MDL-68353 test: Update filemanager/filepicker xpath selector
[moodle.git] / lib / behat / core_behat_file_helper.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  * Files interactions with behat.
19  *
20  * Note that steps definitions files can not extend other steps definitions files, so steps definitions which makes use
21  * of file attachments or filepicker should use this behat_file_helper trait.
22  *
23  * @package    core
24  * @category   test
25  * @copyright  2013 David MonllaĆ³
26  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27  */
29 // NOTE: no MOODLE_INTERNAL test here, this file may be required by behat before including /config.php.
31 require_once(__DIR__ . '/behat_base.php');
33 use Behat\Mink\Exception\ExpectationException as ExpectationException,
34     Behat\Mink\Element\NodeElement as NodeElement;
36 /**
37  * Files-related actions.
38  *
39  * Steps definitions related with filepicker or repositories should extend use this trait as it provides useful methods
40  * to deal with the common filepicker issues.
41  *
42  * @package    core
43  * @category   test
44  * @copyright  2013 David MonllaĆ³
45  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
46  */
47 trait core_behat_file_helper {
49     /**
50      * Gets the NodeElement for filepicker of filemanager moodleform element.
51      *
52      * The filepicker/filemanager element label is pointing to a hidden input which is
53      * not recognized as a named selector, as it is hidden...
54      *
55      * @throws ExpectationException Thrown by behat_base::find
56      * @param string $filepickerelement The filepicker form field label
57      * @return NodeElement The hidden element node.
58      */
60     protected function get_filepicker_node($filepickerelement) {
62         // More info about the problem (in case there is a problem).
63         $exception = new ExpectationException('"' . $filepickerelement . '" filepicker can not be found', $this->getSession());
65         // If no file picker label is mentioned take the first file picker from the page.
66         if (empty($filepickerelement)) {
67             $filepickercontainer = $this->find(
68                     'xpath',
69                     "//*[@data-fieldtype=\"filemanager\"]",
70                     $exception
71             );
72         } else {
73             // Gets the ffilemanager node specified by the locator which contains the filepicker container.
74             $filepickerelement = behat_context_helper::escape($filepickerelement);
75             $filepickercontainer = $this->find(
76                     'xpath',
77                     "//input[./@id = substring-before(//p[normalize-space(.)=$filepickerelement]/@id, '_label')]" .
78                     "//ancestor::*[@data-fieldtype = 'filemanager' or @data-fieldtype = 'filepicker']",
79                     $exception
80             );
81         }
83         return $filepickercontainer;
84     }
86     /**
87      * Performs $action on a filemanager container element (file or folder).
88      *
89      * It works together with open_element_contextual_menu
90      * as this method needs the contextual menu to be opened.
91      *
92      * @throws ExpectationException Thrown by behat_base::find
93      * @param string $action
94      * @param ExpectationException $exception
95      * @return void
96      */
97     protected function perform_on_element($action, ExpectationException $exception) {
99         // Finds the button inside the DOM, is a modal window, so should be unique.
100         $classname = 'fp-file-' . $action;
101         $button = $this->find('css', '.moodle-dialogue-focused button.' . $classname, $exception);
103         $this->ensure_node_is_visible($button);
104         $button->click();
105     }
107     /**
108      * Opens the contextual menu of a folder or a file.
109      *
110      * Works both in filemanager elements and when dealing with repository
111      * elements inside filepicker modal window.
112      *
113      * @throws ExpectationException Thrown by behat_base::find
114      * @param string $name The name of the folder/file
115      * @param string $filemanagerelement The filemanager form element locator, the repository items are in filepicker modal window if false
116      * @return void
117      */
118     protected function open_element_contextual_menu($name, $filemanagerelement = false) {
120         // If a filemanager is specified we restrict the search to the descendants of this particular filemanager form element.
121         $containernode = false;
122         $exceptionmsg = '"'.$name.'" element can not be found';
123         if ($filemanagerelement) {
124             $containernode = $this->get_filepicker_node($filemanagerelement);
125             $exceptionmsg = 'The "'.$filemanagerelement.'" filemanager ' . $exceptionmsg;
126             $locatorprefix = "//div[contains(concat(' ', normalize-space(@class), ' '), ' fp-content ')]";
127         } else {
128             $locatorprefix = "//div[contains(concat(' ', normalize-space(@class), ' '), ' fp-repo-items ')]" .
129                              "//descendant::div[contains(concat(' ', normalize-space(@class), ' '), ' fp-content ')]";
130         }
132         $exception = new ExpectationException($exceptionmsg, $this->getSession());
134         // Avoid quote-related problems.
135         $name = behat_context_helper::escape($name);
137         // Get a filepicker/filemanager element (folder or file).
138         try {
140             // First we look at the folder as we need to click on the contextual menu otherwise it would be opened.
141             $node = $this->find(
142                 'xpath',
143                 $locatorprefix .
144                     "//descendant::*[self::div | self::a][contains(concat(' ', normalize-space(@class), ' '), ' fp-file ')]" .
145                     "[contains(concat(' ', normalize-space(@class), ' '), ' fp-folder ')]" .
146                     "[normalize-space(.)=$name]" .
147                     "//descendant::a[contains(concat(' ', normalize-space(@class), ' '), ' fp-contextmenu ')]",
148                 $exception,
149                 $containernode
150             );
152         } catch (ExpectationException $e) {
154             // Here the contextual menu is hidden, we click on the thumbnail.
155             $node = $this->find(
156                 'xpath',
157                 $locatorprefix .
158                 "//descendant::*[self::div | self::a][contains(concat(' ', normalize-space(@class), ' '), ' fp-file ')]" .
159                 "[normalize-space(.)=$name]" .
160                 "//descendant::div[contains(concat(' ', normalize-space(@class), ' '), ' fp-filename-field ')]",
161                 false,
162                 $containernode
163             );
164         }
166         // Click opens the contextual menu when clicking on files.
167         $this->ensure_node_is_visible($node);
168         $node->click();
169     }
171     /**
172      * Opens the filepicker modal window and selects the repository.
173      *
174      * @throws ExpectationException Thrown by behat_base::find
175      * @param NodeElement $filemanagernode The filemanager or filepicker form element DOM node.
176      * @param mixed $repositoryname The repo name.
177      * @return void
178      */
179     protected function open_add_file_window($filemanagernode, $repositoryname) {
181         $exception = new ExpectationException('No files can be added to the specified filemanager', $this->getSession());
183         // We should deal with single-file and multiple-file filemanagers,
184         // catching the exception thrown by behat_base::find() in case is not multiple
185         try {
186             // Looking for the add button inside the specified filemanager.
187             $add = $this->find('css', 'div.fp-btn-add a', $exception, $filemanagernode);
188         } catch (Exception $e) {
189             // Otherwise should be a single-file filepicker form element.
190             $add = $this->find('css', 'input.fp-btn-choose', $exception, $filemanagernode);
191         }
192         $this->ensure_node_is_visible($add);
193         $add->click();
195         // Wait for the default repository (if any) to load. This checks that
196         // the relevant div exists and that it does not include the loading image.
197         $this->ensure_element_exists(
198                 "//div[contains(concat(' ', normalize-space(@class), ' '), ' file-picker ')]" .
199                 "//div[contains(concat(' ', normalize-space(@class), ' '), ' fp-content ')]" .
200                 "[not(descendant::div[contains(concat(' ', normalize-space(@class), ' '), ' fp-content-loading ')])]",
201                 'xpath_element');
203         // Getting the repository link and opening it.
204         $repoexception = new ExpectationException('The "' . $repositoryname . '" repository has not been found', $this->getSession());
206         // Avoid problems with both double and single quotes in the same string.
207         $repositoryname = behat_context_helper::escape($repositoryname);
209         // Here we don't need to look inside the selected element because there can only be one modal window.
210         $repositorylink = $this->find(
211             'xpath',
212             "//div[contains(concat(' ', normalize-space(@class), ' '), ' fp-repo-area ')]" .
213                 "//descendant::span[contains(concat(' ', normalize-space(@class), ' '), ' fp-repo-name ')]" .
214                 "[normalize-space(.)=$repositoryname]",
215             $repoexception
216         );
218         // Selecting the repo.
219         $this->ensure_node_is_visible($repositorylink);
220         if (!$repositorylink->getParent()->getParent()->hasClass('active')) {
221             // If the repository link is active, then the repository is already loaded.
222             // Clicking it while it's active causes issues, so only click it when it isn't (see MDL-51014).
223             $repositorylink->click();
224         }
225     }
227     /**
228      * Waits until the file manager modal windows are closed.
229      *
230      * This method is not used by any of our step definitions,
231      * keeping it here for users already using it.
232      *
233      * @throws ExpectationException
234      * @return void
235      */
236     protected function wait_until_return_to_form() {
238         $exception = new ExpectationException('The file manager is taking too much time to finish the current action', $this->getSession());
240          $this->find(
241              'xpath',
242              "//div[contains(concat(' ', @class, ' '), ' moodle-dialogue-lightbox ')][contains(@style, 'display: none;')]",
243              $exception
244          );
245     }
247     /**
248      * Checks that the file manager contents are not being updated.
249      *
250      * This method is not used by any of our step definitions,
251      * keeping it here for users already using it.
252      *
253      * @throws ExpectationException
254      * @param NodeElement $filepickernode The file manager DOM node
255      * @return void
256      */
257     protected function wait_until_contents_are_updated($filepickernode) {
259         $exception = new ExpectationException(
260             'The file manager contents are requiring too much time to be updated',
261             $this->getSession()
262         );
264         // Looks for the loading image not being displayed. For single-file filepickers is
265         // only used when accessing the filepicker, there is no filemanager-loading after selecting the file.
266         $this->find(
267             'xpath',
268             "//div[contains(concat(' ', normalize-space(@class), ' '), ' filemanager ')]" .
269                 "[not(contains(concat(' ', normalize-space(@class), ' '), ' fm-updating '))]" .
270             "|" .
271             "//div[contains(concat(' ', normalize-space(@class), ' '), ' filemanager-loading ')]" .
272                 "[contains(@style, 'display: none;')]",
273             $exception,
274             $filepickernode
275         );
276     }