style(cli): resolve linter issues

Author: saitho

ansible/collection.go

@@ -13,6 +13,7 @@ import (
 	"github.com/spf13/viper"
 )
 
+// GetAnsibleVersion returns the installed Ansible version. Returns error if not installed
 func GetAnsibleVersion() (string, error) {
 	cmd := exec.Command("ansible", "--version")
 	var stdoutBuffer = new(bytes.Buffer)
@@ -34,6 +35,7 @@ func extractAnsibleVersion(versionCmdOutput string) string {
 	return r.FindStringSubmatch(versionLine)[1]
 }
 
+// GetCollectionDirs returns a list of Ansible collection paths from config or environment
 func GetCollectionDirs() ([]string, error) {
 	var customCollectionPath = viper.GetString("ansible.collection_path")
 	if customCollectionPath != "" {
@@ -63,6 +65,7 @@ func GetCollectionDirs() ([]string, error) {
 	return pathList, nil
 }
 
+// GetStackHeadCollectionLocation returns the exact path of where the StackHead collection has been installed to
 func GetStackHeadCollectionLocation() (string, error) {
 	collectionDirs, err := GetCollectionDirs()
 	if err != nil {

ansible/inventory.go

@@ -7,18 +7,23 @@ import (
 	"text/template"
 )
 
+// InventoryOptions is a configuration used during creation of the temporary inventory file
 type InventoryOptions struct {
-	IpAddress string
+	IPAddress string
 }
 
-func IpAddress(text string) InventoryOption {
+// IPAddress sets the corresponding inventory option
+func IPAddress(ipAddress string) InventoryOption {
 	return func(args *InventoryOptions) {
-		args.IpAddress = text
+		args.IPAddress = ipAddress
 	}
 }
 
+// InventoryOption is a single inventory setting
 type InventoryOption func(*InventoryOptions)
 
+// CreateInventoryFile creates a temporary inventory file with the given settings and returns an absolute file path.
+// Note: make sure to remove the file when you don't need it anymore!
 func CreateInventoryFile(options ...InventoryOption) (string, error) {
 	opts := &InventoryOptions{}
 	for _, setter := range options {
@@ -44,7 +49,7 @@ all:
     ansible_connection: ssh
   hosts:
     mackerel:
-      ansible_host: {{ .IpAddress }}
+      ansible_host: {{ .IPAddress }}
 `)
 
 	if err = t.Execute(tmpFile, opts); err != nil {

commands/init.go

@@ -7,14 +7,15 @@ import (
 	"github.com/getstackhead/stackhead/cli/routines"
 )
 
+// Init is a command object for Cobra that provides the init command
 var Init = &cobra.Command{
 	Use:   "init",
 	Short: "Install StackHead dependencies according to configuration file",
 	Long: `init will install all required dependencies according to configuration file.
 If no configuration file exists, it will start a wizard to create one.`,
 	Run: func(cmd *cobra.Command, args []string) {
 
-		routines.RunTask(commands_init.InstallCollection...)
-		routines.RunTask(commands_init.InstallModules...)
+		routines.RunTask(commandsinit.InstallCollection...)
+		routines.RunTask(commandsinit.InstallModules...)
 	},
 }

commands/init/install_collection.go

@@ -1,4 +1,4 @@
-package commands_init
+package commandsinit
 
 import (
 	"fmt"
@@ -25,6 +25,7 @@ func installCollectionDependencies() error {
 	)
 }
 
+// InstallCollection is a list of task options that provide the actual workflow being run
 var InstallCollection = []routines.TaskOption{
 	routines.Text("Installing StackHead Ansible collection"),
 	routines.Execute(func(wg *sync.WaitGroup, result chan routines.TaskResult) {
@@ -34,7 +35,7 @@ var InstallCollection = []routines.TaskOption{
 		// Check if Ansible is installed
 		_, err = ansible.GetAnsibleVersion()
 		if err != nil {
-			err = fmt.Errorf("Ansible could not be found on your system. Please install it.")
+			err = fmt.Errorf(fmt.Sprintf("Ansible could not be found on your system. Please install it."))
 		}
 
 		if err == nil {

commands/init/install_modules.go

@@ -1,4 +1,4 @@
-package commands_init
+package commandsinit
 
 import (
 	"fmt"
@@ -70,6 +70,7 @@ func installStackHeadModules() error {
 	return nil
 }
 
+// InstallModules is a list of task options that provide the actual workflow being run
 var InstallModules = []routines.TaskOption{
 	routines.Text("Installing StackHead modules"),
 	routines.Execute(func(wg *sync.WaitGroup, result chan routines.TaskResult) {

commands/setup.go

@@ -11,6 +11,7 @@ import (
 	"github.com/getstackhead/stackhead/cli/routines"
 )
 
+// SetupServer is a command object for Cobra that provides the setup command
 var SetupServer = &cobra.Command{
 	Use:     "setup [ipv4 address]",
 	Example: "setup 192.168.178.14",
@@ -24,7 +25,7 @@ var SetupServer = &cobra.Command{
 				defer wg.Done()
 
 				// Generate Inventory file
-				inventoryFile, err := ansible.CreateInventoryFile(ansible.IpAddress(args[0]))
+				inventoryFile, err := ansible.CreateInventoryFile(ansible.IPAddress(args[0]))
 				if err == nil {
 					defer os.Remove(inventoryFile)
 					err = routines.ExecAnsiblePlaybook("server-provision", inventoryFile)

commands/validate.go

@@ -9,6 +9,7 @@ import (
 	"github.com/getstackhead/stackhead/cli/jsonschema"
 )
 
+// Validate is a command object for Cobra that provides the validate command
 var Validate = &cobra.Command{
 	Use:     "validate [path to project definition file]",
 	Example: "validate ./my-project-definition.yml",

jsonschema/validation.go

@@ -41,11 +41,11 @@ func ValidateFile(filePath string) (*gojsonschema.Result, error) {
 	}
 
 	// YAML to JSON
-	configJson, err := yaml.YAMLToJSON(configData)
+	configJSON, err := yaml.YAMLToJSON(configData)
 	if err != nil {
 		return nil, err
 	}
-	documentLoader := gojsonschema.NewBytesLoader(configJson)
+	documentLoader := gojsonschema.NewBytesLoader(configJSON)
 
 	return gojsonschema.Validate(schemaLoader, documentLoader)
 }

routines/exec.go

@@ -12,6 +12,7 @@ import (
 	"github.com/getstackhead/stackhead/cli/ansible"
 )
 
+// Exec is a wrapper function around exec.Command with additional settings for this CLI
 func Exec(name string, arg ...string) error {
 	cmd := exec.Command(name, arg...)
 	var errBuffer = new(bytes.Buffer)
@@ -28,6 +29,7 @@ func Exec(name string, arg ...string) error {
 	return nil
 }
 
+// ExecAnsibleGalaxy is shortcut for executing a command via ansible-galaxy binary
 func ExecAnsibleGalaxy(args ...string) error {
 	collectionDir, err := ansible.GetCollectionDirs()
 	if err != nil {
@@ -37,6 +39,7 @@ func ExecAnsibleGalaxy(args ...string) error {
 	return Exec("ansible-galaxy", args...)
 }
 
+// ExecAnsiblePlaybook is shortcut for executing a playbook within the StackHead collection via ansible-playbook binary
 func ExecAnsiblePlaybook(playbookName string, inventoryPath string) error {
 	stackHeadLocation, err := ansible.GetStackHeadCollectionLocation()
 	if err != nil {

routines/tasks.go

@@ -11,40 +11,44 @@ import (
 )
 
 const (
-	InfoColor    = "\033[1;34m%s\033[0m%s"
-	NoticeColor  = "\033[1;36m%s\033[0m%s"
-	WarningColor = "\033[1;33m%s\033[0m%s"
-	ErrorColor   = "\033[1;31m%s\033[0m%s"
+	// ErrorColor colors the first text red and the second text default color
+	ErrorColor = "\033[1;31m%s\033[0m%s"
+	// SuccessColor colors the first text green and the second text default color
 	SuccessColor = "\033[1;32m%s\033[0m%s"
-	DebugColor   = "\033[0;36m%s\033[0m%s"
 )
 
+// TaskOptions is a configuration used to define the behaviour of tasks and processing functions
 type TaskOptions struct {
 	Text    string
 	Execute func(wg *sync.WaitGroup, results chan TaskResult)
 }
 
+// TaskResult is the result of a task execution and expected to be returned into the respective channel
 type TaskResult struct {
 	// internal name
 	Name    string
 	Message string
 	Error   bool
 }
 
+// Text assigns the given text to TaskOption.Text
 func Text(text string) TaskOption {
 	return func(args *TaskOptions) {
 		args.Text = text
 	}
 }
 
+// Execute assigns the given execution function to TaskOption.Execute
 func Execute(executeFunc func(wg *sync.WaitGroup, results chan TaskResult)) TaskOption {
 	return func(args *TaskOptions) {
 		args.Execute = executeFunc
 	}
 }
 
+// TaskOption is a single task setting
 type TaskOption func(*TaskOptions)
 
+// RunTask executes a task that can be configured using task options
 func RunTask(options ...TaskOption) {
 	t := &TaskOptions{
 		Text: "Processing...",