Skip to content

Commit

Permalink
refactor(be): extract Ansible to separate class
Browse files Browse the repository at this point in the history
  • Loading branch information
@fiftin
fiftin committed Jan 30, 2022
1 parent 3e559cc commit bf7b503
Show file tree
Hide file tree
Showing 2 changed files with 130 additions and 80 deletions.
107 changes: 107 additions & 0 deletions lib/AnsiblePlaybook.go
View file
@@ -0,0 +1,107 @@
package lib

import (
"bytes"
"encoding/json"
"fmt"
"github.com/ansible-semaphore/semaphore/db"
"github.com/ansible-semaphore/semaphore/util"
"os"
"os/exec"
"regexp"
"strings"
)

type AnsiblePlaybook struct {
TemplateID int
Logger Logger
Repository db.Repository
Environment db.Environment
}

func (p AnsiblePlaybook) makeCmd(command string, args []string) *exec.Cmd {
cmd := exec.Command(command, args...) //nolint: gas
cmd.Dir = p.GetFullPath()
p.setCmdEnvironment(cmd, p.Repository.SSHKey.GetSshCommand())
return cmd
}

func (p AnsiblePlaybook) runCmd(command string, args []string) error {
cmd := p.makeCmd(command, args)
p.Logger.LogCmd(cmd)
return cmd.Run()
}

func (p AnsiblePlaybook) GetHosts(args []string) (hosts []string, err error) {
args = append(args, "--list-hosts")
cmd := p.makeCmd("ansible-playbook", args)

var errb bytes.Buffer
cmd.Stderr = &errb

out, err := cmd.Output()
if err != nil {
return
}

re := regexp.MustCompile(`(?m)^\\s{6}(.*)$`)
matches := re.FindAllSubmatch(out, 20)
hosts = make([]string, len(matches))
for i := range matches {
hosts[i] = string(matches[i][1])
}

return
}

func (p AnsiblePlaybook) Run(args []string, process chan *os.Process) error {
cmd := p.makeCmd("ansible-playbook", args)
p.Logger.LogCmd(cmd)
cmd.Stdin = strings.NewReader("")
err := cmd.Start()
if err != nil {
return err
}
process <- cmd.Process
return cmd.Wait()
}

func (p AnsiblePlaybook) RunGalaxy(args []string) error {
return p.runCmd("ansible-galaxy", args)
}

func (p AnsiblePlaybook) GetFullPath() (path string) {
path = p.Repository.GetFullPath(p.TemplateID)
return
}

func (p AnsiblePlaybook) setCmdEnvironment(cmd *exec.Cmd, gitSSHCommand string) {
env := os.Environ()
env = append(env, fmt.Sprintf("HOME=%s", util.Config.TmpPath))
env = append(env, fmt.Sprintf("PWD=%s", cmd.Dir))
env = append(env, fmt.Sprintln("PYTHONUNBUFFERED=1"))
env = append(env, fmt.Sprintln("GIT_TERMINAL_PROMPT=0"))
env = append(env, extractCommandEnvironment(p.Environment.JSON)...)

if gitSSHCommand != "" {
env = append(env, fmt.Sprintf("GIT_SSH_COMMAND=%s", gitSSHCommand))
}
cmd.Env = env
}

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
}
103 changes: 23 additions & 80 deletions services/tasks/runner.go
View file
@@ -1,16 +1,13 @@
package tasks

