kzdev.primetime/Source/Dev/Testing/KZDev.PrimeTime.Testing.Examples/UsingPrimeTestClockIntervalTimerExamples.cs at main · kzdev-net/kzdev.primetime · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
// Copyright (c) Kevin Zehrer
// Licensed under the MIT License. See LICENSE file in the project root for full license information.

using AwesomeAssertions;

using KZDev.PrimeTime;

using NodaTime;

namespace KZDev.PrimeTime.Testing.Examples;

/// <summary>
/// Demonstrates interval timers under a <see cref="PrimeTestClock"/> where callbacks fire only when
/// virtual time is advanced.
/// </summary>
public sealed class UsingPrimeTestClockIntervalTimerExamples
{
    #region Snippet
    /// <summary>
    /// Verifies a one-shot interval timer fires after virtual time advances past the initial delay.
    /// </summary>
    [Fact]
    public void IntervalTimer_AdvanceOneShot_FiresOnce ()
    {
        IPrimeTestClock clock = new PrimeTestClock(Instant.FromUtc(2025, 1, 1, 0, 0, 0));
        int fired = 0;
        using IClockIntervalTimer registration = clock.RegisterTimer(
            TimeSpan.FromMinutes(5),
            Timeout.InfiniteTimeSpan,
            _ => fired++,
            CancellationToken.None);

        clock.Advance(Duration.FromMinutes(4));
        fired.Should().Be(0);
        clock.Advance(Duration.FromMinutes(1));
        fired.Should().Be(1);
        registration.IsRepeating.Should().BeFalse();
    }

    /// <summary>
    /// Verifies a repeating interval timer advances its schedule deterministically under
    /// <see cref="IPrimeTestClock.Advance(NodaTime.Duration)"/>.
    /// </summary>
    [Fact]
    public void IntervalTimer_AdvanceRepeating_FiresOnEachInterval ()
    {
        IPrimeTestClock clock = new PrimeTestClock(Instant.FromUtc(2025, 1, 1, 0, 0, 0));
        int fired = 0;
        using IClockIntervalTimer registration = clock.RegisterTimer(
            TimeSpan.FromMinutes(2),
            TimeSpan.FromMinutes(3),
            _ => fired++,
            CancellationToken.None);

        clock.Advance(Duration.FromMinutes(2));
        fired.Should().Be(1);
        clock.Advance(Duration.FromMinutes(3));
        fired.Should().Be(2);
        registration.IsRepeating.Should().BeTrue();
    }

    /// <summary>
    /// Verifies an asynchronous interval callback completes when virtual time reaches the due instant.
    /// </summary>
    [Fact]
    public void IntervalTimer_RegisterAsyncTimer_Advance_CompletesCallback ()
    {
        IPrimeTestClock clock = new PrimeTestClock(Instant.FromUtc(2025, 1, 1, 0, 0, 0));
        int fired = 0;
        using IClockIntervalTimer registration = clock.RegisterAsyncTimer(
            TimeSpan.FromSeconds(1),
            Timeout.InfiniteTimeSpan,
            async (_, cancellationToken) =>
            {
                fired++;
                await Task.Delay(0, cancellationToken).ConfigureAwait(false);
            },
            CancellationToken.None);

        clock.Advance(Duration.FromSeconds(1));
        fired.Should().Be(1);
        registration.State.Should().Be(TimerState.Completed);
    }
    #endregion Snippet
}