API test (spying)

spying-api-test.spec.ts

// 👇 separate from other types of Jest tests
/**
 * @group integration/api
 */

// imports ...

it('admin creates user', async () => {
  await loginAs(Role.ADMIN); // login helper (setup 1 dummy user for each role)

  const user = { email: 'aNewEmail', roles: [Role.ADMIN] };

  await createUser(user); // call the API function

  expect(await getLastMethodCall()) // gets the last method call from the backend's API test spy endpoint
    .toEqual<MethodCall>(
      {
        method: 'create-user', // the call was made to the method labelled 'create-user'
        arguments: [user] // just one argument here, but can be more depending on the method signature
      }
    );
});

The @group test separation powered by jest-runner-groups.

Originally published as part of this article.

We spy the backend method because it was labelled on the backend.