Search moodle.org's
Developer Documentation
Developer Documentation
See Release Notes
Long Term Support Release
- Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
- Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
- PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/lib/tests/behat/ -> behat_navigation.php (source)
Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 400 and 401] [Versions 401 and 402] [Versions 401 and 403]
1 <?php 2 // This file is part of Moodle - http://moodle.org/ 3 // 4 // Moodle is free software: you can redistribute it and/or modify 5 // it under the terms of the GNU General Public License as published by 6 // the Free Software Foundation, either version 3 of the License, or 7 // (at your option) any later version. 8 // 9 // Moodle is distributed in the hope that it will be useful, 10 // but WITHOUT ANY WARRANTY; without even the implied warranty of 11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 // GNU General Public License for more details. 13 // 14 // You should have received a copy of the GNU General Public License 15 // along with Moodle. If not, see <http://www.gnu.org/licenses/>. 16 17 /** 18 * 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 */ 25 26 // NOTE: no MOODLE_INTERNAL test here, this file may be required by behat before including /config.php. 27 28 require_once (__DIR__ . '/../../behat/behat_base.php'); 29 30 use Behat\Mink\Exception\ExpectationException as ExpectationException; 31 use Behat\Mink\Exception\DriverException as DriverException; 32 use Behat\Mink\Exception\ElementNotFoundException as ElementNotFoundException; 33 34 /** 35 * Steps definitions to navigate through the navigation tree nodes. 36 * 37 * @package core 38 * @category test 39 * @copyright 2012 David Monllaó 40 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 41 */ 42 class behat_navigation extends behat_base { 43 44 /** 45 * Checks whether a navigation node is active within the block navigation. 46 * 47 * @Given i should see :name is active in navigation 48 * 49 * @throws ElementNotFoundException 50 * @param string $element The name of the nav elemnent to look for. 51 * @return void 52 */ 53 public function i_should_see_is_active_in_navigation($element) { 54 $this->execute("behat_general::assert_element_contains_text", 55 [$element, '.block_navigation .active_tree_node', 'css_element']); 56 } 57 58 /** 59 * Helper function to get a navigation nodes text element given its text from within the navigation block. 60 * 61 * This function finds the node with the given text from within the navigation block. 62 * It checks to make sure the node is visible, and then returns it. 63 * 64 * @param string $text 65 * @param bool $branch Set this true if you're only interested in the node if its a branch. 66 * @param null|bool $collapsed Set this to true or false if you want the node to either be collapsed or not. 67 * If its left as null then we don't worry about it. 68 * @param null|string|Exception|false $exception The exception to throw if the node is not found. 69 * @return \Behat\Mink\Element\NodeElement 70 */ 71 protected function get_node_text_node($text, $branch = false, $collapsed = null, $exception = null) { 72 if ($exception === null) { 73 $exception = new ExpectationException('The "' . $text . '" node could not be found', $this->getSession()); 74 } else if (is_string($exception)) { 75 $exception = new ExpectationException($exception, $this->getSession()); 76 } 77 78 $nodetextliteral = behat_context_helper::escape($text); 79 $hasblocktree = "[contains(concat(' ', normalize-space(@class), ' '), ' block_tree ')]"; 80 $hasbranch = "[contains(concat(' ', normalize-space(@class), ' '), ' branch ')]"; 81 $hascollapsed = "li[@aria-expanded='false']/p"; 82 $notcollapsed = "li[@aria-expanded='true']/p"; 83 $match = "[normalize-space(.)={$nodetextliteral}]"; 84 85 // Avoid problems with quotes. 86 $isbranch = ($branch) ? $hasbranch : ''; 87 if ($collapsed === true) { 88 $iscollapsed = $hascollapsed; 89 } else if ($collapsed === false) { 90 $iscollapsed = $notcollapsed; 91 } else { 92 $iscollapsed = 'li/p'; 93 } 94 95 // First check root nodes, it can be a span or link. 96 $xpath = "//ul{$hasblocktree}/{$hascollapsed}{$isbranch}/span{$match}|"; 97 $xpath .= "//ul{$hasblocktree}/{$hascollapsed}{$isbranch}/a{$match}|"; 98 99 // Next search for the node containing the text within a link. 100 $xpath .= "//ul{$hasblocktree}//ul/{$iscollapsed}{$isbranch}/a{$match}|"; 101 102 // Finally search for the node containing the text within a span. 103 $xpath .= "//ul{$hasblocktree}//ul/{$iscollapsed}{$isbranch}/span{$match}"; 104 105 $node = $this->find('xpath', $xpath, $exception); 106 $this->ensure_node_is_visible($node); 107 return $node; 108 } 109 110 /** 111 * Returns true if the navigation node with the given text is expandable. 112 * 113 * @Given /^navigation node "([^"]*)" should be expandable$/ 114 * 115 * @throws ExpectationException 116 * @param string $nodetext 117 * @return bool 118 */ 119 public function navigation_node_should_be_expandable($nodetext) { 120 if (!$this->running_javascript()) { 121 // Nodes are only expandable when JavaScript is enabled. 122 return false; 123 } 124 125 $node = $this->get_node_text_node($nodetext, true); 126 $node = $node->getParent(); 127 if ($node->hasClass('emptybranch')) { 128 throw new ExpectationException('The "' . $nodetext . '" node is not expandable', $this->getSession()); 129 } 130 131 return true; 132 } 133 134 /** 135 * Returns true if the navigation node with the given text is not expandable. 136 * 137 * @Given /^navigation node "([^"]*)" should not be expandable$/ 138 * 139 * @throws ExpectationException 140 * @param string $nodetext 141 * @return bool 142 */ 143 public function navigation_node_should_not_be_expandable($nodetext) { 144 if (!$this->running_javascript()) { 145 // Nodes are only expandable when JavaScript is enabled. 146 return false; 147 } 148 149 $node = $this->get_node_text_node($nodetext); 150 $node = $node->getParent(); 151 152 if ($node->hasClass('emptybranch') || $node->hasClass('tree_item')) { 153 return true; 154 } 155 throw new ExpectationException('The "' . $nodetext . '" node is expandable', $this->getSession()); 156 } 157 158 /** 159 * Click on an entry in the user menu. 160 * @Given /^I follow "(?P<nodetext_string>(?:[^"]|\\")*)" in the user menu$/ 161 * 162 * @param string $nodetext 163 */ 164 public function i_follow_in_the_user_menu($nodetext) { 165 166 if ($this->running_javascript()) { 167 // The user menu must be expanded when JS is enabled. 168 $xpath = "//div[contains(concat(' ', @class, ' '), ' usermenu ')]//a[contains(concat(' ', @class, ' '), ' dropdown-toggle ')]"; 169 $this->execute("behat_general::i_click_on", array($this->escape($xpath), "xpath_element")); 170 } 171 172 // Now select the link. 173 // The CSS path is always present, with or without JS. 174 $csspath = ".usermenu .dropdown-menu"; 175 176 $this->execute('behat_general::i_click_on_in_the', 177 array($nodetext, "link", $csspath, "css_element") 178 ); 179 } 180 181 /** 182 * Expands the selected node of the navigation tree that matches the text. 183 * @Given /^I expand "(?P<nodetext_string>(?:[^"]|\\")*)" node$/ 184 * 185 * @throws ExpectationException 186 * @param string $nodetext 187 * @return bool|void 188 */ 189 public function i_expand_node($nodetext) { 190 191 // This step is useless with Javascript disabled as Moodle auto expands 192 // all of tree's nodes; adding this because of scenarios that shares the 193 // same steps with and without Javascript enabled. 194 if (!$this->running_javascript()) { 195 if ($nodetext === get_string('administrationsite')) { 196 // Administration menu is not loaded by default any more. Click the link to expand. 197 $this->execute('behat_general::i_click_on_in_the', 198 array($nodetext, "link", get_string('administration'), "block") 199 ); 200 return true; 201 } 202 return true; 203 } 204 205 $node = $this->get_node_text_node($nodetext, true, true, 'The "' . $nodetext . '" node can not be expanded'); 206 // Check if the node is a link AND a branch. 207 if (strtolower($node->getTagName()) === 'a') { 208 // We just want to expand the node, we don't want to follow it. 209 $node = $node->getParent(); 210 } 211 $this->execute('behat_general::i_click_on', [$node, 'NodeElement']); 212 } 213 214 /** 215 * Collapses the selected node of the navigation tree that matches the text. 216 * 217 * @Given /^I collapse "(?P<nodetext_string>(?:[^"]|\\")*)" node$/ 218 * @throws ExpectationException 219 * @param string $nodetext 220 * @return bool|void 221 */ 222 public function i_collapse_node($nodetext) { 223 224 // No collapsible nodes with non-JS browsers. 225 if (!$this->running_javascript()) { 226 return true; 227 } 228 229 $node = $this->get_node_text_node($nodetext, true, false, 'The "' . $nodetext . '" node can not be collapsed'); 230 // Check if the node is a link AND a branch. 231 if (strtolower($node->getTagName()) === 'a') { 232 // We just want to expand the node, we don't want to follow it. 233 $node = $node->getParent(); 234 } 235 $this->execute('behat_general::i_click_on', [$node, 'NodeElement']); 236 } 237 238 /** 239 * Finds a node in the Navigation or Administration tree 240 * 241 * @param string $nodetext 242 * @param array $parentnodes 243 * @param string $nodetype node type (link or text) 244 * @return NodeElement|null 245 * @throws ExpectationException when one of the parent nodes is not found 246 */ 247 protected function find_node_in_navigation($nodetext, $parentnodes, $nodetype = 'link') { 248 // Site admin is different and needs special treatment. 249 $siteadminstr = get_string('administrationsite'); 250 251 // Create array of all parentnodes. 252 $countparentnode = count($parentnodes); 253 254 // If JS is disabled and Site administration is not expanded we 255 // should follow it, so all the lower-level nodes are available. 256 if (!$this->running_javascript()) { 257 if ($parentnodes[0] === $siteadminstr) { 258 // We don't know if there if Site admin is already expanded so 259 // don't wait, it is non-JS and we already waited for the DOM. 260 $siteadminlink = $this->getSession()->getPage()->find('named_exact', array('link', "'" . $siteadminstr . "'")); 261 if ($siteadminlink) { 262 $this->execute('behat_general::i_click_on', [$siteadminlink, 'NodeElement']); 263 } 264 } 265 } 266 267 // Get top level node. 268 $node = $this->get_top_navigation_node($parentnodes[0]); 269 270 // Expand all nodes. 271 for ($i = 0; $i < $countparentnode; $i++) { 272 if ($i > 0) { 273 // Sub nodes within top level node. 274 $node = $this->get_navigation_node($parentnodes[$i], $node); 275 } 276 277 // The p node contains the aria jazz. 278 $pnodexpath = "/p[contains(concat(' ', normalize-space(@class), ' '), ' tree_item ')]"; 279 $pnode = $node->find('xpath', $pnodexpath); 280 $linode = $pnode->getParent(); 281 282 // Keep expanding all sub-parents if js enabled. 283 if ($pnode && $this->running_javascript() && $linode->hasAttribute('aria-expanded') && 284 ($linode->getAttribute('aria-expanded') == "false")) { 285 $this->js_trigger_click($pnode); 286 287 // Wait for node to load, if not loaded before. 288 if ($linode->hasAttribute('data-loaded') && $linode->getAttribute('data-loaded') == "false") { 289 $jscondition = '(document.evaluate("' . $linode->getXpath() . '", document, null, '. 290 'XPathResult.ANY_TYPE, null).iterateNext().getAttribute(\'data-loaded\') == "true")'; 291 292 $this->getSession()->wait(behat_base::get_extended_timeout() * 1000, $jscondition); 293 } 294 } 295 } 296 297 // Finally, click on requested node under navigation. 298 $nodetextliteral = behat_context_helper::escape($nodetext); 299 $tagname = ($nodetype === 'link') ? 'a' : 'span'; 300 $xpath = "/ul/li/p[contains(concat(' ', normalize-space(@class), ' '), ' tree_item ')]" . 301 "/{$tagname}[normalize-space(.)=" . $nodetextliteral . "]"; 302 return $node->find('xpath', $xpath); 303 } 304 305 /** 306 * Finds a node in the Navigation or Administration tree and clicks on it. 307 * 308 * @param string $nodetext 309 * @param array $parentnodes 310 * @throws ExpectationException 311 */ 312 protected function select_node_in_navigation($nodetext, $parentnodes) { 313 $nodetoclick = $this->find_node_in_navigation($nodetext, $parentnodes); 314 // Throw exception if no node found. 315 if (!$nodetoclick) { 316 throw new ExpectationException('Navigation node "' . $nodetext . '" not found under "' . 317 implode(' > ', $parentnodes) . '"', $this->getSession()); 318 } 319 $this->execute('behat_general::i_click_on', [$nodetoclick, 'NodeElement']); 320 } 321 322 /** 323 * Helper function to get top navigation node in tree. 324 * 325 * @throws ExpectationException if note not found. 326 * @param string $nodetext name of top navigation node in tree. 327 * @return NodeElement 328 */ 329 protected function get_top_navigation_node($nodetext) { 330 331 // Avoid problems with quotes. 332 $nodetextliteral = behat_context_helper::escape($nodetext); 333 $exception = new ExpectationException('Top navigation node "' . $nodetext . ' not found in "', $this->getSession()); 334 335 // First find in navigation block. 336 $xpath = "//div[contains(concat(' ', normalize-space(@class), ' '), ' card-text ')]" . 337 "/ul[contains(concat(' ', normalize-space(@class), ' '), ' block_tree ')]" . 338 "/li[contains(concat(' ', normalize-space(@class), ' '), ' contains_branch ')]" . 339 "/ul/li[contains(concat(' ', normalize-space(@class), ' '), ' contains_branch ')]" . 340 "[p[contains(concat(' ', normalize-space(@class), ' '), ' branch ')]" . 341 "/*[contains(normalize-space(.), " . $nodetextliteral .")]]" . 342 "|" . 343 "//div[contains(concat(' ', normalize-space(@class), ' '), ' card-text ')]/div" . 344 "/ul[contains(concat(' ', normalize-space(@class), ' '), ' block_tree ')]" . 345 "/li[p[contains(concat(' ', normalize-space(@class), ' '), ' branch ')]" . 346 "/*[contains(normalize-space(.), " . $nodetextliteral .")]]"; 347 348 $node = $this->find('xpath', $xpath, $exception); 349 350 return $node; 351 } 352 353 /** 354 * Helper function to get sub-navigation node. 355 * 356 * @throws ExpectationException if note not found. 357 * @param string $nodetext node to find. 358 * @param NodeElement $parentnode parent navigation node. 359 * @return NodeElement. 360 */ 361 protected function get_navigation_node($nodetext, $parentnode = null) { 362 363 // Avoid problems with quotes. 364 $nodetextliteral = behat_context_helper::escape($nodetext); 365 366 $xpath = "/ul/li[contains(concat(' ', normalize-space(@class), ' '), ' contains_branch ')]" . 367 "[child::p[contains(concat(' ', normalize-space(@class), ' '), ' branch ')]" . 368 "/child::span[normalize-space(.)=" . $nodetextliteral ."]]"; 369 $node = $parentnode->find('xpath', $xpath); 370 if (!$node) { 371 $xpath = "/ul/li[contains(concat(' ', normalize-space(@class), ' '), ' contains_branch ')]" . 372 "[child::p[contains(concat(' ', normalize-space(@class), ' '), ' branch ')]" . 373 "/child::a[normalize-space(.)=" . $nodetextliteral ."]]"; 374 $node = $parentnode->find('xpath', $xpath); 375 } 376 377 if (!$node) { 378 throw new ExpectationException('Sub-navigation node "' . $nodetext . '" not found under "' . 379 $parentnode->getText() . '"', $this->getSession()); 380 } 381 return $node; 382 } 383 384 /** 385 * Step to open the navigation bar if it is needed. 386 * 387 * The top log in and log out links are hidden when middle or small 388 * size windows (or devices) are used. This step returns a step definition 389 * clicking to expand the navbar if it is hidden. 390 * 391 * @Given /^I expand navigation bar$/ 392 */ 393 public function get_expand_navbar_step() { 394 395 // Checking if we need to click the navbar button to show the navigation menu, it 396 // is hidden by default when using clean theme and a medium or small screen size. 397 398 // The DOM and the JS should be all ready and loaded. Running without spinning 399 // as this is a widely used step and we can not spend time here trying to see 400 // a DOM node that is not always there (at the moment clean is not even the 401 // default theme...). 402 $navbuttonjs = "return ( 403 Y.one('.btn-navbar') && 404 Y.one('.btn-navbar').getComputedStyle('display') !== 'none' 405 )"; 406 407 // Adding an extra click we need to show the 'Log in' link. 408 if (!$this->evaluate_script($navbuttonjs)) { 409 return false; 410 } 411 412 $this->execute('behat_general::i_click_on', array(".btn-navbar", "css_element")); 413 } 414 415 /** 416 * Go to current page setting item 417 * 418 * This can be used on front page, course, category or modules pages. 419 * 420 * @Given /^I navigate to "(?P<nodetext_string>(?:[^"]|\\")*)" in current page administration$/ 421 * 422 * @throws ExpectationException 423 * @param string $nodetext navigation node to click, may contain path, for example "Reports > Overview" 424 * @return void 425 */ 426 public function i_navigate_to_in_current_page_administration($nodetext) { 427 $nodelist = array_map('trim', explode('>', $nodetext)); 428 $this->select_from_administration_menu($nodelist); 429 } 430 431 /** 432 * Checks that current page administration contains text 433 * 434 * @Given /^"(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>[^"]*)" should exist in current page administration$/ 435 * 436 * @throws ExpectationException 437 * @param string $element The locator of the specified selector. 438 * This may be a path, for example "Subscription mode > Forced subscription" 439 * @param string $selectortype The selector type (link or text) 440 * @return void 441 */ 442 public function should_exist_in_current_page_administration($element, $selectortype) { 443 $nodes = array_map('trim', explode('>', $element)); 444 $nodetext = end($nodes); 445 446 // Find administration menu. 447 if (!$menuxpath = $this->find_page_action_menu()) { 448 $menuxpath = $this->find_header_administration_menu() ?: $this->find_page_administration_menu(true); 449 } 450 451 $this->toggle_page_administration_menu($menuxpath); 452 $this->execute('behat_general::should_exist_in_the', [$nodetext, $selectortype, $menuxpath, 'xpath_element']); 453 $this->toggle_page_administration_menu($menuxpath); 454 } 455 456 /** 457 * Checks that current page administration contains text 458 * 459 * @Given /^"(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>[^"]*)" should not exist in current page administration$/ 460 * 461 * @throws ExpectationException 462 * @param string $element The locator of the specified selector. 463 * This may be a path, for example "Subscription mode > Forced subscription" 464 * @param string $selectortype The selector type (link or text) 465 * @return void 466 */ 467 public function should_not_exist_in_current_page_administration($element, $selectortype) { 468 $nodes = array_map('trim', explode('>', $element)); 469 $nodetext = end($nodes); 470 471 // Find administration menu. 472 $menuxpath = $this->find_header_administration_menu() ?: $this->find_page_administration_menu(); 473 if (!$menuxpath) { 474 // Menu not found, exit. 475 return; 476 } 477 478 $this->toggle_page_administration_menu($menuxpath); 479 $this->execute('behat_general::should_not_exist_in_the', [$nodetext, $selectortype, $menuxpath, 'xpath_element']); 480 $this->toggle_page_administration_menu($menuxpath); 481 } 482 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 $nodelist = array_map('trim', explode('>', $nodetext)); 494 $this->i_select_from_primary_navigation(get_string('administrationsite')); 495 $this->select_on_administration_page($nodelist); 496 } 497 498 /** 499 * Opens the current users profile page in edit mode. 500 * 501 * @Given /^I open my profile in edit mode$/ 502 * @throws coding_exception 503 * @return void 504 */ 505 public function i_open_my_profile_in_edit_mode() { 506 global $USER; 507 508 $user = $this->get_session_user(); 509 $globuser = $USER; 510 $USER = $user; // We need this set to the behat session user so we can call isloggedin. 511 512 $systemcontext = context_system::instance(); 513 514 $bodynode = $this->find('xpath', 'body'); 515 $bodyclass = $bodynode->getAttribute('class'); 516 $matches = []; 517 if (preg_match('/(?<=^course-|\scourse-)\d+/', $bodyclass, $matches) && !empty($matches)) { 518 $courseid = intval($matches[0]); 519 } else { 520 $courseid = SITEID; 521 } 522 523 if (isloggedin() && !isguestuser($user) && !is_mnet_remote_user($user)) { 524 if (is_siteadmin($user) || has_capability('moodle/user:update', $systemcontext)) { 525 $url = new moodle_url('/user/editadvanced.php', array('id' => $user->id, 'course' => SITEID, 526 'returnto' => 'profile')); 527 } else if (has_capability('moodle/user:editownprofile', $systemcontext)) { 528 $userauthplugin = false; 529 if (!empty($user->auth)) { 530 $userauthplugin = get_auth_plugin($user->auth); 531 } 532 if ($userauthplugin && $userauthplugin->can_edit_profile()) { 533 $url = $userauthplugin->edit_profile_url(); 534 if (empty($url)) { 535 if (empty($course)) { 536 $url = new moodle_url('/user/edit.php', array('id' => $user->id, 'returnto' => 'profile')); 537 } else { 538 $url = new moodle_url('/user/edit.php', array('id' => $user->id, 'course' => $courseid, 539 'returnto' => 'profile')); 540 } 541 } 542 543 } 544 } 545 $this->execute('behat_general::i_visit', [$url]); 546 } 547 548 // Restore global user variable. 549 $USER = $globuser; 550 } 551 552 /** 553 * Open a given page, belonging to a plugin or core component. 554 * 555 * The page-type are interpreted by each plugin to work out the 556 * corresponding URL. See the resolve_url method in each class like 557 * behat_mod_forum. That method should document which page types are 558 * recognised, and how the name identifies them. 559 * 560 * For pages belonging to core, the 'core > ' bit is omitted. 561 * 562 * @When /^I am on the (?<page>[^ "]*) page$/ 563 * @When /^I am on the "(?<page>[^"]*)" page$/ 564 * 565 * @param string $page the component and page name. 566 * E.g. 'Admin notifications' or 'core_user > Preferences'. 567 * @throws Exception if the specified page cannot be determined. 568 */ 569 public function i_am_on_page(string $page) { 570 $this->execute('behat_general::i_visit', [$this->resolve_page_helper($page)]); 571 } 572 573 /** 574 * Open a given page logged in as a given user. 575 * 576 * This is like the combination 577 * When I log in as "..." 578 * And I am on the "..." page 579 * but with the advantage that you go straight to the desired page, without 580 * having to wait for the Dashboard to load. 581 * 582 * @When /^I am on the (?<page>[^ "]*) page logged in as (?<username>[^ "]*)$/ 583 * @When /^I am on the "(?<page>[^"]*)" page logged in as (?<username>[^ "]*)$/ 584 * @When /^I am on the (?<page>[^ "]*) page logged in as "(?<username>[^ "]*)"$/ 585 * @When /^I am on the "(?<page>[^"]*)" page logged in as "(?<username>[^ "]*)"$/ 586 * 587 * @param string $page the type of page. E.g. 'Admin notifications' or 'core_user > Preferences'. 588 * @param string $username the name of the user to log in as. E.g. 'admin'. 589 * @throws Exception if the specified page cannot be determined. 590 */ 591 public function i_am_on_page_logged_in_as(string $page, string $username) { 592 self::execute('behat_auth::i_log_in_as', [$username, $this->resolve_page_helper($page)]); 593 } 594 595 /** 596 * Helper used by i_am_on_page() and i_am_on_page_logged_in_as(). 597 * 598 * @param string $page the type of page. E.g. 'Admin notifications' or 'core_user > Preferences'. 599 * @return moodle_url the corresponding URL. 600 */ 601 protected function resolve_page_helper(string $page): moodle_url { 602 list($component, $name) = $this->parse_page_name($page); 603 if ($component === 'core') { 604 return $this->resolve_core_page_url($name); 605 } else { 606 $context = behat_context_helper::get('behat_' . $component); 607 return $context->resolve_page_url($name); 608 } 609 } 610 611 /** 612 * Parse a full page name like 'Admin notifications' or 'core_user > Preferences'. 613 * 614 * E.g. parsing 'mod_quiz > View' gives ['mod_quiz', 'View']. 615 * 616 * @param string $page the full page name 617 * @return array with two elements, component and page name. 618 */ 619 protected function parse_page_name(string $page): array { 620 $dividercount = substr_count($page, ' > '); 621 if ($dividercount === 0) { 622 return ['core', $page]; 623 } else if ($dividercount >= 1) { 624 [$component, $name] = explode(' > ', $page, 2); 625 if ($component === 'core') { 626 throw new coding_exception('Do not specify the component "core > ..." for core pages.'); 627 } 628 return [$component, $name]; 629 } else { 630 throw new coding_exception('The page name must be in the form ' . 631 '"{page-name}" for core pages, or "{component} > {page-name}" ' . 632 'for pages belonging to other components. ' . 633 'For example "Admin notifications" or "mod_quiz > View".'); 634 } 635 } 636 637 /** 638 * Open a given instance of a page, belonging to a plugin or core component. 639 * 640 * The instance identifier and page-type are interpreted by each plugin to 641 * work out the corresponding URL. See the resolve_page_instance_url method 642 * in each class like behat_mod_forum. That method should document which page 643 * types are recognised, and how the name identifies them. 644 * 645 * For pages belonging to core, the 'core > ' bit is omitted. 646 * 647 * @When /^I am on the (?<identifier>[^ "]*) (?<type>[^ "]*) page$/ 648 * @When /^I am on the "(?<identifier>[^"]*)" "(?<type>[^"]*)" page$/ 649 * @When /^I am on the (?<identifier>[^ "]*) "(?<type>[^"]*)" page$/ 650 * @When /^I am on the "(?<identifier>[^"]*)" (?<type>[^ "]*) page$/ 651 * 652 * @param string $identifier identifies the particular page. E.g. 'Test quiz'. 653 * @param string $type the component and page type. E.g. 'mod_quiz > View'. 654 * @throws Exception if the specified page cannot be determined. 655 */ 656 public function i_am_on_page_instance(string $identifier, string $type) { 657 $this->execute('behat_general::i_visit', [$this->resolve_page_instance_helper($identifier, $type)]); 658 } 659 660 /** 661 * Open a given page logged in as a given user. 662 * 663 * This is like the combination 664 * When I log in as "..." 665 * And I am on the "..." "..." page 666 * but with the advantage that you go straight to the desired page, without 667 * having to wait for the Dashboard to load. 668 * 669 * @When /^I am on the (?<identifier>[^ "]*) (?<type>[^ "]*) page logged in as (?<username>[^ "]*)$/ 670 * @When /^I am on the "(?<identifier>[^"]*)" "(?<type>[^"]*)" page logged in as (?<username>[^ "]*)$/ 671 * @When /^I am on the (?<identifier>[^ "]*) "(?<type>[^"]*)" page logged in as (?<username>[^ "]*)$/ 672 * @When /^I am on the "(?<identifier>[^"]*)" (?<type>[^ "]*) page logged in as (?<username>[^ "]*)$/ 673 * @When /^I am on the (?<identifier>[^ "]*) (?<type>[^ "]*) page logged in as "(?<username>[^"]*)"$/ 674 * @When /^I am on the "(?<identifier>[^"]*)" "(?<type>[^"]*)" page logged in as "(?<username>[^"]*)"$/ 675 * @When /^I am on the (?<identifier>[^ "]*) "(?<type>[^"]*)" page logged in as "(?<username>[^"]*)"$/ 676 * @When /^I am on the "(?<identifier>[^"]*)" (?<type>[^ "]*) page logged in as "(?<username>[^"]*)"$/ 677 * 678 * @param string $identifier identifies the particular page. E.g. 'Test quiz'. 679 * @param string $type the component and page type. E.g. 'mod_quiz > View'. 680 * @param string $username the name of the user to log in as. E.g. 'student'. 681 * @throws Exception if the specified page cannot be determined. 682 */ 683 public function i_am_on_page_instance_logged_in_as(string $identifier, 684 string $type, string $username) { 685 self::execute('behat_auth::i_log_in_as', 686 [$username, $this->resolve_page_instance_helper($identifier, $type)]); 687 } 688 689 /** 690 * Helper used by i_am_on_page() and i_am_on_page_logged_in_as(). 691 * 692 * @param string $identifier identifies the particular page. E.g. 'Test quiz'. 693 * @param string $pagetype the component and page type. E.g. 'mod_quiz > View'. 694 * @return moodle_url the corresponding URL. 695 */ 696 protected function resolve_page_instance_helper(string $identifier, string $pagetype): moodle_url { 697 list($component, $type) = $this->parse_page_name($pagetype); 698 if ($component === 'core') { 699 return $this->resolve_core_page_instance_url($type, $identifier); 700 } else { 701 $context = behat_context_helper::get('behat_' . $component); 702 return $context->resolve_page_instance_url($type, $identifier); 703 } 704 } 705 706 /** 707 * Convert core page names to URLs for steps like 'When I am on the "[page name]" page'. 708 * 709 * Recognised page names are: 710 * | Homepage | Homepage (normally dashboard). | 711 * | Admin notifications | Admin notification screen. | 712 * 713 * @param string $name identifies which identifies this page, e.g. 'Homepage', 'Admin notifications'. 714 * @return moodle_url the corresponding URL. 715 * @throws Exception with a meaningful error message if the specified page cannot be found. 716 */ 717 protected function resolve_core_page_url(string $name): moodle_url { 718 switch ($name) { 719 case 'Homepage': 720 return new moodle_url('/'); 721 722 case 'My courses': 723 return new moodle_url('/my/courses.php'); 724 725 case 'Admin notifications': 726 return new moodle_url('/admin/'); 727 728 default: 729 throw new Exception('Unrecognised core page type "' . $name . '."'); 730 } 731 } 732 733 /** 734 * Convert page names to URLs for steps like 'When I am on the "[identifier]" "[page type]" page'. 735 * 736 * Recognised page names are: 737 * | Page type | Identifier meaning | description | 738 * | Category | category idnumber | List of courses in that category. | 739 * | Course | course shortname | Main course home pag | 740 * | Course editing | course shortname | Edit settings page for the course | 741 * | Activity | activity idnumber | Start page for that activity | 742 * | Activity editing | activity idnumber | Edit settings page for that activity | 743 * | [modname] Activity | activity name or idnumber | Start page for that activity | 744 * | [modname] Activity editing | activity name or idnumber | Edit settings page for that activity | 745 * | Backup | course shortname | Course to backup | 746 * | Import | course shortname | Course import from | 747 * | Restore | course shortname | Course to restore from | 748 * | Reset | course shortname | Course to reset | 749 * | Course copy | course shortname | Course to copy | 750 * | Groups | course shortname | Groups page for the course | 751 * | Permissions | course shortname | Permissions page for the course | 752 * | Enrolment methods | course shortname | Enrolment methods for the course | 753 * | Enrolled users | course shortname | The main participants page | 754 * | Other users | course shortname | The course other users page | 755 * 756 * Examples: 757 * 758 * When I am on the "Welcome to ECON101" "forum activity" page logged in as student1 759 * 760 * @param string $type identifies which type of page this is, e.g. 'Category page'. 761 * @param string $identifier identifies the particular page, e.g. 'test-cat'. 762 * @return moodle_url the corresponding URL. 763 * @throws Exception with a meaningful error message if the specified page cannot be found. 764 */ 765 protected function resolve_core_page_instance_url(string $type, string $identifier): moodle_url { 766 $type = strtolower($type); 767 768 switch ($type) { 769 case 'category': 770 $categoryid = $this->get_category_id($identifier); 771 if (!$categoryid) { 772 throw new Exception('The specified category with idnumber "' . $identifier . '" does not exist'); 773 } 774 return new moodle_url('/course/index.php', ['categoryid' => $categoryid]); 775 776 case 'course editing': 777 $courseid = $this->get_course_id($identifier); 778 if (!$courseid) { 779 throw new Exception('The specified course with shortname, fullname, or idnumber "' . 780 $identifier . '" does not exist'); 781 } 782 return new moodle_url('/course/edit.php', ['id' => $courseid]); 783 784 case 'course': 785 $courseid = $this->get_course_id($identifier); 786 if (!$courseid) { 787 throw new Exception('The specified course with shortname, fullname, or idnumber "' . 788 $identifier . '" does not exist'); 789 } 790 return new moodle_url('/course/view.php', ['id' => $courseid]); 791 792 case 'activity': 793 $cm = $this->get_course_module_for_identifier($identifier); 794 if (!$cm) { 795 throw new Exception('The specified activity with idnumber "' . $identifier . '" does not exist'); 796 } 797 return $cm->url; 798 799 case 'activity editing': 800 $cm = $this->get_course_module_for_identifier($identifier); 801 if (!$cm) { 802 throw new Exception('The specified activity with idnumber "' . $identifier . '" does not exist'); 803 } 804 return new moodle_url('/course/modedit.php', [ 805 'update' => $cm->id, 806 ]); 807 case 'backup': 808 $courseid = $this->get_course_id($identifier); 809 if (!$courseid) { 810 throw new Exception('The specified course with shortname, fullname, or idnumber "' . 811 $identifier . '" does not exist'); 812 } 813 return new moodle_url('/backup/backup.php', ['id' => $courseid]); 814 case 'import': 815 $courseid = $this->get_course_id($identifier); 816 if (!$courseid) { 817 throw new Exception('The specified course with shortname, fullname, or idnumber "' . 818 $identifier . '" does not exist'); 819 } 820 return new moodle_url('/backup/import.php', ['id' => $courseid]); 821 case 'restore': 822 $courseid = $this->get_course_id($identifier); 823 if (!$courseid) { 824 throw new Exception('The specified course with shortname, fullname, or idnumber "' . 825 $identifier . '" does not exist'); 826 } 827 $context = context_course::instance($courseid); 828 return new moodle_url('/backup/restorefile.php', ['contextid' => $context->id]); 829 case 'reset': 830 $courseid = $this->get_course_id($identifier); 831 if (!$courseid) { 832 throw new Exception('The specified course with shortname, fullname, or idnumber "' . 833 $identifier . '" does not exist'); 834 } 835 return new moodle_url('/course/reset.php', ['id' => $courseid]); 836 case 'course copy': 837 $courseid = $this->get_course_id($identifier); 838 if (!$courseid) { 839 throw new Exception('The specified course with shortname, fullname, or idnumber "' . 840 $identifier . '" does not exist'); 841 } 842 return new moodle_url('/backup/copy.php', ['id' => $courseid]); 843 case 'groups': 844 $courseid = $this->get_course_id($identifier); 845 if (!$courseid) { 846 throw new Exception('The specified course with shortname, fullname, or idnumber "' . 847 $identifier . '" does not exist'); 848 } 849 return new moodle_url('/group/index.php', ['id' => $courseid]); 850 case 'permissions': 851 $courseid = $this->get_course_id($identifier); 852 if (!$courseid) { 853 throw new Exception('The specified course with shortname, fullname, or idnumber "' . 854 $identifier . '" does not exist'); 855 } 856 $context = context_course::instance($courseid); 857 return new moodle_url('/admin/roles/permissions.php', ['contextid' => $context->id]); 858 case 'enrolment methods': 859 $courseid = $this->get_course_id($identifier); 860 if (!$courseid) { 861 throw new Exception('The specified course with shortname, fullname, or idnumber "' . 862 $identifier . '" does not exist'); 863 } 864 return new moodle_url('/enrol/instances.php', ['id' => $courseid]); 865 case 'enrolled users': 866 $courseid = $this->get_course_id($identifier); 867 if (!$courseid) { 868 throw new Exception('The specified course with shortname, fullname, or idnumber "' . 869 $identifier . '" does not exist'); 870 } 871 return new moodle_url('/user/index.php', ['id' => $courseid]); 872 case 'other users': 873 $courseid = $this->get_course_id($identifier); 874 if (!$courseid) { 875 throw new Exception('The specified course with shortname, fullname, or idnumber "' . 876 $identifier . '" does not exist'); 877 } 878 return new moodle_url('/enrol/otherusers.php', ['id' => $courseid]); 879 } 880 881 $parts = explode(' ', $type); 882 if (count($parts) > 1) { 883 if ($parts[1] === 'activity') { 884 $modname = $parts[0]; 885 $cm = $this->get_cm_by_activity_name($modname, $identifier); 886 887 if (count($parts) == 2) { 888 // View page. 889 return new moodle_url($cm->url); 890 } 891 892 if ($parts[2] === 'editing') { 893 // Edit settings page. 894 return new moodle_url('/course/modedit.php', ['update' => $cm->id]); 895 } 896 897 if ($parts[2] === 'roles') { 898 // Locally assigned roles page. 899 return new moodle_url('/admin/roles/assign.php', ['contextid' => $cm->context->id]); 900 } 901 902 if ($parts[2] === 'permissions') { 903 // Permissions page. 904 return new moodle_url('/admin/roles/permissions.php', ['contextid' => $cm->context->id]); 905 } 906 } 907 } 908 909 throw new Exception('Unrecognised core page type "' . $type . '."'); 910 } 911 912 /** 913 * Opens a new tab with given name on the same URL as current page and switches to it. 914 * 915 * @param string $name Tab name that can be used for switching later (no whitespace) 916 * @When /^I open a tab named "(?<name>[^"]*)" on the current page$/ 917 */ 918 public function i_open_a_tab_on_the_current_page(string $name): void { 919 $this->open_tab($name, 'location.href'); 920 } 921 922 /** 923 * Opens a new tab with given name on specified page, and switches to it. 924 * 925 * @param string $name Tab name that can be used for switching later (no whitespace) 926 * @param string $page Page name 927 * @When /^I open a tab named "(?<name>[^"]*)" on the "(?<page>[^"]*)" page$/ 928 */ 929 public function i_open_a_tab_on_the_page(string $name, string $page): void { 930 if ($page === 'current') { 931 $jstarget = 'location.href'; 932 } else { 933 $jstarget = '"' . addslashes_js($this->resolve_page_helper($page)->out(false)) . '"'; 934 } 935 $this->open_tab($name, $jstarget); 936 } 937 938 /** 939 * Opens a new tab with given name (on specified page), and switches to it. 940 * 941 * @param string $name Tab name that can be used for switching later (no whitespace) 942 * @param string $identifier Page identifier 943 * @param string $page Page type 944 * @When /^I open a tab named "(?<name>[^"]*)" on the "(?<identifier>[^"]*)" "(?<page>[^"]*)" page$/ 945 */ 946 public function i_open_a_tab_on_the_page_instance(string $name, string $identifier, string $page): void { 947 $this->open_tab($name, '"' . addslashes_js( 948 $this->resolve_page_instance_helper($identifier, $page)->out(false)) . '"'); 949 } 950 951 /** 952 * Opens a new tab at the given target URL. 953 * 954 * @param string $name Name for tab 955 * @param string $jstarget Target in JavaScript syntax, i.e. if a string, must be quoted 956 */ 957 protected function open_tab(string $name, string $jstarget): void { 958 // Tab names aren't allowed spaces, and our JavaScript below doesn't do any escaping. 959 if (clean_param($name, PARAM_ALPHANUMEXT) !== $name) { 960 throw new Exception('Tab name may not contain whitespace or special characters: "' . $name . '"'); 961 } 962 963 // Normally you can't open a tab unless in response to a user action, but presumably Behat 964 // is exempt from this restriction, because it works to just open it directly. 965 $this->execute_script('window.open(' . $jstarget . ', "' . $name . '");'); 966 $this->execute('behat_general::switch_to_window', [$name]); 967 } 968 969 /** 970 * Opens the course homepage. (Consider using 'I am on the "shortname" "Course" page' step instead.) 971 * 972 * @Given /^I am on "(?P<coursefullname_string>(?:[^"]|\\")*)" course homepage$/ 973 * @throws coding_exception 974 * @param string $coursefullname The full name of the course. 975 * @return void 976 */ 977 public function i_am_on_course_homepage($coursefullname) { 978 $courseid = $this->get_course_id($coursefullname); 979 $url = new moodle_url('/course/view.php', ['id' => $courseid]); 980 $this->execute('behat_general::i_visit', [$url]); 981 } 982 983 /** 984 * Open the course homepage with editing mode enabled. 985 * 986 * @param string $coursefullname The course full name of the course. 987 */ 988 public function i_am_on_course_homepage_with_editing_mode_on($coursefullname) { 989 $this->i_am_on_course_homepage_with_editing_mode_set_to($coursefullname, 'on'); 990 } 991 992 /** 993 * Open the course homepage with editing mode set to either on, or off. 994 * 995 * @Given I am on :coursefullname course homepage with editing mode :onoroff 996 * @throws coding_exception 997 * @param string $coursefullname The course full name of the course. 998 * @param string $onoroff Whehter to switch editing on, or off. 999 */ 1000 public function i_am_on_course_homepage_with_editing_mode_set_to(string $coursefullname, string $onoroff): void { 1001 if ($onoroff !== 'on' && $onoroff !== 'off') { 1002 throw new coding_exception("Unknown editing mode '{$onoroff}'. Accepted values are 'on' and 'off'"); 1003 } 1004 1005 $courseid = $this->get_course_id($coursefullname); 1006 $context = context_course::instance($courseid); 1007 $courseurl = new moodle_url('/course/view.php', ['id' => $courseid]); 1008 1009 $editmodeurl = new moodle_url('/editmode.php', [ 1010 'context' => $context->id, 1011 'pageurl' => $courseurl->out(true), 1012 'setmode' => ($onoroff === 'on' ? 1 : 0), 1013 ]); 1014 $this->execute('behat_general::i_visit', [$editmodeurl]); 1015 } 1016 1017 /** 1018 * Opens the flat navigation drawer if it is not already open 1019 * 1020 * @When /^I open flat navigation drawer$/ 1021 * @throws ElementNotFoundException Thrown by behat_base::find 1022 */ 1023 public function i_open_flat_navigation_drawer() { 1024 if (!$this->running_javascript()) { 1025 // Navigation drawer is always open without JS. 1026 return; 1027 } 1028 $xpath = "//button[contains(@data-action,'toggle-drawer')]"; 1029 $node = $this->find('xpath', $xpath); 1030 $expanded = $node->getAttribute('aria-expanded'); 1031 if ($expanded === 'false') { 1032 $this->execute('behat_general::i_click_on', [$node, 'NodeElement']); 1033 $this->ensure_node_attribute_is_set($node, 'aria-expanded', 'true'); 1034 } 1035 } 1036 1037 /** 1038 * Closes the flat navigation drawer if it is open (does nothing if JS disabled) 1039 * 1040 * @When /^I close flat navigation drawer$/ 1041 * @throws ElementNotFoundException Thrown by behat_base::find 1042 */ 1043 public function i_close_flat_navigation_drawer() { 1044 if (!$this->running_javascript()) { 1045 // Navigation drawer can not be closed without JS. 1046 return; 1047 } 1048 $xpath = "//button[contains(@data-action,'toggle-drawer')]"; 1049 $node = $this->find('xpath', $xpath); 1050 $expanded = $node->getAttribute('aria-expanded'); 1051 if ($expanded === 'true') { 1052 $this->execute('behat_general::i_click_on', [$node, 'NodeElement']); 1053 } 1054 } 1055 1056 /** 1057 * Clicks link with specified id|title|alt|text in the primary navigation 1058 * 1059 * @When /^I select "(?P<link_string>(?:[^"]|\\")*)" from primary navigation$/ 1060 * @throws ElementNotFoundException Thrown by behat_base::find 1061 * @param string $link 1062 */ 1063 public function i_select_from_primary_navigation(string $link) { 1064 $this->execute('behat_general::i_click_on_in_the', 1065 [$link, 'link', '.primary-navigation .moremenu.navigation', 'css_element'] 1066 ); 1067 } 1068 1069 /** 1070 * Clicks link with specified id|title|alt|text in the secondary navigation 1071 * 1072 * @When I select :link from secondary navigation 1073 * @throws ElementNotFoundException Thrown by behat_base::find 1074 * @param string $link 1075 */ 1076 public function i_select_from_secondary_navigation(string $link) { 1077 $this->execute('behat_general::i_click_on_in_the', 1078 [$link, 'link', '.secondary-navigation .moremenu.navigation', 'css_element'] 1079 ); 1080 } 1081 1082 /** 1083 * If we are not on the course main page, click on the course link in the navbar 1084 */ 1085 protected function go_to_main_course_page() { 1086 $url = $this->getSession()->getCurrentUrl(); 1087 if (!preg_match('|/course/view.php\?id=[\d]+$|', $url)) { 1088 $node = $this->find('xpath', 1089 '//header//div[@id=\'page-navbar\']//a[contains(@href,\'/course/view.php?id=\')]' 1090 ); 1091 $this->execute('behat_general::i_click_on', [$node, 'NodeElement']); 1092 } 1093 } 1094 1095 /** 1096 * Finds and clicks a link on the admin page (site administration or course administration) 1097 * 1098 * @param array $nodelist 1099 */ 1100 protected function select_on_administration_page($nodelist) { 1101 $parentnodes = $nodelist; 1102 $lastnode = array_pop($parentnodes); 1103 $xpath = '//section[@id=\'region-main\']'; 1104 1105 // Check if there is a separate tab for this submenu of the page. If found go to it. 1106 if ($parentnodes) { 1107 $tabname = behat_context_helper::escape($parentnodes[0]); 1108 $tabxpath = '//ul[@role=\'tablist\']/li/a[contains(normalize-space(.), ' . $tabname . ')]'; 1109 $menubarxpath = '//ul[@role=\'menubar\']/li/a[contains(normalize-space(.), ' . $tabname . ')]'; 1110 $linkname = behat_context_helper::escape(get_string('moremenu')); 1111 $menubarmorexpath = '//ul[contains(@class,\'more-nav\')]/li/a[contains(normalize-space(.), ' . $linkname . ')]'; 1112 $tabnode = $this->getSession()->getPage()->find('xpath', $tabxpath); 1113 $menunode = $this->getSession()->getPage()->find('xpath', $menubarxpath); 1114 $menubuttons = $this->getSession()->getPage()->findAll('xpath', $menubarmorexpath); 1115 if ($tabnode || $menunode) { 1116 $node = is_object($tabnode) ? $tabnode : $menunode; 1117 if ($this->running_javascript()) { 1118 $this->execute('behat_general::i_click_on', [$node, 'NodeElement']); 1119 // Click on the tab and add 'active' tab to the xpath. 1120 $xpath .= '//div[contains(@class,\'active\')]'; 1121 } else { 1122 // Add the tab content selector to the xpath. 1123 $tabid = behat_context_helper::escape(ltrim($node->getAttribute('href'), '#')); 1124 $xpath .= '//div[@id = ' . $tabid . ']'; 1125 } 1126 array_shift($parentnodes); 1127 } else if (count($menubuttons) > 0) { 1128 try { 1129 $menubuttons[0]->isVisible(); 1130 try { 1131 $this->execute('behat_general::i_click_on', [$menubuttons[1], 'NodeElement']); 1132 } catch (Exception $e) { 1133 $this->execute('behat_general::i_click_on', [$menubuttons[0], 'NodeElement']); 1134 } 1135 $moreitemxpath = '//ul[@data-region=\'moredropdown\']/li/a[contains(normalize-space(.), ' . $tabname . ')]'; 1136 if ($morenode = $this->getSession()->getPage()->find('xpath', $moreitemxpath)) { 1137 $this->execute('behat_general::i_click_on', [$morenode, 'NodeElement']); 1138 $xpath .= '//div[contains(@class,\'active\')]'; 1139 array_shift($parentnodes); 1140 } 1141 } catch (Exception $e) { 1142 } 1143 } 1144 } 1145 1146 // Find a section with the parent name in it. 1147 if ($parentnodes) { 1148 // Find the section on the page (links may be repeating in different sections). 1149 $section = behat_context_helper::escape($parentnodes[0]); 1150 $xpath .= '//div[@class=\'row\' and contains(.,'.$section.')]'; 1151 } 1152 1153 // Find a link and click on it. 1154 $linkname = behat_context_helper::escape($lastnode); 1155 $xpathlink = $xpathbutton = $xpath; 1156 $xpathlink .= '//a[contains(normalize-space(.), ' . $linkname . ')]'; 1157 $xpathbutton .= '//button[contains(normalize-space(.), ' . $linkname . ')]'; 1158 if ($node = $this->getSession()->getPage()->find('xpath', $xpathbutton)) { 1159 $this->execute('behat_general::i_click_on', [$node, 'NodeElement']); 1160 } else if (!$node = $this->getSession()->getPage()->find('xpath', $xpathlink)) { 1161 throw new ElementNotFoundException($this->getSession(), 'Link "' . join(' > ', $nodelist) . '"'); 1162 } else { 1163 $this->execute('behat_general::i_click_on', [$node, 'NodeElement']); 1164 } 1165 } 1166 1167 /** 1168 * Locates the administration menu in the <header> element and returns its xpath 1169 * 1170 * @param bool $mustexist if specified throws an exception if menu is not found 1171 * @return null|string 1172 */ 1173 protected function find_header_administration_menu($mustexist = false) { 1174 $menuxpath = '//div[contains(@class,\'secondary-navigation\')]//nav[contains(@class,\'moremenu\')]'; 1175 1176 if ($mustexist) { 1177 $exception = new ElementNotFoundException($this->getSession(), 'Page header administration menu'); 1178 $this->find('xpath', $menuxpath, $exception); 1179 } else if (!$this->getSession()->getPage()->find('xpath', $menuxpath)) { 1180 return null; 1181 } 1182 return $menuxpath; 1183 } 1184 1185 /** 1186 * Locates the administration menu on the page (but not in the header) and returns its xpath 1187 * 1188 * @param bool $mustexist if specified throws an exception if menu is not found 1189 * @return null|string 1190 */ 1191 protected function find_page_administration_menu($mustexist = false) { 1192 $menuxpath = '//div[@id=\'region-main-settings-menu\']'; 1193 if ($mustexist) { 1194 $exception = new ElementNotFoundException($this->getSession(), 'Page administration menu'); 1195 $this->find('xpath', $menuxpath, $exception); 1196 } else if (!$this->getSession()->getPage()->find('xpath', $menuxpath)) { 1197 return null; 1198 } 1199 return $menuxpath; 1200 } 1201 1202 /** 1203 * Locates the action menu on the page (but not in the header) and returns its xpath 1204 * 1205 * @param null|bool $mustexist if specified throws an exception if menu is not found 1206 * @return null|string 1207 */ 1208 protected function find_page_action_menu($mustexist = false) { 1209 $menuxpath = '//div[@id=\'action-menu-0-menubar\']'; 1210 1211 if ($mustexist) { 1212 $exception = new ElementNotFoundException($this->getSession(), 'Page check'); 1213 $this->find('xpath', $menuxpath, $exception); 1214 } else if (!$this->getSession()->getPage()->find('xpath', $menuxpath)) { 1215 return null; 1216 } 1217 return $menuxpath; 1218 } 1219 1220 /** 1221 * Toggles administration menu 1222 * 1223 * @param string $menuxpath (optional) xpath to the page administration menu if already known 1224 */ 1225 protected function toggle_page_administration_menu($menuxpath = null) { 1226 if (!$menuxpath) { 1227 $menuxpath = $this->find_header_administration_menu() ?: $this->find_page_administration_menu(); 1228 } 1229 if ($menuxpath && $this->running_javascript()) { 1230 $node = $this->find('xpath', $menuxpath . '//a[@data-toggle=\'dropdown\']'); 1231 if ($node->isVisible()) { 1232 $this->execute('behat_general::i_click_on', [$node, 'NodeElement']); 1233 } 1234 } 1235 } 1236 1237 /** 1238 * Finds a page edit cog and select an item from it 1239 * 1240 * If the page edit cog is in the page header and the item is not found there, click "More..." link 1241 * and find the item on the course/frontpage administration page 1242 * 1243 * @param array $nodelist 1244 * @throws ElementNotFoundException 1245 */ 1246 protected function select_from_administration_menu($nodelist) { 1247 // Find administration menu. 1248 if ($menuxpath = $this->find_header_administration_menu()) { 1249 $isheader = true; 1250 } else if ($menuxpath = $this->find_page_action_menu(true)) { 1251 $isheader = false; 1252 } else { 1253 $menuxpath = $this->find_page_administration_menu(true); 1254 $isheader = false; 1255 } 1256 1257 $this->execute('behat_navigation::toggle_page_administration_menu', [$menuxpath]); 1258 1259 $firstnode = $nodelist[0]; 1260 $firstlinkname = behat_context_helper::escape($firstnode); 1261 $firstlink = $this->getSession()->getPage()->find('xpath', 1262 $menuxpath . '//a[contains(normalize-space(.), ' . $firstlinkname . ')]' 1263 ); 1264 1265 if (!$isheader || count($nodelist) == 1) { 1266 $lastnode = end($nodelist); 1267 $linkname = behat_context_helper::escape($lastnode); 1268 $link = $this->getSession()->getPage()->find('xpath', $menuxpath . '//a[contains(normalize-space(.), ' . $linkname . ')]'); 1269 if ($link) { 1270 $this->execute('behat_general::i_click_on', [$link, 'NodeElement']); 1271 return; 1272 } 1273 } else if ($firstlink) { 1274 $this->execute('behat_general::i_click_on', [$firstlink, 'NodeElement']); 1275 array_splice($nodelist, 0, 1); 1276 $this->select_on_administration_page($nodelist); 1277 return; 1278 } 1279 1280 if ($isheader) { 1281 // Front page administration will have subnodes under "More...". 1282 $linkname = behat_context_helper::escape(get_string('morenavigationlinks')); 1283 $link = $this->getSession()->getPage()->find('xpath', 1284 $menuxpath . '//a[contains(normalize-space(.), ' . $linkname . ')]' 1285 ); 1286 // Course administration will have subnodes under "Course administration". 1287 $courselinkname = behat_context_helper::escape(get_string('courseadministration')); 1288 $courselink = $this->getSession()->getPage()->find('xpath', 1289 $menuxpath . '//a[contains(normalize-space(.), ' . $courselinkname . ')]' 1290 ); 1291 if ($link) { 1292 $this->execute('behat_general::i_click_on', [$link, 'NodeElement']); 1293 $this->select_on_administration_page($nodelist); 1294 return; 1295 } else if ($courselink) { 1296 $this->execute('behat_general::i_click_on', [$courselink, 'NodeElement']); 1297 $this->select_on_administration_page($nodelist); 1298 return; 1299 } 1300 } 1301 1302 throw new ElementNotFoundException($this->getSession(), 1303 'Link "' . join(' > ', $nodelist) . '" in the current page edit menu"'); 1304 } 1305 1306 /** 1307 * Visit a fixture page for testing stuff that is not available in core. 1308 * 1309 * Please always, to prevent unwanted requests, protect behat fixture files with: 1310 * defined('BEHAT_SITE_RUNNING') || die(); 1311 * 1312 * @Given /^I am on fixture page "(?P<url_string>(?:[^"]|\\")*)"$/ 1313 * @param string $url local path to fixture page 1314 */ 1315 public function i_am_on_fixture_page($url) { 1316 $fixtureregex = '|^/[a-z0-9_\-/]*/tests/behat/fixtures/[a-z0-9_\-]*\.php$|'; 1317 if (!preg_match($fixtureregex, $url)) { 1318 throw new coding_exception("URL {$url} is not a fixture URL"); 1319 } 1320 $this->execute('behat_general::i_visit', [$url]); 1321 } 1322 1323 /** 1324 * First checks to see if we are on this page via the breadcrumb. If not we then attempt to follow the link name given. 1325 * 1326 * @param string $pagename Name of the breadcrumb item to check and follow. 1327 * @Given /^I follow the breadcrumb "(?P<url_string>(?:[^"]|\\")*)"$/ 1328 */ 1329 public function go_to_breadcrumb_location(string $pagename): void { 1330 $link = $this->getSession()->getPage()->find( 1331 'xpath', 1332 "//nav[@aria-label='Navigation bar']/ol/li[last()][contains(normalize-space(.), '" . $pagename . "')]" 1333 ); 1334 if (!$link) { 1335 $this->execute("behat_general::i_click_on_in_the", [$pagename, 'link', 'page', 'region']); 1336 } 1337 } 1338 1339 /** 1340 * Checks whether an item exists in the user menu. 1341 * 1342 * @Given :itemtext :selectortype should exist in the user menu 1343 * @Given :itemtext :selectortype should :not exist in the user menu 1344 * 1345 * @throws ElementNotFoundException 1346 * @param string $itemtext The menu item to find 1347 * @param string $selectortype The selector type 1348 * @param string|null $not Instructs to checks whether the element does not exist in the user menu, if defined 1349 * @return void 1350 */ 1351 public function should_exist_in_user_menu($itemtext, $selectortype, $not = null) { 1352 $callfunction = is_null($not) ? 'should_exist_in_the' : 'should_not_exist_in_the'; 1353 $this->execute("behat_general::{$callfunction}", 1354 [$itemtext, $selectortype, $this->get_user_menu_xpath(), 'xpath_element']); 1355 } 1356 1357 /** 1358 * Checks whether an item exists in a given user submenu. 1359 * 1360 * @Given :itemtext :selectortype should exist in the :submenuname user submenu 1361 * @Given :itemtext :selectortype should :not exist in the :submenuname user submenu 1362 * 1363 * @throws ElementNotFoundException 1364 * @param string $itemtext The submenu item to find 1365 * @param string $selectortype The selector type 1366 * @param string $submenuname The name of the submenu 1367 * @param string|null $not Instructs to checks whether the element does not exist in the user menu, if defined 1368 * @return void 1369 */ 1370 public function should_exist_in_user_submenu($itemtext, $selectortype, $submenuname, $not = null) { 1371 $callfunction = is_null($not) ? 'should_exist_in_the' : 'should_not_exist_in_the'; 1372 $this->execute("behat_general::{$callfunction}", 1373 [$itemtext, $selectortype, $this->get_user_submenu_xpath($submenuname), 'xpath_element']); 1374 } 1375 1376 /** 1377 * Checks whether a given user submenu is visible. 1378 * 1379 * @Then /^I should see "(?P<submenu_string>[^"]*)" user submenu$/ 1380 * 1381 * @throws ElementNotFoundException 1382 * @throws ExpectationException 1383 * @param string $submenuname The name of the submenu 1384 * @return void 1385 */ 1386 public function i_should_see_user_submenu($submenuname) { 1387 $this->execute('behat_general::should_be_visible', 1388 array($this->get_user_submenu_xpath($submenuname), 'xpath_element')); 1389 } 1390 1391 /** 1392 * Return the xpath for the user menu element. 1393 * 1394 * @return string The xpath 1395 */ 1396 protected function get_user_menu_xpath() { 1397 return "//div[contains(concat(' ', @class, ' '), ' usermenu ')]" . 1398 "//div[contains(concat(' ', @class, ' '), ' dropdown-menu ')]" . 1399 "//div[@id='carousel-item-main']"; 1400 } 1401 1402 /** 1403 * Return the xpath for a given user submenu element. 1404 * 1405 * @param string $submenuname The name of the submenu 1406 * @return string The xpath 1407 */ 1408 protected function get_user_submenu_xpath($submenuname) { 1409 return "//div[contains(concat(' ', @class, ' '), ' usermenu ')]" . 1410 "//div[contains(concat(' ', @class, ' '), ' dropdown-menu ')]" . 1411 "//div[contains(concat(' ', @class, ' '), ' submenu ')][@aria-label='" . $submenuname . "']"; 1412 } 1413 1414 /** 1415 * Returns whether the user can edit the current page. 1416 * 1417 * @return bool 1418 */ 1419 protected function is_editing_on() { 1420 $body = $this->find('xpath', "//body", false, false, 0); 1421 return $body->hasClass('editing'); 1422 } 1423 1424 /** 1425 * Turns editing mode on. 1426 * @Given I switch editing mode on 1427 * @Given I turn editing mode on 1428 */ 1429 public function i_turn_editing_mode_on() { 1430 $this->execute('behat_forms::i_set_the_field_to', [get_string('editmode'), 1]); 1431 1432 if (!$this->running_javascript()) { 1433 $this->execute('behat_general::i_click_on', [ 1434 get_string('setmode', 'core'), 1435 'button', 1436 ]); 1437 } 1438 1439 if (!$this->is_editing_on()) { 1440 throw new ExpectationException('The edit mode could not be turned on', $this->getSession()); 1441 } 1442 } 1443 1444 /** 1445 * Turns editing mode off. 1446 * @Given I switch editing mode off 1447 * @Given I turn editing mode off 1448 */ 1449 public function i_turn_editing_mode_off() { 1450 $this->execute('behat_forms::i_set_the_field_to', [get_string('editmode'), 0]); 1451 1452 if (!$this->running_javascript()) { 1453 $this->execute('behat_general::i_click_on', [ 1454 get_string('setmode', 'core'), 1455 'button', 1456 ]); 1457 } 1458 1459 if ($this->is_editing_on()) { 1460 throw new ExpectationException('The edit mode could not be turned off', $this->getSession()); 1461 } 1462 } 1463 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
