Page MenuHomeWickedGov Phorge
Files F5994027

ChangesListStringOptionsFilterGroupTest.php
No OneTemporary
Actions

Size
5 KB
Referenced Files
None
Subscribers
None

ChangesListStringOptionsFilterGroupTest.php
View Options

<?php
use MediaWiki\Context\IContextSource;
use MediaWiki\Html\FormOptions;
use MediaWiki\SpecialPage\ChangesListSpecialPage;
use Wikimedia\Rdbms\IDatabase;
use Wikimedia\Rdbms\IReadableDatabase;
use Wikimedia\TestingAccessWrapper;
/**
* @covers \ChangesListStringOptionsFilterGroup
*/
class ChangesListStringOptionsFilterGroupTest extends MediaWikiUnitTestCase {
public function testIsFullCoverage() {
$falseGroup = TestingAccessWrapper::newFromObject(
new ChangesListStringOptionsFilterGroup( [
'name' => 'group',
'filters' => [],
'isFullCoverage' => false,
'queryCallable' => static function () {
},
'default' => '',
] )
);
$this->assertFalse( $falseGroup->isFullCoverage );
$this->expectException( InvalidArgumentException::class );
$this->expectExceptionMessage( 'You must specify isFullCoverage' );
$undefinedFullCoverageGroup = new ChangesListStringOptionsFilterGroup( [
'name' => 'othergroup',
'filters' => [],
] );
}
/**
* @param array $filterDefinitions Array of filter definitions
* @param array $expectedValues Array of values callback should receive
* @param string $input Value in URL
*
* @dataProvider provideModifyQuery
*/
public function testModifyQuery( $filterDefinitions, $expectedValues, $input ) {
$queryCallable = function (
string $className,
IContextSource $ctx,
IReadableDatabase $dbr,
&$tables,
&$fields,
&$conds,
&$query_options,
&$join_conds,
$actualSelectedValues
) use ( $expectedValues ) {
$this->assertSame(
$expectedValues,
$actualSelectedValues
);
};
$groupDefinition = [
'name' => 'group',
'default' => '',
'isFullCoverage' => true,
'filters' => $filterDefinitions,
'queryCallable' => $queryCallable,
];
$this->modifyQueryHelper( $groupDefinition, $input );
}
public static function provideModifyQuery() {
$mixedFilters = [
[
'name' => 'foo',
],
[
'name' => 'baz',
],
[
'name' => 'goo'
],
];
return [
[
$mixedFilters,
[ 'baz', 'foo', ],
'foo;bar;BaZ;invalid',
],
[
$mixedFilters,
[ 'baz', 'foo', 'goo' ],
'all',
],
];
}
/**
* @param array $filterDefinitions Array of filter definitions
* @param string $input Value in URL
* @param string $message Message thrown by exception
*
* @dataProvider provideNoOpModifyQuery
*/
public function testNoOpModifyQuery( $filterDefinitions, $input, $message ) {
$noFiltersAllowedCallable = static function (
string $className,
IContextSource $ctx,
IReadableDatabase $dbr,
&$tables,
&$fields,
&$conds,
&$query_options,
&$join_conds,
$actualSelectedValues
) use ( $message ) {
throw new LogicException( $message );
};
$groupDefinition = [
'name' => 'group',
'default' => '',
'isFullCoverage' => true,
'filters' => $filterDefinitions,
'queryCallable' => $noFiltersAllowedCallable,
];
$this->modifyQueryHelper( $groupDefinition, $input );
$this->assertTrue(
true,
'Test successfully completed without calling queryCallable'
);
}
public static function provideNoOpModifyQuery() {
$noFilters = [];
$normalFilters = [
[
'name' => 'foo',
],
[
'name' => 'bar',
]
];
return [
[
$noFilters,
'disallowed1;disallowed3',
'The queryCallable should not be called if there are no filters',
],
[
$normalFilters,
'',
'The queryCallable should not be called if no filters are selected',
],
[
$normalFilters,
'invalid1',
'The queryCallable should not be called if no valid filters are selected',
],
];
}
/**
* @param array $groupDefinition
* @param string $input Value in URL
*/
protected function modifyQueryHelper( $groupDefinition, $input ) {
$dbr = $this->createMock( IDatabase::class );
$tables = [];
$fields = [];
$conds = [];
$query_options = [];
$join_conds = [];
$group = new ChangesListStringOptionsFilterGroup( $groupDefinition );
$opts = new FormOptions();
$opts->add( $groupDefinition[ 'name' ], $input );
$group->modifyQuery(
$dbr,
$this->createNoOpAbstractMock( ChangesListSpecialPage::class ),
$tables,
$fields,
$conds,
$query_options,
$join_conds,
$opts,
true
);
}
public function testGetJsData() {
$definition = [
'name' => 'some-group',
'title' => 'some-group-title',
'default' => 'foo',
'priority' => 1,
'isFullCoverage' => false,
'queryCallable' => static function () {
},
'filters' => [
[
'name' => 'foo',
'label' => 'foo-label',
'description' => 'foo-description',
'priority' => 2,
],
[
'name' => 'bar',
'label' => 'bar-label',
'description' => 'bar-description',
'priority' => 4,
]
],
];
$group = new ChangesListStringOptionsFilterGroup( $definition );
$this->assertArrayEquals(
[
'name' => 'some-group',
'title' => 'some-group-title',
'type' => ChangesListStringOptionsFilterGroup::TYPE,
'default' => 'foo',
'priority' => 1,
'fullCoverage' => false,
'filters' => [
[
'name' => 'bar',
'label' => 'bar-label',
'description' => 'bar-description',
'priority' => 4,
'cssClass' => null,
'conflicts' => [],
'subset' => [],
'defaultHighlightColor' => null,
],
[
'name' => 'foo',
'label' => 'foo-label',
'description' => 'foo-description',
'priority' => 2,
'cssClass' => null,
'conflicts' => [],
'subset' => [],
'defaultHighlightColor' => null,
],
],
'conflicts' => [],
'separator' => ';',
'messageKeys' => [
'some-group-title',
'bar-label',
'bar-description',
'foo-label',
'foo-description',
],
],
$group->getJsData(),
/** ordered= */ false,
/** named= */ true
);
}
}

File Metadata

Mime Type
text/x-php
Expires
Oct 4 2026, 03:03 (4 w, 6 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
ee/69/cc85369d8213a3716df20b4593df
Default Alt Text
ChangesListStringOptionsFilterGroupTest.php (5 KB)

Event Timeline