使用 dotnet test 和 xUnit 在 .NET Core 中进行 F# 库单元测试Unit testing F# libraries in .NET Core using dotnet test and xUnit

本文内容

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

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

创建源项目Creating the source project

打开 shell 窗口。创建一个名为 unit-testing-with-fsharp 的目录,以保留该解决方案。在此新目录中,运行 dotnet new sln 创建新的解决方案。这样便于管理类库和单元测试项目。在解决方案库中,创建 MathService 目录。目录和文件结构目前如下所示:

  1. /unit-testing-with-fsharp
  2. unit-testing-with-fsharp.sln
  3. /MathService

将 MathService 作为当前目录,然后运行 dotnet new classlib -lang F# 以创建源项目。创建数学服务的失败实现:

  1. module MyMath =
  2. let squaresOfOdds xs = raise (System.NotImplementedException("You haven't written a test yet!"))

将目录更改回 unit-testing-with-fsharp 目录。运行 dotnet sln add .\MathService\MathService.fsproj 向解决方案添加类库项目。

创建测试项目Creating the test project

接下来,创建 MathService.Tests 目录。下图显示了它的目录结构:

  1. /unit-testing-with-fsharp
  2. unit-testing-with-fsharp.sln
  3. /MathService
  4. Source Files
  5. MathService.fsproj
  6. /MathService.Tests

将 MathService.Tests 目录作为当前目录,并使用 dotnet new xunit -lang F# 创建一个新项目。这会创建将 xUnit 用作测试库的测试项目。生成的模板在 MathServiceTests.fsproj 中配置测试运行程序:

  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 运行程序。现在,将 MathService 类库作为另一个依赖项添加到项目中。使用 dotnet add reference 命令:

  1. dotnet add reference ../MathService/MathService.fsproj

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

最终的解决方案布局将如下所示:

  1. /unit-testing-with-fsharp
  2. unit-testing-with-fsharp.sln
  3. /MathService
  4. Source Files
  5. MathService.fsproj
  6. /MathService.Tests
  7. Test Source Files
  8. MathServiceTests.fsproj

在 unit-testing-with-fsharp 目录中执行 dotnet sln add .\MathService.Tests\MathService.Tests.fsproj

创建第一个测试Creating the first test

编写一个失败测试,使其通过,然后重复此过程。打开 Tests.fs 并添加以下代码:

  1. [<Fact>]
  2. let ``My test`` () =
  3. Assert.True(true)
  4. [<Fact>]
  5. let ``Fail every time`` () = Assert.True(false)

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

这两个测试演示了最基本的已通过测试和未通过测试。My test 通过,而 Fail every time 未通过。现在创建针对 squaresOfOdds 方法的测试。squaresOfOdds 方法返回输入序列中所有奇整数值的平方序列。可以以迭代的方式创建可验证此功能的测试,而非尝试同时写入所有的函数。若要让每个测试都通过,意味着要针对此方法创建必要的功能。

可以编写的最简单的测试是调用包含所有偶数的 squaresOfOdds,它的结果应该是一个空整数序列。此测试如下所示:

  1. [<Fact>]
  2. let ``Sequence of Evens returns empty collection`` () =
  3. let expected = Seq.empty<int>
  4. let actual = MyMath.squaresOfOdds [2; 4; 6; 8; 10]
  5. Assert.Equal<Collections.Generic.IEnumerable<int>>(expected, actual)

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

  1. let squaresOfOdds xs =
  2. Seq.empty<int>

在 unit-testing-with-fsharp 目录中,再次运行 dotnet testdotnet test 命令构建 MathService 项目,然后构建 MathService.Tests 项目。构建这两个项目后,该命令将运行此单项测试。测试通过。

完成要求Completing the requirements

你已经通过了一个测试,现在可以编写更多测试。下一个简单示例使用的序列包含的唯一奇数为 1数值 1 较为简单,因为 1 的平方是 1。下一个测试如下所示:

  1. [<Fact>]
  2. let ``Sequences of Ones and Evens returns Ones`` () =
  3. let expected = [1; 1; 1; 1]
  4. let actual = MyMath.squaresOfOdds [2; 1; 4; 1; 6; 1; 8; 1; 10]
  5. Assert.Equal<Collections.Generic.IEnumerable<int>>(expected, actual)

执行 dotnet test 以运行测试,并显示新测试失败。现在更新 squaresOfOdds 方法,以处理此新测试。筛选出序列中的所有偶数值,以使此测试通过。可以编写一个小筛选器函数并使用 Seq.filter 来实现此目的:

  1. let private isOdd x = x % 2 <> 0
  2. let squaresOfOdds xs =
  3. xs
  4. |> Seq.filter isOdd

还要执行一个步骤:计算每个奇数的平方值。从编写新测试开始:

  1. [<Fact>]
  2. let ``SquaresOfOdds works`` () =
  3. let expected = [1; 9; 25; 49; 81]
  4. let actual = MyMath.squaresOfOdds [1; 2; 3; 4; 5; 6; 7; 8; 9; 10]
  5. Assert.Equal(expected, actual)

可以通过映射操作传递经过筛选的序列来计算每个奇数的平方,以此方式来修复测试的缺陷:

  1. let private square x = x * x
  2. let private isOdd x = x % 2 <> 0
  3. let squaresOfOdds xs =
  4. xs
  5. |> Seq.filter isOdd
  6. |> Seq.map square

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