UserRoleConditionTest.php

<?php

namespace Drupal\Tests\user\Kernel\Condition;

use Drupal\Component\Render\FormattableMarkup;
use Drupal\KernelTests\KernelTestBase;
use Drupal\user\Entity\Role;
use Drupal\user\Entity\User;
use Drupal\user\RoleInterface;

/**
 * Tests the user role condition.
 *
 * @group user
 */
class UserRoleConditionTest extends KernelTestBase {
    
    /**
     * The condition plugin manager.
     *
     * @var \Drupal\Core\Condition\ConditionManager
     */
    protected $manager;
    
    /**
     * An anonymous user for testing purposes.
     *
     * @var \Drupal\user\UserInterface
     */
    protected $anonymous;
    
    /**
     * An authenticated user for testing purposes.
     *
     * @var \Drupal\user\UserInterface
     */
    protected $authenticated;
    
    /**
     * A custom role for testing purposes.
     *
     * @var \Drupal\user\RoleInterface
     */
    protected $role;
    
    /**
     * Modules to enable.
     *
     * @var array
     */
    protected static $modules = [
        'system',
        'user',
        'field',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->installSchema('system', 'sequences');
        $this->installEntitySchema('user');
        $this->manager = $this->container
            ->get('plugin.manager.condition');
        // Set up the authenticated and anonymous roles.
        Role::create([
            'id' => RoleInterface::ANONYMOUS_ID,
            'label' => 'Anonymous user',
        ])->save();
        Role::create([
            'id' => RoleInterface::AUTHENTICATED_ID,
            'label' => 'Authenticated user',
        ])->save();
        // Create new role.
        $rid = strtolower($this->randomMachineName(8));
        $label = $this->randomString(8);
        $role = Role::create([
            'id' => $rid,
            'label' => $label,
        ]);
        $role->save();
        $this->role = $role;
        // Setup an anonymous user for our tests.
        $this->anonymous = User::create([
            'name' => '',
            'uid' => 0,
        ]);
        $this->anonymous
            ->save();
        // Loading the anonymous user adds the correct role.
        $this->anonymous = User::load($this->anonymous
            ->id());
        // Setup an authenticated user for our tests.
        $this->authenticated = User::create([
            'name' => $this->randomMachineName(),
        ]);
        $this->authenticated
            ->save();
        // Add the custom role.
        $this->authenticated
            ->addRole($this->role
            ->id());
    }
    
    /**
     * Tests the user_role condition.
     */
    public function testConditions() {
        // Grab the user role condition and configure it to check against
        // authenticated user roles.
        
        /** @var \Drupal\Core\Condition\ConditionInterface $condition */
        $condition = $this->manager
            ->createInstance('user_role')
            ->setConfig('roles', [
            RoleInterface::AUTHENTICATED_ID => RoleInterface::AUTHENTICATED_ID,
        ])
            ->setContextValue('user', $this->anonymous);
        $this->assertFalse($condition->execute(), 'Anonymous users fail role checks for authenticated.');
        // Check for the proper summary.
        // Summaries require an extra space due to negate handling in summary().
        $this->assertEquals('The user is a member of Authenticated user', $condition->summary());
        // Set the user role to anonymous.
        $condition->setConfig('roles', [
            RoleInterface::ANONYMOUS_ID => RoleInterface::ANONYMOUS_ID,
        ]);
        $this->assertTrue($condition->execute(), 'Anonymous users pass role checks for anonymous.');
        // Check for the proper summary.
        $this->assertEquals('The user is a member of Anonymous user', $condition->summary());
        // Set the user role to check anonymous or authenticated.
        $condition->setConfig('roles', [
            RoleInterface::ANONYMOUS_ID => RoleInterface::ANONYMOUS_ID,
            RoleInterface::AUTHENTICATED_ID => RoleInterface::AUTHENTICATED_ID,
        ]);
        $this->assertTrue($condition->execute(), 'Anonymous users pass role checks for anonymous or authenticated.');
        // Check for the proper summary.
        $this->assertEquals('The user is a member of Anonymous user, Authenticated user', $condition->summary());
        // Set the context to the authenticated user and check that they also pass
        // against anonymous or authenticated roles.
        $condition->setContextValue('user', $this->authenticated);
        $this->assertTrue($condition->execute(), 'Authenticated users pass role checks for anonymous or authenticated.');
        // Set the role to just authenticated and recheck.
        $condition->setConfig('roles', [
            RoleInterface::AUTHENTICATED_ID => RoleInterface::AUTHENTICATED_ID,
        ]);
        $this->assertTrue($condition->execute(), 'Authenticated users pass role checks for authenticated.');
        // Check the negated summary.
        $condition->setConfig('negate', TRUE);
        $this->assertEquals('The user is not a member of Authenticated user', $condition->summary());
        // Check the complex negated summary.
        $condition->setConfig('roles', [
            RoleInterface::ANONYMOUS_ID => RoleInterface::ANONYMOUS_ID,
            RoleInterface::AUTHENTICATED_ID => RoleInterface::AUTHENTICATED_ID,
        ]);
        $this->assertEquals('The user is not a member of Anonymous user, Authenticated user', $condition->summary());
        // Check a custom role.
        $condition->setConfig('roles', [
            $this->role
                ->id() => $this->role
                ->id(),
        ]);
        $condition->setConfig('negate', FALSE);
        $this->assertTrue($condition->execute(), 'Authenticated user is a member of the custom role.');
        $this->assertEquals(new FormattableMarkup('The user is a member of @roles', [
            '@roles' => $this->role
                ->label(),
        ]), $condition->summary());
    }
    
    /**
     * @group legacy
     */
    public function testLegacy() {
        $this->expectDeprecation('Passing context values to plugins via configuration is deprecated in drupal:9.1.0 and will be removed before drupal:10.0.0. Instead, call ::setContextValue() on the plugin itself. See https://www.drupal.org/node/3120980');
        // Test Constructor injection.
        $condition = $this->manager
            ->createInstance('user_role', [
            'roles' => [
                RoleInterface::AUTHENTICATED_ID => RoleInterface::AUTHENTICATED_ID,
            ],
            'context' => [
                'user' => $this->authenticated,
            ],
        ]);
        $this->assertTrue($condition->execute(), 'Constructor injection of context and configuration working as anticipated.');
    }

}