github.com/swisspost/terratest@v0.0.0-20230214120104-7ec6de2e1ae0/examples/terragrunt-example/README.md (about)

     1  # Terragrunt Example
     2  
     3  This folder contains the simplest possible Terragrunt module—one that just passes inputs to terraform-to demonstrate how
     4  you can use Terratest to write automated tests for your Terragrunt code.
     5  
     6  Check out [test/terragrunt_example_test.go](/test/terragrunt_example_test.go) to see how you can
     7  write automated tests for this simple module.
     8  
     9  Note that this module doesn't do anything useful; it's just here to demonstrate the simplest usage pattern for
    10  Terratest.
    11  
    12  
    13  
    14  
    15  ## Running this module manually
    16  
    17  1. Install [Terraform](https://www.terraform.io/) and make sure it's on your `PATH`.
    18  1. Install [Terragrunt](https://terragrunt.gruntwork.io/) and make sure it's on your `PATH`.
    19  1. Run `terragrunt apply`.
    20  1. When you're done, run `terragrunt destroy`.
    21  
    22  
    23  
    24  
    25  ## Running automated tests against this module
    26  
    27  1. Install [Terraform](https://www.terraform.io/) and make sure it's on your `PATH`.
    28  1. Install [Terragrunt](https://terragrunt.gruntwork.io/) and make sure it's on your `PATH`.
    29  1. Install [Golang](https://golang.org/) and make sure this code is checked out into your `GOPATH`.
    30  1. `cd test`
    31  1. `go test -v -run TestTerragruntExample`