mirrored from git://git.moodle.org/moodle.git
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
MDL-62357 enrol_cohort: Add privacy implementation for enrol_cohort
- Loading branch information
Showing
3 changed files
with
338 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,252 @@ | ||
| <?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/>. | ||
| /** | ||
| * Base class for unit tests for enrol_cohort. | ||
| * | ||
| * @package enrol_cohort | ||
| * @category test | ||
| * @copyright 2018 Carlos Escobedo <carlos@moodle.com> | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
| defined('MOODLE_INTERNAL') || die(); | ||
| use \core_privacy\local\request\writer; | ||
| use \core_privacy\local\request\approved_contextlist; | ||
| use \enrol_cohort\privacy\provider; | ||
| /** | ||
| * Unit tests for the enrol_cohort implementation of the privacy API. | ||
| * | ||
| * @copyright 2018 Carlos Escobedo <carlos@moodle.com> | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
| class enrol_cohort_privacy_testcase extends \core_privacy\tests\provider_testcase { | ||
| /** | ||
| * Test getting the context for the user ID related to this plugin. | ||
| */ | ||
| public function test_get_contexts_for_userid() { | ||
| global $DB; | ||
|
|
||
| $this->resetAfterTest(); | ||
| $trace = new null_progress_trace(); | ||
|
|
||
| $cohortplugin = enrol_get_plugin('cohort'); | ||
| $user1 = $this->getDataGenerator()->create_user(); | ||
| $cat1 = $this->getDataGenerator()->create_category(); | ||
| $course1 = $this->getDataGenerator()->create_course(array('category' => $cat1->id)); | ||
| $group1 = $this->getDataGenerator()->create_group(array('courseid' => $course1->id)); | ||
| $studentrole = $DB->get_record('role', array('shortname' => 'student')); | ||
| $cohort1 = $this->getDataGenerator()->create_cohort( | ||
| array('contextid' => context_coursecat::instance($cat1->id)->id)); | ||
| $cohortplugin->add_instance($course1, array( | ||
| 'customint1' => $cohort1->id, | ||
| 'roleid' => $studentrole->id, | ||
| 'customint2' => $group1->id) | ||
| ); | ||
|
|
||
| cohort_add_member($cohort1->id, $user1->id); | ||
| enrol_cohort_sync($trace, $course1->id); | ||
| // Check if user1 is enrolled into course1 in group 1. | ||
| $this->assertEquals(1, $DB->count_records('role_assignments', array())); | ||
| $this->assertTrue($DB->record_exists('groups_members', array( | ||
| 'groupid' => $group1->id, | ||
| 'userid' => $user1->id, | ||
| 'component' => 'enrol_cohort') | ||
| )); | ||
| // Check context course fro provider to user1. | ||
| $context = \context_course::instance($course1->id); | ||
| $contextlist = provider::get_contexts_for_userid($user1->id); | ||
| $this->assertEquals($context->id, $contextlist->current()->id); | ||
| } | ||
|
|
||
| /** | ||
| * Test that user data is exported correctly. | ||
| */ | ||
| public function test_export_user_data() { | ||
| global $DB; | ||
|
|
||
| $this->resetAfterTest(); | ||
| $trace = new null_progress_trace(); | ||
|
|
||
| $cohortplugin = enrol_get_plugin('cohort'); | ||
| $user1 = $this->getDataGenerator()->create_user(); | ||
| $cat1 = $this->getDataGenerator()->create_category(); | ||
| $course1 = $this->getDataGenerator()->create_course(array('category' => $cat1->id)); | ||
| $group1 = $this->getDataGenerator()->create_group(array('courseid' => $course1->id)); | ||
| $studentrole = $DB->get_record('role', array('shortname' => 'student')); | ||
| $cohort1 = $this->getDataGenerator()->create_cohort( | ||
| array('contextid' => context_coursecat::instance($cat1->id)->id)); | ||
| $cohortplugin->add_instance($course1, array( | ||
| 'customint1' => $cohort1->id, | ||
| 'roleid' => $studentrole->id, | ||
| 'customint2' => $group1->id) | ||
| ); | ||
|
|
||
| cohort_add_member($cohort1->id, $user1->id); | ||
| enrol_cohort_sync($trace, $course1->id); | ||
| // Check if user1 is enrolled into course1 in group 1. | ||
| $this->assertEquals(1, $DB->count_records('role_assignments', array())); | ||
| $this->assertTrue($DB->record_exists('groups_members', array( | ||
| 'groupid' => $group1->id, | ||
| 'userid' => $user1->id, | ||
| 'component' => 'enrol_cohort') | ||
| )); | ||
|
|
||
| $this->setUser($user1); | ||
| $contextlist = provider::get_contexts_for_userid($user1->id); | ||
| $approvedcontextlist = new approved_contextlist($user1, 'enrol_cohort', $contextlist->get_contextids()); | ||
| provider::export_user_data($approvedcontextlist); | ||
| foreach ($contextlist as $context) { | ||
| $writer = writer::with_context($context); | ||
| $data = $writer->get_data([ | ||
| get_string('pluginname', 'enrol_cohort'), | ||
| get_string('groups', 'core_group') | ||
| ]); | ||
| $this->assertTrue($writer->has_any_data()); | ||
| if ($context->contextlevel == CONTEXT_COURSE) { | ||
| $exportedgroups = $data->groups; | ||
| // User1 only belongs to group1 via enrol_cohort. | ||
| $this->assertCount(1, $exportedgroups); | ||
| $exportedgroup = reset($exportedgroups); | ||
| $this->assertEquals($group1->name, $exportedgroup->name); | ||
| } | ||
| } | ||
| } | ||
| /** | ||
| * Test for provider::delete_data_for_all_users_in_context(). | ||
| */ | ||
| public function test_delete_data_for_all_users_in_context() { | ||
| global $DB; | ||
|
|
||
| $this->resetAfterTest(); | ||
| $trace = new null_progress_trace(); | ||
|
|
||
| $cohortplugin = enrol_get_plugin('cohort'); | ||
| $user1 = $this->getDataGenerator()->create_user(); | ||
| $user2 = $this->getDataGenerator()->create_user(); | ||
| $user3 = $this->getDataGenerator()->create_user(); | ||
| $cat1 = $this->getDataGenerator()->create_category(); | ||
| $course1 = $this->getDataGenerator()->create_course(array('category' => $cat1->id)); | ||
| $group1 = $this->getDataGenerator()->create_group(array('courseid' => $course1->id)); | ||
| $studentrole = $DB->get_record('role', array('shortname' => 'student')); | ||
| $cohort1 = $this->getDataGenerator()->create_cohort( | ||
| array('contextid' => context_coursecat::instance($cat1->id)->id)); | ||
| $cohortplugin->add_instance($course1, array( | ||
| 'customint1' => $cohort1->id, | ||
| 'roleid' => $studentrole->id, | ||
| 'customint2' => $group1->id) | ||
| ); | ||
|
|
||
| cohort_add_member($cohort1->id, $user1->id); | ||
| cohort_add_member($cohort1->id, $user2->id); | ||
| cohort_add_member($cohort1->id, $user3->id); | ||
| enrol_cohort_sync($trace, $course1->id); | ||
| $this->assertEquals( | ||
| 3, | ||
| $DB->count_records_sql("SELECT COUNT(gm.id) | ||
| FROM {groups_members} gm | ||
| JOIN {groups} g ON gm.groupid = g.id | ||
| WHERE g.courseid = ?", [$course1->id]) | ||
| ); | ||
|
|
||
| $coursecontext1 = context_course::instance($course1->id); | ||
| provider::delete_data_for_all_users_in_context($coursecontext1); | ||
| $this->assertEquals( | ||
| 0, | ||
| $DB->count_records_sql("SELECT COUNT(gm.id) | ||
| FROM {groups_members} gm | ||
| JOIN {groups} g ON gm.groupid = g.id | ||
| WHERE g.courseid = ?", [$course1->id]) | ||
| ); | ||
| } | ||
| /** | ||
| * Test for provider::delete_data_for_user(). | ||
| */ | ||
| public function test_delete_data_for_user() { | ||
| global $DB; | ||
|
|
||
| $this->resetAfterTest(); | ||
| $trace = new null_progress_trace(); | ||
|
|
||
| $cohortplugin = enrol_get_plugin('cohort'); | ||
| $user1 = $this->getDataGenerator()->create_user(); | ||
| $user2 = $this->getDataGenerator()->create_user(); | ||
| $user3 = $this->getDataGenerator()->create_user(); | ||
| $cat1 = $this->getDataGenerator()->create_category(); | ||
| $course1 = $this->getDataGenerator()->create_course(array('category' => $cat1->id)); | ||
| $course2 = $this->getDataGenerator()->create_course(array('category' => $cat1->id)); | ||
| $group1 = $this->getDataGenerator()->create_group(array('courseid' => $course1->id)); | ||
| $group2 = $this->getDataGenerator()->create_group(array('courseid' => $course2->id)); | ||
| $studentrole = $DB->get_record('role', array('shortname' => 'student')); | ||
| $cohort1 = $this->getDataGenerator()->create_cohort( | ||
| array('contextid' => context_coursecat::instance($cat1->id)->id)); | ||
| $cohortplugin->add_instance($course1, array( | ||
| 'customint1' => $cohort1->id, | ||
| 'roleid' => $studentrole->id, | ||
| 'customint2' => $group1->id) | ||
| ); | ||
| $cohortplugin->add_instance($course2, array( | ||
| 'customint1' => $cohort1->id, | ||
| 'roleid' => $studentrole->id, | ||
| 'customint2' => $group2->id) | ||
| ); | ||
|
|
||
| $this->getDataGenerator()->enrol_user($user2->id, $course1->id); | ||
| $this->getDataGenerator()->enrol_user($user3->id, $course1->id); | ||
| $this->getDataGenerator()->create_group_member(array('groupid' => $group1->id, 'userid' => $user2->id)); | ||
| $this->getDataGenerator()->create_group_member(array('groupid' => $group1->id, 'userid' => $user3->id)); | ||
|
|
||
| cohort_add_member($cohort1->id, $user1->id); | ||
| enrol_cohort_sync($trace, $course1->id); | ||
|
|
||
| $this->assertEquals( | ||
| 3, | ||
| $DB->count_records_sql("SELECT COUNT(gm.id) | ||
| FROM {groups_members} gm | ||
| JOIN {groups} g ON gm.groupid = g.id | ||
| WHERE g.courseid = ?", [$course1->id]) | ||
| ); | ||
|
|
||
| $this->assertEquals( | ||
| 1, | ||
| $DB->count_records_sql("SELECT COUNT(gm.id) | ||
| FROM {groups_members} gm | ||
| JOIN {groups} g ON gm.groupid = g.id | ||
| WHERE g.courseid = ?", [$course2->id]) | ||
| ); | ||
|
|
||
| $this->setUser($user1); | ||
| $coursecontext1 = context_course::instance($course1->id); | ||
| $coursecontext2 = context_course::instance($course2->id); | ||
| $approvedcontextlist = new \core_privacy\tests\request\approved_contextlist($user1, 'enrol_cohort', | ||
| [$coursecontext1->id, $coursecontext2->id]); | ||
| provider::delete_data_for_user($approvedcontextlist); | ||
| // Check we have 2 users in groups because we are deleted user1. | ||
| $this->assertEquals( | ||
| 2, | ||
| $DB->count_records_sql("SELECT COUNT(gm.id) | ||
| FROM {groups_members} gm | ||
| JOIN {groups} g ON gm.groupid = g.id | ||
| WHERE g.courseid = ?", [$course1->id]) | ||
| ); | ||
| // Check we have not users in groups. | ||
| $this->assertEquals( | ||
| 0, | ||
| $DB->count_records_sql("SELECT COUNT(gm.id) | ||
| FROM {groups_members} gm | ||
| JOIN {groups} g ON gm.groupid = g.id | ||
| WHERE g.courseid = ?", [$course2->id]) | ||
| ); | ||
| } | ||
| } |