Karate测试框架：如何在GitHub外部存储凭证并运行时调用

当然支持！Karate在处理敏感凭证这类场景上灵活性拉满，完全不需要把client_id和client_secret硬编码到GitHub仓库里，下面给你几种实用的实现方式，结合你的user-login.feature来具体说明：

方法1：通过环境变量传递 #

这是最常见的敏感信息传递方式，你可以在本地终端或CI环境中设置环境变量，Karate能直接读取这些值。

修改user-login.feature： #

Feature: User Login with External Credentials

  Background:
    * def clientId = karate.env('CLIENT_ID')
    * def clientSecret = karate.env('CLIENT_SECRET')
    * url 'https://your-api-gateway-endpoint/auth'

  Scenario: Successful login with valid credentials
    Given request { client_id: '#(clientId)', client_secret: '#(clientSecret)' }
    When method post
    Then status 200
    And match response contains { access_token: '#string' }

运行测试： #

• Linux/macOS终端：

  export CLIENT_ID=your-actual-client-id && export CLIENT_SECRET=your-actual-secret && mvn test
  

• Windows终端：

  set CLIENT_ID=your-actual-client-id && set CLIENT_SECRET=your-actual-secret && mvn test
  

方法2：通过命令行参数传入 #

如果不想设置环境变量，也可以在运行测试时直接通过命令行传递参数，Karate可以读取这些系统属性。

修改user-login.feature： #

Feature: User Login with External Credentials

  Background:
    * def clientId = karate.properties['client.id']
    * def clientSecret = karate.properties['client.secret']
    * url 'https://your-api-gateway-endpoint/auth'

  Scenario: Successful login with valid credentials
    Given request { client_id: '#(clientId)', client_secret: '#(clientSecret)' }
    When method post
    Then status 200
    And match response contains { access_token: '#string' }

运行测试： #

• Maven：

  mvn test -Dclient.id=your-actual-client-id -Dclient.secret=your-actual-secret
  

• Gradle：

  gradle test -Pclient.id=your-actual-client-id -Pclient.secret=your-actual-secret
  

方法3：使用外部配置文件（需排除在Git之外） #

你可以创建一个本地配置文件存储凭证，然后把这个文件加入.gitignore，避免提交到GitHub。

步骤1：创建local-config.properties文件 #

CLIENT_ID=your-actual-client-id
CLIENT_SECRET=your-actual-secret

把这个文件添加到.gitignore中，确保不会被提交：

local-config.properties

步骤2：修改karate-config.js（Karate默认配置文件） #

function fn() {
  var config = {
    baseUrl: 'https://your-api-gateway-endpoint/auth'
  };
  // 读取本地配置文件
  var props = java.util.Properties();
  try {
    props.load(new java.io.FileInputStream('local-config.properties'));
    config.clientId = props.getProperty('CLIENT_ID');
    config.clientSecret = props.getProperty('CLIENT_SECRET');
  } catch(e) {
    // 如果本地配置文件不存在， fallback 到环境变量
    config.clientId = karate.env('CLIENT_ID');
    config.clientSecret = karate.env('CLIENT_SECRET');
  }
  return config;
}

步骤3：简化user-login.feature #

Feature: User Login with External Credentials

  Background:
    * url baseUrl

  Scenario: Successful login with valid credentials
    Given request { client_id: '#(clientId)', client_secret: '#(clientSecret)' }
    When method post
    Then status 200
    And match response contains { access_token: '#string' }

额外提示：CI环境适配 #

如果在GitHub Actions这类CI环境中运行测试，你可以把凭证存在GitHub Secrets里，然后在Workflow中设置为环境变量或命令行参数，完全不用担心泄露问题。

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