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

require_once __DIR__ . '/../vendor/autoload.php';

9
use Drupal\Core\StreamWrapper\PublicStream;
10

11
12
13
const SIMPLETEST_SCRIPT_COLOR_PASS = 32; // Green.
const SIMPLETEST_SCRIPT_COLOR_FAIL = 31; // Red.
const SIMPLETEST_SCRIPT_COLOR_EXCEPTION = 33; // Brown.
14
15
16
17
18
19
20
21
22

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

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

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

34
// Bootstrap to perform initial validation or other operations.
35
drupal_bootstrap(DRUPAL_BOOTSTRAP_CODE);
36
37
simpletest_classloader_register();

38
if (!\Drupal::moduleHandler()->moduleExists('simpletest')) {
39
40
41
42
43
44
45
46
47
48
49
  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'));
50
  foreach ($messages as $text) {
51
52
53
54
55
56
    echo " - " . $text . "\n";
  }
  exit;
}

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

70
71
$test_list = simpletest_script_get_test_list();

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

simpletest_script_reporter_init();

// Execute tests.
78
79
for ($i = 0; $i < $args['repeat']; $i++) {
  simpletest_script_execute_batch($test_list);
80
}
81

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

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

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

92
// Clean up all test results.
93
94
95
if (!$args['keep-results']) {
  simpletest_clean_results_table();
}
96

97
98
99
// Test complete, exit.
exit;

100
101
102
103
104
/**
 * Print help text.
 */
function simpletest_script_help() {
  global $args;
105
106
107
108
109

  echo <<<EOF

Run Drupal tests from the shell.

110
111
Usage:        {$args['script']} [OPTIONS] <tests>
Example:      {$args['script']} Profile
112
113
114
115

All arguments are long options.

  --help      Print this page.
116
117
118

  --list      Display all available test groups.

119
120
121
  --clean     Cleans up database tables or directories from previous, failed,
              tests and then exits (no tests are run).

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

127
  --php       The absolute path to the PHP executable. Usually not needed.
128

129
130
  --concurrency [num]

131
              Run tests in parallel, up to [num] tests at a time.
132

133
  --all       Run all available tests.
134

135
136
137
  --module    Run all tests belonging to the specified module name.
              (e.g., 'node')

138
  --class     Run tests identified by specific class names, instead of group names.
139

140
  --file      Run tests identified by specific file names, instead of group names.
141
142
              Specify the path and the extension
              (i.e. 'core/modules/user/user.test').
143

144
145
146
147
148
  --xml       <path>

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

  --color     Output text format results with color highlighting.
149
150
151

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

152
153
154
155
156
  --keep-results

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

157
158
159
160
  --repeat    Number of times to repeat the test.

  --die-on-fail

161
162
163
164
              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.
165

166
167
  <test1>[,<test2>[,<test3> ...]]

168
              One or more tests to be run. By default, these are interpreted
169
              as the names of test groups as shown at
170
              admin/config/development/testing.
171
172
173
              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
174
175
              specific test classes whose test methods will be run. Tests must
              be separated by commas. Ignored if --all is specified.
176

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

180
sudo -u [wwwrun|www-data|etc] php ./core/scripts/{$args['script']}
181
  --url http://example.com/ --all
182
sudo -u [wwwrun|www-data|etc] php ./core/scripts/{$args['script']}
183
  --url http://example.com/ --class "Drupal\block\Tests\BlockTest"
184
185
186
187
\n
EOF;
}

188
189
190
191
192
193
194
195
196
197
198
199
200
/**
 * 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' => '',
201
    'php' => '',
202
203
    'concurrency' => 1,
    'all' => FALSE,
204
    'module' => FALSE,
205
    'class' => FALSE,
206
    'file' => FALSE,
207
208
    'color' => FALSE,
    'verbose' => FALSE,
209
    'keep-results' => FALSE,
210
    'test_names' => array(),
211
212
    'repeat' => 1,
    'die-on-fail' => FALSE,
213
    // Used internally.
214
215
    'test-id' => 0,
    'execute-test' => '',
216
    'xml' => '',
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
  );

  // 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']);
        }
235
        // Clear extraneous values.
236
237
238
239
240
241
242
243
244
245
246
247
        $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);
248
      $count++;
249
    }
250
  }
251
252
253
254
255
256
257

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

258
  return array($args, $count);
259
260
}

261
262
263
/**
 * Initialize script variables and perform general setup requirements.
 */
