73745500bee7b2bd12c30b8de5fef3c99f541d00
[moodle.git] / lib / behat / lib.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  * Behat basic functions
19  *
20  * It does not include MOODLE_INTERNAL because is part of the bootstrap
21  *
22  * @package    core
23  * @category   test
24  * @copyright  2012 David MonllaĆ³
25  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26  */
28 require_once(__DIR__ . '/../testing/lib.php');
30 define('BEHAT_EXITCODE_CONFIG', 250);
31 define('BEHAT_EXITCODE_REQUIREMENT', 251);
32 define('BEHAT_EXITCODE_PERMISSIONS', 252);
33 define('BEHAT_EXITCODE_REINSTALL', 253);
34 define('BEHAT_EXITCODE_INSTALL', 254);
35 define('BEHAT_EXITCODE_COMPOSER', 255);
37 /**
38  * Exits with an error code
39  *
40  * @param  mixed $errorcode
41  * @param  string $text
42  * @return void Stops execution with error code
43  */
44 function behat_error($errorcode, $text = '') {
46     // Adding error prefixes.
47     switch ($errorcode) {
48         case BEHAT_EXITCODE_CONFIG:
49             $text = 'Behat config error: ' . $text;
50             break;
51         case BEHAT_EXITCODE_REQUIREMENT:
52             $text = 'Behat requirement not satisfied: ' . $text;
53             break;
54         case BEHAT_EXITCODE_PERMISSIONS:
55             $text = 'Behat permissions problem: ' . $text . ', check the permissions';
56             break;
57         case BEHAT_EXITCODE_REINSTALL:
58             $path = testing_cli_argument_path('/admin/tool/behat/cli/init.php');
59             $text = "Reinstall Behat: ".$text.", use:\n php ".$path;
60             break;
61         case BEHAT_EXITCODE_INSTALL:
62             $path = testing_cli_argument_path('/admin/tool/behat/cli/init.php');
63             $text = "Install Behat before enabling it, use:\n php ".$path;
64             break;
65         default:
66             $text = 'Unknown error ' . $errorcode . ' ' . $text;
67             break;
68     }
70     testing_error($errorcode, $text);
71 }
73 /**
74  * PHP errors handler to use when running behat tests.
75  *
76  * Adds specific CSS classes to identify
77  * the messages.
78  *
79  * @param int $errno
80  * @param string $errstr
81  * @param string $errfile
82  * @param int $errline
83  * @param array $errcontext
84  * @return bool
85  */
86 function behat_error_handler($errno, $errstr, $errfile, $errline, $errcontext) {
87     global $OUTPUT;
89     // Only after something has been writen.
90     if (!$OUTPUT->has_started()) {
91         return false;
92     }
94     // If is preceded by an @ we don't show it.
95     if (!error_reporting()) {
96         return true;
97     }
99     // This error handler receives E_ALL | E_STRICT, running the behat test site the debug level is
100     // set to DEVELOPER and will always include E_NOTICE,E_USER_NOTICE... as part of E_ALL, if the current
101     // error_reporting() value does not include one of those levels is because it has been forced through
102     // the moodle code (see fix_utf8() for example) in that cases we respect the forced error level value.
103     $respect = array(E_NOTICE, E_USER_NOTICE, E_STRICT, E_WARNING, E_USER_WARNING);
104     foreach ($respect as $respectable) {
106         // If the current value does not include this kind of errors and the reported error is
107         // at that level don't print anything.
108         if ($errno == $respectable && !(error_reporting() & $respectable)) {
109             return true;
110         }
111     }
113     // Using the default one in case there is a fatal catchable error.
114     default_error_handler($errno, $errstr, $errfile, $errline, $errcontext);
116     switch ($errno) {
117         case E_USER_ERROR:
118             $errnostr = 'Fatal error';
119             break;
120         case E_WARNING:
121         case E_USER_WARNING:
122             $errnostr = 'Warning';
123             break;
124         case E_NOTICE:
125         case E_USER_NOTICE:
126         case E_STRICT:
127             $errnostr = 'Notice';
128             break;
129         case E_RECOVERABLE_ERROR:
130             $errnostr = 'Catchable';
131             break;
132         default:
133             $errnostr = 'Unknown error type';
134     }
136     // Wrapping the output.
137     echo '<div class="phpdebugmessage" data-rel="phpdebugmessage">' . PHP_EOL;
138     echo "$errnostr: $errstr in $errfile on line $errline" . PHP_EOL;
139     echo '</div>';
141     // Also use the internal error handler so we keep the usual behaviour.
142     return false;
145 /**
146  * Restrict the config.php settings allowed.
147  *
148  * When running the behat features the config.php
149  * settings should not affect the results.
150  *
151  * @return void
152  */
153 function behat_clean_init_config() {
154     global $CFG;
156     $allowed = array_flip(array(
157         'wwwroot', 'dataroot', 'dirroot', 'admin', 'directorypermissions', 'filepermissions',
158         'dbtype', 'dblibrary', 'dbhost', 'dbname', 'dbuser', 'dbpass', 'prefix', 'dboptions',
159         'proxyhost', 'proxyport', 'proxytype', 'proxyuser', 'proxypassword', 'proxybypass',
160         'theme'
161     ));
163     // Add extra allowed settings.
164     if (!empty($CFG->behat_extraallowedsettings)) {
165         $allowed = array_merge($allowed, array_flip($CFG->behat_extraallowedsettings));
166     }
168     // Also allowing behat_ prefixed attributes.
169     foreach ($CFG as $key => $value) {
170         if (!isset($allowed[$key]) && strpos($key, 'behat_') !== 0) {
171             unset($CFG->{$key});
172         }
173     }