MDL-42733 behat: Removing the restriction of an started output to handle the PHP...
[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) {
88     // If is preceded by an @ we don't show it.
89     if (!error_reporting()) {
90         return true;
91     }
93     // This error handler receives E_ALL | E_STRICT, running the behat test site the debug level is
94     // set to DEVELOPER and will always include E_NOTICE,E_USER_NOTICE... as part of E_ALL, if the current
95     // error_reporting() value does not include one of those levels is because it has been forced through
96     // the moodle code (see fix_utf8() for example) in that cases we respect the forced error level value.
97     $respect = array(E_NOTICE, E_USER_NOTICE, E_STRICT, E_WARNING, E_USER_WARNING);
98     foreach ($respect as $respectable) {
100         // If the current value does not include this kind of errors and the reported error is
101         // at that level don't print anything.
102         if ($errno == $respectable && !(error_reporting() & $respectable)) {
103             return true;
104         }
105     }
107     // Using the default one in case there is a fatal catchable error.
108     default_error_handler($errno, $errstr, $errfile, $errline, $errcontext);
110     switch ($errno) {
111         case E_USER_ERROR:
112             $errnostr = 'Fatal error';
113             break;
114         case E_WARNING:
115         case E_USER_WARNING:
116             $errnostr = 'Warning';
117             break;
118         case E_NOTICE:
119         case E_USER_NOTICE:
120         case E_STRICT:
121             $errnostr = 'Notice';
122             break;
123         case E_RECOVERABLE_ERROR:
124             $errnostr = 'Catchable';
125             break;
126         default:
127             $errnostr = 'Unknown error type';
128     }
130     // Wrapping the output.
131     echo '<div class="phpdebugmessage" data-rel="phpdebugmessage">' . PHP_EOL;
132     echo "$errnostr: $errstr in $errfile on line $errline" . PHP_EOL;
133     echo '</div>';
135     // Also use the internal error handler so we keep the usual behaviour.
136     return false;
139 /**
140  * Restrict the config.php settings allowed.
141  *
142  * When running the behat features the config.php
143  * settings should not affect the results.
144  *
145  * @return void
146  */
147 function behat_clean_init_config() {
148     global $CFG;
150     $allowed = array_flip(array(
151         'wwwroot', 'dataroot', 'dirroot', 'admin', 'directorypermissions', 'filepermissions',
152         'dbtype', 'dblibrary', 'dbhost', 'dbname', 'dbuser', 'dbpass', 'prefix', 'dboptions',
153         'proxyhost', 'proxyport', 'proxytype', 'proxyuser', 'proxypassword', 'proxybypass',
154         'theme'
155     ));
157     // Add extra allowed settings.
158     if (!empty($CFG->behat_extraallowedsettings)) {
159         $allowed = array_merge($allowed, array_flip($CFG->behat_extraallowedsettings));
160     }
162     // Also allowing behat_ prefixed attributes.
163     foreach ($CFG as $key => $value) {
164         if (!isset($allowed[$key]) && strpos($key, 'behat_') !== 0) {
165             unset($CFG->{$key});
166         }
167     }