user/tests/search_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  * Course global search unit tests.
  19  *
  20  * @package     core
  21  * @copyright   2016 Devang Gaur {@link http://www.devanggaur.com}
  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 . '/search/tests/fixtures/testable_core_search.php');
  29
  30 /**
  31  * Provides the unit tests for course global search.
  32  *
  33  * @package     core
  34  * @copyright   2016 Devang Gaur {@link http://www.davidmonllao.com}
  35  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  36  */
  37 class user_search_testcase extends advanced_testcase {
  38
  39     /**
  40      * @var string Area id
  41      */
  42     protected $userareaid = null;
  43
  44     public function setUp() {
  45         $this->resetAfterTest(true);
  46         set_config('enableglobalsearch', true);
  47
  48         $this->userareaid = \core_search\manager::generate_areaid('core_user', 'user');
  49
  50         // Set \core_search::instance to the mock_search_engine as we don't require the search engine to be working to test this.
  51         $search = testable_core_search::instance();
  52     }
  53
  54     /**
  55      * Indexing users contents.
  56      *
  57      * @return void
  58      */
  59     public function test_users_indexing() {
  60
  61         // Returns the instance as long as the area is supported.
  62         $searcharea = \core_search\manager::get_search_area($this->userareaid);
  63         $this->assertInstanceOf('\core_user\search\user', $searcharea);
  64
  65         $user1 = self::getDataGenerator()->create_user();
  66         $user2 = self::getDataGenerator()->create_user();
  67
  68         // All records.
  69         // Recordset will produce 4 user records:
  70         // Guest User, Admin User and two above generated users.
  71         $recordset = $searcharea->get_recordset_by_timestamp(0);
  72         $this->assertTrue($recordset->valid());
  73         $nrecords = 0;
  74         foreach ($recordset as $record) {
  75             $this->assertInstanceOf('stdClass', $record);
  76             $doc = $searcharea->get_document($record);
  77             $this->assertInstanceOf('\core_search\document', $doc);
  78             $nrecords++;
  79         }
  80         // If there would be an error/failure in the foreach above the recordset would be closed on shutdown.
  81         $recordset->close();
  82         $this->assertEquals(4, $nrecords);
  83
  84         // The +2 is to prevent race conditions.
  85         $recordset = $searcharea->get_recordset_by_timestamp(time() + 2);
  86
  87         // No new records.
  88         $this->assertFalse($recordset->valid());
  89         $recordset->close();
  90     }
  91
  92     /**
  93      * Document contents.
  94      *
  95      * @return void
  96      */
  97     public function test_users_document() {
  98
  99         // Returns the instance as long as the area is supported.
 100         $searcharea = \core_search\manager::get_search_area($this->userareaid);
 101         $this->assertInstanceOf('\core_user\search\user', $searcharea);
 102
 103         $user = self::getDataGenerator()->create_user();
 104
 105         $doc = $searcharea->get_document($user);
 106         $this->assertInstanceOf('\core_search\document', $doc);
 107         $this->assertEquals($user->id, $doc->get('itemid'));
 108         $this->assertEquals($this->userareaid . '-' . $user->id, $doc->get('id'));
 109         $this->assertEquals(SITEID, $doc->get('courseid'));
 110         $this->assertFalse($doc->is_set('userid'));
 111         $this->assertEquals(\core_search\manager::NO_OWNER_ID, $doc->get('owneruserid'));
 112         $this->assertEquals(content_to_text(fullname($user), false), $doc->get('title'));
 113         $this->assertEquals(content_to_text($user->description, $user->descriptionformat), $doc->get('content'));
 114     }
 115
 116     /**
 117      * Document accesses.
 118      *
 119      * @return void
 120      */
 121     public function test_users_access() {
 122
 123         // Returns the instance as long as the area is supported.
 124         $searcharea = \core_search\manager::get_search_area($this->userareaid);
 125
 126         $user1 = self::getDataGenerator()->create_user();
 127         $user2 = self::getDataGenerator()->create_user();
 128         $user3 = self::getDataGenerator()->create_user();
 129         $user4 = self::getDataGenerator()->create_user();
 130
 131         $deleteduser = self::getDataGenerator()->create_user(array('deleted' => 1));
 132         $unconfirmeduser = self::getDataGenerator()->create_user(array('confirmed' => 0));
 133         $suspendeduser = self::getDataGenerator()->create_user(array('suspended' => 1));
 134
 135         $course1 = self::getDataGenerator()->create_course();
 136         $course2 = self::getDataGenerator()->create_course();
 137
 138         $group1 = $this->getDataGenerator()->create_group(array('courseid' => $course1->id));
 139         $group2 = $this->getDataGenerator()->create_group(array('courseid' => $course1->id));
 140
 141         $this->getDataGenerator()->enrol_user($user1->id, $course1->id, 'teacher');
 142         $this->getDataGenerator()->enrol_user($user2->id, $course1->id, 'student');
 143         $this->getDataGenerator()->enrol_user($user2->id, $course2->id, 'student');
 144         $this->getDataGenerator()->enrol_user($user3->id, $course2->id, 'student');
 145         $this->getDataGenerator()->enrol_user($user4->id, $course2->id, 'student');
 146         $this->getDataGenerator()->enrol_user($suspendeduser->id, $course1->id, 'student');
 147
 148         $this->getDataGenerator()->create_group_member(array('userid' => $user2->id, 'groupid' => $group1->id));
 149         $this->getDataGenerator()->create_group_member(array('userid' => $user3->id, 'groupid' => $group1->id));
 150         $this->getDataGenerator()->create_group_member(array('userid' => $user4->id, 'groupid' => $group2->id));
 151
 152         $this->setAdminUser();
 153         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($user1->id));
 154         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($user2->id));
 155         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($user3->id));
 156         $this->assertEquals(\core_search\manager::ACCESS_DELETED, $searcharea->check_access($deleteduser->id));
 157         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($unconfirmeduser->id));
 158         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($suspendeduser->id));
 159         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access(2));
 160
 161         $this->setUser($user1);
 162         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($user1->id));
 163         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($user2->id));
 164         $this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access($user3->id));
 165         $this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access($user4->id));
 166         $this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access(1));// Guest user can't be accessed.
 167         $this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access(2));// Admin user can't be accessed.
 168         $this->assertEquals(\core_search\manager::ACCESS_DELETED, $searcharea->check_access(-123));
 169         $this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access($unconfirmeduser->id));
 170         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($suspendeduser->id));
 171
 172         $this->setUser($user2);
 173         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($user1->id));
 174         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($user2->id));
 175         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($user3->id));
 176         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($user4->id));
 177
 178         $this->setUser($user3);
 179         $this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access($user1->id));
 180         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($user2->id));
 181         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($user3->id));
 182         $this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access($suspendeduser->id));
 183
 184         $this->setGuestUser();
 185         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($user1->id));
 186         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($user2->id));
 187         $this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($user3->id));
 188     }
 189 }