run-tests.sh 46.9 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 23 24 25 26
// Define some colors for display.
// A nice calming green.
const SIMPLETEST_SCRIPT_COLOR_PASS = 32;
// An alerting Red.
const SIMPLETEST_SCRIPT_COLOR_FAIL = 31;
// An annoying brown.
const SIMPLETEST_SCRIPT_COLOR_EXCEPTION = 33;
27 28 29

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

31 32 33 34
const SIMPLETEST_SCRIPT_EXIT_SUCCESS = 0;
const SIMPLETEST_SCRIPT_EXIT_FAILURE = 1;
const SIMPLETEST_SCRIPT_EXIT_EXCEPTION = 2;

35 36 37 38 39
// Set defaults and get overrides.
list($args, $count) = simpletest_script_parse_args();

if ($args['help'] || $count == 0) {
  simpletest_script_help();
40
  exit(($count == 0) ? SIMPLETEST_SCRIPT_EXIT_FAILURE : SIMPLETEST_SCRIPT_EXIT_SUCCESS);
41 42
}

43
simpletest_script_init();
44

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

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

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

82
simpletest_script_setup_database(TRUE);
83 84

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

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

103 104
$test_list = simpletest_script_get_test_list();

105 106
// Try to allocate unlimited time to run the tests.
drupal_set_time_limit(0);
107 108
simpletest_script_reporter_init();

109
$tests_to_run = array();
110
for ($i = 0; $i < $args['repeat']; $i++) {
111
  $tests_to_run = array_merge($tests_to_run, $test_list);
112
}
113

114
// Execute tests.
115
$status = simpletest_script_execute_batch($tests_to_run);
116

117 118 119
// Stop the timer.
simpletest_script_reporter_timer_stop();

120
// Display results before database is cleared.
121 122 123 124 125 126
if ($args['browser']) {
  simpletest_script_open_browser();
}
else {
  simpletest_script_reporter_display_results();
}
127

128 129 130 131
if ($args['xml']) {
  simpletest_script_reporter_write_xml_results();
}

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

143
// Test complete, exit.
144
exit($status);
145

146 147 148 149 150
/**
 * Print help text.
 */
function simpletest_script_help() {
  global $args;
151 152 153 154 155

  echo <<<EOF

Run Drupal tests from the shell.

156 157
Usage:        {$args['script']} [OPTIONS] <tests>
Example:      {$args['script']} Profile
158 159 160 161

All arguments are long options.

  --help      Print this page.
162 163 164

  --list      Display all available test groups.

165 166 167
  --clean     Cleans up database tables or directories from previous, failed,
              tests and then exits (no tests are run).

168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
  --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,
183
              and database name to use in tests.
184 185
              Required when running tests without a Drupal installation that
              contains default database connection info in settings.php.
186 187 188 189
              Examples:
                mysql://username:password@localhost/databasename#table_prefix
                sqlite://localhost/relative/path/db.sqlite
                sqlite://localhost//absolute/path/db.sqlite
190

191
  --php       The absolute path to the PHP executable. Usually not needed.
192

193 194
  --concurrency [num]

195
              Run tests in parallel, up to [num] tests at a time.
196

197
  --all       Run all available tests.
198

199 200 201
  --module    Run all tests belonging to the specified module name.
              (e.g., 'node')

202
  --class     Run tests identified by specific class names, instead of group names.
203 204
              A specific test method can be added, for example,
              'Drupal\book\Tests\BookTest::testBookExport'.
205

206
  --file      Run tests identified by specific file names, instead of group names.
207 208
              Specify the path and the extension
              (i.e. 'core/modules/user/user.test').
209

210 211
  --directory Run all tests found within the specified file directory.

212 213 214 215 216
  --xml       <path>

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

  --color     Output text format results with color highlighting.
217 218 219

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

220 221 222 223 224
  --keep-results

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

225 226 227 228
  --repeat    Number of times to repeat the test.

  --die-on-fail

229 230 231 232
              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.
233

234 235 236 237
  --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.

238 239 240
  --non-html  Removes escaping from output. Useful for reading results on the
              CLI.

241 242
  <test1>[,<test2>[,<test3> ...]]

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

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

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

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

269 270 271
EOF;
}

