run-tests.sh 22.9 KB
Newer Older
1 2 3
<?php
/**
 * @file
4
 * This script runs Drupal tests from command line.
5 6
 */

7 8 9
const SIMPLETEST_SCRIPT_COLOR_PASS = 32; // Green.
const SIMPLETEST_SCRIPT_COLOR_FAIL = 31; // Red.
const SIMPLETEST_SCRIPT_COLOR_EXCEPTION = 33; // Brown.
10 11 12 13 14 15 16 17 18

// Set defaults and get overrides.
list($args, $count) = simpletest_script_parse_args();

if ($args['help'] || $count == 0) {
  simpletest_script_help();
  exit;
}

19
if ($args['execute-test']) {
20 21
  // Masquerade as Apache for running tests.
  simpletest_script_init("Apache");
22
  simpletest_script_run_one_test($args['test-id'], $args['execute-test']);
23
  // Sub-process script execution ends here.
24
}
25 26
else {
  // Run administrative functions as CLI.
27
  simpletest_script_init(NULL);
28
}
29

30
// Bootstrap to perform initial validation or other operations.
31 32 33 34 35 36 37 38 39 40 41 42 43
drupal_bootstrap(DRUPAL_BOOTSTRAP_FULL);
if (!module_exists('simpletest')) {
  simpletest_script_print_error("The simpletest module must be enabled before this script can run.");
  exit;
}

if ($args['clean']) {
  // Clean up left-over times and directories.
  simpletest_clean_environment();
  echo "\nEnvironment cleaned.\n";

  // Get the status messages and print them.
  $messages = array_pop(drupal_get_messages('status'));
44
  foreach ($messages as $text) {
45 46 47 48 49 50
    echo " - " . $text . "\n";
  }
  exit;
}

// Load SimpleTest files.
51 52 53 54 55
$groups = simpletest_test_get_all();
$all_tests = array();
foreach ($groups as $group => $tests) {
  $all_tests = array_merge($all_tests, array_keys($tests));
}
56 57 58
$test_list = array();

if ($args['list']) {
59
  // Display all available tests.
60 61 62 63
  echo "\nAvailable test groups & classes\n";
  echo   "-------------------------------\n\n";
  foreach ($groups as $group => $tests) {
    echo $group . "\n";
64 65
    foreach ($tests as $class => $info) {
      echo " - " . $info['name'] . ' (' . $class . ')' . "\n";
66 67 68 69 70
    }
  }
  exit;
}

71 72
$test_list = simpletest_script_get_test_list();

73 74
// Try to allocate unlimited time to run the tests.
drupal_set_time_limit(0);
75 76 77 78

simpletest_script_reporter_init();

// Execute tests.
79
simpletest_script_execute_batch(simpletest_script_get_test_list());
80

81 82 83
// Stop the timer.
simpletest_script_reporter_timer_stop();

84 85 86
// Display results before database is cleared.
simpletest_script_reporter_display_results();

87 88 89 90
if ($args['xml']) {
  simpletest_script_reporter_write_xml_results();
}

91 92
// Clean up all test results.
simpletest_clean_results_table();
93

94 95 96
// Test complete, exit.
exit;

97 98 99 100 101
/**
 * Print help text.
 */
