@condor-labs/lms-smoke-tests

This module provides a useful helper to implement Smoke tests for the LMS in any app it is integrated, like CEBroker or Evercheck.

Compatibility

The minimum supported version of Node.js is v8.

How to use it

To use the library you just need to follow these steps:

1. Install the library with npm

npm install @condor-labs/lms-smoke-tests

2. Import the library

const SmokeTests = require("@condor-labs/lms-smoke-tests")

3. Init library

This library uses a specific key called clientCourseId (unique id for courses) that the client must provide in the called functions or in the constructor. The clientCourseId passed as a parameter in the functions takes precedence over the one passed in the constructor.

const SmokeTests = require("@condor-labs/lms-smoke-tests");
const smokeTestsObject = new SmokeTests(clientCourseId);

4. Methods

Method	Required Parameters	Optional Parameters	Description
createCourse	Page (instance of puppetear page object), clientCourseId (String)		This method creates a course with the clientCourseId provided as a parameter
createContentPage	Page (instance of puppetear page object)	clientCourseId (String)	This method allows to create a content page in the course

5. Example

You can find the example in the lms-smoke-tests folder in this repository: https://github.com/cebroker/condorlabs-npm-helpers/lms-smoke-tests/example

How to Publish

Increasing package version

You will need to update the package.json file placed in the root folder.

Identify the property version and increase the right number in plus one.

Install node modules

Run npm i in the root folder.

Make a build

You have to run the command npm run build to the create a compile "Dist"

Login in NPM by console.

 npm login
 [Enter username]
 [Enter password]
 [Enter email]

If everything goes ok, the console will show you something like this : Logged in as USERNAME on https://registry.npmjs.org/.

Uploading a new version

 npm publish --access public

Ref: https://docs.npmjs.com/getting-started/publishing-npm-packages

Note: You will need to have a NPM account. If you don't have one, create it here: https://www.npmjs.com/signup

Contributors

The original author and current lead maintainer of this module is the @condor-labs development team.

More about Condorlabs Here.

License

MIT