精通中間件測試:Asp.Net Core實戰指南,提升應用穩定性和可靠性

来源:https://www.cnblogs.com/ruipeng/p/18149582
-Advertisement-
Play Games

引言 在上一章節我們實戰了在Asp.Net Core中的項目實戰,這一章節講解一下如何測試Asp.Net Core的中間件。 TestServer 還記得我們在集成測試中提供的TestServer嗎? TestServer 是由 Microsoft.AspNetCore.TestHost 包提供的。 ...


引言

在上一章節我們實戰了在Asp.Net Core中的項目實戰,這一章節講解一下如何測試Asp.Net Core的中間件。

TestServer

還記得我們在集成測試中提供的TestServer嗎?
TestServer 是由 Microsoft.AspNetCore.TestHost 包提供的。包含了用於在測試環境中模擬 ASP.NET Core 應用程式的類和方法。通過使用 TestServer,開發人員可以在測試中模擬整個應用程式的運行環境,包括中間件的執行,從而進行集成測試和端到端測試。

中間件可以使用 TestServer 單獨測試。 這樣便可以:

  • 實例化只包含需要測試的組件的應用管道。
  • 發送自定義請求以驗證中間件行為。

優點:

  • 請求會發送到記憶體中,而不是通過網路進行序列化。
  • 這樣可以避免產生額外的問題,例如埠管理和 HTTPS 證書。
  • 中間件中的異常可以直接流回調用測試。
  • 可以直接在測試中自定義伺服器數據結構,如 HttpContext

實戰

VS 新建測試項目dotNetParadise.MiddlerWareTest

Nuget 安裝Microsoft.AspNetCore.TestHost

PM> NuGet\Install-Package Microsoft.AspNetCore.TestHost -Version 8.0.4

既然我們是要測試中間件 那首先得先在我們的Sample.Api中創建一個中間件

定義MyMiddleware中間件

public class MyMiddleware(RequestDelegate next)
{
    public async Task InvokeAsync(HttpContext context)
    {
        // 在請求處理前執行的邏輯
        context.Response.ContentType = "text/plain";
        context.Response.Headers.TryAdd("X-Custom-Header", "CustomValue");
        await context.Response.WriteAsync("Test My Middleware");
        // 調用下一個中間件
        await next(context);

        // 在請求處理後執行的邏輯
        await context.Response.WriteAsync("Middleware Test Completed");
    }
}

定義測試類

        // Arrange
        using var host = await new HostBuilder()
            .ConfigureWebHost(webBuilder =>
            {
                webBuilder
                    .UseTestServer()
                    .ConfigureServices(services =>
                    {
                        // 在這裡可以註入服務
                    })
                    .Configure(app =>
                    {
                        app.UseMiddleware<MyMiddleware>();
                    });
            })
            .StartAsync();

        // Act
        var response = await host.GetTestClient().GetAsync("/");

        // Assert
        response.EnsureSuccessStatusCode(); // 確保請求成功
        var responseContent = await response.Content.ReadAsStringAsync();
        Assert.Contains("Test My Middleware", responseContent);
        Assert.Contains("Middleware Test Completed", responseContent);

Run Test

image

使用 HttpContext 發送請求

可以使用 TestServer 來設置測試環境,並創建一個模擬的 HttpContext對象來代表一個請求

    [Fact]
    public async Task TestMiddleware_ExpectedResponse()
    {
        using var host = await new HostBuilder()
            .ConfigureWebHost(webBuilder =>
            {
                webBuilder
                    .UseTestServer()
                    .ConfigureServices(services =>
                    {
                    })
                    .Configure(app =>
                    {
                        app.UseMiddleware<MyMiddleware>();
                    });
            })
            .StartAsync();

        var server = host.GetTestServer();
        server.BaseAddress = new Uri("http://localhost");

        var context = await server.SendAsync(c =>
        {
            c.Request.Method = HttpMethods.Get;
            c.Request.Path = "/";
            c.Request.Host = new HostString("localhost");
            c.Request.Scheme = "http";
        });
        //act
        Assert.True(context.RequestAborted.CanBeCanceled);
        Assert.Equal(HttpProtocol.Http11, context.Request.Protocol);
        // 驗證響應
        Assert.Equal(StatusCodes.Status200OK, context.Response.StatusCode);
        var customHeader = context.Response.Headers["X-Custom-Header"].ToString();
        Assert.Equal("CustomValue", customHeader);
    }

使用 SendAsync 的好處包括:
通過設置 HttpContext 的任何屬性,從而精確控制請求的各個方面。相比於使用 HttpClientSendAsync 通常更快,因為它繞過了網路層。
集成測試:這是測試整個請求處理管道(包括所有中間件)的好方法。
然而,它也有一些限制:

局限性
SendAsync 主要用於集成測試,而不是單元測試。它測試的是整個請求處理流程,而不是單個組件。
模擬限制:雖然你可以設置 HttpContext 的許多屬性來模擬請求,但某些方面(如用戶認證狀態或外部依賴項)可能難以完全模擬。

添加請求路由

這個比較好理解,就是在TestServer中添加路由的功能和Asp.Net Core中添加路由基本一致

    [Fact]
    public async Task TestWithEndpoint_ExpectedResponse()
    {
        using var host = await new HostBuilder()
            .ConfigureWebHost(webBuilder =>
            {
                webBuilder
                    .UseTestServer()
                    .ConfigureServices(services =>
                    {
                        services.AddRouting();
                    })
                    .Configure(app =>
                    {
                        app.UseRouting();
                        //app.UseMiddleware<MyMiddleware>();
                        app.UseEndpoints(endpoints =>
                        {
                            endpoints.MapGet("/hello", () =>
                                TypedResults.Text("Hello Tests"));
                        });
                    });
            })
            .StartAsync();

        var client = host.GetTestClient();

        var response = await client.GetAsync("/hello");

        Assert.True(response.IsSuccessStatusCode);
        var responseBody = await response.Content.ReadAsStringAsync();
        Assert.Equal("Hello Tests", responseBody);

    }

在測試場景中,添加請求路由的好處主要體現在以下幾個方面:

  • 模擬真實環境:
    通過添加請求路由,你可以模擬出與真實生產環境相似的請求處理流程。這使得測試更加接近實際使用情況,從而提高了測試的可靠性和有效性。

  • 控制測試的粒度:
    你可以針對特定的路由進行精確測試,確保每個路由都能正確響應並返回預期的結果。這有助於發現潛在的路由錯誤或邏輯問題,提高了測試的精度。

  • 隔離測試:
    在測試過程中,你可以通過配置路由來隔離特定的功能或組件,從而避免其他部分的干擾。這種隔離測試有助於更準確地定位問題,提高了測試的效率。

  • 模擬異常場景:
    通過配置路由,你可以模擬各種異常場景,如路由不存在、參數錯誤等。這有助於測試應用程式在異常情況下的響應和處理能力,提高了應用程式的健壯性。

  • 自動化測試:
    在自動化測試框架中,添加請求路由可以使得測試用例更加易於編寫和執行。通過發送請求到特定的路由並驗證響應,你可以自動化地檢查應用程式的功能和性能。

最後

本章我們探討瞭如何在Asp.Net Core項目中測試中間件的方法和技巧。通過使用TestServerHttpContext發送請求,我們可以模擬整個應用程式的運行環境,從而進行集成測試和端到端測試。同時,我們也介紹瞭如何添加請求路由來模擬不同的場景,並對中間件的行為進行驗證。

通過測試中間件,我們可以確保其在處理請求時的行為符合預期,提高應用程式的穩定性和可靠性。測試不僅可以幫助發現潛在的問題,還可以在開發過程中及早發現和解決 bug,提高代碼質量和開發效率。

您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 前言 整理這個官方翻譯的系列,原因是網上大部分的 tomcat 版本比較舊,此版本為 v11 最新的版本。 開源項目 從零手寫實現 tomcat minicat 別稱【嗅虎】心有猛虎,輕嗅薔薇。 系列文章 web server apache tomcat11-01-官方文檔入門介紹 web serv ...
  • Spring Cache 是 Spring 提供的的緩存解決方案,它並非是一個具體的緩存實現,而是和 JSR107 類似的一套緩存規範,基於註解並與 Spring 的無縫集成。本文主要介紹其基本概念及簡單使用。 1、簡介 1.1、Spring Cache 概述 Spring Cache 是 Spri ...
  • AI大模型的相關的一些基礎知識,一些背景和基礎知識。 多模型強應用AI 2.0時代應用開發者的機會。 0 大綱 AI產業的拆解和常見名詞 應用級開發者,在目前這樣一個大背景下的一個職業上面的一些機會 實戰部分的,做這個agent,即所謂智能體的這麼一個虛擬項目,項目需求分析、技術選型等 1 大語言模 ...
  • 在上文《Keycloak中授權的實現》中,以一個實際案例介紹了Keycloak中用戶授權的設置方法。現在回顧一下這個案例: 服務供應商(Service Provider)發佈/WeatherForecast API供外部訪問 在企業應用(Client)里有三個用戶:super,daxnet,nobo ...
  • 今天電腦重啟之後,發現 visual studio 2022 的智能提示與報錯經常性不好用,不光不能在正常時候提示代碼錯誤信息,甚至在編譯過後也不提示錯誤。反覆重啟,剛開始正常,隔一會兒就會提示什麼什麼功能不可用,點開打開詳情,提示:StreamJsonRpc.ConnectionLostExcep ...
  • 通常情況下,PDF文件是不可編輯的,但PDF表單提供了一些可編輯區域,允許用戶填寫和提交信息。PDF表單通常用於收集信息、反饋或進行線上申請,是許多行業中數據收集和交換的重要工具。 PDF表單可以包含各種類型的輸入控制項,如文本框、覆選框、下拉菜單、單選按鈕等。本文將介紹如何使用C# 和一個免費.NE ...
  • 在C#編程世界中,語法的精妙之處往往體現在那些看似微小卻極具影響力的符號與結構之中。其中,“_ =” 這一組合突然出現還真不知道什麼意思。本文將深入剖析“_ =” 的含義、工作原理及其在實際編程中的廣泛應用,揭示其作為C#語法奇兵的重要角色。 一、下劃線 _:神秘的棄元符號 下劃線 _ 在C#中並非 ...
  • 在發現結果為真的WHEN子句時,CASE表達式的真假值判斷會終止,剩餘的WHEN子句會被忽略: CASE WHEN col_1 IN ('a', 'b') THEN '第一' WHEN col_1 IN ('a') THEN '第二' ELSE '其他' END 註意: 統一各分支返回的數據類型. ...
