MDL-38041 behat: Adding styles to debugging messages
[moodle.git] / lib / tests / behat / behat_hooks.php
CommitLineData
f5ceb6c2 1<?php
f5ceb6c2
DM
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/>.
16
17/**
18 * Behat hooks steps definitions.
19 *
20 * This methods are used by Behat CLI command.
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 */
27
28// NOTE: no MOODLE_INTERNAL test here, this file may be required by behat before including /config.php.
29
30require_once(__DIR__ . '/../../behat/behat_base.php');
31
1303eb29
DM
32use Behat\Behat\Event\SuiteEvent as SuiteEvent,
33 Behat\Behat\Event\ScenarioEvent as ScenarioEvent,
34 Behat\Behat\Event\StepEvent as StepEvent,
35 WebDriver\Exception\NoSuchWindow as NoSuchWindow;
f5ceb6c2
DM
36
37/**
38 * Hooks to the behat process.
39 *
40 * Behat accepts hooks after and before each
41 * suite, feature, scenario and step.
42 *
43 * They can not call other steps as part of their process
44 * like regular steps definitions does.
45 *
46 * Throws generic Exception because they are captured by Behat.
47 *
48 * @package core
49 * @category test
50 * @copyright 2012 David MonllaĆ³
51 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
52 */
53class behat_hooks extends behat_base {
54
f5ceb6c2
DM
55 /**
56 * Gives access to moodle codebase, ensures all is ready and sets up the test lock.
57 *
58 * Includes config.php to use moodle codebase with $CFG->behat_*
59 * instead of $CFG->prefix and $CFG->dataroot, called once per suite.
60 *
61 * @static
62 * @throws Exception
63 * @BeforeSuite
64 */
65 public static function before_suite($event) {
66 global $CFG;
67
68 // To work with behat_dataroot and behat_prefix instead of the regular environment.
69 define('BEHAT_RUNNING', 1);
70 define('CLI_SCRIPT', 1);
71
b831d479 72 // With BEHAT_RUNNING we will be using $CFG->behat_* instead of $CFG->dataroot, $CFG->prefix and $CFG->wwwroot.
f5ceb6c2
DM
73 require_once(__DIR__ . '/../../../config.php');
74
75 // Now that we are MOODLE_INTERNAL.
76 require_once(__DIR__ . '/../../behat/classes/behat_command.php');
77 require_once(__DIR__ . '/../../behat/classes/util.php');
78 require_once(__DIR__ . '/../../testing/classes/test_lock.php');
b08b0a28 79 require_once(__DIR__ . '/../../testing/classes/nasty_strings.php');
f5ceb6c2
DM
80
81 // Avoids vendor/bin/behat to be executed directly without test environment enabled
82 // to prevent undesired db & dataroot modifications, this is also checked
83 // before each scenario (accidental user deletes) in the BeforeScenario hook.
84
85 if (!behat_util::is_test_mode_enabled()) {
86 throw new Exception('Behat only can run if test mode is enabled. More info in ' . behat_command::DOCS_URL . '#Running_tests');
87 }
88
89 if (!behat_util::is_server_running()) {
90 throw new Exception($CFG->behat_wwwroot . ' is not available, ensure you started your PHP built-in server. More info in ' . behat_command::DOCS_URL . '#Running_tests');
91 }
92
b831d479
DM
93 // Prevents using outdated data, upgrade script would start and tests would fail.
94 if (!behat_util::is_test_data_updated()) {
95 $commandpath = 'php admin/tool/behat/cli/util.php';
96 throw new Exception('Your behat test site is outdated, please run ' . $commandpath . ' from your moodle dirroot to drop and install the behat test site again.');
97 }
f5ceb6c2
DM
98 // Avoid parallel tests execution, it continues when the previous lock is released.
99 test_lock::acquire('behat');
100 }
101
102 /**
103 * Resets the test environment.
104 *
105 * @throws coding_exception If here we are not using the test database it should be because of a coding error
106 * @BeforeScenario
107 */
108 public function before_scenario($event) {
109 global $DB, $SESSION, $CFG;
110
111 // As many checks as we can.
112 if (!defined('BEHAT_RUNNING') ||
113 php_sapi_name() != 'cli' ||
114 !behat_util::is_test_mode_enabled() ||
115 !behat_util::is_test_site() ||
46ac40cd
DM
116 !isset($CFG->originaldataroot)) {
117 throw new coding_exception('Behat only can modify the test database and the test dataroot!');
f5ceb6c2
DM
118 }
119
c8619f33
DM
120 // Avoid some notices / warnings.
121 $SESSION = new stdClass();
122
f5ceb6c2
DM
123 behat_util::reset_database();
124 behat_util::reset_dataroot();
125
10dd80c2
DM
126 purge_all_caches();
127 accesslib_clear_all_caches(true);
128
b08b0a28
DM
129 // Reset the nasty strings list used during the last test.
130 nasty_strings::reset_used_strings();
131
f5ceb6c2
DM
132 // Assing valid data to admin user (some generator-related code needs a valid user).
133 $user = $DB->get_record('user', array('username' => 'admin'));
134 session_set_user($user);
f5ceb6c2
DM
135 }
136
137 /**
138 * Ensures selenium is running.
139 *
140 * Is only executed in scenarios which requires Javascript to run,
141 * it returns a direct error message about what's going on.
142 *
143 * @throws Exception
144 * @BeforeScenario @javascript
145 */
146 public function before_scenario_javascript($event) {
147
148 // Just trying if server responds.
149 try {
150 $this->getSession()->executeScript('// empty comment');
151 } catch (Exception $e) {
152 $moreinfo = 'More info in ' . behat_command::DOCS_URL . '#Running_tests';
153 $msg = 'Selenium server is not running, you need to start it to run tests that involves Javascript. ' . $moreinfo;
154 throw new Exception($msg);
155 }
156 }
157
158 /**
159 * Checks that all DOM is ready.
160 *
161 * Executed only when running against a real browser.
162 *
163 * @AfterStep @javascript
164 */
165 public function after_step_javascript($event) {
166
167 // If it doesn't have definition or it fails there is no need to check it.
168 if ($event->getResult() != StepEvent::PASSED ||
169 !$event->hasDefinition()) {
170 return;
171 }
172
d56ae59b 173 // Wait until the page is ready.
1303eb29
DM
174 try {
175 $this->getSession()->wait(self::TIMEOUT, '(document.readyState === "complete")');
176 } catch (NoSuchWindow $e) {
177 // If we were interacting with a popup window it will not exists after closing it.
178 }
f5ceb6c2
DM
179 }
180
181}