Gradle 测试夹具插件和核心模块依赖关系

Question

我有一个使用 Gradle 版本 6.4 和 JDK 8 构建的项目。我正在尝试使用 Gradle plugin for Test Fixtures (java-test-fixtures)但我对依赖项有一些问题。

根据上面链接的 Gradle 页面，项目的结构应如下所示：

core-module
-- src
   -- main
      -- java
   -- test
      -- java
   -- testFixtures
      -- java

虽然 build.gradle.kts 文件具有以下依赖项部分：

dependencies {
    api("com.my.external.project:1.0")
    // ... more API dependencies

    testFixturesCompileOnly(project(":core-module"))
    testFixturesApi("junit:junit:4.12")
    // ... more test dependencies
}

现在，在 IntelliJ（我正在使用的 IDE）中 testFixtures/java 源文件夹中的类查看 main/java 源中的类文件夹。因此，我可以在 testFixtures/java 下添加新的 Java 类，它们依赖于 main 下的那些。但是，我将无法从外部库 com.my.external.project:1.0 导入依赖项。当我尝试运行 Gradle 任务 compileTestFixturesJava.

时，问题得到确认

我可以复制 dependencies 部分中的条目；例如我可以添加：

testFixturesImplementationOnly("com.my.external.project:1.0")

但这并不是我真正希望做的；特别是当我有几十个依赖项时。

我还可以在数组中定义依赖关系，并在它们之上运行 for-each。不过，这不是最干净的解决方案。

是否有允许 testFixtures 模块使用 main 模块中声明的依赖项的干净解决方案？

Answer 1

Gradle java-test-fixtures 插件中最重要的概念在其 documentation:

中说明

[this plugin] will automatically create a testFixtures source set, in which you can write your test fixtures. Test fixtures are configured so that:

they can see the main source set classes

test sources can see the test fixtures classes

此插件确实会创建以下依赖项：main <-- testFixtures 和 testFixtures <-- test

在您的情况下，testFixtures 模块应该自动依赖于 main 源，并且还依赖于 api 范围内声明的 main 依赖项（com.my.extenal.project:1.0）

在此处查看有效示例项目中的类似示例 https://github.com/mricciuti/so-64133013 :

Simpsons class 可以从主模块

Person

TestHelpers class 可以访问 main 在 api 配置中声明的依赖项

请注意 testFixtures 不会从 test 模块继承依赖项：如果您需要在此模块中使用此类库（例如 JUnit、Mockito 等），则需要声明显式依赖，使用 testFixturesImplementation 或 testFixturesApi 配置。

参见 core-module

中的示例

plugins {
    id ("java-library")
    id ("java-test-fixtures")
}
dependencies {
    // Main dependencies
    //   will be available in "testFixture" as well thanks to "api" configuration
    api("org.apache.commons:commons-lang3:3.9")
    api(project(":utils-module"))

    // Testfixture dependencies
        // ==> mockito lib will be available in testFixture module and also in consumer modules (e.g test)
    testFixturesApi("org.mockito:mockito-core:3.5.13")

    // Test dependencies
       // dependencies specific to the "test" module; not visible from "testFixtures"
    testImplementation("org.junit.jupiter:junit-jupiter-api:5.3.1")
    testRuntimeOnly ("org.junit.jupiter:junit-jupiter-engine:5.3.1")
}

Gradle 测试夹具插件和核心模块依赖关系

Gradle test fixtures plugin and core module dependencies

java

dependency-management

gradle

gradle-kotlin-dsl

java-test-fixtures