Initial version

This commit is contained in:
2025-12-15 19:56:17 +01:00
parent c04107c9b8
commit d93d29522c
26 changed files with 1152 additions and 43 deletions

View File

@@ -0,0 +1,49 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>net6.0</TargetFramework>
<Nullable>enable</Nullable>
<ImplicitUsings>enable</ImplicitUsings>
<LangVersion>latest</LangVersion>
<PackageId>EonaCat.DeterministicTime.AspNetCore</PackageId>
<Version>1.0.0</Version>
<Authors>EonaCat (Jeroen Saey)</Authors>
<Description>
ASP.NET Core integration for DeterministicTime.
</Description>
<PackageTags>aspnet;core;middleware;time;deterministic;</PackageTags>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Title>EonaCat.DeterministicTime.AspNetCore</Title>
<Company>EonaCat (Jeroen Saey)</Company>
<Product>EonaCat.DeterministicTime.AspNetCore</Product>
<Copyright>EonaCat (Jeroen Saey)</Copyright>
<PackageProjectUrl>https://git.saey.me/EonaCat/EonaCat.DeterministicTime</PackageProjectUrl>
<PackageIcon>icon.png</PackageIcon>
<PackageReadmeFile>Readme.md</PackageReadmeFile>
<RepositoryUrl>https://git.saey.me/EonaCat/EonaCat.DeterministicTime</RepositoryUrl>
<RepositoryType>git</RepositoryType>
<PackageLicenseFile>LICENSE</PackageLicenseFile>
</PropertyGroup>
<ItemGroup>
<None Include="..\..\icon.png">
<Pack>True</Pack>
<PackagePath>\</PackagePath>
</None>
<None Include="..\..\LICENSE">
<Pack>True</Pack>
<PackagePath>\</PackagePath>
</None>
<None Include="..\..\Readme.md">
<Pack>True</Pack>
<PackagePath>\</PackagePath>
</None>
</ItemGroup>
<ItemGroup>
<PackageReference Include="EonaCat.DeterministicTime" Version="1.0.0" />
<PackageReference Include="Microsoft.AspNetCore.Http.Abstractions" Version="2.3.0" />
</ItemGroup>
</Project>

View File

@@ -0,0 +1,35 @@
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Http;
using System.Net.Http;
namespace EonaCat.DeterministicTime.AspNetCore;
// This file is part of the EonaCat project(s) which is released under the Apache License.
// See the LICENSE file or go to https://EonaCat.com/License for full license details.
public sealed class DeterministicTimeMiddleware
{
private readonly RequestDelegate _next;
public DeterministicTimeMiddleware(RequestDelegate next)
{
_next = next;
}
public async Task InvokeAsync(HttpContext context)
{
using (TimeScope.Scaled(1.0))
{
await _next(context);
}
}
}
public static class DeterministicTimeMiddlewareExtensions
{
public static IApplicationBuilder UseDeterministicTime(
this IApplicationBuilder app)
{
return app.UseMiddleware<DeterministicTimeMiddleware>();
}
}

View File

@@ -0,0 +1,12 @@
{
"profiles": {
"EonaCat.DeterministicTime.AspNet": {
"commandName": "Project",
"launchBrowser": true,
"environmentVariables": {
"ASPNETCORE_ENVIRONMENT": "Development"
},
"applicationUrl": "https://localhost:56865;http://localhost:56866"
}
}
}

View File

