如何在Java程序中编程式调用Karate场景并获取结果

本文探讨了如何在Java应用程序中编程式地执行Karate测试场景。虽然Karate主要设计为独立的API测试框架，但在特定集成场景下，可以通过`Runner.runFeature()` API直接从Java调用Feature文件。文章将详细介绍这种方法，包括如何配置调用、访问场景中生成的变量，并提供示例代码和注意事项，帮助开发者实现Karate与Java代码的有效集成，从而实现数据生成或预置条件设置等目的。

引言：Karate与Java集成的需求

Karate是一个功能强大的API测试自动化框架，以其简洁的Gherkin语法和内置的HTTP客户端而闻名。通常，Karate场景通过JUnit测试运行器执行，生成详细的测试报告。然而，在某些特定的集成场景中，开发者可能需要在Java应用程序中直接调用Karate场景，例如：

1. 数据生成： 利用Karate的API调用能力生成测试数据或业务数据，然后将这些数据传递给Java代码进行进一步处理或验证。
2. 预置条件设置： 在执行某个Java业务逻辑之前，使用Karate场景调用API来设置系统状态或创建必要的资源。
3. 微服务集成测试： 在一个Java驱动的集成测试框架中，需要编程式地触发某些Karate定义的API交互。

在这种情况下，传统的JUnit运行方式可能不够灵活，需要一种更直接的Java API来与Karate进行交互。

理解Karate的设计哲学与挑战

在深入解决方案之前，需要明确Karate的设计初衷。Karate主要被设计为一个端到端的API测试框架，其JUnit集成是为了提供标准的测试执行、报告和生命周期管理。直接通过Java代码实例化Karate的JUnit运行器（如new RandomUserRunner().testRandomUserRunner()）并期望它能像普通Java方法一样被调用，通常是不可行的。这是因为JUnit运行器依赖于JUnit框架的上下文来初始化测试环境、管理生命周期钩子、收集测试结果和生成报告。脱离JUnit上下文直接调用这些方法，会导致其内部机制无法正常工作。

立即学习“Java免费学习笔记（深入）”；

因此，Karate提供了一种专门的Java API来解决这种编程式调用的需求，即Runner.runFeature()。

解决方案：使用Runner.runFeature() API

Runner.runFeature() API是Karate官方推荐的、在Java程序中编程式执行单个Karate Feature文件并获取其结果的方式。它允许开发者像调用一个Java方法一样执行一个Karate Feature，并能够访问该Feature中定义的变量。

MaxAI

MaxAI.me是一款功能强大的浏览器AI插件，集成了多种AI模型。

下载

1. 基本用法

Runner.runFeature()方法有多种重载形式，最常用的是接受Feature文件路径和可选变量映射的：

public static Map runFeature(String featurePath, Map vars)

• featurePath: Karata Feature文件的路径。通常建议使用classpath:前缀来指定位于类路径下的文件（如classpath:myfeature.feature），也可以是文件系统的绝对路径或相对路径。
• vars: 一个Map，用于将Java变量传递给Karate Feature。这些变量在Feature中可以直接访问。
• 返回值：一个Map，包含了Karate Feature执行完成后所有在Feature中定义的变量。这是从Karate获取数据回Java的关键。

2. 示例代码

假设我们有一个Karate Feature文件，用于获取随机用户数据并将其定义为一个变量：

src/test/resources/randomuser.feature

Feature: Random Users Data Generation

  Background:
    # 使用一个公共的API作为示例
    * url 'https://reqres.in' 

  Scenario: Get and Store Random User Data
    Given path 'api/users/2' # 示例：获取一个特定用户
    When method get
    Then status 200
    * def userData = response # 将API响应定义为'userData'变量
    * print 'Karate Scenario executed. userData: ', userData

现在，我们可以在Java程序中调用这个Feature并获取userData变量：

src/main/java/com/example/KarateDataGenerator.java

package com.example;

import com.intuit.karate.Runner;
import java.util.Collections;
import java.util.Map;

public class KarateDataGenerator {

    public static void main(String[] args) {
        // 可选：设置Karate环境，这会影响karate-config.js的加载
        System.setProperty("karate.env", "dev"); 

        // 定义Karate Feature文件的路径。
        // 推荐使用"classpath:"前缀，如果Feature文件位于Maven/Gradle项目的resources目录下。
        String featurePath = "classpath:randomuser.feature";

        // 如果需要，可以从Java向Karate Feature传递变量。
        // 在此示例中，我们不需要传递任何变量。
        Map inputVariables = Collections.emptyMap();

        System.out.println("Starting Karate feature execution from Java...");

        try {
            // 执行Karate Feature。
            // 返回的Map包含了Feature中定义的所有变量。
            Map featureResult = Runner.runFeature(featurePath, inputVariables);

            System.out.println("Karate feature execution finished.");

            // 检查执行是否成功，并检索我们定义的'userData'变量。
            if (featureResult != null && featureResult.containsKey("userData")) {
                // 检索在Karate场景中定义的'userData'变量。
                // 由于API响应通常是JSON，我们将其转换为字符串。
                String userDataJson = featureResult.get("userData").toString(); 

                System.out.println("\nSuccessfully retrieved 'userData' from Karate:");
                System.out.println(userDataJson);

                // 现在，您可以在Java程序中使用'userDataJson'。
                // 例如，使用Jackson或Gson库解析它，保存到数据库，或进行其他业务处理。
                // 示例：简单打印其中的某个字段（需要JSON解析库，此处仅作示意）
                // ObjectMapper mapper = new ObjectMapper();
                // JsonNode rootNode = mapper.readTree(userDataJson);
                // String email = rootNode.path("data").path("email").asText();
                // System.out.println("User Email: " + email);

            } else {
                System.err.println("Failed to retrieve 'userData' variable or feature execution encountered an issue.");
                // 对于更详细的错误信息，可能需要检查Karate的日志输出。
            }
        } catch (Exception e) {
            System.err.println("An error occurred during Karate feature execution: " + e.getMessage());
            e.printStackTrace();
        }
    }
}

3. 参数详解与注意事项

• featurePath:
  • classpath:前缀：推荐用于Maven/Gradle项目，Feature文件应放在src/test/resources或src/main/resources等类路径下。
  • 绝对路径/相对路径：可以直接指定文件系统中的路径。
• vars: 传递给Karate Feature的变量会在其执行期间作为全局变量可用。这对于参数化Feature非常有用。
• karate-config.js: 当使用Runner.runFeature()时，如果Feature文件依赖于karate-config.js来定义基础URL、通用函数或环境变量，那么该配置文件也会被加载和执行。可以通过System.setProperty("karate.env", "your_env")来控制加载哪个环境配置。
• 返回结果: Runner.runFeature()返回的Map是Karate Feature执行结束时所有已定义变量的快照。这意味着你可以在Feature中定义任意变量（如def myVar = 'value'），然后通过featureResult.get("myVar")在Java中获取。
• 错误处理: 如果Feature执行失败，runFeature方法可能不会直接抛出异常，而是返回一个不包含预期变量的Map。为了进行更全面的错误检查和报告，如果目标是测试报告，仍然建议使用JUnit集成（Runner.path().parallel()）并检查Results对象。但对于数据生成等场景，检查返回Map中是否存在预期数据通常足够。

注意事项与最佳实践

1. 适用场景明确：Runner.runFeature()主要适用于需要从Java代码中触发Karate Feature来完成特定任务（如数据生成、状态设置）的场景。它不应替代Karate的JUnit测试运行器进行常规的测试套件执行和报告生成。
2. 避免滥用：如果你的目标仅仅是复用Karate的步骤，而不是从Java中调用，那么Karate内部的call机制（* call read('another.feature')）是更推荐的方式，因为它保持了Karate的纯粹性，并且更易于维护。
3. 依赖管理：确保你的Java项目已正确引入Karate的依赖。通常只需要karate-core或karate-apache（如果使用Apache HTTP客户端）。

   
       com.intuit.karate
       karate-core
       ${karate.version}
   
   
   
       com.intuit.karate
       karate-apache
       ${karate.version}
   

4. 日志配置：为了更好地调试，确保你的Java项目有合适的日志配置（如Logback或Log4j），以便Karate的内部日志能够输出。

总结

通过Runner.runFeature() API，Karate提供了一种强大而灵活的方式，允许Java应用程序编程式地调用和集成Karate Feature。这种方法特别适用于需要利用Karate的API交互能力来生成数据、设置预置条件或执行特定业务逻辑的场景。开发者应根据具体需求选择合适的集成方式，并遵循最佳实践，以确保代码的可维护性和健壮性。