lsm/initializr
1
0
Fork 0
mirror of https://gitee.com/dcren/initializr.git synced 2025-04-05 17:38:06 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Allow to map a Dependency BOM

Browse Source 
This commit allows a BOM to be overridden using a dependency mapping.

Closes gh-1155
This commit is contained in:
Stephane Nicoll 2020-11-30 09:30:50 +01:00
parent 58220dcb1c
commit e77aca2211
8 changed files with 111 additions and 54 deletions
initializr-actuator/src/test/java/io/spring/initializr/actuate/info
DependencyRangesInfoContributorTests.java
initializr-generator-spring/src
main/java/io/spring/initializr/generator/spring/build
DependencyManagementBuildCustomizer.java
test/java/io/spring/initializr/generator/spring/build
DependencyManagementBuildCustomizerTests.java
initializr-metadata/src
main/java/io/spring/initializr/metadata
Dependency.java
test/java/io/spring/initializr/metadata
DependencyTests.javaInitializrMetadataTests.java
support
MetadataBuildItemResolverTests.java
initializr-web/src/test/java/io/spring/initializr/web/support
DefaultDependencyMetadataProviderTests.java

20
initializr-actuator/src/test/java/io/spring/initializr/actuate/info/DependencyRangesInfoContributorTests.java
View File

