NOBUG standardising prevention of output buffering
[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 // disable compression, it would prevent closing of buffers
19 if (ini_get('zlib.output_compression')) {
20     ini_set('zlib.output_compression', 'Off');
21 }
23 // try to flush everything all the time
24 ob_implicit_flush(true);
25 while(ob_get_level()) {
26     if (!ob_end_clean()) {
27         // prevent infinite loop
28         break;
29     }
30 }
32 // Always run the unit tests in developer debug mode.
33 $CFG->debug = DEBUG_DEVELOPER;
34 error_reporting($CFG->debug);
35 raise_memory_limit(MEMORY_EXTRA);
37 // page parameters
38 $path         = optional_param('path', null, PARAM_PATH);
39 $showpasses   = optional_param('showpasses', false, PARAM_BOOL);
40 $codecoverage = optional_param('codecoverage', false, PARAM_BOOL);
41 $showsearch   = optional_param('showsearch', false, PARAM_BOOL);
43 admin_externalpage_setup('reportsimpletest', '', array('showpasses'=>$showpasses, 'showsearch'=>$showsearch));
45 $unittest = true;
47 global $UNITTEST;
48 $UNITTEST = new stdClass();
50 // This limit is the time allowed per individual test function. Please do not
51 // increase this value. If you get a PHP time limit when running unit tests,
52 // find the unit test which is running slowly, and either make it faster,
53 // split it into multiple tests, or call set_time_limit within that test.
54 define('TIME_ALLOWED_PER_UNIT_TEST', 60);
56 // Print the header.
57 $strtitle = get_string('unittests', 'simpletest');
59 if (!is_null($path)) {
60     //trim so user doesn't get an error if they include a space on the end of the path (ie by pasting path)
61     $path = trim($path);
63     // Turn off xmlstrictheaders during the unit test run.
64     $origxmlstrictheaders = !empty($CFG->xmlstrictheaders);
65     $CFG->xmlstrictheaders = false;
66     echo $OUTPUT->header();
67     $CFG->xmlstrictheaders = $origxmlstrictheaders;
68     unset($origxmlstrictheaders);
70     // Create the group of tests.
71     $test = new autogroup_test_coverage($showsearch, true, $codecoverage, 'Moodle Unit Tests Code Coverage Report', 'unittest');
73     // OU specific. We use the _nonproject folder for stuff we want to
74     // keep in CVS, but which is not really relevant. It does no harm
75     // to leave this here.
76     $test->addIgnoreFolder($CFG->dirroot . '/_nonproject');
78     // Make the reporter, which is what displays the results.
79     $reporter = new ExHtmlReporter($showpasses);
81     if ($showsearch) {
82         echo $OUTPUT->heading('Searching for test cases');
83     }
84     flush();
86     // Work out what to test.
87     if (substr($path, 0, 1) == '/') {
88         $path = substr($path, 1);
89     }
90     $path = $CFG->dirroot . '/' . $path;
91     if (substr($path, -1) == '/') {
92         $path = substr($path, 0, -1);
93     }
94     $displaypath = substr($path, strlen($CFG->dirroot) + 1);
95     $ok = true;
96     if (is_file($path)) {
97         $test->addTestFile($path);
98     } else if (is_dir($path)){
99         $test->findTestFiles($path);
100     } else {
101         echo $OUTPUT->box(get_string('pathdoesnotexist', 'simpletest', $path), 'errorbox');
102         $ok = false;
103     }
105     // If we have something to test, do it.
106     if ($ok) {
107         if ($path == $CFG->dirroot) {
108             $title = get_string('moodleunittests', 'simpletest', get_string('all', 'simpletest'));
109         } else {
110             $title = get_string('moodleunittests', 'simpletest', $displaypath);
111         }
112         echo $OUTPUT->heading($title);
113         $test->run($reporter);
114     }
116     $formheader = get_string('retest', 'simpletest');
117 } else {
118     $displaypath = '';
119     echo $OUTPUT->header();
120     $formheader = get_string('rununittests', 'simpletest');
122 // Print the form for adjusting options.
123 echo $OUTPUT->box_start('generalbox boxwidthwide boxaligncenter');
124 echo $OUTPUT->heading($formheader);
125 echo '<form method="get" action="index.php">';
126 echo '<fieldset class="invisiblefieldset">';
127 echo '<p>'.html_writer::checkbox('showpasses', 1, $showpasses, get_string('showpasses', 'simpletest')).'</p>';
128 echo '<p>'.html_writer::checkbox('showsearch', 1, $showsearch, get_string('showsearch', 'simpletest')).'</p>';
129 if (moodle_coverage_recorder::can_run_codecoverage()) {
130     echo '<p>'.html_writer::checkbox('codecoverage', 1, $codecoverage, get_string('codecoverageanalysis', 'simpletest')).'</p>';
131 } else {
132     echo '<p>'; print_string('codecoveragedisabled', 'simpletest'); echo '<input type="hidden" name="codecoverage" value="0" /></p>';
134 echo '<p>';
135     echo '<label for="path">', get_string('onlytest', 'simpletest'), '</label> ';
136     echo '<input type="text" id="path" name="path" value="', $displaypath, '" size="40" />';
137 echo '</p>';
138 echo '<input type="submit" value="' . get_string('runtests', 'simpletest') . '" />';
139 echo '</fieldset>';
140 echo '</form>';
141 echo $OUTPUT->box_end();
143 // Print link to latest code coverage for this report type
144 if (is_null($path) || !$codecoverage) {
145     moodle_coverage_reporter::print_link_to_latest('unittest');
148 // Footer.
149 echo $OUTPUT->footer();