You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

1294 lines
51 KiB

<?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/>.
/**
* Choice module library functions tests
*
* @package mod_choice
* @category test
* @copyright 2015 Juan Leyva <juan@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 3.0
*/
defined('MOODLE_INTERNAL') || die();
global $CFG;
require_once($CFG->dirroot . '/webservice/tests/helpers.php');
require_once($CFG->dirroot . '/mod/choice/lib.php');
/**
* Choice module library functions tests
*
* @package mod_choice
* @category test
* @copyright 2015 Juan Leyva <juan@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 3.0
*/
class mod_choice_lib_testcase extends externallib_advanced_testcase {
/**
* Test choice_view
* @return void
*/
public function test_choice_view() {
global $CFG;
$this->resetAfterTest();
$this->setAdminUser();
// Setup test data.
$course = $this->getDataGenerator()->create_course();
$choice = $this->getDataGenerator()->create_module('choice', array('course' => $course->id));
$context = context_module::instance($choice->cmid);
$cm = get_coursemodule_from_instance('choice', $choice->id);
// Trigger and capture the event.
$sink = $this->redirectEvents();
choice_view($choice, $course, $cm, $context);
$events = $sink->get_events();
$this->assertCount(1, $events);
$event = array_shift($events);
// Checking that the event contains the expected values.
$this->assertInstanceOf('\mod_choice\event\course_module_viewed', $event);
$this->assertEquals($context, $event->get_context());
$url = new \moodle_url('/mod/choice/view.php', array('id' => $cm->id));
$this->assertEquals($url, $event->get_url());
$this->assertEventContextNotUsed($event);
$this->assertNotEmpty($event->get_name());
}
/**
* Test choice_can_view_results
* @return void
*/
public function test_choice_can_view_results() {
global $DB, $USER;
$this->resetAfterTest();
$this->setAdminUser();
// Setup test data.
$course = $this->getDataGenerator()->create_course();
$choice = $this->getDataGenerator()->create_module('choice', array('course' => $course->id));
$context = context_module::instance($choice->cmid);
$cm = get_coursemodule_from_instance('choice', $choice->id);
// Default values are false, user cannot view results.
$canview = choice_can_view_results($choice);
$this->assertFalse($canview);
// Show results forced.
$choice->showresults = CHOICE_SHOWRESULTS_ALWAYS;
$DB->update_record('choice', $choice);
$canview = choice_can_view_results($choice);
$this->assertTrue($canview);
// Add a time restriction (choice not open yet).
$choice->timeopen = time() + YEARSECS;
$DB->update_record('choice', $choice);
$canview = choice_can_view_results($choice);
$this->assertFalse($canview);
// Show results after closing.
$choice->timeopen = 0;
$choice->showresults = CHOICE_SHOWRESULTS_AFTER_CLOSE;
$DB->update_record('choice', $choice);
$canview = choice_can_view_results($choice);
$this->assertFalse($canview);
$choice->timeclose = time() - HOURSECS;
$DB->update_record('choice', $choice);
$canview = choice_can_view_results($choice);
$this->assertTrue($canview);
// Show results after answering.
$choice->timeclose = 0;
$choice->showresults = CHOICE_SHOWRESULTS_AFTER_ANSWER;
$DB->update_record('choice', $choice);
$canview = choice_can_view_results($choice);
$this->assertFalse($canview);
// Get the first option.
$choicewithoptions = choice_get_choice($choice->id);
$optionids = array_keys($choicewithoptions->option);
choice_user_submit_response($optionids[0], $choice, $USER->id, $course, $cm);
$canview = choice_can_view_results($choice);
$this->assertTrue($canview);
}
/**
* @expectedException moodle_exception
*/
public function test_choice_user_submit_response_validation() {
global $USER;
$this->resetAfterTest();
$this->setAdminUser();
// Setup test data.
$course = $this->getDataGenerator()->create_course();
$choice1 = $this->getDataGenerator()->create_module('choice', array('course' => $course->id));
$choice2 = $this->getDataGenerator()->create_module('choice', array('course' => $course->id));
$cm = get_coursemodule_from_instance('choice', $choice1->id);
$choicewithoptions1 = choice_get_choice($choice1->id);
$choicewithoptions2 = choice_get_choice($choice2->id);
$optionids1 = array_keys($choicewithoptions1->option);
$optionids2 = array_keys($choicewithoptions2->option);
// Make sure we cannot submit options from a different choice instance.
choice_user_submit_response($optionids2[0], $choice1, $USER->id, $course, $cm);
}
/**
* Test choice_get_user_response
* @return void
*/
public function test_choice_get_user_response() {
$this->resetAfterTest();
$this->setAdminUser();
// Setup test data.
$course = $this->getDataGenerator()->create_course();
$student = $this->getDataGenerator()->create_and_enrol($course, 'student');
$choice = $this->getDataGenerator()->create_module('choice', array('course' => $course->id));
$cm = get_coursemodule_from_instance('choice', $choice->id);
$choicewithoptions = choice_get_choice($choice->id);
$optionids = array_keys($choicewithoptions->option);
choice_user_submit_response($optionids[0], $choice, $student->id, $course, $cm);
$responses = choice_get_user_response($choice, $student->id);
$this->assertCount(1, $responses);
$response = array_shift($responses);
$this->assertEquals($optionids[0], $response->optionid);
// Multiple responses.
$choice = $this->getDataGenerator()->create_module('choice', array('course' => $course->id, 'allowmultiple' => 1));
$cm = get_coursemodule_from_instance('choice', $choice->id);
$choicewithoptions = choice_get_choice($choice->id);
$optionids = array_keys($choicewithoptions->option);
// Submit a response with the options reversed.
$selections = $optionids;
rsort($selections);
choice_user_submit_response($selections, $choice, $student->id, $course, $cm);
$responses = choice_get_user_response($choice, $student->id);
$this->assertCount(count($optionids), $responses);
foreach ($responses as $resp) {
$this->assertEquals(array_shift($optionids), $resp->optionid);
}
}
/**
* Test choice_get_my_response
* @return void
*/
public function test_choice_get_my_response() {
global $USER;
$this->resetAfterTest();
$this->setAdminUser();
// Setup test data.
$course = $this->getDataGenerator()->create_course();
$choice = $this->getDataGenerator()->create_module('choice', array('course' => $course->id));
$cm = get_coursemodule_from_instance('choice', $choice->id);
$choicewithoptions = choice_get_choice($choice->id);
$optionids = array_keys($choicewithoptions->option);
choice_user_submit_response($optionids[0], $choice, $USER->id, $course, $cm);
$responses = choice_get_my_response($choice);
$this->assertCount(1, $responses);
$response = array_shift($responses);
$this->assertEquals($optionids[0], $response->optionid);
// Multiple responses.
$choice = $this->getDataGenerator()->create_module('choice', array('course' => $course->id, 'allowmultiple' => 1));
$cm = get_coursemodule_from_instance('choice', $choice->id);
$choicewithoptions = choice_get_choice($choice->id);
$optionids = array_keys($choicewithoptions->option);
// Submit a response with the options reversed.
$selections = $optionids;
rsort($selections);
choice_user_submit_response($selections, $choice, $USER->id, $course, $cm);
$responses = choice_get_my_response($choice);
$this->assertCount(count($optionids), $responses);
foreach ($responses as $resp) {
$this->assertEquals(array_shift($optionids), $resp->optionid);
}
}
/**
* Test choice_get_availability_status
* @return void
*/
public function test_choice_get_availability_status() {
global $USER;
$this->resetAfterTest();
$this->setAdminUser();
// Setup test data.
$course = $this->getDataGenerator()->create_course();
$choice = $this->getDataGenerator()->create_module('choice', array('course' => $course->id));
// No time restrictions and updates allowed.
list($status, $warnings) = choice_get_availability_status($choice, false);
$this->assertEquals(true, $status);
$this->assertCount(0, $warnings);
// No updates allowed, but haven't answered yet.
$choice->allowupdate = false;
list($status, $warnings) = choice_get_availability_status($choice, false);
$this->assertEquals(true, $status);
$this->assertCount(0, $warnings);
// No updates allowed and have answered.
$cm = get_coursemodule_from_instance('choice', $choice->id);
$choicewithoptions = choice_get_choice($choice->id);
$optionids = array_keys($choicewithoptions->option);
choice_user_submit_response($optionids[0], $choice, $USER->id, $course, $cm);
list($status, $warnings) = choice_get_availability_status($choice, false);
$this->assertEquals(false, $status);
$this->assertCount(1, $warnings);
$this->assertEquals('choicesaved', array_keys($warnings)[0]);
$choice->allowupdate = true;
// With time restrictions, still open.
$choice->timeopen = time() - DAYSECS;
$choice->timeclose = time() + DAYSECS;
list($status, $warnings) = choice_get_availability_status($choice, false);
$this->assertEquals(true, $status);
$this->assertCount(0, $warnings);
// Choice not open yet.
$choice->timeopen = time() + DAYSECS;
$choice->timeclose = $choice->timeopen + DAYSECS;
list($status, $warnings) = choice_get_availability_status($choice, false);
$this->assertEquals(false, $status);
$this->assertCount(1, $warnings);
$this->assertEquals('notopenyet', array_keys($warnings)[0]);
// Choice closed.
$choice->timeopen = time() - DAYSECS;
$choice->timeclose = time() - 1;
list($status, $warnings) = choice_get_availability_status($choice, false);
$this->assertEquals(false, $status);
$this->assertCount(1, $warnings);
$this->assertEquals('expired', array_keys($warnings)[0]);
}
/*
* The choice's event should not be shown to a user when the user cannot view the choice activity at all.
*/
public function test_choice_core_calendar_provide_event_action_in_hidden_section() {
global $CFG;
$this->resetAfterTest();
$this->setAdminUser();
// Create a course.
$course = $this->getDataGenerator()->create_course();
// Create a student.
$student = $this->getDataGenerator()->create_and_enrol($course, 'student');
// Create a choice.
$choice = $this->getDataGenerator()->create_module('choice', array('course' => $course->id,
'timeopen' => time() - DAYSECS, 'timeclose' => time() + DAYSECS));
// Create a calendar event.
$event = $this->create_action_event($course->id, $choice->id, CHOICE_EVENT_TYPE_OPEN);
// Set sections 0 as hidden.
set_section_visible($course->id, 0, 0);
// Now, log out.
$CFG->forcelogin = true; // We don't want to be logged in as guest, as guest users might still have some capabilities.
$this->setUser();
// Create an action factory.
$factory = new \core_calendar\action_factory();
// Decorate action event for the student.
$actionevent = mod_choice_core_calendar_provide_event_action($event, $factory, $student->id);
// Confirm the event is not shown at all.
$this->assertNull($actionevent);
}
/*
* The choice's event should not be shown to a user who does not have permission to view the choice.
*/
public function test_choice_core_calendar_provide_event_action_for_non_user() {
global $CFG;
$this->resetAfterTest();
$this->setAdminUser();
// Create a course.
$course = $this->getDataGenerator()->create_course();
// Create a choice.
$choice = $this->getDataGenerator()->create_module('choice', array('course' => $course->id,
'timeopen' => time() - DAYSECS, 'timeclose' => time() + DAYSECS));
// Create a calendar event.
$event = $this->create_action_event($course->id, $choice->id, CHOICE_EVENT_TYPE_OPEN);
// Now, log out.
$CFG->forcelogin = true; // We don't want to be logged in as guest, as guest users might still have some capabilities.
$this->setUser();
// Create an action factory.
$factory = new \core_calendar\action_factory();
// Decorate action event.
$actionevent = mod_choice_core_calendar_provide_event_action($event, $factory);
// Confirm the event is not shown at all.
$this->assertNull($actionevent);
}
public function test_choice_core_calendar_provide_event_action_open() {
$this->resetAfterTest();
$this->setAdminUser();
// Create a course.
$course = $this->getDataGenerator()->create_course();
// Create a choice.
$choice = $this->getDataGenerator()->create_module('choice', array('course' => $course->id,
'timeopen' => time() - DAYSECS, 'timeclose' => time() + DAYSECS));
// Create a calendar event.
$event = $this->create_action_event($course->id, $choice->id, CHOICE_EVENT_TYPE_OPEN);
// Create an action factory.
$factory = new \core_calendar\action_factory();
// Decorate action event.
$actionevent = mod_choice_core_calendar_provide_event_action($event, $factory);
// Confirm the event was decorated.
$this->assertInstanceOf('\core_calendar\local\event\value_objects\action', $actionevent);
$this->assertEquals(get_string('viewchoices', 'choice'), $actionevent->get_name());
$this->assertInstanceOf('moodle_url', $actionevent->get_url());
$this->assertEquals(1, $actionevent->get_item_count());
$this->assertTrue($actionevent->is_actionable());
}
public function test_choice_core_calendar_provide_event_action_open_for_user() {
$this->resetAfterTest();
$this->setAdminUser();
// Create a course.
$course = $this->getDataGenerator()->create_course();
// Create a student.
$student = $this->getDataGenerator()->create_and_enrol($course, 'student');
// Create a choice.
$choice = $this->getDataGenerator()->create_module('choice', array('course' => $course->id,
'timeopen' => time() - DAYSECS, 'timeclose' => time() + DAYSECS));
// Create a calendar event.
$event = $this->create_action_event($course->id, $choice->id, CHOICE_EVENT_TYPE_OPEN);
// Create an action factory.
$factory = new \core_calendar\action_factory();
// Decorate action event for the student.
$actionevent = mod_choice_core_calendar_provide_event_action($event, $factory, $student->id);
// Confirm the event was decorated.
$this->assertInstanceOf('\core_calendar\local\event\value_objects\action', $actionevent);
$this->assertEquals(get_string('viewchoices', 'choice'), $actionevent->get_name());
$this->assertInstanceOf('moodle_url', $actionevent->get_url());
$this->assertEquals(1, $actionevent->get_item_count());
$this->assertTrue($actionevent->is_actionable());
}
/**
* An event should not have an action if the user has already submitted a response
* to the choice activity.
*/
public function test_choice_core_calendar_provide_event_action_already_submitted() {
$this->resetAfterTest();
$this->setAdminUser();
// Create a course.
$course = $this->getDataGenerator()->create_course();
// Create a student.
$student = $this->getDataGenerator()->create_and_enrol($course, 'student');
// Create a choice.
$choice = $this->getDataGenerator()->create_module('choice', array('course' => $course->id,
'timeopen' => time() - DAYSECS, 'timeclose' => time() + DAYSECS));
$cm = get_coursemodule_from_instance('choice', $choice->id);
$choicewithoptions = choice_get_choice($choice->id);
$optionids = array_keys($choicewithoptions->option);
choice_user_submit_response($optionids[0], $choice, $student->id, $course, $cm);
// Create a calendar event.
$event = $this->create_action_event($course->id, $choice->id, CHOICE_EVENT_TYPE_OPEN);
// Create an action factory.
$factory = new \core_calendar\action_factory();
$this->setUser($student);
// Decorate action event.
$action = mod_choice_core_calendar_provide_event_action($event, $factory);
// Confirm no action was returned if the user has already submitted the
// choice activity.
$this->assertNull($action);
}
/**
* An event should not have an action if the user has already submitted a response
* to the choice activity.
*/
public function test_choice_core_calendar_provide_event_action_already_submitted_for_user() {
$this->resetAfterTest();
$this->setAdminUser();
// Create a course.
$course = $this->getDataGenerator()->create_course();
// Create a student.
$student = $this->getDataGenerator()->create_and_enrol($course, 'student');
// Create a choice.
$choice = $this->getDataGenerator()->create_module('choice', array('course' => $course->id,
'timeopen' => time() - DAYSECS, 'timeclose' => time() + DAYSECS));
$cm = get_coursemodule_from_instance('choice', $choice->id);
$choicewithoptions = choice_get_choice($choice->id);
$optionids = array_keys($choicewithoptions->option);
choice_user_submit_response($optionids[0], $choice, $student->id, $course, $cm);
// Create a calendar event.
$event = $this->create_action_event($course->id, $choice->id, CHOICE_EVENT_TYPE_OPEN);
// Create an action factory.
$factory = new \core_calendar\action_factory();
// Decorate action event for the student.
$action = mod_choice_core_calendar_provide_event_action($event, $factory, $student->id);
// Confirm no action was returned if the user has already submitted the
// choice activity.
$this->assertNull($action);
}
public function test_choice_core_calendar_provide_event_action_closed() {
$this->resetAfterTest();
$this->setAdminUser();
// Create a course.
$course = $this->getDataGenerator()->create_course();
$timeclose = time() - DAYSECS;
// Create a choice.
$choice = $this->getDataGenerator()->create_module('choice', array('course' => $course->id,
'timeclose' => $timeclose));
// Create a calendar event.
$event = $this->create_action_event($course->id, $choice->id, CHOICE_EVENT_TYPE_OPEN, $timeclose - 1);
// Create an action factory.
$factory = new \core_calendar\action_factory();
// Decorate action event.
$action = mod_choice_core_calendar_provide_event_action($event, $factory);
// Confirm not action was provided for a closed activity.
$this->assertNull($action);
}
public function test_choice_core_calendar_provide_event_action_closed_for_user() {
$this->resetAfterTest();
$this->setAdminUser();
// Create a course.
$course = $this->getDataGenerator()->create_course();
// Create a student.
$student = $this->getDataGenerator()->create_and_enrol($course, 'student');
$timeclose = time() - DAYSECS;
// Create a choice.
$choice = $this->getDataGenerator()->create_module('choice', array('course' => $course->id,
'timeclose' => $timeclose));
// Create a calendar event.
$event = $this->create_action_event($course->id, $choice->id, CHOICE_EVENT_TYPE_OPEN, $timeclose - 1);
// Create an action factory.
$factory = new \core_calendar\action_factory();
// Decorate action event for the student.
$action = mod_choice_core_calendar_provide_event_action($event, $factory, $student->id);
// Confirm not action was provided for a closed activity.
$this->assertNull($action);
}
public function test_choice_core_calendar_provide_event_action_open_in_future() {
$this->resetAfterTest();
$this->setAdminUser();
// Create a course.
$course = $this->getDataGenerator()->create_course();
$timeopen = time() + DAYSECS;
$timeclose = $timeopen + DAYSECS;
// Create a choice.
$choice = $this->getDataGenerator()->create_module('choice', array('course' => $course->id,
'timeopen' => $timeopen, 'timeclose' => $timeclose));
// Create a calendar event.
$event = $this->create_action_event($course->id, $choice->id, CHOICE_EVENT_TYPE_OPEN, $timeopen);
// Create an action factory.
$factory = new \core_calendar\action_factory();
// Decorate action event.
$actionevent = mod_choice_core_calendar_provide_event_action($event, $factory);
// Confirm the event was decorated.
$this->assertInstanceOf('\core_calendar\local\event\value_objects\action', $actionevent);
$this->assertEquals(get_string('viewchoices', 'choice'), $actionevent->get_name());
$this->assertInstanceOf('moodle_url', $actionevent->get_url());
$this->assertEquals(1, $actionevent->get_item_count());
$this->assertFalse($actionevent->is_actionable());
}
public function test_choice_core_calendar_provide_event_action_open_in_future_for_user() {
global $CFG;
$this->resetAfterTest();
$this->setAdminUser();
// Create a course.
$course = $this->getDataGenerator()->create_course();
// Create a student.
$student = $this->getDataGenerator()->create_and_enrol($course, 'student');
$timeopen = time() + DAYSECS;
$timeclose = $timeopen + DAYSECS;
// Create a choice.
$choice = $this->getDataGenerator()->create_module('choice', array('course' => $course->id,
'timeopen' => $timeopen, 'timeclose' => $timeclose));
// Create a calendar event.
$event = $this->create_action_event($course->id, $choice->id, CHOICE_EVENT_TYPE_OPEN, $timeopen);
// Now, log out.
$CFG->forcelogin = true; // We don't want to be logged in as guest, as guest users might still have some capabilities.
$this->setUser();
// Create an action factory.
$factory = new \core_calendar\action_factory();
// Decorate action event for the student.
$actionevent = mod_choice_core_calendar_provide_event_action($event, $factory, $student->id);
// Confirm the event was decorated.
$this->assertInstanceOf('\core_calendar\local\event\value_objects\action', $actionevent);
$this->assertEquals(get_string('viewchoices', 'choice'), $actionevent->get_name());
$this->assertInstanceOf('moodle_url', $actionevent->get_url());
$this->assertEquals(1, $actionevent->get_item_count());
$this->assertFalse($actionevent->is_actionable());
}
public function test_choice_core_calendar_provide_event_action_no_time_specified() {
$this->resetAfterTest();
$this->setAdminUser();
// Create a course.
$course = $this->getDataGenerator()->create_course();
// Create a choice.
$choice = $this->getDataGenerator()->create_module('choice', array('course' => $course->id));
// Create a calendar event.
$event = $this->create_action_event($course->id, $choice->id, CHOICE_EVENT_TYPE_OPEN);
// Create an action factory.
$factory = new \core_calendar\action_factory();
// Decorate action event.
$actionevent = mod_choice_core_calendar_provide_event_action($event, $factory);
// Confirm the event was decorated.
$this->assertInstanceOf('\core_calendar\local\event\value_objects\action', $actionevent);
$this->assertEquals(get_string('viewchoices', 'choice'), $actionevent->get_name());
$this->assertInstanceOf('moodle_url', $actionevent->get_url());
$this->assertEquals(1, $actionevent->get_item_count());
$this->assertTrue($actionevent->is_actionable());
}
public function test_choice_core_calendar_provide_event_action_no_time_specified_for_user() {
global $CFG;
$this->resetAfterTest();
$this->setAdminUser();
// Create a course.
$course = $this->getDataGenerator()->create_course();
// Create a student.
$student = $this->getDataGenerator()->create_and_enrol($course, 'student');
// Create a choice.
$choice = $this->getDataGenerator()->create_module('choice', array('course' => $course->id));
// Create a calendar event.
$event = $this->create_action_event($course->id, $choice->id, CHOICE_EVENT_TYPE_OPEN);
// Now, log out.
$CFG->forcelogin = true; // We don't want to be logged in as guest, as guest users might still have some capabilities.
$this->setUser();
// Create an action factory.
$factory = new \core_calendar\action_factory();
// Decorate action event for the student.
$actionevent = mod_choice_core_calendar_provide_event_action($event, $factory, $student->id);
// Confirm the event was decorated.
$this->assertInstanceOf('\core_calendar\local\event\value_objects\action', $actionevent);
$this->assertEquals(get_string('viewchoices', 'choice'), $actionevent->get_name());
$this->assertInstanceOf('moodle_url', $actionevent->get_url());
$this->assertEquals(1, $actionevent->get_item_count());
$this->assertTrue($actionevent->is_actionable());
}
/**
* Creates an action event.
*
* @param int $courseid
* @param int $instanceid The choice id.
* @param string $eventtype The event type. eg. CHOICE_EVENT_TYPE_OPEN.
* @param int|null $timestart The start timestamp for the event
* @return bool|calendar_event
*/
private function create_action_event($courseid, $instanceid, $eventtype, $timestart = null) {
$event = new stdClass();
$event->name = 'Calendar event';
$event->modulename = 'choice';
$event->courseid = $courseid;
$event->instance = $instanceid;
$event->type = CALENDAR_EVENT_TYPE_ACTION;
$event->eventtype = $eventtype;
if ($timestart) {
$event->timestart = $timestart;
} else {
$event->timestart = time();
}
return calendar_event::create($event);
}
/**
* Test the callback responsible for returning the completion rule descriptions.
* This function should work given either an instance of the module (cm_info), such as when checking the active rules,
* or if passed a stdClass of similar structure, such as when checking the the default completion settings for a mod type.
*/
public function test_mod_choice_completion_get_active_rule_descriptions() {
$this->resetAfterTest();
$this->setAdminUser();
// Two activities, both with automatic completion. One has the 'completionsubmit' rule, one doesn't.
$course = $this->getDataGenerator()->create_course(['enablecompletion' => 1]);
$choice1 = $this->getDataGenerator()->create_module('choice', [
'course' => $course->id,
'completion' => 2,
'completionsubmit' => 1
]);
$choice2 = $this->getDataGenerator()->create_module('choice', [
'course' => $course->id,
'completion' => 2,
'completionsubmit' => 0
]);
$cm1 = cm_info::create(get_coursemodule_from_instance('choice', $choice1->id));
$cm2 = cm_info::create(get_coursemodule_from_instance('choice', $choice2->id));
// Data for the stdClass input type.
// This type of input would occur when checking the default completion rules for an activity type, where we don't have
// any access to cm_info, rather the input is a stdClass containing completion and customdata attributes, just like cm_info.
$moddefaults = new stdClass();
$moddefaults->customdata = ['customcompletionrules' => ['completionsubmit' => 1]];
$moddefaults->completion = 2;
$activeruledescriptions = [get_string('completionsubmit', 'choice')];
$this->assertEquals(mod_choice_get_completion_active_rule_descriptions($cm1), $activeruledescriptions);
$this->assertEquals(mod_choice_get_completion_active_rule_descriptions($cm2), []);
$this->assertEquals(mod_choice_get_completion_active_rule_descriptions($moddefaults), $activeruledescriptions);
$this->assertEquals(mod_choice_get_completion_active_rule_descriptions(new stdClass()), []);
}
/**
* An unkown event type should not change the choice instance.
*/
public function test_mod_choice_core_calendar_event_timestart_updated_unknown_event() {
global $CFG, $DB;
require_once($CFG->dirroot . "/calendar/lib.php");
$this->resetAfterTest(true);
$this->setAdminUser();
$generator = $this->getDataGenerator();
$course = $generator->create_course();
$choicegenerator = $generator->get_plugin_generator('mod_choice');
$timeopen = time();
$timeclose = $timeopen + DAYSECS;
$choice = $choicegenerator->create_instance(['course' => $course->id]);
$choice->timeopen = $timeopen;
$choice->timeclose = $timeclose;
$DB->update_record('choice', $choice);
// Create a valid event.
$event = new \calendar_event([
'name' => 'Test event',
'description' => '',
'format' => 1,
'courseid' => $course->id,
'groupid' => 0,
'userid' => 2,
'modulename' => 'choice',
'instance' => $choice->id,
'eventtype' => CHOICE_EVENT_TYPE_OPEN . "SOMETHING ELSE",
'timestart' => 1,
'timeduration' => 86400,
'visible' => 1
]);
mod_choice_core_calendar_event_timestart_updated($event, $choice);
$choice = $DB->get_record('choice', ['id' => $choice->id]);
$this->assertEquals($timeopen, $choice->timeopen);
$this->assertEquals($timeclose, $choice->timeclose);
}
/**
* A CHOICE_EVENT_TYPE_OPEN event should update the timeopen property of
* the choice activity.
*/
public function test_mod_choice_core_calendar_event_timestart_updated_open_event() {
global $CFG, $DB;
require_once($CFG->dirroot . "/calendar/lib.php");
$this->resetAfterTest(true);
$this->setAdminUser();
$generator = $this->getDataGenerator();
$course = $generator->create_course();
$choicegenerator = $generator->get_plugin_generator('mod_choice');
$timeopen = time();
$timeclose = $timeopen + DAYSECS;
$timemodified = 1;
$newtimeopen = $timeopen - DAYSECS;
$choice = $choicegenerator->create_instance(['course' => $course->id]);
$choice->timeopen = $timeopen;
$choice->timeclose = $timeclose;
$choice->timemodified = $timemodified;
$DB->update_record('choice', $choice);
// Create a valid event.
$event = new \calendar_event([
'name' => 'Test event',
'description' => '',
'format' => 1,
'courseid' => $course->id,
'groupid' => 0,
'userid' => 2,
'modulename' => 'choice',
'instance' => $choice->id,
'eventtype' => CHOICE_EVENT_TYPE_OPEN,
'timestart' => $newtimeopen,
'timeduration' => 86400,
'visible' => 1
]);
// Trigger and capture the event when adding a contact.
$sink = $this->redirectEvents();
mod_choice_core_calendar_event_timestart_updated($event, $choice);
$triggeredevents = $sink->get_events();
$moduleupdatedevents = array_filter($triggeredevents, function($e) {
return is_a($e, 'core\event\course_module_updated');
});
$choice = $DB->get_record('choice', ['id' => $choice->id]);
// Ensure the timeopen property matches the event timestart.
$this->assertEquals($newtimeopen, $choice->timeopen);
// Ensure the timeclose isn't changed.
$this->assertEquals($timeclose, $choice->timeclose);
// Ensure the timemodified property has been changed.
$this->assertNotEquals($timemodified, $choice->timemodified);
// Confirm that a module updated event is fired when the module
// is changed.
$this->assertNotEmpty($moduleupdatedevents);
}
/**
* A CHOICE_EVENT_TYPE_CLOSE event should update the timeclose property of
* the choice activity.
*/
public function test_mod_choice_core_calendar_event_timestart_updated_close_event() {
global $CFG, $DB;
require_once($CFG->dirroot . "/calendar/lib.php");
$this->resetAfterTest(true);
$this->setAdminUser();
$generator = $this->getDataGenerator();
$course = $generator->create_course();
$choicegenerator = $generator->get_plugin_generator('mod_choice');
$timeopen = time();
$timeclose = $timeopen + DAYSECS;
$timemodified = 1;
$newtimeclose = $timeclose + DAYSECS;
$choice = $choicegenerator->create_instance(['course' => $course->id]);
$choice->timeopen = $timeopen;
$choice->timeclose = $timeclose;
$choice->timemodified = $timemodified;
$DB->update_record('choice', $choice);
// Create a valid event.
$event = new \calendar_event([
'name' => 'Test event',
'description' => '',
'format' => 1,
'courseid' => $course->id,
'groupid' => 0,
'userid' => 2,
'modulename' => 'choice',
'instance' => $choice->id,
'eventtype' => CHOICE_EVENT_TYPE_CLOSE,
'timestart' => $newtimeclose,
'timeduration' => 86400,
'visible' => 1
]);
// Trigger and capture the event when adding a contact.
$sink = $this->redirectEvents();
mod_choice_core_calendar_event_timestart_updated($event, $choice);
$triggeredevents = $sink->get_events();
$moduleupdatedevents = array_filter($triggeredevents, function($e) {
return is_a($e, 'core\event\course_module_updated');
});
$choice = $DB->get_record('choice', ['id' => $choice->id]);
// Ensure the timeclose property matches the event timestart.
$this->assertEquals($newtimeclose, $choice->timeclose);
// Ensure the timeopen isn't changed.
$this->assertEquals($timeopen, $choice->timeopen);
// Ensure the timemodified property has been changed.
$this->assertNotEquals($timemodified, $choice->timemodified);
// Confirm that a module updated event is fired when the module
// is changed.
$this->assertNotEmpty($moduleupdatedevents);
}
/**
* An unkown event type should not have any limits
*/
public function test_mod_choice_core_calendar_get_valid_event_timestart_range_unknown_event() {
global $CFG, $DB;
require_once($CFG->dirroot . "/calendar/lib.php");
$this->resetAfterTest(true);
$this->setAdminUser();
$generator = $this->getDataGenerator();
$course = $generator->create_course();
$timeopen = time();
$timeclose = $timeopen + DAYSECS;
$choice = new \stdClass();
$choice->timeopen = $timeopen;
$choice->timeclose = $timeclose;
// Create a valid event.
$event = new \calendar_event([
'name' => 'Test event',
'description' => '',
'format' => 1,
'courseid' => $course->id,
'groupid' => 0,
'userid' => 2,
'modulename' => 'choice',
'instance' => 1,
'eventtype' => CHOICE_EVENT_TYPE_OPEN . "SOMETHING ELSE",
'timestart' => 1,
'timeduration' => 86400,
'visible' => 1
]);
list ($min, $max) = mod_choice_core_calendar_get_valid_event_timestart_range($event, $choice);
$this->assertNull($min);
$this->assertNull($max);
}
/**
* The open event should be limited by the choice's timeclose property, if it's set.
*/
public function test_mod_choice_core_calendar_get_valid_event_timestart_range_open_event() {
global $CFG, $DB;
require_once($CFG->dirroot . "/calendar/lib.php");
$this->resetAfterTest(true);
$this->setAdminUser();
$generator = $this->getDataGenerator();
$course = $generator->create_course();
$timeopen = time();
$timeclose = $timeopen + DAYSECS;
$choice = new \stdClass();
$choice->timeopen = $timeopen;
$choice->timeclose = $timeclose;
// Create a valid event.
$event = new \calendar_event([
'name' => 'Test event',
'description' => '',
'format' => 1,
'courseid' => $course->id,
'groupid' => 0,
'userid' => 2,
'modulename' => 'choice',
'instance' => 1,
'eventtype' => CHOICE_EVENT_TYPE_OPEN,
'timestart' => 1,
'timeduration' => 86400,
'visible' => 1
]);
// The max limit should be bounded by the timeclose value.
list ($min, $max) = mod_choice_core_calendar_get_valid_event_timestart_range($event, $choice);
$this->assertNull($min);
$this->assertEquals($timeclose, $max[0]);
// No timeclose value should result in no upper limit.
$choice->timeclose = 0;
list ($min, $max) = mod_choice_core_calendar_get_valid_event_timestart_range($event, $choice);
$this->assertNull($min);
$this->assertNull($max);
}
/**
* The close event should be limited by the choice's timeopen property, if it's set.
*/
public function test_mod_choice_core_calendar_get_valid_event_timestart_range_close_event() {
global $CFG, $DB;
require_once($CFG->dirroot . "/calendar/lib.php");
$this->resetAfterTest(true);
$this->setAdminUser();
$generator = $this->getDataGenerator();
$course = $generator->create_course();
$timeopen = time();
$timeclose = $timeopen + DAYSECS;
$choice = new \stdClass();
$choice->timeopen = $timeopen;
$choice->timeclose = $timeclose;
// Create a valid event.
$event = new \calendar_event([
'name' => 'Test event',
'description' => '',
'format' => 1,
'courseid' => $course->id,
'groupid' => 0,
'userid' => 2,
'modulename' => 'choice',
'instance' => 1,
'eventtype' => CHOICE_EVENT_TYPE_CLOSE,
'timestart' => 1,
'timeduration' => 86400,
'visible' => 1
]);
// The max limit should be bounded by the timeclose value.
list ($min, $max) = mod_choice_core_calendar_get_valid_event_timestart_range($event, $choice);
$this->assertEquals($timeopen, $min[0]);
$this->assertNull($max);
// No timeclose value should result in no upper limit.
$choice->timeopen = 0;
list ($min, $max) = mod_choice_core_calendar_get_valid_event_timestart_range($event, $choice);
$this->assertNull($min);
$this->assertNull($max);
}
/**
* Test choice_user_submit_response for a choice with specific options.
* Options:
* allowmultiple: false
* limitanswers: false
*/
public function test_choice_user_submit_response_no_multiple_no_limits() {
global $DB;
$this->resetAfterTest(true);
$generator = $this->getDataGenerator();
$course = $generator->create_course();
$user = $generator->create_user();
$user2 = $generator->create_user();
// User must be enrolled in the course for choice limits to be honoured properly.
$role = $DB->get_record('role', ['shortname' => 'student']);
$this->getDataGenerator()->enrol_user($user->id, $course->id, $role->id);
$this->getDataGenerator()->enrol_user($user2->id, $course->id, $role->id);
// Create choice, with updates allowed and a two options both limited to 1 response each.
$choice = $generator->get_plugin_generator('mod_choice')->create_instance([
'course' => $course->id,
'allowupdate' => false,
'limitanswers' => false,
'allowmultiple' => false,
'option' => ['red', 'green'],
]);
$cm = get_coursemodule_from_instance('choice', $choice->id);
// Get the choice, with options and limits included.
$choicewithoptions = choice_get_choice($choice->id);
$optionids = array_keys($choicewithoptions->option);
// Now, save an response which includes the first option.
$this->assertNull(choice_user_submit_response($optionids[0], $choicewithoptions, $user->id, $course, $cm));
// Confirm that saving again without changing the selected option will not throw a 'choice full' exception.
$this->assertNull(choice_user_submit_response($optionids[1], $choicewithoptions, $user->id, $course, $cm));
// Confirm that saving a response for student 2 including the first option is allowed.
$this->assertNull(choice_user_submit_response($optionids[0], $choicewithoptions, $user2->id, $course, $cm));
// Confirm that trying to save multiple options results in an exception.
$this->expectException('moodle_exception');
choice_user_submit_response([$optionids[1], $optionids[1]], $choicewithoptions, $user->id, $course, $cm);
}
/**
* Test choice_user_submit_response for a choice with specific options.
* Options:
* allowmultiple: true
* limitanswers: false
*/
public function test_choice_user_submit_response_multiples_no_limits() {
global $DB;
$this->resetAfterTest(true);
$generator = $this->getDataGenerator();
$course = $generator->create_course();
$user = $generator->create_user();
$user2 = $generator->create_user();
// User must be enrolled in the course for choice limits to be honoured properly.
$role = $DB->get_record('role', ['shortname' => 'student']);
$this->getDataGenerator()->enrol_user($user->id, $course->id, $role->id);
$this->getDataGenerator()->enrol_user($user2->id, $course->id, $role->id);
// Create choice, with updates allowed and a two options both limited to 1 response each.
$choice = $generator->get_plugin_generator('mod_choice')->create_instance([
'course' => $course->id,
'allowupdate' => false,
'allowmultiple' => true,
'limitanswers' => false,
'option' => ['red', 'green'],
]);
$cm = get_coursemodule_from_instance('choice', $choice->id);
// Get the choice, with options and limits included.
$choicewithoptions = choice_get_choice($choice->id);
$optionids = array_keys($choicewithoptions->option);
// Save a response which includes the first option only.
$this->assertNull(choice_user_submit_response([$optionids[0]], $choicewithoptions, $user->id, $course, $cm));
// Confirm that adding an option to the response is allowed.
$this->assertNull(choice_user_submit_response([$optionids[0], $optionids[1]], $choicewithoptions, $user->id, $course, $cm));
// Confirm that saving a response for student 2 including the first option is allowed.
$this->assertNull(choice_user_submit_response($optionids[0], $choicewithoptions, $user2->id, $course, $cm));
// Confirm that removing an option from the response is allowed.
$this->assertNull(choice_user_submit_response([$optionids[0]], $choicewithoptions, $user->id, $course, $cm));
// Confirm that removing all options from the response is not allowed via this method.
$this->expectException('moodle_exception');
choice_user_submit_response([], $choicewithoptions, $user->id, $course, $cm);
}
/**
* Test choice_user_submit_response for a choice with specific options.
* Options:
* allowmultiple: false
* limitanswers: true
*/
public function test_choice_user_submit_response_no_multiples_limits() {
global $DB;
$this->resetAfterTest(true);
$generator = $this->getDataGenerator();
$course = $generator->create_course();
$user = $generator->create_user();
$user2 = $generator->create_user();
// User must be enrolled in the course for choice limits to be honoured properly.
$role = $DB->get_record('role', ['shortname' => 'student']);
$this->getDataGenerator()->enrol_user($user->id, $course->id, $role->id);
$this->getDataGenerator()->enrol_user($user2->id, $course->id, $role->id);
// Create choice, with updates allowed and a two options both limited to 1 response each.
$choice = $generator->get_plugin_generator('mod_choice')->create_instance([
'course' => $course->id,
'allowupdate' => false,
'allowmultiple' => false,
'limitanswers' => true,
'option' => ['red', 'green'],
'limit' => [1, 1]
]);
$cm = get_coursemodule_from_instance('choice', $choice->id);
// Get the choice, with options and limits included.
$choicewithoptions = choice_get_choice($choice->id);
$optionids = array_keys($choicewithoptions->option);
// Save a response which includes the first option only.
$this->assertNull(choice_user_submit_response($optionids[0], $choicewithoptions, $user->id, $course, $cm));
// Confirm that changing the option in the response is allowed.
$this->assertNull(choice_user_submit_response($optionids[1], $choicewithoptions, $user->id, $course, $cm));
// Confirm that limits are respected by trying to save the same option as another user.
$this->expectException('moodle_exception');
choice_user_submit_response($optionids[1], $choicewithoptions, $user2->id, $course, $cm);
}
/**
* Test choice_user_submit_response for a choice with specific options.
* Options:
* allowmultiple: true
* limitanswers: true
*/
public function test_choice_user_submit_response_multiples_limits() {
global $DB;
$this->resetAfterTest(true);
$generator = $this->getDataGenerator();
$course = $generator->create_course();
$user = $generator->create_user();
$user2 = $generator->create_user();
// User must be enrolled in the course for choice limits to be honoured properly.
$role = $DB->get_record('role', ['shortname' => 'student']);
$this->getDataGenerator()->enrol_user($user->id, $course->id, $role->id);
$this->getDataGenerator()->enrol_user($user2->id, $course->id, $role->id);
// Create choice, with updates allowed and a two options both limited to 1 response each.
$choice = $generator->get_plugin_generator('mod_choice')->create_instance([
'course' => $course->id,
'allowupdate' => false,
'allowmultiple' => true,
'limitanswers' => true,
'option' => ['red', 'green'],
'limit' => [1, 1]
]);
$cm = get_coursemodule_from_instance('choice', $choice->id);
// Get the choice, with options and limits included.
$choicewithoptions = choice_get_choice($choice->id);
$optionids = array_keys($choicewithoptions->option);
// Now, save a response which includes the first option only.
$this->assertNull(choice_user_submit_response([$optionids[0]], $choicewithoptions, $user->id, $course, $cm));
// Confirm that changing the option in the response is allowed.
$this->assertNull(choice_user_submit_response([$optionids[1]], $choicewithoptions, $user->id, $course, $cm));
// Confirm that adding an option to the response is allowed.
$this->assertNull(choice_user_submit_response([$optionids[0], $optionids[1]], $choicewithoptions, $user->id, $course, $cm));
// Confirm that limits are respected by trying to save the same option as another user.
$this->expectException('moodle_exception');
choice_user_submit_response($optionids[1], $choicewithoptions, $user2->id, $course, $cm);
}
/**
* A user who does not have capabilities to add events to the calendar should be able to create an choice.
*/
public function test_creation_with_no_calendar_capabilities() {
$this->resetAfterTest();
$course = self::getDataGenerator()->create_course();
$context = context_course::instance($course->id);
$user = self::getDataGenerator()->create_and_enrol($course, 'editingteacher');
$roleid = self::getDataGenerator()->create_role();
self::getDataGenerator()->role_assign($roleid, $user->id, $context->id);
assign_capability('moodle/calendar:manageentries', CAP_PROHIBIT, $roleid, $context, true);
$generator = self::getDataGenerator()->get_plugin_generator('mod_choice');
// Create an instance as a user without the calendar capabilities.
$this->setUser($user);
$time = time();
$params = array(
'course' => $course->id,
'timeopen' => $time + 200,
'timeclose' => $time + 500,
);
$generator->create_instance($params);
}
}