MDL-37458 testing common methods generalization
[moodle.git] / lib / phpunit / bootstrap.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  * Prepares PHPUnit environment, the phpunit.xml configuration
19  * must specify this file as bootstrap.
20  *
21  * Exit codes: {@see phpunit_bootstrap_error()}
22  *
23  * @package    core
24  * @category   phpunit
25  * @copyright  2012 Petr Skoda {@link http://skodak.org}
26  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27  */
29 // we want to know about all problems
30 error_reporting(E_ALL | E_STRICT);
31 ini_set('display_errors', '1');
32 ini_set('log_errors', '1');
34 require_once(__DIR__.'/bootstraplib.php');
35 require_once(__DIR__.'/../testing/lib.php');
37 if (isset($_SERVER['REMOTE_ADDR'])) {
38     phpunit_bootstrap_error(1, 'Unit tests can be executed only from command line!');
39 }
41 if (defined('PHPUNIT_TEST')) {
42     phpunit_bootstrap_error(1, "PHPUNIT_TEST constant must not be manually defined anywhere!");
43 }
44 /** PHPUnit testing framework active */
45 define('PHPUNIT_TEST', true);
47 if (!defined('PHPUNIT_UTIL')) {
48     /** Identifies utility scripts - the database does not need to be initialised */
49     define('PHPUNIT_UTIL', false);
50 }
52 if (defined('CLI_SCRIPT')) {
53     phpunit_bootstrap_error(1, 'CLI_SCRIPT must not be manually defined in any PHPUnit test scripts');
54 }
55 define('CLI_SCRIPT', true);
57 $phpunitversion = PHPUnit_Runner_Version::id();
58 if ($phpunitversion === '@package_version@') {
59     // library checked out from git, let's hope dev knows that 3.6.0 is required
60 } else if (version_compare($phpunitversion, '3.6.0', 'lt')) {
61     phpunit_bootstrap_error(PHPUNIT_EXITCODE_PHPUNITWRONG, $phpunitversion);
62 }
63 unset($phpunitversion);
65 if (!include_once('PHPUnit/Extensions/Database/Autoload.php')) {
66     phpunit_bootstrap_error(PHPUNIT_EXITCODE_PHPUNITEXTMISSING, 'phpunit/DbUnit');
67 }
69 define('NO_OUTPUT_BUFFERING', true);
71 // only load CFG from config.php, stop ASAP in lib/setup.php
72 define('ABORT_AFTER_CONFIG', true);
73 require(__DIR__ . '/../../config.php');
75 if (!defined('PHPUNIT_LONGTEST')) {
76     /** Execute longer version of tests */
77     define('PHPUNIT_LONGTEST', false);
78 }
80 // remove error handling overrides done in config.php
81 error_reporting(E_ALL | E_STRICT);
82 ini_set('display_errors', '1');
83 ini_set('log_errors', '1');
84 set_time_limit(0); // no time limit in CLI scripts, user may cancel execution
86 // prepare dataroot
87 umask(0);
88 if (isset($CFG->phpunit_directorypermissions)) {
89     $CFG->directorypermissions = $CFG->phpunit_directorypermissions;
90 } else {
91     $CFG->directorypermissions = 02777;
92 }
93 $CFG->filepermissions = ($CFG->directorypermissions & 0666);
94 if (!isset($CFG->phpunit_dataroot)) {
95     phpunit_bootstrap_error(PHPUNIT_EXITCODE_CONFIGERROR, 'Missing $CFG->phpunit_dataroot in config.php, can not run tests!');
96 }
97 if (isset($CFG->dataroot) and $CFG->phpunit_dataroot === $CFG->dataroot) {
98     phpunit_bootstrap_error(PHPUNIT_EXITCODE_CONFIGERROR, '$CFG->dataroot and $CFG->phpunit_dataroot must not be identical, can not run tests!');
99 }
100 if (!file_exists($CFG->phpunit_dataroot)) {
101     mkdir($CFG->phpunit_dataroot, $CFG->directorypermissions);
103 if (!is_dir($CFG->phpunit_dataroot)) {
104     phpunit_bootstrap_error(PHPUNIT_EXITCODE_CONFIGERROR, '$CFG->phpunit_dataroot directory can not be created, can not run tests!');
107 if (!is_writable($CFG->phpunit_dataroot)) {
108     // try to fix permissions if possible
109     if (function_exists('posix_getuid')) {
110         $chmod = fileperms($CFG->phpunit_dataroot);
111         if (fileowner($CFG->phpunit_dataroot) == posix_getuid()) {
112             $chmod = $chmod | 0700;
113             chmod($CFG->phpunit_dataroot, $chmod);
114         }
115     }
116     if (!is_writable($CFG->phpunit_dataroot)) {
117         phpunit_bootstrap_error(PHPUNIT_EXITCODE_CONFIGERROR, '$CFG->phpunit_dataroot directory is not writable, can not run tests!');
118     }
120 if (!file_exists("$CFG->phpunit_dataroot/phpunittestdir.txt")) {
121     if ($dh = opendir($CFG->phpunit_dataroot)) {
122         while (($file = readdir($dh)) !== false) {
123             if ($file === 'phpunit' or $file === '.' or $file === '..' or $file === '.DS_Store') {
124                 continue;
125             }
126             phpunit_bootstrap_error(PHPUNIT_EXITCODE_CONFIGERROR, '$CFG->phpunit_dataroot directory is not empty, can not run tests! Is it used for anything else?');
127         }
128         closedir($dh);
129         unset($dh);
130         unset($file);
131     }
133     // now we are 100% sure this dir is used only for phpunit tests
134     testing_initdataroot($CFG->phpunit_dataroot, 'phpunit');
137 // verify db prefix
138 if (!isset($CFG->phpunit_prefix)) {
139     phpunit_bootstrap_error(PHPUNIT_EXITCODE_CONFIGERROR, 'Missing $CFG->phpunit_prefix in config.php, can not run tests!');
141 if ($CFG->phpunit_prefix === '') {
142     phpunit_bootstrap_error(PHPUNIT_EXITCODE_CONFIGERROR, '$CFG->phpunit_prefix can not be empty, can not run tests!');
144 if (isset($CFG->prefix) and $CFG->prefix === $CFG->phpunit_prefix) {
145     phpunit_bootstrap_error(PHPUNIT_EXITCODE_CONFIGERROR, '$CFG->prefix and $CFG->phpunit_prefix must not be identical, can not run tests!');
148 // override CFG settings if necessary and throw away extra CFG settings
149 $CFG->wwwroot   = 'http://www.example.com/moodle';
150 $CFG->dataroot  = $CFG->phpunit_dataroot;
151 $CFG->prefix    = $CFG->phpunit_prefix;
152 $CFG->dbtype    = isset($CFG->phpunit_dbtype) ? $CFG->phpunit_dbtype : $CFG->dbtype;
153 $CFG->dblibrary = isset($CFG->phpunit_dblibrary) ? $CFG->phpunit_dblibrary : $CFG->dblibrary;
154 $CFG->dbhost    = isset($CFG->phpunit_dbhost) ? $CFG->phpunit_dbhost : $CFG->dbhost;
155 $CFG->dbname    = isset($CFG->phpunit_dbname) ? $CFG->phpunit_dbname : $CFG->dbname;
156 $CFG->dbuser    = isset($CFG->phpunit_dbuser) ? $CFG->phpunit_dbuser : $CFG->dbuser;
157 $CFG->dbpass    = isset($CFG->phpunit_dbpass) ? $CFG->phpunit_dbpass : $CFG->dbpass;
158 $CFG->prefix    = isset($CFG->phpunit_prefix) ? $CFG->phpunit_prefix : $CFG->prefix;
159 $CFG->dboptions = isset($CFG->phpunit_dboptions) ? $CFG->phpunit_dboptions : $CFG->dboptions;
161 $allowed = array('wwwroot', 'dataroot', 'dirroot', 'admin', 'directorypermissions', 'filepermissions',
162                  'dbtype', 'dblibrary', 'dbhost', 'dbname', 'dbuser', 'dbpass', 'prefix', 'dboptions',
163                  'proxyhost', 'proxyport', 'proxytype', 'proxyuser', 'proxypassword', 'proxybypass', // keep proxy settings from config.php
164                 );
165 $productioncfg = (array)$CFG;
166 $CFG = new stdClass();
167 foreach ($productioncfg as $key=>$value) {
168     if (!in_array($key, $allowed) and strpos($key, 'phpunit_') !== 0) {
169         // ignore
170         continue;
171     }
172     $CFG->{$key} = $value;
174 unset($key);
175 unset($value);
176 unset($allowed);
177 unset($productioncfg);
179 // force the same CFG settings in all sites
180 $CFG->debug = (E_ALL | E_STRICT); // can not use DEBUG_DEVELOPER yet
181 $CFG->debugdisplay = 1;
182 error_reporting($CFG->debug);
183 ini_set('display_errors', '1');
184 ini_set('log_errors', '1');
186 $CFG->passwordsaltmain = 'phpunit'; // makes login via normal UI impossible
188 $CFG->noemailever = true; // better not mail anybody from tests, override temporarily if necessary
189 $CFG->cachetext = 0; // disable this very nasty setting
191 // some ugly hacks
192 $CFG->themerev = 1;
193 $CFG->jsrev = 1;
195 // load test case stub classes and other stuff
196 require_once("$CFG->dirroot/lib/phpunit/lib.php");
198 // finish moodle init
199 define('ABORT_AFTER_CONFIG_CANCEL', true);
200 require("$CFG->dirroot/lib/setup.php");
202 raise_memory_limit(MEMORY_HUGE);
204 if (PHPUNIT_UTIL) {
205     // we are not going to do testing, this is 'true' in utility scripts that only init database
206     return;
209 // is database and dataroot ready for testing?
210 list($errorcode, $message) = phpunit_util::testing_ready_problem();
211 if ($errorcode) {
212     phpunit_bootstrap_error($errorcode, $message);
215 // prepare for the first test run - store fresh globals, reset database and dataroot, etc.
216 phpunit_util::bootstrap_init();