MSTest ベストプラクティス (MSTest 3.x/4.x)

モダンな MSTest を使った効果的なユニットテストの作成を支援します。現在の API とベストプラクティスに従います。

プロジェクトセットアップ

• テストプロジェクトは [ProjectName].Tests という命名規則を使用する
• MSTest 3.x 以上の NuGet パッケージを参照する (アナライザーを含む)
• 簡潔なプロジェクトセットアップのために MSTest.Sdk の使用を検討する
• dotnet test でテストを実行する

テストクラスの構造

• テストクラスには [TestClass] 属性を使用する
• テストクラスはデフォルトで sealed にする パフォーマンスと設計の明確性のため
• テストメソッドには [TestMethod] を使用する ([DataTestMethod] より推奨)
• Arrange-Act-Assert (AAA) パターンに従う
• テストに MethodName_Scenario_ExpectedBehavior というパターンで命名する

[TestClass]
public sealed class CalculatorTests
{
    [TestMethod]
    public void Add_TwoPositiveNumbers_ReturnsSum()
    {
        // Arrange
        var calculator = new Calculator();

        // Act
        var result = calculator.Add(2, 3);

        // Assert
        Assert.AreEqual(5, result);
    }
}

テストライフサイクル

• [TestInitialize] よりコンストラクタを推奨 - readonly フィールドを有効にし、標準的な C# パターンに従う
• [TestCleanup] はテストが失敗した場合でも実行する必要があるクリーンアップに使用する
• 非同期セットアップが必要な場合は、コンストラクタと非同期 [TestInitialize] を組み合わせる

[TestClass]
public sealed class ServiceTests
{
    private readonly MyService _service;  // コンストラクタで readonly を有効化

    public ServiceTests()
    {
        _service = new MyService();
    }

    [TestInitialize]
    public async Task InitAsync()
    {
        // 非同期初期化のみに使用する
        await _service.WarmupAsync();
    }

    [TestCleanup]
    public void Cleanup() => _service.Reset();
}

実行順序

1. アセンブリ初期化 - [AssemblyInitialize] (テストアセンブリごと 1 回)
2. クラス初期化 - [ClassInitialize] (テストクラスごと 1 回)
3. テスト初期化 (すべてのテストメソッド):
   1. コンストラクタ
   2. TestContext プロパティを設定
   3. [TestInitialize]
4. テスト実行 - テストメソッドが実行される
5. テストクリーンアップ (すべてのテストメソッド):
   1. [TestCleanup]
   2. DisposeAsync (実装されている場合)
   3. Dispose (実装されている場合)
6. クラスクリーンアップ - [ClassCleanup] (テストクラスごと 1 回)
7. アセンブリクリーンアップ - [AssemblyCleanup] (テストアセンブリごと 1 回)

モダンなアサーション API

MSTest は 3 つのアサーションクラスを提供します: Assert、StringAssert、CollectionAssert。

Assert クラス - コアアサーション

// 等価性
Assert.AreEqual(expected, actual);
Assert.AreNotEqual(notExpected, actual);
Assert.AreSame(expectedObject, actualObject);      // 参照等価性
Assert.AreNotSame(notExpectedObject, actualObject);

// null チェック
Assert.IsNull(value);
Assert.IsNotNull(value);

// ブール値
Assert.IsTrue(condition);
Assert.IsFalse(condition);

// 失敗/不確定
Assert.Fail("Test failed due to...");
Assert.Inconclusive("Test cannot be completed because...");

例外テスト ([ExpectedException] より推奨)

// Assert.Throws - TException またはその派生型にマッチ
var ex = Assert.Throws<ArgumentException>(() => Method(null));
Assert.AreEqual("Value cannot be null.", ex.Message);

// Assert.ThrowsExactly - 厳密に型にマッチ
var ex = Assert.ThrowsExactly<InvalidOperationException>(() => Method());

