class UserRoleAddTest in Rules 8.3

@coversDefaultClass \Drupal\rules\Plugin\RulesAction\UserRoleAdd @group RulesAction

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\RulesAction\UserRoleAddTest

Expanded class hierarchy of UserRoleAddTest

File

tests/src/Unit/Integration/RulesAction/UserRoleAddTest.php, line 14

Namespace

Drupal\Tests\rules\Unit\Integration\RulesAction

View source

class UserRoleAddTest extends RulesEntityIntegrationTestBase {

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

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

  /**
   * Tests the summary.
   *
   * @covers ::summary
   */
  public function testSummary() {
    $this
      ->assertEquals('Add user role', $this->action
      ->summary());
  }

  /**
   * Tests adding of one role to user. User should not be saved.
   *
   * @covers ::execute
   */
  public function testAddOneRoleNoSave() {

    // Set-up a mock user.
    $account = $this
      ->prophesizeEntity(UserInterface::class);
    $account
      ->hasRole('administrator')
      ->willReturn(FALSE);
    $account
      ->addRole('administrator')
      ->shouldBeCalledTimes(1);

    // We do not expect to call the 'save' method because the user should be
    // auto-saved later.
    $account
      ->save()
      ->shouldNotBeCalled();

    // Mock the 'administrator' user role.
    $administrator = $this
      ->prophesize(RoleInterface::class);
    $administrator
      ->id()
      ->willReturn('administrator');

    // Test adding of one role.
    $this->action
      ->setContextValue('user', $account
      ->reveal())
      ->setContextValue('roles', [
      $administrator
        ->reveal(),
    ])
      ->execute();
    $this
      ->assertEquals($this->action
      ->autoSaveContext(), [
      'user',
    ], 'Action returns the user context name for auto saving.');
  }

  /**
   * Tests adding of three roles to user.
   *
   * @covers ::execute
   */
  public function testAddThreeRoles() {

    // Set-up a mock user.
    $account = $this
      ->prophesizeEntity(UserInterface::class);

    // Mock hasRole.
    $account
      ->hasRole('manager')
      ->willReturn(FALSE)
      ->shouldBeCalledTimes(1);
    $account
      ->hasRole('editor')
      ->willReturn(FALSE)
      ->shouldBeCalledTimes(1);
    $account
      ->hasRole('administrator')
      ->willReturn(FALSE)
      ->shouldBeCalledTimes(1);

    // Mock addRole.
    $account
      ->addRole('manager')
      ->shouldBeCalledTimes(1);
    $account
      ->addRole('editor')
      ->shouldBeCalledTimes(1);
    $account
      ->addRole('administrator')
      ->shouldBeCalledTimes(1);

    // Mock user roles.
    $manager = $this
      ->prophesize(RoleInterface::class);
    $manager
      ->id()
      ->willReturn('manager');
    $editor = $this
      ->prophesize(RoleInterface::class);
    $editor
      ->id()
      ->willReturn('editor');
    $administrator = $this
      ->prophesize(RoleInterface::class);
    $administrator
      ->id()
      ->willReturn('administrator');

    // Test adding of three roles.
    $this->action
      ->setContextValue('user', $account
      ->reveal())
      ->setContextValue('roles', [
      $manager
        ->reveal(),
      $editor
        ->reveal(),
      $administrator
        ->reveal(),
    ])
      ->execute();
    $this
      ->assertEquals($this->action
      ->autoSaveContext(), [
      'user',
    ], 'Action returns the user context name for auto saving.');
  }

  /**
   * Tests adding of existing role to user.
   *
   * @covers ::execute
   */
  public function testAddExistingRole() {

    // Set-up a mock user with role 'administrator'.
    $account = $this
      ->prophesizeEntity(UserInterface::class);
    $account
      ->hasRole('administrator')
      ->willReturn(TRUE);

    // We do not expect a call of the 'addRole' method.
    $account
      ->addRole(Argument::any())
      ->shouldNotBeCalled();

    // Mock the 'administrator' user role.
    $administrator = $this
      ->prophesize(RoleInterface::class);
    $administrator
      ->id()
      ->willReturn('administrator');

    // Test adding one role.
    $this->action
      ->setContextValue('user', $account
      ->reveal())
      ->setContextValue('roles', [
      $administrator
        ->reveal(),
    ])
      ->execute();
    $this
      ->assertEquals($this->action
      ->autoSaveContext(), [], 'Action returns nothing for auto saving since the user has the role already.');
  }

  /**
   * Tests adding of one existing and one nonexistent role to user.
   *
   * @covers ::execute
   */
  public function testAddExistingAndNonexistentRole() {

    // Set-up a mock user with role 'administrator' but without 'editor'.
    $account = $this
      ->prophesizeEntity(UserInterface::class);
    $account
      ->hasRole('administrator')
      ->willReturn(TRUE)
      ->shouldBeCalledTimes(1);
    $account
      ->hasRole('editor')
      ->willReturn(FALSE)
      ->shouldBeCalledTimes(1);

    // We expect only one call of the 'addRole' method.
    $account
      ->addRole('editor')
      ->shouldBeCalledTimes(1);

    // Mock user roles.
    $editor = $this
      ->prophesize(RoleInterface::class);
    $editor
      ->id()
      ->willReturn('editor');
    $administrator = $this
      ->prophesize(RoleInterface::class);
    $administrator
      ->id()
      ->willReturn('administrator');

    // Test adding one role.
    $this->action
      ->setContextValue('user', $account
      ->reveal())
      ->setContextValue('roles', [
      $administrator
        ->reveal(),
      $editor
        ->reveal(),
    ])
      ->execute();
    $this
      ->assertEquals($this->action
      ->autoSaveContext(), [
      'user',
    ], 'Action returns the user context name for auto saving.');
  }

}

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.
UserRoleAddTest::$action	protected	property	The action that is being tested.
UserRoleAddTest::setUp	protected	function	Overrides RulesEntityIntegrationTestBase::setUp
UserRoleAddTest::testAddExistingAndNonexistentRole	public	function	Tests adding of one existing and one nonexistent role to user.
UserRoleAddTest::testAddExistingRole	public	function	Tests adding of existing role to user.
UserRoleAddTest::testAddOneRoleNoSave	public	function	Tests adding of one role to user. User should not be saved.
UserRoleAddTest::testAddThreeRoles	public	function	Tests adding of three roles to user.
UserRoleAddTest::testSummary	public	function	Tests the summary.

You are here

class UserRoleAddTest in Rules 8.3

Hierarchy

File

Namespace

Members

API Navigation