Commit d123c924 authored by Phillip Webb's avatar Phillip Webb

Add BootstrapRegisty support for config data

Expose the `BootstrapRegisty` to both `ConfigDataLocationResolver` and
`ConfigDataLoader` implementations. The registry is exposed via the
context interfaces and may be used to reuse instances that are expensive
to create. It may also be used to ultimately register beans with the
`ApplicationContext`.

Closes gh-22956
parent 22606577
......@@ -18,6 +18,7 @@ package org.springframework.boot.test.context;
import org.springframework.boot.context.config.ConfigData;
import org.springframework.boot.context.config.ConfigDataEnvironmentPostProcessor;
import org.springframework.boot.env.DefaultBootstrapRegisty;
import org.springframework.boot.env.DefaultPropertiesPropertySource;
import org.springframework.boot.env.RandomValuePropertySource;
import org.springframework.context.ApplicationContextInitializer;
......@@ -41,7 +42,9 @@ public class ConfigDataApplicationContextInitializer
public void initialize(ConfigurableApplicationContext applicationContext) {
ConfigurableEnvironment environment = applicationContext.getEnvironment();
RandomValuePropertySource.addToEnvironment(environment);
ConfigDataEnvironmentPostProcessor.applyTo(environment, applicationContext);
DefaultBootstrapRegisty bootstrapRegistry = new DefaultBootstrapRegisty();
ConfigDataEnvironmentPostProcessor.applyTo(environment, applicationContext, bootstrapRegistry);
bootstrapRegistry.applicationContextPrepared(applicationContext);
DefaultPropertiesPropertySource.moveToEnd(environment);
}
......
......@@ -25,6 +25,7 @@ import org.apache.commons.logging.Log;
import org.springframework.boot.context.config.ConfigDataEnvironmentContributors.BinderOption;
import org.springframework.boot.context.properties.bind.BindException;
import org.springframework.boot.context.properties.bind.Binder;
import org.springframework.boot.env.BootstrapRegistry;
import org.springframework.boot.env.DefaultPropertiesPropertySource;
import org.springframework.boot.logging.DeferredLogFactory;
import org.springframework.core.env.ConfigurableEnvironment;
......@@ -77,6 +78,8 @@ class ConfigDataEnvironment {
private final Log logger;
private final BootstrapRegistry bootstrapRegistry;
private final ConfigurableEnvironment environment;
private final ConfigDataLocationResolvers resolvers;
......@@ -90,16 +93,18 @@ class ConfigDataEnvironment {
/**
* Create a new {@link ConfigDataEnvironment} instance.
* @param logFactory the deferred log factory
* @param bootstrapRegistry the bootstrap registry
* @param environment the Spring {@link Environment}.
* @param resourceLoader {@link ResourceLoader} to load resource locations
* @param additionalProfiles any additional profiles to activate
*/
ConfigDataEnvironment(DeferredLogFactory logFactory, ConfigurableEnvironment environment,
ResourceLoader resourceLoader, Collection<String> additionalProfiles) {
ConfigDataEnvironment(DeferredLogFactory logFactory, BootstrapRegistry bootstrapRegistry,
ConfigurableEnvironment environment, ResourceLoader resourceLoader, Collection<String> additionalProfiles) {
Binder binder = Binder.get(environment);
UseLegacyConfigProcessingException.throwIfRequested(binder);
this.logFactory = logFactory;
this.logger = logFactory.getLog(getClass());
this.bootstrapRegistry = bootstrapRegistry;
this.environment = environment;
this.resolvers = createConfigDataLocationResolvers(logFactory, binder, resourceLoader);
this.additionalProfiles = additionalProfiles;
......@@ -132,7 +137,7 @@ class ConfigDataEnvironment {
this.logger.trace("Creating wrapped config data contributor for default property source");
contributors.add(ConfigDataEnvironmentContributor.ofExisting(defaultPropertySource));
}
return new ConfigDataEnvironmentContributors(this.logFactory, contributors);
return new ConfigDataEnvironmentContributors(this.logFactory, this.bootstrapRegistry, contributors);
}
ConfigDataEnvironmentContributors getContributors() {
......
......@@ -36,6 +36,7 @@ import org.springframework.boot.context.properties.bind.Binder;
import org.springframework.boot.context.properties.bind.PlaceholdersResolver;
import org.springframework.boot.context.properties.source.ConfigurationPropertyName;
import org.springframework.boot.context.properties.source.ConfigurationPropertySource;
import org.springframework.boot.env.BootstrapRegistry;
import org.springframework.boot.logging.DeferredLogFactory;
import org.springframework.core.log.LogMessage;
import org.springframework.util.ObjectUtils;
......@@ -53,19 +54,25 @@ class ConfigDataEnvironmentContributors implements Iterable<ConfigDataEnvironmen
private final ConfigDataEnvironmentContributor root;
private final BootstrapRegistry bootstrapRegistry;
/**
* Create a new {@link ConfigDataEnvironmentContributors} instance.
* @param logFactory the log factory
* @param bootstrapRegistry the bootstrap registry
* @param contributors the initial set of contributors
*/
ConfigDataEnvironmentContributors(DeferredLogFactory logFactory,
ConfigDataEnvironmentContributors(DeferredLogFactory logFactory, BootstrapRegistry bootstrapRegistry,
List<ConfigDataEnvironmentContributor> contributors) {
this.logger = logFactory.getLog(getClass());
this.bootstrapRegistry = bootstrapRegistry;
this.root = ConfigDataEnvironmentContributor.of(contributors);
}
private ConfigDataEnvironmentContributors(Log logger, ConfigDataEnvironmentContributor root) {
private ConfigDataEnvironmentContributors(Log logger, BootstrapRegistry bootstrapRegistry,
ConfigDataEnvironmentContributor root) {
this.logger = logger;
this.bootstrapRegistry = bootstrapRegistry;
this.root = root;
}
......@@ -91,22 +98,27 @@ class ConfigDataEnvironmentContributors implements Iterable<ConfigDataEnvironmen
this.logger.trace(LogMessage.format("Processed imports for of %d contributors", processedCount));
return result;
}
ConfigDataLocationResolverContext locationResolverContext = new ContributorLocationResolverContext(result,
unprocessed, activationContext);
ConfigDataLocationResolverContext locationResolverContext = new ContributorConfigDataLocationResolverContext(
result, unprocessed, activationContext);
ConfigDataLoaderContext loaderContext = new ContributorDataLoaderContext(this);
List<String> imports = unprocessed.getImports();
this.logger.trace(LogMessage.format("Processing imports %s", imports));
Map<ConfigDataLocation, ConfigData> imported = importer.resolveAndLoad(activationContext,
locationResolverContext, imports);
locationResolverContext, loaderContext, imports);
this.logger.trace(LogMessage.of(() -> imported.isEmpty() ? "Nothing imported" : "Imported "
+ imported.size() + " location " + ((imported.size() != 1) ? "s" : "") + imported.keySet()));
ConfigDataEnvironmentContributor processed = unprocessed.withChildren(importPhase,
asContributors(activationContext, imported));
result = new ConfigDataEnvironmentContributors(this.logger,
result = new ConfigDataEnvironmentContributors(this.logger, this.bootstrapRegistry,
result.getRoot().withReplacement(unprocessed, processed));
processedCount++;
}
}
protected final BootstrapRegistry getBootstrapRegistry() {
return this.bootstrapRegistry;
}
private ConfigDataEnvironmentContributor getFirstUnprocessed(ConfigDataEnvironmentContributors contributors,
ConfigDataActivationContext activationContext, ImportPhase importPhase) {
for (ConfigDataEnvironmentContributor contributor : contributors.getRoot()) {
......@@ -177,10 +189,27 @@ class ConfigDataEnvironmentContributors implements Iterable<ConfigDataEnvironmen
}
/**
* {@link ConfigDataLocationResolverContext} backed by a
* {@link ConfigDataEnvironmentContributor}.
* {@link ConfigDataLocationResolverContext} for a contributor.
*/
private static class ContributorLocationResolverContext implements ConfigDataLocationResolverContext {
private static class ContributorDataLoaderContext implements ConfigDataLoaderContext {
private final ConfigDataEnvironmentContributors contributors;
ContributorDataLoaderContext(ConfigDataEnvironmentContributors contributors) {
this.contributors = contributors;
}
@Override
public BootstrapRegistry getBootstrapRegistry() {
return this.contributors.getBootstrapRegistry();
}
}
/**
* {@link ConfigDataLocationResolverContext} for a contributor.
*/
private static class ContributorConfigDataLocationResolverContext implements ConfigDataLocationResolverContext {
private final ConfigDataEnvironmentContributors contributors;
......@@ -190,7 +219,7 @@ class ConfigDataEnvironmentContributors implements Iterable<ConfigDataEnvironmen
private volatile Binder binder;
ContributorLocationResolverContext(ConfigDataEnvironmentContributors contributors,
ContributorConfigDataLocationResolverContext(ConfigDataEnvironmentContributors contributors,
ConfigDataEnvironmentContributor contributor, ConfigDataActivationContext activationContext) {
this.contributors = contributors;
this.contributor = contributor;
......@@ -212,6 +241,11 @@ class ConfigDataEnvironmentContributors implements Iterable<ConfigDataEnvironmen
return this.contributor.getLocation();
}
@Override
public BootstrapRegistry getBootstrapRegistry() {
return this.contributors.getBootstrapRegistry();
}
}
private class InactiveSourceChecker implements BindHandler {
......
......@@ -24,6 +24,8 @@ import java.util.function.Supplier;
import org.apache.commons.logging.Log;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.env.BootstrapRegistry;
import org.springframework.boot.env.DefaultBootstrapRegisty;
import org.springframework.boot.env.EnvironmentPostProcessor;
import org.springframework.boot.logging.DeferredLogFactory;
import org.springframework.core.Ordered;
......@@ -52,9 +54,12 @@ public class ConfigDataEnvironmentPostProcessor implements EnvironmentPostProces
private final Log logger;
public ConfigDataEnvironmentPostProcessor(DeferredLogFactory logFactory) {
private final BootstrapRegistry bootstrapRegistry;
public ConfigDataEnvironmentPostProcessor(DeferredLogFactory logFactory, BootstrapRegistry bootstrapRegistry) {
this.logFactory = logFactory;
this.logger = logFactory.getLog(getClass());
this.bootstrapRegistry = bootstrapRegistry;
}
@Override
......@@ -83,7 +88,8 @@ public class ConfigDataEnvironmentPostProcessor implements EnvironmentPostProces
ConfigDataEnvironment getConfigDataEnvironment(ConfigurableEnvironment environment, ResourceLoader resourceLoader,
Collection<String> additionalProfiles) {
return new ConfigDataEnvironment(this.logFactory, environment, resourceLoader, additionalProfiles);
return new ConfigDataEnvironment(this.logFactory, this.bootstrapRegistry, environment, resourceLoader,
additionalProfiles);
}
private void postProcessUsingLegacyApplicationListener(ConfigurableEnvironment environment,
......@@ -103,7 +109,7 @@ public class ConfigDataEnvironmentPostProcessor implements EnvironmentPostProces
* @param environment the environment to apply {@link ConfigData} to
*/
public static void applyTo(ConfigurableEnvironment environment) {
applyTo(environment, null, Collections.emptyList());
applyTo(environment, null, null, Collections.emptyList());
}
/**
......@@ -112,11 +118,13 @@ public class ConfigDataEnvironmentPostProcessor implements EnvironmentPostProces
* directly and not necessarily as part of a {@link SpringApplication}.
* @param environment the environment to apply {@link ConfigData} to
* @param resourceLoader the resource loader to use
* @param bootstrapRegistry the bootstrap registry to use or {@code null} to use a
* throw-away registry
* @param additionalProfiles any additional profiles that should be applied
*/
public static void applyTo(ConfigurableEnvironment environment, ResourceLoader resourceLoader,
String... additionalProfiles) {
applyTo(environment, resourceLoader, Arrays.asList(additionalProfiles));
BootstrapRegistry bootstrapRegistry, String... additionalProfiles) {
applyTo(environment, resourceLoader, bootstrapRegistry, Arrays.asList(additionalProfiles));
}
/**
......@@ -125,13 +133,17 @@ public class ConfigDataEnvironmentPostProcessor implements EnvironmentPostProces
* directly and not necessarily as part of a {@link SpringApplication}.
* @param environment the environment to apply {@link ConfigData} to
* @param resourceLoader the resource loader to use
* @param bootstrapRegistry the bootstrap registry to use or {@code null} to use a
* throw-away registry
* @param additionalProfiles any additional profiles that should be applied
*/
public static void applyTo(ConfigurableEnvironment environment, ResourceLoader resourceLoader,
Collection<String> additionalProfiles) {
new ConfigDataEnvironmentPostProcessor(Supplier::get).postProcessEnvironment(environment, resourceLoader,
additionalProfiles);
BootstrapRegistry bootstrapRegistry, Collection<String> additionalProfiles) {
DeferredLogFactory logFactory = Supplier::get;
bootstrapRegistry = (bootstrapRegistry != null) ? bootstrapRegistry : new DefaultBootstrapRegisty();
ConfigDataEnvironmentPostProcessor postProcessor = new ConfigDataEnvironmentPostProcessor(logFactory,
bootstrapRegistry);
postProcessor.postProcessEnvironment(environment, resourceLoader, additionalProfiles);
}
@SuppressWarnings("deprecation")
......
......@@ -55,26 +55,29 @@ class ConfigDataImporter {
* previously loaded.
* @param activationContext the activation context
* @param locationResolverContext the location resolver context
* @param loaderContext the loader context
* @param locations the locations to resolve
* @return a map of the loaded locations and data
*/
Map<ConfigDataLocation, ConfigData> resolveAndLoad(ConfigDataActivationContext activationContext,
ConfigDataLocationResolverContext locationResolverContext, List<String> locations) {
ConfigDataLocationResolverContext locationResolverContext, ConfigDataLoaderContext loaderContext,
List<String> locations) {
try {
Profiles profiles = (activationContext != null) ? activationContext.getProfiles() : null;
return load(this.resolvers.resolveAll(locationResolverContext, locations, profiles));
return load(loaderContext, this.resolvers.resolveAll(locationResolverContext, locations, profiles));
}
catch (IOException ex) {
throw new IllegalStateException("IO error on loading imports from " + locations, ex);
}
}
private Map<ConfigDataLocation, ConfigData> load(List<ConfigDataLocation> locations) throws IOException {
private Map<ConfigDataLocation, ConfigData> load(ConfigDataLoaderContext loaderContext,
List<ConfigDataLocation> locations) throws IOException {
Map<ConfigDataLocation, ConfigData> result = new LinkedHashMap<>();
for (int i = locations.size() - 1; i >= 0; i--) {
ConfigDataLocation location = locations.get(i);
if (this.loadedLocations.add(location)) {
result.put(location, this.loaders.load(location));
result.put(location, this.loaders.load(loaderContext, location));
}
}
return Collections.unmodifiableMap(result);
......
......@@ -40,19 +40,21 @@ public interface ConfigDataLoader<L extends ConfigDataLocation> {
/**
* Returns if the specified location can be loaded by this instance.
* @param context the loader context
* @param location the location to check.
* @return if the location is supported by this loader
*/
default boolean isLoadable(L location) {
default boolean isLoadable(ConfigDataLoaderContext context, L location) {
return true;
}
/**
* Load {@link ConfigData} for the given location.
* @param context the loader context
* @param location the location to load
* @return the loaded config data or {@code null} if the location should be skipped
* @throws IOException on IO error
*/
ConfigData load(L location) throws IOException;
ConfigData load(ConfigDataLoaderContext context, L location) throws IOException;
}
/*
* 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.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.boot.context.config;
import org.springframework.boot.env.BootstrapRegistry;
import org.springframework.boot.env.EnvironmentPostProcessor;
/**
* Context provided to {@link ConfigDataLoader} methods.
*
* @author Phillip Webb
* @since 2.4.0
*/
public interface ConfigDataLoaderContext {
/**
* Provides access to the {@link BootstrapRegistry} shared across all
* {@link EnvironmentPostProcessor EnvironmentPostProcessors}.
* @return the bootstrap registry
*/
BootstrapRegistry getBootstrapRegistry();
}
......@@ -80,24 +80,25 @@ class ConfigDataLoaders {
/**
* Load {@link ConfigData} using the first appropriate {@link ConfigDataLoader}.
* @param <L> the config data location type
* @param context the loader context
* @param location the location to load
* @return the loaded {@link ConfigData}
* @throws IOException on IO error
*/
<L extends ConfigDataLocation> ConfigData load(L location) throws IOException {
ConfigDataLoader<L> loader = getLoader(location);
<L extends ConfigDataLocation> ConfigData load(ConfigDataLoaderContext context, L location) throws IOException {
ConfigDataLoader<L> loader = getLoader(context, location);
this.logger.trace(LogMessage.of(() -> "Loading " + location + " using loader " + loader.getClass().getName()));
return loader.load(location);
return loader.load(context, location);
}
@SuppressWarnings("unchecked")
private <L extends ConfigDataLocation> ConfigDataLoader<L> getLoader(L location) {
private <L extends ConfigDataLocation> ConfigDataLoader<L> getLoader(ConfigDataLoaderContext context, L location) {
ConfigDataLoader<L> result = null;
for (int i = 0; i < this.loaders.size(); i++) {
ConfigDataLoader<?> candidate = this.loaders.get(i);
if (this.locationTypes.get(i).isInstance(location)) {
ConfigDataLoader<L> loader = (ConfigDataLoader<L>) candidate;
if (loader.isLoadable(location)) {
if (loader.isLoadable(context, location)) {
if (result != null) {
throw new IllegalStateException("Multiple loaders found for location " + location + " ["
+ candidate.getClass().getName() + "," + result.getClass().getName() + "]");
......
......@@ -17,6 +17,8 @@
package org.springframework.boot.context.config;
import org.springframework.boot.context.properties.bind.Binder;
import org.springframework.boot.env.BootstrapRegistry;
import org.springframework.boot.env.EnvironmentPostProcessor;
/**
* Context provided to {@link ConfigDataLocationResolver} methods.
......@@ -41,4 +43,11 @@ public interface ConfigDataLocationResolverContext {
*/
ConfigDataLocation getParent();
/**
* Provides access to the {@link BootstrapRegistry} shared across all
* {@link EnvironmentPostProcessor EnvironmentPostProcessors}.
* @return the bootstrap registry
*/
BootstrapRegistry getBootstrapRegistry();
}
......@@ -31,7 +31,7 @@ import org.springframework.boot.env.ConfigTreePropertySource;
class ConfigTreeConfigDataLoader implements ConfigDataLoader<ConfigTreeConfigDataLocation> {
@Override
public ConfigData load(ConfigTreeConfigDataLocation location) throws IOException {
public ConfigData load(ConfigDataLoaderContext context, ConfigTreeConfigDataLocation location) throws IOException {
Path path = location.getPath();
String name = "Config tree '" + path + "'";
ConfigTreePropertySource source = new ConfigTreePropertySource(name, path);
......
......@@ -29,7 +29,7 @@ import org.springframework.core.io.Resource;
class ResourceConfigDataLoader implements ConfigDataLoader<ResourceConfigDataLocation> {
@Override
public ConfigData load(ResourceConfigDataLocation location) throws IOException {
public ConfigData load(ConfigDataLoaderContext context, ResourceConfigDataLocation location) throws IOException {
return new ConfigData(location.load());
}
......
......@@ -80,6 +80,13 @@ public class DefaultBootstrapRegisty implements BootstrapRegistry {
.forEach((registration) -> registration.applicationContextPrepared(applicationContext));
}
/**
* Clear the registry to reclaim memory.
*/
public void clear() {
this.registrations.clear();
}
/**
* Default implementation of {@link Registration}.
*/
......
......@@ -104,11 +104,16 @@ public class EnvironmentPostProcessorApplicationListener implements SmartApplica
}
private void onApplicationPreparedEvent(ApplicationPreparedEvent event) {
this.deferredLogs.switchOverAll();
this.bootstrapRegistry.applicationContextPrepared(event.getApplicationContext());
finish();
}
private void onApplicationFailedEvent(ApplicationFailedEvent event) {
finish();
}
private void finish() {
this.bootstrapRegistry.clear();
this.deferredLogs.switchOverAll();
}
......
/*
* 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.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.boot.context.config;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.WebApplicationType;
import org.springframework.boot.context.config.TestConfigDataBootstrap.LoaderHelper;
import org.springframework.boot.env.BootstrapRegistry;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.context.annotation.Configuration;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Integration tests for {@link ConfigDataEnvironmentPostProcessor} when used with a
* {@link BootstrapRegistry}.
*
* @author Phillip Webb
*/
class ConfigDataEnvironmentPostProcessorBootstrapRegistryIntegrationTests {
private SpringApplication application;
@BeforeEach
void setup() {
this.application = new SpringApplication(Config.class);
this.application.setWebApplicationType(WebApplicationType.NONE);
}
@Test
void bootstrapsApplicationContext() {
try (ConfigurableApplicationContext context = this.application
.run("--spring.config.import=classpath:application-bootstrap-registry-integration-tests.properties")) {
LoaderHelper bean = context.getBean(TestConfigDataBootstrap.LoaderHelper.class);
assertThat(bean).isNotNull();
assertThat(bean.getLocation().getResolverHelper().getLocation()).isEqualTo("testbootstrap:test");
}
}
@Configuration
static class Config {
}
}
......@@ -28,6 +28,7 @@ import org.mockito.Spy;
import org.mockito.junit.jupiter.MockitoExtension;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.env.DefaultBootstrapRegisty;
import org.springframework.core.env.StandardEnvironment;
import org.springframework.core.io.DefaultResourceLoader;
import org.springframework.core.io.ResourceLoader;
......@@ -58,7 +59,8 @@ class ConfigDataEnvironmentPostProcessorTests {
private ConfigDataEnvironment configDataEnvironment;
@Spy
private ConfigDataEnvironmentPostProcessor postProcessor = new ConfigDataEnvironmentPostProcessor(Supplier::get);
private ConfigDataEnvironmentPostProcessor postProcessor = new ConfigDataEnvironmentPostProcessor(Supplier::get,
new DefaultBootstrapRegisty());
@Captor
private ArgumentCaptor<Set<String>> additionalProfilesCaptor;
......@@ -117,7 +119,7 @@ class ConfigDataEnvironmentPostProcessorTests {
@Test
void applyToAppliesPostProcessing() {
int before = this.environment.getPropertySources().size();
ConfigDataEnvironmentPostProcessor.applyTo(this.environment, null, "dev");
ConfigDataEnvironmentPostProcessor.applyTo(this.environment, null, null, "dev");
assertThat(this.environment.getPropertySources().size()).isGreaterThan(before);
assertThat(this.environment.getActiveProfiles()).containsExactly("dev");
}
......
......@@ -54,6 +54,9 @@ class ConfigDataImporterTests {
@Mock
private ConfigDataLocationResolverContext locationResolverContext;
@Mock
private ConfigDataLoaderContext loaderContext;
@Mock
private ConfigDataActivationContext activationContext;
......@@ -75,11 +78,12 @@ class ConfigDataImporterTests {
ConfigData configData2 = new ConfigData(Collections.singleton(new MockPropertySource()));
given(this.resolvers.resolveAll(this.locationResolverContext, locations, this.profiles))
.willReturn(resolvedLocations);
given(this.loaders.load(resolvedLocation1)).willReturn(configData1);
given(this.loaders.load(resolvedLocation2)).willReturn(configData2);
given(this.loaders.load(this.loaderContext, resolvedLocation1)).willReturn(configData1);
given(this.loaders.load(this.loaderContext, resolvedLocation2)).willReturn(configData2);
ConfigDataImporter importer = new ConfigDataImporter(this.resolvers, this.loaders);
Collection<ConfigData> loaded = importer
.resolveAndLoad(this.activationContext, this.locationResolverContext, locations).values();
.resolveAndLoad(this.activationContext, this.locationResolverContext, this.loaderContext, locations)
.values();
assertThat(loaded).containsExactly(configData2, configData1);
}
......@@ -99,14 +103,14 @@ class ConfigDataImporterTests {
.willReturn(resolvedLocations1and2);
given(this.resolvers.resolveAll(this.locationResolverContext, locations2and3, this.profiles))
.willReturn(resolvedLocations2and3);
given(this.loaders.load(resolvedLocation1)).willReturn(configData1);
given(this.loaders.load(resolvedLocation2)).willReturn(configData2);
given(this.loaders.load(resolvedLocation3)).willReturn(configData3);
given(this.loaders.load(this.loaderContext, resolvedLocation1)).willReturn(configData1);
given(this.loaders.load(this.loaderContext, resolvedLocation2)).willReturn(configData2);
given(this.loaders.load(this.loaderContext, resolvedLocation3)).willReturn(configData3);
ConfigDataImporter importer = new ConfigDataImporter(this.resolvers, this.loaders);
Collection<ConfigData> loaded1and2 = importer
.resolveAndLoad(this.activationContext, this.locationResolverContext, locations1and2).values();
Collection<ConfigData> loaded2and3 = importer
.resolveAndLoad(this.activationContext, this.locationResolverContext, locations2and3).values();
Collection<ConfigData> loaded1and2 = importer.resolveAndLoad(this.activationContext,
this.locationResolverContext, this.loaderContext, locations1and2).values();
Collection<ConfigData> loaded2and3 = importer.resolveAndLoad(this.activationContext,
this.locationResolverContext, this.loaderContext, locations2and3).values();
assertThat(loaded1and2).containsExactly(configData2, configData1);
assertThat(loaded2and3).containsExactly(configData3);
}
......
......@@ -21,6 +21,7 @@ import java.io.IOException;
import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.mock;
/**
* Tests for {@link ConfigDataLoader}.
......@@ -32,15 +33,17 @@ class ConfigDataLoaderTests {
private TestConfigDataLoader loader = new TestConfigDataLoader();
private ConfigDataLoaderContext context = mock(ConfigDataLoaderContext.class);
@Test
void isLoadableAlwaysReturnsTrue() {
assertThat(this.loader.isLoadable(new TestConfigDataLocation())).isTrue();
assertThat(this.loader.isLoadable(this.context, new TestConfigDataLocation())).isTrue();
}
static class TestConfigDataLoader implements ConfigDataLoader<TestConfigDataLocation> {
@Override
public ConfigData load(TestConfigDataLocation location) throws IOException {
public ConfigData load(ConfigDataLoaderContext context, TestConfigDataLocation location) throws IOException {
return null;
}
......
......@@ -30,6 +30,7 @@ import org.springframework.mock.env.MockPropertySource;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatIllegalStateException;
import static org.mockito.Mockito.mock;
/**
* Tests for {@link ConfigDataLoaders}.
......@@ -41,6 +42,8 @@ class ConfigDataLoadersTests {
private DeferredLogFactory logFactory = Supplier::get;
private ConfigDataLoaderContext context = mock(ConfigDataLoaderContext.class);
@Test
void createWhenLoaderHasLogParameterInjectsLog() {
new ConfigDataLoaders(this.logFactory, Arrays.asList(LoggingConfigDataLoader.class.getName()));
......@@ -51,7 +54,7 @@ class ConfigDataLoadersTests {
TestConfigDataLocation location = new TestConfigDataLocation("test");
ConfigDataLoaders loaders = new ConfigDataLoaders(this.logFactory,
Arrays.asList(TestConfigDataLoader.class.getName()));
ConfigData loaded = loaders.load(location);
ConfigData loaded = loaders.load(this.context, location);
assertThat(getLoader(loaded)).isInstanceOf(TestConfigDataLoader.class);
}
......@@ -60,7 +63,7 @@ class ConfigDataLoadersTests {
TestConfigDataLocation location = new TestConfigDataLocation("test");
ConfigDataLoaders loaders = new ConfigDataLoaders(this.logFactory,
Arrays.asList(LoggingConfigDataLoader.class.getName(), TestConfigDataLoader.class.getName()));
assertThatIllegalStateException().isThrownBy(() -> loaders.load(location))
assertThatIllegalStateException().isThrownBy(() -> loaders.load(this.context, location))
.withMessageContaining("Multiple loaders found for location test");
}
......@@ -69,7 +72,7 @@ class ConfigDataLoadersTests {
TestConfigDataLocation location = new TestConfigDataLocation("test");
ConfigDataLoaders loaders = new ConfigDataLoaders(this.logFactory,
Arrays.asList(NonLoadableConfigDataLoader.class.getName()));
assertThatIllegalStateException().isThrownBy(() -> loaders.load(location))
assertThatIllegalStateException().isThrownBy(() -> loaders.load(this.context, location))
.withMessage("No loader found for location 'test'");
}
......@@ -78,7 +81,7 @@ class ConfigDataLoadersTests {
TestConfigDataLocation location = new TestConfigDataLocation("test");
ConfigDataLoaders loaders = new ConfigDataLoaders(this.logFactory,
Arrays.asList(OtherConfigDataLoader.class.getName(), SpecificConfigDataLoader.class.getName()));
ConfigData loaded = loaders.load(location);
ConfigData loaded = loaders.load(this.context, location);
assertThat(getLoader(loaded)).isInstanceOf(SpecificConfigDataLoader.class);
}
......@@ -121,7 +124,7 @@ class ConfigDataLoadersTests {
}
@Override
public ConfigData load(ConfigDataLocation location) throws IOException {
public ConfigData load(ConfigDataLoaderContext context, ConfigDataLocation location) throws IOException {
throw new AssertionError("Unexpected call");
}
......@@ -130,7 +133,7 @@ class ConfigDataLoadersTests {
static class TestConfigDataLoader implements ConfigDataLoader<ConfigDataLocation> {
@Override
public ConfigData load(ConfigDataLocation location) throws IOException {
public ConfigData load(ConfigDataLoaderContext context, ConfigDataLocation location) throws IOException {
return createConfigData(this, location);
}
......@@ -139,7 +142,7 @@ class ConfigDataLoadersTests {
static class NonLoadableConfigDataLoader extends TestConfigDataLoader {
@Override
public boolean isLoadable(ConfigDataLocation location) {
public boolean isLoadable(ConfigDataLoaderContext context, ConfigDataLocation location) {
return false;
}
......@@ -148,7 +151,7 @@ class ConfigDataLoadersTests {
static class SpecificConfigDataLoader implements ConfigDataLoader<TestConfigDataLocation> {
@Override
public ConfigData load(TestConfigDataLocation location) throws IOException {
public ConfigData load(ConfigDataLoaderContext context, TestConfigDataLocation location) throws IOException {
return createConfigData(this, location);
}
......@@ -157,7 +160,7 @@ class ConfigDataLoadersTests {
static class OtherConfigDataLoader implements ConfigDataLoader<OtherConfigDataLocation> {
@Override
public ConfigData load(OtherConfigDataLocation location) throws IOException {
public ConfigData load(ConfigDataLoaderContext context, OtherConfigDataLocation location) throws IOException {
return createConfigData(this, location);
}
......
......@@ -31,9 +31,9 @@ import static org.mockito.Mockito.mock;
*/
class ConfigDataLocationResolverTests {
ConfigDataLocationResolver<?> resolver = new TestConfigDataLocationResolver();
private ConfigDataLocationResolver<?> resolver = new TestConfigDataLocationResolver();
ConfigDataLocationResolverContext context = mock(ConfigDataLocationResolverContext.class);
private ConfigDataLocationResolverContext context = mock(ConfigDataLocationResolverContext.class);
@Test
void resolveProfileSpecificReturnsEmptyList() {
......
......@@ -28,6 +28,7 @@ import org.springframework.core.env.PropertySource;
import org.springframework.util.FileCopyUtils;
import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.mock;
/**
* Tests for {@link ConfigTreeConfigDataLoader}.
......@@ -39,6 +40,8 @@ public class ConfigTreeConfigDataLoaderTests {
private ConfigTreeConfigDataLoader loader = new ConfigTreeConfigDataLoader();
private ConfigDataLoaderContext loaderContext = mock(ConfigDataLoaderContext.class);
@TempDir
Path directory;
......@@ -48,7 +51,7 @@ public class ConfigTreeConfigDataLoaderTests {
file.getParentFile().mkdirs();
FileCopyUtils.copy("world".getBytes(StandardCharsets.UTF_8), file);
ConfigTreeConfigDataLocation location = new ConfigTreeConfigDataLocation(this.directory.toString());
ConfigData configData = this.loader.load(location);
ConfigData configData = this.loader.load(this.loaderContext, location);
assertThat(configData.getPropertySources().size()).isEqualTo(1);
PropertySource<?> source = configData.getPropertySources().get(0);
assertThat(source.getName()).isEqualTo("Config tree '" + this.directory.toString() + "'");
......
......@@ -26,6 +26,7 @@ import org.springframework.core.env.PropertySource;
import org.springframework.core.io.ClassPathResource;
import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.mock;
/**
* Tests for {@link ResourceConfigDataLoader}.
......@@ -37,11 +38,13 @@ public class ResourceConfigDataLoaderTests {
private ResourceConfigDataLoader loader = new ResourceConfigDataLoader();
private ConfigDataLoaderContext loaderContext = mock(ConfigDataLoaderContext.class);
@Test
void loadWhenLocationResultsInMultiplePropertySourcesAddsAllToConfigData() throws IOException {
ResourceConfigDataLocation location = new ResourceConfigDataLocation("application.yml",
new ClassPathResource("configdata/yaml/application.yml"), new YamlPropertySourceLoader());
ConfigData configData = this.loader.load(location);
ConfigData configData = this.loader.load(this.loaderContext, location);
assertThat(configData.getPropertySources().size()).isEqualTo(2);
PropertySource<?> source1 = configData.getPropertySources().get(0);
PropertySource<?> source2 = configData.getPropertySources().get(1);
......@@ -56,7 +59,7 @@ public class ResourceConfigDataLoaderTests {
ResourceConfigDataLocation location = new ResourceConfigDataLocation("testproperties.properties",
new ClassPathResource("config/0-empty/testproperties.properties"),
new PropertiesPropertySourceLoader());
ConfigData configData = this.loader.load(location);
ConfigData configData = this.loader.load(this.loaderContext, location);
assertThat(configData.getPropertySources().size()).isEqualTo(0);
}
......
/*
* 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.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.boot.context.config;
import java.io.IOException;
import java.util.Collections;
import java.util.List;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.core.env.MapPropertySource;
/**
* Test classes used with
* {@link ConfigDataEnvironmentPostProcessorBootstrapRegistryIntegrationTests} to show how
* a bootstrap registry can be used. This example will create helper instances during
* result and load. It also shows how the helper can ultimately be registered as a bean.
*
* @author Phillip Webb
*/
class TestConfigDataBootstrap {
static class LocationResolver implements ConfigDataLocationResolver<Location> {
@Override
public boolean isResolvable(ConfigDataLocationResolverContext context, String location) {
return location.startsWith("testbootstrap:");
}
@Override
public List<Location> resolve(ConfigDataLocationResolverContext context, String location) {
ResolverHelper helper = context.getBootstrapRegistry().get(ResolverHelper.class,
() -> new ResolverHelper(location));
return Collections.singletonList(new Location(helper));
}
}
static class Loader implements ConfigDataLoader<Location> {
@Override
public ConfigData load(ConfigDataLoaderContext context, Location location) throws IOException {
context.getBootstrapRegistry().get(LoaderHelper.class, () -> new LoaderHelper(location),
LoaderHelper::addToContext);
return new ConfigData(
Collections.singleton(new MapPropertySource("loaded", Collections.singletonMap("test", "test"))));
}
}
static class Location extends ConfigDataLocation {
private final ResolverHelper resolverHelper;
Location(ResolverHelper resolverHelper) {
this.resolverHelper = resolverHelper;
}
@Override
public String toString() {
return "test";
}
ResolverHelper getResolverHelper() {
return this.resolverHelper;
}
}
static class ResolverHelper {
private final String location;
ResolverHelper(String location) {
this.location = location;
}
String getLocation() {
return this.location;
}
}
static class LoaderHelper {
private final Location location;
LoaderHelper(Location location) {
this.location = location;
}
Location getLocation() {
return this.location;
}
static void addToContext(ConfigurableApplicationContext context, LoaderHelper loaderHelper) {
context.getBeanFactory().registerSingleton("loaderHelper", loaderHelper);
}
}
}
org.springframework.boot.env.PropertySourceLoader=\
org.springframework.boot.context.config.TestPropertySourceLoader1,\
org.springframework.boot.context.config.TestPropertySourceLoader2
org.springframework.boot.context.config.ConfigDataLocationResolver=\
org.springframework.boot.context.config.TestConfigDataBootstrap.LocationResolver
org.springframework.boot.context.config.ConfigDataLoader=\
org.springframework.boot.context.config.TestConfigDataBootstrap.Loader
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment