93b886036925217c0721bfe4f72c7be5001d1c6c
[moodle.git] / course / tests / behat / behat_course.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  * Behat course-related steps definitions.
19  *
20  * @package    core_course
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__ . '/../../../lib/behat/behat_base.php');
30 use Behat\Gherkin\Node\TableNode as TableNode,
31     Behat\Mink\Exception\ExpectationException as ExpectationException,
32     Behat\Mink\Exception\DriverException as DriverException,
33     Behat\Mink\Exception\ElementNotFoundException as ElementNotFoundException;
35 /**
36  * Course-related steps definitions.
37  *
38  * @package    core_course
39  * @category   test
40  * @copyright  2012 David MonllaĆ³
41  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
42  */
43 class behat_course extends behat_base {
45     /**
46      * Turns editing mode on.
47      * @Given /^I turn editing mode on$/
48      */
49     public function i_turn_editing_mode_on() {
51         try {
52             $this->execute("behat_forms::press_button", get_string('turneditingon'));
53         } catch (Exception $e) {
54             $this->execute("behat_navigation::i_navigate_to_in_current_page_administration", [get_string('turneditingon')]);
55         }
56     }
58     /**
59      * Turns editing mode off.
60      * @Given /^I turn editing mode off$/
61      */
62     public function i_turn_editing_mode_off() {
64         try {
65             $this->execute("behat_forms::press_button", get_string('turneditingoff'));
66         } catch (Exception $e) {
67             $this->execute("behat_navigation::i_navigate_to_in_current_page_administration", [get_string('turneditingoff')]);
68         }
69     }
71     /**
72      * Creates a new course with the provided table data matching course settings names with the desired values.
73      *
74      * @Given /^I create a course with:$/
75      * @param TableNode $table The course data
76      */
77     public function i_create_a_course_with(TableNode $table) {
79         // Go to course management page.
80         $this->i_go_to_the_courses_management_page();
81         // Ensure you are on course management page.
82         $this->execute("behat_course::i_should_see_the_courses_management_page", get_string('categories'));
84         // Select Miscellaneous category.
85         $this->i_click_on_category_in_the_management_interface(get_string('miscellaneous'));
86         $this->execute("behat_course::i_should_see_the_courses_management_page", get_string('categoriesandcoures'));
88         // Click create new course.
89         $this->execute('behat_general::i_click_on_in_the',
90             array(get_string('createnewcourse'), "link", "#course-listing", "css_element")
91         );
93         // If the course format is one of the fields we change how we
94         // fill the form as we need to wait for the form to be set.
95         $rowshash = $table->getRowsHash();
96         $formatfieldrefs = array(get_string('format'), 'format', 'id_format');
97         foreach ($formatfieldrefs as $fieldref) {
98             if (!empty($rowshash[$fieldref])) {
99                 $formatfield = $fieldref;
100             }
101         }
103         // Setting the format separately.
104         if (!empty($formatfield)) {
106             // Removing the format field from the TableNode.
107             $rows = $table->getRows();
108             $formatvalue = $rowshash[$formatfield];
109             foreach ($rows as $key => $row) {
110                 if ($row[0] == $formatfield) {
111                     unset($rows[$key]);
112                 }
113             }
114             $table = new TableNode($rows);
116             // Adding a forced wait until editors are loaded as otherwise selenium sometimes tries clicks on the
117             // format field when the editor is being rendered and the click misses the field coordinates.
118             $this->execute("behat_forms::i_expand_all_fieldsets");
120             $this->execute("behat_forms::i_set_the_field_to", array($formatfield, $formatvalue));
121         }
123         // Set form fields.
124         $this->execute("behat_forms::i_set_the_following_fields_to_these_values", $table);
126         // Save course settings.
127         $this->execute("behat_forms::press_button", get_string('savechangesanddisplay'));
129     }
131     /**
132      * Goes to the system courses/categories management page.
133      *
134      * @Given /^I go to the courses management page$/
135      */
136     public function i_go_to_the_courses_management_page() {
138         $parentnodes = get_string('courses', 'admin');
140         // Go to home page.
141         $this->execute("behat_general::i_am_on_homepage");
143         // Navigate to course management via system administration.
144         $this->execute("behat_navigation::i_navigate_to_in_site_administration",
145             array($parentnodes . ' > ' . get_string('coursemgmt', 'admin'))
146         );
148     }
150     /**
151      * Adds the selected activity/resource filling the form data with the specified field/value pairs. Sections 0 and 1 are also allowed on frontpage.
152      *
153      * @When /^I add a "(?P<activity_or_resource_name_string>(?:[^"]|\\")*)" to section "(?P<section_number>\d+)" and I fill the form with:$/
154      * @param string $activity The activity name
155      * @param int $section The section number
156      * @param TableNode $data The activity field/value data
157      */
158     public function i_add_to_section_and_i_fill_the_form_with($activity, $section, TableNode $data) {
160         // Add activity to section.
161         $this->execute("behat_course::i_add_to_section",
162             array($this->escape($activity), $this->escape($section))
163         );
165         // Wait to be redirected.
166         $this->execute('behat_general::wait_until_the_page_is_ready');
168         // Set form fields.
169         $this->execute("behat_forms::i_set_the_following_fields_to_these_values", $data);
171         // Save course settings.
172         $this->execute("behat_forms::press_button", get_string('savechangesandreturntocourse'));
173     }
175     /**
176      * Opens the activity chooser and opens the activity/resource form page. Sections 0 and 1 are also allowed on frontpage.
177      *
178      * @Given /^I add a "(?P<activity_or_resource_name_string>(?:[^"]|\\")*)" to section "(?P<section_number>\d+)"$/
179      * @throws ElementNotFoundException Thrown by behat_base::find
180      * @param string $activity
181      * @param int $section
182      */
183     public function i_add_to_section($activity, $section) {
185         if ($this->getSession()->getPage()->find('css', 'body#page-site-index') && (int)$section <= 1) {
186             // We are on the frontpage.
187             if ($section) {
188                 // Section 1 represents the contents on the frontpage.
189                 $sectionxpath = "//body[@id='page-site-index']/descendant::div[contains(concat(' ',normalize-space(@class),' '),' sitetopic ')]";
190             } else {
191                 // Section 0 represents "Site main menu" block.
192                 $sectionxpath = "//div[contains(concat(' ',normalize-space(@class),' '),' block_site_main_menu ')]";
193             }
194         } else {
195             // We are inside the course.
196             $sectionxpath = "//li[@id='section-" . $section . "']";
197         }
199         $activityliteral = behat_context_helper::escape(ucfirst($activity));
201         if ($this->running_javascript()) {
203             // Clicks add activity or resource section link.
204             $sectionxpath = $sectionxpath . "/descendant::div[@class='section-modchooser']/span/a";
205             $sectionnode = $this->find('xpath', $sectionxpath);
206             $sectionnode->click();
208             // Clicks the selected activity if it exists.
209             $activityxpath = "//div[@id='chooseform']/descendant::label" .
210                 "/descendant::span[contains(concat(' ', normalize-space(@class), ' '), ' typename ')]" .
211                 "[normalize-space(.)=$activityliteral]" .
212                 "/parent::label/child::input";
213             $activitynode = $this->find('xpath', $activityxpath);
214             $activitynode->doubleClick();
216         } else {
217             // Without Javascript.
219             // Selecting the option from the select box which contains the option.
220             $selectxpath = $sectionxpath . "/descendant::div[contains(concat(' ', normalize-space(@class), ' '), ' section_add_menus ')]" .
221                 "/descendant::select[option[normalize-space(.)=$activityliteral]]";
222             $selectnode = $this->find('xpath', $selectxpath);
223             $selectnode->selectOption($activity);
225             // Go button.
226             $gobuttonxpath = $selectxpath . "/ancestor::form/descendant::input[@type='submit']";
227             $gobutton = $this->find('xpath', $gobuttonxpath);
228             $gobutton->click();
229         }
231     }
234     /**
235      * Opens a section edit menu if it is not already opened.
236      *
237      * @Given /^I open section "(?P<section_number>\d+)" edit menu$/
238      * @throws DriverException The step is not available when Javascript is disabled
239      * @param string $sectionnumber
240      */
241     public function i_open_section_edit_menu($sectionnumber) {
242         if (!$this->running_javascript()) {
243             throw new DriverException('Section edit menu not available when Javascript is disabled');
244         }
246         // Wait for section to be available, before clicking on the menu.
247         $this->i_wait_until_section_is_available($sectionnumber);
249         // If it is already opened we do nothing.
250         $xpath = $this->section_exists($sectionnumber);
251         $xpath .= "/descendant::div[contains(@class, 'section-actions')]/descendant::a[contains(@class, 'textmenu')]";
253         $exception = new ExpectationException('Section "' . $sectionnumber . '" was not found', $this->getSession());
254         $menu = $this->find('xpath', $xpath, $exception);
255         $menu->click();
256         $this->i_wait_until_section_is_available($sectionnumber);
257     }
259     /**
260      * Deletes course section.
261      *
262      * @Given /^I delete section "(?P<section_number>\d+)"$/
263      * @param int $sectionnumber The section number
264      */
265     public function i_delete_section($sectionnumber) {
266         // Ensures the section exists.
267         $xpath = $this->section_exists($sectionnumber);
269         // We need to know the course format as the text strings depends on them.
270         $courseformat = $this->get_course_format();
271         if (get_string_manager()->string_exists('deletesection', $courseformat)) {
272             $strdelete = get_string('deletesection', $courseformat);
273         } else {
274             $strdelete = get_string('deletesection');
275         }
277         // If javascript is on, link is inside a menu.
278         if ($this->running_javascript()) {
279             $this->i_open_section_edit_menu($sectionnumber);
280         }
282         // Click on delete link.
283         $this->execute('behat_general::i_click_on_in_the',
284             array($strdelete, "link", $this->escape($xpath), "xpath_element")
285         );
287     }
289     /**
290      * Turns course section highlighting on.
291      *
292      * @Given /^I turn section "(?P<section_number>\d+)" highlighting on$/
293      * @param int $sectionnumber The section number
294      */
295     public function i_turn_section_highlighting_on($sectionnumber) {
297         // Ensures the section exists.
298         $xpath = $this->section_exists($sectionnumber);
300         // If javascript is on, link is inside a menu.
301         if ($this->running_javascript()) {
302             $this->i_open_section_edit_menu($sectionnumber);
303         }
305         // Click on highlight topic link.
306         $this->execute('behat_general::i_click_on_in_the',
307             array(get_string('markthistopic'), "link", $this->escape($xpath), "xpath_element")
308         );
309     }
311     /**
312      * Turns course section highlighting off.
313      *
314      * @Given /^I turn section "(?P<section_number>\d+)" highlighting off$/
315      * @param int $sectionnumber The section number
316      */
317     public function i_turn_section_highlighting_off($sectionnumber) {
319         // Ensures the section exists.
320         $xpath = $this->section_exists($sectionnumber);
322         // If javascript is on, link is inside a menu.
323         if ($this->running_javascript()) {
324             $this->i_open_section_edit_menu($sectionnumber);
325         }
327         // Click on un-highlight topic link.
328         $this->execute('behat_general::i_click_on_in_the',
329             array(get_string('markedthistopic'), "link", $this->escape($xpath), "xpath_element")
330         );
331     }
333     /**
334      * Shows the specified hidden section. You need to be in the course page and on editing mode.
335      *
336      * @Given /^I show section "(?P<section_number>\d+)"$/
337      * @param int $sectionnumber
338      */
339     public function i_show_section($sectionnumber) {
340         $showlink = $this->show_section_link_exists($sectionnumber);
342         // Ensure section edit menu is open before interacting with it.
343         if ($this->running_javascript()) {
344             $this->i_open_section_edit_menu($sectionnumber);
345         }
346         $showlink->click();
348         if ($this->running_javascript()) {
349             $this->getSession()->wait(self::TIMEOUT * 1000, self::PAGE_READY_JS);
350             $this->i_wait_until_section_is_available($sectionnumber);
351         }
352     }
354     /**
355      * Hides the specified visible section. You need to be in the course page and on editing mode.
356      *
357      * @Given /^I hide section "(?P<section_number>\d+)"$/
358      * @param int $sectionnumber
359      */
360     public function i_hide_section($sectionnumber) {
361         // Ensures the section exists.
362         $xpath = $this->section_exists($sectionnumber);
364         // We need to know the course format as the text strings depends on them.
365         $courseformat = $this->get_course_format();
366         if (get_string_manager()->string_exists('hidefromothers', $courseformat)) {
367             $strhide = get_string('hidefromothers', $courseformat);
368         } else {
369             $strhide = get_string('hidesection');
370         }
372         // If javascript is on, link is inside a menu.
373         if ($this->running_javascript()) {
374             $this->i_open_section_edit_menu($sectionnumber);
375         }
377         // Click on delete link.
378         $this->execute('behat_general::i_click_on_in_the',
379               array($strhide, "link", $this->escape($xpath), "xpath_element")
380         );
382         if ($this->running_javascript()) {
383             $this->getSession()->wait(self::TIMEOUT * 1000, self::PAGE_READY_JS);
384             $this->i_wait_until_section_is_available($sectionnumber);
385         }
386     }
388     /**
389      * Go to editing section page for specified section number. You need to be in the course page and on editing mode.
390      *
391      * @Given /^I edit the section "(?P<section_number>\d+)"$/
392      * @param int $sectionnumber
393      */
394     public function i_edit_the_section($sectionnumber) {
395         // If javascript is on, link is inside a menu.
396         if ($this->running_javascript()) {
397             $this->i_open_section_edit_menu($sectionnumber);
398         }
400         // We need to know the course format as the text strings depends on them.
401         $courseformat = $this->get_course_format();
402         if ($sectionnumber > 0 && get_string_manager()->string_exists('editsection', $courseformat)) {
403             $stredit = get_string('editsection', $courseformat);
404         } else {
405             $stredit = get_string('editsection');
406         }
408         // Click on un-highlight topic link.
409         $this->execute('behat_general::i_click_on_in_the',
410             array($stredit, "link", "#section-" . $sectionnumber, "css_element")
411         );
413     }
415     /**
416      * Edit specified section and fill the form data with the specified field/value pairs.
417      *
418      * @When /^I edit the section "(?P<section_number>\d+)" and I fill the form with:$/
419      * @param int $sectionnumber The section number
420      * @param TableNode $data The activity field/value data
421      */
422     public function i_edit_the_section_and_i_fill_the_form_with($sectionnumber, TableNode $data) {
424         // Edit given section.
425         $this->execute("behat_course::i_edit_the_section", $sectionnumber);
427         // Set form fields.
428         $this->execute("behat_forms::i_set_the_following_fields_to_these_values", $data);
430         // Save section settings.
431         $this->execute("behat_forms::press_button", get_string('savechanges'));
432     }
434     /**
435      * Checks if the specified course section hightlighting is turned on. You need to be in the course page on editing mode.
436      *
437      * @Then /^section "(?P<section_number>\d+)" should be highlighted$/
438      * @throws ExpectationException
439      * @param int $sectionnumber The section number
440      */
441     public function section_should_be_highlighted($sectionnumber) {
443         // Ensures the section exists.
444         $xpath = $this->section_exists($sectionnumber);
446         // The important checking, we can not check the img.
447         $this->execute('behat_general::should_exist_in_the', ['This topic is highlighted as the current topic', 'icon', $xpath, 'xpath_element']);
448     }
450     /**
451      * Checks if the specified course section highlighting is turned off. You need to be in the course page on editing mode.
452      *
453      * @Then /^section "(?P<section_number>\d+)" should not be highlighted$/
454      * @throws ExpectationException
455      * @param int $sectionnumber The section number
456      */
457     public function section_should_not_be_highlighted($sectionnumber) {
459         // We only catch ExpectationException, ElementNotFoundException should be thrown if the specified section does not exist.
460         try {
461             $this->section_should_be_highlighted($sectionnumber);
462         } catch (ExpectationException $e) {
463             // ExpectedException means that it is not highlighted.
464             return;
465         }
467         throw new ExpectationException('The "' . $sectionnumber . '" section is highlighted', $this->getSession());
468     }
470     /**
471      * Checks that the specified section is visible. You need to be in the course page. It can be used being logged as a student and as a teacher on editing mode.
472      *
473      * @Then /^section "(?P<section_number>\d+)" should be hidden$/
474      * @throws ExpectationException
475      * @throws ElementNotFoundException Thrown by behat_base::find
476      * @param int $sectionnumber
477      */
478     public function section_should_be_hidden($sectionnumber) {
480         $sectionxpath = $this->section_exists($sectionnumber);
482         // Preventive in case there is any action in progress.
483         // Adding it here because we are interacting (click) with
484         // the elements, not necessary when we just find().
485         $this->i_wait_until_section_is_available($sectionnumber);
487         // Section should be hidden.
488         $exception = new ExpectationException('The section is not hidden', $this->getSession());
489         $this->find('xpath', $sectionxpath . "[contains(concat(' ', normalize-space(@class), ' '), ' hidden ')]", $exception);
490     }
492     /**
493      * Checks that all actiities in the specified section are hidden. You need to be in the course page. It can be used being logged as a student and as a teacher on editing mode.
494      *
495      * @Then /^all activities in section "(?P<section_number>\d+)" should be hidden$/
496      * @throws ExpectationException
497      * @throws ElementNotFoundException Thrown by behat_base::find
498      * @param int $sectionnumber
499      */
500     public function section_activities_should_be_hidden($sectionnumber) {
501         $sectionxpath = $this->section_exists($sectionnumber);
503         // Preventive in case there is any action in progress.
504         // Adding it here because we are interacting (click) with
505         // the elements, not necessary when we just find().
506         $this->i_wait_until_section_is_available($sectionnumber);
508         // The checking are different depending on user permissions.
509         if ($this->is_course_editor()) {
511             // The section must be hidden.
512             $this->show_section_link_exists($sectionnumber);
514             // If there are activities they should be hidden and the visibility icon should not be available.
515             if ($activities = $this->get_section_activities($sectionxpath)) {
517                 $dimmedexception = new ExpectationException('There are activities that are not dimmed', $this->getSession());
518                 foreach ($activities as $activity) {
519                     // Dimmed.
520                     $this->find('xpath', "//div[contains(concat(' ', normalize-space(@class), ' '), ' activityinstance ')]" .
521                         "//a[contains(concat(' ', normalize-space(@class), ' '), ' dimmed ')]", $dimmedexception, $activity);
522                 }
523             }
524         } else {
525             // There shouldn't be activities.
526             if ($this->get_section_activities($sectionxpath)) {
527                 throw new ExpectationException('There are activities in the section and they should be hidden', $this->getSession());
528             }
529         }
531     }
533     /**
534      * Checks that the specified section is visible. You need to be in the course page. It can be used being logged as a student and as a teacher on editing mode.
535      *
536      * @Then /^section "(?P<section_number>\d+)" should be visible$/
537      * @throws ExpectationException
538      * @param int $sectionnumber
539      */
540     public function section_should_be_visible($sectionnumber) {
542         $sectionxpath = $this->section_exists($sectionnumber);
544         // Section should not be hidden.
545         $xpath = $sectionxpath . "[not(contains(concat(' ', normalize-space(@class), ' '), ' hidden '))]";
546         if (!$this->getSession()->getPage()->find('xpath', $xpath)) {
547             throw new ExpectationException('The section is hidden', $this->getSession());
548         }
550         // Edit menu should be visible.
551         if ($this->is_course_editor()) {
552             $xpath = $sectionxpath .
553                      "/descendant::div[contains(@class, 'section-actions')]" .
554                      "/descendant::a[contains(@class, 'textmenu')]";
555             if (!$this->getSession()->getPage()->find('xpath', $xpath)) {
556                 throw new ExpectationException('The section edit menu is not available', $this->getSession());
557             }
558         }
559     }
561     /**
562      * Moves up the specified section, this step only works with Javascript disabled. Editing mode should be on.
563      *
564      * @Given /^I move up section "(?P<section_number>\d+)"$/
565      * @throws DriverException Step not available when Javascript is enabled
566      * @param int $sectionnumber
567      */
568     public function i_move_up_section($sectionnumber) {
570         if ($this->running_javascript()) {
571             throw new DriverException('Move a section up step is not available with Javascript enabled');
572         }
574         // Ensures the section exists.
575         $sectionxpath = $this->section_exists($sectionnumber);
577         // If javascript is on, link is inside a menu.
578         if ($this->running_javascript()) {
579             $this->i_open_section_edit_menu($sectionnumber);
580         }
582         // Follows the link
583         $moveuplink = $this->get_node_in_container('link', get_string('moveup'), 'xpath_element', $sectionxpath);
584         $moveuplink->click();
585     }
587     /**
588      * Moves down the specified section, this step only works with Javascript disabled. Editing mode should be on.
589      *
590      * @Given /^I move down section "(?P<section_number>\d+)"$/
591      * @throws DriverException Step not available when Javascript is enabled
592      * @param int $sectionnumber
593      */
594     public function i_move_down_section($sectionnumber) {
596         if ($this->running_javascript()) {
597             throw new DriverException('Move a section down step is not available with Javascript enabled');
598         }
600         // Ensures the section exists.
601         $sectionxpath = $this->section_exists($sectionnumber);
603         // If javascript is on, link is inside a menu.
604         if ($this->running_javascript()) {
605             $this->i_open_section_edit_menu($sectionnumber);
606         }
608         // Follows the link
609         $movedownlink = $this->get_node_in_container('link', get_string('movedown'), 'xpath_element', $sectionxpath);
610         $movedownlink->click();
611     }
613     /**
614      * Checks that the specified activity is visible. You need to be in the course page. It can be used being logged as a student and as a teacher on editing mode.
615      *
616      * @Then /^"(?P<activity_or_resource_string>(?:[^"]|\\")*)" activity should be visible$/
617      * @param string $activityname
618      * @throws ExpectationException
619      */
620     public function activity_should_be_visible($activityname) {
622         // The activity must exists and be visible.
623         $activitynode = $this->get_activity_node($activityname);
625         if ($this->is_course_editor()) {
627             // The activity should not be dimmed.
628             try {
629                 $xpath = "/descendant-or-self::a[contains(concat(' ', normalize-space(@class), ' '), ' dimmed ')] | ".
630                          "/descendant-or-self::div[contains(concat(' ', normalize-space(@class), ' '), ' dimmed_text ')]";
631                 $this->find('xpath', $xpath, false, $activitynode);
632                 throw new ExpectationException('"' . $activityname . '" is hidden', $this->getSession());
633             } catch (ElementNotFoundException $e) {
634                 // All ok.
635             }
637             // Additional check if this is a teacher in editing mode.
638             if ($this->is_editing_on()) {
639                 // The 'Hide' button should be available.
640                 $nohideexception = new ExpectationException('"' . $activityname . '" doesn\'t have a "' .
641                     get_string('hide') . '" icon', $this->getSession());
642                 $this->find('named_partial', array('link', get_string('hide')), $nohideexception, $activitynode);
643             }
644         }
645     }
647     /**
648      * Checks that the specified activity is visible. You need to be in the course page.
649      * It can be used being logged as a student and as a teacher on editing mode.
650      *
651      * @Then /^"(?P<activity_or_resource_string>(?:[^"]|\\")*)" activity should be available but hidden from course page$/
652      * @param string $activityname
653      * @throws ExpectationException
654      */
655     public function activity_should_be_available_but_hidden_from_course_page($activityname) {
657         if ($this->is_course_editor()) {
659             // The activity must exists and be visible.
660             $activitynode = $this->get_activity_node($activityname);
662             // The activity should not be dimmed.
663             try {
664                 $xpath = "/descendant-or-self::a[contains(concat(' ', normalize-space(@class), ' '), ' dimmed ')] | " .
665                     "/descendant-or-self::div[contains(concat(' ', normalize-space(@class), ' '), ' dimmed_text ')]";
666                 $this->find('xpath', $xpath, false, $activitynode);
667                 throw new ExpectationException('"' . $activityname . '" is hidden', $this->getSession());
668             } catch (ElementNotFoundException $e) {
669                 // All ok.
670             }
672             // Should has "stealth" class.
673             $exception = new ExpectationException('"' . $activityname . '" does not have CSS class "stealth"', $this->getSession());
674             $xpath = "/descendant-or-self::a[contains(concat(' ', normalize-space(@class), ' '), ' stealth ')]";
675             $this->find('xpath', $xpath, $exception, $activitynode);
677             // Additional check if this is a teacher in editing mode.
678             if ($this->is_editing_on()) {
679                 // Also has either 'Hide' or 'Make unavailable' edit control.
680                 $nohideexception = new ExpectationException('"' . $activityname . '" has neither "' . get_string('hide') .
681                     '" nor "' . get_string('makeunavailable') . '" icons', $this->getSession());
682                 try {
683                     $this->find('named_partial', array('link', get_string('hide')), false, $activitynode);
684                 } catch (ElementNotFoundException $e) {
685                     $this->find('named_partial', array('link', get_string('makeunavailable')), $nohideexception, $activitynode);
686                 }
687             }
689         } else {
691             // Student should not see the activity at all.
692             try {
693                 $this->get_activity_node($activityname);
694                 throw new ExpectationException('The "' . $activityname . '" should not appear', $this->getSession());
695             } catch (ElementNotFoundException $e) {
696                 // This is good, the activity should not be there.
697             }
698         }
699     }
701     /**
702      * Checks that the specified activity is hidden. You need to be in the course page. It can be used being logged as a student and as a teacher on editing mode.
703      *
704      * @Then /^"(?P<activity_or_resource_string>(?:[^"]|\\")*)" activity should be hidden$/
705      * @param string $activityname
706      * @throws ExpectationException
707      */
708     public function activity_should_be_hidden($activityname) {
710         if ($this->is_course_editor()) {
712             // The activity should exist.
713             $activitynode = $this->get_activity_node($activityname);
715             // Should be hidden.
716             $exception = new ExpectationException('"' . $activityname . '" is not dimmed', $this->getSession());
717             $xpath = "/descendant-or-self::a[contains(concat(' ', normalize-space(@class), ' '), ' dimmed ')] | ".
718                      "/descendant-or-self::div[contains(concat(' ', normalize-space(@class), ' '), ' dimmed_text ')]";
719             $this->find('xpath', $xpath, $exception, $activitynode);
721             // Additional check if this is a teacher in editing mode.
722             if ($this->is_editing_on()) {
723                 // Also has either 'Show' or 'Make available' edit control.
724                 $noshowexception = new ExpectationException('"' . $activityname . '" has neither "' . get_string('show') .
725                     '" nor "' . get_string('makeavailable') . '" icons', $this->getSession());
726                 try {
727                     $this->find('named_partial', array('link', get_string('show')), false, $activitynode);
728                 } catch (ElementNotFoundException $e) {
729                     $this->find('named_partial', array('link', get_string('makeavailable')), $noshowexception, $activitynode);
730                 }
731             }
733         } else {
735             // It should not exist at all.
736             try {
737                 $this->get_activity_node($activityname);
738                 throw new ExpectationException('The "' . $activityname . '" should not appear', $this->getSession());
739             } catch (ElementNotFoundException $e) {
740                 // This is good, the activity should not be there.
741             }
742         }
744     }
746     /**
747      * Checks that the specified activity is dimmed. You need to be in the course page.
748      *
749      * @Then /^"(?P<activity_or_resource_string>(?:[^"]|\\")*)" activity should be dimmed$/
750      * @param string $activityname
751      * @throws ExpectationException
752      */
753     public function activity_should_be_dimmed($activityname) {
755         // The activity should exist.
756         $activitynode = $this->get_activity_node($activityname);
758         // Should be hidden.
759         $exception = new ExpectationException('"' . $activityname . '" is not dimmed', $this->getSession());
760         $xpath = "/descendant-or-self::a[contains(concat(' ', normalize-space(@class), ' '), ' dimmed ')] | ".
761             "/descendant-or-self::div[contains(concat(' ', normalize-space(@class), ' '), ' dimmed_text ')]";
762         $this->find('xpath', $xpath, $exception, $activitynode);
764     }
766     /**
767      * Moves the specified activity to the first slot of a section. This step is experimental when using it in Javascript tests. Editing mode should be on.
768      *
769      * @Given /^I move "(?P<activity_name_string>(?:[^"]|\\")*)" activity to section "(?P<section_number>\d+)"$/
770      * @param string $activityname The activity name
771      * @param int $sectionnumber The number of section
772      */
773     public function i_move_activity_to_section($activityname, $sectionnumber) {
775         // Ensure the destination is valid.
776         $sectionxpath = $this->section_exists($sectionnumber);
778         $activitynode = $this->get_activity_element('Move', 'icon', $activityname);
780         // JS enabled.
781         if ($this->running_javascript()) {
783             $destinationxpath = $sectionxpath . "/descendant::ul[contains(concat(' ', normalize-space(@class), ' '), ' yui3-dd-drop ')]";
785             $this->execute("behat_general::i_drag_and_i_drop_it_in",
786                 array($this->escape($activitynode->getXpath()), "xpath_element",
787                     $this->escape($destinationxpath), "xpath_element")
788             );
790         } else {
791             // Following links with no-JS.
793             // Moving to the fist spot of the section (before all other section's activities).
794             $this->execute('behat_course::i_click_on_in_the_activity',
795                 array("a.editing_move", "css_element", $this->escape($activityname))
796             );
798             $this->execute('behat_general::i_click_on_in_the',
799                 array("li.movehere a", "css_element", $this->escape($sectionxpath), "xpath_element")
800             );
801         }
802     }
804     /**
805      * Edits the activity name through the edit activity; this step only works with Javascript enabled. Editing mode should be on.
806      *
807      * @Given /^I change "(?P<activity_name_string>(?:[^"]|\\")*)" activity name to "(?P<new_name_string>(?:[^"]|\\")*)"$/
808      * @throws DriverException Step not available when Javascript is disabled
809      * @param string $activityname
810      * @param string $newactivityname
811      */
812     public function i_change_activity_name_to($activityname, $newactivityname) {
814         if (!$this->running_javascript()) {
815             throw new DriverException('Change activity name step is not available with Javascript disabled');
816         }
818         $activity = $this->escape($activityname);
820         $this->execute('behat_course::i_click_on_in_the_activity',
821             array(get_string('edittitle'), "link", $activity)
822         );
824         // Adding chr(10) to save changes.
825         $this->execute('behat_forms::i_set_the_field_to',
826             array('title', $this->escape($newactivityname) . chr(10))
827         );
829     }
831     /**
832      * Opens an activity actions menu if it is not already opened.
833      *
834      * @Given /^I open "(?P<activity_name_string>(?:[^"]|\\")*)" actions menu$/
835      * @throws DriverException The step is not available when Javascript is disabled
836      * @param string $activityname
837      */
838     public function i_open_actions_menu($activityname) {
840         if (!$this->running_javascript()) {
841             throw new DriverException('Activities actions menu not available when Javascript is disabled');
842         }
844         // If it is already opened we do nothing.
845         $activitynode = $this->get_activity_node($activityname);
846         $classes = array_flip(explode(' ', $activitynode->getAttribute('class')));
847         if (!empty($classes['action-menu-shown'])) {
848             return;
849         }
851         $this->execute('behat_course::i_click_on_in_the_activity',
852             array("a[role='menuitem']", "css_element", $this->escape($activityname))
853         );
855     }
857     /**
858      * Closes an activity actions menu if it is not already closed.
859      *
860      * @Given /^I close "(?P<activity_name_string>(?:[^"]|\\")*)" actions menu$/
861      * @throws DriverException The step is not available when Javascript is disabled
862      * @param string $activityname
863      */
864     public function i_close_actions_menu($activityname) {
866         if (!$this->running_javascript()) {
867             throw new DriverException('Activities actions menu not available when Javascript is disabled');
868         }
870         // If it is already closed we do nothing.
871         $activitynode = $this->get_activity_node($activityname);
872         $classes = array_flip(explode(' ', $activitynode->getAttribute('class')));
873         if (empty($classes['action-menu-shown'])) {
874             return;
875         }
877         $this->execute('behat_course::i_click_on_in_the_activity',
878             array("a[role='menuitem']", "css_element", $this->escape($activityname))
879         );
880     }
882     /**
883      * Checks that the specified activity's action menu is open.
884      *
885      * @Then /^"(?P<activity_name_string>(?:[^"]|\\")*)" actions menu should be open$/
886      * @throws DriverException The step is not available when Javascript is disabled
887      * @param string $activityname
888      */
889     public function actions_menu_should_be_open($activityname) {
891         if (!$this->running_javascript()) {
892             throw new DriverException('Activities actions menu not available when Javascript is disabled');
893         }
895         // If it is already closed we do nothing.
896         $activitynode = $this->get_activity_node($activityname);
897         $classes = array_flip(explode(' ', $activitynode->getAttribute('class')));
898         if (empty($classes['action-menu-shown'])) {
899             throw new ExpectationException(sprintf("The action menu for '%s' is not open", $activityname), $this->getSession());
900         }
901     }
903     /**
904      * Checks that the specified activity's action menu contains an item.
905      *
906      * @Then /^"(?P<activity_name_string>(?:[^"]|\\")*)" actions menu should have "(?P<menu_item_string>(?:[^"]|\\")*)" item$/
907      * @throws DriverException The step is not available when Javascript is disabled
908      * @param string $activityname
909      * @param string $menuitem
910      */
911     public function actions_menu_should_have_item($activityname, $menuitem) {
912         $activitynode = $this->get_activity_node($activityname);
914         $notfoundexception = new ExpectationException('"' . $activityname . '" doesn\'t have a "' .
915             $menuitem . '" item', $this->getSession());
916         $this->find('named_partial', array('link', $menuitem), $notfoundexception, $activitynode);
917     }
919     /**
920      * Checks that the specified activity's action menu does not contains an item.
921      *
922      * @Then /^"(?P<activity_name_string>(?:[^"]|\\")*)" actions menu should not have "(?P<menu_item_string>(?:[^"]|\\")*)" item$/
923      * @throws DriverException The step is not available when Javascript is disabled
924      * @param string $activityname
925      * @param string $menuitem
926      */
927     public function actions_menu_should_not_have_item($activityname, $menuitem) {
928         $activitynode = $this->get_activity_node($activityname);
930         try {
931             $this->find('named_partial', array('link', $menuitem), false, $activitynode);
932             throw new ExpectationException('"' . $activityname . '" has a "' . $menuitem .
933                 '" item when it should not', $this->getSession());
934         } catch (ElementNotFoundException $e) {
935             // This is good, the menu item should not be there.
936         }
937     }
939     /**
940      * Indents to the right the activity or resource specified by it's name. Editing mode should be on.
941      *
942      * @Given /^I indent right "(?P<activity_name_string>(?:[^"]|\\")*)" activity$/
943      * @param string $activityname
944      */
945     public function i_indent_right_activity($activityname) {
947         $activity = $this->escape($activityname);
948         if ($this->running_javascript()) {
949             $this->i_open_actions_menu($activity);
950         }
952         $this->execute('behat_course::i_click_on_in_the_activity',
953             array(get_string('moveright'), "link", $this->escape($activity))
954         );
956     }
958     /**
959      * Indents to the left the activity or resource specified by it's name. Editing mode should be on.
960      *
961      * @Given /^I indent left "(?P<activity_name_string>(?:[^"]|\\")*)" activity$/
962      * @param string $activityname
963      */
964     public function i_indent_left_activity($activityname) {
966         $activity = $this->escape($activityname);
967         if ($this->running_javascript()) {
968             $this->i_open_actions_menu($activity);
969         }
971         $this->execute('behat_course::i_click_on_in_the_activity',
972             array(get_string('moveleft'), "link", $this->escape($activity))
973         );
975     }
977     /**
978      * Deletes the activity or resource specified by it's name. This step is experimental when using it in Javascript tests. You should be in the course page with editing mode on.
979      *
980      * @Given /^I delete "(?P<activity_name_string>(?:[^"]|\\")*)" activity$/
981      * @param string $activityname
982      */
983     public function i_delete_activity($activityname) {
984         $steps = array();
985         $activity = $this->escape($activityname);
986         if ($this->running_javascript()) {
987             $this->i_open_actions_menu($activity);
988         }
990         $this->execute('behat_course::i_click_on_in_the_activity',
991             array(get_string('delete'), "link", $this->escape($activity))
992         );
994         // JS enabled.
995         // Not using chain steps here because the exceptions catcher have problems detecting
996         // JS modal windows and avoiding interacting them at the same time.
997         if ($this->running_javascript()) {
998             $this->execute('behat_general::i_click_on_in_the',
999                 array(get_string('yes'), "button", "Confirm", "dialogue")
1000             );
1001         } else {
1002             $this->execute("behat_forms::press_button", get_string('yes'));
1003         }
1005         return $steps;
1006     }
1008     /**
1009      * Duplicates the activity or resource specified by it's name. You should be in the course page with editing mode on.
1010      *
1011      * @Given /^I duplicate "(?P<activity_name_string>(?:[^"]|\\")*)" activity$/
1012      * @param string $activityname
1013      */
1014     public function i_duplicate_activity($activityname) {
1015         $steps = array();
1016         $activity = $this->escape($activityname);
1017         if ($this->running_javascript()) {
1018             $this->i_open_actions_menu($activity);
1019         }
1020         $this->execute('behat_course::i_click_on_in_the_activity',
1021             array(get_string('duplicate'), "link", $activity)
1022         );
1024     }
1026     /**
1027      * Duplicates the activity or resource and modifies the new activity with the provided data. You should be in the course page with editing mode on.
1028      *
1029      * @Given /^I duplicate "(?P<activity_name_string>(?:[^"]|\\")*)" activity editing the new copy with:$/
1030      * @param string $activityname
1031      * @param TableNode $data
1032      */
1033     public function i_duplicate_activity_editing_the_new_copy_with($activityname, TableNode $data) {
1035         $activity = $this->escape($activityname);
1036         $activityliteral = behat_context_helper::escape($activityname);
1038         $this->execute("behat_course::i_duplicate_activity", $activity);
1040         // Determine the future new activity xpath from the former one.
1041         $duplicatedxpath = "//li[contains(concat(' ', normalize-space(@class), ' '), ' activity ')]" .
1042             "[contains(., $activityliteral)]/following-sibling::li";
1043         $duplicatedactionsmenuxpath = $duplicatedxpath . "/descendant::a[@role='menuitem']";
1045         if ($this->running_javascript()) {
1046             // We wait until the AJAX request finishes and the section is visible again.
1047             $hiddenlightboxxpath = "//li[contains(concat(' ', normalize-space(@class), ' '), ' activity ')]" .
1048                 "[contains(., $activityliteral)]" .
1049                 "/ancestor::li[contains(concat(' ', normalize-space(@class), ' '), ' section ')]" .
1050                 "/descendant::div[contains(concat(' ', @class, ' '), ' lightbox ')][contains(@style, 'display: none')]";
1052             $this->execute("behat_general::wait_until_exists",
1053                 array($this->escape($hiddenlightboxxpath), "xpath_element")
1054             );
1056             // Close the original activity actions menu.
1057             $this->i_close_actions_menu($activity);
1059             // The next sibling of the former activity will be the duplicated one, so we click on it from it's xpath as, at
1060             // this point, it don't even exists in the DOM (the steps are executed when we return them).
1061             $this->execute('behat_general::i_click_on',
1062                 array($this->escape($duplicatedactionsmenuxpath), "xpath_element")
1063             );
1064         }
1066         // We force the xpath as otherwise mink tries to interact with the former one.
1067         $this->execute('behat_general::i_click_on_in_the',
1068             array(get_string('editsettings'), "link", $this->escape($duplicatedxpath), "xpath_element")
1069         );
1071         $this->execute("behat_forms::i_set_the_following_fields_to_these_values", $data);
1072         $this->execute("behat_forms::press_button", get_string('savechangesandreturntocourse'));
1074     }
1076     /**
1077      * Waits until the section is available to interact with it. Useful when the section is performing an action and the section is overlayed with a loading layout.
1078      *
1079      * Using the protected method as this method will be usually
1080      * called by other methods which are not returning a set of
1081      * steps and performs the actions directly, so it would not
1082      * be executed if it returns another step.
1083      *
1084      * Hopefully we would not require test writers to use this step
1085      * and we will manage it from other step definitions.
1086      *
1087      * @Given /^I wait until section "(?P<section_number>\d+)" is available$/
1088      * @param int $sectionnumber
1089      * @return void
1090      */
1091     public function i_wait_until_section_is_available($sectionnumber) {
1093         // Looks for a hidden lightbox or a non-existent lightbox in that section.
1094         $sectionxpath = $this->section_exists($sectionnumber);
1095         $hiddenlightboxxpath = $sectionxpath . "/descendant::div[contains(concat(' ', @class, ' '), ' lightbox ')][contains(@style, 'display: none')]" .
1096             " | " .
1097             $sectionxpath . "[count(child::div[contains(@class, 'lightbox')]) = 0]";
1099         $this->ensure_element_exists($hiddenlightboxxpath, 'xpath_element');
1100     }
1102     /**
1103      * Clicks on the specified element of the activity. You should be in the course page with editing mode turned on.
1104      *
1105      * @Given /^I click on "(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>(?:[^"]|\\")*)" in the "(?P<activity_name_string>(?:[^"]|\\")*)" activity$/
1106      * @param string $element
1107      * @param string $selectortype
1108      * @param string $activityname
1109      */
1110     public function i_click_on_in_the_activity($element, $selectortype, $activityname) {
1111         $element = $this->get_activity_element($element, $selectortype, $activityname);
1112         $element->click();
1113     }
1115     /**
1116      * Clicks on the specified element inside the activity container.
1117      *
1118      * @throws ElementNotFoundException
1119      * @param string $element
1120      * @param string $selectortype
1121      * @param string $activityname
1122      * @return NodeElement
1123      */
1124     protected function get_activity_element($element, $selectortype, $activityname) {
1125         $activitynode = $this->get_activity_node($activityname);
1127         // Transforming to Behat selector/locator.
1128         list($selector, $locator) = $this->transform_selector($selectortype, $element);
1129         $exception = new ElementNotFoundException($this->getSession(), '"' . $element . '" "' . $selectortype . '" in "' . $activityname . '" ');
1131         return $this->find($selector, $locator, $exception, $activitynode);
1132     }
1134     /**
1135      * Checks if the course section exists.
1136      *
1137      * @throws ElementNotFoundException Thrown by behat_base::find
1138      * @param int $sectionnumber
1139      * @return string The xpath of the section.
1140      */
1141     protected function section_exists($sectionnumber) {
1143         // Just to give more info in case it does not exist.
1144         $xpath = "//li[@id='section-" . $sectionnumber . "']";
1145         $exception = new ElementNotFoundException($this->getSession(), "Section $sectionnumber ");
1146         $this->find('xpath', $xpath, $exception);
1148         return $xpath;
1149     }
1151     /**
1152      * Returns the show section icon or throws an exception.
1153      *
1154      * @throws ElementNotFoundException Thrown by behat_base::find
1155      * @param int $sectionnumber
1156      * @return NodeElement
1157      */
1158     protected function show_section_link_exists($sectionnumber) {
1160         // Gets the section xpath and ensure it exists.
1161         $xpath = $this->section_exists($sectionnumber);
1163         // We need to know the course format as the text strings depends on them.
1164         $courseformat = $this->get_course_format();
1166         // Checking the show button alt text and show icon.
1167         $showtext = get_string('showfromothers', $courseformat);
1168         $linkxpath = $xpath . "/descendant::a[@title=" . behat_context_helper::escape($showtext) . "]";
1170         $exception = new ElementNotFoundException($this->getSession(), 'Show section link ');
1172         // Returing the link so both Non-JS and JS browsers can interact with it.
1173         return $this->find('xpath', $linkxpath, $exception);
1174     }
1176     /**
1177      * Returns the hide section icon link if it exists or throws exception.
1178      *
1179      * @throws ElementNotFoundException Thrown by behat_base::find
1180      * @param int $sectionnumber
1181      * @return NodeElement
1182      */
1183     protected function hide_section_link_exists($sectionnumber) {
1185         // Gets the section xpath and ensure it exists.
1186         $xpath = $this->section_exists($sectionnumber);
1188         // We need to know the course format as the text strings depends on them.
1189         $courseformat = $this->get_course_format();
1191         // Checking the hide button alt text and hide icon.
1192         $hidetext = behat_context_helper::escape(get_string('hidefromothers', $courseformat));
1193         $linkxpath = $xpath . "/descendant::a[@title=$hidetext]";
1195         $exception = new ElementNotFoundException($this->getSession(), 'Hide section icon ');
1196         $this->find('icon', 'Hide', $exception);
1198         // Returing the link so both Non-JS and JS browsers can interact with it.
1199         return $this->find('xpath', $linkxpath, $exception);
1200     }
1202     /**
1203      * Gets the current course format.
1204      *
1205      * @throws ExpectationException If we are not in the course view page.
1206      * @return string The course format in a frankenstyled name.
1207      */
1208     protected function get_course_format() {
1210         $exception = new ExpectationException('You are not in a course page', $this->getSession());
1212         // The moodle body's id attribute contains the course format.
1213         $node = $this->getSession()->getPage()->find('css', 'body');
1214         if (!$node) {
1215             throw $exception;
1216         }
1218         if (!$bodyid = $node->getAttribute('id')) {
1219             throw $exception;
1220         }
1222         if (strstr($bodyid, 'page-course-view-') === false) {
1223             throw $exception;
1224         }
1226         return 'format_' . str_replace('page-course-view-', '', $bodyid);
1227     }
1229     /**
1230      * Gets the section's activites DOM nodes.
1231      *
1232      * @param string $sectionxpath
1233      * @return array NodeElement instances
1234      */
1235     protected function get_section_activities($sectionxpath) {
1237         $xpath = $sectionxpath . "/descendant::li[contains(concat(' ', normalize-space(@class), ' '), ' activity ')]";
1239         // We spin here, as activities usually require a lot of time to load.
1240         try {
1241             $activities = $this->find_all('xpath', $xpath);
1242         } catch (ElementNotFoundException $e) {
1243             return false;
1244         }
1246         return $activities;
1247     }
1249     /**
1250      * Returns the DOM node of the activity from <li>.
1251      *
1252      * @throws ElementNotFoundException Thrown by behat_base::find
1253      * @param string $activityname The activity name
1254      * @return NodeElement
1255      */
1256     protected function get_activity_node($activityname) {
1258         $activityname = behat_context_helper::escape($activityname);
1259         $xpath = "//li[contains(concat(' ', normalize-space(@class), ' '), ' activity ')][contains(., $activityname)]";
1261         return $this->find('xpath', $xpath);
1262     }
1264     /**
1265      * Gets the activity instance name from the activity node.
1266      *
1267      * @throws ElementNotFoundException
1268      * @param NodeElement $activitynode
1269      * @return string
1270      */
1271     protected function get_activity_name($activitynode) {
1272         $instancenamenode = $this->find('xpath', "//span[contains(concat(' ', normalize-space(@class), ' '), ' instancename ')]", false, $activitynode);
1273         return $instancenamenode->getText();
1274     }
1276     /**
1277      * Returns whether the user can edit the course contents or not.
1278      *
1279      * @return bool
1280      */
1281     protected function is_course_editor() {
1283         // We don't need to behat_base::spin() here as all is already loaded.
1284         if (!$this->getSession()->getPage()->findButton(get_string('turneditingoff')) &&
1285                 !$this->getSession()->getPage()->findButton(get_string('turneditingon'))) {
1286             return false;
1287         }
1289         return true;
1290     }
1292     /**
1293      * Returns whether the user can edit the course contents and the editing mode is on.
1294      *
1295      * @return bool
1296      */
1297     protected function is_editing_on() {
1298         return $this->getSession()->getPage()->findButton(get_string('turneditingoff')) ? true : false;
1299     }
1301     /**
1302      * Returns the id of the category with the given idnumber.
1303      *
1304      * Please note that this function requires the category to exist. If it does not exist an ExpectationException is thrown.
1305      *
1306      * @param string $idnumber
1307      * @return string
1308      * @throws ExpectationException
1309      */
1310     protected function get_category_id($idnumber) {
1311         global $DB;
1312         try {
1313             return $DB->get_field('course_categories', 'id', array('idnumber' => $idnumber), MUST_EXIST);
1314         } catch (dml_missing_record_exception $ex) {
1315             throw new ExpectationException(sprintf("There is no category in the database with the idnumber '%s'", $idnumber));
1316         }
1317     }
1319     /**
1320      * Returns the id of the course with the given idnumber.
1321      *
1322      * Please note that this function requires the category to exist. If it does not exist an ExpectationException is thrown.
1323      *
1324      * @param string $idnumber
1325      * @return string
1326      * @throws ExpectationException
1327      */
1328     protected function get_course_id($idnumber) {
1329         global $DB;
1330         try {
1331             return $DB->get_field('course', 'id', array('idnumber' => $idnumber), MUST_EXIST);
1332         } catch (dml_missing_record_exception $ex) {
1333             throw new ExpectationException(sprintf("There is no course in the database with the idnumber '%s'", $idnumber));
1334         }
1335     }
1337     /**
1338      * Returns the category node from within the listing on the management page.
1339      *
1340      * @param string $idnumber
1341      * @return \Behat\Mink\Element\NodeElement
1342      */
1343     protected function get_management_category_listing_node_by_idnumber($idnumber) {
1344         $id = $this->get_category_id($idnumber);
1345         $selector = sprintf('#category-listing .listitem-category[data-id="%d"] > div', $id);
1346         return $this->find('css', $selector);
1347     }
1349     /**
1350      * Returns a category node from within the management interface.
1351      *
1352      * @param string $name The name of the category.
1353      * @param bool $link If set to true we'll resolve to the link rather than just the node.
1354      * @return \Behat\Mink\Element\NodeElement
1355      */
1356     protected function get_management_category_listing_node_by_name($name, $link = false) {
1357         $selector = "//div[@id='category-listing']//li[contains(concat(' ', normalize-space(@class), ' '), ' listitem-category ')]//a[text()='{$name}']";
1358         if ($link === false) {
1359             $selector .= "/ancestor::li[@data-id][1]";
1360         }
1361         return $this->find('xpath', $selector);
1362     }
1364     /**
1365      * Returns a course node from within the management interface.
1366      *
1367      * @param string $name The name of the course.
1368      * @param bool $link If set to true we'll resolve to the link rather than just the node.
1369      * @return \Behat\Mink\Element\NodeElement
1370      */
1371     protected function get_management_course_listing_node_by_name($name, $link = false) {
1372         $selector = "//div[@id='course-listing']//li[contains(concat(' ', @class, ' '), ' listitem-course ')]//a[text()='{$name}']";
1373         if ($link === false) {
1374             $selector .= "/ancestor::li[@data-id]";
1375         }
1376         return $this->find('xpath', $selector);
1377     }
1379     /**
1380      * Returns the course node from within the listing on the management page.
1381      *
1382      * @param string $idnumber
1383      * @return \Behat\Mink\Element\NodeElement
1384      */
1385     protected function get_management_course_listing_node_by_idnumber($idnumber) {
1386         $id = $this->get_course_id($idnumber);
1387         $selector = sprintf('#course-listing .listitem-course[data-id="%d"] > div', $id);
1388         return $this->find('css', $selector);
1389     }
1391     /**
1392      * Clicks on a category in the management interface.
1393      *
1394      * @Given /^I click on category "(?P<name_string>(?:[^"]|\\")*)" in the management interface$/
1395      * @param string $name
1396      */
1397     public function i_click_on_category_in_the_management_interface($name) {
1398         $node = $this->get_management_category_listing_node_by_name($name, true);
1399         $node->click();
1400     }
1402     /**
1403      * Clicks on a course in the management interface.
1404      *
1405      * @Given /^I click on course "(?P<name_string>(?:[^"]|\\")*)" in the management interface$/
1406      * @param string $name
1407      */
1408     public function i_click_on_course_in_the_management_interface($name) {
1409         $node = $this->get_management_course_listing_node_by_name($name, true);
1410         $node->click();
1411     }
1413     /**
1414      * Clicks on a category checkbox in the management interface, if not checked.
1415      *
1416      * @Given /^I select category "(?P<name_string>(?:[^"]|\\")*)" in the management interface$/
1417      * @param string $name
1418      */
1419     public function i_select_category_in_the_management_interface($name) {
1420         $node = $this->get_management_category_listing_node_by_name($name);
1421         $node = $node->findField('bcat[]');
1422         if (!$node->isChecked()) {
1423             $node->click();
1424         }
1425     }
1427     /**
1428      * Clicks on a category checkbox in the management interface, if checked.
1429      *
1430      * @Given /^I unselect category "(?P<name_string>(?:[^"]|\\")*)" in the management interface$/
1431      * @param string $name
1432      */
1433     public function i_unselect_category_in_the_management_interface($name) {
1434         $node = $this->get_management_category_listing_node_by_name($name);
1435         $node = $node->findField('bcat[]');
1436         if ($node->isChecked()) {
1437             $node->click();
1438         }
1439     }
1441     /**
1442      * Clicks course checkbox in the management interface, if not checked.
1443      *
1444      * @Given /^I select course "(?P<name_string>(?:[^"]|\\")*)" in the management interface$/
1445      * @param string $name
1446      */
1447     public function i_select_course_in_the_management_interface($name) {
1448         $node = $this->get_management_course_listing_node_by_name($name);
1449         $node = $node->findField('bc[]');
1450         if (!$node->isChecked()) {
1451             $node->click();
1452         }
1453     }
1455     /**
1456      * Clicks course checkbox in the management interface, if checked.
1457      *
1458      * @Given /^I unselect course "(?P<name_string>(?:[^"]|\\")*)" in the management interface$/
1459      * @param string $name
1460      */
1461     public function i_unselect_course_in_the_management_interface($name) {
1462         $node = $this->get_management_course_listing_node_by_name($name);
1463         $node = $node->findField('bc[]');
1464         if ($node->isChecked()) {
1465             $node->click();
1466         }
1467     }
1469     /**
1470      * Move selected categories to top level in the management interface.
1471      *
1472      * @Given /^I move category "(?P<name_string>(?:[^"]|\\")*)" to top level in the management interface$/
1473      * @param string $name
1474      */
1475     public function i_move_category_to_top_level_in_the_management_interface($name) {
1476         $this->i_select_category_in_the_management_interface($name);
1478         $this->execute('behat_forms::i_set_the_field_to',
1479             array('menumovecategoriesto', core_course_category::get(0)->get_formatted_name())
1480         );
1482         // Save event.
1483         $this->execute("behat_forms::press_button", "bulkmovecategories");
1484     }
1486     /**
1487      * Checks that a category is a subcategory of specific category.
1488      *
1489      * @Given /^I should see category "(?P<subcatidnumber_string>(?:[^"]|\\")*)" as subcategory of "(?P<catidnumber_string>(?:[^"]|\\")*)" in the management interface$/
1490      * @throws ExpectationException
1491      * @param string $subcatidnumber
1492      * @param string $catidnumber
1493      */
1494     public function i_should_see_category_as_subcategory_of_in_the_management_interface($subcatidnumber, $catidnumber) {
1495         $categorynodeid = $this->get_category_id($catidnumber);
1496         $subcategoryid = $this->get_category_id($subcatidnumber);
1497         $exception = new ExpectationException('The category '.$subcatidnumber.' is not a subcategory of '.$catidnumber, $this->getSession());
1498         $selector = sprintf('#category-listing .listitem-category[data-id="%d"] .listitem-category[data-id="%d"]', $categorynodeid, $subcategoryid);
1499         $this->find('css', $selector, $exception);
1500     }
1502     /**
1503      * Checks that a category is not a subcategory of specific category.
1504      *
1505      * @Given /^I should not see category "(?P<subcatidnumber_string>(?:[^"]|\\")*)" as subcategory of "(?P<catidnumber_string>(?:[^"]|\\")*)" in the management interface$/
1506      * @throws ExpectationException
1507      * @param string $subcatidnumber
1508      * @param string $catidnumber
1509      */
1510     public function i_should_not_see_category_as_subcategory_of_in_the_management_interface($subcatidnumber, $catidnumber) {
1511         try {
1512             $this->i_should_see_category_as_subcategory_of_in_the_management_interface($subcatidnumber, $catidnumber);
1513         } catch (ExpectationException $e) {
1514             // ExpectedException means that it is not highlighted.
1515             return;
1516         }
1517         throw new ExpectationException('The category '.$subcatidnumber.' is a subcategory of '.$catidnumber, $this->getSession());
1518     }
1520     /**
1521      * Click to expand a category revealing its sub categories within the management UI.
1522      *
1523      * @Given /^I click to expand category "(?P<idnumber_string>(?:[^"]|\\")*)" in the management interface$/
1524      * @param string $idnumber
1525      */
1526     public function i_click_to_expand_category_in_the_management_interface($idnumber) {
1527         $categorynode = $this->get_management_category_listing_node_by_idnumber($idnumber);
1528         $exception = new ExpectationException('Category "' . $idnumber . '" does not contain an expand or collapse toggle.', $this->getSession());
1529         $togglenode = $this->find('css', 'a[data-action=collapse],a[data-action=expand]', $exception, $categorynode);
1530         $togglenode->click();
1531     }
1533     /**
1534      * Checks that a category within the management interface is visible.
1535      *
1536      * @Given /^category in management listing should be visible "(?P<idnumber_string>(?:[^"]|\\")*)"$/
1537      * @param string $idnumber
1538      */
1539     public function category_in_management_listing_should_be_visible($idnumber) {
1540         $id = $this->get_category_id($idnumber);
1541         $exception = new ExpectationException('The category '.$idnumber.' is not visible.', $this->getSession());
1542         $selector = sprintf('#category-listing .listitem-category[data-id="%d"][data-visible="1"]', $id);
1543         $this->find('css', $selector, $exception);
1544     }
1546     /**
1547      * Checks that a category within the management interface is dimmed.
1548      *
1549      * @Given /^category in management listing should be dimmed "(?P<idnumber_string>(?:[^"]|\\")*)"$/
1550      * @param string $idnumber
1551      */
1552     public function category_in_management_listing_should_be_dimmed($idnumber) {
1553         $id = $this->get_category_id($idnumber);
1554         $selector = sprintf('#category-listing .listitem-category[data-id="%d"][data-visible="0"]', $id);
1555         $exception = new ExpectationException('The category '.$idnumber.' is visible.', $this->getSession());
1556         $this->find('css', $selector, $exception);
1557     }
1559     /**
1560      * Checks that a course within the management interface is visible.
1561      *
1562      * @Given /^course in management listing should be visible "(?P<idnumber_string>(?:[^"]|\\")*)"$/
1563      * @param string $idnumber
1564      */
1565     public function course_in_management_listing_should_be_visible($idnumber) {
1566         $id = $this->get_course_id($idnumber);
1567         $exception = new ExpectationException('The course '.$idnumber.' is not visible.', $this->getSession());
1568         $selector = sprintf('#course-listing .listitem-course[data-id="%d"][data-visible="1"]', $id);
1569         $this->find('css', $selector, $exception);
1570     }
1572     /**
1573      * Checks that a course within the management interface is dimmed.
1574      *
1575      * @Given /^course in management listing should be dimmed "(?P<idnumber_string>(?:[^"]|\\")*)"$/
1576      * @param string $idnumber
1577      */
1578     public function course_in_management_listing_should_be_dimmed($idnumber) {
1579         $id = $this->get_course_id($idnumber);
1580         $exception = new ExpectationException('The course '.$idnumber.' is visible.', $this->getSession());
1581         $selector = sprintf('#course-listing .listitem-course[data-id="%d"][data-visible="0"]', $id);
1582         $this->find('css', $selector, $exception);
1583     }
1585     /**
1586      * Toggles the visibility of a course in the management UI.
1587      *
1588      * If it was visible it will be hidden. If it is hidden it will be made visible.
1589      *
1590      * @Given /^I toggle visibility of course "(?P<idnumber_string>(?:[^"]|\\")*)" in management listing$/
1591      * @param string $idnumber
1592      */
1593     public function i_toggle_visibility_of_course_in_management_listing($idnumber) {
1594         $id = $this->get_course_id($idnumber);
1595         $selector = sprintf('#course-listing .listitem-course[data-id="%d"][data-visible]', $id);
1596         $node = $this->find('css', $selector);
1597         $exception = new ExpectationException('Course listing "' . $idnumber . '" does not contain a show or hide toggle.', $this->getSession());
1598         if ($node->getAttribute('data-visible') === '1') {
1599             $toggle = $this->find('css', '.action-hide', $exception, $node);
1600         } else {
1601             $toggle = $this->find('css', '.action-show', $exception, $node);
1602         }
1603         $toggle->click();
1604     }
1606     /**
1607      * Toggles the visibility of a category in the management UI.
1608      *
1609      * If it was visible it will be hidden. If it is hidden it will be made visible.
1610      *
1611      * @Given /^I toggle visibility of category "(?P<idnumber_string>(?:[^"]|\\")*)" in management listing$/
1612      */
1613     public function i_toggle_visibility_of_category_in_management_listing($idnumber) {
1614         $id = $this->get_category_id($idnumber);
1615         $selector = sprintf('#category-listing .listitem-category[data-id="%d"][data-visible]', $id);
1616         $node = $this->find('css', $selector);
1617         $exception = new ExpectationException('Category listing "' . $idnumber . '" does not contain a show or hide toggle.', $this->getSession());
1618         if ($node->getAttribute('data-visible') === '1') {
1619             $toggle = $this->find('css', '.action-hide', $exception, $node);
1620         } else {
1621             $toggle = $this->find('css', '.action-show', $exception, $node);
1622         }
1623         $toggle->click();
1624     }
1626     /**
1627      * Moves a category displayed in the management interface up or down one place.
1628      *
1629      * @Given /^I click to move category "(?P<idnumber_string>(?:[^"]|\\")*)" (?P<direction>up|down) one$/
1630      *
1631      * @param string $idnumber The category idnumber
1632      * @param string $direction The direction to move in, either up or down
1633      */
1634     public function i_click_to_move_category_by_one($idnumber, $direction) {
1635         $node = $this->get_management_category_listing_node_by_idnumber($idnumber);
1636         $this->user_moves_listing_by_one('category', $node, $direction);
1637     }
1639     /**
1640      * Moves a course displayed in the management interface up or down one place.
1641      *
1642      * @Given /^I click to move course "(?P<idnumber_string>(?:[^"]|\\")*)" (?P<direction>up|down) one$/
1643      *
1644      * @param string $idnumber The course idnumber
1645      * @param string $direction The direction to move in, either up or down
1646      */
1647     public function i_click_to_move_course_by_one($idnumber, $direction) {
1648         $node = $this->get_management_course_listing_node_by_idnumber($idnumber);
1649         $this->user_moves_listing_by_one('course', $node, $direction);
1650     }
1652     /**
1653      * Moves a course or category listing within the management interface up or down by one.
1654      *
1655      * @param string $listingtype One of course or category
1656      * @param \Behat\Mink\Element\NodeElement $listingnode
1657      * @param string $direction One of up or down.
1658      * @param bool $highlight If set to false we don't check the node has been highlighted.
1659      */
1660     protected function user_moves_listing_by_one($listingtype, $listingnode, $direction, $highlight = true) {
1661         $up = (strtolower($direction) === 'up');
1662         if ($up) {
1663             $exception = new ExpectationException($listingtype.' listing does not contain a moveup button.', $this->getSession());
1664             $button = $this->find('css', 'a.action-moveup', $exception, $listingnode);
1665         } else {
1666             $exception = new ExpectationException($listingtype.' listing does not contain a movedown button.', $this->getSession());
1667             $button = $this->find('css', 'a.action-movedown', $exception, $listingnode);
1668         }
1669         $button->click();
1670         if ($this->running_javascript() && $highlight) {
1671             $listitem = $listingnode->getParent();
1672             $exception = new ExpectationException('Nothing was highlighted, ajax didn\'t occur or didn\'t succeed.', $this->getSession());
1673             $this->spin(array($this, 'listing_is_highlighted'), $listitem->getTagName().'#'.$listitem->getAttribute('id'), 2, $exception, true);
1674         }
1675     }
1677     /**
1678      * Used by spin to determine the callback has been highlighted.
1679      *
1680      * @param behat_course $self A self reference (default first arg from a spin callback)
1681      * @param \Behat\Mink\Element\NodeElement $selector
1682      * @return bool
1683      */
1684     protected function listing_is_highlighted($self, $selector) {
1685         $listitem = $this->find('css', $selector);
1686         return $listitem->hasClass('highlight');
1687     }
1689     /**
1690      * Check that one course appears before another in the course category management listings.
1691      *
1692      * @Given /^I should see course listing "(?P<preceedingcourse_string>(?:[^"]|\\")*)" before "(?P<followingcourse_string>(?:[^"]|\\")*)"$/
1693      *
1694      * @param string $preceedingcourse The first course to find
1695      * @param string $followingcourse The second course to find (should be AFTER the first course)
1696      * @throws ExpectationException
1697      */
1698     public function i_should_see_course_listing_before($preceedingcourse, $followingcourse) {
1699         $xpath = "//div[@id='course-listing']//li[contains(concat(' ', @class, ' '), ' listitem-course ')]//a[text()='{$preceedingcourse}']/ancestor::li[@data-id]//following::a[text()='{$followingcourse}']";
1700         $msg = "{$preceedingcourse} course does not appear before {$followingcourse} course";
1701         if (!$this->getSession()->getDriver()->find($xpath)) {
1702             throw new ExpectationException($msg, $this->getSession());
1703         }
1704     }
1706     /**
1707      * Check that one category appears before another in the course category management listings.
1708      *
1709      * @Given /^I should see category listing "(?P<preceedingcategory_string>(?:[^"]|\\")*)" before "(?P<followingcategory_string>(?:[^"]|\\")*)"$/
1710      *
1711      * @param string $preceedingcategory The first category to find
1712      * @param string $followingcategory The second category to find (should be after the first category)
1713      * @throws ExpectationException
1714      */
1715     public function i_should_see_category_listing_before($preceedingcategory, $followingcategory) {
1716         $xpath = "//div[@id='category-listing']//li[contains(concat(' ', @class, ' '), ' listitem-category ')]//a[text()='{$preceedingcategory}']/ancestor::li[@data-id]//following::a[text()='{$followingcategory}']";
1717         $msg = "{$preceedingcategory} category does not appear before {$followingcategory} category";
1718         if (!$this->getSession()->getDriver()->find($xpath)) {
1719             throw new ExpectationException($msg, $this->getSession());
1720         }
1721     }
1723     /**
1724      * Checks that we are on the course management page that we expect to be on and that no course has been selected.
1725      *
1726      * @Given /^I should see the "(?P<mode_string>(?:[^"]|\\")*)" management page$/
1727      * @param string $mode The mode to expected. One of 'Courses', 'Course categories' or 'Course categories and courses'
1728      */
1729     public function i_should_see_the_courses_management_page($mode) {
1730         $this->execute("behat_general::assert_element_contains_text",
1731             array("Course and category management", "h2", "css_element")
1732         );
1734         switch ($mode) {
1735             case "Courses":
1736                 $this->execute("behat_general::should_not_exist", array("#category-listing", "css_element"));
1737                 $this->execute("behat_general::should_exist", array("#course-listing", "css_element"));
1738                 break;
1740             case "Course categories":
1741                 $this->execute("behat_general::should_exist", array("#category-listing", "css_element"));
1742                 $this->execute("behat_general::should_exist", array("#course-listing", "css_element"));
1743                 break;
1745             case "Courses categories and courses":
1746             default:
1747                 $this->execute("behat_general::should_exist", array("#category-listing", "css_element"));
1748                 $this->execute("behat_general::should_exist", array("#course-listing", "css_element"));
1749                 break;
1750         }
1752         $this->execute("behat_general::should_not_exist", array("#course-detail", "css_element"));
1753     }
1755     /**
1756      * Checks that we are on the course management page that we expect to be on and that a course has been selected.
1757      *
1758      * @Given /^I should see the "(?P<mode_string>(?:[^"]|\\")*)" management page with a course selected$/
1759      * @param string $mode The mode to expected. One of 'Courses', 'Course categories' or 'Course categories and courses'
1760      */
1761     public function i_should_see_the_courses_management_page_with_a_course_selected($mode) {
1762         $this->execute("behat_general::assert_element_contains_text",
1763             array("Course and category management", "h2", "css_element"));
1765         switch ($mode) {
1766             case "Courses":
1767                 $this->execute("behat_general::should_not_exist", array("#category-listing", "css_element"));
1768                 $this->execute("behat_general::should_exist", array("#course-listing", "css_element"));
1769                 break;
1771             case "Course categories":
1772                 $this->execute("behat_general::should_exist", array("#category-listing", "css_element"));
1773                 $this->execute("behat_general::should_exist", array("#course-listing", "css_element"));
1774                 break;
1776             case "Courses categories and courses":
1777             default:
1778                 $this->execute("behat_general::should_exist", array("#category-listing", "css_element"));
1779                 $this->execute("behat_general::should_exist", array("#course-listing", "css_element"));
1780                 break;
1781         }
1783         $this->execute("behat_general::should_exist", array("#course-detail", "css_element"));
1784     }
1786     /**
1787      * Locates a course in the course category management interface and then triggers an action for it.
1788      *
1789      * @Given /^I click on "(?P<action_string>(?:[^"]|\\")*)" action for "(?P<name_string>(?:[^"]|\\")*)" in management course listing$/
1790      *
1791      * @param string $action The action to take. One of
1792      * @param string $name The name of the course as it is displayed in the management interface.
1793      */
1794     public function i_click_on_action_for_item_in_management_course_listing($action, $name) {
1795         $node = $this->get_management_course_listing_node_by_name($name);
1796         $this->user_clicks_on_management_listing_action('course', $node, $action);
1797     }
1799     /**
1800      * Locates a category in the course category management interface and then triggers an action for it.
1801      *
1802      * @Given /^I click on "(?P<action_string>(?:[^"]|\\")*)" action for "(?P<name_string>(?:[^"]|\\")*)" in management category listing$/
1803      *
1804      * @param string $action The action to take. One of
1805      * @param string $name The name of the category as it is displayed in the management interface.
1806      */
1807     public function i_click_on_action_for_item_in_management_category_listing($action, $name) {
1808         $node = $this->get_management_category_listing_node_by_name($name);
1809         $this->user_clicks_on_management_listing_action('category', $node, $action);
1810     }
1812     /**
1813      * Clicks to expand or collapse a category displayed on the frontpage
1814      *
1815      * @Given /^I toggle "(?P<categoryname_string>(?:[^"]|\\")*)" category children visibility in frontpage$/
1816      * @throws ExpectationException
1817      * @param string $categoryname
1818      */
1819     public function i_toggle_category_children_visibility_in_frontpage($categoryname) {
1821         $headingtags = array();
1822         for ($i = 1; $i <= 6; $i++) {
1823             $headingtags[] = 'self::h' . $i;
1824         }
1826         $exception = new ExpectationException('"' . $categoryname . '" category can not be found', $this->getSession());
1827         $categoryliteral = behat_context_helper::escape($categoryname);
1828         $xpath = "//div[@class='info']/descendant::*[" . implode(' or ', $headingtags) . "][@class='categoryname'][./descendant::a[.=$categoryliteral]]";
1829         $node = $this->find('xpath', $xpath, $exception);
1830         $node->click();
1832         // Smooth expansion.
1833         $this->getSession()->wait(1000);
1834     }
1836     /**
1837      * Finds the node to use for a management listitem action and clicks it.
1838      *
1839      * @param string $listingtype Either course or category.
1840      * @param \Behat\Mink\Element\NodeElement $listingnode
1841      * @param string $action The action being taken
1842      * @throws Behat\Mink\Exception\ExpectationException
1843      */
1844     protected function user_clicks_on_management_listing_action($listingtype, $listingnode, $action) {
1845         $actionsnode = $listingnode->find('xpath', "//*[contains(concat(' ', normalize-space(@class), ' '), '{$listingtype}-item-actions')]");
1846         if (!$actionsnode) {
1847             throw new ExpectationException("Could not find the actions for $listingtype", $this->getSession());
1848         }
1849         $actionnode = $actionsnode->find('css', '.action-'.$action);
1850         if (!$actionnode) {
1851             throw new ExpectationException("Expected action was not available or not found ($action)", $this->getSession());
1852         }
1853         if ($this->running_javascript() && !$actionnode->isVisible()) {
1854             $actionsnode->find('css', 'a.toggle-display')->click();
1855             $actionnode = $actionsnode->find('css', '.action-'.$action);
1856         }
1857         $actionnode->click();
1858     }
1860     /**
1861      * Clicks on a category in the management interface.
1862      *
1863      * @Given /^I click on "(?P<categoryname_string>(?:[^"]|\\")*)" category in the management category listing$/
1864      * @param string $name The name of the category to click.
1865      */
1866     public function i_click_on_category_in_the_management_category_listing($name) {
1867         $node = $this->get_management_category_listing_node_by_name($name);
1868         $node->find('css', 'a.categoryname')->click();
1869     }
1871     /**
1872      * Go to the course participants
1873      *
1874      * @Given /^I navigate to course participants$/
1875      */
1876     public function i_navigate_to_course_participants() {
1877         $coursestr = behat_context_helper::escape(get_string('courses'));
1878         $mycoursestr = behat_context_helper::escape(get_string('mycourses'));
1879         $xpath = "//div[contains(@class,'block')]//li[p/*[string(.)=$coursestr or string(.)=$mycoursestr]]";
1880         $this->execute('behat_general::i_click_on_in_the', [get_string('participants'), 'link', $xpath, 'xpath_element']);
1881     }
1883     /**
1884      * Check that one teacher appears before another in the course contacts.
1885      *
1886      * @Given /^I should see teacher "(?P<pteacher_string>(?:[^"]|\\")*)" before "(?P<fteacher_string>(?:[^"]|\\")*)" in the course contact listing$/
1887      *
1888      * @param string $pteacher The first teacher to find
1889      * @param string $fteacher The second teacher to find (should be after the first teacher)
1890      *
1891      * @throws ExpectationException
1892      */
1893     public function i_should_see_teacher_before($pteacher, $fteacher) {
1894         $xpath = "//ul[contains(@class,'teachers')]//li//a[text()='{$pteacher}']/ancestor::li//following::a[text()='{$fteacher}']";
1895         $msg = "Teacher {$pteacher} does not appear before Teacher {$fteacher}";
1896         if (!$this->getSession()->getDriver()->find($xpath)) {
1897             throw new ExpectationException($msg, $this->getSession());
1898         }
1899     }
1901     /**
1902      * Check that one teacher oes not appears after another in the course contacts.
1903      *
1904      * @Given /^I should not see teacher "(?P<fteacher_string>(?:[^"]|\\")*)" after "(?P<pteacher_string>(?:[^"]|\\")*)" in the course contact listing$/
1905      *
1906      * @param string $fteacher The teacher that should not be found (after the other teacher)
1907      * @param string $pteacher The teacher after who the other should not be found (this teacher must be found!)
1908      *
1909      * @throws ExpectationException
1910      */
1911     public function i_should_not_see_teacher_after($fteacher, $pteacher) {
1912         $xpathliteral = behat_context_helper::escape($pteacher);
1913         $xpath = "/descendant-or-self::*[contains(., $xpathliteral)]" .
1914                 "[count(descendant::*[contains(., $xpathliteral)]) = 0]";
1915         try {
1916             $nodes = $this->find_all('xpath', $xpath);
1917         } catch (ElementNotFoundException $e) {
1918             throw new ExpectationException('"' . $pteacher . '" text was not found in the page', $this->getSession());
1919         }
1920         $xpath = "//ul[contains(@class,'teachers')]//li//a[text()='{$pteacher}']/ancestor::li//following::a[text()='{$fteacher}']";
1921         $msg = "Teacher {$fteacher} appears after Teacher {$pteacher}";
1922         if ($this->getSession()->getDriver()->find($xpath)) {
1923             throw new ExpectationException($msg, $this->getSession());
1924         }
1925     }