run-tests.sh 48.5 KB
Newer Older
1
<?php
2

3 4
/**
 * @file
5
 * This script runs Drupal tests from command line.
6
 */
7

8
use Drupal\Component\Utility\Html;
9
use Drupal\Component\Utility\Timer;
10
use Drupal\Component\Uuid\Php;
11
use Drupal\Core\Database\Database;
12
use Drupal\Core\Site\Settings;
13
use Drupal\Core\StreamWrapper\PublicStream;
14
use Drupal\Core\Test\TestRunnerKernel;
15
use Drupal\simpletest\Form\SimpletestResultsForm;
16
use Drupal\simpletest\TestBase;
17
use Drupal\simpletest\TestDiscovery;
18 19
use Symfony\Component\HttpFoundation\Request;

20
$autoloader = require_once __DIR__ . '/../../autoload.php';
21

22 23 24 25 26 27 28
// Define some colors for display.
// A nice calming green.
const SIMPLETEST_SCRIPT_COLOR_PASS = 32;
// An alerting Red.
const SIMPLETEST_SCRIPT_COLOR_FAIL = 31;
// An annoying brown.
const SIMPLETEST_SCRIPT_COLOR_EXCEPTION = 33;
29 30 31

// Restricting the chunk of queries prevents memory exhaustion.
const SIMPLETEST_SCRIPT_SQLITE_VARIABLE_LIMIT = 350;
32

33 34 35 36
const SIMPLETEST_SCRIPT_EXIT_SUCCESS = 0;
const SIMPLETEST_SCRIPT_EXIT_FAILURE = 1;
const SIMPLETEST_SCRIPT_EXIT_EXCEPTION = 2;

37 38 39 40 41
// Set defaults and get overrides.
list($args, $count) = simpletest_script_parse_args();

if ($args['help'] || $count == 0) {
  simpletest_script_help();
42
  exit(($count == 0) ? SIMPLETEST_SCRIPT_EXIT_FAILURE : SIMPLETEST_SCRIPT_EXIT_SUCCESS);
43 44
}

45
simpletest_script_init();
46

47 48 49 50 51 52 53 54 55
try {
  $request = Request::createFromGlobals();
  $kernel = TestRunnerKernel::createFromRequest($request, $autoloader);
  $kernel->prepareLegacyRequest($request);
}
catch (Exception $e) {
  echo (string) $e;
  exit(SIMPLETEST_SCRIPT_EXIT_EXCEPTION);
}
56

57
if ($args['execute-test']) {
58
  simpletest_script_setup_database();
59
  simpletest_script_run_one_test($args['test-id'], $args['execute-test']);
60
  // Sub-process exited already; this is just for clarity.
61
  exit(SIMPLETEST_SCRIPT_EXIT_SUCCESS);
62
}
63

64 65 66
if ($args['list']) {
  // Display all available tests.
  echo "\nAvailable test groups & classes\n";
67
  echo "-------------------------------\n\n";
68 69 70 71 72 73 74
  try {
    $groups = simpletest_test_get_all($args['module']);
  }
  catch (Exception $e) {
    echo (string) $e;
    exit(SIMPLETEST_SCRIPT_EXIT_EXCEPTION);
  }
75 76 77 78 79 80
  foreach ($groups as $group => $tests) {
    echo $group . "\n";
    foreach ($tests as $class => $info) {
      echo " - $class\n";
    }
  }
81
  exit(SIMPLETEST_SCRIPT_EXIT_SUCCESS);
82 83
}

84
simpletest_script_setup_database(TRUE);
85 86

if ($args['clean']) {
87
  // Clean up left-over tables and directories.
88 89 90 91 92 93 94
  try {
    simpletest_clean_environment();
  }
  catch (Exception $e) {
    echo (string) $e;
    exit(SIMPLETEST_SCRIPT_EXIT_EXCEPTION);
  }
95 96 97
  echo "\nEnvironment cleaned.\n";

  // Get the status messages and print them.
98 99
  $messages = drupal_get_messages('status');
  foreach ($messages['status'] as $text) {
100 101
    echo " - " . $text . "\n";
  }
102
  exit(SIMPLETEST_SCRIPT_EXIT_SUCCESS);
103 104
}

105 106
$test_list = simpletest_script_get_test_list();

107 108
// Try to allocate unlimited time to run the tests.
drupal_set_time_limit(0);
109 110
simpletest_script_reporter_init();

111
$tests_to_run = array();
112
for ($i = 0; $i < $args['repeat']; $i++) {
113
  $tests_to_run = array_merge($tests_to_run, $test_list);
114
}
115

116
// Execute tests.
117
$status = simpletest_script_execute_batch($tests_to_run);
118

119 120 121
// Stop the timer.
simpletest_script_reporter_timer_stop();

122
// Display results before database is cleared.
123 124 125 126 127 128
if ($args['browser']) {
  simpletest_script_open_browser();
}
else {
  simpletest_script_reporter_display_results();
}
129

130 131 132 133
if ($args['xml']) {
  simpletest_script_reporter_write_xml_results();
}

134
// Clean up all test results.
135
if (!$args['keep-results']) {
136 137 138 139 140 141 142
  try {
    simpletest_clean_results_table();
  }
  catch (Exception $e) {
    echo (string) $e;
    exit(SIMPLETEST_SCRIPT_EXIT_EXCEPTION);
  }
143
}
144

145
// Test complete, exit.
146
exit($status);
147

148 149 150 151 152
/**
 * Print help text.
 */
