Web API 持续集成:PostMan+Newman+Jenkins

简介:

上篇文章我们已经完成了API测试工具选型,接下来是一系列周期性的开发测试过程:接口开发、检出代码、运行测试、记录结果、发送报告。为了快速发现问题,并减少重复过程以节省时间、费用和工作量,我们需要一套完整的持续集成解决方案,除接口开发之外其他环节全部自动完成,无需太多的人工干预。

这篇文章将对持续集成解决方案进行一步一步的讲解,希望对大家能有帮助。

1. Web Api 测试工具选型

目前市场有很多的用于API 测试的工具,如Postman, SoapUI, YApi, HttpRunner等等。

在进行了很多的尝试后,我们最终还是决定在Postman和Soap UI间做出抉择,在经过我们详细的对比后:https://www.cnblogs.com/powertoolsteam/p/9772211.html

最终我们选择了Postman。

2. 用Postman创建项目

选型做好了,第二步当然是Postman用起来了,创建自己的项目。参照Postman官网的文档。https://learning.getpostman.com/docs/postman/collections/intro_to_collections/

 ●  创建 LeyserkidsApi项目

da9b6dd634e288ff9cc85d9cdb05dfc066fd083c

3. 源码管理

因为我们项目使用TFS做源码管理,这里就以TFS为例。

 ●  把Postman中项目LeyserkidsApi的Collection和Envrionment导出为json文件。
 ●  TFS创建项目LeyserKids,追加Postman导出的JSON文件,进行资源版本管理。接下来展示的项目结构如下:

bf2287cbc412643c915e6fada388ec0df0807bb6

4. Jenkins服务搭建

我们称搭建Jenkins Server的机器为:机器A,后续步骤需要对这台机器安装一些Services。

5. Jenkins与TFS关联

创建FreeStyle Project :Test

97738120c5fadee84c46ca9d9df0783380a48c56

Jenkins主页->Manage Jenkins->Manage Plugins->找到Team Foundation Server插件并安装。

b56a2d48fc520c3cfed0d54497724f35aa30dfc2

进入Project Test详细页面->Configure->Source Code Management

29606067ccb8513602479b420e98035b3587eef6

Build Triggers 设置当源码发生变化时,重新构建。可以每天定时构建。

3d7ef263c1561c9e6b5f250fa680ee4bdc667751

6. Jenkins构建(Build)

Newman是用命令行来执行Postman的Collection。可以很容易的和Jenkins集成。Newman是基于Nodejs的,所以首先得安装Nodejs。

 ●  在机器A(Jenkins Server)上安装nodejs和newman。参照:https://learning.getpostman.com/docs/postman/collection_runs/command_line_integration_with_newman
 ●  进入Test详细页面->Configure ->Build->Add Build Step->Execute Windows batch command->command

032a64f65b21db70a2dfe6e53f69e2727d91a051

7. 邮件配置

Jenkins构建之后,发送邮件,通知构建结果。邮件配置步骤如下:

Jenkins主页->ManageJenkins->Manage Plugins->找到Email Extension Plugin插件并安装->插件安装之后需要重启jenkins 服务

8da81955ce347a2cfca90516c28920da0d6a42ed

Jenkins主页->Manage Jenkins->Configure System-> Extended E-mail Notification, 配置邮件Server

c7974922c7243614275c6b914e23327ecee06a6f

进入Test详细页面->Configure-> Post-build Actions->Add post-build action(Editable-Email Notification)

 ●  进入Test详细页面

e7d1acf6aea24662c5fe1a37e571bdefc3f5cddb

 ●  对Test进行配置

95fda7f45401dbe8fbfd3ec2b1a6a1e3feedba7b

 ●  Post-build Actions追加动作:Editable-Email Notification

a4ec73b6f99906ec8e06b666e65e292bf372f98b

 ●  配置Editable-Email Notification

0e9eecf5852e1c09641e20b7dc4b7175032940af

