SonarQube MSBuild扫描仪不会从分析

时间:2018-04-13 12:05:41

标签: .net tfs msbuild sonarqube sonarqube-scan

我们目前正在使用SonarQube Scanner for VSTS / TFS 4.1.1(使用SonarQube Scanner 4.1.1)。

我们想做什么:

对于我们解决方案中的某些项目(模块),我们希望从分析和代码覆盖率统计信息中排除文件。这应该通过使用文件模式而不是修改TFS构建任务以可维护的方式完成。

项目结构:

    |- Source
      |- ProjectA
        |- Scripts (should be excluded)
        |- OwnCode
      |- ProjectB
        |- Views (only code coverage should be excluded)
        |- Presenters
        |- ...
      |- ProjectC
        |- Scripts (should be scanned)
        |- ...
      |- ...
      |- Solution.sln

我们尝试了什么:

  1. 排除在TFS构建任务中
    • 绝对路径(带反斜杠或斜杠):sonar.exclusions="$(Build.SourcesDirectory)\Source\ProjectA\Scripts\**\*.js"(类似于覆盖范围)
    • 相对路径:**/ProjectsA/Scripts/**/*.js
  2. 排除在SonarQube前端
    • 分析排除:**/ProjectA/Scripts/**/*.js
    • 覆盖范围排除:**/ProjectB/Views/**/*.cs
  3. 不包括sonar-project.properties:
    • 不受支持,会导致以下错误:sonar-project.properties files are not understood by the SonarScanner for MSBuild
  4. 我们看到了什么:

    SonarQube Web界面中扫描仪上下文的日志为:

      Settings for module: Solution:Solution:6FA7B5C2-667D-4387-98B9-445617F2AC0B
      - sonar.coverage.exclusions=**/ProjectA/Views/**/*.cs
      - sonar.cs.analyzer.projectOutPath=D:\agent1\_work\5\.sonarqube\out\9
      - sonar.cs.analyzer.projectOutPaths="D:\agent1\_work\5\.sonarqube\out\9"
      - sonar.cs.roslyn.reportFilePath=D:\agent1\_work\5\s\Source\Solution\Source\ProjectA\bin\Release\ProjectA.dll.RoslynCA.json
      - sonar.cs.roslyn.reportFilePaths="D:\agent1\_work\5\s\Source\Solution\Source\ProjectA\bin\Release\ProjectA.dll.RoslynCA.json"
      - sonar.exclusions=**/ProjectA/Scripts/**/*.js
      - sonar.moduleKey=Solution:Solution:6FA7B5C2-667D-4387-98B9-445617F2AC0B
      - sonar.projectBaseDir=D:\agent1\_work\5\s\Source\Solution\Source\ProjectA
      - sonar.projectKey=Solution:Solution:6FA7B5C2-667D-4387-98B9-445617F2AC0B
      - sonar.projectName=ProjectA
      - sonar.sourceEncoding=utf-8
      - sonar.sources="D:\agent1\_work\5\s\Source\Solution\Source\ProjectA\Scripts\abc.js","..."
    

    TFS版本中的MSBuild扫描程序的日志是:

    Base dir: D:\agent1\_work\5\s\Source\Solution\Source\ProjectA
    Working dir: D:\agent1\_work\5\.sonarqube\out\.sonar\Solution_Solution_6FA7B5C2-667D-4387-98B9-445617F2AC0B
    Source paths: Scripts/abc.cs, ...
    Source encoding: UTF-8, default locale: en_US
    Index files
    Excluded sources: 
      **/ProjectA/Scripts/**/*.js
    172 files indexed
    0 files ignored because of inclusion/exclusion patterns
    Quality profile for cs: Sonar way
    Quality profile for js: Sonar way
    Excluded sources for coverage: 
      **/ProjectB/Views/**/*.cs
    Sensor C# Properties [csharp]
    Sensor C# Properties [csharp] (done) | time=15ms
    Sensor SonarJavaXmlFileSensor [java]
    Sensor SonarJavaXmlFileSensor [java] (done) | time=0ms
    Sensor SonarJS [javascript]
    

    我们没有尝试:

    • 通过更改项目文件排除单个文件

    我们不想这样做,因为它无法维护。

    • 排除整个项目

    我们只想从解决方案中的单个项目中排除某些文件夹/模式。

2 个答案:

答案 0 :(得分:5)

部分答案:可以在SonarQube UI中按照“组件”(即每个MSBuild项目)配置代码覆盖率排除,因此您应该能够从coverage而不是分析中排除 ProjectB \ Views

导航到组件页面,然后选择管理常规设置分析范围标签中的 Coverage Exclusions 属性仅为此组件设置排除。

查找组件页面并不明显:单击SonarQube项目的代码选项卡。这将显示组件列表。单击您感兴趣的组件旁边屏幕上最左侧的图标:

Open component page

组件页面看起来与整个项目页面相同,但页面顶部的路径将显示项目和组件名称(下图中红色加下划线):

Component page

答案 1 :(得分:0)