clocksteps

README

Cucumber Clock steps for Golang

clocksteps uses go.nhat.io/clock to provide steps for cucumber/godog and makes it easy to run tests with time.

Prerequisites

• Go >= 1.16

Usage

Initiate the clock and register it to the scenario.

package mypackage

import (
	"testing"

	"github.com/cucumber/godog"
	"github.com/godogx/clocksteps"
)

func TestIntegration(t *testing.T) {
	clock := clocksteps.New()
	suite := godog.TestSuite{
		Name:                 "Integration",
		TestSuiteInitializer: nil,
		ScenarioInitializer: func(ctx *godog.ScenarioContext) {
			clock.RegisterContext(ctx)
		},
		Options: &godog.Options{
			Strict:    true,
			Output:    out,
			Randomize: rand.Int63(),
		},
	}
	
	// Inject the clock to your application then run the suite.
	status := suite.Run()
}

Read more about go.nhat.io/clock

Steps

Set the time

By default, the clock always returns time.Now() unless you freeze or set it. For setting, you can use one of these:

• (?:the )?clock is at "([^"]*)"
• (?:the )?clock is set to "([^"]*)"
• sets? (?:the )?clock to "([^"]*)"
• now is "([^"]*)"

They have the same effect, the clock will be set at a specific time.Time. The given can be in RFC3339 (2006-01-02T15:04:05Z07:00) or YMD (2006-01-02)

For example:

    Scenario: Set time
        Given the clock is at "2020-01-02T03:04:05Z"
        Then the time is "2020-01-02T03:04:05Z"

        Given the clock is set to "2020-02-03T04:05:06Z"
        Then the time is "2020-02-03T04:05:06Z"

        Given Someone sets the clock to "2020-03-04T05:06:07Z"
        Then the time is "2020-03-04T05:06:07Z"

        Given now is "2020-04-05T06:07:08Z"
        Then the time is "2020-04-05T06:07:08Z"

Adjust the time

After setting the clock, you can adjust the time by adding a time.Duration, some days, months or years with these:

• adds? ([^\s]*) to (?:the )?clock
• adds? ([0-9]+) days? to (?:the )?clock
• adds? ([0-9]+) months? to (?:the )?clock
• adds? ([0-9]+) years? to (?:the )?clock
• adds? ([0-9]+) months?,? ([0-9]+) days? to (?:the )?clock
• adds? ([0-9]+) years?,? ([0-9]+) days? to (?:the )?clock
• adds? ([0-9]+) years?,? ([0-9]+) months? to (?:the )?clock
• adds? ([0-9]+) years?,? ([0-9]+) months?,? ([0-9]+) days? to (?:the )?clock

Important: You have to set the clock before adjusting it. Otherwise you will get clocksteps.ErrClockIsNotSet

For example:

    Scenario: Add time
        Given the clock is at "2020-01-02T03:04:05Z"
        And someone adds 1h5s to the clock
        Then the time is "2020-01-02T04:04:10Z"

        Given someone adds 2 days to the clock
        Then the time is "2020-01-04T04:04:10Z"

Freeze and release the clock

    Scenario: Freeze and Release
        Given the time is now

        When I freeze the clock
        And I wait for 50ms
        Then the time is not now

        When I wait for 50ms
        And I release the clock
        Then the time is now

Documentation

Overview

Package clocksteps provides a clock for tests with cucumber/godog.

Index

• Variables
• type Clock
  • func New() *Clock
  • func (c *Clock) Add(d time.Duration) error
  • func (c *Clock) AddDate(years, months, days int) error
  • func (c *Clock) Clock() clock.Clock
  • func (c *Clock) Freeze()
  • func (c *Clock) Now() time.Time
  • func (c *Clock) RegisterContext(s *godog.ScenarioContext)
  • func (c *Clock) RegisterSteps(s *godog.ScenarioContext)
  • func (c *Clock) Set(t time.Time)
  • func (c *Clock) Unfreeze()

Variables

var ErrClockIsNotSet = errors.New("clock is not set")

ErrClockIsNotSet indicates that the clock must be set by either Clock.Set() or Clock.Freeze() before adding some time.Duration into it.

Types

type Clock

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

Clock is a clock.Clock.

func New

func New() *Clock

New initiates a new Clock.

func (*Clock) Add

func (c *Clock) Add(d time.Duration) error

Add adds time to the clock.

func (*Clock) AddDate

func (c *Clock) AddDate(years, months, days int) error

AddDate adds date to the clock.

func (*Clock) Clock

func (c *Clock) Clock() clock.Clock

Clock provides clock.Clock.

func (*Clock) Freeze

func (c *Clock) Freeze()

Freeze freezes the clock.

func (*Clock) Now

func (c *Clock) Now() time.Time

Now returns a fixed timestamp or time.Now().

func (*Clock) RegisterContext

func (c *Clock) RegisterContext(s *godog.ScenarioContext)

RegisterContext registers clock to godog tests.

Deprecated: use RegisterSteps instead.

func (*Clock) RegisterSteps

func (c *Clock) RegisterSteps(s *godog.ScenarioContext)

RegisterSteps registers clock to godog tests.

func (*Clock) Set

func (c *Clock) Set(t time.Time)

Set fixes the clock at a time.

func (*Clock) Unfreeze

func (c *Clock) Unfreeze()

Unfreeze unfreezes the clock.