33a21878bb715b234b5198bc0b5daeae3e3450af
[moodle.git] / mod / lti / tests / locallib_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/>.
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
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 csev@unmich.edu
43  * @author     Marc Alier (marc.alier@upc.edu)
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  */
50 defined('MOODLE_INTERNAL') || die;
52 global $CFG;
53 require_once($CFG->dirroot . '/mod/lti/locallib.php');
54 require_once($CFG->dirroot . '/mod/lti/servicelib.php');
57 class mod_lti_locallib_testcase extends basic_testcase {
59     public function test_split_custom_parameters() {
60         $this->assertEquals(lti_split_custom_parameters("x=1\ny=2"),
61             array('custom_x' => '1', 'custom_y'=> '2'));
63         $this->assertEquals(lti_split_custom_parameters('x=1;y=2'),
64             array('custom_x' => '1', 'custom_y'=> '2'));
66         $this->assertEquals(lti_split_custom_parameters('Review:Chapter=1.2.56'),
67             array('custom_review_chapter' => '1.2.56'));
69         $this->assertEquals(lti_split_custom_parameters('Complex!@#$^*(){}[]KEY=Complex!@#$^*(){}[]Value'),
70             array('custom_complex____________key' => 'Complex!@#$^*(){}[]Value'));
71     }
73     /**
74      * This test has been disabled because the test-tool is
75      * being moved and probably it won't work anymore for this.
76      * We should be testing here local stuff only and leave
77      * outside-checks to the conformance tests. MDL-30347
78      */
79     public function disabled_test_sign_parameters() {
80         $correct = array ( 'context_id' => '12345', 'context_label' => 'SI124', 'context_title' => 'Social Computing', 'ext_submit' => 'Click Me', 'lti_message_type' => 'basic-lti-launch-request', 'lti_version' => 'LTI-1p0', 'oauth_consumer_key' => 'lmsng.school.edu', 'oauth_nonce' => '47458148e33a8f9dafb888c3684cf476', 'oauth_signature' => 'qWgaBIezihCbeHgcwUy14tZcyDQ=', 'oauth_signature_method' => 'HMAC-SHA1', 'oauth_timestamp' => '1307141660', 'oauth_version' => '1.0', 'resource_link_id' => '123', 'resource_link_title' => 'Weekly Blog', 'roles' => 'Learner', 'tool_consumer_instance_guid' => 'lmsng.school.edu', 'user_id' => '789');
82         $requestparams = array('resource_link_id' => '123', 'resource_link_title' => 'Weekly Blog', 'user_id' => '789', 'roles' => 'Learner', 'context_id' => '12345', 'context_label' => 'SI124', 'context_title' => 'Social Computing');
84         $parms = lti_sign_parameters($requestparams, 'http://www.imsglobal.org/developer/LTI/tool.php', 'POST',
85             'lmsng.school.edu', 'secret', 'Click Me', 'lmsng.school.edu' /*, $org_desc*/);
86         $this->assertTrue(isset($parms['oauth_nonce']));
87         $this->assertTrue(isset($parms['oauth_signature']));
88         $this->assertTrue(isset($parms['oauth_timestamp']));
90         // Those things that are hard to mock
91         $correct['oauth_nonce'] = $parms['oauth_nonce'];
92         $correct['oauth_signature'] = $parms['oauth_signature'];
93         $correct['oauth_timestamp'] = $parms['oauth_timestamp'];
94         ksort($parms);
95         ksort($correct);
96         $this->assertEquals($parms, $correct);
97     }
99     /**
100      * This test has been disabled because, since its creation,
101      * the sourceId generation has changed and surely this is outdated.
102      * Some day these should be replaced by proper tests, but until then
103      * conformance tests say this is working. MDL-30347
104      */
105     public function disabled_test_parse_grade_replace_message() {
106         $message = '
107             <imsx_POXEnvelopeRequest xmlns = "http://www.imsglobal.org/services/ltiv1p1/xsd/imsoms_v1p0">
108               <imsx_POXHeader>
109                 <imsx_POXRequestHeaderInfo>
110                   <imsx_version>V1.0</imsx_version>
111                   <imsx_messageIdentifier>999998123</imsx_messageIdentifier>
112                 </imsx_POXRequestHeaderInfo>
113               </imsx_POXHeader>
114               <imsx_POXBody>
115                 <replaceResultRequest>
116                   <resultRecord>
117                     <sourcedGUID>
118                       <sourcedId>{&quot;data&quot;:{&quot;instanceid&quot;:&quot;2&quot;,&quot;userid&quot;:&quot;2&quot;},&quot;hash&quot;:&quot;0b5078feab59b9938c333ceaae21d8e003a7b295e43cdf55338445254421076b&quot;}</sourcedId>
119                     </sourcedGUID>
120                     <result>
121                       <resultScore>
122                         <language>en-us</language>
123                         <textString>0.92</textString>
124                       </resultScore>
125                     </result>
126                   </resultRecord>
127                 </replaceResultRequest>
128               </imsx_POXBody>
129             </imsx_POXEnvelopeRequest>
130 ';
132         $parsed = lti_parse_grade_replace_message(new SimpleXMLElement($message));
134         $this->assertEquals($parsed->userid, '2');
135         $this->assertEquals($parsed->instanceid, '2');
136         $this->assertEquals($parsed->sourcedidhash, '0b5078feab59b9938c333ceaae21d8e003a7b295e43cdf55338445254421076b');
138         $ltiinstance = (object)array('servicesalt' => '4e5fcc06de1d58.44963230');
140         lti_verify_sourcedid($ltiinstance, $parsed);
141     }
143     public function test_lti_ensure_url_is_https() {
144         $this->assertEquals('https://moodle.org', lti_ensure_url_is_https('http://moodle.org'));
145         $this->assertEquals('https://moodle.org', lti_ensure_url_is_https('moodle.org'));
146         $this->assertEquals('https://moodle.org', lti_ensure_url_is_https('https://moodle.org'));
147     }