Merge branch 'MDL-41587_master' of git://github.com/dmonllao/moodle
[moodle.git] / lib / behat / classes / util.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  * Utils for behat-related stuff
19  *
20  * @package    core
21  * @category   test
22  * @copyright  2012 David MonllaĆ³
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 defined('MOODLE_INTERNAL') || die();
28 require_once(__DIR__ . '/../lib.php');
29 require_once(__DIR__ . '/../../testing/classes/util.php');
30 require_once(__DIR__ . '/behat_command.php');
31 require_once(__DIR__ . '/behat_config_manager.php');
33 require_once(__DIR__ . '/../../filelib.php');
35 /**
36  * Init/reset utilities for Behat database and dataroot
37  *
38  * @package   core
39  * @category  test
40  * @copyright 2013 David MonllaĆ³
41  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
42  */
43 class behat_util extends testing_util {
45     /**
46      * The behat test site fullname and shortname.
47      */
48     const BEHATSITENAME = "Acceptance test site";
50     /**
51      * @var array Files to skip when resetting dataroot folder
52      */
53     protected static $datarootskiponreset = array('.', '..', 'behat', 'behattestdir.txt');
55     /**
56      * @var array Files to skip when dropping dataroot folder
57      */
58     protected static $datarootskipondrop = array('.', '..', 'lock');
60     /**
61      * Installs a site using $CFG->dataroot and $CFG->prefix
62      * @throws coding_exception
63      * @return void
64      */
65     public static function install_site() {
66         global $DB, $CFG;
67         require_once($CFG->dirroot.'/user/lib.php');
68         if (!defined('BEHAT_UTIL')) {
69             throw new coding_exception('This method can be only used by Behat CLI tool');
70         }
72         // New dataroot.
73         self::reset_dataroot();
75         $options = array();
76         $options['adminuser'] = 'admin';
77         $options['adminpass'] = 'admin';
78         $options['fullname'] = self::BEHATSITENAME;
79         $options['shortname'] = self::BEHATSITENAME;
81         install_cli_database($options, false);
83         // Update admin user info.
84         $user = $DB->get_record('user', array('username' => 'admin'));
85         $user->email = 'moodle@moodlemoodle.com';
86         $user->firstname = 'Admin';
87         $user->lastname = 'User';
88         $user->city = 'Perth';
89         $user->country = 'AU';
90         user_update_user($user, false);
92         // Disable email message processor.
93         $DB->set_field('message_processors', 'enabled', '0', array('name' => 'email'));
95         // Sets maximum debug level.
96         set_config('debug', DEBUG_DEVELOPER);
97         set_config('debugdisplay', true);
99         // Keeps the current version of database and dataroot.
100         self::store_versions_hash();
102         // Stores the database contents for fast reset.
103         self::store_database_state();
104     }
106     /**
107      * Drops dataroot and remove test database tables
108      * @throws coding_exception
109      * @return void
110      */
111     public static function drop_site() {
113         if (!defined('BEHAT_UTIL')) {
114             throw new coding_exception('This method can be only used by Behat CLI tool');
115         }
117         self::reset_dataroot();
118         self::drop_dataroot();
119         self::drop_database(true);
120     }
122     /**
123      * Checks if $CFG->behat_wwwroot is available
124      *
125      * @return bool
126      */
127     public static function is_server_running() {
128         global $CFG;
130         $request = new curl();
131         $request->get($CFG->behat_wwwroot);
133         if ($request->get_errno() === 0) {
134             return true;
135         }
136         return false;
137     }
139     /**
140      * Checks whether the test database and dataroot is ready
141      * Stops execution if something went wrong
142      * @throws coding_exception
143      * @return void
144      */
145     protected static function test_environment_problem() {
146         global $CFG, $DB;
148         if (!defined('BEHAT_UTIL')) {
149             throw new coding_exception('This method can be only used by Behat CLI tool');
150         }
152         if (!self::is_test_site()) {
153             behat_error(1, 'This is not a behat test site!');
154         }
156         $tables = $DB->get_tables(false);
157         if (empty($tables)) {
158             behat_error(BEHAT_EXITCODE_INSTALL, '');
159         }
161         if (!self::is_test_data_updated()) {
162             behat_error(BEHAT_EXITCODE_REINSTALL, 'The test environment was initialised for a different version');
163         }
164     }
166     /**
167      * Enables test mode
168      *
169      * It uses CFG->behat_dataroot
170      *
171      * Starts the test mode checking the composer installation and
172      * the test environment and updating the available
173      * features and steps definitions.
174      *
175      * Stores a file in dataroot/behat to allow Moodle to switch
176      * to the test environment when using cli-server (or $CFG->behat_switchcompletely)
177      * @throws coding_exception
178      * @return void
179      */
180     public static function start_test_mode() {
181         global $CFG;
183         if (!defined('BEHAT_UTIL')) {
184             throw new coding_exception('This method can be only used by Behat CLI tool');
185         }
187         // Checks the behat set up and the PHP version.
188         if ($errorcode = behat_command::behat_setup_problem(true)) {
189             exit($errorcode);
190         }
192         // Check that test environment is correctly set up.
193         self::test_environment_problem();
195         // Updates all the Moodle features and steps definitions.
196         behat_config_manager::update_config_file();
198         if (self::is_test_mode_enabled()) {
199             return;
200         }
202         $contents = '$CFG->behat_wwwroot, $CFG->behat_prefix and $CFG->behat_dataroot' .
203             ' are currently used as $CFG->wwwroot, $CFG->prefix and $CFG->dataroot';
204         $filepath = self::get_test_file_path();
205         if (!file_put_contents($filepath, $contents)) {
206             behat_error(BEHAT_EXITCODE_PERMISSIONS, 'File ' . $filepath . ' can not be created');
207         }
208     }
210     /**
211      * Returns the status of the behat test environment
212      *
213      * @return int Error code
214      */
215     public static function get_behat_status() {
217         if (!defined('BEHAT_UTIL')) {
218             throw new coding_exception('This method can be only used by Behat CLI tool');
219         }
221         // Checks the behat set up and the PHP version, returning an error code if something went wrong.
222         if ($errorcode = behat_command::behat_setup_problem(true)) {
223             return $errorcode;
224         }
226         // Check that test environment is correctly set up, stops execution.
227         self::test_environment_problem();
228     }
230     /**
231      * Disables test mode
232      * @throws coding_exception
233      * @return void
234      */
235     public static function stop_test_mode() {
237         if (!defined('BEHAT_UTIL')) {
238             throw new coding_exception('This method can be only used by Behat CLI tool');
239         }
241         $testenvfile = self::get_test_file_path();
243         if (!self::is_test_mode_enabled()) {
244             echo "Test environment was already disabled\n";
245         } else {
246             if (!unlink($testenvfile)) {
247                 behat_error(BEHAT_EXITCODE_PERMISSIONS, 'Can not delete test environment file');
248             }
249         }
250     }
252     /**
253      * Checks whether test environment is enabled or disabled
254      *
255      * To check is the current script is running in the test
256      * environment
257      *
258      * @return bool
259      */
260     public static function is_test_mode_enabled() {
262         $testenvfile = self::get_test_file_path();
263         if (file_exists($testenvfile)) {
264             return true;
265         }
267         return false;
268     }
270     /**
271      * Returns the path to the file which specifies if test environment is enabled
272      * @return string
273      */
274     protected final static function get_test_file_path() {
275         return behat_command::get_behat_dir() . '/test_environment_enabled.txt';
276     }