function simpletest_script_help() {
  global $args;
102 103 104 105 106

  echo <<<EOF

Run Drupal tests from the shell.

107 108
Usage:        {$args['script']} [OPTIONS] <tests>
Example:      {$args['script']} Profile
109 110 111 112

All arguments are long options.

  --help      Print this page.
113 114 115

  --list      Display all available test groups.

116 117 118
  --clean     Cleans up database tables or directories from previous, failed,
              tests and then exits (no tests are run).

119
  --url       Immediately precedes a URL to set the host and path. You will
120
              need this parameter if Drupal is in a subdirectory on your
121 122
              localhost and you have not set \$base_url in settings.php. Tests
              can be run under SSL by including https:// in the URL.
123

124
  --php       The absolute path to the PHP executable. Usually not needed.
125

126 127
  --concurrency [num]

128
              Run tests in parallel, up to [num] tests at a time.
129

130
  --all       Run all available tests.
131

132
  --class     Run tests identified by specific class names, instead of group names.
133

134
  --file      Run tests identified by specific file names, instead of group names.
135 136
              Specify the path and the extension
              (i.e. 'core/modules/user/user.test').
137

138 139 140 141 142
  --xml       <path>

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

  --color     Output text format results with color highlighting.
143 144 145

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

146 147
  <test1>[,<test2>[,<test3> ...]]

148
              One or more tests to be run. By default, these are interpreted
149
              as the names of test groups as shown at
150
              admin/config/development/testing.
151 152 153
              These group names typically correspond to module names like "User"
              or "Profile" or "System", but there is also a group "XML-RPC".
              If --class is specified then these are interpreted as the names of
154 155
              specific test classes whose test methods will be run. Tests must
              be separated by commas. Ignored if --all is specified.
156

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

160
sudo -u [wwwrun|www-data|etc] php ./core/scripts/{$args['script']}
161
  --url http://example.com/ --all
162
sudo -u [wwwrun|www-data|etc] php ./core/scripts/{$args['script']}
163
  --url http://example.com/ --class BlockTestCase
164 165 166 167
\n
EOF;
}

168 169 170 171 172 173 174 175 176 177 178 179 180
/**
 * Parse execution argument and ensure that all are valid.
 *
 * @return The list of arguments.
 */
function simpletest_script_parse_args() {
  // Set default values.
  $args = array(
    'script' => '',
    'help' => FALSE,
    'list' => FALSE,
    'clean' => FALSE,
    'url' => '',
181
    'php' => '',
182 183 184
    'concurrency' => 1,
    'all' => FALSE,
    'class' => FALSE,
185
    'file' => FALSE,
186 187 188 189
    'color' => FALSE,
    'verbose' => FALSE,
    'test_names' => array(),
    // Used internally.
190 191
    'test-id' => 0,
    'execute-test' => '',
192
    'xml' => '',
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
  );

  // 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;
        }
        else {
          $args[$matches[1]] = array_shift($_SERVER['argv']);
        }
211
        // Clear extraneous values.
212 213 214 215 216 217 218 219 220 221 222 223
        $args['test_names'] = array();
        $count++;
      }
      else {
        // Argument not found in list.
        simpletest_script_print_error("Unknown argument '$arg'.");
        exit;
      }
    }
    else {
      // Values found without an argument should be test names.
      $args['test_names'] += explode(',', $arg);
224
      $count++;
225
    }
226
  }
227 228 229 230 231 232 233

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

234
  return array($args, $count);
235 236
}

237 238 239
/**
 * Initialize script variables and perform general setup requirements.
 */
