resource_vlan.go

package ddcloud

import (
	"fmt"
	"log"
	"time"

	"github.com/DimensionDataResearch/dd-cloud-compute-terraform/retry"
	"github.com/DimensionDataResearch/go-dd-cloud-compute/compute"
	"github.com/hashicorp/terraform/helper/schema"
)

const (
	resourceKeyVLANNetworkDomainID           = "networkdomain"
	resourceKeyVLANName                      = "name"
	resourceKeyVLANDescription               = "description"
	resourceKeyVLANIPv4BaseAddress           = "ipv4_base_address"
	resourceKeyVLANIPv4PrefixSize            = "ipv4_prefix_size"
	resourceKeyVLANIPv6BaseAddress           = "ipv6_base_address"
	resourceKeyVLANIPv6PrefixSize            = "ipv6_prefix_size"
	resourceKeyAttachedVlanGatewayAddressing = "attached_vlan_gateway_addressing"
	resourceKeyDetachedGatewayAddress        = "detached_vlan_gateway_address"
	resourceCreateTimeoutVLAN                = 5 * time.Minute
	resourceEditTimeoutVLAN                  = 3 * time.Minute
	resourceDeleteTimeoutVLAN                = 5 * time.Minute

	// No more than 3 at a time for now
	deployTimeoutVLAN = 3 * resourceCreateTimeoutVLAN
	editTimeoutVLAN   = 3 * resourceEditTimeoutVLAN
	deleteTimeoutVLAN = 3 * resourceDeleteTimeoutVLAN
)

func resourceVLAN() *schema.Resource {
	return &schema.Resource{
		Create: resourceVLANCreate,
		Read:   resourceVLANRead,
		Update: resourceVLANUpdate,
		Delete: resourceVLANDelete,
		Importer: &schema.ResourceImporter{
			State: resourceVLANImport,
		},

		Schema: map[string]*schema.Schema{
			resourceKeyVLANNetworkDomainID: &schema.Schema{
				Type:        schema.TypeString,
				Required:    true,
				Description: "The Id of the network domain in which the VLAN is deployed.",
			},
			resourceKeyVLANName: &schema.Schema{
				Type:        schema.TypeString,
				Required:    true,
				Description: "The VLAN display name.",
			},
			resourceKeyVLANDescription: &schema.Schema{
				Type:        schema.TypeString,
				Optional:    true,
				Default:     "",
				Description: "The VLAN description.",
			},
			resourceKeyVLANIPv4BaseAddress: &schema.Schema{
				Type:        schema.TypeString,
				Required:    true,
				ForceNew:    true,
				Description: "The VLAN's private IPv4 base address.",
			},
			resourceKeyVLANIPv4PrefixSize: &schema.Schema{
				Type:        schema.TypeInt,
				Required:    true,
				ForceNew:    true,
				Description: "The VLAN's private IPv4 prefix length.",
			},
			resourceKeyVLANIPv6BaseAddress: &schema.Schema{
				Type:        schema.TypeString,
				Computed:    true,
				Description: "The VLAN's IPv6 base address.",
			},
			resourceKeyVLANIPv6PrefixSize: &schema.Schema{
				Type:        schema.TypeInt,
				Computed:    true,
				Description: "The VLAN's IPv6 prefix length.",
			},
			resourceKeyAttachedVlanGatewayAddressing: &schema.Schema{
				Type:          schema.TypeString,
				Optional:      true,
				Description:   "A String literal LOW or HIGH.",
				ConflictsWith: []string{resourceKeyDetachedGatewayAddress},
			},
			resourceKeyDetachedGatewayAddress: &schema.Schema{
				Type:          schema.TypeString,
				Optional:      true,
				Description:   "IPv4 Address representation of the desired IPv4 Gateway.",
				ConflictsWith: []string{resourceKeyAttachedVlanGatewayAddressing},
			},
		},
	}
}

