TestBase.php 50.2 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
use Symfony\Component\HttpFoundation\Request;
22 23 24 25

/**
 * Base class for Drupal tests.
 *
26 27
 * Do not extend this class directly, use either
 * \Drupal\simpletest\WebTestBaseBase or \Drupal\simpletest\UnitTestBaseBase.
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 96
 */
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;

97 98 99 100
  protected $setupDatabasePrefix = FALSE;

  protected $setupEnvironment = FALSE;

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 130
  /**
   * 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;

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

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

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

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

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

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

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

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

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

199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
  /**
   * 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();

223 224 225 226 227 228 229 230 231 232 233 234 235 236
  /**
   * 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
237
   *   Can be 'pass', 'fail', 'exception', 'debug'.
238 239
   *   TRUE is a synonym for 'pass', FALSE for 'fail'.
   * @param $message
240 241 242
   *   (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.
243
   * @param $group
244 245 246 247
   *   (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.
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 281
   * @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.
282
    self::getDatabaseConnection()
283 284 285 286 287 288 289 290 291 292
      ->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 {
293
      if ($this->dieOnFail && ($status == 'fail' || $status == 'exception')) {
294 295
        exit(1);
      }
296 297 298 299 300 301 302 303 304 305 306
      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
307
   * the method behaves just like \Drupal\simpletest\TestBase::assert() in terms
308 309 310 311 312
   * of storing the assertion.
   *
   * @return
   *   Message ID of the stored assertion.
   *
313 314
   * @see \Drupal\simpletest\TestBase::assert()
   * @see \Drupal\simpletest\TestBase::deleteAssert()
315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338
   */
  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'],
    );

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

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

363 364 365
  /**
   * Returns the database connection to the site running Simpletest.
   *
366
   * @return \Drupal\Core\Database\Connection
367 368 369 370 371 372 373 374 375 376 377 378 379 380
   *   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;
  }

381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403
  /**
   * 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);
  }

  /**
404 405 406
   * Check to see if a value is not false.
   *
   * False values are: empty string, 0, NULL, and FALSE.
407 408 409 410
   *
   * @param $value
   *   The value on which the assertion is to be done.
   * @param $message
411 412 413
   *   (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.
414
   * @param $group
415 416 417 418
   *   (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.
419
   *
420 421 422 423 424 425 426 427
   * @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);
  }

  /**
428 429 430
   * Check to see if a value is false.
   *
   * False values are: empty string, 0, NULL, and FALSE.
431 432 433 434
   *
   * @param $value
   *   The value on which the assertion is to be done.
   * @param $message
435 436 437
   *   (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.
438
   * @param $group
439 440 441 442
   *   (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.
443
   *
444 445 446 447 448 449 450 451 452 453 454 455 456
   * @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
457 458 459
   *   (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.
460
   * @param $group
461 462 463 464
   *   (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.
465
   *
466 467 468 469 470 471 472 473 474 475 476 477 478
   * @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
479 480 481
   *   (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.
482
   * @param $group
483 484 485 486
   *   (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.
487
   *
488 489 490 491 492 493 494 495 496 497 498 499 500 501 502
   * @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
503 504 505
   *   (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.
506
   * @param $group
507 508 509 510
   *   (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.
511
   *
512 513 514 515 516 517 518 519 520 521 522 523 524 525 526
   * @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
527 528 529
   *   (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.
530
   * @param $group
531 532 533 534
   *   (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.
535
   *
536 537 538 539 540 541 542 543 544 545 546 547 548 549 550
   * @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
551 552 553
   *   (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.
554
   * @param $group
555 556 557 558
   *   (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.
559
   *
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574
   * @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
575 576 577
   *   (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.
578
   * @param $group
579 580 581 582
   *   (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.
583
   *
584 585 586 587 588 589 590
   * @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);
  }

591 592 593 594 595 596 597 598
  /**
   * 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
599 600 601
   *   (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.
602
   * @param $group
603 604 605 606
   *   (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.
607 608 609 610
   *
   * @return
   *   TRUE if the assertion succeeded, FALSE otherwise.
   */
611
  protected function assertIdenticalObject($object1, $object2, $message = '', $group = 'Other') {
612 613 614 615 616 617 618 619
    $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;
    }
620
    return $this->assertTrue($identical, $message, $group);
621 622 623 624
  }