function simpletest_script_help() {
  global $args;
153 154 155 156 157

  echo <<<EOF

Run Drupal tests from the shell.

158 159
Usage:        {$args['script']} [OPTIONS] <tests>
Example:      {$args['script']} Profile
160 161 162 163

All arguments are long options.

  --help      Print this page.
164 165 166

  --list      Display all available test groups.

167 168 169
  --clean     Cleans up database tables or directories from previous, failed,
              tests and then exits (no tests are run).

170 171 172 173 174 175 176 177 178 179 180 181 182 183
  --url       The base URL of the root directory of this Drupal checkout; e.g.:
                http://drupal.test/
              Required unless the Drupal root directory maps exactly to:
                http://localhost:80/
              Use a https:// URL to force all tests to be run under SSL.

  --sqlite    A pathname to use for the SQLite database of the test runner.
              Required unless this script is executed with a working Drupal
              installation that has Simpletest module installed.
              A relative pathname is interpreted relative to the Drupal root
              directory.
              Note that ':memory:' cannot be used, because this script spawns
              sub-processes. However, you may use e.g. '/tmpfs/test.sqlite'

184 185 186 187 188 189
  --keep-results-table

              Boolean flag to indicate to not cleanup the simpletest result
              table. For testbots or repeated execution of a single test it can
              be helpful to not cleanup the simpletest result table.

190
  --dburl     A URI denoting the database driver, credentials, server hostname,
191
              and database name to use in tests.
192 193
              Required when running tests without a Drupal installation that
              contains default database connection info in settings.php.
194 195 196 197
              Examples:
                mysql://username:password@localhost/databasename#table_prefix
                sqlite://localhost/relative/path/db.sqlite
                sqlite://localhost//absolute/path/db.sqlite
198

199
  --php       The absolute path to the PHP executable. Usually not needed.
200

201 202
  --concurrency [num]

203
              Run tests in parallel, up to [num] tests at a time.
204

205
  --all       Run all available tests.
206

207 208 209
  --module    Run all tests belonging to the specified module name.
              (e.g., 'node')

210
  --class     Run tests identified by specific class names, instead of group names.
211 212
              A specific test method can be added, for example,
              'Drupal\book\Tests\BookTest::testBookExport'.
213

214
  --file      Run tests identified by specific file names, instead of group names.
215 216
              Specify the path and the extension
              (i.e. 'core/modules/user/user.test').
217

218 219 220 221 222 223
  --types

              Runs just tests from the specified test type, for example
              run-tests.sh
              (i.e. --types "Simpletest,PHPUnit-Functional")

224 225
  --directory Run all tests found within the specified file directory.

226 227 228 229 230
  --xml       <path>

              If provided, test results will be written as xml files to this path.

  --color     Output text format results with color highlighting.
231 232 233

  --verbose   Output detailed assertion messages in addition to summary.

234 235 236 237 238
  --keep-results

              Keeps detailed assertion results (in the database) after tests
              have completed. By default, assertion results are cleared.

239 240 241 242
  --repeat    Number of times to repeat the test.

  --die-on-fail

243 244 245 246
              Exit test execution immediately upon any failed assertion. This
              allows to access the test site by changing settings.php to use the
              test database and configuration directories. Use in combination
              with --repeat for debugging random test failures.
247

248 249 250 251
  --browser   Opens the results in the browser. This enforces --keep-results and
              if you want to also view any pages rendered in the simpletest
              browser you need to add --verbose to the command line.

252 253 254
  --non-html  Removes escaping from output. Useful for reading results on the
              CLI.

255 256
  <test1>[,<test2>[,<test3> ...]]

257
              One or more tests to be run. By default, these are interpreted
258
              as the names of test groups as shown at
259
              admin/config/development/testing.
260
              These group names typically correspond to module names like "User"
261
              or "Profile" or "System", but there is also a group "Database".
262
              If --class is specified then these are interpreted as the names of
263 264
              specific test classes whose test methods will be run. Tests must
              be separated by commas. Ignored if --all is specified.
265

266
To run this script you will normally invoke it from the root directory of your
267
Drupal installation as the webserver user (differs per configuration), or root:
268

269
sudo -u [wwwrun|www-data|etc] php ./core/scripts/{$args['script']}
270
  --url http://example.com/ --all
271
sudo -u [wwwrun|www-data|etc] php ./core/scripts/{$args['script']}
272
  --url http://example.com/ --class "Drupal\block\Tests\BlockTest"
273 274 275 276 277 278 279 280 281 282

Without a preinstalled Drupal site and enabled Simpletest module, specify a
SQLite database pathname to create and the default database connection info to
use in tests:

sudo -u [wwwrun|www-data|etc] php ./core/scripts/{$args['script']}
  --sqlite /tmpfs/drupal/test.sqlite
  --dburl mysql://username:password@localhost/database
  --url http://example.com/ --all

283 284 285
EOF;
}

286 287 288
/**
 * Parse execution argument and ensure that all are valid.
 *
289 290
 * @return array
 *   The list of arguments.
291 292 293 294 295 296 297 298 299
 */
function simpletest_script_parse_args() {
  // Set default values.
  $args = array(
    'script' => '',
    'help' => FALSE,
    'list' => FALSE,
    'clean' => FALSE,
    'url' => '',
300 301
    'sqlite' => NULL,
    'dburl' => NULL,
302
    'php' => '',
303 304
    'concurrency' => 1,
    'all' => FALSE,
305
    'module' => NULL,
306
    'class' => FALSE,
307
    'file' => FALSE,
308
    'types' => [],
309
    'directory' => NULL,
310 311
    'color' => FALSE,
    'verbose' => FALSE,
312
    'keep-results' => FALSE,
313
    'keep-results-table' => FALSE,
314
    'test_names' => array(),
315 316
    'repeat' => 1,
    'die-on-fail' => FALSE,
317
    'browser' => FALSE,
318
    // Used internally.
319 320
    'test-id' => 0,
    'execute-test' => '',
321
    'xml' => '',
322
    'non-html' => FALSE,
323 324 325 326 327 328 329 330 331 332 333 334 335 336 337
  );

  // Override with set values.
  $args['script'] = basename(array_shift($_SERVER['argv']));

  $count = 0;
  while ($arg = array_shift($_SERVER['argv'])) {
    if (preg_match('/--(\S+)/', $arg, $matches)) {
      // Argument found.
      if (array_key_exists($matches[1], $args)) {
        // Argument found in list.
        $previous_arg = $matches[1];
        if (is_bool($args[$previous_arg])) {
          $args[$matches[1]] = TRUE;
        }
338 339 340 341
        elseif (is_array($args[$previous_arg])) {
          $value = array_shift($_SERVER['argv']);
          $args[$matches[1]] = array_map('trim', explode(',', $value));
        }
342 343 344
        else {
          $args[$matches[1]] = array_shift($_SERVER['argv']);
        }
345
        // Clear extraneous values.
346 347 348 349 350 351
        $args['test_names'] = array();
        $count++;
      }
      else {
        // Argument not found in list.
        simpletest_script_print_error("Unknown argument '$arg'.");
352
        exit(SIMPLETEST_SCRIPT_EXIT_FAILURE);
353 354 355 356 357
      }
    }
    else {
      // Values found without an argument should be test names.
      $args['test_names'] += explode(',', $arg);
358
      $count++;
359
    }
360
  }
361

362
  // Validate the concurrency argument.
363 364
  if (!is_numeric($args['concurrency']) || $args['concurrency'] <= 0) {
    simpletest_script_print_error("--concurrency must be a strictly positive integer.");
365
    exit(SIMPLETEST_SCRIPT_EXIT_FAILURE);
366 367
  }

368 369 370
  if ($args['browser']) {
    $args['keep-results'] = TRUE;
  }
371
  return array($args, $count);
372 373
}

