de0c4819d1
This adds an option to the schema generating maintenance scripts to validate abstract schemas and schema changes and a structure test to validate exisiting schemas and schema changes. Schemas are also validated when generating. The validation for the schema doesn't impose limits on table, index or column names as I couldn't find any reliable conventions for them. The structure tests only cover MediaWiki itself as there is no convention on where extensions store their abstract schema. Ideally, auto detection would be possible for sql/, but for now extensions have to define their own (thankfully trivial) tests. A couple of invalid definitions were fixed thanks to these tests. I aimed to be thorough, but not all parts of the abstract schema are completely clear, and Doctrine's documentation is not complete. As a result, not everything has a description field. Bug: T298320 Change-Id: I681d265317d4d1584869142ebb23d4098c06885f
117 lines
3.5 KiB
PHP
117 lines
3.5 KiB
PHP
<?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 );
|
|
}
|
|
}
|