@loopback/testlab

LoopBack Test Lab

A collection of test utilities we use to write LoopBack tests.

Overview

Test utilities to help writing loopback-next tests:

• expect - behavior-driven development (BDD) style assertions
• sinon
  • test spies: functions recording arguments and other information for all of their calls
  • stubs: functions (spies) with pre-programmed behavior
  • mocks: fake methods (like spies) with pre-programmed behavior (like stubs) as well as pre-programmed expectations
• Helpers for creating supertest clients for LoopBack applications
• HTTP request/response stubs for writing tests without a listening HTTP server
• Swagger/OpenAPI spec validation

Installation

$ npm install --save-dev @loopback/testlab

This package is typically used in tests, save it to devDependencies via --save-dev.

Basic use

import { expect } from '@loopback/testlab';

expect({key:'value'}).to.deepEqual({key: 'value'});
expect.exists(1);

API documentation

expect

Should.js configured in "as-function" mode (global Object.prototype is left intact) with an extra chaining word to.

sinon

Spies, mocks and stubs. Learn more at http://sinonjs.org/.

shot

Shot API Reference

validateApiSpec

Verify that your application API specification is a valid OpenAPI spec document.

import {validateApiSpec} from '@loopback/testlab';

describe('MyApp', () => {)
  it('has valid spec', async () => {
    const app = new MyApp();
    await validateApiSpec(app.getApiSpec());
  })
});

Related resources

For more info about supertest, please refer to supertest

Contributions

• Guidelines
• Join the team

Tests

run 'npm test' from the root folder.

Contributors

See all contributors.

License

MIT