Fixed assertions on DateTime/DateTimeOffset in tests

Author: Bart Koelman

test/JsonApiDotNetCoreExampleTests/IntegrationTestConfiguration.cs

@@ -0,0 +1,19 @@
+using Newtonsoft.Json;
+
+namespace JsonApiDotNetCoreExampleTests
+{
+    internal static class IntegrationTestConfiguration
+    {
+        // Because our tests often deserialize incoming responses into weakly-typed string-to-object dictionaries (as part of ResourceObject),
+        // Newtonsoft.JSON is unable to infer the target type in such cases. So we steer a bit using explicit configuration.
+        public static readonly JsonSerializerSettings DeserializationSettings = new JsonSerializerSettings
+        {
+            // Choosing between DateTime and DateTimeOffset is impossible: it depends on how the resource properties are declared.
+            // So instead we leave them as strings and let the test itself deal with the conversion.
+            DateParseHandling = DateParseHandling.None,
+
+            // Here we must choose between double (default) and decimal. Favored decimal because it has higher precision (but lower range).
+            FloatParseHandling = FloatParseHandling.Decimal
+        };
+    }
+}

test/JsonApiDotNetCoreExampleTests/IntegrationTestContext.cs

@@ -189,7 +189,8 @@ private TResponseDocument DeserializeResponse<TResponseDocument>(string response
 
             try
             {
-                return JsonConvert.DeserializeObject<TResponseDocument>(responseText);
+                return JsonConvert.DeserializeObject<TResponseDocument>(responseText,
+                    IntegrationTestConfiguration.DeserializationSettings);
             }
             catch (JsonException exception)
             {

test/JsonApiDotNetCoreExampleTests/IntegrationTests/Filtering/FilterDataTypeTests.cs

@@ -2,6 +2,7 @@
 using System.Net;
 using System.Threading.Tasks;
 using FluentAssertions;
+using FluentAssertions.Common;
 using FluentAssertions.Extensions;
 using Humanizer;
 using JsonApiDotNetCore.Configuration;
@@ -138,7 +139,7 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>
             httpResponse.Should().HaveStatusCode(HttpStatusCode.OK);
 
             responseDocument.ManyData.Should().HaveCount(1);
-            responseDocument.ManyData[0].Attributes["someDateTime"].Should().Be(resource.SomeDateTime);
+            responseDocument.ManyData[0].Attributes["someDateTime"].Should().BeCloseTo(resource.SomeDateTime);
         }
 
         [Fact]
@@ -147,7 +148,7 @@ public async Task Can_filter_equality_on_type_DateTimeOffset()
             // Arrange
             var resource = new FilterableResource
             {
-                SomeDateTimeOffset = new DateTimeOffset(27.January(2003).At(11, 22, 33, 44), TimeSpan.FromHours(3))
+                SomeDateTimeOffset = 27.January(2003).At(11, 22, 33, 44).ToDateTimeOffset(TimeSpan.FromHours(3))
             };
 
             await _testContext.RunOnDatabaseAsync(async dbContext =>
@@ -167,7 +168,7 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>
             httpResponse.Should().HaveStatusCode(HttpStatusCode.OK);
 
             responseDocument.ManyData.Should().HaveCount(1);
-            responseDocument.ManyData[0].Attributes["someDateTimeOffset"].Should().Be(resource.SomeDateTimeOffset.LocalDateTime);
+            responseDocument.ManyData[0].Attributes["someDateTimeOffset"].Should().BeCloseTo(resource.SomeDateTimeOffset);
         }
 
         [Fact]
@@ -254,7 +255,7 @@ public async Task Can_filter_is_null_on_type(string propertyName)
                 SomeNullableDouble = 1,
                 SomeNullableGuid = Guid.NewGuid(),
                 SomeNullableDateTime = 1.January(2001),
-                SomeNullableDateTimeOffset = 1.January(2001),
+                SomeNullableDateTimeOffset = 1.January(2001).ToDateTimeOffset(TimeSpan.FromHours(-1)),
                 SomeNullableTimeSpan = TimeSpan.FromHours(1),
                 SomeNullableEnum = DayOfWeek.Friday
             };
