Proyectos de Subversion Moodle

<?php

// This file is part of Moodle - http://moodle.org/

//

// Moodle is free software: you can redistribute it and/or modify

// it under the terms of the GNU General Public License as published by

// the Free Software Foundation, either version 3 of the License, or

// (at your option) any later version.

//

// Moodle is distributed in the hope that it will be useful,

// but WITHOUT ANY WARRANTY; without even the implied warranty of

// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

// GNU General Public License for more details.

//

// You should have received a copy of the GNU General Public License

// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

// NOTE: no MOODLE_INTERNAL test here, this file may be required by behat before including /config.php.

require_once(__DIR__ . '/../../../lib/behat/behat_base.php');

/**

 * Behat grade related steps definitions.

 *

 * @package    core_grades

 * @copyright  2022 Mathew May <mathew.solutions>

 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

 */

class behat_grades extends behat_base {

    /**

     * Return the list of partial named selectors.

     *

     * @return array

     */

    public static function get_partial_named_selectors(): array {

        return [

            new behat_component_named_selector(

                'initials bar',

                [".//*[contains(concat(' ', @class, ' '), ' initialbar ')]//span[contains(., %locator%)]/parent::div"]

            ),

            new behat_component_named_selector(

                'grade_actions',

                ["//td[count(//table[@id='user-grades']//th[contains(., %locator%)]/preceding-sibling::th)]//*[@data-type='grade']"]

            ),

            new behat_component_named_selector(

                'gradeitem modal',

                [".//*[contains(concat(' ', @class, ' '), ' modal ')]"]

            ),

        ];

    }

    /**

     * Convert page names to URLs for steps like 'When I am on the "[identifier]" "[page type]" page'.

     *

     * Recognised page names are:

     * | pagetype              | name meaning | description                                       |

     * | [report] view         | Course name  | The view page for the specified course and report |

     * | gradebook setup       | Course name  | The gradebook setup page for the specified course |

     * | course grade settings | Course name  | The grade settings page                           |

     * | outcomes              | Course name  | The grade outcomes page                           |

     * | scales                | Course name  | The grade scales page                             |

     *

     * @param string $type identifies which type of page this is - for example "Grader > View"

     * @param string $identifier identifies the particular page - for example "Course name"

     * @return moodle_url the corresponding URL.

     */

    protected function resolve_page_instance_url(string $type, string $identifier): moodle_url {

        $type = strtolower($type);

        if (strpos($type, '>') !== false) {

            [$pluginname, $type] = explode('>', $type);

            $pluginname = strtolower(trim($pluginname));

            // Fetch the list of plugins.

            $plugins = \core_component::get_plugin_list('gradereport');

            if (array_key_exists($pluginname, $plugins)) {

                $plugin = $pluginname;

            } else {

                $plugins = array_combine(

                    array_keys($plugins),

                    array_keys($plugins),

                );

                // This plugin is not in the list of plugins. Check the pluginname string.

                $names = array_map(fn($name) => strtolower(get_string('pluginname', "gradereport_{$name}")), $plugins);

                $result = array_search($pluginname, $names);

                if ($result === false) {

                    throw new \coding_exception("Unknown plugin '{$pluginname}'");

                }

                $plugin = $result;

            }

        }

        $type = trim($type);

        switch ($type) {

            case 'view':

                return new moodle_url(

                    "/grade/report/{$plugin}/index.php",

                    ['id' => $this->get_course_id($identifier)]

                );

            case 'gradebook setup':

                return new moodle_url(

                    "/grade/edit/tree/index.php",

                    ['id' => $this->get_course_id($identifier)]

                );

            case 'course grade settings':

                return new moodle_url(

                    "/grade/edit/settings/index.php",

                    ['id' => $this->get_course_id($identifier)]

                );

            case 'outcomes':

                return new moodle_url(

                    "/grade/edit/outcome/course.php",

                    ['id' => $this->get_course_id($identifier)]

                );

            case 'scales':

                return new moodle_url(

                    "/grade/edit/scale/index.php",

                    ['id' => $this->get_course_id($identifier)]

                );

            default:

                throw new \coding_exception(

                    "Unknown page type '$type' for page identifier '$identifier'"

                );

        }

    }

    /**

     * Select a given element within a specific container instance.

     *

     * @Given /^I select "(?P<input_value>(?:[^"]|\\")*)" in the "(?P<instance>(?:[^"]|\\")*)" "(?P<instance_type>(?:[^"]|\\")*)"$/

     * @param string $value The Needle

     * @param string  $element The Haystack to select within

     * @param string $selectortype What type of haystack we are looking in

     */

    public function i_select_in_the($value, $element, $selectortype) {

        // Getting the container where the text should be found.

        $container = $this->get_selected_node($selectortype, $element);

        if ($this->getSession()->getPage()->find('xpath', './/input[@value="' . $value . '"]')) {

            $node = $this->find('xpath', './/input[@value="' . $value . '"]', false, $container);

            $node->click();

        } else {

            $node = $this->find('xpath', './/button[@data-action="' . strtolower($value) . '"]', false, $container);

            $node->press();

        }

    }

    /**

     * Gets the grade id from its grade item name and userid.

     *

     * @param int $itemid Item ID

     * @param int $userid User ID

     * @return int

     * @throws Exception

     */

