MDL-41030 behat: Dock blocks compatible with both selenium and phantomjs
[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,
89cf999a 35 Behat\Mink\Exception\DriverException as DriverException,
870349ee
DM
36 WebDriver\Exception\NoSuchWindow as NoSuchWindow,
37 WebDriver\Exception\UnexpectedAlertOpen as UnexpectedAlertOpen,
3b7d3fb8
DM
38 WebDriver\Exception\UnknownError as UnknownError,
39 WebDriver\Exception\CurlExec as CurlExec,
870349ee 40 WebDriver\Exception\NoAlertOpenError as NoAlertOpenError;
f5ceb6c2
DM
41
42/**
43 * Hooks to the behat process.
44 *
45 * Behat accepts hooks after and before each
46 * suite, feature, scenario and step.
47 *
48 * They can not call other steps as part of their process
49 * like regular steps definitions does.
50 *
51 * Throws generic Exception because they are captured by Behat.
52 *
53 * @package core
54 * @category test
55 * @copyright 2012 David Monllaó
56 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
57 */
58class behat_hooks extends behat_base {
59
41eb672b
DM
60 /**
61 * @var Last browser session start time.
62 */
63 protected static $lastbrowsersessionstart = 0;
64
95b43d6b
DM
65 /**
66 * @var For actions that should only run once.
67 */
68 protected static $initprocessesfinished = false;
69
f5ceb6c2
DM
70 /**
71 * Gives access to moodle codebase, ensures all is ready and sets up the test lock.
72 *
73 * Includes config.php to use moodle codebase with $CFG->behat_*
74 * instead of $CFG->prefix and $CFG->dataroot, called once per suite.
75 *
76 * @static
77 * @throws Exception
78 * @BeforeSuite
79 */
80 public static function before_suite($event) {
81 global $CFG;
82
cfcbc34a
DM
83 // Defined only when the behat CLI command is running, the moodle init setup process will
84 // read this value and switch to $CFG->behat_dataroot and $CFG->behat_prefix instead of
85 // the normal site.
86 define('BEHAT_TEST', 1);
87
f5ceb6c2
DM
88 define('CLI_SCRIPT', 1);
89
cfcbc34a 90 // With BEHAT_TEST we will be using $CFG->behat_* instead of $CFG->dataroot, $CFG->prefix and $CFG->wwwroot.
f5ceb6c2
DM
91 require_once(__DIR__ . '/../../../config.php');
92
93 // Now that we are MOODLE_INTERNAL.
94 require_once(__DIR__ . '/../../behat/classes/behat_command.php');
17344d4c 95 require_once(__DIR__ . '/../../behat/classes/behat_selectors.php');
f5ceb6c2
DM
96 require_once(__DIR__ . '/../../behat/classes/util.php');
97 require_once(__DIR__ . '/../../testing/classes/test_lock.php');
b08b0a28 98 require_once(__DIR__ . '/../../testing/classes/nasty_strings.php');
f5ceb6c2
DM
99
100 // Avoids vendor/bin/behat to be executed directly without test environment enabled
101 // to prevent undesired db & dataroot modifications, this is also checked
102 // before each scenario (accidental user deletes) in the BeforeScenario hook.
103
104 if (!behat_util::is_test_mode_enabled()) {
105 throw new Exception('Behat only can run if test mode is enabled. More info in ' . behat_command::DOCS_URL . '#Running_tests');
106 }
107
108 if (!behat_util::is_server_running()) {
3b7d3fb8
DM
109 throw new Exception($CFG->behat_wwwroot .
110 ' is not available, ensure you started your PHP built-in server or your web server is correctly started and set up.' .
111 ' More info in ' . behat_command::DOCS_URL . '#Running_tests');
f5ceb6c2
DM
112 }
113
b831d479
DM
114 // Prevents using outdated data, upgrade script would start and tests would fail.
115 if (!behat_util::is_test_data_updated()) {
b32ca4ca 116 $commandpath = 'php admin/tool/behat/cli/init.php';
b831d479
DM
117 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.');
118 }
f5ceb6c2
DM
119 // Avoid parallel tests execution, it continues when the previous lock is released.
120 test_lock::acquire('behat');
41eb672b
DM
121
122 // Store the browser reset time if reset after N seconds is specified in config.php.
123 if (!empty($CFG->behat_restart_browser_after)) {
124 // Store the initial browser session opening.
125 self::$lastbrowsersessionstart = time();
126 }
f5ceb6c2
DM
127 }
128
129 /**
130 * Resets the test environment.
131 *
132 * @throws coding_exception If here we are not using the test database it should be because of a coding error
133 * @BeforeScenario
134 */
135 public function before_scenario($event) {
136 global $DB, $SESSION, $CFG;
137
138 // As many checks as we can.
cfcbc34a
DM
139 if (!defined('BEHAT_TEST') ||
140 !defined('BEHAT_SITE_RUNNING') ||
f5ceb6c2
DM
141 php_sapi_name() != 'cli' ||
142 !behat_util::is_test_mode_enabled() ||
cfcbc34a 143 !behat_util::is_test_site()) {
46ac40cd 144 throw new coding_exception('Behat only can modify the test database and the test dataroot!');
f5ceb6c2
DM
145 }
146
89cf999a
DM
147 $moreinfo = 'More info in ' . behat_command::DOCS_URL . '#Running_tests';
148 $driverexceptionmsg = 'Selenium server is not running, you need to start it to run tests that involve Javascript. ' . $moreinfo;
f59f6b6b
DM
149 try {
150 $session = $this->getSession();
151 } catch (CurlExec $e) {
152 // Exception thrown by WebDriver, so only @javascript tests will be caugth; in
153 // behat_util::is_server_running() we already checked that the server is running.
89cf999a
DM
154 throw new Exception($driverexceptionmsg);
155 } catch (DriverException $e) {
156 throw new Exception($driverexceptionmsg);
f59f6b6b
DM
157 } catch (UnknownError $e) {
158 // Generic 'I have no idea' Selenium error. Custom exception to provide more feedback about possible solutions.
159 $this->throw_unknown_exception($e);
160 }
161
162
17344d4c
DM
163 // We need the Mink session to do it and we do it only before the first scenario.
164 if (self::is_first_scenario()) {
f59f6b6b 165 behat_selectors::register_moodle_selectors($session);
17344d4c
DM
166 }
167
de230fd3
PS
168 // Reset $SESSION.
169 $_SESSION = array();
c8619f33 170 $SESSION = new stdClass();
de230fd3 171 $_SESSION['SESSION'] =& $SESSION;
c8619f33 172
f5ceb6c2
DM
173 behat_util::reset_database();
174 behat_util::reset_dataroot();
175
10dd80c2
DM
176 purge_all_caches();
177 accesslib_clear_all_caches(true);
178
b08b0a28
DM
179 // Reset the nasty strings list used during the last test.
180 nasty_strings::reset_used_strings();
181
de230fd3 182 // Assign valid data to admin user (some generator-related code needs a valid user).
f5ceb6c2 183 $user = $DB->get_record('user', array('username' => 'admin'));
d79d5ac2 184 \core\session\manager::set_user($user);
5f4b4e91 185
41eb672b
DM
186 // Reset the browser if specified in config.php.
187 if (!empty($CFG->behat_restart_browser_after) && $this->running_javascript()) {
188 $now = time();
189 if (self::$lastbrowsersessionstart + $CFG->behat_restart_browser_after < $now) {
f59f6b6b 190 $session->restart();
41eb672b
DM
191 self::$lastbrowsersessionstart = $now;
192 }
193 }
194
5f4b4e91 195 // Start always in the the homepage.
3b7d3fb8 196 try {
f59f6b6b
DM
197 // Let's be conservative as we never know when new upstream issues will affect us.
198 $session->visit($this->locate_path('/'));
3b7d3fb8 199 } catch (UnknownError $e) {
3b7d3fb8
DM
200 $this->throw_unknown_exception($e);
201 }
870349ee 202
f59f6b6b 203
95b43d6b
DM
204 // Checking that the root path is a Moodle test site.
205 if (self::is_first_scenario()) {
206 $notestsiteexception = new Exception('The base URL (' . $CFG->wwwroot . ') is not a behat test site, ' .
3b7d3fb8 207 'ensure you started the built-in web server in the correct directory or your web server is correctly started and set up');
19f6703d 208 $this->find("xpath", "//head/child::title[normalize-space(.)='" . behat_util::BEHATSITENAME . "']", $notestsiteexception);
95b43d6b
DM
209
210 self::$initprocessesfinished = true;
211 }
212
870349ee
DM
213 // Closing JS dialogs if present. Otherwise they would block this scenario execution.
214 if ($this->running_javascript()) {
215 try {
f59f6b6b 216 $session->getDriver()->getWebDriverSession()->accept_alert();
870349ee
DM
217 } catch (NoAlertOpenError $e) {
218 // All ok, there should not be JS dialogs in theory.
219 }
220 }
221
f5ceb6c2
DM
222 }
223
f5ceb6c2
DM
224 /**
225 * Checks that all DOM is ready.
226 *
227 * Executed only when running against a real browser.
228 *
229 * @AfterStep @javascript
230 */
231 public function after_step_javascript($event) {
232
233 // If it doesn't have definition or it fails there is no need to check it.
234 if ($event->getResult() != StepEvent::PASSED ||
235 !$event->hasDefinition()) {
236 return;
237 }
238
28abad1a
DM
239 // Wait until the page is ready.
240 // We are already checking that we use a JS browser, this could
241 // change in case we use another JS driver.
242 try {
243
244 // Safari and Internet Explorer requires time between steps,
245 // otherwise Selenium tries to click in the previous page's DOM.
246 if ($this->getSession()->getDriver()->getBrowserName() == 'safari' ||
247 $this->getSession()->getDriver()->getBrowserName() == 'internet explorer') {
248 $this->getSession()->wait(self::TIMEOUT * 1000, false);
249
250 } else {
251 // With other browsers we just wait for the DOM ready.
252 $this->getSession()->wait(self::TIMEOUT * 1000, '(document.readyState === "complete")');
253 }
254
1303eb29
DM
255 } catch (NoSuchWindow $e) {
256 // If we were interacting with a popup window it will not exists after closing it.
3b7d3fb8
DM
257 } catch (UnknownError $e) {
258 // Custom exception to provide more feedback about possible solutions.
259 $this->throw_unknown_exception($e);
1303eb29 260 }
f5ceb6c2
DM
261 }
262
5f4b4e91
DM
263 /**
264 * Internal step definition to find exceptions, debugging() messages and PHP debug messages.
265 *
266 * Part of behat_hooks class as is part of the testing framework, is auto-executed
267 * after each step so no features will splicitly use it.
268 *
269 * @Given /^I look for exceptions$/
270 * @see Moodle\BehatExtension\Tester\MoodleStepTester
271 */
272 public function i_look_for_exceptions() {
273
217e8e59
DM
274 // Wrap in try in case we were interacting with a closed window.
275 try {
5f4b4e91 276
217e8e59 277 // Exceptions.
3e76c7fa 278 $exceptionsxpath = "//div[@data-rel='fatalerror']";
8aea365f 279 // Debugging messages.
3e76c7fa 280 $debuggingxpath = "//div[@data-rel='debugging']";
8aea365f 281 // PHP debug messages.
3e76c7fa 282 $phperrorxpath = "//div[@data-rel='phpdebugmessage']";
8aea365f 283 // Any other backtrace.
6cd21356 284 $othersxpath = "(//*[contains(., ': call to ')])[1]";
8aea365f
DM
285
286 $xpaths = array($exceptionsxpath, $debuggingxpath, $phperrorxpath, $othersxpath);
287 $joinedxpath = implode(' | ', $xpaths);
288
289 // Joined xpath expression. Most of the time there will be no exceptions, so this pre-check
290 // is faster than to send the 4 xpath queries for each step.
291 if (!$this->getSession()->getDriver()->find($joinedxpath)) {
292 return;
293 }
294
295 // Exceptions.
296 if ($errormsg = $this->getSession()->getPage()->find('xpath', $exceptionsxpath)) {
5f4b4e91 297
217e8e59
DM
298 // Getting the debugging info and the backtrace.
299 $errorinfoboxes = $this->getSession()->getPage()->findAll('css', 'div.notifytiny');
300 $errorinfo = $this->get_debug_text($errorinfoboxes[0]->getHtml()) . "\n" .
301 $this->get_debug_text($errorinfoboxes[1]->getHtml());
5f4b4e91 302
217e8e59
DM
303 $msg = "Moodle exception: " . $errormsg->getText() . "\n" . $errorinfo;
304 throw new \Exception(html_entity_decode($msg));
305 }
306
307 // Debugging messages.
8aea365f 308 if ($debuggingmessages = $this->getSession()->getPage()->findAll('xpath', $debuggingxpath)) {
217e8e59
DM
309 $msgs = array();
310 foreach ($debuggingmessages as $debuggingmessage) {
311 $msgs[] = $this->get_debug_text($debuggingmessage->getHtml());
312 }
313 $msg = "debugging() message/s found:\n" . implode("\n", $msgs);
314 throw new \Exception(html_entity_decode($msg));
5f4b4e91 315 }
90ed22ab 316
217e8e59 317 // PHP debug messages.
8aea365f 318 if ($phpmessages = $this->getSession()->getPage()->findAll('xpath', $phperrorxpath)) {
90ed22ab 319
217e8e59
DM
320 $msgs = array();
321 foreach ($phpmessages as $phpmessage) {
322 $msgs[] = $this->get_debug_text($phpmessage->getHtml());
323 }
324 $msg = "PHP debug message/s found:\n" . implode("\n", $msgs);
325 throw new \Exception(html_entity_decode($msg));
90ed22ab 326 }
bbd802f7 327
217e8e59 328 // Any other backtrace.
9a1f4922
DM
329 // First looking through xpath as it is faster than get and parse the whole page contents,
330 // we get the contents and look for matches once we found something to suspect that there is a backtrace.
8aea365f 331 if ($this->getSession()->getDriver()->find($othersxpath)) {
9a1f4922
DM
332 $backtracespattern = '/(line [0-9]* of [^:]*: call to [\->&;:a-zA-Z_\x7f-\xff][\->&;:a-zA-Z0-9_\x7f-\xff]*)/';
333 if (preg_match_all($backtracespattern, $this->getSession()->getPage()->getContent(), $backtraces)) {
334 $msgs = array();
335 foreach ($backtraces[0] as $backtrace) {
336 $msgs[] = $backtrace . '()';
337 }
338 $msg = "Other backtraces found:\n" . implode("\n", $msgs);
339 throw new \Exception(htmlentities($msg));
217e8e59 340 }
bbd802f7 341 }
217e8e59
DM
342
343 } catch (NoSuchWindow $e) {
344 // If we were interacting with a popup window it will not exists after closing it.
870349ee
DM
345 } catch (UnexpectedAlertOpen $e) {
346 // We fail the scenario if we find an opened JS alert/confirm, in most of the cases it
347 // will be there because we are leaving an edited form without submitting/cancelling
348 // it, but moodle is using JS confirms and we can not just cancel the JS dialog
349 // as in some cases (delete activity with JS enabled for example) the test writer should
350 // use extra steps to deal with moodle's behaviour.
351 throw new Exception('Modal window present. Ensure there are no edited forms pending to submit/cancel.');
bbd802f7 352 }
5f4b4e91
DM
353 }
354
355 /**
356 * Converts HTML tags to line breaks to display the info in CLI
357 *
358 * @param string $html
359 * @return string
360 */
361 protected function get_debug_text($html) {
362
363 // Replacing HTML tags for new lines and keeping only the text.
364 $notags = preg_replace('/<+\s*\/*\s*([A-Z][A-Z0-9]*)\b[^>]*\/*\s*>*/i', "\n", $html);
365 return preg_replace("/(\n)+/s", "\n", $notags);
366 }
367
95b43d6b
DM
368 /**
369 * Returns whether the first scenario of the suite is running
370 *
371 * @return bool
372 */
373 protected static function is_first_scenario() {
374 return !(self::$initprocessesfinished);
375 }
3b7d3fb8
DM
376
377 /**
378 * Throws an exception after appending an extra info text.
379 *
380 * @throws Exception
381 * @param UnknownError $exception
382 * @return void
383 */
384 protected function throw_unknown_exception(UnknownError $exception) {
385 $text = get_string('unknownexceptioninfo', 'tool_behat');
386 throw new Exception($text . PHP_EOL . $exception->getMessage());
387 }
388
f5ceb6c2 389}