run-tests.sh 20 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
}
24 25
else {
  // Run administrative functions as CLI.
26
  simpletest_script_init(NULL);
27
}
28

29
// Bootstrap to perform initial validation or other operations.
30 31 32 33 34 35 36 37 38 39 40 41 42
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'));
43
  foreach ($messages as $text) {
44 45 46 47 48 49
    echo " - " . $text . "\n";
  }
  exit;
}

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

if ($args['list']) {
58
  // Display all available tests.
59 60 61 62
  echo "\nAvailable test groups & classes\n";
  echo   "-------------------------------\n\n";
  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();

// Setup database for test results.
78
$test_id = db_insert('simpletest_test_id')->useDefaults(array('test_id'))->execute();
79 80

// Execute tests.
81
simpletest_script_execute_batch($test_id, simpletest_script_get_test_list());
82

83 84 85 86 87 88
// Retrieve the last database prefix used for testing and the last test class
// that was run from. Use the information to read the lgo file in case any
// fatal errors caused the test to crash.
list($last_prefix, $last_test_class) = simpletest_last_test_get($test_id);
simpletest_log_read($test_id, $last_prefix, $last_test_class);

89 90 91
// Stop the timer.
simpletest_script_reporter_timer_stop();

92 93 94
// Display results before database is cleared.
simpletest_script_reporter_display_results();

95 96 97 98
if ($args['xml']) {
  simpletest_script_reporter_write_xml_results();
}

99
// Cleanup our test results.
100
simpletest_clean_results_table($test_id);
101

102 103 104
// Test complete, exit.
exit;

105 106 107 108 109
/**
 * Print help text.
 */
function simpletest_script_help() {
  global $args;
110 111 112 113 114

  echo <<<EOF

Run Drupal tests from the shell.

115 116
Usage:        {$args['script']} [OPTIONS] <tests>
Example:      {$args['script']} Profile
117 118 119 120

All arguments are long options.

  --help      Print this page.
121 122 123

  --list      Display all available test groups.

124 125 126
  --clean     Cleans up database tables or directories from previous, failed,
              tests and then exits (no tests are run).

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

132
  --php       The absolute path to the PHP executable. Usually not needed.
133

134 135
  --concurrency [num]

136
              Run tests in parallel, up to [num] tests at a time.
137

138
  --all       Run all available tests.
139

140
  --class     Run tests identified by specific class names, instead of group names.
141

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

146 147 148 149 150
  --xml       <path>

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

  --color     Output text format results with color highlighting.
151 152 153

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

154 155
  <test1>[,<test2>[,<test3> ...]]

156
              One or more tests to be run. By default, these are interpreted
157
              as the names of test groups as shown at
158
              ?q=admin/config/development/testing.
159 160 161
              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
162 163
              specific test classes whose test methods will be run. Tests must
              be separated by commas. Ignored if --all is specified.
164

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

168
sudo -u [wwwrun|www-data|etc] php ./core/scripts/{$args['script']}
169
  --url http://example.com/ --all
170
sudo -u [wwwrun|www-data|etc] php ./core/scripts/{$args['script']}
171
  --url http://example.com/ --class BlockTestCase
172 173 174 175
\n
EOF;
}

176 177 178 179 180 181 182 183 184 185 186 187 188
/**
 * 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' => '',
189
    'php' => '',
190 191 192
    'concurrency' => 1,
    'all' => FALSE,
    'class' => FALSE,
193
    'file' => FALSE,
194 195 196 197
    'color' => FALSE,
    'verbose' => FALSE,
    'test_names' => array(),
    // Used internally.
198 199
    'test-id' => 0,
    'execute-test' => '',
200
    'xml' => '',
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
  );

  // 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']);
        }
219
        // Clear extraneous values.
220 221 222 223 224 225 226 227 228 229 230 231
        $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);
232
      $count++;
233
    }
234
  }
235 236 237 238 239 240 241

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

242
  return array($args, $count);
243 244
}

245 246 247
/**
 * Initialize script variables and perform general setup requirements.
 */
248
function simpletest_script_init($server_software) {
249 250 251 252
  global $args, $php;

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

  // Get url from arguments.
  if (!empty($args['url'])) {
    $parsed_url = parse_url($args['url']);
275
    $host = $parsed_url['host'] . (isset($parsed_url['port']) ? ':' . $parsed_url['port'] : '');
276
    $path = isset($parsed_url['path']) ? $parsed_url['path'] : '';
277 278 279 280 281 282

    // 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';
    }
283 284 285 286 287
  }

  $_SERVER['HTTP_HOST'] = $host;
  $_SERVER['REMOTE_ADDR'] = '127.0.0.1';
  $_SERVER['SERVER_ADDR'] = '127.0.0.1';
288
  $_SERVER['SERVER_SOFTWARE'] = $server_software;
289 290
  $_SERVER['SERVER_NAME'] = 'localhost';
  $_SERVER['REQUEST_URI'] = $path .'/';
291
  $_SERVER['REQUEST_METHOD'] = 'GET';
292 293 294 295
  $_SERVER['SCRIPT_NAME'] = $path .'/index.php';
  $_SERVER['PHP_SELF'] = $path .'/index.php';
  $_SERVER['HTTP_USER_AGENT'] = 'Drupal command line';

296
  if (!empty($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on') {
297 298 299 300 301 302
    // Ensure that any and all environment variables are changed to https://.
    foreach ($_SERVER as $key => $value) {
      $_SERVER[$key] = str_replace('http://', 'https://', $_SERVER[$key]);
    }
  }

303
  chdir(realpath(__DIR__ . '/../..'));
304
  define('DRUPAL_ROOT', getcwd());
305
  require_once DRUPAL_ROOT . '/core/includes/bootstrap.inc';
306 307 308 309 310
}

/**
 * Execute a batch of tests.
 */
311
function simpletest_script_execute_batch($test_id, $test_classes) {
312 313
  global $args;

314 315 316 317 318 319
  // Multi-process execution.
  $children = array();
  while (!empty($test_classes) || !empty($children)) {
    while (count($children) < $args['concurrency']) {
      if (empty($test_classes)) {
        break;
320
      }
321 322 323 324 325 326 327 328 329

      // Fork a child process.
      $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;
330 331
      }

332 333 334 335 336 337 338
      // Register our new child.
      $children[] = array(
        'process' => $process,
        'class' => $test_class,
        'pipes' => $pipes,
      );
    }
339

340 341 342 343 344 345 346 347 348 349 350
    // 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']) {
          echo 'FATAL ' . $test_class . ': test runner returned a non-zero error code (' . $status['exitcode'] . ').' . "\n";
351
        }
352
        unset($children[$cid]);
353 354 355 356 357
      }
    }
  }
}

