API test

stubbing-api-test.spec.ts

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

// imports ...

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

  const users = [
    { id: 1, email: 'email1', roles: [Role.ADMIN], invitePending: false },
    { id: 2, email: 'email2', roles: [Role.ADMIN], invitePending: true },
  ];

  await setStubbing('get-users', users); // stub the backend method labelled 'get-users'

  const actualUsers = await getUsers(); // get actual users with the API function under test
  
  expect(actualUsers).toEqual<User[]>(users); // verify correctness
});

it('getting users is not public', async () => {
  logout();
  await expectUnauthorized(getUsers); // helper calls the referenced function & asserts unauthorized error
});

We can stub the backend method because it was labelled on the backend.

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

Originally published as part of this article.