ApiWatchTest.php

Go to the documentation of this file.

<?php

class ApiWatchTest extends ApiTestCase {

        function setUp() {
                parent::setUp();
                $this->doLogin();
        }

        function getTokens() {
                $data = $this->getTokenList( self::$users['sysop'] );

                $keys = array_keys( $data[0]['query']['pages'] );
                $key = array_pop( $keys );
                $pageinfo = $data[0]['query']['pages'][$key];

                return $pageinfo;
        }

        function testWatchEdit() {
                $pageinfo = $this->getTokens();

                $data = $this->doApiRequest( array(
                        'action' => 'edit',
                        'title' => 'UTPage',
                        'text' => 'new text',
                        'token' => $pageinfo['edittoken'],
                        'watchlist' => 'watch' ) );
                $this->assertArrayHasKey( 'edit', $data[0] );
                $this->assertArrayHasKey( 'result', $data[0]['edit'] );
                $this->assertEquals( 'Success', $data[0]['edit']['result'] );

                return $data;
        }

        function testWatchClear() {

                $pageinfo = $this->getTokens();

                $data = $this->doApiRequest( array(
                        'action' => 'query',
                        'list' => 'watchlist' ) );

                if ( isset( $data[0]['query']['watchlist'] ) ) {
                        $wl = $data[0]['query']['watchlist'];

                        foreach ( $wl as $page ) {
                                $data = $this->doApiRequest( array(
                                        'action' => 'watch',
                                        'title' => $page['title'],
                                        'unwatch' => true,
                                        'token' => $pageinfo['watchtoken'] ) );
                        }
                }
                $data = $this->doApiRequest( array(
                        'action' => 'query',
                        'list' => 'watchlist' ), $data );
                $this->assertArrayHasKey( 'query', $data[0] );
                $this->assertArrayHasKey( 'watchlist', $data[0]['query'] );
                $this->assertEquals( 0, count( $data[0]['query']['watchlist'] ) );

                return $data;
        }

        function testWatchProtect() {

                $pageinfo = $this->getTokens();

                $data = $this->doApiRequest( array(
                        'action' => 'protect',
                        'token' => $pageinfo['protecttoken'],
                        'title' => 'UTPage',
                        'protections' => 'edit=sysop',
                        'watchlist' => 'unwatch' ) );

                $this->assertArrayHasKey( 'protect', $data[0] );
                $this->assertArrayHasKey( 'protections', $data[0]['protect'] );
                $this->assertEquals( 1, count( $data[0]['protect']['protections'] ) );
                $this->assertArrayHasKey( 'edit', $data[0]['protect']['protections'][0] );
        }

        function testGetRollbackToken() {

                $pageinfo = $this->getTokens();

                if ( !Title::newFromText( 'UTPage' )->exists() ) {
                        $this->markTestSkipped( "The article [[UTPage]] does not exist" ); //TODO: just create it?
                }

                $data = $this->doApiRequest( array(
                        'action' => 'query',
                        'prop' => 'revisions',
                        'titles' => 'UTPage',
                        'rvtoken' => 'rollback' ) );

                $this->assertArrayHasKey( 'query', $data[0] );
                $this->assertArrayHasKey( 'pages', $data[0]['query'] );
                $keys = array_keys( $data[0]['query']['pages'] );
                $key = array_pop( $keys );

                if ( isset( $data[0]['query']['pages'][$key]['missing'] ) ) {
                        $this->markTestSkipped( "Target page (UTPage) doesn't exist" );
                }

                $this->assertArrayHasKey( 'pageid', $data[0]['query']['pages'][$key] );
                $this->assertArrayHasKey( 'revisions', $data[0]['query']['pages'][$key] );
                $this->assertArrayHasKey( 0, $data[0]['query']['pages'][$key]['revisions'] );
                $this->assertArrayHasKey( 'rollbacktoken', $data[0]['query']['pages'][$key]['revisions'][0] );

                return $data;
        }

        function testWatchRollback( $data ) {
                $keys = array_keys( $data[0]['query']['pages'] );
                $key = array_pop( $keys );
                $pageinfo = $data[0]['query']['pages'][$key];
                $revinfo = $pageinfo['revisions'][0];

                try {
                        $data = $this->doApiRequest( array(
                                'action' => 'rollback',
                                'title' => 'UTPage',
                                'user' => $revinfo['user'],
                                'token' => $pageinfo['rollbacktoken'],
                                'watchlist' => 'watch' ) );

                        $this->assertArrayHasKey( 'rollback', $data[0] );
                        $this->assertArrayHasKey( 'title', $data[0]['rollback'] );
                } catch( UsageException $ue ) {
                        if( $ue->getCodeString() == 'onlyauthor' ) {
                                $this->markTestIncomplete( "Only one author to 'UTPage', cannot test rollback" );
                        } else {
                                $this->fail( "Received error '" . $ue->getCodeString() . "'" );
                        }
                }
        }

        function testWatchDelete() {
                $pageinfo = $this->getTokens();

                $data = $this->doApiRequest( array(
                        'action' => 'delete',
                        'token' => $pageinfo['deletetoken'],
                        'title' => 'UTPage' ) );
                $this->assertArrayHasKey( 'delete', $data[0] );
                $this->assertArrayHasKey( 'title', $data[0]['delete'] );

                $data = $this->doApiRequest( array(
                        'action' => 'query',
                        'list' => 'watchlist' ) );

                $this->markTestIncomplete( 'This test needs to verify the deleted article was added to the users watchlist' );
        }
}