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
** This file was automatically generated by the `cloudposse/build-harness`.
17
20
** 1) Make all changes to `README.yaml`
18
-
** 2) Run `make init` (you only need to do this once)
19
-
** 3) Run`make readme` to rebuild this file.
21
+
** 2) Install [atmos](https://atmos.tools/install/) (you only need to do this once)
22
+
** 3) Run`atmos readme` to rebuild this file.
20
23
**
21
24
** (We maintain HUNDREDS of open source projects. This is how we maintain our sanity.)
22
25
**
@@ -51,6 +54,7 @@ topic ARN is given. This module was largely inspired by
51
54
52
55
## Usage
53
56
57
+
54
58
For a complete example, see [examples/complete](examples/complete).
55
59
56
60
For automated tests of the complete example using [bats](https://github.com/bats-core/bats-core) and [Terratest](https://github.com/gruntwork-io/terratest) (which tests and deploys the example on AWS), see [test](test).
@@ -263,7 +267,8 @@ Check out these related projects.
263
267
> -**Customer Workshops.** Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.
@@ -289,6 +294,38 @@ In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
289
294
290
295
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
291
296
297
+
298
+
## Running Terraform Tests
299
+
300
+
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.
301
+
302
+
All tests are located in the [`test/`](test) folder.
303
+
304
+
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)
309
+
- Install Terraform or OpenTofu
310
+
311
+
To run tests:
312
+
313
+
- Run all tests:
314
+
```sh
315
+
atmos test run
316
+
```
317
+
- Clean up test artifacts:
318
+
```sh
319
+
atmos test clean
320
+
```
321
+
- Explore additional test options:
322
+
```sh
323
+
atmos test --help
324
+
```
325
+
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.
326
+
327
+
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.
328
+
292
329
### 🌎 Slack Community
293
330
294
331
Join our [Open Source Community](https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-lambda-elasticsearch-cleanup&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