MDL-70167 behat: Rewrite attribute check steps
[moodle.git] / lib / tests / behat / behat_general.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  * General use steps definitions.
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 // NOTE: no MOODLE_INTERNAL test here, this file may be required by behat before including /config.php.
28 require_once(__DIR__ . '/../../behat/behat_base.php');
30 use Behat\Gherkin\Node\TableNode as TableNode;
31 use Behat\Mink\Exception\DriverException as DriverException;
32 use Behat\Mink\Exception\ElementNotFoundException as ElementNotFoundException;
33 use Behat\Mink\Exception\ExpectationException as ExpectationException;
34 use WebDriver\Exception\NoSuchElement as NoSuchElement;
35 use WebDriver\Exception\StaleElementReference as StaleElementReference;
37 /**
38  * Cross component steps definitions.
39  *
40  * Basic web application definitions from MinkExtension and
41  * BehatchExtension. Definitions modified according to our needs
42  * when necessary and including only the ones we need to avoid
43  * overlapping and confusion.
44  *
45  * @package   core
46  * @category  test
47  * @copyright 2012 David MonllaĆ³
48  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
49  */
50 class behat_general extends behat_base {
52     /**
53      * @var string used by {@link switch_to_window()} and
54      * {@link switch_to_the_main_window()} to work-around a Chrome browser issue.
55      */
56     const MAIN_WINDOW_NAME = '__moodle_behat_main_window_name';
58     /**
59      * @var string when we want to check whether or not a new page has loaded,
60      * we first write this unique string into the page. Then later, by checking
61      * whether it is still there, we can tell if a new page has been loaded.
62      */
63     const PAGE_LOAD_DETECTION_STRING = 'new_page_not_loaded_since_behat_started_watching';
65     /**
66      * @var $pageloaddetectionrunning boolean Used to ensure that page load detection was started before a page reload
67      * was checked for.
68      */
69     private $pageloaddetectionrunning = false;
71     /**
72      * Opens Moodle homepage.
73      *
74      * @Given /^I am on homepage$/
75      */
76     public function i_am_on_homepage() {
77         $this->execute('behat_general::i_visit', ['/']);
78     }
80     /**
81      * Opens Moodle site homepage.
82      *
83      * @Given /^I am on site homepage$/
84      */
85     public function i_am_on_site_homepage() {
86         $this->execute('behat_general::i_visit', ['/?redirect=0']);
87     }
89     /**
90      * Opens course index page.
91      *
92      * @Given /^I am on course index$/
93      */
94     public function i_am_on_course_index() {
95         $this->execute('behat_general::i_visit', ['/course/index.php']);
96     }
98     /**
99      * Reloads the current page.
100      *
101      * @Given /^I reload the page$/
102      */
103     public function reload() {
104         $this->getSession()->reload();
105     }
107     /**
108      * Follows the page redirection. Use this step after any action that shows a message and waits for a redirection
109      *
110      * @Given /^I wait to be redirected$/
111      */
112     public function i_wait_to_be_redirected() {
114         // Xpath and processes based on core_renderer::redirect_message(), core_renderer::$metarefreshtag and
115         // moodle_page::$periodicrefreshdelay possible values.
116         if (!$metarefresh = $this->getSession()->getPage()->find('xpath', "//head/descendant::meta[@http-equiv='refresh']")) {
117             // We don't fail the scenario if no redirection with message is found to avoid race condition false failures.
118             return true;
119         }
121         // Wrapped in try & catch in case the redirection has already been executed.
122         try {
123             $content = $metarefresh->getAttribute('content');
124         } catch (NoSuchElement $e) {
125             return true;
126         } catch (StaleElementReference $e) {
127             return true;
128         }
130         // Getting the refresh time and the url if present.
131         if (strstr($content, 'url') != false) {
133             list($waittime, $url) = explode(';', $content);
135             // Cleaning the URL value.
136             $url = trim(substr($url, strpos($url, 'http')));
138         } else {
139             // Just wait then.
140             $waittime = $content;
141         }
144         // Wait until the URL change is executed.
145         if ($this->running_javascript()) {
146             $this->getSession()->wait($waittime * 1000);
148         } else if (!empty($url)) {
149             // We redirect directly as we can not wait for an automatic redirection.
150             $this->getSession()->getDriver()->getClient()->request('get', $url);
152         } else {
153             // Reload the page if no URL was provided.
154             $this->getSession()->getDriver()->reload();
155         }
156     }
158     /**
159      * Switches to the specified iframe.
160      *
161      * @Given /^I switch to "(?P<iframe_name_string>(?:[^"]|\\")*)" iframe$/
162      * @param string $iframename
163      */
164     public function switch_to_iframe($iframename) {
166         // We spin to give time to the iframe to be loaded.
167         // Using extended timeout as we don't know about which
168         // kind of iframe will be loaded.
169         $this->spin(
170             function($context, $iframename) {
171                 $context->getSession()->switchToIFrame($iframename);
173                 // If no exception we are done.
174                 return true;
175             },
176             $iframename,
177             behat_base::get_extended_timeout()
178         );
179     }
181     /**
182      * Switches to the iframe containing specified class.
183      *
184      * @Given /^I switch to "(?P<iframe_name_string>(?:[^"]|\\")*)" class iframe$/
185      * @param string $classname
186      */
187     public function switch_to_class_iframe($classname) {
188         // We spin to give time to the iframe to be loaded.
189         // Using extended timeout as we don't know about which
190         // kind of iframe will be loaded.
191         $this->spin(
192             function($context, $classname) {
193                 $iframe = $this->find('iframe', $classname);
194                 if (!empty($iframe->getAttribute('id'))) {
195                     $iframename = $iframe->getAttribute('id');
196                 } else {
197                     $iframename = $iframe->getAttribute('name');
198                 }
199                 $context->getSession()->switchToIFrame($iframename);
201                 // If no exception we are done.
202                 return true;
203             },
204             $classname,
205             behat_base::get_extended_timeout()
206         );
207     }
209     /**
210      * Switches to the main Moodle frame.
211      *
212      * @Given /^I switch to the main frame$/
213      */
214     public function switch_to_the_main_frame() {
215         $this->getSession()->switchToIFrame();
216     }
218     /**
219      * Switches to the specified window. Useful when interacting with popup windows.
220      *
221      * @Given /^I switch to "(?P<window_name_string>(?:[^"]|\\")*)" window$/
222      * @param string $windowname
223      */
224     public function switch_to_window($windowname) {
225         // In Behat, some browsers (e.g. Chrome) are unable to switch to a
226         // window without a name, and by default the main browser window does
227         // not have a name. To work-around this, when we switch away from an
228         // unnamed window (presumably the main window) to some other named
229         // window, then we first set the main window name to a conventional
230         // value that we can later use this name to switch back.
231         $this->execute_script('if (window.name == "") window.name = "' . self::MAIN_WINDOW_NAME . '"');
233         $this->getSession()->switchToWindow($windowname);
234     }
236     /**
237      * Switches to the main Moodle window. Useful when you finish interacting with popup windows.
238      *
239      * @Given /^I switch to the main window$/
240      */
241     public function switch_to_the_main_window() {
242         $this->getSession()->switchToWindow(self::MAIN_WINDOW_NAME);
243     }
245     /**
246      * Closes all extra windows opened during the navigation.
247      *
248      * This assumes all popups are opened by the main tab and you will now get back.
249      *
250      * @Given /^I close all opened windows$/
251      * @throws DriverException If there aren't exactly 1 tabs open when finish or no javascript running
252      */
253     public function i_close_all_opened_windows() {
254         if (!$this->running_javascript()) {
255             throw new DriverException('Closing windows steps require javascript');
256         }
257         $names = $this->getSession()->getWindowNames();
258         for ($index = 1; $index < count($names); $index ++) {
259             $this->getSession()->switchToWindow($names[$index]);
260             $this->execute_script("window.open('', '_self').close();");
261         }
262         $names = $this->getSession()->getWindowNames();
263         if (count($names) !== 1) {
264             throw new DriverException('Expected to see 1 tabs open, not ' . count($names));
265         }
266         $this->getSession()->switchToWindow($names[0]);
267     }
269     /**
270      * Accepts the currently displayed alert dialog. This step does not work in all the browsers, consider it experimental.
271      * @Given /^I accept the currently displayed dialog$/
272      */
273     public function accept_currently_displayed_alert_dialog() {
274         $this->getSession()->getDriver()->getWebDriverSession()->accept_alert();
275     }
277     /**
278      * Dismisses the currently displayed alert dialog. This step does not work in all the browsers, consider it experimental.
279      * @Given /^I dismiss the currently displayed dialog$/
280      */
281     public function dismiss_currently_displayed_alert_dialog() {
282         $this->getSession()->getDriver()->getWebDriverSession()->dismiss_alert();
283     }
285     /**
286      * Clicks link with specified id|title|alt|text.
287      *
288      * @When /^I follow "(?P<link_string>(?:[^"]|\\")*)"$/
289      * @throws ElementNotFoundException Thrown by behat_base::find
290      * @param string $link
291      */
292     public function click_link($link) {
294         $linknode = $this->find_link($link);
295         $this->ensure_node_is_visible($linknode);
296         $linknode->click();
297     }
299     /**
300      * Waits X seconds. Required after an action that requires data from an AJAX request.
301      *
302      * @Then /^I wait "(?P<seconds_number>\d+)" seconds$/
303      * @param int $seconds
304      */
305     public function i_wait_seconds($seconds) {
306         if ($this->running_javascript()) {
307             $this->getSession()->wait($seconds * 1000);
308         } else {
309             sleep($seconds);
310         }
311     }
313     /**
314      * Waits until the page is completely loaded. This step is auto-executed after every step.
315      *
316      * @Given /^I wait until the page is ready$/
317      */
318     public function wait_until_the_page_is_ready() {
320         // No need to wait if not running JS.
321         if (!$this->running_javascript()) {
322             return;
323         }
325         $this->getSession()->wait(self::get_timeout() * 1000, self::PAGE_READY_JS);
326     }
328     /**
329      * Waits until the provided element selector exists in the DOM
330      *
331      * Using the protected method as this method will be usually
332      * called by other methods which are not returning a set of
333      * steps and performs the actions directly, so it would not
334      * be executed if it returns another step.
336      * @Given /^I wait until "(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>[^"]*)" exists$/
337      * @param string $element
338      * @param string $selector
339      * @return void
340      */
341     public function wait_until_exists($element, $selectortype) {
342         $this->ensure_element_exists($element, $selectortype);
343     }
345     /**
346      * Waits until the provided element does not exist in the DOM
347      *
348      * Using the protected method as this method will be usually
349      * called by other methods which are not returning a set of
350      * steps and performs the actions directly, so it would not
351      * be executed if it returns another step.
353      * @Given /^I wait until "(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>[^"]*)" does not exist$/
354      * @param string $element
355      * @param string $selector
356      * @return void
357      */
358     public function wait_until_does_not_exists($element, $selectortype) {
359         $this->ensure_element_does_not_exist($element, $selectortype);
360     }
362     /**
363      * Generic mouse over action. Mouse over a element of the specified type.
364      *
365      * @When /^I hover "(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>[^"]*)"$/
366      * @param string $element Element we look for
367      * @param string $selectortype The type of what we look for
368      */
369     public function i_hover($element, $selectortype) {
371         // Gets the node based on the requested selector type and locator.
372         $node = $this->get_selected_node($selectortype, $element);
373         $node->mouseOver();
374     }
376     /**
377      * Generic click action. Click on the element of the specified type.
378      *
379      * @When /^I click on "(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>[^"]*)"$/
380      * @param string $element Element we look for
381      * @param string $selectortype The type of what we look for
382      */
383     public function i_click_on($element, $selectortype) {
385         // Gets the node based on the requested selector type and locator.
386         $node = $this->get_selected_node($selectortype, $element);
387         $this->ensure_node_is_visible($node);
388         $node->click();
389     }
391     /**
392      * Sets the focus and takes away the focus from an element, generating blur JS event.
393      *
394      * @When /^I take focus off "(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>[^"]*)"$/
395      * @param string $element Element we look for
396      * @param string $selectortype The type of what we look for
397      */
398     public function i_take_focus_off_field($element, $selectortype) {
399         if (!$this->running_javascript()) {
400             throw new ExpectationException('Can\'t take focus off from "' . $element . '" in non-js mode', $this->getSession());
401         }
402         // Gets the node based on the requested selector type and locator.
403         $node = $this->get_selected_node($selectortype, $element);
404         $this->ensure_node_is_visible($node);
406         // Ensure element is focused before taking it off.
407         $node->focus();
408         $node->blur();
409     }
411     /**
412      * Clicks the specified element and confirms the expected dialogue.
413      *
414      * @When /^I click on "(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>[^"]*)" confirming the dialogue$/
415      * @throws ElementNotFoundException Thrown by behat_base::find
416      * @param string $element Element we look for
417      * @param string $selectortype The type of what we look for
418      */
419     public function i_click_on_confirming_the_dialogue($element, $selectortype) {
420         $this->i_click_on($element, $selectortype);
421         $this->accept_currently_displayed_alert_dialog();
422     }
424     /**
425      * Clicks the specified element and dismissing the expected dialogue.
426      *
427      * @When /^I click on "(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>[^"]*)" dismissing the dialogue$/
428      * @throws ElementNotFoundException Thrown by behat_base::find
429      * @param string $element Element we look for
430      * @param string $selectortype The type of what we look for
431      */
432     public function i_click_on_dismissing_the_dialogue($element, $selectortype) {
433         $this->i_click_on($element, $selectortype);
434         $this->dismiss_currently_displayed_alert_dialog();
435     }
437     /**
438      * Click on the element of the specified type which is located inside the second element.
439      *
440      * @When /^I click on "(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>[^"]*)" in the "(?P<element_container_string>(?:[^"]|\\")*)" "(?P<text_selector_string>[^"]*)"$/
441      * @param string $element Element we look for
442      * @param string $selectortype The type of what we look for
443      * @param string $nodeelement Element we look in
444      * @param string $nodeselectortype The type of selector where we look in
445      */
446     public function i_click_on_in_the($element, $selectortype, $nodeelement, $nodeselectortype) {
448         $node = $this->get_node_in_container($selectortype, $element, $nodeselectortype, $nodeelement);
449         $this->ensure_node_is_visible($node);
450         $node->click();
451     }
453     /**
454      * Drags and drops the specified element to the specified container. This step does not work in all the browsers, consider it experimental.
455      *
456      * The steps definitions calling this step as part of them should
457      * manage the wait times by themselves as the times and when the
458      * waits should be done depends on what is being dragged & dropper.
459      *
460      * @Given /^I drag "(?P<element_string>(?:[^"]|\\")*)" "(?P<selector1_string>(?:[^"]|\\")*)" and I drop it in "(?P<container_element_string>(?:[^"]|\\")*)" "(?P<selector2_string>(?:[^"]|\\")*)"$/
461      * @param string $element
462      * @param string $selectortype
463      * @param string $containerelement
464      * @param string $containerselectortype
465      */
466     public function i_drag_and_i_drop_it_in($source, $sourcetype, $target, $targettype) {
467         if (!$this->running_javascript()) {
468             throw new DriverException('Drag and drop steps require javascript');
469         }
471         $source = $this->find($sourcetype, $source);
472         $target = $this->find($targettype, $target);
474         if (!$source->isVisible()) {
475             throw new ExpectationException("'{$source}' '{$sourcetype}' is not visible", $this->getSession());
476         }
477         if (!$target->isVisible()) {
478             throw new ExpectationException("'{$target}' '{$targettype}' is not visible", $this->getSession());
479         }
481         $this->getSession()->getDriver()->dragTo($source->getXpath(), $target->getXpath());
482     }
484     /**
485      * Checks, that the specified element is visible. Only available in tests using Javascript.
486      *
487      * @Then /^"(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>(?:[^"]|\\")*)" should be visible$/
488      * @throws ElementNotFoundException
489      * @throws ExpectationException
490      * @throws DriverException
491      * @param string $element
492      * @param string $selectortype
493      * @return void
494      */
495     public function should_be_visible($element, $selectortype) {
497         if (!$this->running_javascript()) {
498             throw new DriverException('Visible checks are disabled in scenarios without Javascript support');
499         }
501         $node = $this->get_selected_node($selectortype, $element);
502         if (!$node->isVisible()) {
503             throw new ExpectationException('"' . $element . '" "' . $selectortype . '" is not visible', $this->getSession());
504         }
505     }
507     /**
508      * Checks, that the existing element is not visible. Only available in tests using Javascript.
509      *
510      * As a "not" method, it's performance could not be good, but in this
511      * case the performance is good because the element must exist,
512      * otherwise there would be a ElementNotFoundException, also here we are
513      * not spinning until the element is visible.
514      *
515      * @Then /^"(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>(?:[^"]|\\")*)" should not be visible$/
516      * @throws ElementNotFoundException
517      * @throws ExpectationException
518      * @param string $element
519      * @param string $selectortype
520      * @return void
521      */
522     public function should_not_be_visible($element, $selectortype) {
524         try {
525             $this->should_be_visible($element, $selectortype);
526         } catch (ExpectationException $e) {
527             // All as expected.
528             return;
529         }
530         throw new ExpectationException('"' . $element . '" "' . $selectortype . '" is visible', $this->getSession());
531     }
533     /**
534      * Checks, that the specified element is visible inside the specified container. Only available in tests using Javascript.
535      *
536      * @Then /^"(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>[^"]*)" in the "(?P<element_container_string>(?:[^"]|\\")*)" "(?P<text_selector_string>[^"]*)" should be visible$/
537      * @throws ElementNotFoundException
538      * @throws DriverException
539      * @throws ExpectationException
540      * @param string $element Element we look for
541      * @param string $selectortype The type of what we look for
542      * @param string $nodeelement Element we look in
543      * @param string $nodeselectortype The type of selector where we look in
544      */
545     public function in_the_should_be_visible($element, $selectortype, $nodeelement, $nodeselectortype) {
547         if (!$this->running_javascript()) {
548             throw new DriverException('Visible checks are disabled in scenarios without Javascript support');
549         }
551         $node = $this->get_node_in_container($selectortype, $element, $nodeselectortype, $nodeelement);
552         if (!$node->isVisible()) {
553             throw new ExpectationException(
554                 '"' . $element . '" "' . $selectortype . '" in the "' . $nodeelement . '" "' . $nodeselectortype . '" is not visible',
555                 $this->getSession()
556             );
557         }
558     }
560     /**
561      * Checks, that the existing element is not visible inside the existing container. Only available in tests using Javascript.
562      *
563      * As a "not" method, it's performance could not be good, but in this
564      * case the performance is good because the element must exist,
565      * otherwise there would be a ElementNotFoundException, also here we are
566      * not spinning until the element is visible.
567      *
568      * @Then /^"(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>[^"]*)" in the "(?P<element_container_string>(?:[^"]|\\")*)" "(?P<text_selector_string>[^"]*)" should not be visible$/
569      * @throws ElementNotFoundException
570      * @throws ExpectationException
571      * @param string $element Element we look for
572      * @param string $selectortype The type of what we look for
573      * @param string $nodeelement Element we look in
574      * @param string $nodeselectortype The type of selector where we look in
575      */
576     public function in_the_should_not_be_visible($element, $selectortype, $nodeelement, $nodeselectortype) {
578         try {
579             $this->in_the_should_be_visible($element, $selectortype, $nodeelement, $nodeselectortype);
580         } catch (ExpectationException $e) {
581             // All as expected.
582             return;
583         }
584         throw new ExpectationException(
585             '"' . $element . '" "' . $selectortype . '" in the "' . $nodeelement . '" "' . $nodeselectortype . '" is visible',
586             $this->getSession()
587         );
588     }
590     /**
591      * Checks, that page contains specified text. It also checks if the text is visible when running Javascript tests.
592      *
593      * @Then /^I should see "(?P<text_string>(?:[^"]|\\")*)"$/
594      * @throws ExpectationException
595      * @param string $text
596      */
597     public function assert_page_contains_text($text) {
599         // Looking for all the matching nodes without any other descendant matching the
600         // same xpath (we are using contains(., ....).
601         $xpathliteral = behat_context_helper::escape($text);
602         $xpath = "/descendant-or-self::*[contains(., $xpathliteral)]" .
603             "[count(descendant::*[contains(., $xpathliteral)]) = 0]";
605         try {
606             $nodes = $this->find_all('xpath', $xpath);
607         } catch (ElementNotFoundException $e) {
608             throw new ExpectationException('"' . $text . '" text was not found in the page', $this->getSession());
609         }
611         // If we are not running javascript we have enough with the
612         // element existing as we can't check if it is visible.
613         if (!$this->running_javascript()) {
614             return;
615         }
617         // We spin as we don't have enough checking that the element is there, we
618         // should also ensure that the element is visible. Using microsleep as this
619         // is a repeated step and global performance is important.
620         $this->spin(
621             function($context, $args) {
623                 foreach ($args['nodes'] as $node) {
624                     if ($node->isVisible()) {
625                         return true;
626                     }
627                 }
629                 // If non of the nodes is visible we loop again.
630                 throw new ExpectationException('"' . $args['text'] . '" text was found but was not visible', $context->getSession());
631             },
632             array('nodes' => $nodes, 'text' => $text),
633             false,
634             false,
635             true
636         );
638     }
640     /**
641      * Checks, that page doesn't contain specified text. When running Javascript tests it also considers that texts may be hidden.
642      *
643      * @Then /^I should not see "(?P<text_string>(?:[^"]|\\")*)"$/
644      * @throws ExpectationException
645      * @param string $text
646      */
647     public function assert_page_not_contains_text($text) {
649         // Looking for all the matching nodes without any other descendant matching the
650         // same xpath (we are using contains(., ....).
651         $xpathliteral = behat_context_helper::escape($text);
652         $xpath = "/descendant-or-self::*[contains(., $xpathliteral)]" .
653             "[count(descendant::*[contains(., $xpathliteral)]) = 0]";
655         // We should wait a while to ensure that the page is not still loading elements.
656         // Waiting less than self::get_timeout() as we already waited for the DOM to be ready and
657         // all JS to be executed.
658         try {
659             $nodes = $this->find_all('xpath', $xpath, false, false, self::get_reduced_timeout());
660         } catch (ElementNotFoundException $e) {
661             // All ok.
662             return;
663         }
665         // If we are not running javascript we have enough with the
666         // element existing as we can't check if it is hidden.
667         if (!$this->running_javascript()) {
668             throw new ExpectationException('"' . $text . '" text was found in the page', $this->getSession());
669         }
671         // If the element is there we should be sure that it is not visible.
672         $this->spin(
673             function($context, $args) {
675                 foreach ($args['nodes'] as $node) {
676                     // If element is removed from dom, then just exit.
677                     try {
678                         // If element is visible then throw exception, so we keep spinning.
679                         if ($node->isVisible()) {
680                             throw new ExpectationException('"' . $args['text'] . '" text was found in the page',
681                                 $context->getSession());
682                         }
683                     } catch (WebDriver\Exception\NoSuchElement $e) {
684                         // Do nothing just return, as element is no more on page.
685                         return true;
686                     } catch (ElementNotFoundException $e) {
687                         // Do nothing just return, as element is no more on page.
688                         return true;
689                     }
690                 }
692                 // If non of the found nodes is visible we consider that the text is not visible.
693                 return true;
694             },
695             array('nodes' => $nodes, 'text' => $text),
696             behat_base::get_reduced_timeout(),
697             false,
698             true
699         );
700     }
702     /**
703      * Checks, that the specified element contains the specified text. When running Javascript tests it also considers that texts may be hidden.
704      *
705      * @Then /^I should see "(?P<text_string>(?:[^"]|\\")*)" in the "(?P<element_string>(?:[^"]|\\")*)" "(?P<text_selector_string>[^"]*)"$/
706      * @throws ElementNotFoundException
707      * @throws ExpectationException
708      * @param string $text
709      * @param string $element Element we look in.
710      * @param string $selectortype The type of element where we are looking in.
711      */
712     public function assert_element_contains_text($text, $element, $selectortype) {
714         // Getting the container where the text should be found.
715         $container = $this->get_selected_node($selectortype, $element);
717         // Looking for all the matching nodes without any other descendant matching the
718         // same xpath (we are using contains(., ....).
719         $xpathliteral = behat_context_helper::escape($text);
720         $xpath = "/descendant-or-self::*[contains(., $xpathliteral)]" .
721             "[count(descendant::*[contains(., $xpathliteral)]) = 0]";
723         // Wait until it finds the text inside the container, otherwise custom exception.
724         try {
725             $nodes = $this->find_all('xpath', $xpath, false, $container);
726         } catch (ElementNotFoundException $e) {
727             throw new ExpectationException('"' . $text . '" text was not found in the "' . $element . '" element', $this->getSession());
728         }
730         // If we are not running javascript we have enough with the
731         // element existing as we can't check if it is visible.
732         if (!$this->running_javascript()) {
733             return;
734         }
736         // We also check the element visibility when running JS tests. Using microsleep as this
737         // is a repeated step and global performance is important.
738         $this->spin(
739             function($context, $args) {
741                 foreach ($args['nodes'] as $node) {
742                     if ($node->isVisible()) {
743                         return true;
744                     }
745                 }
747                 throw new ExpectationException('"' . $args['text'] . '" text was found in the "' . $args['element'] . '" element but was not visible', $context->getSession());
748             },
749             array('nodes' => $nodes, 'text' => $text, 'element' => $element),
750             false,
751             false,
752             true
753         );
754     }
756     /**
757      * Checks, that the specified element does not contain the specified text. When running Javascript tests it also considers that texts may be hidden.
758      *
759      * @Then /^I should not see "(?P<text_string>(?:[^"]|\\")*)" in the "(?P<element_string>(?:[^"]|\\")*)" "(?P<text_selector_string>[^"]*)"$/
760      * @throws ElementNotFoundException
761      * @throws ExpectationException
762      * @param string $text
763      * @param string $element Element we look in.
764      * @param string $selectortype The type of element where we are looking in.
765      */
766     public function assert_element_not_contains_text($text, $element, $selectortype) {
768         // Getting the container where the text should be found.
769         $container = $this->get_selected_node($selectortype, $element);
771         // Looking for all the matching nodes without any other descendant matching the
772         // same xpath (we are using contains(., ....).
773         $xpathliteral = behat_context_helper::escape($text);
774         $xpath = "/descendant-or-self::*[contains(., $xpathliteral)]" .
775             "[count(descendant::*[contains(., $xpathliteral)]) = 0]";
777         // We should wait a while to ensure that the page is not still loading elements.
778         // Giving preference to the reliability of the results rather than to the performance.
779         try {
780             $nodes = $this->find_all('xpath', $xpath, false, $container, self::get_reduced_timeout());
781         } catch (ElementNotFoundException $e) {
782             // All ok.
783             return;
784         }
786         // If we are not running javascript we have enough with the
787         // element not being found as we can't check if it is visible.
788         if (!$this->running_javascript()) {
789             throw new ExpectationException('"' . $text . '" text was found in the "' . $element . '" element', $this->getSession());
790         }
792         // We need to ensure all the found nodes are hidden.
793         $this->spin(
794             function($context, $args) {
796                 foreach ($args['nodes'] as $node) {
797                     if ($node->isVisible()) {
798                         throw new ExpectationException('"' . $args['text'] . '" text was found in the "' . $args['element'] . '" element', $context->getSession());
799                     }
800                 }
802                 // If all the found nodes are hidden we are happy.
803                 return true;
804             },
805             array('nodes' => $nodes, 'text' => $text, 'element' => $element),
806             behat_base::get_reduced_timeout(),
807             false,
808             true
809         );
810     }
812     /**
813      * Checks, that the first specified element appears before the second one.
814      *
815      * @Then :preelement :preselectortype should appear before :postelement :postselectortype
816      * @Then :preelement :preselectortype should appear before :postelement :postselectortype in the :containerelement :containerselectortype
817      * @throws ExpectationException
818      * @param string $preelement The locator of the preceding element
819      * @param string $preselectortype The selector type of the preceding element
820      * @param string $postelement The locator of the latest element
821      * @param string $postselectortype The selector type of the latest element
822      * @param string $containerelement
823      * @param string $containerselectortype
824      */
825     public function should_appear_before(
826         string $preelement,
827         string $preselectortype,
828         string $postelement,
829         string $postselectortype,
830         ?string $containerelement = null,
831         ?string $containerselectortype = null
832     ) {
833         $msg = "'{$preelement}' '{$preselectortype}' does not appear before '{$postelement}' '{$postselectortype}'";
834         $this->check_element_order(
835             $containerelement,
836             $containerselectortype,
837             $preelement,
838             $preselectortype,
839             $postelement,
840             $postselectortype,
841             $msg
842         );
843     }
845     /**
846      * Checks, that the first specified element appears after the second one.
847      *
848      * @Then :postelement :postselectortype should appear after :preelement :preselectortype
849      * @Then :postelement :postselectortype should appear after :preelement :preselectortype in the :containerelement :containerselectortype
850      * @throws ExpectationException
851      * @param string $postelement The locator of the latest element
852      * @param string $postselectortype The selector type of the latest element
853      * @param string $preelement The locator of the preceding element
854      * @param string $preselectortype The selector type of the preceding element
855      * @param string $containerelement
856      * @param string $containerselectortype
857      */
858     public function should_appear_after(
859         string $postelement,
860         string $postselectortype,
861         string $preelement,
862         string $preselectortype,
863         ?string $containerelement = null,
864         ?string $containerselectortype = null
865     ) {
866         $msg = "'{$postelement}' '{$postselectortype}' does not appear after '{$preelement}' '{$preselectortype}'";
867         $this->check_element_order(
868             $containerelement,
869             $containerselectortype,
870             $preelement,
871             $preselectortype,
872             $postelement,
873             $postselectortype,
874             $msg
875         );
876     }
878     /**
879      * Shared code to check whether an element is before or after another one.
880      *
881      * @param string $containerelement
882      * @param string $containerselectortype
883      * @param string $preelement The locator of the preceding element
884      * @param string $preselectortype The locator of the preceding element
885      * @param string $postelement The locator of the following element
886      * @param string $postselectortype The selector type of the following element
887      * @param string $msg Message to output if this fails
888      */
889     protected function check_element_order(
890         ?string $containerelement,
891         ?string $containerselectortype,
892         string $preelement,
893         string $preselectortype,
894         string $postelement,
895         string $postselectortype,
896         string $msg
897     ) {
898         $containernode = false;
899         if ($containerselectortype && $containerelement) {
900             // Get the container node.
901             $containernode = $this->get_selected_node($containerselectortype, $containerelement);
902             $msg .= " in the '{$containerelement}' '{$containerselectortype}'";
903         }
905         list($preselector, $prelocator) = $this->transform_selector($preselectortype, $preelement);
906         list($postselector, $postlocator) = $this->transform_selector($postselectortype, $postelement);
908         $newlines = [
909             "\r\n",
910             "\r",
911             "\n",
912         ];
913         $prexpath = str_replace($newlines, ' ', $this->find($preselector, $prelocator, false, $containernode)->getXpath());
914         $postxpath = str_replace($newlines, ' ', $this->find($postselector, $postlocator, false, $containernode)->getXpath());
916         if ($this->running_javascript()) {
917             // The xpath to do this was running really slowly on certain Chrome versions so we are using
918             // this DOM method instead.
919             $js = <<<EOF
920 (function() {
921     var a = document.evaluate("{$prexpath}", document, null, XPathResult.ANY_TYPE, null).iterateNext();
922     var b = document.evaluate("{$postxpath}", document, null, XPathResult.ANY_TYPE, null).iterateNext();
923     return a.compareDocumentPosition(b) & Node.DOCUMENT_POSITION_FOLLOWING;
924 })()
925 EOF;
926             $ok = $this->evaluate_script($js);
927         } else {
929             // Using following xpath axe to find it.
930             $xpath = "{$prexpath}/following::*[contains(., {$postxpath})]";
931             $ok = $this->getSession()->getDriver()->find($xpath);
932         }
934         if (!$ok) {
935             throw new ExpectationException($msg, $this->getSession());
936         }
937     }
939     /**
940      * Checks, that element of specified type is disabled.
941      *
942      * @Then /^the "(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>[^"]*)" should be disabled$/
943      * @throws ExpectationException Thrown by behat_base::find
944      * @param string $element Element we look in
945      * @param string $selectortype The type of element where we are looking in.
946      */
947     public function the_element_should_be_disabled($element, $selectortype) {
948         $this->the_attribute_of_should_be_set("disabled", $element, $selectortype, false);
949     }
951     /**
952      * Checks, that element of specified type is enabled.
953      *
954      * @Then /^the "(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>[^"]*)" should be enabled$/
955      * @throws ExpectationException Thrown by behat_base::find
956      * @param string $element Element we look on
957      * @param string $selectortype The type of where we look
958      */
959     public function the_element_should_be_enabled($element, $selectortype) {
960         $this->the_attribute_of_should_be_set("disabled", $element, $selectortype, true);
961     }
963     /**
964      * Checks the provided element and selector type are readonly on the current page.
965      *
966      * @Then /^the "(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>[^"]*)" should be readonly$/
967      * @throws ExpectationException Thrown by behat_base::find
968      * @param string $element Element we look in
969      * @param string $selectortype The type of element where we are looking in.
970      */
971     public function the_element_should_be_readonly($element, $selectortype) {
972         $this->the_attribute_of_should_be_set("readonly", $element, $selectortype, false);
973     }
975     /**
976      * Checks the provided element and selector type are not readonly on the current page.
977      *
978      * @Then /^the "(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>[^"]*)" should not be readonly$/
979      * @throws ExpectationException Thrown by behat_base::find
980      * @param string $element Element we look in
981      * @param string $selectortype The type of element where we are looking in.
982      */
983     public function the_element_should_not_be_readonly($element, $selectortype) {
984         $this->the_attribute_of_should_be_set("readonly", $element, $selectortype, true);
985     }
987     /**
988      * Checks the provided element and selector type exists in the current page.
989      *
990      * This step is for advanced users, use it if you don't find anything else suitable for what you need.
991      *
992      * @Then /^"(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>[^"]*)" should exist$/
993      * @throws ElementNotFoundException Thrown by behat_base::find
994      * @param string $element The locator of the specified selector
995      * @param string $selectortype The selector type
996      */
997     public function should_exist($element, $selectortype) {
998         // Will throw an ElementNotFoundException if it does not exist.
999         $this->find($selectortype, $element);
1000     }
1002     /**
1003      * Checks that the provided element and selector type not exists in the current page.
1004      *
1005      * This step is for advanced users, use it if you don't find anything else suitable for what you need.
1006      *
1007      * @Then /^"(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>[^"]*)" should not exist$/
1008      * @throws ExpectationException
1009      * @param string $element The locator of the specified selector
1010      * @param string $selectortype The selector type
1011      */
1012     public function should_not_exist($element, $selectortype) {
1013         // Will throw an ElementNotFoundException if it does not exist, but, actually it should not exist, so we try &
1014         // catch it.
1015         try {
1016             // The exception does not really matter as we will catch it and will never "explode".
1017             $exception = new ElementNotFoundException($this->getSession(), $selectortype, null, $element);
1019             // Using the spin method as we want a reduced timeout but there is no need for a 0.1 seconds interval
1020             // because in the optimistic case we will timeout.
1021             // If all goes good it will throw an ElementNotFoundExceptionn that we will catch.
1022             return $this->find($selectortype, $element, $exception, false, behat_base::get_reduced_timeout());
1023         } catch (ElementNotFoundException $e) {
1024             // We expect the element to not be found.
1025             return;
1026         }
1028         // The element was found and should not have been. Throw an exception.
1029         throw new ExpectationException("The '{$element}' '{$selectortype}' exists in the current page", $this->getSession());
1030     }
1032     /**
1033      * This step triggers cron like a user would do going to admin/cron.php.
1034      *
1035      * @Given /^I trigger cron$/
1036      */
1037     public function i_trigger_cron() {
1038         $this->execute('behat_general::i_visit', ['/admin/cron.php']);
1039     }
1041     /**
1042      * Runs a scheduled task immediately, given full class name.
1043      *
1044      * This is faster and more reliable than running cron (running cron won't
1045      * work more than once in the same test, for instance). However it is
1046      * a little less 'realistic'.
1047      *
1048      * While the task is running, we suppress mtrace output because it makes
1049      * the Behat result look ugly.
1050      *
1051      * Note: Most of the code relating to running a task is based on
1052      * admin/tool/task/cli/schedule_task.php.
1053      *
1054      * @Given /^I run the scheduled task "(?P<task_name>[^"]+)"$/
1055      * @param string $taskname Name of task e.g. 'mod_whatever\task\do_something'
1056      */
1057     public function i_run_the_scheduled_task($taskname) {
1058         global $CFG;
1059         require_once("{$CFG->libdir}/cronlib.php");
1061         $task = \core\task\manager::get_scheduled_task($taskname);
1062         if (!$task) {
1063             throw new DriverException('The "' . $taskname . '" scheduled task does not exist');
1064         }
1066         // Do setup for cron task.
1067         raise_memory_limit(MEMORY_EXTRA);
1068         cron_setup_user();
1070         // Get lock.
1071         $cronlockfactory = \core\lock\lock_config::get_lock_factory('cron');
1072         if (!$cronlock = $cronlockfactory->get_lock('core_cron', 10)) {
1073             throw new DriverException('Unable to obtain core_cron lock for scheduled task');
1074         }
1075         if (!$lock = $cronlockfactory->get_lock('\\' . get_class($task), 10)) {
1076             $cronlock->release();
1077             throw new DriverException('Unable to obtain task lock for scheduled task');
1078         }
1079         $task->set_lock($lock);
1080         if (!$task->is_blocking()) {
1081             $cronlock->release();
1082         } else {
1083             $task->set_cron_lock($cronlock);
1084         }
1086         try {
1087             // Prepare the renderer.
1088             cron_prepare_core_renderer();
1090             // Discard task output as not appropriate for Behat output!
1091             ob_start();
1092             $task->execute();
1093             ob_end_clean();
1095             // Restore the previous renderer.
1096             cron_prepare_core_renderer(true);
1098             // Mark task complete.
1099             \core\task\manager::scheduled_task_complete($task);
1100         } catch (Exception $e) {
1101             // Restore the previous renderer.
1102             cron_prepare_core_renderer(true);
1104             // Mark task failed and throw exception.
1105             \core\task\manager::scheduled_task_failed($task);
1107             throw new DriverException('The "' . $taskname . '" scheduled task failed', 0, $e);
1108         }
1109     }
1111     /**
1112      * Runs all ad-hoc tasks in the queue.
1113      *
1114      * This is faster and more reliable than running cron (running cron won't
1115      * work more than once in the same test, for instance). However it is
1116      * a little less 'realistic'.
1117      *
1118      * While the task is running, we suppress mtrace output because it makes
1119      * the Behat result look ugly.
1120      *
1121      * @Given /^I run all adhoc tasks$/
1122      * @throws DriverException
1123      */
1124     public function i_run_all_adhoc_tasks() {
1125         global $CFG, $DB;
1126         require_once("{$CFG->libdir}/cronlib.php");
1128         // Do setup for cron task.
1129         cron_setup_user();
1131         // Discard task output as not appropriate for Behat output!
1132         ob_start();
1134         // Run all tasks which have a scheduled runtime of before now.
1135         $timenow = time();
1137         while (!\core\task\manager::static_caches_cleared_since($timenow) &&
1138                 $task = \core\task\manager::get_next_adhoc_task($timenow)) {
1139             // Clean the output buffer between tasks.
1140             ob_clean();
1142             // Run the task.
1143             cron_run_inner_adhoc_task($task);
1145             // Check whether the task record still exists.
1146             // If a task was successful it will be removed.
1147             // If it failed then it will still exist.
1148             if ($DB->record_exists('task_adhoc', ['id' => $task->get_id()])) {
1149                 // End ouptut buffering and flush the current buffer.
1150                 // This should be from just the current task.
1151                 ob_end_flush();
1153                 throw new DriverException('An adhoc task failed', 0);
1154             }
1155         }
1156         ob_end_clean();
1157     }
1159     /**
1160      * Checks that an element and selector type exists in another element and selector type on the current page.
1161      *
1162      * This step is for advanced users, use it if you don't find anything else suitable for what you need.
1163      *
1164      * @Then /^"(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>[^"]*)" should exist in the "(?P<element2_string>(?:[^"]|\\")*)" "(?P<selector2_string>[^"]*)"$/
1165      * @throws ElementNotFoundException Thrown by behat_base::find
1166      * @param string $element The locator of the specified selector
1167      * @param string $selectortype The selector type
1168      * @param string $containerelement The container selector type
1169      * @param string $containerselectortype The container locator
1170      */
1171     public function should_exist_in_the($element, $selectortype, $containerelement, $containerselectortype) {
1172         // Get the container node.
1173         $containernode = $this->find($containerselectortype, $containerelement);
1175         // Specific exception giving info about where can't we find the element.
1176         $locatorexceptionmsg = "{$element} in the {$containerelement} {$containerselectortype}";
1177         $exception = new ElementNotFoundException($this->getSession(), $selectortype, null, $locatorexceptionmsg);
1179         // Looks for the requested node inside the container node.
1180         $this->find($selectortype, $element, $exception, $containernode);
1181     }
1183     /**
1184      * Checks that an element and selector type does not exist in another element and selector type on the current page.
1185      *
1186      * This step is for advanced users, use it if you don't find anything else suitable for what you need.
1187      *
1188      * @Then /^"(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>[^"]*)" should not exist in the "(?P<element2_string>(?:[^"]|\\")*)" "(?P<selector2_string>[^"]*)"$/
1189      * @throws ExpectationException
1190      * @param string $element The locator of the specified selector
1191      * @param string $selectortype The selector type
1192      * @param string $containerelement The container selector type
1193      * @param string $containerselectortype The container locator
1194      */
1195     public function should_not_exist_in_the($element, $selectortype, $containerelement, $containerselectortype) {
1196         // Get the container node.
1197         $containernode = $this->find($containerselectortype, $containerelement);
1199         // Will throw an ElementNotFoundException if it does not exist, but, actually it should not exist, so we try &
1200         // catch it.
1201         try {
1202             // Looks for the requested node inside the container node.
1203             $this->find($selectortype, $element, false, $containernode, behat_base::get_reduced_timeout());
1204         } catch (ElementNotFoundException $e) {
1205             // We expect the element to not be found.
1206             return;
1207         }
1209         // The element was found and should not have been. Throw an exception.
1210         throw new ExpectationException(
1211             "The '{$element}' '{$selectortype}' exists in the '{$containerelement}' '{$containerselectortype}'",
1212             $this->getSession()
1213         );
1214     }
1216     /**
1217      * Change browser window size small: 640x480, medium: 1024x768, large: 2560x1600, custom: widthxheight
1218      *
1219      * Example: I change window size to "small" or I change window size to "1024x768"
1220      * or I change viewport size to "800x600". The viewport option is useful to guarantee that the
1221      * browser window has same viewport size even when you run Behat on multiple operating systems.
1222      *
1223      * @throws ExpectationException
1224      * @Then /^I change (window|viewport) size to "(small|medium|large|\d+x\d+)"$/
1225      * @Then /^I change the (window|viewport) size to "(small|medium|large|\d+x\d+)"$/
1226      * @param string $windowsize size of the window (small|medium|large|wxh).
1227      */
1228     public function i_change_window_size_to($windowviewport, $windowsize) {
1229         $this->resize_window($windowsize, $windowviewport === 'viewport');
1230     }
1232     /**
1233      * Checks whether there the specified attribute is set or not.
1234      *
1235      * @Then the :attribute attribute of :element :selectortype should be set
1236      * @Then the :attribute attribute of :element :selectortype should :not be set
1237      *
1238      * @throws ExpectationException
1239      * @param string $attribute Name of attribute
1240      * @param string $element The locator of the specified selector
1241      * @param string $selectortype The selector type
1242      * @param string $not
1243      */
1244     public function the_attribute_of_should_be_set($attribute, $element, $selectortype, $not = null) {
1245         // Get the container node (exception if it doesn't exist).
1246         $containernode = $this->get_selected_node($selectortype, $element);
1247         $hasattribute = $containernode->hasAttribute($attribute);
1249         if ($not && $hasattribute) {
1250             $value = $containernode->getAttribute($attribute);
1251             // Should not be set but is.
1252             throw new ExpectationException(
1253                 "The attribute \"{$attribute}\" should not be set but has a value of '{$value}'",
1254                 $this->getSession()
1255             );
1256         } else if (!$not && !$hasattribute) {
1257             // Should be set but is not.
1258             throw new ExpectationException(
1259                 "The attribute \"{$attribute}\" should be set but is not",
1260                 $this->getSession()
1261             );
1262         }
1263     }
1265     /**
1266      * Checks whether there is an attribute on the given element that contains the specified text.
1267      *
1268      * @Then /^the "(?P<attribute_string>[^"]*)" attribute of "(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>[^"]*)" should contain "(?P<text_string>(?:[^"]|\\")*)"$/
1269      * @throws ExpectationException
1270      * @param string $attribute Name of attribute
1271      * @param string $element The locator of the specified selector
1272      * @param string $selectortype The selector type
1273      * @param string $text Expected substring
1274      */
1275     public function the_attribute_of_should_contain($attribute, $element, $selectortype, $text) {
1276         // Get the container node (exception if it doesn't exist).
1277         $containernode = $this->get_selected_node($selectortype, $element);
1278         $value = $containernode->getAttribute($attribute);
1279         if ($value == null) {
1280             throw new ExpectationException('The attribute "' . $attribute. '" does not exist',
1281                     $this->getSession());
1282         } else if (strpos($value, $text) === false) {
1283             throw new ExpectationException('The attribute "' . $attribute .
1284                     '" does not contain "' . $text . '" (actual value: "' . $value . '")',
1285                     $this->getSession());
1286         }
1287     }
1289     /**
1290      * Checks that the attribute on the given element does not contain the specified text.
1291      *
1292      * @Then /^the "(?P<attribute_string>[^"]*)" attribute of "(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>[^"]*)" should not contain "(?P<text_string>(?:[^"]|\\")*)"$/
1293      * @throws ExpectationException
1294      * @param string $attribute Name of attribute
1295      * @param string $element The locator of the specified selector
1296      * @param string $selectortype The selector type
1297      * @param string $text Expected substring
1298      */
1299     public function the_attribute_of_should_not_contain($attribute, $element, $selectortype, $text) {
1300         // Get the container node (exception if it doesn't exist).
1301         $containernode = $this->get_selected_node($selectortype, $element);
1302         $value = $containernode->getAttribute($attribute);
1303         if ($value == null) {
1304             throw new ExpectationException('The attribute "' . $attribute. '" does not exist',
1305                     $this->getSession());
1306         } else if (strpos($value, $text) !== false) {
1307             throw new ExpectationException('The attribute "' . $attribute .
1308                     '" contains "' . $text . '" (value: "' . $value . '")',
1309                     $this->getSession());
1310         }
1311     }
1313     /**
1314      * Checks the provided value exists in specific row/column of table.
1315      *
1316      * @Then /^"(?P<row_string>[^"]*)" row "(?P<column_string>[^"]*)" column of "(?P<table_string>[^"]*)" table should contain "(?P<value_string>[^"]*)"$/
1317      * @throws ElementNotFoundException
1318      * @param string $row row text which will be looked in.
1319      * @param string $column column text to search (or numeric value for the column position)
1320      * @param string $table table id/class/caption
1321      * @param string $value text to check.
1322      */
1323     public function row_column_of_table_should_contain($row, $column, $table, $value) {
1324         $tablenode = $this->get_selected_node('table', $table);
1325         $tablexpath = $tablenode->getXpath();
1327         $rowliteral = behat_context_helper::escape($row);
1328         $valueliteral = behat_context_helper::escape($value);
1329         $columnliteral = behat_context_helper::escape($column);
1331         if (preg_match('/^-?(\d+)-?$/', $column, $columnasnumber)) {
1332             // Column indicated as a number, just use it as position of the column.
1333             $columnpositionxpath = "/child::*[position() = {$columnasnumber[1]}]";
1334         } else {
1335             // Header can be in thead or tbody (first row), following xpath should work.
1336             $theadheaderxpath = "thead/tr[1]/th[(normalize-space(.)=" . $columnliteral . " or a[normalize-space(text())=" .
1337                     $columnliteral . "] or div[normalize-space(text())=" . $columnliteral . "])]";
1338             $tbodyheaderxpath = "tbody/tr[1]/td[(normalize-space(.)=" . $columnliteral . " or a[normalize-space(text())=" .
1339                     $columnliteral . "] or div[normalize-space(text())=" . $columnliteral . "])]";
1341             // Check if column exists.
1342             $columnheaderxpath = $tablexpath . "[" . $theadheaderxpath . " | " . $tbodyheaderxpath . "]";
1343             $columnheader = $this->getSession()->getDriver()->find($columnheaderxpath);
1344             if (empty($columnheader)) {
1345                 $columnexceptionmsg = $column . '" in table "' . $table . '"';
1346                 throw new ElementNotFoundException($this->getSession(), "\n$columnheaderxpath\n\n".'Column', null, $columnexceptionmsg);
1347             }
1348             // Following conditions were considered before finding column count.
1349             // 1. Table header can be in thead/tr/th or tbody/tr/td[1].
1350             // 2. First column can have th (Gradebook -> user report), so having lenient sibling check.
1351             $columnpositionxpath = "/child::*[position() = count(" . $tablexpath . "/" . $theadheaderxpath .
1352                 "/preceding-sibling::*) + 1]";
1353         }
1355         // Check if value exists in specific row/column.
1356         // Get row xpath.
1357         // GoutteDriver uses DomCrawler\Crawler and it is making XPath relative to the current context, so use descendant.
1358         $rowxpath = $tablexpath."/tbody/tr[descendant::th[normalize-space(.)=" . $rowliteral .
1359                     "] | descendant::td[normalize-space(.)=" . $rowliteral . "]]";
1361         $columnvaluexpath = $rowxpath . $columnpositionxpath . "[contains(normalize-space(.)," . $valueliteral . ")]";
1363         // Looks for the requested node inside the container node.
1364         $coumnnode = $this->getSession()->getDriver()->find($columnvaluexpath);
1365         if (empty($coumnnode)) {
1366             $locatorexceptionmsg = $value . '" in "' . $row . '" row with column "' . $column;
1367             throw new ElementNotFoundException($this->getSession(), "\n$columnvaluexpath\n\n".'Column value', null, $locatorexceptionmsg);
1368         }
1369     }
1371     /**
1372      * Checks the provided value should not exist in specific row/column of table.
1373      *
1374      * @Then /^"(?P<row_string>[^"]*)" row "(?P<column_string>[^"]*)" column of "(?P<table_string>[^"]*)" table should not contain "(?P<value_string>[^"]*)"$/
1375      * @throws ElementNotFoundException
1376      * @param string $row row text which will be looked in.
1377      * @param string $column column text to search
1378      * @param string $table table id/class/caption
1379      * @param string $value text to check.
1380      */
1381     public function row_column_of_table_should_not_contain($row, $column, $table, $value) {
1382         try {
1383             $this->row_column_of_table_should_contain($row, $column, $table, $value);
1384         } catch (ElementNotFoundException $e) {
1385             // Table row/column doesn't contain this value. Nothing to do.
1386             return;
1387         }
1388         // Throw exception if found.
1389         throw new ExpectationException(
1390             '"' . $column . '" with value "' . $value . '" is present in "' . $row . '"  row for table "' . $table . '"',
1391             $this->getSession()
1392         );
1393     }
1395     /**
1396      * Checks that the provided value exist in table.
1397      *
1398      * First row may contain column headers or numeric indexes of the columns
1399      * (syntax -1- is also considered to be column index). Column indexes are
1400      * useful in case of multirow headers and/or presence of cells with colspan.
1401      *
1402      * @Then /^the following should exist in the "(?P<table_string>[^"]*)" table:$/
1403      * @throws ExpectationException
1404      * @param string $table name of table
1405      * @param TableNode $data table with first row as header and following values
1406      *        | Header 1 | Header 2 | Header 3 |
1407      *        | Value 1 | Value 2 | Value 3|
1408      */
1409     public function following_should_exist_in_the_table($table, TableNode $data) {
1410         $datahash = $data->getHash();
1412         foreach ($datahash as $row) {
1413             $firstcell = null;
1414             foreach ($row as $column => $value) {
1415                 if ($firstcell === null) {
1416                     $firstcell = $value;
1417                 } else {
1418                     $this->row_column_of_table_should_contain($firstcell, $column, $table, $value);
1419                 }
1420             }
1421         }
1422     }
1424     /**
1425      * Checks that the provided values do not exist in a table.
1426      *
1427      * @Then /^the following should not exist in the "(?P<table_string>[^"]*)" table:$/
1428      * @throws ExpectationException
1429      * @param string $table name of table
1430      * @param TableNode $data table with first row as header and following values
1431      *        | Header 1 | Header 2 | Header 3 |
1432      *        | Value 1 | Value 2 | Value 3|
1433      */
1434     public function following_should_not_exist_in_the_table($table, TableNode $data) {
1435         $datahash = $data->getHash();
1437         foreach ($datahash as $value) {
1438             $row = array_shift($value);
1439             foreach ($value as $column => $value) {
1440                 try {
1441                     $this->row_column_of_table_should_contain($row, $column, $table, $value);
1442                     // Throw exception if found.
1443                 } catch (ElementNotFoundException $e) {
1444                     // Table row/column doesn't contain this value. Nothing to do.
1445                     continue;
1446                 }
1447                 throw new ExpectationException('"' . $column . '" with value "' . $value . '" is present in "' .
1448                     $row . '"  row for table "' . $table . '"', $this->getSession()
1449                 );
1450             }
1451         }
1452     }
1454     /**
1455      * Given the text of a link, download the linked file and return the contents.
1456      *
1457      * This is a helper method used by {@link following_should_download_bytes()}
1458      * and {@link following_should_download_between_and_bytes()}
1459      *
1460      * @param string $link the text of the link.
1461      * @return string the content of the downloaded file.
1462      */
1463     public function download_file_from_link($link) {
1464         // Find the link.
1465         $linknode = $this->find_link($link);
1466         $this->ensure_node_is_visible($linknode);
1468         // Get the href and check it.
1469         $url = $linknode->getAttribute('href');
1470         if (!$url) {
1471             throw new ExpectationException('Download link does not have href attribute',
1472                     $this->getSession());
1473         }
1474         if (!preg_match('~^https?://~', $url)) {
1475             throw new ExpectationException('Download link not an absolute URL: ' . $url,
1476                     $this->getSession());
1477         }
1479         // Download the URL and check the size.
1480         $session = $this->getSession()->getCookie('MoodleSession');
1481         return download_file_content($url, array('Cookie' => 'MoodleSession=' . $session));
1482     }
1484     /**
1485      * Downloads the file from a link on the page and checks the size.
1486      *
1487      * Only works if the link has an href attribute. Javascript downloads are
1488      * not supported. Currently, the href must be an absolute URL.
1489      *
1490      * @Then /^following "(?P<link_string>[^"]*)" should download "(?P<expected_bytes>\d+)" bytes$/
1491      * @throws ExpectationException
1492      * @param string $link the text of the link.
1493      * @param number $expectedsize the expected file size in bytes.
1494      */
1495     public function following_should_download_bytes($link, $expectedsize) {
1496         $exception = new ExpectationException('Error while downloading data from ' . $link, $this->getSession());
1498         // It will stop spinning once file is downloaded or time out.
1499         $result = $this->spin(
1500             function($context, $args) {
1501                 $link = $args['link'];
1502                 return $this->download_file_from_link($link);
1503             },
1504             array('link' => $link),
1505             behat_base::get_extended_timeout(),
1506             $exception
1507         );
1509         // Check download size.
1510         $actualsize = (int)strlen($result);
1511         if ($actualsize !== (int)$expectedsize) {
1512             throw new ExpectationException('Downloaded data was ' . $actualsize .
1513                     ' bytes, expecting ' . $expectedsize, $this->getSession());
1514         }
1515     }
1517     /**
1518      * Downloads the file from a link on the page and checks the size is in a given range.
1519      *
1520      * Only works if the link has an href attribute. Javascript downloads are
1521      * not supported. Currently, the href must be an absolute URL.
1522      *
1523      * The range includes the endpoints. That is, a 10 byte file in considered to
1524      * be between "5" and "10" bytes, and between "10" and "20" bytes.
1525      *
1526      * @Then /^following "(?P<link_string>[^"]*)" should download between "(?P<min_bytes>\d+)" and "(?P<max_bytes>\d+)" bytes$/
1527      * @throws ExpectationException
1528      * @param string $link the text of the link.
1529      * @param number $minexpectedsize the minimum expected file size in bytes.
1530      * @param number $maxexpectedsize the maximum expected file size in bytes.
1531      */
1532     public function following_should_download_between_and_bytes($link, $minexpectedsize, $maxexpectedsize) {
1533         // If the minimum is greater than the maximum then swap the values.
1534         if ((int)$minexpectedsize > (int)$maxexpectedsize) {
1535             list($minexpectedsize, $maxexpectedsize) = array($maxexpectedsize, $minexpectedsize);
1536         }
1538         $exception = new ExpectationException('Error while downloading data from ' . $link, $this->getSession());
1540         // It will stop spinning once file is downloaded or time out.
1541         $result = $this->spin(
1542             function($context, $args) {
1543                 $link = $args['link'];
1545                 return $this->download_file_from_link($link);
1546             },
1547             array('link' => $link),
1548             behat_base::get_extended_timeout(),
1549             $exception
1550         );
1552         // Check download size.
1553         $actualsize = (int)strlen($result);
1554         if ($actualsize < $minexpectedsize || $actualsize > $maxexpectedsize) {
1555             throw new ExpectationException('Downloaded data was ' . $actualsize .
1556                     ' bytes, expecting between ' . $minexpectedsize . ' and ' .
1557                     $maxexpectedsize, $this->getSession());
1558         }
1559     }
1561     /**
1562      * Checks that the image on the page is the same as one of the fixture files
1563      *
1564      * @Then /^the image at "(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>[^"]*)" should be identical to "(?P<filepath_string>(?:[^"]|\\")*)"$/
1565      * @throws ExpectationException
1566      * @param string $element The locator of the image
1567      * @param string $selectortype The selector type
1568      * @param string $filepath path to the fixture file
1569      */
1570     public function the_image_at_should_be_identical_to($element, $selectortype, $filepath) {
1571         global $CFG;
1573         // Get the container node (exception if it doesn't exist).
1574         $containernode = $this->get_selected_node($selectortype, $element);
1575         $url = $containernode->getAttribute('src');
1576         if ($url == null) {
1577             throw new ExpectationException('Element does not have src attribute',
1578                 $this->getSession());
1579         }
1580         $session = $this->getSession()->getCookie('MoodleSession');
1581         $content = download_file_content($url, array('Cookie' => 'MoodleSession=' . $session));
1583         // Get the content of the fixture file.
1584         // Replace 'admin/' if it is in start of path with $CFG->admin .
1585         if (substr($filepath, 0, 6) === 'admin/') {
1586             $filepath = $CFG->admin . DIRECTORY_SEPARATOR . substr($filepath, 6);
1587         }
1588         $filepath = str_replace('/', DIRECTORY_SEPARATOR, $filepath);
1589         $filepath = $CFG->dirroot . DIRECTORY_SEPARATOR . $filepath;
1590         if (!is_readable($filepath)) {
1591             throw new ExpectationException('The file to compare to does not exist.', $this->getSession());
1592         }
1593         $expectedcontent = file_get_contents($filepath);
1595         if ($content !== $expectedcontent) {
1596             throw new ExpectationException('Image is not identical to the fixture. Received ' .
1597             strlen($content) . ' bytes and expected ' . strlen($expectedcontent) . ' bytes');
1598         }
1599     }
1601     /**
1602      * Prepare to detect whether or not a new page has loaded (or the same page reloaded) some time in the future.
1603      *
1604      * @Given /^I start watching to see if a new page loads$/
1605      */
1606     public function i_start_watching_to_see_if_a_new_page_loads() {
1607         if (!$this->running_javascript()) {
1608             throw new DriverException('Page load detection requires JavaScript.');
1609         }
1611         $session = $this->getSession();
1613         if ($this->pageloaddetectionrunning || $session->getPage()->find('xpath', $this->get_page_load_xpath())) {
1614             // If we find this node at this point we are already watching for a reload and the behat steps
1615             // are out of order. We will treat this as an error - really it needs to be fixed as it indicates a problem.
1616             throw new ExpectationException(
1617                 'Page load expectation error: page reloads are already been watched for.', $session);
1618         }
1620         $this->pageloaddetectionrunning = true;
1622         $this->execute_script(
1623             'var span = document.createElement("span");
1624             span.setAttribute("data-rel", "' . self::PAGE_LOAD_DETECTION_STRING . '");
1625             span.setAttribute("style", "display: none;");
1626             document.body.appendChild(span);'
1627         );
1628     }
1630     /**
1631      * Verify that a new page has loaded (or the same page has reloaded) since the
1632      * last "I start watching to see if a new page loads" step.
1633      *
1634      * @Given /^a new page should have loaded since I started watching$/
1635      */
1636     public function a_new_page_should_have_loaded_since_i_started_watching() {
1637         $session = $this->getSession();
1639         // Make sure page load tracking was started.
1640         if (!$this->pageloaddetectionrunning) {
1641             throw new ExpectationException(
1642                 'Page load expectation error: page load tracking was not started.', $session);
1643         }
1645         // As the node is inserted by code above it is either there or not, and we do not need spin and it is safe
1646         // to use the native API here which is great as exception handling (the alternative is slow).
1647         if ($session->getPage()->find('xpath', $this->get_page_load_xpath())) {
1648             // We don't want to find this node, if we do we have an error.
1649             throw new ExpectationException(
1650                 'Page load expectation error: a new page has not been loaded when it should have been.', $session);
1651         }
1653         // Cancel the tracking of pageloaddetectionrunning.
1654         $this->pageloaddetectionrunning = false;
1655     }
1657     /**
1658      * Verify that a new page has not loaded (or the same page has reloaded) since the
1659      * last "I start watching to see if a new page loads" step.
1660      *
1661      * @Given /^a new page should not have loaded since I started watching$/
1662      */
1663     public function a_new_page_should_not_have_loaded_since_i_started_watching() {
1664         $session = $this->getSession();
1666         // Make sure page load tracking was started.
1667         if (!$this->pageloaddetectionrunning) {
1668             throw new ExpectationException(
1669                 'Page load expectation error: page load tracking was not started.', $session);
1670         }
1672         // We use our API here as we can use the exception handling provided by it.
1673         $this->find(
1674             'xpath',
1675             $this->get_page_load_xpath(),
1676             new ExpectationException(
1677                 'Page load expectation error: A new page has been loaded when it should not have been.',
1678                 $this->getSession()
1679             )
1680         );
1681     }
1683     /**
1684      * Helper used by {@link a_new_page_should_have_loaded_since_i_started_watching}
1685      * and {@link a_new_page_should_not_have_loaded_since_i_started_watching}
1686      * @return string xpath expression.
1687      */
1688     protected function get_page_load_xpath() {
1689         return "//span[@data-rel = '" . self::PAGE_LOAD_DETECTION_STRING . "']";
1690     }
1692     /**
1693      * Wait unit user press Enter/Return key. Useful when debugging a scenario.
1694      *
1695      * @Then /^(?:|I )pause(?:| scenario execution)$/
1696      */
1697     public function i_pause_scenario_execution() {
1698         $message = "<colour:lightYellow>Paused. Press <colour:lightRed>Enter/Return<colour:lightYellow> to continue.";
1699         behat_util::pause($this->getSession(), $message);
1700     }
1702     /**
1703      * Presses a given button in the browser.
1704      * NOTE: Phantomjs and goutte driver reloads page while navigating back and forward.
1705      *
1706      * @Then /^I press the "(back|forward|reload)" button in the browser$/
1707      * @param string $button the button to press.
1708      * @throws ExpectationException
1709      */
1710     public function i_press_in_the_browser($button) {
1711         $session = $this->getSession();
1713         if ($button == 'back') {
1714             $session->back();
1715         } else if ($button == 'forward') {
1716             $session->forward();
1717         } else if ($button == 'reload') {
1718             $session->reload();
1719         } else {
1720             throw new ExpectationException('Unknown browser button.', $session);
1721         }
1722     }
1724     /**
1725      * Send key presses to the browser without first changing focusing, or applying the key presses to a specific
1726      * element.
1727      *
1728      * Example usage of this step:
1729      *     When I type "Penguin"
1730      *
1731      * @When    I type :keys
1732      * @param   string $keys The key, or list of keys, to type
1733      */
1734     public function i_type(string $keys): void {
1735         behat_base::type_keys($this->getSession(), str_split($keys));
1736     }
1738     /**
1739      * Press a named key with an optional set of modifiers.
1740      *
1741      * Supported named keys are:
1742      * - up
1743      * - down
1744      * - left
1745      * - right
1746      * - pageup|page_up
1747      * - pagedown|page_down
1748      * - home
1749      * - end
1750      * - insert
1751      * - delete
1752      * - backspace
1753      * - escape
1754      * - enter
1755      * - tab
1756      *
1757      * Supported moderators are:
1758      * - shift
1759      * - ctrl
1760      * - alt
1761      * - meta
1762      *
1763      * Example usage of this new step:
1764      *     When I press the up key
1765      *     When I press the space key
1766      *     When I press the shift tab key
1767      *
1768      * Multiple moderator keys can be combined using the '+' operator, for example:
1769      *     When I press the ctrl+shift enter key
1770      *     When I press the ctrl + shift enter key
1771      *
1772      * @When    /^I press the (?P<modifiers_string>.* )?(?P<key_string>.*) key$/
1773      * @param   string $modifiers A list of keyboard modifiers, separated by the `+` character
1774      * @param   string $key The name of the key to press
1775      */
1776     public function i_press_named_key(string $modifiers, string $key): void {
1777         behat_base::require_javascript_in_session($this->getSession());
1779         $keys = [];
1781         foreach (explode('+', $modifiers) as $modifier) {
1782             switch (strtoupper(trim($modifier))) {
1783                 case '':
1784                     break;
1785                 case 'SHIFT':
1786                     $keys[] = behat_keys::SHIFT;
1787                     break;
1788                 case 'CTRL':
1789                     $keys[] = behat_keys::CONTROL;
1790                     break;
1791                 case 'ALT':
1792                     $keys[] = behat_keys::ALT;
1793                     break;
1794                 case 'META':
1795                     $keys[] = behat_keys::META;
1796                     break;
1797                 default:
1798                     throw new \coding_exception("Unknown modifier key '$modifier'}");
1799             }
1800         }
1802         $modifier = trim($key);
1803         switch (strtoupper($key)) {
1804             case 'UP':
1805                 $keys[] = behat_keys::UP_ARROW;
1806                 break;
1807             case 'DOWN':
1808                 $keys[] = behat_keys::DOWN_ARROW;
1809                 break;
1810             case 'LEFT':
1811                 $keys[] = behat_keys::LEFT_ARROW;
1812                 break;
1813             case 'RIGHT':
1814                 $keys[] = behat_keys::RIGHT_ARROW;
1815                 break;
1816             case 'HOME':
1817                 $keys[] = behat_keys::HOME;
1818                 break;
1819             case 'END':
1820                 $keys[] = behat_keys::END;
1821                 break;
1822             case 'INSERT':
1823                 $keys[] = behat_keys::INSERT;
1824                 break;
1825             case 'BACKSPACE':
1826                 $keys[] = behat_keys::BACKSPACE;
1827                 break;
1828             case 'DELETE':
1829                 $keys[] = behat_keys::DELETE;
1830                 break;
1831             case 'PAGEUP':
1832             case 'PAGE_UP':
1833                 $keys[] = behat_keys::PAGE_UP;
1834                 break;
1835             case 'PAGEDOWN':
1836             case 'PAGE_DOWN':
1837                 $keys[] = behat_keys::PAGE_DOWN;
1838                 break;
1839             case 'ESCAPE':
1840                 $keys[] = behat_keys::ESCAPE;
1841                 break;
1842             case 'ENTER':
1843                 $keys[] = behat_keys::ENTER;
1844                 break;
1845             case 'TAB':
1846                 $keys[] = behat_keys::TAB;
1847                 break;
1848             case 'SPACE':
1849                 $keys[] = behat_keys::SPACE;
1850                 break;
1851             default:
1852                 throw new \coding_exception("Unknown key '$key'}");
1853         }
1855         // Always send the NULL key as the last key.
1856         $keys[] = behat_keys::NULL_KEY;
1858         behat_base::type_keys($this->getSession(), $keys);
1859     }
1861     /**
1862      * Trigger a keydown event for a key on a specific element.
1863      *
1864      * @When /^I press key "(?P<key_string>(?:[^"]|\\")*)" in "(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>[^"]*)"$/
1865      * @param string $key either char-code or character itself,
1866      *               may optionally be prefixed with ctrl-, alt-, shift- or meta-
1867      * @param string $element Element we look for
1868      * @param string $selectortype The type of what we look for
1869      * @throws DriverException
1870      * @throws ExpectationException
1871      */
1872     public function i_press_key_in_element($key, $element, $selectortype) {
1873         if (!$this->running_javascript()) {
1874             throw new DriverException('Key down step is not available with Javascript disabled');
1875         }
1876         // Gets the node based on the requested selector type and locator.
1877         $node = $this->get_selected_node($selectortype, $element);
1878         $modifier = null;
1879         $validmodifiers = array('ctrl', 'alt', 'shift', 'meta');
1880         $char = $key;
1881         if (strpos($key, '-')) {
1882             list($modifier, $char) = preg_split('/-/', $key, 2);
1883             $modifier = strtolower($modifier);
1884             if (!in_array($modifier, $validmodifiers)) {
1885                 throw new ExpectationException(sprintf('Unknown key modifier: %s.', $modifier));
1886             }
1887         }
1888         if (is_numeric($char)) {
1889             $char = (int)$char;
1890         }
1892         $node->keyDown($char, $modifier);
1893         $node->keyPress($char, $modifier);
1894         $node->keyUp($char, $modifier);
1895     }
1897     /**
1898      * Press tab key on a specific element.
1899      *
1900      * @When /^I press tab key in "(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>[^"]*)"$/
1901      * @param string $element Element we look for
1902      * @param string $selectortype The type of what we look for
1903      * @throws DriverException
1904      * @throws ExpectationException
1905      */
1906     public function i_post_tab_key_in_element($element, $selectortype) {
1907         if (!$this->running_javascript()) {
1908             throw new DriverException('Tab press step is not available with Javascript disabled');
1909         }
1910         // Gets the node based on the requested selector type and locator.
1911         $node = $this->get_selected_node($selectortype, $element);
1912         $this->execute('behat_general::i_click_on', [$node, 'NodeElement']);
1913         $this->execute('behat_general::i_press_named_key', ['', 'tab']);
1914     }
1916     /**
1917      * Checks if database family used is using one of the specified, else skip. (mysql, postgres, mssql, oracle, etc.)
1918      *
1919      * @Given /^database family used is one of the following:$/
1920      * @param TableNode $databasefamilies list of database.
1921      * @return void.
1922      * @throws \Moodle\BehatExtension\Exception\SkippedException
1923      */
1924     public function database_family_used_is_one_of_the_following(TableNode $databasefamilies) {
1925         global $DB;
1927         $dbfamily = $DB->get_dbfamily();
1929         // Check if used db family is one of the specified ones. If yes then return.
1930         foreach ($databasefamilies->getRows() as $dbfamilytocheck) {
1931             if ($dbfamilytocheck[0] == $dbfamily) {
1932                 return;
1933             }
1934         }
1936         throw new \Moodle\BehatExtension\Exception\SkippedException();
1937     }
1939     /**
1940      * Checks focus is with the given element.
1941      *
1942      * @Then /^the focused element is( not)? "(?P<node_string>(?:[^"]|\\")*)" "(?P<node_selector_string>[^"]*)"$/
1943      * @param string $not optional step verifier
1944      * @param string $nodeelement Element identifier
1945      * @param string $nodeselectortype Element type
1946      * @throws DriverException If not using JavaScript
1947      * @throws ExpectationException
1948      */
1949     public function the_focused_element_is($not, $nodeelement, $nodeselectortype) {
1950         if (!$this->running_javascript()) {
1951             throw new DriverException('Checking focus on an element requires JavaScript');
1952         }
1954         $element = $this->find($nodeselectortype, $nodeelement);
1955         $xpath = addslashes_js($element->getXpath());
1956         $script = 'return (function() { return document.activeElement === document.evaluate("' . $xpath . '",
1957                 document, null, XPathResult.FIRST_ORDERED_NODE_TYPE, null).singleNodeValue; })(); ';
1958         $targetisfocused = $this->evaluate_script($script);
1959         if ($not == ' not') {
1960             if ($targetisfocused) {
1961                 throw new ExpectationException("$nodeelement $nodeselectortype is focused", $this->getSession());
1962             }
1963         } else {
1964             if (!$targetisfocused) {
1965                 throw new ExpectationException("$nodeelement $nodeselectortype is not focused", $this->getSession());
1966             }
1967         }
1968     }
1970     /**
1971      * Checks focus is with the given element.
1972      *
1973      * @Then /^the focused element is( not)? "(?P<n>(?:[^"]|\\")*)" "(?P<ns>[^"]*)" in the "(?P<c>(?:[^"]|\\")*)" "(?P<cs>[^"]*)"$/
1974      * @param string $not string optional step verifier
1975      * @param string $element Element identifier
1976      * @param string $selectortype Element type
1977      * @param string $nodeelement Element we look in
1978      * @param string $nodeselectortype The type of selector where we look in
1979      * @throws DriverException If not using JavaScript
1980      * @throws ExpectationException
1981      */
1982     public function the_focused_element_is_in_the($not, $element, $selectortype, $nodeelement, $nodeselectortype) {
1983         if (!$this->running_javascript()) {
1984             throw new DriverException('Checking focus on an element requires JavaScript');
1985         }
1986         $element = $this->get_node_in_container($selectortype, $element, $nodeselectortype, $nodeelement);
1987         $xpath = addslashes_js($element->getXpath());
1988         $script = 'return (function() { return document.activeElement === document.evaluate("' . $xpath . '",
1989                 document, null, XPathResult.FIRST_ORDERED_NODE_TYPE, null).singleNodeValue; })(); ';
1990         $targetisfocused = $this->evaluate_script($script);
1991         if ($not == ' not') {
1992             if ($targetisfocused) {
1993                 throw new ExpectationException("$nodeelement $nodeselectortype is focused", $this->getSession());
1994             }
1995         } else {
1996             if (!$targetisfocused) {
1997                 throw new ExpectationException("$nodeelement $nodeselectortype is not focused", $this->getSession());
1998             }
1999         }
2000     }
2002     /**
2003      * Manually press tab key.
2004      *
2005      * @When /^I press( shift)? tab$/
2006      * @param string $shift string optional step verifier
2007      * @throws DriverException
2008      */
2009     public function i_manually_press_tab($shift = '') {
2010         if (empty($shift)) {
2011             $this->execute('behat_general::i_press_named_key', ['', 'tab']);
2012         } else {
2013             $this->execute('behat_general::i_press_named_key', ['shift', 'tab']);
2014         }
2015     }
2017     /**
2018      * Trigger click on node via javascript instead of actually clicking on it via pointer.
2019      * This function resolves the issue of nested elements.
2020      *
2021      * @When /^I click on "(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>[^"]*)" skipping visibility check$/
2022      * @param string $element
2023      * @param string $selectortype
2024      */
2025     public function i_click_on_skipping_visibility_check($element, $selectortype) {
2027         // Gets the node based on the requested selector type and locator.
2028         $node = $this->get_selected_node($selectortype, $element);
2029         $this->js_trigger_click($node);
2030     }
2032     /**
2033      * Checks, that the specified element contains the specified text a certain amount of times.
2034      * When running Javascript tests it also considers that texts may be hidden.
2035      *
2036      * @Then /^I should see "(?P<elementscount_number>\d+)" occurrences of "(?P<text_string>(?:[^"]|\\")*)" in the "(?P<element_string>(?:[^"]|\\")*)" "(?P<text_selector_string>[^"]*)"$/
2037      * @throws ElementNotFoundException
2038      * @throws ExpectationException
2039      * @param int    $elementscount How many occurrences of the element we look for.
2040      * @param string $text
2041      * @param string $element Element we look in.
2042      * @param string $selectortype The type of element where we are looking in.
2043      */
2044     public function i_should_see_occurrences_of_in_element($elementscount, $text, $element, $selectortype) {
2046         // Getting the container where the text should be found.
2047         $container = $this->get_selected_node($selectortype, $element);
2049         // Looking for all the matching nodes without any other descendant matching the
2050         // same xpath (we are using contains(., ....).
2051         $xpathliteral = behat_context_helper::escape($text);
2052         $xpath = "/descendant-or-self::*[contains(., $xpathliteral)]" .
2053                 "[count(descendant::*[contains(., $xpathliteral)]) = 0]";
2055         $nodes = $this->find_all('xpath', $xpath, false, $container);
2057         if ($this->running_javascript()) {
2058             $nodes = array_filter($nodes, function($node) {
2059                 return $node->isVisible();
2060             });
2061         }
2063         if ($elementscount != count($nodes)) {
2064             throw new ExpectationException('Found '.count($nodes).' elements in column. Expected '.$elementscount,
2065                     $this->getSession());
2066         }
2067     }
2069     /**
2070      * Manually press enter key.
2071      *
2072      * @When /^I press enter/
2073      * @throws DriverException
2074      */
2075     public function i_manually_press_enter() {
2076         $this->execute('behat_general::i_press_named_key', ['', 'enter']);
2077     }
2079     /**
2080      * Visit a local URL relative to the behat root.
2081      *
2082      * @When I visit :localurl
2083      *
2084      * @param string|moodle_url $localurl The URL relative to the behat_wwwroot to visit.
2085      */
2086     public function i_visit($localurl): void {
2087         $localurl = new moodle_url($localurl);
2088         $this->getSession()->visit($this->locate_path($localurl->out_as_local_url(false)));
2089     }