使用 Visual Studio 测试 .NET 类库

项目
09/11/2023

重要

Microsoft 已宣布停用 Visual Studio for Mac。从 2024 年 8 月 31 日起，将不再支持 Visual Studio for Mac。替代方案包括：

使用 C# 开发工具包和相关扩展（如 .NET MAUI 和 Unity）的 Visual Studio Code。
在 Mac 上 VM 中的 Windows 上运行的 Visual Studio。
在云中的 VM 的 Windows 上运行的 Visual Studio。

有关详细信息，请参阅 Visual Studio for Mac 停用公告。

本教程演示如何通过将测试项目添加到解决方案来自动执行单元测试。

先决条件

本教程适用于在使用 Visual Studio for Mac 创建 .NET 类库中创建的解决方案。

创建单元测试项目

单元测试在开发和发布期间提供自动化的软件测试。 MSTest 是可供选择的三个测试框架之一。其他两个是 xUnit 和 nUnit。

启动 Visual Studio for Mac。
打开在使用 Visual Studio for Mac 创建 .NET 类库中创建的 ClassLibraryProjects 解决方案。
在“解决方案”边栏中，按住 Ctrl 并单击 ClassLibraryProjects 解决方案，然后选择“添加”>“新建项目”。
在“新建项目”对话框中，选择“Web 和控制台”节点中的“测试”。依次选择“MSTest 项目”、“下一步”。
选择“.NET Core 5.0”作为“目标框架”，然后选择“下一步”。
将新项目命名为"StringLibraryTest"，然后选择“创建”。

Visual Studio 使用以下代码创建类文件：
```
using Microsoft.VisualStudio.TestTools.UnitTesting;

namespace StringLibraryTest
{
    [TestClass]
    public class UnitTest1
    {
        [TestMethod]
        public void TestMethod1()
        {
        }
    }
}
```
单元测试模板创建的源代码负责执行以下操作：
- 它会导入 Microsoft.VisualStudio.TestTools.UnitTesting 命名空间，其中包含用于单元测试的类型。
- 向 UnitTest1 类应用 TestClassAttribute 特性。
- 它向 TestMethod1 应用 TestMethodAttribute 特性。
使用 [TestClass] 标记的测试类中标记有 [TestMethod] 的所有测试方法都会在单元测试运行时自动执行。

添加项目引用

对于要使用 StringLibrary 类的测试库，请将引用添加到 StringLibrary 项目中。

在“解决方案”边栏中，按住 Ctrl 并单击“StringLibraryTest”下的“依赖项” 。从上下文菜单中选择“添加引用”。
在“引用”对话框中，选择“StringLibrary”项目。选择“确定”。

添加并运行单元测试方法

当 Visual Studio 运行单元测试时，它会执行使用 TestClassAttribute 特性标记的类中标记有 TestMethodAttribute 特性的所有方法。当第一次遇到测试不通过或测试方法中的所有测试均已成功通过时，测试方法终止。

最常见的测试调用 Assert 类的成员。许多断言方法至少包含两个参数，其中一个是预期的测试结果，另一个是实际的测试结果。下表显示了 Assert 类最常调用的一些方法：

断言方法	函数
`Assert.AreEqual`	验证两个值或对象是否相等。如果值或对象不相等，则断言失败。
`Assert.AreSame`	验证两个对象变量引用的是否是同一个对象。如果这些变量引用不同的对象，则断言失败。
`Assert.IsFalse`	验证条件是否为 `false`。如果条件为 `true`，则断言失败。
`Assert.IsNotNull`	验证对象是否不为 `null`。如果对象为 `null`，则断言失败。

还可以在测试方法中使用 Assert.ThrowsException 方法来指示它应引发的异常的类型。如果未引发指定异常，则测试不通过。

测试 StringLibrary.StartsWithUpper 方法时，需要提供许多以大写字符开头的字符串。在这种情况下，此方法应返回 true，以便可以调用 Assert.IsTrue 方法。同样，需要提供许多以非大写字符开头的字符串。在这种情况下，此方法应返回 false，以便可以调用 Assert.IsFalse 方法。

由于库方法处理的是字符串，因此还需要确保它能够成功处理空字符串 (String.Empty)（不含字符且 Length 为 0 的有效字符串）和 null 字符串（尚未初始化的字符串）。可以直接将 StartsWithUpper 作为静态方法进行调用，并向其传递一个 String 自变量。或者，可以对分配给 null 的 string 变量将 StartsWithUpper 作为扩展方法进行调用。

将定义三个方法，每个方法都会对字符串数组中的各个元素调用它的 Assert 方法。你将调用方法重载，以便指定在测试失败时要显示的错误消息。消息标识导致失败的字符串。

创建测试方法：

打开 UnitTest1.cs 文件，并将代码替换为以下代码：

using Microsoft.VisualStudio.TestTools.UnitTesting;
using UtilityLibraries;

