Documentation
¶
Overview ¶
Package test_structure allows to set up tests and their environment.
Index ¶
- Constants
- func CleanupTestData(t testing.TestingT, path string)
- func CleanupTestDataFolder(t testing.TestingT, path string)
- func CleanupTestDataFolderE(t testing.TestingT, path string) error
- func CopyTerraformFolderToTemp(t testing.TestingT, rootFolder string, terraformModuleFolder string) string
- func FormatTestDataPath(testFolder string, filename string) string
- func IsTestDataPresent(t testing.TestingT, path string) bool
- func LoadAmiId(t testing.TestingT, testFolder string) stringdeprecated
- func LoadArtifactID(t testing.TestingT, testFolder string) string
- func LoadEc2KeyPair(t testing.TestingT, testFolder string) *aws.Ec2Keypair
- func LoadInt(t testing.TestingT, testFolder string, name string) int
- func LoadKubectlOptions(t testing.TestingT, testFolder string) *k8s.KubectlOptions
- func LoadPackerOptions(t testing.TestingT, testFolder string) *packer.Options
- func LoadString(t testing.TestingT, testFolder string, name string) string
- func LoadTerraformOptions(t testing.TestingT, testFolder string) *terraform.Options
- func LoadTestData(t testing.TestingT, path string, value interface{})
- func RunTestStage(t testing.TestingT, stageName string, stage func())
- func SaveAmiId(t testing.TestingT, testFolder string, amiId string)deprecated
- func SaveArtifactID(t testing.TestingT, testFolder string, artifactID string)
- func SaveEc2KeyPair(t testing.TestingT, testFolder string, keyPair *aws.Ec2Keypair)
- func SaveInt(t testing.TestingT, testFolder string, name string, val int)
- func SaveKubectlOptions(t testing.TestingT, testFolder string, kubectlOptions *k8s.KubectlOptions)
- func SavePackerOptions(t testing.TestingT, testFolder string, packerOptions *packer.Options)
- func SaveString(t testing.TestingT, testFolder string, name string, val string)
- func SaveTerraformOptions(t testing.TestingT, testFolder string, terraformOptions *terraform.Options)
- func SaveTestData(t testing.TestingT, path string, value interface{})
- func SkipStageEnvVarSet() bool
Constants ¶
const SKIP_STAGE_ENV_VAR_PREFIX = "SKIP_"
SKIP_STAGE_ENV_VAR_PREFIX is the prefix used for skipping stage environment variables.
Variables ¶
This section is empty.
Functions ¶
func CleanupTestData ¶
CleanupTestData cleans up the test data at the given path.
func CleanupTestDataFolder ¶ added in v0.20.1
CleanupTestDataFolder cleans up the .test-data folder inside the given folder. If there are any errors, fail the test.
func CleanupTestDataFolderE ¶ added in v0.20.1
CleanupTestDataFolderE cleans up the .test-data folder inside the given folder.
func CopyTerraformFolderToTemp ¶
func CopyTerraformFolderToTemp(t testing.TestingT, rootFolder string, terraformModuleFolder string) string
CopyTerraformFolderToTemp copies the given root folder to a randomly-named temp folder and return the path to the given terraform modules folder within the new temp root folder. This is useful when running multiple tests in parallel against the same set of Terraform files to ensure the tests don't overwrite each other's .terraform working directory and terraform.tfstate files. To ensure relative paths work, we copy over the entire root folder to a temp folder, and then return the path within that temp folder to the given terraform module dir, which is where the actual test will be running. For example, suppose you had the target terraform folder you want to test in "/examples/terraform-aws-example" relative to the repo root. If your tests reside in the "/test" relative to the root, then you will use this as follows:
// Root folder where terraform files should be (relative to the test folder)
rootFolder := ".."
// Relative path to terraform module being tested from the root folder
terraformFolderRelativeToRoot := "examples/terraform-aws-example"
// Copy the terraform folder to a temp folder
tempTestFolder := test_structure.CopyTerraformFolderToTemp(t, rootFolder, terraformFolderRelativeToRoot)
// Make sure to use the temp test folder in the terraform options
terraformOptions := &terraform.Options{
TerraformDir: tempTestFolder,
}
Note that if any of the SKIP_<stage> environment variables is set, we assume this is a test in the local dev where there are no other concurrent tests running and we want to be able to cache test data between test stages, so in that case, we do NOT copy anything to a temp folder, and return the path to the original terraform module folder instead.
func FormatTestDataPath ¶
FormatTestDataPath formats a path to save test data.
func IsTestDataPresent ¶
IsTestDataPresent returns true if a file exists at $path and the test data there is non-empty.
func LoadAmiId
deprecated
func LoadArtifactID ¶ added in v0.10.0
LoadArtifactID loads and unserializes an Artifact ID from the given folder. This allows you to reuse an Artifact that was created during an earlier setup step in later validation and teardown steps.
func LoadEc2KeyPair ¶
func LoadEc2KeyPair(t testing.TestingT, testFolder string) *aws.Ec2Keypair
LoadEc2KeyPair loads and unserializes an Ec2KeyPair from the given folder. This allows you to reuse an Ec2KeyPair that was created during an earlier setup step in later validation and teardown steps.
func LoadInt ¶
LoadInt loads a uniquely named int value from the given folder. This allows you to reuse one or more int values that were created during an earlier setup step in later steps.
func LoadKubectlOptions ¶ added in v0.13.29
func LoadKubectlOptions(t testing.TestingT, testFolder string) *k8s.KubectlOptions
LoadKubectlOptions loads and unserializes a KubectlOptions from the given folder. This allows you to reuse a KubectlOptions that was created during an earlier setup step in later validation and teardown steps.
func LoadPackerOptions ¶
LoadPackerOptions loads and unserializes PackerOptions from the given folder. This allows you to reuse a PackerOptions that was created during an earlier setup step in later validation and teardown steps.
func LoadString ¶
LoadString loads and unserializes a uniquely named string value from the given folder. This allows you to reuse one or more string values that were created during an earlier setup step in later steps.
func LoadTerraformOptions ¶
LoadTerraformOptions loads and unserializes TerraformOptions from the given folder. This allows you to reuse a TerraformOptions that was created during an earlier setup step in later validation and teardown steps.
func LoadTestData ¶
LoadTestData loads and unserializes a value stored at the given path. The value should be a pointer to a struct into which the value will be deserialized. This allows you to reuse some sort of test data (e.g., TerraformOptions) from earlier setup steps in later validation and teardown steps.
func RunTestStage ¶
RunTestStage executes the given test stage (e.g., setup, teardown, validation) if an environment variable of the name `SKIP_<stageName>` (e.g., SKIP_teardown) is not set.
func SaveAmiId
deprecated
func SaveArtifactID ¶ added in v0.10.0
SaveArtifactID serializes and saves an Artifact ID into the given folder. This allows you to build an Artifact during setup and to reuse that Artifact later during validation and teardown.
func SaveEc2KeyPair ¶
func SaveEc2KeyPair(t testing.TestingT, testFolder string, keyPair *aws.Ec2Keypair)
SaveEc2KeyPair serializes and saves an Ec2KeyPair into the given folder. This allows you to create an Ec2KeyPair during setup and to reuse that Ec2KeyPair later during validation and teardown.
func SaveInt ¶
SaveInt saves a uniquely named int value into the given folder. This allows you to create one or more int values during one stage -- each with a unique name -- and to reuse those values during later stages.
func SaveKubectlOptions ¶ added in v0.13.29
func SaveKubectlOptions(t testing.TestingT, testFolder string, kubectlOptions *k8s.KubectlOptions)
SaveKubectlOptions serializes and saves KubectlOptions into the given folder. This allows you to create a KubectlOptions during setup and reuse that KubectlOptions later during validation and teardown.
func SavePackerOptions ¶
SavePackerOptions serializes and saves PackerOptions into the given folder. This allows you to create PackerOptions during setup and to reuse that PackerOptions later during validation and teardown.
func SaveString ¶
SaveString serializes and saves a uniquely named string value into the given folder. This allows you to create one or more string values during one stage -- each with a unique name -- and to reuse those values during later stages.
func SaveTerraformOptions ¶
func SaveTerraformOptions(t testing.TestingT, testFolder string, terraformOptions *terraform.Options)
SaveTerraformOptions serializes and saves TerraformOptions into the given folder. This allows you to create TerraformOptions during setup and to reuse that TerraformOptions later during validation and teardown.
func SaveTestData ¶
SaveTestData serializes and saves a value used at test time to the given path. This allows you to create some sort of test data (e.g., TerraformOptions) during setup and to reuse this data later during validation and teardown.
func SkipStageEnvVarSet ¶
func SkipStageEnvVarSet() bool
SkipStageEnvVarSet returns true if an environment variable is set instructing Terratest to skip a test stage. This can be an easy way to tell if the tests are running in a local dev environment vs a CI server.
Types ¶
This section is empty.
Source Files