1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
namespace MediaWiki\DB;
use JsonSchema\Validator;
use Seld\JsonLint\DuplicateKeyException;
use Seld\JsonLint\JsonParser;
use Seld\JsonLint\ParsingException;
use function class_exists;
use function file_get_contents;
use function is_array;
use function is_object;
/**
* Validate abstract schema json files against their JSON schema.
*
* This is used for static validation from the command-line via
* generateSchemaSql.php, generateSchemaChangeSql, and the PHPUnit structure test suite
* (AbstractSchemaValidationTest).
*
* The files are normally read by the generateSchemaSql.php and generateSchemaSqlChange.php maintenance scripts.
*
* @since 1.38
*/
class AbstractSchemaValidator {
/**
* @var callable(string):void
*/
private $missingDepCallback;
/**
* @param callable(string):void $missingDepCallback
*/
public function __construct( callable $missingDepCallback ) {
$this->missingDepCallback = $missingDepCallback;
}
/**
* @codeCoverageIgnore
* @return bool
*/
public function checkDependencies(): bool {
if ( !class_exists( Validator::class ) ) {
( $this->missingDepCallback )(
'The JsonSchema library cannot be found, please install it through composer.'
);
return false;
}
if ( !class_exists( JsonParser::class ) ) {
( $this->missingDepCallback )(
'The JSON lint library cannot be found, please install it through composer.'
);
return false;
}
return true;
}
/**
* @param string $path file to validate
* @return bool true if passes validation
* @throws AbstractSchemaValidationError on any failure
*/
public function validate( string $path ): bool {
$contents = file_get_contents( $path );
$jsonParser = new JsonParser();
try {
$data = $jsonParser->parse( $contents, JsonParser::DETECT_KEY_CONFLICTS );
} catch ( DuplicateKeyException $e ) {
throw new AbstractSchemaValidationError( $e->getMessage(), $e->getCode(), $e );
} catch ( ParsingException $e ) {
throw new AbstractSchemaValidationError( "$path is not valid JSON", $e->getCode(), $e );
}
// Regular schema's are arrays, schema changes are objects.
if ( is_array( $data ) ) {
$schemaPath = __DIR__ . '/../../docs/abstract-schema.schema.json';
} elseif ( is_object( $data ) ) {
$schemaPath = __DIR__ . '/../../docs/abstract-schema-changes.schema.json';
} else {
throw new AbstractSchemaValidationError( "$path is not a supported JSON object" );
}
$validator = new Validator;
$validator->check( $data, (object)[ '$ref' => 'file://' . $schemaPath ] );
if ( $validator->isValid() ) {
// All good.
return true;
}
$out = "$path did not pass validation.\n";
foreach ( $validator->getErrors() as $error ) {
$out .= "[{$error['property']}] {$error['message']}\n";
}
throw new AbstractSchemaValidationError( $out );
}
}
|
