Skip to content

Commit

Permalink
feat(be): passing to ansible new variable semaphore_vars
Browse files Browse the repository at this point in the history
  • Loading branch information
@fiftin
fiftin committed Jan 19, 2022
1 parent d8afdb1 commit 315dba6
Show file tree
Hide file tree
Showing 6 changed files with 104 additions and 109 deletions.
92 changes: 50 additions & 42 deletions api/tasks/runner.go
View file
Expand Up @@ -638,31 +638,36 @@ func (t *task) getExtraVars() (str string, err error) {

delete(extraVars, "ENV")

if util.Config.VariablesPassingMethod == util.VariablesPassingBoth ||
util.Config.VariablesPassingMethod == util.VariablesPassingExtra {
taskDetails := make(map[string]interface{})

if t.task.Message != "" {
extraVars["semaphore_task_message"] = t.task.Message
}
if t.task.Message != "" {
taskDetails["message"] = t.task.Message
}

if t.task.UserID != nil {
var user db.User
user, err = t.store.GetUser(*t.task.UserID)
if err != nil {
return
}
extraVars["semaphore_task_username"] = user.Username
if t.task.UserID != nil {
var user db.User
user, err = t.store.GetUser(*t.task.UserID)
if err != nil {
return
}
taskDetails["username"] = user.Username
}

if t.template.Type != db.TemplateTask {
extraVars["semaphore_task_type"] = t.template.Type
extraVars["semaphore_task_version"], err = t.task.GetVersion(t.store)
if err != nil {
panic("Deploy task has no build task")
}
if t.template.Type != db.TemplateTask {
taskDetails["type"] = t.template.Type
incomingVersion := t.task.GetIncomingVersion(t.store)
if incomingVersion != nil {
taskDetails["incoming_version"] = incomingVersion
}
if t.template.Type == db.TemplateBuild {
taskDetails["target_version"] = t.task.Version
}
}

vars := make(map[string]interface{})
vars["task_details"] = taskDetails
extraVars["semaphore_vars"] = vars

ev, err := json.Marshal(extraVars)
if err != nil {
return
Expand Down Expand Up @@ -762,30 +767,33 @@ func (t *task) setCmdEnvironment(cmd *exec.Cmd, gitSSHCommand string) {
env = append(env, fmt.Sprintln("PYTHONUNBUFFERED=1"))
env = append(env, extractCommandEnvironment(t.environment.JSON)...)

if util.Config.VariablesPassingMethod == util.VariablesPassingBoth ||
util.Config.VariablesPassingMethod == util.VariablesPassingEnv {

if t.task.Message != "" {
env = append(env, "SEMAPHORE_TASK_MESSAGE="+t.task.Message)
}

if t.task.UserID != nil {
user, err := t.store.GetUser(*t.task.UserID)
if err != nil {
panic("Deploy task can't find user")
}
env = append(env, "SEMAPHORE_TASK_USERNAME="+user.Username)
}

if t.template.Type != db.TemplateTask {
env = append(env, "SEMAPHORE_TASK_TYPE="+string(t.template.Type))
version, err := t.task.GetVersion(t.store)
if err != nil {
panic("Deploy task has no build task")
}
env = append(env, "SEMAPHORE_TASK_VERSION="+version)
}
}
//if util.Config.VariablesPassingMethod == util.VariablesPassingBoth ||
// util.Config.VariablesPassingMethod == util.VariablesPassingEnv {
//
// if t.task.Message != "" {
// env = append(env, "SEMAPHORE_TASK_MESSAGE="+t.task.Message)
// }
//
// if t.task.UserID != nil {
// user, err := t.store.GetUser(*t.task.UserID)
// if err != nil {
// panic("Deploy task can't find user")
// }
// env = append(env, "SEMAPHORE_TASK_USERNAME="+user.Username)
// }
//
// if t.template.Type != db.TemplateTask {
// env = append(env, "SEMAPHORE_TASK_TYPE="+string(t.template.Type))
// incomingVersion, err := t.task.GetIncomingVersion(t.store)
// if err != nil {
// panic("Deploy task has no build task")
// }
// env = append(env, "SEMAPHORE_INCOMING_VERSION="+incomingVersion)
// if t.template.Type == db.TemplateBuild {
// env = append(env, "SEMAPHORE_TARGET_VERSION="+*t.task.Version)
// }
// }
//}

if gitSSHCommand != "" {
env = append(env, fmt.Sprintf("GIT_SSH_COMMAND=%s", gitSSHCommand))
Expand Down
48 changes: 24 additions & 24 deletions api/tasks/runner_test.go
View file
Expand Up @@ -37,7 +37,7 @@ func TestPopulateDetails(t *testing.T) {

repo, err := store.CreateRepository(db.Repository{
ProjectID: proj.ID,
SSHKeyID: key.ID,
SSHKeyID: key.ID,
})
if err != nil {
t.Fatal(err)
Expand All @@ -52,19 +52,19 @@ func TestPopulateDetails(t *testing.T) {

env, err := store.CreateEnvironment(db.Environment{
ProjectID: proj.ID,
Name: "test",
JSON: `{"author": "Denis", "comment": "Hello, World!"}`,
Name: "test",
JSON: `{"author": "Denis", "comment": "Hello, World!"}`,
})
if err != nil {
t.Fatal(err)
}

tpl, err := store.CreateTemplate(db.Template{
Alias: "Test",
Playbook: "test.yml",
ProjectID: proj.ID,
RepositoryID: repo.ID,
InventoryID: inv.ID,
Alias: "Test",
Playbook: "test.yml",
ProjectID: proj.ID,
RepositoryID: repo.ID,
InventoryID: inv.ID,
EnvironmentID: &env.ID,
})

Expand All @@ -73,10 +73,10 @@ func TestPopulateDetails(t *testing.T) {
}

tsk := task{
store: &store,
store: &store,
projectID: proj.ID,
task: db.Task{
TemplateID: tpl.ID,
TemplateID: tpl.ID,
Environment: `{"comment": "Just do it!", "time": "2021-11-02"}`,
},
}
Expand All @@ -102,7 +102,7 @@ func TestTaskGetPlaybookArgs(t *testing.T) {
inventory: db.Inventory{
SSHKeyID: &inventoryID,
SSHKey: db.AccessKey{
ID: 12345,
ID: 12345,
Type: db.AccessKeySSH,
},
},
Expand All @@ -118,7 +118,7 @@ func TestTaskGetPlaybookArgs(t *testing.T) {
}

res := strings.Join(args, " ")
if res != "-i /tmp/inventory_0 --private-key=/tmp/access_key_0 --extra-vars {} test.yml" {
if res != "-i /tmp/inventory_0 --private-key=/tmp/access_key_0 --extra-vars {\"semaphore_vars\":{\"task_details\":{}}} test.yml" {
t.Fatal("incorrect result")
}
}
Expand All @@ -135,11 +135,11 @@ func TestTaskGetPlaybookArgs2(t *testing.T) {
inventory: db.Inventory{
SSHKeyID: &inventoryID,
SSHKey: db.AccessKey{
ID: 12345,
ID: 12345,
Type: db.AccessKeyLoginPassword,
LoginPassword: db.LoginPassword{
Password: "123456",
Login: "root",
Login: "root",
},
},
},
Expand All @@ -155,7 +155,7 @@ func TestTaskGetPlaybookArgs2(t *testing.T) {
}

res := strings.Join(args, " ")
if res != "-i /tmp/inventory_0 --extra-vars=@/tmp/access_key_0 --extra-vars {} test.yml" {
if res != "-i /tmp/inventory_0 --extra-vars=@/tmp/access_key_0 --extra-vars {\"semaphore_vars\":{\"task_details\":{}}} test.yml" {
t.Fatal("incorrect result")
}
}
Expand All @@ -172,11 +172,11 @@ func TestTaskGetPlaybookArgs3(t *testing.T) {
inventory: db.Inventory{
BecomeKeyID: &inventoryID,
BecomeKey: db.AccessKey{
ID: 12345,
ID: 12345,
Type: db.AccessKeyLoginPassword,
LoginPassword: db.LoginPassword{
Password: "123456",
Login: "root",
Login: "root",
},
},
},
Expand All @@ -192,15 +192,14 @@ func TestTaskGetPlaybookArgs3(t *testing.T) {
}

res := strings.Join(args, " ")
if res != "-i /tmp/inventory_0 --extra-vars=@/tmp/access_key_0 --extra-vars {} test.yml" {
if res != "-i /tmp/inventory_0 --extra-vars=@/tmp/access_key_0 --extra-vars {\"semaphore_vars\":{\"task_details\":{}}} test.yml" {
t.Fatal("incorrect result")
}
}


func TestCheckTmpDir(t *testing.T) {
//It should be able to create a random dir in /tmp
dirName := os.TempDir()+ "/" + randString(rand.Intn(10 - 4) + 4)
dirName := os.TempDir() + "/" + randString(rand.Intn(10-4)+4)
err := checkTmpDir(dirName)
if err != nil {
t.Fatal(err)
Expand All @@ -212,7 +211,7 @@ func TestCheckTmpDir(t *testing.T) {
t.Fatal(err)
}

err = os.Chmod(dirName,os.FileMode(int(0550)))
err = os.Chmod(dirName, os.FileMode(int(0550)))
if err != nil {
t.Fatal(err)
}
Expand All @@ -225,7 +224,7 @@ func TestCheckTmpDir(t *testing.T) {
return
}

err = checkTmpDir(dirName+"/noway")
err = checkTmpDir(dirName + "/noway")
if err == nil {
t.Fatal("You should not be able to write in this folder, causing an error")
}
Expand All @@ -235,17 +234,18 @@ func TestCheckTmpDir(t *testing.T) {
}
}


//HELPERS

//https://stackoverflow.com/questions/22892120/how-to-generate-a-random-string-of-a-fixed-length-in-golang
var src = rand.NewSource(time.Now().UnixNano())

const letterBytes = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
const (
letterIdxBits = 6 // 6 bits to represent a letter index
letterIdxMask = 1<<letterIdxBits - 1 // All 1-bits, as many as letterIdxBits
letterIdxMax = 63 / letterIdxBits // # of letter indices fitting in 63 bits
)

func randString(n int) string {
b := make([]byte, n)
// A src.Int63() generates 63 random bits, enough for letterIdxMax characters!
Expand All @@ -261,4 +261,4 @@ func randString(n int) string {
remain--
}
return string(b)
}
}
38 changes: 17 additions & 21 deletions db/Task.go
View file
@@ -1,7 +1,6 @@
package db

import (
"fmt"
"time"
)

Expand Down Expand Up @@ -40,30 +39,27 @@ type Task struct {
Version *string `db:"version" json:"version"`
}

func (task *Task) GetVersion(d Store) (string, error) {
tpl, err := d.GetTemplate(task.ProjectID, task.TemplateID)
func (task *Task) GetIncomingVersion(d Store) *string {
if task.BuildTaskID == nil {
return nil
}

buildTask, err := d.GetTask(task.ProjectID, *task.BuildTaskID)

if err != nil {
return "", err
return nil
}

switch tpl.Type {
case TemplateTask:
return "", fmt.Errorf("only build and deploy tasks has versions")
case TemplateBuild:
if task.Version == nil {
return "", fmt.Errorf("build task must have version")
}
return *task.Version, nil
case TemplateDeploy:
var buildTask Task
buildTask, err = d.GetTask(task.ProjectID, *task.BuildTaskID)
if err != nil {
return "", err
}
return buildTask.GetVersion(d)
default:
return "", fmt.Errorf("unknown task type")
tpl, err := d.GetTemplate(task.ProjectID, buildTask.TemplateID)
if err != nil {
return nil
}

if tpl.Type == TemplateBuild {
return buildTask.Version
}

return buildTask.GetIncomingVersion(d)
}

func (task *Task) ValidateNewTask(template Template) error {
Expand Down
20 changes: 12 additions & 8 deletions db/bolt/Task_test.go
View file
Expand Up @@ -89,19 +89,23 @@ func TestTask_GetVersion(t *testing.T) {
t.Fatal(err)
}

version, err := deployTask.GetVersion(store)
if err != nil {
t.Fatal(err)
version := deployTask.GetIncomingVersion(store)
if version == nil {
t.Fatal()
return
}
if version != VERSION {
if *version != VERSION {
t.Fatal()
return
}

version, err = deploy2Task.GetVersion(store)
if err != nil {
t.Fatal(err)
version = deploy2Task.GetIncomingVersion(store)
if version == nil {
t.Fatal()
return
}
if version != VERSION {
if *version != VERSION {
t.Fatal()
return
}
}
13 changes: 0 additions & 13 deletions util/config.go
View file
Expand Up @@ -49,15 +49,6 @@ type ldapMappings struct {
CN string `json:"cn"`
}

type VariablesPassingMethod string

const (
VariablesPassingNone VariablesPassingMethod = "none"
VariablesPassingEnv VariablesPassingMethod = "env_vars"
VariablesPassingExtra VariablesPassingMethod = "extra_vars"
VariablesPassingBoth VariablesPassingMethod = ""
)

//ConfigType mapping between Config and the json file that sets it
type ConfigType struct {
MySQL DbConfig `json:"mysql"`
Expand Down Expand Up @@ -120,10 +111,6 @@ type ConfigType struct {

SshConfigPath string `json:"ssh_config_path"`

// VariablesPassingMethod defines how Semaphore will pass variables to Ansible.
// Default both via environment variables and via extra vars.
VariablesPassingMethod VariablesPassingMethod `json:"variables_passing_method"`

DemoMode bool `json:"demo_mode"`
}

Expand Down

0 comments on commit 315dba6

Please sign in to comment.