Environment variables

Working with environment variables.

Overview #

Project has built-in support for environment variables. Freshly cloned project uses 3 of them.

GODOG_DEBUG=false
GODOG_MY_APP_URL=http://localhost:1234
GODOG_JSON_SCHEMA_DIR=./assets/test_server/doc/schema

which can be found in .env file.

Further usage #

You can add/modify/remove any environment variables. In code, current environment variables are defined at top of main_test.go file

const (
    //envDebug describes environment variable responsible for debug mode - (true/false).
    envDebug = "GODOG_DEBUG"
    
    // envMyAppURL describes URL to "My app" - should be valid URL.
    envMyAppURL = "GODOG_MY_APP_URL"
    
    // envJsonSchemaDir path to JSON schemas dir - relative path from this file's directory.
    envJsonSchemaDir = "GODOG_JSON_SCHEMA_DIR"
)

and further used for example as pre-defined variables in every scenario like this (os.Getenv obtains environment variable from .env file or shell):

ctx.Before(func(ctx context.Context, sc *godog.Scenario) (context.Context, error) {
    scenario.APIContext.ResetState(isDebug)

    // Here you can define more scenario-scoped values using scenario.APIContext.Cache.Save() method
    scenario.APIContext.Cache.Save("MY_APP_URL", os.Getenv(envMyAppURL))
    scenario.APIContext.Cache.Save("CWD", wd) // current working directory - full OS path to this file

return ctx, nil
})

Above example shows usage of Cache utility service, which is responsible for storing values across scenario.