RabbitMQ Dev Service

A service providing a RabbitMQ event broker for development and testing purposes.

It works with Spring Boot libraries that support AMQP or RabbitMQ, including:

Dependencies

First, you need to add the Dev Service dependency to your project.

Gradle
Maven

dependencies {
  testAndDevelopmentOnly "io.arconia:arconia-dev-services-rabbitmq"
}

<dependency>
    <groupId>io.arconia</groupId>
    <artifactId>arconia-dev-services-rabbitmq</artifactId>
    <scope>runtime</scope>
    <optional>true</optional>
</dependency>

You can optionally include the Spring Boot DevTools dependency to enable live reload of your application during development.

Gradle
Maven

dependencies {
  developmentOnly "org.springframework.boot:spring-boot-devtools"
}

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-devtools</artifactId>
    <scope>runtime</scope>
    <optional>true</optional>
</dependency>

When you use the Spring Boot DevTools in your project, Arconia will keep the Dev Services running while you make changes to your code instead of restarting them with the application. This allows you to see the changes in real-time without having to restart the Dev Services.

Running the Application

When using the Arconia Dev Services, you can keep running your application as you normally would. The Dev Services will automatically start when you run your application.

CLI
Gradle
Maven

arconia dev

./gradlew bootRun

./mvnw spring-boot:run

Unlike the lower-level Testcontainers support in Spring Boot, Arconia doesn’t require special tasks to run your application when using Dev Services (./gradlew bootTestRun or ./mvnw spring-boot:test-run) nor requires you to define a separate @SpringBootApplication class for configuring Testcontainers.

Your integration tests will automatically use the Dev Services without any additional configuration.

By default, when running the application in development mode, the Dev Service will be shared across multiple applications.

Configuring the Dev Service

You can configure the Dev Service via configuration properties.

Property Default Description

Property	Default	Description
`arconia.dev.services.rabbitmq.enabled`	`true`	Whether the dev service is enabled.
`arconia.dev.services.rabbitmq.image-name`	`rabbitmq`	Full name of the container image used in the dev service.
`arconia.dev.services.rabbitmq.environment`	`{}`	Environment variables to set in the service. Example: `RABBITMQ_DEFAULT_USER: "user"`.
`arconia.dev.services.rabbitmq.shared`	`dev-mode`	When the dev service is shared across applications.

arconia.dev.services.rabbitmq.enabled

true

Whether the dev service is enabled.

arconia.dev.services.rabbitmq.image-name

rabbitmq

Full name of the container image used in the dev service.

arconia.dev.services.rabbitmq.environment

{}

Environment variables to set in the service. Example: RABBITMQ_DEFAULT_USER: "user".

arconia.dev.services.rabbitmq.shared

dev-mode

When the dev service is shared across applications.

You can enable/disable the Dev Service selectively for a specific application mode (development, test), relying on one of the profiles which are automatically configured by Arconia (see Profiles).

You can enable/disable the Dev Service for a specific test class by using the @TestProperty annotation or equivalent Spring testing utilities.