Commit | Line | Data |
---|---|---|
23ebc481 DM |
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 | * Steps definitions related with forms. | |
19 | * | |
20 | * @package core | |
21 | * @category test | |
22 | * @copyright 2012 David Monllaó | |
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 | ||
28 | require_once(__DIR__ . '/../../../lib/behat/behat_base.php'); | |
a4534dce | 29 | require_once(__DIR__ . '/../../../lib/behat/behat_field_manager.php'); |
23ebc481 DM |
30 | |
31 | use Behat\Behat\Context\Step\Given as Given, | |
32 | Behat\Behat\Context\Step\When as When, | |
33 | Behat\Behat\Context\Step\Then as Then, | |
34 | Behat\Gherkin\Node\TableNode as TableNode, | |
35 | Behat\Mink\Element\NodeElement as NodeElement, | |
36 | Behat\Mink\Exception\ExpectationException as ExpectationException, | |
37 | Behat\Mink\Exception\ElementNotFoundException as ElementNotFoundException; | |
38 | ||
39 | /** | |
40 | * Forms-related steps definitions. | |
41 | * | |
42 | * @package core | |
43 | * @category test | |
44 | * @copyright 2012 David Monllaó | |
45 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | |
46 | */ | |
47 | class behat_forms extends behat_base { | |
48 | ||
49 | /** | |
50 | * Presses button with specified id|name|title|alt|value. | |
51 | * | |
23ebc481 | 52 | * @When /^I press "(?P<button_string>(?:[^"]|\\")*)"$/ |
1f9ffbdb | 53 | * @throws ElementNotFoundException Thrown by behat_base::find |
46ac40cd | 54 | * @param string $button |
23ebc481 DM |
55 | */ |
56 | public function press_button($button) { | |
1f9ffbdb DM |
57 | |
58 | // Ensures the button is present. | |
59 | $buttonnode = $this->find_button($button); | |
60 | $buttonnode->press(); | |
23ebc481 DM |
61 | } |
62 | ||
63 | /** | |
64 | * Fills a moodle form with field/value data. | |
65 | * | |
23ebc481 | 66 | * @Given /^I fill the moodle form with:$/ |
1f9ffbdb | 67 | * @throws ElementNotFoundException Thrown by behat_base::find |
23ebc481 DM |
68 | * @param TableNode $data |
69 | */ | |
70 | public function i_fill_the_moodle_form_with(TableNode $data) { | |
71 | ||
f8f1bdc3 DM |
72 | // Expand all fields in case we have. |
73 | $this->expand_all_fields(); | |
74 | ||
23ebc481 DM |
75 | $datahash = $data->getRowsHash(); |
76 | ||
77 | // The action depends on the field type. | |
78 | foreach ($datahash as $locator => $value) { | |
79 | ||
a4534dce | 80 | // Getting the node element pointed by the label. |
1f9ffbdb | 81 | $fieldnode = $this->find_field($locator); |
23ebc481 DM |
82 | |
83 | // Gets the field type from a parent node. | |
051e9663 | 84 | $field = behat_field_manager::get_form_field($fieldnode, $this->getSession()); |
23ebc481 DM |
85 | |
86 | // Delegates to the field class. | |
d1e55a47 | 87 | $field->set_value($value); |
23ebc481 DM |
88 | } |
89 | } | |
90 | ||
f8f1bdc3 DM |
91 | /** |
92 | * Expands all moodleform's fields, including collapsed fieldsets and advanced fields if they are present. | |
93 | * @Given /^I expand all fieldsets$/ | |
94 | */ | |
95 | public function i_expand_all_fieldsets() { | |
96 | $this->expand_all_fields(); | |
97 | } | |
98 | ||
99 | /** | |
100 | * Expands all moodle form fieldsets if they exists. | |
101 | * | |
102 | * Externalized from i_expand_all_fields to call it from | |
103 | * other form-related steps without having to use steps-group calls. | |
104 | * | |
105 | * @throws ElementNotFoundException Thrown by behat_base::find_all | |
106 | * @return void | |
107 | */ | |
108 | protected function expand_all_fields() { | |
109 | ||
fb99ef1d DM |
110 | // We ensure that all the editors are loaded and we can interact with them. |
111 | $this->ensure_editors_are_loaded(); | |
112 | ||
74c78e74 DM |
113 | // We already know that we waited for the DOM and the JS to be loaded, even the editor |
114 | // so, we will use the reduced timeout as it is a common task and we should save time. | |
f8f1bdc3 DM |
115 | try { |
116 | ||
8cda2e6f | 117 | // Expand fieldsets link. |
74c78e74 | 118 | $xpath = "//div[@class='collapsible-actions']" . |
8cda2e6f | 119 | "/descendant::a[contains(concat(' ', @class, ' '), ' collapseexpand ')]" . |
74c78e74 DM |
120 | "[not(contains(concat(' ', @class, ' '), ' collapse-all '))]"; |
121 | $collapseexpandlink = $this->find('xpath', $xpath, false, false, self::REDUCED_TIMEOUT); | |
8cda2e6f | 122 | $collapseexpandlink->click(); |
f8f1bdc3 DM |
123 | |
124 | } catch (ElementNotFoundException $e) { | |
74c78e74 DM |
125 | // The behat_base::find() method throws an exception if there are no elements, |
126 | // we should not fail a test because of this. We continue if there are not expandable fields. | |
f8f1bdc3 DM |
127 | } |
128 | ||
129 | // Different try & catch as we can have expanded fieldsets with advanced fields on them. | |
130 | try { | |
131 | ||
8cda2e6f DM |
132 | // Expand all fields xpath. |
133 | $showmorexpath = "//a[normalize-space(.)='" . get_string('showmore', 'form') . "']" . | |
134 | "[contains(concat(' ', normalize-space(@class), ' '), ' moreless-toggler')]"; | |
f8f1bdc3 | 135 | |
8cda2e6f | 136 | // We don't wait here as we already waited when getting the expand fieldsets links. |
74c78e74 DM |
137 | if (!$showmores = $this->getSession()->getPage()->findAll('xpath', $showmorexpath)) { |
138 | return; | |
139 | } | |
f8f1bdc3 | 140 | |
8cda2e6f DM |
141 | // Funny thing about this, with findAll() we specify a pattern and each element matching the pattern is added to the array |
142 | // with of xpaths with a [0], [1]... sufix, but when we click on an element it does not matches the specified xpath | |
143 | // anymore (now is a "Show less..." link) so [1] becomes [0], that's why we always click on the first XPath match, | |
144 | // will be always the next one. | |
f8f1bdc3 DM |
145 | $iterations = count($showmores); |
146 | for ($i = 0; $i < $iterations; $i++) { | |
147 | $showmores[0]->click(); | |
148 | } | |
149 | ||
150 | } catch (ElementNotFoundException $e) { | |
151 | // We continue with the test. | |
152 | } | |
153 | ||
154 | } | |
155 | ||
23ebc481 DM |
156 | /** |
157 | * Fills in form field with specified id|name|label|value. | |
158 | * | |
23ebc481 | 159 | * @When /^I fill in "(?P<field_string>(?:[^"]|\\")*)" with "(?P<value_string>(?:[^"]|\\")*)"$/ |
1f9ffbdb | 160 | * @throws ElementNotFoundException Thrown by behat_base::find |
46ac40cd DM |
161 | * @param string $field |
162 | * @param string $value | |
23ebc481 DM |
163 | */ |
164 | public function fill_field($field, $value) { | |
1f9ffbdb DM |
165 | |
166 | $fieldnode = $this->find_field($field); | |
167 | $fieldnode->setValue($value); | |
23ebc481 DM |
168 | } |
169 | ||
170 | /** | |
171 | * Selects option in select field with specified id|name|label|value. | |
172 | * | |
23ebc481 | 173 | * @When /^I select "(?P<option_string>(?:[^"]|\\")*)" from "(?P<select_string>(?:[^"]|\\")*)"$/ |
1f9ffbdb | 174 | * @throws ElementNotFoundException Thrown by behat_base::find |
46ac40cd DM |
175 | * @param string $option |
176 | * @param string $select | |
23ebc481 DM |
177 | */ |
178 | public function select_option($option, $select) { | |
23ebc481 | 179 | |
1f9ffbdb | 180 | $selectnode = $this->find_field($select); |
28abad1a | 181 | |
d1e55a47 DM |
182 | // We delegate to behat_form_field class, it will |
183 | // guess the type properly as it is a select tag. | |
184 | $selectformfield = behat_field_manager::get_form_field($selectnode, $this->getSession()); | |
185 | $selectformfield->set_value($option); | |
23ebc481 DM |
186 | } |
187 | ||
fb624374 DM |
188 | /** |
189 | * Selects the specified id|name|label from the specified radio button. | |
190 | * | |
191 | * @When /^I select "(?P<radio_button_string>(?:[^"]|\\")*)" radio button$/ | |
192 | * @throws ElementNotFoundException Thrown by behat_base::find | |
5cde7298 | 193 | * @param string $radio The radio button id, name or label value |
fb624374 DM |
194 | */ |
195 | public function select_radio($radio) { | |
196 | ||
197 | $radionode = $this->find_radio($radio); | |
198 | $radionode->check(); | |
199 | ||
200 | // Adding a click as Selenium requires it to fire some JS events. | |
cd7ea8f0 DM |
201 | if ($this->running_javascript()) { |
202 | $radionode->click(); | |
203 | } | |
fb624374 DM |
204 | } |
205 | ||
23ebc481 DM |
206 | /** |
207 | * Checks checkbox with specified id|name|label|value. | |
208 | * | |
23ebc481 | 209 | * @When /^I check "(?P<option_string>(?:[^"]|\\")*)"$/ |
1f9ffbdb | 210 | * @throws ElementNotFoundException Thrown by behat_base::find |
46ac40cd | 211 | * @param string $option |
23ebc481 DM |
212 | */ |
213 | public function check_option($option) { | |
1f9ffbdb | 214 | |
d1e55a47 DM |
215 | // We don't delegate to behat_form_checkbox as the |
216 | // step is explicitly saying I check. | |
1f9ffbdb DM |
217 | $checkboxnode = $this->find_field($option); |
218 | $checkboxnode->check(); | |
23ebc481 DM |
219 | } |
220 | ||
221 | /** | |
222 | * Unchecks checkbox with specified id|name|label|value. | |
223 | * | |
23ebc481 | 224 | * @When /^I uncheck "(?P<option_string>(?:[^"]|\\")*)"$/ |
1f9ffbdb | 225 | * @throws ElementNotFoundException Thrown by behat_base::find |
46ac40cd | 226 | * @param string $option |
23ebc481 DM |
227 | */ |
228 | public function uncheck_option($option) { | |
1f9ffbdb | 229 | |
d1e55a47 DM |
230 | // We don't delegate to behat_form_checkbox as the |
231 | // step is explicitly saying I uncheck. | |
1f9ffbdb DM |
232 | $checkboxnode = $this->find_field($option); |
233 | $checkboxnode->uncheck(); | |
23ebc481 DM |
234 | } |
235 | ||
236 | /** | |
237 | * Checks that the form element field have the specified value. | |
238 | * | |
23ebc481 | 239 | * @Then /^the "(?P<field_string>(?:[^"]|\\")*)" field should match "(?P<value_string>(?:[^"]|\\")*)" value$/ |
1f9ffbdb DM |
240 | * @throws ExpectationException |
241 | * @throws ElementNotFoundException Thrown by behat_base::find | |
46ac40cd DM |
242 | * @param string $locator |
243 | * @param string $value | |
23ebc481 DM |
244 | */ |
245 | public function the_field_should_match_value($locator, $value) { | |
246 | ||
1f9ffbdb | 247 | $fieldnode = $this->find_field($locator); |
23ebc481 | 248 | |
49d91129 | 249 | // Get the field. |
051e9663 | 250 | $field = behat_field_manager::get_form_field($fieldnode, $this->getSession()); |
49d91129 | 251 | $fieldvalue = $field->get_value(); |
23ebc481 DM |
252 | |
253 | // Checks if the provided value matches the current field value. | |
15c7fb4a | 254 | if (trim($value) != trim($fieldvalue)) { |
23ebc481 | 255 | throw new ExpectationException( |
49d91129 | 256 | 'The \'' . $locator . '\' value is \'' . $fieldvalue . '\', \'' . $value . '\' expected' , |
23ebc481 DM |
257 | $this->getSession() |
258 | ); | |
259 | } | |
260 | } | |
261 | ||
262 | /** | |
263 | * Checks, that checkbox with specified in|name|label|value is checked. | |
264 | * | |
23ebc481 | 265 | * @Then /^the "(?P<checkbox_string>(?:[^"]|\\")*)" checkbox should be checked$/ |
1f9ffbdb | 266 | * @see Behat\MinkExtension\Context\MinkContext |
46ac40cd | 267 | * @param string $checkbox |
23ebc481 DM |
268 | */ |
269 | public function assert_checkbox_checked($checkbox) { | |
23ebc481 DM |
270 | $this->assertSession()->checkboxChecked($checkbox); |
271 | } | |
272 | ||
273 | /** | |
274 | * Checks, that checkbox with specified in|name|label|value is unchecked. | |
275 | * | |
23ebc481 | 276 | * @Then /^the "(?P<checkbox_string>(?:[^"]|\\")*)" checkbox should not be checked$/ |
1f9ffbdb | 277 | * @see Behat\MinkExtension\Context\MinkContext |
46ac40cd | 278 | * @param string $checkbox |
23ebc481 DM |
279 | */ |
280 | public function assert_checkbox_not_checked($checkbox) { | |
23ebc481 DM |
281 | $this->assertSession()->checkboxNotChecked($checkbox); |
282 | } | |
283 | ||
284 | /** | |
285 | * Checks, that given select box contains the specified option. | |
286 | * | |
23ebc481 | 287 | * @Then /^the "(?P<select_string>(?:[^"]|\\")*)" select box should contain "(?P<option_string>(?:[^"]|\\")*)"$/ |
1f9ffbdb DM |
288 | * @throws ExpectationException |
289 | * @throws ElementNotFoundException Thrown by behat_base::find | |
23ebc481 DM |
290 | * @param string $select The select element name |
291 | * @param string $option The option text/value | |
292 | */ | |
293 | public function the_select_box_should_contain($select, $option) { | |
294 | ||
1f9ffbdb | 295 | $selectnode = $this->find_field($select); |
23ebc481 DM |
296 | |
297 | $regex = '/' . preg_quote($option, '/') . '/ui'; | |
298 | if (!preg_match($regex, $selectnode->getText())) { | |
299 | throw new ExpectationException( | |
300 | 'The select box "' . $select . '" does not contains the option "' . $option . '"', | |
301 | $this->getSession() | |
302 | ); | |
303 | } | |
304 | ||
305 | } | |
306 | ||
307 | /** | |
308 | * Checks, that given select box does not contain the specified option. | |
309 | * | |
23ebc481 | 310 | * @Then /^the "(?P<select_string>(?:[^"]|\\")*)" select box should not contain "(?P<option_string>(?:[^"]|\\")*)"$/ |
1f9ffbdb DM |
311 | * @throws ExpectationException |
312 | * @throws ElementNotFoundException Thrown by behat_base::find | |
23ebc481 DM |
313 | * @param string $select The select element name |
314 | * @param string $option The option text/value | |
315 | */ | |
316 | public function the_select_box_should_not_contain($select, $option) { | |
317 | ||
1f9ffbdb | 318 | $selectnode = $this->find_field($select); |
23ebc481 DM |
319 | |
320 | $regex = '/' . preg_quote($option, '/') . '/ui'; | |
321 | if (preg_match($regex, $selectnode->getText())) { | |
322 | throw new ExpectationException( | |
323 | 'The select box "' . $select . '" contains the option "' . $option . '"', | |
324 | $this->getSession() | |
325 | ); | |
326 | } | |
327 | } | |
328 | ||
23ebc481 | 329 | } |