快捷導(dǎo)航

關(guān)于Net6?Xunit?集成測試的問題

更新時(shí)間：2022年05月24日 11:29:53 作者：何聰

這篇文章主要介紹了Net6?Xunit?集成測試的相關(guān)知識,下面我將Net6下沒有使用Startup以及NET6以前版本使用Startup的集成測試（單元測試?yán)淄┳鲆粋€(gè)梳理，需要的朋友可以參考下

對于單元測試、集成測試大部分開發(fā)的朋友都懶得去寫，因?yàn)檫@要耗費(fèi)精力去設(shè)計(jì)去開發(fā)，做完項(xiàng)目模塊直接postman 調(diào)用測試(當(dāng)然這是一個(gè)選擇，開發(fā)也中經(jīng)常用到)，但是如果測試需要多樣化數(shù)據(jù)，各種場景模擬這樣postman測試就暴露了他的局限性，下面我將Net6下沒有使用Startup以及NET6以前版本使用Startup的集成測試（單元測試?yán)淄┳鲆粋€(gè)梳理

1.新建測試項(xiàng)目

2.使用到的類庫

Xunti與xunit.runner.visualstudio創(chuàng)建測試項(xiàng)目是自帶

Xunit.DependencyInjection 這是一個(gè)測試注入的擴(kuò)展：github地址：https://github.com/pengweiqhca/Xunit.DependencyInjection

Xunit.Extensions.Ordering 這是一個(gè)排序執(zhí)行測試方法的擴(kuò)展，因?yàn)橛行┓椒ㄊ切枰凑枕樞驁?zhí)行，如獲取圖形驗(yàn)證碼-->發(fā)送手機(jī)驗(yàn)證碼-->到獲取Token這是一個(gè)有序的過程，如果沒有按照順序執(zhí)行肯定是不對的，github地址：https://github.com/tomaszeman/Xunit.Extensions.Ordering

3.注入

就是將要測試項(xiàng)目的所有注入重新注入測試項(xiàng)目（Program.cs）中和Startup中的所有東東全部注入，NET6中默認(rèn)取消了Startup類，那么就要手工全部將這些注入再測試項(xiàng)目中添加一次，注入的時(shí)候有些是不兼容的做一下小的改動(dòng)就行，因?yàn)?a target="_blank">https://github.com/pengweiqhca/Xunit.DependencyInjection的注入還是停留在NET5以下版本的，哦對了，還有中間件也是需要在測試項(xiàng)目中添加的，

3.1 NET5 以下，測試項(xiàng)目中的Startup需要自己手工創(chuàng)建，區(qū)別在于NET5項(xiàng)目有Startup注入的時(shí)候不用手動(dòng)寫很多東西，測試項(xiàng)目直接從項(xiàng)目中的Startup查找注入，

public class Startup
    {
        // custom host build
        public void ConfigureHost(IHostBuilder hostBuilder)
        {
            hostBuilder
                .ConfigureHostConfiguration(builder =>
                {
                    builder.AddJsonFile("appsettings.json", true);
                })
                .ConfigureWebHostDefaults(builder =>
                {
                    builder.UseStartup<Dx.H5.Service.Startup>();//此處為項(xiàng)目中的startup，不是測試項(xiàng)目中的startup
                    builder.UseTestServer();
                    builder.ConfigureServices(services =>
                    {
                        services.AddSingleton(sp => sp.GetRequiredService<IHost>()
                            .GetTestClient()
                        );
                    });
                })
                ;
        }
        // add services need to injection
        // ConfigureServices(IServiceCollection services)
        // ConfigureServices(IServiceCollection services, HostBuilderContext hostBuilderContext)
        // ConfigureServices(HostBuilderContext hostBuilderContext, IServiceCollection services)
        public void ConfigureServices(IServiceCollection services)
        {
            // ready check
            //services.AddHostedService<ReadyCheckHostedService>();
        }
        public void Configure(ILoggerFactory loggerFactory, ITestOutputHelperAccessor outputHelperAccessor)
        {
            loggerFactory.AddProvider(new XunitTestOutputLoggerProvider(outputHelperAccessor));
        }
    }

