c# - 使用fxcop申请sonarqube自定义规则我错过了什么？

Question

我想使用 fxcop 申请自己的 sonarqube 自定义规则。 SonarScan 使用 MSBuild 成功，但是 sonarqube 没有反射(reflect)规则!

我引用了这个 url - https://github.com/DanielHWe/sonar-fxcop

我试了很多次。如果您对此问题有经验，请提出一些建议。

• 我的开发环境

Visual Studio 2017

MSBuild 15

Sonar 6.7.7

适用于 MSBuild 4.6.2 的 SonarScanner

FxCop 插件 1.4.1

C# 插件( Sonar )7.15

首先，我在下面设置了 sonarqube 服务器:

1. 我在本地主机上设置了 sonarqube 6.7.7
2. 我添加到 fxcop 插件 1.4( https://community.sonarsource.com/t/new-release-fxcop-plugin-version-1-4/1430 )
3. 我在 sonarqube 质量配置文件上创建了 fxcop 自定义规则模板

我写在下面

名称:SampleCustomRule

键:SampleCustomRule

描述:SampleCustomRule

校验码:SK100

1. 我在 sonarqube 规则上激活了这条规则

其次，我在下面创建了示例 fxcop 自定义规则 (Visual Studio):

我引用了这个视频。( https://www.youtube.com/watch?v=arHybNYWj04 )

1. 创建类库
2. 添加引用(FxCopSdk、Microsoft.Cci)
3. 创建示例规则 .cs 和 rules.xml
4. 创建签名文件(.pfx)
5. 构建项目
6. 将我的程序集 (.dll) 复制到 C:\Program Files (x86)\Microsoft Visual Studio 12.0\Team Tools\Static Analysis Tools\FxCop\Rules

第三，我执行了MSBuild(SonarScanner)

1. 以管理员身份运行(VS 2019 的开发人员命令提示符)
2. 我在下面输入了命令

SonarScanner.MSBuild.exe begin/k:"ConsoleApp10"/n:"ConsoleApp10"/v:"3.6"/d:"sonar.cs.fxcop.assembly=C:\Users\ezcare\Desktop\FxCopTest\FxCopTest\bin\Debug\FxCopTest.dll"/d:"sonar.cs.fxcop.fxCopCmdPath=C:\Program Files (x86)\Microsoft Visual Studio 12.0\Team Tools\Static Analysis Tools\FxCop\FxCopCmd.exe"/d:"sonar.cs.fxcop.directory=C:\Users\ezcare\Desktop\FxCopTest\FxCopTest\bin\Debug"

MSBuild.exe C:\Users\ezcare\source\repos\ConsoleApp10/t:重建

SonarScanner.MSBuild.exe 结束

1. 结果是成功了。

我检查了作为我的自定义规则检查的项目，但没有任何代码味道或其他东西。

下面是我的自定义规则代码(.cs & .xml)

using Microsoft.FxCop.Sdk;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

[assembly: CLSCompliant(true)]
namespace FxCopTest
{
    public class SampleCustomRule : BaseIntrospectionRule
    {
        public SampleCustomRule():
        base(@"SampleCustomRule", "FxCopTest.Rules", typeof(SampleCustomRule).Assembly)
        {

        }
        public override ProblemCollection Check(TypeNode type)
        {
            if(!type.Namespace.Name.StartsWith("SK", StringComparison.Ordinal))
            {
                var resolution = GetResolution(type.Name.Name);
                var problem = new Problem(resolution, type)
                {
                    Certainty = 100
                    //FixCategory = FixCategories.NonBreaking,
                    //MessageLevel = MessageLevel.Warning
                };
                base.Problems.Add(problem);

            }
            return base.Problems;
        }
    }
}


<?xml version="1.0" encoding="utf-8" ?>
<Rules>
  <Rule TypeName="SampleCustomRule" Category="CustomRules.Naming" CheckId="SK100">
    <Name>All type namespace should start with 'SK'</Name>
    <Description>SK</Description>
    <Resolution>The name of type {0} should start 'SK'</Resolution>
    <MessageLevel Certainty="100">Warning</MessageLevel>
    <FixCategories>NonBreaking</FixCategories>
    <Url/>
  </Rule>
</Rules>

Answer 1

我不建议使用 FxCop 为 C# 或 VB.NET 编写新规则，尤其是当您想将问题导入 SonarQube 时。

首先，几年前，FxCop 被更强大、更易用的 Roslyn 框架所取代。在 Roslyn 中编写自定义规则更简单，网络上有许多资源可以帮助您，例如Getting Started with Roslyn Analyzers (如果您已设法在 FxCop 中编写自定义规则，那么使用 Roslyn 编写自定义规则将毫无问题!)。

其次，SonarQube 和 Scanner for MSBuild 为从自定义 Roslyn 分析器导入问题作为“外部问题”提供开箱即用的支持。基本上，这意味着如果您将新的 Roslyn 分析规则打包为 NuGet 包，然后在您要分析的项目中引用该 NuGet 包，MSBuild 扫描器会自动将问题上传到 SonarQube。

但是，外部问题有一些限制，如 SonarQube documentation 中所述- 您不能在质量配置文件中配置要执行的规则，不能在 UI 中将问题标记为误报等，并且您有责任将自定义 Roslyn 分析器 NuGet 包添加到您想要的所有 MSBuild 项目进行分析。

要绕过所有这些限制，您可以使用 SonarQube Roslyn SDK生成一个自定义的 SonarQube 插件 jar 来打包你的自定义 Roslyn 分析器。您不需要编写任何代码；只需针对您的 Roslyn NuGet 包运行 RoslynSonarQubePluginGenerator.exe，它将创建一个插件 jar。

一旦您将生成的自定义 SonarQube 插件安装到您的 SonarQube 实例中，您将能够在质量配置文件中配置您的规则，将问题标记为 FP 等，并且 MSBuild 的扫描器将负责执行您的分析规则作为一部分构建的一部分，因此您无需从要分析的每个 MSBuild 项目中引用自定义 Roslyn 分析器 NuGet 包。