* Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org) * * Licensed under The MIT License * Redistributions of files must retain the above copyright notice * * @copyright Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org) * @link http://book.cakephp.org/view/1196/Testing CakePHP(tm) Tests * @since CakePHP(tm) v 1.2.0.4433 * @license MIT License (http://www.opensource.org/licenses/mit-license.php) */ App::uses('TestShell', 'Console/Command'); /** * Provides a CakePHP wrapper around PHPUnit. * Adds in CakePHP's fixtures and gives access to plugin, app and core test cases * * @package Cake.Console.Command */ class TestsuiteShell extends TestShell { /** * get the option parser for the test suite. * * @return void */ public function getOptionParser() { $parser = new ConsoleOptionParser($this->name); $parser->description(array( __d('cake_console', 'The CakePHP Testsuite allows you to run test cases from the command line'), __d('cake_console', 'This shell is for backwards-compatibility only'), __d('cake_console', 'use the test shell instead') ))->addArgument('category', array( 'help' => __d('cake_console', 'app, core or name of a plugin.'), 'required' => true ))->addArgument('file', array( 'help' => __d('cake_console', 'file name with folder prefix and without the test.php suffix.'), 'required' => false, ))->addOption('log-junit', array( 'help' => __d('cake_console', ' Log test execution in JUnit XML format to file.'), 'default' => false ))->addOption('log-json', array( 'help' => __d('cake_console', ' Log test execution in TAP format to file.'), 'default' => false ))->addOption('log-tap', array( 'help' => __d('cake_console', ' Log test execution in TAP format to file.'), 'default' => false ))->addOption('log-dbus', array( 'help' => __d('cake_console', 'Log test execution to DBUS.'), 'default' => false ))->addOption('coverage-html', array( 'help' => __d('cake_console', ' Generate code coverage report in HTML format.'), 'default' => false ))->addOption('coverage-clover', array( 'help' => __d('cake_console', ' Write code coverage data in Clover XML format.'), 'default' => false ))->addOption('testdox-html', array( 'help' => __d('cake_console', ' Write agile documentation in HTML format to file.'), 'default' => false ))->addOption('testdox-text', array( 'help' => __d('cake_console', ' Write agile documentation in Text format to file.'), 'default' => false ))->addOption('filter', array( 'help' => __d('cake_console', ' Filter which tests to run.'), 'default' => false ))->addOption('group', array( 'help' => __d('cake_console', ' Only runs tests from the specified group(s).'), 'default' => false ))->addOption('exclude-group', array( 'help' => __d('cake_console', ' Exclude tests from the specified group(s).'), 'default' => false ))->addOption('list-groups', array( 'help' => __d('cake_console', 'List available test groups.'), 'boolean' => true ))->addOption('loader', array( 'help' => __d('cake_console', 'TestSuiteLoader implementation to use.'), 'default' => false ))->addOption('repeat', array( 'help' => __d('cake_console', ' Runs the test(s) repeatedly.'), 'default' => false ))->addOption('tap', array( 'help' => __d('cake_console', 'Report test execution progress in TAP format.'), 'boolean' => true ))->addOption('testdox', array( 'help' => __d('cake_console', 'Report test execution progress in TestDox format.'), 'default' => false, 'boolean' => true ))->addOption('no-colors', array( 'help' => __d('cake_console', 'Do not use colors in output.'), 'boolean' => true ))->addOption('stderr', array( 'help' => __d('cake_console', 'Write to STDERR instead of STDOUT.'), 'boolean' => true ))->addOption('stop-on-error', array( 'help' => __d('cake_console', 'Stop execution upon first error or failure.'), 'boolean' => true ))->addOption('stop-on-failure', array( 'help' => __d('cake_console', 'Stop execution upon first failure.'), 'boolean' => true ))->addOption('stop-on-skipped ', array( 'help' => __d('cake_console', 'Stop execution upon first skipped test.'), 'boolean' => true ))->addOption('stop-on-incomplete', array( 'help' => __d('cake_console', 'Stop execution upon first incomplete test.'), 'boolean' => true ))->addOption('strict', array( 'help' => __d('cake_console', 'Mark a test as incomplete if no assertions are made.'), 'boolean' => true ))->addOption('wait', array( 'help' => __d('cake_console', 'Waits for a keystroke after each test.'), 'boolean' => true ))->addOption('process-isolation', array( 'help' => __d('cake_console', 'Run each test in a separate PHP process.'), 'boolean' => true ))->addOption('no-globals-backup', array( 'help' => __d('cake_console', 'Do not backup and restore $GLOBALS for each test.'), 'boolean' => true ))->addOption('static-backup ', array( 'help' => __d('cake_console', 'Backup and restore static attributes for each test.'), 'boolean' => true ))->addOption('syntax-check', array( 'help' => __d('cake_console', 'Try to check source files for syntax errors.'), 'boolean' => true ))->addOption('bootstrap', array( 'help' => __d('cake_console', ' A "bootstrap" PHP file that is run before the tests.'), 'default' => false ))->addOption('configuration', array( 'help' => __d('cake_console', ' Read configuration from XML file.'), 'default' => false ))->addOption('no-configuration', array( 'help' => __d('cake_console', 'Ignore default configuration file (phpunit.xml).'), 'boolean' => true ))->addOption('include-path', array( 'help' => __d('cake_console', ' Prepend PHP include_path with given path(s).'), 'default' => false ))->addOption('directive', array( 'help' => __d('cake_console', 'key[=value] Sets a php.ini value.'), 'default' => false ))->addOption('fixture', array( 'help' => __d('cake_console', 'Choose a custom fixture manager.'), ))->addOption('debug', array( 'help' => __d('cake_console', 'Enable full output of testsuite. (supported in PHPUnit 3.6.0 and greater)'), )); return $parser; } /** * Parse the CLI options into an array CakeTestDispatcher can use. * * @return array Array of params for CakeTestDispatcher */ protected function _parseArgs() { if (empty($this->args)) { return; } $params = array( 'core' => false, 'app' => false, 'plugin' => null, 'output' => 'text', ); $category = $this->args[0]; if ($category == 'core') { $params['core'] = true; } elseif ($category == 'app') { $params['app'] = true; } elseif ($category != 'core') { $params['plugin'] = $category; } if (isset($this->args[1])) { $params['case'] = $this->args[1]; } return $params; } /** * Main entry point to this shell * * @return void */ public function main() { $this->out(__d('cake_console', 'CakePHP Test Shell')); $this->hr(); $args = $this->_parseArgs(); if (empty($args['case'])) { return $this->available(); } $this->_run($args, $this->_runnerOptions()); } }