如何为protractor-beautiful-reporter的HTML报告添加自定义日志
protractor-beautiful-reporter 自定义业务日志接入方案
能直接跑通的实现思路
1. 利用Reporter原生接口绑定步骤级日志
protractor-beautiful-reporter本身就内置了面向自定义日志的写入方法,不需要第三方插件或者篡改报告源码,只要在初始化时拿到Reporter实例,就可以在测试执行链路中把业务提示直接挂载到当前运行的用例节点下。
参考基础接入逻辑:
// protractor.conf.js 的 onPrepare 配置块 const BeautifulReporter = require('protractor-beautiful-reporter'); // 将Reporter实例挂到全局,方便测试链路任意位置调用 global.currentReporter = new BeautifulReporter({ baseDirectory: './e2e-reports', takeScreenShotsOnlyForFailedSpecs: true }).getJasmine2Reporter(); jasmine.getEnv().addReporter(global.currentReporter);
在你封装的等待逻辑的超时分支中,直接调用实例方法写入业务提示即可:
// 原等待逻辑 // await browser.wait(ec.visibilityOf(loginPopupEl), 5000) // 改造后的带业务日志的等待逻辑 async function checkLoginPopupShow() { try { await browser.wait(ec.visibilityOf(loginPopupEl), 5000) } catch (e) { // 直接把业务化错误写到当前执行的测试节点下 global.currentReporter.addError('ERROR: the login popup did not show') // 可选择把自定义提示拼接到原始报错上,保证技术排障信息不丢失 throw new Error(`业务提示:the login popup did not show \n 原始报错:${e.message}`) } }
写入的日志会自动关联当前失败用例,直接展示在HTML报告的用例详情区,不会和其他用例的日志串位。
2. 无侵入式替换通用超时报错
针对“超时只出通用技术提示”的痛点,不需要每个等待方法都手动加try/catch,只要在全局覆写browser.wait的默认错误生成逻辑,就可以把超时抛出的原始错误替换为业务提示:
// 还是在onPrepare块里做全局打补丁 const originBrowserWait = browser.wait; browser.wait = function(condition, timeout, customBusinessTip) { // 优先使用传入的业务提示生成错误消息,没传就保留原有的通用报错逻辑 const finalErrorMsg = customBusinessTip ? `ERROR: ${customBusinessTip}` : `Wait timed out after ${timeout}ms` return originBrowserWait.call(this, condition, timeout, finalErrorMsg) }
改造完之后,所有等待调用只要多传一个业务提示参数,触发超时的时候抛出的错误本身就带业务信息,而Reporter会自动把抛出的错误完整展示在报告里,不需要额外手动写日志:
// 改造后的等待调用,直接传业务提示 await browser.wait(ec.visibilityOf(loginPopupEl), 5000, 'the login popup did not show')
实际踩坑注意事项
- 绝对不要在全局
afterAll或者异步延迟队列里调用日志写入方法,这类场景下jasmine的当前用例执行上下文已经切换,很容易出现日志挂错用例的问题,最稳妥的写法是在catch块里同步调用日志方法。 - 写日志的时候直接传纯文本就行,不要手动拼接HTML标签,Reporter本身会对日志内容做转义,传带HTML的内容很容易破坏报告页面的正常渲染。
- 按照日志等级区分调用方法:普通流程提示用
addLog,需要高亮标记的业务异常用addError,能保持报告原来的视觉层级,不会出现所有内容都堆在一个列表里找不到重点的问题。 - 长期维护可以把等待逻辑和业务提示绑定到页面对象的方法里,比如在LoginPage类里写死
waitForPopup方法对应的提示语,后续所有调用这个方法的地方都不需要重复传提示参数,维护成本很低。
内容的提问来源于stack exchange,提问作者Zoette
相关产品推荐
相关产品推荐

