Merge branch 'main' into james/oss-3364-bump-gcp-sdk

Author: james00012

modules/aws/account.go

@@ -59,6 +59,20 @@ func GetAccountIDE(t testing.TestingT) (string, error) {
 	return GetAccountIDContextE(t, context.Background())
 }
 
+// Deprecated: Use [GetAccountID] instead.
+//
+//nolint:staticcheck,revive // preserving deprecated function name
+func GetAccountId(t testing.TestingT) string {
+	return GetAccountID(t)
+}
+
+// Deprecated: Use [GetAccountIDE] instead.
+//
+//nolint:staticcheck,revive // preserving deprecated function name
+func GetAccountIdE(t testing.TestingT) (string, error) {
+	return GetAccountIDE(t)
+}
+
 // ExtractAccountIDFromARN extracts the AWS account ID from an IAM ARN.
 // An IAM ARN is of the format arn:aws:iam::123456789012:user/test. The account ID is the number after arn:aws:iam::,
 // so we split on a colon and return the 5th item.

modules/aws/ami.go

@@ -22,6 +22,13 @@ const (
 	CentOsAccountID = "679593333241"
 	// AmazonAccountID is the AWS account ID (or alias) for Amazon.
 	AmazonAccountID = "amazon"
+
+	// Deprecated: Use [CanonicalAccountID] instead.
+	CanonicalAccountId = CanonicalAccountID //nolint:staticcheck,revive // preserving deprecated constant name
+	// Deprecated: Use [CentOsAccountID] instead.
+	CentOsAccountId = CentOsAccountID //nolint:staticcheck,revive // preserving deprecated constant name
+	// Deprecated: Use [AmazonAccountID] instead.
+	AmazonAccountId = AmazonAccountID //nolint:staticcheck,revive // preserving deprecated constant name
 )
 
 // DeleteAmiAndAllSnapshotsContextE will delete the given AMI along with all EBS snapshots that backed that AMI.
@@ -202,6 +209,20 @@ func GetMostRecentAmiIDE(t testing.TestingT, region string, ownerID string, filt
 	return GetMostRecentAmiIDContextE(t, context.Background(), region, ownerID, filters)
 }
 
+// Deprecated: Use [GetMostRecentAmiID] instead.
+//
+//nolint:staticcheck,revive // preserving deprecated function name
+func GetMostRecentAmiId(t testing.TestingT, region string, ownerId string, filters map[string][]string) string {
+	return GetMostRecentAmiID(t, region, ownerId, filters)
+}
+
+// Deprecated: Use [GetMostRecentAmiIDE] instead.
+//
+//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)
+}
+
 // Image sorting code borrowed from: https://github.com/hashicorp/packer/blob/7f4112ba229309cfc0ebaa10ded2abdfaf1b22c8/builder/amazon/common/step_source_ami_info.go
 type imageSort []types.Image
 

modules/aws/ec2.go

@@ -56,6 +56,24 @@ func GetPrivateIPOfEc2InstanceE(t testing.TestingT, instanceID string, awsRegion
 	return GetPrivateIPOfEc2InstanceContextE(t, context.Background(), instanceID, awsRegion)
 }
 