272 273 274
/**
 * Parse execution argument and ensure that all are valid.
 *
275 276
 * @return array
 *   The list of arguments.
277 278 279 280 281 282 283 284 285
 */
function simpletest_script_parse_args() {
  // Set default values.
  $args = array(
    'script' => '',
    'help' => FALSE,
    'list' => FALSE,
    'clean' => FALSE,
    'url' => '',
286 287
    'sqlite' => NULL,
    'dburl' => NULL,
288
    'php' => '',
289 290
    'concurrency' => 1,
    'all' => FALSE,
291
    'module' => NULL,
292
    'class' => FALSE,
293
    'file' => FALSE,
294
    'directory' => NULL,
295 296
    'color' => FALSE,
    'verbose' => FALSE,
297
    'keep-results' => FALSE,
298
    'test_names' => array(),
299 300
    'repeat' => 1,
    'die-on-fail' => FALSE,
301
    'browser' => FALSE,
302
    // Used internally.
303 304
    'test-id' => 0,
    'execute-test' => '',
305
    'xml' => '',
306
    'non-html' => FALSE,
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
  );

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

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

348 349 350
  if ($args['browser']) {
    $args['keep-results'] = TRUE;
  }
351
  return array($args, $count);
352 353
}

354 355 356
/**
 * Initialize script variables and perform general setup requirements.
 */
357
function simpletest_script_init() {
358 359 360 361
  global $args, $php;

  $host = 'localhost';
  $path = '';
362 363
  $port = '80';

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

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

401 402 403 404 405 406 407 408 409 410 411
  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);
412 413 414
  $_SERVER['HTTP_HOST'] = $host;
  $_SERVER['REMOTE_ADDR'] = '127.0.0.1';
  $_SERVER['SERVER_ADDR'] = '127.0.0.1';
415
  $_SERVER['SERVER_PORT'] = $port;
416
  $_SERVER['SERVER_SOFTWARE'] = NULL;
417
  $_SERVER['SERVER_NAME'] = 'localhost';
418
  $_SERVER['REQUEST_URI'] = $path . '/';
419
  $_SERVER['REQUEST_METHOD'] = 'GET';
420 421 422
  $_SERVER['SCRIPT_NAME'] = $path . '/index.php';
  $_SERVER['SCRIPT_FILENAME'] = $path . '/index.php';
  $_SERVER['PHP_SELF'] = $path . '/index.php';
423 424
  $_SERVER['HTTP_USER_AGENT'] = 'Drupal command line';

425
  if (!empty($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on') {
426 427 428 429 430 431
    // Ensure that any and all environment variables are changed to https://.
    foreach ($_SERVER as $key => $value) {
      $_SERVER[$key] = str_replace('http://', 'https://', $_SERVER[$key]);
    }
  }

432
  chdir(realpath(__DIR__ . '/../..'));
433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461
}

/**
 * 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) {
462
  global $args;
463 464 465 466 467 468 469 470 471 472 473

  // 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');
474 475
    try {
      $databases['default']['default'] = Database::convertDbUrlToConnectionInfo($args['dburl'], DRUPAL_ROOT);
476
    }
477 478
    catch (\InvalidArgumentException $e) {
      simpletest_script_print_error('Invalid --dburl. Reason: ' . $e->getMessage());
479
      exit(SIMPLETEST_SCRIPT_EXIT_FAILURE);
480
    }
481
  }
482 483 484
  // Otherwise, use the default database connection from settings.php.
  else {
    $databases['default'] = Database::getConnectionInfo('default');
485 486 487 488 489
  }

  // 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.');
490
    exit(SIMPLETEST_SCRIPT_EXIT_FAILURE);
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 528 529 530 531 532 533
  }
  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());
534
    exit(SIMPLETEST_SCRIPT_EXIT_FAILURE);
535 536 537 538
  }
  if ($new && $sqlite) {
    require_once DRUPAL_ROOT . '/' . drupal_get_path('module', 'simpletest') . '/simpletest.install';
    foreach (simpletest_schema() as $name => $table_spec) {
539 540 541 542 543 544 545 546 547
      try {
        if ($schema->tableExists($name)) {
          $schema->dropTable($name);
        }
        $schema->createTable($name, $table_spec);
      }
      catch (Exception $e) {
        echo (string) $e;
        exit(SIMPLETEST_SCRIPT_EXIT_EXCEPTION);
548 549 550 551
      }
    }
  }
  // Verify that the Simpletest database schema exists by checking one table.
552 553 554 555 556 557 558 559 560
  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);
561 562 563
  }
}

564 565 566
/**
 * Execute a batch of tests.
 */
