run-tests.sh 43 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\Form\FormState;
13
use Drupal\Core\Site\Settings;
14
use Drupal\Core\StreamWrapper\PublicStream;
15
use Drupal\Core\Test\TestRunnerKernel;
16
use Drupal\simpletest\Form\SimpletestResultsForm;
17 18
use Symfony\Component\HttpFoundation\Request;

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

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

// Restricting the chunk of queries prevents memory exhaustion.
const SIMPLETEST_SCRIPT_SQLITE_VARIABLE_LIMIT = 350;
27 28 29 30 31 32

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

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

36
simpletest_script_init();
37 38 39 40

$request = Request::createFromGlobals();
$kernel = TestRunnerKernel::createFromRequest($request, $autoloader);
$kernel->prepareLegacyRequest($request);
41

42
if ($args['execute-test']) {
43
  simpletest_script_setup_database();
44
  simpletest_script_run_one_test($args['test-id'], $args['execute-test']);
45
  // Sub-process exited already; this is just for clarity.
46
  exit;
47
}
48

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

63
simpletest_script_setup_database(TRUE);
64 65

if ($args['clean']) {
66
  // Clean up left-over tables and directories.
67 68 69 70
  simpletest_clean_environment();
  echo "\nEnvironment cleaned.\n";

  // Get the status messages and print them.
71 72
  $messages = drupal_get_messages('status');
  foreach ($messages['status'] as $text) {
73 74
    echo " - " . $text . "\n";
  }
75
  exit;
76 77
}

78 79
$test_list = simpletest_script_get_test_list();

80 81
// Try to allocate unlimited time to run the tests.
drupal_set_time_limit(0);
82 83
simpletest_script_reporter_init();

84
$tests_to_run = array();
85
for ($i = 0; $i < $args['repeat']; $i++) {
86
  $tests_to_run = array_merge($tests_to_run, $test_list);
87
}
88

89
// Execute tests.
90
simpletest_script_execute_batch($tests_to_run);
91

92 93 94
// Stop the timer.
simpletest_script_reporter_timer_stop();

95
// Display results before database is cleared.
96 97 98 99 100 101
if ($args['browser']) {
  simpletest_script_open_browser();
}
else {
  simpletest_script_reporter_display_results();
}
102

103 104 105 106
if ($args['xml']) {
  simpletest_script_reporter_write_xml_results();
}

107
// Clean up all test results.
108 109 110
if (!$args['keep-results']) {
  simpletest_clean_results_table();
}
111

112
// Test complete, exit.
113
exit;
114

115 116 117 118 119
/**
 * Print help text.
 */
function simpletest_script_help() {
  global $args;
120 121 122 123 124

  echo <<<EOF

Run Drupal tests from the shell.

125 126
Usage:        {$args['script']} [OPTIONS] <tests>
Example:      {$args['script']} Profile
127 128 129 130

All arguments are long options.

  --help      Print this page.
131 132 133

  --list      Display all available test groups.

134 135 136
  --clean     Cleans up database tables or directories from previous, failed,
              tests and then exits (no tests are run).

137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
  --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,
152
              and database name to use in tests.
153 154
              Required when running tests without a Drupal installation that
              contains default database connection info in settings.php.
155 156 157 158
              Examples:
                mysql://username:password@localhost/databasename#table_prefix
                sqlite://localhost/relative/path/db.sqlite
                sqlite://localhost//absolute/path/db.sqlite
159

160
  --php       The absolute path to the PHP executable. Usually not needed.
161

162 163
  --concurrency [num]

164
              Run tests in parallel, up to [num] tests at a time.
165

166
  --all       Run all available tests.
167

168 169 170
  --module    Run all tests belonging to the specified module name.
              (e.g., 'node')

171
  --class     Run tests identified by specific class names, instead of group names.
172 173
              A specific test method can be added, for example,
              'Drupal\book\Tests\BookTest::testBookExport'.
174

175
  --file      Run tests identified by specific file names, instead of group names.
176 177
              Specify the path and the extension
              (i.e. 'core/modules/user/user.test').
178

179 180
  --directory Run all tests found within the specified file directory.

181 182 183 184 185
  --xml       <path>

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

  --color     Output text format results with color highlighting.
186 187 188

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

189 190 191 192 193
  --keep-results

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

194 195 196 197
  --repeat    Number of times to repeat the test.

  --die-on-fail

198 199 200 201
              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.
202

203 204 205 206
  --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.

207 208 209
  --non-html  Removes escaping from output. Useful for reading results on the
              CLI.

210 211
  <test1>[,<test2>[,<test3> ...]]

212
              One or more tests to be run. By default, these are interpreted
213
              as the names of test groups as shown at
214
              admin/config/development/testing.
215
              These group names typically correspond to module names like "User"
216
              or "Profile" or "System", but there is also a group "Database".
217
              If --class is specified then these are interpreted as the names of
218 219
              specific test classes whose test methods will be run. Tests must
              be separated by commas. Ignored if --all is specified.
220

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

224
sudo -u [wwwrun|www-data|etc] php ./core/scripts/{$args['script']}
225
  --url http://example.com/ --all
226
sudo -u [wwwrun|www-data|etc] php ./core/scripts/{$args['script']}
227
  --url http://example.com/ --class "Drupal\block\Tests\BlockTest"
228 229 230 231 232 233 234 235 236 237

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

238 239 240
EOF;
}

241 242 243 244 245 246 247 248 249 250 251 252 253
/**
 * 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' => '',
254 255
    'sqlite' => NULL,
    'dburl' => NULL,
256
    'php' => '',
257 258
    'concurrency' => 1,
    'all' => FALSE,
259
    'module' => NULL,
260
    'class' => FALSE,
261
    'file' => FALSE,
262
    'directory' => NULL,
263 264
    'color' => FALSE,
    'verbose' => FALSE,
265
    'keep-results' => FALSE,
266
    'test_names' => array(),
267 268
    'repeat' => 1,
    'die-on-fail' => FALSE,
269
    'browser' => FALSE,
270
    // Used internally.
271 272
    'test-id' => 0,
    'execute-test' => '',
273
    'xml' => '',
274
    'non-html' => FALSE,
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
  );

  // 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']);
        }
293
        // Clear extraneous values.
294 295 296 297 298 299
        $args['test_names'] = array();
        $count++;
      }
      else {
        // Argument not found in list.
        simpletest_script_print_error("Unknown argument '$arg'.");
300
        exit;
301 302 303 304 305
      }
    }
    else {
      // Values found without an argument should be test names.
      $args['test_names'] += explode(',', $arg);
306
      $count++;
307
    }
308
  }
309 310 311 312

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

316 317 318
  if ($args['browser']) {
    $args['keep-results'] = TRUE;
  }
319
  return array($args, $count);
320 321
}

322 323 324
/**
 * Initialize script variables and perform general setup requirements.
 */
325
function simpletest_script_init() {
326 327 328 329
  global $args, $php;

  $host = 'localhost';
  $path = '';
330 331
  $port = '80';

332
  // Determine location of php command automatically, unless a command line argument is supplied.
333
  if (!empty($args['php'])) {
334 335
    $php = $args['php'];
  }
336
  elseif ($php_env = getenv('_')) {
337
    // '_' is an environment variable set by the shell. It contains the command that was executed.
338
    $php = $php_env;
339
  }
340
  elseif ($sudo = getenv('SUDO_COMMAND')) {
341 342
    // 'SUDO_COMMAND' is an environment variable set by the sudo program.
    // Extract only the PHP interpreter, not the rest of the command.
343
    list($php, ) = explode(' ', $sudo, 2);
344 345
  }
  else {
346
    simpletest_script_print_error('Unable to automatically determine the path to the PHP interpreter. Supply the --php command line argument.');
347
    simpletest_script_help();
348
    exit();
349
  }
350

351
  // Get URL from arguments.
352 353
  if (!empty($args['url'])) {
    $parsed_url = parse_url($args['url']);
354
    $host = $parsed_url['host'] . (isset($parsed_url['port']) ? ':' . $parsed_url['port'] : '');
355
    $path = isset($parsed_url['path']) ? rtrim(rtrim($parsed_url['path']), '/') : '';
356
    $port = (isset($parsed_url['port']) ? $parsed_url['port'] : $port);
357 358 359
    if ($path == '/') {
      $path = '';
    }
360
    // If the passed URL schema is 'https' then setup the $_SERVER variables
361
    // properly so that testing will run under HTTPS.
362 363 364
    if ($parsed_url['scheme'] == 'https') {
      $_SERVER['HTTPS'] = 'on';
    }
365 366
  }

367 368 369 370 371 372 373 374 375 376 377
  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);
378 379 380
  $_SERVER['HTTP_HOST'] = $host;
  $_SERVER['REMOTE_ADDR'] = '127.0.0.1';
  $_SERVER['SERVER_ADDR'] = '127.0.0.1';
381
  $_SERVER['SERVER_PORT'] = $port;
382
  $_SERVER['SERVER_SOFTWARE'] = NULL;
383 384
  $_SERVER['SERVER_NAME'] = 'localhost';
  $_SERVER['REQUEST_URI'] = $path .'/';
385
  $_SERVER['REQUEST_METHOD'] = 'GET';
386
  $_SERVER['SCRIPT_NAME'] = $path .'/index.php';
387
  $_SERVER['SCRIPT_FILENAME'] = $path .'/index.php';
388 389 390
  $_SERVER['PHP_SELF'] = $path .'/index.php';
  $_SERVER['HTTP_USER_AGENT'] = 'Drupal command line';

391
  if (!empty($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on') {
392 393 394 395 396 397
    // Ensure that any and all environment variables are changed to https://.
    foreach ($_SERVER as $key => $value) {
      $_SERVER[$key] = str_replace('http://', 'https://', $_SERVER[$key]);
    }
  }

398
  chdir(realpath(__DIR__ . '/../..'));
399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
}

/**
 * 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) {
428
  global $args;
429 430 431 432 433 434 435 436 437 438 439 440

  // 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');
441 442
    try {
      $databases['default']['default'] = Database::convertDbUrlToConnectionInfo($args['dburl'], DRUPAL_ROOT);
443
    }
444 445 446
    catch (\InvalidArgumentException $e) {
      simpletest_script_print_error('Invalid --dburl. Reason: ' . $e->getMessage());
      exit(1);
447
    }
448
  }
449 450 451
  // Otherwise, use the default database connection from settings.php.
  else {
    $databases['default'] = Database::getConnectionInfo('default');
452 453 454 455 456
  }

  // 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.');
457
    exit(1);
458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
  }
  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());
501
    exit(1);
502 503 504 505 506 507 508 509 510 511 512 513 514
  }
  if ($new && $sqlite) {
    require_once DRUPAL_ROOT . '/' . drupal_get_path('module', 'simpletest') . '/simpletest.install';
    foreach (simpletest_schema() as $name => $table_spec) {
      if ($schema->tableExists($name)) {
        $schema->dropTable($name);
      }
      $schema->createTable($name, $table_spec);
    }
  }
  // Verify that the Simpletest database schema exists by checking one table.
  if (!$schema->tableExists('simpletest')) {
    simpletest_script_print_error('Missing Simpletest database schema. Either install Simpletest module or use the --sqlite parameter.');
515
    exit(1);
516 517 518
  }
}

519 520 521
/**
 * Execute a batch of tests.
 */
522
function simpletest_script_execute_batch($test_classes) {
523
  global $args, $test_ids;
524

525 526
  // Multi-process execution.
  $children = array();
527
  while (!empty($test_classes) || !empty($children)) {
528
    while (count($children) < $args['concurrency']) {
529
      if (empty($test_classes)) {
530
        break;
531
      }
532

533 534
      $test_id = Database::getConnection('default', 'test-runner')
        ->insert('simpletest_test_id')->useDefaults(array('test_id'))->execute();
535
      $test_ids[] = $test_id;
536

537
      $test_class = array_shift($test_classes);
538
      // Fork a child process.
539 540 541 542 543
      $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";
544
        exit;
545 546
      }

547 548 549
      // Register our new child.
      $children[] = array(
        'process' => $process,
550
        'test_id' => $test_id,
551 552 553 554
        'class' => $test_class,
        'pipes' => $pipes,
      );
    }
555

556 557 558 559 560 561 562 563 564
    // 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']);
565
        if ($status['exitcode']) {
566
          echo 'FATAL ' . $child['class'] . ': test runner returned a non-zero error code (' . $status['exitcode'] . ').' . "\n";
567 568
          if ($args['die-on-fail']) {
            list($db_prefix, ) = simpletest_last_test_get($child['test_id']);
569
            $test_directory = 'sites/simpletest/' . substr($db_prefix, 10);
570
            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";
571 572 573
            $args['keep-results'] = TRUE;
            // Exit repeat loop immediately.
            $args['repeat'] = -1;
574
          }
575
        }
576
        // Free-up space by removing any potentially created resources.
577 578 579
        if (!$args['keep-results']) {
          simpletest_script_cleanup($child['test_id'], $child['class'], $status['exitcode']);
        }
580 581

        // Remove this child.
582
        unset($children[$cid]);
583 584 585 586 587
      }
    }
  }
}

588 589 590
/**
 * Run a group of phpunit tests.
 */
591
function simpletest_script_run_phpunit($test_id, $class) {
592
  $results = simpletest_run_phpunit_tests($test_id, array($class));
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618
  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':
619
        $summaries[$result['test_class']]['#debug']++;
620 621 622 623 624
        break;
    }
  }

  foreach ($summaries as $class => $summary) {
625
    simpletest_script_reporter_display_summary($class, $summary);
626 627 628
  }
}

629
/**
630
 * Bootstrap Drupal and run a single test.
631 632
 */
function simpletest_script_run_one_test($test_id, $test_class) {
633
  global $args;
634

635
  try {
636 637 638 639 640 641 642 643 644 645
    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);
646 647 648 649 650 651 652 653 654
    if (is_subclass_of($test_class, '\PHPUnit_Framework_TestCase')) {
      simpletest_script_run_phpunit($test_id, $test_class);
    }
    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);
    }
655

656
    // Finished, kill this runner.
657
    exit(0);
658
  }
659 660
  // DrupalTestCase::run() catches exceptions already, so this is only reached
  // when an exception is thrown in the wrapping test runner environment.
661 662
  catch (Exception $e) {
    echo (string) $e;
663
    exit(1);
664
  }
665 666
}

667
/**
668 669 670 671 672 673
 * 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.
674
 */
675
function simpletest_script_command($test_id, $test_class) {
676
  global $args, $php;
677

678 679
  $command = escapeshellarg($php) . ' ' . escapeshellarg('./core/scripts/' . $args['script']);
  $command .= ' --url ' . escapeshellarg($args['url']);
680 681 682 683 684 685
  if (!empty($args['sqlite'])) {
    $command .= ' --sqlite ' . escapeshellarg($args['sqlite']);
  }
  if (!empty($args['dburl'])) {
    $command .= ' --dburl ' . escapeshellarg($args['dburl']);
  }
686 687
  $command .= ' --php ' . escapeshellarg($php);
  $command .= " --test-id $test_id";
688
  foreach (array('verbose', 'keep-results', 'color', 'die-on-fail') as $arg) {
689 690 691
    if ($args[$arg]) {
      $command .= ' --' . $arg;
    }
692
  }
693 694
  // --execute-test and class name needs to come last.
  $command .= ' --execute-test ' . escapeshellarg($test_class);
695
  return $command;
696 697
}

