https://github.com/adlnet/lrs-conformance-test-suite
A NodeJS project that tests the MUST requirements of the xAPI Spec and is based on the ADL testing requirements repository. The test suite website can be found here: https://lrstest.adlnet.gov/. The adopters website can be found here: https://adopters.adlnet.gov/
https://github.com/adlnet/lrs-conformance-test-suite
xapi
Last synced: 6 days ago
JSON representation
A NodeJS project that tests the MUST requirements of the xAPI Spec and is based on the ADL testing requirements repository. The test suite website can be found here: https://lrstest.adlnet.gov/. The adopters website can be found here: https://adopters.adlnet.gov/
- Host: GitHub
- URL: https://github.com/adlnet/lrs-conformance-test-suite
- Owner: adlnet
- License: mit
- Created: 2014-07-10T01:24:53.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2025-09-04T14:37:45.000Z (5 months ago)
- Last Synced: 2026-01-15T05:50:15.280Z (28 days ago)
- Topics: xapi
- Language: JavaScript
- Homepage: https://adlnet.gov/projects/xapi/
- Size: 2.77 MB
- Stars: 71
- Watchers: 35
- Forks: 50
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
LRS Conformance Test Suite
==========================
### Description
This is a NodeJS project that tests the 'MUST' requirements of the xAPI Spec, determined by the governing documents for the various versions of the xAPI Spec. This is actively being developed and new tests will be periodically added based on the testing requirements. Currently, this test suite only supports basic authentication. This test suite should also not run against a production LRS endpoint because the data is persisted and never voided.
- For xAPI versions 1.0.3 and earlier, the documentation can be found on the **[ADL Initiative GitHub repository](https://github.com/adlnet/xAPI-Spec)**
- For xAPI versions 2.0 and later, these will be hosted on the **[IEEE GitLab repository](https://opensource.ieee.org/xapi/xapi-base-standard-documentation)**
### xAPI 2.0 Update
xAPI 2.0 changed a number of requirements for the LRS from previous versions; most of these are additions supporting new features, while others have been removed. The details of the changes may be seen in the updated xAPI Spec.
The following are the major changes that warranted the creation of additional tests in the conformance suite:
- Full support and validation for context agents and context groups
- 2.0.x is a valid set of xAPI versions
- Timestamps may be represented in the RFC 3339 format (changed from strict ISO 8601)
- If a timestamp is not formatted to UTC, the LRS will convert the timestamp instead of rejecting the statement
- Alternate Request Syntax is no longer supported and therefore not tested
- LRS responses now include `Last-Modified` headers
### Installation
Dependency
This requires npm for installation. NodeJS version 8.x or later at a minimum, but it's recommended to use the latest LTS release.
Clone and install
```bash
$ git clone https://github.com/adlnet/lrs-conformance-test-suite.git
$ cd lrs-conformance-test-suite
$ npm install
```
Verify installation
```bash
$ node bin/console_runner.js --help
Usage: console_runner [options]
Options:
-h, --help output usage information
-V, --version output the version number
-e, --endpoint [url] xAPI endpoint
-u, --authUser [string] Basic Auth Username
-p, --authPassword [string] Basic Auth Password
-a, --basicAuth Enable Basic Auth
-o, --oAuth1 Enable oAuth 1
-c, --consumer_key [string] oAuth 1 Consumer Key
-s, --consumer_secret [string] oAuth 1 Consumer Secert
-r, --request_token_path [string] Path to OAuth request token endpoint (relative to endpoint)
-t, --auth_token_path [string] Path to OAuth authorization token endpoint (relative to endpoint)
-l, --authorization_path [string] Path to OAuth user authorization endpoint (relative to endpoint)
-g, --grep [string] Only run tests that match the given pattern
-b, --bail Abort the battery if one test fails
-x, --xapiVersion [string] 🌟 New: Version of the xAPI spec to test against
-d, --directory [value] Specific directories of tests (as a comma seperated list with no spaces)
-z, --errors Results log of failing tests only
```
### Running the Test Suite
Example Basic Authentication:
```bash
$ node bin/console_runner.js -e -a -u -p
-or-
$ node bin/console_runner.js --endpoint --basicAuth --authUser --authPass
```
Example OAuth1 Authentication:
```bash
$ node bin/console_runner.js -e -o -c -s -r -t -l
-or-
$ node bin/console_runner.js --endpoint --oAuth1 --consumer_key --consumer_secret --request_token_path --auth_token_path --authorization_path
```
Example with Grep:
```bash
$ node bin/console_runner.js -a -e -a -u -p -g ""
-or-
$ node bin/console_runner.js --endpoint --basicAuth --authUser --authPass --grep ""
```
**Note:** Grep is a useful tool to run only specific tests or a group of tests which meet a specific pattern. For example using a specific requirement number (XAPI-00113) or a specific section of the spec (Data 2.4.1).
Example using Option for Log Containing Only Errors:
```bash
$ node bin/console_runner.js -e -a -u -p -z
-or-
$ node bin/console_runner.js --endpoint --basicAuth --authUser --authPass --errors
```
**Note:** The default log contains results from every test run in the suite both passed and failed. The --errors option filters the log to contain only tests which have failed.
## Contributing to the project
We welcome contributions to this project. Fork this repository, make changes, and submit pull requests. If you're not comfortable with editing the code, please [submit an issue](mailto:adlhelpdesk@adlnet.gov) and we'll be happy to address it.
### License
MIT License
>Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
>The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.