feat: migration fluent assertions to shoudly

Chapter-2-modules-separation/Docs/ArchitectureDecisionLog/0018-select-assertion-framework.adoc

@@ -0,0 +1,44 @@
+= 18. Select Fluent Assertion Alternative Due to Licensing Issue
+
+Date: 2025-09-04
+
+== Problem
+
+We have been using Fluent Assertions as an assertion library to enhance the readability and maintainability of our test code through fluent interfaces. However, starting from version 8, Fluent Assertions has transitioned to a paid NuGet package. Given the current pricing model, the cost outweighs the benefits it provides to our project. Consequently, we are evaluating open-source alternatives to replace Fluent Assertions.
+
+=== Option 1: NFluentAssertions
+
+This library is a fork of Fluent Assertions, allowing us to transition without modifying our existing assertions—only a NuGet package change is required.
+
+The project is maintained by a separate group of developers, raising concerns about its long-term stability and ongoing support.
+
+Repository: https://github.com/tpierrain/NFluent
+
+=== Option 2: MSTest Assertions
+
+These assertions are the standard Microsoft .NET testing utilities, maintained and updated with each .NET release.
+
+They offer a reliable and well-supported alternative but lack the fluent syntax, resulting in assertions that are less readable and more verbose.
+
+Documentation: https://learn.microsoft.com/en-us/dotnet/core/testing/unit-testing-with-mstest
+
+=== Option 3: Shouldly
+
+Shouldly provides a similar fluent interface to Fluent Assertions with minor syntactic differences.
+
+It is widely supported, maintained by an active community of contributors, and backed by sponsors, ensuring its long-term viability.
+
+The primary downside is the need to refactor existing assertions to align with Shouldly’s syntax.
+
+Repository: https://github.com/shouldly/shouldly
+
+== Decision
+
+After a thorough analysis of available options, we have decided to migrate from Fluent Assertions to Shouldly.
+
+== Consequences
+- Improved Long-Term Stability: Shouldly is actively maintained and supported by the open-source community, reducing the risk of unexpected licensing changes.
+- Maintainability & Readability: Shouldly retains a fluent syntax, ensuring our tests remain easy to read and maintain.
+- Refactoring Effort: Transitioning to Shouldly requires refactoring existing assertions, introducing short-term overhead but ensuring long-term sustainability.
+- Cost Reduction: Moving away from a paid assertion library eliminates unnecessary expenditure while maintaining similar functionality.
+- Ecosystem Alignment: Shouldly is widely adopted in the .NET ecosystem, ensuring compatibility and integration with modern development workflows.

Chapter-2-modules-separation/Src/Common/Fitnet.Common.IntegrationTests/Fitnet.Common.IntegrationTests.csproj

@@ -7,7 +7,6 @@
 
     <ItemGroup>
         <PackageReference Include="Bogus" Version="35.6.1" />
-        <PackageReference Include="FluentAssertions" Version="6.12.2" />
         <PackageReference Include="Microsoft.Extensions.TimeProvider.Testing" Version="9.0.0" />
         <PackageReference Include="Verify.Xunit" Version="28.3.2" />
         <PackageReference Include="xunit.runner.visualstudio" Version="2.8.2">

Chapter-2-modules-separation/Src/Common/Fitnet.Common.IntegrationTests/TestEngine/Database/IDatabaseConfiguration.cs

@@ -2,5 +2,5 @@ namespace EvolutionaryArchitecture.Fitnet.Common.IntegrationTests.TestEngine.Dat
 
 public interface IDatabaseConfiguration
 {
-    public Dictionary<string, string?> Get();
-}
+    Dictionary<string, string?> Get();
+}

Chapter-2-modules-separation/Src/Common/Tests/Fitnet.Common.Api.UnitTests/Fitnet.Common.Api.UnitTests.csproj

@@ -9,9 +9,9 @@
     </ItemGroup>
 
     <ItemGroup>
-        <PackageReference Include="FluentAssertions" Version="6.12.2" />
         <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
         <PackageReference Include="NSubstitute" Version="5.3.0" />
