protected function CommandsTest::assertCommand in Drupal 10

Same name and namespace in other branches

1. 8 core/tests/Drupal/KernelTests/Core/Ajax/CommandsTest.php \Drupal\KernelTests\Core\Ajax\CommandsTest::assertCommand()
2. 9 core/tests/Drupal/KernelTests/Core/Ajax/CommandsTest.php \Drupal\KernelTests\Core\Ajax\CommandsTest::assertCommand()

Asserts the array of Ajax commands contains the searched command.

An AjaxResponse object stores an array of Ajax commands. This array sometimes includes commands automatically provided by the framework in addition to commands returned by a particular controller. During testing, we're usually interested that a particular command is present, and don't care whether other commands precede or follow the one we're interested in. Additionally, the command we're interested in may include additional data that we're not interested in. Therefore, this function simply asserts that one of the commands in $haystack contains all of the keys and values in $needle. Furthermore, if $needle contains a 'settings' key with an array value, we simply assert that all keys and values within that array are present in the command we're checking, and do not consider it a failure if the actual command contains additional settings that aren't part of $needle.

@internal

Parameters

array $haystack: An array of rendered Ajax commands returned by the server.

array $needle: Array of info we're expecting in one of those commands.

string $message: An assertion message.

1 call to CommandsTest::assertCommand()

CommandsTest::testAttachedSettings in core/tests/Drupal/KernelTests/Core/Ajax/CommandsTest.php

Regression test: Settings command exists regardless of JS aggregation.

File

core/tests/Drupal/KernelTests/Core/Ajax/CommandsTest.php, line 100

Class

CommandsTest

Performs tests on AJAX framework commands.

Namespace

Drupal\KernelTests\Core\Ajax

Code

protected function assertCommand(array $haystack, array $needle, string $message) : void {
  $found = FALSE;
  foreach ($haystack as $command) {

    // If the command has additional settings that we're not testing for, do
    // not consider that a failure.
    if (isset($command['settings']) && is_array($command['settings']) && isset($needle['settings']) && is_array($needle['settings'])) {
      $command['settings'] = array_intersect_key($command['settings'], $needle['settings']);
    }

    // If the command has additional data that we're not testing for, do not
    // consider that a failure. Also, == instead of ===, because we don't
    // require the key/value pairs to be in any particular order
    // (http://php.net/manual/language.operators.array.php).
    if (array_intersect_key($command, $needle) == $needle) {
      $found = TRUE;
      break;
    }
  }
  $this
    ->assertTrue($found, $message);
}