Skip to content

feat: add url query tests for Refit.Tests/RestService #1904

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ChrisPulman merged 3 commits into from
Nov 3, 2024
Merged

feat: add url query tests for Refit.Tests/RestService #1904

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
09e333e
feat: add url query tests for `Refit.Tests/RestService`
TimothyMakkison Nov 1, 2024
ec56242
Merge branch 'main' into url_query_tests
ChrisPulman Nov 3, 2024
5938446
Merge branch 'main' into url_query_tests
ChrisPulman Nov 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
210 changes: 210 additions & 0 deletions Refit.Tests/RestService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,6 +273,36 @@ public interface IValidApi
Task Get();
}

public interface IQueryApi
{
[Get("/foo?")]
Task EmptyQuery();

[Get("/foo? ")]
Task WhiteSpaceQuery();

[Get("/foo?=value")]
Task EmptyQueryKey();

[Get("/foo?key=")]
Task EmptyQueryValue();

[Get("/foo?=")]
Task EmptyQueryKeyAndValue();

[Get("/foo?&&&")]
Task QueryManyAndSymbol();

[Get("/foo?key,=value,&key1(=value1(")]
Task UnescapedQuery();

[Get("/foo?key%2C=value%2C&key1%28=value1%28")]
Task EscapedQuery();

[Get("/foo?{key}={value}")]
Task ParameterMappedQuery(string key, string value);
}

public class HttpBinGet
{
public Dictionary<string, object> Args { get; set; }
Expand Down Expand Up @@ -2215,6 +2245,186 @@ public void NonGenericCreate()
Assert.Equal(fixture.Client.BaseAddress.AbsoluteUri, expectedBaseAddress);
}

[Fact]
public async Task EmptyQueryShouldBeEmpty()
{
var mockHttp = new MockHttpMessageHandler();
var settings = new RefitSettings { HttpMessageHandlerFactory = () => mockHttp, };

mockHttp
.Expect(HttpMethod.Get, "https://github.com/foo?")
.WithExactQueryString("")
.Respond(HttpStatusCode.OK);

var fixture = RestService.For<IQueryApi>("https://github.com", settings);

await fixture.EmptyQuery();

mockHttp.VerifyNoOutstandingExpectation();
}

[Fact]
public async Task WhiteSpaceQueryShouldBeEmpty()
{
var mockHttp = new MockHttpMessageHandler();
var settings = new RefitSettings { HttpMessageHandlerFactory = () => mockHttp, };

mockHttp
.Expect(HttpMethod.Get, "https://github.com/foo?")
.WithExactQueryString("")
.Respond(HttpStatusCode.OK);

var fixture = RestService.For<IQueryApi>("https://github.com", settings);

await fixture.WhiteSpaceQuery();

mockHttp.VerifyNoOutstandingExpectation();
}

[Fact]
public async Task EmptyQueryKeyShouldBeEmpty()
{
var mockHttp = new MockHttpMessageHandler();
var settings = new RefitSettings { HttpMessageHandlerFactory = () => mockHttp, };

mockHttp
.Expect(HttpMethod.Get, "https://github.com/foo?")
.WithExactQueryString("")
.Respond(HttpStatusCode.OK);

var fixture = RestService.For<IQueryApi>("https://github.com", settings);

await fixture.EmptyQueryKey();

mockHttp.VerifyNoOutstandingExpectation();
}

[Fact]
public async Task EmptyQueryValueShouldNotBeEmpty()
{
var mockHttp = new MockHttpMessageHandler();
var settings = new RefitSettings { HttpMessageHandlerFactory = () => mockHttp, };

mockHttp
.Expect(HttpMethod.Get, "https://github.com/foo?key=")
.WithExactQueryString("key=")
.Respond(HttpStatusCode.OK);

var fixture = RestService.For<IQueryApi>("https://github.com", settings);

await fixture.EmptyQueryValue();

mockHttp.VerifyNoOutstandingExpectation();
}

[Fact]
public async Task EmptyQueryKeyAndValueShouldBeEmpty()
{
var mockHttp = new MockHttpMessageHandler();
var settings = new RefitSettings { HttpMessageHandlerFactory = () => mockHttp, };

mockHttp
.Expect(HttpMethod.Get, "https://github.com/foo?")
.WithExactQueryString("")
.Respond(HttpStatusCode.OK);

var fixture = RestService.For<IQueryApi>("https://github.com", settings);

await fixture.EmptyQueryKeyAndValue();

mockHttp.VerifyNoOutstandingExpectation();
}

[Fact]
public async Task QueryAndSymbolShouldBeEmpty()
{
var mockHttp = new MockHttpMessageHandler();
var settings = new RefitSettings { HttpMessageHandlerFactory = () => mockHttp, };

mockHttp
.Expect(HttpMethod.Get, "https://github.com/foo?&&&")
.WithExactQueryString("&&&")
.Respond(HttpStatusCode.OK);

var fixture = RestService.For<IQueryApi>("https://github.com", settings);

await fixture.QueryManyAndSymbol();

mockHttp.VerifyNoOutstandingExpectation();
}

[Fact]
public async Task UnescapedQueryShouldBeEscaped()
{
var mockHttp = new MockHttpMessageHandler();
var settings = new RefitSettings { HttpMessageHandlerFactory = () => mockHttp, };

mockHttp
.Expect(HttpMethod.Get, "https://github.com/foo")
.WithExactQueryString("key%2C=value%2C&key1%28=value1%28")
.Respond(HttpStatusCode.OK);

var fixture = RestService.For<IQueryApi>("https://github.com", settings);

await fixture.UnescapedQuery();

mockHttp.VerifyNoOutstandingExpectation();
}

[Fact]
public async Task EscapedQueryShouldStillBeEscaped()
{
var mockHttp = new MockHttpMessageHandler();
var settings = new RefitSettings { HttpMessageHandlerFactory = () => mockHttp, };

mockHttp
.Expect(HttpMethod.Get, "https://github.com/foo")
.WithExactQueryString("key%2C=value%2C&key1%28=value1%28")
.Respond(HttpStatusCode.OK);

var fixture = RestService.For<IQueryApi>("https://github.com", settings);

await fixture.EscapedQuery();

mockHttp.VerifyNoOutstandingExpectation();
}

[Fact]
public async Task ParameterMappedQueryShouldWork()
{
var mockHttp = new MockHttpMessageHandler();
var settings = new RefitSettings { HttpMessageHandlerFactory = () => mockHttp, };

mockHttp
.Expect(HttpMethod.Get, "https://github.com/foo")
.WithExactQueryString("key1=value1")
.Respond(HttpStatusCode.OK);

var fixture = RestService.For<IQueryApi>("https://github.com", settings);

await fixture.ParameterMappedQuery("key1", "value1");

mockHttp.VerifyNoOutstandingExpectation();
}

[Fact]
public async Task ParameterMappedQueryShouldEscape()
{
var mockHttp = new MockHttpMessageHandler();
var settings = new RefitSettings { HttpMessageHandlerFactory = () => mockHttp, };

mockHttp
.Expect(HttpMethod.Get, "https://github.com/foo")
.WithExactQueryString("key1%2C=value1%2C")
.Respond(HttpStatusCode.OK);

var fixture = RestService.For<IQueryApi>("https://github.com", settings);

await fixture.ParameterMappedQuery("key1,", "value1,");

mockHttp.VerifyNoOutstandingExpectation();
}

[Fact]
public async Task TypeCollisionTest()
{
Expand Down