Merge branch 'main' into helm-install-generate-name

Author: james00012

README.md

@@ -37,6 +37,10 @@ only happen in major releases (e.g. v2.0.0).
 Symbols renamed or replaced in v1 are kept with `// Deprecated:` annotations pointing at the new name; removals happen
 in v2. Migrating from v0.x: see the [v1 migration guide](https://terratest.gruntwork.io/docs/migrating-to-v1/overview/).
 
+**v1 maintenance.** With v2 in development, the v1 line has entered maintenance: it receives security fixes only,
+delivered on the `v1` branch, until 12 months after v2.0.0 reaches general availability. v2 ships under new `/v2`
+module paths, so pinned v1 consumers are unaffected. Upgrade on your own schedule.
+
 ## More info
 
 - [Terratest Website](https://terratest.gruntwork.io)

docs/Gemfile.lock

@@ -37,11 +37,11 @@ GEM
       ffi (>= 1.3.0)
     eventmachine (1.2.7)
     execjs (2.7.0)
-    faraday (2.14.2)
+    faraday (2.14.3)
       faraday-net_http (>= 2.0, < 3.5)
       json
       logger
-    faraday-net_http (3.4.2)
+    faraday-net_http (3.4.4)
       net-http (~> 0.5)
     ffi (1.13.1)
     forwardable-extended (2.6.0)
@@ -213,7 +213,7 @@ GEM
       gemoji (~> 3.0)
       html-pipeline (~> 2.2)
       jekyll (>= 3.0, < 5.0)
-    json (2.19.5)
+    json (2.20.0)
     kramdown (2.3.2)
       rexml
     kramdown-parser-gfm (1.1.0)

docs/v2-import-map.md

@@ -0,0 +1,80 @@
+# Terratest v2 Import Map
+
+Status: FROZEN. The one open decision (renames) is resolved: the three hyphenated packages are renamed to idiomatic Go names at the `/v2` boundary.
+
+Built from the actual v1 layout at tag `v1.0.1-test` (27 `modules/` packages, 2 `cmd/` binaries, 1 `internal/lib` tree).
+
+Module base path: `github.com/gruntwork-io/terratest`
+
+## Transformation rule
+
+For any surviving import path, the rewrite is a prefix replacement that also applies to every subpackage:
+
+- `modules/<name>/...` -> `modules/<name>/v2/...` (the `/v2` SIV goes after the module root; directory layout unchanged except for the three renames below)
+- The six tier-0 utilities collapse under one module: `modules/<util>/...` -> `modules/core/v2/<util>/...`
+- Three packages are also renamed to drop the hyphen: `http-helper` -> `httphelper`, `dns-helper` -> `dnshelper`, `test-structure` -> `teststructure`. The package identifier loses its underscore too (`http_helper` -> `httphelper`), so call sites change, not just the import path. The codemod handles both.
+
+So e.g. `modules/logger/parser` -> `modules/core/v2/logger/parser`, `modules/aws/foo` -> `modules/aws/v2/foo`, and `modules/http-helper` -> `modules/httphelper/v2`.
+
+## core collapse (6 v1 packages -> one `modules/core/v2`)
+
+| v1 import path | v2 import path |
+|---|---|
+| `modules/logger` | `modules/core/v2/logger` |
+| `modules/testing` | `modules/core/v2/testing` |
+| `modules/retry` | `modules/core/v2/retry` |
+| `modules/random` | `modules/core/v2/random` |
+| `modules/files` | `modules/core/v2/files` |
+| `modules/shell` | `modules/core/v2/shell` |
+
+## Standalone `/v2` submodules
+
+| v1 import path | v2 import path |
+|---|---|
+| `modules/aws` | `modules/aws/v2` |
+| `modules/azure` | `modules/azure/v2` |
+| `modules/gcp` | `modules/gcp/v2` |
+| `modules/k8s` | `modules/k8s/v2` |
+| `modules/helm` | `modules/helm/v2` |
+| `modules/ssh` | `modules/ssh/v2` |
+| `modules/docker` | `modules/docker/v2` |
+| `modules/packer` | `modules/packer/v2` |
+| `modules/database` | `modules/database/v2` |
+| `modules/opa` | `modules/opa/v2` |
+| `modules/terraform` | `modules/terraform/v2` |
+| `modules/terragrunt` | `modules/terragrunt/v2` |
+| `modules/http-helper` | `modules/httphelper/v2` |
+| `modules/dns-helper` | `modules/dnshelper/v2` |
+| `modules/test-structure` | `modules/teststructure/v2` |
+
+## Removed in v2.0.0 (deprecated in v1 first, deleted at cutover)
+
+| v1 import path | replacement |
+|---|---|
+| `modules/collections` | stdlib `slices` |
+| `modules/environment` | stdlib `os.Getenv` |
+| `modules/git` | stdlib `os/exec` |
+| `modules/slack` | none, vendor from frozen v1 if needed |
+| `modules/version-checker` | none, shell out |
+| `modules/oci` | none, Oracle Cloud support not carried forward; remains in frozen v1, vendor if needed |
+| `cmd/pick-instance-type` | none, standalone binary, out of scope |
+| `cmd/terratest_log_parser` | none, standalone binary (its `logger/parser` lib survives under `modules/core/v2/logger/parser`) |
+
+## Internal flatten (non-importable, not consumer-facing)
+
+| v1 | v2 |
+|---|---|
+| `internal/lib/formatting` | `internal/formatting` |
+
+## Accounting
+
+27 `modules/` packages = 6 collapsed into core + 15 standalone submodules + 6 removed. Plus 2 removed `cmd/` binaries and 1 internal flatten. Submodule count: 16.
+
+## Open decisions
+
+None. The map is frozen.
+
+## Resolved
+
+- **`oci`** (Oracle Cloud Infrastructure): not carried forward to v2. Niche provider; removed alongside the other dropped packages. Oracle Cloud users stay on frozen v1.
+- **Renames.** Decided to rename the three hyphenated packages at the v2 boundary: `http-helper` -> `httphelper`, `dns-helper` -> `dnshelper`, `test-structure` -> `teststructure`. Consumers already rewrite every import for the `/v2` bump, so folding the rename into that same edit adds no separate migration, and it drops the non-idiomatic underscore package names (`http_helper`, currently suppressed with `//nolint:staticcheck`). The rename rides along with the modularization import rewrite, and the codemod covers both the path and the package identifier.

internal/collections/collections.go

@@ -0,0 +1,43 @@
+// Package collections holds small generic slice helpers shared across
+// Terratest's own packages. It is internal and not part of the public API; the
+// public modules/collections package is deprecated and scheduled for removal in
+// v2.
+package collections
+
+// Intersection returns the items present in both lists, de-duplicated, in the
+// order they appear in list1.
+func Intersection[T comparable](list1 []T, list2 []T) []T {
+	lookups := make(map[T]struct{}, len(list2))
+	for _, item := range list2 {
+		lookups[item] = struct{}{}
+	}
+
+	out := make([]T, 0, min(len(list1), len(list2)))
+
+	for _, item := range list1 {
+		if _, found := lookups[item]; found {
+			out = append(out, item)
+			delete(lookups, item) // delete so a repeated list1 item isn't emitted twice
+		}
+	}
+
+	return out
+}
+
+// Subtract returns the items in list1 that are not in list2.
+func Subtract[T comparable](list1 []T, list2 []T) []T {
+	lookups := make(map[T]struct{}, len(list2))
+	for _, item := range list2 {
+		lookups[item] = struct{}{}
+	}
+
+	out := make([]T, 0, len(list1))
+
+	for _, item := range list1 {
+		if _, found := lookups[item]; !found {
+			out = append(out, item)
+		}
+	}
+
+	return out
+}

internal/collections/collections_test.go

@@ -0,0 +1,74 @@
+package collections_test
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/gruntwork-io/terratest/internal/collections"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestIntersection(t *testing.T) {
+	t.Parallel()
+
+	tests := []struct {
+		name  string
+		list1 []string
+		list2 []string
+		want  []string
+	}{
+		{"common items, ordered by list1", []string{"a", "b", "c"}, []string{"b", "c", "d"}, []string{"b", "c"}},
+		{"dedups output", []string{"a", "a"}, []string{"a"}, []string{"a"}},
+		{"dedups duplicates in list2", []string{"a"}, []string{"a", "a"}, []string{"a"}},
+		{"no overlap returns empty, not nil", []string{"a"}, []string{"b"}, []string{}},
+		{"nil inputs return empty, not nil", nil, nil, []string{}},
+	}
+
+	for _, tc := range tests {
+		t.Run(tc.name, func(t *testing.T) {
+			t.Parallel()
+			assert.Equal(t, tc.want, collections.Intersection(tc.list1, tc.list2))
+		})
+	}
+}
+
+func TestSubtract(t *testing.T) {
+	t.Parallel()
+
+	tests := []struct {
+		name  string
+		list1 []string
+		list2 []string
+		want  []string
+	}{
+		{"removes list2 items", []string{"a", "b", "c"}, []string{"b", "c"}, []string{"a"}},
+		{"everything removed returns empty, not nil", []string{"a", "b"}, []string{"a", "b"}, []string{}},
+		{"nil list1 returns empty, not nil", nil, []string{"a"}, []string{}},
+		{"nil list2 keeps list1", []string{"a", "b"}, nil, []string{"a", "b"}},
+	}
+
+	for _, tc := range tests {
+		t.Run(tc.name, func(t *testing.T) {
+			t.Parallel()
+			assert.Equal(t, tc.want, collections.Subtract(tc.list1, tc.list2))
+		})
+	}
+}
+
+func TestSubtractDoesNotMutateInput(t *testing.T) {
+	t.Parallel()
+
+	in := []string{"a", "b"}
+	collections.Subtract(in, []string{"a"})
+	assert.Equal(t, []string{"a", "b"}, in, "does not mutate the input slice")
+}
+
+func ExampleIntersection() {
+	fmt.Println(collections.Intersection([]int{1, 2, 3}, []int{2, 3, 4}))
+	// Output: [2 3]
+}
+
+func ExampleSubtract() {
+	fmt.Println(collections.Subtract([]int{1, 2, 3}, []int{2, 3}))
+	// Output: [1]
+}

modules/aws/region.go

@@ -8,7 +8,7 @@ import (
 	"github.com/aws/aws-sdk-go-v2/aws"
 	"github.com/aws/aws-sdk-go-v2/service/ec2"
 	"github.com/aws/aws-sdk-go-v2/service/ssm"
-	"github.com/gruntwork-io/terratest/modules/collections"
+	"github.com/gruntwork-io/terratest/internal/collections"
 	"github.com/gruntwork-io/terratest/modules/logger"
 	"github.com/gruntwork-io/terratest/modules/random"
 	"github.com/gruntwork-io/terratest/modules/testing"
@@ -53,11 +53,11 @@ func GetRandomStableRegionContextE(t testing.TestingT, ctx context.Context, appr
 	regionsToPickFrom := stableRegions
 
 	if len(approvedRegions) > 0 {
-		regionsToPickFrom = collections.ListIntersection(regionsToPickFrom, approvedRegions)
+		regionsToPickFrom = collections.Intersection(regionsToPickFrom, approvedRegions)
 	}
 
 	if len(forbiddenRegions) > 0 {
-		regionsToPickFrom = collections.ListSubtract(regionsToPickFrom, forbiddenRegions)
+		regionsToPickFrom = collections.Subtract(regionsToPickFrom, forbiddenRegions)
 	}
 
 	return GetRandomRegionContextE(t, ctx, regionsToPickFrom, nil)
@@ -122,7 +122,7 @@ func GetRandomRegionContextE(t testing.TestingT, ctx context.Context, approvedRe
 		regionsToPickFrom = allRegions
 	}
 
-	regionsToPickFrom = collections.ListSubtract(regionsToPickFrom, forbiddenRegions)
+	regionsToPickFrom = collections.Subtract(regionsToPickFrom, forbiddenRegions)
 	region := random.RandomString(regionsToPickFrom)
 
 	logger.Default.Logf(t, "Using region %s", region)

modules/azure/errors.go

@@ -72,6 +72,21 @@ func (e *UnknownEnvironmentError) Error() string {
 		e.EnvironmentName)
 }
 
+// ResourceIDNameNotFoundError is returned when a name cannot be resolved from an Azure resource ID.
+// The offending ID is exported so callers can inspect it via errors.As.
+type ResourceIDNameNotFoundError struct {
+	ResourceID string
+}
+
+func (err ResourceIDNameNotFoundError) Error() string {
+	return fmt.Sprintf("could not resolve name from resource ID %q", err.ResourceID)
+}
+
+// NewResourceIDNameNotFoundError creates a ResourceIDNameNotFoundError for the given resource ID.
+func NewResourceIDNameNotFoundError(resourceID string) ResourceIDNameNotFoundError {
+	return ResourceIDNameNotFoundError{ResourceID: resourceID}
+}
+
 // ResourceNotFoundErrorExists checks the Service Error Code for the 'Resource Not Found' error.
 func ResourceNotFoundErrorExists(err error) bool {
 	if err == nil {

modules/azure/region.go

@@ -3,7 +3,7 @@ package azure
 import (
 	"context"
 
-	"github.com/gruntwork-io/terratest/modules/collections"
+	"github.com/gruntwork-io/terratest/internal/collections"
 	"github.com/gruntwork-io/terratest/modules/random"
 	"github.com/gruntwork-io/terratest/modules/testing"
 	"github.com/stretchr/testify/require"
@@ -72,11 +72,11 @@ func GetRandomStableRegionContext(t testing.TestingT, ctx context.Context, appro
 	regionsToPickFrom := stableRegions
 
 	if len(approvedRegions) > 0 {
-		regionsToPickFrom = collections.ListIntersection(regionsToPickFrom, approvedRegions)
+		regionsToPickFrom = collections.Intersection(regionsToPickFrom, approvedRegions)
 	}
 
 	if len(forbiddenRegions) > 0 {
-		regionsToPickFrom = collections.ListSubtract(regionsToPickFrom, forbiddenRegions)
+		regionsToPickFrom = collections.Subtract(regionsToPickFrom, forbiddenRegions)
 	}
 
 	return GetRandomRegionContext(t, ctx, regionsToPickFrom, nil, subscriptionID) //nolint:staticcheck
@@ -145,7 +145,7 @@ func GetRandomRegionContextE(t testing.TestingT, ctx context.Context, approvedRe
 		regionsToPickFrom = allRegions
 	}
 
-	regionsToPickFrom = collections.ListSubtract(regionsToPickFrom, forbiddenRegions)
+	regionsToPickFrom = collections.Subtract(regionsToPickFrom, forbiddenRegions)
 	region := random.RandomString(regionsToPickFrom)
 
 	return region, nil

modules/azure/resourceid.go

@@ -1,6 +1,8 @@
 package azure
 
-import "github.com/gruntwork-io/terratest/modules/collections"
+import (
+	"strings"
+)
 
 // GetNameFromResourceID gets the Name from an Azure Resource ID.
 func GetNameFromResourceID(resourceID string) string {
@@ -15,10 +17,10 @@ func GetNameFromResourceID(resourceID string) string {
 // GetNameFromResourceIDE gets the Name from an Azure Resource ID.
 // This function would fail the test if there is an error.
 func GetNameFromResourceIDE(resourceID string) (string, error) {
-	id, err := collections.GetSliceLastValueE(resourceID, "/")
-	if err != nil {
-		return "", err
+	i := strings.LastIndex(resourceID, "/")
+	if i == -1 || i == len(resourceID)-1 {
+		return "", NewResourceIDNameNotFoundError(resourceID)
 	}
 
-	return id, nil
+	return resourceID[i+1:], nil
 }