WireMock.Net-wiremock/test/WireMock.Net.Tests/RequestBuilders/RequestBuilderTests.cs

// Copyright © WireMock.Net


using WireMock.Matchers.Request;
using WireMock.Models;
using WireMock.Owin;
using WireMock.RequestBuilders;
using WireMock.Types;
using WireMock.Util;

namespace WireMock.Net.Tests.RequestBuilders;

public class RequestBuilderTests
{
    private const string ClientIp = "::1";

    [Fact]
    public void Should_exclude_requests_matching_given_http_method_but_not_url()
    {
        // given
        var spec = Request.Create().WithPath("/bar").UsingPut();

        // when
        var request = new RequestMessage(new UrlDetails("http://localhost/foo"), "PUT", ClientIp);

        // then
        var requestMatchResult = new RequestMatchResult();
        spec.GetMatchingScore(request, requestMatchResult).Should().NotBe(1.0);
    }

    [Fact]
    public void Should_exclude_requests_not_matching_given_headers()
    {
        // given
        var spec = Request.Create().UsingAnyMethod().WithHeader("X-toto", "tatata");

        // when
        var body = new BodyData
        {
            BodyAsString = "whatever",
            DetectedBodyType = BodyType.String
        };
        var request = new RequestMessage(new UrlDetails("http://localhost/foo"), "PUT", ClientIp, body, new Dictionary<string, string[]> { { "X-toto", new[] { "tata" } } });

        // then
        var requestMatchResult = new RequestMatchResult();
        spec.GetMatchingScore(request, requestMatchResult).Should().NotBe(1.0);
    }

    [Fact]
    public void Should_exclude_requests_not_matching_given_headers_ignorecase()
    {
        // given
        var spec = Request.Create().UsingAnyMethod().WithHeader("X-toto", "abc", false);

        // when
        var body = new BodyData
        {
            BodyAsString = "whatever",
            DetectedBodyType = BodyType.String
        };
        var request = new RequestMessage(new UrlDetails("http://localhost/foo"), "PUT", ClientIp, body, new Dictionary<string, string[]> { { "X-toto", new[] { "ABC" } } });

        // then
        var requestMatchResult = new RequestMatchResult();
        spec.GetMatchingScore(request, requestMatchResult).Should().NotBe(1.0);
    }

    [Fact]
    public void Should_specify_requests_matching_given_header_prefix()
    {
        // given
        var spec = Request.Create().UsingAnyMethod().WithHeader("X-toto", "tata*");

        // when
        var body = new BodyData
        {
            BodyAsString = "whatever",
            DetectedBodyType = BodyType.String
        };
        var request = new RequestMessage(new UrlDetails("http://localhost/foo"), "PUT", ClientIp, body, new Dictionary<string, string[]> { { "X-toto", new[] { "TaTa" } } });

        // then
        var requestMatchResult = new RequestMatchResult();
        spec.GetMatchingScore(request, requestMatchResult).Should().Be(1.0);
    }

    [Fact]
    public void Should_specify_requests_matching_given_wildcard_header()
    {
        // given
        var spec = Request.Create().UsingAnyMethod().WithHeader("X-toto", "*");

        // when
        var body = new BodyData
        {
            BodyAsString = "whatever",
            DetectedBodyType = BodyType.String
        };
        var request = new RequestMessage(new UrlDetails("http://localhost/foo"), "PUT", ClientIp, body, new Dictionary<string, string[]> { { "X-toto", new[] { "TaTa" } } });

        // then
        var requestMatchResult = new RequestMatchResult();
        spec.GetMatchingScore(request, requestMatchResult).Should().Be(1.0);
    }

    [Fact]
    public void Should_specify_requests_not_matching_given_wildcard_header2()
    {
        // given
        var spec = Request.Create().UsingAnyMethod().WithHeader("X-toto", "*");

        // when
        var body = new BodyData
        {
            BodyAsString = "whatever",
            DetectedBodyType = BodyType.String
        };
        var request = new RequestMessage(new UrlDetails("http://localhost/foo"), "PUT", ClientIp, body, new Dictionary<string, string[]> { { "X-tata", new[] { "ToTo" } } });

        // then
        var requestMatchResult = new RequestMatchResult();
        spec.GetMatchingScore(request, requestMatchResult).Should().Be(0.0);
    }

