SuperAPI AI 工具集

cypress-testing

测试与质量

查看项目

更新于 10-26 16:19

技能介绍

用途

Cypress Testing 技能用于在编写 Cypress 端到端(e2e)或组件测试、创建自定义命令、拦截网络请求,或将 Cypress 集成到 CI 时提供指导。Cypress 是一个现代、开发者优先的端到端与组件测试框架,直接运行在浏览器中。与基于 Selenium 的工具不同,Cypress 在浏览器的执行上下文中运行,可原生访问 DOM、网络层与应用状态。该技能覆盖编写可靠的 e2e 测试、组件测试、自定义命令、网络拦截、认证策略与 CI 集成。

触发场景

当用户提出以下需求时触发该技能:编写或调试 Cypress e2e 测试;设置 Cypress 组件测试;使用 cy.intercept 拦截或桩化网络请求;询问如何使用 cy.get、cy.contains 或其他 Cypress 命令;创建可复用的自定义 Cypress 命令;询问 fixtures、aliases 或 Cypress 命令队列;将 Cypress 集成到 GitHub Actions 或其他 CI 流水线。

不适用于:使用 Jest、Vitest 等的单元测试(不使用 Cypress runner);Playwright 或 Puppeteer 测试编写(API 完全不同)。

主要能力与核心原则

  • 避免任意等待:不要使用 cy.wait(2000),应使用 cy.intercept 别名(cy.wait('@alias'))、cy.contains 或断言重试。Cypress 默认自动重试最长 4 秒。
  • 使用 data-testid 选择器:不要用 CSS 类、标签名或会变化的文本选择元素,应添加 data-testid 并用 cy.get('[data-testid="submit-btn"]') 选择。
  • 拦截网络请求,不访问真实 API:使用 cy.intercept 桩化所有 HTTP 调用,用 fixtures 或内联 JSON 提供响应。
  • 每个测试必须独立:测试之间不共享状态,使用 beforeEach 重置状态、重新播种 fixtures 并重新桩化路由,不依赖执行顺序。
  • 使用自定义命令实现复用:重复的多步设置(登录、播种数据、导航到页面)应放在 cypress/support/commands.ts 中。

核心概念包括:命令队列与链式调用(Cypress 命令是异步入队的,不能混用 async/await)、重试能力、拦截与桩化的区别、组件测试与 e2e 测试的区别。

使用方式

技能提供多种常见任务的示例代码,包括:页面对象模式测试、拦截并桩化 API 响应、使用 TypeScript 创建自定义命令、组件测试设置、通过 cy.session 与 cy.request 以编程方式处理认证、使用截图进行视觉回归、以及 GitHub Actions 的 CI 集成配置。

技能还列出反模式对照表(如 cy.wait(3000)、cy.get('.btn-primary')、访问真实 API、每个测试都通过 UI 登录、测试间共享状态、在 Cypress 命令中使用 async/await)及应采用的替代做法。

适用场景

适用于需要编写或维护 Cypress e2e 测试、组件测试、自定义命令、网络拦截、认证策略与 CI 集成的开发场景。

限制与注意事项

技能列出了若干易错点:混用 async/await 会破坏命令队列;cy.session 缓存失效可能导致后续测试出现 401;过度宽泛的拦截会破坏测试隔离;组件测试挂载时缺少 providers 会崩溃或渲染错误;动态渲染列表上使用单一 data-testid 会导致选择器返回集合。技能还包含一个 companion check 流程,用于检查已安装的配套技能并提示安装缺失项。