enrol/tests/externallib_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 defined('MOODLE_INTERNAL') || die();
  18
  19 global $CFG;
  20
  21 require_once($CFG->dirroot . '/webservice/tests/helpers.php');
  22 require_once($CFG->dirroot . '/enrol/externallib.php');
  23
  24 /**
  25  * Enrol external PHPunit tests
  26  *
  27  * @package    core_enrol
  28  * @category   external
  29  * @copyright  2012 Jerome Mouneyrac
  30  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  31  * @since Moodle 2.4
  32  */
  33 class core_enrol_externallib_testcase extends externallib_advanced_testcase {
  34
  35     /**
  36      * dataProvider for test_get_enrolled_users_visibility().
  37      */
  38     public function get_enrolled_users_visibility_provider() {
  39         return array(
  40             'Course without groups, default behavior (not filtering by cap, group, active)' =>
  41             array(
  42                 'settings' => array(
  43                     'coursegroupmode' => NOGROUPS,
  44                     'withcapability' => null,
  45                     'groupid' => null,
  46                     'onlyactive' => false,
  47                     'allowedcaps' => array(),
  48                 ),
  49                 'results' => array( // Everybody can view everybody.
  50                     'user0' => array('canview' => array('user0', 'user1', 'user2', 'user2su', 'user31', 'user32', 'userall')),
  51                     'user1' => array('canview' => array('user0', 'user1', 'user2', 'user2su', 'user31', 'user32', 'userall')),
  52                     'user2' => array('canview' => array('user0', 'user1', 'user2', 'user2su', 'user31', 'user32', 'userall')),
  53                     'user31' => array('canview' => array('user0', 'user1', 'user2', 'user2su', 'user31', 'user32', 'userall')),
  54                     'userall' => array('canview' => array('user0', 'user1', 'user2', 'user2su', 'user31', 'user32', 'userall')),
  55                 ),
  56             ),
  57
  58             'Course with visible groups, default behavior (not filtering by cap, group, active)' =>
  59             array(
  60                 'settings' => array(
  61                     'coursegroupmode' => VISIBLEGROUPS,
  62                     'withcapability' => null,
  63                     'groupid' => null,
  64                     'onlyactive' => false,
  65                     'allowedcaps' => array(),
  66                 ),
  67                 'results' => array( // Everybody can view everybody.
  68                     'user0' => array('canview' => array('user0', 'user1', 'user2', 'user2su', 'user31', 'user32', 'userall')),
  69                     'user1' => array('canview' => array('user0', 'user1', 'user2', 'user2su', 'user31', 'user32', 'userall')),
  70                     'user2' => array('canview' => array('user0', 'user1', 'user2', 'user2su', 'user31', 'user32', 'userall')),
  71                     'user31' => array('canview' => array('user0', 'user1', 'user2', 'user2su', 'user31', 'user32', 'userall')),
  72                     'userall' => array('canview' => array('user0', 'user1', 'user2', 'user2su', 'user31', 'user32', 'userall')),
  73                 ),
  74             ),
  75
  76             'Course with separate groups, default behavior (not filtering by cap, group, active)' =>
  77             array(
  78                 'settings' => array(
  79                     'coursegroupmode' => SEPARATEGROUPS,
  80                     'withcapability' => null,
  81                     'groupid' => null,
  82                     'onlyactive' => false,
  83                     'allowedcaps' => array(),
  84                 ),
  85                 'results' => array( // Only users from own groups are visible.
  86                     'user0' => array('canview' => array()), // Poor guy, cannot see anybody, himself included.
  87                     'user1' => array('canview' => array('user1', 'userall')),
  88                     'user2' => array('canview' => array('user2', 'user2su', 'userall')),
  89                     'user31' => array('canview' => array('user31', 'user32', 'userall')),
  90                     'userall' => array('canview' => array('user1', 'user2', 'user2su', 'user31', 'user32', 'userall')),
  91                 ),
  92             ),
  93
  94             'Course with separate groups, default behavior (not filtering but having moodle/site:accessallgroups)' =>
  95             array(
  96                 'settings' => array(
  97                     'coursegroupmode' => VISIBLEGROUPS,
  98                     'withcapability' => null,
  99                     'groupid' => null,
 100                     'onlyactive' => false,
 101                     'allowedcaps' => array('moodle/site:accessallgroups'),
 102                 ),
 103                 'results' => array( // Everybody can view everybody.
 104                     'user0' => array('canview' => array('user0', 'user1', 'user2', 'user2su', 'user31', 'user32', 'userall')),
 105                     'user1' => array('canview' => array('user0', 'user1', 'user2', 'user2su', 'user31', 'user32', 'userall')),
 106                     'user2' => array('canview' => array('user0', 'user1', 'user2', 'user2su', 'user31', 'user32', 'userall')),
 107                     'user31' => array('canview' => array('user0', 'user1', 'user2', 'user2su', 'user31', 'user32', 'userall')),
 108                     'userall' => array('canview' => array('user0', 'user1', 'user2', 'user2su', 'user31', 'user32', 'userall')),
 109                 ),
 110             ),
 111
 112             'Course with separate groups, filtering onlyactive (missing moodle/course:enrolreview)' =>
 113             array(
 114                 'settings' => array(
 115                     'coursegroupmode' => SEPARATEGROUPS,
 116                     'withcapability' => null,
 117                     'groupid' => null,
 118                     'onlyactive' => true,
 119                     'allowedcaps' => array(),
 120                 ),
 121                 'results' => array( // returns exception, cannot view anybody without the cap.
 122                     'user2' => array('exception' => array(
 123                         'type' => 'required_capability_exception',
 124                         'message' => 'Review course enrolments')),
 125                     'userall' => array('exception' => array(
 126                         'type' => 'required_capability_exception',
 127                         'message' => 'Review course enrolments')),
 128                 ),
 129             ),
 130
 131             'Course with separate groups, filtering onlyactive (having moodle/course:enrolreview)' =>
 132             array(
 133                 'settings' => array(
 134                     'coursegroupmode' => SEPARATEGROUPS,
 135                     'withcapability' => null,
 136                     'groupid' => null,
 137                     'onlyactive' => true,
 138                     'allowedcaps' => array('moodle/course:enrolreview'),
 139                 ),
 140                 'results' => array( // Suspended are not returned.
 141                     'user2' => array('canview' => array('user2', 'userall')),
 142                     'user31' => array('canview' => array('user31', 'user32', 'userall')),
 143                     'userall' => array('canview' => array('user1', 'user2', 'user31', 'user32', 'userall')),
 144                 ),
 145             ),
 146
 147             'Course with separate groups, filtering by groupid (not having moodle/site:accessallgroups)' =>
 148             array(
 149                 'settings' => array(
 150                     'coursegroupmode' => SEPARATEGROUPS,
 151                     'withcapability' => null,
 152                     'groupid' => 'group2',
 153                     'onlyactive' => false,
 154                     'allowedcaps' => array(),
 155                 ),
 156                 'results' => array( // Only group 2 members and only for members. Exception for non-members.
 157                     'user0' => array('exception' => array(
 158                         'type' => 'required_capability_exception',
 159                         'message' => 'Access all groups')),
 160                     'user1' => array('exception' => array(
 161                         'type' => 'required_capability_exception',
 162                         'message' => 'Access all groups')),
 163                     'user2' => array('canview' => array('user2', 'user2su', 'userall')),
 164                     'userall' => array('canview' => array('user2', 'user2su', 'userall')),
 165                 ),
 166             ),
 167
 168             'Course with separate groups, filtering by groupid (having moodle/site:accessallgroups)' =>
 169             array(
 170                 'settings' => array(
 171                     'coursegroupmode' => SEPARATEGROUPS,
 172                     'withcapability' => null,
 173                     'groupid' => 'group2',
 174                     'onlyactive' => false,
 175                     'allowedcaps' => array('moodle/site:accessallgroups'),
 176                 ),
 177                 'results' => array( // All users with 'moodle/site:accessallgroups' can view group 2
 178                     'user0' => array('canview' => array('user2', 'user2su', 'userall')),
 179                     'user1' => array('canview' => array('user2', 'user2su', 'userall')),
 180                     'user2' => array('canview' => array('user2', 'user2su', 'userall')),
 181                     'userall' => array('canview' => array('user2', 'user2su', 'userall')),
 182                 ),
 183             ),
 184
 185             'Course with separate groups, filtering by withcapability (not having moodle/role:review)' =>
 186             array(
 187                 'settings' => array(
 188                     'coursegroupmode' => SEPARATEGROUPS,
 189                     'withcapability' => 'moodle/course:bulkmessaging',
 190                     'groupid' => null,
 191                     'onlyactive' => false,
 192                     'allowedcaps' => array(),
 193                 ),
 194                 'results' => array( // No user has 'moodle/role:review' so exception.
 195                     'user0' => array('exception' => array(
 196                         'type' => 'required_capability_exception',
 197                         'message' => 'Review permissions for others')),
 198                     'user1' => array('exception' => array(
 199                         'type' => 'required_capability_exception',
 200                         'message' => 'Review permissions for others')),
 201                     'user2' => array('exception' => array(
 202                         'type' => 'required_capability_exception',
 203                         'message' => 'Review permissions for others')),
 204                     'userall' => array('exception' => array(
 205                         'type' => 'required_capability_exception',
 206                         'message' => 'Review permissions for others')),
 207                 ),
 208             ),
 209
 210             'Course with separate groups, filtering by withcapability (having moodle/role:review)' =>
 211             array(
 212                 'settings' => array(
 213                     'coursegroupmode' => SEPARATEGROUPS,
 214                     'withcapability' => 'moodle/course:bulkmessaging',
 215                     'groupid' => null,
 216                     'onlyactive' => false,
 217                     'allowedcaps' => array('moodle/role:review'),
 218                 ),
 219                 'results' => array( // No user has withcapability, but all have 'moodle/role:review'. Empties.
 220                     'user0' => array('canview' => array()),
 221                     'user1' => array('canview' => array()),
 222                     'user2' => array('canview' => array()),
 223                     'userall' => array('canview' => array()),
 224                 ),
 225             ),
 226
 227             'Course with separate groups, filtering by withcapability (having moodle/role:review)' =>
 228             array(
 229                 'settings' => array(
 230                     'coursegroupmode' => SEPARATEGROUPS,
 231                     'withcapability' => 'moodle/course:bulkmessaging',
 232                     'groupid' => null,
 233                     'onlyactive' => false,
 234                     'allowedcaps' => array('moodle/role:review', 'moodle/course:bulkmessaging'),
 235                 ),
 236                 'results' => array( // Users (previous) have withcapability, and all have 'moodle/role:review'.
 237                     'user0' => array('canview' => array()),
 238                     'user1' => array('canview' => array('user1')),
 239                     'user2' => array('canview' => array('user2')),
 240                     'userall' => array('canview' => array('user1', 'user2', 'userall')),
 241                 ),
 242             ),
 243         );
 244     }
 245
 246     /**
 247      * Verify get_enrolled_users() returned users are the expected in every situation.
 248      *
 249      * @dataProvider get_enrolled_users_visibility_provider
 250      */
 251     public function test_get_enrolled_users_visibility($settings, $results) {
 252
 253         global $USER;
 254
 255         $this->resetAfterTest();
 256
 257         // Create the course and the users.
 258         $course = $this->getDataGenerator()->create_course(array('groupmode' => $settings['coursegroupmode']));
 259         $coursecontext = context_course::instance($course->id);
 260         $user0 = $this->getDataGenerator()->create_user(array('username' => 'user0'));     // A user without group.
 261         $user1 = $this->getDataGenerator()->create_user(array('username' => 'user1'));     // User for group 1.
 262         $user2 = $this->getDataGenerator()->create_user(array('username' => 'user2'));     // Two users for group 2.
 263         $user2su = $this->getDataGenerator()->create_user(array('username' => 'user2su')); // (one suspended).
 264         $user31 = $this->getDataGenerator()->create_user(array('username' => 'user31'));   // Two users for group 3.
 265         $user32 = $this->getDataGenerator()->create_user(array('username' => 'user32'));   // (both enabled).
 266         $userall = $this->getDataGenerator()->create_user(array('username' => 'userall')); // A user in all groups.
 267
 268         // Create utility array of created users, to produce better assertion messages.
 269         $createdusers = array();
 270         foreach (array($user0, $user1, $user2, $user2su, $user31, $user32, $userall) as $createduser) {
 271             $createdusers[$createduser->id] = $createduser->username;
 272         }
 273
 274         // Enrol the users in the course.
 275         $this->getDataGenerator()->enrol_user($user0->id, $course->id);
 276         $this->getDataGenerator()->enrol_user($user1->id, $course->id);
 277         $this->getDataGenerator()->enrol_user($user2->id, $course->id);
 278         $this->getDataGenerator()->enrol_user($user2su->id, $course->id, null, 'manual', 0, 0, ENROL_USER_SUSPENDED);
 279         $this->getDataGenerator()->enrol_user($user31->id, $course->id);
 280         $this->getDataGenerator()->enrol_user($user32->id, $course->id);
 281         $this->getDataGenerator()->enrol_user($userall->id, $course->id);
 282
 283         // Create 3 groups.
 284         $group1 = $this->getDataGenerator()->create_group(array('courseid' => $course->id));
 285         $group2 = $this->getDataGenerator()->create_group(array('courseid' => $course->id));
 286         $group3 = $this->getDataGenerator()->create_group(array('courseid' => $course->id));
 287
 288         // Add the users to the groups.
 289         $this->getDataGenerator()->create_group_member(array('groupid' => $group1->id, 'userid' => $user1->id));
 290         $this->getDataGenerator()->create_group_member(array('groupid' => $group2->id, 'userid' => $user2->id));
 291         $this->getDataGenerator()->create_group_member(array('groupid' => $group2->id, 'userid' => $user2su->id));
 292         $this->getDataGenerator()->create_group_member(array('groupid' => $group3->id, 'userid' => $user31->id));
 293         $this->getDataGenerator()->create_group_member(array('groupid' => $group3->id, 'userid' => $user32->id));
 294         $this->getDataGenerator()->create_group_member(array('groupid' => $group1->id, 'userid' => $userall->id));
 295         $this->getDataGenerator()->create_group_member(array('groupid' => $group2->id, 'userid' => $userall->id));
 296         $this->getDataGenerator()->create_group_member(array('groupid' => $group3->id, 'userid' => $userall->id));
 297
 298         // Create a role to add the allowedcaps. Users will have this role assigned.
 299         $roleid = $this->getDataGenerator()->create_role();
 300         // Allow the specified capabilities.
 301         if (!empty($settings['allowedcaps'])) {
 302             foreach ($settings['allowedcaps'] as $capability) {
 303                 assign_capability($capability, CAP_ALLOW, $roleid, $coursecontext);
 304             }
 305         }
 306
 307         // For each of the users, configure everything, perform the call, and assert results.
 308         foreach ($results as $user => $expectations) {
 309             // Convert canview expectations into a nice array of ids for easier handling.
 310             $canview = array();
 311             $exception = null;
 312             // Analyse the expectations.
 313             if (isset($expectations['canview'])) {
 314                 foreach ($expectations['canview'] as $canviewuser) {
 315                     $canview[] = $createdusers[${$canviewuser}->id];
 316                 }
 317             } else if (isset($expectations['exception'])) {
 318                 $exception = $expectations['exception'];
 319                 $this->expectException($exception['type']);
 320                 $this->expectExceptionMessage($exception['message']);
 321             } else {
 322                 // Failed, only canview and exception are supported.
 323                 $this->markTestIncomplete('Incomplete, only canview and exception are supported');
 324             }
 325             // Switch to the user and assign the role.
 326             $this->setUser(${$user});
 327             role_assign($roleid, $USER->id, $coursecontext);
 328
 329             // Convert groupid to proper id.
 330             $groupid = 0;
 331             if (isset($settings['groupid'])) {
 332                 $groupid = ${$settings['groupid']}->id;
 333             }
 334
 335             // Call to the function.
 336             $options = array(
 337                 array('name' => 'withcapability', 'value' => $settings['withcapability']),
 338                 array('name' => 'groupid', 'value' => $groupid),
 339                 array('name' => 'onlyactive', 'value' => $settings['onlyactive']),
 340                 array('name' => 'userfields', 'value' => 'id')
 341             );
 342             $enrolledusers = core_enrol_external::get_enrolled_users($course->id, $options);
 343
 344             // We need to execute the return values cleaning process to simulate the web service server.
 345             $enrolledusers = external_api::clean_returnvalue(core_enrol_external::get_enrolled_users_returns(), $enrolledusers);
 346
 347             // We are only interested in ids to check visibility.
 348             $viewed = array();
 349             // Verify the user canview the expected users.
 350             foreach ($enrolledusers as $enrolleduser) {
 351                 $viewed[] = $createdusers[$enrolleduser['id']];
 352             }
 353             // Verify viewed matches canview expectation (using canonicalize to ignore ordering).
 354             $this->assertEquals($canview, $viewed, "Problem checking visible users for '{$createdusers[$USER->id]}'", 0, 1, true);
 355         }
 356     }
 357
 358     /**
 359      * Test get_users_courses
 360      */
 361     public function test_get_users_courses() {
 362         global $USER;
 363
 364         $this->resetAfterTest(true);
 365
 366         $timenow = time();
 367         $coursedata1 = array(
 368             'fullname'         => '<b>Course 1</b>',                // Adding tags here to check that external_format_string works.
 369             'shortname'         => '<b>Course 1</b>',               // Adding tags here to check that external_format_string works.
 370             'summary'          => 'Lightwork Course 1 description',
 371             'summaryformat'    => FORMAT_MOODLE,
 372             'lang'             => 'en',
 373             'enablecompletion' => true,
 374             'showgrades'       => true,
 375             'startdate'        => $timenow,
 376             'enddate'          => $timenow + WEEKSECS
 377         );
 378
 379         $coursedata2 = array(
 380             'lang'             => 'kk', // Check invalid language pack.
 381         );
 382
 383         $course1 = self::getDataGenerator()->create_course($coursedata1);
 384         $course2 = self::getDataGenerator()->create_course($coursedata2);
 385         $courses = array($course1, $course2);
 386
 387         // Enrol $USER in the courses.
 388         // We use the manual plugin.
 389         $roleid = null;
 390         $contexts = array();
 391         foreach ($courses as $course) {
 392             $contexts[$course->id] = context_course::instance($course->id);
 393             $roleid = $this->assignUserCapability('moodle/course:viewparticipants',
 394                     $contexts[$course->id]->id, $roleid);
 395
 396             $this->getDataGenerator()->enrol_user($USER->id, $course->id, $roleid, 'manual');
 397         }
 398
 399         // Call the external function.
 400         $enrolledincourses = core_enrol_external::get_users_courses($USER->id);
 401
 402         // We need to execute the return values cleaning process to simulate the web service server.
 403         $enrolledincourses = external_api::clean_returnvalue(core_enrol_external::get_users_courses_returns(), $enrolledincourses);
 404
 405         // Check we retrieve the good total number of enrolled users.
 406         $this->assertEquals(2, count($enrolledincourses));
 407
 408         // We need to format summary and summaryformat before to compare them with those values returned by the webservice.
 409         list($course1->summary, $course1->summaryformat) =
 410              external_format_text($course1->summary, $course1->summaryformat, $contexts[$course1->id]->id, 'course', 'summary', 0);
 411
 412         // Check there are no differences between $course1 properties and course values returned by the webservice
 413         // only for those fields listed in the $coursedata1 array.
 414         $course1->fullname = external_format_string($course1->fullname, $contexts[$course1->id]->id);
 415         $course1->shortname = external_format_string($course1->shortname, $contexts[$course1->id]->id);
 416         foreach ($enrolledincourses as $courseenrol) {
 417             if ($courseenrol['id'] == $course1->id) {
 418                 foreach ($coursedata1 as $fieldname => $value) {
 419                     $this->assertEquals($courseenrol[$fieldname], $course1->$fieldname);
 420                 }
 421             } else {
 422                 // Check language pack. Should be empty since an incorrect one was used when creating the course.
 423                 $this->assertEmpty($courseenrol['lang']);
 424             }
 425         }
 426     }
 427
 428     /**
 429      * Test get_course_enrolment_methods
 430      */
 431     public function test_get_course_enrolment_methods() {
 432         global $DB;
 433
 434         $this->resetAfterTest(true);
 435
 436         // Get enrolment plugins.
 437         $selfplugin = enrol_get_plugin('self');
 438         $this->assertNotEmpty($selfplugin);
 439         $manualplugin = enrol_get_plugin('manual');
 440         $this->assertNotEmpty($manualplugin);
 441
 442         $studentrole = $DB->get_record('role', array('shortname'=>'student'));
 443         $this->assertNotEmpty($studentrole);
 444
 445         $course1 = self::getDataGenerator()->create_course();
 446         $coursedata = new stdClass();
 447         $coursedata->visible = 0;
 448         $course2 = self::getDataGenerator()->create_course($coursedata);
 449
 450         // Add enrolment methods for course.
 451         $instanceid1 = $selfplugin->add_instance($course1, array('status' => ENROL_INSTANCE_ENABLED,
 452                                                                 'name' => 'Test instance 1',
 453                                                                 'customint6' => 1,
 454                                                                 'roleid' => $studentrole->id));
 455         $instanceid2 = $selfplugin->add_instance($course1, array('status' => ENROL_INSTANCE_DISABLED,
 456                                                                 'name' => 'Test instance 2',
 457                                                                 'roleid' => $studentrole->id));
 458
 459         $instanceid3 = $manualplugin->add_instance($course1, array('status' => ENROL_INSTANCE_ENABLED,
 460                                                                 'name' => 'Test instance 3'));
 461
 462         $enrolmentmethods = $DB->get_records('enrol', array('courseid' => $course1->id, 'status' => ENROL_INSTANCE_ENABLED));
 463         $this->assertCount(2, $enrolmentmethods);
 464
 465         $this->setAdminUser();
 466
 467         // Check if information is returned.
 468         $enrolmentmethods = core_enrol_external::get_course_enrolment_methods($course1->id);
 469         $enrolmentmethods = external_api::clean_returnvalue(core_enrol_external::get_course_enrolment_methods_returns(),
 470                                                             $enrolmentmethods);
 471         // Enrolment information is currently returned by self enrolment plugin, so count == 1.
 472         // This should be changed as we implement get_enrol_info() for other enrolment plugins.
 473         $this->assertCount(1, $enrolmentmethods);
 474
 475         $enrolmentmethod = $enrolmentmethods[0];
 476         $this->assertEquals($course1->id, $enrolmentmethod['courseid']);
 477         $this->assertEquals('self', $enrolmentmethod['type']);
 478         $this->assertTrue($enrolmentmethod['status']);
 479         $this->assertFalse(isset($enrolmentmethod['wsfunction']));
 480
 481         $instanceid4 = $selfplugin->add_instance($course2, array('status' => ENROL_INSTANCE_ENABLED,
 482                                                                 'name' => 'Test instance 4',
 483                                                                 'roleid' => $studentrole->id,
 484                                                                 'customint6' => 1,
 485                                                                 'password' => 'test'));
 486         $enrolmentmethods = core_enrol_external::get_course_enrolment_methods($course2->id);
 487         $enrolmentmethods = external_api::clean_returnvalue(core_enrol_external::get_course_enrolment_methods_returns(),
 488                                                             $enrolmentmethods);
 489         $this->assertCount(1, $enrolmentmethods);
 490
 491         $enrolmentmethod = $enrolmentmethods[0];
 492         $this->assertEquals($course2->id, $enrolmentmethod['courseid']);
 493         $this->assertEquals('self', $enrolmentmethod['type']);
 494         $this->assertTrue($enrolmentmethod['status']);
 495         $this->assertEquals('enrol_self_get_instance_info', $enrolmentmethod['wsfunction']);
 496
 497         // Try to retrieve information using a normal user for a hidden course.
 498         $user = self::getDataGenerator()->create_user();
 499         $this->setUser($user);
 500         try {
 501             core_enrol_external::get_course_enrolment_methods($course2->id);
 502         } catch (moodle_exception $e) {
 503             $this->assertEquals('coursehidden', $e->errorcode);
 504         }
 505     }
 506
 507     public function get_enrolled_users_setup($capability) {
 508         global $USER;
 509
 510         $this->resetAfterTest(true);
 511
 512         $return = new stdClass();
 513
 514         $return->course = self::getDataGenerator()->create_course();
 515         $return->user1 = self::getDataGenerator()->create_user();
 516         $return->user2 = self::getDataGenerator()->create_user();
 517         $return->user3 = self::getDataGenerator()->create_user();
 518         $this->setUser($return->user3);
 519
 520         // Set the required capabilities by the external function.
 521         $return->context = context_course::instance($return->course->id);
 522         $return->roleid = $this->assignUserCapability($capability, $return->context->id);
 523         $this->assignUserCapability('moodle/user:viewdetails', $return->context->id, $return->roleid);
 524
 525         // Enrol the users in the course.
 526         $this->getDataGenerator()->enrol_user($return->user1->id, $return->course->id, $return->roleid, 'manual');
 527         $this->getDataGenerator()->enrol_user($return->user2->id, $return->course->id, $return->roleid, 'manual');
 528         $this->getDataGenerator()->enrol_user($return->user3->id, $return->course->id, $return->roleid, 'manual');
 529
 530         return $return;
 531     }
 532
 533     /**
 534      * Test get_enrolled_users from core_enrol_external without additional
 535      * parameters.
 536      */
 537     public function test_get_enrolled_users_without_parameters() {
 538         $capability = 'moodle/course:viewparticipants';
 539         $data = $this->get_enrolled_users_setup($capability);
 540
 541         // Call the external function.
 542         $enrolledusers = core_enrol_external::get_enrolled_users($data->course->id);
 543
 544         // We need to execute the return values cleaning process to simulate the web service server.
 545         $enrolledusers = external_api::clean_returnvalue(core_enrol_external::get_enrolled_users_returns(), $enrolledusers);
 546
 547         // Check the result set.
 548         $this->assertEquals(3, count($enrolledusers));
 549         $this->assertArrayHasKey('email', $enrolledusers[0]);
 550     }
 551
 552     /**
 553      * Test get_enrolled_users from core_enrol_external with some parameters set.
 554      */
 555     public function test_get_enrolled_users_with_parameters() {
 556         $capability = 'moodle/course:viewparticipants';
 557         $data = $this->get_enrolled_users_setup($capability);
 558
 559         // Call the function with some parameters set.
 560         $enrolledusers = core_enrol_external::get_enrolled_users($data->course->id, array(
 561             array('name' => 'limitfrom', 'value' => 2),
 562             array('name' => 'limitnumber', 'value' => 1),
 563             array('name' => 'userfields', 'value' => 'id')
 564         ));
 565
 566         // We need to execute the return values cleaning process to simulate the web service server.
 567         $enrolledusers = external_api::clean_returnvalue(core_enrol_external::get_enrolled_users_returns(), $enrolledusers);
 568
 569         // Check the result set, we should only get the 3rd result, which is $user3.
 570         $this->assertCount(1, $enrolledusers);
 571         $this->assertEquals($data->user3->id, $enrolledusers[0]['id']);
 572         $this->assertArrayHasKey('id', $enrolledusers[0]);
 573         $this->assertArrayNotHasKey('email', $enrolledusers[0]);
 574     }
 575
 576     /**
 577      * Test get_enrolled_users from core_enrol_external with capability to
 578      * viewparticipants removed.
 579      *
 580      * @expectedException moodle_exception
 581      */
 582     public function test_get_enrolled_users_without_capability() {
 583         $capability = 'moodle/course:viewparticipants';
 584         $data = $this->get_enrolled_users_setup($capability);
 585
 586         // Call without required capability.
 587         $this->unassignUserCapability($capability, $data->context->id, $data->roleid);
 588         $categories = core_enrol_external::get_enrolled_users($data->course->id);
 589     }
 590
 591     public function get_enrolled_users_with_capability_setup($capability) {
 592         global $USER, $DB;
 593
 594         $this->resetAfterTest(true);
 595
 596         $return = new stdClass();
 597
 598         // Create the course and fetch its context.
 599         $return->course = self::getDataGenerator()->create_course();
 600         $context = context_course::instance($return->course->id);
 601
 602         // Create one teacher, and two students.
 603         $return->teacher = self::getDataGenerator()->create_user();
 604         $return->student1 = self::getDataGenerator()->create_user();
 605         $return->student2 = self::getDataGenerator()->create_user();
 606
 607         // Create a new student role based on the student archetype but with the capability prohibitted.
 608         $fakestudentroleid = create_role('Fake student role', 'fakestudent', 'Fake student role', 'student');
 609         assign_capability($capability, CAP_PROHIBIT, $fakestudentroleid, $context->id);
 610
 611         // Enrol all of the users in the course.
 612         // * 'teacher'  is an editing teacher.
 613         // * 'student1' is a standard student.
 614         // * 'student2' is a student with the capability prohibitted.
 615         $editingteacherroleid = $DB->get_field('role', 'id', array('shortname' => 'editingteacher'));
 616         $studentroleid = $DB->get_field('role', 'id', array('shortname' => 'student'));
 617         $this->getDataGenerator()->enrol_user($return->teacher->id, $return->course->id, $editingteacherroleid);
 618         $this->getDataGenerator()->enrol_user($return->student1->id, $return->course->id, $studentroleid);
 619         $this->getDataGenerator()->enrol_user($return->student2->id, $return->course->id, $fakestudentroleid);
 620
 621         // Log in as the teacher.
 622         $this->setUser($return->teacher);
 623
 624         // Clear caches.
 625         accesslib_clear_all_caches_for_unit_testing();
 626
 627         return $return;
 628     }
 629
 630     /**
 631      * Test get_enrolled_users_with_capability without additional paramaters.
 632      */
 633     public function test_get_enrolled_users_with_capability_without_parameters() {
 634         $capability = 'moodle/course:viewparticipants';
 635         $data = $this->get_enrolled_users_with_capability_setup($capability);
 636
 637         $result = core_enrol_external::get_enrolled_users_with_capability(
 638             array(
 639                 'coursecapabilities' => array(
 640                     'courseid' => $data->course->id,
 641                     'capabilities' => array(
 642                         $capability,
 643                     ),
 644                 ),
 645             ),
 646             array()
 647         );
 648
 649         // We need to execute the return values cleaning process to simulate the web service server.
 650         $result = external_api::clean_returnvalue(core_enrol_external::get_enrolled_users_with_capability_returns(), $result);
 651
 652         // Check an array containing the expected user for the course capability is returned.
 653         $expecteduserlist = $result[0];
 654         $this->assertEquals($data->course->id, $expecteduserlist['courseid']);
 655         $this->assertEquals($capability, $expecteduserlist['capability']);
 656         $this->assertEquals(2, count($expecteduserlist['users']));
 657     }
 658
 659     /**
 660      * Test get_enrolled_users_with_capability
 661      */
 662     public function test_get_enrolled_users_with_capability_with_parameters () {
 663         $capability = 'moodle/course:viewparticipants';
 664         $data = $this->get_enrolled_users_with_capability_setup($capability);
 665
 666         $result = core_enrol_external::get_enrolled_users_with_capability(
 667             array(
 668                 'coursecapabilities' => array(
 669                     'courseid' => $data->course->id,
 670                     'capabilities' => array(
 671                         $capability,
 672                     ),
 673                 ),
 674             ),
 675             array(
 676                 array('name' => 'limitfrom', 'value' => 1),
 677                 array('name' => 'limitnumber', 'value' => 1),
 678                 array('name' => 'userfields', 'value' => 'id')
 679             )
 680         );
 681
 682         // We need to execute the return values cleaning process to simulate the web service server.
 683         $result = external_api::clean_returnvalue(core_enrol_external::get_enrolled_users_with_capability_returns(), $result);
 684
 685         // Check an array containing the expected user for the course capability is returned.
 686         $expecteduserlist = $result[0]['users'];
 687         $expecteduser = reset($expecteduserlist);
 688         $this->assertEquals(1, count($expecteduserlist));
 689         $this->assertEquals($data->student1->id, $expecteduser['id']);
 690     }
 691
 692     /**
 693      * Test for core_enrol_external::edit_user_enrolment().
 694      */
 695     public function test_edit_user_enrolment() {
 696         global $DB;
 697
 698         $this->resetAfterTest(true);
 699         $datagen = $this->getDataGenerator();
 700
 701         /** @var enrol_manual_plugin $manualplugin */
 702         $manualplugin = enrol_get_plugin('manual');
 703         $this->assertNotNull($manualplugin);
 704
 705         $studentroleid = $DB->get_field('role', 'id', ['shortname' => 'student'], MUST_EXIST);
 706         $teacherroleid = $DB->get_field('role', 'id', ['shortname' => 'editingteacher'], MUST_EXIST);
 707         $course = $datagen->create_course();
 708         $user = $datagen->create_user();
 709         $teacher = $datagen->create_user();
 710
 711         $instanceid = null;
 712         $instances = enrol_get_instances($course->id, true);
 713         foreach ($instances as $inst) {
 714             if ($inst->enrol == 'manual') {
 715                 $instanceid = (int)$inst->id;
 716                 break;
 717             }
 718         }
 719         if (empty($instanceid)) {
 720             $instanceid = $manualplugin->add_default_instance($course);
 721             if (empty($instanceid)) {
 722                 $instanceid = $manualplugin->add_instance($course);
 723             }
 724         }
 725         $this->assertNotNull($instanceid);
 726
 727         $instance = $DB->get_record('enrol', ['id' => $instanceid], '*', MUST_EXIST);
 728         $manualplugin->enrol_user($instance, $user->id, $studentroleid, 0, 0, ENROL_USER_ACTIVE);
 729         $manualplugin->enrol_user($instance, $teacher->id, $teacherroleid, 0, 0, ENROL_USER_ACTIVE);
 730         $ueid = (int)$DB->get_field(
 731             'user_enrolments',
 732             'id',
 733             ['enrolid' => $instance->id, 'userid' => $user->id],
 734             MUST_EXIST
 735         );
 736
 737         // Login as teacher.
 738         $this->setUser($teacher);
 739
 740         $now = new DateTime();
 741         $nowtime = $now->getTimestamp();
 742
 743         // Invalid data.
 744         $data = core_enrol_external::edit_user_enrolment($course->id, $ueid, ENROL_USER_ACTIVE, $nowtime, $nowtime);
 745         $data = external_api::clean_returnvalue(core_enrol_external::edit_user_enrolment_returns(), $data);
 746         $this->assertFalse($data['result']);
 747         $this->assertNotEmpty($data['errors']);
 748
 749         // Valid data.
 750         $nextmonth = clone($now);
 751         $nextmonth->add(new DateInterval('P1M'));
 752         $nextmonthtime = $nextmonth->getTimestamp();
 753         $data = core_enrol_external::edit_user_enrolment($course->id, $ueid, ENROL_USER_ACTIVE, $nowtime, $nextmonthtime);
 754         $data = external_api::clean_returnvalue(core_enrol_external::edit_user_enrolment_returns(), $data);
 755         $this->assertTrue($data['result']);
 756         $this->assertEmpty($data['errors']);
 757
 758         // Check updated user enrolment.
 759         $ue = $DB->get_record('user_enrolments', ['id' => $ueid], '*', MUST_EXIST);
 760         $this->assertEquals(ENROL_USER_ACTIVE, $ue->status);
 761         $this->assertEquals($nowtime, $ue->timestart);
 762         $this->assertEquals($nextmonthtime, $ue->timeend);
 763
 764         // Suspend user.
 765         $data = core_enrol_external::edit_user_enrolment($course->id, $ueid, ENROL_USER_SUSPENDED);
 766         $data = external_api::clean_returnvalue(core_enrol_external::edit_user_enrolment_returns(), $data);
 767         $this->assertTrue($data['result']);
 768         $this->assertEmpty($data['errors']);
 769
 770         // Check updated user enrolment.
 771         $ue = $DB->get_record('user_enrolments', ['id' => $ueid], '*', MUST_EXIST);
 772         $this->assertEquals(ENROL_USER_SUSPENDED, $ue->status);
 773     }
 774
 775     /**
 776      * Test for core_enrol_external::unenrol_user_enrolment().
 777      */
 778     public function test_unenerol_user_enrolment() {
 779         global $DB;
 780
 781         $this->resetAfterTest(true);
 782         $datagen = $this->getDataGenerator();
 783
 784         /** @var enrol_manual_plugin $manualplugin */
 785         $manualplugin = enrol_get_plugin('manual');
 786         $this->assertNotNull($manualplugin);
 787
 788         $studentroleid = $DB->get_field('role', 'id', ['shortname' => 'student'], MUST_EXIST);
 789         $teacherroleid = $DB->get_field('role', 'id', ['shortname' => 'editingteacher'], MUST_EXIST);
 790         $course = $datagen->create_course();
 791         $user = $datagen->create_user();
 792         $teacher = $datagen->create_user();
 793
 794         $instanceid = null;
 795         $instances = enrol_get_instances($course->id, true);
 796         foreach ($instances as $inst) {
 797             if ($inst->enrol == 'manual') {
 798                 $instanceid = (int)$inst->id;
 799                 break;
 800             }
 801         }
 802         if (empty($instanceid)) {
 803             $instanceid = $manualplugin->add_default_instance($course);
 804             if (empty($instanceid)) {
 805                 $instanceid = $manualplugin->add_instance($course);
 806             }
 807         }
 808         $this->assertNotNull($instanceid);
 809
 810         $instance = $DB->get_record('enrol', ['id' => $instanceid], '*', MUST_EXIST);
 811         $manualplugin->enrol_user($instance, $user->id, $studentroleid, 0, 0, ENROL_USER_ACTIVE);
 812         $manualplugin->enrol_user($instance, $teacher->id, $teacherroleid, 0, 0, ENROL_USER_ACTIVE);
 813         $ueid = (int)$DB->get_field(
 814             'user_enrolments',
 815             'id',
 816             ['enrolid' => $instance->id, 'userid' => $user->id],
 817             MUST_EXIST
 818         );
 819
 820         // Login as teacher.
 821         $this->setUser($teacher);
 822
 823         // Invalid data by passing invalid ueid.
 824         $data = core_enrol_external::unenrol_user_enrolment(101010);
 825         $data = external_api::clean_returnvalue(core_enrol_external::unenrol_user_enrolment_returns(), $data);
 826         $this->assertFalse($data['result']);
 827         $this->assertNotEmpty($data['errors']);
 828
 829         // Valid data.
 830         $data = core_enrol_external::unenrol_user_enrolment($ueid);
 831         $data = external_api::clean_returnvalue(core_enrol_external::unenrol_user_enrolment_returns(), $data);
 832         $this->assertTrue($data['result']);
 833         $this->assertEmpty($data['errors']);
 834
 835         // Check unenrol user enrolment.
 836         $ue = $DB->count_records('user_enrolments', ['id' => $ueid]);
 837         $this->assertEquals(0, $ue);
 838     }
 839 }