TestBase.php 49.9 KB
Newer Older
1 2 3 4
<?php

/**
 * @file
5
 * Definition of \Drupal\simpletest\TestBase.
6 7 8 9
 */

namespace Drupal\simpletest;

10
use Drupal\Component\Utility\Random;
11
use Drupal\Core\Database\Database;
12
use Drupal\Component\Utility\Settings;
13
use Drupal\Core\Config\ConfigImporter;
14
use Drupal\Core\Config\StorageComparer;
15
use Drupal\Core\DependencyInjection\ContainerBuilder;
16
use Drupal\Core\Database\ConnectionNotDefinedException;
17
use Drupal\Core\Config\StorageInterface;
18
use Drupal\Core\DrupalKernel;
19
use Drupal\Core\Language\Language;
20
use Drupal\Core\StreamWrapper\PublicStream;
21 22 23 24

/**
 * Base class for Drupal tests.
 *
25 26
 * Do not extend this class directly, use either
 * \Drupal\simpletest\WebTestBaseBase or \Drupal\simpletest\UnitTestBaseBase.
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
 */
abstract class TestBase {
  /**
   * The test run ID.
   *
   * @var string
   */
  protected $testId;

  /**
   * The database prefix of this test run.
   *
   * @var string
   */
  protected $databasePrefix = NULL;

  /**
   * The original file directory, before it was changed for testing purposes.
   *
   * @var string
   */
  protected $originalFileDirectory = NULL;

  /**
   * Time limit for the test.
   */
  protected $timeLimit = 500;

  /**
   * Current results of this test case.
   *
   * @var Array
   */
  public $results = array(
    '#pass' => 0,
    '#fail' => 0,
    '#exception' => 0,
    '#debug' => 0,
  );

  /**
   * Assertions thrown in that test case.
   *
   * @var Array
   */
  protected $assertions = array();

  /**
   * This class is skipped when looking for the source of an assertion.
   *
   * When displaying which function an assert comes from, it's not too useful
   * to see "WebTestBase->drupalLogin()', we would like to see the test
   * that called it. So we need to skip the classes defining these helper
   * methods.
   */
  protected $skipClasses = array(__CLASS__ => TRUE);

  /**
   * Flag to indicate whether the test has been set up.
   *
   * The setUp() method isolates the test from the parent Drupal site by
   * creating a random prefix for the database and setting up a clean file
   * storage directory. The tearDown() method then cleans up this test
   * environment. We must ensure that setUp() has been run. Otherwise,
   * tearDown() will act on the parent Drupal site rather than the test
   * environment, destroying live data.
   */
  protected $setup = FALSE;

96 97 98 99
  protected $setupDatabasePrefix = FALSE;

  protected $setupEnvironment = FALSE;

100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
  /**
   * TRUE if verbose debugging is enabled.
   *
   * @var boolean
   */
  protected $verbose = FALSE;

  /**
   * Incrementing identifier for verbose output filenames.
   *
   * @var integer
   */
  protected $verboseId = 0;

  /**
   * Safe class name for use in verbose output filenames.
   *
   * Namespaces separator (\) replaced with _.
   *
   * @var string
   */
  protected $verboseClassName;

  /**
   * Directory where verbose output files are put.
   *
   * @var string
   */
  protected $verboseDirectory;

130 131 132 133 134 135 136
  /**
   * The original database prefix when running inside Simpletest.
   *
   * @var string
   */
  protected $originalPrefix;

137 138 139 140 141 142 143
  /**
   * URL to the verbose output file directory.
   *
   * @var string
   */
  protected $verboseDirectoryUrl;

144 145 146 147 148
  /**
   * The settings array.
   */
  protected $originalSettings;

149 150 151 152 153 154 155 156 157
  /**
   * The public file directory for the test environment.
   *
   * This is set in TestBase::prepareEnvironment().
   *
   * @var string
   */
  protected $public_files_directory;

158
  /**
159 160
   * Whether to die in case any test assertion fails.
   *
161
   * @var boolean
162 163
   *
   * @see run-tests.sh
164
   */
165
  public $dieOnFail = FALSE;
166

167 168 169 170 171 172 173
  /**
   * The dependency injection container used in the test.
   *
   * @var \Symfony\Component\DependencyInjection\ContainerInterface
   */
  protected $container;

174 175 176 177 178 179 180
  /**
   * The config importer that can used in a test.
   *
   * @var \Drupal\Core\Config\ConfigImporter
   */
  protected $configImporter;

181 182 183 184 185 186 187
  /**
   * The random generator.
   *
   * @var \Drupal\Component\Utility\Random
   */
  protected $randomGenerator;

188 189 190 191 192 193 194 195 196 197
  /**
   * Constructor for Test.
   *
   * @param $test_id
   *   Tests with the same id are reported together.
   */
  public function __construct($test_id = NULL) {
    $this->testId = $test_id;
  }

198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
  /**
   * Provides meta information about this test case, such as test name.
   *
   * @return array
   *   An array of untranslated strings with the following keys:
   *   - name: An overview of what is tested by the class; for example, "User
   *     access rules".
   *   - description: One sentence describing the test, starting with a verb.
   *   - group: The human-readable name of the module ("Node", "Statistics"), or
   *     the human-readable name of the Drupal facility tested (e.g. "Form API"
   *     or "XML-RPC").
   */
  public static function getInfo() {
    // PHP does not allow us to declare this method as abstract public static,
    // so we simply throw an exception here if this has not been implemented by
    // a child class.
    throw new \RuntimeException("Sub-class must implement the getInfo method!");
  }

  /**
   * Performs setup tasks before each individual test method is run.
   */
  abstract protected function setUp();

222 223 224 225 226 227 228 229 230 231 232 233 234 235
  /**
   * Checks the matching requirements for Test.
   *
   * @return
   *   Array of errors containing a list of unmet requirements.
   */
  protected function checkRequirements() {
    return array();
  }

