<?php

/**

 * @file

 * This script runs Drupal tests from command line.

 */

define('SIMPLETEST_SCRIPT_COLOR_PASS', 32); // Green.

define('SIMPLETEST_SCRIPT_COLOR_FAIL', 31); // Red.

define('SIMPLETEST_SCRIPT_COLOR_EXCEPTION', 33); // Brown.

define('SIMPLETEST_SCRIPT_EXIT_SUCCESS', 0);

define('SIMPLETEST_SCRIPT_EXIT_FAILURE', 1);

define('SIMPLETEST_SCRIPT_EXIT_EXCEPTION', 2);

// Set defaults and get overrides.

list($args, $count) = simpletest_script_parse_args();

if ($args['help'] || $count == 0) {

  simpletest_script_help();

  exit(($count == 0) ? SIMPLETEST_SCRIPT_EXIT_FAILURE : SIMPLETEST_SCRIPT_EXIT_SUCCESS);

}

if ($args['execute-test']) {

  // Masquerade as Apache for running tests.

  simpletest_script_init("Apache");

  simpletest_script_run_one_test($args['test-id'], $args['execute-test']);

}

else {

  // Run administrative functions as CLI.

  simpletest_script_init(NULL);

}

// Bootstrap to perform initial validation or other operations.

drupal_bootstrap(DRUPAL_BOOTSTRAP_FULL);

if (!module_exists('simpletest')) {

  simpletest_script_print_error("The simpletest module must be enabled before this script can run.");

  exit(SIMPLETEST_SCRIPT_EXIT_FAILURE);

}

if ($args['clean']) {

  // Clean up left-over times and directories.

  simpletest_clean_environment();

  echo "\nEnvironment cleaned.\n";

  // Get the status messages and print them.

  $messages = array_pop(drupal_get_messages('status'));

  foreach ($messages as $text) {

    echo " - " . $text . "\n";

  }

  exit(SIMPLETEST_SCRIPT_EXIT_SUCCESS);

}

// Load SimpleTest files.

$groups = simpletest_test_get_all();

$all_tests = array();

foreach ($groups as $group => $tests) {

  $all_tests = array_merge($all_tests, array_keys($tests));

}

$test_list = array();

if ($args['list']) {

  // Display all available tests.

  echo "\nAvailable test groups & classes\n";

  echo   "-------------------------------\n\n";

  foreach ($groups as $group => $tests) {

    echo $group . "\n";

    foreach ($tests as $class => $info) {

      echo " - " . $info['name'] . ' (' . $class . ')' . "\n";

    }

  }

  exit(SIMPLETEST_SCRIPT_EXIT_SUCCESS);

}

$test_list = simpletest_script_get_test_list();

// Try to allocate unlimited time to run the tests.

drupal_set_time_limit(0);

simpletest_script_reporter_init();

// Setup database for test results.

$test_id = db_insert('simpletest_test_id')->useDefaults(array('test_id'))->execute();

// Execute tests.

$status = simpletest_script_execute_batch($test_id, simpletest_script_get_test_list());

// Retrieve the last database prefix used for testing and the last test class

// that was run from. Use the information to read the lgo file in case any

// fatal errors caused the test to crash.

list($last_prefix, $last_test_class) = simpletest_last_test_get($test_id);

simpletest_log_read($test_id, $last_prefix, $last_test_class);

// Stop the timer.

simpletest_script_reporter_timer_stop();

// Display results before database is cleared.

simpletest_script_reporter_display_results();

if ($args['xml']) {

  simpletest_script_reporter_write_xml_results();

}

// Cleanup our test results.

simpletest_clean_results_table($test_id);

// Test complete, exit.

exit($status);

/**

 * Print help text.

 */

function simpletest_script_help() {

  global $args;

  echo <<<EOF

Run Drupal tests from the shell.

Usage:        {$args['script']} [OPTIONS] <tests>

Example:      {$args['script']} Profile

All arguments are long options.

  --help      Print this page.

  --list      Display all available test groups.

  --clean     Cleans up database tables or directories from previous, failed,

              tests and then exits (no tests are run).

  --url       Immediately precedes a URL to set the host and path. You will

              need this parameter if Drupal is in a subdirectory on your

              localhost and you have not set \$base_url in settings.php. Tests

              can be run under SSL by including https:// in the URL.

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

  --concurrency [num]

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

  --all       Run all available tests.

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

  --file      Run tests identified by specific file names, instead of group names.

              Specify the path and the extension (i.e. 'modules/user/user.test').

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

  --xml       <path>

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

  --color     Output text format results with color highlighting.

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

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

              One or more tests to be run. By default, these are interpreted

              as the names of test groups as shown at

              ?q=admin/config/development/testing.

              These group names typically correspond to module names like "User"

              or "Profile" or "System", but there is also a group "XML-RPC".

              If --class is specified then these are interpreted as the names of

              specific test classes whose test methods will be run. Tests must

              be separated by commas. Ignored if --all is specified.

To run this script you will normally invoke it from the root directory of your

Drupal installation as the webserver user (differs per configuration), or root:

sudo -u [wwwrun|www-data|etc] php ./scripts/{$args['script']}

  --url http://example.com/ --all

sudo -u [wwwrun|www-data|etc] php ./scripts/{$args['script']}

  --url http://example.com/ --class BlockTestCase

\n

EOF;

}

