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