Merge branch 'MDL-68753-master-enfix' of git://github.com/mudrd8mz/moodle
[moodle.git] / repository / tests / behat / behat_filepicker.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  * Filemanager and filepicker manipulation steps definitions.
19  *
20  * @package    core_filepicker
21  * @category   test
22  * @copyright  2013 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/core_behat_file_helper.php');
30 use Behat\Mink\Exception\ExpectationException as ExpectationException,
31     Behat\Gherkin\Node\TableNode as TableNode;
33 /**
34  * Steps definitions to deal with the filemanager and filepicker.
35  *
36  * @package    core_filepicker
37  * @category   test
38  * @copyright  2013 David MonllaĆ³
39  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
40  */
41 class behat_filepicker extends behat_base {
42     use core_behat_file_helper;
44     /**
45      * Creates a folder with specified name in the current folder and in the specified filemanager field.
46      *
47      * @Given /^I create "(?P<foldername_string>(?:[^"]|\\")*)" folder in "(?P<filemanager_field_string>(?:[^"]|\\")*)" filemanager$/
48      * @throws ExpectationException Thrown by behat_base::find
49      * @param string $foldername
50      * @param string $filemanagerelement
51      */
52     public function i_create_folder_in_filemanager($foldername, $filemanagerelement) {
54         $fieldnode = $this->get_filepicker_node($filemanagerelement);
56         // Looking for the create folder button inside the specified filemanager.
57         $exception = new ExpectationException('No folders can be created in "'.$filemanagerelement.'" filemanager',
58                 $this->getSession());
59         $newfolder = $this->find('css', 'div.fp-btn-mkdir a', $exception, $fieldnode);
60         $newfolder->click();
62         // Setting the folder name in the modal window.
63         $exception = new ExpectationException('The dialog to enter the folder name does not appear', $this->getSession());
64         $dialoginput = $this->find('css', '.fp-mkdir-dlg-text input', $exception);
65         $dialoginput->setValue($foldername);
67         $exception = new ExpectationException('The button for the create folder dialog can not be located', $this->getSession());
68         $dialognode = $this->find('css', '.moodle-dialogue-focused');
69         $buttonnode = $this->find('css', '.fp-dlg-butcreate', $exception, $dialognode);
70         $buttonnode->click();
71     }
73     /**
74      * Opens the contents of a filemanager folder. It looks for the folder in the current folder and in the path bar.
75      *
76      * @Given /^I open "(?P<foldername_string>(?:[^"]|\\")*)" folder from "(?P<filemanager_field_string>(?:[^"]|\\")*)" filemanager$/
77      * @throws ExpectationException Thrown by behat_base::find
78      * @param string $foldername
79      * @param string $filemanagerelement
80      */
81     public function i_open_folder_from_filemanager($foldername, $filemanagerelement) {
83         $fieldnode = $this->get_filepicker_node($filemanagerelement);
85         $exception = new ExpectationException(
86                 'The "'.$foldername.'" folder can not be found in the "'.$filemanagerelement.'" filemanager',
87                 $this->getSession()
88         );
90         $folderliteral = behat_context_helper::escape($foldername);
92         // We look both in the pathbar and in the contents.
93         try {
95             // In the current folder workspace.
96             $folder = $this->find(
97                     'xpath',
98                     "//div[contains(concat(' ', normalize-space(@class), ' '), ' fp-folder ')]" .
99                     "/descendant::div[contains(concat(' ', normalize-space(@class), ' '), ' fp-filename ')]" .
100                     "[normalize-space(.)=$folderliteral]",
101                     $exception,
102                     $fieldnode
103             );
104         } catch (ExpectationException $e) {
106             // And in the pathbar.
107             $folder = $this->find(
108                     'xpath',
109                     "//a[contains(concat(' ', normalize-space(@class), ' '), ' fp-path-folder-name ')]" .
110                     "[normalize-space(.)=$folderliteral]",
111                     $exception,
112                     $fieldnode
113             );
114         }
116         // It should be a NodeElement, otherwise an exception would have been thrown.
117         $folder->click();
118     }
120     /**
121      * Unzips the specified file from the specified filemanager field. The zip file has to be visible in the current folder.
122      *
123      * @Given /^I unzip "(?P<filename_string>(?:[^"]|\\")*)" file from "(?P<filemanager_field_string>(?:[^"]|\\")*)" filemanager$/
124      * @throws ExpectationException Thrown by behat_base::find
125      * @param string $filename
126      * @param string $filemanagerelement
127      */
128     public function i_unzip_file_from_filemanager($filename, $filemanagerelement) {
130         // Open the contextual menu of the filemanager element.
131         $this->open_element_contextual_menu($filename, $filemanagerelement);
133         // Execute the action.
134         $exception = new ExpectationException($filename.' element can not be unzipped', $this->getSession());
135         $this->perform_on_element('unzip', $exception);
136     }
138     /**
139      * Zips the specified folder from the specified filemanager field. The folder has to be in the current folder.
140      *
141      * @Given /^I zip "(?P<filename_string>(?:[^"]|\\")*)" folder from "(?P<filemanager_field_string>(?:[^"]|\\")*)" filemanager$/
142      * @throws ExpectationException Thrown by behat_base::find
143      * @param string $foldername
144      * @param string $filemanagerelement
145      */
146     public function i_zip_folder_from_filemanager($foldername, $filemanagerelement) {
148         // Open the contextual menu of the filemanager element.
149         $this->open_element_contextual_menu($foldername, $filemanagerelement);
151         // Execute the action.
152         $exception = new ExpectationException($foldername.' element can not be zipped', $this->getSession());
153         $this->perform_on_element('zip', $exception);
154     }
156     /**
157      * Deletes the specified file or folder from the specified filemanager field.
158      *
159      * @Given /^I delete "(?P<file_or_folder_name_string>(?:[^"]|\\")*)" from "(?P<filemanager_field_string>(?:[^"]|\\")*)" filemanager$/
160      * @throws ExpectationException Thrown by behat_base::find
161      * @param string $name
162      * @param string $filemanagerelement
163      */
164     public function i_delete_file_from_filemanager($name, $filemanagerelement) {
166         // Open the contextual menu of the filemanager element.
167         $this->open_element_contextual_menu($name, $filemanagerelement);
169         // Execute the action.
170         $exception = new ExpectationException($name.' element can not be deleted', $this->getSession());
171         $this->perform_on_element('delete', $exception);
173         // Yes, we are sure.
174         // Using xpath + click instead of pressButton as 'Ok' it is a common string.
175         $okbutton = $this->find('css', 'div.fp-dlg button.fp-dlg-butconfirm');
176         $okbutton->click();
177     }
179     /**
180      * Makes sure user can see the exact number of elements (files in folders) in the filemanager.
181      *
182      * @Then /^I should see "(?P<elementscount_number>\d+)" elements in "(?P<filemanagerelement_string>(?:[^"]|\\")*)" filemanager$/
183      * @throws ExpectationException Thrown by behat_base::find
184      * @param int $elementscount
185      * @param string $filemanagerelement
186      */
187     public function i_should_see_elements_in_filemanager($elementscount, $filemanagerelement) {
188         $filemanagernode = $this->get_filepicker_node($filemanagerelement);
190         // We count .fp-file elements inside a filemanager not being updated.
191         $xpath = "//div[contains(concat(' ', normalize-space(@class), ' '), ' filemanager ')]" .
192                 "[not(contains(concat(' ', normalize-space(@class), ' '), ' fm-updating '))]" .
193                 "//div[contains(concat(' ', normalize-space(@class), ' '), ' fp-content ')]" .
194                 "//div[contains(concat(' ', normalize-space(@class), ' '), ' fp-file ')]";
196         $elements = $this->find_all('xpath', $xpath, false, $filemanagernode);
197         if (count($elements) != $elementscount) {
198             throw new ExpectationException('Found '.count($elements).' elements in filemanager. Expected '.$elementscount,
199                     $this->getSession());
200         }
201     }
203     /**
204      * Picks the file from repository leaving default values in select file dialogue.
205      *
206      * @When /^I add "(?P<filepath_string>(?:[^"]|\\")*)" file from "(?P<repository_string>(?:[^"]|\\")*)" to "(?P<filemanagerelement_string>(?:[^"]|\\")*)" filemanager$/
207      * @throws ExpectationException Thrown by behat_base::find
208      * @param string $filepath
209      * @param string $repository
210      * @param string $filemanagerelement
211      */
212     public function i_add_file_from_repository_to_filemanager($filepath, $repository, $filemanagerelement) {
213         $this->add_file_from_repository_to_filemanager($filepath, $repository, $filemanagerelement, new TableNode(array()), false);
214     }
216     /**
217      * Picks the file from repository leaving default values in select file dialogue and confirming to overwrite an existing file.
218      *
219      * @When /^I add and overwrite "(?P<filepath_string>(?:[^"]|\\")*)" file from "(?P<repository_string>(?:[^"]|\\")*)" to "(?P<filemanagerelement_string>(?:[^"]|\\")*)" filemanager$/
220      * @throws ExpectationException Thrown by behat_base::find
221      * @param string $filepath
222      * @param string $repository
223      * @param string $filemanagerelement
224      */
225     public function i_add_and_overwrite_file_from_repository_to_filemanager($filepath, $repository, $filemanagerelement) {
226         $this->add_file_from_repository_to_filemanager($filepath, $repository, $filemanagerelement, new TableNode(array()),
227                 get_string('overwrite', 'repository'));
228     }
230     /**
231      * Picks the file from repository filling the form in Select file dialogue.
232      *
233      * @When /^I add "(?P<filepath_string>(?:[^"]|\\")*)" file from "(?P<repository_string>(?:[^"]|\\")*)" to "(?P<filemanager_field_string>(?:[^"]|\\")*)" filemanager as:$/
234      * @throws ExpectationException Thrown by behat_base::find
235      * @param string $filepath
236      * @param string $repository
237      * @param string $filemanagerelement
238      * @param TableNode $data Data to fill the form in Select file dialogue
239      */
240     public function i_add_file_from_repository_to_filemanager_as($filepath, $repository, $filemanagerelement, TableNode $data) {
241         $this->add_file_from_repository_to_filemanager($filepath, $repository, $filemanagerelement, $data, false);
242     }
244     /**
245      * Picks the file from repository confirming to overwrite an existing file
246      *
247      * @When /^I add and overwrite "(?P<filepath_string>(?:[^"]|\\")*)" file from "(?P<repository_string>(?:[^"]|\\")*)" to "(?P<filemanager_field_string>(?:[^"]|\\")*)" filemanager as:$/
248      * @throws ExpectationException Thrown by behat_base::find
249      * @param string $filepath
250      * @param string $repository
251      * @param string $filemanagerelement
252      * @param TableNode $data Data to fill the form in Select file dialogue
253      */
254     public function i_add_and_overwrite_file_from_repository_to_filemanager_as($filepath, $repository, $filemanagerelement,
255             TableNode $data) {
256         $this->add_file_from_repository_to_filemanager($filepath, $repository, $filemanagerelement, $data,
257                 get_string('overwrite', 'repository'));
258     }
260     /**
261      * Picks the file from private files repository
262      *
263      * @throws ExpectationException Thrown by behat_base::find
264      * @param string $filepath
265      * @param string $repository
266      * @param string $filemanagerelement
267      * @param TableNode $data Data to fill the form in Select file dialogue
268      * @param false|string $overwriteaction false if we don't expect that file with the same name already exists,
269      *     or button text in overwrite dialogue ("Overwrite", "Rename to ...", "Cancel")
270      */
271     protected function add_file_from_repository_to_filemanager($filepath, $repository, $filemanagerelement, TableNode $data,
272             $overwriteaction = false) {
273         $filemanagernode = $this->get_filepicker_node($filemanagerelement);
275         // Opening the select repository window and selecting the upload repository.
276         $this->open_add_file_window($filemanagernode, $repository);
278         $this->open_element_contextual_menu($filepath);
280         // Fill the form in Select window.
281         $datahash = $data->getRowsHash();
283         // The action depends on the field type.
284         foreach ($datahash as $locator => $value) {
286             $field = behat_field_manager::get_form_field_from_label($locator, $this);
288             // Delegates to the field class.
289             $field->set_value($value);
290         }
292         $selectfilebutton = $this->find_button(get_string('getfile', 'repository'));
293         $this->ensure_node_is_visible($selectfilebutton);
294         $selectfilebutton->click();
296         // We wait for all the JS to finish as it is performing an action.
297         $this->getSession()->wait(self::get_timeout(), self::PAGE_READY_JS);
299         if ($overwriteaction !== false) {
300             $overwritebutton = $this->find_button($overwriteaction);
301             $this->ensure_node_is_visible($overwritebutton);
302             $overwritebutton->click();
304             // We wait for all the JS to finish.
305             $this->getSession()->wait(self::get_timeout(), self::PAGE_READY_JS);
306         }
308     }
310     /**
311      * Selects a repository from the repository list in the file picker.
312      *
313      * @Then /^I select "(?P<repository_name_string>(?:[^"]|\\")*)" repository in file picker$/
314      * @throws ExpectationException Thrown by behat_base::find
315      * @param string $repositoryname
316      */
317     public function i_select_filepicker_repository($repositoryname) {
318         $exception = new ExpectationException(
319             "The '{$repositoryname}' repository can not be found in the file picker", $this->getSession());
320         // We look for a repository that matches a certain name in the file picker repository list.
321         $xpath = "//div[contains(concat(' ', normalize-space(@class), ' '), ' filepicker ')]" .
322             "//div[contains(concat(' ', normalize-space(@class), ' '), ' fp-repo-area ')]" .
323             "//span[contains(concat(' ', normalize-space(@class), ' '), ' fp-repo-name ')]" .
324             "[normalize-space(.)='{$repositoryname}']";
326         $repository = $this->find('xpath', $xpath, $exception);
327         // If the node exists, click on the node.
328         $repository->click();
329     }
331     /**
332      * Makes sure user can see the exact number of elements (files and folders) in the repository content area in
333      * the file picker.
334      *
335      * @Then /^I should see "(?P<elements_number>\d+)" elements in repository content area$/
336      * @throws ExpectationException Thrown by behat_base::find_all
337      * @param int $expectedcount
338      */
339     public function i_should_see_elements_in_filepicker_repository($expectedcount) {
340         // We look for all .fp-file elements inside the content area of the file picker repository.
341         $xpath = "//div[contains(concat(' ', normalize-space(@class), ' '), ' file-picker ')]" .
342             "//div[contains(concat(' ', normalize-space(@class), ' '), ' fp-content ')]" .
343             "//a[contains(concat(' ', normalize-space(@class), ' '), ' fp-file ')]";
345         $elements = $this->find_all('xpath', $xpath);
346         // Make sure the expected number is equal to the actual number of .fp-file elements.
347         if (count($elements) != $expectedcount) {
348             throw new ExpectationException("Found " . count($elements) .
349                 " elements in filepicker repository. Expected {$expectedcount}", $this->getSession());
350         }
351     }
353     /**
354      * Returns a specific element (file or folder) in the repository content area in the file picker.
355      *
356      * @throws ExpectationException Thrown by behat_base::find
357      * @param string $elementname The name of the element
358      * @param string $elementtype The type of the element ("file" or "folder")
359      * @return NodeElement
360      */
361     protected function get_element_in_filepicker_repository($elementname, $elementtype) {
362         // We look for a .fp-{type} element with a certain name inside the content area of the file picker repository.
363         $exception = new ExpectationException(
364             "The '{$elementname}' {$elementtype} can not be found in the repository content area",
365             $this->getSession());
366         $xpath = "//div[contains(concat(' ', normalize-space(@class), ' '), ' file-picker ')]" .
367             "//div[contains(concat(' ', normalize-space(@class), ' '), ' fp-content ')]" .
368             "//a[contains(concat(' ', normalize-space(@class), ' '), ' fp-{$elementtype} ')]" .
369             "[normalize-space(.)='{$elementname}']";
371         return $this->find('xpath', $xpath, $exception);
372     }
374     /**
375      * Makes sure user can see a specific element (file or folder) in the repository content area in the file picker.
376      *
377      * @Then /^I should see "(?P<element_name_string>(?:[^"]|\\")*)" "(?P<element_type_string>(?:[^"]|\\")*)" in repository content area$/
378      * @throws ExpectationException Thrown by behat_base::find
379      * @param string $elementname The name of the element
380      * @param string $elementtype The type of the element ("file" or "folder")
381      */
382     public function i_should_see_element_in_filepicker_repository($elementname, $elementtype) {
383         $this->get_element_in_filepicker_repository($elementname, $elementtype);
384     }
386     /**
387      * Clicks on a specific element (file or folder) in the repository content area in the file picker.
388      *
389      * @Then /^I click on "(?P<element_name_string>(?:[^"]|\\")*)" "(?P<element_type_string>(?:[^"]|\\")*)" in repository content area$/
390      * @throws ExpectationException Thrown by behat_base::find
391      * @param string $elementname The name of the element
392      * @param string $elementtype The type of the element ("file" or "folder")
393      */
394     public function i_click_on_element_in_filepicker_repository($elementname, $elementtype) {
395         $element = $this->get_element_in_filepicker_repository($elementname, $elementtype);
396         $element->click();
397     }
399     /**
400      * Makes sure the user can see a specific breadcrumb navigation structure in the file picker repository.
401      *
402      * @Then /^I should see "(?P<breadcrumb_navigation_string>(?:[^"]|\\")*)" breadcrumb navigation in repository$/
403      * @throws ExpectationException Thrown by behat_base::find
404      * @param string $breadcrumbs The breadcrumb navigation structure (ex. "System > Category > Course")
405      */
406     public function i_should_see_breadcrumb_navigation_in_filepicker_repository($breadcrumbs) {
407         $breadcrumbs = preg_split('/\s*>\s*/', trim($breadcrumbs));
408         foreach ($breadcrumbs as $breadcrumb) {
409             // We look for a .fp-path-folder element with a certain name inside the breadcrumb navigation area
410             // in the repository.
411             $exception = new ExpectationException(
412                 "The '{$breadcrumb}' node can not be found in the breadcrumb navigation in the repository",
413                 $this->getSession()
414             );
415             $xpath = "//div[contains(concat(' ', normalize-space(@class), ' '), ' file-picker ')]" .
416                 "//div[contains(concat(' ', normalize-space(@class), ' '), ' fp-pathbar ')]" .
417                 "//span[contains(concat(' ', normalize-space(@class), ' '), ' fp-path-folder ')]" .
418                 "[normalize-space(.)='{$breadcrumb}']";
420             $this->find('xpath', $xpath, $exception);
421         }
422     }