2 // This file is part of Moodle - http://moodle.org/
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.
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.
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/>.
18 * Sent message global search unit tests.
21 * @copyright 2016 Devang Gaur
22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25 defined('MOODLE_INTERNAL') ||
die();
28 require_once($CFG->dirroot
. '/search/tests/fixtures/testable_core_search.php');
31 * Provides the unit tests for sent message global search.
34 * @copyright 2016 Devang Gaur
35 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
37 class message_sent_search_testcase
extends advanced_testcase
{
42 protected $messagesentareaid = null;
45 * Setting up the test environment
48 public function setUp() {
49 $this->resetAfterTest(true);
50 set_config('enableglobalsearch', true);
52 $this->messagesentareaid
= \core_search\manager
::generate_areaid('core_message', 'message_sent');
54 // Set \core_search::instance to the mock_search_engine as we don't require the search engine to be working to test this.
55 $search = testable_core_search
::instance();
59 * Indexing messages contents.
63 public function test_message_sent_indexing() {
65 // Returns the instance as long as the area is supported.
66 $searcharea = \core_search\manager
::get_search_area($this->messagesentareaid
);
67 $this->assertInstanceOf('\core_message\search\message_sent', $searcharea);
69 $user1 = self
::getDataGenerator()->create_user();
70 $user2 = self
::getDataGenerator()->create_user();
72 $this->preventResetByRollback();
73 $sink = $this->redirectMessages();
75 $message = new \core\message\
message();
76 $message->courseid
= SITEID
;
77 $message->userfrom
= $user1;
78 $message->userto
= $user2;
79 $message->subject
= "Test Subject";
80 $message->smallmessage
= "Test small messsage";
81 $message->fullmessage
= "Test full messsage";
82 $message->fullmessageformat
= 0;
83 $message->fullmessagehtml
= null;
84 $message->notification
= 0;
85 $message->component
= 'moodle';
86 $message->name
= "instantmessage";
88 message_send($message);
90 $messages = $sink->get_messages();
92 $this->assertEquals(1, count($messages));
95 $recordset = $searcharea->get_recordset_by_timestamp(0);
96 $this->assertTrue($recordset->valid());
98 foreach ($recordset as $record) {
99 $this->assertInstanceOf('stdClass', $record);
100 $doc = $searcharea->get_document($record);
101 $this->assertInstanceOf('\core_search\document', $doc);
104 // If there would be an error/failure in the foreach above the recordset would be closed on shutdown.
106 $this->assertEquals(1, $nrecords);
108 // The +2 is to prevent race conditions.
109 $recordset = $searcharea->get_recordset_by_timestamp(time() +
2);
112 $this->assertFalse($recordset->valid());
117 * Indexing messages, with restricted contexts.
119 public function test_message_sent_indexing_contexts() {
122 $searcharea = \core_search\manager
::get_search_area($this->messagesentareaid
);
124 $user1 = self
::getDataGenerator()->create_user();
125 $user2 = self
::getDataGenerator()->create_user();
127 $this->preventResetByRollback();
128 $sink = $this->redirectMessages();
130 // Send first message.
131 $message = new \core\message\
message();
132 $message->courseid
= SITEID
;
133 $message->userfrom
= $user1;
134 $message->userto
= $user2;
135 $message->subject
= 'Test1';
136 $message->smallmessage
= 'Test small messsage';
137 $message->fullmessage
= 'Test full messsage';
138 $message->fullmessageformat
= 0;
139 $message->fullmessagehtml
= null;
140 $message->notification
= 0;
141 $message->component
= 'moodle';
142 $message->name
= 'instantmessage';
143 message_send($message);
145 // Ensure that ordering by timestamp will return in consistent order.
146 $this->waitForSecond();
148 // Send second message in opposite direction.
149 $message = new \core\message\
message();
150 $message->courseid
= SITEID
;
151 $message->userfrom
= $user2;
152 $message->userto
= $user1;
153 $message->subject
= 'Test2';
154 $message->smallmessage
= 'Test small messsage';
155 $message->fullmessage
= 'Test full messsage';
156 $message->fullmessageformat
= 0;
157 $message->fullmessagehtml
= null;
158 $message->notification
= 0;
159 $message->component
= 'moodle';
160 $message->name
= 'instantmessage';
161 message_send($message);
163 // Test function with null context and system context (same).
164 $rs = $searcharea->get_document_recordset(0, null);
165 $this->assertEquals(['Test1', 'Test2'], self
::recordset_to_subjects($rs));
166 $rs = $searcharea->get_document_recordset(0, context_system
::instance());
167 $this->assertEquals(['Test1', 'Test2'], self
::recordset_to_subjects($rs));
169 // Test with user context for each user.
170 $rs = $searcharea->get_document_recordset(0, \context_user
::instance($user1->id
));
171 $this->assertEquals(['Test1'], self
::recordset_to_subjects($rs));
172 $rs = $searcharea->get_document_recordset(0, \context_user
::instance($user2->id
));
173 $this->assertEquals(['Test2'], self
::recordset_to_subjects($rs));
175 // Test with a course context (should return null).
176 $this->assertNull($searcharea->get_document_recordset(0,
177 context_course
::instance($SITE->id
)));
181 * Utility function to convert recordset to array of message subjects for testing.
183 * @param moodle_recordset $rs Recordset to convert (and close)
184 * @return array Array of IDs from records indexed by number (0, 1, 2, ...)
186 public static function recordset_to_subjects(moodle_recordset
$rs) {
188 foreach ($rs as $rec) {
189 $results[] = $rec->subject
;
200 public function test_message_sent_document() {
202 // Returns the instance as long as the area is supported.
203 $searcharea = \core_search\manager
::get_search_area($this->messagesentareaid
);
204 $this->assertInstanceOf('\core_message\search\message_sent', $searcharea);
206 $user1 = self
::getDataGenerator()->create_user();
207 $user2 = self
::getDataGenerator()->create_user();
209 $this->preventResetByRollback();
210 $sink = $this->redirectMessages();
212 $message = new \core\message\
message();
213 $message->courseid
= SITEID
;
214 $message->userfrom
= $user1;
215 $message->userto
= $user2;
216 $message->subject
= "Test Subject";
217 $message->smallmessage
= "Test small messsage";
218 $message->fullmessage
= "Test full messsage";
219 $message->fullmessageformat
= 0;
220 $message->fullmessagehtml
= null;
221 $message->notification
= 0;
222 $message->component
= "moodle";
223 $message->name
= "instantmessage";
225 message_send($message);
227 $messages = $sink->get_messages();
228 $message = $messages[0];
230 $doc = $searcharea->get_document($message);
231 $this->assertInstanceOf('\core_search\document', $doc);
232 $this->assertEquals($message->id
, $doc->get('itemid'));
233 $this->assertEquals($this->messagesentareaid
. '-' . $message->id
, $doc->get('id'));
234 $this->assertEquals(SITEID
, $doc->get('courseid'));
235 $this->assertEquals($message->useridfrom
, $doc->get('owneruserid'));
236 $this->assertEquals($message->useridto
, $doc->get('userid'));
237 $this->assertEquals(content_to_text($message->subject
, false), $doc->get('title'));
238 $this->assertEquals(content_to_text($message->smallmessage
, false), $doc->get('content'));
246 public function test_message_sent_access() {
249 // Returns the instance as long as the area is supported.
250 $searcharea = \core_search\manager
::get_search_area($this->messagesentareaid
);
252 $user1 = self
::getDataGenerator()->create_user();
253 $user2 = self
::getDataGenerator()->create_user();
254 $user3 = self
::getDataGenerator()->create_user();
256 $this->preventResetByRollback();
257 $sink = $this->redirectMessages();
259 $message = new \core\message\
message();
260 $message->courseid
= SITEID
;
261 $message->userfrom
= $user1;
262 $message->userto
= $user2;
263 $message->subject
= "Test Subject";
264 $message->smallmessage
= "Test small messsage";
265 $message->fullmessage
= "Test full messsage";
266 $message->fullmessageformat
= 0;
267 $message->fullmessagehtml
= null;
268 $message->notification
= 0;
269 $message->component
= "moodle";
270 $message->name
= "instantmessage";
272 $messageid = message_send($message);
274 $messages = $sink->get_messages();
275 $message = $messages[0];
277 $this->setUser($user1);
279 if ($CFG->messaging
) {
280 $this->assertEquals(\core_search\manager
::ACCESS_GRANTED
, $searcharea->check_access($messageid));
282 $this->assertEquals(\core_search\manager
::ACCESS_DENIED
, $searcharea->check_access($messageid));
285 $this->assertEquals(\core_search\manager
::ACCESS_DELETED
, $searcharea->check_access(-123));
287 \core_message\api
::delete_message($user1->id
, $message->id
);
288 $this->assertEquals(\core_search\manager
::ACCESS_DELETED
, $searcharea->check_access($messageid));
290 $this->setUser($user2);
291 $this->assertEquals(\core_search\manager
::ACCESS_DENIED
, $searcharea->check_access($messageid));
293 $this->setUser($user3);
294 $this->assertEquals(\core_search\manager
::ACCESS_DENIED
, $searcharea->check_access($messageid));
296 $this->setGuestUser();
297 $this->assertEquals(\core_search\manager
::ACCESS_DENIED
, $searcharea->check_access($messageid));
299 $this->setAdminUser();
300 $this->assertEquals(\core_search\manager
::ACCESS_DENIED
, $searcharea->check_access($messageid));
304 $this->setUser($user1);
305 $this->assertEquals(\core_search\manager
::ACCESS_DELETED
, $searcharea->check_access($messageid));
310 * Test sent deleted user.
311 * Tests the case where a sent message for a deleted user
312 * is attempted to be added to the index.
316 public function test_message_sent_deleted_user() {
318 // Returns the instance as long as the area is supported.
319 $searcharea = \core_search\manager
::get_search_area($this->messagesentareaid
);
320 $this->assertInstanceOf('\core_message\search\message_sent', $searcharea);
322 $user1 = self
::getDataGenerator()->create_user();
323 $user2 = self
::getDataGenerator()->create_user();
325 $this->preventResetByRollback();
326 $sink = $this->redirectMessages();
328 $message = new \core\message\
message();
329 $message->courseid
= SITEID
;
330 $message->userfrom
= $user1;
331 $message->userto
= $user2;
332 $message->subject
= "Test Subject";
333 $message->smallmessage
= "Test small messsage";
334 $message->fullmessage
= "Test full messsage";
335 $message->fullmessageformat
= 0;
336 $message->fullmessagehtml
= null;
337 $message->notification
= 0;
338 $message->component
= "moodle";
339 $message->name
= "instantmessage";
341 message_send($message);
343 $messages = $sink->get_messages();
344 $message = $messages[0];
349 $doc = $searcharea->get_document($message);
351 $this->assertFalse($doc);
356 * Test document icon.
358 public function test_get_doc_icon() {
359 $searcharea = \core_search\manager
::get_search_area($this->messagesentareaid
);
361 $document = $this->getMockBuilder('\core_search\document')
362 ->disableOriginalConstructor()
365 $result = $searcharea->get_doc_icon($document);
367 $this->assertEquals('t/message', $result->get_name());
368 $this->assertEquals('moodle', $result->get_component());
372 * Test assigned search categories.
374 public function test_get_category_names() {
375 $searcharea = \core_search\manager
::get_search_area($this->messagesentareaid
);
377 $expected = ['core-users'];
378 $this->assertEquals($expected, $searcharea->get_category_names());