.net - 如何在 xUnit 中为包含测试的类设置显示名称？

Question

xUnit 给了我们 DisplayName [Fact] 的属性(property)属性来指定我们的测试应该如何在 Visual Studio 的测试资源管理器中显示。例如:

public class BooksIntegrationTests
{
    [Fact(DisplayName = "GET /api/books returns http status code 200")]
    public Task Get_Books_ReturnsCollectionOfBooks()
    {
        // ... test code
    }
}

因此，而不是显示方法名称 Get_Books_ReturnsCollectionOfBooks测试资源管理器现在显示更友好的测试名称 GET /api/books returns http status code 200 .

但是有没有一种等效的方法来指定 DisplayName在包含这些测试的类上？我希望测试资源管理器显示类似 Integration tests for Books API resource 的内容而不仅仅是类名 BooksIntegrationTests .

有没有办法通过一些 xUnit 类属性来做到这一点？

Answer 1

我发现在 Visual Studio 测试资源管理器窗口中以更友好的名称对 xUnit 测试进行分组的唯一方法是使用特征功能，然后使用测试资源管理器中的 UI 选项按特征而不是按类对测试进行分组。
示例代码:

public class BooksIntegrationTests
{
    [Xunit.TraitAttribute("Category", "Integration tests for Books API resource")]
    [Fact(DisplayName = "GET /api/books returns http status code 200")]
    public void Get_Books_ReturnsCollectionOfBooks()
    {
        // ... test code
    }

    [Trait("Category", "Integration tests for Books API resource")]
    [Fact(DisplayName = "GET /api/books/book returns http status code 999")]
    public void Get_BookByISBN_ReturnsSingleBook()
    {
        // ... test code
    }
}

然后您的测试资源管理器将显示如下:



第一个红圈按钮是“Show Test Hierarchy”按钮，它应该被取消选择。就在它的右侧是“分组依据...”下拉菜单，单击它并选择按“特征”分组。我使用名为“Category”的特征将两个 xUnit 测试分组，并发明了另一个测试，它返回一本书而不是书的集合。使用此 View ，两个相关测试都显示在“类别:图书 API 资源的集成测试”下。

以上是针对VS2017的。我希望 VS2019 会相同/相似。

我没有找到一种方法来完成您想要做的事情，从而使“按“类”分组在“测试资源管理器”窗口中显示更友好的名称。我尝试在 AssemblyInfo.cs 文件中放入属性，更改项目属性，但没有任何工作可以更改类 View 。可能有办法，但我没有找到。希望这有助于让你更接近你的目标。

附言"Trait"和 "TraitAttribute"属性似乎是等效和可互换的。我在代码中展示了这两种形式来说明这一点。似乎“特征”可能是该属性的较新的首选形式，因为如果您选择“简化”名称，Visual Studio 将使用该形式。