refactor(be): move some functionality to GitRepository and AnsiblePlaybook classes

Author: fiftin

db/AccessKey.go

@@ -66,7 +66,7 @@ const (
 	AccessKeyRoleGit
 )
 
-func (key AccessKey) Install(usage AccessKeyRole) error {
+func (key *AccessKey) Install(usage AccessKeyRole) error {
 	rnd, err := rand.Int(rand.Reader, big.NewInt(1000000000))
 	if err != nil {
 		return err
@@ -143,7 +143,8 @@ func (key AccessKey) Install(usage AccessKeyRole) error {
 
 func (key AccessKey) Destroy() error {
 	path := key.GetPath()
-	if _, err := os.Stat(path); os.IsNotExist(err) {
+	_, err := os.Stat(path)
+	if os.IsNotExist(err) {
 		return nil
 	}
 	return os.Remove(path)

lib/AnsiblePlaybook.go

@@ -2,7 +2,6 @@ package lib
 
 import (
 	"bytes"
-	"encoding/json"
 	"fmt"
 	"github.com/ansible-semaphore/semaphore/db"
 	"github.com/ansible-semaphore/semaphore/util"
@@ -13,10 +12,9 @@ import (
 )
 
 type AnsiblePlaybook struct {
-	TemplateID  int
-	Logger      Logger
-	Repository  db.Repository
-	Environment db.Environment
+	TemplateID int
+	Repository db.Repository
+	Logger     Logger
 }
 
 func (p AnsiblePlaybook) makeCmd(command string, args []string) *exec.Cmd {
@@ -27,7 +25,6 @@ func (p AnsiblePlaybook) makeCmd(command string, args []string) *exec.Cmd {
 	cmd.Env = append(cmd.Env, fmt.Sprintf("HOME=%s", util.Config.TmpPath))
 	cmd.Env = append(cmd.Env, fmt.Sprintf("PWD=%s", cmd.Dir))
 	cmd.Env = append(cmd.Env, fmt.Sprintln("PYTHONUNBUFFERED=1"))
-	cmd.Env = append(cmd.Env, extractCommandEnvironment(p.Environment.JSON)...)
 
 	return cmd
 }
@@ -60,15 +57,16 @@ func (p AnsiblePlaybook) GetHosts(args []string) (hosts []string, err error) {
 	return
 }
 
-func (p AnsiblePlaybook) MakeRunCmd(args []string) (cmd *exec.Cmd, err error) {
-	cmd = p.makeCmd("ansible-playbook", args)
+func (p AnsiblePlaybook) RunPlaybook(args []string, cb func(*os.Process)) error {
+	cmd := p.makeCmd("ansible-playbook", args)
 	p.Logger.LogCmd(cmd)
 	cmd.Stdin = strings.NewReader("")
-	err = cmd.Start()
+	err := cmd.Start()
 	if err != nil {
-		return
+		return err
 	}
-	return
+	cb(cmd.Process)
+	return cmd.Wait()
 }
 
 func (p AnsiblePlaybook) RunGalaxy(args []string) error {
@@ -79,20 +77,3 @@ func (p AnsiblePlaybook) GetFullPath() (path string) {
 	path = p.Repository.GetFullPath(p.TemplateID)
 	return
 }
-
-func extractCommandEnvironment(envJSON string) []string {
-	env := make([]string, 0)
-	var js map[string]interface{}
-	err := json.Unmarshal([]byte(envJSON), &js)
-	if err == nil {
-		if cfg, ok := js["ENV"]; ok {
-			switch v := cfg.(type) {
-			case map[string]interface{}:
-				for key, val := range v {
-					env = append(env, fmt.Sprintf("%s=%s", key, val))
-				}
-			}
-		}
-	}
-	return env
-}

lib/GitRepository.go

@@ -50,6 +50,13 @@ func (r GitRepository) makeCmd(targetDir GitRepositoryDirType, args ...string) *
 }
 
 func (r GitRepository) run(targetDir GitRepositoryDirType, args ...string) error {
+	err := r.Repository.SSHKey.Install(db.AccessKeyRoleGit)
+	if err != nil {
+		return err
+	}
+
+	defer r.Repository.SSHKey.Destroy()
+
 	cmd := r.makeCmd(targetDir, args...)
 
 	r.Logger.LogCmd(cmd)

services/tasks/runner.go

@@ -38,16 +38,6 @@ type TaskRunner struct {
 	pool      *TaskPool
 }
 
-//func (t *TaskRunner) validate() error {
-//	if t.task.ProjectID != t.template.ProjectID ||
-//		t.task.ProjectID != t.inventory.ProjectID ||
-//		t.task.ProjectID != t.repository.ProjectID ||
-//		t.task.ProjectID != t.environment.ProjectID {
-//		return fmt.Errorf("invalid project id")
-//	}
-//	return nil
-//}
-
 func getMD5Hash(filepath string) (string, error) {
 	file, err := os.Open(filepath)
 	if err != nil {
@@ -124,12 +114,7 @@ func (t *TaskRunner) fail() {
 }
 
 func (t *TaskRunner) destroyKeys() {
-	err := t.repository.SSHKey.Destroy()
-	if err != nil {
-		t.Log("Can't destroy repository key, error: " + err.Error())
-	}
-
-	err = t.inventory.SSHKey.Destroy()
+	err := t.inventory.SSHKey.Destroy()
 	if err != nil {
 		t.Log("Can't destroy inventory user key, error: " + err.Error())
 	}
@@ -208,12 +193,6 @@ func (t *TaskRunner) prepareRun() {
 
 	t.updateStatus()
 
-	if err := t.repository.SSHKey.Install(db.AccessKeyRoleGit); err != nil {
-		t.Log("Failed installing ssh key for repository access: " + err.Error())
-		t.fail()
-		return
-	}
-
 	if strings.HasPrefix(t.repository.GitURL, gitURLFilePrefix) {
 		repositoryPath := strings.TrimPrefix(t.repository.GitURL, gitURLFilePrefix)
 		if _, err := os.Stat(repositoryPath); err != nil {
@@ -579,22 +558,14 @@ func (t *TaskRunner) runPlaybook() (err error) {
 		return
 	}
 
-	cmd, err := lib.AnsiblePlaybook{
+	return lib.AnsiblePlaybook{
 		Logger:     t,
 		TemplateID: t.template.ID,
 		Repository: t.repository,
-	}.MakeRunCmd(args)
-
-	if err != nil {
-		return
-	}
-
-	t.process = cmd.Process
-
-	return cmd.Wait()
+	}.RunPlaybook(args, func(p *os.Process) { t.process = p })
 }
 
-func (t *TaskRunner) getExtraVars() (str string, err error) {
+func (t *TaskRunner) getEnvironmentExtraVars() (str string, err error) {
 	extraVars := make(map[string]interface{})
 
 	if t.environment.JSON != "" {
@@ -604,8 +575,6 @@ func (t *TaskRunner) getExtraVars() (str string, err error) {
 		}
 	}
 
-	delete(extraVars, "ENV")
-
 	taskDetails := make(map[string]interface{})
 
 	if t.task.Message != "" {
@@ -707,7 +676,7 @@ func (t *TaskRunner) getPlaybookArgs() (args []string, err error) {
 		args = append(args, "--vault-password-file", t.template.VaultKey.GetPath())
 	}
 
-	extraVars, err := t.getExtraVars()
+	extraVars, err := t.getEnvironmentExtraVars()
 	if err != nil {
 		t.Log(err.Error())
 		t.Log("Could not remove command environment, if existant it will be passed to --extra-vars. This is not fatal but be aware of side effects")
@@ -725,7 +694,6 @@ func (t *TaskRunner) getPlaybookArgs() (args []string, err error) {
 	}
 
 	var taskExtraArgs []string
-
 	if t.template.AllowOverrideArgsInTask && t.task.Arguments != nil {
 		err = json.Unmarshal([]byte(*t.task.Arguments), &taskExtraArgs)
 		if err != nil {

web2/src/components/EnvironmentForm.vue

@@ -33,15 +33,11 @@
         type="info"
         class="mt-4"
     >
-      Environment must be valid JSON. You may use the key <code>ENV</code> to pass
-      environment variables to ansible-playbook.
+      Environment must be valid JSON.
       Example:
       <pre style="font-size: 14px;">{
   "var_available_in_playbook_1": 1245,
   "var_available_in_playbook_2": "test",
-  "ENV": {
-    "VAR1": "Read by lookup('env', 'VAR1')"
-  }
 }</pre>
     </v-alert>
   </v-form>