calendar/tests/privacy_test.php

   1 <?php
   2 // This file is part of Moodle - http://moodle.org/
   3 //
   4 // Moodle is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU General Public License as published by
   6 // the Free Software Foundation, either version 3 of the License, or
   7 // (at your option) any later version.
   8 //
   9 // Moodle is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU General Public License
  15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 /**
  18  * Privacy tests for core_calendar.
  19  *
  20  * @package    core_calendar
  21  * @category   test
  22  * @copyright  2018 Zig Tan <zig@moodle.com>
  23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24  */
  25
  26 defined('MOODLE_INTERNAL') || die();
  27 global $CFG;
  28
  29 require_once($CFG->dirroot . '/calendar/lib.php');
  30 require_once($CFG->dirroot . '/calendar/tests/externallib_test.php');
  31
  32 use \core_calendar\privacy\provider;
  33 use \core_privacy\local\metadata\collection;
  34 use \core_privacy\local\request\approved_contextlist;
  35 use \core_privacy\local\request\writer;
  36 use \core_privacy\tests\provider_testcase;
  37 use \core_privacy\local\request\approved_userlist;
  38
  39 /**
  40  * Unit tests for calendar/classes/privacy/provider
  41  *
  42  * @copyright  2018 Zig Tan <zig@moodle.com>
  43  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  44  */
  45 class core_calendar_privacy_testcase extends provider_testcase {
  46
  47     /**
  48      * Overriding setUp() function to always reset after tests.
  49      */
  50     public function setUp() {
  51         $this->resetAfterTest(true);
  52     }
  53
  54     /**
  55      * Test for provider::get_contexts_for_userid().
  56      *
  57      * @throws coding_exception
  58      */
  59     public function test_get_contexts_for_userid() {
  60         // Create test user to create Calendar Events and Subscriptions.
  61         $user = $this->getDataGenerator()->create_user();
  62         $this->setUser($user);
  63
  64         // Create a Category and Courses to assign Calendar Events and Subscriptions.
  65         $category = $this->getDataGenerator()->create_category();
  66         $course1 = $this->getDataGenerator()->create_course();
  67         $course2 = $this->getDataGenerator()->create_course();
  68         $course3 = $this->getDataGenerator()->create_course();
  69         $grouprecord = (object)[
  70             'courseid' => $course3->id,
  71             'name' => 'test_group'
  72         ];
  73         $course3group = $this->getDataGenerator()->create_group($grouprecord);
  74
  75         // Get contexts.
  76         $usercontext = context_user::instance($user->id);
  77         $categorycontext = context_coursecat::instance($category->id);
  78         $course1context = context_course::instance($course1->id);
  79         $course2context = context_course::instance($course2->id);
  80         $course3context = context_course::instance($course3->id);
  81
  82         // Add Category Calendar Events for Category.
  83         $this->create_test_standard_calendar_event('category', $user->id, time(), '', $category->id);
  84         $this->create_test_standard_calendar_event('category', $user->id, time(), '', $category->id);
  85
  86         // Add User Calendar Events for User.
  87         $this->create_test_standard_calendar_event('user', $user->id, time(), '');
  88         $this->create_test_standard_calendar_event('user', $user->id, time(), '', 0, $course1->id);
  89         $this->create_test_standard_calendar_event('user', $user->id, time(), '', 0, $course2->id);
  90
  91         // Add a Course Calendar Event for Course 1.
  92         $this->create_test_standard_calendar_event('course', $user->id, time(), '', 0, $course1->id);
  93
  94         // Add a Course Assignment Action Calendar Event for Course 2.
  95         $generator = $this->getDataGenerator()->get_plugin_generator('mod_assign');
  96         $params['course'] = $course2->id;
  97         $params['assignsubmission_onlinetext_enabled'] = 1;
  98         $instance = $generator->create_instance($params);
  99         $cm = get_coursemodule_from_instance('assign', $instance->id);
 100         $modulecontext = context_module::instance($cm->id);
 101         $assign = new assign($modulecontext, $cm, $course2);
 102         $this->create_test_action_calendar_event('duedate', $course2->id, $instance->id, 'assign', $user->id, time());
 103         $this->create_test_action_calendar_event('gradingduedate', $course2->id, $instance->id, 'assign', $user->id, time());
 104
 105         // Add a Calendar Subscription and Group Calendar Event to Course 3.
 106         $this->create_test_calendar_subscription('course', 'https://calendar.google.com/', $user->id, 0, $course3->id);
 107         $this->create_test_standard_calendar_event('group', $user->id, time(), '', 0, $course3->id, $course3group->id);
 108
 109         // The user will be in these contexts.
 110         $usercontextids = [
 111             $usercontext->id,
 112             $categorycontext->id,
 113             $course1context->id,
 114             $modulecontext->id,
 115             $course3context->id
 116         ];
 117         // Retrieve the user's context ids.
 118         $contextids = provider::get_contexts_for_userid($user->id);
 119
 120         // Check the user context list and retrieved user context lists contains the same number of records.
 121         $this->assertEquals(count($usercontextids), count($contextids->get_contextids()));
 122         // There should be no difference between the contexts.
 123         $this->assertEmpty(array_diff($usercontextids, $contextids->get_contextids()));
 124     }
 125
 126     /**
 127      * Test for provider::export_user_data().
 128      *
 129      * @throws coding_exception
 130      */
 131     public function test_export_user_data() {
 132         global $DB;
 133
 134         // Create test user to create Calendar Events and Subscriptions with.
 135         $user = $this->getDataGenerator()->create_user();
 136         $this->setUser($user);
 137
 138         // Create a Category to test creating a Category Calendar Event.
 139         $category = $this->getDataGenerator()->create_category();
 140         $course1 = $this->getDataGenerator()->create_course();
 141         $course2 = $this->getDataGenerator()->create_course();
 142         $course3 = $this->getDataGenerator()->create_course();
 143         $grouprecord = (object)[
 144             'courseid' => $course3->id,
 145             'name' => 'test_group'
 146         ];
 147         $course3group = $this->getDataGenerator()->create_group($grouprecord);
 148
 149         // Add User Calendar Events for User.
 150         $event1 = $this->create_test_standard_calendar_event('user', $user->id, time(), '');
 151
 152         // Add Category Calendar Events for Category.
 153         $event2 = $this->create_test_standard_calendar_event('category', $user->id, time(), '', $category->id);
 154
 155         // Add two Course Calendar Event for Course 1 and set the same time (1 day a head).
 156         $time = strtotime('+1 day', time());
 157         $event3 = $this->create_test_standard_calendar_event('course', $user->id, $time, 'ABC', 0, $course1->id);
 158         $event4 = $this->create_test_standard_calendar_event('course', $user->id, $time, 'DEF', 0, $course1->id);
 159
 160         // Add a Course Assignment Action Calendar Event for Course 2.
 161         $generator = $this->getDataGenerator()->get_plugin_generator('mod_assign');
 162         $params['course'] = $course2->id;
 163         $params['assignsubmission_onlinetext_enabled'] = 1;
 164         $instance = $generator->create_instance($params);
 165         $cm = get_coursemodule_from_instance('assign', $instance->id);
 166         $modulecontext = context_module::instance($cm->id);
 167         $assign = new assign($modulecontext, $cm, $course2);
 168         $event5 = $this->create_test_action_calendar_event('duedate', $course2->id, $instance->id, 'assign', $user->id, time());
 169
 170         // Add a Calendar Subscription and Group Calendar Event to Course 3.
 171         $subscription1 = $this->create_test_calendar_subscription('course', 'https://calendar.google.com/', $user->id, 0, $course3->id);
 172         $event6 = $this->create_test_standard_calendar_event('group', $user->id, time(), '', 0, $course3->id, $course3group->id);
 173
 174         // Retrieve the user's context ids.
 175         $contextlist = provider::get_contexts_for_userid($user->id);
 176         $approvedcontextlist = new approved_contextlist($user, 'core_calendar', $contextlist->get_contextids());
 177
 178         // Retrieve Calendar Event and Subscriptions data only for this user.
 179         provider::export_user_data($approvedcontextlist);
 180
 181         foreach ($contextlist as $context) {
 182             $writer = writer::with_context($context);
 183             $this->assertTrue($writer->has_any_data());
 184
 185             // Test event 1 that was created for the test User.
 186             if ($context->instanceid == $user->id && $context->contextlevel == CONTEXT_USER) {
 187                 // Test the content contains Calendar Event user data.
 188                 $subcontexts = [
 189                     get_string('calendar', 'calendar'),
 190                     get_string('events', 'calendar'),
 191                     date('c', $event1->timestart)
 192                 ];
 193                 $name = "user-event";
 194                 $data = $writer->get_related_data($subcontexts, $name);
 195                 $this->assertEquals('Standard Calendar Event user', $data->name);
 196             }
 197
 198             // Test event 2 that was created for the test Category.
 199             if ($context->instanceid == $category->id && $context->contextlevel == CONTEXT_COURSECAT) {
 200                 // Test the content contains Calendar Event category data.
 201                 $subcontexts = [
 202                     get_string('calendar', 'calendar'),
 203                     get_string('events', 'calendar'),
 204                     date('c', $event2->timestart)
 205                 ];
 206                 $name = "category-event";
 207                 $data = $writer->get_related_data($subcontexts, $name);
 208                 $this->assertEquals('Standard Calendar Event category', $data->name);
 209             }
 210
 211             // Test events 3, 4, and 5 that were created for the test Course 1.
 212             if ($context->instanceid == $course1->id && $context->contextlevel == CONTEXT_COURSE) {
 213                 // Test the content contains Calendar Event course data set with the same time, and the exported files are uniquely identified.
 214                 $subcontext1 = [
 215                     get_string('calendar', 'calendar'),
 216                     get_string('events', 'calendar'),
 217                     date('c', $event3->timestart)
 218                 ];
 219                 $name1 = "course-event-1";
 220                 $data1 = $writer->get_related_data($subcontext1, $name1);
 221                 $this->assertEquals('Standard Calendar Event course -- ABC', $data1->name);
 222
 223                 $subcontext2 = [
 224                     get_string('calendar', 'calendar'),
 225                     get_string('events', 'calendar'),
 226                     date('c', $event4->timestart)
 227                 ];
 228                 $name2 = "course-event-2";
 229                 $data2 = $writer->get_related_data($subcontext2, $name2);
 230                 $this->assertEquals('Standard Calendar Event course -- DEF', $data2->name);
 231             }
 232
 233             // Test action event that were created for the test Course 2.
 234             if ($context->instanceid == $cm->id  && $context->contextlevel == CONTEXT_MODULE) {
 235                 // Test the content contains Calendar Action Event course data.
 236                 $subcontexts = [
 237                     get_string('calendar', 'calendar'),
 238                     get_string('events', 'calendar'),
 239                     date('c', $event5->timestart)
 240                 ];
 241                 $name = "duedate-event";
 242                 $data = $writer->get_related_data($subcontexts, $name);
 243                 $this->assertEquals('Action Calendar Event duedate -- assign', $data->name);
 244             }
 245
 246             // Test Calendar Subscription and Event that were created for the test Course 3.
 247             if ($context->instanceid == $course3->id && $context->contextlevel == CONTEXT_COURSE) {
 248                 // Test the content contains Calendar Subscription data also created for the test Course 3.
 249                 $subcontexts = [
 250                     get_string('calendar', 'calendar'),
 251                     get_string('subscriptions', 'calendar')
 252                 ];
 253                 $name = "course-subscription";
 254                 $data = $writer->get_related_data($subcontexts, $name);
 255                 $this->assertEquals('Calendar Subscription course', $data->name);
 256
 257                 // Test the content contains Calendar Event group data also created for the test Course 3.
 258                 $subcontexts = [
 259                     get_string('calendar', 'calendar'),
 260                     get_string('events', 'calendar'),
 261                     date('c', $event6->timestart)
 262                 ];
 263                 $name = "group-event";
 264                 $data = $writer->get_related_data($subcontexts, $name);
 265                 $this->assertEquals('Standard Calendar Event group', $data->name);
 266             }
 267         }
 268
 269     }
 270
 271     /**
 272      * Test for provider::test_export_user_preferences().
 273      */
 274     public function test_export_user_preferences() {
 275         global $DB;
 276
 277         // Test setup.
 278         $user = $this->getDataGenerator()->create_user();
 279         $this->setUser($user);
 280
 281         // Add a user home page preference for the User.
 282         set_user_preference('calendar_savedflt', 'true', $user);
 283
 284         // Test the user preference exists.
 285         $params = [
 286             'userid' => $user->id,
 287             'name' => 'calendar_savedflt'
 288         ];
 289
 290         // Test the user preferences export contains 1 user preference record for the User.
 291         provider::export_user_preferences($user->id);
 292         $contextuser = context_user::instance($user->id);
 293         $writer = writer::with_context($contextuser);
 294         $this->assertTrue($writer->has_any_data());
 295
 296         $exportedpreferences = $writer->get_user_preferences('core_calendar');
 297         $this->assertCount(1, (array) $exportedpreferences);
 298         $this->assertEquals('true', $exportedpreferences->calendarsavedflt->value);
 299     }
 300
 301     /**
 302      * Test for provider::delete_data_for_all_users_in_context().
 303      *
 304      * @throws dml_exception
 305      */
 306     public function test_delete_data_for_all_users_in_context() {
 307         global $DB;
 308
 309         // Create test user to create Calendar Events and Subscriptions with.
 310         $user1 = $this->getDataGenerator()->create_user();
 311         $user2 = $this->getDataGenerator()->create_user();
 312
 313         // Create a Course to test creating a Category Calendar Event.
 314         $course1 = $this->getDataGenerator()->create_course();
 315         $course2 = $this->getDataGenerator()->create_course();
 316
 317         // Get contexts.
 318         $course1context = context_course::instance($course1->id);
 319         $course2context = context_course::instance($course2->id);
 320
 321         // Add a Course Calendar Event by User 1 for Course 1 and Course 2.
 322         $this->setUser($user1);
 323         $this->create_test_standard_calendar_event('course', $user1->id, time(), '', 0, $course1->id);
 324         $this->create_test_standard_calendar_event('course', $user1->id, time(), '', 0, $course2->id);
 325
 326         // Add a Calendar Subscription by User 1 for Course 1.
 327         $this->create_test_calendar_subscription('course', 'https://calendar.google.com/', $user1->id, 0, $course1->id);
 328
 329         // Add a Course Calendar Event by User 2 for Course 1 and Course 2.
 330         $this->setUser($user2);
 331         $this->create_test_standard_calendar_event('course', $user2->id, time(), '', 0, $course1->id);
 332         $this->create_test_standard_calendar_event('course', $user2->id, time(), '', 0, $course2->id);
 333
 334         // Add a Calendar Subscription by User 2 for Course 2.
 335         $this->create_test_calendar_subscription('course', 'https://calendar.google.com/', $user2->id, 0, $course2->id);
 336
 337         // Add a Course Assignment Action Calendar Event by User 2 for Course 2.
 338         $generator = $this->getDataGenerator()->get_plugin_generator('mod_assign');
 339         $params['course'] = $course2->id;
 340         $params['assignsubmission_onlinetext_enabled'] = 1;
 341         $instance = $generator->create_instance($params);
 342         $cm = get_coursemodule_from_instance('assign', $instance->id);
 343         $modulecontext = context_module::instance($cm->id);
 344         $assign = new assign($modulecontext, $cm, $course2);
 345         $this->create_test_action_calendar_event('duedate', $course2->id, $instance->id, 'assign', $user2->id, time());
 346         $this->create_test_action_calendar_event('gradingduedate', $course2->id, $instance->id, 'assign', $user2->id, time());
 347
 348         // Delete all Calendar Events for all Users by Context for Course 1.
 349         provider::delete_data_for_all_users_in_context($course1context);
 350
 351         // Verify all Calendar Events for Course 1 were deleted.
 352         $events = $DB->get_records('event', array('courseid' => $course1->id));
 353         $this->assertCount(0, $events);
 354         // Verify all Calendar Subscriptions for Course 1 were deleted.
 355         $subscriptions = $DB->get_records('event_subscriptions', array('courseid' => $course1->id));
 356         $this->assertCount(0, $subscriptions);
 357
 358         // Verify all Calendar Events for Course 2 exists still.
 359         $events = $DB->get_records('event', array('courseid' => $course2->id));
 360         $this->assertCount(4, $events);
 361         // Verify all Calendar Subscriptions for Course 2 exists still.
 362         $subscriptions = $DB->get_records('event_subscriptions', array('courseid' => $course2->id));
 363         $this->assertCount(1, $subscriptions);
 364
 365         // Delete all Calendar Events for all Users by Context for Course 2.
 366         provider::delete_data_for_all_users_in_context($course2context);
 367
 368         // Verify all Calendar Events for Course 2 were deleted.
 369         $events = $DB->get_records('event', array('courseid' => $course2->id));
 370         $this->assertCount(0, $events);
 371         // Verify all Calendar Subscriptions for Course 2 were deleted.
 372         $subscriptions = $DB->get_records('event_subscriptions', array('courseid' => $course2->id));
 373         $this->assertCount(0, $subscriptions);
 374     }
 375
 376     /**
 377      * Test for provider::delete_data_for_user().
 378      *
 379      * @throws dml_exception
 380      */
 381     public function test_delete_data_for_user() {
 382         global $DB;
 383
 384         // Create test user to create Calendar Events and Subscriptions with.
 385         $user1 = $this->getDataGenerator()->create_user();
 386         $user2 = $this->getDataGenerator()->create_user();
 387
 388         // Create a Category and Courses to test creating a Category Calendar Event.
 389         $category = $this->getDataGenerator()->create_category();
 390         $course1 = $this->getDataGenerator()->create_course();
 391         $course2 = $this->getDataGenerator()->create_course();
 392
 393         // Add 5 Calendar Events for User 1 for various contexts.
 394         $this->setUser($user1);
 395         $this->create_test_standard_calendar_event('user', $user1->id, time(), '');
 396         $this->create_test_standard_calendar_event('site', $user1->id, time(), '', 0, 1);
 397         $this->create_test_standard_calendar_event('category', $user1->id, time(), '', $category->id);
 398         $this->create_test_standard_calendar_event('course', $user1->id, time(), '', 0, $course1->id);
 399         $this->create_test_standard_calendar_event('course', $user1->id, time(), '', 0, $course2->id);
 400
 401         // Add 1 Calendar Subscription for User 1 at course context.
 402         $this->create_test_calendar_subscription('course', 'https://calendar.google.com/', $user1->id, 0, $course2->id);
 403
 404         // Add 3 Calendar Events for User 2 for various contexts.
 405         $this->setUser($user2);
 406         $this->create_test_standard_calendar_event('user', $user2->id, time(), '');
 407         $this->create_test_standard_calendar_event('category', $user2->id, time(), '', $category->id);
 408         $this->create_test_standard_calendar_event('course', $user2->id, time(), '', 0, $course1->id);
 409
 410         // Add 1 Calendar Subscription for User 2 at course context.
 411         $this->create_test_calendar_subscription('course', 'https://calendar.google.com/', $user2->id, 0, $course2->id);
 412
 413         // Retrieve the user's context ids.
 414         $contextlist = provider::get_contexts_for_userid($user1->id);
 415         $approvedcontextlist = new approved_contextlist($user1, 'core_calendar', $contextlist->get_contextids());
 416
 417         // Delete all Calendar data for User 1.
 418         provider::delete_data_for_user($approvedcontextlist);
 419
 420         // Test all Calendar Events and Subscriptions for User 1 equals zero.
 421         $events = $DB->get_records('event', ['userid' => $user1->id]);
 422         $this->assertCount(0, $events);
 423         $eventsubscriptions = $DB->get_records('event_subscriptions', ['userid' => $user1->id]);
 424         $this->assertCount(0, $eventsubscriptions);
 425
 426         // Test all Calendar Events and Subscriptions for User 2 still exists and matches the same number created.
 427         $events = $DB->get_records('event', ['userid' => $user2->id]);
 428         $this->assertCount(3, $events);
 429         $eventsubscriptions = $DB->get_records('event_subscriptions', ['userid' => $user2->id]);
 430         $this->assertCount(1, $eventsubscriptions);
 431     }
 432
 433     /**
 434      * Test that only users with a user context are fetched.
 435      */
 436     public function test_get_users_in_context() {
 437         $component = 'core_calendar';
 438
 439         // Create user1 to create Calendar Events and Subscriptions.
 440         $user1 = $this->getDataGenerator()->create_user();
 441         $usercontext1 = context_user::instance($user1->id);
 442         // Create user2 to create Calendar Events and Subscriptions.
 443         $user2 = $this->getDataGenerator()->create_user();
 444         $usercontext2 = context_user::instance($user2->id);
 445         // Create user3 to create Calendar Events and Subscriptions.
 446         $user3 = $this->getDataGenerator()->create_user();
 447         $usercontext3 = context_user::instance($user3->id);
 448
 449         // Create a Category and Courses to assign Calendar Events and Subscriptions.
 450         $category = $this->getDataGenerator()->create_category();
 451         $categorycontext = context_coursecat::instance($category->id);
 452         $course1 = $this->getDataGenerator()->create_course();
 453         $course1context = context_course::instance($course1->id);
 454         $course2 = $this->getDataGenerator()->create_course();
 455         $course2context = context_course::instance($course2->id);
 456         $course3 = $this->getDataGenerator()->create_course();
 457         $course3context = context_course::instance($course3->id);
 458         $grouprecord = (object)[
 459             'courseid' => $course3->id,
 460             'name' => 'test_group'
 461         ];
 462         $course3group = $this->getDataGenerator()->create_group($grouprecord);
 463
 464         // Add Category Calendar Events for Category.
 465         $this->setUser($user1);
 466         $this->create_test_standard_calendar_event('category', $user1->id, time(), '',
 467                 $category->id);
 468         $this->setUser($user2);
 469         $this->create_test_standard_calendar_event('category', $user2->id, time(), '',
 470                 $category->id);
 471
 472         // Add User Calendar Events for user1 and user2.
 473         $this->setUser($user1);
 474         $this->create_test_standard_calendar_event('user', $user1->id, time(), '');
 475         $this->create_test_standard_calendar_event('user', $user1->id, time(), '',
 476                 0, $course1->id);
 477         $this->create_test_standard_calendar_event('user', $user1->id, time(), '',
 478                 0, $course2->id);
 479         $this->setUser($user2);
 480         $this->create_test_standard_calendar_event('user', $user2->id, time(), '',
 481             0, $course1->id);
 482
 483         // Add a Course Calendar Events for Course 1.
 484         $this->setUser($user1);
 485         $this->create_test_standard_calendar_event('course', $user1->id, time(), '',
 486                 0, $course1->id);
 487         $this->setUser($user2);
 488         $this->create_test_standard_calendar_event('course', $user2->id, time(), '',
 489             0, $course1->id);
 490
 491         // Add a Course Assignment Action Calendar Event for Course 2.
 492         $generator = $this->getDataGenerator()->get_plugin_generator('mod_assign');
 493         $params['course'] = $course2->id;
 494         $params['assignsubmission_onlinetext_enabled'] = 1;
 495         $instance = $generator->create_instance($params);
 496         $cm = get_coursemodule_from_instance('assign', $instance->id);
 497         $modulecontext = context_module::instance($cm->id);
 498         $assign = new assign($modulecontext, $cm, $course2);
 499         $this->setUser($user2);
 500         $this->create_test_action_calendar_event('duedate', $course2->id, $instance->id,
 501                 'assign', $user2->id, time());
 502         $this->create_test_action_calendar_event('gradingduedate', $course2->id, $instance->id,
 503                 'assign', $user2->id, time());
 504
 505         // Add a Calendar Subscription and Group Calendar Event to Course 3.
 506         $this->create_test_standard_calendar_event('group', $user2->id, time(), '', 0,
 507                 $course3->id, $course3group->id);
 508         $this->setUser($user3);
 509         $this->create_test_calendar_subscription('course', 'https://calendar.google.com/', $user3->id,
 510                 0, $course3->id);
 511
 512         // The user list for usercontext1 should return user1.
 513         $userlist1 = new \core_privacy\local\request\userlist($usercontext1, $component);
 514         provider::get_users_in_context($userlist1);
 515         $this->assertCount(1, $userlist1);
 516         $this->assertTrue(in_array($user1->id, $userlist1->get_userids()));
 517         // The user list for usercontext2 should return user2.
 518         $userlist2 = new \core_privacy\local\request\userlist($usercontext2, $component);
 519         provider::get_users_in_context($userlist2);
 520         $this->assertCount(1, $userlist2);
 521         $this->assertTrue(in_array($user2->id, $userlist2->get_userids()));
 522         // The user list for course1context should return user1 and user2.
 523         $userlist3 = new \core_privacy\local\request\userlist($course1context, $component);
 524         provider::get_users_in_context($userlist3);
 525         $this->assertCount(2, $userlist3);
 526         $this->assertTrue(in_array($user1->id, $userlist3->get_userids()));
 527         $this->assertTrue(in_array($user2->id, $userlist3->get_userids()));
 528         // The user list for course2context should not return any users.
 529         $userlist4 = new \core_privacy\local\request\userlist($course2context, $component);
 530         provider::get_users_in_context($userlist4);
 531         $this->assertCount(0, $userlist4);
 532         // The user list for course3context should return user2 and user3.
 533         $userlist5 = new \core_privacy\local\request\userlist($course3context, $component);
 534         provider::get_users_in_context($userlist5);
 535         $this->assertCount(2, $userlist5);
 536         $this->assertTrue(in_array($user2->id, $userlist5->get_userids()));
 537         $this->assertTrue(in_array($user3->id, $userlist5->get_userids()));
 538         // The user list for categorycontext should return user1 and user2.
 539         $userlist6 = new \core_privacy\local\request\userlist($categorycontext, $component);
 540         provider::get_users_in_context($userlist6);
 541         $this->assertCount(2, $userlist6);
 542         $this->assertTrue(in_array($user1->id, $userlist6->get_userids()));
 543         $this->assertTrue(in_array($user2->id, $userlist6->get_userids()));
 544         // The user list for modulecontext should return user2.
 545         $userlist7 = new \core_privacy\local\request\userlist($modulecontext, $component);
 546         provider::get_users_in_context($userlist7);
 547         $this->assertCount(1, $userlist7);
 548         $this->assertTrue(in_array($user2->id, $userlist7->get_userids()));
 549         // The user list for usercontext3 should not return any users.
 550         $userlist8 = new \core_privacy\local\request\userlist($usercontext3, $component);
 551         provider::get_users_in_context($userlist8);
 552         $this->assertCount(0, $userlist8);
 553     }
 554
 555     /**
 556      * Test that data for users in approved userlist is deleted.
 557      */
 558     public function test_delete_data_for_users() {
 559         $component = 'core_calendar';
 560
 561         // Create user1 to create Calendar Events and Subscriptions.
 562         $user1 = $this->getDataGenerator()->create_user();
 563         $usercontext1 = context_user::instance($user1->id);
 564         // Create user2 to create Calendar Events and Subscriptions.
 565         $user2 = $this->getDataGenerator()->create_user();
 566         $usercontext2 = context_user::instance($user2->id);
 567         // Create user3 to create Calendar Events and Subscriptions.
 568         $user3 = $this->getDataGenerator()->create_user();
 569         $usercontext3 = context_user::instance($user3->id);
 570
 571         // Create a Category and Courses to assign Calendar Events and Subscriptions.
 572         $category = $this->getDataGenerator()->create_category();
 573         $categorycontext = context_coursecat::instance($category->id);
 574         $course1 = $this->getDataGenerator()->create_course();
 575         $course1context = context_course::instance($course1->id);
 576         $course2 = $this->getDataGenerator()->create_course();
 577         $course2context = context_course::instance($course2->id);
 578         $course3 = $this->getDataGenerator()->create_course();
 579         $course3context = context_course::instance($course3->id);
 580         $grouprecord = (object)[
 581             'courseid' => $course3->id,
 582             'name' => 'test_group'
 583         ];
 584         $course3group = $this->getDataGenerator()->create_group($grouprecord);
 585
 586         // Add Category Calendar Events for Category.
 587         $this->setUser($user1);
 588         $this->create_test_standard_calendar_event('category', $user1->id, time(), '',
 589             $category->id);
 590         $this->setUser($user2);
 591         $this->create_test_standard_calendar_event('category', $user2->id, time(), '',
 592             $category->id);
 593
 594         // Add User Calendar Events for user1 and user2.
 595         $this->setUser($user1);
 596         $this->create_test_standard_calendar_event('user', $user1->id, time(), '');
 597         $this->create_test_standard_calendar_event('user', $user1->id, time(), '',
 598             0, $course1->id);
 599         $this->create_test_standard_calendar_event('user', $user1->id, time(), '',
 600             0, $course2->id);
 601         $this->setUser($user2);
 602         $this->create_test_standard_calendar_event('user', $user2->id, time(), '',
 603             0, $course1->id);
 604
 605         // Add a Course Calendar Events for Course 1.
 606         $this->setUser($user1);
 607         $this->create_test_standard_calendar_event('course', $user1->id, time(), '',
 608             0, $course1->id);
 609         $this->setUser($user2);
 610         $this->create_test_standard_calendar_event('course', $user2->id, time(), '',
 611             0, $course1->id);
 612
 613         // Add a Course Assignment Action Calendar Event for Course 2.
 614         $generator = $this->getDataGenerator()->get_plugin_generator('mod_assign');
 615         $params['course'] = $course2->id;
 616         $params['assignsubmission_onlinetext_enabled'] = 1;
 617         $instance = $generator->create_instance($params);
 618         $cm = get_coursemodule_from_instance('assign', $instance->id);
 619         $modulecontext = context_module::instance($cm->id);
 620         $assign = new assign($modulecontext, $cm, $course2);
 621         $this->setUser($user2);
 622         $this->create_test_action_calendar_event('duedate', $course2->id, $instance->id,
 623             'assign', $user2->id, time());
 624         $this->create_test_action_calendar_event('gradingduedate', $course2->id, $instance->id,
 625             'assign', $user2->id, time());
 626
 627         // Add a Calendar Subscription and Group Calendar Event to Course 3.
 628         $this->create_test_standard_calendar_event('group', $user2->id, time(), '', 0,
 629             $course3->id, $course3group->id);
 630         $this->setUser($user3);
 631         $this->create_test_calendar_subscription('course', 'https://calendar.google.com/', $user3->id,
 632             0, $course3->id);
 633
 634         // The user list for usercontext1 should return user1.
 635         $userlist1 = new \core_privacy\local\request\userlist($usercontext1, $component);
 636         provider::get_users_in_context($userlist1);
 637         $this->assertCount(1, $userlist1);
 638         // The user list for usercontext2 should return user2.
 639         $userlist2 = new \core_privacy\local\request\userlist($usercontext2, $component);
 640         provider::get_users_in_context($userlist2);
 641         $this->assertCount(1, $userlist2);
 642         // The user list for course1context should return user1 and user2.
 643         $userlist3 = new \core_privacy\local\request\userlist($course1context, $component);
 644         provider::get_users_in_context($userlist3);
 645         $this->assertCount(2, $userlist3);
 646         // The user list for course2context should not return any users.
 647         $userlist4 = new \core_privacy\local\request\userlist($course2context, $component);
 648         provider::get_users_in_context($userlist4);
 649         $this->assertCount(0, $userlist4);
 650         // The user list for course3context should return user2 and user3.
 651         $userlist5 = new \core_privacy\local\request\userlist($course3context, $component);
 652         provider::get_users_in_context($userlist5);
 653         $this->assertCount(2, $userlist5);
 654         // The user list for categorycontext should return user1 and user2.
 655         $userlist6 = new \core_privacy\local\request\userlist($categorycontext, $component);
 656         provider::get_users_in_context($userlist6);
 657         $this->assertCount(2, $userlist6);
 658         // The user list for modulecontext should return user2.
 659         $userlist7 = new \core_privacy\local\request\userlist($modulecontext, $component);
 660         provider::get_users_in_context($userlist7);
 661         $this->assertCount(1, $userlist7);
 662         // The user list for usercontext3 should not return any users.
 663         $userlist8 = new \core_privacy\local\request\userlist($usercontext3, $component);
 664         provider::get_users_in_context($userlist8);
 665         $this->assertCount(0, $userlist8);
 666
 667         // Convert $userlist1 into an approved_contextlist.
 668         $approvedlist1 = new approved_userlist($usercontext1, $component, $userlist1->get_userids());
 669         // Delete using delete_data_for_user.
 670         provider::delete_data_for_users($approvedlist1);
 671         // The user list for usercontext1 should not return any users.
 672         $userlist1 = new \core_privacy\local\request\userlist($usercontext1, $component);
 673         provider::get_users_in_context($userlist1);
 674         $this->assertCount(0, $userlist1);
 675         // The user list for usercontext2 should still return users2.
 676         $userlist2 = new \core_privacy\local\request\userlist($usercontext2, $component);
 677         provider::get_users_in_context($userlist2);
 678         $this->assertCount(1, $userlist2);
 679
 680         // Convert $userlist3 into an approved_contextlist.
 681         // Pass an empty array as a value for the approved user list.
 682         $approvedlist2 = new approved_userlist($course1context, $component, []);
 683         // Delete using delete_data_for_user.
 684         provider::delete_data_for_users($approvedlist2);
 685         // The user list for course1context should return user1 and user2.
 686         $userlist3 = new \core_privacy\local\request\userlist($course1context, $component);
 687         provider::get_users_in_context($userlist3);
 688         $this->assertCount(2, $userlist3);
 689         $this->assertTrue(in_array($user1->id, $userlist3->get_userids()));
 690         $this->assertTrue(in_array($user2->id, $userlist3->get_userids()));
 691
 692         // Convert $userlist3 into an approved_contextlist.
 693         // Pass the ID of user1 as a value for the approved user list.
 694         $approvedlist2 = new approved_userlist($course1context, $component, [$user1->id]);
 695         // Delete using delete_data_for_user.
 696         provider::delete_data_for_users($approvedlist2);
 697         // The user list for course1context should return user2.
 698         $userlist3 = new \core_privacy\local\request\userlist($course1context, $component);
 699         provider::get_users_in_context($userlist3);
 700         $this->assertCount(1, $userlist3);
 701         $this->assertTrue(in_array($user2->id, $userlist3->get_userids()));
 702
 703         // The user list for course3context should still return user2 and user3.
 704         $userlist5 = new \core_privacy\local\request\userlist($course3context, $component);
 705         provider::get_users_in_context($userlist5);
 706         $this->assertCount(2, $userlist5);
 707
 708         // Convert $userlist6 into an approved_contextlist.
 709         $approvedlist3 = new approved_userlist($categorycontext, $component, $userlist6->get_userids());
 710         // Delete using delete_data_for_user.
 711         provider::delete_data_for_users($approvedlist3);
 712         // The user list for categorycontext should not return any users.
 713         $userlist6 = new \core_privacy\local\request\userlist($categorycontext, $component);
 714         provider::get_users_in_context($userlist6);
 715         $this->assertCount(0, $userlist6);
 716
 717         // Convert $userlist7 into an approved_contextlist.
 718         $approvedlist4 = new approved_userlist($modulecontext, $component, $userlist7->get_userids());
 719         // Delete using delete_data_for_user.
 720         provider::delete_data_for_users($approvedlist4);
 721         // The user list for modulecontext should not return any users.
 722         $userlist7 = new \core_privacy\local\request\userlist($modulecontext, $component);
 723         provider::get_users_in_context($userlist7);
 724         $this->assertCount(0, $userlist7);
 725     }
 726
 727     // Start of helper functions.
 728
 729     /**
 730      * Helper function to create a Standard Calendar Event.
 731      *
 732      * @param string    $eventtype  Calendar event type
 733      * @param int       $userid     User Id
 734      * @param int       $time       Timestamp value
 735      * @param string    $customname Custom name
 736      * @param int       $categoryid Course Category Id
 737      * @param int       $courseid   Course Id
 738      * @param int       $groupid    Group Id
 739      * @return bool|calendar_event  Standard Calendar Event created.
 740      * @throws coding_exception
 741      */
 742     protected function create_test_standard_calendar_event($eventtype, $userid, $time, $customname = '', $categoryid = 0, $courseid = 0, $groupid = 0) {
 743         // Create a standard calendar event.
 744         $name = "Standard Calendar Event $eventtype";
 745         if ($customname != '') {
 746             $name .= " -- $customname";
 747         }
 748
 749         $event = (object)[
 750             'name' => $name,
 751             'categoryid' => $categoryid,
 752             'courseid' => $courseid,
 753             'groupid' => $groupid,
 754             'userid' => $userid,
 755             'modulename' => 0,
 756             'instance' => 0,
 757             'eventtype' => $eventtype,
 758             'type' => CALENDAR_EVENT_TYPE_STANDARD,
 759             'timestart' => $time,
 760             'visible' => 1
 761         ];
 762         return calendar_event::create($event, false);
 763     }
 764
 765     /**
 766      * Helper function to create an Action Calendar Event.
 767      *
 768      * @param string    $eventtype  Calendar event type
 769      * @param int       $courseid   Course Id
 770      * @param int       $instanceid Activity Module instance id
 771      * @param string    $modulename Activity Module name
 772      * @param int       $userid     User Id
 773      * @param int       $time       Timestamp value
 774      * @return bool|calendar_event  Action Calendar Event created.
 775      * @throws coding_exception
 776      */
 777     protected function create_test_action_calendar_event($eventtype, $courseid, $instanceid, $modulename, $userid, $time) {
 778         // Create an action calendar event.
 779         $event = (object)[
 780             'name' => "Action Calendar Event $eventtype -- $modulename",
 781             'categoryid' => 0,
 782             'courseid' => $courseid,
 783             'groupid' => 0,
 784             'userid' => $userid,
 785             'modulename' => $modulename,
 786             'instance' => $instanceid,
 787             'eventtype' => $eventtype,
 788             'type' => CALENDAR_EVENT_TYPE_ACTION,
 789             'timestart' => $time,
 790             'visible' => 1
 791         ];
 792         return calendar_event::create($event, false);
 793     }
 794
 795     /**
 796      * Helper function to create a Calendar Subscription.
 797      *
 798      * @param string    $eventtype  Calendar Subscription event type
 799      * @param string    $url        Calendar Subscription URL
 800      * @param int       $userid     User Id
 801      * @param int       $categoryid Category Id
 802      * @param int       $courseid   Course Id
 803      * @param int       $groupid    Group Id
 804      * @return int  Calendar Subscription Id
 805      */
 806     protected function create_test_calendar_subscription($eventtype, $url, $userid, $categoryid = 0, $courseid = 0, $groupid = 0) {
 807         // Create a subscription calendar event.
 808         $subscription = (object)[
 809             'name' => "Calendar Subscription " . $eventtype,
 810             'url' => $url,
 811             'categoryid' => $categoryid,
 812             'courseid' => $courseid,
 813             'groupid' => $groupid,
 814             'userid' => $userid,
 815             'eventtype' => $eventtype
 816         ];
 817
 818         return calendar_add_subscription($subscription);
 819     }
 820
 821 }