123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543 |
- <?php
- use MediaWiki\MediaWikiServices;
- /**
- * @group API
- * @group Database
- * @group medium
- *
- * @covers ApiQueryWatchlistRaw
- */
- class ApiQueryWatchlistRawIntegrationTest extends ApiTestCase {
- protected function setUp() {
- parent::setUp();
- self::$users['ApiQueryWatchlistRawIntegrationTestUser']
- = $this->getMutableTestUser();
- self::$users['ApiQueryWatchlistRawIntegrationTestUser2']
- = $this->getMutableTestUser();
- }
- private function getLoggedInTestUser() {
- return self::$users['ApiQueryWatchlistRawIntegrationTestUser']->getUser();
- }
- private function getNotLoggedInTestUser() {
- return self::$users['ApiQueryWatchlistRawIntegrationTestUser2']->getUser();
- }
- private function getWatchedItemStore() {
- return MediaWikiServices::getInstance()->getWatchedItemStore();
- }
- private function doListWatchlistRawRequest( array $params = [] ) {
- return $this->doApiRequest( array_merge(
- [ 'action' => 'query', 'list' => 'watchlistraw' ],
- $params
- ), null, false, $this->getLoggedInTestUser() );
- }
- private function doGeneratorWatchlistRawRequest( array $params = [] ) {
- return $this->doApiRequest( array_merge(
- [ 'action' => 'query', 'generator' => 'watchlistraw' ],
- $params
- ), null, false, $this->getLoggedInTestUser() );
- }
- private function getItemsFromApiResponse( array $response ) {
- return $response[0]['watchlistraw'];
- }
- public function testListWatchlistRaw_returnsWatchedItems() {
- $store = $this->getWatchedItemStore();
- $store->addWatch(
- $this->getLoggedInTestUser(),
- new TitleValue( 0, 'ApiQueryWatchlistRawIntegrationTestPage' )
- );
- $result = $this->doListWatchlistRawRequest();
- $this->assertArrayHasKey( 'watchlistraw', $result[0] );
- $this->assertEquals(
- [
- [
- 'ns' => 0,
- 'title' => 'ApiQueryWatchlistRawIntegrationTestPage',
- ],
- ],
- $this->getItemsFromApiResponse( $result )
- );
- }
- public function testPropChanged_addsNotificationTimestamp() {
- $target = new TitleValue( 0, 'ApiQueryWatchlistRawIntegrationTestPage' );
- $otherUser = $this->getNotLoggedInTestUser();
- $store = $this->getWatchedItemStore();
- $store->addWatch( $this->getLoggedInTestUser(), $target );
- $store->updateNotificationTimestamp(
- $otherUser,
- $target,
- '20151212010101'
- );
- $result = $this->doListWatchlistRawRequest( [ 'wrprop' => 'changed' ] );
- $this->assertEquals(
- [
- [
- 'ns' => 0,
- 'title' => 'ApiQueryWatchlistRawIntegrationTestPage',
- 'changed' => '2015-12-12T01:01:01Z',
- ],
- ],
- $this->getItemsFromApiResponse( $result )
- );
- }
- public function testNamespaceParam() {
- $store = $this->getWatchedItemStore();
- $store->addWatchBatchForUser( $this->getLoggedInTestUser(), [
- new TitleValue( 0, 'ApiQueryWatchlistRawIntegrationTestPage' ),
- new TitleValue( 1, 'ApiQueryWatchlistRawIntegrationTestPage' ),
- ] );
- $result = $this->doListWatchlistRawRequest( [ 'wrnamespace' => '0' ] );
- $this->assertEquals(
- [
- [
- 'ns' => 0,
- 'title' => 'ApiQueryWatchlistRawIntegrationTestPage',
- ],
- ],
- $this->getItemsFromApiResponse( $result )
- );
- }
- public function testShowChangedParams() {
- $subjectTarget = new TitleValue( 0, 'ApiQueryWatchlistRawIntegrationTestPage' );
- $talkTarget = new TitleValue( 1, 'ApiQueryWatchlistRawIntegrationTestPage' );
- $otherUser = $this->getNotLoggedInTestUser();
- $store = $this->getWatchedItemStore();
- $store->addWatchBatchForUser( $this->getLoggedInTestUser(), [
- $subjectTarget,
- $talkTarget,
- ] );
- $store->updateNotificationTimestamp(
- $otherUser,
- $subjectTarget,
- '20151212010101'
- );
- $resultChanged = $this->doListWatchlistRawRequest(
- [ 'wrprop' => 'changed', 'wrshow' => WatchedItemQueryService::FILTER_CHANGED ]
- );
- $resultNotChanged = $this->doListWatchlistRawRequest(
- [ 'wrprop' => 'changed', 'wrshow' => WatchedItemQueryService::FILTER_NOT_CHANGED ]
- );
- $this->assertEquals(
- [
- [
- 'ns' => 0,
- 'title' => 'ApiQueryWatchlistRawIntegrationTestPage',
- 'changed' => '2015-12-12T01:01:01Z',
- ],
- ],
- $this->getItemsFromApiResponse( $resultChanged )
- );
- $this->assertEquals(
- [
- [
- 'ns' => 1,
- 'title' => 'Talk:ApiQueryWatchlistRawIntegrationTestPage',
- ],
- ],
- $this->getItemsFromApiResponse( $resultNotChanged )
- );
- }
- public function testLimitParam() {
- $store = $this->getWatchedItemStore();
- $store->addWatchBatchForUser( $this->getLoggedInTestUser(), [
- new TitleValue( 0, 'ApiQueryWatchlistRawIntegrationTestPage1' ),
- new TitleValue( 1, 'ApiQueryWatchlistRawIntegrationTestPage1' ),
- new TitleValue( 0, 'ApiQueryWatchlistRawIntegrationTestPage2' ),
- ] );
- $resultWithoutLimit = $this->doListWatchlistRawRequest();
- $resultWithLimit = $this->doListWatchlistRawRequest( [ 'wrlimit' => 2 ] );
- $this->assertEquals(
- [
- [
- 'ns' => 0,
- 'title' => 'ApiQueryWatchlistRawIntegrationTestPage1',
- ],
- [
- 'ns' => 0,
- 'title' => 'ApiQueryWatchlistRawIntegrationTestPage2',
- ],
- [
- 'ns' => 1,
- 'title' => 'Talk:ApiQueryWatchlistRawIntegrationTestPage1',
- ],
- ],
- $this->getItemsFromApiResponse( $resultWithoutLimit )
- );
- $this->assertEquals(
- [
- [
- 'ns' => 0,
- 'title' => 'ApiQueryWatchlistRawIntegrationTestPage1',
- ],
- [
- 'ns' => 0,
- 'title' => 'ApiQueryWatchlistRawIntegrationTestPage2',
- ],
- ],
- $this->getItemsFromApiResponse( $resultWithLimit )
- );
- $this->assertArrayNotHasKey( 'continue', $resultWithoutLimit[0] );
- $this->assertArrayHasKey( 'continue', $resultWithLimit[0] );
- $this->assertArrayHasKey( 'wrcontinue', $resultWithLimit[0]['continue'] );
- }
- public function testDirParams() {
- $store = $this->getWatchedItemStore();
- $store->addWatchBatchForUser( $this->getLoggedInTestUser(), [
- new TitleValue( 0, 'ApiQueryWatchlistRawIntegrationTestPage1' ),
- new TitleValue( 1, 'ApiQueryWatchlistRawIntegrationTestPage1' ),
- new TitleValue( 0, 'ApiQueryWatchlistRawIntegrationTestPage2' ),
- ] );
- $resultDirAsc = $this->doListWatchlistRawRequest( [ 'wrdir' => 'ascending' ] );
- $resultDirDesc = $this->doListWatchlistRawRequest( [ 'wrdir' => 'descending' ] );
- $this->assertEquals(
- [
- [
- 'ns' => 0,
- 'title' => 'ApiQueryWatchlistRawIntegrationTestPage1',
- ],
- [
- 'ns' => 0,
- 'title' => 'ApiQueryWatchlistRawIntegrationTestPage2',
- ],
- [
- 'ns' => 1,
- 'title' => 'Talk:ApiQueryWatchlistRawIntegrationTestPage1',
- ],
- ],
- $this->getItemsFromApiResponse( $resultDirAsc )
- );
- $this->assertEquals(
- [
- [
- 'ns' => 1,
- 'title' => 'Talk:ApiQueryWatchlistRawIntegrationTestPage1',
- ],
- [
- 'ns' => 0,
- 'title' => 'ApiQueryWatchlistRawIntegrationTestPage2',
- ],
- [
- 'ns' => 0,
- 'title' => 'ApiQueryWatchlistRawIntegrationTestPage1',
- ],
- ],
- $this->getItemsFromApiResponse( $resultDirDesc )
- );
- }
- public function testAscendingIsDefaultOrder() {
- $store = $this->getWatchedItemStore();
- $store->addWatchBatchForUser( $this->getLoggedInTestUser(), [
- new TitleValue( 0, 'ApiQueryWatchlistRawIntegrationTestPage1' ),
- new TitleValue( 1, 'ApiQueryWatchlistRawIntegrationTestPage1' ),
- new TitleValue( 0, 'ApiQueryWatchlistRawIntegrationTestPage2' ),
- ] );
- $resultNoDir = $this->doListWatchlistRawRequest();
- $resultAscDir = $this->doListWatchlistRawRequest( [ 'wrdir' => 'ascending' ] );
- $this->assertEquals(
- $this->getItemsFromApiResponse( $resultNoDir ),
- $this->getItemsFromApiResponse( $resultAscDir )
- );
- }
- public function testFromTitleParam() {
- $store = $this->getWatchedItemStore();
- $store->addWatchBatchForUser( $this->getLoggedInTestUser(), [
- new TitleValue( 0, 'ApiQueryWatchlistRawIntegrationTestPage1' ),
- new TitleValue( 0, 'ApiQueryWatchlistRawIntegrationTestPage2' ),
- new TitleValue( 0, 'ApiQueryWatchlistRawIntegrationTestPage3' ),
- ] );
- $result = $this->doListWatchlistRawRequest( [
- 'wrfromtitle' => 'ApiQueryWatchlistRawIntegrationTestPage2',
- ] );
- $this->assertEquals(
- [
- [
- 'ns' => 0,
- 'title' => 'ApiQueryWatchlistRawIntegrationTestPage2',
- ],
- [
- 'ns' => 0,
- 'title' => 'ApiQueryWatchlistRawIntegrationTestPage3',
- ],
- ],
- $this->getItemsFromApiResponse( $result )
- );
- }
- public function testToTitleParam() {
- $store = $this->getWatchedItemStore();
- $store->addWatchBatchForUser( $this->getLoggedInTestUser(), [
- new TitleValue( 0, 'ApiQueryWatchlistRawIntegrationTestPage1' ),
- new TitleValue( 0, 'ApiQueryWatchlistRawIntegrationTestPage2' ),
- new TitleValue( 0, 'ApiQueryWatchlistRawIntegrationTestPage3' ),
- ] );
- $result = $this->doListWatchlistRawRequest( [
- 'wrtotitle' => 'ApiQueryWatchlistRawIntegrationTestPage2',
- ] );
- $this->assertEquals(
- [
- [
- 'ns' => 0,
- 'title' => 'ApiQueryWatchlistRawIntegrationTestPage1',
- ],
- [
- 'ns' => 0,
- 'title' => 'ApiQueryWatchlistRawIntegrationTestPage2',
- ],
- ],
- $this->getItemsFromApiResponse( $result )
- );
- }
- public function testContinueParam() {
- $store = $this->getWatchedItemStore();
- $store->addWatchBatchForUser( $this->getLoggedInTestUser(), [
- new TitleValue( 0, 'ApiQueryWatchlistRawIntegrationTestPage1' ),
- new TitleValue( 0, 'ApiQueryWatchlistRawIntegrationTestPage2' ),
- new TitleValue( 0, 'ApiQueryWatchlistRawIntegrationTestPage3' ),
- ] );
- $firstResult = $this->doListWatchlistRawRequest( [ 'wrlimit' => 2 ] );
- $continuationParam = $firstResult[0]['continue']['wrcontinue'];
- $this->assertEquals( '0|ApiQueryWatchlistRawIntegrationTestPage3', $continuationParam );
- $continuedResult = $this->doListWatchlistRawRequest( [ 'wrcontinue' => $continuationParam ] );
- $this->assertEquals(
- [
- [
- 'ns' => 0,
- 'title' => 'ApiQueryWatchlistRawIntegrationTestPage3',
- ]
- ],
- $this->getItemsFromApiResponse( $continuedResult )
- );
- }
- public function fromTitleToTitleContinueComboProvider() {
- return [
- [
- [
- 'wrfromtitle' => 'ApiQueryWatchlistRawIntegrationTestPage1',
- 'wrtotitle' => 'ApiQueryWatchlistRawIntegrationTestPage2',
- ],
- [
- [ 'ns' => 0, 'title' => 'ApiQueryWatchlistRawIntegrationTestPage1' ],
- [ 'ns' => 0, 'title' => 'ApiQueryWatchlistRawIntegrationTestPage2' ],
- ],
- ],
- [
- [
- 'wrfromtitle' => 'ApiQueryWatchlistRawIntegrationTestPage1',
- 'wrcontinue' => '0|ApiQueryWatchlistRawIntegrationTestPage3',
- ],
- [
- [ 'ns' => 0, 'title' => 'ApiQueryWatchlistRawIntegrationTestPage3' ],
- ],
- ],
- [
- [
- 'wrtotitle' => 'ApiQueryWatchlistRawIntegrationTestPage3',
- 'wrcontinue' => '0|ApiQueryWatchlistRawIntegrationTestPage2',
- ],
- [
- [ 'ns' => 0, 'title' => 'ApiQueryWatchlistRawIntegrationTestPage2' ],
- [ 'ns' => 0, 'title' => 'ApiQueryWatchlistRawIntegrationTestPage3' ],
- ],
- ],
- [
- [
- 'wrfromtitle' => 'ApiQueryWatchlistRawIntegrationTestPage1',
- 'wrtotitle' => 'ApiQueryWatchlistRawIntegrationTestPage3',
- 'wrcontinue' => '0|ApiQueryWatchlistRawIntegrationTestPage3',
- ],
- [
- [ 'ns' => 0, 'title' => 'ApiQueryWatchlistRawIntegrationTestPage3' ],
- ],
- ],
- ];
- }
- /**
- * @dataProvider fromTitleToTitleContinueComboProvider
- */
- public function testFromTitleToTitleContinueCombo( array $params, array $expectedItems ) {
- $store = $this->getWatchedItemStore();
- $store->addWatchBatchForUser( $this->getLoggedInTestUser(), [
- new TitleValue( 0, 'ApiQueryWatchlistRawIntegrationTestPage1' ),
- new TitleValue( 0, 'ApiQueryWatchlistRawIntegrationTestPage2' ),
- new TitleValue( 0, 'ApiQueryWatchlistRawIntegrationTestPage3' ),
- ] );
- $result = $this->doListWatchlistRawRequest( $params );
- $this->assertEquals( $expectedItems, $this->getItemsFromApiResponse( $result ) );
- }
- public function fromTitleToTitleContinueSelfContradictoryComboProvider() {
- return [
- [
- [
- 'wrfromtitle' => 'ApiQueryWatchlistRawIntegrationTestPage2',
- 'wrtotitle' => 'ApiQueryWatchlistRawIntegrationTestPage1',
- ]
- ],
- [
- [
- 'wrfromtitle' => 'ApiQueryWatchlistRawIntegrationTestPage1',
- 'wrtotitle' => 'ApiQueryWatchlistRawIntegrationTestPage2',
- 'wrdir' => 'descending',
- ]
- ],
- [
- [
- 'wrtotitle' => 'ApiQueryWatchlistRawIntegrationTestPage1',
- 'wrcontinue' => '0|ApiQueryWatchlistRawIntegrationTestPage2',
- ]
- ],
- ];
- }
- /**
- * @dataProvider fromTitleToTitleContinueSelfContradictoryComboProvider
- */
- public function testFromTitleToTitleContinueSelfContradictoryCombo( array $params ) {
- $store = $this->getWatchedItemStore();
- $store->addWatchBatchForUser( $this->getLoggedInTestUser(), [
- new TitleValue( 0, 'ApiQueryWatchlistRawIntegrationTestPage1' ),
- new TitleValue( 0, 'ApiQueryWatchlistRawIntegrationTestPage2' ),
- ] );
- $result = $this->doListWatchlistRawRequest( $params );
- $this->assertEmpty( $this->getItemsFromApiResponse( $result ) );
- $this->assertArrayNotHasKey( 'continue', $result[0] );
- }
- public function testOwnerAndTokenParams() {
- $otherUser = $this->getNotLoggedInTestUser();
- $otherUser->setOption( 'watchlisttoken', '1234567890' );
- $otherUser->saveSettings();
- $store = $this->getWatchedItemStore();
- $store->addWatchBatchForUser( $otherUser, [
- new TitleValue( 0, 'ApiQueryWatchlistRawIntegrationTestPage1' ),
- new TitleValue( 1, 'ApiQueryWatchlistRawIntegrationTestPage1' ),
- ] );
- ObjectCache::getMainWANInstance()->clearProcessCache();
- $result = $this->doListWatchlistRawRequest( [
- 'wrowner' => $otherUser->getName(),
- 'wrtoken' => '1234567890',
- ] );
- $this->assertEquals(
- [
- [
- 'ns' => 0,
- 'title' => 'ApiQueryWatchlistRawIntegrationTestPage1',
- ],
- [
- 'ns' => 1,
- 'title' => 'Talk:ApiQueryWatchlistRawIntegrationTestPage1',
- ],
- ],
- $this->getItemsFromApiResponse( $result )
- );
- }
- public function testOwnerAndTokenParams_wrongToken() {
- $otherUser = $this->getNotLoggedInTestUser();
- $otherUser->setOption( 'watchlisttoken', '1234567890' );
- $otherUser->saveSettings();
- $this->setExpectedException( ApiUsageException::class, 'Incorrect watchlist token provided' );
- $this->doListWatchlistRawRequest( [
- 'wrowner' => $otherUser->getName(),
- 'wrtoken' => 'wrong-token',
- ] );
- }
- public function testOwnerAndTokenParams_userHasNoWatchlistToken() {
- $this->setExpectedException( ApiUsageException::class, 'Incorrect watchlist token provided' );
- $this->doListWatchlistRawRequest( [
- 'wrowner' => $this->getNotLoggedInTestUser()->getName(),
- 'wrtoken' => 'some-watchlist-token',
- ] );
- }
- public function testGeneratorWatchlistRawPropInfo_returnsWatchedItems() {
- $store = $this->getWatchedItemStore();
- $store->addWatch(
- $this->getLoggedInTestUser(),
- new TitleValue( 0, 'ApiQueryWatchlistRawIntegrationTestPage' )
- );
- $result = $this->doGeneratorWatchlistRawRequest( [ 'prop' => 'info' ] );
- $this->assertArrayHasKey( 'query', $result[0] );
- $this->assertArrayHasKey( 'pages', $result[0]['query'] );
- $this->assertCount( 1, $result[0]['query']['pages'] );
- // $result[0]['query']['pages'] uses page ids as keys
- $item = array_values( $result[0]['query']['pages'] )[0];
- $this->assertEquals( 0, $item['ns'] );
- $this->assertEquals( 'ApiQueryWatchlistRawIntegrationTestPage', $item['title'] );
- }
- }
|