/**

 * 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' => '',

    'php' => '',

    'concurrency' => 1,

    'all' => FALSE,

    'class' => FALSE,

    'file' => FALSE,

    'directory' => '',

    'color' => FALSE,

    'verbose' => FALSE,

    'test_names' => array(),

    // Used internally.

    'test-id' => 0,

    'execute-test' => '',

    'xml' => '',

  );

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

        }

        // Clear extraneous values.

        $args['test_names'] = array();

        $count++;

      }

      else {

        // Argument not found in list.

        simpletest_script_print_error("Unknown argument '$arg'.");

        exit(SIMPLETEST_SCRIPT_EXIT_FAILURE);

      }

    }

    else {

      // Values found without an argument should be test names.

      $args['test_names'] += explode(',', $arg);

      $count++;

    }

  }

  // Validate the concurrency argument

  if (!is_numeric($args['concurrency']) || $args['concurrency'] <= 0) {

    simpletest_script_print_error("--concurrency must be a strictly positive integer.");

    exit(SIMPLETEST_SCRIPT_EXIT_FAILURE);

  }

  return array($args, $count);

}

/**

 * Initialize script variables and perform general setup requirements.

 */

function simpletest_script_init($server_software) {

  global $args, $php;

  $host = 'localhost';

  $path = '';

  // Determine location of php command automatically, unless a command line argument is supplied.

  if (!empty($args['php'])) {

    $php = $args['php'];

  }

  elseif ($php_env = getenv('_')) {

    // '_' is an environment variable set by the shell. It contains the command that was executed.

    $php = $php_env;

  }

  elseif ($sudo = getenv('SUDO_COMMAND')) {

    // 'SUDO_COMMAND' is an environment variable set by the sudo program.

    // Extract only the PHP interpreter, not the rest of the command.

    list($php, ) = explode(' ', $sudo, 2);

  }

  else {

    simpletest_script_print_error('Unable to automatically determine the path to the PHP interpreter. Supply the --php command line argument.');

    simpletest_script_help();

    exit(SIMPLETEST_SCRIPT_EXIT_FAILURE);

  }

  // Get URL from arguments.

  if (!empty($args['url'])) {

    $parsed_url = parse_url($args['url']);

    $host = $parsed_url['host'] . (isset($parsed_url['port']) ? ':' . $parsed_url['port'] : '');

    $path = isset($parsed_url['path']) ? $parsed_url['path'] : '';

    // If the passed URL schema is 'https' then setup the $_SERVER variables

    // properly so that testing will run under HTTPS.

    if ($parsed_url['scheme'] == 'https') {

      $_SERVER['HTTPS'] = 'on';

    }

  }

  $_SERVER['HTTP_HOST'] = $host;

  $_SERVER['REMOTE_ADDR'] = '127.0.0.1';

  $_SERVER['SERVER_ADDR'] = '127.0.0.1';

  $_SERVER['SERVER_SOFTWARE'] = $server_software;

  $_SERVER['SERVER_NAME'] = 'localhost';

  $_SERVER['REQUEST_URI'] = $path .'/';

  $_SERVER['REQUEST_METHOD'] = 'GET';

  $_SERVER['SCRIPT_NAME'] = $path .'/index.php';

  $_SERVER['PHP_SELF'] = $path .'/index.php';

  $_SERVER['HTTP_USER_AGENT'] = 'Drupal command line';

  if (!empty($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on') {

    // Ensure that any and all environment variables are changed to https://.

    foreach ($_SERVER as $key => $value) {

      $_SERVER[$key] = str_replace('http://', 'https://', $_SERVER[$key]);

    }

  }

  chdir(realpath(dirname(__FILE__) . '/..'));

  define('DRUPAL_ROOT', getcwd());

  require_once DRUPAL_ROOT . '/includes/bootstrap.inc';

}

/**

 * Execute a batch of tests.

 */

function simpletest_script_execute_batch($test_id, $test_classes) {

  global $args;

  $total_status = SIMPLETEST_SCRIPT_EXIT_SUCCESS;

  // Multi-process execution.

  $children = array();

  while (!empty($test_classes) || !empty($children)) {

    while (count($children) < $args['concurrency']) {

      if (empty($test_classes)) {

        break;

      }

      // Fork a child process.

      $test_class = array_shift($test_classes);

      $command = simpletest_script_command($test_id, $test_class);

      $process = proc_open($command, array(), $pipes, NULL, NULL, array('bypass_shell' => TRUE));

      if (!is_resource($process)) {

        echo "Unable to fork test process. Aborting.\n";

        exit(SIMPLETEST_SCRIPT_EXIT_FAILURE);

      }

      // Register our new child.

      $children[] = array(

        'process' => $process,

        'class' => $test_class,

        'pipes' => $pipes,

      );

    }

    // 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'] == SIMPLETEST_SCRIPT_EXIT_FAILURE) {

          if ($status['exitcode'] > $total_status) {

            $total_status = $status['exitcode'];

          }

        }

        elseif ($status['exitcode']) {

          $total_status = $status['exitcode'];

          echo 'FATAL ' . $test_class . ': test runner returned a non-zero error code (' . $status['exitcode'] . ').' . "\n";

        }

        // Remove this child.

        unset($children[$cid]);

      }

    }

  }

  return $total_status;

}

/**

 * Bootstrap Drupal and run a single test.

 */

function simpletest_script_run_one_test($test_id, $test_class) {

  try {