pact-foundation #pact-net

Prakhar Roy

11/06/2023, 1:10 PM

Hi all, there is an issue I am facing on C# level of datetime values with pact tests. (See screenshot below) Basically after Json serialization, the trailing insignificant 0's are removed. In the mocked data, we have mentioned those 0s. Hence there is a length difference causing pact test cases to fail with the error : "Expected property Date with a length of 24, but has a length of 20, differs near Z" Can someone give any insights to this issue without removing those 0's from our mock data?

Nuno Domingues

11/10/2023, 12:25 AM

Hello everyone, I'm studying about a topic which envolves contract testing, and i found pact, so i decided try to implement a contract test between two minimal services. You can check it out here: https://github.com/nomorealex/pactnet-MinimalAPI/ It's not finished because i need to exercise the provider with the pact file as well implement the pact-broker. it's not done yet cause i have some problems in the providertests

Bas Dijkstra

11/10/2023, 5:25 AM

Hey Nuno! Let us know where we can help.

Nuno Domingues

11/10/2023, 10:48 AM

So basically I’m with problems verifying the provider. There is something wrong with the providertests.csproj, where you can check it out in the github page

Nuno Domingues

11/10/2023, 10:56 AM

Copy code

namespace providertests
{
    [TestFixture]
    public class VerifyPact
    {


        private readonly string _url = "<http://127.0.0.1/9001>";
        private readonly Uri _Uri = new Uri("<http://127.0.0.1/9001>");
        

        public VerifyPact() { }


        [Test]
        public void Verify_That_Address_Service_Honours_Pacts()
        {

            var config = new PactVerifierConfig
            {
                LogLevel = PactNet.PactLogLevel.Debug
            };

            using (var _webHost = WebHost.CreateDefaultBuilder().UseUrls(_url).Build())
            {
                _webHost.Start();

                //Assert
                IPactVerifier pactVerifier = new PactVerifier(config);
                var pactFile = new FileInfo(Path.Join("..", "..", "..", "..", "consumertests", "pacts", "consumer-provider.json"));
                pactVerifier
                    .ServiceProvider("provider", _Uri)
                    .WithFileSource(pactFile)
                    .Verify();
            }


        }
    }
}

This is the code, that i'm using to verify the provider with the pact file generated

Nuno Domingues

11/10/2023, 10:58 AM

I think the problem is with the webhost. It says that i need to provide a Startup class. But since this is a minimal API, I don´t need that class, below is the provider web api

Nuno Domingues

11/10/2023, 10:59 AM

Copy code

using provider.model;

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
// Learn more about configuring Swagger/OpenAPI at <https://aka.ms/aspnetcore/swashbuckle>
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();



var app = builder.Build();

// Configure the HTTP request pipeline.
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();
}

app.UseHttpsRedirection();


List<Jokes> jokesStorage = new List<Jokes>
{
        new Jokes (0,"Why do programmers prefer dark mode? -Because the light attracts bugs!","Jonas" ),
        new Jokes (1,"Why did the programmer break up with their keyboard? -They had too many arguments.","Peter" ),
};


app.MapGet("/jokes", () =>
{
    var allJokes = jokesStorage.ToArray();
    if (allJokes.Count() > 0)
        return Results.Ok(jokesStorage);
    else
        return Results.NoContent();
})
.WithName("GetJokes")
.Produces<Jokes>(StatusCodes.Status200OK)
.Produces<string>(StatusCodes.Status204NoContent, contentType: "text/plain");


app.MapGet("/jokes/{id}", (string id) =>
{

    int _id = 0;

    if (!(int.TryParse(id, out _id)))
    {
        return Results.BadRequest("BadRequest!");
    }


    Jokes joke = jokesStorage.FirstOrDefault(j => j.Id == _id);

    if (joke != null)
    {
        return Results.Ok(joke);
    }

    return Results.NotFound("Joke with the id provided not found!");
})
.WithName("GetJokesId")
.Produces<Jokes>(StatusCodes.Status200OK, contentType: "application/json")
.Produces<string>(StatusCodes.Status404NotFound, contentType: "text/plain")
.Produces<string>(StatusCodes.Status400BadRequest, contentType: "text/plain");


