MDL-58428 theme: Shift templates ready for Bootstrapbase removal
[moodle.git] / grade / tests / behat / behat_grade.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 grade related steps definitions.
19  *
20  * @package    core_grades
21  * @category   test
22  * @copyright  2014 Mark Nelson <markn@moodle.com>
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;
32 class behat_grade extends behat_base {
34     /**
35      * Enters a grade via the gradebook for a specific grade item and user when viewing the 'Grader report' with editing mode turned on.
36      *
37      * @Given /^I give the grade "(?P<grade_number>(?:[^"]|\\")*)" to the user "(?P<username_string>(?:[^"]|\\")*)" for the grade item "(?P<grade_activity_string>(?:[^"]|\\")*)"$/
38      * @param int $grade
39      * @param string $userfullname the user's fullname as returned by fullname()
40      * @param string $itemname
41      */
42     public function i_give_the_grade($grade, $userfullname, $itemname) {
43         $gradelabel = $userfullname . ' ' . $itemname;
44         $fieldstr = get_string('useractivitygrade', 'gradereport_grader', $gradelabel);
46         $this->execute('behat_forms::i_set_the_field_to', array($this->escape($fieldstr), $grade));
47     }
49     /**
50      * Enters a quick feedback via the gradebook for a specific grade item and user when viewing
51      * the 'Grader report' with editing mode turned on.
52      *
53      * @Given /^I give the feedback "(?P<grade_number>(?:[^"]|\\")*)" to the user "(?P<username_string>(?:[^"]|\\")*)" for the grade item "(?P<grade_activity_string>(?:[^"]|\\")*)"$/
54      * @param string $feedback
55      * @param string $userfullname the user's fullname as returned by fullname()
56      * @param string $itemname
57      */
58     public function i_give_the_feedback($feedback, $userfullname, $itemname) {
59         $gradelabel = $userfullname . ' ' . $itemname;
60         $fieldstr = get_string('useractivityfeedback', 'gradereport_grader', $gradelabel);
62         $this->execute('behat_forms::i_set_the_field_to', array($this->escape($fieldstr), $this->escape($feedback)));
63     }
65     /**
66      * Changes the settings of a grade item or category or the course.
67      *
68      * Teacher must be either on the grade setup page or on the Grader report page with editing mode turned on.
69      *
70      * @Given /^I set the following settings for grade item "(?P<grade_item_string>(?:[^"]|\\")*)":$/
71      * @param string $gradeitem
72      * @param TableNode $data
73      */
74     public function i_set_the_following_settings_for_grade_item($gradeitem, TableNode $data) {
76         $gradeitem = behat_context_helper::escape($gradeitem);
78         if ($this->running_javascript()) {
79             $xpath = "//tr[contains(.,$gradeitem)]//*[contains(@class,'moodle-actionmenu')]";
80             if ($this->getSession()->getPage()->findAll('xpath', $xpath)) {
81                 $this->execute("behat_action_menu::i_open_the_action_menu_in",
82                         array("//tr[contains(.,$gradeitem)]",
83                                 "xpath_element"));
84             }
85         }
87         $savechanges = get_string('savechanges', 'grades');
88         $edit = behat_context_helper::escape(get_string('edit') . '  ');
89         $linkxpath = "//a[./*[contains(concat(' ', normalize-space(@class), ' '), ' icon ') " .
90                 "and starts-with(@title,$edit) and contains(@title,$gradeitem)]]";
92         $this->execute("behat_general::i_click_on", array($this->escape($linkxpath), "xpath_element"));
93         $this->execute("behat_forms::i_set_the_following_fields_to_these_values", $data);
94         $this->execute('behat_forms::press_button', $this->escape($savechanges));
95     }
97     /**
98      * Hids a grade item or category.
99      *
100      * Teacher must be on the grade setup page.
101      *
102      * @Given /^I hide the grade item "(?P<grade_item_string>(?:[^"]|\\")*)"$/
103      * @param string $gradeitem
104      */
105     public function i_hide_the_grade_item($gradeitem) {
107         $gradeitem = behat_context_helper::escape($gradeitem);
109         if ($this->running_javascript()) {
110             $xpath = "//tr[contains(.,$gradeitem)]//*[contains(@class,'moodle-actionmenu')]//a[contains(@class,'toggle-display')]";
111             if ($this->getSession()->getPage()->findAll('xpath', $xpath)) {
112                 $this->execute("behat_general::i_click_on", array($this->escape($xpath), "xpath_element"));
113             }
114         }
116         $this->execute("behat_general::i_click_on_in_the", array(get_string('hide'), 'link',
117             "//tr[descendant::*[text() = " . $this->escape($gradeitem) . "]]", 'xpath_element'));
118     }
120     /**
121      * Sets a calculated manual grade item. Needs a table with item name - idnumber relation.
122      * The step requires you to be in the 'Gradebook setup' page.
123      *
124      * @Given /^I set "(?P<calculation_string>(?:[^"]|\\")*)" calculation for grade item "(?P<grade_item_string>(?:[^"]|\\")*)" with idnumbers:$/
125      * @param string $calculation The calculation.
126      * @param string $gradeitem The grade item name.
127      * @param TableNode $TableNode The grade item name - idnumbers relation.
128      */
129     public function i_set_calculation_for_grade_item_with_idnumbers($calculation, $gradeitem, TableNode $data) {
131         $gradeitem = behat_context_helper::escape($gradeitem);
133         if ($this->running_javascript()) {
134             $xpath = "//tr[contains(.,$gradeitem)]//*[contains(@class,'moodle-actionmenu')]";
135             if ($this->getSession()->getPage()->findAll('xpath', $xpath)) {
136                 $this->execute("behat_action_menu::i_open_the_action_menu_in",
137                         array("//tr[contains(.,$gradeitem)]",
138                                 "xpath_element"));
139             }
140         }
142         // Going to edit calculation.
143         $savechanges = get_string('savechanges', 'grades');
144         $edit = behat_context_helper::escape(get_string('editcalculation', 'grades'));
145         $linkxpath = "//a[./*[contains(concat(' ', normalize-space(@class), ' '), ' icon ') " .
146                 "and starts-with(@title,$edit) and contains(@title,$gradeitem)]]";
147         $this->execute("behat_general::i_click_on", array($this->escape($linkxpath), "xpath_element"));
149         // Mapping names to idnumbers.
150         $datahash = $data->getRowsHash();
151         foreach ($datahash as $gradeitem => $idnumber) {
152             // This xpath looks for course, categories and items with the provided name.
153             // Grrr, we can't equal in categoryitem and courseitem because there is a line jump...
154             $inputxpath = "//input[@class='idnumber'][" .
155                     "parent::li[@class='item'][text()='" . $gradeitem . "']" .
156                     " or " .
157                     "parent::li[@class='categoryitem' or @class='courseitem']" .
158                     "/parent::ul/parent::li[starts-with(text(),'" . $gradeitem . "')]" .
159                     "]";
160             $this->execute('behat_forms::i_set_the_field_with_xpath_to', array($inputxpath, $idnumber));
161         }
163         $this->execute('behat_forms::press_button', get_string('addidnumbers', 'grades'));
164         $this->execute('behat_forms::i_set_the_field_to', array(get_string('calculation', 'grades'), $calculation));
165         $this->execute('behat_forms::press_button', $savechanges);
167     }
169     /**
170      * Sets a calculated manual grade category total. Needs a table with item name - idnumber relation.
171      * The step requires you to be in the 'Gradebook setup' page.
172      *
173      * @Given /^I set "(?P<calculation_string>(?:[^"]|\\")*)" calculation for grade category "(?P<grade_item_string>(?:[^"]|\\")*)" with idnumbers:$/
174      * @param string $calculation The calculation.
175      * @param string $gradeitem The grade item name.
176      * @param TableNode $data The grade item name - idnumbers relation.
177      */
178     public function i_set_calculation_for_grade_category_with_idnumbers($calculation, $gradeitem, TableNode $data) {
180         $gradecategorytotal = behat_context_helper::escape($gradeitem . ' total');
181         $gradeitem = behat_context_helper::escape($gradeitem);
183         if ($this->running_javascript()) {
184             $xpath = "//tr[contains(.,$gradecategorytotal)]//*[contains(@class,'moodle-actionmenu')]";
185             if ($this->getSession()->getPage()->findAll('xpath', $xpath)) {
186                 $xpath = "//tr[contains(.,$gradecategorytotal)]";
187                 $this->execute("behat_action_menu::i_open_the_action_menu_in", array($xpath, "xpath_element"));
188             }
189         }
191         // Going to edit calculation.
192         $savechanges = get_string('savechanges', 'grades');
193         $edit = behat_context_helper::escape(get_string('editcalculation', 'grades'));
194         $linkxpath = "//a[./*[contains(concat(' ', normalize-space(@class), ' '), ' icon ') " .
195                 "and starts-with(@title,$edit) and contains(@title,$gradeitem)]]";
196         $this->execute("behat_general::i_click_on", array($this->escape($linkxpath), "xpath_element"));
198         // Mapping names to idnumbers.
199         $datahash = $data->getRowsHash();
200         foreach ($datahash as $gradeitem => $idnumber) {
201             // This xpath looks for course, categories and items with the provided name.
202             // Grrr, we can't equal in categoryitem and courseitem because there is a line jump...
203             $inputxpath = "//input[@class='idnumber'][" .
204                     "parent::li[@class='item'][text()='" . $gradeitem . "']" .
205                     " | " .
206                     "parent::li[@class='categoryitem' | @class='courseitem']" .
207                     "/parent::ul/parent::li[starts-with(text(),'" . $gradeitem . "')]" .
208                     "]";
209             $this->execute('behat_forms::i_set_the_field_with_xpath_to', array($inputxpath, $idnumber));
210         }
212         $this->execute('behat_forms::press_button', get_string('addidnumbers', 'grades'));
214         $this->execute('behat_forms::i_set_the_field_to', array(get_string('calculation', 'grades'), $calculation));
215         $this->execute('behat_forms::press_button', $savechanges);
216     }
218     /**
219      * Resets the weights for the grade category
220      *
221      * Teacher must be on the grade setup page.
222      *
223      * @Given /^I reset weights for grade category "(?P<grade_item_string>(?:[^"]|\\")*)"$/
224      * @param $gradeitem
225      */
226     public function i_reset_weights_for_grade_category($gradeitem) {
228         $steps = array();
230         if ($this->running_javascript()) {
231             $gradeitemliteral = behat_context_helper::escape($gradeitem);
232             $xpath = "//tr[contains(.,$gradeitemliteral)]//*[contains(@class,'moodle-actionmenu')]";
233             if ($this->getSession()->getPage()->findAll('xpath', $xpath)) {
234                 $xpath = "//tr[contains(.,$gradeitemliteral)]";
235                 $this->execute("behat_action_menu::i_open_the_action_menu_in", array($xpath, "xpath_element"));
236             }
237         }
239         $linktext = get_string('resetweights', 'grades', (object)array('itemname' => $gradeitem));
240         $this->execute("behat_general::i_click_on", array($this->escape($linktext), "link"));
241     }
243     /**
244      * Step allowing to test before-the-fix behaviour of the gradebook
245      *
246      * @Given /^gradebook calculations for the course "(?P<coursename_string>(?:[^"]|\\")*)" are frozen at version "(?P<version_string>(?:[^"]|\\")*)"$/
247      * @param string $coursename
248      * @param string $version
249      */
250     public function gradebook_calculations_for_the_course_are_frozen_at_version($coursename, $version) {
251         global $DB;
252         $courseid = $DB->get_field('course', 'id', array('shortname' => $coursename), MUST_EXIST);
253         set_config('gradebook_calculations_freeze_' . $courseid, $version);
254     }
256     /**
257      * Select the tab in the gradebook. We must be on one of the gradebook pages already.
258      *
259      * @param string $gradepath examples: "View > User report", "Letters > View", "Scales"
260      */
261     protected function select_in_gradebook_tabs($gradepath) {
262         $gradepath = preg_split('/\s*>\s*/', trim($gradepath));
263         if (count($gradepath) > 2) {
264             throw new coding_exception('Grade path is too long (must have no more than two items separated with ">")');
265         }
267         $xpath = '//div[contains(@class,\'grade-navigation\')]';
269         // If the first row of the grade-navigation tabs does not have $gradepath[0] as active tab, click on it.
270         $link = '\'' . $this->escape($gradepath[0]) . '\'';
271         $xpathrow1 = $xpath . '//ul[1]//*[contains(@class,\'active\') and contains(normalize-space(.), ' . $link . ')]';
272         if (!$this->getSession()->getPage()->findAll('xpath', $xpathrow1)) {
273             $this->find('xpath', $xpath . '//ul[1]/li/a[text()=' . $link . ']')->click();
274             $this->wait_for_pending_js();
275         }
277         if (isset($gradepath[1])) {
278             // If the second row of the grade-navigation tabs does not have $gradepath[1] as active tab, click on it.
279             $link = '\'' . $this->escape($gradepath[1]) . '\'';
280             $xpathrow2 = $xpath . '//ul[2]//*[contains(@class,\'active\') and contains(normalize-space(.), ' . $link . ')]';
281             if (!$this->getSession()->getPage()->findAll('xpath', $xpathrow2)) {
282                 $this->find('xpath', $xpath . '//ul[2]/li/a[text()=' . $link . ']')->click();
283                 $this->wait_for_pending_js();
284             }
285         }
286     }
288     /**
289      * Navigates to the course gradebook and selects a specified item from the grade navigation tabs.
290      *
291      * Examples:
292      * - I navigate to "Setup > Gradebook setup" in the course gradebook
293      * - I navigate to "Scales" in the course gradebook
294      * - I navigate to "Letters > View" in the course gradebook
295      * - I navigate to "View > User report" in the course gradebook // for teachers
296      * - I navigate to "User report" in the course gradebook // for students
297      *
298      * @Given /^I navigate to "(?P<gradepath_string>(?:[^"]|\\")*)" in the course gradebook$/
299      * @param string $gradepath
300      */
301     public function i_navigate_to_in_the_course_gradebook($gradepath) {
302         // If we are not on one of the gradebook pages already, follow "Grades" link in the navigation drawer.
303         $xpath = '//div[contains(@class,\'grade-navigation\')]';
304         if (!$this->getSession()->getPage()->findAll('xpath', $xpath)) {
305             $this->execute('behat_navigation::i_select_from_flat_navigation_drawer', get_string('grades'));
306         }
308         $this->select_in_gradebook_tabs($gradepath);
309     }