C:/xampp/htdocs/moodle/lib/simpletestlib/test_case.php

Go to the documentation of this file.

<?php
require_once(dirname(__FILE__) . '/invoker.php');
require_once(dirname(__FILE__) . '/errors.php');
require_once(dirname(__FILE__) . '/compatibility.php');
require_once(dirname(__FILE__) . '/scorer.php');
require_once(dirname(__FILE__) . '/expectation.php');
require_once(dirname(__FILE__) . '/dumper.php');
require_once(dirname(__FILE__) . '/simpletest.php');
if (version_compare(phpversion(), '5') >= 0) {
    require_once(dirname(__FILE__) . '/exceptions.php');
    require_once(dirname(__FILE__) . '/reflection_php5.php');
} else {
    require_once(dirname(__FILE__) . '/reflection_php4.php');
}
if (! defined('SIMPLE_TEST')) {
    define('SIMPLE_TEST', dirname(__FILE__) . DIRECTORY_SEPARATOR);
}
class SimpleTestCase {
    var $_label = false;
    var $_reporter;
    var $_observers;
    var $_should_skip = false;

    function SimpleTestCase($label = false) {
        if ($label) {
            $this->_label = $label;
        }
    }

    function getLabel() {
        return $this->_label ? $this->_label : get_class($this);
    }

    function skip() {
    }

    function skipIf($should_skip, $message = '%s') {
        if ($should_skip && ! $this->_should_skip) {
            $this->_should_skip = true;
            $message = sprintf($message, 'Skipping [' . get_class($this) . ']');
            $this->_reporter->paintSkip($message . $this->getAssertionLine());
        }
    }

    function skipUnless($shouldnt_skip, $message = false) {
        $this->skipIf(! $shouldnt_skip, $message);
    }

    function &createInvoker() {
        $invoker = new SimpleErrorTrappingInvoker(new SimpleInvoker($this));
        if (version_compare(phpversion(), '5') >= 0) {
            $invoker = new SimpleExceptionTrappingInvoker($invoker);
        }
        return $invoker;
    }

    function run(&$reporter) {
        $context = &SimpleTest::getContext();
        $context->setTest($this);
        $context->setReporter($reporter);
        $this->_reporter = &$reporter;
        $started = false;
        foreach ($this->getTests() as $method) {
            if ($reporter->shouldInvoke($this->getLabel(), $method)) {
                $this->skip();
                if ($this->_should_skip) {
                    break;
                }
                if (! $started) {
                    $reporter->paintCaseStart($this->getLabel());
                    $started = true;
                }
//moodlefix begins
                if (defined('TIME_ALLOWED_PER_UNIT_TEST')) {
                    set_time_limit(TIME_ALLOWED_PER_UNIT_TEST);
                }
//moodlefix ends
                $invoker = &$this->_reporter->createInvoker($this->createInvoker());
                $invoker->before($method);
                $invoker->invoke($method);
                $invoker->after($method);
            }
        }
        if ($started) {
            $reporter->paintCaseEnd($this->getLabel());
        }
        unset($this->_reporter);
//moodlefix begins
        $context->unsetTest();
//moodlefix ends
        return $reporter->getStatus();
    }

    function getTests() {
        $methods = array();
        foreach (get_class_methods(get_class($this)) as $method) {
            if ($this->_isTest($method)) {
                $methods[] = $method;
            }
        }
        return $methods;
    }

    function _isTest($method) {
        if (strtolower(substr($method, 0, 4)) == 'test') {
            return ! SimpleTestCompatibility::isA($this, strtolower($method));
        }
        return false;
    }

    function before($method) {
        $this->_reporter->paintMethodStart($method);
        $this->_observers = array();
    }

    function setUp() {
    }

    function tearDown() {
    }

    function after($method) {
        for ($i = 0; $i < count($this->_observers); $i++) {
            $this->_observers[$i]->atTestEnd($method, $this);
        }
        $this->_reporter->paintMethodEnd($method);
    }

    function tell(&$observer) {
        $this->_observers[] = &$observer;
    }

