我们目前正在使用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
我们尝试过的:
- 在 TFS Build 任务中进行排除
- 绝对路径(带反斜杠或斜杠):
sonar.exclusions="$(Build.SourcesDirectory)\Source\ProjectA\Scripts\**\*.js"
(覆盖率类似) - 相对路径:
**/ProjectsA/Scripts/**/*.js
- 绝对路径(带反斜杠或斜杠):
- 在 SonarQube 前端进行排除
- 分析排除:
**/ProjectA/Scripts/**/*.js
- 覆盖率排除:
**/ProjectB/Views/**/*.cs
- 分析排除:
- 使用 sonar-project.properties 进行排除:
- 不支持,会导致以下错误:
sonar-project.properties files are not understood by the SonarScanner for MSBuild
- 不支持,会导致以下错误:
我们看到的:
SonarQube Web 界面中 Scanner Context 的日志为:
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]
我们没有尝试过的:
- 通过更改项目文件来排除单个文件
我们不想这样做,因为它不可维护。
- 排除整个项目
我们只想从解决方案中的单个项目中排除一些文件夹/模式。
Base dir: D:\agent1\_work\5\s\Source\Solution\Source\ProjectA
它包含ProjectA,所以你的过滤器**/ProjectA/Scripts/**/*.js
将不起作用。应该改为类似于**/Scripts/**/*.js
的形式。但是这个过滤器将从所有项目中删除所有的“Scripts”,这并不是你想要的结果。Ants通配符也不接受“..”,因此你无法向上移动目录。我有过类似的问题,最后只能删掉了我不想分析的文件。我会给你点赞的,因为我也对答案很感兴趣。 - PeskaSonarQube.Scanner.MSBuild.exe begin
2.MSBuild.exe
3.删除文件 4.SonarQube.Scanner.MSBuild.exe end
。它会给您关于SonarQube中缺少文件的警告,但除此之外,一切都会很好。但正如我所说,这是一个奇怪的解决方法。我也对永久解决方案感兴趣。 - Peska