refactor(tests): use Shouldly for assertions (#98)

* Refactor tests to use Shouldly for assertions

- Updated assertions in FluentHttpClientTest to use Shouldly for better readability.
- Refactored FluentHttpHeadersTest to replace traditional assertions with Shouldly.
- Modified FluentHttpRequestBuilderTest to utilize Shouldly for assertions.
- Changed assertions in HttpMiddlewareTest to use Shouldly for consistency.
- Updated FileUploadIntegrationTest to use Shouldly for response assertions.
- Refactored MessagePackIntegrationTest to utilize Shouldly for assertions.
- Changed ResponseCacheIntegrationTest assertions to use Shouldly for clarity.
- Updated SerilogIntegrationTest to use Shouldly for null checks and value assertions.
- Refactored LoggingHttpMiddlewareTest to use Shouldly for assertions.
- Updated TimerHttpMiddlewareTest to utilize Shouldly for assertions.
- Added Shouldly package reference to the test project.
- Included global using directive for Shouldly in GlobalUsings.cs.

* refactor: update test dependencies and improve test assertions

Author: stephenlautier

Directory.Packages.props

@@ -14,7 +14,7 @@
     <PackageVersion Include="Microsoft.Extensions.Logging.Abstractions" Version="10.0.6" />
     <PackageVersion Include="Microsoft.Extensions.DependencyInjection" Version="10.0.6" />
     <PackageVersion Include="Microsoft.Extensions.Logging" Version="10.0.6" />
-    <PackageVersion Include="Microsoft.Data.SqlClient" Version="6.1.1" />
+    <PackageVersion Include="Microsoft.Data.SqlClient" Version="7.0.0" />
     <PackageVersion Include="Microsoft.EntityFrameworkCore.SqlServer" Version="10.0.6" />
     <PackageVersion Include="Microsoft.AspNet.WebApi.Client" Version="6.0.0" />
     <!-- 3rd party -->
@@ -26,7 +26,8 @@
     <PackageVersion Include="Sketch7.Core" Version="0.2.0" />
     <!-- testing -->
     <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="18.4.0" />
-    <PackageVersion Include="xunit" Version="2.9.3" />
+    <PackageVersion Include="Shouldly" Version="4.3.0" />
+    <PackageVersion Include="xunit.v3" Version="3.2.2" />
     <PackageVersion Include="xunit.runner.visualstudio" Version="3.1.5" />
     <PackageVersion Include="RichardSzalay.MockHttp" Version="7.0.0" />
     <PackageVersion Include="Serilog.Extensions.Logging" Version="10.0.0" />

src/FluentlyHttpClient/Middleware/FluentHttpMiddlewareBuilder.cs

@@ -93,7 +93,7 @@ public IFluentHttpMiddlewareRunner Build(IFluentHttpClient httpClient)
 				}
 			}
 			else
-				ctor = new object[] { };
+				ctor = [];
 			var instance = (IFluentHttpMiddleware)ActivatorUtilities.CreateInstance(_serviceProvider, pipe.Type, ctor);
 
 			if (isFirst)

test/FluentHttpClientFactoryTest.cs

@@ -13,7 +13,7 @@ public void ShouldAllowEmptyBaseUrl()
 		var httpClient = GetNewClientFactory().CreateBuilder("abc")
 			.Build();
 
-		Assert.Null(httpClient.BaseUrl);
+		httpClient.BaseUrl.ShouldBeNull();
 	}
 }
 
@@ -30,7 +30,7 @@ public void AddFluentlyHttpClient_Defaults_ShouldBeSet()
 			.GetRequiredService<IFluentHttpClientFactory>();
 
 		var client = f.CreateBuilder("sketch7").Build();
-		Assert.Equal("default-config", client.Headers.UserAgent.ToString());
+		client.Headers.UserAgent.ToString().ShouldBe("default-config");
 	}
 
 
@@ -57,17 +57,13 @@ public void Build_RegisterMulti_ShouldNotReplacePrevious()
 		httpClientB.Headers.TryGetValues("X-S7", out var s7HeadersB);
 		httpClientA.Headers.TryGetValues("X-Org", out var orgHeadersB);
 
-		Assert.NotNull(orgHeadersA);
-		Assert.Single(orgHeadersA, "s7");
-		Assert.NotNull(s7HeadersA);
-		Assert.Single(s7HeadersA, "a");
-		Assert.Equal("dXNlcjpwYSQk", httpClientA.Headers.Authorization!.Parameter);
-
-		Assert.NotNull(orgHeadersB);
-		Assert.Single(orgHeadersB, "s7");
-		Assert.NotNull(s7HeadersB);
-		Assert.Single(s7HeadersB, "b");
-		Assert.Equal("dXNlci0yOnBhJCQ=", httpClientB.Headers.Authorization!.Parameter);
+		orgHeadersA.ShouldNotBeNull().ShouldHaveSingleItem().ShouldBe("s7");
+		s7HeadersA.ShouldNotBeNull().ShouldHaveSingleItem().ShouldBe("a");
+		httpClientA.Headers.Authorization!.Parameter.ShouldBe("dXNlcjpwYSQk");
+
+		orgHeadersB.ShouldNotBeNull().ShouldHaveSingleItem().ShouldBe("s7");
+		s7HeadersB.ShouldNotBeNull().ShouldHaveSingleItem().ShouldBe("b");
+		httpClientB.Headers.Authorization!.Parameter.ShouldBe("dXNlci0yOnBhJCQ=");
 	}
 
 	[Fact]
@@ -81,8 +77,8 @@ public void ShouldHaveWithCustomDefaultsSet()
 		var request = httpClient.CreateRequest("/api")
 			.Build();
 
-		Assert.NotNull(request);
-		Assert.Equal(HttpMethod.Put, request.Method);
+		request.ShouldNotBeNull();
+		request.Method.ShouldBe(HttpMethod.Put);
 	}
 
 	[Fact]
@@ -97,9 +93,9 @@ public void ShouldHaveCustomDefaultsCombined()
 		var request = httpClient.CreateRequest("/api")
 			.Build();
 
-		Assert.NotNull(request);
-		Assert.Equal(HttpMethod.Put, request.Method);
-		Assert.Equal("user", request.Items["context"]);
+		request.ShouldNotBeNull();
+		request.Method.ShouldBe(HttpMethod.Put);
+		request.Items["context"].ShouldBe("user");
 	}
 
 	[Fact]
@@ -114,9 +110,9 @@ public void ShouldHavePreviousCustomDefaultsReplaced()
 		var request = httpClient.CreateRequest("/api")
 			.Build();
 
-		Assert.NotNull(request);
-		Assert.Equal(HttpMethod.Get, request.Method);
-		Assert.Equal("user", request.Items["context"]);
+		request.ShouldNotBeNull();
+		request.Method.ShouldBe(HttpMethod.Get);
+		request.Items["context"].ShouldBe("user");
 	}
 
 	[Fact]
@@ -140,7 +136,7 @@ public void ShouldHaveQueryParamsDefaultsSet()
 			})
 			.Build();
 
-		Assert.Equal("/api/heroes?ROLES=warrior,assassin", request.Uri?.ToString());
+		request.Uri?.ToString().ShouldBe("/api/heroes?ROLES=warrior,assassin");
 	}
 
 	[Fact]
@@ -158,8 +154,8 @@ public void ShouldAppendToParentsBaseUrl()
 				.Build()
 			;
 
-		Assert.Equal("http://abc.com/v1/", subHttpClient.BaseUrl);
-		Assert.Equal("http://abc.com/", httpClient.BaseUrl);
+		subHttpClient.BaseUrl.ShouldBe("http://abc.com/v1/");
+		httpClient.BaseUrl.ShouldBe("http://abc.com/");
 	}
 }
 
