module

Documentation

Index

• func ByPath(i, j *Module) int
• type Module
  • func New(workdir internal.Workdir, path string) *Module
  • func (m *Module) FullPath() string
  • func (m *Module) LogValue() slog.Value
• type Service
  • func NewService(opts ServiceOptions) *Service
  • func (s *Service) CreateTask(mod *Module, opts task.CreateOptions) (*task.Task, error)
  • func (s *Service) Format(moduleID resource.ID) (*task.Task, error)
  • func (s *Service) Get(id resource.ID) (*Module, error)
  • func (s *Service) GetByPath(path string) (*Module, error)
  • func (s *Service) Init(moduleID resource.ID) (*task.Task, error)
  • func (s *Service) List() []*Module
  • func (s *Service) Reload() (added []string, removed []string, err error)
  • func (s *Service) SetCurrent(moduleID, workspaceID resource.ID) error
  • func (s *Service) Validate(moduleID resource.ID) (*task.Task, error)
• type ServiceOptions

Functions

func ByPath

func ByPath(i, j *Module) int

Types

type Module

type Module struct {
	resource.Resource

	// Pug working directory
	Workdir internal.Workdir

	// Path relative to pug working directory
	Path string

	// The module's current workspace.
	CurrentWorkspaceID *resource.ID

	// Whether module is initialized correctly. Nil means it is unknown.
	Initialized *bool
	// Whether a terraform init is in progress.
	InitInProgress bool

	// Whether module is formatted correctly. Nil means it is unknown.
	Formatted *bool
	// Whether formatting is in progress.
	FormatInProgress bool

	// Whether module is valid. Nil means it is unknown.
	Valid *bool
	// Whether validation is in progress.
	ValidationInProgress bool
}

Module is a terraform root module.

func New

func New(workdir internal.Workdir, path string) *Module

New constructs a module. Workdir is the pug working directory, and path is the module path relative to the working directory.

func (*Module) FullPath

func (m *Module) FullPath() string

FullPath returns the absolute path to the module.

func (*Module) LogValue

func (m *Module) LogValue() slog.Value

type Service

type Service struct {
	*pubsub.Broker[*Module]
	// contains filtered or unexported fields
}

func NewService

func NewService(opts ServiceOptions) *Service

func (*Service) CreateTask

func (s *Service) CreateTask(mod *Module, opts task.CreateOptions) (*task.Task, error)

func (*Service) Format

func (s *Service) Format(moduleID resource.ID) (*task.Task, error)

func (*Service) Get

func (s *Service) Get(id resource.ID) (*Module, error)

func (*Service) GetByPath

func (s *Service) GetByPath(path string) (*Module, error)

func (*Service) Init

func (s *Service) Init(moduleID resource.ID) (*task.Task, error)

Init invokes terraform init on the module.

func (*Service) List

func (s *Service) List() []*Module

func (*Service) Reload

func (s *Service) Reload() (added []string, removed []string, err error)

Reload searches the working directory recursively for modules and adds them to the store before pruning those that are currently stored but can no longer be found.

func (*Service) SetCurrent

func (s *Service) SetCurrent(moduleID, workspaceID resource.ID) error

func (*Service) Validate

func (s *Service) Validate(moduleID resource.ID) (*task.Task, error)

type ServiceOptions

type ServiceOptions struct {
	TaskService *task.Service
	Workdir     internal.Workdir
	PluginCache bool
	Logger      logging.Interface
}