|
2 | 2 |
|
3 | 3 | <!-- markdownlint-disable -->
|
4 | 4 | <a href="https://cpco.io/homepage"><img src="https://github.com/cloudposse/terraform-aws-s3-bucket/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-s3-bucket/actions"><img src="https://github.com/cloudposse/terraform-aws-s3-bucket/workflows/test/badge.svg?branch=master" alt="GitHub Action Tests"/></a><a href="https://github.com/cloudposse/terraform-aws-s3-bucket/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/terraform-aws-s3-bucket.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://github.com/cloudposse/terraform-aws-s3-bucket/commits"><img src="https://img.shields.io/github/last-commit/cloudposse/terraform-aws-s3-bucket.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-s3-bucket/actions"><img src="https://github.com/cloudposse/terraform-aws-s3-bucket/workflows/test/badge.svg?branch=master" alt="GitHub Action Tests"/></a><a href="https://github.com/cloudposse/terraform-aws-s3-bucket/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/terraform-aws-s3-bucket.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://github.com/cloudposse/terraform-aws-s3-bucket/commits"><img src="https://img.shields.io/github/last-commit/cloudposse/terraform-aws-s3-bucket.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 | <!--
|
@@ -421,7 +424,36 @@ In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
|
421 | 424 | 5. **Push** your work back up to your fork
|
422 | 425 | 6. Submit a **Pull Request** so that we can review your changes
|
423 | 426 |
|
424 |
| -**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request! |
| 427 | +**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!## Running Terraform Tests |
| 428 | + |
| 429 | +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. |
| 430 | + |
| 431 | +All tests are located in the [`test/`](test) folder. |
| 432 | + |
| 433 | +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. |
| 434 | + |
| 435 | +Setup dependencies: |
| 436 | +- Install Atmos ([installation guide](https://atmos.tools/install/)) |
| 437 | +- Install Go [1.24+ or newer](https://go.dev/doc/install) |
| 438 | +- Install Terraform or OpenTofu |
| 439 | + |
| 440 | +To run tests: |
| 441 | + |
| 442 | +- Run all tests: |
| 443 | + ```sh |
| 444 | + atmos test run |
| 445 | + ``` |
| 446 | +- Clean up test artifacts: |
| 447 | + ```sh |
| 448 | + atmos test clean |
| 449 | + ``` |
| 450 | +- Explore additional test options: |
| 451 | + ```sh |
| 452 | + atmos test --help |
| 453 | + ``` |
| 454 | +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. |
| 455 | + |
| 456 | +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. |
425 | 457 |
|
426 | 458 | ### 🌎 Slack Community
|
427 | 459 |
|
|
0 commit comments