schema

Documentation

Index

• func SchemaSupportsTerraform(v string) error
• type DataSource
• type MockReader
  • func (r *MockReader) DataSourceSchema(dsType string) (*tfjson.Schema, error)
  • func (r *MockReader) DataSources() ([]DataSource, error)
  • func (r *MockReader) ProviderConfigSchema(name string) (*tfjson.Schema, error)
  • func (r *MockReader) Providers() ([]string, error)
  • func (r *MockReader) ResourceSchema(rType string) (*tfjson.Schema, error)
  • func (r *MockReader) Resources() ([]Resource, error)
• type MockWatcher
  • func (w *MockWatcher) AddWorkspace(string) error
  • func (w *MockWatcher) Close() error
  • func (w *MockWatcher) Errors() chan error
  • func (w *MockWatcher) Events() chan fsnotify.Event
  • func (w *MockWatcher) OnPluginChange(func(*watchedWorkspace) error)
  • func (w *MockWatcher) SetLogger(*log.Logger)
• type NoSchemaAvailableErr
  • func (e *NoSchemaAvailableErr) Error() string
• type Reader
• type Resource
• type SchemaUnavailableErr
  • func (e *SchemaUnavailableErr) Error() string
• type Storage
  • func MockStorage(ps *tfjson.ProviderSchemas) *Storage
  • func NewStorage() *Storage
  • func (s *Storage) AddWorkspaceForWatching(dir string) error
  • func (s *Storage) DataSourceSchema(dsType string) (*tfjson.Schema, error)
  • func (s *Storage) DataSources() ([]DataSource, error)
  • func (s *Storage) ObtainSchemasForWorkspace(tf *exec.Executor, dir string) error
  • func (s *Storage) ProviderConfigSchema(name string) (*tfjson.Schema, error)
  • func (s *Storage) Providers() ([]string, error)
  • func (s *Storage) ResourceSchema(rType string) (*tfjson.Schema, error)
  • func (s *Storage) Resources() ([]Resource, error)
  • func (s *Storage) SetLogger(logger *log.Logger)
  • func (s *Storage) SetSynchronous()
  • func (s *Storage) StartWatching(tf *exec.Executor) error
  • func (s *Storage) StopWatching() error
• type Watcher
  • func NewWatcher() (*Watcher, error)
  • func (w *Watcher) AddWorkspace(dir string) error
  • func (w *Watcher) Close() error
  • func (w *Watcher) Errors() chan error
  • func (w *Watcher) Events() chan fsnotify.Event
  • func (w *Watcher) OnPluginChange(f func(*watchedWorkspace) error)
  • func (w *Watcher) SetLogger(logger *log.Logger)
• type Writer

Functions

func SchemaSupportsTerraform

func SchemaSupportsTerraform(v string) error

Types

type DataSource

type DataSource struct {
	Name            string
	Provider        string
	Description     string
	DescriptionKind tfjson.SchemaDescriptionKind
}

type MockReader

type MockReader struct {
	ProviderSchemas *tfjson.ProviderSchemas

	ProviderSchemaErr   error
	ProvidersErr        error
	ResourceSchemaErr   error
	ResourcesErr        error
	DataSourceSchemaErr error
	DataSourcesErr      error
}

func (*MockReader) DataSourceSchema

func (r *MockReader) DataSourceSchema(dsType string) (*tfjson.Schema, error)

func (*MockReader) DataSources

func (r *MockReader) DataSources() ([]DataSource, error)

func (*MockReader) ProviderConfigSchema

func (r *MockReader) ProviderConfigSchema(name string) (*tfjson.Schema, error)

func (*MockReader) Providers

func (r *MockReader) Providers() ([]string, error)

func (*MockReader) ResourceSchema

func (r *MockReader) ResourceSchema(rType string) (*tfjson.Schema, error)

func (*MockReader) Resources

func (r *MockReader) Resources() ([]Resource, error)

type MockWatcher

type MockWatcher struct{}

func (*MockWatcher) AddWorkspace

func (w *MockWatcher) AddWorkspace(string) error

func (*MockWatcher) Close

func (w *MockWatcher) Close() error