// 非同期版
var ex = await Assert.ThrowsAsync<HttpRequestException>(async () => await client.GetAsync(url));
var ex = await Assert.ThrowsExactlyAsync<InvalidOperationException>(async () => await Method());

コレクションアサーション (Assert クラス)

Assert.Contains(expectedItem, collection);
Assert.DoesNotContain(unexpectedItem, collection);
Assert.ContainsSingle(collection);  // 厳密に 1 要素
Assert.HasCount(5, collection);
Assert.IsEmpty(collection);
Assert.IsNotEmpty(collection);

文字列アサーション (Assert クラス)

Assert.Contains("expected", actualString);
Assert.StartsWith("prefix", actualString);
Assert.EndsWith("suffix", actualString);
Assert.DoesNotStartWith("prefix", actualString);
Assert.DoesNotEndWith("suffix", actualString);
Assert.MatchesRegex(@"\d{3}-\d{4}", phoneNumber);
Assert.DoesNotMatchRegex(@"\d+", textOnly);

比較アサーション

Assert.IsGreaterThan(lowerBound, actual);
Assert.IsGreaterThanOrEqualTo(lowerBound, actual);
Assert.IsLessThan(upperBound, actual);
Assert.IsLessThanOrEqualTo(upperBound, actual);
Assert.IsInRange(actual, low, high);
Assert.IsPositive(number);
Assert.IsNegative(number);

型アサーション

// MSTest 3.x - out パラメータを使用
Assert.IsInstanceOfType<MyClass>(obj, out var typed);
typed.DoSomething();

// MSTest 4.x - 型付き結果を直接返す
var typed = Assert.IsInstanceOfType<MyClass>(obj);
typed.DoSomething();

Assert.IsNotInstanceOfType<WrongType>(obj);

Assert.That (MSTest 4.0+)

Assert.That(result.Count > 0);  // 失敗メッセージの式を自動キャプチャ

StringAssert クラス

注記: 利用可能な場合は Assert クラスの同等メソッドを推奨します (例: StringAssert.Contains(actual, "expected") より Assert.Contains("expected", actual))。

StringAssert.Contains(actualString, "expected");
StringAssert.StartsWith(actualString, "prefix");
StringAssert.EndsWith(actualString, "suffix");
StringAssert.Matches(actualString, new Regex(@"\d{3}-\d{4}"));
StringAssert.DoesNotMatch(actualString, new Regex(@"\d+"));

CollectionAssert クラス

注記: 利用可能な場合は Assert クラスの同等メソッドを推奨します (例: Assert.Contains)。

// 包含
CollectionAssert.Contains(collection, expectedItem);
CollectionAssert.DoesNotContain(collection, unexpectedItem);

// 等価性 (同じ要素、同じ順序)
CollectionAssert.AreEqual(expectedCollection, actualCollection);
CollectionAssert.AreNotEqual(unexpectedCollection, actualCollection);

// 同等性 (同じ要素、任意の順序)
CollectionAssert.AreEquivalent(expectedCollection, actualCollection);
CollectionAssert.AreNotEquivalent(unexpectedCollection, actualCollection);

// サブセットチェック
CollectionAssert.IsSubsetOf(subset, superset);
CollectionAssert.IsNotSubsetOf(notSubset, collection);

// 要素の検証
CollectionAssert.AllItemsAreInstancesOfType(collection, typeof(MyClass));
CollectionAssert.AllItemsAreNotNull(collection);
CollectionAssert.AllItemsAreUnique(collection);

データ駆動テスト

DataRow

[TestMethod]
[DataRow(1, 2, 3)]
[DataRow(0, 0, 0, DisplayName = "Zeros")]
[DataRow(-1, 1, 0, IgnoreMessage = "Known issue #123")]  // MSTest 3.8+
public void Add_ReturnsSum(int a, int b, int expected)
{
    Assert.AreEqual(expected, Calculator.Add(a, b));
}

DynamicData

データソースは以下のいずれかの型を返します:

