MDL-29029 move all the simpletest bits into new tool unittest
[moodle.git] / admin / tool / unittest / index.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Run the unit tests.
19  *
20  * @package    tool
21  * @subpackage unittest
22  * @copyright  &copy; 2006 The Open University
23  * @author     N.D.Freear@open.ac.uk, T.J.Hunt@open.ac.uk
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 define('NO_OUTPUT_BUFFERING', true);
29 require(dirname(__FILE__) . '/../../../config.php');
30 require_once($CFG->libdir.'/adminlib.php');
31 require_once('simpletestlib.php');
32 require_once('simpletestcoveragelib.php');
33 require_once('ex_simple_test.php');
34 require_once('ex_reporter.php');
36 // Always run the unit tests in developer debug mode.
37 $CFG->debug = DEBUG_DEVELOPER;
38 error_reporting($CFG->debug);
39 raise_memory_limit(MEMORY_EXTRA);
41 // page parameters
42 $path         = optional_param('path', null, PARAM_PATH);
43 $showpasses   = optional_param('showpasses', false, PARAM_BOOL);
44 $codecoverage = optional_param('codecoverage', false, PARAM_BOOL);
45 $showsearch   = optional_param('showsearch', false, PARAM_BOOL);
47 admin_externalpage_setup('toolsimpletest', '', array('showpasses'=>$showpasses, 'showsearch'=>$showsearch));
49 $unittest = true;
51 global $UNITTEST;
52 $UNITTEST = new stdClass();
54 // This limit is the time allowed per individual test function. Please do not
55 // increase this value. If you get a PHP time limit when running unit tests,
56 // find the unit test which is running slowly, and either make it faster,
57 // split it into multiple tests, or call set_time_limit within that test.
58 define('TIME_ALLOWED_PER_UNIT_TEST', 60);
60 // Print the header.
61 $strtitle = get_string('unittests', 'tool_unittest');
63 if (!is_null($path)) {
64     //trim so user doesn't get an error if they include a space on the end of the path (ie by pasting path)
65     $path = trim($path);
67     // Turn off xmlstrictheaders during the unit test run.
68     $origxmlstrictheaders = !empty($CFG->xmlstrictheaders);
69     $CFG->xmlstrictheaders = false;
70     echo $OUTPUT->header();
71     $CFG->xmlstrictheaders = $origxmlstrictheaders;
72     unset($origxmlstrictheaders);
74     // Create the group of tests.
75     $test = new autogroup_test_coverage($showsearch, true, $codecoverage, 'Moodle Unit Tests Code Coverage Report', 'unittest');
77     // OU specific. We use the _nonproject folder for stuff we want to
78     // keep in CVS, but which is not really relevant. It does no harm
79     // to leave this here.
80     $test->addIgnoreFolder($CFG->dirroot . '/_nonproject');
82     // Make the reporter, which is what displays the results.
83     $reporter = new ExHtmlReporter($showpasses);
85     if ($showsearch) {
86         echo $OUTPUT->heading('Searching for test cases');
87     }
88     flush();
90     // Work out what to test.
91     if (substr($path, 0, 1) == '/') {
92         $path = substr($path, 1);
93     }
94     $path = $CFG->dirroot . '/' . $path;
95     if (substr($path, -1) == '/') {
96         $path = substr($path, 0, -1);
97     }
98     $displaypath = substr($path, strlen($CFG->dirroot) + 1);
99     $ok = true;
100     if (is_file($path)) {
101         $test->addTestFile($path);
102     } else if (is_dir($path)){
103         $test->findTestFiles($path);
104     } else {
105         echo $OUTPUT->box(get_string('pathdoesnotexist', 'tool_unittest', $path), 'errorbox');
106         $ok = false;
107     }
109     // If we have something to test, do it.
110     if ($ok) {
111         if ($path == $CFG->dirroot) {
112             $title = get_string('moodleunittests', 'tool_unittest', get_string('all', 'tool_unittest'));
113         } else {
114             $title = get_string('moodleunittests', 'tool_unittest', $displaypath);
115         }
116         echo $OUTPUT->heading($title);
117         $test->run($reporter);
118     }
120     $formheader = get_string('retest', 'tool_unittest');
121 } else {
122     $displaypath = '';
123     echo $OUTPUT->header();
124     $formheader = get_string('rununittests', 'tool_unittest');
126 // Print the form for adjusting options.
127 echo $OUTPUT->box_start('generalbox boxwidthwide boxaligncenter');
128 echo $OUTPUT->heading($formheader);
129 echo '<form method="get" action="index.php">';
130 echo '<fieldset class="invisiblefieldset">';
131 echo '<p>'.html_writer::checkbox('showpasses', 1, $showpasses, get_string('showpasses', 'tool_unittest')).'</p>';
132 echo '<p>'.html_writer::checkbox('showsearch', 1, $showsearch, get_string('showsearch', 'tool_unittest')).'</p>';
133 if (moodle_coverage_recorder::can_run_codecoverage()) {
134     echo '<p>'.html_writer::checkbox('codecoverage', 1, $codecoverage, get_string('codecoverageanalysis', 'tool_unittest')).'</p>';
135 } else {
136     echo '<p>'; print_string('codecoveragedisabled', 'tool_unittest'); echo '<input type="hidden" name="codecoverage" value="0" /></p>';
138 echo '<p>';
139     echo '<label for="path">', get_string('onlytest', 'tool_unittest'), '</label> ';
140     echo '<input type="text" id="path" name="path" value="', $displaypath, '" size="40" />';
141 echo '</p>';
142 echo '<input type="submit" value="' . get_string('runtests', 'tool_unittest') . '" />';
143 echo '</fieldset>';
144 echo '</form>';
145 echo $OUTPUT->box_end();
147 $otherpages = array();
148 $otherpages['PDF lib test'] = new moodle_url('/admin/tool/unittest/other/pdflibtestpage.php');
149 if (debugging('', DEBUG_DEVELOPER)) {
150     $otherpages['TODO checker'] = new moodle_url('/admin/tool/unittest/other/todochecker.php');
153 // print list of extra test pages that are not simpletests,
154 // not everything there is good enough to show to our users
155 if ($otherpages) {
156     echo $OUTPUT->box_start('generalbox boxwidthwide boxaligncenter');
157     echo $OUTPUT->heading(get_string('othertestpages', 'tool_unittest'));
158     echo '<ul>';
159     foreach ($otherpages as $name=>$url) {
160         echo '<li>'.html_writer::link($url, $name).'</li>';
161     }
162     echo '</ul>';
163     echo $OUTPUT->box_end();
167 // Print link to latest code coverage for this report type
168 if (is_null($path) || !$codecoverage) {
169     moodle_coverage_reporter::print_link_to_latest('unittest');
172 // Footer.
173 echo $OUTPUT->footer();