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

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

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

18
$autoloader = require_once __DIR__ . '/../../autoload.php';
19

20 21 22
const SIMPLETEST_SCRIPT_COLOR_PASS = 32; // Green.
const SIMPLETEST_SCRIPT_COLOR_FAIL = 31; // Red.
const SIMPLETEST_SCRIPT_COLOR_EXCEPTION = 33; // Brown.
23 24 25

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

27 28 29 30
const SIMPLETEST_SCRIPT_EXIT_SUCCESS = 0;
const SIMPLETEST_SCRIPT_EXIT_FAILURE = 1;
const SIMPLETEST_SCRIPT_EXIT_EXCEPTION = 2;

31 32 33 34 35
// Set defaults and get overrides.
list($args, $count) = simpletest_script_parse_args();

if ($args['help'] || $count == 0) {
  simpletest_script_help();
36
  exit(($count == 0) ? SIMPLETEST_SCRIPT_EXIT_FAILURE : SIMPLETEST_SCRIPT_EXIT_SUCCESS);
37 38
}

39
simpletest_script_init();
40

41 42 43 44 45 46 47 48 49
try {
  $request = Request::createFromGlobals();
  $kernel = TestRunnerKernel::createFromRequest($request, $autoloader);
  $kernel->prepareLegacyRequest($request);
}
catch (Exception $e) {
  echo (string) $e;
  exit(SIMPLETEST_SCRIPT_EXIT_EXCEPTION);
}
50

51
if ($args['execute-test']) {
52
  simpletest_script_setup_database();
53
  simpletest_script_run_one_test($args['test-id'], $args['execute-test']);
54
  // Sub-process exited already; this is just for clarity.
55
  exit(SIMPLETEST_SCRIPT_EXIT_SUCCESS);
56
}
57

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

78
simpletest_script_setup_database(TRUE);
79 80

if ($args['clean']) {
81
  // Clean up left-over tables and directories.
82 83 84 85 86 87 88
  try {
    simpletest_clean_environment();
  }
  catch (Exception $e) {
    echo (string) $e;
    exit(SIMPLETEST_SCRIPT_EXIT_EXCEPTION);
  }
89 90 91
  echo "\nEnvironment cleaned.\n";

  // Get the status messages and print them.
92 93
  $messages = drupal_get_messages('status');
  foreach ($messages['status'] as $text) {
94 95
    echo " - " . $text . "\n";
  }
96
  exit(SIMPLETEST_SCRIPT_EXIT_SUCCESS);
97 98
}

99 100
$test_list = simpletest_script_get_test_list();

101 102
// Try to allocate unlimited time to run the tests.
drupal_set_time_limit(0);
103 104
simpletest_script_reporter_init();

105
$tests_to_run = array();
106
for ($i = 0; $i < $args['repeat']; $i++) {
107
  $tests_to_run = array_merge($tests_to_run, $test_list);
108
}
109

110
// Execute tests.
111
$status = simpletest_script_execute_batch($tests_to_run);
112

113 114 115
// Stop the timer.
simpletest_script_reporter_timer_stop();

116
// Display results before database is cleared.
117 118 119 120 121 122
if ($args['browser']) {
  simpletest_script_open_browser();
}
else {
  simpletest_script_reporter_display_results();
}
123

124 125 126 127
if ($args['xml']) {
  simpletest_script_reporter_write_xml_results();
}

128
// Clean up all test results.
129
if (!$args['keep-results']) {
130 131 132 133 134 135 136
  try {
    simpletest_clean_results_table();
  }
  catch (Exception $e) {
    echo (string) $e;
    exit(SIMPLETEST_SCRIPT_EXIT_EXCEPTION);
  }
137
}
138

139
// Test complete, exit.
140
exit($status);
141

142 143 144 145 146
/**
 * Print help text.
 */
