.NET单元测试使用AutoFixture按需填充的几种方式和最佳实践记录

 更新时间:2024年07月21日 09:20:27   作者:万雅虎  
AutoFixture是一个.NET库,旨在简化单元测试中的数据设置过程,通过自动生成测试数据,它帮助开发者减少测试代码的编写量,使得单元测试更加简洁、易读和易维护,本文介绍.NET单元测试使用AutoFixture按需填充的几种方式和最佳实践记录,感兴趣的朋友一起看看吧

AutoFixture是一个.NET库,旨在简化单元测试中的数据设置过程。通过自动生成测试数据,它帮助开发者减少测试代码的编写量,使得单元测试更加简洁、易读和易维护。AutoFixture可以用于任何.NET测试框架,如xUnit、NUnit或MSTest。

默认情况下AutoFixture生成的字段值很多时候都满足不了测试需求,比如:

public class User
{
	public int Id { get; set; }
	public string Name { get; set; } = null!;
	[EmailAddress]
	public string? Email { get; set; }
	[StringLength(512)]
	public string? Address { get; set; }
	public DateTime CreatedAt { get; set; } = DateTime.Now;
}

如果直接使用 Create<T>()生成的User对象,他会默认给你填充Id为随机整数,Name和Email为一串Guid,显然这里的邮箱地址生成就不能满足要求,并不是一个有效的邮箱格式

那么如何让AutoFixture按需生成有效的测试数据呢?方法其实有好几种:

方法1:直接定制

var fixture = new Fixture();
fixture.Customize<User>(c => c
    .With(x => x.Email, "特定值")
    .Without(x => x.Id));

这里,With方法用于指定属性的具体值,而Without方法用于排除某些属性不被自动填充。

方法2:使用匿名函数

这在需要对生成的数据进行更复杂的操作时非常有用。

var fixture = new Fixture();
fixture.Customize<User>(c => c.FromFactory(() => new User
{
    Email = "通过工厂方法生成",
}));

方法3:实现ICustomization接口

对于更复杂的定制需求,可以通过实现ICustomization接口来创建一个定制化类。这种方法的好处是可以重用定制逻辑,并且使得测试代码更加整洁。

public class MyCustomClassCustomization : ICustomization
{
    public void Customize(IFixture fixture)
    {
        fixture.Customize<User>(c => c
            .With(x => x.Email, "自定义值")
            .Without(x => x.Id));
    }
}
// 使用定制化
var fixture = new Fixture();
fixture.Customize(new MyCustomClassCustomization());

方法4:使用Build<T>方法

Build<T>方法提供了一种链式调用的方式来定制类型的生成规则,这在只需要对单个对象进行简单定制时非常方便。

var myCustomObject = fixture.Build<User>()
                            .With(x => x.Email, $"{Guid.NewId()}@example.com")
                            .Without(x => x.Id)
                            .Create();

最佳实践:

这里以xunit测试框架为例,
我们需要提前引用AutoFixture,AutoFixture.Xunit2库,实现一个UserAutoDataAttribute类,继承自InlineAutoDataAttribute 重写GetData方法,大致代码如下:

public  class UserAutoDataAttribute : InlineAutoDataAttribute
    {
        public UserAutoDataAttribute(params object[] values) : base(values)
        {
            ArgumentNullException.ThrowIfNull(values[0]);
        }
        public override IEnumerable<object[]> GetData(MethodInfo testMethod)
        {
            var fixture = new Fixture();
            //这里使用上面的4种方式的一种,亦或者根据自身情况定制!
            var user = fixture.Build<User>()
                 //.With(x => x.Id, 0)
                 .Without(x => x.Id) //ID需要排除因为EFCore需要插入时自动生成
                 .With(x => x.Email, $"{Uuid7.NewUuid7()}@example.com") //邮箱地址,需要照规则生成
                 .Create();
            yield return new object[] { Values[0], user };
        }
    }

下面是一个测试用例,需要填充db,和一个自动生成的User参数