8. 项目构建

f60e77507c9c46c8437ce0fb6512c124cb9dc683

经过以上步骤的配置,构建完成之后,会收到邮件,根据链接在console output查看构建结果,不是很直观。下一步中将进行改善。

74afbe6de1a71d47c3c2eafafc1781014ee7be9d

9. 更优美的邮件模板

默认的邮件内容过于简单,用Email Extension Plugin 提供的Groovy标准HTML模板:groovy-html.template

进入Test详细页面->Configure-> Editable-Email Notification-> Default Content配置模板

e86889fe6d8787031cf0bd709316020ac672e409

重新Build,查看邮件,邮件内容变的易读行,发送错误红色显示很是醒目。成功则显示为绿色,一目了然。

e6498e8e080bd4b5b8e5a25151eeff2b06a7a2cc

10. 更简洁精炼,美观的构建报告:Html Report

查看Console Output 中的构建结果,易读性差,而且也不美观,所以我们要改进。用newman生成HTML Report,再通过HTML Publisher插件展示到Jenkins。

Jenkins主页->ManageJenkins->Manage Plugins->找到HTML Publisher插件并安装。

74bb0be895c5a36f917bcdec369b54d8a8e4340c

在机器A(Jenkins Server)上通过Nodejs安装reporter-html-template$ npm install -g newman-reporter-html

newman-reporter-html使用参见:https://github.com/postmanlabs/newman-reporter-html#readme

环境准备好了,把准备好的模板:htmlreqres.hbs上传到TFS项目的templates下。我用了https://github.com/MarcosEllys/awesome-newman-html-template 这个小伙伴的模板,进行了些许改造。

e8406da67b9bd5fa97248a9a7d682f8bd22d78e2

进入Test详细页面->Configure-> Execute Windows batch command->command

把导出的index.html放在了当前Job对于的newman文件夹(文件夹会自动创建)下。此路径将在下一步配置中使用。

7da3f76b425836bfb897ed3f98fcf48bbe83e88d

进入Test详细页面->Configure-> Post-build Actions->Add post-build action(Publish Html report)配置Html Report ,展示上一个步骤生成的Index.html文件。

6d5aa9be4521922b42623346a7e7fe7d1dc1b049

重新构建,查看生成的HTML Report,结果如下,是不是好很多

 ●  进入Test详细,查看最新Html Report

7969b111a13ddc8c0bf28f05da2e2ccd4286be4e

 ●  查看某次构建的Report,选中一个build history,查看HTML Report。

04a805b2486e3e8bdcd0d870498965a89ef4328f

 ●  Report详细

aab9e88b640980d23db32df0cbd19269ec5191a4

如果你的Report样式或JS脚本加载不正确,解决方案如下:

https://testerhome.com/topics/9476

以上,内容比较多,写的比较粗,欢迎交流。


原文发布时间为:2018-11-09

本文作者:葡萄城技术

本文来自云栖社区合作伙伴“前端大学”,了解相关信息可以关注“前端大学”。

