run-tests.sh 36.2 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\Timer;
9
use Drupal\Core\Database\Database;
10
use Drupal\Core\Site\Settings;
11
use Drupal\Core\Test\TestRunnerKernel;
12
13
use Symfony\Component\HttpFoundation\Request;

14
$autoloader = require_once __DIR__ . '/../vendor/autoload.php';
15

16
17
18
const SIMPLETEST_SCRIPT_COLOR_PASS = 32; // Green.
const SIMPLETEST_SCRIPT_COLOR_FAIL = 31; // Red.
const SIMPLETEST_SCRIPT_COLOR_EXCEPTION = 33; // Brown.
19
20
21
22
23
24
25
26
27

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

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

28
simpletest_script_init();
29
30
31
32

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

34
if ($args['execute-test']) {
35
  simpletest_script_setup_database();
36
  simpletest_script_run_one_test($args['test-id'], $args['execute-test']);
37
  // Sub-process exited already; this is just for clarity.
38
39
  exit;
}
40
41

simpletest_script_setup_database(TRUE);
42
43

if ($args['clean']) {
44
  // Clean up left-over tables and directories.
45
46
47
48
  simpletest_clean_environment();
  echo "\nEnvironment cleaned.\n";

  // Get the status messages and print them.
49
50
  $messages = drupal_get_messages('status');
  foreach ($messages['status'] as $text) {
51
52
53
54
55
56
    echo " - " . $text . "\n";
  }
  exit;
}

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

70
71
$test_list = simpletest_script_get_test_list();

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

simpletest_script_reporter_init();

77
$tests_to_run = array();
78
for ($i = 0; $i < $args['repeat']; $i++) {
79
  $tests_to_run = array_merge($tests_to_run, $test_list);
80
}
81

82
83
84
// Execute tests.
simpletest_script_execute_batch($tests_to_run);

85
86
87
// Stop the timer.
simpletest_script_reporter_timer_stop();

88
89
90
// Display results before database is cleared.
simpletest_script_reporter_display_results();

91
92
93
94
if ($args['xml']) {
  simpletest_script_reporter_write_xml_results();
}

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

100
101
102
// Test complete, exit.
exit;

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

  echo <<<EOF

Run Drupal tests from the shell.

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

All arguments are long options.

  --help      Print this page.
119
120
121

  --list      Display all available test groups.

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

125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
  --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,
140
              and database name to use in tests.
141
142
              Required when running tests without a Drupal installation that
              contains default database connection info in settings.php.
143
144
145
146
              Examples:
                mysql://username:password@localhost/databasename#table_prefix
                sqlite://localhost/relative/path/db.sqlite
                sqlite://localhost//absolute/path/db.sqlite
147

148
  --php       The absolute path to the PHP executable. Usually not needed.
149

150
151
  --concurrency [num]

152
              Run tests in parallel, up to [num] tests at a time.
153

154
  --all       Run all available tests.
155

156
157
158
  --module    Run all tests belonging to the specified module name.
              (e.g., 'node')

159
  --class     Run tests identified by specific class names, instead of group names.
160

161
  --file      Run tests identified by specific file names, instead of group names.
162
163
              Specify the path and the extension
              (i.e. 'core/modules/user/user.test').
164

165
166
167
168
169
  --xml       <path>

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

  --color     Output text format results with color highlighting.
170
171
172

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

173
174
175
176
177
  --keep-results

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

178
179
180
181
  --repeat    Number of times to repeat the test.

  --die-on-fail

182
183
184
185
              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.
186

187
188
  <test1>[,<test2>[,<test3> ...]]

189
              One or more tests to be run. By default, these are interpreted
190
              as the names of test groups as shown at
191
              admin/config/development/testing.
192
              These group names typically correspond to module names like "User"
193
              or "Profile" or "System", but there is also a group "Database".
194
              If --class is specified then these are interpreted as the names of
195
196
              specific test classes whose test methods will be run. Tests must
              be separated by commas. Ignored if --all is specified.
197

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

201
sudo -u [wwwrun|www-data|etc] php ./core/scripts/{$args['script']}
202
  --url http://example.com/ --all
203
sudo -u [wwwrun|www-data|etc] php ./core/scripts/{$args['script']}
204
  --url http://example.com/ --class "Drupal\block\Tests\BlockTest"
