Writing Jest Integration Tests

Jest integration tests are written in almost the same way as unit tests, so you should read and understand the Writing Jest Unit tests article before moving on to this one.

These are the key differences:

Integration tests are also named with a .test.js suffix, but they all live in the /tests root folder.
Integration tests can write some initial test data into an in-memory MongoDB store, allowing them to test database queries without mocking them.
Integration tests can send actual GraphQL requests to a server that is the same as the real server and is spun up temporarily while tests are running.

GraphQL Integration Tests

GraphQL integration tests are useful for testing things like:

Queries involving multiple resolvers
Response pagination
Whether mutations properly affect the MongoDB collections
The effect of complex permission rules on query results

Writing GraphQL Tests

The folder and file structure in /tests should match as much as possible the graphql plugin folder structure.

Prior to running the tests in each file, initialize a server, in-memory database, and any collection data you need. Then stop the server when done. The general pattern is something like this:

import TestApp from "/imports/test-utils/helpers/TestApp";

let testApp;
beforeAll(async () => {
  testApp = new TestApp();
  await testApp.start();
});

afterAll(() => testApp.stop());

test("something", async () => {
  // (1) use testApp.collections to write to MongoDB collections to set up initial data state
  // (2) execute a GraphQL query or mutation using testApp.query()() or testApp.mutation()()
  // (3) verify the response is as expected and/or verify that the collection data has been changed
  // (4) optionally reset the database if there is a chance it will conflict with the next test in this file
});

Inserting a Primary Shop

const shopId = await testApp.insertPrimaryShop();

Create a User With Associated Account

mockAccount = Factory.Accounts.makeOne({
  // ...any specific properties you need on the account
});
await testApp.createUserAndAccount(mockAccount);

Create a User with Owner Admin role

mockAdminAccount = Factory.Accounts.makeOne({
  // ...any specific properties you need on the account
});
await testApp.createUserAndAccount(mockAdminAccount, ["owner"]);

Set and Clear the Logged in User

beforeAll(async () => {
  await testApp.setLoggedInUser(mockAccount);
});

afterAll(async () => {
  await testApp.clearLoggedInUser();
});

mockAccount may either be an account document that you've already inserted or one that will be inserted for you. Either way, it must have an _id property on it. This will be used to set the user and account properties on the GraphQL context for all test queries.

Reaction Docs

3.0.0