@@ -305,7 +306,7 @@ public async Task Can_filter_is_not_null_on_type(string propertyName)
                 SomeNullableDouble = 1,
                 SomeNullableGuid = Guid.NewGuid(),
                 SomeNullableDateTime = 1.January(2001),
-                SomeNullableDateTimeOffset = 1.January(2001),
+                SomeNullableDateTimeOffset = 1.January(2001).ToDateTimeOffset(TimeSpan.FromHours(-1)),
                 SomeNullableTimeSpan = TimeSpan.FromHours(1),
                 SomeNullableEnum = DayOfWeek.Friday
             };

test/JsonApiDotNetCoreExampleTests/IntegrationTests/Filtering/FilterOperatorTests.cs

@@ -381,7 +381,7 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>
             httpResponse.Should().HaveStatusCode(HttpStatusCode.OK);
 
             responseDocument.ManyData.Should().HaveCount(1);
-            responseDocument.ManyData[0].Attributes["someDateTime"].Should().Be(resource.SomeDateTime);
+            responseDocument.ManyData[0].Attributes["someDateTime"].Should().BeCloseTo(resource.SomeDateTime);
         }
 
         [Theory]

test/JsonApiDotNetCoreExampleTests/IntegrationTests/Includes/IncludeTests.cs

@@ -282,7 +282,7 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>
             responseDocument.Included.Should().HaveCount(1);
             responseDocument.Included[0].Type.Should().Be("revisions");
             responseDocument.Included[0].Id.Should().Be(article.Revisions.Single().StringId);
-            responseDocument.Included[0].Attributes["publishTime"].Should().Be(article.Revisions.Single().PublishTime);
+            responseDocument.Included[0].Attributes["publishTime"].Should().BeCloseTo(article.Revisions.Single().PublishTime);
         }
 
         [Fact]
@@ -479,7 +479,7 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>
 
             responseDocument.Included[1].Type.Should().Be("revisions");
             responseDocument.Included[1].Id.Should().Be(blog.Articles[0].Revisions.Single().StringId);
-            responseDocument.Included[1].Attributes["publishTime"].Should().Be(blog.Articles[0].Revisions.Single().PublishTime);
+            responseDocument.Included[1].Attributes["publishTime"].Should().BeCloseTo(blog.Articles[0].Revisions.Single().PublishTime);
         }
 
         [Fact]

test/JsonApiDotNetCoreExampleTests/IntegrationTests/NamingConventions/KebabCasingTests.cs

@@ -50,7 +50,7 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>
             responseDocument.Included.Should().HaveCount(1);
             responseDocument.Included[0].Type.Should().Be("diving-boards");
             responseDocument.Included[0].Id.Should().Be(pools[1].DivingBoards[0].StringId);
-            responseDocument.Included[0].Attributes["height-in-meters"].Should().BeApproximately(pools[1].DivingBoards[0].HeightInMeters);
+            responseDocument.Included[0].Attributes["height-in-meters"].As<decimal>().Should().BeApproximately(pools[1].DivingBoards[0].HeightInMeters, 0.00000000001M);
             responseDocument.Included[0].Relationships.Should().BeNull();
             responseDocument.Included[0].Links.Self.Should().Be($"/public-api/diving-boards/{pools[1].DivingBoards[0].StringId}");
 

test/JsonApiDotNetCoreExampleTests/IntegrationTests/ObjectAssertionsExtensions.cs

@@ -7,7 +7,9 @@ namespace JsonApiDotNetCoreExampleTests.IntegrationTests
     public static class ObjectAssertionsExtensions
     {
         /// <summary>
-        /// Used to assert on a nullable <see cref="DateTimeOffset"/> column, whose value is returned as <see cref="DateTime"/> in JSON:API response body.
+        /// Used to assert on a (nullable) <see cref="DateTime"/> or <see cref="DateTimeOffset"/> property,
+        /// whose value is returned as <see cref="string"/> in JSON:API response body
+        /// because of <see cref="IntegrationTestConfiguration.DeserializationSettings"/>.
         /// </summary>
         public static void BeCloseTo(this ObjectAssertions source, DateTimeOffset? expected, string because = "",
             params object[] becauseArgs)
@@ -18,23 +20,14 @@ public static void BeCloseTo(this ObjectAssertions source, DateTimeOffset? expec
             }
             else
             {
-                // We lose a little bit of precision (milliseconds) on roundtrip through PostgreSQL database.
+                if (!DateTimeOffset.TryParse((string) source.Subject, out var value))
+                {
+                    source.Subject.Should().Be(expected, because, becauseArgs);
+                }
 
-                var value = new DateTimeOffset((DateTime) source.Subject);
+                // We lose a little bit of precision (milliseconds) on roundtrip through PostgreSQL database.
                 value.Should().BeCloseTo(expected.Value, because: because, becauseArgs: becauseArgs);
             }
         }
