12e67895bfc0931d359002d1547af9d22957c702
[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')]//a[contains(@class,'toggle-display')]";
80             if ($this->getSession()->getPage()->findAll('xpath', $xpath)) {
81                 $this->execute("behat_general::i_click_on", array($this->escape($xpath), "xpath_element"));
82             }
83         }
85         $savechanges = get_string('savechanges', 'grades');
86         $edit = behat_context_helper::escape(get_string('edit') . '  ');
87         $linkxpath = "//a[./img[starts-with(@title,$edit) and contains(@title,$gradeitem)]]";
89         $this->execute("behat_general::i_click_on", array($this->escape($linkxpath), "xpath_element"));
90         $this->execute("behat_forms::i_set_the_following_fields_to_these_values", $data);
91         $this->execute('behat_forms::press_button', $this->escape($savechanges));
92     }
94     /**
95      * Hids a grade item or category.
96      *
97      * Teacher must be on the grade setup page.
98      *
99      * @Given /^I hide the grade item "(?P<grade_item_string>(?:[^"]|\\")*)"$/
100      * @param string $gradeitem
101      */
102     public function i_hide_the_grade_item($gradeitem) {
104         $gradeitem = behat_context_helper::escape($gradeitem);
106         if ($this->running_javascript()) {
107             $xpath = "//tr[contains(.,$gradeitem)]//*[contains(@class,'moodle-actionmenu')]//a[contains(@class,'toggle-display')]";
108             if ($this->getSession()->getPage()->findAll('xpath', $xpath)) {
109                 $this->execute("behat_general::i_click_on", array($this->escape($xpath), "xpath_element"));
110             }
111         }
113         $this->execute("behat_general::i_click_on_in_the", array(get_string('hide'), 'link',
114             "//tr[descendant::*[text() = " . $this->escape($gradeitem) . "]]", 'xpath_element'));
115     }
117     /**
118      * Sets a calculated manual grade item. Needs a table with item name - idnumber relation.
119      * The step requires you to be in the 'Gradebook setup' page.
120      *
121      * @Given /^I set "(?P<calculation_string>(?:[^"]|\\")*)" calculation for grade item "(?P<grade_item_string>(?:[^"]|\\")*)" with idnumbers:$/
122      * @param string $calculation The calculation.
123      * @param string $gradeitem The grade item name.
124      * @param TableNode $TableNode The grade item name - idnumbers relation.
125      */
126     public function i_set_calculation_for_grade_item_with_idnumbers($calculation, $gradeitem, TableNode $data) {
128         $gradeitem = behat_context_helper::escape($gradeitem);
130         if ($this->running_javascript()) {
131             $xpath = "//tr[contains(.,$gradeitem)]//*[contains(@class,'moodle-actionmenu')]//a[contains(@class,'toggle-display')]";
132             if ($this->getSession()->getPage()->findAll('xpath', $xpath)) {
133                 $this->execute("behat_general::i_click_on", array($this->escape($xpath), "xpath_element"));
134             }
135         }
137         // Going to edit calculation.
138         $savechanges = get_string('savechanges', 'grades');
139         $edit = behat_context_helper::escape(get_string('editcalculation', 'grades'));
140         $linkxpath = "//a[./img[starts-with(@title,$edit) and contains(@title,$gradeitem)]]";
141         $this->execute("behat_general::i_click_on", array($this->escape($linkxpath), "xpath_element"));
143         // Mapping names to idnumbers.
144         $datahash = $data->getRowsHash();
145         foreach ($datahash as $gradeitem => $idnumber) {
146             // This xpath looks for course, categories and items with the provided name.
147             // Grrr, we can't equal in categoryitem and courseitem because there is a line jump...
148             $inputxpath ="//input[@class='idnumber'][" .
149                 "parent::li[@class='item'][text()='" . $gradeitem . "']" .
150                 " or " .
151                 "parent::li[@class='categoryitem' or @class='courseitem']/parent::ul/parent::li[starts-with(text(),'" . $gradeitem . "')]" .
152             "]";
153             $this->execute('behat_forms::i_set_the_field_with_xpath_to', array($inputxpath, $idnumber));
154         }
156         $this->execute('behat_forms::press_button', get_string('addidnumbers', 'grades'));
157         $this->execute('behat_forms::i_set_the_field_to', array(get_string('calculation', 'grades'), $calculation));
158         $this->execute('behat_forms::press_button', $savechanges);
160     }
162     /**
163      * Sets a calculated manual grade category total. Needs a table with item name - idnumber relation.
164      * The step requires you to be in the 'Gradebook setup' page.
165      *
166      * @Given /^I set "(?P<calculation_string>(?:[^"]|\\")*)" calculation for grade category "(?P<grade_item_string>(?:[^"]|\\")*)" with idnumbers:$/
167      * @param string $calculation The calculation.
168      * @param string $gradeitem The grade item name.
169      * @param TableNode $data The grade item name - idnumbers relation.
170      */
171     public function i_set_calculation_for_grade_category_with_idnumbers($calculation, $gradeitem, TableNode $data) {
173         $gradecategorytotal = behat_context_helper::escape($gradeitem . ' total');
174         $gradeitem = behat_context_helper::escape($gradeitem);
176         if ($this->running_javascript()) {
177             $xpath = "//tr[contains(.,$gradecategorytotal)]//*[contains(@class,'moodle-actionmenu')]" .
178                 "//a[contains(@class,'toggle-display')]";
179             if ($this->getSession()->getPage()->findAll('xpath', $xpath)) {
180                 $this->execute("behat_general::i_click_on", array($this->escape($xpath), "xpath_element"));
181             }
182         }
184         // Going to edit calculation.
185         $savechanges = get_string('savechanges', 'grades');
186         $edit = behat_context_helper::escape(get_string('editcalculation', 'grades'));
187         $linkxpath = "//a[./img[starts-with(@title,$edit) and contains(@title,$gradeitem)]]";
188         $this->execute("behat_general::i_click_on", array($this->escape($linkxpath), "xpath_element"));
190         // Mapping names to idnumbers.
191         $datahash = $data->getRowsHash();
192         foreach ($datahash as $gradeitem => $idnumber) {
193             // This xpath looks for course, categories and items with the provided name.
194             // Grrr, we can't equal in categoryitem and courseitem because there is a line jump...
195             $inputxpath = "//input[@class='idnumber'][" .
196                 "parent::li[@class='item'][text()='" . $gradeitem . "']" .
197                 " | " .
198                 "parent::li[@class='categoryitem' | @class='courseitem']" .
199                 "/parent::ul/parent::li[starts-with(text(),'" . $gradeitem . "')]" .
200             "]";
201             $this->execute('behat_forms::i_set_the_field_with_xpath_to', array($inputxpath, $idnumber));
202         }
204         $this->execute('behat_forms::press_button', get_string('addidnumbers', 'grades'));
206         $this->execute('behat_forms::i_set_the_field_to', array(get_string('calculation', 'grades'), $calculation));
207         $this->execute('behat_forms::press_button', $savechanges);
208     }
210     /**
211      * Resets the weights for the grade category
212      *
213      * Teacher must be on the grade setup page.
214      *
215      * @Given /^I reset weights for grade category "(?P<grade_item_string>(?:[^"]|\\")*)"$/
216      * @param $gradeitem
217      */
218     public function i_reset_weights_for_grade_category($gradeitem) {
220         $steps = array();
222         if ($this->running_javascript()) {
223             $gradeitemliteral = behat_context_helper::escape($gradeitem);
224             $xpath = "//tr[contains(.,$gradeitemliteral)]//*[contains(@class,'moodle-actionmenu')]//a[contains(@class,'toggle-display')]";
225             if ($this->getSession()->getPage()->findAll('xpath', $xpath)) {
226                 $this->execute("behat_general::i_click_on", array($this->escape($xpath), "xpath_element"));
227             }
228         }
230         $linktext = get_string('resetweights', 'grades', (object)array('itemname' => $gradeitem));
231         $this->execute("behat_general::i_click_on", array($this->escape($linktext), "link"));
232     }
234     /**
235      * Step allowing to test before-the-fix behaviour of the gradebook
236      *
237      * @Given /^gradebook calculations for the course "(?P<coursename_string>(?:[^"]|\\")*)" are frozen at version "(?P<version_string>(?:[^"]|\\")*)"$/
238      * @param string $coursename
239      * @param string $version
240      */
241     public function gradebook_calculations_for_the_course_are_frozen_at_version($coursename, $version) {
242         global $DB;
243         $courseid = $DB->get_field('course', 'id', array('shortname' => $coursename), MUST_EXIST);
244         set_config('gradebook_calculations_freeze_' . $courseid, $version);
245     }
247     /**
248      * Select the tab in the gradebook. We must be on one of the gradebook pages already.
249      *
250      * @param string $gradepath examples: "View > User report", "Letters > View", "Scales"
251      */
252     protected function select_in_gradebook_tabs($gradepath) {
253         $gradepath = preg_split('/\s*>\s*/', trim($gradepath));
254         if (count($gradepath) > 2) {
255             throw new coding_exception('Grade path is too long (must have no more than two items separated with ">")');
256         }
258         $xpath = '//div[contains(@class,\'grade-navigation\')]';
260         // If the first row of the grade-navigation tabs does not have $gradepath[0] as active tab, click on it.
261         $link = '\'' . $this->escape($gradepath[0]) . '\'';
262         $xpathrow1 = $xpath . '//ul[1]//*[contains(@class,\'active\') and contains(normalize-space(.), ' . $link . ')]';
263         if (!$this->getSession()->getPage()->findAll('xpath', $xpathrow1)) {
264             $this->find('xpath', $xpath . '//ul[1]/li/a[text()=' . $link . ']')->click();
265             $this->wait_for_pending_js();
266         }
268         if (isset($gradepath[1])) {
269             // If the second row of the grade-navigation tabs does not have $gradepath[1] as active tab, click on it.
270             $link = '\'' . $this->escape($gradepath[1]) . '\'';
271             $xpathrow2 = $xpath . '//ul[2]//*[contains(@class,\'active\') and contains(normalize-space(.), ' . $link . ')]';
272             if (!$this->getSession()->getPage()->findAll('xpath', $xpathrow2)) {
273                 $this->find('xpath', $xpath . '//ul[2]/li/a[text()=' . $link . ']')->click();
274                 $this->wait_for_pending_js();
275             }
276         }
277     }
279     /**
280      * Navigates to the course gradebook and selects a specified item from the grade navigation tabs.
281      *
282      * Examples:
283      * - I navigate to "Setup > Gradebook setup" in the course gradebook
284      * - I navigate to "Scales" in the course gradebook
285      * - I navigate to "Letters > View" in the course gradebook
286      * - I navigate to "View > User report" in the course gradebook // for teachers
287      * - I navigate to "User report" in the course gradebook // for students
288      *
289      * @Given /^I navigate to "(?P<gradepath_string>(?:[^"]|\\")*)" in the course gradebook$/
290      * @param string $gradepath
291      */
292     public function i_navigate_to_in_the_course_gradebook($gradepath) {
293         // If we are not on one of the gradebook pages already, follow "Grades" link in the navigation block.
294         $xpath = '//div[contains(@class,\'grade-navigation\')]';
295         if (!$this->getSession()->getPage()->findAll('xpath', $xpath)) {
296             $this->execute("behat_general::i_click_on_in_the", array(get_string('grades'), 'link',
297                 get_string('pluginname', 'block_navigation'), 'block'));
298         }
300         $this->select_in_gradebook_tabs($gradepath);
301     }