测试在开发过程中起着至关重要的作用,它可以确保软件的可靠性和高质量。这一原则也适用于构建代码,包括 Gradle 插件。

示例项目

本节围绕一个名为“URL 验证器插件”的示例项目展开。该插件创建一个名为 verifyUrl 的任务,用于检查给定的 URL 是否可以通过 HTTP GET 解析。最终用户可以通过名为 verification 的扩展提供 URL。

以下构建脚本假设插件 JAR 文件已发布到二进制存储库。该脚本演示了如何将插件应用于项目并配置其公开的扩展

build.gradle.kts
plugins {
    id("org.myorg.url-verifier")        (1)
}

verification {
    url = "https://www.google.com/"  (2)
}
build.gradle
plugins {
    id 'org.myorg.url-verifier'         (1)
}

verification {
    url = 'https://www.google.com/'     (2)
}
1 将插件应用于项目
2 通过公开的扩展配置要验证的 URL

执行 verifyUrl 任务,如果对配置的 URL 的 HTTP GET 调用返回 200 响应代码,则会呈现成功消息

$ gradle verifyUrl

> Task :verifyUrl
Successfully resolved URL 'https://www.google.com/'

BUILD SUCCESSFUL in 0s
5 actionable tasks: 5 executed

在深入研究代码之前,让我们首先回顾一下不同类型的测试以及支持实现它们的工具。

测试的重要性

测试是软件开发生命周期中至关重要的部分,它可以确保软件在发布之前正常运行并符合质量标准。自动化测试使开发人员能够自信地重构和改进代码。

测试金字塔

手动测试

虽然手动测试很简单,但它容易出错,并且需要人工操作。对于 Gradle 插件,手动测试涉及在构建脚本中使用插件。

自动化测试

自动化测试包括单元测试、集成测试和功能测试。

testing pyramid

迈克·科恩在他的书《敏捷软件开发:使用 Scrum 取得成功》中介绍的测试金字塔描述了三种类型的自动化测试。

  1. 单元测试:验证代码的最小单元,通常是方法,在隔离状态下进行。它使用桩或模拟来隔离代码与外部依赖项。

  2. 集成测试:验证多个单元或组件是否协同工作。

  3. 功能测试:从最终用户的角度测试系统,确保功能正确。Gradle 插件的端到端测试模拟构建,应用插件,并执行特定任务以验证功能。

工具支持

使用适当的工具可以简化 Gradle 插件的手动和自动测试。下表总结了每种测试方法。您可以选择任何您熟悉的测试框架。

有关详细说明和代码示例,请参阅以下特定部分。

测试类型 工具支持

手动测试

Gradle 复合构建

单元测试

任何基于 JVM 的测试框架

集成测试

任何基于 JVM 的测试框架

功能测试

任何基于 JVM 的测试框架和 Gradle TestKit

设置手动测试

Gradle 的 复合构建 功能使手动测试插件变得容易。独立的插件项目和使用项目的项目可以组合成一个单元,从而可以轻松地尝试或调试更改,而无需重新发布二进制文件。

.
├── include-plugin-build   (1)
│   ├── build.gradle
│   └── settings.gradle
└── url-verifier-plugin    (2)
    ├── build.gradle
    ├── settings.gradle
    └── src
1 包含插件项目的消费项目
2 插件项目

将插件项目包含到使用项目中有两种方法。

  1. 使用命令行选项 `--include-build`。

  2. 在 `settings.gradle` 中使用 `includeBuild` 方法。

以下代码片段演示了如何使用设置文件。

settings.gradle.kts
pluginManagement {
    includeBuild("../url-verifier-plugin")
}
settings.gradle
pluginManagement {
    includeBuild '../url-verifier-plugin'
}

来自项目 `include-plugin-build` 的 `verifyUrl` 任务的命令行输出 与简介中显示的完全相同,只是它现在作为复合构建的一部分执行。

手动测试在开发过程中有其作用,但不能替代自动化测试。

设置自动化测试

尽早设置一组测试对于插件的成功至关重要。当将插件升级到新的 Gradle 版本或增强/重构代码时,自动化测试将成为宝贵的安全网。

组织测试源代码

我们建议实施单元测试、集成测试和功能测试的良好分布,以涵盖最重要的用例。将每种测试类型的源代码分开会自动导致一个更易于维护和管理的项目。

