add WithoutStrictOrdering for IJsonAssertionOptions<T>

Author: maximiliysiss

Src/FluentAssertions.Json/Common/JTokenExtensions.cs

@@ -0,0 +1,18 @@
+using System.Linq;
+using Newtonsoft.Json.Linq;
+
+namespace FluentAssertions.Json.Common
+{
+    internal static class JTokenExtensions
+    {
+        public static JToken Normalize(this JToken token)
+        {
+            return token switch
+            {
+                JObject obj => new JObject(obj.Properties().OrderBy(p => p.Name).Select(p => new JProperty(p.Name, Normalize(p.Value)))),
+                JArray array => new JArray(array.Select(Normalize).OrderBy(x => x.ToString(Newtonsoft.Json.Formatting.None))),
+                _ => token
+            };
+        }
+    }
+}

Src/FluentAssertions.Json/IJsonAssertionOptions.cs

@@ -16,5 +16,10 @@ public interface IJsonAssertionOptions<T>
         /// The assertion to execute when the predicate is met.
         /// </param>
         IJsonAssertionRestriction<T, TProperty> Using<TProperty>(Action<IAssertionContext<TProperty>> action);
+
+        /// <summary>
+        /// Configures the JSON assertion to ignore the order of elements in arrays or collections during comparison, allowing for equivalency checks regardless of element sequence.
+        /// </summary>
+        IJsonAssertionOptions<T> WithoutStrictOrdering();
     }
 }

Src/FluentAssertions.Json/JTokenDifferentiator.cs

@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using FluentAssertions.Execution;
+using FluentAssertions.Json.Common;
 using Newtonsoft.Json.Linq;
 
 namespace FluentAssertions.Json
@@ -11,12 +12,14 @@ internal class JTokenDifferentiator
         private readonly bool ignoreExtraProperties;
 
         private readonly Func<IJsonAssertionOptions<object>, IJsonAssertionOptions<object>> config;
+        private readonly JsonAssertionOptions<object> options;
 
         public JTokenDifferentiator(bool ignoreExtraProperties,
             Func<IJsonAssertionOptions<object>, IJsonAssertionOptions<object>> config)
         {
             this.ignoreExtraProperties = ignoreExtraProperties;
             this.config = config;
+            this.options = (JsonAssertionOptions<object>)config(new JsonAssertionOptions<object>());
         }
 
         public Difference FindFirstDifference(JToken actual, JToken expected)
@@ -38,6 +41,12 @@ public Difference FindFirstDifference(JToken actual, JToken expected)
                 return new Difference(DifferenceKind.ExpectedIsNull, path);
             }
 
+            if (options.IsStrictOrdering is false)
+            {
+                actual = actual.Normalize();
+                expected = expected.Normalize();
+            }
+
             return FindFirstDifference(actual, expected, path);
         }
 

Src/FluentAssertions.Json/JsonAssertionOptions.cs

@@ -4,17 +4,27 @@
 namespace FluentAssertions.Json
 {
     /// <summary>
-    /// Represents the run-time type-specific behavior of a JSON structural equivalency assertion. It is the equivalent of <see cref="FluentAssertions.Equivalency.EquivalencyAssertionOptions{T}"/>
+    /// Represents the run-time type-specific behavior of a JSON structural equivalency assertion. It is the equivalent of <see cref="FluentAssertions.Equivalency.EquivalencyOptions{T}"/>
     /// </summary>
     public sealed class JsonAssertionOptions<T> : EquivalencyOptions<T>, IJsonAssertionOptions<T>
     {
+        internal JsonAssertionOptions() { }
+
         public JsonAssertionOptions(EquivalencyOptions<T> equivalencyAssertionOptions) : base(equivalencyAssertionOptions)
         {
-
         }
+
+        public bool IsStrictOrdering { get; private set; } = true;
+
         public new IJsonAssertionRestriction<T, TProperty> Using<TProperty>(Action<IAssertionContext<TProperty>> action)
         {
             return new JsonAssertionRestriction<T, TProperty>(base.Using(action));
         }
+
+        public new IJsonAssertionOptions<T> WithoutStrictOrdering()
+        {
+            IsStrictOrdering = false;
+            return this;
+        }
     }
 }

Tests/FluentAssertions.Json.Specs/WithoutStrictOrderingSpecs.cs

@@ -0,0 +1,69 @@
+using System;
+using System.Collections.Generic;
+using Newtonsoft.Json.Linq;
+using Xunit;
+using Xunit.Sdk;
+
+namespace FluentAssertions.Json.Specs
+{
+    public class WithoutStrictOrderingSpecs
+    {
+        [Theory]
+        [MemberData(nameof(Should_HandleJToken_WhenNeedToIgnoreOrdering_SampleData))]
+        public void Should_HandleJToken_WhenNeedToIgnoreOrdering(string json1, string json2)
+        {
+            // Arrange
+            var j1 = JToken.Parse(json1);
+            var j2 = JToken.Parse(json2);
+
+            // Act
+            j1.Should().BeEquivalentTo(j2, opt => opt.WithoutStrictOrdering());
+
+            // Assert
+        }
+
+        [Theory]
+        [MemberData(nameof(Should_DoNotHandleJToken_WhenNoNeedToIgnoreOrdering_SampleData))]
+        public void Should_DoNotHandleJToken_WhenNoNeedToIgnoreOrdering(string json1, string json2)
+        {
+            // Arrange
+            var j1 = JToken.Parse(json1);
+            var j2 = JToken.Parse(json2);
+
+            // Act
+            var action = new Func<AndConstraint<JTokenAssertions>>(() => j1.Should().BeEquivalentTo(j2));
+
+            // Assert
+            action.Should().Throw<XunitException>();
+        }
+
+        public static IEnumerable<object[]> Should_DoNotHandleJToken_WhenNoNeedToIgnoreOrdering_SampleData()
+        {
+            yield return new object[] { @"{""ids"":[1,2,3]}", @"{""ids"":[3,2,1]}" };
+            yield return new object[] { @"{""names"":[""a"",""b""]}", @"{""names"":[""b"",""a""]}" };
+            yield return new object[]
+            {
+                @"{""vals"":[{""type"":1,""name"":""a""},{""name"":""b"",""type"":2}]}",
+                @"{""vals"":[{""type"":2,""name"":""b""},{""name"":""a"",""type"":1}]}"
+            };
+        }
+
+        public static IEnumerable<object[]> Should_HandleJToken_WhenNeedToIgnoreOrdering_SampleData()
+        {
+            yield return new object[] { @"{""ids"":[1,2,3]}", @"{""ids"":[3,2,1]}" };
+            yield return new object[] { @"{""ids"":[1,2,3]}", @"{""ids"":[1,2,3]}" };
+            yield return new object[] { @"{""type"":2,""name"":""b""}", @"{""name"":""b"",""type"":2}" };
+            yield return new object[] { @"{""names"":[""a"",""b""]}", @"{""names"":[""b"",""a""]}" };
+            yield return new object[]
+            {
+                @"{""vals"":[{""type"":1,""name"":""a""},{""name"":""b"",""type"":2}]}",
+                @"{""vals"":[{""type"":2,""name"":""b""},{""name"":""a"",""type"":1}]}"
+            };
+            yield return new object[]
+            {
+                @"{""vals"":[{""type"":1,""name"":""a""},{""name"":""b"",""type"":2}]}",
+                @"{""vals"":[{""name"":""a"",""type"":1},{""type"":2,""name"":""b""}]}"
+            };
+        }
+    }
+}