scripts

Documentation

Index

• type ScriptDef
  • func (s *ScriptDef) Execute()
  • func (s *ScriptDef) GetScriptExecutionEnvVars() []string
  • func (s *ScriptDef) Render() string
  • func (s *ScriptDef) SaveToFile()
  • func (s *ScriptDef) ScriptConfig() config.ManagerConfig
  • func (s *ScriptDef) WithParams(i *ServerProvisioningInfo) *ScriptDef
• type ScriptEngine
  • func NewScriptEngine(cfg config.ManagerConfig) ScriptEngine
  • func (s *ScriptEngine) GetProvisioningScript(scriptName string) *ScriptDef
  • func (s *ScriptEngine) GetScriptDef(scriptName string, cfg config.ManagerConfig, ...) *ScriptDef
  • func (s *ScriptEngine) GetSetupScript(scriptName string) *ScriptDef
  • func (s *ScriptEngine) GetSetupScripts() []*ScriptDef
• type ScriptTemplateVars
• type ScriptType
• type ServerProvisioningInfo
  • func NewServerProvisioning(game string, ip string, sshPort int, remoteUser string, sshKey string, ...) *ServerProvisioningInfo

Types

type ScriptDef

type ScriptDef struct {
	Name     string
	Template string
	Path     string
	Type     ScriptType

	ParamsInfo *ServerProvisioningInfo
	// contains filtered or unexported fields
}

ScriptDef represents a model to render a script

func (*ScriptDef) Execute

func (s *ScriptDef) Execute()

Execute executes script

func (*ScriptDef) GetScriptExecutionEnvVars

func (s *ScriptDef) GetScriptExecutionEnvVars() []string

GetScriptExecutionEnvVars generates the env vars to execute scripts

func (*ScriptDef) Render

func (s *ScriptDef) Render() string

Render renders the script

func (*ScriptDef) SaveToFile

func (s *ScriptDef) SaveToFile()

SaveToFile saves rendered script to file

func (*ScriptDef) ScriptConfig

func (s *ScriptDef) ScriptConfig() config.ManagerConfig

ScriptConfig returns the execution configuration

func (*ScriptDef) WithParams

func (s *ScriptDef) WithParams(i *ServerProvisioningInfo) *ScriptDef

WithParams add the provisioning info

type ScriptEngine

type ScriptEngine struct {
	Cfg config.ManagerConfig
}

ScriptEngine is the script executor

func NewScriptEngine

func NewScriptEngine(cfg config.ManagerConfig) ScriptEngine

NewScriptEngine sets up a new scripts.ScriptEngine

func (*ScriptEngine) GetProvisioningScript

func (s *ScriptEngine) GetProvisioningScript(scriptName string) *ScriptDef

GetProvisioningScript returns a single provisioning script model

func (*ScriptEngine) GetScriptDef

func (s *ScriptEngine) GetScriptDef(scriptName string, cfg config.ManagerConfig, scriptsDef map[string]map[string]string) *ScriptDef

GetScriptDef returns

func (*ScriptEngine) GetSetupScript

func (s *ScriptEngine) GetSetupScript(scriptName string) *ScriptDef

GetSetupScript returns a single setup script model

func (*ScriptEngine) GetSetupScripts

func (s *ScriptEngine) GetSetupScripts() []*ScriptDef

GetSetupScripts returns all the script models

type ScriptTemplateVars

type ScriptTemplateVars struct {
	WorkspacePath    string
	PythonVersion    string
	VenvName         string
	ProvisioningInfo *ServerProvisioningInfo
}

ScriptTemplateVars is a representation of vars to parse script templates

type ScriptType

type ScriptType string

ScriptType defines a type of script

const (
	// AnsibleScript is ansible playbook script type
	AnsibleScript ScriptType = "Ansible"
	// ShellScript is shell script type
	ShellScript ScriptType = "Shell"
)

type ServerProvisioningInfo

type ServerProvisioningInfo struct {
	Game       string
	IP         string
	SSHPort    int
	SSHKey     string
	RemoteUser string
	Args       map[string]string
}

ServerProvisioningInfo is a model to represents provisioning parameters

func NewServerProvisioning

func NewServerProvisioning(game string, ip string, sshPort int, remoteUser string, sshKey string, args []string) *ServerProvisioningInfo

NewServerProvisioning creates a server provisioning data