Move from FluentAssertions to AwesomeAssertions (#2547)

artl93 · web-flow · commit e8282e765515 · 2025-04-22T09:55:41.000+02:00
diff --git a/Directory.Packages.props b/Directory.Packages.props
@@ -20,7 +20,7 @@
     <!-- external dependencies -->
     <PackageVersion Include="ApprovalTests" Version="7.0.0-beta.3" />
     <PackageVersion Include="BenchmarkDotNet" Version="0.13.1" />
-    <PackageVersion Include="FluentAssertions" Version="5.10.3" />
+    <PackageVersion Include="AwesomeAssertions" Version="8.0.2" />
     <PackageVersion Include="Microsoft.CSharp" Version="4.7.0" />
     <PackageVersion Include="Microsoft.DotNet.PlatformAbstractions" Version="3.1.6" />
     <PackageVersion Include="Newtonsoft.Json" Version="13.0.2" />
diff --git a/src/System.CommandLine.DragonFruit.Tests/ConfigureFromMethodTests.cs b/src/System.CommandLine.DragonFruit.Tests/ConfigureFromMethodTests.cs
@@ -28,7 +28,7 @@ public async Task Generated_boolean_parameters_will_accept_zero_arguments()
 
             await config.InvokeAsync($"{RootCommand.ExecutableName} --value");
 
-            _receivedValues.Should().BeEquivalentTo(true);
+            _receivedValues.Should().BeEquivalentTo(new object[] { true });
         }
 
         [Theory]
@@ -47,7 +47,7 @@ public async Task Generated_boolean_parameters_will_accept_one_argument(string c
 
             await config.InvokeAsync(commandLine);
 
-            _receivedValues.Should().BeEquivalentTo(expected);
+            _receivedValues.Should().BeEquivalentTo(new [] { expected });
         }
 
         [Fact]
@@ -220,7 +220,7 @@ public async Task Method_parameters_on_the_invoked_member_method_are_bound_to_ma
 
             await command.Parse("--value").InvokeAsync();
 
-            _receivedValues.Should().BeEquivalentTo(true);
+            _receivedValues.Should().BeEquivalentTo(new [] { true });
         }
 
         [Fact]
@@ -231,7 +231,7 @@ public async Task Method_with_multiple_parameters_with_default_values_are_resolv
 
             await command.Parse("").InvokeAsync();
 
-            _receivedValues.Should().BeEquivalentTo(1, 2);
+            _receivedValues.Should().BeEquivalentTo(new [] { 1, 2 });
         }
 
         internal void Method_taking_bool(bool value = false)
diff --git a/src/System.CommandLine.DragonFruit.Tests/System.CommandLine.DragonFruit.Tests.csproj b/src/System.CommandLine.DragonFruit.Tests/System.CommandLine.DragonFruit.Tests.csproj
@@ -12,7 +12,7 @@
   </PropertyGroup>
   
   <ItemGroup>
-    <PackageReference Include="FluentAssertions" />
+    <PackageReference Include="AwesomeAssertions" />
     <PackageReference Include="Newtonsoft.Json" />
   </ItemGroup>
   
diff --git a/src/System.CommandLine.Generator.Tests/System.CommandLine.Generator.Tests.csproj b/src/System.CommandLine.Generator.Tests/System.CommandLine.Generator.Tests.csproj
@@ -15,7 +15,7 @@
   </ItemGroup>
   
   <ItemGroup>
-    <PackageReference Include="FluentAssertions" />
+    <PackageReference Include="AwesomeAssertions" />
     <PackageReference Include="Microsoft.DotNet.PlatformAbstractions" />
   </ItemGroup>
 
diff --git a/src/System.CommandLine.Hosting.Tests/System.CommandLine.Hosting.Tests.csproj b/src/System.CommandLine.Hosting.Tests/System.CommandLine.Hosting.Tests.csproj
@@ -6,7 +6,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="FluentAssertions" />
+    <PackageReference Include="AwesomeAssertions" />
     <PackageReference Include="Microsoft.Extensions.Configuration.CommandLine" />
   </ItemGroup>
 
diff --git a/src/System.CommandLine.NamingConventionBinder.Tests/System.CommandLine.NamingConventionBinder.Tests.csproj b/src/System.CommandLine.NamingConventionBinder.Tests/System.CommandLine.NamingConventionBinder.Tests.csproj
@@ -19,7 +19,7 @@
   
   <ItemGroup>
     <PackageReference Include="ApprovalTests" />
