Postman+Newman+Git+Jenkins实现接口自动化测试持续集成

简介: 做接口测试的话,首先要考虑的是如何选择一个合适的工具?在忽略工具是否好用,是否能满足业务要求的前提下,需要考虑以下2点:1、要考虑工具的学习成本2、要考虑团队的协作

接口测试脚本一般的执行流程

  做接口测试的话,首先要考虑的是如何选择一个合适的工具?在忽略工具是否好用,是否能满足业务要求的前提下,需要考虑以下2点:

1、要考虑工具的学习成本

2、要考虑团队的协作

 接口测试脚本的执行流程:

团队成员协作编写接口用例->用例归档到git/svn->脚本集成jenkins,在环境更新后自动触发执行或定时执行。




Postman工具常见的接口测试流程是怎样的?



使用Postman+Newman+Git+Jenkins+钉钉/邮件提醒                                                                                                          

Windows系统Newman安装


1、下载Node.js进行安装,然后配置node的环境变量                                              

2、借助npm工具,安装Newmannpm install -g newman

3、运行Newman

通过Newman来运行某个postman脚本:

newman run  mycollection.json

用newman执行postman脚本的效果如下:微信图片_20220113180831.jpg


Centos系统Newman安装


1、先下载安装nodejs (必须安装10.0以上的版本http://nodejs.cn/download/下载linux系统压缩包 ,,解压,配置环境变量    

tar xvJf ***.tar.xz
echo "export PATH=\"\$PATH:/root/tools/node-v14.8.0-linux-x64/bin\"" \ >> ~/.bash_profile &&
source ~/.bash_profile

2、安装Newmannpm install -g newman以上通过命令安装如果问题的话 ,可以百度解决。


命令行执行Postman脚本生成测试报告


1、命令行执行脚本的最基本的命令newman run xxx.json


微信图片_20220113180839.png


2、生成html格式的报告先安装插件:npm install -g newman-reporter-htmlnewman run demo.postman_collection.json -r html



微信图片_20220113180841.png


3、优化报告显示格式,生成美观一点的html格式报告
先安装插件:npm install -g newman-reporter-htmlextranewman run demo.postman_collection.json -r htmlextra


微信图片_20220113180843.png


注意事项:

1、-r参数是--reporters的缩写,可以在参数后面指定需要生成的报告格式 ,比如 -r html,junit,json,htmlextra  ,这个会在当前目录下生成一个newman的文件夹,报告都在newman的文件夹下面:


微信图片_20220113180846.png


2、也可以加上下面的参数指定报告名称:(报告默认生成在当前执行命令的路径下 ,也可以自己在报告名称前加上指定路径生成)

--reporter-html-export htmlReport.html

--reporter-htmlextra-export htmlExtraReport.html

--reporter-junit-export junitReport.html

--reporter-json-export jsonReport.html

3、在使用npm命令安装newman以及其他的包时,建议都加上-g 参数 ,给所有用户都安装对应的包,避免在使用命令时报错。

使用npm安装如果比较慢,可以先执行下面的命令,切换下载源的地址:

npm config set registry https://registry.npm.taobao.org

4、通过newman-reporter-htmlextra插件生成的html报告,默认是不包含css样式文件的,如果是发给别人访问 ,在断网的情况下查看报告,样式是加载不了的。目前查了一下,好像没有类似allure里面的那种参数,可以把报告所需的样式和报告一起导出,不过这个插件支持自定义报告模板,可以自己手动将css样式文件导出到某个位置,然后修改报告模板汇总引用的文件去解决这个问题。





Postman脚本持续集成

通过上面的描述 ,现在已经可以将postman脚本生成报告了,离集成jenkins只差最后的配置工作了:

1、在gitee上新建一个仓库,将postman调试好的脚本导出成json文件,上传到gitee上 (上传到gitee仓库的话,可以方便团队不同成员之间可以更改和查看用例),后续有脚本变更的时候也可以直接更新到git上进行存储,git上也可以按版本按分支存放你的测试脚本

2、搭建好jenkins环境,并配置好npm的环境以及安装好newman执行环境

3、新建一个自由风格的job,配置从git上获取脚本:


微信图片_20220113180848.png


勾选构建环境下的清除工作空间目录的配置,将之前的报告清除(如果执行命令生成报告时自己指定了报告名称的话 ,也可以不清除工作空间的文件)


微信图片_20220113180851.png



添加执行batch命令 / shell命令,命令内容如下:


微信图片_20220113180853.png

# batch命令
cd /d  %WORKSPACE%
newman run demo.postman_collection.json -r htmlextra --reporter-htmlextra-export ./report/htmlExtraReport.html 
或者
# shell 命令
cd $WORKSPACE
newman run demo.postman_collection.json -r htmlextra --reporter-htmlextra-export ./report/htmlExtraReport.html newman run demo.postman_collection.json -r htmlextra --reporter-htmlextra-export ./report/htmlExtraReport.html

然后再构建后操作那里 ,添加报告的展示:

需安装HTML Publisher plugin插件


微信图片_20220113180856.png


构建后 ,即可在jenkins上看到HTML报告:

微信图片_20220113180858.png


发送钉钉通知


由于现在很多企业办公通讯都是用钉钉 ,那么接口自动化的脚本执行完之后,是可以讲结果发送到指定的钉钉群里面的准备工作:钉钉帐号,在钉钉上创建指定机器人 ,jenkins上安装DingTalk插件。
钉钉PC端机器人创建操作:
钉钉左上角用户头像处->机器人管理->创建自定义机器人


微信图片_20220113180901.png


设置机器人名称、指定消息通知的群、安全设置下可以设置自定义关键字,然后点击完成,然后页面会生成一个webhook的地址


微信图片_20220113180903.png



微信图片_20220113180905.png


安装Jenkins上的DingTalk插件,进入系统配置页面,找到钉钉的配置:


微信图片_20220113180907.png


然后进入postman脚本执行的job配置页面,勾选需要通知的机器人名称即可。


微信图片_20220113180910.png


构建开始和结束后就会收到钉钉通知:


微信图片_20220113180913.png


解决jenkins上无法展示HTML样式的问题



由于安全考虑,jenkins默认是禁止了外部的css和js的加载的,因此html报告显示会出现异常,常见的解决方案有以下几种:
1、在jenkins系统管理->脚本命令行 输入以下脚本运行:(此方案重启jenkins失效

System.setProperty("hudson.model.DirectoryBrowserSupport.CSP", "")

2、利用jenkins的插件,在启动节点的时候自动触发某个job去执行groovy脚本。搜索安装Startup Trigger和Groovy插件即可。

配置一个job,然后在job中执行groovy脚本:

System.setProperty("hudson.model.DirectoryBrowserSupport.CSP", "")

3、以windows服务或者java -jar的方式启动的jenkins,可以修改jenkin.xml文件中的启动命令,加入参数

-Dhudson.model.DirectoryBrowserSupport.CSP=

4、用tomcat部署的jenkins,可以直接改catalina.bat文件,找到tomcat/bin下的catalina.bat文件,用Notepad++打开,加上一行代码

set JAVA_OPTS="-Dhudson.model.DirectoryBrowserSupport.CSP"




扩展学习1、newman的其他用法(比如执行命令的时候加载环境变配置、设置执行次数等):https://www.npmjs.com/package/newman

                                                                                                                              2、newman-reporter-htmlextra插件的其他用法(比如报告过滤数据,设置标题等):https://www.npmjs.com/package/newman-reporter-htmlextra


3、钉钉通知在jenkins上的配置,还可以指定具体通知的人等高级用法,可以自己查资料扩展一下.觉得钉钉插件提醒不好用的话,也可以自己写脚本调用钉钉的接口发送消息提醒。


相关文章
|
1月前
|
测试技术 开发工具 git
利用Git Hooks自动化你的开发流程
Git Hooks 是 Git 的强大功能,允许在特定事件(如提交、推送、合并请求)发生时自动执行脚本。通过合理设置和使用 Git Hooks,可以自动化测试、代码风格检查等任务,提高代码质量和开发效率。本文介绍了如何设置和使用常用的 Git Hooks,包括 `pre-commit`、`pre-push` 和 `post-merge`,并提供了最佳实践建议。
|
9天前
|
监控 JavaScript 测试技术
postman接口测试工具详解
Postman是一个功能强大且易于使用的API测试工具。通过详细的介绍和实际示例,本文展示了Postman在API测试中的各种应用。无论是简单的请求发送,还是复杂的自动化测试和持续集成,Postman都提供了丰富的功能来满足用户的需求。希望本文能帮助您更好地理解和使用Postman,提高API测试的效率和质量。
49 11
|
24天前
|
运维 jenkins Java
Jenkins 自动化局域网管控软件构建与部署流程
在企业局域网管理中,Jenkins 作为自动化工具,通过配置源码管理、构建及部署步骤,实现了高效、稳定的软件开发与部署流程,显著提升局域网管控软件的开发与运维效率。
39 5
|
2月前
|
运维 监控 jenkins
运维自动化实战:利用Jenkins构建高效CI/CD流程
【10月更文挑战第18天】运维自动化实战:利用Jenkins构建高效CI/CD流程
|
2月前
|
测试技术 开发工具 git
利用Git Hooks自动化你的开发流程
【10月更文挑战第6天】在现代软件开发中,版本控制至关重要,Git作为主流工具,提供了强大的代码管理功能。Git Hooks 是 Git 的一个特性,可在特定事件(如提交、推送)发生时自动执行脚本,实现开发流程自动化。本文介绍 Git Hooks 的基本概念、常见用例及设置方法,涵盖 pre-commit、pre-push 等多种类型的 Hooks,并展示了如何利用它们进行代码格式化、自动化测试和风格检查,提升开发效率与代码质量。通过合理应用 Git Hooks,可以显著减少人为错误,确保代码一致性,并促进团队协作。
|
3月前
|
JSON Java 数据格式
使用postMan调试接口出现 Content type ‘multipart/form-data;charset=UTF-8‘ not supported“
本文介绍了使用Postman调试接口时遇到的“Content type ‘multipart/form-data;charset=UTF-8’ not supported”错误,原因是Spring Boot接口默认只接受通过`@RequestBody`注解的请求体,而不支持`multipart/form-data`格式的表单提交。解决方案是在Postman中将请求体格式改为`raw`并选择`JSON`格式提交数据。
使用postMan调试接口出现 Content type ‘multipart/form-data;charset=UTF-8‘ not supported“
|
2月前
|
运维 监控 jenkins
运维自动化实践:利用Jenkins实现高效CI/CD流程
【10月更文挑战第18天】运维自动化实践:利用Jenkins实现高效CI/CD流程
|
2月前
|
JavaScript 前端开发 API
vue尚品汇商城项目-day02【9.Home组件拆分+10.postman测试接口】
vue尚品汇商城项目-day02【9.Home组件拆分+10.postman测试接口】
49 0
|
4月前
|
持续交付 jenkins Devops
WPF与DevOps的完美邂逅:从Jenkins配置到自动化部署,全流程解析持续集成与持续交付的最佳实践
【8月更文挑战第31天】WPF与DevOps的结合开启了软件生命周期管理的新篇章。通过Jenkins等CI/CD工具,实现从代码提交到自动构建、测试及部署的全流程自动化。本文详细介绍了如何配置Jenkins来管理WPF项目的构建任务,确保每次代码提交都能触发自动化流程,提升开发效率和代码质量。这一方法不仅简化了开发流程,还加强了团队协作,是WPF开发者拥抱DevOps文化的理想指南。
101 1
|
4月前
|
Kubernetes jenkins 持续交付
Jenkins 插件生态:提升自动化能力
【8月更文第31天】Jenkins 是一个开源的持续集成/持续交付(CI/CD)平台,广泛应用于软件开发的各个阶段。Jenkins 的一大特色就是其丰富的插件生态系统,这些插件极大地扩展了 Jenkins 的功能,使其能够适应各种各样的应用场景。本文将深入探讨 Jenkins 的插件生态系统,并指导如何选择和配置插件以满足特定需求。
230 1