refactor command package to remove globals and add dependency injection

2026-11-01 23:16:30 +01:00 · 2022-04-26 18:23:03 +00:00
parent 7304bbf8ee
commit 6029dd7c2e
44 changed files with 1781 additions and 1870 deletions
@@ -0,0 +1,118 @@
+package options
+
+import (
+	"fmt"
+
+	"github.com/anchore/syft/internal/formats/table"
+	"github.com/anchore/syft/syft"
+	"github.com/anchore/syft/syft/pkg/cataloger"
+	"github.com/anchore/syft/syft/source"
+	"github.com/spf13/cobra"
+	"github.com/spf13/pflag"
+	"github.com/spf13/viper"
+)
+
+type PackagesOptions struct {
+	Scope                  string
+	Output                 []string
+	File                   string
+	Platform               string
+	Host                   string
+	Username               string
+	Password               string
+	Dockerfile             string
+	Exclude                []string
+	OverwriteExistingImage bool
+	ImportTimeout          uint
+}
+
+var _ Interface = (*PackagesOptions)(nil)
+
+func (o *PackagesOptions) AddFlags(cmd *cobra.Command, v *viper.Viper) error {
+	cmd.PersistentFlags().StringVarP(&o.Scope, "scope", "s", cataloger.DefaultSearchConfig().Scope.String(),
+		fmt.Sprintf("selection of layers to catalog, options=%v", source.AllScopes))
+
+	cmd.PersistentFlags().StringArrayVarP(&o.Output, "output", "o", FormatAliases(table.ID),
+		fmt.Sprintf("report output format, options=%v", FormatAliases(syft.FormatIDs()...)))
+
+	cmd.PersistentFlags().StringVarP(&o.File, "file", "", "",
+		"file to write the default report output to (default is STDOUT)")
+
+	cmd.PersistentFlags().StringVarP(&o.Platform, "platform", "", "",
+		"an optional platform specifier for container image sources (e.g. 'linux/arm64', 'linux/arm64/v8', 'arm64', 'linux')")
+
+	cmd.PersistentFlags().StringVarP(&o.Host, "host", "H", "",
+		"the hostname or URL of the Anchore Enterprise instance to upload to")
+
+	cmd.PersistentFlags().StringVarP(&o.Username, "username", "u", "",
+		"the username to authenticate against Anchore Enterprise")
+
+	cmd.PersistentFlags().StringVarP(&o.Password, "password", "p", "",
+		"the password to authenticate against Anchore Enterprise")
+
+	cmd.PersistentFlags().StringVarP(&o.Dockerfile, "dockerfile", "d", "",
+		"include dockerfile for upload to Anchore Enterprise")
+
+	cmd.PersistentFlags().StringArrayVarP(&o.Exclude, "exclude", "", nil,
+		"exclude paths from being scanned using a glob expression")
+
+	cmd.PersistentFlags().BoolVarP(&o.OverwriteExistingImage, "overwrite-existing-image", "", false,
+		"overwrite an existing image during the upload to Anchore Enterprise")
+
+	cmd.PersistentFlags().UintVarP(&o.ImportTimeout, "import-timeout", "", 30,
+		"set a timeout duration (in seconds) for the upload to Anchore Enterprise")
+
+	return bindPackageConfigOptions(cmd.PersistentFlags(), v)
+}
+
+func bindPackageConfigOptions(flags *pflag.FlagSet, v *viper.Viper) error {
+	// Formatting & Input options //////////////////////////////////////////////
+
+	if err := v.BindPFlag("package.cataloger.scope", flags.Lookup("scope")); err != nil {
+		return err
+	}
+
+	if err := v.BindPFlag("file", flags.Lookup("file")); err != nil {
+		return err
+	}
+
+	if err := v.BindPFlag("exclude", flags.Lookup("exclude")); err != nil {
+		return err
+	}
+
+	if err := v.BindPFlag("output", flags.Lookup("output")); err != nil {
+		return err
+	}
+
+	if err := v.BindPFlag("platform", flags.Lookup("platform")); err != nil {
+		return err
+	}
+
+	// Upload options //////////////////////////////////////////////////////////
+
+	if err := v.BindPFlag("anchore.host", flags.Lookup("host")); err != nil {
+		return err
+	}
+
+	if err := v.BindPFlag("anchore.username", flags.Lookup("username")); err != nil {
+		return err
+	}
+
+	if err := v.BindPFlag("anchore.password", flags.Lookup("password")); err != nil {
+		return err
+	}
+
+	if err := v.BindPFlag("anchore.dockerfile", flags.Lookup("dockerfile")); err != nil {
+		return err
+	}
+
+	if err := v.BindPFlag("anchore.overwrite-existing-image", flags.Lookup("overwrite-existing-image")); err != nil {
+		return err
+	}
+
+	if err := v.BindPFlag("anchore.import-timeout", flags.Lookup("import-timeout")); err != nil {
+		return err
+	}
+
+	return nil
+}