# AutoData属性家族：xUnit与AutoFixture的整合应用 ## 适用于 * 自动数据 * 内联自动数据 * 会员自动数据 * 复合自动数据 * xUnit AutoFixture 集成 * 参数化测试数据 * 测试参数注入 * 集合大小属性 * 外部测试数据 * CSV 测试数据 * JSON测试数据 ## 概述 AutoData 属性家族是 `AutoFixture.Xunit2` 套件提供的功能，将 AutoFixture 的数据产生能力与 xUnit 的参数化测试整合，让测试参数自动填充，大大减少测试准备方案代码。 ### 核心特色 1. **AutoData** ：自动产生所有测试参数 2. **InlineAutoData** ：混合固定值与自动产生 3. **MemberAutoData** ：结合外部数据来源 4. **CompositeAutoData**：调度数据来源整合 5. **CollectionSizeAttribute** ：控制集合产生数量 ## 安装套件 dotnet添加包AutoFixture.Xunit2 ## AutoData：完全自动产生参数 `AutoData` 是最基础的属性，自动为测试方法的所有参数产生测试数据。 ### 基本使用使用 AutoFixture.Xunit2；公开课人物 { 公共 Guid Id { 获取；放; } [字符串长度(10)] 公共字符串名称{获取;放; } = 字符串.Empty; [范围(18, 80)] 公共 int 年龄 { 得到;放; } 公共字符串电子邮件{获取;放; } = 字符串.Empty; 公共日期时间创建时间{获取;放; } } [理论] [自动数据] public void AutoData_应能自动产生所有参数(Person person, string message, int count) { // Arrange & Act - 参数已由 AutoData 自动生成 // 断言 person.Should().NotBeNull(); person.Id.Should().NotBe(Guid.Empty); person.Name.Should().HaveLength(10); // 遵循 StringLength 限制 person.Age.Should().BeInRange(18, 80); // 遵循范围限制 message.Should().NotBeNullOrEmpty(); count.Should().NotBe(0); } ### 贯穿 DataAnnotation 约束参数 [理论] [自动数据] public void AutoData_使用DataAnnotation约束参数( [StringLength(5, MaximumLength = 3)] 字符串短名称， [范围(1, 100)] int 百分比, 人人） { // 断言 ShortName.Length.Should().BeInRange(3, 5); 百分比.Should().BeInRange(1, 100); person.Should().NotBeNull(); } ## InlineAutoData：混合固定值与自动产生 `InlineAutoData` 结合了 `InlineData` 的固定值特性与 `AutoData` 的自动产生功能。 ### 基本语法 [理论] [InlineAutoData("VIP客户", 1000)] [InlineAutoData("一般客户", 500)] [InlineAutoData("新客户", 100)] public void InlineAutoData_混合固定值与自动产生( string customerType, // 对应第1个固定值十进制creditLimit, // 对应第2个固定值 Person person) // 由 AutoFixture 产生 { // 排列 var 客户 = 新客户 { 人=人，类型 = 客户类型，信用限额 = 信用限额 }; // 断言客户.Type.Should().Be(客户类型); customer.CreditLimit.Should().BeOneOf(1000, 500, 100); customer.Person.Should().NotBeNull(); } ### 参数顺序一致性固定值的顺序必须与方法参数的顺序一致： [理论] [InlineAutoData("产品A", 100)] // 依序对应名称、价格 [InlineAutoData("产品B", 200)] public void InlineAutoData_参数顺序一致性( string name, // 对应第1个固定值小数价格, //对应第2个固定值字符串描述, // 由 AutoFixture 产生产品product) // 由 AutoFixture 产生 { // 断言 name.Should().BeOneOf("产品A", "产品B"); 价格.Should().BeOneOf(100, 200); 描述.Should().NotBeNullOrEmpty(); 产品.Should().NotBeNull(); } ### ⚠️重要限制：只能使用编译时基础 // ✅ 正确：使用标记 [InlineAutoData("VIP", 100000)] [InlineAutoData("高级", 50000)] // ❌ 错误：不能使用变数私有 const 小数 VipCreditLimit = 100000m; [InlineAutoData("VIP", VipCreditLimit)] // 编译错误 // ❌错误：不能使用进攻式 [InlineAutoData("VIP", 100 * 1000)] // 编译错误需要使用复杂数据时，应使用 `MemberAutoData`。 ## MemberAutoData：结合外部资料来源 `MemberAutoData` 允许从类别的方法、属性或栏位中获取测试数据。 ### 使用静态方法公共类MemberAutoDataTests { 公共静态 IEnumerable GetProductCategories() { yield return new object[] { "3C产品", "TECH" }; yield return new object[] { "服饰配件", "时尚" }; yield return new object[] { "居家生活", "HOME" }; yield return new object[] { "运动健身", "SPORTS" }; } [理论] [MemberAutoData(nameof(GetProductCategories))] public void MemberAutoData_使用静态方法数据( stringcategoryName, // 来自 GetProductCategories stringcategoryCode, // 来自 GetProductCategories 产品product) // 由 AutoFixture 产生 { // 排列 var 分类产品 = 新的分类产品 { 产品=产品，类别名称 = 类别名称, 类别代码 = 类别代码 }; // 断言分类产品.CategoryName.Should().Be(categoryName); 分类产品.CategoryCode.Should().Be(categoryCode); 分类产品.产品.Should().NotBeNull(); } } ### 使用静态属性公共静态 IEnumerable StatusTransitions => new[] { 新对象[] { OrderStatus.Created, OrderStatus.Confirmed }, 新对象[] { OrderStatus.Confirmed, OrderStatus.Shipped }, 新对象[] { OrderStatus.Shipped, OrderStatus.Delivered }, 新对象[] { OrderStatus.Delivered, OrderStatus.Completed } }; [理论] [MemberAutoData(nameof(StatusTransitions))] public void MemberAutoData_使用静态属性_订单状态转换( 订单状态来自状态，订单状态到状态，订单订单） { // 排列 order.Status = fromStatus; // 行动 order.TransitionTo(toStatus); // 断言 order.Status.Should().Be(toStatus); } ## 自订 AutoData 属性建立专用的AutoData配置： ### 域自动数据属性公共类DomainAutoDataAttribute：AutoDataAttribute { 公共 DomainAutoDataAttribute() : 基(() => CreateFixture()) { } 私有静态 IFixture CreateFixture() { var 固定装置 = 新固定装置(); // 设置人的自订规则 Fixture.Customize(作曲家 => 作曲家 .With(p => p.Age, () => Random.Shared.Next(18, 65)) .With(p => p.Email, () => $"user{Random.Shared.Next(1000)}@example.com") .With(p => p.Name, () => $"测试用户{Random.Shared.Next(100)}")); // 设定产品的自订规则 Fixture.Customize<产品>(作曲家 => 作曲家 .With(p => p.Price, () => Random.Shared.Next(100, 10000)) .With(p => p.IsAvailable, true) .With(p => p.Name, () => $"产品{Random.Shared.Next(1000)}")); 返回夹具； } } ### BusinessAutoDataAttribute 公共类 BusinessAutoDataAttribute ：AutoDataAttribute { 公共 BusinessAutoDataAttribute() : 基(() => CreateFixture()) { } 私有静态 IFixture CreateFixture() { var 固定装置 = 新固定装置(); // 设置订单的业务规则 Fixture.Customize(作曲家 => 作曲家 .With(o => o.Status, OrderStatus.Created) .With(o => o.Amount, () => Random.Shared.Next(1000, 50000)) .With(o => o.OrderNumber, () => $"ORD{DateTime.Now:yyyyMMdd}{Random.Shared.Next(1000):D4}")); 返回夹具； } } ### 使用自订AutoData [理论] [域自动数据] public void 使用DomainAutoData(人, 产品产品) { person.Age.Should().BeInRange(18, 64); person.Email.Should().EndWith("@example.com"); 产品.IsAvailable.Should().BeTrue(); } [理论] [商业汽车数据] public void 使用BusinessAutoData(订单订单) { order.Status.Should().Be(OrderStatus.Created); order.Amount.Should().BeInRange(1000, 49999); order.OrderNumber.Should().StartWith("ORD"); } ## CompositeAutoData：时钟数据来源整合跨越继承 `AutoDataAttribute` 并以反射合并多个 Fixture 的自定义，组合多个自订 AutoData 配置： // 使用方式 - 自动套用 DomainAutoData + BusinessAutoData 的所有设置 [理论] [CompositeAutoData(typeof(DomainAutoDataAttribute), typeof(BusinessAutoDataAttribute))] public void CompositeAutoData_集成时钟数据来源( 人人、产品产品、订单订单） { person.Age.Should().BeInRange(18, 64); // DomainAutoData 的设置产品.IsAvailable.Should().BeTrue(); // DomainAutoData 的设置 order.Status.Should().Be(OrderStatus.Created); // BusinessAutoData 的设置 } ## CollectionSizeAttribute：控制集合大小 AutoData 默认的集合大小为 3，可自行修改 `CollectionSizeAttribute` 控制产生的集合元素数量。完整的实作与使用方式请参考 [CollectionSizeAttribute]完整指南]()。 ## 外部测试数据整合整合CSV、JSON等外部数据来源与MemberAutoData，同时保留AutoFixture自动产生其余参数的能力。完整指南请参考[外部测试数据整合]()。 ## 资料来源设计模式阶层式数据组织与可重用数据集的设计模式，建立`BaseTestData`威胁地域统一管理测试数据路径。完整范例请参考[资料来源设计模式]()。 ## 与 Awesome Assertions 协作 [理论] [InlineAutoData("VIP", 100000)] [InlineAutoData("高级", 50000)] [InlineAutoData("常规", 20000)] public void AutoData与AwesomeAssertions协作_客户等级验证( 字符串客户级别，小数预期信用限额， [范围(1000, 15000)] 十进制顺序金额, 客户客户，订单订单） { // 排列客户类型=客户级别；客户.CreditLimit =预期的CreditLimit; 订单金额=订单金额； // 行动 var canPlaceOrder = customer.CanPlaceOrder(order.Amount); vardiscountRate=CalculateDiscount(customer.Type, order.Amount); // 断言 - 使用 Awesome Assertions 语法 customer.Type.Should().Be(customerLevel); customer.CreditLimit.Should().Be(expectedCreditLimit); customer.CreditLimit.Should().BePositive(); order.Amount.Should().BeInRange(1000m, 15000m); canPlaceOrder.Should().BeTrue(); discountRate.Should().BeInRange(0m, 0.3m); } 私有静态十进制CalculateDiscount（字符串customerType，十进制orderAmount） { var baseDiscount = customerType 开关 { “贵宾”=> 0.15m， “高级”=> 0.10m， “常规”=> 0.05m， _ => 0米 }; var largeOrderBonus = orderAmount > 30000m ? 0.05m：0米； return Math.Min(baseDiscount + largeOrderBonus, 0.3m); } ## 最佳实践 ### 应该做 1. **善用DataAnnotation** * 在参数上使用 `[StringLength]`、`[Range]` 约束资料范围 *确保产生的资料符合业务规则 2. **建立可重用的自订AutoData** * 为不同领域建立专用的 AutoData 属性 * 集中管理测试数据的产生规则 3. **使用MemberAutoData处理复杂数据** * 当InlineAutoData无法满足需求时使用 * 支持变数、攻击方式和外部数据来源 4. **组织测试资料来源** * 建立阶层式的数据来源结构 * 将相关资料集中管理 ### 应该避免 1. **在 InlineAutoData 中使用非常数值** * InlineAutoData 只接受编译时 * 需要动态值时改用MemberAutoData 2. **过度复杂的复合自动数据** * 避免组合过多的 AutoData 来源 * 保持配置的可理解性 3. **忽略参数顺序** * InlineAutoData 的固定值必须与参数顺序一致 * 错误的顺序会导致类型不同不符 ## 课程代码范本请参考[templates]()资料夹中的示例文件： * [autodata-attributes.cs]() \- AutoData 属性家族使用示例 * [external-data-integration.cs]() \- CSV/JSON 外部数据整合 * [advanced-patterns.cs]() \- 进阶模式与 CollectionSizeAttribute ## 与其他技能的关系 * **autofixture-basics** ：本技能的前置知识 * **autofixture-customization** ：自动修正策略可用于 AutoData 属性 * **autofixture-nsubstitute-integration** ：下一步学习目标 * **awesome-assertions-guide** ：布局使用提升测试的独特性 ## 参考资源 ### 原始文章本技能内容提炼自「老派软体工程师的测试修练 - 30天挑战」系列文章： * **第12天 - 结合AutoData：xUnit 与 AutoFixture 的整合应用** * 铁人赛文章： * 示例程序代码： ### 官方文件 * [AutoFixture 备忘单 - AutoData 理论]() * [AutoDataAttribute API 参考]() * [InlineAutoDataAttribute API 参考]() * [CsvHelper 官方文件]()

Dotnet 测试 Autodata Xunit 集成

包含技能