Karate框架@env/@envnot标签未读取karate-config.js中env值的问题

核心原因 #

Karate框架的场景标签筛选逻辑（@env/@envnot）是在karate-config.js脚本执行之前运行的。也就是说，当框架判断哪些场景该执行时，你在karate-config.js里设置的默认env值还没有被加载，此时karate.env只能读取到系统属性（即命令行通过-Dkarate.env传入的值），如果没有传系统属性，就会是null。

这是框架设计的固定执行顺序：先完成场景的筛选，再执行配置脚本初始化环境变量，所以配置脚本里的默认值无法影响标签的筛选逻辑。

解决办法 #

1. 在测试运行器中提前设置系统属性 #

如果用Java测试运行器，可以在启动时主动设置系统属性，让标签筛选阶段就能获取到env值：

import com.intuit.karate.junit5.Karate;
import org.junit.jupiter.api.BeforeAll;

class TestRunner {

    @BeforeAll
    static void setup() {
        // 提前设置默认env为dev
        System.setProperty("karate.env", "dev");
    }

    @Karate.Test
    Karate testAll() {
        return Karate.run().relativeTo(getClass());
    }
}

2. 通过构建工具配置默认系统属性 #

如果用Maven，可以在pom.xml的maven-surefire-plugin中配置默认的karate.env，这样运行测试时不用每次手动传命令行参数：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-surefire-plugin</artifactId>
            <version>3.2.5</version>
            <configuration>
                <systemPropertyVariables>
                    <karate.env>dev</karate.env>
                </systemPropertyVariables>
            </configuration>
        </plugin>
    </plugins>
</build>

3. 改用场景内条件判断替代@env标签 #

如果不想依赖系统属性，可以在feature文件中通过条件判断跳过不符合环境的场景，这样就能直接使用karate-config.js里设置的默认env值：

Feature: 示例功能

  Background:
    * def env = karate.env

  Scenario: 仅在dev环境运行的场景
    * if (env != 'dev') karate.skip('当前环境非dev，跳过场景')
    # 场景测试步骤...

  Scenario: 排除prod环境的场景
    * if (env == 'prod') karate.skip('当前环境为prod，跳过场景')
    # 场景测试步骤...

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