240
function simpletest_script_init($server_software) {
241 242 243 244
  global $args, $php;

  $host = 'localhost';
  $path = '';
245
  // Determine location of php command automatically, unless a command line argument is supplied.
246
  if (!empty($args['php'])) {
247 248
    $php = $args['php'];
  }
249
  elseif ($php_env = getenv('_')) {
250
    // '_' is an environment variable set by the shell. It contains the command that was executed.
251
    $php = $php_env;
252
  }
253
  elseif ($sudo = getenv('SUDO_COMMAND')) {
254 255
    // 'SUDO_COMMAND' is an environment variable set by the sudo program.
    // Extract only the PHP interpreter, not the rest of the command.
256
    list($php, ) = explode(' ', $sudo, 2);
257 258
  }
  else {
259
    simpletest_script_print_error('Unable to automatically determine the path to the PHP interpreter. Supply the --php command line argument.');
260
    simpletest_script_help();
261 262
    exit();
  }
263 264 265 266

  // Get url from arguments.
  if (!empty($args['url'])) {
    $parsed_url = parse_url($args['url']);
267
    $host = $parsed_url['host'] . (isset($parsed_url['port']) ? ':' . $parsed_url['port'] : '');
268
    $path = isset($parsed_url['path']) ? $parsed_url['path'] : '';
269 270 271 272 273 274

    // If the passed URL schema is 'https' then setup the $_SERVER variables
    // properly so that testing will run under https.
    if ($parsed_url['scheme'] == 'https') {
      $_SERVER['HTTPS'] = 'on';
    }
275 276 277 278 279
  }

  $_SERVER['HTTP_HOST'] = $host;
  $_SERVER['REMOTE_ADDR'] = '127.0.0.1';
  $_SERVER['SERVER_ADDR'] = '127.0.0.1';
280
  $_SERVER['SERVER_SOFTWARE'] = $server_software;
281 282
  $_SERVER['SERVER_NAME'] = 'localhost';
  $_SERVER['REQUEST_URI'] = $path .'/';
283
  $_SERVER['REQUEST_METHOD'] = 'GET';
284 285 286 287
  $_SERVER['SCRIPT_NAME'] = $path .'/index.php';
  $_SERVER['PHP_SELF'] = $path .'/index.php';
  $_SERVER['HTTP_USER_AGENT'] = 'Drupal command line';

288
  if (!empty($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on') {
289 290 291 292 293 294
    // Ensure that any and all environment variables are changed to https://.
    foreach ($_SERVER as $key => $value) {
      $_SERVER[$key] = str_replace('http://', 'https://', $_SERVER[$key]);
    }
  }

295
  chdir(realpath(__DIR__ . '/../..'));
296
  define('DRUPAL_ROOT', getcwd());
297
  require_once DRUPAL_ROOT . '/core/includes/bootstrap.inc';
298 299 300 301 302
}

/**
 * Execute a batch of tests.
 */
303 304
function simpletest_script_execute_batch($test_classes) {
  global $args, $test_ids;
305

306 307 308 309 310 311
  // Multi-process execution.
  $children = array();
  while (!empty($test_classes) || !empty($children)) {
    while (count($children) < $args['concurrency']) {
      if (empty($test_classes)) {
        break;
312
      }
313 314

      // Fork a child process.
315 316
      $test_id = db_insert('simpletest_test_id')->useDefaults(array('test_id'))->execute();
      $test_ids[] = $test_id;
317 318 319 320 321 322 323
      $test_class = array_shift($test_classes);
      $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";
        exit;
324 325
      }

326 327 328
      // Register our new child.
      $children[] = array(
        'process' => $process,
329
        'test_id' => $test_id,
330 331 332 333
        'class' => $test_class,
        'pipes' => $pipes,
      );
    }
334

335 336 337 338 339 340 341 342 343 344
    // 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']);
        if ($status['exitcode']) {
345
          echo 'FATAL ' . $child['class'] . ': test runner returned a non-zero error code (' . $status['exitcode'] . ').' . "\n";
346
        }
347 348 349 350
        // Free-up space by removing any potentially created resources.
        simpletest_script_cleanup($child['test_id'], $child['class'], $status['exitcode']);

        // Remove this child.
351
        unset($children[$cid]);
352 353 354 355 356
      }
    }
  }
}

357
/**
358
 * Bootstrap Drupal and run a single test.
359 360
 */
function simpletest_script_run_one_test($test_id, $test_class) {
361 362 363 364
  try {
    // Bootstrap Drupal.
    drupal_bootstrap(DRUPAL_BOOTSTRAP_FULL);

365 366
    simpletest_classloader_register();

367 368 369 370 371 372 373 374
    $test = new $test_class($test_id);
    $test->run();
    $info = $test->getInfo();

    $had_fails = (isset($test->results['#fail']) && $test->results['#fail'] > 0);
    $had_exceptions = (isset($test->results['#exception']) && $test->results['#exception'] > 0);
    $status = ($had_fails || $had_exceptions ? 'fail' : 'pass');
    simpletest_script_print($info['name'] . ' ' . _simpletest_format_summary_line($test->results) . "\n", simpletest_script_color_code($status));
375

376 377 378
    // Finished, kill this runner.
    exit(0);
  }
379 380
  // DrupalTestCase::run() catches exceptions already, so this is only reached
  // when an exception is thrown in the wrapping test runner environment.
381 382 383 384
  catch (Exception $e) {
    echo (string) $e;
    exit(1);
  }
385 386
}

