使用 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 String
response.asString();
// Get all headers
Headers allHeaders = response.getHeaders()