interfaces

Documentation

Index

• type Bootconfig
• type ICMDPlugin
• type IConfig
• type ICore
• type IDAL
• type IExtractor
• type IHelper
• type ILogger
• type INetworker
• type IProfile
• type IProject
• type IService
• type IUIPlugin
• type IUpdater
• type ProjectMetadata
• type RunTime
• type ServiceLocator
• type ServiceMetadata
• type VersionHandle

Types

type Bootconfig

type Bootconfig struct {
	DatabasePath string
}

Bootconfig ...

type ICMDPlugin

type ICMDPlugin interface {
	// GetCommands returns all urfave cli commands implemented by this plugin
	GetCommands(i interface{}) interface{}
}

ICMDPlugin ...

type IConfig

type IConfig interface {
	Save(i ...interface{}) error

	SetActiveProfile(name string) error
	GetActiveProfile() IProfile

	GetAllProfiles() (map[string]IProfile, error)
	GetActiveProfileByName(profilename string) (IProfile, error)

	AddProfile(p IProfile) error
	RemoveProfile(p IProfile) error

	Remove(i interface{}) error

	GetConfigPath() (string, error)
	SetConfigPath(path string) error

	DumpConfig(i ...interface{}) interface{}
}

IConfig interface ...

type ICore

type ICore interface {
	GetStartTime() time.Time
	GetLogger() ILogger
	GetUI() IUIPlugin
	GetConfig() IConfig
	GetHelper() IHelper
	GetNetworker() INetworker
	GetUpdater() IUpdater
	GetCMDPlugins() []ICMDPlugin
	Get(i interface{}) error
	CallPreHook(i interface{}) error
	CallPostHook(i interface{}) error
}

ICore ...

type IDAL

type IDAL interface {
	Create(i interface{}) error
	Read(i interface{}) error
	Update(i interface{}) error
	Delete(i interface{}) error
	ReadAll(i interface{}) (map[string]interface{}, error)
}

IDAL ...

type IExtractor

type IExtractor interface {
	// ExtractLogger ...
	GetCore(i interface{}) ICore
	// ExtractMetadata ...
	GetMetadata(m map[string]interface{}, key string, container interface{}) error
	// ExtractMetadataFatal calls ExtractMetadata but fails fataly before returning to caller
	// if extraction has error. This allows for less lines in calling code for essential
	// extractions that would need to interrupt the application anyways
	GetMetadataFatal(m map[string]interface{}, key string, container interface{})
}

IExtractor ...

type IHelper

type IHelper interface {
	CheckUserProfile() string
	CheckFlag(flag string) bool
	CheckFlagArg(flag string) string
	// HomeDir ...
	HomeDir(i ...string) string

	// HomeDir ...
	CurrentWorkdir(i ...string) string

	// CheckOrCreateFolder ...
	CheckOrCreateFolder(path string, permissions os.FileMode)

	// CheckOrCreateParentFolder ...
	CheckOrCreateParentFolder(path string, permissions os.FileMode)
	// PathExists ...
	PathExists(path string) bool

	LoadBootConfig() *Bootconfig

	ReadFile(path string) ([]byte, error)

	UpdateOrWriteFile(path string, content []byte, permissions os.FileMode) error

	CatchOutput(script string, silent bool, args ...string) (string, error)
}

IHelper ...

type ILogger

type ILogger interface {
	GetLevel(i ...interface{}) string
	Trace(i ...interface{})
	Debug(i ...interface{})
	Info(i ...interface{})
	Warn(i ...interface{})
	Error(i ...interface{})
	Fatal(i ...interface{})
	Tracef(format string, i ...interface{})
	Debugf(format string, i ...interface{})
	Infof(format string, i ...interface{})
	Warnf(format string, i ...interface{})
	Errorf(format string, i ...interface{})
	Fatalf(format string, i ...interface{})
}

ILogger ...

type INetworker

