github.com/juju/clock@v1.0.3/testclock/dilated_test.go

// Copyright 2022 Canonical Ltd.
// Licensed under the LGPLv3, see LICENCE file for details.

package testclock_test

import (
	"math/rand"
	"runtime"
	"sync"
	"time"

	"github.com/juju/clock"
	"github.com/juju/testing"
	jc "github.com/juju/testing/checkers"
	gc "gopkg.in/check.v1"

	"github.com/juju/clock/testclock"
)

const (
	halfSecond   = 500 * time.Millisecond
	doubleSecond = 2 * time.Second
)

type dilatedClockSuite struct {
	testing.LoggingSuite
}

var _ = gc.Suite(&dilatedClockSuite{})

func (*dilatedClockSuite) TestSlowedAfter(c *gc.C) {
	cl := testclock.NewDilatedWallClock(doubleSecond)
	t0 := time.Now()
	d0 := cl.Now()
	d1 := <-cl.After(time.Second)
	t1 := time.Now()
	c.Assert(t1.Sub(t0).Seconds(), jc.GreaterThan, 1.9)
	c.Assert(d1.Sub(d0).Seconds(), jc.GreaterThan, 0.9)
	c.Assert(d1.Sub(d0).Seconds(), jc.LessThan, 1.1)
}

func (*dilatedClockSuite) TestFastAfter(c *gc.C) {
	cl := testclock.NewDilatedWallClock(halfSecond)
	t0 := time.Now()
	d0 := cl.Now()
	d1 := <-cl.After(time.Second)
	t1 := time.Now()
	c.Assert(t1.Sub(t0).Milliseconds(), jc.LessThan, 600)
	c.Assert(d1.Sub(d0).Milliseconds(), jc.GreaterThan, 990)
	c.Assert(d1.Sub(d0).Milliseconds(), jc.LessThan, 1010)
}

func (*dilatedClockSuite) TestSlowedAfterFunc(c *gc.C) {
	t0 := time.Now()
	cl := testclock.NewDilatedWallClock(doubleSecond)
	mut := sync.Mutex{}
	mut.Lock()
	cl.AfterFunc(time.Second, func() {
		defer mut.Unlock()
		c.Check(time.Since(t0).Seconds(), jc.GreaterThan, 1.9)
	})
	mut.Lock()
}

func (*dilatedClockSuite) TestFastAfterFunc(c *gc.C) {
	t0 := time.Now()
	cl := testclock.NewDilatedWallClock(halfSecond)
	mut := sync.Mutex{}
	mut.Lock()
	cl.AfterFunc(time.Second, func() {
		defer mut.Unlock()
		c.Check(time.Since(t0).Milliseconds(), jc.LessThan, 600)
	})
	mut.Lock()
}

func (*dilatedClockSuite) TestSlowedNow(c *gc.C) {
	t0 := time.Now()
	cl := testclock.NewDilatedWallClock(doubleSecond)
	<-time.After(time.Second)
	t2 := cl.Now()
	c.Assert(t2.Sub(t0).Milliseconds(), jc.GreaterThan, 400)
	c.Assert(t2.Sub(t0).Milliseconds(), jc.LessThan, 600)
	<-time.After(time.Second)
	t3 := cl.Now()
	c.Assert(t3.Sub(t0).Milliseconds(), jc.GreaterThan, 900)
	c.Assert(t3.Sub(t0).Milliseconds(), jc.LessThan, 1100)
}

func (*dilatedClockSuite) TestFastNow(c *gc.C) {
	t0 := time.Now()
	cl := testclock.NewDilatedWallClock(halfSecond)
	<-time.After(time.Second)
	t2 := cl.Now()
	c.Assert(t2.Sub(t0).Milliseconds(), jc.GreaterThan, 1900)
	c.Assert(t2.Sub(t0).Milliseconds(), jc.LessThan, 2100)
	<-time.After(time.Second)
	t3 := cl.Now()
	c.Assert(t3.Sub(t0).Milliseconds(), jc.GreaterThan, 3900)
	c.Assert(t3.Sub(t0).Milliseconds(), jc.LessThan, 4100)
}

func (*dilatedClockSuite) TestAdvance(c *gc.C) {
	t0 := time.Now()
	cl := testclock.NewDilatedWallClock(halfSecond)
	first := cl.After(time.Second)
	cl.Advance(halfSecond)
	<-time.After(250 * time.Millisecond)
	select {
	case t := <-first:
		c.Assert(t.Sub(t0).Milliseconds(), jc.GreaterThan, 249)
	case <-time.After(shortWait):
		c.Fatal("timer failed to trigger early")
	}
}

func (*dilatedClockSuite) TestAdvanceMulti(c *gc.C) {
	cl := testclock.NewDilatedWallClock(halfSecond)
	first := cl.After(time.Second)
	second := cl.After(2 * time.Second)
	third := cl.After(1 * time.Hour)

	done := time.After(longWait)
	fourth := cl.After(12*time.Hour + longWait*2 + time.Second)

	cl.Advance(12 * time.Hour)

	n := 0
out:
	for {
		select {
		case <-first:
			n++
		case <-second:
			n++
		case <-third:
			n++
		case <-fourth:
			c.Fatal("timer that fired that should not have")
		case <-done:
			break out
		}
	}
	c.Assert(n, gc.Equals, 3)
}

