coregrade/CoreGradeLearning
1
0
Fork 0
Code Issues Pull Requests Releases Activity

first commit

Browse Source
This commit is contained in:
CHIEFSOFT\ameye
2024-09-30 18:11:26 -04:00
commit e592ca6823
27270 changed files with 5002257 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
enrol/flatfile/tests/flatfile_test.php
+555
View File
@@ -0,0 +1,555 @@
<?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/>.
/**
* flatfile enrolment sync tests.
*
* @package enrol_flatfile
* @category test
* @copyright 2012 Petr Skoda {@link http://skodak.org}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace enrol_flatfile;
use enrol_flatfile\task\flatfile_sync_task;
/**
* flatfile enrolment sync tests.
*
* @package enrol_flatfile
* @category test
* @copyright 2012 Petr Skoda {@link http://skodak.org}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class flatfile_test extends \advanced_testcase {
protected function enable_plugin() {
$enabled = enrol_get_plugins(true);
$enabled['flatfile'] = true;
$enabled = array_keys($enabled);
set_config('enrol_plugins_enabled', implode(',', $enabled));
}
protected function disable_plugin() {
$enabled = enrol_get_plugins(true);
unset($enabled['flatfile']);
$enabled = array_keys($enabled);
set_config('enrol_plugins_enabled', implode(',', $enabled));
}
public function test_basics(): void {
$this->assertFalse(enrol_is_enabled('flatfile'));
$plugin = enrol_get_plugin('flatfile');
$this->assertInstanceOf('enrol_flatfile_plugin', $plugin);
$this->assertEquals(ENROL_EXT_REMOVED_SUSPENDNOROLES, get_config('enrol_flatfile', 'expiredaction'));
}
public function test_sync_nothing(): void {
$this->resetAfterTest();
$this->disable_plugin();
$flatfileplugin = enrol_get_plugin('flatfile');
// Just make sure the sync does not throw any errors when nothing to do.
$flatfileplugin->sync(new \null_progress_trace());
$this->enable_plugin();
$flatfileplugin->sync(new \null_progress_trace());
}
public function test_sync(): void {
global $CFG, $DB;
$this->resetAfterTest();
/** @var \enrol_flatfile_plugin $flatfileplugin */
$flatfileplugin = enrol_get_plugin('flatfile');
/** @var \enrol_manual_plugin $manualplugin */
$manualplugin = enrol_get_plugin('manual');
$this->assertNotEmpty($manualplugin);
$trace = new \null_progress_trace();
$this->enable_plugin();
$file = "$CFG->dataroot/enrol.txt";
$studentrole = $DB->get_record('role', array('shortname'=>'student'));
$this->assertNotEmpty($studentrole);
$teacherrole = $DB->get_record('role', array('shortname'=>'teacher'));
$this->assertNotEmpty($teacherrole);
$managerrole = $DB->get_record('role', array('shortname'=>'manager'));
$this->assertNotEmpty($managerrole);
$user1 = $this->getDataGenerator()->create_user(array('idnumber'=>'u1'));
$user2 = $this->getDataGenerator()->create_user(array('idnumber'=>'u2'));
$user3 = $this->getDataGenerator()->create_user(array('idnumber'=>'u3'));
$user4 = $this->getDataGenerator()->create_user(array('idnumber'=>'čtvrtý'));
$user5 = $this->getDataGenerator()->create_user(array('idnumber'=>'u5'));
$user6 = $this->getDataGenerator()->create_user(array('idnumber'=>'u6'));
$user7 = $this->getDataGenerator()->create_user(array('idnumber'=>''));
$course1 = $this->getDataGenerator()->create_course(array('idnumber'=>'c1'));
$course2 = $this->getDataGenerator()->create_course(array('idnumber'=>'c2'));
$course3 = $this->getDataGenerator()->create_course(array('idnumber'=>'c3'));
$context1 = \context_course::instance($course1->id);
$context2 = \context_course::instance($course2->id);
$context3 = \context_course::instance($course3->id);
$maninstance1 = $DB->get_record('enrol', array('courseid'=>$course1->id, 'enrol'=>'manual'), '*', MUST_EXIST);
$maninstance2 = $DB->get_record('enrol', array('courseid'=>$course2->id, 'enrol'=>'manual'), '*', MUST_EXIST);
$maninstance3 = $DB->get_record('enrol', array('courseid'=>$course3->id, 'enrol'=>'manual'), '*', MUST_EXIST);
// Rename teacher role.
$flatfileplugin->set_config('map_'.$teacherrole->id, 'ucitel');
// Disable manager role.
$flatfileplugin->set_config('map_'.$managerrole->id, '');
// Set file location.
$flatfileplugin->set_config('location', $file);
$now = time();
$before = $now - 60;
$future = $now + 60*60*5;
$farfuture = $now + 60*60*24*5;
// Test add action.
$data ="'add','student','u1','c1'
\"add\" , \"ucitel\", u2 , c2
add,manager,u3,c1
add,student,čtvrtý,c2,$before
add,student,u5,c1,0,0,1
add,student,u5,c2,20,10
add,student,u6,c1,0,$future
add,student,u6,c2,$future,0
add,student,u6,c3,$future,$farfuture
add,student,,c2";
file_put_contents($file, $data);
$this->assertEquals(0, $DB->count_records('user_enrolments'));
$this->assertEquals(0, $DB->count_records('role_assignments'));
$this->assertEquals(0, $DB->count_records('enrol_flatfile'));
$this->assertTrue(file_exists($file));
$flatfileplugin->sync($trace);
$this->assertFalse(file_exists($file));
$this->assertEquals(4, $DB->count_records('user_enrolments'));
$this->assertEquals(4, $DB->count_records('role_assignments'));
$this->assertTrue($DB->record_exists('role_assignments', array('contextid'=>$context1->id, 'userid'=>$user1->id, 'roleid'=>$studentrole->id, 'component'=>'enrol_flatfile')));
$this->assertTrue($DB->record_exists('role_assignments', array('contextid'=>$context2->id, 'userid'=>$user2->id, 'roleid'=>$teacherrole->id, 'component'=>'enrol_flatfile')));
$this->assertTrue($DB->record_exists('role_assignments', array('contextid'=>$context2->id, 'userid'=>$user4->id, 'roleid'=>$studentrole->id, 'component'=>'enrol_flatfile')));
$this->assertTrue($DB->record_exists('role_assignments', array('contextid'=>$context1->id, 'userid'=>$user6->id, 'roleid'=>$studentrole->id, 'component'=>'enrol_flatfile')));
// Test buffer.
$this->assertEquals(2, $DB->count_records('enrol_flatfile'));
$flatfileplugin->sync($trace);
$this->assertEquals(2, $DB->count_records('enrol_flatfile'));
$this->assertEquals(4, $DB->count_records('user_enrolments'));
$this->assertEquals(4, $DB->count_records('role_assignments'));
$DB->set_field('enrol_flatfile', 'timestart', time()-60, array('timestart'=>$future, 'timeend'=>0));
$flatfileplugin->sync($trace);
$this->assertEquals(1, $DB->count_records('enrol_flatfile'));
$this->assertEquals(5, $DB->count_records('user_enrolments'));
$this->assertEquals(5, $DB->count_records('role_assignments'));
$this->assertTrue($DB->record_exists('role_assignments', array('contextid'=>$context2->id, 'userid'=>$user6->id, 'roleid'=>$studentrole->id, 'component'=>'enrol_flatfile')));
$this->assertTrue($DB->record_exists('enrol_flatfile', array('userid'=>$user6->id, 'roleid'=>$studentrole->id, 'timeend'=>$farfuture)));
// Test encoding.
$data = "add;student;čtvrtý;c3";
$data = \core_text::convert($data, 'utf-8', 'iso-8859-2');
file_put_contents($file, $data);
$flatfileplugin->set_config('encoding', 'iso-8859-2');
$flatfileplugin->sync($trace);
$this->assertEquals(6, $DB->count_records('user_enrolments'));
$this->assertEquals(6, $DB->count_records('role_assignments'));
$this->assertTrue($DB->record_exists('role_assignments', array('contextid'=>$context3->id, 'userid'=>$user4->id, 'roleid'=>$studentrole->id, 'component'=>'enrol_flatfile')));
$flatfileplugin->set_config('encoding', 'UTF-8');
// Test unenrolling purges buffer.
$manualplugin->enrol_user($maninstance1, $user1->id, $teacherrole->id);
$manualplugin->enrol_user($maninstance3, $user5->id, $teacherrole->id);
$this->assertEquals(8, $DB->count_records('user_enrolments'));
$this->assertEquals(8, $DB->count_records('role_assignments'));
$this->assertEquals(1, $DB->count_records('enrol_flatfile'));
$this->assertTrue($DB->record_exists('role_assignments', array('contextid'=>$context1->id, 'userid'=>$user1->id, 'roleid'=>$teacherrole->id)));
$flatfileplugin->set_config('unenrolaction', ENROL_EXT_REMOVED_KEEP);
$data = "del,student,u1,c1\ndel,teacher,u6,c3";
file_put_contents($file, $data);
$flatfileplugin->sync($trace);
$this->assertEquals(8, $DB->count_records('user_enrolments'));
$this->assertEquals(8, $DB->count_records('role_assignments'));
$this->assertEquals(1, $DB->count_records('enrol_flatfile'));
$data = "del,student,u6,c3";
file_put_contents($file, $data);
$flatfileplugin->sync($trace);
$this->assertEquals(8, $DB->count_records('user_enrolments'));
$this->assertEquals(8, $DB->count_records('role_assignments'));
$this->assertEquals(0, $DB->count_records('enrol_flatfile'));
$flatfileplugin->set_config('unenrolaction', ENROL_EXT_REMOVED_SUSPENDNOROLES);
$data = "
del,student,u1,c1
del,grrr,u5,c1
del,guest,u5,c2
del,student,u6,c2
del,ucitel,u5,c3";
file_put_contents($file, $data);
$this->assertTrue($DB->record_exists('role_assignments', array('contextid'=>$context1->id, 'userid'=>$user1->id, 'roleid'=>$studentrole->id, 'component'=>'enrol_flatfile')));
$this->assertTrue($DB->record_exists('role_assignments', array('contextid'=>$context2->id, 'userid'=>$user6->id, 'roleid'=>$studentrole->id)));
$this->assertTrue($DB->record_exists('role_assignments', array('contextid'=>$context3->id, 'userid'=>$user5->id, 'roleid'=>$teacherrole->id)));
$flatfileplugin->sync($trace);
$this->assertEquals(8, $DB->count_records('user_enrolments'));
$this->assertEquals(5, $DB->count_records('role_assignments'));
$this->assertFalse($DB->record_exists('role_assignments', array('contextid'=>$context1->id, 'userid'=>$user1->id, 'roleid'=>$studentrole->id, 'component'=>'enrol_flatfile')));
$this->assertTrue($DB->record_exists('role_assignments', array('contextid'=>$context1->id, 'userid'=>$user1->id, 'roleid'=>$teacherrole->id)));
$this->assertFalse($DB->record_exists('role_assignments', array('contextid'=>$context2->id, 'userid'=>$user6->id, 'roleid'=>$studentrole->id)));
$this->assertFalse($DB->record_exists('role_assignments', array('contextid'=>$context3->id, 'userid'=>$user5->id, 'roleid'=>$teacherrole->id)));
$flatfileplugin->set_config('unenrolaction', ENROL_EXT_REMOVED_UNENROL);
$manualplugin->enrol_user($maninstance3, $user5->id, $teacherrole->id);
$data = "
add,student,u1,c1
add,student,u6,c2";
file_put_contents($file, $data);
$flatfileplugin->sync($trace);
$this->assertEquals(8, $DB->count_records('user_enrolments'));
$this->assertEquals(8, $DB->count_records('role_assignments'));
$this->assertEquals(0, $DB->count_records('enrol_flatfile'));
$this->assertTrue($DB->record_exists('role_assignments', array('contextid'=>$context1->id, 'userid'=>$user1->id, 'roleid'=>$studentrole->id, 'component'=>'enrol_flatfile')));
$this->assertTrue($DB->record_exists('role_assignments', array('contextid'=>$context2->id, 'userid'=>$user6->id, 'roleid'=>$studentrole->id)));
$this->assertTrue($DB->record_exists('role_assignments', array('contextid'=>$context3->id, 'userid'=>$user5->id, 'roleid'=>$teacherrole->id)));
$this->assertTrue($DB->record_exists('user_enrolments', array('userid'=>$user5->id, 'enrolid'=>$maninstance3->id)));
$this->assertTrue($DB->record_exists('user_enrolments', array('userid'=>$user1->id, 'enrolid'=>$maninstance1->id)));
$data = "
del,student,u1,c1
del,grrr,u5,c1
del,guest,u5,c2
del,student,u6,c2
del,ucitel,u5,c3";
file_put_contents($file, $data);
$flatfileplugin->sync($trace);
$this->assertEquals(5, $DB->count_records('user_enrolments'));
$this->assertEquals(5, $DB->count_records('role_assignments'));
$this->assertFalse($DB->record_exists('role_assignments', array('contextid'=>$context1->id, 'userid'=>$user1->id, 'roleid'=>$studentrole->id, 'component'=>'enrol_flatfile')));
$this->assertTrue($DB->record_exists('role_assignments', array('contextid'=>$context1->id, 'userid'=>$user1->id, 'roleid'=>$teacherrole->id)));
$this->assertFalse($DB->record_exists('role_assignments', array('contextid'=>$context2->id, 'userid'=>$user6->id, 'roleid'=>$studentrole->id)));
$this->assertFalse($DB->record_exists('role_assignments', array('contextid'=>$context3->id, 'userid'=>$user5->id, 'roleid'=>$teacherrole->id)));
$this->assertFalse($DB->record_exists('user_enrolments', array('userid'=>$user5->id, 'enrolid'=>$maninstance3->id)));
$this->assertTrue($DB->record_exists('user_enrolments', array('userid'=>$user1->id, 'enrolid'=>$maninstance1->id)));
}
public function test_notification(): void {
global $CFG, $DB;
$this->resetAfterTest();
$this->preventResetByRollback();
/** @var \enrol_flatfile_plugin $flatfileplugin */
$flatfileplugin = enrol_get_plugin('flatfile');
/** @var \enrol_manual_plugin $manualplugin */
$manualplugin = enrol_get_plugin('manual');
$this->assertNotEmpty($manualplugin);
$this->enable_plugin();
$trace = new \progress_trace_buffer(new \text_progress_trace(), false);
$file = "$CFG->dataroot/enrol.txt";
$flatfileplugin->set_config('location', $file);
$studentrole = $DB->get_record('role', array('shortname'=>'student'));
$this->assertNotEmpty($studentrole);
$teacherrole = $DB->get_record('role', array('shortname'=>'editingteacher'));
$this->assertNotEmpty($teacherrole);
$user1 = $this->getDataGenerator()->create_user(array('idnumber'=>'u1'));
$user2 = $this->getDataGenerator()->create_user(array('idnumber'=>'u2'));
$user3 = $this->getDataGenerator()->create_user(array('idnumber'=>'u3'));
$admin = get_admin();
$course1 = $this->getDataGenerator()->create_course(array('idnumber'=>'c1'));
$course2 = $this->getDataGenerator()->create_course(array('idnumber'=>'c2'));
$context1 = \context_course::instance($course1->id);
$context2 = \context_course::instance($course2->id);
$maninstance1 = $DB->get_record('enrol', array('courseid'=>$course1->id, 'enrol'=>'manual'), '*', MUST_EXIST);
$now = time();
$future = $now + 60*60*5;
$farfuture = $now + 60*60*24*5;
$manualplugin->enrol_user($maninstance1, $user3->id, $teacherrole->id);
$data =
"add,student,u1,c1
add,student,u2,c2
add,student,u2,c1,$future,$farfuture";
file_put_contents($file, $data);
$this->assertEquals(1, $DB->count_records('user_enrolments'));
$this->assertEquals(1, $DB->count_records('role_assignments'));
$this->assertEquals(0, $DB->count_records('enrol_flatfile'));
$flatfileplugin->set_config('mailadmins', 1);
$flatfileplugin->set_config('mailteachers', 1);
$flatfileplugin->set_config('mailstudents', 1);
$sink = $this->redirectMessages();
$flatfileplugin->sync($trace);
$this->assertEquals(3, $DB->count_records('user_enrolments'));
$this->assertEquals(3, $DB->count_records('role_assignments'));
$this->assertEquals(1, $DB->count_records('enrol_flatfile'));
$messages = $sink->get_messages();
$this->assertCount(5, $messages);
// Notify student from teacher.
$this->assertEquals($user1->id, $messages[0]->useridto);
$this->assertEquals($user3->id, $messages[0]->useridfrom);
// Notify teacher.
$this->assertEquals($user3->id, $messages[1]->useridto);
$this->assertEquals($admin->id, $messages[1]->useridfrom);
// Notify student when teacher not present.
$this->assertEquals($user2->id, $messages[2]->useridto);
$this->assertEquals($admin->id, $messages[2]->useridfrom);
// Notify admin when teacher not present.
$this->assertEquals($admin->id, $messages[3]->useridto);
$this->assertEquals($admin->id, $messages[3]->useridfrom);
// Sent report to admin from self.
$this->assertEquals($admin->id, $messages[4]->useridto);
$this->assertEquals($admin->id, $messages[4]->useridfrom);
}
public function test_expired(): void {
global $DB;
$this->resetAfterTest();
/** @var \enrol_flatfile_plugin $flatfileplugin */
$flatfileplugin = enrol_get_plugin('flatfile');
/** @var \enrol_manual_plugin $manualplugin */
$manualplugin = enrol_get_plugin('manual');
$this->assertNotEmpty($manualplugin);
$now = time();
$trace = new \null_progress_trace();
$this->enable_plugin();
// Prepare some data.
$studentrole = $DB->get_record('role', array('shortname'=>'student'));
$this->assertNotEmpty($studentrole);
$teacherrole = $DB->get_record('role', array('shortname'=>'teacher'));
$this->assertNotEmpty($teacherrole);
$managerrole = $DB->get_record('role', array('shortname'=>'manager'));
$this->assertNotEmpty($managerrole);
$user1 = $this->getDataGenerator()->create_user();
$user2 = $this->getDataGenerator()->create_user();
$user3 = $this->getDataGenerator()->create_user();
$user4 = $this->getDataGenerator()->create_user();
$course1 = $this->getDataGenerator()->create_course();
$course2 = $this->getDataGenerator()->create_course();
$context1 = \context_course::instance($course1->id);
$context2 = \context_course::instance($course2->id);
$data = array('roleid'=>$studentrole->id, 'courseid'=>$course1->id);
$id = $flatfileplugin->add_instance($course1, $data);
$instance1 = $DB->get_record('enrol', array('id'=>$id));
$data = array('roleid'=>$studentrole->id, 'courseid'=>$course2->id);
$id = $flatfileplugin->add_instance($course2, $data);
$instance2 = $DB->get_record('enrol', array('id'=>$id));
$data = array('roleid'=>$teacherrole->id, 'courseid'=>$course2->id);
$id = $flatfileplugin->add_instance($course2, $data);
$instance3 = $DB->get_record('enrol', array('id'=>$id));
$maninstance1 = $DB->get_record('enrol', array('courseid'=>$course2->id, 'enrol'=>'manual'), '*', MUST_EXIST);
$manualplugin->enrol_user($maninstance1, $user3->id, $studentrole->id);
$this->assertEquals(1, $DB->count_records('user_enrolments'));
$this->assertEquals(1, $DB->count_records('role_assignments'));
$this->assertEquals(1, $DB->count_records('role_assignments', array('roleid'=>$studentrole->id)));
$flatfileplugin->enrol_user($instance1, $user1->id, $studentrole->id);
$flatfileplugin->enrol_user($instance1, $user2->id, $studentrole->id);
$flatfileplugin->enrol_user($instance1, $user3->id, $studentrole->id, 0, $now-60);
$flatfileplugin->enrol_user($instance2, $user1->id, $studentrole->id, 0, 0);
$flatfileplugin->enrol_user($instance2, $user2->id, $studentrole->id, 0, $now-60*60);
$flatfileplugin->enrol_user($instance2, $user3->id, $studentrole->id, 0, $now+60*60);
$flatfileplugin->enrol_user($instance3, $user1->id, $teacherrole->id, $now-60*60*24*7, $now-60);
$flatfileplugin->enrol_user($instance3, $user4->id, $teacherrole->id);
role_assign($managerrole->id, $user3->id, $context1->id);
$this->assertEquals(9, $DB->count_records('user_enrolments'));
$this->assertEquals(10, $DB->count_records('role_assignments'));
$this->assertEquals(7, $DB->count_records('role_assignments', array('roleid'=>$studentrole->id)));
$this->assertEquals(2, $DB->count_records('role_assignments', array('roleid'=>$teacherrole->id)));
$this->assertEquals(1, $DB->count_records('role_assignments', array('roleid'=>$managerrole->id)));
// Execute tests.
$flatfileplugin->set_config('expiredaction', ENROL_EXT_REMOVED_KEEP);
$code = $flatfileplugin->sync($trace);
$this->assertSame(0, $code);
$this->assertEquals(9, $DB->count_records('user_enrolments'));
$this->assertEquals(10, $DB->count_records('role_assignments'));
$flatfileplugin->set_config('expiredaction', ENROL_EXT_REMOVED_SUSPENDNOROLES);
$flatfileplugin->sync($trace);
$this->assertEquals(9, $DB->count_records('user_enrolments'));
$this->assertEquals(7, $DB->count_records('role_assignments'));
$this->assertEquals(5, $DB->count_records('role_assignments', array('roleid'=>$studentrole->id)));
$this->assertEquals(1, $DB->count_records('role_assignments', array('roleid'=>$teacherrole->id)));
$this->assertEquals(1, $DB->count_records('role_assignments', array('roleid'=>$managerrole->id)));
$this->assertFalse($DB->record_exists('role_assignments', array('contextid'=>$context1->id, 'userid'=>$user3->id, 'roleid'=>$studentrole->id)));
$this->assertFalse($DB->record_exists('role_assignments', array('contextid'=>$context2->id, 'userid'=>$user2->id, 'roleid'=>$studentrole->id)));
$this->assertFalse($DB->record_exists('role_assignments', array('contextid'=>$context2->id, 'userid'=>$user1->id, 'roleid'=>$teacherrole->id)));
$this->assertTrue($DB->record_exists('role_assignments', array('contextid'=>$context2->id, 'userid'=>$user1->id, 'roleid'=>$studentrole->id)));
$flatfileplugin->set_config('expiredaction', ENROL_EXT_REMOVED_UNENROL);
role_assign($studentrole->id, $user3->id, $context1->id, 'enrol_flatfile', $instance1->id);
role_assign($studentrole->id, $user2->id, $context2->id, 'enrol_flatfile', $instance2->id);
role_assign($teacherrole->id, $user1->id, $context2->id, 'enrol_flatfile', $instance3->id);
$this->assertEquals(9, $DB->count_records('user_enrolments'));
$this->assertEquals(10, $DB->count_records('role_assignments'));
$this->assertEquals(7, $DB->count_records('role_assignments', array('roleid'=>$studentrole->id)));
$this->assertEquals(2, $DB->count_records('role_assignments', array('roleid'=>$teacherrole->id)));
$this->assertEquals(1, $DB->count_records('role_assignments', array('roleid'=>$managerrole->id)));
$flatfileplugin->sync($trace);
$this->assertEquals(6, $DB->count_records('user_enrolments'));
$this->assertFalse($DB->record_exists('user_enrolments', array('enrolid'=>$instance1->id, 'userid'=>$user3->id)));
$this->assertFalse($DB->record_exists('user_enrolments', array('enrolid'=>$instance2->id, 'userid'=>$user2->id)));
$this->assertFalse($DB->record_exists('user_enrolments', array('enrolid'=>$instance3->id, 'userid'=>$user1->id)));
$this->assertEquals(6, $DB->count_records('role_assignments'));
$this->assertEquals(5, $DB->count_records('role_assignments', array('roleid'=>$studentrole->id)));
$this->assertEquals(1, $DB->count_records('role_assignments', array('roleid'=>$teacherrole->id)));
$this->assertEquals(0, $DB->count_records('role_assignments', array('roleid'=>$managerrole->id)));
}
/**
* Flatfile enrolment sync task test.
*/
public function test_flatfile_sync_task(): void {
global $CFG, $DB;
$this->resetAfterTest();
$flatfileplugin = enrol_get_plugin('flatfile');
$trace = new \null_progress_trace();
$this->enable_plugin();
$file = "$CFG->dataroot/enrol.txt";
$flatfileplugin->set_config('location', $file);
$studentrole = $DB->get_record('role', array('shortname' => 'student'));
$this->assertNotEmpty($studentrole);
$user1 = $this->getDataGenerator()->create_user(array('idnumber' => 'u1'));
$course1 = $this->getDataGenerator()->create_course(array('idnumber' => 'c1'));
$context1 = \context_course::instance($course1->id);
$data =
"add,student,u1,c1";
file_put_contents($file, $data);
$task = new flatfile_sync_task;
$task->execute();
$this->assertEquals(1, $DB->count_records('role_assignments', array('roleid' => $studentrole->id)));
}
/**
* Test for getting user enrolment actions.
*/
public function test_get_user_enrolment_actions(): void {
global $CFG, $PAGE;
$this->resetAfterTest();
// Set page URL to prevent debugging messages.
$PAGE->set_url('/enrol/editinstance.php');
$pluginname = 'flatfile';
// Only enable the flatfile enrol plugin.
$CFG->enrol_plugins_enabled = $pluginname;
$generator = $this->getDataGenerator();
// Get the enrol plugin.
$plugin = enrol_get_plugin($pluginname);
// Create a course.
$course = $generator->create_course();
// Enable this enrol plugin for the course.
$plugin->add_instance($course);
// Create a student.
$student = $generator->create_user();
// Enrol the student to the course.
$generator->enrol_user($student->id, $course->id, 'student', $pluginname);
// Teachers don't have enrol/flatfile:manage and enrol/flatfile:unenrol capabilities by default.
// Login as admin for simplicity.
$this->setAdminUser();
require_once($CFG->dirroot . '/enrol/locallib.php');
$manager = new \course_enrolment_manager($PAGE, $course);
$userenrolments = $manager->get_user_enrolments($student->id);
$this->assertCount(1, $userenrolments);
$ue = reset($userenrolments);
$actions = $plugin->get_user_enrolment_actions($manager, $ue);
// Flatfile enrolment has 2 enrol actions for active users -- edit and unenrol.
$this->assertCount(2, $actions);
}
}
enrol/flatfile/tests/privacy/provider_test.php
+312
View File
@@ -0,0 +1,312 @@
<?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/>.
/**
* Privacy tests for enrol_flatfile.
*
* @package enrol_flatfile
* @category test
* @copyright 2018 Jake Dallimore <jrhdallimore@gmail.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace enrol_flatfile\privacy;
defined('MOODLE_INTERNAL') || die();
use core_privacy\local\metadata\collection;
use core_privacy\tests\provider_testcase;
use core_privacy\local\request\approved_contextlist;
use core_privacy\local\request\writer;
use enrol_flatfile\privacy\provider;
/**
* Privacy tests for enrol_flatfile.
*
* @copyright 2018 Jake Dallimore <jrhdallimore@gmail.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class provider_test extends provider_testcase {
/** @var \stdClass $user1 a test user.*/
protected $user1;
/** @var \stdClass $user2 a test user.*/
protected $user2;
/** @var \stdClass $user3 a test user.*/
protected $user3;
/** @var \stdClass $user4 a test user.*/
protected $user4;
/** @var \context $coursecontext1 a course context.*/
protected $coursecontext1;
/** @var \context $coursecontext2 a course context.*/
protected $coursecontext2;
/** @var \context $coursecontext3 a course context.*/
protected $coursecontext3;
/**
* Called before every test.
*/
public function setUp(): void {
$this->resetAfterTest(true);
}
/**
* Verify that get_metadata returns the database table mapping.
*/
public function test_get_metadata(): void {
$collection = new collection('enrol_flatfile');
$collection = provider::get_metadata($collection);
$collectiondata = $collection->get_collection();
$this->assertNotEmpty($collectiondata);
$this->assertInstanceOf(\core_privacy\local\metadata\types\database_table::class, $collectiondata[0]);
}
/**
* Verify that the relevant course contexts are returned for users with pending enrolment records.
*/
public function test_get_contexts_for_user(): void {
global $DB;
// Create, via flatfile syncing, the future enrolments entries in the enrol_flatfile table.
$this->create_future_enrolments();
$this->assertEquals(5, $DB->count_records('enrol_flatfile'));
// We expect to see 2 entries for user1, in course1 and course3.
$contextlist = provider::get_contexts_for_userid($this->user1->id);
$this->assertEquals(2, $contextlist->count());
$contextids = $contextlist->get_contextids();
$this->assertContainsEquals($this->coursecontext1->id, $contextids);
$this->assertContainsEquals($this->coursecontext3->id, $contextids);
// And 1 for user2 on course2.
$contextlist = provider::get_contexts_for_userid($this->user2->id);
$this->assertEquals(1, $contextlist->count());
$contextids = $contextlist->get_contextids();
$this->assertContainsEquals($this->coursecontext2->id, $contextids);
}
/**
* Verify the export includes any future enrolment records for the user.
*/
public function test_export_user_data(): void {
// Create, via flatfile syncing, the future enrolments entries in the enrol_flatfile table.
$this->create_future_enrolments();
// Get contexts containing user data.
$contextlist = provider::get_contexts_for_userid($this->user1->id);
$this->assertEquals(2, $contextlist->count());
$approvedcontextlist = new approved_contextlist(
$this->user1,
'enrol_flatfile',
$contextlist->get_contextids()
);
// Export for the approved contexts.
provider::export_user_data($approvedcontextlist);
// Verify we see one future course enrolment in course1, and one in course3.
$subcontext = \core_enrol\privacy\provider::get_subcontext([get_string('pluginname', 'enrol_flatfile')]);
$writer = writer::with_context($this->coursecontext1);
$this->assertNotEmpty($writer->get_data($subcontext));
$writer = writer::with_context($this->coursecontext3);
$this->assertNotEmpty($writer->get_data($subcontext));
// Verify we have nothing in course 2 for this user.
$writer = writer::with_context($this->coursecontext2);
$this->assertEmpty($writer->get_data($subcontext));
}
/**
* Verify export will limit any future enrolment records to only those contextids provided.
*/
public function test_export_user_data_restricted_context_subset(): void {
// Create, via flatfile syncing, the future enrolments entries in the enrol_flatfile table.
$this->create_future_enrolments();
// Now, limit the export scope to just course1's context and verify only that data is seen in any export.
$subsetapprovedcontextlist = new approved_contextlist(
$this->user1,
'enrol_flatfile',
[$this->coursecontext1->id]
);
// Export for the approved contexts.
provider::export_user_data($subsetapprovedcontextlist);
// Verify we see one future course enrolment in course1 only.
$subcontext = \core_enrol\privacy\provider::get_subcontext([get_string('pluginname', 'enrol_flatfile')]);
$writer = writer::with_context($this->coursecontext1);
$this->assertNotEmpty($writer->get_data($subcontext));
// And nothing in the course3 context.
$writer = writer::with_context($this->coursecontext3);
$this->assertEmpty($writer->get_data($subcontext));
}
/**
* Verify that records can be deleted by context.
*/
public function test_delete_data_for_all_users_in_context(): void {
global $DB;
// Create, via flatfile syncing, the future enrolments entries in the enrol_flatfile table.
$this->create_future_enrolments();
// Verify we have 3 future enrolments for course 1.
$this->assertEquals(3, $DB->count_records('enrol_flatfile', ['courseid' => $this->coursecontext1->instanceid]));
// Now, run delete by context and confirm that all records are removed.
provider::delete_data_for_all_users_in_context($this->coursecontext1);
$this->assertEquals(0, $DB->count_records('enrol_flatfile', ['courseid' => $this->coursecontext1->instanceid]));
}
public function test_delete_data_for_user(): void {
global $DB;
// Create, via flatfile syncing, the future enrolments entries in the enrol_flatfile table.
$this->create_future_enrolments();
// Verify we have 2 future enrolments for course 1 and course 3.
$contextlist = provider::get_contexts_for_userid($this->user1->id);
$this->assertEquals(2, $contextlist->count());
$contextids = $contextlist->get_contextids();
$this->assertContainsEquals($this->coursecontext1->id, $contextids);
$this->assertContainsEquals($this->coursecontext3->id, $contextids);
$approvedcontextlist = new approved_contextlist(
$this->user1,
'enrol_flatfile',
$contextids
);
// Now, run delete for user and confirm that both records are removed.
provider::delete_data_for_user($approvedcontextlist);
$contextlist = provider::get_contexts_for_userid($this->user1->id);
$this->assertEquals(0, $contextlist->count());
$this->assertEquals(0, $DB->count_records('enrol_flatfile', ['userid' => $this->user1->id]));
}
/**
* Test for provider::get_users_in_context().
*/
public function test_get_users_in_context(): void {
global $DB;
// Create, via flatfile syncing, the future enrolments entries in the enrol_flatfile table.
$this->create_future_enrolments();
$this->assertEquals(5, $DB->count_records('enrol_flatfile'));
// We expect to see 3 entries for course1, and that's user1, user3 and user4.
$userlist = new \core_privacy\local\request\userlist($this->coursecontext1, 'enrol_flatfile');
provider::get_users_in_context($userlist);
$this->assertEqualsCanonicalizing(
[$this->user1->id, $this->user3->id, $this->user4->id],
$userlist->get_userids());
// And 1 for course2 which is for user2.
$userlist = new \core_privacy\local\request\userlist($this->coursecontext2, 'enrol_flatfile');
provider::get_users_in_context($userlist);
$this->assertEquals([$this->user2->id], $userlist->get_userids());
// And 1 for course3 which is for user1 again.
$userlist = new \core_privacy\local\request\userlist($this->coursecontext3, 'enrol_flatfile');
provider::get_users_in_context($userlist);
$this->assertEquals([$this->user1->id], $userlist->get_userids());
}
/**
* Test for provider::delete_data_for_users().
*/
public function test_delete_data_for_users(): void {
global $DB;
// Create, via flatfile syncing, the future enrolments entries in the enrol_flatfile table.
$this->create_future_enrolments();
// Verify we have 3 future enrolment for user 1, user 3 and user 4.
$userlist = new \core_privacy\local\request\userlist($this->coursecontext1, 'enrol_flatfile');
provider::get_users_in_context($userlist);
$this->assertEqualsCanonicalizing(
[$this->user1->id, $this->user3->id, $this->user4->id],
$userlist->get_userids());
$approveduserlist = new \core_privacy\local\request\approved_userlist($this->coursecontext1, 'enrol_flatfile',
[$this->user1->id, $this->user3->id]);
// Now, run delete for user and confirm that the record is removed.
provider::delete_data_for_users($approveduserlist);
$userlist = new \core_privacy\local\request\userlist($this->coursecontext1, 'enrol_flatfile');
provider::get_users_in_context($userlist);
$this->assertEquals([$this->user4->id], $userlist->get_userids());
$this->assertEquals(
[$this->user4->id],
$DB->get_fieldset_select('enrol_flatfile', 'userid', 'courseid = ?', [$this->coursecontext1->instanceid])
);
}
/**
* Helper to sync a file and create the enrol_flatfile DB entries, for use with the get, export and delete tests.
*/
protected function create_future_enrolments() {
global $CFG;
$this->user1 = $this->getDataGenerator()->create_user(['idnumber' => 'u1']);
$this->user2 = $this->getDataGenerator()->create_user(['idnumber' => 'u2']);
$this->user3 = $this->getDataGenerator()->create_user(['idnumber' => 'u3']);
$this->user4 = $this->getDataGenerator()->create_user(['idnumber' => 'u4']);
$course1 = $this->getDataGenerator()->create_course(['idnumber' => 'c1']);
$course2 = $this->getDataGenerator()->create_course(['idnumber' => 'c2']);
$course3 = $this->getDataGenerator()->create_course(['idnumber' => 'c3']);
$this->coursecontext1 = \context_course::instance($course1->id);
$this->coursecontext2 = \context_course::instance($course2->id);
$this->coursecontext3 = \context_course::instance($course3->id);
$now = time();
$future = $now + 60 * 60 * 5;
$farfuture = $now + 60 * 60 * 24 * 5;
$file = "$CFG->dataroot/enrol.txt";
$data = "add,student,u1,c1,$future,0
add,student,u2,c2,$future,0
add,student,u3,c1,$future,0
add,student,u4,c1,$future,0
add,student,u1,c3,$future,$farfuture";
file_put_contents($file, $data);
$trace = new \null_progress_trace();
$this->enable_plugin();
$flatfileplugin = enrol_get_plugin('flatfile');
$flatfileplugin->set_config('location', $file);
$flatfileplugin->sync($trace);
}
/**
* Enables the flatfile plugin for testing.
*/
protected function enable_plugin() {
$enabled = enrol_get_plugins(true);
$enabled['flatfile'] = true;
$enabled = array_keys($enabled);
set_config('enrol_plugins_enabled', implode(',', $enabled));
}
}