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.
426 lines
18 KiB
426 lines
18 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/>.
|
|
|
|
/**
|
|
* External functions test for attendance plugin.
|
|
*
|
|
* @package mod_attendance
|
|
* @category external
|
|
* @copyright 2015 Caio Bressan Doneda
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
global $CFG;
|
|
|
|
require_once($CFG->dirroot . '/webservice/tests/helpers.php');
|
|
require_once($CFG->dirroot . '/mod/attendance/classes/attendance_webservices_handler.php');
|
|
require_once($CFG->dirroot . '/mod/attendance/classes/structure.php');
|
|
require_once($CFG->dirroot . '/mod/attendance/externallib.php');
|
|
|
|
/**
|
|
* This class contains the test cases for webservices.
|
|
*
|
|
* @package mod_attendance
|
|
* @category external
|
|
* @copyright 2015 Caio Bressan Doneda
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
* @group mod_attendance
|
|
*/
|
|
class mod_attendance_external_testcase extends externallib_advanced_testcase {
|
|
/** @var coursecat */
|
|
protected $category;
|
|
/** @var stdClass */
|
|
protected $course;
|
|
/** @var stdClass */
|
|
protected $attendance;
|
|
/** @var stdClass */
|
|
protected $teacher;
|
|
/** @var array */
|
|
protected $students;
|
|
/** @var array */
|
|
protected $sessions;
|
|
|
|
/**
|
|
* Setup class.
|
|
*/
|
|
public function setUp() {
|
|
$this->category = $this->getDataGenerator()->create_category();
|
|
$this->course = $this->getDataGenerator()->create_course(array('category' => $this->category->id));
|
|
|
|
$this->attendance = $this->create_attendance();
|
|
|
|
$this->create_and_enrol_users();
|
|
|
|
$this->setUser($this->teacher);
|
|
|
|
$session = new stdClass();
|
|
$session->sessdate = time();
|
|
$session->duration = 6000;
|
|
$session->description = "";
|
|
$session->descriptionformat = 1;
|
|
$session->descriptionitemid = 0;
|
|
$session->timemodified = time();
|
|
$session->statusset = 0;
|
|
$session->groupid = 0;
|
|
$session->absenteereport = 1;
|
|
$session->calendarevent = 0;
|
|
|
|
// Creating session.
|
|
$this->sessions[] = $session;
|
|
|
|
$this->attendance->add_sessions($this->sessions);
|
|
}
|
|
|
|
/**
|
|
* Create new attendance activity.
|
|
*/
|
|
private function create_attendance() {
|
|
global $DB;
|
|
$att = $this->getDataGenerator()->create_module('attendance', array('course' => $this->course->id));
|
|
$cm = $DB->get_record('course_modules', array('id' => $att->cmid));
|
|
unset($att->cmid);
|
|
return new mod_attendance_structure($att, $cm, $this->course);
|
|
}
|
|
|
|
/** Creating 10 students and 1 teacher. */
|
|
protected function create_and_enrol_users() {
|
|
$this->students = array();
|
|
for ($i = 0; $i < 10; $i++) {
|
|
$student = $this->getDataGenerator()->create_user();
|
|
$this->getDataGenerator()->enrol_user($student->id, $this->course->id, 5); // Enrol as student.
|
|
$this->students[] = $student;
|
|
}
|
|
|
|
$this->teacher = $this->getDataGenerator()->create_user();
|
|
$this->getDataGenerator()->enrol_user($this->teacher->id, $this->course->id, 3); // Enrol as teacher.
|
|
}
|
|
|
|
public function test_get_courses_with_today_sessions() {
|
|
$this->resetAfterTest(true);
|
|
|
|
// Just adding the same session again to check if the method returns the right amount of instances.
|
|
$this->attendance->add_sessions($this->sessions);
|
|
|
|
$courseswithsessions = attendance_handler::get_courses_with_today_sessions($this->teacher->id);
|
|
|
|
$this->assertTrue(is_array($courseswithsessions));
|
|
$this->assertEquals(count($courseswithsessions), 1);
|
|
$course = array_pop($courseswithsessions);
|
|
$this->assertEquals($course->fullname, $this->course->fullname);
|
|
$attendanceinstance = array_pop($course->attendance_instances);
|
|
$this->assertEquals(count($attendanceinstance['today_sessions']), 2);
|
|
}
|
|
|
|
public function test_get_courses_with_today_sessions_multiple_instances() {
|
|
$this->resetAfterTest(true);
|
|
|
|
// Make another attendance.
|
|
$second = $this->create_attendance();
|
|
|
|
// Just add the same session.
|
|
$secondsession = clone $this->sessions[0];
|
|
$secondsession->sessdate += 3600;
|
|
|
|
$second->add_sessions([$secondsession]);
|
|
|
|
$courseswithsessions = attendance_handler::get_courses_with_today_sessions($this->teacher->id);
|
|
$this->assertTrue(is_array($courseswithsessions));
|
|
$this->assertEquals(count($courseswithsessions), 1);
|
|
$course = array_pop($courseswithsessions);
|
|
$this->assertEquals(count($course->attendance_instances), 2);
|
|
}
|
|
|
|
public function test_get_session() {
|
|
$this->resetAfterTest(true);
|
|
|
|
$courseswithsessions = attendance_handler::get_courses_with_today_sessions($this->teacher->id);
|
|
|
|
$course = array_pop($courseswithsessions);
|
|
$attendanceinstance = array_pop($course->attendance_instances);
|
|
$session = array_pop($attendanceinstance['today_sessions']);
|
|
|
|
$sessioninfo = attendance_handler::get_session($session->id);
|
|
|
|
$this->assertEquals($this->attendance->id, $sessioninfo->attendanceid);
|
|
$this->assertEquals($session->id, $sessioninfo->id);
|
|
$this->assertEquals(count($sessioninfo->users), 10);
|
|
}
|
|
|
|
public function test_get_session_with_group() {
|
|
$this->resetAfterTest(true);
|
|
|
|
// Create a group in our course, and add some students to it.
|
|
$group = new stdClass();
|
|
$group->courseid = $this->course->id;
|
|
$group = $this->getDataGenerator()->create_group($group);
|
|
|
|
for ($i = 0; $i < 5; $i++) {
|
|
$member = new stdClass;
|
|
$member->groupid = $group->id;
|
|
$member->userid = $this->students[$i]->id;
|
|
$this->getDataGenerator()->create_group_member($member);
|
|
}
|
|
|
|
// Add a session that's identical to the first, but with a group.
|
|
$midnight = usergetmidnight(time()); // Check if this test is running during midnight.
|
|
$session = clone $this->sessions[0];
|
|
$session->groupid = $group->id;
|
|
$session->sessdate += 3600; // Make sure it appears second in the list.
|
|
$this->attendance->add_sessions([$session]);
|
|
|
|
$courseswithsessions = attendance_handler::get_courses_with_today_sessions($this->teacher->id);
|
|
|
|
// This test is fragile when running over midnight - check that it is still the same day, if not, run this again.
|
|
// This isn't really ideal code, but will hopefully still give a valid test.
|
|
if (empty($courseswithsessions) && $midnight !== usergetmidnight(time())) {
|
|
$this->attendance->add_sessions([$session]);
|
|
$courseswithsessions = attendance_handler::get_courses_with_today_sessions($this->teacher->id);
|
|
}
|
|
|
|
$course = array_pop($courseswithsessions);
|
|
$attendanceinstance = array_pop($course->attendance_instances);
|
|
$session = array_pop($attendanceinstance['today_sessions']);
|
|
|
|
$sessioninfo = attendance_handler::get_session($session->id);
|
|
|
|
$this->assertEquals($session->id, $sessioninfo->id);
|
|
$this->assertEquals($group->id, $sessioninfo->groupid);
|
|
$this->assertEquals(count($sessioninfo->users), 5);
|
|
}
|
|
|
|
public function test_update_user_status() {
|
|
$this->resetAfterTest(true);
|
|
|
|
$courseswithsessions = attendance_handler::get_courses_with_today_sessions($this->teacher->id);
|
|
|
|
$course = array_pop($courseswithsessions);
|
|
$attendanceinstance = array_pop($course->attendance_instances);
|
|
$session = array_pop($attendanceinstance['today_sessions']);
|
|
|
|
$sessioninfo = attendance_handler::get_session($session->id);
|
|
|
|
$student = array_pop($sessioninfo->users);
|
|
$status = array_pop($sessioninfo->statuses);
|
|
$statusset = $sessioninfo->statusset;
|
|
attendance_handler::update_user_status($session->id, $student->id, $this->teacher->id, $status->id, $statusset);
|
|
|
|
$sessioninfo = attendance_handler::get_session($session->id);
|
|
$log = $sessioninfo->attendance_log;
|
|
$studentlog = $log[$student->id];
|
|
|
|
$this->assertEquals($status->id, $studentlog->statusid);
|
|
}
|
|
|
|
public function test_add_attendance() {
|
|
global $DB;
|
|
$this->resetAfterTest(true);
|
|
|
|
$course = $this->getDataGenerator()->create_course();
|
|
|
|
// Become a teacher.
|
|
$teacher = self::getDataGenerator()->create_user();
|
|
$teacherrole = $DB->get_record('role', array('shortname' => 'editingteacher'));
|
|
$this->getDataGenerator()->enrol_user($teacher->id, $course->id, $teacherrole->id);
|
|
$this->setUser($teacher);
|
|
|
|
// Check attendance does not exist.
|
|
$this->assertCount(0, $DB->get_records('attendance', ['course' => $course->id]));
|
|
|
|
// Create attendance.
|
|
$result = mod_wsattendance_external::add_attendance($course->id, 'test', 'test', NOGROUPS);
|
|
|
|
// Check attendance exist.
|
|
$this->assertCount(1, $DB->get_records('attendance', ['course' => $course->id]));
|
|
$record = $DB->get_record('attendance', ['id' => $result['attendanceid']]);
|
|
$this->assertEquals($record->name, 'test');
|
|
|
|
// Check group.
|
|
$cm = get_coursemodule_from_instance('attendance', $result['attendanceid'], 0, false, MUST_EXIST);
|
|
$groupmode = (int)groups_get_activity_groupmode($cm);
|
|
$this->assertEquals($groupmode, NOGROUPS);
|
|
|
|
// Create attendance with "separate groups" group mode.
|
|
$result = mod_wsattendance_external::add_attendance($course->id, 'testsepgrp', 'testsepgrp', SEPARATEGROUPS);
|
|
|
|
// Check attendance exist.
|
|
$this->assertCount(2, $DB->get_records('attendance', ['course' => $course->id]));
|
|
$record = $DB->get_record('attendance', ['id' => $result['attendanceid']]);
|
|
$this->assertEquals($record->name, 'testsepgrp');
|
|
|
|
// Check group.
|
|
$cm = get_coursemodule_from_instance('attendance', $result['attendanceid'], 0, false, MUST_EXIST);
|
|
$groupmode = (int)groups_get_activity_groupmode($cm);
|
|
$this->assertEquals($groupmode, SEPARATEGROUPS);
|
|
|
|
// Create attendance with wrong group mode.
|
|
$this->expectException('invalid_parameter_exception');
|
|
$result = mod_wsattendance_external::add_attendance($course->id, 'test1', 'test1', 100);
|
|
}
|
|
|
|
public function test_remove_attendance() {
|
|
global $DB;
|
|
$this->resetAfterTest(true);
|
|
|
|
// Become a teacher.
|
|
$teacher = self::getDataGenerator()->create_user();
|
|
$teacherrole = $DB->get_record('role', array('shortname' => 'editingteacher'));
|
|
$this->getDataGenerator()->enrol_user($teacher->id, $this->course->id, $teacherrole->id);
|
|
$this->setUser($teacher);
|
|
|
|
// Check attendance exists.
|
|
$this->assertCount(1, $DB->get_records('attendance', ['course' => $this->course->id]));
|
|
$this->assertCount(1, $DB->get_records('attendance_sessions', ['attendanceid' => $this->attendance->id]));
|
|
|
|
// Remove attendance.
|
|
mod_wsattendance_external::remove_attendance($this->attendance->id);
|
|
|
|
// Check attendance removed.
|
|
$this->assertCount(0, $DB->get_records('attendance', ['course' => $this->course->id]));
|
|
$this->assertCount(0, $DB->get_records('attendance_sessions', ['attendanceid' => $this->attendance->id]));
|
|
}
|
|
|
|
public function test_add_session() {
|
|
global $DB;
|
|
$this->resetAfterTest(true);
|
|
|
|
$course = $this->getDataGenerator()->create_course();
|
|
$group = $this->getDataGenerator()->create_group(array('courseid' => $course->id));
|
|
|
|
// Become a teacher.
|
|
$teacher = self::getDataGenerator()->create_user();
|
|
$teacherrole = $DB->get_record('role', array('shortname' => 'editingteacher'));
|
|
$this->getDataGenerator()->enrol_user($teacher->id, $course->id, $teacherrole->id);
|
|
$this->setUser($teacher);
|
|
|
|
// Create attendances.
|
|
$attendancenogroups = mod_wsattendance_external::add_attendance($course->id, 'nogroups', 'test', NOGROUPS);
|
|
$attendancesepgroups = mod_wsattendance_external::add_attendance($course->id, 'sepgroups', 'test', SEPARATEGROUPS);
|
|
$attendancevisgroups = mod_wsattendance_external::add_attendance($course->id, 'visgroups', 'test', VISIBLEGROUPS);
|
|
|
|
// Check attendances exist.
|
|
$this->assertCount(3, $DB->get_records('attendance', ['course' => $course->id]));
|
|
|
|
// Create session with group in "no groups" attendance.
|
|
$this->expectException('invalid_parameter_exception');
|
|
mod_wsattendance_external::add_session($attendancenogroups['attendanceid'], 'test', time(), 3600, $group->id, false);
|
|
|
|
// Create session with no group in "separate groups" attendance.
|
|
$this->expectException('invalid_parameter_exception');
|
|
mod_wsattendance_external::add_session($attendancesepgroups['attendanceid'], 'test', time(), 3600, 0, false);
|
|
|
|
// Create session with invalid group in "visible groups" attendance.
|
|
$this->expectException('invalid_parameter_exception');
|
|
mod_wsattendance_external::add_session($attendancevisgroups['attendanceid'], 'test', time(), 3600, $group->id + 100, false);
|
|
|
|
// Create session and validate record.
|
|
$time = time();
|
|
$duration = 3600;
|
|
$result = mod_wsattendance_external::add_session($attendancesepgroups['attendanceid'],
|
|
'testsession', $time, $duration, $group->id, true);
|
|
|
|
$this->assertCount(1, $DB->get_records('attendance_sessions', ['id' => $result['sessionid']]));
|
|
$record = $DB->get_records('attendance_sessions', ['id' => $result['sessionid']]);
|
|
$this->assertEquals($record->description, 'testsession');
|
|
$this->assertEquals($record->attendanceid, $attendancesepgroups['attendanceid']);
|
|
$this->assertEquals($record->groupid, $group->id);
|
|
$this->assertEquals($record->sessdate, $time);
|
|
$this->assertEquals($record->duration, $duration);
|
|
$this->assertEquals($record->calendarevent, 1);
|
|
}
|
|
|
|
public function test_remove_session() {
|
|
global $DB;
|
|
$this->resetAfterTest(true);
|
|
|
|
$course = $this->getDataGenerator()->create_course();
|
|
|
|
// Become a teacher.
|
|
$teacher = self::getDataGenerator()->create_user();
|
|
$teacherrole = $DB->get_record('role', array('shortname' => 'editingteacher'));
|
|
$this->getDataGenerator()->enrol_user($teacher->id, $course->id, $teacherrole->id);
|
|
$this->setUser($teacher);
|
|
|
|
// Create attendance with no groups mode.
|
|
$attendancenogroups = mod_wsattendance_external::add_attendance($course->id, 'nogroups',
|
|
'test', NOGROUPS);
|
|
$attendancenogroups = external_api::clean_returnvalue(mod_wsattendance_external::add_attendance_returns(),
|
|
$attendancenogroups);
|
|
|
|
// Check attendance exist.
|
|
$this->assertCount(1, $DB->get_records('attendance', ['course' => $course->id]));
|
|
|
|
// Create session.
|
|
$result0 = mod_wsattendance_external::add_session($attendancenogroups['attendanceid'], 'test0', time(), 3600, 0, false);
|
|
$result1 = mod_wsattendance_external::add_session($attendancenogroups['attendanceid'], 'test1', time(), 3600, 0, false);
|
|
|
|
$this->assertCount(2, $DB->get_records('attendance_sessions', ['attendanceid' => $attendancenogroups['attendanceid']]));
|
|
|
|
// Delete session 0.
|
|
mod_wsattendance_external::remove_session($result0['sessionid']);
|
|
$this->assertCount(1, $DB->get_records('attendance_sessions', ['attendanceid' => $attendancenogroups['attendanceid']]));
|
|
|
|
// Delete session 1.
|
|
mod_wsattendance_external::remove_session($result1['sessionid']);
|
|
$this->assertCount(0, $DB->get_records('attendance_sessions', ['attendanceid' => $attendancenogroups['attendanceid']]));
|
|
}
|
|
|
|
public function test_add_session_creates_calendar_event() {
|
|
global $DB;
|
|
$this->resetAfterTest(true);
|
|
|
|
$course = $this->getDataGenerator()->create_course();
|
|
|
|
// Become a teacher.
|
|
$teacher = self::getDataGenerator()->create_user();
|
|
$teacherrole = $DB->get_record('role', array('shortname' => 'editingteacher'));
|
|
$this->getDataGenerator()->enrol_user($teacher->id, $course->id, $teacherrole->id);
|
|
$this->setUser($teacher);
|
|
|
|
// Create attendance.
|
|
$attendance = mod_wsattendance_external::add_attendance($course->id, 'test', 'test', NOGROUPS);
|
|
|
|
// Check attendance exist.
|
|
$this->assertCount(1, $DB->get_records('attendance', ['course' => $course->id]));
|
|
|
|
// Prepare events tracing.
|
|
$sink = $this->redirectEvents();
|
|
|
|
// Create session with no calendar event.
|
|
mod_wsattendance_external::add_session($attendance['attendanceid'], 'test0', time(), 3600, 0, false);
|
|
|
|
// Capture the event.
|
|
$events = $sink->get_events();
|
|
$sink->clear();
|
|
|
|
// Validate.
|
|
$this->assertCount(1, $events);
|
|
$this->assertInstanceOf('\mod_attendance\event\session_added', $events[0]);
|
|
|
|
// Create session with calendar event.
|
|
mod_wsattendance_external::add_session($attendance['attendanceid'], 'test0', time(), 3600, 0, true);
|
|
|
|
// Capture the event.
|
|
$events = $sink->get_events();
|
|
$sink->clear();
|
|
|
|
// Validate the event.
|
|
$this->assertCount(2, $events);
|
|
$this->assertInstanceOf('\core\event\calendar_event_created', $events[0]);
|
|
$this->assertInstanceOf('\mod_attendance\event\session_added', $events[1]);
|
|
}
|
|
}
|
|
|