Skip to content

Commit 0caa7ac

Browse files
committed
chore: update README.md
1 parent 45d0c9e commit 0caa7ac

File tree

1 file changed

+35
-3
lines changed

1 file changed

+35
-3
lines changed

README.md

Lines changed: 35 additions & 3 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-rds/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-rds/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/terraform-aws-rds.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://github.com/cloudposse/terraform-aws-rds/commits"><img src="https://img.shields.io/github/last-commit/cloudposse/terraform-aws-rds.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-rds/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/terraform-aws-rds.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://github.com/cloudposse/terraform-aws-rds/commits"><img src="https://img.shields.io/github/last-commit/cloudposse/terraform-aws-rds.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
<!--
@@ -372,7 +375,36 @@ In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
372375
5. **Push** your work back up to your fork
373376
6. Submit a **Pull Request** so that we can review your changes
374377

375-
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
378+
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!## Running Terraform Tests
379+
380+
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.
381+
382+
All tests are located in the [`test/`](test) folder.
383+
384+
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.
385+
386+
Setup dependencies:
387+
- Install Atmos ([installation guide](https://atmos.tools/install/))
388+
- Install Go [1.24+ or newer](https://go.dev/doc/install)
389+
- Install Terraform or OpenTofu
390+
391+
To run tests:
392+
393+
- Run all tests:
394+
```sh
395+
atmos test run
396+
```
397+
- Clean up test artifacts:
398+
```sh
399+
atmos test clean
400+
```
401+
- Explore additional test options:
402+
```sh
403+
atmos test --help
404+
```
405+
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.
406+
407+
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.
376408

377409
### 🌎 Slack Community
378410

0 commit comments

Comments
 (0)