📖 4 min read (~ 700 words).

Time

Asserting Times And Durations

Assertions

GoDoc

All links point to https://pkg.go.dev/github.com/go-openapi/testify/v2

This domain exposes 2 functionalities.

WithinDuration

WithinDuration asserts that the two times are within duration delta of each other.

Examples
​
	assertions.WithinDuration(t, time.Now(), 10*time.Second)
	success: time.Date(2024, 1, 1, 12, 0, 0, 0, time.UTC), time.Date(2024, 1, 1, 12, 0, 1, 0, time.UTC), 2*time.Second
	failure: time.Date(2024, 1, 1, 12, 0, 0, 0, time.UTC), time.Date(2024, 1, 1, 12, 0, 10, 0, time.UTC), 1*time.Second

  • Copy and click to open Go Playground

    // real-world test would inject *testing.T from TestWithinDuration(t *testing.T)
package main

import (
	"fmt"
	"testing"
	"time"

	"github.com/go-openapi/testify/v2/assert"
)

func main() {
	t := new(testing.T) // should come from testing, e.g. func TestWithinDuration(t *testing.T)
	success := assert.WithinDuration(t, time.Date(2024, 1, 1, 12, 0, 0, 0, time.UTC), time.Date(2024, 1, 1, 12, 0, 1, 0, time.UTC), 2*time.Second)
	fmt.Printf("success: %t\n", success)

}

  • Copy and click to open Go Playground

    // real-world test would inject *testing.T from TestWithinDuration(t *testing.T)
package main

import (
	"fmt"
	"testing"
	"time"

	"github.com/go-openapi/testify/v2/require"
)

func main() {
	t := new(testing.T) // should come from testing, e.g. func TestWithinDuration(t *testing.T)
	require.WithinDuration(t, time.Date(2024, 1, 1, 12, 0, 0, 0, time.UTC), time.Date(2024, 1, 1, 12, 0, 1, 0, time.UTC), 2*time.Second)
	fmt.Println("passed")

}
​
SignatureUsage
assert.WithinDuration(t T, expected time.Time, actual time.Time, delta time.Duration, msgAndArgs ...any) boolpackage-level function
assert.WithinDurationf(t T, expected time.Time, actual time.Time, delta time.Duration, msg string, args ...any) boolformatted variant
assert.(*Assertions).WithinDuration(expected time.Time, actual time.Time, delta time.Duration) boolmethod variant
assert.(*Assertions).WithinDurationf(expected time.Time, actual time.Time, delta time.Duration, msg string, args ..any)method formatted variant
SignatureUsage
require.WithinDuration(t T, expected time.Time, actual time.Time, delta time.Duration, msgAndArgs ...any) boolpackage-level function
require.WithinDurationf(t T, expected time.Time, actual time.Time, delta time.Duration, msg string, args ...any) boolformatted variant
require.(*Assertions).WithinDuration(expected time.Time, actual time.Time, delta time.Duration) boolmethod variant
require.(*Assertions).WithinDurationf(expected time.Time, actual time.Time, delta time.Duration, msg string, args ..any)method formatted variant
SignatureUsage
assertions.WithinDuration(t T, expected time.Time, actual time.Time, delta time.Duration, msgAndArgs ...any) boolinternal implementation

Source: github.com/go-openapi/testify/v2/internal/assertions#WithinDuration

WithinRange

WithinRange asserts that a time is within a time range (inclusive).

Examples
​
	assertions.WithinRange(t, time.Now(), time.Now().Add(-time.Second), time.Now().Add(time.Second))
	success: time.Date(2024, 1, 1, 12, 0, 0, 0, time.UTC), time.Date(2024, 1, 1, 11, 0, 0, 0, time.UTC), time.Date(2024, 1, 1, 13, 0, 0, 0, time.UTC)
	failure: time.Date(2024, 1, 1, 14, 0, 0, 0, time.UTC), time.Date(2024, 1, 1, 11, 0, 0, 0, time.UTC), time.Date(2024, 1, 1, 13, 0, 0, 0, time.UTC)

  • Copy and click to open Go Playground

    // real-world test would inject *testing.T from TestWithinRange(t *testing.T)
package main

import (
	"fmt"
	"testing"
	"time"

	"github.com/go-openapi/testify/v2/assert"
)

func main() {
	t := new(testing.T) // should come from testing, e.g. func TestWithinRange(t *testing.T)
	success := assert.WithinRange(t, time.Date(2024, 1, 1, 12, 0, 0, 0, time.UTC), time.Date(2024, 1, 1, 11, 0, 0, 0, time.UTC), time.Date(2024, 1, 1, 13, 0, 0, 0, time.UTC))
	fmt.Printf("success: %t\n", success)

}

  • Copy and click to open Go Playground

    // real-world test would inject *testing.T from TestWithinRange(t *testing.T)
package main

import (
	"fmt"
	"testing"
	"time"

	"github.com/go-openapi/testify/v2/require"
)

func main() {
	t := new(testing.T) // should come from testing, e.g. func TestWithinRange(t *testing.T)
	require.WithinRange(t, time.Date(2024, 1, 1, 12, 0, 0, 0, time.UTC), time.Date(2024, 1, 1, 11, 0, 0, 0, time.UTC), time.Date(2024, 1, 1, 13, 0, 0, 0, time.UTC))
	fmt.Println("passed")

}
​
SignatureUsage
assert.WithinRange(t T, actual time.Time, start time.Time, end time.Time, msgAndArgs ...any) boolpackage-level function
assert.WithinRangef(t T, actual time.Time, start time.Time, end time.Time, msg string, args ...any) boolformatted variant
assert.(*Assertions).WithinRange(actual time.Time, start time.Time, end time.Time) boolmethod variant
assert.(*Assertions).WithinRangef(actual time.Time, start time.Time, end time.Time, msg string, args ..any)method formatted variant
SignatureUsage
require.WithinRange(t T, actual time.Time, start time.Time, end time.Time, msgAndArgs ...any) boolpackage-level function
require.WithinRangef(t T, actual time.Time, start time.Time, end time.Time, msg string, args ...any) boolformatted variant
require.(*Assertions).WithinRange(actual time.Time, start time.Time, end time.Time) boolmethod variant
require.(*Assertions).WithinRangef(actual time.Time, start time.Time, end time.Time, msg string, args ..any)method formatted variant
SignatureUsage
assertions.WithinRange(t T, actual time.Time, start time.Time, end time.Time, msgAndArgs ...any) boolinternal implementation

Source: github.com/go-openapi/testify/v2/internal/assertions#WithinRange

Generated with github.com/go-openapi/testify/codegen/v2