使用 dotnet test 和 xUnit 进行 Visual Basic .NET Core 库单元测试Unit testing Visual Basic .NET Core libraries using dotnet test and xUnit

本文内容

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

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

创建源项目Creating the source project

打开 shell 窗口。创建一个名为 unit-testing-vb-using-dotnet-test 的目录，以保留该解决方案。在此新目录中，运行 dotnet new sln 创建新的解决方案。此做法便于管理类库和单元测试项目。在解决方案目录中，创建 PrimeService 目录。目前目录和文件结构如下所示：

  1. /unit-testing-using-dotnet-test
  2.     unit-testing-using-dotnet-test.sln
  3.     /PrimeService

将 PrimeService 作为当前目录，然后运行 dotnet new classlib -lang VB 以创建源项目。将 Class1.VB 重命名为 PrimeService.VB 。创建 PrimeService 类的失败实现：

  1. Namespace Prime.Services
  2.     Public Class PrimeService
  3.         Public Function IsPrime(candidate As Integer) As Boolean
  4.             Throw New NotImplementedException("Please create a test first")
  5.         End Function
  6.     End Class
  7. End Namespace

将目录更改回 unit-testing-vb-using-dotnet-test 目录。运行 dotnet sln add .\PrimeService\PrimeService.vbproj 向解决方案添加类库项目。

创建测试项目Creating the test project

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

  1. /unit-testing-vb-using-dotnet-test
  2.     unit-testing-vb-using-dotnet-test.sln
  3.     /PrimeService
  4.         Source Files
  5.         PrimeService.vbproj
  6.     /PrimeService.Tests

将 PrimeService.Tests 目录作为当前目录，并使用 dotnet new xunit -lang VB 创建一个新项目。此命令会创建将 xUnit 用作测试库的测试项目。生成的模板在 PrimeServiceTests.vbproj 中配置了测试运行程序：

  1. <ItemGroup>
  2.   <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.3.0-preview-20170628-02" />
  3.   <PackageReference Include="xunit" Version="2.2.0" />
  4.   <PackageReference Include="xunit.runner.visualstudio" Version="2.2.0" />
  5. </ItemGroup>

测试项目需要其他包创建和运行单元测试。dotnet new 在以前的步骤中已添加 xUnit 和 xUnit 运行程序。现在，将 PrimeService 类库作为另一个依赖项添加到项目中。使用 dotnet add reference 命令：

  1. dotnet add reference ../PrimeService/PrimeService.vbproj

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

最终的文件夹布局将如下所示：

  1. /unit-testing-using-dotnet-test
  2.     unit-testing-using-dotnet-test.sln
  3.     /PrimeService
  4.         Source Files
  5.         PrimeService.vbproj
  6.     /PrimeService.Tests
  7.         Test Source Files
  8.         PrimeServiceTests.vbproj

在 unit-testing-vb-using-dotnet-test 目录中执行 dotnet sln add .\PrimeService.Tests\PrimeService.Tests.vbproj。

创建第一个测试Creating the first test

编写一个失败测试，使其通过，然后重复此过程。从 PrimeService.Tests 目录删除 UnitTest1.vb ，并创建一个名为 PrimeService_IsPrimeShould.VB 的新 Visual Basic 文件。添加以下代码：

  1. Imports Xunit
  3. Namespace PrimeService.Tests
  4.     Public Class PrimeService_IsPrimeShould
  5.         Private _primeService As Prime.Services.PrimeService = New Prime.Services.PrimeService()
  7.         <Fact>
  8.         Sub IsPrime_InputIs1_ReturnFalse()
  9.             Dim result As Boolean = _primeService.IsPrime(1)
  11.             Assert.False(result, "1 should not be prime")
  12.         End Sub
  14.     End Class
  15. End Namespace

<Fact> 属性表示由测试运行程序运行的测试方法。在 unit-testing-using-dotnet-test 中，执行 dotnet test 以构建测试和类库，然后运行测试。xUnit 测试运行程序包含要运行测试的程序入口点。dotnet test 使用已创建的单元测试项目启动测试运行程序。

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

  1. Public Function IsPrime(candidate As Integer) As Boolean
  2.     If candidate = 1 Then
  3.         Return False
  4.     End If
  5.     Throw New NotImplementedException("Please create a test first.")
  6. End Function

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

添加更多功能Adding more features

你已经通过了一个测试，现在可以编写更多测试。质数有其他几种简单情况：0、-1。可以将这些情况添加为具有 <Fact> 属性的新测试，但这很快就会变得枯燥乏味。还有其他 xUnit 属性，可使你编写类似测试套件。<Theory> 属性表示执行相同代码，但具有不同输入参数一系列测试。可以使用 <InlineData> 属性来指定这些输入的值。

可以不使用这两个属性创建新测试，而用来创建单个索引。此索引是测试多个小于 2（即最小的质数）的值的方法：

  1.     Public Class PrimeService_IsPrimeShould
  2.         Private _primeService As Prime.Services.PrimeService = New Prime.Services.PrimeService()
  4.         <Theory>
  5.         <InlineData(-1)>
  6.         <InlineData(0)>
  7.         <InlineData(1)>
  8.         Sub IsPrime_ValueLessThan2_ReturnFalse(value As Integer)
  9.             Dim result As Boolean = _primeService.IsPrime(value)
  11.             Assert.False(result, $"{value} should not be prime")
  12.         End Sub
  14.         <Theory>
  15.         <InlineData(2)>
  16.         <InlineData(3)>
  17.         <InlineData(5)>
  18.         <InlineData(7)>
  19.         Public Sub IsPrime_PrimesLessThan10_ReturnTrue(value As Integer)
  20.             Dim result As Boolean = _primeService.IsPrime(value)
  22.             Assert.True(result, $"{value} should be prime")
  23.         End Sub
  25.         <Theory>
  26.         <InlineData(4)>
  27.         <InlineData(6)>
  28.         <InlineData(8)> 
  29.         <InlineData(9)> 
  30.         Public Sub IsPrime_NonPrimesLessThan10_ReturnFalse(value As Integer)
  31.             Dim result As Boolean = _primeService.IsPrime(value)
  33.             Assert.False(result, $"{value} should not be prime")
  34.         End Sub
  35.     End Class

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

  1. if candidate < 2

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

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