app.MapPost("/jokes", (Jokes entity) =>
{

    Console.WriteLine(entity);

    if (entity is Jokes joke && entity.Id == 0 && entity.Joke != null && entity.Bywho != null)
    {
        var lastid = GetLastJokesId();
        joke.Id = (lastid != -1) ? ++lastid : 0;
        jokesStorage.Add(joke);
        return Results.Created($"/jokes/{joke.Id}", joke);
    }

    return Results.BadRequest("BadRequest!");

})
.WithName("PostJoke")
.Accepts<Jokes>("application/json")
.Produces<Jokes>(StatusCodes.Status201Created)
.Produces<string>(StatusCodes.Status400BadRequest, contentType: "text/plain")
.Produces<string>(StatusCodes.Status415UnsupportedMediaType, contentType: "text/plain");

app.MapDelete("/jokes/{id}", (string id) =>
{
    int _id = 0;

    if (!(int.TryParse(id, out _id)))
    {
        return Results.BadRequest("BadRequest!");
    }


    Jokes joke = jokesStorage.FirstOrDefault(j => j.Id == _id);

    if (joke != null)
    {
        return Results.Ok(joke);
    }

    return Results.NotFound("Joke with the id provided not found!");
})
.WithName("DeleteJoke")
.Produces<Jokes>(StatusCodes.Status200OK, contentType: "application/json")
.Produces<string>(StatusCodes.Status404NotFound, contentType: "text/plain")
.Produces<string>(StatusCodes.Status400BadRequest, contentType: "text/plain");


app.Run();


int GetLastJokesId()
{
    if (jokesStorage.Count > 0)
    {
        Jokes lastJoke = jokesStorage[jokesStorage.Count - 1];
        return lastJoke.Id;
    }
    else
    {
        return -1;
    }
}

Bas Dijkstra

11/10/2023, 9:43 PM

Yeah, I tried to get this to work with a minimal API as well but ended up having to wrap it in a lightweight Startup class: https://github.com/basdijkstra/introduction-to-contract-testing-dotnet/tree/main/AddressProvider

Bas Dijkstra

11/10/2023, 9:43 PM

It’s something I need to revisit anyway as I’m prepping for a workshop in a couple of weeks, but this is what I have / know at the moment

Nuno Domingues

11/10/2023, 11:24 PM

Yes, that workshop will be Based on jvm or .net

Nuno Domingues

11/10/2023, 11:25 PM

@Bas Dijkstra Thanks anyways

Chandra Muddam

11/11/2023, 7:41 AM

Good evening. Can someone point me to a sample example/github repo for message based dotnet pact tests please ?

Nuno Domingues

11/15/2023, 11:13 AM

@Bas Dijkstra I was reviewing your work in pact-net can you tell me the purpose of the integration tests. I mean AddressPactTest.cs should make the job, right. https://github.com/basdijkstra/introduction-to-contract-testing-dotnet/blob/main/AddressProvider.Tests/AddressIntegrationTests.cs

Steve Blomeley

11/15/2023, 3:34 PM

