887743d2f82e9803baadf86ea898ce2e1e9be333
[moodle.git] / lib / tests / behat / behat_navigation.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  * Navigation 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\Behat\Context\Step\Given as Given,
31     Behat\Mink\Exception\ExpectationException as ExpectationException;
33 /**
34  * Steps definitions to navigate through the navigation tree nodes.
35  *
36  * @package    core
37  * @category   test
38  * @copyright  2012 David MonllaĆ³
39  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
40  */
41 class behat_navigation extends behat_base {
43     /**
44      * Helper function to get a navigation nodes text element given its text from within the navigation block.
45      *
46      * This function finds the node with the given text from within the navigation block.
47      * It checks to make sure the node is visible, and then returns it.
48      *
49      * @param string $text
50      * @param bool $branch Set this true if you're only interested in the node if its a branch.
51      * @param null|bool $collapsed Set this to true or false if you want the node to either be collapsed or not.
52      *    If its left as null then we don't worry about it.
53      * @param null|string|Exception|false $exception The exception to throw if the node is not found.
54      * @return \Behat\Mink\Element\NodeElement
55      */
56     protected function get_node_text_node($text, $branch = false, $collapsed = null, $exception = null) {
57         if ($exception === null) {
58             $exception = new ExpectationException('The "' . $text . '" node could not be found', $this->getSession());
59         } else if (is_string($exception)) {
60             $exception = new ExpectationException($exception, $this->getSession());
61         }
63         $nodetextliteral = $this->getSession()->getSelectorsHandler()->xpathLiteral($text);
64         $hasblocktree = "[contains(concat(' ', normalize-space(@class), ' '), ' block_tree ')]";
65         $hasbranch = "[contains(concat(' ', normalize-space(@class), ' '), ' branch ')]";
66         $hascollapsed = "li[contains(concat(' ', normalize-space(@class), ' '), ' collapsed ') or @data-exandable='1']";
67         $notcollapsed = "[not(contains(concat(' ', normalize-space(@class), ' '), ' collapsed '))]";
68         $match = "[normalize-space(.)={$nodetextliteral}]";
70         // Avoid problems with quotes.
71         $isbranch = ($branch) ? $hasbranch : '';
72         if ($collapsed === true) {
73             $iscollapsed = $hascollapsed;
74         } else if ($collapsed === false) {
75             $iscollapsed = $notcollapsed;
76         } else {
77             $iscollapsed = 'li';
78         }
80         $xpath  = "//ul{$hasblocktree}//li{$notcollapsed}/ul/{$iscollapsed}/p{$isbranch}/a{$match}|";
81         $xpath .= "//ul{$hasblocktree}//li{$notcollapsed}/ul/{$iscollapsed}/p{$isbranch}/span{$match}";
83         $node = $this->find('xpath', $xpath, $exception);
84         $this->ensure_node_is_visible($node);
85         return $node;
86     }
88     /**
89      * Returns true if the navigation node with the given text is expandable.
90      *
91      * @Given /^navigation node "([^"]*)" should be expandable$/
92      *
93      * @throws ExpectationException
94      * @param string $nodetext
95      * @return bool
96      */
97     public function navigation_node_should_be_expandable($nodetext) {
98         if (!$this->running_javascript()) {
99             // Nodes are only expandable when JavaScript is enabled.
100             return false;
101         }
103         $node = $this->get_node_text_node($nodetext, true);
104         $node = $node->getParent();
105         if ($node->hasAttribute('data-expandable') && $node->getAttribute('data-expandable')) {
106             return true;
107         }
108         throw new ExpectationException('The "' . $nodetext . '" node is not expandable', $this->getSession());
109     }
111     /**
112      * Returns true if the navigation node with the given text is not expandable.
113      *
114      * @Given /^navigation node "([^"]*)" should not be expandable$/
115      *
116      * @throws ExpectationException
117      * @param string $nodetext
118      * @return bool
119      */
120     public function navigation_node_should_not_be_expandable($nodetext) {
121         if (!$this->running_javascript()) {
122             // Nodes are only expandable when JavaScript is enabled.
123             return false;
124         }
126         $node = $this->get_node_text_node($nodetext);
127         $node = $node->getParent();
128         if ($node->hasAttribute('data-expandable') && $node->getAttribute('data-expandable')) {
129             throw new ExpectationException('The "' . $nodetext . '" node is expandable', $this->getSession());
130         }
131         return true;
132     }
134     /**
135      * Expands the selected node of the navigation tree that matches the text.
136      * @Given /^I expand "(?P<nodetext_string>(?:[^"]|\\")*)" node$/
137      *
138      * @throws ExpectationException
139      * @param string $nodetext
140      * @return bool|void
141      */
142     public function i_expand_node($nodetext) {
144         // This step is useless with Javascript disabled as Moodle auto expands
145         // all of tree's nodes; adding this because of scenarios that shares the
146         // same steps with and without Javascript enabled.
147         if (!$this->running_javascript()) {
148             if ($nodetext === get_string('administrationsite')) {
149                 // Administration menu is not loaded by default any more. Click the link to expand.
150                 return new Given('I click on "'.$nodetext.'" "link" in the "'.get_string('administration').'" "block"');
151             }
152             return true;
153         }
155         $node = $this->get_node_text_node($nodetext, true, true, 'The "' . $nodetext . '" node can not be expanded');
156         // Check if the node is a link AND a branch.
157         if (strtolower($node->getTagName()) === 'a') {
158             // We just want to expand the node, we don't want to follow it.
159             $node = $node->getParent();
160         }
161         $node->click();
162     }
164     /**
165      * Collapses the selected node of the navigation tree that matches the text.
166      *
167      * @Given /^I collapse "(?P<nodetext_string>(?:[^"]|\\")*)" node$/
168      * @throws ExpectationException
169      * @param string $nodetext
170      * @return bool|void
171      */
172     public function i_collapse_node($nodetext) {
174         // No collapsible nodes with non-JS browsers.
175         if (!$this->running_javascript()) {
176             return true;
177         }
179         $node = $this->get_node_text_node($nodetext, true, false, 'The "' . $nodetext . '" node can not be collapsed');
180         // Check if the node is a link AND a branch.
181         if (strtolower($node->getTagName()) === 'a') {
182             // We just want to expand the node, we don't want to follow it.
183             $node = $node->getParent();
184         }
185         $node->click();
186     }
188     /**
189      * Click link in navigation tree that matches the text in parentnode/s (seperated using greater-than character if more than one)
190      *
191      * @Given /^I navigate to "(?P<nodetext_string>(?:[^"]|\\")*)" node in "(?P<parentnodes_string>(?:[^"]|\\")*)"$/
192      *
193      * @throws ExpectationException
194      * @param string $nodetext navigation node to click.
195      * @param string $parentnodes comma seperated list of parent nodes.
196      * @return void
197      */
198     public function i_navigate_to_node_in($nodetext, $parentnodes) {
200         // Site admin is different and needs special treatment.
201         $siteadminstr = get_string('administrationsite');
203         // Create array of all parentnodes.
204         $parentnodes = array_map('trim', explode('>', $parentnodes));
205         $countparentnode = count($parentnodes);
207         // If JS is disabled and Site administration is not expanded we
208         // should follow it, so all the lower-level nodes are available.
209         if (!$this->running_javascript()) {
210             if ($parentnodes[0] === $siteadminstr) {
211                 // We don't know if there if Site admin is already expanded so
212                 // don't wait, it is non-JS and we already waited for the DOM.
213                 if ($siteadminlink = $this->getSession()->getPage()->find('named', array('link', "'" . $siteadminstr . "'"))) {
214                     $siteadminlink->click();
215                 }
216             }
217         }
219         // Expand first node, and get it.
220         $node = $this->get_top_navigation_node($parentnodes[0]);
222         // Expand parent, sub-parent nodes in navigation if js enabled.
223         if ($node->hasClass('collapsed') || ($node->hasAttribute('data-loaded') && $node->getAttribute('data-loaded') == 0)) {
224             $xpath = "/p[contains(concat(' ', normalize-space(@class), ' '), ' tree_item ')]/span";
225             $nodetoexpand = $node->find('xpath', $xpath);
227             if ($this->running_javascript()) {
228                 $this->ensure_node_is_visible($nodetoexpand);
229                 $nodetoexpand->click();
231                 // Site administration node needs to be expanded.
232                 if ($parentnodes[0] === $siteadminstr) {
233                     $this->getSession()->wait(self::TIMEOUT * 1000, self::PAGE_READY_JS);
234                 }
235             }
236         }
238         // If sub-parent nodes then get to the last one.
239         if ($countparentnode > 1) {
240             for ($i = 1; $i < $countparentnode; $i++) {
241                 $node = $this->get_navigation_node($parentnodes[$i], $node);
243                 // Keep expanding all sub-parents if js enabled.
244                 if ($this->running_javascript()) {
245                     $xpath = "/p[contains(concat(' ', normalize-space(@class), ' '), ' tree_item ')]";
246                     if ($node->hasClass('collapsed')) {
247                         $nodetoexpand = $node->find('xpath', $xpath);
248                         if ($this->running_javascript()) {
249                             $this->ensure_node_is_visible($nodetoexpand);
250                             $nodetoexpand->click();
251                         }
252                     }
253                 }
254             }
255         }
257         // Finally, click on requested node under navigation.
258         $nodetextliteral = $this->getSession()->getSelectorsHandler()->xpathLiteral($nodetext);
259         $xpath = "/ul/li/p[contains(concat(' ', normalize-space(@class), ' '), ' tree_item ')]" .
260                 "/a[normalize-space(.)=" . $nodetextliteral . "]";
261         $node = $node->find('xpath', $xpath);
263         // Throw exception if no node found.
264         if (!$node) {
265             throw new ExpectationException('Navigation node "' . $nodetext . '" not found under "' .
266                 $parentnodes . '"', $this->getSession());
267         }
269         if ($this->running_javascript()) {
270             $this->ensure_node_is_visible($node);
271         }
273         $node->click();
274     }
276     /**
277      * Helper function to get top navigation node in tree.
278      *
279      * @throws ExpectationException if note not found.
280      * @param string $nodetext name of top navigation node in tree.
281      * @return NodeElement
282      */
283     protected function get_top_navigation_node($nodetext) {
285         // Avoid problems with quotes.
286         $nodetextliteral = $this->getSession()->getSelectorsHandler()->xpathLiteral($nodetext);
287         $exception = new ExpectationException('Top navigation node "' . $nodetext . ' not found in "', $this->getSession());
289         // First find in navigation block.
290         $xpath = "//div[contains(concat(' ', normalize-space(@class), ' '), ' content ')]" .
291             "/ul[contains(concat(' ', normalize-space(@class), ' '), ' block_tree ')]" .
292             "/li[contains(concat(' ', normalize-space(@class), ' '), ' contains_branch ')]" .
293             "/ul/li[contains(concat(' ', normalize-space(@class), ' '), ' contains_branch ')]" .
294             "[p[contains(concat(' ', normalize-space(@class), ' '), ' branch ')]" .
295             "/span[normalize-space(.)=" . $nodetextliteral ."]]" .
296             "|" .
297             "//div[contains(concat(' ', normalize-space(@class), ' '), ' content ')]/div" .
298             "/ul[contains(concat(' ', normalize-space(@class), ' '), ' block_tree ')]" .
299             "/li[contains(concat(' ', normalize-space(@class), ' '), ' contains_branch ')]" .
300             "/ul/li[contains(concat(' ', normalize-space(@class), ' '), ' contains_branch ')]" .
301             "[p[contains(concat(' ', normalize-space(@class), ' '), ' branch ')]" .
302             "/span[normalize-space(.)=" . $nodetextliteral ."]]" .
303             "|" .
304             "//div[contains(concat(' ', normalize-space(@class), ' '), ' content ')]/div" .
305             "/ul[contains(concat(' ', normalize-space(@class), ' '), ' block_tree ')]" .
306             "/li[p[contains(concat(' ', normalize-space(@class), ' '), ' branch ')]" .
307             "/span[normalize-space(.)=" . $nodetextliteral ."]]";
308             $node = $this->find('xpath', $xpath, $exception);
310         return $node;
311     }
313     /**
314      * Helper function to get sub-navigation node.
315      *
316      * @throws ExpectationException if note not found.
317      * @param string $nodetext node to find.
318      * @param NodeElement $parentnode parent navigation node.
319      * @return NodeElement.
320      */
321     protected function get_navigation_node($nodetext, $parentnode = null) {
323         // Avoid problems with quotes.
324         $nodetextliteral = $this->getSession()->getSelectorsHandler()->xpathLiteral($nodetext);
326         $xpath = "/ul/li[contains(concat(' ', normalize-space(@class), ' '), ' contains_branch ')]" .
327             "[child::p[contains(concat(' ', normalize-space(@class), ' '), ' branch ')]" .
328             "/child::span[normalize-space(.)=" . $nodetextliteral ."]]";
329         $node = $parentnode->find('xpath', $xpath);
330         if (!$node) {
331             $xpath = "/ul/li[contains(concat(' ', normalize-space(@class), ' '), ' contains_branch ')]" .
332                 "[child::p[contains(concat(' ', normalize-space(@class), ' '), ' branch ')]" .
333                 "/child::a[normalize-space(.)=" . $nodetextliteral ."]]";
334             $node = $parentnode->find('xpath', $xpath);
335         }
337         if (!$node) {
338             throw new ExpectationException('Sub-navigation node "' . $nodetext . '" not found under "' .
339                 $parentnode->getText() . '"', $this->getSession());
340         }
341         return $node;
342     }