Mocking modules and functions in Node.js

Introduction

Mocking helps you test code by replacing real parts with fake ones. This way, you can check how your code works without using the real modules or functions.

When you want to test a function that calls another module without running the real module.

When the real module depends on slow or external services like databases or APIs.

When you want to simulate different responses from a function to see how your code handles them.

When you want to isolate a part of your code to find bugs easily.

When you want to avoid side effects like sending emails or writing files during tests.

Syntax

Node.js

import { jest } from '@jest/globals';

// Mock a whole module
jest.mock('module-name');

// Mock a specific function
import * as module from 'module-name';
jest.spyOn(module, 'functionName').mockImplementation(() => fakeValue);

jest.mock() replaces the whole module with a mock version.

jest.spyOn() lets you replace just one function inside a module.

Examples

This replaces the entire 'fs' module with a mock version for testing.

Node.js

jest.mock('fs');

This mocks only the 'add' function from the 'math' module to always return 10.

Node.js

import * as math from './math';
jest.spyOn(math, 'add').mockImplementation(() => 10);

This mocks the 'axios' module's 'get' method to return a fake resolved promise.

Node.js

jest.mock('axios', () => ({
  get: jest.fn(() => Promise.resolve({ data: 'mocked data' }))
}));

Sample Program

This example shows how to mock the fetchData function from a module. Instead of returning 'real data', it returns 'mocked data' during the test.

Node.js

import { jest } from '@jest/globals';

// Original module
export function fetchData() {
  return 'real data';
}

// Test file
import * as dataModule from './dataModule';

// Mock fetchData function
jest.spyOn(dataModule, 'fetchData').mockImplementation(() => 'mocked data');

console.log(dataModule.fetchData());

Important Notes

Always reset mocks after tests to avoid interference using jest.resetAllMocks().

Mocking helps keep tests fast and reliable by avoiding real external calls.

Use mocks carefully to not hide real bugs in your code.

Summary

Mocking replaces real modules or functions with fake ones for testing.

Use jest.mock() for whole modules and jest.spyOn() for specific functions.

Mocking helps test code in isolation and avoid slow or unreliable dependencies.

Practice

1. What is the main purpose of mocking modules or functions in Node.js testing?

easy

A. To replace real modules or functions with fake ones for isolated testing

B. To speed up the production code execution

C. To permanently change the behavior of modules in the app

D. To automatically generate documentation for modules

Solution

1. Step 1: Understand mocking concept

   Mocking means replacing real code with fake versions to test parts independently.

2. Step 2: Identify purpose in testing

   This helps avoid slow or unreliable dependencies and focuses tests on the code itself.

3. Final Answer:

   To replace real modules or functions with fake ones for isolated testing -> Option A

4. Quick Check:

   Mocking = isolated testing [OK]

Hint: Mocking means faking parts to test code alone [OK]

Common Mistakes:

• Thinking mocking speeds up production code
• Believing mocking changes app behavior permanently
• Confusing mocking with documentation generation

2. Which of the following is the correct syntax to mock an entire module named utils using Jest?

easy

A. jest.spyOn('utils')

B. jest.fake('utils')

C. jest.mock('utils')

D. mock('utils')

Solution

1. Step 1: Recall Jest mocking syntax

   Jest uses jest.mock('moduleName') to mock entire modules.

2. Step 2: Match syntax to options

   Only jest.mock('utils') uses the correct jest.mock() function with the module name.

3. Final Answer:

   jest.mock('utils') -> Option C

4. Quick Check:

   jest.mock() mocks modules [OK]

Hint: Use jest.mock('moduleName') to mock whole modules [OK]

Common Mistakes:

• Using jest.spyOn for whole modules instead of functions
• Trying mock() or jest.fake() which don't exist
• Passing module name incorrectly as a variable

3. Given the code below, what will be the output of console.log(fetchData()) after mocking?

import * as api from './api';

jest.mock('./api', () => ({
  fetchData: () => 'mocked data'
}));

console.log(api.fetchData());

medium

A. 'real data'

B. 'mocked data'

C. undefined

D. Error: fetchData is not a function

Solution

1. Step 1: Understand jest.mock replacement

   The jest.mock call replaces the entire './api' module with the provided object.

2. Step 2: Check the mocked function return

   The mocked fetchData returns the string 'mocked data'.

3. Final Answer:

   'mocked data' -> Option B

4. Quick Check:

   Mocked function returns mocked data [OK]

Hint: Mocked functions return what you define in jest.mock [OK]

Common Mistakes:

• Expecting original function output
• Assuming undefined because of mocking
• Confusing import and mock timing

4. What is wrong with this Jest mocking code snippet?

import * as math from './math';

jest.spyOn(math, 'add');

math.add.mockReturnValue(10);

console.log(math.add(2, 3));

medium

A. No error, the code works and logs 10

B. mockReturnValue cannot be used on spy without mockImplementation

C. The spy is created correctly, but math.add is not mocked properly

D. jest.spyOn should be called after calling math.add

Solution

1. Step 1: Understand jest.spyOn usage

   jest.spyOn creates a mock function that can be controlled.

2. Step 2: Check mockReturnValue usage

   Calling mockReturnValue(10) on the spy sets the return value to 10.

3. Final Answer:

   No error, the code works and logs 10 -> Option A

4. Quick Check:

   spyOn + mockReturnValue works [OK]

Hint: spyOn returns a mock you can control directly [OK]

Common Mistakes:

• Thinking spyOn needs mockImplementation first
• Believing spyOn must be after function call
• Assuming spyOn does not mock return values

5. You want to mock only the sendEmail function from the notifications module to return true during tests, but keep other functions real. Which is the best approach?

hard

A. Use jest.mock('notifications') and redefine all functions manually

B. Replace the entire module with a fake object returning true for sendEmail

C. Import sendEmail separately and overwrite it directly

D. Use jest.spyOn(notifications, 'sendEmail').mockReturnValue(true)

Solution

1. Step 1: Understand partial mocking need

   We want to mock only one function, not the whole module.

2. Step 2: Use jest.spyOn for specific function

   jest.spyOn allows mocking a single function while keeping others real.

3. Final Answer:

   Use jest.spyOn(notifications, 'sendEmail').mockReturnValue(true) -> Option D

4. Quick Check:

   spyOn mocks single function only [OK]

Hint: Use jest.spyOn to mock one function, not whole module [OK]

Common Mistakes:

• Mocking entire module unnecessarily
• Trying to overwrite imported functions directly
• Not using spyOn for partial mocks