625 626 627 628
  /**
   * Fire an assertion that is always positive.
   *
   * @param $message
629 630 631
   *   (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.
632
   * @param $group
633 634 635 636
   *   (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.
637
   *
638 639 640 641 642 643 644 645 646 647 648
   * @return
   *   TRUE.
   */
  protected function pass($message = NULL, $group = 'Other') {
    return $this->assert(TRUE, $message, $group);
  }

  /**
   * Fire an assertion that is always negative.
   *
   * @param $message
649 650 651
   *   (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.
652
   * @param $group
653 654 655 656
   *   (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.
657
   *
658 659 660 661 662 663 664 665 666 667 668
   * @return
   *   FALSE.
   */
  protected function fail($message = NULL, $group = 'Other') {
    return $this->assert(FALSE, $message, $group);
  }

  /**
   * Fire an error assertion.
   *
   * @param $message
669 670 671
   *   (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.
672
   * @param $group
673 674 675 676
   *   (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.
677 678
   * @param $caller
   *   The caller of the error.
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 704
   * @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) {
705 706 707 708 709 710 711 712
    // 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)) {
713
      $url = $this->verboseDirectoryUrl . '/' . $this->verboseClassName . '-' . $this->verboseId . '.html';
714 715 716 717
      // 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');
718
    }
719
    $this->verboseId++;
720 721 722 723 724 725 726 727 728 729 730 731 732 733 734
  }

  /**
   * 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()) {
735
    TestServiceProvider::$currentTest = $this;
736
    $simpletest_config = \Drupal::config('simpletest.settings');
737

738
    $class = get_class($this);
739
    if ($simpletest_config->get('verbose')) {
740 741
      // Initialize verbose debugging.
      $this->verbose = TRUE;
742
      $this->verboseDirectory = PublicStream::basePath() . '/simpletest/verbose';
743
      $this->verboseDirectoryUrl = file_create_url($this->verboseDirectory);
744 745 746 747 748
      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);
    }
749 750
    // HTTP auth settings (<username>:<password>) for the simpletest browser
    // when sending requests to the test site.
751 752 753 754
    $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)) {
755 756 757 758 759 760 761 762 763 764 765 766
      $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)) {
767
      $missing_requirements_object = new \ReflectionObject($this);
768 769 770 771 772 773 774 775
      $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 {
776 777 778
      if (defined("$class::SORT_METHODS")) {
        sort($class_methods);
      }
779 780 781 782 783
      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.
784
          $method_info = new \ReflectionMethod($class, $method);
785 786 787 788 789 790 791 792 793 794 795 796
          $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.
            }
797
            catch (\Exception $e) {
798 799 800 801 802 803 804 805 806 807 808 809
              $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);
        }
      }
    }
810
    TestServiceProvider::$currentTest = NULL;
811 812 813 814 815
    // Clear out the error messages and restore error handler.
    drupal_get_messages();
    restore_error_handler();
  }

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 857
  /**
   * 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();
858 859 860 861 862 863
      // 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;
      }
864 865 866 867 868 869 870 871 872 873 874
    }

    // 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']);
875

876 877 878 879 880 881 882 883
    // 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'];

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

  /**
   * 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() {
901
    global $user, $conf;
902
    $language_interface = language(Language::TYPE_INTERFACE);
903

904 905 906 907 908 909 910
    // 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);
    }

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

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

    // Save further contextual information.
925 926 927
    // 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');
928
    $this->originalProfile = drupal_get_profile();
929
    $this->originalUser = isset($user) ? clone $user : NULL;
930 931

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

    // 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';
952
    $this->translation_files_directory = $this->public_files_directory . '/translations';
953 954 955 956 957

    // 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);
958
    file_prepare_directory($this->translation_files_directory, FILE_CREATE_DIRECTORY);
959 960
    $this->generatedTestFiles = FALSE;

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

964 965 966 967 968
    // 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();

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

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

977 978 979 980
    $request = Request::create('/');
    $this->container->set('request', $request);
    $this->container->set('current_user', $GLOBALS['user']);

981
    \Drupal::setContainer($this->container);
982

983 984 985 986
    // Unset globals.
    unset($GLOBALS['theme_key']);
    unset($GLOBALS['theme']);

987 988 989 990 991 992 993 994
    // 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;
995 996 997

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

1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025
  /**
   * 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;
    }
  }

1026
  /**
1027
   * Rebuild \Drupal::getContainer().
1028
   *
1029 1030 1031 1032 1033
   * 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.
   *
1034 1035 1036
   * @see TestBase::prepareEnvironment()
   * @see TestBase::tearDown()
   *
1037
   * @todo Fix http://drupal.org/node/1708692 so that module enable/disable
1038
   *   changes are immediately reflected in \Drupal::getContainer(). Until then,
1039 1040 1041 1042
   *   tests can invoke this workaround when requiring services from newly
   *   enabled modules to be immediately available in the same request.
   */
  protected function rebuildContainer() {
1043 1044 1045
    // Preserve the request object after the container rebuild.
    $request = \Drupal::request();

1046
    $this->kernel = new DrupalKernel('testing', drupal_classloader(), FALSE);
1047
    $this->kernel->boot();
1048
    // DrupalKernel replaces the container in \Drupal::getContainer() with a
1049
    // different object, so we need to replace the instance on this test class.
1050 1051
    $this->container = \Drupal::getContainer();
    // The global $user is set in TestBase::prepareEnvironment().
1052
    $this->container->set('request', $request);
1053
    $this->container->set('current_user', $GLOBALS['user']);
1054 1055
  }

