Asp.Net Core 輕鬆學-利用xUnit進行主機級別的網路集成測試

来源:https://www.cnblogs.com/viter/archive/2018/12/09/10091816.html
-Advertisement-
Play Games

在開發 Asp.Net Core 應用程式的過程中，我們常常需要對業務代碼編寫單元測試，這種方法既快速又有效，利用單元測試做代碼覆蓋測試，也是非常必要的事情；但是，但我們需要對系統進行集成測試的時候，需要啟動服務主機，利用瀏覽器或者Postman 等網路工具對介面進行集成測試，這就非常的不方便，同時... ...


前言

    在開發 Asp.Net Core 應用程式的過程中，我們常常需要對業務代碼編寫單元測試，這種方法既快速又有效，利用單元測試做代碼覆蓋測試，也是非常必要的事情；但是，但我們需要對系統進行集成測試的時候，需要啟動服務主機，利用瀏覽器或者Postman 等網路工具對介面進行集成測試，這就非常的不方便，同時浪費了大量的時間在重覆啟動應用程式上；今天要介紹就是如何在不啟動應用程式的情況下，對 Asp.Net Core WebApi 項目進行網路集成測試。

1.1 建立項目

1.1 首先我們建立兩個項目，Asp.Net Core WebApi 和 xUnit 單元測試項目，如下

1.2 上圖的單元測試項目 Ron.XUnitTest 必須應用待測試的 WebApi 項目 Ron.TestDemo
1.3 接下來打開 Ron.XUnitTest 項目文件 .csproj，添加包引用

Microsoft.AspNetCore.App
Microsoft.AspNetCore.TestHost

1.4 為什麼要引用這兩個包呢，因為我剛纔創建的 WebApi 項目是引用 Microsoft.AspNetCore.App 的，至於 Microsoft.AspNetCore.TestHost，它是今天的主角，為了使用測試主機，必須對其進行引用，下麵會詳細說明

2. 編寫業務

2.1 創建一個介面，代碼如下

    [Route("api/[controller]")]
    [ApiController]
    public class ValuesController : ControllerBase
    {
        private IConfiguration configuration;
        public ValuesController(IConfiguration configuration)
        {
            this.configuration = configuration;
        }

        [HttpGet("{id}")]
        public ActionResult<int> Get(int id)
        {
            var result= id + this.configuration.GetValue<int>("max");

            return result;
        }
    }

2.1 介面代碼非常簡單，接受一個參數 id，然後和配置文件中獲取的值 max 相加，然後輸出結果給客戶端

3. 編寫測試用例

3.1 為了能夠使用主機集成測試，我們需要使用類

Microsoft.AspNetCore.TestHost.TestServer