+        <PackageReference Include="Shouldly" Version="4.3.0" />
         <PackageReference Include="xunit" Version="2.9.2" />
         <PackageReference Update="SonarAnalyzer.CSharp" Version="9.32.0.97167" />
     </ItemGroup>

Chapter-2-modules-separation/Src/Common/Tests/Fitnet.Common.Api.UnitTests/GlobalExceptionHandlerTests.cs

@@ -22,10 +22,10 @@ internal async Task Given_business_rule_validation_exception_Then_returns_confli
         await exceptionHandler.TryHandleAsync(_context, new BusinessRuleValidationException(exceptionMessage), default);
 
         // Assert
-        _context.Response.StatusCode.Should().Be((int)HttpStatusCode.Conflict);
+        _context.Response.StatusCode.ShouldBe((int)HttpStatusCode.Conflict);
 
         var responseMessage = await GetExceptionResponseMessage();
-        responseMessage.Title.Should().Be(exceptionMessage);
+        responseMessage.Title.ShouldBe(exceptionMessage);
     }
 
     [Fact]
@@ -40,10 +40,10 @@ internal async Task Given_other_than_business_rule_validation_exception_Then_ret
         await exceptionHandler.TryHandleAsync(_context, new InvalidCastException("test"), CancellationToken.None);
 
         // Assert
-        _context.Response.StatusCode.Should().Be((int)HttpStatusCode.InternalServerError);
+        _context.Response.StatusCode.ShouldBe((int)HttpStatusCode.InternalServerError);
 
         var responseMessage = await GetExceptionResponseMessage();
-        responseMessage.Title.Should().Be(exceptionMessage);
+        responseMessage.Title.ShouldBe(exceptionMessage);
     }
 
     private static DefaultHttpContext GetHttpContext() =>

Chapter-2-modules-separation/Src/Common/Tests/Fitnet.Common.Api.UnitTests/GlobalUsings.cs

@@ -1,6 +1,6 @@
 global using System.Net;
 global using Xunit;
-global using FluentAssertions;
 global using Microsoft.AspNetCore.Http;
 global using Newtonsoft.Json;
-global using NSubstitute;
+global using NSubstitute;
+global using Shouldly;

Chapter-2-modules-separation/Src/Common/Tests/Fitnet.Common.Core.UnitTests/BusinessRulesEngine/BusinessRuleValidatorTests.cs

@@ -13,7 +13,7 @@ internal void Given_concrete_business_rule_which_is_met_Then_validation_should_p
         var act = () => BusinessRuleValidator.Validate(new FakeBusinessRule(20));
 
         // Assert
-        act.Should().NotThrow<BusinessRuleValidationException>();
+        act.ShouldNotThrow();
     }
 
     [Fact]
@@ -25,6 +25,7 @@ internal void Given_concrete_business_rule_which_is_not_met_Then_validation_shou
         var act = () => BusinessRuleValidator.Validate(new FakeBusinessRule(1));
 
         // Assert
-        act.Should().Throw<BusinessRuleValidationException>().WithMessage("Fake business rule was not met");
+        var exception = act.ShouldThrow<BusinessRuleValidationException>();
+        exception.Message.ShouldBe("Fake business rule was not met");
     }
 }

Chapter-2-modules-separation/Src/Common/Tests/Fitnet.Common.Core.UnitTests/Fitnet.Common.Core.UnitTests.csproj

@@ -9,8 +9,8 @@
     </ItemGroup>
 
     <ItemGroup>
-      <PackageReference Include="FluentAssertions" Version="6.12.2" />
       <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
+      <PackageReference Include="Shouldly" Version="4.3.0" />
       <PackageReference Include="xunit" Version="2.9.2" />
       <PackageReference Update="SonarAnalyzer.CSharp" Version="9.32.0.97167" />
     </ItemGroup>

Chapter-2-modules-separation/Src/Common/Tests/Fitnet.Common.Core.UnitTests/GlobalUsings.cs

@@ -1,2 +1,2 @@
 global using Xunit;
-global using FluentAssertions;
+global using Shouldly;

Chapter-2-modules-separation/Src/Common/Tests/Fitnet.Common.Infrastructure.IntegrationTests/Events/EventBus/InMemory/InMemoryEventBusTests.cs

