MDL-58948 behat: catch ElementNotFoundException
[moodle.git] / lib / behat / behat_base.php
CommitLineData
d4322e38
DM
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/>.
16
17/**
18 * Base class of all steps definitions.
19 *
20 * This script is only called from Behat as part of it's integration
21 * in Moodle.
22 *
23 * @package core
24 * @category test
25 * @copyright 2012 David MonllaĆ³
26 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27 */
28
29// NOTE: no MOODLE_INTERNAL test here, this file may be required by behat before including /config.php.
30
ff48a235 31use Behat\Mink\Exception\ExpectationException as ExpectationException,
fcb6ed47
MG
32 Behat\Mink\Exception\ElementNotFoundException as ElementNotFoundException,
33 Behat\Mink\Element\NodeElement as NodeElement;
ff48a235 34
d4322e38
DM
35/**
36 * Steps definitions base class.
37 *
38 * To extend by the steps definitions of the different Moodle components.
39 *
40 * It can not contain steps definitions to avoid duplicates, only utility
41 * methods shared between steps.
42 *
fcb6ed47
MG
43 * @method NodeElement find_field(string $locator) Finds a form element
44 * @method NodeElement find_button(string $locator) Finds a form input submit element or a button
45 * @method NodeElement find_link(string $locator) Finds a link on a page
46 * @method NodeElement find_file(string $locator) Finds a forum input file element
47 *
d4322e38
DM
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_base extends Behat\MinkExtension\Context\RawMinkContext {
54
74c78e74
DM
55 /**
56 * Small timeout.
57 *
58 * A reduced timeout for cases where self::TIMEOUT is too much
59 * and a simple $this->getSession()->getPage()->find() could not
60 * be enough.
61 */
62 const REDUCED_TIMEOUT = 2;
63
d4322e38
DM
64 /**
65 * The timeout for each Behat step (load page, wait for an element to load...).
66 */
845ceaff 67 const TIMEOUT = 6;
d1e55a47
DM
68
69 /**
70 * And extended timeout for specific cases.
71 */
72 const EXTENDED_TIMEOUT = 10;
73
d1e55a47
DM
74 /**
75 * The JS code to check that the page is ready.
76 */
41f4dabe 77 const PAGE_READY_JS = '(typeof M !== "undefined" && M.util && M.util.pending_js && !Boolean(M.util.pending_js.length)) && (document.readyState === "complete")';
d4322e38 78
786ea937
DM
79 /**
80 * Locates url, based on provided path.
81 * Override to provide custom routing mechanism.
82 *
83 * @see Behat\MinkExtension\Context\MinkContext
84 * @param string $path
85 * @return string
86 */
40923977 87 protected function locate_path($path) {
46ac40cd
DM
88 $starturl = rtrim($this->getMinkParameter('base_url'), '/') . '/';
89 return 0 !== strpos($path, 'http') ? $starturl . ltrim($path, '/') : $path;
786ea937
DM
90 }
91
ff48a235 92 /**
f8f1bdc3 93 * Returns the first matching element.
ff48a235
DM
94 *
95 * @link http://mink.behat.org/#traverse-the-page-selectors
ff48a235
DM
96 * @param string $selector The selector type (css, xpath, named...)
97 * @param mixed $locator It depends on the $selector, can be the xpath, a name, a css locator...
40923977 98 * @param Exception $exception Otherwise we throw exception with generic info
072f67fc 99 * @param NodeElement $node Spins around certain DOM node instead of the whole page
74c78e74 100 * @param int $timeout Forces a specific time out (in seconds).
ff48a235
DM
101 * @return NodeElement
102 */
74c78e74 103 protected function find($selector, $locator, $exception = false, $node = false, $timeout = false) {
ff48a235 104
42ad096f
RT
105 // Throw exception, so dev knows it is not supported.
106 if ($selector === 'named') {
107 $exception = 'Using the "named" selector is deprecated as of 3.1. '
108 .' Use the "named_partial" or use the "named_exact" selector instead.';
109 throw new ExpectationException($exception, $this->getSession());
110 }
111
f8f1bdc3 112 // Returns the first match.
74c78e74 113 $items = $this->find_all($selector, $locator, $exception, $node, $timeout);
f8f1bdc3
DM
114 return count($items) ? reset($items) : null;
115 }
116
117 /**
118 * Returns all matching elements.
119 *
120 * Adapter to Behat\Mink\Element\Element::findAll() using the spin() method.
121 *
122 * @link http://mink.behat.org/#traverse-the-page-selectors
123 * @param string $selector The selector type (css, xpath, named...)
124 * @param mixed $locator It depends on the $selector, can be the xpath, a name, a css locator...
125 * @param Exception $exception Otherwise we throw expcetion with generic info
126 * @param NodeElement $node Spins around certain DOM node instead of the whole page
74c78e74 127 * @param int $timeout Forces a specific time out (in seconds). If 0 is provided the default timeout will be applied.
f8f1bdc3
DM
128 * @return array NodeElements list
129 */
74c78e74 130 protected function find_all($selector, $locator, $exception = false, $node = false, $timeout = false) {
f8f1bdc3 131
42ad096f
RT
132 // Throw exception, so dev knows it is not supported.
133 if ($selector === 'named') {
134 $exception = 'Using the "named" selector is deprecated as of 3.1. '
135 .' Use the "named_partial" or use the "named_exact" selector instead.';
136 throw new ExpectationException($exception, $this->getSession());
137 }
138
ff48a235
DM
139 // Generic info.
140 if (!$exception) {
141
142 // With named selectors we can be more specific.
07298309 143 if (($selector == 'named_exact') || ($selector == 'named_partial')) {
ff48a235
DM
144 $exceptiontype = $locator[0];
145 $exceptionlocator = $locator[1];
0a7f6a02
DM
146
147 // If we are in a @javascript session all contents would be displayed as HTML characters.
eff79d53 148 if ($this->running_javascript()) {
0a7f6a02
DM
149 $locator[1] = html_entity_decode($locator[1], ENT_NOQUOTES);
150 }
151
ff48a235
DM
152 } else {
153 $exceptiontype = $selector;
154 $exceptionlocator = $locator;
155 }
156
157 $exception = new ElementNotFoundException($this->getSession(), $exceptiontype, null, $exceptionlocator);
158 }
159
072f67fc
DM
160 $params = array('selector' => $selector, 'locator' => $locator);
161 // Pushing $node if required.
162 if ($node) {
163 $params['node'] = $node;
164 }
165
74c78e74
DM
166 // How much we will be waiting for the element to appear.
167 if (!$timeout) {
168 $timeout = self::TIMEOUT;
169 $microsleep = false;
170 } else {
171 // Spinning each 0.1 seconds if the timeout was forced as we understand
172 // that is a special case and is good to refine the performance as much
173 // as possible.
174 $microsleep = true;
175 }
176
ff48a235
DM
177 // Waits for the node to appear if it exists, otherwise will timeout and throw the provided exception.
178 return $this->spin(
179 function($context, $args) {
072f67fc
DM
180
181 // If no DOM node provided look in all the page.
182 if (empty($args['node'])) {
f8f1bdc3 183 return $context->getSession()->getPage()->findAll($args['selector'], $args['locator']);
072f67fc
DM
184 }
185
186 // For nodes contained in other nodes we can not use the basic named selectors
187 // as they include unions and they would look for matches in the DOM root.
188 $elementxpath = $context->getSession()->getSelectorsHandler()->selectorToXpath($args['selector'], $args['locator']);
189
190 // Split the xpath in unions and prefix them with the container xpath.
191 $unions = explode('|', $elementxpath);
192 foreach ($unions as $key => $union) {
193 $union = trim($union);
194
195 // We are in the container node.
196 if (strpos($union, '.') === 0) {
197 $union = substr($union, 1);
3db1aec5
DM
198 } else if (strpos($union, '/') !== 0) {
199 // Adding the path separator in case it is not there.
200 $union = '/' . $union;
072f67fc
DM
201 }
202 $unions[$key] = $args['node']->getXpath() . $union;
203 }
204
205 // We can not use usual Element::find() as it prefixes with DOM root.
f8f1bdc3 206 return $context->getSession()->getDriver()->find(implode('|', $unions));
ff48a235 207 },
072f67fc 208 $params,
74c78e74
DM
209 $timeout,
210 $exception,
211 $microsleep
46ac40cd 212 );
ff48a235
DM
213 }
214
215 /**
216 * Finds DOM nodes in the page using named selectors.
217 *
218 * The point of using this method instead of Mink ones is the spin
219 * method of behat_base::find() that looks for the element until it
220 * is available or it timeouts, this avoids the false failures received
221 * when selenium tries to execute commands on elements that are not
222 * ready to be used.
223 *
224 * All steps that requires elements to be available before interact with
225 * them should use one of the find* methods.
226 *
227 * The methods calls requires a {'find_' . $elementtype}($locator)
228 * format, like find_link($locator), find_select($locator),
229 * find_button($locator)...
230 *
231 * @link http://mink.behat.org/#named-selectors
232 * @throws coding_exception
46ac40cd 233 * @param string $name The name of the called method
ff48a235
DM
234 * @param mixed $arguments
235 * @return NodeElement
236 */
237 public function __call($name, $arguments) {
238
239 if (substr($name, 0, 5) !== 'find_') {
240 throw new coding_exception('The "' . $name . '" method does not exist');
241 }
242
243 // Only the named selector identifier.
244 $cleanname = substr($name, 5);
245
246 // All named selectors shares the interface.
247 if (count($arguments) !== 1) {
248 throw new coding_exception('The "' . $cleanname . '" named selector needs the locator as it\'s single argument');
249 }
250
251 // Redirecting execution to the find method with the specified selector.
252 // It will detect if it's pointing to an unexisting named selector.
42ad096f 253 return $this->find('named_partial',
ff48a235
DM
254 array(
255 $cleanname,
921faad9 256 behat_context_helper::escape($arguments[0])
ff48a235
DM
257 )
258 );
259 }
260
49d91129
DM
261 /**
262 * Escapes the double quote character.
263 *
264 * Double quote is the argument delimiter, it can be escaped
265 * with a backslash, but we auto-remove this backslashes
266 * before the step execution, this method is useful when using
267 * arguments as arguments for other steps.
268 *
269 * @param string $string
270 * @return string
271 */
272 public function escape($string) {
273 return str_replace('"', '\"', $string);
274 }
275
786ea937
DM
276 /**
277 * Executes the passed closure until returns true or time outs.
278 *
279 * In most cases the document.readyState === 'complete' will be enough, but sometimes JS
280 * requires more time to be completely loaded or an element to be visible or whatever is required to
281 * perform some action on an element; this method receives a closure which should contain the
282 * required statements to ensure the step definition actions and assertions have all their needs
283 * satisfied and executes it until they are satisfied or it timeouts. Redirects the return of the
284 * closure to the caller.
285 *
286 * The closures requirements to work well with this spin method are:
287 * - Must return false, null or '' if something goes wrong
288 * - Must return something != false if finishes as expected, this will be the (mixed) value
289 * returned by spin()
290 *
ff48a235 291 * The arguments of the closure are mixed, use $args depending on your needs.
786ea937 292 *
ff48a235 293 * You can provide an exception to give more accurate feedback to tests writers, otherwise the
c51c3b55 294 * closure exception will be used, but you must provide an exception if the closure does not throw
ff48a235
DM
295 * an exception.
296 *
8e5f86bc
SH
297 * @throws Exception If it timeouts without receiving something != false from the closure
298 * @param Function|array|string $lambda The function to execute or an array passed to call_user_func (maps to a class method)
299 * @param mixed $args Arguments to pass to the closure
300 * @param int $timeout Timeout in seconds
301 * @param Exception $exception The exception to throw in case it time outs.
302 * @param bool $microsleep If set to true it'll sleep micro seconds rather than seconds.
786ea937
DM
303 * @return mixed The value returned by the closure
304 */
8e5f86bc 305 protected function spin($lambda, $args = false, $timeout = false, $exception = false, $microsleep = false) {
786ea937
DM
306
307 // Using default timeout which is pretty high.
308 if (!$timeout) {
309 $timeout = self::TIMEOUT;
310 }
8e5f86bc
SH
311 if ($microsleep) {
312 // Will sleep 1/10th of a second by default for self::TIMEOUT seconds.
313 $loops = $timeout * 10;
314 } else {
315 // Will sleep for self::TIMEOUT seconds.
316 $loops = $timeout;
317 }
786ea937 318
80ac8522
TL
319 // DOM will never change on non-javascript case; do not wait or try again.
320 if (!$this->running_javascript()) {
321 $loops = 1;
322 }
323
8e5f86bc 324 for ($i = 0; $i < $loops; $i++) {
786ea937
DM
325 // We catch the exception thrown by the step definition to execute it again.
326 try {
786ea937 327 // We don't check with !== because most of the time closures will return
ff48a235
DM
328 // direct Behat methods returns and we are not sure it will be always (bool)false
329 // if it just runs the behat method without returning anything $return == null.
8e5f86bc 330 if ($return = call_user_func($lambda, $this, $args)) {
786ea937
DM
331 return $return;
332 }
46ac40cd 333 } catch (Exception $e) {
ff48a235
DM
334 // We would use the first closure exception if no exception has been provided.
335 if (!$exception) {
336 $exception = $e;
337 }
786ea937
DM
338 // We wait until no exception is thrown or timeout expires.
339 continue;
340 }
341
80ac8522
TL
342 if ($this->running_javascript()) {
343 if ($microsleep) {
344 usleep(100000);
345 } else {
346 sleep(1);
347 }
8e5f86bc 348 }
786ea937
DM
349 }
350
ff48a235
DM
351 // Using coding_exception as is a development issue if no exception has been provided.
352 if (!$exception) {
8e5f86bc 353 $exception = new coding_exception('spin method requires an exception if the callback does not throw an exception');
ff48a235
DM
354 }
355
786ea937
DM
356 // Throwing exception to the user.
357 throw $exception;
358 }
359
40923977
DM
360 /**
361 * Gets a NodeElement based on the locator and selector type received as argument from steps definitions.
362 *
072f67fc
DM
363 * Use behat_base::get_text_selector_node() for text-based selectors.
364 *
40923977
DM
365 * @throws ElementNotFoundException Thrown by behat_base::find
366 * @param string $selectortype
367 * @param string $element
368 * @return NodeElement
369 */
370 protected function get_selected_node($selectortype, $element) {
371
372 // Getting Mink selector and locator.
373 list($selector, $locator) = $this->transform_selector($selectortype, $element);
374
375 // Returns the NodeElement.
376 return $this->find($selector, $locator);
377 }
378
072f67fc
DM
379 /**
380 * Gets a NodeElement based on the locator and selector type received as argument from steps definitions.
381 *
382 * @throws ElementNotFoundException Thrown by behat_base::find
383 * @param string $selectortype
384 * @param string $element
385 * @return NodeElement
386 */
387 protected function get_text_selector_node($selectortype, $element) {
388
389 // Getting Mink selector and locator.
390 list($selector, $locator) = $this->transform_text_selector($selectortype, $element);
391
392 // Returns the NodeElement.
393 return $this->find($selector, $locator);
394 }
395
396 /**
397 * Gets the requested element inside the specified container.
398 *
399 * @throws ElementNotFoundException Thrown by behat_base::find
400 * @param mixed $selectortype The element selector type.
401 * @param mixed $element The element locator.
402 * @param mixed $containerselectortype The container selector type.
403 * @param mixed $containerelement The container locator.
404 * @return NodeElement
405 */
406 protected function get_node_in_container($selectortype, $element, $containerselectortype, $containerelement) {
407
408 // Gets the container, it will always be text based.
409 $containernode = $this->get_text_selector_node($containerselectortype, $containerelement);
410
411 list($selector, $locator) = $this->transform_selector($selectortype, $element);
412
413 // Specific exception giving info about where can't we find the element.
414 $locatorexceptionmsg = $element . '" in the "' . $containerelement. '" "' . $containerselectortype. '"';
415 $exception = new ElementNotFoundException($this->getSession(), $selectortype, null, $locatorexceptionmsg);
416
417 // Looks for the requested node inside the container node.
418 return $this->find($selector, $locator, $exception, $containernode);
419 }
420
40923977
DM
421 /**
422 * Transforms from step definition's argument style to Mink format.
423 *
424 * Mink has 3 different selectors css, xpath and named, where named
425 * selectors includes link, button, field... to simplify and group multiple
426 * steps in one we use the same interface, considering all link, buttons...
427 * at the same level as css selectors and xpath; this method makes the
428 * conversion from the arguments received by the steps to the selectors and locators
429 * required to interact with Mink.
430 *
431 * @throws ExpectationException
432 * @param string $selectortype It can be css, xpath or any of the named selectors.
433 * @param string $element The locator (or string) we are looking for.
434 * @return array Contains the selector and the locator expected by Mink.
435 */
436 protected function transform_selector($selectortype, $element) {
437
17344d4c
DM
438 // Here we don't know if an allowed text selector is being used.
439 $selectors = behat_selectors::get_allowed_selectors();
440 if (!isset($selectors[$selectortype])) {
40923977
DM
441 throw new ExpectationException('The "' . $selectortype . '" selector type does not exist', $this->getSession());
442 }
443
17344d4c 444 return behat_selectors::get_behat_selector($selectortype, $element, $this->getSession());
40923977
DM
445 }
446
072f67fc
DM
447 /**
448 * Transforms from step definition's argument style to Mink format.
449 *
450 * Delegates all the process to behat_base::transform_selector() checking
451 * the provided $selectortype.
452 *
453 * @throws ExpectationException
454 * @param string $selectortype It can be css, xpath or any of the named selectors.
455 * @param string $element The locator (or string) we are looking for.
456 * @return array Contains the selector and the locator expected by Mink.
457 */
458 protected function transform_text_selector($selectortype, $element) {
459
17344d4c
DM
460 $selectors = behat_selectors::get_allowed_text_selectors();
461 if (empty($selectors[$selectortype])) {
072f67fc
DM
462 throw new ExpectationException('The "' . $selectortype . '" selector can not be used to select text nodes', $this->getSession());
463 }
464
465 return $this->transform_selector($selectortype, $element);
466 }
467
eff79d53
DM
468 /**
469 * Returns whether the scenario is running in a browser that can run Javascript or not.
470 *
471 * @return boolean
472 */
473 protected function running_javascript() {
28abad1a 474 return get_class($this->getSession()->getDriver()) !== 'Behat\Mink\Driver\GoutteDriver';
eff79d53
DM
475 }
476
d1e55a47
DM
477 /**
478 * Spins around an element until it exists
479 *
480 * @throws ExpectationException
481 * @param string $element
482 * @param string $selectortype
483 * @return void
484 */
485 protected function ensure_element_exists($element, $selectortype) {
486
487 // Getting the behat selector & locator.
488 list($selector, $locator) = $this->transform_selector($selectortype, $element);
489
490 // Exception if it timesout and the element is still there.
c1faf86b 491 $msg = 'The "' . $element . '" element does not exist and should exist';
d1e55a47
DM
492 $exception = new ExpectationException($msg, $this->getSession());
493
c1faf86b 494 // It will stop spinning once the find() method returns true.
d1e55a47
DM
495 $this->spin(
496 function($context, $args) {
497 // We don't use behat_base::find as it is already spinning.
498 if ($context->getSession()->getPage()->find($args['selector'], $args['locator'])) {
499 return true;
500 }
c1faf86b 501 return false;
d1e55a47
DM
502 },
503 array('selector' => $selector, 'locator' => $locator),
504 self::EXTENDED_TIMEOUT,
505 $exception,
506 true
507 );
508
509 }
510
511 /**
512 * Spins until the element does not exist
513 *
514 * @throws ExpectationException
515 * @param string $element
516 * @param string $selectortype
517 * @return void
518 */
519 protected function ensure_element_does_not_exist($element, $selectortype) {
520
521 // Getting the behat selector & locator.
522 list($selector, $locator) = $this->transform_selector($selectortype, $element);
523
524 // Exception if it timesout and the element is still there.
c1faf86b 525 $msg = 'The "' . $element . '" element exists and should not exist';
d1e55a47
DM
526 $exception = new ExpectationException($msg, $this->getSession());
527
c1faf86b 528 // It will stop spinning once the find() method returns false.
d1e55a47
DM
529 $this->spin(
530 function($context, $args) {
c1faf86b 531 // We don't use behat_base::find() as we are already spinning.
d1e55a47
DM
532 if (!$context->getSession()->getPage()->find($args['selector'], $args['locator'])) {
533 return true;
534 }
c1faf86b 535 return false;
d1e55a47
DM
536 },
537 array('selector' => $selector, 'locator' => $locator),
538 self::EXTENDED_TIMEOUT,
539 $exception,
540 true
541 );
542 }
543
544 /**
545 * Ensures that the provided node is visible and we can interact with it.
546 *
547 * @throws ExpectationException
548 * @param NodeElement $node
549 * @return void Throws an exception if it times out without the element being visible
550 */
551 protected function ensure_node_is_visible($node) {
552
553 if (!$this->running_javascript()) {
554 return;
555 }
556
557 // Exception if it timesout and the element is still there.
c1faf86b 558 $msg = 'The "' . $node->getXPath() . '" xpath node is not visible and it should be visible';
d1e55a47
DM
559 $exception = new ExpectationException($msg, $this->getSession());
560
c1faf86b 561 // It will stop spinning once the isVisible() method returns true.
d1e55a47
DM
562 $this->spin(
563 function($context, $args) {
564 if ($args->isVisible()) {
565 return true;
566 }
c1faf86b 567 return false;
d1e55a47
DM
568 },
569 $node,
570 self::EXTENDED_TIMEOUT,
571 $exception,
572 true
573 );
574 }
575
3df6e801
RT
576 /**
577 * Ensures that the provided node has a attribute value set. This step can be used to check if specific
578 * JS has finished modifying the node.
579 *
580 * @throws ExpectationException
581 * @param NodeElement $node
582 * @param string $attribute attribute name
583 * @param string $attributevalue attribute value to check.
584 * @return void Throws an exception if it times out without the element being visible
585 */
586 protected function ensure_node_attribute_is_set($node, $attribute, $attributevalue) {
587
588 if (!$this->running_javascript()) {
589 return;
590 }
591
592 // Exception if it timesout and the element is still there.
593 $msg = 'The "' . $node->getXPath() . '" xpath node is not visible and it should be visible';
594 $exception = new ExpectationException($msg, $this->getSession());
595
596 // It will stop spinning once the $args[1]) == $args[2], and method returns true.
597 $this->spin(
598 function($context, $args) {
599 if ($args[0]->getAttribute($args[1]) == $args[2]) {
600 return true;
601 }
602 return false;
603 },
604 array($node, $attribute, $attributevalue),
605 self::EXTENDED_TIMEOUT,
606 $exception,
607 true
608 );
609 }
610
d1e55a47
DM
611 /**
612 * Ensures that the provided element is visible and we can interact with it.
613 *
614 * Returns the node in case other actions are interested in using it.
615 *
616 * @throws ExpectationException
617 * @param string $element
618 * @param string $selectortype
619 * @return NodeElement Throws an exception if it times out without being visible
620 */
621 protected function ensure_element_is_visible($element, $selectortype) {
622
623 if (!$this->running_javascript()) {
624 return;
625 }
626
627 $node = $this->get_selected_node($selectortype, $element);
628 $this->ensure_node_is_visible($node);
629
630 return $node;
631 }
632
633 /**
634 * Ensures that all the page's editors are loaded.
635 *
9f07f05a 636 * @deprecated since Moodle 2.7 MDL-44084 - please do not use this function any more.
d1e55a47 637 * @throws ElementNotFoundException
c1faf86b 638 * @throws ExpectationException
d1e55a47
DM
639 * @return void
640 */
641 protected function ensure_editors_are_loaded() {
786ced99
DW
642 global $CFG;
643
644 if (empty($CFG->behat_usedeprecated)) {
645 debugging('Function behat_base::ensure_editors_are_loaded() is deprecated. It is no longer required.');
646 }
9f07f05a 647 return;
d1e55a47 648 }
c1faf86b 649
3b0b5e57
RT
650 /**
651 * Change browser window size.
652 * - small: 640x480
653 * - medium: 1024x768
654 * - large: 2560x1600
655 *
656 * @param string $windowsize size of window.
5a14c4d9 657 * @param bool $viewport If true, changes viewport rather than window size
3b0b5e57
RT
658 * @throws ExpectationException
659 */
5a14c4d9 660 protected function resize_window($windowsize, $viewport = false) {
3233f32d
RT
661 // Non JS don't support resize window.
662 if (!$this->running_javascript()) {
663 return;
664 }
665
3b0b5e57
RT
666 switch ($windowsize) {
667 case "small":
668 $width = 640;
669 $height = 480;
670 break;
671 case "medium":
672 $width = 1024;
673 $height = 768;
674 break;
675 case "large":
676 $width = 2560;
677 $height = 1600;
678 break;
679 default:
3233f32d 680 preg_match('/^(\d+x\d+)$/', $windowsize, $matches);
3b0b5e57
RT
681 if (empty($matches) || (count($matches) != 2)) {
682 throw new ExpectationException("Invalid screen size, can't resize", $this->getSession());
683 }
684 $size = explode('x', $windowsize);
685 $width = (int) $size[0];
686 $height = (int) $size[1];
687 }
5a14c4d9 688 if ($viewport) {
689 // When setting viewport size, we set it so that the document width will be exactly
690 // as specified, assuming that there is a vertical scrollbar. (In cases where there is
691 // no scrollbar it will be slightly wider. We presume this is rare and predictable.)
692 // The window inner height will be as specified, which means the available viewport will
693 // actually be smaller if there is a horizontal scrollbar. We assume that horizontal
694 // scrollbars are rare so this doesn't matter.
695 $offset = $this->getSession()->getDriver()->evaluateScript(
696 'return (function() { var before = document.body.style.overflowY;' .
697 'document.body.style.overflowY = "scroll";' .
698 'var result = {};' .
699 'result.x = window.outerWidth - document.body.offsetWidth;' .
700 'result.y = window.outerHeight - window.innerHeight;' .
701 'document.body.style.overflowY = before;' .
702 'return result; })();');
703 $width += $offset['x'];
704 $height += $offset['y'];
705 }
706
3b0b5e57
RT
707 $this->getSession()->getDriver()->resizeWindow($width, $height);
708 }
07298309
RT
709
710 /**
711 * Waits for all the JS to be loaded.
712 *
713 * @throws \Exception
714 * @throws NoSuchWindow
715 * @throws UnknownError
716 * @return bool True or false depending whether all the JS is loaded or not.
717 */
718 public function wait_for_pending_js() {
719 // Waiting for JS is only valid for JS scenarios.
720 if (!$this->running_javascript()) {
721 return;
722 }
723
724 // We don't use behat_base::spin() here as we don't want to end up with an exception
725 // if the page & JSs don't finish loading properly.
726 for ($i = 0; $i < self::EXTENDED_TIMEOUT * 10; $i++) {
727 $pending = '';
728 try {
729 $jscode = '
5536bf4f 730 return (function() {
07298309
RT
731 if (typeof M === "undefined") {
732 if (document.readyState === "complete") {
733 return "";
734 } else {
735 return "incomplete";
736 }
737 } else if (' . self::PAGE_READY_JS . ') {
738 return "";
eb9ca848 739 } else if (typeof M.util !== "undefined") {
07298309 740 return M.util.pending_js.join(":");
eb9ca848
RT
741 } else {
742 return "incomplete"
07298309 743 }
5536bf4f 744 }());';
07298309
RT
745 $pending = $this->getSession()->evaluateScript($jscode);
746 } catch (NoSuchWindow $nsw) {
747 // We catch an exception here, in case we just closed the window we were interacting with.
748 // No javascript is running if there is no window right?
749 $pending = '';
750 } catch (UnknownError $e) {
751 // M is not defined when the window or the frame don't exist anymore.
752 if (strstr($e->getMessage(), 'M is not defined') != false) {
753 $pending = '';
754 }
755 }
756
757 // If there are no pending JS we stop waiting.
758 if ($pending === '') {
759 return true;
760 }
761
762 // 0.1 seconds.
763 usleep(100000);
764 }
765
766 // Timeout waiting for JS to complete. It will be catched and forwarded to behat_hooks::i_look_for_exceptions().
767 // It is unlikely that Javascript code of a page or an AJAX request needs more than self::EXTENDED_TIMEOUT seconds
768 // to be loaded, although when pages contains Javascript errors M.util.js_complete() can not be executed, so the
769 // number of JS pending code and JS completed code will not match and we will reach this point.
770 throw new \Exception('Javascript code and/or AJAX requests are not ready after ' . self::EXTENDED_TIMEOUT .
771 ' seconds. There is a Javascript error or the code is extremely slow.');
772 }
eb9ca848
RT
773
774 /**
775 * Internal step definition to find exceptions, debugging() messages and PHP debug messages.
776 *
777 * Part of behat_hooks class as is part of the testing framework, is auto-executed
778 * after each step so no features will splicitly use it.
779 *
780 * @throws Exception Unknown type, depending on what we caught in the hook or basic \Exception.
781 * @see Moodle\BehatExtension\Tester\MoodleStepTester
782 */
783 public function look_for_exceptions() {
784 // Wrap in try in case we were interacting with a closed window.
785 try {
786
787 // Exceptions.
788 $exceptionsxpath = "//div[@data-rel='fatalerror']";
789 // Debugging messages.
790 $debuggingxpath = "//div[@data-rel='debugging']";
791 // PHP debug messages.
792 $phperrorxpath = "//div[@data-rel='phpdebugmessage']";
793 // Any other backtrace.
794 $othersxpath = "(//*[contains(., ': call to ')])[1]";
795
796 $xpaths = array($exceptionsxpath, $debuggingxpath, $phperrorxpath, $othersxpath);
797 $joinedxpath = implode(' | ', $xpaths);
798
799 // Joined xpath expression. Most of the time there will be no exceptions, so this pre-check
800 // is faster than to send the 4 xpath queries for each step.
801 if (!$this->getSession()->getDriver()->find($joinedxpath)) {
0c1bcb63
RT
802 // Check if we have recorded any errors in driver process.
803 $phperrors = behat_get_shutdown_process_errors();
804 if (!empty($phperrors)) {
805 foreach ($phperrors as $error) {
806 $errnostring = behat_get_error_string($error['type']);
807 $msgs[] = $errnostring . ": " .$error['message'] . " at " . $error['file'] . ": " . $error['line'];
808 }
809 $msg = "PHP errors found:\n" . implode("\n", $msgs);
810 throw new \Exception(htmlentities($msg));
811 }
812
eb9ca848
RT
813 return;
814 }
815
816 // Exceptions.
817 if ($errormsg = $this->getSession()->getPage()->find('xpath', $exceptionsxpath)) {
818
819 // Getting the debugging info and the backtrace.
820 $errorinfoboxes = $this->getSession()->getPage()->findAll('css', 'div.alert-error');
63e4df60
DW
821 // If errorinfoboxes is empty, try find alert-danger (bootstrap4) class.
822 if (empty($errorinfoboxes)) {
823 $errorinfoboxes = $this->getSession()->getPage()->findAll('css', 'div.alert-danger');
824 }
eb9ca848
RT
825 // If errorinfoboxes is empty, try find notifytiny (original) class.
826 if (empty($errorinfoboxes)) {
827 $errorinfoboxes = $this->getSession()->getPage()->findAll('css', 'div.notifytiny');
828 }
0c1bcb63
RT
829
830 // If errorinfoboxes is empty, try find ajax/JS exception in dialogue.
831 if (empty($errorinfoboxes)) {
832 $errorinfoboxes = $this->getSession()->getPage()->findAll('css', 'div.moodle-exception-message');
833
834 // If ajax/JS exception.
835 if ($errorinfoboxes) {
836 $errorinfo = $this->get_debug_text($errorinfoboxes[0]->getHtml());
837 }
838
839 } else {
840 $errorinfo = $this->get_debug_text($errorinfoboxes[0]->getHtml()) . "\n" .
841 $this->get_debug_text($errorinfoboxes[1]->getHtml());
842 }
eb9ca848
RT
843
844 $msg = "Moodle exception: " . $errormsg->getText() . "\n" . $errorinfo;
845 throw new \Exception(html_entity_decode($msg));
846 }
847
848 // Debugging messages.
849 if ($debuggingmessages = $this->getSession()->getPage()->findAll('xpath', $debuggingxpath)) {
850 $msgs = array();
851 foreach ($debuggingmessages as $debuggingmessage) {
852 $msgs[] = $this->get_debug_text($debuggingmessage->getHtml());
853 }
854 $msg = "debugging() message/s found:\n" . implode("\n", $msgs);
855 throw new \Exception(html_entity_decode($msg));
856 }
857
858 // PHP debug messages.
859 if ($phpmessages = $this->getSession()->getPage()->findAll('xpath', $phperrorxpath)) {
860
861 $msgs = array();
862 foreach ($phpmessages as $phpmessage) {
863 $msgs[] = $this->get_debug_text($phpmessage->getHtml());
864 }
865 $msg = "PHP debug message/s found:\n" . implode("\n", $msgs);
866 throw new \Exception(html_entity_decode($msg));
867 }
868
869 // Any other backtrace.
870 // First looking through xpath as it is faster than get and parse the whole page contents,
871 // we get the contents and look for matches once we found something to suspect that there is a backtrace.
872 if ($this->getSession()->getDriver()->find($othersxpath)) {
873 $backtracespattern = '/(line [0-9]* of [^:]*: call to [\->&;:a-zA-Z_\x7f-\xff][\->&;:a-zA-Z0-9_\x7f-\xff]*)/';
874 if (preg_match_all($backtracespattern, $this->getSession()->getPage()->getContent(), $backtraces)) {
875 $msgs = array();
876 foreach ($backtraces[0] as $backtrace) {
877 $msgs[] = $backtrace . '()';
878 }
879 $msg = "Other backtraces found:\n" . implode("\n", $msgs);
880 throw new \Exception(htmlentities($msg));
881 }
882 }
883
884 } catch (NoSuchWindow $e) {
885 // If we were interacting with a popup window it will not exists after closing it.
886 }
887 }
888
8918a811
DM
889 /**
890 * Converts HTML tags to line breaks to display the info in CLI
891 *
892 * @param string $html
893 * @return string
894 */
895 protected function get_debug_text($html) {
896
897 // Replacing HTML tags for new lines and keeping only the text.
898 $notags = preg_replace('/<+\s*\/*\s*([A-Z][A-Z0-9]*)\b[^>]*\/*\s*>*/i', "\n", $html);
899 return preg_replace("/(\n)+/s", "\n", $notags);
900 }
901
eb9ca848
RT
902 /**
903 * Helper function to execute api in a given context.
904 *
905 * @param string $contextapi context in which api is defined.
906 * @param array $params list of params to pass.
907 * @throws Exception
908 */
909 protected function execute($contextapi, $params = array()) {
910 if (!is_array($params)) {
911 $params = array($params);
912 }
913
914 // Get required context and execute the api.
915 $contextapi = explode("::", $contextapi);
916 $context = behat_context_helper::get($contextapi[0]);
917 call_user_func_array(array($context, $contextapi[1]), $params);
918
919 // NOTE: Wait for pending js and look for exception are not optional, as this might lead to unexpected results.
920 // Don't make them optional for performance reasons.
921
922 // Wait for pending js.
923 $this->wait_for_pending_js();
924
925 // Look for exceptions.
926 $this->look_for_exceptions();
927 }
353e7876 928
929 /**
930 * Get the actual user in the behat session (note $USER does not correspond to the behat session's user).
931 * @return mixed
932 * @throws coding_exception
933 */
934 protected function get_session_user() {
935 global $DB;
936
937 $sid = $this->getSession()->getCookie('MoodleSession');
938 if (empty($sid)) {
939 throw new coding_exception('failed to get moodle session');
940 }
941 $userid = $DB->get_field('sessions', 'userid', ['sid' => $sid]);
942 if (empty($userid)) {
943 throw new coding_exception('failed to get user from seession id '.$sid);
944 }
945 return $DB->get_record('user', ['id' => $userid]);
946 }
01f2a530 947
948 /**
949 * Trigger click on node via javascript instead of actually clicking on it via pointer.
950 *
951 * This function resolves the issue of nested elements with click listeners or links - in these cases clicking via
952 * the pointer may accidentally cause a click on the wrong element.
953 * Example of issue: clicking to expand navigation nodes when the config value linkadmincategories is enabled.
954 * @param NodeElement $node
955 */
956 protected function js_trigger_click($node) {
957 if (!$this->running_javascript()) {
958 $node->click();
959 }
960 $this->ensure_node_is_visible($node); // Ensures hidden elements can't be clicked.
961 $xpath = $node->getXpath();
962 $script = "Syn.click({{ELEMENT}})";
963 $this->getSession()->getDriver()->triggerSynScript($xpath, $script);
964 }
d4322e38 965}