Fix failing tests when EF Core change tracker is purged more often (see next commit)

Author: Bart Koelman

test/JsonApiDotNetCoreExampleTests/IntegrationTests/Archiving/TelevisionFakers.cs

@@ -23,14 +23,17 @@ internal sealed class TelevisionFakers : FakerContainer
             new Faker<TelevisionBroadcast>()
                 .UseSeed(GetFakerSeed())
                 .RuleFor(broadcast => broadcast.Title, faker => faker.Lorem.Sentence())
-                .RuleFor(broadcast => broadcast.AiredAt, faker => faker.Date.PastOffset())
-                .RuleFor(broadcast => broadcast.ArchivedAt, faker => faker.Date.RecentOffset()));
+                .RuleFor(broadcast => broadcast.AiredAt, faker => faker.Date.PastOffset()
+                    .TruncateToWholeMilliseconds())
+                .RuleFor(broadcast => broadcast.ArchivedAt, faker => faker.Date.RecentOffset()
+                    .TruncateToWholeMilliseconds()));
 
         private readonly Lazy<Faker<BroadcastComment>> _lazyBroadcastCommentFaker = new(() =>
             new Faker<BroadcastComment>()
                 .UseSeed(GetFakerSeed())
                 .RuleFor(comment => comment.Text, faker => faker.Lorem.Paragraph())
-                .RuleFor(comment => comment.CreatedAt, faker => faker.Date.PastOffset()));
+                .RuleFor(comment => comment.CreatedAt, faker => faker.Date.PastOffset()
+                    .TruncateToWholeMilliseconds()));
 
         public Faker<TelevisionNetwork> TelevisionNetwork => _lazyTelevisionNetworkFaker.Value;
         public Faker<TelevisionStation> TelevisionStation => _lazyTelevisionStationFaker.Value;

test/JsonApiDotNetCoreExampleTests/IntegrationTests/AtomicOperations/Creating/AtomicCreateResourceWithClientGeneratedIdTests.cs

@@ -105,7 +105,8 @@ public async Task Can_create_resource_with_client_generated_string_ID_having_no_
                             attributes = new
                             {
                                 title = newTrack.Title,
-                                lengthInSeconds = newTrack.LengthInSeconds
+                                lengthInSeconds = newTrack.LengthInSeconds,
+                                releasedAt = newTrack.ReleasedAt
                             }
                         }
                     }

test/JsonApiDotNetCoreExampleTests/IntegrationTests/AtomicOperations/OperationsFakers.cs

@@ -30,7 +30,8 @@ internal sealed class OperationsFakers : FakerContainer
                 .RuleFor(musicTrack => musicTrack.Title, faker => faker.Lorem.Word())
                 .RuleFor(musicTrack => musicTrack.LengthInSeconds, faker => faker.Random.Decimal(3 * 60, 5 * 60))
                 .RuleFor(musicTrack => musicTrack.Genre, faker => faker.Lorem.Word())
-                .RuleFor(musicTrack => musicTrack.ReleasedAt, faker => faker.Date.PastOffset()));
+                .RuleFor(musicTrack => musicTrack.ReleasedAt, faker => faker.Date.PastOffset()
+                    .TruncateToWholeMilliseconds()));
 
         private readonly Lazy<Faker<Lyric>> _lazyLyricFaker = new(() =>
             new Faker<Lyric>()
@@ -47,7 +48,8 @@ internal sealed class OperationsFakers : FakerContainer
             new Faker<Performer>()
                 .UseSeed(GetFakerSeed())
                 .RuleFor(performer => performer.ArtistName, faker => faker.Name.FullName())
-                .RuleFor(performer => performer.BornAt, faker => faker.Date.PastOffset()));
+                .RuleFor(performer => performer.BornAt, faker => faker.Date.PastOffset()
+                    .TruncateToWholeMilliseconds()));
 
         private readonly Lazy<Faker<RecordCompany>> _lazyRecordCompanyFaker = new(() =>
             new Faker<RecordCompany>()

test/JsonApiDotNetCoreExampleTests/IntegrationTests/Logging/AuditFakers.cs

@@ -13,7 +13,8 @@ internal sealed class AuditFakers : FakerContainer
             new Faker<AuditEntry>()
                 .UseSeed(GetFakerSeed())
                 .RuleFor(auditEntry => auditEntry.UserName, faker => faker.Internet.UserName())
-                .RuleFor(auditEntry => auditEntry.CreatedAt, faker => faker.Date.PastOffset()));
+                .RuleFor(auditEntry => auditEntry.CreatedAt, faker => faker.Date.PastOffset()
+                    .TruncateToWholeMilliseconds()));
 
         public Faker<AuditEntry> AuditEntry => _lazyAuditEntryFaker.Value;
     }