    function pass($message = "Pass") {
        if (! isset($this->_reporter)) {
            trigger_error('Can only make assertions within test methods');
        }
        $this->_reporter->paintPass(
                $message . $this->getAssertionLine());
        return true;
    }

    function fail($message = "Fail") {
        if (! isset($this->_reporter)) {
            trigger_error('Can only make assertions within test methods');
        }
        $this->_reporter->paintFail(
                $message . $this->getAssertionLine());
        return false;
    }

    function error($severity, $message, $file, $line) {
        if (! isset($this->_reporter)) {
            trigger_error('Can only make assertions within test methods');
        }
        $this->_reporter->paintError(
                "Unexpected PHP error [$message] severity [$severity] in [$file line $line]");
    }

    function exception($exception) {
        $this->_reporter->paintException($exception);
    }

    function signal($type, &$payload) {
        if (! isset($this->_reporter)) {
            trigger_error('Can only make assertions within test methods');
        }
        $this->_reporter->paintSignal($type, $payload);
    }

    function assert(&$expectation, $compare, $message = '%s') {
        if ($expectation->test($compare)) {
            return $this->pass(sprintf(
                    $message,
                    $expectation->overlayMessage($compare, $this->_reporter->getDumper())));
        } else {
            return $this->fail(sprintf(
                    $message,
                    $expectation->overlayMessage($compare, $this->_reporter->getDumper())));
        }
    }

    function assertExpectation(&$expectation, $compare, $message = '%s') {
        return $this->assert($expectation, $compare, $message);
    }

    function getAssertionLine() {
        $trace = new SimpleStackTrace(array('assert', 'expect', 'pass', 'fail', 'skip'));
        return $trace->traceMethod();
    }

    function dump($variable, $message = false) {
        $dumper = $this->_reporter->getDumper();
        $formatted = $dumper->dump($variable);
        if ($message) {
            $formatted = $message . "\n" . $formatted;
        }
        $this->_reporter->paintFormattedMessage($formatted);
        return $variable;
    }

    function sendMessage($message) {
        $this->_reporter->PaintMessage($message);
    }

    function getSize() {
        return 1;
    }
}

class SimpleFileLoader {

    function &load($test_file) {
        $existing_classes = get_declared_classes();
        $existing_globals = get_defined_vars();
        global $CFG;
        include_once($test_file);
        $new_globals = get_defined_vars();
        $this->_makeFileVariablesGlobal($existing_globals, $new_globals);
        $new_classes = array_diff(get_declared_classes(), $existing_classes);
        if (empty($new_classes)) {
            $new_classes = $this->_scrapeClassesFromFile($test_file);
        }
        $classes = $this->selectRunnableTests($new_classes);
        $suite = &$this->createSuiteFromClasses($test_file, $classes);
        return $suite;
    }

    function _makeFileVariablesGlobal($existing, $new) {
        $globals = array_diff(array_keys($new), array_keys($existing));
        foreach ($globals as $global) {
            $_GLOBALS[$global] = $new[$global];
        }
    }

    function _scrapeClassesFromFile($test_file) {
        preg_match_all('~^\s*class\s+(\w+)(\s+(extends|implements)\s+\w+)*\s*\{~mi',
                        file_get_contents($test_file),
                        $matches );
        return $matches[1];
    }

    function selectRunnableTests($candidates) {
        $classes = array();
        foreach ($candidates as $class) {
            if (TestSuite::getBaseTestCase($class)) {
                $reflection = new SimpleReflection($class);
                if ($reflection->isAbstract()) {
                    SimpleTest::ignore($class);
                } else {
                    $classes[] = $class;
                }
            }
        }
        return $classes;
    }

    function &createSuiteFromClasses($title, $classes) {
        if (count($classes) == 0) {
            $suite = new BadTestSuite($title, "No runnable test cases in [$title]");
            return $suite;
        }
        SimpleTest::ignoreParentsIfIgnored($classes);
        $suite = new TestSuite($title);
        foreach ($classes as $class) {
            if (! SimpleTest::isIgnored($class)) {
                $suite->addTestClass($class);
            }
        }
        return $suite;
    }
}