public class UnitOfWorkTests(ITestOutputHelper output)
{
	[Theory]
	[UserAutoData(1)]
	[UserAutoData(2)]
	public async Task MyUnitOfWorkTest(int db, User user)
	{
		var services = new ServiceCollection();
		services.AddLogging();
		services.AddDbContext<TestDbContext>(options =>
		 {
                    options.UseInMemoryDatabase($"test-{db}");
		});
		services.AddUnitOfWork<TestDbContext>();
		var provider = services.BuildServiceProvider();
		var uow = provider.GetRequiredService<IUnitOfWork<TestDbContext>>();
		//add user
		await uow.GetRepository<User>().InsertAsync(user);
		await uow.SaveChangesAsync();
		// select user
		var user2 = await uow.GetRepository<User>().FindAsync(1);
		Assert.NotNull(user2);
		// delete user
		uow.GetRepository<User>().Delete(1);
		var row = await uow.SaveChangesAsync();
		Assert.Equal(1, row);
		// select user
		user2 = await uow.GetRepository<User>().GetFirstOrDefaultAsync(x => x.Id == 1);
		Assert.Null(user2);
	}
}

如果你已经习惯编写单元测试,但还没有使用AutoFixture,那么推荐你尝试一下,也许你也会喜欢上TA

到此这篇关于.NET单元测试使用AutoFixture按需填充的几种方式和最佳实践记录的文章就介绍到这了,更多相关.NET单元测试使用AutoFixture按需填充内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • ASP.NET中Web API的简单实例

    ASP.NET中Web API的简单实例

    Web API框架是一个面向Http协议的通信框架,Web API 框架是一个面向Http协议的通信框架。Web API 框架目前支持两种数据格式的序列化:Json 及 Xml。在不做任何配置的情况下,则 Web API 会自动把数据使用xml进行序列化,否则使用 json 序列化,需要的朋友可以参考下
    2015-10-10
  • ASP.NET Core利用Jaeger实现分布式追踪详解

    ASP.NET Core利用Jaeger实现分布式追踪详解

    这篇文章主要给大家介绍了关于ASP.NET Core利用Jaeger实现分布式追踪的相关资料,文中通过示例代码介绍的非常详细,对大家学习或者使用ASP.NET Core具有一定的参考学习价值,需要的朋友们下面来一起学习学习吧
    2019-04-04
  • asp.net Cookie值中文乱码问题解决方法

    asp.net Cookie值中文乱码问题解决方法

    cookie里面不能写中文,是由于cookie先天的编码方式造成的,所以有必要存在一种中间的编码方式:URLEncode是最好的选择,感兴趣的你可千万不要错过了哈,或许本文提供的知识点对你学习cookie有所帮助
    2013-02-02
  • MVC+EasyUI+三层新闻网站建立 实现登录功能(四)

    MVC+EasyUI+三层新闻网站建立 实现登录功能(四)

    这篇文章主要为大家详细介绍了MVC+EasyUI+三层新闻网站建立的第四篇,教大家实现登录功能,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-07-07
  • asp.net中简体转繁体实现代码

    asp.net中简体转繁体实现代码

    最近到了台企,什么都要用繁体的。开发中也遇到了简繁体转换的问题。这里和朋友们分享一下用.net实现简繁体转换的经验。
    2010-03-03
  • asp.net 获取银行货币汇率的代码

    asp.net 获取银行货币汇率的代码

    这个主要公司做外贸的每天都需要更新汇率,本来以前有一个服务可以调用,但是那个连接用不了 所以就写了一个这样的东西 套取网页显示信息
    2010-12-12
  • Ajax+asp.net智能匹配检索(含图含完整代码)

    Ajax+asp.net智能匹配检索(含图含完整代码)

    使用谷歌搜索引擎的用户都知道,只要在文本框中输入部分关键字,就能显示相关搜索提示信息列表
    2012-06-06
  • ASP.NET MVC前台动态添加文本框并在后台使用FormCollection接收值

    ASP.NET MVC前台动态添加文本框并在后台使用FormCollection接收值

    这篇文章介绍了ASP.NET MVC前台动态添加文本框并在后台使用FormCollection接收的方法,文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2022-08-08
  • MVC4制作网站教程第四章 前台栏目浏览4.5

    MVC4制作网站教程第四章 前台栏目浏览4.5

    这篇文章主要为大家详细介绍了MVC4制作网站教程,前台栏目浏览功能实现代码,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2016-08-08
  • ASP.NET服务器控件的生命周期分析

    ASP.NET服务器控件的生命周期分析

    这篇文章主要介绍了ASP.NET服务器控件的生命周期分析,较为详尽的讲述了asp.net服务器控件的运行原理与过程,有助于深入了解asp.net程序的运行原理,需要的朋友可以参考下
    2014-11-11

最新评论