Timecop 2.2.0
See the version list below for details.
dotnet add package Timecop --version 2.2.0
NuGet\Install-Package Timecop -Version 2.2.0
<PackageReference Include="Timecop" Version="2.2.0" />
paket add Timecop --version 2.2.0
#r "nuget: Timecop, 2.2.0"
// Install Timecop as a Cake Addin #addin nuget:?package=Timecop&version=2.2.0 // Install Timecop as a Cake Tool #tool nuget:?package=Timecop&version=2.2.0
Timecop - Easy Date and Time Testing in C#
Timecop is a small library that helps you test DateTime in a static, thread-safe, ambient context.
Timecop targets .NET Standard 2.0, has no external dependencies, and can be used with .NET Framework 4.5+ and any version of .NET and .NET Core.
Timecop has been inspired by the timecop Ruby gem.
Installation
You can install Timecop from NuGet using the .NET CLI:
dotnet add package Timecop
Basic usage
Timecop allows you to freeze and travel in time. Just use the Clock
class instead of DateTime
to get the current time via Now
or UtcNow
properties, and manipulate time with the Timecop
class in your tests.
string Greet()
{
var timeOfDay = Clock.Now.Hour switch // Use Clock instead of DateTime
{
>= 0 and < 6 => "night",
>= 6 and < 12 => "morning",
>= 12 and < 18 => "afternoon",
_ => "evening"
};
return $"Good {timeOfDay}!";
}
// freeze at 2pm local time:
using var tc = Timecop.Frozen(o => o.At(14,0,0).LocalTime());
Greet(); // Good afternoon!
// travel to 8pm local time:
tc.TravelBy(TimeSpan.FromHours(6));
Greet(); // Good evening!
Available methods
Freezing and resuming time
You can freeze the time so that it stops running for your tests until you call Resume
or dispose the Timecop
instance.
You freeze time with either an instance Freeze
or a static Frozen
method, which both have the same set of overloads. Both methods have the same effect, however the static Frozen
creates an already frozen Timecop
instance.
using var tc = Timecop.Frozen(1990, 12, 2, 14, 38, 51, DateTimeKind.Local);
Clock.Now; // 1990-12-02 14:38:51
Thread.Sleep(TimeSpan.FromSeconds(3));
Clock.Now; // 1990-12-02 14:38:51 - still the same value
tc.Resume();
Thread.Sleep(TimeSpan.FromSeconds(3));
Clock.Now; // 1990-12-02 14:38:54 - time has changed
Freeze
and Frozen
have multiple overloads:
// freeze at the current instant:
var frozenAt = tc.Freeze();
// freeze at the specified DateTime:
frozenAt = tc.Freeze(new DateTime(1990, 12, 2, 14, 38, 51, DateTimeKind.Utc));
// freeze at the specified date and time:
frozenAt = tc.Freeze(1990, 12, 2, 14, 38, 51, DateTimeKind.Utc);
// freeze at the specified date:
frozenAt = tc.Freeze(1990, 12, 2, DateTimeKind.Utc);
// freeze at the specified date or time using a builder:
frozenAt = tc.Freeze(o => o.On(1990, 12, 2)
.At(14, 13, 51)
.LocalTime());
Traveling in time
Use the TravelBy
method to travel forward and backward in time:
using var tc = Timecop.Frozen(1990, 12, 2, 14, 38, 51, DateTimeKind.Local);
tc.TravelBy(TimeSpan.FromDays(1));
Clock.Now; // 1990-12-03 14:38:51 - one day in the future
License
Timecop was created by Dmytro Khmara and is licensed under the MIT license.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. 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. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- Timecop.Core (>= 4.2.0)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on Timecop:
Package | Downloads |
---|---|
Timecop.Extensions.DependencyInjection
Extensions to register Timecop's IClock with IServiceCollection in one line of code. |
GitHub repositories
This package is not used by any popular GitHub repositories.