-    <PackageReference Include="FluentAssertions" />
+    <PackageReference Include="AwesomeAssertions" />
     <PackageReference Include="Newtonsoft.Json" />
     <PackageReference Include="Microsoft.DotNet.PlatformAbstractions" />
   </ItemGroup>
diff --git a/src/System.CommandLine.Suggest.Tests/GlobalToolsSuggestionRegistrationTests.cs b/src/System.CommandLine.Suggest.Tests/GlobalToolsSuggestionRegistrationTests.cs
@@ -50,11 +50,11 @@ public void Global_tools_can_be_found()
 
             registrationPairs
                 .Should()
-                .BeEquivalentTo(
+                .BeEquivalentTo( new [] {
                     new Registration(
                         Path.Combine(dotnetProfileDirectory, "tools", "dotnet-suggest")),
                     new Registration(
-                        Path.Combine(dotnetProfileDirectory, "tools", "t-rex")));
+                        Path.Combine(dotnetProfileDirectory, "tools", "t-rex"))});
         }
     }
 }
diff --git a/src/System.CommandLine.Suggest.Tests/dotnet-suggest.Tests.csproj b/src/System.CommandLine.Suggest.Tests/dotnet-suggest.Tests.csproj
@@ -10,7 +10,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="FluentAssertions" />
+    <PackageReference Include="AwesomeAssertions" />
   </ItemGroup>
 
   <ItemGroup>
diff --git a/src/System.CommandLine.Tests/Binding/TypeConversionTests.cs b/src/System.CommandLine.Tests/Binding/TypeConversionTests.cs
@@ -689,7 +689,7 @@ public void Values_can_be_correctly_converted_to_nullable_uint_without_the_parse
 
         [Fact]
         public void Values_can_be_correctly_converted_to_array_of_int_without_the_parser_specifying_a_custom_converter()
-            => GetValue(new Option<int[]>("-x"), "-x 1 -x 2 -x 3").Should().BeEquivalentTo(1, 2, 3);
+            => GetValue(new Option<int[]>("-x"), "-x 1 -x 2 -x 3").Should().BeEquivalentTo(new[] { 1, 2, 3 });
 
         [Theory]
         [InlineData(0, 100_000, typeof(string[]))]
@@ -734,11 +734,11 @@ public void Max_arity_greater_than_1_converts_to_enumerable_types(
 
         [Fact]
         public void Values_can_be_correctly_converted_to_List_of_int_without_the_parser_specifying_a_custom_converter()
-            => GetValue(new Option<List<int>>("-x"), "-x 1 -x 2 -x 3").Should().BeEquivalentTo(1, 2, 3);
+            => GetValue(new Option<List<int>>("-x"), "-x 1 -x 2 -x 3").Should().BeEquivalentTo(new[] {1, 2, 3});
 
         [Fact]
         public void Values_can_be_correctly_converted_to_IEnumerable_of_int_without_the_parser_specifying_a_custom_converter()
-            => GetValue(new Option<IEnumerable<int>>("-x"), "-x 1 -x 2 -x 3").Should().BeEquivalentTo(1, 2, 3);
+            => GetValue(new Option<IEnumerable<int>>("-x"), "-x 1 -x 2 -x 3").Should().BeEquivalentTo(new[] { 1, 2, 3 });
 
         [Fact]
         public void Enum_values_can_be_correctly_converted_based_on_enum_value_name_without_the_parser_specifying_a_custom_converter()
@@ -826,6 +826,6 @@ public void Sequence_type_defaults_to_empty_when_not_specified(Type sequenceType
         }
 
         private void AssertParsedValueIsEmpty<T>(Argument<T> argument) where T : IEnumerable
-            => GetValue(argument, "").Should().BeEmpty();
+            => GetValue(argument, "").Should().BeEquivalentTo(Enumerable.Empty<T>());
     }
 }
diff --git a/src/System.CommandLine.Tests/CompletionTests.cs b/src/System.CommandLine.Tests/CompletionTests.cs
@@ -311,6 +311,7 @@ public void When_a_subcommand_has_been_specified_then_its_sibling_commands_will_
             var result = rootCommand.Parse("cherry ", simpleConfig);
 
             result.GetCompletions()
+                  .Select(item => item.Label)
                   .Should()
                   .NotContain(new[]{"apple", "banana", "cherry"});
         }
@@ -381,6 +382,7 @@ public void When_a_subcommand_has_been_specified_then_its_sibling_options_with_a
 
             parseResult
                 .GetCompletions(commandLine.Length + 1)
+                .Select(item => item.Label)
                 .Should()
                 .NotContain("--parent-option");
         }
