fix(api): rename *Context functions returning errors to *ContextE

Thirteen exported functions returned (T, error) under names ending in
*Context, violating the *ContextE convention used elsewhere. Tagging v1.0
with the convention violation would lock it into the stable API and a
later rename would require a major version bump.

Renamed in modules/aws/auth.go:
  NewAuthenticatedSessionContext
  NewAuthenticatedSessionFromDefaultCredentialsContext
  NewAuthenticatedSessionFromRoleContext
  CreateAwsSessionWithCredsContext
  CreateAwsSessionWithMfaContext
  ReadPasswordPolicyMinPasswordLengthContext

Renamed in modules/azure/client_factory.go:
  CreateSQLServerClientContext
  CreateSQLMangedInstanceClientContext
  CreateSQLMangedDatabasesClientContext
  CreateDatabaseClientContext
  CreateActionGroupClientContext

Renamed in modules/azure/sql.go:
  GetSQLServerClientContext
  GetDatabaseClientContext

For each, the original name remains as a // Deprecated: alias delegating
to the new *ContextE function so existing callers keep compiling. Internal
callers and the existing non-Context deprecated wrappers are repointed at
the new names directly.

OSS-3451.

Author: james00012

modules/aws/auth.go

@@ -22,28 +22,35 @@ const (
 	AuthAssumeRoleEnvVar = "TERRATEST_IAM_ROLE"
 )
 
-// NewAuthenticatedSessionContext creates an AWS Config following to standard AWS authentication workflow.
+// NewAuthenticatedSessionContextE creates an AWS Config following to standard AWS authentication workflow.
 // If AuthAssumeIamRoleEnvVar environment variable is set, assumes IAM role specified in it.
 // The ctx parameter supports cancellation and timeouts.
