github.com/terraform-modules-krish/terratest@v0.29.0/examples/terraform-remote-exec-example/README.md (about)

     1  # Terraform remote-exec example
     2  
     3  This folder contains a simple Terraform module that deploys resources in [AWS](https://aws.amazon.com/) to demonstrate
     4  how you can use Terratest to test modules which use `remote-exec`, `files`, and other ssh-based 
     5  [provisioners](https://www.terraform.io/docs/provisioners/index.html).
     6  
     7  Check out [test/terraform_remote_exec_example_test.go](https://github.com/terraform-modules-krish/terratest/blob/v0.29.0/test/terraform_remote_exec_example_test.go) to see how you can write
     8  automated tests for this module.
     9  
    10  **WARNING**: This module and the automated tests for it deploy real resources into your AWS account which can cost you
    11  money. The resources are all part of the [AWS Free Tier](https://aws.amazon.com/free/), so if you haven't used that up,
    12  it should be free, but you are completely responsible for all AWS charges.
    13  
    14  ## Running this module manually
    15  
    16  1. Sign up for [AWS](https://aws.amazon.com/).
    17  1. Configure your AWS credentials using one of the [supported methods for AWS CLI
    18     tools](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html), such as setting the
    19     `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables. If you're using the `~/.aws/config` file for profiles then export `AWS_SDK_LOAD_CONFIG` as "True".
    20  1. Install [Terraform](https://www.terraform.io/) and make sure it's on your `PATH`.
    21  1. Run `terraform init`.
    22  1. Run `terraform apply`.
    23  1. When you're done, run `terraform destroy`.
    24  
    25  ## Running automated tests against this module
    26  
    27  1. Sign up for [AWS](https://aws.amazon.com/).
    28  1. Configure your AWS credentials using one of the [supported methods for AWS CLI
    29     tools](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html), such as setting the
    30     `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables. If you're using the `~/.aws/config` file for profiles then export `AWS_SDK_LOAD_CONFIG` as "True".
    31  1. Install [Terraform](https://www.terraform.io/) and make sure it's on your `PATH`.
    32  1. Install [Golang](https://golang.org/) and make sure this code is checked out into your `GOPATH`.
    33  1. `cd test`
    34  1. `dep ensure`
    35  1. `go test -v -run TestTerraformRemoteExecExample`