摘要：接入分為兩部分，其一是可視化編輯器，在官網上我們可以獲取該編輯器的安裝包，并通過的插件管理進行安裝。借助可視化編輯器，在整個過程中我們可以替換大部分手工編寫代碼的工作，進行一站式操作。
，有趣實用的分布式架構頻道。
本文根據 SOFAChannel#5 直播分享整理，主題：給研發工程師的代碼質量利器 —— 自動化測試框架 SOFAActs。
回顧視頻以及 PPT 查看地址見文末。
歡迎加入直播互動釘釘群：23195297，不錯過每場直播。
大家晚上好，我是螞蟻金服自動化測試框架 SOFAActs 開源核心成員青勤，目前從事測試技術相關的研發工作，今晚將由我來給大家分享交流自動化測試框架 SOFAActs 的基本原理和使用，今天的內容主要分為以下四個章節：
項目介紹
SOFAActs 接入
功能介紹與使用
升階功能使用
歡迎大家 Star 我，SOFAActs：github.com/sofastack/s…
1 項目介紹在分享使用操作前，我將引導大家來熟悉下 SOFAActs 的項目背景、基本原理等。
對于研發質量保障而言，金融系統和金融業務的多樣性、復雜性同樣也會在測試場景、測試驗證和測試流程的復雜程度上得到充分體現。
譬如，對于包含出參、RPC 調用、DB 變更和異常等多個測試驗證點的用例而言，在研發和測試人員維護和驗證用例場景的過程中，時常發生業務結果校驗遺漏，對我們及早發現和糾錯問題造成干擾，進而無法嚴格保障產品質量。這些問題對研發質量保障提出了很高的挑戰，相應的自動化、精細化的白盒測試工具需求日益增長，這其中就包括 SOFAActs。
為了解決上述痛點、滿足精細化測試需要，在多年測試實踐積累與沉淀下，我們研發了基于模型驅動的 SOFAActs 測試框架，它可以靈活、可擴展的提供一站式用例管理，標準化測試執行和精細化校驗。目前 SOFAActs 測試框架逐漸成熟并在螞蟻金服內部得到廣泛應用。
1.1 項目架構
介紹完背景，我們來看下 SOFAActs 的大體框架，SOFAActs 底層封裝并集成適配 SOFABoot 等運行環境。
在重要的引擎層，SOFAActs 封裝了工具類和數據模型，并將測試模式的過程進行了標準化，提供通用測試能力和擴展點。對于有自動化測試經驗的同學來講，測試模式其實并不復雜，這其中有很多工作是可以抽象和固定的，SOFAActs 將這部分內容內聚到引擎層，封裝成標準測試流程等，尤其是模型驅動和精細化校驗等，從而釋放精力，將更多關注點聚焦在待測目標上。
引擎層之上，是 SOFAActs 提供的可視化用例管理功能，可以一站式的維護測試腳本、測試數據和數據模型，借助可視化編輯器可成倍提高用例管理等等操作效率，整體而言 SOFAActs 圍繞模型驅動引擎和可視化編輯器，將測試代碼的編寫工作量極盡降低，目標聚焦在測試對象上。
這里我們示例看下，SOFAActs 對測試代碼和效率的優化。這里以 Credit 接口為例，業務處理開始之前會檢查傳參，構造上下文、隨后發起業務處理，涉及對三張表的讀取或變更，并在數據庫事物結束之后，返回業務處理結果。
針對這一業務邏輯，這里我們構造一個 Credit 接口的完整測試用例，在代碼驅動測試時，它需要一下 9 個步驟，手動準備依賴數據、構造請求參數、執行業務邏輯、校驗業務結果以及數據清理等等，人工介入成本居高，尤其當存在多個用例時，測試代碼可復用性低，測試效率是難以得到有效提升。而與之對比，在模型驅動測試下，Credit 接口的 SOFAActs 測試腳本會對固有的測試模式進行封裝，用例復雜度得到極大精簡，眾多用例數據可以得到高效的可視化管理。
1.2 執行原理
在開始使用 SOFAActs 之前，我們來了解一下有關 SOFAActs 執行引擎的運作原理。SOFAActs 框架也提供了非常多的擴展點，如果需要個性化的定義，可以對每一個環節進行擴展。
上文中已提到過 SOFAActs 執行引擎是對測試模式過程的封裝，Setup 方法是引擎入口，用于加載初始化 SOFAActs 運行時的必需資源，如獲取數據源。
以下是主體測試過程：clear、prepare、execute、check 這 4 個方法依次負責環境清理、依賴準備、執行、結果校驗等。這些內容是代碼驅動測試時需要手寫的測試代碼和內容，每個測試腳本的完成意味著上面的過程會被我們重復一遍，于是 SOFAActs 將這部分內容進行了封裝，實現了最通用基礎的功能。
右側，我們對高頻數據如方法入參、出參、異常和依賴DB數據進行了抽象，給出 SOFAActs 的模型，這是代碼驅動轉向模型驅動、精細化校驗的基礎。左側的數據總線會貫穿每個用例的執行生命周期，即貫穿中間的主體測試過程，如果大家對框架封裝的基礎功能有自定義需要，可以通過數據總線對 SOFAActs 的對象、方法進行獲取、重寫，以便更靈活的控制框架行為。當然 SOFAActs 對這些內容作了較好的封裝，覆蓋了大部分的測試需求，無需大家過度關注。
以上就是 SOFAActs 的執行原理，接下來我會給大家詳細介紹 SOFAActs 的接入和使用。
2 SOFAActs 接入SOFAActs 分為兩部分，其一是可視化編輯器，在 SOFAStack 官網上 [1] 我們可以獲取該編輯器的安裝包，并通過 IDEA 的插件管理進行安裝。其二是 SOFAActs 的基礎 jar，它提供了 SOFAActs 用例運行的環境支持，在 test 模塊 pom 中添加下列依賴即可，有關 test 模塊或者多模塊詳細內容大家可以參考 SOFAActs 的快速開始文檔 [1] 。
3 功能介紹和使用下面，我們進入 SOFAActs 的功能介紹和使用章節，這部分我將分為三小節展開：一站式構建、SOFAActs 核心的模型驅動以及 SOFAActs 提供的精準校驗。
3.1 一站式構建一站式構建中，SOFAActs 通過可視化編輯器為我們提供了便捷操作，以幫助一鍵配置初始化、構建測試腳本與模型，可視化管理用例數據等等。借助可視化編輯器，在整個過程中我們可以替換大部分手工編寫代碼的工作，進行一站式操作。
一鍵初始化
這里我們示例看下，如何操作一鍵初始化以及一鍵初始化做哪些內容。首先一鍵初始化框架只需要 3 個鼠標點擊步驟。在 Package 視圖下選中測試模塊并右鍵選擇 SOFAActs 功能，一鍵初始化，輸入該應用的應用名稱和工程編碼格式。在一鍵初始化完成后，SOFAActs 將會在 test 模塊寫入 SOFAActs 配置文件，DB 連接配置文件，測試套件配置文件以及創建模型存儲目錄等。
acts-config 配置文件是 SOFAActs 的核心配置，提供了測試環境切換、數據庫連接切換、冒煙測試以及預跑反填等配置，來開關 SOFAActs 的相關功能；model 目錄用于存放對象模型、數據模型，以便對模型進行統一管理；DB 配置文件指明了數據庫連接信息，用于生成數據模型時自動填充表結構和模版數據。
一鍵生成測試腳本
在完成配置初始化操作后，我們可以開始第一個用例的編寫，SOFAActs 提供了一鍵測試腳本生成功能。以待測的 getMessage 接口為例，在其方法定義上右鍵選擇 SOFAActs 功能，生成測試用例，在彈出框中檢查用例信息，修正無誤后點擊確定可以生成該接口的測試腳本。校正依賴的啟動類并運行 SOFAActs 測試腳本，可以看到能夠正常啟動 SOFABoot，SOFAActs 會拉起 SOFABoot 以盡量模擬業務代碼運行時的容器環境，因此如果存在 SOFABoot 上下文加載失敗，需要排查應用配置。
一鍵生成數據模型
通常在我們創建 SOFAActs 測試腳本時方法入參和出參的對象模型會一并生成好，因此這里著重介紹下如何一鍵生成數據模型。事先，我們在 acts-config 配置文件中，指明 DB 環境如 dev 并配置 dev 環境下 DB 連接信息。就緒后，我們打開測試腳本，在被 @test 注解的方法上右鍵選擇 SOFAActs 功能，生成 DB 表結構模型，在彈出視圖中選擇需要的 DB 表，當有多個表時，可以一并添加至右側，點擊 OK 以生成 DB 模型，之后可在 model／dbModel 目錄查看生成的數據模型。
稍后模型驅動內容中，我將給大家詳細介紹 SOFAActs 中模型的概念和使用。
可視化用例管理
在 SOFAActs 編輯器中，我們能夠可視化地修改入參、DB 和結果數據等。在用例級別，編輯器提供了用例復制功能，對于設計等價用例而言，通常正常測試用例之間，異常測試用例之間的差異可能只在于某一關鍵字段的取值，而大部分數據是相同的，這時用例數據復用十分必要。SOFAActs 提供了用例復制等管理功能，可用于快速發起用例構建。
3.2 模型驅動下面我們介紹模型驅動，在代碼驅動測試時，方法入參、出參和 DB等測試數據是通過代碼組織的，隨著業務復雜度提升，尤其在金融級業務場景中，類和表動輒十幾個屬性或者字段，屬性嵌套也時常可見，代碼驅動測試難移應對：測試腳本可復用性低、測試數據管理困難等問題。于是，SOFAActs 將方法入參、出參、異常和 DB 等數據抽象為模型，用以結構化地記錄數據類型、取值和校驗規則，可以快速發起用例數據構建。
SOFAActs 中的模型主要分為：數據模型和對象模型。
對象模型：主要用于構造方法入參、期望結果和期望異常。期望結果和期望異常是指在符合測試預期下被測方法的返回結果或者異常拋出。
數據模型：對于一個有 DB 依賴的業務場景的測試驗證，需要生成相關 DB 表的數據模型，用于快速構建 DB 準備數據和期望數據。DB 準備數據是業務執行期間依賴的前置 DB 數據，例如在驗證轉賬場景時參與雙方的賬戶余額等，DB 期望數據是指在符合測試預期下，被測方法對 DB 的變更。
經過模型化，一個復雜對象或數據可以被快速模版化地創建、拷貝和校驗，達到測試數據與測試代碼解耦合的效果，另一方面，配套使用 SOFAActs 編輯器，實現測試數據一站式管理，來提高用例編寫效率和降低維護成本。
下面我詳細介紹下數據模型和對象模型的結構和使用。
3.2.1 數據模型通常 SOFAActs 只需要填充 DB 準備數據，而 DB 期望數據可以利用預跑反填功能進行自動采集。
為了更好地理解數據模型， 在model／dbModel 下的 csv 文件中，我們可以看到某一張表的全部字段、取值以及校驗規則。數據模型聚合了表的結構、數據和校驗規則，結合可視化編輯器可快速創建、復制 DB 數據，一次編輯多次使用。這里我們來看下示例，在編輯器如何使用數據模型。
3.2.2 對象模型對象模型，它是方法入參、出參等對象在 SOFAActs 中的映射，可以在 model／objModel 目錄下查看生成的對象模型。對象模型的結構和數據模型相似，是屬性、取值、校驗規則的聚合，與數據模型不同的是，對象模型可能存在多層嵌套，因為類的某一屬性可以是 map、集合、類等引用類型。
在 SOFAActs 編輯器中可以為一個新的用例添加入參數據，如果入參是簡單類型，如 int、String 等可以選擇簡單類型填充，這里示例下復雜類型，即業務對象的模型使用，在左側的列表中選擇目標對象，添加至右側，如果有多個入參可以一并添加到右側后，再點擊確定，即可以在入參設置中看到入參數據并可進行編輯。對于有多個入參的方法，入參設置中從上之下的順序和方法聲明入參順序是需要一致的。
3.3 精細化校驗下面我們介紹精細化校驗，在一開始時，我們提及到復雜業務場景下極易出現校驗遺漏，形成校驗假綠。為此，SOFAActs 內置了精細化校驗，從校驗規則和行為還原兩點，來保證復雜場景的校驗覆蓋。
如右圖，SOFAActs 將重復性 assert 代碼抽象歸納為校驗規則，與測試數據一同作為數據模型的一部分，可以細化校驗每個字段。目前acts支持的校驗標簽如下，其中常用有 Y、N、C 標簽，Y 表示了校驗時必須一致的對象或屬性、N 表示校驗時不關心的屬性或記錄值、C 標簽標示 DB 數據校驗時的 DB 查詢條件，即 where 條件，參考右圖我們可以理解標簽的使用。
為了真實還原業務行為以提高驗證覆蓋和用例數據的編寫效率，SOFAActs 提供了行為還原，作為精細化校驗的一部分，行為還原在 SOFAActs 中稱為預跑反填功能，是指在方法入參、依賴的 DB 數據等用例正常執行的基本數據準備完成后，可先不必填寫期望數據而直接運行測試腳本，框架可自動捕獲運行時方法返回結果、所有 DB 表變更等數據，通過 SOFAActs 編輯器可填充用例的期望數據，小幅度修正和標記校驗規則后即可完成全部校驗點的參考數據的編寫。
這里我給大家演示如何使用 SOFAActs 的預跑反填功能：
啟用 SOFAActs 的預跑反填功能需要在 acts-config 中打開結果收集開關，然后執行用例，運行完畢喚起 SOFAActs 編輯器，點擊左上角的預跑反填，選中需要的用例數據，點擊確定就完成了相應用例的期望結果、期望 DB 數據的構造，但預跑反填功能本身并不保障校驗數據的準確性，需要針對待測業務場景將數據修正。
4 進階功能下面，我們進入本次分享的最后一部分，SOFAActs 進階功能的使用。這里為大家介紹使用頻度最高的兩個功能：自定義引擎流程和參數化。
稍做回憶，在一開始我們熟悉了 SOFAActs 的運行原理，提及到 SOFAActs 執行引擎是對測試模式過程的封裝，同時為數據模型、數據總線提供了擴展點，這里我們舉例使用、重寫這些 API 。另一個高頻功能是參數化，提供了運行動態替換 String 類型取值的功能，以滿足部分隨機動態的測試需要。
@Override
public void check(ActsRuntimeContext actsRuntimeContext) {
if (actsRuntimeContext.caseId.endsWith("001")) {
if (((AccountTransResult) actsRuntimeContext.getResultObj()).isSuccess()) {
actsRuntimeContext.paramMap.put("status", "0");
} else {
actsRuntimeContext.paramMap.put("status", "1");
}
actsRuntimeContext.refreshDataParam();
}
super.check(actsRuntimeContext);
}我們以 check 流程為例，重寫了 check 方法來滿足動態校驗，這里依據返回結果設置了自定義參數，放置到數據總線 Actsruntimecontext 中，我們將期望 DB 數據中的 mast 表的 status 字段設置為自定義參數，表示該字段的期望值應該和方法返回結果中的狀態保持一致或者關聯。然后運行用例來查看我們重寫的校驗是否達到了預期。
5 總結SOFAActs 提供了很多擴展點可以讓大家適配應用的測試需求，如果你需要一個更強大的 SOFAActs，可以動手重寫這些 API 將基礎功能進行延伸，當然更歡迎大家在 Github 中提 Issue、Commit 來一同完善 SOFAActs。
以上內容由 SOFAChannel#5 直播分享整理，如果大家有疑問可以在釘釘群（搜索群號即可加入：23195297）或者 Github 上與我們討論交流，我們將進行解答。
SOFAActs：github.com/sofastack/s…
文章相關涉及鏈接[1] SOFAActs 下載地址以及快速開始文檔：www.sofastack.tech/sofa-acts/d…
[2] 示例視頻：www.yuque.com/huarou/gd4s…
本期視頻回顧以及 PPT 查看地址tech.antfin.com/activities/…
往期直播精彩回顧分布式事務 Seata TCC 模式深度解析 | SOFAChannel#4 直播整理：tech.antfin.com/activities/…
SOFAChannel#3 SOFARPC 性能優化實踐（下）：tech.antfin.com/activities/…
SOFAChannel#2 SOFARPC 性能優化實踐（上）：tech.antfin.com/activities/…
SOFAChannel#1 從螞蟻金服微服務實踐談起：tech.antfin.com/activities/…
6 SOFAMeetup#2 上海站 報名 ingSOFA Meetup #2 上海站《使用 SOFAStack 快速構建微服務》報名進行中?~
5 月 26 日，SOFAStack 開源核心成員集體出動。本期我們將側重于各個落地的實際場景進行架構解析。
分布式事務 Seata 詳解、與 Spring Cloud 生態的融合案例、使用 SOFAStack 快速構建微服務 Demo 實操、更有最新開源的《讓 AI 像 SQL 一樣簡單 — SQLFlow Demo 》首秀，期待與你不見不散~
戳鏈接即可報名：tech.antfin.com/community/a…
公眾號：金融級分布式架構（Antfin_SOFA）
