mirror of
https://github.com/moodle/moodle.git
synced 2025-01-19 14:27:22 +01:00
83b490a594
Applied the following changes to various testcase classes: - Namespaced with component[\level2-API] - Moved to level2-API subdirectory when required. - Fixed incorrect use statements with leading backslash. - Remove file phpdoc block - Remove MOODLE_INTERNAL if not needed. - Changed code to point to global scope when needed. - Fix some relative paths and comments here and there. - All them passing individually. - Complete runs passing too. Special mention to: - The following task tests have been moved within the level2 directory: - \core\adhoc_task_test => \core\task\adhoc_task_test - \core\scheduled_task_test => \core\task\scheduled_task_test - \core\calendar_cron_task_test => \core\task\calendar_cron_task_test - \core\h5p_get_content_types_task_test => \core\task\h5p_get_content_types_task_test - \core\task_database_logger_test => \core\task\database_logger_test - \core\task_logging_test => \core\task\logging_test - The following event tests have been moved within level2 directory: - \core\event_context_locked_test => \core\event\context_locked_test - \core\event_deprecated_test => \core\event\deprecated_test - \core\event_grade_deleted_test => \core\event\grade_deleted_test - \core\event_profile_field_test => \core\event\profile_field_test - \core\event_unknown_logged_test => \core\event\unknown_logged_test - \core\event_user_graded_test => \core\event\user_graded_test - \core\event_user_password_updated_test => \core\event\user_password_updated_test - The following output tests have been moved within level2 directory: - \core\mustache_template_finder_test => \core\output\mustache_template_finder_test - \core\mustache_template_source_loader_test => \core\output\mustache_template_source_loader_test - \core\output_mustache_helper_collection_test => \core\output\mustache_helper_collection_test - The following tests have been moved to their correct tests directories: - lib/tests/time_splittings_test.php => analytics/tests/time_splittings_test.php - All the classes and tests under lib/filebrowser and lib/filestorage belong to core, not to core_files. Some day we should move them to their correct subsystem. - All the classes and tests under lib/grade belong to core, not to core_grades. Some day we should move them to their correct subsystem. - The core_grades_external class and its \core\grades_external_test unit test should belong to the grades subsystem or, alternatively, to \core\external, they both should be moved together. - The core_grading_external class and its \core\grading_external_test unit test should belong to the grading subsystem or, alternatively, to \core\external, they both should be moved together. - The \core\message\message and \core\message\inbound (may be others) classes, and their associated tests should go to the core_message subsystem. - The core_user class, and its associated tests should go to the core_user subsystem. - The \core\update namespace is plain wrong (update is not valid API) and needs action 1) create it or 2) move elsewhere.
261 lines
12 KiB
PHP
261 lines
12 KiB
PHP
<?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/>.
|
|
|
|
namespace core;
|
|
|
|
/**
|
|
* Test script for message class.
|
|
*
|
|
* Test classes for \core\message\message.
|
|
*
|
|
* @package core
|
|
* @category test
|
|
* @copyright 2015 onwards Ankit Agarwal
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class message_test 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->courseid = SITEID;
|
|
$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@example.com";
|
|
$message->replytoname = fullname($USER);
|
|
$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->courseid, $stdClass->courseid);
|
|
$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->replytoname, $stdClass->replytoname);
|
|
$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(array('maildisplay' => 1));
|
|
$user2 = $this->getDataGenerator()->create_user();
|
|
set_config('allowedemaildomains', 'example.com');
|
|
|
|
// 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_enabled', 'email', $user2);
|
|
|
|
// Extra content for all types of messages.
|
|
$message = new \core\message\message();
|
|
$message->courseid = 1;
|
|
$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('messages', array('id' => $messageid));
|
|
$this->assertSame(true, $recordexists);
|
|
$this->assertSame($user1->email, $email->from);
|
|
$this->assertSame($user2->email, $email->to);
|
|
$this->assertSame(get_string('unreadnewmessage', 'message', fullname($user1)), $email->subject);
|
|
$this->assertNotEmpty($email->header);
|
|
$this->assertNotEmpty($email->body);
|
|
$this->assertMatchesRegularExpression('/test.*message body.*test/s', $email->body);
|
|
$sink->clear();
|
|
|
|
// Test that event fired includes the courseid.
|
|
$eventsink = $this->redirectEvents();
|
|
$messageid = message_send($message);
|
|
$events = $eventsink->get_events();
|
|
$event = reset($events);
|
|
$this->assertEquals($message->courseid, $event->other['courseid']);
|
|
$eventsink->clear();
|
|
$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->courseid = 1;
|
|
$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('messages', array('id' => $messageid));
|
|
$this->assertSame(true, $recordexists);
|
|
$this->assertSame($user1->email, $email->from);
|
|
$this->assertSame($user2->email, $email->to);
|
|
$this->assertSame(get_string('unreadnewmessage', 'message', fullname($user1)), $email->subject);
|
|
$this->assertNotEmpty($email->header);
|
|
$this->assertNotEmpty($email->body);
|
|
$this->assertDoesNotMatchRegularExpression('/test.*message body test/', $email->body);
|
|
|
|
// Test that event fired includes the courseid.
|
|
$eventsink = $this->redirectEvents();
|
|
$messageid = message_send($message);
|
|
$events = $eventsink->get_events();
|
|
$event = reset($events);
|
|
$this->assertEquals($message->courseid, $event->other['courseid']);
|
|
$eventsink->close();
|
|
$sink->close();
|
|
}
|
|
|
|
public function test_send_message_with_prefix() {
|
|
global $DB, $CFG;
|
|
$this->preventResetByRollback();
|
|
$this->resetAfterTest();
|
|
|
|
$user1 = $this->getDataGenerator()->create_user(array('maildisplay' => 1));
|
|
$user2 = $this->getDataGenerator()->create_user();
|
|
set_config('allowedemaildomains', 'example.com');
|
|
set_config('emailsubjectprefix', '[Prefix Text]');
|
|
|
|
// 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_enabled', 'email', $user2);
|
|
|
|
// Check that prefix is ammended to the subject of the email.
|
|
$message = new \core\message\message();
|
|
$message->courseid = 1;
|
|
$message->component = 'moodle';
|
|
$message->name = 'instantmessage';
|
|
$message->userfrom = $user1;
|
|
$message->userto = $user2;
|
|
$message->subject = get_string('unreadnewmessage', 'message', fullname($user1));
|
|
$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);
|
|
$this->assertSame('[Prefix Text] '. get_string('unreadnewmessage', 'message', fullname($user1)), $email->subject);
|
|
$sink->clear();
|
|
}
|
|
}
|