// Create a VLAN resource.
func resourceVLANCreate(data *schema.ResourceData, provider interface{}) error {
	var (
		networkDomainID, name, description, ipv4BaseAddress, gatewayAddressing, gatewayAddress string
		ipv4PrefixSize                                                                         int
	)

	networkDomainID = data.Get(resourceKeyVLANNetworkDomainID).(string)
	name = data.Get(resourceKeyVLANName).(string)
	description = data.Get(resourceKeyVLANDescription).(string)
	ipv4BaseAddress = data.Get(resourceKeyVLANIPv4BaseAddress).(string)
	ipv4PrefixSize = data.Get(resourceKeyVLANIPv4PrefixSize).(int)
	gatewayAddressing = data.Get(resourceKeyAttachedVlanGatewayAddressing).(string)
	gatewayAddress = data.Get(resourceKeyDetachedGatewayAddress).(string)

	log.Printf("Create VLAN '%s' ('%s') in network domain '%s' (IPv4 network = '%s/%d') AttachedGatewayAddressing:%s, DetachedGatewayAddress:%s ",
		name, description, networkDomainID, ipv4BaseAddress, ipv4PrefixSize, gatewayAddressing, gatewayAddress)

	providerState := provider.(*providerState)
	apiClient := providerState.Client()

	var (
		vlanID string
		err    error
	)
	operationDescription := fmt.Sprintf("Create VLAN '%s'", name)
	err = retry.Action(operationDescription, deployTimeoutVLAN, func(context retry.Context) {
		// CloudControl has issues if more than one asynchronous operation is initated at a time (returns UNEXPECTED_ERROR).
		asyncLock := providerState.AcquireAsyncOperationLock(operationDescription)
		defer asyncLock.Release() // Released at the end of the current attempt.

		var deployError error
		vlanID, deployError = apiClient.DeployVLAN(networkDomainID, name, description, ipv4BaseAddress, ipv4PrefixSize, gatewayAddressing, gatewayAddress)
		if deployError != nil {
			if compute.IsResourceBusyError(deployError) {
				context.Retry()
			} else {
				context.Fail(deployError)
			}
		}

		asyncLock.Release()
	})
	if err != nil {
		return err
	}

	data.SetId(vlanID)

	log.Printf("VLAN '%s' is being provisioned...", vlanID)

	deployedResource, err := apiClient.WaitForDeploy(compute.ResourceTypeVLAN, vlanID, resourceCreateTimeoutVLAN)
	if err != nil {
		return err
	}

	vlan := deployedResource.(*compute.VLAN)
	data.Set(resourceKeyVLANIPv6BaseAddress, vlan.IPv6Range.BaseAddress)
	data.Set(resourceKeyVLANIPv6PrefixSize, vlan.IPv6Range.PrefixSize)

	return nil
}

// Read a VLAN resource.
func resourceVLANRead(data *schema.ResourceData, provider interface{}) error {
	id := data.Id()
	networkDomainID := data.Get(resourceKeyVLANNetworkDomainID).(string)
	name := data.Get(resourceKeyVLANName).(string)
	description := data.Get(resourceKeyVLANDescription).(string)
	ipv4BaseAddress := data.Get(resourceKeyVLANIPv4BaseAddress).(string)
	ipv4PrefixSize := data.Get(resourceKeyVLANIPv4PrefixSize).(int)
	ipv6BaseAddress := data.Get(resourceKeyVLANIPv6BaseAddress).(string)
	ipv6PrefixSize := data.Get(resourceKeyVLANIPv6PrefixSize).(int)

	log.Printf("Read VLAN '%s' (Name = '%s', description = '%s') in network domain '%s' (IPv4 network = '%s/%d', IPv6 network = '%s/%d').", id, name, description, networkDomainID, ipv4BaseAddress, ipv4PrefixSize, ipv6BaseAddress, ipv6PrefixSize)

	apiClient := provider.(*providerState).Client()

	vlan, err := apiClient.GetVLAN(id)
	if err != nil {
		return err
	}

	if vlan != nil {
		data.Set(resourceKeyVLANName, vlan.Name)
		data.Set(resourceKeyVLANDescription, vlan.Description)
		data.Set(resourceKeyVLANIPv4BaseAddress, vlan.IPv4Range.BaseAddress)
		data.Set(resourceKeyVLANIPv4PrefixSize, vlan.IPv4Range.PrefixSize)
		data.Set(resourceKeyVLANIPv6BaseAddress, vlan.IPv6Range.BaseAddress)
		data.Set(resourceKeyVLANIPv6PrefixSize, vlan.IPv6Range.PrefixSize)
	} else {
		data.SetId("") // Mark resource as deleted.
	}

	return nil
}

