Replace Flapdoodle with Testcontainers for MongoDB support.

For more details on this usage of Testcontainers, see https://bsideup.github.io/posts/local_development_with_testcontainers/

Related issues: https://github.com/spring-projects/spring-boot/issues/30863
This commit is contained in:
Greg L. Turnquist
2022-05-13 16:34:25 -05:00
committed by Rob Winch
parent c9cf1eab7b
commit 55f9bc9c37
10 changed files with 89 additions and 65 deletions

View File

@@ -5,7 +5,7 @@ dependencies {
implementation "org.springframework.boot:spring-boot-starter-webflux"
implementation "org.springframework.boot:spring-boot-starter-thymeleaf"
implementation "org.springframework.boot:spring-boot-starter-data-mongodb-reactive"
implementation "de.flapdoodle.embed:de.flapdoodle.embed.mongo"
implementation "org.testcontainers:mongodb"
testImplementation "org.springframework.boot:spring-boot-starter-test"
testImplementation "org.seleniumhq.selenium:htmlunit-driver"

View File

@@ -18,7 +18,16 @@ package org.springframework.session.mongodb.examples;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ApplicationContextInitializer;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.core.env.MapPropertySource;
import org.springframework.session.data.mongo.config.annotation.web.reactive.EnableMongoWebSession;
import org.testcontainers.containers.MongoDBContainer;
import org.testcontainers.utility.DockerImageName;
import java.util.HashMap;
import java.util.Map;
/**
* Pure Spring-based application (using Spring Boot for dependency management), hence no
@@ -31,8 +40,35 @@ import org.springframework.session.data.mongo.config.annotation.web.reactive.Ena
@EnableMongoWebSession
public class SpringSessionMongoReactiveApplication {
public static void main(String[] args) {
SpringApplication.run(SpringSessionMongoReactiveApplication.class);
/**
* Use Testcontainers to managed MongoDB through Docker.
* <p>
* @see https://bsideup.github.io/posts/local_development_with_testcontainers/
*/
static class Initializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {
static MongoDBContainer mongo = new MongoDBContainer(DockerImageName.parse("mongo:5.0"));
public static Map<String, String> getProperties() {
mongo.start();
HashMap<String, String> properties = new HashMap<>();
properties.put("spring.data.mongodb.host", mongo.getHost());
properties.put("spring.data.mongodb.port", mongo.getFirstMappedPort() + "");
return properties;
}
@Override
public void initialize(ConfigurableApplicationContext context) {
ConfigurableEnvironment env = context.getEnvironment();
env.getPropertySources().addFirst(new MapPropertySource("testcontainers", (Map) getProperties()));
}
}
public static void main(String[] args) {
SpringApplication application = new SpringApplication(SpringSessionMongoReactiveApplication.class);
application.addInitializers(new Initializer());
application.run(args);
}
}

View File

@@ -0,0 +1,2 @@
logging.level.org.springframework.data.mongodb=DEBUG
logging.level.org.springframework.session=DEBUG

View File

@@ -1,8 +0,0 @@
logging:
level:
org.springframework.data.mongodb: DEBUG
org.springframework.session: DEBUG
spring:
mongodb:
embedded:
version: 3.4.3

View File

