class UserHasRoleTest in Rules 8.3

@coversDefaultClass \Drupal\rules\Plugin\Condition\UserHasRole @group RulesCondition

Hierarchy

class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses PhpunitCompatibilityTrait
- class \Drupal\Tests\rules\Unit\Integration\RulesIntegrationTestBase
  - class \Drupal\Tests\rules\Unit\Integration\RulesEntityIntegrationTestBase
    class \Drupal\Tests\rules\Unit\Integration\Condition\UserHasRoleTest

Expanded class hierarchy of UserHasRoleTest

File

tests/src/Unit/Integration/Condition/UserHasRoleTest.php, line 14

Namespace

Drupal\Tests\rules\Unit\Integration\Condition

View source

class UserHasRoleTest extends RulesEntityIntegrationTestBase {

  /**
   * The condition that is being tested.
   *
   * @var \Drupal\rules\Core\RulesConditionInterface
   */
  protected $condition;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this
      ->enableModule('user');
    $this->condition = $this->conditionManager
      ->createInstance('rules_user_has_role');
  }

  /**
   * Tests evaluating the condition.
   *
   * @covers ::evaluate
   */
  public function testConditionEvaluation() {

    // Set-up a mock object with roles 'authenticated' and 'editor', but not
    // 'administrator'.
    $account = $this
      ->prophesizeEntity(UserInterface::class);
    $account
      ->getRoles()
      ->willReturn([
      'authenticated',
      'editor',
    ])
      ->shouldBeCalledTimes(7);
    $this->condition
      ->setContextValue('user', $account
      ->reveal());
    $authenticated = $this
      ->prophesize(RoleInterface::class);
    $authenticated
      ->id()
      ->willReturn('authenticated');
    $editor = $this
      ->prophesize(RoleInterface::class);
    $editor
      ->id()
      ->willReturn('editor');
    $administrator = $this
      ->prophesize(RoleInterface::class);
    $administrator
      ->id()
      ->willReturn('administrator');

    // First test the default AND condition with both roles the user has.
    $this->condition
      ->setContextValue('roles', [
      $authenticated
        ->reveal(),
      $editor
        ->reveal(),
    ]);
    $this
      ->assertTrue($this->condition
      ->evaluate());

    // User doesn't have the administrator role, this should fail.
    $this->condition
      ->setContextValue('roles', [
      $authenticated
        ->reveal(),
      $administrator
        ->reveal(),
    ]);
    $this
      ->assertFalse($this->condition
      ->evaluate());

    // Only one role, should succeed.
    $this->condition
      ->setContextValue('roles', [
      $authenticated
        ->reveal(),
    ]);
    $this
      ->assertTrue($this->condition
      ->evaluate());

    // A role the user doesn't have.
    $this->condition
      ->setContextValue('roles', [
      $administrator
        ->reveal(),
    ]);
    $this
      ->assertFalse($this->condition
      ->evaluate());

    // Only one role, the user has with OR condition, should succeed.
    $this->condition
      ->setContextValue('roles', [
      $authenticated
        ->reveal(),
    ]);
    $this->condition
      ->setContextValue('operation', 'OR');
    $this
      ->assertTrue($this->condition
      ->evaluate());

    // User doesn't have the administrator role, but has the authenticated,
    // should succeed.
    $this->condition
      ->setContextValue('roles', [
      $authenticated
        ->reveal(),
      $administrator
        ->reveal(),
    ]);
    $this->condition
      ->setContextValue('operation', 'OR');
    $this
      ->assertTrue($this->condition
      ->evaluate());

    // User doesn't have the administrator role. This should fail.
    $this->condition
      ->setContextValue('roles', [
      $administrator
        ->reveal(),
    ]);
    $this->condition
      ->setContextValue('operation', 'OR');
    $this
      ->assertFalse($this->condition
      ->evaluate());
  }

  /**
   * Test the behavior with unsupported operations.
   *
   * @covers ::execute
   */
  public function testInvalidOperationException() {

    // Set the expected exception class and message.
    $this
      ->expectException(InvalidArgumentException::class);
    $this
      ->expectExceptionMessage('Either use "AND" or "OR". Leave empty for default "AND" behavior.');

    // Set-up a mock object with roles 'authenticated' and 'editor', but not
    // 'administrator'.
    $account = $this
      ->prophesizeEntity(UserInterface::class);
    $account
      ->getRoles()
      ->willReturn([
      'authenticated',
      'editor',
    ]);
    $this->condition
      ->setContextValue('user', $account
      ->reveal());
    $authenticated = $this
      ->prophesize(RoleInterface::class);
    $authenticated
      ->id()
      ->willReturn('authenticated');

    // Now test INVALID as operation. An exception must be thrown.
    $this->condition
      ->setContextValue('roles', [
      $authenticated
        ->reveal(),
    ]);
    $this->condition
      ->setContextValue('operation', 'INVALID');
    $this->condition
      ->evaluate();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PhpunitCompatibilityTrait::getMock Deprecated	public	function	Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated	public	function	Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RulesEntityIntegrationTestBase::$entityAccess	protected	property	The mocked entity access handler.
RulesEntityIntegrationTestBase::$fieldTypeManager	protected	property	The field type manager.
RulesEntityIntegrationTestBase::$languageManager	protected	property	The language manager mock.
RulesEntityIntegrationTestBase::getContextDefinitionFor	protected	function	Helper to mock a context definition with a mocked data definition.
RulesIntegrationTestBase::$actionManager	protected	property
RulesIntegrationTestBase::$cacheBackend	protected	property
RulesIntegrationTestBase::$classResolver	protected	property	The class resolver mock for the typed data manager.
RulesIntegrationTestBase::$conditionManager	protected	property
RulesIntegrationTestBase::$container	protected	property	The Drupal service container.
RulesIntegrationTestBase::$dataFetcher	protected	property	The data fetcher service.
RulesIntegrationTestBase::$dataFilterManager	protected	property	The data filter manager.
RulesIntegrationTestBase::$enabledModules	protected	property	Array object keyed with module names and TRUE as value.
RulesIntegrationTestBase::$entityFieldManager	protected	property
RulesIntegrationTestBase::$entityTypeBundleInfo	protected	property
RulesIntegrationTestBase::$entityTypeManager	protected	property
RulesIntegrationTestBase::$logger	protected	property	A mocked Rules logger.channel.rules_debug service.	6
RulesIntegrationTestBase::$messenger	protected	property	The messenger service.
RulesIntegrationTestBase::$moduleHandler	protected	property
RulesIntegrationTestBase::$namespaces	protected	property	All setup'ed namespaces.
RulesIntegrationTestBase::$placeholderResolver	protected	property	The placeholder resolver service.
RulesIntegrationTestBase::$rulesDataProcessorManager	protected	property
RulesIntegrationTestBase::$rulesExpressionManager	protected	property
RulesIntegrationTestBase::$typedDataManager	protected	property
RulesIntegrationTestBase::constructModulePath	protected	function	Determines the path to a module's class files.
RulesIntegrationTestBase::enableModule	protected	function	Fakes the enabling of a module and adds its namespace for plugin loading.
RulesIntegrationTestBase::getTypedData	protected	function	Returns a typed data object.
RulesIntegrationTestBase::prophesizeEntity	protected	function	Helper method to mock irrelevant cache methods on entities.
UnitTestCase::$randomGenerator	protected	property	The random generator.
UnitTestCase::$root	protected	property	The app root.	1
UnitTestCase::assertArrayEquals	protected	function	Asserts if two arrays are equal by sorting them first.
UnitTestCase::getBlockMockWithMachineName Deprecated	protected	function	Mocks a block with a block plugin.	1
UnitTestCase::getClassResolverStub	protected	function	Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub	public	function	Returns a stub config factory that behaves according to the passed array.
UnitTestCase::getConfigStorageStub	public	function	Returns a stub config storage that returns the supplied configuration.
UnitTestCase::getContainerWithCacheTagsInvalidator	protected	function	Sets up a container with a cache tags invalidator.
UnitTestCase::getRandomGenerator	protected	function	Gets the random generator for the utility methods.
UnitTestCase::getStringTranslationStub	public	function	Returns a stub translation manager that just returns the passed string.
UnitTestCase::randomMachineName	public	function	Generates a unique random string containing letters and numbers.
UserHasRoleTest::$condition	protected	property	The condition that is being tested.
UserHasRoleTest::setUp	protected	function	Overrides RulesEntityIntegrationTestBase::setUp
UserHasRoleTest::testConditionEvaluation	public	function	Tests evaluating the condition.
UserHasRoleTest::testInvalidOperationException	public	function	Test the behavior with unsupported operations.

You are here

class UserHasRoleTest in Rules 8.3

Hierarchy

File

Namespace

Members

API Navigation