3

我有一个具有以下结构的应用程序：

my-application
  +- pom.xml
  +- app
  |   +- scripts
  |   |   +- app.js
  |   |   +- **/*.js
  |   +- 3rd-party-libs
  +- build
  +- node_modules
  +- test

我创建了pom.xml唯一运行 SonarQube 分析的程序。否则，所有任务都由 Grunt 运行（测试使用 Karma 运行）。

的内容pom.xml如下：

<properties>
    <sonar.language>js</sonar.language>
    <sonar.sourceEncoding>UTF-8</sonar.sourceEncoding>
    <sonar.javascript.coveragePlugin>lcov</sonar.javascript.coveragePlugin>
    <sonar.javascript.lcov.reportPath>build/karma/coverage/lcov.info</sonar.javascript.lcov.reportPath>
    <sonar.exclusions>app/3rd-party-libs/**,node_modules/**</sonar.exclusions>
    <sonar.dynamicAnalysis>reuseReports</sonar.dynamicAnalysis>
</properties>

<build>
    <sourceDirectory>app/scripts</sourceDirectory>
    <testSourceDirectory>test</testSourceDirectory>
</build>

当我运行时grunt test，它会创建一个build/karma/coverage/lcov.info包含以下信息的：

TN:
SF:./app/scripts/app.js
FN:16,(anonymous_1)
FN:26,(anonymous_2)
FNF:2
...

在 SonarQube 分析之后，仪表板显示 0% 的代码覆盖率。

我怀疑 中的路径SF:是错误的根源。因此，我更改了sonar.javascript.lcov.reportPath属性以使用另一个属性来lcov.info测试不同的值：app.js, ./app.js, app/scripts/app.js, ./app/scripts/app.js, 但没有一个起作用，将覆盖率保持为 0%。

我错过了什么？

以防万一，我的配置中有以下配置karma.conf.js：

coverageReporter: {
  reporters: [
    {
      type: 'lcov',
      dir: 'build/karma/coverage',
      subdir: '.'
    }
  ]
},

ps：声纳版本是3.7.2，不过我也试过4.3，结果一样……

编辑：我已经更新了我的配置以直接使用 Sonar-runner，我使用的是最新版本的 Sonar（5.0.1）和 JS 插件（2.3）。我还手动修改了lcov.info具有“良好”格式（至少一种与 Sonar repo 示例匹配的格式）：

SF:./app/scripts/app.js
DA:2,1
DA:20,1
DA:29,1
DA:34,1
end_of_record
SF:./app/scripts/services/exampleService.js
DA:1,1
DA:11,1
DA:12,0
end_of_record

sonar-project.properties看起来像：

sonar.projectKey=xxx
sonar.projectName=xxx
sonar.projectVersion=xxx
sonar.sourceEncoding=UTF-8

sonar.sources=app/scripts
sonar.tests=test
sonar.exclusions=app/3rd-party-libs/**,node_modules/**
sonar.dynamicAnalysis=reuseReports
sonar.language=js
sonar.projectBaseDir=.
sonar.javascript.coveragePlugin=lcov
sonar.javascript.lcov.reportPath=build/karma/coverage/lcov.info

而且，0% 的覆盖率 :(

4

1 回答 1

6

我一无所知，所以我决定修改JavaScript 插件以添加更多日志。我终于找到了错误，这是一个......区分大小写的恶性问题！

让我解释。让我们考虑以下saveMeasureFromLCOVFile方法CoverageSensor.java：

  protected void saveMeasureFromLCOVFile(SensorContext context) {
    String providedPath = settings.getString(JavaScriptPlugin.LCOV_REPORT_PATH);
    File lcovFile = getIOFile(fileSystem.baseDir(), providedPath);
    ...
    LOG.info("Analysing {}", lcovFile);

    LCOVParser parser = new LCOVParser(fileSystem.baseDir());
    Map<String, CoverageMeasuresBuilder> coveredFiles = parser.parseFile(lcovFile);

    for (InputFile inputFile : fileSystem.inputFiles(mainFilePredicate)) {
      try {
        CoverageMeasuresBuilder fileCoverage = coveredFiles.get(inputFile.file().getAbsolutePath());
        org.sonar.api.resources.File resource = org.sonar.api.resources.File.create(inputFile.relativePath());

        if (fileCoverage != null) {
          for (Measure measure : fileCoverage.createMeasures()) {
            context.saveMeasure(resource, measure);
          }
        } else {
          // colour all lines as not executed
          LOG.debug("Default value of zero will be saved for file: {}", resource.getPath());
          LOG.debug("Because: either was not present in LCOV report either was not able to retrieve associated SonarQube resource");
          saveZeroValueForResource(resource, context);
        }
      } catch (Exception e) {
        LOG.error("Problem while calculating coverage for " + inputFile.absolutePath(), e);
      }
   }
  }

首先，它读取lcov.info给定的文件以了解我们拥有哪些文件的覆盖率数据（通过解析文件检索，使用LCOVParser类完成）。之后，它会从coveredFiles地图中获取相同的文件来进行指标和代码之间的匹配。如果找不到文件（else部分if (fileCoverage != null) {），则代码覆盖率被强制为 0。

这就是我的项目中发生的事情。

那么为什么会这样呢？仅仅因为在我的环境中，inputFile等于d:\dev\my-application\app\scripts\app.js并且在coveredFiles地图中，我有D:\dev\my-application\app\scripts\app.js. d:请注意驱动器号（反对D:）中大小写的区别。因为map.get(...)是区分大小写的，fileCoverage所以是null，然后不计算覆盖率。

现在，我必须调查如何强制路径具有正确的案例......

经过更多调查，我发现插件代码中的修改有效（至少对我来说，我没有考虑到所有可能的影响）。在LCOVParser中，filePath = CoverageSensor.getIOFile(moduleBaseDir, filePath).getCanonicalPath();可以修改为filePath = CoverageSensor.getIOFile(moduleBaseDir, filePath).getAbsolutePath();，因为第一个返回路径，D:\...而第二个将返回d:\...。

事实上，我什至不是在 Windows 上使用的首选案例。以下代码：

public static void main(String[] args) throws IOException {
    System.out.println("PATH 1 : " + new File(".").getAbsolutePath());
    System.out.println("PATH 2 : " + new File(".").getCanonicalPath());
}

将返回：

PATH 1 : D:\dev\preclosing\preclosing-eme\.
PATH 2 : D:\dev\preclosing\preclosing-eme

无论如何，我暂时被卡住了，我什至不确定如何在不等待 JS 插件修复的情况下解决我的问题（因为我的“官方”Sonar 目前有点旧，只支持 JS 插件到 v2.1)。

于 2015-02-25T15:11:07.893 回答