.NET Core と .NET Standard での単体テストのベストプラクティス

[アーティクル]
06/01/2023

単体テストの記述には多大な利点があります。回帰の防止に役立ち、ドキュメントを提供して、優れた設計を容易に行うことができます。ただし、読みにくくて不安定な単体テストは、コードベースに打撃を与える可能性があります。この記事では、.NET Core プロジェクトと .NET Standard プロジェクトの単体テストの設計に関するベストプラクティスについて説明します。

このガイドでは、テストの回復性とわかりやすさを維持するよう単体テストを記述する際のいくつかのベストプラクティスについて説明します。

著者: John Reese、協力者: Roy Osherove

単体テストを記述する理由

単体テストを使用する理由はいくつかあります。

機能テストの実行時間を短縮

機能テストはコストがかかります。通常、これらのテストでは、アプリケーションを開き、想定される動作を検証するためにお客様 (または他のだれか) が従う必要のある一連の手順を実行します。テスト担当者は、これらの手順を必ずしも把握しているとは限りません。テストを実行するために、その領域に精通している他者に支援を求めることが必要になります。テスト自体は、小さな変更の場合は数秒かかり、大きな変更の場合は数分かかる可能性があります。最後に、システムで変更を行うたびにこのプロセスを繰り返す必要があります。

一方、単体テストは数ミリ秒しかかからず、ボタンを押すだけで実行でき、概してシステムの知識は必ずしも必要ありません。テストに合格するか失敗するかは、個人ではなくテストランナーの責任となります。

回帰の防止

回帰問題は、アプリケーションに変更が行われると発生する欠陥です。一般的にテスト担当者は、新しい機能をテストするだけでなく、以前に実装されていた機能が今も想定どおりに機能していることを確認するために、事前に存在していた機能もテストします。

単体テストでは、ビルドを行うたびに、さらにはコード行を変更するたびに、テストのスイート全体を再実行できます。これにより、新しいコードが既存の機能を損なわないことを確信できます。

実行可能なドキュメント

特定のメソッドが何を実行するか、またはそのメソッドがどのように動作するかは、特定の入力を見ても必ずしも明らかではありません。空の文字列や Null を渡した場合にこのメソッドがどのように動作するか、自分自身わからないことがあります。

適切な名前の単体テストのスイートがある場合、各テストは、特定の入力に対して想定される出力を明確に説明できる必要があります。さらに、実際に動作することを確認できる必要があります。

疎結合コード

コードが密結合されている場合、単体テストは難しくなる可能性があります。記述しているコードに対して単体テストを作成しないと、結合を明確に認識できません。

したがって、コードに対するテストを記述する際には、必然的にコードを分離します。そうしないと、テストが困難になるからです。

適切な単体テストの特性

高速: 完成度の高いプロジェクトに数千もの単体テストが含まれることは、珍しくありません。単体テストの実行にかかる時間はわずかで、数ミリ秒です。
独立性: 単体テストはスタンドアロンであり、独立して実行でき、ファイルシステムやデータベースなどの外部要因に対する依存関係がありません。
反復可能: 単体テストの実行では、その結果に一貫性がある必要があります。つまり、実行と実行の間で何も変更しない場合、常に同じ結果を返す必要があります。
自己チェック: テストは人の介入なしに、合格したか失敗したかを自動的に検出できる必要があります。
タイムリー: 単体テストは、テスト対象のコードの記述と比較して時間がかかりすぎないようにする必要があります。コードの記述と比較してコードのテストに時間がかかりすぎる場合は、よりテストしやすい設計を検討してください。

コードカバレッジ

コードカバレッジのパーセンテージの高さは多くの場合、コードの品質の高さに関連します。ただし、測定自体でコードの品質を判断することは "できません"。コードカバレッジのパーセンテージ目標を過度に大きく設定すると、逆効果になることがあります。条件分岐が大量にある複雑なプロジェクトを想像してください。また、コードカバレッジ目標を 95% に設定することを想像してください。現在、このプロジェクトは 90% のコードカバレッジを維持しています。残り 5% の極端な状況をすべて考慮するために膨大な時間が必要になる可能性があり、提案された価値がすぐに減少します。