@@ -0,0 +1,51 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>net48</TargetFramework>
<Nullable>enable</Nullable>
<LangVersion>latest</LangVersion>
<PackageId>EonaCat.DeterministicTime.AspNetFramework</PackageId>
<Version>1.0.0</Version>
<Authors>EonaCat (Jeroen Saey)</Authors>
<Description>
ASP.NET 4.8 integration for DeterministicTime.
</Description>
<PackageTags>aspnet;httpmodule;time;deterministic</PackageTags>
<LangVersion>latest</LangVersion>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Title>EonaCat.DeterministicTime.AspNetFramework</Title>
<Company>EonaCat (Jeroen Saey)</Company>
<Copyright>EonaCat (Jeroen Saey)</Copyright>
<PackageProjectUrl>https://git.saey.me/EonaCat/EonaCat.DeterministicTime</PackageProjectUrl>
<PackageIcon>icon.png</PackageIcon>
<PackageReadmeFile>Readme.md</PackageReadmeFile>
<RepositoryUrl>https://git.saey.me/EonaCat/EonaCat.DeterministicTime</RepositoryUrl>
<RepositoryType>git</RepositoryType>
<PackageLicenseFile>LICENSE</PackageLicenseFile>
</PropertyGroup>
<ItemGroup>
<None Include="..\..\icon.png">
<Pack>True</Pack>
<PackagePath>\</PackagePath>
</None>
<None Include="..\..\LICENSE">
<Pack>True</Pack>
<PackagePath>\</PackagePath>
</None>
<None Include="..\..\Readme.md">
<Pack>True</Pack>
<PackagePath>\</PackagePath>
</None>
</ItemGroup>
<ItemGroup>
<PackageReference Include="EonaCat.DeterministicTime" Version="1.0.0" />
</ItemGroup>
<ItemGroup>
<Reference Include="System.Web" />
</ItemGroup>
</Project>

View File

@@ -0,0 +1,19 @@
using System.Web;
namespace EonaCat.DeterministicTime.AspNetFramework;
// This file is part of the EonaCat project(s) which is released under the Apache License.
// See the LICENSE file or go to https://EonaCat.com/License for full license details.
public class DeterministicTimeHttpModule : IHttpModule
{
public void Init(HttpApplication context)
{
context.BeginRequest += (sender, e) =>
{
TimeScope.Scaled(1.0); // per-request deterministic scope
};
}
public void Dispose() { }
}

View File

@@ -0,0 +1,12 @@
{
"profiles": {
"EonaCat.DeterministicTime.AspNet": {
"commandName": "Project",
"launchBrowser": true,
"environmentVariables": {
"ASPNETCORE_ENVIRONMENT": "Development"
},
"applicationUrl": "https://localhost:56865;http://localhost:56866"
}
}
}

View File

@@ -0,0 +1,5 @@
<Solution>
<Project Path="../EonaCat.DeterministicTime.AspNetCore/EonaCat.DeterministicTime.AspNetCore/EonaCat.DeterministicTime.AspNetCore.csproj" />
<Project Path="../EonaCat.DeterministicTime.AspNetFramework/EonaCat.DeterministicTime.AspNetFramework/EonaCat.DeterministicTime.AspNetFramework.csproj" />
<Project Path="EonaCat.DeterministicTime/EonaCat.DeterministicTime.csproj" />
</Solution>

View File

@@ -0,0 +1,33 @@
using System;
using System.Threading.Tasks;
namespace EonaCat.DeterministicTime;
// This file is part of the EonaCat project(s) which is released under the Apache License.
// See the LICENSE file or go to https://EonaCat.com/License for full license details.
/// <summary>
/// Deterministic replacement for Task.Delay.
/// Completes when deterministic time advances past the delay.
/// </summary>
public static class DeterministicDelay
{
public static Task For(TimeSpan delay)
{
if (delay < TimeSpan.Zero)
{
throw new ArgumentOutOfRangeException(nameof(delay));
}
var tcs = new TaskCompletionSource<bool>(
TaskCreationOptions.RunContinuationsAsynchronously);
DeterministicTimer.Start(delay, () =>
{
tcs.TrySetResult(true);
});
return tcs.Task;
}
}

View File

@@ -0,0 +1,68 @@
using System;
using System.Collections.Generic;
namespace EonaCat.DeterministicTime;
// This file is part of the EonaCat project(s) which is released under the Apache License.
// See the LICENSE file or go to https://EonaCat.com/License for full license details.
public sealed class DeterministicScheduler
{
private readonly object _lock = new();
private readonly List<ScheduledJob> _jobs = new();
public static DeterministicScheduler Global { get; } = new();
public void Tick()
{
var now = DeterministicTime.UtcNow;
lock (_lock)
{
foreach (var job in _jobs)
{
job.TryRun(now);
}
}
}
public IDisposable Every(TimeSpan interval, Action action)
{
var job = new ScheduledJob(interval, action);
lock (_lock)
{
_jobs.Add(job);
}
return new Handle(() => _jobs.Remove(job));
}
private sealed class Handle : IDisposable
{
private readonly Action _dispose;
public Handle(Action dispose) => _dispose = dispose;
public void Dispose() => _dispose();
}
private sealed class ScheduledJob
{
private readonly TimeSpan _interval;
private readonly Action _action;
private DateTime _next;
public ScheduledJob(TimeSpan interval, Action action)
{
_interval = interval;
_action = action;
_next = DeterministicTime.UtcNow + interval;
}
public void TryRun(DateTime now)
{
while (now >= _next)
{
_action();
_next += _interval;
}
}
}
}

View File

@@ -0,0 +1,66 @@
using System;
using System.Diagnostics;
namespace EonaCat.DeterministicTime;
// This file is part of the EonaCat project(s) which is released under the Apache License.
// See the LICENSE file or go to https://EonaCat.com/License for full license details.
public sealed class DeterministicStopwatch
{
private long _start;
private long _elapsed;
private bool _running;
public static DeterministicStopwatch StartNew()
{
var sw = new DeterministicStopwatch();
sw.Start();
return sw;
}
public void Start()
{
if (_running)
{
return;
}
_start = DeterministicTime.GetTimestamp();
_running = true;
}
public void Stop()
{
if (!_running)
{
return;
}
_elapsed += DeterministicTime.GetTimestamp() - _start;
_running = false;
}
public void Reset()
{
_elapsed = 0;
_running = false;
}
public TimeSpan Elapsed
{
get
{
long ticks = _elapsed;
if (_running)
{
ticks += DeterministicTime.GetTimestamp() - _start;
}
// Convert Stopwatch ticks to TimeSpan
double seconds = (double)ticks / Stopwatch.Frequency;
return TimeSpan.FromSeconds(seconds);
}
}
}

View File

@@ -0,0 +1,50 @@
using System;
using System.Threading;
namespace EonaCat.DeterministicTime;
// This file is part of the EonaCat project(s) which is released under the Apache License.
// See the LICENSE file or go to https://EonaCat.com/License for full license details.
public static class DeterministicTime
{
private static readonly AsyncLocal<ITimeSource?> _current = new();
private static readonly ITimeSource _system = new SystemTimeSource();
private static ITimeSource Source => _current.Value ?? _system;
public static DateTime UtcNow => Source.UtcNow;
public static DateTime Now => Source.UtcNow.ToLocalTime();
public static long GetTimestamp() => Source.Timestamp;
internal static IDisposable Push(ITimeSource source)
{
var previous = _current.Value;
_current.Value = source;
return new Scope(() => _current.Value = previous);
}
public static void Advance(TimeSpan delta)
{
if (Source is not IAdjustableTimeSource adjustable)
{
throw new InvalidOperationException("Time source is not adjustable");
}
adjustable.Advance(delta);
DeterministicScheduler.Global.Tick();
}
public static IDisposable WithOffset(TimeSpan offset)
{
return Push(new OffsetTimeSource(Source, offset));
}
private sealed class Scope : IDisposable
{
private readonly Action _restore;
public Scope(Action restore) => _restore = restore;
public void Dispose() => _restore();
}
}

View File

