Bug: IRequestBuilder.WithParam broken for key-only matching

[benjamin-bader]

I just upgraded our wiremock-net from 1.0.2.3 to 1.0.4.2 and noticed that a few tests that were working have broken. This request matcher no longer works:

server.Given(Request.Create()
            .WithPath("/api/incidents/search")
            .WithParam("q")
            .UsingGet())
        .RespondWith(Response.Create()
            .WithStatusCode(200)
            .WithBodyAsJson(new Dictionary<string, object>
            {
                ["text"] = "[email protected]",
                ["results"] = new object[0]
            }));

The test issues an HTTP request like GET /api/incidents/[email protected]. In 1.0.2.3, this request was matched by the server, but not in 1.0.4.2. If I change the builder such that I call .WithParam("q", "[email protected]"), it works.

This seems like a regression, given that the API hasn't changed as far as I can tell.

[StefH]

This seems like a bug, I'll investigate.

[StefH]

New code can be used like:

server
	.Given(Request
		.Create()
		.WithPath(new WildcardMatcher("/param2", true))
		.WithParam("key", "test")
		.UsingGet())
	.RespondWith(Response.Create()
		.WithHeader("Content-Type", "application/json")
		.WithBodyAsJson(new { result = "param2" }));

server
	.Given(Request
		.Create()
		.WithPath(new WildcardMatcher("/param3", true))
		.WithParam("key", new WildcardMatcher("t*"))
		.UsingGet())
	.RespondWith(Response.Create()
		.WithHeader("Content-Type", "application/json")
		.WithBodyAsJson(new { result = "param3" }));

See also linked code or branch : https://github.com/WireMock-Net/WireMock.Net/tree/Fix_IRequestBuilder.WithParam

[benjamin-bader]

Cool, thanks. Looks like the original usage will work in the next release - is that correct?

[StefH]

Correct the C# code will be backwards compatible.

However the mapping JSON be changed and looks like:

{
    "Guid": "63f84226-8c13-483f-946c-9008cca9555e",
    "Priority": 0,
    "Request": {
        "Path": {
            "Matchers": [
                {
                    "Name": "WildcardMatcher",
                    "Pattern": "/param3",
                    "IgnoreCase": true
                }
            ]
        },
        "Methods": [
            "get"
        ],
        "Params": [
            {
                "Name": "key",
                "Matchers": [
                    {
                        "Name": "WildcardMatcher",
                        "Pattern": "t*",
                        "IgnoreCase": false
                    }
                ]
            }
        ]
}

(You can use a WildcardMatcher, RegExMatcher, ExactMatcher or whatever.)

[benjamin-bader]

Awesome - thanks for the advice and for the quick fix!

[StefH]

NuGet is created