SerenityRest处理无响应内容接口时报告生成报错的解决方法
报错根因
这个问题的触发逻辑非常直接:
- 标准201创建接口的响应可以没有正文内容,此时RestAssured解析得到的
response.getBody()是null,而非空字符串 - Serenity的报告采集模块没有对这个null值做判空,直接将其传入FreeMarker渲染流程,调用
Formatter.renderText(String)方法时触发空指针,最终中断整个报告生成流程,导致Maven构建失败 - 改用原生RestAssured能规避报错,本质是绕开了Serenity内置的请求拦截与报告采集链路,代价是测试报告完全丢失REST请求/响应的全量追踪信息,属于没有实际价值的临时规避手段
可落地的解决方法
所有方案都会完整保留Serenity报告的请求/响应全量信息,从根源解决空响应触发的渲染报错:
- 单用例快速适配
对无正文的201/204类接口,在原有链式调用中补充状态码断言,通过extract方法触发Serenity的内置空值兼容逻辑,阻断null值进入报告链路:return SerenityRest.rest().given() .contentType(ContentType.JSON) .log().all() .body(requestbody) .post("/somepath/v1/resource") .then() // 断言预期201状态码 .statusCode(201) // 触发Serenity的响应包装逻辑,自动将null body替换为空串 .extract().response(); - 全局配置(推荐长期使用)
不需要逐用例修改代码,直接在项目根目录的serenity.properties文件中添加内置兼容配置,对所有REST类用例永久生效:
这个是Serenity官方内置的兼容参数,专门针对无正文响应的场景设计,配置完成后所有201/204类接口的报告生成都不会触发NPE,且完整保留请求头、请求体、响应状态码等所有追踪信息。# 空响应统一使用空字符串作为占位内容,替代null值传入报告渲染流程 serenity.rest.report.empty.response.placeholder= - 旧版本Serenity兼容方案
如果使用的Serenity版本低于3.14.0,内置的空值占位配置未生效,可以在公共Step工具类中增加一层响应包装逻辑,不需要切换到原生RestAssured:
调用时将原始接口响应传入该方法做一层转换即可,完全不影响原有断言逻辑,也不会丢失报告采集的核心能力。public static Response wrapEmptyBodyResponse(Response rawResponse) { if (rawResponse.getBody() == null) { // 构造带空响应体的等效对象,传入Serenity的报告采集流程 return new ResponseBuilder() .setStatusCode(rawResponse.getStatusCode()) .setHeaders(rawResponse.getHeaders()) .setBody(ResponseBody.from("")) .build(); } return rawResponse; }
避坑提示
不要为了规避报错直接切换为原生RestAssured调用,这种方式虽然绕开Serenity的内部拦截逻辑不会触发NPE,但会导致报告模块无法采集请求详情、响应详情等核心测试追踪信息,完全浪费Serenity的测试报告能力,属于得不偿失的临时方案。
内容的提问来源于stack exchange,提问作者Beejal Shah
相关产品推荐
相关产品推荐