374 375 376
/**
 * Initialize script variables and perform general setup requirements.
 */
377
function simpletest_script_init() {
378 379 380 381
  global $args, $php;

  $host = 'localhost';
  $path = '';
382 383
  $port = '80';

384 385
  // Determine location of php command automatically, unless a command line
  // argument is supplied.
386
  if (!empty($args['php'])) {
387 388
    $php = $args['php'];
  }
389
  elseif ($php_env = getenv('_')) {
390 391
    // '_' is an environment variable set by the shell. It contains the command
    // that was executed.
392
    $php = $php_env;
393
  }
394
  elseif ($sudo = getenv('SUDO_COMMAND')) {
395 396
    // 'SUDO_COMMAND' is an environment variable set by the sudo program.
    // Extract only the PHP interpreter, not the rest of the command.
397
    list($php) = explode(' ', $sudo, 2);
398 399
  }
  else {
400
    simpletest_script_print_error('Unable to automatically determine the path to the PHP interpreter. Supply the --php command line argument.');
401
    simpletest_script_help();
402
    exit(SIMPLETEST_SCRIPT_EXIT_FAILURE);
403
  }
404

405
  // Get URL from arguments.
406 407
  if (!empty($args['url'])) {
    $parsed_url = parse_url($args['url']);
408
    $host = $parsed_url['host'] . (isset($parsed_url['port']) ? ':' . $parsed_url['port'] : '');
409
    $path = isset($parsed_url['path']) ? rtrim(rtrim($parsed_url['path']), '/') : '';
410
    $port = (isset($parsed_url['port']) ? $parsed_url['port'] : $port);
411 412 413
    if ($path == '/') {
      $path = '';
    }
414
    // If the passed URL schema is 'https' then setup the $_SERVER variables
415
    // properly so that testing will run under HTTPS.
416 417 418
    if ($parsed_url['scheme'] == 'https') {
      $_SERVER['HTTPS'] = 'on';
    }
419 420
  }

421 422 423 424 425 426 427 428 429 430 431
  if (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] === 'on') {
    $base_url = 'https://';
  }
  else {
    $base_url = 'http://';
  }
  $base_url .= $host;
  if ($path !== '') {
    $base_url .= $path;
  }
  putenv('SIMPLETEST_BASE_URL=' . $base_url);
432 433 434
  $_SERVER['HTTP_HOST'] = $host;
  $_SERVER['REMOTE_ADDR'] = '127.0.0.1';
  $_SERVER['SERVER_ADDR'] = '127.0.0.1';
435
  $_SERVER['SERVER_PORT'] = $port;
436
  $_SERVER['SERVER_SOFTWARE'] = NULL;
437
  $_SERVER['SERVER_NAME'] = 'localhost';
438
  $_SERVER['REQUEST_URI'] = $path . '/';
439
  $_SERVER['REQUEST_METHOD'] = 'GET';
440 441 442
  $_SERVER['SCRIPT_NAME'] = $path . '/index.php';
  $_SERVER['SCRIPT_FILENAME'] = $path . '/index.php';
  $_SERVER['PHP_SELF'] = $path . '/index.php';
443 444
  $_SERVER['HTTP_USER_AGENT'] = 'Drupal command line';

445
  if (!empty($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on') {
446 447 448 449 450 451
    // Ensure that any and all environment variables are changed to https://.
    foreach ($_SERVER as $key => $value) {
      $_SERVER[$key] = str_replace('http://', 'https://', $_SERVER[$key]);
    }
  }

452
  chdir(realpath(__DIR__ . '/../..'));
453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481
}

/**
 * Sets up database connection info for running tests.
 *
 * If this script is executed from within a real Drupal installation, then this
 * function essentially performs nothing (unless the --sqlite or --dburl
 * parameters were passed).
 *
 * Otherwise, there are three database connections of concern:
 * - --sqlite: The test runner connection, providing access to Simpletest
 *   database tables for recording test IDs and assertion results.
 * - --dburl: A database connection that is used as base connection info for all
 *   tests; i.e., every test will spawn from this connection. In case this
 *   connection uses e.g. SQLite, then all tests will run against SQLite. This
 *   is exposed as $databases['default']['default'] to Drupal.
 * - The actual database connection used within a test. This is the same as
 *   --dburl, but uses an additional database table prefix. This is
 *   $databases['default']['default'] within a test environment. The original
 *   connection is retained in
 *   $databases['simpletest_original_default']['default'] and restored after
 *   each test.
 *
 * @param bool $new
 *   Whether this process is a run-tests.sh master process. If TRUE, the SQLite
 *   database file specified by --sqlite (if any) is set up. Otherwise, database
 *   connections are prepared only.
 */
