DefaultPreferencesFactoryTest.php

Go to the documentation of this file.

<?php
 
use MediaWiki\Auth\AuthManager;
use MediaWiki\MediaWikiServices;
use MediaWiki\Preferences\DefaultPreferencesFactory;
use Wikimedia\TestingAccessWrapper;
 
class DefaultPreferencesFactoryTest extends \MediaWikiTestCase {
 
    protected $context;
 
    protected $config;
 
    public function setUp() {
        parent::setUp();
        $this->context = new RequestContext();
        $this->context->setTitle( Title::newFromText( self::class ) );
 
        $services = MediaWikiServices::getInstance();
 
        $this->setMwGlobals( 'wgParser', $services->getParserFactory()->create() );
        $this->config = $services->getMainConfig();
    }
 
    protected function getPreferencesFactory() {
        return new DefaultPreferencesFactory(
            $this->config,
            new Language(),
            AuthManager::singleton(),
            MediaWikiServices::getInstance()->getLinkRenderer()
        );
    }
 
    public function testGetForm() {
        $this->setTemporaryHook( 'GetPreferences', null );
 
        $testUser = $this->getTestUser();
        $form = $this->getPreferencesFactory()->getForm( $testUser->getUser(), $this->context );
        $this->assertInstanceOf( PreferencesFormLegacy::class, $form );
        $this->assertCount( 5, $form->getPreferenceSections() );
    }
 
    public function testEmailAuthentication( $user, $cssClass ) {
        $prefs = $this->getPreferencesFactory()->getFormDescriptor( $user, $this->context );
        $this->assertArrayHasKey( 'cssclass', $prefs['emailauthentication'] );
        $this->assertEquals( $cssClass, $prefs['emailauthentication']['cssclass'] );
    }
 
    public function testShowRollbackConfIsHiddenForUsersWithoutRollbackRights() {
        $userMock = $this->getMockBuilder( User::class )
            ->disableOriginalConstructor()
            ->getMock();
        $userMock->method( 'isAllowed' )
            ->willReturn( false );
        $userMock->method( 'getEffectiveGroups' )
            ->willReturn( [] );
        $userMock->method( 'getGroupMemberships' )
            ->willReturn( [] );
        $userMock->method( 'getOptions' )
            ->willReturn( [ 'test' => 'yes' ] );
 
        $prefs = $this->getPreferencesFactory()->getFormDescriptor( $userMock, $this->context );
        $this->assertArrayNotHasKey( 'showrollbackconfirmation', $prefs );
    }
 
    public function testShowRollbackConfIsShownForUsersWithRollbackRights() {
        $userMock = $this->getMockBuilder( User::class )
            ->disableOriginalConstructor()
            ->getMock();
        $userMock->method( 'isAllowed' )
            ->willReturn( true );
        $userMock->method( 'getEffectiveGroups' )
            ->willReturn( [] );
        $userMock->method( 'getGroupMemberships' )
            ->willReturn( [] );
        $userMock->method( 'getOptions' )
            ->willReturn( [ 'test' => 'yes' ] );
 
        $prefs = $this->getPreferencesFactory()->getFormDescriptor( $userMock, $this->context );
        $this->assertArrayHasKey( 'showrollbackconfirmation', $prefs );
        $this->assertEquals(
            'rendering/advancedrendering',
            $prefs['showrollbackconfirmation']['section']
        );
    }
 
    public function emailAuthenticationProvider() {
        $userNoEmail = new User;
        $userEmailUnauthed = new User;
        $userEmailUnauthed->setEmail( 'noauth@example.org' );
        $userEmailAuthed = new User;
        $userEmailAuthed->setEmail( 'noauth@example.org' );
        $userEmailAuthed->setEmailAuthenticationTimestamp( wfTimestamp() );
        return [
            [ $userNoEmail, 'mw-email-none' ],
            [ $userEmailUnauthed, 'mw-email-not-authenticated' ],
            [ $userEmailAuthed, 'mw-email-authenticated' ],
        ];
    }
 
    public function testPreferencesFormPreSaveHookHasCorrectData() {
        $oldOptions = [
            'test' => 'abc',
            'option' => 'old'
        ];
        $newOptions = [
            'test' => 'abc',
            'option' => 'new'
        ];
        $configMock = new HashConfig( [
            'HiddenPrefs' => []
        ] );
        $form = $this->getMockBuilder( PreferencesFormLegacy::class )
            ->disableOriginalConstructor()
            ->getMock();
 
        $userMock = $this->getMockBuilder( User::class )
            ->disableOriginalConstructor()
            ->getMock();
        $userMock->method( 'getOptions' )
            ->willReturn( $oldOptions );
        $userMock->method( 'isAllowedAny' )
            ->willReturn( true );
        $userMock->method( 'isAllowed' )
            ->willReturn( true );
 
        $userMock->expects( $this->exactly( 2 ) )
            ->method( 'setOption' )
            ->withConsecutive(
                [ $this->equalTo( 'test' ), $this->equalTo( $newOptions[ 'test' ] ) ],
                [ $this->equalTo( 'option' ), $this->equalTo( $newOptions[ 'option' ] ) ]
            );
 
        $form->expects( $this->any() )
            ->method( 'getModifiedUser' )
            ->willReturn( $userMock );
 
        $form->expects( $this->any() )
            ->method( 'getContext' )
            ->willReturn( $this->context );
 
        $form->expects( $this->any() )
            ->method( 'getConfig' )
            ->willReturn( $configMock );
 
        $this->setTemporaryHook( 'PreferencesFormPreSave',
            function ( $formData, $form, $user, &$result, $oldUserOptions )
                use ( $newOptions, $oldOptions, $userMock ) {
                    $this->assertSame( $userMock, $user );
                    foreach ( $newOptions as $option => $value ) {
                        $this->assertSame( $value, $formData[ $option ] );
                    }
                    foreach ( $oldOptions as $option => $value ) {
                        $this->assertSame( $value, $oldUserOptions[ $option ] );
                    }
                    $this->assertEquals( true, $result );
            }
        );
 
        $factory = TestingAccessWrapper::newFromObject( $this->getPreferencesFactory() );
        $factory->saveFormData( $newOptions, $form, [] );
    }
 
    public function testIntvalFilter() {
        // Test a string with leading zeros (i.e. not octal) and spaces.
        $this->context->getRequest()->setVal( 'wprclimit', ' 0012 ' );
        $user = new User;
        $form = $this->getPreferencesFactory()->getForm( $user, $this->context );
        $form->show();
        $form->trySubmit();
        $this->assertEquals( 12, $user->getOption( 'rclimit' ) );
    }
}