run-tests.sh 23.8 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;
}

if ($args['list']) {
51
  // Display all available tests.
52
53
  echo "\nAvailable test groups & classes\n";
  echo   "-------------------------------\n\n";
54
  $groups = simpletest_test_get_all();
55
56
  foreach ($groups as $group => $tests) {
    echo $group . "\n";
57
58
    foreach ($tests as $class => $info) {
      echo " - " . $info['name'] . ' (' . $class . ')' . "\n";
59
60
61
62
63
    }
  }
  exit;
}

64
65
$test_list = simpletest_script_get_test_list();

66
67
// Try to allocate unlimited time to run the tests.
drupal_set_time_limit(0);
68
69
70
71

simpletest_script_reporter_init();

// Execute tests.
72
simpletest_script_execute_batch(simpletest_script_get_test_list());
73

74
75
76
// Stop the timer.
simpletest_script_reporter_timer_stop();

77
78
79
// Display results before database is cleared.
simpletest_script_reporter_display_results();

80
81
82
83
if ($args['xml']) {
  simpletest_script_reporter_write_xml_results();
}

84
85
// Clean up all test results.
simpletest_clean_results_table();
86

87
88
89
// Test complete, exit.
exit;

90
91
92
93
94
/**
 * Print help text.
 */
function simpletest_script_help() {
  global $args;
95
96
97
98
99

  echo <<<EOF

Run Drupal tests from the shell.

100
101
Usage:        {$args['script']} [OPTIONS] <tests>
Example:      {$args['script']} Profile
102
103
104
105

All arguments are long options.

  --help      Print this page.
106
107
108

  --list      Display all available test groups.

109
110
111
  --clean     Cleans up database tables or directories from previous, failed,
              tests and then exits (no tests are run).

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

117
  --php       The absolute path to the PHP executable. Usually not needed.
118

119
120
  --concurrency [num]

121
              Run tests in parallel, up to [num] tests at a time.
122

123
  --all       Run all available tests.
124

125
126
127
  --module    Run all tests belonging to the specified module name.
              (e.g., 'node')

128
  --class     Run tests identified by specific class names, instead of group names.
129

130
  --file      Run tests identified by specific file names, instead of group names.
131
132
              Specify the path and the extension
              (i.e. 'core/modules/user/user.test').
133

134
135
136
137
138
  --xml       <path>

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

  --color     Output text format results with color highlighting.
139
140
141

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

142
143
  <test1>[,<test2>[,<test3> ...]]

144
              One or more tests to be run. By default, these are interpreted
145
              as the names of test groups as shown at
146
              admin/config/development/testing.
147
148
149
              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
150
151
              specific test classes whose test methods will be run. Tests must
              be separated by commas. Ignored if --all is specified.
152

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

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

164
165
166
167
168
169
170
171
172
173
174
175
176
/**
 * 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' => '',
177
    'php' => '',
178
179
    'concurrency' => 1,
    'all' => FALSE,
180
    'module' => FALSE,
181
    'class' => FALSE,
182
    'file' => FALSE,
183
184
185
186
    'color' => FALSE,
    'verbose' => FALSE,
    'test_names' => array(),
    // Used internally.
187
188
    'test-id' => 0,
    'execute-test' => '',
189
    'xml' => '',
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
  );

  // 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']);
        }
208
        // Clear extraneous values.
209
210
211
212
213
214
215
216
217
218
219
220
        $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);
221
      $count++;
222
    }
223
  }
224
225
226
227
228
229
230

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

231
  return array($args, $count);
232
233
}

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

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

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

    // 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';
    }
272
273
274
275
276
  }

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

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

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

/**
 * Execute a batch of tests.
 */
300
301
function simpletest_script_execute_batch($test_classes) {
  global $args, $test_ids;
302

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

      // Fork a child process.
312
313
      $test_id = db_insert('simpletest_test_id')->useDefaults(array('test_id'))->execute();
      $test_ids[] = $test_id;
314
315
316
317
318
319
320
      $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;
321
322
      }

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

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

        // Remove this child.
348
        unset($children[$cid]);
349
350
351
352
353
      }
    }
  }
}

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

362
363
    simpletest_classloader_register();

364
365
366
367
368
369
370
371
    $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));
372

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

384
/**
385
386
387
388
389
390
 * 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.
391
 */
