d81686e081ba1fb5041ee1a55fc6fd3aabf30195
[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  * Note, Behat tests to verify that the steps defined here work as advertised
40  * are kept in admin/tool/behat/tests/behat.
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) {
57         $this->execute('behat_general::i_click_on', [$button, 'button']);
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.
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      * Fills a form with field/value data.
98      *
99      * @Given /^I set the following fields in the "(?P<element_container_string>(?:[^"]|\\")*)" "(?P<text_selector_string>[^"]*)" to these values:$/
100      * @throws ElementNotFoundException Thrown by behat_base::find
101      * @param string $containerelement Element we look in
102      * @param string $containerselectortype The type of selector where we look in
103      * @param TableNode $data
104      */
105     public function i_set_the_following_fields_in_container_to_these_values(
106             $containerelement, $containerselectortype, TableNode $data) {
108         // Expand all fields in case we have.
109         $this->expand_all_fields();
111         $datahash = $data->getRowsHash();
113         // The action depends on the field type.
114         foreach ($datahash as $locator => $value) {
115             $this->set_field_value_in_container($locator, $value, $containerselectortype, $containerelement);
116         }
117     }
119     /**
120      * Expands all moodleform's fields, including collapsed fieldsets and advanced fields if they are present.
121      * @Given /^I expand all fieldsets$/
122      */
123     public function i_expand_all_fieldsets() {
124         $this->expand_all_fields();
125     }
127     /**
128      * Expands all moodle form fieldsets if they exists.
129      *
130      * Externalized from i_expand_all_fields to call it from
131      * other form-related steps without having to use steps-group calls.
132      *
133      * @throws ElementNotFoundException Thrown by behat_base::find_all
134      * @return void
135      */
136     protected function expand_all_fields() {
137         // Expand only if JS mode, else not needed.
138         if (!$this->running_javascript()) {
139             return;
140         }
142         // We already know that we waited for the DOM and the JS to be loaded, even the editor
143         // so, we will use the reduced timeout as it is a common task and we should save time.
144         try {
146             // Expand all fieldsets link - which will only be there if there is more than one collapsible section.
147             $expandallxpath = "//div[@class='collapsible-actions']" .
148                 "//a[contains(concat(' ', @class, ' '), ' collapseexpand ')]" .
149                 "[not(contains(concat(' ', @class, ' '), ' collapse-all '))]";
150             // Else, look for the first expand fieldset link.
151             $expandonlysection = "//legend[@class='ftoggler']" .
152                     "//a[contains(concat(' ', @class, ' '), ' fheader ') and @aria-expanded = 'false']";
154             $collapseexpandlink = $this->find('xpath', $expandallxpath . '|' . $expandonlysection,
155                     false, false, behat_base::get_reduced_timeout());
156             $collapseexpandlink->click();
158         } catch (ElementNotFoundException $e) {
159             // The behat_base::find() method throws an exception if there are no elements,
160             // we should not fail a test because of this. We continue if there are not expandable fields.
161         }
163         // Different try & catch as we can have expanded fieldsets with advanced fields on them.
164         try {
166             // Expand all fields xpath.
167             $showmorexpath = "//a[normalize-space(.)='" . get_string('showmore', 'form') . "']" .
168                 "[contains(concat(' ', normalize-space(@class), ' '), ' moreless-toggler')]";
170             // We don't wait here as we already waited when getting the expand fieldsets links.
171             if (!$showmores = $this->getSession()->getPage()->findAll('xpath', $showmorexpath)) {
172                 return;
173             }
175             if ($this->getSession()->getDriver() instanceof \DMore\ChromeDriver\ChromeDriver) {
176                 // Chrome Driver produces unique xpaths for each element.
177                 foreach ($showmores as $showmore) {
178                     $showmore->click();
179                 }
180             } else {
181                 // Funny thing about this, with findAll() we specify a pattern and each element matching the pattern
182                 // is added to the array with of xpaths with a [0], [1]... sufix, but when we click on an element it
183                 // does not matches the specified xpath anymore (now is a "Show less..." link) so [1] becomes [0],
184                 // that's why we always click on the first XPath match, will be always the next one.
185                 $iterations = count($showmores);
186                 for ($i = 0; $i < $iterations; $i++) {
187                     $showmores[0]->click();
188                 }
189             }
191         } catch (ElementNotFoundException $e) {
192             // We continue with the test.
193         }
195     }
197     /**
198      * Sets the field to wwwroot plus the given path. Include the first slash.
199      *
200      * @Given /^I set the field "(?P<field_string>(?:[^"]|\\")*)" to local url "(?P<field_path_string>(?:[^"]|\\")*)"$/
201      * @throws ElementNotFoundException Thrown by behat_base::find
202      * @param string $field
203      * @param string $path
204      * @return void
205      */
206     public function i_set_the_field_to_local_url($field, $path) {
207         global $CFG;
208         $this->set_field_value($field, $CFG->wwwroot . $path);
209     }
211     /**
212      * Sets the specified value to the field.
213      *
214      * @Given /^I set the field "(?P<field_string>(?:[^"]|\\")*)" to "(?P<field_value_string>(?:[^"]|\\")*)"$/
215      * @throws ElementNotFoundException Thrown by behat_base::find
216      * @param string $field
217      * @param string $value
218      * @return void
219      */
220     public function i_set_the_field_to($field, $value) {
221         $this->set_field_value($field, $value);
222     }
224     /**
225      * Sets the specified value to the field.
226      *
227      * @Given /^I set the field "(?P<field_string>(?:[^"]|\\")*)" in the "(?P<element_container_string>(?:[^"]|\\")*)" "(?P<text_selector_string>[^"]*)" to "(?P<field_value_string>(?:[^"]|\\")*)"$/
228      * @throws ElementNotFoundException Thrown by behat_base::find
229      * @param string $field
230      * @param string $containerelement Element we look in
231      * @param string $containerselectortype The type of selector where we look in
232      * @param string $value
233      */
234     public function i_set_the_field_in_container_to($field, $containerelement, $containerselectortype, $value) {
235         $this->set_field_value_in_container($field, $value, $containerselectortype, $containerelement);
236     }
238     /**
239      * Press the key in the field to trigger the javascript keypress event
240      *
241      * Note that the character key will not actually be typed in the input field
242      *
243      * @Given /^I press key "(?P<key_string>(?:[^"]|\\")*)" in the field "(?P<field_string>(?:[^"]|\\")*)"$/
244      * @throws ElementNotFoundException Thrown by behat_base::find
245      * @param string $key either char-code or character itself,
246      *          may optionally be prefixed with ctrl-, alt-, shift- or meta-
247      * @param string $field
248      * @return void
249      */
250     public function i_press_key_in_the_field($key, $field) {
251         if (!$this->running_javascript()) {
252             throw new DriverException('Key press step is not available with Javascript disabled');
253         }
254         $fld = behat_field_manager::get_form_field_from_label($field, $this);
255         $modifier = null;
256         $char = $key;
257         if (preg_match('/-/', $key)) {
258             list($modifier, $char) = preg_split('/-/', $key, 2);
259         }
260         if (is_numeric($char)) {
261             $char = (int)$char;
262         }
263         $fld->key_press($char, $modifier);
264     }
266     /**
267      * Sets the specified value to the field.
268      *
269      * @Given /^I set the field "(?P<field_string>(?:[^"]|\\")*)" to multiline:$/
270      * @throws ElementNotFoundException Thrown by behat_base::find
271      * @param string $field
272      * @param PyStringNode $value
273      * @return void
274      */
275     public function i_set_the_field_to_multiline($field, PyStringNode $value) {
276         $this->set_field_value($field, (string)$value);
277     }
279     /**
280      * Sets the specified value to the field with xpath.
281      *
282      * @Given /^I set the field with xpath "(?P<fieldxpath_string>(?:[^"]|\\")*)" to "(?P<field_value_string>(?:[^"]|\\")*)"$/
283      * @throws ElementNotFoundException Thrown by behat_base::find
284      * @param string $field
285      * @param string $value
286      * @return void
287      */
288     public function i_set_the_field_with_xpath_to($fieldxpath, $value) {
289         $fieldnode = $this->find('xpath', $fieldxpath);
290         $this->ensure_node_is_visible($fieldnode);
291         $field = behat_field_manager::get_form_field($fieldnode, $this->getSession());
292         $field->set_value($value);
293     }
295     /**
296      * Checks, the field matches the value.
297      *
298      * @Then /^the field "(?P<field_string>(?:[^"]|\\")*)" matches value "(?P<field_value_string>(?:[^"]|\\")*)"$/
299      * @throws ElementNotFoundException Thrown by behat_base::find
300      * @param string $field
301      * @param string $value
302      * @return void
303      */
304     public function the_field_matches_value($field, $value) {
306         // Get the field.
307         $formfield = behat_field_manager::get_form_field_from_label($field, $this);
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 \'' . $field . '\' 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 "(?P<field_string>(?:[^"]|\\")*)" does not match value "(?P<field_value_string>(?:[^"]|\\")*)"$/
323      * @throws ExpectationException
324      * @throws ElementNotFoundException Thrown by behat_base::find
325      * @param string $field
326      * @param string $value
327      */
328     public function the_field_does_not_match_value($field, $value) {
330         // Get the field.
331         $formfield = behat_field_manager::get_form_field_from_label($field, $this);
333         // Checks if the provided value matches the current field value.
334         if ($formfield->matches($value)) {
335             throw new ExpectationException(
336                 'The \'' . $field . '\' value matches \'' . $value . '\' and it should not match it' ,
337                 $this->getSession()
338             );
339         }
340     }
342     /**
343      * Checks, the field matches the value.
344      *
345      * @Then /^the field "(?P<field_string>(?:[^"]|\\")*)" in the "(?P<element_container_string>(?:[^"]|\\")*)" "(?P<text_selector_string>[^"]*)" matches value "(?P<field_value_string>(?:[^"]|\\")*)"$/
346      * @throws ElementNotFoundException Thrown by behat_base::find
347      * @param string $field
348      * @param string $containerelement Element we look in
349      * @param string $containerselectortype The type of selector where we look in
350      * @param string $value
351      */
352     public function the_field_in_container_matches_value($field, $containerelement, $containerselectortype, $value) {
354         // Get the field.
355         $node = $this->get_node_in_container('field', $field, $containerselectortype, $containerelement);
356         $formfield = behat_field_manager::get_form_field($node, $this->getSession());
358         // Checks if the provided value matches the current field value.
359         if (!$formfield->matches($value)) {
360             $fieldvalue = $formfield->get_value();
361             throw new ExpectationException(
362                     'The \'' . $field . '\' value is \'' . $fieldvalue . '\', \'' . $value . '\' expected' ,
363                     $this->getSession()
364             );
365         }
366     }
368     /**
369      * Checks, the field does not match the value.
370      *
371      * @Then /^the field "(?P<field_string>(?:[^"]|\\")*)" in the "(?P<element_container_string>(?:[^"]|\\")*)" "(?P<text_selector_string>[^"]*)" does not match value "(?P<field_value_string>(?:[^"]|\\")*)"$/
372      * @throws ExpectationException
373      * @throws ElementNotFoundException Thrown by behat_base::find
374      * @param string $field
375      * @param string $containerelement Element we look in
376      * @param string $containerselectortype The type of selector where we look in
377      * @param string $value
378      */
379     public function the_field_in_container_does_not_match_value($field, $containerelement, $containerselectortype, $value) {
381         // Get the field.
382         $node = $this->get_node_in_container('field', $field, $containerselectortype, $containerelement);
383         $formfield = behat_field_manager::get_form_field($node, $this->getSession());
385         // Checks if the provided value matches the current field value.
386         if ($formfield->matches($value)) {
387             throw new ExpectationException(
388                     'The \'' . $field . '\' value matches \'' . $value . '\' and it should not match it' ,
389                     $this->getSession()
390             );
391         }
392     }
394     /**
395      * Checks, the field matches the value.
396      *
397      * @Then /^the field with xpath "(?P<xpath_string>(?:[^"]|\\")*)" matches value "(?P<field_value_string>(?:[^"]|\\")*)"$/
398      * @throws ExpectationException
399      * @throws ElementNotFoundException Thrown by behat_base::find
400      * @param string $fieldxpath
401      * @param string $value
402      * @return void
403      */
404     public function the_field_with_xpath_matches_value($fieldxpath, $value) {
406         // Get the field.
407         $fieldnode = $this->find('xpath', $fieldxpath);
408         $formfield = behat_field_manager::get_form_field($fieldnode, $this->getSession());
410         // Checks if the provided value matches the current field value.
411         if (!$formfield->matches($value)) {
412             $fieldvalue = $formfield->get_value();
413             throw new ExpectationException(
414                 'The \'' . $fieldxpath . '\' value is \'' . $fieldvalue . '\', \'' . $value . '\' expected' ,
415                 $this->getSession()
416             );
417         }
418     }
420     /**
421      * Checks, the field does not match the value.
422      *
423      * @Then /^the field with xpath "(?P<xpath_string>(?:[^"]|\\")*)" does not match value "(?P<field_value_string>(?:[^"]|\\")*)"$/
424      * @throws ExpectationException
425      * @throws ElementNotFoundException Thrown by behat_base::find
426      * @param string $fieldxpath
427      * @param string $value
428      * @return void
429      */
430     public function the_field_with_xpath_does_not_match_value($fieldxpath, $value) {
432         // Get the field.
433         $fieldnode = $this->find('xpath', $fieldxpath);
434         $formfield = behat_field_manager::get_form_field($fieldnode, $this->getSession());
436         // Checks if the provided value matches the current field value.
437         if ($formfield->matches($value)) {
438             throw new ExpectationException(
439                 'The \'' . $fieldxpath . '\' value matches \'' . $value . '\' and it should not match it' ,
440                 $this->getSession()
441             );
442         }
443     }
445     /**
446      * Checks, the provided field/value matches.
447      *
448      * @Then /^the following fields match these values:$/
449      * @throws ExpectationException
450      * @param TableNode $data Pairs of | field | value |
451      */
452     public function the_following_fields_match_these_values(TableNode $data) {
454         // Expand all fields in case we have.
455         $this->expand_all_fields();
457         $datahash = $data->getRowsHash();
459         // The action depends on the field type.
460         foreach ($datahash as $locator => $value) {
461             $this->the_field_matches_value($locator, $value);
462         }
463     }
465     /**
466      * Checks that the provided field/value pairs don't match.
467      *
468      * @Then /^the following fields do not match these values:$/
469      * @throws ExpectationException
470      * @param TableNode $data Pairs of | field | value |
471      */
472     public function the_following_fields_do_not_match_these_values(TableNode $data) {
474         // Expand all fields in case we have.
475         $this->expand_all_fields();
477         $datahash = $data->getRowsHash();
479         // The action depends on the field type.
480         foreach ($datahash as $locator => $value) {
481             $this->the_field_does_not_match_value($locator, $value);
482         }
483     }
485     /**
486      * Checks, the provided field/value matches.
487      *
488      * @Then /^the following fields in the "(?P<element_container_string>(?:[^"]|\\")*)" "(?P<text_selector_string>[^"]*)" match these values:$/
489      * @throws ExpectationException
490      * @param string $containerelement Element we look in
491      * @param string $containerselectortype The type of selector where we look in
492      * @param TableNode $data Pairs of | field | value |
493      */
494     public function the_following_fields_in_container_match_these_values(
495             $containerelement, $containerselectortype, TableNode $data) {
497         // Expand all fields in case we have.
498         $this->expand_all_fields();
500         $datahash = $data->getRowsHash();
502         // The action depends on the field type.
503         foreach ($datahash as $locator => $value) {
504             $this->the_field_in_container_matches_value($locator, $containerelement, $containerselectortype, $value);
505         }
506     }
508     /**
509      * Checks that the provided field/value pairs don't match.
510      *
511      * @Then /^the following fields in the "(?P<element_container_string>(?:[^"]|\\")*)" "(?P<text_selector_string>[^"]*)" do not match these values:$/
512      * @throws ExpectationException
513      * @param string $containerelement Element we look in
514      * @param string $containerselectortype The type of selector where we look in
515      * @param TableNode $data Pairs of | field | value |
516      */
517     public function the_following_fields_in_container_do_not_match_these_values(
518             $containerelement, $containerselectortype, TableNode $data) {
520         // Expand all fields in case we have.
521         $this->expand_all_fields();
523         $datahash = $data->getRowsHash();
525         // The action depends on the field type.
526         foreach ($datahash as $locator => $value) {
527             $this->the_field_in_container_does_not_match_value($locator, $containerelement, $containerselectortype, $value);
528         }
529     }
531     /**
532      * Checks, that given select box contains the specified option.
533      *
534      * @Then /^the "(?P<select_string>(?:[^"]|\\")*)" select box should contain "(?P<option_string>(?:[^"]|\\")*)"$/
535      * @throws ExpectationException
536      * @throws ElementNotFoundException Thrown by behat_base::find
537      * @param string $select The select element name
538      * @param string $option The option text/value. Plain value or comma separated
539      *                       values if multiple. Commas in multiple values escaped with backslash.
540      */
541     public function the_select_box_should_contain($select, $option) {
543         $selectnode = $this->find_field($select);
544         $multiple = $selectnode->hasAttribute('multiple');
545         $optionsarr = array(); // Array of passed value/text options to test.
547         if ($multiple) {
548             // Can pass multiple comma separated, with valuable commas escaped with backslash.
549             foreach (preg_replace('/\\\,/', ',',  preg_split('/(?<!\\\),/', $option)) as $opt) {
550                 $optionsarr[] = trim($opt);
551             }
552         } else {
553             // Only one option has been passed.
554             $optionsarr[] = trim($option);
555         }
557         // Now get all the values and texts in the select.
558         $options = $selectnode->findAll('xpath', '//option');
559         $values = array();
560         foreach ($options as $opt) {
561             $values[trim($opt->getValue())] = trim($opt->getText());
562         }
564         foreach ($optionsarr as $opt) {
565             // Verify every option is a valid text or value.
566             if (!in_array($opt, $values) && !array_key_exists($opt, $values)) {
567                 throw new ExpectationException(
568                     'The select box "' . $select . '" does not contain the option "' . $opt . '"',
569                     $this->getSession()
570                 );
571             }
572         }
573     }
575     /**
576      * Checks, that given select box does not contain the specified option.
577      *
578      * @Then /^the "(?P<select_string>(?:[^"]|\\")*)" select box should not contain "(?P<option_string>(?:[^"]|\\")*)"$/
579      * @throws ExpectationException
580      * @throws ElementNotFoundException Thrown by behat_base::find
581      * @param string $select The select element name
582      * @param string $option The option text/value. Plain value or comma separated
583      *                       values if multiple. Commas in multiple values escaped with backslash.
584      */
585     public function the_select_box_should_not_contain($select, $option) {
587         $selectnode = $this->find_field($select);
588         $multiple = $selectnode->hasAttribute('multiple');
589         $optionsarr = array(); // Array of passed value/text options to test.
591         if ($multiple) {
592             // Can pass multiple comma separated, with valuable commas escaped with backslash.
593             foreach (preg_replace('/\\\,/', ',',  preg_split('/(?<!\\\),/', $option)) as $opt) {
594                 $optionsarr[] = trim($opt);
595             }
596         } else {
597             // Only one option has been passed.
598             $optionsarr[] = trim($option);
599         }
601         // Now get all the values and texts in the select.
602         $options = $selectnode->findAll('xpath', '//option');
603         $values = array();
604         foreach ($options as $opt) {
605             $values[trim($opt->getValue())] = trim($opt->getText());
606         }
608         foreach ($optionsarr as $opt) {
609             // Verify every option is not a valid text or value.
610             if (in_array($opt, $values) || array_key_exists($opt, $values)) {
611                 throw new ExpectationException(
612                     'The select box "' . $select . '" contains the option "' . $opt . '"',
613                     $this->getSession()
614                 );
615             }
616         }
617     }
619     /**
620      * Generic field setter.
621      *
622      * Internal API method, a generic *I set "VALUE" to "FIELD" field*
623      * could be created based on it.
624      *
625      * @param string $fieldlocator The pointer to the field, it will depend on the field type.
626      * @param string $value
627      * @return void
628      */
629     protected function set_field_value($fieldlocator, $value) {
631         // We delegate to behat_form_field class, it will
632         // guess the type properly as it is a select tag.
633         $field = behat_field_manager::get_form_field_from_label($fieldlocator, $this);
634         $field->set_value($value);
635     }
637     /**
638      * Generic field setter.
639      *
640      * Internal API method, a generic *I set "VALUE" to "FIELD" field*
641      * could be created based on it.
642      *
643      * @param string $fieldlocator The pointer to the field, it will depend on the field type.
644      * @param string $value the value to set
645      * @param string $containerselectortype The type of selector where we look in
646      * @param string $containerelement Element we look in
647      */
648     protected function set_field_value_in_container($fieldlocator, $value, $containerselectortype, $containerelement) {
650         $node = $this->get_node_in_container('field', $fieldlocator, $containerselectortype, $containerelement);
651         // We delegate to behat_form_field class, it will
652         // guess the type properly as it is a select tag.
653         $field = behat_field_manager::get_form_field($node, $this->getSession());
654         $field->set_value($value);
655     }
657     /**
658      * Select a value from single select and redirect.
659      *
660      * @Given /^I select "(?P<singleselect_option_string>(?:[^"]|\\")*)" from the "(?P<singleselect_name_string>(?:[^"]|\\")*)" singleselect$/
661      */
662     public function i_select_from_the_singleselect($option, $singleselect) {
664         $this->execute('behat_forms::i_set_the_field_to', array($this->escape($singleselect), $this->escape($option)));
666         if (!$this->running_javascript()) {
667             // Press button in the specified select container.
668             $containerxpath = "//div[" .
669                 "(contains(concat(' ', normalize-space(@class), ' '), ' singleselect ') " .
670                     "or contains(concat(' ', normalize-space(@class), ' '), ' urlselect ')".
671                 ") and (
672                 .//label[contains(normalize-space(string(.)), '" . $singleselect . "')] " .
673                     "or .//select[(./@name='" . $singleselect . "' or ./@id='". $singleselect . "')]" .
674                 ")]";
676             $this->execute('behat_general::i_click_on_in_the',
677                 array(get_string('go'), "button", $containerxpath, "xpath_element")
678             );
679         }
680     }
682     /**
683      * Select item from autocomplete list.
684      *
685      * @Given /^I click on "([^"]*)" item in the autocomplete list$/
686      *
687      * @param string $item
688      */
689     public function i_click_on_item_in_the_autocomplete_list($item) {
690         $xpathtarget = "//ul[@class='form-autocomplete-suggestions']//*[contains(concat('|', string(.), '|'),'|" . $item . "|')]";
692         $this->execute('behat_general::i_click_on', [$xpathtarget, 'xpath_element']);
694         $this->execute('behat_general::i_press_key_in_element', ['13', 'body', 'xpath_element']);
695     }
697     /**
698      * Open the auto-complete suggestions list (Assuming there is only one on the page.).
699      *
700      * @Given /^I open the autocomplete suggestions list$/
701      */
702     public function i_open_the_autocomplete_suggestions_list() {
703         $csstarget = ".form-autocomplete-downarrow";
704         $this->execute('behat_general::i_click_on', [$csstarget, 'css_element']);
705     }
707     /**
708      * Expand the given autocomplete list
709      *
710      * @Given /^I expand the "(?P<field_string>(?:[^"]|\\")*)" autocomplete$/
711      *
712      * @param string $field Field name
713      */
714     public function i_expand_the_autocomplete($field) {
715         $csstarget = '.form-autocomplete-downarrow';
716         $node = $this->get_node_in_container('css_element', $csstarget, 'form_row', $field);
717         $this->ensure_node_is_visible($node);
718         $node->click();
719     }
721     /**
722      * Assert the given option exist in the given autocomplete list
723      *
724      * @Given /^I should see "(?P<option_string>(?:[^"]|\\")*)" in the list of options for the "(?P<field_string>(?:[^"]|\\")*)" autocomplete$$/
725      *
726      * @param string $option Name of option
727      * @param string $field Field name
728      */
729     public function i_should_see_in_the_list_of_option_for_the_autocomplete($option, $field) {
730         $xpathtarget = "//div[contains(@class, 'form-autocomplete-selection') and contains(.//div, '" . $option . "')]";
731         $node = $this->get_node_in_container('xpath_element', $xpathtarget, 'form_row', $field);
732         $this->ensure_node_is_visible($node);
733     }