コードカバレッジのパーセンテージの高さは成功を示すものではありません。コードの品質の高さを暗に示すものでもありません。単体テストの対象となるコードの量を表すだけです。詳細については、単体テストのコードカバレッジに関するページを参照してください。

用語を統一する

テストに関して、"モック" という用語は残念ながら誤用されることがしばしばあります。単体テストの記述時における最も一般的な種類の "フェイク" を定義するポイントを以下に挙げます。

"フェイク" - フェイクは、スタブまたはモックオブジェクトのいずれかを示すのに使用できる汎用的な用語です。スタブとモックのどちらであるかは、使用されているコンテキストによって決まります。つまり、フェイクはスタブとモックのどちらにもなりえます。

モック - モックオブジェクトは、単体テストに合格したか失敗したかを判断する、システム内のフェイクオブジェクトです。モックは、アサートされるまでフェイクとして開始します。

スタブ - スタブは、システム内の既存の依存関係 (コラボレーター) の制御可能な置換です。スタブを使用すると、依存関係を直接処理することなく、コードをテストできます。既定では、スタブはフェイクとして開始します。

次のコードスニペットを考えてみます。

var mockOrder = new MockOrder();
var purchase = new Purchase(mockOrder);

purchase.ValidateOrders();

Assert.True(purchase.CanBeShipped);

上記の例は、モックと呼ばれるスタブを表しています。ここでは、実際にはスタブです。 Purchase (テスト対象のシステム) をインスタンス化する手段として、Order を渡しているだけです。 Order はモックではないので、名前 MockOrder も紛らわしいものです。

より適切なアプローチを以下に示します。

var stubOrder = new FakeOrder();
var purchase = new Purchase(stubOrder);

purchase.ValidateOrders();

Assert.True(purchase.CanBeShipped);

クラスの名前を FakeOrder に変更して、クラスをより汎用的にしました。このクラスをモックまたはスタブ (どちらかテストケースに適している方) として使用できます。上記の例では、FakeOrder はスタブとして使用されています。アサート時には、どのような形状または形式でも FakeOrder を使用していません。 FakeOrder は、コンストラクターの要件を満たすためだけに Purchase クラスに渡されました。

これをモックとして使用するには、たとえば次のコードのようにします。

var mockOrder = new FakeOrder();
var purchase = new Purchase(mockOrder);

purchase.ValidateOrders();

Assert.True(mockOrder.Validated);

この場合は、フェイクのプロパティをチェック (フェイクに対してアサート) しているので、上記のコードスニペット内で mockOrder はモックです。

重要

この用語を正確に理解することが重要です。スタブを "モック" と呼んだ場合、他の開発者はあなたの意図を誤って解釈してしまいます。

モックとスタブに関する重要な留意点として、モックとスタブはよく似ていますが、モックオブジェクトに対してはアサートを行うのに対し、スタブに対してはアサートを行いません。

ベストプラクティス

単体テストを記述するための最も重要なベストプラクティスをいくつか次に示します。

インフラストラクチャの依存関係を回避する

単体テストを記述するときは、インフラストラクチャに対する依存関係を設けようとしないでください。この依存関係によってテストが低速で不安定になるため、これは統合テストで行います。アプリケーションでこれらの依存関係を回避するには、明示的な依存関係の原則に従い、依存関係の挿入を使用します。個別のプロジェクトの単体テストを統合テストと区別することもできます。このアプローチを使用すると、単体テストプロジェクトとインフラストラクチャパッケージの間に参照や依存関係がなくなります。

テストの名前付け

テストの名前は、次の 3 つの部分で構成される必要があります。

