使用Cypress.io为Node模块编写单元测试时调用task方法出现断言报错
报错原因定位与修复方案
一、报错中特殊对象的含义
报错提示里的{ Object (userInvocationStack, specWindow, ...) }是Cypress内部的命令封装对象,既不是Node端task返回的业务结果,也不是测试逻辑里的任何数据。
Cypress所有cy.*开头的命令都是异步排队、按测试执行顺序调度的,本身不会同步返回执行结果。当前把cy.task(...)的调用返回值直接传给expect时,拿到的就是这个绑定了调用栈、spec窗口上下文的内部命令实例,根本没有取到task实际跑完后的返回值,自然无法和预期的空数组、票据对象做相等校验,才会触发这个不匹配的报错。
二、可落地的修复步骤
本次问题一共有3处核心错误,逐处修正即可正常运行:
- 修正测试文件的断言写法:异步命令必须通过链式
.then()回调取出真实返回值后再做断言,不能直接将cy.task(...)的调用返回值传入expect。对象/数组对比时要使用deep.eq做深度相等判断,避免不同引用下浅对比的误差。
修正后的测试文件示例:describe('Unit Tests for utils.js methods', () => { const mockedTickets = { data: { issues: [ { id: 1, key: 'ticket-key-1', fields: { summary: 'This is ticket number 1' } }, { id: 2, key: 'ticket-key-2', fields: { summary: 'This is ticket number 2' } }, ], }, }; const mockedEmptyTicketsArray = []; it('returns an array containing a found ticket summary', () => { cy.task('getTicketBySummary', { issues: mockedTickets, summaryTitle: 'This is ticket number 1', }).then((result) => { expect(result).deep.eq([mockedTickets.data.issues[0]]); }); }); it('returns an empty array, when no ticket summary was found', () => { cy.task('getTicketBySummary', { issues: mockedTickets, summaryTitle: 'This is ticket number 3', }).then((result) => { expect(result).deep.eq(mockedEmptyTicketsArray); }); }); }); - 修正插件文件的task回调逻辑:当前task的回调函数没有手动return filter的计算结果,会导致Cypress默认返回
undefined;同时Array.filter的回调逻辑冗余,filter本身只需要接收返回布尔值的回调,不需要在回调里返回元素本身。
修正后的插件代码示例:on('task', { getTicketBySummary({ issues, summaryTitle }) { return issues.data.issues.filter(issueData => { return issueData.fields.summary === summaryTitle; }); }, }); - 对齐测试预期与实际返回结构:Array.filter的输出是符合条件元素组成的数组,原测试中第一个用例直接将预期值写为单个票据对象,即使修复了前面的问题,也会因为“数组vs单个对象”的结构不匹配触发断言错误,需要将预期值调整为数组结构。
内容的提问来源于stack exchange,提问作者Manuel Abascal
相关产品推荐
相关产品推荐

