Merge pull request #29896 from gcoppex
* pr/29896: Polish "Clarify log message with a profile containing a comma" Clarify log message with a profile containing a comma Closes gh-29896
This commit is contained in:
commit
ca23c68b1c
|
@ -27,6 +27,7 @@ import java.util.List;
|
|||
import java.util.Map;
|
||||
import java.util.Properties;
|
||||
import java.util.Set;
|
||||
import java.util.stream.Collectors;
|
||||
|
||||
import org.apache.commons.logging.Log;
|
||||
import org.apache.commons.logging.LogFactory;
|
||||
|
@ -666,19 +667,26 @@ public class SpringApplication {
|
|||
protected void logStartupProfileInfo(ConfigurableApplicationContext context) {
|
||||
Log log = getApplicationLog();
|
||||
if (log.isInfoEnabled()) {
|
||||
String[] activeProfiles = context.getEnvironment().getActiveProfiles();
|
||||
List<String> activeProfiles = quoteProfiles(context.getEnvironment().getActiveProfiles());
|
||||
if (ObjectUtils.isEmpty(activeProfiles)) {
|
||||
String[] defaultProfiles = context.getEnvironment().getDefaultProfiles();
|
||||
log.info("No active profile set, falling back to default profiles: "
|
||||
+ StringUtils.arrayToCommaDelimitedString(defaultProfiles));
|
||||
List<String> defaultProfiles = quoteProfiles(context.getEnvironment().getDefaultProfiles());
|
||||
String message = String.format("%s default %s: ", defaultProfiles.size(),
|
||||
(defaultProfiles.size() <= 1) ? "profile" : "profiles");
|
||||
log.info("No active profile set, falling back to " + message
|
||||
+ StringUtils.collectionToDelimitedString(defaultProfiles, ", "));
|
||||
}
|
||||
else {
|
||||
log.info("The following profiles are active: "
|
||||
+ StringUtils.arrayToCommaDelimitedString(activeProfiles));
|
||||
String message = (activeProfiles.size() == 1) ? "1 profile is active: "
|
||||
: activeProfiles.size() + " profiles are active: ";
|
||||
log.info("The following " + message + StringUtils.collectionToDelimitedString(activeProfiles, ", "));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private List<String> quoteProfiles(String[] profiles) {
|
||||
return Arrays.stream(profiles).map((profile) -> "\"" + profile + "\"").collect(Collectors.toList());
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the {@link Log} for the application. By default will be deduced.
|
||||
* @return the application log
|
||||
|
|
|
@ -249,19 +249,40 @@ class SpringApplicationTests {
|
|||
}
|
||||
|
||||
@Test
|
||||
void logsNoActiveProfiles(CapturedOutput output) {
|
||||
void logsActiveProfilesWithoutProfileAndSingleDefault(CapturedOutput output) {
|
||||
SpringApplication application = new SpringApplication(ExampleConfig.class);
|
||||
application.setWebApplicationType(WebApplicationType.NONE);
|
||||
this.context = application.run();
|
||||
assertThat(output).contains("No active profile set, falling back to default profiles: default");
|
||||
assertThat(output).contains("No active profile set, falling back to 1 default profile: \"default\"");
|
||||
}
|
||||
|
||||
@Test
|
||||
void logsActiveProfiles(CapturedOutput output) {
|
||||
void logsActiveProfilesWithoutProfileAndMultipleDefaults(CapturedOutput output) {
|
||||
MockEnvironment environment = new MockEnvironment();
|
||||
environment.setDefaultProfiles("p0,p1", "default");
|
||||
SpringApplication application = new SpringApplication(ExampleConfig.class);
|
||||
application.setWebApplicationType(WebApplicationType.NONE);
|
||||
application.setEnvironment(environment);
|
||||
this.context = application.run();
|
||||
assertThat(output)
|
||||
.contains("No active profile set, falling back to 2 default profiles: \"p0,p1\", \"default\"");
|
||||
}
|
||||
|
||||
@Test
|
||||
void logsActiveProfilesWithSingleProfile(CapturedOutput output) {
|
||||
SpringApplication application = new SpringApplication(ExampleConfig.class);
|
||||
application.setWebApplicationType(WebApplicationType.NONE);
|
||||
this.context = application.run("--spring.profiles.active=myprofiles");
|
||||
assertThat(output).contains("The following profiles are active: myprofile");
|
||||
assertThat(output).contains("The following 1 profile is active: \"myprofiles\"");
|
||||
}
|
||||
|
||||
@Test
|
||||
void logsActiveProfilesWithMultipleProfiles(CapturedOutput output) {
|
||||
SpringApplication application = new SpringApplication(ExampleConfig.class);
|
||||
application.setWebApplicationType(WebApplicationType.NONE);
|
||||
application.setAdditionalProfiles("p1,p2", "p3");
|
||||
application.run();
|
||||
assertThat(output).contains("The following 2 profiles are active: \"p1,p2\", \"p3\"");
|
||||
}
|
||||
|
||||
@Test
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* Copyright 2012-2021 the original author or authors.
|
||||
* Copyright 2012-2022 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.
|
||||
|
@ -815,8 +815,8 @@ class ConfigFileApplicationListenerTests {
|
|||
assertThat(environment).has(matchingProfile("morespecific"));
|
||||
assertThat(environment).has(matchingProfile("yetmorespecific"));
|
||||
assertThat(environment).doesNotHave(matchingProfile("missing"));
|
||||
assertThat(output)
|
||||
.contains("The following profiles are active: includeprofile,specific,morespecific,yetmorespecific");
|
||||
assertThat(output).contains(
|
||||
"The following 4 profiles are active: \"includeprofile\", \"specific\", \"morespecific\", \"yetmorespecific\"");
|
||||
}
|
||||
|
||||
@Test
|
||||
|
|
Loading…
Reference in New Issue