github.com/darmach/terratest@v0.34.8-0.20210517103231-80931f95e3ff/examples/terraform-aws-example/README.md (about)

     1  # Terraform AWS 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 write automated tests for your AWS Terraform code. This module deploys an [EC2
     5  Instance](https://aws.amazon.com/ec2/) and gives that Instance a `Name` tag with the value specified in the
     6  `instance_name` variable.
     7  
     8  Check out [test/terraform_aws_example_test.go](/test/terraform_aws_example_test.go) to see how you can write
     9  automated tests for this module.
    10  
    11  Note that the EC2 Instance in this module doesn't actually do anything; it just runs a Vanilla Ubuntu 16.04 AMI for
    12  demonstration purposes. For slightly more complicated, real-world examples of Terraform modules, see
    13  [terraform-http-example](/examples/terraform-http-example) and [terraform-ssh-example](/examples/terraform-ssh-example).
    14  
    15  **WARNING**: This module and the automated tests for it deploy real resources into your AWS account which can cost you
    16  money. The resources are all part of the [AWS Free Tier](https://aws.amazon.com/free/), so if you haven't used that up,
    17  it should be free, but you are completely responsible for all AWS charges.
    18  
    19  
    20  
    21  
    22  
    23  ## Running this module manually
    24  
    25  1. Sign up for [AWS](https://aws.amazon.com/).
    26  1. Configure your AWS credentials using one of the [supported methods for AWS CLI
    27     tools](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html), such as setting the
    28     `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".
    29  1. Set the AWS region you want to use as the environment variable `AWS_DEFAULT_REGION`.
    30  1. Install [Terraform](https://www.terraform.io/) and make sure it's on your `PATH`.
    31  1. Run `terraform init`.
    32  1. Run `terraform apply`.
    33  1. When you're done, run `terraform destroy`.
    34  
    35  
    36  
    37  
    38  ## Running automated tests against this module
    39  
    40  1. Sign up for [AWS](https://aws.amazon.com/).
    41  1. Configure your AWS credentials using one of the [supported methods for AWS CLI
    42     tools](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html), such as setting the
    43     `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".
    44  1. Install [Terraform](https://www.terraform.io/) and make sure it's on your `PATH`.
    45  1. Install [Golang](https://golang.org/) and make sure this code is checked out into your `GOPATH`.
    46  1. `cd test`
    47  1. `dep ensure`
    48  1. `go test -v -run TestTerraformAwsExample`