From d824f463d483238d95d2b70c55ef68b272b9d516 Mon Sep 17 00:00:00 2001 From: kmoe <5575356+kmoe@users.noreply.github.com> Date: Wed, 18 May 2022 16:08:57 +0100 Subject: [PATCH] add custom binary test instructions --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 22940bd7..10052a70 100644 --- a/README.md +++ b/README.md @@ -71,6 +71,17 @@ func main() { } ``` +## Testing Terraform binaries + +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: +```sh +go test -timeout=20m ./tfexec/internal/e2etest +``` + +For more information on terraform-exec's test suite, please see Contributing below. + ## Contributing Please see [CONTRIBUTING.md](./CONTRIBUTING.md).