Merge pull request #1758 from gruntwork-io/deprecation-api

chore: marked as deprecated functions which have context variant

Author: denis256

modules/aws/account.go

@@ -95,6 +95,15 @@ func NewStsClientContext(t testing.TestingT, ctx context.Context, region string)
 	return client
 }
 
+// NewStsClient creates a new STS client.
+//
+// Deprecated: Use [NewStsClientContext] instead.
+func NewStsClient(t testing.TestingT, region string) *sts.Client {
+	t.Helper()
+
+	return NewStsClientContext(t, context.Background(), region)
+}
+
 // NewStsClientE creates a new STS client.
 //
 // Deprecated: Use [NewStsClientContextE] instead.

modules/aws/asg.go

@@ -144,8 +144,9 @@ func WaitForCapacityContextE(
 	maxRetries int,
 	sleepBetweenRetries time.Duration,
 ) error {
-	msg, err := retry.DoWithRetryE(
+	msg, err := retry.DoWithRetryContextE(
 		t,
+		ctx,
 		fmt.Sprintf("Waiting for ASG %s to reach desired capacity.", asgName),
 		maxRetries,
 		sleepBetweenRetries,

modules/aws/ec2-syslog.go

@@ -36,11 +36,7 @@ func GetSyslogForInstanceContextE(t testing.TestingT, ctx context.Context, insta
 		InstanceId: aws.String(instanceID),
 	}
 
-	syslogB64, err := retry.DoWithRetryE(t, description, maxRetries, syslogRetryInterval, func() (string, error) {
-		if ctx.Err() != nil {
-			return "", ctx.Err()
-		}
-
+	syslogB64, err := retry.DoWithRetryContextE(t, ctx, description, maxRetries, syslogRetryInterval, func() (string, error) {
 		out, err := client.GetConsoleOutput(ctx, &input)
 		if err != nil {
 			return "", err

modules/aws/ec2.go

@@ -647,6 +647,25 @@ func GetLaunchPermissionsForAmiContextE(t testing.TestingT, ctx context.Context,
 	return output.LaunchPermissions, nil
 }
 
+// GetLaunchPermissionsForAmiContext returns launchPermissions as configured in AWS.
+// This function will fail the test if there is an error.
+// The ctx parameter supports cancellation and timeouts.
+func GetLaunchPermissionsForAmiContext(t testing.TestingT, ctx context.Context, awsRegion string, amiID string) []types.LaunchPermission {
+	t.Helper()
+	output, err := GetLaunchPermissionsForAmiContextE(t, ctx, awsRegion, amiID)
+	require.NoError(t, err)
+
+	return output
+}
+
+// GetLaunchPermissionsForAmi returns launchPermissions as configured in AWS.
+//
+// Deprecated: Use [GetLaunchPermissionsForAmiContext] instead.
+func GetLaunchPermissionsForAmi(t testing.TestingT, awsRegion string, amiID string) []types.LaunchPermission {
+	t.Helper()
+	return GetLaunchPermissionsForAmiContext(t, context.Background(), awsRegion, amiID)
+}
+
 // GetLaunchPermissionsForAmiE returns launchPermissions as configured in AWS
 //
 // Deprecated: Use [GetLaunchPermissionsForAmiContextE] instead.
@@ -734,6 +753,38 @@ func GetRecommendedInstanceTypeWithClientContextE(t testing.TestingT, ctx contex
 	return PickRecommendedInstanceTypeE(availabilityZones, instanceTypeOfferings, instanceTypeOptions)
 }
 
+// GetRecommendedInstanceTypeWithClientContext takes in a list of EC2 instance types (e.g., "t2.micro", "t3.micro") and returns the
+// first instance type in the list that is available in all Availability Zones (AZs) in the given region. If there's no
+// instance available in all AZs, this function exits with an error. This is useful because certain instance types,
+// such as t2.micro, are not available in some of the newer AZs, while t3.micro is not available in some of the older
+// AZs. If you have code that needs to run on a "small" instance across all AZs in many different regions, you can
+// use this function to automatically figure out which instance type you should use.
+// This function expects an authenticated EC2 client from the AWS SDK Go library.
+// This function will fail the test if there is an error.
+// The ctx parameter supports cancellation and timeouts.
+func GetRecommendedInstanceTypeWithClientContext(t testing.TestingT, ctx context.Context, ec2Client *ec2.Client, instanceTypeOptions []string) string {
+	t.Helper()
+	out, err := GetRecommendedInstanceTypeWithClientContextE(t, ctx, ec2Client, instanceTypeOptions)
+	require.NoError(t, err)
+
+	return out
+}
+
+// GetRecommendedInstanceTypeWithClient takes in a list of EC2 instance types (e.g., "t2.micro", "t3.micro") and returns the
+// first instance type in the list that is available in all Availability Zones (AZs) in the given region. If there's no
+// instance available in all AZs, this function exits with an error. This is useful because certain instance types,
+// such as t2.micro, are not available in some of the newer AZs, while t3.micro is not available in some of the older
+// AZs. If you have code that needs to run on a "small" instance across all AZs in many different regions, you can
+// use this function to automatically figure out which instance type you should use.
+// This function expects an authenticated EC2 client from the AWS SDK Go library.
+// This function will fail the test if there is an error.
+//
+// Deprecated: Use [GetRecommendedInstanceTypeWithClientContext] instead.
+func GetRecommendedInstanceTypeWithClient(t testing.TestingT, ec2Client *ec2.Client, instanceTypeOptions []string) string {
+	t.Helper()
+	return GetRecommendedInstanceTypeWithClientContext(t, context.Background(), ec2Client, instanceTypeOptions)
+}
+
 // GetRecommendedInstanceTypeWithClientE takes in a list of EC2 instance types (e.g., "t2.micro", "t3.micro") and returns the
 // first instance type in the list that is available in all Availability Zones (AZs) in the given region. If there's no
 // instance available in all AZs, this function exits with an error. This is useful because certain instance types,

modules/aws/region.go

@@ -89,6 +89,16 @@ func GetRandomStableRegion(t testing.TestingT, approvedRegions []string, forbidd
 	return GetRandomStableRegionContext(t, context.Background(), approvedRegions, forbiddenRegions)
 }
 
+// GetRandomStableRegionE gets a randomly chosen AWS region that is considered stable. Like GetRandomRegion, you can
+// further restrict the stable region list using approvedRegions and forbiddenRegions. We consider stable regions to be
+// those that have been around for at least 1 year.
+// Note that regions in the approvedRegions list that are not considered stable are ignored.
+//
+// Deprecated: Use [GetRandomStableRegionContextE] instead.
+func GetRandomStableRegionE(t testing.TestingT, approvedRegions []string, forbiddenRegions []string) (string, error) {
+	return GetRandomStableRegionContextE(t, context.Background(), approvedRegions, forbiddenRegions)
+}
+
 // GetRandomRegionContextE gets a randomly chosen AWS region. If approvedRegions is not empty, this will be a region from the approvedRegions
 // list; otherwise, this method will fetch the latest list of regions from the AWS APIs and pick one of those. If
 // forbiddenRegions is not empty, this method will make sure the returned region is not in the forbiddenRegions list.
@@ -348,3 +358,11 @@ func GetRandomRegionForService(t testing.TestingT, serviceName string) string {
 
 	return GetRandomRegionForServiceContext(t, context.Background(), serviceName)
 }
+
+// GetRandomRegionForServiceE retrieves a list of AWS regions in which a service is available
+// Then returns one region randomly from the list and returns errors.
+//
+// Deprecated: Use [GetRandomRegionForServiceContextE] instead.
+func GetRandomRegionForServiceE(t testing.TestingT, serviceName string) (string, error) {
+	return GetRandomRegionForServiceContextE(t, context.Background(), serviceName)
+}

modules/aws/ssm.go

@@ -272,7 +272,7 @@ func WaitForSsmInstanceWithClientContextE(t testing.TestingT, ctx context.Contex
 		},
 	}
 
-	_, err := retry.DoWithRetryE(t, description, maxRetries, timeBetweenRetries, func() (string, error) {
+	_, err := retry.DoWithRetryContextE(t, ctx, description, maxRetries, timeBetweenRetries, func() (string, error) {
 		resp, err := client.GetInventory(ctx, input)
 		if err != nil {
 			return "", err
@@ -414,7 +414,7 @@ func CheckSSMCommandWithClientWithDocumentContextE(t testing.TestingT, ctx conte
 
 	result := &CommandOutput{}
 
-	_, err = retry.DoWithRetryableErrorsE(t, description, retryableErrors, maxRetries, timeBetweenRetries, func() (string, error) {
+	_, err = retry.DoWithRetryableErrorsContextE(t, ctx, description, retryableErrors, maxRetries, timeBetweenRetries, func() (string, error) {
 		resp, err := client.GetCommandInvocation(ctx, &ssm.GetCommandInvocationInput{
 			CommandId:  resp.Command.CommandId,
 			InstanceId: &instanceID,

modules/aws/vpc.go

@@ -311,6 +311,13 @@ func GetAzDefaultSubnetsForVpc(t testing.TestingT, vpcID string, region string)
 	return GetAzDefaultSubnetsForVpcContext(t, context.Background(), vpcID, region)
 }
 
+// GetAzDefaultSubnetsForVpcE gets the default az subnets in the specified VPC.
+//
+// Deprecated: Use [GetAzDefaultSubnetsForVpcContextE] instead.
+func GetAzDefaultSubnetsForVpcE(t testing.TestingT, vpcID string, region string) ([]Subnet, error) {
+	return GetAzDefaultSubnetsForVpcContextE(t, context.Background(), vpcID, region)
+}
+
 // generateVpcIDFilter is a helper method to generate vpc id filter
 func generateVpcIDFilter(vpcID string) types.Filter {
 	return types.Filter{Name: aws.String(vpcIDFilterName), Values: []string{vpcID}}

modules/azure/actiongroup.go

@@ -32,7 +32,7 @@ func GetActionGroupResourceContextE(ctx context.Context, ruleName string, resGro
 		return nil, err
 	}
 
-	client, err := CreateActionGroupClient(subscriptionID)
+	client, err := CreateActionGroupClientContext(ctx, subscriptionID)
 	if err != nil {
 		return nil, err
 	}

modules/azure/aks.go

@@ -8,10 +8,11 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
-// GetManagedClustersClientE is a helper function that will setup an Azure ManagedClusters client on your behalf.
-func GetManagedClustersClientE(subscriptionID string) (*containerservice.ManagedClustersClient, error) {
+// GetManagedClustersClientContextE is a helper function that will setup an Azure ManagedClusters client on your behalf.
+// The ctx parameter supports cancellation and timeouts.
+func GetManagedClustersClientContextE(ctx context.Context, subscriptionID string) (*containerservice.ManagedClustersClient, error) {
 	// Create a cluster client
-	client, err := CreateManagedClustersClientE(subscriptionID)
+	client, err := CreateManagedClustersClientContextE(ctx, subscriptionID)
 	if err != nil {
 		return nil, err
 	}
@@ -27,6 +28,13 @@ func GetManagedClustersClientE(subscriptionID string) (*containerservice.Managed
 	return &client, nil
 }
 
+// GetManagedClustersClientE is a helper function that will setup an Azure ManagedClusters client on your behalf.
+//
+// Deprecated: Use [GetManagedClustersClientContextE] instead.
+func GetManagedClustersClientE(subscriptionID string) (*containerservice.ManagedClustersClient, error) {
+	return GetManagedClustersClientContextE(context.Background(), subscriptionID)
+}
+
 // GetManagedClusterContextE returns a ManagedCluster for the specified cluster in the given resource group.
 // The ctx parameter supports cancellation and timeouts.
 func GetManagedClusterContextE(t testing.TestingT, ctx context.Context, resourceGroupName, clusterName, subscriptionID string) (*containerservice.ManagedCluster, error) {
@@ -35,7 +43,7 @@ func GetManagedClusterContextE(t testing.TestingT, ctx context.Context, resource
 		return nil, err
 	}
 
-	client, err := GetManagedClustersClientE(subscriptionID)
+	client, err := GetManagedClustersClientContextE(ctx, subscriptionID)
 	if err != nil {
 		return nil, err
 	}

modules/azure/appService.go

@@ -82,7 +82,7 @@ func GetAppServiceContextE(ctx context.Context, appName string, resGroupName str
 		return nil, err
 	}
 
-	client, err := GetAppServiceClientE(subscriptionID)
+	client, err := GetAppServiceClientContextE(ctx, subscriptionID)
 	if err != nil {
 		return nil, err
 	}
@@ -102,12 +102,20 @@ func GetAppServiceE(appName string, resGroupName string, subscriptionID string)
 	return GetAppServiceContextE(context.Background(), appName, resGroupName, subscriptionID)
 }
 
-// GetAppServiceClientE creates and returns an App Service web apps client.
-func GetAppServiceClientE(subscriptionID string) (*armappservice.WebAppsClient, error) {
+// GetAppServiceClientContextE creates and returns an App Service web apps client.
+// The ctx parameter supports cancellation and timeouts.
+func GetAppServiceClientContextE(_ context.Context, subscriptionID string) (*armappservice.WebAppsClient, error) {
 	clientFactory, err := getArmAppServiceClientFactory(subscriptionID)
 	if err != nil {
 		return nil, err
 	}
 
 	return clientFactory.NewWebAppsClient(), nil
 }
+
+// GetAppServiceClientE creates and returns an App Service web apps client.
+//
+// Deprecated: Use [GetAppServiceClientContextE] instead.
+func GetAppServiceClientE(subscriptionID string) (*armappservice.WebAppsClient, error) {
+	return GetAppServiceClientContextE(context.Background(), subscriptionID)
+}