Hi all, We're considering using Pact to write contract tests around the message-based interactions between some .NET services (Azure functions implemented in C#). So far we've found reasonable documentation and example code for testing .NET HTTP APIs, but documentation and examples around testing _.NET message-based systems_ is hard to find - what little there is seems somewhat patchy and theoretical. So we're wondering whether in practice folks are actually using Pact to test these kind of scenarios. (The sketchy docs and apparent lack of any blog posts or other on-line resources around this subject leads us to suspect not) We'd appreciate any feedback on this, and especially URLs for useful online resources like: worked examples; blog posts; in depth docs; etc. (We already looked at the Pact .NET repo - if there are any reasonably comprehensive docs / examples on there, we haven't found them yet) Thanks! Steve

GitHub

11/16/2023, 3:32 PM

#482 Pact-Net: PactConfig does not appear to have parity with Pact-JS - Missing [Host] and [Port] properties Issue created by daTooz Request: Add [Host] and [Port] properties to Pact-Net PactConfig class. Using pact-js, I can create a new pact where I can specify those properties...

const provider = new Pact({

consumer: "consumer-js-v2",

provider: "provider-js-v2",

host: "127.0.0.1",

port: 9999

});

By comparison, I cannot specify those same properties in Pact-Net...

var config = new PactConfig

{

PactDir = PactDir,

Outputters = new List { new XunitOutput(output), new ConsoleOutput() },

LogLevel = PactLogLevel.Trace

};

_pact = PactNet.Pact.V3(_consumerName, _providerName, config).WithHttpInteractions();

pact-foundation/pact-net

Prakhar Roy

11/17/2023, 8:27 AM

Hi all. On the consumer side CICD Job - Pact Publish, we have defined the version to $CI_COMMIT_SH. But on the provider side, verification is done on code level. We are facing the following error on provider side verification in Can-I-Deploy on consumer side

Copy code

There is no verified pact between version 1.0.0 of Consumer and the latest version of Producer (c8169874d39b17ac0ca748dcd2fd)

Wanted to know how we can incorporate git sh in our code.

Copy code

pactVerifier
     .ServiceProvider("City_Provider_API", new Uri(_providerServiceUri))
     .WithUriSource(new Uri(pactUri), options =>
     {
         options.TokenAuthentication("Uiv1OaU4O1wOXX0GoIfLAA");
         options.PublishResults(true, "1.0.0", results =>                        // Version -> CI_COMMIT_SH (something of this manner instead of 1.0.0)
         {
             results.ProviderBranch("Development");

         });
     })

boden winkel

11/21/2023, 10:29 AM

Hello i have written consumer and verifider tests, i am running pact-broker in which i published contract already. How now i can publish results from verifier test in broker ? this is my verifier test which im running from command line and it is passing, but nothing has changed in broker index page.

GitHub

11/22/2023, 2:39 PM

#483 docs req - contributing guide Issue created by YOU54F There is a link in the README that points to a non-existent contribution guide. I've checked previous release branches but cannot find the older doc. It would be nice to have a simple contribution guide, that at least points users to the basic commands they need to checkout this repository, and run the project locally. I usually work backgrounds from the CI workflows, and noted that the native libs need to be downloaded, before the code in the repo can be run pact-net/.github/workflows/ci.yml Lines 29 to 30 in </pact-foundation/pact-net/commit/5b5388d81995da48889cc441495153b2ef7c0978|5b5388d> This would be a nice easy first contribution, but happy to do so myself pact-foundation/pact-net

Rafaela Azevedo

11/27/2023, 10:00 AM

Hey hey peeps !

Rafaela Azevedo

11/27/2023, 10:00 AM

Do you have any good tutorial/video/repo for someone that is starting in pact with C# ?

Rafaela Azevedo

11/27/2023, 10:01 AM

ah just saw there is a link on the top lolz

giphy

11/27/2023, 10:01 AM

hide

Rafaela Azevedo

11/27/2023, 10:01 AM

nevermind xD I was not here !

Divya Parappanavar

11/27/2023, 1:28 PM

Hi Guys, We are facing a problem on Provider verification. Scenario is we have used "JsonIgnore" attribute in 2 of the properties in the model class(say key1, key2). And the same is used in the consumer model class also. public class Test { public string name {get;set} public string id{get;set} [JsonIgnore] public bool key1 {get;set;} [JsonIgnore] public int key2 {get;set;} } When we run the Provider tests, its giving error saying Actual map is missing the following keys : key1, key2 And also in the Standard Output body those 2 properties are missing. Can anyone pls help us here as we are stuck

Adam Schaff

11/28/2023, 4:38 AM

Hello. We are using the DAPR framework for our microservices application. I would like to institute contract testing, but it is unclear how the pieces of the contract testing puzzle fit together in a world with dapr sidecars. Does anyone have any suggestions, examples, links? Any help would be appreciated.

Lukasz

11/28/2023, 10:59 AM

Hey there 👋 In the company I am working in we started using Pact for contract tests. Unfortunately, we are rookies in Contract Testing. Right now, we are struggling with identifying boundaries in contract tests. Do you know any expert that could help us? To give you more context, we are working on distributed system and we would like to have contract tests in place, to make sure other services don’t change the data on their API. We are wondering if contract tests should be black box or white box? Lets take an example: There is a service that works as provider and there is consumer. Provider works as open host. Provider exposes API and there is endpoint

GET /api/document/{id}

. We would like to have contract tests for this as it happened in the past that the contact was broken. ID is

guid

. The question is how should we provide ID? Should it be the one existing in Service A or should it be any valid guid? If the first one, the tests are becoming white box, right? Provider knows about the details & the data in Service A. But service A can take the guid from the contract, act on it and return the data. In this case, there is a temptation to check also the data returned, so you can achieve both functional tests and contract at once. How should this work? How should you provide

id

s for the data you would like to use? How should provider check it? On real data? The same will also apply for resources with availability. Assuming you there is an endpoint

Delete api/document/{id}

. Should you check it in contract tests? If yes, how? Same problem with guid, but also additional problem. If you execute it on any side of tests then the document with {id} will be removed, so you won’t be able to run this for the 2nd time. We really love the tool but after some time we have many questions to ask, as we are not sure how to use it properly 👼 is there any expert in the house that could help us? 🤔

Bas Dijkstra

11/28/2023, 3:46 PM

Hey folks, so, I'm trying to get my test for an HTTP POST to work, but it fails on the consumer side with an HTTP 500. Here's the test:

Copy code

[Test]
public async Task PostAddress_AddressIdIsValid()
{
    Address address = new Address
    {
        Id = new Guid(addressIdNonexistent),
        AddressType = "delivery",
        Street = "Main Street",
        Number = 123,
        City = "Beverly Hills",
        ZipCode = 90210,
        State = "California",
        Country = "United States"
    };

    pact.UponReceiving("A request to create an address by ID")
            .Given("an address with ID {id} does not exist", new Dictionary<string, string> { ["id"] = addressIdNonexistent })
            .WithRequest(HttpMethod.Post, $"/address")
            .WithHeader("Content-Type", "application/json; charset=utf-8")
            .WithJsonBody(address)
        .WillRespond()
            .WithStatus(HttpStatusCode.Created);
    
    await pact.VerifyAsync(async ctx => {
        var response = await client.PostAddress(address);
        Assert.That(response.StatusCode, Is.EqualTo(HttpStatusCode.Created));
    });
}

This is my client implementation:

Copy code

public async Task<HttpResponseMessage> PostAddress(Address address)
{
    using (var client = new HttpClient { BaseAddress = baseUri })
    {
        try
        {
            var response = await client.PostAsync($"/address",
                new StringContent(JsonSerializer.Serialize(address), Encoding.UTF8, "application/json"));
            return response;
        }
        catch (Exception ex)
        {
            throw new Exception("There was a problem connecting to the AddressProvider API.", ex);
        }
    }
}

The actual request, as captured by Fiddler:

Copy code

POST <http://localhost:9876/address> HTTP/1.1
Host: localhost:9876
Content-Type: application/json; charset=utf-8
Content-Length: 192

{"Id":"3514466e-3e58-48b3-ab35-e553b91aa2b3","AddressType":"delivery","Street":"Main Street","Number":123,"City":"Beverly Hills","ZipCode":90210,"State":"California","Country":"United States"}

And the response from the Pact mock provider:

Copy code

HTTP/1.1 500 Internal Server Error
access-control-allow-origin: *
content-type: application/json; charset=utf-8
x-pact: Request-Mismatch
content-length: 747
date: Tue, 28 Nov 2023 15:53:22 GMT

{"error":"Request-Mismatch : HttpRequest { method: \"POST\", path: \"/address\", query: None, headers: Some({\"content-length\": [\"192\"], \"host\": [\"localhost:9876\"], \"content-type\": [\"application/json; charset=utf-8\"]}), body: Present(b\"{\\\"Id\\\":\\\"3514466e-3e58-48b3-ab35-e553b91aa2b3\\\",\\\"AddressType\\\":\\\"delivery\\\",\\\"Street\\\":\\\"Main Street\\\",\\\"Number\\\":123,\\\"City\\\":\\\"Beverly Hills\\\",\\\"ZipCode\\\":90210,\\\"State\\\":\\\"California\\\",\\\"Country\\\":\\\"United States\\\"}\", Some(ContentType { main_type: \"application\", sub_type: \"json\", attributes: {\"charset\": \"utf-8\"}, suffix: None }), None), matching_rules: MatchingRules { rules: {} }, generators: Generators { categories: {} } }"}

And the log output:

Copy code

2023-11-28T15:53:22.876142Z  INFO tokio-runtime-worker pact_mock_server::hyper_server: Received request HTTP Request ( method: POST, path: /address, query: None, headers: Some({"content-length": ["192"], "host": ["localhost:9876"], "content-type": ["application/json; charset=utf-8"]}), body: Present(192 bytes, application/json;charset=utf-8) )

2023-11-28T15:53:22.876349Z  INFO tokio-runtime-worker pact_matching: comparing to expected HTTP Request ( method: POST, path: /address, query: None, headers: Some({"Content-Type": ["application/json; charset=utf-8"]}), body: Present(192 bytes, application/json) )

The only real difference I'm seeing is the capitalization of the

Content-Type

header name, but Pact isn't that fussy, hopefully? EDIT: it doesn't seem like it is, when I change the capitalization in the test to

content-type

it still fails, here's the updated logging:

Copy code

2023-11-28T16:11:08.276151Z  INFO tokio-runtime-worker pact_mock_server::hyper_server: Received request HTTP Request ( method: POST, path: /address, query: None, headers: Some({"content-length": ["192"], "content-type": ["application/json; charset=utf-8"], "host": ["localhost:9876"]}), body: Present(192 bytes, application/json;charset=utf-8) )

2023-11-28T16:11:08.276441Z  INFO tokio-runtime-worker pact_matching: comparing to expected HTTP Request ( method: POST, path: /address, query: None, headers: Some({"content-type": ["application/json; charset=utf-8"]}), body: Present(192 bytes, application/json) )

GitHub

11/29/2023, 2:51 AM

#484 Improve error message output Issue created by mefellows When there is a request mismatch in a consumer test, the error message is hidden away in the logs or in the response to the failing API test:

Copy code

HTTP/1.1 500 Internal Server Error
access-control-allow-origin: *
content-type: application/json; charset=utf-8
x-pact: Request-Mismatch
content-length: 747
date: Tue, 28 Nov 2023 15:53:22 GMT

{"error":"Request-Mismatch : HttpRequest { method: \"POST\", path: \"/address\", query: None, headers: Some({\"content-length\": [\"192\"], \"host\": [\"localhost:9876\"], \"content-type\": [\"application/json; charset=utf-8\"]}), body: Present(b\"{\\\"Id\\\":\\\"3514466e-3e58-48b3-ab35-e553b91aa2b3\\\",\\\"AddressType\\\":\\\"delivery\\\",\\\"Street\\\":\\\"Main Street\\\",\\\"Number\\\":123,\\\"City\\\":\\\"Beverly Hills\\\",\\\"ZipCode\\\":90210,\\\"State\\\":\\\"California\\\",\\\"Country\\\":\\\"United States\\\"}\", Some(ContentType { main_type: \"application\", sub_type: \"json\", attributes: {\"charset\": \"utf-8\"}, suffix: None }), None), matching_rules: MatchingRules { rules: {} }, generators: Generators { categories: {} } }"}

Ideally, this is pretty printed and logged to console (or whatever logging framework is configured). For example, in Pact JS it would be something like this:

Copy code

Mock server failed with the following mismatches:

	0) The following request was incorrect:

            	POST /test

			 1.0 	$: Failed to parse the expected body as a MIME multipart body: 'no boundary in content-type'

pact-foundation/pact-net

Shiva Kumar

11/30/2023, 9:39 AM

Hi, I'm getting pact verification failure error like below. Unable to connect service url and it is refusing it. Can any one help me out , how to resolve below error. Thanks in advance.

Copy code

{
  "providerName": "DocumentArtifact",
  "providerApplicationVersion": "1",
  "success": false,
  "verificationDate": "2023-11-30T09:31:21+00:00",
  "testResults": [
    {
      "exceptions": [
        {
          "message": "error sending request for url (<http://localhost:9223/api/v1/api/v1/artifact/d4ebdf49-fff0-4968-a6b0-e7bc27072c64>): error trying to connect: tcp connect error: No connection could be made because the target machine actively refused it. (os error 10061)"
        }
      ],
      "interactionId": "f7ba0fa997611c33ada03b17e453118d3dfbac56",
      "success": false
    }
  ],
  "verifiedBy": {
    "implementation": "Pact-Rust",
    "version": "1.0.4"
  },

Eddie Stanley

11/30/2023, 8:58 PM

When I run

.Verify

if contract verification fails then a

PactFailureException

is thrown. Will results still be published to the broker in this case, though? Is it safe to swallow this exception?