diff --git a/src/System.CommandLine.Tests/ParserTests.cs b/src/System.CommandLine.Tests/ParserTests.cs
@@ -1030,12 +1030,12 @@ public void Options_can_have_the_same_alias_differentiated_only_by_prefix()
                   .Children
                   .Select(s => ((OptionResult)s).Option)
                   .Should()
-                  .BeEquivalentTo(option1);
+                  .BeEquivalentTo(new[] { option1 });
             parser.Parse("--a").CommandResult
                   .Children
                   .Select(s => ((OptionResult)s).Option)
                   .Should()
-                  .BeEquivalentTo(option2);
+                  .BeEquivalentTo(new[] { option2 });
         }
 
         [Theory]
@@ -1398,10 +1398,10 @@ public void Command_argument_arity_can_be_a_fixed_value_greater_than_1()
                    .CommandResult
                    .Tokens
                    .Should()
-                   .BeEquivalentTo(
+                   .BeEquivalentTo(new [] {
                        new Token("1", TokenType.Argument, argument),
                        new Token("2", TokenType.Argument, argument),
-                       new Token("3", TokenType.Argument, argument));
+                       new Token("3", TokenType.Argument, argument)});
         }
 
         [Fact]
@@ -1420,20 +1420,20 @@ public void Command_argument_arity_can_be_a_range_with_a_lower_bound_greater_tha
                    .CommandResult
                    .Tokens
                    .Should()
-                   .BeEquivalentTo(
+                   .BeEquivalentTo(new [] {
                        new Token("1", TokenType.Argument, argument),
                        new Token("2", TokenType.Argument, argument),
-                       new Token("3", TokenType.Argument, argument));
+                       new Token("3", TokenType.Argument, argument)});
             command.Parse("1 2 3 4 5")
                    .CommandResult
                    .Tokens
                    .Should()
-                   .BeEquivalentTo(
+                   .BeEquivalentTo(new [] {
                        new Token("1", TokenType.Argument, argument),
                        new Token("2", TokenType.Argument, argument),
                        new Token("3", TokenType.Argument, argument),
                        new Token("4", TokenType.Argument, argument),
-                       new Token("5", TokenType.Argument, argument));
+                       new Token("5", TokenType.Argument, argument)});
         }
 
         [Fact]
@@ -1489,10 +1489,10 @@ public void Option_argument_arity_can_be_a_fixed_value_greater_than_1()
                    .GetResult(option)
                    .Tokens
                    .Should()
-                   .BeEquivalentTo(
+                   .BeEquivalentTo(new [] {
                        new Token("1", TokenType.Argument, default),
                        new Token("2", TokenType.Argument, default),
-                       new Token("3", TokenType.Argument, default));
+                       new Token("3", TokenType.Argument, default)});
         }
 
         [Fact]
@@ -1509,20 +1509,20 @@ public void Option_argument_arity_can_be_a_range_with_a_lower_bound_greater_than
                    .GetResult(option)
                    .Tokens
                    .Should()
-                   .BeEquivalentTo(
+                   .BeEquivalentTo(new [] {
                        new Token("1", TokenType.Argument, default),
                        new Token("2", TokenType.Argument, default),
-                       new Token("3", TokenType.Argument, default));
+                       new Token("3", TokenType.Argument, default)});
             command.Parse("-x 1 -x 2 -x 3 -x 4 -x 5")
                    .GetResult(option)
                    .Tokens
                    .Should()
-                   .BeEquivalentTo(
+                   .BeEquivalentTo(new [] {
                        new Token("1", TokenType.Argument, default),
                        new Token("2", TokenType.Argument, default),
                        new Token("3", TokenType.Argument, default),
                        new Token("4", TokenType.Argument, default),
-                       new Token("5", TokenType.Argument, default));
+                       new Token("5", TokenType.Argument, default)});
         }
 
         [Fact]
diff --git a/src/System.CommandLine.Tests/System.CommandLine.Tests.csproj b/src/System.CommandLine.Tests/System.CommandLine.Tests.csproj
@@ -25,7 +25,7 @@
   
   <ItemGroup>
     <PackageReference Include="ApprovalTests" />
-    <PackageReference Include="FluentAssertions" />
+    <PackageReference Include="AwesomeAssertions" />
     <PackageReference Include="Newtonsoft.Json" />
     <PackageReference Include="Microsoft.DotNet.PlatformAbstractions" />
   </ItemGroup>