-func NewAuthenticatedSessionContext(ctx context.Context, region string) (*aws.Config, error) {
+func NewAuthenticatedSessionContextE(ctx context.Context, region string) (*aws.Config, error) {
 	if assumeRoleArn, ok := os.LookupEnv(AuthAssumeRoleEnvVar); ok {
-		return NewAuthenticatedSessionFromRoleContext(ctx, region, assumeRoleArn)
+		return NewAuthenticatedSessionFromRoleContextE(ctx, region, assumeRoleArn)
 	}
 
-	return NewAuthenticatedSessionFromDefaultCredentialsContext(ctx, region)
+	return NewAuthenticatedSessionFromDefaultCredentialsContextE(ctx, region)
+}
+
+// NewAuthenticatedSessionContext is a backwards-compatible alias for [NewAuthenticatedSessionContextE].
+//
+// Deprecated: Use [NewAuthenticatedSessionContextE] instead.
+func NewAuthenticatedSessionContext(ctx context.Context, region string) (*aws.Config, error) {
+	return NewAuthenticatedSessionContextE(ctx, region)
 }
 
 // NewAuthenticatedSession creates an AWS Config following to standard AWS authentication workflow.
 // If AuthAssumeIamRoleEnvVar environment variable is set, assumes IAM role specified in it.
 //
-// Deprecated: Use [NewAuthenticatedSessionContext] instead.
+// Deprecated: Use [NewAuthenticatedSessionContextE] instead.
 func NewAuthenticatedSession(region string) (*aws.Config, error) {
-	return NewAuthenticatedSessionContext(context.Background(), region)
+	return NewAuthenticatedSessionContextE(context.Background(), region)
 }
 
-// NewAuthenticatedSessionFromDefaultCredentialsContext gets an AWS Config, checking that the user has credentials properly configured in their environment.
+// NewAuthenticatedSessionFromDefaultCredentialsContextE gets an AWS Config, checking that the user has credentials properly configured in their environment.
 // The ctx parameter supports cancellation and timeouts.
-func NewAuthenticatedSessionFromDefaultCredentialsContext(ctx context.Context, region string) (*aws.Config, error) {
+func NewAuthenticatedSessionFromDefaultCredentialsContextE(ctx context.Context, region string) (*aws.Config, error) {
 	cfg, err := config.LoadDefaultConfig(ctx, config.WithRegion(region))
 	if err != nil {
 		return nil, CredentialsError{UnderlyingErr: err}
@@ -52,19 +59,26 @@ func NewAuthenticatedSessionFromDefaultCredentialsContext(ctx context.Context, r
 	return &cfg, nil
 }
 
+// NewAuthenticatedSessionFromDefaultCredentialsContext is a backwards-compatible alias for [NewAuthenticatedSessionFromDefaultCredentialsContextE].
+//
+// Deprecated: Use [NewAuthenticatedSessionFromDefaultCredentialsContextE] instead.
+func NewAuthenticatedSessionFromDefaultCredentialsContext(ctx context.Context, region string) (*aws.Config, error) {
+	return NewAuthenticatedSessionFromDefaultCredentialsContextE(ctx, region)
+}
+
 // NewAuthenticatedSessionFromDefaultCredentials gets an AWS Config, checking that the user has credentials properly configured in their environment.
 //
-// Deprecated: Use [NewAuthenticatedSessionFromDefaultCredentialsContext] instead.
+// Deprecated: Use [NewAuthenticatedSessionFromDefaultCredentialsContextE] instead.
 func NewAuthenticatedSessionFromDefaultCredentials(region string) (*aws.Config, error) {
-	return NewAuthenticatedSessionFromDefaultCredentialsContext(context.Background(), region)
+	return NewAuthenticatedSessionFromDefaultCredentialsContextE(context.Background(), region)
 }
 
-// NewAuthenticatedSessionFromRoleContext returns a new AWS Config after assuming the
+// NewAuthenticatedSessionFromRoleContextE returns a new AWS Config after assuming the
 // role whose ARN is provided in roleARN. If the credentials are not properly
 // configured in the underlying environment, an error is returned.
 // The ctx parameter supports cancellation and timeouts.
-func NewAuthenticatedSessionFromRoleContext(ctx context.Context, region string, roleARN string) (*aws.Config, error) {
-	cfg, err := NewAuthenticatedSessionFromDefaultCredentialsContext(ctx, region)
+func NewAuthenticatedSessionFromRoleContextE(ctx context.Context, region string, roleARN string) (*aws.Config, error) {
+	cfg, err := NewAuthenticatedSessionFromDefaultCredentialsContextE(ctx, region)
 	if err != nil {
 		return nil, err
 	}
@@ -86,36 +100,50 @@ func NewAuthenticatedSessionFromRoleContext(ctx context.Context, region string,
 	}, nil
 }
 
+// NewAuthenticatedSessionFromRoleContext is a backwards-compatible alias for [NewAuthenticatedSessionFromRoleContextE].
+//
+// Deprecated: Use [NewAuthenticatedSessionFromRoleContextE] instead.
+func NewAuthenticatedSessionFromRoleContext(ctx context.Context, region string, roleARN string) (*aws.Config, error) {
+	return NewAuthenticatedSessionFromRoleContextE(ctx, region, roleARN)
+}
+
 // NewAuthenticatedSessionFromRole returns a new AWS Config after assuming the
 // role whose ARN is provided in roleARN. If the credentials are not properly
 // configured in the underlying environment, an error is returned.
 //
-// Deprecated: Use [NewAuthenticatedSessionFromRoleContext] instead.
+// Deprecated: Use [NewAuthenticatedSessionFromRoleContextE] instead.
 func NewAuthenticatedSessionFromRole(region string, roleARN string) (*aws.Config, error) {
-	return NewAuthenticatedSessionFromRoleContext(context.Background(), region, roleARN)
+	return NewAuthenticatedSessionFromRoleContextE(context.Background(), region, roleARN)
 }
 
-// CreateAwsSessionWithCredsContext creates a new AWS Config using explicit credentials. This is useful if you want to create an IAM User dynamically and
+// CreateAwsSessionWithCredsContextE creates a new AWS Config using explicit credentials. This is useful if you want to create an IAM User dynamically and
 // create an AWS Config authenticated as the new IAM User.
 // The ctx parameter is accepted for API consistency but not currently used.
-func CreateAwsSessionWithCredsContext(ctx context.Context, region string, accessKeyID string, secretAccessKey string) (*aws.Config, error) {
+func CreateAwsSessionWithCredsContextE(_ context.Context, region string, accessKeyID string, secretAccessKey string) (*aws.Config, error) {
 	return &aws.Config{
 		Region:      region,
 		Credentials: aws.NewCredentialsCache(credentials.NewStaticCredentialsProvider(accessKeyID, secretAccessKey, "")),
 	}, nil
 }
 
+// CreateAwsSessionWithCredsContext is a backwards-compatible alias for [CreateAwsSessionWithCredsContextE].
+//
+// Deprecated: Use [CreateAwsSessionWithCredsContextE] instead.
+func CreateAwsSessionWithCredsContext(ctx context.Context, region string, accessKeyID string, secretAccessKey string) (*aws.Config, error) {
+	return CreateAwsSessionWithCredsContextE(ctx, region, accessKeyID, secretAccessKey)
+}
+
 // CreateAwsSessionWithCreds creates a new AWS Config using explicit credentials. This is useful if you want to create an IAM User dynamically and
 // create an AWS Config authenticated as the new IAM User.
 //
-// Deprecated: Use [CreateAwsSessionWithCredsContext] instead.
+// Deprecated: Use [CreateAwsSessionWithCredsContextE] instead.
 func CreateAwsSessionWithCreds(region string, accessKeyID string, secretAccessKey string) (*aws.Config, error) {
-	return CreateAwsSessionWithCredsContext(context.Background(), region, accessKeyID, secretAccessKey)
+	return CreateAwsSessionWithCredsContextE(context.Background(), region, accessKeyID, secretAccessKey)
 }
 
-// CreateAwsSessionWithMfaContext creates a new AWS Config authenticated using an MFA token retrieved using the given STS client and MFA Device.
+// CreateAwsSessionWithMfaContextE creates a new AWS Config authenticated using an MFA token retrieved using the given STS client and MFA Device.
 // The ctx parameter supports cancellation and timeouts.
-func CreateAwsSessionWithMfaContext(ctx context.Context, region string, stsClient *sts.Client, mfaDevice *types.VirtualMFADevice) (*aws.Config, error) {
+func CreateAwsSessionWithMfaContextE(ctx context.Context, region string, stsClient *sts.Client, mfaDevice *types.VirtualMFADevice) (*aws.Config, error) {
 	tokenCode, err := GetTimeBasedOneTimePassword(mfaDevice)
 	if err != nil {
 		return nil, err
@@ -139,11 +167,18 @@ func CreateAwsSessionWithMfaContext(ctx context.Context, region string, stsClien
 	}, nil
 }
 
+// CreateAwsSessionWithMfaContext is a backwards-compatible alias for [CreateAwsSessionWithMfaContextE].
+//
+// Deprecated: Use [CreateAwsSessionWithMfaContextE] instead.
+func CreateAwsSessionWithMfaContext(ctx context.Context, region string, stsClient *sts.Client, mfaDevice *types.VirtualMFADevice) (*aws.Config, error) {
+	return CreateAwsSessionWithMfaContextE(ctx, region, stsClient, mfaDevice)
+}
+
 // CreateAwsSessionWithMfa creates a new AWS Config authenticated using an MFA token retrieved using the given STS client and MFA Device.
 //
-// Deprecated: Use [CreateAwsSessionWithMfaContext] instead.
+// Deprecated: Use [CreateAwsSessionWithMfaContextE] instead.
 func CreateAwsSessionWithMfa(region string, stsClient *sts.Client, mfaDevice *types.VirtualMFADevice) (*aws.Config, error) {
-	return CreateAwsSessionWithMfaContext(context.Background(), region, stsClient, mfaDevice)
+	return CreateAwsSessionWithMfaContextE(context.Background(), region, stsClient, mfaDevice)
 }
 
 // GetTimeBasedOneTimePassword gets a One-Time Password from the given mfaDevice. Per the RFC 6238 standard, this value will be different every 30 seconds.
@@ -158,9 +193,9 @@ func GetTimeBasedOneTimePassword(mfaDevice *types.VirtualMFADevice) (string, err
 	return otp, nil
 }
 
-// ReadPasswordPolicyMinPasswordLengthContext returns the minimal password length.
+// ReadPasswordPolicyMinPasswordLengthContextE returns the minimal password length.
 // The ctx parameter supports cancellation and timeouts.
-func ReadPasswordPolicyMinPasswordLengthContext(ctx context.Context, iamClient *iam.Client) (int, error) {
+func ReadPasswordPolicyMinPasswordLengthContextE(ctx context.Context, iamClient *iam.Client) (int, error) {
 	output, err := iamClient.GetAccountPasswordPolicy(ctx, &iam.GetAccountPasswordPolicyInput{})
 	if err != nil {
 		return -1, err
@@ -169,11 +204,18 @@ func ReadPasswordPolicyMinPasswordLengthContext(ctx context.Context, iamClient *
 	return int(*output.PasswordPolicy.MinimumPasswordLength), nil
 }
 
+// ReadPasswordPolicyMinPasswordLengthContext is a backwards-compatible alias for [ReadPasswordPolicyMinPasswordLengthContextE].
+//
+// Deprecated: Use [ReadPasswordPolicyMinPasswordLengthContextE] instead.
+func ReadPasswordPolicyMinPasswordLengthContext(ctx context.Context, iamClient *iam.Client) (int, error) {
+	return ReadPasswordPolicyMinPasswordLengthContextE(ctx, iamClient)
+}
+
 // ReadPasswordPolicyMinPasswordLength returns the minimal password length.
 //
-// Deprecated: Use [ReadPasswordPolicyMinPasswordLengthContext] instead.
+// Deprecated: Use [ReadPasswordPolicyMinPasswordLengthContextE] instead.
 func ReadPasswordPolicyMinPasswordLength(iamClient *iam.Client) (int, error) {
-	return ReadPasswordPolicyMinPasswordLengthContext(context.Background(), iamClient)
+	return ReadPasswordPolicyMinPasswordLengthContextE(context.Background(), iamClient)
 }
 
 // CredentialsError is an error that occurs because AWS credentials can't be found.

modules/azure/actiongroup.go

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