[小北De编程手记] : Lesson 03 玩转 xUnit.Net 之 Fixture（上）

　　在使用xUnit.Net Framework构建单元测试或自动化测试项目的时候，无论是针对一些比较耗费资源的对象亦或是为了支持Test case预设数据的能力，我们都需要有一些初始化或是清理相关的动作。在xUnit.Net中，提供了多种方式来满足我们的需要。还是照例看一下本文要讨论的内容：

• xUnit.Net 共享数据的方式（上）
• Test Case的构造函数 & IDisposable.Dispose（上）
• Class级别的Fixture ： IClassFixture（上）
• Collection级别的Fixture ： ICollectionFixture（下）
• 依赖注入以及输出日志（下）

　　本文我们只是讨论前三个议题，其他的议题我会在《xUnit.Net 之 Fixture（下）》中讨论。

　　首先，我们虚拟一个自动化测试中很容易遇到的一个场景。有四个Test case如下图所示：

　　

　　可以看到，其中前三个Case（测试功能01，02，03）步骤如下，创建DB连接->打开浏览器->执行功能->关闭浏览器->释放数据库连接。而功能测试04仅仅是需要操作数据库而已，没有操作浏览器的需求。因此，不需要在浏览器中进行操作。对于这样的一个场景，直接能想到的方法是编写4个测试方法打上前面的[Fact]标签，每个方法中创建数据库连接，打开浏览器，操作，然后释放数据库，关闭浏览器。但这样的做法有很多的问题，比如会多次占用浏览器驱动和数据库连接这样的非托管资源。而打开数据库连接和浏览器驱动往往是比较耗时的操作，多次打开会无端的增加Test case的运行时间。

　　那么，如何来设计测试步骤呢？这里，我建议满足下面几个条件（当然也是为了讲解今天的内容）：

• 在每个测试任务开始之前做一些数据的初始化工作。
• 打开一次浏览器，完成测试功能01，02，03之后，在关闭浏览器。在减少创建浏览器的开销的同时节省了测试时间
• 在应用程序级别统一创建数据库连接，Test Case 使用的数据库连接是同一份（或是统一管理的）。

（一）xUnit.Net 共享数据的方式

　　对于之前描述的业务场景，我们需要在每个Test Case执行前后，一组Test Case执行前后，所有Test Case执行前后这三个维度上添加自定义的操作。对应下来：

• 每个Test Case执行前后 ： 在每个测试任务开始之前做一些数据的初始化工作。
• 一组Test Case执行前后 ： 打开一次浏览器，完成测试功能01，02，03之后，再关闭浏览器。
• 所有Test Case执行前后 ： 在应用程序级别统一创建数据库连接。

　　如图所示，CollectionFixture可以用于添加所有Test Case执行前后的一些操作（即例子中的创建和销毁数据库连接）。对于部分Case需要初始化浏览器，我们可以使用ClassFixture提供的功能。每个Case执行前后的操作我们可以使用测试类构造函数和IDisposable.Dispose来进行处理。下面我就逐一为大家讲解如何使用这些功能。

（二）Test Case的构造函数 & IDisposable.Dispose

　　如何在每个Test Case执行前后做处理？这应该是每个使用过单元测试框架的同学都知道的。多数的框架都是通过打标签的方式来提供类似功能的，例如：NUnit的[Setup]和[TearDown] , MSTest的[TestInitialize]和[TestCleanup]。而xUnit.Net提供了一种更加优雅的处理方式，就是利用构造函数以及IDisposable.Dispose方法来实现对应的功能。懂得一些面向对象的小伙伴也许会发现，这样的改进主要是为了支持依赖注入（而不是简单的省去了标签而已）。这也为我后续的文章中要讲到的许多功能的注入实现提供了可能。讲了这么多理论，先上一段Code：

namespace Demo.UnitTest.Lesson03_Fixture
{
    public class SharedContext_Constructor : IDisposable
    {
        private ITestOutputHelper _output;
        public SharedContext_Constructor(ITestOutputHelper output)
        {
            this._output = output;
            _output.WriteLine("Execute constructor!");
        }

        #region Test case
        [Fact(DisplayName = "SharedContext.Constructor.Case01")]
        public void TestCase01()
        {
            _output.WriteLine("Execute case 01!");
        }

        [Fact(DisplayName = "SharedContext.Constructor.Case02")]
        public void TestCase02()
        {
            _output.WriteLine("Execute case 02!");
        }

        [Fact(DisplayName = "SharedContext.Constructor.Case03")]
        public void TestCase03()
        {
            _output.WriteLine("Execute case 03!");
        }
        #endregion

        public void Dispose()
        {
            _output.WriteLine("Execute dispose!");
        }
    }
}