class TestSuite {
    var $_label;
    var $_test_cases;

    function TestSuite($label = false) {
        $this->_label = $label;
        $this->_test_cases = array();
    }

    function getLabel() {
        if (! $this->_label) {
            return ($this->getSize() == 1) ?
                    get_class($this->_test_cases[0]) : get_class($this);
        } else {
            return $this->_label;
        }
    }

    function addTestCase(&$test_case) {
        $this->_test_cases[] = &$test_case;
    }

    function addTestClass($class) {
        if (TestSuite::getBaseTestCase($class) == 'testsuite') {
            $this->_test_cases[] = new $class();
        } else {
            $this->_test_cases[] = $class;
        }
    }

    function add(&$test_case) {
        if (! is_string($test_case)) {
            $this->_test_cases[] = &$test_case;
        } elseif (TestSuite::getBaseTestCase($class) == 'testsuite') {
            $this->_test_cases[] = new $class();
        } else {
            $this->_test_cases[] = $class;
        }
    }

    function addTestFile($test_file) {
        $this->addFile($test_file);
    }

    function addFile($test_file) {
        $extractor = new SimpleFileLoader();
        $this->add($extractor->load($test_file));
    }

    function collect($path, &$collector) {
        $collector->collect($this, $path);
    }

    function run(&$reporter) {
        $reporter->paintGroupStart($this->getLabel(), $this->getSize());
        for ($i = 0, $count = count($this->_test_cases); $i < $count; $i++) {
            if (is_string($this->_test_cases[$i])) {
                $class = $this->_test_cases[$i];
                // moodle hack start - need to do this before the constructor call, because of FakeDBUnitTestCase.
                global $CFG;
                if (is_subclass_of($class, 'FakeDBUnitTestCase')) {
                    // Do not execute this test because the test tables system no longer works, reporting it as exception
                    $reporter->paintError("Unit test \"{$class}\" of type FakeDBUnitTestCase no longer supported. Must be migrated to UnitTestCaseUsingDatabase.");
                    continue;
                }
                if (is_subclass_of($class, 'UnitTestCaseUsingDatabase') && empty($CFG->unittestprefix)) {
                    // Do not execute this test because $CFG->unittestprefix is not set, but it will be required.
                    $reporter->paintSkip("Unit test \"{$class}\" of type UnitTestCaseUsingDatabase skipped. Must define different, non-conflicting \$CFG->unittestprefix to be runnable.");
                    continue;
                }
                // moodle hack end
                $test = new $class();
                $test->run($reporter);
                unset($test);
            } else {
                $this->_test_cases[$i]->run($reporter);
            }
        }
        $reporter->paintGroupEnd($this->getLabel());
        return $reporter->getStatus();
    }

    function getSize() {
        $count = 0;
        foreach ($this->_test_cases as $case) {
            if (is_string($case)) {
                if (! SimpleTest::isIgnored($case)) {
                    $count++;
                }
            } else {
                $count += $case->getSize();
            }
        }
        return $count;
    }

    function getBaseTestCase($class) {
        while ($class = get_parent_class($class)) {
            $class = strtolower($class);
            if ($class == 'simpletestcase' || $class == 'testsuite') {
                return $class;
            }
        }
        return false;
    }
}

class GroupTest extends TestSuite {
    // moodle fix: adding old style constructor to make it compatible with PHP 5.3
    function GroupTest($label = false) {
        parent::TestSuite($label);
    }
}

class BadTestSuite {
    var $_label;
    var $_error;

    function BadTestSuite($label, $error) {
        $this->_label = $label;
        $this->_error = $error;
    }

    function getLabel() {
        return $this->_label;
    }

    function run(&$reporter) {
        $reporter->paintGroupStart($this->getLabel(), $this->getSize());
        $reporter->paintFail('Bad TestSuite [' . $this->getLabel() .
                '] with error [' . $this->_error . ']');
        $reporter->paintGroupEnd($this->getLabel());
        return $reporter->getStatus();
    }

    function getSize() {
        return 0;
    }
}

class BadGroupTest extends BadTestSuite { }
?>