env

Documentation

Index

• Constants
• Variables
• func CurrentEnvironments() string
• func GetProcessedPropertiesMap(propertiesMap *properties.Properties) (*properties.Properties, error)
• func LoadEnv(envName string, errorHandler properties.ErrorHandlerFunc) error
• func LoadEnvProperties(propertiesMap *properties.Properties)

Constants

const (
	// SpecsDir holds the location of spec files
	SpecsDir = "gauge_specs_dir"
	// ConceptsDir holds the location of concept files
	ConceptsDir = "gauge_concepts_dir"
	// GaugeReportsDir holds the location of reports
	GaugeReportsDir = "gauge_reports_dir"
	// GaugeEnvironment holds the name of the current environment
	GaugeEnvironment = "gauge_environment"
	// 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"

	// GaugeScreenshotsDir holds the location of screenshots dir
	GaugeScreenshotsDir = "gauge_screenshots_dir"
)

Variables

var AllowCaseSensitiveTags = func() bool {
	return convertToBool(allowCaseSensitiveTags, false)
}

AllowCaseSensitiveTags determines if the casing is ignored in tags filtering

var AllowFilteredParallelExecution = func() bool {
	return convertToBool(allowFilteredParallelExecution, false)
}

AllowFilteredParallelExecution - feature toggle for filtered parallel execution

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 GaugeDataDir = func() string {
	d := os.Getenv(gaugeDataDir)
	if d == "" {
		return "."
	}
	return d
}

GaugeDataDir gets the data files location. This location should be relative to GAUGE_PROJECT_ROOT

var GaugeSpecFileExtensions = func() []string {
	e := os.Getenv(gaugeSpecFileExtensions)
	if e == "" {
		e = ".spec, .md"
	}
	exts := strings.Split(strings.TrimSpace(e), ",")
	var allowedExts = []string{}
	for _, ext := range exts {
		e := strings.TrimSpace(ext)
		if e != "" {
			allowedExts = append(allowedExts, e)
		}
	}
	return allowedExts
}

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

SaveExecutionResult determines if last run result should be saved

Functions

func CurrentEnvironments

func CurrentEnvironments() string

comma-separated value of environments

func GetProcessedPropertiesMap

func GetProcessedPropertiesMap(propertiesMap *properties.Properties) (*properties.Properties, error)

func LoadEnv

func LoadEnv(envName string, errorHandler properties.ErrorHandlerFunc) 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.

func LoadEnvProperties

func LoadEnvProperties(propertiesMap *properties.Properties)