+// GetPrivateIpOfEc2Instance gets the private IP address of the given EC2 Instance in the given region.
+//
+// Deprecated: Use [GetPrivateIPOfEc2Instance] instead.
+//
+//nolint:staticcheck,revive // preserving deprecated function name
+func GetPrivateIpOfEc2Instance(t testing.TestingT, instanceID string, awsRegion string) string {
+	return GetPrivateIPOfEc2Instance(t, instanceID, awsRegion)
+}
+
+// GetPrivateIpOfEc2InstanceE gets the private IP address of the given EC2 Instance in the given region.
+//
+// Deprecated: Use [GetPrivateIPOfEc2InstanceE] instead.
+//
+//nolint:staticcheck,revive // preserving deprecated function name
+func GetPrivateIpOfEc2InstanceE(t testing.TestingT, instanceID string, awsRegion string) (string, error) {
+	return GetPrivateIPOfEc2InstanceE(t, 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.
 // The ctx parameter supports cancellation and timeouts.
 func GetPrivateIpsOfEc2InstancesContextE(t testing.TestingT, ctx context.Context, instanceIDs []string, awsRegion string) (map[string]string, error) {
@@ -212,6 +230,24 @@ func GetPublicIPOfEc2InstanceE(t testing.TestingT, instanceID string, awsRegion
 	return GetPublicIPOfEc2InstanceContextE(t, context.Background(), instanceID, awsRegion)
 }
 
+// GetPublicIpOfEc2Instance gets the public IP address of the given EC2 Instance in the given region.
+//
+// Deprecated: Use [GetPublicIPOfEc2Instance] instead.
+//
+//nolint:staticcheck,revive // preserving deprecated function name
+func GetPublicIpOfEc2Instance(t testing.TestingT, instanceID string, awsRegion string) string {
+	return GetPublicIPOfEc2Instance(t, instanceID, awsRegion)
+}
+
+// GetPublicIpOfEc2InstanceE gets the public IP address of the given EC2 Instance in the given region.
+//
+// Deprecated: Use [GetPublicIPOfEc2InstanceE] instead.
+//
+//nolint:staticcheck,revive // preserving deprecated function name
+func GetPublicIpOfEc2InstanceE(t testing.TestingT, instanceID string, awsRegion string) (string, error) {
+	return GetPublicIPOfEc2InstanceE(t, 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.
 // The ctx parameter supports cancellation and timeouts.
 func GetPublicIpsOfEc2InstancesContextE(t testing.TestingT, ctx context.Context, instanceIDs []string, awsRegion string) (map[string]string, error) {

modules/aws/vpc.go

@@ -128,6 +128,20 @@ func GetVpcByIDE(t testing.TestingT, vpcID string, region string) (*Vpc, error)
 	return GetVpcByIDContextE(t, context.Background(), vpcID, region)
 }
 
+// GetVpcById fetches information about a VPC with given ID in the given region.
+//
+// Deprecated: Use [GetVpcByID] instead.
+func GetVpcById(t testing.TestingT, vpcID string, region string) *Vpc { //nolint:staticcheck,revive // preserving deprecated function name
+	return GetVpcByID(t, vpcID, region)
+}
+
+// GetVpcByIdE fetches information about a VPC with given ID in the given region.
+//
+// Deprecated: Use [GetVpcByIDE] instead.
+func GetVpcByIdE(t testing.TestingT, vpcID string, region string) (*Vpc, error) { //nolint:staticcheck,revive // preserving deprecated function name
+	return GetVpcByIDE(t, vpcID, region)
+}
+
 // GetVpcsContextE fetches information about VPCs from given regions limited by filters
 // The ctx parameter supports cancellation and timeouts.
 func GetVpcsContextE(t testing.TestingT, ctx context.Context, filters []types.Filter, region string) ([]*Vpc, error) {

modules/gcp/compute.go

@@ -56,6 +56,12 @@ type InstanceGroup interface {
 	// GetInstanceIDsContextE gets the IDs of Instances in the given Instance Group.
 	// The ctx parameter supports cancellation and timeouts.
 	GetInstanceIDsContextE(t testing.TestingT, ctx context.Context) ([]string, error)
+
+	// Deprecated: Use [InstanceGroup.GetInstanceIDs] instead.
+	GetInstanceIds(t testing.TestingT) []string //nolint:staticcheck,revive // preserving deprecated method name
+
+	// Deprecated: Use [InstanceGroup.GetInstanceIDsE] instead.
+	GetInstanceIdsE(t testing.TestingT) ([]string, error) //nolint:staticcheck,revive // preserving deprecated method name
 }
 
 // FetchInstance queries GCP to return an instance of the Compute Instance type.
@@ -297,6 +303,21 @@ func (i *Instance) GetPublicIPE(t testing.TestingT) (string, error) {
 	return i.GetPublicIPContextE(t, context.Background())
 }
 
+// GetPublicIp gets the public IP address of the given Compute Instance.
+// This will fail the test if there is an error.
+//
+// Deprecated: Use [Instance.GetPublicIP] instead.
+func (i *Instance) GetPublicIp(t testing.TestingT) string { //nolint:staticcheck,revive // preserving deprecated method name
+	return i.GetPublicIP(t)
+}
+
+// GetPublicIpE gets the public IP address of the given Compute Instance.
+//
+// Deprecated: Use [Instance.GetPublicIPE] instead.
+func (i *Instance) GetPublicIpE(t testing.TestingT) (string, error) { //nolint:staticcheck,revive // preserving deprecated method name
+	return i.GetPublicIPE(t)
+}
+
 // GetPublicIPContextE gets the public IP address of the given Compute Instance.
 // The ctx parameter supports cancellation and timeouts.
 // Returns an error (rather than panicking) when the instance has no network interfaces
@@ -555,6 +576,21 @@ func (i *Instance) AddSSHKeyE(t testing.TestingT, username string, publicKey str
 	return i.AddSSHKeyContextE(t, context.Background(), username, publicKey)
 }
 
+// AddSshKey adds the given public SSH key to the Compute Instance. Users can SSH in with the given username.
+// This will fail the test if there is an error.
+//
+// Deprecated: Use [Instance.AddSSHKey] instead.
+func (i *Instance) AddSshKey(t testing.TestingT, username string, publicKey string) { //nolint:staticcheck,revive // preserving deprecated method name
+	i.AddSSHKey(t, username, publicKey)
+}
+
+// AddSshKeyE adds the given public SSH key to the Compute Instance. Users can SSH in with the given username.
+//
+// Deprecated: Use [Instance.AddSSHKeyE] instead.
+func (i *Instance) AddSshKeyE(t testing.TestingT, username string, publicKey string) error { //nolint:staticcheck,revive // preserving deprecated method name
+	return i.AddSSHKeyE(t, username, publicKey)
+}
+
 // AddSSHKeyContextE adds the given public SSH key to the Compute Instance. Users can SSH in with the given username.
 // The ctx parameter supports cancellation and timeouts.
 func (i *Instance) AddSSHKeyContextE(t testing.TestingT, ctx context.Context, username string, publicKey string) error {
@@ -661,6 +697,21 @@ func (ig *ZonalInstanceGroup) GetInstanceIDsE(t testing.TestingT) ([]string, err
 	return ig.GetInstanceIDsContextE(t, context.Background())
 }
 
+// GetInstanceIds gets the IDs of Instances in the given Zonal Instance Group.
+// This will fail the test if there is an error.
+//
+// Deprecated: Use [ZonalInstanceGroup.GetInstanceIDs] instead.
+func (ig *ZonalInstanceGroup) GetInstanceIds(t testing.TestingT) []string { //nolint:staticcheck,revive // preserving deprecated method name
+	return ig.GetInstanceIDs(t)
+}
+
+// GetInstanceIdsE gets the IDs of Instances in the given Zonal Instance Group.
+//
+// Deprecated: Use [ZonalInstanceGroup.GetInstanceIDsE] instead.
+func (ig *ZonalInstanceGroup) GetInstanceIdsE(t testing.TestingT) ([]string, error) { //nolint:staticcheck,revive // preserving deprecated method name
+	return ig.GetInstanceIDsE(t)
+}
+
 // GetInstanceIDsContextE gets the IDs of Instances in the given Zonal Instance Group.
 // The ctx parameter supports cancellation and timeouts.
 func (ig *ZonalInstanceGroup) GetInstanceIDsContextE(t testing.TestingT, ctx context.Context) ([]string, error) {
@@ -730,6 +781,21 @@ func (ig *RegionalInstanceGroup) GetInstanceIDsE(t testing.TestingT) ([]string,
 	return ig.GetInstanceIDsContextE(t, context.Background())
 }
 
+// GetInstanceIds gets the IDs of Instances in the given Regional Instance Group.
+// This will fail the test if there is an error.
+//
+// Deprecated: Use [RegionalInstanceGroup.GetInstanceIDs] instead.
+func (ig *RegionalInstanceGroup) GetInstanceIds(t testing.TestingT) []string { //nolint:staticcheck,revive // preserving deprecated method name
+	return ig.GetInstanceIDs(t)
+}
+
+// GetInstanceIdsE gets the IDs of Instances in the given Regional Instance Group.
+//
+// Deprecated: Use [RegionalInstanceGroup.GetInstanceIDsE] instead.
+func (ig *RegionalInstanceGroup) GetInstanceIdsE(t testing.TestingT) ([]string, error) { //nolint:staticcheck,revive // preserving deprecated method name
+	return ig.GetInstanceIDsE(t)
+}
+
 // GetInstanceIDsContextE gets the IDs of Instances in the given Regional Instance Group.
 // The ctx parameter supports cancellation and timeouts.
 func (ig *RegionalInstanceGroup) GetInstanceIDsContextE(t testing.TestingT, ctx context.Context) ([]string, error) {
@@ -882,6 +948,21 @@ func (ig *ZonalInstanceGroup) GetPublicIPsE(t testing.TestingT, projectID string
 	return ig.GetPublicIPsContextE(t, context.Background(), projectID)
 }
 
+// GetPublicIps returns a slice of the public IPs from the given Zonal Instance Group.
+// This will fail the test if there is an error.
+//
+// Deprecated: Use [ZonalInstanceGroup.GetPublicIPs] instead.
+func (ig *ZonalInstanceGroup) GetPublicIps(t testing.TestingT, projectID string) []string { //nolint:staticcheck,revive // preserving deprecated method name
+	return ig.GetPublicIPs(t, projectID)
+}
+
+// GetPublicIpsE returns a slice of the public IPs from the given Zonal Instance Group.
+//
+// Deprecated: Use [ZonalInstanceGroup.GetPublicIPsE] instead.
+func (ig *ZonalInstanceGroup) GetPublicIpsE(t testing.TestingT, projectID string) ([]string, error) { //nolint:staticcheck,revive // preserving deprecated method name
+	return ig.GetPublicIPsE(t, projectID)
+}
+
 // GetPublicIPsContextE returns a slice of the public IPs from the given Zonal Instance Group.
 // The ctx parameter supports cancellation and timeouts.
 func (ig *ZonalInstanceGroup) GetPublicIPsContextE(t testing.TestingT, ctx context.Context, projectID string) ([]string, error) {
@@ -913,6 +994,21 @@ func (ig *RegionalInstanceGroup) GetPublicIPsE(t testing.TestingT, projectID str
 	return ig.GetPublicIPsContextE(t, context.Background(), projectID)
 }
 
+// GetPublicIps returns a slice of the public IPs from the given Regional Instance Group.
+// This will fail the test if there is an error.
+//
+// Deprecated: Use [RegionalInstanceGroup.GetPublicIPs] instead.
+func (ig *RegionalInstanceGroup) GetPublicIps(t testing.TestingT, projectID string) []string { //nolint:staticcheck,revive // preserving deprecated method name
+	return ig.GetPublicIPs(t, projectID)
+}
+
+// GetPublicIpsE returns a slice of the public IPs from the given Regional Instance Group.
+//
+// Deprecated: Use [RegionalInstanceGroup.GetPublicIPsE] instead.
+func (ig *RegionalInstanceGroup) GetPublicIpsE(t testing.TestingT, projectID string) ([]string, error) { //nolint:staticcheck,revive // preserving deprecated method name
+	return ig.GetPublicIPsE(t, projectID)
+}
+
 // GetPublicIPsContextE returns a slice of the public IPs from the given Regional Instance Group.
 // The ctx parameter supports cancellation and timeouts.
 func (ig *RegionalInstanceGroup) GetPublicIPsContextE(t testing.TestingT, ctx context.Context, projectID string) ([]string, error) {
@@ -1131,3 +1227,10 @@ func RandomValidGCPName() string {
 
 	return "terratest-" + id
 }
+
+// RandomValidGcpName returns a random, valid name for GCP resources. Many resources in GCP require lowercase letters only.
+//
+// Deprecated: Use [RandomValidGCPName] instead.
+func RandomValidGcpName() string { //nolint:staticcheck,revive // preserving deprecated function name
+	return RandomValidGCPName()
+}

modules/gcp/region.go

@@ -233,6 +233,38 @@ func GetAllGCPRegionsE(t testing.TestingT, projectID string) ([]string, error) {
 	return GetAllGCPRegionsContextE(t, context.Background(), projectID)
 }
 
+// GetAllGcpRegions gets the list of GCP regions available in this account.
+// This will fail the test if there is an error.
+//
+// Deprecated: Use [GetAllGCPRegionsContext] instead.
+func GetAllGcpRegions(t testing.TestingT, projectID string) []string { //nolint:staticcheck,revive // preserving deprecated function name
+	return GetAllGCPRegionsContext(t, context.Background(), projectID)
+}
+
+// GetAllGcpRegionsContext gets the list of GCP regions available in this account.
+// This will fail the test if there is an error.
+// The ctx parameter supports cancellation and timeouts.
+//
+// Deprecated: Use [GetAllGCPRegionsContext] instead.
+func GetAllGcpRegionsContext(t testing.TestingT, ctx context.Context, projectID string) []string { //nolint:staticcheck,revive // preserving deprecated function name
+	return GetAllGCPRegionsContext(t, ctx, projectID)
+}
+
+// GetAllGcpRegionsE gets the list of GCP regions available in this account.
+//
+// Deprecated: Use [GetAllGCPRegionsContextE] instead.
+func GetAllGcpRegionsE(t testing.TestingT, projectID string) ([]string, error) { //nolint:staticcheck,revive // preserving deprecated function name
+	return GetAllGCPRegionsContextE(t, context.Background(), projectID)
+}
+
+// GetAllGcpRegionsContextE gets the list of GCP regions available in this account.
+// The ctx parameter supports cancellation and timeouts.
+//
+// Deprecated: Use [GetAllGCPRegionsContextE] instead.
+func GetAllGcpRegionsContextE(t testing.TestingT, ctx context.Context, projectID string) ([]string, error) { //nolint:staticcheck,revive // preserving deprecated function name
+	return GetAllGCPRegionsContextE(t, ctx, projectID)
+}
+
 // GetAllGCPRegionsContextE gets the list of GCP regions available in this account.
 // The ctx parameter supports cancellation and timeouts.
 func GetAllGCPRegionsContextE(t testing.TestingT, ctx context.Context, projectID string) ([]string, error) {
@@ -293,6 +325,38 @@ func GetAllGCPZonesE(t testing.TestingT, projectID string) ([]string, error) {
 	return GetAllGCPZonesContextE(t, context.Background(), projectID)
 }
 
+// GetAllGcpZones gets the list of GCP Zones available in this account.
+// This will fail the test if there is an error.
+//
+// Deprecated: Use [GetAllGCPZonesContext] instead.
+func GetAllGcpZones(t testing.TestingT, projectID string) []string { //nolint:staticcheck,revive // preserving deprecated function name
+	return GetAllGCPZonesContext(t, context.Background(), projectID)
+}
+
+// GetAllGcpZonesContext gets the list of GCP Zones available in this account.
+// This will fail the test if there is an error.
+// The ctx parameter supports cancellation and timeouts.
+//
+// Deprecated: Use [GetAllGCPZonesContext] instead.
+func GetAllGcpZonesContext(t testing.TestingT, ctx context.Context, projectID string) []string { //nolint:staticcheck,revive // preserving deprecated function name
+	return GetAllGCPZonesContext(t, ctx, projectID)
+}
+
+// GetAllGcpZonesE gets the list of GCP Zones available in this account.
+//
+// Deprecated: Use [GetAllGCPZonesContextE] instead.
+func GetAllGcpZonesE(t testing.TestingT, projectID string) ([]string, error) { //nolint:staticcheck,revive // preserving deprecated function name
+	return GetAllGCPZonesContextE(t, context.Background(), projectID)
+}
+
+// GetAllGcpZonesContextE gets the list of GCP Zones available in this account.
+// The ctx parameter supports cancellation and timeouts.
+//
+// Deprecated: Use [GetAllGCPZonesContextE] instead.
+func GetAllGcpZonesContextE(t testing.TestingT, ctx context.Context, projectID string) ([]string, error) { //nolint:staticcheck,revive // preserving deprecated function name
+	return GetAllGCPZonesContextE(t, ctx, projectID)
+}
+
 // GetAllGCPZonesContextE gets the list of GCP Zones available in this account.
 // The ctx parameter supports cancellation and timeouts.
 func GetAllGCPZonesContextE(t testing.TestingT, ctx context.Context, projectID string) ([]string, error) {
@@ -334,6 +398,13 @@ func ZoneURLToZone(zoneURL string) string {
 	return tokens[len(tokens)-1]
 }
 
+// ZoneUrlToZone extracts the zone name from a GCP Zone URL.
+//
+// Deprecated: Use [ZoneURLToZone] instead.
+func ZoneUrlToZone(zoneURL string) string { //nolint:staticcheck,revive // preserving deprecated function name
+	return ZoneURLToZone(zoneURL)
+}
+
 // RegionURLToRegion extracts the region name from a GCP Region URL formatted like
 // https://www.googleapis.com/compute/v1/projects/project-123456/regions/southamerica-east1 and returns
 // "southamerica-east1".
@@ -343,6 +414,13 @@ func RegionURLToRegion(regionURL string) string {
 	return tokens[len(tokens)-1]
 }
 
+// RegionUrlToRegion extracts the region name from a GCP Region URL.
+//
+// Deprecated: Use [RegionURLToRegion] instead.
+func RegionUrlToRegion(regionURL string) string { //nolint:staticcheck,revive // preserving deprecated function name
+	return RegionURLToRegion(regionURL)
+}
+
 // isInRegions returns true if the given zone is in any of the given regions.
 func isInRegions(zone string, regions []string) bool {
 	for _, region := range regions {