使用 NUnit 和 .NET Core 进行 C# 单元测试Unit testing C# with NUnit and .NET Core

本文内容

本教程介绍分步构建示例解决方案的交互式体验，以了解单元测试概念。如果希望使用预构建解决方案学习本教程，请在开始前查看或下载示例代码。有关下载说明，请参阅示例和教程。

本文介绍如何测试 .NET Core 项目。如果要测试 ASP.NET Core 项目，请参阅 ASP.NET Core 中的集成测试 。

系统必备Prerequisites

  • .NET Core 2.1 SDK 或更高版本。
  • 按需选择的文本编辑器或代码编辑器。

创建源项目Creating the source project

打开 shell 窗口。创建一个名为 unit-testing-using-nunit 的目录，以保留该解决方案。在此新目录中，运行以下命令，为类库和测试项目创建新的解决方案文件：

  1. dotnet new sln

接下来，创建 PrimeService 目录。下图显示了当前的目录和文件结构：

  1. /unit-testing-using-nunit
  2.     unit-testing-using-nunit.sln
  3.     /PrimeService

将 PrimeService 作为当前目录，并运行以下命令以创建源项目：

  1. dotnet new classlib

将 Class1.cs 重命名为 PrimeService.cs。创建 PrimeService 类的失败实现：

  1. using System;
  3. namespace Prime.Services
  4. {
  5.     public class PrimeService
  6.     {
  7.         public bool IsPrime(int candidate)
  8.         {
  9.             throw new NotImplementedException("Please create a test first.");
  10.         }
  11.     }
  12. }

将目录更改回 unit-testing-using-nunit 目录。运行以下命令，向解决方案添加类库项目：

  1. dotnet sln add PrimeService/PrimeService.csproj

创建测试项目Creating the test project

接下来，创建 PrimeService.Tests 目录。下图显示了它的目录结构：

  1. /unit-testing-using-nunit
  2.     unit-testing-using-nunit.sln
  3.     /PrimeService
  4.         Source Files
  5.         PrimeService.csproj
  6.     /PrimeService.Tests

将 PrimeService.Tests 目录作为当前目录，并使用以下命令创建一个新项目：

  1. dotnet new nunit

dotnet new 命令可创建一个将 NUnit 用作测试库的测试项目。生成的模板在 PrimeService.Tests.csproj 文件中配置测试运行程序：

  1. <ItemGroup>
  2.   <PackageReference Include="nunit" Version="3.12.0" />
  3.   <PackageReference Include="NUnit3TestAdapter" Version="3.15.1" />
  4.   <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.3.0" />
  5. </ItemGroup>

测试项目需要其他包创建和运行单元测试。在上一步中，dotnet new 已添加 Microsoft 测试 SDK、NUnit 测试框架和 NUnit 测试适配器。现在，将 PrimeService 类库作为另一个依赖项添加到项目中。使用 dotnet add reference 命令：

  1. dotnet add reference ../PrimeService/PrimeService.csproj

可以在 GitHub 上的示例存储库中看到整个文件。

下图显示了最终的解决方案布局：

  1. /unit-testing-using-nunit
  2.     unit-testing-using-nunit.sln
  3.     /PrimeService
  4.         Source Files
  5.         PrimeService.csproj
  6.     /PrimeService.Tests
  7.         Test Source Files
  8.         PrimeService.Tests.csproj

在 unit-testing-using-nunit 目录中执行以下命令：

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

创建第一个测试Creating the first test

编写一个失败测试，使其通过，然后重复此过程。在 PrimeService.Tests 目录中，将 UnitTest1.cs 文件重命名为 PrimeService_IsPrimeShould.cs ，并将其整个内容替换为以下代码：

  1. using NUnit.Framework;
  2. using Prime.Services;
  4. namespace Prime.UnitTests.Services
  5. {
  6.     [TestFixture]
  7.     public class PrimeService_IsPrimeShould
  8.     {
  9.         [Test]
  10.         public void IsPrime_InputIs1_ReturnFalse()
  11.         {
  12.             PrimeService primeService = CreatePrimeService();
  13.             var result = primeService.IsPrime(1);
  15.             Assert.IsFalse(result, "1 should not be prime");
  16.         }
  18.         /*
  19.         More tests
  20.         */
  22.         private PrimeService CreatePrimeService()
  23.         {
  24.              return new PrimeService();
  25.         }
  26.     }
  27. }

[TestFixture] 属性表示包含单元测试的类。[Test] 属性指示方法是测试方法。

保存此文件并执行 dotnet test 以构建测试和类库，然后运行测试。NUnit 测试运行程序包含要运行测试的程序入口点。dotnet test 使用已创建的单元测试项目启动测试运行程序。

测试失败。尚未创建实现。在起作用的 PrimeService 类中编写最简单的代码，使此测试通过：

  1. public bool IsPrime(int candidate)
  2. {
  3.     if (candidate == 1)
  4.     {
  5.         return false;
  6.     }
  7.     throw new NotImplementedException("Please create a test first.");
  8. }

在 unit-testing-using-nunit 目录中再次运行 dotnet test。dotnet test 命令构建 PrimeService 项目，然后构建 PrimeService.Tests 项目。构建这两个项目后，该命令将运行此单项测试。测试通过。

添加更多功能Adding more features

你已经通过了一个测试，现在可以编写更多测试。质数有其他几种简单情况：0、-1。可以添加具有 [Test] 属性的新测试，但这很快就会变得枯燥乏味。还有其他 NUnit 属性可用于编写一套类似的测试。[TestCase] 属性用于创建一套可执行相同代码但具有不同输入参数的测试。可以使用 [TestCase] 属性来指定这些输入的值。

无需创建新的测试，而是应用此属性来创建数据驱动的单个测试。数据驱动的测试方法用于测试多个小于 2（即最小质数）的值：

  1. [TestCase(-1)]
  2. [TestCase(0)]
  3. [TestCase(1)]
  4. public void IsPrime_ValuesLessThan2_ReturnFalse(int value)
  5. {
  6.     var result = _primeService.IsPrime(value);
  8.     Assert.IsFalse(result, $"{value} should not be prime");
  9. }

运行 dotnet test，两项测试均失败。若要使所有测试通过，可以在 PrimeService.cs 文件中更改 Main 方法开头的 if 子句 ：

  1. if (candidate < 2)

通过在主库中添加更多测试、理论和代码继续循环访问。你将拥有已完成的测试版本和库的完整实现。

你已生成一个小型库和该库的一组单元测试。你已将解决方案结构化，使添加新包和新测试成为了正常工作流的一部分。你已将多数的时间和精力集中在解决应用程序的目标上。