使用 dotnet test 和 NUnit 进行 F# 库的单元测试

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

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

先决条件

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

创建源项目

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

dotnet new sln

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

/unit-testing-with-fsharp
    unit-testing-with-fsharp.sln
    /MathService

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

dotnet new classlib -lang "F#"

创建数学服务的失败实现：

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

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

dotnet sln add .\MathService\MathService.fsproj

创建测试项目

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

/unit-testing-with-fsharp
    unit-testing-with-fsharp.sln
    /MathService
        Source Files
        MathService.fsproj
    /MathService.Tests

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

dotnet new nunit -lang "F#"

此命令会创建一个将 NUnit 用作测试框架的测试项目。 生成的模板在 MathServiceTests.fsproj 中配置测试运行程序：

<ItemGroup>
  <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
  <PackageReference Include="NUnit" Version="4.1.0" />
  <PackageReference Include="NUnit3TestAdapter" Version="4.5.0" />
</ItemGroup>

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

dotnet add reference ../MathService/MathService.fsproj

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

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

/unit-testing-with-fsharp
    unit-testing-with-fsharp.sln
    /MathService
        Source Files
        MathService.fsproj
    /MathService.Tests
        Test Source Files
        MathService.Tests.fsproj

在 unit-testing-with-fsharp 目录中执行以下命令：

dotnet sln add .\MathService.Tests\MathService.Tests.fsproj

创建第一个测试

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

namespace MathService.Tests

open System
open NUnit.Framework
open MathService

[<TestFixture>]
type TestClass () =

    [<Test>]
    member this.TestMethodPassing() =
        Assert.That(true, Is.True)

    [<Test>]
     member this.FailEveryTime() = Assert.That(false, Is.True)

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

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

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

[<Test>]
member this.TestEvenSequence() =
    let expected = Seq.empty<int>
    let actual = MyMath.squaresOfOdds [2; 4; 6; 8; 10]
    Assert.That(actual, Is.EqualTo(expected))

请注意，expected 序列需要转换为列表。 NUnit 框架依赖于许多标准 .NET 类型。 此依赖关系表示公共接口和预期结果支持 ICollection，而非 IEnumerable。

运行此测试时，会看到测试失败。 因为尚未创建实现。 在起作用的 MathService 项目的 Library.fs 类中编写最简单的代码，使此测试通过：

let squaresOfOdds xs =
    Seq.empty<int>

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

满足以下要求：

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

[<Test>]
member public this.TestOnesAndEvens() =
    let expected = [1; 1; 1; 1]
    let actual = MyMath.squaresOfOdds [2; 1; 4; 1; 6; 1; 8; 1; 10]
    Assert.That(actual, Is.EqualTo(expected))

如果执行 dotnet test，新测试将失败。 必须更新 squaresOfOdds 方法才能处理此新测试。 必须筛选出序列中的所有偶数值，以使此测试通过。 可以编写一个小筛选器函数并使用 Seq.filter 来实现此目的：

let private isOdd x = x % 2 <> 0

let squaresOfOdds xs =
    xs
    |> Seq.filter isOdd

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

[<Test>]
member public this.TestSquaresOfOdds() =
    let expected = [1; 9; 25; 49; 81]
    let actual = MyMath.squaresOfOdds [1; 2; 3; 4; 5; 6; 7; 8; 9; 10]
    Assert.That(actual, Is.EqualTo(expected))

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

let private square x = x * x
let private isOdd x = x % 2 <> 0

let squaresOfOdds xs =
    xs
    |> Seq.filter isOdd
    |> Seq.map square

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

另请参阅

• dotnet add reference
• dotnet test