@ -57,7 +57,7 @@ class DependencyRangesInfoContributorTests {
void dependencyWithRangeOnArtifact() {
Dependency dependency = Dependency.withId("foo", "com.example", "foo", "1.2.3.RELEASE");
dependency.getMappings()
.add(Dependency.Mapping.create("[1.1.0.RELEASE, 1.2.0.RELEASE)", null, "foo2", null, null, null));
.add(Dependency.Mapping.create("[1.1.0.RELEASE, 1.2.0.RELEASE)", null, "foo2", null, null, null, null));
InitializrMetadata metadata = InitializrMetadataTestBuilder.withDefaults().addDependencyGroup("foo", dependency)
.build();
Info info = getInfo(metadata);
@ -68,8 +68,8 @@ class DependencyRangesInfoContributorTests {
void dependencyWithRangeAndBom() {
BillOfMaterials bom = BillOfMaterials.create("com.example", "bom", "1.0.0");
Dependency dependency = Dependency.withId("foo", "com.example", "foo", "1.2.3.RELEASE");
dependency.getMappings().add(
Dependency.Mapping.create("[1.1.0.RELEASE, 1.2.0.RELEASE)", null, null, "0.1.0.RELEASE", null, null));
dependency.getMappings().add(Dependency.Mapping.create("[1.1.0.RELEASE, 1.2.0.RELEASE)", null, null,
"0.1.0.RELEASE", null, null, null));
dependency.setBom("bom");
InitializrMetadata metadata = InitializrMetadataTestBuilder.withDefaults().addBom("bom", bom)
.addDependencyGroup("foo", dependency).build();
@ -96,10 +96,10 @@ class DependencyRangesInfoContributorTests {
@Test
void dependencyWithMappingAndOpenRange() {
Dependency dependency = Dependency.withId("foo", null, null, "0.3.0.RELEASE");
dependency.getMappings().add(
Dependency.Mapping.create("[1.1.0.RELEASE, 1.2.0.RELEASE)", null, null, "0.1.0.RELEASE", null, null));
dependency.getMappings().add(Dependency.Mapping.create("[1.1.0.RELEASE, 1.2.0.RELEASE)", null, null,
"0.1.0.RELEASE", null, null, null));
dependency.getMappings()
.add(Dependency.Mapping.create("1.2.0.RELEASE", null, null, "0.2.0.RELEASE", null, null));
.add(Dependency.Mapping.create("1.2.0.RELEASE", null, null, "0.2.0.RELEASE", null, null, null));
InitializrMetadata metadata = InitializrMetadataTestBuilder.withDefaults()
.addDependencyGroup("test", dependency).build();
Info info = getInfo(metadata);
@ -112,10 +112,10 @@ class DependencyRangesInfoContributorTests {
@Test
void dependencyWithMappingAndNoOpenRange() {
Dependency dependency = Dependency.withId("foo", null, null, "0.3.0.RELEASE");
dependency.getMappings().add(
Dependency.Mapping.create("[1.1.0.RELEASE, 1.2.0.RELEASE)", null, null, "0.1.0.RELEASE", null, null));
dependency.getMappings().add(
Dependency.Mapping.create("[1.2.0.RELEASE, 1.3.0.RELEASE)", null, null, "0.2.0.RELEASE", null, null));
dependency.getMappings().add(Dependency.Mapping.create("[1.1.0.RELEASE, 1.2.0.RELEASE)", null, null,
"0.1.0.RELEASE", null, null, null));
dependency.getMappings().add(Dependency.Mapping.create("[1.2.0.RELEASE, 1.3.0.RELEASE)", null, null,
"0.2.0.RELEASE", null, null, null));
InitializrMetadata metadata = InitializrMetadataTestBuilder.withDefaults()
.addDependencyGroup("test", dependency).build();
Info info = getInfo(metadata);

5
initializr-generator-spring/src/main/java/io/spring/initializr/generator/spring/build/DependencyManagementBuildCustomizer.java
View File

@ -1,5 +1,5 @@
/*
* Copyright 2012-2019 the original author or authors.
* Copyright 2012-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -84,7 +84,8 @@ public class DependencyManagementBuildCustomizer implements BuildCustomizer<Buil
}
private Stream<Dependency> mapDependencies(Build build) {
return build.dependencies().ids().map((id) -> this.metadata.getDependencies().get(id)).filter(Objects::nonNull);
return build.dependencies().ids().map((id) -> this.metadata.getDependencies().get(id)).filter(Objects::nonNull)
.map((dependency) -> dependency.resolve(this.description.getPlatformVersion()));
}
private void resolveBom(Map<String, BillOfMaterials> boms, String bomId, Version requestedVersion) {

22
initializr-generator-spring/src/test/java/io/spring/initializr/generator/spring/build/DependencyManagementBuildCustomizerTests.java
View File

@ -1,5 +1,5 @@
/*
* Copyright 2012-2019 the original author or authors.
* Copyright 2012-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -51,6 +51,22 @@ class DependencyManagementBuildCustomizerTests {
assertThat(build.boms().items()).hasSize(2);
}
@Test
void contributeBomFromMapping() {
Dependency dependency = Dependency.withId("foo");
dependency.getMappings()
.add(Dependency.Mapping.create("[2.4.0,2.5.0-M1)", null, null, null, null, "foo-bom", null));
BillOfMaterials bom = BillOfMaterials.create("com.example", "foo-bom", "1.0.0");
bom.getAdditionalBoms().add("bar-bom");
BillOfMaterials additionalBom = BillOfMaterials.create("com.example", "bar-bom", "1.1.0");
InitializrMetadata metadata = InitializrMetadataTestBuilder.withDefaults().addBom("foo-bom", bom)
.addBom("bar-bom", additionalBom).addDependencyGroup("test", dependency).build();
Build build = createBuild(metadata);
build.dependencies().add(dependency.getId());
customizeBuild(build, metadata);
assertThat(build.boms().items()).hasSize(2);
}
@Test
void contributeRepositories() { // ProjectRequestTests#resolveAdditionalRepositories
Dependency dependency = Dependency.withId("foo");
@ -70,12 +86,12 @@ class DependencyManagementBuildCustomizerTests {
}
private MavenBuild createBuild(InitializrMetadata metadata) {
return new MavenBuild(new MetadataBuildItemResolver(metadata, Version.parse("2.0.0.RELEASE")));
return new MavenBuild(new MetadataBuildItemResolver(metadata, Version.parse("2.4.0")));
}
private void customizeBuild(Build build, InitializrMetadata metadata) {
MutableProjectDescription description = new MutableProjectDescription();
description.setPlatformVersion(Version.parse("2.0.0.RELEASE"));
description.setPlatformVersion(Version.parse("2.4.0"));
new DependencyManagementBuildCustomizer(description, metadata).customize(build);
}

18
initializr-metadata/src/main/java/io/spring/initializr/metadata/Dependency.java
View File

@ -250,6 +250,7 @@ public class Dependency extends MetadataElement implements Describable {
dependency.artifactId = (mapping.artifactId != null) ? mapping.artifactId : this.artifactId;
dependency.version = (mapping.version != null) ? mapping.version : this.version;
dependency.starter = (mapping.starter != null) ? mapping.starter : this.starter;
dependency.bom = (mapping.bom != null) ? mapping.bom : this.bom;
dependency.repository = (mapping.repository != null) ? mapping.repository : this.repository;
dependency.versionRequirement = mapping.range.toString();
dependency.mappings = null;
@ -532,6 +533,12 @@ public class Dependency extends MetadataElement implements Describable {
*/
private Boolean starter;
/**
* The extra Bill of Materials to use for this mapping or {@code null} to use the
* default.
*/
private String bom;
/**
* The extra repository to use for this mapping or {@code null} to use the
* default.
@ -573,6 +580,14 @@ public class Dependency extends MetadataElement implements Describable {
this.starter = starter;
}
public String getBom() {
return this.bom;
}
public void setBom(String bom) {
this.bom = bom;
}
public String getRepository() {
return this.repository;
}
@ -594,13 +609,14 @@ public class Dependency extends MetadataElement implements Describable {
}
public static Mapping create(String range, String groupId, String artifactId, String version, Boolean starter,
String repository) {
String bom, String repository) {
Mapping mapping = new Mapping();
mapping.compatibilityRange = range;
mapping.groupId = groupId;
mapping.artifactId = artifactId;
mapping.version = version;
mapping.starter = starter;
mapping.bom = bom;
mapping.repository = repository;
return mapping;
}

86
initializr-metadata/src/test/java/io/spring/initializr/metadata/DependencyTests.java
View File

@ -148,7 +148,8 @@ class DependencyTests {
@Test
void resolveInvalidMapping() {
Dependency dependency = Dependency.withId("web");
dependency.getMappings().add(Dependency.Mapping.create("foo-bar", null, null, "0.1.0.RELEASE", null, null));
dependency.getMappings()
.add(Dependency.Mapping.create("foo-bar", null, null, "0.1.0.RELEASE", null, null, null));
assertThatExceptionOfType(InvalidInitializrMetadataException.class).isThrownBy(dependency::resolve)
.withMessageContaining("foo-bar");
}
@ -156,8 +157,8 @@ class DependencyTests {
@Test
void resolveVersionRequirement() {
Dependency dependency = Dependency.withId("web");
dependency.getMappings().add(
Dependency.Mapping.create("[1.1.0.RELEASE, 1.2.0.RELEASE)", null, null, "0.1.0.RELEASE", null, null));
dependency.getMappings().add(Dependency.Mapping.create("[1.1.0.RELEASE, 1.2.0.RELEASE)", null, null,
"0.1.0.RELEASE", null, null, null));
dependency.resolve();
Dependency resolved = dependency.resolve(Version.parse("1.1.5.RELEASE"));
assertThat(resolved.getVersionRequirement()).isEqualTo(">=1.1.0.RELEASE and <1.2.0.RELEASE");
@ -170,10 +171,10 @@ class DependencyTests {
dependency.getKeywords().addAll(Arrays.asList("foo", "bar"));
dependency.getAliases().add("the-web");
dependency.getFacets().add("web");
dependency.getMappings().add(
Dependency.Mapping.create("[1.1.0.RELEASE, 1.2.0.RELEASE)", null, null, "0.1.0.RELEASE", null, null));
dependency.getMappings().add(
Dependency.Mapping.create("[1.2.0.RELEASE, 1.3.0.RELEASE)", null, null, "0.2.0.RELEASE", null, null));
dependency.getMappings().add(Dependency.Mapping.create("[1.1.0.RELEASE, 1.2.0.RELEASE)", null, null,
"0.1.0.RELEASE", null, null, null));
dependency.getMappings().add(Dependency.Mapping.create("[1.2.0.RELEASE, 1.3.0.RELEASE)", null, null,
"0.2.0.RELEASE", null, null, null));
dependency.resolve();
validateResolvedWebDependency(dependency.resolve(Version.parse("1.1.5.RELEASE")), "org.springframework.boot",
@ -191,10 +192,10 @@ class DependencyTests {
dependency.getKeywords().addAll(Arrays.asList("foo", "bar"));
dependency.getAliases().add("the-web");
dependency.getFacets().add("web");
dependency.getMappings().add(
Dependency.Mapping.create("[1.1.0.RELEASE, 1.2.0.RELEASE)", "org.spring.boot", null, null, null, null));
dependency.getMappings().add(
Dependency.Mapping.create("[1.2.0.RELEASE, 1.3.0.RELEASE)", null, "starter-web", null, null, null));
dependency.getMappings().add(Dependency.Mapping.create("[1.1.0.RELEASE, 1.2.0.RELEASE)", "org.spring.boot",
null, null, null, null, null));
dependency.getMappings().add(Dependency.Mapping.create("[1.2.0.RELEASE, 1.3.0.RELEASE)", null, "starter-web",
null, null, null, null));
dependency.resolve();
validateResolvedWebDependency(dependency.resolve(Version.parse("1.1.5.RELEASE")), "org.spring.boot",
@ -212,10 +213,10 @@ class DependencyTests {
dependency.getKeywords().addAll(Arrays.asList("foo", "bar"));
dependency.getAliases().add("the-web");
dependency.getFacets().add("web");
dependency.getMappings().add(
Dependency.Mapping.create("[1.1.0.RELEASE, 1.1.x.RELEASE]", null, null, "0.1.0.RELEASE", null, null));
dependency.getMappings().add(Dependency.Mapping.create("[1.1.0.RELEASE, 1.1.x.RELEASE]", null, null,
"0.1.0.RELEASE", null, null, null));
dependency.getMappings().add(Dependency.Mapping.create("[1.1.x.BUILD-SNAPSHOT, 1.2.0.RELEASE)", null, null,
"0.2.0.RELEASE", null, null));
"0.2.0.RELEASE", null, null, null));
dependency.resolve();
dependency.updateCompatibilityRange(new VersionParser(
@ -242,36 +243,57 @@ class DependencyTests {
@Test
void resolveMatchingWithCustomGroupId() {
Dependency dependency = Dependency.withId("foo", "com.acme", "foo", "0.3.0.RELEASE");
dependency.getMappings().add(
Dependency.Mapping.create("[1.1.0.RELEASE, 1.2.0.RELEASE)", null, null, "1.0.0.RELEASE", null, null));
dependency.getMappings().add(Dependency.Mapping.create("[1.1.0.RELEASE, 1.2.0.RELEASE)", null, null,
"1.0.0.RELEASE", null, null, null));
dependency.getMappings()
.add(Dependency.Mapping.create("[1.2.0.RELEASE, 1.3.0.RELEASE)", null, "bar", null, null, null));
.add(Dependency.Mapping.create("[1.2.0.RELEASE, 1.3.0.RELEASE)", null, "bar", null, null, null, null));
dependency.resolve();
validateResolvedDependency(dependency.resolve(Version.parse("1.1.5.RELEASE")), "foo", "com.acme", "foo",
"1.0.0.RELEASE", true, null);
"1.0.0.RELEASE", true, null, null);
validateResolvedDependency(dependency.resolve(Version.parse("1.2.5.RELEASE")), "foo", "com.acme", "bar",
"0.3.0.RELEASE", true, null);
"0.3.0.RELEASE", true, null, null);
}
@Test
void resolveMatchingWithMappingThatDisablesStarter() {
Dependency dependency = Dependency.withId("foo", "com.acme", "foo", "0.3.0.RELEASE");
dependency.getMappings().add(
Dependency.Mapping.create("[1.1.0.RELEASE, 1.2.0.RELEASE)", null, null, "1.0.0.RELEASE", false, null));
dependency.getMappings().add(Dependency.Mapping.create("[1.1.0.RELEASE, 1.2.0.RELEASE)", null, null,
"1.0.0.RELEASE", false, null, null));
dependency.resolve();
validateResolvedDependency(dependency.resolve(Version.parse("1.1.5.RELEASE")), "foo", "com.acme", "foo",
"1.0.0.RELEASE", false, null);
"1.0.0.RELEASE", false, null, null);
}
@Test
void resolveMatchingWithMappingThatEnablesStarter() {
Dependency dependency = Dependency.withId("foo", "com.acme", "foo", "0.3.0.RELEASE");
dependency.setStarter(false);
dependency.getMappings().add(
Dependency.Mapping.create("[1.1.0.RELEASE, 1.2.0.RELEASE)", null, null, "1.0.0.RELEASE", true, null));
dependency.getMappings().add(Dependency.Mapping.create("[1.1.0.RELEASE, 1.2.0.RELEASE)", null, null,
"1.0.0.RELEASE", true, null, null));
dependency.resolve();
validateResolvedDependency(dependency.resolve(Version.parse("1.1.5.RELEASE")), "foo", "com.acme", "foo",
"1.0.0.RELEASE", true, null);
"1.0.0.RELEASE", true, null, null);
}
@Test
void resolveMatchingWithMappingWithCustomBom() {
Dependency dependency = Dependency.withId("foo", "com.acme", "foo", "0.3.0.RELEASE");
dependency.setBom("basic-bom");
dependency.getMappings().add(Dependency.Mapping.create("[1.1.0.RELEASE, 1.2.0.RELEASE)", null, null,
"1.0.0.RELEASE", null, "my-bom", null));
dependency.resolve();
validateResolvedDependency(dependency.resolve(Version.parse("1.1.5.RELEASE")), "foo", "com.acme", "foo",
"1.0.0.RELEASE", true, "my-bom", null);
}
@Test
void resolveMatchingWithMappingWithBom() {
Dependency dependency = Dependency.withId("foo", "com.acme", "foo", "0.3.0.RELEASE");
dependency.getMappings().add(Dependency.Mapping.create("[1.1.0.RELEASE, 1.2.0.RELEASE)", null, null,
"1.0.0.RELEASE", true, "basic-bom", null));
dependency.resolve();
validateResolvedDependency(dependency.resolve(Version.parse("1.1.5.RELEASE")), "foo", "com.acme", "foo",
"1.0.0.RELEASE", true, "basic-bom", null);
}
@Test
@ -279,20 +301,20 @@ class DependencyTests {
Dependency dependency = Dependency.withId("foo", "com.acme", "foo", "0.3.0.RELEASE");
dependency.setRepository("basic-repository");
dependency.getMappings().add(Dependency.Mapping.create("[1.1.0.RELEASE, 1.2.0.RELEASE)", null, null,
"1.0.0.RELEASE", null, "my-repository"));
"1.0.0.RELEASE", null, null, "my-repository"));
dependency.resolve();
validateResolvedDependency(dependency.resolve(Version.parse("1.1.5.RELEASE")), "foo", "com.acme", "foo",
"1.0.0.RELEASE", true, "my-repository");
"1.0.0.RELEASE", true, null, "my-repository");
}
@Test
void resolveMatchingWithMappingWithRepository() {
Dependency dependency = Dependency.withId("foo", "com.acme", "foo", "0.3.0.RELEASE");
dependency.getMappings().add(Dependency.Mapping.create("[1.1.0.RELEASE, 1.2.0.RELEASE)", null, null,
"1.0.0.RELEASE", true, "basic-repository"));
"1.0.0.RELEASE", true, null, "basic-repository"));
dependency.resolve();
validateResolvedDependency(dependency.resolve(Version.parse("1.1.5.RELEASE")), "foo", "com.acme", "foo",
"1.0.0.RELEASE", true, "basic-repository");
"1.0.0.RELEASE", true, null, "basic-repository");
}
@Test
@ -314,19 +336,21 @@ class DependencyTests {
private static void validateResolvedWebDependency(Dependency dependency, String expectedGroupId,
String expectedArtifactId, String expectedVersion, boolean expectedStarter) {
validateResolvedDependency(dependency, "web", expectedGroupId, expectedArtifactId, expectedVersion,
expectedStarter, null);
expectedStarter, null, null);
assertThat(dependency.getKeywords()).hasSize(2);
assertThat(dependency.getAliases()).hasSize(1);
assertThat(dependency.getFacets()).hasSize(1);
}
private static void validateResolvedDependency(Dependency dependency, String id, String expectedGroupId,
String expectedArtifactId, String expectedVersion, boolean expectedStarter, String expectedRepository) {
String expectedArtifactId, String expectedVersion, boolean expectedStarter, String expectedBom,
String expectedRepository) {
assertThat(dependency.getId()).isEqualTo(id);
assertThat(dependency.getGroupId()).isEqualTo(expectedGroupId);
assertThat(dependency.getArtifactId()).isEqualTo(expectedArtifactId);
assertThat(dependency.getVersion()).isEqualTo(expectedVersion);
assertThat(dependency.isStarter()).isEqualTo(expectedStarter);
assertThat(dependency.getBom()).isEqualTo(expectedBom);
assertThat(dependency.getRepository()).isEqualTo(expectedRepository);
}

6
initializr-metadata/src/test/java/io/spring/initializr/metadata/InitializrMetadataTests.java
View File

@ -137,10 +137,10 @@ class InitializrMetadataTests {
bom.getMappings().add(Mapping.create("[1.2.0.RELEASE,1.3.x.RELEASE]", "1.0.0"));
bom.getMappings().add(Mapping.create("1.3.x.BUILD-SNAPSHOT", "1.1.0-BUILD-SNAPSHOT"));
Dependency dependency = Dependency.withId("bar");
dependency.getMappings().add(
Dependency.Mapping.create("[1.3.0.RELEASE, 1.3.x.RELEASE]", null, null, "0.1.0.RELEASE", null, null));
dependency.getMappings().add(Dependency.Mapping.create("[1.3.0.RELEASE, 1.3.x.RELEASE]", null, null,
"0.1.0.RELEASE", null, null, null));
dependency.getMappings()
.add(Dependency.Mapping.create("1.3.x.BUILD-SNAPSHOT", null, null, "0.2.0.RELEASE", null, null));
.add(Dependency.Mapping.create("1.3.x.BUILD-SNAPSHOT", null, null, "0.2.0.RELEASE", null, null, null));
addTestDependencyGroup(metadata, dependency);
metadata.getConfiguration().getEnv().getBoms().put("foo-bom", bom);

4
initializr-metadata/src/test/java/io/spring/initializr/metadata/support/MetadataBuildItemResolverTests.java
View File

@ -65,9 +65,9 @@ class MetadataBuildItemResolverTests {
DependencyGroup group = DependencyGroup.create("test");
Dependency dependency = Dependency.withId("test-dep", "com.example", "test");
dependency.getMappings()
.add(Mapping.create("[1.0.0.RELEASE, 2.0.0.RELEASE)", null, null, "1.0.0.RELEASE", null, null));
.add(Mapping.create("[1.0.0.RELEASE, 2.0.0.RELEASE)", null, null, "1.0.0.RELEASE", null, null, null));
dependency.getMappings()
.add(Mapping.create("2.0.0.RELEASE", "com.example.override", "test-override", null, null, null));
.add(Mapping.create("2.0.0.RELEASE", "com.example.override", "test-override", null, null, null, null));
group.getContent().add(dependency);
metadata.getDependencies().getContent().add(group);
metadata.validate();

4
initializr-web/src/test/java/io/spring/initializr/web/support/DefaultDependencyMetadataProviderTests.java
View File

@ -55,9 +55,9 @@ class DefaultDependencyMetadataProviderTests {
void resolveDependencies() {
Dependency first = Dependency.withId("first", "org.foo", "first");
first.getMappings().add(Dependency.Mapping.create("[1.0.0.RELEASE, 1.1.0.RELEASE)", "org.bar", "second",
"0.1.0.RELEASE", null, null));
"0.1.0.RELEASE", null, null, null));
first.getMappings()
.add(Dependency.Mapping.create("1.1.0.RELEASE", "org.biz", "third", "0.2.0.RELEASE", null, null));
.add(Dependency.Mapping.create("1.1.0.RELEASE", "org.biz", "third", "0.2.0.RELEASE", null, null, null));
Dependency second = Dependency.withId("second", "org.foo", "second");
InitializrMetadata metadata = InitializrMetadataTestBuilder.withDefaults()
.addDependencyGroup("test", first, second).build();