Shell task runner API implementation

Implemented the `snowblock.TaskRunner` API interface to handle `shell`
tasks from the original Python implementation (1).

References:
  (1) https://github.com/arcticicestudio/snowsaw/blob/3e3840824bf6f3d5cc09573b9505737473c7ed95/README.md#shell

Epic: GH-33
Resolves GH-79

Author: arcticicestudio

pkg/config/constants.go

@@ -17,6 +17,7 @@ import (
 	"github.com/arcticicestudio/snowsaw/pkg/snowblock/task"
 	"github.com/arcticicestudio/snowsaw/pkg/snowblock/task/clean"
 	"github.com/arcticicestudio/snowsaw/pkg/snowblock/task/link"
+	"github.com/arcticicestudio/snowsaw/pkg/snowblock/task/shell"
 )
 
 const (
@@ -43,6 +44,7 @@ var (
 	availableTaskRunner = []snowblock.TaskRunner{
 		&clean.Clean{},
 		&link.Link{},
+		&shell.Shell{},
 	}
 
 	// BuildDateTime is the date and time this application was build.

pkg/snowblock/task/shell/shell.go

@@ -0,0 +1,184 @@
+// Copyright (C) 2017-present Arctic Ice Studio <[email protected]>
+// Copyright (C) 2017-present Sven Greb <[email protected]>
+//
+// Project:    snowsaw
+// Repository: https://github.com/arcticicestudio/snowsaw
+// License:    MIT
+
+// Author: Arctic Ice Studio <[email protected]>
+// Author: Sven Greb <[email protected]>
+// Since: 0.4.0
+
+// Package shell provides a task runner implementation to run arbitrary shell commands.
+package shell
+
+import (
+	"errors"
+	"fmt"
+	"os"
+	"os/exec"
+	"strings"
+
+	"github.com/fatih/color"
+	"github.com/mitchellh/mapstructure"
+
+	"github.com/arcticicestudio/snowsaw/pkg/api/snowblock"
+	"github.com/arcticicestudio/snowsaw/pkg/prt"
+	"github.com/arcticicestudio/snowsaw/pkg/util/filesystem"
+)
+
+const (
+	// CommandConfigArrayMaxArgs is the maximum amount of values that are allowed when using an a array of strings
+	// as shell configuration type.
+	CommandConfigArrayMaxArgs = 2
+)
+
+// Shell is a task runner to run arbitrary shell commands.
+type Shell struct {
+	cmd              string
+	cmdArgs          []string
+	config           *config
+	snowblockAbsPath string
+}
+
+type config struct {
+	Command     string `json:"command" yaml:"command"`
+	Description string `json:"description" yaml:"description"`
+	Stderr      bool   `json:"stderr" yaml:"stderr"`
+	Stdin       bool   `json:"stdin" yaml:"stdin"`
+	Stdout      bool   `json:"stdout" yaml:"stdout"`
+}
+
+// GetTaskName returns the name of the task this runner can process.
+func (s Shell) GetTaskName() string {
+	return "shell"
+}
+
+// Run processes a task using the given task instructions.
+// The snowblockAbsPath parameter is the absolute path of the snowblock used as contextual information.
+func (s *Shell) Run(configuration snowblock.TaskConfiguration, snowblockAbsPath string) error {
+	s.snowblockAbsPath = snowblockAbsPath
+
+	// Try to convert given task configurations...
+	configMap, ok := configuration.([]interface{})
+	if !ok {
+		prt.Debugf("invalid shell configuration type: %s", color.RedString("%T", configuration))
+		return errors.New("malformed shell configuration")
+	}
+
+	// ...and handle the possible types.
+	for idxConfigMap, configData := range configMap {
+		s.config = &config{}
+		s.cmd = ""
+		s.cmdArgs = []string{}
+
+		switch configType := configData.(type) {
+		// Handle JSON `object` configurations used to define a command with a description and additional options.
+		case map[string]interface{}:
+			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
+			}
+
+		// Handle JSON `array` configurations storing `string` values used to specify a command with a description.
+		case []interface{}:
+			var configStringValues []string
+			for idxConfigArray, value := range configType {
+				configString, isStringValue := value.(string)
+				if !isStringValue {
+					prt.Debugf("Unsupported value in %s shell command configuration of type %s at index %s",
+						color.CyanString("%d", idxConfigMap),
+						color.RedString("%T", value),
+						color.BlueString("%d", idxConfigArray))
+					return fmt.Errorf("unsupported value in %d shell configuration at index %d: %v",
+						idxConfigMap, idxConfigArray, value)
+				}
+				configStringValues = append(configStringValues, configString)
+			}
+			if len(configStringValues) > CommandConfigArrayMaxArgs || len(configStringValues) < CommandConfigArrayMaxArgs {
+				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 {
+				return execErr
+			}
+
+		// Reject invalid or unsupported JSON data structures.
+		default:
+			prt.Debugf("unsupported shell command configuration type: %s", color.RedString("%T", configType))
+			return fmt.Errorf("unsupported shell command configuration at index %d", idxConfigMap)
+		}
+	}
+
+	return nil
+}
+
+func (s *Shell) execute() error {
+	cmd := exec.Command(s.cmd, s.cmdArgs...)
+	cmd.Dir = s.snowblockAbsPath
+	cmd.Env = os.Environ()
+
+	if s.config.Description != "" {
+		prt.Infof(s.config.Description)
+	}
+	if s.config.Stderr {
+		cmd.Stderr = os.Stderr
+	}
+	if s.config.Stdin {
+		cmd.Stdin = os.Stdin
+	}
+	if s.config.Stdout {
+		cmd.Stdout = os.Stdout
+	}
+
+	runErr := cmd.Run()
+	if runErr != nil {
+		return fmt.Errorf("failed to execute shell command: %s",
+			color.CyanString("%s %s", s.cmd, strings.Join(s.cmdArgs, " ")))
+	}
+
+	return nil
+}
+
+func (s *Shell) parseCommand(cmd string) error {
+	parts := strings.Split(strings.TrimSpace(cmd), " ")
+	if len(parts[0]) == 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
+}