Skip to content

Commit 19d9e3b

Browse files
philwebbphilwebb
committed
Update BOM plugin to support commercial releases
See gh-42333
1 parent 80b1944 commit 19d9e3b

File tree

10 files changed

+419
-88
lines changed

10 files changed

+419
-88
lines changed

‎buildSrc/src/main/java/org/springframework/boot/build/bom/BomExtension.java

Lines changed: 45 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@
6565
import org.springframework.boot.build.bom.Library.VersionAlignment;
6666
import org.springframework.boot.build.bom.bomr.version.DependencyVersion;
6767
import org.springframework.boot.build.mavenplugin.MavenExec;
68+
import org.springframework.boot.build.properties.BuildProperties;
6869
import org.springframework.util.FileCopyUtils;
6970

7071
/**
@@ -74,22 +75,19 @@
7475
*/
7576
public class BomExtension {
7677

78+
private final Project project;
79+
80+
private final UpgradeHandler upgradeHandler;
81+
7782
private final Map<String, DependencyVersion> properties = new LinkedHashMap<>();
7883

7984
private final Map<String, String> artifactVersionProperties = new HashMap<>();
8085

8186
private final List<Library> libraries = new ArrayList<>();
8287

83-
private final UpgradeHandler upgradeHandler;
84-
85-
private final DependencyHandler dependencyHandler;
86-
87-
private final Project project;
88-
89-
public BomExtension(DependencyHandler dependencyHandler, Project project) {
90-
this.dependencyHandler = dependencyHandler;
91-
this.upgradeHandler = project.getObjects().newInstance(UpgradeHandler.class);
88+
public BomExtension(Project project) {
9289
this.project = project;
90+
this.upgradeHandler = project.getObjects().newInstance(UpgradeHandler.class, project);
9391
}
9492

9593
public List<Library> getLibraries() {
@@ -101,8 +99,9 @@ public void upgrade(Action<UpgradeHandler> action) {
10199
}
102100

103101
public Upgrade getUpgrade() {
104-
return new Upgrade(this.upgradeHandler.upgradePolicy, new GitHub(this.upgradeHandler.gitHub.organization,
105-
this.upgradeHandler.gitHub.repository, this.upgradeHandler.gitHub.issueLabels));
102+
GitHubHandler gitHub = this.upgradeHandler.gitHub;
103+
return new Upgrade(this.upgradeHandler.upgradePolicy,
104+
new GitHub(gitHub.organization, gitHub.repository, gitHub.issueLabels));
106105
}
107106

108107
public void library(String name, Action<LibraryHandler> action) {
@@ -191,30 +190,38 @@ private void putArtifactVersionProperty(String groupId, String artifactId, Strin
191190
}
192191

193192
private void addLibrary(Library library) {
193+
DependencyHandler dependencies = this.project.getDependencies();
194194
this.libraries.add(library);
195195
String versionProperty = library.getVersionProperty();
196196
if (versionProperty != null) {
197197
this.properties.put(versionProperty, library.getVersion().getVersion());
198198
}
199199
for (Group group : library.getGroups()) {
200200
for (Module module : group.getModules()) {
201-
putArtifactVersionProperty(group.getId(), module.getName(), module.getClassifier(), versionProperty);
202-
this.dependencyHandler.getConstraints()
203-
.add(JavaPlatformPlugin.API_CONFIGURATION_NAME, createDependencyNotation(group.getId(),
204-
module.getName(), library.getVersion().getVersion()));
201+
addModule(library, dependencies, versionProperty, group, module);
205202
}
206203
for (String bomImport : group.getBoms()) {
207-
putArtifactVersionProperty(group.getId(), bomImport, versionProperty);
208-
String bomDependency = createDependencyNotation(group.getId(), bomImport,
209-
library.getVersion().getVersion());
210-
this.dependencyHandler.add(JavaPlatformPlugin.API_CONFIGURATION_NAME,
211-
this.dependencyHandler.platform(bomDependency));
212-
this.dependencyHandler.add(BomPlugin.API_ENFORCED_CONFIGURATION_NAME,
213-
this.dependencyHandler.enforcedPlatform(bomDependency));
204+
addBomImport(library, dependencies, versionProperty, group, bomImport);
214205
}
215206
}
216207
}
217208

209+
private void addModule(Library library, DependencyHandler dependencies, String versionProperty, Group group,
210+
Module module) {
211+
putArtifactVersionProperty(group.getId(), module.getName(), module.getClassifier(), versionProperty);
212+
String constraint = createDependencyNotation(group.getId(), module.getName(),
213+
library.getVersion().getVersion());
214+
dependencies.getConstraints().add(JavaPlatformPlugin.API_CONFIGURATION_NAME, constraint);
215+
}
216+
217+
private void addBomImport(Library library, DependencyHandler dependencies, String versionProperty, Group group,
218+
String bomImport) {
219+
putArtifactVersionProperty(group.getId(), bomImport, versionProperty);
220+
String bomDependency = createDependencyNotation(group.getId(), bomImport, library.getVersion().getVersion());
221+
dependencies.add(JavaPlatformPlugin.API_CONFIGURATION_NAME, dependencies.platform(bomDependency));
222+
dependencies.add(BomPlugin.API_ENFORCED_CONFIGURATION_NAME, dependencies.enforcedPlatform(bomDependency));
223+
}
224+
218225
public static class LibraryHandler {
219226

220227
private final List<Group> groups = new ArrayList<>();
@@ -421,7 +428,12 @@ public static class UpgradeHandler {
421428

422429
private UpgradePolicy upgradePolicy;
423430

424-
private final GitHubHandler gitHub = new GitHubHandler();
431+
private final GitHubHandler gitHub;
432+
433+
@Inject
434+
public UpgradeHandler(Project project) {
435+
this.gitHub = new GitHubHandler(project);
436+
}
425437

426438
public void setPolicy(UpgradePolicy upgradePolicy) {
427439
this.upgradePolicy = upgradePolicy;
@@ -456,12 +468,18 @@ public GitHub getGitHub() {
456468

457469
public static class GitHubHandler {
458470

459-
private String organization = "spring-projects";
471+
private String organization;
460472

461-
private String repository = "spring-boot";
473+
private String repository;
462474

463475
private List<String> issueLabels;
464476

477+
public GitHubHandler(Project project) {
478+
BuildProperties buildProperties = BuildProperties.get(project);
479+
this.organization = buildProperties.gitHub().organization();
480+
this.repository = buildProperties.gitHub().repository();
481+
}
482+
465483
public void setOrganization(String organization) {
466484
this.organization = organization;
467485
}
@@ -478,9 +496,9 @@ public void setIssueLabels(List<String> issueLabels) {
478496

479497
public static final class GitHub {
480498

481-
private String organization = "spring-projects";
499+
private String organization;
482500

483-
private String repository = "spring-boot";
501+
private String repository;
484502

485503
private final List<String> issueLabels;
486504

‎buildSrc/src/main/java/org/springframework/boot/build/bom/BomPlugin.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2023 the original author or authors.
2+
* Copyright 2012-2024 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -60,8 +60,7 @@ public void apply(Project project) {
6060
JavaPlatformExtension javaPlatform = project.getExtensions().getByType(JavaPlatformExtension.class);
6161
javaPlatform.allowDependencies();
6262
createApiEnforcedConfiguration(project);
63-
BomExtension bom = project.getExtensions()
64-
.create("bom", BomExtension.class, project.getDependencies(), project);
63+
BomExtension bom = project.getExtensions().create("bom", BomExtension.class, project);
6564
CheckBom checkBom = project.getTasks().create("bomrCheck", CheckBom.class, bom);
6665
project.getTasks().named("check").configure((check) -> check.dependsOn(checkBom));
6766
project.getTasks().create("bomrUpgrade", UpgradeBom.class, bom);

‎buildSrc/src/main/java/org/springframework/boot/build/bom/bomr/MavenMetadataVersionResolver.java

Lines changed: 22 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2023 the original author or authors.
2+
* Copyright 2012-2024 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -30,11 +30,15 @@
3030
import javax.xml.xpath.XPathConstants;
3131
import javax.xml.xpath.XPathFactory;
3232

33+
import org.gradle.api.artifacts.repositories.MavenArtifactRepository;
3334
import org.w3c.dom.Document;
3435
import org.w3c.dom.NodeList;
3536
import org.xml.sax.InputSource;
3637

3738
import org.springframework.boot.build.bom.bomr.version.DependencyVersion;
39+
import org.springframework.http.HttpEntity;
40+
import org.springframework.http.HttpHeaders;
41+
import org.springframework.http.HttpMethod;
3842
import org.springframework.http.HttpStatus;
3943
import org.springframework.http.converter.StringHttpMessageConverter;
4044
import org.springframework.web.client.HttpClientErrorException;
@@ -50,42 +54,37 @@ final class MavenMetadataVersionResolver implements VersionResolver {
5054

5155
private final RestTemplate rest;
5256

53-
private final Collection<URI> repositoryUrls;
57+
private final Collection<MavenArtifactRepository> repositories;
5458

55-
MavenMetadataVersionResolver(Collection<URI> repositoryUrls) {
56-
this(new RestTemplate(Collections.singletonList(new StringHttpMessageConverter())), repositoryUrls);
59+
MavenMetadataVersionResolver(Collection<MavenArtifactRepository> repositories) {
60+
this(new RestTemplate(Collections.singletonList(new StringHttpMessageConverter())), repositories);
5761
}
5862

59-
MavenMetadataVersionResolver(RestTemplate restTemplate, Collection<URI> repositoryUrls) {
63+
MavenMetadataVersionResolver(RestTemplate restTemplate, Collection<MavenArtifactRepository> repositories) {
6064
this.rest = restTemplate;
61-
this.repositoryUrls = normalize(repositoryUrls);
62-
}
63-
64-
private Collection<URI> normalize(Collection<URI> uris) {
65-
return uris.stream().map(this::normalize).toList();
66-
}
67-
68-
private URI normalize(URI uri) {
69-
if ("/".equals(uri.getPath())) {
70-
return uri;
71-
}
72-
return URI.create(uri + "/");
65+
this.repositories = repositories;
7366
}
7467

7568
@Override
7669
public SortedSet<DependencyVersion> resolveVersions(String groupId, String artifactId) {
7770
Set<String> versions = new HashSet<>();
78-
for (URI repositoryUrl : this.repositoryUrls) {
79-
versions.addAll(resolveVersions(groupId, artifactId, repositoryUrl));
71+
for (MavenArtifactRepository repository : this.repositories) {
72+
versions.addAll(resolveVersions(groupId, artifactId, repository));
8073
}
8174
return versions.stream().map(DependencyVersion::parse).collect(Collectors.toCollection(TreeSet::new));
8275
}
8376

84-
private Set<String> resolveVersions(String groupId, String artifactId, URI repositoryUrl) {
77+
private Set<String> resolveVersions(String groupId, String artifactId, MavenArtifactRepository repository) {
8578
Set<String> versions = new HashSet<>();
86-
URI url = repositoryUrl.resolve(groupId.replace('.', '/') + "/" + artifactId + "/maven-metadata.xml");
79+
URI url = repository.getUrl().resolve(groupId.replace('.', '/') + "/" + artifactId + "/maven-metadata.xml");
8780
try {
88-
String metadata = this.rest.getForObject(url, String.class);
81+
HttpHeaders headers = new HttpHeaders();
82+
String username = repository.getCredentials().getUsername();
83+
if (username != null) {
84+
headers.setBasicAuth(username, repository.getCredentials().getPassword());
85+
}
86+
HttpEntity<Void> request = new HttpEntity<>(headers);
87+
String metadata = this.rest.exchange(url, HttpMethod.GET, request, String.class).getBody();
8988
Document metadataDocument = DocumentBuilderFactory.newInstance()
9089
.newDocumentBuilder()
9190
.parse(new InputSource(new StringReader(metadata)));
@@ -104,7 +103,7 @@ private Set<String> resolveVersions(String groupId, String artifactId, URI repos
104103
}
105104
catch (Exception ex) {
106105
System.err.println("Failed to resolve versions for module " + groupId + ":" + artifactId + " in repository "
107-
+ repositoryUrl + ": " + ex.getMessage());
106+
+ repository + ": " + ex.getMessage());
108107
}
109108
return versions;
110109
}

‎buildSrc/src/main/java/org/springframework/boot/build/bom/bomr/MoveToSnapshots.java

Lines changed: 37 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2021-2023 the original author or authors.
2+
* Copyright 2021-2024 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -16,8 +16,8 @@
1616

1717
package org.springframework.boot.build.bom.bomr;
1818

19-
import java.net.URI;
2019
import java.time.OffsetDateTime;
20+
import java.util.Arrays;
2121
import java.util.List;
2222
import java.util.Map;
2323
import java.util.function.BiPredicate;
@@ -34,6 +34,10 @@
3434
import org.springframework.boot.build.bom.bomr.ReleaseSchedule.Release;
3535
import org.springframework.boot.build.bom.bomr.github.Milestone;
3636
import org.springframework.boot.build.bom.bomr.version.DependencyVersion;
37+
import org.springframework.boot.build.properties.BuildProperties;
38+
import org.springframework.boot.build.properties.BuildType;
39+
import org.springframework.boot.build.repository.SpringRepository;
40+
import org.springframework.boot.build.repository.SpringRepository.RepositoryType;
3741

3842
/**
3943
* A {@link Task} to move to snapshot dependencies.
@@ -44,12 +48,20 @@ public abstract class MoveToSnapshots extends UpgradeDependencies {
4448

4549
private static final Logger log = LoggerFactory.getLogger(MoveToSnapshots.class);
4650

47-
private final URI REPOSITORY_URI = URI.create("https://repo.spring.io/snapshot/");
48-
4951
@Inject
5052
public MoveToSnapshots(BomExtension bom) {
5153
super(bom, true);
52-
getRepositoryUris().add(this.REPOSITORY_URI);
54+
BuildType buildType = BuildProperties.get(this).buildType();
55+
getRepositoryNames().addAll(getSnapshotRepositoryNames(buildType));
56+
}
57+
58+
public static List<String> getSnapshotRepositoryNames(BuildType buildType) {
59+
return Arrays.stream(SpringRepository.values())
60+
.filter((repository) -> repository.getRepositoryType() == RepositoryType.SNAPSHOT)
61+
.filter((repository) -> repository.getBuildType() == BuildType.OPEN_SOURCE
62+
|| repository.getBuildType() == buildType)
63+
.map(SpringRepository::getName)
64+
.toList();
5365
}
5466

5567
@Override
@@ -83,26 +95,31 @@ protected boolean eligible(Library library) {
8395

8496
@Override
8597
protected List<BiPredicate<Library, DependencyVersion>> determineUpdatePredicates(Milestone milestone) {
86-
ReleaseSchedule releaseSchedule = new ReleaseSchedule();
87-
Map<String, List<Release>> releases = releaseSchedule.releasesBetween(OffsetDateTime.now(),
88-
milestone.getDueOn());
98+
return switch (BuildProperties.get(this).buildType()) {
99+
case OPEN_SOURCE -> determineOpenSourceUpdatePredicates(milestone);
100+
case COMMERCIAL -> super.determineUpdatePredicates(milestone);
101+
};
102+
}
103+
104+
private List<BiPredicate<Library, DependencyVersion>> determineOpenSourceUpdatePredicates(Milestone milestone) {
105+
Map<String, List<Release>> scheduledReleases = getScheduledOpenSourceReleases(milestone);
89106
List<BiPredicate<Library, DependencyVersion>> predicates = super.determineUpdatePredicates(milestone);
90107
predicates.add((library, candidate) -> {
91-
List<Release> releasesForLibrary = releases.get(library.getCalendarName());
92-
if (releasesForLibrary != null) {
93-
for (Release release : releasesForLibrary) {
94-
if (candidate.isSnapshotFor(release.getVersion())) {
95-
return true;
96-
}
97-
}
98-
}
99-
if (log.isInfoEnabled()) {
100-
log.info("Ignoring " + candidate + ". No release of " + library.getName() + " scheduled before "
101-
+ milestone.getDueOn());
108+
List<Release> releases = scheduledReleases.get(library.getCalendarName());
109+
boolean match = (releases != null)
110+
&& releases.stream().anyMatch((release) -> candidate.isSnapshotFor(release.getVersion()));
111+
if (log.isInfoEnabled() && !match) {
112+
log.info("Ignoring {}. No release of {} scheduled before {}", candidate, library.getName(),
113+
milestone.getDueOn());
102114
}
103-
return false;
115+
return match;
104116
});
105117
return predicates;
106118
}
107119

120+
private Map<String, List<Release>> getScheduledOpenSourceReleases(Milestone milestone) {
121+
ReleaseSchedule releaseSchedule = new ReleaseSchedule();
122+
return releaseSchedule.releasesBetween(OffsetDateTime.now(), milestone.getDueOn());
123+
}
124+
108125
}

0 commit comments

Comments
 (0)