@@ -16,21 +16,21 @@
package org.springframework.session.mongodb.examples;
import java.util.List;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.htmlunit.HtmlUnitDriver;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.web.server.LocalServerPort;
import org.springframework.session.mongodb.examples.pages.HomePage;
import org.springframework.session.mongodb.examples.pages.HomePage.Attribute;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit.jupiter.SpringExtension;
import java.util.List;
import static org.assertj.core.api.Assertions.assertThat;
/**
@@ -39,6 +39,7 @@ import static org.assertj.core.api.Assertions.assertThat;
*/
@ExtendWith(SpringExtension.class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
@ContextConfiguration(initializers = SpringSessionMongoReactiveApplication.Initializer.class)
public class AttributeTests {
@LocalServerPort

View File

@@ -8,7 +8,8 @@ dependencies {
implementation "org.thymeleaf.extras:thymeleaf-extras-springsecurity6"
implementation "org.springframework.boot:spring-boot-starter-data-mongodb"
implementation "org.springframework.boot:spring-boot-starter-security"
implementation "de.flapdoodle.embed:de.flapdoodle.embed.mongo"
implementation "org.testcontainers:mongodb"
testImplementation "org.springframework.boot:spring-boot-starter-test"
testImplementation "org.seleniumhq.selenium:htmlunit-driver"

View File

@@ -1,46 +0,0 @@
/*
* Copyright 2014-2016 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.session.mongodb.examples;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.boot.ApplicationArguments;
import org.springframework.boot.ApplicationRunner;
import org.springframework.context.EnvironmentAware;
import org.springframework.core.env.Environment;
import org.springframework.stereotype.Component;
@Component
class EmbeddedMongoPortLogger implements ApplicationRunner, EnvironmentAware {
private static final Log logger = LogFactory.getLog(EmbeddedMongoPortLogger.class);
private Environment environment;
@Override
public void run(ApplicationArguments args) throws Exception {
String port = this.environment.getProperty("local.mongo.port");
logger.info("Embedded Mongo started on port " + port + ", use 'mongo --port " + port + "' command to connect");
}
@Override
public void setEnvironment(Environment environment) {
this.environment = environment;
}
}

View File

@@ -18,6 +18,15 @@ package org.springframework.session.mongodb.examples;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ApplicationContextInitializer;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.core.env.MapPropertySource;
import org.testcontainers.containers.MongoDBContainer;
import org.testcontainers.utility.DockerImageName;
import java.util.HashMap;
import java.util.Map;
/**
* @author Rob Winch
@@ -25,8 +34,34 @@ import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class SpringSessionMongoTraditionalBoot {
public static void main(String[] args) {
SpringApplication.run(SpringSessionMongoTraditionalBoot.class, args);
/**
* Use Testcontainers to managed MongoDB through Docker.
* <p>
* @see https://bsideup.github.io/posts/local_development_with_testcontainers/
*/
static class Initializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {
static MongoDBContainer mongo = new MongoDBContainer(DockerImageName.parse("mongo:5.0"));
public static Map<String, String> getProperties() {
mongo.start();
HashMap<String, String> properties = new HashMap<>();
properties.put("spring.data.mongodb.host", mongo.getHost());
properties.put("spring.data.mongodb.port", mongo.getFirstMappedPort() + "");
return properties;
}
@Override
public void initialize(ConfigurableApplicationContext context) {
ConfigurableEnvironment env = context.getEnvironment();
env.getPropertySources().addFirst(new MapPropertySource("testcontainers", (Map) getProperties()));
}
}
public static void main(String[] args) {
SpringApplication application = new SpringApplication(SpringSessionMongoTraditionalBoot.class);
application.addInitializers(new Initializer());
application.run(args);
}
}

View File

@@ -1,4 +1,5 @@
spring.thymeleaf.cache=false
spring.template.cache=false
spring.data.mongodb.port=0
spring.mongodb.embedded.version=3.4.3
logging.level.org.springframework.data.mongodb=DEBUG
logging.level.org.springframework.session=DEBUG

View File

@@ -33,6 +33,7 @@ import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
import org.springframework.session.mongodb.examples.pages.HomePage;
import org.springframework.session.mongodb.examples.pages.LoginPage;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit.jupiter.SpringExtension;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.htmlunit.webdriver.MockMvcHtmlUnitDriverBuilder;
@@ -45,6 +46,7 @@ import static org.assertj.core.api.Assertions.assertThat;
@ExtendWith(SpringExtension.class)
@AutoConfigureMockMvc
@SpringBootTest(webEnvironment = WebEnvironment.MOCK)
@ContextConfiguration(initializers = SpringSessionMongoTraditionalBoot.Initializer.class)
public class BootTests {
@Autowired