Verifying a pact between Web-PermissionsModule and Customers-API Given user does not exist - request to create user

[ibrar434]

@akamud

edit: don’t tag maintainers in issues!

I updated my pactnet From 4.5.0 to 5.0.1 but all the test which work pefectly fine in previous version which is front end related but now is making issue
these are also api test where grpc calls inculdes

Frontend side code for generating files

i just change in ApiProivdertest

Exception is this

Same Code works in previous but now after updating file not work and gives this exception
if anyone have idea please let me know and help

[YOU54F]

Hmm, that looks like it should work.

Could you share the pact file that is being verified? I just want to check the matchers that are being serialised

The matcher looks correct in the consumer test, but does not look like it is being checked on the verifier side

Could you share code snippets and the log output from the verifier please rather than photos, as they are not searchable.

I also amended your original post, to take out the maintainer tags. We are open-source volunteers working in our free time, and will aim to get to posts as and when we can :) We would ask kindly if you could refrain from tagging maintainers in future, we get notifications of new issues, via GH notifications / and the pact-foundation slack language appropriate channel.

This one popped up in pact-net :) https://pact-foundation.slack.com/archives/C9UTHV2AD

[ibrar434]

Okay Sorry For Tagging I will be careful next time

Here is my Consumer code
describe('POST customers/users', () => {
it('returns an HTTP 202 and location header', () => {
provider
.given('user does not exist')
.uponReceiving('request to create user')
.withRequest({
method: 'POST',
path: '/customers/users',
body: {
username: 'AZE0001',
agencyId: 'c46334f9-20ae-4193-8de1-f6eaa042f2cb',
title: 'Mr',
forename: 'John',
surname: 'Smith',
email: 'here@there.com',
telephone: '1234567',
additionalEmail: 'here@there.com',
createPermissions: true
}
})
.willRespondWith({
status: 202,
headers: {
location: MatchersV3.regex(
/customers/users/requeststatus?id=[0-9a-f-]{36}/,
'customers/users/requeststatus?id=6fe87dd4-bfdb-469d-8815-fc5bf09d0abd')
}
});

        return provider.executeTest(async () => {
            const res = service.createUser({
                username: 'AZE0001',
                agencyId: 'c46334f9-20ae-4193-8de1-f6eaa042f2cb',
                title: 'Mr',
                forename: 'John',
                surname: 'Smith',
                email: 'here@there.com',
                telephone: '1234567',
                additionalEmail: 'here@there.com',
                createPermissions: true
            } as CreateUserRequest);

            const response = await firstValueFrom(res);

            expect(response).toBeDefined();
        });
    });
});

Here is my Provider Side Code

// -----------------------------------------------------------------------
//
// Copyright (c) Calrom Limited. All rights reserved.
//
// -----------------------------------------------------------------------

namespace Calrom.Customers.IntegrationTests.Contract.Api.Provider
{
using System;
using Calrom.Customers.Infrastructure.Context;
using Calrom.Customers.IntegrationTests.Mock;
using Calrom.Customers.IntegrationTests.Setup;
using Calrom.Testing.Pact.Provider;
using Calrom.Testing.Pact.State;
using Microsoft.Extensions.DependencyInjection;
using Moq;
using NUnit.Framework;
using PactNet.Infrastructure.Outputters;
using PactNet.Verifier;

/// <summary>
/// The API provider tests.
/// </summary>
public class ApiProviderTests
{
    private readonly string proxyUrl = "http://127.0.0.1:9002";

    private readonly PactVerifierConfig config = new()
    {
        LogLevel = PactNet.PactLogLevel.Debug,
        Outputters = new List<IOutput>
        {
            new NUnitOutput(),
        },
    };

