NUnit と .NET Core による単体テスト C#

  • [アーティクル]

このチュートリアルでは、単体テストの概念について学習するためにサンプル ソリューションを段階的に構築する対話型のエクスペリエンスを示します。 構築済みのソリューションを使用してチュートリアルに従う場合は、開始する前にサンプル コードを参照またはダウンロードしてください。 ダウンロード方法については、「サンプルおよびチュートリアル」を参照してください。

この記事では、.NET Core プロジェクトのテストについて説明します。 ASP.NET Core プロジェクトをテストしている場合は、「ASP.NET Core の統合テスト」を参照してください。

必須コンポーネント

  • .NET Core 2.1 SDK 以降のバージョン。
  • ユーザーが選んだテキスト エディターまたはコード エディター。

ソース プロジェクトの作成

シェル ウィンドウを開きます。 ソリューションを保存するための unit-testing-using-nunit というディレクトリを作成します。 この新しいディレクトリ内で、次のコマンドを実行して、クラス ライブラリとテスト プロジェクト用の新しいソリューション ファイルを作成します。

dotnet new sln

次に、PrimeService ディレクトリを作成します。 これまでのところ、ディレクトリとファイルの構造は次のアウトラインのようになっています。

/unit-testing-using-nunit
    unit-testing-using-nunit.sln
    /PrimeService

PrimeService を現在のディレクトリとし、次のコマンドを実行してソース プロジェクトを作成します。

dotnet new classlib

Class1.cs の名前を PrimeService.cs に変更します。 PrimeService クラスのエラーが発生する実装を作成します。

using System;

namespace Prime.Services
{
    public class PrimeService
    {
        public bool IsPrime(int candidate)
        {
            throw new NotImplementedException("Please create a test first.");
        }
    }
}

unit-testing-using-nunit ディレクトリに戻ります。 次のコマンドを実行して、クラス ライブラリ プロジェクトをソリューションに追加します。

dotnet sln add PrimeService/PrimeService.csproj

テスト プロジェクトの作成

次に、PrimeService.Tests ディレクトリを作成します。 次の一覧はディレクトリ構造を示したものです。

/unit-testing-using-nunit
    unit-testing-using-nunit.sln
    /PrimeService
        Source Files
        PrimeService.csproj
    /PrimeService.Tests

PrimeService.Tests ディレクトリを現在のディレクトリとし、次のコマンドを使用して新しいプロジェクトを作成します。

dotnet new nunit

dotnet new コマンドによって、テスト ライブラリとして NUnit を使用するテスト プロジェクトが作成されます。 生成されたテンプレートによって、PrimeService.Tests.csproj ファイル内にテスト ランナーが構成されます。

<ItemGroup>
  <PackageReference Include="nunit" Version="3.14.0" />
  <PackageReference Include="NUnit3TestAdapter" Version="4.5.0" />
  <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
</ItemGroup>

テスト プロジェクトには、単体テストを作成して実行するための、他のパッケージが必要です。 前の手順の dotnet new コマンドでは Microsoft テスト SDK、NUnit テスト フレームワーク、NUnit テスト アダプターを追加しました。 ここで、プロジェクトに別の依存関係として PrimeService クラス ライブラリを追加します。 dotnet add reference コマンドを使用する。

dotnet add reference ../PrimeService/PrimeService.csproj

全体のファイルは GitHub のサンプル リポジトリで確認できます。

ソリューションの最終的なレイアウトは次のアウトラインのようになります。

/unit-testing-using-nunit
    unit-testing-using-nunit.sln
    /PrimeService
        Source Files
        PrimeService.csproj
    /PrimeService.Tests
        Test Source Files
        PrimeService.Tests.csproj

unit-testing-vb-nunit ディレクトリ内で次のコマンドを実行します。

dotnet sln add ./PrimeService.Tests/PrimeService.Tests.csproj

最初のテストの作成

失敗するテストを 1 つ作成してそれを合格させる、というプロセスを繰り返します。 PrimeService.Testsディレクトリ内で、UnitTest1.csファイルの名前を PrimeService_IsPrimeShould.cs に変更し、その内容全体を次のコードに置き換えます。

using NUnit.Framework;
using Prime.Services;

namespace Prime.UnitTests.Services
{
    [TestFixture]
    public class PrimeService_IsPrimeShould
    {
        private PrimeService _primeService;

        [SetUp]
        public void SetUp()
        {
            _primeService = new PrimeService();
        }

        [Test]
        public void IsPrime_InputIs1_ReturnFalse()
        {
            var result = _primeService.IsPrime(1);

            Assert.IsFalse(result, "1 should not be prime");
        }
    }
}

[TestFixture] 属性は、単体テストを含むクラスを表します。 [Test] 属性は、メソッドがテスト メソッドであることを表します。

このファイルを保存し、dotnet test コマンドを実行してテストとクラス ライブラリをビルドしてから、テストを実行します。 NUnit テスト ランナーには、テストを実行するためのプログラムのエントリ ポイントが含まれています。 dotnet test を実行すると、作成した単体テスト プロジェクトを使用してテスト ランナーが開始されます。

テストが失敗します。 実装はまだ作成していません。 最もシンプルな動作のコードを PrimeService クラスに記述し、テストが成功するようにします。

public bool IsPrime(int candidate)
{
    if (candidate == 1)
    {
        return false;
    }
    throw new NotImplementedException("Please create a test first.");
}

unit-testing-using-nunit ディレクトリで、もう一度 dotnet test を実行します。 dotnet test コマンドは PrimeService プロジェクトのビルドを実行してから、PrimeService.Tests プロジェクトのビルドを実行します。 両方のプロジェクトをビルドすると、この単一テストが実行されます。 成功します。

他の機能の追加

テストが成功したので、他のテストも記述してみましょう。 素数に関する、いくつかの単純なケースが他にもあります (0、-1)。 [Test] 属性を使用すると新しいテストを追加できますが、すぐに煩雑になります。 一連の類似のテストを記述できるようになる、他の NUnit 属性があります。 [TestCase] 属性は同じコードを実行するものの、異なる入力引数が含まれる一連のテストを作成するために使用します。 [TestCase] 属性を使用して、そのような入力の値を指定することができます。

新しいテストを作成するのではなく、この属性を適用することで 1 つのデータ駆動テストを作成します。 そのデータ駆動テストとは、複数の 2 未満の値を調べて、最も小さい素数を特定するという手法です。

[TestCase(-1)]
[TestCase(0)]
[TestCase(1)]
public void IsPrime_ValuesLessThan2_ReturnFalse(int value)
{
    var result = _primeService?.IsPrime(value);

    Assert.IsFalse(result, $"{value} should not be prime");
}

dotnet test を実行して、これらの 2 つのテストが失敗したとします。 すべてのテストを成功させるために、PrimeService.cs ファイルで Main メソッドの先頭にある if 句を変更します。

if (candidate < 2)

他のテスト、理論、コードをメイン ライブラリに追加して反復を続けます。 テストの最終版ができ、ライブラリの完全な実装が完了しました。

これで、小さなライブラリとそのライブラリの単体テストのセットが構築されました。 また、ソリューションを構築したことで、新しいパッケージとテストの追加が標準のワークフローに組み込まれました。 アプリケーションの目標を達成することに時間と労力の多くを割き、集中して取り組みました。