rename hyphenated packages: http-helper, dns-helper, test-structure (#1844)

Rebased onto the post-freeze main (v1.0.1 cut). Moves the three dirs, renames package declarations (drops the staticcheck nolint), rewrites import paths, drops redundant aliases, normalizes call sites, updates docs/examples, and renames the eponymous files. First step of the v2 modularization.

Author: james00012

docs/_docs/01_getting-started/packages-overview.md

@@ -25,7 +25,7 @@ Terratest's [modules folder](https://github.com/gruntwork-io/terratest/tree/main
 | **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.                                                                                                                                                                                                                     |
 | **git**            | Functions for working with Git. Examples: get the name of the current Git branch.                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
 | **helm**           | Functions for working with Helm. Examples: Install a Helm chart.                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
-| **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.                                                                                                                        |
+| **httphelper**    | 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.                                                                                                                        |
 | **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.                                                                                                                                              |
 | **logger**         | A replacement for Go's `t.Log` and `t.Logf` that writes the logs to `stdout` immediately, rather than buffering them until the very end of the test. This makes debugging and iterating easier.                                                                                                      |
 | **logger/parser**  | Includes functions for parsing out interleaved go test output and piecing out the individual test logs. Used by the [terratest_log_parser](https://github.com/gruntwork-io/terratest/tree/main/cmd/terratest_log_parser) command.                                                                                                                       |
@@ -37,4 +37,4 @@ Terratest's [modules folder](https://github.com/gruntwork-io/terratest/tree/main
 | **ssh**            | Functions to SSH to servers. Examples: SSH to a server, execute a command, and return `stdout` and `stderr`.                                                                                                                                                                                         |
 | **terraform**      | Functions for working with Terraform. Examples: run `terraform init`, `terraform apply`, `terraform destroy`.                                                                                                                                                                                        |
 | **terragrunt**     | Functions for working with Terragrunt. Examples: run `terragrunt apply --all`, `terragrunt destroy --all`, test stack configurations with dependencies, and work with Terragrunt stacks.                                                                                                      |
-| **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.                                                                                                                     |
+| **teststructure** | 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.                                                                                                                     |

docs/_docs/02_testing-best-practices/iterating-locally-using-test-stages.md

@@ -3,8 +3,8 @@ layout: collection-browser-doc
 title: Iterating locally using test stages
 category: testing-best-practices
 excerpt: >-
-  Learn more about Terratest's `test_structure`.
-tags: ["testing-best-practices", "test_structure"]
+  Learn more about Terratest's `teststructure`.
+tags: ["testing-best-practices", "teststructure"]
 order: 210
 nav_title: Documentation
 nav_title_link: /docs/
@@ -21,7 +21,7 @@ Often, while testing locally, you'll want to re-run some subset of these stages
 might want to repeatedly run the validation step while you work out the kinks. Having to run _all_ of these stages
 each time you change a single line of code can be very slow.
 
-This is where Terratest's `test_structure` package comes in handy: it allows you to explicitly break up your tests into
+This is where Terratest's `teststructure` package comes in handy: it allows you to explicitly break up your tests into
 stages and to be able to disable any one of those stages by setting an environment variable. Check out the
 [terraform_packer_example_test.go](https://github.com/gruntwork-io/terratest/blob/main/test/terraform_packer_example_test.go)
 for working sample code.

docs/_docs/03_migrating-to-v1/overview.md

@@ -61,7 +61,7 @@ warnings over the table when they disagree.
 
 The Context migration is the single largest source of deprecation
 warnings you will see when upgrading. It touches nearly every helper
-package: `terraform`, `helm`, `dns-helper`, `http-helper`, `packer`,
+package: `terraform`, `helm`, `dnshelper`, `httphelper`, `packer`,
 `docker`, `ssh`, `oci`, `k8s`, `aws`, `azure`, `gcp`. The non-`Context`
 variants compile and behave the same as before; they just emit a
 `// Deprecated:` godoc warning.

docs/_docs/04_community/contributing.md

@@ -66,7 +66,7 @@ Here are the guidelines for contributions with external tools:
 These are helper functions for creating, destroying, and validating infrastructure directly via API calls or SDKs.
 Examples:
 
-* `http_helper.HTTPGetWithRetryContext`: make an HTTP request, retrying until you get a certain expected response.
+* `httphelper.HTTPGetWithRetryContext`: make an HTTP request, retrying until you get a certain expected response.
 * `ssh.CheckSSHCommandContext`: SSH to a server and execute a command.
 * `aws.CreateS3BucketContext`: create an S3 bucket.
 * `aws.GetPrivateIpsOfEc2InstancesContext`: use the AWS APIs to fetch IPs of some EC2 instances.

examples/terraform-asg-scp-example/README.md

@@ -50,7 +50,7 @@ aws.FetchFilesFromInstanceContext(t, ctx, awsRegion, sshUserName, keyPair, appSe
 Finally, to put all of this together, in your go test you could do something like:
 
 ```go
-defer test_structure.RunTestStage(t, "grab_logs", func() {
+defer teststructure.RunTestStage(t, "grab_logs", func() {
 	if t.Failed() {
 		takeElkMultiClusterLogSnapshot(t, examplesDir, awsRegion, "ubuntu")
 	}

…ules/dns-helper/dns_local_server_test.go …dules/dnshelper/dns_local_server_test.gomodules/dns-helper/dns_local_server_test.go renamed to modules/dnshelper/dns_local_server_test.go modules/dns-helper/dns_local_server_test.go renamed to modules/dnshelper/dns_local_server_test.go

@@ -1,4 +1,4 @@
-package dns_helper_test //nolint:staticcheck // package name determined by directory
+package dnshelper_test
 
 import (
 	"fmt"
@@ -8,7 +8,7 @@ import (
 	"testing"
 	"time"
 
-	dnshelper "github.com/gruntwork-io/terratest/modules/dns-helper"
+	"github.com/gruntwork-io/terratest/modules/dnshelper"
 	"github.com/miekg/dns"
 )
 

modules/dns-helper/dns_helper.go modules/dnshelper/dnshelper.gomodules/dns-helper/dns_helper.go renamed to modules/dnshelper/dnshelper.go

@@ -1,5 +1,5 @@
-// Package dns_helper contains helpers to interact with the Domain Name System.
-package dns_helper //nolint:staticcheck // package name determined by directory
+// Package dnshelper contains helpers to interact with the Domain Name System.
+package dnshelper
 
 import (
 	"context"

modules/dns-helper/dns_helper_test.go modules/dnshelper/dnshelper_test.gomodules/dns-helper/dns_helper_test.go renamed to modules/dnshelper/dnshelper_test.go

@@ -1,10 +1,10 @@
-package dns_helper_test //nolint:staticcheck // package name determined by directory
+package dnshelper_test
 
 import (
 	"testing"
 	"time"
 
-	dnshelper "github.com/gruntwork-io/terratest/modules/dns-helper"
+	"github.com/gruntwork-io/terratest/modules/dnshelper"
 	"github.com/gruntwork-io/terratest/modules/retry"
 	"github.com/stretchr/testify/require"
 )

modules/dns-helper/errors.go modules/dnshelper/errors.gomodules/dns-helper/errors.go renamed to modules/dnshelper/errors.go

@@ -1,4 +1,4 @@
-package dns_helper //nolint:staticcheck // package name determined by directory
+package dnshelper
 
 import "fmt"
 

modules/docker/stop_test.go

@@ -9,7 +9,7 @@ import (
 	"time"
 
 	"github.com/gruntwork-io/terratest/modules/docker"
-	http_helper "github.com/gruntwork-io/terratest/modules/http-helper"
+	"github.com/gruntwork-io/terratest/modules/httphelper"
 	"github.com/gruntwork-io/terratest/modules/shell"
 	"github.com/stretchr/testify/require"
 )
@@ -40,7 +40,7 @@ func TestStop(t *testing.T) {
 	docker.RunContext(t, ctx, "nginx:1.17-alpine", runOpts)
 
 	// verify nginx is running
-	http_helper.HTTPGetWithRetryWithCustomValidationContext(t, ctx, testURL, &tls.Config{}, 60, 2*time.Second, verifyNginxIsUp)
+	httphelper.HTTPGetWithRetryWithCustomValidationContext(t, ctx, testURL, &tls.Config{}, 60, 2*time.Second, verifyNginxIsUp)
 
 	// try to stop it now
 	out := docker.StopContext(t, ctx, []string{name}, &docker.StopOptions{})