Migrate internal callers off deprecated function wrappers

Rewrite every in-repo call site (production, tests, examples) from the
deprecated non-context wrappers to their Context variants, inserting
context.Background() to preserve behavior. The deprecated wrappers are left
in place so this change is behavior-preserving and builds green on its own;
the wrappers themselves are removed in a follow-up.

Done with an AST codemod that derives each transform from the wrapper body,
so argument mapping (including pointer and variadic forms) is exact.

Author: james00012

modules/aws/account.go

@@ -74,7 +74,8 @@ func GetAccountId(t testing.TestingT) string {
 //
 //nolint:staticcheck,revive // preserving deprecated function name
 func GetAccountIdE(t testing.TestingT) (string, error) {
-	return GetAccountIDE(t)
+	return GetAccountIDContextE(t, context.Background())
+
 }
 
 // ExtractAccountIDFromARN extracts the AWS account ID from an IAM ARN.

modules/aws/ami.go

@@ -226,7 +226,9 @@ func GetMostRecentAmiId(t testing.TestingT, region string, ownerId string, filte
 //
 //nolint:staticcheck,revive // preserving deprecated function name
 func GetMostRecentAmiIdE(t testing.TestingT, region string, ownerId string, filters map[string][]string) (string, error) {
-	return GetMostRecentAmiIDE(t, region, ownerId, filters)
+	return GetMostRecentAmiIDContextE(t, context.Background(),
+
+		region, ownerId, filters)
 }
 
 // Image sorting code borrowed from: https://github.com/hashicorp/packer/blob/7f4112ba229309cfc0ebaa10ded2abdfaf1b22c8/builder/amazon/common/step_source_ami_info.go

modules/aws/ec2-files.go

@@ -286,7 +286,7 @@ func FetchFilesFromInstanceContextE(t testing.TestingT, ctx context.Context, aws
 	}
 
 	//nolint:staticcheck,contextcheck // ScpDirFromE has no Context variant yet
-	return ssh.ScpDirFromE(t, scpOptions, useSudo)
+	return ssh.SCPDirFromContextE(t, context.Background(), &scpOptions, useSudo)
 }
 
 // FetchFilesFromInstanceContext looks up the EC2 Instances in the given ASG, looks up the public IPs of those EC2

modules/aws/ec2.go

@@ -22,7 +22,7 @@ func GetPrivateIPOfEc2InstanceContextE(t testing.TestingT, ctx context.Context,
 	ip, containsIP := ips[instanceID]
 
 	if !containsIP {
-		return "", IpForEc2InstanceNotFound{InstanceId: instanceID, AwsRegion: awsRegion, Type: "private"}
+		return "", IPForEc2InstanceNotFound{InstanceId: instanceID, AwsRegion: awsRegion, Type: "private"}
 	}
 
 	return ip, nil
@@ -71,7 +71,9 @@ func GetPrivateIpOfEc2Instance(t testing.TestingT, instanceID string, awsRegion
 //
 //nolint:staticcheck,revive // preserving deprecated function name
 func GetPrivateIpOfEc2InstanceE(t testing.TestingT, instanceID string, awsRegion string) (string, error) {
-	return GetPrivateIPOfEc2InstanceE(t, instanceID, awsRegion)
+	return GetPrivateIPOfEc2InstanceContextE(t, context.Background(),
+
+		instanceID, awsRegion)
 }
 
 // GetPrivateIpsOfEc2InstancesContextE gets the private IP address of the given EC2 Instance in the given region. Returns a map of instance ID to IP address.
@@ -196,7 +198,7 @@ func GetPublicIPOfEc2InstanceContextE(t testing.TestingT, ctx context.Context, i
 	ip, containsIP := ips[instanceID]
 
 	if !containsIP {
-		return "", IpForEc2InstanceNotFound{InstanceId: instanceID, AwsRegion: awsRegion, Type: "public"}
+		return "", IPForEc2InstanceNotFound{InstanceId: instanceID, AwsRegion: awsRegion, Type: "public"}
 	}
 
 	return ip, nil
@@ -245,7 +247,9 @@ func GetPublicIpOfEc2Instance(t testing.TestingT, instanceID string, awsRegion s
 //
 //nolint:staticcheck,revive // preserving deprecated function name
 func GetPublicIpOfEc2InstanceE(t testing.TestingT, instanceID string, awsRegion string) (string, error) {
-	return GetPublicIPOfEc2InstanceE(t, instanceID, awsRegion)
+	return GetPublicIPOfEc2InstanceContextE(t, context.Background(),
+
+		instanceID, awsRegion)
 }
 
 // GetPublicIpsOfEc2InstancesContextE gets the public IP address of the given EC2 Instance in the given region. Returns a map of instance ID to IP address.

modules/aws/ec2_test.go

@@ -1,6 +1,7 @@
 package aws_test
 
 import (
+	"context"
 	"strings"
 	"testing"
 
@@ -17,7 +18,23 @@ func TestGetEc2InstanceIdsByTag(t *testing.T) {
 	t.Parallel()
 
 	region := aws.GetRandomStableRegion(t, nil, nil)
-	ids, err := aws.GetEc2InstanceIdsByTagE(t, region, "Name", "nonexistent-"+random.UniqueID())
+	ids, err := aws.GetEc2InstanceIdsByTagContextE(t,
+
+		// The following is necessary to make sure testCase's values don't get updated due to concurrency within the
+		// scope of t.Run(..) below. https://golang.org/doc/faq#closures_and_goroutines
+
+		// We could hard-code the expected result (e.g., as of July 2020, we expect eu-west-1 to return t2.micro
+		// and ap-northeast-2 to return t3.micro), but the result will likely change over time, so to avoid a
+		// brittle test, we simply check that we get _one_ result. Combined with the unit test below, this hopefully
+		// is enough to be confident this function works correctly.
+
+		// The following is necessary to make sure testCase's values don't get updated due to concurrency within the
+		// scope of t.Run(..) below. https://golang.org/doc/faq#closures_and_goroutines
+
+		// The following is necessary to make sure testCase's values don't
+		// get updated due to concurrency within the scope of t.Run(..) below
+
+		context.Background(), region, "Name", "nonexistent-"+random.UniqueID())
 	require.NoError(t, err)
 	assert.Empty(t, ids)
 }
@@ -31,7 +48,9 @@ func TestGetEc2InstanceIdsByFilters(t *testing.T) {
 		"tag:Name":            {"nonexistent-" + random.UniqueID()},
 	}
 
-	ids, err := aws.GetEc2InstanceIdsByFiltersE(t, region, filters)
+	ids, err := aws.GetEc2InstanceIdsByFiltersContextE(t,
+
+		context.Background(), region, filters)
 	require.NoError(t, err)
 	assert.Empty(t, ids)
 }
@@ -49,17 +68,13 @@ func TestGetRecommendedInstanceType(t *testing.T) {
 	}
 
 	for _, testCase := range testCases {
-		// The following is necessary to make sure testCase's values don't get updated due to concurrency within the
-		// scope of t.Run(..) below. https://golang.org/doc/faq#closures_and_goroutines
+
 		testCase := testCase
 
 		t.Run(testCase.region+"-"+strings.Join(testCase.instanceTypeOptions, "-"), func(t *testing.T) {
 			t.Parallel()
 			instanceType := aws.GetRecommendedInstanceType(t, testCase.region, testCase.instanceTypeOptions)
-			// We could hard-code the expected result (e.g., as of July 2020, we expect eu-west-1 to return t2.micro
-			// and ap-northeast-2 to return t3.micro), but the result will likely change over time, so to avoid a
-			// brittle test, we simply check that we get _one_ result. Combined with the unit test below, this hopefully
-			// is enough to be confident this function works correctly.
+
 			assert.Contains(t, testCase.instanceTypeOptions, instanceType)
 		})
 	}
@@ -120,8 +135,7 @@ func TestPickRecommendedInstanceTypeHappyPath(t *testing.T) {
 	}
 
 	for _, testCase := range testCases {
-		// The following is necessary to make sure testCase's values don't get updated due to concurrency within the
-		// scope of t.Run(..) below. https://golang.org/doc/faq#closures_and_goroutines
+
 		testCase := testCase
 
 		t.Run(testCase.name, func(t *testing.T) {
@@ -176,8 +190,7 @@ func TestPickRecommendedInstanceTypeErrors(t *testing.T) {
 	}
 
 	for _, testCase := range testCases {
-		// The following is necessary to make sure testCase's values don't
-		// get updated due to concurrency within the scope of t.Run(..) below
+
 		testCase := testCase
 		t.Run(testCase.name, func(t *testing.T) {
 			t.Parallel()

modules/aws/ecr_test.go

@@ -1,6 +1,7 @@
 package aws_test
 
 import (
+	"context"
 	"strings"
 	"testing"
 
@@ -18,14 +19,18 @@ func TestEcrRepo(t *testing.T) {
 	region := aws.GetRandomStableRegion(t, nil, nil)
 	ecrRepoName := "terratest" + strings.ToLower(random.UniqueID())
 
-	repo1, err := aws.CreateECRRepoE(t, region, ecrRepoName)
+	repo1, err := aws.CreateECRRepoContextE(t,
+
+		context.Background(), region, ecrRepoName)
 	defer aws.DeleteECRRepo(t, region, repo1)
 
 	require.NoError(t, err)
 
 	assert.Equal(t, ecrRepoName, awsSDK.ToString(repo1.RepositoryName))
 
-	repo2, err := aws.GetECRRepoE(t, region, ecrRepoName)
+	repo2, err := aws.GetECRRepoContextE(t,
+
+		context.Background(), region, ecrRepoName)
 	require.NoError(t, err)
 	assert.Equal(t, ecrRepoName, awsSDK.ToString(repo2.RepositoryName))
 }
@@ -36,14 +41,18 @@ func TestGetEcrRepoLifecyclePolicyError(t *testing.T) {
 	region := aws.GetRandomStableRegion(t, nil, nil)
 	ecrRepoName := "terratest" + strings.ToLower(random.UniqueID())
 
-	repo1, err := aws.CreateECRRepoE(t, region, ecrRepoName)
+	repo1, err := aws.CreateECRRepoContextE(t,
+
+		context.Background(), region, ecrRepoName)
 	defer aws.DeleteECRRepo(t, region, repo1)
 
 	require.NoError(t, err)
 
 	assert.Equal(t, ecrRepoName, awsSDK.ToString(repo1.RepositoryName))
 
-	_, err = aws.GetECRRepoLifecyclePolicyE(t, region, repo1)
+	_, err = aws.GetECRRepoLifecyclePolicyContextE(t,
+
+		context.Background(), region, repo1)
 	require.Error(t, err)
 }
 
@@ -53,7 +62,8 @@ func TestCanSetECRRepoLifecyclePolicyWithSingleRule(t *testing.T) {
 	region := aws.GetRandomStableRegion(t, nil, nil)
 	ecrRepoName := "terratest" + strings.ToLower(random.UniqueID())
 
-	repo1, err := aws.CreateECRRepoE(t, region, ecrRepoName)
+	repo1, err := aws.CreateECRRepoContextE(t,
+		context.Background(), region, ecrRepoName)
 	defer aws.DeleteECRRepo(t, region, repo1)
 
 	require.NoError(t, err)
@@ -76,7 +86,9 @@ func TestCanSetECRRepoLifecyclePolicyWithSingleRule(t *testing.T) {
 		]
 	}`
 
-	err = aws.PutECRRepoLifecyclePolicyE(t, region, repo1, lifecyclePolicy)
+	err = aws.PutECRRepoLifecyclePolicyContextE(t,
+
+		context.Background(), region, repo1, lifecyclePolicy)
 	require.NoError(t, err)
 
 	policy := aws.GetECRRepoLifecyclePolicy(t, region, repo1)
@@ -89,7 +101,9 @@ func TestCanSetRepositoryPolicyWithSimplePolicy(t *testing.T) {
 	region := aws.GetRandomStableRegion(t, nil, nil)
 	ecrRepoName := "terratest" + strings.ToLower(random.UniqueID())
 
-	repo, err := aws.CreateECRRepoE(t, region, ecrRepoName)
+	repo, err := aws.CreateECRRepoContextE(t, context.Background(),
+
+		region, ecrRepoName)
 	defer aws.DeleteECRRepo(t, region, repo)
 
 	require.NoError(t, err)
@@ -109,7 +123,9 @@ func TestCanSetRepositoryPolicyWithSimplePolicy(t *testing.T) {
 		]
 	}`
 
-	err = aws.PutECRRepoPolicyE(t, region, repo, repositoryPolicy)
+	err = aws.PutECRRepoPolicyContextE(t,
+
+		context.Background(), region, repo, repositoryPolicy)
 	require.NoError(t, err)
 
 	policy := aws.GetECRRepoPolicy(t, region, repo)

modules/aws/ecs_test.go

@@ -19,13 +19,17 @@ func TestEcsCluster(t *testing.T) {
 
 	region := aws.GetRandomStableRegion(t, nil, nil)
 
-	c1, err := aws.CreateEcsClusterE(t, region, "terratest")
+	c1, err := aws.CreateEcsClusterContextE(t,
+
+		context.Background(), region, "terratest")
 	defer aws.DeleteEcsCluster(t, region, c1)
 
 	require.NoError(t, err)
 	assert.Equal(t, "terratest", *c1.ClusterName)
 
-	c2, err := aws.GetEcsClusterE(t, region, *c1.ClusterName)
+	c2, err := aws.GetEcsClusterContextE(t,
+
+		context.Background(), region, *c1.ClusterName)
 
 	require.NoError(t, err)
 	assert.Equal(t, "terratest", *c2.ClusterName)
@@ -52,14 +56,18 @@ func TestEcsClusterWithInclude(t *testing.T) {
 
 	assert.Equal(t, clusterName, awsSDK.ToString(c1.Cluster.ClusterName))
 
-	c2, err := aws.GetEcsClusterWithIncludeE(t, region, clusterName, []types.ClusterField{types.ClusterFieldTags})
+	c2, err := aws.GetEcsClusterWithIncludeContextE(t,
+
+		context.Background(), region, clusterName, []types.ClusterField{types.ClusterFieldTags})
 	require.NoError(t, err)
 
 	assert.Equal(t, clusterName, awsSDK.ToString(c2.ClusterName))
 	assert.Equal(t, tags, c2.Tags)
 	assert.Empty(t, c2.Statistics)
 
-	c3, err := aws.GetEcsClusterWithIncludeE(t, region, clusterName, []types.ClusterField{types.ClusterFieldStatistics})
+	c3, err := aws.GetEcsClusterWithIncludeContextE(t,
+
+		context.Background(), region, clusterName, []types.ClusterField{types.ClusterFieldStatistics})
 	require.NoError(t, err)
 
 	assert.Equal(t, clusterName, awsSDK.ToString(c3.ClusterName))

modules/aws/iam_test.go

@@ -35,7 +35,9 @@ func TestGetIAMPolicyDocument(t *testing.T) {
 	t.Run("Exists", func(t *testing.T) {
 		t.Parallel()
 
-		iamClient, err := aws.NewIamClientE(t, region)
+		iamClient, err := aws.NewIamClientContextE(t,
+
+			context.Background(), region)
 		require.NoError(t, err)
 
 		policyDocument := `{
@@ -74,7 +76,9 @@ func TestGetIAMPolicyDocument(t *testing.T) {
 	t.Run("DoesNotExist", func(t *testing.T) {
 		t.Parallel()
 
-		_, err := aws.GetIamPolicyDocumentE(t, region, "arn:aws:iam::1234567890:policy/does-not-exist")
+		_, err := aws.GetIamPolicyDocumentContextE(t,
+
+			context.Background(), region, "arn:aws:iam::1234567890:policy/does-not-exist")
 		require.Error(t, err)
 	})
 }

modules/aws/rds_test.go

@@ -1,6 +1,7 @@
 package aws_test
 
 import (
+	"context"
 	"testing"
 
 	aws "github.com/gruntwork-io/terratest/modules/aws/v2"
@@ -61,7 +62,9 @@ func TestGetRecommendedRdsInstanceTypeHappyPath(t *testing.T) {
 		t.Run(scenerio.name, func(t *testing.T) {
 			t.Parallel()
 			engineVersion := aws.GetValidEngineVersion(t, scenerio.region, scenerio.databaseEngine, scenerio.engineMajorVersion)
-			actual, err := aws.GetRecommendedRdsInstanceTypeE(t, scenerio.region, scenerio.databaseEngine, engineVersion, scenerio.instanceTypes)
+			actual, err := aws.GetRecommendedRdsInstanceTypeContextE(t,
+
+				context.Background(), scenerio.region, scenerio.databaseEngine, engineVersion, scenerio.instanceTypes)
 			require.NoError(t, err)
 			assert.Equal(t, scenerio.expected, actual)
 		})
@@ -144,7 +147,9 @@ func TestGetRecommendedRdsInstanceTypeErrors(t *testing.T) {
 		t.Run(scenerio.name, func(t *testing.T) {
 			t.Parallel()
 
-			_, err := aws.GetRecommendedRdsInstanceTypeE(t, scenerio.region, scenerio.databaseEngine, scenerio.databaseEngineVersion, scenerio.instanceTypes)
+			_, err := aws.GetRecommendedRdsInstanceTypeContextE(t,
+
+				context.Background(), scenerio.region, scenerio.databaseEngine, scenerio.databaseEngineVersion, scenerio.instanceTypes)
 			assert.EqualError(t, err, aws.NoRdsInstanceTypeError{InstanceTypeOptions: scenerio.instanceTypes, DatabaseEngine: scenerio.databaseEngine, DatabaseEngineVersion: scenerio.databaseEngineVersion}.Error())
 		})
 	}

modules/aws/region_test.go

@@ -1,6 +1,7 @@
 package aws_test
 
 import (
+	"context"
 	"testing"
 
 	aws "github.com/gruntwork-io/terratest/modules/aws/v2"
@@ -64,7 +65,9 @@ func TestGetRandomRegionForService(t *testing.T) {
 
 	serviceName := "apigatewayv2"
 
-	regionsForService, _ := aws.GetRegionsForServiceE(t, serviceName)
+	regionsForService, _ := aws.GetRegionsForServiceContextE(t,
+
+		context.Background(), serviceName)
 	randomRegionForService := aws.GetRandomRegionForService(t, serviceName)
 
 	assert.Contains(t, regionsForService, randomRegionForService)