TimeScheduler 0.5.0

Suggested Alternatives

TimeProviderExtensions

There is a newer version of this package available.
See the version list below for details.
dotnet add package TimeScheduler --version 0.5.0                
NuGet\Install-Package TimeScheduler -Version 0.5.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="TimeScheduler" Version="0.5.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add TimeScheduler --version 0.5.0                
#r "nuget: TimeScheduler, 0.5.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install TimeScheduler as a Cake Addin
#addin nuget:?package=TimeScheduler&version=0.5.0

// Install TimeScheduler as a Cake Tool
#tool nuget:?package=TimeScheduler&version=0.5.0                

Time Scheduler - a TimeProvider shim

This is a shim for the upcoming System.TimeProvider API coming in .NET 8. It includes a test version of the TimeProvider, named TestTimeProvider, that allows you to control the progress of time during testing deterministically.

NOTE: Originally, this library provided its own abstraction, ITimeScheduler and related types, DefaultScheduler and TestScheduler. These are now considered obsolete.

Currently, the following .NET time-based APIs are supported:

TimeProvider method .NET API it replaces
GetUtcNow() method DateTimeOffset.UtcNow property
CreateTimer() method System.Threading.Timer type
CreatePeriodicTimer(TimeSpan) method System.Threading.PeriodicTimer type
Delay(TimeSpan, CancellationToken) method Task.Delay(TimeSpan, CancellationToken) method
CancellationTokenSource.CancelAfter(TimeSpan, TimeProvider) method CancellationTokenSource.CancelAfter(TimeSpan) method
Task.WaitAsync(TimeSpan, TimeProvider) method Task.WaitAsync(TimeSpan) method
Task.WaitAsync(TimeSpan, TimeProvider, CancellationToken) method Task.WaitAsync(TimeSpan, CancellationToken) method

The implementations of TimeProvider is abstract. An instance of TimeProvider for production use is availalbe on the TimeProvider.System property, and TestTimeProvider can be used during testing.

During testing, you can move time forward by calling ForwardTime(TimeSpan) or SetUtcNow(DateTimeOffset) on TestTimeProvider. This allows you to write tests that run fast and predictable, even if the system under test pauses execution for multiple minutes using e.g. TimeProvider.Delay(TimeSpan), the replacement for Task.Delay(TimeSpan).

Installation

Get the latest release from https://www.nuget.org/packages/TimeScheduler

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:

services.AddSingleton(TimeProvider.System);

If you do not want to register the TimeProvider with your IoC container, you can instead create an additional constructor in the types that use it, which allow you to pass in a TimeProvider, and in the existing constructor(s) you have, just new up TimeProvider.System directly. For example:

public class MyService
{
  private readonly TimeProvider timeProvider;
  
  public MyService() : this(TimeProvider.System)
  {
  }
  
  public MyService(TimeProvider timeProvider)
  {
    this.timeProvider = timeProvider;
  }
}

This allows you to explicitly pass in an TestTimeProvider during testing.

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 runs fast and predictably.

The idea is to replace the use of e.g. Task.Delay with an abstraction, the TimeProvider, that in production is represented by the TimeProvider.System, that just uses the real Task.Delay. During testing it is now possible to pass in TestTimeProvider, that allows the test to control the progress of time, making it possible to skip ahead, e.g. 10 minutes, and also pause time, leading to fast and predictable tests.

As an example, lets test the "Stuff Service" below that performs a specific tasks every 10 second with an additional 1 second delay. We have two versions, one that uses the standard types in .NET, and one that uses the TimeProvider.

// Version of stuff service that uses the built in DateTimeOffset, PeriodicTimer, and Task.Delay
public class StuffServiceSystem
{
  private static readonly TimeSpan doStuffDelay = TimeSpan.FromSeconds(10);
  private readonly List<DateTimeOffset> container;

  public StuffServiceSystem(List<DateTimeOffset> container)
  {
    this.container = container;
  }
  
  public async Task DoStuff(CancellationToken cancelllationToken)
  {
    using var periodicTimer = new PeriodicTimer(doStuffDelay);
    
    while (await periodicTimer.WaitForNextTickAsync(cancellationToken))
    {      
      await Task.Delay(TimeSpan.FromSeconds(1));
      container.Add(DateTimeOffset.UtcNow);
    }
  }
}

// Version of stuff service that uses the built in TimeProvider
public class StuffServiceUsingTimeProvider
{
  private static readonly TimeSpan doStuffDelay = TimeSpan.FromSeconds(10);
  private readonly TimeProvider timeProvider;
  private readonly List<DateTimeOffset> container;

  public StuffServiceUsingTimeProvider(TimeProvider timeProvider, List<DateTimeOffset> container)
  {
    this.timeProvider = timeProvider;
    this.container = container;
  }
  
  public async Task DoStuff(CancellationToken cancelllationToken)
  {
    using var periodicTimer = timeProvider.CreatePeriodicTimer(doStuffDelay);
    
    while (await periodicTimer.WaitForNextTickAsync(cancellationToken))
    {      
      await timeProvider.Delay(TimeSpan.FromSeconds(1));
      container.Add(timeProvider.GetUtcNow());
    }
  }
}

The test, using xUnit and FluentAssertions, could look like this:

[Fact]
public void DoStuff_does_stuff_every_11_seconds()
{
  // Arrange
  var timeProvider = new TestTimeProvider();
  var container = new List<DateTimeOffset>();  
  var sut = new StuffServiceUsingTimeProvider(timeProvider, container);
  
  // Act
  _ = sut.DoStuff(CancellationToken.None);
  timeProvider.ForwardTime(TimeSpan.FromSeconds(11));
  
  // Assert
  container
    .Should()
    .ContainSingle()
    .Which
    .Should()
    .Be(timeProvider.GetUtcNow());
}

Writing a similar test for StuffServiceSystem is both more simple and runs much slower.

[Fact]
public async Task DoStuff_does_stuff_every_11_seconds()
{
  // Arrange
  var container = new List<DateTimeOffset>();  
  var sut = new StuffServiceSystem(container);
  
  // Act
  _ = sut.DoStuff(CancellationToken.None);
  await Task.Delay(TimeSpan.FromSeconds(11));
  
  // Assert
  container
    .Should()
    .ContainSingle()
    .Which
    .Should()
    .BeCloseTo(DateTimeOffset.UtcNow, precision: TimeSpan.FromMilliseconds(50));
}
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • net6.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.7.1 195 4/25/2023
0.7.0 190 4/25/2023
0.6.0 185 4/25/2023
0.5.1 446 4/16/2023
0.5.0 197 4/15/2023
0.4.0-preview 140 4/13/2023
0.3.0 400 3/3/2023
0.2.0 635 2/21/2023
0.1.3-preview 319 1/30/2023
0.1.2-preview 163 1/23/2023
0.1.1-preview 186 1/17/2023
0.1.0-preview 162 1/16/2023