  /**
   * Internal helper: stores the assert.
   *
   * @param $status
236
   *   Can be 'pass', 'fail', 'exception', 'debug'.
237 238
   *   TRUE is a synonym for 'pass', FALSE for 'fail'.
   * @param $message
239 240 241
   *   (optional) A message to display with the assertion. Do not translate
   *   messages: use format_string() to embed variables in the message text, not
   *   t(). If left blank, a default message will be displayed.
242
   * @param $group
243 244 245 246
   *   (optional) The group this message is in, which is displayed in a column
   *   in test output. Use 'Debug' to indicate this is debugging output. Do not
   *   translate this string. Defaults to 'Other'; most tests do not override
   *   this default.
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
   * @param $caller
   *   By default, the assert comes from a function whose name starts with
   *   'test'. Instead, you can specify where this assert originates from
   *   by passing in an associative array as $caller. Key 'file' is
   *   the name of the source file, 'line' is the line number and 'function'
   *   is the caller function itself.
   */
  protected function assert($status, $message = '', $group = 'Other', array $caller = NULL) {
    // Convert boolean status to string status.
    if (is_bool($status)) {
      $status = $status ? 'pass' : 'fail';
    }

    // Increment summary result counter.
    $this->results['#' . $status]++;

    // Get the function information about the call to the assertion method.
    if (!$caller) {
      $caller = $this->getAssertionCall();
    }

    // Creation assertion array that can be displayed while tests are running.
    $this->assertions[] = $assertion = array(
      'test_id' => $this->testId,
      'test_class' => get_class($this),
      'status' => $status,
      'message' => $message,
      'message_group' => $group,
      'function' => $caller['function'],
      'line' => $caller['line'],
      'file' => $caller['file'],
    );

    // Store assertion for display after the test has completed.
281
    self::getDatabaseConnection()
282 283 284 285 286 287 288 289 290 291
      ->insert('simpletest')
      ->fields($assertion)
      ->execute();

    // We do not use a ternary operator here to allow a breakpoint on
    // test failure.
    if ($status == 'pass') {
      return TRUE;
    }
    else {
292
      if ($this->dieOnFail && ($status == 'fail' || $status == 'exception')) {
293 294
        exit(1);
      }
295 296 297 298 299 300 301 302 303 304 305
      return FALSE;
    }
  }

  /**
   * Store an assertion from outside the testing context.
   *
   * This is useful for inserting assertions that can only be recorded after
   * the test case has been destroyed, such as PHP fatal errors. The caller
   * information is not automatically gathered since the caller is most likely
   * inserting the assertion on behalf of other code. In all other respects
306
   * the method behaves just like \Drupal\simpletest\TestBase::assert() in terms
307 308 309 310 311
   * of storing the assertion.
   *
   * @return
   *   Message ID of the stored assertion.
   *
312 313
   * @see \Drupal\simpletest\TestBase::assert()
   * @see \Drupal\simpletest\TestBase::deleteAssert()
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337
   */
  public static function insertAssert($test_id, $test_class, $status, $message = '', $group = 'Other', array $caller = array()) {
    // Convert boolean status to string status.
    if (is_bool($status)) {
      $status = $status ? 'pass' : 'fail';
    }

    $caller += array(
      'function' => t('Unknown'),
      'line' => 0,
      'file' => t('Unknown'),
    );

    $assertion = array(
      'test_id' => $test_id,
      'test_class' => $test_class,
      'status' => $status,
      'message' => $message,
      'message_group' => $group,
      'function' => $caller['function'],
      'line' => $caller['line'],
      'file' => $caller['file'],
    );

338 339
    return self::getDatabaseConnection()
      ->insert('simpletest')
340 341 342 343 344 345 346 347 348
      ->fields($assertion)
      ->execute();
  }

  /**
   * Delete an assertion record by message ID.
   *
   * @param $message_id
   *   Message ID of the assertion to delete.
349
   *
350 351 352
   * @return
   *   TRUE if the assertion was deleted, FALSE otherwise.
   *
353
   * @see \Drupal\simpletest\TestBase::insertAssert()
354 355
   */
  public static function deleteAssert($message_id) {
356 357
    return (bool) self::getDatabaseConnection()
      ->delete('simpletest')
358 359 360 361
      ->condition('message_id', $message_id)
      ->execute();
  }

362 363 364
  /**
   * Returns the database connection to the site running Simpletest.
   *
365
   * @return \Drupal\Core\Database\Connection
366 367 368 369 370 371 372 373 374 375 376 377 378 379
   *   The database connection to use for inserting assertions.
   */
  public static function getDatabaseConnection() {
    try {
      $connection = Database::getConnection('default', 'simpletest_original_default');
    }
    catch (ConnectionNotDefinedException $e) {
      // If the test was not set up, the simpletest_original_default
      // connection does not exist.
      $connection = Database::getConnection('default', 'default');
    }
    return $connection;
  }

380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
  /**
   * Cycles through backtrace until the first non-assertion method is found.
   *
   * @return
   *   Array representing the true caller.
   */
  protected function getAssertionCall() {
    $backtrace = debug_backtrace();

    // The first element is the call. The second element is the caller.
    // We skip calls that occurred in one of the methods of our base classes
    // or in an assertion function.
   while (($caller = $backtrace[1]) &&
         ((isset($caller['class']) && isset($this->skipClasses[$caller['class']])) ||
           substr($caller['function'], 0, 6) == 'assert')) {
      // We remove that call.
      array_shift($backtrace);
    }

    return _drupal_get_last_caller($backtrace);
  }

  /**
403 404 405
   * Check to see if a value is not false.
   *
   * False values are: empty string, 0, NULL, and FALSE.
406 407 408 409
   *
   * @param $value
   *   The value on which the assertion is to be done.
   * @param $message
410 411 412
   *   (optional) A message to display with the assertion. Do not translate
   *   messages: use format_string() to embed variables in the message text, not
   *   t(). If left blank, a default message will be displayed.
413
   * @param $group
414 415 416 417
   *   (optional) The group this message is in, which is displayed in a column
   *   in test output. Use 'Debug' to indicate this is debugging output. Do not
   *   translate this string. Defaults to 'Other'; most tests do not override
   *   this default.
418
   *
419 420 421 422 423 424 425 426
   * @return
   *   TRUE if the assertion succeeded, FALSE otherwise.
   */
  protected function assertTrue($value, $message = '', $group = 'Other') {
    return $this->assert((bool) $value, $message ? $message : t('Value @value is TRUE.', array('@value' => var_export($value, TRUE))), $group);
  }

