resource_ibm_network_public_ip.go

// Copyright IBM Corp. 2017, 2021 All Rights Reserved.
// Licensed under the Mozilla Public License v2.0

package classicinfrastructure

import (
	"fmt"
	"log"
	"net"
	"strconv"
	"strings"
	"time"

	"github.com/IBM-Cloud/terraform-provider-ibm/ibm/conns"
	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
	"github.com/softlayer/softlayer-go/datatypes"
	"github.com/softlayer/softlayer-go/filter"
	"github.com/softlayer/softlayer-go/helpers/product"
	"github.com/softlayer/softlayer-go/services"
	"github.com/softlayer/softlayer-go/session"
	"github.com/softlayer/softlayer-go/sl"
)

const (
	AdditionalServicesGlobalIpAddressesPackageType = "ADDITIONAL_SERVICES_GLOBAL_IP_ADDRESSES"

	GlobalIpMask = "id,ipAddress[ipAddress,id,note],destinationIpAddress[ipAddress]"
)

func ResourceIBMNetworkPublicIp() *schema.Resource {
	return &schema.Resource{
		Create:   resourceIBMNetworkPublicIpCreate,
		Read:     resourceIBMNetworkPublicIpRead,
		Update:   resourceIBMNetworkPublicIpUpdate,
		Delete:   resourceIBMNetworkPublicIpDelete,
		Exists:   resourceIBMNetworkPublicIpExists,
		Importer: &schema.ResourceImporter{},
		Timeouts: &schema.ResourceTimeout{
			Create: schema.DefaultTimeout(30 * time.Minute),
		},

		Schema: map[string]*schema.Schema{
			"ip_address": {
				Type:        schema.TypeString,
				Computed:    true,
				Description: "IP Address",
			},

			"routes_to": {
				Type:     schema.TypeString,
				Required: true,
				ValidateFunc: func(v interface{}, k string) (ws []string, errors []error) {
					address := v.(string)
					if net.ParseIP(address) == nil {
						errors = append(errors, fmt.Errorf("[ERROR] Invalid IP format: %s", address))
					}
					return
				},
				DiffSuppressFunc: func(k, o, n string, d *schema.ResourceData) bool {
					newRoutesTo := net.ParseIP(n)
					// Return true when n has the appropriate IPv6 format and
					// the compressed value of n equals the compressed value of o.
					return newRoutesTo != nil && (newRoutesTo.String() == net.ParseIP(o).String())
				},
				Description: "Route info",
			},
			"tags": {
				Type:        schema.TypeSet,
				Optional:    true,
				Elem:        &schema.Schema{Type: schema.TypeString},
				Set:         schema.HashString,
				Description: "List of tags",
			},
			"notes": {
				Type:        schema.TypeString,
				Optional:    true,
				Description: "Additional notes",
			},
		},
	}
}

func resourceIBMNetworkPublicIpCreate(d *schema.ResourceData, meta interface{}) error {

	sess := meta.(conns.ClientSession).SoftLayerSession()

	// Find price items with AdditionalServicesGlobalIpAddresses
	productOrderContainer, err := buildGlobalIpProductOrderContainer(d, sess, AdditionalServicesGlobalIpAddressesPackageType)
	if err != nil {
		// Find price items with AdditionalServices
		productOrderContainer, err = buildGlobalIpProductOrderContainer(d, sess, AdditionalServicesPackageType)
		if err != nil {
			return fmt.Errorf("[ERROR] Error creating network public ip: %s", err)
		}
	}

	log.Println("[INFO] Creating network public ip")

	receipt, err := services.GetProductOrderService(sess.SetRetries(0)).
		PlaceOrder(productOrderContainer, sl.Bool(false))
	if err != nil {
		return fmt.Errorf("[ERROR] Error during creation of network public ip: %s", err)
	}

	globalIp, err := findGlobalIpByOrderId(sess, *receipt.OrderId, d)
	if err != nil {
		return fmt.Errorf("[ERROR] Error during creation of network public ip: %s", err)
	}

	d.SetId(fmt.Sprintf("%d", *globalIp.Id))
	d.Set("ip_address", *globalIp.IpAddress.IpAddress)

	return resourceIBMNetworkPublicIpUpdate(d, meta)
}

