unit-testing - 如何将 JUnit 5 与 Gradle 结合使用？

Question

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

预期结果:JUnit 4 测试在输出中给出了很好的“通过”结果，并在 build/reports/tests 中给出了 html 报告。

实际结果:下面的 JUnit 5 测试除了 (...) build success 之外不输出任何内容，虽然我知道测试实际上并没有运行，因为那里没有测试日志输出通过/跳过/失败，并且在测试中放置失败可以保持构建成功。

运行gradle test --info会产生Skipping task ':testClasses'，因为它没有任何操作。其中有很多我认为大多不相关的输出。令人惊讶的是，它还显示正在执行任务':test'和生成HTML测试报告...已完成生成测试html结果以及build/test中的xml类似-results/test，虽然没有生成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，并且我已经根据答案之一在一个 JUnit 依赖行中使用 IJ 2016.3.3 及更高版本的语法，所以应该没问题.

• 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")
  

  Why were JUnit Jupiter and JUnit Vintage separated When I Running TestCase in IntelliJ? 中对此进行了解释好吧，当我运行它时，输出显示它找不到这个版本，但根据 Maven Repository这个适用于 JUnit 5:

   testRuntime("org.junit.vintage:junit-vintage-engine:4.12.0-M4")
  

  那里的答案指出，您可以只在 IntelliJ 中运行测试，因为更高版本有 JUnit 5 支持。我知道，当我从 IntelliJ 中运行时，测试运行良好。但我想使用 Gradle(和 Travis，需要依赖管理)。

• How to capture stdout/stderr in junit 5 gradle test report?

  我尝试使用

   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

新功能:Gradle 4.6 中支持 JUnit 5

正如所指出的in this GitHub issue从 Gradle 4.6 开始支持 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，请在项目位置 gradlewwrapper --gradle-version=4.6 的终端中运行，或者确保在 gradle/wrapper/gradle-wrapper 中更新此行.properties 文件:distributionUrl=https\://services.gradle.org/distributions/gradle-4.6-all.zip。

如何使用内置的 JUnit 5

然后使用问题中的 java 文件、目录结构等，build.gradle 文件将是(使用新的 plugins block )

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(请参阅此帖子:JUnit 5 for Android testing)

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

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 任务是否通过或失败。