Gherkin+Cypress+Cucumber不同Feature文件步骤重名报错解决方案咨询

方案1：按目录隔离步骤定义（推荐） #

Cypress Cucumber Preprocessor支持按目录结构自动隔离步骤定义，仅加载当前feature所在目录（及父目录）的步骤文件，具体操作如下：

• 调整项目目录结构：

  cypress/
    e2e/
      login/
        login.feature
        login.js
      registration/
        registration.feature
        registration.js
  

• 在cypress.config.js中确保开启nonGlobalStepDefinitions配置（部分版本默认已开启，未开启则手动添加）：

  const { defineConfig } = require("cypress");
  const createBundler = require("@bahmutov/cypress-esbuild-preprocessor");
  const addCucumberPreprocessorPlugin = require("@badeball/cypress-cucumber-preprocessor").addCucumberPreprocessorPlugin;
  const createEsbuildPlugin = require("@badeball/cypress-cucumber-preprocessor/esbuild").createEsbuildPlugin;
  
  module.exports = defineConfig({
    e2e: {
      specPattern: "**/*.feature",
      async setupNodeEvents(on, config) {
        const bundler = createBundler({
          plugins: [createEsbuildPlugin(config)],
        });
        on("file:preprocessor", bundler);
        await addCucumberPreprocessorPlugin(on, config);
        return config;
      },
      nonGlobalStepDefinitions: true, // 关键配置，开启后步骤定义按目录隔离
    },
  });
  

配置完成后，login.js的步骤只会匹配login目录下的login.feature，registration.js的步骤仅匹配registration目录下的registration.feature，完全隔离且无需修改步骤文本。

方案2：用标签（Tags）限定步骤定义的匹配范围 #

给不同feature文件添加专属标签，再在步骤定义中指定仅匹配带对应标签的场景：

1. 给login.feature添加标签：

   @login
   Feature: Login Module
     Scenario: Successful login
       Given A user enters the username "testuser"
       ...
   

2. 给registration.feature添加标签：

   @registration
   Feature: Registration Module
     Scenario: Successful registration
       Given A user enters the username "newuser"
       ...
   

3. 在步骤定义文件中添加标签限定：
   • login.js：

     import { Given } from "@badeball/cypress-cucumber-preprocessor";
     
     Given({ tags: "@login" }, "A user enters the username {string}", (username) => {
       cy.get("#login-username").type(username);
     });
     

   • registration.js：

     import { Given } from "@badeball/cypress-cucumber-preprocessor";
     
     Given({ tags: "@registration" }, "A user enters the username {string}", (username) => {
       cy.get("#register-username").type(username);
     });
     

运行测试时，Cucumber会根据场景标签自动匹配对应步骤定义，不会出现冲突。

方案3：在步骤定义中判断当前feature文件 #

通过this.testCase.sourceLocation.uri获取当前执行的feature文件路径，根据路径判断执行对应模块逻辑，无需调整目录或加标签：

// login.js
import { Given } from "@badeball/cypress-cucumber-preprocessor";

Given("A user enters the username {string}", function (username) {
  if (this.testCase.sourceLocation.uri.includes("login.feature")) {
    cy.get("#login-username").type(username);
  }
});

// registration.js
import { Given } from "@badeball/cypress-cucumber-preprocessor";

Given("A user enters the username {string}", function (username) {
  if (this.testCase.sourceLocation.uri.includes("registration.feature")) {
    cy.get("#register-username").type(username);
  }
});

这种方式两个步骤定义都会被加载，但通过条件判断跳过不匹配逻辑，适合不想调整项目结构的场景。

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