Skip to content

Respect AutoAdvance for GetTimestamp in FakeTimeProvider #5783

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 10, 2025
Merged

Respect AutoAdvance for GetTimestamp in FakeTimeProvider #5783

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
10a7a48
Respect AutoAdvance for GetTimestamp in FakeTimeProvider
amadeuszl Jan 9, 2025
2d29b85
Refactor
amadeuszl Jan 9, 2025
557084b
Refactor GetTimestamp to use GetUtcNow
amadeuszl Jan 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion src/Libraries/Microsoft.Extensions.TimeProvider.Testing/FakeTimeProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,17 @@ public override long GetTimestamp()
#pragma warning disable S3236 // Caller information arguments should not be provided explicitly
Debug.Assert(TimestampFrequency == TimeSpan.TicksPerSecond, "Assuming frequency equals ticks per second");
#pragma warning restore S3236 // Caller information arguments should not be provided explicitly
return _now.Ticks;

DateTimeOffset result;

lock (Waiters)
{
result = _now;
_now += _autoAdvanceAmount;
}

WakeWaiters();
return result.Ticks;
}

/// <inheritdoc />
Expand Down
57 changes: 57 additions & 0 deletions test/Libraries/Microsoft.Extensions.TimeProvider.Testing.Tests/FakeTimeProviderTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,63 @@ public void Constructor_DefaultInitialization_SetsExpectedValues()
Assert.Equal(timestamp, timestamp2);
}

[Fact]
public void GetTimestamp_WithoutAutoAdvance_DoesNotAdvance()
{
var nowOffset = new DateTimeOffset(2000, 1, 1, 0, 0, 0, 0, TimeSpan.Zero);
var timeProvider = new FakeTimeProvider(nowOffset);

var timestamp1 = timeProvider.GetTimestamp();
var timestamp2 = timeProvider.GetTimestamp();

Assert.Equal(nowOffset, new DateTimeOffset(timestamp1, TimeSpan.Zero));
Assert.Equal(nowOffset, new DateTimeOffset(timestamp2, TimeSpan.Zero));
}

[Fact]
public void GetTimestamp_WithAutoAdvance_AdvancesProperly()
{
var msToElapse = 100;
var nowOffset = new DateTimeOffset(2000, 1, 1, 0, 0, 0, 0, TimeSpan.Zero);
var timeProvider = new FakeTimeProvider(nowOffset)
{
AutoAdvanceAmount = TimeSpan.FromMilliseconds(msToElapse)
};

var timestamp1 = timeProvider.GetTimestamp();
var timestamp2 = timeProvider.GetTimestamp();

Assert.Equal(nowOffset, new DateTimeOffset(timestamp1, TimeSpan.Zero));
Assert.Equal(nowOffset.AddMilliseconds(msToElapse), new DateTimeOffset(timestamp2, TimeSpan.Zero));
}

[Fact]
public void GetElapsedTime_CallsGetTimestamp()
{
var timeProvider = new FakeTimeProvider();
var st = timeProvider.GetTimestamp();
timeProvider.Advance(TimeSpan.FromSeconds(1));
var t = timeProvider.GetElapsedTime(st);

Assert.Equal(TimeSpan.FromSeconds(1), t);
}

[Fact]
public void GetElapsedTime_WithAutoAdvance_AdvancesProperly()
{
var timeProvider = new FakeTimeProvider
{
AutoAdvanceAmount = TimeSpan.FromSeconds(1)
};

var st = timeProvider.GetTimestamp();
var elapsedTime = timeProvider.GetElapsedTime(st);
var elapsedTime2 = timeProvider.GetElapsedTime(st);

Assert.Equal(TimeSpan.FromSeconds(1), elapsedTime);
Assert.Equal(TimeSpan.FromSeconds(2), elapsedTime2);
}

[Fact]
public void Constructor_InitializesWithCustomDateTimeOffset_AdvancesCorrectly()
{
Expand Down