MDL-59214 webservice: Return calendar type in get_site_info
[moodle.git] / webservice / tests / externallib_test.php
CommitLineData
639bc8b2
PC
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
17defined('MOODLE_INTERNAL') || die();
18
19global $CFG;
498bc10c 20require_once($CFG->dirroot . '/webservice/externallib.php');
639bc8b2
PC
21require_once($CFG->dirroot . '/webservice/tests/helpers.php');
22
23/**
24 * External course functions unit tests
25 *
26 * @package core_webservice
27 * @category external
28 * @copyright 2012 Paul Charsley
29 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
30 */
8252b7c2 31class core_webservice_externallib_testcase extends externallib_advanced_testcase {
639bc8b2 32
498bc10c
EL
33 public function setUp() {
34 // Calling parent is good, always
35 parent::setUp();
36
37 // We always need enabled WS for this testcase
639bc8b2 38 set_config('enablewebservices', '1');
639bc8b2
PC
39 }
40
41 public function test_get_site_info() {
42 global $DB, $USER, $CFG;
43
44 $this->resetAfterTest(true);
498bc10c 45
116c4a62
JL
46 $maxbytes = 10485760;
47 $userquota = 5242880;
48 set_config('maxbytes', $maxbytes);
49 set_config('userquota', $userquota);
50
498bc10c 51 // Set current user
639bc8b2
PC
52 $user = array();
53 $user['username'] = 'johnd';
54 $user['firstname'] = 'John';
55 $user['lastname'] = 'Doe';
56 self::setUser(self::getDataGenerator()->create_user($user));
57
58 // Add a web service and token.
59 $webservice = new stdClass();
60 $webservice->name = 'Test web service';
61 $webservice->enabled = true;
62 $webservice->restrictedusers = false;
63 $webservice->component = 'moodle';
64 $webservice->timecreated = time();
65 $webservice->downloadfiles = true;
106c55fb 66 $webservice->uploadfiles = true;
639bc8b2
PC
67 $externalserviceid = $DB->insert_record('external_services', $webservice);
68
87ede25c
JM
69 // Add a function to the service
70 $DB->insert_record('external_services_functions', array('externalserviceid' => $externalserviceid,
71 'functionname' => 'core_course_get_contents'));
72
639bc8b2
PC
73 $_POST['wstoken'] = 'testtoken';
74 $externaltoken = new stdClass();
75 $externaltoken->token = 'testtoken';
76 $externaltoken->tokentype = 0;
77 $externaltoken->userid = $USER->id;
78 $externaltoken->externalserviceid = $externalserviceid;
79 $externaltoken->contextid = 1;
80 $externaltoken->creatorid = $USER->id;
81 $externaltoken->timecreated = time();
82 $DB->insert_record('external_tokens', $externaltoken);
83
84 $siteinfo = core_webservice_external::get_site_info();
85
fb695f6e
JM
86 // We need to execute the return values cleaning process to simulate the web service server.
87 $siteinfo = external_api::clean_returnvalue(core_webservice_external::get_site_info_returns(), $siteinfo);
88
639bc8b2
PC
89 $this->assertEquals('johnd', $siteinfo['username']);
90 $this->assertEquals('John', $siteinfo['firstname']);
91 $this->assertEquals('Doe', $siteinfo['lastname']);
92fa81d3 92 $this->assertEquals(current_language(), $siteinfo['lang']);
639bc8b2 93 $this->assertEquals($USER->id, $siteinfo['userid']);
43695b6a 94 $this->assertEquals(SITEID, $siteinfo['siteid']);
639bc8b2
PC
95 $this->assertEquals(true, $siteinfo['downloadfiles']);
96 $this->assertEquals($CFG->release, $siteinfo['release']);
97 $this->assertEquals($CFG->version, $siteinfo['version']);
0c6c8664 98 $this->assertEquals('', $siteinfo['mobilecssurl']);
87ede25c
JM
99 $this->assertEquals(count($siteinfo['functions']), 1);
100 $function = array_pop($siteinfo['functions']);
101 $this->assertEquals($function['name'], 'core_course_get_contents');
102 $this->assertEquals($function['version'], $siteinfo['version']);
106c55fb
DW
103 $this->assertEquals(1, $siteinfo['downloadfiles']);
104 $this->assertEquals(1, $siteinfo['uploadfiles']);
14ae63be
JL
105
106 foreach ($siteinfo['advancedfeatures'] as $feature) {
107 if ($feature['name'] == 'mnet_dispatcher_mode') {
108 if ($CFG->mnet_dispatcher_mode == 'off') {
109 $this->assertEquals(0, $feature['value']);
110 } else {
111 $this->assertEquals(1, $feature['value']);
112 }
113 } else {
114 $this->assertEquals($CFG->{$feature['name']}, $feature['value']);
115 }
116 }
117
116c4a62 118 $this->assertEquals($userquota, $siteinfo['userquota']);
33d65f70
EL
119 // We can use the function for the expectation because USER_CAN_IGNORE_FILE_SIZE_LIMITS is
120 // covered below for admin user. This test is for user not allowed to ignore limits.
121 $this->assertEquals(get_max_upload_file_size($maxbytes), $siteinfo['usermaxuploadfilesize']);
116c4a62
JL
122 $this->assertEquals(true, $siteinfo['usercanmanageownfiles']);
123
333e7770 124 $this->assertEquals(HOMEPAGE_MY, $siteinfo['userhomepage']);
bef5777f
JL
125 $this->assertEquals($CFG->calendartype, $siteinfo['sitecalendartype']);
126 if (!empty($USER->calendartype)) {
127 $this->assertEquals($USER->calendartype, $siteinfo['usercalendartype']);
128 } else {
129 $this->assertEquals($CFG->calendartype, $siteinfo['usercalendartype']);
130 }
333e7770 131
116c4a62
JL
132 // Now as admin.
133 $this->setAdminUser();
134
135 // Set a fake token for the user admin.
136 $_POST['wstoken'] = 'testtoken';
137 $externaltoken = new stdClass();
138 $externaltoken->token = 'testtoken';
139 $externaltoken->tokentype = 0;
140 $externaltoken->userid = $USER->id;
141 $externaltoken->externalserviceid = $externalserviceid;
142 $externaltoken->contextid = 1;
143 $externaltoken->creatorid = $USER->id;
144 $externaltoken->timecreated = time();
145 $DB->insert_record('external_tokens', $externaltoken);
333e7770
JL
146
147 // Set a home page by user preferences.
148 $CFG->defaulthomepage = HOMEPAGE_USER;
149 set_user_preference('user_home_page_preference', HOMEPAGE_SITE);
150
116c4a62
JL
151 $siteinfo = core_webservice_external::get_site_info();
152
153 // We need to execute the return values cleaning process to simulate the web service server.
154 $siteinfo = external_api::clean_returnvalue(core_webservice_external::get_site_info_returns(), $siteinfo);
155
156 $this->assertEquals(0, $siteinfo['userquota']);
4f9b94fd 157 $this->assertEquals(USER_CAN_IGNORE_FILE_SIZE_LIMITS, $siteinfo['usermaxuploadfilesize']);
116c4a62
JL
158 $this->assertEquals(true, $siteinfo['usercanmanageownfiles']);
159
333e7770
JL
160 $this->assertEquals(HOMEPAGE_SITE, $siteinfo['userhomepage']);
161
639bc8b2
PC
162 }
163
164}