SonarQube 如何创建配置文件并向其导入新规则

Question

我正在为 SonarQube 开发一个插件，以便从 .xml 文件导入规则。到目前为止，这已经完成，它们确实被导入到 SonarQube 实例中并显示在 "Rules" 下。虽然正在创建质量配置文件，但没有将所有导入的规则添加到其中，我不明白为什么。

我不想一个一个地手工添加；一旦它们从 .xml 文件导入，我正在寻找一种方法将它们直接添加到创建的配置文件中。配置文件是通过以下方式简单创建的：

public class MyProfile extends ProfileDefinition {
    @Override
    public RulesProfile createProfile(ValidationMessages validation) {
        return RulesProfile.create("QP", "Java");
    }
}

以下是我怀疑会实现此目的的一些方法代码：

public class MyRules extends RulesDefinition {

public void define(Context context) {
    List<RulePack> rulePacks = this.rulePackParser.parse();
    parseXml(context);                                                      
    parseRulePacks(context, rulePacks);
    for (NewRepository newRepository : newRepositories.values()) {
        newRepository.done();
    }
}

private void parseXml(Context context) {
    for (Language supportedLanguage : languages.all()) {
        InputStream rulesXml = this.getClass().getResourceAsStream("/rules-TESTE.xml");
        if (rulesXml != null) {
            NewRepository repository = getRepository(context, supportedLanguage.getKey());
            xmlLoader.load(repository, new BufferedReader(new InputStreamReader(rulesXml)));
            repository.done();
        }
    }
}

private void parseRulePacks(Context context, List<RulePack> rulePacks) {
    for (RulePack rulePack : rulePacks) {
        for (AppScanRule rule : rulePack.getRules()) {
            String sqLanguageKey = convertToSQ(rulePack.getRuleLanguage(rule));
            if (this.languages.get(sqLanguageKey) != null && isAnInterestingRule(rule)) {
                processRule(context, rulePack, rule, sqLanguageKey);
            }
        }
    }
}
}

提前致谢。

Answer 1

编辑说明：所描述的将规则实际添加到质量配置文件的过程可以被视为一种解决方法，因为当时 SonarQube 的引擎存在一个未解决的问题' 允许一次访问所有规则，以便轻松添加到所需的质量配置文件中（可以查看此问题 here）。所以从 5.6 开始的版本可以这样做：

自己实现了 class 扩展 ProfileDefinition;
覆盖方法 public RulesProfile createProfile(ValidationMessages messages) 并创建配置文件对象 RulesProfile profile = RulesProfile.create();
在该方法上，通过 Collection<Rule> rules = ruleFinder.findAll(RuleQuery.create().withRepositoryKey(key-of-the-repository-with-the-desired-rules)); 获取所有规则（findAll 是被破坏的方法）
激活配置文件上的规则：

for(Rule rule : rules) { profile.activateRule(rule, null); }
最后可以设置一些定义，例如配置文件的语言或名称。之后 return 新创建的配置文件对象：

profile.setLanguage("Java"); profile.setName("My Profile"); return profile;

所以我能够解决这个问题，但采用了一种非常不同的方法。为了使用我的新规则添加质量配置文件，我使用了 SonarQube 的 REST Web API docs.sonarqube.org/display/DEV/Web+Service+API. The client that I used for sending/receiving requests to/from the API was Postman. The available commands are also documented in nemo.sonarqube.org.

经过一些失败后，我发现这个过程似乎有一些使用限制。为了让这个工作我必须：

首先，在问题中给出的插件代码中，我必须使用 class 加载包含规则的 .XML 文件RulesDefinitionXmlLoader 方法 load 像这样：
```
xmlLoader.load(repository, new BufferedReader(newInputStreamReader(rulesXml)));
```

这个过程我其实很甜蜜，你可以很容易地加载你的规则。您所要做的就是确保包含规则的 .XML 文件遵循以下标准模板：

<rules>
    <rule>
        <repositoryKey>java-key</repositoryKey>
        <key>1</key>
        <internalKey> da-rule-name-1</internalKey>
        <name> da-rule-name </name>
        <description>da-description </description>
   </rule>
</rules>

这里主要关注的是 repositoryKey，因为其余列出的字段是强制性的。您必须确保此处使用的密钥与用于添加质量配置文件的 same 相同（我将在接下来展示）。此键在 class extending RulesDefinition（我在问题中提供的最重要的代码）while creating a repository.

如果有帮助，您还可以使用 Web 请求 API 来列出所有存储库，这样您就可以确保使用的密钥是正确的：

像上一个文件一样创建一个 .XML 文件，但包含以下信息。这是 REST Web API 用来创建质量配置文件的文件：

<profile>
    <name>da-profile-name</name>
    <language>java</language>
    <rules>
        <rule>
            <repositoryKey>java-key</repositoryKey>
            <key>1</key>
            <internalKey> da-rule-name-1</internalKey>
            <name> da-rule-name </name>
            <description>da-description </description>
       </rule>
    </rules>
</profile>

最后，您所要做的就是使用创建的第二个文件将请求发送到 Web API。为此，您可以像我说的那样使用 Postman（如果您像我一样使用 REST APIs 的知识较少或 none）或命令提示符（在这种情况下需要 install Curl). 在邮递员中：
1. 将请求设置为"Post"并添加URL（假设SonarQube在本地机器上并监听默认端口）：http://localhost:9000/api/qualityprofiles/restore
2. 设置"Authorization"。默认为 "admin"/"admin";
3. 在"Body"处设置一个参数"key" = "backup"和"value"作为一个文件（select下箭头）和 select 创建的第二个文件（带有规则和配置文件额外标签的文件）.

发送请求，如果一切顺利你应该能够在底部看到window成功导入规则的数量！

SonarQube 如何创建配置文件并向其导入新规则

SonarQube how to create Profile and import new rules to it

plugins

sonarqube

user-profile

sonarqube-web