You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
`test-helpers` is a library that adds some missing functionality to [terratest](https://terratest.gruntwork.io).
38
41
39
42
`test-helpers` includes functionality for:
@@ -148,6 +151,10 @@ The [example](examples/) folder contains a full set examples that demonstrate th
148
151
149
152
150
153
154
+
155
+
156
+
157
+
151
158
## β¨ Contributing
152
159
153
160
This project is under active development, and we encourage contributions from our community.
@@ -172,6 +179,38 @@ In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
172
179
173
180
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
174
181
182
+
183
+
## Running Terraform Tests
184
+
185
+
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.
186
+
187
+
All tests are located in the [`test/`](test) folder.
188
+
189
+
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.
- Install Go [1.24+ or newer](https://go.dev/doc/install)
194
+
- Install Terraform or OpenTofu
195
+
196
+
To run tests:
197
+
198
+
- Run all tests:
199
+
```sh
200
+
atmos test run
201
+
```
202
+
- Clean up test artifacts:
203
+
```sh
204
+
atmos test clean
205
+
```
206
+
- Explore additional test options:
207
+
```sh
208
+
atmos test --help
209
+
```
210
+
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.
211
+
212
+
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.
213
+
175
214
### π Slack Community
176
215
177
216
Join our [Open Source Community](https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/test-helpers&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