　　代码中的ITestOutputHelper就是通过构造函数注入的方式为我们提供了输出Log的能力（这个下一篇的文章我会为大家讲解），这里你只需要知道他是可以输出一些日志的即可。上面的Code中，有3个Case，Case执行的时Runner会在执行每个Case前后分别调用测试类的构造函数和对应的Dispose方法。输出如下，我们可以看到测试类构造函数和Dispose方法在每一个Case执行前后都被执行。

（三）Class级别的Fixture ： IClassFixture

　　ok，现在我们考虑前文中提到的问题二：仅仅打开一次浏览器，完成测试功能01，02，03之后，再关闭浏览器。xUnit.Net为我们提供了基于类级别的Fixture，即IClassFixture。IClassFixture是一个泛型接口(标记接口，没有任何需要实现的方法)，接受一个类型。该类型的构造函数会在测试类中的第一个Test Case运行之前被调用。而其IDisposable.Dispose方法会在测试类中最后一个测试方法执行完成之后被执行。IClassFixture定义如下：

namespace Xunit
{
    public interface IClassFixture<TFixture> where TFixture : class
    {
    }
}

　　如何使用IClassFixture呢？步骤如下：

　　Step 01 ： 创建自定义的Fixture类，添加构造函数和IDisposable接口的实现方法。本文主要是讲解xUnit.Net的使用，因此示例代码中我没有给出创建浏览器驱动的具体代码（这部分内容可以参见我的另一个系列《[小北De编程手记] : Selenium For C# 教程》），只是添加了ExecuteCount属性用于标记执行次数，代码如下：

    public class SingleBrowserFixture : IDisposable
    {
        public int UserId { get; set; }
        public string UserName { get; set; }
        public static int ExecuteCount;

        public SingleBrowserFixture()
        {
            this.UserId = 1;
            this.UserName = "North";
            ExecuteCount++;

            //打开浏览器...
        }

        public void Dispose()
        {
            //关闭浏览器...
        }
    }

　　Step 02 ：创建具体的测试类，并继承 IClassFixture<SingleBrowserFixture>（注意：我们用接口标记需要使用哪一个类）

　　Step 03 ：在测试类中获取Fixture对象，xUnit.Net 用构造函数注入的方式提供了获取IClassFixture标记对象的方法。我们可以在测试类的构造函数中添加对应的注入参数来获取Fixture，这样的设计使得我们在测试类中所有的测试用例中共享一些Context数据，xUnit.Net执行测试用例的时候会自动识别构造参数的类型是否和IClassFixture所标记的类型是否匹配。代码如下：

    public class SharedContext_ClassFixture : IClassFixture<SingleBrowserFixture>
    {
        ITestOutputHelper _output;
        SingleBrowserFixture _fixture;
        static int _count;
        public SharedContext_ClassFixture(ITestOutputHelper output, SingleBrowserFixture fixture)
        {
            _output = output;
            _fixture = fixture;
            _count++;
        }
        #region Test case
        [Fact(DisplayName = "SharedContext.ClassFixture.Case01")]
        public void TestCase01()
        {
            _output.WriteLine("Execute case 01! Current User:[{0}]-{1}", _fixture.UserId, _fixture.UserName);
            _output.WriteLine("Execute count! Constructor:[{0}] , ClassFixture:[{1}]", _count, SingleBrowserFixture.ExecuteCount);

        }

        [Fact(DisplayName = "SharedContext.ClassFixture.Case02")]
        public void TestCase02()
        {
            _output.WriteLine("Execute case 01! Current User:[{0}]-{1}", _fixture.UserId, _fixture.UserName);
            _output.WriteLine("Execute count! Constructor:[{0}] , ClassFixture:[{1}]", _count, SingleBrowserFixture.ExecuteCount);
        }
        #endregion Test case
    }

　　代码中可以看到，我用_count 标记了测试类的执行次数，用ExecuteCount标记Fixture类的执行次数，看下运行结果：

　　可以看到，测试类的构造被执行了2次（也就是每个测试用例执行的时候都会执行一次），而ClassFixture标记的测试类中的构造函数只是被执行了一次。IDisposable.Dispose 也具有相同的逻辑。

　　下一篇，为大家介绍：

• Collection级别的Fixture ： ICollectionFixture（下）
• 依赖注入以及输出日志（下）

小北De系列文章：

　　《[小北De编程手记] : Selenium For C# 教程》

　　《[小北De编程手记]：C# 进化史》(未完成)

　　《[小北De编程手记]：玩转 xUnit.Net》(未完成)

Demo地址：https://github.com/DemoCnblogs/xUnit.Net

如果您认为这篇文章还不错或者有所收获，可以点击右下角的【推荐】按钮，因为你的支持是我继续写作，分享的最大动力！

作者：小北@North

来源：http://www.cnblogs.com/NorthAlan

声明：本博客原创文字只代表本人工作中在某一时间内总结的观点或结论，与本人所在单位没有直接利益关系。非商业，未授权，贴子请以现状保留，转载时必须保留此段声明，且在文章页面明显位置给出原文连接。