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
40 /**
f05c1013 41 * View the contact information of a user in the messages ui.
21c6f11c 42 *
f05c1013 43 * @Given /^I view the "(?P<user_full_name_string>(?:[^"]|\\")*)" contact in the message area$/
14ebd163 44 * @param string $userfullname
21c6f11c 45 */
f05c1013 46 public function i_view_contact_in_messages($userfullname) {
9741087f
DW
47 // Visit home page and follow messages.
48 $this->i_select_user_in_messaging($userfullname);
49
50 $this->execute('behat_general::i_click_on_in_the',
51 array(
52 "//button[@data-action='view-contact-profile']
53 [contains(normalize-space(.), '" . $this->escape($userfullname) . "')]",
54 'xpath_element',
55 ".messages-header",
56 "css_element",
57 )
58 );
59
60 $this->execute('behat_general::wait_until_the_page_is_ready');
61 }
62
63 /**
64 * Select a user in the messaging UI.
65 *
66 * @Given /^I select "(?P<user_full_name_string>(?:[^"]|\\")*)" user in messaging$/
67 * @param string $userfullname
68 */
69 public function i_select_user_in_messaging($userfullname) {
70
eb9ca848
RT
71 // Visit home page and follow messages.
72 $this->execute("behat_general::i_am_on_homepage");
73
f074d6f0 74 $this->execute("behat_general::i_click_on", [get_string('togglemessagemenu', 'core_message'), 'link']);
21c6f11c 75
f074d6f0 76 $this->execute('behat_general::i_click_on', [get_string('search', 'core'), 'field']);
eb9ca848 77
f074d6f0
RW
78 $this->execute('behat_forms::i_set_the_field_with_xpath_to',
79 [
80 "//*[@data-region='message-drawer']//input[@data-region='search-input']",
81 $this->escape($userfullname)
82 ]
eb9ca848
RT
83 );
84
f074d6f0
RW
85 $this->execute('behat_general::i_click_on', ['[data-action="search"]', 'css_element']);
86
16f91ae1
MN
87 $this->execute('behat_general::wait_until_the_page_is_ready');
88
f05c1013
RW
89 // Need to limit the click to the search results because the 'view-contact-profile' elements
90 // can occur in two separate divs on the page.
91 $this->execute('behat_general::i_click_on_in_the',
f074d6f0
RW
92 [
93 $this->escape($userfullname),
94 'link',
95 "[data-region='message-drawer'] [data-region='search-results-container']",
f05c1013 96 "css_element",
f074d6f0 97 ]
f05c1013 98 );
16f91ae1
MN
99
100 $this->execute('behat_general::wait_until_the_page_is_ready');
21c6f11c
DM
101 }
102
9741087f 103
16f91ae1
MN
104 /**
105 * Sends a message to the specified user from the logged user. The user full name should contain the first and last names.
106 *
107 * @Given /^I send "(?P<message_contents_string>(?:[^"]|\\")*)" message to "(?P<user_full_name_string>(?:[^"]|\\")*)" user$/
108 * @param string $messagecontent
109 * @param string $userfullname
110 */
111 public function i_send_message_to_user($messagecontent, $userfullname) {
9741087f 112 $this->i_select_user_in_messaging($userfullname);
16f91ae1
MN
113
114 $this->execute('behat_forms::i_set_the_field_with_xpath_to',
115 array("//textarea[@data-region='send-message-txt']", $this->escape($messagecontent))
116 );
117
f074d6f0
RW
118 $this->execute('behat_general::i_click_on_in_the',
119 [
120 '[data-action="send-message"]',
121 'css_element',
122 "[data-region='message-drawer'] [data-region='footer-container'] [data-region='view-conversation']",
123 "css_element",
124 ]
125 );
16f91ae1 126 }
f05c1013
RW
127
128 /**
129 * Select messages from a user in the messaging ui.
130 *
131 * @Given /^I send "(?P<message_contents_string>(?:[^"]|\\")*)" message in the message area$/
132 * @param string $messagecontent
133 */
134 public function i_send_message_in_the_message_area($messagecontent) {
8857c715
DW
135 $this->execute('behat_general::wait_until_the_page_is_ready');
136
f05c1013
RW
137 $this->execute('behat_forms::i_set_the_field_with_xpath_to',
138 array("//textarea[@data-region='send-message-txt']", $this->escape($messagecontent))
139 );
140
141 $this->execute("behat_forms::press_button", get_string('send', 'message'));
142 }
21c6f11c 143}