You need to enable JavaScript to run this app. AbstractTestNGCucumberTests为Cucumber报告附加截图及解决Scenario为null问题
优惠活动
大模型
产品
解决方案
定价
更多

AbstractTestNGCucumberTests为Cucumber报告附加截图及解决Scenario为null问题

Cucumber结合TestNG时实现HTML报告附加步骤截图的落地方案

为什么之前获取的Scenario为null

  • 类包名版本不匹配:Cucumber 5.x及以后版本,官方已经废弃io.cucumber.core.api.Scenario类,替换为io.cucumber.java.Scenario,如果混用新旧版本的类,@Before注解的参数注入逻辑会直接失败,最终拿到的对象就是null。
  • 依赖版本冲突:项目里同时引入了多版本的cucumber-core、cucumber-testng依赖,类加载器隔离会导致注入逻辑找不到上下文,参数完全无法装配。
  • 时序逻辑错误:把通过@Before方法拿到的Scenario赋值给静态/类成员变量时,Cucumber上下文还没完成初始化,后续取变量的时候自然就是null。

正确获取有效Scenario对象的步骤

  • 第一步对齐依赖与类引用
    先检查项目的Cucumber版本:
    • 如果是Cucumber 5.x及以上版本:彻底移除所有对io.cucumber.core.api.Scenario的引用,统一改用io.cucumber.java.Scenario类,这个类是Cucumber官方提供的、可以通过Hook方法参数直接注入的对象,自带embed()方法支持把截图嵌入到最终生成的HTML报告中。
    • 如果是Cucumber 4.x及更早版本:确保cucumber-java、cucumber-testng、cucumber-core三个依赖的版本完全一致,没有跨版本混引。
  • 第二步编写合规的Hook类
    单独编写一个Cucumber Hook类,确保这个类在Cucumber配置的glue扫描路径下,不要把Hook逻辑写在TestNG的测试基类里——很多人注入失败就是因为TestNG基类不在Cucumber的扫描路径下,导致Hook方法根本没被Cucumber识别。
    参考代码:
    import io.cucumber.java.Before;
    import io.cucumber.java.Scenario;
    
    // 该类需放在Cucumber glue指定的扫描包路径下
    public class ScenarioHook {
        @Before
        public void bindCurrentScenario(Scenario scenario) {
            // 用ThreadLocal存储当前运行的Scenario,供后续步骤调用截图方法时取到
            ScenarioContext.setCurrent(scenario);
        }
    }
    
  • 第三步改造现有截图方法
    把原来截图方法里的旧版Scenario类替换为匹配版本的类,embed方法的调用逻辑完全不需要修改,因为新旧版本的embed(byte[] screenshot, String mediaType)方法入参和功能完全一致:
    public static void takeScreenshot(io.cucumber.java.Scenario scenario,
                                      WebDriver driver, File screenShotFile) {
        final byte[] screenshot = ((TakesScreenshot) driver).getScreenshot(OutputType.BYTES);
        // 嵌入截图到当前运行场景,HTML报告会自动展示在对应当前步骤下
        scenario.embed(screenshot, "image/png");
        try (OutputStream os = new FileOutputStream(screenShotFile)) {
            os.write(screenshot);
            Log.debug("Successfully save screenshot");
        } catch (Exception ex) {
            Log.error("Exception : " + ex);
        }
    }
    

简化实现的优化方向

  • 不需要在每个测试步骤里手动调用截图方法,可以搭配@After钩子实现“场景执行失败自动截图嵌入报告”的逻辑,减少重复代码:
    import io.cucumber.java.After;
    import io.cucumber.java.Scenario;
    import org.openqa.selenium.OutputType;
    import org.openqa.selenium.TakesScreenshot;
    
    public class ScenarioHook {
        @After
        public void captureFailureScreenshot(Scenario scenario) {
            // 仅在场景执行失败时触发截图
            if (scenario.isFailed()) {
                WebDriver driver = DriverManager.getCurrentDriver(); // 替换为你项目中获取当前线程Driver的方法
                final byte[] screenshot = ((TakesScreenshot) driver).getScreenshot(OutputType.BYTES);
                scenario.embed(screenshot, "image/png");
            }
        }
    }
    
  • 因为项目是继承AbstractTestNGCucumberTests作为测试基类,这个类本身已经完成了Cucumber和TestNG的执行桥接,只要Hook类在正确的扫描路径下,Scenario的注入完全由Cucumber上下文完成,不受TestNG的执行时序影响。

内容的提问来源于stack exchange,提问作者The Sun

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.11.16 01:06:11