func resourceIBMNetworkPublicIpRead(d *schema.ResourceData, meta interface{}) error {
	sess := meta.(conns.ClientSession).SoftLayerSession()
	service := services.GetNetworkSubnetIpAddressGlobalService(sess)

	globalIpId, err := strconv.Atoi(d.Id())
	if err != nil {
		return fmt.Errorf("[ERROR] Not  a valid network public ip ID, must be an integer: %s", err)
	}

	globalIp, err := service.Id(globalIpId).Mask(GlobalIpMask).GetObject()
	if err != nil {
		return fmt.Errorf("[ERROR] Error retrieving network public Ip: %s", err)
	}

	d.Set("ip_address", *globalIp.IpAddress.IpAddress)
	if globalIp.DestinationIpAddress != nil {
		d.Set("routes_to", *globalIp.DestinationIpAddress.IpAddress)
	}
	if globalIp.IpAddress.Note != nil {
		d.Set("notes", *globalIp.IpAddress.Note)
	}
	return nil
}

func resourceIBMNetworkPublicIpUpdate(d *schema.ResourceData, meta interface{}) error {
	sess := meta.(conns.ClientSession).SoftLayerSession()
	service := services.GetNetworkSubnetIpAddressGlobalService(sess)

	globalIpId, err := strconv.Atoi(d.Id())
	if err != nil {
		return fmt.Errorf("[ERROR] Not  a valid network public ip ID, must be an integer: %s", err)
	}

	routes_to := d.Get("routes_to").(string)
	if strings.Contains(routes_to, ":") && len(routes_to) != 39 {
		parts := strings.Split(routes_to, ":")
		for x, s := range parts {
			if s == "" {
				zeroes := 9 - len(parts)
				parts[x] = strings.Repeat("0000:", zeroes)[:(zeroes*4)+(zeroes-1)]
			} else {
				parts[x] = fmt.Sprintf("%04s", s)
			}
		}

		routes_to = strings.Join(parts, ":")
		d.Set("routes_to", routes_to)
	}

	_, err = service.Id(globalIpId).Route(sl.String(routes_to))
	if err != nil {
		return fmt.Errorf("[ERROR] Error editing network public Ip: %s", err)
	}
	// Update notes
	if d.HasChange("notes") {
		publicIp, err := service.Id(globalIpId).Mask(GlobalIpMask).GetObject()
		if err != nil {
			return fmt.Errorf("[ERROR] Error updating network public Ip: %s", err)
		}
		err = updatePublicIPNotes(d, sess, publicIp)
		if err != nil {
			return fmt.Errorf("[ERROR] Error editing network public Ip: %s", err)
		}
	}

	stateConf := &resource.StateChangeConf{
		Pending: []string{"pending"},
		Target:  []string{"complete"},
		Refresh: func() (interface{}, string, error) {
			transaction, err := service.Id(globalIpId).GetActiveTransaction()
			if err != nil {
				return datatypes.Network_Subnet_IpAddress_Global{}, "pending", err
			}
			if transaction.Id == nil {
				return datatypes.Network_Subnet_IpAddress_Global{}, "complete", nil
			}
			return datatypes.Network_Subnet_IpAddress_Global{}, "pending", nil
		},
		Timeout:    10 * time.Minute,
		Delay:      5 * time.Second,
		MinTimeout: 3 * time.Second,
	}

	pendingResult, err := stateConf.WaitForState()

	if err != nil {
		return fmt.Errorf("[ERROR] Error waiting for network public ip destination ip address to become active: %s", err)
	}

	if _, ok := pendingResult.(datatypes.Network_Subnet_IpAddress_Global); ok {
		return nil
	}

	return nil
}

func resourceIBMNetworkPublicIpDelete(d *schema.ResourceData, meta interface{}) error {
	sess := meta.(conns.ClientSession).SoftLayerSession()
	service := services.GetNetworkSubnetIpAddressGlobalService(sess)

	globalIpId, err := strconv.Atoi(d.Id())
	if err != nil {
		return fmt.Errorf("[ERROR] Not  a valid network public ip ID, must be an integer: %s", err)
	}

	billingItem, err := service.Id(globalIpId).GetBillingItem()
	if err != nil {
		return fmt.Errorf("[ERROR] Error deleting network public ip: %s", err)
	}

	if billingItem.Id == nil {
		return nil
	}

	_, err = services.GetBillingItemService(sess).Id(*billingItem.Id).CancelService()

	return err
}

func resourceIBMNetworkPublicIpExists(d *schema.ResourceData, meta interface{}) (bool, error) {
	sess := meta.(conns.ClientSession).SoftLayerSession()
	service := services.GetNetworkSubnetIpAddressGlobalService(sess)

	globalIpId, err := strconv.Atoi(d.Id())
	if err != nil {
		return false, fmt.Errorf("[ERROR] Not  a valid ID, must be an integer: %s", err)
	}

	result, err := service.Id(globalIpId).GetObject()
	if err != nil {
		if apiErr, ok := err.(sl.Error); ok && apiErr.StatusCode == 404 {
			return false, nil
		}
		return false, fmt.Errorf("[ERROR] Error retrieving network public ip: %s", err)
	}
	return result.Id != nil && *result.Id == globalIpId, nil
}

