XUnit - Shared Context between Tests

原文

单元测试类通常都会有share setup和cleanup的相关代码。xUnit.net根据共享的范围提供了几种share setup和cleanup的方法。

• Constructor and Dispose (shared setup/cleanup code 无共享对象实例)
• Class Fixtures (一个类中的多个test共享一个对象实例)
• Collection Fixtures (多个类共享对象实例)

Constructor and Dispose

使用场景: 当你想在每次测试后clean测试上下文 (shared setup/cleanup code 无共享对象实例)。

每次测试运行时xUnit.net会创建测试类的实例，所以测试类构造函数里的代码每次测试时都会运行。因此如果你想有些想可复用的上下文，构造函数是个非常适合放置这些可复用上下文的地方。

如果你想cleanup上下文，只需让你的测试类实现IDisposable, 并将cleanup上下文的代码写在Dispose() 方法中即可。

例子:

public class StackTests : IDisposable
{
    Stack<int> stack;

    public StackTests()
    {
        stack = new Stack<int>();
    }

    public void Dispose()
    {
        stack.Dispose();
    }

    [Fact]
    public void WithNoItems_CountShouldReturnZero()
    {
        var count = stack.Count;

        Assert.Equal(0, count);
    }

    [Fact]
    public void AfterPushingItem_CountShouldReturnOne()
    {
        stack.Push(42);

        var count = stack.Count;

        Assert.Equal(1, count);
    }
}

有时候将上面的结构称为 "test class as context" 模式, 因为测试类本身自包含了setup上下文和cleanup上下文的代码。你甚至可以根据setup上下文后的情况来命名你的测试类，这样可以更容易的看出这个测试类的初始点是什么样的:

public class StackTests
{
    public class EmptyStack
    {
        Stack<int> stack;

        public EmptyStack()
        {
            stack = new Stack<int>();
        }

        // ... tests for an empty stack ...
    }

    public class SingleItemStack
    {
        Stack<int> stack;

        public SingleItemStack()
        {
            stack = new Stack<int>();
            stack.Push(42);
        }

        // ... tests for a single-item stack ...
    }
}

因为每个context是处于某种情况的Stack。我们把EmptyStack和SingleItemStack类放在StackTests类里面。

Class Fixtures

使用场景: 你想创建一个测试上下文对象并在一个测试类中的多个测试方法中共享它，并在这个类中打得所有的测试结束后cleanup它。

有的时候setup和cleanup上下文是非常耗时的。如果你每个测试都去setup和cleanup上下文，那会非常耗时。这时你可以使用xUnit.net提供的fixture特性用来在一个测试类中的所有测试方法中共享同一个上下文对象。

我们已经知道 xUnit.net会为每次测试创建一个测试类的实例。当我们使用class fixture时, xUnit.net会确保在任何test测试前先创建fixture实例，并且一旦测试全部完成会调用Dispose执行cleanup。

使用class fixture步骤如下：

• 创建fixture class, 将startup代码放在fixture class的构造函数中。
• 如果fixture class要执行cleanup，那么需要实现IDisposable, 并在Dispose()中写cleanup的代码。
• 测试类需要实现IClassFixture<>
• 如果测试类想获取fixture class的实例，只需将fixture类作为参数传到测试类的构造函数中即可。
  
  例子:

public class DatabaseFixture : IDisposable
{
    public DatabaseFixture()
    {
        Db = new SqlConnection("MyConnectionString");

        // ... 在测试数据库中初始化数据 ...
    }

    public void Dispose()
    {
        // ... 清除测试数据 ...
    }

    public SqlConnection Db { get; private set; }
}
public class MyDatabaseTests : IClassFixture<DatabaseFixture>
{
    DatabaseFixture fixture;

    public MyDatabaseTests(DatabaseFixture fixture)
    {
        this.fixture = fixture;
    }

    // ... write tests, using fixture.Db to get access to the SQL Server ...
}

在MyDatabaseTests的测试运行前, xUnit.net会创建一个DatabaseFixture的实例。每个测试都会创建一个MyDatabaseTests的实例, 并将共享的DatabaseFixture实例传到测试类的构造函数中去。

注意: 如果你只在没有实现IClassFixture<>的情况下将fixture class做为了测试类的构造函数参数， xUnit.net会报错。

如果你需要多个fixture对象，只要实现多个IClassFixture<>，并将这些fixture对象作为测试类的构造函数参数就行了。构造函数参数的顺序不重要。

注意你没法控制fixture对象创建的顺序，fixture不能依赖其他的fixture。如果你想控制顺序或者在fixture之间有依赖关系，你需要创建一个类并在其中封装另外两个fixture。

注意: Fixtures必须和使用它的测试类在同一个程序集。

Collection Fixtures

使用场景: 你想在多个测试类中共享一个测试上下文对象，并在所有测试类的测试都跑完了后执行cleanup。

使用collection fixtures步骤如下:

• 创建fixture class, 将startup代码放在fixture class的构造函数中。
• 如果fixture class要执行cleanup，fixture class需要实现IDisposable, 将cleanup代码放在Dispose()方法中。
• 创建collection definition class, 且添加[CollectionDefinition]attribute, 给一个唯一的名。
• collection definition class实现 ICollectionFixture<>。
• 为所有要用collection fixtures的测试类添加[Collection]attribute, 并使用在collection definition class的[CollectionDefinition]attribute的唯一名。
• 如果测试类想获取fixture class的实例，只需将fixture类作为参数传到测试类的构造函数中即可。

例子:

public class DatabaseFixture : IDisposable
{
    public DatabaseFixture()
    {
        Db = new SqlConnection("MyConnectionString");

        // ... initialize data in the test database ...
    }

    public void Dispose()
    {
        // ... clean up test data from the database ...
    }

    public SqlConnection Db { get; private set; }
}

[CollectionDefinition("Database collection")]
public class DatabaseCollection : ICollectionFixture<DatabaseFixture>
{
    // This class has no code, and is never created. Its purpose is simply
    // to be the place to apply [CollectionDefinition] and all the
    // ICollectionFixture<> interfaces.
}

[Collection("Database collection")]
public class DatabaseTestClass1
{
    DatabaseFixture fixture;

    public DatabaseTestClass1(DatabaseFixture fixture)
    {
        this.fixture = fixture;
    }
}

[Collection("Database collection")]
public class DatabaseTestClass2
{
    // ...
}

xUnit.net对collection fixtures的处理可class fixtures类似, 除了collection fixture对象的生命周期更长: 在所有测试类的测试前创建，在所有测试类的测试完成后cleanup。

Test collections can also be decorated with IClassFixture<>. xUnit.net treats this as though each individual test class in the test collection were decorated with the class fixture.

Test collections also influence the way xUnit.net runs tests when running them in parallel. For more information, see Running Tests in Parallel.

注意: Fixtures和使用它的测试类必须在同一个程序集。