567
function simpletest_script_execute_batch($test_classes) {
568
  global $args, $test_ids;
569

570 571
  $total_status = SIMPLETEST_SCRIPT_EXIT_SUCCESS;

572 573
  // Multi-process execution.
  $children = array();
574
  while (!empty($test_classes) || !empty($children)) {
575
    while (count($children) < $args['concurrency']) {
576
      if (empty($test_classes)) {
577
        break;
578
      }
579

580 581 582 583 584 585 586 587 588 589
      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);
      }
590
      $test_ids[] = $test_id;
591

592
      $test_class = array_shift($test_classes);
593
      // Fork a child process.
594 595 596 597 598
      $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";
599
        exit(SIMPLETEST_SCRIPT_EXIT_SUCCESS);
600 601
      }

602 603 604
      // Register our new child.
      $children[] = array(
        'process' => $process,
605
        'test_id' => $test_id,
606 607 608 609
        'class' => $test_class,
        'pipes' => $pipes,
      );
    }
610

611 612 613 614 615 616 617 618 619
    // 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']);
620 621 622 623
        if ($status['exitcode'] === SIMPLETEST_SCRIPT_EXIT_FAILURE) {
          $total_status = max($status['exitcode'], $total_status);
        }
        elseif ($status['exitcode']) {
624 625 626 627
          $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');
628 629 630 631 632
          // 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]
          );
633
          if ($args['die-on-fail']) {
634
            list($db_prefix) = simpletest_last_test_get($child['test_id']);
635
            $test_directory = 'sites/simpletest/' . substr($db_prefix, 10);
636
            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";
637 638 639
            $args['keep-results'] = TRUE;
            // Exit repeat loop immediately.
            $args['repeat'] = -1;
640
          }
641
        }
642
        // Free-up space by removing any potentially created resources.
643 644 645
        if (!$args['keep-results']) {
          simpletest_script_cleanup($child['test_id'], $child['class'], $status['exitcode']);
        }
646 647

        // Remove this child.
648
        unset($children[$cid]);
649 650 651
      }
    }
  }
652
  return $total_status;
653 654
}

655
/**
656
 * Run a PHPUnit-based test.
657
 */
658
function simpletest_script_run_phpunit($test_id, $class) {
659 660 661 662 663
  $reflection = new \ReflectionClass($class);
  if ($reflection->hasProperty('runLimit')) {
    set_time_limit($reflection->getStaticPropertyValue('runLimit'));
  }

664
  $results = simpletest_run_phpunit_tests($test_id, array($class), $status);
665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683
  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;
684

685 686 687
      case 'fail':
        $summaries[$result['test_class']]['#fail']++;
        break;
688

689 690 691
      case 'exception':
        $summaries[$result['test_class']]['#exception']++;
        break;
692

693
      case 'debug':
694
        $summaries[$result['test_class']]['#debug']++;
695 696 697 698 699
        break;
    }
  }

  foreach ($summaries as $class => $summary) {
700
    simpletest_script_reporter_display_summary($class, $summary);
701
  }
702
  return $status;
703 704
}

