How to mock an axios request using sinon modules

In JavaScript testing, using the Sinon.js library to mock external HTTP requests (e.g., those made via Axios) is a common practice. This avoids making real network requests during unit tests, thereby improving test speed and stability. Below, I will provide a detailed explanation of how to use Sinon to mock Axios requests.

Step 1: Install the necessary libraries

Ensure you have installed sinon and axios. If not installed, you can install them using npm or yarn:

bash
npm install sinon axios --save-dev

Step 2: Create a Sinon sandbox

In your test file, first create a Sinon sandbox. This allows restoring all modifications at the end of the test, maintaining test independence and a clean environment.

javascript
import sinon from 'sinon';
import axios from 'axios';

describe('Axios Request Mocking Test', function() {
    let sandbox;

    beforeEach(function() {
        // Create the sandbox before each test
        sandbox = sinon.createSandbox();
    });

    afterEach(function() {
        // Restore the sandbox after each test
        sandbox.restore();
    });

    // Test cases...
});

Step 3: Mock Axios requests

In specific test cases, you can use the sandbox to mock axios.get or other HTTP methods. Assume we are testing a function fetchData that uses axios.get to fetch data from an external API.

javascript
import { fetchData } from './path/to/your/function';

it('should fetch data using Axios', async function() {
    // Mock the axios.get method
    const resolvedValue = { data: { userId: 1, id: 1, title: 'Example' } };
    const mock = sandbox.stub(axios, 'get').resolves(resolvedValue);

    // Call the actual function
    const result = await fetchData('https://jsonplaceholder.typicode.com/todos/1');

    // Assert the mock was called correctly
    sinon.assert.calledWith(mock, 'https://jsonplaceholder.typicode.com/todos/1');
    // Assert the returned data is correct
    assert.deepEqual(result, resolvedValue.data);
});

Step 4: Run the tests

Ensure you have the appropriate test runner and configured environment, then run the tests. If everything is set up correctly, your tests should be able to mock Axios requests and pass.

This example demonstrates how to use Sinon to mock external HTTP requests and verify that the function correctly uses the API. This approach allows you to test code logic without relying on real network requests, making unit tests more reliable and faster.