如何使用build.gradle为JUnit测试搭建Elasticsearch环境

刚好我之前做过类似的ES集成测试环境搭建，直接给你一套可以复用的Gradle配置，完美覆盖你的需求：自动缓存压缩包避免重复下载、启动ES指定配置文件、测试后自动停止清理。

完整Groovy配置代码 #

// 自定义配置，用于声明Elasticsearch压缩包依赖
configurations {
    elasticsearchDistro
}

// 引入Elasticsearch 6.1.1的zip包依赖，Gradle会自动缓存到本地仓库
dependencies {
    elasticsearchDistro "org.elasticsearch.distribution.zip:elasticsearch:6.1.1@zip"
}

// 定义解压目录，建议放在build目录下，方便清理
def esInstallDir = file("${buildDir}/elasticsearch")
def esPidFile = file("${buildDir}/elasticsearch.pid")
// 假设你的elasticsearch.yml放在src/test/resources/config目录下
def esConfigFile = file("src/test/resources/config/elasticsearch.yml")

// 解压Elasticsearch压缩包的任务
task unpackElasticsearch(type: Copy) {
    // 依赖配置中的ES压缩包
    from zipTree(configurations.elasticsearchDistro.singleFile)
    // 解压到指定目录，注意ES zip包解压后会有一层根目录，这里直接把内容移到esInstallDir
    into esInstallDir
    eachFile { file ->
        file.path = file.path.substring(file.path.indexOf('/') + 1)
    }
    includeEmptyDirs = true
}

// 启动Elasticsearch的任务
task startElasticsearch(type: Exec) {
    dependsOn unpackElasticsearch
    // 根据操作系统选择可执行文件
    def esExecutable = operatingSystem.isWindows() ? "elasticsearch.bat" : "elasticsearch"
    commandLine "${esInstallDir}/bin/${esExecutable}", "-Epath.config=${esConfigFile.parent}"
    
    // 把进程ID写入文件，方便后续停止
    doLast {
        esPidFile.text = pid
    }
}

// 停止Elasticsearch并清理的任务
task stopElasticsearch(type: Exec) {
    onlyIf { esPidFile.exists() }
    // 根据操作系统选择杀进程命令
    def killCommand = operatingSystem.isWindows() ? "taskkill /F /PID" : "kill"
    commandLine killCommand, esPidFile.text
    
    doLast {
        // 删除解压目录和PID文件
        esInstallDir.deleteDir()
        esPidFile.delete()
    }
}

// 关联测试任务：测试前启动ES，测试完成后自动停止清理
test.dependsOn startElasticsearch
test.finalizedBy stopElasticsearch

关键细节说明 #

• 自动缓存机制：通过configurations.elasticsearchDistro声明依赖，Gradle会自动将下载的zip包缓存到本地Gradle缓存目录（通常是~/.gradle/caches），后续构建时如果缓存存在，不会重复下载，完全符合你的需求。
• 跨系统兼容：代码中通过operatingSystem判断系统，自动选择对应的可执行文件和杀进程命令，支持Windows、Linux、MacOS。
• 配置文件指定：这里假设你的elasticsearch.yml放在src/test/resources/config目录下，启动时通过-Epath.config参数指定配置文件所在的目录，ES会自动加载该目录下的elasticsearch.yml。
• 进程管理：启动ES时将进程ID写入build/elasticsearch.pid文件，停止任务读取该PID来终止进程，确保ES能被正确停止。

注意事项 #

• 确保你的项目使用的Java版本符合Elasticsearch 6.1.1的要求（需要Java 8）。
• 如果你的elasticsearch.yml有特殊配置，比如修改端口、集群名称等，直接调整该文件即可，任务会自动使用最新配置。
• 首次运行时Gradle会自动下载ES压缩包，可能需要几分钟时间，后续构建会复用缓存，速度会快很多。

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