function simpletest_script_setup_database($new = FALSE) {
482
  global $args;
483 484 485 486 487 488 489 490 491 492 493

  // If there is an existing Drupal installation that contains a database
  // connection info in settings.php, then $databases['default']['default'] will
  // hold the default database connection already. This connection is assumed to
  // be valid, and this connection will be used in tests, so that they run
  // against e.g. MySQL instead of SQLite.
  // However, in case no Drupal installation exists, this default database
  // connection can be set and/or overridden with the --dburl parameter.
  if (!empty($args['dburl'])) {
    // Remove a possibly existing default connection (from settings.php).
    Database::removeConnection('default');
494 495
    try {
      $databases['default']['default'] = Database::convertDbUrlToConnectionInfo($args['dburl'], DRUPAL_ROOT);
496
    }
497 498
    catch (\InvalidArgumentException $e) {
      simpletest_script_print_error('Invalid --dburl. Reason: ' . $e->getMessage());
499
      exit(SIMPLETEST_SCRIPT_EXIT_FAILURE);
500
    }
501
  }
502 503 504
  // Otherwise, use the default database connection from settings.php.
  else {
    $databases['default'] = Database::getConnectionInfo('default');
505 506 507 508 509
  }

  // If there is no default database connection for tests, we cannot continue.
  if (!isset($databases['default']['default'])) {
    simpletest_script_print_error('Missing default database connection for tests. Use --dburl to specify one.');
510
    exit(SIMPLETEST_SCRIPT_EXIT_FAILURE);
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549
  }
  Database::addConnectionInfo('default', 'default', $databases['default']['default']);

  // If no --sqlite parameter has been passed, then Simpletest module is assumed
  // to be installed, so the test runner database connection is the default
  // database connection.
  if (empty($args['sqlite'])) {
    $sqlite = FALSE;
    $databases['test-runner']['default'] = $databases['default']['default'];
  }
  // Otherwise, set up a SQLite connection for the test runner.
  else {
    if ($args['sqlite'][0] === '/') {
      $sqlite = $args['sqlite'];
    }
    else {
      $sqlite = DRUPAL_ROOT . '/' . $args['sqlite'];
    }
    $databases['test-runner']['default'] = array(
      'driver' => 'sqlite',
      'database' => $sqlite,
      'prefix' => array(
        'default' => '',
      ),
    );
    // Create the test runner SQLite database, unless it exists already.
    if ($new && !file_exists($sqlite)) {
      if (!is_dir(dirname($sqlite))) {
        mkdir(dirname($sqlite));
      }
      touch($sqlite);
    }
  }

  // Add the test runner database connection.
  Database::addConnectionInfo('test-runner', 'default', $databases['test-runner']['default']);

  // Create the Simpletest schema.
  try {
550 551
    $connection = Database::getConnection('default', 'test-runner');
    $schema = $connection->schema();
552 553 554
  }
  catch (\PDOException $e) {
    simpletest_script_print_error($databases['test-runner']['default']['driver'] . ': ' . $e->getMessage());
555
    exit(SIMPLETEST_SCRIPT_EXIT_FAILURE);
556 557 558 559
  }
  if ($new && $sqlite) {
    require_once DRUPAL_ROOT . '/' . drupal_get_path('module', 'simpletest') . '/simpletest.install';
    foreach (simpletest_schema() as $name => $table_spec) {
560
      try {
561 562 563 564 565 566
        $table_exists = $schema->tableExists($name);
        if (empty($args['keep-results-table']) && $table_exists) {
          $connection->truncate($name)->execute();
        }
        if (!$table_exists) {
          $schema->createTable($name, $table_spec);
567 568 569 570 571
        }
      }
      catch (Exception $e) {
        echo (string) $e;
        exit(SIMPLETEST_SCRIPT_EXIT_EXCEPTION);
572 573 574 575
      }
    }
  }
  // Verify that the Simpletest database schema exists by checking one table.
576 577 578 579 580 581 582 583 584
  try {
    if (!$schema->tableExists('simpletest')) {
      simpletest_script_print_error('Missing Simpletest database schema. Either install Simpletest module or use the --sqlite parameter.');
      exit(SIMPLETEST_SCRIPT_EXIT_FAILURE);
    }
  }
  catch (Exception $e) {
    echo (string) $e;
    exit(SIMPLETEST_SCRIPT_EXIT_EXCEPTION);
585 586 587
  }
}

588 589 590
/**
 * Execute a batch of tests.
 */
591
function simpletest_script_execute_batch($test_classes) {
592
  global $args, $test_ids;
593

594 595
  $total_status = SIMPLETEST_SCRIPT_EXIT_SUCCESS;

596 597
  // Multi-process execution.
  $children = array();
598
  while (!empty($test_classes) || !empty($children)) {
599
    while (count($children) < $args['concurrency']) {
600
      if (empty($test_classes)) {
601
        break;
602
      }
603

604 605 606 607 608 609 610 611 612 613
      try {
        $test_id = Database::getConnection('default', 'test-runner')
          ->insert('simpletest_test_id')
          ->useDefaults(array('test_id'))
          ->execute();
      }
      catch (Exception $e) {
        echo (string) $e;
        exit(SIMPLETEST_SCRIPT_EXIT_EXCEPTION);
      }
614
      $test_ids[] = $test_id;
615

616
      $test_class = array_shift($test_classes);
617
      // Fork a child process.
618 619 620 621 622
      $command = simpletest_script_command($test_id, $test_class);
      $process = proc_open($command, array(), $pipes, NULL, NULL, array('bypass_shell' => TRUE));

      if (!is_resource($process)) {
        echo "Unable to fork test process. Aborting.\n";
623
        exit(SIMPLETEST_SCRIPT_EXIT_SUCCESS);
624 625
      }

626 627 628
      // Register our new child.
      $children[] = array(
        'process' => $process,
629
        'test_id' => $test_id,
630 631 632 633
        'class' => $test_class,
        'pipes' => $pipes,
      );
    }
634

635 636 637 638 639 640 641 642 643
    // Wait for children every 200ms.
    usleep(200000);

    // Check if some children finished.
    foreach ($children as $cid => $child) {
      $status = proc_get_status($child['process']);
      if (empty($status['running'])) {
        // The child exited, unregister it.
        proc_close($child['process']);
644 645 646 647
        if ($status['exitcode'] === SIMPLETEST_SCRIPT_EXIT_FAILURE) {
          $total_status = max($status['exitcode'], $total_status);
        }
        elseif ($status['exitcode']) {
648 649 650 651
          $message = 'FATAL ' . $child['class'] . ': test runner returned a non-zero error code (' . $status['exitcode'] . ').';
          echo $message . "\n";
          // Insert a fail for xml results.
          TestBase::insertAssert($child['test_id'], $child['class'], FALSE, $message, 'run-tests.sh check');
652 653 654 655 656
          // Ensure that an error line is displayed for the class.
          simpletest_script_reporter_display_summary(
            $child['class'],
            ['#pass' => 0, '#fail' => 1, '#exception' => 0, '#debug' => 0]
          );
657
          if ($args['die-on-fail']) {
658
            list($db_prefix) = simpletest_last_test_get($child['test_id']);
659
            $test_directory = 'sites/simpletest/' . substr($db_prefix, 10);
660
            echo 'Simpletest database and files kept and test exited immediately on fail so should be reproducible if you change settings.php to use the database prefix ' . $db_prefix . ' and config directories in ' . $test_directory . "\n";
661 662 663
            $args['keep-results'] = TRUE;
            // Exit repeat loop immediately.
            $args['repeat'] = -1;
664
          }
665
        }
666
        // Free-up space by removing any potentially created resources.
667 668 669
        if (!$args['keep-results']) {
          simpletest_script_cleanup($child['test_id'], $child['class'], $status['exitcode']);
        }
670 671

        // Remove this child.
672
        unset($children[$cid]);
673 674 675
      }
    }
  }
676
  return $total_status;
677 678
}