205
206
207
208
209
210
211
212
213
214

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

215
216
217
EOF;
}

218
219
220
221
222
223
224
225
226
227
228
229
230
/**
 * 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' => '',
231
232
    'sqlite' => NULL,
    'dburl' => NULL,
233
    'php' => '',
234
235
    'concurrency' => 1,
    'all' => FALSE,
236
    'module' => NULL,
237
    'class' => FALSE,
238
    'file' => FALSE,
239
240
    'color' => FALSE,
    'verbose' => FALSE,
241
    'keep-results' => FALSE,
242
    'test_names' => array(),
243
244
    'repeat' => 1,
    'die-on-fail' => FALSE,
245
    // Used internally.
246
247
    'test-id' => 0,
    'execute-test' => '',
248
    'xml' => '',
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
  );

  // 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']);
        }
267
        // Clear extraneous values.
268
269
270
271
272
273
274
275
276
277
278
279
        $args['test_names'] = array();
        $count++;
      }
      else {
        // Argument not found in list.
        simpletest_script_print_error("Unknown argument '$arg'.");
        exit;
      }
    }
    else {
      // Values found without an argument should be test names.
      $args['test_names'] += explode(',', $arg);
280
      $count++;
281
    }
282
  }
283
284
285
286
287
288
289

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

290
  return array($args, $count);
291
292
}

293
294
295
/**
 * Initialize script variables and perform general setup requirements.
 */
