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

Document usage of Docker Compose support in tests

Browse Source 
Closes gh-40171
This commit is contained in:
Scott Frederick
2024-04-22 16:47:29 -05:00
parent 3a9ee9f1a7
commit 08bc0460ed
1 changed files with 20 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
spring-boot-project/spring-boot-docs/src/docs/asciidoc/features/docker-compose.adoc
View File

@@ -38,9 +38,6 @@ When this module is included as a dependency Spring Boot will do the following:
If the Docker Compose services are already running when starting the application, Spring Boot will only create the service connection beans for each supported container.
It will not call `docker compose up` again and it will not call `docker compose stop` when the application is shutdown.
NOTE: By default, Spring Boot's Docker Compose support is disabled when running tests.
To enable it, set configprop:spring.docker.compose.skip.in-tests[] to `false`.
[[features.docker-compose.prerequisites]]
@@ -256,3 +253,23 @@ If you want to activate a specific Docker Compose profile you can use the config
profiles:
active: "myprofile"
----
[[features.docker-compose.tests]]
=== Using Docker Compose in Tests
By default, Spring Boot's Docker Compose support is disabled when running tests.
To enable Docker Compose support in tests, set configprop:spring.docker.compose.skip.in-tests[] to `false`.
When using Gradle, you also need to change the configuration of the `spring-boot-docker-compose` dependency from `developmentOnly` to `testAndDevelopmentOnly`:
.Gradle
[source,gradle,indent=0,subs="verbatim"]
----
dependencies {
testAndDevelopmentOnly("org.springframework.boot:spring-boot-docker-compose")
}
----