Link task runner API implementation

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

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

Epic GH-33
Resolves GH-74

Author: arcticicestudio

go.mod

@@ -8,6 +8,7 @@ require (
 	github.com/magefile/mage v1.8.0
 	github.com/mattn/go-colorable v0.1.2 // indirect
 	github.com/mitchellh/go-homedir v1.1.0
+	github.com/mitchellh/mapstructure v1.1.2
 	github.com/spf13/cobra v0.0.5
 	gopkg.in/yaml.v3 v3.0.0-20190709130402-674ba3eaed22
 )

go.sum

@@ -22,6 +22,7 @@ github.com/mattn/go-isatty v0.0.8 h1:HLtExJ+uU2HOZ+wI0Tt5DtUDrx8yhUqDcp7fYERX4CE
 github.com/mattn/go-isatty v0.0.8/go.mod h1:Iq45c/XA43vh69/j3iqttzPXn0bhXyGjM0Hdxcsrc5s=
 github.com/mitchellh/go-homedir v1.1.0 h1:lukF9ziXFxDFPkA1vsr5zpc1XuPDn/wFntq5mG+4E0Y=
 github.com/mitchellh/go-homedir v1.1.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrkLzIz1N1q0pr0=
+github.com/mitchellh/mapstructure v1.1.2 h1:fmNYVwqnSfB9mZU6OS2O6GsXM+wcskZDuKQzvN1EDeE=
 github.com/mitchellh/mapstructure v1.1.2/go.mod h1:FVVH3fgwuzCH5S8UJGiWEs2h04kUh9fWfEaFds41c1Y=
 github.com/pelletier/go-toml v1.2.0/go.mod h1:5z9KED0ma1S8pY6P1sdut58dfprrGBbd/94hg7ilaic=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=

pkg/config/constants.go