テスト対象のメソッドの名前。
それがテストされるシナリオ。
シナリオが呼び出されたときに想定される動作。

なぜでしょうか。

名前付け規則は、テストの目的を明示的に表すので重要です。テストは、コードが機能することを確認するだけでなく、ドキュメントも提供します。単体テストのスイートを見るだけで、コード自体を見なくても、コードの動作を推測できます。さらに、テストが失敗した際には、どのシナリオが想定を満たしていないかを正確に判断できます。

不適切な例:

[Fact]
public void Test_Single()
{
    var stringCalculator = new StringCalculator();

    var actual = stringCalculator.Add("0");

    Assert.Equal(0, actual);
}

より適切な例:

[Fact]
public void Add_SingleNumber_ReturnsSameNumber()
{
    var stringCalculator = new StringCalculator();

    var actual = stringCalculator.Add("0");

    Assert.Equal(0, actual);
}

テストの配置

Arrange、Act、Assert は、単体テスト時に共通するパターンです。名前が示すように、これは次の 3 つの主なアクションで構成されます。

オブジェクトを "配置 (Arrange)" し、必要に応じて作成および設定します。
オブジェクトを操作 (Act) します。
何かが想定どおりであることをアサート (Assert) します。

なぜでしょうか。

配置とアサートの手順で、テストする対象を明確に区別します。
"Act" コードにより、アサーションが混合される可能性が低くなります。

読みやすさは、テストの作成時において最も重要な側面の 1 つです。テスト内でこれらの各アクションを分離することで、コードの呼び出しに必要な依存関係とコードを呼び出す方法、また何をアサートしようとしているかが明確に区別されます。いくつかの手順を結合し、テストのサイズを小さくすることは可能ですが、主な目的はテストをできるだけ読みやすくすることにあります。

不適切な例:

[Fact]
public void Add_EmptyString_ReturnsZero()
{
    // Arrange
    var stringCalculator = new StringCalculator();

    // Assert
    Assert.Equal(0, stringCalculator.Add(""));
}

より適切な例:

[Fact]
public void Add_EmptyString_ReturnsZero()
{
    // Arrange
    var stringCalculator = new StringCalculator();

    // Act
    var actual = stringCalculator.Add("");

    // Assert
    Assert.Equal(0, actual);
}

最小限の情報で合格するテストを記述する

単体テストで使用する入力は、現在テストしている動作を検証するために、できる限り単純である必要があります。

なぜでしょうか。

コードベースでの今後の変更に対して、テストの回復力が高くなります。
実装よりもテストの動作に的が絞られます。

テストに合格するために必要以上の情報を含むテストは、テストでエラーが発生する可能性が高く、テストの目的が不明確になる可能性があります。テストの記述時には、動作に的を絞る必要があります。モデルに追加のプロパティを設定したり、不要な場合に 0 以外の値を使用すると、証明しようとしている内容が不明瞭になるだけです。

不適切な例:

[Fact]
public void Add_SingleNumber_ReturnsSameNumber()
{
    var stringCalculator = new StringCalculator();

    var actual = stringCalculator.Add("42");

    Assert.Equal(42, actual);
}

より適切な例:

[Fact]
public void Add_SingleNumber_ReturnsSameNumber()
{
    var stringCalculator = new StringCalculator();

    var actual = stringCalculator.Add("0");

    Assert.Equal(0, actual);
}

マジック文字列を回避する

単体テストにおける変数の名前付けは、運用コードにおける変数の名前付けより重要というわけではないとしても、重要であることは確かです。単体テストにマジック文字列を含めることはできません。

なぜでしょうか。

特殊な値となっている原因を特定するために、テストを読む人が運用コードを調べる必要がなくなります。
実現しようとしている内容ではなく証明しようとしている内容が明示的に示されます。

マジック文字列は、テストを読む人に混乱をきたす可能性があります。文字列が通常からかけ離れて見えれば、パラメーターや戻り値としてその特定の値がなぜ選択されたかが気になります。このような種類の文字列値のせいで、テストに集中するのではなく、実装の詳細を調べようとします。

