12d24bb71fc5cfb4a6c103bb0f091ca0a422d401
[moodle.git] / mod / forum / tests / maildigest_test.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * The module forums external functions unit tests
20  *
21  * @package    mod_forum
22  * @category   external
23  * @copyright  2013 Andrew Nicols
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 defined('MOODLE_INTERNAL') || die();
29 global $CFG;
31 class mod_forum_maildigest_testcase extends advanced_testcase {
33     /**
34      * Keep track of the message and mail sinks that we set up for each
35      * test.
36      *
37      * @var stdClass $helper
38      */
39     protected $helper;
41     /**
42      * Set up message and mail sinks, and set up other requirements for the
43      * cron to be tested here.
44      */
45     public function setUp() {
46         global $CFG;
48         $this->helper = new stdClass();
50         // Messaging is not compatible with transactions...
51         $this->preventResetByRollback();
53         // Catch all messages
54         $this->helper->messagesink = $this->redirectMessages();
55         $this->helper->mailsink = $this->redirectEmails();
57         // Confirm that we have an empty message sink so far.
58         $messages = $this->helper->messagesink->get_messages();
59         $this->assertEquals(0, count($messages));
61         $messages = $this->helper->mailsink->get_messages();
62         $this->assertEquals(0, count($messages));
64         // Tell Moodle that we've not sent any digest messages out recently.
65         $CFG->digestmailtimelast = 0;
67         // And set the digest sending time to a negative number - this has
68         // the effect of making it 11pm the previous day.
69         $CFG->digestmailtime = -1;
71         // Forcibly reduce the maxeditingtime to a one second to ensure that
72         // messages are sent out.
73         $CFG->maxeditingtime = 1;
75         // We must clear the subscription caches. This has to be done both before each test, and after in case of other
76         // tests using these functions.
77         \mod_forum\subscriptions::reset_forum_cache();
78         \mod_forum\subscriptions::reset_discussion_cache();
79     }
81     /**
82      * Clear the message sinks set up in this test.
83      */
84     public function tearDown() {
85         $this->helper->messagesink->clear();
86         $this->helper->messagesink->close();
88         $this->helper->mailsink->clear();
89         $this->helper->mailsink->close();
90     }
92     /**
93      * Setup a user, course, and forums.
94      *
95      * @return stdClass containing the list of forums, courses, forumids,
96      * and the user enrolled in them.
97      */
98     protected function helper_setup_user_in_course() {
99         global $DB;
101         $return = new stdClass();
102         $return->courses = new stdClass();
103         $return->forums = new stdClass();
104         $return->forumids = array();
106         // Create a user.
107         $user = $this->getDataGenerator()->create_user();
108         $return->user = $user;
110         // Create courses to add the modules.
111         $return->courses->course1 = $this->getDataGenerator()->create_course();
113         // Create forums.
114         $record = new stdClass();
115         $record->course = $return->courses->course1->id;
116         $record->forcesubscribe = 1;
118         $return->forums->forum1 = $this->getDataGenerator()->create_module('forum', $record);
119         $return->forumsids[] = $return->forums->forum1->id;
121         $return->forums->forum2 = $this->getDataGenerator()->create_module('forum', $record);
122         $return->forumsids[] = $return->forums->forum2->id;
124         // Check the forum was correctly created.
125         list ($test, $params) = $DB->get_in_or_equal($return->forumsids);
127         // Enrol the user in the courses.
128         // DataGenerator->enrol_user automatically sets a role for the user
129         $this->getDataGenerator()->enrol_user($return->user->id, $return->courses->course1->id);
131         return $return;
132     }
134     /**
135      * Helper to falsify all forum post records for a digest run.
136      */
137     protected function helper_force_digest_mail_times() {
138         global $CFG, $DB;
139         // Fake all of the post editing times because digests aren't sent until
140         // the start of an hour where the modification time on the message is before
141         // the start of that hour
142         $sitetimezone = core_date::get_server_timezone();
143         $digesttime = usergetmidnight(time(), $sitetimezone) + ($CFG->digestmailtime * 3600) - (60 * 60);
144         $DB->set_field('forum_posts', 'modified', $digesttime, array('mailed' => 0));
145         $DB->set_field('forum_posts', 'created', $digesttime, array('mailed' => 0));
146     }
148     /**
149      * Run the forum cron, and check that the specified post was sent the
150      * specified number of times.
151      *
152      * @param integer $expected The number of times that the post should have been sent
153      * @return array An array of the messages caught by the message sink
154      */
155     protected function helper_run_cron_check_count($expected, $messagecount, $mailcount) {
156         if ($expected === 0) {
157             $this->expectOutputRegex('/(Email digests successfully sent to .* users.){0}/');
158         } else {
159             $this->expectOutputRegex("/Email digests successfully sent to {$expected} users/");
160         }
161         forum_cron();
163         // Now check the results in the message sink.
164         $messages = $this->helper->messagesink->get_messages();
165         // There should be the expected number of messages.
166         $this->assertEquals($messagecount, count($messages));
168         // Now check the results in the mail sink.
169         $messages = $this->helper->mailsink->get_messages();
170         // There should be the expected number of messages.
171         $this->assertEquals($mailcount, count($messages));
173         return $messages;
174     }
176     public function test_set_maildigest() {
177         global $DB;
179         $this->resetAfterTest(true);
181         $helper = $this->helper_setup_user_in_course();
182         $user = $helper->user;
183         $course1 = $helper->courses->course1;
184         $forum1 = $helper->forums->forum1;
186         // Set to the user.
187         self::setUser($helper->user);
189         // Confirm that there is no current value.
190         $currentsetting = $DB->get_record('forum_digests', array(
191             'forum' => $forum1->id,
192             'userid' => $user->id,
193         ));
194         $this->assertFalse($currentsetting);
196         // Test with each of the valid values:
197         // 0, 1, and 2 are valid values.
198         forum_set_user_maildigest($forum1, 0, $user);
199         $currentsetting = $DB->get_record('forum_digests', array(
200             'forum' => $forum1->id,
201             'userid' => $user->id,
202         ));
203         $this->assertEquals($currentsetting->maildigest, 0);
205         forum_set_user_maildigest($forum1, 1, $user);
206         $currentsetting = $DB->get_record('forum_digests', array(
207             'forum' => $forum1->id,
208             'userid' => $user->id,
209         ));
210         $this->assertEquals($currentsetting->maildigest, 1);
212         forum_set_user_maildigest($forum1, 2, $user);
213         $currentsetting = $DB->get_record('forum_digests', array(
214             'forum' => $forum1->id,
215             'userid' => $user->id,
216         ));
217         $this->assertEquals($currentsetting->maildigest, 2);
219         // And the default value - this should delete the record again
220         forum_set_user_maildigest($forum1, -1, $user);
221         $currentsetting = $DB->get_record('forum_digests', array(
222             'forum' => $forum1->id,
223             'userid' => $user->id,
224         ));
225         $this->assertFalse($currentsetting);
227         // Try with an invalid value.
228         $this->setExpectedException('moodle_exception');
229         forum_set_user_maildigest($forum1, 42, $user);
230     }
232     public function test_get_user_digest_options_default() {
233         global $USER, $DB;
235         $this->resetAfterTest(true);
237         // Set up a basic user enrolled in a course.
238         $helper = $this->helper_setup_user_in_course();
239         $user = $helper->user;
240         $course1 = $helper->courses->course1;
241         $forum1 = $helper->forums->forum1;
243         // Set to the user.
244         self::setUser($helper->user);
246         // We test against these options.
247         $digestoptions = array(
248             '0' => get_string('emaildigestoffshort', 'mod_forum'),
249             '1' => get_string('emaildigestcompleteshort', 'mod_forum'),
250             '2' => get_string('emaildigestsubjectsshort', 'mod_forum'),
251         );
253         // The default settings is 0.
254         $this->assertEquals(0, $user->maildigest);
255         $options = forum_get_user_digest_options();
256         $this->assertEquals($options[-1], get_string('emaildigestdefault', 'mod_forum', $digestoptions[0]));
258         // Update the setting to 1.
259         $USER->maildigest = 1;
260         $this->assertEquals(1, $USER->maildigest);
261         $options = forum_get_user_digest_options();
262         $this->assertEquals($options[-1], get_string('emaildigestdefault', 'mod_forum', $digestoptions[1]));
264         // Update the setting to 2.
265         $USER->maildigest = 2;
266         $this->assertEquals(2, $USER->maildigest);
267         $options = forum_get_user_digest_options();
268         $this->assertEquals($options[-1], get_string('emaildigestdefault', 'mod_forum', $digestoptions[2]));
269     }
271     public function test_get_user_digest_options_sorting() {
272         global $USER, $DB;
274         $this->resetAfterTest(true);
276         // Set up a basic user enrolled in a course.
277         $helper = $this->helper_setup_user_in_course();
278         $user = $helper->user;
279         $course1 = $helper->courses->course1;
280         $forum1 = $helper->forums->forum1;
282         // Set to the user.
283         self::setUser($helper->user);
285         // Retrieve the list of applicable options.
286         $options = forum_get_user_digest_options();
288         // The default option must always be at the top of the list.
289         $lastoption = -2;
290         foreach ($options as $value => $description) {
291             $this->assertGreaterThan($lastoption, $value);
292             $lastoption = $value;
293         }
294     }
296     public function test_cron_no_posts() {
297         global $DB;
299         $this->resetAfterTest(true);
301         $this->helper_force_digest_mail_times();
303         // Initially the forum cron should generate no messages as we've made no posts.
304         $this->helper_run_cron_check_count(0, 0, 0);
305     }
307     /**
308      * Sends several notifications to one user as:
309      * * single messages based on a user profile setting.
310      */
311     public function test_cron_profile_single_mails() {
312         global $DB;
314         $this->resetAfterTest(true);
316         // Set up a basic user enrolled in a course.
317         $userhelper = $this->helper_setup_user_in_course();
318         $user = $userhelper->user;
319         $course1 = $userhelper->courses->course1;
320         $forum1 = $userhelper->forums->forum1;
321         $forum2 = $userhelper->forums->forum2;
323         // Add some discussions to the forums.
324         $record = new stdClass();
325         $record->course = $course1->id;
326         $record->userid = $user->id;
327         $record->mailnow = 1;
329         // Add 5 discussions to forum 1.
330         $record->forum = $forum1->id;
331         for ($i = 0; $i < 5; $i++) {
332             $this->getDataGenerator()->get_plugin_generator('mod_forum')->create_discussion($record);
333         }
335         // Add 5 discussions to forum 2.
336         $record->forum = $forum2->id;
337         for ($i = 0; $i < 5; $i++) {
338             $this->getDataGenerator()->get_plugin_generator('mod_forum')->create_discussion($record);
339         }
341         // Ensure that the creation times mean that the messages will be sent.
342         $this->helper_force_digest_mail_times();
344         // Set the tested user's default maildigest setting.
345         $DB->set_field('user', 'maildigest', 0, array('id' => $user->id));
347         // Set the maildigest preference for forum1 to default.
348         forum_set_user_maildigest($forum1, -1, $user);
350         // Set the maildigest preference for forum2 to default.
351         forum_set_user_maildigest($forum2, -1, $user);
353         // No digests mails should be sent, but 10 forum mails will be sent.
354         $this->helper_run_cron_check_count(0, 10, 0);
355     }
357     /**
358      * Sends several notifications to one user as:
359      * * daily digests coming from the user profile setting.
360      */
361     public function test_cron_profile_digest_email() {
362         global $DB, $CFG;
364         $this->resetAfterTest(true);
366         // Set up a basic user enrolled in a course.
367         $userhelper = $this->helper_setup_user_in_course();
368         $user = $userhelper->user;
369         $course1 = $userhelper->courses->course1;
370         $forum1 = $userhelper->forums->forum1;
371         $forum2 = $userhelper->forums->forum2;
373         // Add a discussion to the forums.
374         $record = new stdClass();
375         $record->course = $course1->id;
376         $record->userid = $user->id;
377         $record->mailnow = 1;
379         // Add 5 discussions to forum 1.
380         $record->forum = $forum1->id;
381         for ($i = 0; $i < 5; $i++) {
382             $this->getDataGenerator()->get_plugin_generator('mod_forum')->create_discussion($record);
383         }
385         // Add 5 discussions to forum 2.
386         $record->forum = $forum2->id;
387         for ($i = 0; $i < 5; $i++) {
388             $this->getDataGenerator()->get_plugin_generator('mod_forum')->create_discussion($record);
389         }
391         // Ensure that the creation times mean that the messages will be sent.
392         $this->helper_force_digest_mail_times();
394         // Set the tested user's default maildigest setting.
395         $DB->set_field('user', 'maildigest', 1, array('id' => $user->id));
397         // Set the maildigest preference for forum1 to default.
398         forum_set_user_maildigest($forum1, -1, $user);
400         // Set the maildigest preference for forum2 to default.
401         forum_set_user_maildigest($forum2, -1, $user);
403         // One digest mail should be sent, with no notifications, and one e-mail.
404         $this->helper_run_cron_check_count(1, 0, 1);
405     }
407     /**
408      * Sends several notifications to one user as:
409      * * daily digests coming from the per-forum setting; and
410      * * single e-mails from the profile setting.
411      */
412     public function test_cron_mixed_email_1() {
413         global $DB, $CFG;
415         $this->resetAfterTest(true);
417         // Set up a basic user enrolled in a course.
418         $userhelper = $this->helper_setup_user_in_course();
419         $user = $userhelper->user;
420         $course1 = $userhelper->courses->course1;
421         $forum1 = $userhelper->forums->forum1;
422         $forum2 = $userhelper->forums->forum2;
424         // Add a discussion to the forums.
425         $record = new stdClass();
426         $record->course = $course1->id;
427         $record->userid = $user->id;
428         $record->mailnow = 1;
430         // Add 5 discussions to forum 1.
431         $record->forum = $forum1->id;
432         for ($i = 0; $i < 5; $i++) {
433             $this->getDataGenerator()->get_plugin_generator('mod_forum')->create_discussion($record);
434         }
436         // Add 5 discussions to forum 2.
437         $record->forum = $forum2->id;
438         for ($i = 0; $i < 5; $i++) {
439             $this->getDataGenerator()->get_plugin_generator('mod_forum')->create_discussion($record);
440         }
442         // Ensure that the creation times mean that the messages will be sent.
443         $this->helper_force_digest_mail_times();
445         // Set the tested user's default maildigest setting.
446         $DB->set_field('user', 'maildigest', 0, array('id' => $user->id));
448         // Set the maildigest preference for forum1 to digest.
449         forum_set_user_maildigest($forum1, 1, $user);
451         // Set the maildigest preference for forum2 to default (single).
452         forum_set_user_maildigest($forum2, -1, $user);
454         // One digest e-mail should be sent, and five individual notifications.
455         $this->helper_run_cron_check_count(1, 5, 1);
456     }
458     /**
459      * Sends several notifications to one user as:
460      * * single e-mails from the per-forum setting; and
461      * * daily digests coming from the per-user setting.
462      */
463     public function test_cron_mixed_email_2() {
464         global $DB, $CFG;
466         $this->resetAfterTest(true);
468         // Set up a basic user enrolled in a course.
469         $userhelper = $this->helper_setup_user_in_course();
470         $user = $userhelper->user;
471         $course1 = $userhelper->courses->course1;
472         $forum1 = $userhelper->forums->forum1;
473         $forum2 = $userhelper->forums->forum2;
475         // Add a discussion to the forums.
476         $record = new stdClass();
477         $record->course = $course1->id;
478         $record->userid = $user->id;
479         $record->mailnow = 1;
481         // Add 5 discussions to forum 1.
482         $record->forum = $forum1->id;
483         for ($i = 0; $i < 5; $i++) {
484             $this->getDataGenerator()->get_plugin_generator('mod_forum')->create_discussion($record);
485         }
487         // Add 5 discussions to forum 2.
488         $record->forum = $forum2->id;
489         for ($i = 0; $i < 5; $i++) {
490             $this->getDataGenerator()->get_plugin_generator('mod_forum')->create_discussion($record);
491         }
493         // Ensure that the creation times mean that the messages will be sent.
494         $this->helper_force_digest_mail_times();
496         // Set the tested user's default maildigest setting.
497         $DB->set_field('user', 'maildigest', 1, array('id' => $user->id));
499         // Set the maildigest preference for forum1 to digest.
500         forum_set_user_maildigest($forum1, -1, $user);
502         // Set the maildigest preference for forum2 to single.
503         forum_set_user_maildigest($forum2, 0, $user);
505         // One digest e-mail should be sent, and five individual notifications.
506         $this->helper_run_cron_check_count(1, 5, 1);
507     }
509     /**
510      * Sends several notifications to one user as:
511      * * daily digests coming from the per-forum setting.
512      */
513     public function test_cron_forum_digest_email() {
514         global $DB, $CFG;
516         $this->resetAfterTest(true);
518         // Set up a basic user enrolled in a course.
519         $userhelper = $this->helper_setup_user_in_course();
520         $user = $userhelper->user;
521         $course1 = $userhelper->courses->course1;
522         $forum1 = $userhelper->forums->forum1;
523         $forum2 = $userhelper->forums->forum2;
525         // Add a discussion to the forums.
526         $record = new stdClass();
527         $record->course = $course1->id;
528         $record->userid = $user->id;
529         $record->mailnow = 1;
531         // Add 5 discussions to forum 1.
532         $record->forum = $forum1->id;
533         for ($i = 0; $i < 5; $i++) {
534             $this->getDataGenerator()->get_plugin_generator('mod_forum')->create_discussion($record);
535         }
537         // Add 5 discussions to forum 2.
538         $record->forum = $forum2->id;
539         for ($i = 0; $i < 5; $i++) {
540             $this->getDataGenerator()->get_plugin_generator('mod_forum')->create_discussion($record);
541         }
543         // Ensure that the creation times mean that the messages will be sent.
544         $this->helper_force_digest_mail_times();
546         // Set the tested user's default maildigest setting.
547         $DB->set_field('user', 'maildigest', 0, array('id' => $user->id));
549         // Set the maildigest preference for forum1 to digest (complete).
550         forum_set_user_maildigest($forum1, 1, $user);
552         // Set the maildigest preference for forum2 to digest (short).
553         forum_set_user_maildigest($forum2, 2, $user);
555         // One digest e-mail should be sent, and no individual notifications.
556         $this->helper_run_cron_check_count(1, 0, 1);
557     }