Spring-boot default profile for integration tests

java

test-environment

spring-boot

integration-tests

byAnton Shumikhin·Dec 3, 2024

To set a default profile for integration tests in Spring Boot, annotate your test classes using @ActiveProfiles("integration"):

@ActiveProfiles("integration")
public class MyIntegrationTests {
    // Test cases here...with plenty of coffee obviously ☕
}

Alternatively, in src/test/resources/application.properties, you can set:

spring.profiles.active=integration

This action will activate the integration profile during the test exercise, ensuring a consistent test environment setup.

For boosting your configuration efficiency, think about using a custom test annotation. It helps to collect shared settings, resulting in less profile definitions scattering around:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@SpringBootTest
@ActiveProfiles("integration")
public @interface IntegrationTest {
    // Custom annotation attributes (if needed), not magicians' secrets 🎩
}

Use the newly created annotation to simply switch profiles with minimal alterations:

@IntegrationTest
public class MyIntegrationTests {
    // Test cases here...did anyone see my green pen? 🖊
}

Upleveling test configuration with meta annotations

Adding finesse to annotations with `@AliasFor`

Employ @AliasFor to tune up your custom annotations. This enables better control over your test environment:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@SpringBootTest
@ActiveProfiles
public @interface IntegrationTest {

    @AliasFor(annotation = ActiveProfiles.class)
    String[] profiles() default "integration"; 
    // Because who doesn't love having a default setting? 💁‍♀️
}

Organizing your configuration files like a pro

Arrange your configuration files neatly in src/test/resources/config/. This makes overriding default properties clear. Also, use spring.config.import to manage a multitude of properties files:

spring:
  config:
    import: classpath:config/application-defaults.yaml
    // Because why do something yourself when you can automate it? 🤖

Within application-test.yml, import main application properties for maintaining consistency:

spring:
  profiles:
    include: default
    // Including all the things...just like a shopping spree 🛍

No more clashes in profiles

Ensure that your test-specific properties in application-test.yml efficiently override defaults. This will put an end to any conflicts with main application configurations.

Streamlining common logic

In order to streamline common setup and teardown logic across different tests, implement specialized base classes. For instance, a @SpringBootTest base class can be extended for all web-layer tests:

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public abstract class WebLayerTestBase {
    // Common web layer setup and teardown done here, let's get tidy 🧹
}

public class UserControllerTest extends WebLayerTestBase {
    // Test cases specific to UserController, the control freak of all classes 🙃
}

Creating robust tests through profile management

Give thought to the structure and contents of your configuration files. Creating robust testing methods require test profiles which are comprehensive to mimic the production environment, yet isolated to avoid unwanted impacts on production settings.

Minor tweaks, major differences

Perform minor adjustments to the configurations in application-test.properties only when necessary. This ensures that tests remain as close to real-world scenarios as possible.

explain-codes / Java / Spring-boot default profile for integration tests

Linked

Override default Spring-Boot application.properties settings in Junit Test



Spring Boot and multiple external configuration files



Unable to find a @SpringBootConfiguration when doing a JpaTest



Populating Spring @Value during Unit Test



Setting active profile and config location from command line in Spring Boot

