如何使用JavaScript集成Cypress、Cucumber与TestRail？

1. 基础配置复用 #

先基于已有的Cypress-TestRail集成方案完成核心配置：

• 配置TestRail连接参数（API地址、用户名、API密钥、项目ID），可通过环境变量或单独的配置文件存储，比如testrail.config.js。
• 安装TestRail API依赖或封装自定义API请求工具，用于调用TestRail的创建测试运行、更新测试结果等接口。

2. 利用Cucumber Hooks关联用例与上报结果 #

在Cucumber的钩子文件（cypress/support/hooks.js）中，通过Before和After钩子实现用例关联与结果同步：

• 解析TestRail用例ID：在Before钩子中读取场景标签（如@testrail-123），提取其中的TestRail用例ID并记录。
• 上报测试结果：在After钩子中获取场景执行状态，映射为TestRail的状态ID，调用API更新对应用例的结果。

示例代码：

// 自定义TestRail API工具示例（testrail-api.js）
const axios = require('axios');

const testrail = {
  async addRun(projectId, data) {
    const response = await axios.post(
      `${process.env.TESTRAIL_URL}/index.php?/api/v2/add_run/${projectId}`,
      data,
      { auth: { username: process.env.TESTRAIL_USER, password: process.env.TESTRAIL_API_KEY } }
    );
    return response.data;
  },
  async addResultForCase(runId, caseId, data) {
    await axios.post(
      `${process.env.TESTRAIL_URL}/index.php?/api/v2/add_result_for_case/${runId}/${caseId}`,
      data,
      { auth: { username: process.env.TESTRAIL_USER, password: process.env.TESTRAIL_API_KEY } }
    );
  }
};

module.exports = testrail;

// hooks.js 中的After钩子
const testrail = require('../../testrail-api');

After(async function (scenario) {
  // 从场景标签中提取TestRail用例ID
  const testCaseTag = scenario.pickle.tags.find(tag => tag.name.startsWith('@testrail-'));
  if (!testCaseTag) return;
  
  const testCaseId = testCaseTag.name.split('-')[1];
  
  // 映射Cucumber状态到TestRail状态ID（TestRail默认状态：1=通过，5=失败，4=重测）
  const statusMap = {
    PASSED: 1,
    FAILED: 5,
    PENDING: 4,
    SKIPPED: 3
  };
  const statusId = statusMap[scenario.result.status.toUpperCase()] || 4;
  
  // 上报结果到TestRail
  await testrail.addResultForCase(
    process.env.TESTRAIL_RUN_ID,
    testCaseId,
    { 
      status_id: statusId,
      comment: scenario.result.error ? `失败原因：${scenario.result.error.message}` : '测试通过'
    }
  );
});

3. 动态创建TestRail测试运行 #

在Cypress配置文件中，通过before:run钩子自动创建TestRail测试运行，并将运行ID存入环境变量：

// cypress.config.js
const { defineConfig } = require('cypress');
const testrail = require('./testrail-api');

module.exports = defineConfig({
  e2e: {
    setupNodeEvents(on, config) {
      on('before:run', async () => {
        const runName = `Cucumber自动化测试运行 ${new Date().toLocaleString()}`;
        const run = await testrail.addRun(process.env.TESTRAIL_PROJECT_ID, { name: runName });
        process.env.TESTRAIL_RUN_ID = run.id;
      });
    },
    specPattern: 'cypress/e2e/**/*.feature',
  },
});

4. 特性文件中标记用例 #

在Cucumber特性文件里，给需要关联TestRail的场景添加对应标签：

Feature: 用户登录模块
  @testrail-101
  Scenario: 正确账号密码登录成功
    Given 访问系统登录页
    When 输入用户名"test_user"和密码"test_pass"
    Then 成功跳转至用户首页并显示欢迎信息

  @testrail-102
  Scenario: 错误密码登录失败
    Given 访问系统登录页
    When 输入用户名"test_user"和密码"wrong_pass"
    Then 页面提示"账号或密码错误"

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