    [Fact]
    public void Should_specify_requests_matching_given_wildcard_header_rejectonmatch()
    {
        // given
        var spec = Request.Create().UsingAnyMethod().WithHeader("X-toto", "*", WireMock.Matchers.MatchBehaviour.RejectOnMatch);

        // when
        var body = new BodyData
        {
            BodyAsString = "whatever",
            DetectedBodyType = BodyType.String
        };
        var request = new RequestMessage(new UrlDetails("http://localhost/foo"), "PUT", ClientIp, body, new Dictionary<string, string[]> { { "X-tata", new[] { "ToTo" } } });

        // then
        var requestMatchResult = new RequestMatchResult();
        spec.GetMatchingScore(request, requestMatchResult).Should().Be(1.0);
    }

    [Fact]
    public void Should_specify_requests_not_matching_given_wildcard_header_rejectonmatch()
    {
        // given
        var spec = Request.Create().UsingAnyMethod().WithHeader("X-toto", "*", WireMock.Matchers.MatchBehaviour.RejectOnMatch);

        // when
        var body = new BodyData
        {
            BodyAsString = "whatever",
            DetectedBodyType = BodyType.String
        };
        var request = new RequestMessage(new UrlDetails("http://localhost/foo"), "PUT", ClientIp, body, new Dictionary<string, string[]> { { "X-toto", new[] { "TaTa" } } });

        // then
        var requestMatchResult = new RequestMatchResult();
        spec.GetMatchingScore(request, requestMatchResult).Should().Be(0.0);
    }

    [Fact]
    public void Should_specify_requests_matching_given_body()
    {
        // given
        var spec = Request.Create().UsingAnyMethod().WithBody("Hello world!");

        // when
        var body = new BodyData
        {
            BodyAsString = "Hello world!",
            DetectedBodyType = BodyType.String
        };
        var request = new RequestMessage(new UrlDetails("http://localhost/foo"), "PUT", ClientIp, body);

        // then
        var requestMatchResult = new RequestMatchResult();
        spec.GetMatchingScore(request, requestMatchResult).Should().Be(1.0);
    }

    [Fact]
    public void Should_exclude_requests_not_matching_given_body()
    {
        // given
        var spec = Request.Create().UsingAnyMethod().WithBody("      Hello world!   ");

        // when
        var body = new BodyData
        {
            BodyAsString = "xxx",
            DetectedBodyType = BodyType.String
        };
        var request = new RequestMessage(new UrlDetails("http://localhost/foo"), "PUT", ClientIp, body, new Dictionary<string, string[]> { { "X-toto", new[] { "tata" } } });

        // then
        var requestMatchResult = new RequestMatchResult();
        spec.GetMatchingScore(request, requestMatchResult).Should().NotBe(1.0);
    }

    [Fact]
    public void Should_specify_requests_matching_given_param()
    {
        // given
        var spec = Request.Create().WithParam("bar", "1", "2");

        // when
        var request = new RequestMessage(new UrlDetails("http://localhost/foo?bar=1&bar=2"), "PUT", ClientIp);

        // then
        var requestMatchResult = new RequestMatchResult();
        spec.GetMatchingScore(request, requestMatchResult).Should().Be(1.0);
    }

    [Fact]
    public void Should_specify_requests_matching_given_param_WithComma()
    {
        // given
        var options = new WireMockMiddlewareOptions
        {
            QueryParameterMultipleValueSupport = QueryParameterMultipleValueSupport.NoComma
        };
        var spec = Request.Create().WithParam("$filter", "startswith(name,'testName')");

        // when
        var request = new RequestMessage(options, new UrlDetails("http://localhost/?$filter=startswith(name,'testName')"), "PUT", ClientIp);

        // then
        var requestMatchResult = new RequestMatchResult();
        spec.GetMatchingScore(request, requestMatchResult).Should().Be(1.0);
    }

    [Fact]
    public void Should_specify_requests_matching_given_param_func()
    {
        // given
        var spec = Request.Create().UsingAnyMethod().WithParam(p => p.ContainsKey("bar"));

        // when
        var request = new RequestMessage(new UrlDetails("http://localhost/foo?bar=1&bar=2"), "PUT", ClientIp);

        // then
        var requestMatchResult = new RequestMatchResult();
        spec.GetMatchingScore(request, requestMatchResult).Should().Be(1.0);
    }

    [Fact]
    public void Should_exclude_requests_not_matching_given_params()
    {
        // given
        var spec = Request.Create().WithParam("bar", "1");

        // when
        var request = new RequestMessage(new UrlDetails("http://localhost/test=7"), "PUT", ClientIp);

        // then
        var requestMatchResult = new RequestMatchResult();
        spec.GetMatchingScore(request, requestMatchResult).Should().NotBe(1.0);
    }
}