context

Documentation

Index

• type AppContext
  • func GetAppContext(location string) (*AppContext, error)
  • func NewAppContext(location string, config *types.AppConfig) (*AppContext, error)
  • func (a *AppContext) AddService(serviceRole string) error
  • func (a *AppContext) GetDependencyServiceData(dependencyName string) map[string]map[string]interface{}
  • func (a *AppContext) GetDockerComposeDir() string
  • func (a *AppContext) GetRemoteDependencies() map[string]types.RemoteDependency
  • func (a *AppContext) GetServiceContextByLocation(location string) *ServiceContext
  • func (a *AppContext) GetSortedRemoteDependencyNames() []string
• type ServiceContext
  • func (s *ServiceContext) GetDependencyData(dependencyName string) map[string]interface{}
  • func (s *ServiceContext) ID() string
• type UserContext

Types

type AppContext

type AppContext struct {
	Location        string
	Config          *types.AppConfig
	ServiceContexts map[string]*ServiceContext
}

AppContext represents the exosphere application the user is running

func GetAppContext

func GetAppContext(location string) (*AppContext, error)

GetAppContext returns an AppContext for the application found at the passed location by walking up the directory tree until it finds an application.yml

func NewAppContext

func NewAppContext(location string, config *types.AppConfig) (*AppContext, error)

NewAppContext returns an AppContext with all the service contexts loaded

func (*AppContext) AddService

func (a *AppContext) AddService(serviceRole string) error

AddService adds serviceRole to the appConfig object and writes it to app.yml

func (*AppContext) GetDependencyServiceData

func (a *AppContext) GetDependencyServiceData(dependencyName string) map[string]map[string]interface{}

GetDependencyServiceData returns a map from service role to service data for the given dependency

func (*AppContext) GetDockerComposeDir

func (a *AppContext) GetDockerComposeDir() string

GetDockerComposeDir returns the file path to the directory containaing the docker compose files

func (*AppContext) GetRemoteDependencies

func (a *AppContext) GetRemoteDependencies() map[string]types.RemoteDependency

GetRemoteDependencies returns all remote dependencies

func (*AppContext) GetServiceContextByLocation

func (a *AppContext) GetServiceContextByLocation(location string) *ServiceContext

GetServiceContextByLocation returns the service context for the given location

func (*AppContext) GetSortedRemoteDependencyNames

func (a *AppContext) GetSortedRemoteDependencyNames() []string

GetSortedRemoteDependencyNames returns all remote dependency names in alphabetical order

type ServiceContext

type ServiceContext struct {
	Config     types.ServiceConfig
	AppContext *AppContext
	Source     *types.ServiceSource
	Role       string
}

ServiceContext represents the exosphere service the user is running

func (*ServiceContext) GetDependencyData

func (s *ServiceContext) GetDependencyData(dependencyName string) map[string]interface{}

GetDependencyData returns the data for the given dependency

func (*ServiceContext) ID

func (s *ServiceContext) ID() string

ID returns the identifier for the ServiceContext

type UserContext

type UserContext struct {
	AppContext        *AppContext
	ServiceContext    *ServiceContext
	HasServiceContext bool
}

UserContext represents contextual information about what application/service the user is running