    /// <summary>
    /// Tests that it honours pact.
    /// </summary>
    /// <param name="filepath">The file path.</param>
    /// <returns>the task.</returns>
    [Test]
    [TestCaseSource(nameof(GetFiles))]
    public async Task CustomersHonoursPact(string filepath)
    {
        using var fixture = await TestServerFixture.Start<TestStartup>();

        ConfigureDbSet(fixture);
        using var testHarness = fixture.TestServer.Services.StartMassTransitTestHarness();

        using var proxy = ProxyProviderTestServer
            .Create(fixture.TestServer)
            .AddGrpcClient<Contacts.ContactsClient>((client, config) =>
            {
                config.Adapt<UserContactsRequest, List_UserContact>(
                    "/Calrom.Customers.Contacts/GetContacts",
                    async (request) => await client.GetContactsAsync(request));
            })
             .AddHttpProxy("/customers/", options =>
             {
                 options.RewriteUrl(@"\/customers\/", "/api/");
             })
            .Run(this.proxyUrl);

        // verify pacts
        IPactVerifier pactVerifier = new PactVerifier("Customers-API", this.config);

        var providerStateUri = ProviderStateEndpoints.GetStateUri(this.proxyUrl);

        var provider = pactVerifier.WithHttpEndpoint(new Uri(this.proxyUrl));
        IPactVerifierSource source;

        if (PactSettings.IsPublishResults)
        {
            source = provider
                .WithPactBrokerSource(PactSettings.BrokerUri, options =>
                {
                    options.ProviderBranch(PactSettings.BranchName);
                    options.TokenAuthentication(PactSettings.AuthenticationToken);
                    options
                        .ConsumerVersionSelectors(
                            new ConsumerVersionSelector
                            {
                                Branch = "refs/heads/main",
                            },
                            new ConsumerVersionSelector
                            {
                                MatchingBranch = true,
                            })
                        .PublishResults(true, PactSettings.BuildVersion, results =>
                        {
                            results.ProviderBranch(PactSettings.BranchName);
                        });
                });

            source
                .WithProviderStateUrl(providerStateUri)
                .Verify();
        }
        else
        {
                source = provider.WithFileSource(new FileInfo(filepath));
                source
                    .WithProviderStateUrl(providerStateUri)
                    .Verify();
        }
    }

    /// <summary>
    /// Gets the pact files and sets custom test names without file paths.
    /// </summary>
    private static IEnumerable<TestCaseData> GetFiles()
    {
        foreach (var file in Directory.GetFiles($"../../../../../../Pacts/Customers").Where(f => f.EndsWith("Customers-API.json")))
        {
            // Extract the file name without the path and extension
            var fileName = Path.GetFileNameWithoutExtension(file);

            // Set the custom test name based on the file name
            yield return new TestCaseData(file).SetName($"{fileName}");
        }
    }

    private static void ConfigureDbSet(TestServerFixture fixture)
    {
        var customersContext = fixture.TestServer.Services.GetRequiredService<Mock<ICustomersContext>>();
        _ = MockUsersSetup.SetupUsers(customersContext, true);
    }
}

}

