env

Documentation

Index

• Constants
• Variables
• func CurrentEnvironments() string
• func LoadEnv(envName string) error

Constants

const (
	// SpecsDir holds the location of spec files
	SpecsDir = "gauge_specs_dir"
	// GaugeReportsDir holds the location of reports
	GaugeReportsDir = "gauge_reports_dir"
	// LogsDirectory holds the location of log files
	LogsDirectory = "logs_directory"
	// OverwriteReports = false will create a new directory for reports
	// for every run.
	OverwriteReports = "overwrite_reports"
	// ScreenshotOnFailure indicates if failure should invoke screenshot
	ScreenshotOnFailure = "screenshot_on_failure"

	// CsvDelimiter holds delimiter used to parse csv files
	CsvDelimiter = "csv_delimiter"
)

Variables

var AllowMultiLineStep = func() bool {
	return convertToBool(allowMultilineStep, false)
}

AllowMultiLineStep - feature toggle for newline in step text

var AllowScenarioDatatable = func() bool {
	return convertToBool(allowScenarioDatatable, false)
}

AllowScenarioDatatable -feature toggle for datatables in scenario

var EnableMultiThreadedExecution = func() bool {
	return convertToBool(enableMultithreading, false)
}

EnableMultiThreadedExecution determines if threads should be used instead of process for each parallel stream

var SaveExecutionResult = func() bool {
	return convertToBool(saveExecutionResult, false)
}

SaveExecutionResult determines if last run result should be saved

var TelemetryInterval = func() string {
	return strings.ToLower(os.Getenv(telemetryInterval))
}

TelemetryInterval allows to configure duration for which telemetry is to be sent, when UseTestGA is true.

var UseTestGA = func() bool {
	return strings.ToLower(os.Getenv(useTestGA)) == "true"
}

UseTestGA checks if test google analytics account needs to be used

Functions

func CurrentEnvironments

func CurrentEnvironments() string

comma-separated value of environments

func LoadEnv

func LoadEnv(envName string) error

LoadEnv first generates the map of the env vars that needs to be set. It starts by populating the map with the env passed by the user in --env flag. It then adds the default values of the env vars which are required by Gauge, but are not present in the map.

Finally, all the env vars present in the map are actually set in the shell.