264
function simpletest_script_init($server_software) {
265
266
267
268
  global $args, $php;

  $host = 'localhost';
  $path = '';
269
  // Determine location of php command automatically, unless a command line argument is supplied.
270
  if (!empty($args['php'])) {
271
272
    $php = $args['php'];
  }
273
  elseif ($php_env = getenv('_')) {
274
    // '_' is an environment variable set by the shell. It contains the command that was executed.
275
    $php = $php_env;
276
  }
277
  elseif ($sudo = getenv('SUDO_COMMAND')) {
278
279
    // 'SUDO_COMMAND' is an environment variable set by the sudo program.
    // Extract only the PHP interpreter, not the rest of the command.
280
    list($php, ) = explode(' ', $sudo, 2);
281
282
  }
  else {
283
    simpletest_script_print_error('Unable to automatically determine the path to the PHP interpreter. Supply the --php command line argument.');
284
    simpletest_script_help();
285
286
    exit();
  }
287

288
  // Get URL from arguments.
289
290
  if (!empty($args['url'])) {
    $parsed_url = parse_url($args['url']);
291
    $host = $parsed_url['host'] . (isset($parsed_url['port']) ? ':' . $parsed_url['port'] : '');
292
293
294
295
    $path = isset($parsed_url['path']) ? rtrim($parsed_url['path']) : '';
    if ($path == '/') {
      $path = '';
    }
296
    // If the passed URL schema is 'https' then setup the $_SERVER variables
297
    // properly so that testing will run under HTTPS.
298
299
300
    if ($parsed_url['scheme'] == 'https') {
      $_SERVER['HTTPS'] = 'on';
    }
301
302
303
304
305
  }

  $_SERVER['HTTP_HOST'] = $host;
  $_SERVER['REMOTE_ADDR'] = '127.0.0.1';
  $_SERVER['SERVER_ADDR'] = '127.0.0.1';
306
  $_SERVER['SERVER_SOFTWARE'] = $server_software;
307
308
  $_SERVER['SERVER_NAME'] = 'localhost';
  $_SERVER['REQUEST_URI'] = $path .'/';
309
  $_SERVER['REQUEST_METHOD'] = 'GET';
310
  $_SERVER['SCRIPT_NAME'] = $path .'/index.php';
311
  $_SERVER['SCRIPT_FILENAME'] = $path .'/index.php';
312
313
314
  $_SERVER['PHP_SELF'] = $path .'/index.php';
  $_SERVER['HTTP_USER_AGENT'] = 'Drupal command line';

315
  if (!empty($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on') {
316
317
318
319
320
321
    // Ensure that any and all environment variables are changed to https://.
    foreach ($_SERVER as $key => $value) {
      $_SERVER[$key] = str_replace('http://', 'https://', $_SERVER[$key]);
    }
  }

322
  chdir(realpath(__DIR__ . '/../..'));
323
  require_once dirname(__DIR__) . '/includes/bootstrap.inc';
324
325
}

326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
/**
 * Get all available tests from simpletest and PHPUnit.
 *
 * @return
 *   An array of tests keyed with the groups specified in each of the tests
 *   getInfo() method and then keyed by the test class. An example of the array
 *   structure is provided below.
 *
 *   @code
 *     $groups['Block'] => array(
 *       'BlockTestCase' => array(
 *         'name' => 'Block functionality',
 *         'description' => 'Add, edit and delete custom block...',
 *         'group' => 'Block',
 *       ),
 *     );
 *   @endcode
 */
function simpletest_script_get_all_tests() {
  $tests = simpletest_test_get_all();
  $tests['PHPUnit'] = simpletest_phpunit_get_available_tests();
  return $tests;
}

350
351
352
/**
 * Execute a batch of tests.
 */
353
function simpletest_script_execute_batch($test_classes) {
354
  global $args, $test_ids;
355

356
357
  // Multi-process execution.
  $children = array();
358
  while (!empty($test_classes) || !empty($children)) {
359
    while (count($children) < $args['concurrency']) {
360
      if (empty($test_classes)) {
361
        break;
362
      }
363

364
365
      $test_id = db_insert('simpletest_test_id')->useDefaults(array('test_id'))->execute();
      $test_ids[] = $test_id;
366

367
      $test_class = array_shift($test_classes);
368
369
      // Process phpunit tests immediately since they are fast and we don't need
      // to fork for them.
370
371
      if (is_subclass_of($test_class, 'Drupal\Tests\UnitTestCase')) {
        simpletest_script_run_phpunit($test_id, $test_class);
372
373
374
375
        continue;
      }

      // Fork a child process.
376
377
378
379
380
381
      $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;
382
383
      }

384
385
386
      // Register our new child.
      $children[] = array(
        'process' => $process,
387
        'test_id' => $test_id,
388
389
390
391
        'class' => $test_class,
        'pipes' => $pipes,
      );
    }
392

393
394
395
396
397
398
399
400
401
402
    // 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']) {
403
          echo 'FATAL ' . $child['class'] . ': test runner returned a non-zero error code (' . $status['exitcode'] . ').' . "\n";
404
405
          if ($args['die-on-fail']) {
            list($db_prefix, ) = simpletest_last_test_get($child['test_id']);
406
            $public_files = PublicStream::basePath();
407
408
            $test_directory = $public_files . '/simpletest/' . substr($db_prefix, 10);
            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";
409
410
411
            $args['keep-results'] = TRUE;
            // Exit repeat loop immediately.
            $args['repeat'] = -1;
412
          }
413
        }
414
        // Free-up space by removing any potentially created resources.
415
416
417
        if (!$args['keep-results']) {
          simpletest_script_cleanup($child['test_id'], $child['class'], $status['exitcode']);
        }
418
419

        // Remove this child.
420
        unset($children[$cid]);
421
422
423
424
425
      }
    }
  }
}

