diff options
Diffstat (limited to 'www/wiki/tests/phpunit/includes/api/query')
8 files changed, 1497 insertions, 0 deletions
diff --git a/www/wiki/tests/phpunit/includes/api/query/ApiQueryBasicTest.php b/www/wiki/tests/phpunit/includes/api/query/ApiQueryBasicTest.php new file mode 100644 index 00000000..e49e1d8b --- /dev/null +++ b/www/wiki/tests/phpunit/includes/api/query/ApiQueryBasicTest.php @@ -0,0 +1,346 @@ +<?php +/** + * Copyright © 2013 Yuri Astrakhan "<Firstname><Lastname>@gmail.com" + * + * 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 + */ + +/** + * These tests validate basic functionality of the api query module + * + * @group API + * @group Database + * @group medium + * @covers ApiQuery + */ +class ApiQueryBasicTest extends ApiQueryTestBase { + protected $exceptionFromAddDBData; + + /** + * Create a set of pages. These must not change, otherwise the tests might give wrong results. + * +*@see MediaWikiTestCase::addDBDataOnce() + */ + function addDBDataOnce() { + try { + if ( Title::newFromText( 'AQBT-All' )->exists() ) { + return; + } + + // Ordering is important, as it will be returned in the same order as stored in the index + $this->editPage( 'AQBT-All', '[[Category:AQBT-Cat]] [[AQBT-Links]] {{AQBT-T}}' ); + $this->editPage( 'AQBT-Categories', '[[Category:AQBT-Cat]]' ); + $this->editPage( 'AQBT-Links', '[[AQBT-All]] [[AQBT-Categories]] [[AQBT-Templates]]' ); + $this->editPage( 'AQBT-Templates', '{{AQBT-T}}' ); + $this->editPage( 'AQBT-T', 'Content', '', NS_TEMPLATE ); + + // Refresh due to the bug with listing transclusions as links if they don't exist + $this->editPage( 'AQBT-All', '[[Category:AQBT-Cat]] [[AQBT-Links]] {{AQBT-T}}' ); + $this->editPage( 'AQBT-Templates', '{{AQBT-T}}' ); + } catch ( Exception $e ) { + $this->exceptionFromAddDBData = $e; + } + } + + private static $links = [ + [ 'prop' => 'links', 'titles' => 'AQBT-All' ], + [ 'pages' => [ + '1' => [ + 'pageid' => 1, + 'ns' => 0, + 'title' => 'AQBT-All', + 'links' => [ + [ 'ns' => 0, 'title' => 'AQBT-Links' ], + ] + ] + ] ] + ]; + + private static $templates = [ + [ 'prop' => 'templates', 'titles' => 'AQBT-All' ], + [ 'pages' => [ + '1' => [ + 'pageid' => 1, + 'ns' => 0, + 'title' => 'AQBT-All', + 'templates' => [ + [ 'ns' => 10, 'title' => 'Template:AQBT-T' ], + ] + ] + ] ] + ]; + + private static $categories = [ + [ 'prop' => 'categories', 'titles' => 'AQBT-All' ], + [ 'pages' => [ + '1' => [ + 'pageid' => 1, + 'ns' => 0, + 'title' => 'AQBT-All', + 'categories' => [ + [ 'ns' => 14, 'title' => 'Category:AQBT-Cat' ], + ] + ] + ] ] + ]; + + private static $allpages = [ + [ 'list' => 'allpages', 'apprefix' => 'AQBT-' ], + [ 'allpages' => [ + [ 'pageid' => 1, 'ns' => 0, 'title' => 'AQBT-All' ], + [ 'pageid' => 2, 'ns' => 0, 'title' => 'AQBT-Categories' ], + [ 'pageid' => 3, 'ns' => 0, 'title' => 'AQBT-Links' ], + [ 'pageid' => 4, 'ns' => 0, 'title' => 'AQBT-Templates' ], + ] ] + ]; + + private static $alllinks = [ + [ 'list' => 'alllinks', 'alprefix' => 'AQBT-' ], + [ 'alllinks' => [ + [ 'ns' => 0, 'title' => 'AQBT-All' ], + [ 'ns' => 0, 'title' => 'AQBT-Categories' ], + [ 'ns' => 0, 'title' => 'AQBT-Links' ], + [ 'ns' => 0, 'title' => 'AQBT-Templates' ], + ] ] + ]; + + private static $alltransclusions = [ + [ 'list' => 'alltransclusions', 'atprefix' => 'AQBT-' ], + [ 'alltransclusions' => [ + [ 'ns' => 10, 'title' => 'Template:AQBT-T' ], + [ 'ns' => 10, 'title' => 'Template:AQBT-T' ], + ] ] + ]; + + // Although this appears to have no use it is used by testLists() + private static $allcategories = [ + [ 'list' => 'allcategories', 'acprefix' => 'AQBT-' ], + [ 'allcategories' => [ + [ 'category' => 'AQBT-Cat' ], + ] ] + ]; + + private static $backlinks = [ + [ 'list' => 'backlinks', 'bltitle' => 'AQBT-Links' ], + [ 'backlinks' => [ + [ 'pageid' => 1, 'ns' => 0, 'title' => 'AQBT-All' ], + ] ] + ]; + + private static $embeddedin = [ + [ 'list' => 'embeddedin', 'eititle' => 'Template:AQBT-T' ], + [ 'embeddedin' => [ + [ 'pageid' => 1, 'ns' => 0, 'title' => 'AQBT-All' ], + [ 'pageid' => 4, 'ns' => 0, 'title' => 'AQBT-Templates' ], + ] ] + ]; + + private static $categorymembers = [ + [ 'list' => 'categorymembers', 'cmtitle' => 'Category:AQBT-Cat' ], + [ 'categorymembers' => [ + [ 'pageid' => 1, 'ns' => 0, 'title' => 'AQBT-All' ], + [ 'pageid' => 2, 'ns' => 0, 'title' => 'AQBT-Categories' ], + ] ] + ]; + + private static $generatorAllpages = [ + [ 'generator' => 'allpages', 'gapprefix' => 'AQBT-' ], + [ 'pages' => [ + '1' => [ + 'pageid' => 1, + 'ns' => 0, + 'title' => 'AQBT-All' ], + '2' => [ + 'pageid' => 2, + 'ns' => 0, + 'title' => 'AQBT-Categories' ], + '3' => [ + 'pageid' => 3, + 'ns' => 0, + 'title' => 'AQBT-Links' ], + '4' => [ + 'pageid' => 4, + 'ns' => 0, + 'title' => 'AQBT-Templates' ], + ] ] + ]; + + private static $generatorLinks = [ + [ 'generator' => 'links', 'titles' => 'AQBT-Links' ], + [ 'pages' => [ + '1' => [ + 'pageid' => 1, + 'ns' => 0, + 'title' => 'AQBT-All' ], + '2' => [ + 'pageid' => 2, + 'ns' => 0, + 'title' => 'AQBT-Categories' ], + '4' => [ + 'pageid' => 4, + 'ns' => 0, + 'title' => 'AQBT-Templates' ], + ] ] + ]; + + private static $generatorLinksPropLinks = [ + [ 'prop' => 'links' ], + [ 'pages' => [ + '1' => [ 'links' => [ + [ 'ns' => 0, 'title' => 'AQBT-Links' ], + ] ] + ] ] + ]; + + private static $generatorLinksPropTemplates = [ + [ 'prop' => 'templates' ], + [ 'pages' => [ + '1' => [ 'templates' => [ + [ 'ns' => 10, 'title' => 'Template:AQBT-T' ] ] ], + '4' => [ 'templates' => [ + [ 'ns' => 10, 'title' => 'Template:AQBT-T' ] ] ], + ] ] + ]; + + /** + * Test basic props + */ + public function testProps() { + $this->check( self::$links ); + $this->check( self::$templates ); + $this->check( self::$categories ); + } + + /** + * Test basic lists + */ + public function testLists() { + $this->check( self::$allpages ); + $this->check( self::$alllinks ); + $this->check( self::$alltransclusions ); + $this->check( self::$allcategories ); + $this->check( self::$backlinks ); + $this->check( self::$embeddedin ); + $this->check( self::$categorymembers ); + } + + /** + * Test basic lists + */ + public function testAllTogether() { + // All props together + $this->check( $this->merge( + self::$links, + self::$templates, + self::$categories + ) ); + + // All lists together + $this->check( $this->merge( + self::$allpages, + self::$alllinks, + self::$alltransclusions, + // This test is temporarily disabled until a sqlite bug is fixed + // self::$allcategories, + self::$backlinks, + self::$embeddedin, + self::$categorymembers + ) ); + + // All props+lists together + $this->check( $this->merge( + self::$links, + self::$templates, + self::$categories, + self::$allpages, + self::$alllinks, + self::$alltransclusions, + // This test is temporarily disabled until a sqlite bug is fixed + // self::$allcategories, + self::$backlinks, + self::$embeddedin, + self::$categorymembers + ) ); + } + + /** + * Test basic lists + */ + public function testGenerator() { + // generator=allpages + $this->check( self::$generatorAllpages ); + // generator=allpages & list=allpages + $this->check( $this->merge( + self::$generatorAllpages, + self::$allpages ) ); + // generator=links + $this->check( self::$generatorLinks ); + // generator=links & prop=links + $this->check( $this->merge( + self::$generatorLinks, + self::$generatorLinksPropLinks ) ); + // generator=links & prop=templates + $this->check( $this->merge( + self::$generatorLinks, + self::$generatorLinksPropTemplates ) ); + // generator=links & prop=links|templates + $this->check( $this->merge( + self::$generatorLinks, + self::$generatorLinksPropLinks, + self::$generatorLinksPropTemplates ) ); + // generator=links & prop=links|templates & list=allpages|... + $this->check( $this->merge( + self::$generatorLinks, + self::$generatorLinksPropLinks, + self::$generatorLinksPropTemplates, + self::$allpages, + self::$alllinks, + self::$alltransclusions, + // This test is temporarily disabled until a sqlite bug is fixed + // self::$allcategories, + self::$backlinks, + self::$embeddedin, + self::$categorymembers ) ); + } + + /** + * Test T53821 + */ + public function testGeneratorRedirects() { + $this->editPage( 'AQBT-Target', 'test' ); + $this->editPage( 'AQBT-Redir', '#REDIRECT [[AQBT-Target]]' ); + $this->check( [ + [ 'generator' => 'backlinks', 'gbltitle' => 'AQBT-Target', 'redirects' => '1' ], + [ + 'redirects' => [ + [ + 'from' => 'AQBT-Redir', + 'to' => 'AQBT-Target', + ] + ], + 'pages' => [ + '6' => [ + 'pageid' => 6, + 'ns' => 0, + 'title' => 'AQBT-Target', + ] + ], + ] + ] ); + } +} diff --git a/www/wiki/tests/phpunit/includes/api/query/ApiQueryContinue2Test.php b/www/wiki/tests/phpunit/includes/api/query/ApiQueryContinue2Test.php new file mode 100644 index 00000000..334fd5da --- /dev/null +++ b/www/wiki/tests/phpunit/includes/api/query/ApiQueryContinue2Test.php @@ -0,0 +1,71 @@ +<?php +/** + * Copyright © 2013 Yuri Astrakhan "<Firstname><Lastname>@gmail.com" + * + * 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 3 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 + */ + +/** + * @group API + * @group Database + * @group medium + * @covers ApiQuery + */ +class ApiQueryContinue2Test extends ApiQueryContinueTestBase { + protected $exceptionFromAddDBData; + + /** + * Create a set of pages. These must not change, otherwise the tests might give wrong results. + * +*@see MediaWikiTestCase::addDBDataOnce() + */ + function addDBDataOnce() { + try { + $this->editPage( 'AQCT73462-A', '**AQCT73462-A** [[AQCT73462-B]] [[AQCT73462-C]]' ); + $this->editPage( 'AQCT73462-B', '[[AQCT73462-A]] **AQCT73462-B** [[AQCT73462-C]]' ); + $this->editPage( 'AQCT73462-C', '[[AQCT73462-A]] [[AQCT73462-B]] **AQCT73462-C**' ); + $this->editPage( 'AQCT73462-A', '**AQCT73462-A** [[AQCT73462-B]] [[AQCT73462-C]]' ); + $this->editPage( 'AQCT73462-B', '[[AQCT73462-A]] **AQCT73462-B** [[AQCT73462-C]]' ); + $this->editPage( 'AQCT73462-C', '[[AQCT73462-A]] [[AQCT73462-B]] **AQCT73462-C**' ); + } catch ( Exception $e ) { + $this->exceptionFromAddDBData = $e; + } + } + + /** + * @group medium + */ + public function testA() { + $this->mVerbose = false; + $mk = function ( $g, $p, $gDir ) { + return [ + 'generator' => 'allpages', + 'gapprefix' => 'AQCT73462-', + 'prop' => 'links', + 'gaplimit' => "$g", + 'pllimit' => "$p", + 'gapdir' => $gDir ? "ascending" : "descending", + ]; + }; + // generator + 1 prop + 1 list + $data = $this->query( $mk( 99, 99, true ), 1, 'g1p', false ) + + [ 'batchcomplete' => true ]; + $this->checkC( $data, $mk( 1, 1, true ), 6, 'g1p-11t' ); + $this->checkC( $data, $mk( 2, 2, true ), 3, 'g1p-22t' ); + $this->checkC( $data, $mk( 1, 1, false ), 6, 'g1p-11f' ); + $this->checkC( $data, $mk( 2, 2, false ), 3, 'g1p-22f' ); + } +} diff --git a/www/wiki/tests/phpunit/includes/api/query/ApiQueryContinueTest.php b/www/wiki/tests/phpunit/includes/api/query/ApiQueryContinueTest.php new file mode 100644 index 00000000..7259bb81 --- /dev/null +++ b/www/wiki/tests/phpunit/includes/api/query/ApiQueryContinueTest.php @@ -0,0 +1,323 @@ +<?php +/** + * Copyright © 2013 Yuri Astrakhan "<Firstname><Lastname>@gmail.com" + * + * 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 + */ + +/** + * These tests validate the new continue functionality of the api query module by + * doing multiple requests with varying parameters, merging the results, and checking + * that the result matches the full data received in one no-limits call. + * + * @group API + * @group Database + * @group medium + * @covers ApiQuery + */ +class ApiQueryContinueTest extends ApiQueryContinueTestBase { + protected $exceptionFromAddDBData; + + /** + * Create a set of pages. These must not change, otherwise the tests might give wrong results. + * +*@see MediaWikiTestCase::addDBDataOnce() + */ + function addDBDataOnce() { + try { + $this->editPage( 'Template:AQCT-T1', '**Template:AQCT-T1**' ); + $this->editPage( 'Template:AQCT-T2', '**Template:AQCT-T2**' ); + $this->editPage( 'Template:AQCT-T3', '**Template:AQCT-T3**' ); + $this->editPage( 'Template:AQCT-T4', '**Template:AQCT-T4**' ); + $this->editPage( 'Template:AQCT-T5', '**Template:AQCT-T5**' ); + + $this->editPage( 'AQCT-1', '**AQCT-1** {{AQCT-T2}} {{AQCT-T3}} {{AQCT-T4}} {{AQCT-T5}}' ); + $this->editPage( 'AQCT-2', '[[AQCT-1]] **AQCT-2** {{AQCT-T3}} {{AQCT-T4}} {{AQCT-T5}}' ); + $this->editPage( 'AQCT-3', '[[AQCT-1]] [[AQCT-2]] **AQCT-3** {{AQCT-T4}} {{AQCT-T5}}' ); + $this->editPage( 'AQCT-4', '[[AQCT-1]] [[AQCT-2]] [[AQCT-3]] **AQCT-4** {{AQCT-T5}}' ); + $this->editPage( 'AQCT-5', '[[AQCT-1]] [[AQCT-2]] [[AQCT-3]] [[AQCT-4]] **AQCT-5**' ); + } catch ( Exception $e ) { + $this->exceptionFromAddDBData = $e; + } + } + + /** + * Test smart continue - list=allpages + * @group medium + */ + public function test1List() { + $this->mVerbose = false; + $mk = function ( $l ) { + return [ + 'list' => 'allpages', + 'apprefix' => 'AQCT-', + 'aplimit' => "$l", + ]; + }; + $data = $this->query( $mk( 99 ), 1, '1L', false ) + + [ 'batchcomplete' => true ]; + + // 1 list + $this->checkC( $data, $mk( 1 ), 5, '1L-1' ); + $this->checkC( $data, $mk( 2 ), 3, '1L-2' ); + $this->checkC( $data, $mk( 3 ), 2, '1L-3' ); + $this->checkC( $data, $mk( 4 ), 2, '1L-4' ); + $this->checkC( $data, $mk( 5 ), 1, '1L-5' ); + } + + /** + * Test smart continue - list=allpages|alltransclusions + * @group medium + */ + public function test2Lists() { + $this->mVerbose = false; + $mk = function ( $l1, $l2 ) { + return [ + 'list' => 'allpages|alltransclusions', + 'apprefix' => 'AQCT-', + 'atprefix' => 'AQCT-', + 'atunique' => '', + 'aplimit' => "$l1", + 'atlimit' => "$l2", + ]; + }; + // 2 lists + $data = $this->query( $mk( 99, 99 ), 1, '2L', false ) + + [ 'batchcomplete' => true ]; + $this->checkC( $data, $mk( 1, 1 ), 5, '2L-11' ); + $this->checkC( $data, $mk( 2, 2 ), 3, '2L-22' ); + $this->checkC( $data, $mk( 3, 3 ), 2, '2L-33' ); + $this->checkC( $data, $mk( 4, 4 ), 2, '2L-44' ); + $this->checkC( $data, $mk( 5, 5 ), 1, '2L-55' ); + } + + /** + * Test smart continue - generator=allpages, prop=links + * @group medium + */ + public function testGen1Prop() { + $this->mVerbose = false; + $mk = function ( $g, $p ) { + return [ + 'generator' => 'allpages', + 'gapprefix' => 'AQCT-', + 'gaplimit' => "$g", + 'prop' => 'links', + 'pllimit' => "$p", + ]; + }; + // generator + 1 prop + $data = $this->query( $mk( 99, 99 ), 1, 'G1P', false ) + + [ 'batchcomplete' => true ]; + $this->checkC( $data, $mk( 1, 1 ), 11, 'G1P-11' ); + $this->checkC( $data, $mk( 2, 2 ), 6, 'G1P-22' ); + $this->checkC( $data, $mk( 3, 3 ), 4, 'G1P-33' ); + $this->checkC( $data, $mk( 4, 4 ), 3, 'G1P-44' ); + $this->checkC( $data, $mk( 5, 5 ), 2, 'G1P-55' ); + } + + /** + * Test smart continue - generator=allpages, prop=links|templates + * @group medium + */ + public function testGen2Prop() { + $this->mVerbose = false; + $mk = function ( $g, $p1, $p2 ) { + return [ + 'generator' => 'allpages', + 'gapprefix' => 'AQCT-', + 'gaplimit' => "$g", + 'prop' => 'links|templates', + 'pllimit' => "$p1", + 'tllimit' => "$p2", + ]; + }; + // generator + 2 props + $data = $this->query( $mk( 99, 99, 99 ), 1, 'G2P', false ) + + [ 'batchcomplete' => true ]; + $this->checkC( $data, $mk( 1, 1, 1 ), 16, 'G2P-111' ); + $this->checkC( $data, $mk( 2, 2, 2 ), 9, 'G2P-222' ); + $this->checkC( $data, $mk( 3, 3, 3 ), 6, 'G2P-333' ); + $this->checkC( $data, $mk( 4, 4, 4 ), 4, 'G2P-444' ); + $this->checkC( $data, $mk( 5, 5, 5 ), 2, 'G2P-555' ); + $this->checkC( $data, $mk( 5, 1, 1 ), 10, 'G2P-511' ); + $this->checkC( $data, $mk( 4, 2, 2 ), 7, 'G2P-422' ); + $this->checkC( $data, $mk( 2, 3, 3 ), 7, 'G2P-233' ); + $this->checkC( $data, $mk( 2, 4, 4 ), 5, 'G2P-244' ); + $this->checkC( $data, $mk( 1, 5, 5 ), 5, 'G2P-155' ); + } + + /** + * Test smart continue - generator=allpages, prop=links, list=alltransclusions + * @group medium + */ + public function testGen1Prop1List() { + $this->mVerbose = false; + $mk = function ( $g, $p, $l ) { + return [ + 'generator' => 'allpages', + 'gapprefix' => 'AQCT-', + 'gaplimit' => "$g", + 'prop' => 'links', + 'pllimit' => "$p", + 'list' => 'alltransclusions', + 'atprefix' => 'AQCT-', + 'atunique' => '', + 'atlimit' => "$l", + ]; + }; + // generator + 1 prop + 1 list + $data = $this->query( $mk( 99, 99, 99 ), 1, 'G1P1L', false ) + + [ 'batchcomplete' => true ]; + $this->checkC( $data, $mk( 1, 1, 1 ), 11, 'G1P1L-111' ); + $this->checkC( $data, $mk( 2, 2, 2 ), 6, 'G1P1L-222' ); + $this->checkC( $data, $mk( 3, 3, 3 ), 4, 'G1P1L-333' ); + $this->checkC( $data, $mk( 4, 4, 4 ), 3, 'G1P1L-444' ); + $this->checkC( $data, $mk( 5, 5, 5 ), 2, 'G1P1L-555' ); + $this->checkC( $data, $mk( 5, 5, 1 ), 4, 'G1P1L-551' ); + $this->checkC( $data, $mk( 5, 5, 2 ), 2, 'G1P1L-552' ); + } + + /** + * Test smart continue - generator=allpages, prop=links|templates, + * list=alllinks|alltransclusions, meta=siteinfo + * @group medium + */ + public function testGen2Prop2List1Meta() { + $this->mVerbose = false; + $mk = function ( $g, $p1, $p2, $l1, $l2 ) { + return [ + 'generator' => 'allpages', + 'gapprefix' => 'AQCT-', + 'gaplimit' => "$g", + 'prop' => 'links|templates', + 'pllimit' => "$p1", + 'tllimit' => "$p2", + 'list' => 'alllinks|alltransclusions', + 'alprefix' => 'AQCT-', + 'alunique' => '', + 'allimit' => "$l1", + 'atprefix' => 'AQCT-', + 'atunique' => '', + 'atlimit' => "$l2", + 'meta' => 'siteinfo', + 'siprop' => 'namespaces', + ]; + }; + // generator + 1 prop + 1 list + $data = $this->query( $mk( 99, 99, 99, 99, 99 ), 1, 'G2P2L1M', false ) + + [ 'batchcomplete' => true ]; + $this->checkC( $data, $mk( 1, 1, 1, 1, 1 ), 16, 'G2P2L1M-11111' ); + $this->checkC( $data, $mk( 2, 2, 2, 2, 2 ), 9, 'G2P2L1M-22222' ); + $this->checkC( $data, $mk( 3, 3, 3, 3, 3 ), 6, 'G2P2L1M-33333' ); + $this->checkC( $data, $mk( 4, 4, 4, 4, 4 ), 4, 'G2P2L1M-44444' ); + $this->checkC( $data, $mk( 5, 5, 5, 5, 5 ), 2, 'G2P2L1M-55555' ); + $this->checkC( $data, $mk( 5, 5, 5, 1, 1 ), 4, 'G2P2L1M-55511' ); + $this->checkC( $data, $mk( 5, 5, 5, 2, 2 ), 2, 'G2P2L1M-55522' ); + $this->checkC( $data, $mk( 5, 1, 1, 5, 5 ), 10, 'G2P2L1M-51155' ); + $this->checkC( $data, $mk( 5, 2, 2, 5, 5 ), 5, 'G2P2L1M-52255' ); + } + + /** + * Test smart continue - generator=templates, prop=templates + * @group medium + */ + public function testSameGenAndProp() { + $this->mVerbose = false; + $mk = function ( $g, $gDir, $p, $pDir ) { + return [ + 'titles' => 'AQCT-1', + 'generator' => 'templates', + 'gtllimit' => "$g", + 'gtldir' => $gDir ? 'ascending' : 'descending', + 'prop' => 'templates', + 'tllimit' => "$p", + 'tldir' => $pDir ? 'ascending' : 'descending', + ]; + }; + // generator + 1 prop + $data = $this->query( $mk( 99, true, 99, true ), 1, 'G=P', false ) + + [ 'batchcomplete' => true ]; + + $this->checkC( $data, $mk( 1, true, 1, true ), 4, 'G=P-1t1t' ); + $this->checkC( $data, $mk( 2, true, 2, true ), 2, 'G=P-2t2t' ); + $this->checkC( $data, $mk( 3, true, 3, true ), 2, 'G=P-3t3t' ); + $this->checkC( $data, $mk( 1, true, 3, true ), 4, 'G=P-1t3t' ); + $this->checkC( $data, $mk( 3, true, 1, true ), 2, 'G=P-3t1t' ); + + $this->checkC( $data, $mk( 1, true, 1, false ), 4, 'G=P-1t1f' ); + $this->checkC( $data, $mk( 2, true, 2, false ), 2, 'G=P-2t2f' ); + $this->checkC( $data, $mk( 3, true, 3, false ), 2, 'G=P-3t3f' ); + $this->checkC( $data, $mk( 1, true, 3, false ), 4, 'G=P-1t3f' ); + $this->checkC( $data, $mk( 3, true, 1, false ), 2, 'G=P-3t1f' ); + + $this->checkC( $data, $mk( 1, false, 1, true ), 4, 'G=P-1f1t' ); + $this->checkC( $data, $mk( 2, false, 2, true ), 2, 'G=P-2f2t' ); + $this->checkC( $data, $mk( 3, false, 3, true ), 2, 'G=P-3f3t' ); + $this->checkC( $data, $mk( 1, false, 3, true ), 4, 'G=P-1f3t' ); + $this->checkC( $data, $mk( 3, false, 1, true ), 2, 'G=P-3f1t' ); + + $this->checkC( $data, $mk( 1, false, 1, false ), 4, 'G=P-1f1f' ); + $this->checkC( $data, $mk( 2, false, 2, false ), 2, 'G=P-2f2f' ); + $this->checkC( $data, $mk( 3, false, 3, false ), 2, 'G=P-3f3f' ); + $this->checkC( $data, $mk( 1, false, 3, false ), 4, 'G=P-1f3f' ); + $this->checkC( $data, $mk( 3, false, 1, false ), 2, 'G=P-3f1f' ); + } + + /** + * Test smart continue - generator=allpages, list=allpages + * @group medium + */ + public function testSameGenList() { + $this->mVerbose = false; + $mk = function ( $g, $gDir, $l, $pDir ) { + return [ + 'generator' => 'allpages', + 'gapprefix' => 'AQCT-', + 'gaplimit' => "$g", + 'gapdir' => $gDir ? 'ascending' : 'descending', + 'list' => 'allpages', + 'apprefix' => 'AQCT-', + 'aplimit' => "$l", + 'apdir' => $pDir ? 'ascending' : 'descending', + ]; + }; + // generator + 1 list + $data = $this->query( $mk( 99, true, 99, true ), 1, 'G=L', false ) + + [ 'batchcomplete' => true ]; + + $this->checkC( $data, $mk( 1, true, 1, true ), 5, 'G=L-1t1t' ); + $this->checkC( $data, $mk( 2, true, 2, true ), 3, 'G=L-2t2t' ); + $this->checkC( $data, $mk( 3, true, 3, true ), 2, 'G=L-3t3t' ); + $this->checkC( $data, $mk( 1, true, 3, true ), 5, 'G=L-1t3t' ); + $this->checkC( $data, $mk( 3, true, 1, true ), 5, 'G=L-3t1t' ); + $this->checkC( $data, $mk( 1, true, 1, false ), 5, 'G=L-1t1f' ); + $this->checkC( $data, $mk( 2, true, 2, false ), 3, 'G=L-2t2f' ); + $this->checkC( $data, $mk( 3, true, 3, false ), 2, 'G=L-3t3f' ); + $this->checkC( $data, $mk( 1, true, 3, false ), 5, 'G=L-1t3f' ); + $this->checkC( $data, $mk( 3, true, 1, false ), 5, 'G=L-3t1f' ); + $this->checkC( $data, $mk( 1, false, 1, true ), 5, 'G=L-1f1t' ); + $this->checkC( $data, $mk( 2, false, 2, true ), 3, 'G=L-2f2t' ); + $this->checkC( $data, $mk( 3, false, 3, true ), 2, 'G=L-3f3t' ); + $this->checkC( $data, $mk( 1, false, 3, true ), 5, 'G=L-1f3t' ); + $this->checkC( $data, $mk( 3, false, 1, true ), 5, 'G=L-3f1t' ); + $this->checkC( $data, $mk( 1, false, 1, false ), 5, 'G=L-1f1f' ); + $this->checkC( $data, $mk( 2, false, 2, false ), 3, 'G=L-2f2f' ); + $this->checkC( $data, $mk( 3, false, 3, false ), 2, 'G=L-3f3f' ); + $this->checkC( $data, $mk( 1, false, 3, false ), 5, 'G=L-1f3f' ); + $this->checkC( $data, $mk( 3, false, 1, false ), 5, 'G=L-3f1f' ); + } +} diff --git a/www/wiki/tests/phpunit/includes/api/query/ApiQueryContinueTestBase.php b/www/wiki/tests/phpunit/includes/api/query/ApiQueryContinueTestBase.php new file mode 100644 index 00000000..d2bdb496 --- /dev/null +++ b/www/wiki/tests/phpunit/includes/api/query/ApiQueryContinueTestBase.php @@ -0,0 +1,210 @@ +<?php +/** + * Copyright © 2013 Yuri Astrakhan "<Firstname><Lastname>@gmail.com" + * + * 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 + */ +abstract class ApiQueryContinueTestBase extends ApiQueryTestBase { + + /** + * Enable to print in-depth debugging info during the test run + */ + protected $mVerbose = false; + + /** + * Run query() and compare against expected values + * @param array $expected + * @param array $params Api parameters + * @param int $expectedCount Max number of iterations + * @param string $id Unit test id + * @param bool $continue True to use smart continue + * @return array Merged results data array + */ + protected function checkC( $expected, $params, $expectedCount, $id, $continue = true ) { + $result = $this->query( $params, $expectedCount, $id, $continue ); + $this->assertResult( $expected, $result, $id ); + } + + /** + * Run query in a loop until no more values are available + * @param array $params Api parameters + * @param int $expectedCount Max number of iterations + * @param string $id Unit test id + * @param bool $useContinue True to use smart continue + * @return array Merged results data array + * @throws Exception + */ + protected function query( $params, $expectedCount, $id, $useContinue = true ) { + if ( isset( $params['action'] ) ) { + $this->assertEquals( 'query', $params['action'], 'Invalid query action' ); + } else { + $params['action'] = 'query'; + } + $count = 0; + $result = []; + $continue = []; + do { + $request = array_merge( $params, $continue ); + uksort( $request, function ( $a, $b ) { + // put 'continue' params at the end - lazy method + $a = strpos( $a, 'continue' ) !== false ? 'zzz ' . $a : $a; + $b = strpos( $b, 'continue' ) !== false ? 'zzz ' . $b : $b; + + return strcmp( $a, $b ); + } ); + $reqStr = http_build_query( $request ); + // $reqStr = str_replace( '&', ' & ', $reqStr ); + $this->assertLessThan( $expectedCount, $count, "$id more data: $reqStr" ); + if ( $this->mVerbose ) { + print "$id (#$count): $reqStr\n"; + } + try { + $data = $this->doApiRequest( $request ); + } catch ( Exception $e ) { + throw new Exception( "$id on $count", 0, $e ); + } + $data = $data[0]; + if ( isset( $data['warnings'] ) ) { + $warnings = json_encode( $data['warnings'] ); + $this->fail( "$id Warnings on #$count in $reqStr\n$warnings" ); + } + $this->assertArrayHasKey( 'query', $data, "$id no 'query' on #$count in $reqStr" ); + if ( isset( $data['continue'] ) ) { + $continue = $data['continue']; + unset( $data['continue'] ); + } else { + $continue = []; + } + if ( $this->mVerbose ) { + $this->printResult( $data ); + } + $this->mergeResult( $result, $data ); + $count++; + if ( empty( $continue ) ) { + $this->assertEquals( $expectedCount, $count, "$id finished early" ); + + return $result; + } elseif ( !$useContinue ) { + $this->assertFalse( 'Non-smart query must be requested all at once' ); + } + } while ( true ); + } + + /** + * @param array $data + */ + private function printResult( $data ) { + $q = $data['query']; + $print = []; + if ( isset( $q['pages'] ) ) { + foreach ( $q['pages'] as $p ) { + $m = $p['title']; + if ( isset( $p['links'] ) ) { + $m .= '/[' . implode( ',', array_map( + function ( $v ) { + return $v['title']; + }, + $p['links'] ) ) . ']'; + } + if ( isset( $p['categories'] ) ) { + $m .= '/(' . implode( ',', array_map( + function ( $v ) { + return str_replace( 'Category:', '', $v['title'] ); + }, + $p['categories'] ) ) . ')'; + } + $print[] = $m; + } + } + if ( isset( $q['allcategories'] ) ) { + $print[] = '*Cats/(' . implode( ',', array_map( + function ( $v ) { + return $v['*']; + }, + $q['allcategories'] ) ) . ')'; + } + self::GetItems( $q, 'allpages', 'Pages', $print ); + self::GetItems( $q, 'alllinks', 'Links', $print ); + self::GetItems( $q, 'alltransclusions', 'Trnscl', $print ); + print ' ' . implode( ' ', $print ) . "\n"; + } + + private static function GetItems( $q, $moduleName, $name, &$print ) { + if ( isset( $q[$moduleName] ) ) { + $print[] = "*$name/[" . implode( ',', + array_map( + function ( $v ) { + return $v['title']; + }, + $q[$moduleName] ) ) . ']'; + } + } + + /** + * Recursively merge the new result returned from the query to the previous results. + * @param mixed &$results + * @param mixed $newResult + * @param bool $numericIds If true, treat keys as ids to be merged instead of appending + */ + protected function mergeResult( &$results, $newResult, $numericIds = false ) { + $this->assertEquals( + is_array( $results ), + is_array( $newResult ), + 'Type of result and data do not match' + ); + if ( !is_array( $results ) ) { + $this->assertEquals( $results, $newResult, 'Repeated result must be the same as before' ); + } else { + $sort = null; + foreach ( $newResult as $key => $value ) { + if ( !$numericIds && $sort === null ) { + if ( !is_array( $value ) ) { + $sort = false; + } elseif ( array_key_exists( 'title', $value ) ) { + $sort = function ( $a, $b ) { + return strcmp( $a['title'], $b['title'] ); + }; + } else { + $sort = false; + } + } + $keyExists = array_key_exists( $key, $results ); + if ( is_numeric( $key ) ) { + if ( $numericIds ) { + if ( !$keyExists ) { + $results[$key] = $value; + } else { + $this->mergeResult( $results[$key], $value ); + } + } else { + $results[] = $value; + } + } elseif ( !$keyExists ) { + $results[$key] = $value; + } else { + $this->mergeResult( $results[$key], $value, $key === 'pages' ); + } + } + if ( $numericIds ) { + ksort( $results, SORT_NUMERIC ); + } elseif ( $sort !== null && $sort !== false ) { + usort( $results, $sort ); + } + } + } +} diff --git a/www/wiki/tests/phpunit/includes/api/query/ApiQueryRevisionsTest.php b/www/wiki/tests/phpunit/includes/api/query/ApiQueryRevisionsTest.php new file mode 100644 index 00000000..38a1d685 --- /dev/null +++ b/www/wiki/tests/phpunit/includes/api/query/ApiQueryRevisionsTest.php @@ -0,0 +1,44 @@ +<?php + +/** + * @group API + * @group Database + * @group medium + * @covers ApiQueryRevisions + */ +class ApiQueryRevisionsTest extends ApiTestCase { + + /** + * @group medium + */ + public function testContentComesWithContentModelAndFormat() { + $pageName = 'Help:' . __METHOD__; + $title = Title::newFromText( $pageName ); + $page = WikiPage::factory( $title ); + + $page->doEditContent( + ContentHandler::makeContent( 'Some text', $page->getTitle() ), + 'inserting content' + ); + + $apiResult = $this->doApiRequest( [ + 'action' => 'query', + 'prop' => 'revisions', + 'titles' => $pageName, + 'rvprop' => 'content', + ] ); + $this->assertArrayHasKey( 'query', $apiResult[0] ); + $this->assertArrayHasKey( 'pages', $apiResult[0]['query'] ); + foreach ( $apiResult[0]['query']['pages'] as $page ) { + $this->assertArrayHasKey( 'revisions', $page ); + foreach ( $page['revisions'] as $revision ) { + $this->assertArrayHasKey( 'contentformat', $revision, + 'contentformat should be included when asking content so client knows how to interpret it' + ); + $this->assertArrayHasKey( 'contentmodel', $revision, + 'contentmodel should be included when asking content so client knows how to interpret it' + ); + } + } + } +} diff --git a/www/wiki/tests/phpunit/includes/api/query/ApiQueryTest.php b/www/wiki/tests/phpunit/includes/api/query/ApiQueryTest.php new file mode 100644 index 00000000..de8d8156 --- /dev/null +++ b/www/wiki/tests/phpunit/includes/api/query/ApiQueryTest.php @@ -0,0 +1,151 @@ +<?php + +/** + * @group API + * @group Database + * @group medium + * @covers ApiQuery + */ +class ApiQueryTest extends ApiTestCase { + protected function setUp() { + parent::setUp(); + + // Setup apiquerytestiw: as interwiki prefix + $this->setMwGlobals( 'wgHooks', [ + 'InterwikiLoadPrefix' => [ + function ( $prefix, &$data ) { + if ( $prefix == 'apiquerytestiw' ) { + $data = [ 'iw_url' => 'wikipedia' ]; + } + return false; + } + ] + ] ); + } + + public function testTitlesGetNormalized() { + global $wgMetaNamespace; + + $this->setMwGlobals( [ + 'wgCapitalLinks' => true, + ] ); + + $data = $this->doApiRequest( [ + 'action' => 'query', + 'titles' => 'Project:articleA|article_B' ] ); + + $this->assertArrayHasKey( 'query', $data[0] ); + $this->assertArrayHasKey( 'normalized', $data[0]['query'] ); + + // Forge a normalized title + $to = Title::newFromText( $wgMetaNamespace . ':ArticleA' ); + + $this->assertEquals( + [ + 'fromencoded' => false, + 'from' => 'Project:articleA', + 'to' => $to->getPrefixedText(), + ], + $data[0]['query']['normalized'][0] + ); + + $this->assertEquals( + [ + 'fromencoded' => false, + 'from' => 'article_B', + 'to' => 'Article B' + ], + $data[0]['query']['normalized'][1] + ); + } + + public function testTitlesAreRejectedIfInvalid() { + $title = false; + while ( !$title || Title::newFromText( $title )->exists() ) { + $title = md5( mt_rand( 0, 100000 ) ); + } + + $data = $this->doApiRequest( [ + 'action' => 'query', + 'titles' => $title . '|Talk:' ] ); + + $this->assertArrayHasKey( 'query', $data[0] ); + $this->assertArrayHasKey( 'pages', $data[0]['query'] ); + $this->assertEquals( 2, count( $data[0]['query']['pages'] ) ); + + $this->assertArrayHasKey( -2, $data[0]['query']['pages'] ); + $this->assertArrayHasKey( -1, $data[0]['query']['pages'] ); + + $this->assertArrayHasKey( 'missing', $data[0]['query']['pages'][-2] ); + $this->assertArrayHasKey( 'invalid', $data[0]['query']['pages'][-1] ); + } + + public function testTitlesWithWhitespaces() { + $data = $this->doApiRequest( [ + 'action' => 'query', + 'titles' => ' ' + ] ); + + $this->assertArrayHasKey( 'query', $data[0] ); + $this->assertArrayHasKey( 'pages', $data[0]['query'] ); + $this->assertEquals( 1, count( $data[0]['query']['pages'] ) ); + $this->assertArrayHasKey( -1, $data[0]['query']['pages'] ); + $this->assertArrayHasKey( 'invalid', $data[0]['query']['pages'][-1] ); + } + + /** + * Test the ApiBase::titlePartToKey function + * + * @param string $titlePart + * @param int $namespace + * @param string $expected + * @param string $expectException + * @dataProvider provideTestTitlePartToKey + */ + function testTitlePartToKey( $titlePart, $namespace, $expected, $expectException ) { + $this->setMwGlobals( [ + 'wgCapitalLinks' => true, + ] ); + + $api = new MockApiQueryBase(); + $exceptionCaught = false; + try { + $this->assertEquals( $expected, $api->titlePartToKey( $titlePart, $namespace ) ); + } catch ( ApiUsageException $e ) { + $exceptionCaught = true; + } + $this->assertEquals( $expectException, $exceptionCaught, + 'ApiUsageException thrown by titlePartToKey' ); + } + + function provideTestTitlePartToKey() { + return [ + [ 'a b c', NS_MAIN, 'A_b_c', false ], + [ 'x', NS_MAIN, 'X', false ], + [ 'y ', NS_MAIN, 'Y_', false ], + [ 'template:foo', NS_CATEGORY, 'Template:foo', false ], + [ 'apiquerytestiw:foo', NS_CATEGORY, 'Apiquerytestiw:foo', false ], + [ "\xF7", NS_MAIN, null, true ], + [ 'template:foo', NS_MAIN, null, true ], + [ 'apiquerytestiw:foo', NS_MAIN, null, true ], + ]; + } + + /** + * Test if all classes in the query module manager exists + */ + public function testClassNamesInModuleManager() { + $api = new ApiMain( + new FauxRequest( [ 'action' => 'query', 'meta' => 'siteinfo' ] ) + ); + $queryApi = new ApiQuery( $api, 'query' ); + $modules = $queryApi->getModuleManager()->getNamesWithClasses(); + + foreach ( $modules as $name => $class ) { + $this->assertTrue( + class_exists( $class ), + 'Class ' . $class . ' for api module ' . $name . ' does not exist (with exact case)' + ); + } + } +} diff --git a/www/wiki/tests/phpunit/includes/api/query/ApiQueryTestBase.php b/www/wiki/tests/phpunit/includes/api/query/ApiQueryTestBase.php new file mode 100644 index 00000000..e7588cb5 --- /dev/null +++ b/www/wiki/tests/phpunit/includes/api/query/ApiQueryTestBase.php @@ -0,0 +1,158 @@ +<?php +/** + * Copyright © 2013 Yuri Astrakhan "<Firstname><Lastname>@gmail.com" + * + * 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 3 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 + */ + +/** This class has some common functionality for testing query module + */ +abstract class ApiQueryTestBase extends ApiTestCase { + + const PARAM_ASSERT = <<<STR +Each parameter must be an array of two elements, +first - an array of params to the API call, +and the second array - expected results as returned by the API +STR; + + /** + * Merges all requests parameter + expected values into one + * @param array $v,... List of arrays, each of which contains exactly two + * @return array + */ + protected function merge( /*...*/ ) { + $request = []; + $expected = []; + foreach ( func_get_args() as $v ) { + list( $req, $exp ) = $this->validateRequestExpectedPair( $v ); + $request = array_merge_recursive( $request, $req ); + $this->mergeExpected( $expected, $exp ); + } + + return [ $request, $expected ]; + } + + /** + * Check that the parameter is a valid two element array, + * with the first element being API request and the second - expected result + * @param array $v + * @return array + */ + private function validateRequestExpectedPair( $v ) { + $this->assertInternalType( 'array', $v, self::PARAM_ASSERT ); + $this->assertEquals( 2, count( $v ), self::PARAM_ASSERT ); + $this->assertArrayHasKey( 0, $v, self::PARAM_ASSERT ); + $this->assertArrayHasKey( 1, $v, self::PARAM_ASSERT ); + $this->assertInternalType( 'array', $v[0], self::PARAM_ASSERT ); + $this->assertInternalType( 'array', $v[1], self::PARAM_ASSERT ); + + return $v; + } + + /** + * Recursively merges the expected values in the $item into the $all + * @param array &$all + * @param array $item + */ + private function mergeExpected( &$all, $item ) { + foreach ( $item as $k => $v ) { + if ( array_key_exists( $k, $all ) ) { + if ( is_array( $all[$k] ) ) { + $this->mergeExpected( $all[$k], $v ); + } else { + $this->assertEquals( $all[$k], $v ); + } + } else { + $all[$k] = $v; + } + } + } + + /** + * Checks that the request's result matches the expected results. + * Assumes no rawcontinue and a complete batch. + * @param array $values Array is a two element array( request, expected_results ) + * @param array $session + * @param bool $appendModule + * @param User $user + */ + protected function check( $values, array $session = null, + $appendModule = false, User $user = null + ) { + list( $req, $exp ) = $this->validateRequestExpectedPair( $values ); + if ( !array_key_exists( 'action', $req ) ) { + $req['action'] = 'query'; + } + foreach ( $req as &$val ) { + if ( is_array( $val ) ) { + $val = implode( '|', array_unique( $val ) ); + } + } + $result = $this->doApiRequest( $req, $session, $appendModule, $user ); + $this->assertResult( [ 'batchcomplete' => true, 'query' => $exp ], $result[0], $req ); + } + + protected function assertResult( $exp, $result, $message = '' ) { + try { + $exp = self::sanitizeResultArray( $exp ); + $result = self::sanitizeResultArray( $result ); + $this->assertEquals( $exp, $result ); + } catch ( PHPUnit_Framework_ExpectationFailedException $e ) { + if ( is_array( $message ) ) { + $message = http_build_query( $message ); + } + + // FIXME: once we migrate to phpunit 4.1+, hardcode ComparisonFailure exception use + $compEx = 'SebastianBergmann\Comparator\ComparisonFailure'; + if ( !class_exists( $compEx ) ) { + $compEx = 'PHPUnit_Framework_ComparisonFailure'; + } + + throw new PHPUnit_Framework_ExpectationFailedException( + $e->getMessage() . "\nRequest: $message", + new $compEx( + $exp, + $result, + print_r( $exp, true ), + print_r( $result, true ), + false, + $e->getComparisonFailure()->getMessage() . "\nRequest: $message" + ) + ); + } + } + + /** + * Recursively ksorts a result array and removes any 'pageid' keys. + * @param array $result + * @return array + */ + private static function sanitizeResultArray( $result ) { + unset( $result['pageid'] ); + foreach ( $result as $key => $value ) { + if ( is_array( $value ) ) { + $result[$key] = self::sanitizeResultArray( $value ); + } + } + + // Sort the result by keys, then take advantage of how array_merge will + // renumber numeric keys while leaving others alone. + ksort( $result ); + return array_merge( $result ); + } +} diff --git a/www/wiki/tests/phpunit/includes/api/query/ApiQueryUserContributionsTest.php b/www/wiki/tests/phpunit/includes/api/query/ApiQueryUserContributionsTest.php new file mode 100644 index 00000000..ca6a929a --- /dev/null +++ b/www/wiki/tests/phpunit/includes/api/query/ApiQueryUserContributionsTest.php @@ -0,0 +1,194 @@ +<?php + +/** + * @group API + * @group Database + * @group medium + * @covers ApiQueryContributions + */ +class ApiQueryContributionsTest extends ApiTestCase { + public function addDBDataOnce() { + global $wgActorTableSchemaMigrationStage; + + $reset = new \Wikimedia\ScopedCallback( function ( $v ) { + global $wgActorTableSchemaMigrationStage; + $wgActorTableSchemaMigrationStage = $v; + $this->overrideMwServices(); + }, [ $wgActorTableSchemaMigrationStage ] ); + $wgActorTableSchemaMigrationStage = MIGRATION_WRITE_BOTH; + $this->overrideMwServices(); + + $users = [ + User::newFromName( '192.168.2.2', false ), + User::newFromName( '192.168.2.1', false ), + User::newFromName( '192.168.2.3', false ), + User::createNew( __CLASS__ . ' B' ), + User::createNew( __CLASS__ . ' A' ), + User::createNew( __CLASS__ . ' C' ), + User::newFromName( 'IW>' . __CLASS__, false ), + ]; + + $title = Title::newFromText( __CLASS__ ); + $page = WikiPage::factory( $title ); + for ( $i = 0; $i < 3; $i++ ) { + foreach ( array_reverse( $users ) as $user ) { + $status = $page->doEditContent( + ContentHandler::makeContent( "Test revision $user #$i", $title ), 'Test edit', 0, false, $user + ); + if ( !$status->isOK() ) { + $this->fail( "Failed to edit $title: " . $status->getWikiText( false, false, 'en' ) ); + } + } + } + } + + /** + * @dataProvider provideSorting + * @param int $stage One of the MIGRATION_* constants for $wgActorTableSchemaMigrationStage + * @param array $params Extra parameters for the query + * @param bool $reverse Reverse order? + * @param int $revs Number of revisions to expect + */ + public function testSorting( $stage, $params, $reverse, $revs ) { + if ( isset( $params['ucuserprefix'] ) && + ( $stage === MIGRATION_WRITE_BOTH || $stage === MIGRATION_WRITE_NEW ) && + $this->db->getType() === 'mysql' && $this->usesTemporaryTables() + ) { + // https://bugs.mysql.com/bug.php?id=10327 + $this->markTestSkipped( 'MySQL bug 10327 - can\'t reopen temporary tables' ); + } + + $this->setMwGlobals( 'wgActorTableSchemaMigrationStage', $stage ); + $this->overrideMwServices(); + + if ( isset( $params['ucuserids'] ) ) { + $params['ucuserids'] = implode( '|', array_map( 'User::idFromName', $params['ucuserids'] ) ); + } + if ( isset( $params['ucuser'] ) ) { + $params['ucuser'] = implode( '|', $params['ucuser'] ); + } + + $sort = 'rsort'; + if ( $reverse ) { + $params['ucdir'] = 'newer'; + $sort = 'sort'; + } + + $params += [ + 'action' => 'query', + 'list' => 'usercontribs', + 'ucprop' => 'ids', + ]; + + $apiResult = $this->doApiRequest( $params + [ 'uclimit' => 500 ] ); + $this->assertArrayNotHasKey( 'continue', $apiResult[0] ); + $this->assertArrayHasKey( 'query', $apiResult[0] ); + $this->assertArrayHasKey( 'usercontribs', $apiResult[0]['query'] ); + + $count = 0; + $ids = []; + foreach ( $apiResult[0]['query']['usercontribs'] as $page ) { + $count++; + $ids[$page['user']][] = $page['revid']; + } + $this->assertSame( $revs, $count, 'Expected number of revisions' ); + foreach ( $ids as $user => $revids ) { + $sorted = $revids; + call_user_func_array( $sort, [ &$sorted ] ); + $this->assertSame( $sorted, $revids, "IDs for $user are sorted" ); + } + + for ( $limit = 1; $limit < $revs; $limit++ ) { + $continue = []; + $count = 0; + $batchedIds = []; + while ( $continue !== null ) { + $apiResult = $this->doApiRequest( $params + [ 'uclimit' => $limit ] + $continue ); + $this->assertArrayHasKey( 'query', $apiResult[0], "Batching with limit $limit" ); + $this->assertArrayHasKey( 'usercontribs', $apiResult[0]['query'], + "Batching with limit $limit" ); + $continue = isset( $apiResult[0]['continue'] ) ? $apiResult[0]['continue'] : null; + foreach ( $apiResult[0]['query']['usercontribs'] as $page ) { + $count++; + $batchedIds[$page['user']][] = $page['revid']; + } + $this->assertLessThanOrEqual( $revs, $count, "Batching with limit $limit" ); + } + $this->assertSame( $ids, $batchedIds, "Result set is the same when batching with limit $limit" ); + } + } + + public static function provideSorting() { + $users = [ __CLASS__ . ' A', __CLASS__ . ' B', __CLASS__ . ' C' ]; + $users2 = [ __CLASS__ . ' A', __CLASS__ . ' B', __CLASS__ . ' D' ]; + $ips = [ '192.168.2.1', '192.168.2.2', '192.168.2.3', '192.168.2.4' ]; + + foreach ( + [ + 'old' => MIGRATION_OLD, + 'write both' => MIGRATION_WRITE_BOTH, + 'write new' => MIGRATION_WRITE_NEW, + 'new' => MIGRATION_NEW, + ] as $stageName => $stage + ) { + foreach ( [ false, true ] as $reverse ) { + $name = $stageName . ( $reverse ? ', reverse' : '' ); + yield "Named users, $name" => [ $stage, [ 'ucuser' => $users ], $reverse, 9 ]; + yield "Named users including a no-edit user, $name" => [ + $stage, [ 'ucuser' => $users2 ], $reverse, 6 + ]; + yield "IP users, $name" => [ $stage, [ 'ucuser' => $ips ], $reverse, 9 ]; + yield "All users, $name" => [ + $stage, [ 'ucuser' => array_merge( $users, $ips ) ], $reverse, 18 + ]; + yield "User IDs, $name" => [ $stage, [ 'ucuserids' => $users ], $reverse, 9 ]; + yield "Users by prefix, $name" => [ $stage, [ 'ucuserprefix' => __CLASS__ ], $reverse, 9 ]; + yield "IPs by prefix, $name" => [ $stage, [ 'ucuserprefix' => '192.168.2.' ], $reverse, 9 ]; + } + } + } + + /** + * @dataProvider provideInterwikiUser + * @param int $stage One of the MIGRATION_* constants for $wgActorTableSchemaMigrationStage + */ + public function testInterwikiUser( $stage ) { + $this->setMwGlobals( 'wgActorTableSchemaMigrationStage', $stage ); + $this->overrideMwServices(); + + $params = [ + 'action' => 'query', + 'list' => 'usercontribs', + 'ucuser' => 'IW>' . __CLASS__, + 'ucprop' => 'ids', + 'uclimit' => 'max', + ]; + + $apiResult = $this->doApiRequest( $params ); + $this->assertArrayNotHasKey( 'continue', $apiResult[0] ); + $this->assertArrayHasKey( 'query', $apiResult[0] ); + $this->assertArrayHasKey( 'usercontribs', $apiResult[0]['query'] ); + + $count = 0; + $ids = []; + foreach ( $apiResult[0]['query']['usercontribs'] as $page ) { + $count++; + $this->assertSame( 'IW>' . __CLASS__, $page['user'], 'Correct user returned' ); + $ids[] = $page['revid']; + } + $this->assertSame( 3, $count, 'Expected number of revisions' ); + $sorted = $ids; + rsort( $sorted ); + $this->assertSame( $sorted, $ids, "IDs are sorted" ); + } + + public static function provideInterwikiUser() { + return [ + 'old' => [ MIGRATION_OLD ], + 'write both' => [ MIGRATION_WRITE_BOTH ], + 'write new' => [ MIGRATION_WRITE_NEW ], + 'new' => [ MIGRATION_NEW ], + ]; + } + +} |