class SystemMessageTest in Rules 8.3

@coversDefaultClass \Drupal\rules\Plugin\RulesAction\SystemMessage @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\RulesAction\SystemMessageTest

File

tests/src/Unit/Integration/RulesAction/SystemMessageTest.php, line 12

Namespace

Drupal\Tests\rules\Unit\Integration\RulesAction

class SystemMessageTest extends RulesIntegrationTestBase {

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

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

    // Clear the statically stored messages before every test run.
    $this->messenger
      ->deleteAll();
  }

  /**
   * Tests the summary.
   *
   * @covers ::summary
   */
  public function testSummary() {
    $this
      ->assertEquals('Show a message on the site', $this->action
      ->summary());
  }

  /**
   * Tests the action execution.
   *
   * @covers ::execute
   */
  public function testActionExecution() {
    $this->action
      ->setContextValue('message', 'test message')
      ->setContextValue('type', MessengerInterface::TYPE_STATUS)
      ->setContextValue('repeat', FALSE);

    // Execute the action multiple times. The message should still only
    // be stored once (repeat is set to FALSE).
    $this->action
      ->execute();
    $this->action
      ->execute();
    $this->action
      ->execute();
    $messages = $this
      ->getMessages(MessengerInterface::TYPE_STATUS);
    $this
      ->assertNotNull($messages);
    $this
      ->assertEquals([
      'test message',
    ], $messages);

    // Set the 'repeat' context to TRUE and execute the action again.
    $this->action
      ->setContextValue('repeat', TRUE);
    $this->action
      ->execute();

    // The message should be repeated now.
    $messages = $this
      ->getMessages(MessengerInterface::TYPE_STATUS);
    $this
      ->assertNotNull($messages);
    $this
      ->assertEquals([
      'test message',
      'test message',
    ], $messages);
  }

  /**
   * Tests that the action works if the optional repeat flag is not set.
   *
   * @covers ::execute
   */
  public function testOptionalRepeat() {
    $this->action
      ->setContextValue('message', 'test message')
      ->setContextValue('type', MessengerInterface::TYPE_STATUS);
    $this->action
      ->execute();
    $messages = $this
      ->getMessages(MessengerInterface::TYPE_STATUS);
    $this
      ->assertNotNull($messages);
    $this
      ->assertEquals([
      'test message',
    ], $messages);
  }

  /**
   * Clears the statically stored messages.
   *
   * @param null|string $type
   *   (optional) The type of messages to clear. Defaults to NULL which causes
   *   all messages to be cleared.
   *
   * @return $this
   */
  protected function clearMessages($type = NULL) {
    if (isset($type)) {
      $this->messenger
        ->deleteByType($type);
    }
    else {
      $this->messenger
        ->deleteAll();
    }
    return $this;
  }

  /**
   * Retrieves the stored messages.
   *
   * @param null|string $type
   *   (optional) The type of messages to return. Defaults to NULL which
   *   causes all messages to be returned.
   *
   * @return array|null
   *   A multidimensional array with keys corresponding to the set message
   *   types. The indexed array values of each contain the set messages for
   *   that type. The messages returned are limited to the type specified in
   *   the $type parameter. If there are no messages of the specified type,
   *   an empty array is returned.
   */
  protected function getMessages($type = NULL) {
    $messages = $this->messenger
      ->all();
    if (isset($type)) {
      return isset($messages[$type]) ? $messages[$type] : NULL;
    }
    return $messages;
  }

}

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.
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.
SystemMessageTest::$action	protected	property	The action to be tested.
SystemMessageTest::clearMessages	protected	function	Clears the statically stored messages.
SystemMessageTest::getMessages	protected	function	Retrieves the stored messages.
SystemMessageTest::setUp	protected	function	Overrides RulesIntegrationTestBase::setUp
SystemMessageTest::testActionExecution	public	function	Tests the action execution.
SystemMessageTest::testOptionalRepeat	public	function	Tests that the action works if the optional repeat flag is not set.
SystemMessageTest::testSummary	public	function	Tests the summary.
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.