Overcoming OAuth2 Unit Testing Challenges in Spring: A Practical Guide

Why Unit Testing Is Needed

Unit testing guarantees code quality, early bug discovery, simplifies debugging, promotes change, eases integration, and makes processes more flexible. Its core principle is independence, which brings both advantages and limitations: because tests are isolated, they cannot easily verify interactions with other code or environments. Unit testing complements, rather than replaces, system testing; each covers the other's shortcomings.

OAuth2 System Unit Testing Difficulties

Interface testing depends on UPMS (user permission management) and cannot be decoupled.

spring-security-test module does not provide a standard implementation .

Complex scenarios require both stateless token calls and proper context propagation.

Solution

Reference @WithMockUser, which automatically performs token acquisition in a mock interceptor, and use an extended WithSecurityContextFactory to pass the token through the context. See the source code in the pig-common-test module.

Adding Dependency

<dependency>
  <groupId>com.pig4cloud</groupId>
  <artifactId>pig-common-test</artifactId>
  <version>${last.version}</version>
  <scope>test</scope>
</dependency>

Unit Testing Controller Interface

Specify authentication center interface

# configuration in test/resources/application.yml
security:
  oauth2:
    client:
      access-token-uri: http://pig-gateway:3000/oauth/token

Mock test controller interface

@RunWith(SpringRunner.class)
@SpringBootTest
public class SysLogControllerTest {
    private MockMvc mvc;
    @Autowired
    private WebApplicationContext applicationContext; // inject WebApplicationContext

    @Before
    public void setUp() {
        this.mvc = MockMvcBuilders.webAppContextSetup(applicationContext).build();
    }

    @Test
    @SneakyThrows
    @WithMockOAuth2User
    public void testMvcToken() {
        mvc.perform(delete("/log/1").with(token()))
           .andExpect(status().isOk());
    }
}

Mock test FeignClient token passing

Simply inject the FeignClient implementation and use the @WithMockOAuth2User annotation on the test class.

WithMockOAuth2User Attribute Description

Username used to obtain the token in the current test case String username() default "admin"; Password used to obtain the token in the current test case

String password() default "123456";

Final Notes

Source code reference: pig-common-test module.

Implemented in pig 2.10; theoretically supports lower versions—just install this module.

References

pig-common-test: https://gitee.com/log4j/pig/tree/master/pig-common/pig-common-test

pig-common-test: https://gitee.com/log4j/pig/tree/master/pig-common/pig-common-test

pig 2.10: https://gitee.com/log4j/pig