3.2 我們來看一下 TestServer 的源碼，代碼較長，你可以直接跳過此段，進入下一節 3.3

 public class TestServer : IServer
    {
        private IWebHost _hostInstance;
        private bool _disposed = false;
        private IHttpApplication<Context> _application;

        public TestServer(): this(new FeatureCollection())
        {
        }

        public TestServer(IFeatureCollection featureCollection)
        {
            Features = featureCollection ?? throw new ArgumentNullException(nameof(featureCollection));
        }

        public TestServer(IWebHostBuilder builder): this(builder, new FeatureCollection())
        {
        }
        
        public TestServer(IWebHostBuilder builder, IFeatureCollection featureCollection): this(featureCollection)
        {
            if (builder == null)
            {
                throw new ArgumentNullException(nameof(builder));
            }

            var host = builder.UseServer(this).Build();
            host.StartAsync().GetAwaiter().GetResult();
            _hostInstance = host;
        }

        public Uri BaseAddress { get; set; } = new Uri("http://localhost/");

        public IWebHost Host
        {
            get
            {
                return _hostInstance
                    ?? throw new InvalidOperationException("The TestServer constructor was not called with a IWebHostBuilder so IWebHost is not available.");
            }
        }

        public IFeatureCollection Features { get; }

        private IHttpApplication<Context> Application
        {
            get => _application ?? throw new InvalidOperationException("The server has not been started or no web application was configured.");
        }

        public HttpMessageHandler CreateHandler()
        {
            var pathBase = BaseAddress == null ? PathString.Empty : PathString.FromUriComponent(BaseAddress);
            return new ClientHandler(pathBase, Application);
        }

        public HttpClient CreateClient()
        {
            return new HttpClient(CreateHandler()) { BaseAddress = BaseAddress };
        }

        public WebSocketClient CreateWebSocketClient()
        {
            var pathBase = BaseAddress == null ? PathString.Empty : PathString.FromUriComponent(BaseAddress);
            return new WebSocketClient(pathBase, Application);
        }

        public RequestBuilder CreateRequest(string path)
        {
            return new RequestBuilder(this, path);
        }

        public async Task<HttpContext> SendAsync(Action<HttpContext> configureContext, CancellationToken cancellationToken = default)
        {
            if (configureContext == null)
            {
                throw new ArgumentNullException(nameof(configureContext));
            }

            var builder = new HttpContextBuilder(Application);
            builder.Configure(context =>
            {
                var request = context.Request;
                request.Scheme = BaseAddress.Scheme;
                request.Host = HostString.FromUriComponent(BaseAddress);
                if (BaseAddress.IsDefaultPort)
                {
                    request.Host = new HostString(request.Host.Host);
                }
                var pathBase = PathString.FromUriComponent(BaseAddress);
                if (pathBase.HasValue && pathBase.Value.EndsWith("/"))
                {
                    pathBase = new PathString(pathBase.Value.Substring(0, pathBase.Value.Length - 1));
                }
                request.PathBase = pathBase;
            });
            builder.Configure(configureContext);
            return await builder.SendAsync(cancellationToken).ConfigureAwait(false);
        }

        public void Dispose()
        {
            if (!_disposed)
            {
                _disposed = true;
                _hostInstance.Dispose();
            }
        }

        Task IServer.StartAsync<TContext>(IHttpApplication<TContext> application, CancellationToken cancellationToken)
        {
            _application = new ApplicationWrapper<Context>((IHttpApplication<Context>)application, () =>
            {
                if (_disposed)
                {
                    throw new ObjectDisposedException(GetType().FullName);
                }
            });

            return Task.CompletedTask;
        }

        Task IServer.StopAsync(CancellationToken cancellationToken)
        {
            return Task.CompletedTask;
        }

        private class ApplicationWrapper<TContext> : IHttpApplication<TContext>
        {
            private readonly IHttpApplication<TContext> _application;
            private readonly Action _preProcessRequestAsync;

            public ApplicationWrapper(IHttpApplication<TContext> application, Action preProcessRequestAsync)
            {
                _application = application;
                _preProcessRequestAsync = preProcessRequestAsync;
            }

            public TContext CreateContext(IFeatureCollection contextFeatures)
            {
                return _application.CreateContext(contextFeatures);
            }

            public void DisposeContext(TContext context, Exception exception)
            {
                _application.DisposeContext(context, exception);
            }

            public Task ProcessRequestAsync(TContext context)
            {
                _preProcessRequestAsync();
                return _application.ProcessRequestAsync(context);
            }
        }
    }

3.3 TestServer 類代碼量比較大，不過不要緊，我們只需要關註它的構造方法就可以了

        public TestServer(IWebHostBuilder builder)
            : this(builder, new FeatureCollection())
        {
        }

3.4 其構造方法接受一個 IWebHostBuilder 對象，只要我們傳入一個 WebHostBuilder 就可以創建一個測試主機了
3.5 創建測試主機和 HttpClient 客戶端，我們在測試類 ValuesUnitTest 編寫如下代碼

    public class ValuesUnitTest
    {
        private TestServer testServer;
        private HttpClient httpCLient;

        public ValuesUnitTest()
        {
            testServer = new TestServer(new WebHostBuilder().UseStartup<Ron.TestDemo.Startup>());
            httpCLient = testServer.CreateClient();
        }

        [Fact]
        public async void GetTest()
        {
            var data = await httpCLient.GetAsync("/api/values/100");
            var result = await data.Content.ReadAsStringAsync();

            Assert.Equal("300", result);
        }
    }

代碼解釋
這段代碼非常簡單，首先，我們聲明瞭一個 TestServer 和 HttpClient 對象，併在構造方法中初始化他們； TestServer 的初始化是由我們 new 了一個 Builder 對象，並指定其使用待測試項目 Ron.TestDemo 中的 Startup 類來啟動，這樣我們能可以直接使用待測試項目的路由和管道了，甚至我們無需指定測試站點，因為這些都會在 TestServer 自動配置一個 localhost 的主機地址

3.7 接下來就是創建了一個單元測試的方法，直接使用剛纔初始化的 HttpClient 對象進行網路請求，這個時候，我們只需要知道 Action 即可，同時傳遞參數 100，最後斷言伺服器輸出值為："300"，回顧一下我們創建的待測試方法，其業務正是將客戶端傳入的 id 值和配置文件 max 值相加後輸出，而 max 值在這裡被配置為 200

3.8 運行單元測試

3.9 測試通過，可以看到，測試達到了預期的結果，伺服器正確返回了計算後的值

