如何测试自定义Gradle插件对项目的配置是否正确？

1. 用Gradle内置任务直接查看配置结果 #

• 执行gradle dependencies查看依赖树：确认插件添加的依赖是否出现在对应配置（如implementation、compileClasspath）中，版本是否匹配，同时能间接验证仓库配置有效性——依赖能正常显示则说明仓库可正常访问
• 执行gradle projects：检查插件是否正确应用到目标子项目（多模块场景下）
• 执行gradle properties：查看项目属性，验证插件设置的自定义配置项（如customPlugin.enableFeature这类）是否已正确注入

2. 用Gradle TestKit编写集成测试 #

这是最可靠的自动化验证方式，直接模拟插件应用场景：

• 创建临时测试项目，在测试代码中应用插件，通过Project对象直接断言配置是否符合预期
• 示例Groovy测试代码：

def "plugin adds expected repository and dependency"() {
    given:
    def projectDir = temporaryFolder.newFolder()
    def buildFile = new File(projectDir, "build.gradle")
    buildFile << """
        plugins {
            id 'com.your.custom.plugin'
        }
    """

    when:
    def project = ProjectBuilder.builder().withProjectDir(projectDir).build()
    project.plugins.apply("com.your.custom.plugin")

    then:
    // 验证目标仓库是否添加
    project.repositories.any { 
        it instanceof MavenArtifactRepository && it.url.toString() == "https://your.target.repo" 
    }
    // 验证指定依赖是否添加
    project.dependencies.find { 
        it.group == 'com.example' && it.name == 'core-lib' && it.version == '2.1.0' 
    } != null
}

• 可扩展测试不同场景：比如插件在Java/Android项目中的配置差异，或根据项目属性动态调整配置的逻辑

3. 用dry-run模式快速验证配置触发 #

• 执行gradle assemble --dry-run，该命令会模拟构建流程但不实际执行任务，能直观看到插件是否触发了预期的配置动作——比如是否尝试添加仓库、依赖，快速排查配置逻辑是否被正确执行

4. 临时添加任务输出配置详情 #

在测试项目的build.gradle中添加临时任务，直接打印插件配置内容：

task checkPluginSetup {
    doLast {
        println "=== 已配置仓库 ==="
        repositories.each { println "- ${it.url}" }
        println "\n=== 插件添加的依赖 ==="
        configurations.implementation.dependencies.each { 
            println "- ${it.group}:${it.name}:${it.version}" 
        }
    }
}

• 执行gradle checkPluginSetup，通过输出快速确认配置是否符合预期，适合临时调试

5. 开启调试模式跟踪配置过程 #

• 执行gradle build -Dorg.gradle.debug=true，用IDE（IntelliJ/Eclipse）连接默认5005调试端口，在插件的配置代码中打断点，逐步执行查看仓库、依赖是否被正确添加，配置项是否生效——适合排查复杂配置逻辑问题

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