b72b9a8c43
The goal is to keep the actual default values for settings in the same place as the setting is declared, and applied using the regular means for loading the settings -- not in a separate piece of code that needs to be loaded through some entirely different mechanism. SetupDynamicConfig.php now contains a few categories of things: * Post-processing of configuration settings, where already-set settings are altered. This could be moved to MainConfigSchema too as a separate set of methods. * Processing of old aliases of settings (blacklist, slave) that are not registered as settings anymore and therefore are not available to MainConfigSchema. This could perhaps be moved to LocalSettings processing somehow? * Setting $wgUseEnotif, which is also not registered as a setting. Easiest would be just to declare it as a setting and have it set unconditionally. * Setting the actual timezone to $wgLocaltimezone. This is not related to configuration and should just be in Setup.php. Bug: T305093 Change-Id: Ia5c23b52dbbfcb3d07ffcf5d3b7f2d7befba2a26
311 lines
11 KiB
PHP
311 lines
11 KiB
PHP
<?php
|
|
|
|
namespace MediaWiki\Tests\Unit\Settings\Config;
|
|
|
|
use HashConfig;
|
|
use InvalidArgumentException;
|
|
use MediaWiki\Settings\Config\ConfigSchemaAggregator;
|
|
use MediaWiki\Settings\Config\MergeStrategy;
|
|
use MediaWiki\Settings\SettingsBuilderException;
|
|
use PHPUnit\Framework\TestCase;
|
|
|
|
/**
|
|
* @covers \MediaWiki\Settings\Config\ConfigSchemaAggregator
|
|
*/
|
|
class ConfigSchemaAggregatorTest extends TestCase {
|
|
|
|
public function testAddSchema() {
|
|
$aggregator = new ConfigSchemaAggregator();
|
|
$aggregator->addSchema( 'foo', [ 'type' => 'string', ] );
|
|
$aggregator->addSchema( 'bar', [ 'type' => 'number', ] );
|
|
$this->assertTrue( $aggregator->hasSchemaFor( 'foo' ) );
|
|
$this->assertFalse( $aggregator->hasSchemaFor( 'xyzzy' ) );
|
|
$this->assertSame( [ 'type' => 'number', ], $aggregator->getSchemaFor( 'bar' ) );
|
|
}
|
|
|
|
public function testAddSchemaMulti() {
|
|
$aggregator = new ConfigSchemaAggregator();
|
|
$aggregator->addSchemaMulti( [
|
|
'foo' => [ 'type' => 'string', ],
|
|
'bar' => [ 'type' => 'number', ],
|
|
] );
|
|
$this->assertTrue( $aggregator->hasSchemaFor( 'foo' ) );
|
|
$this->assertFalse( $aggregator->hasSchemaFor( 'xyzzy' ) );
|
|
$this->assertSame( [ 'type' => 'number', ], $aggregator->getSchemaFor( 'bar' ) );
|
|
}
|
|
|
|
public function testCombineSchema() {
|
|
$aggregator = new ConfigSchemaAggregator();
|
|
$aggregator->addTypes( [ 'foo' => 'string', ] );
|
|
$aggregator->addSchema( 'bar', [ 'type' => 'number', ] );
|
|
$aggregator->addSchema( 'foo', [ 'default' => 'X', ] );
|
|
$this->assertTrue( $aggregator->hasSchemaFor( 'foo' ) );
|
|
$this->assertTrue( $aggregator->hasSchemaFor( 'bar' ) );
|
|
$this->assertFalse( $aggregator->hasSchemaFor( 'xyzzy' ) );
|
|
$this->assertSame( [ 'type' => 'number', ], $aggregator->getSchemaFor( 'bar' ) );
|
|
$this->assertSame( 'X', $aggregator->getDefaultFor( 'foo' ) );
|
|
$this->assertSame( 'string', $aggregator->getTypeFor( 'foo' ) );
|
|
}
|
|
|
|
public function testAddSchemaOverrideFails() {
|
|
$aggregator = new ConfigSchemaAggregator();
|
|
$aggregator->addTypes( [ 'foo' => 'int', ] );
|
|
|
|
$this->expectException( SettingsBuilderException::class );
|
|
$aggregator->addSchema( 'foo', [ 'type' => 'string', ] );
|
|
}
|
|
|
|
public function testSetAndGetDefaults() {
|
|
$aggregator = new ConfigSchemaAggregator();
|
|
$aggregator->addSchema( 'no_default', [ 'type' => 'string', ] );
|
|
$aggregator->addSchema( 'with_default', [ 'type' => 'string', 'default' => 'bla', ] );
|
|
$aggregator->addDefaults( [ 'another_with_default' => 'blabla' ] );
|
|
$this->assertFalse( $aggregator->hasDefaultFor( 'no_default' ) );
|
|
$this->assertTrue( $aggregator->hasDefaultFor( 'with_default' ) );
|
|
$this->assertTrue( $aggregator->hasDefaultFor( 'another_with_default' ) );
|
|
$this->assertSame( 'bla', $aggregator->getDefaultFor( 'with_default' ) );
|
|
$this->assertSame( [ 'default' => 'blabla' ], $aggregator->getSchemaFor( 'another_with_default' ) );
|
|
$this->assertEquals( [
|
|
'with_default' => 'bla',
|
|
'another_with_default' => 'blabla',
|
|
], $aggregator->getDefaults() );
|
|
}
|
|
|
|
public function testSetAndGetDynamicDefaults() {
|
|
$dyn1 = [ 'callback' => 'function1' ];
|
|
$dyn2 = [ 'callback' => 'function2', 'use' => [ 'Stuff' ] ];
|
|
|
|
$aggregator = new ConfigSchemaAggregator();
|
|
$aggregator->addSchema( 'no_dynamicDefault', [ 'default' => 'xyz', ] );
|
|
$aggregator->addSchema( 'with_dynamicDefault', [ 'dynamicDefault' => $dyn1, 'default' => 'bla', ] );
|
|
$aggregator->addDynamicDefaults( [ 'another_with_dynamicDefault' => $dyn2 ] );
|
|
$this->assertNull( $aggregator->getDynamicDefaultDeclarationFor( 'no_dynamicDefault' ) );
|
|
$this->assertSame( $dyn1, $aggregator->getDynamicDefaultDeclarationFor( 'with_dynamicDefault' ) );
|
|
$this->assertSame( [ 'dynamicDefault' => $dyn2 ], $aggregator->getSchemaFor( 'another_with_dynamicDefault' ) );
|
|
$this->assertEquals( [
|
|
'with_dynamicDefault' => $dyn1,
|
|
'another_with_dynamicDefault' => $dyn2,
|
|
], $aggregator->getDynamicDefaults() );
|
|
}
|
|
|
|
public function testGetDefaults() {
|
|
$aggregator = new ConfigSchemaAggregator();
|
|
$aggregator->addSchema( 'no_default', [ 'type' => 'string', ] );
|
|
$aggregator->addSchema( 'with_default', [ 'type' => 'string', 'default' => 'bla', ] );
|
|
$aggregator->addSchema(
|
|
'another_with_default',
|
|
[ 'type' => 'string', 'default' => 'blabla', ]
|
|
);
|
|
|
|
$this->assertEquals( [
|
|
'with_default' => 'bla',
|
|
'another_with_default' => 'blabla',
|
|
], $aggregator->getDefaults() );
|
|
|
|
$this->assertFalse( $aggregator->hasDefaultFor( 'no_default' ) );
|
|
$this->assertNull( $aggregator->getDefaultFor( 'no_default' ) );
|
|
$this->assertTrue( $aggregator->hasDefaultFor( 'with_default' ) );
|
|
$this->assertSame( 'bla', $aggregator->getDefaultFor( 'with_default' ) );
|
|
}
|
|
|
|
public function testGetDefaultsFromProperties() {
|
|
$aggregator = new ConfigSchemaAggregator();
|
|
$aggregator->addSchema( 'test', [
|
|
'default' => [ 'a' => 111, 'c' => 333 ],
|
|
'properties' => [
|
|
'a' => [ 'default' => 222 ],
|
|
'b' => [
|
|
'properties' => [
|
|
'b-1' => [ 'default' => 777 ]
|
|
]
|
|
]
|
|
]
|
|
] );
|
|
|
|
$expected = [
|
|
'a' => 222, // overwritten by property
|
|
'c' => 333, // kept from top level
|
|
'b' => [ // complex property
|
|
'b-1' => 777 // nested default
|
|
]
|
|
];
|
|
|
|
$this->assertSame( $expected, $aggregator->getDefaultFor( 'test' ) );
|
|
}
|
|
|
|
public function testDefaultOverrideFails() {
|
|
$aggregator = new ConfigSchemaAggregator();
|
|
$aggregator->addSchema( 'foo', [ 'default' => 'bla', ] );
|
|
$this->expectException( SettingsBuilderException::class );
|
|
$aggregator->addDefaults( [ 'foo' => 'xyz', ] );
|
|
}
|
|
|
|
public function testSetAndGetTypes() {
|
|
$aggregator = new ConfigSchemaAggregator();
|
|
$aggregator->addSchema( 'no_type', [ 'default' => 'xyz', ] );
|
|
$aggregator->addSchema( 'with_type', [ 'type' => 'string', 'default' => 'bla', ] );
|
|
$aggregator->addTypes( [ 'another_with_type' => 'number' ] );
|
|
$this->assertSame( 'string', $aggregator->getTypeFor( 'with_type' ) );
|
|
$this->assertSame( [ 'type' => 'number' ], $aggregator->getSchemaFor( 'another_with_type' ) );
|
|
$this->assertEquals( [
|
|
'with_type' => 'string',
|
|
'another_with_type' => 'number',
|
|
], $aggregator->getTypes() );
|
|
}
|
|
|
|
public function testTypeOverrideFails() {
|
|
$aggregator = new ConfigSchemaAggregator();
|
|
$aggregator->addSchema( 'foo', [ 'type' => 'string', ] );
|
|
$this->expectException( SettingsBuilderException::class );
|
|
$aggregator->addTypes( [ 'foo' => 'number', ] );
|
|
}
|
|
|
|
public function testSetAndGetMergeStrategies() {
|
|
$aggregator = new ConfigSchemaAggregator();
|
|
$aggregator->addSchema( 'no_mergeStrategy', [ 'default' => 'xyz', ] );
|
|
$aggregator->addSchema( 'with_mergeStrategy',
|
|
[ 'mergeStrategy' => 'array_plus', 'default' => 'bla', ] );
|
|
$aggregator->addMergeStrategies( [ 'another_with_mergeStrategy' => 'array_merge' ] );
|
|
$this->assertSame(
|
|
[ 'mergeStrategy' => 'array_merge' ],
|
|
$aggregator->getSchemaFor( 'another_with_mergeStrategy' )
|
|
);
|
|
$this->assertEquals( [
|
|
'with_mergeStrategy' => 'array_plus',
|
|
'another_with_mergeStrategy' => 'array_merge',
|
|
], $aggregator->getMergeStrategyNames() );
|
|
|
|
foreach ( $aggregator->getMergeStrategies() as $key => $strategy ) {
|
|
$this->assertEquals( $aggregator->getMergeStrategyFor( $key ), $strategy );
|
|
}
|
|
$this->assertEquals(
|
|
array_keys( $aggregator->getMergeStrategyNames() ),
|
|
array_keys( $aggregator->getMergeStrategies() )
|
|
);
|
|
}
|
|
|
|
public function testMergeStrategieOverrideFails() {
|
|
$aggregator = new ConfigSchemaAggregator();
|
|
$aggregator->addSchema( 'foo', [ 'mergeStrategy' => 'array_merge', ] );
|
|
$this->expectException( SettingsBuilderException::class );
|
|
$aggregator->addMergeStrategies( [ 'foo' => 'array_plus', ] );
|
|
}
|
|
|
|
public function provideGetMergeStrategiesFor() {
|
|
yield 'no schema' => [ null, null ];
|
|
yield 'no strategy' => [ [ 'default' => '' ], null ];
|
|
yield 'with strategy' => [ [ 'mergeStrategy' => 'array_merge' ], 'array_merge' ];
|
|
|
|
yield 'with strategy and type=array' => [
|
|
[
|
|
'type' => 'array',
|
|
'mergeStrategy' => 'replace'
|
|
],
|
|
'replace'
|
|
];
|
|
|
|
yield 'without strategy and type=array' => [
|
|
[ 'type' => 'array' ],
|
|
'array_merge'
|
|
];
|
|
|
|
yield 'with strategy and type=object' => [
|
|
[
|
|
'type' => 'object',
|
|
'mergeStrategy' => 'array_plus_2d'
|
|
],
|
|
'array_plus_2d'
|
|
];
|
|
|
|
yield 'without strategy and type=object' => [
|
|
[ 'type' => 'object' ],
|
|
'array_plus'
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @dataProvider provideGetMergeStrategiesFor
|
|
*/
|
|
public function testGetMergeStrategyFor( $schema, $expected ) {
|
|
$aggregator = new ConfigSchemaAggregator();
|
|
|
|
if ( $schema ) {
|
|
$aggregator->addSchema( 'test', $schema );
|
|
}
|
|
|
|
$strategy = $aggregator->getMergeStrategyFor( 'test' );
|
|
$this->assertSame(
|
|
$expected,
|
|
$strategy ? $strategy->getName() : null
|
|
);
|
|
}
|
|
|
|
public function provideValidate() {
|
|
yield 'invalid config' => [
|
|
'config-schema' => [ 'foo' => [ 'type' => 'string', ], ],
|
|
'config' => [ 'foo' => 1 ],
|
|
'valid' => false,
|
|
];
|
|
yield 'all good' => [
|
|
'config-schema' => [ 'foo' => [ 'type' => 'string', ], ],
|
|
'config' => [ 'foo' => 'bar', ],
|
|
'valid' => true,
|
|
];
|
|
yield 'missing key' => [
|
|
'config-schema' => [ 'foo' => [ 'type' => 'string', ], ],
|
|
'config' => [ 'bar' => 'bar' ],
|
|
'valid' => false,
|
|
];
|
|
yield 'no schema was added' => [
|
|
'config-schema' => [],
|
|
'config' => [ 'foo' => 'bar', ],
|
|
'valid' => true,
|
|
];
|
|
yield 'key is in config but has no schema' => [
|
|
'config-schema' => [ 'foo' => [ 'type' => 'array', 'mergeStrategy' => MergeStrategy::ARRAY_MERGE ], ],
|
|
'config' => [ 'foo' => [], 'baz' => false, ],
|
|
'valid' => true,
|
|
];
|
|
yield 'assoc array where list is expected' => [
|
|
'config-schema' => [ 'foo' => [ 'type' => 'array', ], ],
|
|
'config' => [ 'foo' => [ 'x' => 1 ] ],
|
|
'valid' => false,
|
|
];
|
|
yield 'map with numeric keys' => [
|
|
'config-schema' => [ 'foo' => [ 'type' => 'object', ], ],
|
|
'config' => [ 'foo' => [ 0 => 'x', 1 => 'y' ] ],
|
|
'valid' => true,
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @dataProvider provideValidate
|
|
*/
|
|
public function testValidateConfig( array $schemas, array $config, bool $valid ) {
|
|
$aggregator = $this->newConfigSchemaAggregator( $schemas );
|
|
$status = $aggregator->validateConfig( new HashConfig( $config ) );
|
|
$this->assertSame( $valid, $status->isOK() );
|
|
}
|
|
|
|
public function testValidateValue() {
|
|
$aggregator = $this->newConfigSchemaAggregator( [ 'foo' => [ 'type' => 'integer' ] ] );
|
|
$this->assertTrue( $aggregator->validateValue( 'foo', 1 )->isOK() );
|
|
$this->assertFalse( $aggregator->validateValue( 'foo', 'bar' )->isOK() );
|
|
}
|
|
|
|
public function testValidateInvalidSchema() {
|
|
$this->expectException( InvalidArgumentException::class );
|
|
$aggregator = $this->newConfigSchemaAggregator( [ 'foo' => [ 'type' => 1 ] ] );
|
|
$aggregator->validateConfig( new HashConfig( [ 'foo' => 'bar' ] ) );
|
|
}
|
|
|
|
private function newConfigSchemaAggregator( array $schemas = [] ) {
|
|
$aggregator = new ConfigSchemaAggregator();
|
|
|
|
foreach ( $schemas as $key => $sch ) {
|
|
$aggregator->addSchema( $key, $sch );
|
|
}
|
|
|
|
return $aggregator;
|
|
}
|
|
}
|