Skip to content

Commit 7041a52

Browse files
committed
chore: update README.md
1 parent 92353fc commit 7041a52

File tree

1 file changed

+39
-4
lines changed

1 file changed

+39
-4
lines changed

README.md

Lines changed: 39 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,11 @@
22

33
<!-- markdownlint-disable -->
44
<a href="https://cpco.io/homepage"><img src="https://github.com/cloudposse/terraform-aws-elasticsearch/blob/main/.github/banner.png?raw=true" alt="Project Banner"/></a><br/>
5-
<p align="right">
6-
<a href="https://github.com/cloudposse/terraform-aws-elasticsearch/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/terraform-aws-elasticsearch.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://github.com/cloudposse/terraform-aws-elasticsearch/commits"><img src="https://img.shields.io/github/last-commit/cloudposse/terraform-aws-elasticsearch.svg?style=for-the-badge" alt="Last Updated"/></a><a href="https://cloudposse.com/slack"><img src="https://slack.cloudposse.com/for-the-badge.svg" alt="Slack Community"/></a></p>
5+
6+
7+
<p align="right"><a href="https://github.com/cloudposse/terraform-aws-elasticsearch/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/terraform-aws-elasticsearch.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://github.com/cloudposse/terraform-aws-elasticsearch/commits"><img src="https://img.shields.io/github/last-commit/cloudposse/terraform-aws-elasticsearch.svg?style=for-the-badge" alt="Last Updated"/></a><a href="https://cloudposse.com/slack"><img src="https://slack.cloudposse.com/for-the-badge.svg" alt="Slack Community"/></a><a href="https://cloudposse.com/support/"><img src="https://img.shields.io/badge/Get_Support-success.svg?style=for-the-badge" alt="Get Support"/></a>
8+
9+
</p>
710
<!-- markdownlint-restore -->
811

912
<!--
@@ -116,13 +119,13 @@ Here are automated tests for the complete example using [bats](https://github.co
116119
| Name | Version |
117120
|------|---------|
118121
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3 |
119-
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 3.35.0 |
122+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 5.0 |
120123

121124
## Providers
122125

123126
| Name | Version |
124127
|------|---------|
125-
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 3.35.0 |
128+
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 5.0 |
126129

127130
## Modules
128131

@@ -346,6 +349,38 @@ In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
346349

347350
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
348351

352+
353+
## Running Terraform Tests
354+
355+
We use [Atmos](https://atmos.tools) to streamline how Terraform tests are run. It centralizes configuration and wraps common test workflows with easy-to-use commands.
356+
357+
All tests are located in the [`test/`](test) folder.
358+
359+
Under the hood, tests are powered by Terratest together with our internal [Test Helpers](https://github.com/cloudposse/test-helpers) library, providing robust infrastructure validation.
360+
361+
Setup dependencies:
362+
- Install Atmos ([installation guide](https://atmos.tools/install/))
363+
- Install Go [1.24+ or newer](https://go.dev/doc/install)
364+
- Install Terraform or OpenTofu
365+
366+
To run tests:
367+
368+
- Run all tests:
369+
```sh
370+
atmos test run
371+
```
372+
- Clean up test artifacts:
373+
```sh
374+
atmos test clean
375+
```
376+
- Explore additional test options:
377+
```sh
378+
atmos test --help
379+
```
380+
The configuration for test commands is centrally managed. To review what's being imported, see the [`atmos.yaml`](https://raw.githubusercontent.com/cloudposse/.github/refs/heads/main/.github/atmos/terraform-module.yaml) file.
381+
382+
Learn more about our [automated testing in our documentation](https://docs.cloudposse.com/community/contribute/automated-testing/) or implementing [custom commands](https://atmos.tools/core-concepts/custom-commands/) with atmos.
383+
349384
### 🌎 Slack Community
350385

351386
Join our [Open Source Community](https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-elasticsearch&utm_content=slack) on Slack. It's **FREE** for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally *sweet* infrastructure.

0 commit comments

Comments
 (0)