25a1071f6a2ab313e39faf34f03d56be58e81368
[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, PyStringNode};
32 use Behat\Mink\Element\NodeElement;
33 use Behat\Mink\Exception\{ElementNotFoundException, ExpectationException};
35 /**
36  * Forms-related steps definitions.
37  *
38  * Note, Behat tests to verify that the steps defined here work as advertised
39  * are kept in admin/tool/behat/tests/behat.
40  *
41  * @package    core
42  * @category   test
43  * @copyright  2012 David MonllaĆ³
44  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
45  */
46 class behat_forms extends behat_base {
48     /**
49      * Presses button with specified id|name|title|alt|value.
50      *
51      * @When /^I press "(?P<button_string>(?:[^"]|\\")*)"$/
52      * @throws ElementNotFoundException Thrown by behat_base::find
53      * @param string $button
54      */
55     public function press_button($button) {
56         $this->execute('behat_general::i_click_on', [$button, 'button']);
57     }
59     /**
60      * Ensure a button exists.
61      * @Then the button :button exists
62      * @param string $button
63      */
64     public function button_exists(string $button) {
65         $buttonnode = $this->find_button($button);
66         $this->ensure_node_is_visible($buttonnode);
67     }
69     /**
70      * Ensure that a button does not exist.
71      * @Then the button :button does not exist
72      * @param string $button
73      */
74     public function button_does_not_exist(string $button) {
75         $general = behat_context_helper::get('behat_general');
76         $general->should_not_exist($button, 'button');
77     }
79     /**
80      * Press button with specified id|name|title|alt|value and switch to main window.
81      *
82      * @When /^I press "(?P<button_string>(?:[^"]|\\")*)" and switch to main window$/
83      * @throws ElementNotFoundException Thrown by behat_base::find
84      * @param string $button
85      */
86     public function press_button_and_switch_to_main_window($button) {
87         // Ensures the button is present, before pressing.
88         $buttonnode = $this->find_button($button);
89         $buttonnode->press();
91         // Switch to main window.
92         $this->getSession()->switchToWindow(behat_general::MAIN_WINDOW_NAME);
93     }
95     /**
96      * Fills a form with field/value data.
97      *
98      * @Given /^I set the following fields to these values:$/
99      * @throws ElementNotFoundException Thrown by behat_base::find
100      * @param TableNode $data
101      */
102     public function i_set_the_following_fields_to_these_values(TableNode $data) {
104         // Expand all fields in case we have.
105         $this->expand_all_fields();
107         $datahash = $data->getRowsHash();
109         // The action depends on the field type.
110         foreach ($datahash as $locator => $value) {
111             $this->set_field_value($locator, $value);
112         }
113     }
115     /**
116      * Fills a form with field/value data.
117      *
118      * @Given /^I set the following fields in the "(?P<element_container_string>(?:[^"]|\\")*)" "(?P<text_selector_string>[^"]*)" to these values:$/
119      * @throws ElementNotFoundException Thrown by behat_base::find
120      * @param string $containerelement Element we look in
121      * @param string $containerselectortype The type of selector where we look in
122      * @param TableNode $data
123      */
124     public function i_set_the_following_fields_in_container_to_these_values(
125             $containerelement, $containerselectortype, TableNode $data) {
127         // Expand all fields in case we have.
128         $this->expand_all_fields();
130         $datahash = $data->getRowsHash();
132         // The action depends on the field type.
133         foreach ($datahash as $locator => $value) {
134             $this->set_field_value_in_container($locator, $value, $containerselectortype, $containerelement);
135         }
136     }
138     /**
139      * Expands all moodleform's fields, including collapsed fieldsets and advanced fields if they are present.
140      * @Given /^I expand all fieldsets$/
141      */
142     public function i_expand_all_fieldsets() {
143         $this->expand_all_fields();
144     }
146     /**
147      * Expands all moodle form fieldsets if they exists.
148      *
149      * Externalized from i_expand_all_fields to call it from
150      * other form-related steps without having to use steps-group calls.
151      *
152      * @throws ElementNotFoundException Thrown by behat_base::find_all
153      * @return void
154      */
155     protected function expand_all_fields() {
156         // Expand only if JS mode, else not needed.
157         if (!$this->running_javascript()) {
158             return;
159         }
161         // We already know that we waited for the DOM and the JS to be loaded, even the editor
162         // so, we will use the reduced timeout as it is a common task and we should save time.
163         try {
165             // Expand all fieldsets link - which will only be there if there is more than one collapsible section.
166             $expandallxpath = "//div[@class='collapsible-actions']" .
167                 "//a[contains(concat(' ', @class, ' '), ' collapseexpand ')]" .
168                 "[not(contains(concat(' ', @class, ' '), ' collapse-all '))]";
169             // Else, look for the first expand fieldset link.
170             $expandonlysection = "//legend[@class='ftoggler']" .
171                     "//a[contains(concat(' ', @class, ' '), ' fheader ') and @aria-expanded = 'false']";
173             $collapseexpandlink = $this->find('xpath', $expandallxpath . '|' . $expandonlysection,
174                     false, false, behat_base::get_reduced_timeout());
175             $collapseexpandlink->click();
177         } catch (ElementNotFoundException $e) {
178             // The behat_base::find() method throws an exception if there are no elements,
179             // we should not fail a test because of this. We continue if there are not expandable fields.
180         }
182         // Different try & catch as we can have expanded fieldsets with advanced fields on them.
183         try {
185             // Expand all fields xpath.
186             $showmorexpath = "//a[normalize-space(.)='" . get_string('showmore', 'form') . "']" .
187                 "[contains(concat(' ', normalize-space(@class), ' '), ' moreless-toggler')]";
189             // We don't wait here as we already waited when getting the expand fieldsets links.
190             if (!$showmores = $this->getSession()->getPage()->findAll('xpath', $showmorexpath)) {
191                 return;
192             }
194             if ($this->getSession()->getDriver() instanceof \DMore\ChromeDriver\ChromeDriver) {
195                 // Chrome Driver produces unique xpaths for each element.
196                 foreach ($showmores as $showmore) {
197                     $showmore->click();
198                 }
199             } else {
200                 // Funny thing about this, with findAll() we specify a pattern and each element matching the pattern
201                 // is added to the array with of xpaths with a [0], [1]... sufix, but when we click on an element it
202                 // does not matches the specified xpath anymore (now is a "Show less..." link) so [1] becomes [0],
203                 // that's why we always click on the first XPath match, will be always the next one.
204                 $iterations = count($showmores);
205                 for ($i = 0; $i < $iterations; $i++) {
206                     $showmores[0]->click();
207                 }
208             }
210         } catch (ElementNotFoundException $e) {
211             // We continue with the test.
212         }
214     }
216     /**
217      * Sets the field to wwwroot plus the given path. Include the first slash.
218      *
219      * @Given /^I set the field "(?P<field_string>(?:[^"]|\\")*)" to local url "(?P<field_path_string>(?:[^"]|\\")*)"$/
220      * @throws ElementNotFoundException Thrown by behat_base::find
221      * @param string $field
222      * @param string $path
223      * @return void
224      */
225     public function i_set_the_field_to_local_url($field, $path) {
226         global $CFG;
227         $this->set_field_value($field, $CFG->wwwroot . $path);
228     }
230     /**
231      * Sets the specified value to the field.
232      *
233      * @Given /^I set the field "(?P<field_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_to($field, $value) {
240         $this->set_field_value($field, $value);
241     }
243     /**
244      * Sets the specified value to the field.
245      *
246      * @Given /^I set the field "(?P<field_string>(?:[^"]|\\")*)" in the "(?P<element_container_string>(?:[^"]|\\")*)" "(?P<text_selector_string>[^"]*)" to "(?P<field_value_string>(?:[^"]|\\")*)"$/
247      * @throws ElementNotFoundException Thrown by behat_base::find
248      * @param string $field
249      * @param string $containerelement Element we look in
250      * @param string $containerselectortype The type of selector where we look in
251      * @param string $value
252      */
253     public function i_set_the_field_in_container_to($field, $containerelement, $containerselectortype, $value) {
254         $this->set_field_value_in_container($field, $value, $containerselectortype, $containerelement);
255     }
257     /**
258      * Press the key in the field to trigger the javascript keypress event
259      *
260      * Note that the character key will not actually be typed in the input field
261      *
262      * @Given /^I press key "(?P<key_string>(?:[^"]|\\")*)" in the field "(?P<field_string>(?:[^"]|\\")*)"$/
263      * @throws ElementNotFoundException Thrown by behat_base::find
264      * @param string $key either char-code or character itself,
265      *          may optionally be prefixed with ctrl-, alt-, shift- or meta-
266      * @param string $field
267      * @return void
268      */
269     public function i_press_key_in_the_field($key, $field) {
270         if (!$this->running_javascript()) {
271             throw new DriverException('Key press step is not available with Javascript disabled');
272         }
273         $fld = behat_field_manager::get_form_field_from_label($field, $this);
274         $modifier = null;
275         $char = $key;
276         if (preg_match('/-/', $key)) {
277             list($modifier, $char) = preg_split('/-/', $key, 2);
278         }
279         if (is_numeric($char)) {
280             $char = (int)$char;
281         }
282         $fld->key_press($char, $modifier);
283     }
285     /**
286      * Sets the specified value to the field.
287      *
288      * @Given /^I set the field "(?P<field_string>(?:[^"]|\\")*)" to multiline:$/
289      * @throws ElementNotFoundException Thrown by behat_base::find
290      * @param string $field
291      * @param PyStringNode $value
292      * @return void
293      */
294     public function i_set_the_field_to_multiline($field, PyStringNode $value) {
295         $this->set_field_value($field, (string)$value);
296     }
298     /**
299      * Sets the specified value to the field with xpath.
300      *
301      * @Given /^I set the field with xpath "(?P<fieldxpath_string>(?:[^"]|\\")*)" to "(?P<field_value_string>(?:[^"]|\\")*)"$/
302      * @throws ElementNotFoundException Thrown by behat_base::find
303      * @param string $field
304      * @param string $value
305      * @return void
306      */
307     public function i_set_the_field_with_xpath_to($fieldxpath, $value) {
308         $this->set_field_node_value($this->find('xpath', $fieldxpath), $value);
309     }
311     /**
312      * Checks, the field matches the value.
313      *
314      * @Then /^the field "(?P<field_string>(?:[^"]|\\")*)" matches value "(?P<field_value_string>(?:[^"]|\\")*)"$/
315      * @throws ElementNotFoundException Thrown by behat_base::find
316      * @param string $field
317      * @param string $value
318      * @return void
319      */
320     public function the_field_matches_value($field, $value) {
322         // Get the field.
323         $formfield = behat_field_manager::get_form_field_from_label($field, $this);
325         // Checks if the provided value matches the current field value.
326         if (!$formfield->matches($value)) {
327             $fieldvalue = $formfield->get_value();
328             throw new ExpectationException(
329                 'The \'' . $field . '\' value is \'' . $fieldvalue . '\', \'' . $value . '\' expected' ,
330                 $this->getSession()
331             );
332         }
333     }
335     /**
336      * Checks, the field does not match the value.
337      *
338      * @Then /^the field "(?P<field_string>(?:[^"]|\\")*)" does not match value "(?P<field_value_string>(?:[^"]|\\")*)"$/
339      * @throws ExpectationException
340      * @throws ElementNotFoundException Thrown by behat_base::find
341      * @param string $field
342      * @param string $value
343      */
344     public function the_field_does_not_match_value($field, $value) {
346         // Get the field.
347         $formfield = behat_field_manager::get_form_field_from_label($field, $this);
349         // Checks if the provided value matches the current field value.
350         if ($formfield->matches($value)) {
351             throw new ExpectationException(
352                 'The \'' . $field . '\' value matches \'' . $value . '\' and it should not match it' ,
353                 $this->getSession()
354             );
355         }
356     }
358     /**
359      * Checks, the field matches the value.
360      *
361      * @Then /^the field "(?P<field_string>(?:[^"]|\\")*)" in the "(?P<element_container_string>(?:[^"]|\\")*)" "(?P<text_selector_string>[^"]*)" matches value "(?P<field_value_string>(?:[^"]|\\")*)"$/
362      * @throws ElementNotFoundException Thrown by behat_base::find
363      * @param string $field
364      * @param string $containerelement Element we look in
365      * @param string $containerselectortype The type of selector where we look in
366      * @param string $value
367      */
368     public function the_field_in_container_matches_value($field, $containerelement, $containerselectortype, $value) {
370         // Get the field.
371         $node = $this->get_node_in_container('field', $field, $containerselectortype, $containerelement);
372         $formfield = behat_field_manager::get_form_field($node, $this->getSession());
374         // Checks if the provided value matches the current field value.
375         if (!$formfield->matches($value)) {
376             $fieldvalue = $formfield->get_value();
377             throw new ExpectationException(
378                     'The \'' . $field . '\' value is \'' . $fieldvalue . '\', \'' . $value . '\' expected' ,
379                     $this->getSession()
380             );
381         }
382     }
384     /**
385      * Checks, the field does not match the value.
386      *
387      * @Then /^the field "(?P<field_string>(?:[^"]|\\")*)" in the "(?P<element_container_string>(?:[^"]|\\")*)" "(?P<text_selector_string>[^"]*)" does not match value "(?P<field_value_string>(?:[^"]|\\")*)"$/
388      * @throws ExpectationException
389      * @throws ElementNotFoundException Thrown by behat_base::find
390      * @param string $field
391      * @param string $containerelement Element we look in
392      * @param string $containerselectortype The type of selector where we look in
393      * @param string $value
394      */
395     public function the_field_in_container_does_not_match_value($field, $containerelement, $containerselectortype, $value) {
397         // Get the field.
398         $node = $this->get_node_in_container('field', $field, $containerselectortype, $containerelement);
399         $formfield = behat_field_manager::get_form_field($node, $this->getSession());
401         // Checks if the provided value matches the current field value.
402         if ($formfield->matches($value)) {
403             throw new ExpectationException(
404                     'The \'' . $field . '\' value matches \'' . $value . '\' and it should not match it' ,
405                     $this->getSession()
406             );
407         }
408     }
410     /**
411      * Checks, the field matches the value.
412      *
413      * @Then /^the field with xpath "(?P<xpath_string>(?:[^"]|\\")*)" matches value "(?P<field_value_string>(?:[^"]|\\")*)"$/
414      * @throws ExpectationException
415      * @throws ElementNotFoundException Thrown by behat_base::find
416      * @param string $fieldxpath
417      * @param string $value
418      * @return void
419      */
420     public function the_field_with_xpath_matches_value($fieldxpath, $value) {
422         // Get the field.
423         $fieldnode = $this->find('xpath', $fieldxpath);
424         $formfield = behat_field_manager::get_form_field($fieldnode, $this->getSession());
426         // Checks if the provided value matches the current field value.
427         if (!$formfield->matches($value)) {
428             $fieldvalue = $formfield->get_value();
429             throw new ExpectationException(
430                 'The \'' . $fieldxpath . '\' value is \'' . $fieldvalue . '\', \'' . $value . '\' expected' ,
431                 $this->getSession()
432             );
433         }
434     }
436     /**
437      * Checks, the field does not match the value.
438      *
439      * @Then /^the field with xpath "(?P<xpath_string>(?:[^"]|\\")*)" does not match value "(?P<field_value_string>(?:[^"]|\\")*)"$/
440      * @throws ExpectationException
441      * @throws ElementNotFoundException Thrown by behat_base::find
442      * @param string $fieldxpath
443      * @param string $value
444      * @return void
445      */
446     public function the_field_with_xpath_does_not_match_value($fieldxpath, $value) {
448         // Get the field.
449         $fieldnode = $this->find('xpath', $fieldxpath);
450         $formfield = behat_field_manager::get_form_field($fieldnode, $this->getSession());
452         // Checks if the provided value matches the current field value.
453         if ($formfield->matches($value)) {
454             throw new ExpectationException(
455                 'The \'' . $fieldxpath . '\' value matches \'' . $value . '\' and it should not match it' ,
456                 $this->getSession()
457             );
458         }
459     }
461     /**
462      * Checks, the provided field/value matches.
463      *
464      * @Then /^the following fields match these values:$/
465      * @throws ExpectationException
466      * @param TableNode $data Pairs of | field | value |
467      */
468     public function the_following_fields_match_these_values(TableNode $data) {
470         // Expand all fields in case we have.
471         $this->expand_all_fields();
473         $datahash = $data->getRowsHash();
475         // The action depends on the field type.
476         foreach ($datahash as $locator => $value) {
477             $this->the_field_matches_value($locator, $value);
478         }
479     }
481     /**
482      * Checks that the provided field/value pairs don't match.
483      *
484      * @Then /^the following fields do not match these values:$/
485      * @throws ExpectationException
486      * @param TableNode $data Pairs of | field | value |
487      */
488     public function the_following_fields_do_not_match_these_values(TableNode $data) {
490         // Expand all fields in case we have.
491         $this->expand_all_fields();
493         $datahash = $data->getRowsHash();
495         // The action depends on the field type.
496         foreach ($datahash as $locator => $value) {
497             $this->the_field_does_not_match_value($locator, $value);
498         }
499     }
501     /**
502      * Checks, the provided field/value matches.
503      *
504      * @Then /^the following fields in the "(?P<element_container_string>(?:[^"]|\\")*)" "(?P<text_selector_string>[^"]*)" match these values:$/
505      * @throws ExpectationException
506      * @param string $containerelement Element we look in
507      * @param string $containerselectortype The type of selector where we look in
508      * @param TableNode $data Pairs of | field | value |
509      */
510     public function the_following_fields_in_container_match_these_values(
511             $containerelement, $containerselectortype, TableNode $data) {
513         // Expand all fields in case we have.
514         $this->expand_all_fields();
516         $datahash = $data->getRowsHash();
518         // The action depends on the field type.
519         foreach ($datahash as $locator => $value) {
520             $this->the_field_in_container_matches_value($locator, $containerelement, $containerselectortype, $value);
521         }
522     }
524     /**
525      * Checks that the provided field/value pairs don't match.
526      *
527      * @Then /^the following fields in the "(?P<element_container_string>(?:[^"]|\\")*)" "(?P<text_selector_string>[^"]*)" do not match these values:$/
528      * @throws ExpectationException
529      * @param string $containerelement Element we look in
530      * @param string $containerselectortype The type of selector where we look in
531      * @param TableNode $data Pairs of | field | value |
532      */
533     public function the_following_fields_in_container_do_not_match_these_values(
534             $containerelement, $containerselectortype, TableNode $data) {
536         // Expand all fields in case we have.
537         $this->expand_all_fields();
539         $datahash = $data->getRowsHash();
541         // The action depends on the field type.
542         foreach ($datahash as $locator => $value) {
543             $this->the_field_in_container_does_not_match_value($locator, $containerelement, $containerselectortype, $value);
544         }
545     }
547     /**
548      * Checks, that given select box contains the specified option.
549      *
550      * @Then /^the "(?P<select_string>(?:[^"]|\\")*)" select box should contain "(?P<option_string>(?:[^"]|\\")*)"$/
551      * @throws ExpectationException
552      * @throws ElementNotFoundException Thrown by behat_base::find
553      * @param string $select The select element name
554      * @param string $option The option text/value. Plain value or comma separated
555      *                       values if multiple. Commas in multiple values escaped with backslash.
556      */
557     public function the_select_box_should_contain($select, $option) {
559         $selectnode = $this->find_field($select);
560         $multiple = $selectnode->hasAttribute('multiple');
561         $optionsarr = array(); // Array of passed value/text options to test.
563         if ($multiple) {
564             // Can pass multiple comma separated, with valuable commas escaped with backslash.
565             foreach (preg_replace('/\\\,/', ',',  preg_split('/(?<!\\\),/', $option)) as $opt) {
566                 $optionsarr[] = trim($opt);
567             }
568         } else {
569             // Only one option has been passed.
570             $optionsarr[] = trim($option);
571         }
573         // Now get all the values and texts in the select.
574         $options = $selectnode->findAll('xpath', '//option');
575         $values = array();
576         foreach ($options as $opt) {
577             $values[trim($opt->getValue())] = trim($opt->getText());
578         }
580         foreach ($optionsarr as $opt) {
581             // Verify every option is a valid text or value.
582             if (!in_array($opt, $values) && !array_key_exists($opt, $values)) {
583                 throw new ExpectationException(
584                     'The select box "' . $select . '" does not contain the option "' . $opt . '"',
585                     $this->getSession()
586                 );
587             }
588         }
589     }
591     /**
592      * Checks, that given select box does not contain the specified option.
593      *
594      * @Then /^the "(?P<select_string>(?:[^"]|\\")*)" select box should not contain "(?P<option_string>(?:[^"]|\\")*)"$/
595      * @throws ExpectationException
596      * @throws ElementNotFoundException Thrown by behat_base::find
597      * @param string $select The select element name
598      * @param string $option The option text/value. Plain value or comma separated
599      *                       values if multiple. Commas in multiple values escaped with backslash.
600      */
601     public function the_select_box_should_not_contain($select, $option) {
603         $selectnode = $this->find_field($select);
604         $multiple = $selectnode->hasAttribute('multiple');
605         $optionsarr = array(); // Array of passed value/text options to test.
607         if ($multiple) {
608             // Can pass multiple comma separated, with valuable commas escaped with backslash.
609             foreach (preg_replace('/\\\,/', ',',  preg_split('/(?<!\\\),/', $option)) as $opt) {
610                 $optionsarr[] = trim($opt);
611             }
612         } else {
613             // Only one option has been passed.
614             $optionsarr[] = trim($option);
615         }
617         // Now get all the values and texts in the select.
618         $options = $selectnode->findAll('xpath', '//option');
619         $values = array();
620         foreach ($options as $opt) {
621             $values[trim($opt->getValue())] = trim($opt->getText());
622         }
624         foreach ($optionsarr as $opt) {
625             // Verify every option is not a valid text or value.
626             if (in_array($opt, $values) || array_key_exists($opt, $values)) {
627                 throw new ExpectationException(
628                     'The select box "' . $select . '" contains the option "' . $opt . '"',
629                     $this->getSession()
630                 );
631             }
632         }
633     }
635     /**
636      * Generic field setter.
637      *
638      * Internal API method, a generic *I set "VALUE" to "FIELD" field*
639      * could be created based on it.
640      *
641      * @param string $fieldlocator The pointer to the field, it will depend on the field type.
642      * @param string $value
643      * @return void
644      */
645     protected function set_field_value($fieldlocator, $value) {
646         // We delegate to behat_form_field class, it will
647         // guess the type properly as it is a select tag.
648         $field = behat_field_manager::get_form_field_from_label($fieldlocator, $this);
649         $field->set_value($value);
650     }
652     /**
653      * Generic field setter to be used by chainable steps.
654      *
655      * @param NodeElement $fieldnode
656      * @param string $value
657      */
658     public function set_field_node_value(NodeElement $fieldnode, string $value): void {
659         $this->ensure_node_is_visible($fieldnode);
660         $field = behat_field_manager::get_form_field($fieldnode, $this->getSession());
661         $field->set_value($value);
662     }
664     /**
665      * Generic field setter.
666      *
667      * Internal API method, a generic *I set "VALUE" to "FIELD" field*
668      * could be created based on it.
669      *
670      * @param string $fieldlocator The pointer to the field, it will depend on the field type.
671      * @param string $value the value to set
672      * @param string $containerselectortype The type of selector where we look in
673      * @param string $containerelement Element we look in
674      */
675     protected function set_field_value_in_container($fieldlocator, $value, $containerselectortype, $containerelement) {
676         $node = $this->get_node_in_container('field', $fieldlocator, $containerselectortype, $containerelement);
677         $this->set_field_node_value($node, $value);
678     }
680     /**
681      * Select a value from single select and redirect.
682      *
683      * @Given /^I select "(?P<singleselect_option_string>(?:[^"]|\\")*)" from the "(?P<singleselect_name_string>(?:[^"]|\\")*)" singleselect$/
684      */
685     public function i_select_from_the_singleselect($option, $singleselect) {
687         $this->execute('behat_forms::i_set_the_field_to', array($this->escape($singleselect), $this->escape($option)));
689         if (!$this->running_javascript()) {
690             // Press button in the specified select container.
691             $containerxpath = "//div[" .
692                 "(contains(concat(' ', normalize-space(@class), ' '), ' singleselect ') " .
693                     "or contains(concat(' ', normalize-space(@class), ' '), ' urlselect ')".
694                 ") and (
695                 .//label[contains(normalize-space(string(.)), '" . $singleselect . "')] " .
696                     "or .//select[(./@name='" . $singleselect . "' or ./@id='". $singleselect . "')]" .
697                 ")]";
699             $this->execute('behat_general::i_click_on_in_the',
700                 array(get_string('go'), "button", $containerxpath, "xpath_element")
701             );
702         }
703     }
705     /**
706      * Select item from autocomplete list.
707      *
708      * @Given /^I click on "([^"]*)" item in the autocomplete list$/
709      *
710      * @param string $item
711      */
712     public function i_click_on_item_in_the_autocomplete_list($item) {
713         $xpathtarget = "//ul[@class='form-autocomplete-suggestions']//*[contains(concat('|', string(.), '|'),'|" . $item . "|')]";
715         $this->execute('behat_general::i_click_on', [$xpathtarget, 'xpath_element']);
717         $this->execute('behat_general::i_press_key_in_element', ['13', 'body', 'xpath_element']);
718     }
720     /**
721      * Open the auto-complete suggestions list (Assuming there is only one on the page.).
722      *
723      * @Given /^I open the autocomplete suggestions list$/
724      */
725     public function i_open_the_autocomplete_suggestions_list() {
726         $csstarget = ".form-autocomplete-downarrow";
727         $this->execute('behat_general::i_click_on', [$csstarget, 'css_element']);
728     }
730     /**
731      * Expand the given autocomplete list
732      *
733      * @Given /^I expand the "(?P<field_string>(?:[^"]|\\")*)" autocomplete$/
734      *
735      * @param string $field Field name
736      */
737     public function i_expand_the_autocomplete($field) {
738         $csstarget = '.form-autocomplete-downarrow';
739         $node = $this->get_node_in_container('css_element', $csstarget, 'form_row', $field);
740         $this->ensure_node_is_visible($node);
741         $node->click();
742     }
744     /**
745      * Assert the given option exist in the given autocomplete list
746      *
747      * @Given /^I should see "(?P<option_string>(?:[^"]|\\")*)" in the list of options for the "(?P<field_string>(?:[^"]|\\")*)" autocomplete$$/
748      *
749      * @param string $option Name of option
750      * @param string $field Field name
751      */
752     public function i_should_see_in_the_list_of_option_for_the_autocomplete($option, $field) {
753         $xpathtarget = "//div[contains(@class, 'form-autocomplete-selection') and contains(.//div, '" . $option . "')]";
754         $node = $this->get_node_in_container('xpath_element', $xpathtarget, 'form_row', $field);
755         $this->ensure_node_is_visible($node);
756     }