From 5c01aa719c5a33053c2c93783c9a37fbf025bd35 Mon Sep 17 00:00:00 2001 From: Krzysztof Krason Date: Sat, 25 Mar 2023 21:12:06 +0100 Subject: [PATCH 1/2] Fix support for default values in banner placeholders See gh-34764 --- .../springframework/boot/ResourceBanner.java | 46 ++++++++++--------- .../boot/ResourceBannerTests.java | 18 +++++++- 2 files changed, 42 insertions(+), 22 deletions(-) diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/ResourceBanner.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/ResourceBanner.java index a80189bda3..ec8f6c5911 100644 --- a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/ResourceBanner.java +++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/ResourceBanner.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2019 the original author or authors. + * Copyright 2012-2023 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. @@ -19,7 +19,6 @@ package org.springframework.boot; import java.io.PrintStream; import java.nio.charset.Charset; import java.nio.charset.StandardCharsets; -import java.util.ArrayList; import java.util.Collections; import java.util.HashMap; import java.util.List; @@ -33,6 +32,7 @@ import org.springframework.core.env.Environment; import org.springframework.core.env.MapPropertySource; import org.springframework.core.env.MutablePropertySources; import org.springframework.core.env.PropertyResolver; +import org.springframework.core.env.PropertySource; import org.springframework.core.env.PropertySourcesPropertyResolver; import org.springframework.core.io.Resource; import org.springframework.core.log.LogMessage; @@ -45,13 +45,14 @@ import org.springframework.util.StreamUtils; * @author Phillip Webb * @author Vedran Pavic * @author Toshiaki Maki + * @author Krzysztof Krason * @since 1.2.0 */ public class ResourceBanner implements Banner { private static final Log logger = LogFactory.getLog(ResourceBanner.class); - private Resource resource; + private final Resource resource; public ResourceBanner(Resource resource) { Assert.notNull(resource, "Resource must not be null"); @@ -77,18 +78,25 @@ public class ResourceBanner implements Banner { } protected List getPropertyResolvers(Environment environment, Class sourceClass) { - List resolvers = new ArrayList<>(); - resolvers.add(environment); - resolvers.add(getVersionResolver(sourceClass)); - resolvers.add(getAnsiResolver()); - resolvers.add(getTitleResolver(sourceClass)); - return resolvers; + MutablePropertySources propertySources = new MutablePropertySources(); + propertySources.addLast(getEnvironmentSource(environment)); + propertySources.addLast(getTitleSource(sourceClass)); + propertySources.addLast(getAnsiSource()); + propertySources.addLast(getVersionSource(sourceClass)); + return Collections.singletonList(new PropertySourcesPropertyResolver(propertySources)); } - private PropertyResolver getVersionResolver(Class sourceClass) { - MutablePropertySources propertySources = new MutablePropertySources(); - propertySources.addLast(new MapPropertySource("version", getVersionsMap(sourceClass))); - return new PropertySourcesPropertyResolver(propertySources); + private PropertySource getEnvironmentSource(Environment environment) { + return new PropertySource("environment", environment) { + @Override + public Object getProperty(String name) { + return environment.getProperty(name); + } + }; + } + + private MapPropertySource getVersionSource(Class sourceClass) { + return new MapPropertySource("version", getVersionsMap(sourceClass)); } private Map getVersionsMap(Class sourceClass) { @@ -118,19 +126,15 @@ public class ResourceBanner implements Banner { return format ? " (v" + version + ")" : version; } - private PropertyResolver getAnsiResolver() { - MutablePropertySources sources = new MutablePropertySources(); - sources.addFirst(new AnsiPropertySource("ansi", true)); - return new PropertySourcesPropertyResolver(sources); + private AnsiPropertySource getAnsiSource() { + return new AnsiPropertySource("ansi", true); } - private PropertyResolver getTitleResolver(Class sourceClass) { - MutablePropertySources sources = new MutablePropertySources(); + private MapPropertySource getTitleSource(Class sourceClass) { String applicationTitle = getApplicationTitle(sourceClass); Map titleMap = Collections.singletonMap("application.title", (applicationTitle != null) ? applicationTitle : ""); - sources.addFirst(new MapPropertySource("title", titleMap)); - return new PropertySourcesPropertyResolver(sources); + return new MapPropertySource("title", titleMap); } protected String getApplicationTitle(Class sourceClass) { diff --git a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/ResourceBannerTests.java b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/ResourceBannerTests.java index e7aa375bb2..dcd95a13ea 100644 --- a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/ResourceBannerTests.java +++ b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/ResourceBannerTests.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2019 the original author or authors. + * Copyright 2012-2023 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. @@ -40,6 +40,7 @@ import static org.assertj.core.api.Assertions.assertThat; * @author Phillip Webb * @author Vedran Pavic * @author Toshiaki Maki + * @author Krzysztof Krason */ class ResourceBannerTests { @@ -48,6 +49,21 @@ class ResourceBannerTests { AnsiOutput.setEnabled(Enabled.DETECT); } + @Test + void doNotUseDefaultsIfValueExists() { + Resource resource = new ByteArrayResource( + "banner ${a:def} ${spring-boot.version:def} ${application.version:def}".getBytes()); + String banner = printBanner(resource, "10.2", "1.0", null); + assertThat(banner).startsWith("banner 1 10.2 1.0"); + } + + @Test + void useDefaults() { + Resource resource = new ByteArrayResource("banner ${b:def1} ${c:def2} ${d:def3}".getBytes()); + String banner = printBanner(resource, null, null, null); + assertThat(banner).startsWith("banner def1 def2 def3"); + } + @Test void renderVersions() { Resource resource = new ByteArrayResource( From 2d280bb9674e15aba78987ed0f616fd161785889 Mon Sep 17 00:00:00 2001 From: Andy Wilkinson Date: Tue, 28 Mar 2023 09:57:22 +0100 Subject: [PATCH 2/2] Polish "Fix support for default values in banner placeholders" See gh-34764 --- .../springframework/boot/ResourceBanner.java | 15 ++++-------- .../boot/ResourceBannerTests.java | 24 +++++++------------ 2 files changed, 13 insertions(+), 26 deletions(-) diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/ResourceBanner.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/ResourceBanner.java index ec8f6c5911..46108497df 100644 --- a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/ResourceBanner.java +++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/ResourceBanner.java @@ -28,11 +28,11 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.springframework.boot.ansi.AnsiPropertySource; +import org.springframework.core.env.ConfigurableEnvironment; import org.springframework.core.env.Environment; import org.springframework.core.env.MapPropertySource; import org.springframework.core.env.MutablePropertySources; import org.springframework.core.env.PropertyResolver; -import org.springframework.core.env.PropertySource; import org.springframework.core.env.PropertySourcesPropertyResolver; import org.springframework.core.io.Resource; import org.springframework.core.log.LogMessage; @@ -79,22 +79,15 @@ public class ResourceBanner implements Banner { protected List getPropertyResolvers(Environment environment, Class sourceClass) { MutablePropertySources propertySources = new MutablePropertySources(); - propertySources.addLast(getEnvironmentSource(environment)); + if (environment instanceof ConfigurableEnvironment) { + ((ConfigurableEnvironment) environment).getPropertySources().forEach(propertySources::addLast); + } propertySources.addLast(getTitleSource(sourceClass)); propertySources.addLast(getAnsiSource()); propertySources.addLast(getVersionSource(sourceClass)); return Collections.singletonList(new PropertySourcesPropertyResolver(propertySources)); } - private PropertySource getEnvironmentSource(Environment environment) { - return new PropertySource("environment", environment) { - @Override - public Object getProperty(String name) { - return environment.getProperty(name); - } - }; - } - private MapPropertySource getVersionSource(Class sourceClass) { return new MapPropertySource("version", getVersionsMap(sourceClass)); } diff --git a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/ResourceBannerTests.java b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/ResourceBannerTests.java index dcd95a13ea..9960e78c9b 100644 --- a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/ResourceBannerTests.java +++ b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/ResourceBannerTests.java @@ -49,21 +49,6 @@ class ResourceBannerTests { AnsiOutput.setEnabled(Enabled.DETECT); } - @Test - void doNotUseDefaultsIfValueExists() { - Resource resource = new ByteArrayResource( - "banner ${a:def} ${spring-boot.version:def} ${application.version:def}".getBytes()); - String banner = printBanner(resource, "10.2", "1.0", null); - assertThat(banner).startsWith("banner 1 10.2 1.0"); - } - - @Test - void useDefaults() { - Resource resource = new ByteArrayResource("banner ${b:def1} ${c:def2} ${d:def3}".getBytes()); - String banner = printBanner(resource, null, null, null); - assertThat(banner).startsWith("banner def1 def2 def3"); - } - @Test void renderVersions() { Resource resource = new ByteArrayResource( @@ -142,6 +127,15 @@ class ResourceBannerTests { assertThat(banner).startsWith("banner 1"); } + @Test + void renderWithDefaultValues() { + Resource resource = new ByteArrayResource( + "banner ${a:default-a} ${b:default-b} ${spring-boot.version:default-boot-version} ${application.version:default-application-version}" + .getBytes()); + String banner = printBanner(resource, "10.2", "1.0", null); + assertThat(banner).startsWith("banner 1 default-b 10.2 1.0"); + } + private String printBanner(Resource resource, String bootVersion, String applicationVersion, String applicationTitle) { ResourceBanner banner = new MockResourceBanner(resource, bootVersion, applicationVersion, applicationTitle);