runtime

Documentation

Index

• type Context
  • func NewContext() Context
• type RunSource

Types

type Context

type Context struct {
	// ClusterName is the name of the cluster that will be used to execute the tests in
	ClusterName string

	// RunSource identifies who/what triggered the test
	RunSource RunSource
}

Context contains the set of properties that are defined at runtime by whoever is invoking tests. The intention of this is two-fold:

1. To provide a transparent definition for the set of runtime inputs that are accepted.
2. To ensure that tests are not aware of _how_ inputs are provided (command line, env variable), but just are aware _that_ they exist

func NewContext

func NewContext() Context

type RunSource

type RunSource int

RunSource identifies who/what triggered the test

const (
	// LocalDevelopment signifies that the test is invoked locally
	LocalDevelopment RunSource = iota

	// PullRequest means that the test was invoked while running CI against a Pull Request
	PullRequest

	// NightlyTest means that the test was invoked while running CI as part of a Nightly operation
	NightlyTest
)