// Update a VLAN resource.
func resourceVLANUpdate(data *schema.ResourceData, provider interface{}) error {
	var (
		id, ipv4BaseAddress, name, description string
		newName, newDescription                *string
		ipv4PrefixSize                         int
	)

	id = data.Id()

	name = data.Get(resourceKeyVLANName).(string)
	if data.HasChange(resourceKeyVLANName) {
		newName = &name
	}

	if data.HasChange(resourceKeyVLANDescription) {
		description = data.Get(resourceKeyVLANDescription).(string)
		newDescription = &description
	}

	log.Printf("Update VLAN '%s' (name = '%s', description = '%s', IPv4 network = '%s/%d').", id, name, description, ipv4BaseAddress, ipv4PrefixSize)

	providerState := provider.(*providerState)
	apiClient := providerState.Client()

	if newName == nil && newDescription == nil {
		return nil
	}

	operationDescription := fmt.Sprintf("Edit VLAN '%s'", name)

	return retry.Action(operationDescription, deployTimeoutVLAN, func(context retry.Context) {
		// CloudControl has issues if more than one asynchronous operation is initated at a time (returns UNEXPECTED_ERROR).
		asyncLock := providerState.AcquireAsyncOperationLock(operationDescription)
		defer asyncLock.Release() // Released at the end of the current attempt.

		editError := apiClient.EditVLAN(id, newName, newDescription)
		if editError != nil {
			if compute.IsResourceBusyError(editError) {
				context.Retry()
			} else {
				context.Fail(editError)
			}
		}

		asyncLock.Release()
	})
}

// Delete a VLAN resource.
func resourceVLANDelete(data *schema.ResourceData, provider interface{}) error {
	id := data.Id()
	name := data.Get(resourceKeyVLANName).(string)
	networkDomainID := data.Get(resourceKeyVLANNetworkDomainID).(string)

	log.Printf("Delete VLAN '%s' ('%s') in network domain '%s'.", id, name, networkDomainID)

	providerState := provider.(*providerState)
	apiClient := providerState.Client()

	operationDescription := fmt.Sprintf("Delete VLAN '%s'", id)
	err := providerState.Retry().Action(operationDescription, deleteTimeoutVLAN, func(context retry.Context) {
		// CloudControl has issues if more than one asynchronous operation is initated at a time (returns UNEXPECTED_ERROR).
		asyncLock := providerState.AcquireAsyncOperationLock(operationDescription)
		defer asyncLock.Release() // Released once the current attempt is complete.

		deleteError := apiClient.DeleteVLAN(id)
		if deleteError != nil {
			if compute.IsResourceBusyError(deleteError) {
				context.Retry()
			} else {
				context.Fail(deleteError)
			}
		}

		asyncLock.Release()
	})
	if err != nil {
		return err
	}

	log.Printf("VLAN '%s' is being deleted...", id)

	return apiClient.WaitForDelete(compute.ResourceTypeVLAN, id, resourceDeleteTimeoutServer)
}

// Import data for an existing VLAN.
func resourceVLANImport(data *schema.ResourceData, provider interface{}) (importedData []*schema.ResourceData, err error) {
	providerState := provider.(*providerState)
	apiClient := providerState.Client()

	vlanID := data.Id()
	log.Printf("Import VLAN '%s'.", vlanID)

	vlan, err := apiClient.GetVLAN(vlanID)
	if err != nil {
		return
	}
	if vlan == nil {
		err = fmt.Errorf("VLAN '%s' not found", vlanID)

		return
	}

	data.Set(resourceKeyVLANName, vlan.Name)
	data.Set(resourceKeyVLANDescription, vlan.Description)
	data.Set(resourceKeyVLANIPv4BaseAddress, vlan.IPv4Range.BaseAddress)
	data.Set(resourceKeyVLANIPv4PrefixSize, vlan.IPv4Range.PrefixSize)
	data.Set(resourceKeyVLANIPv6BaseAddress, vlan.IPv6Range.BaseAddress)
	data.Set(resourceKeyVLANIPv6PrefixSize, vlan.IPv6Range.PrefixSize)
	data.Set(resourceKeyVLANNetworkDomainID, vlan.NetworkDomain.ID)
	data.Set(resourceKeyDetachedGatewayAddress, vlan.IPv4GatewayAddress)
	data.Set(resourceKeyAttachedVlanGatewayAddressing, vlan.GatewayAddressing)
	importedData = []*schema.ResourceData{data}

	return
}