[Summary view]

Differences Between: [Versions 310 and 311] [Versions 310 and 400] [Versions 310 and 401] [Versions 310 and 402] [Versions 310 and 403]

   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 user/profile/lib.php.
  19   *
  20   * @package core_user
  21   * @copyright 2014 The Open University
  22   * @licensehttp://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  defined('MOODLE_INTERNAL') || die();
  26  
  27  global $CFG;
  28  
  29  /**
  30   * Unit tests for user/profile/lib.php.
  31   *
  32   * @package core_user
  33   * @copyright 2014 The Open University
  34   * @licensehttp://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35   */
  36  class core_user_profilelib_testcase extends advanced_testcase {
  37      /**
  38       * Tests profile_get_custom_fields function and checks it is consistent
  39       * with profile_user_record.
  40       */
  41      public function test_get_custom_fields() {
  42          global $DB, $CFG;
  43          require_once($CFG->dirroot . '/user/profile/lib.php');
  44  
  45          $this->resetAfterTest();
  46          $user = $this->getDataGenerator()->create_user();
  47  
  48          // Add a custom field of textarea type.
  49          $id1 = $DB->insert_record('user_info_field', array(
  50                  'shortname' => 'frogdesc', 'name' => 'Description of frog', 'categoryid' => 1,
  51                  'datatype' => 'textarea'));
  52  
  53          // Check the field is returned.
  54          $result = profile_get_custom_fields();
  55          $this->assertArrayHasKey($id1, $result);
  56          $this->assertEquals('frogdesc', $result[$id1]->shortname);
  57  
  58          // Textarea types are not included in user data though, so if we
  59          // use the 'only in user data' parameter, there is still nothing.
  60          $this->assertArrayNotHasKey($id1, profile_get_custom_fields(true));
  61  
  62          // Check that profile_user_record returns same (no) fields.
  63          $this->assertObjectNotHasAttribute('frogdesc', profile_user_record($user->id));
  64  
  65          // Check that profile_user_record returns all the fields when requested.
  66          $this->assertObjectHasAttribute('frogdesc', profile_user_record($user->id, false));
  67  
  68          // Add another custom field, this time of normal text type.
  69          $id2 = $DB->insert_record('user_info_field', array(
  70                  'shortname' => 'frogname', 'name' => 'Name of frog', 'categoryid' => 1,
  71                  'datatype' => 'text'));
  72  
  73          // Check both are returned using normal option.
  74          $result = profile_get_custom_fields();
  75          $this->assertArrayHasKey($id2, $result);
  76          $this->assertEquals('frogname', $result[$id2]->shortname);
  77  
  78          // And check that only the one is returned the other way.
  79          $this->assertArrayHasKey($id2, profile_get_custom_fields(true));
  80  
  81          // Check profile_user_record returns same field.
  82          $this->assertObjectHasAttribute('frogname', profile_user_record($user->id));
  83  
  84          // Check that profile_user_record returns all the fields when requested.
  85          $this->assertObjectHasAttribute('frogname', profile_user_record($user->id, false));
  86      }
  87  
  88      /**
  89       * Make sure that all profile fields can be initialised without arguments.
  90       */
  91      public function test_default_constructor() {
  92          global $DB, $CFG;
  93          require_once($CFG->dirroot . '/user/profile/definelib.php');
  94          $datatypes = profile_list_datatypes();
  95          foreach ($datatypes as $datatype => $datatypename) {
  96              require_once($CFG->dirroot . '/user/profile/field/' .
  97                  $datatype . '/field.class.php');
  98              $newfield = 'profile_field_' . $datatype;
  99              $formfield = new $newfield();
 100              $this->assertNotNull($formfield);
 101          }
 102      }
 103  
 104      /**
 105       * Test profile_view function
 106       */
 107      public function test_profile_view() {
 108          global $USER;
 109  
 110          $this->resetAfterTest();
 111  
 112          // Course without sections.
 113          $course = $this->getDataGenerator()->create_course();
 114          $context = context_course::instance($course->id);
 115          $user = $this->getDataGenerator()->create_user();
 116          $usercontext = context_user::instance($user->id);
 117  
 118          $this->setUser($user);
 119  
 120          // Redirect events to the sink, so we can recover them later.
 121          $sink = $this->redirectEvents();
 122  
 123          profile_view($user, $context, $course);
 124          $events = $sink->get_events();
 125          $event = reset($events);
 126  
 127          // Check the event details are correct.
 128          $this->assertInstanceOf('\core\event\user_profile_viewed', $event);
 129          $this->assertEquals($context, $event->get_context());
 130          $this->assertEquals($user->id, $event->relateduserid);
 131          $this->assertEquals($course->id, $event->other['courseid']);
 132          $this->assertEquals($course->shortname, $event->other['courseshortname']);
 133          $this->assertEquals($course->fullname, $event->other['coursefullname']);
 134  
 135          profile_view($user, $usercontext);
 136          $events = $sink->get_events();
 137          $event = array_pop($events);
 138          $sink->close();
 139  
 140          $this->assertInstanceOf('\core\event\user_profile_viewed', $event);
 141          $this->assertEquals($usercontext, $event->get_context());
 142          $this->assertEquals($user->id, $event->relateduserid);
 143  
 144      }
 145  
 146      /**
 147       * Test that {@link user_not_fully_set_up()} takes required custom fields into account.
 148       */
 149      public function test_profile_has_required_custom_fields_set() {
 150          global $CFG, $DB;
 151          require_once($CFG->dirroot.'/mnet/lib.php');
 152  
 153          $this->resetAfterTest();
 154  
 155          // Add a required, visible, unlocked custom field.
 156          $DB->insert_record('user_info_field', ['shortname' => 'house', 'name' => 'House', 'required' => 1,
 157              'visible' => 1, 'locked' => 0, 'categoryid' => 1, 'datatype' => 'text']);
 158  
 159          // Add an optional, visible, unlocked custom field.
 160          $DB->insert_record('user_info_field', ['shortname' => 'pet', 'name' => 'Pet', 'required' => 0,
 161              'visible' => 1, 'locked' => 0, 'categoryid' => 1, 'datatype' => 'text']);
 162  
 163          // Add required but invisible custom field.
 164          $DB->insert_record('user_info_field', ['shortname' => 'secretid', 'name' => 'Secret ID', 'required' => 1,
 165              'visible' => 0, 'locked' => 0, 'categoryid' => 1, 'datatype' => 'text']);
 166  
 167          // Add required but locked custom field.
 168          $DB->insert_record('user_info_field', ['shortname' => 'muggleborn', 'name' => 'Muggle-born', 'required' => 1,
 169              'visible' => 1, 'locked' => 1, 'categoryid' => 1, 'datatype' => 'checkbox']);
 170  
 171          // Create some student accounts.
 172          $hermione = $this->getDataGenerator()->create_user();
 173          $harry = $this->getDataGenerator()->create_user();
 174          $ron = $this->getDataGenerator()->create_user();
 175          $draco = $this->getDataGenerator()->create_user();
 176  
 177          // Hermione has all available custom fields filled (of course she has).
 178          profile_save_data((object)['id' => $hermione->id, 'profile_field_house' => 'Gryffindor']);
 179          profile_save_data((object)['id' => $hermione->id, 'profile_field_pet' => 'Crookshanks']);
 180  
 181          // Harry has only the optional field filled.
 182          profile_save_data((object)['id' => $harry->id, 'profile_field_pet' => 'Hedwig']);
 183  
 184          // Draco has only the required field filled.
 185          profile_save_data((object)['id' => $draco->id, 'profile_field_house' => 'Slytherin']);
 186  
 187          // Only students with required fields filled should be considered as fully set up in the default (strict) mode.
 188          $this->assertFalse(user_not_fully_set_up($hermione));
 189          $this->assertFalse(user_not_fully_set_up($draco));
 190          $this->assertTrue(user_not_fully_set_up($harry));
 191          $this->assertTrue(user_not_fully_set_up($ron));
 192  
 193          // In the lax mode, students do not need to have required fields filled.
 194          $this->assertFalse(user_not_fully_set_up($hermione, false));
 195          $this->assertFalse(user_not_fully_set_up($draco, false));
 196          $this->assertFalse(user_not_fully_set_up($harry, false));
 197          $this->assertFalse(user_not_fully_set_up($ron, false));
 198  
 199          // Lack of required core field is seen as a problem in either mode.
 200          unset($hermione->email);
 201          $this->assertTrue(user_not_fully_set_up($hermione, true));
 202          $this->assertTrue(user_not_fully_set_up($hermione, false));
 203  
 204          // When confirming remote MNet users, we do not have custom fields available.
 205          $roamingharry = mnet_strip_user($harry, ['firstname', 'lastname', 'email']);
 206          $roaminghermione = mnet_strip_user($hermione, ['firstname', 'lastname', 'email']);
 207  
 208          $this->assertTrue(user_not_fully_set_up($roamingharry, true));
 209          $this->assertFalse(user_not_fully_set_up($roamingharry, false));
 210          $this->assertTrue(user_not_fully_set_up($roaminghermione, true));
 211          $this->assertTrue(user_not_fully_set_up($roaminghermione, false));
 212      }
 213  
 214      /**
 215       * Test that user generator sets the custom profile fields
 216       */
 217      public function test_profile_fields_in_generator() {
 218          global $CFG, $DB;
 219          require_once($CFG->dirroot.'/mnet/lib.php');
 220  
 221          $this->resetAfterTest();
 222  
 223          // Add a required, visible, unlocked custom field.
 224          $DB->insert_record('user_info_field', ['shortname' => 'house', 'name' => 'House', 'required' => 1,
 225              'visible' => 1, 'locked' => 0, 'categoryid' => 1, 'datatype' => 'text']);
 226  
 227          // Create some student accounts.
 228          $hermione = $this->getDataGenerator()->create_user(['profile_field_house' => 'Gryffindor']);
 229          $harry = $this->getDataGenerator()->create_user();
 230  
 231          // Only students with required fields filled should be considered as fully set up.
 232          $this->assertFalse(user_not_fully_set_up($hermione));
 233          $this->assertTrue(user_not_fully_set_up($harry));
 234  
 235          // Test that the profile fields were actually set.
 236          $profilefields1 = profile_user_record($hermione->id);
 237          $this->assertEquals('Gryffindor', $profilefields1->house);
 238  
 239          $profilefields2 = profile_user_record($harry->id);
 240          $this->assertObjectHasAttribute('house', $profilefields2);
 241          $this->assertNull($profilefields2->house);
 242      }
 243  }