本文记录如何排查解决cy.task()未注册的问题
起因
根据官方文档的指引,安装cypress-otp,帮助在web测试时自动获取otp
执行用例后报错【cy.task(‘generateOTP’) failed with the following error: The ‘task’ event has not been registered in the setupNodeEvents method. You must register it before using cy.task() Fix this in your setupNodeEvents method here: D:\project\cypress\cypress_demo\cypress.config.js】
排查过程
对照官方文档,核对注册task的地址cypress/plugins/index.js没有问题。网上查阅了大量资料,没有好的解决方案。
仔细看了报错后发现问题出现在cypress.config.js文件中的setupNodeEvents 方法中。但是根据opt插件安装指引,并未提到这个文件和方法。资料显示plugins插件会在cypress用例执行之前自动加载,那现在报错未找到task,也就是说并没有加载plugins文件,而是加载了cypress.config.js文件。
抱着试一试的心态在官网文档中搜一下setupNodeEvents 方法看看是什么作用,然后问题就逐渐明朗
检索到关于setupNodeEvents 方法的说明,并查看了版本变更日志,得出结论,在10.0.0版本之后就不再使用pluginsFile ,需要将插件写到setupNodeEvents方法中
解决
在setupNodeEvents 方法中添加如下代码,即可正常获取opt
on("task", {
generateOTP: require("cypress-otp")
});