Cypress如何标识describe/测试/文件仅在指定环境运行

你现有已经通过env变量区分4套运行环境的基础上，不需要额外装第三方插件，靠Cypress原生的测试跳过、动态注册机制，就能覆盖三个粒度的环境筛选需求，具体操作如下：

第一步：抽公共环境判断逻辑 #

避免每个测试块硬写环境判断、拼写不一致的问题，先在cypress/support/commands.js或者单独的工具文件里抽公共方法：

// 从你已有的env配置取当前运行环境（替换成你实际的env变量名即可）
const currentEnv = Cypress.env('TARGET_ENV')

/**
 * 校验当前运行环境是否在允许执行的环境列表内
 * @param {Array} allowedEnvs 允许执行的环境集合，比如 ['production', 'staging']
 * @returns {boolean} 匹配返回true，不匹配返回false
 */
export const isEnvAllowed = (allowedEnvs = []) => {
  return allowedEnvs.includes(currentEnv)
}

按测试粒度添加环境标记 #

1. 单个测试用例（it块）标记 #

针对某一条独立用例指定运行环境，直接在it的函数上下文里做判断，不匹配就跳过，跳过的用例会在测试报告里标记为skipped，不会计为失败：

it('生产环境专属的支付回调幂等性校验', function() {
  // 不匹配目标环境直接跳过
  if (!isEnvAllowed(['production'])) {
    cy.log(`当前环境为${currentEnv}，该用例仅在production运行，自动跳过`)
    this.skip()
  }
  // 以下是正常测试逻辑
  cy.repeatPaymentCallback()
  cy.assertOrderStatusNotDuplicated()
})

注意：这里的it回调必须用普通函数写法，不能用箭头函数，否则拿不到绑定的测试上下文，this.skip()会报上下文错误。

2. 整个describe测试块标记 #

针对某一组关联的同类型用例，统一限制运行环境，不用在每个it里重复写判断，有两种常用写法：

• 写法1：通过beforeEach钩子统一控制跳过，不匹配环境时块内所有用例都会被标记为skipped

  describe('Staging环境专属的权限边界测试集', function() {
    beforeEach(function() {
      if (!isEnvAllowed(['staging'])) {
        cy.log('当前环境非staging，跳过整个权限测试块')
        this.skip()
      }
    })
  
    it('管理员账号越权操作拦截校验', () => { /* 测试逻辑 */ })
    it('普通用户无权限访问系统设置校验', () => { /* 测试逻辑 */ })
  })
  

• 写法2：不匹配环境时直接不注册整个测试块，测试报告里连skipped的条目都不会出现，报告更干净

  // 只有当前环境为production时，才会注册这个生产合规测试块
  if (isEnvAllowed(['production'])) {
    describe('生产环境合规性校验测试集', () => {
      it('生产页面无未关闭的调试弹窗', () => { /* 测试逻辑 */ })
      it('生产环境接口无敏感信息返回', () => { /* 测试逻辑 */ })
    })
  }
  

3. 整个测试文件标记 #

针对整个文件内的所有用例，指定仅在特定环境运行，直接在文件最顶部做判断，不匹配环境就终止整个文件的加载，后面的所有测试块都不会被Cypress识别：

// 测试文件最顶部，所有describe、it定义之前
// 比如这个文件是生产专属的性能监控校验用例
if (!isEnvAllowed(['production'])) {
  // 不满足环境要求直接终止文件加载，后续代码不会执行
  return
}

// 以下所有内容，只有环境匹配时才会加载执行
describe('生产核心接口响应性能校验', () => {
  it('商品列表接口响应时间<200ms', () => { /* 测试逻辑 */ })
  it('支付接口响应时间<500ms', () => { /* 测试逻辑 */ })
})

避坑提醒 #

• 环境判断的取值要和你之前配置的env变量值完全一致，避免因为大小写、拼写错误导致测试漏跑，比如统一把环境值存成小写的local/staging/production/custom，不要混用大小写
• 不要把环境判断写在用例逻辑的中间位置，一定要放在测试逻辑的最开头，否则会出现部分测试步骤执行完才跳过的情况，浪费执行时间
• 如果需要更灵活的标签筛选能力，可以搭配自定义标签插件实现多维度筛选，但前面讲的原生实现不需要额外依赖，满足基础的环境筛选需求完全够用。

内容的提问来源于stack exchange，提问作者voy