@@ -0,0 +1,59 @@
using System;
namespace EonaCat.DeterministicTime;
// This file is part of the EonaCat project(s) which is released under the Apache License.
// See the LICENSE file or go to https://EonaCat.com/License for full license details.
/// <summary>
/// A deterministic, virtual-time-aware timer.
/// Fires immediately when deterministic time passes its due time.
/// </summary>
public sealed class DeterministicTimer : IDisposable
{
private readonly Action _callback;
private readonly IDisposable _handle;
private bool _fired;
private DeterministicTimer(TimeSpan delay, Action callback)
{
_callback = callback;
_handle = DeterministicScheduler.Global.Every(
delay,
TryFire
);
}
private void TryFire()
{
if (_fired)
{
return;
}
_fired = true;
_callback();
Dispose();
}
/// <summary>
/// Starts a one-shot deterministic timer.
/// </summary>
public static DeterministicTimer Start(
TimeSpan delay,
Action callback)
{
if (delay < TimeSpan.Zero)
{
throw new ArgumentOutOfRangeException(nameof(delay));
}
return new DeterministicTimer(delay, callback);
}
public void Dispose()
{
_handle.Dispose();
}
}

View File

@@ -0,0 +1,25 @@
using System;
using System.Diagnostics;
namespace EonaCat.DeterministicTime;
// This file is part of the EonaCat project(s) which is released under the Apache License.
// See the LICENSE file or go to https://EonaCat.com/License for full license details.
public interface IDistributedTimeCoordinator
{
DateTime GetClusterUtc();
}
public sealed class DistributedTimeSource : ITimeSource
{
private readonly IDistributedTimeCoordinator _coordinator;
public DistributedTimeSource(IDistributedTimeCoordinator coordinator)
{
_coordinator = coordinator;
}
public DateTime UtcNow => _coordinator.GetClusterUtc();
public long Timestamp => Stopwatch.GetTimestamp();
}

View File

@@ -0,0 +1,40 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFrameworks>netstandard2.1; net48</TargetFrameworks>
<PackageId>EonaCat.DeterministicTime</PackageId>
<Version>1.0.0</Version>
<Authors>EonaCat (Jeroen Saey)</Authors>
<Description>Deterministic, testable, and replayable time for .NET</Description>
<RepositoryUrl>https://git.saey.me/EonaCat/EonaCat.DeterministicTime</RepositoryUrl>
<PackageTags>time;testing;ntp;deterministic;clock;EonaCat;Jeroen;Saey</PackageTags>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<LangVersion>latest</LangVersion>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Title>EonaCat.DeterministicTime</Title>
<Company>EonaCat (Jeroen Saey)</Company>
<Product>EonaCat.DeterministicTime</Product>
<Copyright>EonaCat (Jeroen Saey)</Copyright>
<PackageProjectUrl>https://git.saey.me/EonaCat/EonaCat.DeterministicTime</PackageProjectUrl>
<PackageIcon>icon.png</PackageIcon>
<PackageReadmeFile>Readme.md</PackageReadmeFile>
<RepositoryType>git</RepositoryType>
<PackageLicenseFile>LICENSE</PackageLicenseFile>
</PropertyGroup>
<ItemGroup>
<None Include="..\..\icon.png">
<Pack>True</Pack>
<PackagePath>\</PackagePath>
</None>
<None Include="..\..\LICENSE">
<Pack>True</Pack>
<PackagePath>\</PackagePath>
</None>
<None Include="..\..\Readme.md">
<Pack>True</Pack>
<PackagePath>\</PackagePath>
</None>
</ItemGroup>
<ItemGroup>
<PackageReference Include="EonaCat.Json" Version="1.2.0" />
</ItemGroup>
</Project>

View File

@@ -0,0 +1,11 @@
using System;
namespace EonaCat.DeterministicTime;
// This file is part of the EonaCat project(s) which is released under the Apache License.
// See the LICENSE file or go to https://EonaCat.com/License for full license details.
public interface IAdjustableTimeSource : ITimeSource
{
void Advance(TimeSpan delta);
}

