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
Copy file name to clipboardExpand all lines: docs/_docs/01_getting-started/packages-overview.md
+7-11Lines changed: 7 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,29 +3,27 @@ layout: collection-browser-doc
3
3
title: Package by package overview
4
4
category: getting-started
5
5
excerpt: >-
6
-
Learn more about Terratest modules and how they can help you test different types of infrastructure.
6
+
Learn more about Terratest modules and how they can help you test different types infrastructure.
7
7
tags: ["packages"]
8
-
order: 104
8
+
order: 103
9
9
nav_title: Documentation
10
10
nav_title_link: /docs/
11
11
---
12
12
13
13
Now that you've had a chance to browse the examples and their tests, here's an overview of the packages you'll find in
14
-
Terratest's [modules folder](https://github.com/gruntwork-io/terratest/tree/main/modules) and how they can help you test different types of infrastructure:
15
-
16
-
Some packages are **deprecated** and scheduled for removal in v2 because they fall outside [what Terratest is for]({{ site.baseurl }}/docs/getting-started/what-terratest-is-for/) (for example, helpers the Go standard library already covers). They keep working for the rest of v1; their GoDoc points at the recommended replacement.
14
+
Terratest's [modules folder](https://github.com/gruntwork-io/terratest/tree/main/modules) and how they can help you test different types infrastructure:
|**aws**| Functions that make it easier to work with the AWS APIs. Examples: find an EC2 Instance by tag, get the IPs of EC2 Instances in an ASG, create an EC2 KeyPair, look up a VPC ID. |
22
20
|**azure**| Functions that make it easier to work with the Azure APIs. Examples: get the size of a virtual machine, get the tags of a virtual machine. |
23
-
|**collections**|_Deprecated (removed in v2): use the standard library `slices`/`strings`._ A few helper methods for working with lists. Examples: subtract two lists from each other.|
21
+
|**collections**|Go doesn't have much of a collections library built-in, so this package has a few helper methods for working with lists and maps. Examples: subtract two lists from each other. |
24
22
|**docker**| Functions that make it easier to work with Docker and Docker Compose. Examples: run `docker compose` commands. |
25
-
|**environment**|_Deprecated (removed in v2): use the standard library `os.Getenv`._Functions for interacting with os environment. Examples: check for first non empty environment variable in a list. |
23
+
|**environment**| Functions for interacting with os environment. Examples: check for first non empty environment variable in a list.|
26
24
|**files**| Functions for manipulating files and folders. Examples: check if a file exists, copy a folder and all of its contents. |
27
25
|**gcp**| Functions that make it easier to work with the GCP APIs. Examples: Add labels to a Compute Instance, get the Public IPs of an Instance, Get a list of Instances in a Managed Instance Group, Work with Storage Buckets and Objects. |
28
-
|**git**|_Deprecated (removed in v2): shell out to `git` with `os/exec`._Functions for working with Git. Examples: get the name of the current Git branch. |
26
+
|**git**| Functions for working with Git. Examples: get the name of the current Git branch. |
29
27
|**helm**| Functions for working with Helm. Examples: Install a Helm chart. |
30
28
|**http-helper**| Functions for making HTTP requests. Examples: make an HTTP request to a URL and check the status code and body contain the expected values, run a simple HTTP server locally. |
31
29
|**k8s**| Functions that make it easier to work with Kubernetes. Examples: Getting the list of nodes in a cluster, waiting until all nodes in a cluster is ready. |
@@ -36,9 +34,7 @@ Some packages are **deprecated** and scheduled for removal in v2 because they fa
36
34
|**random**| Functions for generating random data. Examples: generate a unique ID that can be used to namespace resources so multiple tests running in parallel don't clash. |
37
35
|**retry**| Functions for retrying actions. Examples: retry a function up to a maximum number of retries, retry a function until a stop function is called, wait up to a certain timeout for a function to complete. These are especially useful when working with distributed systems and eventual consistency. |
38
36
|**shell**| Functions to run shell commands. Examples: run a shell command and return its `stdout` and `stderr`. |
39
-
|**slack**|_Deprecated (removed in v2): use the slack-go client directly._ Functions for validating Slack messages posted during a test. |
40
37
|**ssh**| Functions to SSH to servers. Examples: SSH to a server, execute a command, and return `stdout` and `stderr`. |
41
-
|**terraform**| Functions for working with OpenTofu and Terraform. Examples: run `init`, `apply`, and `destroy`. |
38
+
|**terraform**| Functions for working with Terraform. Examples: run `terraform init`, `terraform apply`, `terraform destroy`. |
42
39
|**terragrunt**| Functions for working with Terragrunt. Examples: run `terragrunt apply --all`, `terragrunt destroy --all`, test stack configurations with dependencies, and work with Terragrunt stacks. |
43
40
|**test_structure**| Functions for structuring your tests to speed up local iteration. Examples: break up your tests into stages so that any stage can be skipped by setting an environment variable. |
44
-
|**version-checker**|_Deprecated (removed in v2): shell out to check a binary's version yourself._ Functions for checking a binary's version against a constraint. |
0 commit comments