698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719
/**
 * 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) {
720
  if (is_subclass_of($test_class, '\PHPUnit_Framework_TestCase')) {
721 722 723
    // PHPUnit test, move on.
    return;
  }
724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741
  // Retrieve the last database prefix used for testing.
  list($db_prefix, ) = simpletest_last_test_get($test_id);

  // If no database prefix was found, then the test was not set up correctly.
  if (empty($db_prefix)) {
    echo "\nFATAL $test_class: Found no database prefix for test ID $test_id. (Check whether setUp() is invoked correctly.)";
    return;
  }

  // Do not output verbose cleanup messages in case of a positive exitcode.
  $output = !empty($exitcode);
  $messages = array();

  $messages[] = "- Found database prefix '$db_prefix' for test ID $test_id.";

  // Read the log file in case any fatal errors caused the test to crash.
  simpletest_log_read($test_id, $db_prefix, $test_class);

742 743 744
  // Check whether a test site directory was setup already.
  // @see \Drupal\simpletest\TestBase::prepareEnvironment()
  $test_directory = DRUPAL_ROOT . '/sites/simpletest/' . substr($db_prefix, 10);
745 746 747 748 749 750 751 752
  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;
      }
    }
753
    // Delete the test site directory.
754 755 756
    // simpletest_clean_temporary_directories() cannot be used here, since it
    // would also delete file directories of other tests that are potentially
    // running concurrently.
757
    file_unmanaged_delete_recursive($test_directory, array('Drupal\simpletest\TestBase', 'filePreDeleteCallback'));
758
    $messages[] = "- Removed test site directory.";
759 760 761
  }

  // Clear out all database tables from the test.
762
  $schema = Database::getConnection('default', 'default')->schema();
763
  $count = 0;
764 765
  foreach ($schema->findTables($db_prefix . '%') as $table) {
    $schema->dropTable($table);
766 767 768
    $count++;
  }
  if ($count) {
769
    $messages[] = "- Removed $count leftover tables.";
770 771 772 773 774 775 776 777
  }

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

778
/**
779
 * Get list of tests based on arguments. If --all specified then
780 781 782 783 784 785 786
 * 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() {
787
  global $args;
788 789

  $test_list = array();
790
  if ($args['all'] || $args['module']) {
791
    $groups = simpletest_test_get_all($args['module']);
792 793
    $all_tests = array();
    foreach ($groups as $group => $tests) {
794
      $all_tests = array_merge($all_tests, array_keys($tests));
795
    }
796
    $test_list = $all_tests;
797 798
  }
  else {
799
    if ($args['class']) {
800 801
      $test_list = array();
      foreach ($args['test_names'] as $test_class) {
802 803
        list($class_name, ) = explode('::', $test_class, 2);
        if (class_exists($class_name)) {
804 805 806 807 808 809 810 811
          $test_list[] = $test_class;
        }
        else {
          $groups = simpletest_test_get_all();
          $all_classes = array();
          foreach ($groups as $group) {
            $all_classes = array_merge($all_classes, array_keys($group));
          }
812 813
          simpletest_script_print_error('Test class not found: ' . $class_name);
          simpletest_script_print_alternatives($class_name, $all_classes, 6);
814
          exit(1);
815
        }
816 817
      }
    }
818
    elseif ($args['file']) {
819
      // Extract test case class names from specified files.
820
      foreach ($args['test_names'] as $file) {
821 822
        if (!file_exists($file)) {
          simpletest_script_print_error('File not found: ' . $file);
823
          exit;
824 825 826 827 828 829 830 831 832 833 834
        }
        $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) {
835
          $test_list = array_merge($test_list, $matches[1]);
836 837 838
        }
        else {
          foreach ($matches[1] as $class_name) {
839
            $namespace_class = $namespace . '\\' . $class_name;
840
            if (is_subclass_of($namespace_class, '\Drupal\simpletest\TestBase') || is_subclass_of($namespace_class, '\PHPUnit_Framework_TestCase')) {
841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894
              $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')) {
895 896
              $test_list[] = $namespace_class;
            }
897
          }
898 899 900
        }
      }
    }
901
    else {
902
      $groups = simpletest_test_get_all();
903
      foreach ($args['test_names'] as $group_name) {
904 905 906 907 908 909
        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));
910
          exit(1);
911
        }
912 913
      }
    }
914
  }
915

916 917
  if (empty($test_list)) {
    simpletest_script_print_error('No valid tests were specified.');
918
    exit;
919 920
  }
  return $test_list;
921 922
}

923 924 925 926
/**
 * Initialize the reporter.
 */
function simpletest_script_reporter_init() {
927
  global $args, $test_list, $results_map;
928 929 930 931 932 933

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

935 936 937 938
  echo "\n";
  echo "Drupal test run\n";
  echo "---------------\n";
  echo "\n";
939

940 941 942 943 944 945
  // 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";
946
    foreach ($test_list as $class_name) {
947
      echo "  - $class_name\n";
948 949
    }
    echo "\n";
950
  }
951

952
  echo "Test run started:\n";
953
  echo "  " . date('l, F j, Y - H:i', $_SERVER['REQUEST_TIME']) . "\n";
