新增：Gradle 4.6中的JUnit 5支持

Question

我在成功运行JUnit 4测试后尝试将JUnit 5与Gradle一起使用。

预期结果：JUnit 4测试在输出中提供了一个很好的'传递'，在build/reports/tests中提供了一个html报告。

实际结果：下面的JUnit 5测试除了(...) build succesful之外没有输出任何内容，而我知道测试实际上没有运行，因为没有传递/跳过测试日志输出/失败，并在测试中放置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产生

[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");

我认为这很奇怪！

我的构建文件是

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现在需要源代码并在自己的包中进行测试。

我尝试了什么

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

Gradle project running jUnit 5 tests in IntelliJ

但是你可以看到这是针对旧版本的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使用与上述问题相同的行。还链接到：
Why were JUnit Jupiter and JUnit Vintage separated When I Running TestCase in IntelliJ? 在这个问题中，这个也显示为依赖
```
testRuntime("org.junit.vintage:junit-vintage-engine:5.0.0-M1")
```
在Maven Repository中解释好吧，当我运行它时，输出显示它找不到这个版本，但根据How to capture stdout/stderr in junit 5 gradle test report?这个是JUnit 5：
```
testRuntime("org.junit.vintage:junit-vintage-engine:4.12.0-M4")
```
答案中注意到您可以在IntelliJ中运行测试，因为更高版本具有JUnit 5支持。我知道，当我在IntelliJ中运行时，测试运行正常。但我想使用Gradle（和需要依赖管理的Travis）。
https://github.com/PHPirates/java-template-project

我尝试使用
```
testCompile("org.junit.platform:junit-platform-gradle-plugin:1.0.0-M3")
testCompile("org.junit.jupiter:junit-jupiter-engine:5.0.0-M3")
```
但结果没有改变。

我的模板项目位于Getopt::Std，但此问题应包含所有必要信息。

Answer 1

新增：Gradle 4.6中的JUnit 5支持

正如从Gradle 4.6开始的in this GitHub issue所指出的，支持JUnit 5！官方发行说明4.6（在编辑最新版本时，但请检查GitHub releases page以确保使用最新版本）at docs.gradle.org。旧的设置仍然有效，但使用它可以使构建文件更加清晰。

[编辑2019年5月]正如@deFreitas在他的answer中指出的那样，JUnit文档已得到改进，现在他们在https://github.com/junit-team/junit5-samples/tree/r5.4.0/junit5-jupiter-starter-gradle提供了一个完整的示例，特别是那里的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。

如何使用内置的JUnit 5

然后使用build.gradle文件的问题中的java文件，目录结构等（使用新的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对于绝对最小版本，请参阅Ray's answer。

的Android

在Android上，我设法通过将以下内容添加到我的app模块构建文件来运行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"
            }
        }
    }
}

然而它只适用于我执行Gradle test任务时，不，当我运行check任务时。像往常一样，我通过创建一个失败的测试来测试它，然后我尝试Gradle任务通过或失败。

Answer 2

您需要两个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 3

只需添加到知识库中，我就可以使用以下内容来使用gradle 4.7：

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

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

test {
    useJUnitPlatform()
}

Answer 4

由于github issue内置支持JUnit 5，计划用于Gradle 4.6

因此，自Gradle 4.6起，您的预期结果必须与实际结果相同。

预期结果：JUnit 4测试给出了一个很好的通过＆＃39;在输出中以及build/reports/tests中的html报告。

UPD：

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 5

结帐junit official documentation如何将gratis结合使用junit 5。

build.gradle

plugins {
    id 'java'
}

repositories {
    mavenCentral()
}

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

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

Answer 6

对于尝试将 JUnit5 与Gradle版本 4.10 集成在一起的人来说，这可能是有用的。

var variableRef = Expression.Property(Expression.Constant(Tuple.Create(key)), "Item1");

实际上，在4.10中，您无需在build.gradle中添加此测试配置块即可启用JUnit5。

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

仅通过添加jupitor-api和jupitor-engine的必要依赖项，它就可以正常工作。

我尝试浏览4.10的发行说明，但找不到有关此更改的任何信息。如果有人对它背后的“为什么”有所了解，那么也请给我启发。

如何在Gradle中使用JUnit 5？

6 个答案:

新增：Gradle 4.6中的JUnit 5支持

的Android