HooksTest.php

Go to the documentation of this file.

<?php
 
class HooksTest extends MediaWikiTestCase {
 
    function setUp() {
        global $wgHooks;
        parent::setUp();
        Hooks::clear( 'MediaWikiHooksTest001' );
        unset( $wgHooks['MediaWikiHooksTest001'] );
    }
 
    public static function provideHooks() {
        $i = new NothingClass();
 
        return [
            [
                'Object and method',
                [ $i, 'someNonStatic' ],
                'changed-nonstatic',
                'changed-nonstatic'
            ],
            [ 'Object and no method', [ $i ], 'changed-onevent', 'original' ],
            [
                'Object and method with data',
                [ $i, 'someNonStaticWithData', 'data' ],
                'data',
                'original'
            ],
            [ 'Object and static method', [ $i, 'someStatic' ], 'changed-static', 'original' ],
            [
                'Class::method static call',
                [ 'NothingClass::someStatic' ],
                'changed-static',
                'original'
            ],
            [
                'Class::method static call as array',
                [ [ 'NothingClass::someStatic' ] ],
                'changed-static',
                'original'
            ],
            [ 'Global function', [ 'NothingFunction' ], 'changed-func', 'original' ],
            [ 'Global function with data', [ 'NothingFunctionData', 'data' ], 'data', 'original' ],
            [ 'Closure', [ function ( &$foo, $bar ) {
                $foo = 'changed-closure';
 
                return true;
            } ], 'changed-closure', 'original' ],
            [ 'Closure with data', [ function ( $data, &$foo, $bar ) {
                $foo = $data;
 
                return true;
            }, 'data' ], 'data', 'original' ]
        ];
    }
 
    public function testNewStyleHooks( $msg, $hook, $expectedFoo, $expectedBar ) {
        $foo = $bar = 'original';
 
        Hooks::register( 'MediaWikiHooksTest001', $hook );
        Hooks::run( 'MediaWikiHooksTest001', [ &$foo, &$bar ] );
 
        $this->assertSame( $expectedFoo, $foo, $msg );
        $this->assertSame( $expectedBar, $bar, $msg );
    }
 
    public function testGetHandlers() {
        global $wgHooks;
 
        $this->assertSame(
            [],
            Hooks::getHandlers( 'MediaWikiHooksTest001' ),
            'No hooks registered'
        );
 
        $a = new NothingClass();
        $b = new NothingClass();
 
        $wgHooks['MediaWikiHooksTest001'][] = $a;
 
        $this->assertSame(
            [ $a ],
            Hooks::getHandlers( 'MediaWikiHooksTest001' ),
            'Hook registered by $wgHooks'
        );
 
        Hooks::register( 'MediaWikiHooksTest001', $b );
        $this->assertSame(
            [ $b, $a ],
            Hooks::getHandlers( 'MediaWikiHooksTest001' ),
            'Hooks::getHandlers() should return hooks registered via wgHooks as well as Hooks::register'
        );
 
        Hooks::clear( 'MediaWikiHooksTest001' );
        unset( $wgHooks['MediaWikiHooksTest001'] );
 
        Hooks::register( 'MediaWikiHooksTest001', $b );
        $this->assertSame(
            [ $b ],
            Hooks::getHandlers( 'MediaWikiHooksTest001' ),
            'Hook registered by Hook::register'
        );
    }
 
    public function testNewStyleHookInteraction() {
        global $wgHooks;
 
        $a = new NothingClass();
        $b = new NothingClass();
 
        $wgHooks['MediaWikiHooksTest001'][] = $a;
        $this->assertTrue(
            Hooks::isRegistered( 'MediaWikiHooksTest001' ),
            'Hook registered via $wgHooks should be noticed by Hooks::isRegistered'
        );
 
        Hooks::register( 'MediaWikiHooksTest001', $b );
        $this->assertEquals(
            2,
            count( Hooks::getHandlers( 'MediaWikiHooksTest001' ) ),
            'Hooks::getHandlers() should return hooks registered via wgHooks as well as Hooks::register'
        );
 
        $foo = 'quux';
        $bar = 'qaax';
 
        Hooks::run( 'MediaWikiHooksTest001', [ &$foo, &$bar ] );
        $this->assertEquals(
            1,
            $a->calls,
            'Hooks::run() should run hooks registered via wgHooks as well as Hooks::register'
        );
        $this->assertEquals(
            1,
            $b->calls,
            'Hooks::run() should run hooks registered via wgHooks as well as Hooks::register'
        );
    }
 
