ttime

README

TTime - Testable Time

TTime is a small package meant to be used in place of the Go std "time" package. The driving goal of this package is to be testable by allowing a user to plug in their own 'time' struct.

If no 'time' struct is configured, ttime will behave normally.

A testing shim, ttime.TestTime, is also provided which allows time to be fast-forwarded and skipped.

This package does not provide a complete replacement to the 'time' package at this time, preferring to cover the most common use-cases that include "Sleep" and "Now".

Documentation

Overview

Package ttime implements a testable alternative to the Go "time" package.

Index

• func After(t time.Duration) <-chan time.Time
• func Now() time.Time
• func SetTime(t Time)
• func Since(t time.Time) time.Duration
• func Sleep(d time.Duration)
• type DefaultTime
  • func (*DefaultTime) After(d time.Duration) <-chan time.Time
  • func (*DefaultTime) AfterFunc(d time.Duration, f func()) Timer
  • func (*DefaultTime) Now() time.Time
  • func (*DefaultTime) Sleep(d time.Duration)
• type TestTime
  • func NewTestTime() *TestTime
  • func (t *TestTime) After(d time.Duration) <-chan time.Time
  • func (t *TestTime) AfterFunc(d time.Duration, f func()) Timer
  • func (t *TestTime) Cancel()
  • func (t *TestTime) LudicrousSpeed(b bool)
  • func (t *TestTime) Now() time.Time
  • func (t *TestTime) Sleep(d time.Duration)
  • func (t *TestTime) Warp(d time.Duration)
• type Time
• type Timer
  • func AfterFunc(d time.Duration, f func()) Timer

Functions

func After

func After(t time.Duration) <-chan time.Time

After calls the implementations After method

func Now

func Now() time.Time

Now returns the implementation's current time

func SetTime

func SetTime(t Time)

SetTime configures what 'Time' implementation to use for each of the package-level methods.

func Since

func Since(t time.Time) time.Duration

Since returns the time different from Now and the given time t

func Sleep

func Sleep(d time.Duration)

Sleep calls the implementation's Sleep method

Types

type DefaultTime

type DefaultTime struct{}

DefaultTime is a Time that behaves normally

func (*DefaultTime) After

func (*DefaultTime) After(d time.Duration) <-chan time.Time

After sleeps for the given duration and then writes to to the returned channel

func (*DefaultTime) AfterFunc

func (*DefaultTime) AfterFunc(d time.Duration, f func()) Timer

AfterFunc waits for the duration to elapse and then calls f in its own goroutine. It returns a Timer that can be used to cancel the call using its Stop method.

func (*DefaultTime) Now

func (*DefaultTime) Now() time.Time

Now returns the current time

func (*DefaultTime) Sleep

func (*DefaultTime) Sleep(d time.Duration)

Sleep sleeps for the given duration

type TestTime

type TestTime struct {
	// IsLudicrousSpeed indicates whether sleeps will all succeed instantly
	IsLudicrousSpeed bool
	// contains filtered or unexported fields
}

TestTime implements a time that is able to be moved forward easily

func NewTestTime

func NewTestTime() *TestTime

NewTestTime returns a default TestTime. It will not be LudicrousSpeed and will behave like a normal time

func (*TestTime) After

func (t *TestTime) After(d time.Duration) <-chan time.Time

After returns a channel which is written to after the given duration, taking into account time-warping

func (*TestTime) AfterFunc

func (t *TestTime) AfterFunc(d time.Duration, f func()) Timer

AfterFunc returns a timer and calls a function after a given time taking into account time-warping

func (*TestTime) Cancel

func (t *TestTime) Cancel()

Cancel cancels all pending sleeps

func (*TestTime) LudicrousSpeed

func (t *TestTime) LudicrousSpeed(b bool)

LudicrousSpeed can be called to toggle LudicrousSpeed (default off). When LudicrousSpeed is engaged, all calls to "sleep" will succeed instantly.

func (*TestTime) Now

func (t *TestTime) Now() time.Time

Now returns the current time, including any time-warping that has occured.

func (*TestTime) Sleep

func (t *TestTime) Sleep(d time.Duration)

Sleep sleeps the given duration in mock-time; that is to say that Warps will reduce the amount of time slept and LudicrousSpeed will cause instant success.

func (*TestTime) Warp

func (t *TestTime) Warp(d time.Duration)

Warp moves the mock time forwards by the given duration.

type Time

type Time interface {
	Now() time.Time
	Sleep(d time.Duration)
	After(d time.Duration) <-chan time.Time
	AfterFunc(d time.Duration, f func()) Timer
}

Time represents an implementation for this package's methods

type Timer

type Timer interface {
	Reset(d time.Duration) bool
	Stop() bool
}

func AfterFunc

func AfterFunc(d time.Duration, f func()) Timer

AfterFunc calls the implementations AfterFunc method