Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Move "Testcontainers" How-to

Browse Source 
See gh-26262
This commit is contained in:
Phillip Webb
2021-05-18 11:23:46 -07:00
parent 72d50ed2f8
commit 499a29c415
6 changed files with 30 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
spring-boot-project/spring-boot-docs/src/docs/asciidoc/anchor-rewrite.properties
View File

@@ -2849,7 +2849,7 @@ howto.jedis-instead-of-lettuce
# 2 == Use Testcontainers for integration testing
howto-testcontainers=\
howto.testcontainers
howto.testing.testcontainers

2
spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto.adoc
View File

@@ -50,5 +50,3 @@ include::howto/build.adoc[]
include::howto/traditional-deployment.adoc[]
include::howto/jedis-instead-of-lettuce.adoc[]
include::howto/testcontainers.adoc[]

23
spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/testcontainers.adoc
View File

@@ -1,23 +0,0 @@
[[howto.testcontainers]]
== Use Testcontainers for integration testing
The https://www.testcontainers.org/[Testcontainers] library provides a way to manage services running inside Docker containers.
It integrates with JUnit, allowing you to write a test class that can start up a container before any of the tests run.
Testcontainers is especially useful for writing integration tests that talk to a real backend service such as MySQL, MongoDB, Cassandra etc.
Testcontainers can be used in a Spring Boot test as follows:
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/howto/testcontainers/vanilla/MyIntegrationTests.java[]
----
This will start up a docker container running Neo4j (if Docker is running locally) before any of the tests are run.
In most cases, you will need to configure the application using details from the running container, such as container IP or port.
This can be done with a static `@DynamicPropertySource` method that allows adding dynamic property values to the Spring Environment.
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/howto/testcontainers/dynamicproperties/MyIntegrationTests.java[]
----
The above configuration allows Neo4j-related beans in the application to communicate with Neo4j running inside the Testcontainers-managed Docker container.

27
spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/testing.adoc
View File

@@ -18,3 +18,30 @@ include::{docs-java}/howto/testing/withspringsecurity/MySecurityTests.java[]
Spring Security provides comprehensive integration with Spring MVC Test and this can also be used when testing controllers using the `@WebMvcTest` slice and `MockMvc`.
For additional details on Spring Security's testing support, refer to Spring Security's {spring-security-docs}#test[reference documentation]).
[[howto.testing.testcontainers]]
=== Use Testcontainers for Integration Testing
The https://www.testcontainers.org/[Testcontainers] library provides a way to manage services running inside Docker containers.
It integrates with JUnit, allowing you to write a test class that can start up a container before any of the tests run.
Testcontainers is especially useful for writing integration tests that talk to a real backend service such as MySQL, MongoDB, Cassandra etc.
Testcontainers can be used in a Spring Boot test as follows:
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/howto/testing/testcontainers/vanilla/MyIntegrationTests.java[]
----
This will start up a docker container running Neo4j (if Docker is running locally) before any of the tests are run.
In most cases, you will need to configure the application using details from the running container, such as container IP or port.
This can be done with a static `@DynamicPropertySource` method that allows adding dynamic property values to the Spring Environment.
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/howto/testing/testcontainers/dynamicproperties/MyIntegrationTests.java[]
----
The above configuration allows Neo4j-related beans in the application to communicate with Neo4j running inside the Testcontainers-managed Docker container.