共用方式為


使用 MSTest 和 .NET 對 C# 進行單元測試

本教學課程會逐步引導您完成建置範例解決方案的互動式體驗,以瞭解單元測試概念。 如果您想要使用預先建置的解決方案來遵循教學課程,請在開始之前檢視或下載範例程式代碼。 如需下載指示,請參閱 範例和教學課程

本文是關於測試 .NET Core 專案。 如果您要測試 ASP.NET Core 專案,請參閱 ASP.NET Core 中的整合測試。

先決條件

建立來源專案

開啟終端機視窗。 建立名為 unit-testing-using-mstest 的目錄來保存解決方案。 在此新目錄中,執行 dotnet new sln,為類別庫和測試專案建立新的方案檔。 建立 PrimeService 目錄。 下列大綱顯示到目前為止的目錄和檔案結構:

/unit-testing-using-mstest
    unit-testing-using-mstest.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-mstest 目錄。 執行 dotnet sln add,將類別庫專案新增至方案:

dotnet sln add PrimeService/PrimeService.csproj

建立測試專案

建立 PrimeService.Tests 目錄。 下列大綱顯示目錄結構:

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

PrimeService.Tests 目錄設為目前目錄,並使用 dotnet new mstest建立新專案。 dotnet new 命令會建立使用 MSTest 作為測試連結庫的測試專案。 範本會在 PrimeServiceTests.csproj 檔案中設定測試執行器:

<ItemGroup>
  <PackageReference Include="MSTest" Version="3.2.0" />
  <PackageReference Include="Microsoft.Testing.Extensions.CodeCoverage" Version="17.10.1" />
</ItemGroup>

測試專案需要其他套件才能建立和執行單元測試。 上一個步驟中的 dotnet new 新增了程式代碼涵蓋範圍報告所需的 MSTest 套件和工具。

PrimeService 類別庫新增為專案的另一個相依性。 使用 dotnet reference add 命令:

dotnet reference add ../PrimeService/PrimeService.csproj

您可以在 GitHub 上的 範例存放庫 中看到整個檔案。

下列大綱顯示最終解決方案配置:

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

變更為 unit-testing-using-mstest 目錄,然後執行 dotnet sln add

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

建立第一個測試

編寫一個失敗的測試,使其通過,然後重複此過程。 從 PrimeService.Tests 目錄移除 UnitTest1.cs,並使用下列內容建立名為 PrimeService_IsPrimeShould.cs 的新 C# 檔案:

using Microsoft.VisualStudio.TestTools.UnitTesting;
using Prime.Services;

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

        public PrimeService_IsPrimeShould()
        {
            _primeService = new PrimeService();
        }

        [TestMethod]
        public void IsPrime_InputIs1_ReturnFalse()
        {
            bool result = _primeService.IsPrime(1);

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

TestClass 屬性 表示包含單元測試的類別。 TestMethod 屬性 表示方法是測試方法。

儲存此檔案並執行 dotnet test,以建置測試和類別庫,然後執行測試。 MSTest 測試執行器包含執行測試的程式進入點。 dotnet test 使用您建立的單元測試專案啟動測試執行器。

您的測試失敗。 您尚未創建實作。 在可運作的 PrimeService 類別中撰寫最簡單的程式代碼,讓此測試通過:

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

unit-testing-using-mstest 目錄中,再次執行 dotnet testdotnet test 命令會執行 PrimeService 項目的組建,然後執行 PrimeService.Tests 項目的組建。 建置這兩個項目之後,它會執行此單一測試。 它通過了。

新增更多功能

既然您已通過一次測試,現在是時候撰寫更多了。 關於質數,有一些其他的特殊情況:0、-1。 您可以使用 TestMethod 屬性來新增測試,但這很快就會變得乏味。 還有其他 MSTest 屬性可讓您撰寫一套類似的測試。 測試方法可以執行相同的程序代碼,但有不同的輸入自變數。 您可以使用 DataRow 屬性 來指定這些輸入的值。

不要建立新的測試,而是套用這兩個屬性來建立單一數據驅動測試。 數據驅動測試是一種方法,可測試小於兩個值的數個值,這是最低質數。 在 PrimeService_IsPrimeShould.cs中新增測試方法:

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

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

執行 dotnet test,其中兩個測試會失敗。 若要讓所有測試都通過,請變更 if 檔案中 IsPrime 方法開頭的 子句:

if (candidate < 2)

在主程式庫中新增更多測試、更多理論和更多代碼,以繼續迭代。 您已獲得測試的完成版本 ,及函式庫 的完整實作

您已建立一個小型程式庫及其一組單元測試。 您已建構解決方案,以便新增新的套件和測試是一般工作流程的一部分。 您大部分的時間和精力都集中在解決應用程式的目標上。

另請參閱