  /**
427 428 429
   * Check to see if a value is false.
   *
   * False values are: empty string, 0, NULL, and FALSE.
430 431 432 433
   *
   * @param $value
   *   The value on which the assertion is to be done.
   * @param $message
434 435 436
   *   (optional) A message to display with the assertion. Do not translate
   *   messages: use format_string() to embed variables in the message text, not
   *   t(). If left blank, a default message will be displayed.
437
   * @param $group
438 439 440 441
   *   (optional) The group this message is in, which is displayed in a column
   *   in test output. Use 'Debug' to indicate this is debugging output. Do not
   *   translate this string. Defaults to 'Other'; most tests do not override
   *   this default.
442
   *
443 444 445 446 447 448 449 450 451 452 453 454 455
   * @return
   *   TRUE if the assertion succeeded, FALSE otherwise.
   */
  protected function assertFalse($value, $message = '', $group = 'Other') {
    return $this->assert(!$value, $message ? $message : t('Value @value is FALSE.', array('@value' => var_export($value, TRUE))), $group);
  }

  /**
   * Check to see if a value is NULL.
   *
   * @param $value
   *   The value on which the assertion is to be done.
   * @param $message
456 457 458
   *   (optional) A message to display with the assertion. Do not translate
   *   messages: use format_string() to embed variables in the message text, not
   *   t(). If left blank, a default message will be displayed.
459
   * @param $group
460 461 462 463
   *   (optional) The group this message is in, which is displayed in a column
   *   in test output. Use 'Debug' to indicate this is debugging output. Do not
   *   translate this string. Defaults to 'Other'; most tests do not override
   *   this default.
464
   *
465 466 467 468 469 470 471 472 473 474 475 476 477
   * @return
   *   TRUE if the assertion succeeded, FALSE otherwise.
   */
  protected function assertNull($value, $message = '', $group = 'Other') {
    return $this->assert(!isset($value), $message ? $message : t('Value @value is NULL.', array('@value' => var_export($value, TRUE))), $group);
  }

  /**
   * Check to see if a value is not NULL.
   *
   * @param $value
   *   The value on which the assertion is to be done.
   * @param $message
478 479 480
   *   (optional) A message to display with the assertion. Do not translate
   *   messages: use format_string() to embed variables in the message text, not
   *   t(). If left blank, a default message will be displayed.
481
   * @param $group
482 483 484 485
   *   (optional) The group this message is in, which is displayed in a column
   *   in test output. Use 'Debug' to indicate this is debugging output. Do not
   *   translate this string. Defaults to 'Other'; most tests do not override
   *   this default.
486
   *
487 488 489 490 491 492 493 494 495 496 497 498 499 500 501
   * @return
   *   TRUE if the assertion succeeded, FALSE otherwise.
   */
  protected function assertNotNull($value, $message = '', $group = 'Other') {
    return $this->assert(isset($value), $message ? $message : t('Value @value is not NULL.', array('@value' => var_export($value, TRUE))), $group);
  }

  /**
   * Check to see if two values are equal.
   *
   * @param $first
   *   The first value to check.
   * @param $second
   *   The second value to check.
   * @param $message
502 503 504
   *   (optional) A message to display with the assertion. Do not translate
   *   messages: use format_string() to embed variables in the message text, not
   *   t(). If left blank, a default message will be displayed.
505
   * @param $group
506 507 508 509
   *   (optional) The group this message is in, which is displayed in a column
   *   in test output. Use 'Debug' to indicate this is debugging output. Do not
   *   translate this string. Defaults to 'Other'; most tests do not override
   *   this default.
510
   *
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525
   * @return
   *   TRUE if the assertion succeeded, FALSE otherwise.
   */
  protected function assertEqual($first, $second, $message = '', $group = 'Other') {
    return $this->assert($first == $second, $message ? $message : t('Value @first is equal to value @second.', array('@first' => var_export($first, TRUE), '@second' => var_export($second, TRUE))), $group);
  }

  /**
   * Check to see if two values are not equal.
   *
   * @param $first
   *   The first value to check.
   * @param $second
   *   The second value to check.
   * @param $message
526 527 528
   *   (optional) A message to display with the assertion. Do not translate
   *   messages: use format_string() to embed variables in the message text, not
   *   t(). If left blank, a default message will be displayed.
529
   * @param $group
530 531 532 533
   *   (optional) The group this message is in, which is displayed in a column
   *   in test output. Use 'Debug' to indicate this is debugging output. Do not
   *   translate this string. Defaults to 'Other'; most tests do not override
   *   this default.
534
   *
535 536 537 538 539 540 541 542 543 544 545 546 547 548 549
   * @return
   *   TRUE if the assertion succeeded, FALSE otherwise.
   */
  protected function assertNotEqual($first, $second, $message = '', $group = 'Other') {
    return $this->assert($first != $second, $message ? $message : t('Value @first is not equal to value @second.', array('@first' => var_export($first, TRUE), '@second' => var_export($second, TRUE))), $group);
  }

  /**
   * Check to see if two values are identical.
   *
   * @param $first
   *   The first value to check.
   * @param $second
   *   The second value to check.
   * @param $message
550 551 552
   *   (optional) A message to display with the assertion. Do not translate
   *   messages: use format_string() to embed variables in the message text, not
   *   t(). If left blank, a default message will be displayed.
553
   * @param $group
554 555 556 557
   *   (optional) The group this message is in, which is displayed in a column
   *   in test output. Use 'Debug' to indicate this is debugging output. Do not
   *   translate this string. Defaults to 'Other'; most tests do not override
   *   this default.
558
   *
559 560 561 562 563 564 565 566 567 568 569 570 571 572 573
   * @return
   *   TRUE if the assertion succeeded, FALSE otherwise.
   */
  protected function assertIdentical($first, $second, $message = '', $group = 'Other') {
    return $this->assert($first === $second, $message ? $message : t('Value @first is identical to value @second.', array('@first' => var_export($first, TRUE), '@second' => var_export($second, TRUE))), $group);
  }

