通用报告收集

在您使用持续集成进行构建时,可能会使用不同工具或插件生成 HTML 格式的报告,比如单元测试报告、代码覆盖率报告,以及 API 文档等。在添加 CODING 通用报告收集插件并进行简单配置后,即可在【构建记录】->【通用报告】中直接浏览或快速下载收集到的各类 HTML 格式报告。

快速开始

进入构建计划的设置页面,您可以通过图形化界面或文本编辑器两种方式添加步骤,收集在构建计划过程所产生的各类 HTML 格式报告。下面将会以搜集测试覆盖率 HTML 报告为例,逐个说明相应的配置方法,演示如何使用 CODING 通用报告插件收集用户自定义报告。

使用图形化界面收集通用报告

CODING 持续集成的「图形化编辑器」在基于编辑 Jenkinsfile(过程描述文件)的核心功能之上,设计了可视化视图,同时也兼容绝大部分自定义操作,实现了边写边看、所见即所得的直观编辑体验。

1. 添加步骤

新建或选择构建计划,进入流程配置界面。在「单元测试」步骤后添加「收集测试覆盖率报告」阶段,并增加执行 shell 脚本命令步骤。

2. 生成测试覆盖率报告

调用项目中配置的脚本生成测试覆盖率报告。示例中的测试覆盖率报告脚本默认会在项目目录下创建名为 coverage 的文件夹保存测试报告文件,入口文件为 index.html;您也可以根据自身使用的测试覆盖率报告生成工具进行命令调整。

3. 添加步骤

在生成覆盖率报告脚本的下一步添加【收集通用报告】步骤。

4. 填写配置

填写收集通用报告配置,详情请见参数说明部分。

5. 构建完成后查看报告

点击【保存】,完成插件配置。构建计划运行完成后前往【构建记录】->【通用报告】页面查看并下载测试覆盖率报告。

使用文本编辑器收集通用报告

文本编辑器本质上是在编写 Jenkinsfile, 它定义了持续集成中的工作流水线(pipeline),其不仅实现了对步骤的流式化封装和管理,也是持续集成中的基本功能单位。流水线可以顺序执行,也可以并行执行。

1. 进入文本编辑器

新建或选择构建计划,进入设置界面。轻点流程配置界面,选择【文本编辑器】。

2. 增加步骤

在「单元测试」步骤后增加「收集代码测试覆盖率报告」步骤。

pipeline {
    agent any

    // ... 

    stage('收集代码测试覆盖率报告') {
      steps {
        // 生成覆盖率报告,默认保存在项目目录下 coverage 文件夹下。您也可以根据自身使用的测试覆盖率报告生成工具进行命令调整
        sh 'npm run coverage'
        // 使用 CODING 通用报告收集插件收集测试覆盖率报告,配置详情请见 “参数说明” 部分
        codingHtmlReport(
            name: 'my-report', 
            tag: 'test', 
            path: 'coverage', 
            des: 'This is the coverage report', 
            entryFile: 'index.html'
        )
      }
    }

    // ...
}

3. 构建完成后查看报告

点击【保存】,完成插件配置。构建计划运行完成后前往【构建记录】->【通用报告】页面查看并下载测试覆盖率报告。

点击查看就可以直接在新的 Tab 看到测试覆盖率报告。

更多参数演示

pipeline {
    agent any
    stages  {
        stage("html-report") {
            steps {
                // 在 my-dir 文件夹中生成一个 index.html 文件
                sh 'mkdir my-dir'                
                sh 'echo hello coding > my-dir/index.html'

                // 上传到通用报告中
                codingHtmlReport(
                    name: 'my-test-report',
                    path: 'my-dir',
                    entryFile: 'index.html',
                    tag: 'test',
                    des: 'something'
                )
            }
        }
    }
}

参数说明

参数名称 图形化界面对应选项名 必填 文本参数类型 图形化参数类型 默认值 说明
name 报告名称 string string - 通用报告的名称,应在构建记录下为唯一值,不得超过 50 个字符
path 路径 string string - 通用报告所在的路径,可以为文件夹或者文件
entryFile 入口文件 string string index.html 若 path 为文件夹时,可以为 path 设置一个入口文件的位置,默认为 index.htmlentryFile 配置的路径将相对于 path。若 path 为文件时,此参数无效
tag 标签 string string - 通用报告的标签, 支持通过自定义标签来给报告分类,不得超过 30 个字符
des 描述 string string(textarea) - 通用报告描述,不得超过 300 个字符
上一篇人工确认
文档是否对您有用?
感谢反馈有用
感谢反馈没用