MessageCommandTest.php in Drupal 9

Namespace

Drupal\FunctionalJavascriptTests\Ajax

File

core/tests/Drupal/FunctionalJavascriptTests/Ajax/MessageCommandTest.php

<?php

namespace Drupal\FunctionalJavascriptTests\Ajax;

use Drupal\FunctionalJavascriptTests\WebDriverTestBase;

/**
 * Tests adding messages via AJAX command.
 *
 * @group Ajax
 */
class MessageCommandTest extends WebDriverTestBase {

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'ajax_test',
  ];

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';

  /**
   * Tests AJAX MessageCommand use in a form.
   */
  public function testMessageCommand() {
    $page = $this
      ->getSession()
      ->getPage();
    $assert_session = $this
      ->assertSession();
    $this
      ->drupalGet('ajax-test/message');
    $page
      ->pressButton('Make Message In Default Location');
    $this
      ->waitForMessageVisible('I am a message in the default location.');
    $this
      ->assertAnnounceContains('I am a message in the default location.');
    $assert_session
      ->elementsCount('css', '.messages__wrapper .messages', 1);
    $page
      ->pressButton('Make Message In Alternate Location');
    $this
      ->waitForMessageVisible('I am a message in an alternate location.', '#alternate-message-container');
    $assert_session
      ->pageTextContains('I am a message in the default location.');
    $this
      ->assertAnnounceContains('I am a message in an alternate location.');
    $assert_session
      ->elementsCount('css', '.messages__wrapper .messages', 1);
    $assert_session
      ->elementsCount('css', '#alternate-message-container .messages', 1);
    $page
      ->pressButton('Make Warning Message');
    $this
      ->waitForMessageVisible('I am a warning message in the default location.', NULL, 'warning');
    $assert_session
      ->pageTextNotContains('I am a message in the default location.');
    $assert_session
      ->elementsCount('css', '.messages__wrapper .messages', 1);
    $assert_session
      ->elementsCount('css', '#alternate-message-container .messages', 1);
    $this
      ->drupalGet('ajax-test/message');

    // Test that by default, previous messages in a location are removed.
    for ($i = 0; $i < 6; $i++) {
      $page
        ->pressButton('Make Message In Default Location');
      $this
        ->waitForMessageVisible('I am a message in the default location.');
      $assert_session
        ->elementsCount('css', '.messages__wrapper .messages', 1);
      $page
        ->pressButton('Make Warning Message');
      $this
        ->waitForMessageVisible('I am a warning message in the default location.', NULL, 'warning');

      // Test that setting MessageCommand::$option['announce'] => '' suppresses
      // screen reader announcement.
      $this
        ->assertAnnounceNotContains('I am a warning message in the default location.');
      $this
        ->waitForMessageRemoved('I am a message in the default location.');
      $assert_session
        ->elementsCount('css', '.messages__wrapper .messages', 1);
    }

    // Test that if MessageCommand::clearPrevious is FALSE, messages will not
    // be cleared.
    $this
      ->drupalGet('ajax-test/message');
    for ($i = 1; $i < 7; $i++) {
      $page
        ->pressButton('Make Message In Alternate Location');
      $expected_count = $page
        ->waitFor(10, function () use ($i, $page) {
        return count($page
          ->findAll('css', '#alternate-message-container .messages')) === $i;
      });
      $this
        ->assertTrue($expected_count);
      $this
        ->assertAnnounceContains('I am a message in an alternate location.');
    }
  }

  /**
   * Asserts that a message of the expected type appears.
   *
   * @param string $message
   *   The expected message.
   * @param string $selector
   *   The selector for the element in which to check for the expected message.
   * @param string $type
   *   The expected type.
   */
  protected function waitForMessageVisible($message, $selector = '[data-drupal-messages]', $type = 'status') {
    $this
      ->assertNotEmpty($this
      ->assertSession()
      ->waitForElementVisible('css', $selector . ' .messages--' . $type . ':contains("' . $message . '")'));
  }

  /**
   * Asserts that a message of the expected type is removed.
   *
   * @param string $message
   *   The expected message.
   * @param string $selector
   *   The selector for the element in which to check for the expected message.
   * @param string $type
   *   The expected type.
   */
  protected function waitForMessageRemoved($message, $selector = '[data-drupal-messages]', $type = 'status') {
    $this
      ->assertNotEmpty($this
      ->assertSession()
      ->waitForElementRemoved('css', $selector . ' .messages--' . $type . ':contains("' . $message . '")'));
  }

  /**
   * Checks for inclusion of text in #drupal-live-announce.
   *
   * @param string $expected_message
   *   The text expected to be present in #drupal-live-announce.
   */
  protected function assertAnnounceContains($expected_message) {
    $assert_session = $this
      ->assertSession();
    $this
      ->assertNotEmpty($assert_session
      ->waitForElement('css', "#drupal-live-announce:contains('{$expected_message}')"));
  }

  /**
   * Checks for absence of the given text from #drupal-live-announce.
   *
   * @param string $expected_message
   *   The text expected to be absent from #drupal-live-announce.
   */
  protected function assertAnnounceNotContains($expected_message) {
    $assert_session = $this
      ->assertSession();
    $this
      ->assertEmpty($assert_session
      ->waitForElement('css', "#drupal-live-announce:contains('{$expected_message}')", 1000));
  }

}

Classes

Name	Description
MessageCommandTest	Tests adding messages via AJAX command.