• IEnumerable<(T1, T2, ...)> (ValueTuple) - 推奨、型安全性を提供 (MSTest 3.7+)
• IEnumerable<Tuple<T1, T2, ...>> - 型安全性を提供
• IEnumerable<TestDataRow> - 型安全性とテストメタデータ制御 (表示名、カテゴリ) を提供
• IEnumerable<object[]> - 最も推奨されない、型安全性なし

注記: 新しいテストデータメソッドを作成する場合は、IEnumerable<object[]> よりも ValueTuple または TestDataRow を推奨します。object[] アプローチはコンパイル時の型チェックなし、型ミスマッチからのランタイムエラーが生じる可能性があります。

[TestMethod]
[DynamicData(nameof(TestData))]
public void DynamicTest(int a, int b, int expected)
{
    Assert.AreEqual(expected, Calculator.Add(a, b));
}

// ValueTuple - 推奨 (MSTest 3.7+)
public static IEnumerable<(int a, int b, int expected)> TestData =>
[
    (1, 2, 3),
    (0, 0, 0),
];

// TestDataRow - カスタム表示名やメタデータが必要な場合
public static IEnumerable<TestDataRow<(int a, int b, int expected)>> TestDataWithMetadata =>
[
    new((1, 2, 3)) { DisplayName = "Positive numbers" },
    new((0, 0, 0)) { DisplayName = "Zeros" },
    new((-1, 1, 0)) { DisplayName = "Mixed signs", IgnoreMessage = "Known issue #123" },
];

// IEnumerable<object[]> - 新しいコード向けに非推奨 (型安全性なし)
public static IEnumerable<object[]> LegacyTestData =>
[
    [1, 2, 3],
    [0, 0, 0],
];

TestContext

TestContext クラスはテスト実行情報、キャンセレーション対応、出力メソッドを提供します。 完全なリファレンスは TestContext ドキュメント をご覧ください。

TestContext へのアクセス

// プロパティ (MSTest は CS8618 を抑制 - nullable または = null を使用しないこと!)
public TestContext TestContext { get; set; }

// コンストラクタインジェクション (MSTest 3.6+) - 不変性のために推奨
[TestClass]
public sealed class MyTests
{
    private readonly TestContext _testContext;

    public MyTests(TestContext testContext)
    {
        _testContext = testContext;
    }
}

// スタティックメソッドはパラメータとして受け取る
[ClassInitialize]
public static void ClassInit(TestContext context) { }

// クリーンアップメソッド向けにオプション (MSTest 3.6+)
[ClassCleanup]
public static void ClassCleanup(TestContext context) { }

[AssemblyCleanup]
public static void AssemblyCleanup(TestContext context) { }

キャンセレーショントークン

[Timeout] との協調キャンセレーションのため常に TestContext.CancellationToken を使用します:

[TestMethod]
[Timeout(5000)]
public async Task LongRunningTest()
{
    await _httpClient.GetAsync(url, TestContext.CancellationToken);
}

テスト実行プロパティ

TestContext.TestName              // 現在のテストメソッド名
TestContext.TestDisplayName       // 表示名 (3.7+)
TestContext.CurrentTestOutcome    // Pass/Fail/InProgress
TestContext.TestData              // パラメータ化テストデータ (3.7+, TestInitialize/Cleanup で)
TestContext.TestException         // テストが失敗した場合の例外 (3.7+, TestCleanup で)
TestContext.DeploymentDirectory   // デプロイメント項目を含むディレクトリ

出力と結果ファイル

// テスト出力に書き込み (デバッグに便利)
TestContext.WriteLine("Processing item {0}", itemId);

// テスト結果にファイルを添付 (ログ、スクリーンショット)
TestContext.AddResultFile(screenshotPath);

// テストメソッド間でデータを保存/取得
TestContext.Properties["SharedKey"] = computedValue;

アドバンスド機能

不安定なテストのリトライ (MSTest 3.9+)

[TestMethod]
[Retry(3)]
public void FlakyTest() { }

条件付き実行 (MSTest 3.10+)