namespace StringLibraryTest
{
    [TestClass]
    public class UnitTest1
    {
        [TestMethod]
        public void TestStartsWithUpper()
        {
            // Tests that we expect to return true.
            string[] words = { "Alphabet", "Zebra", "ABC", "Αθήνα", "Москва" };
            foreach (var word in words)
            {
                bool result = word.StartsWithUpper();
                Assert.IsTrue(result,
                       string.Format("Expected for '{0}': true; Actual: {1}",
                                     word, result));
            }
        }

        [TestMethod]
        public void TestDoesNotStartWithUpper()
        {
            // Tests that we expect to return false.
            string[] words = { "alphabet", "zebra", "abc", "αυτοκινητοβιομηχανία", "государство",
                               "1234", ".", ";", " " };
            foreach (var word in words)
            {
                bool result = word.StartsWithUpper();
                Assert.IsFalse(result,
                       string.Format("Expected for '{0}': false; Actual: {1}",
                                     word, result));
            }
        }

        [TestMethod]
        public void DirectCallWithNullOrEmpty()
        {
            // Tests that we expect to return false.
            string?[] words = { string.Empty, null };
            foreach (var word in words)
            {
                bool result = StringLibrary.StartsWithUpper(word);
                Assert.IsFalse(result,
                       string.Format("Expected for '{0}': false; Actual: {1}",
                                     word == null ? "<null>" : word, result));
            }
        }
    }
}

TestStartsWithUpper 方法中的大写字符的测试包括希腊文大写字母 alpha (U+0391) 和西里尔文大写字母 EM (U+041C)。 TestDoesNotStartWithUpper 方法中的小写字符的测试包括希腊文小写字母 alpha (U+03B1) 和西里尔文小写字母 Ghe (U+0433)。

在菜单栏中，选择“文件”>“另存为” 。在对话框中，确保“编码”设置为“Unicode (UTF-8)” 。
当系统询问你是否要替换现有文件时，请选择“替换”。

如果无法将源代码保存为 UTF8 编码文件，Visual Studio 可能会将其另存为 ASCII 文件。在这种情况下，运行时将无法准确解码 ASCII 范围以外的 UTF8 字符，且测试结果也会不正确。
打开屏幕右侧的“单元测试”面板。从菜单中选择“查看”>“测试”。
单击“停靠”图标使此面板保持打开状态。
单击“全部运行”按钮。

所有测试通过。

处理测试失败

如果进行的是测试驱动开发 (TDD)，请先编写测试，然后测试会在第一次运行时失败。接着将可以使测试成功的代码添加到应用。在本教程中，先编写了测试要验证的应用代码然后才创建测试，所以没有看到测试失败。若要验证测试是否在预期失败时失败，请在测试输入中添加无效值。

通过修改 TestDoesNotStartWithUpper 方法中的 words 数组来包含字符串“Error”。由于 Visual Studio 将在生成运行测试的解决方案时自动保存打开的文件，因此无需手动保存。
```
string[] words = { "alphabet", "Error", "zebra", "abc", "αυτοκινητοβιομηχανία", "государство",
                   "1234", ".", ";", " " };
```
重新运行测试。

这一次，“测试资源管理器”窗口指示有两个测试成功，还有一个失败。
按 Ctrl 并单击失败的测试 TestDoesNotStartWithUpper，然后从上下文菜单中选择“显示结果边栏”。

“结果”边栏显示断言生成的消息：“Assert.IsFalse 失败。 “Error”应返回 false；实际返回 True”。由于此次失败，数组中“Error”之后的所有字符串都未进行测试。
删除在步骤 1 中添加的字符串“Error”。重新运行测试，测试将通过。

测试库的发行版本

至此，在运行库的调试版本时，测试已全部通过，接下来应对库的发行版本再运行一次这些测试。许多因素（包括编译器优化）有时可能会导致调试版本和发行版本出现行为差异。

若要测试发行版本，请执行以下操作：

在 Visual Studio 工具栏中，将生成配置从 “调试” 更改为 “发行” 。
在“解决方案”边栏中，按 Ctrl 并单击“StringLibrary”项目，然后从上下文菜单中选择“生成”，重新编译库。
再次运行单元测试。

测试通过。

调试测试

如果使用 Visual Studio for Mac 作为 IDE，可以使用教程：使用 Visual Studio for Mac 调试 .NET 控制台应用程序中所示的相同过程，使用单元测试项目调试代码。按住 Ctrl 并单击“StringLibraryTests”项目，然后从上下文菜单中选择“启动调试项目” ，而不是启动 ShowCase 应用项目。

Visual Studio 启动附有调试器的测试项目。执行将在添加到测试项目的任何断点或基础库代码处停止。

其他资源

.NET 中的单元测试

后续步骤

在本教程中，你对类库进行了单元测试。你可以将库作为包发布到 NuGet，使其可供其他人使用。若要了解如何操作，请遵循 NuGet 教程：

创建并发布包 (dotnet CLI)

如果将库作为 NuGet 包发布，其他人可以安装并使用它。若要了解如何操作，请遵循 NuGet 教程：

在 Visual Studio for Mac 中安装和使用包

库并非必须作为包进行分发。它还可与使用它的控制台应用捆绑在一起。若要了解如何发布控制台应用，请参阅本系列中前面的教程：

使用 Visual Studio for Mac 发布 .NET 控制台应用程序