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流程的效率和质量。