Skip to content

Commit

Permalink
[skip ci] Incorporate review feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
bwhaley committed May 10, 2024
1 parent c3c9e79 commit 8e30199
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ NAT Gateways are dead. Long live NAT instances!

Built and released with 💚 by <a href="https://chime.com"><img src="/assets/Chime_company_logo.png" alt="Chime Engineering" width="146"/></a>

[![GitHub Actions](https://github.com/1debit/alternat/workflows/Test/badge.svg)](https://github.com/1debit/alternat/actions)
[![GitHub Actions](https://github.com/chime/terraform-aws-alternat/workflows/Test/badge.svg)](https://github.com/chime/terraform-aws-alternat/actions)


## Background
Expand Down Expand Up @@ -264,6 +264,12 @@ alterNAT is intended to be a safe, welcoming space for collaboration. Contributo

## Local Testing

### Terraform module testing

The `test/` directory uses the [Terratest](https://terratest.gruntwork.io/) library to run integration tests on the Terraform module. The test uses the example located in `examples/` to set up Alternat, runs validations, then destroys the resources. Unfortunately, because of how the [Lambda Hyperplane ENI](https://docs.aws.amazon.com/lambda/latest/dg/foundation-networking.html#foundation-nw-eni) deletion process works, this takes a very long time (about 35 minutes) to run.

### Lambda function testing

To test locally, install the AWS SAM CLI client:

```
Expand Down
3 changes: 3 additions & 0 deletions test/alternat_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ import (
)

func TestAlternat(t *testing.T) {
// Uncomment any of the following lines to skip that part of the test.
// This is useful for iterating during test development.
// See https://terratest.gruntwork.io/docs/testing-best-practices/iterating-locally-using-test-stages/
// os.Setenv("SKIP_setup", "true")
// os.Setenv("SKIP_apply_vpc", "true")
// os.Setenv("SKIP_apply_alternat_basic", "true")
Expand Down

0 comments on commit 8e30199

Please sign in to comment.