Merge pull request #78 from salsadigitalauorg/feature/plugin-refactor

feat: plugin refactor

cmd/collect.go

@@ -24,18 +24,18 @@ output them in the format specified`,
 	Run: func(cmd *cobra.Command, args []string) {
 		shipshape.FactsOnly = true
 		runCmd.Run(cmd, args)
-		for _, f := range fact.Facts {
+		for _, f := range fact.Manager().GetPlugins() {
 			if shouldSkipFact(f) {
 				continue
 			}
 
 			log.WithFields(log.Fields{
 				"fact":   f.GetName(),
 				"format": f.GetFormat(),
-				"data":   f.GetData(),
 			}).Debug("printing collected fact")
 			fmt.Printf("%s:", f.GetName())
 			switch f.GetFormat() {
+
 			case data.FormatMapListString:
 				loadedData := data.AsMapListString(f.GetData())
 				for k, vList := range loadedData {
@@ -44,6 +44,7 @@ output them in the format specified`,
 						fmt.Printf("    - %s\n", v)
 					}
 				}
+
 			case data.FormatMapString:
 				loadedData := data.AsMapString(f.GetData())
 				fmt.Println()
@@ -55,6 +56,7 @@ output them in the format specified`,
 						fmt.Printf("  %s: %s\n", k, v)
 					}
 				}
+
 			case data.FormatMapNestedString:
 				loadedData := data.AsMapNestedString(f.GetData())
 				fmt.Println()
@@ -64,10 +66,17 @@ output them in the format specified`,
 						fmt.Printf("    %s: %s\n", k2, v)
 					}
 				}
+
 			case data.FormatString:
 				fmt.Printf(" %s\n", f.GetData())
+
+			case data.FormatRaw:
+				fmt.Println("\n",
+					output.TabbedMultiline("  ", fmt.Sprintf("%s", f.GetData())))
+
 			default:
-				fmt.Println(" collect not yet implemented for", f.GetFormat())
+				log.WithField("data", fmt.Sprintf("%s", f.GetData())).Warn("collect not yet implemented for this format")
+				fmt.Println("  collect not yet implemented for", f.GetFormat())
 			}
 			fmt.Println()
 		}

cmd/config.go

@@ -45,17 +45,17 @@ var configListPluginsCmd = &cobra.Command{
 	Long:  `List all available plugins that can be used in shipshape`,
 	Run: func(cmd *cobra.Command, args []string) {
 		fmt.Println("Connection plugins:")
-		for _, p := range connection.RegistryKeys() {
+		for _, p := range connection.Manager().GetFactoriesKeys() {
 			fmt.Println("  - " + p)
 		}
 
 		fmt.Println("\nFact plugins:")
-		for _, p := range fact.RegistryKeys() {
+		for _, p := range fact.Manager().GetFactoriesKeys() {
 			fmt.Println("  - " + p)
 		}
 
 		fmt.Println("\nAnalyse plugins:")
-		for _, p := range analyse.RegistryKeys() {
+		for _, p := range analyse.Manager().GetFactoriesKeys() {
 			fmt.Println("  - " + p)
 		}
 

cmd/gen.go

@@ -40,20 +40,10 @@ func main() {
 		}
 		gen.BreachType(breachTypes)
 		break
-	case "connection-plugin":
-		if len(plugins) == 0 {
-			log.Fatal("connection-plugin missing flags; plugin is required")
-		}
-		gen.ConnectionPlugin(plugins)
-		break
 	case "fact-plugin":
-		if len(plugins) == 0 {
-			log.Fatal("fact-plugin missing flags; plugin is required")
-		}
 		if pkg == "" {
 			log.Fatal("fact-plugin missing flags; package is required")
 		}
-		gen.FactPlugin(plugins, pkg, enableEnvResolver)
 		gen.FactRegistry(pkg)
 		break
 	case "analyse-plugin":

cmd/gen/analyseplugin.go

@@ -11,7 +11,6 @@ func AnalysePlugin(plugins []string) {
 	log.Println("Generating analyse plugin funcs -", strings.Join(plugins, ","))
 
 	tmplPath := filepath.Join("..", "..", "pkg", "analyse", "templates", "analyseplugin.go.tmpl")
-	tmplTestPath := filepath.Join("..", "..", "pkg", "analyse", "templates", "analyseplugin_test.go.tmpl")
 
 	for _, p := range plugins {
 		pluginFile := strings.ToLower(p) + "_gen.go"
@@ -21,14 +20,5 @@ func AnalysePlugin(plugins []string) {
 		}
 
 		templateToFile(tmplPath, struct{ Plugin string }{p}, pluginFullFilePath)
-
-		// Test file.
-		pluginTestFile := strings.ToLower(p) + "_gen_test.go"
-		pluginFullTestFilePath := filepath.Join(getScriptPath(), "..", "..", "pkg", "analyse", pluginTestFile)
-		if err := os.Remove(pluginTestFile); err != nil && !os.IsNotExist(err) {
-			log.Fatalln(err)
-		}
-
-		templateToFile(tmplTestPath, struct{ Plugin string }{p}, pluginFullTestFilePath)
 	}
 }

cmd/gen/factplugin.go

@@ -3,35 +3,8 @@ package gen
 import (
 	"fmt"
 	"log"
-	"os"
-	"path/filepath"
-	"strings"
 )
 
-func FactPlugin(plugins []string, pkg string, envResolver bool) {
-	log.Printf("Generating fact plugin funcs for package %s: %s\n", pkg, strings.Join(plugins, ","))
-
-	tmplPath := filepath.Join("..", "..", "pkg", "fact", "templates", "factplugin.go.tmpl")
-
-	for _, p := range plugins {
-		pluginFile := strings.ToLower(p) + "_gen.go"
-		pluginDir := filepath.Join(getScriptPath(), "..", "..", "pkg", "fact")
-		if pkg != "fact" {
-			pluginDir = filepath.Join(pluginDir, pkg)
-		}
-		pluginFullFilePath := filepath.Join(pluginDir, pluginFile)
-		if err := os.Remove(pluginFullFilePath); err != nil && !os.IsNotExist(err) {
-			log.Fatalln(err)
-		}
-
-		templateToFile(tmplPath, struct {
-			Package     string
-			Plugin      string
-			EnvResolver bool
-		}{Package: pkg, Plugin: p, EnvResolver: envResolver}, pluginFullFilePath)
-	}
-}
-
 // FactRegistry adds the Facters for a package to the registry.
 func FactRegistry(pkg string) {
 	log.Println("Updating Fact plugins registry - adding", pkg)

examples/regex-not-match.yml

@@ -7,10 +7,11 @@ collect:
     yaml:key:
       input: extension-file
       path: module.lagoon_logs
+      ignore-not-found: true
 
 analyse:
   lagoon-logs-check:
     regex:not-match:
       description: Lagoon logs module is not enabled
       input: module-lagoon_logs
-      pattern: "^1$"
+      pattern: "^0$"

pkg/analyse/allowedlist.go

@@ -7,23 +7,11 @@ import (
 
 	"github.com/salsadigitalauorg/shipshape/pkg/breach"
 	"github.com/salsadigitalauorg/shipshape/pkg/data"
-	"github.com/salsadigitalauorg/shipshape/pkg/fact"
-	"github.com/salsadigitalauorg/shipshape/pkg/result"
 	"github.com/salsadigitalauorg/shipshape/pkg/utils"
 )
 
 type AllowedList struct {
-	// Common fields.
-	Id                    string `yaml:"name"`
-	Description           string `yaml:"description"`
-	InputName             string `yaml:"input"`
-	Severity              string `yaml:"severity"`
-	breach.BreachTemplate `yaml:"breach-format"`
-	Result                result.Result
-	Remediation           interface{} `yaml:"remediation"`
-	input                 fact.Facter
-
-	// Plugin fields.
+	BaseAnalyser `yaml:",inline"`
 	PackageMatch string `yaml:"package-match"`
 	pkgRegex     *regexp.Regexp
 	Allowed      []string `yaml:"allowed"`
@@ -36,10 +24,12 @@ type AllowedList struct {
 //go:generate go run ../../cmd/gen.go analyse-plugin --plugin=AllowedList --package=analyse
 
 func init() {
-	Registry["allowed:list"] = func(id string) Analyser { return NewAllowedList(id) }
+	Manager().RegisterFactory("allowed:list", func(id string) Analyser {
+		return NewAllowedList(id)
+	})
 }
 
-func (p *AllowedList) PluginName() string {
+func (p *AllowedList) GetName() string {
 	return "allowed:list"
 }