azure / terratest-terraform-fluent

Go module for Terraform module testing with fluent assertions

terratest-terraform-fluent

Terratest extension package for testing Terraform code with fluent assertions.

Usage

package test

import (
  "testing"

  "github.com/Azure/terratest-terraform-fluent/check"
  "github.com/Azure/terratest-terraform-fluent/setuptest"
  "github.com/stretchr/testify/assert"
  "github.com/stretchr/testify/require"
)

const (
  moduleDir = "../"
)

func TestSomeTerraform(t *testing.T) {
  // Set up the Terraform test and run terraform init, plan and show,
  // saving the plan output to a struct.
  // The returned struct in tftest contains the temp dir, the plan struct,
  // the terraform options, and the clean up func.
  //
  // The Dirs inputs are the test root directory and the relative path to the test code.
  // (this must be a subdirectory of the test root directory).
  // To test the module in the current directory, use "" for the second input.
  //
  // The WithVars inputs are the Terraform variables to pass to the test.
  // The InitPlanShow input is the testing.T pointer.
  tftest, err := setuptest.Dirs(moduleDir, "").WithVars(nil).InitPlanShow(t)
  require.NoError(t, err)

  // Defer the cleanup, which will delete the temporary directory and provide coherent logging.
  // THIS IS VERY IMPORTANT :)
  defer tftest.Cleanup()

  // Check that the plan contains the expected number of resources.
  check.InPlan(tftest.Plan).NumberOfResourcesEquals(1).ErrorIsNil(t)

  // Check that the plan contains the expected resource, with an attribute called `my_attribute` and
  // a corresponding value of `my_value`.
  check.InPlan(tftest.Plan).That("my_terraform_resource.name").Key("my_attribute").HasValue("my_value").ErrorIsNil(t)

  // Check that the plan contains the expected resource, with an attribute called `my_complex_attribute` and
  // a gjson query in a list called `mylist`, taking the first element, which is an object with a property
  // called `property`, with a value of `my_value`. See: https://github.com/tidwall/gjson/blob/master/SYNTAX.md
  check.InPlan(tftest.Plan).That("my_terraform_resource.name").Key("my_complex_attribute").Query("mylist.0.property").HasValue("my_value").ErrorIsNil(t)

  // Ensure that the terraform apply is idempotent.
  defer tftest.Destroy()
  tftest.ApplyIdempotent().ErrorIsNil(t)

  // Retrieve the value from the plan and check it using an external func.
  val, err := check.InPlan(tftest.Plan).That("my_terraform_resource.name").Key("my_other_attribute").GetValue()
  assert.NoError(t, err)
  assert.NoError(t, myValidationFunc(val))

  // Check that the output contains the expected value.
  tftest.Output("my_output").HasValue("my_output_value").ErrorIsNil(t)
}

terratest-terraform-fluent's Issues

feat(setuptest): init only

Add method to perform init only, e.g.

resp, err := Dirs("testdata/depth1", "").WithVars(nil).Init(t)
resp.Apply()

feat(check): deep value check

Check values within lists/maps/etc.

feat(check): planned outputs

Add wrapper to allow fluent assertions of planned outputs. Currently this is possible using code like this:

terratest-terraform-fluent/setuptest/dir_test.go

Line 27 in d87277c

assert.Equal(t, "testing", tftest.Plan.RawPlan.OutputChanges["test"].After)

But we could implement like this:

check.InPlan(myPlan).Output("myoutput").HasValue("foo").ErrorIsNil(t)