Asp-Net-Core学习笔记:单元测试和集成测试

asp,net,core,学习,笔记,单元测试,集成,测试 · 浏览次数 : 475

小编点评

**单元测试和集成测试** **单元测试** * 验证代码段(如方法或函数)的功能。 * 编写相应的测试方法,以验证代码执行后与预期结果是否一致。 * 用于单元测试的测试项目主要有 xUnit 和 NUnit。 **集成测试** * 确保应用程序的组件正常工作。 * 运行在真实的系统上进行测试。 * 利用与生产环境中一样的真实组件进行测试。 * 用于集成测试的测试项目通常使用 WebApplicationFactory。 **主要区别** | 特征 | 单元测试 | 整合测试 | |---|---|---| | 测试范围 | 单个代码段或方法 | 全部应用程序组件 | | 测试方式 | 独立执行 | 与生产环境中一样运行 | | 测试目标 | 验证代码功能 | 确保应用程序正常工作 | **测试示例** **单元测试** ```csharp // 单元测试测试方法 public void Test_Method() { // 执行方法,验证预期结果 } ``` **集成测试** ```csharp // 整合测试,模拟数据库连接 public async Task Test_Method() { // 模拟数据库连接,获取数据 } ``` **结论** 单元测试和集成测试是软件开发中的重要阶段,可以确保代码功能正确执行并确保应用程序正常工作。单元测试可用于验证代码的功能,而集成测试可用于确保应用程序的完整性和可靠性。

正文

前言

我在使用 AspNetCore 的这段时间内,看了很多开源项目和博客,发现各种 .Net 体系的新技术很多人都有关注和使用,但却很少有人关注测试。

测试是软件生命周期中的一个非常重要的阶段,对于保证软件的可靠性具有极其重要的意义。在应用程序的开发过程中,为了确保它的功能与预期一致,必须对其进行测试。这样做不仅能够确保功能正确执行,同时能够帮助开发人员尽早地发现并改正系统中所存在的缺陷(Bug),从而提高软件的可靠性。测试应该覆盖到软件的所有功能,全面、细致的测试会在很大程度上节省软件开发的成本;反之,不足的测试势必会使软件包含一些未发现的缺陷而投入运行,使用户承担软件缺陷所造成的危险。

从测试所涉及的层次上,分为单元测试、集成测试和系统测试。单元测试是指验证代码段(如方法或函数)功能的测试,通常由开发人员编写相应的测试方法,以验证代码执行后与预期结果是否一致;集成测试用于验证具有依赖关系的多个模块或组件是否能够正常工作;系统测试是对整个系统进行全面测试,以确认系统正常运行并符合需求。

本文主要记录一下单元测试和集成测试。

PS:本文只介绍简单的测试方法,抛砖引玉,更深入的使用可以参考官方文档,其中写得很清楚。

.Net 中的测试

.Net 的测试项目,主要有几种模板

  • MSTest
  • NUnit
  • xUnit

本文选择 xUnit 作为测试项目模板。

单元测试

从测试所涉及的层次上,分为单元测试、集成测试和系统测试。单元测试是指验证代码段(如方法或函数)功能的测试,通常由开发人员编写相应的测试方法,以验证代码执行后与预期结果是否一致;集成测试用于验证具有依赖关系的多个模块或组件是否能够正常工作;系统测试是对整个系统进行全面测试,以确认系统正常运行并符合需求。

  • Arrange:为测试进行准备操作,如设置测试数据、变量和环境等。
  • Act:执行要测试的方法,如调用要测试的函数和方法。
  • Assert:断言测试结果,验证被测试方法的输出是否与预期的结果一致。

最简单的例子

Controller 代码

[ApiController]
public class DemoController : ControllerBase {
  [HttpGet("[action]")]
  public ApiResponse Test() {
    return ApiResponse.Ok("version=2.0");
  }
}

单元测试代码

public class DemoTests {
  private readonly DemoController _demoController;

  public DemoTests() {
    _demoController = new DemoController();
    _demoController.ControllerContext = new ControllerContext {
      HttpContext = new DefaultHttpContext()
    };
  }

  [Fact]
  public void Test_Test() {
    var resp = _demoController.Test();
    Assert.Equal("version=2.0", resp.Message);
  }
}

带参数的 controller

