SonarQube 7.4 集成報告插件

前言

Sonar PDF Report Plugin

介紹

安裝

快速使用

配置

下載報告

前言

Sonar PDF Report Plugin

介紹

安裝

快速使用

配置

下載報告

sonar-cnes-report

介紹

快速開始

安裝

單機(jī)模型

插件模式（自 2.2.0 起）

幫助命令

示例

兼容矩陣

小結(jié)

前言

本文總結(jié)目前兩種常用的生成 SonarQube 結(jié)果報告的方法，以備查閱。

Sonar PDF Report Plugin

適用SonarQube版本 : 5.5–7.5。

2.0.X：適用SONARQUBE5.5–5.6.7版本

2.1.x：適用SONARQUBE6.0-6.2版本

3.0.x：適用SONARQUBE6.3+

官網(wǎng)地址：https://gitee.com/zzulj/sonar-pdf-plugin

介紹

本插件生成 PDF 格式的 sonarqube 報告.

報告包括以下內(nèi)容:

概要

靜態(tài)分析

動態(tài)分析

編碼問題

熱點(diǎn):

違反最多的規(guī)則TOP10

違規(guī)最多的文件TOP5

復(fù)雜度最高的文件TOP5

重復(fù)行最多的文件TOP5

違規(guī)詳情

子模塊信息（只有在存在時生成）

安裝

下載對應(yīng)的版本，將插件復(fù)制到 SONARQUBE_HOME/extensions/plugins 目錄

重啟 SonarQube

快速使用

SonarQube PDF 是一個 post-job任務(wù). 因此，PDF 報告將在SonarQube 分析結(jié)束后生成.

配置 Skip 為“否”時生成 PDF 報告功能啟用。

配置 Username 和 Password。如果出現(xiàn) HTTP error: 401 或者 HTTP error: 403, msg: Forbidden，請查看該配置。

5.x版本：PDF 在儀表盤中下載，如果沒有下載界面，需要在“配置控件”中添加該控件

6.x 以及 7.x 版本：因為 UI 變化無儀表盤頁面，在工程中 More 菜單下查看：

生成的報告內(nèi)容如下：

sonar-cnes-report

介紹

插件可以將代碼分析從 SonarQube 服務(wù)器導(dǎo)出為 docx、xlsx、csv、markdown 和文本文件。

該工具可以作為 JAR 可執(zhí)行文件（使用命令行）或作為 Sonarqube 插件獨(dú)立使用。

特性：

將代碼分析導(dǎo)出為一組文件

導(dǎo)出代碼分析配置

使用自定義模板

獲取自定義的OpenXML (docx, xlsx)報告

獲得一個包含所有問題的動態(tài)透視表

導(dǎo)出成法語或英語

官網(wǎng)地址：https://github.com/cnescatlab/sonar-cnes-report

快速開始

設(shè)置一個SonarQube實例。

使用sonar-scanner, maven, gradle, msbuild 等運(yùn)行分析。

執(zhí)行cnesreport:

在單機(jī)中，使用命令行

在插件模式下，拷貝 jar 到 /opt/sonarqube/extensions/plugins，重啟 sonarqube，然后點(diǎn)擊 “More”>“CNES Report”。

安裝

Cnesreport 不需要任何安裝。它是一個可移植的 Java 應(yīng)用程序，可以根據(jù)下面的示例復(fù)制并運(yùn)行它。唯一的要求是一個最新的JRE(>=1.8)。

將 sonar-cnes-report.jar 復(fù)制到 sonarqube 的插件文件夾中（在 linux 上路徑應(yīng)該是這樣的 /opt/sonarqube/extensions/plugins ）

重新啟動 sonarqube（在Linux上：sudo service sonar restart）

幫助命令

使用 java -jar cnesreport.jar -h 以獲取有關(guān) cnesreport 以下幫助：

usage: java -jar cnesreport.jar [-a ] [-b ] [-c] [-d ] [-e] [-h] [-l ] [-o ] [-p ] [-r ] [-s ] [-t ] [-v] [-w] [-x ] Generate editable reports for SonarQube projects. -a,--author Name of the report writer. -b,--branch Branch of the targeted project. Requires Developer Edition or sonarqube-community-branch-plugin. Default: usage of main branch. -c,--disable-conf Disable export of quality configuration used during analysis. -d,--date Date for the report. Format: yyyy-MM-dd. Default: current date. -e,--disable-spreadsheet Disable spreadsheet generation. -f,--disable-csv Disable csv generation. -h,--help Display this message. -l,--language Language of the report. Values: en_US, fr_FR. Default: en_US. -m,--disable-markdown Disable markdown generation. -n,--template-markdown Path to the report template in markdown. Default: usage of internal template. -o,--output Output path for exported resources. -p,--project SonarQube key of the targeted project. -r,--template-report Path to the report template. Default: usage of internal template. -s,--server Complete URL of the targeted SonarQube server. -t,--token SonarQube token of the SonarQube user who has permissions on the project. -v,--version Display current version. -w,--disable-report Disable report generation. -x,--template-spreadsheet Path to the spreadsheet template. Default: usage of internal template. Please report issues at https://github.com/cnescatlab/sonar-cnes-report/issues

示例

如果正在使用 SonarQube 的安全實例，可以通過 -t 選項提供一個 SonarQube 身份驗證令牌，并使用 -s 指定 SonarQube 實例的url。文本報告的內(nèi)部模板將被 -r 選項所取代。

java -Xmx1024m -Xms1024m -jar sonar-cnes-report.jar -t 6bc36088524a4d06e3e07e73ba419127cd90ff04 -s http://172.16.106.188:9088/ -p projectId -r template.docx

生成的文件如下：

打開其中 word 的報告：

兼容矩陣

有關(guān)遺留版本，請在這里查看 wiki 頁面 : Note on legacy versions

小結(jié)

通過簡單的實驗，我發(fā)現(xiàn) sonar-cnes-report 報告的數(shù)據(jù)較 Sonar PDF Report Plugin 更為正確，推薦使用前者。

代碼檢查 CodeCheck 網(wǎng)絡(luò)

版權(quán)聲明：本文內(nèi)容由網(wǎng)絡(luò)用戶投稿，版權(quán)歸原作者所有，本站不擁有其著作權(quán)，亦不承擔(dān)相應(yīng)法律責(zé)任。如果您發(fā)現(xiàn)本站中有涉嫌抄襲或描述失實的內(nèi)容，請聯(lián)系我們jiasou666@gmail.com 處理，核實后本網(wǎng)站將在24小時內(nèi)刪除侵權(quán)內(nèi)容。