679
/**
680
 * Run a PHPUnit-based test.
681
 */
682
function simpletest_script_run_phpunit($test_id, $class) {
683 684 685 686 687
  $reflection = new \ReflectionClass($class);
  if ($reflection->hasProperty('runLimit')) {
    set_time_limit($reflection->getStaticPropertyValue('runLimit'));
  }

688
  $results = simpletest_run_phpunit_tests($test_id, array($class), $status);
689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707
  simpletest_process_phpunit_results($results);

  // Map phpunit results to a data structure we can pass to
  // _simpletest_format_summary_line.
  $summaries = array();
  foreach ($results as $result) {
    if (!isset($summaries[$result['test_class']])) {
      $summaries[$result['test_class']] = array(
        '#pass' => 0,
        '#fail' => 0,
        '#exception' => 0,
        '#debug' => 0,
      );
    }

    switch ($result['status']) {
      case 'pass':
        $summaries[$result['test_class']]['#pass']++;
        break;
708

709 710 711
      case 'fail':
        $summaries[$result['test_class']]['#fail']++;
        break;
712

713 714 715
      case 'exception':
        $summaries[$result['test_class']]['#exception']++;
        break;
716

717
      case 'debug':
718
        $summaries[$result['test_class']]['#debug']++;
719 720 721 722 723
        break;
    }
  }

  foreach ($summaries as $class => $summary) {
724
    simpletest_script_reporter_display_summary($class, $summary);
725
  }
726
  return $status;
727 728
}

729
/**
730
 * Run a single test, bootstrapping Drupal if needed.
731 732
 */
function simpletest_script_run_one_test($test_id, $test_class) {
733
  global $args;
734

735
  try {
736 737 738 739 740 741 742 743 744 745
    if (strpos($test_class, '::') > 0) {
      list($class_name, $method) = explode('::', $test_class, 2);
      $methods = [$method];
    }
    else {
      $class_name = $test_class;
      // Use empty array to run all the test methods.
      $methods = array();
    }
    $test = new $class_name($test_id);
746
    if (is_subclass_of($test_class, '\PHPUnit_Framework_TestCase')) {
747
      $status = simpletest_script_run_phpunit($test_id, $test_class);
748 749 750 751 752 753
    }
    else {
      $test->dieOnFail = (bool) $args['die-on-fail'];
      $test->verbose = (bool) $args['verbose'];
      $test->run($methods);
      simpletest_script_reporter_display_summary($test_class, $test->results);
754 755 756 757 758 759

      $status = SIMPLETEST_SCRIPT_EXIT_SUCCESS;
      // Finished, kill this runner.
      if ($test->results['#fail'] || $test->results['#exception']) {
        $status = SIMPLETEST_SCRIPT_EXIT_FAILURE;
      }
760
    }
761

762
    exit($status);
763
  }
764 765
  // DrupalTestCase::run() catches exceptions already, so this is only reached
  // when an exception is thrown in the wrapping test runner environment.
766 767
  catch (Exception $e) {
    echo (string) $e;
768
    exit(SIMPLETEST_SCRIPT_EXIT_EXCEPTION);
769
  }
770 771
}

772
/**
773 774
 * Return a command used to run a test in a separate process.
 *
775 776 777 778 779 780 781
 * @param int $test_id
 *   The current test ID.
 * @param string $test_class
 *   The name of the test class to run.
 *
 * @return string
 *   The assembled command string.
782
 */
783
function simpletest_script_command($test_id, $test_class) {
784
  global $args, $php;
785

786 787
  $command = escapeshellarg($php) . ' ' . escapeshellarg('./core/scripts/' . $args['script']);
  $command .= ' --url ' . escapeshellarg($args['url']);
788 789 790 791 792 793
  if (!empty($args['sqlite'])) {
    $command .= ' --sqlite ' . escapeshellarg($args['sqlite']);
  }
  if (!empty($args['dburl'])) {
    $command .= ' --dburl ' . escapeshellarg($args['dburl']);
  }
794 795
  $command .= ' --php ' . escapeshellarg($php);
  $command .= " --test-id $test_id";
796
  foreach (array('verbose', 'keep-results', 'color', 'die-on-fail') as $arg) {
797 798 799
    if ($args[$arg]) {
      $command .= ' --' . $arg;
    }
800
  }
801 802
  // --execute-test and class name needs to come last.
  $command .= ' --execute-test ' . escapeshellarg($test_class);
803
  return $command;
804 805
}

806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827
/**
 * Removes all remnants of a test runner.
 *
 * In case a (e.g., fatal) error occurs after the test site has been fully setup
 * and the error happens in many tests, the environment that executes the tests
 * can easily run out of memory or disk space. This function ensures that all
 * created resources are properly cleaned up after every executed test.
 *
 * This clean-up only exists in this script, since SimpleTest module itself does
 * not use isolated sub-processes for each test being run, so a fatal error
 * halts not only the test, but also the test runner (i.e., the parent site).
 *
 * @param int $test_id
 *   The test ID of the test run.
 * @param string $test_class
 *   The class name of the test run.
 * @param int $exitcode
 *   The exit code of the test runner.
 *
 * @see simpletest_script_run_one_test()
 */
