/** * Test view_scorm */ public function test_view_scorm() { global $DB; $this->resetAfterTest(true); $this->setAdminUser(); // Setup test data. $course = $this->getDataGenerator()->create_course(); $scorm = $this->getDataGenerator()->create_module('scorm', array('course' => $course->id)); $context = context_module::instance($scorm->cmid); $cm = get_coursemodule_from_instance('scorm', $scorm->id); // Test invalid instance id. try { mod_scorm_external::view_scorm(0); $this->fail('Exception expected due to invalid mod_scorm instance id.'); } catch (moodle_exception $e) { $this->assertEquals('invalidrecord', $e->errorcode); } // Test not-enrolled user. $user = self::getDataGenerator()->create_user(); $this->setUser($user); try { mod_scorm_external::view_scorm($scorm->id); $this->fail('Exception expected due to not enrolled user.'); } catch (moodle_exception $e) { $this->assertEquals('requireloginerror', $e->errorcode); } // Test user with full capabilities. $studentrole = $DB->get_record('role', array('shortname' => 'student')); $this->getDataGenerator()->enrol_user($user->id, $course->id, $studentrole->id); // Trigger and capture the event. $sink = $this->redirectEvents(); $result = mod_scorm_external::view_scorm($scorm->id); $result = external_api::clean_returnvalue(mod_scorm_external::view_scorm_returns(), $result); $events = $sink->get_events(); $this->assertCount(1, $events); $event = array_shift($events); // Checking that the event contains the expected values. $this->assertInstanceOf('\\mod_scorm\\event\\course_module_viewed', $event); $this->assertEquals($context, $event->get_context()); $moodleurl = new \moodle_url('/mod/scorm/view.php', array('id' => $cm->id)); $this->assertEquals($moodleurl, $event->get_url()); $this->assertEventContextNotUsed($event); $this->assertNotEmpty($event->get_name()); }
/** * Test launch_sco */ public function test_launch_sco() { global $DB; // Test invalid instance id. try { mod_scorm_external::launch_sco(0); $this->fail('Exception expected due to invalid mod_scorm instance id.'); } catch (moodle_exception $e) { $this->assertEquals('invalidrecord', $e->errorcode); } // Test not-enrolled user. $user = self::getDataGenerator()->create_user(); $this->setUser($user); try { mod_scorm_external::launch_sco($this->scorm->id); $this->fail('Exception expected due to not enrolled user.'); } catch (moodle_exception $e) { $this->assertEquals('requireloginerror', $e->errorcode); } // Test user with full capabilities. $this->setUser($this->student); // Trigger and capture the event. $sink = $this->redirectEvents(); $scoes = scorm_get_scoes($this->scorm->id); foreach ($scoes as $sco) { // Find launchable SCO. if ($sco->launch != '') { break; } } $result = mod_scorm_external::launch_sco($this->scorm->id, $sco->id); $result = external_api::clean_returnvalue(mod_scorm_external::launch_sco_returns(), $result); $events = $sink->get_events(); $this->assertCount(1, $events); $event = array_shift($events); // Checking that the event contains the expected values. $this->assertInstanceOf('\\mod_scorm\\event\\sco_launched', $event); $this->assertEquals($this->context, $event->get_context()); $moodleurl = new \moodle_url('/mod/scorm/player.php', array('id' => $this->cm->id, 'scoid' => $sco->id)); $this->assertEquals($moodleurl, $event->get_url()); $this->assertEventContextNotUsed($event); $this->assertNotEmpty($event->get_name()); // Invalid SCO. try { mod_scorm_external::launch_sco($this->scorm->id, -1); $this->fail('Exception expected due to invalid SCO id.'); } catch (moodle_exception $e) { $this->assertEquals('cannotfindsco', $e->errorcode); } }
public function test_mod_scorm_get_scorms_by_courses() { global $DB; $this->resetAfterTest(true); // Create users. $student = self::getDataGenerator()->create_user(); $teacher = self::getDataGenerator()->create_user(); // Set to the student user. self::setUser($student); // Create courses to add the modules. $course1 = self::getDataGenerator()->create_course(); $course2 = self::getDataGenerator()->create_course(); // First scorm. $record = new stdClass(); $record->introformat = FORMAT_HTML; $record->course = $course1->id; $record->hidetoc = 2; $record->displayattemptstatus = 2; $record->skipview = 2; $scorm1 = self::getDataGenerator()->create_module('scorm', $record); // Second scorm. $record = new stdClass(); $record->introformat = FORMAT_HTML; $record->course = $course2->id; $scorm2 = self::getDataGenerator()->create_module('scorm', $record); $studentrole = $DB->get_record('role', array('shortname' => 'student')); $teacherrole = $DB->get_record('role', array('shortname' => 'editingteacher')); // Users enrolments. $this->getDataGenerator()->enrol_user($student->id, $course1->id, $studentrole->id, 'manual'); $this->getDataGenerator()->enrol_user($teacher->id, $course1->id, $teacherrole->id, 'manual'); // Execute real Moodle enrolment as we'll call unenrol() method on the instance later. $enrol = enrol_get_plugin('manual'); $enrolinstances = enrol_get_instances($course2->id, true); foreach ($enrolinstances as $courseenrolinstance) { if ($courseenrolinstance->enrol == "manual") { $instance2 = $courseenrolinstance; break; } } $enrol->enrol_user($instance2, $student->id, $studentrole->id); $returndescription = mod_scorm_external::get_scorms_by_courses_returns(); // Test open/close dates. $timenow = time(); $scorm1->timeopen = $timenow - DAYSECS; $scorm1->timeclose = $timenow - HOURSECS; $DB->update_record('scorm', $scorm1); $result = mod_scorm_external::get_scorms_by_courses(array($course1->id)); $result = external_api::clean_returnvalue($returndescription, $result); $this->assertCount(1, $result['warnings']); // Only 'id', 'coursemodule', 'course', 'name', 'intro', 'introformat'. $this->assertCount(6, $result['scorms'][0]); $this->assertEquals('expired', $result['warnings'][0]['warningcode']); $scorm1->timeopen = $timenow + DAYSECS; $scorm1->timeclose = $scorm1->timeopen + DAYSECS; $DB->update_record('scorm', $scorm1); $result = mod_scorm_external::get_scorms_by_courses(array($course1->id)); $result = external_api::clean_returnvalue($returndescription, $result); $this->assertCount(1, $result['warnings']); // Only 'id', 'coursemodule', 'course', 'name', 'intro', 'introformat'. $this->assertCount(6, $result['scorms'][0]); $this->assertEquals('notopenyet', $result['warnings'][0]['warningcode']); // Reset times. $scorm1->timeopen = 0; $scorm1->timeclose = 0; $DB->update_record('scorm', $scorm1); // Create what we expect to be returned when querying the two courses. // First for the student user. $expectedfields = array('id', 'coursemodule', 'course', 'name', 'intro', 'introformat', 'version', 'maxgrade', 'grademethod', 'whatgrade', 'maxattempt', 'forcecompleted', 'forcenewattempt', 'lastattemptlock', 'displayattemptstatus', 'displaycoursestructure', 'sha1hash', 'md5hash', 'revision', 'launch', 'skipview', 'hidebrowse', 'hidetoc', 'nav', 'navpositionleft', 'navpositiontop', 'auto', 'popup', 'width', 'height', 'timeopen', 'timeclose', 'displayactivityname', 'packagesize', 'packageurl', 'scormtype', 'reference'); // Add expected coursemodule and data. $scorm1->coursemodule = $scorm1->cmid; $scorm1->section = 0; $scorm1->visible = true; $scorm1->groupmode = 0; $scorm1->groupingid = 0; $scorm2->coursemodule = $scorm2->cmid; $scorm2->section = 0; $scorm2->visible = true; $scorm2->groupmode = 0; $scorm2->groupingid = 0; // SCORM size. The same package is used in both SCORMs. $scormcontext1 = context_module::instance($scorm1->cmid); $scormcontext2 = context_module::instance($scorm2->cmid); $fs = get_file_storage(); $packagefile = $fs->get_file($scormcontext1->id, 'mod_scorm', 'package', 0, '/', $scorm1->reference); $packagesize = $packagefile->get_filesize(); $packageurl1 = moodle_url::make_webservice_pluginfile_url($scormcontext1->id, 'mod_scorm', 'package', 0, '/', $scorm1->reference)->out(false); $packageurl2 = moodle_url::make_webservice_pluginfile_url($scormcontext2->id, 'mod_scorm', 'package', 0, '/', $scorm2->reference)->out(false); $scorm1->packagesize = $packagesize; $scorm1->packageurl = $packageurl1; $scorm2->packagesize = $packagesize; $scorm2->packageurl = $packageurl2; // Forced to boolean as it is returned as PARAM_BOOL. $protectpackages = (bool) get_config('scorm', 'protectpackagedownloads'); $expected1 = array('protectpackagedownloads' => $protectpackages); $expected2 = array('protectpackagedownloads' => $protectpackages); foreach ($expectedfields as $field) { // Since we return the fields used as boolean as PARAM_BOOL instead PARAM_INT we need to force casting here. // From the returned fields definition we obtain the type expected for the field. $fieldtype = $returndescription->keys['scorms']->content->keys[$field]->type; if ($fieldtype == PARAM_BOOL) { $expected1[$field] = (bool) $scorm1->{$field}; $expected2[$field] = (bool) $scorm2->{$field}; } else { $expected1[$field] = $scorm1->{$field}; $expected2[$field] = $scorm2->{$field}; } } $expectedscorms = array(); $expectedscorms[] = $expected2; $expectedscorms[] = $expected1; // Call the external function passing course ids. $result = mod_scorm_external::get_scorms_by_courses(array($course2->id, $course1->id)); $result = external_api::clean_returnvalue($returndescription, $result); $this->assertEquals($expectedscorms, $result['scorms']); // Call the external function without passing course id. $result = mod_scorm_external::get_scorms_by_courses(); $result = external_api::clean_returnvalue($returndescription, $result); $this->assertEquals($expectedscorms, $result['scorms']); // Unenrol user from second course and alter expected scorms. $enrol->unenrol_user($instance2, $student->id); array_shift($expectedscorms); // Call the external function without passing course id. $result = mod_scorm_external::get_scorms_by_courses(); $result = external_api::clean_returnvalue($returndescription, $result); $this->assertEquals($expectedscorms, $result['scorms']); // Call for the second course we unenrolled the user from, expected warning. $result = mod_scorm_external::get_scorms_by_courses(array($course2->id)); $this->assertCount(1, $result['warnings']); $this->assertEquals('1', $result['warnings'][0]['warningcode']); $this->assertEquals($course2->id, $result['warnings'][0]['itemid']); // Now, try as a teacher for getting all the additional fields. self::setUser($teacher); $additionalfields = array('updatefreq', 'timemodified', 'options', 'completionstatusrequired', 'completionscorerequired', 'autocommit', 'section', 'visible', 'groupmode', 'groupingid'); foreach ($additionalfields as $field) { $fieldtype = $returndescription->keys['scorms']->content->keys[$field]->type; if ($fieldtype == PARAM_BOOL) { $expectedscorms[0][$field] = (bool) $scorm1->{$field}; } else { $expectedscorms[0][$field] = $scorm1->{$field}; } } $result = mod_scorm_external::get_scorms_by_courses(); $result = external_api::clean_returnvalue($returndescription, $result); $this->assertEquals($expectedscorms, $result['scorms']); // Even with the SCORM closed in time teacher should retrieve the info. $scorm1->timeopen = $timenow - DAYSECS; $scorm1->timeclose = $timenow - HOURSECS; $DB->update_record('scorm', $scorm1); $expectedscorms[0]['timeopen'] = $scorm1->timeopen; $expectedscorms[0]['timeclose'] = $scorm1->timeclose; $result = mod_scorm_external::get_scorms_by_courses(); $result = external_api::clean_returnvalue($returndescription, $result); $this->assertEquals($expectedscorms, $result['scorms']); // Admin also should get all the information. self::setAdminUser(); $result = mod_scorm_external::get_scorms_by_courses(array($course1->id)); $result = external_api::clean_returnvalue($returndescription, $result); $this->assertEquals($expectedscorms, $result['scorms']); }
/** * Test get scorm sco tracks */ public function test_mod_scorm_get_scorm_sco_tracks() { global $DB; $this->resetAfterTest(true); // Create users. $student = self::getDataGenerator()->create_user(); $otherstudent = self::getDataGenerator()->create_user(); $teacher = self::getDataGenerator()->create_user(); // Set to the student user. self::setUser($student); // Create courses to add the modules. $course = self::getDataGenerator()->create_course(); // First scorm. $record = new stdClass(); $record->course = $course->id; $scorm = self::getDataGenerator()->create_module('scorm', $record); // Users enrolments. $studentrole = $DB->get_record('role', array('shortname' => 'student')); $teacherrole = $DB->get_record('role', array('shortname' => 'teacher')); $this->getDataGenerator()->enrol_user($student->id, $course->id, $studentrole->id, 'manual'); $this->getDataGenerator()->enrol_user($teacher->id, $course->id, $teacherrole->id, 'manual'); // Create attempts. $scoes = scorm_get_scoes($scorm->id); $sco = array_shift($scoes); scorm_insert_track($student->id, $scorm->id, $sco->id, 1, 'cmi.core.lesson_status', 'completed'); scorm_insert_track($student->id, $scorm->id, $sco->id, 1, 'cmi.core.score.raw', '80'); scorm_insert_track($student->id, $scorm->id, $sco->id, 2, 'cmi.core.lesson_status', 'completed'); $result = mod_scorm_external::get_scorm_sco_tracks($sco->id, $student->id, 1); $result = external_api::clean_returnvalue(mod_scorm_external::get_scorm_sco_tracks_returns(), $result); // 7 default elements + 2 custom ones. $this->assertCount(9, $result['data']['tracks']); $this->assertEquals(1, $result['data']['attempt']); // Find our tracking data. $found = 0; foreach ($result['data']['tracks'] as $userdata) { if ($userdata['element'] == 'cmi.core.lesson_status' and $userdata['value'] == 'completed') { $found++; } if ($userdata['element'] == 'cmi.core.score.raw' and $userdata['value'] == '80') { $found++; } } $this->assertEquals(2, $found); // Capabilities check. try { mod_scorm_external::get_scorm_sco_tracks($sco->id, $otherstudent->id); $this->fail('Exception expected due to invalid instance id.'); } catch (required_capability_exception $e) { $this->assertEquals('nopermissions', $e->errorcode); } self::setUser($teacher); // Ommit the attempt parameter, the function should calculate the last attempt. $result = mod_scorm_external::get_scorm_sco_tracks($sco->id, $student->id); $result = external_api::clean_returnvalue(mod_scorm_external::get_scorm_sco_tracks_returns(), $result); // 7 default elements + 1 custom one. $this->assertCount(8, $result['data']['tracks']); $this->assertEquals(2, $result['data']['attempt']); // Test invalid instance id. try { mod_scorm_external::get_scorm_sco_tracks(0, 1); $this->fail('Exception expected due to invalid instance id.'); } catch (moodle_exception $e) { $this->assertEquals('cannotfindsco', $e->errorcode); } // Invalid user. try { mod_scorm_external::get_scorm_sco_tracks($sco->id, 0); $this->fail('Exception expected due to invalid instance id.'); } catch (moodle_exception $e) { $this->assertEquals('invaliduser', $e->errorcode); } }