test/JsonApiDotNetCoreExampleTests/IntegrationTests/QueryStrings/QueryStringFakers.cs

@@ -31,7 +31,8 @@ internal sealed class QueryStringFakers : FakerContainer
             new Faker<Comment>()
                 .UseSeed(GetFakerSeed())
                 .RuleFor(comment => comment.Text, faker => faker.Lorem.Paragraph())
-                .RuleFor(comment => comment.CreatedAt, faker => faker.Date.Past()));
+                .RuleFor(comment => comment.CreatedAt, faker => faker.Date.Past()
+                    .TruncateToWholeMilliseconds()));
 
         private readonly Lazy<Faker<WebAccount>> _lazyWebAccountFaker = new(() =>
             new Faker<WebAccount>()
@@ -57,7 +58,8 @@ internal sealed class QueryStringFakers : FakerContainer
             new Faker<Appointment>()
                 .UseSeed(GetFakerSeed())
                 .RuleFor(appointment => appointment.Title, faker => faker.Random.Word())
-                .RuleFor(appointment => appointment.StartTime, faker => faker.Date.FutureOffset())
+                .RuleFor(appointment => appointment.StartTime, faker => faker.Date.FutureOffset()
+                    .TruncateToWholeMilliseconds())
                 .RuleFor(appointment => appointment.EndTime, (faker, appointment) => appointment.StartTime.AddHours(faker.Random.Double(1, 4))));
 
         public Faker<Blog> Blog => _lazyBlogFaker.Value;

test/JsonApiDotNetCoreExampleTests/IntegrationTests/ReadWrite/ReadWriteFakers.cs

@@ -13,7 +13,8 @@ internal sealed class ReadWriteFakers : FakerContainer
             new Faker<WorkItem>()
                 .UseSeed(GetFakerSeed())
                 .RuleFor(workItem => workItem.Description, faker => faker.Lorem.Sentence())
-                .RuleFor(workItem => workItem.DueAt, faker => faker.Date.Future())
+                .RuleFor(workItem => workItem.DueAt, faker => faker.Date.Future()
+                    .TruncateToWholeMilliseconds())
                 .RuleFor(workItem => workItem.Priority, faker => faker.PickRandom<WorkItemPriority>()));
 
         private readonly Lazy<Faker<WorkTag>> _lazyWorkTagFaker = new(() =>

test/JsonApiDotNetCoreExampleTests/IntegrationTests/RequiredRelationships/DefaultBehaviorFakers.cs

@@ -23,7 +23,8 @@ internal sealed class DefaultBehaviorFakers : FakerContainer
             new Faker<Shipment>()
                 .UseSeed(GetFakerSeed())
                 .RuleFor(shipment => shipment.TrackAndTraceCode, faker => faker.Commerce.Ean13())
-                .RuleFor(shipment => shipment.ShippedAt, faker => faker.Date.Past()));
+                .RuleFor(shipment => shipment.ShippedAt, faker => faker.Date.Past()
+                    .TruncateToWholeMilliseconds()));
 
         public Faker<Order> Orders => _orderFaker.Value;
         public Faker<Customer> Customers => _customerFaker.Value;

test/JsonApiDotNetCoreExampleTests/IntegrationTests/ResourceConstructorInjection/InjectionFakers.cs