@@ -22,7 +22,7 @@ internal async Task Given_valid_event_published_Then_event_should_be_consumed()
         await eventBus!.PublishAsync(fakeEvent, CancellationToken.None);
 
         // Assert
-        fakeEvent.Consumed.Should().BeTrue();
+        fakeEvent.Consumed.ShouldBeTrue();
     }
 
     private IEventBus GetEventBus() =>

Chapter-2-modules-separation/Src/Common/Tests/Fitnet.Common.Infrastructure.IntegrationTests/Fitnet.Common.Infrastructure.IntegrationTests.csproj

@@ -7,6 +7,7 @@
     <ItemGroup>
         <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
         <PackageReference Update="SonarAnalyzer.CSharp" Version="9.32.0.97167" />
+        <PackageReference Include="Shouldly" Version="4.3.0" />
     </ItemGroup>
 
     <ItemGroup>

Chapter-2-modules-separation/Src/Common/Tests/Fitnet.Common.Infrastructure.IntegrationTests/GlobalUsings.cs

@@ -1,5 +1,5 @@
 global using System.Reflection;
 global using Microsoft.Extensions.DependencyInjection;
 global using Microsoft.AspNetCore.Mvc.Testing;
+global using Shouldly;
 global using Xunit;
-global using FluentAssertions;

Chapter-2-modules-separation/Src/Contracts/Tests/Fitnet.Contracts.Core.UnitTests/Fitnet.Contracts.Core.UnitTests.csproj

@@ -6,7 +6,7 @@
 
     <ItemGroup>
         <PackageReference Include="Bogus" Version="35.6.1" />
-        <PackageReference Include="FluentAssertions" Version="6.12.2" />
+        <PackageReference Include="Shouldly" Version="4.3.0" />
         <PackageReference Include="xunit" Version="2.9.2" />
         <PackageReference Include="xunit.analyzers" Version="1.17.0">
           <PrivateAssets>all</PrivateAssets>

Chapter-2-modules-separation/Src/Contracts/Tests/Fitnet.Contracts.Core.UnitTests/GlobalUsings.cs

@@ -1,3 +1,3 @@
 global using System.Collections;
-global using FluentAssertions;
-global using Xunit;
+global using Shouldly;
+global using Xunit;

Chapter-2-modules-separation/Src/Contracts/Tests/Fitnet.Contracts.Core.UnitTests/PrepareContract/BusinessRules/ContractCanBePreparedOnlyForAdultRuleTests.cs

@@ -14,7 +14,8 @@ internal void Given_customer_age_which_is_less_than_18_Then_validation_should_th
         var act = () => BusinessRuleValidator.Validate(new ContractCanBePreparedOnlyForAdultRule(17));
 
         // Assert
-        act.Should().Throw<BusinessRuleValidationException>().WithMessage("Contract can not be prepared for a person who is not adult");
+        var exception = act.ShouldThrow<BusinessRuleValidationException>();
+        exception.Message.ShouldBe("Contract can not be prepared for a person who is not adult");
     }
 
     [Fact]
@@ -26,7 +27,7 @@ internal void Given_customer_age_which_is_equal_to_18_Then_validation_should_pas
         var act = () => BusinessRuleValidator.Validate(new ContractCanBePreparedOnlyForAdultRule(18));
 
         // Assert
-        act.Should().NotThrow<BusinessRuleValidationException>();
+        act.ShouldNotThrow();
     }
 
     [Fact]
@@ -38,6 +39,6 @@ internal void Given_customer_age_which_is_greater_than_18_Then_validation_should
         var act = () => BusinessRuleValidator.Validate(new ContractCanBePreparedOnlyForAdultRule(19));
 
         // Assert
-        act.Should().NotThrow<BusinessRuleValidationException>();
+        act.ShouldNotThrow();
     }
 }

Chapter-2-modules-separation/Src/Contracts/Tests/Fitnet.Contracts.Core.UnitTests/PrepareContract/BusinessRules/CustomerMustBeSmallerThanMaximumHeightLimitRuleTests.cs

@@ -15,7 +15,8 @@ internal void Given_customer_height_which_is_greater_than_maximum_height_limit_T
         var act = () => BusinessRuleValidator.Validate(new CustomerMustBeSmallerThanMaximumHeightLimitRule(height));
 
         // Assert