296
function simpletest_script_init() {
297
298
299
300
  global $args, $php;

  $host = 'localhost';
  $path = '';
301
302
  $port = '80';

303
  // Determine location of php command automatically, unless a command line argument is supplied.
304
  if (!empty($args['php'])) {
305
306
    $php = $args['php'];
  }
307
  elseif ($php_env = getenv('_')) {
308
    // '_' is an environment variable set by the shell. It contains the command that was executed.
309
    $php = $php_env;
310
  }
311
  elseif ($sudo = getenv('SUDO_COMMAND')) {
312
313
    // 'SUDO_COMMAND' is an environment variable set by the sudo program.
    // Extract only the PHP interpreter, not the rest of the command.
314
    list($php, ) = explode(' ', $sudo, 2);
315
316
  }
  else {
317
    simpletest_script_print_error('Unable to automatically determine the path to the PHP interpreter. Supply the --php command line argument.');
318
    simpletest_script_help();
319
320
    exit();
  }
321

322
  // Get URL from arguments.
323
324
  if (!empty($args['url'])) {
    $parsed_url = parse_url($args['url']);
325
    $host = $parsed_url['host'] . (isset($parsed_url['port']) ? ':' . $parsed_url['port'] : '');
326
    $path = isset($parsed_url['path']) ? rtrim(rtrim($parsed_url['path']), '/') : '';
327
    $port = (isset($parsed_url['port']) ? $parsed_url['port'] : $port);
328
329
330
    if ($path == '/') {
      $path = '';
    }
331
    // If the passed URL schema is 'https' then setup the $_SERVER variables
332
    // properly so that testing will run under HTTPS.
333
334
335
    if ($parsed_url['scheme'] == 'https') {
      $_SERVER['HTTPS'] = 'on';
    }
336
337
338
339
340
  }

  $_SERVER['HTTP_HOST'] = $host;
  $_SERVER['REMOTE_ADDR'] = '127.0.0.1';
  $_SERVER['SERVER_ADDR'] = '127.0.0.1';
341
  $_SERVER['SERVER_PORT'] = $port;
342
  $_SERVER['SERVER_SOFTWARE'] = NULL;
343
344
  $_SERVER['SERVER_NAME'] = 'localhost';
  $_SERVER['REQUEST_URI'] = $path .'/';
345
  $_SERVER['REQUEST_METHOD'] = 'GET';
346
  $_SERVER['SCRIPT_NAME'] = $path .'/index.php';
347
  $_SERVER['SCRIPT_FILENAME'] = $path .'/index.php';
348
349
350
  $_SERVER['PHP_SELF'] = $path .'/index.php';
  $_SERVER['HTTP_USER_AGENT'] = 'Drupal command line';

351
  if (!empty($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on') {
352
353
354
355
356
357
    // Ensure that any and all environment variables are changed to https://.
    foreach ($_SERVER as $key => $value) {
      $_SERVER[$key] = str_replace('http://', 'https://', $_SERVER[$key]);
    }
  }

358
  chdir(realpath(__DIR__ . '/../..'));
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
}

/**
 * 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) {
388
  global $args;
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411

  // 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');

    $info = parse_url($args['dburl']);
    if (!isset($info['scheme'], $info['host'], $info['path'])) {
      simpletest_script_print_error('Invalid --dburl. Minimum requirement: driver://host/database');
      exit(1);
    }
    $info += array(
      'user' => '',
      'pass' => '',
      'fragment' => '',
    );
412
413
414
415
416
417
    if ($info['path'][0] === '/') {
      $info['path'] = substr($info['path'], 1);
    }
    if ($info['scheme'] === 'sqlite' && $info['path'][0] !== '/') {
      $info['path'] = DRUPAL_ROOT . '/' . $info['path'];
    }
418
419
420
421
422
    $databases['default']['default'] = array(
      'driver' => $info['scheme'],
      'username' => $info['user'],
      'password' => $info['pass'],
      'host' => $info['host'],
423
      'database' => $info['path'],
424
425
426
427
      'prefix' => array(
        'default' => $info['fragment'],
      ),
    );
428
429
430
    if (isset($info['port'])) {
      $databases['default']['default']['port'] = $info['port'];
    }
431
  }
432
433
434
  // Otherwise, use the default database connection from settings.php.
  else {
    $databases['default'] = Database::getConnectionInfo('default');
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
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
501
  }

  // 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.');
    exit(1);
  }
  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());
    exit(1);
  }
  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.');
    exit(1);
  }
}

502
503
504
/**
 * Execute a batch of tests.
 */
505
function simpletest_script_execute_batch($test_classes) {
506
  global $args, $test_ids;
507

508
509
  // Multi-process execution.
  $children = array();
510
  while (!empty($test_classes) || !empty($children)) {
511
    while (count($children) < $args['concurrency']) {
512
      if (empty($test_classes)) {
513
        break;
514
      }
515

516
517
      $test_id = Database::getConnection('default', 'test-runner')
        ->insert('simpletest_test_id')->useDefaults(array('test_id'))->execute();
518
      $test_ids[] = $test_id;
519

520
      $test_class = array_shift($test_classes);
521
522
      // Process phpunit tests immediately since they are fast and we don't need
      // to fork for them.
523
524
      if (is_subclass_of($test_class, 'Drupal\Tests\UnitTestCase')) {
        simpletest_script_run_phpunit($test_id, $test_class);
525
526
527
528
        continue;
      }

      // Fork a child process.
529
530
531
532
533
534
      $command = simpletest_script_command($test_id, $test_class);
      $process = proc_open($command, array(), $pipes, NULL, NULL, array('bypass_shell' => TRUE));

      if (!is_resource($process)) {
        echo "Unable to fork test process. Aborting.\n";
        exit;
535
536
      }

537
538
539
      // Register our new child.
      $children[] = array(
        'process' => $process,
540
        'test_id' => $test_id,
541
542
543
544
        'class' => $test_class,
        'pipes' => $pipes,
      );
    }
545

546
547
548
549
550
551
552
553
554
555
    // Wait for children every 200ms.
    usleep(200000);

    // Check if some children finished.
    foreach ($children as $cid => $child) {
      $status = proc_get_status($child['process']);
      if (empty($status['running'])) {
        // The child exited, unregister it.
        proc_close($child['process']);
        if ($status['exitcode']) {
556
          echo 'FATAL ' . $child['class'] . ': test runner returned a non-zero error code (' . $status['exitcode'] . ').' . "\n";
557
558
          if ($args['die-on-fail']) {
            list($db_prefix, ) = simpletest_last_test_get($child['test_id']);
559
            $test_directory = 'sites/simpletest/' . substr($db_prefix, 10);
560
            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";
561
562
563
            $args['keep-results'] = TRUE;
            // Exit repeat loop immediately.
            $args['repeat'] = -1;
564
          }
565
        }
566
        // Free-up space by removing any potentially created resources.
567
568
569
        if (!$args['keep-results']) {
          simpletest_script_cleanup($child['test_id'], $child['class'], $status['exitcode']);
        }
570
571

        // Remove this child.
572
        unset($children[$cid]);
573
574
575
576
577
      }
    }
  }
}

578
579
580
/**
 * Run a group of phpunit tests.
 */
581
582
function simpletest_script_run_phpunit($test_id, $class) {
  $results = simpletest_run_phpunit_tests($test_id, array($class));
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
  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':
609
        $summaries[$result['test_class']]['#debug']++;
610
611
612
613
614
        break;
    }
  }

  foreach ($summaries as $class => $summary) {
615
    simpletest_script_reporter_display_summary($class, $summary);
616
617
618
  }
}