3.2 NET6 ，測試項(xiàng)目中的Startup需要自己手工創(chuàng)建，NET6 項(xiàng)目取消了Startup那么就需要手工搬移所有的注入，需要注意的是Startup中的ConfigureServices不支持重載，也就是你只能用一個(gè)ConfigureServices方法，見如下示例，還有測試日志的注入，但是在測試項(xiàng)目中使用ILogger<>好像是有問題的，有時(shí)日志不打印，使用private readonly ITestOutputHelperAccessor _testOutputHelperAccessor; 替代ILogger<>,直接在測試類構(gòu)造函數(shù)中注入就行

public class Startup
    {
        const string DefaultCorsPolicyName = "Default";
        public void ConfigureHost(IHostBuilder hostBuilder) =>
            hostBuilder.ConfigureWebHost(webHostBuilder => webHostBuilder
                .UseTestServer()
                .Configure(Configure)
                .UseUrls("http://*:17890","http://*:17880")
                .ConfigureServices(services =>
                {
                    services.AddSingleton(sp => sp.GetRequiredService<IHost>()
                            .GetTestClient()
                        );
                })
            )
            .ConfigureAppConfiguration(lb => lb.AddJsonFile("appsettings.json", false, true));
        public void ConfigureServices(IServiceCollection services, HostBuilderContext context)
        {
            services.AddControllers();
            services.AddEndpointsApiExplorer();
            services.AddSwaggerGen();
            services.AddHttpClient();
        }
        public void Configure(ILoggerFactory loggerFactory, ITestOutputHelperAccessor accessor) =>
        loggerFactory.AddProvider(new XunitTestOutputLoggerProvider(accessor));
        ////public void ConfigureHost(IHostBuilder hostBuilder) { }
        //public void ConfigureServices(IServiceCollection services)
        //{
        //}
        //public IHostBuilder CreateHostBuilder(AssemblyName assemblyName) 
        //{
        //    return new HostBuilder();
        //}
        private void Configure(IApplicationBuilder app)
        {
            //if (app.Environment.IsDevelopment())
            //{
            //    app.UseSwagger();
            //    app.UseSwaggerUI();
            //}
            app.UseRouting();
            app.UseAuthorization();
            app.UseEndpoints(endpoints =>
            {
                endpoints
                .MapControllers();
                endpoints.MapGet("/hb/generatetoken", context =>
                {
                    return context.Response.WriteAsync(GenerateToken(context));
                });
            });
        }
        string GenerateToken(HttpContext httpContext)
        {
            return "dfdfdfdfd";
        }
    }
public static IEnumerable<object?[]> ReadFile()
        {
            yield return new object[] { "123"};
            yield return new object[] { "456" };
        }

4.創(chuàng)建測試類測試方法：

需要注意的是api接口測試中url忽略host與端口，默認(rèn)端口配置請查閱https://github.com/pengweiqhca/Xunit.DependencyInjection文檔，UnitTest2中的測試方法是帶有數(shù)據(jù)集合的測試方法，及測試方法是執(zhí)行多次的，測試方法中的參數(shù)數(shù)據(jù)就是由MemberData(nameof(ReadFile))，其中數(shù)據(jù)方法ReadFile必須是 public staticReadFile要不然會(huì)有報(bào)錯(cuò)