import (
"bytes"
"crypto/md5"
"encoding/json"
"fmt"
"github.com/ansible-semaphore/semaphore/lib"
"io"
"io/ioutil"
"os"
"os/exec"
"regexp"
"strconv"
"strings"
"time"
Expand Down Expand Up @@ -257,10 +254,8 @@ func (t *TaskRunner) prepareRun() {
return
}

// todo: write environment

if stderr, err := t.listPlaybookHosts(); err != nil {
t.Log("Listing playbook hosts failed: " + err.Error() + "\n" + stderr)
if err := t.listPlaybookHosts(); err != nil {
t.Log("Listing playbook hosts failed: " + err.Error())
t.fail()
return
}
Expand Down Expand Up @@ -546,64 +541,45 @@ func (t *TaskRunner) installRequirements() error {
}

func (t *TaskRunner) runGalaxy(args []string) error {
cmd := exec.Command("ansible-galaxy", args...) //nolint: gas
cmd.Dir = t.getRepoPath()

t.setCmdEnvironment(cmd, t.repository.SSHKey.GetSshCommand())

t.LogCmd(cmd)
return cmd.Run()
return lib.AnsiblePlaybook{
Logger: t,
TemplateID: t.template.ID,
Repository: t.repository,
}.RunGalaxy(args)
}

func (t *TaskRunner) listPlaybookHosts() (string, error) {

func (t *TaskRunner) listPlaybookHosts() (err error) {
if util.Config.ConcurrencyMode == "project" {
return "", nil
return
}

args, err := t.getPlaybookArgs()
if err != nil {
return "", err
return
}
args = append(args, "--list-hosts")

cmd := exec.Command("ansible-playbook", args...) //nolint: gas
cmd.Dir = t.getRepoPath()
t.setCmdEnvironment(cmd, "")

var errb bytes.Buffer
cmd.Stderr = &errb

out, err := cmd.Output()
t.hosts, err = lib.AnsiblePlaybook{
Logger: t,
TemplateID: t.template.ID,
Repository: t.repository,
}.GetHosts(args)

re := regexp.MustCompile(`(?m)^\\s{6}(.*)$`)
matches := re.FindAllSubmatch(out, 20)
hosts := make([]string, len(matches))
for i := range matches {
hosts[i] = string(matches[i][1])
}
t.hosts = hosts
return errb.String(), err
return
}

func (t *TaskRunner) runPlaybook() (err error) {
args, err := t.getPlaybookArgs()
if err != nil {
return
}
cmd := exec.Command("ansible-playbook", args...) //nolint: gas
cmd.Dir = t.getRepoPath()
t.setCmdEnvironment(cmd, "")

t.LogCmd(cmd)
cmd.Stdin = strings.NewReader("")
err = cmd.Start()
if err != nil {
return
}
t.process = cmd.Process
err = cmd.Wait()
return
process := make(chan *os.Process)
t.process = <-process
return lib.AnsiblePlaybook{
Logger: t,
TemplateID: t.template.ID,
Repository: t.repository,
}.Run(args, process)
}

func (t *TaskRunner) getExtraVars() (str string, err error) {
Expand Down Expand Up @@ -746,20 +722,6 @@ func (t *TaskRunner) getPlaybookArgs() (args []string, err error) {
return
}

func (t *TaskRunner) setCmdEnvironment(cmd *exec.Cmd, gitSSHCommand string) {
env := os.Environ()
env = append(env, fmt.Sprintf("HOME=%s", util.Config.TmpPath))
env = append(env, fmt.Sprintf("PWD=%s", cmd.Dir))
env = append(env, fmt.Sprintln("PYTHONUNBUFFERED=1"))
env = append(env, fmt.Sprintln("GIT_TERMINAL_PROMPT=0"))
env = append(env, extractCommandEnvironment(t.environment.JSON)...)

if gitSSHCommand != "" {
env = append(env, fmt.Sprintf("GIT_SSH_COMMAND=%s", gitSSHCommand))
}
cmd.Env = env
}

func hasRequirementsChanges(requirementsFilePath string, requirementsHashFilePath string) bool {
oldFileMD5HashBytes, err := ioutil.ReadFile(requirementsHashFilePath)
if err != nil {
Expand All @@ -783,25 +745,6 @@ func writeMD5Hash(requirementsFile string, requirementsHashFile string) error {
return ioutil.WriteFile(requirementsHashFile, []byte(newFileMD5Hash), 0644)
}

// extractCommandEnvironment unmarshalls a json string, extracts the ENV key from it and returns it as
// []string where strings are in key=value format
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
}

// checkTmpDir checks to see if the temporary directory exists
// and if it does not attempts to create it
func checkTmpDir(path string) error {
Expand Down

0 comments on commit bf7b503

Please sign in to comment.