-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
rename package to test-helpers (#29)
- Loading branch information
Showing
6 changed files
with
50 additions
and
65 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,9 @@ | ||
| <!-- markdownlint-disable --> | ||
|
|
||
| # 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> | ||
|
|
||
| <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> | ||
|
|
||
| <!-- markdownlint-disable --> | ||
| # terratest-helpers <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terratest-helpers&utm_content="><img align="right" src="https://cloudposse.com/logo-300x69.svg" width="150" /></a> | ||
| <a href="https://github.com/cloudposse/terratest-helpers/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/terratest-helpers.svg" alt="Latest Release"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/badge.svg" alt="Slack Community"/></a> | ||
| <!-- markdownlint-restore --> | ||
|
|
||
| <!-- | ||
|
|
@@ -26,39 +27,34 @@ | |
| --> | ||
|
|
||
| `terratest-helpers` is a library that adds some missing functionality to [terratest](https://terratest.gruntwork.io). | ||
|
|
||
|
|
||
|
|
||
| `test-helpers` is a library that adds some missing functionality to [terratest](https://terratest.gruntwork.io). | ||
|
|
||
| ## Introduction | ||
|
|
||
| `test-helpers` is a library that adds some missing functionality to [terratest](https://terratest.gruntwork.io). | ||
|
|
||
| `terratest-helpers` is a library that adds some missing functionality to [terratest](https://terratest.gruntwork.io). | ||
|
|
||
| `terratest-helpers` includes functionality for: | ||
|
|
||
| - Destroying all resources in an AWS account after a test run using [aws-nuke](https://github.com/rebuy-de/aws-nuke) | ||
| - Running tests with [atmos](https://github.com/cloudposse/atmos) stack configs | ||
| `test-helpers` includes functionality for: | ||
|
|
||
| - Destroying all resources in an AWS account after a test run using [aws-nuke](https://github.com/rebuy-de/aws-nuke) | ||
| - Running tests with [atmos](https://github.com/cloudposse/atmos) stack configs | ||
|
|
||
| ## Install | ||
|
|
||
| Install the latest version in your go tests | ||
|
|
||
| ```console | ||
| go install github.com/cloudposse/terratest-helpers | ||
| go install github.com/cloudposse/test-helpers | ||
| ``` | ||
|
|
||
| Get a specific version | ||
|
|
||
| ```console | ||
| go install github.com/cloudposse/terratest[email protected] | ||
| go install github.com/cloudposse/test[email protected] | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| You can use `terratest-helpers` as a library in your own terratest code. | ||
| You can use `test-helpers` as a library in your own terratest code. | ||
|
|
||
| ### atmos | ||
|
|
||
|
|
@@ -114,63 +110,50 @@ func TestAwsNuke(t *testing.T) { | |
| } | ||
| ``` | ||
| ## Examples | ||
| The [example](examples/) folder contains a full set examples that demonstrate the use of `terratest-helpers`: | ||
| The [example](examples/) folder contains a full set examples that demonstrate the use of `test-helpers`: | ||
| - [example](examples/awsnuke-example) folder contains a terraform module that can be used to test the `awsnuke` functionality. | ||
| - [example](examples/awsnuke-example) folder contains a terraform module that can be used to test the `awsnuke` functionality. | ||
| The test for this module is in [pkg/awsnuke/awsnuke_test.go](pkg/awsnuke/awsnuke_test.go). | ||
| ## ✨ Contributing | ||
| This project is under active development, and we encourage contributions from our community. | ||
| Many thanks to our outstanding contributors: | ||
| <a href="https://github.com/cloudposse/terratest-helpers/graphs/contributors"> | ||
| <img src="https://contrib.rocks/image?repo=cloudposse/terratest-helpers&max=24" /> | ||
| <a href="https://github.com/cloudposse/test-helpers/graphs/contributors"> | ||
| <img src="https://contrib.rocks/image?repo=cloudposse/test-helpers&max=24" /> | ||
| </a> | ||
| For 🐛 bug reports & feature requests, please use the [issue tracker](https://github.com/cloudposse/terratest-helpers/issues). | ||
| For 🐛 bug reports & feature requests, please use the [issue tracker](https://github.com/cloudposse/test-helpers/issues). | ||
| In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow. | ||
| 1. Review our [Code of Conduct](https://github.com/cloudposse/terratest-helpers/?tab=coc-ov-file#code-of-conduct) and [Contributor Guidelines](https://github.com/cloudposse/.github/blob/main/CONTRIBUTING.md). | ||
| 2. **Fork** the repo on GitHub | ||
| 3. **Clone** the project to your own machine | ||
| 4. **Commit** changes to your own branch | ||
| 5. **Push** your work back up to your fork | ||
| 6. Submit a **Pull Request** so that we can review your changes | ||
| 1. Review our [Code of Conduct](https://github.com/cloudposse/test-helpers/?tab=coc-ov-file#code-of-conduct) and [Contributor Guidelines](https://github.com/cloudposse/.github/blob/main/CONTRIBUTING.md). | ||
| 2. **Fork** the repo on GitHub | ||
| 3. **Clone** the project to your own machine | ||
| 4. **Commit** changes to your own branch | ||
| 5. **Push** your work back up to your fork | ||
| 6. Submit a **Pull Request** so that we can review your changes | ||
| **NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request! | ||
| ### 🌎 Slack Community | ||
| Join our [Open Source Community](https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terratest-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. | ||
| 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. | ||
| ### 📰 Newsletter | ||
| Sign up for [our newsletter](https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terratest-helpers&utm_content=newsletter) and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. | ||
| Sign up for [our newsletter](https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/test-helpers&utm_content=newsletter) and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. | ||
| Dropped straight into your Inbox every week — and usually a 5-minute read. | ||
| ### 📆 Office Hours <a href="https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terratest-helpers&utm_content=office_hours"><img src="https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png" align="right" /></a> | ||
| ### 📆 Office Hours <a href="https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/test-helpers&utm_content=office_hours"><img src="https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png" align="right" /></a> | ||
| [Join us every Wednesday via Zoom](https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terratest-helpers&utm_content=office_hours) for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a _live Q&A_ that you can’t find anywhere else. | ||
| [Join us every Wednesday via Zoom](https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/test-helpers&utm_content=office_hours) for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a _live Q&A_ that you can’t find anywhere else. | ||
| It's **FREE** for everyone! | ||
| ## License | ||
| <a href="https://opensource.org/licenses/Apache-2.0"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge" alt="License"></a> | ||
|
|
@@ -200,17 +183,17 @@ KIND, either express or implied. See the License for the | |
| specific language governing permissions and limitations | ||
| under the License. | ||
| ``` | ||
| </details> | ||
| ## Trademarks | ||
| All other trademarks referenced herein are the property of their respective owners. | ||
| --- | ||
| Copyright © 2017-2024 [Cloud Posse, LLC](https://cpco.io/copyright) | ||
| Copyright © 2017-2024 [Cloud Posse, LLC](https://cpco.io/copyright) | ||
| <a href="https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terratest-helpers&utm_content=readme_footer_link"><img alt="README footer" src="https://cloudposse.com/readme/footer/img"/></a> | ||
| <a href="https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/test-helpers&utm_content=readme_footer_link"><img alt="README footer" src="https://cloudposse.com/readme/footer/img"/></a> | ||
| <img alt="Beacon" width="0" src="https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/terratest-helpers?pixel&cs=github&cm=readme&an=terratest-helpers"/> | ||
| <img alt="Beacon" width="0" src="https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/test-helpers?pixel&cs=github&cm=readme&an=test-helpers"/> | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,10 @@ | ||
| name: terratest-helpers | ||
| name: test-helpers | ||
| license: APACHE2 | ||
| github_repo: cloudposse/terratest-helpers | ||
| github_repo: cloudposse/test-helpers | ||
| badges: | ||
| - name: Latest Release | ||
| image: https://img.shields.io/github/release/cloudposse/terratest-helpers.svg | ||
| url: https://github.com/cloudposse/terratest-helpers/releases/latest | ||
| image: https://img.shields.io/github/release/cloudposse/test-helpers.svg | ||
| url: https://github.com/cloudposse/test-helpers/releases/latest | ||
| - name: Slack Community | ||
| image: https://slack.cloudposse.com/badge.svg | ||
| url: https://slack.cloudposse.com | ||
|
|
@@ -19,13 +19,13 @@ categories: | |
| - terratest | ||
|
|
||
| description: |- | ||
| `terratest-helpers` is a library that adds some missing functionality to [terratest](https://terratest.gruntwork.io). | ||
| `test-helpers` is a library that adds some missing functionality to [terratest](https://terratest.gruntwork.io). | ||
| introduction: |- | ||
| `terratest-helpers` is a library that adds some missing functionality to [terratest](https://terratest.gruntwork.io). | ||
| `test-helpers` is a library that adds some missing functionality to [terratest](https://terratest.gruntwork.io). | ||
| `terratest-helpers` includes functionality for: | ||
| `test-helpers` includes functionality for: | ||
| - Destroying all resources in an AWS account after a test run using [aws-nuke](https://github.com/rebuy-de/aws-nuke) | ||
| - Running tests with [atmos](https://github.com/cloudposse/atmos) stack configs | ||
|
|
@@ -36,18 +36,18 @@ introduction: |- | |
| Install the latest version in your go tests | ||
| ```console | ||
| go install github.com/cloudposse/terratest-helpers | ||
| go install github.com/cloudposse/test-helpers | ||
| ``` | ||
| Get a specific version | ||
| ```console | ||
| go install github.com/cloudposse/terratest[email protected] | ||
| go install github.com/cloudposse/test[email protected] | ||
| ``` | ||
| ## Usage | ||
| You can use `terratest-helpers` as a library in your own terratest code. | ||
| You can use `test-helpers` as a library in your own terratest code. | ||
| ### atmos | ||
|
|
@@ -106,7 +106,7 @@ introduction: |- | |
| ## Examples | ||
| The [example](examples/) folder contains a full set examples that demonstrate the use of `terratest-helpers`: | ||
| The [example](examples/) folder contains a full set examples that demonstrate the use of `test-helpers`: | ||
| - [example](examples/awsnuke-example) folder contains a terraform module that can be used to test the `awsnuke` functionality. | ||
| The test for this module is in [pkg/awsnuke/awsnuke_test.go](pkg/awsnuke/awsnuke_test.go). | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters