OAuth 2.0 單元測試解決方案

為什麼需要單元測試

單元測試擁有保證代碼品質、盡早發現軟體 Bug、簡化調試過程、促進變化并簡化內建、使流程更靈活等優勢。單元測試是針對代碼單元的獨立測試，核心是“獨立”，優勢來源也是這種獨立性，而所面臨的不足也正是因為其獨立性：既然是“獨立”，就難以測試與其他代碼和依賴環境的互相關系。單元測試與系統測試是互補而非代替關系。單元測試的優勢，正是系統測試的不足，單元測試的不足，又恰是系統測試的優勢。不能将單元測試當做解決所有問題的萬金油，而需了解其優勢與不足，揚長避短，與系統測試相輔相成，實作測試的最大效益。

OAuth2 系統單元測試困難

• 接口測試依賴于 UPMS (使用者權限管理)，無法做到解耦獨立
• spring-security-test 子產品未提供相關标準實作
• 場景複雜既要包含無狀态 token 調用，又要保證上線文傳遞業務

解決方案

參考 @WithMockUser ，在 Mock 攔截器中自動執行相關的增強（token 擷取），并通過擴充 WithSecurityContextFactory 實作上下文 token 的傳遞。具體可以參考源碼 pig-common-test[1]

引入依賴

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

單元測試 Controller 接口

• 指定認證中心接口

配置在 test/resources/application.yml
security:
  oauth2:
    client:
      access-token-uri: http://pig-gateway:3000/oauth/token           

• 模拟測試 controller 接口

@RunWith(SpringRunner.class)
@SpringBootTest
public class SysLogControllerTest {

 private MockMvc mvc;

 @Autowired
 private WebApplicationContext applicationContext; // 注入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());
 }
}           

模拟測試 FeignClient 傳遞 token

-

直接注入 FeignClient 實作即可 使用 @WithMockOAuth2User 注解測試類即可

WithMockOAuth2User 屬性說明

• 目前用例擷取 token 使用的使用者名

String username() default "admin";           

• 目前用例擷取 token 使用的密碼

String password() default "123456";           

寫在最後

源碼參考

pig-common-test

子產品

目前僅在 pig 2.10 做了實作，理論支援低版本，直接 install 此子產品即可

項目推薦: Spring Cloud 、Spring Security OAuth2的RBAC權限管理系統 歡迎關注