function simpletest_script_cleanup($test_id, $test_class, $exitcode) {
828
  if (is_subclass_of($test_class, '\PHPUnit_Framework_TestCase')) {
829 830 831
    // PHPUnit test, move on.
    return;
  }
832
  // Retrieve the last database prefix used for testing.
833
  try {
834
    list($db_prefix) = simpletest_last_test_get($test_id);
835 836 837 838 839
  }
  catch (Exception $e) {
    echo (string) $e;
    exit(SIMPLETEST_SCRIPT_EXIT_EXCEPTION);
  }
840 841 842 843 844 845 846 847 848 849 850 851 852 853

  // If no database prefix was found, then the test was not set up correctly.
  if (empty($db_prefix)) {
    echo "\nFATAL $test_class: Found no database prefix for test ID $test_id. (Check whether setUp() is invoked correctly.)";
    return;
  }

  // Do not output verbose cleanup messages in case of a positive exitcode.
  $output = !empty($exitcode);
  $messages = array();

  $messages[] = "- Found database prefix '$db_prefix' for test ID $test_id.";

  // Read the log file in case any fatal errors caused the test to crash.
854 855 856 857 858 859 860
  try {
    simpletest_log_read($test_id, $db_prefix, $test_class);
  }
  catch (Exception $e) {
    echo (string) $e;
    exit(SIMPLETEST_SCRIPT_EXIT_EXCEPTION);
  }
861

862 863 864
  // Check whether a test site directory was setup already.
  // @see \Drupal\simpletest\TestBase::prepareEnvironment()
  $test_directory = DRUPAL_ROOT . '/sites/simpletest/' . substr($db_prefix, 10);
865 866 867 868 869 870 871 872
  if (is_dir($test_directory)) {
    // Output the error_log.
    if (is_file($test_directory . '/error.log')) {
      if ($errors = file_get_contents($test_directory . '/error.log')) {
        $output = TRUE;
        $messages[] = $errors;
      }
    }
873
    // Delete the test site directory.
874 875 876
    // simpletest_clean_temporary_directories() cannot be used here, since it
    // would also delete file directories of other tests that are potentially
    // running concurrently.
877
    file_unmanaged_delete_recursive($test_directory, array('Drupal\simpletest\TestBase', 'filePreDeleteCallback'));
878
    $messages[] = "- Removed test site directory.";
879 880 881
  }

  // Clear out all database tables from the test.
882 883 884 885 886 887 888
  try {
    $schema = Database::getConnection('default', 'default')->schema();
    $count = 0;
    foreach ($schema->findTables($db_prefix . '%') as $table) {
      $schema->dropTable($table);
      $count++;
    }
889
  }
890 891 892 893 894
  catch (Exception $e) {
    echo (string) $e;
    exit(SIMPLETEST_SCRIPT_EXIT_EXCEPTION);
  }

895
  if ($count) {
896
    $messages[] = "- Removed $count leftover tables.";
897 898 899 900 901 902 903 904
  }

  if ($output) {
    echo implode("\n", $messages);
    echo "\n";
  }
}

905
/**
906
 * Get list of tests based on arguments.
907
 *
908 909
 * If --all specified then return all available tests, otherwise reads list of
 * tests.
910
 *
911 912
 * @return array
 *   List of tests.
913 914
 */
function simpletest_script_get_test_list() {
915
  global $args;
916

917
  $types_processed = empty($args['types']);
918
  $test_list = array();
919
  if ($args['all'] || $args['module']) {
920
    try {
921
      $groups = simpletest_test_get_all($args['module'], $args['types']);
922
      $types_processed = TRUE;
923 924 925 926 927
    }
    catch (Exception $e) {
      echo (string) $e;
      exit(SIMPLETEST_SCRIPT_EXIT_EXCEPTION);
    }
928 929
    $all_tests = array();
    foreach ($groups as $group => $tests) {
930
      $all_tests = array_merge($all_tests, array_keys($tests));
931
    }
932
    $test_list = $all_tests;
933 934
  }
  else {
935
    if ($args['class']) {
936 937
      $test_list = array();
      foreach ($args['test_names'] as $test_class) {
938
        list($class_name) = explode('::', $test_class, 2);
939
        if (class_exists($class_name)) {
940 941 942
          $test_list[] = $test_class;
        }
        else {
943
          try {
944
            $groups = simpletest_test_get_all(NULL, $args['types']);
945 946 947 948 949
          }
          catch (Exception $e) {
            echo (string) $e;
            exit(SIMPLETEST_SCRIPT_EXIT_EXCEPTION);
          }
950 951 952 953
          $all_classes = array();
          foreach ($groups as $group) {
            $all_classes = array_merge($all_classes, array_keys($group));
          }
954 955
          simpletest_script_print_error('Test class not found: ' . $class_name);
          simpletest_script_print_alternatives($class_name, $all_classes, 6);
956
          exit(SIMPLETEST_SCRIPT_EXIT_FAILURE);
957
        }
958 959
      }
    }
960
    elseif ($args['file']) {
961
      // Extract test case class names from specified files.
962
      foreach ($args['test_names'] as $file) {
963 964
        if (!file_exists($file)) {
          simpletest_script_print_error('File not found: ' . $file);
965
          exit(SIMPLETEST_SCRIPT_EXIT_FAILURE);
966 967 968 969 970 971 972 973 974 975 976
        }
        $content = file_get_contents($file);
        // Extract a potential namespace.
        $namespace = FALSE;
        if (preg_match('@^namespace ([^ ;]+)@m', $content, $matches)) {
          $namespace = $matches[1];
        }
        // Extract all class names.
        // Abstract classes are excluded on purpose.
        preg_match_all('@^class ([^ ]+)@m', $content, $matches);
        if (!$namespace) {
977
          $test_list = array_merge($test_list, $matches[1]);
978 979 980
        }
        else {
          foreach ($matches[1] as $class_name) {
981
            $namespace_class = $namespace . '\\' . $class_name;
982
            if (is_subclass_of($namespace_class, '\Drupal\simpletest\TestBase') || is_subclass_of($namespace_class, '\PHPUnit_Framework_TestCase')) {
983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008
              $test_list[] = $namespace_class;
            }
          }
        }
      }
    }
    elseif ($args['directory']) {
      // Extract test case class names from specified directory.
      // Find all tests in the PSR-X structure; Drupal\$extension\Tests\*.php
      // Since we do not want to hard-code too many structural file/directory
      // assumptions about PSR-0/4 files and directories, we check for the
      // minimal conditions only; i.e., a '*.php' file that has '/Tests/' in
      // its path.
      // Ignore anything from third party vendors.
      $ignore = array('.', '..', 'vendor');
      $files = [];
      if ($args['directory'][0] === '/') {
        $directory = $args['directory'];
      }
      else {
        $directory = DRUPAL_ROOT . "/" . $args['directory'];
      }
      foreach (file_scan_directory($directory, '/\.php$/', $ignore) as $file) {
        // '/Tests/' can be contained anywhere in the file's path (there can be
        // sub-directories below /Tests), but must be contained literally.
        // Case-insensitive to match all Simpletest and PHPUnit tests:
1009 1010 1011 1012
        // ./lib/Drupal/foo/Tests/Bar/Baz.php
        // ./foo/src/Tests/Bar/Baz.php
        // ./foo/tests/Drupal/foo/Tests/FooTest.php
        // ./foo/tests/src/FooTest.php
1013
        // $file->filename doesn't give us a directory, so we use $file->uri
1014 1015
        // Strip the drupal root directory and trailing slash off the URI.
        $filename = substr($file->uri, strlen(DRUPAL_ROOT) + 1);
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036
        if (stripos($filename, '/Tests/')) {
          $files[$filename] = $filename;
        }
      }
      foreach ($files as $file) {
        $content = file_get_contents($file);
        // Extract a potential namespace.
        $namespace = FALSE;
        if (preg_match('@^namespace ([^ ;]+)@m', $content, $matches)) {
          $namespace = $matches[1];
        }
        // Extract all class names.
        // Abstract classes are excluded on purpose.
        preg_match_all('@^class ([^ ]+)@m', $content, $matches);
        if (!$namespace) {
          $test_list = array_merge($test_list, $matches[1]);
        }
        else {
          foreach ($matches[1] as $class_name) {
            $namespace_class = $namespace . '\\' . $class_name;
            if (is_subclass_of($namespace_class, '\Drupal\simpletest\TestBase') || is_subclass_of($namespace_class, '\PHPUnit_Framework_TestCase')) {
1037 1038
              $test_list[] = $namespace_class;
            }
1039
          }
1040 1041 1042
        }
      }
    }
1043
    else {
1044
      try {
1045
        $groups = simpletest_test_get_all(NULL, $args['types']);
1046
        $types_processed = TRUE;
1047 1048 1049 1050 1051
      }
      catch (Exception $e) {
        echo (string) $e;
        exit(SIMPLETEST_SCRIPT_EXIT_EXCEPTION);
      }
1052
      foreach ($args['test_names'] as $group_name) {
1053 1054 1055 1056 1057 1058
        if (isset($groups[$group_name])) {
          $test_list = array_merge($test_list, array_keys($groups[$group_name]));
        }
        else {
          simpletest_script_print_error('Test group not found: ' . $group_name);
          simpletest_script_print_alternatives($group_name, array_keys($groups));
1059
          exit(SIMPLETEST_SCRIPT_EXIT_FAILURE);
1060
        }
1061 1062
      }
    }
1063
  }
1064

1065 1066 1067 1068 1069 1070 1071 1072 1073
  // If the test list creation does not automatically limit by test type then
  // we need to do so here.
  if (!$types_processed) {
    $test_list = array_filter($test_list, function ($test_class) use ($args) {
      $test_info = TestDiscovery::getTestInfo($test_class);
      return in_array($test_info['type'], $args['types'], TRUE);
    });
  }

1074 1075
  if (empty($test_list)) {
    simpletest_script_print_error('No valid tests were specified.');
1076
    exit(SIMPLETEST_SCRIPT_EXIT_FAILURE);
1077 1078
  }
  return $test_list;
1079 1080
}

