f6644c07cb
Our hardcoded enum list in the extension.json schema for license-name values was incomplete and did not cover the full SPDX license identifier specification, which includes things like "AND" for specifying multiple licenses. Composer already has solid code in a library to do this validation, so let's use it! This updates both the validateRegistrationFile.php and ExtensionJsonValidationTest.php to use the composer/spdx-licenses library (a new development dependency) to ensure the license-name field is a valid SPDX identifier. Also fix a silly typo in the validateRegistrationFile script which prevented it from running, and use ::class so it will be easier to detect typos like that in the future. Bug: T146862 Change-Id: Ibb8973ed7950ae81c90558f9630f73746b2aff2c
77 lines
2.7 KiB
PHP
77 lines
2.7 KiB
PHP
<?php
|
|
|
|
require_once __DIR__ . '/Maintenance.php';
|
|
|
|
use Composer\Spdx\SpdxLicenses;
|
|
use JsonSchema\Validator;
|
|
|
|
class ValidateRegistrationFile extends Maintenance {
|
|
public function __construct() {
|
|
parent::__construct();
|
|
$this->addArg( 'path', 'Path to extension.json/skin.json file.', true );
|
|
}
|
|
public function execute() {
|
|
if ( !class_exists( Validator::class ) ) {
|
|
$this->error( 'The JsonSchema library cannot be found, please install it through composer.', 1 );
|
|
} elseif ( !class_exists( SpdxLicenses::class ) ) {
|
|
$this->error(
|
|
'The spdx-licenses library cannot be found, please install it through composer.', 1
|
|
);
|
|
}
|
|
|
|
$path = $this->getArg( 0 );
|
|
$data = json_decode( file_get_contents( $path ) );
|
|
if ( !is_object( $data ) ) {
|
|
$this->error( "$path is not a valid JSON file.", 1 );
|
|
}
|
|
if ( !isset( $data->manifest_version ) ) {
|
|
$this->output( "Warning: No manifest_version set, assuming 1.\n" );
|
|
// For backwards-compatability assume 1
|
|
$data->manifest_version = 1;
|
|
}
|
|
$version = $data->manifest_version;
|
|
if ( $version !== ExtensionRegistry::MANIFEST_VERSION ) {
|
|
$schemaPath = dirname( __DIR__ ) . "/docs/extension.schema.v$version.json";
|
|
} else {
|
|
$schemaPath = dirname( __DIR__ ) . '/docs/extension.schema.json';
|
|
}
|
|
|
|
if ( $version < ExtensionRegistry::OLDEST_MANIFEST_VERSION
|
|
|| $version > ExtensionRegistry::MANIFEST_VERSION
|
|
) {
|
|
$this->error( "Error: $path is using a non-supported schema version, it should use "
|
|
. ExtensionRegistry::MANIFEST_VERSION, 1 );
|
|
} elseif ( $version < ExtensionRegistry::MANIFEST_VERSION ) {
|
|
$this->output( "Warning: $path is using a deprecated schema, and should be updated to "
|
|
. ExtensionRegistry::MANIFEST_VERSION . "\n" );
|
|
}
|
|
|
|
$licenseError = false;
|
|
// Check if it's a string, if not, schema validation will display an error
|
|
if ( isset( $data->{'license-name'} ) && is_string( $data->{'license-name'} ) ) {
|
|
$licenses = new SpdxLicenses();
|
|
$valid = $licenses->validate( $data->{'license-name'} );
|
|
if ( !$valid ) {
|
|
$licenseError = '[license-name] Invalid SPDX license identifier, '
|
|
. 'see <https://spdx.org/licenses/>';
|
|
}
|
|
}
|
|
|
|
$validator = new Validator;
|
|
$validator->check( $data, (object) [ '$ref' => 'file://' . $schemaPath ] );
|
|
if ( $validator->isValid() && !$licenseError ) {
|
|
$this->output( "$path validates against the version $version schema!\n" );
|
|
} else {
|
|
foreach ( $validator->getErrors() as $error ) {
|
|
$this->output( "[{$error['property']}] {$error['message']}\n" );
|
|
}
|
|
if ( $licenseError ) {
|
|
$this->output( "$licenseError\n" );
|
|
}
|
|
$this->error( "$path does not validate.", 1 );
|
|
}
|
|
}
|
|
}
|
|
|
|
$maintClass = 'ValidateRegistrationFile';
|
|
require_once RUN_MAINTENANCE_IF_MAIN;
|