function simpletest_script_help() {
  global $args;
147 148 149 150 151

  echo <<<EOF

Run Drupal tests from the shell.

152 153
Usage:        {$args['script']} [OPTIONS] <tests>
Example:      {$args['script']} Profile
154 155 156 157

All arguments are long options.

  --help      Print this page.
158 159 160

  --list      Display all available test groups.

161 162 163
  --clean     Cleans up database tables or directories from previous, failed,
              tests and then exits (no tests are run).

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

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

  --dburl     A URI denoting the database driver, credentials, server hostname,
179
              and database name to use in tests.
180 181
              Required when running tests without a Drupal installation that
              contains default database connection info in settings.php.
182 183 184 185
              Examples:
                mysql://username:password@localhost/databasename#table_prefix
                sqlite://localhost/relative/path/db.sqlite
                sqlite://localhost//absolute/path/db.sqlite
186

187
  --php       The absolute path to the PHP executable. Usually not needed.
188

189 190
  --concurrency [num]

191
              Run tests in parallel, up to [num] tests at a time.
192

193
  --all       Run all available tests.
194

195 196 197
  --module    Run all tests belonging to the specified module name.
              (e.g., 'node')

198
  --class     Run tests identified by specific class names, instead of group names.
199 200
              A specific test method can be added, for example,
              'Drupal\book\Tests\BookTest::testBookExport'.
201

202
  --file      Run tests identified by specific file names, instead of group names.
203 204
              Specify the path and the extension
              (i.e. 'core/modules/user/user.test').
205

206 207
  --directory Run all tests found within the specified file directory.

208 209 210 211 212
  --xml       <path>

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

  --color     Output text format results with color highlighting.
213 214 215

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

216 217 218 219 220
  --keep-results

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

221 222 223 224
  --repeat    Number of times to repeat the test.

  --die-on-fail

225 226 227 228
              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.
229

230 231 232 233
  --browser   Opens the results in the browser. This enforces --keep-results and
              if you want to also view any pages rendered in the simpletest
              browser you need to add --verbose to the command line.

234 235 236
  --non-html  Removes escaping from output. Useful for reading results on the
              CLI.

237 238
  <test1>[,<test2>[,<test3> ...]]

239
              One or more tests to be run. By default, these are interpreted
240
              as the names of test groups as shown at
241
              admin/config/development/testing.
242
              These group names typically correspond to module names like "User"
243
              or "Profile" or "System", but there is also a group "Database".
244
              If --class is specified then these are interpreted as the names of
245 246
              specific test classes whose test methods will be run. Tests must
              be separated by commas. Ignored if --all is specified.
247

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

251
sudo -u [wwwrun|www-data|etc] php ./core/scripts/{$args['script']}
252
  --url http://example.com/ --all
253
sudo -u [wwwrun|www-data|etc] php ./core/scripts/{$args['script']}
254
  --url http://example.com/ --class "Drupal\block\Tests\BlockTest"
255 256 257 258 259 260 261 262 263 264

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

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

265 266 267
EOF;
}

268 269 270 271 272 273 274 275 276 277 278 279 280
/**
 * 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' => '',
281 282
    'sqlite' => NULL,
    'dburl' => NULL,
283
    'php' => '',
284 285
    'concurrency' => 1,
    'all' => FALSE,
286
    'module' => NULL,
287
    'class' => FALSE,
288
    'file' => FALSE,
289
    'directory' => NULL,
290 291
    'color' => FALSE,
    'verbose' => FALSE,
292
    'keep-results' => FALSE,
293
    'test_names' => array(),
294 295
    'repeat' => 1,
    'die-on-fail' => FALSE,
296
    'browser' => FALSE,
297
    // Used internally.
298 299
    'test-id' => 0,
    'execute-test' => '',
300
    'xml' => '',
301
    'non-html' => FALSE,
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
  );

  // 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']);
        }
320
        // Clear extraneous values.
321 322 323 324 325 326
        $args['test_names'] = array();
        $count++;
      }
      else {
        // Argument not found in list.
        simpletest_script_print_error("Unknown argument '$arg'.");
327
        exit(SIMPLETEST_SCRIPT_EXIT_FAILURE);
328 329 330 331 332
      }
    }
    else {
      // Values found without an argument should be test names.
      $args['test_names'] += explode(',', $arg);
333
      $count++;
334
    }
335
  }
336 337 338 339

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

343 344 345
  if ($args['browser']) {
    $args['keep-results'] = TRUE;
  }
346
  return array($args, $count);
347 348
}

349 350 351
/**
 * Initialize script variables and perform general setup requirements.
 */
