Karate DSL：如何将Scenario Outline变量传入独立存放的GraphQL查询JSON字符串

我来帮你搞定这个查询复用和变量替换的难题！针对你想把GraphQL查询和Cucumber Feature文件分离，同时从Scenario Outline的Examples模块传入变量的需求，这里有两个实用的解决方案，你可以根据自己的场景选择：

方案1：利用GraphQL原生变量机制（推荐） #

这是最规范的做法，完全贴合GraphQL的设计，还能避免字符串替换带来的潜在问题。

步骤1：编写带变量的分离查询文件 #

把查询里需要动态替换的部分定义成GraphQL变量，比如创建get_user_query.graphql：

query GetUserDetails($user_id: ID!) {
  user(id: $user_id) {
    name
    email
    role
  }
}

步骤2：编写Feature文件的Scenario Outline #

在Examples里定义要传入的变量值：

Scenario Outline: 查询不同用户的详细信息
  Given 加载GraphQL查询文件 "get_user_query.graphql"
  When 使用用户ID "<user_id>" 执行查询
  Then 响应中的用户姓名应为 "<expected_name>"

  Examples:
    | user_id | expected_name |
    | u1001   | John Doe      |
    | u1002   | Jane Smith    |

步骤3：在Step定义中处理变量注入 #

以JavaScript+Cucumber为例，读取查询文件后，把Examples里的变量传入GraphQL请求：

const fs = require('fs');
const { Given, When, Then } = require('@cucumber/cucumber');
const { executeGraphQL } = require('./your-graphql-client'); // 封装的GraphQL请求工具

let queryContent;
let response;

Given('加载GraphQL查询文件 {string}', (filePath) => {
  queryContent = fs.readFileSync(`./queries/${filePath}`, 'utf8');
});

When('使用用户ID {string} 执行查询', (userId) => {
  // 把Examples中的变量包装成GraphQL要求的变量对象
  const variables = { user_id: userId };
  return executeGraphQL(queryContent, variables)
    .then(res => response = res);
});

Then('响应中的用户姓名应为 {string}', (expectedName) => {
  if (response.data.user.name !== expectedName) {
    throw new Error(`预期姓名: ${expectedName}, 实际姓名: ${response.data.user.name}`);
  }
});

方案2：字符串替换（适用于无法使用GraphQL变量的场景） #

如果你的查询确实需要嵌入固定字符串（比如某些特殊的查询语法不支持变量），可以用字符串占位符+替换的方式：

步骤1：在查询文件中添加占位符 #

比如get_orders_query.graphql：

query GetRecentOrders {
  orders(filter: { status: "STATUS_PLACEHOLDER", createdAfter: "7_DAYS_AGO" }) {
    id
    totalAmount
  }
}

步骤2：在Step定义中替换占位符 #

修改When步骤的逻辑，把Examples中的变量替换到查询字符串里：

When('使用订单状态 {string} 执行查询', (status) => {
  // 替换查询中的占位符
  const processedQuery = queryContent.replace('STATUS_PLACEHOLDER', status);
  return executeGraphQL(processedQuery)
    .then(res => response = res);
});

注意事项 #

• 优先选择方案1，因为GraphQL变量是原生支持的特性，能避免SQL/GraphQL注入风险，也更易维护。
• 如果用字符串替换，建议使用语义化的占位符（比如{{STATUS}}），避免和查询本身的语法冲突。

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