Integration testing patterns in Node.js - Step-by-Step Execution

Concept Flow - Integration testing patterns

Write test cases for multiple modules

↓

Setup test environment (DB, APIs)

↓

Run integration tests

↓

Check combined module outputs

↓

Report success or failure

↓

Clean up environment

Integration testing runs tests on combined parts of the system to check they work together correctly.

Execution Sample

Node.js

import request from 'supertest';
import app from './app.js';

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

This test checks if the /users API endpoint returns a successful response with status 200.

Execution Table

Step	Action	Evaluation	Result
1	Import test modules	Modules loaded	Ready to run tests
2	Send GET request to /users	Request sent	Waiting for response
3	Receive response	Status code received	Status = 200
4	Check status code == 200	Condition true	Test passes
5	Report test result	Test passed	Success message shown
6	Clean up test environment	Environment reset	Ready for next test

💡 Test ends after verifying response status and cleaning up environment

Variable Tracker

Variable	Start	After Step 2	After Step 3	After Step 4	Final
response.status	undefined	undefined	200	200	200
testResult	undefined	undefined	undefined	pass	pass

Key Moments - 2 Insights

Why do we need to set up a test environment before running integration tests?

Integration tests check combined modules, so a test environment with databases or APIs must be ready to simulate real conditions, as shown in step 1 and step 6 of the execution_table.

What happens if the response status is not 200?

If the status is not 200, the condition in step 4 fails, causing the test to fail and report an error instead of success.

Visual Quiz - 3 Questions

Look at the execution_table, what is the response status after Step 3?

A 404

B 200

C 500

D undefined

💡 Hint

Check the 'response.status' value in variable_tracker after Step 3

At which step does the test confirm if the API response is successful?

A Step 2

B Step 3

C Step 4

D Step 5

💡 Hint

Look at the 'Check status code == 200' action in execution_table

If the test environment is not cleaned up, which step is skipped?

A Step 6

B Step 4

C Step 1

D Step 5

💡 Hint

Refer to the 'Clean up test environment' action in execution_table

Concept Snapshot

Integration testing checks if multiple parts work together.
Set up a test environment (DB, APIs) before tests.
Run tests that call combined modules or endpoints.
Verify outputs and status codes.
Clean up environment after tests.
Use tools like supertest for Node.js API testing.

Full Transcript

Integration testing patterns involve writing tests that check how different parts of a system work together. First, you write test cases that cover multiple modules or components. Then, you set up a test environment, which may include databases or external APIs, to simulate real conditions. Next, you run the integration tests, such as sending HTTP requests to API endpoints. You check the combined outputs, like response status codes or data returned, to confirm everything works as expected. Finally, you report the test results and clean up the environment to prepare for future tests. This process ensures that the system's parts integrate correctly and helps catch issues that unit tests alone might miss.

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