Merge pull request #1754 from gruntwork-io/fix/azure-restore-deprecated-wrappers

fix(azure): restore deprecated non-Context wrappers for backward compatibility

Author: james00012

modules/azure/availabilityset.go

@@ -9,6 +9,25 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
+// AvailabilitySetExists indicates whether the specified Azure Availability Set exists.
+// This function would fail the test if there is an error.
+//
+// Deprecated: Use [AvailabilitySetExistsContext] instead.
+func AvailabilitySetExists(t testing.TestingT, avsName string, resGroupName string, subscriptionID string) bool {
+	t.Helper()
+
+	return AvailabilitySetExistsContext(t, context.Background(), avsName, resGroupName, subscriptionID)
+}
+
+// AvailabilitySetExistsE indicates whether the specified Azure Availability Set exists.
+//
+// Deprecated: Use [AvailabilitySetExistsContextE] instead.
+func AvailabilitySetExistsE(t testing.TestingT, avsName string, resGroupName string, subscriptionID string) (bool, error) {
+	t.Helper()
+
+	return AvailabilitySetExistsContextE(t, context.Background(), avsName, resGroupName, subscriptionID)
+}
+
 // AvailabilitySetExistsContext indicates whether the specified Azure Availability Set exists.
 // This function would fail the test if there is an error.
 // The ctx parameter supports cancellation and timeouts.
@@ -36,6 +55,25 @@ func AvailabilitySetExistsContextE(t testing.TestingT, ctx context.Context, avsN
 	return true, nil
 }
 
+// CheckAvailabilitySetContainsVM checks if the Virtual Machine is contained in the Availability Set VMs.
+// This function would fail the test if there is an error.
+//
+// Deprecated: Use [CheckAvailabilitySetContainsVMContext] instead.
+func CheckAvailabilitySetContainsVM(t testing.TestingT, vmName string, avsName string, resGroupName string, subscriptionID string) bool {
+	t.Helper()
+
+	return CheckAvailabilitySetContainsVMContext(t, context.Background(), vmName, avsName, resGroupName, subscriptionID)
+}
+
+// CheckAvailabilitySetContainsVME checks if the Virtual Machine is contained in the Availability Set VMs.
+//
+// Deprecated: Use [CheckAvailabilitySetContainsVMContextE] instead.
+func CheckAvailabilitySetContainsVME(t testing.TestingT, vmName string, avsName string, resGroupName string, subscriptionID string) (bool, error) {
+	t.Helper()
+
+	return CheckAvailabilitySetContainsVMContextE(t, context.Background(), vmName, avsName, resGroupName, subscriptionID)
+}
+
 // CheckAvailabilitySetContainsVMContext checks if the Virtual Machine is contained in the Availability Set VMs.
 // This function would fail the test if there is an error.
 // The ctx parameter supports cancellation and timeouts.
@@ -71,6 +109,25 @@ func CheckAvailabilitySetContainsVMContextE(t testing.TestingT, ctx context.Cont
 	return false, NewNotFoundError("Virtual Machine", vmName, avsName)
 }
 
+// GetAvailabilitySetVMNamesInCaps gets a list of VM names in the specified Azure Availability Set.
+// This function would fail the test if there is an error.
+//
+// Deprecated: Use [GetAvailabilitySetVMNamesInCapsContext] instead.
+func GetAvailabilitySetVMNamesInCaps(t testing.TestingT, avsName string, resGroupName string, subscriptionID string) []string {
+	t.Helper()
+
+	return GetAvailabilitySetVMNamesInCapsContext(t, context.Background(), avsName, resGroupName, subscriptionID)
+}
+
+// GetAvailabilitySetVMNamesInCapsE gets a list of VM names in the specified Azure Availability Set.
+//
+// Deprecated: Use [GetAvailabilitySetVMNamesInCapsContextE] instead.
+func GetAvailabilitySetVMNamesInCapsE(t testing.TestingT, avsName string, resGroupName string, subscriptionID string) ([]string, error) {
+	t.Helper()
+
+	return GetAvailabilitySetVMNamesInCapsContextE(t, context.Background(), avsName, resGroupName, subscriptionID)
+}
+
 // GetAvailabilitySetVMNamesInCapsContext gets a list of VM names in the specified Azure Availability Set.
 // This function would fail the test if there is an error.
 // The ctx parameter supports cancellation and timeouts.
