f19619ef9f
This commit adds a new environment package that manages all calls to the underlying operating system.
81 lines
2.6 KiB
Go
81 lines
2.6 KiB
Go
// Package component holds the main abstraction for components.
|
|
package component
|
|
|
|
import (
|
|
"github.com/FAU-CDI/wisski-distillery/internal/config"
|
|
"github.com/FAU-CDI/wisski-distillery/pkg/environment"
|
|
)
|
|
|
|
// Component represents a logical subsystem of the distillery.
|
|
//
|
|
// By convention these are defined within their corresponding subpackage.
|
|
// This subpackage also contains all required resources.
|
|
// Furthermore, a component is typically instantiated using a call on the ["distillery.Distillery"] struct.
|
|
//
|
|
// Each Component should make use of [ComponentBase] for sane defaults.
|
|
//
|
|
// For example, the web.Web component lives in the web package and can be created like:
|
|
//
|
|
// var dis Distillery
|
|
// web := dis.Web()
|
|
type Component interface {
|
|
// Name returns the name of this component.
|
|
// It should correspond to the appropriate subpackage.
|
|
Name() string
|
|
|
|
// Path returns the path this component is installed at.
|
|
// By convention it is /var/www/deploy/internal/core/${Name()}
|
|
Path() string
|
|
|
|
// Base() returns a reference to a base component
|
|
// This is implemented by an embedding on ComponentBase
|
|
Base() *ComponentBase
|
|
}
|
|
|
|
// Installable implements an installable component.
|
|
type Installable interface {
|
|
Component
|
|
|
|
// Stack can be used to gain access to the "docker compose" stack.
|
|
//
|
|
// This should internally call [ComponentBase.MakeStack]
|
|
Stack(env environment.Environment) StackWithResources
|
|
|
|
// Context returns a new InstallationContext to be used during installation from the command line.
|
|
// Typically this should just pass through the parent, but might perform other tasks.
|
|
Context(parent InstallationContext) InstallationContext
|
|
}
|
|
|
|
// ComponentBase implements base functionality for a component
|
|
type ComponentBase struct {
|
|
Core // the core of the associated distillery
|
|
Dir string // Dir is the directory this component lives in
|
|
}
|
|
|
|
// Core represents the core of a distillery
|
|
type Core struct {
|
|
Environment environment.Environment // environment to use for reading / writing to and from the distillery
|
|
Config *config.Config // the configuration of the distillery
|
|
}
|
|
|
|
// Base returns a reference to the ComponentBase
|
|
func (cb *ComponentBase) Base() *ComponentBase {
|
|
return cb
|
|
}
|
|
|
|
// Path returns the path to this component
|
|
func (cb ComponentBase) Path() string {
|
|
return cb.Dir
|
|
}
|
|
|
|
// Context passes through the parent context
|
|
func (ComponentBase) Context(parent InstallationContext) InstallationContext {
|
|
return parent
|
|
}
|
|
|
|
// MakeStack registers the Installable as a stack
|
|
func (cb ComponentBase) MakeStack(env environment.Environment, stack StackWithResources) StackWithResources {
|
|
stack.Env = env
|
|
stack.Dir = cb.Dir
|
|
return stack
|
|
}
|