使用 Apache Maven Surefire 在 Junit 5 平台上运行基于文件的测试

Question

我已经实现了一个自定义 TestEngine 类，它能够通过检查来自 Junit 5 的 EngineDiscoveryRequest 中的 FileSelector 从 *.csv 文件（不是 java 类）中发现和运行单元测试。

我可以使用 Junit 团队提供的 ConsoleLauncher 通过调用 org.junit.platform.console.ConsoleLauncher -f build/resources/test/testfile_1.csv 毫无问题地运行这些测试（这是从 gradle 任务中调用的，因为 gradle does not support resource-based testing 但这在这里不重要）。

现在，我尝试使用相同的自定义测试引擎运行相同的测试，但使用 maven 和 surefire 插件而不是控制台启动器。我当前的pom.xml 如下（相关部分）：

<project>
    <dependencies>
        <dependency>
            <groupId>my_custom_test_engine</groupId>
            <artifactId>custom_test_engine</artifactId>
            <version>1.0-SNAPSHOT</version>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.junit.platform</groupId>
            <artifactId>junit-platform-engine</artifactId>
            <version>1.7.0-M1</version>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.junit.platform</groupId>
            <artifactId>junit-platform-console</artifactId>
            <version>1.7.0-M1</version>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-simple</artifactId>
            <version>1.7.30</version>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-surefire-plugin</artifactId>
                <version>3.0.0-M5</version>
            </plugin>
        </plugins>
    </build>
</project>

不幸的是，surefire:test 似乎甚至没有调用我的测试引擎进行发现，只是完成了：

[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  0.626 s
[INFO] Finished at: 2020-06-20T17:00:01+02:00
[INFO] ------------------------------------------------------------------------

我的src 文件夹中没有任何测试类，resources/testfile_1.csv 下只有一个测试文件。

surefire 是否甚至支持使用 Junit 5 进行基于文件的测试？如果是这样，我如何强制 Surefire 调用我的自定义测试引擎进行测试发现？

-- 更新

我的TestEngine 实现的发现部分看起来像这样（仅显示相关部分）：

public class MyTestEngine implements TestEngine {

    @Override
    public TestDescriptor discover(EngineDiscoveryRequest discoveryRequest, UniqueId uniqueId) {
        EngineDescriptor engineDescriptor = new EngineDescriptor(uniqueId, name);

        logger.debug("Discovering tests");

        discoveryRequest.getSelectorsByType(FileSelector.class).forEach(selector -> {
            logger.debug("Discovered: {}", selector.getFile().getAbsolutePath());
                engineDescriptor.addChild(new TestDescriptor (engineDescriptor.getUniqueId(), selector.getFile().getName()));

        });
}

-- 更新 2 我的测试文件位于src/test/resources。

Answer 1

想通了。感谢@johanneslink 为我指明了正确的方向。

Surefire 确实不支持基于资源的测试（另请参阅this issue）。 我所做的（正如@johanneslink 建议的那样）是创建一个空类，可以通过surefire 检测到，以便调用自定义TestEngine：

public class TestInitializer {
}

然后，在我的TestEngine 中检查ClassSelector 并发现基于资源的测试：

discoveryRequest.getSelectorsByType(ClassSelector.class).forEach(selector -> {
            if (selector.getClassName().equals(TestInitializer.class.getName())) {
                discoverTests(new File(System.getenv("test_dir")), engineDescriptor);
            }
        });

我的测试文件所在的实际目录由环境变量test_dir指定。

那么，为了实际使用自定义TestEngine，修改你的pom.xml如下：

   <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-surefire-plugin</artifactId>
                <version>2.22.2</version>
                <configuration>
                    <dependenciesToScan>
                        <dependency>
                            my_custom_test_engine:custom_test_engine
                        </dependency>
                    </dependenciesToScan>
                    <includes>
                        <include>**/TestInitializer*
                        </include>
                    </includes>
                    <environmentVariables>
                        <test_dir>target/test-classes
                        </test_dir>
                    </environmentVariables>
                </configuration>
            </plugin>
        </plugins>
    </build>

dependenciesToScan 属性将确保，surefire 扫描包含 TestInitializer 类的依赖项。

请注意，maven-surefire-plugin 的最新版本 3.0.0-M5 在这方面似乎已被破坏，因为会发现并运行测试，但 Surefire 不会收到结果。请改用2.22.2。