weekly release 3.7dev
[moodle.git] / theme / boost / tests / behat / behat_theme_boost_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 overrides.
19  *
20  * @copyright  2016 Damyon Wiese
21  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
22  */
24 // NOTE: no MOODLE_INTERNAL test here, this file may be required by behat before including /config.php.
26 require_once(__DIR__ . '/behat_theme_boost_behat_files.php');
28 use Behat\Mink\Exception\ExpectationException as ExpectationException,
29     Behat\Gherkin\Node\TableNode as TableNode;
31 /**
32  * Steps definitions to deal with the filemanager and filepicker overrides.
33  *
34  * @copyright  2016 Damyon Wiese
35  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36  */
37 class behat_theme_boost_behat_filepicker extends behat_theme_boost_behat_files {
38     /**
39      * Creates a folder with specified name in the current folder and in the specified filemanager field.
40      *
41      * @Given /^I create "(?P<foldername_string>(?:[^"]|\\")*)" folder in "(?P<filemanager_field_string>(?:[^"]|\\")*)" filemanager$/
42      * @throws ExpectationException Thrown by behat_base::find
43      * @param string $foldername
44      * @param string $filemanagerelement
45      */
46     public function i_create_folder_in_filemanager($foldername, $filemanagerelement) {
48         $fieldnode = $this->get_filepicker_node($filemanagerelement);
50         // Looking for the create folder button inside the specified filemanager.
51         $exception = new ExpectationException('No folders can be created in "'.$filemanagerelement.'" filemanager',
52             $this->getSession());
53         $newfolder = $this->find('css', 'div.fp-btn-mkdir a', $exception, $fieldnode);
54         $newfolder->click();
56         // Setting the folder name in the modal window.
57         $exception = new ExpectationException('The dialog to enter the folder name does not appear', $this->getSession());
58         $dialoginput = $this->find('css', '.fp-mkdir-dlg-text input', $exception);
59         $dialoginput->setValue($foldername);
61         $exception = new ExpectationException('The button for the create folder dialog can not be located', $this->getSession());
62         $dialognode = $this->find('css', '.moodle-dialogue-focused');
63         $buttonnode = $this->find('css', '.fp-dlg-butcreate', $exception, $dialognode);
64         $buttonnode->click();
65     }
67     /**
68      * Opens the contents of a filemanager folder. It looks for the folder in the current folder and in the path bar.
69      *
70      * @Given /^I open "(?P<foldername_string>(?:[^"]|\\")*)" folder from "(?P<filemanager_field_string>(?:[^"]|\\")*)" filemanager$/
71      * @throws ExpectationException Thrown by behat_base::find
72      * @param string $foldername
73      * @param string $filemanagerelement
74      */
75     public function i_open_folder_from_filemanager($foldername, $filemanagerelement) {
77         $fieldnode = $this->get_filepicker_node($filemanagerelement);
79         $exception = new ExpectationException(
80             'The "'.$foldername.'" folder can not be found in the "'.$filemanagerelement.'" filemanager',
81             $this->getSession()
82         );
84         $folderliteral = behat_context_helper::escape($foldername);
86         // We look both in the pathbar and in the contents.
87         try {
89             // In the current folder workspace.
90             $folder = $this->find(
91                 'xpath',
92                 "//div[contains(concat(' ', normalize-space(@class), ' '), ' fp-folder ')]" .
93                     "/descendant::div[contains(concat(' ', normalize-space(@class), ' '), ' fp-filename ')]" .
94                     "[normalize-space(.)=$folderliteral]",
95                 $exception,
96                 $fieldnode
97             );
98         } catch (ExpectationException $e) {
100             // And in the pathbar.
101             $folder = $this->find(
102                 'xpath',
103                 "//a[contains(concat(' ', normalize-space(@class), ' '), ' fp-path-folder-name ')]" .
104                     "[normalize-space(.)=$folderliteral]",
105                 $exception,
106                 $fieldnode
107             );
108         }
110         // It should be a NodeElement, otherwise an exception would have been thrown.
111         $folder->click();
112     }
114     /**
115      * Unzips the specified file from the specified filemanager field. The zip file has to be visible in the current folder.
116      *
117      * @Given /^I unzip "(?P<filename_string>(?:[^"]|\\")*)" file from "(?P<filemanager_field_string>(?:[^"]|\\")*)" filemanager$/
118      * @throws ExpectationException Thrown by behat_base::find
119      * @param string $filename
120      * @param string $filemanagerelement
121      */
122     public function i_unzip_file_from_filemanager($filename, $filemanagerelement) {
124         // Open the contextual menu of the filemanager element.
125         $this->open_element_contextual_menu($filename, $filemanagerelement);
127         // Execute the action.
128         $exception = new ExpectationException($filename.' element can not be unzipped', $this->getSession());
129         $this->perform_on_element('unzip', $exception);
130     }
132     /**
133      * Zips the specified folder from the specified filemanager field. The folder has to be in the current folder.
134      *
135      * @Given /^I zip "(?P<filename_string>(?:[^"]|\\")*)" folder from "(?P<filemanager_field_string>(?:[^"]|\\")*)" filemanager$/
136      * @throws ExpectationException Thrown by behat_base::find
137      * @param string $foldername
138      * @param string $filemanagerelement
139      */
140     public function i_zip_folder_from_filemanager($foldername, $filemanagerelement) {
142         // Open the contextual menu of the filemanager element.
143         $this->open_element_contextual_menu($foldername, $filemanagerelement);
145         // Execute the action.
146         $exception = new ExpectationException($foldername.' element can not be zipped', $this->getSession());
147         $this->perform_on_element('zip', $exception);
148     }
150     /**
151      * Deletes the specified file or folder from the specified filemanager field.
152      *
153      * @Given /^I delete "(?P<file_or_folder_name_string>(?:[^"]|\\")*)" from "(?P<filemanager_field_string>(?:[^"]|\\")*)" filemanager$/
154      * @throws ExpectationException Thrown by behat_base::find
155      * @param string $name
156      * @param string $filemanagerelement
157      */
158     public function i_delete_file_from_filemanager($name, $filemanagerelement) {
160         // Open the contextual menu of the filemanager element.
161         $this->open_element_contextual_menu($name, $filemanagerelement);
163         // Execute the action.
164         $exception = new ExpectationException($name.' element can not be deleted', $this->getSession());
165         $this->perform_on_element('delete', $exception);
167         // Yes, we are sure.
168         // Using xpath + click instead of pressButton as 'Ok' it is a common string.
169         $okbutton = $this->find('css', 'div.fp-dlg button.fp-dlg-butconfirm');
170         $okbutton->click();
171     }
174     /**
175      * Makes sure user can see the exact number of elements (files in folders) in the filemanager.
176      *
177      * @Then /^I should see "(?P<elementscount_number>\d+)" elements in "(?P<filemanagerelement_string>(?:[^"]|\\")*)" filemanager$/
178      * @throws ExpectationException Thrown by behat_base::find
179      * @param int $elementscount
180      * @param string $filemanagerelement
181      */
182     public function i_should_see_elements_in_filemanager($elementscount, $filemanagerelement) {
183         $filemanagernode = $this->get_filepicker_node($filemanagerelement);
185         // We count .fp-file elements inside a filemanager not being updated.
186         $xpath = "//div[contains(concat(' ', normalize-space(@class), ' '), ' filemanager ')]" .
187             "[not(contains(concat(' ', normalize-space(@class), ' '), ' fm-updating '))]" .
188             "//div[contains(concat(' ', normalize-space(@class), ' '), ' fp-content ')]" .
189             "//div[contains(concat(' ', normalize-space(@class), ' '), ' fp-file ')]";
191         $elements = $this->find_all('xpath', $xpath, false, $filemanagernode);
192         if (count($elements) != $elementscount) {
193             throw new ExpectationException('Found '.count($elements).' elements in filemanager. Expected '.$elementscount,
194                  $this->getSession());
195         }
196     }
198     /**
199      * Picks the file from repository leaving default values in select file dialogue.
200      *
201      * @When /^I add "(?P<filepath_string>(?:[^"]|\\")*)" file from "(?P<repository_string>(?:[^"]|\\")*)" to "(?P<filemanagerelement_string>(?:[^"]|\\")*)" filemanager$/
202      * @throws ExpectationException Thrown by behat_base::find
203      * @param string $filepath
204      * @param string $repository
205      * @param string $filemanagerelement
206      */
207     public function i_add_file_from_repository_to_filemanager($filepath, $repository, $filemanagerelement) {
208         $this->add_file_from_repository_to_filemanager($filepath, $repository, $filemanagerelement, new TableNode(array()), false);
209     }
211     /**
212      * Picks the file from repository leaving default values in select file dialogue and confirming to overwrite an existing file.
213      *
214      * @When /^I add and overwrite "(?P<filepath_string>(?:[^"]|\\")*)" file from "(?P<repository_string>(?:[^"]|\\")*)" to "(?P<filemanagerelement_string>(?:[^"]|\\")*)" filemanager$/
215      * @throws ExpectationException Thrown by behat_base::find
216      * @param string $filepath
217      * @param string $repository
218      * @param string $filemanagerelement
219      */
220     public function i_add_and_overwrite_file_from_repository_to_filemanager($filepath, $repository, $filemanagerelement) {
221         $this->add_file_from_repository_to_filemanager($filepath, $repository, $filemanagerelement, new TableNode(array()),
222                 get_string('overwrite', 'repository'));
223     }
225     /**
226      * Picks the file from repository filling the form in Select file dialogue.
227      *
228      * @When /^I add "(?P<filepath_string>(?:[^"]|\\")*)" file from "(?P<repository_string>(?:[^"]|\\")*)" to "(?P<filemanager_field_string>(?:[^"]|\\")*)" filemanager as:$/
229      * @throws ExpectationException Thrown by behat_base::find
230      * @param string $filepath
231      * @param string $repository
232      * @param string $filemanagerelement
233      * @param TableNode $data Data to fill the form in Select file dialogue
234      */
235     public function i_add_file_from_repository_to_filemanager_as($filepath, $repository, $filemanagerelement, TableNode $data) {
236         $this->add_file_from_repository_to_filemanager($filepath, $repository, $filemanagerelement, $data, false);
237     }
239     /**
240      * Picks the file from repository confirming to overwrite an existing file
241      *
242      * @When /^I add and overwrite "(?P<filepath_string>(?:[^"]|\\")*)" file from "(?P<repository_string>(?:[^"]|\\")*)" to "(?P<filemanager_field_string>(?:[^"]|\\")*)" filemanager as:$/
243      * @throws ExpectationException Thrown by behat_base::find
244      * @param string $filepath
245      * @param string $repository
246      * @param string $filemanagerelement
247      * @param TableNode $data Data to fill the form in Select file dialogue
248      */
249     public function i_add_and_overwrite_file_from_repository_to_filemanager_as($filepath, $repository, $filemanagerelement,
250             TableNode $data) {
251         $this->add_file_from_repository_to_filemanager($filepath, $repository, $filemanagerelement, $data,
252                 get_string('overwrite', 'repository'));
253     }
255     /**
256      * Picks the file from private files repository
257      *
258      * @throws ExpectationException Thrown by behat_base::find
259      * @param string $filepath
260      * @param string $repository
261      * @param string $filemanagerelement
262      * @param TableNode $data Data to fill the form in Select file dialogue
263      * @param false|string $overwriteaction false if we don't expect that file with the same name already exists,
264      *     or button text in overwrite dialogue ("Overwrite", "Rename to ...", "Cancel")
265      */
266     protected function add_file_from_repository_to_filemanager($filepath, $repository, $filemanagerelement, TableNode $data,
267             $overwriteaction = false) {
268         $filemanagernode = $this->get_filepicker_node($filemanagerelement);
270         // Opening the select repository window and selecting the upload repository.
271         $this->open_add_file_window($filemanagernode, $repository);
273         $this->open_element_contextual_menu($filepath);
275         // Fill the form in Select window.
276         $datahash = $data->getRowsHash();
278         // The action depends on the field type.
279         foreach ($datahash as $locator => $value) {
281             $field = behat_field_manager::get_form_field_from_label($locator, $this);
283             // Delegates to the field class.
284             $field->set_value($value);
285         }
287         $selectfilebutton = $this->find_button(get_string('getfile', 'repository'));
288         $this->ensure_node_is_visible($selectfilebutton);
289         $selectfilebutton->click();
291         // We wait for all the JS to finish as it is performing an action.
292         $this->getSession()->wait(self::TIMEOUT, self::PAGE_READY_JS);
294         if ($overwriteaction !== false) {
295             $overwritebutton = $this->find_button($overwriteaction);
296             $this->ensure_node_is_visible($overwritebutton);
297             $overwritebutton->click();
299             // We wait for all the JS to finish.
300             $this->getSession()->wait(self::TIMEOUT, self::PAGE_READY_JS);
301         }
303     }