相关文章
|
23天前
|
Java API 数据库
构建RESTful API已经成为现代Web开发的标准做法之一。Spring Boot框架因其简洁的配置、快速的启动特性及丰富的功能集而备受开发者青睐。
【10月更文挑战第11天】本文介绍如何使用Spring Boot构建在线图书管理系统的RESTful API。通过创建Spring Boot项目,定义`Book`实体类、`BookRepository`接口和`BookService`服务类,最后实现`BookController`控制器来处理HTTP请求,展示了从基础环境搭建到API测试的完整过程。
36 4
|
25天前
|
XML JSON API
ServiceStack:不仅仅是一个高性能Web API和微服务框架,更是一站式解决方案——深入解析其多协议支持及简便开发流程,带您体验前所未有的.NET开发效率革命
【10月更文挑战第9天】ServiceStack 是一个高性能的 Web API 和微服务框架,支持 JSON、XML、CSV 等多种数据格式。它简化了 .NET 应用的开发流程,提供了直观的 RESTful 服务构建方式。ServiceStack 支持高并发请求和复杂业务逻辑,安装简单,通过 NuGet 包管理器即可快速集成。示例代码展示了如何创建一个返回当前日期的简单服务,包括定义请求和响应 DTO、实现服务逻辑、配置路由和宿主。ServiceStack 还支持 WebSocket、SignalR 等实时通信协议,具备自动验证、自动过滤器等丰富功能,适合快速搭建高性能、可扩展的服务端应用。
86 3
|
2天前
|
前端开发 API 开发者
Python Web开发者必看!AJAX、Fetch API实战技巧,让前后端交互如丝般顺滑!
在Web开发中,前后端的高效交互是提升用户体验的关键。本文通过一个基于Flask框架的博客系统实战案例,详细介绍了如何使用AJAX和Fetch API实现不刷新页面查看评论的功能。从后端路由设置到前端请求处理,全面展示了这两种技术的应用技巧,帮助Python Web开发者提升项目质量和开发效率。
8 1
|
9天前
|
JSON API 数据格式
如何使用Python和Flask构建一个简单的RESTful API。Flask是一个轻量级的Web框架
本文介绍了如何使用Python和Flask构建一个简单的RESTful API。Flask是一个轻量级的Web框架,适合小型项目和微服务。文章从环境准备、创建基本Flask应用、定义资源和路由、请求和响应处理、错误处理等方面进行了详细说明,并提供了示例代码。通过这些步骤,读者可以快速上手构建自己的RESTful API。
20 2
|
19天前
|
监控 负载均衡 API
Web、RESTful API 在微服务中有哪些作用?
在微服务架构中,Web 和 RESTful API 扮演着至关重要的角色。它们帮助实现服务之间的通信、数据交换和系统的可扩展性。
41 2
|
25天前
|
人工智能 搜索推荐 API
用于企业AI搜索的Bocha Web Search API,给LLM提供联网搜索能力和长文本上下文
博查Web Search API是由博查提供的企业级互联网网页搜索API接口,允许开发者通过编程访问博查搜索引擎的搜索结果和相关信息,实现在应用程序或网站中集成搜索功能。该API支持近亿级网页内容搜索,适用于各类AI应用、RAG应用和AI Agent智能体的开发,解决数据安全、价格高昂和内容合规等问题。通过注册博查开发者账户、获取API KEY并调用API,开发者可以轻松集成搜索功能。
|
1月前
|
前端开发 JavaScript API
惊呆了!学会AJAX与Fetch API,你的Python Web项目瞬间高大上!
在Web开发领域,AJAX与Fetch API是提升交互体验的关键技术。AJAX(Asynchronous JavaScript and XML)作为异步通信的先驱,通过XMLHttpRequest对象实现了局部页面更新,提升了应用流畅度。Fetch API则以更现代、简洁的方式处理HTTP请求,基于Promises提供了丰富的功能。当与Python Web框架(如Django、Flask)结合时,这两者能显著增强应用的响应速度和用户体验,使项目更加高效、高大上。
47 2
|
1月前
|
前端开发 API 开发者
从零到精通,AJAX与Fetch API让你的Python Web前后端交互无所不能!
从零到精通,AJAX与Fetch API让你的Python Web前后端交互无所不能!
38 3
|
1月前
|
jenkins Shell 持续交付
Jenkins持续集成GitLab项目 GitLab提交分支后触发Jenkis任务 持续集成 CI/CD 超级详细 超多图(二)
Jenkins持续集成GitLab项目 GitLab提交分支后触发Jenkis任务 持续集成 CI/CD 超级详细 超多图(二)
64 0
|
21天前
|
移动开发 前端开发 JavaScript
前端开发实战:利用Web Speech API之speechSynthesis实现文字转语音功能
前端开发实战:利用Web Speech API之speechSynthesis实现文字转语音功能
111 0