@gigster/module-loopback-jest
v2.0.0
Published
Role | Name | Email | Slack ---- | ---- | ----- | ----- *Product Owner* | Ryan Borker | [[email protected]](mailto:[email protected]) | [@borker] *Maintainer* | Mark Miyashita | [[email protected]](mailto:[email protected]) | [@mark]
Downloads
59
Readme
loopback-jest
Role | Name | Email | Slack ---- | ---- | ----- | ----- Product Owner | Ryan Borker | [email protected] | [@borker] Maintainer | Mark Miyashita | [email protected] | [@mark]
Overview
Adds the jest testing framework to a Loopback API. This module generates the base infrastructure to use jest with a Loopback API and optionally generates tests for the default API.
Usage
Specification
Name | Status | Description
---- | ------ | -----------
generateTests
| true
/false
| Set to true if you would like generated tests to be created for you for the API.
Dependencies
This module is dependent on jest
version 21.2.1.
Examples
There are two examples for this package:
with-tests
- This example is generated withgenerateTests: true
so it has the infrastructure as well as generated tests.without-tests
- This example is generated withgenerateTests: false
so it only has the base infrastructure and does not contain tests.
Troubleshooting
Testing
Module tests are defined using a test/scenarios.yaml
file. This file defines the set of example gigs that we generate as part of integration testing. To run all tests, run yarn test
at the root of this module.
Each scenario is generated in test/scenario/<name>
which you can then cd
into and run the actual app. For a scenario called default
, this is done via:
cd test/scenario/default
yarn install
# Run tests.
yarn test
# Start the app.
yarn start