使用 Jest 进行 JavaScript REST GET 请求的单元测试-js教程-PHP中文网

使用 Jest 进行 JavaScript REST GET 请求的单元测试

霞舞

发布： 2025-07-13 19:30:37

原创

410人浏览过

使用 jest 进行 javascript rest get 请求的单元测试

本文档旨在指导开发者如何使用 Jest 框架为 JavaScript 中的 REST GET 请求编写单元测试。我们将通过示例代码，详细介绍如何模拟 HTTP 请求、验证响应状态码和数据，以及处理错误情况，帮助你构建健壮可靠的测试用例，确保代码质量。

使用 Jest 测试 JavaScript REST GET 请求

在 JavaScript 开发中，经常需要与 REST API 进行交互。为了确保代码的正确性和可靠性，编写单元测试至关重要。本文将介绍如何使用 Jest 框架为 REST GET 请求编写测试用例。

前提条件

已安装 Node.js 和 npm。
已安装 Jest：npm install --save-dev jest

待测试的 GET 请求函数

假设我们有如下的 GET 请求函数，该函数使用 https 模块发起请求，并根据响应状态码调用不同的回调函数：

const https = require('https');

module.exports.get = function(req, url, callback, errorCallback) {
  https.get(getOptions(req, url), (response) => {
    handleResponse(response, callback, errorCallback);
  }).on('error', (e) => {
    console.error('MYAPP-GET Request.', e);
    if (errorCallback) {
      errorCallback(e);
    }
  });
};


function handleResponse(response, callback, errorCallback) {
  let rawData = '';
  response.on('data', (chunk) => {
    rawData += chunk;
  });

  response.on('end', () => {
    if (response.statusCode >= 200 && response.statusCode < 300) {
      callback(checkJSONResponse(rawData));
    } else if (errorCallback) {
      errorCallback(rawData);
    }
  });

}

function checkJSONResponse(rawData) {
  if (typeof rawData === 'object') {
    return rawData;
  }

  let data = {};
  if (rawData.length > 0) {
    try {
      data = JSON.parse(rawData);
    } catch (e) {
      console.log('Response is not JSON.');
      if (e) {
        console.log(e);
      }
      data = {};
    }
  }

  return data;
}

function getOptions(req, url) {
    // 这里只是一个占位符，实际项目中需要根据请求构造 options 对象
    return {
        hostname: new URL(url).hostname,
        path: new URL(url).pathname,
        method: 'GET'
    };
}

登录后复制

编写测试用例

接下来，我们将使用 Jest 编写测试用例来验证该函数的行为。

立即学习“Java免费学习笔记（深入）”；

创建测试文件： 创建一个名为 yourModule.test.js 的文件（与包含 get 函数的模块同名，后缀为 .test.js）。

引入模块和 Jest 函数：

const module = require('./yourModule'); // 替换为你的模块路径
const https = require('https');

登录后复制

编写测试套件： 使用 describe 函数创建一个测试套件，用于组织相关的测试用例。
```
describe("get", () => {
  // 测试用例将在这里编写
});
```
登录后复制

编写测试用例： 使用 it 函数编写单个测试用例。每个测试用例应关注函数的一个特定方面。

模拟成功的响应：

it("should get a successful response from a valid URL", (done) => {
  const url = "https://www.google.com";
  const expectedStatusCode = 200;
  const expectedData = {
    name: "Google",
    domain: "www.google.com",
  };

  // Mock https.get
  const mockResponse = {
      statusCode: expectedStatusCode,
      on: (event, cb) => {
          if (event === 'data') {
              cb(JSON.stringify(expectedData));
          }
          if (event === 'end') {
              cb();
          }
      }
  };

  const mockHttpsGet = jest.fn((options, callback) => {
      callback(mockResponse);
      return {
          on: () => {} // 模拟 on('error')
      };
  });

  https.get = mockHttpsGet;

  module.get(null, url, (data) => {
    expect(data).toEqual(expectedData);
    expect(mockHttpsGet).toHaveBeenCalledTimes(1);
    done(); // 通知 Jest 测试完成
  }, (error) => {
      fail('Should not have called error callback');
      done();
  });
});

登录后复制

解释:

