将带有描述的声纳规则导出到 excel

Question

我正在尝试找到一种方法，从带有描述的特定配置文件中获取所有 Sonarqube 规则的列表，并将其导出为 Excel、csv 或 xml。 我可以使用 Quality Profiles 下的 Permalinks 选项将列表导出到 xml 并转换为 excel，但这仅提供有关与每个规则关联的优先级、密钥、语言和配置文件名称的详细信息，而不提供任何类似于规则描述的信息。

我在论坛上发现了以下问题，其中概述了下载 xml 文件的步骤，其中列出了详细信息，但没有按要求提供说明

Export list of coding rules from Sonarqube

我还发现了这个问题，它也提出了关于如何获取每条规则的描述的相同问题，但无法获得所需的详细信息

sonar quality profile rule export with descrption

我能够运行上一个链接中提供的命令，通过从质量配置文件部分的永久链接下获得的 xml 中引用 repositoryke​​y 和 key_name 来获得一些所需的结果

curl -X GET -v -u admin:admin "http://[Sonarservername]:[port]/api/rules/show?key=[repositorykey]:[key_name]" --输出文件.xml

此命令提供所需的结果（规则描述），但需要更改每个规则的存储库密钥和密钥名称。 这是不可行的，因为我需要超过 550 条规则的描述

获取描述/规则描述文本需要什么？

请帮忙。

Answer 1

如果我的理解是正确的，那么 /api/rules/search 网络服务应该可以满足您的需求。有关 Java 规则的列表，请参阅 https://sonarcloud.io/api/rules/search?languages=java。

API 支持此处记录的许多参数：https://sonarcloud.io/web_api/api/rules/search（单击水平线上方的参数标题以打开说明）。

例如，rule_key 参数可以搜索特定规则。要查找有关 S2065 规则的信息（不可序列化类中的字段不应为“瞬态”），您可以使用：https://sonarcloud.io/api/rules/search?rule_key=squid:S2065

Answer 2

我在使用 SONAR 4.5.6 和 Sonar 7.3 时遇到过这个问题，但我会通过 API 获取所有信息。

为了获得规则，我需要 Quality Profile 密钥：

• 对于声纳 SONAR 4.5.6

  1 - 转到您的质量配置文件 (QP) 页面并从您的 URL 获取密钥：

  示例： http://sonar_host:port/sonar/profiles/show?key=java-sonar-way-45044

  2 - 获取密钥并调用 API。

  http://sonar_host:port/sonar/api/rules/search?qprofile=java-sonar-way-45044&ps=500&languages=java&activation=true

• 对于 SONAR 7.3，您需要内部质量配置文件密钥

  1 - 调用 API 按名称获取 QP，在我的情况下（声纳方式）：

  http://sonar_host:port/api/qualityprofiles/search?qualityProfile=Sonar%20way

  就我而言 (AWYRSVFJNN_Bjog4uKk1)

  2 - 获取您的 QP 密钥并获取规则

  http://sonar_host:port/api/rules/search?qprofile=AWYRSVFJNN_Bjog4uKk1&ps=500&languages=java&activation=true

额外参数：

1 - qprofile: QP 的键

2 - ps：每页要获取的规则数。

3 - 语言：个人资料的语言

4 - 激活：true，需要使用 qprofile 参数

所有此 API 调用都以 JSON 格式返回所有信息。

最后，为了将此 JSON 转换为 Excell，我使用了这样的在线转换器

http://www.convertcsv.com/json-to-csv.htm

复制并粘贴您的 JSON 并选择您的覆盖选项，注意输出选项（输出字段分隔符），选择“;”然后点击 JSON to excel 选项。