testutils_resource

Documentation

Index

• type ResourceCreationInfoType
• type ResourceInfo
• type TestableResource
  • func (tr *TestableResource) CreateResource(t *testing.T)
  • func (tr *TestableResource) DeleteResource(t *testing.T)

Types

type ResourceCreationInfoType

type ResourceCreationInfoType string

const (
	// General ID and Name enums for most resource creation
	ENUM_ID   ResourceCreationInfoType = "ENUM_ID"
	ENUM_NAME ResourceCreationInfoType = "ENUM_NAME"

	// Mapping Info for Mapping resources
	ENUM_SOURCE_ID ResourceCreationInfoType = "ENUM_SOURCE_ID"
	ENUM_TARGET_ID ResourceCreationInfoType = "ENUM_TARGET_ID"

	// Certificate Info for Certificate resources
	ENUM_ISSUER_DN     ResourceCreationInfoType = "ENUM_ISSUER_DN"
	ENUM_SERIAL_NUMBER ResourceCreationInfoType = "ENUM_SERIAL_NUMBER"

	// Language Info for Language resources
	ENUM_LOCALE ResourceCreationInfoType = "ENUM_LOCALE"

	// Template Info for Template resources
	ENUM_TEMPLATE_VARIANT         ResourceCreationInfoType = "ENUM_TEMPLATE_VARIANT"
	ENUM_TEMPLATE_DELIVERY_METHOD ResourceCreationInfoType = "ENUM_TEMPLATE_DELIVERY_METHOD"

	// Schema Info for Schema Attribute resources
	ENUM_SCHEMA_ID   ResourceCreationInfoType = "ENUM_SCHEMA_ID"
	ENUM_SCHEMA_NAME ResourceCreationInfoType = "ENUM_SCHEMA_NAME"

	// Miscellaneous Info for resources that don't fit the above
	ENUM_TYPE          ResourceCreationInfoType = "ENUM_TYPE"
	ENUM_CONTEXT_TYPE  ResourceCreationInfoType = "ENUM_CONTEXT_TYPE"
	ENUM_CREDENTIAL    ResourceCreationInfoType = "ENUM_CREDENTIAL" //#nosec G101 -- This is not hard-coded credentials
	ENUM_SOURCE_REF_ID ResourceCreationInfoType = "ENUM_SOURCE_REF_ID"
)

type ResourceInfo

type ResourceInfo struct {
	CreationInfo map[ResourceCreationInfoType]string
	DeletionIds  []string
}

type TestableResource

type TestableResource struct {
	// SDK client used in creation and deletion of this TestableResource
	ClientInfo *connector.ClientInfo

	// Creation function for this TestableResources
	CreateFunc func(*testing.T, *connector.ClientInfo, string, ...string) ResourceInfo

	// TestableResource information like ID, Name, etc.
	ResourceInfo ResourceInfo

	// Deletion function for this TestableResources
	DeleteFunc func(*testing.T, *connector.ClientInfo, string, ...string)

	// TestableResources required to be created before this TestableResource can be created
	Dependencies []*TestableResource

	// ExportableResource that this TestableResource is testing
	ExportableResource connector.ExportableResource
}

The TestableResource struct is used to create and delete resources in a test, without prior configuration needed on a service. This allows different developers and contributors to provide their own test service credentials, which would consistently create and clean configuration needed for testing without requiring shared credentials on a central test service.

Further, this struct is notably decoupled from resource unit tests and service connector integration test. This allows for both tests to leverage the same struct, without worrying about setup and cleanup. Golang 'defer' applies to the current scope, so this allows for each test to have its own setup and cleanup, without knowing which test ran first or if the resource is still needed for subsequent tests.

Finally, this struct allows the integration test to initialize terraform only once, which makes the terraform --generate-config-out testing almost an order of magnitude faster.

func (*TestableResource) CreateResource

func (tr *TestableResource) CreateResource(t *testing.T)

func (*TestableResource) DeleteResource

func (tr *TestableResource) DeleteResource(t *testing.T)