最新版Cypress如何优化多参数添加实现通用SQL查询feature文件

现有实现的核心问题 #

• 步骤和Users表、Email查询条件强绑定，无法复用到其他业务表、其他查询维度，每加一个查询场景就要写新的步骤定义
• 断言逻辑硬编码在步骤中，查询字段、预期值变动都要修改步骤代码，维护成本高
• 直接在测试侧拼接SQL字符串，没有转义逻辑，存在SQL注入风险，也不支持多条件组合查询
• 步骤语义过于狭窄，只能满足单一场景，不符合BDD步骤复用的原则

具体优化实现 #

1. 设计通用化Feature语句 #

将查询动作拆成「指定查询目标」「传入查询条件」「执行结果断言」三个独立步骤，支持任意表、任意字段、任意条件、任意预期值的组合，示例：

Scenario: 校验用户表指定邮箱的用户基础信息
    Given 我查询数据库表 "Users" 的字段 "FirstName, LastName, Email, Address"
    When 查询条件为 "Email = 'sam@test.com'"
    Then 查询结果第1行应满足:
      | FirstName | Sam              |
      | LastName  | Thinker          |
      | Email     | sam@test.com     |
      | Address   | 455 Sydney Street|

# 多条件查询示例
Scenario: 校验有效订单列表数据
    Given 我查询数据库表 "Orders" 的字段 "OrderId, TotalAmount, Status"
    When 查询条件为 "UserId = 123 AND Status = 'PAID' AND CreateTime > '2024-01-01'"
    Then 查询结果返回行数应为 2
    And 查询结果第1行字段 "TotalAmount" 的值应为 99.9

如果需要写复杂联表查询，也可以加自定义SQL的兼容步骤，不用被结构化参数限制。

2. 编写可复用的步骤定义 #

通过上下文变量在步骤间传递查询参数，所有逻辑通用化，不需要针对特定业务写重复代码：

const { Given, When, Then } = require("@badeball/cypress-cucumber-preprocessor");

// 初始化查询上下文，做步骤间参数传递
let queryContext = {
  table: "",
  fields: "",
  condition: "",
  result: null
};

// 每个场景执行前重置上下文，避免场景间数据污染
beforeEach(() => {
  queryContext = {
    table: "",
    fields: "",
    condition: "",
    result: null
  };
});

Given("我查询数据库表 {string} 的字段 {string}", (tableName, fields) => {
  queryContext.table = tableName;
  // 传入*时默认查全字段
  queryContext.fields = fields === "*" ? "*" : fields;
});

When("查询条件为 {string}", (condition) => {
  // 传结构化参数给task，不在前端拼接完整SQL
  cy.task("queryDb", {
    table: queryContext.table,
    fields: queryContext.fields,
    condition: condition
  }).then((queryResult) => {
    queryContext.result = queryResult;
  });
});

// 兼容直接执行自定义SQL的场景
Given("我执行自定义SQL查询:", (sqlStr) => {
  cy.task("queryDb", { rawSql: sqlStr }).then((queryResult) => {
    queryContext.result = queryResult;
  });
});

Then("查询结果返回行数应为 {int}", (expectedCount) => {
  expect(queryContext.result).to.have.length(expectedCount);
});

Then("查询结果第{int}行应满足:", (rowIndex, dataTable) => {
  // 日常习惯行号从1开始，这里做下标转换
  const targetRow = queryContext.result[rowIndex - 1];
  const expectedMap = dataTable.rowsHash();
  // 自动遍历传入的预期字段做断言，不需要写死字段名
  Object.entries(expectedMap).forEach(([field, expectedValue]) => {
    expect(targetRow[field]).to.equal(expectedValue);
  });
});

Then("查询结果第{int}行字段 {string} 的值应为 {string}", (rowIndex, field, expectedValue) => {
  const targetRow = queryContext.result[rowIndex - 1];
  expect(targetRow[field]).to.equal(expectedValue);
});

3. 优化task层数据库逻辑 #

把SQL拼接、转义、校验逻辑放到Node侧的task中，从根源避免SQL注入，同时做权限控制：

// cypress.config.js 中task配置示例
const mysql = require("mysql2/promise");

module.exports = defineConfig({
  e2e: {
    setupNodeEvents(on, config) {
      // 初始化数据库连接池，配置从环境变量读取，避免硬编码
      const dbPool = mysql.createPool({
        host: config.env.DB_HOST,
        user: config.env.DB_USER,
        password: config.env.DB_PASSWORD,
        database: config.env.DB_NAME
      });

      on("task", {
        queryDb: async (queryParams) => {
          // 支持直接执行自定义SQL
          if (queryParams.rawSql) {
            const [rows] = await dbPool.query(queryParams.rawSql);
            return rows;
          }
          // 结构化查询逻辑
          const { table, fields, condition } = queryParams;
          // 配置允许查询的表白名单，禁止非法表查询
          const allowedTables = ["Users", "Orders", "Products", "UserAddress"];
          if (!allowedTables.includes(table)) {
            throw new Error(`无查询表${table}的权限，请先在白名单中配置`);
          }
          // 用数据库驱动自带的参数转义能力防注入
          const sql = `SELECT ${fields} FROM ?? WHERE ${condition}`;
          const [rows] = await dbPool.query(sql, [table]);
          return rows;
        }
      });
      return config;
    }
  }
});

额外优化建议 #

• 数据库连接配置全部放到cypress.env.json中，不同测试环境切换时只需要改环境变量，不需要动代码
• 对于高频使用的查询场景，可以在通用步骤基础上再封装语义更简洁的快捷步骤，比如When 查询邮箱为 {string} 的用户数据，内部自动拼接对应条件，减少重复写条件语句的成本
• 可以扩展支持排序、分页、聚合查询的参数传入，覆盖更多查询场景
• 查询结果默认返回JSON数组，不需要额外做格式转换，断言时直接取字段值即可

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