如何为不同线程定制Cucumber TestNG？并行执行ThreadLocal失效问题

问题背景 #

项目已完成Cucumber特性文件、步骤类及TestRunner的创建，尝试通过TestNG XML配置并行执行，但出现线程变量失效的问题。

项目结构 #

src/
└── test/
    └── java/
        └── com/
            └── projectname/
                └── tests/
                    ├── TestRunner.java
                    ├── suites/
                    │   ├── first/
                    │   │   └── FirstSteps.java
                    │   └── second/
                    │       └── SecondSteps.java
                    └── resources/
                        └── suites/
                            └── smoke.xml

TestNG并行配置（smoke.xml） #

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE suite SYSTEM "http://testng.org/testng-1.0.dtd">
<suite name="Test Debug" parallel="tests">
    <test name="Test 1">
        <parameter name="browser" value="firefox"/>
        <parameter name="cucumber.features" value="classpath:features/first"/>
        <classes>
            <class name="com.projectname.tests.TestRunner"/>
        </classes>
    </test>
    <test name="Test 2">
        <parameter name="browser" value="chrome"/>
        <parameter name="cucumber.features" value="classpath:features/second"/>
        <classes>
            <class name="com.projectname.tests.TestRunner"/>
        </classes>
    </test>
</suite>

原TestRunner实现 #

public class TestRunner extends AbstractTestNGCucumberTests {

    private static volatile ThreadLocal<String> threadLocal;
    private static String debug;

    @Override
    @DataProvider(parallel = true)
    public Object[][] scenarios() {
        return super.scenarios();
    }

    @BeforeClass
    @Parameters("browser")
    public void init(@Optional("chrome") String browser) {
        System.out.println("BrowserName: " + browser);
        printThread(browser);
        if (threadLocal == null) {
            synchronized (TestRunner.class) {
                if (threadLocal == null) {
                    threadLocal = new ThreadLocal<>();
                }
            }
        }
        threadLocal.set(browser); // 修正原代码笔误threadPool
        debug = browser;
    }

    public static String getBrowserName(){
        return threadLocal.get();
    }

    public static String getDebugString(){
        return debug;
    }
}

出现的问题 #

1. 步骤类中调用getBrowserName()返回null；
2. 调用getDebugString()时，两个步骤类均获取到最后一次赋值的debug值，static变量被覆盖；
3. 控制台输出显示：TestNG初始化线程（TestNG-tests-xx）与Cucumber场景执行线程（TestNG-PoolService-xx）为不同线程组。

原因分析 #

1. ThreadLocal失效原因：@BeforeClass注解的方法在TestNG的测试初始化线程（TestNG-tests-xx）中执行，而Cucumber的场景逻辑是在TestNG的PoolService线程（TestNG-PoolService-xx）中运行的。ThreadLocal是线程隔离的，不同线程无法读取彼此的ThreadLocal值，因此场景线程拿不到初始化线程设置的值。
2. static变量被覆盖：debug是全局静态变量，多个线程并发赋值时会互相覆盖，最终保留的是最后一次赋值的结果。

解决方案 #

核心思路：确保线程隔离的变量在场景执行的线程中被设置，而非TestNG初始化线程。以下提供两种可行方案：

方案一：使用Cucumber依赖注入（PicoContainer）管理线程安全上下文 #

1. 添加PicoContainer依赖（Maven）

<dependency>
    <groupId>io.cucumber</groupId>
    <artifactId>cucumber-picocontainer</artifactId>
    <version>对应你的Cucumber版本</version>
    <scope>test</scope>
</dependency>

2. 创建线程安全的测试上下文类

public class TestContext {
    private ThreadLocal<String> browser = new ThreadLocal<>();
    private ThreadLocal<WebDriver> driver = new ThreadLocal<>();

    public void setBrowser(String browserName) {
        browser.set(browserName);
    }

    public String getBrowser() {
        return browser.get();
    }

