Spring Boot+Java环境下，如何在运行Karate测试前执行testdata.sql脚本？

方案1：Spring Test @Sql注解（最简直接） #

如果仅针对特定测试类或方法执行脚本，Spring Test原生的@Sql注解是最省心的选择，无需额外编码。

实现步骤： #

在Karate测试类上添加@Sql注解，指定脚本路径和执行时机：

import org.springframework.test.context.junit.jupiter.SpringJUnitConfig;
import org.springframework.test.context.jdbc.Sql;
import com.intuit.karate.junit5.Karate;

@SpringJUnitConfig
@Sql(scripts = "classpath:testdata.sql", executionPhase = Sql.ExecutionPhase.BEFORE_TEST_METHOD)
public class KarateIntegrationTest {
    @Karate.Test
    Karate testAll() {
        return Karate.run("classpath:features").relativeTo(getClass());
    }
}

• 注意：确保testdata.sql放在src/test/resources目录下，Spring会自动识别加载。
• 优势：零自定义代码，依托Spring原生能力，适配简单测试场景。

方案2：自定义Spring TestExecutionListener（全局控制） #

如果需要让所有Karate测试统一执行脚本，或者要做更复杂的前置/后置逻辑处理，自定义监听器的灵活性更强。

实现步骤： #

1. 编写自定义监听器类，实现TestExecutionListener，重写beforeTestMethod方法执行SQL脚本：

import org.springframework.test.context.TestContext;
import org.springframework.test.context.support.AbstractTestExecutionListener;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.core.io.ClassPathResource;
import org.springframework.jdbc.datasource.init.ScriptUtils;
import javax.sql.DataSource;

public class SqlScriptExecutionListener extends AbstractTestExecutionListener {
    @Override
    public void beforeTestMethod(TestContext testContext) throws Exception {
        DataSource dataSource = testContext.getApplicationContext().getBean(DataSource.class);
        ScriptUtils.executeSqlScript(dataSource.getConnection(), new ClassPathResource("testdata.sql"));
    }
}

2. 在测试类上注册该监听器：

import org.springframework.test.context.junit.jupiter.SpringJUnitConfig;
import org.springframework.test.context.TestExecutionListeners;
import com.intuit.karate.junit5.Karate;

@SpringJUnitConfig
@TestExecutionListeners(listeners = SqlScriptExecutionListener.class, mergeMode = TestExecutionListeners.MergeMode.MERGE_WITH_DEFAULTS)
public class KarateIntegrationTest {
    @Karate.Test
    Karate testAll() {
        return Karate.run("classpath:features").relativeTo(getClass());
    }
}

• 优势：全局生效，可扩展（例如添加执行日志、异常捕获逻辑），适配批量测试场景。

方案3：Karate原生Before钩子（测试流程内执行） #

如果希望脚本执行和Karate测试流程深度绑定，比如在每个Feature/Scenario执行前运行脚本，可使用Karate的Before钩子。

实现步骤： #

1. 编写Java工具类，封装SQL脚本执行逻辑：

import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.core.io.ClassPathResource;
import org.springframework.jdbc.datasource.init.ScriptUtils;
import javax.sql.DataSource;
import org.springframework.context.ApplicationContext;
import com.intuit.karate.core.ScenarioRuntime;

public class TestDataLoader {
    public static void loadTestData(ScenarioRuntime sr) {
        ApplicationContext ctx = (ApplicationContext) sr.getEnv().get("springContext");
        DataSource dataSource = ctx.getBean(DataSource.class);
        try {
            ScriptUtils.executeSqlScript(dataSource.getConnection(), new ClassPathResource("testdata.sql"));
        } catch (Exception e) {
            throw new RuntimeException("执行测试数据脚本失败", e);
        }
    }
}

2. 在Karate Feature文件中配置Before钩子：

Feature: 用户接口测试

Background:
* configure beforeCall = () => com.example.TestDataLoader.loadTestData(__runtime)

Scenario: 查询用户列表
Given url '/api/users'
When method get
Then status 200

也可在Java测试启动类中全局配置：

import com.intuit.karate.junit5.Karate;

public class KarateTestRunner {
    @Karate.Test
    Karate testAll() {
        return Karate.run("classpath:features")
                .configure("beforeCall", () -> com.example.TestDataLoader.loadTestData(__runtime))
                .relativeTo(getClass());
    }
}

• 优势：完全融入Karate测试生命周期，适配需要与测试步骤联动的场景。

方案选择建议 #

• 简单场景（单类/单方法测试）：优先使用@Sql注解，快速落地。
• 全局批量测试：使用自定义TestExecutionListener，统一管理测试前置逻辑。
• 测试流程联动需求：使用Karate Before钩子，与测试场景深度绑定。

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