単体テストの概要

[アーティクル]
01/19/2024

Visual Studio を使用して、単体テストを定義および実行してコードの正常性を維持し、コードカバレッジを保証し、事前にエラーとフォールトを見つけます。単体テストを頻繁に実行し、コードが正しく動作していることを確認します。

この記事ではコードに C# と C++ を使用しており、図では C# が示されていますが、概念と機能は .NET 言語、C++、Python、JavaScript、TypeScript に適用されます。

単体テストを作成する

このセクションでは、単体テストプロジェクトの作成方法を説明します。

Visual Studio でテストするプロジェクトを開きます。

単体テストの例のデモを行うことを目的として、この記事では HelloWorld という名前のシンプルな "Hello World" C# または C++ Console プロジェクトをテストします。そのようなプロジェクトのサンプルコードは、次のとおりです。
- .NET
- C++
```
namespace HelloWorld
{
   public class Program
   {
      public static void Main()
      {
         Console.WriteLine("Hello World!");
      }
   }
}
```
```
#include <iostream>

int main()
{
   std::cout << "Hello World!\n";
}
```
ソリューションエクスプローラーで、ソリューションノードを選びます。次に、上部のメニューバーで [ファイル]>[追加]>[新しいプロジェクト] を選択します。
[新しいプロジェクト] ダイアログボックスで、使用する単体テストプロジェクトを見つけます。

