feat: Added support for netstandard2.0

Author: egil

CHANGELOG.md

@@ -5,6 +5,10 @@ All notable changes to TimeProviderExtensions will be documented in this file.
 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).
 
+## [1.0.0-preview.7]
+
+- Added support for netstandard2.0, as this is supported by the back-port package https://www.nuget.org/packages/Microsoft.Bcl.TimeProvider.
+
 ## [1.0.0-preview.6]
 
 - Added `Jump(TimeSpan)` and `Jump(DateTimeOffset)` methods that will jump time to the specified place. Any timer callbacks between the start and end of the jump will be invoked the expected number of times, but the date/time returned from `GetUtcNow()` and `GetTimestamp()` will always be the jump time. This differs from how `Advance` and `SetUtcNow` works. See the readme for a detailed description.

README.md

@@ -1,10 +1,29 @@
+[![GitHub tag (latest SemVer pre-release)](https://img.shields.io/github/v/tag/egil/TimeProviderExtensions?include_prereleases&logo=github&style=flat-square)](https://github.com/egil/TimeProviderExtensions/releases)
+[![Nuget](https://img.shields.io/nuget/dt/TimeProviderExtensions?logo=nuget&style=flat-square)](https://www.nuget.org/packages/TimeProviderExtensions/)
+[![Issues Open](https://img.shields.io/github/issues/egil/TimeProviderExtensions.svg?style=flat-square&logo=github)](https://github.com/egil/TimeProviderExtensions/issues)
+
 # TimeProvider Extensions
 
-Extensions for [`System.TimeProvider`](https://learn.microsoft.com/en-us/dotnet/api/system.timeprovider) API. It includes a version of the `TimeProvider` type, named `ManualTimeProvider`, that allows you to control the progress of time during testing deterministically.
+Extensions for the [`System.TimeProvider`](https://learn.microsoft.com/en-us/dotnet/api/system.timeprovider) API. It includes:
+
+- A test/fake version of `TimeProvider` type, named `ManualTimeProvider`, that allows you to control the progress of time during testing deterministically.
+- A backported version of `PeriodicTimer` that supports `TimeProvider` in .NET 6.
+
+## Quick start
+
+This describes how to get started:
+
+1. Get the latest release from https://www.nuget.org/packages/TimeProviderExtensions.
+
+2. Take a dependency on `TimeProvider` in your code. Inject the production version of `TimeProvider` available via the [`TimeProvider.System`](https://learn.microsoft.com/en-us/dotnet/api/system.timeprovider.system?#system-timeprovider-system) property during production.
+
+3. During testing, inject the `ManualTimeProvider` from this library. With `ManualTimeProvider`, you can move advance time by calling `Advance(TimeSpan)` or `SetUtcNow(DateTimeOffset)` and jump ahead in time using `Jump(TimeSpan)` or `Jump(DateTimeOffset)`. This allows you to write tests that run fast and predictably, even if the system under test pauses execution for multiple minutes using e.g. `TimeProvider.Delay(TimeSpan)`, the replacement for `Task.Delay(TimeSpan)`.
+
+Read the rest of this README for further details and examples.
 
-An instance of `TimeProvider` for production use is available on the [`TimeProvider.System`](https://learn.microsoft.com/en-us/dotnet/api/system.timeprovider.system?#system-timeprovider-system) property, and `ManualTimeProvider` can be used during testing.
+## ManualTimeProvider API
 
-During testing, you can move time forward by calling `Advance(TimeSpan)` or `SetUtcNow(DateTimeOffset)` on `ManualTimeProvider`. This allows you to write tests that run fast and predictably, even if the system under test pauses execution for multiple minutes using e.g. `TimeProvider.Delay(TimeSpan)`, the replacement for `Task.Delay(TimeSpan)`.
+The ManualTimeProvider represents a synthetic time provider that can be used to enable deterministic behavior in tests.
 
 ## Difference between `ManualTimeProvider` and `FakeTimeProvider`
 
@@ -49,11 +68,11 @@ To support testing this scenario, `ManualtTimeProvider` includes a method that w
   fixture.Customize<ManualTimeProvider>(x => x.With(tp => tp.AutoAdvanceAmount, TimeSpan.Zero));
   ```
 
-## Installation
+## Installation and Usage
 
 Get the latest release from https://www.nuget.org/packages/TimeProviderExtensions
 
-## Set up in production
+### Set up in production
 
 To use in production, pass in `TimeProvider.System` to the types that depend on `TimeProvider`.
 This can be done directly or via an IoC Container, e.g. .NETs built-in `IServiceCollection` like so:
@@ -84,7 +103,7 @@ public class MyService
 
 This allows you to explicitly pass in a `ManualTimeProvider` during testing.
 
-## Example - control time during tests
+### Example - control time during tests
 
 If a system under test (SUT) uses things like `Task.Delay`, `DateTimeOffset.UtcNow`, `Task.WaitAsync`, or `PeriodicTimer`,
 it becomes hard to create tests that run fast and predictably.

src/TimeProviderExtensions/ManualTimeProvider.ManualTimer.cs

@@ -55,7 +55,11 @@ public ValueTask DisposeAsync()
         {
             Dispose(true);
             GC.SuppressFinalize(this);
+#if NET5_0_OR_GREATER
             return ValueTask.CompletedTask;
+#else
+            return default;
+#endif
         }
 
         private void Dispose(bool _)

src/TimeProviderExtensions/ManualTimeProvider.cs

@@ -424,7 +424,7 @@ public void Jump(DateTimeOffset value)
                 // Calculates how many callbacks should have happened
                 // in the jump period and invokes the callback that
                 // number of times. Has to happen at least one time.
-                var callbacksPassed = Math.Max(1, Math.Floor(jump / scheduler.Period));
+                var callbacksPassed = Math.Max(1, Math.Floor((double)jump.Ticks / scheduler.Period.Ticks));
                 for (int i = 0; i < callbacksPassed; i++)
                 {
                     scheduler.TimerElapsed();

src/TimeProviderExtensions/TimeProviderExtensions.csproj

@@ -6,7 +6,9 @@
 		<Company>Egil Hansen</Company>
 		<Authors>Egil Hansen</Authors>
 		<Description>
-			Extensions for `System.TimeProvider` API. It includes a test version of the `TimeProvider`, named `ManualTimeProvider`, that allows you to control the progress of time during testing deterministically.
+			Extensions for the `System.TimeProvider` API. It includes a test version of the `TimeProvider`, named `ManualTimeProvider`,
+			that allows you to control the progress of time during testing deterministically and a backport of the `PeriodicTimer`
+			version from .NET 8 to .NET 6/7 that supports `TimeProvider`.
 		</Description>
 		<PackageTags>TimeProvider, testing</PackageTags>
 		<Copyright>Egil Hansen</Copyright>
@@ -31,7 +33,7 @@
 	</Target>
 
 	<PropertyGroup>
-		<TargetFrameworks>net8.0;net6.0</TargetFrameworks>
+		<TargetFrameworks>net8.0;net6.0;netstandard2.0</TargetFrameworks>
 		<ImplicitUsings>enable</ImplicitUsings>
 		<Nullable>enable</Nullable>
 		<Deterministic>true</Deterministic>
@@ -51,12 +53,12 @@
 	</PropertyGroup>
 
 	<ItemGroup>
+		<PackageReference Include="Microsoft.Bcl.TimeProvider" Version="8.0.0-preview.*" />
 		<PackageReference Include="DotNet.ReproducibleBuilds" Version="1.1.1">
 			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
 			<PrivateAssets>all</PrivateAssets>
 		</PackageReference>
 		<PackageReference Include="MinVer" Version="4.3.0" PrivateAssets="All" />
-		<PackageReference Include="Microsoft.Bcl.TimeProvider" Version="8.0.0-preview.*" />
 	</ItemGroup>
 
 	<ItemGroup>

test/TimeProviderExtensions.Tests/ManualTimeProviderTests.cs

@@ -76,7 +76,7 @@ await Task.Delay(TimeSpan.FromDays(1))
     }
 #endif
 
-#if !NET8_0_OR_GREATER
+#if !NET8_0_OR_GREATER && NET6_0_OR_GREATER
     [Fact(Skip = "Include after NET 8 rc1 release")]
     public async Task Callbacks_happens_in_schedule_order()
     {
@@ -108,7 +108,7 @@ async Task AsyncCallbacks(PeriodicTimerWrapper periodicTimer)
             }
         }
     }
-#else
+#elif NET8_0_OR_GREATER
     [Fact]
     public async Task Callbacks_happens_in_schedule_order()
     {

test/TimeProviderExtensions.Tests/ManualTimeProviderTimerTests.cs

@@ -155,14 +155,14 @@ public void Advancing_causes_multiple_timers_invokes_callback_in_order()
         sut.Advance(TimeSpan.FromSeconds(11));
 
         callbacks.Should().Equal(
-            (1, oneSec * 2),
-            (2, oneSec * 3),
-            (1, oneSec * 4),
-            (2, oneSec * 6),
-            (1, oneSec * 6),
-            (1, oneSec * 8),
-            (2, oneSec * 9),
-            (1, oneSec * 10));
+            (1, TimeSpan.FromSeconds(2)),
+            (2, TimeSpan.FromSeconds(3)),
+            (1, TimeSpan.FromSeconds(4)),
+            (2, TimeSpan.FromSeconds(6)),
+            (1, TimeSpan.FromSeconds(6)),
+            (1, TimeSpan.FromSeconds(8)),
+            (2, TimeSpan.FromSeconds(9)),
+            (1, TimeSpan.FromSeconds(10)));
     }
 
     [Fact]

test/TimeProviderExtensions.Tests/Microsoft.Extensions.Time.Testing.Test/FakeTimeProviderTests.cs

@@ -210,9 +210,7 @@ public async Task Delay_Cancelled()
 
         cs.Cancel();
 
-#pragma warning disable VSTHRD003 // Avoid awaiting foreign Tasks
         await Assert.ThrowsAsync<TaskCanceledException>(async () => await delay);
-#pragma warning restore VSTHRD003 // Avoid awaiting foreign Tasks
     }
 
     [Fact]

test/TimeProviderExtensions.Tests/TimeProviderExtensions.Tests.csproj

@@ -1,24 +1,24 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
 	<PropertyGroup>
-		<TargetFrameworks>net8.0;net6.0</TargetFrameworks>
+		<TargetFrameworks>net8.0;net6.0;netcoreapp3.1</TargetFrameworks>
 		<LangVersion>latest</LangVersion>
 		<ImplicitUsings>enable</ImplicitUsings>
 		<Nullable>enable</Nullable>
 		<IsPackable>false</IsPackable>
 		<RootNamespace>TimeProviderExtensions</RootNamespace>
-		<TargetMicrosoftTestTimeProvider>false</TargetMicrosoftTestTimeProvider>
+		<SuppressTfmSupportBuildWarnings>true</SuppressTfmSupportBuildWarnings>
 	</PropertyGroup>
 
 	<ItemGroup>
-		<PackageReference Include="FluentAssertions" Version="6.9.0" />
-		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.1" />
-		<PackageReference Include="xunit" Version="2.4.2" />
+		<PackageReference Include="FluentAssertions" Version="6.12.0" />
+		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.7.2" />
+		<PackageReference Include="xunit" Version="2.5.0" />
 		<PackageReference Include="xunit.runner.visualstudio" Version="2.4.5">
 			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
 			<PrivateAssets>all</PrivateAssets>
 		</PackageReference>
-		<PackageReference Include="coverlet.collector" Version="3.2.0">
+		<PackageReference Include="coverlet.collector" Version="6.0.0">
 			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
 			<PrivateAssets>all</PrivateAssets>
 		</PackageReference>