MDL-58428 theme: Shift templates ready for Bootstrapbase removal
[moodle.git] / theme / bootstrapbase / tests / behat / behat_theme_bootstrapbase_behat_filepicker.php
 /**
  * Filemanager and filepicker manipulation steps definitions overrides.
  *
+ * @package    theme_bootstrapbase
+ * @category   test
  * @copyright  2016 Damyon Wiese
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 // NOTE: no MOODLE_INTERNAL test here, this file may be required by behat before including /config.php.
 
-require_once(__DIR__ . '/behat_theme_boost_behat_files.php');
+require_once(__DIR__ . '/theme_bootstrapbase_behat_file_helper.php');
+require_once(__DIR__ . '/../../../../repository/tests/behat/behat_filepicker.php');
 
 use Behat\Mink\Exception\ExpectationException as ExpectationException,
     Behat\Gherkin\Node\TableNode as TableNode;
@@ -34,22 +37,13 @@ use Behat\Mink\Exception\ExpectationException as ExpectationException,
  * @copyright  2016 Damyon Wiese
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-class behat_theme_boost_behat_filepicker extends behat_theme_boost_behat_files {
-    /**
-     * Creates a folder with specified name in the current folder and in the specified filemanager field.
-     *
-     * @Given /^I create "(?P<foldername_string>(?:[^"]|\\")*)" folder in "(?P<filemanager_field_string>(?:[^"]|\\")*)" filemanager$/
-     * @throws ExpectationException Thrown by behat_base::find
-     * @param string $foldername
-     * @param string $filemanagerelement
-     */
+class behat_theme_bootstrapbase_behat_filepicker extends behat_theme_bootstrapbase_behat_files {
     public function i_create_folder_in_filemanager($foldername, $filemanagerelement) {
 
         $fieldnode = $this->get_filepicker_node($filemanagerelement);
 
         // Looking for the create folder button inside the specified filemanager.
-        $exception = new ExpectationException('No folders can be created in "'.$filemanagerelement.'" filemanager',
-            $this->getSession());
+        $exception = new ExpectationException('No folders can be created in "'.$filemanagerelement.'" filemanager',$this->getSession());
         $newfolder = $this->find('css', 'div.fp-btn-mkdir a', $exception, $fieldnode);
         $newfolder->click();
 
@@ -64,21 +58,13 @@ class behat_theme_boost_behat_filepicker extends behat_theme_boost_behat_files {
         $buttonnode->click();
     }
 
-    /**
-     * Opens the contents of a filemanager folder. It looks for the folder in the current folder and in the path bar.
-     *
-     * @Given /^I open "(?P<foldername_string>(?:[^"]|\\")*)" folder from "(?P<filemanager_field_string>(?:[^"]|\\")*)" filemanager$/
-     * @throws ExpectationException Thrown by behat_base::find
-     * @param string $foldername
-     * @param string $filemanagerelement
-     */
     public function i_open_folder_from_filemanager($foldername, $filemanagerelement) {
 
         $fieldnode = $this->get_filepicker_node($filemanagerelement);
 
         $exception = new ExpectationException(
-            'The "'.$foldername.'" folder can not be found in the "'.$filemanagerelement.'" filemanager',
-            $this->getSession()
+                'The "'.$foldername.'" folder can not be found in the "'.$filemanagerelement.'" filemanager',
+                $this->getSession()
         );
 
         $folderliteral = behat_context_helper::escape($foldername);
@@ -88,22 +74,22 @@ class behat_theme_boost_behat_filepicker extends behat_theme_boost_behat_files {
 
             // In the current folder workspace.
             $folder = $this->find(
-                'xpath',
-                "//div[contains(concat(' ', normalize-space(@class), ' '), ' fp-folder ')]" .
+                    'xpath',
+                    "//div[contains(concat(' ', normalize-space(@class), ' '), ' fp-folder ')]" .
                     "/descendant::div[contains(concat(' ', normalize-space(@class), ' '), ' fp-filename ')]" .
                     "[normalize-space(.)=$folderliteral]",
-                $exception,
-                $fieldnode
+                    $exception,
+                    $fieldnode
             );
         } catch (ExpectationException $e) {
 
             // And in the pathbar.
             $folder = $this->find(
-                'xpath',
-                "//a[contains(concat(' ', normalize-space(@class), ' '), ' fp-path-folder-name ')]" .
+                    'xpath',
+                    "//a[contains(concat(' ', normalize-space(@class), ' '), ' fp-path-folder-name ')]" .
                     "[normalize-space(.)=$folderliteral]",
-                $exception,
-                $fieldnode
+                    $exception,
+                    $fieldnode
             );
         }
 
@@ -111,14 +97,6 @@ class behat_theme_boost_behat_filepicker extends behat_theme_boost_behat_files {
         $folder->click();
     }
 
-    /**
-     * Unzips the specified file from the specified filemanager field. The zip file has to be visible in the current folder.
-     *
-     * @Given /^I unzip "(?P<filename_string>(?:[^"]|\\")*)" file from "(?P<filemanager_field_string>(?:[^"]|\\")*)" filemanager$/
-     * @throws ExpectationException Thrown by behat_base::find
-     * @param string $filename
-     * @param string $filemanagerelement
-     */
     public function i_unzip_file_from_filemanager($filename, $filemanagerelement) {
 
         // Open the contextual menu of the filemanager element.
@@ -129,14 +107,6 @@ class behat_theme_boost_behat_filepicker extends behat_theme_boost_behat_files {
         $this->perform_on_element('unzip', $exception);
     }
 
-    /**
-     * Zips the specified folder from the specified filemanager field. The folder has to be in the current folder.
-     *
-     * @Given /^I zip "(?P<filename_string>(?:[^"]|\\")*)" folder from "(?P<filemanager_field_string>(?:[^"]|\\")*)" filemanager$/
-     * @throws ExpectationException Thrown by behat_base::find
-     * @param string $foldername
-     * @param string $filemanagerelement
-     */
     public function i_zip_folder_from_filemanager($foldername, $filemanagerelement) {
 
         // Open the contextual menu of the filemanager element.
@@ -147,14 +117,6 @@ class behat_theme_boost_behat_filepicker extends behat_theme_boost_behat_files {
         $this->perform_on_element('zip', $exception);
     }
 
-    /**
-     * Deletes the specified file or folder from the specified filemanager field.
-     *
-     * @Given /^I delete "(?P<file_or_folder_name_string>(?:[^"]|\\")*)" from "(?P<filemanager_field_string>(?:[^"]|\\")*)" filemanager$/
-     * @throws ExpectationException Thrown by behat_base::find
-     * @param string $name
-     * @param string $filemanagerelement
-     */
     public function i_delete_file_from_filemanager($name, $filemanagerelement) {
 
         // Open the contextual menu of the filemanager element.
@@ -170,99 +132,39 @@ class behat_theme_boost_behat_filepicker extends behat_theme_boost_behat_files {
         $okbutton->click();
     }
 
-
-    /**
-     * Makes sure user can see the exact number of elements (files in folders) in the filemanager.
-     *
-     * @Then /^I should see "(?P<elementscount_number>\d+)" elements in "(?P<filemanagerelement_string>(?:[^"]|\\")*)" filemanager$/
-     * @throws ExpectationException Thrown by behat_base::find
-     * @param int $elementscount
-     * @param string $filemanagerelement
-     */
     public function i_should_see_elements_in_filemanager($elementscount, $filemanagerelement) {
         $filemanagernode = $this->get_filepicker_node($filemanagerelement);
 
         // We count .fp-file elements inside a filemanager not being updated.
         $xpath = "//div[contains(concat(' ', normalize-space(@class), ' '), ' filemanager ')]" .
-            "[not(contains(concat(' ', normalize-space(@class), ' '), ' fm-updating '))]" .
-            "//div[contains(concat(' ', normalize-space(@class), ' '), ' fp-content ')]" .
-            "//div[contains(concat(' ', normalize-space(@class), ' '), ' fp-file ')]";
+                "[not(contains(concat(' ', normalize-space(@class), ' '), ' fm-updating '))]" .
+                "//div[contains(concat(' ', normalize-space(@class), ' '), ' fp-content ')]" .
+                "//div[contains(concat(' ', normalize-space(@class), ' '), ' fp-file ')]";
 
         $elements = $this->find_all('xpath', $xpath, false, $filemanagernode);
         if (count($elements) != $elementscount) {
-            throw new ExpectationException('Found '.count($elements).' elements in filemanager. Expected '.$elementscount,
-                 $this->getSession());
+            throw new ExpectationException('Found '.count($elements).' elements in filemanager instead of expected '.$elementscount, $this->getSession());
         }
     }
 
-    /**
-     * Picks the file from repository leaving default values in select file dialogue.
-     *
-     * @When /^I add "(?P<filepath_string>(?:[^"]|\\")*)" file from "(?P<repository_string>(?:[^"]|\\")*)" to "(?P<filemanagerelement_string>(?:[^"]|\\")*)" filemanager$/
-     * @throws ExpectationException Thrown by behat_base::find
-     * @param string $filepath
-     * @param string $repository
-     * @param string $filemanagerelement
-     */
     public function i_add_file_from_repository_to_filemanager($filepath, $repository, $filemanagerelement) {
         $this->add_file_from_repository_to_filemanager($filepath, $repository, $filemanagerelement, new TableNode(array()), false);
     }
 
-    /**
-     * Picks the file from repository leaving default values in select file dialogue and confirming to overwrite an existing file.
-     *
-     * @When /^I add and overwrite "(?P<filepath_string>(?:[^"]|\\")*)" file from "(?P<repository_string>(?:[^"]|\\")*)" to "(?P<filemanagerelement_string>(?:[^"]|\\")*)" filemanager$/
-     * @throws ExpectationException Thrown by behat_base::find
-     * @param string $filepath
-     * @param string $repository
-     * @param string $filemanagerelement
-     */
     public function i_add_and_overwrite_file_from_repository_to_filemanager($filepath, $repository, $filemanagerelement) {
         $this->add_file_from_repository_to_filemanager($filepath, $repository, $filemanagerelement, new TableNode(array()),
                 get_string('overwrite', 'repository'));
     }
 
-    /**
-     * Picks the file from repository filling the form in Select file dialogue.
-     *
-     * @When /^I add "(?P<filepath_string>(?:[^"]|\\")*)" file from "(?P<repository_string>(?:[^"]|\\")*)" to "(?P<filemanager_field_string>(?:[^"]|\\")*)" filemanager as:$/
-     * @throws ExpectationException Thrown by behat_base::find
-     * @param string $filepath
-     * @param string $repository
-     * @param string $filemanagerelement
-     * @param TableNode $data Data to fill the form in Select file dialogue
-     */
     public function i_add_file_from_repository_to_filemanager_as($filepath, $repository, $filemanagerelement, TableNode $data) {
         $this->add_file_from_repository_to_filemanager($filepath, $repository, $filemanagerelement, $data, false);
     }
 
-    /**
-     * Picks the file from repository confirming to overwrite an existing file
-     *
-     * @When /^I add and overwrite "(?P<filepath_string>(?:[^"]|\\")*)" file from "(?P<repository_string>(?:[^"]|\\")*)" to "(?P<filemanager_field_string>(?:[^"]|\\")*)" filemanager as:$/
-     * @throws ExpectationException Thrown by behat_base::find
-     * @param string $filepath
-     * @param string $repository
-     * @param string $filemanagerelement
-     * @param TableNode $data Data to fill the form in Select file dialogue
-     */
-    public function i_add_and_overwrite_file_from_repository_to_filemanager_as($filepath, $repository, $filemanagerelement,
-            TableNode $data) {
+    public function i_add_and_overwrite_file_from_repository_to_filemanager_as($filepath, $repository, $filemanagerelement, TableNode $data) {
         $this->add_file_from_repository_to_filemanager($filepath, $repository, $filemanagerelement, $data,
                 get_string('overwrite', 'repository'));
     }
 
-    /**
-     * Picks the file from private files repository
-     *
-     * @throws ExpectationException Thrown by behat_base::find
-     * @param string $filepath
-     * @param string $repository
-     * @param string $filemanagerelement
-     * @param TableNode $data Data to fill the form in Select file dialogue
-     * @param false|string $overwriteaction false if we don't expect that file with the same name already exists,
-     *     or button text in overwrite dialogue ("Overwrite", "Rename to ...", "Cancel")
-     */
     protected function add_file_from_repository_to_filemanager($filepath, $repository, $filemanagerelement, TableNode $data,
             $overwriteaction = false) {
         $filemanagernode = $this->get_filepicker_node($filemanagerelement);