wiki.techinc.nl/tests/phpunit/includes/password/PasswordTestCase.php
Tim Starling a9911b2582 Improve test coverage in includes/password
From 21% to 82%.

* Added missing @covers, broadened @covers where appropriate.
* Added tests for some code that lacked them.
* Added a parameter to control the use of hash_pbkdf2() so that the pure
  PHP fallback could be tested. In the non-fallback test, force the use
  of the extension, and mark it skipped if it is not installed.

Bug: T167003
Change-Id: I987e1a89ec343907f4ead7f6192b2d4deb58ac16
2017-06-07 14:28:11 +10:00

112 lines
3.3 KiB
PHP

<?php
/**
* Testing framework for the password hashes
*
* 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
*
* @file
*/
/**
* @since 1.24
*/
abstract class PasswordTestCase extends MediaWikiTestCase {
/**
* @var PasswordFactory
*/
protected $passwordFactory;
protected function setUp() {
parent::setUp();
$this->passwordFactory = new PasswordFactory();
foreach ( $this->getTypeConfigs() as $type => $config ) {
$this->passwordFactory->register( $type, $config );
}
}
/**
* Return an array of configs to be used for this class's password type.
*
* @return array[]
*/
abstract protected function getTypeConfigs();
/**
* An array of tests in the form of (bool, string, string), where the first
* element is whether the second parameter (a password hash) and the third
* parameter (a password) should match.
* @return array
* @throws MWException
* @abstract
*/
public static function providePasswordTests() {
throw new MWException( "Not implemented" );
}
/**
* @dataProvider providePasswordTests
*/
public function testHashing( $shouldMatch, $hash, $password ) {
$hash = $this->passwordFactory->newFromCiphertext( $hash );
$password = $this->passwordFactory->newFromPlaintext( $password, $hash );
$this->assertSame( $shouldMatch, $hash->equals( $password ) );
}
/**
* @dataProvider providePasswordTests
*/
public function testStringSerialization( $shouldMatch, $hash, $password ) {
$hashObj = $this->passwordFactory->newFromCiphertext( $hash );
$serialized = $hashObj->toString();
$unserialized = $this->passwordFactory->newFromCiphertext( $serialized );
$this->assertTrue( $hashObj->equals( $unserialized ) );
}
/**
* @dataProvider providePasswordTests
* @covers InvalidPassword
*/
public function testInvalidUnequalNormal( $shouldMatch, $hash, $password ) {
$invalid = $this->passwordFactory->newFromCiphertext( null );
$normal = $this->passwordFactory->newFromCiphertext( $hash );
$this->assertFalse( $invalid->equals( $normal ) );
$this->assertFalse( $normal->equals( $invalid ) );
}
protected function getValidTypes() {
return array_keys( $this->getTypeConfigs() );
}
public function provideTypes( $type ) {
$params = [];
foreach ( $this->getValidTypes() as $type ) {
$params[] = [ $type ];
}
return $params;
}
/**
* @dataProvider provideTypes
*/
public function testCrypt( $type ) {
$fromType = $this->passwordFactory->newFromType( $type );
$fromType->crypt( 'password' );
$fromPlaintext = $this->passwordFactory->newFromPlaintext( 'password', $fromType );
$this->assertTrue( $fromType->equals( $fromPlaintext ) );
}
}