refactor: replace FluentAssertions with Shouldly in tests

- Migrated all test assertions from FluentAssertions to Shouldly
- Removed all FluentAssertions package references
- Updated README to reflect use of Shouldly

Author: Kamyab7

Directory.Packages.props

@@ -31,7 +31,6 @@
     <PackageVersion Include="Azure.Extensions.AspNetCore.Configuration.Secrets" Version="1.3.2" />
     <PackageVersion Include="Azure.Identity" Version="1.13.1" />
     <PackageVersion Include="coverlet.collector" Version="6.0.2" />
-    <PackageVersion Include="FluentAssertions" Version="6.12.2" />
     <PackageVersion Include="FluentValidation.AspNetCore" Version="11.3.0" />
     <PackageVersion Include="FluentValidation.DependencyInjectionExtensions" Version="11.11.0" />
     <PackageVersion Include="MediatR" Version="12.4.1" />
@@ -49,6 +48,7 @@
     <PackageVersion Include="Microsoft.EntityFrameworkCore.Relational" Version="$(EfcoreVersion)" />
     <!--#if (UsePostgreSQL)-->
     <PackageVersion Include="Npgsql.EntityFrameworkCore.PostgreSQL" Version="9.0.1" />
+    <PackageVersion Include="Shouldly" Version="4.3.0" />
     <PackageVersion Include="Testcontainers.PostgreSql" Version="4.0.0" />
     <!--#endif-->
     <!--#if (UseSqlite)-->

README.md

@@ -107,7 +107,7 @@ azd up
 * [MediatR](https://github.com/jbogard/MediatR)
 * [AutoMapper](https://automapper.org/)
 * [FluentValidation](https://fluentvalidation.net/)
-* [NUnit](https://nunit.org/), [FluentAssertions](https://fluentassertions.com/), [Moq](https://github.com/devlooped/moq) & [Respawn](https://github.com/jbogard/Respawn)
+* [NUnit](https://nunit.org/), [Shoudly](https://docs.shouldly.org/), [Moq](https://github.com/devlooped/moq) & [Respawn](https://github.com/jbogard/Respawn)
 
 ## Versions
 The main branch is now on .NET 9.0. The following previous versions are available:

tests/Application.FunctionalTests/Application.FunctionalTests.csproj

@@ -32,9 +32,9 @@
         <PrivateAssets>all</PrivateAssets>
         <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       </PackageReference>
-      <PackageReference Include="FluentAssertions" />
       <PackageReference Include="Moq" />
       <PackageReference Include="Respawn" />
+      <PackageReference Include="Shouldly" />
       <PackageReference Include="System.Configuration.ConfigurationManager" />
       <!--#if (UsePostgreSQL)-->
       <PackageReference Include="Testcontainers.PostgreSql" />

tests/Application.FunctionalTests/GlobalUsings.cs

@@ -1,4 +1,4 @@
 global using Ardalis.GuardClauses;
-global using FluentAssertions;
+global using Shouldly;
 global using Moq;
-global using NUnit.Framework;
+global using NUnit.Framework;

tests/Application.FunctionalTests/TodoLists/Commands/CreateTodoListTests.cs

@@ -12,7 +12,7 @@ public class CreateTodoListTests : BaseTestFixture
     public async Task ShouldRequireMinimumFields()
     {
         var command = new CreateTodoListCommand();
-        await FluentActions.Invoking(() => SendAsync(command)).Should().ThrowAsync<ValidationException>();
+        await Should.ThrowAsync<ValidationException>(() => SendAsync(command));
     }
 
     [Test]
@@ -28,8 +28,7 @@ await SendAsync(new CreateTodoListCommand
             Title = "Shopping"
         };
 
-        await FluentActions.Invoking(() =>
-            SendAsync(command)).Should().ThrowAsync<ValidationException>();
+        await Should.ThrowAsync<ValidationException>(() => SendAsync(command));
     }
 
     [Test]
@@ -46,9 +45,9 @@ public async Task ShouldCreateTodoList()
 
         var list = await FindAsync<TodoList>(id);
 
-        list.Should().NotBeNull();
-        list!.Title.Should().Be(command.Title);
-        list.CreatedBy.Should().Be(userId);
-        list.Created.Should().BeCloseTo(DateTime.Now, TimeSpan.FromMilliseconds(10000));
+        list.ShouldNotBeNull();
+        list!.Title.ShouldBe(command.Title);
+        list.CreatedBy.ShouldBe(userId);
+        list.Created.ShouldBe(DateTime.Now, TimeSpan.FromMilliseconds(10000));
     }
 }

tests/Application.FunctionalTests/TodoLists/Commands/DeleteTodoListTests.cs

@@ -12,7 +12,7 @@ public class DeleteTodoListTests : BaseTestFixture
     public async Task ShouldRequireValidTodoListId()
     {
         var command = new DeleteTodoListCommand(99);
-        await FluentActions.Invoking(() => SendAsync(command)).Should().ThrowAsync<NotFoundException>();
+        await Should.ThrowAsync<NotFoundException>(() => SendAsync(command));
     }
 
     [Test]
@@ -27,6 +27,6 @@ public async Task ShouldDeleteTodoList()
 
         var list = await FindAsync<TodoList>(listId);
 
-        list.Should().BeNull();
+        list.ShouldBeNull();
     }
 }

tests/Application.FunctionalTests/TodoLists/Commands/PurgeTodoListsTests.cs

@@ -15,11 +15,13 @@ public async Task ShouldDenyAnonymousUser()
     {
         var command = new PurgeTodoListsCommand();
 
-        command.GetType().Should().BeDecoratedWith<AuthorizeAttribute>();
+        command.GetType().ShouldSatisfyAllConditions(
+            type => type.ShouldBeDecoratedWith<AuthorizeAttribute>()
+        );
 
         var action = () => SendAsync(command);
 
-        await action.Should().ThrowAsync<UnauthorizedAccessException>();
+        await Should.ThrowAsync<UnauthorizedAccessException>(action);
     }
 
     [Test]
@@ -31,7 +33,7 @@ public async Task ShouldDenyNonAdministrator()
 
         var action = () => SendAsync(command);
 
-        await action.Should().ThrowAsync<ForbiddenAccessException>();
+        await Should.ThrowAsync<ForbiddenAccessException>(action);
     }
 
     [Test]
@@ -43,7 +45,8 @@ public async Task ShouldAllowAdministrator()
 
         var action = () => SendAsync(command);
 
-        await action.Should().NotThrowAsync<ForbiddenAccessException>();
+        Func<Task> asyncAction = async () => await SendAsync(command);
+        await asyncAction.ShouldNotThrowAsync();
     }
 
     [Test]
@@ -70,6 +73,6 @@ await SendAsync(new CreateTodoListCommand
 
         var count = await CountAsync<TodoList>();
 
-        count.Should().Be(0);
+        count.ShouldBe(0);
     }
 }

tests/Application.FunctionalTests/TodoLists/Commands/UpdateTodoListTests.cs

@@ -13,7 +13,7 @@ public class UpdateTodoListTests : BaseTestFixture
     public async Task ShouldRequireValidTodoListId()
     {
         var command = new UpdateTodoListCommand { Id = 99, Title = "New Title" };
-        await FluentActions.Invoking(() => SendAsync(command)).Should().ThrowAsync<NotFoundException>();
+        await Should.ThrowAsync<NotFoundException>(() => SendAsync(command));
     }
 
     [Test]
@@ -35,10 +35,10 @@ await SendAsync(new CreateTodoListCommand
             Title = "Other List"
         };
 
-        (await FluentActions.Invoking(() =>
-            SendAsync(command))
-                .Should().ThrowAsync<ValidationException>().Where(ex => ex.Errors.ContainsKey("Title")))
-                .And.Errors["Title"].Should().Contain("'Title' must be unique.");
+        var ex = await Should.ThrowAsync<ValidationException>(() => SendAsync(command));
+
+        ex.Errors.ShouldContainKey("Title");
+        ex.Errors["Title"].ShouldContain("'Title' must be unique.");
     }
 
     [Test]
@@ -61,10 +61,10 @@ public async Task ShouldUpdateTodoList()
 
         var list = await FindAsync<TodoList>(listId);
 
