MWExceptionTest.php

Go to the documentation of this file.

<?php
class MWExceptionTest extends MediaWikiTestCase {

    public function testMwexceptionThrowing() {
        throw new MWException();
    }

    public function testUseOutputPage( $expected, $langObj, $wgFullyInitialised, $wgOut ) {
        $this->setMwGlobals( [
            'wgLang' => $langObj,
            'wgFullyInitialised' => $wgFullyInitialised,
            'wgOut' => $wgOut,
        ] );

        $e = new MWException();
        $this->assertEquals( $expected, $e->useOutputPage() );
    }

    public function provideTextUseOutputPage() {
        return [
            // expected, langObj, wgFullyInitialised, wgOut
            [ false, null, null, null ],
            [ false, $this->getMockLanguage(), null, null ],
            [ false, $this->getMockLanguage(), true, null ],
            [ false, null, true, null ],
            [ false, null, null, true ],
            [ true, $this->getMockLanguage(), true, true ],
        ];
    }

    private function getMockLanguage() {
        return $this->getMockBuilder( 'Language' )
            ->disableOriginalConstructor()
            ->getMock();
    }

    public function testUseMessageCache( $expected, $langObj ) {
        $this->setMwGlobals( [
            'wgLang' => $langObj,
        ] );
        $e = new MWException();
        $this->assertEquals( $expected, $e->useMessageCache() );
    }

    public function provideUseMessageCache() {
        return [
            [ false, null ],
            [ true, $this->getMockLanguage() ],
        ];
    }

    public function testIsLogable() {
        $e = new MWException();
        $this->assertTrue( $e->isLoggable() );
    }

    public function testRunHooks( $wgExceptionHooks, $name, $args, $expectedReturn ) {
        $this->setMwGlobals( [
            'wgExceptionHooks' => $wgExceptionHooks,
        ] );
        $e = new MWException();
        $this->assertEquals( $expectedReturn, $e->runHooks( $name, $args ) );
    }

    public static function provideRunHooks() {
        return [
            [ null, null, null, null ],
            [ [], 'name', [], null ],
            [ [ 'name' => false ], 'name', [], null ],
            [
                [ 'mockHook' => [ 'MWExceptionTest::mockHook' ] ],
                'mockHook', [], 'YAY.[]'
            ],
            [
                [ 'mockHook' => [ 'MWExceptionTest::mockHook' ] ],
                'mockHook', [ 'a' ], 'YAY.{"1":"a"}'
            ],
            [
                [ 'mockHook' => [ 'MWExceptionTest::mockHook' ] ],
                'mockHook', [ null ], null
            ],
        ];
    }

    public static function mockHook() {
        $args = func_get_args();
        if ( !$args[0] instanceof MWException ) {
            return '$caller not instance of MWException';
        }
        unset( $args[0] );
        if ( array_key_exists( 1, $args ) && $args[1] === null ) {
            return null;
        }
        return 'YAY.' . json_encode( $args );
    }

    public function testisCommandLine( $expected, $wgCommandLineMode ) {
        $this->setMwGlobals( [
            'wgCommandLineMode' => $wgCommandLineMode,
        ] );
        $e = new MWException();
        $this->assertEquals( $expected, $e->isCommandLine() );
    }

    public static function provideIsCommandLine() {
        return [
            [ false, null ],
            [ true, true ],
        ];
    }

    public function testJsonSerializeExceptions( $exception_class ) {
        $json = MWExceptionHandler::jsonSerializeException(
            new $exception_class()
        );
        $this->assertNotEquals( false, $json,
            "The $exception_class exception should be JSON serializable, got false." );
    }

    public static function provideExceptionClasses() {
        return [
            [ 'Exception' ],
            [ 'MWException' ],
        ];
    }

    public function testJsonserializeexceptionKeys( $expectedKeyType, $exClass, $key ) {

        # Make sure we log a backtrace:
        $this->setMwGlobals( [ 'wgLogExceptionBacktrace' => true ] );

        $json = json_decode(
            MWExceptionHandler::jsonSerializeException( new $exClass() )
        );
        $this->assertObjectHasAttribute( $key, $json,
            "JSON serialized exception is missing key '$key'"
        );
        $this->assertInternalType( $expectedKeyType, $json->$key,
            "JSON serialized key '$key' has type " . gettype( $json->$key )
            . " (expected: $expectedKeyType)."
        );
    }

    public static function provideJsonSerializedKeys() {
        $testCases = [];
        foreach ( [ 'Exception', 'MWException' ] as $exClass ) {
            $exTests = [
                [ 'string', $exClass, 'id' ],
                [ 'string', $exClass, 'file' ],
                [ 'integer', $exClass, 'line' ],
                [ 'string', $exClass, 'message' ],
                [ 'null', $exClass, 'url' ],
                # Backtrace only enabled with wgLogExceptionBacktrace = true
                [ 'array', $exClass, 'backtrace' ],
            ];
            $testCases = array_merge( $testCases, $exTests );
        }
        return $testCases;
    }

    public function testJsonserializeexceptionBacktracingEnabled() {
        $this->setMwGlobals( [ 'wgLogExceptionBacktrace' => true ] );
        $json = json_decode(
            MWExceptionHandler::jsonSerializeException( new Exception() )
        );
        $this->assertObjectHasAttribute( 'backtrace', $json );
    }

    public function testJsonserializeexceptionBacktracingDisabled() {
        $this->setMwGlobals( [ 'wgLogExceptionBacktrace' => false ] );
        $json = json_decode(
            MWExceptionHandler::jsonSerializeException( new Exception() )
        );
        $this->assertObjectNotHasAttribute( 'backtrace', $json );

    }

}