Merge branch 'MDL-70422-310' of https://github.com/paulholden/moodle into MOODLE_310_...
[moodle.git] / search / tests / external_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/>.
17 /**
18  * External function unit tests.
19  *
20  * @package core_search
21  * @copyright 2017 The Open University
22  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace core_search;
27 defined('MOODLE_INTERNAL') || die();
29 /**
30  * External function unit tests.
31  *
32  * @package core_search
33  * @copyright 2017 The Open University
34  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
35  */
36 class external_testcase extends \advanced_testcase {
38     public function setUp(): void {
39         $this->resetAfterTest();
40     }
42     /**
43      * Checks the get_relevant_users function used when selecting users in search filter.
44      */
45     public function test_get_relevant_users() {
46         // Set up two users to search for and one to do the searching.
47         $generator = $this->getDataGenerator();
48         $student1 = $generator->create_user(['firstname' => 'Amelia', 'lastname' => 'Aardvark']);
49         $student2 = $generator->create_user(['firstname' => 'Amelia', 'lastname' => 'Beetle']);
50         $student3 = $generator->create_user(['firstname' => 'Zebedee', 'lastname' => 'Boing']);
51         $course = $generator->create_course();
52         $generator->enrol_user($student1->id, $course->id, 'student');
53         $generator->enrol_user($student2->id, $course->id, 'student');
54         $generator->enrol_user($student3->id, $course->id, 'student');
56         // As student 3, search for the other two.
57         $this->setUser($student3);
58         $result = external::get_relevant_users('Amelia', 0);
59         $this->assertCount(2, $result);
61         // Check that the result contains all the expected fields.
62         $this->assertEquals($student1->id, $result[0]->id);
63         $this->assertEquals('Amelia Aardvark', $result[0]->fullname);
64         $this->assertStringContainsString('/u/f2', $result[0]->profileimageurlsmall);
66         // Check we aren't leaking information about user email address (for instance).
67         $this->assertObjectNotHasAttribute('email', $result[0]);
69         // Note: We are not checking search permissions, search by different fields, etc. as these
70         // are covered by the core_user::search unit test.
71     }
72 }