AvailableRightsTest.php

Go to the documentation of this file.

<?php
 
class AvailableRightsTest extends PHPUnit\Framework\TestCase {
 
    use MediaWikiCoversValidator;
 
    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(
            [],
            // 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'
        );
    }
 
    public function testAllRightsWithMessage() {
        // Getting all user rights, for core: User::$mCoreRights, for extensions: $wgAvailableRights
        $allRights = User::getAllRights();
        $allMessageKeys = Language::getMessageKeysFor( 'en' );
 
        $rightsWithMessage = [];
        foreach ( $allMessageKeys as $message ) {
            // === 0: must be at beginning of string (position 0)
            if ( strpos( $message, 'right-' ) === 0 ) {
                $rightsWithMessage[] = substr( $message, strlen( 'right-' ) );
            }
        }
 
        $missing = array_diff(
            $allRights,
            $rightsWithMessage
        );
 
        $this->assertEquals(
            [],
            $missing,
            'Each user rights (core/extensions) has a corresponding right- message.'
        );
    }
}