Jenkins如何使用publish?html?report插件展示HTML報告

Jenkins如何使用publish html report插件展示HTML報告

在現代軟件開發中，持續集成和持續交付（CI/CD）已經成為不可或缺的一部分。Jenkins作為最流行的開源自動化服務器之一，廣泛應用于構建、測試和部署軟件項目。在CI/CD流程中，生成和展示測試報告是非常重要的一環，它可以幫助開發團隊快速了解測試結果，定位問題。本文將詳細介紹如何在Jenkins中使用publish html report插件來展示HTML格式的測試報告。

1. 什么是publish html report插件

publish html report插件是Jenkins的一個插件，它允許用戶在構建后發布HTML格式的報告，并在Jenkins的構建頁面中展示這些報告。這個插件非常適合用于展示測試報告、代碼覆蓋率報告、靜態分析報告等。

1.1 插件的主要功能

• 發布HTML報告：將生成的HTML報告發布到Jenkins的構建頁面中。
• 自定義報告路徑：可以指定HTML報告所在的目錄和文件。
• 報告歸檔：將報告歸檔到Jenkins的工作空間中，方便后續查看。
• 報告鏈接：在構建頁面中生成一個鏈接，點擊即可查看報告。

1.2 插件的適用場景

• 測試報告：展示單元測試、集成測試、端到端測試的HTML報告。
• 代碼覆蓋率報告：展示代碼覆蓋率分析的HTML報告。
• 靜態分析報告：展示代碼質量分析的HTML報告。
• 自定義報告：展示任何自定義生成的HTML報告。

2. 安裝publish html report插件

在使用publish html report插件之前，首先需要在Jenkins中安裝該插件。

2.1 安裝步驟

1. 登錄Jenkins：打開Jenkins的Web界面，并使用管理員賬號登錄。
2. 進入插件管理頁面：點擊左側菜單中的Manage Jenkins，然后選擇Manage Plugins。
3. 搜索插件：在插件管理頁面中，點擊Available選項卡，然后在搜索框中輸入publish html report。
4. 安裝插件：找到publish html report插件后，勾選它，然后點擊頁面底部的Install without restart按鈕。
5. 等待安裝完成：插件安裝完成后，Jenkins會自動刷新頁面。

2.2 驗證安裝

安裝完成后，可以通過以下步驟驗證插件是否安裝成功：

1. 新建一個自由風格項目：在Jenkins首頁點擊New Item，然后選擇Freestyle project，輸入項目名稱并點擊OK。
2. 查看構建后操作：在項目配置頁面中，向下滾動到Post-build Actions部分，查看是否有Publish HTML reports選項。
3. 確認插件可用：如果能看到Publish HTML reports選項，說明插件安裝成功。

3. 配置publish html report插件

安裝完插件后，接下來需要配置插件以發布HTML報告。以下是一個典型的配置步驟。

3.1 生成HTML報告

在配置插件之前，首先需要確保在構建過程中生成了HTML格式的報告。假設我們使用JUnit進行單元測試，并使用maven-surefire-plugin生成HTML格式的測試報告。

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-surefire-plugin</artifactId>
    <version>3.0.0-M5</version>
    <configuration>
        <reportsDirectory>${project.build.directory}/surefire-reports</reportsDirectory>
    </configuration>
</plugin>

在構建完成后，HTML格式的測試報告會生成在target/surefire-reports目錄下。

3.2 配置Jenkins項目

1. 打開項目配置：在Jenkins中打開需要配置的項目，點擊Configure。
2. 添加構建后操作：向下滾動到Post-build Actions部分，點擊Add post-build action，然后選擇Publish HTML reports。
3. 配置報告路徑：
   • HTML directory to archive：輸入HTML報告所在的目錄，例如target/surefire-reports。
   • Index page[s]：輸入HTML報告的入口文件，例如index.html。
   • Report title：輸入報告的名稱，例如Unit Test Report。
4. 保存配置：點擊Save保存配置。

3.3 運行構建

配置完成后，運行一次構建。構建完成后，可以在構建頁面中看到HTML Report鏈接，點擊即可查看HTML格式的測試報告。

4. 高級配置

publish html report插件還支持一些高級配置選項，以滿足更復雜的需求。

4.1 多報告配置

如果項目中生成了多個HTML報告，可以在Publish HTML reports配置中添加多個報告路徑。例如：

• HTML directory to archive：target/surefire-reports

• Index page[s]：index.html

• Report title：Unit Test Report

• HTML directory to archive：target/jacoco-report

• Index page[s]：index.html

• Report title：Code Coverage Report

4.2 自定義報告鏈接

默認情況下，插件會在構建頁面中生成一個HTML Report鏈接?？梢酝ㄟ^配置Report title來修改鏈接的名稱。例如，將Report title設置為Unit Test Report，則鏈接名稱會變為Unit Test Report。

4.3 報告歸檔

插件會將HTML報告歸檔到Jenkins的工作空間中?？梢酝ㄟ^HTML directory to archive配置指定需要歸檔的目錄。歸檔后的報告可以在Workspace中查看。

5. 常見問題及解決方案

5.1 報告未顯示

如果構建完成后，報告未顯示在構建頁面中，可以檢查以下內容：

• 報告路徑是否正確：確保HTML directory to archive和Index page[s]配置正確。
• 報告是否生成：確保在構建過程中生成了HTML格式的報告。
• 插件是否安裝成功：確保publish html report插件已成功安裝。

5.2 報告鏈接無法打開

如果點擊報告鏈接后無法打開報告，可以檢查以下內容：

• 報告文件是否存在：確保報告文件存在于指定的路徑中。
• 文件權限：確保Jenkins有權限訪問報告文件。

5.3 報告內容不完整

如果報告內容不完整，可能是由于以下原因：

• 報告生成不完整：確保在構建過程中報告生成完整。
• 文件編碼問題：確保報告文件的編碼與Jenkins的編碼一致。

6. 總結

通過publish html report插件，Jenkins可以方便地展示HTML格式的測試報告、代碼覆蓋率報告等。本文詳細介紹了如何安裝、配置和使用該插件，并提供了常見問題的解決方案。希望本文能幫助你在Jenkins中更好地展示和管理HTML報告，提升CI/CD流程的效率和質量。