MDL-40566 behat: Adding behat_selectors
[moodle.git] / lib / behat / classes / behat_selectors.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  * Moodle-specific selectors.
19  *
20  * @package    core
21  * @category   test
22  * @copyright  2013 David MonllaĆ³
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 defined('MOODLE_INTERNAL') || die();
28 /**
29  * Moodle selectors manager.
30  *
31  * @package    core
32  * @category   test
33  * @copyright  2013 David MonllaĆ³
34  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
35  */
36 class behat_selectors {
38     /**
39      * @var Allowed types when using text selectors arguments.
40      */
41     protected static $allowedtextselectors = array(
42         'dialogue' => 'dialogue',
43         'block' => 'block',
44         'region' => 'region',
45         'table_row' => 'table_row',
46         'table' => 'table',
47         'fieldset' => 'fieldset',
48         'css_element' => 'css_element',
49         'xpath_element' => 'xpath_element'
50     );
52     /**
53      * @var Allowed types when using selector arguments.
54      */
55     protected static $allowedselectors = array(
56         'dialogue' => 'dialogue',
57         'block' => 'block',
58         'region' => 'region',
59         'table_row' => 'table_row',
60         'link' => 'link',
61         'button' => 'button',
62         'link_or_button' => 'link_or_button',
63         'select' => 'select',
64         'checkbox' => 'checkbox',
65         'radio' => 'radio',
66         'file' => 'file',
67         'optgroup' => 'optgroup',
68         'option' => 'option',
69         'table' => 'table',
70         'field' => 'field',
71         'fieldset' => 'fieldset',
72         'css_element' => 'css_element',
73         'xpath_element' => 'xpath_element'
74     );
76     /**
77      * Behat by default comes with XPath, CSS and named selectors,
78      * named selectors are a mapping between names (like button) and
79      * xpaths that represents that names and includes a placeholder that
80      * will be replaced by the locator. These are Moodle's own xpaths.
81      *
82      * @var XPaths for moodle elements.
83      */
84     protected static $moodleselectors = array(
85         'dialogue' => <<<XPATH
86 .//div[contains(concat(' ', normalize-space(@class), ' '), ' moodle-dialogue ')]/descendant::h1[normalize-space(.) = %locator%]/ancestor::div[contains(concat(' ', normalize-space(@class), ' '), ' moodle-dialogue ')]
87 XPATH
88         , 'block' => <<<XPATH
89 .//div[contains(concat(' ', normalize-space(@class), ' '), concat(' ', %locator%, ' '))] | .//div[contains(concat(' ', normalize-space(@class), ' '), ' block ')]/descendant::h2[normalize-space(.) = %locator%]/ancestor::div[contains(concat(' ', normalize-space(@class), ' '), ' block ')]
90 XPATH
91         , 'region' => <<<XPATH
92 .//div[./@id = %locator%]
93 XPATH
94         , 'table_row' => <<<XPATH
95 .//tr[contains(normalize-space(.), %locator%)]
96 XPATH
97     );
99     /**
100      * Returns the behat selector and locator for a given moodle selector and locator
101      *
102      * @param string $selectortype The moodle selector type, which includes moodle selectors
103      * @param string $element The locator we look for in that kind of selector
104      * @param Session $session The Mink opened session
105      * @return array Contains the selector and the locator expected by Mink.
106      */
107     public static function get_behat_selector($selectortype, $element, Behat\Mink\Session $session) {
109         // CSS and XPath selectors locator is one single argument.
110         if ($selectortype == 'css_element' || $selectortype == 'xpath_element') {
111             $selector = str_replace('_element', '', $selectortype);
112             $locator = $element;
113         } else {
114             // Named selectors uses arrays as locators including the type of named selector.
115             $locator = array($selectortype, $session->getSelectorsHandler()->xpathLiteral($element));
116             $selector = 'named';
117         }
119         return array($selector, $locator);
120     }
122     /**
123      * Adds moodle selectors as behat named selectors.
124      *
125      * @param Session $session The mink session
126      * @return void
127      */
128     public static function register_moodle_selectors(Behat\Mink\Session $session) {
130         foreach (self::get_moodle_selectors() as $name => $xpath) {
131             $session->getSelectorsHandler()->getSelector('named')->registerNamedXpath($name, $xpath);
132         }
133     }
135     /**
136      * Allowed selectors getter.
137      *
138      * @return array
139      */
140     public static function get_allowed_selectors() {
141         return self::$allowedselectors;
142     }
144     /**
145      * Allowed text selectors getter.
146      *
147      * @return array
148      */
149     public static function get_allowed_text_selectors() {
150         return self::$allowedtextselectors;
151     }
153     /**
154      * Moodle selectors attribute accessor.
155      *
156      * @return array
157      */
158     protected static function get_moodle_selectors() {
159         return self::$moodleselectors;
160     }