Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add statement batch tests, prevent double initialized/terminated within same batch. #5

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion lts/__tests__/runtime.js
Original file line number Diff line number Diff line change
Expand Up @@ -402,7 +402,9 @@ describe.each(
describe.each(
[
["005-1-invalid-au.zip"],
["005-2-invalid-au.zip"]
["005-2-invalid-au.zip"],
["005-3-invalid-batches-au.zip"],
["005-4-valid-batches-au.zip"]
]
)(
"Test package: %s",
Expand Down
110 changes: 110 additions & 0 deletions lts/pkg/src/005-3-invalid-batches-au/005-3-invalid-batches-au.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
/*
Copyright 2021 Rustici Software

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
import Helpers from "../lib/helpers";

const execute = async () => {
const cmi5 = await Helpers.initCmi5();

if (! cmi5) {
return;
}

try {
await cmi5.postFetch();
}
catch (ex) {
Helpers.storeResult(false, true, {msg: `Failed to start AU at POSTing to the fetch URL: ${ex}`});

return;
}

try {
await cmi5.loadLMSLaunchData();
}
catch (ex) {
Helpers.storeResult(false, true, {msg: `Failed to start AU at loading LMS Launch Data: ${ex}`});

return;
}

try {
await cmi5.loadLearnerPrefs();
}
catch (ex) {
Helpers.storeResult(false, true, {msg: `Failed to start AU at loading Learner Prefs: ${ex}`});

return;
}

// Reject a double initialization within the same batch, leave as uninitialized.
const doubleInitialize = [cmi5.initializedStatement(), cmi5.initializedStatement()];

if (! await Helpers.sendStatement(cmi5, doubleInitialize, "9.3.0.0-2", {method: "post"})) {
return;
}

await cmi5.initialize();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: this causes a timeout when it fails


// Reject a double termination within the same batch, leave as unterminated.
const doubleTerminated = [cmi5.terminatedStatement(), cmi5.terminatedStatement()];

if (! await Helpers.sendStatement(cmi5, doubleTerminated, "9.3.0.0-2", {method: "post"})) {
return;
}

// Reject a double passed within the same batch.
const doublePassed = [cmi5.passedStatement(), cmi5.passedStatement()];

if (! await Helpers.sendStatement(cmi5, doublePassed, "9.3.0.0-2", {method: "post"})) {
return;
}

// Reject a double failed within the same batch.
const doubleFailed = [cmi5.failedStatement(), cmi5.failedStatement()];

if (! await Helpers.sendStatement(cmi5, doubleFailed, "9.3.0.0-2", {method: "post"})) {
return;
}

// Reject a passed and failed within the same batch, in either order
const passedFailed = [cmi5.passedStatement(), cmi5.failedStatement()];

if (! await Helpers.sendStatement(cmi5, passedFailed, "9.3.0.0-3", {method: "post"})) {
return;
}

const failedPassed = [cmi5.failedStatement(), cmi5.passedStatement()];

if (! await Helpers.sendStatement(cmi5, failedPassed, "9.3.0.0-3", {method: "post"})) {
return;
}

// cmi5 defined statements should still be accepted.
try {
await cmi5.passed();
}
catch (ex) {
Helpers.storeResult(false, true, {msg: `Failed call to passed: ${ex}`});

return;
}

await Helpers.closeAU(cmi5);

Helpers.storeResult(true, false, {msg: "All statement batches rejected successfully."});
};

execute();
39 changes: 39 additions & 0 deletions lts/pkg/src/005-3-invalid-batches-au/cmi5.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
<?xml version="1.0" encoding="utf-8"?>
<!--
Copyright 2021 Rustici Software

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<courseStructure xmlns="https://w3id.org/xapi/profiles/cmi5/v1/CourseStructure.xsd">
<course id="https://w3id.org/xapi/cmi5/catapult/lts/course/005-3-invalid-batches-au">
<title>
<langstring lang="en">CATAPULT LMS Test Course: 005-3 Invalid Batches AU</langstring>
</title>
<description>
<langstring lang="en">CATAPULT LMS Test Course: 005-3 Invalid Batches AU</langstring>
</description>
</course>
<au
id="https://w3id.org/xapi/cmi5/catapult/lts/au/005-3-invalid-au"
moveOn="CompletedOrPassed"
masteryScore="0.9"
>
<title>
<langstring lang="en">CATAPULT LMS Test AU: 005-3 Invalid Batches AU</langstring>
</title>
<description>
<langstring lang="en">CATAPULT LMS Test AU: 005-3 Invalid Batches AU</langstring>
</description>
<url>index.html</url>
</au>
</courseStructure>
68 changes: 68 additions & 0 deletions lts/pkg/src/005-4-valid-batches-au/005-4-valid-batches-au.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
/*
Copyright 2021 Rustici Software

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
import Helpers from "../lib/helpers";

const execute = async () => {
const cmi5 = await Helpers.initCmi5();

if (! cmi5) {
return;
}

try {
await cmi5.postFetch();
}
catch (ex) {
Helpers.storeResult(false, true, {msg: `Failed to start AU at POSTing to the fetch URL: ${ex}`});

return;
}

try {
await cmi5.loadLMSLaunchData();
}
catch (ex) {
Helpers.storeResult(false, true, {msg: `Failed to start AU at loading LMS Launch Data: ${ex}`});

return;
}

try {
await cmi5.loadLearnerPrefs();
}
catch (ex) {
Helpers.storeResult(false, true, {msg: `Failed to start AU at loading Learner Prefs: ${ex}`});

return;
}

// Do a full session in a single batch.
const fullSession = [
cmi5.initializedStatement(),
cmi5.passedStatement(),
cmi5.completedStatement(),
cmi5.terminatedStatement()
];

if (! await Helpers.sendStatement(cmi5, fullSession, "gav 123", {method: "post", shouldSucceed: true})) {
return;
}
await Helpers.returnAU(cmi5);

Helpers.storeResult(true, false, {msg: "Valid statement batch accepted."});
};

execute();
39 changes: 39 additions & 0 deletions lts/pkg/src/005-4-valid-batches-au/cmi5.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
<?xml version="1.0" encoding="utf-8"?>
<!--
Copyright 2021 Rustici Software

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<courseStructure xmlns="https://w3id.org/xapi/profiles/cmi5/v1/CourseStructure.xsd">
<course id="https://w3id.org/xapi/cmi5/catapult/lts/course/005-4-valid-batches-au">
<title>
<langstring lang="en">CATAPULT LMS Test Course: 005-4 Valid Batches AU</langstring>
</title>
<description>
<langstring lang="en">CATAPULT LMS Test Course: 005-4 Valid Batches AU</langstring>
</description>
</course>
<au
id="https://w3id.org/xapi/cmi5/catapult/lts/au/005-4-valid-au"
moveOn="CompletedOrPassed"
masteryScore="0.9"
>
<title>
<langstring lang="en">CATAPULT LMS Test AU: 005-4 Valid Batches AU</langstring>
</title>
<description>
<langstring lang="en">CATAPULT LMS Test AU: 005-4 Valid Batches AU</langstring>
</description>
<url>index.html</url>
</au>
</courseStructure>
3 changes: 3 additions & 0 deletions lts/pkg/src/lib/helpers.js
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,9 @@ const Helpers = {
return;
}

return Helpers.returnAU(cmi5, loadReturnURL);
},
returnAU: (cmi5, loadReturnURL = false) => {
try {
const returnURL = cmi5.getReturnURL();

Expand Down
6 changes: 4 additions & 2 deletions player/service/plugins/routes/lrs.js
Original file line number Diff line number Diff line change
Expand Up @@ -160,11 +160,11 @@ const Boom = require("@hapi/boom"),
throw Helpers.buildViolatedReqId("9.6.3.1-4", st.id);
}

if (! session.is_initialized && st.verb.id !== VERB_INITIALIZED_ID) {
if (! session.is_initialized && st.verb.id !== VERB_INITIALIZED_ID && !result.statements.includes(VERB_INITIALIZED_ID)) {
throw Helpers.buildViolatedReqId("9.3.0.0-4", st.id);
}

if (session.is_terminated) {
if (session.is_terminated || result.statements.includes(VERB_TERMINATED_ID)) {
throw Helpers.buildViolatedReqId("9.3.0.0-5", st.id);
}
if (session.is_abandoned) {
Expand Down Expand Up @@ -387,6 +387,8 @@ const Boom = require("@hapi/boom"),
}
}
else if (resource === "agents") {
let parsedAgent;

// all agents requests require an actor, and that actor must be the launch actor
try {
parsedAgent = JSON.parse(req.query.agent);
Expand Down