352
function simpletest_script_init() {
353 354 355 356
  global $args, $php;

  $host = 'localhost';
  $path = '';
357 358
  $port = '80';

359
  // Determine location of php command automatically, unless a command line argument is supplied.
360
  if (!empty($args['php'])) {
361 362
    $php = $args['php'];
  }
363
  elseif ($php_env = getenv('_')) {
364
    // '_' is an environment variable set by the shell. It contains the command that was executed.
365
    $php = $php_env;
366
  }
367
  elseif ($sudo = getenv('SUDO_COMMAND')) {
368 369
    // 'SUDO_COMMAND' is an environment variable set by the sudo program.
    // Extract only the PHP interpreter, not the rest of the command.
370
    list($php, ) = explode(' ', $sudo, 2);
371 372
  }
  else {
373
    simpletest_script_print_error('Unable to automatically determine the path to the PHP interpreter. Supply the --php command line argument.');
374
    simpletest_script_help();
375
    exit(SIMPLETEST_SCRIPT_EXIT_FAILURE);
376
  }
377

378
  // Get URL from arguments.
379 380
  if (!empty($args['url'])) {
    $parsed_url = parse_url($args['url']);
381
    $host = $parsed_url['host'] . (isset($parsed_url['port']) ? ':' . $parsed_url['port'] : '');
382
    $path = isset($parsed_url['path']) ? rtrim(rtrim($parsed_url['path']), '/') : '';
383
    $port = (isset($parsed_url['port']) ? $parsed_url['port'] : $port);
384 385 386
    if ($path == '/') {
      $path = '';
    }
387
    // If the passed URL schema is 'https' then setup the $_SERVER variables
388
    // properly so that testing will run under HTTPS.
389 390 391
    if ($parsed_url['scheme'] == 'https') {
      $_SERVER['HTTPS'] = 'on';
    }
392 393
  }

394 395 396 397 398 399 400 401 402 403 404
  if (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] === 'on') {
    $base_url = 'https://';
  }
  else {
    $base_url = 'http://';
  }
  $base_url .= $host;
  if ($path !== '') {
    $base_url .= $path;
  }
  putenv('SIMPLETEST_BASE_URL=' . $base_url);
405 406 407
  $_SERVER['HTTP_HOST'] = $host;
  $_SERVER['REMOTE_ADDR'] = '127.0.0.1';
  $_SERVER['SERVER_ADDR'] = '127.0.0.1';
408
  $_SERVER['SERVER_PORT'] = $port;
409
  $_SERVER['SERVER_SOFTWARE'] = NULL;
410 411
  $_SERVER['SERVER_NAME'] = 'localhost';
  $_SERVER['REQUEST_URI'] = $path .'/';
412
  $_SERVER['REQUEST_METHOD'] = 'GET';
413
  $_SERVER['SCRIPT_NAME'] = $path .'/index.php';
414
  $_SERVER['SCRIPT_FILENAME'] = $path .'/index.php';
415 416 417
  $_SERVER['PHP_SELF'] = $path .'/index.php';
  $_SERVER['HTTP_USER_AGENT'] = 'Drupal command line';

418
  if (!empty($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on') {
419 420 421 422 423 424
    // Ensure that any and all environment variables are changed to https://.
    foreach ($_SERVER as $key => $value) {
      $_SERVER[$key] = str_replace('http://', 'https://', $_SERVER[$key]);
    }
  }

425
  chdir(realpath(__DIR__ . '/../..'));
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
}

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

  // If there is an existing Drupal installation that contains a database
  // connection info in settings.php, then $databases['default']['default'] will
  // hold the default database connection already. This connection is assumed to
  // be valid, and this connection will be used in tests, so that they run
  // against e.g. MySQL instead of SQLite.

  // However, in case no Drupal installation exists, this default database
  // connection can be set and/or overridden with the --dburl parameter.
  if (!empty($args['dburl'])) {
    // Remove a possibly existing default connection (from settings.php).
    Database::removeConnection('default');
468 469
    try {
      $databases['default']['default'] = Database::convertDbUrlToConnectionInfo($args['dburl'], DRUPAL_ROOT);
470
    }
471 472
    catch (\InvalidArgumentException $e) {
      simpletest_script_print_error('Invalid --dburl. Reason: ' . $e->getMessage());
473
      exit(SIMPLETEST_SCRIPT_EXIT_FAILURE);
474
    }
475
  }
