如何将Cypress代码覆盖率集成至Sonar平台？

一、纠正Sonar参数错误 #

你之前用的-Dsonar.apex.coverage.reportPath是针对Salesforce Apex代码的，完全不适用JS项目；-Dsonar.testExecutionReportPaths是用来导入测试执行结果（比如哪些用例通过/失败），不是代码覆盖率。JS项目的代码覆盖率需要用以下参数：

• 对于LCov格式报告（Sonar官方推荐的JS覆盖率格式）：-Dsonar.javascript.lcov.reportPaths=coverage/lcov.info
• 如果一定要用JSON格式（Sonar仅兼容特定结构的JSON，coverage-final.json无法直接使用），需先转成Sonar适配格式，但更推荐用LCov。

二、让Cypress code-coverage直接生成LCov报告 #

不需要额外用nyc手动转换，Cypress的code-coverage插件本身可配置生成LCov格式：

1. 在Cypress配置文件（如cypress.config.js）中修改codeCoverage配置：

module.exports = defineConfig({
  e2e: {
    setupNodeEvents(on, config) {
      require('@cypress/code-coverage/task')(on, config);
      return config;
    },
  },
  env: {
    codeCoverage: {
      reporter: ['lcov', 'json'], // 同时生成LCov和JSON，满足不同需求
      dir: './coverage', // 报告输出目录
    },
  },
});

2. 重新运行Cypress测试，coverage目录下会自动生成lcov.info文件。

三、nyc转换coverage-final.json为LCov（备用方案） #

如果上述配置未生效，可手动用nyc处理现有JSON报告：

1. 安装nyc：npm install nyc --save-dev
2. 在package.json中添加转换脚本：

{
  "scripts": {
    "coverage:convert": "nyc report --reporter=lcov --temp-dir=./coverage --report-dir=./coverage"
  }
}

3. 先运行Cypress测试生成coverage-final.json，再执行npm run coverage:convert，即可在coverage目录得到lcov.info。

四、Sonar扫描的正确命令 #

确保SonarQube服务正常，执行以下扫描命令（替换为你的项目信息）：

sonar-scanner \
  -Dsonar.projectKey=你的项目Key \
  -Dsonar.projectName=你的项目名称 \
  -Dsonar.projectVersion=1.0 \
  -Dsonar.sources=./src \ # 你的源码目录
  -Dsonar.javascript.lcov.reportPaths=./coverage/lcov.info \
  -Dsonar.host.url=http://你的Sonar地址 \
  -Dsonar.login=你的Sonar令牌

常见问题排查 #

• 确认lcov.info路径正确，CI环境需确保报告文件未被清理
• 检查SonarQube版本（建议用LTS版本，较新版本均支持JS覆盖率）
• 验证Cypress测试覆盖了目标代码，避免报告为空

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