forked from opensearch-project/OpenSearch
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Simplify distribution download and extraction (7.x backport) (#61184)
We leverage artifact transforms now when downloading and unpacking elasticsearch distributions. This has the benefit of - handcrafted extract tasks on the root project are not required. - the general tight coupling to the root project has been removed. - the overall required configurations required to handle a distribution have been reduced - ElasticsearchDistribution has been simplified by making Extracted an ordinary Configuration downloaded and unpacked external distributions are reused in later builds by been cached in the gradle user home. DistributionDownloadPlugin functional tests have been extended and ported to DistributionDownloadPluginFuncTest. * Fix java8 compliant Path calculation
- Loading branch information
Showing
20 changed files
with
376 additions
and
568 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
179 changes: 179 additions & 0 deletions
179
...c/src/integTest/groovy/org/elasticsearch/gradle/DistributionDownloadPluginFuncTest.groovy
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,179 @@ | ||
| /* | ||
| * Licensed to Elasticsearch under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch licenses this file to you under | ||
| * the Apache License, Version 2.0 (the "License"); you may | ||
| * not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| package org.elasticsearch.gradle | ||
|
|
||
| import com.github.tomakehurst.wiremock.WireMockServer | ||
| import org.elasticsearch.gradle.fixtures.AbstractGradleFuncTest | ||
| import org.elasticsearch.gradle.fixtures.WiremockFixture | ||
| import org.elasticsearch.gradle.transform.SymbolicLinkPreservingUntarTransform | ||
| import org.gradle.testkit.runner.TaskOutcome | ||
| import spock.lang.Unroll | ||
|
|
||
| class DistributionDownloadPluginFuncTest extends AbstractGradleFuncTest { | ||
|
|
||
| @Unroll | ||
| def "#distType version can be resolved"() { | ||
| given: | ||
| def mockRepoUrl = urlPath(version, platform) | ||
| def mockedContent = filebytes(mockRepoUrl) | ||
|
|
||
| buildFile << applyPluginAndSetupDistro(version, platform) | ||
|
|
||
| when: | ||
| def result = WiremockFixture.withWireMock(mockRepoUrl, mockedContent) { server -> | ||
| buildFile << repositoryMockSetup(server) | ||
| gradleRunner('setupDistro').build() | ||
| } | ||
|
|
||
| then: | ||
| result.task(":setupDistro").outcome == TaskOutcome.SUCCESS | ||
| assertExtractedDistroCreated("build/distro") | ||
|
|
||
| where: | ||
| version | platform | distType | ||
| VersionProperties.getElasticsearch() | "linux" | "current" | ||
| "8.1.0-SNAPSHOT" | "linux" | "bwc" | ||
| "7.0.0" | "windows" | "released" | ||
| } | ||
|
|
||
|
|
||
| def "transformed versions are kept across builds"() { | ||
| given: | ||
| def version = VersionProperties.getElasticsearch() | ||
| def mockRepoUrl = urlPath(version) | ||
| def mockedContent = filebytes(mockRepoUrl) | ||
|
|
||
| buildFile << applyPluginAndSetupDistro(version, 'linux') | ||
| buildFile << """ | ||
| apply plugin:'base' | ||
| """ | ||
|
|
||
|
|
||
| when: | ||
| def result = WiremockFixture.withWireMock(mockRepoUrl, mockedContent) { server -> | ||
| buildFile << repositoryMockSetup(server) | ||
| gradleRunner('clean', 'setupDistro').build() | ||
| gradleRunner('clean', 'setupDistro', '-i').build() | ||
| } | ||
|
|
||
| then: | ||
| result.task(":setupDistro").outcome == TaskOutcome.SUCCESS | ||
| assertOutputContains(result.output, "Skipping ${SymbolicLinkPreservingUntarTransform.class.simpleName}") | ||
| } | ||
|
|
||
| def "transforms are reused across projects"() { | ||
| given: | ||
| def version = VersionProperties.getElasticsearch() | ||
| def mockRepoUrl = urlPath(version) | ||
| def mockedContent = filebytes(mockRepoUrl) | ||
|
|
||
| 3.times { | ||
| settingsFile << """ | ||
| include ':sub-$it' | ||
| """ | ||
| } | ||
| buildFile.text = """ | ||
| import org.elasticsearch.gradle.Architecture | ||
| plugins { | ||
| id 'elasticsearch.distribution-download' | ||
| } | ||
| subprojects { | ||
| apply plugin: 'elasticsearch.distribution-download' | ||
| ${setupTestDistro(version, 'linux')} | ||
| ${setupDistroTask()} | ||
| } | ||
| """ | ||
|
|
||
| when: | ||
| def result = WiremockFixture.withWireMock(mockRepoUrl, mockedContent) { server -> | ||
| buildFile << repositoryMockSetup(server) | ||
| gradleRunner('setupDistro', '-i', '-g', testProjectDir.newFolder().toString()).build() | ||
| } | ||
|
|
||
| then: | ||
| result.tasks.size() == 3 | ||
| result.output.count("Unpacking elasticsearch-${version}-linux-x86_64.tar.gz using SymbolicLinkPreservingUntarTransform.") == 1 | ||
| } | ||
|
|
||
| private boolean assertExtractedDistroCreated(String relativePath) { | ||
| File distroExtracted = new File(testProjectDir.root, relativePath) | ||
| assert distroExtracted.exists() | ||
| assert distroExtracted.isDirectory() | ||
| assert new File(distroExtracted, "elasticsearch-1.2.3/bin/elasticsearch").exists() | ||
| true | ||
| } | ||
|
|
||
| private static String urlPath(String version, String platform = 'linux') { | ||
| String fileType = platform == "linux" ? "tar.gz" : "zip" | ||
| "/downloads/elasticsearch/elasticsearch-${version}-${platform}-x86_64.$fileType" | ||
| } | ||
|
|
||
| private static String repositoryMockSetup(WireMockServer server) { | ||
| """allprojects{ p -> | ||
| p.repositories.all { repo -> | ||
| repo.setUrl('${server.baseUrl()}') | ||
| } | ||
| }""" | ||
| } | ||
|
|
||
| private static byte[] filebytes(String urlPath) throws IOException { | ||
| String suffix = urlPath.endsWith("zip") ? "zip" : "tar.gz"; | ||
| return DistributionDownloadPluginFuncTest.getResourceAsStream("fake_elasticsearch." + suffix).getBytes() | ||
| } | ||
|
|
||
| private static String applyPluginAndSetupDistro(String version, String platform) { | ||
| """ | ||
| import org.elasticsearch.gradle.Architecture | ||
| plugins { | ||
| id 'elasticsearch.distribution-download' | ||
| } | ||
| ${setupTestDistro(version, platform)} | ||
| ${setupDistroTask()} | ||
| """ | ||
| } | ||
|
|
||
| private static String setupTestDistro(String version, String platform) { | ||
| return """ | ||
| elasticsearch_distributions { | ||
| test_distro { | ||
| version = "$version" | ||
| type = "archive" | ||
| platform = "$platform" | ||
| architecture = Architecture.current(); | ||
| } | ||
| } | ||
| """ | ||
| } | ||
|
|
||
| private static String setupDistroTask() { | ||
| return """ | ||
| tasks.register("setupDistro", Sync) { | ||
| from(elasticsearch_distributions.test_distro.extracted) | ||
| into("build/distro") | ||
| } | ||
| """ | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.