一周排行
    -Advertisement-
    Play Games
  • C#.Net的BCL提供了豐富的類型,最基礎的是值類型、引用類型,而他們的共同(隱私)祖先是 System.Object(萬物之源),所以任何類型都可以轉換為Object。 ...
  • 最近有群友咨詢C#如何調用Python?小編嘗試Python.NET過程中遭遇的版本相容性和環境配置難題,小編決定尋找一個更為簡單、穩定且對初學者友好的解決方案。小編搜索一番,除了Python.NET之外,還有其他途徑能夠幫助我們輕鬆地在C#項目調用Python腳本,那就是通過命令行調用,使用 Sy ...
  • .NET中特性+反射 實現數據校驗 在.NET中,我們可以使用特性+反射來實現數據校驗。特性是一種用於為程式中的代碼添加元數據的機制。元數據是與程式中的代碼相關聯的數據,但不直接成為代碼的一部分。通過特性,我們可以為類、方法、屬性等添加額外的信息,這些信息可以在運行時通過反射獲取和使用。 對反射不太 ...
  • Biwen.Settings 是一個簡易的配置項管理模塊,主要的作用就是可以校驗並持久化配置項,比如將自己的配置存儲到資料庫中,JSON文件中等 使用上也是很簡單,只需要在服務中註入配置, 比如我們有一個GithubSetting的配置項,我們只需要定義好對象然後註入到Service中即可: [De ...
  • EDP是一套集組織架構,許可權框架【功能許可權,操作許可權,數據訪問許可權,WebApi許可權】,自動化日誌,動態Interface,WebApi管理等基礎功能於一體的,基於.net的企業應用開發框架。通過友好的編碼方式實現數據行、列許可權的管控。 ...
  • 前言 VB.NET,全名Visual Basic .NET,是Microsoft .NET框架的一部分,是一種面向對象的編程語言。它繼承了Visual Basic的易用性,同時增加了對面向對象編程的支持。VB.NET提供了大量的內置函數,使得開發者可以更容易地處理字元串、數學計算、文件和目錄訪問等任 ...
  • 自定義可移動點二維坐標軸控制項 目錄 路由參數 坐標軸控制項定義 Demo 路由參數 X_YResultCollection為當前X軸對應Y軸值存儲字典 public class ResultCollectionChangedEventArgs(RoutedEvent routedEvent, obje ...
  • 自定義分頁控制項 tip: 該控制項的樣式用的是materialDesign庫,需要下載Nuget包 Code Xaml <UserControl x:Class="TestTool.CustomControls.PagingControl" xmlns="http://schemas.microsof ...
  • 最近群里有個小伙伴把Dapper遷移SqlSugar幾個不能解決的問題進行一個彙總,我正好寫一篇文章來講解一下 一、sql where in傳參問題: SELECT * FROM users where id IN @ids 答: SqlSugar中應該是 var sql="SELECT * FRO ...
  • 安裝nuget包 Wesky.Net.OpenTools 1.0.8或以上版本。支持.net framework 4.6以上版本,以及所有.net core以及以上版本引用。 開發一個簡單的Winform界面,用來測試使用。如需該winform的demo,可以在公眾號【Dotnet Dancer】後 ...