1056
  /**
1057 1058
   * Performs cleanup tasks after each individual test method has been run.
   *
1059
   * Deletes created files, database tables, and reverts environment changes.
1060 1061 1062 1063 1064 1065 1066 1067
   *
   * This method needs to be invoked for both unit and integration tests.
   *
   * @see TestBase::prepareDatabasePrefix()
   * @see TestBase::changeDatabasePrefix()
   * @see TestBase::prepareEnvironment()
   */
  protected function tearDown() {
1068
    global $user, $conf;
1069 1070 1071 1072 1073 1074 1075 1076

    // 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();

1077 1078 1079 1080 1081 1082 1083 1084 1085
    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'));
      }
    }

1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102
    // 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.');
      }
    }
1103 1104 1105 1106 1107 1108

    // 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.
1109
    file_unmanaged_delete_recursive($this->originalFileDirectory . '/simpletest/' . substr($this->databasePrefix, 10), array($this, 'filePreDeleteCallback'));
1110 1111 1112 1113

    // Restore original database connection.
    Database::removeConnection('default');
    Database::renameConnection('simpletest_original_default', 'default');
1114 1115 1116 1117
    // @see TestBase::changeDatabasePrefix()
    global $databases;
    $connection_info = Database::getConnectionInfo('default');
    $databases['default']['default'] = $connection_info['default'];
1118

1119
    // Restore original globals.
1120 1121 1122
    if (isset($this->originalThemeKey)) {
      $GLOBALS['theme_key'] = $this->originalThemeKey;
    }
1123 1124
    $GLOBALS['theme'] = $this->originalTheme;

1125
    // Reset all static variables.
1126
    // All destructors of statically cached objects have been invoked above;
1127
    // this second reset is guaranteed to reset everything to nothing.
1128 1129 1130 1131
    drupal_static_reset();

    // Restore original in-memory configuration.
    $conf = $this->originalConf;
1132
    new Settings($this->originalSettings);
1133 1134

    // Restore original statics and globals.
1135
    \Drupal::setContainer($this->originalContainer);
1136
    $GLOBALS['config_directories'] = $this->originalConfigDirectories;
1137 1138 1139
    if (isset($this->originalPrefix)) {
      drupal_valid_test_ua($this->originalPrefix);
    }
1140 1141 1142 1143 1144 1145 1146 1147 1148 1149

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

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

1150 1151 1152 1153
  /**
   * Handle errors during test runs.
   *
   * Because this is registered in set_error_handler(), it has to be public.
1154
   *
1155 1156 1157 1158
   * @see set_error_handler
   */
  public function errorHandler($severity, $message, $file = NULL, $line = NULL) {
    if ($severity & error_reporting()) {
1159
      require_once DRUPAL_ROOT . '/core/includes/errors.inc';
1160 1161 1162 1163 1164 1165 1166 1167 1168 1169
      $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',
1170 1171
        E_DEPRECATED => 'Deprecated',
        E_USER_DEPRECATED => 'User deprecated',
1172 1173 1174
      );

      $backtrace = debug_backtrace();
1175 1176 1177 1178 1179 1180 1181 1182

      // 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>';
      }

1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193
      $this->error($message, $error_map[$severity], _drupal_get_last_caller($backtrace));
    }
    return TRUE;
  }

  /**
   * Handle exceptions.
   *
   * @see set_exception_handler
   */
  protected function exceptionHandler($exception) {
1194
    require_once DRUPAL_ROOT . '/core/includes/errors.inc';
1195
    $backtrace = $exception->getTrace();
1196
    $verbose_backtrace = $backtrace;
1197 1198 1199 1200 1201
    // Push on top of the backtrace the call that generated the exception.
    array_unshift($backtrace, array(
      'line' => $exception->getLine(),
      'file' => $exception->getFile(),
    ));
1202 1203
    // The exception message is run through check_plain()
    // by _drupal_decode_exception().
1204 1205 1206
    $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(
1207 1208 1209
      '!backtrace' => format_backtrace($verbose_backtrace),
    ));
    $this->error($message, 'Uncaught exception', _drupal_get_last_caller($backtrace));
1210 1211
  }

1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227
  /**
   * 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);
  }

1228
  /**
1229
   * Generates a unique random string of ASCII characters of codes 32 to 126.
1230
   *
1231 1232
   * 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
1233
   * \Drupal\simpletest\TestBase::randomName().
1234
   *
1235
   * @param int $length
1236
   *   Length of random string to generate.
1237
   *
1238 1239
   * @return string
   *   Randomly generated unique string.
1240
   *
1241
   * @see \Drupal\Component\Utility\Random::string()
1242
   */
1243
  public function randomString($length = 8) {
1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275
    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;
1276 1277 1278
  }

  /**
1279
   * Generates a unique random string containing letters and numbers.
1280
   *
1281
   * Do not use this method when testing unvalidated user input. Instead, use
1282
   * \Drupal\simpletest\TestBase::randomString().
1283
   *
1284
   * @param int $length
1285
   *   Length of random string to generate.
1286
   *
1287 1288
   * @return string
   *   Randomly generated unique string.
1289
   *
1290
   * @see \Drupal\Component\Utility\Random::name()