默认情况下,Java 项目会在目录 `src/test/java` 中创建一个用于组织单元测试的约定。此外,如果您应用 Groovy 插件,则目录 `src/test/groovy` 下的源代码将被视为编译(Kotlin 在目录 `src/test/kotlin` 下具有相同的标准)。因此,其他测试类型的源代码目录应遵循类似的模式。

.
└── src
    ├── functionalTest
    │   └── groovy      (1)
    ├── integrationTest
    │   └── groovy      (2)
    ├── main
    │   ├── java        (3)
    └── test
        └── groovy      (4)
1 包含功能测试的源代码目录
2 包含集成测试的源代码目录
3 包含生产源代码的源代码目录
4 包含单元测试的源代码目录
目录 `src/integrationTest/groovy` 和 `src/functionalTest/groovy` 不是基于 Gradle 项目的现有标准约定。您可以自由选择最适合您的任何项目布局。

您可以配置用于编译和测试执行的源代码目录。

测试套件插件 提供 DSL 和 API,用于将 JVM 基于项目的多个自动化测试组建模为测试套件。您也可以依靠第三方插件来获得便利,例如 Nebula Facet 插件TestSets 插件

建模测试类型

通过孵化中的 JVM 测试套件 插件,可以使用新的配置 DSL 来建模以下 `integrationTest` 套件。

在 Gradle 中,源代码目录使用 源集 的概念来表示。源集被配置为指向包含源代码的一个或多个目录。当您定义一个源集时,Gradle 会自动为指定的目录设置编译任务。

可以使用一行构建脚本代码创建一个预配置的源集。源集会自动注册配置,以定义源集源代码的依赖项。

// Define a source set named 'test' for test sources
sourceSets {
    test {
        java {
            srcDirs = ['src/test/java']
        }
    }
}
// Specify a test implementation dependency on JUnit
dependencies {
    testImplementation 'junit:junit:4.12'
}

我们使用它来定义一个 integrationTestImplementation 依赖项到项目本身,它代表我们项目的“主”变体(即编译后的插件代码)。

build.gradle.kts
val integrationTest by sourceSets.creating

dependencies {
    "integrationTestImplementation"(project)
}
build.gradle
def integrationTest = sourceSets.create("integrationTest")

dependencies {
    integrationTestImplementation(project)
}

源集负责编译源代码,但它们不处理执行字节码。对于测试执行,需要建立一个类型为 Test 的相应任务。以下设置显示了执行集成测试,引用集成测试源集的类和运行时类路径。

build.gradle.kts
val integrationTestTask = tasks.register<Test>("integrationTest") {
    description = "Runs the integration tests."
    group = "verification"
    testClassesDirs = integrationTest.output.classesDirs
    classpath = integrationTest.runtimeClasspath
    mustRunAfter(tasks.test)
}
tasks.check {
    dependsOn(integrationTestTask)
}
build.gradle
def integrationTestTask = tasks.register("integrationTest", Test) {
    description = 'Runs the integration tests.'
    group = "verification"
    testClassesDirs = integrationTest.output.classesDirs
    classpath = integrationTest.runtimeClasspath
    mustRunAfter(tasks.named('test'))
}
tasks.named('check') {
    dependsOn(integrationTestTask)
}

配置测试框架

Gradle 不强制使用特定的测试框架。流行的选择包括 JUnitTestNGSpock。一旦您选择了一个选项,您就必须将其依赖项添加到测试的编译类路径中。

以下代码片段展示了如何使用 Spock 来实现测试。

build.gradle.kts
repositories {
    mavenCentral()
}

dependencies {
    testImplementation(platform("org.spockframework:spock-bom:2.2-groovy-3.0"))
    testImplementation("org.spockframework:spock-core")
    testRuntimeOnly("org.junit.platform:junit-platform-launcher")

    "integrationTestImplementation"(platform("org.spockframework:spock-bom:2.2-groovy-3.0"))
    "integrationTestImplementation"("org.spockframework:spock-core")
    "integrationTestRuntimeOnly"("org.junit.platform:junit-platform-launcher")

    "functionalTestImplementation"(platform("org.spockframework:spock-bom:2.2-groovy-3.0"))
    "functionalTestImplementation"("org.spockframework:spock-core")
    "functionalTestRuntimeOnly"("org.junit.platform:junit-platform-launcher")
}

