StatusTest.php

Go to the documentation of this file.

<?php

class StatusTest extends MediaWikiLangTestCase {

    public function testCanConstruct() {
        new Status();
        $this->assertTrue( true );
    }

    public function testNewGood( $value = null ) {
        $status = Status::newGood( $value );
        $this->assertTrue( $status->isGood() );
        $this->assertTrue( $status->isOK() );
        $this->assertEquals( $value, $status->getValue() );
    }

    public static function provideValues() {
        return array(
            array(),
            array( 'foo' ),
            array( array( 'foo' => 'bar' ) ),
            array( new Exception() ),
            array( 1234 ),
        );
    }

    public function testNewFatalWithMessage() {
        $message = $this->getMockBuilder( 'Message' )
            ->disableOriginalConstructor()
            ->getMock();

        $status = Status::newFatal( $message );
        $this->assertFalse( $status->isGood() );
        $this->assertFalse( $status->isOK() );
        $this->assertEquals( $message, $status->getMessage() );
    }

    public function testNewFatalWithString() {
        $message = 'foo';
        $status = Status::newFatal( $message );
        $this->assertFalse( $status->isGood() );
        $this->assertFalse( $status->isOK() );
        $this->assertEquals( $message, $status->getMessage()->getKey() );
    }

    public function testSetResult( $ok, $value = null ) {
        $status = new Status();
        $status->setResult( $ok, $value );
        $this->assertEquals( $ok, $status->isOK() );
        $this->assertEquals( $value, $status->getValue() );
    }

    public static function provideSetResult() {
        return array(
            array( true ),
            array( false ),
            array( true, 'value' ),
            array( false, 'value' ),
        );
    }

    public function testIsOk( $ok ) {
        $status = new Status();
        $status->ok = $ok;
        $this->assertEquals( $ok, $status->isOK() );
    }

    public static function provideIsOk() {
        return array(
            array( true ),
            array( false ),
        );
    }

    public function testGetValue() {
        $status = new Status();
        $status->value = 'foobar';
        $this->assertEquals( 'foobar', $status->getValue() );
    }

    public function testIsGood( $ok, $errors, $expected ) {
        $status = new Status();
        $status->ok = $ok;
        $status->errors = $errors;
        $this->assertEquals( $expected, $status->isGood() );
    }

    public static function provideIsGood() {
        return array(
            array( true, array(), true ),
            array( true, array( 'foo' ), false ),
            array( false, array(), false ),
            array( false, array( 'foo' ), false ),
        );
    }

    public function testWarningWithMessage( $mockDetails ) {
        $status = new Status();
        $messages = $this->getMockMessages( $mockDetails );

        foreach ( $messages as $message ) {
            $status->warning( $message );
        }
        $warnings = $status->getWarningsArray();

        $this->assertEquals( count( $messages ), count( $warnings ) );
        foreach ( $messages as $key => $message ) {
            $expectedArray = array_merge( array( $message->getKey() ), $message->getParams() );
            $this->assertEquals( $warnings[$key], $expectedArray );
        }
    }

    public function testErrorWithMessage( $mockDetails ) {
        $status = new Status();
        $messages = $this->getMockMessages( $mockDetails );

        foreach ( $messages as $message ) {
            $status->error( $message );
        }
        $errors = $status->getErrorsArray();

        $this->assertEquals( count( $messages ), count( $errors ) );
        foreach ( $messages as $key => $message ) {
            $expectedArray = array_merge( array( $message->getKey() ), $message->getParams() );
            $this->assertEquals( $errors[$key], $expectedArray );
        }
    }

    public function testFatalWithMessage( $mockDetails ) {
        $status = new Status();
        $messages = $this->getMockMessages( $mockDetails );

        foreach ( $messages as $message ) {
            $status->fatal( $message );
        }
        $errors = $status->getErrorsArray();

        $this->assertEquals( count( $messages ), count( $errors ) );
        foreach ( $messages as $key => $message ) {
            $expectedArray = array_merge( array( $message->getKey() ), $message->getParams() );
            $this->assertEquals( $errors[$key], $expectedArray );
        }
        $this->assertFalse( $status->isOK() );
    }

    protected function getMockMessage( $key = 'key', $params = array() ) {
        $message = $this->getMockBuilder( 'Message' )
            ->disableOriginalConstructor()
            ->getMock();
        $message->expects( $this->atLeastOnce() )
            ->method( 'getKey' )
            ->will( $this->returnValue( $key ) );
        $message->expects( $this->atLeastOnce() )
            ->method( 'getParams' )
            ->will( $this->returnValue( $params ) );
        return $message;
    }

    protected function getMockMessages( $messageDetails ) {
        $messages = array();
        foreach ( $messageDetails as $key => $paramsArray ) {
            $messages[] = $this->getMockMessage( $key, $paramsArray );
        }
        return $messages;
    }

