快捷導(dǎo)航

C#中實(shí)現(xiàn)契約測試的方法

更新時(shí)間：2023年09月15日 09:02:19 作者：楊中科

這篇文章主要介紹了C#中實(shí)現(xiàn)契約測試,在本文中，我將揭開契約測試的神秘面紗，并向您展示如何在 C# 項(xiàng)目中實(shí)現(xiàn)它，需要的朋友可以參考下

在軟件開發(fā)中，確保微服務(wù)和API的可靠性和穩(wěn)定性非常重要。隨著應(yīng)用程序變得越來越復(fù)雜，對強(qiáng)大的測試策略的需求也越來越大，這些策略可以幫助團(tuán)隊(duì)在不犧牲敏捷性的情況下交付高質(zhì)量的代碼。近年來獲得廣泛關(guān)注的一種方法是契約測試（Contract Testing）。在本文中，我將揭開契約測試的神秘面紗，并向您展示如何在 C# 項(xiàng)目中實(shí)現(xiàn)它。

1. 術(shù)語

消費(fèi)者（Consumer）:對服務(wù)進(jìn)行消費(fèi)的代碼，通常指的是客戶端。

提供者（Provider）: 提供服務(wù)的代碼，通常指的是服務(wù)器端。

契約（Contract）: 消費(fèi)者和提供者之間商定的協(xié)議。它包括預(yù)期的請求（輸入）和響應(yīng)（輸出）。

2. 為什么需要契約測試？

構(gòu)建和維護(hù)微服務(wù)是一項(xiàng)艱巨的任務(wù)。在眾多服務(wù)必須彼此無縫交互的世界中，確保對一項(xiàng)服務(wù)的更改不會破壞另一項(xiàng)服務(wù)的功能是很讓人頭疼的。傳統(tǒng)的集成測試針對的是整個(gè)系統(tǒng)之間的交互，工作量太大、速度太慢，甚至無法直接識別問題。與之相反的是，契約測試側(cè)重于測試各個(gè)服務(wù)之間的契約。合同測試根據(jù)消費(fèi)者和提供商之間商定的契約分別對消費(fèi)者和提供商進(jìn)行測試。

3. 如何執(zhí)行契約測試

在契約測試中，消費(fèi)者端程序員編寫“消費(fèi)者測試”，其中包含期望的輸入和輸出，并且期望將被保存到 Pact Json 文件中。運(yùn)行時(shí)，測試將請求發(fā)送到內(nèi)置的模擬服務(wù)器而不是真實(shí)服務(wù)器，模擬服務(wù)器使用保存的 Pact Json 文件發(fā)送響應(yīng)，該響應(yīng)將用于驗(yàn)證消費(fèi)者端測試用例。

此外，契約測試框架將讀取保存的 Pact Json 文件，并向服務(wù)提供者（服務(wù)器）發(fā)送請求，并且將根據(jù) Pact Json 文件中的預(yù)期輸出來驗(yàn)證響應(yīng)。

4. What is Pact?

Pact 是合約測試的實(shí)現(xiàn)。由于消費(fèi)者和提供者可能使用不同的編程語言進(jìn)行開發(fā)，因此 Pact 是語言無關(guān)的，它支持多種編程語言，例如 Java、.NET、Ruby、JavaScript、Python、PHP 等。保存的 Pact Json 文件是由用一種編程語言開發(fā)的消費(fèi)者可以用來驗(yàn)證用另一種編程語言開發(fā)的提供者。