1081 1082 1083 1084
/**
 * Initialize the reporter.
 */
function simpletest_script_reporter_init() {
1085
  global $args, $test_list, $results_map;
1086 1087 1088 1089

  $results_map = array(
    'pass' => 'Pass',
    'fail' => 'Fail',
1090
    'exception' => 'Exception',
1091
  );
1092

1093 1094 1095 1096
  echo "\n";
  echo "Drupal test run\n";
  echo "---------------\n";
  echo "\n";
1097

1098 1099 1100 1101 1102 1103
  // Tell the user about what tests are to be run.
  if ($args['all']) {
    echo "All tests will run.\n\n";
  }
  else {
    echo "Tests to be run:\n";
1104
    foreach ($test_list as $class_name) {
1105
      echo "  - $class_name\n";
1106 1107
    }
    echo "\n";
1108
  }
1109

1110
  echo "Test run started:\n";
1111
  echo "  " . date('l, F j, Y - H:i', $_SERVER['REQUEST_TIME']) . "\n";
1112
  Timer::start('run-tests');
1113 1114
  echo "\n";

1115 1116
  echo "Test summary\n";
  echo "------------\n";
1117
  echo "\n";
1118 1119
}

1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133
/**
 * Displays the assertion result summary for a single test class.
 *
 * @param string $class
 *   The test class name that was run.
 * @param array $results
 *   The assertion results using #pass, #fail, #exception, #debug array keys.
 */
function simpletest_script_reporter_display_summary($class, $results) {
  // Output all test results vertically aligned.
  // Cut off the class name after 60 chars, and pad each group with 3 digits
  // by default (more than 999 assertions are rare).
  $output = vsprintf('%-60.60s %10s %9s %14s %12s', array(
    $class,
1134 1135
    $results['#pass'] . ' passes',
    !$results['#fail'] ? '' : $results['#fail'] . ' fails',
1136
    !$results['#exception'] ? '' : $results['#exception'] . ' exceptions',
1137
    !$results['#debug'] ? '' : $results['#debug'] . ' messages',
1138 1139 1140 1141 1142 1143
  ));

  $status = ($results['#fail'] || $results['#exception'] ? 'fail' : 'pass');
  simpletest_script_print($output . "\n", simpletest_script_color_code($status));
}

1144
/**
1145
 * Display jUnit XML test results.
1146
 */
