From cd5790efff52934264270f930e39793a24009ab9 Mon Sep 17 00:00:00 2001 From: Hoo man Date: Sat, 21 Feb 2015 17:21:19 +0000 Subject: [PATCH] Re-introduce AvailableRightsTest for User::getAllRights completeness Because extensions often don't add their rights to $wgAvailableRights or via the 'UserGetAllRights' hook, thus User::getAllRights is incomplete. As announced on https://lists.wikimedia.org/pipermail/wikitech-l/2015-February/080953.html This reverts commit 9a16d3a37e0a00951139bc5e8b62bfa16306a6e4. Change-Id: Ic394145d123cd74bdd5b912559f56c393f1d5919 --- includes/User.php | 2 +- .../phpunit/structure/AvailableRightsTest.php | 51 +++++++++++++++++++ 2 files changed, 52 insertions(+), 1 deletion(-) create mode 100644 tests/phpunit/structure/AvailableRightsTest.php diff --git a/includes/User.php b/includes/User.php index 7025717799..027f1c1dbe 100644 --- a/includes/User.php +++ b/includes/User.php @@ -4416,7 +4416,7 @@ class User implements IDBAccessObject { /** * Get a list of all available permissions. - * @return array Array of permission names + * @return string[] Array of permission names */ public static function getAllRights() { if ( self::$mAllRights === false ) { diff --git a/tests/phpunit/structure/AvailableRightsTest.php b/tests/phpunit/structure/AvailableRightsTest.php new file mode 100644 index 0000000000..51d31aaa0a --- /dev/null +++ b/tests/phpunit/structure/AvailableRightsTest.php @@ -0,0 +1,51 @@ + + */ +class AvailableRightsTest extends PHPUnit_Framework_TestCase { + + /** + * Returns all rights that should be in $wgAvailableRights + all rights + * registered via the 'UserGetAllRights' hook + all "core" rights. + * + * @return string[] + */ + private function getAllVisibleRights() { + global $wgGroupPermissions, $wgRevokePermissions; + + $rights = User::getAllRights(); + + foreach( $wgGroupPermissions as $permissions ) { + $rights = array_merge( $rights, array_keys( $permissions ) ); + } + + foreach( $wgRevokePermissions as $permissions ) { + $rights = array_merge( $rights, array_keys( $permissions ) ); + } + + $rights = array_unique( $rights ); + sort( $rights ); + + return $rights; + } + + public function testAvailableRights() { + $missingRights = array_diff( + $this->getAllVisibleRights(), + User::getAllRights() + ); + + $this->assertEquals( + array(), + // Re-index to produce nicer output, keys are meaningless. + array_values( $missingRights ), + 'Additional user rights need to be added to $wgAvailableRights or ' . + 'via the "UserGetAllRights" hook. See the instructions at: ' . + 'https://www.mediawiki.org/wiki/Manual:User_rights#Adding_new_rights' + ); + } +} -- 2.20.1