Testing with Spring Boot

Spring Reference Guides

Spring Framework
Spring Boot
- Testing
Spring Security
- Testing
- Spring MVC Test Integration

JUnit

@RunWith

When a class is annotated with @RunWith or extends a class annotated with @RunWith, JUnit will invoke the class it references to run the tests in that class instead of the runner built into JUnit. We added this feature late in development. While it seems powerful we expect the runner API to change as we learn how people really use it. Some of the classes that are currently internal will likely be refined and become public.

@RunWith allows you to provide an alternate test runner to JUnit's build-in test runner.

Spring Framework

SpringJUnit4ClassRunner

SpringMethodRule is a custom JUnit MethodRule that supports instance-level and method-level features of the Spring TestContext Framework in standard JUnit tests by means of the TestContextManager and associated support classes and annotations.

@RunWith(SpringJUnit4ClassRunner.class)

ReflectionTestUtils

ReflectionTestUtils is a collection of reflection-based utility methods for use in unit and integration testing scenarios.

@ContextConfiguration

@ContextConfiguration defines class-level metadata that is used to determine how to load and configure an ApplicationContext for integration tests.

@WebAppConfiguration

@WebAppConfiguration is a class-level annotation that is used to declare that the ApplicationContext loaded for an integration test should be a WebApplicationContext.

The mere presence of @WebAppConfiguration on a test class ensures that a WebApplicationContext will be loaded for the test using a default for the path to the root of the web application. To override the default, specify an explicit resource path via the value() attribute.

Note that @WebAppConfiguration must be used in conjunction with @ContextConfiguration, either within a single test class or within a test class hierarchy.

@ActiveProfiles

ActiveProfiles is a class-level annotation that is used to declare which active bean definition profiles should be used when loading an ApplicationContext for test classes.

MockMvcBuilders

webAppContextSetup(webApplicationContext)

addFilters(springSecurityFilterChain)
alwaysDo(print())

standaloneSetup(controller)

Other Spring Testing Annotations

@ContextHierarchy
@TestPropertySource
@DirtiesContext
@TestExecutionListeners
@Rollback
@BeforeTransaction
@AfterTransaction
@Sql
@SqlConfig
@SqlGroup

Spring Boot

@SpringApplicationConfiguration

Class-level annotation that is used to determine how to load and configure an ApplicationContext for integration tests.

Similar to the standard @ContextConfiguration but uses Spring Boot's SpringApplicationContextLoader.

@WebIntegrationTest

Test class annotation signifying that the tests are "web integration tests" and therefore require full startup in the same way as a production application (listening on normal ports). Normally used in conjunction with @SpringApplicationConfiguration.

This annotation can be used as an alternative to @IntegrationTest and @WebAppConfiguration.

This has a randomPort value which can be set to true.

@WebIntegrationTest(randomPort = true)

@IntegrationTest

Test class annotation signifying that the tests are "integration tests" and therefore require full startup in the same way as a production application. Normally used in conjunction with @SpringApplicationConfiguration.

If your test also uses @WebAppConfiguration consider using the @WebIntegrationTest instead.

Spring Security

<dependency>
    <groupId>org.springframework.security</groupId>
    <artifactId>spring-security-test</artifactId>
    <version>4.0.3.RELEASE</version>
</dependency>

Test Annotations

SecurityMockMvcConfigurers

Provides springSecurity() method for ???

Spring MVC Test Integration
SecurityContextHolder.getContext().setAuthentication(…)

spilth/spring-boot-testing-notes.md

Testing with Spring Boot

Spring Reference Guides

Other Spring Testing Annotations

Test Annotations