705
/**
706
 * Run a single test, bootstrapping Drupal if needed.
707 708
 */
function simpletest_script_run_one_test($test_id, $test_class) {
709
  global $args;
710

711
  try {
712 713 714 715 716 717 718 719 720 721
    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);
722
    if (is_subclass_of($test_class, '\PHPUnit_Framework_TestCase')) {
723
      $status = simpletest_script_run_phpunit($test_id, $test_class);
724 725 726 727 728 729
    }
    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);
730 731 732 733 734 735

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

738
    exit($status);
739
  }
740 741
  // DrupalTestCase::run() catches exceptions already, so this is only reached
  // when an exception is thrown in the wrapping test runner environment.
742 743
  catch (Exception $e) {
    echo (string) $e;
744
    exit(SIMPLETEST_SCRIPT_EXIT_EXCEPTION);
745
  }
746 747
}

748
/**
749 750
 * Return a command used to run a test in a separate process.
 *
751 752 753 754 755 756 757
 * @param int $test_id
 *   The current test ID.
 * @param string $test_class
 *   The name of the test class to run.
 *
 * @return string
 *   The assembled command string.
758
 */
759
function simpletest_script_command($test_id, $test_class) {
760
  global $args, $php;
761

762 763
  $command = escapeshellarg($php) . ' ' . escapeshellarg('./core/scripts/' . $args['script']);
  $command .= ' --url ' . escapeshellarg($args['url']);
764 765 766 767 768 769
  if (!empty($args['sqlite'])) {
    $command .= ' --sqlite ' . escapeshellarg($args['sqlite']);
  }
  if (!empty($args['dburl'])) {
    $command .= ' --dburl ' . escapeshellarg($args['dburl']);
  }
770 771
  $command .= ' --php ' . escapeshellarg($php);
  $command .= " --test-id $test_id";
772
  foreach (array('verbose', 'keep-results', 'color', 'die-on-fail') as $arg) {
773 774 775
    if ($args[$arg]) {
      $command .= ' --' . $arg;
    }
776
  }
777 778
  // --execute-test and class name needs to come last.
  $command .= ' --execute-test ' . escapeshellarg($test_class);
779
  return $command;
780 781
}

782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803
/**
 * 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) {
804
  if (is_subclass_of($test_class, '\PHPUnit_Framework_TestCase')) {
805 806 807
    // PHPUnit test, move on.
    return;
  }
808
  // Retrieve the last database prefix used for testing.
809
  try {
810
    list($db_prefix) = simpletest_last_test_get($test_id);
811 812 813 814 815
  }
  catch (Exception $e) {
    echo (string) $e;
    exit(SIMPLETEST_SCRIPT_EXIT_EXCEPTION);
  }
816 817 818 819 820 821 822 823 824 825 826 827 828 829

  // 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.
830 831 832 833 834 835 836
  try {
    simpletest_log_read($test_id, $db_prefix, $test_class);
  }
  catch (Exception $e) {
    echo (string) $e;
    exit(SIMPLETEST_SCRIPT_EXIT_EXCEPTION);
  }
837

838 839 840
  // Check whether a test site directory was setup already.
  // @see \Drupal\simpletest\TestBase::prepareEnvironment()
  $test_directory = DRUPAL_ROOT . '/sites/simpletest/' . substr($db_prefix, 10);
841 842 843 844 845 846 847 848
  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;
      }
    }
849
    // Delete the test site directory.
850 851 852
    // simpletest_clean_temporary_directories() cannot be used here, since it
    // would also delete file directories of other tests that are potentially
    // running concurrently.
853
    file_unmanaged_delete_recursive($test_directory, array('Drupal\simpletest\TestBase', 'filePreDeleteCallback'));
854
    $messages[] = "- Removed test site directory.";
855 856 857
  }

  // Clear out all database tables from the test.
858 859 860 861 862 863 864
  try {
    $schema = Database::getConnection('default', 'default')->schema();
    $count = 0;
    foreach ($schema->findTables($db_prefix . '%') as $table) {
      $schema->dropTable($table);
      $count++;
    }
865
  }
866 867 868 869 870
  catch (Exception $e) {
    echo (string) $e;
    exit(SIMPLETEST_SCRIPT_EXIT_EXCEPTION);
  }

871
  if ($count) {
872
    $messages[] = "- Removed $count leftover tables.";
873 874 875 876 877 878 879 880
  }

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

881
/**
882
 * Get list of tests based on arguments.
883
 *
884 885
 * If --all specified then return all available tests, otherwise reads list of
 * tests.
886
 *
887 888
 * @return array
 *   List of tests.
889 890
 */
