在 Junit 5 中，如何从扩展中调用测试类方法？

Posted 2023-02-19

【中文标题】在 Junit 5 中，如何从扩展中调用测试类方法？

【英文标题】：In Junit 5 how can I call a test class method from an extension?

【发布时间】：2021-02-07 21:25:15

【问题描述】：

在 Junit 5 中，我试图让测试类方法从扩展中运行。我正在使用 Junit 5 扩展接口 TestWatcher 并覆盖 testFailed() 方法。

此扩展的目的是在测试类的 Selenium WebDriver 浏览器中截取失败的屏幕截图，并将其附加到该测试的 Allure 报告中。测试类方法具有用于附加到 Allure 的实例化浏览器和注释。我的 takeScreenshot 方法依赖于浏览器和测试类中的 testName 字符串才能正确运行。

package utils;

public class ScreenshotOnFailureExtension implements TestWatcher
    @Override
    public void testFailed(ExtensionContext context, Throwable cause) 
        try 
            Object clazz = context.getRequiredTestInstance();
            Method takeScreenshot = clazz.getClass().getMethod("takeScreenshot");
            takeScreenshot.setAccessible(true);
            Object test = clazz.getClass().getConstructor().newInstance();
            takeScreenshot.invoke(test);
         catch (Exception e) 
            e.printStackTrace();
         

我的测试类中的代码是这样的：

package tests;

@ExtendWith(ScreenshotOnFailureExtension.class)
public class MyTest implements Config 
    public WebDriver driver;
    public String testName;

//bunch of Junit5 annotations with functions to initialize above variables omitted...

    //take a screen shot
    public void takeScreenshot() 
        System.out.println("Taking screenshot.");
        byte[] srcFile=((TakesScreenshot)driver).getScreenshotAs(OutputType.BYTES);
        saveScreenshot(srcFile, testName+ ".png");
    
    
    //this attaches screenshot to an allure test result
    @Attachment(value = "testName", type = "image/png")
    public byte[] saveScreenshot(byte[] screenShot, String testName) 
        System.out.println("Attaching screenshot to Allure report");
        return screenShot;
    

上述测试类在测试方法中从@AfterEach 调用时能够正确截屏。但我只想接受失败。

当我运行测试时，它会调用 takeScreenshot，但在执行时会出现异常：

截屏.java.lang.reflect.InvocationTargetException

在 java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native 方法）在 java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62) 在 java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) 在 java.base/java.lang.reflect.Method.invoke(Method.java:566) 在 utils.ScreenshotOnFailureExtension.testFailed(ScreenshotOnFailureExtension.java:49) 在 org.junit.jupiter.engine.descriptor.TestMethodTestDescriptor.lambda$nodeFinished$14(TestMethodTestDescriptor.java:299) 在 org.junit.jupiter.engine.descriptor.MethodBasedTestDescriptor.lambda$invokeTestWatchers$3(MethodBasedTestDescriptor.java:134) 在 java.base/java.util.ArrayList.forEach(ArrayList.java:1540) 在 org.junit.jupiter.engine.descriptor.MethodBasedTestDescriptor.invokeTestWatchers(MethodBasedTestDescriptor.java:132) 在 org.junit.jupiter.engine.descriptor.TestMethodTestDescriptor.nodeFinished(TestMethodTestDescriptor.java:290) 在 org.junit.jupiter.engine.descriptor.TestMethodTestDescriptor.nodeFinished(TestMethodTestDescriptor.java:65) 在 org.junit.platform.engine.support.hierarchical.NodeTestTask.reportCompletion(NodeTestTask.java:176) 在 org.junit.platform.engine.support.hierarchical.NodeTestTask.execute(NodeTestTask.java:89) 在 java.base/java.util.ArrayList.forEach(ArrayList.java:1540) 在 org.junit.platform.engine.support.hierarchical.SameThreadHierarchicalTestExecutorService.invokeAll(SameThreadHierarchicalTestExecutorService.java:38) 在 org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively$5(NodeTestTask.java:143) 在 org.junit.platform.engine.support.hierarchical.ThrowableCollector.execute(ThrowableCollector.java:73) 在 org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively$7(NodeTestTask.java:129) 在 org.junit.platform.engine.support.hierarchical.Node.around(Node.java:137) 在 org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively$8(NodeTestTask.java:127) 在 org.junit.platform.engine.support.hierarchical.ThrowableCollector.execute(ThrowableCollector.java:73) 在 org.junit.platform.engine.support.hierarchical.NodeTestTask.executeRecursively(NodeTestTask.java:126) 在 org.junit.platform.engine.support.hierarchical.NodeTestTask.execute(NodeTestTask.java:84) 在 java.base/java.util.ArrayList.forEach(ArrayList.java:1540) 在 org.junit.platform.engine.support.hierarchical.SameThreadHierarchicalTestExecutorService.invokeAll(SameThreadHierarchicalTestExecutorService.java:38) 在 org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively$5(NodeTestTask.java:143) 在 org.junit.platform.engine.support.hierarchical.ThrowableCollector.execute(ThrowableCollector.java:73) 在 org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively$7(NodeTestTask.java:129) 在 org.junit.platform.engine.support.hierarchical.Node.around(Node.java:137) 在 org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively$8(NodeTestTask.java:127) 在 org.junit.platform.engine.support.hierarchical.ThrowableCollector.execute(ThrowableCollector.java:73) 在 org.junit.platform.engine.support.hierarchical.NodeTestTask.executeRecursively(NodeTestTask.java:126) 在 org.junit.platform.engine.support.hierarchical.NodeTestTask.execute(NodeTestTask.java:84) 在 org.junit.platform.engine.support.hierarchical.SameThreadHierarchicalTestExecutorService.submit(SameThreadHierarchicalTestExecutorService.java:32) 在 org.junit.platform.engine.support.hierarchical.HierarchicalTestExecutor.execute（HierarchicalTestExecutor.java:57） 在 org.junit.platform.engine.support.hierarchical.HierarchicalTestEngine.execute(HierarchicalTestEngine.java:51) 在 org.junit.platform.launcher.core.EngineExecutionOrchestrator.execute(EngineExecutionOrchestrator.java:108) 在 org.junit.platform.launcher.core.EngineExecutionOrchestrator.execute(EngineExecutionOrchestrator.java:88) 在 org.junit.platform.launcher.core.EngineExecutionOrchestrator.lambda$execute$0(EngineExecutionOrchestrator.java:54) 在 org.junit.platform.launcher.core.EngineExecutionOrchestrator.withInterceptedStreams(EngineExecutionOrchestrator.java:67) 在 org.junit.platform.launcher.core.EngineExecutionOrchestrator.execute(EngineExecutionOrchestrator.java:52) 在 org.junit.platform.launcher.core.DefaultLauncher.execute（DefaultLauncher.java:96） 在 org.junit.platform.launcher.core.DefaultLauncher.execute（DefaultLauncher.java:75） 在 org.eclipse.jdt.internal.junit5.runner.JUnit5TestReference.run(JUnit5TestReference.java:89) 在 org.eclipse.jdt.internal.junit.runner.TestExecution.run(TestExecution.java:41) 在 org.eclipse.jdt.internal.junit.runner.RemoteTestRunner.runTests(RemoteTestRunner.java:541) 在 org.eclipse.jdt.internal.junit.runner.RemoteTestRunner.runTests(RemoteTestRunner.java:763) 在 org.eclipse.jdt.internal.junit.runner.RemoteTestRunner.run(RemoteTestRunner.java:463) 在 org.eclipse.jdt.internal.junit.runner.RemoteTestRunner.main(RemoteTestRunner.java:209) 引起：java.lang.NullPointerException at tests.Base.takeScreenshot(Base.java:240) ... 49 更多

您可以看到我的日志记录语句在该方法中的下一行代码导致的 NullPointerException 之前输出（从测试实例引用 driver）。是否有正确的方法在上下文中触发现有测试实例的takeScreenshot() 方法？

或

如果有更简单的方法可以直接在测试的@AfterEach 方法中截屏失败，请告诉我。似乎是一个非常基本的用例。 :)

【问题讨论】：

从扩展中注入或查找WebDriver，然后将屏幕截图逻辑迁移到扩展中不是更容易吗？

您已经在调用 clazz 的变量中有测试实例。为什么要尝试创建一个新实例？

@johanneslink，感谢您的提示。如果我打电话给takeScreenshot.invoke(clazz);，我现在得到一个 Selenium 异常 org.openqa.selenium.NoSuchSessionException。我添加了一些日志记录，似乎在我退出浏览器的测试中的 @AfterEach 方法之后调用了 Junit5 TestWatcher testFailed() 方法。在我看来，TestWatcher 方法应该在测试生命周期的任何清理/拆卸部分之前完成。

【参考方案1】：

IMO 问题出在您所描述的流程中。 JUnit 为每个测试方法创建一个 Test 类的新实例（尽管可以更改）。

更好的方法是：

使扩展程序“有状态”，因为它将包含对 Web 驱动程序的引用。 不要在测试中实现takeScreenshot方法，而是在扩展（私有方法）中实现 如果您需要在测试中使用它，请在扩展中实现回调并将 WebDriver 的实例“注入”（通过反射）到测试中。这将保证测试以正确实例化的“状态”（webdriver 实例）运行。 在扩展中实现“如果测试方法失败调用扩展takeScreenshot的私有方法”的逻辑

【参考方案2】：

你不应该做一些事情，比如从扩展中实例化测试类，框架应该处理所有事情。

请参考文档中的https://junit.org/junit5/docs/current/user-guide/#extensions5.9.1，看this Q&A

您可以使用它，也可以修改您的 TestWatcher 以按照 cmets 中的建议进行屏幕截图。您必须将驱动程序引用保存在 ExtensionContext 中才能访问它。