-        list.Should().NotBeNull();
-        list!.Title.Should().Be(command.Title);
-        list.LastModifiedBy.Should().NotBeNull();
-        list.LastModifiedBy.Should().Be(userId);
-        list.LastModified.Should().BeCloseTo(DateTime.Now, TimeSpan.FromMilliseconds(10000));
+        list.ShouldNotBeNull();
+        list!.Title.ShouldBe(command.Title);
+        list.LastModifiedBy.ShouldNotBeNull();
+        list.LastModifiedBy.ShouldBe(userId);
+        list.LastModified.ShouldBe(DateTime.Now, TimeSpan.FromMilliseconds(10000));
     }
 }

tests/Application.FunctionalTests/TodoLists/Queries/GetTodosTests.cs

@@ -17,7 +17,7 @@ public async Task ShouldReturnPriorityLevels()
 
         var result = await SendAsync(query);
 
-        result.PriorityLevels.Should().NotBeEmpty();
+        result.PriorityLevels.ShouldNotBeEmpty();
     }
 
     [Test]
@@ -30,23 +30,23 @@ await AddAsync(new TodoList
             Title = "Shopping",
             Colour = Colour.Blue,
             Items =
-                    {
-                        new TodoItem { Title = "Apples", Done = true },
-                        new TodoItem { Title = "Milk", Done = true },
-                        new TodoItem { Title = "Bread", Done = true },
-                        new TodoItem { Title = "Toilet paper" },
-                        new TodoItem { Title = "Pasta" },
-                        new TodoItem { Title = "Tissues" },
-                        new TodoItem { Title = "Tuna" }
-                    }
+                {
+                    new TodoItem { Title = "Apples", Done = true },
+                    new TodoItem { Title = "Milk", Done = true },
+                    new TodoItem { Title = "Bread", Done = true },
+                    new TodoItem { Title = "Toilet paper" },
+                    new TodoItem { Title = "Pasta" },
+                    new TodoItem { Title = "Tissues" },
+                    new TodoItem { Title = "Tuna" }
+                }
         });
 
         var query = new GetTodosQuery();
 
         var result = await SendAsync(query);
 
-        result.Lists.Should().HaveCount(1);
-        result.Lists.First().Items.Should().HaveCount(7);
+        result.Lists.Count.ShouldBe(1);
+        result.Lists.First().Items.Count.ShouldBe(7);
     }
 
     [Test]
@@ -55,7 +55,7 @@ public async Task ShouldDenyAnonymousUser()
         var query = new GetTodosQuery();
 
         var action = () => SendAsync(query);
-        
-        await action.Should().ThrowAsync<UnauthorizedAccessException>();
+
+        await Should.ThrowAsync<UnauthorizedAccessException>(action);
     }
 }

tests/Application.UnitTests/Application.UnitTests.csproj

@@ -18,8 +18,8 @@
           <PrivateAssets>all</PrivateAssets>
           <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
         </PackageReference>
-        <PackageReference Include="FluentAssertions" />
         <PackageReference Include="Moq" />
+        <PackageReference Include="Shouldly" />
     </ItemGroup>
 
     <ItemGroup>

tests/Application.UnitTests/Common/Exceptions/ValidationExceptionTests.cs

@@ -1,7 +1,7 @@
 using CleanArchitecture.Application.Common.Exceptions;
-using FluentAssertions;
 using FluentValidation.Results;
 using NUnit.Framework;
+using Shouldly;
 
 namespace CleanArchitecture.Application.UnitTests.Common.Exceptions;
 
@@ -12,7 +12,7 @@ public void DefaultConstructorCreatesAnEmptyErrorDictionary()
     {
         var actual = new ValidationException().Errors;
 
-        actual.Keys.Should().BeEquivalentTo(Array.Empty<string>());
+        actual.Keys.ShouldBeEmpty();
     }
 
     [Test]
@@ -25,8 +25,8 @@ public void SingleValidationFailureCreatesASingleElementErrorDictionary()
 
         var actual = new ValidationException(failures).Errors;
 
-        actual.Keys.Should().BeEquivalentTo(new string[] { "Age" });
-        actual["Age"].Should().BeEquivalentTo(new string[] { "must be over 18" });
+        actual.Keys.ShouldBe(new string[] { "Age" });
+        actual["Age"].ShouldBe(new string[] { "must be over 18" });
     }
 
     [Test]
@@ -44,20 +44,20 @@ public void MulitpleValidationFailureForMultiplePropertiesCreatesAMultipleElemen
 
         var actual = new ValidationException(failures).Errors;
 