619
/**
620
 * Bootstrap Drupal and run a single test.
621
622
 */
function simpletest_script_run_one_test($test_id, $test_class) {
623
  global $args;
624

625
626
  try {
    $test = new $test_class($test_id);
627
    $test->dieOnFail = (bool) $args['die-on-fail'];
628
    $test->verbose = (bool) $args['verbose'];
629
630
    $test->run();

631
    simpletest_script_reporter_display_summary($test_class, $test->results);
632

633
634
635
    // Finished, kill this runner.
    exit(0);
  }
636
637
  // DrupalTestCase::run() catches exceptions already, so this is only reached
  // when an exception is thrown in the wrapping test runner environment.
638
639
640
641
  catch (Exception $e) {
    echo (string) $e;
    exit(1);
  }
642
643
}

644
/**
645
646
647
648
649
650
 * 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.
651
 */
652
function simpletest_script_command($test_id, $test_class) {
653
  global $args, $php;
654

655
656
  $command = escapeshellarg($php) . ' ' . escapeshellarg('./core/scripts/' . $args['script']);
  $command .= ' --url ' . escapeshellarg($args['url']);
657
658
659
660
661
662
  if (!empty($args['sqlite'])) {
    $command .= ' --sqlite ' . escapeshellarg($args['sqlite']);
  }
  if (!empty($args['dburl'])) {
    $command .= ' --dburl ' . escapeshellarg($args['dburl']);
  }
663
664
  $command .= ' --php ' . escapeshellarg($php);
  $command .= " --test-id $test_id";
665
  foreach (array('verbose', 'keep-results', 'color', 'die-on-fail') as $arg) {
666
667
668
    if ($args[$arg]) {
      $command .= ' --' . $arg;
    }
669
  }
670
671
  // --execute-test and class name needs to come last.
  $command .= ' --execute-test ' . escapeshellarg($test_class);
672
  return $command;
673
674
}

675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
/**
 * Removes all remnants of a test runner.
 *
 * In case a (e.g., fatal) error occurs after the test site has been fully setup
 * and the error happens in many tests, the environment that executes the tests
 * can easily run out of memory or disk space. This function ensures that all
 * created resources are properly cleaned up after every executed test.
 *
 * This clean-up only exists in this script, since SimpleTest module itself does
 * not use isolated sub-processes for each test being run, so a fatal error
 * halts not only the test, but also the test runner (i.e., the parent site).
 *
 * @param int $test_id
 *   The test ID of the test run.
 * @param string $test_class
 *   The class name of the test run.
 * @param int $exitcode
 *   The exit code of the test runner.
 *
 * @see simpletest_script_run_one_test()
 */
function simpletest_script_cleanup($test_id, $test_class, $exitcode) {
  // Retrieve the last database prefix used for testing.
  list($db_prefix, ) = simpletest_last_test_get($test_id);

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

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

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

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

715
716
717
  // Check whether a test site directory was setup already.
  // @see \Drupal\simpletest\TestBase::prepareEnvironment()
  $test_directory = DRUPAL_ROOT . '/sites/simpletest/' . substr($db_prefix, 10);
718
719
720
721
722
723
724
725
  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;
      }
    }
726
    // Delete the test site directory.
727
728
729
    // simpletest_clean_temporary_directories() cannot be used here, since it
    // would also delete file directories of other tests that are potentially
    // running concurrently.
730
    file_unmanaged_delete_recursive($test_directory, array('Drupal\simpletest\TestBase', 'filePreDeleteCallback'));
731
    $messages[] = "- Removed test site directory.";
732
733
734
  }

  // Clear out all database tables from the test.
735
  $schema = Database::getConnection('default', 'default')->schema();
736
  $count = 0;