4. 配置文件註意事項

4.1 在待測試項目中的配置文件 appsettings.json 並不會被測試主機所讀取，因為我們在上面創建測試主機的時候沒有調用方法

WebHost.CreateDefaultBuilder

4.2 我們只是創建了一個 WebHostBuilder 對象，非常輕量的主機配置，簡單來說就是無配置，如果對於 WebHost.CreateDefaultBuilder 不理解的同學，建議閱讀我的文章 asp.netcore 深入瞭解配置文件載入過程.

4.3 所以，為了能夠在單元測試中使用項目配置文件，我在 Ron.TestDemo 項目中的 Startup 類加入了下麵的代碼

 public class Startup
    {
        public Startup(IConfiguration configuration, IHostingEnvironment env)
        {
            this.Configuration = new ConfigurationBuilder()
                .AddJsonFile("appsettings.json")
                .AddEnvironmentVariables()
                .SetBasePath(env.ContentRootPath)
                .Build();
        }

        public IConfiguration Configuration { get; }

        // This method gets called by the runtime. Use this method to add services to the container.
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddSingleton<IConfiguration>(this.Configuration);
            services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
        }
    }

4.4 其目的就是手動讀取配置文件，重新初始化 IConfiguration 對象，並將 this.Configuration 對象加入依賴註入容器中

結語

  • 本文從單元測試入手，針對常見的系統集成測試提供了另外一種便捷的測試方案，通過創建 TestServer 測試主機開始，利用主機創建 HttpCLient 對象進行網路集成測試
  • 減少重覆啟動程式和測試工具，提高了測試效率
  • 充分利用了 Visual Studio 的優勢，既可以做單元測試，還能利用這種測試方案進行快速代碼調試
  • 最後，還瞭解如何通過 TestServer 主機載入待測試項目的配置文件對象 IConfiguration

示例代碼下載

https://files.cnblogs.com/files/viter/Ron.TestDemo.zip


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

-Advertisement-
Play Games
更多相關文章
  • hand first python 選讀（1）
    列表(list) 基本操作 比如說我要整理一個近期熱映的電影列表： 列表很像數組，但功能超越數組。列表都是從0開始的，python中列表無需事先聲明類型。 從列表後面加上一個新的元素，比如說加個“無名之輩”，是 方法。 刪除列表最後一個元素： 方法。 兩個列表相銜接，用的是 方法。 我想在某個條件下 ...
  • python學習之運算符
    python學習之運算符； 算術運算符； 比較運算符；位運算符； 邏輯運算符； 成員運算符； 身份運算符； ++ 或 -- 自運算符； is 和 ==； 數組的兩種賦值方式區別 ...
  • .NET Core實戰項目之CMS 第十章 設計篇-系統開發框架設計
    這兩天比較忙，周末也在加班，所以更新的就慢了一點，不過沒關係，今天我們就進行千呼萬喚的系統開發框架的設計。不知道上篇關於架構設計的文章大家有沒有閱讀，如果閱讀後相信一定對架構設計有了更近一部的理解，如果你沒有閱讀也希望大家能好好閱讀一下！其實說白了，架構是為了應對軟體系統複雜度而提出的一個解決方案， ...
  • .NET Core跨平臺部署
    .NET Core跨平臺部署 1. Windows IIS 大家對於在IIS上部署.NET站點已經駕輕就熟了，部署.NET Core也沒有什麼本質區別，但是這其中仍然有一些細節是不同的，下麵記錄了一些我在部署時遇到的問題 1.1 安裝.NET Core Windows Server Hosting ...
  • .net core i上 K8S(二)運行簡單.netcore程式
    上一章我們搭建了k8s集群，這一章我們開始在k8s集群上運行.netcore程式 1.kubectl run 在我的Docker系列教程里，我曾往docker hub中推送過一個鏡像“webdokcer_s_provider”，今天我們就是使用這個鏡像來配合K8S來演示。 我們可以看到，創建了資源d ...
  • C#與Java AES 加密解密
    參考文檔:https://www.cnblogs.com/xbzhu/p/7064642.html 這是參考文檔的博主寫的Demo:https://github.com/zhu-xb/AES-Cryptography 再次感謝博主 朱小波 https://www.cnblogs.com/xbzhu/ ...
  • [UWP] 用 AudioGraph 來增強 UWP 的音頻處理能力——AudioFrameInputNode
    上一篇心得記錄中提到了 AudioGraph, 描述了一下 什麼是 AudioGraph 以及其中涉及到的各種類型的 節點（Node）。 這一篇就其中比較有意思的 AudioFrameInputNode 來詳細展開一下。 借用 AudioFrameInputNode, 實現簡單的音頻左右聲道互換 什 ...
  • Linq中 AsQueryable(), AsEnumerable()和ToList()的區別和用法
    Linq中 AsQueryable(), AsEnumerable()和ToList()的區別和用法:在寫LINQ語句的時候，往往會看到AsEnumerable() ，AsQueryable() 和ToList()的用法，三者有何區別呢？以下是我的理解，有毛病請大家指教!在System.Linq命名 ...