实际开发中,Controller 会使用依赖注入,有很多参数

比如这个 controller ,用到了 EFCore 的 DbContext

public class StudentController : ControllerBase {
  private readonly AppDbContext _dbCtx;

  public StudentController(AppDbContext dbCtx) {
    _dbCtx = dbCtx;
  }
  /// <summary>
  /// 学生分数等级
  /// </summary>
  [HttpGet("[action]")]
  public async Task<List<StudentGrades>> StudentScoreGrades() {
    return await _dbCtx.StudentGrades.ToListAsync();
  }
}

这时候在单元测试里,就得用 mock 对象框架 来实现依赖模拟

这里用的是 Moq 这个库,可以直接 nuget 安装

public class StudentTests {
  private readonly StudentController _studentController;

  public StudentTests() {
    var mockOptions = new Mock<DbContextOptions<AppDbContext>>();
    var mockDbContext = new Mock<AppDbContext>(mockOptions.Object);
    _studentController = new StudentController(mockDbContext.Object) {
      ControllerContext = new ControllerContext {
        HttpContext = new DefaultHttpContext()
      }
    };
  }

  [Fact]
  public async Task Test_StudentScoreGrades() {
    var resp = await _studentController.StudentScoreGrades();
    Assert.True(resp.Count > 0);
  }
}

PS:实际使用的时候,这个 mock 还是挺麻烦的,所以这些接口还是用后面的集成测试更好。

集成测试

集成测试能够确保应用程序的组件正常工作,包括应用程序支持的基础结构,如数据库和文件系统等。ASP.NET Core提供了用于集成测试的组件,其中包含了用于测试的WebHost和内存测试服务器TestServer。与单元测试不同,这里所有的依赖都是模拟出来的,在集成测试中,应使用与生产环境中一样的真实组件,如数据库和第三方库等。

简单说,单元测试是把所有组件都模拟一遍,集成测试是在真实的系统上进行测试,比如 AspNetCore 开发的接口,集成测试直接使用 HTTP 请求,获取接口数据,然后检查这些返回数据是否符合条件。

开始前需要先安装依赖

dotnet add Microsoft.AspNetCore.Mvc.Testing

公开被测试项目的 Program/Startup 类

集成测试使用 WebApplicationFactory 来启动 AspNetCore 应用

所以需要在被测试的应用里做一点小修改,以便让测试项目可以访问到它的 Program

本文使用的被测试项目是基于 .Net6 的,修改它的 Program.cs ,添加以下代码

public partial class Program { }

使其 Program 类变成共有,让测试项目能够访问到。

官网文档上说还可以修改 .csproj ,添加配置

<ItemGroup>
  <InternalsVisibleTo Include="MyTestProject" />
</ItemGroup>

但我试了好像没有效果,所以还是用第一种方法比较方便。

PS:如果是 .Net6 之前的项目,就把 Startup 类改成 public

例子

以刚才的 Student 接口为例

用 HTTP 请求这几个接口,然后判断返回的响应头里是否符合条件。

public class StudentTests : IClassFixture<WebApplicationFactory<Program>> {
  private readonly WebApplicationFactory<Program> _factory;

  public StudentTests(WebApplicationFactory<Program> factory) {
    _factory = factory;
  }

  [Theory]
  [InlineData("/api/v2/Student/StudentScoreGrades")]
  [InlineData("/api/v2/Student/Height")]
  [InlineData("/api/v2/Student/Weight")]
  public async Task Get_EndpointsReturnSuccessAndCorrectContentType(string url) {
    var client = _factory.CreateClient();
    var response = await client.GetAsync(url);
    response.EnsureSuccessStatusCode();
    Assert.Equal("application/json; charset=utf-8; ver=2", response.Content.Headers.ContentType?.ToString());
  }
}

更多示例

本文只介绍了 WebApi 的集成测试,实际开发可能还会对 MVC、Blazor 等项目进行测试

官方提供了一个实例项目: https://github.com/dotnet/AspNetCore.Docs.Samples/tree/main/test/integration-tests/IntegrationTestsSample

里面有很多集成测试的例子,可以参考一下。

运行测试

第一次测试需要先 Build 测试项目

本文使用的 IDE 是 Rider(VS 的话也是大同小异),其中提供了可视化的测试界面