    public WebDriver getDriver() {
        if (driver.get() == null) {
            String browserName = browser.get();
            // 根据浏览器类型初始化WebDriver
            switch (browserName) {
                case "chrome":
                    driver.set(new ChromeDriver());
                    break;
                case "firefox":
                    driver.set(new FirefoxDriver());
                    break;
                default:
                    driver.set(new ChromeDriver());
            }
        }
        return driver.get();
    }

    public void cleanUp() {
        if (driver.get() != null) {
            driver.get().quit();
            driver.remove();
        }
        browser.remove();
    }
}

3. 修改TestRunner传递参数并管理上下文

public class TestRunner extends AbstractTestNGCucumberTests {
    private static ThreadLocal<TestContext> testContextThreadLocal = new ThreadLocal<>();

    @BeforeClass
    @Parameters("browser")
    public void initContext(@Optional("chrome") String browser) {
        TestContext context = new TestContext();
        context.setBrowser(browser);
        testContextThreadLocal.set(context);
    }

    @Override
    @DataProvider(parallel = true)
    public Object[][] scenarios() {
        return super.scenarios();
    }

    public static TestContext getTestContext() {
        return testContextThreadLocal.get();
    }

    @AfterClass
    public void tearDown() {
        TestContext context = testContextThreadLocal.get();
        if (context != null) {
            context.cleanUp();
            testContextThreadLocal.remove();
        }
    }
}

4. 步骤类中注入上下文

public class FirstSteps {
    private TestContext testContext;

    // PicoContainer会自动注入TestContext实例
    public FirstSteps(TestContext testContext) {
        this.testContext = testContext;
    }

    @Given("第一步")
    public void firstStep() {
        String browser = testContext.getBrowser();
        WebDriver driver = testContext.getDriver();
        System.out.println("FirstSteps 当前使用浏览器：" + browser);
        // 执行测试操作
    }
}

方案二：使用TestNG监听器在场景线程中注入参数 #

1. 创建TestNG监听器类

public class CucumberThreadListener implements IInvokedMethodListener {
    @Override
    public void beforeInvocation(IInvokedMethod method, ITestResult testResult) {
        if (method.isTestMethod()) {
            // 从TestNG上下文获取browser参数
            String browser = testResult.getTestContext().getCurrentXmlTest().getParameter("browser");
            // 设置线程隔离变量
            ThreadLocalStorage.setBrowser(browser);
        }
    }

    @Override
    public void afterInvocation(IInvokedMethod method, ITestResult testResult) {
        if (method.isTestMethod()) {
            // 清理线程变量
            ThreadLocalStorage.removeBrowser();
        }
    }
}

2. 创建全局ThreadLocal管理类

public class ThreadLocalStorage {
    private static ThreadLocal<String> browser = new ThreadLocal<>();

    public static void setBrowser(String browserName) {
        browser.set(browserName);
    }

    public static String getBrowser() {
        return browser.get();
    }

    public static void removeBrowser() {
        browser.remove();
    }
}

3. 在TestRunner中注册监听器

@Listeners(CucumberThreadListener.class)
public class TestRunner extends AbstractTestNGCucumberTests {
    @Override
    @DataProvider(parallel = true)
    public Object[][] scenarios() {
        return super.scenarios();
    }
}

4. 步骤类中获取参数

public class SecondSteps {
    @Given("第二个场景第一步")
    public void firstFunction() {
        String browser = ThreadLocalStorage.getBrowser();
        System.out.println("SecondSteps 当前使用浏览器：" + browser);
        // 初始化WebDriver并执行操作
    }
}

总结 #

• 问题本质是TestNG初始化线程与Cucumber场景执行线程不属于同一线程组，导致初始化阶段设置的ThreadLocal无法被场景线程读取；
• 解决关键是将线程隔离变量的设置时机移到场景执行的线程中，依赖注入或TestNG监听器都是可靠的实现方式。

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