@@ -35,7 +35,8 @@ public InjectionFakers(IServiceProvider serviceProvider)
                 new Faker<GiftCertificate>()
                     .UseSeed(GetFakerSeed())
                     .CustomInstantiator(_ => new GiftCertificate(ResolveDbContext()))
-                    .RuleFor(giftCertificate => giftCertificate.IssueDate, faker => faker.Date.PastOffset()));
+                    .RuleFor(giftCertificate => giftCertificate.IssueDate, faker => faker.Date.PastOffset()
+                        .TruncateToWholeMilliseconds()));
         }
 
         private InjectionDbContext ResolveDbContext()

test/JsonApiDotNetCoreExampleTests/IntegrationTests/Serialization/SerializationFakers.cs

@@ -21,7 +21,8 @@ internal sealed class SerializationFakers : FakerContainer
             new Faker<Meeting>()
                 .UseSeed(GetFakerSeed())
                 .RuleFor(meeting => meeting.Title, faker => faker.Lorem.Word())
-                .RuleFor(meeting => meeting.StartTime, faker => TruncateToWholeMilliseconds(faker.Date.FutureOffset()))
+                .RuleFor(meeting => meeting.StartTime, faker => faker.Date.FutureOffset()
+                    .TruncateToWholeMilliseconds())
                 .RuleFor(meeting => meeting.Duration, faker => faker.PickRandom(MeetingDurations))
                 .RuleFor(meeting => meeting.Latitude, faker => faker.Address.Latitude())
                 .RuleFor(meeting => meeting.Longitude, faker => faker.Address.Longitude()));
@@ -33,13 +34,5 @@ internal sealed class SerializationFakers : FakerContainer
 
         public Faker<Meeting> Meeting => _lazyMeetingFaker.Value;
         public Faker<MeetingAttendee> MeetingAttendee => _lazyMeetingAttendeeFaker.Value;
-
-        private static DateTimeOffset TruncateToWholeMilliseconds(DateTimeOffset value)
-        {
-            long ticksToSubtract = value.DateTime.Ticks % TimeSpan.TicksPerMillisecond;
-            long ticksInWholeMilliseconds = value.DateTime.Ticks - ticksToSubtract;
-
-            return new DateTimeOffset(new DateTime(ticksInWholeMilliseconds), value.Offset);
-        }
     }
 }

test/TestBuildingBlocks/DateTimeExtensions.cs

@@ -0,0 +1,34 @@
+using System;
+
+namespace TestBuildingBlocks
+{
+    public static class DateTimeExtensions
+    {
+        // The milliseconds precision in DateTime/DateTimeOffset values that fakers produce is higher
+        // than what PostgreSQL can store. This results in our resource change tracker to detect
+        // that the time stored in database differs from the time in the request body.
+        // While that's technically correct, we don't want such side effects influencing our tests everywhere.
+
+        public static DateTimeOffset TruncateToWholeMilliseconds(this DateTimeOffset value)
+        {
+            DateTime dateTime = TruncateToWholeMilliseconds(value.DateTime);
+
+            // PostgreSQL is unable to store the timezone in the database, so it always uses the local zone.
+            // See https://www.npgsql.org/doc/types/datetime.html.
+            // We're taking the local zone here, to prevent our change tracker to detect that the time
+            // stored in database differs from the time in the request body. While that's technically
+            // correct, we don't want such side effects influencing our tests everywhere.
+            TimeSpan offset = TimeZoneInfo.Local.GetUtcOffset(dateTime);
+
+            return new DateTimeOffset(dateTime, offset);
+        }
+
+        public static DateTime TruncateToWholeMilliseconds(this DateTime value)
+        {
+            long ticksToSubtract = value.Ticks % TimeSpan.TicksPerMillisecond;
+            long ticksInWholeMilliseconds = value.Ticks - ticksToSubtract;
+
+            return new DateTime(ticksInWholeMilliseconds, value.Kind);
+        }
+    }
+}