Skip to content

Commit

Permalink
GH-253 - Let @ApplicationModuleTest be meta-annotated with @SpringBoo…
Browse files Browse the repository at this point in the history
…tTest.

@ApplicationModuleTest is now meta-annotated with @SpringBootTest. This allows us to remove a couple of declarations that we actually had copied from it (such as the TestContextBootstrapper, the SpringExtension etc.)

The presence of the original annotation allow test-related auto-configuration to inspect @SprignBootTest for particular configuration. For example, we now alias the WebEnvironment to make it configurable for the test execution.
  • Loading branch information
odrotbohm committed Aug 2, 2023
1 parent d665161 commit 8c50b3b
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 5 deletions.
6 changes: 6 additions & 0 deletions spring-modulith-integration-test/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,12 @@
<scope>test</scope>
</dependency>

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-webflux</artifactId>
<scope>test</scope>
</dependency>

</dependencies>

</project>
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,16 @@
*/
package com.acme.myproject.moduleA;

import static org.assertj.core.api.Assertions.*;

import org.junit.jupiter.api.Nested;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.reactive.AutoConfigureWebTestClient;
import org.springframework.context.ApplicationContext;
import org.springframework.modulith.test.ApplicationModuleTest;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.web.reactive.server.WebTestClient;

/**
* Integration tests for {@link ApplicationModuleTest}.
Expand All @@ -36,4 +43,19 @@ class SomeNestedClass {
@Test // GH-173
void bootstrapsSecondLevelMestMethod() {}
}

// GH-202
@Nested
@ApplicationModuleTest(verifyAutomatically = false)
@ContextConfiguration
@AutoConfigureWebTestClient
class SampleTest {

@Autowired ApplicationContext context;

@Test
void registersTestWebClient() {
assertThat(context.getBean(WebTestClient.class)).isNotNull();
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,12 @@
import org.junit.jupiter.api.extension.ExtendWith;
import org.springframework.boot.autoconfigure.ImportAutoConfiguration;
import org.springframework.boot.test.autoconfigure.filter.TypeExcludeFilters;
import org.springframework.boot.test.context.SpringBootTestContextBootstrapper;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
import org.springframework.core.annotation.AliasFor;
import org.springframework.modulith.core.DependencyDepth;
import org.springframework.test.context.BootstrapWith;
import org.springframework.test.context.TestConstructor;
import org.springframework.test.context.TestConstructor.AutowireMode;
import org.springframework.test.context.junit.jupiter.SpringExtension;

/**
* Bootstraps the module containing the package of the test class annotated with {@link ApplicationModuleTest}. Will
Expand All @@ -49,10 +48,10 @@
@Documented
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@BootstrapWith(SpringBootTestContextBootstrapper.class)
@SpringBootTest
@TypeExcludeFilters(ModuleTypeExcludeFilter.class)
@ImportAutoConfiguration(ModuleTestAutoConfiguration.class)
@ExtendWith({ SpringExtension.class, PublishedEventsParameterResolver.class, ScenarioParameterResolver.class })
@ExtendWith({ PublishedEventsParameterResolver.class, ScenarioParameterResolver.class })
@TestInstance(Lifecycle.PER_CLASS)
@TestConstructor(autowireMode = AutowireMode.ALL)
public @interface ApplicationModuleTest {
Expand All @@ -77,6 +76,14 @@
*/
String[] extraIncludes() default {};

/**
* The type of web environment to create when applicable. Defaults to {@link WebEnvironment#MOCK}.
*
* @return the type of web environment
*/
@AliasFor(annotation = SpringBootTest.class)
WebEnvironment webEnvironment() default WebEnvironment.MOCK;

public enum BootstrapMode {

/**
Expand Down

0 comments on commit 8c50b3b

Please sign in to comment.