Skip to content
This repository was archived by the owner on May 20, 2025. It is now read-only.

Commit 9617023

Browse files
raksivdavemooreuws
andauthored
Apply suggestions from code review
Co-authored-by: David Moore <[email protected]>
1 parent 8623f61 commit 9617023

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

src/nav.config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -587,7 +587,7 @@ const fullNav: FullNav = {
587587
href: '/guides/terraform/api-gateway-throttle',
588588
},
589589
{
590-
title: 'Testing AWS resources with Terratest',
590+
title: 'Terratest for Testing AWS Resources',
591591
href: '/guides/terraform/terratest',
592592
},
593593
],

src/pages/guides/terraform/terratest.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,30 +3,30 @@ export const description =
33

44
# Testing AWS resources with Terratest
55

6-
This guide will walk you through adding Terratest to a Nitric project.
6+
This guide will walk you through adding [Terratest](https://terratest.gruntwork.io/) to a Nitric project.
77

88
## How Terratest works
99

1010
Terratest is designed to automate the entire process of testing your Terraform code with the following steps:
1111

12-
- Initialize: Terratest will automatically run terraform init to initialize the Terraform working directory.
13-
- Apply: It will then run terraform apply to deploy the infrastructure as defined in your Terraform code.
14-
- Assert: The test script will then run assertions to check that the infrastructure was created as expected.
15-
- Teardown: Finally, it will run terraform destroy to tear down the infrastructure after the test completes.
12+
- **Initialize**: Terratest will automatically run terraform init to initialize the Terraform working directory.
13+
- **Apply**: It will then run terraform apply to deploy the infrastructure as defined in your Terraform code.
14+
- **Assert**: The test script will then run assertions to check that the infrastructure was created as expected.
15+
- **Teardown**: Finally, it will run terraform destroy to tear down the infrastructure after the test completes.
1616

1717
## What we'll be doing
1818

1919
1. Create and set up your application.
2020
2. Deploying to AWS with a Terraform provider.
21-
3. Add and execute Terratest
21+
3. Add and execute Terratest.
2222

2323
## Create and set up your application.
2424

25-
Our sample project creates a real-time communication service using websockets and a key-value store for connections.
25+
Our sample project creates a real-time communication service using [websockets](/docs/websockets) and a [key-value store](/docs/keyvalue) for connections.
2626

2727
We intend to deploy to AWS and will use Terratest to ensure that the following:
2828

29-
- **API Gateway WebSocket**: Confirm that the webSocket endpoint is correctly configured for real-time communication.
29+
- **API Gateway WebSocket**: Confirm that the websocket endpoint is correctly configured for real-time communication.
3030
- **DynamoDB Table**: Verify that the key-value store for connections is created and operational.
3131
- **IAM Roles**: Ensure that permissions for interacting with AWS services are correctly set up.
3232

@@ -142,7 +142,7 @@ provider: nitric/[email protected]
142142
region: us-east-2
143143
```
144144
145-
The Nitric Terraform providers are currently in preview, to enable them you'll need to enable beta-providers in your Nitric project. You can do this by adding the following to your project's nitric.yaml file:
145+
The Nitric Terraform providers are currently in preview, to enable them you'll need to enable beta-providers in your Nitric project. You can do this by adding the following to your project's `nitric.yaml` file:
146146

147147
```
148148
preview:
@@ -155,7 +155,7 @@ Once you've created your Nitric stack, you can generate the Terraform code by ru
155155
nitric up
156156
```
157157
158-
This will generate the Terraform code for your Nitric application into a folder named cdktf.out by default.
158+
This will generate the Terraform code for your Nitric application into a folder named `cdktf.out` by default.
159159
160160
## Add and execute Terratest
161161

0 commit comments

Comments
 (0)