検索ボックスに「テスト」と入力し、MSTest (C#) や Native Unit Test プロジェクト (C++) など、使用するテストフレームワーク用の単体テストプロジェクトテンプレートを検索して、選択します。

Visual Studio 2017 バージョン 14.8 以降、.NET 言語には NUnit と xUnit 用の組み込みのテンプレートが含まれています。 C++ の場合、この例では、Microsoft Native Unit Test Framework を使用する Native Unit Test プロジェクトを選択します。 (別の C++ テストフレームワークを使用するには、C/C++ の単体テストの記述に関するページを参照してください)。 Python の場合、使用するテストプロジェクトを設定するには、Python コードでの単体テストの設定に関するページを参照してください。

ヒント

C# の場合のみ、より高速なメソッドを使用して単体テストプロジェクトをコードから作成できます。詳細については、「単体テストプロジェクトとテストメソッドを作成する」を参照してください。 .NET Core または .NET Standard でこのメソッドを使用するには、Visual Studio 2019 以降が必要です。

次の図に、.NET でサポートされている MSTest 単体テストを示します。

[次へ] をクリックし、テストプロジェクトの名前を選択して、[作成] をクリックします。

[次へ] をクリックし、テストプロジェクトの名前を選択して、[作成] をクリックします。

プロジェクトがソリューションに追加されます。
単体テストプロジェクトで、[参照] または [依存関係] を右クリックし、[参照の追加] または [プロジェクト参照の追加] を選択して、テストするプロジェクトへの参照を追加します。
テストするコードを含むプロジェクトを選択し、[OK] をクリックします。

単体テストメソッドにコードを追加します。

たとえば、ご利用のテストフレームワーク (MSTest、NUnit、.NET でのみサポートされる xUnit、または C++ Microsoft Native Unit Test Framework) に一致する適切なドキュメントタブを選択して、次のコードを使用できます。

using Microsoft.VisualStudio.TestTools.UnitTesting;
using System.IO;
using System;

namespace HelloWorldTests
{
   [TestClass]
   public class UnitTest1
   {
      private const string Expected = "Hello World!";
      [TestMethod]
      public void TestMethod1()
      {
         using (var sw = new StringWriter())
         {
            Console.SetOut(sw);
            HelloWorld.Program.Main();

            var result = sw.ToString().Trim();
            Assert.AreEqual(Expected, result);
         }
      }
   }
}

using NUnit.Framework;
using System.IO;
using System;

namespace HelloWorldTests
{
   public class Tests
   {
      private const string Expected = "Hello World!";

      [SetUp]
      public void Setup()
      {
      }
      [Test]
      public void TestMethod1()
      {
         using (var sw = new StringWriter())
         {
            Console.SetOut(sw);
            HelloWorld.Program.Main();

            var result = sw.ToString().Trim();
            Assert.AreEqual(Expected, result);
         }
      }
   }
}

using System;
using Xunit;
using System.IO;

namespace HelloWorldTests
{
    public class UnitTest1
    {
        private const string Expected = "Hello World!";
        [Fact]
        public void Test1()
        {
            using (var sw = new StringWriter())
            {
                Console.SetOut(sw);
                HelloWorld.Program.Main();

                var result = sw.ToString().Trim();
                Assert.Equal(Expected, result);
            }
        }
    }
}

#include "pch.h"
#include "CppUnitTest.h"
#include "../HelloWorldUnitTestCPP/HelloWorldUnitTestCPP.cpp"   // Update using your project name

using namespace Microsoft::VisualStudio::CppUnitTestFramework;

namespace HelloWorldTests
{
   TEST_CLASS(HelloWorldTests)
   {
   public:

      TEST_METHOD(TestMethod)
      {
         std::string expected = "Hello World!\n";

         std::stringstream buffer;
         std::streambuf* sbuf = std::cout.rdbuf(); // Save cout's buffer
         std::cout.rdbuf(buffer.rdbuf()); // Redirect cout to the stringstream buffer

         // Call main() in your test
         int result = main();

         // When finished, redirect cout to the original buffer 
         std::cout.rdbuf(sbuf);
         std::cout << "std original buffer: \n";
         std::cout << buffer.get();

         // Test
         Assert::AreEqual(expected, buffer.str());
      }
   };
}

単体テストを実行する

テストエクスプローラーを開きます。

テストエクスプローラーを開くには、上部のメニューバーで [テスト]>[テストエクスプローラー] を選択します (または Ctrl + E、T キーを押します)。
[すべて実行] をクリックして、単体テストを実行します (または Ctrl + R、V キーを押します)。

テストが完了すると、緑色のチェックマークが、テストが成功したことを示します。赤色の "x" アイコンは、テストが失敗したことを示します。

ヒント

テストエクスプローラーを使用して、組み込みのテストフレームワーク (MSTest) またはサードパーティのテストフレームワークから、単体テストを実行できます。テストをカテゴリにまとめたり、テストの一覧にフィルターを適用したり、テストのプレイリストを実行したりできます。テストをデバッグし、テストのパフォーマンスとコードカバレッジを分析することもできます。

ライブ単体テストの結果を表示する (Visual Studio Enterprise)

Visual Studio 2017 以降で MSTest、xUnit、または NUnit テストフレームワークを使用する場合は、単体テストのライブ結果を表示できます。

Note

次の手順を行うには、Visual Studio Enterprise に加えて、.NET コードのほかに MSTest、xUnit、NUnit のうちいずれか 1 つのテストフレームワークが必要です。

[テスト]>[Live Unit Testing]>[開始] を選択して、[テスト] メニューでライブ単体テストをオンにします。
コードの作成および編集時に、コードエディターウィンドウ内でテストの結果を表示します。
そのメソッドをカバーしているテストの名前などの詳細については、テスト結果インジケーターをクリックします。

ライブ単体テストの詳細については、ライブ単体テストに関するページを参照してください。

サードパーティのテストフレームワークを使用する

ご利用のプログラミング言語に応じて、NUnit、Boost、Google C++ Testing Framework など、サードパーティのテストフレームワークを利用して、Visual Studio で単体テストを実行できます。サードパーティのフレームワークを使用するには:

NuGet パッケージマネージャーを使用して、お好きなフレームワーク用の NuGet パッケージをインストールします。
(.NET) Visual studio 2017 バージョン 14.6 以降、Visual Studio には、NUnit および xUnit テストフレームワーク用に構成済みのテストプロジェクトテンプレートが含まれています。これらのテンプレートには、サポートを有効にするために必要な NuGet パッケージも含まれています。
(C++) Visual Studio 2017 以降のバージョンには、Google C++ Testing Framework などの一部のフレームワークが既に含まれています。詳細については、「Visual Studio で C/C++ 用の単体テストを作成する」を参照してください。

単体テストプロジェクトを作成するには:

テストするコードを含むソリューションを開きます。
ソリューションエクスプローラーでソリューションを右クリックし、[追加]>[新しいプロジェクト] を選択します。
単体テストプロジェクトテンプレートを選択します。

この例では、NUnit を選択します

[次へ] をクリックし、プロジェクトに名前を設定して、[作成] をクリックします。

プロジェクトテンプレートには、NUnit と NUnit3TestAdapter への NuGet 参照が含まれています。
テストプロジェクトから、テストするコードを含むプロジェクトに参照を追加します。

ソリューションエクスプローラーでプロジェクトを右クリックし、[追加]>[参照] を選択します。 ([参照] ノードまたは [依存関係] ノードの右クリックメニューから参照を追加することもできます。)
テストメソッドにコードを追加する
テストエクスプローラーで、またはテストコードを右クリックして [テストの実行] を選択して、テストを実行します (または Ctrl + R、T キーを押します)。