MSTest 使用規則

使用規則は、MSTest 属性、メソッド、およびパターンの適切な使用をサポートします。 これらの規則は、一般的な間違いをキャッチし、テストがフレームワークの要件と規則に従っていることを確認します。

このカテゴリのルール

* Recommended モードと All モードでエラーにエスカレート。

一般的なシナリオ

テスト構造の検証

テスト クラス、メソッド、フィクスチャが MSTest の要件に従っていることを確認します。

• MSTEST0002: クラス レイアウトの要件をテストします (例: public、non-static)。
• MSTEST0003: テスト メソッドのレイアウト要件 (⚠️ がエラーにエスカレートされました)。
• MSTEST0030: [TestMethod] を持つメソッドは、[TestClass] に含める必要があります。
• MSTEST0063: クラス コンストラクターの検証をテストします。
• MSTEST0069: [TestClass] を直接適用して、ソースによって生成された検出によってクラスが検索されるようにします。

ライフサイクル メソッド

初期化メソッドとクリーンアップ メソッドを検証します。

• MSTEST0008: TestInitialize 検証。
• MSTEST0009: TestCleanup 検証。
• MSTEST0010: ClassInitialize 検証。
• MSTEST0011: ClassCleanup 検証。
• MSTEST0012: AssemblyInitialize 検証。
• MSTEST0013: AssemblyCleanup 検証。
• MSTEST0034: ClassCleanupBehavior.EndOfClass を設定します。
• MSTEST0050: グローバル テスト フィクスチャの検証。
• MSTEST0072: 事前コンパイルで共有アセンブリ フィクスチャ プロバイダーを使用しないでください。

データドリブン テスト

データ属性が正しく使用されていることを確認します。

• MSTEST0007: データ属性はテスト メソッド上にある必要があります。
• MSTEST0014: DataRow 検証。
• MSTEST0018: DynamicData 検証。
• MSTEST0042: 重複する DataRow を検出します。
• MSTEST0052: DynamicDataSourceType に自動検出を使用します。
• MSTEST0062: out/ref パラメーターは使用しないでください。

より優れたアサーションを書く

正しく効果的なアサーションの使用に関する規則:

• MSTEST0017: 予想値と実績値を正しい順序で渡します。
• MSTEST0023: 条件を否定しないでください (Assert.IsFalse を直接使用します)。
• MSTEST0026: アサーションで null 条件演算子を使用しないようにします。
• MSTEST0032: 常に真の条件を確認します。
• MSTEST0037: 最も適切なアサート メソッドを使用します。
• MSTEST0038: 値型で AreSame を使用しないでください。
• MSTEST0039: Assert.ThrowsExactly (新しい API) を使用します。
• MSTEST0046: StringAssert よりも Assert を優先します。
• MSTEST0051: Assert.Throws は 1 つのステートメントをテストする必要があります。
• MSTEST0053: 書式パラメーターの代わりに文字列補間を使用します。
• MSTEST0058: アサーションを catch ブロックに配置しないでください。
• 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: プロセス グローバル状態に変更をロックします。
• MSTEST0075: 現在のディレクトリの変更をロックします。
• MSTEST0076: プロセス全体のカルチャの変異を回避します。
• MSTEST0077: 共有ファイル システム パスは避けてください。

テスト構成

• MSTEST0031: 適切な属性 (System.ComponentModel.Description ではなく) を使用します。
• MSTEST0035: DeploymentItem の使用方法。
• 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: テスト フィルター プロバイダーの登録を検証します。

関連ドキュメント

• MSTest を使用してテストを記述する
• アサーション (命題)
• ライフサイクル
• Testcontext