使用xUnit.net进行数据驱动的单元测试

目前在.Net框架下的测试工具主要有Nunit、内置的MSTest以及xUnit这三个工具,本文就简单的介绍一下如何在VS中使用xUnit进行数据驱动的单元测试。

1. 安装

直接使用NuGet安装如下两个库即可:

PM> Install-Package xunit
PM> Install-Package xunit.runner.visualstudio -Pre (Visual Studio测试浏览器支持, VS2015目前必须装Pre的)

2.搭建项目

新建一个类库项目包含两个目录,分别存放:

TestDatas文件夹:测试需要的数据及其类型
UnitTests文件夹:单元测试

使用xUnit.net进行数据驱动的单元测试_第1张图片
目录结构

测试数据采用csv格式,好处是可以使用Excel进行编辑,同时数据结构易于解析。
ProviderTypeData_AddProviderType.csv文件在Excel中和VS中编辑的结果如下:

使用xUnit.net进行数据驱动的单元测试_第2张图片
Excel中的测试数据
使用xUnit.net进行数据驱动的单元测试_第3张图片
在VS中打开后的格式

3.解析数据

需要有一个CSVFileHelper基础类来将csv格式的数据转换成DataTable。

public static class CSVFileHelper
{
        public static DataTable OpenCSV(string filePath)
        {
            //Encoding encoding = Common.GetType(filePath); //Encoding.ASCII;//
            DataTable dt = new DataTable();
            FileStream fs = new FileStream(filePath, System.IO.FileMode.Open, System.IO.FileAccess.Read);
            StreamReader sr = new StreamReader(fs, System.Text.Encoding.GetEncoding("GB2312"));
            //StreamReader sr = new StreamReader(fs, encoding);
            //string fileContent = sr.ReadToEnd();
            //encoding = sr.CurrentEncoding;
            //记录每次读取的一行记录
            string strLine = "";
            //记录每行记录中的各字段内容
            string[] aryLine = null;
            string[] tableHead = null;
            //标示列数
            int columnCount = 0;
            //标示是否是读取的第一行
            bool IsFirst = true;
            //逐行读取CSV中的数据
            while ((strLine = sr.ReadLine()) != null)
            {
                //strLine = Common.ConvertStringUTF8(strLine, encoding);
                //strLine = Common.ConvertStringUTF8(strLine);

                if (IsFirst == true)
                {
                    tableHead = strLine.Split(',');
                    IsFirst = false;
                    columnCount = tableHead.Length;
                    //创建列
                    for (int i = 0; i < columnCount; i++)
                    {
                        DataColumn dc = new DataColumn(tableHead[i]);
                        dt.Columns.Add(dc);
                    }
                }
                else
                {
                    aryLine = strLine.Split(',');
                    DataRow dr = dt.NewRow();
                    for (int j = 0; j < columnCount; j++)
                    {
                        dr[j] = aryLine[j];
                    }
                    dt.Rows.Add(dr);
                }
            }
            if (aryLine != null && aryLine.Length > 0)
            {
                dt.DefaultView.Sort = tableHead[0] + " " + "asc";
            }

            sr.Close();
            fs.Close();
            return dt;
        }
}

4.定义数据类型

有了测试数据和数据转换工具还不够,还需要一个能被xUnit使用的类型,就是目录结构中的ProviderTypeData类。

public class ProviderTypeData : TheoryData
{
        public ProviderTypeData(string csvPath)
        {
            var path = Common.CurrentPath + csvPath;
            var dt = CSVFileHelper.OpenCSV(path);
            foreach (DataRow dr in dt.Rows)
            {
                Add(dr[0].ToString(), dr[1].ToString(), dr[2].ToString());
            }
        }
}

父类TheoryData的泛型参数与数据源的列一一对应,测试数据有三列,所以就有三个泛型参数。
然后使用父类的Add方法加载解析好的数据。

5.编写测试

public class ProviderTypeTest
{
        //测试数据
        public static ProviderTypeData providerTypeData_AddProviderType = new ProviderTypeData(
            "\\TestDatas\\ProviderTypeData_AddProviderType.csv");

        public ProviderTypeTest()
        {
        }

        [Trait("TPS", "供应商分类")]
        [Theory(DisplayName = "0001_验证数据_空数据_抛出")]
        [MemberData("providerTypeData_AddProviderType")]
        public void ValidData_EmptyData_ThrowException(
            string providerTypeName, string providerCode, string parentCode)
        {
            //do test
        }
}

