Skip to content

Commit c158859

Browse files
breskebybreskeby
authored
[8.16] Reapply "[Build] Do not invalidate configuration cache when branch is switched (#118894)" (#119300) (#119325) (#119338)
* Reapply "[Build] Do not invalidate configuration cache when branch is switched (#118894)" (#119300) (#119325) * Reapply "[Build] Do not invalidate configuration cache when branch is switched (#118894)" (#119300) The original PR (#118894) has broken serverless. * Fix gitinfo plugin for serverless usage * Update buildscan git revision reference (cherry picked from commit 5278159) # Conflicts: # build-conventions/src/main/java/org/elasticsearch/gradle/internal/conventions/PublishPlugin.java * Fix merge conflict
1 parent 30e418f commit c158859

File tree

19 files changed

+149
-88
lines changed

19 files changed

+149
-88
lines changed

‎build-conventions/src/main/java/org/elasticsearch/gradle/internal/conventions/GitInfoPlugin.java‎

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -10,47 +10,45 @@
1010
package org.elasticsearch.gradle.internal.conventions;
1111

1212
import org.elasticsearch.gradle.internal.conventions.info.GitInfo;
13+
import org.elasticsearch.gradle.internal.conventions.info.GitInfoValueSource;
1314
import org.elasticsearch.gradle.internal.conventions.util.Util;
1415
import org.gradle.api.Plugin;
1516
import org.gradle.api.Project;
16-
import org.gradle.api.model.ObjectFactory;
1717
import org.gradle.api.provider.Property;
1818
import org.gradle.api.provider.Provider;
1919
import org.gradle.api.provider.ProviderFactory;
2020

21-
import javax.inject.Inject;
2221
import java.io.File;
2322

24-
class GitInfoPlugin implements Plugin<Project> {
23+
import javax.inject.Inject;
2524

26-
private ProviderFactory factory;
27-
private ObjectFactory objectFactory;
25+
public abstract class GitInfoPlugin implements Plugin<Project> {
2826

27+
private ProviderFactory factory;
2928
private Provider<String> revision;
30-
private Property<GitInfo> gitInfo;
3129

3230
@Inject
33-
GitInfoPlugin(ProviderFactory factory, ObjectFactory objectFactory) {
31+
public GitInfoPlugin(ProviderFactory factory) {
3432
this.factory = factory;
35-
this.objectFactory = objectFactory;
3633
}
3734

3835
@Override
3936
public void apply(Project project) {
40-
File rootDir = Util.locateElasticsearchWorkspace(project.getGradle());
41-
gitInfo = objectFactory.property(GitInfo.class).value(factory.provider(() ->
42-
GitInfo.gitInfo(rootDir)
43-
));
44-
gitInfo.disallowChanges();
45-
gitInfo.finalizeValueOnRead();
46-
47-
revision = gitInfo.map(info -> info.getRevision() == null ? info.getRevision() : "main");
37+
File rootDir = getGitRootDir(project);
38+
getGitInfo().convention(factory.of(GitInfoValueSource.class, spec -> { spec.getParameters().getPath().set(rootDir); }));
39+
revision = getGitInfo().map(info -> info.getRevision() == null ? info.getRevision() : "main");
4840
}
4941

50-
public Property<GitInfo> getGitInfo() {
51-
return gitInfo;
42+
private static File getGitRootDir(Project project) {
43+
File rootDir = project.getRootDir();
44+
if (new File(rootDir, ".git").exists()) {
45+
return rootDir;
46+
}
47+
return Util.locateElasticsearchWorkspace(project.getGradle());
5248
}
5349

50+
public abstract Property<GitInfo> getGitInfo();
51+
5452
public Provider<String> getRevision() {
5553
return revision;
5654
}

‎build-conventions/src/main/java/org/elasticsearch/gradle/internal/conventions/LicensingPlugin.java‎

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,10 @@
1515
import org.gradle.api.provider.Provider;
1616
import org.gradle.api.provider.ProviderFactory;
1717

18-
import javax.inject.Inject;
1918
import java.util.Map;
2019

20+
import javax.inject.Inject;
21+
2122
public class LicensingPlugin implements Plugin<Project> {
2223
static final String ELASTIC_LICENSE_URL_PREFIX = "https://raw.githubusercontent.com/elastic/elasticsearch/";
2324
static final String ELASTIC_LICENSE_URL_POSTFIX = "/licenses/ELASTIC-LICENSE-2.0.txt";
@@ -33,24 +34,33 @@ public LicensingPlugin(ProviderFactory providerFactory) {
3334
@Override
3435
public void apply(Project project) {
3536
Provider<String> revision = project.getRootProject().getPlugins().apply(GitInfoPlugin.class).getRevision();
36-
Provider<String> licenseCommitProvider = providerFactory.provider(() ->
37-
isSnapshotVersion(project) ? revision.get() : "v" + project.getVersion()
37+
Provider<String> licenseCommitProvider = providerFactory.provider(
38+
() -> isSnapshotVersion(project) ? revision.get() : "v" + project.getVersion()
3839
);
3940

40-
Provider<String> elasticLicenseURL = licenseCommitProvider.map(licenseCommit -> ELASTIC_LICENSE_URL_PREFIX +
41-
licenseCommit + ELASTIC_LICENSE_URL_POSTFIX);
42-
Provider<String> agplLicenseURL = licenseCommitProvider.map(licenseCommit -> ELASTIC_LICENSE_URL_PREFIX +
43-
licenseCommit + AGPL_ELASTIC_LICENSE_URL_POSTFIX);
41+
Provider<String> elasticLicenseURL = licenseCommitProvider.map(
42+
licenseCommit -> ELASTIC_LICENSE_URL_PREFIX + licenseCommit + ELASTIC_LICENSE_URL_POSTFIX
43+
);
44+
Provider<String> agplLicenseURL = licenseCommitProvider.map(
45+
licenseCommit -> ELASTIC_LICENSE_URL_PREFIX + licenseCommit + AGPL_ELASTIC_LICENSE_URL_POSTFIX
46+
);
4447
// But stick the Elastic license url in project.ext so we can get it if we need to switch to it
4548
project.getExtensions().getExtraProperties().set("elasticLicenseUrl", elasticLicenseURL);
4649

47-
MapProperty<String, String> licensesProperty = project.getObjects().mapProperty(String.class, String.class).convention(
48-
providerFactory.provider(() -> Map.of(
49-
"Server Side Public License, v 1", "https://www.mongodb.com/licensing/server-side-public-license",
50-
"Elastic License 2.0", elasticLicenseURL.get(),
51-
"GNU Affero General Public License Version 3", agplLicenseURL.get())
50+
MapProperty<String, Provider<String>> licensesProperty = project.getObjects()
51+
.mapProperty(String.class, (Class<Provider<String>>) (Class<?>) Provider.class)
52+
.convention(
53+
providerFactory.provider(
54+
() -> Map.of(
55+
"Server Side Public License, v 1",
56+
providerFactory.provider(() -> "https://www.mongodb.com/licensing/server-side-public-license"),
57+
"Elastic License 2.0",
58+
elasticLicenseURL,
59+
"GNU Affero General Public License Version 3",
60+
agplLicenseURL
61+
)
5262
)
53-
);
63+
);
5464

5565
// Default to the SSPL+Elastic dual license
5666
project.getExtensions().getExtraProperties().set("projectLicenses", licensesProperty);

‎build-conventions/src/main/java/org/elasticsearch/gradle/internal/conventions/PublishPlugin.java‎

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
import org.gradle.api.plugins.JavaLibraryPlugin;
3131
import org.gradle.api.plugins.JavaPlugin;
3232
import org.gradle.api.provider.MapProperty;
33+
import org.gradle.api.provider.Provider;
3334
import org.gradle.api.provider.ProviderFactory;
3435
import org.gradle.api.publish.PublishingExtension;
3536
import org.gradle.api.publish.maven.MavenPublication;
@@ -44,6 +45,7 @@
4445
import java.io.File;
4546
import java.util.Map;
4647
import java.util.concurrent.Callable;
48+
4749
import javax.inject.Inject;
4850

4951
public class PublishPlugin implements Plugin<Project> {
@@ -82,15 +84,15 @@ private void configurePublications(Project project) {
8284
}
8385
});
8486
@SuppressWarnings("unchecked")
85-
var projectLicenses = (MapProperty<String, String>) project.getExtensions().getExtraProperties().get("projectLicenses");
87+
var projectLicenses = (MapProperty<String, Provider<String>>) project.getExtensions().getExtraProperties().get("projectLicenses");
8688
publication.getPom().withXml(xml -> {
8789
var node = xml.asNode();
8890
node.appendNode("inceptionYear", "2009");
8991
var licensesNode = node.appendNode("licenses");
9092
projectLicenses.get().entrySet().stream().sorted(Map.Entry.comparingByKey()).forEach(entry -> {
9193
Node license = licensesNode.appendNode("license");
9294
license.appendNode("name", entry.getKey());
93-
license.appendNode("url", entry.getValue());
95+
license.appendNode("url", entry.getValue().get());
9496
license.appendNode("distribution", "repo");
9597
});
9698
var developer = node.appendNode("developers").appendNode("developer");
@@ -143,19 +145,6 @@ private void configurePomGeneration(Project project) {
143145
});
144146
}
145147

146-
/**
147-
* just ensure we put dependencies to the end. more a cosmetic thing than anything else
148-
* */
149-
private void formatDependencies(XmlProvider xml) {
150-
Element rootElement = xml.asElement();
151-
var dependencies = rootElement.getElementsByTagName("dependencies");
152-
if (dependencies.getLength() == 1 && dependencies.item(0) != null) {
153-
org.w3c.dom.Node item = dependencies.item(0);
154-
rootElement.removeChild(item);
155-
rootElement.appendChild(item);
156-
}
157-
}
158-
159148
private void addNameAndDescriptionToPom(Project project, NamedDomainObjectSet<MavenPublication> mavenPublications) {
160149
var name = project.getName();
161150
var description = providerFactory.provider(() -> project.getDescription() != null ? project.getDescription() : "");
@@ -209,4 +198,17 @@ static void configureSourcesJar(Project project) {
209198
project.getTasks().named(BasePlugin.ASSEMBLE_TASK_NAME).configure(t -> t.dependsOn(sourcesJarTask));
210199
});
211200
}
201+
202+
/**
203+
* just ensure we put dependencies to the end. more a cosmetic thing than anything else
204+
* */
205+
private void formatDependencies(XmlProvider xml) {
206+
Element rootElement = xml.asElement();
207+
var dependencies = rootElement.getElementsByTagName("dependencies");
208+
if (dependencies.getLength() == 1 && dependencies.item(0) != null) {
209+
org.w3c.dom.Node item = dependencies.item(0);
210+
rootElement.removeChild(item);
211+
rootElement.appendChild(item);
212+
}
213+
}
212214
}

‎build-conventions/src/main/java/org/elasticsearch/gradle/internal/conventions/info/GitInfo.java‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
import java.util.HashMap;
2323
import java.util.Iterator;
2424
import java.util.Map;
25+
import java.util.Objects;
2526
import java.util.regex.Matcher;
2627
import java.util.regex.Pattern;
2728
import java.util.stream.Collectors;
@@ -190,4 +191,15 @@ public String urlFromOrigin() {
190191
}
191192
}
192193

194+
@Override
195+
public boolean equals(Object o) {
196+
if (o == null || getClass() != o.getClass()) return false;
197+
GitInfo gitInfo = (GitInfo) o;
198+
return Objects.equals(revision, gitInfo.revision) && Objects.equals(origin, gitInfo.origin);
199+
}
200+
201+
@Override
202+
public int hashCode() {
203+
return Objects.hash(revision, origin);
204+
}
193205
}

‎build-conventions/src/main/java/org/elasticsearch/gradle/internal/conventions/info/GitInfoValueSource.java‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
package org.elasticsearch.gradle.internal.conventions.info;
2+
3+
import org.gradle.api.provider.Property;
4+
import org.gradle.api.provider.ValueSource;
5+
import org.gradle.api.provider.ValueSourceParameters;
6+
import org.jetbrains.annotations.Nullable;
7+
8+
import java.io.File;
9+
10+
public abstract class GitInfoValueSource implements ValueSource<GitInfo, GitInfoValueSource.Parameters> {
11+
12+
@Nullable
13+
@Override
14+
public GitInfo obtain() {
15+
File path = getParameters().getPath().get();
16+
return GitInfo.gitInfo(path);
17+
}
18+
19+
public interface Parameters extends ValueSourceParameters {
20+
Property<File> getPath();
21+
}
22+
}

‎build-conventions/src/main/java/org/elasticsearch/gradle/internal/conventions/util/Util.java‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,19 @@
1414
import org.gradle.api.Project;
1515
import org.gradle.api.file.FileTree;
1616
import org.gradle.api.initialization.IncludedBuild;
17+
import org.gradle.api.internal.GradleInternal;
1718
import org.gradle.api.invocation.Gradle;
1819
import org.gradle.api.plugins.JavaPluginExtension;
1920
import org.gradle.api.tasks.SourceSet;
2021
import org.gradle.api.tasks.SourceSetContainer;
2122
import org.gradle.api.tasks.util.PatternFilterable;
2223

23-
import javax.annotation.Nullable;
2424
import java.io.File;
25-
import java.util.Collection;
2625
import java.util.Optional;
2726
import java.util.function.Supplier;
2827

28+
import javax.annotation.Nullable;
29+
2930
public class Util {
3031

3132
public static boolean getBooleanProperty(String property, boolean defaultValue) {
@@ -120,6 +121,14 @@ public static SourceSetContainer getJavaSourceSets(Project project) {
120121
return project.getExtensions().getByType(JavaPluginExtension.class).getSourceSets();
121122
}
122123

124+
public static File getRootFolder(Gradle gradle) {
125+
Gradle parent = gradle.getParent();
126+
if (parent == null) {
127+
return gradle.getRootProject().getRootDir();
128+
}
129+
return getRootFolder(parent);
130+
}
131+
123132
public static File locateElasticsearchWorkspace(Gradle gradle) {
124133
if (gradle.getRootProject().getName().startsWith("build-tools")) {
125134
File buildToolsParent = gradle.getRootProject().getRootDir().getParentFile();

‎build-tools-internal/src/integTest/groovy/org/elasticsearch/gradle/internal/PublishPluginFuncTest.groovy‎

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,8 @@ class PublishPluginFuncTest extends AbstractGradleFuncTest {
4545
file("build/distributions/hello-world-1.0-javadoc.jar").exists()
4646
file("build/distributions/hello-world-1.0-sources.jar").exists()
4747
file("build/distributions/hello-world-1.0.pom").exists()
48-
assertXmlEquals(file("build/distributions/hello-world-1.0.pom").text, """
48+
assertXmlEquals(
49+
file("build/distributions/hello-world-1.0.pom").text, """
4950
<project xmlns="http://maven.apache.org/POM/4.0.0" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
5051
<!-- This module was also published with a richer model, Gradle metadata, -->
5152
<!-- which should be used instead. Do not delete the following line which -->
@@ -130,7 +131,8 @@ class PublishPluginFuncTest extends AbstractGradleFuncTest {
130131
file("build/distributions/hello-world-1.0-javadoc.jar").exists()
131132
file("build/distributions/hello-world-1.0-sources.jar").exists()
132133
file("build/distributions/hello-world-1.0.pom").exists()
133-
assertXmlEquals(file("build/distributions/hello-world-1.0.pom").text, """
134+
assertXmlEquals(
135+
file("build/distributions/hello-world-1.0.pom").text, """
134136
<project xmlns="http://maven.apache.org/POM/4.0.0" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
135137
<modelVersion>4.0.0</modelVersion>
136138
<groupId>org.acme</groupId>
@@ -219,7 +221,8 @@ class PublishPluginFuncTest extends AbstractGradleFuncTest {
219221
file("build/distributions/hello-world-1.0-javadoc.jar").exists()
220222
file("build/distributions/hello-world-1.0-sources.jar").exists()
221223
file("build/distributions/hello-world-1.0.pom").exists()
222-
assertXmlEquals(file("build/distributions/hello-world-1.0.pom").text, """
224+
assertXmlEquals(
225+
file("build/distributions/hello-world-1.0.pom").text, """
223226
<project xmlns="http://maven.apache.org/POM/4.0.0" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
224227
<modelVersion>4.0.0</modelVersion>
225228
<groupId>org.acme</groupId>
@@ -312,7 +315,8 @@ class PublishPluginFuncTest extends AbstractGradleFuncTest {
312315
file("build/distributions/hello-world-plugin-1.0-javadoc.jar").exists()
313316
file("build/distributions/hello-world-plugin-1.0-sources.jar").exists()
314317
file("build/distributions/hello-world-plugin-1.0.pom").exists()
315-
assertXmlEquals(file("build/distributions/hello-world-plugin-1.0.pom").text, """
318+
assertXmlEquals(
319+
file("build/distributions/hello-world-plugin-1.0.pom").text, """
316320
<project xmlns="http://maven.apache.org/POM/4.0.0" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
317321
<!-- This module was also published with a richer model, Gradle metadata, -->
318322
<!-- which should be used instead. Do not delete the following line which -->
@@ -389,7 +393,8 @@ class PublishPluginFuncTest extends AbstractGradleFuncTest {
389393
then:
390394
result.task(":generatePom").outcome == TaskOutcome.SUCCESS
391395
file("build/distributions/hello-world-plugin-2.0.pom").exists()
392-
assertXmlEquals(file("build/distributions/hello-world-plugin-2.0.pom").text, """
396+
assertXmlEquals(
397+
file("build/distributions/hello-world-plugin-2.0.pom").text, """
393398
<project xmlns="http://maven.apache.org/POM/4.0.0" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
394399
<!-- This module was also published with a richer model, Gradle metadata, -->
395400
<!-- which should be used instead. Do not delete the following line which -->
@@ -439,15 +444,15 @@ class PublishPluginFuncTest extends AbstractGradleFuncTest {
439444
// scm info only added for internal builds
440445
internalBuild()
441446
buildFile << """
442-
buildParams.setGitOrigin("https://some-repo.com/repo.git")
447+
buildParams.setGitOrigin(project.providers.provider(() -> "https://some-repo.com/repo.git"))
443448
apply plugin:'elasticsearch.java'
444449
apply plugin:'elasticsearch.publish'
445450
446451
version = "1.0"
447452
group = 'org.acme'
448453
description = "just a test project"
449454
450-
ext.projectLicenses.set(['The Apache Software License, Version 2.0': 'http://www.apache.org/licenses/LICENSE-2.0'])
455+
ext.projectLicenses.set(['The Apache Software License, Version 2.0': project.providers.provider(() -> 'http://www.apache.org/licenses/LICENSE-2.0')])
451456
"""
452457

453458
when:
@@ -456,7 +461,8 @@ class PublishPluginFuncTest extends AbstractGradleFuncTest {
456461
then:
457462
result.task(":generatePom").outcome == TaskOutcome.SUCCESS
458463
file("build/distributions/hello-world-1.0.pom").exists()
459-
assertXmlEquals(file("build/distributions/hello-world-1.0.pom").text, """
464+
assertXmlEquals(
465+
file("build/distributions/hello-world-1.0.pom").text, """
460466
<project xmlns="http://maven.apache.org/POM/4.0.0" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
461467
<!-- This module was also published with a richer model, Gradle metadata, -->
462468
<!-- which should be used instead. Do not delete the following line which -->
@@ -493,15 +499,15 @@ class PublishPluginFuncTest extends AbstractGradleFuncTest {
493499

494500
private boolean assertXmlEquals(String toTest, String expected) {
495501
def diff = DiffBuilder.compare(Input.fromString(expected))
496-
.ignoreWhitespace()
497-
.ignoreComments()
498-
.normalizeWhitespace()
499-
.withTest(Input.fromString(toTest))
500-
.build()
502+
.ignoreWhitespace()
503+
.ignoreComments()
504+
.normalizeWhitespace()
505+
.withTest(Input.fromString(toTest))
506+
.build()
501507
diff.differences.each { difference ->
502508
println difference
503509
}
504-
if(diff.differences.size() > 0) {
510+
if (diff.differences.size() > 0) {
505511
println """ given:
506512
$toTest
507513
"""

0 commit comments

Comments
 (0)