NOBUG: I hate the shut-up operator, really!
[moodle.git] / admin / report / unittest / index.php
1 <?php
2 /**
3  * Run the unit tests.
4  *
5  * @copyright &copy; 2006 The Open University
6  * @author N.D.Freear@open.ac.uk, T.J.Hunt@open.ac.uk
7  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
8  * @package SimpleTestEx
9  */
11 /** */
12 require_once(dirname(__FILE__).'/../../../config.php');
13 require_once($CFG->libdir.'/adminlib.php');
14 require_once($CFG->libdir.'/simpletestcoveragelib.php');
15 require_once('ex_simple_test.php');
16 require_once('ex_reporter.php');
18 // Always run the unit tests in developer debug mode.
19 $CFG->debug = DEBUG_DEVELOPER;
20 error_reporting($CFG->debug);
21 raise_memory_limit(MEMORY_EXTRA);
23 // page parameters
24 $path         = optional_param('path', null, PARAM_PATH);
25 $showpasses   = optional_param('showpasses', false, PARAM_BOOL);
26 $codecoverage = optional_param('codecoverage', false, PARAM_BOOL);
27 $showsearch   = optional_param('showsearch', false, PARAM_BOOL);
29 admin_externalpage_setup('reportsimpletest', '', array('showpasses'=>$showpasses, 'showsearch'=>$showsearch));
31 $unittest = true;
33 global $UNITTEST;
34 $UNITTEST = new stdClass();
36 // This limit is the time allowed per individual test function. Please do not
37 // increase this value. If you get a PHP time limit when running unit tests,
38 // find the unit test which is running slowly, and either make it faster,
39 // split it into multiple tests, or call set_time_limit within that test.
40 define('TIME_ALLOWED_PER_UNIT_TEST', 60);
42 // Print the header.
43 $strtitle = get_string('unittests', 'simpletest');
45 if (!is_null($path)) {
46     //trim so user doesn't get an error if they include a space on the end of the path (ie by pasting path)
47     $path = trim($path);
49     // Turn off xmlstrictheaders during the unit test run.
50     $origxmlstrictheaders = !empty($CFG->xmlstrictheaders);
51     $CFG->xmlstrictheaders = false;
52     echo $OUTPUT->header();
53     $CFG->xmlstrictheaders = $origxmlstrictheaders;
54     unset($origxmlstrictheaders);
56     // Create the group of tests.
57     $test = new autogroup_test_coverage($showsearch, true, $codecoverage, 'Moodle Unit Tests Code Coverage Report', 'unittest');
59     // OU specific. We use the _nonproject folder for stuff we want to
60     // keep in CVS, but which is not really relevant. It does no harm
61     // to leave this here.
62     $test->addIgnoreFolder($CFG->dirroot . '/_nonproject');
64     // Make the reporter, which is what displays the results.
65     $reporter = new ExHtmlReporter($showpasses);
67     if ($showsearch) {
68         echo $OUTPUT->heading('Searching for test cases');
69     }
70     flush();
72     // Work out what to test.
73     if (substr($path, 0, 1) == '/') {
74         $path = substr($path, 1);
75     }
76     $path = $CFG->dirroot . '/' . $path;
77     if (substr($path, -1) == '/') {
78         $path = substr($path, 0, -1);
79     }
80     $displaypath = substr($path, strlen($CFG->dirroot) + 1);
81     $ok = true;
82     if (is_file($path)) {
83         $test->addTestFile($path);
84     } else if (is_dir($path)){
85         $test->findTestFiles($path);
86     } else {
87         echo $OUTPUT->box(get_string('pathdoesnotexist', 'simpletest', $path), 'errorbox');
88         $ok = false;
89     }
91     // If we have something to test, do it.
92     if ($ok) {
93         if ($path == $CFG->dirroot) {
94             $title = get_string('moodleunittests', 'simpletest', get_string('all', 'simpletest'));
95         } else {
96             $title = get_string('moodleunittests', 'simpletest', $displaypath);
97         }
98         echo $OUTPUT->heading($title);
99         $test->run($reporter);
100     }
102     $formheader = get_string('retest', 'simpletest');
103 } else {
104     $displaypath = '';
105     echo $OUTPUT->header();
106     $formheader = get_string('rununittests', 'simpletest');
108 // Print the form for adjusting options.
109 echo $OUTPUT->box_start('generalbox boxwidthwide boxaligncenter');
110 echo $OUTPUT->heading($formheader);
111 echo '<form method="get" action="index.php">';
112 echo '<fieldset class="invisiblefieldset">';
113 echo '<p>'.html_writer::checkbox('showpasses', 1, $showpasses, get_string('showpasses', 'simpletest')).'</p>';
114 echo '<p>'.html_writer::checkbox('showsearch', 1, $showsearch, get_string('showsearch', 'simpletest')).'</p>';
115 if (moodle_coverage_recorder::can_run_codecoverage()) {
116     echo '<p>'.html_writer::checkbox('codecoverage', 1, $codecoverage, get_string('codecoverageanalysis', 'simpletest')).'</p>';
117 } else {
118     echo '<p>'; print_string('codecoveragedisabled', 'simpletest'); echo '<input type="hidden" name="codecoverage" value="0" /></p>';
120 echo '<p>';
121     echo '<label for="path">', get_string('onlytest', 'simpletest'), '</label> ';
122     echo '<input type="text" id="path" name="path" value="', $displaypath, '" size="40" />';
123 echo '</p>';
124 echo '<input type="submit" value="' . get_string('runtests', 'simpletest') . '" />';
125 echo '</fieldset>';
126 echo '</form>';
127 echo $OUTPUT->box_end();
129 // Print link to latest code coverage for this report type
130 if (is_null($path) || !$codecoverage) {
131     moodle_coverage_reporter::print_link_to_latest('unittest');
134 // Footer.
135 echo $OUTPUT->footer();