func (*MockWatcher) Errors

func (w *MockWatcher) Errors() chan error

func (*MockWatcher) Events

func (w *MockWatcher) Events() chan fsnotify.Event

func (*MockWatcher) OnPluginChange

func (w *MockWatcher) OnPluginChange(func(*watchedWorkspace) error)

func (*MockWatcher) SetLogger

func (w *MockWatcher) SetLogger(*log.Logger)

type NoSchemaAvailableErr

type NoSchemaAvailableErr struct{}

func (*NoSchemaAvailableErr) Error

func (e *NoSchemaAvailableErr) Error() string

type Reader

type Reader interface {
	ProviderConfigSchema(name string) (*tfjson.Schema, error)
	Providers() ([]string, error)
	ResourceSchema(rType string) (*tfjson.Schema, error)
	Resources() ([]Resource, error)
	DataSourceSchema(dsType string) (*tfjson.Schema, error)
	DataSources() ([]DataSource, error)
}

type Resource

type Resource struct {
	Name            string
	Provider        string
	Description     string
	DescriptionKind tfjson.SchemaDescriptionKind
}

type SchemaUnavailableErr

type SchemaUnavailableErr struct {
	BlockType string
	FullName  string
}

func (*SchemaUnavailableErr) Error

func (e *SchemaUnavailableErr) Error() string

type Storage

type Storage struct {
	// contains filtered or unexported fields
}

func MockStorage

func MockStorage(ps *tfjson.ProviderSchemas) *Storage

func NewStorage

func NewStorage() *Storage

func (*Storage) AddWorkspaceForWatching

func (s *Storage) AddWorkspaceForWatching(dir string) error

func (*Storage) DataSourceSchema

func (s *Storage) DataSourceSchema(dsType string) (*tfjson.Schema, error)

func (*Storage) DataSources

func (s *Storage) DataSources() ([]DataSource, error)

func (*Storage) ObtainSchemasForWorkspace

func (s *Storage) ObtainSchemasForWorkspace(tf *exec.Executor, dir string) error

ObtainSchemasForWorkspace will (by default) asynchronously obtain schema via tf and store it for later consumption via Reader methods

func (*Storage) ProviderConfigSchema

func (s *Storage) ProviderConfigSchema(name string) (*tfjson.Schema, error)

func (*Storage) Providers

func (s *Storage) Providers() ([]string, error)

func (*Storage) ResourceSchema

func (s *Storage) ResourceSchema(rType string) (*tfjson.Schema, error)

func (*Storage) Resources

func (s *Storage) Resources() ([]Resource, error)

func (*Storage) SetLogger

func (s *Storage) SetLogger(logger *log.Logger)

func (*Storage) SetSynchronous

func (s *Storage) SetSynchronous()

func (*Storage) StartWatching

func (s *Storage) StartWatching(tf *exec.Executor) error

StartWatching starts to watch for plugin changes in dirs that were added via AddWorkspaceForWatching until StopWatching() is called

func (*Storage) StopWatching

func (s *Storage) StopWatching() error

type Watcher

type Watcher struct {
	// contains filtered or unexported fields
}

Watcher is a wrapper around native fsnotify.Watcher to make it swappable for MockWatcher via interface, provide higher-level ability to detect actual file changes (rather than just events that may not be changing any bytes) and hold knowledge about workspace structure

func NewWatcher

func NewWatcher() (*Watcher, error)

func (*Watcher) AddWorkspace

func (w *Watcher) AddWorkspace(dir string) error

func (*Watcher) Close

func (w *Watcher) Close() error

func (*Watcher) Errors

func (w *Watcher) Errors() chan error

func (*Watcher) Events

func (w *Watcher) Events() chan fsnotify.Event

func (*Watcher) OnPluginChange

func (w *Watcher) OnPluginChange(f func(*watchedWorkspace) error)

func (*Watcher) SetLogger

func (w *Watcher) SetLogger(logger *log.Logger)

type Writer

type Writer interface {
	ObtainSchemasForWorkspace(*exec.Executor, string) error
	AddWorkspaceForWatching(string) error
	StartWatching(*exec.Executor) error
}