358
/**
359
 * Bootstrap Drupal and run a single test.
360 361
 */
function simpletest_script_run_one_test($test_id, $test_class) {
362 363 364 365 366 367 368 369 370 371 372 373
  try {
    // Bootstrap Drupal.
    drupal_bootstrap(DRUPAL_BOOTSTRAP_FULL);

    $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));
374

375 376 377 378 379 380 381
    // Finished, kill this runner.
    exit(0);
  }
  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 400
  $command .= " --php " . escapeshellarg($php) . " --test-id $test_id --execute-test $test_class";
  return $command;
401 402
}

403
/**
404
 * Get list of tests based on arguments. If --all specified then
405 406 407 408 409 410 411 412 413 414 415
 * 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']) {
416
    $test_list = $all_tests;
417 418
  }
  else {
419
    if ($args['class']) {
420 421
      // Check for valid class names.
      foreach ($args['test_names'] as $class_name) {
422
        if (in_array($class_name, $all_tests)) {
423 424 425 426
          $test_list[] = $class_name;
        }
      }
    }
427
    elseif ($args['file']) {
428 429
      $files = array();
      foreach ($args['test_names'] as $file) {
430
        $files[drupal_realpath($file)] = 1;
431
      }
432

433
      // Check for valid class names.
434
      foreach ($all_tests as $class_name) {
435 436 437 438 439 440 441
        $refclass = new ReflectionClass($class_name);
        $file = $refclass->getFileName();
        if (isset($files[$file])) {
          $test_list[] = $class_name;
        }
      }
    }
442 443 444 445
    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])) {
446
          foreach ($groups[$group_name] as $class_name => $info) {
447 448 449 450 451
            $test_list[] = $class_name;
          }
        }
      }
    }
452
  }
453

454 455 456 457 458
  if (empty($test_list)) {
    simpletest_script_print_error('No valid tests were specified.');
    exit;
  }
  return $test_list;
459 460
}

461 462 463 464
/**
 * Initialize the reporter.
 */
