WebSVN – Moodle – Diff – /lib/tests/behat/behat_general.php

      * Opens Moodle homepage.
+     *
      * @Given /^I am on homepage$/
      */
     public function i_am_on_homepage() {
-        $this->execute('behat_general::i_visit', ['/']);
+        $this->execute([self::class, 'i_visit'], ['/']);
+    }
     /**
      * Opens Moodle site homepage.
+     *
      * @Given /^I am on site homepage$/
      */
     public function i_am_on_site_homepage() {
-        $this->execute('behat_general::i_visit', ['/?redirect=0']);
+        $this->execute([self::class, 'i_visit'], ['/?redirect=0']);
+    }
     /**
      * Opens course index page.
+     *
      * @Given /^I am on course index$/
      */
+    public function i_am_on_course_index() {
+        $this->execute([self::class, 'i_visit'], ['/course/index.php']);
+    }
+    /**
+     * Checks, that current page PATH matches regular expression
+     *
+     * Example: Then the url should match "/course/index\.php"
+     * Example: Then the url should match "/mod/forum/view\.php\?id=[0-9]+"
+     * Example: And the url should match "^http://moodle\.org"
+     *
+     * @Then /^the url should match (?P<pattern>"(?:[^"]|\\")*")$/
+     * @param string $pattern The pattern that must match to the current url.
+     */
+    public function the_url_should_match($pattern) {
+        $url = $this->getSession()->getCurrentUrl();
+        if (preg_match($pattern, $url) === 1) {
+            return;
+        }
     public function i_am_on_course_index() {
-        $this->execute('behat_general::i_visit', ['/course/index.php']);
+        throw new ExpectationException(sprintf('The url "%s" should match with %s', $url, $pattern), $this->getSession());
+    }
+        }
         // Getting the refresh time and the url if present.
         if (strstr($content, 'url') != false) {
-            list($waittime, $url) = explode(';', $content);
+            [$waittime, $url] = explode(';', $content);
      * @param string $element Element we look for
      * @param string $selectortype The type of what we look for
      */
     public function i_click_on_confirming_the_dialogue($element, $selectortype) {
         $this->i_click_on($element, $selectortype);
-        $this->execute('behat_general::accept_currently_displayed_alert_dialog', []);
+        $this->execute([self::class, 'accept_currently_displayed_alert_dialog'], []);
         $this->wait_until_the_page_is_ready();
+    }
     /**
      * @param string $element Element we look for
      * @param string $selectortype The type of what we look for
      */
     public function i_click_on_dismissing_the_dialogue($element, $selectortype) {
         $this->i_click_on($element, $selectortype);
-        $this->execute('behat_general::dismiss_currently_displayed_alert_dialog', []);
+        $this->execute([self::class, 'dismiss_currently_displayed_alert_dialog'], []);
         $this->wait_until_the_page_is_ready();
+    }
     /**
             // Get the container node.
             $containernode = $this->get_selected_node($containerselectortype, $containerelement);
             $msg .= " in the '{$containerelement}' '{$containerselectortype}'";
+        }
-        list($preselector, $prelocator) = $this->transform_selector($preselectortype, $preelement);
+        [$preselector, $prelocator] = $this->transform_selector($preselectortype, $preelement);
-        list($postselector, $postlocator) = $this->transform_selector($postselectortype, $postelement);
+        [$postselector, $postlocator] = $this->transform_selector($postselectortype, $postelement);
-        $newlines = [
-            "\r\n",
-            "\r",
+        $prexpath = $this->prepare_xpath_for_javascript(
-            "\n",
+            $this->find($preselector, $prelocator, false, $containernode)->getXpath()
-        ];
+        );
+        $postxpath = $this->prepare_xpath_for_javascript(
-        $prexpath = str_replace($newlines, ' ', $this->find($preselector, $prelocator, false, $containernode)->getXpath());
+            $this->find($postselector, $postlocator, false, $containernode)->getXpath()
-        $postxpath = str_replace($newlines, ' ', $this->find($postselector, $postlocator, false, $containernode)->getXpath());
+        );
         if ($this->running_javascript()) {
      * This step triggers cron like a user would do going to admin/cron.php.
+     *
      * @Given /^I trigger cron$/
      */
     public function i_trigger_cron() {
-        $this->execute('behat_general::i_visit', ['/admin/cron.php']);
+        $this->execute([self::class, 'i_visit'], ['/admin/cron.php']);
+    }
     /**
      * Runs a scheduled task immediately, given full class name.
      * Example: I change window size to "small" or I change window size to "1024x768"
      * or I change viewport size to "800x600". The viewport option is useful to guarantee that the
      * browser window has same viewport size even when you run Behat on multiple operating systems.
+     *
      * @throws ExpectationException
-     * @Then /^I change (window|viewport) size to "(mobile|tablet|small|medium|large|\d+x\d+)"$/
+     * @Then /^I change (window|viewport) size to "(mobile|tablet|small|medium|large|\d+x\d+)"( without runtime scaling)?$/
-     * @Then /^I change the (window|viewport) size to "(mobile|tablet|small|medium|large|\d+x\d+)"$/
+     * @Then /^I change the (window|viewport) size to "(mobile|tablet|small|medium|large|\d+x\d+)"( without runtime scaling)?$/
+     * @param string $windowviewport Whether this is a window or viewport size hcange
      * @param string $windowsize size of the window (mobile|tablet|small|medium|large|wxh).
+     * @param null|string $scale whether to lock runtime scaling (string) or to allow it (null)
      */
-    public function i_change_window_size_to($windowviewport, $windowsize) {
+    public function i_change_window_size_to(
+        $windowviewport,
+        $windowsize,
+        ?string $scale = null,
+    ): void {
+        $this->resize_window(
+            $windowsize,
-        $this->resize_window($windowsize, $windowviewport === 'viewport');
+            $windowviewport === 'viewport',
+            $scale === null,
+        );
+    }
     /**
      * Checks whether there the specified attribute is set or not.
         // Check if value exists in specific row/column.
         // Get row xpath.
         // Some drivers make XPath relative to the current context, so use descendant.
+        $rowxpath = $tablexpath . "/tbody/tr[descendant::*[@class='rowtitle'][normalize-space(.)=" . $rowliteral . "] | " . "
-        $rowxpath = $tablexpath . "/tbody/tr[descendant::*[@class='rowtitle'][normalize-space(.)=" . $rowliteral . "] | " . "
+            descendant::th[contains(normalize-space(.)," . $rowliteral . ")] | " . "
-            descendant::th[normalize-space(.)=" . $rowliteral . "] | descendant::td[normalize-space(.)=" . $rowliteral . "]]";
+            descendant::td[contains(normalize-space(.)," . $rowliteral . ")]]";
         $columnvaluexpath = $rowxpath . $columnpositionxpath . "[contains(normalize-space(.)," . $valueliteral . ")]";
+    }
     /**
      * Given the text of a link, download the linked file and return the contents.
      *
-     * This is a helper method used by {@link following_should_download_bytes()}
+     * A helper method used by the steps in {@see behat_download}, and the legacy
-     * and {@link following_should_download_between_and_bytes()}
+     * {@see following_should_download_bytes()} and {@see following_should_download_between_and_bytes()}.
+     *
+     * @param string $link the text of the link.
+     * @param string $containerlocator optional container element locator.
+     * @param string $containertype optional container element selector type.
      * @param string $link the text of the link.
      * @return string the content of the downloaded file.
      */
+    public function download_file_from_link(string $link, string $containerlocator = '', string $containertype = ''): string {
     public function download_file_from_link($link) {
+        // Find the link.
+        if ($containerlocator !== '' && $containertype !== '') {
+            $linknode = $this->get_node_in_container('link', $link, $containertype, $containerlocator);
-        // Find the link.
+        } else {
+            $linknode = $this->find_link($link);
+        }
         $linknode = $this->find_link($link);
         $this->ensure_node_is_visible($linknode);
         // Get the href and check it.
+    }
     /**
      * Downloads the file from a link on the page and checks the size.
+     *
+     * Not recommended any more. The steps in {@see behat_download} are much better!
+     *
      * Only works if the link has an href attribute. Javascript downloads are
      * not supported. Currently, the href must be an absolute URL.
+     *
      * @Then /^following "(?P<link_string>[^"]*)" should download "(?P<expected_bytes>\d+)" bytes$/
+    }
     /**
      * Downloads the file from a link on the page and checks the size is in a given range.
+     *
+     * Not recommended any more. The steps in {@see behat_download} are much better!
+     *
      * Only works if the link has an href attribute. Javascript downloads are
      * not supported. Currently, the href must be an absolute URL.
+     *
      * The range includes the endpoints. That is, a 10 byte file in considered to
      * be between "5" and "10" bytes, and between "10" and "20" bytes.
+     *
      * @Then /^following "(?P<link_string>[^"]*)" should download between "(?P<min_bytes>\d+)" and "(?P<max_bytes>\d+)" bytes$/
      * @throws ExpectationException
      * @param string $link the text of the link.
      * @param number $minexpectedsize the minimum expected file size in bytes.
+     * @param number $maxexpectedsize the maximum expected file size in bytes.
-     * @param number $maxexpectedsize the maximum expected file size in bytes.
+     * @throws ExpectationException
      */
     public function following_should_download_between_and_bytes($link, $minexpectedsize, $maxexpectedsize) {
         // If the minimum is greater than the maximum then swap the values.
         if ((int)$minexpectedsize > (int)$maxexpectedsize) {
-            list($minexpectedsize, $maxexpectedsize) = array($maxexpectedsize, $minexpectedsize);
+            [$minexpectedsize, $maxexpectedsize] = [$maxexpectedsize, $minexpectedsize];
+        }
         $node = $this->get_selected_node($selectortype, $element);
         $modifier = null;
         $validmodifiers = array('ctrl', 'alt', 'shift', 'meta');
         $char = $key;
         if (strpos($key, '-')) {
-            list($modifier, $char) = preg_split('/-/', $key, 2);
+            [$modifier, $char] = preg_split('/-/', $key, 2);
             $modifier = strtolower($modifier);
             if (!in_array($modifier, $validmodifiers)) {
                 throw new ExpectationException(sprintf('Unknown key modifier: %s.', $modifier),
                     $this->getSession());
+            }
         if (!$this->running_javascript()) {
             throw new DriverException('Tab press step is not available with Javascript disabled');
+        }
         // Gets the node based on the requested selector type and locator.
         $node = $this->get_selected_node($selectortype, $element);
-        $this->execute('behat_general::i_click_on', [$node, 'NodeElement']);
+        $this->execute([self::class, 'i_click_on'], [$node, 'NodeElement']);
-        $this->execute('behat_general::i_press_named_key', ['', 'tab']);
+        $this->execute([self::class, 'i_press_named_key'], ['', 'tab']);
+    }
     /**
-     * Checks if database family used is using one of the specified, else skip. (mysql, postgres, mssql, oracle, etc.)
+     * Checks if database family used is using one of the specified, else skip. (mysql, postgres, mssql, etc.)
+     *
      * @Given /^database family used is one of the following:$/
      * @param TableNode $databasefamilies list of database.
      * @return void.
      * @param string $shift string optional step verifier
      * @throws DriverException
      */
     public function i_manually_press_tab($shift = '') {
         if (empty($shift)) {
-            $this->execute('behat_general::i_press_named_key', ['', 'tab']);
+            $this->execute([self::class, 'i_press_named_key'], ['', 'tab']);
         } else {
-            $this->execute('behat_general::i_press_named_key', ['shift', 'tab']);
+            $this->execute([self::class, 'i_press_named_key'], ['shift', 'tab']);
+        }
+    }
     /**
+     *
      * @When /^I press enter/
      * @throws DriverException
      */
     public function i_manually_press_enter() {
-        $this->execute('behat_general::i_press_named_key', ['', 'enter']);
+        $this->execute([self::class, 'i_press_named_key'], ['', 'enter']);
+    }
     /**
      * Visit a local URL relative to the behat root.
+     *
      * @param string $tabname
      */
     public function i_click_on_the_dynamic_tab(string $tabname): void {
         $xpath = "//*[@id='dynamictabs-tabs'][descendant::a[contains(text(), '" . $this->escape($tabname) . "')]]";
-        $this->execute('behat_general::i_click_on_in_the',
+        $this->execute([self::class, 'i_click_on_in_the'],
             [$tabname, 'link', $xpath, 'xpath_element']);
+    }
     /**
      * Enable an specific plugin.
+     *
      * @When /^I enable "(?P<plugin_string>(?:[^"]|\\")*)" "(?P<plugintype_string>[^"]*)" plugin$/
      * @param string $plugin Plugin we look for
      * @param string $plugintype The type of the plugin
+     */
-     */
+    #[\core\attribute\example('I enable "subsection" "mod" plugin')]
     public function i_enable_plugin($plugin, $plugintype) {
         $class = core_plugin_manager::resolve_plugininfo_class($plugintype);
         $class::enable_plugin($plugin, true);
+    }
+    /**
+     * Disable an specific plugin.
+     *
+     * @When /^I disable "(?P<plugin_string>(?:[^"]|\\")*)" "(?P<plugintype_string>[^"]*)" plugin$/
+     * @param string $plugin Plugin we look for
+     * @param string $plugintype The type of the plugin
+     */
+    #[\core\attribute\example('I disable "page" "mod" plugin')]
+    public function i_disable_plugin($plugin, $plugintype) {
+        $class = core_plugin_manager::resolve_plugininfo_class($plugintype);
+        $class::enable_plugin($plugin, false);
+    }
     /**
      * Set the default text editor to the named text editor.
+     *
      * @Given the default editor is set to :editor
                 $this->getSession()
             );
+        }
         // Make the provided editor the default one in $CFG->texteditors by
-        // moving it to the first [editor],atto,tiny,textarea on the list.
+        // moving it to the first [editor],tiny,textarea on the list.
         $list = explode(',', $CFG->texteditors);
         array_unshift($list, $editor);
         $list = array_unique($list);
                 "'$title' was not found from the current page title '$actualtitle'",
                 $session
             );
+        }
+    }
+    /**
+     * Toggles the specified admin switch.
+     *
+     * @When /^I toggle the "(?P<element_string>(?:[^"]|\\")*)" admin switch "(?P<state_string>on|off)"$/
+     * @param string $element Element we look for
+     * @param string $state The state of the switch
+     * @throws ElementNotFoundException Thrown by behat_base::find
+     */
+    public function i_toggle_admin_switch($element, $state) {
+        // First check we are running Javascript, otherwise explode.
+        if (!$this->running_javascript()) {
+            throw new \Behat\Mink\Exception\DriverException('Switches are only available with JavaScript enabled');
+        }
+        // Next check that the node is available.
+        $node = $this->get_selected_node('checkbox', $element);
+        $this->ensure_node_is_visible($node);
+        // Update the state of the switch.
+        $field = $node->getAttribute('id');
+        if ($state == "on") {
+            $this->execute([behat_forms::class, 'i_set_the_field_to'], [$field, 1]);
+        } else if ($state == "off") {
+            $this->execute([behat_forms::class, 'i_set_the_field_to'], [$field, 0]);
+        } else {
+            throw new \Behat\Mink\Exception\ExpectationException('Invalid state for switch: ' . $state, $this->getSession());
+        }
+    }
+    /**
+     * Update a stored progress bar.
+     *
+     * @Given I set the stored progress bar :idnumber to :percent
+     * @param string $idnumber The unique idnumber of the stored progress bar.
+     * @param float $percent The value to update the progress bar to.
+     */
+    public function i_set_the_stored_progress_bar_to(string $idnumber, float $percent): void {
+        $progress = \core\output\stored_progress_bar::get_by_idnumber($idnumber);
+        if (!$progress) {
+            throw new invalid_parameter_exception('No progress bar with idnumber ' . $idnumber . 'found.');
+        }
+        $progress->auto_update(false);
+        $progress->update_full($percent, '');
+    }
+    /**
+     * Helper that returns the dropdown node element within a particular search combo box.
+     *
+     * @param string $comboboxname The name (label) of the search combo box element. (e.g. "Search users", "Search groups").
+     * @param string $itemname The name of the combo box item we are searching for. This is only used if $fieldset is set
+     *                         to true.
+     * @param bool $fieldset Whether to set the search field of the combo box at the same time
+     * @return NodeElement
+     * @throws coding_exception
+     */
+    private function get_combobox_dropdown_node(string $comboboxname, string $itemname, bool $fieldset = true): NodeElement {
+        $this->execute([self::class, 'wait_until_the_page_is_ready']);
+        $comboboxxpath = "//div[contains(@class, 'comboboxsearch') and .//span[text()='{$comboboxname}']]";
+        $dropdowntriggerxpath = $comboboxxpath . "/descendant::div[contains(@class,'dropdown-toggle')]";
+        $dropdownxpath = $comboboxxpath . "/descendant::div[contains(@class,'dropdown-menu')]";
+        $dropdown = $this->find("xpath_element", $dropdownxpath);
+        // If the dropdown is not visible, open it. Also, ensure that a dropdown trigger element exists.
+        if ($this->getSession()->getPage()->find('xpath', $dropdowntriggerxpath) && !$dropdown->isVisible()) {
+            $this->execute([self::class, 'i_click_on'], [$dropdowntriggerxpath, "xpath_element"]);
+        }
+        if ($fieldset) {
+            $this->execute([behat_forms::class, 'set_field_value'], [$comboboxname, $itemname]);
+            $this->execute([self::class, 'wait_until_exists'], [$itemname, "list_item"]);
+        }
+        return $dropdown;
+    }
+    /**
+     * Confirm if a value exists within the search combo box.
+     *
+     * Examples:
+     * - I confirm "User" exists in the "Search users" search combo box
+     * - I confirm "Group" exists in the "Search groups" search combo box
+     * - I confirm "Grade item" exists in the "Search grade items" search combo box
+     *
+     * @Given /^I confirm "(?P<itemname>(?:[^"]|\\")*)" exists in the "(?P<comboboxname>(?:[^"]|\\")*)" search combo box$/
+     * @param string $itemname The name of the combo box item we are searching for. This is only used if $fieldset is set
+     *                         to true.
+     * @param string $comboboxname The name (label) of the search combo box element. (e.g. "Search users", "Search groups").
+     */
+    public function i_confirm_in_search_combobox_exists(string $itemname, string $comboboxname): void {
+        $this->execute([self::class, 'assert_element_contains_text'],
+            [$itemname, $this->get_combobox_dropdown_node($comboboxname, $itemname, false), "NodeElement"]);
+    }
+    /**
+     * Confirm if a value does not exist within the search combo box.
+     *
+     * Examples:
+     * - I confirm "User" does not exist in the "Search users" search combo box
+     * - I confirm "Group" does not exist in the "Search groups" search combo box
+     * - I confirm "Grade item" does not exist in the "Search grade items" search combo box
+     *
+     * @Given /^I confirm "(?P<itemname>(?:[^"]|\\")*)" does not exist in the "(?P<comboboxname>(?:[^"]|\\")*)" search combo box$/
+     * @param string $itemname The name of the combo box item we are searching for. This is only used if $fieldset is set
+     *                         to true.
+     * @param string $comboboxname The name (label) of the search combo box element. (e.g. "Search users", "Search groups").
+     */
+    public function i_confirm_in_search_combobox_does_not_exist(string $itemname, string $comboboxname): void {
+        $this->execute([self::class, 'assert_element_not_contains_text'],
+            [$itemname, $this->get_combobox_dropdown_node($comboboxname, $itemname, false), "NodeElement"]);
+    }
+    /**
+     * Clicks on an option from the specified search widget.
+     *
+     * Examples:
+     * - I click on "Student" in the "Search users" search combo box
+     * - I click on "Group" in the "Search groups" search combo box
+     * - I click on "Grade item" in the "Search grade items" search combo box
+     *
+     * @Given /^I click on "(?P<itemname>(?:[^"]|\\")*)" in the "(?P<comboboxname>(?:[^"]|\\")*)" search combo box$/
+     * @param string $itemname The name of the combo box item we are searching for. This is only used if $fieldset is set
+     *                         to true.
+     * @param string $comboboxname The name (label) of the search combo box element. (e.g. "Search users", "Search groups").
+     */
+    public function i_click_on_in_search_combobox(string $itemname, string $comboboxname): void {
+        $node = $this->get_combobox_dropdown_node($comboboxname, $itemname);
+        $this->execute([self::class, 'i_click_on_in_the'], [
+            $itemname, "list_item",
+            $node, "NodeElement",
+        ]);
+        $this->execute([self::class, 'i_wait_to_be_redirected']);
+    }
+    /**
+     * Clicks on a specific link within a table row.
+     * Good for clicking links on tables where links have repeated text in diiferent rows.
+     *
+     * Example:
+     * - I click on the "Settings" link in the row containing "Text editor placement"
+     *
+     * @Given /^I click on the "(?P<linktext>(?:[^"]|\\")*)" link in the table row containing "(?P<rowtext>(?:[^"]|\\")*)"$/
+     * @param string $linktext
+     * @param string $rowtext
+     */
+    public function i_click_on_the_link_in_the_table_row_containing(string $linktext, string $rowtext): void {
+        $row = $this->getSession()->getPage()->find('xpath', "//tr[contains(., '{$rowtext}')]");
+        if (!$row) {
+            throw new Exception("Row containing '{$rowtext}' not found");
+        }
+        $link = $row->findLink($linktext);
+        if (!$link) {
+            throw new Exception("Link '{$linktext}' not found in the row containing '{$rowtext}'");
+        }
+        $link->click();
+    }
+    /**
+     * Checks if a specific text is present in a table row.
+     * Good for checking text in tables where text is repeated in different rows.
+     *
+     * Example:
+     * - I should see "This action is unavailable." in the table row containing "Generate text"
+     *
+     * @Then /^I should see "(?P<text>(?:[^"]|\\")*)" in the table row containing "(?P<rowtext>(?:[^"]|\\")*)"$/
+     * @param string $text
+     * @param string $rowtext
+     */
+    public function i_should_see_in_the_table_row_containing(string $text, string $rowtext): void {
+        $row = $this->getSession()->getPage()->find('xpath', "//tr[contains(., '{$rowtext}')]");
+        if (!$row) {
+            throw new Exception("Row containing '{$rowtext}' not found");
+        }
+        if (strpos($row->getText(), $text) === false) {
+            throw new Exception("Text '{$text}' not found in the row containing '{$rowtext}'");
+        }
+    }
+    /**
+     * Checks if a specific text is not present in a table row.
+     * Good for checking text in tables where text is repeated in different rows.
+     *
+     * Example:
+     * - I should not see "This action is unavailable." in the table row containing "Generate text"
+     *
+     * @Then /^I should not see "(?P<text>(?:[^"]|\\")*)" in the table row containing "(?P<rowtext>(?:[^"]|\\")*)"$/
+     * @param string $text
+     * @param string $rowtext
+     */
+    public function i_should_not_see_in_the_table_row_containing(string $text, string $rowtext): void {
+        $row = $this->getSession()->getPage()->find('xpath', "//tr[contains(., '{$rowtext}')]");
+        if (!$row) {
+            throw new Exception("Row containing '{$rowtext}' not found");
+        }
+        if (strpos($row->getText(), $text) !== false) {
+            throw new Exception("Text '{$text}' found in the row containing '{$rowtext}'");
+        }
+    }
+    /**
+     * Sets the current time for the remainder of this Behat test.
+     *
+     * This is not supported everywhere in Moodle: if code uses \core\clock through DI then
+     * it will work, but if it just calls time() it will still get the real time.
+     *
+     * @Given the time is frozen at :datetime
+     * @param string $datetime Date and time in a format that strtotime understands
+     */
+    public function the_time_is_frozen_at(string $datetime): void {
+        global $CFG;
+        require_once($CFG->libdir . '/testing/classes/frozen_clock.php');
+        $timestamp = strtotime($datetime);
+        // The config variable is used to set up a frozen clock in each Behat web request.
+        set_config('behat_frozen_clock', $timestamp);
+        // Simply setting a frozen clock in DI should work for future steps in Behat CLI process.
+        \core\di::set(\core\clock::class, new \frozen_clock($timestamp));
+    }
+    /**
+     * Stops freezing time so that it goes back to real time.
+     *
+     * @Given the time is no longer frozen
+     */
+    public function the_time_is_no_longer_frozen(): void {
+        unset_config('behat_frozen_clock');
+        \core\di::set(\core\clock::class, new \core\system_clock());
+    }
+}

Proyectos de Subversion Moodle

(root)/lib/tests/behat/behat_general.php – Rev 11 → 1441