func (*dilatedClockSuite) TestStop(c *gc.C) {
	numGo := runtime.NumGoroutine()
	cl := testclock.NewDilatedWallClock(halfSecond)
	a := cl.NewTimer(time.Second)
	time.Sleep(shortWait)
	ok := a.Stop()
	c.Assert(ok, jc.IsTrue)
	ok = a.Stop()
	c.Assert(ok, jc.IsFalse)
	select {
	case <-a.Chan():
		c.Fatal("stopped clock fired")
	case <-time.After(time.Second):
	}
	for i := 0; i < 3; i++ {
		if runtime.NumGoroutine() == numGo {
			break
		}
		time.Sleep(shortWait)
	}
	c.Assert(runtime.NumGoroutine(), gc.Equals, numGo, gc.Commentf("clock goroutine still running"))
}

func (*dilatedClockSuite) TestReset(c *gc.C) {
	numGo := runtime.NumGoroutine()
	cl := testclock.NewDilatedWallClock(halfSecond)
	a := cl.NewTimer(time.Second)
	time.Sleep(250 * time.Millisecond)
	ok := a.Reset(time.Second)
	c.Assert(ok, jc.IsTrue)
	<-time.After(halfSecond)
	select {
	case <-a.Chan():
	case <-time.After(shortWait):
		c.Fatal("timer did not fire")
	}
	for i := 0; i < 3; i++ {
		if runtime.NumGoroutine() == numGo {
			break
		}
		time.Sleep(shortWait)
	}
	c.Assert(runtime.NumGoroutine(), gc.Equals, numGo, gc.Commentf("clock goroutine still running"))
}

func (*dilatedClockSuite) TestStopReset(c *gc.C) {
	numGo := runtime.NumGoroutine()
	cl := testclock.NewDilatedWallClock(halfSecond)
	a := cl.NewTimer(time.Second)
	time.Sleep(250 * time.Millisecond)
	ok := a.Stop()
	c.Assert(ok, jc.IsTrue)
	ok = a.Reset(time.Second)
	c.Assert(ok, jc.IsTrue)
	<-time.After(halfSecond)
	select {
	case <-a.Chan():
	case <-time.After(shortWait):
		c.Fatal("timer did not fire")
	}
	for i := 0; i < 3; i++ {
		if runtime.NumGoroutine() == numGo {
			break
		}
		time.Sleep(shortWait)
	}
	c.Assert(runtime.NumGoroutine(), gc.Equals, numGo, gc.Commentf("clock goroutine still running"))
}

func (*dilatedClockSuite) TestAdvanceAlreadyFired(c *gc.C) {
	numGo := runtime.NumGoroutine()
	cl := testclock.NewDilatedWallClock(time.Second)
	t := cl.NewTimer(time.Millisecond)
	time.Sleep(shortWait)
	cl.Advance(time.Second)
	select {
	case <-t.Chan():
	case <-time.After(shortWait):
		c.Fatal("timer did not fire")
	}
	for i := 0; i < 3; i++ {
		if runtime.NumGoroutine() == numGo {
			break
		}
		time.Sleep(shortWait)
	}
	c.Assert(runtime.NumGoroutine(), gc.Equals, numGo, gc.Commentf("clock goroutine still running"))
}

func (*dilatedClockSuite) TestAdvanceFast(c *gc.C) {
	cl := testclock.NewDilatedWallClock(time.Minute)
	timers := make([]clock.Timer, 0, 1000)
	for i := time.Millisecond; i <= time.Second; i += time.Millisecond {
		timers = append(timers, cl.NewTimer(i))
	}
	for i := 0; i < 10000; i++ {
		cl.Advance(100 * time.Microsecond)
	}
	deadline := time.After(10 * time.Second)
	for _, timer := range timers {
		select {
		case <-timer.Chan():
		case <-deadline:
			c.Fatal("timer did not fire by deadline")
		}
	}
}

func (*dilatedClockSuite) TestAdvanceReset(c *gc.C) {
	cl := testclock.NewDilatedWallClock(time.Minute)
	timers := make([]clock.Timer, 0, 10)
	for i := 0; i < 10; i++ {
		timers = append(timers, cl.NewTimer(time.Millisecond))
	}
	deadline := time.After(10 * time.Second)
	for i := 0; i < 1000; i++ {
		cl.Advance(time.Millisecond)
		for _, timer := range timers {
			select {
			case <-timer.Chan():
			case <-deadline:
				c.Fatal("timer did not fire by deadline")
			}
			timer.Reset(time.Millisecond)
		}
	}
}

func (*dilatedClockSuite) TestAdvanceResetRacey(c *gc.C) {
	cl := testclock.NewDilatedWallClock(time.Second)
	timers := make([]clock.Timer, 0, 10)
	for i := 0; i < 10; i++ {
		timers = append(timers, cl.NewTimer(time.Millisecond))
	}
	deadline := time.After(2 * time.Second)
	for i := 0; i < 1000; i++ {
		time.Sleep(999 * time.Microsecond)
		cl.Advance(time.Microsecond * time.Duration(rand.Intn(2)))
		for _, timer := range timers {
			select {
			case <-timer.Chan():
			case <-deadline:
				c.Fatal("timer did not fire by deadline")
			}
			timer.Reset(time.Millisecond)
		}
	}
}