group/tests/lib_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  * Unit tests for group lib.
  19  *
  20  * @package    core_group
  21  * @copyright  2013 Frédéric Massart
  22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23  */
  24
  25 defined('MOODLE_INTERNAL') || die();
  26
  27 global $CFG;
  28 require_once($CFG->dirroot . '/group/lib.php');
  29
  30 /**
  31  * Group lib testcase.
  32  *
  33  * @package    core_group
  34  * @copyright  2013 Frédéric Massart
  35  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  36  */
  37 class core_group_lib_testcase extends advanced_testcase {
  38
  39     public function test_member_added_event() {
  40         $this->resetAfterTest();
  41
  42         $this->setAdminUser();
  43         $course = $this->getDataGenerator()->create_course();
  44         $user = $this->getDataGenerator()->create_user();
  45         $group = $this->getDataGenerator()->create_group(array('courseid' => $course->id));
  46         $this->getDataGenerator()->enrol_user($user->id, $course->id);
  47
  48         $sink = $this->redirectEvents();
  49         groups_add_member($group->id, $user->id, 'mod_workshop', '123');
  50         $events = $sink->get_events();
  51         $this->assertCount(1, $events);
  52         $event = reset($events);
  53
  54         $expected = new stdClass();
  55         $expected->groupid = $group->id;
  56         $expected->userid  = $user->id;
  57         $expected->component = 'mod_workshop';
  58         $expected->itemid = '123';
  59         $this->assertEventLegacyData($expected, $event);
  60         $this->assertSame('groups_member_added', $event->get_legacy_eventname());
  61         $this->assertInstanceOf('\core\event\group_member_added', $event);
  62         $this->assertEquals($user->id, $event->relateduserid);
  63         $this->assertEquals(context_course::instance($course->id), $event->get_context());
  64         $this->assertEquals($group->id, $event->objectid);
  65     }
  66
  67     public function test_member_removed_event() {
  68         $this->resetAfterTest();
  69
  70         $this->setAdminUser();
  71         $course = $this->getDataGenerator()->create_course();
  72         $user = $this->getDataGenerator()->create_user();
  73         $group = $this->getDataGenerator()->create_group(array('courseid' => $course->id));
  74         $this->getDataGenerator()->enrol_user($user->id, $course->id);
  75         $this->getDataGenerator()->create_group_member(array('userid' => $user->id, 'groupid' => $group->id));
  76
  77         $sink = $this->redirectEvents();
  78         groups_remove_member($group->id, $user->id);
  79         $events = $sink->get_events();
  80         $this->assertCount(1, $events);
  81         $event = reset($events);
  82
  83         $expected = new stdClass();
  84         $expected->groupid = $group->id;
  85         $expected->userid  = $user->id;
  86         $this->assertEventLegacyData($expected, $event);
  87         $this->assertSame('groups_member_removed', $event->get_legacy_eventname());
  88         $this->assertInstanceOf('\core\event\group_member_removed', $event);
  89         $this->assertEquals($user->id, $event->relateduserid);
  90         $this->assertEquals(context_course::instance($course->id), $event->get_context());
  91         $this->assertEquals($group->id, $event->objectid);
  92     }
  93
  94     public function test_group_created_event() {
  95         $this->resetAfterTest();
  96
  97         $this->setAdminUser();
  98         $course = $this->getDataGenerator()->create_course();
  99
 100         $sink = $this->redirectEvents();
 101         $group = $this->getDataGenerator()->create_group(array('courseid' => $course->id));
 102         $events = $sink->get_events();
 103         $this->assertCount(1, $events);
 104         $event = reset($events);
 105
 106         $this->assertInstanceOf('\core\event\group_created', $event);
 107         $this->assertEventLegacyData($group, $event);
 108         $this->assertSame('groups_group_created', $event->get_legacy_eventname());
 109         $this->assertEquals(context_course::instance($course->id), $event->get_context());
 110         $this->assertEquals($group->id, $event->objectid);
 111     }
 112
 113     public function test_grouping_created_event() {
 114         $this->resetAfterTest();
 115
 116         $this->setAdminUser();
 117         $course = $this->getDataGenerator()->create_course();
 118
 119         $sink = $this->redirectEvents();
 120         $group = $this->getDataGenerator()->create_grouping(array('courseid' => $course->id));
 121         $events = $sink->get_events();
 122         $this->assertCount(1, $events);
 123         $event = reset($events);
 124
 125         $this->assertInstanceOf('\core\event\grouping_created', $event);
 126
 127         // 'Repairing' the object for comparison because of type of variables being wrong.
 128         $group->id = (int) $group->id;
 129         $group->timemodified = (int) $group->timemodified;
 130         $group->timecreated = (int) $group->timecreated;
 131         unset($group->idnumber);
 132         unset($group->configdata);
 133         $this->assertEventLegacyData($group, $event);
 134         $this->assertSame('groups_grouping_created', $event->get_legacy_eventname());
 135
 136         $this->assertEquals(context_course::instance($course->id), $event->get_context());
 137         $this->assertEquals($group->id, $event->objectid);
 138     }
 139
 140     public function test_group_updated_event() {
 141         $this->resetAfterTest();
 142
 143         $course = $this->getDataGenerator()->create_course();
 144         $group = $this->getDataGenerator()->create_group(array('courseid' => $course->id));
 145
 146         $sink = $this->redirectEvents();
 147         $data = new stdClass();
 148         $data->id = $group->id;
 149         $data->courseid = $course->id;
 150         $data->name = 'Backend team';
 151         groups_update_group($data);
 152         $events = $sink->get_events();
 153         $this->assertCount(1, $events);
 154         $event = reset($events);
 155
 156         $this->assertInstanceOf('\core\event\group_updated', $event);
 157         $group->name = $data->name;
 158         $this->assertEventLegacyData($group, $event);
 159         $this->assertSame('groups_group_updated', $event->get_legacy_eventname());
 160         $this->assertEquals(context_course::instance($course->id), $event->get_context());
 161         $this->assertEquals($group->id, $event->objectid);
 162     }
 163
 164     public function test_grouping_updated_event() {
 165         $this->resetAfterTest();
 166
 167         $course = $this->getDataGenerator()->create_course();
 168         $group = $this->getDataGenerator()->create_grouping(array('courseid' => $course->id));
 169
 170         $sink = $this->redirectEvents();
 171         $data = new stdClass();
 172         $data->id = $group->id;
 173         $data->courseid = $course->id;
 174         $data->name = 'Backend team';
 175         $mostaccuratetimemodified = time();
 176         groups_update_grouping($data);
 177         $events = $sink->get_events();
 178         $this->assertCount(1, $events);
 179         $event = reset($events);
 180
 181         $this->assertInstanceOf('\core\event\grouping_updated', $event);
 182
 183         // 'Repairing' the object for comparison because of type of variables being wrong.
 184         $data->id = (int) $group->id;
 185         $data->timemodified = $mostaccuratetimemodified;
 186         $this->assertEventLegacyData($data, $event);
 187         $this->assertSame('groups_grouping_updated', $event->get_legacy_eventname());
 188
 189         $this->assertEquals(context_course::instance($course->id), $event->get_context());
 190         $this->assertEquals($group->id, $event->objectid);
 191     }
 192
 193     public function test_group_deleted_event() {
 194         $this->resetAfterTest();
 195
 196         $course = $this->getDataGenerator()->create_course();
 197         $group = $this->getDataGenerator()->create_group(array('courseid' => $course->id));
 198
 199         $sink = $this->redirectEvents();
 200         groups_delete_group($group->id);
 201         $events = $sink->get_events();
 202         $this->assertCount(1, $events);
 203         $event = reset($events);
 204
 205         $this->assertInstanceOf('\core\event\group_deleted', $event);
 206         $this->assertEventLegacyData($group, $event);
 207         $this->assertSame('groups_group_deleted', $event->get_legacy_eventname());
 208         $this->assertEquals(context_course::instance($course->id), $event->get_context());
 209         $this->assertEquals($group->id, $event->objectid);
 210     }
 211
 212     public function test_grouping_deleted_event() {
 213         $this->resetAfterTest();
 214
 215         $course = $this->getDataGenerator()->create_course();
 216         $group = $this->getDataGenerator()->create_grouping(array('courseid' => $course->id));
 217
 218         $sink = $this->redirectEvents();
 219         groups_delete_grouping($group->id);
 220         $events = $sink->get_events();
 221         $this->assertCount(1, $events);
 222         $event = reset($events);
 223
 224         $this->assertInstanceOf('\core\event\grouping_deleted', $event);
 225         $this->assertEventLegacyData($group, $event);
 226         $this->assertSame('groups_grouping_deleted', $event->get_legacy_eventname());
 227         $this->assertEquals(context_course::instance($course->id), $event->get_context());
 228         $this->assertEquals($group->id, $event->objectid);
 229     }
 230
 231     public function test_groups_delete_group_members() {
 232         global $DB;
 233         $this->resetAfterTest();
 234
 235         $course = $this->getDataGenerator()->create_course();
 236         $user1 = $this->getDataGenerator()->create_user();
 237         $user2 = $this->getDataGenerator()->create_user();
 238         $this->getDataGenerator()->enrol_user($user1->id, $course->id);
 239         $this->getDataGenerator()->enrol_user($user2->id, $course->id);
 240         $group1 = $this->getDataGenerator()->create_group(array('courseid' => $course->id));
 241         $group2 = $this->getDataGenerator()->create_group(array('courseid' => $course->id));
 242
 243         // Test deletion of all the users.
 244         $this->getDataGenerator()->create_group_member(array('groupid' => $group1->id, 'userid' => $user1->id));
 245         $this->getDataGenerator()->create_group_member(array('groupid' => $group2->id, 'userid' => $user1->id));
 246         $this->getDataGenerator()->create_group_member(array('groupid' => $group1->id, 'userid' => $user2->id));
 247
 248         $this->assertTrue($DB->record_exists('groups_members', array('groupid' => $group1->id, 'userid' => $user1->id)));
 249         $this->assertTrue($DB->record_exists('groups_members', array('groupid' => $group2->id, 'userid' => $user1->id)));
 250         $this->assertTrue($DB->record_exists('groups_members', array('groupid' => $group1->id, 'userid' => $user2->id)));
 251         groups_delete_group_members($course->id);
 252         $this->assertFalse($DB->record_exists('groups_members', array('groupid' => $group1->id, 'userid' => $user1->id)));
 253         $this->assertFalse($DB->record_exists('groups_members', array('groupid' => $group2->id, 'userid' => $user1->id)));
 254         $this->assertFalse($DB->record_exists('groups_members', array('groupid' => $group1->id, 'userid' => $user2->id)));
 255
 256         // Test deletion of a specific user.
 257         $this->getDataGenerator()->create_group_member(array('groupid' => $group1->id, 'userid' => $user1->id));
 258         $this->getDataGenerator()->create_group_member(array('groupid' => $group2->id, 'userid' => $user1->id));
 259         $this->getDataGenerator()->create_group_member(array('groupid' => $group1->id, 'userid' => $user2->id));
 260
 261         $this->assertTrue($DB->record_exists('groups_members', array('groupid' => $group1->id, 'userid' => $user1->id)));
 262         $this->assertTrue($DB->record_exists('groups_members', array('groupid' => $group2->id, 'userid' => $user1->id)));
 263         $this->assertTrue($DB->record_exists('groups_members', array('groupid' => $group1->id, 'userid' => $user2->id)));
 264         groups_delete_group_members($course->id, $user2->id);
 265         $this->assertTrue($DB->record_exists('groups_members', array('groupid' => $group1->id, 'userid' => $user1->id)));
 266         $this->assertTrue($DB->record_exists('groups_members', array('groupid' => $group2->id, 'userid' => $user1->id)));
 267         $this->assertFalse($DB->record_exists('groups_members', array('groupid' => $group1->id, 'userid' => $user2->id)));
 268     }
 269
 270     public function test_groups_remove_member() {
 271         global $DB;
 272         $this->resetAfterTest();
 273
 274         $course = $this->getDataGenerator()->create_course();
 275         $user1 = $this->getDataGenerator()->create_user();
 276         $user2 = $this->getDataGenerator()->create_user();
 277         $this->getDataGenerator()->enrol_user($user1->id, $course->id);
 278         $this->getDataGenerator()->enrol_user($user2->id, $course->id);
 279         $group1 = $this->getDataGenerator()->create_group(array('courseid' => $course->id));
 280         $group2 = $this->getDataGenerator()->create_group(array('courseid' => $course->id));
 281
 282         $this->getDataGenerator()->create_group_member(array('groupid' => $group1->id, 'userid' => $user1->id));
 283         $this->getDataGenerator()->create_group_member(array('groupid' => $group2->id, 'userid' => $user1->id));
 284         $this->getDataGenerator()->create_group_member(array('groupid' => $group1->id, 'userid' => $user2->id));
 285
 286         $this->assertTrue($DB->record_exists('groups_members', array('groupid' => $group1->id, 'userid' => $user1->id)));
 287         $this->assertTrue($DB->record_exists('groups_members', array('groupid' => $group2->id, 'userid' => $user1->id)));
 288         $this->assertTrue($DB->record_exists('groups_members', array('groupid' => $group1->id, 'userid' => $user2->id)));
 289         groups_remove_member($group1->id, $user1->id);
 290         $this->assertFalse($DB->record_exists('groups_members', array('groupid' => $group1->id, 'userid' => $user1->id)));
 291         $this->assertTrue($DB->record_exists('groups_members', array('groupid' => $group2->id, 'userid' => $user1->id)));
 292         $this->assertTrue($DB->record_exists('groups_members', array('groupid' => $group1->id, 'userid' => $user2->id)));
 293         groups_remove_member($group1->id, $user2->id);
 294         $this->assertTrue($DB->record_exists('groups_members', array('groupid' => $group2->id, 'userid' => $user1->id)));
 295         $this->assertFalse($DB->record_exists('groups_members', array('groupid' => $group1->id, 'userid' => $user2->id)));
 296         groups_remove_member($group2->id, $user1->id);
 297         $this->assertFalse($DB->record_exists('groups_members', array('groupid' => $group2->id, 'userid' => $user1->id)));
 298     }
 299
 300     public function test_groups_delete_groupings_groups() {
 301         global $DB;
 302         $this->resetAfterTest();
 303
 304         $course = $this->getDataGenerator()->create_course();
 305         $course2 = $this->getDataGenerator()->create_course();
 306         $group1 = $this->getDataGenerator()->create_group(array('courseid' => $course->id));
 307         $group2 = $this->getDataGenerator()->create_group(array('courseid' => $course->id));
 308         $group1c2 = $this->getDataGenerator()->create_group(array('courseid' => $course2->id));
 309         $grouping1 = $this->getDataGenerator()->create_grouping(array('courseid' => $course->id));
 310         $grouping2 = $this->getDataGenerator()->create_grouping(array('courseid' => $course->id));
 311         $grouping1c2 = $this->getDataGenerator()->create_grouping(array('courseid' => $course2->id));
 312
 313         $this->getDataGenerator()->create_grouping_group(array('groupingid' => $grouping1->id, 'groupid' => $group1->id));
 314         $this->getDataGenerator()->create_grouping_group(array('groupingid' => $grouping1->id, 'groupid' => $group2->id));
 315         $this->getDataGenerator()->create_grouping_group(array('groupingid' => $grouping2->id, 'groupid' => $group1->id));
 316         $this->getDataGenerator()->create_grouping_group(array('groupingid' => $grouping1c2->id, 'groupid' => $group1c2->id));
 317         $this->assertTrue($DB->record_exists('groupings_groups', array('groupid' => $group1->id, 'groupingid' => $grouping1->id)));
 318         $this->assertTrue($DB->record_exists('groupings_groups', array('groupid' => $group2->id, 'groupingid' => $grouping1->id)));
 319         $this->assertTrue($DB->record_exists('groupings_groups', array('groupid' => $group1->id, 'groupingid' => $grouping2->id)));
 320         $this->assertTrue($DB->record_exists('groupings_groups',
 321             array('groupid' => $group1c2->id, 'groupingid' => $grouping1c2->id)));
 322         groups_delete_groupings_groups($course->id);
 323         $this->assertFalse($DB->record_exists('groupings_groups', array('groupid' => $group1->id, 'groupingid' => $grouping1->id)));
 324         $this->assertFalse($DB->record_exists('groupings_groups', array('groupid' => $group2->id, 'groupingid' => $grouping1->id)));
 325         $this->assertFalse($DB->record_exists('groupings_groups', array('groupid' => $group1->id, 'groupingid' => $grouping2->id)));
 326         $this->assertTrue($DB->record_exists('groupings_groups',
 327             array('groupid' => $group1c2->id, 'groupingid' => $grouping1c2->id)));
 328     }
 329
 330     public function test_groups_delete_groups() {
 331         global $DB;
 332         $this->resetAfterTest();
 333
 334         $course = $this->getDataGenerator()->create_course();
 335         $course2 = $this->getDataGenerator()->create_course();
 336         $group1 = $this->getDataGenerator()->create_group(array('courseid' => $course->id));
 337         $group2 = $this->getDataGenerator()->create_group(array('courseid' => $course->id));
 338         $group1c2 = $this->getDataGenerator()->create_group(array('courseid' => $course2->id));
 339         $grouping1 = $this->getDataGenerator()->create_grouping(array('courseid' => $course->id));
 340         $grouping2 = $this->getDataGenerator()->create_grouping(array('courseid' => $course->id));
 341         $user1 = $this->getDataGenerator()->create_user();
 342         $this->getDataGenerator()->enrol_user($user1->id, $course->id);
 343         $this->getDataGenerator()->create_group_member(array('groupid' => $group1->id, 'userid' => $user1->id));
 344         $this->getDataGenerator()->create_grouping_group(array('groupid' => $group1->id, 'groupingid' => $grouping1->id));
 345
 346         $this->assertTrue($DB->record_exists('groups', array('id' => $group1->id, 'courseid' => $course->id)));
 347         $this->assertTrue($DB->record_exists('groups', array('id' => $group2->id, 'courseid' => $course->id)));
 348         $this->assertTrue($DB->record_exists('groups', array('id' => $group1c2->id, 'courseid' => $course2->id)));
 349         $this->assertTrue($DB->record_exists('groups_members', array('groupid' => $group1->id, 'userid' => $user1->id)));
 350         $this->assertTrue($DB->record_exists('groupings', array('id' => $grouping1->id, 'courseid' => $course->id)));
 351         $this->assertTrue($DB->record_exists('groupings_groups', array('groupid' => $group1->id, 'groupingid' => $grouping1->id)));
 352         groups_delete_groups($course->id);
 353         $this->assertFalse($DB->record_exists('groups', array('id' => $group1->id, 'courseid' => $course->id)));
 354         $this->assertFalse($DB->record_exists('groups', array('id' => $group2->id, 'courseid' => $course->id)));
 355         $this->assertTrue($DB->record_exists('groups', array('id' => $group1c2->id, 'courseid' => $course2->id)));
 356         $this->assertFalse($DB->record_exists('groups_members', array('groupid' => $group1->id, 'userid' => $user1->id)));
 357         $this->assertTrue($DB->record_exists('groupings', array('id' => $grouping1->id, 'courseid' => $course->id)));
 358         $this->assertFalse($DB->record_exists('groupings_groups', array('groupid' => $group1->id, 'groupingid' => $grouping1->id)));
 359     }
 360
 361     public function test_groups_delete_groupings() {
 362         global $DB;
 363         $this->resetAfterTest();
 364
 365         $course = $this->getDataGenerator()->create_course();
 366         $course2 = $this->getDataGenerator()->create_course();
 367         $group1 = $this->getDataGenerator()->create_group(array('courseid' => $course->id));
 368         $grouping1 = $this->getDataGenerator()->create_grouping(array('courseid' => $course->id));
 369         $grouping2 = $this->getDataGenerator()->create_grouping(array('courseid' => $course->id));
 370         $grouping1c2 = $this->getDataGenerator()->create_grouping(array('courseid' => $course2->id));
 371         $this->getDataGenerator()->create_grouping_group(array('groupid' => $group1->id, 'groupingid' => $grouping1->id));
 372
 373         $this->assertTrue($DB->record_exists('groups', array('id' => $group1->id, 'courseid' => $course->id)));
 374         $this->assertTrue($DB->record_exists('groupings', array('id' => $grouping1->id, 'courseid' => $course->id)));
 375         $this->assertTrue($DB->record_exists('groupings', array('id' => $grouping2->id, 'courseid' => $course->id)));
 376         $this->assertTrue($DB->record_exists('groupings', array('id' => $grouping1c2->id, 'courseid' => $course2->id)));
 377         $this->assertTrue($DB->record_exists('groupings_groups', array('groupid' => $group1->id, 'groupingid' => $grouping1->id)));
 378         groups_delete_groupings($course->id);
 379         $this->assertTrue($DB->record_exists('groups', array('id' => $group1->id, 'courseid' => $course->id)));
 380         $this->assertFalse($DB->record_exists('groupings', array('id' => $grouping1->id, 'courseid' => $course->id)));
 381         $this->assertFalse($DB->record_exists('groupings', array('id' => $grouping2->id, 'courseid' => $course->id)));
 382         $this->assertTrue($DB->record_exists('groupings', array('id' => $grouping1c2->id, 'courseid' => $course2->id)));
 383         $this->assertFalse($DB->record_exists('groupings_groups', array('groupid' => $group1->id, 'groupingid' => $grouping1->id)));
 384     }
 385 }