387
/**
388 389 390 391 392 393
 * Return a command used to run a test in a separate process.
 *
 * @param $test_id
 *  The current test ID.
 * @param $test_class
 *  The name of the test class to run.
394
 */
395
function simpletest_script_command($test_id, $test_class) {
396
  global $args, $php;
397

398
  $command = escapeshellarg($php) . ' ' . escapeshellarg('./core/scripts/' . $args['script']) . ' --url ' . escapeshellarg($args['url']);
399 400
  if ($args['color']) {
    $command .= ' --color';
401
  }
402
  $command .= " --php " . escapeshellarg($php) . " --test-id $test_id --execute-test " . escapeshellarg($test_class);
403
  return $command;
404 405
}

406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 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 482
/**
 * 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) {
  // Retrieve the last database prefix used for testing.
  list($db_prefix, ) = simpletest_last_test_get($test_id);

  // 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.
  simpletest_log_read($test_id, $db_prefix, $test_class);

  // Check whether a test file directory was setup already.
  // @see prepareEnvironment()
  $public_files = variable_get('file_public_path', conf_path() . '/files');
  $test_directory = $public_files . '/simpletest/' . substr($db_prefix, 10);
  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;
      }
    }

    // Delete the test files directory.
    // simpletest_clean_temporary_directories() cannot be used here, since it
    // would also delete file directories of other tests that are potentially
    // running concurrently.
    file_unmanaged_delete_recursive($test_directory);
    $messages[] = "- Removed test files directory.";
  }

  // Clear out all database tables from the test.
  $count = 0;
  foreach (db_find_tables($db_prefix . '%') as $table) {
    db_drop_table($table);
    $count++;
  }
  if ($count) {
    $messages[] = "- " . format_plural($count, 'Removed 1 leftover table.', 'Removed @count leftover tables.');
  }

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

483
/**
484
 * Get list of tests based on arguments. If --all specified then
485 486 487 488 489 490 491 492 493 494 495
 * returns all available tests, otherwise reads list of tests.
 *
 * Will print error and exit if no valid tests were found.
 *
 * @return List of tests.
 */
function simpletest_script_get_test_list() {
  global $args, $all_tests, $groups;

  $test_list = array();
  if ($args['all']) {
496
    $test_list = $all_tests;
497 498
  }
  else {
499
    if ($args['class']) {
500 501
      // Check for valid class names.
      foreach ($args['test_names'] as $class_name) {
502
        if (in_array($class_name, $all_tests)) {
503 504 505 506
          $test_list[] = $class_name;
        }
      }
    }
507
    elseif ($args['file']) {
508 509
      $files = array();
      foreach ($args['test_names'] as $file) {
510
        $files[drupal_realpath($file)] = 1;
511
      }
512

513
      // Check for valid class names.
514
      foreach ($all_tests as $class_name) {
515 516 517 518 519 520 521
        $refclass = new ReflectionClass($class_name);
        $file = $refclass->getFileName();
        if (isset($files[$file])) {
          $test_list[] = $class_name;
        }
      }
    }
522 523 524 525
    else {
      // Check for valid group names and get all valid classes in group.
      foreach ($args['test_names'] as $group_name) {
        if (isset($groups[$group_name])) {
526
          foreach ($groups[$group_name] as $class_name => $info) {
527 528 529 530 531
            $test_list[] = $class_name;
          }
        }
      }
    }
532
  }
533

534 535 536 537 538
  if (empty($test_list)) {
    simpletest_script_print_error('No valid tests were specified.');
    exit;
  }
  return $test_list;
539 540
}

541 542 543 544
/**
 * Initialize the reporter.
 */
function simpletest_script_reporter_init() {
545 546 547 548 549 550 551
  global $args, $all_tests, $test_list, $results_map;

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

553 554 555 556
  echo "\n";
  echo "Drupal test run\n";
  echo "---------------\n";
  echo "\n";
557

558 559 560 561 562 563 564
  // 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";
    foreach ($test_list as $class_name) {
565
      $info = call_user_func(array($class_name, 'getInfo'));
566 567 568
      echo " - " . $info['name'] . ' (' . $class_name . ')' . "\n";
    }
    echo "\n";
569
  }
