528 lines
18 KiB
JavaScript
528 lines
18 KiB
JavaScript
import {expect} from 'chai';
|
|
import {describe, it} from 'mocha';
|
|
import * as h from './api_helpers';
|
|
import ErrorCodes from '../src/constants/error_codes';
|
|
import Scorm2004API from '../src/Scorm2004API';
|
|
import {scorm2004_values} from './field_values';
|
|
|
|
const scorm2004_error_codes = ErrorCodes.scorm2004;
|
|
|
|
const api = (settings = {}, startingData = {}) => {
|
|
const API = new Scorm2004API(settings);
|
|
API.apiLogLevel = 1;
|
|
if (startingData) {
|
|
API.startingData = startingData;
|
|
}
|
|
return API;
|
|
};
|
|
const apiInitialized = (startingData) => {
|
|
const API = api();
|
|
API.loadFromJSON(startingData, '');
|
|
API.lmsInitialize();
|
|
return API;
|
|
};
|
|
|
|
describe('SCORM 2004 API Tests', () => {
|
|
describe('SetValue()', () => {
|
|
h.checkValidValues({
|
|
api: apiInitialized(),
|
|
fieldName: 'cmi.score.scaled',
|
|
validValues: scorm2004_values.validScaledRange,
|
|
invalidValues: scorm2004_values.invalidScaledRange,
|
|
});
|
|
h.checkValidValues({
|
|
api: apiInitialized(),
|
|
fieldName: 'cmi.score.raw',
|
|
validValues: scorm2004_values.validScoreRange,
|
|
invalidValues: scorm2004_values.invalidScoreRange,
|
|
});
|
|
h.checkValidValues({
|
|
api: apiInitialized(),
|
|
fieldName: 'cmi.score.min',
|
|
validValues: scorm2004_values.validScoreRange,
|
|
invalidValues: scorm2004_values.invalidScoreRange,
|
|
});
|
|
h.checkValidValues({
|
|
api: apiInitialized(),
|
|
fieldName: 'cmi.score.max',
|
|
validValues: scorm2004_values.validScoreRange,
|
|
invalidValues: scorm2004_values.invalidScoreRange,
|
|
});
|
|
});
|
|
|
|
describe('setCMIValue()', () => {
|
|
describe('Invalid Sets - Should Always Fail', () => {
|
|
h.checkSetCMIValue({
|
|
api: api(),
|
|
fieldName: 'cmi._version',
|
|
expectedError: scorm2004_error_codes.READ_ONLY_ELEMENT,
|
|
});
|
|
h.checkSetCMIValue({
|
|
api: api(),
|
|
fieldName: 'cmi._children',
|
|
expectedError: scorm2004_error_codes.READ_ONLY_ELEMENT,
|
|
});
|
|
h.checkSetCMIValue({
|
|
api: api(),
|
|
fieldName: 'cmi.comments_from_learner._children',
|
|
expectedError: scorm2004_error_codes.READ_ONLY_ELEMENT,
|
|
});
|
|
h.checkSetCMIValue({
|
|
api: api(),
|
|
fieldName: 'cmi.comments_from_learner._count',
|
|
expectedError: scorm2004_error_codes.READ_ONLY_ELEMENT,
|
|
});
|
|
h.checkSetCMIValue({
|
|
api: api(),
|
|
fieldName: 'cmi.comments_from_lms._children',
|
|
expectedError: scorm2004_error_codes.READ_ONLY_ELEMENT,
|
|
});
|
|
h.checkSetCMIValue({
|
|
api: api(),
|
|
fieldName: 'cmi.comments_from_lms._count',
|
|
expectedError: scorm2004_error_codes.READ_ONLY_ELEMENT,
|
|
});
|
|
h.checkSetCMIValue({
|
|
api: api(),
|
|
fieldName: 'cmi.interactions._children',
|
|
expectedError: scorm2004_error_codes.READ_ONLY_ELEMENT,
|
|
});
|
|
h.checkSetCMIValue({
|
|
api: api(),
|
|
fieldName: 'cmi.interactions._count',
|
|
expectedError: scorm2004_error_codes.READ_ONLY_ELEMENT,
|
|
});
|
|
h.checkSetCMIValue({
|
|
api: api(),
|
|
fieldName: 'cmi.interactions.0.objectives._count',
|
|
expectedError: scorm2004_error_codes.READ_ONLY_ELEMENT,
|
|
});
|
|
h.checkSetCMIValue({
|
|
api: api(),
|
|
fieldName: 'cmi.interactions.0.correct_responses._count',
|
|
expectedError: scorm2004_error_codes.READ_ONLY_ELEMENT,
|
|
});
|
|
h.checkSetCMIValue({
|
|
api: api(),
|
|
fieldName: 'cmi.learner_preference._children',
|
|
expectedError: scorm2004_error_codes.READ_ONLY_ELEMENT,
|
|
});
|
|
h.checkSetCMIValue({
|
|
api: api(),
|
|
fieldName: 'cmi.objectives._children',
|
|
expectedError: scorm2004_error_codes.READ_ONLY_ELEMENT,
|
|
});
|
|
h.checkSetCMIValue({
|
|
api: api(),
|
|
fieldName: 'cmi.objectives._count',
|
|
expectedError: scorm2004_error_codes.READ_ONLY_ELEMENT,
|
|
});
|
|
h.checkSetCMIValue({
|
|
api: api(),
|
|
fieldName: 'cmi.objectives.0.score._children',
|
|
expectedError: scorm2004_error_codes.READ_ONLY_ELEMENT,
|
|
});
|
|
h.checkSetCMIValue({
|
|
api: api(),
|
|
fieldName: 'cmi.score._children',
|
|
expectedError: scorm2004_error_codes.READ_ONLY_ELEMENT,
|
|
});
|
|
});
|
|
|
|
describe('Invalid Sets - Should Fail After Initialization', () => {
|
|
h.checkSetCMIValue({
|
|
api: apiInitialized(),
|
|
fieldName: 'cmi.completion_threshold',
|
|
expectedError: scorm2004_error_codes.READ_ONLY_ELEMENT,
|
|
});
|
|
h.checkSetCMIValue({
|
|
api: apiInitialized(),
|
|
fieldName: 'cmi.credit',
|
|
expectedError: scorm2004_error_codes.READ_ONLY_ELEMENT,
|
|
});
|
|
h.checkSetCMIValue({
|
|
api: apiInitialized(),
|
|
fieldName: 'cmi.entry',
|
|
expectedError: scorm2004_error_codes.READ_ONLY_ELEMENT,
|
|
});
|
|
h.checkSetCMIValue({
|
|
api: apiInitialized(),
|
|
fieldName: 'cmi.launch_data',
|
|
expectedError: scorm2004_error_codes.READ_ONLY_ELEMENT,
|
|
});
|
|
h.checkSetCMIValue({
|
|
api: apiInitialized(),
|
|
fieldName: 'cmi.learner_id',
|
|
expectedError: scorm2004_error_codes.READ_ONLY_ELEMENT,
|
|
});
|
|
h.checkSetCMIValue({
|
|
api: apiInitialized(),
|
|
fieldName: 'cmi.learner_name',
|
|
expectedError: scorm2004_error_codes.READ_ONLY_ELEMENT,
|
|
});
|
|
h.checkSetCMIValue({
|
|
api: apiInitialized(),
|
|
fieldName: 'cmi.max_time_allowed',
|
|
expectedError: scorm2004_error_codes.READ_ONLY_ELEMENT,
|
|
});
|
|
h.checkSetCMIValue({
|
|
api: apiInitialized(),
|
|
fieldName: 'cmi.mode',
|
|
expectedError: scorm2004_error_codes.READ_ONLY_ELEMENT,
|
|
});
|
|
h.checkSetCMIValue({
|
|
api: apiInitialized(),
|
|
fieldName: 'cmi.scaled_passing_score',
|
|
expectedError: scorm2004_error_codes.READ_ONLY_ELEMENT,
|
|
});
|
|
h.checkSetCMIValue({
|
|
api: apiInitialized(),
|
|
fieldName: 'cmi.time_limit_action',
|
|
expectedError: scorm2004_error_codes.READ_ONLY_ELEMENT,
|
|
});
|
|
h.checkSetCMIValue({
|
|
api: apiInitialized(),
|
|
fieldName: 'cmi.total_time',
|
|
expectedError: scorm2004_error_codes.READ_ONLY_ELEMENT,
|
|
});
|
|
h.checkSetCMIValue({
|
|
api: apiInitialized(),
|
|
fieldName: 'cmi.comments_from_lms.0.comment',
|
|
expectedError: scorm2004_error_codes.READ_ONLY_ELEMENT,
|
|
});
|
|
h.checkSetCMIValue({
|
|
api: apiInitialized(),
|
|
fieldName: 'cmi.comments_from_lms.0.location',
|
|
expectedError: scorm2004_error_codes.READ_ONLY_ELEMENT,
|
|
});
|
|
h.checkSetCMIValue({
|
|
api: apiInitialized(),
|
|
fieldName: 'cmi.comments_from_lms.0.timestamp',
|
|
expectedError: scorm2004_error_codes.READ_ONLY_ELEMENT,
|
|
});
|
|
});
|
|
});
|
|
|
|
describe('GetValue()', () => {
|
|
describe('Invalid Properties - Should Always Fail', () => {
|
|
h.checkLMSGetValue({
|
|
api: apiInitialized(),
|
|
fieldName: 'cmi.core.close',
|
|
expectedError: scorm2004_error_codes.UNDEFINED_DATA_MODEL,
|
|
errorThrown: false,
|
|
});
|
|
h.checkLMSGetValue({
|
|
api: apiInitialized(),
|
|
fieldName: 'cmi.core.exit',
|
|
expectedError: scorm2004_error_codes.UNDEFINED_DATA_MODEL,
|
|
errorThrown: false,
|
|
});
|
|
h.checkLMSGetValue({
|
|
api: apiInitialized(),
|
|
fieldName: 'cmi.core.entry',
|
|
expectedError: scorm2004_error_codes.UNDEFINED_DATA_MODEL,
|
|
errorThrown: false,
|
|
});
|
|
});
|
|
|
|
describe('Write-Only Properties - Should Always Fail', () => {
|
|
h.checkLMSGetValue({
|
|
api: apiInitialized(),
|
|
fieldName: 'cmi.exit',
|
|
expectedError: scorm2004_error_codes.WRITE_ONLY_ELEMENT,
|
|
});
|
|
h.checkLMSGetValue({
|
|
api: apiInitialized(),
|
|
fieldName: 'cmi.session_time',
|
|
expectedError: scorm2004_error_codes.WRITE_ONLY_ELEMENT,
|
|
});
|
|
});
|
|
});
|
|
|
|
describe('SetValue()', () => {
|
|
describe('Uninitialized - Should Fail', () => {
|
|
h.checkLMSSetValue({
|
|
api: api(),
|
|
fieldName: 'cmi.objectives.0.id',
|
|
expectedError: scorm2004_error_codes.STORE_BEFORE_INIT,
|
|
});
|
|
h.checkLMSSetValue({
|
|
api: api(),
|
|
fieldName: 'cmi.interactions.0.id',
|
|
expectedError: scorm2004_error_codes.STORE_BEFORE_INIT,
|
|
});
|
|
h.checkLMSSetValue({
|
|
api: api(),
|
|
fieldName: 'cmi.comments_from_learner.0.comment',
|
|
expectedError: scorm2004_error_codes.STORE_BEFORE_INIT,
|
|
});
|
|
h.checkLMSSetValue({
|
|
api: api(),
|
|
fieldName: 'cmi.comments_from_lms.0.comment',
|
|
expectedError: scorm2004_error_codes.STORE_BEFORE_INIT,
|
|
});
|
|
});
|
|
|
|
describe('Initialized - Should Succeed', () => {
|
|
h.checkLMSSetValue({
|
|
api: apiInitialized(),
|
|
fieldName: 'cmi.objectives.0.id',
|
|
valueToTest: 'AAA',
|
|
errorThrown: false,
|
|
});
|
|
h.checkLMSSetValue({
|
|
api: apiInitialized(),
|
|
fieldName: 'cmi.interactions.0.id',
|
|
valueToTest: 'AAA',
|
|
errorThrown: false,
|
|
});
|
|
h.checkLMSSetValue({
|
|
api: apiInitialized(),
|
|
fieldName: 'cmi.comments_from_learner.0.comment',
|
|
valueToTest: 'comment',
|
|
errorThrown: false,
|
|
});
|
|
h.checkLMSSetValue({
|
|
api: apiInitialized(),
|
|
fieldName: 'cmi.comments_from_learner.0.location',
|
|
valueToTest: 'location',
|
|
errorThrown: false,
|
|
});
|
|
h.checkLMSSetValue({
|
|
api: apiInitialized(),
|
|
fieldName: 'cmi.comments_from_learner.0.timestamp',
|
|
valueToTest: scorm2004_values.validTimestamps[0],
|
|
errorThrown: false,
|
|
});
|
|
it('should allow cmi.interactions.0.correct_responses.0.pattern to be set - T/F',
|
|
() => {
|
|
const scorm2004API = apiInitialized();
|
|
scorm2004API.setCMIValue('cmi.interactions.0.id',
|
|
'Scene1_Slide3_MultiChoice_0_0');
|
|
scorm2004API.setCMIValue('cmi.interactions.0.type', 'true-false');
|
|
scorm2004API.setCMIValue(
|
|
'cmi.interactions.0.correct_responses.0.pattern', 'true');
|
|
expect(
|
|
String(scorm2004API.lmsGetLastError()),
|
|
).to.equal(String(0));
|
|
});
|
|
it('should allow cmi.interactions.10.correct_responses.0.pattern to be set - T/F',
|
|
() => {
|
|
const scorm2004API = apiInitialized();
|
|
scorm2004API.setCMIValue('cmi.interactions.0.id',
|
|
'Scene1_Slide3_MultiChoice_0_0');
|
|
scorm2004API.setCMIValue('cmi.interactions.0.type', 'true-false');
|
|
scorm2004API.setCMIValue(
|
|
'cmi.interactions.0.correct_responses.0.pattern', 'true');
|
|
expect(
|
|
String(scorm2004API.lmsGetLastError()),
|
|
).to.equal(String(0));
|
|
});
|
|
it('should allow cmi.interactions.0.correct_responses.0.pattern to be set - choice',
|
|
() => {
|
|
const scorm2004API = apiInitialized();
|
|
scorm2004API.setCMIValue('cmi.interactions.0.id',
|
|
'Scene1_Slide3_MultiChoice_0_0');
|
|
scorm2004API.setCMIValue('cmi.interactions.0.type', 'choice');
|
|
scorm2004API.setCMIValue(
|
|
'cmi.interactions.0.correct_responses.0.pattern',
|
|
'VP_on-call_or_President');
|
|
expect(
|
|
String(scorm2004API.lmsGetLastError()),
|
|
).to.equal(String(0));
|
|
});
|
|
it('should allow cmi.interactions.0.objectives.0.id to be set',
|
|
() => {
|
|
const scorm2004API = apiInitialized();
|
|
scorm2004API.setCMIValue('cmi.interactions.0.objectives.0.id',
|
|
'ID of the Obj - ID 2');
|
|
expect(
|
|
String(scorm2004API.lmsGetLastError()),
|
|
).to.equal(String(0));
|
|
});
|
|
it('should allow cmi.interactions.0.learner_response to be set',
|
|
() => {
|
|
const scorm2004API = apiInitialized();
|
|
scorm2004API.setCMIValue('cmi.interactions.0.id',
|
|
'Scene1_Slide3_MultiChoice_0_0');
|
|
scorm2004API.setCMIValue('cmi.interactions.0.type', 'choice');
|
|
scorm2004API.setCMIValue('cmi.interactions.0.learner_response',
|
|
'VP_on-call_or_President');
|
|
expect(
|
|
String(scorm2004API.lmsGetLastError()),
|
|
).to.equal(String(0));
|
|
expect(
|
|
scorm2004API.getCMIValue('cmi.interactions.0.id'),
|
|
).to.equal('Scene1_Slide3_MultiChoice_0_0');
|
|
expect(
|
|
scorm2004API.getCMIValue('cmi.interactions.0.type'),
|
|
).to.equal('choice');
|
|
expect(
|
|
scorm2004API.getCMIValue('cmi.interactions.0.learner_response'),
|
|
).to.equal('VP_on-call_or_President');
|
|
});
|
|
});
|
|
|
|
describe('Initialized - Should Fail', () => {
|
|
h.checkLMSSetValue({
|
|
api: apiInitialized(
|
|
{cmi: {interactions: {'0': {id: 'interaction-id-1'}}}}),
|
|
fieldName: 'cmi.interactions.0.type',
|
|
valueToTest: 'unknown',
|
|
errorThrown: false,
|
|
expectedError: scorm2004_error_codes.TYPE_MISMATCH,
|
|
});
|
|
h.checkLMSSetValue({
|
|
api: apiInitialized(),
|
|
fieldName: 'cmi.interactions.0.type',
|
|
valueToTest: 'true-false',
|
|
errorThrown: false,
|
|
expectedError: scorm2004_error_codes.DEPENDENCY_NOT_ESTABLISHED,
|
|
});
|
|
h.checkLMSSetValue({
|
|
api: apiInitialized(),
|
|
fieldName: 'cmi.interactions.0.description',
|
|
valueToTest: 'this is an interaction',
|
|
errorThrown: false,
|
|
expectedError: scorm2004_error_codes.DEPENDENCY_NOT_ESTABLISHED,
|
|
});
|
|
h.checkLMSSetValue({
|
|
api: apiInitialized(),
|
|
fieldName: 'cmi.interactions.0.timestamp',
|
|
valueToTest: 'PT1S',
|
|
errorThrown: false,
|
|
expectedError: scorm2004_error_codes.DEPENDENCY_NOT_ESTABLISHED,
|
|
});
|
|
h.checkLMSSetValue({
|
|
api: apiInitialized(),
|
|
fieldName: 'cmi.interactions.0.weighting',
|
|
valueToTest: 1.0,
|
|
errorThrown: false,
|
|
expectedError: scorm2004_error_codes.DEPENDENCY_NOT_ESTABLISHED,
|
|
});
|
|
h.checkLMSSetValue({
|
|
api: apiInitialized(),
|
|
fieldName: 'cmi.interactions.0.learner_response',
|
|
valueToTest: 'true',
|
|
errorThrown: false,
|
|
expectedError: scorm2004_error_codes.DEPENDENCY_NOT_ESTABLISHED,
|
|
});
|
|
h.checkLMSSetValue({
|
|
api: apiInitialized(),
|
|
fieldName: 'cmi.interactions.0.latency',
|
|
valueToTest: 'PT1S',
|
|
errorThrown: false,
|
|
expectedError: scorm2004_error_codes.DEPENDENCY_NOT_ESTABLISHED,
|
|
});
|
|
h.checkLMSSetValue({
|
|
api: apiInitialized(),
|
|
fieldName: 'cmi.objectives.0.success_status',
|
|
valueToTest: 'passed',
|
|
errorThrown: false,
|
|
expectedError: scorm2004_error_codes.DEPENDENCY_NOT_ESTABLISHED,
|
|
});
|
|
h.checkLMSSetValue({
|
|
api: apiInitialized(),
|
|
fieldName: 'cmi.objectives.0.completion_status',
|
|
valueToTest: 'completed',
|
|
errorThrown: false,
|
|
expectedError: scorm2004_error_codes.DEPENDENCY_NOT_ESTABLISHED,
|
|
});
|
|
h.checkLMSSetValue({
|
|
api: apiInitialized(),
|
|
fieldName: 'cmi.objectives.0.progress_measure',
|
|
valueToTest: 1.0,
|
|
errorThrown: false,
|
|
expectedError: scorm2004_error_codes.DEPENDENCY_NOT_ESTABLISHED,
|
|
});
|
|
h.checkLMSSetValue({
|
|
api: apiInitialized(),
|
|
fieldName: 'cmi.objectives.0.description',
|
|
valueToTest: 'this is an objective',
|
|
errorThrown: false,
|
|
expectedError: scorm2004_error_codes.DEPENDENCY_NOT_ESTABLISHED,
|
|
});
|
|
h.checkLMSSetValue({
|
|
api: apiInitialized(),
|
|
fieldName: 'cmi.comments_from_lms.0.comment',
|
|
valueToTest: 'comment',
|
|
errorThrown: false,
|
|
expectedError: scorm2004_error_codes.READ_ONLY_ELEMENT,
|
|
});
|
|
h.checkLMSSetValue({
|
|
api: apiInitialized(),
|
|
fieldName: 'cmi.comments_from_lms.0.location',
|
|
valueToTest: 'location',
|
|
errorThrown: false,
|
|
expectedError: scorm2004_error_codes.READ_ONLY_ELEMENT,
|
|
});
|
|
h.checkLMSSetValue({
|
|
api: apiInitialized(),
|
|
fieldName: 'cmi.comments_from_lms.0.timestamp',
|
|
valueToTest: scorm2004_values.validTimestamps[0],
|
|
errorThrown: false,
|
|
expectedError: scorm2004_error_codes.READ_ONLY_ELEMENT,
|
|
});
|
|
h.checkLMSSetValue({
|
|
api: apiInitialized(),
|
|
fieldName: 'cmi.unknown',
|
|
valueToTest: 'uknown',
|
|
errorThrown: false,
|
|
expectedError: scorm2004_error_codes.UNDEFINED_DATA_MODEL,
|
|
});
|
|
});
|
|
});
|
|
|
|
describe('renderCommitCMI()', () => {
|
|
it('should calculate total time when terminateCommit passed',
|
|
() => {
|
|
const scorm2004API = api();
|
|
scorm2004API.cmi.total_time = 'PT12H34M56S';
|
|
scorm2004API.cmi.session_time = 'PT23H59M59S';
|
|
const cmiExport = scorm2004API.renderCommitCMI(true);
|
|
expect(
|
|
cmiExport.cmi.total_time,
|
|
).to.equal('P1DT12H34M55S');
|
|
});
|
|
});
|
|
|
|
describe('storeData()', () => {
|
|
it('should set cmi.completion_status to "completed"',
|
|
() => {
|
|
const scorm2004API = api();
|
|
scorm2004API.cmi.credit = 'credit';
|
|
scorm2004API.cmi.completion_threshold = '0.6';
|
|
scorm2004API.cmi.progress_measure = '0.75';
|
|
scorm2004API.storeData(true);
|
|
expect(scorm2004API.cmi.completion_status).to.equal('completed');
|
|
});
|
|
it('should set cmi.completion_status to "incomplete"',
|
|
() => {
|
|
const scorm2004API = api();
|
|
scorm2004API.cmi.credit = 'credit';
|
|
scorm2004API.cmi.completion_threshold = '0.7';
|
|
scorm2004API.cmi.progress_measure = '0.6';
|
|
scorm2004API.storeData(true);
|
|
expect(scorm2004API.cmi.completion_status).to.equal('incomplete');
|
|
});
|
|
it('should set cmi.success_status to "passed"',
|
|
() => {
|
|
const scorm2004API = api();
|
|
scorm2004API.cmi.credit = 'credit';
|
|
scorm2004API.cmi.score.scaled = '0.7';
|
|
scorm2004API.cmi.scaled_passing_score = '0.6';
|
|
scorm2004API.storeData(true);
|
|
expect(scorm2004API.cmi.success_status).to.equal('passed');
|
|
});
|
|
it('should set cmi.success_status to "failed"',
|
|
() => {
|
|
const scorm2004API = api();
|
|
scorm2004API.cmi.credit = 'credit';
|
|
scorm2004API.cmi.score.scaled = '0.6';
|
|
scorm2004API.cmi.scaled_passing_score = '0.7';
|
|
scorm2004API.storeData(true);
|
|
expect(scorm2004API.cmi.success_status).to.equal('failed');
|
|
});
|
|
});
|
|
});
|