github.com/vmware/go-vcloud-director/v2@v2.24.0/govcd/lbappprofile.go

/*
 * Copyright 2019 VMware, Inc.  All rights reserved.  Licensed under the Apache v2 License.
 */

package govcd

import (
	"fmt"
	"net/http"

	"github.com/vmware/go-vcloud-director/v2/types/v56"
)

// CreateLbAppProfile creates a load balancer application profile based on mandatory fields. It is a
// synchronous operation. It returns created object with all fields (including ID) populated or an error.
func (egw *EdgeGateway) CreateLbAppProfile(lbAppProfileConfig *types.LbAppProfile) (*types.LbAppProfile, error) {
	if err := validateCreateLbAppProfile(lbAppProfileConfig, egw); err != nil {
		return nil, err
	}

	httpPath, err := egw.buildProxiedEdgeEndpointURL(types.LbAppProfilePath)
	if err != nil {
		return nil, fmt.Errorf("could not get Edge Gateway API endpoint: %s", err)
	}
	// We expect to get http.StatusCreated or if not an error of type types.NSXError
	resp, err := egw.client.ExecuteRequestWithCustomError(httpPath, http.MethodPost, types.AnyXMLMime,
		"error creating load balancer application profile: %s", lbAppProfileConfig, &types.NSXError{})
	if err != nil {
		return nil, err
	}

	// Location header should look similar to:
	// [/network/edges/edge-3/loadbalancer/config/applicationprofiles/applicationProfile-4]
	lbAppProfileID, err := extractNsxObjectIdFromPath(resp.Header.Get("Location"))
	if err != nil {
		return nil, err
	}

	readAppProfile, err := egw.GetLbAppProfileById(lbAppProfileID)
	if err != nil {
		return nil, fmt.Errorf("unable to retrieve application profile with ID (%s) after creation: %s",
			lbAppProfileID, err)
	}
	return readAppProfile, nil
}

// GetLbAppProfiles returns a list of all LB application profiles in a given edge gateway
func (egw *EdgeGateway) GetLbAppProfiles() ([]*types.LbAppProfile, error) {
	httpPath, err := egw.buildProxiedEdgeEndpointURL(types.LbAppProfilePath)
	if err != nil {
		return nil, fmt.Errorf("could not get Edge Gateway API endpoint: %s", err)
	}

	// Anonymous struct to unwrap response
	lbAppProfileResponse := &struct {
		LbAppProfiles []*types.LbAppProfile `xml:"applicationProfile"`
	}{}

	// This query returns all application profiles as the API does not have filtering options
	_, err = egw.client.ExecuteRequest(httpPath, http.MethodGet, types.AnyXMLMime,
		"unable to read load balancer application profile: %s", nil, lbAppProfileResponse)
	if err != nil {
		return nil, err
	}
	return lbAppProfileResponse.LbAppProfiles, nil
}

// getLbAppProfile is able to find the types.LbAppProfile type by Name and/or ID.
// If both - Name and ID are specified it performs a lookup by ID and returns an error if the specified name and found
// name do not match.
func (egw *EdgeGateway) getLbAppProfile(lbAppProfileConfig *types.LbAppProfile) (*types.LbAppProfile, error) {
	if err := validateGetLbAppProfile(lbAppProfileConfig, egw); err != nil {
		return nil, err
	}

	lbAppProfiles, err := egw.GetLbAppProfiles()
	if err != nil {
		return nil, err
	}

	// Search for application profile by ID or by Name
	for _, profile := range lbAppProfiles {
		// If ID was specified for lookup - look for the same ID
		if lbAppProfileConfig.ID != "" && profile.ID == lbAppProfileConfig.ID {
			return profile, nil
		}

		// If Name was specified for lookup - look for the same Name
		if lbAppProfileConfig.Name != "" && profile.Name == lbAppProfileConfig.Name {
			// We found it by name. Let's verify if search ID was specified and it matches the lookup object
			if lbAppProfileConfig.ID != "" && profile.ID != lbAppProfileConfig.ID {
				return nil, fmt.Errorf("load balancer application profile was found by name (%s)"+
					", but its ID (%s) does not match specified ID (%s)",
					profile.Name, profile.ID, lbAppProfileConfig.ID)
			}
			return profile, nil
		}
	}

	return nil, ErrorEntityNotFound
}

// GetLbAppProfileById wraps getLbAppProfile and needs only an ID for lookup
func (egw *EdgeGateway) GetLbAppProfileById(id string) (*types.LbAppProfile, error) {
	return egw.getLbAppProfile(&types.LbAppProfile{ID: id})
}

// GetLbAppProfileByName wraps getLbAppProfile and needs only a Name for lookup
func (egw *EdgeGateway) GetLbAppProfileByName(name string) (*types.LbAppProfile, error) {
	return egw.getLbAppProfile(&types.LbAppProfile{Name: name})
}