@@ -173,7 +169,7 @@ public void ShouldSetClientFormatters()
 			.ConfigureFormatters(opts => { opts.Formatters.Clear(); })
 			.Build();
 
-		Assert.Empty(httpClient.Formatters);
+		httpClient.Formatters.ShouldBeEmpty();
 	}
 
 	[Fact]
@@ -187,7 +183,7 @@ public void ShouldSetDefaultFormatter()
 			})
 			.Build();
 
-		Assert.Equal(httpClient.Formatters.XmlFormatter, httpClient.DefaultFormatter);
+		httpClient.DefaultFormatter.ShouldBe(httpClient.Formatters.XmlFormatter);
 	}
 
 	[Fact]
@@ -207,8 +203,8 @@ public void SetDefaultFormatterMany_ShouldBeSetCorrectly()
 				.Build()
 			;
 
-		Assert.Equal(httpClient.Formatters.XmlFormatter, httpClient.DefaultFormatter);
-		Assert.Equal(httpClient2.Formatters.FormUrlEncodedFormatter, httpClient2.DefaultFormatter);
+		httpClient.DefaultFormatter.ShouldBe(httpClient.Formatters.XmlFormatter);
+		httpClient2.DefaultFormatter.ShouldBe(httpClient2.Formatters.FormUrlEncodedFormatter);
 	}
 
 	[Fact]
@@ -224,7 +220,7 @@ public void ShouldAutoRegisterDefault()
 			})
 			.Build();
 
-		Assert.Equal(jsonFormatter, httpClient.DefaultFormatter);
+		httpClient.DefaultFormatter.ShouldBe(jsonFormatter);
 	}
 
 	[Fact]
@@ -238,7 +234,7 @@ public void DefaultFormatterShouldBePlacedFirst()
 			})
 			.Build();
 
-		Assert.Equal(httpClient.Formatters.First(), httpClient.DefaultFormatter);
+		httpClient.DefaultFormatter.ShouldBe(httpClient.Formatters.First());
 	}
 }
 
@@ -253,8 +249,7 @@ public void ShouldSetClientFormatters()
 			.WithBaseUrl("http://abc.com")
 			.Build();
 
-		var userAgentHeader = httpClient.Headers.GetValues("User-Agent").FirstOrDefault();
-		Assert.Equal("hots", userAgentHeader);
+		httpClient.Headers.GetValues("User-Agent").FirstOrDefault().ShouldBe("hots");
 	}
 }
 
@@ -267,15 +262,15 @@ public void ShouldRegisterSuccessfully()
 			.WithBaseUrl("http://abc.com")
 			.Build();
 
-		Assert.NotNull(httpClient);
-		Assert.Equal("abc", httpClient.Identifier);
+		httpClient.ShouldNotBeNull();
+		httpClient.Identifier.ShouldBe("abc");
 	}
 
 	[Fact]
 	public void ThrowsErrorWhenIdentifierNotSpecified()
 	{
 		var clientBuilder = GetNewClientFactory().CreateBuilder(null!);
-		Assert.Throws<ClientBuilderValidationException>(() => clientBuilder.Register());
+		Should.Throw<ClientBuilderValidationException>(() => clientBuilder.Register());
 	}
 
 	[Fact]
@@ -285,7 +280,7 @@ public void ThrowsErrorWhenAlreadyRegistered()
 			.WithBaseUrl("http://abc.com")
 			.Register();
 
-		Assert.Throws<ClientBuilderValidationException>(() => clientBuilder.Register());
+		Should.Throw<ClientBuilderValidationException>(() => clientBuilder.Register());
 	}
 }
 
@@ -302,7 +297,7 @@ public async Task ShouldDisposeClient()
 		var isRegistered = fluentHttpClientFactory.Remove("abc")
 			.Has("abc");
 
-		await Assert.ThrowsAsync<ObjectDisposedException>(() => httpClient.Get<Hero>("/api/heroes/azmodan"));
-		Assert.False(isRegistered);
+		await Should.ThrowAsync<ObjectDisposedException>(() => httpClient.Get<Hero>("/api/heroes/azmodan"));
+		isRegistered.ShouldBeFalse();
 	}
 }

test/FluentHttpClientTest.cs

@@ -23,8 +23,8 @@ public async Task Get_ShouldReturnContent()
 
 		var hero = await httpClient.Get<Hero>("/api/heroes/azmodan");
 
-		Assert.NotNull(hero);
-		Assert.Equal("Azmodan", hero.Name);
+		hero.ShouldNotBeNull();
+		hero.Name.ShouldBe("Azmodan");
 	}
 
 	[Fact]
@@ -51,8 +51,8 @@ public async Task Post_ShouldReturnContent()
 			Title = "Lord of Sin"
 		});
 
-		Assert.NotNull(hero);
-		Assert.Equal("Lord of Sin", hero.Title);
+		hero.ShouldNotBeNull();
+		hero.Title.ShouldBe("Lord of Sin");
 	}
 
 	[Fact]
@@ -92,21 +92,21 @@ public void CreateClient_ShouldInheritOptions()
 		httpClient.Headers.TryGetValues("country", out var countryValues);
 		var subClientCountry = subClient.Headers.GetValues("country").FirstOrDefault();
 
-		Assert.Equal("sketch7", httpClient.Identifier);
-		Assert.Equal("sketch7.subclient", subClient.Identifier);
-		Assert.Equal("en-GB", httpClientLocale);
-		Assert.Equal("de", subClientLocale);
-		Assert.Null(countryValues?.FirstOrDefault());
-		Assert.Equal("de", subClientCountry);
-
-		Assert.Equal(httpClientRequest.HttpMethod, subClientRequest.HttpMethod);
-		Assert.Equal(httpClientRequest.Items["error-mapping"], subClientRequest.Items["error-mapping"]);
-		Assert.Equal("user", httpClientRequest.Items["context"]);
-		Assert.Equal("reward", subClientRequest.Items["context"]);
-		Assert.Equal(httpClient.Formatters.Count, subClient.Formatters.Count);
+		httpClient.Identifier.ShouldBe("sketch7");
+		subClient.Identifier.ShouldBe("sketch7.subclient");
+		httpClientLocale.ShouldBe("en-GB");
+		subClientLocale.ShouldBe("de");
+		countryValues?.FirstOrDefault().ShouldBeNull();
+		subClientCountry.ShouldBe("de");
+
+		subClientRequest.HttpMethod.ShouldBe(httpClientRequest.HttpMethod);
+		subClientRequest.Items["error-mapping"].ShouldBe(httpClientRequest.Items["error-mapping"]);
+		httpClientRequest.Items["context"].ShouldBe("user");
+		subClientRequest.Items["context"].ShouldBe("reward");
+		subClient.Formatters.Count.ShouldBe(httpClient.Formatters.Count);
 		// todo: check middleware count?
 
-		Assert.Equal(2, httpClientFactory.Count);
+		httpClientFactory.Count.ShouldBe(2);
 	}
 
 	[Fact]
@@ -136,8 +136,8 @@ public async Task GraphQL_ShouldReturnContent()
 		var response = await httpClient.CreateGqlRequest(query, operationName)
 			.ReturnAsGqlResponse<Hero>();
 
-		Assert.True(response.IsSuccessStatusCode);
-		Assert.NotNull(response.Data);
-		Assert.Equal("Lord of Sin", response.Data.Title);
+		response.IsSuccessStatusCode.ShouldBeTrue();
+		response.Data.ShouldNotBeNull();
+		response.Data.Title.ShouldBe("Lord of Sin");
 	}
 }