Microsoft.Extensions.TimeProvider.Testing 8.6.0

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package Microsoft.Extensions.TimeProvider.Testing --version 8.6.0
NuGet\Install-Package Microsoft.Extensions.TimeProvider.Testing -Version 8.6.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="Microsoft.Extensions.TimeProvider.Testing" Version="8.6.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Microsoft.Extensions.TimeProvider.Testing --version 8.6.0
#r "nuget: Microsoft.Extensions.TimeProvider.Testing, 8.6.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 Microsoft.Extensions.TimeProvider.Testing as a Cake Addin
#addin nuget:?package=Microsoft.Extensions.TimeProvider.Testing&version=8.6.0

// Install Microsoft.Extensions.TimeProvider.Testing as a Cake Tool
#tool nuget:?package=Microsoft.Extensions.TimeProvider.Testing&version=8.6.0

Microsoft.Extensions.TimeProvider.Testing

Provides a FakeTimeProvider for testing components that depend on System.TimeProvider.

Install the package

From the command-line:

dotnet add package Microsoft.Extensions.TimeProvider.Testing

Or directly in the C# project file:

<ItemGroup>
  <PackageReference Include="Microsoft.Extensions.TimeProvider.Testing" Version="[CURRENTVERSION]" />
</ItemGroup>

Usage Example

FakeTimeProvider can be used to manually adjust time to test time dependent components in a deterministic way.

FakeTimeProvider derives from TimeProvider and adds the following APIs:

public FakeTimeProvider(DateTimeOffset startDateTime)
public DateTimeOffset Start { get; }
public TimeSpan AutoAdvanceAmount { get; set; }
public void SetUtcNow(DateTimeOffset value)
public void Advance(TimeSpan delta)
public void SetLocalTimeZone(TimeZoneInfo localTimeZone)

These can be used as follows:

var timeProvider = new FakeTimeProvider();
var myComponent = new MyComponent(timeProvider);
timeProvider.Advance(TimeSpan.FromSeconds(5));
myComponent.CheckState();

Use ConfigureAwait(true) with FakeTimeProvider.Advance

The Advance method is used to simulate the passage of time. This can be useful in tests where you need to control the timing of asynchronous operations. When awaiting a task in a test that uses FakeTimeProvider, it's important to use ConfigureAwait(true).

Here's an example:

await provider.Delay(TimeSpan.FromSeconds(delay)).ConfigureAwait(true);

This ensures that the continuation of the awaited task (i.e., the code that comes after the await statement) runs in the original context.

For a more realistic example, consider the following test using Polly:

using Polly;
using Polly.Retry;

public class SomeService(TimeProvider timeProvider)
{
    // Don't do this in real life, not thread safe
    public int Tries { get; private set; }

    private readonly ResiliencePipeline _retryPipeline = new ResiliencePipelineBuilder { TimeProvider = timeProvider }
        .AddRetry(
            new RetryStrategyOptions
            {
                ShouldHandle = new PredicateBuilder().Handle<InvalidOperationException>(),
                Delay = TimeSpan.FromSeconds(1),
                MaxRetryAttempts = 2,
                BackoffType = DelayBackoffType.Linear,
            })
        .Build();

    public async Task<int> PollyRetry(double taskDelay, double cancellationSeconds)
    {
        CancellationTokenSource cts = new(TimeSpan.FromSeconds(cancellationSeconds), timeProvider);
        Tries = 0;

        // get a context from the pool and return it when done
        var context = ResilienceContextPool.Shared.Get(
            // ensure execution continues on captured context 
            continueOnCapturedContext: true, 
            cancellationToken: cts.Token);

        var result = await _retryPipeline.ExecuteAsync(
            async _ =>
            {
                Tries++;

                // Simulate a task that takes some time to complete
                await Task.Delay(TimeSpan.FromSeconds(taskDelay), timeProvider).ConfigureAwait(true);

                if (Tries <= 2)
                {
                    throw new InvalidOperationException();
                }

                return Tries;
            },
            context);

        ResilienceContextPool.Shared.Return(context);

        return result;
    }
}

using Microsoft.Extensions.Time.Testing;

public class SomeServiceTests
{
    [Fact]
    public void PollyRetry_ShouldHave2Tries()
    {
        var timeProvider = new FakeTimeProvider();
        var someService = new SomeService(timeProvider);

        // Act
        var result = someService.PollyRetry(taskDelay: 1, cancellationSeconds: 6);

        // Advancing the time more than one second should resolves the first execution delay.
        timeProvider.Advance(TimeSpan.FromMilliseconds(1001));

        // Advancing the time more than the retry delay time of 1s,
        // and less then the task execution delay should start the second try
        timeProvider.Advance(TimeSpan.FromMilliseconds(1050));
        
        // Assert
        result.IsCompleted.Should().BeFalse();
        someService.Tries.Should().Be(2);
    }
}

Feedback & Contributing

We welcome feedback and contributions in our GitHub repo.

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 is compatible.  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. 
.NET Framework net462 is compatible.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (7)

Showing the top 5 NuGet packages that depend on Microsoft.Extensions.TimeProvider.Testing:

Package Downloads
Reo.Core.Testing

Package Description

Smusdi.Testing

Utilities to test .NET services.

Smusdi.PostgreSQL.Testing

Utilities for testing projects using postgreSQL.

do-blueprints-service-application

DO is an opinionated framework for .NET. This is a blueprint package that brings together all the feature implementations one needs for a service application.

LeanCode.TimeProvider.TestHelpers

LeanCode Core library

GitHub repositories (14)

Showing the top 5 popular GitHub repositories that depend on Microsoft.Extensions.TimeProvider.Testing:

Repository Stars
microsoft/semantic-kernel
Integrate cutting-edge LLM technology quickly and easily into your apps
App-vNext/Polly
Polly is a .NET resilience and transient-fault-handling library that allows developers to express policies such as Retry, Circuit Breaker, Timeout, Bulkhead Isolation, and Fallback in a fluent and thread-safe manner. From version 6.0.1, Polly targets .NET Standard 1.1 and 2.0+.
sebastienros/jint
Javascript Interpreter for .NET
Cysharp/R3
The new future of dotnet/reactive and UniRx.
evolutionary-architecture/evolutionary-architecture-by-example
Navigate the complex landscape of .NET software architecture with our step-by-step, story-like guide. Unpack the interplay between modular monoliths, microservices, domain-driven design, and various architectural patterns. Go beyond the one-size-fits-all solutions and understand how to blend these approaches based on your unique needs.
Version Downloads Last updated
9.0.0-preview.5.24311.7 271 6/11/2024
9.0.0-preview.4.24271.2 2,377 5/21/2024
9.0.0-preview.3.24209.3 3,114 4/11/2024
9.0.0-preview.2.24157.4 1,252 3/12/2024
9.0.0-preview.1.24108.1 743 2/13/2024
8.6.0 4,355 6/11/2024
8.5.0 92,874 5/14/2024
8.4.0 152,259 4/9/2024
8.3.0 189,785 3/12/2024
8.2.0 149,273 2/13/2024
8.1.0 136,244 1/9/2024
8.0.0 245,461 11/14/2023
8.0.0-rc.2.23510.2 40,068 10/10/2023
8.0.0-rc.1.23453.1 1,371 9/12/2023
8.0.0-preview.7.23407.5 3,087 8/8/2023
8.0.0-preview.6.23360.2 1,366 7/12/2023
8.0.0-preview.5.23308.3 538 6/14/2023
8.0.0-preview.4.23273.7 164 5/23/2023