dca01b7edee46e53d89c62ca305ef241f83a2f60
[moodle.git] / lib / tests / behat / behat_action_menu.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  * Steps definitions to open and close action menus.
19  *
20  * @package    core
21  * @category   test
22  * @copyright  2016 Damyon Wiese
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\Mink\Exception\ExpectationException as ExpectationException;
31 use Behat\Mink\Exception\DriverException as DriverException;
33 /**
34  * Steps definitions to open and close action menus.
35  *
36  * @package    core
37  * @category   test
38  * @copyright  2016 Damyon Wiese
39  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
40  */
41 class behat_action_menu extends behat_base {
43     /**
44      * Open the action menu in
45      *
46      * @Given /^I open the action menu in "(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>[^"]*)"$/
47      * @param string $element
48      * @param string $selector
49      * @return void
50      */
51     public function i_open_the_action_menu_in($element, $selectortype) {
52         if (!$this->running_javascript()) {
53             // Action menus automatically expand in a visible list of actions when Javascript is disabled.
54             return;
55         }
56         // Gets the node based on the requested selector type and locator.
57         $node = $this->get_node_in_container("css_element", "[role=menuitem][aria-haspopup=true]", $selectortype, $element);
59         // Check if it is not already opened.
60         $menunode = $this->find('css', '[aria-labelledby='.$node->getAttribute('id').']');
61         if ($menunode->getAttribute('aria-hidden') === 'false') {
62             return;
63         }
65         $this->ensure_node_is_visible($node);
66         $node->click();
67     }
69     /**
70      * When an action menu is open, follow one of the items in it.
71      *
72      * @Given /^I choose "(?P<link_string>(?:[^"]|\\")*)" in the open action menu$/
73      * @param string $linkstring
74      * @return void
75      */
76     public function i_choose_in_the_open_action_menu($linkstring) {
77         if (!$this->running_javascript()) {
78             throw new DriverException('Action menu steps are not available with Javascript disabled');
79         }
80         // Gets the node based on the requested selector type and locator.
81         $node = $this->get_node_in_container("link",
82             $linkstring,
83             "css_element",
84             ".moodle-actionmenu [role=menu][aria-hidden=false]");
85         $this->ensure_node_is_visible($node);
86         $node->click();
87     }
88 }