weekly release 3.7dev
[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()) {
79 $xpath = "//tr[contains(.,$gradeitem)]//*[contains(@class,'moodle-actionmenu')]//a[contains(@class,'toggle-display')]";
80 if ($this->getSession()->getPage()->findAll('xpath', $xpath)) {
eb9ca848 81 $this->execute("behat_general::i_click_on", array($this->escape($xpath), "xpath_element"));
079b2e52
MG
82 }
83 }
84
d06aec10 85 $savechanges = get_string('savechanges', 'grades');
921faad9 86 $edit = behat_context_helper::escape(get_string('edit') . ' ');
d06aec10 87 $linkxpath = "//a[./img[starts-with(@title,$edit) and contains(@title,$gradeitem)]]";
eb9ca848
RT
88
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));
079b2e52
MG
92 }
93
ca2cb90f
EM
94 /**
95 * Hids a grade item or category.
96 *
8857c715 97 * Teacher must be on the grade setup page.
ca2cb90f
EM
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) {
103
104 $gradeitem = behat_context_helper::escape($gradeitem);
105
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 }
112
8857c715
DW
113 $this->execute("behat_general::i_click_on_in_the", array(get_string('hide'), 'link',
114 "//tr[descendant::*[text() = " . $this->escape($gradeitem) . "]]", 'xpath_element'));
ca2cb90f
EM
115 }
116
12a4770d 117 /**
53914e44
MN
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.
12a4770d
DM
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.
12a4770d
DM
125 */
126 public function i_set_calculation_for_grade_item_with_idnumbers($calculation, $gradeitem, TableNode $data) {
127
921faad9 128 $gradeitem = behat_context_helper::escape($gradeitem);
12a4770d
DM
129
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)) {
eb9ca848 133 $this->execute("behat_general::i_click_on", array($this->escape($xpath), "xpath_element"));
12a4770d
DM
134 }
135 }
136
137 // Going to edit calculation.
138 $savechanges = get_string('savechanges', 'grades');
921faad9 139 $edit = behat_context_helper::escape(get_string('editcalculation', 'grades'));
12a4770d 140 $linkxpath = "//a[./img[starts-with(@title,$edit) and contains(@title,$gradeitem)]]";
eb9ca848 141 $this->execute("behat_general::i_click_on", array($this->escape($linkxpath), "xpath_element"));
12a4770d
DM
142
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 . "']" .
77f1778c
RT
150 " or " .
151 "parent::li[@class='categoryitem' or @class='courseitem']/parent::ul/parent::li[starts-with(text(),'" . $gradeitem . "')]" .
12a4770d 152 "]";
eb9ca848 153 $this->execute('behat_forms::i_set_the_field_with_xpath_to', array($inputxpath, $idnumber));
77f1778c 154 }
12a4770d 155
eb9ca848
RT
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);
12a4770d 159
12a4770d
DM
160 }
161
f44ffb72
AG
162 /**
163 * Sets a calculated manual grade category total. Needs a table with item name - idnumber relation.
53914e44 164 * The step requires you to be in the 'Gradebook setup' page.
f44ffb72
AG
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.
f44ffb72
AG
170 */
171 public function i_set_calculation_for_grade_category_with_idnumbers($calculation, $gradeitem, TableNode $data) {
172
921faad9
RT
173 $gradecategorytotal = behat_context_helper::escape($gradeitem . ' total');
174 $gradeitem = behat_context_helper::escape($gradeitem);
f44ffb72
AG
175
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)) {
eb9ca848 180 $this->execute("behat_general::i_click_on", array($this->escape($xpath), "xpath_element"));
f44ffb72
AG
181 }
182 }
183
184 // Going to edit calculation.
185 $savechanges = get_string('savechanges', 'grades');
921faad9 186 $edit = behat_context_helper::escape(get_string('editcalculation', 'grades'));
f44ffb72 187 $linkxpath = "//a[./img[starts-with(@title,$edit) and contains(@title,$gradeitem)]]";
eb9ca848 188 $this->execute("behat_general::i_click_on", array($this->escape($linkxpath), "xpath_element"));
f44ffb72
AG
189
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 "]";
eb9ca848 201 $this->execute('behat_forms::i_set_the_field_with_xpath_to', array($inputxpath, $idnumber));
f44ffb72
AG
202 }
203
eb9ca848 204 $this->execute('behat_forms::press_button', get_string('addidnumbers', 'grades'));
12a4770d 205
eb9ca848
RT
206 $this->execute('behat_forms::i_set_the_field_to', array(get_string('calculation', 'grades'), $calculation));
207 $this->execute('behat_forms::press_button', $savechanges);
12a4770d
DM
208 }
209
079b2e52
MG
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
079b2e52
MG
217 */
218 public function i_reset_weights_for_grade_category($gradeitem) {
219
220 $steps = array();
221
222 if ($this->running_javascript()) {
921faad9 223 $gradeitemliteral = behat_context_helper::escape($gradeitem);
079b2e52
MG
224 $xpath = "//tr[contains(.,$gradeitemliteral)]//*[contains(@class,'moodle-actionmenu')]//a[contains(@class,'toggle-display')]";
225 if ($this->getSession()->getPage()->findAll('xpath', $xpath)) {
eb9ca848 226 $this->execute("behat_general::i_click_on", array($this->escape($xpath), "xpath_element"));
079b2e52
MG
227 }
228 }
229
230 $linktext = get_string('resetweights', 'grades', (object)array('itemname' => $gradeitem));
eb9ca848 231 $this->execute("behat_general::i_click_on", array($this->escape($linktext), "link"));
d06aec10 232 }
deb3d5ed
MG
233
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
deb3d5ed
MG
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 }
b0842f61
MG
246
247 /**
ebcff7e2 248 * Select the tab in the gradebook. We must be on one of the gradebook pages already.
b0842f61 249 *
ebcff7e2 250 * @param string $gradepath examples: "View > User report", "Letters > View", "Scales"
b0842f61 251 */
ebcff7e2 252 protected function select_in_gradebook_tabs($gradepath) {
b0842f61
MG
253 $gradepath = preg_split('/\s*>\s*/', trim($gradepath));
254 if (count($gradepath) > 2) {
ebcff7e2 255 throw new coding_exception('Grade path is too long (must have no more than two items separated with ">")');
b0842f61
MG
256 }
257
b0842f61 258 $xpath = '//div[contains(@class,\'grade-navigation\')]';
b0842f61
MG
259
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]) . '\'';
47b03b91 262 $xpathrow1 = $xpath . '//ul[1]//*[contains(@class,\'active\') and contains(normalize-space(.), ' . $link . ')]';
b0842f61 263 if (!$this->getSession()->getPage()->findAll('xpath', $xpathrow1)) {
1adf21fc
MG
264 $this->find('xpath', $xpath . '//ul[1]/li/a[text()=' . $link . ']')->click();
265 $this->wait_for_pending_js();
b0842f61
MG
266 }
267
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]) . '\'';
47b03b91 271 $xpathrow2 = $xpath . '//ul[2]//*[contains(@class,\'active\') and contains(normalize-space(.), ' . $link . ')]';
b0842f61 272 if (!$this->getSession()->getPage()->findAll('xpath', $xpathrow2)) {
1adf21fc
MG
273 $this->find('xpath', $xpath . '//ul[2]/li/a[text()=' . $link . ']')->click();
274 $this->wait_for_pending_js();
b0842f61
MG
275 }
276 }
277 }
ebcff7e2
MG
278
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 }
299
300 $this->select_in_gradebook_tabs($gradepath);
301 }
4f5eaa55 302}