[ Index ]

PHP Cross Reference of moodle-2.8

title

Body

[close]

/mod/lti/tests/ -> locallib_test.php (source)

   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  // This file is part of BasicLTI4Moodle
  18  //
  19  // BasicLTI4Moodle is an IMS BasicLTI (Basic Learning Tools for Interoperability)
  20  // consumer for Moodle 1.9 and Moodle 2.0. BasicLTI is a IMS Standard that allows web
  21  // based learning tools to be easily integrated in LMS as native ones. The IMS BasicLTI
  22  // specification is part of the IMS standard Common Cartridge 1.1 Sakai and other main LMS
  23  // are already supporting or going to support BasicLTI. This project Implements the consumer
  24  // for Moodle. Moodle is a Free Open source Learning Management System by Martin Dougiamas.
  25  // BasicLTI4Moodle is a project iniciated and leaded by Ludo(Marc Alier) and Jordi Piguillem
  26  // at the GESSI research group at UPC.
  27  // SimpleLTI consumer for Moodle is an implementation of the early specification of LTI
  28  // by Charles Severance (Dr Chuck) htp://dr-chuck.com , developed by Jordi Piguillem in a
  29  // Google Summer of Code 2008 project co-mentored by Charles Severance and Marc Alier.
  30  //
  31  // BasicLTI4Moodle is copyright 2009 by Marc Alier Forment, Jordi Piguillem and Nikolas Galanis
  32  // of the Universitat Politecnica de Catalunya http://www.upc.edu
  33  // Contact info: Marc Alier Forment granludo @ gmail.com or marc.alier @ upc.edu.
  34  
  35  /**
  36   * This file contains unit tests for (some of) lti/locallib.php
  37   *
  38   * @package    mod_lti
  39   * @category   phpunit
  40   * @copyright  2009 Marc Alier, Jordi Piguillem, Nikolas Galanis
  41   * @copyright  2009 Universitat Politecnica de Catalunya http://www.upc.edu
  42   * @author     Charles Severance [email protected]
  43   * @author     Marc Alier ([email protected])
  44   * @author     Jordi Piguillem
  45   * @author     Nikolas Galanis
  46   * @author     Chris Scribner
  47   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  48   */
  49  
  50  defined('MOODLE_INTERNAL') || die;
  51  
  52  global $CFG;
  53  require_once($CFG->dirroot . '/mod/lti/locallib.php');
  54  require_once($CFG->dirroot . '/mod/lti/servicelib.php');
  55  
  56  /**
  57   * Local library tests
  58   *
  59   * @package    mod_lti
  60   * @copyright  Copyright (c) 2012 Moodlerooms Inc. (http://www.moodlerooms.com)
  61   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  62   */
  63  class mod_lti_locallib_testcase extends advanced_testcase {
  64  
  65      public function test_split_custom_parameters() {
  66          $tool = new stdClass();
  67          $tool->enabledcapability = '';
  68          $this->assertEquals(lti_split_custom_parameters(null, $tool, array(), "x=1\ny=2", false),
  69              array('custom_x' => '1', 'custom_y' => '2'));
  70  
  71          // Removed repeat of previous test with a semicolon separator.
  72  
  73          $this->assertEquals(lti_split_custom_parameters(null, $tool, array(), 'Review:Chapter=1.2.56', false),
  74              array('custom_review_chapter' => '1.2.56'));
  75  
  76          $this->assertEquals(lti_split_custom_parameters(null, $tool, array(),
  77              'Complex!@#$^*(){}[]KEY=Complex!@#$^*;(){}[]½Value', false),
  78              array('custom_complex____________key' => 'Complex!@#$^*;(){}[]½Value'));
  79      }
  80  
  81      /**
  82       * This test has been disabled because the test-tool is
  83       * being moved and probably it won't work anymore for this.
  84       * We should be testing here local stuff only and leave
  85       * outside-checks to the conformance tests. MDL-30347
  86       */
  87      public function disabled_test_sign_parameters() {
  88          $correct = array ( 'context_id' => '12345', 'context_label' => 'SI124', 'context_title' => 'Social Computing',
  89              'ext_submit' => 'Click Me', 'lti_message_type' => 'basic-lti-launch-request', 'lti_version' => 'LTI-1p0',
  90              'oauth_consumer_key' => 'lmsng.school.edu', 'oauth_nonce' => '47458148e33a8f9dafb888c3684cf476',
  91              'oauth_signature' => 'qWgaBIezihCbeHgcwUy14tZcyDQ=', 'oauth_signature_method' => 'HMAC-SHA1',
  92              'oauth_timestamp' => '1307141660', 'oauth_version' => '1.0', 'resource_link_id' => '123',
  93              'resource_link_title' => 'Weekly Blog', 'roles' => 'Learner', 'tool_consumer_instance_guid' => 'lmsng.school.edu',
  94              'user_id' => '789');
  95  
  96          $requestparams = array('resource_link_id' => '123', 'resource_link_title' => 'Weekly Blog', 'user_id' => '789',
  97              'roles' => 'Learner', 'context_id' => '12345', 'context_label' => 'SI124', 'context_title' => 'Social Computing');
  98  
  99          $parms = lti_sign_parameters($requestparams, 'http://www.imsglobal.org/developer/LTI/tool.php', 'POST',
 100              'lmsng.school.edu', 'secret', 'Click Me', 'lmsng.school.edu' /*, $org_desc*/);
 101          $this->assertTrue(isset($parms['oauth_nonce']));
 102          $this->assertTrue(isset($parms['oauth_signature']));
 103          $this->assertTrue(isset($parms['oauth_timestamp']));
 104  
 105          // Those things that are hard to mock.
 106          $correct['oauth_nonce'] = $parms['oauth_nonce'];
 107          $correct['oauth_signature'] = $parms['oauth_signature'];
 108          $correct['oauth_timestamp'] = $parms['oauth_timestamp'];
 109          ksort($parms);
 110          ksort($correct);
 111          $this->assertEquals($parms, $correct);
 112      }
 113  
 114      /**
 115       * This test has been disabled because, since its creation,
 116       * the sourceId generation has changed and surely this is outdated.
 117       * Some day these should be replaced by proper tests, but until then
 118       * conformance tests say this is working. MDL-30347
 119       */
 120      public function disabled_test_parse_grade_replace_message() {
 121          $message = '
 122              <imsx_POXEnvelopeRequest xmlns = "http://www.imsglobal.org/services/ltiv1p1/xsd/imsoms_v1p0">
 123                <imsx_POXHeader>
 124                  <imsx_POXRequestHeaderInfo>
 125                    <imsx_version>V1.0</imsx_version>
 126                    <imsx_messageIdentifier>999998123</imsx_messageIdentifier>
 127                  </imsx_POXRequestHeaderInfo>
 128                </imsx_POXHeader>
 129                <imsx_POXBody>
 130                  <replaceResultRequest>
 131                    <resultRecord>
 132                      <sourcedGUID>
 133                        <sourcedId>' .
 134              '{&quot;data&quot;:{&quot;instanceid&quot;:&quot;2&quot;,&quot;userid&quot;:&quot;2&quot;},&quot;hash&quot;:' .
 135              '&quot;0b5078feab59b9938c333ceaae21d8e003a7b295e43cdf55338445254421076b&quot;}' .
 136                        '</sourcedId>
 137                      </sourcedGUID>
 138                      <result>
 139                        <resultScore>
 140                          <language>en-us</language>
 141                          <textString>0.92</textString>
 142                        </resultScore>
 143                      </result>
 144                    </resultRecord>
 145                  </replaceResultRequest>
 146                </imsx_POXBody>
 147              </imsx_POXEnvelopeRequest>
 148  ';
 149  
 150          $parsed = lti_parse_grade_replace_message(new SimpleXMLElement($message));
 151  
 152          $this->assertEquals($parsed->userid, '2');
 153          $this->assertEquals($parsed->instanceid, '2');
 154          $this->assertEquals($parsed->sourcedidhash, '0b5078feab59b9938c333ceaae21d8e003a7b295e43cdf55338445254421076b');
 155  
 156          $ltiinstance = (object)array('servicesalt' => '4e5fcc06de1d58.44963230');
 157  
 158          lti_verify_sourcedid($ltiinstance, $parsed);
 159      }
 160  
 161      public function test_lti_ensure_url_is_https() {
 162          $this->assertEquals('https://moodle.org', lti_ensure_url_is_https('http://moodle.org'));
 163          $this->assertEquals('https://moodle.org', lti_ensure_url_is_https('moodle.org'));
 164          $this->assertEquals('https://moodle.org', lti_ensure_url_is_https('https://moodle.org'));
 165      }
 166  
 167      /**
 168       * Test lti_get_url_thumbprint against various URLs
 169       */
 170      public function test_lti_get_url_thumbprint() {
 171          // Note: trailing and double slash are expected right now.  Must evaluate if it must be removed at some point.
 172          $this->assertEquals('moodle.org/', lti_get_url_thumbprint('http://MOODLE.ORG'));
 173          $this->assertEquals('moodle.org/', lti_get_url_thumbprint('http://www.moodle.org'));
 174          $this->assertEquals('moodle.org/', lti_get_url_thumbprint('https://www.moodle.org'));
 175          $this->assertEquals('moodle.org/', lti_get_url_thumbprint('moodle.org'));
 176          $this->assertEquals('moodle.org//this/is/moodle', lti_get_url_thumbprint('http://moodle.org/this/is/moodle'));
 177          $this->assertEquals('moodle.org//this/is/moodle', lti_get_url_thumbprint('https://moodle.org/this/is/moodle'));
 178          $this->assertEquals('moodle.org//this/is/moodle', lti_get_url_thumbprint('moodle.org/this/is/moodle'));
 179          $this->assertEquals('moodle.org//this/is/moodle', lti_get_url_thumbprint('moodle.org/this/is/moodle?foo=bar'));
 180      }
 181  
 182      /**
 183       * Test lti_build_request's resource_link_description and ensure
 184       * that the newlines in the description are correct.
 185       */
 186      public function test_lti_build_request_description() {
 187          $this->resetAfterTest();
 188  
 189          self::setUser($this->getDataGenerator()->create_user());
 190          $course   = $this->getDataGenerator()->create_course();
 191          $instance = $this->getDataGenerator()->create_module('lti', array(
 192              'intro'       => "<p>This</p>\nhas\r\n<p>some</p>\nnew\n\rlines",
 193              'introformat' => FORMAT_HTML,
 194              'course'      => $course->id,
 195          ));
 196  
 197          $typeconfig = array(
 198              'acceptgrades'     => 1,
 199              'forcessl'         => 0,
 200              'sendname'         => 2,
 201              'sendemailaddr'    => 2,
 202              'customparameters' => '',
 203          );
 204  
 205          $params = lti_build_request($instance, $typeconfig, $course, null);
 206  
 207          $ncount = substr_count($params['resource_link_description'], "\n");
 208          $this->assertGreaterThan(0, $ncount);
 209  
 210          $rcount = substr_count($params['resource_link_description'], "\r");
 211          $this->assertGreaterThan(0, $rcount);
 212  
 213          $this->assertEquals($ncount, $rcount, 'The number of \n characters should be the same as the number of \r characters');
 214  
 215          $rncount = substr_count($params['resource_link_description'], "\r\n");
 216          $this->assertGreaterThan(0, $rncount);
 217  
 218          $this->assertEquals($ncount, $rncount, 'All newline characters should be a combination of \r\n');
 219      }
 220  }


Generated: Fri Nov 28 20:29:05 2014 Cross-referenced by PHPXref 0.7.1