aee4b4ad02d0e3250ba0ccedb471643e280fd26e
[moodle.git] / lib / behat / form_field / behat_form_field.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  * Generic moodleforms field.
19  *
20  * @package    core_form
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 use Behat\Mink\Session as Session,
29     Behat\Mink\Element\NodeElement as NodeElement;
31 /**
32  * Representation of a form field.
33  *
34  * Basically an interface with Mink session.
35  *
36  * @package    core_form
37  * @category   test
38  * @copyright  2012 David MonllaĆ³
39  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
40  */
41 class behat_form_field {
43     /**
44      * @var Session Behat session.
45      */
46     protected $session;
48     /**
49      * @var NodeElement The field DOM node to interact with.
50      */
51     protected $field;
53     /**
54      * @var string The field's locator.
55      */
56     protected $fieldlocator = false;
59     /**
60      * General constructor with the node and the session to interact with.
61      *
62      * @param Session $session Reference to Mink session to traverse/modify the page DOM.
63      * @param NodeElement $fieldnode The field DOM node
64      * @return void
65      */
66     public function __construct(Session $session, NodeElement $fieldnode) {
67         $this->session = $session;
68         $this->field = $fieldnode;
69     }
71     /**
72      * Sets the value to a field.
73      *
74      * @param string $value
75      * @return void
76      */
77     public function set_value($value) {
78         // We delegate to the best guess, if we arrived here
79         // using the generic behat_form_field is because we are
80         // dealing with a fgroup element.
81         $instance = $this->guess_type();
82         return $instance->set_value($value);
83     }
85     /**
86      * Returns the current value of the select element.
87      *
88      * @return string
89      */
90     public function get_value() {
91         // We delegate to the best guess, if we arrived here
92         // using the generic behat_form_field is because we are
93         // dealing with a fgroup element.
94         $instance = $this->guess_type();
95         return $instance->get_value();
96     }
98     /**
99      * Presses specific keyboard key.
100      *
101      * @param mixed  $char     could be either char ('b') or char-code (98)
102      * @param string $modifier keyboard modifier (could be 'ctrl', 'alt', 'shift' or 'meta')
103      */
104     public function key_press($char, $modifier = null) {
105         // We delegate to the best guess, if we arrived here
106         // using the generic behat_form_field is because we are
107         // dealing with a fgroup element.
108         $instance = $this->guess_type();
109         return $instance->field->keyPress($char, $modifier);
110     }
112     /**
113      * Generic match implementation
114      *
115      * Will work well with text-based fields, extension required
116      * for most of the other cases.
117      *
118      * @param string $expectedvalue
119      * @return bool The provided value matches the field value?
120      */
121     public function matches($expectedvalue) {
122         // We delegate to the best guess, if we arrived here
123         // using the generic behat_form_field is because we are
124         // dealing with a fgroup element.
125         $instance = $this->guess_type();
126         return $instance->matches($expectedvalue);
127     }
129     /**
130      * Guesses the element type we are dealing with in case is not a text-based element.
131      *
132      * This class is the generic field type, behat_field_manager::get_form_field()
133      * should be able to find the appropiate class for the field type, but
134      * in cases like moodle form group elements we can not find the type of
135      * the field through the DOM so we also need to take care of the
136      * different field types from here. If we need to deal with more complex
137      * moodle form elements we will need to refactor this simple HTML elements
138      * guess method.
139      *
140      * @return behat_form_field
141      */
142     private function guess_type() {
143         global $CFG;
145         // We default to the text-based field if nothing was detected.
146         if (!$type = behat_field_manager::guess_field_type($this->field, $this->session)) {
147             $type = 'text';
148         }
150         $classname = 'behat_form_' . $type;
151         $classpath = $CFG->dirroot . '/lib/behat/form_field/' . $classname . '.php';
152         require_once($classpath);
153         return new $classname($this->session, $this->field);
154     }
156     /**
157      * Returns whether the scenario is running in a browser that can run Javascript or not.
158      *
159      * @return bool
160      */
161     protected function running_javascript() {
162         return get_class($this->session->getDriver()) !== 'Behat\Mink\Driver\GoutteDriver';
163     }
165     /**
166      * Gets the field internal id used by selenium wire protocol.
167      *
168      * Only available when running_javascript().
169      *
170      * @throws coding_exception
171      * @return int
172      */
173     protected function get_internal_field_id() {
175         if (!$this->running_javascript()) {
176             throw new coding_exception('You can only get an internal ID using the selenium driver.');
177         }
179         return $this->session->getDriver()->getWebDriverSession()->element('xpath', $this->field->getXPath())->getID();
180     }
182     /**
183      * Checks if the provided text matches the field value.
184      *
185      * @param string $expectedvalue
186      * @return bool
187      */
188     protected function text_matches($expectedvalue) {
189         if (trim($expectedvalue) != trim($this->get_value())) {
190             return false;
191         }
192         return true;
193     }
195     /**
196      * Gets the field locator.
197      *
198      * Defaults to the field label but you can
199      * specify other locators if you are interested.
200      *
201      * Public visibility as in most cases will be hard to
202      * use this method in a generic way, as fields can
203      * be selected using multiple ways (label, id, name...).
204      *
205      * @throws coding_exception
206      * @param string $locatortype
207      * @return string
208      */
209     protected function get_field_locator($locatortype = false) {
211         if (!empty($this->fieldlocator)) {
212             return $this->fieldlocator;
213         }
215         $fieldid = $this->field->getAttribute('id');
217         // Defaults to label.
218         if ($locatortype == 'label' || $locatortype == false) {
220             $labelnode = $this->session->getPage()->find('xpath', '//label[@for="' . $fieldid . '"]');
222             // Exception only if $locatortype was specified.
223             if (!$labelnode && $locatortype == 'label') {
224                 throw new coding_exception('Field with "' . $fieldid . '" id does not have a label.');
225             }
227             $this->fieldlocator = $labelnode->getText();
228         }
230         // Let's look for the name as a second option (more popular than
231         // id's when pointing to fields).
232         if (($locatortype == 'name' || $locatortype == false) &&
233                 empty($this->fieldlocator)) {
235             $name = $this->field->getAttribute('name');
237             // Exception only if $locatortype was specified.
238             if (!$name && $locatortype == 'name') {
239                 throw new coding_exception('Field with "' . $fieldid . '" id does not have a name attribute.');
240             }
242             $this->fieldlocator = $name;
243         }
245         // Otherwise returns the id if no specific locator type was provided.
246         if (empty($this->fieldlocator)) {
247             $this->fieldlocator = $fieldid;
248         }
250         return $this->fieldlocator;
251     }