{"id":43841590,"url":"https://github.com/adlnet/lrs-conformance-test-suite","last_synced_at":"2026-02-06T05:11:22.065Z","repository":{"id":18479341,"uuid":"21674625","full_name":"adlnet/lrs-conformance-test-suite","owner":"adlnet","description":"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/ ","archived":false,"fork":false,"pushed_at":"2025-09-04T14:37:45.000Z","size":2908,"stargazers_count":71,"open_issues_count":20,"forks_count":50,"subscribers_count":35,"default_branch":"master","last_synced_at":"2026-01-15T05:50:15.280Z","etag":null,"topics":["xapi"],"latest_commit_sha":null,"homepage":"https://adlnet.gov/projects/xapi/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/adlnet.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2014-07-10T01:24:53.000Z","updated_at":"2025-09-16T05:26:38.000Z","dependencies_parsed_at":"2024-04-04T19:43:15.159Z","dependency_job_id":"6dfc7136-8e52-4a17-9070-6709d1ff1806","html_url":"https://github.com/adlnet/lrs-conformance-test-suite","commit_stats":null,"previous_names":["tryxapi/lrs-conformance-tests","riptidecloud/lrs-conformance-tests"],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/adlnet/lrs-conformance-test-suite","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adlnet%2Flrs-conformance-test-suite","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adlnet%2Flrs-conformance-test-suite/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adlnet%2Flrs-conformance-test-suite/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adlnet%2Flrs-conformance-test-suite/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adlnet","download_url":"https://codeload.github.com/adlnet/lrs-conformance-test-suite/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adlnet%2Flrs-conformance-test-suite/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29151859,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-06T02:39:25.012Z","status":"ssl_error","status_checked_at":"2026-02-06T02:37:22.784Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["xapi"],"created_at":"2026-02-06T05:11:21.592Z","updated_at":"2026-02-06T05:11:22.057Z","avatar_url":"https://github.com/adlnet.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"LRS Conformance Test Suite\n==========================\n\n### Description\n\nThis 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.\n\n- 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)**\n- 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)**\n\n### xAPI 2.0 Update\n\nxAPI 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.\n\nThe following are the major changes that warranted the creation of additional tests in the conformance suite:\n- Full support and validation for context agents and context groups\n- 2.0.x is a valid set of xAPI versions\n- Timestamps may be represented in the RFC 3339 format (changed from strict ISO 8601)\n- If a timestamp is not formatted to UTC, the LRS will convert the timestamp instead of rejecting the statement\n- Alternate Request Syntax is no longer supported and therefore not tested\n- LRS responses now include `Last-Modified` headers\n\n### Installation  \n\nDependency  \nThis requires npm for installation.  NodeJS version 8.x or later at a minimum, but it's recommended to use the latest LTS release.\n\nClone and install\n\n```bash\n$ git clone https://github.com/adlnet/lrs-conformance-test-suite.git\n$ cd lrs-conformance-test-suite\n$ npm install\n```\n\nVerify installation\n```bash\n$ node bin/console_runner.js --help\n\n  Usage: console_runner [options]\n\n  Options:\n\n    -h, --help                         output usage information\n    -V, --version                      output the version number\n    -e, --endpoint [url]               xAPI endpoint\n    -u, --authUser [string]            Basic Auth Username\n    -p, --authPassword [string]        Basic Auth Password\n    -a, --basicAuth                    Enable Basic Auth\n    -o, --oAuth1                       Enable oAuth 1\n    -c, --consumer_key [string]        oAuth 1 Consumer Key\n    -s, --consumer_secret [string]     oAuth 1 Consumer Secert\n    -r, --request_token_path [string]  Path to OAuth request token endpoint (relative to endpoint)\n    -t, --auth_token_path [string]     Path to OAuth authorization token endpoint (relative to endpoint)\n    -l, --authorization_path [string]  Path to OAuth user authorization endpoint (relative to endpoint)\n    -g, --grep [string]                Only run tests that match the given pattern\n    -b, --bail                         Abort the battery if one test fails\n    -x, --xapiVersion [string]         🌟 New: Version of the xAPI spec to test against\n    -d, --directory [value]            Specific directories of tests (as a comma seperated list with no spaces)\n    -z, --errors                       Results log of failing tests only\n```\n\n### Running the Test Suite\n\nExample Basic Authentication:\n\n```bash\n$ node bin/console_runner.js -e \u003chttp://localhost/xapi\u003e -a -u \u003cusername\u003e -p \u003cpassword\u003e\n-or-\n$ node bin/console_runner.js --endpoint \u003chttp://localhost/xapi\u003e --basicAuth --authUser \u003cusername\u003e --authPass \u003cpassword\u003e\n```\n\nExample OAuth1 Authentication:\n\n```bash\n$ node bin/console_runner.js -e \u003chttp://localhost/xapi\u003e -o -c \u003cconsumer_key\u003e -s \u003cconsumer_secret\u003e -r \u003crequest_token_path\u003e -t \u003cauth_token_path\u003e -l \u003cauthorization_path\u003e\n-or-\n$ node bin/console_runner.js --endpoint \u003chttp://localhost/xapi\u003e --oAuth1 --consumer_key \u003cconsumer_key\u003e --consumer_secret \u003cconsumer_secret\u003e --request_token_path \u003crequest_token_path\u003e --auth_token_path \u003cauth_token_path\u003e --authorization_path \u003cauthorization_path\u003e\n```\n\nExample with Grep:\n\n```bash\n$ node bin/console_runner.js -a -e \u003chttp://localhost/xapi\u003e -a -u \u003cusername\u003e -p \u003cpassword\u003e -g \"\u003cstring or pattern to match\u003e\"\n-or-\n$ node bin/console_runner.js --endpoint \u003chttp://localhost/xapi\u003e --basicAuth --authUser \u003cusername\u003e --authPass \u003cpassword\u003e --grep \"\u003cstring or pattern to match\u003e\"\n```\n\n**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).\n\nExample using Option for Log Containing Only Errors:\n\n```bash\n$ node bin/console_runner.js -e \u003chttp://localhost/xapi\u003e -a -u \u003cusername\u003e -p \u003cpassword\u003e -z\n-or-\n$ node bin/console_runner.js --endpoint \u003chttp://localhost/xapi\u003e --basicAuth --authUser \u003cusername\u003e --authPass \u003cpassword\u003e --errors\n```\n\n**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.\n\n## Contributing to the project\nWe 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.\n\n### License\nMIT License\n\n\u003ePermission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n\"Software\"), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\n\u003eThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\n\u003eTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\nNONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE\nLIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION\nOF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION\nWITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadlnet%2Flrs-conformance-test-suite","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadlnet%2Flrs-conformance-test-suite","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadlnet%2Flrs-conformance-test-suite/lists"}