utils

func Addr ¶ added in v0.0.29

func Addr[T any](t T) *T

Addr returns the address of t.

func ConvertModelToTerraformObject ¶ added in v0.0.33

func ConvertModelToTerraformObject[T TerraformObjectConvertible](
	ctx context.Context,
	model *T,
) (types.Object, diag.Diagnostics)

ConvertModelToTerraformObject converts a model pointer to a Terraform object. If the model is nil, returns a null object with the provided attribute types.

func GenerateUpdateTimestamp ¶ added in v0.0.23

func GenerateUpdateTimestamp() basetypes.StringValue

func IsKnown ¶ added in v0.0.11

func IsKnown(value attr.Value) bool

IsKnown returns true if an attribute value is known and not null.

func IsNull ¶ added in v0.0.40

func IsNull(value attr.Value) bool

IsNull returns true if an attribute value is known and null.

func ListIDsToModify ¶

func ListIDsToModify(
	ctx context.Context,
	plan, state types.List,
) (idsToAdd, idsToRemove []string, diags diag.Diagnostics)

ListIDsToModify takes a list of unique IDs from plan and state and returns the IDs to add and remove to get from the state to the plan. idsToAdd is the slice of IDs that are in the plan but not in the state. idsToRemove is the slice of IDs that are in the state but not in the plan. useful for resources with HostGroups, RuleGroups, etc.

func ListTypeAs ¶ added in v0.0.11

func ListTypeAs[T any](
	ctx context.Context,
	list types.List,
	diags *diag.Diagnostics,
) []T

ListTypeAs converts a types.List into a known []T.

func MapTypeAs ¶ added in v0.0.29

func MapTypeAs[T any](
	ctx context.Context,
	mapIn types.Map,
	diags *diag.Diagnostics,
) map[string]T

MapTypeAs converts a types.Map into a known map[string]T.

func MarkdownDescription ¶ added in v0.0.23

func MarkdownDescription(section, description string, apiScopes []scopes.Scope) string

MarkdownDescription generates a markdown description that works for generating terraform docs.

func MatchesWildcard ¶ added in v0.0.45

func MatchesWildcard(text, pattern string) bool

MatchesWildcard checks if a text string matches a wildcard pattern. The pattern can contain asterisks (*) which match zero or more characters. Matching is case-insensitive. Examples:

• "admin*" matches "admin@example.com", "Administrator", "ADMIN"
• "*admin*" matches "system-admin@example.com", "Admin"
• "example*more" matches "example-test-more", "EXAMPLEMORE"

func MissingElements ¶ added in v0.0.26

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

MissingElements checks if any elements in slice `a` are missing from slice `b`. It returns a slice containing the missing elements.

func OptionalString ¶ added in v0.0.33

func OptionalString(value *string) types.String

OptionalString converts a string pointer to types.String, returning null if pointer is nil or empty.

func PancicPrettyPrint ¶ added in v0.0.20

func PancicPrettyPrint(v interface{})

PancicPrettyPrint converts the interface into a json string and panics.

func PlanAwareStringValue ¶ added in v0.0.40

func PlanAwareStringValue(plan types.String, apiValue *string) types.String

PlanAwareStringValue converts a string pointer to a types.String, treating null and empty string as equivalent. This is useful for properties like description where the API often returns "" for descriptions that are unset. This allows us to handle cases where an omitted field and a field with "" value should be treated the same.

If the plan value is null and the API returns nil or empty string, the result will be null. Otherwise, the API value is used as-is (nil becomes null, empty string becomes empty string, etc.). This prevents Terraform inconsistent state errors when the API returns "" for omitted fields.

func SetIDsToModify ¶

func SetIDsToModify(
	ctx context.Context,
	plan, state types.Set,
) (idsToAdd, idsToRemove []string, diags diag.Diagnostics)

SetIDsToModify takes a set of IDs from plan and state and returns the IDs to add and remove to get from the state to the plan. idsToAdd is the slice of IDs that are in the plan but not in the state. idsToRemove is the slice of IDs that are in the state but not in the plan. useful for resources with HostGroups, RuleGroups, etc.

func SetInt64FromAPIIfNotZero ¶ added in v0.0.33

func SetInt64FromAPIIfNotZero(currentValue types.Int64, apiValue int64) types.Int64

SetInt64FromAPIIfNotZero sets an Int64 value from API response, keeping null if current is null and API value is 0.

func SetStringFromAPIIfNotEmpty ¶ added in v0.0.33

func SetStringFromAPIIfNotEmpty(currentValue types.String, apiValue string) types.String

SetStringFromAPIIfNotEmpty sets a String value from API response, keeping null if current is null and API value is "".

func SliceToListTypeObject ¶ added in v0.0.29

func SliceToListTypeObject[T any](
	ctx context.Context,
	elems []T,
	attrs map[string]attr.Type,
	diags *diag.Diagnostics,
) types.List

SliceToListTypeObject converts []T into types.List with an attr.Type of types.Object{}. Empty or null []T will result in an types.List with the state of Known. Nil pointers in the slice are filtered out before conversion.

func SliceToListTypeString ¶ added in v0.0.29

func SliceToListTypeString(
	ctx context.Context,
	elems []string,
	diags *diag.Diagnostics,
) types.List

SliceToListTypeString converts []string into types.List with an attr.Type of types.String. Empty []string will result in an empty types.List.

func ValidateEmptyIDs ¶ added in v0.0.20

func ValidateEmptyIDs(ctx context.Context, checkSet types.Set, attrPath string) diag.Diagnostics

ValidateEmptyIDs checks if a set contains empty IDs. Returns a attribute error at path.

func ValidateEmptyIDsList ¶ added in v0.0.29

func ValidateEmptyIDsList(
	ctx context.Context,
	checkList types.Set,
	attrPath string,
) diag.Diagnostics

ValidateEmptyIDsList checks if a list contains empty IDs. Returns a attribute error at path.