class UserRoleConditionTest

Same name in other branches
  1. 8.9.x core/modules/user/tests/src/Kernel/Condition/UserRoleConditionTest.php \Drupal\Tests\user\Kernel\Condition\UserRoleConditionTest
  2. 10 core/modules/user/tests/src/Kernel/Condition/UserRoleConditionTest.php \Drupal\Tests\user\Kernel\Condition\UserRoleConditionTest
  3. 11.x core/modules/user/tests/src/Kernel/Condition/UserRoleConditionTest.php \Drupal\Tests\user\Kernel\Condition\UserRoleConditionTest

Tests the user role condition.

@group user

Hierarchy

Expanded class hierarchy of UserRoleConditionTest

File

core/modules/user/tests/src/Kernel/Condition/UserRoleConditionTest.php, line 16

Namespace

Drupal\Tests\user\Kernel\Condition
View source
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.');
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if raw text IS NOT found escaped on loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated protected function
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 6
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes
that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading
of code from extensions. Running the test in a separate process isolates
this behavior from other tests. Subclasses should not override this
property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 7
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel private function Bootstraps a kernel for a test.
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 3
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 26
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 3
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 5
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__sleep public function Prevents serializing any properties.
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers. 1
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
UserRoleConditionTest::$anonymous protected property An anonymous user for testing purposes.
UserRoleConditionTest::$authenticated protected property An authenticated user for testing purposes.
UserRoleConditionTest::$manager protected property The condition plugin manager.
UserRoleConditionTest::$modules protected static property Modules to enable. Overrides KernelTestBase::$modules
UserRoleConditionTest::$role protected property A custom role for testing purposes.
UserRoleConditionTest::setUp protected function Overrides KernelTestBase::setUp
UserRoleConditionTest::testConditions public function Tests the user_role condition.
UserRoleConditionTest::testLegacy public function @group legacy

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.