tasks.withType<Test>().configureEach {
    // Using JUnitPlatform for running tests
    useJUnitPlatform()
}
build.gradle
repositories {
    mavenCentral()
}

dependencies {
    testImplementation platform("org.spockframework:spock-bom:2.2-groovy-3.0")
    testImplementation 'org.spockframework:spock-core'
    testRuntimeOnly 'org.junit.platform:junit-platform-launcher'

    integrationTestImplementation platform("org.spockframework:spock-bom:2.2-groovy-3.0")
    integrationTestImplementation 'org.spockframework:spock-core'
    integrationTestRuntimeOnly 'org.junit.platform:junit-platform-launcher'

    functionalTestImplementation platform("org.spockframework:spock-bom:2.2-groovy-3.0")
    functionalTestImplementation 'org.spockframework:spock-core'
    functionalTestRuntimeOnly 'org.junit.platform:junit-platform-launcher'
}

tasks.withType(Test).configureEach {
    // Using JUnitPlatform for running tests
    useJUnitPlatform()
}
Spock 是一个基于 Groovy 的 BDD 测试框架,它甚至包含用于创建存根和模拟的 API。Gradle 团队更喜欢 Spock,因为它表达能力强,简洁明了。

实现自动化测试

本节讨论单元测试、集成测试和功能测试的代表性实现示例。所有测试类都基于使用 Spock,尽管将代码适应不同的测试框架应该相对容易。

实现单元测试

URL 验证器插件发出 HTTP GET 调用以检查 URL 是否可以成功解析。方法 DefaultHttpCaller.get(String) 负责调用给定的 URL 并返回类型为 HttpResponse 的实例。HttpResponse 是一个包含有关 HTTP 响应代码和消息信息的 POJO。

HttpResponse.java
package org.myorg.http;

public class HttpResponse {
    private int code;
    private String message;

    public HttpResponse(int code, String message) {
        this.code = code;
        this.message = message;
    }

    public int getCode() {
        return code;
    }

    public String getMessage() {
        return message;
    }

    @Override
    public String toString() {
        return "HTTP " + code + ", Reason: " + message;
    }
}

HttpResponse 代表单元测试的良好候选者。它不接触任何其他类,也不使用 Gradle API。

HttpResponseTest.groovy
package org.myorg.http

import spock.lang.Specification

class HttpResponseTest extends Specification {

    private static final int OK_HTTP_CODE = 200
    private static final String OK_HTTP_MESSAGE = 'OK'

    def "can access information"() {
        when:
        def httpResponse = new HttpResponse(OK_HTTP_CODE, OK_HTTP_MESSAGE)

        then:
        httpResponse.code == OK_HTTP_CODE
        httpResponse.message == OK_HTTP_MESSAGE
    }

    def "can get String representation"() {
        when:
        def httpResponse = new HttpResponse(OK_HTTP_CODE, OK_HTTP_MESSAGE)

        then:
        httpResponse.toString() == "HTTP $OK_HTTP_CODE, Reason: $OK_HTTP_MESSAGE"
    }
}
编写单元测试时,重要的是测试边界条件和各种无效输入形式。尝试从使用 Gradle API 的类中提取尽可能多的逻辑,使其可作为单元测试进行测试。这将导致可维护的代码和更快的测试执行。

您可以使用 ProjectBuilder 类创建 Project 实例,在测试插件实现时使用。

src/test/java/org/example/GreetingPluginTest.java
public class GreetingPluginTest {
    @Test
    public void greeterPluginAddsGreetingTaskToProject() {
        Project project = ProjectBuilder.builder().build();
        project.getPluginManager().apply("org.example.greeting");

        assertTrue(project.getTasks().getByName("hello") instanceof GreetingTask);
    }
}

实现集成测试

让我们看看一个与另一个系统交互的类,即发出 HTTP 调用的代码片段。在执行 DefaultHttpCaller 类的测试时,运行时环境需要能够访问互联网。

DefaultHttpCaller.java
package org.myorg.http;

import java.io.IOException;
import java.net.HttpURLConnection;
import java.net.URL;

public class DefaultHttpCaller implements HttpCaller {
    @Override
    public HttpResponse get(String url) {
        try {
            HttpURLConnection connection = (HttpURLConnection) new URL(url).openConnection();
            connection.setConnectTimeout(5000);
            connection.setRequestMethod("GET");
            connection.connect();

            int code = connection.getResponseCode();
            String message = connection.getResponseMessage();
            return new HttpResponse(code, message);
        } catch (IOException e) {
            throw new HttpCallException(String.format("Failed to call URL '%s' via HTTP GET", url), e);
        }
    }
}