ヒント

テストの記述時には、その意図をできる限り表現することを目指す必要があります。マジック文字列の場合の適切なアプローチとしては、これらの値を定数に割り当てます。

不適切な例:

[Fact]
public void Add_BigNumber_ThrowsException()
{
    var stringCalculator = new StringCalculator();

    Action actual = () => stringCalculator.Add("1001");

    Assert.Throws<OverflowException>(actual);
}

より適切な例:

[Fact]
void Add_MaximumSumResult_ThrowsOverflowException()
{
    var stringCalculator = new StringCalculator();
    const string MAXIMUM_RESULT = "1001";

    Action actual = () => stringCalculator.Add(MAXIMUM_RESULT);

    Assert.Throws<OverflowException>(actual);
}

テストで論理を回避する

単体テストの記述時には、手動による文字列の連結と、if、while、for、switch などの論理条件やその他の条件を回避します。

なぜでしょうか。

テスト内にバグが発生する可能性が低くなります。
実装の詳細ではなく、最終的な結果に的が絞られます。

テストスイートに論理を導入すると、バグが発生する可能性が著しく高まります。テストスイート内でバグが発見されることは避けなければなりません。テストが機能するという高レベルの確信が持てる必要があります。そうでなければ、テストを信頼することはできません。信頼できないテストでは、価値は提供されません。テストが失敗した場合は、コードに問題があり、無視できないことを実感できる必要があります。

ヒント

テスト内の論理を避けられない場合は、テストを 2 つ以上の別々のテストに分割することを検討してください。

不適切な例:

[Fact]
public void Add_MultipleNumbers_ReturnsCorrectResults()
{
    var stringCalculator = new StringCalculator();
    var expected = 0;
    var testCases = new[]
    {
        "0,0,0",
        "0,1,2",
        "1,2,3"
    };

    foreach (var test in testCases)
    {
        Assert.Equal(expected, stringCalculator.Add(test));
        expected += 3;
    }
}

より適切な例:

[Theory]
[InlineData("0,0,0", 0)]
[InlineData("0,1,2", 3)]
[InlineData("1,2,3", 6)]
public void Add_MultipleNumbers_ReturnsSumOfNumbers(string input, int expected)
{
    var stringCalculator = new StringCalculator();

    var actual = stringCalculator.Add(input);

    Assert.Equal(expected, actual);
}

設定と破棄よりもヘルパーメソッドを優先する

テストに同様のオブジェクトまたは状態が必要な場合は、Setup 属性と Teardown 属性を使用する (存在する場合) よりも、ヘルパーメソッドを優先します。

なぜでしょうか。

各テスト内からコード全体を見ることができるので、テストを読むときに混乱が少なくなります。
特定のテストに対する設定が多すぎたり少なすぎたりする可能性が低くなります。
テスト間で状態を共有して、テスト間に不要な依存関係が生じる可能性が低くなります。

単体テストフレームワークでは、テストスイート内のすべての各単体テスト前に Setup が呼び出されます。これは便利なツールとして見なされる場合もありますが、通常はテストが膨張して読みづらくなってしまいます。各テストには、テストが稼働するためにさまざまな要件があります。しかし、Setup は各テストに対してまったく同じ要件を使用することを強制します。

注意

xUnit では、バージョン 2.x の時点で SetUp と TearDown の両方が削除されています。

不適切な例:

private readonly StringCalculator stringCalculator;
public StringCalculatorTests()
{
    stringCalculator = new StringCalculator();
}

// more tests...

[Fact]
public void Add_TwoNumbers_ReturnsSumOfNumbers()
{
    var result = stringCalculator.Add("0,1");

    Assert.Equal(1, result);
}

より適切な例:

