Pact weird behaviour in the contract if same test is present in two class files for same consumer and provider pair.

[OmkarSharan]

I was writing this scenario, where accidently I had written the a test case in two different class with same consumer and provider pair which is having Authorization header in the api request.

So when I publish the contract from one test class, contract was perfectly fine, but when I ran the second test class with exact same test case and publish the contract there was extra space coming in the authorization header.

Not sure why this happen?

[mefellows]

Can you please share a repro or more details? It's hard to understand the problem without seeing code, or something that can reproduce the problem.

[OmkarSharan]

I do not have repo but here is the steps to reproduce. It is Java Micronaut project.

1. Create class A like below code. in the RequestResponsePact builder have this value for uponReceiving : GET expense summary with valid JWT from consumer
2. Create class B and add the same code there as well. But only change the value of uponReceiving : GET expense details with valid JWT from cosnumer
3. Run the test from class A and publishe the contract. Now if you check the contract it will be perfectly file. I want to focus on Authorization part. Here how Authorization is looking into the contract.

Authorization : Bearer service=abschsdjan.dummy-service,customer=kjhskfhskh.dummy-cust

5. But when running the test from class B and publishing the contract on broker. There is space getting added for the Authorization part. For Get /cash/payout/expense/summary and below how Authorization is looking after test case run in Class B. You will observe there is a space before customer.

Authorization : Bearer service=abschsdjan.dummy-service, customer=kjhskfhskh.dummy-cust

6. If you obser since both class have same consumer name and provider name and even they are writing the same test case, some how space is getting added in the authorization header.

Here is the code snippet :

@MicronautTest
@ExtendWith(PactConsumerTestExt.class)
@MockServerConfig(hostInterface = "localhost", port = "9292")
@PactTestFor(providerName = "provider", pactVersion = PactSpecVersion.V3)
public class A {

@Inject
@client("/")
HttpClient client;

@Pact(provider = "consumer", consumer = "provider")
public RequestResponsePact getExpenseSummaryWithAuthPact(PactDslWithProvider builder) {
PactDslJsonBody responseBody = new PactDslJsonBody()
.stringType("employeeId", "e12345")
.decimalType("totalAmount", 229.75)
.stringType("currency", "GBP");

    return builder
            .given("Authorized user requests expense summary")
            .uponReceiving("GET expense summary with valid JWT from consumer")
            .method("GET")
            .path("/cash/payout/expense/summary")
            .matchHeader(HttpHeaders.AUTHORIZATION, "Bearer service=([^\\s,]+),customer=([^\\s]+)$", "Bearer service=abschsdjan.dummy-service,customer=kjhskfhskh.dummy-cust")
            .willRespondWith()
            .status(200)
            .headers(Map.of("Content-Type", "application/json"))
            .body(responseBody)
            .toPact();
}

@PactTestFor(pactMethod = "getExpenseSummaryWithAuthPact")
@Test
void testGetExpenseSummaryWithAuth(MockServer mockServer) {
    HttpRequest<?> request = HttpRequest.GET(mockServer.getUrl() + "/cash/payout/expense/summary")
            .header(HttpHeaders.AUTHORIZATION, "Bearer service=abschsdjan.dummy-service,customer=kjhskfhskh.dummy-cust");

    String response = client.toBlocking().retrieve(request);
    assertNotNull(response);
}

}

[mefellows]

Oh, this is for Pact JVM not Pact .NET? I'll move the issue to that repository.

I'd suggest creating a minimal example Java test that can reproduce the exact problem, once you have created that, the issue should be easier to track down.

[OmkarSharan]

You want me create a repository and share here? I feel waht I have given that is bare minimum example only.

[mefellows]

Yes please, that would be great. See https://stackoverflow.com/help/minimal-reproducible-example for guidance on creating repros more generally.

[OmkarSharan]

@mefellows Here is the Git repo where you can reproduce the issue : https://github.com/OmkarSharan/Pact-testing

[mefellows]

Fantastic - thanks for that!

[mefellows]

Thank you, I can confirm it produces the error you described.

Interestingly, if I change the name of the provider in one of the tests, the header is serialised correctly!

[OmkarSharan]

@mefellows What would be the timeline for this bug get fixed?

[OmkarSharan]

Hello, when can we expect the fix for the issue?

[mefellows]

We don't have any timelines for this at this stage, but if you'd like to contribute we would most certainly welcome a PR. Is that something you would be open to contributing?