function simpletest_script_get_test_list() {
891
  global $args;
892 893

  $test_list = array();
894
  if ($args['all'] || $args['module']) {
895 896 897 898 899 900 901
    try {
      $groups = simpletest_test_get_all($args['module']);
    }
    catch (Exception $e) {
      echo (string) $e;
      exit(SIMPLETEST_SCRIPT_EXIT_EXCEPTION);
    }
902 903
    $all_tests = array();
    foreach ($groups as $group => $tests) {
904
      $all_tests = array_merge($all_tests, array_keys($tests));
905
    }
906
    $test_list = $all_tests;
907 908
  }
  else {
909
    if ($args['class']) {
910 911
      $test_list = array();
      foreach ($args['test_names'] as $test_class) {
912
        list($class_name) = explode('::', $test_class, 2);
913
        if (class_exists($class_name)) {
914 915 916
          $test_list[] = $test_class;
        }
        else {
917 918 919 920 921 922 923
          try {
            $groups = simpletest_test_get_all();
          }
          catch (Exception $e) {
            echo (string) $e;
            exit(SIMPLETEST_SCRIPT_EXIT_EXCEPTION);
          }
924 925 926 927
          $all_classes = array();
          foreach ($groups as $group) {
            $all_classes = array_merge($all_classes, array_keys($group));
          }
928 929
          simpletest_script_print_error('Test class not found: ' . $class_name);
          simpletest_script_print_alternatives($class_name, $all_classes, 6);
930
          exit(SIMPLETEST_SCRIPT_EXIT_FAILURE);
931
        }
932 933
      }
    }
934
    elseif ($args['file']) {
935
      // Extract test case class names from specified files.
936
      foreach ($args['test_names'] as $file) {
937 938
        if (!file_exists($file)) {
          simpletest_script_print_error('File not found: ' . $file);
939
          exit(SIMPLETEST_SCRIPT_EXIT_FAILURE);
940 941 942 943 944 945 946 947 948 949 950
        }
        $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) {
951
          $test_list = array_merge($test_list, $matches[1]);
952 953 954
        }
        else {
          foreach ($matches[1] as $class_name) {
955
            $namespace_class = $namespace . '\\' . $class_name;
956
            if (is_subclass_of($namespace_class, '\Drupal\simpletest\TestBase') || is_subclass_of($namespace_class, '\PHPUnit_Framework_TestCase')) {
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
              $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:
983 984 985 986
        // ./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
987
        // $file->filename doesn't give us a directory, so we use $file->uri
988 989
        // Strip the drupal root directory and trailing slash off the URI.
        $filename = substr($file->uri, strlen(DRUPAL_ROOT) + 1);
990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010
        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')) {
1011 1012
              $test_list[] = $namespace_class;
            }
1013
          }
1014 1015 1016
        }
      }
    }
1017
    else {
1018 1019 1020 1021 1022 1023 1024
      try {
        $groups = simpletest_test_get_all();
      }
      catch (Exception $e) {
        echo (string) $e;
        exit(SIMPLETEST_SCRIPT_EXIT_EXCEPTION);
      }
1025
      foreach ($args['test_names'] as $group_name) {
1026 1027 1028 1029 1030 1031
        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));
1032
          exit(SIMPLETEST_SCRIPT_EXIT_FAILURE);
1033
        }
1034 1035
      }
    }
1036
  }