here is the File Genrated after consumer side code run
{
"consumer": {
"name": "Web-PermissionsModule"
},
"interactions": [
{
"description": "request to create user",
"providerStates": [
{
"name": "user does not exist"
}
],
"request": {
"body": {
"agencyId": "c46334f9-20ae-4193-8de1-f6eaa042f2cb",
"email": "here@there.com",
"forename": "John",
"surname": "Smith",
"title": "Mr",
"username": "AZE0001"
},
"headers": {
"Content-Type": "application/json"
},
"method": "POST",
"path": "/customers/users"
},
"response": {
"headers": {
"location": "customers/users/requeststatus?id=6fe87dd4-bfdb-469d-8815-fc5bf09d0abd"
},
"matchingRules": {
"header": {
"$.location": {
"combine": "AND",
"matchers": [
{
"match": "regex",
"regex": "customers\/users\/requeststatus\?id=[0-9a-f-]{36}"
}
]
}
}
},
"status": 202
}
},
{
"description": "request for user",
"providerStates": [
{
"name": "user exists"
}
],
"request": {
"method": "GET",
"path": "/customers/users/113c6b65-2784-4463-a88a-d6cd377b7ad4"
},
"response": {
"body": {
"additionalEmail": "another@there.com",
"agencyId": "2d7abcc0-aa6d-46dd-8a00-e7cec6c864f2",
"agencyName": "Test Agency",
"contacts": {
"email": "here@there.com",
"telephone": "01234 567567"
},
"forename": "John",
"id": "113c6b65-2784-4463-a88a-d6cd377b7ad4",
"surname": "Smith",
"title": "Mr",
"username": "ABC0000"
},
"headers": {
"Content-Type": "application/json"
},
"matchingRules": {
"body": {
"$.additionalEmail": {
"combine": "AND",
"matchers": [
{
"match": "type"
}
]
},
"$.agencyId": {
"combine": "AND",
"matchers": [
{
"match": "type"
}
]
},
"$.agencyName": {
"combine": "AND",
"matchers": [
{
"match": "type"
}
]
},
"$.contacts.email": {
"combine": "AND",
"matchers": [
{
"match": "type"
}
]
},
"$.contacts.telephone": {
"combine": "AND",
"matchers": [
{
"match": "type"
}
]
},
"$.forename": {
"combine": "AND",
"matchers": [
{
"match": "type"
}
]
},
"$.id": {
"combine": "AND",
"matchers": [
{
"match": "type"
}
]
},
"$.surname": {
"combine": "AND",
"matchers": [
{
"match": "type"
}
]
},
"$.title": {
"combine": "AND",
"matchers": [
{
"match": "type"
}
]
},
"$.username": {
"combine": "AND",
"matchers": [
{
"match": "type"
}
]
}
},
"header": {}
},
"status": 200
}
},
{
"description": "request for user info",
"providerStates": [
{
"name": "user exists"
}
],
"request": {
"method": "GET",
"path": "/customers/users/info",
"query": {
"username": [
"ABC0000"
]
}
},
"response": {
"body": {
"userId": "113c6b65-2784-4463-a88a-d6cd377b7ad4",
"username": "ABC0000"
},
"headers": {
"Content-Type": "application/json"
},
"matchingRules": {
"body": {
"$.userId": {
"combine": "AND",
"matchers": [
{
"match": "type"
}
]
},
"$.username": {
"combine": "AND",
"matchers": [
{
"match": "type"
}
]
}
},
"header": {}
},
"status": 200
}
},
{
"description": "request to update user",
"providerStates": [
{
"name": "user exists"
}
],
"request": {
"body": {
"additionalEmail": "another@there.com",
"email": "here@there.com",
"forename": "John",
"surname": "Smith",
"title": "Mr"
},
"headers": {
"Content-Type": "application/json"
},
"method": "PUT",
"path": "/customers/users/113c6b65-2784-4463-a88a-d6cd377b7ad4"
},
"response": {
"headers": {
"Content-Type": "application/json"
},
"status": 200
}
},
{
"description": "request for users",
"providerStates": [
{
"name": "users exist"
}
],
"request": {
"method": "GET",
"path": "/customers/users",
"query": {
"agencyid": [
"2d7abcc0-aa6d-46dd-8a00-e7cec6c864f2"
],
"crmid": [
"WH00579"
],
"forenamesurname": [
"John"
],
"pageindex": [
"0"
],
"pagesize": [
"10"
],
"sortasc": [
"true"
],
"sorting": [
"agencyTradingName"
],
"username": [
"ABC0000"
]
}
},
"response": {
"body": {
"items": [
{
"agencyCrmId": "WH00579",
"agencyIATA": "12345",
"agencyId": "2d7abcc0-aa6d-46dd-8a00-e7cec6c864f2",
"agencyLegalName": "Test Operator",
"email": "here@there.com",
"fullName": "Mr John Smith",
"id": "113c6b65-2784-4463-a88a-d6cd377b7ad4",
"username": "ABC0000"
}
],
"totalCount": 1
},
"headers": {
"Content-Type": "application/json"
},
"matchingRules": {
"body": {
"$.items": {
"combine": "AND",
"matchers": [
{
"match": "type"
}
]
},
"$.items[].agencyCrmId": {
"combine": "AND",
"matchers": [
{
"match": "type"
}
]
},
"$.items[].agencyIATA": {
"combine": "AND",
"matchers": [
{
"match": "type"
}
]
},
"$.items[].agencyId": {
"combine": "AND",
"matchers": [
{
"match": "type"
}
]
},
"$.items[].agencyLegalName": {
"combine": "AND",
"matchers": [
{
"match": "type"
}
]
},
"$.items[].email": {
"combine": "AND",
"matchers": [
{
"match": "type"
}
]
},
"$.items[].fullName": {
"combine": "AND",
"matchers": [
{
"match": "type"
}
]
},
"$.items[].id": {
"combine": "AND",
"matchers": [
{
"match": "type"
}
]
},
"$.items[].username": {
"combine": "AND",
"matchers": [
{
"match": "type"
}
]
}
},
"header": {}
},
"status": 200
}
}
],
"metadata": {
"pact-js": {
"version": "10.1.2"
},
"pactRust": {
"ffi": "0.3.9",
"models": "0.4.5"
},
"pactSpecification": {
"version": "3.0.0"
}
},
"provider": {
"name": "Customers-API"
}
}

the line which making issue is
"response": {
"headers": {
"location": "customers/users/requeststatus?id=6fe87dd4-bfdb-469d-8815-fc5bf09d0abd"
},

[YOU54F]

I have a sneaky feeling this is fixed in a later ffi and the matching rule is the pact isn't correctly applied looking at some history

pact-foundation/pact-reference#238

the pact was generated with an older version of pact-js and uses a much older version of the ffi.

is it possible to upgrade the consumer to the latest version of pact-js, diff the pacts and reattempt a provider verification?

The alternative is to setup a simple repro in pact-js by taking one of our public examples

https://github.com/pactflow/example-consumer

to generate a pact with the version you have (10.1.2) and the latest (16.0.0), and see if the contents differ.