737
738
  foreach ($schema->findTables($db_prefix . '%') as $table) {
    $schema->dropTable($table);
739
740
741
    $count++;
  }
  if ($count) {
742
    $messages[] = "- Removed $count leftover tables.";
743
744
745
746
747
748
749
750
  }

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

751
/**
752
 * Get list of tests based on arguments. If --all specified then
753
754
755
756
757
758
759
 * 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() {
760
  global $args;
761
762

  $test_list = array();
763
  if ($args['all'] || $args['module']) {
764
    $groups = simpletest_test_get_all($args['module']);
765
766
    $all_tests = array();
    foreach ($groups as $group => $tests) {
767
      $all_tests = array_merge($all_tests, array_keys($tests));
768
    }
769
    $test_list = $all_tests;
770
771
  }
  else {
772
    if ($args['class']) {
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
      $test_list = array();
      foreach ($args['test_names'] as $test_class) {
        if (class_exists($test_class)) {
          $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));
          }
          simpletest_script_print_error('Test class not found: ' . $test_class);
          simpletest_script_print_alternatives($test_class, $all_classes, 6);
          exit(1);
        }
788
789
      }
    }
790
    elseif ($args['file']) {
791
      // Extract test case class names from specified files.
792
      foreach ($args['test_names'] as $file) {
793
794
795
796
797
798
799
800
801
802
803
804
805
806
        if (!file_exists($file)) {
          simpletest_script_print_error('File not found: ' . $file);
          exit;
        }
        $content = file_get_contents($file);
        // Extract a potential namespace.
        $namespace = FALSE;
        if (preg_match('@^namespace ([^ ;]+)@m', $content, $matches)) {
          $namespace = $matches[1];
        }
        // Extract all class names.
        // Abstract classes are excluded on purpose.
        preg_match_all('@^class ([^ ]+)@m', $content, $matches);
        if (!$namespace) {
807
          $test_list = array_merge($test_list, $matches[1]);
808
809
810
        }
        else {
          foreach ($matches[1] as $class_name) {
811
812
813
814
            $namespace_class = $namespace . '\\' . $class_name;
            if (is_subclass_of($namespace_class, '\Drupal\simpletest\TestBase') || is_subclass_of($namespace_class, '\Drupal\Tests\UnitTestCase')) {
              $test_list[] = $namespace_class;
            }
815
          }
816
817
818
        }
      }
    }
819
    else {
820
      $groups = simpletest_test_get_all();
821
      foreach ($args['test_names'] as $group_name) {
822
823
824
825
826
827
828
829
        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));
          exit(1);
        }
830
831
      }
    }
832
  }
833

834
835
836
837
838
  if (empty($test_list)) {
    simpletest_script_print_error('No valid tests were specified.');
    exit;
  }
  return $test_list;
839
840
}

841
842
843
844
/**
 * Initialize the reporter.
 */
function simpletest_script_reporter_init() {
845
  global $args, $test_list, $results_map;
846
847
848
849
850
851

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

853
854
855
856
  echo "\n";
  echo "Drupal test run\n";
  echo "---------------\n";
  echo "\n";
857

858
859
860
861
862
863
  // 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";
864
    foreach ($test_list as $class_name) {
865
      echo "  - $class_name\n";
866
867
    }
    echo "\n";
868
  }
869

870
  echo "Test run started:\n";
871
  echo "  " . date('l, F j, Y - H:i', $_SERVER['REQUEST_TIME']) . "\n";
872
  Timer::start('run-tests');
873
874
  echo "\n";

875
876
  echo "Test summary\n";
  echo "------------\n";
877
  echo "\n";
878
879
}

880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
/**
 * 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));
}

904
/**
905
 * Display jUnit XML test results.
906
 */
