MSTest 使用規則

使用規則支持正確使用 MSTest 屬性、方法與模式。 這些規則能捕捉常見錯誤，並確保你的測試符合框架的要求與慣例。

此類別的規則

* 運行於Recommended和All模式時已升級為錯誤狀態。

常見場景

測試結構驗證

確保您的測試類別、方法與夾具符合 MSTest 要求：

• MSTEST0002：測試類別的配置要求（例如，公開、非靜態）。
• MSTEST0003：測試方法佈局要求（️⚠已升級為錯誤）。
• MSTEST0030：具有 [TestMethod] 的方法必須位於 [TestClass] 中。
• MSTEST0063：測試類別建構子驗證。
• MSTEST0069：直接套用 [TestClass]，讓原始碼產生的發現能找到該類別。
• MSTEST0082：將基礎和衍生的測試類別放在同一個 MSTest 主版本上。
• MSTEST0085：從抽象基底類別中移除 [TestClass] 。
• MSTEST0086：移除測試類別已經提供行為的方法屬性。

生命週期方法

驗證初始化與清理方法：

• MSTEST0008：測試初始化驗證。
• MSTEST0009：TestCleanup 驗證。
• MSTEST0010：ClassInitialize 驗證。
• MSTEST0011：ClassCleanup 驗證。
• MSTEST0012：AssemblyInitialize 驗證。
• MSTEST0013：AssemblyCleanup 驗證。
• MSTEST0034：將 ClassCleanupBehavior 設為 EndOfClass。
• MSTEST0050：全球測試夾具驗證。
• MSTEST0072：不要使用共用組裝夾具供應商，並預先編輯。
• MSTEST0082：根據測試專案的 MSTest 版本重新編譯繼承的生命週期方法。

數據驅動測試

確保資料屬性正確使用：

• MSTEST0007：資料屬性必須設於測試方法上。
• MSTEST0014：DataRow 驗證。
• MSTEST0018：DynamicData 驗證。
• MSTEST0042：偵測重複資料列。
• MSTEST0052：使用 AutoDetect 來處理 DynamicDataSourceType。
• MSTEST0062：避免使用 out/ref 參數。
• MSTEST0087：給每個明確 DataRow 的顯示名稱一個唯一的值。

撰寫更佳的陳述

正確且有效斷言使用的規則：

• MSTEST0017：以正確的順序傳遞預期值和實際值。
• MSTEST0023：不要否定條件（直接使用 Assert.IsFalse）。
• MSTEST0026：在斷言中避免使用空條件運算子。
• MSTEST0032：檢視永遠正確的條件。
• MSTEST0037：使用最合適的主張方法。
• MSTEST0038：不要用 AreSame 來設定值型別。
• MSTEST0039：使用 Assert.ThrowsExactly（較新的 API）。
• MSTEST0046：偏好 Assert 而非 StringAssert。
• MSTEST0051：斷言。擲骰應該測試單一陳述。
• MSTEST0053：使用字串插值代替格式參數。
• MSTEST0058：不要把斷言放在捕捉區塊裡。
• MSTEST0064：偏好非同步斷言方法，而非非同步程式碼的阻塞。
• MSTEST0065：避免將 Assert.AreEqual 用於集合類型。
• MSTEST0068：建議使用 Assert 而非 CollectionAssert。

TestContext 的使用

TestContext 物件的正確使用：

• MSTEST0005：TestContext 屬性驗證。
• MSTEST0024：不要將 TestContext 儲存在靜態欄位。
• MSTEST0048：限制設施進入。
• MSTEST0049：來自 TestContext 的流量消除標記。
• MSTEST0054：使用 TestContext.CancellationToken 屬性。

非同步模式

非同步測試程式碼規則：

• MSTEST0040：避免在非同步 void 方法中使用斷言。
• MSTEST0067：避免在測試程式碼中使用 Thread.Sleep、Task.Wait 及其他會同步封鎖的呼叫（選擇啟用）。

平行測試安全

平行執行的測試規則：

• MSTEST0073：資源鎖鑰匙使用共享常數。
• MSTEST0074：將突變鎖定為 process-global 狀態。
• MSTEST0075：鎖定目前目錄的變更。
• MSTEST0076：避免全流程培養突變。
• MSTEST0077：避免共用檔案系統路徑。

測試組態

• MSTEST0031：使用正確的屬性（而非 System.ComponentModel.Description）。
• MSTEST0035：部署項目使用情況。
• MSTEST0041：條件屬性必須存在於測試類別上。
• MSTEST0043：重試屬性必須在測試方法上（️⚠已升級為錯誤）。
• MSTEST0055：不要忽略字串方法的回傳值。
• MSTEST0056：在 TestMethodAttribute 上正確設定 DisplayName。
• MSTEST0057：在自訂的 TestMethodAttribute 中傳播原始碼資訊。
• MSTEST0059：不要同時使用 Parallelize 和 DoNotParallelize。
• MSTEST0060：避免重複 TestMethodAttribute。
• MSTEST0061：使用 OSCondition 屬性來進行平台檢查。
• MSTEST0070： [MemberCondition] 論證必須引用有效成員。
• MSTEST0071：不要設定顯示名稱等於測試方法名稱。
• MSTEST0078：驗證 [DependsOn] 目標與依賴圖。
• MSTEST0079：使用 ArchitectureCondition 執行時架構檢查來取代。
• MSTEST0080：請使用 CICondition，不要使用環境檢查。
• MSTEST0081：驗證測試過濾器提供者的註冊。
• MSTEST0082：偵測針對另一個 MSTest 主要版本編譯的繼承測試與生命週期方法。
• MSTEST0083：請使用 ExecutableCondition，而非命令式的可執行檢查。
• MSTEST0084：將平台相容性屬性 OSCondition與 對齊。

相關文件

• 用 MSTest 撰寫測試
• 斷言
• 生命週期
• 測試上下文