You are here

Home » API reference » Rules 8.3 » UserBlockTest.php

class UserBlockTest in Rules 8.3

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

Hierarchy

Expanded class hierarchy of UserBlockTest

File

tests/src/Unit/Integration/RulesAction/UserBlockTest.php, line 13

Namespace

Drupal\Tests\rules\Unit\Integration\RulesAction
View source 
class UserBlockTest extends RulesEntityIntegrationTestBase {

  /**
   * Constant used for authenticated test when mocking a user.
   */
  const AUTHENTICATED = TRUE;

  /**
   * Constant used for authenticated test when mocking a user.
   */
  const ANONYMOUS = FALSE;

  /**
   * Constant used for active test when mocking a user.
   */
  const ACTIVE = TRUE;

  /**
   * Constant used for active test when mocking a user.
   */
  const BLOCKED = FALSE;

  /**
   * The action to be tested.
   *
   * @var \Drupal\rules\Engine\RulesActionInterface
   */
  protected $action;

  /**
   * The mocked session manager.
   *
   * @var \Drupal\Core\Session\SessionManagerInterface|\Prophecy\Prophecy\ProphecyInterface
   */
  protected $sessionManager;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this
      ->enableModule('user');
    $this->sessionManager = $this
      ->prophesize(SessionManagerInterface::class);
    $this->container
      ->set('session_manager', $this->sessionManager
      ->reveal());
    $this->action = $this->actionManager
      ->createInstance('rules_user_block');
  }

  /**
   * Test the summary method.
   *
   * @covers ::summary
   */
  public function testSummary() {
    $this
      ->assertEquals('Block a user', $this->action
      ->summary());
  }

  /**
   * Test execute() method for active and authenticated users.
   *
   * @covers ::execute
   */
  public function testBlockUserWithValidUser() {
    $user = $this
      ->getUserMock(self::ACTIVE, self::AUTHENTICATED);
    $user
      ->block()
      ->shouldBeCalledTimes(1);
    $user
      ->id()
      ->willReturn('123')
      ->shouldBeCalledTimes(1);
    $this->sessionManager
      ->delete('123')
      ->shouldBeCalledTimes(1);
    $this->action
      ->setContextValue('user', $user
      ->reveal());
    $this->action
      ->execute();
    $this
      ->assertEquals($this->action
      ->autoSaveContext(), [
      'user',
    ], 'Action returns the user context name for auto saving.');
  }

  /**
   * Test execute() method for active and anonymous users.
   *
   * @covers ::execute
   */
  public function testBlockUserWithActiveAnonymousUser() {
    $user = $this
      ->getUserMock(self::ACTIVE, self::ANONYMOUS);
    $user
      ->block()
      ->shouldNotBeCalled();
    $this->sessionManager
      ->delete()
      ->shouldNotBeCalled();
    $this->action
      ->setContextValue('user', $user
      ->reveal());
    $this->action
      ->execute();
    $this
      ->assertEquals($this->action
      ->autoSaveContext(), [], 'Action returns nothing for auto saving since the user has not been altered.');
  }

  /**
   * Test execute() method for blocked and authenticated users.
   *
   * @covers ::execute
   */
  public function testBlockUserWithBlockedAuthenticatedUser() {
    $user = $this
      ->getUserMock(self::BLOCKED, self::AUTHENTICATED);
    $user
      ->block()
      ->shouldNotBeCalled();
    $this->sessionManager
      ->delete()
      ->shouldNotBeCalled();
    $this->action
      ->setContextValue('user', $user
      ->reveal());
    $this->action
      ->execute();
    $this
      ->assertEquals($this->action
      ->autoSaveContext(), [], 'Action returns nothing for auto saving since the user has not been altered.');
  }

  /**
   * Test execute() method for blocked and anonymous users.
   *
   * @covers ::execute
   */
  public function testBlockUserWithBlockedAnonymousUser() {
    $user = $this
      ->getUserMock(self::BLOCKED, self::ANONYMOUS);
    $user
      ->block()
      ->shouldNotBeCalled();
    $this->sessionManager
      ->delete()
      ->shouldNotBeCalled();
    $this->action
      ->setContextValue('user', $user
      ->reveal());
    $this->action
      ->execute();
    $this
      ->assertEquals($this->action
      ->autoSaveContext(), [], 'Action returns nothing for auto saving since the user has not been altered.');
  }

  /**
   * Creates a mock user.
   *
   * @param bool $active
   *   Is user activated.
   * @param bool $authenticated
   *   Is user authenticated.
   *
   * @return \Drupal\user\UserInterface|\Prophecy\Prophecy\ProphecyInterface
   *   The mocked user object.
   */
  protected function getUserMock($active, $authenticated) {
    $user = $this
      ->prophesizeEntity(UserInterface::class);
    $user
      ->isActive()
      ->willReturn($active);
    $user
      ->isAuthenticated()
      ->willReturn($authenticated);
    return $user;
  }

}

Members

Namesort descending 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.
UserBlockTest::$action protected property The action to be tested.
UserBlockTest::$sessionManager protected property The mocked session manager.
UserBlockTest::ACTIVE constant Constant used for active test when mocking a user.
UserBlockTest::ANONYMOUS constant Constant used for authenticated test when mocking a user.
UserBlockTest::AUTHENTICATED constant Constant used for authenticated test when mocking a user.
UserBlockTest::BLOCKED constant Constant used for active test when mocking a user.
UserBlockTest::getUserMock protected function Creates a mock user.
UserBlockTest::setUp protected function Overrides RulesEntityIntegrationTestBase::setUp
UserBlockTest::testBlockUserWithActiveAnonymousUser public function Test execute() method for active and anonymous users.
UserBlockTest::testBlockUserWithBlockedAnonymousUser public function Test execute() method for blocked and anonymous users.
UserBlockTest::testBlockUserWithBlockedAuthenticatedUser public function Test execute() method for blocked and authenticated users.
UserBlockTest::testBlockUserWithValidUser public function Test execute() method for active and authenticated users.
UserBlockTest::testSummary public function Test the summary method.