    public static function provideMockMessageDetails() {
        return array(
            array( array( 'key1' => array( 'foo' => 'bar' ) ) ),
            array( array( 'key1' => array( 'foo' => 'bar' ), 'key2' => array( 'foo2' => 'bar2' ) ) ),
        );
    }

    public function testMerge() {
        $status1 = new Status();
        $status2 = new Status();
        $message1 = $this->getMockMessage( 'warn1' );
        $message2 = $this->getMockMessage( 'error2' );
        $status1->warning( $message1 );
        $status2->error( $message2 );

        $status1->merge( $status2 );
        $this->assertEquals( 2, count( $status1->getWarningsArray() ) + count( $status1->getErrorsArray() ) );
    }

    public function testMergeWithOverwriteValue() {
        $status1 = new Status();
        $status2 = new Status();
        $message1 = $this->getMockMessage( 'warn1' );
        $message2 = $this->getMockMessage( 'error2' );
        $status1->warning( $message1 );
        $status2->error( $message2 );
        $status2->value = 'FooValue';

        $status1->merge( $status2, true );
        $this->assertEquals( 2, count( $status1->getWarningsArray() ) + count( $status1->getErrorsArray() ) );
        $this->assertEquals( 'FooValue', $status1->getValue() );
    }

    public function testHasMessage() {
        $status = new Status();
        $status->fatal( 'bad' );
        $this->assertTrue( $status->hasMessage( 'bad' ) );
        $this->assertFalse( $status->hasMessage( 'good' ) );
    }

    public function testCleanParams( $cleanCallback, $params, $expected ) {
        $method = new ReflectionMethod( 'Status', 'cleanParams' );
        $method->setAccessible( true );
        $status = new Status();
        $status->cleanCallback = $cleanCallback;

        $this->assertEquals( $expected, $method->invoke( $status, $params ) );
    }

    public static function provideCleanParams() {
        $cleanCallback = function( $value ) {
            return '-' . $value . '-';
        };

        return array(
            array( false, array( 'foo' => 'bar' ), array( 'foo' => 'bar' ) ),
            array( $cleanCallback, array( 'foo' => 'bar' ), array( 'foo' => '-bar-' ) ),
        );
    }

    public function testGetWikiText( Status $status, $wikitext, $html ) {
        $this->assertEquals( $wikitext, $status->getWikiText() );
    }

    public function testGetHtml( Status $status, $wikitext, $html ) {
        $this->assertEquals( $html, $status->getHTML() );
    }

    public static function provideGetWikiTextAndHtml() {
        $testCases = array();

        $testCases[ 'GoodStatus' ] = array(
            new Status(),
            "Internal error: Status::getWikiText called for a good result, this is incorrect\n",
            "<p>Internal error: Status::getWikiText called for a good result, this is incorrect\n</p>",
        );

        $status = new Status();
        $status->ok = false;
        $testCases[ 'GoodButNoError' ] = array(
            $status,
            "Internal error: Status::getWikiText: Invalid result object: no error text but not OK\n",
            "<p>Internal error: Status::getWikiText: Invalid result object: no error text but not OK\n</p>",
        );

        $status = new Status();
        $status->warning( 'fooBar!' );
        $testCases[ '1StringWarning' ] = array(
            $status,
            "<fooBar!>",
            "<p>&lt;fooBar!&gt;\n</p>",
        );

        $status = new Status();
        $status->warning( 'fooBar!' );
        $status->warning( 'fooBar2!' );
        $testCases[ '2StringWarnings' ] = array(
            $status,
            "* <fooBar!>\n* <fooBar2!>\n",
            "<ul>\n<li> &lt;fooBar!&gt;\n</li>\n<li> &lt;fooBar2!&gt;\n</li>\n</ul>\n",
        );

        $status = new Status();
        $status->warning( new Message( 'fooBar!', array( 'foo', 'bar' )  ) );
        $testCases[ '1MessageWarning' ] = array(
            $status,
            "<fooBar!>",
            "<p>&lt;fooBar!&gt;\n</p>",
        );

        $status = new Status();
        $status->warning( new Message( 'fooBar!', array( 'foo', 'bar' ) ) );
        $status->warning( new Message( 'fooBar2!' ) );
        $testCases[ '2MessageWarnings' ] = array(
            $status,
            "* <fooBar!>\n* <fooBar2!>\n",
            "<ul>\n<li> &lt;fooBar!&gt;\n</li>\n<li> &lt;fooBar2!&gt;\n</li>\n</ul>\n",
        );

        return $testCases;
    }

    public function testGetMessage( Status $status, $expectedParams = array(), $expectedKey ) {
        $message = $status->getMessage();
        $this->assertInstanceOf( 'Message', $message );
        $this->assertEquals( $expectedParams, $message->getParams(), 'Message::getParams' );
        $this->assertEquals( $expectedKey, $message->getKey(), 'Message::getKey' );
    }

