fetchTextTest.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Tests\Maintenance;
 
use ContentHandler;
use FetchText;
use MediaWiki\Storage\RevisionRecord;
use MediaWikiTestCase;
use MWException;
use Title;
use PHPUnit_Framework_ExpectationFailedException;
use WikiPage;
 
class SemiMockedFetchText extends FetchText {
 
    private $mockStdinText = null;
 
    private $mockSetUp = false;
 
    private $mockInvocations = [ 'getStdin' => 0 ];
 
    function mockStdin( $stdin ) {
        $this->mockStdinText = $stdin;
        $this->mockSetUp = true;
    }
 
    function mockGetInvocations() {
        return $this->mockInvocations;
    }
 
    // -----------------------------------------------------------------
    // Mocked functions from FetchText follow.
 
    function getStdin( $len = null ) {
        $this->mockInvocations['getStdin']++;
        if ( $len !== null ) {
            throw new PHPUnit_Framework_ExpectationFailedException(
                "Tried to get stdin with non null parameter" );
        }
 
        if ( !$this->mockSetUp ) {
            throw new PHPUnit_Framework_ExpectationFailedException(
                "Tried to get stdin before setting up rerouting" );
        }
 
        return fopen( 'data://text/plain,' . $this->mockStdinText, 'r' );
    }
}
 
class FetchTextTest extends MediaWikiTestCase {
 
    // We add 5 Revisions for this test. Their corresponding text id's
    // are stored in the following 5 variables.
    protected static $textId1;
    protected static $textId2;
    protected static $textId3;
    protected static $textId4;
    protected static $textId5;
 
    protected static $exceptionFromAddDBDataOnce;
 
    private $fetchText;
 
    private function addRevision( $page, $text, $summary ) {
        $status = $page->doEditContent(
            ContentHandler::makeContent( $text, $page->getTitle() ),
            $summary
        );
 
        if ( $status->isGood() ) {
            $value = $status->getValue();
 
            $revision = $value['revision-record'];
            $address = $revision->getSlot( 'main' )->getAddress();
            return $address;
        }
 
        throw new MWException( "Could not create revision" );
    }
 
    function addDBDataOnce() {
        $wikitextNamespace = $this->getDefaultWikitextNS();
 
        try {
            $title = Title::newFromText( 'FetchTextTestPage1', $wikitextNamespace );
            $page = WikiPage::factory( $title );
            self::$textId1 = $this->addRevision(
                $page,
                "FetchTextTestPage1Text1",
                "FetchTextTestPage1Summary1"
            );
 
            $title = Title::newFromText( 'FetchTextTestPage2', $wikitextNamespace );
            $page = WikiPage::factory( $title );
            self::$textId2 = $this->addRevision(
                $page,
                "FetchTextTestPage2Text1",
                "FetchTextTestPage2Summary1"
            );
            self::$textId3 = $this->addRevision(
                $page,
                "FetchTextTestPage2Text2",
                "FetchTextTestPage2Summary2"
            );
            self::$textId4 = $this->addRevision(
                $page,
                "FetchTextTestPage2Text3",
                "FetchTextTestPage2Summary3"
            );
            self::$textId5 = $this->addRevision(
                $page,
                "FetchTextTestPage2Text4 some additional Text  ",
                "FetchTextTestPage2Summary4 extra "
            );
        } catch ( Exception $e ) {
            // We'd love to pass $e directly. However, ... see
            // documentation of exceptionFromAddDBDataOnce
            self::$exceptionFromAddDBDataOnce = $e;
        }
    }
 
    protected function setUp() {
        parent::setUp();
 
        // Check if any Exception is stored for rethrowing from addDBData
        if ( self::$exceptionFromAddDBDataOnce !== null ) {
            throw self::$exceptionFromAddDBDataOnce;
        }
 
        $this->fetchText = new SemiMockedFetchText();
    }
 
    private function assertFilter( $input, $expectedOutput ) {
        $this->fetchText->mockStdin( $input );
        $this->fetchText->execute();
        $invocations = $this->fetchText->mockGetInvocations();
        $this->assertEquals( 1, $invocations['getStdin'],
            "getStdin invocation counter" );
        $this->expectOutputString( $expectedOutput );
    }
 
    // Instead of the following functions, a data provider would be great.
    // However, as data providers are evaluated /before/ addDBData, a data
    // provider would not know the required ids.
 
    function testExistingSimple() {
        $this->assertFilter( self::$textId2,
            self::$textId2 . "\n23\nFetchTextTestPage2Text1" );
    }
 
    function testExistingSimpleWithNewline() {
        $this->assertFilter( self::$textId2 . "\n",
            self::$textId2 . "\n23\nFetchTextTestPage2Text1" );
    }
 
    function testExistingInteger() {
        $this->assertFilter( (int)preg_replace( '/^tt:/', '', self::$textId2 ),
            self::$textId2 . "\n23\nFetchTextTestPage2Text1" );
    }
 
    function testExistingSeveral() {
        $this->assertFilter(
            implode( "\n", [
                self::$textId1,
                self::$textId5,
                self::$textId3,
                self::$textId3,
            ] ),
            implode( '', [
                self::$textId1 . "\n23\nFetchTextTestPage1Text1",
                self::$textId5 . "\n44\nFetchTextTestPage2Text4 "
                    . "some additional Text",
                self::$textId3 . "\n23\nFetchTextTestPage2Text2",
                self::$textId3 . "\n23\nFetchTextTestPage2Text2"
            ] ) );
    }
 
    function testEmpty() {
        $this->assertFilter( "", null );
    }
 
    function testNonExisting() {
        \Wikimedia\suppressWarnings();
        $this->assertFilter( 'tt:77889911', 'tt:77889911' . "\n-1\n" );
        \Wikimedia\suppressWarnings( true );
    }
 
    function testNonExistingInteger() {
        \Wikimedia\suppressWarnings();
        $this->assertFilter( '77889911', 'tt:77889911' . "\n-1\n" );
        \Wikimedia\suppressWarnings( true );
    }
 
    function testBadBlobAddressWithColon() {
        $this->assertFilter( 'foo:bar', 'foo:bar' . "\n-1\n" );
    }
 
    function testNegativeInteger() {
        $this->assertFilter( "-42", "tt:-42\n-1\n" );
    }
 
    function testFloatingPointNumberExisting() {
        // float -> int -> address -> revision
        $id = intval( preg_replace( '/^tt:/', '', self::$textId3 ) ) + 0.14159;
        $this->assertFilter( 'tt:' . intval( $id ),
            self::$textId3 . "\n23\nFetchTextTestPage2Text2" );
    }
 
    function testFloatingPointNumberNonExisting() {
        \Wikimedia\suppressWarnings();
        $id = intval( preg_replace( '/^tt:/', '', self::$textId5 ) ) + 3.14159;
        $this->assertFilter( $id, 'tt:' . intval( $id ) . "\n-1\n" );
        \Wikimedia\suppressWarnings( true );
    }
 
    function testCharacters() {
        $this->assertFilter( "abc", "abc\n-1\n" );
    }
 
    function testMix() {
        $this->assertFilter( "ab\n" . self::$textId4 . ".5cd\n\nefg\nfoo:bar\n" . self::$textId2
                . "\n" . self::$textId3,
            implode( "", [
                "ab\n-1\n",
                self::$textId4 . ".5cd\n-1\n",
                "\n-1\n",
                "efg\n-1\n",
                "foo:bar\n-1\n",
                self::$textId2 . "\n23\nFetchTextTestPage2Text1",
                self::$textId3 . "\n23\nFetchTextTestPage2Text2"
            ] ) );
    }
}