Microsoft.Extensions.TimeProvider.Testing
9.0.0
Prefix Reserved
dotnet add package Microsoft.Extensions.TimeProvider.Testing --version 9.0.0
NuGet\Install-Package Microsoft.Extensions.TimeProvider.Testing -Version 9.0.0
<PackageReference Include="Microsoft.Extensions.TimeProvider.Testing" Version="9.0.0" />
paket add Microsoft.Extensions.TimeProvider.Testing --version 9.0.0
#r "nuget: Microsoft.Extensions.TimeProvider.Testing, 9.0.0"
// Install Microsoft.Extensions.TimeProvider.Testing as a Cake Addin #addin nuget:?package=Microsoft.Extensions.TimeProvider.Testing&version=9.0.0 // Install Microsoft.Extensions.TimeProvider.Testing as a Cake Tool #tool nuget:?package=Microsoft.Extensions.TimeProvider.Testing&version=9.0.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 | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | 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. net9.0 is compatible. |
.NET Framework | net462 is compatible. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
-
.NETFramework 4.6.2
- Microsoft.Bcl.TimeProvider (>= 8.0.1)
-
net8.0
- No dependencies.
-
net9.0
- No dependencies.
NuGet packages (11)
Showing the top 5 NuGet packages that depend on Microsoft.Extensions.TimeProvider.Testing:
Package | Downloads |
---|---|
Reo.Core.Testing
Package Description |
|
Reo.Core.IntegrationTesting
Package Description |
|
Foundatio.TestHarness
Pluggable foundation blocks for building distributed apps. |
|
Smusdi.Testing
Utilities to test .NET services. |
|
Rocket.Surgery.LaunchPad.Testing
Package Description |
GitHub repositories (28)
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
|
|
bitwarden/server
Bitwarden infrastructure/backend (API, database, Docker, etc).
|
|
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+.
|
|
MudBlazor/MudBlazor
Blazor Component Library based on Material design with an emphasis on ease of use. Mainly written in C# with Javascript kept to a bare minimum it empowers .NET developers to easily debug it if needed.
|
|
quartznet/quartznet
Quartz Enterprise Scheduler .NET
|
Version | Downloads | Last updated |
---|---|---|
9.0.0 | 136,765 | 11/12/2024 |
9.0.0-preview.9.24507.7 | 15,851 | 10/8/2024 |
9.0.0-preview.8.24460.1 | 9,678 | 9/10/2024 |
9.0.0-preview.7.24412.10 | 16,693 | 8/14/2024 |
9.0.0-preview.6.24353.1 | 7,424 | 7/10/2024 |
9.0.0-preview.5.24311.7 | 7,743 | 6/11/2024 |
9.0.0-preview.4.24271.2 | 3,035 | 5/21/2024 |
9.0.0-preview.3.24209.3 | 5,794 | 4/11/2024 |
9.0.0-preview.2.24157.4 | 2,255 | 3/12/2024 |
9.0.0-preview.1.24108.1 | 1,160 | 2/13/2024 |
8.10.0 | 528,954 | 10/8/2024 |
8.9.1 | 328,186 | 9/6/2024 |
8.9.0 | 39,377 | 9/5/2024 |
8.8.0 | 240,038 | 8/13/2024 |
8.7.0 | 443,195 | 7/10/2024 |
8.6.0 | 273,188 | 6/11/2024 |
8.5.0 | 291,742 | 5/14/2024 |
8.4.0 | 332,339 | 4/9/2024 |
8.3.0 | 452,934 | 3/12/2024 |
8.2.0 | 220,406 | 2/13/2024 |
8.1.0 | 199,633 | 1/9/2024 |
8.0.0 | 309,529 | 11/14/2023 |
8.0.0-rc.2.23510.2 | 40,463 | 10/10/2023 |
8.0.0-rc.1.23453.1 | 1,452 | 9/12/2023 |
8.0.0-preview.7.23407.5 | 3,124 | 8/8/2023 |
8.0.0-preview.6.23360.2 | 1,387 | 7/12/2023 |
8.0.0-preview.5.23308.3 | 559 | 6/14/2023 |
8.0.0-preview.4.23273.7 | 186 | 5/23/2023 |