Mock 單元測試

作者：小凱
沉淀、分享、成長，讓自己和他人都能有所收獲！

本文的宗旨在于通過簡單干凈實踐的方式教會讀者，如何使用 Mock (opens new window)進行工程的單元測試，以便于驗證系統中的獨立模塊功能的健壯性。

從整個工程所處不同階段的測試手段包括；單元測試、集成測試、系統測試、驗收測試、性能測試、安全測試、回歸測試，以及兼容、可靠、可用性測試。

而單元測試的重點在于，對工程開發中的代碼，進行流程中的單元化測試。如一整個下單流程中，需要調用各項外部的接口(風控、賬戶、營銷、試算、支付)，才能完成整個下單流程。但在本地開發過程中，不太能將所有的外部接口都調試為開發環境可用狀態，所有這個時候要做單元化測試，對于一些不能隨時提供服務的接口進行 Mock (opens new window)處理。

一、案例背景
因為 Mock 單元測試的重點，主要體現在；功能流程較長、調用外部接口穩定性較差、測試過程中希望可以不啟動 SpringBoot 應用就能對單個功能模塊進行測試驗證。

所以本章節帶著這樣一個案例背景的情況，這里通過《HTTP 框架使用和場景實戰 - 結合ChatGLM自動回帖！》 (opens new window)做一個小重構。來對 Mock 框架進行驗證使用。
在這里插入圖片描述

首先，這里使用 DDD 工程模型結構，搭建出測試工程。—— DDD 是一種軟件設計方法，而軟件的設計方法涵蓋了；范式、模型、框架、方法論。所以通常下 MVC 與 DDD 的對比先從模型、框架在到思想設計和方法論。
之后，我們在這樣的一個模型結構下，實現出自動回帖的領域功能。而這個模型的實現恰好需要調用外部的接口和 ChatGLM SDK，這與我們要做的 Mock 測試正好符合，因為在大部分開發場景下，遠程的 HTTP 調用可能不不會一直可用，所以可以用 Mock 方式進行模擬。
二、功能實現
1. 工程結構
在這里插入圖片描述

在 domain 中實現一個zsxq的自動回帖領域，而它所需的要調用的接口則由基礎設施層提供。
另外在 app 中還有 ChatGLM SDK 的配置啟動，也會被注入到 AiReply 實現類中。

2. Ai模塊啟動

# ChatGLM SDK Config
chatglm:sdk:config:# 狀態；true = 開啟、false 關閉enabled: false# 官網地址api-host: https://open.bigmodel.cn/# 官網申請 https://open.bigmodel.cn/usercenter/apikeysapi-secret-key: d570f7c5d289cdac2abdfdc562e39f3f.trqz1dH8ZK6ED7Pg

@Bean
@ConditionalOnProperty(value = "chatglm.sdk.config.enabled", havingValue = "true", matchIfMissing = false)
public OpenAiSession openAiSession(ChatGLMSDKConfigProperties properties) {// 1. 配置文件cn.bugstack.chatglm.session.Configuration configuration = new cn.bugstack.chatglm.session.Configuration();configuration.setApiHost(properties.getApiHost());configuration.setApiSecretKey(properties.getApiSecretKey());// 2. 會話工廠OpenAiSessionFactory factory = new DefaultOpenAiSessionFactory(configuration);// 3. 開啟會話return factory.openSession();
}

所有的這些配置類的服務，都可以放到 app下的 config 模塊中。
ChatGLM 可以直接在官網申請，默認會贈送18元的額度，對于它所提供的模型，還是非常夠測試使用的。

3. 基礎設置 - 接口調用
3.1 接口 - 防腐對接
源碼：cn.bugstack.xfg.dev.tech.infrastructure.gateway.api.IZSXQApi

public interface IZSXQApi {/*** 查詢知識星球帖子內容** @return 帖子數據* @throws IOException 異常*/ResponseDTO topics() throws IOException;/*** 回復帖子** @param topicId 帖子ID* @param content 回復內容*/void comment(long topicId, String content);}

在基礎設置層中定義 gateway 網關接口調用，對于外部的接口使用，中間要做一層防腐，不要直接把外部的接口暴露出去使用。

3.2 使用 - 依賴倒置
源碼：cn.bugstack.xfg.dev.tech.infrastructure.gateway.adapter.ZSXQAdapter

public class ZSXQAdapter implements IZSXQAdapter {@Resourceprivate IZSXQApi zsxqApi;@Overridepublic List<TopicsItemVO> queryTopics() {try {ResponseDTO responseDTO = zsxqApi.topics();RespData respData = responseDTO.getRespData();List<TopicsItem> topics = respData.getTopics();List<TopicsItemVO> topicsItemVOList = new ArrayList<>();for (TopicsItem topicsItem : topics) {TopicsItemVO topicsItemVO = TopicsItemVO.builder().topicId(topicsItem.getTopicId()).talk(topicsItem.getTalk().getText()).showCommentsItems(topicsItem.getShowComments() != null ? topicsItem.getShowComments().stream().map(showCommentsItem -> {TopicsItemVO.ShowCommentsItem item = new TopicsItemVO.ShowCommentsItem();item.setUserId(showCommentsItem.getOwner().getUserId());return item;}).collect(Collectors.toList()) : new ArrayList<>()).build();topicsItemVOList.add(topicsItemVO);}return topicsItemVOList;} catch (IOException e) {throw new RuntimeException(e);}}@Overridepublic boolean comment(long topicId, String content) {zsxqApi.comment(topicId, content);return true;}}

