weekly release 3.7dev
[moodle.git] / message / tests / behat / behat_message.php
CommitLineData
21c6f11c
DM
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 * Behat message-related steps definitions.
19 *
20 * @package core_message
21 * @category test
22 * @copyright 2013 David MonllaĆ³
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
28require_once(__DIR__ . '/../../../lib/behat/behat_base.php');
29
21c6f11c
DM
30/**
31 * Messaging system steps definitions.
32 *
33 * @package core_message
34 * @category test
35 * @copyright 2013 David MonllaĆ³
36 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
37 */
38class behat_message extends behat_base {
39
65f631c5
AA
40 /**
41 * Open the messaging UI.
42 *
43 * @Given /^I open messaging$/
44 */
45 public function i_open_messaging() {
46 // Visit home page and follow messages.
47 $this->execute("behat_general::i_am_on_homepage");
48 $this->execute("behat_general::i_click_on", [get_string('togglemessagemenu', 'core_message'), 'link']);
49 }
50
51 /**
52 * Open the messaging UI.
53 *
54 * @Given /^I open messaging information$/
55 */
56 public function i_open_messaging_information() {
57 $this->execute('behat_general::i_click_on', ["[data-action='view-group-info']", 'css_element']);
58 }
59
21c6f11c 60 /**
f05c1013 61 * View the contact information of a user in the messages ui.
21c6f11c 62 *
f05c1013 63 * @Given /^I view the "(?P<user_full_name_string>(?:[^"]|\\")*)" contact in the message area$/
14ebd163 64 * @param string $userfullname
21c6f11c 65 */
f05c1013 66 public function i_view_contact_in_messages($userfullname) {
9741087f
DW
67 // Visit home page and follow messages.
68 $this->i_select_user_in_messaging($userfullname);
69
70 $this->execute('behat_general::i_click_on_in_the',
71 array(
72 "//button[@data-action='view-contact-profile']
73 [contains(normalize-space(.), '" . $this->escape($userfullname) . "')]",
74 'xpath_element',
75 ".messages-header",
76 "css_element",
77 )
78 );
79
80 $this->execute('behat_general::wait_until_the_page_is_ready');
81 }
82
83 /**
84 * Select a user in the messaging UI.
85 *
86 * @Given /^I select "(?P<user_full_name_string>(?:[^"]|\\")*)" user in messaging$/
87 * @param string $userfullname
88 */
89 public function i_select_user_in_messaging($userfullname) {
65f631c5 90 $this->i_open_messaging();
21c6f11c 91
f074d6f0 92 $this->execute('behat_general::i_click_on', [get_string('search', 'core'), 'field']);
eb9ca848 93
f074d6f0
RW
94 $this->execute('behat_forms::i_set_the_field_with_xpath_to',
95 [
96 "//*[@data-region='message-drawer']//input[@data-region='search-input']",
97 $this->escape($userfullname)
98 ]
eb9ca848
RT
99 );
100
f074d6f0
RW
101 $this->execute('behat_general::i_click_on', ['[data-action="search"]', 'css_element']);
102
16f91ae1
MN
103 $this->execute('behat_general::wait_until_the_page_is_ready');
104
f05c1013
RW
105 // Need to limit the click to the search results because the 'view-contact-profile' elements
106 // can occur in two separate divs on the page.
107 $this->execute('behat_general::i_click_on_in_the',
f074d6f0
RW
108 [
109 $this->escape($userfullname),
110 'link',
111 "[data-region='message-drawer'] [data-region='search-results-container']",
f05c1013 112 "css_element",
f074d6f0 113 ]
f05c1013 114 );
16f91ae1
MN
115
116 $this->execute('behat_general::wait_until_the_page_is_ready');
21c6f11c
DM
117 }
118
16f91ae1
MN
119 /**
120 * Sends a message to the specified user from the logged user. The user full name should contain the first and last names.
121 *
122 * @Given /^I send "(?P<message_contents_string>(?:[^"]|\\")*)" message to "(?P<user_full_name_string>(?:[^"]|\\")*)" user$/
123 * @param string $messagecontent
124 * @param string $userfullname
125 */
126 public function i_send_message_to_user($messagecontent, $userfullname) {
9741087f 127 $this->i_select_user_in_messaging($userfullname);
16f91ae1
MN
128
129 $this->execute('behat_forms::i_set_the_field_with_xpath_to',
130 array("//textarea[@data-region='send-message-txt']", $this->escape($messagecontent))
131 );
132
f074d6f0
RW
133 $this->execute('behat_general::i_click_on_in_the',
134 [
135 '[data-action="send-message"]',
136 'css_element',
137 "[data-region='message-drawer'] [data-region='footer-container'] [data-region='view-conversation']",
138 "css_element",
139 ]
140 );
16f91ae1 141 }
f05c1013
RW
142
143 /**
144 * Select messages from a user in the messaging ui.
145 *
146 * @Given /^I send "(?P<message_contents_string>(?:[^"]|\\")*)" message in the message area$/
147 * @param string $messagecontent
148 */
149 public function i_send_message_in_the_message_area($messagecontent) {
8857c715
DW
150 $this->execute('behat_general::wait_until_the_page_is_ready');
151
f05c1013
RW
152 $this->execute('behat_forms::i_set_the_field_with_xpath_to',
153 array("//textarea[@data-region='send-message-txt']", $this->escape($messagecontent))
154 );
155
156 $this->execute("behat_forms::press_button", get_string('send', 'message'));
157 }
65f631c5
AA
158
159 /**
160 * Navigate back in the messages ui drawer.
161 *
162 * @Given /^I go back in "(?P<parent_element_string>(?:[^"]|\\")*)" message drawer$/
163 * @param string $parentelement
164 */
165 public function i_go_back_in_message_drawer($parentelement) {
166 $this->execute('behat_general::i_click_on_in_the',
167 array(
168 'a[data-route-back]',
169 'css_element',
170 '[data-region="'.$this->escape($parentelement).'"]',
171 'css_element',
172 )
173 );
174 }
175
176 /**
177 * Select a user in the messaging UI.
178 *
179 * @Given /^I select "(?P<conversation_name_string>(?:[^"]|\\")*)" conversation in messaging$/
180 * @param string $conversationname
181 */
182 public function i_select_conversation_in_messaging($conversationname) {
183 $this->execute('behat_general::i_click_on',
184 array(
185 $this->escape($conversationname),
186 'group_message',
187 )
188 );
189 }
21c6f11c 190}