MDL-57282 behat: Deprecate I go to X in the course gradebook
[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\Gherkin\Node\TableNode as TableNode,
32     Behat\Gherkin\Node\PyStringNode as PyStringNode;
34 /**
35  * Deprecated behat step definitions.
36  *
37  * @package    core
38  * @category   test
39  * @copyright  2013 David MonllaĆ³
40  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
41  */
42 class behat_deprecated extends behat_base {
44     /**
45      * @Given /^I click on "(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>(?:[^"]|\\")*)" in the "(?P<row_text_string>(?:[^"]|\\")*)" table row$/
46      * @deprecated since Moodle 2.7 MDL-42627 - please do not use this step any more.
47      */
48     public function i_click_on_in_the_table_row($element, $selectortype, $tablerowtext) {
49         $alternative = 'I click on "' . $this->escape($element) . '" "' . $this->escape($selectortype) .
50             '" in the "' . $this->escape($tablerowtext) . '" "table_row"';
51         $this->deprecated_message($alternative, true);
52     }
54     /**
55      * @Given /^I go to notifications page$/
56      * @deprecated since Moodle 2.7 MDL-42731 - please do not use this step any more.
57      */
58     public function i_go_to_notifications_page() {
59         $alternative = array(
60             'I expand "' . get_string('administrationsite') . '" node',
61             'I click on "' . get_string('notifications') . '" "link" in the "'.get_string('administration').'" "block"'
62         );
63         $this->deprecated_message($alternative, true);
64     }
66     /**
67      * @When /^I add "(?P<filename_string>(?:[^"]|\\")*)" file from recent files to "(?P<filepicker_field_string>(?:[^"]|\\")*)" filepicker$/
68      * @deprecated since Moodle 2.7 MDL-42174 - please do not use this step any more.
69      */
70     public function i_add_file_from_recent_files_to_filepicker($filename, $filepickerelement) {
71         $reponame = get_string('pluginname', 'repository_recent');
72         $alternative = 'I add "' . $this->escape($filename) . '" file from "' .
73                 $reponame . '" to "' . $this->escape($filepickerelement) . '" filemanager';
74         $this->deprecated_message($alternative, true);
75     }
77     /**
78      * @When /^I upload "(?P<filepath_string>(?:[^"]|\\")*)" file to "(?P<filepicker_field_string>(?:[^"]|\\")*)" filepicker$/
79      * @deprecated since Moodle 2.7 MDL-42174 - please do not use this step any more.
80      */
81     public function i_upload_file_to_filepicker($filepath, $filepickerelement) {
82         $alternative = 'I upload "' . $this->escape($filepath) . '" file to "' .
83                 $this->escape($filepickerelement) . '" filemanager';
84         $this->deprecated_message($alternative, true);
85     }
87     /**
88      * @Given /^I create "(?P<foldername_string>(?:[^"]|\\")*)" folder in "(?P<filepicker_field_string>(?:[^"]|\\")*)" filepicker$/
89      * @deprecated since Moodle 2.7 MDL-42174 - please do not use this step any more.
90      */
91     public function i_create_folder_in_filepicker($foldername, $filepickerelement) {
92         $alternative = 'I create "' . $this->escape($foldername) .
93                 '" folder in "' . $this->escape($filepickerelement) . '" filemanager';
94         $this->deprecated_message($alternative, true);
95     }
97     /**
98      * @Given /^I open "(?P<foldername_string>(?:[^"]|\\")*)" folder from "(?P<filepicker_field_string>(?:[^"]|\\")*)" filepicker$/
99      * @deprecated since Moodle 2.7 MDL-42174 - please do not use this step any more.
100      */
101     public function i_open_folder_from_filepicker($foldername, $filepickerelement) {
102         $alternative = 'I open "' . $this->escape($foldername) . '" folder from "' .
103                 $this->escape($filepickerelement) . '" filemanager';
104         $this->deprecated_message($alternative, true);
105     }
107     /**
108      * @Given /^I unzip "(?P<filename_string>(?:[^"]|\\")*)" file from "(?P<filepicker_field_string>(?:[^"]|\\")*)" filepicker$/
109      * @deprecated since Moodle 2.7 MDL-42174 - please do not use this step any more.
110      */
111     public function i_unzip_file_from_filepicker($filename, $filepickerelement) {
112         $alternative = 'I unzip "' . $this->escape($filename) . '" file from "' .
113                 $this->escape($filepickerelement) . '" filemanager';
114         $this->deprecated_message($alternative, true);
115     }
117     /**
118      * @Given /^I zip "(?P<filename_string>(?:[^"]|\\")*)" folder from "(?P<filepicker_field_string>(?:[^"]|\\")*)" filepicker$/
119      * @deprecated since Moodle 2.7 MDL-42174 - please do not use this step any more.
120      */
121     public function i_zip_folder_from_filepicker($foldername, $filepickerelement) {
122         $alternative = 'I zip "' . $this->escape($foldername) . '" folder from "' .
123                 $this->escape($filepickerelement) . '" filemanager';
124         $this->deprecated_message($alternative, true);
125     }
127     /**
128      * @Given /^I delete "(?P<file_or_folder_name_string>(?:[^"]|\\")*)" from "(?P<filepicker_field_string>(?:[^"]|\\")*)" filepicker$/
129      * @deprecated since Moodle 2.7 MDL-42174 - please do not use this step any more.
130      */
131     public function i_delete_file_from_filepicker($name, $filepickerelement) {
132         $alternative = 'I delete "' . $this->escape($name) . '" from "' .
133                 $this->escape($filepickerelement) . '" filemanager';
134         $this->deprecated_message($alternative, true);
135     }
137     /**
138      * @Given /^I send "(?P<message_contents_string>(?:[^"]|\\")*)" message to "(?P<username_string>(?:[^"]|\\")*)"$/
139      * @deprecated since Moodle 2.7 MDL-43584 - please do not use this step any more.
140      */
141     public function i_send_message_to_user($messagecontent, $tousername) {
142         $alternative = 'I send "' . $this->escape($messagecontent) . '" message to "USER_FULL_NAME" user';
143         $this->deprecated_message($alternative, true);
144     }
146     /**
147      * @Given /^I add "(?P<user_username_string>(?:[^"]|\\")*)" user to "(?P<cohort_idnumber_string>(?:[^"]|\\")*)" cohort$/
148      * @deprecated since Moodle 2.7 MDL-43584 - please do not use this step any more.
149      */
150     public function i_add_user_to_cohort($username, $cohortidnumber) {
151         $alternative = 'I add "USER_FIRST_NAME USER_LAST_NAME (USER_EMAIL)" user to "'
152                 . $this->escape($cohortidnumber) . '" cohort members';
153         $this->deprecated_message($alternative, true);
154     }
156     /**
157      * @Given /^I add "(?P<username_string>(?:[^"]|\\")*)" user to "(?P<group_name_string>(?:[^"]|\\")*)" group$/
158      * @deprecated since Moodle 2.7 MDL-43584 - please do not use this step any more.
159      */
160     public function i_add_user_to_group($username, $groupname) {
161         $alternative = 'I add "USER_FULL_NAME" user to "' . $this->escape($groupname) . '" group members';
162         $this->deprecated_message($alternative, true);
163     }
165     /**
166      * @When /^I fill in "(?P<field_string>(?:[^"]|\\")*)" with "(?P<value_string>(?:[^"]|\\")*)"$/
167      * @deprecated since Moodle 2.7 MDL-43738 - please do not use this step any more.
168      */
169     public function fill_field($field, $value) {
170         $alternative = 'I set the field "' . $this->escape($field) . '" to "' . $this->escape($value) . '"';
171         $this->deprecated_message($alternative, true);
172     }
174     /**
175      * @When /^I select "(?P<option_string>(?:[^"]|\\")*)" from "(?P<select_string>(?:[^"]|\\")*)"$/
176      * @deprecated since Moodle 2.7 MDL-43738 - please do not use this step any more.
177      */
178     public function select_option($option, $select) {
179         $alternative = 'I set the field "' . $this->escape($select) . '" to "' . $this->escape($option) . '"';
180         $this->deprecated_message($alternative, true);
181     }
183     /**
184      * @When /^I select "(?P<radio_button_string>(?:[^"]|\\")*)" radio button$/
185      * @deprecated since Moodle 2.7 MDL-43738 - please do not use this step any more.
186      */
187     public function select_radio($radio) {
188         $alternative = 'I set the field "' . $this->escape($radio) . '" to "1"';
189         $this->deprecated_message($alternative, true);
190     }
192     /**
193      * @When /^I check "(?P<option_string>(?:[^"]|\\")*)"$/
194      * @deprecated since Moodle 2.7 MDL-43738 - please do not use this step any more.
195      */
196     public function check_option($option) {
197         $alternative = 'I set the field "' . $this->escape($option) . '" to "1"';
198         $this->deprecated_message($alternative, true);
199     }
201     /**
202      * @When /^I uncheck "(?P<option_string>(?:[^"]|\\")*)"$/
203      * @deprecated since Moodle 2.7 MDL-43738 - please do not use this step any more.
204      */
205     public function uncheck_option($option) {
206         $alternative = 'I set the field "' . $this->escape($option) . '" to ""';
207         $this->deprecated_message($alternative, true);
208     }
210     /**
211      * @Then /^the "(?P<field_string>(?:[^"]|\\")*)" field should match "(?P<value_string>(?:[^"]|\\")*)" value$/
212      * @deprecated since Moodle 2.7 MDL-43738 - please do not use this step any more.
213      */
214     public function the_field_should_match_value($locator, $value) {
215         $alternative = 'the field "' . $this->escape($locator) . '" matches value "' . $this->escape($value) . '"';
216         $this->deprecated_message($alternative, true);
217     }
219     /**
220      * @Then /^the "(?P<checkbox_string>(?:[^"]|\\")*)" checkbox should be checked$/
221      * @deprecated since Moodle 2.7 MDL-43738 - please do not use this step any more.
222      */
223     public function assert_checkbox_checked($checkbox) {
224         $alternative = 'the field "' . $this->escape($checkbox) . '" matches value "1"';
225         $this->deprecated_message($alternative, true);
226     }
228     /**
229      * @Then /^the "(?P<checkbox_string>(?:[^"]|\\")*)" checkbox should not be checked$/
230      * @deprecated since Moodle 2.7 MDL-43738 - please do not use this step any more.
231      */
232     public function assert_checkbox_not_checked($checkbox) {
233         $alternative = 'the field "' . $this->escape($checkbox) . '" matches value ""';
234         $this->deprecated_message($alternative, true);
235     }
237     /**
238      * @Given /^I fill the moodle form with:$/
239      * @deprecated since Moodle 2.7 MDL-43738 - please do not use this step any more.
240      */
241     public function i_fill_the_moodle_form_with(TableNode $data) {
242         $alternative = 'I set the following fields to these values:';
243         $this->deprecated_message($alternative, true);
244     }
246     /**
247      * @Then /^"(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>[^"]*)" should exists$/
248      * @deprecated since Moodle 2.7 MDL-43236 - please do not use this step any more.
249      */
250     public function should_exists($element, $selectortype) {
251         $alternative = '"' . $this->escape($element) . '" "' . $this->escape($selectortype) . '" should exist';
252         $this->deprecated_message($alternative, true);
253     }
255     /**
256      * @Then /^"(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>[^"]*)" should not exists$/
257      * @deprecated since Moodle 2.7 MDL-43236 - please do not use this step any more.
258      */
259     public function should_not_exists($element, $selectortype) {
260         $alternative = '"' . $this->escape($element) . '" "' . $this->escape($selectortype) . '" should not exist';
261         $this->deprecated_message($alternative, true);
262     }
264     /**
265      * @Given /^the following "(?P<element_string>(?:[^"]|\\")*)" exists:$/
266      * @deprecated since Moodle 2.7 MDL-43236 - please do not use this step any more.
267      */
268     public function the_following_exists($elementname, TableNode $data) {
269         $alternative = 'the following "' . $this->escape($elementname) . '" exist:';
270         $this->deprecated_message($alternative, true);
271     }
273     /**
274      * Sets the specified value to the field.
275      *
276      * @Given /^I set the field "(?P<field_string>(?:[^"]|\\")*)" to multiline$/
277      * @throws ElementNotFoundException Thrown by behat_base::find
278      * @param string $field
279      * @param PyStringNode $value
280      * @deprecated since Moodle 3.2 MDL-55406 - please do not use this step any more.
281      */
282     public function i_set_the_field_to_multiline($field, PyStringNode $value) {
284         $alternative = 'I set the field "' . $this->escape($field) . '"  to multiline:';
285         $this->deprecated_message($alternative);
287         $this->execute('behat_forms::i_set_the_field_to_multiline', array($field, $value));
288     }
290     /**
291      * Click on a given link in the moodle-actionmenu that is currently open.
292      * @Given /^I follow "(?P<link_string>(?:[^"]|\\")*)" in the open menu$/
293      * @param string $linkstring the text (or id, etc.) of the link to click.
294      */
295     public function i_follow_in_the_open_menu($linkstring) {
296         $alternative = 'I choose "' . $this->escape($linkstring) . '" from the open action menu';
297         $this->deprecated_message($alternative, true);
298     }
300     /**
301      * Navigates to the course gradebook and selects a specified item from the grade navigation tabs.
302      * @Given /^I go to "(?P<gradepath_string>(?:[^"]|\\")*)" in the course gradebook$/
303      * @param string $gradepath
304      * @deprecated since Moodle 3.3 MDL-57282 - please do not use this step any more.
305      */
306     public function i_go_to_in_the_course_gradebook($gradepath) {
307         $alternative = 'I navigate to "' . $this->escape($gradepath) . '"  in the course gradebook';
308         $this->deprecated_message($alternative);
310         $this->execute('behat_grade::i_navigate_to_in_the_course_gradebook', $gradepath);
311     }
313     /**
314      * Throws an exception if $CFG->behat_usedeprecated is not allowed.
315      *
316      * @throws Exception
317      * @param string|array $alternatives Alternative/s to the requested step
318      * @param bool $throwexception If set to true we always throw exception, irrespective of behat_usedeprecated setting.
319      * @return void
320      */
321     protected function deprecated_message($alternatives, $throwexception = false) {
322         global $CFG;
324         // We do nothing if it is enabled.
325         if (!empty($CFG->behat_usedeprecated) && !$throwexception) {
326             return;
327         }
329         if (is_scalar($alternatives)) {
330             $alternatives = array($alternatives);
331         }
333         // Show an appropriate message based on the throwexception flag.
334         if ($throwexception) {
335             $message = 'This step has been removed. Rather than using this step you can:';
336         } else {
337             $message = 'Deprecated step, rather than using this step you can:';
338         }
340         // Add all alternatives to the message.
341         foreach ($alternatives as $alternative) {
342             $message .= PHP_EOL . '- ' . $alternative;
343         }
345         if (!$throwexception) {
346             $message .= PHP_EOL . '- Set $CFG->behat_usedeprecated in config.php to allow the use of deprecated steps
347                     if you don\'t have any other option';
348         }
350         throw new Exception($message);
351     }