// UpdateLbAppProfile updates types.LbAppProfile with all fields. At least name or ID must be specified.
// If both - Name and ID are specified it performs a lookup by ID and returns an error if the specified name and found
// name do not match.
func (egw *EdgeGateway) UpdateLbAppProfile(lbAppProfileConfig *types.LbAppProfile) (*types.LbAppProfile, error) {
	err := validateUpdateLbAppProfile(lbAppProfileConfig, egw)
	if err != nil {
		return nil, err
	}

	lbAppProfileConfig.ID, err = egw.getLbAppProfileIdByNameId(lbAppProfileConfig.Name, lbAppProfileConfig.ID)
	if err != nil {
		return nil, fmt.Errorf("cannot update load balancer application profile: %s", err)
	}

	httpPath, err := egw.buildProxiedEdgeEndpointURL(types.LbAppProfilePath + lbAppProfileConfig.ID)
	if err != nil {
		return nil, fmt.Errorf("could not get Edge Gateway API endpoint: %s", err)
	}

	// Result should be 204, if not we expect an error of type types.NSXError
	_, err = egw.client.ExecuteRequestWithCustomError(httpPath, http.MethodPut, types.AnyXMLMime,
		"error while updating load balancer application profile : %s", lbAppProfileConfig, &types.NSXError{})
	if err != nil {
		return nil, err
	}

	readAppProfile, err := egw.GetLbAppProfileById(lbAppProfileConfig.ID)
	if err != nil {
		return nil, fmt.Errorf("unable to retrieve application profile with ID (%s) after update: %s",
			lbAppProfileConfig.ID, err)
	}
	return readAppProfile, nil
}

// DeleteLbAppProfile is able to delete the types.LbAppProfile type by Name and/or ID.
// If both - Name and ID are specified it performs a lookup by ID and returns an error if the specified name and found
// name do not match.
func (egw *EdgeGateway) DeleteLbAppProfile(lbAppProfileConfig *types.LbAppProfile) error {
	err := validateDeleteLbAppProfile(lbAppProfileConfig, egw)
	if err != nil {
		return err
	}

	lbAppProfileConfig.ID, err = egw.getLbAppProfileIdByNameId(lbAppProfileConfig.Name, lbAppProfileConfig.ID)
	if err != nil {
		return fmt.Errorf("cannot delete load balancer application profile: %s", err)
	}

	httpPath, err := egw.buildProxiedEdgeEndpointURL(types.LbAppProfilePath + lbAppProfileConfig.ID)
	if err != nil {
		return fmt.Errorf("could not get Edge Gateway API endpoint: %s", err)
	}

	_, err = egw.client.ExecuteRequestWithCustomError(httpPath, http.MethodDelete, types.AnyXMLMime,
		"unable to delete application profile: %s", nil, &types.NSXError{})
	if err != nil {
		return err
	}

	return nil
}

// DeleteLbAppProfileById wraps DeleteLbAppProfile and requires only ID for deletion
func (egw *EdgeGateway) DeleteLbAppProfileById(id string) error {
	return egw.DeleteLbAppProfile(&types.LbAppProfile{ID: id})
}

// DeleteLbAppProfileByName wraps DeleteLbAppProfile and requires only Name for deletion
func (egw *EdgeGateway) DeleteLbAppProfileByName(name string) error {
	return egw.DeleteLbAppProfile(&types.LbAppProfile{Name: name})
}

func validateCreateLbAppProfile(lbAppProfileConfig *types.LbAppProfile, egw *EdgeGateway) error {
	if !egw.HasAdvancedNetworking() {
		return fmt.Errorf("only advanced edge gateways support load balancers")
	}

	if lbAppProfileConfig.Name == "" {
		return fmt.Errorf("load balancer application profile Name cannot be empty")
	}

	return nil
}

func validateGetLbAppProfile(lbAppProfileConfig *types.LbAppProfile, egw *EdgeGateway) error {
	if !egw.HasAdvancedNetworking() {
		return fmt.Errorf("only advanced edge gateways support load balancers")
	}

	if lbAppProfileConfig.ID == "" && lbAppProfileConfig.Name == "" {
		return fmt.Errorf("to read load balancer application profile at least one of `ID`, `Name`" +
			" fields must be specified")
	}

	return nil
}

func validateUpdateLbAppProfile(lbAppProfileConfig *types.LbAppProfile, egw *EdgeGateway) error {
	// Update and create have the same requirements for now
	return validateCreateLbAppProfile(lbAppProfileConfig, egw)
}

func validateDeleteLbAppProfile(lbAppProfileConfig *types.LbAppProfile, egw *EdgeGateway) error {
	// Read and delete have the same requirements for now
	return validateGetLbAppProfile(lbAppProfileConfig, egw)
}

// getLbAppProfileIdByNameId checks if at least name or ID is set and returns the ID.
// If the ID is specified - it passes through the ID. If only name was specified
// it will lookup the object by name and return the ID.
func (egw *EdgeGateway) getLbAppProfileIdByNameId(name, id string) (string, error) {
	if name == "" && id == "" {
		return "", fmt.Errorf("at least Name or ID must be specific to find load balancer "+
			"application profile got name (%s) ID (%s)", name, id)
	}
	if id != "" {
		return id, nil
	}

	// if only name was specified, ID must be found, because only ID can be used in request path
	readlbAppProfile, err := egw.GetLbAppProfileByName(name)
	if err != nil {
		return "", fmt.Errorf("unable to find load balancer application profile by name: %s", err)
	}
	return readlbAppProfile.ID, nil
}