我们首先定义了期望的 URL、状态码和数据。
然后，我们使用 jest.fn() 创建了一个 https.get 的模拟函数，该函数返回一个模拟的 response 对象，其中包含期望的状态码和数据。
我们使用 https.get = mockHttpsGet; 将 https.get 替换为我们的模拟函数。
我们调用 module.exports.get 函数，并验证回调函数是否接收到期望的数据，并且 https.get 是否被调用。
done() 函数用于通知 Jest 测试用例已完成，因为 module.exports.get 函数是异步的。

模拟错误的响应：

it("should get an error response from an invalid URL", (done) => {
  const url = "https://www.google.com/asdfasdf";
  const expectedStatusCode = 404;

  // Mock https.get
  const mockResponse = {
      statusCode: expectedStatusCode,
      on: (event, cb) => {
          if (event === 'data') {
              cb(''); // 模拟空数据
          }
          if (event === 'end') {
              cb();
          }
      }
  };

  const mockHttpsGet = jest.fn((options, callback) => {
      callback(mockResponse);
      return {
          on: (event, cb) => {
              if (event === 'error') {
                  // 模拟错误
                  cb(new Error('Request failed with status code 404'));
              }
          }
      };
  });

  https.get = mockHttpsGet;

  module.get(null, url, null, (error) => {
      expect(mockHttpsGet).toHaveBeenCalledTimes(1);
      done();
  });
});

登录后复制

解释:

与成功响应的测试用例类似，我们模拟了 https.get 函数，但这次我们返回一个具有错误状态码的模拟响应。
我们验证了 errorCallback 是否被调用。

测试 JSON 响应：

it("should get a JSON response", (done) => {
  const url = "https://api.github.com/users/bard";
  const expectedStatusCode = 200;
  const expectedData = {
    login: "bard",
    name: "Bard",
    email: "<a class=\"__cf_email__\" data-cfemail=\"a9cbc8dbcde9ccd1c8c4d9c5cc87cac6c4\" href=\"/cdn-cgi/l/email-protection\">[email protected]</a>",
  };

  // Mock https.get
  const mockResponse = {
      statusCode: expectedStatusCode,
      on: (event, cb) => {
          if (event === 'data') {
              cb(JSON.stringify(expectedData));
          }
          if (event === 'end') {
              cb();
          }
      }
  };

  const mockHttpsGet = jest.fn((options, callback) => {
      callback(mockResponse);
      return {
          on: () => {}
      };
  });

  https.get = mockHttpsGet;

  module.get(null, url, (data) => {
    expect(data).toEqual(expectedData);
    expect(mockHttpsGet).toHaveBeenCalledTimes(1);
    done();
  }, (error) => {
      fail('Should not have called error callback');
      done();
  });
});

登录后复制

解释:

此测试用例验证了当 API 返回 JSON 响应时，module.exports.get 函数是否正确解析 JSON 数据并将其传递给回调函数。

运行测试

在终端中，运行以下命令来运行测试：

npm test

登录后复制

Jest 将运行所有测试用例，并显示测试结果。

注意事项

清理模拟： 在每个测试用例之后，使用 jest.clearAllMocks() 清理模拟，以避免测试用例之间的干扰。
异步测试： 由于 module.exports.get 函数是异步的，因此需要使用 done() 回调函数或 async/await 来处理异步测试。
错误处理： 确保测试用例覆盖了所有可能的错误情况，例如无效的 URL、网络错误等。
Mock 的范围： 确保 mock 的范围尽可能的小，只 mock 必要的函数或模块，避免过度 mock。
测试覆盖率： 考虑使用 Jest 的测试覆盖率功能来确保你的测试用例覆盖了所有重要的代码路径。

总结

本文介绍了如何使用 Jest 框架为 JavaScript REST GET 请求编写单元测试。通过模拟 HTTP 请求、验证响应状态码和数据，以及处理错误情况，你可以构建健壮可靠的测试用例，确保代码质量。记住，良好的单元测试是高质量软件的基础。通过编写全面的测试用例，你可以及早发现和修复错误，提高代码的可维护性和可扩展性。

以上就是使用 Jest 进行 JavaScript REST GET 请求的单元测试的详细内容，更多请关注php中文网其它相关文章！