  /**
   * Check to see if two values are not identical.
   *
   * @param $first
   *   The first value to check.
   * @param $second
   *   The second value to check.
   * @param $message
574 575 576
   *   (optional) A message to display with the assertion. Do not translate
   *   messages: use format_string() to embed variables in the message text, not
   *   t(). If left blank, a default message will be displayed.
577
   * @param $group
578 579 580 581
   *   (optional) The group this message is in, which is displayed in a column
   *   in test output. Use 'Debug' to indicate this is debugging output. Do not
   *   translate this string. Defaults to 'Other'; most tests do not override
   *   this default.
582
   *
583 584 585 586 587 588 589
   * @return
   *   TRUE if the assertion succeeded, FALSE otherwise.
   */
  protected function assertNotIdentical($first, $second, $message = '', $group = 'Other') {
    return $this->assert($first !== $second, $message ? $message : t('Value @first is not identical to value @second.', array('@first' => var_export($first, TRUE), '@second' => var_export($second, TRUE))), $group);
  }

590 591 592 593 594 595 596 597
  /**
   * Checks to see if two objects are identical.
   *
   * @param object $object1
   *   The first object to check.
   * @param object $object2
   *   The second object to check.
   * @param $message
598 599 600
   *   (optional) A message to display with the assertion. Do not translate
   *   messages: use format_string() to embed variables in the message text, not
   *   t(). If left blank, a default message will be displayed.
601
   * @param $group
602 603 604 605
   *   (optional) The group this message is in, which is displayed in a column
   *   in test output. Use 'Debug' to indicate this is debugging output. Do not
   *   translate this string. Defaults to 'Other'; most tests do not override
   *   this default.
606 607 608 609
   *
   * @return
   *   TRUE if the assertion succeeded, FALSE otherwise.
   */
610
  protected function assertIdenticalObject($object1, $object2, $message = '', $group = 'Other') {
611 612 613 614 615 616 617 618
    $message = $message ?: format_string('!object1 is identical to !object2', array(
      '!object1' => var_export($object1, TRUE),
      '!object2' => var_export($object2, TRUE),
    ));
    $identical = TRUE;
    foreach ($object1 as $key => $value) {
      $identical = $identical && isset($object2->$key) && $object2->$key === $value;
    }
619
    return $this->assertTrue($identical, $message, $group);
620 621 622 623
  }



624 625 626 627
  /**
   * Fire an assertion that is always positive.
   *
   * @param $message
628 629 630
   *   (optional) A message to display with the assertion. Do not translate
   *   messages: use format_string() to embed variables in the message text, not
   *   t(). If left blank, a default message will be displayed.
631
   * @param $group
632 633 634 635
   *   (optional) The group this message is in, which is displayed in a column
   *   in test output. Use 'Debug' to indicate this is debugging output. Do not
   *   translate this string. Defaults to 'Other'; most tests do not override
   *   this default.
636
   *
637 638 639 640 641 642 643 644 645 646 647
   * @return
   *   TRUE.
   */
  protected function pass($message = NULL, $group = 'Other') {
    return $this->assert(TRUE, $message, $group);
  }

  /**
   * Fire an assertion that is always negative.
   *
   * @param $message
648 649 650
   *   (optional) A message to display with the assertion. Do not translate
   *   messages: use format_string() to embed variables in the message text, not
   *   t(). If left blank, a default message will be displayed.
651
   * @param $group
652 653 654 655
   *   (optional) The group this message is in, which is displayed in a column
   *   in test output. Use 'Debug' to indicate this is debugging output. Do not
   *   translate this string. Defaults to 'Other'; most tests do not override
   *   this default.
656
   *
657 658 659 660 661 662 663 664 665 666 667
   * @return
   *   FALSE.
   */
  protected function fail($message = NULL, $group = 'Other') {
    return $this->assert(FALSE, $message, $group);
  }

  /**
   * Fire an error assertion.
   *
   * @param $message
668 669 670
   *   (optional) A message to display with the assertion. Do not translate
   *   messages: use format_string() to embed variables in the message text, not
   *   t(). If left blank, a default message will be displayed.
671
   * @param $group
672 673 674 675
   *   (optional) The group this message is in, which is displayed in a column
   *   in test output. Use 'Debug' to indicate this is debugging output. Do not
   *   translate this string. Defaults to 'Other'; most tests do not override
   *   this default.
676 677
   * @param $caller
   *   The caller of the error.
678
   *
679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703
   * @return
   *   FALSE.
   */
  protected function error($message = '', $group = 'Other', array $caller = NULL) {
    if ($group == 'User notice') {
      // Since 'User notice' is set by trigger_error() which is used for debug
      // set the message to a status of 'debug'.
      return $this->assert('debug', $message, 'Debug', $caller);
    }

    return $this->assert('exception', $message, $group, $caller);
  }

  /**
   * Logs verbose message in a text file.
   *
   * The a link to the vebose message will be placed in the test results via
   * as a passing assertion with the text '[verbose message]'.
   *
   * @param $message
   *   The verbose message to be stored.
   *
   * @see simpletest_verbose()
   */
  protected function verbose($message) {
704 705 706 707 708 709 710 711
    // Do nothing if verbose debugging is disabled.
    if (!$this->verbose) {
      return;
    }

    $message = '<hr />ID #' . $this->verboseId . ' (<a href="' . $this->verboseClassName . '-' . ($this->verboseId - 1) . '.html">Previous</a> | <a href="' . $this->verboseClassName . '-' . ($this->verboseId + 1) . '.html">Next</a>)<hr />' . $message;
    $verbose_filename = $this->verboseDirectory . '/' . $this->verboseClassName . '-' . $this->verboseId . '.html';
    if (file_put_contents($verbose_filename, $message, FILE_APPEND)) {
712
      $url = $this->verboseDirectoryUrl . '/' . $this->verboseClassName . '-' . $this->verboseId . '.html';
713 714 715 716
      // Not using l() to avoid invoking the theme system, so that unit tests
      // can use verbose() as well.
      $url = '<a href="' . $url . '" target="_blank">' . t('Verbose message') . '</a>';
      $this->error($url, 'User notice');
717
    }
718
    $this->verboseId++;
719 720 721 722 723 724 725 726 727 728 729 730 731 732 733
  }

