| commit | f06fcd5dd89c4320788cbab1c456d1cd19e8cee1 | [log] [tgz] |
|---|---|---|
| author | Katy Moe <katy@katy.moe> | Sun Aug 14 12:55:10 2022 +0100 |
| committer | kmoe <5575356+kmoe@users.noreply.github.com> | Thu Aug 18 09:23:03 2022 +0200 |
| tree | edf470e9ad5e2678cbb43220ad2de8cc9aec83ea | |
| parent | 495b9eb3d2cd9daebea6191f5329430ea0a72867 [diff] |
use last stable xcode 12 for mac builds Certain terraform-exec tests run versions of Terraform earlier than 0.12 in order to test compatibility behaviour. Any version of Terraform complied with Go < 1.11 causes errors when run on macOS Monterey 12 or later, which corresponds to Xcode version 13 or later. Please see the following pages for more information: https://github.com/golang/go/wiki/MacOS12BSDThreadRegisterIssue https://xcodereleases.com/ We must therefore use Xcode 12 for these tests. CircleCI supports only the latest stable version, currently v12.5.1. When Xcode 16 is released, CircleCI will drop support for Xcode 12, so we will need to resolve this problem another way.
A Go module for constructing and running Terraform CLI commands. Structured return values use the data types defined in terraform-json.
The Terraform Plugin SDK is the canonical Go interface for Terraform plugins using the gRPC protocol. This library is intended for use in Go programs that make use of Terraform's other interface, the CLI. Importing this library is preferable to importing github.com/hashicorp/terraform/command, because the latter is not intended for use outside Terraform Core.
While terraform-exec is already widely used, please note that this module is not yet at v1.0.0, and that therefore breaking changes may occur in minor releases.
We strictly follow semantic versioning.
This library is built in Go, and uses the support policy of Go as its support policy. The two latest major releases of Go are supported by terraform-exec.
Currently, that means Go 1.17 or later must be used.
The Terraform struct must be initialised with NewTerraform(workingDir, execPath).
Top-level Terraform commands each have their own function, which will return either error or (T, error), where T is a terraform-json type.
package main import ( "context" "fmt" "log" "github.com/hashicorp/go-version" "github.com/hashicorp/hc-install/product" "github.com/hashicorp/hc-install/releases" "github.com/hashicorp/terraform-exec/tfexec" ) func main() { installer := &releases.ExactVersion{ Product: product.Terraform, Version: version.Must(version.NewVersion("1.0.6")), } execPath, err := installer.Install(context.Background()) if err != nil { log.Fatalf("error installing Terraform: %s", err) } workingDir := "/path/to/working/dir" tf, err := tfexec.NewTerraform(workingDir, execPath) if err != nil { log.Fatalf("error running NewTerraform: %s", err) } err = tf.Init(context.Background(), tfexec.Upgrade(true)) if err != nil { log.Fatalf("error running Init: %s", err) } state, err := tf.Show(context.Background()) if err != nil { log.Fatalf("error running Show: %s", err) } fmt.Println(state.FormatVersion) // "0.1" }
The terraform-exec test suite contains end-to-end tests which run realistic workflows against a real Terraform binary using tfexec.Terraform{}.
To run these tests with a local Terraform binary, set the environment variable TFEXEC_E2ETEST_TERRAFORM_PATH to its path and run:
go test -timeout=20m ./tfexec/internal/e2etest
For more information on terraform-exec's test suite, please see Contributing below.
Please see CONTRIBUTING.md.