    public static function provideGetMessage() {
        $testCases = array();

        $testCases[ 'GoodStatus' ] = array(
            new Status(),
            array( "Status::getMessage called for a good result, this is incorrect\n" ),
            'internalerror_info'
        );

        $status = new Status();
        $status->ok = false;
        $testCases[ 'GoodButNoError' ] = array(
            $status,
            array( "Status::getMessage: Invalid result object: no error text but not OK\n" ),
            'internalerror_info'
        );

        $status = new Status();
        $status->warning( 'fooBar!' );
        $testCases[ '1StringWarning' ] = array(
            $status,
            array(),
            'fooBar!'
        );

        // FIXME: Assertion tries to compare a StubUserLang with a Language object, because
        // "data providers are executed before both the call to the setUpBeforeClass static method
        // and the first call to the setUp method. Because of that you can't access any variables
        // you create there from within a data provider."
        // http://phpunit.de/manual/3.7/en/writing-tests-for-phpunit.html
//      $status = new Status();
//      $status->warning( 'fooBar!' );
//      $status->warning( 'fooBar2!' );
//      $testCases[ '2StringWarnings' ] = array(
//          $status,
//          array( new Message( 'fooBar!' ), new Message( 'fooBar2!' ) ),
//          "* \$1\n* \$2"
//      );

        $status = new Status();
        $status->warning( new Message( 'fooBar!', array( 'foo', 'bar' )  ) );
        $testCases[ '1MessageWarning' ] = array(
            $status,
            array( 'foo', 'bar' ),
            'fooBar!'
        );

        $status = new Status();
        $status->warning( new Message( 'fooBar!', array( 'foo', 'bar' ) ) );
        $status->warning( new Message( 'fooBar2!' ) );
        $testCases[ '2MessageWarnings' ] = array(
            $status,
            array( new Message( 'fooBar!', array( 'foo', 'bar' ) ), new Message( 'fooBar2!' ) ),
            "* \$1\n* \$2"
        );

        return $testCases;
    }

    public function testReplaceMessage() {
        $status = new Status();
        $message = new Message( 'key1', array( 'foo1', 'bar1' ) );
        $status->error( $message );
        $newMessage = new Message( 'key2', array( 'foo2', 'bar2' ) );

        $status->replaceMessage( $message, $newMessage );

        $this->assertEquals( $newMessage, $status->errors[0]['message'] );
    }

    public function testGetErrorMessage() {
        $method = new ReflectionMethod( 'Status', 'getErrorMessage' );
        $method->setAccessible( true );
        $status = new Status();
        $key = 'foo';
        $params = array( 'bar' );

        $message = $method->invoke( $status, array_merge( array( $key ), $params ) );
        $this->assertInstanceOf( 'Message', $message );
        $this->assertEquals( $key, $message->getKey() );
        $this->assertEquals( $params, $message->getParams() );
    }

    public function testGetErrorMessageArray() {
        $method = new ReflectionMethod( 'Status', 'getErrorMessageArray' );
        $method->setAccessible( true );
        $status = new Status();
        $key = 'foo';
        $params = array( 'bar' );

        $messageArray = $method->invoke(
            $status,
            array(
                array_merge( array( $key ), $params ),
                array_merge( array( $key ), $params )
            )
        );

        $this->assertInternalType( 'array', $messageArray );
        $this->assertCount( 2, $messageArray );
        foreach ( $messageArray as $message ) {
            $this->assertInstanceOf( 'Message', $message );
            $this->assertEquals( $key, $message->getKey() );
            $this->assertEquals( $params, $message->getParams() );
        }
    }

    public function testGetErrorsByType() {
        $status = new Status();
        $warning = new Message( 'warning111' );
        $error = new Message( 'error111' );
        $status->warning( $warning );
        $status->error( $error );

        $warnings = $status->getErrorsByType( 'warning' );
        $errors = $status->getErrorsByType( 'error' );

        $this->assertCount( 1, $warnings );
        $this->assertCount( 1, $errors );
        $this->assertEquals( $warning, $warnings[0]['message'] );
        $this->assertEquals( $error, $errors[0]['message'] );
    }

    public function testWakeUpSanitizesCallback() {
        $status = new Status();
        $status->cleanCallback = function( $value ) {
            return '-' . $value . '-';
        };
        $status->__wakeup();
        $this->assertEquals( false, $status->cleanCallback );
    }

    public function testGetStatusArrayWithNonObjectMessages( $nonObjMsg ) {
        $status = new Status();
        if ( !array_key_exists( 1, $nonObjMsg ) ) {
            $status->warning( $nonObjMsg[0] );
        } else {
            $status->warning( $nonObjMsg[0], $nonObjMsg[1] );
        }

        $array = $status->getWarningsArray(); // We use getWarningsArray to access getStatusArray

        $this->assertEquals( 1, count( $array ) );
        $this->assertEquals( $nonObjMsg, $array[0] );
    }

    public static function provideNonObjectMessages() {
        return array(
            array( array( 'ImaString', array( 'param1' => 'value1' ) ) ),
            array( array( 'ImaString' ) ),
        );
    }

}