單元測試

提示

本內容節錄自《Enterprise Application Patterns Using .NET MAUI》電子書,可以從 .NET Docs 取得,也可以免費下載 PDF 離線閱讀。

《使用 .NET MAUI 的企業應用程式模式》電子書封面縮圖。

多平臺應用程式遇到類似桌面和 Web 應用程式的問題。 行動使用者會根據其裝置、網路連線能力、服務的可用性,以及各種其他因素而有所不同。 因此,因為多平台應用程式會用於真實世界,所以應該進行測試,以改善其品質、可靠性和效能。 許多類型的測試皆應在應用程式上執行,包括單元測試、整合測試和使用者介面測試。 單元測試是建置高品質應用程式最常見的形式和必要作業。

單元測試會採用應用程式的小型單位 (通常是方法),將其與程式碼的其餘部分隔離,並確認其行為正常運作。 其目標是檢查每個功能單位是否正常執行,使錯誤不至於傳播到整個應用程式。 在發生地點偵測 Bug 比在次要故障點間接觀察 Bug 的效果更有效率。

當單元測試是軟體發展工作流程不可或缺的一部分時,對程式碼品質造成的影響最大。 單元測試可作為應用程式的設計文件和功能規格。 一旦方法撰寫完畢,就應該撰寫單元測試,以驗證回應標準、界限和不正確輸入資料案例的方法行為,並檢查程式碼所做的任何明確或隱含假設。 或者,在測試驅動開發中,也可以在程式碼之前撰寫單元測試。 如需測試驅動開發以及如何實作的詳細資訊,請參閱 逐步解說:使用測試總管進行測試驅動開發。。

注意

單元測試對防止回歸非常有效。 也就是說,功能在過去運作正常,但卻因錯誤更新而受到干擾。

單元測試通常會使用準備-執行-斷言模式:

步驟 描述
排列 會初始化物件,並為傳遞至受測方法的資料設定值。
採取行動 會使用必要的引數叫用受測方法。
斷言 驗證受測方法的動作是否正常。

此模式可確保單元測試是可讀取、自我描述和一致的。

選擇測試框架和平台

測試框架會定義用於撰寫測試的屬性、判斷提示和測試生命週期。 測試平台會發現並執行這些測試,並與你的 IDE、命令列及持續整合(CI)管線整合。 VSTest 和 Microsoft.Testing.Platform (MTP) 是測試平台,而不是 MSTest 這類架構的替代方案。

以下框架支援針對與平台無關的 .NET MAUI 應用程式邏輯進行測試:

Framework 框架說明文件 MTP 設定
MSTest MSTest 概述 與 開始使用 MSTest。 用 MSTest 和 MSTest SDK 執行測試。
NUnit 開始使用 C# 和 NUnit。 NUnit 執行器。
xUnit.net 開始學 C# 和 xUnit.net。 xUnit.net v3 內建對 MTP 的支援。 xUnit.net v2 需要第三方整合,而該整合不受 xUnit.net 或 Microsoft 支援。
TUnit TUnit 說明文件。 TUnit 是基於 MTP 建置,不支援 VSTest。

MTP 會將測試作為可執行應用程式來執行。 關於 CLI、IDE 和 CI 的設定,請參見 執行與除錯 MTP 測試。 使用 .NET 10 SDK 或更新版本,你可以在 global.json 中選取 dotnet test 的 MTP 模式。 此模式需 MTP 1.7 或更新版本,且所有選定的測試專案必須支援 MTP。 不要在同一次測試執行中混用以 VSTest 為基礎的專案和以 MTP 為基礎的專案。 平台也使用不同的命令列選項。 詳情請參見使用 dotnet test 進行測試。

了解 .NET MAUI 測試的邊界

要在開發機器上執行單元測試,請將商業邏輯、驗證與檢視模型從平台特定依賴中隔離出來。 一種方法是將程式碼放入 .NET 類別函式庫,讓應用程式和測試專案都參考它。 或者,設定你的 .NET MAUI 應用程式或類別函式庫,以提供相符的非平台特定目標,例如 net10.0。 對於應用程式專案,該目標必須產生函式庫而非執行檔。 避免將原生啟動程式碼和平台特定實作放入該目標中。 關於專案設定,請參見 .NET MAUI 單元測試。

