85fa85d51e9dfa311996f259e0b1b70648682d05
[moodle.git] / lib / tests / behat / behat_forms.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  * 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  */
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');
29 require_once(__DIR__ . '/../../../lib/behat/behat_field_manager.php');
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;
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 {
49     /**
50      * Presses button with specified id|name|title|alt|value.
51      *
52      * @When /^I press "(?P<button_string>(?:[^"]|\\")*)"$/
53      * @throws ElementNotFoundException Thrown by behat_base::find
54      * @param string $button
55      */
56     public function press_button($button) {
58         // Ensures the button is present.
59         $buttonnode = $this->find_button($button);
60         $buttonnode->press();
61     }
63     /**
64      * Fills a moodle form with field/value data.
65      *
66      * @Given /^I fill the moodle form with:$/
67      * @throws ElementNotFoundException Thrown by behat_base::find
68      * @param TableNode $data
69      */
70     public function i_fill_the_moodle_form_with(TableNode $data) {
72         // Expand all fields in case we have.
73         $this->expand_all_fields();
75         $datahash = $data->getRowsHash();
77         // The action depends on the field type.
78         foreach ($datahash as $locator => $value) {
80             // Getting the node element pointed by the label.
81             $fieldnode = $this->find_field($locator);
83             // Gets the field type from a parent node.
84             $field = behat_field_manager::get_form_field($fieldnode, $this->getSession());
86             // Delegates to the field class.
87             $field->set_value($value);
88         }
89     }
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     }
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() {
110         // We ensure that all the editors are loaded and we can interact with them.
111         $this->ensure_editors_are_loaded();
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.
115         try {
117             // Expand fieldsets link.
118             $xpath = "//div[@class='collapsible-actions']" .
119                 "/descendant::a[contains(concat(' ', @class, ' '), ' collapseexpand ')]" .
120                 "[not(contains(concat(' ', @class, ' '), ' collapse-all '))]";
121             $collapseexpandlink = $this->find('xpath', $xpath, false, false, self::REDUCED_TIMEOUT);
122             $collapseexpandlink->click();
124         } catch (ElementNotFoundException $e) {
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.
127         }
129         // Different try & catch as we can have expanded fieldsets with advanced fields on them.
130         try {
132             // Expand all fields xpath.
133             $showmorexpath = "//a[normalize-space(.)='" . get_string('showmore', 'form') . "']" .
134                 "[contains(concat(' ', normalize-space(@class), ' '), ' moreless-toggler')]";
136             // We don't wait here as we already waited when getting the expand fieldsets links.
137             if (!$showmores = $this->getSession()->getPage()->findAll('xpath', $showmorexpath)) {
138                 return;
139             }
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.
145             $iterations = count($showmores);
146             for ($i = 0; $i < $iterations; $i++) {
147                 $showmores[0]->click();
148             }
150         } catch (ElementNotFoundException $e) {
151             // We continue with the test.
152         }
154     }
156     /**
157      * Fills in form text field with specified id|name|label|value. It works with text-based fields.
158      *
159      * @When /^I fill in "(?P<field_string>(?:[^"]|\\")*)" with "(?P<value_string>(?:[^"]|\\")*)"$/
160      * @throws ElementNotFoundException Thrown by behat_base::find
161      * @param string $field
162      * @param string $value
163      */
164     public function fill_field($field, $value) {
165         $this->set_field_value($field, $value);
166     }
168     /**
169      * Selects option in select field with specified id|name|label|value.
170      *
171      * @When /^I select "(?P<option_string>(?:[^"]|\\")*)" from "(?P<select_string>(?:[^"]|\\")*)"$/
172      * @throws ElementNotFoundException Thrown by behat_base::find
173      * @param string $option
174      * @param string $select
175      */
176     public function select_option($option, $select) {
177         $this->set_field_value($select, $option);
178     }
180     /**
181      * Selects the specified id|name|label from the specified radio button.
182      *
183      * @When /^I select "(?P<radio_button_string>(?:[^"]|\\")*)" radio button$/
184      * @throws ElementNotFoundException Thrown by behat_base::find
185      * @param string $radio The radio button id, name or label value
186      */
187     public function select_radio($radio) {
188         $this->set_field_value($radio, 1);
189     }
191     /**
192      * Checks checkbox with specified id|name|label|value.
193      *
194      * @When /^I check "(?P<option_string>(?:[^"]|\\")*)"$/
195      * @throws ElementNotFoundException Thrown by behat_base::find
196      * @param string $option
197      */
198     public function check_option($option) {
199         $this->set_field_value($option, 1);
200     }
202     /**
203      * Unchecks checkbox with specified id|name|label|value.
204      *
205      * @When /^I uncheck "(?P<option_string>(?:[^"]|\\")*)"$/
206      * @throws ElementNotFoundException Thrown by behat_base::find
207      * @param string $option
208      */
209     public function uncheck_option($option) {
210         $this->set_field_value($option, '');
211     }
213     /**
214      * Checks that the form element field matches the specified value. When using multi-select fields use commas to separate the selected options.
215      *
216      * @Then /^the "(?P<field_string>(?:[^"]|\\")*)" field should match "(?P<value_string>(?:[^"]|\\")*)" value$/
217      * @throws ExpectationException
218      * @throws ElementNotFoundException Thrown by behat_base::find
219      * @param string $locator
220      * @param string $value
221      */
222     public function the_field_should_match_value($locator, $value) {
224         $fieldnode = $this->find_field($locator);
226         // Get the field.
227         $field = behat_field_manager::get_form_field($fieldnode, $this->getSession());
229         // Checks if the provided value matches the current field value.
230         if (!$field->matches($value)) {
231             $fieldvalue = $field->get_value();
232             throw new ExpectationException(
233                 'The \'' . $locator . '\' value is \'' . $fieldvalue . '\', \'' . $value . '\' expected' ,
234                 $this->getSession()
235             );
236         }
237     }
239     /**
240      * Checks that the form element field does not match the specified value.
241      *
242      * @Then /^the field "(?P<field_string>(?:[^"]|\\")*)" does not match value "(?P<value_string>(?:[^"]|\\")*)"$/
243      * @throws ExpectationException
244      * @throws ElementNotFoundException Thrown by behat_base::find
245      * @param string $field
246      * @param string $value
247      * @return void
248      */
249     public function the_field_does_not_match_value($field, $value) {
251         $fieldnode = $this->find_field($field);
253         // Get the field.
254         $field = behat_field_manager::get_form_field($fieldnode, $this->getSession());
256         // Checks if the provided value matches the current field value.
257         if ($field->matches($value)) {
258             $fieldvalue = $field->get_value();
259             throw new ExpectationException(
260                 'The \'' . $field . '\' value matches \'' . $value . '\' and it should not match it' ,
261                 $this->getSession()
262             );
263         }
264     }
266     /**
267      * Checks if fields values matches the provided values. Provide a table with field/value data.
268      *
269      * @Then /^the following fields match these values:$/
270      * @throws ExpectationException
271      * @param TableNode $table Pairs of | field | value |
272      */
273     public function the_following_fields_match_these_values(TableNode $data) {
275         // Expand all fields in case we have.
276         $this->expand_all_fields();
278         $datahash = $data->getRowsHash();
280         // The action depends on the field type.
281         foreach ($datahash as $locator => $value) {
282             $this->the_field_should_match_value($locator, $value);
283         }
284     }
286     /**
287      * Checks that fields values do not match the provided values. Provide a table with field/value data.
288      *
289      * @Then /^the following fields do not match these values:$/
290      * @throws ExpectationException
291      * @param TableNode $table Pairs of | field | value |
292      */
293     public function the_following_fields_do_not_match_these_values(TableNode $data) {
295         // Expand all fields in case we have.
296         $this->expand_all_fields();
298         $datahash = $data->getRowsHash();
300         // The action depends on the field type.
301         foreach ($datahash as $locator => $value) {
302             $this->the_field_does_not_match_value($locator, $value);
303         }
304     }
306     /**
307      * Checks, that checkbox with specified in|name|label|value is checked.
308      *
309      * @Then /^the "(?P<checkbox_string>(?:[^"]|\\")*)" checkbox should be checked$/
310      * @param string $checkbox
311      */
312     public function assert_checkbox_checked($checkbox) {
313         $this->the_field_should_match_value($checkbox, 1);
314     }
316     /**
317      * Checks, that checkbox with specified in|name|label|value is unchecked.
318      *
319      * @Then /^the "(?P<checkbox_string>(?:[^"]|\\")*)" checkbox should not be checked$/
320      * @param string $checkbox
321      */
322     public function assert_checkbox_not_checked($checkbox) {
323         $this->the_field_should_match_value($checkbox, '');
324     }
326     /**
327      * Checks, that given select box contains the specified option.
328      *
329      * @Then /^the "(?P<select_string>(?:[^"]|\\")*)" select box should contain "(?P<option_string>(?:[^"]|\\")*)"$/
330      * @throws ExpectationException
331      * @throws ElementNotFoundException Thrown by behat_base::find
332      * @param string $select The select element name
333      * @param string $option The option text/value. Plain value or comma separated
334      *                       values if multiple. Commas in multiple values escaped with backslash.
335      */
336     public function the_select_box_should_contain($select, $option) {
338         $selectnode = $this->find_field($select);
339         $multiple = $selectnode->hasAttribute('multiple');
340         $optionsarr = array(); // Array of passed value/text options to test.
342         if ($multiple) {
343             // Can pass multiple comma separated, with valuable commas escaped with backslash.
344             foreach (preg_replace('/\\\,/', ',',  preg_split('/(?<!\\\),/', $option)) as $opt) {
345                 $optionsarr[] = trim($opt);
346             }
347         } else {
348             // Only one option has been passed.
349             $optionsarr[] = trim($option);
350         }
352         // Now get all the values and texts in the select.
353         $options = $selectnode->findAll('xpath', '//option');
354         $values = array();
355         foreach ($options as $opt) {
356             $values[trim($opt->getValue())] = trim($opt->getText());
357         }
359         foreach ($optionsarr as $opt) {
360             // Verify every option is a valid text or value.
361             if (!in_array($opt, $values) && !array_key_exists($opt, $values)) {
362                 throw new ExpectationException(
363                     'The select box "' . $select . '" does not contain the option "' . $opt . '"',
364                     $this->getSession()
365                 );
366             }
367         }
368     }
370     /**
371      * Checks, that given select box does not contain the specified option.
372      *
373      * @Then /^the "(?P<select_string>(?:[^"]|\\")*)" select box should not contain "(?P<option_string>(?:[^"]|\\")*)"$/
374      * @throws ExpectationException
375      * @throws ElementNotFoundException Thrown by behat_base::find
376      * @param string $select The select element name
377      * @param string $option The option text/value. Plain value or comma separated
378      *                       values if multiple. Commas in multiple values escaped with backslash.
379      */
380     public function the_select_box_should_not_contain($select, $option) {
382         $selectnode = $this->find_field($select);
383         $multiple = $selectnode->hasAttribute('multiple');
384         $optionsarr = array(); // Array of passed value/text options to test.
386         if ($multiple) {
387             // Can pass multiple comma separated, with valuable commas escaped with backslash.
388             foreach (preg_replace('/\\\,/', ',',  preg_split('/(?<!\\\),/', $option)) as $opt) {
389                 $optionsarr[] = trim($opt);
390             }
391         } else {
392             // Only one option has been passed.
393             $optionsarr[] = trim($option);
394         }
396         // Now get all the values and texts in the select.
397         $options = $selectnode->findAll('xpath', '//option');
398         $values = array();
399         foreach ($options as $opt) {
400             $values[trim($opt->getValue())] = trim($opt->getText());
401         }
403         foreach ($optionsarr as $opt) {
404             // Verify every option is not a valid text or value.
405             if (in_array($opt, $values) || array_key_exists($opt, $values)) {
406                 throw new ExpectationException(
407                     'The select box "' . $select . '" contains the option "' . $opt . '"',
408                     $this->getSession()
409                 );
410             }
411         }
412     }
414     /**
415      * Generic field setter.
416      *
417      * Internal API method, a generic *I set "VALUE" to "FIELD" field*
418      * could be created based on it.
419      *
420      * @param string $fieldlocator The pointer to the field, it will depend on the field type.
421      * @param string $value
422      * @return void
423      */
424     protected function set_field_value($fieldlocator, $value) {
426         $node = $this->find_field($fieldlocator);
428         // We delegate to behat_form_field class, it will
429         // guess the type properly as it is a select tag.
430         $field = behat_field_manager::get_form_field($node, $this->getSession());
431         $field->set_value($value);
432     }