如何基于Gherkin场景名设置BrowserStack测试名？解决名称回退问题

基于Selenide、Cucumber和TestNG的项目已集成BrowserStack，但所有测试在BrowserStack平台显示的名称均为默认的runners.TestRunner-runScenario，无法与Gherkin中的场景名（如Correct login、Incorrect login）对应。尝试通过@After钩子调用BrowserStack的setSessionName接口修改名称，仅能在测试结束时短暂生效，之后会恢复为默认值。

提供的TestRunner代码：

@Test
@CucumberOptions(
        features = "src/test/resources/features",
        glue = {"stepDefinitions"},
        plugin = {"pretty", "html:target/cucumber-report.html", "io.qameta.allure.cucumber7jvm.AllureCucumber7Jvm"}
)
public class TestRunner extends AbstractTestNGCucumberTests {
    static {
        System.setProperty("IS_CUCUMBER_TEST", "true");
    }
}

已尝试的代码：

@After
public void tearDown(Scenario scenario) {
    String scenarioName = scenario.getName();
    setBrowserStackTestName(scenarioName);
    Selenide.closeWindow();
}

private void setBrowserStackTestName(String testName) {
    JavascriptExecutor jsExecutor = (JavascriptExecutor) WebDriverRunner.getWebDriver();
    jsExecutor.executeScript("browserstack_executor: {\"action\": \"setSessionName\", \"arguments\": {\"name\":\"" + testName + "\"}}");
}

核心问题是在测试结束时设置会话名称，会被BrowserStack或TestNG的后续默认逻辑覆盖，因此需要在场景启动时就完成名称设置，确保会话全程使用自定义名称。

1. 迁移设置逻辑到@Before钩子 #

将设置BrowserStack会话名称的代码从@After移到@Before，在场景初始化完成后立即执行，避免后续逻辑覆盖：

import io.cucumber.java.Before;
import org.openqa.selenium.JavascriptExecutor;
import com.codeborne.selenide.WebDriverRunner;
import io.cucumber.java.Scenario;

public class BrowserStackSessionHook {

    @Before
    public void initSessionName(Scenario scenario) {
        // 获取Gherkin场景名称
        String scenarioName = scenario.getName();
        // 调用BrowserStack接口设置会话名称
        setBrowserStackSessionName(scenarioName);
    }

    private void setBrowserStackSessionName(String sessionName) {
        // 转义场景名中的特殊字符，避免JS执行报错
        String escapedName = sessionName.replace("\"", "\\\"");
        JavascriptExecutor jsExecutor = (JavascriptExecutor) WebDriverRunner.getWebDriver();
        jsExecutor.executeScript("browserstack_executor: {\"action\": \"setSessionName\", \"arguments\": {\"name\":\"" + escapedName + "\"}}");
    }
}

2. 验证WebDriver初始化时机 #

确保setBrowserStackSessionName方法在WebDriver完全初始化后调用，避免空指针异常。如果项目中存在自定义的WebDriver初始化逻辑，需要保证@Before钩子在WebDriver启动后执行。

3. 结合TestNG监听器强化名称控制（可选） #

如果TestNG的默认命名逻辑仍存在干扰，可以添加TestNG监听器，在测试启动时再次确认会话名称：

import org.testng.ITestListener;
import org.testng.ITestResult;
import com.codeborne.selenide.WebDriverRunner;
import org.openqa.selenium.JavascriptExecutor;

public class BrowserStackTestListener implements ITestListener {

    @Override
    public void onTestStart(ITestResult result) {
        // 从Cucumber上下文或TestNG方法名中获取测试名称
        String testName = result.getMethod().getMethodName();
        if (WebDriverRunner.hasWebDriverStarted()) {
            setBrowserStackSessionName(testName);
        }
    }

    private void setBrowserStackSessionName(String sessionName) {
        String escapedName = sessionName.replace("\"", "\\\"");
        JavascriptExecutor jsExecutor = (JavascriptExecutor) WebDriverRunner.getWebDriver();
        jsExecutor.executeScript("browserstack_executor: {\"action\": \"setSessionName\", \"arguments\": {\"name\":\"" + escapedName + "\"}}");
    }
}

然后在TestRunner上添加监听器注解：

import org.testng.annotations.Listeners;
import io.cucumber.testng.AbstractTestNGCucumberTests;
import io.cucumber.testng.CucumberOptions;

@Listeners(BrowserStackTestListener.class)
@Test
@CucumberOptions(
        features = "src/test/resources/features",
        glue = {"stepDefinitions"},
        plugin = {"pretty", "html:target/cucumber-report.html", "io.qameta.allure.cucumber7jvm.AllureCucumber7Jvm"}
)
public class TestRunner extends AbstractTestNGCucumberTests {
    static {
        System.setProperty("IS_CUCUMBER_TEST", "true");
    }
}

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