View File

@@ -0,0 +1,12 @@
using System;
namespace EonaCat.DeterministicTime;
// This file is part of the EonaCat project(s) which is released under the Apache License.
// See the LICENSE file or go to https://EonaCat.com/License for full license details.
public interface ITimeSource
{
DateTime UtcNow { get; }
long Timestamp { get; }
}

View File

@@ -0,0 +1,20 @@
using System;
namespace EonaCat.DeterministicTime;
// This file is part of the EonaCat project(s) which is released under the Apache License.
// See the LICENSE file or go to https://EonaCat.com/License for full license details.
public interface INtpTimeProvider
{
DateTime GetNetworkUtc();
}
public static class NtpSynchronization
{
public static IDisposable Sync(INtpTimeProvider provider)
{
var offset = provider.GetNetworkUtc() - DateTime.UtcNow;
return DeterministicTime.WithOffset(offset);
}
}

View File

@@ -0,0 +1,21 @@
using System;
namespace EonaCat.DeterministicTime;
// This file is part of the EonaCat project(s) which is released under the Apache License.
// See the LICENSE file or go to https://EonaCat.com/License for full license details.
internal sealed class OffsetTimeSource : ITimeSource
{
private readonly ITimeSource _inner;
private readonly TimeSpan _offset;
public OffsetTimeSource(ITimeSource inner, TimeSpan offset)
{
_inner = inner;
_offset = offset;
}
public DateTime UtcNow => _inner.UtcNow + _offset;
public long Timestamp => _inner.Timestamp;
}

View File

@@ -0,0 +1,13 @@
using System;
using System.Diagnostics;
namespace EonaCat.DeterministicTime;
// This file is part of the EonaCat project(s) which is released under the Apache License.
// See the LICENSE file or go to https://EonaCat.com/License for full license details.
internal sealed class SystemTimeSource : ITimeSource
{
public DateTime UtcNow => DateTime.UtcNow;
public long Timestamp => Stopwatch.GetTimestamp();
}

View File

@@ -0,0 +1,42 @@
using EonaCat.Json;
using System;
using System.Collections.Generic;
using System.IO;
namespace EonaCat.DeterministicTime;
// This file is part of the EonaCat project(s) which is released under the Apache License.
// See the LICENSE file or go to https://EonaCat.com/License for full license details.
public sealed class TimeRecording : ITimeSource, IDisposable
{
private readonly ITimeSource _inner;
private readonly List<DateTime> _log = new();
private readonly IDisposable _scope;
private TimeRecording(ITimeSource inner)
{
_inner = inner;
_scope = DeterministicTime.Push(this);
}
public static TimeRecording Start() =>
new(new SystemTimeSource());
public DateTime UtcNow
{
get
{
var value = _inner.UtcNow;
_log.Add(value);
return value;
}
}
public long Timestamp => _inner.Timestamp;
public void Save(string path) =>
File.WriteAllText(path, JsonHelper.ToJson(_log));
public void Dispose() => _scope.Dispose();
}

View File

@@ -0,0 +1,38 @@
using EonaCat.Json;
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.IO;
namespace EonaCat.DeterministicTime;
// This file is part of the EonaCat project(s) which is released under the Apache License.
// See the LICENSE file or go to https://EonaCat.com/License for full license details.
public sealed class TimeReplay : ITimeSource, IDisposable
{
private readonly Queue<DateTime> _queue;
private readonly IDisposable _scope;
private TimeReplay(IEnumerable<DateTime> times)
{
_queue = new Queue<DateTime>(times);
_scope = DeterministicTime.Push(this);
}
public static IDisposable Load(string path)
{
var times = JsonHelper.ToObject<List<DateTime>>(
File.ReadAllText(path))!;
return new TimeReplay(times);
}
public DateTime UtcNow =>
_queue.Count > 0
? _queue.Dequeue()
: throw new InvalidOperationException("Replay exhausted");
public long Timestamp => Stopwatch.GetTimestamp();
public void Dispose() => _scope.Dispose();
}