954
  Timer::start('run-tests');
955 956
  echo "\n";

957 958
  echo "Test summary\n";
  echo "------------\n";
959
  echo "\n";
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
/**
 * Displays the assertion result summary for a single test class.
 *
 * @param string $class
 *   The test class name that was run.
 * @param array $results
 *   The assertion results using #pass, #fail, #exception, #debug array keys.
 */
function simpletest_script_reporter_display_summary($class, $results) {
  // Output all test results vertically aligned.
  // Cut off the class name after 60 chars, and pad each group with 3 digits
  // by default (more than 999 assertions are rare).
  $output = vsprintf('%-60.60s %10s %9s %14s %12s', array(
    $class,
                                   $results['#pass']      . ' passes',
    !$results['#fail']      ? '' : $results['#fail']      . ' fails',
    !$results['#exception'] ? '' : $results['#exception'] . ' exceptions',
    !$results['#debug']     ? '' : $results['#debug']     . ' messages',
  ));

  $status = ($results['#fail'] || $results['#exception'] ? 'fail' : 'pass');
  simpletest_script_print($output . "\n", simpletest_script_color_code($status));
}

986
/**
987
 * Display jUnit XML test results.
988
 */
989
function simpletest_script_reporter_write_xml_results() {
990
  global $args, $test_ids, $results_map;
991

992
  $results = simpletest_script_load_messages_by_test_id($test_ids);
993 994 995 996 997 998 999 1000 1001

  $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])) {
1002
          file_put_contents($args['xml'] . '/' . str_replace('\\', '_', $test_class) . '.xml', $xml_files[$test_class]['doc']->saveXML());
1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019
          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);
1020 1021 1022 1023 1024 1025
      if (strpos($result->function, '->') !== FALSE) {
        list($class, $name) = explode('->', $result->function, 2);
      }
      else {
        $name = $result->function;
      }
1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055
      $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])) {
1056
    file_put_contents($args['xml'] . '/' . str_replace('\\', '_', $test_class) . '.xml', $xml_files[$test_class]['doc']->saveXML());
1057 1058 1059 1060 1061 1062 1063 1064
    unset($xml_files[$test_class]);
  }
}

/**
 * Stop the test timer.
 */
function simpletest_script_reporter_timer_stop() {
1065
  echo "\n";
1066
  $end = Timer::stop('run-tests');
1067
  echo "Test run duration: " . \Drupal::service('date.formatter')->formatInterval($end['time'] / 1000);
1068
  echo "\n\n";
1069 1070 1071 1072 1073 1074
}

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

1077 1078
  if ($args['verbose']) {
    // Report results.
1079 1080
    echo "Detailed test results\n";
    echo "---------------------\n";
1081

1082
    $results = simpletest_script_load_messages_by_test_id($test_ids);
1083
    $test_class = '';
1084
    foreach ($results as $result) {
1085 1086 1087 1088 1089
      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;
1090

1091 1092 1093
          // Print table header.
          echo "Status    Group      Filename          Line Function                            \n";
          echo "--------------------------------------------------------------------------------\n";
1094 1095 1096 1097 1098
        }

        simpletest_script_format_result($result);
      }
    }
1099 1100 1101
  }
}

1102 1103 1104 1105 1106 1107 1108
/**
 * 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) {
1109
  global $args, $results_map, $color;
1110

1111 1112
  $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);
1113 1114

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

1116 1117 1118 1119 1120
  $message = trim(strip_tags($result->message));
  if ($args['non-html']) {
    $message = Html::decodeEntities($message, ENT_QUOTES, 'UTF-8');
  }
  $lines = explode("\n", wordwrap($message), 76);
1121 1122 1123 1124
  foreach ($lines as $line) {
    echo "    $line\n";
  }
}
1125

1126
/**
1127 1128 1129 1130
 * Print error message prefixed with "  ERROR: " and displayed in fail color
 * if color output is enabled.
 *
 * @param $message The message to print.
1131
 */
1132 1133
function simpletest_script_print_error($message) {
  simpletest_script_print("  ERROR: $message\n", SIMPLETEST_SCRIPT_COLOR_FAIL);
1134
}
1135