之后写完新的测试直接点击旁边的绿色三角形,就可以单独运行这个新的测试。

参考资料

与Asp-Net-Core学习笔记:单元测试和集成测试相似的内容:

Asp-Net-Core学习笔记:单元测试和集成测试

## 前言 我在使用 AspNetCore 的这段时间内,看了很多开源项目和博客,发现各种 .Net 体系的新技术很多人都有关注和使用,但却很少有人关注测试。 测试是软件生命周期中的一个非常重要的阶段,对于保证软件的可靠性具有极其重要的意义。在应用程序的开发过程中,为了确保它的功能与预期一致,必须对

Asp-Net-Core学习笔记:gRPC快速入门

## 前言 此前,我在做跨语言调用时,用的是 Facebook 的 Thrift,挺轻量的,还不错。 >Thrift是一种接口描述语言和二进制通讯协议,它被用来定义和创建跨语言的服务。它被当作一个远程过程调用(RPC)框架来使用,是由Facebook为“大规模跨语言服务开发”而开发的。它通过一个代码

.NET周刊【7月第1期 2024-07-07】

国内文章 学习.NET 8 MiniApis入门 https://www.cnblogs.com/hejiale010426/p/18280441 MiniApis是ASP.NET Core中的轻量级框架,用最少的代码和配置创建HTTP API。其特点包括简洁明了、性能卓越、灵活多变、易于学习使用,

ASP.NET Core中创建中间件的几种方式

前言 今天我们一起来盘点一下在ASP.NET Core应用程序中添加和创建中间件常见的四种方式。 中间件介绍 ASP.NET Core中间件(Middleware)是用于处理HTTP请求和响应的组件,它们被安排在请求处理管道中,并按顺序执行。中间件的设计是为了使其在请求处理管道中能够以灵活和可扩展的

推荐十个优秀的ASP.NET Core第三方中间件,你用过几个?

ASP.NET Core 作为一个强大的、跨平台的、高性能的开源框架,为开发者提供了丰富的功能和灵活的扩展性。其中,中间件(Middleware)是 ASP.NET Core 架构中的核心组件之一,它负责处理 HTTP 请求和响应的管道,允许开发者在请求和响应之间插入自定义逻辑。随着 ASP.NET

Asp-Net-Core开发笔记:使用原生的接口限流功能

前言 之前介绍过使用 AspNetCoreRateLimit 组件来实现接口限流 从 .Net7 开始,AspNetCore 开始内置限流组件,当时我们的项目还在 .Net6 所以只能用第三方的 现在都升级到 .Net8 了,当然是得来试试这个原生组件 体验后:配置使用都比较简单,不过功能也没有 A

ASP.NET Core如何禁用模型验证(或者从模型状态中移除某些属性)?

这是一篇4年前的文章:【经验分享】在ASP.NET Core中,如果禁用某个请求的模型验证? 事隔多年,又有网友问到这个问题。我就来重新整理一下,顺便扩展一下之前的解决办法。 这是一个来自网友【David】的提问。在 AppBoxCore 项目的新增用户页面,新增一个上传按钮:

Asp-Net-Core开发笔记:进一步实现非侵入性审计日志功能

前言 上次说了利用 AOP 思想实现了审计日志功能,不过有同学反馈还是无法实现完全无侵入,于是我又重构了一版新的。 回顾一下:Asp-Net-Core开发笔记:实现动态审计日志功能 现在已经可以实现对业务代码完全无侵入的审计日志了,在需要审计的接口上加上 [AuditLog] 特性,就可以记录这个接

Asp .Net Core 系列:国际化多语言配置

目录概述术语本地化器IStringLocalizer在服务类中使用本地化IStringLocalizerFactoryIHtmlLocalizerIViewLocalizer资源文件区域性回退配置 CultureProvider内置的 RequestCultureProvider实现自定义 Requ

安全机密管理:Asp.Net Core中的本地敏感数据保护技巧

前言 在我们开发过程中基本上不可或缺的用到一些敏感机密数据,比如SQL服务器的连接串或者是OAuth2的Secret等,这些敏感数据在代码中是不太安全的,我们不应该在源代码中存储密码和其他的敏感数据,一种推荐的方式是通过Asp.Net Core的机密管理器。 机密管理器 在 ASP.NET Core