@@ -108,6 +165,25 @@ func GetAvailabilitySetVMNamesInCapsContextE(t testing.TestingT, ctx context.Con
 	return vms, nil
 }
 
+// GetAvailabilitySetFaultDomainCount gets the Fault Domain Count for the specified Azure Availability Set.
+// This function would fail the test if there is an error.
+//
+// Deprecated: Use [GetAvailabilitySetFaultDomainCountContext] instead.
+func GetAvailabilitySetFaultDomainCount(t testing.TestingT, avsName string, resGroupName string, subscriptionID string) int32 {
+	t.Helper()
+
+	return GetAvailabilitySetFaultDomainCountContext(t, context.Background(), avsName, resGroupName, subscriptionID)
+}
+
+// GetAvailabilitySetFaultDomainCountE gets the Fault Domain Count for the specified Azure Availability Set.
+//
+// Deprecated: Use [GetAvailabilitySetFaultDomainCountContextE] instead.
+func GetAvailabilitySetFaultDomainCountE(t testing.TestingT, avsName string, resGroupName string, subscriptionID string) (int32, error) {
+	t.Helper()
+
+	return GetAvailabilitySetFaultDomainCountContextE(t, context.Background(), avsName, resGroupName, subscriptionID)
+}
+
 // GetAvailabilitySetFaultDomainCountContext gets the Fault Domain Count for the specified Azure Availability Set.
 // This function would fail the test if there is an error.
 // The ctx parameter supports cancellation and timeouts.
@@ -131,6 +207,15 @@ func GetAvailabilitySetFaultDomainCountContextE(t testing.TestingT, ctx context.
 	return *avs.Properties.PlatformFaultDomainCount, nil
 }
 
