Skip to content

Commit

Permalink
MDL-63500 enrol_cohort: Support for removal of multiple context users
Browse files Browse the repository at this point in the history 
This issue is part of the MDL-62560 Epic.
  • Loading branch information
@rezaies
rezaies authored and David Monllao committed Oct 22, 2018
1 parent 8091629 commit 882c53d
Show file tree
Hide file tree
Showing 2 changed files with 193 additions and 10 deletions.
54 changes: 48 additions & 6 deletions enrol/cohort/classes/privacy/provider.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,25 @@
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.

/**
* Privacy Subsystem implementation for enrol_cohort.
*
* @package enrol_cohort
* @category privacy
* @copyright 2018 Carlos Escobedo <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/

namespace enrol_cohort\privacy;

defined('MOODLE_INTERNAL') || die();
use \core_privacy\local\metadata\collection;
use \core_privacy\local\request\contextlist;
use \core_privacy\local\request\approved_contextlist;

use core_privacy\local\metadata\collection;
use core_privacy\local\request\approved_userlist;
use core_privacy\local\request\contextlist;
use core_privacy\local\request\approved_contextlist;
use core_privacy\local\request\userlist;

/**
* Privacy provider for enrol_cohort.
Expand All @@ -33,8 +40,15 @@
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class provider implements
\core_privacy\local\metadata\provider,
\core_privacy\local\request\plugin\provider {
// This plugin stores user data.
\core_privacy\local\metadata\provider,

// This plugin contains user's enrolments.
\core_privacy\local\request\plugin\provider,

// This plugin is capable of determining which users have data within it.
\core_privacy\local\request\core_userlist_provider {

/**
* Returns meta data about this system.
*
Expand All @@ -46,6 +60,7 @@ public static function get_metadata(collection $collection) : collection {
$collection->add_subsystem_link('core_group', [], 'privacy:metadata:core_group');
return $collection;
}

/**
* Get the list of contexts that contain user information for the specified user.
*
Expand All @@ -71,6 +86,22 @@ public static function get_contexts_for_userid(int $userid) : contextlist {

return $contextlist;
}

/**
* Get the list of users who have data within a context.
*
* @param userlist $userlist The userlist containing the list of users who have data in this context/plugin combination.
*/
public static function get_users_in_context(userlist $userlist) {
$context = $userlist->get_context();

if (!$context instanceof \context_course) {
return;
}

\core_group\privacy\provider::get_group_members_in_context($userlist, 'enrol_cohort');
}

/**
* Export all user data for the specified user, in the specified contexts.
*
Expand Down Expand Up @@ -105,6 +136,7 @@ public static function delete_data_for_all_users_in_context(\context $context) {
\core_group\privacy\provider::delete_groups_for_all_users($context, 'enrol_cohort');
}
}

/**
* Delete all user data for the specified user, in the specified contexts.
*
Expand All @@ -116,4 +148,14 @@ public static function delete_data_for_user(approved_contextlist $contextlist) {
}
\core_group\privacy\provider::delete_groups_for_user($contextlist, 'enrol_cohort');
}
}

/**
* Delete multiple users within a single context.
*
* @param approved_userlist $userlist The approved context and user information to delete information for.
*/
public static function delete_data_for_users(approved_userlist $userlist) {
\core_group\privacy\provider::delete_groups_for_users($userlist, 'enrol_cohort');
}

}
149 changes: 145 additions & 4 deletions enrol/cohort/tests/privacy_test.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
//
// 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.
*
Expand All @@ -21,17 +22,21 @@
* @copyright 2018 Carlos Escobedo <[email protected]>
* @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;

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 <[email protected]>
* @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.
*/
Expand Down Expand Up @@ -123,6 +128,7 @@ public function test_export_user_data() {
}
}
}

/**
* Test for provider::delete_data_for_all_users_in_context().
*/
Expand Down Expand Up @@ -170,6 +176,7 @@ public function test_delete_data_for_all_users_in_context() {
WHERE g.courseid = ?", [$course1->id])
);
}

/**
* Test for provider::delete_data_for_user().
*/
Expand Down Expand Up @@ -249,4 +256,138 @@ public function test_delete_data_for_user() {
WHERE g.courseid = ?", [$course2->id])
);
}
}

/**
* Test for provider::delete_data_for_users().
*/
public function test_delete_data_for_users() {
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])
);

$coursecontext1 = context_course::instance($course1->id);

$approveduserlist = new \core_privacy\local\request\approved_userlist($coursecontext1, 'enrol_cohort',
[$user1->id, $user2->id]);
provider::delete_data_for_users($approveduserlist);

// Check we have 2 users in groups because we have deleted user1.
// User2's membership is manual and is not as the result of a cohort enrolment.
$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 that course2 is not touched.
$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])
);
}

/**
* Test for provider::get_users_in_context().
*/
public function test_get_users_in_context() {
global $DB;

$this->resetAfterTest();

$trace = new null_progress_trace();

$cohortplugin = enrol_get_plugin('cohort');

$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)
);

$user1 = $this->getDataGenerator()->create_user();

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')
));

$context = \context_course::instance($course1->id);

$userlist = new \core_privacy\local\request\userlist($context, 'enrol_cohort');
\enrol_cohort\privacy\provider::get_users_in_context($userlist);

$this->assertEquals([$user1->id], $userlist->get_userids());
}
}

0 comments on commit 882c53d

Please sign in to comment.