Moodle release 3.2rc1
[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) {
eb9ca848
RT
47 // Visit home page and follow messages.
48 $this->execute("behat_general::i_am_on_homepage");
49
16f91ae1 50 $this->execute("behat_navigation::i_follow_in_the_user_menu", get_string('messages', 'message'));
21c6f11c 51
f05c1013 52 $this->execute('behat_general::i_click_on', array("contacts-view", 'message_area_action'));
eb9ca848 53
16f91ae1 54 $this->execute('behat_general::wait_until_the_page_is_ready');
eb9ca848
RT
55
56 $this->execute('behat_forms::i_set_the_field_to',
16f91ae1 57 array(get_string('searchforuserorcourse', 'message'), $this->escape($userfullname))
eb9ca848
RT
58 );
59
16f91ae1
MN
60 $this->execute('behat_general::wait_until_the_page_is_ready');
61
f05c1013
RW
62 // Need to limit the click to the search results because the 'view-contact-profile' elements
63 // can occur in two separate divs on the page.
64 $this->execute('behat_general::i_click_on_in_the',
65 array(
66 "//div[@data-action='view-contact-profile']
67 [./div[contains(normalize-space(.), '" . $this->escape($userfullname) . "')]]",
68 'xpath_element',
69 "[data-region='messaging-area'] [data-region='search-results-area']",
70 "css_element",
71 )
72 );
16f91ae1
MN
73
74 $this->execute('behat_general::wait_until_the_page_is_ready');
21c6f11c
DM
75 }
76
16f91ae1
MN
77 /**
78 * Sends a message to the specified user from the logged user. The user full name should contain the first and last names.
79 *
80 * @Given /^I send "(?P<message_contents_string>(?:[^"]|\\")*)" message to "(?P<user_full_name_string>(?:[^"]|\\")*)" user$/
81 * @param string $messagecontent
82 * @param string $userfullname
83 */
84 public function i_send_message_to_user($messagecontent, $userfullname) {
f05c1013 85 $this->i_view_contact_in_messages($userfullname);
16f91ae1
MN
86
87 $this->execute("behat_general::i_click_on", array("[data-action='profile-send-message']", 'css_element'));
88
89 $this->execute('behat_general::wait_until_the_page_is_ready');
90
91 $this->execute('behat_forms::i_set_the_field_with_xpath_to',
92 array("//textarea[@data-region='send-message-txt']", $this->escape($messagecontent))
93 );
94
95 $this->execute("behat_forms::press_button", get_string('send', 'message'));
96 }
f05c1013
RW
97
98 /**
99 * Select messages from a user in the messaging ui.
100 *
101 * @Given /^I send "(?P<message_contents_string>(?:[^"]|\\")*)" message in the message area$/
102 * @param string $messagecontent
103 */
104 public function i_send_message_in_the_message_area($messagecontent) {
105 $this->execute('behat_forms::i_set_the_field_with_xpath_to',
106 array("//textarea[@data-region='send-message-txt']", $this->escape($messagecontent))
107 );
108
109 $this->execute("behat_forms::press_button", get_string('send', 'message'));
110 }
21c6f11c 111}