add Until method on clocks

WillMatthews · DPJacques · commit 33fc064cceda · 2024-08-23T09:42:27.000-07:00
diff --git a/clockwork.go b/clockwork.go
@@ -16,6 +16,7 @@ type Clock interface {
 	Sleep(d time.Duration)
 	Now() time.Time
 	Since(t time.Time) time.Duration
+	Until(t time.Time) time.Duration
 	NewTicker(d time.Duration) Ticker
 	NewTimer(d time.Duration) Timer
 	AfterFunc(d time.Duration, f func()) Timer
@@ -45,6 +46,10 @@ func (rc *realClock) Since(t time.Time) time.Duration {
 	return rc.Now().Sub(t)
 }
 
+func (rc *realClock) Until(t time.Time) time.Duration {
+	return t.Sub(rc.Now())
+}
+
 func (rc *realClock) NewTicker(d time.Duration) Ticker {
 	return realTicker{time.NewTicker(d)}
 }
@@ -132,6 +137,12 @@ func (fc *FakeClock) Since(t time.Time) time.Duration {
 	return fc.Now().Sub(t)
 }
 
+// Until returns the duration that has to pass from the given time on the fakeClock
+// to reach the given time.
+func (fc *FakeClock) Until(t time.Time) time.Duration {
+	return t.Sub(fc.Now())
+}
+
 // NewTicker returns a Ticker that will expire only after calls to
 // FakeClock.Advance() have moved the clock past the given duration.
 //
diff --git a/clockwork_test.go b/clockwork_test.go
@@ -124,6 +124,23 @@ func TestFakeClockSince(t *testing.T) {
 	}
 }
 
+func TestFakeClockUntil(t *testing.T) {
+	t.Parallel()
+	testTime := time.Now()
+	fc := NewFakeClockAt(testTime)
+
+	testOffset := time.Minute
+	probeTime := testTime.Add(testOffset)
+
+	elapsedTime := time.Second
+	fc.Advance(elapsedTime)
+
+	expectedDuration := testOffset - elapsedTime
+	if fc.Until(probeTime) != expectedDuration {
+		t.Fatalf("fakeClock.Until() returned unexpected duration, got: %d, want: %d", fc.Until(probeTime), expectedDuration)
+	}
+}
+
 // This used to result in a deadlock.
 // https://github.com/jonboulle/clockwork/issues/35
 func TestTwoBlockersOneBlock(t *testing.T) {
