MDL-48373 behat: new container selector for list items.
[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         'list_item' => 'list_item',
47         'table' => 'table',
48         'fieldset' => 'fieldset',
49         'css_element' => 'css_element',
50         'xpath_element' => 'xpath_element'
51     );
53     /**
54      * @var Allowed types when using selector arguments.
55      */
56     protected static $allowedselectors = array(
57         'dialogue' => 'dialogue',
58         'block' => 'block',
59         'region' => 'region',
60         'table_row' => 'table_row',
61         'list_item' => 'list_item',
62         'link' => 'link',
63         'button' => 'button',
64         'link_or_button' => 'link_or_button',
65         'select' => 'select',
66         'checkbox' => 'checkbox',
67         'radio' => 'radio',
68         'file' => 'file',
69         'filemanager' => 'filemanager',
70         'optgroup' => 'optgroup',
71         'option' => 'option',
72         'table' => 'table',
73         'field' => 'field',
74         'fieldset' => 'fieldset',
75         'text' => 'text',
76         'css_element' => 'css_element',
77         'xpath_element' => 'xpath_element'
78     );
80     /**
81      * Behat by default comes with XPath, CSS and named selectors,
82      * named selectors are a mapping between names (like button) and
83      * xpaths that represents that names and includes a placeholder that
84      * will be replaced by the locator. These are Moodle's own xpaths.
85      *
86      * @var XPaths for moodle elements.
87      */
88     protected static $moodleselectors = array(
89         'text' => <<<XPATH
90 //*[contains(., %locator%)][count(./descendant::*[contains(., %locator%)]) = 0]
91 XPATH
92         , 'dialogue' => <<<XPATH
93 //div[contains(concat(' ', normalize-space(@class), ' '), ' moodle-dialogue ') and
94     normalize-space(descendant::div[
95         contains(concat(' ', normalize-space(@class), ' '), ' moodle-dialogue-hd ')
96         ]) = %locator%] |
97 //div[contains(concat(' ', normalize-space(@class), ' '), ' yui-dialog ') and
98     normalize-space(descendant::div[@class='hd']) = %locator%]
99 XPATH
100         , 'block' => <<<XPATH
101 //div[contains(concat(' ', normalize-space(@class), ' '), ' block ') and
102     (contains(concat(' ', normalize-space(@class), ' '), concat(' ', %locator%, ' ')) or
103      descendant::h2[normalize-space(.) = %locator%] or
104      @aria-label = %locator%)]
105 XPATH
106         , 'region' => <<<XPATH
107 //*[self::div | self::section | self::aside | self::header | self::footer][./@id = %locator%]
108 XPATH
109         , 'table_row' => <<<XPATH
110 .//tr[contains(normalize-space(.), %locator%)]
111 XPATH
112         , 'list_item' => <<<XPATH
113 .//li[contains(normalize-space(.), %locator%)]
114 XPATH
115         , 'filemanager' => <<<XPATH
116 //div[contains(concat(' ', normalize-space(@class), ' '), ' ffilemanager ')]
117     /descendant::input[@id = //label[contains(normalize-space(string(.)), %locator%)]/@for]
118 XPATH
119         , 'table' => <<<XPATH
120 .//table[(./@id = %locator% or contains(.//caption, %locator%) or contains(concat(' ', normalize-space(@class), ' '), %locator% ))]
121 XPATH
122     );
124     /**
125      * Returns the behat selector and locator for a given moodle selector and locator
126      *
127      * @param string $selectortype The moodle selector type, which includes moodle selectors
128      * @param string $element The locator we look for in that kind of selector
129      * @param Session $session The Mink opened session
130      * @return array Contains the selector and the locator expected by Mink.
131      */
132     public static function get_behat_selector($selectortype, $element, Behat\Mink\Session $session) {
134         // CSS and XPath selectors locator is one single argument.
135         if ($selectortype == 'css_element' || $selectortype == 'xpath_element') {
136             $selector = str_replace('_element', '', $selectortype);
137             $locator = $element;
138         } else {
139             // Named selectors uses arrays as locators including the type of named selector.
140             $locator = array($selectortype, $session->getSelectorsHandler()->xpathLiteral($element));
141             $selector = 'named';
142         }
144         return array($selector, $locator);
145     }
147     /**
148      * Adds moodle selectors as behat named selectors.
149      *
150      * @param Session $session The mink session
151      * @return void
152      */
153     public static function register_moodle_selectors(Behat\Mink\Session $session) {
155         foreach (self::get_moodle_selectors() as $name => $xpath) {
156             $session->getSelectorsHandler()->getSelector('named')->registerNamedXpath($name, $xpath);
157         }
158     }
160     /**
161      * Allowed selectors getter.
162      *
163      * @return array
164      */
165     public static function get_allowed_selectors() {
166         return self::$allowedselectors;
167     }
169     /**
170      * Allowed text selectors getter.
171      *
172      * @return array
173      */
174     public static function get_allowed_text_selectors() {
175         return self::$allowedtextselectors;
176     }
178     /**
179      * Moodle selectors attribute accessor.
180      *
181      * @return array
182      */
183     protected static function get_moodle_selectors() {
184         return self::$moodleselectors;
185     }