[Fact]
public void Add_TwoNumbers_ReturnsSumOfNumbers()
{
    var stringCalculator = CreateDefaultStringCalculator();

    var actual = stringCalculator.Add("0,1");

    Assert.Equal(1, actual);
}

// more tests...

private StringCalculator CreateDefaultStringCalculator()
{
    return new StringCalculator();
}

複数の Act を回避する

テストを記述する際には、テストごとに Act を 1 つだけ含めるようにしてください。 Act を 1 つだけ使用する一般的なアプローチには、次のものがあります。

Act ごとに別々のテストを作成します。
パラメーター化されたテストを使用します。

なぜでしょうか。

テストが失敗した場合、どの Act が失敗しているのかは明らかではありません。
テストで 1 つのケースに焦点を合わせることができます。
テストが失敗した理由に関する全体像をとらえることができます。

複数の Act を個別にアサートする必要があります。また、すべてのアサートが実行されることは保証されません。ほとんどの単体テストフレームワークでは、1 つの単体テストで 1 つのアサートが失敗すると、続行中のテストは自動的に失敗と見なされます。この種のプロセスは、実際には動作している機能が失敗として示されるので、混乱を招きます。

不適切な例:

[Fact]
public void Add_EmptyEntries_ShouldBeTreatedAsZero()
{
    // Act
    var actual1 = stringCalculator.Add("");
    var actual2 = stringCalculator.Add(",");

    // Assert
    Assert.Equal(0, actual1);
    Assert.Equal(0, actual2);
}

より適切な例:

[Theory]
[InlineData("", 0)]
[InlineData(",", 0)]
public void Add_EmptyEntries_ShouldBeTreatedAsZero(string input, int expected)
{
    // Arrange
    var stringCalculator = new StringCalculator();

    // Act
    var actual = stringCalculator.Add(input);

    // Assert
    Assert.Equal(expected, actual);
}

パブリックメソッドの単体テストを行うことでプライベートメソッドを検証する

ほとんどの場合、プライベートメソッドをテストする必要はありません。プライベートメソッドは実装の詳細であり、独立して存在することありません。いずれかの時点で、実装の一部としてプライベートメソッドを呼び出す、パブリックに公開されたメソッドが存在することになります。鍵となるのは、プライベートメソッドを呼び出すパブリックメソッドの最終結果です。

次のケースがあるとします。

public string ParseLogLine(string input)
{
    var sanitizedInput = TrimInput(input);
    return sanitizedInput;
}

private string TrimInput(string input)
{
    return input.Trim();
}

メソッドが想定どおりに動作していることを確認する必要があるので、まずは、TrimInput に対してテストを記述しようと考えるかもしれません。しかし、想定外の方法で ParseLogLine が sanitizedInput を操作し、TrimInput に対するテストが無効になる可能性があります。

実際のテストは、パブリックに公開された ParseLogLine メソッドに対して行う必要があります。最終的にはこのメソッドが鍵となるためです。

public void ParseLogLine_StartsAndEndsWithSpace_ReturnsTrimmedResult()
{
    var parser = new Parser();

    var result = parser.ParseLogLine(" a ");

    Assert.Equals("a", result);
}

この観点で、プライベートメソッドがある場合は、パブリックメソッドを見つけて、そのメソッドに対してテストを記述します。プライベートメソッドが想定どおりの結果を返すからといって、最終的にプライベートメソッドを呼び出すシステムが、結果を正しく使用するとは限りません。

スタブの静的参照

単体テストの原則の 1 つは、テスト対象システムに対してフルコントロールを持つ必要があることです。この原則は、運用コードに静的参照への呼び出しが含まれる場合に問題となります (例: DateTime.Now)。次のコードがあるとします。

public int GetDiscountedPrice(int price)
{
    if (DateTime.Now.DayOfWeek == DayOfWeek.Tuesday)
    {
        return price / 2;
    }
    else
    {
        return price;
    }
}

