如何将Jenkins凭据传递至Karate测试框架（Gradle构建）

1. Jenkins 端绑定凭据为环境变量 #

在Jenkins里用凭据绑定插件把你存储的用户凭据（比如用户名+密码类型）暴露成环境变量，两种项目类型的配置方式：

• 自由风格项目：在「构建环境」里勾选「使用凭据绑定」，添加「用户名和密码（分开的）」，分别设置环境变量名，比如TEST_USERNAME和TEST_PASSWORD。
• 流水线项目：用withCredentials块包裹构建命令，示例：

  pipeline {
      agent any
      stages {
          stage('Build & Run Tests') {
              steps {
                  withCredentials([usernamePassword(credentialsId: 'your-credential-id', usernameVariable: 'TEST_USERNAME', passwordVariable: 'TEST_PASSWORD')]) {
                      sh './gradlew test'
                  }
              }
          }
      }
  }
  

  注意把your-credential-id换成你Jenkins凭据里对应的ID。

2. Gradle 传递凭据到 Karate #

Gradle执行测试时，可选择把Jenkins的环境变量转成JVM系统属性传给Karate，或者直接让Karate读环境变量：

方式一：转成JVM系统属性 #

在build.gradle的test任务里添加配置：

test {
    systemProperty 'karate.username', System.getenv('TEST_USERNAME')
    systemProperty 'karate.password', System.getenv('TEST_PASSWORD')
    // 其他测试相关配置按需添加
}

方式二：直接让Karate读环境变量 #

这一步可以跳过，直接让Karate读取Jenkins设置的环境变量即可。

3. Karate 脚本中获取凭据 #

两种读取方式任选：

方式一：读取JVM系统属性 #

Feature: 鉴权接口测试

Background:
    * def username = java.lang.System.getProperty('karate.username')
    * def password = java.lang.System.getProperty('karate.password')
    * configure headers = { Authorization: 'Basic ' + karate.base64(username + ':' + password) }

Scenario: 调用需鉴权的接口
    Given url 'https://your-api-domain.com/target-endpoint'
    When method get
    Then status 200

方式二：直接读取环境变量 #

Karate支持用env关键字读取系统环境变量：

Feature: 鉴权接口测试

Background:
    * def username = env.TEST_USERNAME
    * def password = env.TEST_PASSWORD
    * configure headers = { Authorization: 'Basic ' + karate.base64(username + ':' + password) }

Scenario: 调用需鉴权的接口
    Given url 'https://your-api-domain.com/target-endpoint'
    When method get
    Then status 200

额外提示 #

• 可以把凭据读取逻辑统一放到karate-config.js里，所有测试用例共用：

  function fn() {
      var config = {
          username: java.lang.System.getProperty('karate.username') || env.TEST_USERNAME,
          password: java.lang.System.getProperty('karate.password') || env.TEST_PASSWORD
      };
      return config;
  }
  

• Jenkins会自动屏蔽敏感凭据的输出，不用担心构建日志泄露密码。
• 确保Jenkins节点能正常访问Gradle依赖，建议用Gradle Wrapper避免环境不一致问题。

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