From 93975a6afc3a4e7b0699c1da3e26a0058300b126 Mon Sep 17 00:00:00 2001
From: Ankit Agarwal <ankit@moodle.com>
Date: Thu, 22 Jan 2015 12:35:58 +0530
Subject: [PATCH] MDL-48212 messages: Add unit tests for the message class

---
 lib/tests/message_test.php | 204 +++++++++++++++++++++++++++++++++++++
 1 file changed, 204 insertions(+)
 create mode 100644 lib/tests/message_test.php

diff --git a/lib/tests/message_test.php b/lib/tests/message_test.php
new file mode 100644
index 00000000000..3713aacc6ab
--- /dev/null
+++ b/lib/tests/message_test.php
@@ -0,0 +1,204 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Test classes for \core\message\message.
+ *
+ * @package core_message
+ * @category test
+ * @copyright 2015 onwards Ankit Agarwal
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+
+/**
+ * Test script for message class.
+ *
+ * @package core_message
+ * @category test
+ * @copyright 2015 onwards Ankit Agarwal
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class core_message_testcase extends advanced_testcase {
+
+    /**
+     * Test the method get_eventobject_for_processor().
+     */
+    public function test_get_eventobject_for_processor() {
+        global $USER;
+        $this->resetAfterTest();
+        $this->setAdminUser();
+
+        $user = $this->getDataGenerator()->create_user();
+
+        $message = new \core\message\message();
+        $message->component = 'moodle';
+        $message->name = 'instantmessage';
+        $message->userfrom = $USER;
+        $message->userto = $user;
+        $message->subject = 'message subject 1';
+        $message->fullmessage = 'message body';
+        $message->fullmessageformat = FORMAT_MARKDOWN;
+        $message->fullmessagehtml = '<p>message body</p>';
+        $message->smallmessage = 'small message';
+        $message->notification = '0';
+        $message->contexturl = 'http://GalaxyFarFarAway.com';
+        $message->contexturlname = 'Context name';
+        $message->replyto = "random@random.com";
+        $message->attachname = 'attachment';
+        $content = array('*' => array('header' => ' test ', 'footer' => ' test ')); // Extra content for all types of messages.
+        $message->set_additional_content('test', $content);
+
+        // Create a file instance.
+        $usercontext = context_user::instance($user->id);
+        $file = new stdClass;
+        $file->contextid = $usercontext->id;
+        $file->component = 'user';
+        $file->filearea  = 'private';
+        $file->itemid    = 0;
+        $file->filepath  = '/';
+        $file->filename  = '1.txt';
+        $file->source    = 'test';
+
+        $fs = get_file_storage();
+        $file = $fs->create_file_from_string($file, 'file1 content');
+        $message->attachment = $file;
+
+        $stdclass = $message->get_eventobject_for_processor('test');
+
+        $this->assertSame($message->component, $stdclass->component);
+        $this->assertSame($message->name, $stdclass->name);
+        $this->assertSame($message->userfrom, $stdclass->userfrom);
+        $this->assertSame($message->userto, $stdclass->userto);
+        $this->assertSame($message->subject, $stdclass->subject);
+        $this->assertSame(' test ' . $message->fullmessage . ' test ', $stdclass->fullmessage);
+        $this->assertSame(' test ' . $message->fullmessagehtml . ' test ', $stdclass->fullmessagehtml);
+        $this->assertSame(' test ' . $message->smallmessage . ' test ', $stdclass->smallmessage);
+        $this->assertSame($message->notification, $stdclass->notification);
+        $this->assertSame($message->contexturl, $stdclass->contexturl);
+        $this->assertSame($message->contexturlname, $stdclass->contexturlname);
+        $this->assertSame($message->replyto, $stdclass->replyto);
+        $this->assertSame($message->attachname, $stdclass->attachname);
+
+        // Extra content for fullmessage only.
+        $content = array('fullmessage' => array('header' => ' test ', 'footer' => ' test '));
+        $message->set_additional_content('test', $content);
+        $stdclass = $message->get_eventobject_for_processor('test');
+        $this->assertSame(' test ' . $message->fullmessage . ' test ', $stdclass->fullmessage);
+        $this->assertSame($message->fullmessagehtml, $stdclass->fullmessagehtml);
+        $this->assertSame($message->smallmessage, $stdclass->smallmessage);
+
+        // Extra content for fullmessagehtml and smallmessage only.
+        $content = array('fullmessagehtml' => array('header' => ' test ', 'footer' => ' test '),
+                         'smallmessage' => array('header' => ' testsmall ', 'footer' => ' testsmall '));
+        $message->set_additional_content('test', $content);
+        $stdclass = $message->get_eventobject_for_processor('test');
+        $this->assertSame($message->fullmessage, $stdclass->fullmessage);
+        $this->assertSame(' test ' . $message->fullmessagehtml . ' test ', $stdclass->fullmessagehtml);
+        $this->assertSame(' testsmall ' . $message->smallmessage . ' testsmall ', $stdclass->smallmessage);
+
+        // Extra content for * and smallmessage.
+        $content = array('*' => array('header' => ' test ', 'footer' => ' test '),
+                         'smallmessage' => array('header' => ' testsmall ', 'footer' => ' testsmall '));
+        $message->set_additional_content('test', $content);
+        $stdclass = $message->get_eventobject_for_processor('test');
+        $this->assertSame(' test ' . $message->fullmessage . ' test ', $stdclass->fullmessage);
+        $this->assertSame(' test ' . $message->fullmessagehtml . ' test ', $stdclass->fullmessagehtml);
+        $this->assertSame(' testsmall ' . ' test ' .  $message->smallmessage . ' test ' . ' testsmall ', $stdclass->smallmessage);
+    }
+
+    /**
+     * Test sending messages as email works with the new class.
+     */
+    public function test_send_message() {
+        global $DB, $CFG;
+        $this->preventResetByRollback();
+        $this->resetAfterTest();
+
+        $user1 = $this->getDataGenerator()->create_user();
+        $user2 = $this->getDataGenerator()->create_user();
+
+        // Test basic email processor.
+        $this->assertFileExists("$CFG->dirroot/message/output/email/version.php");
+        $this->assertFileExists("$CFG->dirroot/message/output/popup/version.php");
+
+        $DB->set_field_select('message_processors', 'enabled', 0, "name <> 'email'");
+        set_user_preference('message_provider_moodle_instantmessage_loggedoff', 'email', $user2);
+
+        // Extra content for all types of messages.
+        $message = new \core\message\message();
+        $message->component         = 'moodle';
+        $message->name              = 'instantmessage';
+        $message->userfrom          = $user1;
+        $message->userto            = $user2;
+        $message->subject           = 'message subject 1';
+        $message->fullmessage       = 'message body';
+        $message->fullmessageformat = FORMAT_MARKDOWN;
+        $message->fullmessagehtml   = '<p>message body</p>';
+        $message->smallmessage      = 'small message';
+        $message->notification      = '0';
+        $content = array('*' => array('header' => ' test ', 'footer' => ' test '));
+        $message->set_additional_content('email', $content);
+
+        $sink = $this->redirectEmails();
+        $messageid = message_send($message);
+        $emails = $sink->get_messages();
+        $this->assertCount(1, $emails);
+        $email = reset($emails);
+        $recordexists = $DB->record_exists('message_read', array('id' => $messageid));
+        $this->assertSame(true, $recordexists);
+        $this->assertSame($user1->email, $email->from);
+        $this->assertSame($user2->email, $email->to);
+        $this->assertSame($message->subject, $email->subject);
+        $this->assertNotEmpty($email->header);
+        $this->assertNotEmpty($email->body);
+        $this->assertRegExp('/test message body test/', $email->body);
+        $sink->clear();
+
+        // Extra content for small message only. Shouldn't show up in emails as we sent fullmessage and fullmessagehtml only in
+        // the emails.
+        $message = new \core\message\message();
+        $message->component         = 'moodle';
+        $message->name              = 'instantmessage';
+        $message->userfrom          = $user1;
+        $message->userto            = $user2;
+        $message->subject           = 'message subject 1';
+        $message->fullmessage       = 'message body';
+        $message->fullmessageformat = FORMAT_MARKDOWN;
+        $message->fullmessagehtml   = '<p>message body</p>';
+        $message->smallmessage      = 'small message';
+        $message->notification      = '0';
+        $content = array('smallmessage' => array('header' => ' test ', 'footer' => ' test '));
+        $message->set_additional_content('email', $content);
+
+        $messageid = message_send($message);
+        $emails = $sink->get_messages();
+        $this->assertCount(1, $emails);
+        $email = reset($emails);
+        $recordexists = $DB->record_exists('message_read', array('id' => $messageid));
+        $this->assertSame(true, $recordexists);
+        $this->assertSame($user1->email, $email->from);
+        $this->assertSame($user2->email, $email->to);
+        $this->assertSame($message->subject, $email->subject);
+        $this->assertNotEmpty($email->header);
+        $this->assertNotEmpty($email->body);
+        $this->assertNotRegExp('/test message body test/', $email->body);
+        $sink->close();
+    }
+}
\ No newline at end of file