+// GetAvailabilitySetE gets an Availability Set in the specified Azure Resource Group.
+//
+// Deprecated: Use [GetAvailabilitySetContextE] instead.
+func GetAvailabilitySetE(t testing.TestingT, avsName string, resGroupName string, subscriptionID string) (*armcompute.AvailabilitySet, error) {
+	t.Helper()
+
+	return GetAvailabilitySetContextE(t, context.Background(), avsName, resGroupName, subscriptionID)
+}
+
 // GetAvailabilitySetContextE gets an Availability Set in the specified Azure Resource Group.
 // The ctx parameter supports cancellation and timeouts.
 func GetAvailabilitySetContextE(t testing.TestingT, ctx context.Context, avsName string, resGroupName string, subscriptionID string) (*armcompute.AvailabilitySet, error) {

modules/azure/compute.go

@@ -52,6 +52,23 @@ func GetVirtualMachineClientE(subscriptionID string) (*armcompute.VirtualMachine
 	return GetVirtualMachineClientContextE(context.Background(), subscriptionID)
 }
 
+// VirtualMachineExists indicates whether the specified Azure Virtual Machine exists.
+// This function would fail the test if there is an error.
+//
+// Deprecated: Use [VirtualMachineExistsContext] instead.
+func VirtualMachineExists(t testing.TestingT, vmName string, resGroupName string, subscriptionID string) bool {
+	t.Helper()
+
+	return VirtualMachineExistsContext(t, context.Background(), vmName, resGroupName, subscriptionID)
+}
+
+// VirtualMachineExistsE indicates whether the specified Azure Virtual Machine exists.
+//
+// Deprecated: Use [VirtualMachineExistsContextE] instead.
+func VirtualMachineExistsE(vmName string, resGroupName string, subscriptionID string) (bool, error) {
+	return VirtualMachineExistsContextE(context.Background(), vmName, resGroupName, subscriptionID)
+}
+
 // VirtualMachineExistsContext indicates whether the specified Azure Virtual Machine exists.
 // This function would fail the test if there is an error.
 // The ctx parameter supports cancellation and timeouts.
@@ -79,6 +96,23 @@ func VirtualMachineExistsContextE(ctx context.Context, vmName string, resGroupNa
 	return true, nil
 }
 
+// GetVirtualMachineNics gets a list of Network Interface names for a specified Azure Virtual Machine.
+// This function would fail the test if there is an error.
+//
+// Deprecated: Use [GetVirtualMachineNicsContext] instead.
+func GetVirtualMachineNics(t testing.TestingT, vmName string, resGroupName string, subscriptionID string) []string {
+	t.Helper()
+
+	return GetVirtualMachineNicsContext(t, context.Background(), vmName, resGroupName, subscriptionID)
+}
+
+// GetVirtualMachineNicsE gets a list of Network Interface names for a specified Azure Virtual Machine.
+//
+// Deprecated: Use [GetVirtualMachineNicsContextE] instead.
+func GetVirtualMachineNicsE(vmName string, resGroupName string, subscriptionID string) ([]string, error) {
+	return GetVirtualMachineNicsContextE(context.Background(), vmName, resGroupName, subscriptionID)
+}
+
 // GetVirtualMachineNicsContext gets a list of Network Interface names for a specified Azure Virtual Machine.
 // This function would fail the test if there is an error.
 // The ctx parameter supports cancellation and timeouts.
@@ -124,6 +158,23 @@ func extractVMNics(vm *armcompute.VirtualMachine) ([]string, error) {
 	return nics, nil
 }
 
+// GetVirtualMachineManagedDisks gets the list of Managed Disk names of the specified Azure Virtual Machine.
+// This function would fail the test if there is an error.
+//
+// Deprecated: Use [GetVirtualMachineManagedDisksContext] instead.
+func GetVirtualMachineManagedDisks(t testing.TestingT, vmName string, resGroupName string, subscriptionID string) []string {
+	t.Helper()
+
+	return GetVirtualMachineManagedDisksContext(t, context.Background(), vmName, resGroupName, subscriptionID)
+}
+
+// GetVirtualMachineManagedDisksE gets the list of Managed Disk names of the specified Azure Virtual Machine.
+//
+// Deprecated: Use [GetVirtualMachineManagedDisksContextE] instead.
+func GetVirtualMachineManagedDisksE(vmName string, resGroupName string, subscriptionID string) ([]string, error) {
+	return GetVirtualMachineManagedDisksContextE(context.Background(), vmName, resGroupName, subscriptionID)
+}
+
 // GetVirtualMachineManagedDisksContext gets the list of Managed Disk names of the specified Azure Virtual Machine.
 // This function would fail the test if there is an error.
 // The ctx parameter supports cancellation and timeouts.
@@ -159,6 +210,23 @@ func extractVMManagedDisks(vm *armcompute.VirtualMachine) []string {
 	return diskNames
 }
 
+// GetVirtualMachineOSDiskName gets the OS Disk name of the specified Azure Virtual Machine.
+// This function would fail the test if there is an error.
+//
+// Deprecated: Use [GetVirtualMachineOSDiskNameContext] instead.
+func GetVirtualMachineOSDiskName(t testing.TestingT, vmName string, resGroupName string, subscriptionID string) string {
+	t.Helper()
+
+	return GetVirtualMachineOSDiskNameContext(t, context.Background(), vmName, resGroupName, subscriptionID)
+}
+
+// GetVirtualMachineOSDiskNameE gets the OS Disk name of the specified Azure Virtual Machine.
+//
+// Deprecated: Use [GetVirtualMachineOSDiskNameContextE] instead.
+func GetVirtualMachineOSDiskNameE(vmName string, resGroupName string, subscriptionID string) (string, error) {
+	return GetVirtualMachineOSDiskNameContextE(context.Background(), vmName, resGroupName, subscriptionID)
+}
+
 // GetVirtualMachineOSDiskNameContext gets the OS Disk name of the specified Azure Virtual Machine.
 // This function would fail the test if there is an error.
 // The ctx parameter supports cancellation and timeouts.
@@ -187,6 +255,23 @@ func extractVMOSDiskName(vm *armcompute.VirtualMachine) string {
 	return *vm.Properties.StorageProfile.OSDisk.Name
 }
 
+// GetVirtualMachineAvailabilitySetID gets the Availability Set ID of the specified Azure Virtual Machine.
+// This function would fail the test if there is an error.
+//
+// Deprecated: Use [GetVirtualMachineAvailabilitySetIDContext] instead.
+func GetVirtualMachineAvailabilitySetID(t testing.TestingT, vmName string, resGroupName string, subscriptionID string) string {
+	t.Helper()
+
+	return GetVirtualMachineAvailabilitySetIDContext(t, context.Background(), vmName, resGroupName, subscriptionID)
+}
+
+// GetVirtualMachineAvailabilitySetIDE gets the Availability Set ID of the specified Azure Virtual Machine.
+//
+// Deprecated: Use [GetVirtualMachineAvailabilitySetIDContextE] instead.
+func GetVirtualMachineAvailabilitySetIDE(vmName string, resGroupName string, subscriptionID string) (string, error) {
+	return GetVirtualMachineAvailabilitySetIDContextE(context.Background(), vmName, resGroupName, subscriptionID)
+}
+
 // GetVirtualMachineAvailabilitySetIDContext gets the Availability Set ID of the specified Azure Virtual Machine.
 // This function would fail the test if there is an error.
 // The ctx parameter supports cancellation and timeouts.
@@ -232,6 +317,23 @@ type VMImage struct {
 	Version   string
 }
 
+// GetVirtualMachineImage gets the Image of the specified Azure Virtual Machine.
+// This function would fail the test if there is an error.
+//
+// Deprecated: Use [GetVirtualMachineImageContext] instead.
+func GetVirtualMachineImage(t testing.TestingT, vmName string, resGroupName string, subscriptionID string) VMImage {
+	t.Helper()
+
+	return GetVirtualMachineImageContext(t, context.Background(), vmName, resGroupName, subscriptionID)
+}
+
+// GetVirtualMachineImageE gets the Image of the specified Azure Virtual Machine.
+//
+// Deprecated: Use [GetVirtualMachineImageContextE] instead.
+func GetVirtualMachineImageE(vmName string, resGroupName string, subscriptionID string) (VMImage, error) {
+	return GetVirtualMachineImageContextE(context.Background(), vmName, resGroupName, subscriptionID)
+}
+
 // GetVirtualMachineImageContext gets the Image of the specified Azure Virtual Machine.
 // This function would fail the test if there is an error.
 // The ctx parameter supports cancellation and timeouts.
@@ -281,6 +383,23 @@ func extractVMImage(vm *armcompute.VirtualMachine) VMImage {
 	return img
 }
 
+// GetSizeOfVirtualMachine gets the Size Type of the specified Azure Virtual Machine.
+// This function would fail the test if there is an error.
+//
+// Deprecated: Use [GetSizeOfVirtualMachineContext] instead.
+func GetSizeOfVirtualMachine(t testing.TestingT, vmName string, resGroupName string, subscriptionID string) armcompute.VirtualMachineSizeTypes {
+	t.Helper()
+
+	return GetSizeOfVirtualMachineContext(t, context.Background(), vmName, resGroupName, subscriptionID)
+}
+
+// GetSizeOfVirtualMachineE gets the Size Type of the specified Azure Virtual Machine.
+//
+// Deprecated: Use [GetSizeOfVirtualMachineContextE] instead.
+func GetSizeOfVirtualMachineE(vmName string, resGroupName string, subscriptionID string) (armcompute.VirtualMachineSizeTypes, error) {
+	return GetSizeOfVirtualMachineContextE(context.Background(), vmName, resGroupName, subscriptionID)
+}
+
 // GetSizeOfVirtualMachineContext gets the Size Type of the specified Azure Virtual Machine.
 // This function would fail the test if there is an error.
 // The ctx parameter supports cancellation and timeouts.
@@ -309,6 +428,23 @@ func extractVMSize(vm *armcompute.VirtualMachine) armcompute.VirtualMachineSizeT
 	return *vm.Properties.HardwareProfile.VMSize
 }
 
