OAuth 2.0 單元測(cè)試解決方案
為什么需要單元測(cè)試
單元測(cè)試擁有保證代碼質(zhì)量、盡早發(fā)現(xiàn)軟件 Bug、簡(jiǎn)化調(diào)試過(guò)程、促進(jìn)變化并簡(jiǎn)化集成、使流程更靈活等優(yōu)勢(shì)。單元測(cè)試是針對(duì)代碼單元的獨(dú)立測(cè)試,核心是“獨(dú)立”,優(yōu)勢(shì)來(lái)源也是這種獨(dú)立性,而所面臨的不足也正是因?yàn)槠洫?dú)立性:既然是“獨(dú)立”,就難以測(cè)試與其他代碼和依賴環(huán)境的相互關(guān)系。單元測(cè)試與系統(tǒng)測(cè)試是互補(bǔ)而非代替關(guān)系。單元測(cè)試的優(yōu)勢(shì),正是系統(tǒng)測(cè)試的不足,單元測(cè)試的不足,又恰是系統(tǒng)測(cè)試的優(yōu)勢(shì)。不能將單元測(cè)試當(dāng)做解決所有問(wèn)題的萬(wàn)金油,而需理解其優(yōu)勢(shì)與不足,揚(yáng)長(zhǎng)避短,與系統(tǒng)測(cè)試相輔相成,實(shí)現(xiàn)測(cè)試的最大效益。
OAuth2 系統(tǒng)單元測(cè)試?yán)щy
接口測(cè)試依賴于 UPMS (用戶權(quán)限管理),無(wú)法做到解耦獨(dú)立
spring-security-test 模塊未提供相關(guān)標(biāo)準(zhǔn)實(shí)現(xiàn)
場(chǎng)景復(fù)雜既要包含無(wú)狀態(tài) token 調(diào)用,又要保證上線文傳遞業(yè)務(wù)
解決方案
參考 @WithMockUser ,在 Mock 攔截器中自動(dòng)執(zhí)行相關(guān)的增強(qiáng)(token 獲取),并通過(guò)擴(kuò)展 WithSecurityContextFactory 實(shí)現(xiàn)上下文 token 的傳遞。具體可以參考源碼pig-common-test[1]
引入依賴
<dependency>
??<groupId>com.pig4cloudgroupId>
??<artifactId>pig-common-testartifactId>
??<version>${last.version}version>
??<scope>testscope>
dependency>
單元測(cè)試 Controller 接口
指定認(rèn)證中心接口
#?配置在?test/resources/application.yml
security:
??oauth2:
????client:
??????access-token-uri:?http://pig-gateway:3000/oauth/token
模擬測(cè)試 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());
?}
}
模擬測(cè)試 FeignClient 傳遞 token
直接注入 FeignClient 實(shí)現(xiàn)即可 使用 ?@WithMockOAuth2User 注解測(cè)試類即可
WithMockOAuth2User 屬性說(shuō)明
當(dāng)前用例獲取 token 使用的用戶名
String?username()?default?"admin";
當(dāng)前用例獲取 token 使用的密碼
String?password()?default?"123456";
寫在最后
源碼參考 pig-common-test[2] 模塊 目前僅在 pig 2.10[3]做了實(shí)現(xiàn),理論支持低版本,直接 install 此模塊即可
參考資料
pig-common-test: https://gitee.com/log4j/pig/tree/master/pig-common/pig-common-test
[2]pig-common-test: https://gitee.com/log4j/pig/tree/master/pig-common/pig-common-test
[3]pig 2.10: https://gitee.com/log4j/pig