DefaultHttpCaller 实现集成测试与上一节中显示的单元测试看起来并没有太大区别。

DefaultHttpCallerIntegrationTest.groovy
package org.myorg.http

import spock.lang.Specification
import spock.lang.Subject

class DefaultHttpCallerIntegrationTest extends Specification {
    @Subject HttpCaller httpCaller = new DefaultHttpCaller()

    def "can make successful HTTP GET call"() {
        when:
        def httpResponse = httpCaller.get('https://www.google.com/')

        then:
        httpResponse.code == 200
        httpResponse.message == 'OK'
    }

    def "throws exception when calling unknown host via HTTP GET"() {
        when:
        httpCaller.get('https://www.wedonotknowyou123.com/')

        then:
        def t = thrown(HttpCallException)
        t.message == "Failed to call URL 'https://www.wedonotknowyou123.com/' via HTTP GET"
        t.cause instanceof UnknownHostException
    }
}

实现功能测试

功能测试验证插件端到端的正确性。在实践中,这意味着应用、配置和执行插件实现的功能。UrlVerifierPlugin 类公开了一个扩展和一个任务实例,该实例使用最终用户配置的 URL 值。

UrlVerifierPlugin.java
package org.myorg;

import org.gradle.api.Plugin;
import org.gradle.api.Project;
import org.myorg.tasks.UrlVerify;

public class UrlVerifierPlugin implements Plugin<Project> {
    @Override
    public void apply(Project project) {
        UrlVerifierExtension extension = project.getExtensions().create("verification", UrlVerifierExtension.class);
        UrlVerify verifyUrlTask = project.getTasks().create("verifyUrl", UrlVerify.class);
        verifyUrlTask.getUrl().set(extension.getUrl());
    }
}

每个 Gradle 插件项目都应该应用 插件开发插件 以减少样板代码。通过应用插件开发插件,测试源集将预先配置以用于 TestKit。如果我们想为功能测试使用自定义源集,并将默认测试源集保留为仅用于单元测试,我们可以配置插件开发插件以在其他地方查找 TestKit 测试。

build.gradle.kts
gradlePlugin {
    testSourceSets(functionalTest)
}
build.gradle
gradlePlugin {
    testSourceSets(sourceSets.functionalTest)
}

Gradle 插件的功能测试使用 GradleRunner 的实例来执行被测构建。GradleRunner 是 TestKit 提供的 API,它在内部使用 Tooling API 来执行构建。

以下示例将插件应用于被测构建脚本,配置扩展并使用任务 verifyUrl 执行构建。请参阅 TestKit 文档 以更熟悉 TestKit 的功能。

UrlVerifierPluginFunctionalTest.groovy
package org.myorg

import org.gradle.testkit.runner.GradleRunner
import spock.lang.Specification
import spock.lang.TempDir

import static org.gradle.testkit.runner.TaskOutcome.SUCCESS

class UrlVerifierPluginFunctionalTest extends Specification {
    @TempDir File testProjectDir
    File buildFile

    def setup() {
        buildFile = new File(testProjectDir, 'build.gradle')
        buildFile << """
            plugins {
                id 'org.myorg.url-verifier'
            }
        """
    }

    def "can successfully configure URL through extension and verify it"() {
        buildFile << """
            verification {
                url = 'https://www.google.com/'
            }
        """

        when:
        def result = GradleRunner.create()
            .withProjectDir(testProjectDir)
            .withArguments('verifyUrl')
            .withPluginClasspath()
            .build()

        then:
        result.output.contains("Successfully resolved URL 'https://www.google.com/'")
        result.task(":verifyUrl").outcome == SUCCESS
    }
}

IDE 集成

TestKit 通过运行特定的 Gradle 任务来确定插件类路径。您需要执行 assemble 任务来最初生成插件类路径,或者即使从 IDE 运行基于 TestKit 的功能测试时也要反映对其的更改。

一些 IDE 提供了一个方便的选项,将“测试类路径生成和执行”委托给构建。在 IntelliJ 中,您可以在“首选项”>“构建、执行、部署”>“构建工具”>“Gradle”>“运行器”>“将 IDE 构建/运行操作委托给 Gradle”下找到此选项。

intellij delegate to build