  /**
   * Run all tests in this class.
   *
   * Regardless of whether $methods are passed or not, only method names
   * starting with "test" are executed.
   *
   * @param $methods
   *   (optional) A list of method names in the test case class to run; e.g.,
   *   array('testFoo', 'testBar'). By default, all methods of the class are
   *   taken into account, but it can be useful to only run a few selected test
   *   methods during debugging.
   */
  public function run(array $methods = array()) {
734
    TestServiceProvider::$currentTest = $this;
735
    $simpletest_config = \Drupal::config('simpletest.settings');
736

737
    $class = get_class($this);
738
    if ($simpletest_config->get('verbose')) {
739 740
      // Initialize verbose debugging.
      $this->verbose = TRUE;
741
      $this->verboseDirectory = PublicStream::basePath() . '/simpletest/verbose';
742
      $this->verboseDirectoryUrl = file_create_url($this->verboseDirectory);
743 744 745 746 747
      if (file_prepare_directory($this->verboseDirectory, FILE_CREATE_DIRECTORY) && !file_exists($this->verboseDirectory . '/.htaccess')) {
        file_put_contents($this->verboseDirectory . '/.htaccess', "<IfModule mod_expires.c>\nExpiresActive Off\n</IfModule>\n");
      }
      $this->verboseClassName = str_replace("\\", "_", $class);
    }
748 749
    // HTTP auth settings (<username>:<password>) for the simpletest browser
    // when sending requests to the test site.
750 751 752 753
    $this->httpauth_method = (int) $simpletest_config->get('httpauth.method');
    $username = $simpletest_config->get('httpauth.username');
    $password = $simpletest_config->get('httpauth.password');
    if (!empty($username) && !empty($password)) {
754 755 756 757 758 759 760 761 762 763 764 765
      $this->httpauth_credentials = $username . ':' . $password;
    }

    set_error_handler(array($this, 'errorHandler'));
    // Iterate through all the methods in this class, unless a specific list of
    // methods to run was passed.
    $class_methods = get_class_methods($class);
    if ($methods) {
      $class_methods = array_intersect($class_methods, $methods);
    }
    $missing_requirements = $this->checkRequirements();
    if (!empty($missing_requirements)) {
766
      $missing_requirements_object = new \ReflectionObject($this);
767 768 769 770 771 772 773 774
      $caller = array(
        'file' => $missing_requirements_object->getFileName(),
      );
      foreach ($missing_requirements as $missing_requirement) {
        TestBase::insertAssert($this->testId, $class, FALSE, $missing_requirement, 'Requirements check.', $caller);
      }
    }
    else {
775 776 777
      if (defined("$class::SORT_METHODS")) {
        sort($class_methods);
      }
778 779 780 781 782
      foreach ($class_methods as $method) {
        // If the current method starts with "test", run it - it's a test.
        if (strtolower(substr($method, 0, 4)) == 'test') {
          // Insert a fail record. This will be deleted on completion to ensure
          // that testing completed.
783
          $method_info = new \ReflectionMethod($class, $method);
784 785 786 787 788 789 790 791 792 793 794 795
          $caller = array(
            'file' => $method_info->getFileName(),
            'line' => $method_info->getStartLine(),
            'function' => $class . '->' . $method . '()',
          );
          $completion_check_id = TestBase::insertAssert($this->testId, $class, FALSE, t('The test did not complete due to a fatal error.'), 'Completion check', $caller);
          $this->setUp();
          if ($this->setup) {
            try {
              $this->$method();
              // Finish up.
            }
796
            catch (\Exception $e) {
797 798 799 800 801 802 803 804 805 806 807 808
              $this->exceptionHandler($e);
            }
            $this->tearDown();
          }
          else {
            $this->fail(t("The test cannot be executed because it has not been set up properly."));
          }
          // Remove the completion check record.
          TestBase::deleteAssert($completion_check_id);
        }
      }
    }
809
    TestServiceProvider::$currentTest = NULL;
810 811 812 813 814
    // Clear out the error messages and restore error handler.
    drupal_get_messages();
    restore_error_handler();
  }

815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856
  /**
   * Generates a database prefix for running tests.
   *
   * The database prefix is used by prepareEnvironment() to setup a public files
   * directory for the test to be run, which also contains the PHP error log,
   * which is written to in case of a fatal error. Since that directory is based
   * on the database prefix, all tests (even unit tests) need to have one, in
   * order to access and read the error log.
   *
   * @see TestBase::prepareEnvironment()
   *
   * The generated database table prefix is used for the Drupal installation
   * being performed for the test. It is also used as user agent HTTP header
   * value by the cURL-based browser of DrupalWebTestCase, which is sent to the
   * Drupal installation of the test. During early Drupal bootstrap, the user
   * agent HTTP header is parsed, and if it matches, all database queries use
   * the database table prefix that has been generated here.
   *
   * @see WebTestBase::curlInitialize()
   * @see drupal_valid_test_ua()
   * @see WebTestBase::setUp()
   */
  protected function prepareDatabasePrefix() {
    $this->databasePrefix = 'simpletest' . mt_rand(1000, 1000000);

    // As soon as the database prefix is set, the test might start to execute.
    // All assertions as well as the SimpleTest batch operations are associated
    // with the testId, so the database prefix has to be associated with it.
    db_update('simpletest_test_id')
      ->fields(array('last_prefix' => $this->databasePrefix))
      ->condition('test_id', $this->testId)
      ->execute();
  }

  /**
   * Changes the database connection to the prefixed one.
   *
   * @see WebTestBase::setUp()
   */
  protected function changeDatabasePrefix() {
    if (empty($this->databasePrefix)) {
      $this->prepareDatabasePrefix();
857 858 859 860 861 862
      // If $this->prepareDatabasePrefix() failed to work, return without
      // setting $this->setupDatabasePrefix to TRUE, so setUp() methods will
      // know to bail out.
      if (empty($this->databasePrefix)) {
        return;
      }
863 864 865 866 867 868 869 870 871 872 873
    }

    // Clone the current connection and replace the current prefix.
    $connection_info = Database::getConnectionInfo('default');
    Database::renameConnection('default', 'simpletest_original_default');
    foreach ($connection_info as $target => $value) {
      $connection_info[$target]['prefix'] = array(
        'default' => $value['prefix']['default'] . $this->databasePrefix,
      );
    }
    Database::addConnectionInfo('default', 'default', $connection_info['default']);
874

875 876 877 878 879 880 881 882
    // Additionally override global $databases, since the installer does not use
    // the Database connection info.
    // @see install_verify_database_settings()
    // @see install_database_errors()
    // @todo Fix installer to use Database connection info.
    global $databases;
    $databases['default']['default'] = $connection_info['default'];

883 884
    // Indicate the database prefix was set up correctly.
    $this->setupDatabasePrefix = TRUE;
885 886 887 888 889 890 891 892 893 894 895 896 897 898 899
  }