476 477 478
  // Otherwise, use the default database connection from settings.php.
  else {
    $databases['default'] = Database::getConnectionInfo('default');
479 480 481 482 483
  }

  // If there is no default database connection for tests, we cannot continue.
  if (!isset($databases['default']['default'])) {
    simpletest_script_print_error('Missing default database connection for tests. Use --dburl to specify one.');
484
    exit(SIMPLETEST_SCRIPT_EXIT_FAILURE);
485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527
  }
  Database::addConnectionInfo('default', 'default', $databases['default']['default']);

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

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

  // Create the Simpletest schema.
  try {
    $schema = Database::getConnection('default', 'test-runner')->schema();
  }
  catch (\PDOException $e) {
    simpletest_script_print_error($databases['test-runner']['default']['driver'] . ': ' . $e->getMessage());
528
    exit(SIMPLETEST_SCRIPT_EXIT_FAILURE);
529 530 531 532
  }
  if ($new && $sqlite) {
    require_once DRUPAL_ROOT . '/' . drupal_get_path('module', 'simpletest') . '/simpletest.install';
    foreach (simpletest_schema() as $name => $table_spec) {
533 534 535 536 537 538 539 540 541
      try {
        if ($schema->tableExists($name)) {
          $schema->dropTable($name);
        }
        $schema->createTable($name, $table_spec);
      }
      catch (Exception $e) {
        echo (string) $e;
        exit(SIMPLETEST_SCRIPT_EXIT_EXCEPTION);
542 543 544 545
      }
    }
  }
  // Verify that the Simpletest database schema exists by checking one table.
546 547 548 549 550 551 552 553 554
  try {
    if (!$schema->tableExists('simpletest')) {
      simpletest_script_print_error('Missing Simpletest database schema. Either install Simpletest module or use the --sqlite parameter.');
      exit(SIMPLETEST_SCRIPT_EXIT_FAILURE);
    }
  }
  catch (Exception $e) {
    echo (string) $e;
    exit(SIMPLETEST_SCRIPT_EXIT_EXCEPTION);
555 556 557
  }
}

558 559 560
/**
 * Execute a batch of tests.
 */
561
function simpletest_script_execute_batch($test_classes) {
562
  global $args, $test_ids;
563

564 565
  $total_status = SIMPLETEST_SCRIPT_EXIT_SUCCESS;

566 567
  // Multi-process execution.
  $children = array();
568
  while (!empty($test_classes) || !empty($children)) {
569
    while (count($children) < $args['concurrency']) {
570
      if (empty($test_classes)) {
571
        break;
572
      }
573

574 575 576 577 578 579 580 581 582 583
      try {
        $test_id = Database::getConnection('default', 'test-runner')
          ->insert('simpletest_test_id')
          ->useDefaults(array('test_id'))
          ->execute();
      }
      catch (Exception $e) {
        echo (string) $e;
        exit(SIMPLETEST_SCRIPT_EXIT_EXCEPTION);
      }
584
      $test_ids[] = $test_id;
585

586
      $test_class = array_shift($test_classes);
587
      // Fork a child process.
588 589 590 591 592
      $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";
593
        exit(SIMPLETEST_SCRIPT_EXIT_SUCCESS);
594 595
      }

596 597 598
      // Register our new child.
      $children[] = array(
        'process' => $process,
599
        'test_id' => $test_id,
600 601 602 603
        'class' => $test_class,
        'pipes' => $pipes,
      );
    }
604

605 606 607 608 609 610 611 612 613
    // 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']);
614 615 616 617
        if ($status['exitcode'] === SIMPLETEST_SCRIPT_EXIT_FAILURE) {
          $total_status = max($status['exitcode'], $total_status);
        }
        elseif ($status['exitcode']) {
618 619 620 621 622 623
          $message = 'FATAL ' . $child['class'] . ': test runner returned a non-zero error code (' . $status['exitcode'] . ').';
          echo $message . "\n";
          // Insert a fail for xml results.
          TestBase::insertAssert($child['test_id'], $child['class'], FALSE, $message, 'run-tests.sh check');
          /// Ensure that an error line is displayed for the class.
          simpletest_script_reporter_display_summary($child['class'], ['#pass' => 0, '#fail' => 1, '#exception' => 0, '#debug' => 0]);
624 625
          if ($args['die-on-fail']) {
            list($db_prefix, ) = simpletest_last_test_get($child['test_id']);
626
            $test_directory = 'sites/simpletest/' . substr($db_prefix, 10);
627
            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";
628 629 630
            $args['keep-results'] = TRUE;
            // Exit repeat loop immediately.
            $args['repeat'] = -1;
631
          }
632
        }
633
        // Free-up space by removing any potentially created resources.
634 635 636
        if (!$args['keep-results']) {
          simpletest_script_cleanup($child['test_id'], $child['class'], $status['exitcode']);
        }
637 638

        // Remove this child.
639
        unset($children[$cid]);
640 641 642
      }
    }
  }