426
427
428
/**
 * Run a group of phpunit tests.
 */
429
430
function simpletest_script_run_phpunit($test_id, $class) {
  $results = simpletest_run_phpunit_tests($test_id, array($class));
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
  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;
      case 'fail':
        $summaries[$result['test_class']]['#fail']++;
        break;
      case 'exception':
        $summaries[$result['test_class']]['#exception']++;
        break;
      case 'debug':
457
        $summaries[$result['test_class']]['#debug']++;
458
459
460
461
462
463
464
465
466
467
468
469
470
        break;
    }
  }

  foreach ($summaries as $class => $summary) {
    $had_fails = $summary['#fail'] > 0;
    $had_exceptions = $summary['#exception'] > 0;
    $status = ($had_fails || $had_exceptions ? 'fail' : 'pass');
    $info = call_user_func(array($class, 'getInfo'));
    simpletest_script_print($info['name'] . ' ' . _simpletest_format_summary_line($summary) . "\n", simpletest_script_color_code($status));
  }
}

471
/**
472
 * Bootstrap Drupal and run a single test.
473
474
 */
function simpletest_script_run_one_test($test_id, $test_class) {
475
476
  global $args, $conf;

477
478
  try {
    // Bootstrap Drupal.
479
    drupal_bootstrap(DRUPAL_BOOTSTRAP_CODE);
480

481
482
    simpletest_classloader_register();

483
484
485
486
    // Override configuration according to command line parameters.
    $conf['simpletest.settings']['verbose'] = $args['verbose'];
    $conf['simpletest.settings']['clear_results'] = !$args['keep-results'];

487
    $test = new $test_class($test_id);
488
    $test->dieOnFail = (bool) $args['die-on-fail'];
489
490
491
492
493
494
495
    $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));
496

497
498
499
    // Finished, kill this runner.
    exit(0);
  }
500
501
  // DrupalTestCase::run() catches exceptions already, so this is only reached
  // when an exception is thrown in the wrapping test runner environment.
502
503
504
505
  catch (Exception $e) {
    echo (string) $e;
    exit(1);
  }
506
507
}

508
/**
509
510
511
512
513
514
 * 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.
515
 */
516
function simpletest_script_command($test_id, $test_class) {
517
  global $args, $php;
518

519
520
521
522
  $command = escapeshellarg($php) . ' ' . escapeshellarg('./core/scripts/' . $args['script']);
  $command .= ' --url ' . escapeshellarg($args['url']);
  $command .= ' --php ' . escapeshellarg($php);
  $command .= " --test-id $test_id";
523
  foreach (array('verbose', 'keep-results', 'color', 'die-on-fail') as $arg) {
524
525
526
    if ($args[$arg]) {
      $command .= ' --' . $arg;
    }
527
  }
528
529
  // --execute-test and class name needs to come last.
  $command .= ' --execute-test ' . escapeshellarg($test_class);
530
  return $command;
531
532
}

