Karate运行时能否使用未公开Hook？配置afterStep遇错误求助

问题说明 #

尝试通过karate.configure配置afterStep Hook时触发错误，配置代码：

* karate.configure('afterStep', function(){ karate.call('classpath:adapters/splunklink-updated.feature'); })

报错信息：

js failed:
>>>>>>
01: karate.configure('afterStep', function(){ karate.call('classpath:adapters/splunklink-updated.feature'); })
<<<<<<
org.graalvm.polyglot.PolyglotException: unexpected 'configure' key: 'afterStep'
- com.intuit.karate.core.Config.configure(Config.java:334)
- com.intuit.karate.core.ScenarioEngine.configure(ScenarioEngine.java:348)
- com.intuit.karate.core.ScenarioBridge.configure(ScenarioBridge.java:300)
- <js>.:program(Unnamed:1)

同时需要使用以下Hook方法：

default void beforeSuite(Suite suite) {}
default void afterSuite(Suite suite) {}
default boolean beforeStep(Step step, ScenarioRuntime sr) { return true; }
default void afterStep(StepResult result, ScenarioRuntime sr) {}
default void beforeHttpCall(HttpRequest request, ScenarioRuntime sr) {}
default void afterHttpCall(HttpRequest request, Response response, ScenarioRuntime sr) {}

解决方案 #

这些方法属于Karate底层的com.intuit.karate.core.Hook接口，不能通过karate.configure配置，必须通过自定义Java类实现该接口来使用：

1. 实现自定义Hook类 #

创建Java类实现Hook接口，重写需要的方法：

package com.your.project;

import com.intuit.karate.core.*;

public class CustomTestHook implements Hook {

    @Override
    public void beforeSuite(Suite suite) {
        // 编写suite执行前的逻辑
    }

    @Override
    public void afterSuite(Suite suite) {
        // 编写suite执行后的逻辑
    }

    @Override
    public boolean beforeStep(Step step, ScenarioRuntime sr) {
        // 编写步骤执行前的逻辑，返回true允许步骤继续执行
        return true;
    }

    @Override
    public void afterStep(StepResult result, ScenarioRuntime sr) {
        // 调用指定feature文件，替代原JS配置中的逻辑
        sr.getEngine().call("classpath:adapters/splunklink-updated.feature");
    }

    @Override
    public void beforeHttpCall(HttpRequest request, ScenarioRuntime sr) {
        // 编写HTTP请求发送前的逻辑
    }

    @Override
    public void afterHttpCall(HttpRequest request, Response response, ScenarioRuntime sr) {
        // 编写HTTP请求完成后的逻辑
    }
}

2. 加载自定义Hook #

有三种方式可以让Karate加载这个Hook：

• 方式一：通过karate-config.js配置
  在项目根目录的karate-config.js中添加：

  config.hook = new com.your.project.CustomTestHook();
  

• 方式二：通过系统属性指定
  运行测试时添加JVM参数：

  -Dkarate.hook=com.your.project.CustomTestHook
  

• 方式三：通过测试类注解配置（JUnit 4）
  在测试类上添加@KarateOptions注解：

  import com.intuit.karate.junit4.Karate;
  import org.junit.runner.RunWith;
  
  @RunWith(Karate.class)
  @KarateOptions(hook = com.your.project.CustomTestHook.class)
  public class TestRunner {}
  

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