type INetworker interface {
	CheckConnections(conns map[string]interface{})
	// Download the fiel located at arg `url` to the absolute path at arg `filepath`
	Load(filepath string, url string) error
}

INetworker ...

type IProfile

type IProfile interface {
	SetID(id uint) error
	GetID() uint

	IsInitialized() bool
	SetInitialized(init bool) error

	GetName() string
	SetName(n string) error

	GetCurrentProject() IProject

	GetCurrentProjectID() uint
	SetCurrentProjectID(id uint) error

	GetMetaData(key string) string
	SetMetaData(key string, value string)

	GetBasePath() string
	GetProjects() map[string]IProject

	AddProject() error
	AddProjectByName(name string) error
	AddProjectDirect(p IProject) error

	RemoveProject(p IProject) error
	RemoveProjectByName(name string) error

	GetValues(i ...interface{}) []string
	GetValuesAsMap(i ...interface{}) map[string]string
	GetProjectsTable() [][]string
}

IProfile ...

type IProject

type IProject interface {
	Init(core ICore) error
	GetID() uint
	SetID(id uint) error

	IsInitialized() bool
	SetInitialized(init bool) error

	GetName() string
	SetName(n string) error

	GetPath() string
	SetPath(path string, i ...interface{}) error
	GetServices(i ...interface{}) map[string]ServiceMetadata
	GetServiceByName(serviceName string, i ...interface{}) ServiceMetadata
	GetValues(i ...interface{}) []string

	SetSettingsYamlPath(path string, i ...interface{}) error
	GetSettingsYamlPath(i ...interface{}) string

	WriteSettingsObject(h IHelper, i ...interface{}) error
	ReadSettingsObject(h IHelper, i ...interface{}) (*ProjectMetadata, error)
}

IProject ...

type IService

type IService interface {
	GetName() string
	GetPath(i ...interface{}) string
	SetPath(path string, i ...interface{}) error
	GetActive(i ...interface{}) bool
	SetActive(active bool, i ...interface{}) error
	ToggleActive(i ...interface{}) error
	GetValues(i ...interface{}) []string
}

IService ...

type IUIPlugin

type IUIPlugin interface {
	ClearScreen(i ...interface{}) interface{}
	PrintPercentOfScreen(startPercent int, endPercent int, i ...interface{}) interface{}
	PrintBanner(i ...interface{}) interface{}
	PrintTable(heads []string, rows [][]string, i ...interface{}) interface{}
	Println(i ...interface{}) (int, error)
	Printf(format string, i ...interface{}) (int, error)
	YesNoQuestion(question string, i ...interface{}) bool
	YesNoQuestionf(questionf string, i ...interface{}) bool
	Question(question string, i ...interface{}) error
	Questionf(questionf string, answer *string, i ...interface{}) error
}

IUIPlugin ...

type IUpdater

type IUpdater interface {
	CheckUpdate(version string, core ICore) error
	CheckSinceLastUpdate(version string, core ICore) error
}

type ProjectMetadata

type ProjectMetadata struct {
	Name    string
	Version string
	// only service-name and ref to service.yaml
	Services      map[string]ServiceLocator
	IgnoreFolders []string
	// optional
	Meta map[string]interface{}
}

type RunTime

type RunTime struct {
	// define technology type (i.e. kubernetes, vm, serverless....)
	Technology string
	// define technology for dev deployment (i.e. skaffold&helm, skaffold & manifests, kubectl, helm-only,...)
	Helper map[string]interface{}
}

type ServiceLocator

type ServiceLocator struct {
	Active bool
	Path   string
}

type ServiceMetadata

type ServiceMetadata struct {
	Name    string
	Version string `yaml:"serviceVersion"`
	// define how service is deployed for dev/staging/live...
	RunTimes map[string]RunTime
	//optional
	Meta map[string]interface{}

	VersionHandles map[string]*VersionHandle
}

type VersionHandle

type VersionHandle struct {
	Path    string `yaml:"path"`
	Regexpr string `yaml:"regex"`
	Content []byte `yaml:"-"`
}