533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
/**
 * 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()
575
  $public_files = PublicStream::basePath();
576
577
578
579
580
581
582
583
584
585
586
587
588
589
  $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.
590
    file_unmanaged_delete_recursive($test_directory, array('Drupal\simpletest\TestBase', 'filePreDeleteCallback'));
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
    $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";
  }
}

610
/**
611
 * Get list of tests based on arguments. If --all specified then
612
613
614
615
616
617
618
 * 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() {
619
  global $args;
620
621
622

  $test_list = array();
  if ($args['all']) {
623
    $groups = simpletest_script_get_all_tests();
624
625
    $all_tests = array();
    foreach ($groups as $group => $tests) {
626
      $all_tests = array_merge($all_tests, array_keys($tests));
627
    }
628
    $test_list = $all_tests;
629
630
  }
  else {
631
    if ($args['class']) {
632
      foreach ($args['test_names'] as $class_name) {
633
634
635
636
637
638
639
640
641
642
643
644
        $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,
        ));
645
646
647
        foreach ($files as $test => $file) {
          $test_list[] = "Drupal\\$module\\Tests\\$test";
        }
648
649
      }
    }
650
    elseif ($args['file']) {
651
      // Extract test case class names from specified files.
652
      foreach ($args['test_names'] as $file) {
653
654
655
656
657
658
659
660
661
662
663
664
665
666
        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) {
667
          $test_list = array_merge($test_list, $matches[1]);
668
669
670
        }
        else {
          foreach ($matches[1] as $class_name) {
671
            $test_list[] = $namespace . '\\' . $class_name;
672
          }
673
674
675
        }
      }
    }
676
    else {
677
      $groups = simpletest_script_get_all_tests();
678
      foreach ($args['test_names'] as $group_name) {
679
        $test_list = array_merge($test_list, array_keys($groups[$group_name]));
680
681
      }
    }
682
  }
683

684
685
686
687
688
  if (empty($test_list)) {
    simpletest_script_print_error('No valid tests were specified.');
    exit;
  }
  return $test_list;
689
690
}

691
692
693
694
/**
 * Initialize the reporter.
 */
function simpletest_script_reporter_init() {
695
  global $args, $test_list, $results_map;
696
697
698
699
700
701

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

703
704
705
706
  echo "\n";
  echo "Drupal test run\n";
  echo "---------------\n";
  echo "\n";
707

708
709
710
711
712
713
  // 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";
714
715
716
    foreach ($test_list as $class_name) {
      $info = call_user_func(array($class_name, 'getInfo'));
      echo " - " . $info['name'] . ' (' . $class_name . ')' . "\n";
717
718
    }
    echo "\n";
719
  }
720

721
722
  echo "Test run started:\n";
  echo " " . format_date($_SERVER['REQUEST_TIME'], 'long') . "\n";
723
  timer_start('run-tests');
724
725
  echo "\n";

726
727
  echo "Test summary\n";
  echo "------------\n";
728
  echo "\n";
729
730
}

731
/**
732
 * Display jUnit XML test results.
733
 */
734
function simpletest_script_reporter_write_xml_results() {
735
  global $args, $test_ids, $results_map;
736

737
  $results = db_query("SELECT * FROM {simpletest} WHERE test_id IN (:test_ids) ORDER BY test_class, message_id", array(':test_ids' => $test_ids));
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
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804

  $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() {
805
  echo "\n";
806
807
  $end = timer_stop('run-tests');
  echo "Test run duration: " . format_interval($end['time'] / 1000);
808
  echo "\n\n";
809
810
811
812
813
814
}

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

817
818
  if ($args['verbose']) {
    // Report results.
819
820
    echo "Detailed test results\n";
    echo "---------------------\n";
821

822
    $results = db_query("SELECT * FROM {simpletest} WHERE test_id IN (:test_ids) ORDER BY test_class, message_id", array(':test_ids' => $test_ids));
823
    $test_class = '';
824
    foreach ($results as $result) {
825
826
827
828
829
      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;
830

831
832
833
          // Print table header.
          echo "Status    Group      Filename          Line Function                            \n";
          echo "--------------------------------------------------------------------------------\n";
834
835
836
837
838
        }

        simpletest_script_format_result($result);
      }
    }
839
840
841
  }
}

842
843
844
845
846
847
848
849
850
/**
 * 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;

851
852
  $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);
853
854

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

856
857
858
859
860
  $lines = explode("\n", wordwrap(trim(strip_tags($result->message)), 76));
  foreach ($lines as $line) {
    echo "    $line\n";
  }
}
861

862
/**
863
864
865
866
 * Print error message prefixed with "  ERROR: " and displayed in fail color
 * if color output is enabled.
 *
 * @param $message The message to print.
867
 */
868
869
function simpletest_script_print_error($message) {
  simpletest_script_print("  ERROR: $message\n", SIMPLETEST_SCRIPT_COLOR_FAIL);
870
}
871

872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
/**
 * 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.
}