このコードに対して単体テストを行うには、どのようにすればよいでしょうでしょうか。次のようなアプローチを試してみることができます。

public void GetDiscountedPrice_NotTuesday_ReturnsFullPrice()
{
    var priceCalculator = new PriceCalculator();

    var actual = priceCalculator.GetDiscountedPrice(2);

    Assert.Equals(2, actual)
}

public void GetDiscountedPrice_OnTuesday_ReturnsHalfPrice()
{
    var priceCalculator = new PriceCalculator();

    var actual = priceCalculator.GetDiscountedPrice(2);

    Assert.Equals(1, actual);
}

ただし、このテストにはいくつかの問題があることがすぐにわかります。

テストスイートが火曜日に実行される場合、2 番目のテストには合格しますが、最初のテストには失敗します。
テストスイートが他のいずれかの曜日に実行される場合、最初のテストには合格しますが、2 番目のテストには失敗します。

こうした問題を解決するには、運用コードにシームを導入する必要があります。 1 つのアプローチとしては、インターフェイス内で制御する必要のあるコードをラップし、運用コードがそのインターフェイスに依存するようにします。

public interface IDateTimeProvider
{
    DayOfWeek DayOfWeek();
}

public int GetDiscountedPrice(int price, IDateTimeProvider dateTimeProvider)
{
    if (dateTimeProvider.DayOfWeek() == DayOfWeek.Tuesday)
    {
        return price / 2;
    }
    else
    {
        return price;
    }
}

この時点で、テストスイートは次のようになります。

public void GetDiscountedPrice_NotTuesday_ReturnsFullPrice()
{
    var priceCalculator = new PriceCalculator();
    var dateTimeProviderStub = new Mock<IDateTimeProvider>();
    dateTimeProviderStub.Setup(dtp => dtp.DayOfWeek()).Returns(DayOfWeek.Monday);

    var actual = priceCalculator.GetDiscountedPrice(2, dateTimeProviderStub);

    Assert.Equals(2, actual);
}

public void GetDiscountedPrice_OnTuesday_ReturnsHalfPrice()
{
    var priceCalculator = new PriceCalculator();
    var dateTimeProviderStub = new Mock<IDateTimeProvider>();
    dateTimeProviderStub.Setup(dtp => dtp.DayOfWeek()).Returns(DayOfWeek.Tuesday);

    var actual = priceCalculator.GetDiscountedPrice(2, dateTimeProviderStub);

    Assert.Equals(1, actual);
}

これで、テストスイートは DateTime.Now に対してフルコントロールを持ち、メソッドを呼び出すときに任意の値をスタブできるようになりました。

.NET Core と .NET Standard での単体テストのベスト プラクティス

単体テストを記述する理由

機能テストの実行時間を短縮

回帰の防止

実行可能なドキュメント

疎結合コード

適切な単体テストの特性

コード カバレッジ

用語を統一する

ベスト プラクティス

インフラストラクチャの依存関係を回避する

テストの名前付け

なぜでしょうか。

不適切な例:

より適切な例:

テストの配置

なぜでしょうか。

不適切な例:

より適切な例:

最小限の情報で合格するテストを記述する

なぜでしょうか。

不適切な例:

より適切な例:

マジック文字列を回避する

なぜでしょうか。

不適切な例:

より適切な例:

テストで論理を回避する

なぜでしょうか。

不適切な例:

より適切な例:

設定と破棄よりもヘルパー メソッドを優先する

なぜでしょうか。

不適切な例:

より適切な例:

複数の Act を回避する

なぜでしょうか。

不適切な例:

より適切な例:

パブリック メソッドの単体テストを行うことでプライベート メソッドを検証する

スタブの静的参照

フィードバック

その他のリソース

.NET Core と .NET Standard での単体テストのベストプラクティス

コードカバレッジ

ベストプラクティス

設定と破棄よりもヘルパーメソッドを優先する

パブリックメソッドの単体テストを行うことでプライベートメソッドを検証する