-        act.Should().Throw<BusinessRuleValidationException>().WithMessage("Customer height must fit maximum limit for gym instruments");
+        var exception = act.ShouldThrow<BusinessRuleValidationException>();
+        exception.Message.ShouldBe("Customer height must fit maximum limit for gym instruments");
     }
 
     [Fact]
@@ -28,7 +29,7 @@ internal void Given_customer_height_which_is_equal_to_maximum_height_limit_Then_
         var act = () => BusinessRuleValidator.Validate(new CustomerMustBeSmallerThanMaximumHeightLimitRule(height));
 
         // Assert
-        act.Should().NotThrow<BusinessRuleValidationException>();
+        act.ShouldNotThrow();
     }
 
     [Fact]
@@ -41,6 +42,6 @@ internal void Given_customer_height_which_is_less_than_maximum_height_limit_Then
         var act = () => BusinessRuleValidator.Validate(new CustomerMustBeSmallerThanMaximumHeightLimitRule(height));
 
         // Assert
-        act.Should().NotThrow<BusinessRuleValidationException>();
+        act.ShouldNotThrow();
     }
 }

Chapter-2-modules-separation/Src/Contracts/Tests/Fitnet.Contracts.Core.UnitTests/PrepareContract/BusinessRules/PreviousContractHasToBeSignedRuleTests.cs

@@ -14,7 +14,7 @@ internal void Given_previous_contract_signed_Then_validation_should_pass()
         var act = () => BusinessRuleValidator.Validate(new PreviousContractHasToBeSignedRule(true));
 
         // Assert
-        act.Should().NotThrow<BusinessRuleValidationException>();
+        act.ShouldNotThrow();
     }
 
     [Fact]
@@ -26,10 +26,9 @@ internal void Given_previous_contract_not_exists_Then_validation_should_pass()
         var act = () => BusinessRuleValidator.Validate(new PreviousContractHasToBeSignedRule(null));
 
         // Assert
-        act.Should().NotThrow<BusinessRuleValidationException>();
+        act.ShouldNotThrow();
     }
 
-
     [Fact]
     internal void Given_previous_contract_unsigned_Then_validation_should_throw()
     {
@@ -39,6 +38,7 @@ internal void Given_previous_contract_unsigned_Then_validation_should_throw()
         var act = () => BusinessRuleValidator.Validate(new PreviousContractHasToBeSignedRule(false));
 
         // Assert
-        act.Should().Throw<BusinessRuleValidationException>().WithMessage("Previous contract must be signed by the customer");
+        var exception = act.ShouldThrow<BusinessRuleValidationException>();
+        exception.Message.ShouldBe("Previous contract must be signed by the customer");
     }
 }

Chapter-2-modules-separation/Src/Contracts/Tests/Fitnet.Contracts.Core.UnitTests/SignContract/BusinessRules/ContractCanOnlyBeSignedWithin30DaysFromPreparationTests.cs

@@ -17,8 +17,8 @@ internal void Given_signed_at_date_which_is_more_than_30_days_from_prepared_at_d
                     DateTimeOffset.Now.AddDays(31)));
 
         // Assert
-        act.Should().Throw<BusinessRuleValidationException>().WithMessage(
-            "Contract can not be signed because more than 30 days have passed from the contract preparation");
+        var exception = act.ShouldThrow<BusinessRuleValidationException>();
+        exception.Message.ShouldBe("Contract can not be signed because more than 30 days have passed from the contract preparation");
     }
 
     [Fact]
@@ -33,7 +33,7 @@ internal void Given_signed_at_date_which_is_30_days_from_prepared_at_date_Then_v
                     DateTimeOffset.Now.AddDays(30)));
 
         // Assert
-        act.Should().NotThrow<BusinessRuleValidationException>();
+        act.ShouldNotThrow();
     }
 
     [Fact]
@@ -48,6 +48,6 @@ internal void Given_signed_at_date_which_is_less_than_30_days_from_prepared_at_d
                     DateTimeOffset.Now.AddDays(29)));
 
         // Assert