View File

@@ -0,0 +1,26 @@
using System;
namespace EonaCat.DeterministicTime;
// This file is part of the EonaCat project(s) which is released under the Apache License.
// See the LICENSE file or go to https://EonaCat.com/License for full license details.
public static class TimeScope
{
public static IDisposable Frozen(DateTime utc) =>
DeterministicTime.Push(new VirtualTimeSource(utc, 0));
public static IDisposable Scaled(double scale)
{
if (scale < 0)
{
throw new ArgumentOutOfRangeException(nameof(scale));
}
return DeterministicTime.Push(
new VirtualTimeSource(DeterministicTime.UtcNow, scale));
}
public static IDisposable Offset(TimeSpan offset) =>
DeterministicTime.WithOffset(offset);
}

View File

@@ -0,0 +1,55 @@
using System;
using System.Diagnostics;
namespace EonaCat.DeterministicTime;
// This file is part of the EonaCat project(s) which is released under the Apache License.
// See the LICENSE file or go to https://EonaCat.com/License for full license details.
internal sealed class VirtualTimeSource : IAdjustableTimeSource
{
private DateTime _baseTime;
private long _baseTimestamp;
private readonly double _scale;
public VirtualTimeSource(DateTime startUtc, double scale)
{
_baseTime = DateTime.SpecifyKind(startUtc, DateTimeKind.Utc);
_baseTimestamp = Stopwatch.GetTimestamp();
_scale = scale;
}
public DateTime UtcNow
{
get
{
long nowTicks = Stopwatch.GetTimestamp();
long deltaTicks = nowTicks - _baseTimestamp;
// Convert delta ticks to TimeSpan
double deltaSeconds = (double)deltaTicks / Stopwatch.Frequency;
var elapsed = TimeSpan.FromSeconds(deltaSeconds);
// Apply scale
long scaledTicks = (long)(elapsed.Ticks * _scale);
return _baseTime.AddTicks(scaledTicks);
}
}
public long Timestamp
{
get
{
var delta = Stopwatch.GetTimestamp() - _baseTimestamp;
return _baseTimestamp + (long)(delta * _scale);
}
}
public void Advance(TimeSpan delta)
{
_baseTime = _baseTime.Add(delta);
_baseTimestamp = Stopwatch.GetTimestamp();
}
}

213
LICENSE
View File