diff --git a/src/System.CommandLine.Tests/Utility/AssertionExtensions.cs b/src/System.CommandLine.Tests/Utility/AssertionExtensions.cs
@@ -1,6 +1,7 @@
 ﻿// Copyright (c) .NET Foundation and contributors. All rights reserved.
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
+using System.Collections.Generic;
 using System.Linq;
 using FluentAssertions;
 using FluentAssertions.Collections;
@@ -38,7 +39,7 @@ public static AndConstraint<GenericCollectionAssertions<T>> BeEquivalentSequence
         return new AndConstraint<GenericCollectionAssertions<T>>(assertions);
     }
 
-    public static AndConstraint<StringCollectionAssertions> BeEquivalentSequenceTo(
+    public static AndConstraint<StringCollectionAssertions<IEnumerable<string>>> BeEquivalentSequenceTo(
         this StringCollectionAssertions assertions,
         params string[] expectedValues)
     {

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ public async Task Generated_boolean_parameters_will_accept_zero_arguments()`
`28`	`28`
`29`	`29`	`await config.InvokeAsync($"{RootCommand.ExecutableName} --value");`
`30`	`30`
`31`		`- _receivedValues.Should().BeEquivalentTo(true);`
	`31`	`+ _receivedValues.Should().BeEquivalentTo(new object[] { true });`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`[Theory]`
`@@ -47,7 +47,7 @@ public async Task Generated_boolean_parameters_will_accept_one_argument(string c`
`47`	`47`
`48`	`48`	`await config.InvokeAsync(commandLine);`
`49`	`49`
`50`		`- _receivedValues.Should().BeEquivalentTo(expected);`
	`50`	`+ _receivedValues.Should().BeEquivalentTo(new [] { expected });`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`[Fact]`
`@@ -220,7 +220,7 @@ public async Task Method_parameters_on_the_invoked_member_method_are_bound_to_ma`
`220`	`220`
`221`	`221`	`await command.Parse("--value").InvokeAsync();`
`222`	`222`
`223`		`- _receivedValues.Should().BeEquivalentTo(true);`
	`223`	`+ _receivedValues.Should().BeEquivalentTo(new [] { true });`
`224`	`224`	`}`
`225`	`225`
`226`	`226`	`[Fact]`
`@@ -231,7 +231,7 @@ public async Task Method_with_multiple_parameters_with_default_values_are_resolv`
`231`	`231`
`232`	`232`	`await command.Parse("").InvokeAsync();`
`233`	`233`
`234`		`- _receivedValues.Should().BeEquivalentTo(1, 2);`
	`234`	`+ _receivedValues.Should().BeEquivalentTo(new [] { 1, 2 });`
`235`	`235`	`}`
`236`	`236`
`237`	`237`	`internal void Method_taking_bool(bool value = false)`
Original file line number	Diff line number	Diff line change
`@@ -50,11 +50,11 @@ public void Global_tools_can_be_found()`
`50`	`50`
`51`	`51`	`registrationPairs`
`52`	`52`	`.Should()`
`53`		`- .BeEquivalentTo(`
	`53`	`+ .BeEquivalentTo( new [] {`
`54`	`54`	`new Registration(`
`55`	`55`	`Path.Combine(dotnetProfileDirectory, "tools", "dotnet-suggest")),`
`56`	`56`	`new Registration(`
`57`		`- Path.Combine(dotnetProfileDirectory, "tools", "t-rex")));`
	`57`	`+ Path.Combine(dotnetProfileDirectory, "tools", "t-rex"))});`
`58`	`58`	`}`
`59`	`59`	`}`
`60`	`60`	`}`
Original file line number	Diff line number	Diff line change
`@@ -311,6 +311,7 @@ public void When_a_subcommand_has_been_specified_then_its_sibling_commands_will_`
`311`	`311`	`var result = rootCommand.Parse("cherry ", simpleConfig);`
`312`	`312`
`313`	`313`	`result.GetCompletions()`
	`314`	`+ .Select(item => item.Label)`
`314`	`315`	`.Should()`
`315`	`316`	`.NotContain(new[]{"apple", "banana", "cherry"});`
`316`	`317`	`}`
`@@ -381,6 +382,7 @@ public void When_a_subcommand_has_been_specified_then_its_sibling_options_with_a`
`381`	`382`
`382`	`383`	`parseResult`
`383`	`384`	`.GetCompletions(commandLine.Length + 1)`
	`385`	`+ .Select(item => item.Label)`
`384`	`386`	`.Should()`
`385`	`387`	`.NotContain("--parent-option");`
`386`	`388`	`}`