非平台專屬的測試專案不會建立原生的 .NET MAUI 應用程式上下文。 在測試應用程式邏輯時,將對導航、UI 派遣和裝置服務的依賴性替換成測試替身。 這些測試不會驗證原生渲染、裝置權限,或是你所替換服務的實際實作。

若要測試需要平台 API 或原生控制處理器的程式碼,請使用相容的平台測試主機或裝置執行器。 MTP 可以託管在平台應用程式中,但為桌面測試專案選擇 MTP 並不會讓它變成裝置測試應用程式。 關於裝置執行器與平台測試選項,包括其版本要求,請參見 .NET MAUI 單元測試。 要自動化與已部署應用程式的互動,請參閱 使用 Appium 進行的 UI 測試。 在你支援的平台上執行這些測試。

依賴注入和單元測試

為了隔離被測程式碼,使用建構子注入來提供其相依性的測試替身。 測試替身,如假服務與模擬服務,實作與真實服務相同的介面,但為測試提供受控行為。 架構指引請參見 相依注入。

例如,eShop 應用程式的 OrderDetailViewModel 會透過其建構子接收 IAppEnvironmentService、INavigationService 及 ISettingsService 相依性。 請為測試會使用的相依項目提供測試實作,而非呼叫實際的網路服務或裝置 API。

eShop 目錄檢視模型測試顯示完整架構:他們以模擬服務建構AppEnvironmentService,設定這些服務,並連同模擬導航服務一併傳入檢視模型。 使用現成的範例測試來完成完整的建構器與初始化程式碼。 替換服務相依性可隔離應用程式邏輯;它不會移除測試呼叫的其他程式碼中的原生需求。

測試 MVVM 應用程式

當模型和檢視模型不需要原生應用程式環境時,請使用與測試其他 .NET 類別時相同的框架和技術來測試它們。 一些典型用於模型與檢視模型類別的模式,會受益於特定的單元測試技術。

提示

每個單元測試只測試一種行為。 為了讓測試可重複、彼此獨立且易於診斷問題,請將每項測試限制在單一面向。 如需更多指引,請參閱 使用 .NET 進行單元測試的最佳做法。

不要被誘惑去在單元測試中檢驗單元行為的多個方面。 這樣做會產生難以閱讀和更新的測試。 在解釋失敗時,也可能會造成混淆。

eShop 多平台應用程式使用 MSTest。 在 MSTest 中,應用 TestClass 於測試類別及 TestMethod 每個測試方法。 如需了解屬性、簽章和生命週期指引,請參閱 使用 MSTest 撰寫測試。

若要以不同的輸入執行相同的測試,請結合 TestMethod 與 DataRow 來使用內嵌資料,或使用 DynamicData 取得由成員提供的資料。 這些屬性提供了測試案例;它們不是獨立的測試框架或替代方案 TestMethod。 舊版 DataSource 屬性僅適用於 .NET Framework,不適用於現代 .NET 或 .NET MAUI 專案。 有關支援的選項,請參閱 MSTest 中的數據驅動測試。

測試非同步功能

視圖模型通常會呼叫非同步服務作業。 若要測試最終結果而非中間狀態,請先等待該操作完成,再進行斷言。 使用 MSTest 3.3 或更新版本,撰寫會傳回 Task 或 ValueTask 的非同步 MSTest 方法。 不要使用 async void 測試方法。 關於支援的簽章,請參見 「用 MSTest 寫測試」。

例如,ProductsPropertyIsNotNullAfterViewModelInitializationTest 在 eShop 目錄的檢視模型 測試中,會建立一個包含模擬服務的檢視模型,等待 InitializeAsync,並斷言 Products 不為 null。 此測試檢查的是以受控資料進行初始化,而不是真實目錄 Web 服務的行為。 關於應用程式的初始化與導覽流程,請參見 Navigation。

對於非同步指令,請先等待該指令的非同步執行 API 完成,再檢查結果。 單靠呼叫 ICommand.Execute 並不保證非同步工作已經完成。 關於 MVVM Toolkit 的指令 API,請參見 AsyncRelayCommand。

測試 INotifyPropertyChanged 的各種實作方案

INotifyPropertyChanged 介面可讓視圖對模型和視圖模型中的變更做出反應。 要測試通知,將事件處理程序附加於 PropertyChanged,變更屬性,並斷言處理程序收到預期的 PropertyName。 不要把一個無關的屬性通知當成成功。

SettingForenamePropertyShouldRaisePropertyChanged eShop 驗證檢視模型測試中的該測試顯示了這種模式。 它訂閱 Forename 物件的 PropertyChanged 事件,設定 Forename.Value,並檢查 的 Value通知。

此測試驗證通知契約。 它無法驗證 XAML 綁定或原生控制項是否正確更新;用 UI 測試來涵蓋這些行為。

測試訊息式通訊

對於基於訊息的通訊,請使用 MVVM 工具包中的 IMessenger,例如 WeakReferenceMessenger。 如需了解訊息傳遞合約與 API 範例,請參閱 「鬆散耦合元件之間的通訊」 與 MVVM Toolkit 訊息傳遞器。

要測試發佈者,請為預期的訊息類型註冊接收者,執行操作,並斷言接收者已收到預期的有效載荷。 要測試接收端,請先傳送已知的訊息,並斷言產生的檢視模型狀態。 請先等待非同步指令再進行斷言。

為了讓訊息測試彼此隔離,請為每個測試建立一個訊息傳遞器實例,並將同一個實例注入受測程式碼中。 若程式碼使用 WeakReferenceMessenger.Default,則在清理期間取消註冊測試接收者,並防止並行測試干擾共享 Messenger 狀態。 弱參考並不保證接收者會在下一次測試前被垃圾回收。 如需了解清理和隔離選項,請參閱 MSTest 測試生命週期 和 控制測試執行。

注意

MessagingCenter 在 .NET 10 中已被取代。 新程式碼則改用 MVVM Toolkit Messenger。

測試例外狀況處理

要驗證無效動作或輸入是否會拋出例外,請使用框架的例外斷言。 在 MSTest 3.8 或更新版本中,Assert.Throws<T> 接受指定的例外類型或其衍生類型,而 Assert.ThrowsExactly<T> 需要精確的類型。 對於非同步程式碼,請使用 await Assert.ThrowsAsync<T> 或 Assert.ThrowsExactlyAsync<T>,而不是將非同步工作傳入同步斷言。 關於範例及版本專屬 API,請參見 MSTest 斷言。

當例外斷言捕捉到預期的例外時,該斷言即通過;該例外不會被視為未處理的測試失敗。 如果被測試的操作是建構原生視圖或使用平台處理器,仍需適當的應用程式上下文。 例外主張無法提供這樣的上下文。

提示

避免撰寫檢查例外狀況訊息字串的單元測試。 例外狀況訊息字串可能會隨著時間而變更,因此依賴其存在的單元測試會被視為不盡完善。

測試驗證

測試驗證規則及由 ValidatableObject<T>暴露的狀態。 對每條規則,涵蓋有效、無效及邊界輸入。 關於應用程式所使用的驗證模型,請參見 驗證。

eShop 驗證用檢視模型測試提供模擬導航服務給MockViewModel,並執行其Validate方法。 CheckValidationPassesWhenBothPropertiesHaveDataTest 檢查當兩個名稱都有資料時驗證是否成功。 CheckValidationFailsWhenOnlyForenameHasDataTest 檢查缺少姓氏會導致驗證失敗。

檢查 Value、IsValid 和 Errors 屬性,以及整體結果。 例如,當只有名字有資料時,名字應該保持有效且無錯誤,而姓氏則應為無效,並顯示錯誤。 這些斷言是在驗證驗證模型,而不是驗證 UI 是否有正確顯示錯誤訊息。

摘要

單元測試會採用應用程式的小型單位 (通常是方法),將其與程式碼的其餘部分隔離,並確認其行為正常運作。 其目標是檢查每個功能單位是否正常執行,使錯誤不至於傳播到整個應用程式。

為了隔離應用程式邏輯,請以測試替身取代服務相依項。 選擇一個測試框架和相容的測試平台,並使用它們支援的屬性與斷言。

使用一般的 .NET 單元測試來測試與平台無關的模型和檢視模型。 使用裝置、平台、整合和 UI 測試來測試依賴真實服務或原生應用情境的行為。