user/tests/behat/behat_user.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  * User steps definition.
  19  *
  20  * @package    core_user
  21  * @category   test
  22  * @copyright  2017 Damyon Wiese
  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
  30 use Behat\Mink\Exception\ExpectationException as ExpectationException;
  31
  32 /**
  33  * Steps definitions for users.
  34  *
  35  * @package    core_user
  36  * @category   test
  37  * @copyright  2017 Damyon Wiese
  38  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  39  */
  40 class behat_user extends behat_base {
  41
  42     /**
  43      * Choose from the bulk action menu.
  44      *
  45      * @Given /^I choose "(?P<nodetext_string>(?:[^"]|\\")*)" from the participants page bulk action menu$/
  46      * @param string $nodetext The menu item to select.
  47      */
  48     public function i_choose_from_the_participants_page_bulk_action_menu($nodetext) {
  49         $this->execute("behat_forms::i_set_the_field_to", [
  50             "With selected users...",
  51             $this->escape($nodetext)
  52         ]);
  53     }
  54
  55     /**
  56      * Deletes a user.
  57      *
  58      * @Given the user :identifier is deleted
  59      * @param string $identifier
  60      */
  61     #[\core\attribute\example('And the user student1 is deleted')]
  62     public function the_user_is_deleted($identifier) {
  63         global $DB;
  64         $userid = $this->get_user_id_by_identifier($identifier);
  65         if (!$userid) {
  66             throw new moodle_exception('The specified user with username or email "' . $identifier . '" does not exist');
  67         }
  68         delete_user($DB->get_record('user', ['id' => $userid]));
  69     }
  70
  71     /**
  72      * The input field should have autocomplete set to this value.
  73      *
  74      * @Then /^the field "(?P<field_string>(?:[^"]|\\")*)" should have purpose "(?P<purpose_string>(?:[^"]|\\")*)"$/
  75      * @param string $field The field to select.
  76      * @param string $purpose The expected purpose.
  77      */
  78     public function the_field_should_have_purpose($field, $purpose) {
  79         $fld = behat_field_manager::get_form_field_from_label($field, $this);
  80
  81         $value = $fld->get_attribute('autocomplete');
  82         if ($value != $purpose) {
  83             $reason = 'The "' . $field . '" field does not have purpose "' . $purpose . '"';
  84             throw new ExpectationException($reason, $this->getSession());
  85         }
  86     }
  87
  88     /**
  89      * The input field should not have autocomplete set to this value.
  90      *
  91      * @Then /^the field "(?P<field_string>(?:[^"]|\\")*)" should not have purpose "(?P<purpose_string>(?:[^"]|\\")*)"$/
  92      * @param string $field The field to select.
  93      * @param string $purpose The expected purpose we do not want.
  94      */
  95     public function the_field_should_not_have_purpose($field, $purpose) {
  96         $fld = behat_field_manager::get_form_field_from_label($field, $this);
  97
  98         $value = $fld->get_attribute('autocomplete');
  99         if ($value == $purpose) {
 100             throw new ExpectationException('The "' . $field . '" field does have purpose "' . $purpose . '"', $this->getSession());
 101         }
 102     }
 103
 104     /**
 105      * Convert page names to URLs for steps like 'When I am on the "[page name]" page'.
 106      *
 107      * Recognised page names are:
 108      * | Page name            | Description                                                 |
 109      * | Contact Site Support | The Contact Site Support page (user/contactsitesupport.php) |
 110      *
 111      * @param string $page name of the page, with the component name removed e.g. 'Admin notification'.
 112      * @return moodle_url the corresponding URL.
 113      * @throws Exception with a meaningful error message if the specified page cannot be found.
 114      */
 115     protected function resolve_page_url(string $page): moodle_url {
 116
 117         switch (strtolower($page)) {
 118             case 'contact site support':
 119                 return new moodle_url('/user/contactsitesupport.php');
 120
 121             default:
 122                 throw new Exception("Unrecognised core_user page type '{$page}'.");
 123         }
 124     }
 125
 126     /**
 127      * Convert page names to URLs for steps like 'When I am on the "[identifier]" "[page type]" page'.
 128      *
 129      * Recognised page names are:
 130      * | Page Type | Identifier meaning | Description                                |
 131      * | editing   | username or email  | User editing page (/user/editadvanced.php) |
 132      * | profile   | username or email  | User profile page (/user/profile.php) |
 133      *
 134      * @param string $type identifies which type of page this is, e.g. 'Editing'.
 135      * @param string $identifier identifies the user, e.g. 'student1'.
 136      * @return moodle_url the corresponding URL.
 137      * @throws Exception with a meaningful error message if the specified page cannot be found.
 138      */
 139     protected function resolve_page_instance_url(string $type, string $identifier): moodle_url {
 140
 141         switch (strtolower($type)) {
 142             case 'editing':
 143                 $userid = $this->get_user_id_by_identifier($identifier);
 144                 if (!$userid) {
 145                     throw new Exception('The specified user with username or email "' .
 146                         $identifier . '" does not exist');
 147                 }
 148                 return new moodle_url('/user/editadvanced.php', ['id' => $userid]);
 149             case 'profile':
 150                 $userid = $this->get_user_id_by_identifier($identifier);
 151                 if (!$userid) {
 152                     throw new Exception('The specified user with username or email "' . $identifier . '" does not exist');
 153                 }
 154                 return new moodle_url('/user/profile.php', ['id' => $userid]);
 155             default:
 156                 throw new Exception("Unrecognised page type '{$type}'.");
 157         }
 158     }
 159 }