注意，TopicsItemVO 對象來自于 domain 下領域中模型下的 VO 對象。因為是依賴倒置的，所以 infrastructure 引用的是 domain 并對其接口做實現處理。
并且，TopicsItemVO 只是需要獲取自己需要的對象，還可以做簡單的封裝處理。這樣可以銜接外部接口和內部邏輯中間的橋梁，不做強關聯。

4. 任務調度
源碼：cn.bugstack.xfg.dev.tech.job.ReplyJob

public class ReplyJob {@Resourceprivate IAiReply aiReply;@Scheduled(cron = "0/10 * * * * ?")public void exec() throws Exception {log.info("自動回帖任務開始執行...");aiReply.doAiReply();}}

現在在 trigger 觸發器層中的 job 下，就可以調用我們已經實現好的 AiReply 自動回帖功能了。
此外，注意 Application 中 @EnableScheduling 注解是開啟的，否則任務不能執行。

三、系統測試
1. 集成測試

@Slf4j
@RunWith(SpringRunner.class)
@SpringBootTest
public class ApiTest {@Resourceprivate IAiReply aiReply;@Testpublic void test_IAiReply() {aiReply.doAiReply();}}

通常情況下這種測試是最多的，寫多少功能，就直接測試調用。如功能中所用到的；HTTP接口、RPC接口、數據庫、Redis等資源，都會需要使用到。有時候也因為這樣，所以不好測試。那么單元測試就出現了。

2. 單元測試

@Slf4j
@RunWith(SpringRunner.class)
@SpringBootTest
public class MockTest {@Resourceprivate IAiReply aiReply;@MockBeanprivate IZSXQAdapter izsxqAdapter;@Testpublic void test_doAiReply() throws InterruptedException, JsonProcessingException {Mockito.when(izsxqAdapter.queryTopics()).thenReturn(new ArrayList<TopicsItemVO>() {{TopicsItemVO topicsItemVO = new TopicsItemVO();topicsItemVO.setTopicId(10001L);topicsItemVO.setTalk("<e type=\"mention\" uid=\"241858242255511\" title=\"%40%E5%B0%8F%E5%82%85%E5%93%A5\" /> 提問 java 冒泡排序");add(topicsItemVO);}});Mockito.when(izsxqAdapter.comment(Mockito.anyLong(), Mockito.anyString())).thenReturn(true);aiReply.doAiReply();// 等待；ChatGLM 異步回復new CountDownLatch(1).await();}}

在這里插入圖片描述

在基于使用 SpringBoot 的啟動，以及一部分功能需要走真實調用的情況下，另外一部分功能的接口可能沒法調用時。可以使用這樣的一種 MockBean 的方式進行處理，并對整條鏈路上調用到的接口方法進行 Mock 處理。`Mockito.when(調用到的接口).thenReturn(返回的結果);
那么現在在測試方法中，做了2個Mock操作，把查詢帖子和回復帖子，都給處理掉。也就是有了 Mock 以后，程序調用到這里，就直接走 Mock 里設置的結果信息了。

3. 功能測試

@Slf4j
@RunWith(MockitoJUnitRunner.class)
public class ZSXQAdapterTest {@Mockprivate IZSXQApi mockZsxqApi;@InjectMocksprivate ZSXQAdapter zsxqAdapterUnderTest;@Testpublic void testQueryTopics() throws Exception {// Setupfinal List<TopicsItemVO> expectedResult = Arrays.asList(TopicsItemVO.builder().topicId(0L).talk("talk").showCommentsItems(Arrays.asList(TopicsItemVO.ShowCommentsItem.builder().userId(0L).build())).build());// Configure IZSXQApi.topics(...).final ResponseDTO responseDTO = new ResponseDTO();final RespData respData = new RespData();final TopicsItem topicsItem = new TopicsItem();final ShowCommentsItem showCommentsItem = new ShowCommentsItem();final Owner owner = new Owner();owner.setUserId(0L);showCommentsItem.setOwner(owner);topicsItem.setShowComments(Arrays.asList(showCommentsItem));final Talk talk = new Talk();talk.setText("talk");topicsItem.setTalk(talk);topicsItem.setTopicId(0L);respData.setTopics(Arrays.asList(topicsItem));responseDTO.setRespData(respData);when(mockZsxqApi.topics()).thenReturn(responseDTO);// Run the testfinal List<TopicsItemVO> result = zsxqAdapterUnderTest.queryTopics();// Verify the resultsassertEquals(expectedResult, result);log.info("測試結果：{}", JSON.toJSONString(result));}}

在這里插入圖片描述

除了前面兩種測試，我們在開發功能的時候，還有場景測試；不啟動 SpringBoot 但希望對實現的功能進行測試。
那么這里所體現的就是這樣的測試，主要使用；@RunWith(MockitoJUnitRunner.class)、@Mock、@InjectMocks 相當于模擬了一個啟動的過程，只不過都是 Mock 的信息。但你可以根據這些信息來調試你的接口。
提示：你可以安裝 IDEA Plugin Squaretest 它能自動的幫你生成Mock單元測試。這個插件是收費的，但還好不貴。