Permalink
Switch branches/tags
Nothing to show
Find file
Fetching contributors…
Cannot retrieve contributors at this time
267 lines (248 sloc) 8.66 KB
<?php
/**
* base include file for SimpleTest
* @package SimpleTest
* @subpackage UnitTester
* @version $Id$
*/
/**#@+
* Includes SimpleTest files.
*/
require_once dirname(__FILE__) . '/invoker.php';
require_once dirname(__FILE__) . '/test_case.php';
require_once dirname(__FILE__) . '/expectation.php';
/**#@-*/
/**
* Extension that traps errors into an error queue.
* @package SimpleTest
* @subpackage UnitTester
*/
class SimpleErrorTrappingInvoker extends SimpleInvokerDecorator {
/**
* Stores the invoker to wrap.
* @param SimpleInvoker $invoker Test method runner.
*/
function __construct($invoker) {
parent::__construct($invoker);
}
/**
* Invokes a test method and dispatches any
* untrapped errors. Called back from
* the visiting runner.
* @param string $method Test method to call.
* @access public
*/
function invoke($method) {
$queue = $this->createErrorQueue();
set_error_handler('SimpleTestErrorHandler');
parent::invoke($method);
restore_error_handler();
$queue->tally();
}
/**
* Wires up the error queue for a single test.
* @return SimpleErrorQueue Queue connected to the test.
* @access private
*/
protected function createErrorQueue() {
$context = SimpleTest::getContext();
$test = $this->getTestCase();
$queue = $context->get('SimpleErrorQueue');
$queue->setTestCase($test);
return $queue;
}
}
/**
* Error queue used to record trapped
* errors.
* @package SimpleTest
* @subpackage UnitTester
*/
class SimpleErrorQueue {
private $queue;
private $expectation_queue;
private $test;
private $using_expect_style = false;
/**
* Starts with an empty queue.
*/
function __construct() {
$this->clear();
}
/**
* Discards the contents of the error queue.
* @access public
*/
function clear() {
$this->queue = array();
$this->expectation_queue = array();
}
/**
* Sets the currently running test case.
* @param SimpleTestCase $test Test case to send messages to.
* @access public
*/
function setTestCase($test) {
$this->test = $test;
}
/**
* Sets up an expectation of an error. If this is
* not fulfilled at the end of the test, a failure
* will occour. If the error does happen, then this
* will cancel it out and send a pass message.
* @param SimpleExpectation $expected Expected error match.
* @param string $message Message to display.
* @access public
*/
function expectError($expected, $message) {
array_push($this->expectation_queue, array($expected, $message));
}
/**
* Adds an error to the front of the queue.
* @param integer $severity PHP error code.
* @param string $content Text of error.
* @param string $filename File error occoured in.
* @param integer $line Line number of error.
* @access public
*/
function add($severity, $content, $filename, $line) {
$content = str_replace('%', '%%', $content);
$this->testLatestError($severity, $content, $filename, $line);
}
/**
* Any errors still in the queue are sent to the test
* case. Any unfulfilled expectations trigger failures.
* @access public
*/
function tally() {
while (list($severity, $message, $file, $line) = $this->extract()) {
$severity = $this->getSeverityAsString($severity);
$this->test->error($severity, $message, $file, $line);
}
while (list($expected, $message) = $this->extractExpectation()) {
$this->test->assert($expected, false, "%s -> Expected error not caught");
}
}
/**
* Tests the error against the most recent expected
* error.
* @param integer $severity PHP error code.
* @param string $content Text of error.
* @param string $filename File error occoured in.
* @param integer $line Line number of error.
* @access private
*/
protected function testLatestError($severity, $content, $filename, $line) {
if ($expectation = $this->extractExpectation()) {
list($expected, $message) = $expectation;
$this->test->assert($expected, $content, sprintf(
$message,
"%s -> PHP error [$content] severity [" .
$this->getSeverityAsString($severity) .
"] in [$filename] line [$line]"));
} else {
$this->test->error($severity, $content, $filename, $line);
}
}
/**
* Pulls the earliest error from the queue.
* @return mixed False if none, or a list of error
* information. Elements are: severity
* as the PHP error code, the error message,
* the file with the error, the line number
* and a list of PHP super global arrays.
* @access public
*/
function extract() {
if (count($this->queue)) {
return array_shift($this->queue);
}
return false;
}
/**
* Pulls the earliest expectation from the queue.
* @return SimpleExpectation False if none.
* @access private
*/
protected function extractExpectation() {
if (count($this->expectation_queue)) {
return array_shift($this->expectation_queue);
}
return false;
}
/**
* Converts an error code into it's string
* representation.
* @param $severity PHP integer error code.
* @return String version of error code.
* @access public
*/
static function getSeverityAsString($severity) {
static $map = array(
E_STRICT => 'E_STRICT',
E_ERROR => 'E_ERROR',
E_WARNING => 'E_WARNING',
E_PARSE => 'E_PARSE',
E_NOTICE => 'E_NOTICE',
E_CORE_ERROR => 'E_CORE_ERROR',
E_CORE_WARNING => 'E_CORE_WARNING',
E_COMPILE_ERROR => 'E_COMPILE_ERROR',
E_COMPILE_WARNING => 'E_COMPILE_WARNING',
E_USER_ERROR => 'E_USER_ERROR',
E_USER_WARNING => 'E_USER_WARNING',
E_USER_NOTICE => 'E_USER_NOTICE');
if (defined('E_RECOVERABLE_ERROR')) {
$map[E_RECOVERABLE_ERROR] = 'E_RECOVERABLE_ERROR';
}
if (defined('E_DEPRECATED')) {
$map[E_DEPRECATED] = 'E_DEPRECATED';
}
return $map[$severity];
}
}
/**
* Error handler that simply stashes any errors into the global
* error queue. Simulates the existing behaviour with respect to
* logging errors, but this feature may be removed in future.
* @param $severity PHP error code.
* @param $message Text of error.
* @param $filename File error occoured in.
* @param $line Line number of error.
* @param $super_globals Hash of PHP super global arrays.
* @access public
*/
function SimpleTestErrorHandler($severity, $message, $filename = null, $line = null, $super_globals = null, $mask = null) {
$severity = $severity & error_reporting();
if ($severity) {
restore_error_handler();
if (IsNotCausedBySimpleTest($message) && IsNotTimeZoneNag($message)) {
if (ini_get('log_errors')) {
$label = SimpleErrorQueue::getSeverityAsString($severity);
error_log("$label: $message in $filename on line $line");
}
$queue = SimpleTest::getContext()->get('SimpleErrorQueue');
$queue->add($severity, $message, $filename, $line);
}
set_error_handler('SimpleTestErrorHandler');
}
return true;
}
/**
* Certain messages can be caused by the unit tester itself.
* These have to be filtered.
* @param string $message Message to filter.
* @return boolean True if genuine failure.
*/
function IsNotCausedBySimpleTest($message) {
return ! preg_match('/returned by reference/', $message);
}
/**
* Certain messages caused by PHP are just noise.
* These have to be filtered.
* @param string $message Message to filter.
* @return boolean True if genuine failure.
*/
function IsNotTimeZoneNag($message) {
return ! preg_match('/not safe to rely .* timezone settings/', $message);
}
?>