|
2 | 2 |
|
3 | 3 | <!-- markdownlint-disable --> |
4 | 4 | <a href="https://cpco.io/homepage"><img src="https://github.com/cloudposse/terraform-aws-documentdb-cluster/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-documentdb-cluster/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/terraform-aws-documentdb-cluster.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://github.com/cloudposse/terraform-aws-documentdb-cluster/commits"><img src="https://img.shields.io/github/last-commit/cloudposse/terraform-aws-documentdb-cluster.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-documentdb-cluster/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/terraform-aws-documentdb-cluster.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://github.com/cloudposse/terraform-aws-documentdb-cluster/commits"><img src="https://img.shields.io/github/last-commit/cloudposse/terraform-aws-documentdb-cluster.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> |
7 | 10 | <!-- markdownlint-restore --> |
8 | 11 |
|
9 | 12 | <!-- |
@@ -297,7 +300,36 @@ In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow. |
297 | 300 | 5. **Push** your work back up to your fork |
298 | 301 | 6. Submit a **Pull Request** so that we can review your changes |
299 | 302 |
|
300 | | -**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request! |
| 303 | +**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!## Running Terraform Tests |
| 304 | + |
| 305 | +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. |
| 306 | + |
| 307 | +All tests are located in the [`test/`](test) folder. |
| 308 | + |
| 309 | +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. |
| 310 | + |
| 311 | +Setup dependencies: |
| 312 | +- Install Atmos ([installation guide](https://atmos.tools/install/)) |
| 313 | +- Install Go [1.24+ or newer](https://go.dev/doc/install) |
| 314 | +- Install Terraform or OpenTofu |
| 315 | + |
| 316 | +To run tests: |
| 317 | + |
| 318 | +- Run all tests: |
| 319 | + ```sh |
| 320 | + atmos test run |
| 321 | + ``` |
| 322 | +- Clean up test artifacts: |
| 323 | + ```sh |
| 324 | + atmos test clean |
| 325 | + ``` |
| 326 | +- Explore additional test options: |
| 327 | + ```sh |
| 328 | + atmos test --help |
| 329 | + ``` |
| 330 | +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. |
| 331 | + |
| 332 | +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. |
301 | 333 |
|
302 | 334 | ### 🌎 Slack Community |
303 | 335 |
|
|
0 commit comments