func findGlobalIpByOrderId(sess *session.Session, orderId int, d *schema.ResourceData) (datatypes.Network_Subnet_IpAddress_Global, error) {
	stateConf := &resource.StateChangeConf{
		Pending: []string{"pending"},
		Target:  []string{"complete"},
		Refresh: func() (interface{}, string, error) {
			globalIps, err := services.GetAccountService(sess).
				Filter(filter.Path("globalIpRecords.billingItem.orderItem.order.id").
					Eq(strconv.Itoa(orderId)).Build()).
				Mask("id,ipAddress[ipAddress]").
				GetGlobalIpRecords()
			if err != nil {
				return datatypes.Network_Subnet_IpAddress_Global{}, "", err
			}

			if len(globalIps) == 1 && globalIps[0].IpAddress != nil {
				return globalIps[0], "complete", nil
			} else if len(globalIps) == 0 || len(globalIps) == 1 {
				return datatypes.Network_Subnet_IpAddress_Global{}, "pending", nil
			} else {
				return nil, "", fmt.Errorf("[ERROR] Expected one network public ip: %s", err)
			}
		},
		Timeout:        d.Timeout(schema.TimeoutCreate),
		Delay:          5 * time.Second,
		MinTimeout:     3 * time.Second,
		NotFoundChecks: 24 * 60,
	}

	pendingResult, err := stateConf.WaitForState()

	if err != nil {
		return datatypes.Network_Subnet_IpAddress_Global{}, err
	}

	if result, ok := pendingResult.(datatypes.Network_Subnet_IpAddress_Global); ok {
		return result, nil
	}

	return datatypes.Network_Subnet_IpAddress_Global{},
		fmt.Errorf("[ERROR] Cannot find network public ip with order id '%d'", orderId)
}

func buildGlobalIpProductOrderContainer(d *schema.ResourceData, sess *session.Session, packageType string) (
	*datatypes.Container_Product_Order_Network_Subnet, error) {

	// 1. Get a package
	pkg, err := product.GetPackageByType(sess, packageType)
	if err != nil {
		return &datatypes.Container_Product_Order_Network_Subnet{}, err
	}

	// 2. Get all prices for the package
	productItems, err := product.GetPackageProducts(sess, *pkg.Id)
	if err != nil {
		return &datatypes.Container_Product_Order_Network_Subnet{}, err
	}

	// 3. Find global ip prices
	// the following looks for only IPV4 Global Ips only
	globalIpKeyname := "GLOBAL_IPV4"
	if strings.Contains(d.Get("routes_to").(string), ":") {
		globalIpKeyname = "GLOBAL_IPV6"
	}

	// 4. Select items with a matching keyname
	globalIpItems := []datatypes.Product_Item{}
	for _, item := range productItems {
		if *item.KeyName == globalIpKeyname {
			globalIpItems = append(globalIpItems, item)
		}
	}

	if len(globalIpItems) == 0 {
		return &datatypes.Container_Product_Order_Network_Subnet{},
			fmt.Errorf("[ERROR] No product items matching %s could be found", globalIpKeyname)
	}

	productOrderContainer := datatypes.Container_Product_Order_Network_Subnet{
		Container_Product_Order: datatypes.Container_Product_Order{
			PackageId: pkg.Id,
			Prices: []datatypes.Product_Item_Price{
				{
					Id: globalIpItems[0].Prices[0].Id,
				},
			},
			Quantity: sl.Int(1),
		},
	}

	return &productOrderContainer, nil
}

func updatePublicIPNotes(d *schema.ResourceData, sess *session.Session, publicIP datatypes.Network_Subnet_IpAddress_Global) error {
	id := *publicIP.IpAddress.Id
	notes := d.Get("notes").(string)

	if (publicIP.IpAddress.Note != nil && *publicIP.IpAddress.Note != notes) || (publicIP.IpAddress.Note == nil && notes != "") {
		_, err := services.GetNetworkSubnetIpAddressService(sess).
			Id(id).
			EditObject(&datatypes.Network_Subnet_IpAddress{Note: sl.String(notes)})
		if err != nil {
			return fmt.Errorf("[ERROR] Error adding note to network public IP (%d): %s", id, err)
		}
	}

	return nil
}