Skip to content
/ clock Public

Package clock provides an abstraction for system time that enables testing of time-sensitive code.

License

Notifications You must be signed in to change notification settings

jmhodges/clock

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

clock

GoDoc

Package clock provides an abstraction for system time that enables testing of time-sensitive code.

Where you'd use time.Now, instead use clk.Now where clk is an instance of clock.Clock.

When running your code in production, pass it a Clock given by clock.Default() and when you're running it in your tests, pass it an instance of Clock from NewFake().

When you do that, you can use FakeClock's Add and Set methods to control how time behaves in your tests. That makes the tests you'll write more reliable while also expanding the space of problems you can test.

This code intentionally does not attempt to provide an abstraction over time.Ticker and time.Timer because Go does not have the runtime or API hooks available to do so reliably. See golang/go#8869

As with any use of time, be sure to test Time equality with time.Time#Equal, not ==.

For API documentation, see the godoc.

About

Package clock provides an abstraction for system time that enables testing of time-sensitive code.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages