clock

Documentation

Overview

Package clock provides a mockable time abstraction for deterministic testing.

Index

• type Clock
• type MockClock
  • func NewMockClock(t time.Time) *MockClock
  • func (m *MockClock) Add(d time.Duration)
  • func (m *MockClock) Now() time.Time
• type RealClock
  • func (RealClock) Now() time.Time

Types

type Clock

type Clock interface {
	Now() time.Time
}

Clock abstracts time.Now() for testability.

type MockClock

type MockClock struct {
	// contains filtered or unexported fields
}

MockClock returns a fixed or controlled time for testing.

func NewMockClock

func NewMockClock(t time.Time) *MockClock

NewMockClock creates a MockClock starting at the given time.

func (*MockClock) Add

func (m *MockClock) Add(d time.Duration)

Add advances the mock clock by the given duration.

func (*MockClock) Now

func (m *MockClock) Now() time.Time

Now returns the mock clock's current time.

type RealClock

type RealClock struct{}

RealClock uses the real system time.

func (RealClock) Now

func (RealClock) Now() time.Time

Now returns the current time.