Merge branch 'MDL-55206-master' of git://github.com/junpataleta/moodle
[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\Gherkin\Node\TableNode as TableNode,
32     Behat\Gherkin\Node\PyStringNode as PyStringNode,
33     Behat\Mink\Exception\ExpectationException as ExpectationException,
34     Behat\Mink\Exception\ElementNotFoundException as ElementNotFoundException;
36 /**
37  * Forms-related steps definitions.
38  *
39  * @package    core
40  * @category   test
41  * @copyright  2012 David MonllaĆ³
42  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
43  */
44 class behat_forms extends behat_base {
46     /**
47      * Presses button with specified id|name|title|alt|value.
48      *
49      * @When /^I press "(?P<button_string>(?:[^"]|\\")*)"$/
50      * @throws ElementNotFoundException Thrown by behat_base::find
51      * @param string $button
52      */
53     public function press_button($button) {
55         // Ensures the button is present.
56         $buttonnode = $this->find_button($button);
57         $buttonnode->press();
58     }
60     /**
61      * Press button with specified id|name|title|alt|value and switch to main window.
62      *
63      * @When /^I press "(?P<button_string>(?:[^"]|\\")*)" and switch to main window$/
64      * @throws ElementNotFoundException Thrown by behat_base::find
65      * @param string $button
66      */
67     public function press_button_and_switch_to_main_window($button) {
68         // Ensures the button is present, before pressing.
69         $buttonnode = $this->find_button($button);
70         $buttonnode->press();
72         // Switch to main window.
73         $this->getSession()->switchToWindow(behat_general::MAIN_WINDOW_NAME);
74     }
76     /**
77      * Fills a form with field/value data. More info in http://docs.moodle.org/dev/Acceptance_testing#Providing_values_to_steps.
78      *
79      * @Given /^I set the following fields to these values:$/
80      * @throws ElementNotFoundException Thrown by behat_base::find
81      * @param TableNode $data
82      */
83     public function i_set_the_following_fields_to_these_values(TableNode $data) {
85         // Expand all fields in case we have.
86         $this->expand_all_fields();
88         $datahash = $data->getRowsHash();
90         // The action depends on the field type.
91         foreach ($datahash as $locator => $value) {
92             $this->set_field_value($locator, $value);
93         }
94     }
96     /**
97      * Expands all moodleform's fields, including collapsed fieldsets and advanced fields if they are present.
98      * @Given /^I expand all fieldsets$/
99      */
100     public function i_expand_all_fieldsets() {
101         $this->expand_all_fields();
102     }
104     /**
105      * Expands all moodle form fieldsets if they exists.
106      *
107      * Externalized from i_expand_all_fields to call it from
108      * other form-related steps without having to use steps-group calls.
109      *
110      * @throws ElementNotFoundException Thrown by behat_base::find_all
111      * @return void
112      */
113     protected function expand_all_fields() {
114         // Expand only if JS mode, else not needed.
115         if (!$this->running_javascript()) {
116             return;
117         }
119         // We already know that we waited for the DOM and the JS to be loaded, even the editor
120         // so, we will use the reduced timeout as it is a common task and we should save time.
121         try {
123             // Expand fieldsets link.
124             $xpath = "//div[@class='collapsible-actions']" .
125                 "/descendant::a[contains(concat(' ', @class, ' '), ' collapseexpand ')]" .
126                 "[not(contains(concat(' ', @class, ' '), ' collapse-all '))]";
127             $collapseexpandlink = $this->find('xpath', $xpath, false, false, self::REDUCED_TIMEOUT);
128             $collapseexpandlink->click();
130         } catch (ElementNotFoundException $e) {
131             // The behat_base::find() method throws an exception if there are no elements,
132             // we should not fail a test because of this. We continue if there are not expandable fields.
133         }
135         // Different try & catch as we can have expanded fieldsets with advanced fields on them.
136         try {
138             // Expand all fields xpath.
139             $showmorexpath = "//a[normalize-space(.)='" . get_string('showmore', 'form') . "']" .
140                 "[contains(concat(' ', normalize-space(@class), ' '), ' moreless-toggler')]";
142             // We don't wait here as we already waited when getting the expand fieldsets links.
143             if (!$showmores = $this->getSession()->getPage()->findAll('xpath', $showmorexpath)) {
144                 return;
145             }
147             // Funny thing about this, with findAll() we specify a pattern and each element matching the pattern is added to the array
148             // with of xpaths with a [0], [1]... sufix, but when we click on an element it does not matches the specified xpath
149             // anymore (now is a "Show less..." link) so [1] becomes [0], that's why we always click on the first XPath match,
150             // will be always the next one.
151             $iterations = count($showmores);
152             for ($i = 0; $i < $iterations; $i++) {
153                 $showmores[0]->click();
154             }
156         } catch (ElementNotFoundException $e) {
157             // We continue with the test.
158         }
160     }
162     /**
163      * Sets the field to wwwroot plus the given path. Include the first slash.
164      *
165      * @Given /^I set the field "(?P<field_string>(?:[^"]|\\")*)" to local url "(?P<field_path_string>(?:[^"]|\\")*)"$/
166      * @throws ElementNotFoundException Thrown by behat_base::find
167      * @param string $field
168      * @param string $path
169      * @return void
170      */
171     public function i_set_the_field_to_local_url($field, $path) {
172         global $CFG;
173         $this->set_field_value($field, $CFG->wwwroot . $path);
174     }
176     /**
177      * Sets the specified value to the field.
178      *
179      * @Given /^I set the field "(?P<field_string>(?:[^"]|\\")*)" to "(?P<field_value_string>(?:[^"]|\\")*)"$/
180      * @throws ElementNotFoundException Thrown by behat_base::find
181      * @param string $field
182      * @param string $value
183      * @return void
184      */
185     public function i_set_the_field_to($field, $value) {
186         $this->set_field_value($field, $value);
187     }
189     /**
190      * Press the key in the field to trigger the javascript keypress event
191      *
192      * Note that the character key will not actually be typed in the input field
193      *
194      * @Given /^I press key "(?P<key_string>(?:[^"]|\\")*)" in the field "(?P<field_string>(?:[^"]|\\")*)"$/
195      * @throws ElementNotFoundException Thrown by behat_base::find
196      * @param string $key either char-code or character itself,
197      *          may optionally be prefixed with ctrl-, alt-, shift- or meta-
198      * @param string $field
199      * @return void
200      */
201     public function i_press_key_in_the_field($key, $field) {
202         if (!$this->running_javascript()) {
203             throw new DriverException('Key press step is not available with Javascript disabled');
204         }
205         $fld = behat_field_manager::get_form_field_from_label($field, $this);
206         $modifier = null;
207         $char = $key;
208         if (preg_match('/-/', $key)) {
209             list($modifier, $char) = preg_split('/-/', $key, 2);
210         }
211         if (is_numeric($char)) {
212             $char = (int)$char;
213         }
214         $fld->key_press($char, $modifier);
215     }
217     /**
218      * Sets the specified value to the field.
219      *
220      * @Given /^I set the field "(?P<field_string>(?:[^"]|\\")*)" to multiline$/
221      * @throws ElementNotFoundException Thrown by behat_base::find
222      * @param string $field
223      * @param PyStringNode $value
224      * @return void
225      */
226     public function i_set_the_field_to_multiline($field, PyStringNode $value) {
227         $this->set_field_value($field, (string)$value);
228     }
230     /**
231      * Sets the specified value to the field with xpath.
232      *
233      * @Given /^I set the field with xpath "(?P<fieldxpath_string>(?:[^"]|\\")*)" to "(?P<field_value_string>(?:[^"]|\\")*)"$/
234      * @throws ElementNotFoundException Thrown by behat_base::find
235      * @param string $field
236      * @param string $value
237      * @return void
238      */
239     public function i_set_the_field_with_xpath_to($fieldxpath, $value) {
240         $fieldNode = $this->find('xpath', $fieldxpath);
241         $field = behat_field_manager::get_form_field($fieldNode, $this->getSession());
242         $field->set_value($value);
243     }
245     /**
246      * Checks, the field matches the value. More info in http://docs.moodle.org/dev/Acceptance_testing#Providing_values_to_steps.
247      *
248      * @Then /^the field "(?P<field_string>(?:[^"]|\\")*)" matches value "(?P<field_value_string>(?:[^"]|\\")*)"$/
249      * @throws ElementNotFoundException Thrown by behat_base::find
250      * @param string $field
251      * @param string $value
252      * @return void
253      */
254     public function the_field_matches_value($field, $value) {
256         // Get the field.
257         $formfield = behat_field_manager::get_form_field_from_label($field, $this);
259         // Checks if the provided value matches the current field value.
260         if (!$formfield->matches($value)) {
261             $fieldvalue = $formfield->get_value();
262             throw new ExpectationException(
263                 'The \'' . $field . '\' value is \'' . $fieldvalue . '\', \'' . $value . '\' expected' ,
264                 $this->getSession()
265             );
266         }
267     }
269     /**
270      * Checks, the field does not match the value. More info in http://docs.moodle.org/dev/Acceptance_testing#Providing_values_to_steps.
271      *
272      * @Then /^the field "(?P<field_string>(?:[^"]|\\")*)" does not match value "(?P<field_value_string>(?:[^"]|\\")*)"$/
273      * @throws ExpectationException
274      * @throws ElementNotFoundException Thrown by behat_base::find
275      * @param string $field
276      * @param string $value
277      * @return void
278      */
279     public function the_field_does_not_match_value($field, $value) {
281         // Get the field.
282         $formfield = behat_field_manager::get_form_field_from_label($field, $this);
284         // Checks if the provided value matches the current field value.
285         if ($formfield->matches($value)) {
286             throw new ExpectationException(
287                 'The \'' . $field . '\' value matches \'' . $value . '\' and it should not match it' ,
288                 $this->getSession()
289             );
290         }
291     }
293     /**
294      * Checks, the field matches the value.
295      *
296      * @Then /^the field with xpath "(?P<xpath_string>(?:[^"]|\\")*)" matches value "(?P<field_value_string>(?:[^"]|\\")*)"$/
297      * @throws ExpectationException
298      * @throws ElementNotFoundException Thrown by behat_base::find
299      * @param string $fieldxpath
300      * @param string $value
301      * @return void
302      */
303     public function the_field_with_xpath_matches_value($fieldxpath, $value) {
305         // Get the field.
306         $fieldnode = $this->find('xpath', $fieldxpath);
307         $formfield = behat_field_manager::get_form_field($fieldnode, $this->getSession());
309         // Checks if the provided value matches the current field value.
310         if (!$formfield->matches($value)) {
311             $fieldvalue = $formfield->get_value();
312             throw new ExpectationException(
313                 'The \'' . $fieldxpath . '\' value is \'' . $fieldvalue . '\', \'' . $value . '\' expected' ,
314                 $this->getSession()
315             );
316         }
317     }
319     /**
320      * Checks, the field does not match the value.
321      *
322      * @Then /^the field with xpath "(?P<xpath_string>(?:[^"]|\\")*)" does not match value "(?P<field_value_string>(?:[^"]|\\")*)"$/
323      * @throws ExpectationException
324      * @throws ElementNotFoundException Thrown by behat_base::find
325      * @param string $fieldxpath
326      * @param string $value
327      * @return void
328      */
329     public function the_field_with_xpath_does_not_match_value($fieldxpath, $value) {
331         // Get the field.
332         $fieldnode = $this->find('xpath', $fieldxpath);
333         $formfield = behat_field_manager::get_form_field($fieldnode, $this->getSession());
335         // Checks if the provided value matches the current field value.
336         if ($formfield->matches($value)) {
337             throw new ExpectationException(
338                 'The \'' . $fieldxpath . '\' value matches \'' . $value . '\' and it should not match it' ,
339                 $this->getSession()
340             );
341         }
342     }
344     /**
345      * Checks, the provided field/value matches. More info in http://docs.moodle.org/dev/Acceptance_testing#Providing_values_to_steps.
346      *
347      * @Then /^the following fields match these values:$/
348      * @throws ExpectationException
349      * @param TableNode $data Pairs of | field | value |
350      */
351     public function the_following_fields_match_these_values(TableNode $data) {
353         // Expand all fields in case we have.
354         $this->expand_all_fields();
356         $datahash = $data->getRowsHash();
358         // The action depends on the field type.
359         foreach ($datahash as $locator => $value) {
360             $this->the_field_matches_value($locator, $value);
361         }
362     }
364     /**
365      * Checks that the provided field/value pairs don't match. More info in http://docs.moodle.org/dev/Acceptance_testing#Providing_values_to_steps.
366      *
367      * @Then /^the following fields do not match these values:$/
368      * @throws ExpectationException
369      * @param TableNode $data Pairs of | field | value |
370      */
371     public function the_following_fields_do_not_match_these_values(TableNode $data) {
373         // Expand all fields in case we have.
374         $this->expand_all_fields();
376         $datahash = $data->getRowsHash();
378         // The action depends on the field type.
379         foreach ($datahash as $locator => $value) {
380             $this->the_field_does_not_match_value($locator, $value);
381         }
382     }
384     /**
385      * Checks, that given select box contains the specified option.
386      *
387      * @Then /^the "(?P<select_string>(?:[^"]|\\")*)" select box should contain "(?P<option_string>(?:[^"]|\\")*)"$/
388      * @throws ExpectationException
389      * @throws ElementNotFoundException Thrown by behat_base::find
390      * @param string $select The select element name
391      * @param string $option The option text/value. Plain value or comma separated
392      *                       values if multiple. Commas in multiple values escaped with backslash.
393      */
394     public function the_select_box_should_contain($select, $option) {
396         $selectnode = $this->find_field($select);
397         $multiple = $selectnode->hasAttribute('multiple');
398         $optionsarr = array(); // Array of passed value/text options to test.
400         if ($multiple) {
401             // Can pass multiple comma separated, with valuable commas escaped with backslash.
402             foreach (preg_replace('/\\\,/', ',',  preg_split('/(?<!\\\),/', $option)) as $opt) {
403                 $optionsarr[] = trim($opt);
404             }
405         } else {
406             // Only one option has been passed.
407             $optionsarr[] = trim($option);
408         }
410         // Now get all the values and texts in the select.
411         $options = $selectnode->findAll('xpath', '//option');
412         $values = array();
413         foreach ($options as $opt) {
414             $values[trim($opt->getValue())] = trim($opt->getText());
415         }
417         foreach ($optionsarr as $opt) {
418             // Verify every option is a valid text or value.
419             if (!in_array($opt, $values) && !array_key_exists($opt, $values)) {
420                 throw new ExpectationException(
421                     'The select box "' . $select . '" does not contain the option "' . $opt . '"',
422                     $this->getSession()
423                 );
424             }
425         }
426     }
428     /**
429      * Checks, that given select box does not contain the specified option.
430      *
431      * @Then /^the "(?P<select_string>(?:[^"]|\\")*)" select box should not contain "(?P<option_string>(?:[^"]|\\")*)"$/
432      * @throws ExpectationException
433      * @throws ElementNotFoundException Thrown by behat_base::find
434      * @param string $select The select element name
435      * @param string $option The option text/value. Plain value or comma separated
436      *                       values if multiple. Commas in multiple values escaped with backslash.
437      */
438     public function the_select_box_should_not_contain($select, $option) {
440         $selectnode = $this->find_field($select);
441         $multiple = $selectnode->hasAttribute('multiple');
442         $optionsarr = array(); // Array of passed value/text options to test.
444         if ($multiple) {
445             // Can pass multiple comma separated, with valuable commas escaped with backslash.
446             foreach (preg_replace('/\\\,/', ',',  preg_split('/(?<!\\\),/', $option)) as $opt) {
447                 $optionsarr[] = trim($opt);
448             }
449         } else {
450             // Only one option has been passed.
451             $optionsarr[] = trim($option);
452         }
454         // Now get all the values and texts in the select.
455         $options = $selectnode->findAll('xpath', '//option');
456         $values = array();
457         foreach ($options as $opt) {
458             $values[trim($opt->getValue())] = trim($opt->getText());
459         }
461         foreach ($optionsarr as $opt) {
462             // Verify every option is not a valid text or value.
463             if (in_array($opt, $values) || array_key_exists($opt, $values)) {
464                 throw new ExpectationException(
465                     'The select box "' . $select . '" contains the option "' . $opt . '"',
466                     $this->getSession()
467                 );
468             }
469         }
470     }
472     /**
473      * Generic field setter.
474      *
475      * Internal API method, a generic *I set "VALUE" to "FIELD" field*
476      * could be created based on it.
477      *
478      * @param string $fieldlocator The pointer to the field, it will depend on the field type.
479      * @param string $value
480      * @return void
481      */
482     protected function set_field_value($fieldlocator, $value) {
484         // We delegate to behat_form_field class, it will
485         // guess the type properly as it is a select tag.
486         $field = behat_field_manager::get_form_field_from_label($fieldlocator, $this);
487         $field->set_value($value);
488     }
490     /**
491      * Select a value from single select and redirect.
492      *
493      * @Given /^I select "(?P<singleselect_option_string>(?:[^"]|\\")*)" from the "(?P<singleselect_name_string>(?:[^"]|\\")*)" singleselect$/
494      */
495     public function i_select_from_the_singleselect($option, $singleselect) {
497         $this->execute('behat_forms::i_set_the_field_to', array($this->escape($singleselect), $this->escape($option)));
499         if (!$this->running_javascript()) {
500             // Press button in the specified select container.
501             $containerxpath = "//div[" .
502                 "(contains(concat(' ', normalize-space(@class), ' '), ' singleselect ') " .
503                     "or contains(concat(' ', normalize-space(@class), ' '), ' urlselect ')".
504                 ") and (
505                 .//label[contains(normalize-space(string(.)), '" . $singleselect . "')] " .
506                     "or .//select[(./@name='" . $singleselect . "' or ./@id='". $singleselect . "')]" .
507                 ")]";
509             $this->execute('behat_general::i_click_on_in_the',
510                 array(get_string('go'), "button", $containerxpath, "xpath_element")
511             );
512         }
513     }