using Microsoft.Extensions.Logging;
using Newtonsoft.Json;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Threading.Tasks;
using Xunit;
using Xunit.DependencyInjection;
using Xunit.Extensions.Ordering;
using static WebApiXunit.Controllers.WeatherForecastController;
namespace Xunit.WebApiTest
{
    [Order(1)]
    public class UnitTest1
    {
        private HttpClient _client;
        private ILogger<UnitTest1> _logger;
        //private readonly ITestOutputHelperAccessor _testOutputHelperAccessor;
        public UnitTest1(
            //ITestOutputHelperAccessor testOutputHelperAccessor
            ILogger<UnitTest1> logger,
            HttpClient client
            )
        {
            _logger = logger;
            _client = client;
        }
        [Order(1)]
        [Fact(DisplayName = "1")]
        public async Task Test1()
        {
            var c = new MyClass();
            c.Name = "1";
            c.Description = "e";
            using var request = new HttpRequestMessage(HttpMethod.Post, "WeatherForecast/hb/post/add");
            var content = JsonConvert.SerializeObject(c);
            request.Content = new StringContent(content);
            request.Content.Headers.ContentType = new MediaTypeHeaderValue("application/json");
            var resp = await _client.SendAsync(request);
            //var resp=await _client.GetAsync("/hb/generatetoken");
            _logger.LogInformation("成功");
            if (resp.IsSuccessStatusCode)
            {
                var str = await resp.Content.ReadAsStringAsync();
                Assert.True(true);
                return;
            }
            Assert.True(false);
        }
        [Order(2)]
        [Fact(DisplayName = "2")]
        public async Task Test2()
        {
            var c = new MyClass();
            c.Name = "1";
            c.Description = "e";
            using var request = new HttpRequestMessage(HttpMethod.Post, "WeatherForecast/hb/post/add");
            var content = JsonConvert.SerializeObject(c);
            request.Content = new StringContent(content);
            request.Content.Headers.ContentType = new MediaTypeHeaderValue("application/json");
            var resp = await _client.SendAsync(request);
            //var resp=await _client.GetAsync("/hb/generatetoken");
            //_testOutputHelperAccessor.Output.WriteLine("");
            _logger.LogInformation("成功");
            if (resp.IsSuccessStatusCode)
            {
                var str = await resp.Content.ReadAsStringAsync();
                Assert.True(true);
                return;
            }
            Assert.True(false);
        }
    }
    [Order(2)]
    public class UnitTest2
    {
        private HttpClient _client;
        private ILogger<UnitTest2> _logger;
        public UnitTest2(
            ILogger<UnitTest2> logger,
            HttpClient client
            )
        {
            _logger = logger;
            _client = client;
        }
        [Theory]
        [MemberData(nameof(ReadFile))]
        public async Task Test2(string name)
        {
            _logger.LogInformation(name);
            Assert.True(true);
        }
        public static IEnumerable<object?[]> ReadFile()
        {
            yield return new object[] { "123"};
            yield return new object[] { "456" };
        }
    }
}

5.排序執(zhí)行測試方法：

使用Xunit.Extensions.Ordering進(jìn)行排序執(zhí)行測試方法時(shí)：首先在測試項(xiàng)目中新建一個(gè)AssemblyInfo.cs加入如下內(nèi)容，主要沒有類名及命名空間，其中[assembly: TestFramework("Xunit.Extensions.Ordering.TestFramework", "Xunit.Extensions.Ordering")]是一個(gè)按照集合進(jìn)行排序的使用，但是他與已有xunit assembly沖突，暫時(shí)么有找到解決方法，所以該排序功能暫時(shí)不支持，類中的[Order(2)]為第一優(yōu)先級排序順序，方法中的[Order(2)]即在類的順序下再排序

using Xunit;
using Xunit.Extensions.Ordering;
[assembly: CollectionBehavior(DisableTestParallelization = true)]
//[assembly: TestFramework("Xunit.Extensions.Ordering.TestFramework", "Xunit.Extensions.Ordering")]
[assembly: TestCaseOrderer("Xunit.Extensions.Ordering.TestCaseOrderer", "Xunit.Extensions.Ordering")]
[assembly: TestCollectionOrderer("Xunit.Extensions.Ordering.CollectionOrderer", "Xunit.Extensions.Ordering")]

using Xunit;
using Xunit.Extensions.Ordering;
[assembly: CollectionBehavior(DisableTestParallelization = true)]
//[assembly: TestFramework("Xunit.Extensions.Ordering.TestFramework", "Xunit.Extensions.Ordering")]
[assembly: TestCaseOrderer("Xunit.Extensions.Ordering.TestCaseOrderer", "Xunit.Extensions.Ordering")]
[assembly: TestCollectionOrderer("Xunit.Extensions.Ordering.CollectionOrderer", "Xunit.Extensions.Ordering")]

6.運(yùn)行測試項(xiàng)目：

在vs中運(yùn)行測試項(xiàng)目中右鍵可以看到運(yùn)行和調(diào)試測試項(xiàng)目運(yùn)行比較簡單，如果在服務(wù)器上需要使用dotnet test運(yùn)行測試，注意配置文件要與服務(wù)器的匹配，將項(xiàng)目整體目錄拷貝到服務(wù)器，cd 到測試項(xiàng)目目錄下執(zhí)行 dotnet test，有多少個(gè)接口瞬間測試完畢，而且在項(xiàng)目后續(xù)迭代更新的時(shí)候，只需要執(zhí)行以下就可以測試所有的接口。

到此這篇關(guān)于Net6 Xunit 集成測試的文章就介紹到這了,更多相關(guān)Net6 Xunit 集成測試內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: