Schema validation in tests

[AmusedArg]

Hi, I'm having trouble while testing my app, if I start my application it loads the schemas correctly and they're working.
But when I run the tests it throws the following error: FastifyError: Failed building the validation schema for GET: /api/lorem/ipsum, due to error can't resolve reference default.authorization.header# from id #

The test fails in the before all when creating the configureControllerTest like this

describe('Controller: CalculatorController', () => {
  let instance: FastifyInstanceWithController<CalculatorController>;
  const myService = {someFunction: jest.fn()};
  beforeAll(async () => {
    instance = await configureControllerTest({
      controller: CalculatorController,
      mocks: [
        {
          provide: MyService,
          useValue: myService,
        },
      ],
    });
  });
});

And the controller definition is like this this:

@Controller()
export default class CalculatorController {
    @GET('/api/lorem/ipsum', {
      schema: {
        headers: {$ref: 'default.authorization.header#'}
      },
    })
    init() { /*some code*/ }
}

Thanks!

[L2jLiga]

Hi there!

I think you can workaround this issue in tests by using plugins option. Something like this I guess

describe('Controller: CalculatorController', () => {
  let instance: FastifyInstanceWithController<CalculatorController>;
  const myService = {someFunction: jest.fn()};
  beforeAll(async () => {
    instance = await configureControllerTest({
      controller: CalculatorController,
      mocks: [
        {
          provide: MyService,
          useValue: myService,
        },
      ],
      plugins: [
        (instance) => instance.addSchema(authorizationHeaderSchema)
      ]
    });
  });
});

If this schema comming from another plugin then you can replace this "self written plugin" with actual one

[L2jLiga]

I've released v3.14.0

In new version you can provide instane option which is FastifyInstance so you can easily preconfigure your instance for tests with all required schemas and so on..

[AmusedArg]

Nice!

But I'm having another issue now, when passing my instance to the configureControllerTest() I'm getting the following error:

Method 'GET' already declared for route '/api/:/suggestions' with constraints '{}'

[L2jLiga]

I guess you're passing instance from your main file, if so this will not work because it's already has registered routes, in order to make it work you have to create new instance within your test, preferably in same book and setup your instance with everything needed.

[L2jLiga]

Anyway it might be good idea for improving testing experience to provide option to mock services in already set up instance but I have no idea how to make it with current library structure and behavior

[AmusedArg]

Yup I was using that instance.

I will try that then. Thank you very much!!