e93e98c65401eac2a6f053641a087aab0066ccb5
[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      * Fills a form with field/value data. More info in http://docs.moodle.org/dev/Acceptance_testing#Providing_values_to_steps.
62      *
63      * @Given /^I set the following fields to these values:$/
64      * @throws ElementNotFoundException Thrown by behat_base::find
65      * @param TableNode $data
66      */
67     public function i_set_the_following_fields_to_these_values(TableNode $data) {
69         // Expand all fields in case we have.
70         $this->expand_all_fields();
72         $datahash = $data->getRowsHash();
74         // The action depends on the field type.
75         foreach ($datahash as $locator => $value) {
76             $this->set_field_value($locator, $value);
77         }
78     }
80     /**
81      * Expands all moodleform's fields, including collapsed fieldsets and advanced fields if they are present.
82      * @Given /^I expand all fieldsets$/
83      */
84     public function i_expand_all_fieldsets() {
85         $this->expand_all_fields();
86     }
88     /**
89      * Expands all moodle form fieldsets if they exists.
90      *
91      * Externalized from i_expand_all_fields to call it from
92      * other form-related steps without having to use steps-group calls.
93      *
94      * @throws ElementNotFoundException Thrown by behat_base::find_all
95      * @return void
96      */
97     protected function expand_all_fields() {
98         // Expand only if JS mode, else not needed.
99         if (!$this->running_javascript()) {
100             return;
101         }
103         // We already know that we waited for the DOM and the JS to be loaded, even the editor
104         // so, we will use the reduced timeout as it is a common task and we should save time.
105         try {
107             // Expand fieldsets link.
108             $xpath = "//div[@class='collapsible-actions']" .
109                 "/descendant::a[contains(concat(' ', @class, ' '), ' collapseexpand ')]" .
110                 "[not(contains(concat(' ', @class, ' '), ' collapse-all '))]";
111             $collapseexpandlink = $this->find('xpath', $xpath, false, false, self::REDUCED_TIMEOUT);
112             $collapseexpandlink->click();
114         } catch (ElementNotFoundException $e) {
115             // The behat_base::find() method throws an exception if there are no elements,
116             // we should not fail a test because of this. We continue if there are not expandable fields.
117         }
119         // Different try & catch as we can have expanded fieldsets with advanced fields on them.
120         try {
122             // Expand all fields xpath.
123             $showmorexpath = "//a[normalize-space(.)='" . get_string('showmore', 'form') . "']" .
124                 "[contains(concat(' ', normalize-space(@class), ' '), ' moreless-toggler')]";
126             // We don't wait here as we already waited when getting the expand fieldsets links.
127             if (!$showmores = $this->getSession()->getPage()->findAll('xpath', $showmorexpath)) {
128                 return;
129             }
131             // Funny thing about this, with findAll() we specify a pattern and each element matching the pattern is added to the array
132             // with of xpaths with a [0], [1]... sufix, but when we click on an element it does not matches the specified xpath
133             // anymore (now is a "Show less..." link) so [1] becomes [0], that's why we always click on the first XPath match,
134             // will be always the next one.
135             $iterations = count($showmores);
136             for ($i = 0; $i < $iterations; $i++) {
137                 $showmores[0]->click();
138             }
140         } catch (ElementNotFoundException $e) {
141             // We continue with the test.
142         }
144     }
146     /**
147      * Sets the field to wwwroot plus the given path. Include the first slash.
148      *
149      * @Given /^I set the field "(?P<field_string>(?:[^"]|\\")*)" to local url "(?P<field_path_string>(?:[^"]|\\")*)"$/
150      * @throws ElementNotFoundException Thrown by behat_base::find
151      * @param string $field
152      * @param string $path
153      * @return void
154      */
155     public function i_set_the_field_to_local_url($field, $path) {
156         global $CFG;
157         $this->set_field_value($field, $CFG->wwwroot . $path);
158     }
160     /**
161      * Sets the specified value to the field.
162      *
163      * @Given /^I set the field "(?P<field_string>(?:[^"]|\\")*)" to "(?P<field_value_string>(?:[^"]|\\")*)"$/
164      * @throws ElementNotFoundException Thrown by behat_base::find
165      * @param string $field
166      * @param string $value
167      * @return void
168      */
169     public function i_set_the_field_to($field, $value) {
170         $this->set_field_value($field, $value);
171     }
173     /**
174      * Press the key in the field to trigger the javascript keypress event
175      *
176      * Note that the character key will not actually be typed in the input field
177      *
178      * @Given /^I press key "(?P<key_string>(?:[^"]|\\")*)" in the field "(?P<field_string>(?:[^"]|\\")*)"$/
179      * @throws ElementNotFoundException Thrown by behat_base::find
180      * @param string $key either char-code or character itself,
181      *          may optionally be prefixed with ctrl-, alt-, shift- or meta-
182      * @param string $field
183      * @return void
184      */
185     public function i_press_key_in_the_field($key, $field) {
186         if (!$this->running_javascript()) {
187             throw new DriverException('Key press step is not available with Javascript disabled');
188         }
189         $fld = behat_field_manager::get_form_field_from_label($field, $this);
190         $modifier = null;
191         $char = $key;
192         if (preg_match('/-/', $key)) {
193             list($modifier, $char) = preg_split('/-/', $key, 2);
194         }
195         if (is_numeric($char)) {
196             $char = (int)$char;
197         }
198         $fld->key_press($char, $modifier);
199     }
201     /**
202      * Sets the specified value to the field.
203      *
204      * @Given /^I set the field "(?P<field_string>(?:[^"]|\\")*)" to multiline$/
205      * @throws ElementNotFoundException Thrown by behat_base::find
206      * @param string $field
207      * @param PyStringNode $value
208      * @return void
209      */
210     public function i_set_the_field_to_multiline($field, PyStringNode $value) {
211         $this->set_field_value($field, (string)$value);
212     }
214     /**
215      * Sets the specified value to the field with xpath.
216      *
217      * @Given /^I set the field with xpath "(?P<fieldxpath_string>(?:[^"]|\\")*)" to "(?P<field_value_string>(?:[^"]|\\")*)"$/
218      * @throws ElementNotFoundException Thrown by behat_base::find
219      * @param string $field
220      * @param string $value
221      * @return void
222      */
223     public function i_set_the_field_with_xpath_to($fieldxpath, $value) {
224         $fieldNode = $this->find('xpath', $fieldxpath);
225         $field = behat_field_manager::get_form_field($fieldNode, $this->getSession());
226         $field->set_value($value);
227     }
229     /**
230      * Checks, the field matches the value. More info in http://docs.moodle.org/dev/Acceptance_testing#Providing_values_to_steps.
231      *
232      * @Then /^the field "(?P<field_string>(?:[^"]|\\")*)" matches value "(?P<field_value_string>(?:[^"]|\\")*)"$/
233      * @throws ElementNotFoundException Thrown by behat_base::find
234      * @param string $field
235      * @param string $value
236      * @return void
237      */
238     public function the_field_matches_value($field, $value) {
240         // Get the field.
241         $formfield = behat_field_manager::get_form_field_from_label($field, $this);
243         // Checks if the provided value matches the current field value.
244         if (!$formfield->matches($value)) {
245             $fieldvalue = $formfield->get_value();
246             throw new ExpectationException(
247                 'The \'' . $field . '\' value is \'' . $fieldvalue . '\', \'' . $value . '\' expected' ,
248                 $this->getSession()
249             );
250         }
251     }
253     /**
254      * Checks, the field does not match the value. More info in http://docs.moodle.org/dev/Acceptance_testing#Providing_values_to_steps.
255      *
256      * @Then /^the field "(?P<field_string>(?:[^"]|\\")*)" does not match value "(?P<field_value_string>(?:[^"]|\\")*)"$/
257      * @throws ExpectationException
258      * @throws ElementNotFoundException Thrown by behat_base::find
259      * @param string $field
260      * @param string $value
261      * @return void
262      */
263     public function the_field_does_not_match_value($field, $value) {
265         // Get the field.
266         $formfield = behat_field_manager::get_form_field_from_label($field, $this);
268         // Checks if the provided value matches the current field value.
269         if ($formfield->matches($value)) {
270             throw new ExpectationException(
271                 'The \'' . $field . '\' value matches \'' . $value . '\' and it should not match it' ,
272                 $this->getSession()
273             );
274         }
275     }
277     /**
278      * Checks, the field matches the value.
279      *
280      * @Then /^the field with xpath "(?P<xpath_string>(?:[^"]|\\")*)" matches value "(?P<field_value_string>(?:[^"]|\\")*)"$/
281      * @throws ExpectationException
282      * @throws ElementNotFoundException Thrown by behat_base::find
283      * @param string $fieldxpath
284      * @param string $value
285      * @return void
286      */
287     public function the_field_with_xpath_matches_value($fieldxpath, $value) {
289         // Get the field.
290         $fieldnode = $this->find('xpath', $fieldxpath);
291         $formfield = behat_field_manager::get_form_field($fieldnode, $this->getSession());
293         // Checks if the provided value matches the current field value.
294         if (!$formfield->matches($value)) {
295             $fieldvalue = $formfield->get_value();
296             throw new ExpectationException(
297                 'The \'' . $fieldxpath . '\' value is \'' . $fieldvalue . '\', \'' . $value . '\' expected' ,
298                 $this->getSession()
299             );
300         }
301     }
303     /**
304      * Checks, the field does not match the value.
305      *
306      * @Then /^the field with xpath "(?P<xpath_string>(?:[^"]|\\")*)" does not match value "(?P<field_value_string>(?:[^"]|\\")*)"$/
307      * @throws ExpectationException
308      * @throws ElementNotFoundException Thrown by behat_base::find
309      * @param string $fieldxpath
310      * @param string $value
311      * @return void
312      */
313     public function the_field_with_xpath_does_not_match_value($fieldxpath, $value) {
315         // Get the field.
316         $fieldnode = $this->find('xpath', $fieldxpath);
317         $formfield = behat_field_manager::get_form_field($fieldnode, $this->getSession());
319         // Checks if the provided value matches the current field value.
320         if ($formfield->matches($value)) {
321             throw new ExpectationException(
322                 'The \'' . $fieldxpath . '\' value matches \'' . $value . '\' and it should not match it' ,
323                 $this->getSession()
324             );
325         }
326     }
328     /**
329      * Checks, the provided field/value matches. More info in http://docs.moodle.org/dev/Acceptance_testing#Providing_values_to_steps.
330      *
331      * @Then /^the following fields match these values:$/
332      * @throws ExpectationException
333      * @param TableNode $data Pairs of | field | value |
334      */
335     public function the_following_fields_match_these_values(TableNode $data) {
337         // Expand all fields in case we have.
338         $this->expand_all_fields();
340         $datahash = $data->getRowsHash();
342         // The action depends on the field type.
343         foreach ($datahash as $locator => $value) {
344             $this->the_field_matches_value($locator, $value);
345         }
346     }
348     /**
349      * Checks that the provided field/value pairs don't match. More info in http://docs.moodle.org/dev/Acceptance_testing#Providing_values_to_steps.
350      *
351      * @Then /^the following fields do not match these values:$/
352      * @throws ExpectationException
353      * @param TableNode $data Pairs of | field | value |
354      */
355     public function the_following_fields_do_not_match_these_values(TableNode $data) {
357         // Expand all fields in case we have.
358         $this->expand_all_fields();
360         $datahash = $data->getRowsHash();
362         // The action depends on the field type.
363         foreach ($datahash as $locator => $value) {
364             $this->the_field_does_not_match_value($locator, $value);
365         }
366     }
368     /**
369      * Checks, that given select box contains the specified option.
370      *
371      * @Then /^the "(?P<select_string>(?:[^"]|\\")*)" select box should contain "(?P<option_string>(?:[^"]|\\")*)"$/
372      * @throws ExpectationException
373      * @throws ElementNotFoundException Thrown by behat_base::find
374      * @param string $select The select element name
375      * @param string $option The option text/value. Plain value or comma separated
376      *                       values if multiple. Commas in multiple values escaped with backslash.
377      */
378     public function the_select_box_should_contain($select, $option) {
380         $selectnode = $this->find_field($select);
381         $multiple = $selectnode->hasAttribute('multiple');
382         $optionsarr = array(); // Array of passed value/text options to test.
384         if ($multiple) {
385             // Can pass multiple comma separated, with valuable commas escaped with backslash.
386             foreach (preg_replace('/\\\,/', ',',  preg_split('/(?<!\\\),/', $option)) as $opt) {
387                 $optionsarr[] = trim($opt);
388             }
389         } else {
390             // Only one option has been passed.
391             $optionsarr[] = trim($option);
392         }
394         // Now get all the values and texts in the select.
395         $options = $selectnode->findAll('xpath', '//option');
396         $values = array();
397         foreach ($options as $opt) {
398             $values[trim($opt->getValue())] = trim($opt->getText());
399         }
401         foreach ($optionsarr as $opt) {
402             // Verify every option is a valid text or value.
403             if (!in_array($opt, $values) && !array_key_exists($opt, $values)) {
404                 throw new ExpectationException(
405                     'The select box "' . $select . '" does not contain the option "' . $opt . '"',
406                     $this->getSession()
407                 );
408             }
409         }
410     }
412     /**
413      * Checks, that given select box does not contain the specified option.
414      *
415      * @Then /^the "(?P<select_string>(?:[^"]|\\")*)" select box should not contain "(?P<option_string>(?:[^"]|\\")*)"$/
416      * @throws ExpectationException
417      * @throws ElementNotFoundException Thrown by behat_base::find
418      * @param string $select The select element name
419      * @param string $option The option text/value. Plain value or comma separated
420      *                       values if multiple. Commas in multiple values escaped with backslash.
421      */
422     public function the_select_box_should_not_contain($select, $option) {
424         $selectnode = $this->find_field($select);
425         $multiple = $selectnode->hasAttribute('multiple');
426         $optionsarr = array(); // Array of passed value/text options to test.
428         if ($multiple) {
429             // Can pass multiple comma separated, with valuable commas escaped with backslash.
430             foreach (preg_replace('/\\\,/', ',',  preg_split('/(?<!\\\),/', $option)) as $opt) {
431                 $optionsarr[] = trim($opt);
432             }
433         } else {
434             // Only one option has been passed.
435             $optionsarr[] = trim($option);
436         }
438         // Now get all the values and texts in the select.
439         $options = $selectnode->findAll('xpath', '//option');
440         $values = array();
441         foreach ($options as $opt) {
442             $values[trim($opt->getValue())] = trim($opt->getText());
443         }
445         foreach ($optionsarr as $opt) {
446             // Verify every option is not a valid text or value.
447             if (in_array($opt, $values) || array_key_exists($opt, $values)) {
448                 throw new ExpectationException(
449                     'The select box "' . $select . '" contains the option "' . $opt . '"',
450                     $this->getSession()
451                 );
452             }
453         }
454     }
456     /**
457      * Generic field setter.
458      *
459      * Internal API method, a generic *I set "VALUE" to "FIELD" field*
460      * could be created based on it.
461      *
462      * @param string $fieldlocator The pointer to the field, it will depend on the field type.
463      * @param string $value
464      * @return void
465      */
466     protected function set_field_value($fieldlocator, $value) {
468         // We delegate to behat_form_field class, it will
469         // guess the type properly as it is a select tag.
470         $field = behat_field_manager::get_form_field_from_label($fieldlocator, $this);
471         $field->set_value($value);
472     }
474     /**
475      * Select a value from single select and redirect.
476      *
477      * @Given /^I select "(?P<singleselect_option_string>(?:[^"]|\\")*)" from the "(?P<singleselect_name_string>(?:[^"]|\\")*)" singleselect$/
478      */
479     public function i_select_from_the_singleselect($option, $singleselect) {
481         $this->execute('behat_forms::i_set_the_field_to', array($this->escape($singleselect), $this->escape($option)));
483         if (!$this->running_javascript()) {
484             // Press button in the specified select container.
485             $containerxpath = "//div[" .
486                 "(contains(concat(' ', normalize-space(@class), ' '), ' singleselect ') " .
487                     "or contains(concat(' ', normalize-space(@class), ' '), ' urlselect ')".
488                 ") and (
489                 .//label[contains(normalize-space(string(.)), '" . $singleselect . "')] " .
490                     "or .//select[(./@name='" . $singleselect . "' or ./@id='". $singleselect . "')]" .
491                 ")]";
493             $this->execute('behat_general::i_click_on_in_the',
494                 array(get_string('go'), "button", $containerxpath, "xpath_element")
495             );
496         }
497     }