907
function simpletest_script_reporter_write_xml_results() {
908
  global $args, $test_ids, $results_map;
909

910
911
912
913
  $results = Database::getConnection('default', 'test-runner')
    ->query("SELECT * FROM {simpletest} WHERE test_id IN (:test_ids) ORDER BY test_class, message_id", array(
      ':test_ids' => $test_ids,
    ));
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
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

  $test_class = '';
  $xml_files = array();

  foreach ($results as $result) {
    if (isset($results_map[$result->status])) {
      if ($result->test_class != $test_class) {
        // We've moved onto a new class, so write the last classes results to a file:
        if (isset($xml_files[$test_class])) {
          file_put_contents($args['xml'] . '/' . $test_class . '.xml', $xml_files[$test_class]['doc']->saveXML());
          unset($xml_files[$test_class]);
        }
        $test_class = $result->test_class;
        if (!isset($xml_files[$test_class])) {
          $doc = new DomDocument('1.0');
          $root = $doc->createElement('testsuite');
          $root = $doc->appendChild($root);
          $xml_files[$test_class] = array('doc' => $doc, 'suite' => $root);
        }
      }

      // For convenience:
      $dom_document = &$xml_files[$test_class]['doc'];

      // Create the XML element for this test case:
      $case = $dom_document->createElement('testcase');
      $case->setAttribute('classname', $test_class);
      list($class, $name) = explode('->', $result->function, 2);
      $case->setAttribute('name', $name);

      // Passes get no further attention, but failures and exceptions get to add more detail:
      if ($result->status == 'fail') {
        $fail = $dom_document->createElement('failure');
        $fail->setAttribute('type', 'failure');
        $fail->setAttribute('message', $result->message_group);
        $text = $dom_document->createTextNode($result->message);
        $fail->appendChild($text);
        $case->appendChild($fail);
      }
      elseif ($result->status == 'exception') {
        // In the case of an exception the $result->function may not be a class
        // method so we record the full function name:
        $case->setAttribute('name', $result->function);

        $fail = $dom_document->createElement('error');
        $fail->setAttribute('type', 'exception');
        $fail->setAttribute('message', $result->message_group);
        $full_message = $result->message . "\n\nline: " . $result->line . "\nfile: " . $result->file;
        $text = $dom_document->createTextNode($full_message);
        $fail->appendChild($text);
        $case->appendChild($fail);
      }
      // Append the test case XML to the test suite:
      $xml_files[$test_class]['suite']->appendChild($case);
    }
  }
  // The last test case hasn't been saved to a file yet, so do that now:
  if (isset($xml_files[$test_class])) {
    file_put_contents($args['xml'] . '/' . $test_class . '.xml', $xml_files[$test_class]['doc']->saveXML());
    unset($xml_files[$test_class]);
  }
}

/**
 * Stop the test timer.
 */
function simpletest_script_reporter_timer_stop() {
981
  echo "\n";
982
  $end = Timer::stop('run-tests');
983
  echo "Test run duration: " . \Drupal::service('date.formatter')->formatInterval($end['time'] / 1000);
984
  echo "\n\n";
985
986
987
988
989
990
}

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

993
994
  if ($args['verbose']) {
    // Report results.
995
996
    echo "Detailed test results\n";
    echo "---------------------\n";
997

998
999
1000
1001
    $results = Database::getConnection('default', 'test-runner')
      ->query("SELECT * FROM {simpletest} WHERE test_id IN (:test_ids) ORDER BY test_class, message_id", array(
        ':test_ids' => $test_ids,
      ));
1002
    $test_class = '';
1003
    foreach ($results as $result) {
1004
1005
1006
1007
1008
      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;
1009

1010
1011
1012
          // Print table header.
          echo "Status    Group      Filename          Line Function                            \n";
          echo "--------------------------------------------------------------------------------\n";
1013
1014
1015
1016
1017
        }

        simpletest_script_format_result($result);
      }
    }
1018
1019
1020
  }
}

1021
1022
1023
1024
1025
1026
1027
1028
1029
/**
 * Format the result so that it fits within the default 80 character
 * terminal size.
 *
 * @param $result The result object to format.
 */
function simpletest_script_format_result($result) {
  global $results_map, $color;

1030
1031
  $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);
1032
1033

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

1035
1036
1037
1038
1039
  $lines = explode("\n", wordwrap(trim(strip_tags($result->message)), 76));
  foreach ($lines as $line) {
    echo "    $line\n";
  }
}
1040

1041
/**
1042
1043
1044
1045
 * Print error message prefixed with "  ERROR: " and displayed in fail color
 * if color output is enabled.
 *
 * @param $message The message to print.
1046
 */
1047
1048
function simpletest_script_print_error($message) {
  simpletest_script_print("  ERROR: $message\n", SIMPLETEST_SCRIPT_COLOR_FAIL);
1049
}
1050

1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
/**
 * 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.
}
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118

/**
 * 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);
    }
  }
}