浅谈.Net Core后端单元测试
1. 前言
单元测试一直都是"好处大家都知道很多,但是因为种种原因没有实施起来"的一个老大难问题。具体是否应该落地单元测试,以及落地的程度, 每个项目都有自己的情况。
本篇为个人认为"如何更好地写单元测试", 即更加偏向实践向中夹杂一些理论的分享。
下列示例的单元测试框架为xUnit
, Mock库为Moq
2. 为什么需要单元测试
优点有很多, 这里提两点我个人认为的很明显的好处
2.1 防止回归
通常在进行新功能/模块的开发或者是重构的时候,测试会进行回归测试原有的已存在的功能,以验证以前实现的功能是否仍能按预期运行。
使用单元测试,可在每次生成后,甚至在更改一行代码后重新运行整套测试, 从而可以很大程度减少回归缺陷。
2.2 减少代码耦合
当代码紧密耦合或者一个方法过长的时候,编写单元测试会变得很困难。当不去做单元测试的时候,可能代码的耦合不会给人感觉那么明显。为代码编写测试会自然地解耦代码,变相提高代码质量和可维护性。
3. 基本原则和规范
3.1 3A原则
3A分别是"arrange、act、assert", 分别代表一个合格的单元测试方法的三个阶段
- 事先的准备
- 测试方法的实际调用
- 针对返回值的断言
一个单元测试方法可读性是编写测试时最重要的方面之一。 在测试中分离这些操作会明确地突出显示调用代码所需的依赖项、调用代码的方式以及尝试断言的内容.
所以在进行单元测试的编写的时候, 请使用注释标记出3A的各个阶段的, 如下示例
[Fact]
public async Task VisitDataCompressExport_ShouldReturnEmptyResult_WhenFileTokenDoesNotExist()
{
// arrange
var mockFiletokenStore = new Mock<IFileTokenStore>();
mockFiletokenStore
.Setup(it => it.Get(It.IsAny<string>()))
.Returns(string.Empty);
var controller = new StatController(
mockFiletokenStore.Object,
null);
// act
var actual = await controller.VisitDataCompressExport("faketoken");
// assert
Assert.IsType<EmptyResult>(actual);
}
3.2 尽量避免直接测试私有方法
尽管私有方法可以通过反射进行直接测试,但是在大多数情况下,不需要直接测试私有的private方法, 而是通过测试公共public方法来验证私有的private方法。
可以这样认为:private方法永远不会孤立存在。更应该关心的是调用private方法的public方法的最终结果。
3.3 重构原则
如果一个类/方法,有很多的外部依赖,造成单元测试的编写困难。那么应该考虑当前的设计和依赖项是否合理。是否有部分可以存在解耦的可能性。选择性重构原有的方法,而不是硬着头皮写下去.
3.4 避免多个断言
如果一个测试方法存在多个断言,可能会出现某一个或几个断言失败导致整个方法失败。这样不能从根本上知道是了解测试失败的原因。
所以一般有两种解决方案
- 拆分成多个测试方法
- 使用参数化测试, 如下示例
[Theory]
[InlineData(null)]
[InlineData("a")]
public void Add_InputNullOrAlphabetic_ThrowsArgumentException(string input)
{
// arrange
var stringCalculator = new StringCalculator();
// act
Action actual = () => stringCalculator.Add(input);
// assert
Assert.Throws<ArgumentException>(actual);
}
当然如果是对对象进行断言, 可能会对对象的多个属性都有断言。此为例外。
3.5 文件和方法命名规范
文件名规范
一般有两种。比如针对UserController
下方法的单元测试应该统一放在UserControllerTest
或者UserController_Test
下
单元测试方法名
单元测试的方法名应该具有可读性,让整个测试方法在不需要注释说明的情况下可以被读懂。格式应该类似遵守如下
<被测试方法全名>_<期望的结果>_<给予的条件>
// 例子
[Fact]
public void Add_InputNullOrAlphabetic_ThrowsArgumentException()
{
...
}
4. 常用类库介绍
4.1 xUnit/MsTest/NUnit
编写.Net Core的单元测试绕不过要选择一个单元测试的框架, 三大单元测试框架中
- MsTest是微软官方出品的一个测试框架
- NUnit没用过
- xUnit是.Net Foundation下的一个开源项目,并且被dotnet github上很多仓库(包括runtime)使用的单元测试框架
三大测试框架发展至今已是大差不差, 很多时候选择只是靠个人的喜好。
个人偏好xUnit
简洁的断言
// xUnit
Assert.True()
Assert.Equal()
// MsTest
Assert.IsTrue()
Assert.AreEqual()
客观地功能性地分析三大框架地差异可以参考如下
https://anarsolutions.com/automated-unit-testing-tools-comparison
4.2 Moq
官方仓库
Moq是一个非常流行的模拟库, 只要有一个接口它就可以动态生成一个对象, 底层使用的是Castle的动态代理功能.
基本用法
在实际使用中可能会有如下场景
public class UserController
{
private readonly IUserService _userService;
public UserController(IUserService userService)
{
_userService = userService;
}
[HttpGet("{id}")]
public IActionResult GetUser(int id)
{
var user = _userService.GetUser(id);
if (user == null)
{
return NotFound();
}
else
{
...
}
}
}
在进行单元测试的时候, 可以使用Moq
对_userService.GetUser
进行模拟返回值
[Fact]
public void GetUser_ShouldReturnNotFound_WhenCannotFoundUser()
{
// arrange
// 新建一个IUserService的mock对象
var mockUserService = new Mock<IUserService>();
// 使用moq对IUserService的GetUs方法进行mock: 当入参为233时返回null
mockUserService
.Setup(it => it.GetUser(233))
.Return((User)null);
var controller = new UserController(mockUserService.Object);
// act
var actual = controller.GetUser(233) as NotFoundResult;
// assert
// 验证调用过userService的GetUser方法一次,且入参为233
mockUserService.Verify(it => it.GetUser(233), Times.AtMostOnce());
}
4.3 AutoFixture
官方仓库
AutoFixture是一个假数据填充库,旨在最小化3A中的arrange
阶段,使开发人员更容易创建包含测试数据的对象,从而可以更专注与测试用例的设计本身。
基本用法
直接使用如下的方式创建强类型的假数据
[Fact]
public void IntroductoryTest()
{
// arrange
Fixture fixture = new Fixture();
int expectedNumber = fixture.Create<int>();
MyClass sut = fixture.Create<MyClass>();
// act
int result = sut.Echo(expectedNumber);
// assert
Assert.Equal(expectedNumber, result);
}
上述示例也可以和测试框架本身结合,比如xUnit
[Theory, AutoData]
public void IntroductoryTest(
int expectedNumber, MyClass sut)
{
// act
int result = sut.Echo(expectedNumber);
// assert
Assert.Equal(expectedNumber, result);
}
5. 实践中结合Visual Studio的使用
Visual Studio提供了完备的单元测试的支持,包括运行. 编写. 调试单元测试。以及查看单元测试覆盖率等。
5.1 如何在Visual Studio中运行单元测试
5.2 如何在Visual Studio中查看单元测试覆盖率
如下功能需要Visual Studio 2019 Enterprise版本,社区版不带这个功能。
如何查看覆盖率
- 在测试窗口下,右键相应的测试组
- 点击如下的"分析代码覆盖率"
6. 实践中常见场景的Mock
主要
6.1 DbSet
使用EF Core过程中,如何mock DbSet是一个绕不过的坎。
方法一
参考如下链接的回答进行自行封装
https://stackoverflow.com/questions/31349351/how-to-add-an-item-to-a-mock-dbset-using-moq
方法二(推荐)
使用现成的库(也是基于上面的方式封装好的)
仓库地址:
使用范例
// 1. 测试时创建一个模拟的List<T>
var users = new List<UserEntity>()
{
new UserEntity{LastName = "ExistLastName", DateOfBirth = DateTime.Parse("01/20/2012")},
...
};
// 2. 通过扩展方法转换成DbSet<UserEntity>
var mockUsers = users.AsQueryable().BuildMock();
// 3. 赋值给给mock的DbContext中的Users属性
var mockDbContext = new Mock<DbContext>();
mockDbContext
.Setup(it => it.Users)
.Return(mockUsers);
6.2 HttpClient
使用RestEase/Refit的场景
如果使用的是RestEase
或者Refit
等第三方库,具体接口的定义本质上就是一个interface,所以直接使用moq进行方法mock即可。
并且建议使用这种方式。
IHttpClientFactory
如果使用的是.Net Core自带的IHttpClientFactory
方式来请求外部接口的话,可以参考如下的方式对IHttpClientFactory
进行mock
https://www.thecodebuzz.com/unit-test-mock-httpclientfactory-moq-net-core/
6.3 ILogger
由于ILogger的LogError等方法都是属于扩展方法,所以不需要特别的进行方法级别的mock。
针对平时的一些使用场景封装了一个帮助类, 可以使用如下的帮助类进行Mock和Verify
public static class LoggerHelper
{
public static Mock<ILogger<T>> LoggerMock<T>() where T : class
{
return new Mock<ILogger<T>>();
}
public static void VerifyLog<T>(this Mock<ILogger<T>> loggerMock, LogLevel level, string containMessage, Times times)
{
loggerMock.Verify(
x => x.Log(
level,
It.IsAny<EventId>(),
It.Is<It.IsAnyType>((o, t) => o.ToString().Contains(containMessage)),
It.IsAny<Exception>(),
(Func<It.IsAnyType, Exception, string>)It.IsAny<object>()),
times);
}
public static void VerifyLog<T>(this Mock<ILogger<T>> loggerMock, LogLevel level, Times times)
{
loggerMock.Verify(
x => x.Log(
level,
It.IsAny<EventId>(),
It.IsAny<It.IsAnyType>(),
It.IsAny<Exception>(),
(Func<It.IsAnyType, Exception, string>)It.IsAny<object>()),
times);
}
}
使用方法
[Fact]
public void Echo_ShouldLogInformation()
{
// arrange
var mockLogger = LoggerHelpe.LoggerMock<UserController>();
var controller = new UserController(mockLogger.Object);
// act
controller.Echo();
// assert
mockLogger.VerifyLog(LogLevel.Information, "hello", Times.Once());
}
7. 拓展
7.1 TDD介绍
TDD是测试驱动开发(Test-Driven Development)的英文简称. 一般是先提前设计好单元测试的各种场景再进行真实业务代码的编写,编织安全网以便将Bug扼杀在在摇篮状态。
此种开发模式以测试先行,对开发团队的要求较高, 落地可能会存在很多实际困难。详细说明可以参考如下
参考链接
- https://docs.microsoft.com/en-us/dotnet/core/testing/unit-testing-best-practices
- https://www.kiltandcode.com/2019/06/16/best-practices-for-writing-unit-tests-in-csharp-for-bulletproof-code/
- https://github.com/AutoFixture/AutoFixture
浅谈.Net Core后端单元测试的更多相关文章
- 浅谈.Net Core中使用Autofac替换自带的DI容器
为什么叫 浅谈 呢?就是字面上的意思,讲得比较浅,又不是不能用(这样是不对的)!!! Aufofac大家都不陌生了,说是.Net生态下最优秀的IOC框架那是一点都过分.用的人多了,使用教程也十分丰富, ...
- 再谈EF Core内存数据库单元测试问题
(此文章同时发表在本人微信公众号"dotNET每日精华文章",欢迎右边二维码来关注.) 题记:在用EF Core的内存数据库进行单元测试的时候遇到"无法访问已释放的对象& ...
- 浅谈 Web 中前后端模板引擎的使用
前言 这篇文章本来不打算写的,实话说楼主对前端模板的认识还处在非常初级的阶段,但是为了整个 源码解读系列 的完整性,在深入 Underscore _.template 方法源码后,觉得还是有必要记下此 ...
- 浅谈WEB前后端分离
重审业务逻辑 用过MVC的童鞋都知道业务逻辑(Bussiness Logic),但是大多对这概念又是模棱两可,业务逻辑从来都是这样难以理解,谈论前后端分离之前这个概念非常有必要探讨一下! 在简单的CR ...
- 浅谈 EF CORE 迁移和实例化的几种方式
出于学习和测试的简单需要,使用 Console 来作为 EF CORE 的承载程序是最合适不过的.今天笔者就将平时的几种使用方式总结成文,以供参考,同时也是给本人一个温故知新的机会.因为没有一个完整的 ...
- 浅谈Web前后端分离的意义
自然是有很大意义的.下面我可能说的比较多--方便题主能够更全面的了解为什么说是有有意义的.另外,本文是以Java的角度谈前后端分离.放心,大家一定会有种是我了,没错,的感觉. 一.先来明晰下概念 前后 ...
- 好代码是管出来的——浅谈.Net Core的代码管理方法与落地(更新中...)
软件开发的目的是在规定成本和时间前提下,开发出具有适用性.有效性.可修改性.可靠性.可理解性.可维护性.可重用性.可移植性.可追踪性.可互操作性和满足用户需求的软件产品. 而对于整个开发过程来说,开发 ...
- 浅谈.Net Core DependencyInjection源码探究
前言 相信使用过Asp.Net Core开发框架的人对自带的DI框架已经相当熟悉了,很多刚开始接触.Net Core的时候觉得不适应,主要就是因为Core默认集成它的原因.它是Asp.Net ...
- 浅谈.net core如何使用EFCore为一个上下文注类型注入多个实例用于连接主从数据库
在很多一主多从数据库的场景下,很多开发同学为了复用DbContext往往采用创建一个包含所有DbSet<Model>父类通过继承派生出Write和ReadOnly类型来实现,其实可以通过命 ...
随机推荐
- Redis之哨兵机制(sentinel)——配置详解及原理介绍
说到Redis不得不提哨兵模式,那么究竟哨兵是什么意思?为什么要使用哨兵呢? 接下来一一为您讲解: 1.为什么要用到哨兵 哨兵(Sentinel)主要是为了解决在主从(master-slave)复制架 ...
- bochs 调试 com 文件 magicbreak
参考 https://blog.csdn.net/housansan/article/details/41833581 在网上看到2中解决此问题的方法:1.使用dos下的debug32工具单步跟踪pm ...
- leetcode 1 两数之和 hashmap
主要是hashmap.还有边插入边查找,提高效率和降低空间复杂度. 之前一直用map,结果发现还有hashmap,效率更高. 注意名称空间为 using namespace __gnu_cxx; 问题 ...
- Leetcode(14)-最长公共前缀
编写一个函数来查找字符串数组中的最长公共前缀. 如果不存在公共前缀,返回空字符串 "". 示例 1: 输入: ["flower","flow" ...
- Linux 驱动框架---platform驱动框架
Linux系统的驱动框架主要就是三个主要部分组成,驱动.总线.设备.现在常见的嵌入式SOC已经不是单纯的CPU的概念了,它们都会在片上集成很多外设电路,这些外设都挂接在SOC内部的总线上,不同与IIC ...
- 016.NET5_MVC_视图组件扩展定制
视图组件 1. 呈现页面响应的某一部分而不是整个响应 2. 包括在控制器和视图之间发生的关注分类和可测试优势 3.可以具有参数和业务逻辑 4. 通常在页面局部调用 如何自定义视图组件? 1.Razor ...
- How to create a folder symbol link in macOS
How to create a folder symbol link in macOS macOS 创建文件夹链接 Make AliasMake Alias Symbolic Links 符号链接 $ ...
- how to convert a number to a number array in javascript without convert number to a string
how to convert a number to a number array in javascript without convert number to a string 如何在不将数字转换 ...
- js 动态修改页面文本字体
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8&quo ...
- h5 localStorage和sessionStorage浏览器数据缓存
sessionStorage 会话数据,localStorage 没有过期时间 两个的API基本都一样的 基本的使用 // 保存一个数据 sessionStorage.setItem('key', ' ...