backup/util/ui/tests/behat/behat_backup.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/>.
  16
  17 /**
  18  * Backup and restore actions to help behat feature files writting.
  19  *
  20  * @package    core
  21  * @category   test
  22  * @copyright  2013 David Monllaó
  23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24  */
  25
  26 // NOTE: no MOODLE_INTERNAL test here, this file may be required by behat before including /config.php.
  27
  28 require_once(__DIR__ . '/../../../../../lib/behat/behat_base.php');
  29 require_once(__DIR__ . '/../../../../../lib/behat/behat_field_manager.php');
  30
  31 use Behat\Gherkin\Node\TableNode as TableNode,
  32     Behat\Mink\Exception\ElementNotFoundException as ElementNotFoundException,
  33     Behat\Mink\Exception\ExpectationException as ExpectationException;
  34
  35 /**
  36  * Backup-related steps definitions.
  37  *
  38  * @package    core
  39  * @category   test
  40  * @copyright  2013 David Monllaó
  41  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  42  */
  43 class behat_backup extends behat_base {
  44
  45     /**
  46      * Backups the specified course using the provided options. If you are interested in restoring this backup would be useful to provide a 'Filename' option.
  47      *
  48      * @Given /^I backup "(?P<course_fullname_string>(?:[^"]|\\")*)" course using this options:$/
  49      * @param string $backupcourse
  50      * @param TableNode $options Backup options or false if no options provided
  51      */
  52     public function i_backup_course_using_this_options($backupcourse, $options = false) {
  53
  54         // We can not use other steps here as we don't know where the provided data
  55         // table elements are used, and we need to catch exceptions contantly.
  56
  57         // Go to homepage.
  58         $this->getSession()->visit($this->locate_path('/'));
  59
  60         // Click the course link.
  61         $this->find_link($backupcourse)->click();
  62
  63         // Click the backup link.
  64         $this->find_link('Backup')->click();
  65
  66         // Initial settings.
  67         $this->fill_backup_restore_form($options);
  68         $this->find_button('Next')->press();
  69
  70         // Schema settings.
  71         $this->fill_backup_restore_form($options);
  72         $this->find_button('Next')->press();
  73
  74         // Confirmation and review, backup filename can also be specified.
  75         $this->fill_backup_restore_form($options);
  76         $this->find_button('Perform backup')->press();
  77
  78         // Waiting for it to finish.
  79         $this->wait(10);
  80
  81         // Last backup continue button.
  82         $this->find_button('Continue')->press();
  83     }
  84
  85     /**
  86      * Imports the specified origin course into the other course using the provided options.
  87      *
  88      * Keeping it separatelly from backup & restore, it the number of
  89      * steps and duplicate code becomes bigger a common method should
  90      * be generalized.
  91      *
  92      * @Given /^I import "(?P<from_course_fullname_string>(?:[^"]|\\")*)" course into "(?P<to_course_fullname_string>(?:[^"]|\\")*)" course using this options:$/
  93      * @param string $fromcourse
  94      * @param string $tocourse
  95      * @param TableNode $options
  96      */
  97     public function i_import_course_into_course($fromcourse, $tocourse, $options = false) {
  98
  99         // We can not use other steps here as we don't know where the provided data
 100         // table elements are used, and we need to catch exceptions contantly.
 101
 102         // Go to homepage.
 103         $this->getSession()->visit($this->locate_path('/'));
 104
 105         // Click the course link.
 106         $this->find_link($tocourse)->click();
 107
 108         // Click the backup link.
 109         $this->find_link('Import')->click();
 110
 111         // Select the course.
 112         $exception = new ExpectationException('"' . $fromcourse . '" course not found in the list of courses to import from', $this->getSession());
 113
 114         $fromcourse = str_replace("'", "\'", $fromcourse);
 115         $xpath = "//div[contains(concat(' ', @class, ' '), ' ics-results ')]" .
 116             "/descendant::tr[contains(., '" . $fromcourse . "')]" .
 117             "/descendant::input[@type='radio']";
 118         $radionode = $this->find('xpath', $xpath, $exception);
 119         $radionode->check();
 120         $radionode->click();
 121
 122         $this->find_button('Continue')->press();
 123
 124         // Initial settings.
 125         $this->fill_backup_restore_form($options);
 126         $this->find_button('Next')->press();
 127
 128         // Schema settings.
 129         $this->fill_backup_restore_form($options);
 130         $this->find_button('Next')->press();
 131
 132         // Run it.
 133         $this->find_button('Perform import')->press();
 134         $this->wait();
 135
 136         // Continue and redirect to 'to' course.
 137         $this->find_button('Continue')->press();
 138     }
 139
 140     /**
 141      * Restores the backup into the specified course and the provided options. You should be in the 'Restore' page where the backup is.
 142      *
 143      * @Given /^I restore "(?P<backup_filename_string>(?:[^"]|\\")*)" backup into "(?P<existing_course_fullname_string>(?:[^"]|\\")*)" course using this options:$/
 144      * @param string $backupfilename
 145      * @param string $existingcourse
 146      * @param TableNode $options Restore forms options or false if no options provided
 147      */
 148     public function i_restore_backup_into_course_using_this_options($backupfilename, $existingcourse, $options = false) {
 149
 150         // Confirm restore.
 151         $this->select_backup($backupfilename);
 152
 153         // Selecting the specified course (we can not call behat_forms::select_radio here as is in another behat subcontext).
 154         $existingcourse = str_replace("'", "\'", $existingcourse);
 155         $radionode = $this->find('xpath', "//div[contains(@class, 'bcs-existing-course')]" .
 156             "/descendant::div[@class='restore-course-search']" .
 157             "/descendant::tr[contains(., '" . $existingcourse . "')]" .
 158             "/descendant::input[@type='radio']");
 159         $radionode->check();
 160         $radionode->click();
 161
 162         // Pressing the continue button of the restore into an existing course section.
 163         $continuenode = $this->find('xpath', "//div[contains(@class, 'bcs-existing-course')]/descendant::input[@type='submit'][@value='Continue']");
 164         $continuenode->click();
 165         $this->wait();
 166
 167         // Common restore process using provided key/value options.
 168         $this->process_restore($options);
 169     }
 170
 171     /**
 172      * Restores the specified backup into a new course using the provided options. You should be in the 'Restore' page where the backup is.
 173      *
 174      * @Given /^I restore "(?P<backup_filename_string>(?:[^"]|\\")*)" backup into a new course using this options:$/
 175      * @param string $backupfilename
 176      * @param TableNode $options Restore forms options or false if no options provided
 177      */
 178     public function i_restore_backup_into_a_new_course_using_this_options($backupfilename, $options = false) {
 179
 180         // Confirm restore.
 181         $this->select_backup($backupfilename);
 182
 183         // The first category in the list.
 184         $radionode = $this->find('xpath', "//div[contains(@class, 'bcs-new-course')]" .
 185             "/descendant::div[@class='restore-course-search']" .
 186             "/descendant::input[@type='radio']");
 187         $radionode->check();
 188         $radionode->click();
 189
 190         // Pressing the continue button of the restore into an existing course section.
 191         $continuenode = $this->find('xpath', "//div[contains(@class, 'bcs-new-course')]/descendant::input[@type='submit'][@value='Continue']");
 192         $continuenode->click();
 193         $this->wait();
 194
 195         // Common restore process using provided key/value options.
 196         $this->process_restore($options);
 197     }
 198
 199     /**
 200      * Merges the backup into the current course using the provided restore options. You should be in the 'Restore' page where the backup is.
 201      *
 202      * @Given /^I merge "(?P<backup_filename_string>(?:[^"]|\\")*)" backup into the current course using this options:$/
 203      * @param string $backupfilename
 204      * @param TableNode $options Restore forms options or false if no options provided
 205      */
 206     public function i_merge_backup_into_the_current_course($backupfilename, $options = false) {
 207
 208         // Confirm restore.
 209         $this->select_backup($backupfilename);
 210
 211         // Merge without deleting radio option.
 212         $radionode = $this->find('xpath', "//div[contains(@class, 'bcs-current-course')]" .
 213             "/descendant::input[@type='radio'][@name='target'][@value='1']");
 214         $radionode->check();
 215         $radionode->click();
 216
 217         // Pressing the continue button of the restore merging section.
 218         $continuenode = $this->find('xpath', "//div[contains(@class, 'bcs-current-course')]" .
 219             "/descendant::input[@type='submit'][@value='Continue']");
 220         $continuenode->click();
 221         $this->wait();
 222
 223         // Common restore process using provided key/value options.
 224         $this->process_restore($options);
 225     }
 226
 227     /**
 228      * Merges the backup into the current course after deleting this contents, using the provided restore options. You should be in the 'Restore' page where the backup is.
 229      *
 230      * @Given /^I merge "(?P<backup_filename_string>(?:[^"]|\\")*)" backup into the current course after deleting it's contents using this options:$/
 231      * @param string $backupfilename
 232      * @param TableNode $options Restore forms options or false if no options provided
 233      */
 234     public function i_merge_backup_into_current_course_deleting_its_contents($backupfilename, $options = false) {
 235
 236         // Confirm restore.
 237         $this->select_backup($backupfilename);
 238
 239         // Delete contents radio option.
 240         $radionode = $this->find('xpath', "//div[contains(@class, 'bcs-current-course')]" .
 241             "/descendant::input[@type='radio'][@name='target'][@value='0']");
 242         $radionode->check();
 243         $radionode->click();
 244
 245         // Pressing the continue button of the restore merging section.
 246         $continuenode = $this->find('xpath', "//div[contains(@class, 'bcs-current-course')]" .
 247             "/descendant::input[@type='submit'][@value='Continue']");
 248         $continuenode->click();
 249         $this->wait();
 250
 251         // Common restore process using provided key/value options.
 252         $this->process_restore($options);
 253     }
 254
 255     /**
 256      * Selects the backup to restore.
 257      *
 258      * @throws ExpectationException
 259      * @param string $backupfilename
 260      * @return void
 261      */
 262     protected function select_backup($backupfilename) {
 263
 264         // Using xpath as there are other restore links before this one.
 265         $exception = new ExpectationException('The "' . $backupfilename . '" backup file can not be found in this page', $this->getSession());
 266         $xpath = "//tr[contains(., '" . $backupfilename . "')]/descendant::a[contains(., 'Restore')]";
 267         $restorelink = $this->find('xpath', $xpath, $exception);
 268         $restorelink->click();
 269
 270         // Confirm the backup contents.
 271         $restore = $this->find_button('Continue')->press();
 272     }
 273
 274     /**
 275      * Executes the common steps of all restore processes.
 276      *
 277      * @param TableNode $options The backup and restore options or false if no options provided
 278      * @return void
 279      */
 280     protected function process_restore($options) {
 281
 282         // We can not use other steps here as we don't know where the provided data
 283         // table elements are used, and we need to catch exceptions contantly.
 284
 285         // Settings.
 286         $this->fill_backup_restore_form($options);
 287         $this->find_button('Next')->press();
 288
 289         // Schema.
 290         $this->fill_backup_restore_form($options);
 291         $this->find_button('Next')->press();
 292
 293         // Review, no options here.
 294         $this->find_button('Perform restore')->press();
 295         $this->wait(10);
 296
 297         // Last restore continue button, redirected to restore course after this.
 298         $this->find_button('Continue')->press();
 299     }
 300
 301     /**
 302      * Tries to fill the current page form elements with the provided options.
 303      *
 304      * This step is slow as it spins over each provided option, we are
 305      * not expected to have lots of provided options, anyways, is better
 306      * to be conservative and wait for the elements to appear rather than
 307      * to have false failures.
 308      *
 309      * @param TableNode $options The backup and restore options or false if no options provided
 310      * @return void
 311      */
 312     protected function fill_backup_restore_form($options) {
 313
 314         // Nothing to fill if no options are provided.
 315         if (!$options) {
 316             return;
 317         }
 318
 319         // If we find any of the provided options in the current form we should set the value.
 320         $datahash = $options->getRowsHash();
 321         foreach ($datahash as $locator => $value) {
 322
 323             try {
 324                 $fieldnode = $this->find_field($locator);
 325                 $field = behat_field_manager::get_field($fieldnode, $locator, $this->getSession());
 326                 $field->set_value($value);
 327
 328             } catch (ElementNotFoundException $e) {
 329                 // Next provided option then, this one should be part of another page's fields.
 330             }
 331         }
 332     }
 333
 334     /**
 335      * Waits until the DOM is ready.
 336      *
 337      * @param int To override the default timeout
 338      * @return void
 339      */
 340     protected function wait($timeout = false) {
 341
 342         if (!$timeout) {
 343             $timeout = self::TIMEOUT;
 344         }
 345         $this->getSession()->wait($timeout, '(document.readyState === "complete")');
 346     }
 347
 348 }