1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169
/**
 * 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.
}
1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203

/**
 * Prints alternative test names.
 *
 * Searches the provided array of string values for close matches based on the
 * Levenshtein algorithm.
 *
 * @see http://php.net/manual/en/function.levenshtein.php
 *
 * @param string $string
 *   A string to test.
 * @param array $array
 *   A list of strings to search.
 * @param int $degree
 *   The matching strictness. Higher values return fewer matches. A value of
 *   4 means that the function will return strings from $array if the candidate
 *   string in $array would be identical to $string by changing 1/4 or fewer of
 *   its characters.
 */
function simpletest_script_print_alternatives($string, $array, $degree = 4) {
  $alternatives = array();
  foreach ($array as $item) {
    $lev = levenshtein($string, $item);
    if ($lev <= strlen($item) / $degree || FALSE !== strpos($string, $item)) {
      $alternatives[] = $item;
    }
  }
  if (!empty($alternatives)) {
    simpletest_script_print("  Did you mean?\n", SIMPLETEST_SCRIPT_COLOR_FAIL);
    foreach ($alternatives as $alternative) {
      simpletest_script_print("  - $alternative\n", SIMPLETEST_SCRIPT_COLOR_FAIL);
    }
  }
}
1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230

/**
 * Loads the simpletest messages from the database.
 *
 * Messages are ordered by test class and message id.
 *
 * @param array $test_ids
 *   Array of test IDs of the messages to be loaded.
 *
 * @return array
 *   Array of simpletest messages from the database.
 */
function simpletest_script_load_messages_by_test_id($test_ids) {
  global $args;
  $results = array();

  // Sqlite has a maximum number of variables per query. If required, the
  // database query is split into chunks.
  if (count($test_ids) > SIMPLETEST_SCRIPT_SQLITE_VARIABLE_LIMIT && !empty($args['sqlite'])) {
    $test_id_chunks = array_chunk($test_ids, SIMPLETEST_SCRIPT_SQLITE_VARIABLE_LIMIT);
  }
  else {
    $test_id_chunks = array($test_ids);
  }

  foreach ($test_id_chunks as $test_id_chunk) {
    $result_chunk = Database::getConnection('default', 'test-runner')
1231 1232
      ->query("SELECT * FROM {simpletest} WHERE test_id IN ( :test_ids[] ) ORDER BY test_class, message_id", array(
        ':test_ids[]' => $test_id_chunk,
1233 1234 1235 1236 1237 1238 1239 1240
      ))->fetchAll();
    if ($result_chunk) {
      $results = array_merge($results, $result_chunk);
    }
  }

  return $results;
}
1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272

/**
 * Display test results.
 */
function simpletest_script_open_browser() {
  global $test_ids;

  $connection = Database::getConnection('default', 'test-runner');
  $results = $connection->select('simpletest')
    ->fields('simpletest')
    ->condition('test_id', $test_ids, 'IN')
    ->orderBy('test_class')
    ->orderBy('message_id')
    ->execute()
    ->fetchAll();

  // Get the results form.
  $form = array();
  SimpletestResultsForm::addResultForm($form, $results);

  // Get the assets to make the details element collapsible and theme the result
  // form.
  $assets = new \Drupal\Core\Asset\AttachedAssets();
  $assets->setLibraries(['core/drupal.collapse', 'system/admin', 'simpletest/drupal.simpletest']);
  $resolver = \Drupal::service('asset.resolver');
  list($js_assets_header, $js_assets_footer) = $resolver->getJsAssets($assets, FALSE);
  $js_collection_renderer = \Drupal::service('asset.js.collection_renderer');
  $js_assets_header = $js_collection_renderer->render($js_assets_header);
  $js_assets_footer = $js_collection_renderer->render($js_assets_footer);
  $css_assets = \Drupal::service('asset.css.collection_renderer')->render($resolver->getCssAssets($assets, FALSE));

  // Make the html page to write to disk.
1273 1274
  $render_service = \Drupal::service('renderer');
  $html = '<head>' . ($js_assets_header) . $render_service->renderPlain($css_assets) . '</head><body>' . $render_service->renderPlain($form) . $render_service->renderPlain($js_assets_footer) .'</body>';
1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301