weekly release 3.0dev
[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
d06aec10
MG
30use Behat\Behat\Context\Step\Given as Given,
31 Behat\Gherkin\Node\TableNode as TableNode;
4f5eaa55
MN
32
33class behat_grade extends behat_base {
34
35 /**
36 * Enters a grade via the gradebook for a specific grade item and user when viewing the 'Grader report' with editing mode turned on.
37 *
38 * @Given /^I give the grade "(?P<grade_number>(?:[^"]|\\")*)" to the user "(?P<username_string>(?:[^"]|\\")*)" for the grade item "(?P<grade_activity_string>(?:[^"]|\\")*)"$/
39 * @param int $grade
40 * @param string $userfullname the user's fullname as returned by fullname()
41 * @param string $itemname
42 * @return Given
43 */
44 public function i_give_the_grade($grade, $userfullname, $itemname) {
45 $gradelabel = $userfullname . ' ' . $itemname;
46 $fieldstr = get_string('useractivitygrade', 'gradereport_grader', $gradelabel);
47
f083d614 48 return new Given('I set the field "' . $this->escape($fieldstr) . '" to "' . $grade . '"');
4f5eaa55 49 }
d06aec10
MG
50
51 /**
52 * Changes the settings of a grade item or category or the course.
53 *
54 * Teacher must be either on the grade setup page or on the Grader report page with editing mode turned on.
55 *
56 * @Given /^I set the following settings for grade item "(?P<grade_item_string>(?:[^"]|\\")*)":$/
57 * @param string $gradeitem
58 * @param TableNode $data
59 * @return Given[]
60 */
61 public function i_set_the_following_settings_for_grade_item($gradeitem, TableNode $data) {
079b2e52
MG
62
63 $steps = array();
64 $gradeitem = $this->getSession()->getSelectorsHandler()->xpathLiteral($gradeitem);
65
66 if ($this->running_javascript()) {
67 $xpath = "//tr[contains(.,$gradeitem)]//*[contains(@class,'moodle-actionmenu')]//a[contains(@class,'toggle-display')]";
68 if ($this->getSession()->getPage()->findAll('xpath', $xpath)) {
69 $steps[] = new Given('I click on "' . $this->escape($xpath) . '" "xpath_element"');
70 }
71 }
72
d06aec10
MG
73 $savechanges = get_string('savechanges', 'grades');
74 $edit = $this->getSession()->getSelectorsHandler()->xpathLiteral(get_string('edit') . ' ');
d06aec10 75 $linkxpath = "//a[./img[starts-with(@title,$edit) and contains(@title,$gradeitem)]]";
079b2e52
MG
76 $steps[] = new Given('I click on "' . $this->escape($linkxpath) . '" "xpath_element"');
77 $steps[] = new Given('I set the following fields to these values:', $data);
78 $steps[] = new Given('I press "' . $this->escape($savechanges) . '"');
79 return $steps;
80 }
81
12a4770d
DM
82 /**
83 * Sets a calculated manual grade item. Needs a table with item name - idnumber relation. The step requires you to be in categories and items page.
84 *
85 * @Given /^I set "(?P<calculation_string>(?:[^"]|\\")*)" calculation for grade item "(?P<grade_item_string>(?:[^"]|\\")*)" with idnumbers:$/
86 * @param string $calculation The calculation.
87 * @param string $gradeitem The grade item name.
88 * @param TableNode $TableNode The grade item name - idnumbers relation.
89 * @return Given[]
90 */
91 public function i_set_calculation_for_grade_item_with_idnumbers($calculation, $gradeitem, TableNode $data) {
92
93 $steps = array();
94 $gradeitem = $this->getSession()->getSelectorsHandler()->xpathLiteral($gradeitem);
95
96 if ($this->running_javascript()) {
97 $xpath = "//tr[contains(.,$gradeitem)]//*[contains(@class,'moodle-actionmenu')]//a[contains(@class,'toggle-display')]";
98 if ($this->getSession()->getPage()->findAll('xpath', $xpath)) {
99 $steps[] = new Given('I click on "' . $this->escape($xpath) . '" "xpath_element"');
100 }
101 }
102
103 // Going to edit calculation.
104 $savechanges = get_string('savechanges', 'grades');
105 $edit = $this->getSession()->getSelectorsHandler()->xpathLiteral(get_string('editcalculation', 'grades'));
106 $linkxpath = "//a[./img[starts-with(@title,$edit) and contains(@title,$gradeitem)]]";
107 $steps[] = new Given('I click on "' . $this->escape($linkxpath) . '" "xpath_element"');
108
109 // After adding id numbers we should wait until the page is reloaded.
110 $steps[] = new Given('I wait until the page is ready');
111
112 // Mapping names to idnumbers.
113 $datahash = $data->getRowsHash();
114 foreach ($datahash as $gradeitem => $idnumber) {
115 // This xpath looks for course, categories and items with the provided name.
116 // Grrr, we can't equal in categoryitem and courseitem because there is a line jump...
117 $inputxpath ="//input[@class='idnumber'][" .
118 "parent::li[@class='item'][text()='" . $gradeitem . "']" .
119 " | " .
120 "parent::li[@class='categoryitem' | @class='courseitem']/parent::ul/parent::li[starts-with(text(),'" . $gradeitem . "')]" .
121 "]";
122 $steps[] = new Given('I set the field with xpath "' . $inputxpath . '" to "' . $idnumber . '"');
123 }
124
125 $steps[] = new Given('I press "' . get_string('addidnumbers', 'grades') . '"');
126
127 // After adding id numbers we should wait until the page is reloaded.
128 $steps[] = new Given('I wait until the page is ready');
129
130 $steps[] = new Given('I set the field "' . get_string('calculation', 'grades') . '" to "' . $calculation . '"');
131 $steps[] = new Given('I press "' . $savechanges . '"');
132
133 return $steps;
134 }
135
079b2e52
MG
136 /**
137 * Resets the weights for the grade category
138 *
139 * Teacher must be on the grade setup page.
140 *
141 * @Given /^I reset weights for grade category "(?P<grade_item_string>(?:[^"]|\\")*)"$/
142 * @param $gradeitem
143 * @return array
144 */
145 public function i_reset_weights_for_grade_category($gradeitem) {
146
147 $steps = array();
148
149 if ($this->running_javascript()) {
150 $gradeitemliteral = $this->getSession()->getSelectorsHandler()->xpathLiteral($gradeitem);
151 $xpath = "//tr[contains(.,$gradeitemliteral)]//*[contains(@class,'moodle-actionmenu')]//a[contains(@class,'toggle-display')]";
152 if ($this->getSession()->getPage()->findAll('xpath', $xpath)) {
153 $steps[] = new Given('I click on "' . $this->escape($xpath) . '" "xpath_element"');
154 }
155 }
156
157 $linktext = get_string('resetweights', 'grades', (object)array('itemname' => $gradeitem));
158 $steps[] = new Given('I click on "' . $this->escape($linktext) . '" "link"');
159 return $steps;
d06aec10 160 }
4f5eaa55 161}