@gasbuddy/service-tester
TypeScript icon, indicating that this package has built-in type declarations

12.3.0 • Public • Published

service-tester

main CI

npm version

This module makes it easier for you to write tests for your node.js GasBuddy microservice. Simply add the module as a dev dependency:

yarn add -D @gasbuddy/service-tester

Then write a test in /__tests__/startup.test.js:

import request from 'supertest';
import { getReusableApp, clearReusableApp } from '@gasbuddy/service-tester';
import myService from '../src/index';

describe('my service', () => {
  test('should start', async () => {
    const app = await getReusableApp(myService);
    expect(app).toBeTruthy();
    await request(app).get('/').expect(200);
  });
});

Service call mocking

Nock is so 2010. The future is mock! Since we have typed clients for services these days, mocking them is easier. We've played some nutty tricks with Typescript (well, nutty for me), to enable this kind of syntax:

  mockServiceCall(app.locals.services.myCrazyServ, 'get_some_resource').mockResolvedValue({
    status: 200,
    responseType: 'response',
    body: { resource: true },
    headers: new Headers(),
  });

This will cause calls to app.locals.services.myCrazyServ.get_some_resource() to return {resource: true}. This is just shorthand for jest.spyOn(service, 'method') with knowledge of the traditional return type of OpenAPI service calls.

Readme

Keywords

Package Sidebar

Install

npm i @gasbuddy/service-tester

Weekly Downloads

132

Version

12.3.0

License

MIT

Unpacked Size

51.6 MB

Total Files

900

Last publish

Collaborators

  • djmax
  • msimeon
  • ryan.vasselin
  • normrider2001232
  • dsigmeth
  • bkarchernpm