https://github.com/excoriate/tftest
A collection of commonly use functions for terratest 🧪 & terraform 🏗️
https://github.com/excoriate/tftest
Last synced: 11 months ago
JSON representation
A collection of commonly use functions for terratest 🧪 & terraform 🏗️
- Host: GitHub
- URL: https://github.com/excoriate/tftest
- Owner: Excoriate
- License: other
- Created: 2024-03-16T10:14:42.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-31T10:36:02.000Z (about 2 years ago)
- Last Synced: 2024-08-10T10:51:39.065Z (almost 2 years ago)
- Language: Go
- Size: 287 KB
- Stars: 4
- Watchers: 3
- Forks: 2
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
A collection of functions and common patterns to test Terraform code using Go, and Terratest.
---
## Why 🤔
This library wraps Terratest to provide simplified functions for common testing patterns in Terraform modules.
The **problem** that this library aims to solve is to make it so easy to write
([terraform](https://www.terraform.io/)) tests that you don't need to be a profficient Go developer to write them.
## Installation 🛠️
Install it using [Go get](https://golang.org/cmd/go/#hdr-Add_dependencies_to_current_module_and_install_them):
```bash
go get github.com/Excoriate/tftest
```
### Pre-requisites 📋
- [Go](https://golang.org/doc/install) >= 1.18
>**NOTE**: For the tools used in this project, please check the [Makefile](./Makefile), and the [Taskfile](./Taskfile.yml) files. You'll also need [pre-commit](https://pre-commit.com/) installed.
---
## Usage 🚀
### Simple 'Plan' scenario
```go
package simple
import (
"testing"
"github.com/stretchr/testify/assert"
"github.com/excoriate/tftest/pkg/scenario"
)
func TestSimpleOptionsPlanScenario(t *testing.T) {
s, err := scenario.New(t, "../../data/tf-random")
assert.NoErrorf(t, err, "Failed to create scenario: %s", err)
s.Stg.PlanStage(t, s.GetTerraformOptions())
}
```
### Expecting changes on plan time for certain resources
```go
import (
"testing"
"github.com/stretchr/testify/assert"
"github.com/excoriate/tftest/pkg/scenario"
)
func TestSpecificResourcesExpectedChanges(t *testing.T) {
s, err := scenario.New(t, "../../data/tf-random")
assert.NoErrorf(t, err, "Failed to create scenario: %s", err)
s.Stg.PlanWithSpecificResourcesThatWillChange(t, s.GetTerraformOptions(), []string{"random_id.this"})
}
```
### Full lifecycle (init, plan, destroy) scenario
```go
import (
"testing"
"github.com/stretchr/testify/assert"
"github.com/excoriate/tftest/pkg/scenario"
)
func TestLifecycle(t *testing.T) {
s, err := scenario.New(t, "../../data/tf-random")
assert.NoErrorf(t, err, "Failed to create scenario: %s", err)
defer s.Stg.DestroyStage(t, s.GetTerraformOptions())
s.Stg.PlanStageWithAnySortOfChanges(t, s.GetTerraformOptions())
s.Stg.ApplyStage(t, s.GetTerraformOptions())
}
```
### Expecting a variable that should have an expected value on Plan time
```go
import (
"testing"
"github.com/stretchr/testify/assert"
"github.com/excoriate/tftest/pkg/scenario"
)
func TestWithVarOptionsValid(t *testing.T) {
workdir := "../../data/tf-random"
s, err := scenario.NewWithOptions(t, workdir,
scenario.WithVarFiles(workdir, "fixtures/override-random-password.tfvars"))
assert.NoErrorf(t, err, "Failed to create scenario: %s", err)
s.Stg.PlanWithSpecificVariableValueToExpect(t, s.GetTerraformOptions(), "random_length_password", "25")
}
```
More examples will be added in the [examples](./test/examples) folder.
---
## APIs 📚
There are more API(s) available for the following common patterns:
- [x] A strict validation of the **terraform directory** (it validates whether it's an actual terraform module, directory integrity and others).
- [x] A strict validation of `terraform.tfvars` files.
- [x] Cloud Provider API(s). Currently, [AWS](https://aws.amazon.com/) is supported.
## Roadmap 🗓️
- [ ] Add more tests
- [ ] Add a set of pre-defined error messages
>**Note**: This is still work in progress, however, I'll be happy to receive any feedback or contribution. Ensure you've read the [contributing guide](./CONTRIBUTING.md) before doing so.
## Contributing
Please read our [contributing guide](./CONTRIBUTING.md).