code-analysis - 从 sonarqube api 访问质量门状态

Question

我的问题:

我想通过 SonarQube web api 获取我在 SonarQube 中的项目的质量门的当前状态，但我没有将质量门视为文档中的可用指标。访问此信息以包含在报告中的最佳方式是什么？

背景:

我正在使用 SonarQube API 来访问有关项目分析的信息。 API 的输出用于生成每周报告。我可以使用以下 SonarQube API 调用访问有关每个项目的信息。

http://my-sonar-site/api/resources/index/?resource=$PROJECT_KEY&metrics=$METRIC_LIST

指标列表是从 SonarQube API 文档中填充的

http://docs.sonarqube.org/display/SONAR/Metric+definitions

除了质量门的状态之外，这让我得到了我想要的一切。

我试过的:

我在上面的链接中查看了指标的文档，但未能在 api 的那部分找到质量门状态。

我还查看了在 http://nemo.sonarqube.org/api_documentation#api/qualitygates 中记录的质量门 API。 - 但质量门 API 似乎用于创建和管理质量门和项目关联，而不是在每个项目的基础上获取门的当前状态。

Answer 1

您可以使用“quality_gate_details”指标检索您想要的内容。以 Nemo 为例:http://nemo.sonarqube.org/api/resources/index/?resource=org.codehaus.sonar:sonar&metrics=quality_gate_details

[{"id":48569,"key":"org.codehaus.sonar:sonar","name":"SonarQube","scope":"PRJ","qualifier":"TRK","date":"2014-11-30T16:13:17+0000","creationDate":null,"lname":"SonarQube","version":"5.0-SNAPSHOT","description":"Open source platform for continuous inspection of code quality","msr":[{"key":"quality_gate_details","data":"{\"level\":\"ERROR\",\"conditions\":[{\"metric\":\"blocker_violations\",\"op\":\"GT\",\"error\":\"0\",\"actual\":\"3.0\",\"level\":\"ERROR\"},{\"metric\":\"critical_violations\",\"op\":\"GT\",\"error\":\"0\",\"actual\":\"15.0\",\"level\":\"ERROR\"},{\"metric\":\"test_failures\",\"op\":\"GT\",\"warning\":\"0\",\"error\":\"\",\"actual\":\"0.0\",\"level\":\"OK\"},{\"metric\":\"skipped_tests\",\"op\":\"GT\",\"warning\":\"0\",\"actual\":\"0.0\",\"level\":\"OK\"},{\"metric\":\"coverage\",\"op\":\"LT\",\"warning\":\"\",\"error\":\"80\",\"actual\":\"81.5\",\"level\":\"OK\"},{\"metric\":\"test_errors\",\"op\":\"GT\",\"warning\":\"0\",\"error\":\"\",\"actual\":\"0.0\",\"level\":\"OK\"},{\"metric\":\"sqale_effort_to_grade_a\",\"op\":\"GT\",\"warning\":\"\",\"error\":\"0\",\"actual\":\"0.0\",\"level\":\"OK\"}]}"}]}]

现在，要获得完整的指标列表，您可以浏览“指标”数据库表。
欢迎观看 https://jira.codehaus.org/browse/SONAR-5378这应该可以直接在 SonarQube Web 界面上提供详细的指标列表。