    public function testUncallableFunction() {
        Hooks::register( 'MediaWikiHooksTest001', 'ThisFunctionDoesntExist' );
        Hooks::run( 'MediaWikiHooksTest001', [] );
    }
 
    public function testFalseReturn() {
        Hooks::register( 'MediaWikiHooksTest001', function ( &$foo ) {
            return false;
        } );
        Hooks::register( 'MediaWikiHooksTest001', function ( &$foo ) {
            $foo = 'test';
 
            return true;
        } );
        $foo = 'original';
        Hooks::run( 'MediaWikiHooksTest001', [ &$foo ] );
        $this->assertSame( 'original', $foo, 'Hooks abort after a false return.' );
    }
 
    public function testNullReturn() {
        Hooks::register( 'MediaWikiHooksTest001', function ( &$foo ) {
            return;
        } );
        Hooks::register( 'MediaWikiHooksTest001', function ( &$foo ) {
            $foo = 'test';
 
            return true;
        } );
        $foo = 'original';
        Hooks::run( 'MediaWikiHooksTest001', [ &$foo ] );
        $this->assertSame( 'test', $foo, 'Hooks continue after a null return.' );
    }
 
    public function testCallHook_FalseHook() {
        Hooks::register( 'MediaWikiHooksTest001', false );
        Hooks::register( 'MediaWikiHooksTest001', function ( &$foo ) {
            $foo = 'test';
 
            return true;
        } );
        $foo = 'original';
        Hooks::run( 'MediaWikiHooksTest001', [ &$foo ] );
        $this->assertSame( 'test', $foo, 'Hooks that are falsey are skipped.' );
    }
 
    public function testCallHook_UnknownDatatype() {
        Hooks::register( 'MediaWikiHooksTest001', 12345 );
        Hooks::run( 'MediaWikiHooksTest001' );
    }
 
    public function testCallHook_Deprecated() {
        Hooks::register( 'MediaWikiHooksTest001', 'NothingClass::someStatic' );
        Hooks::run( 'MediaWikiHooksTest001', [], '1.31' );
    }
 
    public function testRunWithoutAbort() {
        $list = [];
        Hooks::register( 'MediaWikiHooksTest001', function ( &$list ) {
            $list[] = 1;
            return true; // Explicit true
        } );
        Hooks::register( 'MediaWikiHooksTest001', function ( &$list ) {
            $list[] = 2;
            return; // Implicit null
        } );
        Hooks::register( 'MediaWikiHooksTest001', function ( &$list ) {
            $list[] = 3;
            // No return
        } );
 
        Hooks::runWithoutAbort( 'MediaWikiHooksTest001', [ &$list ] );
        $this->assertSame( [ 1, 2, 3 ], $list, 'All hooks ran.' );
    }
 
    public function testRunWithoutAbortWarning() {
        Hooks::register( 'MediaWikiHooksTest001', function ( &$foo ) {
            return false;
        } );
        Hooks::register( 'MediaWikiHooksTest001', function ( &$foo ) {
            $foo = 'test';
            return true;
        } );
        $foo = 'original';
 
        $this->setExpectedException(
            UnexpectedValueException::class,
            'Invalid return from hook-MediaWikiHooksTest001-closure for ' .
                'unabortable MediaWikiHooksTest001'
        );
        Hooks::runWithoutAbort( 'MediaWikiHooksTest001', [ &$foo ] );
    }
 
    public function testFatalError() {
        Hooks::register( 'MediaWikiHooksTest001', function () {
            return 'test';
        } );
        Hooks::run( 'MediaWikiHooksTest001', [] );
    }
}
 
function NothingFunction( &$foo, &$bar ) {
    $foo = 'changed-func';
 
    return true;
}
 
function NothingFunctionData( $data, &$foo, &$bar ) {
    $foo = $data;
 
    return true;
}
 
class NothingClass {
    public $calls = 0;
 
    public static function someStatic( &$foo, &$bar ) {
        $foo = 'changed-static';
 
        return true;
    }
 
    public function someNonStatic( &$foo, &$bar ) {
        $this->calls++;
        $foo = 'changed-nonstatic';
        $bar = 'changed-nonstatic';
 
        return true;
    }
 
    public function onMediaWikiHooksTest001( &$foo, &$bar ) {
        $this->calls++;
        $foo = 'changed-onevent';
 
        return true;
    }
 
    public function someNonStaticWithData( $data, &$foo, &$bar ) {
        $this->calls++;
        $foo = $data;
 
        return true;
    }
}