@openapi-typescript-infra/service-tester

service-tester

This module makes it easier for you to write tests for your node.js @openapi-typescript-infra/service microservice. Simply add the module as a dev dependency:

yarn add -D @openapi-typescript-infra/service-tester

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

import request from 'supertest';
import { getReusableApp, clearReusableApp } from '@openapi-typescript-infra/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.