+// GetVirtualMachineTags gets the Tags of the specified Virtual Machine as a map.
+// This function would fail the test if there is an error.
+//
+// Deprecated: Use [GetVirtualMachineTagsContext] instead.
+func GetVirtualMachineTags(t testing.TestingT, vmName string, resGroupName string, subscriptionID string) map[string]string {
+	t.Helper()
+
+	return GetVirtualMachineTagsContext(t, context.Background(), vmName, resGroupName, subscriptionID)
+}
+
+// GetVirtualMachineTagsE gets the Tags of the specified Virtual Machine as a map.
+//
+// Deprecated: Use [GetVirtualMachineTagsContextE] instead.
+func GetVirtualMachineTagsE(vmName string, resGroupName string, subscriptionID string) (map[string]string, error) {
+	return GetVirtualMachineTagsContextE(context.Background(), vmName, resGroupName, subscriptionID)
+}
+
 // GetVirtualMachineTagsContext gets the Tags of the specified Virtual Machine as a map.
 // This function would fail the test if there is an error.
 // The ctx parameter supports cancellation and timeouts.
@@ -351,6 +487,23 @@ func extractVMTags(vm *armcompute.VirtualMachine) map[string]string {
 // Get multiple Virtual Machines from a Resource Group
 // ***************************************************** //
 
+// ListVirtualMachinesForResourceGroup gets a list of all Virtual Machine names in the specified Resource Group.
+// This function would fail the test if there is an error.
+//
+// Deprecated: Use [ListVirtualMachinesForResourceGroupContext] instead.
+func ListVirtualMachinesForResourceGroup(t testing.TestingT, resGroupName string, subscriptionID string) []string {
+	t.Helper()
+
+	return ListVirtualMachinesForResourceGroupContext(t, context.Background(), resGroupName, subscriptionID)
+}
+
+// ListVirtualMachinesForResourceGroupE gets a list of all Virtual Machine names in the specified Resource Group.
+//
+// Deprecated: Use [ListVirtualMachinesForResourceGroupContextE] instead.
+func ListVirtualMachinesForResourceGroupE(resGroupName string, subscriptionID string) ([]string, error) {
+	return ListVirtualMachinesForResourceGroupContextE(context.Background(), resGroupName, subscriptionID)
+}
+
 // ListVirtualMachinesForResourceGroupContext gets a list of all Virtual Machine names in the specified Resource Group.
 // This function would fail the test if there is an error.
 // The ctx parameter supports cancellation and timeouts.
@@ -393,6 +546,25 @@ func listVirtualMachineNames(ctx context.Context, client *armcompute.VirtualMach
 	return vmDetails, nil
 }
 
+// GetVirtualMachinesForResourceGroup gets all Virtual Machine objects in the specified Resource Group. Each
+// VM Object represents the entire set of VM compute properties accessible by using the VM name as the map key.
+// This function would fail the test if there is an error.
+//
+// Deprecated: Use [GetVirtualMachinesForResourceGroupContext] instead.
+func GetVirtualMachinesForResourceGroup(t testing.TestingT, resGroupName string, subscriptionID string) map[string]armcompute.VirtualMachineProperties {
+	t.Helper()
+
+	return GetVirtualMachinesForResourceGroupContext(t, context.Background(), resGroupName, subscriptionID)
+}
+
+// GetVirtualMachinesForResourceGroupE gets all Virtual Machine objects in the specified Resource Group. Each
+// VM Object represents the entire set of VM compute properties accessible by using the VM name as the map key.
+//
+// Deprecated: Use [GetVirtualMachinesForResourceGroupContextE] instead.
+func GetVirtualMachinesForResourceGroupE(resGroupName string, subscriptionID string) (map[string]armcompute.VirtualMachineProperties, error) {
+	return GetVirtualMachinesForResourceGroupContextE(context.Background(), resGroupName, subscriptionID)
+}
+
 // GetVirtualMachinesForResourceGroupContext gets all Virtual Machine objects in the specified Resource Group. Each
 // VM Object represents the entire set of VM compute properties accessible by using the VM name as the map key.
 // This function would fail the test if there is an error.
@@ -467,6 +639,23 @@ func GetVirtualMachineContext(t testing.TestingT, ctx context.Context, vmName st
 	return vm
 }
 
+// GetVirtualMachine gets a Virtual Machine in the specified Azure Resource Group.
+// This function would fail the test if there is an error.
+//
+// Deprecated: Use [GetVirtualMachineContext] instead.
+func GetVirtualMachine(t testing.TestingT, vmName string, resGroupName string, subscriptionID string) *armcompute.VirtualMachine {
+	t.Helper()
+
+	return GetVirtualMachineContext(t, context.Background(), vmName, resGroupName, subscriptionID)
+}
+
+// GetVirtualMachineE gets a Virtual Machine in the specified Azure Resource Group.
+//
+// Deprecated: Use [GetVirtualMachineContextE] instead.
+func GetVirtualMachineE(vmName string, resGroupName string, subscriptionID string) (*armcompute.VirtualMachine, error) {
+	return GetVirtualMachineContextE(context.Background(), vmName, resGroupName, subscriptionID)
+}
+
 // GetVirtualMachineContextE gets a Virtual Machine in the specified Azure Resource Group.
 // The ctx parameter supports cancellation and timeouts.
 func GetVirtualMachineContextE(ctx context.Context, vmName string, resGroupName string, subscriptionID string) (*armcompute.VirtualMachine, error) {