feat: ManualTimeProvider sets local time zone to UTC by default, allow setting during testing

Author: egil

CHANGELOG.md

@@ -6,6 +6,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+## [1.0.0-preview.2]
+
+- Changed ManualTestProvider sets the local time zone to UTC by default, provides method for overriding during testing.
+- Changed `ManualTestProvider` sets the local time zone to UTC by default, provides method for overriding during testing.
 
 ## [1.0.0-preview.1]
 

src/TimeProviderExtensions/ManualTimeProvider.cs

@@ -24,6 +24,7 @@ public class ManualTimeProvider : TimeProvider
 
     private readonly List<ManualTimerScheduledCallback> futureCallbacks = new();
     private DateTimeOffset utcNow;
+    private TimeZoneInfo localTimeZone = TimeZoneInfo.Utc;
 
     /// <summary>
     /// Gets the frequency of <see cref="GetTimestamp"/> of high-frequency value per second.
@@ -34,14 +35,21 @@ public class ManualTimeProvider : TimeProvider
     /// </remarks>
     public override long TimestampFrequency { get; } = 10_000_000;
 
+    /// <inheritdoc />
+    public override TimeZoneInfo LocalTimeZone => localTimeZone;
+
     /// <summary>
     /// Creates an instance of the <see cref="ManualTimeProvider"/> with
     /// <see cref="DateTimeOffset.UtcNow"/> being the initial value returned by <see cref="GetUtcNow()"/>.
     /// </summary>
     public ManualTimeProvider()
         : this(System.GetUtcNow())
+    /// <param name="localTimeZone">Optional local time zone to use during testing. Defaults to <see cref="TimeZoneInfo.Utc"/>.</param>
+    public ManualTimeProvider(TimeZoneInfo? localTimeZone = null)
+        : this(Epoch)
     {
 
+        this.localTimeZone = localTimeZone ?? TimeZoneInfo.Utc;
     }
 
     /// <summary>
@@ -54,6 +62,18 @@ public ManualTimeProvider(DateTimeOffset startDateTime)
         utcNow = startDateTime;
     }
 
+    /// <summary>
+    /// Creates an instance of the <see cref="ManualTimeProvider"/> with
+    /// <paramref name="startDateTime"/> being the initial value returned by <see cref="GetUtcNow()"/>.
+    /// </summary>
+    /// <param name="startDateTime">The initial date and time <see cref="GetUtcNow()"/> will return.</param>
+    /// <param name="localTimeZone">Optional local time zone to use during testing. Defaults to <see cref="TimeZoneInfo.Utc"/>.</param>
+    public ManualTimeProvider(DateTimeOffset startDateTime, TimeZoneInfo? localTimeZone = null)
+    {
+        utcNow = startDateTime;
+        this.localTimeZone = localTimeZone ?? TimeZoneInfo.Utc;
+    }
+
     /// <summary>
     /// Gets the current high-frequency value designed to measure small time intervals with high accuracy in the timer mechanism.
     /// </summary>
@@ -128,6 +148,15 @@ public void ForwardTime(TimeSpan delta)
         SetUtcNow(utcNow + delta);
     }
 
+    /// <summary>
+    /// Sets the local time zone.
+    /// </summary>
+    /// <param name="localTimeZone">The local time zone.</param>
+    public void SetLocalTimeZone(TimeZoneInfo localTimeZone)
+    {
+        this.localTimeZone = localTimeZone;
+    }
+
     /// <summary>
     /// Advance the date and time represented by <see cref="GetUtcNow()"/>
     /// by the specified <paramref name="delta"/>, and triggers any