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

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

package testclock_test

import (
	"sync"
	"time"

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

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

type clockSuite struct {
	testing.LoggingSuite
}

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

func (*clockSuite) TestNow(c *gc.C) {
	t0 := time.Now()
	cl := testclock.NewClock(t0)
	c.Assert(cl.Now(), gc.Equals, t0)
}

func (*clockSuite) TestAdvanceLogs(c *gc.C) {
	loggo.GetLogger("juju.clock").SetLogLevel(loggo.DEBUG)
	t0 := time.Now()
	cl := testclock.NewClock(t0)

	// Shouldn't log anything.
	t := cl.After(time.Second)
	cl.Advance(time.Minute)
	<-t
	c.Check(c.GetTestLog(), jc.DeepEquals, "")

	// Should log since nothing's waiting.
	cl.Advance(time.Hour)
	c.Check(c.GetTestLog(), jc.Contains, "advancing a clock that has nothing waiting: cf. https://github.com/juju/juju/wiki/Intermittent-failures")
}

func (*clockSuite) TestWaitAdvance(c *gc.C) {
	t0 := time.Now()
	cl := testclock.NewClock(t0)

	// It is legal to just say 'nothing is waiting'
	err := cl.WaitAdvance(0, 0, 0)
	c.Check(err, jc.ErrorIsNil)

	// Test that no timers errors out.
	err = cl.WaitAdvance(time.Millisecond, 10*time.Millisecond, 1)
	c.Check(err, gc.ErrorMatches, "got 0 timers added after waiting 10ms: wanted 1, stacks:\n")

	// Test that a timer doesn't error.
	_ = cl.After(time.Nanosecond)
	err = cl.WaitAdvance(time.Millisecond, 10*time.Millisecond, 1)
	c.Check(err, jc.ErrorIsNil)
}

func (*clockSuite) TestAdvanceWithAfter(c *gc.C) {
	t0 := time.Now()
	cl := testclock.NewClock(t0)
	ch := cl.After(time.Second)
	select {
	case <-ch:
		c.Fatalf("received unexpected event")
	case <-time.After(shortWait):
	}

	cl.Advance(time.Second - 1)

	select {
	case <-ch:
		c.Fatalf("received unexpected event")
	case <-time.After(shortWait):
	}

	cl.Advance(1)

	select {
	case <-ch:
	case <-time.After(longWait):
		c.Fatalf("expected event to be triggered")
	}

	cl.Advance(time.Second)
	select {
	case <-ch:
		c.Fatalf("received unexpected event")
	case <-time.After(shortWait):
	}

	// Test that we can do it again
	ch = cl.After(time.Second)
	cl.Advance(2 * time.Second)
	select {
	case <-ch:
	case <-time.After(longWait):
		c.Fatalf("expected event to be triggered")
	}
	c.Assert(cl.Now().UTC(), gc.Equals, t0.Add(4*time.Second).UTC())
}

func (*clockSuite) TestAdvanceWithAfterFunc(c *gc.C) {
	// Most of the details have been checked in TestAdvanceWithAfter,
	// so just check that AfterFunc is wired up correctly.
	t0 := time.Now()
	cl := testclock.NewClock(t0)
	fired := make(chan struct{})
	cl.AfterFunc(time.Second, func() {
		close(fired)
	})
	cl.Advance(2 * time.Second)
	select {
	case <-fired:
	case <-time.After(longWait):
		c.Fatalf("expected event to be triggered")
	}
}

func (*clockSuite) TestAfterFuncStop(c *gc.C) {
	t0 := time.Now()
	cl := testclock.NewClock(t0)
	fired := make(chan struct{})
	timer := cl.AfterFunc(time.Second, func() {
		close(fired)
	})
	cl.Advance(50 * time.Millisecond)
	timer.Stop()
	select {
	case <-fired:
		c.Fatalf("received unexpected event")
	case <-time.After(shortWait):
	}
}

func (*clockSuite) TestNewTimerReset(c *gc.C) {
	t0 := time.Now()
	cl := testclock.NewClock(t0)
	timer := cl.NewTimer(time.Second)
	cl.Advance(time.Second)
	select {
	case t := <-timer.Chan():
		c.Assert(t.UTC(), gc.Equals, t0.Add(time.Second).UTC())
	case <-time.After(longWait):
		c.Fatalf("expected event to be triggered")
	}

	timer.Reset(50 * time.Millisecond)
	cl.Advance(100 * time.Millisecond)
	select {
	case t := <-timer.Chan():
		c.Assert(t.UTC(), gc.Equals, t0.Add(time.Second+100*time.Millisecond).UTC())
	case <-time.After(longWait):
		c.Fatalf("expected event to be triggered")
	}
}

func (*clockSuite) TestNewTimerAsyncReset(c *gc.C) {
	t0 := time.Now()
	clock := testclock.NewClock(t0)
	timer := clock.NewTimer(time.Hour)
	stop := make(chan struct{})
	stopped := make(chan struct{})
	var wg sync.WaitGroup
	wg.Add(1)
	go func() {
		defer wg.Done()
		select {
		case <-stop:
		case t := <-timer.Chan():
			c.Errorf("timer accidentally ticked at: %v", t)
		case <-time.After(longWait):
			c.Errorf("test took too long")
		}
		close(stopped)
	}()
	// Just our goroutine, but we don't go so far as to trigger the wakeup.
	clock.WaitAdvance(1*time.Minute, 10*time.Millisecond, 1)
	// Reset shouldn't trigger a wakeup, just move when it thinks it will wake up.
	timer.Reset(time.Hour)
	clock.WaitAdvance(1*time.Minute, 10*time.Millisecond, 1)
	timer.Reset(time.Minute)
	clock.WaitAdvance(30*time.Second, 10*time.Millisecond, 1)
	// Now tell the goroutine to stop and start another one that *does* want to
	// wake up
	close(stop)
	select {
	case <-stopped:
	case <-time.After(longWait):
		c.Errorf("goroutine failed to stop")
	}
	wg.Add(1)
	go func() {
		defer wg.Done()
		select {
		case t := <-timer.Chan():
			c.Logf("timer successfully ticked: %v", t)
		case <-time.After(longWait):
			c.Errorf("timer took too long")
		}
	}()
	// And advance the clock long enough to cause it to notice
	clock.WaitAdvance(30*time.Second, 10*time.Millisecond, 1)
	wg.Wait()
}

func (*clockSuite) TestNewTimerResetCausesWakeup(c *gc.C) {
	t0 := time.Now()
	clock := testclock.NewClock(t0)
	timer1 := clock.NewTimer(time.Hour)
	timer2 := clock.NewTimer(time.Hour)
	timer3 := clock.NewTimer(time.Hour)
	var wg sync.WaitGroup
	wg.Add(1)
	go func() {
		defer wg.Done()
		select {
		case t := <-timer1.Chan():
			c.Check(t0, gc.Equals, t)
		case <-time.After(longWait):
			c.Errorf("timer1 took too long to wake up")
		}
	}()
	wg.Add(1)
	go func() {
		defer wg.Done()
		select {
		case <-timer2.Chan():
			c.Errorf("timer2 should not wake up")
		case <-time.After(shortWait):
			c.Logf("timer2 succesfully slept for 50ms")
		}
	}()
	wg.Add(1)
	go func() {
		defer wg.Done()
		select {
		case t := <-timer3.Chan():
			// Even though the reset was negative, it triggers at 'now'
			c.Check(t0, gc.Equals, t)
		case <-time.After(longWait):
			c.Errorf("timer3 took too long to wake up")
		}
	}()
	// Reseting the timer to a time <= 0 should cause it to wake up on its
	// own, without needing an Advance or WaitAdvance to be done
	timer1.Reset(0)
	timer3.Reset(-1 * time.Second)
	wg.Wait()
}

func (*clockSuite) TestMultipleWaiters(c *gc.C) {
	var wg sync.WaitGroup
	t0 := time.Date(2000, 01, 01, 01, 0, 0, 0, time.UTC)
	cl := testclock.NewClock(t0)

	total := 0
	start := func(f func()) {
		total++
		wg.Add(1)
		go func() {
			defer wg.Done()
			f()
		}()
	}
	start(func() {
		<-cl.After(50 * time.Millisecond)
	})
	start(func() {
		ch := make(chan struct{})
		cl.AfterFunc(100*time.Millisecond, func() {
			close(ch)
		})
		<-ch
	})
	start(func() {
		timer := cl.NewTimer(150 * time.Millisecond)
		<-timer.Chan()
		timer.Reset(50 * time.Millisecond)
		<-timer.Chan()
	})

	done := make(chan struct{})
	go func() {
		wg.Wait()
		close(done)
	}()

	// Wait for all the alarms to be waited on.
	for i := 0; i < total; i++ {
		select {
		case <-cl.Alarms():
		case <-time.After(longWait):
			c.Fatalf("expected a notification on the alarms channel")
		}
	}
	select {
	case <-cl.Alarms():
		c.Fatalf("unexpected extra notification on alarms channel")
	case <-time.After(shortWait):
	}

	cl.Advance(150 * time.Millisecond)

	// Wait for the extra notification after reset.
	select {
	case <-cl.Alarms():
	case <-time.After(longWait):
		c.Fatalf("expected a notification on the alarms channel")
	}

	cl.Advance(50 * time.Millisecond)

	select {
	case <-done:
	case <-time.After(longWait):
		c.Fatalf("expected all waits to complete")
	}

}