570

571 572
  echo "Test run started:\n";
  echo " " . format_date($_SERVER['REQUEST_TIME'], 'long') . "\n";
573
  timer_start('run-tests');
574 575
  echo "\n";

576 577
  echo "Test summary\n";
  echo "------------\n";
578
  echo "\n";
579 580
}

581
/**
582
 * Display jUnit XML test results.
583
 */
584
function simpletest_script_reporter_write_xml_results() {
585
  global $args, $test_ids, $results_map;
586

587
  $results = db_query("SELECT * FROM {simpletest} WHERE test_id IN (:test_ids) ORDER BY test_class, message_id", array(':test_ids' => $test_ids));
588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654

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

  foreach ($results as $result) {
    if (isset($results_map[$result->status])) {
      if ($result->test_class != $test_class) {
        // We've moved onto a new class, so write the last classes results to a file:
        if (isset($xml_files[$test_class])) {
          file_put_contents($args['xml'] . '/' . $test_class . '.xml', $xml_files[$test_class]['doc']->saveXML());
          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);
      list($class, $name) = explode('->', $result->function, 2);
      $case->setAttribute('name', $name);

      // Passes get no further attention, but failures and exceptions get to add more detail:
      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])) {
    file_put_contents($args['xml'] . '/' . $test_class . '.xml', $xml_files[$test_class]['doc']->saveXML());
    unset($xml_files[$test_class]);
  }
}

/**
 * Stop the test timer.
 */
function simpletest_script_reporter_timer_stop() {
655
  echo "\n";
656 657
  $end = timer_stop('run-tests');
  echo "Test run duration: " . format_interval($end['time'] / 1000);
658
  echo "\n\n";
659 660 661 662 663 664
}

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

667 668
  if ($args['verbose']) {
    // Report results.
669 670
    echo "Detailed test results\n";
    echo "---------------------\n";
671

672
    $results = db_query("SELECT * FROM {simpletest} WHERE test_id IN (:test_ids) ORDER BY test_class, message_id", array(':test_ids' => $test_ids));
673
    $test_class = '';
674
    foreach ($results as $result) {
675 676 677 678 679
      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;
680

681 682 683
          // Print table header.
          echo "Status    Group      Filename          Line Function                            \n";
          echo "--------------------------------------------------------------------------------\n";
684 685 686 687 688
        }

        simpletest_script_format_result($result);
      }
    }
689 690 691
  }
}

692 693 694 695 696 697 698 699 700
/**
 * Format the result so that it fits within the default 80 character
 * terminal size.
 *
 * @param $result The result object to format.
 */
function simpletest_script_format_result($result) {
  global $results_map, $color;

701 702
  $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);
703 704

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

706 707 708 709 710
  $lines = explode("\n", wordwrap(trim(strip_tags($result->message)), 76));
  foreach ($lines as $line) {
    echo "    $line\n";
  }
}
711

712
/**
713 714 715 716
 * Print error message prefixed with "  ERROR: " and displayed in fail color
 * if color output is enabled.
 *
 * @param $message The message to print.
717
 */
718 719
function simpletest_script_print_error($message) {
  simpletest_script_print("  ERROR: $message\n", SIMPLETEST_SCRIPT_COLOR_FAIL);
720
}
721

722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755
/**
 * Print a message to the console, if color is enabled then the specified
 * color code will be used.
 *
 * @param $message The message to print.
 * @param $color_code The color code to use for coloring.
 */
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.
 *
 * @param $status The status string to get code for.
 * @return Color code.
 */
function simpletest_script_color_code($status) {
  switch ($status) {
    case 'pass':
      return SIMPLETEST_SCRIPT_COLOR_PASS;
    case 'fail':
      return SIMPLETEST_SCRIPT_COLOR_FAIL;
    case 'exception':
      return SIMPLETEST_SCRIPT_COLOR_EXCEPTION;
  }
  return 0; // Default formatting.
}