    protected function get_grade_id(int $itemid, int $userid): int {

        global $DB;

        if ($id = $DB->get_field('grade_grades', 'id', ['itemid' => $itemid, 'userid' => $userid])) {

            return $id;

        }

        throw new Exception('The specified grade with id "' . $itemid . ' and userid' . $userid . '" does not exist');

    }

    /**

     * Gets the grade item id from its name.

     *

     * @throws Exception

     * @param string $itemname Item name

     * @return int

     */

    protected function get_grade_item_id(string $itemname): int {

        global $DB;

        if ($id = $DB->get_field('grade_items', 'id', ['itemname' => $itemname])) {

            return $id;

        }

        // The course total is a special case.

        if ($itemname === "Course total") {

            if (!$id = $DB->get_field('grade_items', 'id', ['itemtype' => 'course'])) {

                throw new Exception('The specified grade_item with name "' . $itemname . '" does not exist');

            }

            return $id;

        }

        // Find a category with the name.

        if ($catid = $DB->get_field('grade_categories', 'id', ['fullname' => $itemname])) {

            if ($id = $DB->get_field('grade_items', 'id', ['iteminstance' => $catid])) {

                return $id;

            }

        }

        throw new Exception('The specified grade_item with name "' . $itemname . '" does not exist');

    }

    /**

     * Gets course grade category id from coursename.

     *

     * @throws Exception

     * @param string $coursename

     * @return int

     */

    protected function get_course_grade_category_id(string $coursename): int {

        global $DB;

        $sql = "SELECT gc.id

                  FROM {grade_categories} gc

             LEFT JOIN {course} c

                    ON c.id = gc.courseid

                 WHERE c.fullname = ?

                   AND gc.depth = 1";

        if ($id = $DB->get_field_sql($sql, [$coursename])) {

            return $id;

        }

        throw new Exception('The specified course grade category with course name "' . $coursename . '" does not exist');

    }

    /**

     * Gets grade category id from its name.

     *

     * @throws Exception

     * @param string $categoryname

     * @return int

     */

    protected function get_grade_category_id(string $categoryname): int {

        global $DB;

        $sql = "SELECT gc.id

                  FROM {grade_categories} gc

             LEFT JOIN {course} c

                    ON c.id = gc.courseid

                 WHERE gc.fullname = ?";

        if ($id = $DB->get_field_sql($sql, [$categoryname])) {

            return $id;

        }

        throw new Exception('The specified grade category with name "' . $categoryname . '" does not exist');

    }

    /**

     * Clicks on given grade item menu.

     *

     * @Given /^I click on grade item menu "([^"]*)" of type "([^"]*)" on "([^"]*)" page$/

     * @param string $itemname Item name

     * @param string $itemtype Item type - grade item, category or course

     * @param string $page Page - setup or grader

     * @throws Exception

     */

    public function i_click_on_grade_item_menu(string $itemname, string $itemtype, string $page) {

        $this->execute("behat_navigation::i_close_block_drawer_if_open");

        if ($itemtype == 'gradeitem') {

            $itemid = $this->get_grade_item_id($itemname);

        } else if ($itemtype == 'category') {

            $itemid = $this->get_grade_category_id($itemname);

        } else if ($itemtype == 'course') {

            $itemid = $this->get_course_grade_category_id($itemname);

        } else {

            throw new Exception('Unknown item type: ' . $itemtype);

        }

        $xpath = "//table[@id='grade_edit_tree_table']";

        if (($page == 'grader') || ($page == 'setup')) {

            if ($page == 'grader') {

                $xpath = "//table[@id='user-grades']";

            }

            if ($itemtype == 'gradeitem') {

                $xpath .= "//*[@data-type='item'][@data-id='" . $itemid . "']";

            } else if (($itemtype == 'category') || ($itemtype == 'course')) {

                $xpath .= "//*[@data-type='category'][@data-id='" . $itemid . "']";

            } else {

                throw new Exception('Unknown item type: ' . $itemtype);

            }

        } else {

            throw new Exception('Unknown page: ' . $page);

        }

        $node = $this->get_selected_node("xpath_element", $this->escape($xpath));

        $this->execute_js_on_node($node, '{{ELEMENT}}.scrollIntoView({ block: "center", inline: "center" })');

        $this->execute("behat_general::i_click_on", [$this->escape($xpath), "xpath_element"]);

    }

    /**

     * Clicks on given grade menu.

     *

     * @Given /^I click on grade menu "([^"]*)" for user "([^"]*)"$/

     * @param string $itemname Item name

     * @param string $username User name

     * @throws Exception

     */

    public function i_click_on_grade_menu(string $itemname, string $username) {

        $this->execute("behat_navigation::i_close_block_drawer_if_open");

        $userid = $this->get_user_id_by_identifier($username);

        $itemid = $this->get_grade_item_id($itemname);

        $gradeid = $this->get_grade_id($itemid, $userid);

        $xpath = "//table[@id='user-grades']";

        $xpath .= "//*[@data-type='grade'][@data-id='" . $gradeid . "']";

        $node = $this->get_selected_node("xpath_element", $this->escape($xpath));

        $this->execute_js_on_node($node, '{{ELEMENT}}.scrollIntoView({ block: "center", inline: "center" })');

        $this->execute("behat_general::i_click_on", [$this->escape($xpath), "xpath_element"]);

    }

}