3 * PEAR_Command_Test (run-tests)
9 * @author Stig Bakken <ssb@php.net>
10 * @author Martin Jansen <mj@php.net>
11 * @author Greg Beaver <cellog@php.net>
12 * @copyright 1997-2009 The Authors
13 * @license http://opensource.org/licenses/bsd-license.php New BSD License
14 * @link http://pear.php.net/package/PEAR
15 * @since File available since Release 0.1
21 require_once 'PEAR/Command/Common.php';
24 * PEAR commands for login/logout
28 * @author Stig Bakken <ssb@php.net>
29 * @author Martin Jansen <mj@php.net>
30 * @author Greg Beaver <cellog@php.net>
31 * @copyright 1997-2009 The Authors
32 * @license http://opensource.org/licenses/bsd-license.php New BSD License
33 * @version Release: 1.10.3
34 * @link http://pear.php.net/package/PEAR
35 * @since Class available since Release 0.1
38 class PEAR_Command_Test extends PEAR_Command_Common
40 var $commands = array(
42 'summary' => 'Run Regression Tests',
43 'function' => 'doRunTests',
48 'doc' => 'Run tests in child directories, recursively. 4 dirs deep maximum',
52 'doc' => 'actual string of settings to pass to php in format " -d setting=blah"',
55 'realtimelog' => array(
57 'doc' => 'Log test runs/results as they are run',
61 'doc' => 'Only display detail for failed tests',
65 'doc' => 'Display simple output for all tests',
69 'doc' => 'Treat parameters as installed packages from which to run tests',
73 'doc' => 'Search parameters for AllTests.php, and use that to run phpunit-based tests
74 If none is found, all .phpt tests will be tried instead.',
78 'doc' => 'Output run-tests.log in TAP-compliant format',
82 'doc' => 'CGI php executable (needed for tests with POST/GET section)',
87 'doc' => 'Generate a code coverage report (requires Xdebug 2.0.0+)',
91 'doc' => 'Output diff on test failure',
94 'doc' => '[testfile|dir ...]
95 Run regression tests with PHP\'s regression testing script (run-tests.php).',
102 * PEAR_Command_Test constructor.
106 function __construct(&$ui, &$config)
108 parent::__construct($ui, $config);
111 function doRunTests($command, $options, $params)
113 if (isset($options['phpunit']) && isset($options['tapoutput'])) {
114 return $this->raiseError('ERROR: cannot use both --phpunit and --tapoutput at the same time');
117 require_once 'PEAR/Common.php';
118 require_once 'System.php';
119 $log = new PEAR_Common;
120 $log->ui = &$this->ui; // slightly hacky, but it will work
122 $depth = isset($options['recur']) ? 14 : 1;
124 if (!count($params)) {
128 if (isset($options['package'])) {
129 $oldparams = $params;
131 $reg = &$this->config->getRegistry();
132 foreach ($oldparams as $param) {
133 $pname = $reg->parsePackageName($param, $this->config->get('default_channel'));
134 if (PEAR::isError($pname)) {
135 return $this->raiseError($pname);
138 $package = &$reg->getPackage($pname['package'], $pname['channel']);
140 return PEAR::raiseError('Unknown package "' .
141 $reg->parsedPackageNameToString($pname) . '"');
144 $filelist = $package->getFilelist();
145 foreach ($filelist as $name => $atts) {
146 if (isset($atts['role']) && $atts['role'] != 'test') {
150 if (isset($options['phpunit']) && preg_match('/AllTests\.php\\z/i', $name)) {
151 $params[] = $atts['installed_as'];
153 } elseif (!preg_match('/\.phpt\\z/', $name)) {
156 $params[] = $atts['installed_as'];
161 foreach ($params as $p) {
163 if (isset($options['phpunit'])) {
164 $dir = System::find(array($p, '-type', 'f',
166 '-name', 'AllTests.php'));
168 foreach ($dir as $p) {
170 if (!count($tests) ||
171 (count($tests) && strlen($p) < strlen($tests[0]))) {
172 // this is in a higher-level directory, use this one instead.
180 $args = array($p, '-type', 'f', '-name', '*.phpt');
182 if (isset($options['phpunit'])) {
183 if (preg_match('/AllTests\.php\\z/i', $p)) {
185 if (!count($tests) ||
186 (count($tests) && strlen($p) < strlen($tests[0]))) {
187 // this is in a higher-level directory, use this one instead.
194 if (file_exists($p) && preg_match('/\.phpt$/', $p)) {
199 if (!preg_match('/\.phpt\\z/', $p)) {
203 $args = array(dirname($p), '-type', 'f', '-name', $p);
206 if (!isset($options['recur'])) {
207 $args[] = '-maxdepth';
211 $dir = System::find($args);
212 $tests = array_merge($tests, $dir);
216 if (isset($options['ini'])) {
217 $ini_settings .= $options['ini'];
220 if (isset($_ENV['TEST_PHP_INCLUDE_PATH'])) {
221 $ini_settings .= " -d include_path={$_ENV['TEST_PHP_INCLUDE_PATH']}";
225 $this->ui->outputData('Using INI settings: "' . $ini_settings . '"');
228 $skipped = $passed = $failed = array();
229 $tests_count = count($tests);
230 $this->ui->outputData('Running ' . $tests_count . ' tests', $command);
232 if (isset($options['realtimelog']) && file_exists('run-tests.log')) {
233 unlink('run-tests.log');
236 if (isset($options['tapoutput'])) {
237 $tap = '1..' . $tests_count . "\n";
240 require_once 'PEAR/RunTest.php';
241 $run = new PEAR_RunTest($log, $options);
242 $run->tests_count = $tests_count;
244 if (isset($options['coverage']) && extension_loaded('xdebug')){
245 $run->xdebug_loaded = true;
247 $run->xdebug_loaded = false;
251 foreach ($tests as $t) {
252 if (isset($options['realtimelog'])) {
253 $fp = @fopen('run-tests.log', 'a');
255 fwrite($fp, "Running test [$i / $tests_count] $t...");
259 PEAR::staticPushErrorHandling(PEAR_ERROR_RETURN);
260 if (isset($options['phpunit'])) {
261 $result = $run->runPHPUnit($t, $ini_settings);
263 $result = $run->run($t, $ini_settings, $j);
265 PEAR::staticPopErrorHandling();
266 if (PEAR::isError($result)) {
267 $this->ui->log($result->getMessage());
271 if (isset($options['tapoutput'])) {
272 $tap .= $result[0] . ' ' . $i . $result[1] . "\n";
276 if (isset($options['realtimelog'])) {
277 $fp = @fopen('run-tests.log', 'a');
279 fwrite($fp, "$result\n");
284 if ($result == 'FAILED') {
287 if ($result == 'PASSED') {
290 if ($result == 'SKIPPED') {
297 $total = date('i:s', time() - $start);
298 if (isset($options['tapoutput'])) {
299 $fp = @fopen('run-tests.log', 'w');
301 fwrite($fp, $tap, strlen($tap));
303 $this->ui->outputData('wrote TAP-format log to "' .realpath('run-tests.log') .
307 if (count($failed)) {
308 $output = "TOTAL TIME: $total\n";
309 $output .= count($passed) . " PASSED TESTS\n";
310 $output .= count($skipped) . " SKIPPED TESTS\n";
311 $output .= count($failed) . " FAILED TESTS:\n";
312 foreach ($failed as $failure) {
313 $output .= $failure . "\n";
316 $mode = isset($options['realtimelog']) ? 'a' : 'w';
317 $fp = @fopen('run-tests.log', $mode);
320 fwrite($fp, $output, strlen($output));
322 $this->ui->outputData('wrote log to "' . realpath('run-tests.log') . '"', $command);
324 } elseif (file_exists('run-tests.log') && !is_dir('run-tests.log')) {
325 @unlink('run-tests.log');
328 $this->ui->outputData('TOTAL TIME: ' . $total);
329 $this->ui->outputData(count($passed) . ' PASSED TESTS', $command);
330 $this->ui->outputData(count($skipped) . ' SKIPPED TESTS', $command);
331 if (count($failed)) {
332 $this->ui->outputData(count($failed) . ' FAILED TESTS:', $command);
333 foreach ($failed as $failure) {
334 $this->ui->outputData($failure, $command);
338 if (count($failed) == 0) {
341 return $this->raiseError('Some tests failed');