-
-        /// <summary>
-        /// Used to assert on a <see cref="decimal"/> column, whose value is returned as <see cref="double"/> in json:api response body.
-        /// </summary>
-        public static void BeApproximately(this ObjectAssertions source, decimal? expected, decimal precision = 0.00000000001M, string because = "",
-            params object[] becauseArgs)
-        {
-            // We lose a little bit of precision on roundtrip through PostgreSQL database.
-
-            var value = (decimal?) (double) source.Subject;
-            value.Should().BeApproximately(expected, precision, because, becauseArgs);
-        }
     }
 }

test/JsonApiDotNetCoreExampleTests/IntegrationTests/ResourceConstructorInjection/ResourceInjectionTests.cs

@@ -1,8 +1,7 @@
-using System;
-using System.Linq;
 using System.Net;
 using System.Threading.Tasks;
 using FluentAssertions;
+using FluentAssertions.Common;
 using FluentAssertions.Extensions;
 using JsonApiDotNetCore.Serialization.Objects;
 using Microsoft.AspNetCore.Authentication;
@@ -56,7 +55,7 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>
 
             responseDocument.SingleData.Should().NotBeNull();
             responseDocument.SingleData.Id.Should().Be(certificate.StringId);
-            responseDocument.SingleData.Attributes["issueDate"].Should().Be(certificate.IssueDate.DateTime);
+            responseDocument.SingleData.Attributes["issueDate"].Should().BeCloseTo(certificate.IssueDate);
             responseDocument.SingleData.Attributes["hasExpired"].Should().Be(false);
         }
 
@@ -129,7 +128,7 @@ public async Task Can_create_resource_with_ToOne_relationship_and_include()
 
             var existingOffice = _fakers.PostOffice.Generate();
 
-            var newIssueDate = 18.March(1997);
+            var newIssueDate = 18.March(1997).ToDateTimeOffset();
 
             await _testContext.RunOnDatabaseAsync(async dbContext =>
             {
@@ -169,7 +168,7 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>
             httpResponse.Should().HaveStatusCode(HttpStatusCode.Created);
 
             responseDocument.SingleData.Should().NotBeNull();
-            responseDocument.SingleData.Attributes["issueDate"].Should().Be(newIssueDate);
+            responseDocument.SingleData.Attributes["issueDate"].Should().BeCloseTo(newIssueDate);
             responseDocument.SingleData.Attributes["hasExpired"].Should().Be(true);
             responseDocument.SingleData.Relationships["issuer"].SingleData.Id.Should().Be(existingOffice.StringId);
 

test/JsonApiDotNetCoreExampleTests/IntegrationTests/SparseFieldSets/SparseFieldSetTests.cs

@@ -641,7 +641,7 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>
             responseDocument.Included[0].Id.Should().Be(blog.Owner.StringId);
             responseDocument.Included[0].Attributes["firstName"].Should().Be(blog.Owner.FirstName);
             responseDocument.Included[0].Attributes["lastName"].Should().Be(blog.Owner.LastName);
-            responseDocument.Included[0].Attributes["dateOfBirth"].Should().Be(blog.Owner.DateOfBirth);
+            responseDocument.Included[0].Attributes["dateOfBirth"].Should().BeCloseTo(blog.Owner.DateOfBirth);
             responseDocument.Included[0].Relationships["articles"].ManyData.Should().HaveCount(1);
             responseDocument.Included[0].Relationships["articles"].ManyData[0].Id.Should().Be(blog.Owner.Articles[0].StringId);
             responseDocument.Included[0].Relationships["articles"].Links.Self.Should().NotBeNull();