如何为build.gradle.kts编写测试？验证构建文件指定属性的方法

1. 使用Gradle官方TestKit做集成测试 #

Gradle TestKit是官方推荐的构建脚本测试工具，支持用Groovy、Java或Kotlin编写测试，能模拟Gradle运行环境，验证构建逻辑的正确性。

示例（Groovy + JUnit）：

import org.gradle.testkit.runner.GradleRunner
import static org.gradle.testkit.runner.TaskOutcome.SUCCESS
import org.junit.Test

class BuildValidationTest {
    @Test
    void verifyJavaPluginApplied() {
        def result = GradleRunner.create()
            .withProjectDir(new File(".")) // 指定项目根目录
            .withArguments("tasks") // 执行tasks任务获取输出
            .withPluginClasspath() // 自动加载插件类路径
            .build()
        
        // 通过输出判断Java插件是否应用（Java插件会添加相关任务组）
        assert result.output.contains("Java") : "Java插件未正确应用"
    }

    @Test
    void verifyCompileJavaTaskEnabled() {
        def result = GradleRunner.create()
            .withProjectDir(new File("."))
            .withArguments("compileJava", "--dry-run") // dry-run不实际执行任务，仅验证任务状态
            .withPluginClasspath()
            .build()
        
        // 检查任务存在且可执行（dry-run下SUCCESS表示任务已启用）
        assert result.task(":compileJava") != null : "compileJava任务不存在"
        assert result.task(":compileJava").outcome == SUCCESS : "compileJava任务已被禁用"
    }
}

2. 编写自定义Gradle任务做快速验证 #

如果不需要完整的测试框架，可直接在构建脚本中添加自定义任务，运行时即时验证属性，适合本地开发时快速校验。

示例（build.gradle）：

task validateBuildConfig {
    doLast {
        // 验证指定插件是否已应用
        assert project.plugins.hasPlugin('java') : "错误：Java插件未应用"
        assert project.plugins.hasPlugin('application') : "错误：Application插件未应用"
        
        // 验证任务存在且启用
        def runTask = project.tasks.findByName('run')
        assert runTask != null : "错误：run任务不存在"
        assert runTask.enabled : "错误：run任务已被禁用"
    }
}

运行./gradlew validateBuildConfig即可执行验证，若断言失败，构建会直接终止并抛出错误信息。

3. 结合Spock框架编写更灵活的测试 #

如果需要更简洁的断言语法和行为驱动测试支持，可以用Spock框架配合TestKit，适合复杂场景的构建验证。

示例（Spock测试）：

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

class BuildSpec extends Specification {
    def "验证Application插件已应用且run任务可用"() {
        when:
        def result = GradleRunner.create()
            .withProjectDir(new File("."))
            .withArguments("help", "--task=run")
            .withPluginClasspath()
            .build()

        then:
        // 验证任务描述存在，说明任务可用
        result.output.contains("Runs this project as a JVM application")
        // 直接检查插件状态
        project.plugins.hasPlugin('application')
    }
}

内容的提问来源于stack exchange，提问作者pixel