MSTest でテストを記述する

この記事では、テストの記述と整形に役立つ MSTest で使用される API と規則について説明します。

テスト構造

すべての MSTest テスト クラスには TestClass 属性が必要であり、すべてのテスト メソッドには TestMethod 属性が必要です。

using Microsoft.VisualStudio.TestTools.UnitTesting;

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

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

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

TestClassAttribute

TestClassAttributeは、テストを含むクラスをマークし、必要に応じて、メソッドを初期化またはクリーンアップします。 この属性を拡張して、テスト クラスの動作をカスタマイズできます。

TestMethodAttribute

TestMethodAttributeは、実行するテストとしてメソッドをマークします。 テスト メソッドは次のようにする必要があります。

• インスタンス メソッド (静的ではない)
• Public
• void、Task、またはValueTaskを返します (MSTest v3.3 以降)
• データ ドリブン属性を使用しない限り、パラメーターなし

[TestClass]
public class TestMethodExamples
{
    [TestMethod]
    public void SynchronousTest()
    {
        Assert.IsTrue(true);
    }

    [TestMethod]
    public async Task AsynchronousTest()
    {
        await Task.Delay(100);
        Assert.IsTrue(true);
    }
}

DiscoverInternalsAttribute

DiscoverInternalsAttribute アセンブリ属性を使用すると、MSTest はinternalのテスト クラスとメソッドを検出できます。 既定では、 public テストのみが検出されます。 この属性は、内部型をパラメーターとして使用するパラメーター化されたテストがある場合に特に便利です。

[assembly: DiscoverInternals]

internal record TestInput(int Value, string Description);

[TestClass]
public class CalculatorTests
{
    internal static IEnumerable<TestInput> TestData
    {
        get
        {
            yield return new TestInput(1, "one");
            yield return new TestInput(2, "two");
        }
    }

    [TestMethod]
    [DynamicData(nameof(TestData))]
    internal void Add_WithTestInput_ReturnsExpected(TestInput input)
    {
        var calculator = new Calculator();
        int result = calculator.Add(input.Value, 1);
        Assert.AreEqual(input.Value + 1, result);
    }
}

DiscoverInternalsしないと、テスト メソッドとその内部TestInputパラメーター型は、テスト ランナーによって検出されません。

主要な概念

MSTest のドキュメントはトピック別に整理されています。

属性クイック リファレンス

アサーション

Microsoft.VisualStudio.TestTools.UnitTesting 名前空間の Assert クラスは、特定の機能を確認するために使用します。 テスト メソッドはアプリケーションでコードを実行しますが、Assert ステートメントを含める場合にのみ正確性を報告します。

MSTest アサーションは、次の内容に分かれています。

• Assert クラス: 汎用アサーション (AreEqual、 IsTrue、 ThrowsException)
• StringAssert クラス: 文字列固有のアサーション (Contains、 Matches、 StartsWith)
• CollectionAssert クラス: コレクション アサーション (Contains、 AllItemsAreUnique、 AreEquivalent)

プライベート メンバーのテスト

リフレクション ラッパー クラスを使用してプライベート メンバーをテストできます。

• PrivateObject: プライベート インスタンス メソッドの場合
• PrivateType: プライベート静的メソッドの場合

こちらも参照ください

• MSTest の概要
• MSTest アナライザー
• ベスト プラクティスの単体テスト
• 選択的単体テストを実行する