芝麻web文件管理V1.00
编辑当前文件:/home2/sdektunc/www/cepali/mod/lti/tests/locallib_test.php
. // // This file is part of BasicLTI4Moodle // // BasicLTI4Moodle is an IMS BasicLTI (Basic Learning Tools for Interoperability) // consumer for Moodle 1.9 and Moodle 2.0. BasicLTI is a IMS Standard that allows web // based learning tools to be easily integrated in LMS as native ones. The IMS BasicLTI // specification is part of the IMS standard Common Cartridge 1.1 Sakai and other main LMS // are already supporting or going to support BasicLTI. This project Implements the consumer // for Moodle. Moodle is a Free Open source Learning Management System by Martin Dougiamas. // BasicLTI4Moodle is a project iniciated and leaded by Ludo(Marc Alier) and Jordi Piguillem // at the GESSI research group at UPC. // SimpleLTI consumer for Moodle is an implementation of the early specification of LTI // by Charles Severance (Dr Chuck) htp://dr-chuck.com , developed by Jordi Piguillem in a // Google Summer of Code 2008 project co-mentored by Charles Severance and Marc Alier. // // BasicLTI4Moodle is copyright 2009 by Marc Alier Forment, Jordi Piguillem and Nikolas Galanis // of the Universitat Politecnica de Catalunya http://www.upc.edu // Contact info: Marc Alier Forment granludo @ gmail.com or marc.alier @ upc.edu. /** * This file contains unit tests for (some of) lti/locallib.php * * @package mod_lti * @category phpunit * @copyright 2009 Marc Alier, Jordi Piguillem, Nikolas Galanis * @copyright 2009 Universitat Politecnica de Catalunya http://www.upc.edu * @author Charles Severance csev@unmich.edu * @author Marc Alier (marc.alier@upc.edu) * @author Jordi Piguillem * @author Nikolas Galanis * @author Chris Scribner * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die; global $CFG; require_once($CFG->dirroot . '/mod/lti/locallib.php'); require_once($CFG->dirroot . '/mod/lti/servicelib.php'); /** * Local library tests * * @package mod_lti * @copyright Copyright (c) 2012 Moodlerooms Inc. (http://www.moodlerooms.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class mod_lti_locallib_testcase extends advanced_testcase { public function test_split_custom_parameters() { $this->resetAfterTest(); $tool = new stdClass(); $tool->enabledcapability = ''; $tool->parameter = ''; $tool->ltiversion = 'LTI-1p0'; $this->assertEquals(lti_split_custom_parameters(null, $tool, array(), "x=1\ny=2", false), array('custom_x' => '1', 'custom_y' => '2')); // Check params with caps. $this->assertEquals(lti_split_custom_parameters(null, $tool, array(), "X=1", true), array('custom_x' => '1', 'custom_X' => '1')); // Removed repeat of previous test with a semicolon separator. $this->assertEquals(lti_split_custom_parameters(null, $tool, array(), 'Review:Chapter=1.2.56', true), array( 'custom_review_chapter' => '1.2.56', 'custom_Review:Chapter' => '1.2.56')); $this->assertEquals(lti_split_custom_parameters(null, $tool, array(), 'Complex!@#$^*(){}[]KEY=Complex!@#$^*;(){}[]½Value', true), array( 'custom_complex____________key' => 'Complex!@#$^*;(){}[]½Value', 'custom_Complex!@#$^*(){}[]KEY' => 'Complex!@#$^*;(){}[]½Value')); // Test custom parameter that returns $USER property. $user = $this->getDataGenerator()->create_user(array('middlename' => 'SOMETHING')); $this->setUser($user); $this->assertEquals(array('custom_x' => '1', 'custom_y' => 'SOMETHING'), lti_split_custom_parameters(null, $tool, array(), "x=1\ny=\$Person.name.middle", false)); } /** * This test has been disabled because the test-tool is * being moved and probably it won't work anymore for this. * We should be testing here local stuff only and leave * outside-checks to the conformance tests. MDL-30347 */ public function disabled_test_sign_parameters() { $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'); $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'); $parms = lti_sign_parameters($requestparams, 'http://www.imsglobal.org/developer/LTI/tool.php', 'POST', 'lmsng.school.edu', 'secret', 'Click Me', 'lmsng.school.edu' /*, $org_desc*/); $this->assertTrue(isset($parms['oauth_nonce'])); $this->assertTrue(isset($parms['oauth_signature'])); $this->assertTrue(isset($parms['oauth_timestamp'])); // Those things that are hard to mock. $correct['oauth_nonce'] = $parms['oauth_nonce']; $correct['oauth_signature'] = $parms['oauth_signature']; $correct['oauth_timestamp'] = $parms['oauth_timestamp']; ksort($parms); ksort($correct); $this->assertEquals($parms, $correct); } /** * This test has been disabled because, since its creation, * the sourceId generation has changed and surely this is outdated. * Some day these should be replaced by proper tests, but until then * conformance tests say this is working. MDL-30347 */ public function disabled_test_parse_grade_replace_message() { $message = '
V1.0
999998123
' . '{"data":{"instanceid":"2","userid":"2"},"hash":' . '"0b5078feab59b9938c333ceaae21d8e003a7b295e43cdf55338445254421076b"}' . '
en-us
0.92
'; $parsed = lti_parse_grade_replace_message(new SimpleXMLElement($message)); $this->assertEquals($parsed->userid, '2'); $this->assertEquals($parsed->instanceid, '2'); $this->assertEquals($parsed->sourcedidhash, '0b5078feab59b9938c333ceaae21d8e003a7b295e43cdf55338445254421076b'); $ltiinstance = (object)array('servicesalt' => '4e5fcc06de1d58.44963230'); lti_verify_sourcedid($ltiinstance, $parsed); } public function test_lti_ensure_url_is_https() { $this->assertEquals('https://moodle.org', lti_ensure_url_is_https('http://moodle.org')); $this->assertEquals('https://moodle.org', lti_ensure_url_is_https('moodle.org')); $this->assertEquals('https://moodle.org', lti_ensure_url_is_https('https://moodle.org')); } /** * Test lti_get_url_thumbprint against various URLs */ public function test_lti_get_url_thumbprint() { // Note: trailing and double slash are expected right now. Must evaluate if it must be removed at some point. $this->assertEquals('moodle.org/', lti_get_url_thumbprint('http://MOODLE.ORG')); $this->assertEquals('moodle.org/', lti_get_url_thumbprint('http://www.moodle.org')); $this->assertEquals('moodle.org/', lti_get_url_thumbprint('https://www.moodle.org')); $this->assertEquals('moodle.org/', lti_get_url_thumbprint('moodle.org')); $this->assertEquals('moodle.org//this/is/moodle', lti_get_url_thumbprint('http://moodle.org/this/is/moodle')); $this->assertEquals('moodle.org//this/is/moodle', lti_get_url_thumbprint('https://moodle.org/this/is/moodle')); $this->assertEquals('moodle.org//this/is/moodle', lti_get_url_thumbprint('moodle.org/this/is/moodle')); $this->assertEquals('moodle.org//this/is/moodle', lti_get_url_thumbprint('moodle.org/this/is/moodle?')); $this->assertEquals('moodle.org//this/is/moodle?foo=bar', lti_get_url_thumbprint('moodle.org/this/is/moodle?foo=bar')); } /* * Verify that lti_build_request does handle resource_link_id as expected */ public function test_lti_buid_request_resource_link_id() { $this->resetAfterTest(); self::setUser($this->getDataGenerator()->create_user()); $course = $this->getDataGenerator()->create_course(); $instance = $this->getDataGenerator()->create_module('lti', array( 'intro' => "
This
\nhas\r\n
some
\nnew\n\rlines", 'introformat' => FORMAT_HTML, 'course' => $course->id, )); $typeconfig = array( 'acceptgrades' => 1, 'forcessl' => 0, 'sendname' => 2, 'sendemailaddr' => 2, 'customparameters' => '', ); // Normal call, we expect $instance->id to be used as resource_link_id. $params = lti_build_request($instance, $typeconfig, $course, null); $this->assertSame($instance->id, $params['resource_link_id']); // If there is a resource_link_id set, it gets precedence. $instance->resource_link_id = $instance->id + 99; $params = lti_build_request($instance, $typeconfig, $course, null); $this->assertSame($instance->resource_link_id, $params['resource_link_id']); // With none set, resource_link_id is not set either. unset($instance->id); unset($instance->resource_link_id); $params = lti_build_request($instance, $typeconfig, $course, null); $this->assertArrayNotHasKey('resource_link_id', $params); } /** * Test lti_build_request's resource_link_description and ensure * that the newlines in the description are correct. */ public function test_lti_build_request_description() { $this->resetAfterTest(); self::setUser($this->getDataGenerator()->create_user()); $course = $this->getDataGenerator()->create_course(); $instance = $this->getDataGenerator()->create_module('lti', array( 'intro' => "
This
\nhas\r\n
some
\nnew\n\rlines", 'introformat' => FORMAT_HTML, 'course' => $course->id, )); $typeconfig = array( 'acceptgrades' => 1, 'forcessl' => 0, 'sendname' => 2, 'sendemailaddr' => 2, 'customparameters' => '', ); $params = lti_build_request($instance, $typeconfig, $course, null); $ncount = substr_count($params['resource_link_description'], "\n"); $this->assertGreaterThan(0, $ncount); $rcount = substr_count($params['resource_link_description'], "\r"); $this->assertGreaterThan(0, $rcount); $this->assertEquals($ncount, $rcount, 'The number of \n characters should be the same as the number of \r characters'); $rncount = substr_count($params['resource_link_description'], "\r\n"); $this->assertGreaterThan(0, $rncount); $this->assertEquals($ncount, $rncount, 'All newline characters should be a combination of \r\n'); } /** * Tests lti_prepare_type_for_save's handling of the "Force SSL" configuration. */ public function test_lti_prepare_type_for_save_forcessl() { $type = new stdClass(); $config = new stdClass(); // Try when the forcessl config property is not set. lti_prepare_type_for_save($type, $config); $this->assertObjectHasAttribute('lti_forcessl', $config); $this->assertEquals(0, $config->lti_forcessl); $this->assertEquals(0, $type->forcessl); // Try when forcessl config property is set. $config->lti_forcessl = 1; lti_prepare_type_for_save($type, $config); $this->assertObjectHasAttribute('lti_forcessl', $config); $this->assertEquals(1, $config->lti_forcessl); $this->assertEquals(1, $type->forcessl); // Try when forcessl config property is set to 0. $config->lti_forcessl = 0; lti_prepare_type_for_save($type, $config); $this->assertObjectHasAttribute('lti_forcessl', $config); $this->assertEquals(0, $config->lti_forcessl); $this->assertEquals(0, $type->forcessl); } /** * Tests lti_load_type_from_cartridge and lti_load_type_if_cartridge */ public function test_lti_load_type_from_cartridge() { $type = new stdClass(); $type->lti_toolurl = $this->getExternalTestFileUrl('/ims_cartridge_basic_lti_link.xml'); lti_load_type_if_cartridge($type); $this->assertEquals('Example tool', $type->lti_typename); $this->assertEquals('Example tool description', $type->lti_description); $this->assertEquals('http://www.example.com/lti/provider.php', $type->lti_toolurl); $this->assertEquals('http://download.moodle.org/unittest/test.jpg', $type->lti_icon); $this->assertEquals('https://download.moodle.org/unittest/test.jpg', $type->lti_secureicon); } /** * Tests lti_load_tool_from_cartridge and lti_load_tool_if_cartridge */ public function test_lti_load_tool_from_cartridge() { $lti = new stdClass(); $lti->toolurl = $this->getExternalTestFileUrl('/ims_cartridge_basic_lti_link.xml'); lti_load_tool_if_cartridge($lti); $this->assertEquals('Example tool', $lti->name); $this->assertEquals('Example tool description', $lti->intro); $this->assertEquals('http://www.example.com/lti/provider.php', $lti->toolurl); $this->assertEquals('https://www.example.com/lti/provider.php', $lti->securetoolurl); $this->assertEquals('http://download.moodle.org/unittest/test.jpg', $lti->icon); $this->assertEquals('https://download.moodle.org/unittest/test.jpg', $lti->secureicon); } /** * Tests for lti_build_content_item_selection_request(). */ public function test_lti_build_content_item_selection_request() { $this->resetAfterTest(); $this->setAdminUser(); // Create a tool proxy. $proxy = mod_lti_external::create_tool_proxy('Test proxy', $this->getExternalTestFileUrl('/test.html'), array(), array()); // Create a tool type, associated with that proxy. $type = new stdClass(); $data = new stdClass(); $data->lti_contentitem = true; $type->state = LTI_TOOL_STATE_CONFIGURED; $type->name = "Test tool"; $type->description = "Example description"; $type->toolproxyid = $proxy->id; $type->baseurl = $this->getExternalTestFileUrl('/test.html'); $typeid = lti_add_type($type, $data); $typeconfig = lti_get_type_config($typeid); $course = $this->getDataGenerator()->create_course(); $returnurl = new moodle_url('/'); // Default parameters. $result = lti_build_content_item_selection_request($typeid, $course, $returnurl); $this->assertNotEmpty($result); $this->assertNotEmpty($result->params); $this->assertNotEmpty($result->url); $params = $result->params; $url = $result->url; $this->assertEquals($typeconfig['toolurl'], $url); $this->assertEquals('ContentItemSelectionRequest', $params['lti_message_type']); $this->assertEquals(LTI_VERSION_1, $params['lti_version']); $this->assertEquals('application/vnd.ims.lti.v1.ltilink', $params['accept_media_types']); $this->assertEquals('frame,iframe,window', $params['accept_presentation_document_targets']); $this->assertEquals($returnurl->out(false), $params['content_item_return_url']); $this->assertEquals('false', $params['accept_unsigned']); $this->assertEquals('false', $params['accept_multiple']); $this->assertEquals('false', $params['accept_copy_advice']); $this->assertEquals('false', $params['auto_create']); $this->assertEquals($type->name, $params['title']); $this->assertFalse(isset($params['resource_link_id'])); $this->assertFalse(isset($params['resource_link_title'])); $this->assertFalse(isset($params['resource_link_description'])); $this->assertFalse(isset($params['launch_presentation_return_url'])); $this->assertFalse(isset($params['lis_result_sourcedid'])); // Custom parameters. $title = 'My custom title'; $text = 'This is the tool description'; $mediatypes = ['image/*', 'video/*']; $targets = ['embed', 'iframe']; $result = lti_build_content_item_selection_request($typeid, $course, $returnurl, $title, $text, $mediatypes, $targets, true, true, true, true, true); $this->assertNotEmpty($result); $this->assertNotEmpty($result->params); $this->assertNotEmpty($result->url); $params = $result->params; $this->assertEquals(implode(',', $mediatypes), $params['accept_media_types']); $this->assertEquals(implode(',', $targets), $params['accept_presentation_document_targets']); $this->assertEquals('true', $params['accept_unsigned']); $this->assertEquals('true', $params['accept_multiple']); $this->assertEquals('true', $params['accept_copy_advice']); $this->assertEquals('true', $params['auto_create']); $this->assertEquals($title, $params['title']); $this->assertEquals($text, $params['text']); // Invalid flag values. $result = lti_build_content_item_selection_request($typeid, $course, $returnurl, $title, $text, $mediatypes, $targets, 'aa', -1, 0, 1, 0xabc); $this->assertNotEmpty($result); $this->assertNotEmpty($result->params); $this->assertNotEmpty($result->url); $params = $result->params; $this->assertEquals(implode(',', $mediatypes), $params['accept_media_types']); $this->assertEquals(implode(',', $targets), $params['accept_presentation_document_targets']); $this->assertEquals('false', $params['accept_unsigned']); $this->assertEquals('false', $params['accept_multiple']); $this->assertEquals('false', $params['accept_copy_advice']); $this->assertEquals('false', $params['auto_create']); $this->assertEquals($title, $params['title']); $this->assertEquals($text, $params['text']); } /** * Test for lti_build_content_item_selection_request() with nonexistent tool type ID parameter. */ public function test_lti_build_content_item_selection_request_invalid_tooltype() { $this->resetAfterTest(); $this->setAdminUser(); $course = $this->getDataGenerator()->create_course(); $returnurl = new moodle_url('/'); // Should throw Exception on non-existent tool type. $this->expectException('moodle_exception'); lti_build_content_item_selection_request(1, $course, $returnurl); } /** * Test for lti_build_content_item_selection_request() with invalid media types parameter. */ public function test_lti_build_content_item_selection_request_invalid_mediatypes() { $this->resetAfterTest(); $this->setAdminUser(); // Create a tool type, associated with that proxy. $type = new stdClass(); $data = new stdClass(); $data->lti_contentitem = true; $type->state = LTI_TOOL_STATE_CONFIGURED; $type->name = "Test tool"; $type->description = "Example description"; $type->baseurl = $this->getExternalTestFileUrl('/test.html'); $typeid = lti_add_type($type, $data); $course = $this->getDataGenerator()->create_course(); $returnurl = new moodle_url('/'); // Should throw coding_exception on non-array media types. $mediatypes = 'image/*,video/*'; $this->expectException('coding_exception'); lti_build_content_item_selection_request($typeid, $course, $returnurl, '', '', $mediatypes); } /** * Test for lti_build_content_item_selection_request() with invalid presentation targets parameter. */ public function test_lti_build_content_item_selection_request_invalid_presentationtargets() { $this->resetAfterTest(); $this->setAdminUser(); // Create a tool type, associated with that proxy. $type = new stdClass(); $data = new stdClass(); $data->lti_contentitem = true; $type->state = LTI_TOOL_STATE_CONFIGURED; $type->name = "Test tool"; $type->description = "Example description"; $type->baseurl = $this->getExternalTestFileUrl('/test.html'); $typeid = lti_add_type($type, $data); $course = $this->getDataGenerator()->create_course(); $returnurl = new moodle_url('/'); // Should throw coding_exception on non-array presentation targets. $targets = 'frame,iframe'; $this->expectException('coding_exception'); lti_build_content_item_selection_request($typeid, $course, $returnurl, '', '', [], $targets); } /** * Provider for test_lti_get_best_tool_by_url. * * @return array of [urlToTest, expectedTool, allTools] */ public function lti_get_best_tool_by_url_provider() { $tools = [ (object) [ 'name' => 'Here', 'baseurl' => 'https://example.com/i/am/?where=here', 'tooldomain' => 'example.com', 'state' => LTI_TOOL_STATE_CONFIGURED, 'course' => SITEID ], (object) [ 'name' => 'There', 'baseurl' => 'https://example.com/i/am/?where=there', 'tooldomain' => 'example.com', 'state' => LTI_TOOL_STATE_CONFIGURED, 'course' => SITEID ], (object) [ 'name' => 'Not here', 'baseurl' => 'https://example.com/i/am/?where=not/here', 'tooldomain' => 'example.com', 'state' => LTI_TOOL_STATE_CONFIGURED, 'course' => SITEID ], (object) [ 'name' => 'Here', 'baseurl' => 'https://example.com/i/am/', 'tooldomain' => 'example.com', 'state' => LTI_TOOL_STATE_CONFIGURED, 'course' => SITEID ], (object) [ 'name' => 'Here', 'baseurl' => 'https://example.com/i/was', 'tooldomain' => 'example.com', 'state' => LTI_TOOL_STATE_CONFIGURED, 'course' => SITEID ], (object) [ 'name' => 'Here', 'baseurl' => 'https://badexample.com/i/am/?where=here', 'tooldomain' => 'badexample.com', 'state' => LTI_TOOL_STATE_CONFIGURED, 'course' => SITEID ], ]; $data = [ [ 'url' => $tools[0]->baseurl, 'expected' => $tools[0], ], [ 'url' => $tools[1]->baseurl, 'expected' => $tools[1], ], [ 'url' => $tools[2]->baseurl, 'expected' => $tools[2], ], [ 'url' => $tools[3]->baseurl, 'expected' => $tools[3], ], [ 'url' => $tools[4]->baseurl, 'expected' => $tools[4], ], [ 'url' => $tools[5]->baseurl, 'expected' => $tools[5], ], [ 'url' => 'https://nomatch.com/i/am/', 'expected' => null ], [ 'url' => 'https://example.com', 'expected' => null ], [ 'url' => 'https://example.com/i/am/?where=unknown', 'expected' => $tools[3] ] ]; // Construct the final array as required by the provider API. Each row // of the array contains the URL to test, the expected tool, and // the complete list of tools. return array_map(function($data) use ($tools) { return [$data['url'], $data['expected'], $tools]; }, $data); } /** * Test lti_get_best_tool_by_url. * * @dataProvider lti_get_best_tool_by_url_provider * @param string $url The URL to test. * @param object $expected The expected tool matching the URL. * @param array $tools The pool of tools to match the URL with. */ public function test_lti_get_best_tool_by_url($url, $expected, $tools) { $actual = lti_get_best_tool_by_url($url, $tools, null); $this->assertSame($expected, $actual); } /** * Test lti_get_jwt_message_type_mapping(). */ public function test_lti_get_jwt_message_type_mapping() { $mapping = [ 'basic-lti-launch-request' => 'LtiResourceLinkRequest', 'ContentItemSelectionRequest' => 'LtiDeepLinkingRequest', 'LtiDeepLinkingResponse' => 'ContentItemSelection', ]; $this->assertEquals($mapping, lti_get_jwt_message_type_mapping()); } /** * Test lti_get_jwt_claim_mapping() */ public function test_lti_get_jwt_claim_mapping() { $mapping = [ 'accept_copy_advice' => [ 'suffix' => 'dl', 'group' => 'deep_linking_settings', 'claim' => 'accept_copy_advice', 'isarray' => false ], 'accept_media_types' => [ 'suffix' => 'dl', 'group' => 'deep_linking_settings', 'claim' => 'accept_media_types', 'isarray' => true ], 'accept_multiple' => [ 'suffix' => 'dl', 'group' => 'deep_linking_settings', 'claim' => 'accept_multiple', 'isarray' => false ], 'accept_presentation_document_targets' => [ 'suffix' => 'dl', 'group' => 'deep_linking_settings', 'claim' => 'accept_presentation_document_targets', 'isarray' => true ], 'accept_types' => [ 'suffix' => 'dl', 'group' => 'deep_linking_settings', 'claim' => 'accept_types', 'isarray' => true ], 'accept_unsigned' => [ 'suffix' => 'dl', 'group' => 'deep_linking_settings', 'claim' => 'accept_unsigned', 'isarray' => false ], 'auto_create' => [ 'suffix' => 'dl', 'group' => 'deep_linking_settings', 'claim' => 'auto_create', 'isarray' => false ], 'can_confirm' => [ 'suffix' => 'dl', 'group' => 'deep_linking_settings', 'claim' => 'can_confirm', 'isarray' => false ], 'content_item_return_url' => [ 'suffix' => 'dl', 'group' => 'deep_linking_settings', 'claim' => 'deep_link_return_url', 'isarray' => false ], 'content_items' => [ 'suffix' => 'dl', 'group' => '', 'claim' => 'content_items', 'isarray' => true ], 'data' => [ 'suffix' => 'dl', 'group' => 'deep_linking_settings', 'claim' => 'data', 'isarray' => false ], 'text' => [ 'suffix' => 'dl', 'group' => 'deep_linking_settings', 'claim' => 'text', 'isarray' => false ], 'title' => [ 'suffix' => 'dl', 'group' => 'deep_linking_settings', 'claim' => 'title', 'isarray' => false ], 'lti_msg' => [ 'suffix' => 'dl', 'group' => '', 'claim' => 'msg', 'isarray' => false ], 'lti_log' => [ 'suffix' => 'dl', 'group' => '', 'claim' => 'log', 'isarray' => false ], 'lti_errormsg' => [ 'suffix' => 'dl', 'group' => '', 'claim' => 'errormsg', 'isarray' => false ], 'lti_errorlog' => [ 'suffix' => 'dl', 'group' => '', 'claim' => 'errorlog', 'isarray' => false ], 'context_id' => [ 'suffix' => '', 'group' => 'context', 'claim' => 'id', 'isarray' => false ], 'context_label' => [ 'suffix' => '', 'group' => 'context', 'claim' => 'label', 'isarray' => false ], 'context_title' => [ 'suffix' => '', 'group' => 'context', 'claim' => 'title', 'isarray' => false ], 'context_type' => [ 'suffix' => '', 'group' => 'context', 'claim' => 'type', 'isarray' => true ], 'lis_course_offering_sourcedid' => [ 'suffix' => '', 'group' => 'lis', 'claim' => 'course_offering_sourcedid', 'isarray' => false ], 'lis_course_section_sourcedid' => [ 'suffix' => '', 'group' => 'lis', 'claim' => 'course_section_sourcedid', 'isarray' => false ], 'launch_presentation_css_url' => [ 'suffix' => '', 'group' => 'launch_presentation', 'claim' => 'css_url', 'isarray' => false ], 'launch_presentation_document_target' => [ 'suffix' => '', 'group' => 'launch_presentation', 'claim' => 'document_target', 'isarray' => false ], 'launch_presentation_height' => [ 'suffix' => '', 'group' => 'launch_presentation', 'claim' => 'height', 'isarray' => false ], 'launch_presentation_locale' => [ 'suffix' => '', 'group' => 'launch_presentation', 'claim' => 'locale', 'isarray' => false ], 'launch_presentation_return_url' => [ 'suffix' => '', 'group' => 'launch_presentation', 'claim' => 'return_url', 'isarray' => false ], 'launch_presentation_width' => [ 'suffix' => '', 'group' => 'launch_presentation', 'claim' => 'width', 'isarray' => false ], 'lis_person_contact_email_primary' => [ 'suffix' => '', 'group' => null, 'claim' => 'email', 'isarray' => false ], 'lis_person_name_family' => [ 'suffix' => '', 'group' => null, 'claim' => 'family_name', 'isarray' => false ], 'lis_person_name_full' => [ 'suffix' => '', 'group' => null, 'claim' => 'name', 'isarray' => false ], 'lis_person_name_given' => [ 'suffix' => '', 'group' => null, 'claim' => 'given_name', 'isarray' => false ], 'lis_person_sourcedid' => [ 'suffix' => '', 'group' => 'lis', 'claim' => 'person_sourcedid', 'isarray' => false ], 'user_id' => [ 'suffix' => '', 'group' => null, 'claim' => 'sub', 'isarray' => false ], 'user_image' => [ 'suffix' => '', 'group' => null, 'claim' => 'picture', 'isarray' => false ], 'roles' => [ 'suffix' => '', 'group' => '', 'claim' => 'roles', 'isarray' => true ], 'role_scope_mentor' => [ 'suffix' => '', 'group' => '', 'claim' => 'role_scope_mentor', 'isarray' => false ], 'deployment_id' => [ 'suffix' => '', 'group' => '', 'claim' => 'deployment_id', 'isarray' => false ], 'lti_message_type' => [ 'suffix' => '', 'group' => '', 'claim' => 'message_type', 'isarray' => false ], 'lti_version' => [ 'suffix' => '', 'group' => '', 'claim' => 'version', 'isarray' => false ], 'resource_link_description' => [ 'suffix' => '', 'group' => 'resource_link', 'claim' => 'description', 'isarray' => false ], 'resource_link_id' => [ 'suffix' => '', 'group' => 'resource_link', 'claim' => 'id', 'isarray' => false ], 'resource_link_title' => [ 'suffix' => '', 'group' => 'resource_link', 'claim' => 'title', 'isarray' => false ], 'tool_consumer_info_product_family_code' => [ 'suffix' => '', 'group' => 'tool_platform', 'claim' => 'family_code', 'isarray' => false ], 'tool_consumer_info_version' => [ 'suffix' => '', 'group' => 'tool_platform', 'claim' => 'version', 'isarray' => false ], 'tool_consumer_instance_contact_email' => [ 'suffix' => '', 'group' => 'tool_platform', 'claim' => 'contact_email', 'isarray' => false ], 'tool_consumer_instance_description' => [ 'suffix' => '', 'group' => 'tool_platform', 'claim' => 'description', 'isarray' => false ], 'tool_consumer_instance_guid' => [ 'suffix' => '', 'group' => 'tool_platform', 'claim' => 'guid', 'isarray' => false ], 'tool_consumer_instance_name' => [ 'suffix' => '', 'group' => 'tool_platform', 'claim' => 'name', 'isarray' => false ], 'tool_consumer_instance_url' => [ 'suffix' => '', 'group' => 'tool_platform', 'claim' => 'url', 'isarray' => false ], 'custom_context_memberships_url' => [ 'suffix' => 'nrps', 'group' => 'namesroleservice', 'claim' => 'context_memberships_url', 'isarray' => false ], 'custom_context_memberships_versions' => [ 'suffix' => 'nrps', 'group' => 'namesroleservice', 'claim' => 'service_versions', 'isarray' => true ], 'custom_gradebookservices_scope' => [ 'suffix' => 'ags', 'group' => 'endpoint', 'claim' => 'scope', 'isarray' => true ], 'custom_lineitems_url' => [ 'suffix' => 'ags', 'group' => 'endpoint', 'claim' => 'lineitems', 'isarray' => false ], 'custom_lineitem_url' => [ 'suffix' => 'ags', 'group' => 'endpoint', 'claim' => 'lineitem', 'isarray' => false ], 'custom_results_url' => [ 'suffix' => 'ags', 'group' => 'endpoint', 'claim' => 'results', 'isarray' => false ], 'custom_result_url' => [ 'suffix' => 'ags', 'group' => 'endpoint', 'claim' => 'result', 'isarray' => false ], 'custom_scores_url' => [ 'suffix' => 'ags', 'group' => 'endpoint', 'claim' => 'scores', 'isarray' => false ], 'custom_score_url' => [ 'suffix' => 'ags', 'group' => 'endpoint', 'claim' => 'score', 'isarray' => false ], 'lis_outcome_service_url' => [ 'suffix' => 'bos', 'group' => 'basicoutcomesservice', 'claim' => 'lis_outcome_service_url', 'isarray' => false ], 'lis_result_sourcedid' => [ 'suffix' => 'bos', 'group' => 'basicoutcomesservice', 'claim' => 'lis_result_sourcedid', 'isarray' => false ], ]; $this->assertEquals($mapping, lti_get_jwt_claim_mapping()); } /** * Test lti_build_standard_message(). */ public function test_lti_build_standard_message_institution_name_set() { global $CFG; $this->resetAfterTest(); $CFG->mod_lti_institution_name = 'some institution name lols'; $course = $this->getDataGenerator()->create_course(); $instance = $this->getDataGenerator()->create_module('lti', [ 'course' => $course->id, ] ); $message = lti_build_standard_message($instance, '2', LTI_VERSION_1); $this->assertEquals('moodle-2', $message['ext_lms']); $this->assertEquals('moodle', $message['tool_consumer_info_product_family_code']); $this->assertEquals(LTI_VERSION_1, $message['lti_version']); $this->assertEquals('basic-lti-launch-request', $message['lti_message_type']); $this->assertEquals('2', $message['tool_consumer_instance_guid']); $this->assertEquals('some institution name lols', $message['tool_consumer_instance_name']); $this->assertEquals('PHPUnit test site', $message['tool_consumer_instance_description']); } /** * Test lti_build_standard_message(). */ public function test_lti_build_standard_message_institution_name_not_set() { $this->resetAfterTest(); $course = $this->getDataGenerator()->create_course(); $instance = $this->getDataGenerator()->create_module('lti', [ 'course' => $course->id, ] ); $message = lti_build_standard_message($instance, '2', LTI_VERSION_2); $this->assertEquals('moodle-2', $message['ext_lms']); $this->assertEquals('moodle', $message['tool_consumer_info_product_family_code']); $this->assertEquals(LTI_VERSION_2, $message['lti_version']); $this->assertEquals('basic-lti-launch-request', $message['lti_message_type']); $this->assertEquals('2', $message['tool_consumer_instance_guid']); $this->assertEquals('phpunit', $message['tool_consumer_instance_name']); $this->assertEquals('PHPUnit test site', $message['tool_consumer_instance_description']); } /** * Test lti_verify_jwt_signature(). */ public function test_lti_verify_jwt_signature() { $this->resetAfterTest(); $this->setAdminUser(); // Create a tool type, associated with that proxy. $type = new stdClass(); $type->state = LTI_TOOL_STATE_CONFIGURED; $type->name = "Test tool"; $type->description = "Example description"; $type->baseurl = $this->getExternalTestFileUrl('/test.html'); $config = new stdClass(); $config->lti_publickey = '-----BEGIN PUBLIC KEY----- MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAnzyis1ZjfNB0bBgKFMSv vkTtwlvBsaJq7S5wA+kzeVOVpVWwkWdVha4s38XM/pa/yr47av7+z3VTmvDRyAHc aT92whREFpLv9cj5lTeJSibyr/Mrm/YtjCZVWgaOYIhwrXwKLqPr/11inWsAkfIy tvHWTxZYEcXLgAXFuUuaS3uF9gEiNQwzGTU1v0FqkqTBr4B8nW3HCN47XUu0t8Y0 e+lf4s4OxQawWD79J9/5d3Ry0vbV3Am1FtGJiJvOwRsIfVChDpYStTcHTCMqtvWb V6L11BWkpzGXSW4Hv43qa+GSYOD2QU68Mb59oSk2OB+BtOLpJofmbGEGgvmwyCI9 MwIDAQAB -----END PUBLIC KEY-----'; $typeid = lti_add_type($type, $config); lti_verify_jwt_signature($typeid, '', 'eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4g' . 'RG9lIiwiYWRtaW4iOnRydWUsImlhdCI6MTUxNjIzOTAyMn0.POstGetfAytaZS82wHcjoTyoqhMyxXiWdR7Nn7A29DNSl0EiXLdwJ6xC6AfgZWF1bOs' . 'S_TuYI3OG85AmiExREkrS6tDfTQ2B3WXlrr-wp5AokiRbz3_oB4OxG-W9KcEEbDRcZc0nH3L7LzYptiy1PtAylQGxHTWZXtGz4ht0bAecBgmpdgXMgu' . 'EIcoqPJ1n3pIWk_dUZegpqx0Lka21H6XxUTxiy8OcaarA8zdnPUnV6AmNP3ecFawIFYdvJB_cm-GvpCSbr8G8y_Mllj8f4x9nBH8pQux89_6gUY618iY' . 'v7tuPWBFfEbLxtF2pZS6YC1aSfLQxeNe8djT9YjpvRZA'); } /** * Test lti_verify_jwt_signature(). */ public function test_lti_verify_jwt_signature_with_lti2() { $this->resetAfterTest(); $this->setAdminUser(); // Create a tool proxy. $proxy = mod_lti_external::create_tool_proxy('Test proxy', $this->getExternalTestFileUrl('/test.html'), array(), array()); // Create a tool type, associated with that proxy. $type = new stdClass(); $type->state = LTI_TOOL_STATE_CONFIGURED; $type->name = "Test tool"; $type->description = "Example description"; $type->toolproxyid = $proxy->id; $type->baseurl = $this->getExternalTestFileUrl('/test.html'); $data = new stdClass(); $data->lti_contentitem = true; $typeid = lti_add_type($type, $data); $this->expectExceptionMessage('JWT security not supported with LTI 2'); lti_verify_jwt_signature($typeid, '', ''); } /** * Test lti_verify_jwt_signature(). */ public function test_lti_verify_jwt_signature_no_consumer_key() { $this->resetAfterTest(); $this->setAdminUser(); // Create a tool type, associated with that proxy. $type = new stdClass(); $type->state = LTI_TOOL_STATE_CONFIGURED; $type->name = "Test tool"; $type->description = "Example description"; $type->clientid = 'consumerkey'; $type->baseurl = $this->getExternalTestFileUrl('/test.html'); $config = new stdClass(); $typeid = lti_add_type($type, $config); $this->expectExceptionMessage(get_string('errorincorrectconsumerkey', 'mod_lti')); lti_verify_jwt_signature($typeid, '', ''); } /** * Test lti_verify_jwt_signature(). */ public function test_lti_verify_jwt_signature_no_public_key() { $this->resetAfterTest(); $this->setAdminUser(); // Create a tool type, associated with that proxy. $type = new stdClass(); $type->state = LTI_TOOL_STATE_CONFIGURED; $type->name = "Test tool"; $type->description = "Example description"; $type->clientid = 'consumerkey'; $type->baseurl = $this->getExternalTestFileUrl('/test.html'); $config = new stdClass(); $typeid = lti_add_type($type, $config); $this->expectExceptionMessage('No public key configured'); lti_verify_jwt_signature($typeid, 'consumerkey', ''); } /** * Test lti_convert_content_items(). */ public function test_lti_convert_content_items() { $contentitems = []; $contentitems[] = [ 'type' => 'ltiResourceLink', 'url' => 'http://example.com/messages/launch', 'title' => 'Test title', 'text' => 'Test text', 'frame' => [] ]; $contentitems = json_encode($contentitems); $json = lti_convert_content_items($contentitems); $jsondecode = json_decode($json); $strcontext = '@context'; $strgraph = '@graph'; $strtype = '@type'; $objgraph = new stdClass(); $objgraph->url = 'http://example.com/messages/launch'; $objgraph->title = 'Test title'; $objgraph->text = 'Test text'; $objgraph->frame = []; $objgraph->{$strtype} = 'LtiLinkItem'; $objgraph->mediaType = 'application\/vnd.ims.lti.v1.ltilink'; $expected = new stdClass(); $expected->{$strcontext} = 'http://purl.imsglobal.org/ctx/lti/v1/ContentItem'; $expected->{$strgraph} = []; $expected->{$strgraph}[] = $objgraph; $this->assertEquals($expected, $jsondecode); } /** * Test lti_sign_jwt(). */ public function test_lti_sign_jwt() { $this->resetAfterTest(); $this->setAdminUser(); // Create a tool type, associated with that proxy. $type = new stdClass(); $type->state = LTI_TOOL_STATE_CONFIGURED; $type->name = "Test tool"; $type->description = "Example description"; $type->clientid = 'consumerkey'; $type->baseurl = $this->getExternalTestFileUrl('/test.html'); $config = new stdClass(); $typeid = lti_add_type($type, $config); $params = []; $params['roles'] = 'urn:lti:role:ims/lis/testrole,' . 'urn:lti:instrole:ims/lis/testinstrole,' . 'urn:lti:sysrole:ims/lis/testsysrole,' . 'hi'; $params['accept_copy_advice'] = [ 'suffix' => 'dl', 'group' => 'deep_linking_settings', 'claim' => 'accept_copy_advice', 'isarray' => false ]; $params['lis_result_sourcedid'] = [ 'suffix' => 'bos', 'group' => 'basicoutcomesservice', 'claim' => 'lis_result_sourcedid', 'isarray' => false ]; $endpoint = 'https://www.example.com/moodle'; $oauthconsumerkey = 'consumerkey'; $nonce = ''; $jwt = lti_sign_jwt($params, $endpoint, $oauthconsumerkey, $typeid, $nonce); $this->assertArrayHasKey('id_token', $jwt); $this->assertNotEmpty($jwt['id_token']); } /** * Test lti_convert_from_jwt() */ public function test_lti_convert_from_jwt() { $this->resetAfterTest(); $this->setAdminUser(); // Create a tool type, associated with that proxy. $type = new stdClass(); $type->state = LTI_TOOL_STATE_CONFIGURED; $type->name = "Test tool"; $type->description = "Example description"; $type->clientid = 'sso.example.com'; $type->baseurl = $this->getExternalTestFileUrl('/test.html'); $config = new stdClass(); $config->lti_publickey = '-----BEGIN PUBLIC KEY----- MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAnzyis1ZjfNB0bBgKFMSv vkTtwlvBsaJq7S5wA+kzeVOVpVWwkWdVha4s38XM/pa/yr47av7+z3VTmvDRyAHc aT92whREFpLv9cj5lTeJSibyr/Mrm/YtjCZVWgaOYIhwrXwKLqPr/11inWsAkfIy tvHWTxZYEcXLgAXFuUuaS3uF9gEiNQwzGTU1v0FqkqTBr4B8nW3HCN47XUu0t8Y0 e+lf4s4OxQawWD79J9/5d3Ry0vbV3Am1FtGJiJvOwRsIfVChDpYStTcHTCMqtvWb V6L11BWkpzGXSW4Hv43qa+GSYOD2QU68Mb59oSk2OB+BtOLpJofmbGEGgvmwyCI9 MwIDAQAB -----END PUBLIC KEY-----'; $typeid = lti_add_type($type, $config); $params = lti_convert_from_jwt($typeid, 'eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwib' . 'mFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWUsImlhdCI6MTUxNjIzOTAyMiwiaXNzIjoic3NvLmV4YW1wbGUuY29tIn0.XURVvEb5ueAvFsn-S9EB' . 'BSfKbsgUzfRQqmJ6evlrYdx7sXWoZXw1nYjaLTg-mawvBr7MVvrdG9qh6oN8OfkQ7bfMwiz4tjBMJ4B4q_sig5BDYIKwMNjZL5GGCBs89FQrgqZBhxw' . '3exTjPBEn69__w40o0AhCsBohPMh0ZsAyHug5dhm8vIuOP667repUJzM8uKCD6L4bEL6vQE8EwU6WQOmfJ2SDmRs-1pFkiaFd6hmPn6AVX7ETtzQmlT' . 'X-nXe9weQjU1lH4AQG2Yfnn-7lS94bt6E76Zt-XndP3IY7W48EpnRfUK9Ff1fZlomT4MPahdNP1eP8gT2iMz7vYpCfmA'); $this->assertEquals('sso.example.com', $params['oauth_consumer_key']); $this->assertEquals('John Doe', $params['lis_person_name_full']); } /** * Test lti_get_permitted_service_scopes(). */ public function test_lti_get_permitted_service_scopes() { $this->resetAfterTest(); $this->setAdminUser(); // Create a tool type, associated with that proxy. $type = new stdClass(); $type->state = LTI_TOOL_STATE_CONFIGURED; $type->name = "Test tool"; $type->description = "Example description"; $type->baseurl = $this->getExternalTestFileUrl('/test.html'); $typeconfig = new stdClass(); $typeconfig->lti_acceptgrades = true; $typeid = lti_add_type($type, $typeconfig); $tool = lti_get_type($typeid); $config = lti_get_type_config($typeid); $permittedscopes = lti_get_permitted_service_scopes($tool, $config); $expected = [ 'https://purl.imsglobal.org/spec/lti-bo/scope/basicoutcome' ]; $this->assertEquals($expected, $permittedscopes); } /** * Test get_tool_type_config(). */ public function test_get_tool_type_config() { $this->resetAfterTest(); $this->setAdminUser(); // Create a tool type, associated with that proxy. $type = new stdClass(); $type->state = LTI_TOOL_STATE_CONFIGURED; $type->name = "Test tool"; $type->description = "Example description"; $type->clientid = "Test client ID"; $type->baseurl = $this->getExternalTestFileUrl('/test.html'); $config = new stdClass(); $typeid = lti_add_type($type, $config); $type = lti_get_type($typeid); $typeconfig = get_tool_type_config($type); $this->assertEquals('https://www.example.com/moodle', $typeconfig['platformid']); $this->assertEquals($type->clientid, $typeconfig['clientid']); $this->assertEquals($typeid, $typeconfig['deploymentid']); $this->assertEquals('https://www.example.com/moodle/mod/lti/certs.php', $typeconfig['publickeyseturl']); $this->assertEquals('https://www.example.com/moodle/mod/lti/token.php', $typeconfig['accesstokenurl']); $this->assertEquals('https://www.example.com/moodle/mod/lti/auth.php', $typeconfig['authrequesturl']); } /** * Test lti_new_access_token(). */ public function test_lti_new_access_token() { global $DB; $this->resetAfterTest(); $this->setAdminUser(); // Create a tool type, associated with that proxy. $type = new stdClass(); $type->state = LTI_TOOL_STATE_CONFIGURED; $type->name = "Test tool"; $type->description = "Example description"; $type->clientid = "Test client ID"; $type->baseurl = $this->getExternalTestFileUrl('/test.html'); $config = new stdClass(); $typeid = lti_add_type($type, $config); $scopes = ['lti_some_scope', 'lti_another_scope']; lti_new_access_token($typeid, $scopes); $token = $DB->get_records('lti_access_tokens'); $this->assertEquals(1, count($token)); $token = reset($token); $this->assertEquals($typeid, $token->typeid); $this->assertEquals(json_encode(array_values($scopes)), $token->scope); $this->assertEquals($token->timecreated + LTI_ACCESS_TOKEN_LIFE, $token->validuntil); $this->assertNull($token->lastaccess); } }