SlotRoleRegistryTest.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Tests\Revision;
 
use InvalidArgumentException;
use LogicException;
use MediaWiki\Revision\MainSlotRoleHandler;
use MediaWiki\Revision\SlotRoleHandler;
use MediaWiki\Revision\SlotRoleRegistry;
use MediaWiki\Storage\NameTableStore;
use MediaWikiTestCase;
use Title;
use Wikimedia\Assert\PostconditionException;
 
class SlotRoleRegistryTest extends MediaWikiTestCase {
 
    private function makeBlankTitleObject() {
        $title = $this->getMockBuilder( Title::class )
            ->disableOriginalConstructor()
            ->getMock();
 
        return $title;
    }
 
    private function makeNameTableStore( array $names = [] ) {
        $mock = $this->getMockBuilder( NameTableStore::class )
            ->disableOriginalConstructor()
            ->getMock();
 
        $mock->method( 'getMap' )
            ->willReturn( $names );
 
        return $mock;
    }
 
    private function newSlotRoleRegistry( NameTableStore $roleNameStore = null ) {
        if ( !$roleNameStore ) {
            $roleNameStore = $this->makeNameTableStore();
        }
 
        return new SlotRoleRegistry( $roleNameStore );
    }
 
    public function testDefineRole() {
        $registry = $this->newSlotRoleRegistry();
        $registry->defineRole( 'foo', function ( $role ) {
            return new SlotRoleHandler( $role, 'FooModel' );
        } );
 
        $this->assertTrue( $registry->isDefinedRole( 'foo' ) );
        $this->assertContains( 'foo', $registry->getDefinedRoles() );
        $this->assertContains( 'foo', $registry->getKnownRoles() );
 
        $handler = $registry->getRoleHandler( 'foo' );
        $this->assertSame( 'foo', $handler->getRole() );
 
        $title = $this->makeBlankTitleObject();
        $this->assertSame( 'FooModel', $handler->getDefaultModel( $title ) );
    }
 
    public function testDefineRoleFailsForDupe() {
        $registry = $this->newSlotRoleRegistry();
        $registry->defineRole( 'foo', function ( $role ) {
            return new SlotRoleHandler( $role, 'FooModel' );
        } );
 
        $this->setExpectedException( LogicException::class );
        $registry->defineRole( 'foo', function ( $role ) {
            return new SlotRoleHandler( $role, 'FooModel' );
        } );
    }
 
    public function testDefineRoleWithContentModel() {
        $registry = $this->newSlotRoleRegistry();
        $registry->defineRoleWithModel( 'foo', 'FooModel' );
 
        $this->assertTrue( $registry->isDefinedRole( 'foo' ) );
        $this->assertContains( 'foo', $registry->getDefinedRoles() );
        $this->assertContains( 'foo', $registry->getKnownRoles() );
 
        $handler = $registry->getRoleHandler( 'foo' );
        $this->assertSame( 'foo', $handler->getRole() );
 
        $title = $this->getMockBuilder( Title::class )
            ->disableOriginalConstructor()
            ->getMock();
        $this->assertSame( 'FooModel', $handler->getDefaultModel( $title ) );
    }
 
    public function testGetRoleHandlerForUnknownModel() {
        $registry = $this->newSlotRoleRegistry();
 
        $this->setExpectedException( InvalidArgumentException::class );
 
        $registry->getRoleHandler( 'foo' );
    }
 
    public function testGetRoleHandlerFallbackHandler() {
        $registry = $this->newSlotRoleRegistry(
            $this->makeNameTableStore( [ 1 => 'foo' ] )
        );
 
        \Wikimedia\suppressWarnings();
        $handler = $registry->getRoleHandler( 'foo' );
        $this->assertSame( 'foo', $handler->getRole() );
 
        \Wikimedia\restoreWarnings();
    }
 
    public function testGetRoleHandlerWithBadInstantiator() {
        $registry = $this->newSlotRoleRegistry();
        $registry->defineRole( 'foo', function ( $role ) {
            return 'Not a SlotRoleHandler instance';
        } );
 
        $this->setExpectedException( PostconditionException::class );
        $registry->getRoleHandler( 'foo' );
    }
 
    public function testGetRequiredRoles() {
        $registry = $this->newSlotRoleRegistry();
        $registry->defineRole( 'main', function ( $role ) {
            return new MainSlotRoleHandler( [] );
        } );
 
        $title = $this->makeBlankTitleObject();
        $this->assertEquals( [ 'main' ], $registry->getRequiredRoles( $title ) );
    }
 
    public function testGetAllowedRoles() {
        $registry = $this->newSlotRoleRegistry();
        $registry->defineRole( 'main', function ( $role ) {
            return new MainSlotRoleHandler( [] );
        } );
        $registry->defineRoleWithModel( 'foo', CONTENT_MODEL_TEXT );
 
        $title = $this->makeBlankTitleObject();
        $this->assertEquals( [ 'main', 'foo' ], $registry->getAllowedRoles( $title ) );
    }
 
    public function testGetKnownRoles() {
        $registry = $this->newSlotRoleRegistry(
            $this->makeNameTableStore( [ 1 => 'foo' ] )
        );
        $registry->defineRoleWithModel( 'bar', CONTENT_MODEL_TEXT );
 
        $this->assertTrue( $registry->isKnownRole( 'foo' ) );
        $this->assertTrue( $registry->isKnownRole( 'bar' ) );
        $this->assertFalse( $registry->isKnownRole( 'xyzzy' ) );
 
        $title = $this->makeBlankTitleObject();
        $this->assertArrayEquals( [ 'foo', 'bar' ], $registry->getKnownRoles( $title ) );
    }
 
}