mirror of
https://github.com/moodle/moodle.git
synced 2025-03-03 15:29:08 +01:00
f52459bbbe
If there are multiple, non-repeating events with the same module name, instance and event type. The most specific event or the event with the highest priority will be shown. The ordering of event priorities: User override events > Group override events > Course events. If there are no user override events and there are multiple group overrides for an event, then the one with the highest priority will be shown.
364 lines
14 KiB
PHP
364 lines
14 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/>.
|
|
|
|
/**
|
|
* Calendar lib unit tests
|
|
*
|
|
* @package core_calendar
|
|
* @copyright 2013 Dan Poltawski <dan@moodle.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
global $CFG;
|
|
require_once($CFG->dirroot . '/calendar/lib.php');
|
|
|
|
/**
|
|
* Unit tests for calendar lib
|
|
*
|
|
* @package core_calendar
|
|
* @copyright 2013 Dan Poltawski <dan@moodle.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class core_calendar_lib_testcase extends advanced_testcase {
|
|
|
|
protected function setUp() {
|
|
$this->resetAfterTest(true);
|
|
}
|
|
|
|
public function test_calendar_get_course_cached() {
|
|
// Setup some test courses.
|
|
$course1 = $this->getDataGenerator()->create_course();
|
|
$course2 = $this->getDataGenerator()->create_course();
|
|
$course3 = $this->getDataGenerator()->create_course();
|
|
|
|
// Load courses into cache.
|
|
$coursecache = null;
|
|
calendar_get_course_cached($coursecache, $course1->id);
|
|
calendar_get_course_cached($coursecache, $course2->id);
|
|
calendar_get_course_cached($coursecache, $course3->id);
|
|
|
|
// Verify the cache.
|
|
$this->assertArrayHasKey($course1->id, $coursecache);
|
|
$cachedcourse1 = $coursecache[$course1->id];
|
|
$this->assertEquals($course1->id, $cachedcourse1->id);
|
|
$this->assertEquals($course1->shortname, $cachedcourse1->shortname);
|
|
$this->assertEquals($course1->fullname, $cachedcourse1->fullname);
|
|
|
|
$this->assertArrayHasKey($course2->id, $coursecache);
|
|
$cachedcourse2 = $coursecache[$course2->id];
|
|
$this->assertEquals($course2->id, $cachedcourse2->id);
|
|
$this->assertEquals($course2->shortname, $cachedcourse2->shortname);
|
|
$this->assertEquals($course2->fullname, $cachedcourse2->fullname);
|
|
|
|
$this->assertArrayHasKey($course3->id, $coursecache);
|
|
$cachedcourse3 = $coursecache[$course3->id];
|
|
$this->assertEquals($course3->id, $cachedcourse3->id);
|
|
$this->assertEquals($course3->shortname, $cachedcourse3->shortname);
|
|
$this->assertEquals($course3->fullname, $cachedcourse3->fullname);
|
|
}
|
|
|
|
/**
|
|
* Test calendar cron with a working subscription URL.
|
|
*/
|
|
public function test_calendar_cron_working_url() {
|
|
global $CFG;
|
|
require_once($CFG->dirroot . '/lib/cronlib.php');
|
|
|
|
// ICal URL from external test repo.
|
|
$subscriptionurl = $this->getExternalTestFileUrl('/ical.ics');
|
|
|
|
$subscription = new stdClass();
|
|
$subscription->eventtype = 'site';
|
|
$subscription->name = 'test';
|
|
$subscription->url = $subscriptionurl;
|
|
$subscription->pollinterval = 86400;
|
|
$subscription->lastupdated = 0;
|
|
calendar_add_subscription($subscription);
|
|
|
|
$this->expectOutputRegex('/Events imported: .* Events updated:/');
|
|
calendar_cron();
|
|
}
|
|
|
|
/**
|
|
* Test calendar cron with a broken subscription URL.
|
|
*/
|
|
public function test_calendar_cron_broken_url() {
|
|
global $CFG;
|
|
require_once($CFG->dirroot . '/lib/cronlib.php');
|
|
|
|
$subscription = new stdClass();
|
|
$subscription->eventtype = 'site';
|
|
$subscription->name = 'test';
|
|
$subscription->url = 'brokenurl';
|
|
$subscription->pollinterval = 86400;
|
|
$subscription->lastupdated = 0;
|
|
calendar_add_subscription($subscription);
|
|
|
|
$this->expectOutputRegex('/Error updating calendar subscription: The given iCal URL is invalid/');
|
|
calendar_cron();
|
|
}
|
|
|
|
/**
|
|
* Test the calendar_get_events() function only returns activity
|
|
* events that are enabled.
|
|
*/
|
|
public function test_calendar_get_events_with_disabled_module() {
|
|
global $DB;
|
|
|
|
$generator = $this->getDataGenerator();
|
|
$course = $generator->create_course();
|
|
$student = $generator->create_user();
|
|
$generator->enrol_user($student->id, $course->id, 'student');
|
|
$this->setUser($student);
|
|
|
|
$events = [
|
|
[
|
|
'name' => 'Start of assignment',
|
|
'description' => '',
|
|
'format' => 1,
|
|
'courseid' => $course->id,
|
|
'groupid' => 0,
|
|
'userid' => 2,
|
|
'modulename' => 'assign',
|
|
'instance' => 1,
|
|
'eventtype' => 'due',
|
|
'timestart' => time(),
|
|
'timeduration' => 86400,
|
|
'visible' => 1
|
|
], [
|
|
|
|
'name' => 'Start of lesson',
|
|
'description' => '',
|
|
'format' => 1,
|
|
'courseid' => $course->id,
|
|
'groupid' => 0,
|
|
'userid' => 2,
|
|
'modulename' => 'lesson',
|
|
'instance' => 1,
|
|
'eventtype' => 'end',
|
|
'timestart' => time(),
|
|
'timeduration' => 86400,
|
|
'visible' => 1
|
|
]
|
|
];
|
|
|
|
foreach ($events as $event) {
|
|
calendar_event::create($event, false);
|
|
}
|
|
|
|
$timestart = time() - 60;
|
|
$timeend = time() + 60;
|
|
|
|
// Get all events.
|
|
$events = calendar_get_events($timestart, $timeend, true, 0, true);
|
|
$this->assertCount(2, $events);
|
|
|
|
// Disable the lesson module.
|
|
$modulerecord = $DB->get_record('modules', ['name' => 'lesson']);
|
|
$modulerecord->visible = 0;
|
|
$DB->update_record('modules', $modulerecord);
|
|
|
|
// Check that we only return the assign event.
|
|
$events = calendar_get_events($timestart, $timeend, true, 0, true);
|
|
$this->assertCount(1, $events);
|
|
$event = reset($events);
|
|
$this->assertEquals('assign', $event->modulename);
|
|
}
|
|
|
|
/**
|
|
* Test for calendar_get_events() when there are user and group overrides.
|
|
*/
|
|
public function test_calendar_get_events_with_overrides() {
|
|
global $DB;
|
|
|
|
$generator = $this->getDataGenerator();
|
|
$course = $generator->create_course();
|
|
$plugingenerator = $this->getDataGenerator()->get_plugin_generator('mod_assign');
|
|
if (!isset($params['course'])) {
|
|
$params['course'] = $course->id;
|
|
}
|
|
$instance = $plugingenerator->create_instance($params);
|
|
|
|
// Create users.
|
|
$useroverridestudent = $generator->create_user();
|
|
$group1student = $generator->create_user();
|
|
$group2student = $generator->create_user();
|
|
$group12student = $generator->create_user();
|
|
$nogroupstudent = $generator->create_user();
|
|
|
|
// Enrol users.
|
|
$generator->enrol_user($useroverridestudent->id, $course->id, 'student');
|
|
$generator->enrol_user($group1student->id, $course->id, 'student');
|
|
$generator->enrol_user($group2student->id, $course->id, 'student');
|
|
$generator->enrol_user($group12student->id, $course->id, 'student');
|
|
$generator->enrol_user($nogroupstudent->id, $course->id, 'student');
|
|
|
|
// Create groups.
|
|
$group1 = $generator->create_group(['courseid' => $course->id]);
|
|
$group2 = $generator->create_group(['courseid' => $course->id]);
|
|
|
|
// Add members to groups.
|
|
$generator->create_group_member(['groupid' => $group1->id, 'userid' => $group1student->id]);
|
|
$generator->create_group_member(['groupid' => $group2->id, 'userid' => $group2student->id]);
|
|
$generator->create_group_member(['groupid' => $group1->id, 'userid' => $group12student->id]);
|
|
$generator->create_group_member(['groupid' => $group2->id, 'userid' => $group12student->id]);
|
|
|
|
$now = time();
|
|
// Events with the same module name, instance and event type.
|
|
$events = [
|
|
[
|
|
'name' => 'Assignment 1 due date',
|
|
'description' => '',
|
|
'format' => 0,
|
|
'courseid' => $course->id,
|
|
'groupid' => 0,
|
|
'userid' => 2,
|
|
'modulename' => 'assign',
|
|
'instance' => $instance->id,
|
|
'eventtype' => 'due',
|
|
'timestart' => $now,
|
|
'timeduration' => 0,
|
|
'visible' => 1
|
|
], [
|
|
'name' => 'Assignment 1 due date - User override',
|
|
'description' => '',
|
|
'format' => 1,
|
|
'courseid' => 0,
|
|
'groupid' => 0,
|
|
'userid' => $useroverridestudent->id,
|
|
'modulename' => 'assign',
|
|
'instance' => $instance->id,
|
|
'eventtype' => 'due',
|
|
'timestart' => $now + 86400,
|
|
'timeduration' => 0,
|
|
'visible' => 1,
|
|
'priority' => CALENDAR_EVENT_USER_OVERRIDE_PRIORITY
|
|
], [
|
|
'name' => 'Assignment 1 due date - Group A override',
|
|
'description' => '',
|
|
'format' => 1,
|
|
'courseid' => $course->id,
|
|
'groupid' => $group1->id,
|
|
'userid' => 2,
|
|
'modulename' => 'assign',
|
|
'instance' => $instance->id,
|
|
'eventtype' => 'due',
|
|
'timestart' => $now + (2 * 86400),
|
|
'timeduration' => 0,
|
|
'visible' => 1,
|
|
'priority' => 1,
|
|
], [
|
|
'name' => 'Assignment 1 due date - Group B override',
|
|
'description' => '',
|
|
'format' => 1,
|
|
'courseid' => $course->id,
|
|
'groupid' => $group2->id,
|
|
'userid' => 2,
|
|
'modulename' => 'assign',
|
|
'instance' => $instance->id,
|
|
'eventtype' => 'due',
|
|
'timestart' => $now + (3 * 86400),
|
|
'timeduration' => 0,
|
|
'visible' => 1,
|
|
'priority' => 2,
|
|
],
|
|
];
|
|
|
|
foreach ($events as $event) {
|
|
calendar_event::create($event, false);
|
|
}
|
|
|
|
$timestart = $now - 100;
|
|
$timeend = $now + (3 * 86400);
|
|
|
|
$groups = [$group1->id, $group2->id];
|
|
|
|
// Get user override events.
|
|
$this->setUser($useroverridestudent);
|
|
$events = calendar_get_events($timestart, $timeend, $useroverridestudent->id, $groups, $course->id);
|
|
$this->assertCount(1, $events);
|
|
$event = reset($events);
|
|
$this->assertEquals('Assignment 1 due date - User override', $event->name);
|
|
|
|
// Get event for user with override but with the timestart and timeend parameters only covering the original event.
|
|
$events = calendar_get_events($timestart, $now, $useroverridestudent->id, $groups, $course->id);
|
|
$this->assertCount(0, $events);
|
|
|
|
// Get events for user that does not belong to any group and has no user override events.
|
|
$this->setUser($nogroupstudent);
|
|
$events = calendar_get_events($timestart, $timeend, $nogroupstudent->id, $groups, $course->id);
|
|
$this->assertCount(1, $events);
|
|
$event = reset($events);
|
|
$this->assertEquals('Assignment 1 due date', $event->name);
|
|
|
|
// Get events for user that belongs to groups A and B and has no user override events.
|
|
$this->setUser($group12student);
|
|
$events = calendar_get_events($timestart, $timeend, $group12student->id, $groups, $course->id);
|
|
$this->assertCount(1, $events);
|
|
$event = reset($events);
|
|
$this->assertEquals('Assignment 1 due date - Group B override', $event->name);
|
|
|
|
// Get events for user that belongs to group A and has no user override events.
|
|
$this->setUser($group1student);
|
|
$events = calendar_get_events($timestart, $timeend, $group1student->id, $groups, $course->id);
|
|
$this->assertCount(1, $events);
|
|
$event = reset($events);
|
|
$this->assertEquals('Assignment 1 due date - Group A override', $event->name);
|
|
|
|
// Add repeating events.
|
|
$repeatingevents = [
|
|
[
|
|
'name' => 'Repeating site event',
|
|
'description' => '',
|
|
'format' => 1,
|
|
'courseid' => SITEID,
|
|
'groupid' => 0,
|
|
'userid' => 2,
|
|
'repeatid' => 1,
|
|
'modulename' => '0',
|
|
'instance' => 0,
|
|
'eventtype' => 'site',
|
|
'timestart' => $now + 86400,
|
|
'timeduration' => 0,
|
|
'visible' => 1,
|
|
],
|
|
[
|
|
'name' => 'Repeating site event',
|
|
'description' => '',
|
|
'format' => 1,
|
|
'courseid' => SITEID,
|
|
'groupid' => 0,
|
|
'userid' => 2,
|
|
'repeatid' => 1,
|
|
'modulename' => '0',
|
|
'instance' => 0,
|
|
'eventtype' => 'site',
|
|
'timestart' => $now + (2 * 86400),
|
|
'timeduration' => 0,
|
|
'visible' => 1,
|
|
],
|
|
];
|
|
foreach ($repeatingevents as $event) {
|
|
calendar_event::create($event, false);
|
|
}
|
|
|
|
// Make sure repeating events are not filtered out.
|
|
$events = calendar_get_events($timestart, $timeend, true, true, true);
|
|
$this->assertCount(3, $events);
|
|
}
|
|
}
|