在本文中，消費(fèi)者和提供者都是使用.NET (C#) 開發(fā)的。 Pact.Net 是 Pact 在 .Net 中的實(shí)現(xiàn)。

5. 如何使用Pact.Net?

使用Pact.Net總共分三步：開發(fā)一個(gè)待測試的WebAPI服務(wù)；編寫消費(fèi)者端測試用例；編寫提供者端測試用例。

a. 開發(fā)待測試的WebAPI服務(wù)

創(chuàng)建一個(gè) ASP.Net Core WebAPI項(xiàng)目，然后如下編寫一個(gè)簡單的控制器。

[ApiController]
[Route("[controller]/[action]")]
public class MyController : ControllerBase
{
    [HttpGet]
    public int Abs(int i)
    {
        return Math.Abs(i);
    }
}

上面的控制器提供了一個(gè)計(jì)算給定整數(shù)的絕對值的簡單服務(wù)。

Pact需要使用ASP.Net Core項(xiàng)目的Startup類來啟動(dòng)Web服務(wù)器，但是，在最新的.NET Core中，傳統(tǒng)的Startup.cs被Minimal API取代。如果要將 Pact 與 .NET Core 一起使用，您必須切換到傳統(tǒng)Startup 風(fēng)格的代碼，如果您不知道如何切換回傳統(tǒng)的Startup 風(fēng)格的代碼，請搜索“Adding Back the Startup Class to ASP.NET Core”。

b. 編寫消費(fèi)者端測試用例

創(chuàng)建一個(gè)使用xUnit的.NET測試項(xiàng)目，然后在測試項(xiàng)目上安裝“PactNet”這個(gè)Nuget包。然后編寫如下的測試用例。

public class UnitTest1
{
    private readonly IPactBuilderV4 pactBuilder;
    public UnitTest1()
    {
        var pact = Pact.V4("MyAPI consumer", "MyAPI",new PactConfig());
        this.pactBuilder = pact.WithHttpInteractions();
    }
    [Fact]
    public async Task Test1()
    {
        this.pactBuilder.UponReceiving("A request to calc Abs")
            .Given("Abs")
            .WithRequest(HttpMethod.Get, "/My/Abs")
            .WithQuery("i","-2")//Match.Integer(-2) 
            .WillRespond()
            .WithStatus(HttpStatusCode.OK)
            .WithJsonBody(2);
        await this.pactBuilder.VerifyAsync(async ctx=>
        {
            using HttpClient httpClient = new HttpClient();
            httpClient.BaseAddress = ctx.MockServerUri;
            var r = await httpClient.GetFromJsonAsync<int>($"/My/Abs?i=-2");
            Assert.Equal(2,r);
        });
    }
}

“WithRequest().WithQuery()”用于定義輸入，“WillRespond().WithJsonBody()”用于定義相應(yīng)的預(yù)期輸出。VerifyAsync中的代碼片段是測試用例，根據(jù)“UponReceiving”定義的期望進(jìn)行測試。從“httpClient.BaseAddress = ctx.MockServerUri”可以看出，Provider 測試用例與 Pact 提供的Mock服務(wù)器交互而不是真實(shí)服務(wù)器進(jìn)行交互。

接下來，讓我們運(yùn)行測試，測試運(yùn)行完成后，測試項(xiàng)目的pact文件夾下會生成一個(gè)“MyAPI Consumer-MyAPI.json”，這個(gè)Json文件中保存了預(yù)期的輸入和輸出，如下圖。

c. 編寫提供者端測試用例

創(chuàng)建一個(gè)使用xUnit的.NET測試項(xiàng)目，然后向其安裝 Nuget 包“PactNet”和“PactNet.Output.Xunit”。由于提供程序測試必須使用 Startup 類啟動(dòng)測試服務(wù)器，因此請將待測試的 ASP.NET Core WebAPI 項(xiàng)目的引用添加到提供程序測試項(xiàng)目中。

創(chuàng)建一個(gè)“MyApiFixture”類，用于啟動(dòng)測試項(xiàng)目中測試的WebAPI服務(wù)器。MyApiFixture類的代碼如下：

public class MyApiFixture: IDisposable
{
    private readonly IHost server;
    public Uri ServerUri { get; }
    public MyApiFixture()
    {
        ServerUri = new Uri("http://localhost:9223");
        server = Host.CreateDefaultBuilder()
            .ConfigureWebHostDefaults(webBuilder =>
            {
                webBuilder.UseUrls(ServerUri.ToString());
                webBuilder.UseStartup<Startup>();
            })
            .Build();
        server.Start();
    }
    public void Dispose()
    {
        server.Dispose();
    }
}

接下來，如下創(chuàng)建一個(gè)使用保存的Pact Json文件對服務(wù)器（提供者）進(jìn)行測試的測試用例。

public class MyApiTest1: IClassFixture<MyApiFixture>
{
    private readonly MyApiFixture fixture;
    private readonly ITestOutputHelper output;
    public MyApiTest1(MyApiFixture fixture,ITestOutputHelper output)
    {
        this.fixture = fixture;
        this.output = output;
    }
    [Fact]
    public async Task Test1()
    {
        var config = new PactVerifierConfig
        {
            Outputters = new List<IOutput>
            {
                new XunitOutput(output),
            },
        };
        string pactPath = Path.Combine("..","..","..","..",
            "TestConsumerProject1", "pacts", "MyAPI consumer-MyAPI.json");
        using var pactVerifier = new PactVerifier("MyAPI", config);
        pactVerifier
            .WithHttpEndpoint(fixture.ServerUri)
            .WithFileSource(new FileInfo(pactPath))
            .Verify();
    }
}

“pactPath”是指保存的Pact文件，在您的項(xiàng)目中，它會根據(jù)項(xiàng)目名稱、相對路徑的不同而不同。執(zhí)行上述測試時(shí)，Pact 將啟動(dòng)測試項(xiàng)目中的測試服務(wù)器，發(fā)送請求并根據(jù)保存的 Json 文件驗(yàn)證響應(yīng)。