wiki.techinc.nl/tests/phpunit/includes/specialpage/FormSpecialPageTestCase.php
Dreamy Jazz a83470fb4f Redefine services before ::newSpecialPage in FormSpecialPageTestCase
Why:
* The FormSpecialPageTestCase is a base test class to test classes
  that extend FormSpecialPage.
* This class defines two common tests that verify permission checks
  for the special page by redefining the necessary services after
  a call to ::newSpecialPage
* However, if the FormSpecialPage instance has one of the redefined
  services as a dependency, then it will not get the redefined
  service and therefore may fail tests, for example for the CheckUser
  extnesion.
* Moving the redefinitions of the services to above the call to
  ::newSpecialPage fixes this issue.

What:
* Move the call to ::newSpecialPage in the two tests to below any
  redefinition of a service.

Bug: T362569
Change-Id: I610bcf4c98f2692510280f4cafc8f4934e94d947
2024-04-15 19:28:20 +01:00

120 lines
4.6 KiB
PHP

<?php
namespace MediaWiki\Tests\SpecialPage;
use MediaWiki\Block\BlockErrorFormatter;
use MediaWiki\Block\DatabaseBlock;
use MediaWiki\DAO\WikiAwareEntity;
use MediaWiki\Permissions\PermissionManager;
use MediaWiki\SpecialPage\FormSpecialPage;
use MediaWiki\User\User;
use MediaWiki\Utils\MWTimestamp;
use ReflectionMethod;
use SpecialPageTestBase;
use UserBlockedError;
use Wikimedia\Rdbms\ReadOnlyMode;
/**
* Factory for handling the special page list and generating SpecialPage objects.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @group SpecialPage
*/
abstract class FormSpecialPageTestCase extends SpecialPageTestBase {
/**
* @return FormSpecialPage
*/
abstract protected function newSpecialPage();
/**
* @covers \MediaWiki\SpecialPage\FormSpecialPage::checkExecutePermissions
*/
public function testCheckExecutePermissionsSitewideBlock() {
$blockErrorFormatter = $this->createMock( BlockErrorFormatter::class );
$blockErrorFormatter->method( 'getMessage' )
->willReturn( $this->getMockMessage( 'test' ) );
$this->setService( 'BlockErrorFormatter', $blockErrorFormatter );
// Make the permission tests pass so we can check that the user is denied access because of their block.
$permissionManager = $this->createMock( PermissionManager::class );
$permissionManager->method( 'userHasRight' )->willReturn( true );
$this->setService( 'PermissionManager', $permissionManager );
$special = $this->newSpecialPage();
$checkExecutePermissions = $this->getMethod( $special, 'checkExecutePermissions' );
$user = $this->getMockBuilder( User::class )
->onlyMethods( [ 'getBlock', 'getWikiId' ] )
->getMock();
$user->method( 'getWikiId' )->willReturn( WikiAwareEntity::LOCAL );
$block = $this->createMock( DatabaseBlock::class );
$block->method( 'isSitewide' )->willReturn( true );
$block->method( 'getTargetUserIdentity' )->willReturn( $user );
$block->method( 'getExpiry' )->willReturn( MWTimestamp::convert( TS_MW, 10 ) );
$user->method( 'getBlock' )->willReturn( $block );
$this->expectException( UserBlockedError::class );
$checkExecutePermissions( $user );
}
/**
* @covers \MediaWiki\SpecialPage\FormSpecialPage::checkExecutePermissions
*/
public function testCheckExecutePermissionsPartialBlock() {
$blockErrorFormatter = $this->createMock( BlockErrorFormatter::class );
$blockErrorFormatter->method( 'getMessage' )
->willReturn( $this->getMockMessage( 'test' ) );
$this->setService( 'BlockErrorFormatter', $blockErrorFormatter );
$readOnlyMode = $this->createMock( ReadOnlyMode::class );
$readOnlyMode->method( 'isReadOnly' )->willReturn( false );
$this->setService( 'ReadOnlyMode', $readOnlyMode );
// Make the permission tests pass so we can check that the user is denied access because of their block.
$permissionManager = $this->createMock( PermissionManager::class );
$permissionManager->method( 'userHasRight' )->willReturn( true );
$this->setService( 'PermissionManager', $permissionManager );
$special = $this->newSpecialPage();
$checkExecutePermissions = $this->getMethod( $special, 'checkExecutePermissions' );
$user = $this->getMockBuilder( User::class )
->onlyMethods( [ 'getBlock', 'getWikiId' ] )
->getMock();
$user->method( 'getWikiId' )->willReturn( WikiAwareEntity::LOCAL );
$block = $this->createMock( DatabaseBlock::class );
$block->method( 'isSitewide' )->willReturn( false );
$block->method( 'getTargetUserIdentity' )->willReturn( $user );
$block->method( 'getExpiry' )->willReturn( MWTimestamp::convert( TS_MW, 10 ) );
$user->method( 'getBlock' )->willReturn( $block );
$this->assertNull( $checkExecutePermissions( $user ) );
}
/**
* Get a protected/private method.
*
* @param FormSpecialPage $obj
* @param string $name
* @return callable
*/
protected function getMethod( FormSpecialPage $obj, $name ) {
$method = new ReflectionMethod( $obj, $name );
$method->setAccessible( true );
return $method->getClosure( $obj );
}
}