643
  return $total_status;
644 645
}

646 647 648
/**
 * Run a group of phpunit tests.
 */
649
function simpletest_script_run_phpunit($test_id, $class) {
650 651 652 653 654
  $reflection = new \ReflectionClass($class);
  if ($reflection->hasProperty('runLimit')) {
    set_time_limit($reflection->getStaticPropertyValue('runLimit'));
  }

655
  $results = simpletest_run_phpunit_tests($test_id, array($class), $status);
656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681
  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':
682
        $summaries[$result['test_class']]['#debug']++;
683 684 685 686 687
        break;
    }
  }

  foreach ($summaries as $class => $summary) {
688
    simpletest_script_reporter_display_summary($class, $summary);
689
  }
690
  return $status;
691 692
}

693
/**
694
 * Bootstrap Drupal and run a single test.
695 696
 */
function simpletest_script_run_one_test($test_id, $test_class) {
697
  global $args;
698

699
  try {
700 701 702 703 704 705 706 707 708 709
    if (strpos($test_class, '::') > 0) {
      list($class_name, $method) = explode('::', $test_class, 2);
      $methods = [$method];
    }
    else {
      $class_name = $test_class;
      // Use empty array to run all the test methods.
      $methods = array();
    }
    $test = new $class_name($test_id);
710
    if (is_subclass_of($test_class, '\PHPUnit_Framework_TestCase')) {
711
      $status = simpletest_script_run_phpunit($test_id, $test_class);
712 713 714 715 716 717
    }
    else {
      $test->dieOnFail = (bool) $args['die-on-fail'];
      $test->verbose = (bool) $args['verbose'];
      $test->run($methods);
      simpletest_script_reporter_display_summary($test_class, $test->results);
718 719 720 721 722 723

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

726
    exit($status);
727
  }
728 729
  // DrupalTestCase::run() catches exceptions already, so this is only reached
  // when an exception is thrown in the wrapping test runner environment.
730 731
  catch (Exception $e) {
    echo (string) $e;
732
    exit(SIMPLETEST_SCRIPT_EXIT_EXCEPTION);
733
  }
734 735
}

736
/**
737 738 739 740 741 742
 * 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.
743
 */
744
function simpletest_script_command($test_id, $test_class) {
745
  global $args, $php;
746

747 748
  $command = escapeshellarg($php) . ' ' . escapeshellarg('./core/scripts/' . $args['script']);
  $command .= ' --url ' . escapeshellarg($args['url']);
749 750 751 752 753 754
  if (!empty($args['sqlite'])) {
    $command .= ' --sqlite ' . escapeshellarg($args['sqlite']);
  }
  if (!empty($args['dburl'])) {
    $command .= ' --dburl ' . escapeshellarg($args['dburl']);
  }
755 756
  $command .= ' --php ' . escapeshellarg($php);
  $command .= " --test-id $test_id";
757
  foreach (array('verbose', 'keep-results', 'color', 'die-on-fail') as $arg) {
758 759 760
    if ($args[$arg]) {
      $command .= ' --' . $arg;
    }
761
  }
762 763
  // --execute-test and class name needs to come last.
  $command .= ' --execute-test ' . escapeshellarg($test_class);
764
  return $command;
765 766
}

767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788
/**
 * 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) {
789
  if (is_subclass_of($test_class, '\PHPUnit_Framework_TestCase')) {
790 791 792
    // PHPUnit test, move on.
    return;
  }
793
  // Retrieve the last database prefix used for testing.
794 795 796 797 798 799 800
  try {
    list($db_prefix,) = simpletest_last_test_get($test_id);
  }
  catch (Exception $e) {
    echo (string) $e;
    exit(SIMPLETEST_SCRIPT_EXIT_EXCEPTION);
  }
801 802 803 804 805 806 807 808 809 810 811 812 813 814

  // 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.
815 816 817 818 819 820 821
  try {
    simpletest_log_read($test_id, $db_prefix, $test_class);
  }
  catch (Exception $e) {
    echo (string) $e;
    exit(SIMPLETEST_SCRIPT_EXIT_EXCEPTION);
  }
822

823 824 825
  // Check whether a test site directory was setup already.
  // @see \Drupal\simpletest\TestBase::prepareEnvironment()
  $test_directory = DRUPAL_ROOT . '/sites/simpletest/' . substr($db_prefix, 10);
826 827 828 829 830 831 832 833
  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;
      }
    }
834
    // Delete the test site directory.
835 836 837
    // simpletest_clean_temporary_directories() cannot be used here, since it
    // would also delete file directories of other tests that are potentially
    // running concurrently.
838
    file_unmanaged_delete_recursive($test_directory, array('Drupal\simpletest\TestBase', 'filePreDeleteCallback'));
839
    $messages[] = "- Removed test site directory.";
840 841 842
  }

  // Clear out all database tables from the test.
843 844 845 846 847 848 849
  try {
    $schema = Database::getConnection('default', 'default')->schema();
    $count = 0;
    foreach ($schema->findTables($db_prefix . '%') as $table) {
      $schema->dropTable($table);
      $count++;
    }
850
  }
851 852 853 854 855
  catch (Exception $e) {
    echo (string) $e;
    exit(SIMPLETEST_SCRIPT_EXIT_EXCEPTION);
  }

856
  if ($count) {
857
    $messages[] = "- Removed $count leftover tables.";
858 859 860 861 862 863 864 865
  }

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

866
/**
867
 * Get list of tests based on arguments. If --all specified then
868 869 870 871 872 873 874
 * 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() {
875
  global $args;
876 877

  $test_list = array();
878
  if ($args['all'] || $args['module']) {
879 880 881 882 883 884 885
    try {
      $groups = simpletest_test_get_all($args['module']);
    }
    catch (Exception $e) {
      echo (string) $e;
      exit(SIMPLETEST_SCRIPT_EXIT_EXCEPTION);
    }
886 887
    $all_tests = array();
    foreach ($groups as $group => $tests) {
888
      $all_tests = array_merge($all_tests, array_keys($tests));
889
    }
890
    $test_list = $all_tests;
891 892
  }
  else {
893
    if ($args['class']) {
894 895
      $test_list = array();
      foreach ($args['test_names'] as $test_class) {
896 897
        list($class_name, ) = explode('::', $test_class, 2);
        if (class_exists($class_name)) {
898 899 900
          $test_list[] = $test_class;
        }
        else {
901 902 903 904 905 906 907
          try {
            $groups = simpletest_test_get_all();
          }
          catch (Exception $e) {
            echo (string) $e;
            exit(SIMPLETEST_SCRIPT_EXIT_EXCEPTION);
          }
908 909 910 911
          $all_classes = array();
          foreach ($groups as $group) {
            $all_classes = array_merge($all_classes, array_keys($group));
          }
912 913
          simpletest_script_print_error('Test class not found: ' . $class_name);
          simpletest_script_print_alternatives($class_name, $all_classes, 6);
914
          exit(SIMPLETEST_SCRIPT_EXIT_FAILURE);
915
        }
916 917
      }
    }
918
    elseif ($args['file']) {
919
      // Extract test case class names from specified files.
920
      foreach ($args['test_names'] as $file) {
921 922
        if (!file_exists($file)) {
          simpletest_script_print_error('File not found: ' . $file);
923
          exit(SIMPLETEST_SCRIPT_EXIT_FAILURE);
924 925 926 927 928 929 930 931 932 933 934
        }
        $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) {
935
          $test_list = array_merge($test_list, $matches[1]);
936 937 938
        }
        else {
          foreach ($matches[1] as $class_name) {
939
            $namespace_class = $namespace . '\\' . $class_name;
940
            if (is_subclass_of($namespace_class, '\Drupal\simpletest\TestBase') || is_subclass_of($namespace_class, '\PHPUnit_Framework_TestCase')) {
941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994
              $test_list[] = $namespace_class;
            }
          }
        }
      }
    }
    elseif ($args['directory']) {
      // Extract test case class names from specified directory.
      // Find all tests in the PSR-X structure; Drupal\$extension\Tests\*.php
      // Since we do not want to hard-code too many structural file/directory
      // assumptions about PSR-0/4 files and directories, we check for the
      // minimal conditions only; i.e., a '*.php' file that has '/Tests/' in
      // its path.
      // Ignore anything from third party vendors.
      $ignore = array('.', '..', 'vendor');
      $files = [];
      if ($args['directory'][0] === '/') {
        $directory = $args['directory'];
      }
      else {
        $directory = DRUPAL_ROOT . "/" . $args['directory'];
      }
      foreach (file_scan_directory($directory, '/\.php$/', $ignore) as $file) {
        // '/Tests/' can be contained anywhere in the file's path (there can be
        // sub-directories below /Tests), but must be contained literally.
        // Case-insensitive to match all Simpletest and PHPUnit tests:
        //   ./lib/Drupal/foo/Tests/Bar/Baz.php
        //   ./foo/src/Tests/Bar/Baz.php
        //   ./foo/tests/Drupal/foo/Tests/FooTest.php
        //   ./foo/tests/src/FooTest.php
        // $file->filename doesn't give us a directory, so we use $file->uri
        // Strip the drupal root directory and trailing slash off the URI
        $filename = substr($file->uri, strlen(DRUPAL_ROOT)+1);
        if (stripos($filename, '/Tests/')) {
          $files[$filename] = $filename;
        }
      }
      foreach ($files as $file) {
        $content = file_get_contents($file);
        // Extract a potential namespace.
        $namespace = FALSE;
        if (preg_match('@^namespace ([^ ;]+)@m', $content, $matches)) {
          $namespace = $matches[1];
        }
        // Extract all class names.
        // Abstract classes are excluded on purpose.
        preg_match_all('@^class ([^ ]+)@m', $content, $matches);
        if (!$namespace) {
          $test_list = array_merge($test_list, $matches[1]);
        }
        else {
          foreach ($matches[1] as $class_name) {
            $namespace_class = $namespace . '\\' . $class_name;
            if (is_subclass_of($namespace_class, '\Drupal\simpletest\TestBase') || is_subclass_of($namespace_class, '\PHPUnit_Framework_TestCase')) {
995 996
              $test_list[] = $namespace_class;
            }
997
          }
998 999 1000
        }
      }
    }
1001
    else {
1002 1003 1004 1005 1006 1007 1008
      try {
        $groups = simpletest_test_get_all();
      }
      catch (Exception $e) {
        echo (string) $e;
        exit(SIMPLETEST_SCRIPT_EXIT_EXCEPTION);
      }
1009
      foreach ($args['test_names'] as $group_name) {
1010 1011 1012 1013 1014 1015
        if (isset($groups[$group_name])) {
          $test_list = array_merge($test_list, array_keys($groups[$group_name]));
        }
        else {
          simpletest_script_print_error('Test group not found: ' . $group_name);
          simpletest_script_print_alternatives($group_name, array_keys($groups));
1016
          exit(SIMPLETEST_SCRIPT_EXIT_FAILURE);
1017
        }
1018 1019
      }
    }
1020
  }
1021

1022 1023
  if (empty($test_list)) {
    simpletest_script_print_error('No valid tests were specified.');
1024
    exit(SIMPLETEST_SCRIPT_EXIT_FAILURE);
1025 1026
  }
  return $test_list;
1027 1028
}

1029 1030 1031 1032
/**
 * Initialize the reporter.
 */
function simpletest_script_reporter_init() {
1033
  global $args, $test_list, $results_map;
1034 1035 1036 1037 1038 1039

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

1041 1042 1043 1044
  echo "\n";
  echo "Drupal test run\n";
  echo "---------------\n";
  echo "\n";
1045

1046 1047 1048 1049 1050 1051
  // 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";
1052
    foreach ($test_list as $class_name) {
1053
      echo "  - $class_name\n";
1054 1055
    }
    echo "\n";
1056
  }
1057

1058
  echo "Test run started:\n";
1059
  echo "  " . date('l, F j, Y - H:i', $_SERVER['REQUEST_TIME']) . "\n";
1060
  Timer::start('run-tests');
Dries's avatar