Integration testing patterns in Node.js - Mini Project: Build & Apply

Integration Testing Patterns in Node.js

📖 Scenario: You are building a simple Node.js service that manages a list of users. You want to write integration tests to check how different parts of your service work together.

🎯 Goal: Build a basic integration test setup using Node.js and a testing framework. You will create a simple user data array, configure a test helper, write a test that checks user retrieval, and complete the test file with proper exports.

📋 What You'll Learn

Create an array called users with three user objects with exact names and ids

Add a helper variable called testUserId with the value 2

Write a function called getUserById that returns a user object by matching id

Export the getUserById function and users array for testing

💡 Why This Matters

🌍 Real World

Integration testing is used to check how different parts of a Node.js application work together, such as data retrieval and business logic.

💼 Career

Understanding integration testing patterns is essential for backend developers to ensure their services behave correctly when components interact.

1

DATA SETUP: Create the user data array

Create an array called users with these exact user objects: { id: 1, name: 'Alice' }, { id: 2, name: 'Bob' }, and { id: 3, name: 'Charlie' }.

Node.js

// Create the users array with three user objects
// Your code here

Hint

Use const users = [ ... ] and include the exact objects inside the array.

2

CONFIGURATION: Add a test user ID variable

Add a constant variable called testUserId and set it to the number 2.

Node.js

const users = [
  { id: 1, name: 'Alice' },
  { id: 2, name: 'Bob' },
  { id: 3, name: 'Charlie' }
];

// Add testUserId variable below
// Your code here

Hint

Use const testUserId = 2; to create the variable.

3

CORE LOGIC: Write a function to get user by ID

Write a function called getUserById that takes an id parameter and returns the user object from users where user.id === id.

Node.js

const users = [
  { id: 1, name: 'Alice' },
  { id: 2, name: 'Bob' },
  { id: 3, name: 'Charlie' }
];

const testUserId = 2;

// Write getUserById function below
// Your code here

Hint

Use users.find() to locate the user with matching id.

4

COMPLETION: Export the function and data for testing

Add module.exports to export both getUserById and users so they can be used in integration tests.

Node.js

const users = [
  { id: 1, name: 'Alice' },
  { id: 2, name: 'Bob' },
  { id: 3, name: 'Charlie' }
];

const testUserId = 2;

function getUserById(id) {
  return users.find(user => user.id === id);
}

// Export getUserById and users below
// Your code here

Hint

Use module.exports = { getUserById, users }; to export both.

Practice

1. What is the main goal of integration testing in a Node.js application?

easy

A. To check the syntax of the code

B. To test individual functions in isolation

C. To verify that different parts of the app work together correctly

D. To measure the app's performance under load

Solution

1. Step 1: Understand integration testing purpose

   Integration testing focuses on checking if multiple parts of the app interact correctly, not just individual pieces.

2. Step 2: Compare with other testing types

   Syntax checking is done by linters, unit tests check single functions, and performance tests measure speed, so these are not integration tests.

3. Final Answer:

   To verify that different parts of the app work together correctly -> Option C

4. Quick Check:

   Integration testing = check parts working together [OK]

Hint: Integration tests check combined parts, not single functions [OK]

Common Mistakes:

• Confusing integration tests with unit tests
• Thinking integration tests check code syntax
• Mixing integration tests with performance testing

2. Which of the following is the correct way to define a setup hook in a Node.js integration test using Mocha?

easy

A. init(() => { /* setup code */ })

B. setup(() => { /* setup code */ })

C. start(() => { /* setup code */ })

D. beforeEach(() => { /* setup code */ })

Solution

1. Step 1: Recall Mocha setup hooks

   Mocha uses beforeEach and before hooks to run setup code before tests.

2. Step 2: Identify correct syntax

   Only beforeEach is a valid Mocha hook; setup, init, and start are not Mocha functions.

3. Final Answer:

   beforeEach(() => { /* setup code */ }) -> Option D

4. Quick Check:

   Mocha setup hook = beforeEach [OK]

Hint: Mocha uses beforeEach for setup, not setup or init [OK]

Common Mistakes:

• Using non-existent hook names like setup or init
• Confusing beforeEach with afterEach
• Forgetting arrow function syntax

3. Consider this Node.js integration test snippet using Jest and Supertest:

test('GET /users returns 200', async () => {
  const response = await request(app).get('/users');
  expect(response.statusCode).toBe(200);
});

What does this test check?

medium

A. That the /users endpoint returns a JSON array

B. That the /users endpoint returns a 200 status code

C. That the app throws an error on /users

D. That the /users endpoint is unreachable

Solution

1. Step 1: Analyze the test code

   The test sends a GET request to '/users' and checks the response status code.

2. Step 2: Understand the assertion

   The assertion expects the status code to be 200, meaning success.

3. Final Answer:

   That the /users endpoint returns a 200 status code -> Option B

4. Quick Check:

   Response status 200 means success [OK]

Hint: Check what the expect() function tests in the code [OK]

Common Mistakes:

• Assuming it checks response body instead of status
• Thinking it tests error or unreachable endpoint
• Ignoring async/await usage

4. You wrote this integration test using Jest:

beforeAll(() => {
  db.connect();
});

test('fetch data', async () => {
  const data = await db.getData();
  expect(data).toBeDefined();
});

afterAll(() => {
  db.disconnect();
});

But the test fails because the database connection is not ready. What is the likely problem?

medium

A. beforeAll should be async and await db.connect()

B. afterAll should run before the test

C. db.getData() should not be awaited

D. expect(data).toBeDefined() is incorrect syntax

Solution

1. Step 1: Check async setup in beforeAll

   Database connection is asynchronous, so beforeAll must be async and await db.connect() to ensure readiness.

2. Step 2: Verify other parts

   afterAll runs after tests, awaiting db.getData() is correct, and expect syntax is valid.

3. Final Answer:

   beforeAll should be async and await db.connect() -> Option A

4. Quick Check:

   Async setup needs await in beforeAll [OK]

Hint: Async setup needs await in beforeAll hook [OK]

Common Mistakes:

• Not making beforeAll async for async setup
• Misplacing afterAll before tests
• Ignoring await on async calls

5. You want to write an integration test for a Node.js app that creates a user via POST /users and then fetches it via GET /users/:id. Which pattern best ensures your test is reliable and isolated?

hard

A. Use setup hook to create a test user, then test GET /users/:id, and cleanup hook to delete the user

B. Run both POST and GET requests in the same test without cleanup

C. Only test GET /users/:id assuming user exists in database

D. Manually add user in database before tests and never delete

Solution

1. Step 1: Understand test isolation

   Tests should not depend on external data; setup creates needed data, cleanup removes it.

2. Step 2: Apply setup and cleanup hooks

   Creating a user in setup, testing GET, then deleting user in cleanup keeps tests reliable and repeatable.

3. Final Answer:

   Use setup hook to create a test user, then test GET /users/:id, and cleanup hook to delete the user -> Option A

4. Quick Check:

   Setup and cleanup keep tests isolated and reliable [OK]

Hint: Setup and cleanup hooks keep tests clean and repeatable [OK]

Common Mistakes:

• Not cleaning up test data causing flaky tests
• Assuming data exists without setup
• Combining unrelated tests without isolation