wiki.techinc.nl/tests/phpunit/includes/specialpage/FormSpecialPageTestCase.php
Thalia 5310373336 Stop accessing User::mBlock and User::mBlockedby from tests
Update PermissionManagerTest and FormSpecialPageTestCase to use a
mock User object that returns a specified block.

Before this commit, these tests manipulate the public properties
User::mBlock and User::mBlockedby in order to change the user's
block. There is no advantage to doing this over mocking: it is not
more realistic, and is sensitive to changes in the code. These tests
need updating in order to deprecate public access to these properties
(see T229035).

Also, PermissionManager::testUserBlock is a large, complicated method
that tests three different things, so split it into three smaller
methods, each testing one thing:
* testCheckUserBlockActions: A blocked user is blocked/unblocked
  correctly from certain actions, depending on their block.
* testCheckUserBlockMessage: The correct block message key and
  parameters are returned, depending on the block.
* testCheckUserBlockEmailConfirmToEdit: A user is or isn't asked to
  provide email confirmation in order to edit, as specified by the
  config.

Change-Id: I0bb9252b476131c2b255d4c503c0dab5dfff94be
2019-10-15 15:05:53 +00:00

86 lines
2.6 KiB
PHP

<?php
use MediaWiki\Block\DatabaseBlock;
/**
* 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 {
/**
* @covers FormSpecialPage::checkExecutePermissions
*/
public function testCheckExecutePermissionsSitewideBlock() {
$special = $this->newSpecialPage();
$checkExecutePermissions = $this->getMethod( $special, 'checkExecutePermissions' );
$user = $this->getMockBuilder( User::class )
->setMethods( [ 'getBlock' ] )
->getMock();
$user->method( 'getBlock' )
->willReturn( new DatabaseBlock( [
'address' => '127.0.8.1',
'by' => $user->getId(),
'reason' => 'sitewide block',
'timestamp' => time(),
'sitewide' => true,
'expiry' => 10,
] ) );
$this->expectException( UserBlockedError::class );
$checkExecutePermissions( $user );
}
/**
* @covers FormSpecialPage::checkExecutePermissions
*/
public function testCheckExecutePermissionsPartialBlock() {
$special = $this->newSpecialPage();
$checkExecutePermissions = $this->getMethod( $special, 'checkExecutePermissions' );
$user = $this->getMockBuilder( User::class )
->setMethods( [ 'getBlock' ] )
->getMock();
$user->method( 'getBlock' )
->willReturn( new DatabaseBlock( [
'address' => '127.0.8.1',
'by' => $user->getId(),
'reason' => 'partial block',
'timestamp' => time(),
'sitewide' => false,
'expiry' => 10,
] ) );
$this->assertNull( $checkExecutePermissions( $user ) );
}
/**
* Get a protected/private method.
*
* @param object $obj
* @param string $name
* @return callable
*/
protected function getMethod( $obj, $name ) {
$method = new ReflectionMethod( $obj, $name );
$method->setAccessible( true );
return $method->getClosure( $obj );
}
}