392
function simpletest_script_command($test_id, $test_class) {
393
  global $args, $php;
394

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

403
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
/**
 * 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";
  }
}

480
/**
481
 * Get list of tests based on arguments. If --all specified then
482
483
484
485
486
487
488
 * 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() {
489
  global $args;
490
491
492

  $test_list = array();
  if ($args['all']) {
493
494
495
496
497
    $groups = simpletest_test_get_all();
    $all_tests = array();
    foreach ($groups as $group => $tests) {
      $all_tests = array_merge($all_tests, array_keys($tests));
    }
498
    $test_list = $all_tests;
499
500
  }
  else {
501
    if ($args['class']) {
502
      foreach ($args['test_names'] as $class_name) {
503
504
505
506
507
508
509
510
511
512
513
514
515
        $test_list[] = $class_name;
      }
    }
    elseif ($args['module']) {
      $modules = drupal_system_listing('/^' . DRUPAL_PHP_FUNCTION_PATTERN . '\.module$/', 'modules', 'name', 0);
      foreach ($args['test_names'] as $module) {
        // PSR-0 only.
        $dir = dirname($modules[$module]->uri) . "/lib/Drupal/$module/Tests";
        $files = file_scan_directory($dir, '@\.php$@', array(
          'key' => 'name',
          'recurse' => TRUE,
        ));
        $test_list = array_merge($test_list, array_keys($files));
516
517
      }
    }
518
    elseif ($args['file']) {
519
      // Extract test case class names from specified files.
520
      foreach ($args['test_names'] as $file) {
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
        if (!file_exists($file)) {
          simpletest_script_print_error('File not found: ' . $file);
          exit;
        }
        $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) {
            $test_list[] = $namespace . '\\' . $class_name;
          }
541
542
543
        }
      }
    }
544
    else {
545
      $groups = simpletest_test_get_all();
546
      foreach ($args['test_names'] as $group_name) {
547
        $test_list = array_merge($test_list, array_keys($groups[$group_name]));
548
549
      }
    }
550
  }
551

552
553
554
555
556
  if (empty($test_list)) {
    simpletest_script_print_error('No valid tests were specified.');
    exit;
  }
  return $test_list;
557
558
}

559
560
561
562
/**
 * Initialize the reporter.
 */
function simpletest_script_reporter_init() {
563
  global $args, $test_list, $results_map;
564
565
566
567
568
569

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

571
572
573
574
  echo "\n";
  echo "Drupal test run\n";
  echo "---------------\n";
  echo "\n";
575

576
577
578
579
580
581
582
  // 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) {
583
      $info = call_user_func(array($class_name, 'getInfo'));
584
585
586
      echo " - " . $info['name'] . ' (' . $class_name . ')' . "\n";
    }
    echo "\n";
587
  }
588

589
590
  echo "Test run started:\n";
  echo " " . format_date($_SERVER['REQUEST_TIME'], 'long') . "\n";
591
  timer_start('run-tests');
592
593
  echo "\n";

594
595
  echo "Test summary\n";
  echo "------------\n";
596
  echo "\n";
597
598
}

599
/**
600
 * Display jUnit XML test results.
601
 */
602
function simpletest_script_reporter_write_xml_results() {
603
  global $args, $test_ids, $results_map;
604

605
  $results = db_query("SELECT * FROM {simpletest} WHERE test_id IN (:test_ids) ORDER BY test_class, message_id", array(':test_ids' => $test_ids));
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
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672

  $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() {
673
  echo "\n";
674
675
  $end = timer_stop('run-tests');
  echo "Test run duration: " . format_interval($end['time'] / 1000);
676
  echo "\n\n";
677
678
679
680
681
682
}

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

685
686
  if ($args['verbose']) {
    // Report results.
687
688
    echo "Detailed test results\n";
    echo "---------------------\n";
689

690
    $results = db_query("SELECT * FROM {simpletest} WHERE test_id IN (:test_ids) ORDER BY test_class, message_id", array(':test_ids' => $test_ids));
691
    $test_class = '';
692
    foreach ($results as $result) {
693
694
695
696
697
      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;
698

699
700
701
          // Print table header.
          echo "Status    Group      Filename          Line Function                            \n";
          echo "--------------------------------------------------------------------------------\n";
702
703
704
705
706
        }

        simpletest_script_format_result($result);
      }
    }
707
708
709
  }
}

710
711
712
713
714
715
716
717
718
/**
 * 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;

719
720
  $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);
721
722

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

724
725
726
727
728
  $lines = explode("\n", wordwrap(trim(strip_tags($result->message)), 76));
  foreach ($lines as $line) {
    echo "    $line\n";
  }
}
729

730
/**
731
732
733
734
 * Print error message prefixed with "  ERROR: " and displayed in fail color
 * if color output is enabled.
 *
 * @param $message The message to print.
735
 */
736
737
function simpletest_script_print_error($message) {
  simpletest_script_print("  ERROR: $message\n", SIMPLETEST_SCRIPT_COLOR_FAIL);
738
}
739

740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
/**
 * 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.
}