-        act.Should().NotThrow<BusinessRuleValidationException>();
+        act.ShouldNotThrow();
     }
 }

Chapter-2-modules-separation/Src/Contracts/Tests/Fitnet.Contracts.Core.UnitTests/SignContract/SignContractTests.cs

@@ -19,7 +19,7 @@ internal void Given_sign_contract_Then_expiration_date_is_set_to_contract_durati
         contract.Sign(signedAt, fakeNow);
 
         // Assert
-        contract.ExpiringAt.Should().Be(expectedExpirationDate);
+        contract.ExpiringAt.ShouldBe(expectedExpirationDate);
     }
 
     private static Contract PrepareContract(DateTimeOffset preparedAt)

Chapter-2-modules-separation/Src/Contracts/Tests/Fitnet.Contracts.IntegrationTests/Fitnet.Contracts.IntegrationTests.csproj

@@ -9,6 +9,7 @@
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
     <PackageReference Include="NSubstitute" Version="5.3.0" />
     <PackageReference Update="SonarAnalyzer.CSharp" Version="9.32.0.97167" />
+    <PackageReference Include="Shouldly" Version="4.3.0" />
   </ItemGroup>
 
   <ItemGroup>

Chapter-2-modules-separation/Src/Contracts/Tests/Fitnet.Contracts.IntegrationTests/GlobalUsings.cs

@@ -2,5 +2,5 @@
 global using System.Net.Http.Json;
 global using Xunit;
 global using Bogus;
-global using FluentAssertions;
-global using NSubstitute;
+global using NSubstitute;
+global using Shouldly;

Chapter-2-modules-separation/Src/Contracts/Tests/Fitnet.Contracts.IntegrationTests/PrepareContract/PrepareContractTests.cs

@@ -26,7 +26,7 @@ internal async Task Given_valid_contract_preparation_request_Then_should_return_
         var prepareContractResponse = await PrepareCorrectContract(requestParameters);
 
         // Assert
-        prepareContractResponse.Should().HaveStatusCode(HttpStatusCode.Created);
+        prepareContractResponse.StatusCode.ShouldBe(HttpStatusCode.Created);
     }
 
     [Fact]
@@ -44,9 +44,8 @@ internal async Task Given_contract_preparation_request_with_invalid_age_Then_sho
 
         // Assert
         var responseMessage = await prepareContractResponse.Content.ReadFromJsonAsync<ProblemDetails>();
-        responseMessage?.Status.Should().Be((int)HttpStatusCode.Conflict);
-        responseMessage?.Title.Should()
-            .Be("Contract can not be prepared for a person who is not adult");
+        responseMessage?.Status.ShouldBe((int)HttpStatusCode.Conflict);
+        responseMessage?.Title.ShouldBe("Contract can not be prepared for a person who is not adult");
     }
 
     [Fact]
@@ -64,9 +63,8 @@ internal async Task Given_contract_preparation_request_with_invalid_height_Then_
 
         // Assert
         var responseMessage = await prepareContractResponse.Content.ReadFromJsonAsync<ProblemDetails>();
-        responseMessage?.Status.Should().Be((int)HttpStatusCode.Conflict);
-        responseMessage?.Title.Should()
-            .Be("Customer height must fit maximum limit for gym instruments");
+        responseMessage?.Status.ShouldBe((int)HttpStatusCode.Conflict);
+        responseMessage?.Title.ShouldBe("Customer height must fit maximum limit for gym instruments");
     }
 
     [Fact]
@@ -82,9 +80,8 @@ internal async Task Given_contract_preparation_request_When_contract_for_custome
 
         // Assert
         var responseMessage = await prepareContractResponse.Content.ReadFromJsonAsync<ProblemDetails>();
-        responseMessage?.Status.Should().Be((int)HttpStatusCode.Conflict);
-        responseMessage?.Title.Should()
-            .Be("Previous contract must be signed by the customer");
+        responseMessage?.Status.ShouldBe((int)HttpStatusCode.Conflict);
+        responseMessage?.Title.ShouldBe("Previous contract must be signed by the customer");
     }
 
     private async Task<HttpResponseMessage> PrepareCorrectContract(PrepareContractRequestParameters requestParameters, Guid? customerId = null)