ab6b291a5cc0ae88d9bdc93cc190b495c35437c9
[moodle.git] / lib / tests / behat / behat_deprecated.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/>.
17 /**
18  * Steps definitions that will be deprecated in the next releases.
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  */
26 // NOTE: no MOODLE_INTERNAL test here, this file may be required by behat before including /config.php.
28 require_once(__DIR__ . '/../../../lib/behat/behat_base.php');
30 use Behat\Mink\Exception\ElementNotFoundException as ElementNotFoundException,
31     Behat\Behat\Context\Step\Given as Given;
33 /**
34  * Deprecated behat step definitions.
35  *
36  * @package    core
37  * @category   test
38  * @copyright  2013 David MonllaĆ³
39  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
40  */
41 class behat_deprecated extends behat_base {
43     /**
44      * Click on the specified element inside a table row containing the specified text.
45      *
46      * @deprecated since Moodle 2.7 MDL-42627
47      * @todo MDL-42862 This will be deleted in Moodle 2.9
48      * @see behat_general::i_click_on_in_the()
49      *
50      * @Given /^I click on "(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>(?:[^"]|\\")*)" in the "(?P<row_text_string>(?:[^"]|\\")*)" table row$/
51      * @throws ElementNotFoundException
52      * @param string $element Element we look for
53      * @param string $selectortype The type of what we look for
54      * @param string $tablerowtext The table row text
55      */
56     public function i_click_on_in_the_table_row($element, $selectortype, $tablerowtext) {
58         // Throw an exception if deprecated methods are not allowed otherwise allow it's execution.
59         $alternative = 'I click on "' . $this->escape($element) . '" "' . $this->escape($selectortype) .
60             '" in the "' . $this->escape($tablerowtext) . '" "table_row"';
61         $this->deprecated_message($alternative);
63         return new Given($alternative);
64     }
66     /**
67      * Goes to notification page ensuring site admin navigation is loaded.
68      *
69      * Step [I expand "Site administration" node] will ensure that administration menu
70      * is opened in both javascript and non-javascript modes.
71      *
72      * @deprecated since 2.7
73      * @todo MDL-42862 This will be deleted in Moodle 2.9
74      *
75      * @Given /^I go to notifications page$/
76      * @return Given[]
77      */
78     public function i_go_to_notifications_page() {
79         $alternative = array(
80             'I expand "' . get_string('administrationsite') . '" node',
81             'I click on "' . get_string('notifications') . '" "link" in the "'.get_string('administration').'" "block"'
82         );
83         $this->deprecated_message($alternative);
84         return array(
85             new Given($alternative[0]),
86             new Given($alternative[1]),
87         );
88     }
90     /**
91      * Adds the specified file from the 'Recent files' repository to the specified filepicker of the current page.
92      *
93      * @deprecated since 2.7
94      * @todo MDL-42862 This will be deleted in Moodle 2.9
95      * @see behat_filepicker::i_add_file_from_repository_to_filemanager()
96      *
97      * @When /^I add "(?P<filename_string>(?:[^"]|\\")*)" file from recent files to "(?P<filepicker_field_string>(?:[^"]|\\")*)" filepicker$/
98      * @param string $filename
99      * @param string $filepickerelement
100      */
101     public function i_add_file_from_recent_files_to_filepicker($filename, $filepickerelement) {
102         $reponame = get_string('pluginname', 'repository_recent');
103         $alternative = 'I add "' . $this->escape($filename) . '" file from "' .
104                 $reponame . '" to "' . $this->escape($filepickerelement) . '" filemanager';
105         $this->deprecated_message($alternative);
106         return array(
107             new Given($alternative)
108         );
109     }
111     /**
112      * Uploads a file to the specified filemanager leaving other fields in upload form default. The paths should be relative to moodle codebase.
113      *
114      * @deprecated since 2.7
115      * @todo MDL-42862 This will be deleted in Moodle 2.9
116      * @see behat_repository_upload::i_upload_file_to_filemanager()
117      *
118      * @When /^I upload "(?P<filepath_string>(?:[^"]|\\")*)" file to "(?P<filepicker_field_string>(?:[^"]|\\")*)" filepicker$/
119      * @throws ExpectationException Thrown by behat_base::find
120      * @param string $filepath
121      * @param string $filepickerelement
122      */
123     public function i_upload_file_to_filepicker($filepath, $filepickerelement) {
124         $alternative = 'I upload "' . $this->escape($filepath) . '" file to "' .
125                 $this->escape($filepickerelement) . '" filemanager';
126         $this->deprecated_message($alternative);
127         return array(
128             new Given($alternative)
129         );
130     }
132     /**
133      * Creates a folder with specified name in the current folder and in the specified filepicker field.
134      *
135      * @deprecated since 2.7
136      * @todo MDL-42862 This will be deleted in Moodle 2.9
137      * @see behat_filepicker::i_create_folder_in_filemanager()
138      *
139      * @Given /^I create "(?P<foldername_string>(?:[^"]|\\")*)" folder in "(?P<filepicker_field_string>(?:[^"]|\\")*)" filepicker$/
140      * @throws ExpectationException Thrown by behat_base::find
141      * @param string $foldername
142      * @param string $filepickerelement
143      */
144     public function i_create_folder_in_filepicker($foldername, $filepickerelement) {
145         $alternative = 'I create "' . $this->escape($foldername) .
146                 '" folder in "' . $this->escape($filepickerelement) . '" filemanager';
147         $this->deprecated_message($alternative);
148         return array(new Given($alternative));
149     }
151     /**
152      * Opens the contents of a filepicker folder. It looks for the folder in the current folder and in the path bar.
153      *
154      * @deprecated since 2.7
155      * @todo MDL-42862 This will be deleted in Moodle 2.9
156      * @see behat_filepicker::i_open_folder_from_filemanager()
157      *
158      * @Given /^I open "(?P<foldername_string>(?:[^"]|\\")*)" folder from "(?P<filepicker_field_string>(?:[^"]|\\")*)" filepicker$/
159      * @throws ExpectationException Thrown by behat_base::find
160      * @param string $foldername
161      * @param string $filepickerelement
162      */
163     public function i_open_folder_from_filepicker($foldername, $filepickerelement) {
164         $alternative = 'I open "' . $this->escape($foldername) . '" folder from "' .
165                 $this->escape($filepickerelement) . '" filemanager';
166         $this->deprecated_message($alternative);
167         return array(new Given($alternative));
168     }
170     /**
171      * Unzips the specified file from the specified filepicker field. The zip file has to be visible in the current folder.
172      *
173      * @deprecated since 2.7
174      * @todo MDL-42862 This will be deleted in Moodle 2.9
175      * @see behat_filepicker::i_unzip_file_from_filemanager()
176      *
177      * @Given /^I unzip "(?P<filename_string>(?:[^"]|\\")*)" file from "(?P<filepicker_field_string>(?:[^"]|\\")*)" filepicker$/
178      * @throws ExpectationException Thrown by behat_base::find
179      * @param string $filename
180      * @param string $filepickerelement
181      */
182     public function i_unzip_file_from_filepicker($filename, $filepickerelement) {
183         $alternative = 'I unzip "' . $this->escape($filename) . '" file from "' .
184                 $this->escape($filepickerelement) . '" filemanager';
185         $this->deprecated_message($alternative);
186         return array(new Given($alternative));
187     }
189     /**
190      * Zips the specified folder from the specified filepicker field. The folder has to be in the current folder.
191      *
192      * @deprecated since 2.7
193      * @todo MDL-42862 This will be deleted in Moodle 2.9
194      * @see behat_filepicker::i_zip_folder_from_filemanager()
195      *
196      * @Given /^I zip "(?P<filename_string>(?:[^"]|\\")*)" folder from "(?P<filepicker_field_string>(?:[^"]|\\")*)" filepicker$/
197      * @throws ExpectationException Thrown by behat_base::find
198      * @param string $foldername
199      * @param string $filepickerelement
200      */
201     public function i_zip_folder_from_filepicker($foldername, $filepickerelement) {
202         $alternative = 'I zip "' . $this->escape($foldername) . '" folder from "' .
203                 $this->escape($filepickerelement) . '" filemanager';
204         $this->deprecated_message($alternative);
205         return array(new Given($alternative));
206     }
208     /**
209      * Deletes the specified file or folder from the specified filepicker field.
210      *
211      * @deprecated since 2.7
212      * @todo MDL-42862 This will be deleted in Moodle 2.9
213      * @see behat_filepicker::i_delete_file_from_filemanager()
214      *
215      * @Given /^I delete "(?P<file_or_folder_name_string>(?:[^"]|\\")*)" from "(?P<filepicker_field_string>(?:[^"]|\\")*)" filepicker$/
216      * @throws ExpectationException Thrown by behat_base::find
217      * @param string $name
218      * @param string $filepickerelement
219      */
220     public function i_delete_file_from_filepicker($name, $filepickerelement) {
221         $alternative = 'I delete "' . $this->escape($name) . '" from "' .
222                 $this->escape($filepickerelement) . '" filemanager';
223         $this->deprecated_message($alternative);
224         return array(new Given($alternative));
225     }
227     /**
228      * Sends a message to the specified user from the logged user.
229      *
230      * @deprecated since 2.7
231      * @todo MDL-42862 This will be deleted in Moodle 2.9
232      * @see behat_message::i_send_message_to_user()
233      *
234      * @Given /^I send "(?P<message_contents_string>(?:[^"]|\\")*)" message to "(?P<username_string>(?:[^"]|\\")*)"$/
235      * @throws ElementNotFoundException
236      * @param string $messagecontent
237      * @param string $tousername
238      */
239     public function i_send_message_to_user($messagecontent, $tousername) {
241         global $DB;
243         // Runs by CLI, same PHP process that created the user.
244         $touser = $DB->get_record('user', array('username' => $tousername));
245         if (!$touser) {
246             throw new ElementNotFoundException($this->getSession(), '"' . $tousername . '" ');
247         }
248         $tofullname = fullname($touser);
250         $alternative = 'I send "' . $this->escape($messagecontent) . '" message to "' . $tofullname . '" user';
251         $this->deprecated_message($alternative);
252         return new Given($alternative);
253     }
255     /**
256      * Adds the user to the specified cohort.
257      *
258      * @deprecated since 2.7
259      * @todo MDL-42862 This will be deleted in Moodle 2.9
260      * @see behat_cohort::i_add_user_to_cohort_members()
261      *
262      * @Given /^I add "(?P<user_username_string>(?:[^"]|\\")*)" user to "(?P<cohort_idnumber_string>(?:[^"]|\\")*)" cohort$/
263      * @param string $username
264      * @param string $cohortidnumber
265      */
266     public function i_add_user_to_cohort($username, $cohortidnumber) {
267         global $DB;
269         // The user was created by the data generator, executed by the same PHP process that is
270         // running this step, not by any Selenium action.
271         $user = $DB->get_record('user', array('username' => $username));
272         $userlocator = $user->firstname . ' ' . $user->lastname . ' (' . $user->email . ')';
274         $alternative = 'I add "' . $this->escape($userlocator) .
275             '" user to "' . $this->escape($cohortidnumber) . '" cohort members';
276         $this->deprecated_message($alternative);
278         return new Given($alternative);
279     }
281     /**
282      * Add the specified user to the group. You should be in the groups page when running this step.
283      *
284      * @deprecated since 2.7
285      * @todo MDL-42862 This will be deleted in Moodle 2.9
286      * @see behat_groups::i_add_user_to_group_members()
287      *
288      * @Given /^I add "(?P<username_string>(?:[^"]|\\")*)" user to "(?P<group_name_string>(?:[^"]|\\")*)" group$/
289      * @param string $username
290      * @param string $groupname
291      */
292     public function i_add_user_to_group($username, $groupname) {
293         global $DB;
295         $user = $DB->get_record('user', array('username' => $username));
296         $userfullname = fullname($user);
298         $alternative = 'I add "' . $this->escape($userfullname) .
299             '" user to "' . $this->escape($groupname) . '" group members';
300         $this->deprecated_message($alternative);
302         return new Given($alternative);
303     }
305     /**
306      * Throws an exception if $CFG->behat_usedeprecated is not allowed.
307      *
308      * @throws Exception
309      * @param string|array $alternatives Alternative/s to the requested step
310      * @return void
311      */
312     protected function deprecated_message($alternatives) {
313         global $CFG;
315         // We do nothing if it is enabled.
316         if (!empty($CFG->behat_usedeprecated)) {
317             return;
318         }
320         if (is_scalar($alternatives)) {
321             $alternatives = array($alternatives);
322         }
324         $message = 'Deprecated step, rather than using this step you can:';
325         foreach ($alternatives as $alternative) {
326             $message .= PHP_EOL . '- ' . $alternative;
327         }
328         $message .= PHP_EOL . '- Set $CFG->behat_usedeprecated in config.php to allow the use of deprecated steps if you don\'t have any other option';
329         throw new Exception($message);
330     }