@@ -15,6 +15,7 @@ import (
 	"github.com/arcticicestudio/snowsaw/pkg/api/snowblock"
 	"github.com/arcticicestudio/snowsaw/pkg/config/source/file"
 	"github.com/arcticicestudio/snowsaw/pkg/snowblock/task"
+	"github.com/arcticicestudio/snowsaw/pkg/snowblock/task/link"
 )
 
 const (
@@ -38,7 +39,9 @@ var (
 	// AppConfigPaths is the default paths the application will search for configuration files.
 	AppConfigPaths []*file.File
 
-	availableTaskRunner []snowblock.TaskRunner
+	availableTaskRunner = []snowblock.TaskRunner{
+		&link.Link{},
+	}
 
 	// BuildDateTime is the date and time this application was build.
 	BuildDateTime string

pkg/snowblock/task/link/link.go

@@ -0,0 +1,347 @@
+// 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 link provides a task runner implementation to create symbolic links for files and directories.
+package link
+
+import (
+	"errors"
+	"fmt"
+	"os"
+	"path/filepath"
+	"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 (
+	// DefaultHostName is the name for host mappings that will apply to all host.
+	// To prevent possible collisions with actual host names, it is a single minus character.
+	// As defined in the specification this is not a valid hostname since the name should not start or end with a minus.
+	// See "RFC 1123" and https://en.wikipedia.org/wiki/Hostname#Restrictions_on_valid_hostnames for more details about
+	// restrictions and valid names.
+	DefaultHostName = "-"
+)
+
+// Link is a task runner to create symbolic links for files and directories.
+type Link struct {
+	config           *config
+	destAbsPath      string
+	destPath         string
+	snowblockAbsPath string
+	srcAbsPath       string
+}
+
+type config struct {
+	Create   bool              `json:"create" yaml:"create"`
+	Force    bool              `json:"force" yaml:"force"`
+	Hosts    map[string]string `json:"hosts,flow" yaml:"hosts,flow"`
+	Path     string            `json:"path" yaml:"path"`
+	Relative bool              `json:"relative" yaml:"relative"`
+	Relink   bool              `json:"relink" yaml:"relink"`
+}
+
+// GetTaskName returns the name of the task this runner can process.
+func (l Link) GetTaskName() string {
+	return "link"
+}
+
+// Run processes a task using the given task instructions.
+// The snowblockAbsPath parameter is the absolute path of the snowblock used as contextual information.
+func (l *Link) Run(configuration snowblock.TaskConfiguration, snowblockAbsPath string) error {
+	l.snowblockAbsPath = snowblockAbsPath
+
+	// Try to convert given task configurations...
+	configMap, ok := configuration.(map[string]interface{})
+	if !ok {
+		prt.Debugf("invalid link configuration type: %s", color.RedString("%T", configuration))
+		return errors.New("malformed link configuration")
+	}
+
+	// ...and handle the possible types.
+	for destPath, configData := range configMap {
+		l.destAbsPath = ""
+		l.srcAbsPath = ""
+
+		switch configType := configData.(type) {
+		// Handle JSON `null` value configurations used to omit duplicate definitions when the source path equals the
+		// destination path.
+		// Uses the base name of the destination path and trims a leading dot character if present.
+		case nil:
+			sourceBaseName := strings.TrimPrefix(filepath.Base(destPath), ".")
+			l.config = &config{Path: sourceBaseName}
+			l.destPath = destPath
+			if execErr := l.execute(); execErr != nil {
+				return execErr
+			}
+
+		// Handle JSON `object` configurations used to define more link options.
+		// Uses the base name of the destination path with leading dot character trimmed if path is not specified.
+		case map[string]interface{}:
+			c := new(config)
+			if err := mapstructure.Decode(configType, &c); err != nil {
+				return err
+			}
+			l.destPath = destPath
+			if c.Path == "" {
+				c.Path = strings.TrimPrefix(filepath.Base(destPath), ".")
+			}
+			l.config = c
+			if execErr := l.execute(); execErr != nil {
+				return execErr
+			}
+
+		// Handle JSON `string` configurations used to only specify the source path.
+		case string:
+			l.config = &config{Path: configType}
+			l.destPath = destPath
+			if execErr := l.execute(); execErr != nil {
+				return execErr
+			}
+
+		// Reject invalid or unsupported JSON data structures.
+		default:
+			prt.Debugf("unsupported destination type: %s", color.RedString("%T", configType))
+			return fmt.Errorf("unsupported link configuration: %s", color.CyanString(destPath))
+		}
+	}
+
+	return nil
+}
+
+func (l *Link) execute() error {
+	// Check if the current and/or default host is listed in the target mapping, otherwise stop processing.
+	isTargetHost, hostCheckErr := l.isTargetHost()
+	if hostCheckErr != nil {
+		return hostCheckErr
+	}
+	if !isTargetHost {
+		return nil
+	}
+
+	// Dissolve the source to an absolute path.
+	srcAbsPath, srcToAbsPathErr := filepath.Abs(filepath.Join(l.snowblockAbsPath, l.config.Path))
+	if srcToAbsPathErr != nil {
+		return srcToAbsPathErr
+	}
+	l.srcAbsPath = srcAbsPath
+
+	// Fail fast if the source node does not exist.
+	if sourceNodeExistsErr := l.checkSourceNode(); sourceNodeExistsErr != nil {
+		return sourceNodeExistsErr
+	}
+
+	// Expand the destination path to dissolve environment variables and special characters like tilde...
+	expDestPath, pathExpandErr := filesystem.ExpandPath(l.destPath)
+	if pathExpandErr != nil {
+		return pathExpandErr
+	}
+
+	if !filepath.IsAbs(expDestPath) {
+		l.destAbsPath = filepath.Join(l.snowblockAbsPath, expDestPath)
+	} else {
+		l.destAbsPath = expDestPath
+	}
+
+	destNodeExists, nodeExistErr := filesystem.NodeExists(l.destAbsPath)
+	if nodeExistErr != nil {
+		return nodeExistErr
+	}
+	// Check if the destination node already exists,...
+	if destNodeExists {
+		isSymlink, symlinkCheckErr := filesystem.IsSymlink(l.destAbsPath)
+		if symlinkCheckErr != nil {
+			return symlinkCheckErr
+		}
+		// ...evaluate if it is a symbolic link,...
+		if isSymlink {
+			symlinkDest, symlinkReadErr := os.Readlink(l.destAbsPath)
+			if symlinkReadErr != nil {
+				return symlinkReadErr
+			}
+			symlinkDestAbs, symlinkDestAbsErr := filepath.Abs(symlinkDest)
+			if symlinkDestAbsErr != nil {
+				return symlinkDestAbsErr
+			}
+
+			// ...and continue with processing when running in relinking mode,...
+			if l.config.Relink {
+				prt.Warnf("%s already existing symbolic link: %s",
+					color.YellowString("Relinking"), color.CyanString(l.destAbsPath))
+				if removeErr := os.Remove(l.destAbsPath); removeErr != nil {
+					return removeErr
+				}
+				if parentDirErr := l.handleParentDirStructure(); parentDirErr != nil {
+					return parentDirErr
+				}
+				if symlinkCreationError := l.createSymbolicLink(); symlinkCreationError != nil {
+					return symlinkCreationError
+				}
+				return nil
+			}
+
+			// ...or stop processing when it already links to the correct destination,...
+			if symlinkDestAbs == l.srcAbsPath {
+				prt.Infof("Skipped already existing link: %s", color.CyanString(l.destAbsPath))
+				return nil
+			}
+
+			// ...otherwise only if force linking is enabled.
+			if l.config.Force {
+				prt.Warnf("%s of already existing symbolic link: %s",
+					color.YellowString("Forced linking"), color.CyanString(l.destAbsPath))
+				if removeErr := os.Remove(l.destAbsPath); removeErr != nil {
+					return removeErr
+				}
+				if parentDirErr := l.handleParentDirStructure(); parentDirErr != nil {
+					return parentDirErr
+				}
+				if symlinkCreationError := l.createSymbolicLink(); symlinkCreationError != nil {
+					return symlinkCreationError
+				}
+				return nil
+			}
+
+			return fmt.Errorf("symbolic link already exists: %s ← %s", symlinkDest, l.destAbsPath)
+		}
+
+		// Always process the task in force mode when the destination is an already existing file or directory,...
+		if l.config.Force {
+			prt.Warnf("%s of already existing symbolic link: %s",
+				color.YellowString("Forced linking"), color.CyanString(l.destAbsPath))
+			if removeErr := os.Remove(l.destAbsPath); removeErr != nil {
+				return removeErr
+			}
+			if parentDirErr := l.handleParentDirStructure(); parentDirErr != nil {
+				return parentDirErr
+			}
+			if symlinkCreationError := l.createSymbolicLink(); symlinkCreationError != nil {
+				return symlinkCreationError
+			}
+			return nil
+		}
+
+		return fmt.Errorf("file or directory already exists: %s", l.config.Path)
+	}
+
+	// ...otherwise only when all previous conditions are not met.
+	if parentDirErr := l.handleParentDirStructure(); parentDirErr != nil {
+		return parentDirErr
+	}
+	if symlinkCreateErr := l.createSymbolicLink(); symlinkCreateErr != nil {
+		return symlinkCreateErr
+	}
+
+	return nil
+}
+
+// checkSourceNode checks if the source node at the given path exists, otherwise returns the corresponding error.
+func (l *Link) checkSourceNode() error {
+	sourceNodeExists, err := filesystem.NodeExists(l.srcAbsPath)
+	if err != nil {
+		return err
+	}
+	if !sourceNodeExists {
+		return fmt.Errorf("no such file or directory: %s", l.config.Path)
+	}
+
+	return nil
+}
+
+// createSymbolicLink creates the symbolic link based on the value of the task option that allows to use relative
+// instead of absolute paths.
+// If any error occurs it will be returned, otherwise returns nil.
+func (l *Link) createSymbolicLink() error {
+	if l.config.Relative {
+		srcRelPath, srcRelPathErr := filepath.Rel(filepath.Dir(l.destAbsPath), l.srcAbsPath)
+		if srcRelPathErr != nil {
+			return fmt.Errorf("could not dissolve path of source relative to destination directory: %v", srcRelPathErr)
+		}
+
+		if relSymlinkErr := os.Symlink(srcRelPath, l.destAbsPath); relSymlinkErr != nil {
+			return relSymlinkErr
+		}
+		prt.Infof("Created relative symbolic link: %s → %s", color.CyanString(l.srcAbsPath), color.BlueString(l.srcAbsPath))
+		return nil
+	}
+
+	if symlinkErr := os.Symlink(l.srcAbsPath, l.destAbsPath); symlinkErr != nil {
+		return symlinkErr
+	}
+	prt.Infof("Created symbolic link: %s → %s", color.BlueString(l.destAbsPath), color.CyanString(l.srcAbsPath))
+	return nil
+}
+
+// handleParentDirStructure checks if the required parent directory structure for the symbolic links exists,
+// otherwise creates it if the corresponding task option has been specified.
+// If any error occurs it will be returned, otherwise returns nil.
+func (l *Link) handleParentDirStructure() error {
+	destParentDirs := filepath.Dir(l.destAbsPath)
+	destParentDirsExist, nodeExistErr := filesystem.DirExists(destParentDirs)
+	if nodeExistErr != nil {
+		return nodeExistErr
+	}
+	if !destParentDirsExist {
+		if l.config.Create {
+			if mkdirErr := os.MkdirAll(destParentDirs, os.ModePerm); mkdirErr != nil {
+				return mkdirErr
+			}
+			prt.Debugf("Created parent directory structure: %s", destParentDirs)
+		} else {
+			return fmt.Errorf("no such directory: %s", destParentDirs)
+		}
+	}
+
+	return nil
+}
+
+// isTargetHost checks if the current and/or default host is listed in the target mapping.
+// It returns the host specific source path, otherwise if an error occurs an empty string along with the error.
+func (l *Link) isTargetHost() (bool, error) {
+	if len(l.config.Hosts) > 0 {
+		hostname, err := os.Hostname()
+		if err != nil {
+			return false, fmt.Errorf("failed to determine hostname: %v", err)
+		}
+		sourcePath, isTargetHost := l.config.Hosts[hostname]
+		sourcePathDefaultHost, isDefaultTargetHost := l.config.Hosts[DefaultHostName]
+		if !isTargetHost && !isDefaultTargetHost {
+			prt.Debugf("Skipped host specific link not matching current host %s: %s",
+				color.BlueString(hostname), color.CyanString(l.destPath))
+			return false, nil
+		}
+
+		// Use the default target host if specified...
+		if isDefaultTargetHost {
+			prt.Debugf("Found host mapping for default target: %s", color.CyanString(sourcePathDefaultHost))
+			l.config.Path = sourcePathDefaultHost
+		}
+		// ...and override when exact host name has also been specified.
+		if isTargetHost {
+			prt.Debugf("Using source path for exact host name match %s: %s",
+				color.BlueString(hostname), color.CyanString(sourcePath))
+			l.config.Path = sourcePath
+		}
+
+		return true, nil
+	}
+
+	if l.config.Path != "" {
+		return true, nil
+	}
+
+	return false, nil
+}