Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\system\Tests\Ajax;
Chris@0: 
Chris@0: use Drupal\simpletest\WebTestBase;
Chris@0: 
Chris@0: /**
Chris@0:  * Provides a base class for Ajax tests.
Chris@0:  */
Chris@0: abstract class AjaxTestBase extends WebTestBase {
Chris@0: 
Chris@0:   /**
Chris@0:    * Modules to enable.
Chris@0:    *
Chris@0:    * @var array
Chris@0:    */
Chris@0:   public static $modules = ['node', 'ajax_test', 'ajax_forms_test'];
Chris@0: 
Chris@0:   /**
Chris@0:    * Asserts the array of Ajax commands contains the searched command.
Chris@0:    *
Chris@0:    * An AjaxResponse object stores an array of Ajax commands. This array
Chris@0:    * sometimes includes commands automatically provided by the framework in
Chris@0:    * addition to commands returned by a particular controller. During testing,
Chris@0:    * we're usually interested that a particular command is present, and don't
Chris@0:    * care whether other commands precede or follow the one we're interested in.
Chris@0:    * Additionally, the command we're interested in may include additional data
Chris@0:    * that we're not interested in. Therefore, this function simply asserts that
Chris@0:    * one of the commands in $haystack contains all of the keys and values in
Chris@0:    * $needle. Furthermore, if $needle contains a 'settings' key with an array
Chris@0:    * value, we simply assert that all keys and values within that array are
Chris@0:    * present in the command we're checking, and do not consider it a failure if
Chris@0:    * the actual command contains additional settings that aren't part of
Chris@0:    * $needle.
Chris@0:    *
Chris@0:    * @param $haystack
Chris@0:    *   An array of rendered Ajax commands returned by the server.
Chris@0:    * @param $needle
Chris@0:    *   Array of info we're expecting in one of those commands.
Chris@0:    * @param $message
Chris@0:    *   An assertion message.
Chris@0:    */
Chris@0:   protected function assertCommand($haystack, $needle, $message) {
Chris@0:     $found = FALSE;
Chris@0:     foreach ($haystack as $command) {
Chris@0:       // If the command has additional settings that we're not testing for, do
Chris@0:       // not consider that a failure.
Chris@0:       if (isset($command['settings']) && is_array($command['settings']) && isset($needle['settings']) && is_array($needle['settings'])) {
Chris@0:         $command['settings'] = array_intersect_key($command['settings'], $needle['settings']);
Chris@0:       }
Chris@0:       // If the command has additional data that we're not testing for, do not
Chris@0:       // consider that a failure. Also, == instead of ===, because we don't
Chris@0:       // require the key/value pairs to be in any particular order
Chris@0:       // (http://php.net/manual/language.operators.array.php).
Chris@0:       if (array_intersect_key($command, $needle) == $needle) {
Chris@0:         $found = TRUE;
Chris@0:         break;
Chris@0:       }
Chris@0:     }
Chris@0:     $this->assertTrue($found, $message);
Chris@0:   }
Chris@0: 
Chris@0: }