root
/
spring-boot
1
0
Fork 0
Code Issues Pull Requests 1 Packages Projects Releases Wiki Activity

Polish "Allow easy customization of EmbeddedMongo DownloadConfig"

Browse Source 
Closes gh-15496
pull/15603/head
Stephane Nicoll 6 years ago
parent b5b6889601
commit 6ba1f40e59
4 changed files with 39 additions and 62 deletions
Show Stats Download Patch File Download Diff File

7
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/mongo/embedded/EmbeddedMongoDownloadConfigBuilderCustomizer.java → spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/mongo/embedded/DownloadConfigBuilderCustomizer.java
Unescape Escape View File

@ -1,5 +1,5 @@
/*
* Copyright 2012-2018 the original author or authors.
* Copyright 2012-2019 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.
@ -17,17 +17,18 @@
package org.springframework.boot.autoconfigure.mongo.embedded;
import de.flapdoodle.embed.mongo.config.DownloadConfigBuilder;
import de.flapdoodle.embed.process.config.store.IDownloadConfig;
/**
* Callback interface that can be implemented by beans wishing to customize the
* EmbeddedMongo {@link DownloadConfigBuilder} outcome whilst retaining default
* {@link IDownloadConfig} via a {@link DownloadConfigBuilder} whilst retaining default
* auto-configuration.
*
* @author Michael Gmeiner
* @since 2.2.0
*/
@FunctionalInterface
public interface EmbeddedMongoDownloadConfigBuilderCustomizer {
public interface DownloadConfigBuilderCustomizer {
/**
* Customize the {@link DownloadConfigBuilder}.

47
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/mongo/embedded/EmbeddedMongoAutoConfiguration.java
Unescape Escape View File

@ -1,5 +1,5 @@
/*
* Copyright 2012-2018 the original author or authors.
* Copyright 2012-2019 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.
@ -21,6 +21,7 @@ import java.net.InetAddress;
import java.net.UnknownHostException;
import java.util.HashMap;
import java.util.Map;
import java.util.stream.Stream;
import com.mongodb.MongoClient;
import de.flapdoodle.embed.mongo.Command;
@ -204,41 +205,29 @@ public class EmbeddedMongoAutoConfiguration {
@ConditionalOnMissingBean(IRuntimeConfig.class)
static class RuntimeConfigConfiguration {
private static Logger EMBEDDED_MONGO_LOGGER = LoggerFactory
.getLogger(RuntimeConfigConfiguration.class.getPackage().getName()
+ ".EmbeddedMongo");
@Bean
public IRuntimeConfig embeddedMongoRuntimeConfig(
IDownloadConfig embeddedMongoDownloadConfig) {
ObjectProvider<DownloadConfigBuilderCustomizer> downloadConfigBuilderCustomizers) {
Logger logger = LoggerFactory
.getLogger(getClass().getPackage().getName() + ".EmbeddedMongo");
ProcessOutput processOutput = new ProcessOutput(
Processors.logTo(EMBEDDED_MONGO_LOGGER, Slf4jLevel.INFO),
Processors.logTo(EMBEDDED_MONGO_LOGGER, Slf4jLevel.ERROR),
Processors.named("[console>]",
Processors.logTo(EMBEDDED_MONGO_LOGGER, Slf4jLevel.DEBUG)));
return new RuntimeConfigBuilder()
.defaultsWithLogger(Command.MongoD, EMBEDDED_MONGO_LOGGER)
.processOutput(processOutput)
.artifactStore(getArtifactStore(embeddedMongoDownloadConfig)).build();
Processors.logTo(logger, Slf4jLevel.INFO),
Processors.logTo(logger, Slf4jLevel.ERROR), Processors.named(
"[console>]", Processors.logTo(logger, Slf4jLevel.DEBUG)));
return new RuntimeConfigBuilder().defaultsWithLogger(Command.MongoD, logger)
.processOutput(processOutput).artifactStore(getArtifactStore(logger,
downloadConfigBuilderCustomizers.orderedStream()))
.build();
}
@Bean
@ConditionalOnMissingBean
public IDownloadConfig embeddedMongoDownloadConfig(
ObjectProvider<EmbeddedMongoDownloadConfigBuilderCustomizer> downloadConfigBuilderCustomizer) {
private ArtifactStoreBuilder getArtifactStore(Logger logger,
Stream<DownloadConfigBuilderCustomizer> downloadConfigBuilderCustomizers) {
DownloadConfigBuilder downloadConfigBuilder = new DownloadConfigBuilder()
.defaultsForCommand(Command.MongoD);
downloadConfigBuilder
.progressListener(new Slf4jProgressListener(EMBEDDED_MONGO_LOGGER));
downloadConfigBuilderCustomizer.stream()
.forEach((c) -> c.customize(downloadConfigBuilder));
return downloadConfigBuilder.build();
}
private ArtifactStoreBuilder getArtifactStore(IDownloadConfig downloadConfig) {
downloadConfigBuilder.progressListener(new Slf4jProgressListener(logger));
downloadConfigBuilderCustomizers
.forEach((customizer) -> customizer.customize(downloadConfigBuilder));
IDownloadConfig downloadConfig = downloadConfigBuilder.build();
return new ExtractedArtifactStoreBuilder().defaults(Command.MongoD)
.download(downloadConfig);
}

44
spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/mongo/embedded/EmbeddedMongoAutoConfigurationTests.java
Unescape Escape View File

@ -1,5 +1,5 @@
/*
* Copyright 2012-2018 the original author or authors.
* Copyright 2012-2019 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.
@ -22,19 +22,19 @@ import java.util.EnumSet;
import java.util.stream.Collectors;
import com.mongodb.MongoClient;
import de.flapdoodle.embed.mongo.config.DownloadConfigBuilder;
import de.flapdoodle.embed.mongo.config.IMongodConfig;
import de.flapdoodle.embed.mongo.config.Storage;
import de.flapdoodle.embed.mongo.distribution.Feature;
import de.flapdoodle.embed.mongo.distribution.Version;
import de.flapdoodle.embed.process.config.IRuntimeConfig;
import de.flapdoodle.embed.process.config.store.IDownloadConfig;
import de.flapdoodle.embed.process.io.progress.Slf4jProgressListener;
import org.bson.Document;
import org.junit.After;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TemporaryFolder;
import org.springframework.beans.DirectFieldAccessor;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration;
import org.springframework.boot.autoconfigure.data.mongo.MongoDataAutoConfiguration;
@ -184,27 +184,12 @@ public class EmbeddedMongoAutoConfigurationTests {
}
@Test
public void defaultDownloadConfiguration() {
load();
IDownloadConfig downloadConfig = this.context.getBean(IDownloadConfig.class);
assertThat(downloadConfig.getDownloadPath().getClass().getSimpleName())
.isEqualTo("PlatformDependentDownloadPath");
assertThat(downloadConfig.getUserAgent()).isEqualTo(
"Mozilla/5.0 (compatible; Embedded MongoDB; +https://github.com/flapdoodle-oss/embedmongo.flapdoodle.de)");
assertThat(downloadConfig.getProgressListener())
.isInstanceOf(Slf4jProgressListener.class);
}
@Test
public void customizedDownloadConfiguration() {
load(TestEmbeddedMongoDownloadConfigBuilderCustomizer.class);
IDownloadConfig downloadConfig = this.context.getBean(IDownloadConfig.class);
assertThat(downloadConfig.getDownloadPath().getPath(null)).isEqualTo("test");
public void customizeDownloadConfiguration() {
load(DownloadConfigBuilderCustomizerConfiguration.class);
IRuntimeConfig runtimeConfig = this.context.getBean(IRuntimeConfig.class);
IDownloadConfig downloadConfig = (IDownloadConfig) new DirectFieldAccessor(
runtimeConfig.getArtifactStore()).getPropertyValue("downloadConfig");
assertThat(downloadConfig.getUserAgent()).isEqualTo("Test User Agent");
assertThat(downloadConfig.getProgressListener())
.isInstanceOf(Slf4jProgressListener.class);
}
private void assertVersionConfiguration(String configuredVersion,
@ -254,13 +239,14 @@ public class EmbeddedMongoAutoConfigurationTests {
}
private static class TestEmbeddedMongoDownloadConfigBuilderCustomizer
implements EmbeddedMongoDownloadConfigBuilderCustomizer {
@Configuration
static class DownloadConfigBuilderCustomizerConfiguration {
@Override
public void customize(DownloadConfigBuilder downloadConfigBuilder) {
downloadConfigBuilder.downloadPath("test");
downloadConfigBuilder.userAgent("Test User Agent");
@Bean
public DownloadConfigBuilderCustomizer testDownloadConfigBuilderCustomizer() {
return (downloadConfigBuilder) -> {
downloadConfigBuilder.userAgent("Test User Agent");
};
}
}

3
spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc
Unescape Escape View File

@ -4292,7 +4292,8 @@ If you have SLF4J on the classpath, the output produced by Mongo is automaticall
to a logger named `org.springframework.boot.autoconfigure.mongo.embedded.EmbeddedMongo`.
You can declare your own `IMongodConfig` and `IRuntimeConfig` beans to take control of
the Mongo instance's configuration and logging routing.
the Mongo instance's configuration and logging routing. The download configuration can be
customized by declaring a `DownloadConfigBuilderCustomizer` bean.

Write Preview
Loading…
Cancel
Save