Viewing file:  ResultPrinter.php (13.42 KB) -rwxr-xr-x
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
/**
* PHPUnit
*
* Copyright (c) 2002-2008, 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-2008 Sebastian Bergmann <sb@sebastian-bergmann.de>
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
* @version SVN: $Id: ResultPrinter.php 1985 2007-12-26 18:11:55Z sb $
* @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/Util/Printer.php';
PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
/**
* Prints the result of a TextUI TestRunner run.
*
* @category Testing
* @package PHPUnit
* @author Sebastian Bergmann <sb@sebastian-bergmann.de>
* @copyright 2002-2008 Sebastian Bergmann <sb@sebastian-bergmann.de>
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
* @version Release: 3.2.9
* @link http://www.phpunit.de/
* @since Class available since Release 2.0.0
*/
class PHPUnit_TextUI_ResultPrinter extends PHPUnit_Util_Printer implements PHPUnit_Framework_TestListener {
const EVENT_TEST_START = 0;
const EVENT_TEST_END = 1;
const EVENT_TESTSUITE_START = 2;
const EVENT_TESTSUITE_END = 3;
/**
* @var integer
* @access protected
*/
protected $column = 0;
/**
* @var array
* @access protected
*/
protected $numberOfTests = array();
/**
* @var array
* @access protected
*/
protected $testSuiteSize = array();
/**
* @var integer
* @access protected
*/
protected $lastEvent = - 1;
/**
* @var boolean
* @access protected
*/
protected $lastTestFailed = FALSE;
/**
* @var boolean
* @access protected
*/
protected $verbose = FALSE;
/**
* Constructor.
*
* @param mixed $out
* @param boolean $verbose
* @throws InvalidArgumentException
* @access public
* @since Method available since Release 3.0.0
*/
public function __construct($out = NULL, $verbose = FALSE) {
parent::__construct($out);
if (is_bool($verbose)) {
$this->verbose = $verbose;
} else {
throw new InvalidArgumentException();
}
}
/**
* @param PHPUnit_Framework_TestResult $result
* @access public
*/
public function printResult(PHPUnit_Framework_TestResult $result) {
$this->printHeader($result->time());
if ($result->errorCount() > 0) {
$this->printErrors($result);
}
if ($result->failureCount() > 0) {
if ($result->errorCount() > 0) {
print "\n--\n\n";
}
$this->printFailures($result);
}
if ($this->verbose) {
if ($result->notImplementedCount() > 0) {
if ($result->failureCount() > 0) {
print "\n--\n\n";
}
$this->printIncompletes($result);
}
if ($result->skippedCount() > 0) {
if ($result->notImplementedCount() > 0) {
print "\n--\n\n";
}
$this->printSkipped($result);
}
}
$this->printFooter($result);
}
/**
* @param array $defects
* @param integer $count
* @param string $type
* @access protected
*/
protected function printDefects(array $defects, $count, $type) {
if ($count == 0) {
return;
}
$this->write(sprintf("There %s %d %s%s:\n",
($count == 1) ? 'was' : 'were', $count, $type, ($count == 1) ? '' : 's'));
$i = 1;
foreach ($defects as $defect) {
$this->printDefect($defect, $i ++);
}
}
/**
* @param PHPUnit_Framework_TestFailure $defect
* @param integer $count
* @access protected
*/
protected function printDefect(PHPUnit_Framework_TestFailure $defect, $count) {
$this->printDefectHeader($defect, $count);
$this->printDefectTrace($defect);
}
/**
* @param PHPUnit_Framework_TestFailure $defect
* @param integer $count
* @access protected
*/
protected function printDefectHeader(PHPUnit_Framework_TestFailure $defect, $count) {
$failedTest = $defect->failedTest();
if ($failedTest instanceof PHPUnit_Framework_SelfDescribing) {
$testName = $failedTest->toString();
} else {
$testName = get_class($failedTest);
}
$this->write(sprintf("\n%d) %s\n",
$count, $testName));
}
/**
* @param PHPUnit_Framework_TestFailure $defect
* @access protected
*/
protected function printDefectTrace(PHPUnit_Framework_TestFailure $defect) {
$this->write($defect->toStringVerbose($this->verbose) . PHPUnit_Util_Filter::getFilteredStacktrace($defect->thrownException(), FALSE));
}
/**
* @param PHPUnit_Framework_TestResult $result
* @access protected
*/
protected function printErrors(PHPUnit_Framework_TestResult $result) {
$this->printDefects($result->errors(), $result->errorCount(), 'error');
}
/**
* @param PHPUnit_Framework_TestResult $result
* @access protected
*/
protected function printFailures(PHPUnit_Framework_TestResult $result) {
$this->printDefects($result->failures(), $result->failureCount(), 'failure');
}
/**
* @param PHPUnit_Framework_TestResult $result
* @access protected
*/
protected function printIncompletes(PHPUnit_Framework_TestResult $result) {
$this->printDefects($result->notImplemented(), $result->notImplementedCount(), 'incomplete test');
}
/**
* @param PHPUnit_Framework_TestResult $result
* @access protected
* @since Method available since Release 3.0.0
*/
protected function printSkipped(PHPUnit_Framework_TestResult $result) {
$this->printDefects($result->skipped(), $result->skippedCount(), 'skipped test');
}
/**
* @param float $timeElapsed
* @access protected
*/
protected function printHeader($timeElapsed) {
$this->write("\n\nTime: " . PHPUnit_Util_Timer::secondsToTimeString($timeElapsed) . "\n\n");
}
/**
* @param PHPUnit_Framework_TestResult $result
* @access protected
*/
protected function printFooter(PHPUnit_Framework_TestResult $result) {
if ($result->wasSuccessful() && $result->allCompletlyImplemented() && $result->noneSkipped()) {
$this->write(sprintf("\nOK (%d test%s)\n",
count($result), (count($result) == 1) ? '' : 's'));
}
else if ((! $result->allCompletlyImplemented() || ! $result->noneSkipped()) && $result->wasSuccessful()) {
$this->write(sprintf("\nOK, but incomplete or skipped tests!\n" . "Tests: %d%s%s.\n",
count($result), $this->getCountString($result->notImplementedCount(), 'Incomplete'), $this->getCountString($result->skippedCount(), 'Skipped')));
}
else {
$this->write(sprintf("\nFAILURES!\n" . "Tests: %d%s%s%s%s.\n",
count($result), $this->getCountString($result->failureCount(), 'Failures'), $this->getCountString($result->errorCount(), 'Errors'), $this->getCountString($result->notImplementedCount(), 'Incomplete'), $this->getCountString($result->skippedCount(), 'Skipped')));
}
}
/**
* @param integer $count
* @param string $name
* @return string
* @access protected
* @since Method available since Release 3.0.0
*/
protected function getCountString($count, $name) {
$string = '';
if ($count > 0) {
$string = sprintf(', %s: %d',
$name, $count);
}
return $string;
}
/**
* @access public
*/
public function printWaitPrompt() {
$this->write("\n<RETURN> to continue\n");
}
/**
* An error occurred.
*
* @param PHPUnit_Framework_Test $test
* @param Exception $e
* @param float $time
* @access public
*/
public function addError(PHPUnit_Framework_Test $test, Exception $e, $time) {
$this->writeProgress('E');
$this->lastTestFailed = TRUE;
}
/**
* A failure occurred.
*
* @param PHPUnit_Framework_Test $test
* @param PHPUnit_Framework_AssertionFailedError $e
* @param float $time
* @access public
*/
public function addFailure(PHPUnit_Framework_Test $test, PHPUnit_Framework_AssertionFailedError $e, $time) {
$this->writeProgress('F');
$this->lastTestFailed = TRUE;
}
/**
* Incomplete test.
*
* @param PHPUnit_Framework_Test $test
* @param Exception $e
* @param float $time
* @access public
*/
public function addIncompleteTest(PHPUnit_Framework_Test $test, Exception $e, $time) {
$this->writeProgress('I');
$this->lastTestFailed = TRUE;
}
/**
* Skipped test.
*
* @param PHPUnit_Framework_Test $test
* @param Exception $e
* @param float $time
* @access public
* @since Method available since Release 3.0.0
*/
public function addSkippedTest(PHPUnit_Framework_Test $test, Exception $e, $time) {
$this->writeProgress('S');
$this->lastTestFailed = TRUE;
}
/**
* A testsuite started.
*
* @param PHPUnit_Framework_TestSuite $suite
* @access public
* @since Method available since Release 2.2.0
*/
public function startTestSuite(PHPUnit_Framework_TestSuite $suite) {
if ($this->verbose) {
$name = $suite->getName();
if (empty($name)) {
$name = 'Test Suite';
}
$this->write(sprintf("%s%s%s\n",
$this->lastEvent == self::EVENT_TESTSUITE_END ? "\n" : '', str_repeat(' ', count($this->testSuiteSize)), $name));
array_push($this->numberOfTests, 0);
array_push($this->testSuiteSize, count($suite));
}
else if (empty($this->numberOfTests)) {
array_push($this->numberOfTests, 0);
array_push($this->testSuiteSize, count($suite));
}
$this->lastEvent = self::EVENT_TESTSUITE_START;
}
/**
* A testsuite ended.
*
* @param PHPUnit_Framework_TestSuite $suite
* @access public
* @since Method available since Release 2.2.0
*/
public function endTestSuite(PHPUnit_Framework_TestSuite $suite) {
if ($this->verbose) {
array_pop($this->numberOfTests);
array_pop($this->testSuiteSize);
$this->column = 0;
if ($this->lastEvent != self::EVENT_TESTSUITE_END) {
$this->write("\n");
}
}
$this->lastEvent = self::EVENT_TESTSUITE_END;
}
/**
* A test started.
*
* @param PHPUnit_Framework_Test $test
* @access public
*/
public function startTest(PHPUnit_Framework_Test $test) {
if ($this->verbose) {
$this->numberOfTests[count($this->numberOfTests) - 1] ++;
} else {
$this->numberOfTests[0] ++;
}
$this->lastEvent = self::EVENT_TEST_START;
}
/**
* A test ended.
*
* @param PHPUnit_Framework_Test $test
* @param float $time
* @access public
*/
public function endTest(PHPUnit_Framework_Test $test, $time) {
if (! $this->lastTestFailed) {
$this->writeProgress('.');
}
$this->lastEvent = self::EVENT_TEST_END;
$this->lastTestFailed = FALSE;
}
/**
* @param string $progress
* @access protected
*/
protected function writeProgress($progress) {
$indent = max(0, count($this->testSuiteSize) - 1);
if ($this->column == 0) {
$this->write(str_repeat(' ', $indent));
}
$this->write($progress);
if ($this->column ++ == 60 - 1 - $indent) {
if ($this->verbose) {
$numberOfTests = $this->numberOfTests[count($this->numberOfTests) - 1];
$testSuiteSize = $this->testSuiteSize[count($this->testSuiteSize) - 1];
} else {
$numberOfTests = $this->numberOfTests[0];
$testSuiteSize = $this->testSuiteSize[0];
}
$width = strlen((string)$testSuiteSize);
$this->write(sprintf(' %' . $width . 'd / %' . $width . "d\n",
$numberOfTests, $testSuiteSize));
$this->column = 0;
}
}
}
?>
|