envvar

Documentation

Index

• Constants
• func FailIfAllEmpty(t testing.T, names []string, usageMessage string) (string, string)
• func FailIfEmpty(t testing.T, name string, usageMessage string) string
• func GetWithDefault(variable string, defaultValue string) string
• func Require(name string, usageMessage string) (string, error)
• func RequireOneOf(names []string, usageMessage string) (string, string, error)
• func SkipIfAllEmpty(t testing.T, names []string, usageMessage string) (string, string)
• func SkipIfEmpty(t testing.T, name string, usageMessage string) string

Constants

const (
	// Default static credential identifier for tests (AWS Go SDK does not provide this as constant)
	// See also AWS_SECRET_ACCESS_KEY and AWS_PROFILE
	AccessKeyId = "AWS_ACCESS_KEY_ID"

	// Container credentials endpoint
	// See also AWS_ACCESS_KEY_ID and AWS_PROFILE
	ContainerCredentialsFullURI = "AWS_CONTAINER_CREDENTIALS_FULL_URI"

	// Default AWS region for tests (AWS Go SDK does not provide this as constant)
	DefaultRegion = "AWS_DEFAULT_REGION"

	// Default AWS shared configuration profile for tests (AWS Go SDK does not provide this as constant)
	Profile = "AWS_PROFILE"

	// Default static credential value for tests (AWS Go SDK does not provide this as constant)
	// See also AWS_ACCESS_KEY_ID and AWS_PROFILE
	SecretAccessKey = "AWS_SECRET_ACCESS_KEY"
)

Standard AWS environment variables used in the Terraform AWS Provider testing. These are not provided as constants in the AWS Go SDK currently.

const (
	// For tests using an alternate AWS account, the equivalent of AWS_ACCESS_KEY_ID for that account
	AlternateAccessKeyId = "AWS_ALTERNATE_ACCESS_KEY_ID"

	// For tests using an alternate AWS account, the equivalent of AWS_PROFILE for that account
	AlternateProfile = "AWS_ALTERNATE_PROFILE"

	// For tests using an alternate AWS region, the equivalent of AWS_DEFAULT_REGION for that account
	AlternateRegion = "AWS_ALTERNATE_REGION"

	// For tests using an alternate AWS account, the equivalent of AWS_SECRET_ACCESS_KEY for that account
	AlternateSecretAccessKey = "AWS_ALTERNATE_SECRET_ACCESS_KEY"

	// For tests using a third AWS account, the equivalent of AWS_ACCESS_KEY_ID for that account
	ThirdAccessKeyId = "AWS_THIRD_ACCESS_KEY_ID"

	// For tests using a third AWS account, the equivalent of AWS_PROFILE for that account
	ThirdProfile = "AWS_THIRD_PROFILE"

	// For tests using a third AWS region, the equivalent of AWS_DEFAULT_REGION for that region
	ThirdRegion = "AWS_THIRD_REGION"

	// For tests using a third AWS account, the equivalent of AWS_SECRET_ACCESS_KEY for that account
	ThirdSecretAccessKey = "AWS_THIRD_SECRET_ACCESS_KEY"

	// For tests requiring GitHub permissions
	GithubToken = "GITHUB_TOKEN"

	// For tests requiring restricted IAM permissions, an existing IAM Role to assume
	// An inline assume role policy is then used to deny actions for the test
	AccAssumeRoleARN = "TF_ACC_ASSUME_ROLE_ARN"
)

Custom environment variables used in the Terraform AWS Provider testing. Additions should also be documented in the Environment Variable Dictionary of the Maintainers Guide: docs/MAINTAINING.md

const (
	// The ARN of the IAM Role to assume
	AssumeRoleARN = "TF_AWS_ASSUME_ROLE_ARN"

	// The duration in seconds the IAM role will be assumed.
	// Defaults to 1 hour (3600) instead of the SDK default of 15 minutes.
	AssumeRoleDuration = "TF_AWS_ASSUME_ROLE_DURATION"

	// An External ID to pass to the assumed role
	AssumeRoleExternalID = "TF_AWS_ASSUME_ROLE_EXTERNAL_ID"

	// A session name for the assumed role
	AssumeRoleSessionName = "TF_AWS_ASSUME_ROLE_SESSION_NAME"
)

Custom environment variables used for assuming a role with resource sweepers

Functions

func FailIfAllEmpty

func FailIfAllEmpty(t testing.T, names []string, usageMessage string) (string, string)

FailIfAllEmpty verifies that at least one environment variable is non-empty or fails the test.

If at least one environment variable is non-empty, returns the first name and value.

func FailIfEmpty

func FailIfEmpty(t testing.T, name string, usageMessage string) string

FailIfEmpty verifies that an environment variable is non-empty or fails the test.

For acceptance tests, this function must be used outside PreCheck functions to set values for configurations.

func GetWithDefault

func GetWithDefault(variable string, defaultValue string) string

GetWithDefault gets an environment variable value if non-empty or returns the default.

func Require

func Require(name string, usageMessage string) (string, error)

Require verifies that an environment variable is non-empty or returns an error.

func RequireOneOf

func RequireOneOf(names []string, usageMessage string) (string, string, error)

RequireOneOf verifies that at least one environment variable is non-empty or returns an error.

If at least one environment variable is non-empty, returns the first name and value.

func SkipIfAllEmpty

func SkipIfAllEmpty(t testing.T, names []string, usageMessage string) (string, string)

SkipIfAllEmpty verifies that at least one environment variable is non-empty or skips the test.

If at least one environment variable is non-empty, returns the first name and value.

func SkipIfEmpty

func SkipIfEmpty(t testing.T, name string, usageMessage string) string

SkipIfEmpty verifies that an environment variable is non-empty or skips the test.

For acceptance tests, this function must be used outside PreCheck functions to set values for configurations.