[DEVOPS-570] Added command fact plugin (#73)

Author: yusufhm

docs/src/.vuepress/config.js

@@ -93,6 +93,7 @@ module.exports = {
               path: '/reference/collect',
               collapsable: false,
               children: [
+                ['/reference/collect/command', 'command'],
                 ['/reference/collect/database-search', 'database:search'],
                 ['/reference/collect/docker-command', 'docker:command'],
                 ['/reference/collect/docker-images', 'docker:images'],

docs/src/reference/README.md

@@ -10,6 +10,7 @@ The following Connection plugins are available:
 ## Collect plugins
 
 The following Collect/Fact plugins are available:
+  - [command](../reference/collect/command)
   - [database:search](../reference/collect/database-search)
   - [docker:command](../reference/collect/docker-command)
   - [docker:images](../reference/collect/docker-images)

docs/src/reference/collect/command.md

@@ -0,0 +1,26 @@
+# command
+
+The `command` collect plugin executes a command and returns the output, error and exit code as a map.
+
+## Plugin fields
+
+| Field | Description                                 | Required | Default |
+| ----- | ------------------------------------------- | :------: | :-----: |
+| cmd   | The main command to run.                    |   Yes    |   ""    |
+| args  | A list of arguments to pass to the command. |    No    |   []    |
+
+<Content :page-key="$site.pages.find(p => p.path === '/reference/common/collect.html').key"/>
+
+## Return format
+
+A map with the following fields:
+
+| Field | Description |
+| ----- | ----------- |
+| out   | The command output. |
+| err   | The command error. |
+| code  | The command exit code. |
+
+## Example
+
+<<< @/../examples/remediation.yml{3-9}

docs/src/reference/common/collect.md

@@ -0,0 +1,8 @@
+## Common fields
+
+| Field             | Description                                                                                         | Required | Default |
+| ----------------- | --------------------------------------------------------------------------------------------------- | :------: | :-----: |
+| name              | The name/identifier of the plugin - this is the yaml key in the config file when defining the fact. |   Yes    |    -    |
+| connection        | The connection to use for collecting the fact.                                                      |    No    |   ""    |
+| input             | A previous input to use when collecting the fact.                                                   |    No    |   ""    |
+| additional-inputs | Additional previous inputs to use when collecting the fact.                                         |    No    |   []    |

examples/remediation.yml

@@ -0,0 +1,10 @@
+collect:
+  db-tfa-module:
+    command:
+      cmd: bash
+      args:
+      - -c
+      - |
+        set -o pipefail
+        drush pm:list --no-core --package=Security --fields=name,status --format=json|jq -r '.tfa.status'
+

pkg/command/command.go

@@ -59,3 +59,15 @@ func GetMsgFromCommandError(err error) string {
 	}
 	return errMsg
 }
+
+func GetExitCode(err error) int {
+	var exitErr *exec.ExitError
+	if errors.As(err, &exitErr) {
+		return exitErr.ExitCode()
+	}
+
+	if err != nil {
+		return 1
+	}
+	return 0
+}

pkg/command/command_test.go

@@ -92,3 +92,24 @@ func TestGetMsgFromCommandError(t *testing.T) {
 		assert.Equal("basic error", msg)
 	})
 }
+
+func TestGetExitCode(t *testing.T) {
+	assert := assert.New(t)
+
+	t.Run("exitError", func(t *testing.T) {
+		exitCode := command.GetExitCode(&exec.ExitError{
+			Stderr: []byte("some error"),
+		})
+		assert.Equal(-1, exitCode)
+	})
+
+	t.Run("error", func(t *testing.T) {
+		exitCode := command.GetExitCode(errors.New("basic error"))
+		assert.Equal(1, exitCode)
+	})
+
+	t.Run("nil", func(t *testing.T) {
+		exitCode := command.GetExitCode(nil)
+		assert.Equal(0, exitCode)
+	})
+}

pkg/fact/command/command.go

@@ -0,0 +1,83 @@
+package command
+
+import (
+	"fmt"
+	"strconv"
+	"strings"
+
+	log "github.com/sirupsen/logrus"
+
+	"github.com/salsadigitalauorg/shipshape/pkg/command"
+	"github.com/salsadigitalauorg/shipshape/pkg/connection"
+	"github.com/salsadigitalauorg/shipshape/pkg/data"
+	"github.com/salsadigitalauorg/shipshape/pkg/fact"
+)
+
+// Command is a representation of a shell command.
+type Command struct {
+	// Common fields.
+	Name                 string          `yaml:"name"`
+	Format               data.DataFormat `yaml:"format"`
+	ConnectionName       string          `yaml:"connection"`
+	InputName            string          `yaml:"input"`
+	AdditionalInputNames []string        `yaml:"additional-inputs"`
+
+	connection       connection.Connectioner
+	input            fact.Facter
+	additionalInputs []fact.Facter
+	errors           []error
+	data             interface{}
+
+	// Plugin fields.
+	Cmd  string   `yaml:"cmd"`
+	Args []string `yaml:"args"`
+}
+
+//go:generate go run ../../../cmd/gen.go fact-plugin --plugin=Command --package=command
+
+func init() {
+	fact.Registry["command"] = func(n string) fact.Facter {
+		return &Command{Name: n, Format: data.FormatMapString}
+	}
+}
+
+func (p *Command) PluginName() string {
+	return "command"
+}
+
+func (p *Command) SupportedConnections() (fact.SupportLevel, []string) {
+	return fact.SupportNone, []string{}
+}
+
+func (p *Command) SupportedInputs() (fact.SupportLevel, []string) {
+	return fact.SupportNone, []string{}
+}
+
+func (p *Command) Collect() {
+	log.WithFields(log.Fields{
+		"fact-plugin": p.PluginName(),
+		"fact":        p.Name,
+		"cmd":         p.Cmd,
+		"args":        p.Args,
+	}).Debug("collecting data")
+
+	res := map[string]string{
+		"code":   "0",
+		"stdout": "",
+		"stderr": "",
+	}
+
+	data, err := command.ShellCommander(p.Cmd, p.Args...).Output()
+	log.WithFields(log.Fields{
+		"stdout": string(data),
+		"stderr": fmt.Sprintf("%#v", err),
+	}).Debug("command output")
+
+	res["stdout"] = strings.Trim(string(data), " \n")
+	if err != nil {
+		res["code"] = strconv.Itoa(command.GetExitCode(err))
+		res["stderr"] = command.GetMsgFromCommandError(err)
+	}
+
+	p.data = res
+}

pkg/fact/command/command_test.go

@@ -0,0 +1,73 @@
+package command_test
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+
+	"github.com/salsadigitalauorg/shipshape/pkg/fact"
+	. "github.com/salsadigitalauorg/shipshape/pkg/fact/command"
+	"github.com/salsadigitalauorg/shipshape/pkg/internal"
+)
+
+func TestCommandInit(t *testing.T) {
+	assert := assert.New(t)
+
+	// Test that the command plugin is registered.
+	factPlugin := fact.Registry["command"]("TestCommand")
+	assert.NotNil(factPlugin)
+	keyFacter, ok := factPlugin.(*Command)
+	assert.True(ok)
+	assert.Equal("TestCommand", keyFacter.Name)
+}
+
+func TestCommandPluginName(t *testing.T) {
+	commandF := Command{Name: "TestCommand"}
+	assert.Equal(t, "command", commandF.PluginName())
+}
+
+func TestCommandSupportedConnections(t *testing.T) {
+	commandF := Command{Name: "TestCommand"}
+	supportLevel, connections := commandF.SupportedConnections()
+	assert.Equal(t, fact.SupportNone, supportLevel)
+	assert.Empty(t, connections)
+}
+
+func TestCommandSupportedInputs(t *testing.T) {
+	commandF := Command{Name: "TestCommand"}
+	supportLevel, inputs := commandF.SupportedInputs()
+	assert.Equal(t, fact.SupportNone, supportLevel)
+	assert.ElementsMatch(t, []string{}, inputs)
+}
+
+func TestCommandCollect(t *testing.T) {
+	tests := []internal.FactCollectTest{
+		{
+			Name:   "emptyCommand",
+			Facter: &Command{Name: "TestCommand"},
+			ExpectedData: map[string]string{
+				"code": "1", "stderr": "exec: no command", "stdout": "",
+			},
+		},
+		{
+			Name:   "echo",
+			Facter: &Command{Name: "TestCommand", Cmd: "echo", Args: []string{"hello"}},
+			ExpectedData: map[string]string{
+				"code": "0", "stderr": "", "stdout": "hello",
+			},
+		},
+		{
+			Name:   "multiline",
+			Facter: &Command{Name: "TestCommand", Cmd: "ls", Args: []string{"-A1"}},
+			ExpectedData: map[string]string{
+				"code": "0", "stderr": "", "stdout": "command.go\ncommand_gen.go\ncommand_test.go",
+			},
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.Name, func(t *testing.T) {
+			internal.TestFactCollect(t, tt)
+		})
+	}
+}