utils

Documentation

Index

• Constants
• func CheckFileExists(filePath string) bool
• func CreateTransport() *http.Transport
• func DecodeInterfaceToStruct(input, output interface{}) error
• func DecodeStructToMap(input interface{}) (map[string]interface{}, error)
• func DiffEmptyIps(_, old, new string, _ *schema.ResourceData) bool
• func DiffSlice(slice1 []string, slice2 []string) []string
• func DiffSliceOneWay(a, b []string) []string
• func DiffToLower(_, old, new string, _ *schema.ResourceData) bool
• func DiffWithoutNewLines(_, old, new string, _ *schema.ResourceData) bool
• func GenerateEmail() string
• func GenerateImmutableError(resource, field string) error
• func GenerateSetError(resource, field string, err error) error
• func IsCamelCaseEqualToSnakeCase(a, b string) bool
• func IsSnakeEqualToCamelCase(a, b string) bool
• func IsValidUUID(uuid string) bool
• func IsValueInSliceOfMap[T comparable](sliceOfMaps []interface{}, key string, value T) bool
• func MergeMaps(maps ...map[string]any) map[string]any
• func PointerEmptyToNil() mapstructure.DecodeHookFuncType
• func ReadPublicKey(pathOrKey string) (string, error)
• func RemoveNewLines(s string) string
• func SetPropWithNilCheck(m map[string]interface{}, prop string, v interface{})
• func TestImageNotNull(resource, attribute string) resource.TestCheckFunc
• func TestNotEmptySlice(resource, attribute string) resource.TestCheckFunc
• func TestValueInSlice(resource, attribute, value string) resource.TestCheckFunc
• func WaitForResourceToBeDeleted(ctx context.Context, d *schema.ResourceData, fn IsResourceDeletedFunc) error
• func WaitForResourceToBeReady(ctx context.Context, d *schema.ResourceData, fn ResourceReadyFunc) error
• func WriteToFile(name, value string) error
• type ApiResponseInfo
• type IsResourceDeletedFunc
• type ResourceReadyFunc

Constants

const DefaultTimeout = 60 * time.Minute

Functions

func CheckFileExists

func CheckFileExists(filePath string) bool

func CreateTransport

func CreateTransport() *http.Transport

CreateTransport - creates customizable transport for http clients

func DecodeInterfaceToStruct

func DecodeInterfaceToStruct(input, output interface{}) error

DecodeInterfaceToStruct can decode from interface{}, or from []interface will turn "" into nil values takes snake_case fields and decodes them into camelcase fields of struct used to decode values from TypeList and TypeSet of schema(`d`) directly into sdk structs

func DecodeStructToMap

func DecodeStructToMap(input interface{}) (map[string]interface{}, error)

DecodeStructToMap SDK struct to map[string]interface{}

func DiffEmptyIps

func DiffEmptyIps(_, old, new string, _ *schema.ResourceData) bool

DiffEmptyIps suppress difference when empty value for array is overwritten by API and assigned an actual IP address

func DiffSlice

func DiffSlice(slice1 []string, slice2 []string) []string

func DiffSliceOneWay

func DiffSliceOneWay(a, b []string) []string

DiffSliceOneWay returns the elements in `a` that aren't in `b`.

func DiffToLower

func DiffToLower(_, old, new string, _ *schema.ResourceData) bool

DiffToLower terraform suppress differences between lower and upper

func DiffWithoutNewLines

func DiffWithoutNewLines(_, old, new string, _ *schema.ResourceData) bool

DiffWithoutNewLines terraform suppress differences between newlines

func GenerateEmail

func GenerateEmail() string

func GenerateImmutableError

func GenerateImmutableError(resource, field string) error

func GenerateSetError

func GenerateSetError(resource, field string, err error) error

func IsCamelCaseEqualToSnakeCase

func IsCamelCaseEqualToSnakeCase(a, b string) bool

func IsSnakeEqualToCamelCase

func IsSnakeEqualToCamelCase(a, b string) bool

func IsValidUUID

func IsValidUUID(uuid string) bool

func IsValueInSliceOfMap

func IsValueInSliceOfMap[T comparable](sliceOfMaps []interface{}, key string, value T) bool

checks if value['1'] of key[`id`] is present inside a slice of maps[string]interface{}

func MergeMaps

func MergeMaps(maps ...map[string]any) map[string]any

MergeMaps merges a slice of map[string]any entries into one map. Note: Maps should be disjoint, otherwise overlapping keys will be overwritten.

func PointerEmptyToNil

func PointerEmptyToNil() mapstructure.DecodeHookFuncType

func ReadPublicKey

func ReadPublicKey(pathOrKey string) (string, error)

ReadPublicKey Reads public key from file or directly provided and returns key string if valid

func RemoveNewLines

func RemoveNewLines(s string) string

func SetPropWithNilCheck

func SetPropWithNilCheck(m map[string]interface{}, prop string, v interface{})

func TestImageNotNull

func TestImageNotNull(resource, attribute string) resource.TestCheckFunc

func TestNotEmptySlice

func TestNotEmptySlice(resource, attribute string) resource.TestCheckFunc

func TestValueInSlice

func TestValueInSlice(resource, attribute, value string) resource.TestCheckFunc

func WaitForResourceToBeDeleted

func WaitForResourceToBeDeleted(ctx context.Context, d *schema.ResourceData, fn IsResourceDeletedFunc) error

WaitForResourceToBeDeleted - keeps retrying until resource is not found(404), or until ctx is cancelled

func WaitForResourceToBeReady

func WaitForResourceToBeReady(ctx context.Context, d *schema.ResourceData, fn ResourceReadyFunc) error

WaitForResourceToBeReady - keeps retrying until resource is ready(true is returned), or until err is thrown, or ctx is cancelled

func WriteToFile

func WriteToFile(name, value string) error

WriteToFile - creates the file and writes 'value' to it.

Types

type ApiResponseInfo

type ApiResponseInfo interface {
	HttpNotFound() bool
	LogInfo()
}

ApiResponseInfo - interface over different ApiResponse types from sdks

type IsResourceDeletedFunc

type IsResourceDeletedFunc func(ctx context.Context, d *schema.ResourceData) (bool, error)

IsResourceDeletedFunc polls api to see if resource exists based on id

type ResourceReadyFunc

type ResourceReadyFunc func(ctx context.Context, d *schema.ResourceData) (bool, error)

ResourceReadyFunc polls api to see if resource exists based on id