/tests/PHPUnit/Runner/BaseTestRunner.php
PHP | 304 lines | 111 code | 34 blank | 159 comment | 6 complexity | 522e87fe87270181c9ca1831effb24c9 MD5 | raw file
Possible License(s): AGPL-3.0, LGPL-2.1
- <?php
- /**
- * PHPUnit
- *
- * Copyright (c) 2002-2009, Sebastian Bergmann <sb@sebastian-bergmann.de>.
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- *
- * * Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in
- * the documentation and/or other materials provided with the
- * distribution.
- *
- * * Neither the name of Sebastian Bergmann nor the names of his
- * contributors may be used to endorse or promote products derived
- * from this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
- * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
- * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
- * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
- * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
- * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
- * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
- * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
- * POSSIBILITY OF SUCH DAMAGE.
- *
- * @category Testing
- * @package PHPUnit
- * @author Sebastian Bergmann <sb@sebastian-bergmann.de>
- * @copyright 2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
- * @license http://www.opensource.org/licenses/bsd-license.php BSD License
- * @link http://www.phpunit.de/
- * @since File available since Release 2.0.0
- */
- require_once 'PHPUnit/Framework.php';
- require_once 'PHPUnit/Util/Filter.php';
- require_once 'PHPUnit/Runner/StandardTestSuiteLoader.php';
- PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
- /**
- * Base class for all test runners.
- *
- * @category Testing
- * @package PHPUnit
- * @author Sebastian Bergmann <sb@sebastian-bergmann.de>
- * @copyright 2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
- * @license http://www.opensource.org/licenses/bsd-license.php BSD License
- * @version Release: 3.3.17
- * @link http://www.phpunit.de/
- * @since Class available since Release 2.0.0
- * @abstract
- */
- abstract class PHPUnit_Runner_BaseTestRunner implements PHPUnit_Framework_TestListener
- {
- const STATUS_PASSED = 0;
- const STATUS_SKIPPED = 1;
- const STATUS_INCOMPLETE = 2;
- const STATUS_FAILURE = 3;
- const STATUS_ERROR = 4;
- const SUITE_METHODNAME = 'suite';
- /**
- * An error occurred.
- *
- * @param PHPUnit_Framework_Test $test
- * @param Exception $e
- * @param float $time
- */
- public function addError(PHPUnit_Framework_Test $test, Exception $e, $time)
- {
- $this->testFailed(self::STATUS_ERROR, $test, $e);
- }
- /**
- * A failure occurred.
- *
- * @param PHPUnit_Framework_Test $test
- * @param PHPUnit_Framework_AssertionFailedError $e
- * @param float $time
- */
- public function addFailure(PHPUnit_Framework_Test $test, PHPUnit_Framework_AssertionFailedError $e, $time)
- {
- $this->testFailed(self::STATUS_FAILURE, $test, $e);
- }
- /**
- * Incomplete test.
- *
- * @param PHPUnit_Framework_Test $test
- * @param Exception $e
- * @param float $time
- */
- public function addIncompleteTest(PHPUnit_Framework_Test $test, Exception $e, $time)
- {
- $this->testFailed(self::STATUS_INCOMPLETE, $test, $e);
- }
- /**
- * Skipped test.
- *
- * @param PHPUnit_Framework_Test $test
- * @param Exception $e
- * @param float $time
- * @since Method available since Release 3.0.0
- */
- public function addSkippedTest(PHPUnit_Framework_Test $test, Exception $e, $time)
- {
- $this->testFailed(self::STATUS_SKIPPED, $test, $e);
- }
- /**
- * A testsuite started.
- *
- * @param PHPUnit_Framework_TestSuite $suite
- * @since Method available since Release 2.2.0
- */
- public function startTestSuite(PHPUnit_Framework_TestSuite $suite)
- {
- }
- /**
- * A testsuite ended.
- *
- * @param PHPUnit_Framework_TestSuite $suite
- * @since Method available since Release 2.2.0
- */
- public function endTestSuite(PHPUnit_Framework_TestSuite $suite)
- {
- }
- /**
- * A test started.
- *
- * @param PHPUnit_Framework_Test $test
- */
- public function startTest(PHPUnit_Framework_Test $test)
- {
- $this->testStarted($test->getName());
- }
- /**
- * A test ended.
- *
- * @param PHPUnit_Framework_Test $test
- * @param float $time
- */
- public function endTest(PHPUnit_Framework_Test $test, $time)
- {
- $this->testEnded($test->getName());
- }
- /**
- * Returns the loader to be used.
- *
- * @return PHPUnit_Runner_TestSuiteLoader
- */
- public function getLoader()
- {
- return new PHPUnit_Runner_StandardTestSuiteLoader;
- }
- /**
- * Returns the Test corresponding to the given suite.
- * This is a template method, subclasses override
- * the runFailed() and clearStatus() methods.
- *
- * @param string $suiteClassName
- * @param string $suiteClassFile
- * @param boolean $syntaxCheck
- * @return PHPUnit_Framework_Test
- */
- public function getTest($suiteClassName, $suiteClassFile = '', $syntaxCheck = TRUE)
- {
- if (is_dir($suiteClassName) && !is_file($suiteClassName . '.php') && empty($suiteClassFile)) {
- $testCollector = new PHPUnit_Runner_IncludePathTestCollector(
- array($suiteClassName)
- );
- $suite = new PHPUnit_Framework_TestSuite($suiteClassName);
- $suite->addTestFiles($testCollector->collectTests(), $syntaxCheck);
- return $suite;
- }
- try {
- $testClass = $this->loadSuiteClass(
- $suiteClassName, $suiteClassFile, $syntaxCheck
- );
- }
- catch (Exception $e) {
- $this->runFailed($e->getMessage());
- return NULL;
- }
- try {
- $suiteMethod = $testClass->getMethod(self::SUITE_METHODNAME);
- if (!$suiteMethod->isStatic()) {
- $this->runFailed(
- 'suite() method must be static.'
- );
- return NULL;
- }
- try {
- $test = $suiteMethod->invoke(NULL, $testClass->getName());
- }
- catch (ReflectionException $e) {
- $this->runFailed(
- sprintf(
- "Failed to invoke suite() method.\n%s",
- $e->getMessage()
- )
- );
- return NULL;
- }
- }
- catch (ReflectionException $e) {
- $test = new PHPUnit_Framework_TestSuite($testClass);
- }
- $this->clearStatus();
- return $test;
- }
- /**
- * Override to define how to handle a failed loading of
- * a test suite.
- *
- * @param string $message
- */
- abstract protected function runFailed($message);
- /**
- * Returns the loaded ReflectionClass for a suite name.
- *
- * @param string $suiteClassName
- * @param string $suiteClassFile
- * @param boolean $syntaxCheck
- * @return ReflectionClass
- */
- protected function loadSuiteClass($suiteClassName, $suiteClassFile = '', $syntaxCheck = TRUE)
- {
- $loader = $this->getLoader();
- if ($loader instanceof PHPUnit_Runner_StandardTestSuiteLoader) {
- return $loader->load($suiteClassName, $suiteClassFile, $syntaxCheck);
- } else {
- return $loader->load($suiteClassName, $suiteClassFile);
- }
- }
- /**
- * Clears the status message.
- *
- */
- protected function clearStatus()
- {
- }
- /**
- * A test started.
- *
- * @param string $testName
- */
- abstract public function testStarted($testName);
- /**
- * A test ended.
- *
- * @param string $testName
- */
- abstract public function testEnded($testName);
- /**
- * A test failed.
- *
- * @param integer $status
- * @param PHPUnit_Framework_Test $test
- * @param PHPUnit_Framework_AssertionFailedError $e
- */
- abstract public function testFailed($status, PHPUnit_Framework_Test $test, PHPUnit_Framework_AssertionFailedError $e);
- }
- ?>