params

Documentation

Overview

Package params implements function parameters for [e2e.Suite]

Index

• func WithDevMode() func(*Params)
• func WithLazyEnvironment() func(*Params)
• func WithSkipDeleteOnFailure() func(*Params)
• func WithStackName(stackName string) func(*Params)
• type Option
• type Params

Functions

func WithDevMode

func WithDevMode() func(*Params)

WithDevMode enables dev mode. Dev mode doesn't destroy the environment when the test finished which can be useful when writing a new E2E test.

func WithLazyEnvironment

func WithLazyEnvironment() func(*Params)

WithLazyEnvironment skips environment creation until the first explicit call to suite.Env()

func WithSkipDeleteOnFailure

func WithSkipDeleteOnFailure() func(*Params)

WithSkipDeleteOnFailure doesn't destroy the environment when a test fail.

func WithStackName

func WithStackName(stackName string) func(*Params)

WithStackName overrides the default stack name. This function is useful only when using [Run].

Types

type Option

type Option = func(*Params)

Option is an optional function parameter type for e2e options

type Params

type Params struct {
	StackName string

	// Setting DevMode allows to skip deletion regardless of test results
	// Unavailable in CI.
	DevMode bool

	SkipDeleteOnFailure bool

	// Setting LazyEnvironment allows to skip environment creation
	// until the first explicit call to suite.Env()
	LazyEnvironment bool
}

Params implements [e2e.Suite] options