  /**
   * Prepares the current environment for running the test.
   *
   * Backups various current environment variables and resets them, so they do
   * not interfere with the Drupal site installation in which tests are executed
   * and can be restored in TestBase::tearDown().
   *
   * Also sets up new resources for the testing environment, such as the public
   * filesystem and configuration directories.
   *
   * @see TestBase::tearDown()
   */
  protected function prepareEnvironment() {
900
    global $user, $conf;
901
    $language_interface = language(Language::TYPE_INTERFACE);
902

903 904 905 906 907 908 909
    // When running the test runner within a test, back up the original database
    // prefix and re-set the new/nested prefix in drupal_valid_test_ua().
    if (drupal_valid_test_ua()) {
      $this->originalPrefix = drupal_valid_test_ua();
      drupal_valid_test_ua($this->databasePrefix);
    }

910
    // Backup current in-memory configuration.
911
    $this->originalSettings = settings()->getAll();
912 913 914
    $this->originalConf = $conf;

    // Backup statics and globals.
915
    $this->originalContainer = clone \Drupal::getContainer();
916
    $this->originalLanguage = $language_interface;
917
    $this->originalConfigDirectories = $GLOBALS['config_directories'];
918 919 920
    if (isset($GLOBALS['theme_key'])) {
      $this->originalThemeKey = $GLOBALS['theme_key'];
    }
921
    $this->originalTheme = isset($GLOBALS['theme']) ? $GLOBALS['theme'] : NULL;
922 923

    // Save further contextual information.
924 925 926
    // Use the original files directory to avoid nesting it within an existing
    // simpletest directory if a test is executed within a test.
    $this->originalFileDirectory = settings()->get('file_public_path', conf_path() . '/files');
927
    $this->originalProfile = drupal_get_profile();
928
    $this->originalUser = isset($user) ? clone $user : NULL;
929 930

    // Ensure that the current session is not changed by the new environment.
931
    require_once DRUPAL_ROOT . '/' . settings()->get('session_inc', 'core/includes/session.inc');
932
    drupal_save_session(FALSE);
933 934 935
    // Run all tests as a anonymous user by default, web tests will replace that
    // during the test set up.
    $user = drupal_anonymous_user();
936 937 938 939 940 941 942 943 944 945 946 947 948 949 950

    // Save and clean the shutdown callbacks array because it is static cached
    // and will be changed by the test run. Otherwise it will contain callbacks
    // from both environments and the testing environment will try to call the
    // handlers defined by the original one.
    $callbacks = &drupal_register_shutdown_function();
    $this->originalShutdownCallbacks = $callbacks;
    $callbacks = array();

    // Create test directory ahead of installation so fatal errors and debug
    // information can be logged during installation process.
    // Use temporary files directory with the same prefix as the database.
    $this->public_files_directory = $this->originalFileDirectory . '/simpletest/' . substr($this->databasePrefix, 10);
    $this->private_files_directory = $this->public_files_directory . '/private';
    $this->temp_files_directory = $this->private_files_directory . '/temp';
951
    $this->translation_files_directory = $this->public_files_directory . '/translations';
952 953 954 955 956

    // Create the directories
    file_prepare_directory($this->public_files_directory, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS);
    file_prepare_directory($this->private_files_directory, FILE_CREATE_DIRECTORY);
    file_prepare_directory($this->temp_files_directory, FILE_CREATE_DIRECTORY);
957
    file_prepare_directory($this->translation_files_directory, FILE_CREATE_DIRECTORY);
958 959
    $this->generatedTestFiles = FALSE;

960 961
    // Create and set new configuration directories.
    $this->prepareConfigDirectories();
962

963 964 965 966 967
    // Reset statics before the old container is replaced so that objects with a
    // __destruct() method still have access to it.
    // @todo: Remove once they have been converted to services.
    drupal_static_reset();

968
    // Reset and create a new service container.
969
    $this->container = new ContainerBuilder();
970 971 972
     // @todo Remove this once this class has no calls to t() and format_plural()
    $this->container->register('string_translation', 'Drupal\Core\StringTranslation\TranslationManager');

973 974 975
    // Register info parser.
    $this->container->register('info_parser', 'Drupal\Core\Extension\InfoParser');

976
    \Drupal::setContainer($this->container);
977

978 979 980 981
    // Unset globals.
    unset($GLOBALS['theme_key']);
    unset($GLOBALS['theme']);

982 983 984 985 986 987 988 989
    // Log fatal errors.
    ini_set('log_errors', 1);
    ini_set('error_log', $this->public_files_directory . '/error.log');

    // Set the test information for use in other parts of Drupal.
    $test_info = &$GLOBALS['drupal_test_info'];
    $test_info['test_run_id'] = $this->databasePrefix;
    $test_info['in_child_site'] = FALSE;
990 991 992

    // Indicate the environment was set up correctly.
    $this->setupEnvironment = TRUE;
993 994
  }

995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
  /**
   * Create and set new configuration directories.
   *
   * The child site uses drupal_valid_test_ua() to adjust the config directory
   * paths to a test-prefix-specific directory within the public files
   * directory.
   *
   * @see config_get_config_directory()
   */
  protected function prepareConfigDirectories() {
    $GLOBALS['config_directories'] = array();
    $this->configDirectories = array();
    include_once DRUPAL_ROOT . '/core/includes/install.inc';
    foreach (array(CONFIG_ACTIVE_DIRECTORY, CONFIG_STAGING_DIRECTORY) as $type) {
      // Assign the relative path to the global variable.
      $path = 'simpletest/' . substr($this->databasePrefix, 10) . '/config_' . $type;
      $GLOBALS['config_directories'][$type]['path'] = $path;
      // Ensure the directory can be created and is writeable.
      if (!install_ensure_config_directory($type)) {
        return FALSE;
      }
      // Provide the already resolved path for tests.
      $this->configDirectories[$type] = $this->originalFileDirectory . '/' . $path;
    }
  }

1021
  /**
1022
   * Rebuild \Drupal::getContainer().
1023
   *
1024 1025 1026 1027 1028
   * Use this to build a new kernel and service container. For example, when the
   * list of enabled modules is changed via the internal browser, in which case
   * the test process still contains an old kernel and service container with an
   * old module list.
   *
1029 1030 1031
   * @see TestBase::prepareEnvironment()
   * @see TestBase::tearDown()
   *
1032
   * @todo Fix http://drupal.org/node/1708692 so that module enable/disable
1033
   *   changes are immediately reflected in \Drupal::getContainer(). Until then,
1034 1035 1036 1037
   *   tests can invoke this workaround when requiring services from newly
   *   enabled modules to be immediately available in the same request.
   */
  protected function rebuildContainer() {
1038
    $this->kernel = new DrupalKernel('testing', drupal_classloader(), FALSE);
1039
    $this->kernel->boot();
1040
    // DrupalKernel replaces the container in \Drupal::getContainer() with a
1041
    // different object, so we need to replace the instance on this test class.
1042 1043 1044
    $this->container = \Drupal::getContainer();
    // The global $user is set in TestBase::prepareEnvironment().
    $this->container->get('request')->attributes->set('_account', $GLOBALS['user']);
1045 1046
  }

1047
  /**
1048 1049
   * Performs cleanup tasks after each individual test method has been run.
   *
1050
   * Deletes created files, database tables, and reverts environment changes.
1051 1052 1053 1054 1055 1056 1057 1058
   *
   * This method needs to be invoked for both unit and integration tests.
   *
   * @see TestBase::prepareDatabasePrefix()
   * @see TestBase::changeDatabasePrefix()
   * @see TestBase::prepareEnvironment()
   */
  protected function tearDown() {
1059
    global $user, $conf;
1060 1061 1062 1063 1064 1065 1066 1067

    // Reset all static variables.
    // Unsetting static variables will potentially invoke destruct methods,
    // which might call into functions that prime statics and caches again.
    // In that case, all functions are still operating on the test environment,
    // which means they may need to access its filesystem and database.
    drupal_static_reset();

1068 1069 1070 1071 1072 1073 1074 1075 1076
    if ($this->container->has('state') && $state = $this->container->get('state')) {
      $captured_emails = $state->get('system.test_email_collector') ?: array();
      $emailCount = count($captured_emails);
      if ($emailCount) {
        $message = format_plural($emailCount, '1 e-mail was sent during this test.', '@count e-mails were sent during this test.');
        $this->pass($message, t('E-mail'));
      }
    }

1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093
    // Ensure that TestBase::changeDatabasePrefix() has run and TestBase::$setup
    // was not tricked into TRUE, since the following code would delete the
    // entire parent site otherwise.
    if ($this->setupDatabasePrefix) {
      // Remove all prefixed tables.
      $connection_info = Database::getConnectionInfo('default');
      $tables = db_find_tables($connection_info['default']['prefix']['default'] . '%');
      $prefix_length = strlen($connection_info['default']['prefix']['default']);
      foreach ($tables as $table) {
        if (db_drop_table(substr($table, $prefix_length))) {
          unset($tables[$table]);
        }
      }
      if (!empty($tables)) {
        $this->fail('Failed to drop all prefixed tables.');
      }
    }
1094 1095 1096 1097 1098 1099

    // In case a fatal error occurred that was not in the test process read the
    // log to pick up any fatal errors.
    simpletest_log_read($this->testId, $this->databasePrefix, get_class($this), TRUE);

    // Delete temporary files directory.
1100
    file_unmanaged_delete_recursive($this->originalFileDirectory . '/simpletest/' . substr($this->databasePrefix, 10), array($this, 'filePreDeleteCallback'));
1101 1102 1103 1104

    // Restore original database connection.
    Database::removeConnection('default');
    Database::renameConnection('simpletest_original_default', 'default');
1105 1106 1107 1108
    // @see TestBase::changeDatabasePrefix()
    global $databases;
    $connection_info = Database::getConnectionInfo('default');
    $databases['default']['default'] = $connection_info['default'];
1109

1110
    // Restore original globals.
1111 1112 1113
    if (isset($this->originalThemeKey)) {
      $GLOBALS['theme_key'] = $this->originalThemeKey;
    }
1114 1115
    $GLOBALS['theme'] = $this->originalTheme;

1116
    // Reset all static variables.
1117 1118
    // All destructors of statically cached objects have been invoked above;
    // this second reset is guranteed to reset everything to nothing.
1119 1120 1121 1122
    drupal_static_reset();

    // Restore original in-memory configuration.
    $conf = $this->originalConf;
1123
    new Settings($this->originalSettings);
1124 1125

    // Restore original statics and globals.
1126
    \Drupal::setContainer($this->originalContainer);
1127
    $GLOBALS['config_directories'] = $this->originalConfigDirectories;
1128 1129 1130
    if (isset($this->originalPrefix)) {
      drupal_valid_test_ua($this->originalPrefix);
    }
1131 1132 1133 1134 1135 1136 1137 1138 1139 1140

    // Restore original shutdown callbacks.
    $callbacks = &drupal_register_shutdown_function();
    $callbacks = $this->originalShutdownCallbacks;

    // Restore original user session.
    $user = $this->originalUser;
    drupal_save_session(TRUE);
  }

1141 1142 1143 1144
  /**
   * Handle errors during test runs.
   *
   * Because this is registered in set_error_handler(), it has to be public.
1145
   *
1146 1147 1148 1149
   * @see set_error_handler
   */
  public function errorHandler($severity, $message, $file = NULL, $line = NULL) {
    if ($severity & error_reporting()) {
1150
      require_once DRUPAL_ROOT . '/core/includes/errors.inc';
1151 1152 1153 1154 1155 1156 1157 1158 1159 1160
      $error_map = array(
        E_STRICT => 'Run-time notice',
        E_WARNING => 'Warning',
        E_NOTICE => 'Notice',
        E_CORE_ERROR => 'Core error',
        E_CORE_WARNING => 'Core warning',
        E_USER_ERROR => 'User error',
        E_USER_WARNING => 'User warning',
        E_USER_NOTICE => 'User notice',
        E_RECOVERABLE_ERROR => 'Recoverable error',
1161 1162
        E_DEPRECATED => 'Deprecated',
        E_USER_DEPRECATED => 'User deprecated',
1163 1164 1165
      );

      $backtrace = debug_backtrace();
1166 1167 1168 1169 1170 1171 1172 1173

      // Add verbose backtrace for errors, but not for debug() messages.
      if ($severity !== E_USER_NOTICE) {
        $verbose_backtrace = $backtrace;
        array_shift($verbose_backtrace);
        $message .= '<pre class="backtrace">' . format_backtrace($verbose_backtrace) . '</pre>';
      }

1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184
      $this->error($message, $error_map[$severity], _drupal_get_last_caller($backtrace));
    }
    return TRUE;
  }

  /**
   * Handle exceptions.
   *
   * @see set_exception_handler
   */
  protected function exceptionHandler($exception) {
1185
    require_once DRUPAL_ROOT . '/core/includes/errors.inc';
1186
    $backtrace = $exception->getTrace();
1187
    $verbose_backtrace = $backtrace;
1188 1189 1190 1191 1192
    // Push on top of the backtrace the call that generated the exception.
    array_unshift($backtrace, array(
      'line' => $exception->getLine(),
      'file' => $exception->getFile(),
    ));
1193 1194
    // The exception message is run through check_plain()
    // by _drupal_decode_exception().
1195 1196 1197
    $decoded_exception = _drupal_decode_exception($exception);
    unset($decoded_exception['backtrace']);
    $message = format_string('%type: !message in %function (line %line of %file). <pre class="backtrace">!backtrace</pre>', $decoded_exception + array(
1198 1199 1200
      '!backtrace' => format_backtrace($verbose_backtrace),
    ));
    $this->error($message, 'Uncaught exception', _drupal_get_last_caller($backtrace));
1201 1202
  }

1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218
  /**
   * Changes in memory settings.
   *
   * @param $name
   *   The name of the setting to return.
   * @param $value
   *   The value of the setting.
   *
   * @see \Drupal\Component\Utility\Settings::get()
   */
  protected function settingsSet($name, $value) {
    $settings = settings()->getAll();
    $settings[$name] = $value;
    new Settings($settings);
  }

1219
  /**
1220
   * Generates a unique random string of ASCII characters of codes 32 to 126.
1221
   *
1222 1223
   * Do not use this method when special characters are not possible (e.g., in
   * machine or file names that have already been validated); instead, use
1224
   * \Drupal\simpletest\TestBase::randomName().
1225
   *
1226
   * @param int $length
1227
   *   Length of random string to generate.
1228
   *
1229 1230
   * @return string
   *   Randomly generated unique string.
1231
   *
1232
   * @see \Drupal\Component\Utility\Random::string()
1233
   */
1234
  public function randomString($length = 8) {
1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266
    return $this->getRandomGenerator()->string($length, TRUE, array($this, 'randomStringValidate'));
  }

