对iPipeline的对plll库做出了对应的优化并实践之。

问题描述

项目CI系统引入了Jenkins2.0 iPipeline 框架（plll库）之后应该说提升了很多幸福感，其中一个很重要的方面来源于框架已经为用户提供了报告和邮件的基本格式，显示直观且高效。

一个典型的报告和邮件的基本格式举例如下图所示：

从图中可以看出，各个步骤的总览信息格式化被显示，执行报告和链接，制品库报告和链接以及运行时间一览无余。

但正是由于plll库已经将报告和邮件的样式格式化了，因此用户在基本报告样式的基础上无法扩展报告和邮件展示的内容。这在本项目 若干用例测试的结果报表 需要附加到报告和邮件的情况下显得不是很方便

因此我们决定将报告和邮件展示变为可扩展模式，可以由用户在基本报告格式以外自由添加其他数据并显示，我们称该功能为 快捷报告追加（QuickReport）

带着这个问题，我们对plll库做出了对应的优化并实践之。

优化实践

优化plll库源代码，加入QuickReport功能：

def quickReportContent =""

try{    

ForeachFunctions{ context ->

if(context.args.param.quick_report){

for(int i=0; i

{

def report = context.args.param.quick_report[i]

if(report.report_dir && report.report_file && report.report_name

&&(report.report_always || context.message=='')){

def quickReportFile = report.report_dir +"/"+ report.report_file

quickReportContent = readFile quickReportFile

quickReportContent ="

---

"+ quickReportContent  // 加一条浅绿色的分界线

echo "quickReport内容是："+ quickReportContent

}

}

}

}

}

catch(Exception ex){

echo ex.getMessage()

getData().result='failure'

getData().message+="[ERROR] PublishReportAll ${ex.getMessage()} \n"

}

html = html + quickReportContent

使用举例：

对于用户来说，只需要在plll接口的param参数列表中配上quick_report参数，用来指明需要扩展的报告内容和文件名等参数，则报告或邮件中将添加用户的扩展内容并显示，示例代码如下：

plll.Test("check_xxx_case","case检查",[

run_dir:"${verifyScriptPath}/${runSubPath}",

run_execute:{ run "${cmd}"},

verify_dir:"${->env.OUTPUT_PATH}/",

verify_after: tmp_move_shell_name,

verify_execute: tmp_verify_shell_log_name,

param:[

report_file:[[report_dir:"${->env.OUTPUT_PATH}/", report_file:"${publishLogName}",report_name:"case检查_report", report_always:true]],

quick_report:[[report_dir:"${->env.OUTPUT_PATH}/", report_file:"${quickReportName}",report_name:"case检查_quick_report", report_always:true]]

]

]);

由代码可见，我们在quick_report的参数列表中配置了用户快捷报告所载目录，报告文件名以及报告名，框架即可自动将用户自定义报告附加到原基本表格下面，并以绿色分割线分割。

效果展示：

例如对本项目而言，测试任务中每次都有一个叫做 报文CASE测试报告 需要直观地呈现给用户查看，而不需要让用户点击链接自行查看，因此我们可以将其作为QuickReport扩展到邮件和Jenkins汇总报告中:

Jenkins汇总展示报告如下，用户自定义表格已经扩展在下方，如下图所示：

同理邮件中也被扩展显示了，如下图所示：