単体テストの概要

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

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

単体テストを作成する

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

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

単体テストの例を示す目的で、この記事では HelloWorld という名前の単純な "Hello World" C# または C++ コンソールプロジェクトをテストします。このようなプロジェクトのサンプルコードは次のとおりです。
- .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#) やネイティブ単体テストプロジェクト (C++) など、使用するテストフレームワークの 単体テスト プロジェクトテンプレートを見つけて選択します。

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

ヒント

この記事では、単体テストを手動で作成する方法について説明します。既存のコードからテストを自動的に生成する場合は、「.NET または他の言語の GitHub Copilot テストを使用した単体テストの生成と実行」を参照してください。GitHub Copilot のスラッシュコマンドの使用を参照してください。

ヒント

この記事では、単体テストを手動で作成する方法について説明します。既存のコードからテストを自動的に生成する場合は、「コードから C# 単体テストメソッドスタブを作成する」を参照してください。その他の言語については、「GitHub Copilot でスラッシュコマンドを使用する」を参照してください。

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

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

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

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

たとえば、テストフレームワークに一致する正しいドキュメントタブ (MSTest、NUnit、xUnit (.NET でのみサポート))、または 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 テストフレームワークを使用している場合は、単体テストのライブ結果を確認できます。

注

これらの手順を実行するには、.NET コードと MSTest、xUnit、または NUnit のいずれかのテストフレームワークと共に、Visual Studio Enterprise が必要です。

テストメニューのテストを選択し、ライブ単体テスト>を選択して、ライブ単体テストを有効にします。
コードを記述および編集するときに、コードエディターウィンドウ内でテストの結果を表示します。
テスト結果インジケーターをクリックすると、そのメソッドに対応するテストの名前などの詳細情報が表示されます。

ライブ単体テストの詳細については、「 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) を選択します。