1147
function simpletest_script_reporter_write_xml_results() {
1148
  global $args, $test_ids, $results_map;
1149

1150 1151 1152 1153 1154 1155 1156
  try {
    $results = simpletest_script_load_messages_by_test_id($test_ids);
  }
  catch (Exception $e) {
    echo (string) $e;
    exit(SIMPLETEST_SCRIPT_EXIT_EXCEPTION);
  }
1157 1158 1159 1160 1161 1162 1163

  $test_class = '';
  $xml_files = array();

  foreach ($results as $result) {
    if (isset($results_map[$result->status])) {
      if ($result->test_class != $test_class) {
1164 1165
        // We've moved onto a new class, so write the last classes results to a
        // file:
1166
        if (isset($xml_files[$test_class])) {
1167
          file_put_contents($args['xml'] . '/' . str_replace('\\', '_', $test_class) . '.xml', $xml_files[$test_class]['doc']->saveXML());
1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184
          unset($xml_files[$test_class]);
        }
        $test_class = $result->test_class;
        if (!isset($xml_files[$test_class])) {
          $doc = new DomDocument('1.0');
          $root = $doc->createElement('testsuite');
          $root = $doc->appendChild($root);
          $xml_files[$test_class] = array('doc' => $doc, 'suite' => $root);
        }
      }

      // For convenience:
      $dom_document = &$xml_files[$test_class]['doc'];

      // Create the XML element for this test case:
      $case = $dom_document->createElement('testcase');
      $case->setAttribute('classname', $test_class);
1185 1186 1187 1188 1189 1190
      if (strpos($result->function, '->') !== FALSE) {
        list($class, $name) = explode('->', $result->function, 2);
      }
      else {
        $name = $result->function;
      }
1191 1192
      $case->setAttribute('name', $name);

1193 1194
      // Passes get no further attention, but failures and exceptions get to add
      // more detail:
1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221
      if ($result->status == 'fail') {
        $fail = $dom_document->createElement('failure');
        $fail->setAttribute('type', 'failure');
        $fail->setAttribute('message', $result->message_group);
        $text = $dom_document->createTextNode($result->message);
        $fail->appendChild($text);
        $case->appendChild($fail);
      }
      elseif ($result->status == 'exception') {
        // In the case of an exception the $result->function may not be a class
        // method so we record the full function name:
        $case->setAttribute('name', $result->function);

        $fail = $dom_document->createElement('error');
        $fail->setAttribute('type', 'exception');
        $fail->setAttribute('message', $result->message_group);
        $full_message = $result->message . "\n\nline: " . $result->line . "\nfile: " . $result->file;
        $text = $dom_document->createTextNode($full_message);
        $fail->appendChild($text);
        $case->appendChild($fail);
      }
      // Append the test case XML to the test suite:
      $xml_files[$test_class]['suite']->appendChild($case);
    }
  }
  // The last test case hasn't been saved to a file yet, so do that now:
  if (isset($xml_files[$test_class])) {
1222
    file_put_contents($args['xml'] . '/' . str_replace('\\', '_', $test_class) . '.xml', $xml_files[$test_class]['doc']->saveXML());
1223 1224 1225 1226 1227 1228 1229 1230
    unset($xml_files[$test_class]);
  }
}

/**
 * Stop the test timer.
 */
function simpletest_script_reporter_timer_stop() {
1231
  echo "\n";
1232
  $end = Timer::stop('run-tests');
1233
  echo "Test run duration: " . \Drupal::service('date.formatter')->formatInterval($end['time'] / 1000);
1234
  echo "\n\n";
1235 1236 1237 1238 1239 1240
}

/**
 * Display test results.
 */
function simpletest_script_reporter_display_results() {
1241
  global $args, $test_ids, $results_map;
1242

1243 1244
  if ($args['verbose']) {
    // Report results.
1245 1246
    echo "Detailed test results\n";
    echo "---------------------\n";
1247

1248 1249 1250 1251 1252 1253 1254
    try {
      $results = simpletest_script_load_messages_by_test_id($test_ids);
    }
    catch (Exception $e) {
      echo (string) $e;
      exit(SIMPLETEST_SCRIPT_EXIT_EXCEPTION);
    }
1255
    $test_class = '';
1256
    foreach ($results as $result) {
1257 1258 1259 1260 1261
      if (isset($results_map[$result->status])) {
        if ($result->test_class != $test_class) {
          // Display test class every time results are for new test class.
          echo "\n\n---- $result->test_class ----\n\n\n";
          $test_class = $result->test_class;
1262

1263 1264 1265
          // Print table header.
          echo "Status    Group      Filename          Line Function                            \n";
          echo "--------------------------------------------------------------------------------\n";
1266 1267 1268 1269 1270
        }

        simpletest_script_format_result($result);
      }
    }
1271 1272 1273
  }
}

1274
/**
1275
 * Format the result so that it fits within 80 characters.
1276
 *
1277 1278
 * @param object $result
 *   The result object to format.
1279 1280
 */
function simpletest_script_format_result($result) {
1281
  global $args, $results_map, $color;
1282

1283 1284
  $summary = sprintf("%-9.9s %-10.10s %-17.17s %4.4s %-35.35s\n",
    $results_map[$result->status], $result->message_group, basename($result->file), $result->line, $result->function);
1285 1286

  simpletest_script_print($summary, simpletest_script_color_code($result->status));
1287

1288 1289 1290 1291 1292
  $message = trim(strip_tags($result->message));
  if ($args['non-html']) {
    $message = Html::decodeEntities($message, ENT_QUOTES, 'UTF-8');
  }
  $lines = explode("\n", wordwrap($message), 76);
1293 1294 1295 1296
  foreach ($lines as $line) {
    echo "    $line\n";
  }
}
1297

1298
/**
1299
 * Print error messages so the user will notice them.
1300
 *
1301 1302 1303 1304 1305
 * Print error message prefixed with "  ERROR: " and displayed in fail color if
 * color output is enabled.
 *
 * @param string $message
 *   The message to print.
1306
 */
1307 1308
function simpletest_script_print_error($message) {
  simpletest_script_print("  ERROR: $message\n", SIMPLETEST_SCRIPT_COLOR_FAIL);
1309
}
1310

1311
/**
1312
 * Print a message to the console, using a color.
1313
 *
1314 1315 1316 1317
 * @param string $message
 *   The message to print.
 * @param int $color_code
 *   The color code to use for coloring.
1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331
 */
function simpletest_script_print($message, $color_code) {
  global $args;
  if ($args['color']) {
    echo "\033[" . $color_code . "m" . $message . "\033[0m";
  }
  else {
    echo $message;
  }
}

/**
 * Get the color code associated with the specified status.
 *
1332 1333 1334 1335 1336 1337
 * @param string $status
 *   The status string to get code for. Special cases are: 'pass', 'fail', or
 *   'exception'.
 *
 * @return int
 *   Color code. Returns 0 for default case.
1338 1339 1340 1341 1342
 */
function simpletest_script_color_code($status) {
  switch ($status) {
    case 'pass':
      return SIMPLETEST_SCRIPT_COLOR_PASS;
1343

1344 1345
    case 'fail':
      return SIMPLETEST_SCRIPT_COLOR_FAIL;
1346

1347 1348 1349
    case 'exception':
      re