Skip to content

Commit 478f6ee

Browse files
authored
Added atmos readme (#74)
1 parent 708f1ba commit 478f6ee

File tree

6 files changed

+54
-48
lines changed

6 files changed

+54
-48
lines changed

β€Ž.gitignoreβ€Ž

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010

1111
**/.build-harness
1212
**/build-harness
13+
.atmos
1314

1415
**/.terraform.lock.hcl
1516

β€ŽMakefileβ€Ž

Lines changed: 0 additions & 34 deletions
This file was deleted.

β€ŽREADME.mdβ€Ž

Lines changed: 41 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,11 @@
22

33
<!-- markdownlint-disable -->
44
# test-helpers <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/test-helpers&utm_content="><img align="right" src="https://cloudposse.com/logo-300x69.svg" width="150" /></a>
5-
<a href="https://github.com/cloudposse/test-helpers/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/test-helpers.svg" alt="Latest Release"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/badge.svg" alt="Slack Community"/></a>
5+
6+
7+
<a href="https://github.com/cloudposse/test-helpers/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/test-helpers.svg" alt="Latest Release"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/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+
610
<!-- markdownlint-restore -->
711

812
<!--
@@ -33,7 +37,6 @@
3337

3438
## Introduction
3539

36-
3740
`test-helpers` is a library that adds some missing functionality to [terratest](https://terratest.gruntwork.io).
3841

3942
`test-helpers` includes functionality for:
@@ -148,6 +151,10 @@ The [example](examples/) folder contains a full set examples that demonstrate th
148151
149152
150153
154+
155+
156+
157+
151158
## ✨ Contributing
152159
153160
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.
172179
173180
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
174181
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.
190+
191+
Setup dependencies:
192+
- Install Atmos ([installation guide](https://atmos.tools/install/))
193+
- 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+
175214
### 🌎 Slack Community
176215
177216
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.

β€Žatmos.yamlβ€Ž

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Atmos Configuration β€” powered by https://atmos.tools
2+
#
3+
# This configuration enables centralized, DRY, and consistent project scaffolding using Atmos.
4+
#
5+
# Included features:
6+
# - Organizational custom commands: https://atmos.tools/core-concepts/custom-commands
7+
# - Automated README generation: https://atmos.tools/cli/commands/docs/generate
8+
#
9+
10+
# Import shared configuration used by all modules
11+
import:
12+
- https://raw.githubusercontent.com/cloudposse/.github/refs/heads/main/.github/atmos/default.yaml

β€Ždocs/.gitkeepβ€Ž

Whitespace-only changes.

β€Ždocs/targets.mdβ€Ž

Lines changed: 0 additions & 12 deletions
This file was deleted.

0 commit comments

Comments
Β (0)