schema

Documentation

Index

• type DataSource
• type MockReader
  • func (r *MockReader) DataSourceSchema(pAddr addrs.Provider, dsType string) (*tfjson.Schema, error)
  • func (r *MockReader) DataSources() ([]DataSource, error)
  • func (r *MockReader) ProviderConfigSchema(name addrs.Provider) (*tfjson.Schema, error)
  • func (r *MockReader) Providers() ([]addrs.Provider, error)
  • func (r *MockReader) ResourceSchema(pAddr addrs.Provider, rType string) (*tfjson.Schema, error)
  • func (r *MockReader) Resources() ([]Resource, error)
• type NoSchemaAvailableErr
  • func (e *NoSchemaAvailableErr) Error() string
• type Reader
• type Resource
• type SchemaUnavailableErr
  • func (e *SchemaUnavailableErr) Error() string
• type Storage
  • func NewStorageForVersion(tfVersion string) (*Storage, error)
  • func (s *Storage) DataSourceSchema(pAddr addrs.Provider, dsType string) (*tfjson.Schema, error)
  • func (s *Storage) DataSources() ([]DataSource, error)
  • func (s *Storage) ObtainSchemasForModule(ctx context.Context, tf *exec.Executor, dir string) error
  • func (s *Storage) ProviderConfigSchema(addr addrs.Provider) (*tfjson.Schema, error)
  • func (s *Storage) Providers() ([]addrs.Provider, error)
  • func (s *Storage) ResourceSchema(pAddr addrs.Provider, rType string) (*tfjson.Schema, error)
  • func (s *Storage) Resources() ([]Resource, error)
  • func (s *Storage) SetLogger(logger *log.Logger)
• type StorageFactory
  • func NewMockStorage(ps *tfjson.ProviderSchemas) StorageFactory
• type Writer

Types

type DataSource

type DataSource struct {
	Name            string
	Provider        addrs.Provider
	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(pAddr addrs.Provider, dsType string) (*tfjson.Schema, error)

func (*MockReader) DataSources

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

func (*MockReader) ProviderConfigSchema

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

func (*MockReader) Providers

func (r *MockReader) Providers() ([]addrs.Provider, error)

func (*MockReader) ResourceSchema

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

func (*MockReader) Resources

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

type NoSchemaAvailableErr

type NoSchemaAvailableErr struct{}

func (*NoSchemaAvailableErr) Error

func (e *NoSchemaAvailableErr) Error() string

type Reader

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

type Resource

type Resource struct {
	Name            string
	Provider        addrs.Provider
	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 NewStorageForVersion

func NewStorageForVersion(tfVersion string) (*Storage, error)

func (*Storage) DataSourceSchema

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

func (*Storage) DataSources

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

func (*Storage) ObtainSchemasForModule

func (s *Storage) ObtainSchemasForModule(ctx context.Context, tf *exec.Executor, dir string) error

ObtainSchemasForModule will obtain schema via tf and store it for later consumption via Reader methods

func (*Storage) ProviderConfigSchema

func (s *Storage) ProviderConfigSchema(addr addrs.Provider) (*tfjson.Schema, error)

func (*Storage) Providers

func (s *Storage) Providers() ([]addrs.Provider, error)

func (*Storage) ResourceSchema

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

func (*Storage) Resources

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

func (*Storage) SetLogger

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

type StorageFactory

type StorageFactory func(v string) (*Storage, error)

func NewMockStorage

func NewMockStorage(ps *tfjson.ProviderSchemas) StorageFactory

type Writer

type Writer interface {
	// TODO: Consider decoupling TF exec logic and replace
	// with UpdateSchemas(*tfjson.ProviderSchemas) which may be more suitable
	// in relation to https://github.com/hashicorp/terraform-ls/issues/193
	ObtainSchemasForModule(context.Context, *exec.Executor, string) error
}