b721ec48e576bb86890e615a46454b884a1e9654
[moodle.git] / mod / forum / tests / behat / behat_mod_forum.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 related with the forum activity.
19  *
20  * @package    mod_forum
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\Gherkin\Node\TableNode as TableNode;
31 /**
32  * Forum-related steps definitions.
33  *
34  * @package    mod_forum
35  * @category   test
36  * @copyright  2013 David MonllaĆ³
37  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
38  */
39 class behat_mod_forum extends behat_base {
41     /**
42      * Adds a topic to the forum specified by it's name. Useful for the Announcements and blog-style forums.
43      *
44      * @Given /^I add a new topic to "(?P<forum_name_string>(?:[^"]|\\")*)" forum with:$/
45      * @param string $forumname
46      * @param TableNode $table
47      */
48     public function i_add_a_new_topic_to_forum_with($forumname, TableNode $table) {
49         $this->add_new_discussion($forumname, $table, get_string('addanewtopic', 'forum'));
50     }
52     /**
53      * Adds a discussion to the forum specified by it's name with the provided table data (usually Subject and Message). The step begins from the forum's course page.
54      *
55      * @Given /^I add a new discussion to "(?P<forum_name_string>(?:[^"]|\\")*)" forum with:$/
56      * @param string $forumname
57      * @param TableNode $table
58      */
59     public function i_add_a_forum_discussion_to_forum_with($forumname, TableNode $table) {
60         $this->add_new_discussion($forumname, $table, get_string('addanewdiscussion', 'forum'));
61     }
63     /**
64      * Adds a discussion to the forum specified by it's name with the provided table data (usually Subject and Message).
65      * The step begins from the forum's course page.
66      *
67      * @Given /^I add a new discussion to "(?P<forum_name_string>(?:[^"]|\\")*)" forum inline with:$/
68      * @param string $forumname
69      * @param TableNode $table
70      */
71     public function i_add_a_forum_discussion_to_forum_inline_with($forumname, TableNode $table) {
72         $this->add_new_discussion_inline($forumname, $table, get_string('addanewdiscussion', 'forum'));
73     }
75     /**
76      * Adds a reply to the specified post of the specified forum. The step begins from the forum's page or from the forum's course page.
77      *
78      * @Given /^I reply "(?P<post_subject_string>(?:[^"]|\\")*)" post from "(?P<forum_name_string>(?:[^"]|\\")*)" forum with:$/
79      * @param string $postname The subject of the post
80      * @param string $forumname The forum name
81      * @param TableNode $table
82      */
83     public function i_reply_post_from_forum_with($postsubject, $forumname, TableNode $table) {
85         // Navigate to forum.
86         $this->goto_main_post_reply($postsubject);
88         // Fill form and post.
89         $this->execute('behat_forms::i_set_the_following_fields_to_these_values', $table);
91         $this->execute('behat_forms::press_button', get_string('posttoforum', 'forum'));
92         $this->execute('behat_general::i_wait_to_be_redirected');
93     }
95     /**
96      * Inpage Reply - adds a reply to the specified post of the specified forum. The step begins from the forum's page or from the forum's course page.
97      *
98      * @Given /^I reply "(?P<post_subject_string>(?:[^"]|\\")*)" post from "(?P<forum_name_string>(?:[^"]|\\")*)" forum using an inpage reply with:$/
99      * @param string $postsubject The subject of the post
100      * @param string $forumname The forum name
101      * @param TableNode $table
102      */
103     public function i_reply_post_from_forum_using_an_inpage_reply_with($postsubject, $forumname, TableNode $table) {
105         // Navigate to forum.
106         $this->execute('behat_general::click_link', $this->escape($forumname));
107         $this->execute('behat_general::click_link', $this->escape($postsubject));
108         $this->execute('behat_general::click_link', get_string('reply', 'forum'));
110         // Fill form and post.
111         $this->execute('behat_forms::i_set_the_following_fields_to_these_values', $table);
113         $this->execute('behat_forms::press_button', get_string('submit', 'core'));
114     }
116     /**
117      * Navigates to a particular discussion page
118      *
119      * @Given /^I navigate to post "(?P<post_subject_string>(?:[^"]|\\")*)" in "(?P<forum_name_string>(?:[^"]|\\")*)" forum$/
120      * @param string $postsubject The subject of the post
121      * @param string $forumname The forum name
122      */
123     public function i_navigate_to_post_in_forum($postsubject, $forumname) {
125         // Navigate to forum discussion.
126         $this->execute('behat_general::click_link', $this->escape($forumname));
127         $this->execute('behat_general::click_link', $this->escape($postsubject));
128     }
130     /**
131      * Opens up the action menu for the discussion
132      *
133      * @Given /^I click on "(?P<post_subject_string>(?:[^"]|\\")*)" action menu$/
134      * @param string $discussion The subject of the discussion
135      */
136     public function i_click_on_action_menu($discussion) {
137         $this->execute('behat_general::i_click_on_in_the', [
138             "[data-container='discussion-tools'] [data-toggle='dropdown']", "css_element",
139             "//tr[contains(concat(' ', normalize-space(@class), ' '), ' discussion ') and contains(.,'$discussion')]",
140             "xpath_element"
141         ]);
142     }
144     /**
145      * Returns the steps list to add a new discussion to a forum.
146      *
147      * Abstracts add a new topic and add a new discussion, as depending
148      * on the forum type the button string changes.
149      *
150      * @param string $forumname
151      * @param TableNode $table
152      * @param string $buttonstr
153      */
154     protected function add_new_discussion($forumname, TableNode $table, $buttonstr) {
156         // Navigate to forum.
157         $this->execute('behat_general::click_link', $this->escape($forumname));
158         $this->execute('behat_general::click_link', $buttonstr);
159         $this->execute('behat_forms::press_button', get_string('advanced'));
161         $this->fill_new_discussion_form($table);
162     }
164     /**
165      * Returns the steps list to add a new discussion to a forum inline.
166      *
167      * Abstracts add a new topic and add a new discussion, as depending
168      * on the forum type the button string changes.
169      *
170      * @param string $forumname
171      * @param TableNode $table
172      * @param string $buttonstr
173      */
174     protected function add_new_discussion_inline($forumname, TableNode $table, $buttonstr) {
176         // Navigate to forum.
177         $this->execute('behat_general::click_link', $this->escape($forumname));
178         $this->execute('behat_general::click_link', $buttonstr);
179         $this->fill_new_discussion_form($table);
180     }
182     /**
183      * Fill in the forum's post form and submit. It assumes you've already navigated and enabled the form for view.
184      *
185      * @param TableNode $table
186      * @throws coding_exception
187      */
188     protected function fill_new_discussion_form(TableNode $table) {
189         // Fill form and post.
190         $this->execute('behat_forms::i_set_the_following_fields_to_these_values', $table);
191         $this->execute('behat_forms::press_button', get_string('posttoforum', 'forum'));
192         $this->execute('behat_general::i_wait_to_be_redirected');
193     }
195     /**
196      * Go to the default reply to post page.
197      * This is used instead of navigating through 4-5 different steps and to solve issues where JS would be required to click
198      * on the advanced button
199      *
200      * @param $postsubject
201      * @throws coding_exception
202      * @throws dml_exception
203      * @throws moodle_exception
204      */
205     protected function goto_main_post_reply($postsubject) {
206         global $DB;
207         $post = $DB->get_record("forum_posts", array("subject" => $postsubject), 'id', MUST_EXIST);
208         $url = new moodle_url('/mod/forum/post.php', ['reply' => $post->id]);
209         $this->getSession()->visit($this->locate_path($url->out_as_local_url(false)));
210     }