Skip to content

Commit

Permalink
Issue moodleou#141-: fix phpunit test external\get_users not found
Browse files Browse the repository at this point in the history
  • Loading branch information
thomas.ludwig committed Jan 25, 2024
1 parent 658cc04 commit 749dece
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 24 deletions.
33 changes: 20 additions & 13 deletions classes/external/get_users.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,23 +21,30 @@
global $CFG;
require_once($CFG->libdir . '/externallib.php');

use core_external\external_api;
use core_external\external_function_parameters;
use core_external\external_value;
use core_external\external_description;
use core_external\external_multiple_structure;
use core_external\external_single_structure;

/**
* Web service used by form autocomplete to get a list of users with a given capability.
*
* @package report_customsql
* @copyright 2020 The Open University
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class get_users extends \external_api {
class get_users extends external_api {
/**
* Parameter declaration.
*
* @return \external_function_parameters Parameters
*/
public static function execute_parameters(): \external_function_parameters {
return new \external_function_parameters([
'query' => new \external_value(PARAM_RAW, 'Contents of the search box.'),
'capability' => new \external_value(PARAM_CAPABILITY, 'Return only users with this capability in the system context.'),
public static function execute_parameters(): external_function_parameters {
return new external_function_parameters([
'query' => new external_value(PARAM_RAW, 'Contents of the search box.'),
'capability' => new external_value(PARAM_CAPABILITY, 'Return only users with this capability in the system context.'),
]);
}

Expand Down Expand Up @@ -138,14 +145,14 @@ public static function prepare_result_object(\stdClass $user, array $extrafields
*
* @return \external_description Result type
*/
public static function execute_returns(): \external_description {
return new \external_multiple_structure(
new \external_single_structure([
'id' => new \external_value(PARAM_INT, 'User id.'),
'fullname' => new \external_value(PARAM_RAW, 'User full name.'),
'identity' => new \external_value(PARAM_RAW, 'Additional user identifying info.'),
'hasidentity' => new \external_value(PARAM_BOOL, 'Whether identity is non-blank.'),
'profileimageurlsmall' => new \external_value(PARAM_RAW, 'URL of the user profile image.'),
public static function execute_returns(): external_description {
return new external_multiple_structure(
new external_single_structure([
'id' => new external_value(PARAM_INT, 'User id.'),
'fullname' => new external_value(PARAM_RAW, 'User full name.'),
'identity' => new external_value(PARAM_RAW, 'Additional user identifying info.'),
'hasidentity' => new external_value(PARAM_BOOL, 'Whether identity is non-blank.'),
'profileimageurlsmall' => new external_value(PARAM_RAW, 'URL of the user profile image.'),
]));
}
}
27 changes: 16 additions & 11 deletions tests/external/external_get_users_test.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@

require_once($CFG->dirroot . '/webservice/tests/helpers.php');

use core_external\external_api;

/**
* Tests for the get_users web service.
Expand All @@ -31,6 +32,9 @@
* @category external
* @copyright 2020 The Open University
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*
* @runTestsInSeparateProcesses
*
*/
class external_get_users_test extends \externallib_advanced_testcase {

Expand All @@ -52,7 +56,7 @@ protected function setup_users(): array {

// Create some users.
$DB->update_record('user', (object)
['id' => $USER->id, 'firstname' => 'Admin', 'lastname' => 'User']);
['id' => (int) $USER->id, 'firstname' => 'Admin', 'lastname' => 'User']);
$admin = $DB->get_record('user', ['id' => $USER->id]);
$manager = $generator->create_user(
['firstname' => 'The', 'lastname' => 'Manager', 'email' => 'manager@example.com']);
Expand All @@ -68,10 +72,10 @@ protected function setup_users(): array {

public function test_get_users_site_config() {
[$admin] = $this->setup_users();
$defaultuserimage = 'https://www.example.com/moodle/theme/image.php/_s/boost/core/1/u/f2';
$defaultuserimage = 'https://www.example.com/moodle/theme/image.php/boost/core/1/u/f2';

$result = get_users::execute('', 'moodle/site:config');
$result = \external_api::clean_returnvalue(get_users::execute_returns(), $result);
$result = external_api::clean_returnvalue(get_users::execute_returns(), $result);

$this->assertEquals([
[
Expand All @@ -86,10 +90,11 @@ public function test_get_users_site_config() {

public function test_get_users_site_viewreports() {
[$admin, $manager] = $this->setup_users();
$defaultuserimage = 'https://www.example.com/moodle/theme/image.php/_s/boost/core/1/u/f2';
$defaultuserimage = 'https://www.example.com/moodle/theme/image.php/boost/core/1/u/f2';

$result = get_users::execute('', 'moodle/site:viewreports');
$result = \external_api::clean_returnvalue(get_users::execute_returns(), $result);
$result = external_api::clean_returnvalue(get_users::execute_returns(), $result);


$this->assertEquals([
[
Expand All @@ -111,10 +116,10 @@ public function test_get_users_site_viewreports() {

public function test_get_users_customsql_view() {
[$admin, $manager, $coursecreateor] = $this->setup_users();
$defaultuserimage = 'https://www.example.com/moodle/theme/image.php/_s/boost/core/1/u/f2';
$defaultuserimage = 'https://www.example.com/moodle/theme/image.php/boost/core/1/u/f2';

$result = get_users::execute('', 'report/customsql:view');
$result = \external_api::clean_returnvalue(get_users::execute_returns(), $result);
$result = external_api::clean_returnvalue(get_users::execute_returns(), $result);

$this->assertEquals([
[
Expand Down Expand Up @@ -143,10 +148,10 @@ public function test_get_users_customsql_view() {

public function test_get_users_serch_without_admins() {
[, $manager] = $this->setup_users();
$defaultuserimage = 'https://www.example.com/moodle/theme/image.php/_s/boost/core/1/u/f2';
$defaultuserimage = 'https://www.example.com/moodle/theme/image.php/boost/core/1/u/f2';

$result = get_users::execute('Man', 'report/customsql:view');
$result = \external_api::clean_returnvalue(get_users::execute_returns(), $result);
$result = external_api::clean_returnvalue(get_users::execute_returns(), $result);

$this->assertEquals([
[
Expand All @@ -161,10 +166,10 @@ public function test_get_users_serch_without_admins() {

public function test_get_users_serch_with_admin() {
[$admin] = $this->setup_users();
$defaultuserimage = 'https://www.example.com/moodle/theme/image.php/_s/boost/core/1/u/f2';
$defaultuserimage = 'https://www.example.com/moodle/theme/image.php/boost/core/1/u/f2';

$result = get_users::execute('n U', 'report/customsql:view');
$result = \external_api::clean_returnvalue(get_users::execute_returns(), $result);
$result = external_api::clean_returnvalue(get_users::execute_returns(), $result);

$this->assertEquals([
[
Expand Down

0 comments on commit 749dece

Please sign in to comment.