简单说明一下:
1.测试数据需要是公共静态属性,在声明时实例化。
2.xUnit与MSTest在特性和断言的使用上有区别,见附录。
3.Trait特性声明了测试的分类,可以在VS的测试资源管理器中按特征查看。

使用xUnit.net进行数据驱动的单元测试_第4张图片
选择特征
使用xUnit.net进行数据驱动的单元测试_第5张图片
效果

4.Theory特性声明当前测试方法需要测试数据作为参数。
5.如果定义了Skip的值,那么测试将会被自动跳过。

[Theory(DisplayName = "0001_验证数据_空数据_抛出", Skip = "未完成")]
使用xUnit.net进行数据驱动的单元测试_第6张图片
被跳过的测试

6.MemberData特性声明了测试需要的数据源。

调试测试,结果如下:

使用xUnit.net进行数据驱动的单元测试_第7张图片
调试测试结果

有三条测试数据,就会执行三次测试,测试结果如下:

使用xUnit.net进行数据驱动的单元测试_第8张图片
测试结果

(请忽略测试的时间,因为我在截图调试结果)
以上,我们就可以实现数据驱动的测试。

附录

Attribute标记对比:

NUnit 2.2 | MSTest | xUnit.net | 备注
-|-|-
[Test] | [TestMethod] | [Fact] | 标记为测试方法
[TestFixture] | [TestClass] | n/a | 包含有测试方法的类,在xUnit.net中无需标记,它会查找程序集中所有的public的测试方法
[ExpectedException] | [ExpectedException] | Assert.Throws/ Record.Exception | 期望抛出异常
[SetUp] | [TestInitialize] | Constructor(即构造函数) | 在每个测试方法执行之前用于初始化的方法
[TearDown] | [TestCleanup] | IDisposable.Dispose | 在每个测试方法执行之后用于结束的方法
[TestFixtureSetUp] | [ClassInitialize] | IUseFixture | 在所有测试方法执行之前用于初始化的方法
[TestFixtureTearDown] | [ClassCleanup] | IUseFixture | 在所有测试方法执行之后用于结束的方法
[Ignore] | [Ignore] | [Fact(Skip="reason")] | 临时忽略被标记的方法
n/a | [Timeout] | [Fact(Timeout=n)] | 用于指定被测试方法的最大执行时间(单位毫秒),如果超过指定时间则会被标记为测试失败
[Property] | [TestProperty] | [Trait] | 设置特征
n/a | [DataSource] | [Theory], [XxxData] | 测试数据

Assertions断言对比:

NUnit 2.2 | MSTest | xUnit.net | 备注
-|-|-
AreEqual | AreEqual | Equal | 相等比较
AreNotEqual | AreNotEqual | NotEqual | 不相等比较
AreNotSame | AreNotSame | NotSame | 不相同比较
AreSame | AreSame | Same | 相同比较
Contains | Contains (on CollectionAssert) | Contains | 包含
DoAssert | n/a | n/a |
n/a | DoesNotContain (on CollectionAssert) | DoesNotContain | 不包含
n/a | n/a | DoesNotThrow | 没有抛异常
Fail | Fail | n/a | 可用Assert.True(false, "message")替代
Greater | n/a | n/a | 可用Assert.True(x > y)替代
Ignore | Inconclusive | n/a |
n/a | n/a | InRange | 确保数据在某个范围内
IsAssignableFrom | n/a | IsAssignableFrom |
IsEmpty | n/a | Empty | 为空
IsFalse | IsFalse | False | 为假
IsInstanceOfType | IsInstanceOfType | IsType |
IsNaN | n/a | n/a | 可用Assert.True(double.IsNaN(x))替代
IsNotAssignableFrom | n/a | n/a | 可用Assert.False(obj is Type)替代
IsNotEmpty | n/a | NotEmpty | 不为空
IsNotInstanceOfType | IsNotInstanceOfType | IsNotType |
IsNotNull | IsNotNull | NotNull |
IsNull | IsNull | Null |
IsTrue | IsTrue | True |
Less | n/a | n/a | 可用Assert.True(x < y)替代
n/a | n/a | NotInRange | 确保数据在不某个范围内
n/a | n/a | Throws | 确保会抛出异常

你可能感兴趣的:(使用xUnit.net进行数据驱动的单元测试)