自定义xunit测试用例的执行顺序

但愿海波平

有的时候我们会对程序进行单元测试, 为了测试的效果以及后期的维护, 我一般会将各个测试拆开, 根据需要测试的类分到各个类型中, 不过在实际操作的时候就出现了一些意想不到的问题, 各个测试的执行是乱序的, 按照我自己写测试的习惯, 假如我需要测试新写的增删改查的功能, 我会将增删改查分开测试, 会按照 新增-->查询-->修改-->删除 这样的顺序编写, 在我的预想中新增操作应当是最先执行的, 但是在实际的运行过程中完全不是这样, 随机的顺序对这样的测试会有巨大的影响
所以就需要控制测试的执行顺序
为测试用例排序

一般而言, 我们会将增删改查全都放在一个测试集中

1. public class UserInfoTest
2. {
3.     [Fact]
4.     public void AddTest()
5.     {
6.     }
7.     [Fact]
8.     public void ReadTest()
9.     {
10.     }
11.     [Fact]
12.     public void UpdateTest()
13.     {
14.     }
15.     [Fact]
16.     public void DeleteTest()
17.     {
18.     }
19. }

复制代码

上面就是增删查改的测试用例, 尽管在写的时候看起来是按照我所希望的那样进行排序的, 但是在实际的执行过程却有可能是完全乱序的, 而我需要他们按照上面的顺序执行
实现ITestCaseOrderer

Xunit 中有一个 TestCaseOrdererAttribute, 加在测试类上时可以对测试类中包含的测试用例进行排序
但若是需要让 TestCaseOrdererAttribute 起效, 我们还需要实现一个接口 ITestCaseOrderer

1. public class TestOrders : ITestCaseOrderer
2. {
3.     public IEnumerable<TTestCase> OrderTestCases<TTestCase>(IEnumerable<TTestCase> testCases) where TTestCase : ITestCase
4.     {
5.         var result = testCases.ToList();
6.         return result;
7.     }
8. }

复制代码

通过实现 ITestCaseOrderer 我们可以获取到测试用例, 之后只需要将测试用例重新进行排序, 排序成预期中需要的顺序即可
最简单的就是根据名字来进行排序, 此时只需要使用 result.OrderBy(item => item.DisplayName) 就差不多可以了
但是为了严谨以及后续的可维护性, 最好在做一个新的 Attribute 对需要排序的测试用例进行标记
新建OrderAttribute

1. [AttributeUsage(AttributeTargets.Method)]
2. public class OrderAttribute : Attribute
3. {
4.     public int Sort { get; set; }
5.     public OrderAttribute(int sort)
6.     {
7.         this.Sort = sort;
8.     }
9. }

复制代码

OrderAttribute 的构成非常简单, 其中只包含一个 Sort 用来进行排序
完善TestOrders的实现

1. public class TestOrders : ITestCaseOrderer
2. {
3.     public IEnumerable<TTestCase> OrderTestCases<TTestCase>(IEnumerable<TTestCase> testCases) where TTestCase : ITestCase
4.     {
5.         var typeName = typeof(OrderAttribute).AssemblyQualifiedName;
6.         var result = testCases.ToList();
7.         result.Sort((x, y) =>
8.         {
9.             var xOrder = x.TestMethod.Method.GetCustomAttributes(typeName)?.FirstOrDefault();
10.             if (xOrder == null)
11.             {
12.                 return 0;
13.             }
14.             var yOrder = y.TestMethod.Method.GetCustomAttributes(typeName)?.FirstOrDefault();
15.             if (yOrder == null)
16.             {
17.                 return 0;
18.             }
19.             var sortX = xOrder.GetNamedArgument<int>("Sort");
20.             var sortY = yOrder.GetNamedArgument<int>("Sort");
21.             return sortX - sortY;
22.         });
23.         return result;
24.     }
25. }

复制代码

完善 TestOrders 的实现, 使得测试用例可以按照顺序进行排序
测试用例打标

1. [TestCaseOrderer("TestOrders这个类型所在的namespace.TestOrders", "TestOrders这个类型所在的namespace")]
2. public class UserInfoTest
3. {
4.     [Fact, Order(0)]
5.     public void AddTest()
6.     {
7.     }
8.     [Fact, Order(1)]
9.     public void ReadTest()
10.     {
11.     }
12.     [Fact, Order(2)]
13.     public void UpdateTest()
14.     {
15.     }
16.     [Fact, Order(3)]
17.     public void DeleteTest()
18.     {
19.     }
20. }

复制代码

TestCaseOrdererAttribute 接收两个参数, 一个是可以用来确定之前实现的 TestOrders 的完整命名空间, 第二个是 TestOrders 所在的命名空间
这两个参数主要的功能就是确定 TestOrders 的位置, Xunit会根据这两个参数找到 TestOrders 并且调用排序的方法
然后在需要进行排序的测试用例上使用 [Order] 打标, 传入自定义的排序, 然后在我们使用 dotnet test 就会按照传入的排序执行测试用例了

来源:https://www.cnblogs.com/CollapseNav/archive/2023/11/06/17812235.html
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！