  /**
   * Callback for random string validation.
   *
   * @see \Drupal\Component\Utility\Random::string()
   *
   * @param string $string
   *   The random string to validate.
   *
   * @return bool
   *   TRUE if the random string is valid, FALSE if not.
   */
  public function randomStringValidate($string) {
    // Consecutive spaces causes issues for
    // Drupal\simpletest\WebTestBase::assertLink().
    if (preg_match('/\s{2,}/', $string)) {
      return FALSE;
    }

    // Starting with a space means that length might not be what is expected.
    if (preg_match('/^\s/', $string)) {
      return FALSE;
    }

    // Ending with a space means that length might not be what is expected.
    if (preg_match('/\s$/', $string)) {
      return FALSE;
    }

    return TRUE;
1267 1268 1269
  }

  /**
1270
   * Generates a unique random string containing letters and numbers.
1271
   *
1272
   * Do not use this method when testing unvalidated user input. Instead, use
1273
   * \Drupal\simpletest\TestBase::randomString().
1274
   *
1275
   * @param int $length
1276
   *   Length of random string to generate.
1277
   *
1278 1279
   * @return string
   *   Randomly generated unique string.
1280
   *
1281
   * @see \Drupal\Component\Utility\Random::name()
1282
   */
1283
  public function randomName($length = 8) {
1284
    return $this->getRandomGenerator()->name($length, TRUE);
1285 1286
  }

1287 1288 1289 1290 1291 1292 1293 1294 1295
  /**
   * Generates a random PHP object.
   *
   * @param int $size
   *   The number of random keys to add to the object.
   *
   * @return \stdClass
   *   The generated object, with the specified number of random keys. Each key
   *   has a random string value.
1296 1297
   *
   * @see \Drupal\Component\Utility\Random::object()
1298
   */
1299
  public function randomObject($size = 4) {
1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313
    return $this->getRandomGenerator()->object($size);
  }

  /**
   * Gets the random generator for the utility methods.
   *
   * @return \Drupal\Component\Utility\Random
   *   The random generator
   */
  protected function getRandomGenerator() {
    if (!is_object($this->randomGenerator)) {
      $this->randomGenerator = new Random();
    }
    return $this->randomGenerator;
1314 1315
  }

1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327
  /**
   * Converts a list of possible parameters into a stack of permutations.
   *
   * Takes a list of parameters containing possible values, and converts all of
   * them into a list of items containing every possible permutation.
   *
   * Example:
   * @code
   * $parameters = array(
   *   'one' => array(0, 1),
   *   'two' => array(2, 3),
   * );
1328
   * $permutations = TestBase::generatePermutations($parameters);
1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363
   * // Result:
   * $permutations == array(
   *   array('one' => 0, 'two' => 2),
   *   array('one' => 1, 'two' => 2),
   *   array('one' => 0, 'two' => 3),
   *   array('one' => 1, 'two' => 3),
   * )
   * @endcode
   *
   * @param $parameters
   *   An associative array of parameters, keyed by parameter name, and whose
   *   values are arrays of parameter values.
   *
   * @return
   *   A list of permutations, which is an array of arrays. Each inner array
   *   contains the full list of parameters that have been passed, but with a
   *   single value only.
   */
  public