Semaphore/db/Template.go
2024-10-26 12:56:17 +00:00

155 lines
4.3 KiB
Go

package db
import (
"encoding/json"
)
type TemplateType string
const (
TemplateTask TemplateType = ""
TemplateBuild TemplateType = "build"
TemplateDeploy TemplateType = "deploy"
)
type TemplateApp string
const (
AppAnsible TemplateApp = "ansible"
AppTerraform TemplateApp = "terraform"
AppTofu TemplateApp = "tofu"
AppBash TemplateApp = "bash"
AppPowerShell TemplateApp = "powershell"
AppPython TemplateApp = "python"
AppPulumi TemplateApp = "pulumi"
)
func (t TemplateApp) IsTerraform() bool {
return t == AppTerraform || t == AppTofu
}
type SurveyVarType string
const (
SurveyVarStr TemplateType = ""
SurveyVarInt TemplateType = "int"
SurveyVarEnum TemplateType = "enum"
)
type SurveyVarEnumValue struct {
Name string `json:"name" backup:"name"`
Value string `json:"value" backup:"value"`
}
type SurveyVar struct {
Name string `json:"name" backup:"name"`
Title string `json:"title" backup:"title"`
Required bool `json:"required" backup:"required"`
Type SurveyVarType `json:"type" backup:"type"`
Description string `json:"description" backup:"description"`
Values []SurveyVarEnumValue `json:"values" backup:"values"`
}
type TemplateFilter struct {
ViewID *int
BuildTemplateID *int
AutorunOnly bool
}
// Template is a user defined model that is used to run a task
type Template struct {
ID int `db:"id" json:"id" backup:"-"`
ProjectID int `db:"project_id" json:"project_id" backup:"-"`
InventoryID *int `db:"inventory_id" json:"inventory_id" backup:"-"`
RepositoryID int `db:"repository_id" json:"repository_id" backup:"-"`
EnvironmentID *int `db:"environment_id" json:"environment_id" backup:"-"`
// Name as described in https://github.com/semaphoreui/semaphore/issues/188
Name string `db:"name" json:"name"`
// playbook name in the form of "some_play.yml"
Playbook string `db:"playbook" json:"playbook"`
// to fit into []string
Arguments *string `db:"arguments" json:"arguments"`
// if true, semaphore will not prepend any arguments to `arguments` like inventory, etc
AllowOverrideArgsInTask bool `db:"allow_override_args_in_task" json:"allow_override_args_in_task"`
Description *string `db:"description" json:"description"`
Vaults []TemplateVault `db:"-" json:"vaults" backup:"-"`
Type TemplateType `db:"type" json:"type"`
StartVersion *string `db:"start_version" json:"start_version"`
BuildTemplateID *int `db:"build_template_id" json:"build_template_id" backup:"-"`
ViewID *int `db:"view_id" json:"view_id" backup:"-"`
LastTask *TaskWithTpl `db:"-" json:"last_task" backup:"-"`
Autorun bool `db:"autorun" json:"autorun"`
// override variables
GitBranch *string `db:"git_branch" json:"git_branch"`
// SurveyVarsJSON used internally for read from database.
// It is not used for store survey vars to database.
// Do not use it in your code. Use SurveyVars instead.
SurveyVarsJSON *string `db:"survey_vars" json:"-" backup:"-"`
SurveyVars []SurveyVar `db:"-" json:"survey_vars" backup:"survey_vars"`
SuppressSuccessAlerts bool `db:"suppress_success_alerts" json:"suppress_success_alerts"`
App TemplateApp `db:"app" json:"app"`
Tasks int `db:"tasks" json:"tasks" backup:"-"`
}
func (tpl *Template) Validate() error {
switch tpl.App {
case AppAnsible:
if tpl.InventoryID == nil {
return &ValidationError{"template inventory can not be empty"}
}
}
if tpl.Name == "" {
return &ValidationError{"template name can not be empty"}
}
if !tpl.App.IsTerraform() && tpl.Playbook == "" {
return &ValidationError{"template playbook can not be empty"}
}
if tpl.Arguments != nil {
if !json.Valid([]byte(*tpl.Arguments)) {
return &ValidationError{"template arguments must be valid JSON"}
}
}
return nil
}
func FillTemplate(d Store, template *Template) (err error) {
var vaults []TemplateVault
vaults, err = d.GetTemplateVaults(template.ProjectID, template.ID)
if err != nil {
return
}
template.Vaults = vaults
var tasks []TaskWithTpl
tasks, err = d.GetTemplateTasks(template.ProjectID, template.ID, RetrieveQueryParams{Count: 1})
if err != nil {
return
}
if len(tasks) > 0 {
template.LastTask = &tasks[0]
}
if template.SurveyVarsJSON != nil {
err = json.Unmarshal([]byte(*template.SurveyVarsJSON), &template.SurveyVars)
}
return
}