Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

The way to go: Allow complex shell commands in the shell task #100

Open
wants to merge 1 commit into
base: epic/gh-33-the-way-to-go
Choose a base branch
from
Open

The way to go: Allow complex shell commands in the shell task #100

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 2 additions & 33 deletions pkg/snowblock/task/shell/shell.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ import (

"github.com/arcticicestudio/snowsaw/pkg/api/snowblock"
"github.com/arcticicestudio/snowsaw/pkg/prt"
"github.com/arcticicestudio/snowsaw/pkg/util/filesystem"
)

const (
Expand Down Expand Up @@ -78,18 +77,12 @@ func (s *Shell) Run(configuration snowblock.TaskConfiguration, snowblockAbsPath
if err := mapstructure.Decode(configType, &s.config); err != nil {
return err
}
if parseCmdElErr := s.parseCommand(s.config.Command); parseCmdElErr != nil {
return parseCmdElErr
}
if execErr := s.execute(); execErr != nil {
return execErr
}

// Handle JSON `string` configurations used to only specify a single command.
case string:
if parseCmdElErr := s.parseCommand(configType); parseCmdElErr != nil {
return parseCmdElErr
}
s.config.Command = configType
if execErr := s.execute(); execErr != nil {
return execErr
Expand All @@ -114,9 +107,6 @@ func (s *Shell) Run(configuration snowblock.TaskConfiguration, snowblockAbsPath
return fmt.Errorf("invalid amount of shell command arguments, expected %d but got %d",
CommandConfigArrayMaxArgs, len(configStringValues))
}
if parseCmdElErr := s.parseCommand(configStringValues[0]); parseCmdElErr != nil {
return parseCmdElErr
}
s.config.Command = configStringValues[0]
s.config.Description = configStringValues[1]
if execErr := s.execute(); execErr != nil {
Expand All @@ -134,6 +124,8 @@ func (s *Shell) Run(configuration snowblock.TaskConfiguration, snowblockAbsPath
}

func (s *Shell) execute() error {
s.cmd = os.Getenv("SHELL")
s.cmdArgs = append(s.cmdArgs, "-c", s.config.Command)
cmd := exec.Command(s.cmd, s.cmdArgs...)
cmd.Dir = s.snowblockAbsPath
cmd.Env = os.Environ()
Expand All @@ -159,26 +151,3 @@ func (s *Shell) execute() error {

return nil
}

func (s *Shell) parseCommand(cmd string) error {
parts := strings.Split(strings.TrimSpace(cmd), " ")
if parts[0] == "" {
return fmt.Errorf("shell command must not be empty or whitespace-only")
}

// Simulate shell specific behavior by trying to expand possible environment and special variables.
// Note that this is only necessary to keep the compatibility with the original Python implementation that runs
// commands with a specific shell simulation flag in order to provide these features which is described as "strongly
// discouraged" in the reference documentations because it makes the application vulnerable to "shell injection".
for idx, part := range parts {
expPart, partExpandErr := filesystem.ExpandPath(part)
if partExpandErr != nil {
return partExpandErr
}
parts[idx] = expPart
}

s.cmd = parts[0]
s.cmdArgs = append(s.cmdArgs, parts[1:]...)
return nil
}