timeutil

Documentation

Overview

Package timeutil provides time.Now that can be monkey-patched.

Example

package main

import (
	"fmt"
	"time"

	"github.com/layer0-platform/webpackager/internal/timeutil"
)

func main() {
	defer timeutil.ResetNow()
	timeutil.StubNowWithFixedTime(time.Date(2020, time.June, 1, 12, 34, 56, 0, time.UTC))
	fmt.Println(timeutil.Now())
}

Output:

2020-06-01 12:34:56 +0000 UTC

Index

• func Now() time.Time
• func ResetNow()
• func StubNow(stub func() time.Time)
• func StubNowToAdjust(newNow time.Time)
• func StubNowWithFixedTime(newNow time.Time)

Examples

• Package

Functions

func Now

func Now() time.Time

Now returns the current local time. It is equal to time.Now by default but can be faked using StubNow or other Stub functions.

func ResetNow

func ResetNow()

ResetNow restores the Now's original behavior.

func StubNow

func StubNow(stub func() time.Time)

StubNow substitutes Now with stub for testing.

func StubNowToAdjust

func StubNowToAdjust(newNow time.Time)

StubNowToAdjust "adjusts" Now to newNow for testing. The stubbed time continues to advance: Now will return newNow plus the time elapsed since StubNowToAdjust is called.

func StubNowWithFixedTime

func StubNowWithFixedTime(newNow time.Time)

StubNowWithFixedTime makes Now return newNow for testing. The stubbed time does not advance.