JUnit5：Suite 方法调用前后

Question

我花了几天时间寻找解决方案，所以我知道所有基本答案

我看过文档，我知道，@BeforeClass/@AfterClass 被@BeforeAll/@AfterAll 替换了，@RunWith 不再存在； 被@ExtendWith取代我已经阅读了stackoverflow上的所有主题（删除链接，因为stackoverflow假装它是垃圾邮件:(

我曾经在套件中运行一些 JUnit4 测试。 每个 Suite class Suite1.class、Suite2.class都有几个@Test方法， @BeforeClass/@AfterClass在所有测试方法之前/之后运行。

@RunWith(StopOnFailureSuite.class)
@Suite.SuiteClasses({
        Test1.class,
        Test2.class
})

public class TSuite_20 {
    private static final byte SUITE_NUMBER = 20;

    @BeforeClass
    public static void setUpClass() {
        //some logic for suite setup
    }

    @AfterClass
    public static void tearDownClass() {
        //some logic for teardown
    }
}

因为我想使用 @ParameterizedTests，所以我需要迁移到 JUnit5。 突然我意识到，完全相同的行为，曾经在 JUnit4 中是不可能实现的。 [运行一些自定义设置代码； 运行多个测试类，其中可能包含多个@Test 方法； 运行一些自定义的拆卸代码]；

有没有人知道（最好有例子）用 JUnit 5 制作它的方法？

选项 1此代码永远不会执行BeforeAfterSuite#beforeAll和BeforeAfterSuite#afterAll

@ExtendWith(BeforeAfterSuite.class)
@Suite
@SelectClasses({
        Test1.class,
        Test2.class
})
public class TSuite_20 {
    public static final byte SUITE_NUMBER = 20;
}

public class BeforeAfterSuite implements BeforeAllCallback, AfterAllCallback
/*,TestInstancePreConstructCallback, BeforeTestExecutionCallback, 
AfterTestExecutionCallback, ExtensionContext.Store.CloseableResource*/ {
    private static boolean started = false;

    @Override
    public void beforeAll(ExtensionContext context) {
        if (!started) {
            started = true;
            //before stuff
        }
    }

    @Override
    public void afterAll(ExtensionContext context) throws Exception {
        //after all;
    }
}

选项 2我只是好奇，如果我将测试方法放入其中，JUnit 将如何处理套件 class...此代码将在 TSuite_20#test 之前和之后执行一次BeforeAfterSuite#beforeAll和BeforeAfterSuite#afterAll一次

@ExtendWith(BeforeAfterSuite.class)
@Suite
@SelectClasses({
        Test1.class,
        Test2.class
})
public class TSuite_20 {
    public static final byte SUITE_NUMBER = 20;
    
    @Test
    public void test() {
    }
}

选项 3我们还可以为每个测试 class 应用@ExtendWith(BeforeAfterSuite.class) ，这将导致每个测试 class 的BeforeAfterSuite#beforeAll和BeforeAfterSuite#afterAll 。（在此示例中 - 2 次）。

@ExtendWith(BeforeAfterSuite.class)
public class Test1 {
    
    @Test
    public void test11() {
    }
    @Test
    public void test12() {
    }
}

@ExtendWith(BeforeAfterSuite.class)
public class Test2 {
    
    @Test
    public void test21() {
    }
    @Test
    public void test22() {
    }
}

选项 4我也试一试

• 没有@ExtendWith()和@BeforeAll + @AfterAll ； （正如预期的那样，什么也没发生）`
• 没有@ExtendWith()和@BeforeAll + @Test + @AfterAll ； （正如预期的那样，针对特定套件类单独执行 BeforeAll/AfterAll）`

选项 5听众是我实现预期行为的最后希望。 我已经为 LauncherSessionListener 创建了自己的 impl，只是因为我认为它可以让我在测试开始之前准确地执行 smth。

public class BeforeAfterSuiteLauncher implements LauncherSessionListener {
    private static boolean started = false;
    @Override
    public void launcherSessionOpened(LauncherSession session) {
        if (!started) {
            started = true;
            //before all
        }
    }
    @Override
    public void launcherSessionClosed(LauncherSession session) {
        //after all
    }
}

我还添加了一些默认的 impl CompositeLauncherSessionListener

包结构截图显示 Java SPI 配置： LauncherSessionListener

对于 TestExecutionListener，我添加了两个默认实现，只是为了捕获至少一个 Listener：

org.junit.platform.launcher.listeners.LoggingListener
org.junit.platform.launcher.listeners.SummaryGeneratingListener

和一个习俗

public class BeforeAfterExecutionListener implements TestExecutionListener {
    @Override
    public void testPlanExecutionStarted(TestPlan testPlan) {
        //before all
    }

    @Override
    public void testPlanExecutionFinished(TestPlan testPlan) {
        //after all
    }
}

包结构截图显示 Java SPI 配置： TestExecutionListener

并且只触发了 SummaryGeneratingListener！

我究竟做错了什么？ 为什么我的 BeforeAfterExecutionListener impl 没有被加载和触发？

PS 以上代码均在Intellij Idea 2021.1.3 旗舰版下执行

java version "1.8.0_341"
Java(TM) SE Runtime Environment (build 1.8.0_341-b10)
Java HotSpot(TM) 64-Bit Server VM (build 25.341-b10, mixed mode)

这是 intelliJs 命令：

C:\Tools\jdk\bin\java.exe -agentlib:jdwp=transport=dt_socket,address=127.0.0.1:61280,suspend=y,server=n -ea -Didea.test.cyclic.buffer.size=1048576 -javaagent:C:\Users\userName\AppData\Local\JetBrains\IntelliJIdea2021.1\groovyHotSwap\gragent.jar -javaagent:C:\Users\userName\AppData\Local\JetBrains\IntelliJIdea2021.1\captureAgent\debugger-agent.jar -Dfile.encoding=UTF-8 -classpath C:\Users\userName\AppData\Local\Temp\classpath1705687115.jar com.intellij.rt.junit.JUnitStarter -ideVersion5 -junit5 com.testdirectly.application.testcase.TSuite_20

结果是JUnit5IdeaTestRunner

我的 gradle 依赖项

dependencies {
        //JUnit platform
        // to group tests by package, by class name, by class name pattern, etc (use @Suite, @SelectClasses) :junit-platform-suite-api:1.9.2
        // and to filter/discover and run them         (SuiteLauncher, SuiteTestEngine, SuiteTestDescriptor) :junit-suite-engine:1.9.2
        testImplementation "org.junit.platform:junit-platform-suite:1.9.2"
        //Launcher, engine discovery
        testImplementation "org.junit.platform:junit-platform-launcher:1.9.2"//to run tests

        //JUnit Jupiter
        //to use assertions and so on
        testImplementation "org.junit.jupiter:junit-jupiter-api:5.9.2"
        //to use @ParameterizedTest
        testImplementation "org.junit.jupiter:junit-jupiter-params:5.9.2"
        //Jupiter engine to run junit5 tests (JupiterTestEngine, Extensions, etc)
        testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:5.9.2"
}

Answer 1

简答

如果您稍微调整选项 5，它就会起作用（见下文）。

长答案

选项 1 和 2 不起作用，因为@ExtendWith是 Jupiter 扩展机制，而@Suite触发它自己的引擎。 测试引擎不结合 JUnit 平台。

选项 4 也是如此，因为@BeforeAll和@AfterAll是 Jupiter 注释。

使选项 5 起作用

首先，我建议使用TestExecutionListener而不是LauncherSessionListener ，因为后者仍处于实验阶段。

因此我们有

package my.project.suites;

import org.junit.platform.launcher.*;

public class BeforeAfterSuiteListener implements TestExecutionListener {

    @Override
    public void testPlanExecutionStarted(TestPlan testPlan) {
        System.out.println("before all");
    }

    @Override
    public void testPlanExecutionFinished(TestPlan testPlan) {
        System.out.println("after all");
    }
}

现在缺少的是您必须全局注册BeforeAfterSuiteListener 。 在基于类路径的 Java 中，您通过资源文件META-INF/services/org.junit.platform.launcher.TestExecutionListener ：

my.project.suites.BeforeAfterSuiteListener

现在before all和after all应该在每次测试运行时恰好在您的 output 中显示一次。