一周排行
    -Advertisement-
    Play Games
  • WPF 已知問題 監聽 WMI 事件導致觸摸失效
    示例項目結構 在 Visual Studio 中創建一個 WinForms 應用程式後，項目結構如下所示： MyWinFormsApp/ │ ├───Properties/ │ └───Settings.settings │ ├───bin/ │ ├───Debug/ │ └───Release/ ...
  • [STAThread]特性
    [STAThread] 特性用於需要與 COM 組件交互的應用程式，尤其是依賴單線程模型（如 Windows Forms 應用程式）的組件。在 STA 模式下，線程擁有自己的消息迴圈，這對於處理用戶界面和某些 COM 組件是必要的。 [STAThread] static void Main(stri ...
  • UWP WinUI3 傳入 AddHandler 的 RoutedEventHandler 類型與事件所需不匹配將拋出參數異常
    在WinForm中使用全局異常捕獲處理 在WinForm應用程式中，全局異常捕獲是確保程式穩定性的關鍵。通過在Program類的Main方法中設置全局異常處理，可以有效地捕獲並處理未預見的異常，從而避免程式崩潰。 註冊全局異常事件 [STAThread] static void Main() { / ...
  • .NET 多版本 WinForm 開源控制項庫 SunnyUI
    前言 給大家推薦一款開源的 Winform 控制項庫，可以幫助我們開發更加美觀、漂亮的 WinForm 界面。 項目介紹 SunnyUI.NET 是一個基於 .NET Framework 4.0+、.NET 6、.NET 7 和 .NET 8 的 WinForm 開源控制項庫，同時也提供了工具類庫、擴展 ...
  • .net core8 使用Swagger（附當前源碼）
    說明 該文章是屬於OverallAuth2.0系列文章，每周更新一篇該系列文章（從0到1完成系統開發）。 該系統文章，我會儘量說的非常詳細，做到不管新手、老手都能看懂。 說明：OverallAuth2.0 是一個簡單、易懂、功能強大的許可權+可視化流程管理系統。 有興趣的朋友，請關註我吧(*^▽^*) ...
  • WPF 什麼時候 VisualTreeHelper.GetDescendantBounds 將返回無窮大
    一、下載安裝 1.下載git 必須先下載並安裝git，再TortoiseGit下載安裝 git安裝參考教程：https://blog.csdn.net/mukes/article/details/115693833 2.TortoiseGit下載與安裝 TortoiseGit，Git客戶端，32/6 ...
  • C# 開源教程帶你輕鬆掌握數據結構與演算法
    前言 在項目開發過程中，理解數據結構和演算法如同掌握蓋房子的秘訣。演算法不僅能幫助我們編寫高效、優質的代碼，還能解決項目中遇到的各種難題。 給大家推薦一個支持C#的開源免費、新手友好的數據結構與演算法入門教程：Hello演算法。 項目介紹 《Hello Algo》是一本開源免費、新手友好的數據結構與演算法入門 ...
  • 第22篇 生成proto文件bat腳本
    1.生成單個Proto.bat內容 @rem Copyright 2016, Google Inc. @rem All rights reserved. @rem @rem Redistribution and use in source and binary forms, with or with ...
  • 記一次 .NET某上位機視覺程式 卡死分析
    一：背景 1. 講故事 前段時間有位朋友找到我，說他的窗體程式在客戶這邊出現了卡死，讓我幫忙看下怎麼回事？dump也生成了，既然有dump了那就上 windbg 分析吧。 二：WinDbg 分析 1. 為什麼會卡死 窗體程式的卡死，入口門檻很低，後續往下分析就不一定了，不管怎麼說先用 !clrsta ...
  • 醫學DICOM文件與PACS系統進行數據傳輸
    前言 人工智慧時代，人臉識別技術已成為安全驗證、身份識別和用戶交互的關鍵工具。 給大家推薦一款.NET 開源提供了強大的人臉識別 API，工具不僅易於集成，還具備高效處理能力。 本文將介紹一款如何利用這些API，為我們的項目添加智能識別的亮點。 項目介紹 GitHub 上擁有 1.2k 星標的 C# ...
所有分類