fc7444c50b33b5087ef260b6f633288f5adbc140
[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\Mink\Exception\ExpectationException as ExpectationException;
31 use Behat\Mink\Exception\DriverException as DriverException;
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 = behat_context_helper::escape($text);
64         $hasblocktree = "[contains(concat(' ', normalize-space(@class), ' '), ' block_tree ')]";
65         $hasbranch = "[contains(concat(' ', normalize-space(@class), ' '), ' branch ')]";
66         $hascollapsed = "p[@aria-expanded='false']";
67         $notcollapsed = "p[@aria-expanded='true']";
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 = 'p';
78         }
80         // First check root nodes, it can be a span or link.
81         $xpath  = "//ul{$hasblocktree}/li/{$hascollapsed}{$isbranch}/span{$match}|";
82         $xpath  .= "//ul{$hasblocktree}/li/{$hascollapsed}{$isbranch}/a{$match}|";
84         // Next search for the node containing the text within a link.
85         $xpath .= "//ul{$hasblocktree}//ul/li/{$iscollapsed}{$isbranch}/a{$match}|";
87         // Finally search for the node containing the text within a span.
88         $xpath .= "//ul{$hasblocktree}//ul/li/{$iscollapsed}{$isbranch}/span{$match}";
90         $node = $this->find('xpath', $xpath, $exception);
91         $this->ensure_node_is_visible($node);
92         return $node;
93     }
95     /**
96      * Returns true if the navigation node with the given text is expandable.
97      *
98      * @Given /^navigation node "([^"]*)" should be expandable$/
99      *
100      * @throws ExpectationException
101      * @param string $nodetext
102      * @return bool
103      */
104     public function navigation_node_should_be_expandable($nodetext) {
105         if (!$this->running_javascript()) {
106             // Nodes are only expandable when JavaScript is enabled.
107             return false;
108         }
110         $node = $this->get_node_text_node($nodetext, true);
111         $node = $node->getParent();
112         if ($node->hasClass('emptybranch')) {
113             throw new ExpectationException('The "' . $nodetext . '" node is not expandable', $this->getSession());
114         }
116         return true;
117     }
119     /**
120      * Returns true if the navigation node with the given text is not expandable.
121      *
122      * @Given /^navigation node "([^"]*)" should not be expandable$/
123      *
124      * @throws ExpectationException
125      * @param string $nodetext
126      * @return bool
127      */
128     public function navigation_node_should_not_be_expandable($nodetext) {
129         if (!$this->running_javascript()) {
130             // Nodes are only expandable when JavaScript is enabled.
131             return false;
132         }
134         $node = $this->get_node_text_node($nodetext);
135         $node = $node->getParent();
137         if ($node->hasClass('emptybranch') || $node->hasClass('tree_item')) {
138             return true;
139         }
140         throw new ExpectationException('The "' . $nodetext . '" node is expandable', $this->getSession());
141     }
143     /**
144      * Click on an entry in the user menu.
145      * @Given /^I follow "(?P<nodetext_string>(?:[^"]|\\")*)" in the user menu$/
146      *
147      * @param string $nodetext
148      */
149     public function i_follow_in_the_user_menu($nodetext) {
151         if ($this->running_javascript()) {
152             // The user menu must be expanded when JS is enabled.
153             $xpath = "//div[@class='usermenu']//a[contains(concat(' ', @class, ' '), ' toggle-display ')]";
154             $this->execute("behat_general::i_click_on", array($this->escape($xpath), "xpath_element"));
155         }
157         // Now select the link.
158         // The CSS path is always present, with or without JS.
159         $csspath = ".usermenu [data-rel='menu-content']";
161         $this->execute('behat_general::i_click_on_in_the',
162             array($nodetext, "link", $csspath, "css_element")
163         );
164     }
166     /**
167      * Expands the selected node of the navigation tree that matches the text.
168      * @Given /^I expand "(?P<nodetext_string>(?:[^"]|\\")*)" node$/
169      *
170      * @throws ExpectationException
171      * @param string $nodetext
172      * @return bool|void
173      */
174     public function i_expand_node($nodetext) {
176         // This step is useless with Javascript disabled as Moodle auto expands
177         // all of tree's nodes; adding this because of scenarios that shares the
178         // same steps with and without Javascript enabled.
179         if (!$this->running_javascript()) {
180             if ($nodetext === get_string('administrationsite')) {
181                 // Administration menu is not loaded by default any more. Click the link to expand.
182                 $this->execute('behat_general::i_click_on_in_the',
183                     array($nodetext, "link", get_string('administration'), "block")
184                 );
185                 return true;
186             }
187             return true;
188         }
190         $node = $this->get_node_text_node($nodetext, true, true, 'The "' . $nodetext . '" node can not be expanded');
191         // Check if the node is a link AND a branch.
192         if (strtolower($node->getTagName()) === 'a') {
193             // We just want to expand the node, we don't want to follow it.
194             $node = $node->getParent();
195         }
196         $node->click();
197     }
199     /**
200      * Collapses the selected node of the navigation tree that matches the text.
201      *
202      * @Given /^I collapse "(?P<nodetext_string>(?:[^"]|\\")*)" node$/
203      * @throws ExpectationException
204      * @param string $nodetext
205      * @return bool|void
206      */
207     public function i_collapse_node($nodetext) {
209         // No collapsible nodes with non-JS browsers.
210         if (!$this->running_javascript()) {
211             return true;
212         }
214         $node = $this->get_node_text_node($nodetext, true, false, 'The "' . $nodetext . '" node can not be collapsed');
215         // Check if the node is a link AND a branch.
216         if (strtolower($node->getTagName()) === 'a') {
217             // We just want to expand the node, we don't want to follow it.
218             $node = $node->getParent();
219         }
220         $node->click();
221     }
223     /**
224      * Finds a node in the Navigation or Administration tree
225      *
226      * @param string $nodetext
227      * @param array $parentnodes
228      * @param string $nodetype node type (link or text)
229      * @return NodeElement|null
230      * @throws ExpectationException when one of the parent nodes is not found
231      */
232     protected function find_node_in_navigation($nodetext, $parentnodes, $nodetype = 'link') {
233         // Site admin is different and needs special treatment.
234         $siteadminstr = get_string('administrationsite');
236         // Create array of all parentnodes.
237         $countparentnode = count($parentnodes);
239         // If JS is disabled and Site administration is not expanded we
240         // should follow it, so all the lower-level nodes are available.
241         if (!$this->running_javascript()) {
242             if ($parentnodes[0] === $siteadminstr) {
243                 // We don't know if there if Site admin is already expanded so
244                 // don't wait, it is non-JS and we already waited for the DOM.
245                 $siteadminlink = $this->getSession()->getPage()->find('named_exact', array('link', "'" . $siteadminstr . "'"));
246                 if ($siteadminlink) {
247                     $siteadminlink->click();
248                 }
249             }
250         }
252         // Get top level node.
253         $node = $this->get_top_navigation_node($parentnodes[0]);
255         // Expand all nodes.
256         for ($i = 0; $i < $countparentnode; $i++) {
257             if ($i > 0) {
258                 // Sub nodes within top level node.
259                 $node = $this->get_navigation_node($parentnodes[$i], $node);
260             }
262             // The p node contains the aria jazz.
263             $pnodexpath = "/p[contains(concat(' ', normalize-space(@class), ' '), ' tree_item ')]";
264             $pnode = $node->find('xpath', $pnodexpath);
266             // Keep expanding all sub-parents if js enabled.
267             if ($pnode && $this->running_javascript() && $pnode->hasAttribute('aria-expanded') &&
268                 ($pnode->getAttribute('aria-expanded') == "false")) {
270                 $this->js_trigger_click($pnode);
272                 // Wait for node to load, if not loaded before.
273                 if ($pnode->hasAttribute('data-loaded') && $pnode->getAttribute('data-loaded') == "false") {
274                     $jscondition = '(document.evaluate("' . $pnode->getXpath() . '", document, null, '.
275                         'XPathResult.ANY_TYPE, null).iterateNext().getAttribute(\'data-loaded\') == "true")';
277                     $this->getSession()->wait(self::EXTENDED_TIMEOUT * 1000, $jscondition);
278                 }
279             }
280         }
282         // Finally, click on requested node under navigation.
283         $nodetextliteral = behat_context_helper::escape($nodetext);
284         $tagname = ($nodetype === 'link') ? 'a' : 'span';
285         $xpath = "/ul/li/p[contains(concat(' ', normalize-space(@class), ' '), ' tree_item ')]" .
286             "/{$tagname}[normalize-space(.)=" . $nodetextliteral . "]";
287         return $node->find('xpath', $xpath);
288     }
290     /**
291      * Finds a node in the Navigation or Administration tree and clicks on it.
292      *
293      * @param string $nodetext
294      * @param array $parentnodes
295      * @throws ExpectationException
296      */
297     protected function select_node_in_navigation($nodetext, $parentnodes) {
298         $nodetoclick = $this->find_node_in_navigation($nodetext, $parentnodes);
299         // Throw exception if no node found.
300         if (!$nodetoclick) {
301             throw new ExpectationException('Navigation node "' . $nodetext . '" not found under "' .
302                 implode($parentnodes, ' > ') . '"', $this->getSession());
303         }
304         $nodetoclick->click();
305     }
307     /**
308      * Helper function to get top navigation node in tree.
309      *
310      * @throws ExpectationException if note not found.
311      * @param string $nodetext name of top navigation node in tree.
312      * @return NodeElement
313      */
314     protected function get_top_navigation_node($nodetext) {
316         // Avoid problems with quotes.
317         $nodetextliteral = behat_context_helper::escape($nodetext);
318         $exception = new ExpectationException('Top navigation node "' . $nodetext . ' not found in "', $this->getSession());
320         // First find in navigation block.
321         $xpath = "//div[contains(concat(' ', normalize-space(@class), ' '), ' content ')]" .
322             "/ul[contains(concat(' ', normalize-space(@class), ' '), ' block_tree ')]" .
323             "/li[contains(concat(' ', normalize-space(@class), ' '), ' contains_branch ')]" .
324             "/ul/li[contains(concat(' ', normalize-space(@class), ' '), ' contains_branch ')]" .
325             "[p[contains(concat(' ', normalize-space(@class), ' '), ' branch ')]" .
326             "[span[normalize-space(.)=" . $nodetextliteral ."] or a[normalize-space(.)=" . $nodetextliteral ."]]]" .
327             "|" .
328             "//div[contains(concat(' ', normalize-space(@class), ' '), ' content ')]/div" .
329             "/ul[contains(concat(' ', normalize-space(@class), ' '), ' block_tree ')]" .
330             "/li[contains(concat(' ', normalize-space(@class), ' '), ' contains_branch ')]" .
331             "/ul/li[contains(concat(' ', normalize-space(@class), ' '), ' contains_branch ')]" .
332             "[p[contains(concat(' ', normalize-space(@class), ' '), ' branch ')]" .
333             "/span[normalize-space(.)=" . $nodetextliteral ."]]" .
334             "|" .
335             "//div[contains(concat(' ', normalize-space(@class), ' '), ' content ')]/div" .
336             "/ul[contains(concat(' ', normalize-space(@class), ' '), ' block_tree ')]" .
337             "/li[p[contains(concat(' ', normalize-space(@class), ' '), ' branch ')]" .
338             "/span[normalize-space(.)=" . $nodetextliteral ."]]" .
339             "|" .
340             "//div[contains(concat(' ', normalize-space(@class), ' '), ' content ')]/div" .
341             "/ul[contains(concat(' ', normalize-space(@class), ' '), ' block_tree ')]" .
342             "/li[p[contains(concat(' ', normalize-space(@class), ' '), ' branch ')]" .
343             "/a[normalize-space(.)=" . $nodetextliteral ."]]";
345         $node = $this->find('xpath', $xpath, $exception);
347         return $node;
348     }
350     /**
351      * Helper function to get sub-navigation node.
352      *
353      * @throws ExpectationException if note not found.
354      * @param string $nodetext node to find.
355      * @param NodeElement $parentnode parent navigation node.
356      * @return NodeElement.
357      */
358     protected function get_navigation_node($nodetext, $parentnode = null) {
360         // Avoid problems with quotes.
361         $nodetextliteral = behat_context_helper::escape($nodetext);
363         $xpath = "/ul/li[contains(concat(' ', normalize-space(@class), ' '), ' contains_branch ')]" .
364             "[child::p[contains(concat(' ', normalize-space(@class), ' '), ' branch ')]" .
365             "/child::span[normalize-space(.)=" . $nodetextliteral ."]]";
366         $node = $parentnode->find('xpath', $xpath);
367         if (!$node) {
368             $xpath = "/ul/li[contains(concat(' ', normalize-space(@class), ' '), ' contains_branch ')]" .
369                 "[child::p[contains(concat(' ', normalize-space(@class), ' '), ' branch ')]" .
370                 "/child::a[normalize-space(.)=" . $nodetextliteral ."]]";
371             $node = $parentnode->find('xpath', $xpath);
372         }
374         if (!$node) {
375             throw new ExpectationException('Sub-navigation node "' . $nodetext . '" not found under "' .
376                 $parentnode->getText() . '"', $this->getSession());
377         }
378         return $node;
379     }
381     /**
382      * Step to open the navigation bar if it is needed.
383      *
384      * The top log in and log out links are hidden when middle or small
385      * size windows (or devices) are used. This step returns a step definition
386      * clicking to expand the navbar if it is hidden.
387      *
388      * @Given /^I expand navigation bar$/
389      */
390     public function get_expand_navbar_step() {
392         // Checking if we need to click the navbar button to show the navigation menu, it
393         // is hidden by default when using clean theme and a medium or small screen size.
395         // The DOM and the JS should be all ready and loaded. Running without spinning
396         // as this is a widely used step and we can not spend time here trying to see
397         // a DOM node that is not always there (at the moment clean is not even the
398         // default theme...).
399         $navbuttonjs = "return (
400             Y.one('.btn-navbar') &&
401             Y.one('.btn-navbar').getComputedStyle('display') !== 'none'
402         )";
404         // Adding an extra click we need to show the 'Log in' link.
405         if (!$this->getSession()->getDriver()->evaluateScript($navbuttonjs)) {
406             return false;
407         }
409         $this->execute('behat_general::i_click_on', array(".btn-navbar", "css_element"));
410     }
412     /**
413      * Go to current page setting item
414      *
415      * This can be used on front page, course, category or modules pages.
416      *
417      * @Given /^I navigate to "(?P<nodetext_string>(?:[^"]|\\")*)" in current page administration$/
418      *
419      * @throws ExpectationException
420      * @param string $nodetext navigation node to click, may contain path, for example "Reports > Overview"
421      * @return void
422      */
423     public function i_navigate_to_in_current_page_administration($nodetext) {
424         $parentnodes = array_map('trim', explode('>', $nodetext));
425         // Find the name of the first category of the administration block tree.
426         $xpath = '//div[contains(@class,\'block_settings\')]//div[@id=\'settingsnav\']/ul/li[1]/p[1]/span';
427         $node = $this->find('xpath', $xpath);
428         array_unshift($parentnodes, $node->getText());
429         $lastnode = array_pop($parentnodes);
430         $this->select_node_in_navigation($lastnode, $parentnodes);
431     }
433     /**
434      * Checks that current page administration contains text
435      *
436      * @Given /^"(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>[^"]*)" should exist in current page administration$/
437      *
438      * @throws ExpectationException
439      * @param string $element The locator of the specified selector.
440      *     This may be a path, for example "Subscription mode > Forced subscription"
441      * @param string $selectortype The selector type (link or text)
442      * @return void
443      */
444     public function should_exist_in_current_page_administration($element, $selectortype) {
445         $parentnodes = array_map('trim', explode('>', $element));
446         // Find the name of the first category of the administration block tree.
447         $xpath = '//div[contains(@class,\'block_settings\')]//div[@id=\'settingsnav\']/ul/li[1]/p[1]/span';
448         $node = $this->find('xpath', $xpath);
449         array_unshift($parentnodes, $node->getText());
450         $lastnode = array_pop($parentnodes);
452         if (!$this->find_node_in_navigation($lastnode, $parentnodes, strtolower($selectortype))) {
453             throw new ExpectationException(ucfirst($selectortype) . ' "' . $element .
454                 '" not found in current page administration"', $this->getSession());
455         }
456     }
458     /**
459      * Checks that current page administration contains text
460      *
461      * @Given /^"(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>[^"]*)" should not exist in current page administration$/
462      *
463      * @throws ExpectationException
464      * @param string $element The locator of the specified selector.
465      *     This may be a path, for example "Subscription mode > Forced subscription"
466      * @param string $selectortype The selector type (link or text)
467      * @return void
468      */
469     public function should_not_exist_in_current_page_administration($element, $selectortype) {
470         $parentnodes = array_map('trim', explode('>', $element));
471         // Find the name of the first category of the administration block tree.
472         $xpath = '//div[contains(@class,\'block_settings\')]//div[@id=\'settingsnav\']/ul/li[1]/p[1]/span';
473         $node = $this->find('xpath', $xpath);
474         array_unshift($parentnodes, $node->getText());
475         $lastnode = array_pop($parentnodes);
477         if ($this->find_node_in_navigation($lastnode, $parentnodes, strtolower($selectortype))) {
478             throw new ExpectationException(ucfirst($selectortype) . ' "' . $element .
479                 '" found in current page administration"', $this->getSession());
480         }
481     }
483     /**
484      * Go to site administration item
485      *
486      * @Given /^I navigate to "(?P<nodetext_string>(?:[^"]|\\")*)" in site administration$/
487      *
488      * @throws ExpectationException
489      * @param string $nodetext navigation node to click, may contain path, for example "Reports > Overview"
490      * @return void
491      */
492     public function i_navigate_to_in_site_administration($nodetext) {
493         $parentnodes = array_map('trim', explode('>', $nodetext));
494         array_unshift($parentnodes, get_string('administrationsite'));
495         $lastnode = array_pop($parentnodes);
496         $this->select_node_in_navigation($lastnode, $parentnodes);
497     }
499     /**
500      * Opens the current users profile page in edit mode.
501      *
502      * @Given /^I open my profile in edit mode$/
503      * @throws coding_exception
504      * @return void
505      */
506     public function i_open_my_profile_in_edit_mode() {
507         global $USER;
509         $user = $this->get_session_user();
510         $globuser = $USER;
511         $USER = $user; // We need this set to the behat session user so we can call isloggedin.
513         $systemcontext = context_system::instance();
515         $bodynode = $this->find('xpath', 'body');
516         $bodyclass = $bodynode->getAttribute('class');
517         $matches = [];
518         if (preg_match('/(?<=^course-|\scourse-)\d+/', $bodyclass, $matches) && !empty($matches)) {
519             $courseid = intval($matches[0]);
520         } else {
521             $courseid = SITEID;
522         }
524         if (isloggedin() && !isguestuser($user) && !is_mnet_remote_user($user)) {
525             if (is_siteadmin($user) ||  has_capability('moodle/user:update', $systemcontext)) {
526                 $url = new moodle_url('/user/editadvanced.php', array('id' => $user->id, 'course' => SITEID,
527                     'returnto' => 'profile'));
528             } else if (has_capability('moodle/user:editownprofile', $systemcontext)) {
529                 $userauthplugin = false;
530                 if (!empty($user->auth)) {
531                     $userauthplugin = get_auth_plugin($user->auth);
532                 }
533                 if ($userauthplugin && $userauthplugin->can_edit_profile()) {
534                     $url = $userauthplugin->edit_profile_url();
535                     if (empty($url)) {
536                         if (empty($course)) {
537                             $url = new moodle_url('/user/edit.php', array('id' => $user->id, 'returnto' => 'profile'));
538                         } else {
539                             $url = new moodle_url('/user/edit.php', array('id' => $user->id, 'course' => $courseid,
540                                 'returnto' => 'profile'));
541                         }
542                     }
544                 }
545             }
546             $this->getSession()->visit($this->locate_path($url->out_as_local_url()));
547         }
549         // Restore global user variable.
550         $USER = $globuser;
551     }
553     /**
554      * Opens the course homepage.
555      *
556      * @Given /^I am on "(?P<coursefullname_string>(?:[^"]|\\")*)" course homepage$/
557      * @throws coding_exception
558      * @param string $coursefullname The full name of the course.
559      * @return void
560      */
561     public function i_am_on_course_homepage($coursefullname) {
562         global $DB;
563         $course = $DB->get_record("course", array("fullname" => $coursefullname), 'id', MUST_EXIST);
564         $url = new moodle_url('/course/view.php', ['id' => $course->id]);
565         $this->getSession()->visit($this->locate_path($url->out_as_local_url(false)));
566     }
568     /**
569      * Opens the course homepage with editing mode on.
570      *
571      * @Given /^I am on "(?P<coursefullname_string>(?:[^"]|\\")*)" course homepage with editing mode on$/
572      * @throws coding_exception
573      * @param string $coursefullname The course full name of the course.
574      * @return void
575      */
576     public function i_am_on_course_homepage_with_editing_mode_on($coursefullname) {
577         global $DB;
578         $course = $DB->get_record("course", array("fullname" => $coursefullname), 'id', MUST_EXIST);
579         $url = new moodle_url('/course/view.php', ['id' => $course->id]);
580         $this->getSession()->visit($this->locate_path($url->out_as_local_url(false)));
581         try {
582             $this->execute("behat_forms::press_button", get_string('turneditingon'));
583         } catch (Exception $e) {
584             $this->execute("behat_navigation::i_navigate_to_in_current_page_administration", [get_string('turneditingon')]);
585         }
586     }