Changed CLI to use --types flag, a comma separated list of desired analyzers

Author: aaron-prindle

cmd/analyze.go

@@ -4,6 +4,7 @@ import (
 	"errors"
 	"fmt"
 	"os"
+	"strings"
 
 	"github.com/GoogleCloudPlatform/container-diff/differs"
 	"github.com/GoogleCloudPlatform/container-diff/utils"
@@ -20,20 +21,7 @@ var analyzeCmd = &cobra.Command{
 			glog.Error(err.Error())
 			os.Exit(1)
 		}
-		analyzeArgs := []string{}
-		allAnalyzers := getAllAnalyzers()
-		for _, name := range allAnalyzers {
-			if *analyzeFlagMap[name] == true {
-				analyzeArgs = append(analyzeArgs, name)
-			}
-		}
-
-		// If no analyzers are specified, perform them all as the default
-		if len(analyzeArgs) == 0 {
-			analyzeArgs = allAnalyzers
-		}
-
-		if err := analyzeImage(args[0], analyzeArgs); err != nil {
+		if err := analyzeImage(args[0], strings.Split(types, ",")); err != nil {
 			glog.Error(err)
 			os.Exit(1)
 		}

cmd/diff.go

@@ -4,6 +4,7 @@ import (
 	"errors"
 	"fmt"
 	"os"
+	"strings"
 	"sync"
 
 	"github.com/GoogleCloudPlatform/container-diff/differs"
@@ -21,20 +22,7 @@ var diffCmd = &cobra.Command{
 			glog.Error(err.Error())
 			os.Exit(1)
 		}
-		analyzeArgs := []string{}
-		allAnalyzers := getAllAnalyzers()
-		for _, name := range allAnalyzers {
-			if *analyzeFlagMap[name] == true {
-				analyzeArgs = append(analyzeArgs, name)
-			}
-		}
-
-		// If no analyzers are specified, perform them all as the default
-		if len(analyzeArgs) == 0 {
-			analyzeArgs = allAnalyzers
-		}
-
-		if err := diffImages(args[0], args[1], analyzeArgs); err != nil {
+		if err := diffImages(args[0], args[1], strings.Split(types, ",")); err != nil {
 			glog.Error(err)
 			os.Exit(1)
 		}

cmd/root.go

@@ -3,7 +3,6 @@ package cmd
 import (
 	"bytes"
 	"context"
-	"errors"
 	goflag "flag"
 	"fmt"
 	"os"
@@ -13,26 +12,14 @@ import (
 	"github.com/GoogleCloudPlatform/container-diff/utils"
 	"github.com/docker/docker/client"
 	"github.com/golang/glog"
+	"github.com/pkg/errors"
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
 )
 
 var json bool
-var eng bool
 var save bool
-var apt bool
-var node bool
-var file bool
-var history bool
-var pip bool
-
-var analyzeFlagMap = map[string]*bool{
-	"apt":     &apt,
-	"node":    &node,
-	"file":    &file,
-	"history": &history,
-	"pip":     &pip,
-}
+var types string
 
 type validatefxn func(args []string) (bool, error)
 
@@ -90,14 +77,6 @@ func cleanupImage(image utils.Image) {
 	}
 }
 
-func getAllAnalyzers() []string {
-	allAnalyzers := []string{}
-	for name := range analyzeFlagMap {
-		allAnalyzers = append(allAnalyzers, name)
-	}
-	return allAnalyzers
-}
-
 func validateArgs(args []string, validatefxns ...validatefxn) (bool, error) {
 	for _, validatefxn := range validatefxns {
 		valid, err := validatefxn(args)
@@ -157,11 +136,7 @@ func init() {
 
 func addSharedFlags(cmd *cobra.Command) {
 	cmd.Flags().BoolVarP(&json, "json", "j", false, "JSON Output defines if the diff should be returned in a human readable format (false) or a JSON (true).")
-	cmd.Flags().BoolVarP(&pip, "pip", "p", false, "Set this flag to use the pip differ.")
-	cmd.Flags().BoolVarP(&node, "node", "n", false, "Set this flag to use the node differ.")
-	cmd.Flags().BoolVarP(&apt, "apt", "a", false, "Set this flag to use the apt differ.")
-	cmd.Flags().BoolVarP(&file, "file", "f", false, "Set this flag to use the file differ.")
-	cmd.Flags().BoolVarP(&history, "history", "d", false, "Set this flag to use the dockerfile history differ.")
+	cmd.Flags().StringVarP(&types, "types", "t", "", "This flag sets the list of analyzer types to use.  It expects a comma separated list of supported analyzers.")
 	cmd.Flags().BoolVarP(&save, "save", "s", false, "Set this flag to save rather than remove the final image filesystems on exit.")
 	cmd.Flags().BoolVarP(&utils.SortSize, "order", "o", false, "Set this flag to sort any file/package results by descending size. Otherwise, they will be sorted by name.")
 }

main

@@ -72,75 +72,75 @@ func TestDiffAndAnalysis(t *testing.T) {
 			subcommand:   "diff",
 			imageA:       diffBase,
 			imageB:       diffModified,
-			differFlag:   "-f",
+			differFlag:   "--types=file",
 			expectedFile: "file_diff_expected.json",
 		},
 		{
 			description:  "apt differ",
 			subcommand:   "diff",
 			imageA:       aptBase,
 			imageB:       aptModified,
-			differFlag:   "-a",
+			differFlag:   "--types=apt",
 			expectedFile: "apt_diff_expected.json",
 		},
 		{
 			description:  "node differ",
 			subcommand:   "diff",
 			imageA:       nodeBase,
 			imageB:       nodeModified,
-			differFlag:   "-n",
+			differFlag:   "--types=node",
 			expectedFile: "node_diff_order_expected.json",
 		},
 		{
 			description:  "multi differ",
 			subcommand:   "diff",
 			imageA:       multiBase,
 			imageB:       multiModified,
-			differFlag:   "-npa",
+			differFlag:   "--types=node,pip,apt",
 			expectedFile: "multi_diff_expected.json",
 		},
 		{
 			description:  "history differ",
 			subcommand:   "diff",
 			imageA:       diffBase,
 			imageB:       diffModified,
-			differFlag:   "-d",
+			differFlag:   "--types=history",
 			expectedFile: "hist_diff_expected.json",
 		},
 		{
 			description:  "apt sorted differ",
 			subcommand:   "diff",
 			imageA:       aptBase,
 			imageB:       aptModified,
-			differFlag:   "-ao",
+			differFlag:   "--types=apt -o",
 			expectedFile: "apt_sorted_diff_expected.json",
 		},
 		{
 			description:  "apt analysis",
 			subcommand:   "analyze",
 			imageA:       aptModified,
-			differFlag:   "-a",
+			differFlag:   "--types=apt",
 			expectedFile: "apt_analysis_expected.json",
 		},
 		{
 			description:  "file sorted analysis",
 			subcommand:   "analyze",
 			imageA:       diffModified,
-			differFlag:   "-fo",
+			differFlag:   "--types=file -o",
 			expectedFile: "file_sorted_analysis_expected.json",
 		},
 		{
 			description:  "pip analysis",
 			subcommand:   "analyze",
 			imageA:       pipModified,
-			differFlag:   "-p",
+			differFlag:   "--types=pip",
 			expectedFile: "pip_analysis_expected.json",
 		},
 		{
 			description:  "node analysis",
 			subcommand:   "analyze",
 			imageA:       nodeModified,
-			differFlag:   "-n",
+			differFlag:   "--types=node",
 			expectedFile: "node_analysis_expected.json",
 		},
 	}