干货 | REST-assured 获取日志到文件并结合 Allure 报告进行展示
yuyutoo 2024-12-23 14:29 2 浏览 0 评论
使用 Rest-assured 集合 Allure 运行完用例之后,在生成的报告中只有断言信息,没有请求的日志信息。而当我们的用例失败时,特别是接口失败时,请求日志是分析原因的第一手资源。那如何将 Rest-assured 产生的日志存入 Allure 里,并且能和用例一一对应起来呢?
1. 需求与方向
1.1 问题产生
在使用 Rest-assured 集合 Allure 运行完用例之后,查看生成的报告信息如下:
我们可以看到在生成的报告中只有断言信息,而没有请求的日志信息,而当我们的用例失败时,特别是接口失败时,请求日志是分析原因的第一手资源;
1.2 需求产生
其实Rest-assured是有请求日志的,可以通过在given()和then()后面加上.log().all()来打印全部的日志信息:
这块不是本文想介绍的重点,所以想了解的可以参考以往的文章或直接阅读官方文档
那么问题来了,如何将这打印出来的日志信息都"转移"到 Allure 报告中呢?并且能和用例一一对应起来,然后就开始了探索之路~
1.3 思路产生
下面的解决方案都是在我现阶段研究 Rest-assured 及 Allure 的基础上实现的,可能研究并不透彻不全面,也许有更好的方法使用,请大家多提反馈意见。
首先来看一下 Allure 报告可以如何展示日志,在学习 Allure 的过程中发现 Allure有添加附件展示的功能,那么我就直接想到将日志能存入文件然后添加到报告附件不就可以了吗?由此,Allure 端的解决方向确定。
接下来就是要想法办将 Rest-assured 产生的日志存入文件了;
整体思路:
【Rest-assured打印日志】- 【Rest-assured日志存入文件】- 【文件以附件形式传入Allure】- 【Allure展示附件日志】
2. Allure附件
先看一下Allure 添加附件的两种方法:
@Attachment:在方法上添加注解@Attachment,方法的返回值就会作为附件上传,可添加展示文本和附件类型
@Attachment(value = "Page screenshot", type = "image/png")
Allure.addAttachment:通过addAttachment方法指定要添加的附件和展示信息
public static void addHttpLogToAllure() { try { Allure.addAttachment("接口请求响应日志", new FileInputStream("src/main/resources/test.log")); } catch (FileNotFoundException e) { e.printStackTrace(); } }
3、保存日志
如果是我们自己打印的日志信息,可以任意保存或直接使用 log4j 即可,但是请求的日志是由 Rest-assured 产生的,这可能就需要去查阅框架相关 log 方面的文档资料。
3.1 初始版
3.1.1 方案选择
由于在框架中,我已经进行了封装,每个接口请求后都会返回 response 信息。所以一开始我想着从拿到 response 信息进行存储,查阅官方文档,寻找 response 信息获取的相关 API,发现 response.asString();可以获取到 json body 的信息,就先尝试使用。
//// Get the response body as a Stringresponse.asString();// Get all headersHeaders allHeaders = response.getHeaders();// Get a single header value:String headerName = response.getHeader("headerName");// Get all cookies as simple name-value pairsMap<String, String> allCookies = response.getCookies();// Get a single cookie value:String cookieValue = response.getCookie("cookieName");// Get status lineString statusLine = response.getStatusLine();// Get status codeint statusCode = response.getStatusCode();
- 先创建方法,用于接收 response 获取信息
@Attachment("响应报文")public static String respondBody(Response response) { boolean prettyFormat = true; JSONObject jsonObject = JSONObject.parseObject(response.asString()); String responseBody = JSONObject.toJSONString(jsonObject,prettyFormat); return responseBody;}
- 再创建方法,用于接收请求信息,由于我的所有请求信息都传入了一个 Restful 对象中且未找到 Rest-assured 关于请求信息直接获取的 API,这里我就直接取 Restful对象
Restful对象:
import lombok.Data;import java.util.HashMap;@Datapublic class Restful { public String url; public String method; public HashMap<String,Object> header = new HashMap<>(); public HashMap<String,Object> query = new HashMap<>(); public HashMap<String,Object> pathQuery = new HashMap<>(); public String body;}
接收请求信息方法
@Attachment("请求信息")public static String requestBody(Restful restful) { //报告展现请求信息 return restful.toString();}
- 最后创建一个总的接收方法加入请求流程中,在每个请求结束后获取日志信息进行附件添加
public static void getRequestAndRespondBody(Restful restful, Response response){ requestBody(restful); respondBody(response); }
3.1.2 结果展示
从结果可以看到请求和响应报文已经成功展示,说明这种实现的思路的可行性,只是展示的日志信息还不满意,还是先想要全部的请求和响应信息且是格式化后的,不仅仅只有报文,继续探索~
3.2 RestAssured.config().logConfig
3.2.1 方法实现
在研究过程中发现RestAssured提供了logConfig方法,可以将原本在Console中打印的信息指定格式化输出到文件中,具体用法如下(这里指演示重点实现原理部分,其余封装细节太冗余就不展示了):
- WriterOutputStream用到依赖如下:
<dependency> <groupId>commons-io</groupId> <artifactId>commons-io</artifactId> <version>2.4</version></dependency>
- 在请求中设置log打印方式和存储路径
public void addLogToFile(){ try (FileWriter fileWriter = new FileWriter("src/main/resources/test.log"); PrintStream printStream = new PrintStream(new WriterOutputStream(fileWriter), true)) { RestAssured.config = RestAssured.config().logConfig(LogConfig.logConfig().defaultStream(printStream)); given().XXX.log().all(). when().XXX then().log().all(); } catch (IOException e) { e.printStackTrace(); }}
RestAssured提供的logConfig方法目前发现只能覆盖,无法append,不过这正好符合我们的需求,每个用例的接口请求都只一一对应各自的日志信息,这样每执行一个接口,保存一份日志信息;下一个接口执行的时候就会覆盖成新的当前接口信息保存展示
- 创建附件添加方法加入请求流程中,在每个请求结束后获取日志信息进行附件添加
public static void addHttpLogToAllure() { try { Allure.addAttachment("接口请求响应日志", new FileInputStream("src/main/resources/test.log")); } catch (FileNotFoundException e) { e.printStackTrace(); }}
- 整体的流程思路就是:
@Testvoid testAllureReport(){ addLogToFile(); addHttpLogToAllure();}
3.2.2 结果展示
在下面展示的用例中有2个接口请求,可以看到分别记录展示了,且格式与 Console 中格式化打印的保持一致。
3.3 RestAssured.filters
3.3.1 方法实现
Rest-assured 提供了过滤器 Filters,利用它可以串改请求,设置鉴权信息,过滤 log 等,具体的可在官网中进行学习研究,这里主要用到 RequestLoggingFilter()和 ResponseLoggingFilter() 来实现我们的需求。
RequestLoggingFilter() 和 ResponseLoggingFilter() 可以将所有的请求和响应的 log 进行打印,而我们想要的是将 log 存入文件,因此还要借助方法 logRequestTo(PrintStream stream),指定 log 的格式化输出到文件中:
FileWriter fileWriter = null;try { fileWriter = new FileWriter("src/main/resources/test.log");} catch (IOException e) { e.printStackTrace();}PrintStream printStream = new PrintStream(new WriterOutputStream(fileWriter), true);RestAssured.filters(new RequestLoggingFilter().logRequestTo(printStream),new ResponseLoggingFilter().logResponseTo(printStream));
附件添加复用上述的方法:
AllureAttachment.addHttpLogToAllure();
3.3.2 结果展示
结果依然实现了我们的需求
(文章来源于霍格沃兹测试学院)
相关推荐
- 一篇文章认识JavaScript中的Web API
-
在了解webapi之前先要明白在我们声明变量三个关键字(var、let、const),我们到底该用哪一个?首先排除var,它是老牌的写法,会有很多问题,可以淘汰掉...我们在开发中建议const...
- html5大神结合js带你研究古老读心术,你的心思早被猜透
-
javascript/HTML5课题:javascript开发读心术游戏PS:大爆料!javascript解密读心术游戏背后故事知识点:读心术原理算法独家揭秘,HTML5最新选择器,...
- 纯CSS实现3个圆圈横向排列不断闪烁的Loading特效
-
这个纯CSS实现的Loading特效是一个非常简单而实用的选择,它由三个圆圈横向排列,并不断闪烁。这种动画效果很适合用于页面加载过程中,为用户提供一个愉悦的等待体验。在这个特效的设计中,使用了CSS的...
- 网站建设知识分享系列文章三:符合用户体验的网页设计应如何做?
-
上篇文章向各位讲述了网站建设知识分享系列文章二:如何选择建站公司,今天我们来讲述下建站公司选定后,网站制作流程是怎样的,有哪些需要注意的细节性问题。选定建站公司,签订正规劳务合同后,最先开始的是设计环...
- 「更新」微信小程序 Lottie 动画组件 lottiejs-miniapp V1.1.0 发布
-
lottiejs-miniapp当前版本号:1.1.0npm地址:...
- Web开发基础之jQuery javascript web开发
-
jQuery是一个JavaScript库。jQuery极大地简化了JavaScript编程。jQuery的语法设计可以使开发更加便捷,例如操作文档对象、选择DOM元素、制作动画效果、事件处理、使用Aj...
- Web前端:JavaScript最强总结,最全面的零基础入门教程
-
JavaScript是网景(Netscape)公司开发的一种基于客户端浏览器、面向(基于)对象、事件驱动式的网页脚本语言。JavaScript语言的前身叫作Livescript。JavaScript...
- jQuery 动画制作与特效 jquery的动画函数
-
使用show()和hide()方法在普通的javascript编程中,要实现元素的显示、隐藏通常是利用其CSS的display属性或者visibility属性。在jQuery中提供了show()和hi...
- JavaScript+css实现的登录注册页面web前端html源码
-
大家好,今天给大家介绍一款,JavaScript+css实现的登录注册页面web前端html源码(图1),布局合理。送给大家哦,获取方式在本文末尾。文本框获取焦点动画特效(图2)源码完整,需要的朋友可...
- CSS 3.0+HTML5.0制作各种网页特效
-
?1、C33实现点击图片渐渐放大特效??2、CSS3实现图片全屏背景特效?3、CSS3实现的鼠标移动到图片上不规则放大??3、jQuery+CSS3模拟苹果桌面系统??4、CSS3+jQuery照片...
- js+css实现的按钮悬停动画特效html前端源码,随机元素弹出效果
-
大家好,今天给大家介绍一款,js+css实现的按钮悬停动画特效html页面前端源码,随机元素弹出(图1)。送给大家哦,获取方式在本文末尾。鼠标经过按钮区域的时候,会随机从不同位置上弹出很多小元素,效果...
- Swiper - 免费开源、功能强大的触摸滑动js特效插件
-
简单配置就能实现手机、PC网页中滑动、焦点轮播图、tab切换和触摸导航等大部分功能。js滑动特效插件Swiper是一款纯javascript打造的滑动特效插件,主要用对移动端web开发...
- html5精选特效代码分享(收藏) html酷炫特效
-
在网页设计过程中,我们会经常用到一些HTML5特效代码,下面就是为大家整理分享的一些好看炫酷且实用的HTML5特效代码,可以放心在您的应用程序中使用。一、Canvas跟随鼠标光标动画特效演示、下载地址...
- 玩转Markdown(2)——抽象语法树的提取与操纵
-
上一篇玩转Markdown——数据的分离存储与组件的原生渲染发布,转眼已经鸽了大半年了。最近在操纵mdast生成md文件的时候,心血来潮,把玩转Markdown(2)给补上了。...
- 任由文字肆意流淌,更自由的开源 Markdown 编辑器
-
对于创作平台来说内容编辑器是十分重要的功能,强大的编辑器可以让创作者专注于创作“笔”下生花。而最好取悦程序员创作者的方法之一就是支持Markdown写作,因为大多数程序员都是用Markdown...
你 发表评论:
欢迎- 一周热门
- 最近发表
-
- 一篇文章认识JavaScript中的Web API
- html5大神结合js带你研究古老读心术,你的心思早被猜透
- 纯CSS实现3个圆圈横向排列不断闪烁的Loading特效
- 网站建设知识分享系列文章三:符合用户体验的网页设计应如何做?
- 「更新」微信小程序 Lottie 动画组件 lottiejs-miniapp V1.1.0 发布
- Web开发基础之jQuery javascript web开发
- Web前端:JavaScript最强总结,最全面的零基础入门教程
- jQuery 动画制作与特效 jquery的动画函数
- JavaScript+css实现的登录注册页面web前端html源码
- CSS 3.0+HTML5.0制作各种网页特效
- 标签列表
-
- mybatis plus (70)
- scheduledtask (71)
- css滚动条 (60)
- java学生成绩管理系统 (59)
- 结构体数组 (69)
- databasemetadata (64)
- javastatic (68)
- jsp实用教程 (53)
- fontawesome (57)
- widget开发 (57)
- vb net教程 (62)
- hibernate 教程 (63)
- case语句 (57)
- svn连接 (74)
- directoryindex (69)
- session timeout (58)
- textbox换行 (67)
- extension_dir (64)
- linearlayout (58)
- vba高级教程 (75)
- iframe用法 (58)
- sqlparameter (59)
- trim函数 (59)
- flex布局 (63)
- contextloaderlistener (56)