function simpletest_script_reporter_init() {
465 466 467 468 469 470 471
  global $args, $all_tests, $test_list, $results_map;

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

473 474 475 476
  echo "\n";
  echo "Drupal test run\n";
  echo "---------------\n";
  echo "\n";
477

478 479 480 481 482 483 484
  // 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) {
485
      $info = call_user_func(array($class_name, 'getInfo'));
486 487 488
      echo " - " . $info['name'] . ' (' . $class_name . ')' . "\n";
    }
    echo "\n";
489
  }
490

491 492
  echo "Test run started:\n";
  echo " " . format_date($_SERVER['REQUEST_TIME'], 'long') . "\n";
493
  timer_start('run-tests');
494 495
  echo "\n";

496 497
  echo "Test summary\n";
  echo "------------\n";
498
  echo "\n";
499 500
}

501
/**
502
 * Display jUnit XML test results.
503
 */
504
function simpletest_script_reporter_write_xml_results() {
505
  global $args, $test_id, $results_map;
506

507 508 509 510 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 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
  $results = db_query("SELECT * FROM {simpletest} WHERE test_id = :test_id ORDER BY test_class, message_id", array(':test_id' => $test_id));

  $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() {
575
  echo "\n";
576 577
  $end = timer_stop('run-tests');
  echo "Test run duration: " . format_interval($end['time'] / 1000);
578
  echo "\n\n";
579 580 581 582 583 584 585
}

/**
 * Display test results.
 */
function simpletest_script_reporter_display_results() {
  global $args, $test_id, $results_map;
586

587 588
  if ($args['verbose']) {
    // Report results.
589 590
    echo "Detailed test results\n";
    echo "---------------------\n";
591

592
    $results = db_query("SELECT * FROM {simpletest} WHERE test_id = :test_id ORDER BY test_class, message_id", array(':test_id' => $test_id));
593
    $test_class = '';
594
    foreach ($results as $result) {
595 596 597 598 599
      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;
600 601 602 603

  // Print table header.
  echo "Status    Group      Filename          Line Function                            \n";
  echo "--------------------------------------------------------------------------------\n";
604 605 606 607 608
        }

        simpletest_script_format_result($result);
      }
    }
609 610 611
  }
}

612 613 614 615 616 617 618 619 620
/**
 * 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;

621 622
  $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);
623 624

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

626 627 628 629 630
  $lines = explode("\n", wordwrap(trim(strip_tags($result->message)), 76));
  foreach ($lines as $line) {
    echo "    $line\n";
  }
}
631

632
/**
633 634 635 636
 * Print error message prefixed with "  ERROR: " and displayed in fail color
 * if color output is enabled.
 *
 * @param $message The message to print.
637
 */
638 639
function simpletest_script_print_error($message) {
  simpletest_script_print("  ERROR: $message\n", SIMPLETEST_SCRIPT_COLOR_FAIL);
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 673 674 675
/**
 * 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.
}