[Summary view] [Print] [Text view]

   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  defined('MOODLE_INTERNAL') || die();
  18  
  19  global $CFG;
  20  require_once($CFG->dirroot . '/webservice/externallib.php');
  21  require_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   */
  31  class core_webservice_externallib_testcase extends externallib_advanced_testcase {
  32  
  33      public function setUp() {
  34          // Calling parent is good, always
  35          parent::setUp();
  36  
  37          // We always need enabled WS for this testcase
  38          set_config('enablewebservices', '1');
  39      }
  40  
  41      public function test_get_site_info() {
  42          global $DB, $USER, $CFG;
  43  
  44          $this->resetAfterTest(true);
  45  
  46          // This is the info we are going to check
  47          set_config('release', '2.4dev (Build: 20120823)');
  48          set_config('version', '2012083100.00');
  49  
  50          $maxbytes = 10485760;
  51          $userquota = 5242880;
  52          set_config('maxbytes', $maxbytes);
  53          set_config('userquota', $userquota);
  54  
  55          // Set current user
  56          $user = array();
  57          $user['username'] = 'johnd';
  58          $user['firstname'] = 'John';
  59          $user['lastname'] = 'Doe';
  60          self::setUser(self::getDataGenerator()->create_user($user));
  61  
  62          // Add a web service and token.
  63          $webservice = new stdClass();
  64          $webservice->name = 'Test web service';
  65          $webservice->enabled = true;
  66          $webservice->restrictedusers = false;
  67          $webservice->component = 'moodle';
  68          $webservice->timecreated = time();
  69          $webservice->downloadfiles = true;
  70          $webservice->uploadfiles = true;
  71          $externalserviceid = $DB->insert_record('external_services', $webservice);
  72  
  73          // Add a function to the service
  74          $DB->insert_record('external_services_functions', array('externalserviceid' => $externalserviceid,
  75              'functionname' => 'core_course_get_contents'));
  76  
  77          $_POST['wstoken'] = 'testtoken';
  78          $externaltoken = new stdClass();
  79          $externaltoken->token = 'testtoken';
  80          $externaltoken->tokentype = 0;
  81          $externaltoken->userid = $USER->id;
  82          $externaltoken->externalserviceid = $externalserviceid;
  83          $externaltoken->contextid = 1;
  84          $externaltoken->creatorid = $USER->id;
  85          $externaltoken->timecreated = time();
  86          $DB->insert_record('external_tokens', $externaltoken);
  87  
  88          $siteinfo = core_webservice_external::get_site_info();
  89  
  90          // We need to execute the return values cleaning process to simulate the web service server.
  91          $siteinfo = external_api::clean_returnvalue(core_webservice_external::get_site_info_returns(), $siteinfo);
  92  
  93          $this->assertEquals('johnd', $siteinfo['username']);
  94          $this->assertEquals('John', $siteinfo['firstname']);
  95          $this->assertEquals('Doe', $siteinfo['lastname']);
  96          $this->assertEquals(current_language(), $siteinfo['lang']);
  97          $this->assertEquals($USER->id, $siteinfo['userid']);
  98          $this->assertEquals(true, $siteinfo['downloadfiles']);
  99          $this->assertEquals($CFG->release, $siteinfo['release']);
 100          $this->assertEquals($CFG->version, $siteinfo['version']);
 101          $this->assertEquals($CFG->mobilecssurl, $siteinfo['mobilecssurl']);
 102          $this->assertEquals(count($siteinfo['functions']), 1);
 103          $function = array_pop($siteinfo['functions']);
 104          $this->assertEquals($function['name'], 'core_course_get_contents');
 105          $this->assertEquals($function['version'], $siteinfo['version']);
 106          $this->assertEquals(1, $siteinfo['downloadfiles']);
 107          $this->assertEquals(1, $siteinfo['uploadfiles']);
 108  
 109          foreach ($siteinfo['advancedfeatures'] as $feature) {
 110              if ($feature['name'] == 'mnet_dispatcher_mode') {
 111                  if ($CFG->mnet_dispatcher_mode == 'off') {
 112                      $this->assertEquals(0, $feature['value']);
 113                  } else {
 114                      $this->assertEquals(1, $feature['value']);
 115                  }
 116              } else {
 117                  $this->assertEquals($CFG->{$feature['name']}, $feature['value']);
 118              }
 119          }
 120  
 121          $this->assertEquals($userquota, $siteinfo['userquota']);
 122          // We can use the function for the expectation because USER_CAN_IGNORE_FILE_SIZE_LIMITS is
 123          // covered below for admin user. This test is for user not allowed to ignore limits.
 124          $this->assertEquals(get_max_upload_file_size($maxbytes), $siteinfo['usermaxuploadfilesize']);
 125          $this->assertEquals(true, $siteinfo['usercanmanageownfiles']);
 126  
 127          $this->assertEquals(HOMEPAGE_MY, $siteinfo['userhomepage']);
 128  
 129          // Now as admin.
 130          $this->setAdminUser();
 131  
 132          // Set a fake token for the user admin.
 133          $_POST['wstoken'] = 'testtoken';
 134          $externaltoken = new stdClass();
 135          $externaltoken->token = 'testtoken';
 136          $externaltoken->tokentype = 0;
 137          $externaltoken->userid = $USER->id;
 138          $externaltoken->externalserviceid = $externalserviceid;
 139          $externaltoken->contextid = 1;
 140          $externaltoken->creatorid = $USER->id;
 141          $externaltoken->timecreated = time();
 142          $DB->insert_record('external_tokens', $externaltoken);
 143  
 144          // Set a home page by user preferences.
 145          $CFG->defaulthomepage = HOMEPAGE_USER;
 146          set_user_preference('user_home_page_preference', HOMEPAGE_SITE);
 147  
 148          $siteinfo = core_webservice_external::get_site_info();
 149  
 150          // We need to execute the return values cleaning process to simulate the web service server.
 151          $siteinfo = external_api::clean_returnvalue(core_webservice_external::get_site_info_returns(), $siteinfo);
 152  
 153          $this->assertEquals(0, $siteinfo['userquota']);
 154          $this->assertEquals(USER_CAN_IGNORE_FILE_SIZE_LIMITS, $siteinfo['usermaxuploadfilesize']);
 155          $this->assertEquals(true, $siteinfo['usercanmanageownfiles']);
 156  
 157          $this->assertEquals(HOMEPAGE_SITE, $siteinfo['userhomepage']);
 158  
 159      }
 160  
 161  }