如何将 JUnit 5 与 Gradle 一起使用？

Question

在我成功运行JUnit 4 测试后，我正在尝试将 JUnit 5 与 Gradle 结合使用。

预期结果： JUnit 4 测试在输出中给出了很好的 'passed'，在 build/reports/tests 中给出了 html 报告。

实际结果： 下面的 JUnit 5 测试除了 (...) build succesful 之外没有输出任何东西，而我知道测试实际上不是运行因为那里没有测试日志输出 passed/skipped/failed，在测试中放入 fail 保持构建成功。

运行 gradle test --info 在很多我认为不相关的输出中产生 Skipping task ':testClasses' as it has no actions.。令人惊讶的是，它还说 Executing task ':test' 和 Generating HTML test report... Finished generating test html results 与 build/test-results/test 中的 xml 类似，而 xml 未生成， html 显示没有测试运行也没有错误，测试确实不是运行.

我也觉得很有意思的是，gradle test --debug yields

[TestEventLogger] Gradle Test Run :test STARTED
[org.gradle.api.internal.tasks.testing.junit.JUnitDetector] test-class-
scan : failed to scan parent class java/lang/Object, could not find the class file
[TestEventLogger]
[TestEventLogger] Gradle Test Run :test PASSED

而我唯一的测试包含

fail("test fails");

我觉得非常棒运行ge!

我的构建文件是

apply plugin: 'java'

test {
    dependsOn 'cleanTest' // run tests every time

}

sourceSets {
    main {
        java {
            srcDirs 'src'
        }
    }
    test {
        java {
            srcDirs 'test'
        }
    }
}

repositories {
    mavenCentral()
}

dependencies {
    // when using this, it worked with a junit 4 test
//    testCompile 'junit:junit:4.10'
    // this should be needed for junit 5 (using M4 is required since IJ 2017.1.2
    testCompile("org.junit.jupiter:junit-jupiter-api:5.0.0-M4")
}

test {
    testLogging {
        events "passed", "skipped", "failed"
    }
}

我的测试是

package mypackage;

import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertEquals;

public class HelloWorldTest {
    @Test
    public void testHelloWorld(){
        assertEquals(2, 1+1, "message");
    }
}

我的文件夹结构是，使用包mypackage，

java-template-project
--- src
    --- mypackage
        --- HelloWorld.java
--- test
    --- mypackage
        --- HelloWorldTest.java

在我使用的 IntelliJ 2017.1.3 中，模块结构如下所示

java-template-project
--- java-template-project_main
    --- src/mypackage
        --- HelloWorld(.java)
--- java-template-project_test
    --- test/mypackage
        --- HelloWorldTest(.java)

因为 Gradle 现在想要在他们自己的包中进行源代码和测试。

我试过的

显然这不是关于这个话题的第一个问题，我找到的所有相关问题都是

但如您所见，这是针对旧版本的 IntelliJ，根据其中一个答案，我已经在使用 IJ 2016.3.3 及更高版本的语法，在一个 JUnit 依赖行中，因此应该没事。
Upgrade from JUnit 4 to JUnit 5 in intellij with gradle

链接回上述问题，并链接到此 Jetbrains blog，它使用与上述问题相同的行。还链接到：
Integrate JUnit 5 tests results with Intellij test report 在问题中，这也显示为依赖性
```
testRuntime("org.junit.vintage:junit-vintage-engine:5.0.0-M1")
```
这在中有解释好吧，当我运行它时，输出显示它找不到这个版本，但是根据 Maven Repository 这个版本是针对 JUnit 5 的：
```
testRuntime("org.junit.vintage:junit-vintage-engine:4.12.0-M4")
```
那里的答案注意到您可以运行 IntelliJ 中的测试，因为更高版本具有 JUnit 5 支持。我知道，当我从 IntelliJ 中运行时，测试运行很好。但是我想用Gradle（还有Travis，需要依赖管理）
我尝试使用
```
testCompile("org.junit.platform:junit-platform-gradle-plugin:1.0.0-M3")
testCompile("org.junit.jupiter:junit-jupiter-engine:5.0.0-M3")
```
但结果没有改变。

我的模板项目位于 https://github.com/PHPirates/java-template-project 但这个问题应该包含所有必要的信息。

Answer 1

您需要两个 JUnit 版本的引擎，并且需要应用 JUnit 平台 gradle 插件。我在您的 gradle 文件中没有看到。这是执行 JUnit 4 和 5 的工作 gradle 构建：

buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath ("org.junit.platform:junit-platform-gradle-plugin:1.0.0-M4")
    }
}

apply plugin: 'org.junit.platform.gradle.plugin'
...

dependencies {
...
    testCompile("junit:junit:4.12")
    testRuntime("org.junit.vintage:junit-vintage-engine:4.12.0-M4")

    testCompile("org.junit.jupiter:junit-jupiter-api:5.0.0-M4")
    testRuntime("org.junit.jupiter:junit-jupiter-engine:5.0.0-M4")

    // Enable use of the JUnitPlatform Runner within the IDE
    testCompile("org.junit.platform:junit-platform-runner:1.0.0-M4")
}

junitPlatform {
    details 'tree'
}

请参阅 JUnit doc 表格了解更多信息。

Answer 2

