ffe7470019a95f608f7a6764bb1c0125a9274500
[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\Behat\Context\Step\Given as Given,
31     Behat\Gherkin\Node\TableNode as TableNode,
32     Behat\Mink\Exception\ExpectationException as ExpectationException,
33     Behat\Mink\Exception\DriverException as DriverException,
34     Behat\Mink\Exception\ElementNotFoundException as ElementNotFoundException;
36 /**
37  * Course-related steps definitions.
38  *
39  * @package    core_course
40  * @category   test
41  * @copyright  2012 David MonllaĆ³
42  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
43  */
44 class behat_course extends behat_base {
46     /**
47      * Turns editing mode on.
48      * @Given /^I turn editing mode on$/
49      */
50     public function i_turn_editing_mode_on() {
51         return new Given('I press "' . get_string('turneditingon') . '"');
52     }
54     /**
55      * Turns editing mode off.
56      * @Given /^I turn editing mode off$/
57      */
58     public function i_turn_editing_mode_off() {
59         return new Given('I press "' . get_string('turneditingoff') . '"');
60     }
62     /**
63      * Creates a new course with the provided table data matching course settings names with the desired values.
64      *
65      * @Given /^I create a course with:$/
66      * @param TableNode $table The course data
67      * @return Given[]
68      */
69     public function i_create_a_course_with(TableNode $table) {
71         $steps = array(
72             new Given('I go to the courses management page'),
73             new Given('I should see the "'.get_string('categories').'" management page'),
74             new Given('I click on category "'.get_string('miscellaneous').'" in the management interface'),
75             new Given('I should see the "'.get_string('categoriesandcoures').'" management page'),
76             new Given('I click on "'.get_string('createnewcourse').'" "link" in the "#course-listing" "css_element"')
77         );
79         // If the course format is one of the fields we change how we
80         // fill the form as we need to wait for the form to be set.
81         $rowshash = $table->getRowsHash();
82         $formatfieldrefs = array(get_string('format'), 'format', 'id_format');
83         foreach ($formatfieldrefs as $fieldref) {
84             if (!empty($rowshash[$fieldref])) {
85                 $formatfield = $fieldref;
86             }
87         }
89         // Setting the format separately.
90         if (!empty($formatfield)) {
92             // Removing the format field from the TableNode.
93             $rows = $table->getRows();
94             $formatvalue = $rowshash[$formatfield];
95             foreach ($rows as $key => $row) {
96                 if ($row[0] == $formatfield) {
97                     unset($rows[$key]);
98                 }
99             }
100             $table->setRows($rows);
102             // Adding a forced wait until editors are loaded as otherwise selenium sometimes tries clicks on the
103             // format field when the editor is being rendered and the click misses the field coordinates.
104             $steps[] = new Given('I expand all fieldsets');
105             $steps[] = new Given('I set the field "' . $formatfield . '" to "' . $formatvalue . '"');
106             $steps[] = new Given('I set the following fields to these values:', $table);
107         } else {
108             $steps[] = new Given('I set the following fields to these values:', $table);
109         }
111         $steps[] = new Given('I press "' . get_string('savechangesanddisplay') . '"');
113         return $steps;
114     }
116     /**
117      * Goes to the system courses/categories management page.
118      *
119      * @Given /^I go to the courses management page$/
120      * @return Given[]
121      */
122     public function i_go_to_the_courses_management_page() {
123         return array(
124             new Given('I am on homepage'),
125             new Given('I navigate to "' . get_string('coursemgmt', 'admin') . '" node in "' . get_string('administrationsite') . ' > ' . get_string('courses', 'admin') . '"')
126         );
127     }
129     /**
130      * Adds the selected activity/resource filling the form data with the specified field/value pairs. Sections 0 and 1 are also allowed on frontpage.
131      *
132      * @When /^I add a "(?P<activity_or_resource_name_string>(?:[^"]|\\")*)" to section "(?P<section_number>\d+)" and I fill the form with:$/
133      * @param string $activity The activity name
134      * @param int $section The section number
135      * @param TableNode $data The activity field/value data
136      * @return Given[]
137      */
138     public function i_add_to_section_and_i_fill_the_form_with($activity, $section, TableNode $data) {
140         return array(
141             new Given('I add a "' . $this->escape($activity) . '" to section "' . $this->escape($section) . '"'),
142             new Given('I set the following fields to these values:', $data),
143             new Given('I press "' . get_string('savechangesandreturntocourse') . '"')
144         );
145     }
147     /**
148      * Opens the activity chooser and opens the activity/resource form page. Sections 0 and 1 are also allowed on frontpage.
149      *
150      * @Given /^I add a "(?P<activity_or_resource_name_string>(?:[^"]|\\")*)" to section "(?P<section_number>\d+)"$/
151      * @throws ElementNotFoundException Thrown by behat_base::find
152      * @param string $activity
153      * @param int $section
154      */
155     public function i_add_to_section($activity, $section) {
157         if ($this->getSession()->getPage()->find('css', 'body#page-site-index') && (int)$section <= 1) {
158             // We are on the frontpage.
159             if ($section) {
160                 // Section 1 represents the contents on the frontpage.
161                 $sectionxpath = "//body[@id='page-site-index']/descendant::div[contains(concat(' ',normalize-space(@class),' '),' sitetopic ')]";
162             } else {
163                 // Section 0 represents "Site main menu" block.
164                 $sectionxpath = "//div[contains(concat(' ',normalize-space(@class),' '),' block_site_main_menu ')]";
165             }
166         } else {
167             // We are inside the course.
168             $sectionxpath = "//li[@id='section-" . $section . "']";
169         }
171         $activityliteral = $this->getSession()->getSelectorsHandler()->xpathLiteral(ucfirst($activity));
173         if ($this->running_javascript()) {
175             // Clicks add activity or resource section link.
176             $sectionxpath = $sectionxpath . "/descendant::div[@class='section-modchooser']/span/a";
177             $sectionnode = $this->find('xpath', $sectionxpath);
178             $sectionnode->click();
180             // Clicks the selected activity if it exists.
181             $activityxpath = "//div[@id='chooseform']/descendant::label" .
182                 "/descendant::span[contains(concat(' ', normalize-space(@class), ' '), ' typename ')]" .
183                 "[normalize-space(.)=$activityliteral]" .
184                 "/parent::label/child::input";
185             $activitynode = $this->find('xpath', $activityxpath);
186             $activitynode->doubleClick();
188         } else {
189             // Without Javascript.
191             // Selecting the option from the select box which contains the option.
192             $selectxpath = $sectionxpath . "/descendant::div[contains(concat(' ', normalize-space(@class), ' '), ' section_add_menus ')]" .
193                 "/descendant::select[option[normalize-space(.)=$activityliteral]]";
194             $selectnode = $this->find('xpath', $selectxpath);
195             $selectnode->selectOption($activity);
197             // Go button.
198             $gobuttonxpath = $selectxpath . "/ancestor::form/descendant::input[@type='submit']";
199             $gobutton = $this->find('xpath', $gobuttonxpath);
200             $gobutton->click();
201         }
203     }
206     /**
207      * Opens a section edit menu if it is not already opened.
208      *
209      * @Given /^I open section "(?P<section_number>\d+)" edit menu$/
210      * @throws DriverException The step is not available when Javascript is disabled
211      * @param string $sectionnumber
212      */
213     public function i_open_section_edit_menu($sectionnumber) {
214         if (!$this->running_javascript()) {
215             throw new DriverException('Section edit menu not available when Javascript is disabled');
216         }
218         // If it is already opened we do nothing.
219         $xpath = $this->section_exists($sectionnumber);
220         $xpath .= "/descendant::div[contains(@class, 'section-actions')]/descendant::a[contains(@class, 'textmenu')]";
222         $exception = new ExpectationException('Section "' . $sectionnumber . '" was not found', $this->getSession());
223         $menu = $this->find('xpath', $xpath, $exception);
224         $menu->click();
225         $this->i_wait_until_section_is_available($sectionnumber);
226     }
228     /**
229      * Deletes course section.
230      *
231      * @Given /^I delete section "(?P<section_number>\d+)"$/
232      * @param int $sectionnumber The section number
233      * @return Given[]
234      */
235     public function i_delete_section($sectionnumber) {
236         // Ensures the section exists.
237         $xpath = $this->section_exists($sectionnumber);
239         // We need to know the course format as the text strings depends on them.
240         $courseformat = $this->get_course_format();
241         if (get_string_manager()->string_exists('deletesection', $courseformat)) {
242             $strdelete = get_string('deletesection', $courseformat);
243         } else {
244             $strdelete = get_string('deletesection');
245         }
247         // If javascript is on, link is inside a menu.
248         if ($this->running_javascript()) {
249             $this->i_open_section_edit_menu($sectionnumber);
250         }
252         return new Given('I click on "' . $strdelete . '" "link" in the "' . $this->escape($xpath) . '" "xpath_element"');
253     }
255     /**
256      * Turns course section highlighting on.
257      *
258      * @Given /^I turn section "(?P<section_number>\d+)" highlighting on$/
259      * @param int $sectionnumber The section number
260      * @return Given[]
261      */
262     public function i_turn_section_highlighting_on($sectionnumber) {
264         // Ensures the section exists.
265         $xpath = $this->section_exists($sectionnumber);
267         // If javascript is on, link is inside a menu.
268         if ($this->running_javascript()) {
269             $this->i_open_section_edit_menu($sectionnumber);
270         }
272         return new Given('I click on "' . get_string('markthistopic') . '" "link" in the "' . $this->escape($xpath) . '" "xpath_element"');
273     }
275     /**
276      * Turns course section highlighting off.
277      *
278      * @Given /^I turn section "(?P<section_number>\d+)" highlighting off$/
279      * @param int $sectionnumber The section number
280      * @return Given[]
281      */
282     public function i_turn_section_highlighting_off($sectionnumber) {
284         // Ensures the section exists.
285         $xpath = $this->section_exists($sectionnumber);
287         // If javascript is on, link is inside a menu.
288         if ($this->running_javascript()) {
289             $this->i_open_section_edit_menu($sectionnumber);
290         }
292         return new Given('I click on "' . get_string('markedthistopic') . '" "link" in the "' . $this->escape($xpath) . '" "xpath_element"');
293     }
295     /**
296      * Shows the specified hidden section. You need to be in the course page and on editing mode.
297      *
298      * @Given /^I show section "(?P<section_number>\d+)"$/
299      * @param int $sectionnumber
300      */
301     public function i_show_section($sectionnumber) {
302         $showlink = $this->show_section_icon_exists($sectionnumber);
303         $showlink->click();
305         if ($this->running_javascript()) {
306             $this->getSession()->wait(self::TIMEOUT * 1000, self::PAGE_READY_JS);
307             $this->i_wait_until_section_is_available($sectionnumber);
308         }
309     }
311     /**
312      * Hides the specified visible section. You need to be in the course page and on editing mode.
313      *
314      * @Given /^I hide section "(?P<section_number>\d+)"$/
315      * @param int $sectionnumber
316      */
317     public function i_hide_section($sectionnumber) {
318         $hidelink = $this->hide_section_icon_exists($sectionnumber);
319         $hidelink->click();
321         if ($this->running_javascript()) {
322             $this->getSession()->wait(self::TIMEOUT * 1000, self::PAGE_READY_JS);
323             $this->i_wait_until_section_is_available($sectionnumber);
324         }
325     }
327     /**
328      * Go to editing section page for specified section number. You need to be in the course page and on editing mode.
329      *
330      * @Given /^I edit the section "(?P<section_number>\d+)"$/
331      * @param int $sectionnumber
332      */
333     public function i_edit_the_section($sectionnumber) {
334         // If javascript is on, link is inside a menu.
335         if ($this->running_javascript()) {
336             $this->i_open_section_edit_menu($sectionnumber);
337         }
339         // We need to know the course format as the text strings depends on them.
340         $courseformat = $this->get_course_format();
341         if (get_string_manager()->string_exists('editsection', $courseformat)) {
342             $stredit = get_string('editsection', $courseformat);
343         } else {
344             $stredit = get_string('editsection');
345         }
347         return new Given('I click on "' . $stredit . '" "link" in the "#section-' . $sectionnumber . '" "css_element"');
348     }
350     /**
351      * Edit specified section and fill the form data with the specified field/value pairs.
352      *
353      * @When /^I edit the section "(?P<section_number>\d+)" and I fill the form with:$/
354      * @param int $sectionnumber The section number
355      * @param TableNode $data The activity field/value data
356      * @return Given[]
357      */
358     public function i_edit_the_section_and_i_fill_the_form_with($sectionnumber, TableNode $data) {
360         return array(
361             new Given('I edit the section "' . $sectionnumber . '"'),
362             new Given('I set the following fields to these values:', $data),
363             new Given('I press "' . get_string('savechanges') . '"')
364         );
365     }
367     /**
368      * Checks if the specified course section hightlighting is turned on. You need to be in the course page on editing mode.
369      *
370      * @Then /^section "(?P<section_number>\d+)" should be highlighted$/
371      * @throws ExpectationException
372      * @param int $sectionnumber The section number
373      */
374     public function section_should_be_highlighted($sectionnumber) {
376         // Ensures the section exists.
377         $xpath = $this->section_exists($sectionnumber);
379         // The important checking, we can not check the img.
380         $xpath = $xpath . "/descendant::img[contains(@src, 'marked')]";
381         $exception = new ExpectationException('The "' . $sectionnumber . '" section is not highlighted', $this->getSession());
382         $this->find('xpath', $xpath, $exception);
383     }
385     /**
386      * Checks if the specified course section highlighting is turned off. You need to be in the course page on editing mode.
387      *
388      * @Then /^section "(?P<section_number>\d+)" should not be highlighted$/
389      * @throws ExpectationException
390      * @param int $sectionnumber The section number
391      */
392     public function section_should_not_be_highlighted($sectionnumber) {
394         // We only catch ExpectationException, ElementNotFoundException should be thrown if the specified section does not exist.
395         try {
396             $this->section_should_be_highlighted($sectionnumber);
397         } catch (ExpectationException $e) {
398             // ExpectedException means that it is not highlighted.
399             return;
400         }
402         throw new ExpectationException('The "' . $sectionnumber . '" section is highlighted', $this->getSession());
403     }
405     /**
406      * 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.
407      *
408      * @Then /^section "(?P<section_number>\d+)" should be hidden$/
409      * @throws ExpectationException
410      * @throws ElementNotFoundException Thrown by behat_base::find
411      * @param int $sectionnumber
412      */
413     public function section_should_be_hidden($sectionnumber) {
415         $sectionxpath = $this->section_exists($sectionnumber);
417         // Preventive in case there is any action in progress.
418         // Adding it here because we are interacting (click) with
419         // the elements, not necessary when we just find().
420         $this->i_wait_until_section_is_available($sectionnumber);
422         // Section should be hidden.
423         $exception = new ExpectationException('The section is not hidden', $this->getSession());
424         $this->find('xpath', $sectionxpath . "[contains(concat(' ', normalize-space(@class), ' '), ' hidden ')]", $exception);
425     }
427     /**
428      * 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.
429      *
430      * @Then /^all activities in section "(?P<section_number>\d+)" should be hidden$/
431      * @throws ExpectationException
432      * @throws ElementNotFoundException Thrown by behat_base::find
433      * @param int $sectionnumber
434      */
435     public function section_activities_should_be_hidden($sectionnumber) {
436         $sectionxpath = $this->section_exists($sectionnumber);
438         // Preventive in case there is any action in progress.
439         // Adding it here because we are interacting (click) with
440         // the elements, not necessary when we just find().
441         $this->i_wait_until_section_is_available($sectionnumber);
443         // The checking are different depending on user permissions.
444         if ($this->is_course_editor()) {
446             // The section must be hidden.
447             $this->show_section_icon_exists($sectionnumber);
449             // If there are activities they should be hidden and the visibility icon should not be available.
450             if ($activities = $this->get_section_activities($sectionxpath)) {
452                 $dimmedexception = new ExpectationException('There are activities that are not dimmed', $this->getSession());
453                 foreach ($activities as $activity) {
454                     // Dimmed.
455                     $this->find('xpath', "//div[contains(concat(' ', normalize-space(@class), ' '), ' activityinstance ')]" .
456                         "/a[contains(concat(' ', normalize-space(@class), ' '), ' dimmed ')]", $dimmedexception, $activity);
457                 }
458             }
459         } else {
460             // There shouldn't be activities.
461             if ($this->get_section_activities($sectionxpath)) {
462                 throw new ExpectationException('There are activities in the section and they should be hidden', $this->getSession());
463             }
464         }
466     }
468     /**
469      * 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.
470      *
471      * @Then /^section "(?P<section_number>\d+)" should be visible$/
472      * @throws ExpectationException
473      * @param int $sectionnumber
474      */
475     public function section_should_be_visible($sectionnumber) {
477         $sectionxpath = $this->section_exists($sectionnumber);
479         // Section should not be hidden.
480         $xpath = $sectionxpath . "[not(contains(concat(' ', normalize-space(@class), ' '), ' hidden '))]";
481         if (!$this->getSession()->getPage()->find('xpath', $xpath)) {
482             throw new ExpectationException('The section is hidden', $this->getSession());
483         }
485         // Edit menu should be visible.
486         if ($this->is_course_editor()) {
487             $xpath = $sectionxpath .
488                      "/descendant::div[contains(@class, 'section-actions')]" .
489                      "/descendant::a[contains(@class, 'textmenu')]";
490             if (!$this->getSession()->getPage()->find('xpath', $xpath)) {
491                 throw new ExpectationException('The section edit menu is not available', $this->getSession());
492             }
493         }
494     }
496     /**
497      * Moves up the specified section, this step only works with Javascript disabled. Editing mode should be on.
498      *
499      * @Given /^I move up section "(?P<section_number>\d+)"$/
500      * @throws DriverException Step not available when Javascript is enabled
501      * @param int $sectionnumber
502      */
503     public function i_move_up_section($sectionnumber) {
505         if ($this->running_javascript()) {
506             throw new DriverException('Move a section up step is not available with Javascript enabled');
507         }
509         // Ensures the section exists.
510         $sectionxpath = $this->section_exists($sectionnumber);
512         // If javascript is on, link is inside a menu.
513         if ($this->running_javascript()) {
514             $this->i_open_section_edit_menu($sectionnumber);
515         }
517         // Follows the link
518         $moveuplink = $this->get_node_in_container('link', get_string('moveup'), 'xpath_element', $sectionxpath);
519         $moveuplink->click();
520     }
522     /**
523      * Moves down the specified section, this step only works with Javascript disabled. Editing mode should be on.
524      *
525      * @Given /^I move down section "(?P<section_number>\d+)"$/
526      * @throws DriverException Step not available when Javascript is enabled
527      * @param int $sectionnumber
528      */
529     public function i_move_down_section($sectionnumber) {
531         if ($this->running_javascript()) {
532             throw new DriverException('Move a section down step is not available with Javascript enabled');
533         }
535         // Ensures the section exists.
536         $sectionxpath = $this->section_exists($sectionnumber);
538         // If javascript is on, link is inside a menu.
539         if ($this->running_javascript()) {
540             $this->i_open_section_edit_menu($sectionnumber);
541         }
543         // Follows the link
544         $movedownlink = $this->get_node_in_container('link', get_string('movedown'), 'xpath_element', $sectionxpath);
545         $movedownlink->click();
546     }
548     /**
549      * 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.
550      *
551      * @Then /^"(?P<activity_or_resource_string>(?:[^"]|\\")*)" activity should be visible$/
552      * @param string $activityname
553      * @throws ExpectationException
554      */
555     public function activity_should_be_visible($activityname) {
557         // The activity must exists and be visible.
558         $activitynode = $this->get_activity_node($activityname);
560         if ($this->is_course_editor()) {
562             // The activity should not be dimmed.
563             try {
564                 $xpath = "/descendant-or-self::a[contains(concat(' ', normalize-space(@class), ' '), ' dimmed ')] | ".
565                          "/descendant-or-self::div[contains(concat(' ', normalize-space(@class), ' '), ' dimmed_text ')]";
566                 $this->find('xpath', $xpath, false, $activitynode);
567                 throw new ExpectationException('"' . $activityname . '" is hidden', $this->getSession());
568             } catch (ElementNotFoundException $e) {
569                 // All ok.
570             }
572             // The 'Hide' button should be available.
573             $nohideexception = new ExpectationException('"' . $activityname . '" don\'t have a "' . get_string('hide') . '" icon', $this->getSession());
574             $this->find('named', array('link', get_string('hide')), $nohideexception, $activitynode);
575         }
576     }
578     /**
579      * 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.
580      *
581      * @Then /^"(?P<activity_or_resource_string>(?:[^"]|\\")*)" activity should be hidden$/
582      * @param string $activityname
583      * @throws ExpectationException
584      */
585     public function activity_should_be_hidden($activityname) {
587         if ($this->is_course_editor()) {
589             // The activity should exist.
590             $activitynode = $this->get_activity_node($activityname);
592             // Should be hidden.
593             $exception = new ExpectationException('"' . $activityname . '" is not dimmed', $this->getSession());
594             $xpath = "/descendant-or-self::a[contains(concat(' ', normalize-space(@class), ' '), ' dimmed ')] | ".
595                      "/descendant-or-self::div[contains(concat(' ', normalize-space(@class), ' '), ' dimmed_text ')]";
596             $this->find('xpath', $xpath, $exception, $activitynode);
598             // Also 'Show' icon.
599             $noshowexception = new ExpectationException('"' . $activityname . '" don\'t have a "' . get_string('show') . '" icon', $this->getSession());
600             $this->find('named', array('link', get_string('show')), $noshowexception, $activitynode);
602         } else {
604             // It should not exist at all.
605             try {
606                 $this->find_link($activityname);
607                 throw new ExpectationException('The "' . $activityname . '" should not appear');
608             } catch (ElementNotFoundException $e) {
609                 // This is good, the activity should not be there.
610             }
611         }
613     }
615     /**
616      * 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.
617      *
618      * @Given /^I move "(?P<activity_name_string>(?:[^"]|\\")*)" activity to section "(?P<section_number>\d+)"$/
619      * @param string $activityname The activity name
620      * @param int $sectionnumber The number of section
621      * @return Given[]
622      */
623     public function i_move_activity_to_section($activityname, $sectionnumber) {
625         // Ensure the destination is valid.
626         $sectionxpath = $this->section_exists($sectionnumber);
628         $activitynode = $this->get_activity_element('.editing_move img', 'css_element', $activityname);
630         // JS enabled.
631         if ($this->running_javascript()) {
633             $destinationxpath = $sectionxpath . "/descendant::ul[contains(concat(' ', normalize-space(@class), ' '), ' yui3-dd-drop ')]";
635             return array(
636                 new Given('I drag "' . $this->escape($activitynode->getXpath()) . '" "xpath_element" ' .
637                     'and I drop it in "' . $this->escape($destinationxpath) . '" "xpath_element"'),
638             );
640         } else {
641             // Following links with no-JS.
643             // Moving to the fist spot of the section (before all other section's activities).
644             return array(
645                 new Given('I click on "a.editing_move" "css_element" in the "' . $this->escape($activityname) . '" activity'),
646                 new Given('I click on "li.movehere a" "css_element" in the "' . $this->escape($sectionxpath) . '" "xpath_element"'),
647             );
648         }
649     }
651     /**
652      * Edits the activity name through the edit activity; this step only works with Javascript enabled. Editing mode should be on.
653      *
654      * @Given /^I change "(?P<activity_name_string>(?:[^"]|\\")*)" activity name to "(?P<new_name_string>(?:[^"]|\\")*)"$/
655      * @throws DriverException Step not available when Javascript is disabled
656      * @param string $activityname
657      * @param string $newactivityname
658      * @return Given[]
659      */
660     public function i_change_activity_name_to($activityname, $newactivityname) {
662         if (!$this->running_javascript()) {
663             throw new DriverException('Change activity name step is not available with Javascript disabled');
664         }
666         // Adding chr(10) to save changes.
667         $activity = $this->escape($activityname);
668         return array(
669             new Given('I click on "' . get_string('edittitle') . '" "link" in the "' . $activity .'" activity'),
670             new Given('I set the field "title" to "' . $this->escape($newactivityname) . chr(10) . '"')
671         );
672     }
674     /**
675      * Opens an activity actions menu if it is not already opened.
676      *
677      * @Given /^I open "(?P<activity_name_string>(?:[^"]|\\")*)" actions menu$/
678      * @throws DriverException The step is not available when Javascript is disabled
679      * @param string $activityname
680      * @return Given
681      */
682     public function i_open_actions_menu($activityname) {
684         if (!$this->running_javascript()) {
685             throw new DriverException('Activities actions menu not available when Javascript is disabled');
686         }
688         // If it is already opened we do nothing.
689         $activitynode = $this->get_activity_node($activityname);
690         $classes = array_flip(explode(' ', $activitynode->getAttribute('class')));
691         if (!empty($classes['action-menu-shown'])) {
692             return;
693         }
695         return new Given('I click on "a[role=\'menuitem\']" "css_element" in the "' . $this->escape($activityname) . '" activity');
696     }
698     /**
699      * Closes an activity actions menu if it is not already closed.
700      *
701      * @Given /^I close "(?P<activity_name_string>(?:[^"]|\\")*)" actions menu$/
702      * @throws DriverException The step is not available when Javascript is disabled
703      * @param string $activityname
704      * @return Given
705      */
706     public function i_close_actions_menu($activityname) {
708         if (!$this->running_javascript()) {
709             throw new DriverException('Activities actions menu not available when Javascript is disabled');
710         }
712         // If it is already closed we do nothing.
713         $activitynode = $this->get_activity_node($activityname);
714         $classes = array_flip(explode(' ', $activitynode->getAttribute('class')));
715         if (empty($classes['action-menu-shown'])) {
716             return;
717         }
719         return new Given('I click on "a[role=\'menuitem\']" "css_element" in the "' . $this->escape($activityname) . '" activity');
720     }
722     /**
723      * Checks that the specified activity's action menu is open.
724      *
725      * @Then /^"(?P<activity_name_string>(?:[^"]|\\")*)" actions menu should be open$/
726      * @throws DriverException The step is not available when Javascript is disabled
727      * @param string $activityname
728      */
729     public function actions_menu_should_be_open($activityname) {
731         if (!$this->running_javascript()) {
732             throw new DriverException('Activities actions menu not available when Javascript is disabled');
733         }
735         // If it is already closed we do nothing.
736         $activitynode = $this->get_activity_node($activityname);
737         $classes = array_flip(explode(' ', $activitynode->getAttribute('class')));
738         if (empty($classes['action-menu-shown'])) {
739             throw new ExpectationException(sprintf("The action menu for '%s' is not open", $activityname), $this->getSession());
740         }
742         return;
743     }
745     /**
746      * Indents to the right the activity or resource specified by it's name. Editing mode should be on.
747      *
748      * @Given /^I indent right "(?P<activity_name_string>(?:[^"]|\\")*)" activity$/
749      * @param string $activityname
750      * @return Given[]
751      */
752     public function i_indent_right_activity($activityname) {
754         $steps = array();
755         $activity = $this->escape($activityname);
756         if ($this->running_javascript()) {
757             $steps[] = new Given('I open "' . $activity . '" actions menu');
758         }
759         $steps[] = new Given('I click on "' . get_string('moveright') . '" "link" in the "' . $activity . '" activity');
761         return $steps;
762     }
764     /**
765      * Indents to the left the activity or resource specified by it's name. Editing mode should be on.
766      *
767      * @Given /^I indent left "(?P<activity_name_string>(?:[^"]|\\")*)" activity$/
768      * @param string $activityname
769      * @return Given[]
770      */
771     public function i_indent_left_activity($activityname) {
773         $steps = array();
774         $activity = $this->escape($activityname);
775         if ($this->running_javascript()) {
776             $steps[] = new Given('I open "' . $activity . '" actions menu');
777         }
778         $steps[] = new Given('I click on "' . get_string('moveleft') . '" "link" in the "' . $activity . '" activity');
780         return $steps;
782     }
784     /**
785      * 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.
786      *
787      * @Given /^I delete "(?P<activity_name_string>(?:[^"]|\\")*)" activity$/
788      * @param string $activityname
789      * @return Given[]
790      */
791     public function i_delete_activity($activityname) {
792         $steps = array();
793         $activity = $this->escape($activityname);
794         if ($this->running_javascript()) {
795             $steps[] = new Given('I open "' . $activity . '" actions menu');
796         }
797         $steps[] = new Given('I click on "' . get_string('delete') . '" "link" in the "' . $activity . '" activity');
799         // JS enabled.
800         // Not using chain steps here because the exceptions catcher have problems detecting
801         // JS modal windows and avoiding interacting them at the same time.
802         if ($this->running_javascript()) {
803             $steps[] = new Given('I click on "' . get_string('yes') . '" "button" in the "Confirm" "dialogue"');
804         } else {
805             $steps[] = new Given('I press "' . get_string('yes') . '"');
806         }
808         return $steps;
809     }
811     /**
812      * Duplicates the activity or resource specified by it's name. You should be in the course page with editing mode on.
813      *
814      * @Given /^I duplicate "(?P<activity_name_string>(?:[^"]|\\")*)" activity$/
815      * @param string $activityname
816      * @return Given[]
817      */
818     public function i_duplicate_activity($activityname) {
819         $steps = array();
820         $activity = $this->escape($activityname);
821         if ($this->running_javascript()) {
822             $steps[] = new Given('I open "' . $activity . '" actions menu');
823         }
824         $steps[] = new Given('I click on "' . get_string('duplicate') . '" "link" in the "' . $activity . '" activity');
825         return $steps;
826     }
828     /**
829      * 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.
830      *
831      * @Given /^I duplicate "(?P<activity_name_string>(?:[^"]|\\")*)" activity editing the new copy with:$/
832      * @param string $activityname
833      * @param TableNode $data
834      * @return Given[]
835      */
836     public function i_duplicate_activity_editing_the_new_copy_with($activityname, TableNode $data) {
838         $steps = array();
840         $activity = $this->escape($activityname);
841         $activityliteral = $this->getSession()->getSelectorsHandler()->xpathLiteral($activityname);
843         $steps[] = new Given('I duplicate "' . $activity . '" activity');
845         // Determine the future new activity xpath from the former one.
846         $duplicatedxpath = "//li[contains(concat(' ', normalize-space(@class), ' '), ' activity ')]" .
847             "[contains(., $activityliteral)]/following-sibling::li";
848         $duplicatedactionsmenuxpath = $duplicatedxpath . "/descendant::a[@role='menuitem']";
850         if ($this->running_javascript()) {
851             // We wait until the AJAX request finishes and the section is visible again.
852             $hiddenlightboxxpath = "//li[contains(concat(' ', normalize-space(@class), ' '), ' activity ')]" .
853                 "[contains(., $activityliteral)]" .
854                 "/ancestor::li[contains(concat(' ', normalize-space(@class), ' '), ' section ')]" .
855                 "/descendant::div[contains(concat(' ', @class, ' '), ' lightbox ')][contains(@style, 'display: none')]";
857             $steps[] = new Given('I wait until the page is ready');
858             $steps[] = new Given('I wait until "' . $this->escape($hiddenlightboxxpath) .'" "xpath_element" exists');
860             // Close the original activity actions menu.
861             $steps[] = new Given('I close "' . $activity . '" actions menu');
863             // The next sibling of the former activity will be the duplicated one, so we click on it from it's xpath as, at
864             // this point, it don't even exists in the DOM (the steps are executed when we return them).
865             $steps[] = new Given('I click on "' . $this->escape($duplicatedactionsmenuxpath) . '" "xpath_element"');
866         }
868         // We force the xpath as otherwise mink tries to interact with the former one.
869         $steps[] = new Given('I click on "' . get_string('editsettings') . '" "link" in the "' .
870             $this->escape($duplicatedxpath) . '" "xpath_element"');
872         $steps[] = new Given('I set the following fields to these values:', $data);
873         $steps[] = new Given('I press "' . get_string('savechangesandreturntocourse') . '"');
874         return $steps;
875     }
877     /**
878      * 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.
879      *
880      * Using the protected method as this method will be usually
881      * called by other methods which are not returning a set of
882      * steps and performs the actions directly, so it would not
883      * be executed if it returns another step.
884      *
885      * Hopefully we would not require test writers to use this step
886      * and we will manage it from other step definitions.
887      *
888      * @Given /^I wait until section "(?P<section_number>\d+)" is available$/
889      * @param int $sectionnumber
890      * @return void
891      */
892     public function i_wait_until_section_is_available($sectionnumber) {
894         // Looks for a hidden lightbox or a non-existent lightbox in that section.
895         $sectionxpath = $this->section_exists($sectionnumber);
896         $hiddenlightboxxpath = $sectionxpath . "/descendant::div[contains(concat(' ', @class, ' '), ' lightbox ')][contains(@style, 'display: none')]" .
897             " | " .
898             $sectionxpath . "[count(child::div[contains(@class, 'lightbox')]) = 0]";
900         $this->ensure_element_exists($hiddenlightboxxpath, 'xpath_element');
901     }
903     /**
904      * Clicks on the specified element of the activity. You should be in the course page with editing mode turned on.
905      *
906      * @Given /^I click on "(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>(?:[^"]|\\")*)" in the "(?P<activity_name_string>(?:[^"]|\\")*)" activity$/
907      * @param string $element
908      * @param string $selectortype
909      * @param string $activityname
910      */
911     public function i_click_on_in_the_activity($element, $selectortype, $activityname) {
912         $element = $this->get_activity_element($element, $selectortype, $activityname);
913         $element->click();
914     }
916     /**
917      * Clicks on the specified element inside the activity container.
918      *
919      * @throws ElementNotFoundException
920      * @param string $element
921      * @param string $selectortype
922      * @param string $activityname
923      * @return NodeElement
924      */
925     protected function get_activity_element($element, $selectortype, $activityname) {
926         $activitynode = $this->get_activity_node($activityname);
928         // Transforming to Behat selector/locator.
929         list($selector, $locator) = $this->transform_selector($selectortype, $element);
930         $exception = new ElementNotFoundException($this->getSession(), '"' . $element . '" "' . $selectortype . '" in "' . $activityname . '" ');
932         return $this->find($selector, $locator, $exception, $activitynode);
933     }
935     /**
936      * Checks if the course section exists.
937      *
938      * @throws ElementNotFoundException Thrown by behat_base::find
939      * @param int $sectionnumber
940      * @return string The xpath of the section.
941      */
942     protected function section_exists($sectionnumber) {
944         // Just to give more info in case it does not exist.
945         $xpath = "//li[@id='section-" . $sectionnumber . "']";
946         $exception = new ElementNotFoundException($this->getSession(), "Section $sectionnumber ");
947         $this->find('xpath', $xpath, $exception);
949         return $xpath;
950     }
952     /**
953      * Returns the show section icon or throws an exception.
954      *
955      * @throws ElementNotFoundException Thrown by behat_base::find
956      * @param int $sectionnumber
957      * @return NodeElement
958      */
959     protected function show_section_icon_exists($sectionnumber) {
961         // Gets the section xpath and ensure it exists.
962         $xpath = $this->section_exists($sectionnumber);
964         // We need to know the course format as the text strings depends on them.
965         $courseformat = $this->get_course_format();
967         // If javascript is on, link is inside a menu.
968         if ($this->running_javascript()) {
969             $this->i_open_section_edit_menu($sectionnumber);
970         }
972         // Checking the show button alt text and show icon.
973         $showtext = $this->getSession()->getSelectorsHandler()->xpathLiteral(get_string('showfromothers', $courseformat));
974         $linkxpath = $xpath . "/descendant::a[@title=$showtext]";
975         $imgxpath = $linkxpath . "/descendant::img[contains(@src, 'show')]";
977         $exception = new ElementNotFoundException($this->getSession(), 'Show section icon ');
978         $this->find('xpath', $imgxpath, $exception);
980         // Returing the link so both Non-JS and JS browsers can interact with it.
981         return $this->find('xpath', $linkxpath, $exception);
982     }
984     /**
985      * Returns the hide section icon link if it exists or throws exception.
986      *
987      * @throws ElementNotFoundException Thrown by behat_base::find
988      * @param int $sectionnumber
989      * @return NodeElement
990      */
991     protected function hide_section_icon_exists($sectionnumber) {
993         // Gets the section xpath and ensure it exists.
994         $xpath = $this->section_exists($sectionnumber);
996         // We need to know the course format as the text strings depends on them.
997         $courseformat = $this->get_course_format();
999         // If javascript is on, link is inside a menu.
1000         if ($this->running_javascript()) {
1001             $this->i_open_section_edit_menu($sectionnumber);
1002         }
1004         // Checking the hide button alt text and hide icon.
1005         $hidetext = $this->getSession()->getSelectorsHandler()->xpathLiteral(get_string('hidefromothers', $courseformat));
1006         $linkxpath = $xpath . "/descendant::a[@title=$hidetext]";
1007         $imgxpath = $linkxpath . "/descendant::img[contains(@src, 'hide')]";
1009         $exception = new ElementNotFoundException($this->getSession(), 'Hide section icon ');
1010         $this->find('xpath', $imgxpath, $exception);
1012         // Returing the link so both Non-JS and JS browsers can interact with it.
1013         return $this->find('xpath', $linkxpath, $exception);
1014     }
1016     /**
1017      * Gets the current course format.
1018      *
1019      * @throws ExpectationException If we are not in the course view page.
1020      * @return string The course format in a frankenstyled name.
1021      */
1022     protected function get_course_format() {
1024         $exception = new ExpectationException('You are not in a course page', $this->getSession());
1026         // The moodle body's id attribute contains the course format.
1027         $node = $this->getSession()->getPage()->find('css', 'body');
1028         if (!$node) {
1029             throw $exception;
1030         }
1032         if (!$bodyid = $node->getAttribute('id')) {
1033             throw $exception;
1034         }
1036         if (strstr($bodyid, 'page-course-view-') === false) {
1037             throw $exception;
1038         }
1040         return 'format_' . str_replace('page-course-view-', '', $bodyid);
1041     }
1043     /**
1044      * Gets the section's activites DOM nodes.
1045      *
1046      * @param string $sectionxpath
1047      * @return array NodeElement instances
1048      */
1049     protected function get_section_activities($sectionxpath) {
1051         $xpath = $sectionxpath . "/descendant::li[contains(concat(' ', normalize-space(@class), ' '), ' activity ')]";
1053         // We spin here, as activities usually require a lot of time to load.
1054         try {
1055             $activities = $this->find_all('xpath', $xpath);
1056         } catch (ElementNotFoundException $e) {
1057             return false;
1058         }
1060         return $activities;
1061     }
1063     /**
1064      * Returns the DOM node of the activity from <li>.
1065      *
1066      * @throws ElementNotFoundException Thrown by behat_base::find
1067      * @param string $activityname The activity name
1068      * @return NodeElement
1069      */
1070     protected function get_activity_node($activityname) {
1072         $activityname = $this->getSession()->getSelectorsHandler()->xpathLiteral($activityname);
1073         $xpath = "//li[contains(concat(' ', normalize-space(@class), ' '), ' activity ')][contains(., $activityname)]";
1075         return $this->find('xpath', $xpath);
1076     }
1078     /**
1079      * Gets the activity instance name from the activity node.
1080      *
1081      * @throws ElementNotFoundException
1082      * @param NodeElement $activitynode
1083      * @return string
1084      */
1085     protected function get_activity_name($activitynode) {
1086         $instancenamenode = $this->find('xpath', "//span[contains(concat(' ', normalize-space(@class), ' '), ' instancename ')]", false, $activitynode);
1087         return $instancenamenode->getText();
1088     }
1090     /**
1091      * Returns whether the user can edit the course contents or not.
1092      *
1093      * @return bool
1094      */
1095     protected function is_course_editor() {
1097         // We don't need to behat_base::spin() here as all is already loaded.
1098         if (!$this->getSession()->getPage()->findButton(get_string('turneditingoff')) &&
1099                 !$this->getSession()->getPage()->findButton(get_string('turneditingon'))) {
1100             return false;
1101         }
1103         return true;
1104     }
1106     /**
1107      * Returns the id of the category with the given idnumber.
1108      *
1109      * Please note that this function requires the category to exist. If it does not exist an ExpectationException is thrown.
1110      *
1111      * @param string $idnumber
1112      * @return string
1113      * @throws ExpectationException
1114      */
1115     protected function get_category_id($idnumber) {
1116         global $DB;
1117         try {
1118             return $DB->get_field('course_categories', 'id', array('idnumber' => $idnumber), MUST_EXIST);
1119         } catch (dml_missing_record_exception $ex) {
1120             throw new ExpectationException(sprintf("There is no category in the database with the idnumber '%s'", $idnumber));
1121         }
1122     }
1124     /**
1125      * Returns the id of the course with the given idnumber.
1126      *
1127      * Please note that this function requires the category to exist. If it does not exist an ExpectationException is thrown.
1128      *
1129      * @param string $idnumber
1130      * @return string
1131      * @throws ExpectationException
1132      */
1133     protected function get_course_id($idnumber) {
1134         global $DB;
1135         try {
1136             return $DB->get_field('course', 'id', array('idnumber' => $idnumber), MUST_EXIST);
1137         } catch (dml_missing_record_exception $ex) {
1138             throw new ExpectationException(sprintf("There is no course in the database with the idnumber '%s'", $idnumber));
1139         }
1140     }
1142     /**
1143      * Returns the category node from within the listing on the management page.
1144      *
1145      * @param string $idnumber
1146      * @return \Behat\Mink\Element\NodeElement
1147      */
1148     protected function get_management_category_listing_node_by_idnumber($idnumber) {
1149         $id = $this->get_category_id($idnumber);
1150         $selector = sprintf('#category-listing .listitem-category[data-id="%d"] > div', $id);
1151         return $this->find('css', $selector);
1152     }
1154     /**
1155      * Returns a category node from within the management interface.
1156      *
1157      * @param string $name The name of the category.
1158      * @param bool $link If set to true we'll resolve to the link rather than just the node.
1159      * @return \Behat\Mink\Element\NodeElement
1160      */
1161     protected function get_management_category_listing_node_by_name($name, $link = false) {
1162         $selector = "//div[@id='category-listing']//li[contains(concat(' ', normalize-space(@class), ' '), ' listitem-category ')]//a[text()='{$name}']";
1163         if ($link === false) {
1164             $selector .= "/ancestor::li[@data-id][1]";
1165         }
1166         return $this->find('xpath', $selector);
1167     }
1169     /**
1170      * Returns a course node from within the management interface.
1171      *
1172      * @param string $name The name of the course.
1173      * @param bool $link If set to true we'll resolve to the link rather than just the node.
1174      * @return \Behat\Mink\Element\NodeElement
1175      */
1176     protected function get_management_course_listing_node_by_name($name, $link = false) {
1177         $selector = "//div[@id='course-listing']//li[contains(concat(' ', @class, ' '), ' listitem-course ')]//a[text()='{$name}']";
1178         if ($link === false) {
1179             $selector .= "/ancestor::li[@data-id]";
1180         }
1181         return $this->find('xpath', $selector);
1182     }
1184     /**
1185      * Returns the course node from within the listing on the management page.
1186      *
1187      * @param string $idnumber
1188      * @return \Behat\Mink\Element\NodeElement
1189      */
1190     protected function get_management_course_listing_node_by_idnumber($idnumber) {
1191         $id = $this->get_course_id($idnumber);
1192         $selector = sprintf('#course-listing .listitem-course[data-id="%d"] > div', $id);
1193         return $this->find('css', $selector);
1194     }
1196     /**
1197      * Clicks on a category in the management interface.
1198      *
1199      * @Given /^I click on category "(?P<name_string>(?:[^"]|\\")*)" in the management interface$/
1200      * @param string $name
1201      */
1202     public function i_click_on_category_in_the_management_interface($name) {
1203         $node = $this->get_management_category_listing_node_by_name($name, true);
1204         $node->click();
1205     }
1207     /**
1208      * Clicks on a course in the management interface.
1209      *
1210      * @Given /^I click on course "(?P<name_string>(?:[^"]|\\")*)" in the management interface$/
1211      * @param string $name
1212      */
1213     public function i_click_on_course_in_the_management_interface($name) {
1214         $node = $this->get_management_course_listing_node_by_name($name, true);
1215         $node->click();
1216     }
1218     /**
1219      * Clicks on a category checkbox in the management interface, if not checked.
1220      *
1221      * @Given /^I select category "(?P<name_string>(?:[^"]|\\")*)" in the management interface$/
1222      * @param string $name
1223      */
1224     public function i_select_category_in_the_management_interface($name) {
1225         $node = $this->get_management_category_listing_node_by_name($name);
1226         $node = $node->findField('bcat[]');
1227         if (!$node->isChecked()) {
1228             $node->click();
1229         }
1230     }
1232     /**
1233      * Clicks on a category checkbox in the management interface, if checked.
1234      *
1235      * @Given /^I unselect category "(?P<name_string>(?:[^"]|\\")*)" in the management interface$/
1236      * @param string $name
1237      */
1238     public function i_unselect_category_in_the_management_interface($name) {
1239         $node = $this->get_management_category_listing_node_by_name($name);
1240         $node = $node->findField('bcat[]');
1241         if ($node->isChecked()) {
1242             $node->click();
1243         }
1244     }
1246     /**
1247      * Clicks course checkbox in the management interface, if not checked.
1248      *
1249      * @Given /^I select course "(?P<name_string>(?:[^"]|\\")*)" in the management interface$/
1250      * @param string $name
1251      */
1252     public function i_select_course_in_the_management_interface($name) {
1253         $node = $this->get_management_course_listing_node_by_name($name);
1254         $node = $node->findField('bc[]');
1255         if (!$node->isChecked()) {
1256             $node->click();
1257         }
1258     }
1260     /**
1261      * Clicks course checkbox in the management interface, if checked.
1262      *
1263      * @Given /^I unselect course "(?P<name_string>(?:[^"]|\\")*)" in the management interface$/
1264      * @param string $name
1265      */
1266     public function i_unselect_course_in_the_management_interface($name) {
1267         $node = $this->get_management_course_listing_node_by_name($name);
1268         $node = $node->findField('bc[]');
1269         if ($node->isChecked()) {
1270             $node->click();
1271         }
1272     }
1274     /**
1275      * Move selected categories to top level in the management interface.
1276      *
1277      * @Given /^I move category "(?P<name_string>(?:[^"]|\\")*)" to top level in the management interface$/
1278      * @param string $name
1279      * @return Given[]
1280      */
1281     public function i_move_category_to_top_level_in_the_management_interface($name) {
1282         $this->i_select_category_in_the_management_interface($name);
1283         return array(
1284             new Given('I set the field "menumovecategoriesto" to "' .  coursecat::get(0)->get_formatted_name() . '"'),
1285             new Given('I press "bulkmovecategories"'),
1286         );
1287     }
1289     /**
1290      * Checks that a category is a subcategory of specific category.
1291      *
1292      * @Given /^I should see category "(?P<subcatidnumber_string>(?:[^"]|\\")*)" as subcategory of "(?P<catidnumber_string>(?:[^"]|\\")*)" in the management interface$/
1293      * @throws ExpectationException
1294      * @param string $subcatidnumber
1295      * @param string $catidnumber
1296      */
1297     public function i_should_see_category_as_subcategory_of_in_the_management_interface($subcatidnumber, $catidnumber) {
1298         $categorynodeid = $this->get_category_id($catidnumber);
1299         $subcategoryid = $this->get_category_id($subcatidnumber);
1300         $exception = new ExpectationException('The category '.$subcatidnumber.' is not a subcategory of '.$catidnumber, $this->getSession());
1301         $selector = sprintf('#category-listing .listitem-category[data-id="%d"] .listitem-category[data-id="%d"]', $categorynodeid, $subcategoryid);
1302         $this->find('css', $selector, $exception);
1303     }
1305     /**
1306      * Checks that a category is not a subcategory of specific category.
1307      *
1308      * @Given /^I should not see category "(?P<subcatidnumber_string>(?:[^"]|\\")*)" as subcategory of "(?P<catidnumber_string>(?:[^"]|\\")*)" in the management interface$/
1309      * @throws ExpectationException
1310      * @param string $subcatidnumber
1311      * @param string $catidnumber
1312      */
1313     public function i_should_not_see_category_as_subcategory_of_in_the_management_interface($subcatidnumber, $catidnumber) {
1314         try {
1315             $this->i_should_see_category_as_subcategory_of_in_the_management_interface($subcatidnumber, $catidnumber);
1316         } catch (ExpectationException $e) {
1317             // ExpectedException means that it is not highlighted.
1318             return;
1319         }
1320         throw new ExpectationException('The category '.$subcatidnumber.' is a subcategory of '.$catidnumber, $this->getSession());
1321     }
1323     /**
1324      * Click to expand a category revealing its sub categories within the management UI.
1325      *
1326      * @Given /^I click to expand category "(?P<idnumber_string>(?:[^"]|\\")*)" in the management interface$/
1327      * @param string $idnumber
1328      */
1329     public function i_click_to_expand_category_in_the_management_interface($idnumber) {
1330         $categorynode = $this->get_management_category_listing_node_by_idnumber($idnumber);
1331         $exception = new ExpectationException('Category "' . $idnumber . '" does not contain an expand or collapse toggle.', $this->getSession());
1332         $togglenode = $this->find('css', 'a[data-action=collapse],a[data-action=expand]', $exception, $categorynode);
1333         $togglenode->click();
1334     }
1336     /**
1337      * Checks that a category within the management interface is visible.
1338      *
1339      * @Given /^category in management listing should be visible "(?P<idnumber_string>(?:[^"]|\\")*)"$/
1340      * @param string $idnumber
1341      */
1342     public function category_in_management_listing_should_be_visible($idnumber) {
1343         $id = $this->get_category_id($idnumber);
1344         $exception = new ExpectationException('The category '.$idnumber.' is not visible.', $this->getSession());
1345         $selector = sprintf('#category-listing .listitem-category[data-id="%d"][data-visible="1"]', $id);
1346         $this->find('css', $selector, $exception);
1347     }
1349     /**
1350      * Checks that a category within the management interface is dimmed.
1351      *
1352      * @Given /^category in management listing should be dimmed "(?P<idnumber_string>(?:[^"]|\\")*)"$/
1353      * @param string $idnumber
1354      */
1355     public function category_in_management_listing_should_be_dimmed($idnumber) {
1356         $id = $this->get_category_id($idnumber);
1357         $selector = sprintf('#category-listing .listitem-category[data-id="%d"][data-visible="0"]', $id);
1358         $exception = new ExpectationException('The category '.$idnumber.' is visible.', $this->getSession());
1359         $this->find('css', $selector, $exception);
1360     }
1362     /**
1363      * Checks that a course within the management interface is visible.
1364      *
1365      * @Given /^course in management listing should be visible "(?P<idnumber_string>(?:[^"]|\\")*)"$/
1366      * @param string $idnumber
1367      */
1368     public function course_in_management_listing_should_be_visible($idnumber) {
1369         $id = $this->get_course_id($idnumber);
1370         $exception = new ExpectationException('The course '.$idnumber.' is not visible.', $this->getSession());
1371         $selector = sprintf('#course-listing .listitem-course[data-id="%d"][data-visible="1"]', $id);
1372         $this->find('css', $selector, $exception);
1373     }
1375     /**
1376      * Checks that a course within the management interface is dimmed.
1377      *
1378      * @Given /^course in management listing should be dimmed "(?P<idnumber_string>(?:[^"]|\\")*)"$/
1379      * @param string $idnumber
1380      */
1381     public function course_in_management_listing_should_be_dimmed($idnumber) {
1382         $id = $this->get_course_id($idnumber);
1383         $exception = new ExpectationException('The course '.$idnumber.' is visible.', $this->getSession());
1384         $selector = sprintf('#course-listing .listitem-course[data-id="%d"][data-visible="0"]', $id);
1385         $this->find('css', $selector, $exception);
1386     }
1388     /**
1389      * Toggles the visibility of a course in the management UI.
1390      *
1391      * If it was visible it will be hidden. If it is hidden it will be made visible.
1392      *
1393      * @Given /^I toggle visibility of course "(?P<idnumber_string>(?:[^"]|\\")*)" in management listing$/
1394      * @param string $idnumber
1395      */
1396     public function i_toggle_visibility_of_course_in_management_listing($idnumber) {
1397         $id = $this->get_course_id($idnumber);
1398         $selector = sprintf('#course-listing .listitem-course[data-id="%d"][data-visible]', $id);
1399         $node = $this->find('css', $selector);
1400         $exception = new ExpectationException('Course listing "' . $idnumber . '" does not contain a show or hide toggle.', $this->getSession());
1401         if ($node->getAttribute('data-visible') === '1') {
1402             $toggle = $this->find('css', '.action-hide', $exception, $node);
1403         } else {
1404             $toggle = $this->find('css', '.action-show', $exception, $node);
1405         }
1406         $toggle->click();
1407     }
1409     /**
1410      * Toggles the visibility of a category in the management UI.
1411      *
1412      * If it was visible it will be hidden. If it is hidden it will be made visible.
1413      *
1414      * @Given /^I toggle visibility of category "(?P<idnumber_string>(?:[^"]|\\")*)" in management listing$/
1415      */
1416     public function i_toggle_visibility_of_category_in_management_listing($idnumber) {
1417         $id = $this->get_category_id($idnumber);
1418         $selector = sprintf('#category-listing .listitem-category[data-id="%d"][data-visible]', $id);
1419         $node = $this->find('css', $selector);
1420         $exception = new ExpectationException('Category listing "' . $idnumber . '" does not contain a show or hide toggle.', $this->getSession());
1421         if ($node->getAttribute('data-visible') === '1') {
1422             $toggle = $this->find('css', '.action-hide', $exception, $node);
1423         } else {
1424             $toggle = $this->find('css', '.action-show', $exception, $node);
1425         }
1426         $toggle->click();
1427     }
1429     /**
1430      * Moves a category displayed in the management interface up or down one place.
1431      *
1432      * @Given /^I click to move category "(?P<idnumber_string>(?:[^"]|\\")*)" (?P<direction>up|down) one$/
1433      *
1434      * @param string $idnumber The category idnumber
1435      * @param string $direction The direction to move in, either up or down
1436      */
1437     public function i_click_to_move_category_by_one($idnumber, $direction) {
1438         $node = $this->get_management_category_listing_node_by_idnumber($idnumber);
1439         $this->user_moves_listing_by_one('category', $node, $direction);
1440     }
1442     /**
1443      * Moves a course displayed in the management interface up or down one place.
1444      *
1445      * @Given /^I click to move course "(?P<idnumber_string>(?:[^"]|\\")*)" (?P<direction>up|down) one$/
1446      *
1447      * @param string $idnumber The course idnumber
1448      * @param string $direction The direction to move in, either up or down
1449      */
1450     public function i_click_to_move_course_by_one($idnumber, $direction) {
1451         $node = $this->get_management_course_listing_node_by_idnumber($idnumber);
1452         $this->user_moves_listing_by_one('course', $node, $direction);
1453     }
1455     /**
1456      * Moves a course or category listing within the management interface up or down by one.
1457      *
1458      * @param string $listingtype One of course or category
1459      * @param \Behat\Mink\Element\NodeElement $listingnode
1460      * @param string $direction One of up or down.
1461      * @param bool $highlight If set to false we don't check the node has been highlighted.
1462      */
1463     protected function user_moves_listing_by_one($listingtype, $listingnode, $direction, $highlight = true) {
1464         $up = (strtolower($direction) === 'up');
1465         if ($up) {
1466             $exception = new ExpectationException($listingtype.' listing does not contain a moveup button.', $this->getSession());
1467             $button = $this->find('css', 'a.action-moveup', $exception, $listingnode);
1468         } else {
1469             $exception = new ExpectationException($listingtype.' listing does not contain a movedown button.', $this->getSession());
1470             $button = $this->find('css', 'a.action-movedown', $exception, $listingnode);
1471         }
1472         $button->click();
1473         if ($this->running_javascript() && $highlight) {
1474             $listitem = $listingnode->getParent();
1475             $exception = new ExpectationException('Nothing was highlighted, ajax didn\'t occur or didn\'t succeed.', $this->getSession());
1476             $this->spin(array($this, 'listing_is_highlighted'), $listitem->getTagName().'#'.$listitem->getAttribute('id'), 2, $exception, true);
1477         }
1478     }
1480     /**
1481      * Used by spin to determine the callback has been highlighted.
1482      *
1483      * @param behat_course $self A self reference (default first arg from a spin callback)
1484      * @param \Behat\Mink\Element\NodeElement $selector
1485      * @return bool
1486      */
1487     protected function listing_is_highlighted($self, $selector) {
1488         $listitem = $this->find('css', $selector);
1489         return $listitem->hasClass('highlight');
1490     }
1492     /**
1493      * Check that one course appears before another in the course category management listings.
1494      *
1495      * @Given /^I should see course listing "(?P<preceedingcourse_string>(?:[^"]|\\")*)" before "(?P<followingcourse_string>(?:[^"]|\\")*)"$/
1496      *
1497      * @param string $preceedingcourse The first course to find
1498      * @param string $followingcourse The second course to find (should be AFTER the first course)
1499      * @throws ExpectationException
1500      */
1501     public function i_should_see_course_listing_before($preceedingcourse, $followingcourse) {
1502         $xpath = "//div[@id='course-listing']//li[contains(concat(' ', @class, ' '), ' listitem-course ')]//a[text()='{$preceedingcourse}']/ancestor::li[@data-id]//following::a[text()='{$followingcourse}']";
1503         $msg = "{$preceedingcourse} course does not appear before {$followingcourse} course";
1504         if (!$this->getSession()->getDriver()->find($xpath)) {
1505             throw new ExpectationException($msg, $this->getSession());
1506         }
1507     }
1509     /**
1510      * Check that one category appears before another in the course category management listings.
1511      *
1512      * @Given /^I should see category listing "(?P<preceedingcategory_string>(?:[^"]|\\")*)" before "(?P<followingcategory_string>(?:[^"]|\\")*)"$/
1513      *
1514      * @param string $preceedingcategory The first category to find
1515      * @param string $followingcategory The second category to find (should be after the first category)
1516      * @throws ExpectationException
1517      */
1518     public function i_should_see_category_listing_before($preceedingcategory, $followingcategory) {
1519         $xpath = "//div[@id='category-listing']//li[contains(concat(' ', @class, ' '), ' listitem-category ')]//a[text()='{$preceedingcategory}']/ancestor::li[@data-id]//following::a[text()='{$followingcategory}']";
1520         $msg = "{$preceedingcategory} category does not appear before {$followingcategory} category";
1521         if (!$this->getSession()->getDriver()->find($xpath)) {
1522             throw new ExpectationException($msg, $this->getSession());
1523         }
1524     }
1526     /**
1527      * Checks that we are on the course management page that we expect to be on and that no course has been selected.
1528      *
1529      * @Given /^I should see the "(?P<mode_string>(?:[^"]|\\")*)" management page$/
1530      * @param string $mode The mode to expected. One of 'Courses', 'Course categories' or 'Course categories and courses'
1531      * @return Given[]
1532      */
1533     public function i_should_see_the_courses_management_page($mode) {
1534         $return = array(
1535             new Given('I should see "Course and category management" in the "h2" "css_element"')
1536         );
1537         switch ($mode) {
1538             case "Courses":
1539                 $return[] = new Given('"#category-listing" "css_element" should not exist');
1540                 $return[] = new Given('"#course-listing" "css_element" should exist');
1541                 break;
1542             case "Course categories":
1543                 $return[] = new Given('"#category-listing" "css_element" should exist');
1544                 $return[] = new Given('"#course-listing" "css_element" should exist');
1545                 break;
1546             case "Courses categories and courses":
1547             default:
1548                 $return[] = new Given('"#category-listing" "css_element" should exist');
1549                 $return[] = new Given('"#course-listing" "css_element" should exist');
1550                 break;
1551         }
1552         $return[] = new Given('"#course-detail" "css_element" should not exist');
1553         return $return;
1554     }
1556     /**
1557      * Checks that we are on the course management page that we expect to be on and that a course has been selected.
1558      *
1559      * @Given /^I should see the "(?P<mode_string>(?:[^"]|\\")*)" management page with a course selected$/
1560      * @param string $mode The mode to expected. One of 'Courses', 'Course categories' or 'Course categories and courses'
1561      * @return Given[]
1562      */
1563     public function i_should_see_the_courses_management_page_with_a_course_selected($mode) {
1564         $return = $this->i_should_see_the_courses_management_page($mode);
1565         array_pop($return);
1566         $return[] = new Given('"#course-detail" "css_element" should exist');
1567         return $return;
1568     }
1570     /**
1571      * Locates a course in the course category management interface and then triggers an action for it.
1572      *
1573      * @Given /^I click on "(?P<action_string>(?:[^"]|\\")*)" action for "(?P<name_string>(?:[^"]|\\")*)" in management course listing$/
1574      *
1575      * @param string $action The action to take. One of
1576      * @param string $name The name of the course as it is displayed in the management interface.
1577      */
1578     public function i_click_on_action_for_item_in_management_course_listing($action, $name) {
1579         $node = $this->get_management_course_listing_node_by_name($name);
1580         $this->user_clicks_on_management_listing_action('course', $node, $action);
1581     }
1583     /**
1584      * Locates a category in the course category management interface and then triggers an action for it.
1585      *
1586      * @Given /^I click on "(?P<action_string>(?:[^"]|\\")*)" action for "(?P<name_string>(?:[^"]|\\")*)" in management category listing$/
1587      *
1588      * @param string $action The action to take. One of
1589      * @param string $name The name of the category as it is displayed in the management interface.
1590      */
1591     public function i_click_on_action_for_item_in_management_category_listing($action, $name) {
1592         $node = $this->get_management_category_listing_node_by_name($name);
1593         $this->user_clicks_on_management_listing_action('category', $node, $action);
1594     }
1596     /**
1597      * Clicks to expand or collapse a category displayed on the frontpage
1598      *
1599      * @Given /^I toggle "(?P<categoryname_string>(?:[^"]|\\")*)" category children visibility in frontpage$/
1600      * @throws ExpectationException
1601      * @param string $categoryname
1602      */
1603     public function i_toggle_category_children_visibility_in_frontpage($categoryname) {
1605         $headingtags = array();
1606         for ($i = 1; $i <= 6; $i++) {
1607             $headingtags[] = 'self::h' . $i;
1608         }
1610         $exception = new ExpectationException('"' . $categoryname . '" category can not be found', $this->getSession());
1611         $categoryliteral = $this->getSession()->getSelectorsHandler()->xpathLiteral($categoryname);
1612         $xpath = "//div[@class='info']/descendant::*[" . implode(' or ', $headingtags) . "][@class='categoryname'][./descendant::a[.=$categoryliteral]]";
1613         $node = $this->find('xpath', $xpath, $exception);
1614         $node->click();
1616         // Smooth expansion.
1617         $this->getSession()->wait(1000, false);
1618     }
1620     /**
1621      * Finds the node to use for a management listitem action and clicks it.
1622      *
1623      * @param string $listingtype Either course or category.
1624      * @param \Behat\Mink\Element\NodeElement $listingnode
1625      * @param string $action The action being taken
1626      * @throws Behat\Mink\Exception\ExpectationException
1627      */
1628     protected function user_clicks_on_management_listing_action($listingtype, $listingnode, $action) {
1629         $actionsnode = $listingnode->find('xpath', "//*[contains(concat(' ', normalize-space(@class), ' '), '{$listingtype}-item-actions')]");
1630         if (!$actionsnode) {
1631             throw new ExpectationException("Could not find the actions for $listingtype", $this->getSession());
1632         }
1633         $actionnode = $actionsnode->find('css', '.action-'.$action);
1634         if (!$actionnode) {
1635             throw new ExpectationException("Expected action was not available or not found ($action)", $this->getSession());
1636         }
1637         if ($this->running_javascript() && !$actionnode->isVisible()) {
1638             $actionsnode->find('css', 'a.toggle-display')->click();
1639             $actionnode = $actionsnode->find('css', '.action-'.$action);
1640         }
1641         $actionnode->click();
1642     }
1644     /**
1645      * Clicks on a category in the management interface.
1646      *
1647      * @Given /^I click on "(?P<categoryname_string>(?:[^"]|\\")*)" category in the management category listing$/
1648      * @param string $name The name of the category to click.
1649      */
1650     public function i_click_on_category_in_the_management_category_listing($name) {
1651         $node = $this->get_management_category_listing_node_by_name($name);
1652         $node->find('css', 'a.categoryname')->click();
1653     }