@@ -1,73 +1,204 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
https://EonaCat.com/license/
1. Definitions. TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
OF SOFTWARE BY EONACAT (JEROEN SAEY)
"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. 1. Definitions.
"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. "Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. "Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: 3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
(a) You must give any other recipients of the Work or Derivative Works a copy of this License; and 4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(b) You must cause any modified files to carry prominent notices stating that You changed the files; and (a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. (c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. (d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. 8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
END OF TERMS AND CONDITIONS 9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
APPENDIX: How to apply the Apache License to your work. END OF TERMS AND CONDITIONS
To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. APPENDIX: How to apply the Apache License to your work.
Copyright 2025 EonaCat To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Licensed under the Apache License, Version 2.0 (the "License"); Copyright [yyyy] [name of copyright owner]
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0 Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software http://www.apache.org/licenses/LICENSE-2.0
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. Unless required by applicable law or agreed to in writing, software
See the License for the specific language governing permissions and distributed under the License is distributed on an "AS IS" BASIS,
limitations under the License. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

220
README.md
View File

@@ -1,3 +1,219 @@
# EonaCat.DeterministicTime # EonaCat.DeterministicTime
EonaCat.DeterministicTime is a **.NET library for deterministic, testable, and replayable time**.
It replaces `DateTime.UtcNow`, `Stopwatch`, `Timer`, and `Task.Delay` with deterministic equivalents and supports advanced features like:
scheduling,
time scaling,
replay,
NTP offsets,
ASP.NET Framework integration.
ASP.NET Core integration.
---
## Installation
```
dotnet add package EonaCat.DeterministicTime
```
### ASP.NET Core integration (optional)
```
dotnet add package DeterministicTime.AspNetCore
```
### ASP.NET Framework integration (optional)
```
dotnet add package DeterministicTime.AspNetFramework
```
ASP.NET 4.8 → add DeterministicTime.AspNetFramework and register HttpModule in web.config:
```xml
<system.web>
<httpModules>
<add name="DeterministicTime" type="DeterministicTimeHttpModule"/>
</httpModules>
</system.web>
```
---
## Basic Usage
```csharp
using DeterministicTime;
DateTime now = DeterministicTime.UtcNow;
DateTime localNow = DeterministicTime.Now;
```
---
## Freeze Time
```csharp
using (TimeScope.Frozen(DateTime.Parse("2025-01-01T00:00:00Z")))
{
Console.WriteLine(DeterministicTime.UtcNow); // frozen
}
```
---
## Scale Time
```csharp
using (TimeScope.Scaled(10)) // 10x faster
{
// all timers and delays scale 10x
}
```
---
## Advance Time Manually
```csharp
DeterministicTime.Advance(TimeSpan.FromHours(2));
```
---
## Offset Time
```csharp
using (TimeScope.Offset(TimeSpan.FromMinutes(5)))
{
// all UtcNow calls are offset by 5 minutes
}
```
---
## Deterministic Stopwatch
```csharp
var sw = DeterministicStopwatch.StartNew();
// do work
sw.Stop();
Console.WriteLine(sw.Elapsed);
```
---
## Deterministic Timer
```csharp
int fired = 0;
DeterministicTimer.Start(TimeSpan.FromSeconds(10), () => fired++);
DeterministicTime.Advance(TimeSpan.FromSeconds(10));
Console.WriteLine(fired); // 1
```
---
## Deterministic Delay
```csharp
bool completed = false;
await DeterministicDelay.For(TimeSpan.FromSeconds(5)).ContinueWith(_ => completed = true);
DeterministicTime.Advance(TimeSpan.FromSeconds(5));
Console.WriteLine(completed); // true
```
---
## Deterministic Scheduler
```csharp
var scheduler = DeterministicScheduler.Global;
scheduler.Every(TimeSpan.FromMinutes(1), () => Console.WriteLine("Tick"));
DeterministicTime.Advance(TimeSpan.FromMinutes(5)); // fires 5 times
```
---
## Time Recording & Replay
### Record
```csharp
using var recording = TimeRecording.Start();
// run code
recording.Save("run.json");
```
### Replay
```csharp
using (TimeReplay.Load("run.json"))
{
// deterministic replay of UtcNow calls
}
```
---
## NTP Synchronization
```csharp
using (NtpSynchronization.Sync(myNtpProvider))
{
// deterministic time aligned with NTP
}
```
---
## Distributed Time Source
```csharp
IDistributedTimeCoordinator coordinator = ...;
DeterministicTime.Push(new DistributedTimeSource(coordinator));
Console.WriteLine(DeterministicTime.UtcNow);
```
---
## ASP.NET Core Middleware
```csharp
app.UseDeterministicTime();
```
* Each request runs in its own deterministic scope
* Works with frozen/scaled time and timers
---
## Advanced Features Summary
* **Deterministic UtcNow & Now**
* **Stopwatch replacement**
* **One-shot and repeated timers**
* **Task.Delay replacement**
* **Time scaling, freezing, offset**
* **Scheduler for background jobs**
* **Recording & replay for testing**
* **NTP synchronization & distributed clocks**
* **ASP.NET Framework integration**
* **ASP.NET Core integration**
EonaCat.DeterministicTime

BIN
icon.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 88 KiB