-        actual.Keys.Should().BeEquivalentTo(new string[] { "Password", "Age" });
+        actual.Keys.ShouldBe(new string[] { "Password", "Age" }, ignoreOrder: true);
 
-        actual["Age"].Should().BeEquivalentTo(new string[]
+        actual["Age"].ShouldBe(new string[]
         {
                 "must be 25 or younger",
                 "must be 18 or older",
-        });
+        }, ignoreOrder: true);
 
-        actual["Password"].Should().BeEquivalentTo(new string[]
+        actual["Password"].ShouldBe(new string[]
         {
                 "must contain lower case letter",
                 "must contain upper case letter",
                 "must contain at least 8 characters",
                 "must contain a digit",
-        });
+        }, ignoreOrder: true);
     }
 }

tests/Domain.UnitTests/Domain.UnitTests.csproj

@@ -17,7 +17,7 @@
           <PrivateAssets>all</PrivateAssets>
           <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
         </PackageReference>
-        <PackageReference Include="FluentAssertions" />
+        <PackageReference Include="Shouldly" />
     </ItemGroup>
 
     <ItemGroup>

tests/Domain.UnitTests/ValueObjects/ColourTests.cs

@@ -1,7 +1,7 @@
 using CleanArchitecture.Domain.Exceptions;
 using CleanArchitecture.Domain.ValueObjects;
-using FluentAssertions;
 using NUnit.Framework;
+using Shouldly;
 
 namespace CleanArchitecture.Domain.UnitTests.ValueObjects;
 
@@ -14,37 +14,36 @@ public void ShouldReturnCorrectColourCode()
 
         var colour = Colour.From(code);
 
-        colour.Code.Should().Be(code);
+        colour.Code.ShouldBe(code);
     }
 
     [Test]
     public void ToStringReturnsCode()
     {
         var colour = Colour.White;
 
-        colour.ToString().Should().Be(colour.Code);
+        colour.ToString().ShouldBe(colour.Code);
     }
 
     [Test]
     public void ShouldPerformImplicitConversionToColourCodeString()
     {
         string code = Colour.White;
 
-        code.Should().Be("#FFFFFF");
+        code.ShouldBe("#FFFFFF");
     }
 
     [Test]
     public void ShouldPerformExplicitConversionGivenSupportedColourCode()
     {
         var colour = (Colour)"#FFFFFF";
 
-        colour.Should().Be(Colour.White);
+        colour.ShouldBe(Colour.White);
     }
 
     [Test]
     public void ShouldThrowUnsupportedColourExceptionGivenNotSupportedColourCode()
     {
-        FluentActions.Invoking(() => Colour.From("##FF33CC"))
-            .Should().Throw<UnsupportedColourException>();
+        Should.Throw<UnsupportedColourException>(() => Colour.From("##FF33CC"));
     }
 }

tests/Web.AcceptanceTests/GlobalUsings.cs

@@ -1,5 +1,5 @@
 global using CleanArchitecture.Web.AcceptanceTests.Pages;
 global using BoDi;
-global using FluentAssertions;
+global using Shouldly;
 global using Microsoft.Playwright;
-global using TechTalk.SpecFlow;
+global using TechTalk.SpecFlow;

tests/Web.AcceptanceTests/StepDefinitions/LoginStepDefinitions.cs

@@ -52,8 +52,8 @@ public async Task TheyLogInSuccessfully()
     {
         var profileLinkText = await _loginPage.ProfileLinkText();
 
-        profileLinkText.Should().NotBeNull();
-        profileLinkText.Should().Be("Account");
+        profileLinkText.ShouldNotBeNull();
+        profileLinkText.ShouldBe("Account");
     }
 
     [When("the user logs in with invalid credentials")]
@@ -69,7 +69,7 @@ public async Task AnErrorIsDisplayed()
     {
         var errorVisible = await _loginPage.InvalidLoginAttemptMessageVisible();
 
-        errorVisible.Should().BeTrue();
+        errorVisible.ShouldBeTrue();
     }
 
     [AfterFeature]
@@ -81,4 +81,4 @@ public static async Task AfterScenario(IObjectContainer container)
         await browser.CloseAsync();
         playright.Dispose();
     }
-}
+}