Asp.Net Core 單元測試正確姿勢

来源:https://www.cnblogs.com/xboo/archive/2019/11/08/11811838.html

背景 ASP.NET Core 支持依賴關係註入 (DI) 軟體設計模式,並且預設註入了很多服務,具體可以參考 "官方文檔" , 相信只要使用過依賴註入框架的同學,都會對此有不同深入的理解,在此無需贅言。 然而,在引入 IOC 框架之後,對於之前常規的對於類的依賴(new Class)變成通過構造函 ...


背景

ASP.NET Core 支持依賴關係註入 (DI) 軟體設計模式,並且預設註入了很多服務,具體可以參考 官方文檔, 相信只要使用過依賴註入框架的同學,都會對此有不同深入的理解,在此無需贅言。

然而,在引入 IOC 框架之後,對於之前常規的對於類的依賴(new Class)變成通過構造函數對於介面的依賴(ASP.NET CORE 預設註入方式),這本身更加符合依賴倒置原則,但是對於單元測試來說確會帶來另一個問題:由於層層依賴,導致在某個類的方法進行測試的時候,需要構造一大堆該類依賴的介面的實現,非常麻煩。

這個時候,我們腦子裡會下意識想一個問題:為什麼常用的 .Net 單元測試框架不支持依賴註入?

於是筆者帶著這個問題在查閱了一些關於在單元測試中支持依賴註入的討論Github Issue,以及其他的相關文檔,突然明白一個之前一直忽視但實際卻非常重要的問題:

在對於一個方法的單元測試中,我們應該關註的是這個方法內部的邏輯測試,而這個方法內部對於外部的依賴,則不在這個單元測試關註的範圍內

換言之,單元測試永遠都只關註需要測試的方法內部的邏輯實現,至於外部依賴方法的測試,則應該放在另一個專門針對這個方法的單元測試用例中。弄清楚這個問題,我們才能更加理解另一個單元測試不可缺少的框架——Mock框架,在我們寫的測試中,應該忽略外部依賴具體的實現,而是通過模擬該介面方法來顯示的指定返回值,從而降低該返回值對於當前單元測試結果的影響,而 Mock 框架(例如最常用的Moq),剛好可以滿足我們對於介面的模擬需求。

相信有同學跟我有同樣的疑惑,並且當我嘗試在 ASP.NET CORE 單元測試中的一切外部依賴通過 Mock 的方式進行編寫的時候,遇到了一些問題,才有了本篇文章,希望對有同樣疑惑的同學有所幫助。

如何對 ASP.NET CORE 常用服務進行單元測試和 Mock

本文以 Xunit 以及 Moq 4.x 為例,展示在常用的 ASP.NET CORE 中會遇到的各種測試情況。

業務服務類示例如下:

public class UserService : IUserService
{
    private ILogger _logger;
    private IOptions<RabbitMqOptions> _options;
    private IConfiguration _configuration;

    public UserService(ILogger<UserService> logger, IConfiguration configuration, IOptions<RabbitMqOptions> options)
    {
        this._logger = logger;
        this._options = options;
        this._configuration = configuration;
    }

    public void Login()
    {
        var hostName = this._configuration["RabbitMqOptions:Host"];
        var options = this._options.Value;
        //do something
        this._logger.Log(LogLevel.Information, new EventId(), "Login", null, (m, e) => m);
    }

    public string GetUserInfo()
    {
        return $"hello world!";
    }
}

public class RabbitMqOptions
{
    public string Host { get; set; }

    public string UserName { get; set; }

    public string Password { get; set; }
}

1. IConfiguration 獲取配置Mock

獲取單個配置:

var mockConfiguration = new Mock<IConfiguration>();
mockConfiguration.SetupGet(_ => _["RabbitMqOptions:Host"]).Returns("127.0.0.1");

Mock IOptions<T>

var mockRabbitmqOptions = new Mock<IOptions<RabbitMqOptions>>();
mockRabbitmqOptions.Setup(_ => _.Value).Returns(new RabbitMqOptions
{
    Host = "127.0.0.1",
    UserName = "root",
    Password = "123456"
});

2. Mock 方法返回參數

[Fact]
public void mock_return_test()
{
    var mockInfo = "mock hello world";
    var mockUserService = new Mock<IUserService>();
    mockUserService.Setup(_ => _.GetUserInfo()).Returns(mockInfo);

    var userInfo= mockUserService.Object.GetUserInfo();
    Assert.Equal(mockInfo, userInfo);
}

3. ILogger 日誌組件 Mock

通過 logger.Verify 驗證日誌至少輸出一次:

[Fact]
public void log_in_login_test()
{
    var logger = new Mock<ILogger<UserService>>();
    var userService = new UserService(logger.Object);
    userService.Login();

    logger.Verify(_ => _.Log(It.IsAny<LogLevel>(),
                                It.IsAny<EventId>(),
                                It.IsAny<string>(),
                                It.IsAny<Exception>(), 
                                It.IsAny<Func<string, Exception, string>>()),
                    Times.Once);
}

4. ServiceCollection 單元測試

public static void AddUserService(this IServiceCollection services, IConfiguration configuration)
{
    services.TryAddSingleton<IUserService, UserService>();
}
 [Fact]
public void add_user_service_test() 
{
    var mockConfiguration = new Mock<IConfiguration>();

    var serviceConllection = new ServiceCollection();
    serviceConllection.AddUserService(mockConfiguration.Object);

    var provider = serviceConllection.BuildServiceProvider();
    var userService = provider.GetRequiredService<IUserService>();
    Assert.NotNull(userService);
}

5. Middleware 單元測試

Middleware單元測試重點在於對委托 _next 的模擬

示例 HealthMiddleware:

public class HealthMiddleware
{
    private readonly RequestDelegate _next;
    private readonly ILogger _logger;
    private readonly string _healthPath = "/health";

    public HealthMiddleware(RequestDelegate next, ILogger<HealthMiddleware> logger, IConfiguration configuration)
    {
        this._next = next;
        this._logger = logger;

        var healthPath = configuration["Consul:HealthPath"];
        if (!string.IsNullOrEmpty(healthPath))
        {
            this._healthPath = healthPath;
        }
    }

    public async Task Invoke(HttpContext httpContext)
    {
        if (httpContext.Request.Path == this._healthPath)
        {
            httpContext.Response.StatusCode = (int)HttpStatusCode.OK;
            await httpContext.Response.WriteAsync("I'm OK!");
        }
        else
            await _next(httpContext);
    }
}

單元測試:

public class HealthMiddlewareTest
{
    private readonly Mock<ILogger<HealthMiddleware>> _mockLogger;
    private readonly Mock<IConfiguration> _mockConfiguration;
    private readonly string _healthPath = "/health";
    private readonly HttpContext _httpContext;
    private readonly Mock<RequestDelegate> _mockNext; //middleware next

    public HealthMiddlewareTest()
    {
        this._mockConfiguration = new Mock<IConfiguration>();
        this._mockConfiguration.SetupGet(c => c["Consul:HealthPath"]).Returns(_healthPath);

        this._mockLogger = new Mock<ILogger<HealthMiddleware>>();
        this._mockLogger.Setup(_ => _.Log<object>(It.IsAny<LogLevel>(), It.IsAny<EventId>(),
            It.IsAny<object>(), It.IsAny<Exception>(), It.IsAny<Func<object, Exception, string>>()))
            .Callback<LogLevel, EventId, object, Exception, Func<object, Exception, string>>(
            (logLevel, eventId, message, ex, fun) =>
            {
                Console.WriteLine($"{logLevel}\n{eventId}\n{message}\n{message}");
            });

        this._httpContext = new DefaultHttpContext();
        this._httpContext.Response.Body = new MemoryStream();
        this._httpContext.Request.Path = this._healthPath;

        this._mockNext = new Mock<RequestDelegate>();//next 委托 Mock
        this._mockNext.Setup(_ => _(It.IsAny<HttpContext>())).Returns(async () =>
        {
            await this._httpContext.Response.WriteAsync("Hello World!"); //模擬http請求最終輸出
        });
    }

    [Fact]
    public async Task health_request_test()
    {
        var middleWare = new HealthMiddleware(this._mockNext.Object, this._mockLogger.Object,
            this._mockConfiguration.Object);

        await middleWare.Invoke(this._httpContext);//執行middleware

        this._httpContext.Response.Body.Seek(0, SeekOrigin.Begin); //獲取監控檢查請求獲取到的response內容
        var reader = new StreamReader(this._httpContext.Response.Body);
        var returnStrs = await reader.ReadToEndAsync();

        Assert.Equal("I'm OK!", returnStrs);//斷言健康檢查api是否中間件攔截輸出 "I'm OK!"
    }

    [Fact]
    public async Task general_request_test()
    {
        this._mockConfiguration.SetupGet(c => c["Consul:HealthPath"]).Returns("/api/values");

        var middleWare = new HealthMiddleware(this._mockNext.Object, this._mockLogger.Object,
            this._mockConfiguration.Object);

        await middleWare.Invoke(this._httpContext);
        this._httpContext.Response.Body.Seek(0, SeekOrigin.Begin);
        var reader = new StreamReader(this._httpContext.Response.Body);
        var returnStrs = await reader.ReadToEndAsync();

        Assert.Equal("Hello World!", returnStrs); //斷言非健康檢查請求api返回模擬 Hello World!
    }
}

6. Mock HttpClient

HttpClient 中的 GetAsync、PostAsync 等方法底層實際都是通過HttpMessageHandler 調用 SendAsync 完成(見源碼),所以在 Mock HttpClient 時,實際需要 Mock 的是 HttpMessageHandler 的 SendAsync 方法:

[Fact]
public async Task get_async_test()
{
    var responseContent = "Hello world!";
    var mockHttpClient = this.BuildMockHttpClient("https://github.com/", responseContent);
    var response = await mockHttpClient.GetStringAsync("/api/values");
    Assert.Equal(responseContent, response);
}

private HttpClient BuildMockHttpClient(string baseUrl, string responseStr)
{
    var mockHttpMessageHandler = new Mock<HttpMessageHandler>();
    mockHttpMessageHandler.Protected()
        .Setup<Task<HttpResponseMessage>>("SendAsync",
        ItExpr.IsAny<HttpRequestMessage>(),
        ItExpr.IsAny<CancellationToken>()).ReturnsAsync((HttpRequestMessage request, CancellationToken token) =>
        {
            HttpResponseMessage response = new HttpResponseMessage();
            response.Content = new StringContent(responseStr, Encoding.UTF8);
            return response;
        });
    var mockHttpClient = new HttpClient(mockHttpMessageHandler.Object);
    mockHttpClient.BaseAddress = new Uri(baseUrl);
    return mockHttpClient;
}

結語

幾個問題:

  1. CI/CD 流程中應該包含單元測試

    例如在編寫 Repository 層進行單元測試時,經常有同學會編寫依賴於資料庫數據的單元測試,這樣並不利於隨時隨地的進行單元測試檢查,如果將該流程放在CI/CD中,在代碼的發佈過程中通過單元測試可以檢查代碼邏輯的正確性,同時依賴於資料庫的單元測試將不會通過(通常情況下,生產環境和開發環境隔離),變相迫使開發小伙伴通過 mock 方式模擬資料庫返回結果。這個原則同樣適用於不能依賴三方API編寫單元測試。

  2. 單元測試覆蓋率

    通常很多開發 Leader 都會要求開發團隊編寫單元測試,但是很少檢查單元測試的質量,即單元測試最重要的指標——單元測試代碼覆蓋率,如果不註重覆蓋率的提升,那麼很有可能會導致開發成員為了單元測試而寫單元測試,預期就會與實際情況相差甚遠。保證單元測試代碼覆蓋率,將會大大降低代碼變更帶來的 Bug 率,從而節省整體開發成本。

  3. 新人問題:為何要寫單元測試?

    對於初次開始編寫單元測試的開發人員,腦中經常會對此表示懷疑:我為什麼要去驗證一堆我自己寫的正確的邏輯?實際這個問題包含了區分一個一般開發人員和優秀開發人員很重要的一個條件:他是否會反向思考當前邏輯的正確性。有了這種思維,看待問題才會從多個角度入手分析,對問題的本質掌握更加全面。不要懷疑,堅持寫單元測試,因為這本身也是對反向思維的一種鍛煉,以筆者的經驗,只有當編寫過一段時間之後,才會真正認識單元測試的魅力,並且開始非常習慣的在寫一段邏輯之後,順手寫了對於它的單元測試。即使筆者也算很早就開始寫單元測試了,但直到寫這篇文章,仍然不斷在加深對單元測試的認識。

其實編程也如人生三境:看山是山;看山不是山;看山還是山;階段不同,認知不同,唯有堅持不懈,持之以恆,才能不斷進步,提升境界,這不就是人追求的根本麽!


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

更多相關文章
  • 保留兩位小數點 由於簡單的原因大家直接看代碼塊。 執行結果如下: ...
  • using System; namespace class1 { class program { static void Main(string[] args) { Console.Write("請輸入a="); double a = double.Parse(Console.ReadLine()) ...
  • 1.查詢生命周期 在進入正題時候,我們先來瞭解EF Core查詢的生命周期。 1.1LINQ查詢會由Entity Framework Core處理並生成給資料庫提供程式可處理的表示形式(說白了就是生成給資料庫可識別數據形式)。 ●發送的查詢結果(查詢表示形式)會被緩存,以便每次執行查詢時無需進行1. ...
  • using System; namespace class1 { class program { static void Main(string[] args) { //值傳遞引用,實際參數不會變化 Console.Write("請輸入a="); double a = double.Parse(Co ...
  • 前言 上一篇我們主要介紹了並行編程相關的知識,這一節我們繼續介紹關於任務相關的知識。為了更好的控制並行操作,我們可以使用System.Threading.Tasks中的Task類。我們首先來瞭解是什麼是任務——任務表示將要完成的一個或某個工作單元,這個工作單元可以在單獨線程中運行,也可以使用同步方式 ...
一周排行
  • static void Main(string[] args) { string url = "https://go.microsoft.com/fwlink/?linkid=2108895&amp;clcid=0x409"; DownloadBigFile(new Uri(url), "ssms.... ...
  • 1. 使用ASP.NET Core 3.x 構建 RESTful API - 1.準備工作 什麼是REST 什麼是REST REST一詞最早是在2000年,由Roy Fielding在他的博士論文《Architectural Styles and the Design of Network-base ...
  • wpf 兩個自定義控制項 一個是IP控制項,一個滑動條。先看下效果圖 IPControl 1、實際工作中有時需要設置IP信息,就想著做一個ip控制項。效果沒有window自帶的好,需要通過tab切換。但也能滿足使用。廢話不多說直接上代碼 IPControl.xaml IPControl.xaml.cs 2 ...
  • 近期和幾位做嵌入式開發的朋友閑聊過程中,一位朋友抱怨到:這C#太難用了,我想在N個窗體(或者是N個用戶組件之間)傳遞值都搞不定,非得要定義一個全局變數來存儲,然後用定時器來刷新值,太Low了。我急切的回答道:這很簡單,不就是委托的事嘛。那你來一個示例啊:朋友道。此為這篇博客的起因,所以此篇博客對於有 ...
  • 在面對對象編程中,類的三大特性分別為封裝,繼承,多態。其中多態的具體實現,依賴於三個方法,也就是虛方法,抽象類和介面。 多態的具體作用是什麼呢?或者說多態的存在有什麼意義呢?多態的存在有效的降低了程式的耦合度,在使用的時候,不僅可以表現大家都有的共性,還能在必要的時候突出一些特殊的的個性。 那麼如何 ...
  • [toc] 前言 在之前已經提到過,公用類庫Util已經開源,目的一是為了簡化開發的工作量,畢竟有些常規的功能類庫重覆率還是挺高的,二是為了一起探討學習軟體開發,用的人越多問題也就會越多,解決的問題越多功能也就越完善, 倉庫地址: "April.Util_github" , "April.Util_ ...
  • 【ASP.NET Core學習】在ASP.NET Core 種使用Entity Framework Core介紹,包括如何添加Entity Framwork Core,創建模型和遷移到資料庫,查詢數據,保存數據,使用事務,處理併發衝突 ...
  • 環境:MacOS 10.13 MAMAP Prophp 7.0.33 + xdebugVisual Studio Code前言我所理解的 POP Chain:利用魔術方法並巧妙構造特殊屬性調用一系列函數或類方法以執行某種敏感操作的調用堆棧反序列化常用魔法函數前言我所理解的 POP Chain:利用魔 ...
  • 當創建隊列jobs、監聽器或訂閱伺服器以推送到隊列中時,您可能會開始認為,一旦分派,隊列工作器決定如何處理您的邏輯就完全由您自己決定了。 嗯……並不是說你不能從作業內部與隊列工作器交互,但是通常情況下,哪怕你做了,也是沒必要的。 這個神奇的騷操作的出現是因為“InteractsWithQueue”這 ...
  • 在說正題之前先解釋一下交換機模式是個籠統的稱呼,它不是一個單獨的模式(包括了訂閱模式,路由模式和主題模式),交換機模式是一個比較常用的模式,主要是為了實現數據的同步。 首先,說一下訂閱模式,就和字面上的意思差不多主要就是一個生產者,多個消費者,同一個消息被多個消費者獲取,先看一下官網的圖示 整體執行 ...
x