由于 github issue 对 JUnit 5 的内置支持，预定 Gradle 4.6

因此，从 gradle 4.6 开始，您的预期结果必须与实际结果相同。

Expected result: Tthe JUnit 4 test gave a nice 'passed' in the output and an html report in build/reports/tests.

更新：

gradle 4.6-rc-1 于 2018 年 2 月 16 日发布，此版本提供对 junit 5 的内置支持。

要启用 junit 5 支持，您需要更新 gradle 包装器：

gradle wrapper --gradle-version=4.6-rc-1

并在 build.gradle 中添加一行：

test {
    useJUnitPlatform()
}

Answer 3

新：Gradle 4.6

中的 JUnit 5 支持

正如 in this GitHub issue 所指出的，从 Gradle 4.6 开始支持 JUnit 5！ 4.6 的官方发行说明（目前正在编辑最新版本，但请检查 GitHub releases page to make sure you use the latest version) at docs.gradle.org。旧设置仍然有效，但使用它会使构建文件更清晰。

[2019 年 5 月编辑] 正如@deFreitas 在他的 , the JUnit documentation has improved and now they provide a complete example at https://github.com/junit-team/junit5-samples/tree/r5.4.0/junit5-jupiter-starter-gradle, see especially the build.gradle 中指出的那样。幸运的是，事实证明它实际上与此答案中的相同。

更新Gradle

首先，确保您使用的是最新的 Gradle 版本，检查最新版本 at their GitHub releases。例如，如果是 4.6，运行在您的项目位置 gradlew wrapper --gradle-version=4.6 的终端中，或者确保在您的 gradle/wrapper/gradle-wrapper.properties 文件中更新此行：distributionUrl=https\://services.gradle.org/distributions/gradle-4.6-all.zip.

如何使用built-in JUnit 5

然后 java 文件、目录结构等问题 build.gradle 文件将是（使用新的 plugins 块）

plugins {
    id 'java'
}

repositories {
    mavenCentral()
    mavenLocal()
}

dependencies {
    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.0.3'
    testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.0.3'
}

// These lines can be removed when you use the default directories src/main/kotlin and src/test/kotlin
sourceSets {
    main.java.srcDirs += 'src'
    main.resources.srcDirs += 'src'
    test.java.srcDirs += 'test'
    test.resources.srcDirs += 'test'
}

// Java target version
sourceCompatibility = 1.8

test {
    // Enable JUnit 5 (Gradle 4.6+).
    useJUnitPlatform()

    // Always run tests, even when nothing changed.
    dependsOn 'cleanTest'

    // Show test results.
    testLogging {
        events "passed", "skipped", "failed"
    }
}

PS 绝对最小版本见。

Android

在 Android 上，我通过将以下内容添加到我的应用程序模块构建文件中，设法运行从问题中进行 JUnit 5 测试。如您所见，依赖项是相同的，但我不需要 useJUnitPlatform() 并且测试配置块略有不同。

apply plugin: 'com.android.application'
// In fact I am not sure you need this, but I had it included to run Spek tests anyway
apply plugin: 'de.mannodermaus.android-junit5' 

repositories {
    mavenCentral()
    jcenter()
}

dependencies {
    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.3.1'
    testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.3.1'
}


android {
    // I'm omitting your other configurations like compileSdkVersion, buildTypes etc.

    testOptions {
        unitTests.all {

            // Always run tests, even when nothing changed.
            dependsOn 'clean'

            // Show test results.
            testLogging {
                events "passed", "skipped", "failed"
            }
        }
    }
}

然而它只在我执行Gradletest任务时对我有用，不当我运行 check 任务。像往常一样，我通过创建一个失败的测试来测试它，然后我尝试 Gradle 任务是通过还是失败。

Answer 4

只是添加到知识库中，我刚得到以下与 gradle 4.7 一起使用的内容：

apply plugin: 'java'
repositories {
    mavenCentral()
}

dependencies {
    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.1.1'
    testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.1.1'
}

test {
    useJUnitPlatform()
}

Answer 5

可能对那些在尝试将 JUnit5 与 gradle 版本 4.10 集成时遇到此问题的人有所帮助。

Could not find method test() for arguments [build_dzas89s5z18l3bfyn6b3q0dxv$_run_closure2$_closure9@8e60c6] on project ':app' of type org.gradle.api.Project.

实际上，对于 4.10，您不需要在 build.gradle 中添加此测试配置块来启用 JUnit5。

test {
    useJUnitPlatform()
}

只需添加 jupitor-api 和 jupitor-engine 的必要依赖项就可以正常工作。

我试图浏览 4.10 的发行说明，但找不到有关此更改的任何信息。如果有人对它背后的 "Why" 了解更多，那么也请赐教。

Answer 6

查看 junit official documentation 如何将 junit 5 与 gradle 一起使用。

build.gradle

plugins {
    id 'java'
}

repositories {
    mavenCentral()
}

dependencies {
    testImplementation('org.junit.jupiter:junit-jupiter:5.4.0')
}

test {
    useJUnitPlatform()
    testLogging {
        events "passed", "skipped", "failed"
    }
}

如何将 JUnit 5 与 Gradle 一起使用？

How to use JUnit 5 with Gradle?

junit

gradle

build.gradle

junit5

新：Gradle 4.6

Android