enumeration

Documentation

Index

• type EnumerateInput
• type EnumerateOutput
• type Enumerator
• type Filter
• type GetSchemasOutput
• type MockFilter
  • func NewMockFilter(t interface{ ... }) *MockFilter
  • func (_m *MockFilter) IsResourceIgnored(res *resource.Resource) bool
  • func (_m *MockFilter) IsTypeIgnored(ty resource.ResourceType) bool
• type ProgressCounter
• type RefreshInput
• type RefreshOutput
• type Refresher

Types

type EnumerateInput

type EnumerateInput struct {
	ResourceTypes []string
}

type EnumerateOutput

type EnumerateOutput struct {
	// Resources is a map of resources by type. Every listed resource type will
	// have a key in the map. The value will be either nil or an empty slice if
	// no resources of that type were found.
	Resources map[string][]*resource.Resource

	// Timings is map of list durations by resource type. This aids understanding
	// which resource types took the most time to list.
	Timings map[string]time.Duration

	// Diagnostics contains messages and errors that arose during the list operation.
	// If the diagnostic is associated with a resource type, the ResourceType()
	// call will indicate which type. If associated with a resource, the Resource()
	// call will indicate which resource.
	Diagnostics diagnostic.Diagnostics
}

type Enumerator

type Enumerator interface {
	Enumerate(*EnumerateInput) (*EnumerateOutput, error)
}

type Filter

type Filter interface {
	IsTypeIgnored(ty resource.ResourceType) bool
	IsResourceIgnored(res *resource.Resource) bool
}

type GetSchemasOutput

type GetSchemasOutput struct {
	Schema *terraform.ProviderSchema
}

type MockFilter

type MockFilter struct {
	mock.Mock
}

MockFilter is an autogenerated mock type for the Filter type

func NewMockFilter

func NewMockFilter(t interface {
	mock.TestingT
	Cleanup(func())
}) *MockFilter

NewMockFilter creates a new instance of MockFilter. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations. The first argument is typically a *testing.T value.

func (*MockFilter) IsResourceIgnored

func (_m *MockFilter) IsResourceIgnored(res *resource.Resource) bool

IsResourceIgnored provides a mock function with given fields: res

func (*MockFilter) IsTypeIgnored

func (_m *MockFilter) IsTypeIgnored(ty resource.ResourceType) bool

IsTypeIgnored provides a mock function with given fields: ty

type ProgressCounter

type ProgressCounter interface {
	Inc()
}

type RefreshInput

type RefreshInput struct {
	// Resources to refresh
	Resources map[string][]*resource.Resource
}

type RefreshOutput

type RefreshOutput struct {
	Resources   map[string][]*resource.Resource
	Diagnostics diagnostic.Diagnostics
}

type Refresher

type Refresher interface {
	Refresh(input *RefreshInput) (*RefreshOutput, error)
	GetSchema() (*GetSchemasOutput, error)
}