state

Documentation

Overview

Package state contains the types and functionality used for keeping track of cmd-related values that are used globally throughout k6. It also exposes some related test types and helpers.

Index

• Constants
• func BuildEnvMap(environ []string) map[string]string
• func ParseEnvKeyValue(kv string) (string, string)
• type GlobalFlags
  • func GetDefaultFlags(homeDir string, cacheDir string) GlobalFlags
• type GlobalState
  • func NewGlobalState(ctx context.Context) *GlobalState

Constants

const (
	// AutoExtensionResolution defines the environment variable that enables using extensions natively
	AutoExtensionResolution = "K6_AUTO_EXTENSION_RESOLUTION"

	// DependenciesManifest defines the default values for dependency resolution
	DependenciesManifest = "K6_DEPENDENCIES_MANIFEST"
)

Functions

func BuildEnvMap

func BuildEnvMap(environ []string) map[string]string

BuildEnvMap returns a map from raw environment values, such as returned from os.Environ().

func ParseEnvKeyValue

func ParseEnvKeyValue(kv string) (string, string)

ParseEnvKeyValue splits an environment variable string into key and value.

Types

type GlobalFlags

type GlobalFlags struct {
	ConfigFilePath   string
	Quiet            bool
	NoColor          bool
	Address          string
	ProfilingEnabled bool
	LogOutput        string
	SecretSource     []string
	LogFormat        string
	Verbose          bool

	AutoExtensionResolution   bool
	BuildServiceURL           string
	BinaryCache               string
	EnableCommunityExtensions bool
	DependenciesManifest      string
}

GlobalFlags contains global config values that apply for all k6 sub-commands.

func GetDefaultFlags

func GetDefaultFlags(homeDir string, cacheDir string) GlobalFlags

GetDefaultFlags returns the default global flags.

type GlobalState

type GlobalState struct {
	Ctx context.Context

	FS              fsext.Fs
	Getwd           func() (string, error)
	UserOSConfigDir string
	BinaryName      string
	CmdArgs         []string
	Env             map[string]string
	Events          *event.System

	DefaultFlags, Flags GlobalFlags

	OutMutex       *sync.Mutex
	Stdout, Stderr *console.Writer
	Stdin          io.Reader

	OSExit       func(int)
	SignalNotify func(chan<- os.Signal, ...os.Signal)
	SignalStop   func(chan<- os.Signal)

	Logger         *logrus.Logger //nolint:forbidigo //TODO:change to FieldLogger
	FallbackLogger logrus.FieldLogger

	SecretsManager *secretsource.Manager
	Usage          *usage.Usage
	TestStatus     *lib.TestStatus
}

GlobalState contains the GlobalFlags and accessors for most of the global process-external state like CLI arguments, env vars, standard input, output and error, etc. In practice, most of it is normally accessed through the `os` package from the Go stdlib.

We group them here so we can prevent direct access to them from the rest of the k6 codebase. This gives us the ability to mock them and have robust and easy-to-write integration-like tests to check the k6 end-to-end behavior in any simulated conditions.

`NewGlobalState()` returns a globalState object with the real `os` parameters, while `NewGlobalTestState()` can be used in tests to create simulated environments.

func NewGlobalState

func NewGlobalState(ctx context.Context) *GlobalState

NewGlobalState returns a new GlobalState with the given ctx. Ideally, this should be the only function in the whole codebase where we use global variables and functions from the os package. Anywhere else, things like os.Stdout, os.Stderr, os.Stdin, os.Getenv(), etc. should be removed and the respective properties of globalState used instead.