OS または CI 環境に基づいてテストをスキップまたは実行:

// OS 固有テスト
[TestMethod]
[OSCondition(OperatingSystems.Windows)]
public void WindowsOnlyTest() { }

[TestMethod]
[OSCondition(OperatingSystems.Linux | OperatingSystems.MacOS)]
public void UnixOnlyTest() { }

[TestMethod]
[OSCondition(ConditionMode.Exclude, OperatingSystems.Windows)]
public void SkipOnWindowsTest() { }

// CI 環境テスト
[TestMethod]
[CICondition]  // CI でのみ実行 (デフォルト: ConditionMode.Include)
public void CIOnlyTest() { }

[TestMethod]
[CICondition(ConditionMode.Exclude)]  // CI では スキップ、ローカルで実行
public void LocalOnlyTest() { }

並列化

// アセンブリレベル
[assembly: Parallelize(Workers = 4, Scope = ExecutionScope.MethodLevel)]

// 特定のクラスに対して無効化
[TestClass]
[DoNotParallelize]
public sealed class SequentialTests { }

作業項目の追跡 (MSTest 3.8+)

テストレポートの追跡可能性のため、テストを作業項目にリンク:

// Azure DevOps 作業項目
[TestMethod]
[WorkItem(12345)]  // 作業項目 #12345 にリンク
public void Feature_Scenario_ExpectedBehavior() { }

// 複数の作業項目
[TestMethod]
[WorkItem(12345)]
[WorkItem(67890)]
public void Feature_CoversMultipleRequirements() { }

// GitHub issues (MSTest 3.8+)
[TestMethod]
[GitHubWorkItem("https://github.com/owner/repo/issues/42")]
public void BugFix_Issue42_IsResolved() { }

作業項目の関連付けはテスト結果に表示され、以下に使用できます:

• 要件へのテストカバレッジの追跡
• リグレッション テストへのバグフィックスのリンク
• CI/CD パイプラインの追跡可能性レポート生成

避けるべき一般的な誤り

// ❌ 引数の順序が間違い
Assert.AreEqual(actual, expected);
// ✅ 正解
Assert.AreEqual(expected, actual);

// ❌ ExpectedException を使用 (廃止)
[ExpectedException(typeof(ArgumentException))]
// ✅ Assert.Throws を使用
Assert.Throws<ArgumentException>(() => Method());

// ❌ LINQ Single() を使用 - 例外が不明確
var item = items.Single();
// ✅ ContainsSingle を使用 - より良い失敗メッセージ
var item = Assert.ContainsSingle(items);

// ❌ 強制キャスト - 例外が不明確
var handler = (MyHandler)result;
// ✅ 型アサーション - 失敗時に実際の型を表示
var handler = Assert.IsInstanceOfType<MyHandler>(result);

// ❌ キャンセレーショントークンを無視
await client.GetAsync(url, CancellationToken.None);
// ✅ テストキャンセレーションをフロー
await client.GetAsync(url, TestContext.CancellationToken);

// ❌ TestContext を nullable にする - 不要な null チェックにつながる
public TestContext? TestContext { get; set; }
// ❌ null! を使用 - MSTest はすでにこのプロパティの CS8618 を抑制
public TestContext TestContext { get; set; } = null!;
// ✅ nullable または初期化子なしで宣言 - MSTest が警告を処理
public TestContext TestContext { get; set; }

テスト整理

• 機能またはコンポーネントでテストをグループ化
• フィルタリングのため [TestCategory("Category")] を使用
• カスタムメタデータのため [TestProperty("Name", "Value")] を使用 (例: [TestProperty("Bug", "12345")])
• クリティカルテストのため [Priority(1)] を使用
• 関連する MSTest アナライザーを有効化 (コンストラクタ推奨のための MSTEST0020)

モッキングと分離

• 依存関係のモッキングに Moq または NSubstitute を使用
• モッキングを容易にするためインターフェースを使用
• テスト対象ユニットを分離するため依存関係をモック