Implemented TestBase.AssertJsonResponse

Author: C0nquistadore

src/Dibix.Testing/Http/WebApiTestBase.cs

@@ -1,14 +1,11 @@
 using System;
 using System.Linq.Expressions;
 using System.Net.Http;
-using System.Text.RegularExpressions;
 using System.Threading.Tasks;
 using Dibix.Http.Client;
 using Dibix.Testing.Data;
 using Microsoft.Extensions.DependencyInjection;
 using Newtonsoft.Json;
-using Newtonsoft.Json.Linq;
-using Newtonsoft.Json.Serialization;
 
 namespace Dibix.Testing.Http
 {
@@ -55,13 +52,13 @@ protected async Task<TResponseContent> InvokeApi<TService, TResponseContent>(TSe
         protected async Task<TResponseContent> InvokeApiAndAssertResponse<TService, TResponseContent>(TService service, Expression<Func<TService, Task<HttpResponse<TResponseContent>>>> methodSelector, string expectedText = null, string outputName = null, Action<JsonSerializerSettings> configureSerializer = null)
         {
             HttpResponse<TResponseContent> response = await InvokeApiCore(service, methodSelector).ConfigureAwait(false);
-            Assert(response, expectedText, outputName, configureSerializer);
+            AssertJsonResponse(response.ResponseContent, configureSerializer, outputName, expectedText);
             return response.ResponseContent;
         }
         protected async Task<TResponseContent> InvokeApiAndAssertResponse<TService, TResponseContent>(HttpTestContext context, Expression<Func<TService, Task<HttpResponse<TResponseContent>>>> methodSelector, string expectedText = null, string outputName = null, Action<JsonSerializerSettings> configureSerializer = null)
         {
             HttpResponse<TResponseContent> response = await CreateServiceAndInvokeApi(context, methodSelector).ConfigureAwait(false);
-            Assert(response, expectedText, outputName, configureSerializer);
+            AssertJsonResponse(response.ResponseContent, configureSerializer, outputName, expectedText);
             return response.ResponseContent;
         }
 
@@ -85,32 +82,6 @@ private static Task<TResponse> CreateServiceAndInvokeApi<TService, TResponse>(Ht
             return InvokeApiCore(service, methodSelector);
         }
 
-        private void Assert<TResponseContent>(HttpResponse<TResponseContent> response, string expectedText, string outputName, Action<JsonSerializerSettings> configureSerializer)
-        {
-            JsonSerializerSettings settings = new JsonSerializerSettings
-            {
-                ContractResolver = new DefaultContractResolver { NamingStrategy = new CamelCaseNamingStrategy() },
-                Formatting = Formatting.Indented,
-                DateTimeZoneHandling = DateTimeZoneHandling.Unspecified
-            };
-            configureSerializer?.Invoke(settings);
-
-            const string extension = "json";
-            string outputNameResolved = outputName ?? TestContext.TestName;
-            string expectedTextResolved = expectedText ?? GetEmbeddedResourceContent($"{outputNameResolved}.{extension}");
-            string actualText = JsonConvert.SerializeObject(response.ResponseContent, settings);
-            JToken actualTextDom = JToken.Parse(actualText);
-            string expectedTextReplaced = Regex.Replace(expectedTextResolved, @"\{(?<path>[A-Za-z.]+)\}", x =>
-            {
-                string path = x.Groups["path"].Value;
-                if (!(actualTextDom.SelectToken(path) is JValue value) || value.Value == null)
-                    throw new InvalidOperationException($"Replace pattern did not match a JSON path in the actual document: {path} ({x.Index})");
-
-                return value.Value.ToString();
-            });
-            AssertEqual(expectedTextReplaced, actualText, outputNameResolved, extension: extension);
-        }
-
         private static HttpTestContext CreateTestContext(IHttpClientFactory httpClientFactory, HttpClientOptions httpClientOptions, IHttpAuthorizationProvider authorizationProvider)
         {
             return new HttpTestContext(httpClientFactory, httpClientOptions, authorizationProvider);

src/Dibix.Testing/TestBase.cs

@@ -4,11 +4,15 @@
 using System.Linq;
 using System.Reflection;
 using System.Runtime.CompilerServices;
+using System.Text;
+using System.Text.RegularExpressions;
 using System.Threading;
 using System.Threading.Tasks;
 using Dibix.Testing.Configuration;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
 using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+using Newtonsoft.Json.Serialization;
 
 namespace Dibix.Testing
 {
@@ -119,6 +123,51 @@ protected void AssertEqual(string expected, string actual, string outputName, st
             throw new AssertTextFailedException(expectedNormalized, actualNormalized, message);
         }
 
+        protected void AssertJsonResponse<T>(T response, Action<JsonSerializerSettings> configureSerializer = null, string outputName = null, string expectedText = null)
+        {
+            JsonSerializerSettings settings = new JsonSerializerSettings
+            {
+                ContractResolver = new DefaultContractResolver { NamingStrategy = new CamelCaseNamingStrategy() },
+                Formatting = Formatting.Indented,
+                DateTimeZoneHandling = DateTimeZoneHandling.Unspecified
+            };
+            configureSerializer?.Invoke(settings);
+
+            const string extension = "json";
+            string outputNameResolved = outputName ?? TestContext.TestName;
+            string expectedTextResolved = expectedText ?? GetEmbeddedResourceContent($"{outputNameResolved}.{extension}");
+            string actualText = JsonConvert.SerializeObject(response, settings);
+            JToken actualTextDom = JToken.Parse(actualText);
+
+            // Replace JSON path placeholders in the expected text with values from the actual text
+            // This is useful for undeterministic values like IDs
+            // Example:
+            // {
+            //   "values": [
+            //     {
+            //       "id": "{values[0].id}"
+            //     }
+            //   ]
+            // }
+            string expectedTextReplaced = Regex.Replace(expectedTextResolved, """
+                                                                              "{(?<path>([A-Za-z]+(\[[\d]+\])?)(\.([A-Za-z]+(\[[\d]+\])?)){0,})\}"
+                                                                              """, x =>
+            {
+                string path = x.Groups["path"].Value;
+                if (actualTextDom.SelectToken(path) is not JValue jsonValue || jsonValue.Value == null)
+                    throw new InvalidOperationException($"Replace pattern did not match a JSON path in the actual document: {path} ({x.Index})");
+
+                StringBuilder sb = new StringBuilder();
+                using TextWriter textWriter = new StringWriter(sb);
+                using JsonWriter writer = new JsonTextWriter(textWriter);
+                jsonValue.WriteTo(writer);
+                string replacement = sb.ToString();
+                return replacement;
+            });
+
+            AssertEqual(expectedTextReplaced, actualText, outputNameResolved, extension: extension);
+        }
+
         protected void LogException(Exception exception) => TestResultFileManager.AddTestFile("AdditionalErrors.txt", $@"An error occured while collecting the last event log errors
 {exception}");