如何用Sonar、Jest、Supertest提升Node.js异步操作代码覆盖率

嘿，我来帮你一步步搞定这个问题！你的接口里有个耗时的异步操作DeviceManager.ActivateDevices，当前测试只校验了状态码，要提升覆盖率，我们需要从Mock异步依赖、完善测试用例、Sonar集成这三个核心方向入手：

1. 先Mock耗时的异步依赖 #

因为ActivateDevices要1分钟才能完成，测试不可能真的等它执行完，所以我们要用Jest的Mock功能模拟这个方法的行为——既加快测试速度，又能验证它是否被正确调用。

操作步骤： #

在测试文件顶部，用jest.mock引入并模拟DeviceManager模块：

// 替换成你的DeviceManager实际文件路径
jest.mock('../services/DeviceManager');

Jest会自动生成一个Mock版本的DeviceManager，所有方法都会变成jest mock函数，我们可以在测试里灵活控制它的返回值或抛出的错误。

2. 编写覆盖全面的测试用例 #

现在我们可以针对接口的不同场景写测试，确保每一行代码都被覆盖到：

场景1：正常请求，验证返回结果和异步方法调用 #

test('should return pending status and trigger device activation', async () => {
  // 模拟ActivateDevices返回一个resolved的Promise（原接口不需要等待它完成）
  const mockActivate = jest.fn().mockResolvedValueOnce();
  require('../services/DeviceManager').ActivateDevices = mockActivate;

  const testRequestId = '791';
  const testMac = 'YUINH6767';
  const testAction = 'activate'; // 注意原接口从req.body取action，测试用例要补上这个参数！

  const res = await request(app)
    .post('/api/v1/devices/activate')
    .send({ mac: testMac, requestId: testRequestId, action: testAction });

  // 校验响应状态码
  expect(res.statusCode).toBe(200);
  // 校验响应体的每个字段是否符合预期
  expect(res.body).toEqual({
    requestId: testRequestId,
    message: 'Request is on processing',
    action: testAction,
    status: Config.STATUS.PENDING // 可直接写常量值，比如'PENDING'，如果Config可导入也可以用原常量
  });
  // 校验异步方法是否被正确调用，参数是否匹配
  expect(mockActivate).toHaveBeenCalledTimes(1);
  expect(mockActivate).toHaveBeenCalledWith({ mac: testMac, requestId: testRequestId, action: testAction });
});

场景2：处理异步方法的异常（可选，但能大幅提升覆盖率） #

原接口没有对ActivateDevices的异常做处理，如果这个异步方法抛出错误，会导致未捕获的Promise拒绝。建议先优化接口代码，加上错误处理：

api.post('/activate', async (req, res, next) => { 
  const { action, requestId } = req.body;
  try {
    // 如果需要捕获错误，最好await这个异步方法
    await DeviceManager.ActivateDevices(req.body); 
    res.send({ requestId, message: 'Request is on processing', action, status: Config.STATUS.PENDING }); 
    next();
  } catch (err) {
    next(err); // 把错误传给全局错误处理中间件
  }
})

然后对应的测试用例：

test('should pass error to next when activation fails', async () => {
  const mockError = new Error('Activation failed');
  const mockActivate = jest.fn().mockRejectedValueOnce(mockError);
  require('../services/DeviceManager').ActivateDevices = mockActivate;

  const res = await request(app)
    .post('/api/v1/devices/activate')
    .send({ mac: 'YUINH6767', requestId: '791', action: 'activate' });

  // 根据你的错误处理中间件返回的状态码调整，比如500
  expect(res.statusCode).toBe(500);
  // 可额外校验响应体的错误信息（如果你的错误中间件返回）
  expect(res.body.error).toBe('Activation failed');
});

3. 集成Sonar查看覆盖率报告 #

步骤： #

1. 开启Jest覆盖率收集：修改jest.config.js添加以下配置：

module.exports = {
  // 其他现有配置...
  collectCoverage: true,
  collectCoverageFrom: [
    'src/**/*.js', // 替换成你的源码目录
    '!node_modules/**',
    '!src/**/*.test.js'
  ],
  coverageReporters: ['lcov', 'text'] // 生成Sonar需要的lcov格式报告
};

2. 生成覆盖率报告：运行测试命令：

npm test

执行完成后会在项目根目录的coverage文件夹下生成lcov.info文件。

3. 配置Sonar读取报告：在项目根目录创建sonar-project.properties文件，添加：

sonar.projectKey=your-project-key
sonar.projectName=Your Project Name
sonar.javascript.coveragePlugin=lcov
sonar.javascript.lcov.reportPaths=coverage/lcov.info
sonar.sources=src/ # 你的源码目录路径

然后运行Sonar扫描命令（比如使用sonar-scanner），就能在Sonar dashboard里看到详细的覆盖率数据，包括哪些代码行未被覆盖，针对性补充测试用例即可。

内容的提问来源于stack exchange，提问作者Asish AP