MDL-58428 theme: Shift templates ready for Bootstrapbase removal
[moodle.git] / grade / tests / behat / behat_grade.php
CommitLineData
4f5eaa55
MN
1<?php
2// This file is part of Moodle - http://moodle.org/
3//
4// Moodle is free software: you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
8//
9// Moodle is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12// GNU General Public License for more details.
13//
14// You should have received a copy of the GNU General Public License
15// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
16
17/**
18 * 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 */
25
26// NOTE: no MOODLE_INTERNAL test here, this file may be required by behat before including /config.php.
27
28require_once(__DIR__ . '/../../../lib/behat/behat_base.php');
29
eb9ca848 30use Behat\Gherkin\Node\TableNode as TableNode;
4f5eaa55
MN
31
32class behat_grade extends behat_base {
33
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
4f5eaa55
MN
41 */
42 public function i_give_the_grade($grade, $userfullname, $itemname) {
43 $gradelabel = $userfullname . ' ' . $itemname;
44 $fieldstr = get_string('useractivitygrade', 'gradereport_grader', $gradelabel);
45
eb9ca848 46 $this->execute('behat_forms::i_set_the_field_to', array($this->escape($fieldstr), $grade));
4f5eaa55 47 }
d06aec10 48
12f946d9
EM
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
12f946d9
EM
57 */
58 public function i_give_the_feedback($feedback, $userfullname, $itemname) {
59 $gradelabel = $userfullname . ' ' . $itemname;
60 $fieldstr = get_string('useractivityfeedback', 'gradereport_grader', $gradelabel);
61
eb9ca848 62 $this->execute('behat_forms::i_set_the_field_to', array($this->escape($fieldstr), $this->escape($feedback)));
12f946d9
EM
63 }
64
d06aec10
MG
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
d06aec10
MG
73 */
74 public function i_set_the_following_settings_for_grade_item($gradeitem, TableNode $data) {
079b2e52 75
921faad9 76 $gradeitem = behat_context_helper::escape($gradeitem);
079b2e52
MG
77
78 if ($this->running_javascript()) {
e3652936 79 $xpath = "//tr[contains(.,$gradeitem)]//*[contains(@class,'moodle-actionmenu')]";
079b2e52 80 if ($this->getSession()->getPage()->findAll('xpath', $xpath)) {
e3652936
MM
81 $this->execute("behat_action_menu::i_open_the_action_menu_in",
82 array("//tr[contains(.,$gradeitem)]",
83 "xpath_element"));
079b2e52
MG
84 }
85 }
86
d06aec10 87 $savechanges = get_string('savechanges', 'grades');
921faad9 88 $edit = behat_context_helper::escape(get_string('edit') . ' ');
e3652936
MM
89 $linkxpath = "//a[./*[contains(concat(' ', normalize-space(@class), ' '), ' icon ') " .
90 "and starts-with(@title,$edit) and contains(@title,$gradeitem)]]";
eb9ca848
RT
91
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));
079b2e52
MG
95 }
96
ca2cb90f
EM
97 /**
98 * Hids a grade item or category.
99 *
8857c715 100 * Teacher must be on the grade setup page.
ca2cb90f
EM
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) {
106
107 $gradeitem = behat_context_helper::escape($gradeitem);
108
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 }
115
8857c715
DW
116 $this->execute("behat_general::i_click_on_in_the", array(get_string('hide'), 'link',
117 "//tr[descendant::*[text() = " . $this->escape($gradeitem) . "]]", 'xpath_element'));
ca2cb90f
EM
118 }
119
12a4770d 120 /**
53914e44
MN
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.
12a4770d
DM
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.
12a4770d
DM
128 */
129 public function i_set_calculation_for_grade_item_with_idnumbers($calculation, $gradeitem, TableNode $data) {
130
921faad9 131 $gradeitem = behat_context_helper::escape($gradeitem);
12a4770d
DM
132
133 if ($this->running_javascript()) {
e3652936 134 $xpath = "//tr[contains(.,$gradeitem)]//*[contains(@class,'moodle-actionmenu')]";
12a4770d 135 if ($this->getSession()->getPage()->findAll('xpath', $xpath)) {
e3652936
MM
136 $this->execute("behat_action_menu::i_open_the_action_menu_in",
137 array("//tr[contains(.,$gradeitem)]",
138 "xpath_element"));
12a4770d
DM
139 }
140 }
141
142 // Going to edit calculation.
143 $savechanges = get_string('savechanges', 'grades');
921faad9 144 $edit = behat_context_helper::escape(get_string('editcalculation', 'grades'));
e3652936
MM
145 $linkxpath = "//a[./*[contains(concat(' ', normalize-space(@class), ' '), ' icon ') " .
146 "and starts-with(@title,$edit) and contains(@title,$gradeitem)]]";
eb9ca848 147 $this->execute("behat_general::i_click_on", array($this->escape($linkxpath), "xpath_element"));
12a4770d
DM
148
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...
e3652936
MM
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 "]";
eb9ca848 160 $this->execute('behat_forms::i_set_the_field_with_xpath_to', array($inputxpath, $idnumber));
77f1778c 161 }
12a4770d 162
eb9ca848
RT
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);
12a4770d 166
12a4770d
DM
167 }
168
f44ffb72
AG
169 /**
170 * Sets a calculated manual grade category total. Needs a table with item name - idnumber relation.
53914e44 171 * The step requires you to be in the 'Gradebook setup' page.
f44ffb72
AG
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.
f44ffb72
AG
177 */
178 public function i_set_calculation_for_grade_category_with_idnumbers($calculation, $gradeitem, TableNode $data) {
179
921faad9
RT
180 $gradecategorytotal = behat_context_helper::escape($gradeitem . ' total');
181 $gradeitem = behat_context_helper::escape($gradeitem);
f44ffb72
AG
182
183 if ($this->running_javascript()) {
e3652936 184 $xpath = "//tr[contains(.,$gradecategorytotal)]//*[contains(@class,'moodle-actionmenu')]";
f44ffb72 185 if ($this->getSession()->getPage()->findAll('xpath', $xpath)) {
e3652936
MM
186 $xpath = "//tr[contains(.,$gradecategorytotal)]";
187 $this->execute("behat_action_menu::i_open_the_action_menu_in", array($xpath, "xpath_element"));
f44ffb72
AG
188 }
189 }
190
191 // Going to edit calculation.
192 $savechanges = get_string('savechanges', 'grades');
921faad9 193 $edit = behat_context_helper::escape(get_string('editcalculation', 'grades'));
e3652936
MM
194 $linkxpath = "//a[./*[contains(concat(' ', normalize-space(@class), ' '), ' icon ') " .
195 "and starts-with(@title,$edit) and contains(@title,$gradeitem)]]";
eb9ca848 196 $this->execute("behat_general::i_click_on", array($this->escape($linkxpath), "xpath_element"));
f44ffb72
AG
197
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'][" .
e3652936
MM
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 "]";
eb9ca848 209 $this->execute('behat_forms::i_set_the_field_with_xpath_to', array($inputxpath, $idnumber));
f44ffb72
AG
210 }
211
eb9ca848 212 $this->execute('behat_forms::press_button', get_string('addidnumbers', 'grades'));
12a4770d 213
eb9ca848
RT
214 $this->execute('behat_forms::i_set_the_field_to', array(get_string('calculation', 'grades'), $calculation));
215 $this->execute('behat_forms::press_button', $savechanges);
12a4770d
DM
216 }
217
079b2e52
MG
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
079b2e52
MG
225 */
226 public function i_reset_weights_for_grade_category($gradeitem) {
227
228 $steps = array();
229
230 if ($this->running_javascript()) {
921faad9 231 $gradeitemliteral = behat_context_helper::escape($gradeitem);
e3652936 232 $xpath = "//tr[contains(.,$gradeitemliteral)]//*[contains(@class,'moodle-actionmenu')]";
079b2e52 233 if ($this->getSession()->getPage()->findAll('xpath', $xpath)) {
e3652936
MM
234 $xpath = "//tr[contains(.,$gradeitemliteral)]";
235 $this->execute("behat_action_menu::i_open_the_action_menu_in", array($xpath, "xpath_element"));
079b2e52
MG
236 }
237 }
238
239 $linktext = get_string('resetweights', 'grades', (object)array('itemname' => $gradeitem));
eb9ca848 240 $this->execute("behat_general::i_click_on", array($this->escape($linktext), "link"));
d06aec10 241 }
deb3d5ed
MG
242
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
deb3d5ed
MG
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 }
b0842f61
MG
255
256 /**
ebcff7e2 257 * Select the tab in the gradebook. We must be on one of the gradebook pages already.
b0842f61 258 *
ebcff7e2 259 * @param string $gradepath examples: "View > User report", "Letters > View", "Scales"
b0842f61 260 */
ebcff7e2 261 protected function select_in_gradebook_tabs($gradepath) {
b0842f61
MG
262 $gradepath = preg_split('/\s*>\s*/', trim($gradepath));
263 if (count($gradepath) > 2) {
ebcff7e2 264 throw new coding_exception('Grade path is too long (must have no more than two items separated with ">")');
b0842f61
MG
265 }
266
b0842f61 267 $xpath = '//div[contains(@class,\'grade-navigation\')]';
b0842f61
MG
268
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]) . '\'';
47b03b91 271 $xpathrow1 = $xpath . '//ul[1]//*[contains(@class,\'active\') and contains(normalize-space(.), ' . $link . ')]';
b0842f61 272 if (!$this->getSession()->getPage()->findAll('xpath', $xpathrow1)) {
1adf21fc
MG
273 $this->find('xpath', $xpath . '//ul[1]/li/a[text()=' . $link . ']')->click();
274 $this->wait_for_pending_js();
b0842f61
MG
275 }
276
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]) . '\'';
47b03b91 280 $xpathrow2 = $xpath . '//ul[2]//*[contains(@class,\'active\') and contains(normalize-space(.), ' . $link . ')]';
b0842f61 281 if (!$this->getSession()->getPage()->findAll('xpath', $xpathrow2)) {
1adf21fc
MG
282 $this->find('xpath', $xpath . '//ul[2]/li/a[text()=' . $link . ']')->click();
283 $this->wait_for_pending_js();
b0842f61
MG
284 }
285 }
286 }
ebcff7e2
MG
287
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) {
e3652936 302 // If we are not on one of the gradebook pages already, follow "Grades" link in the navigation drawer.
ebcff7e2
MG
303 $xpath = '//div[contains(@class,\'grade-navigation\')]';
304 if (!$this->getSession()->getPage()->findAll('xpath', $xpath)) {
e3652936 305 $this->execute('behat_navigation::i_select_from_flat_navigation_drawer', get_string('grades'));
ebcff7e2
MG
306 }
307
308 $this->select_in_gradebook_tabs($gradepath);
309 }
4f5eaa55 310}