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 此模塊即可