fix: bearer-ignore-flag not loaded for scan (#1222)

* fix: bearer-ignore-flag not loaded for scan * docs: update docs for new scan flag * fix: update stale snapshots * fix: test setup * feat: move bearer-ignore-file flag to General Flags * docs: update command data files for updated general flags * chore: update snapshots * fix: test setup
Bearer · Aug 28, 2023 · 911c5c1 · 911c5c1
1 parent 063492b
commit 911c5c1
Show file tree

Hide file tree

Showing 19 changed files with 155 additions and 116 deletions.
diff --git a/docs/_data/bearer_ignore_add.yaml b/docs/_data/bearer_ignore_add.yaml
@@ -2,6 +2,8 @@ name: ' ignore add'
 synopsis: Add an ignored fingerprint
 usage: ' ignore add <fingerprint> [flags]'
 options:
+    - name: api-key
+      usage: Use your Bearer API Key to send the report to Bearer.
     - name: author
       shorthand: a
       usage: Add author information to this ignored finding.
@@ -10,13 +12,28 @@ options:
       usage: Load bearer.ignore file from the specified path.
     - name: comment
       usage: Add a comment to this ignored finding.
+    - name: config-file
+      default_value: bearer.yml
+      usage: Load configuration from the specified path.
+    - name: debug-profile
+      default_value: "false"
+      usage: Generate profiling data for debugging
+    - name: disable-version-check
+      default_value: "false"
+      usage: Disable Bearer version checking
     - name: force
       default_value: "false"
       usage: Overwrite an existing ignored finding.
     - name: help
       shorthand: h
       default_value: "false"
       usage: help for add
+    - name: host
+      default_value: my.bearer.sh
+      usage: Specify the Host for sending the report.
+    - name: no-color
+      default_value: "false"
+      usage: Disable color in output
 example: |-
     # Add an ignored fingerprint to your bearer.ignore file
     $ bearer ignore add <fingerprint> --author Mish --comment "Possible false positive"

diff --git a/docs/_data/bearer_ignore_migrate.yaml b/docs/_data/bearer_ignore_migrate.yaml
@@ -3,19 +3,33 @@ synopsis: |
     Migrate ignored fingerprints from bearer.yml to bearer.ignore
 usage: ' ignore migrate [flags]'
 options:
+    - name: api-key
+      usage: Use your Bearer API Key to send the report to Bearer.
     - name: bearer-ignore-file
       default_value: bearer.ignore
       usage: Load bearer.ignore file from the specified path.
     - name: config-file
       default_value: bearer.yml
       usage: Load configuration from the specified path.
+    - name: debug-profile
+      default_value: "false"
+      usage: Generate profiling data for debugging
+    - name: disable-version-check
+      default_value: "false"
+      usage: Disable Bearer version checking
     - name: force
       default_value: "false"
       usage: Overwrite an existing ignored finding.
     - name: help
       shorthand: h
       default_value: "false"
       usage: help for migrate
+    - name: host
+      default_value: my.bearer.sh
+      usage: Specify the Host for sending the report.
+    - name: no-color
+      default_value: "false"
+      usage: Disable color in output
 example: |-
     # Migrate existing ignored (excluded) fingerprints from bearer.yml file to bearer.ignore
     $ bearer ignore migrate

diff --git a/docs/_data/bearer_ignore_remove.yaml b/docs/_data/bearer_ignore_remove.yaml
@@ -2,13 +2,30 @@ name: ' ignore remove'
 synopsis: Remove an ignored fingerprint
 usage: ' ignore remove <fingerprint> [flags]'
 options:
+    - name: api-key
+      usage: Use your Bearer API Key to send the report to Bearer.
     - name: bearer-ignore-file
       default_value: bearer.ignore
       usage: Load bearer.ignore file from the specified path.
+    - name: config-file
+      default_value: bearer.yml
+      usage: Load configuration from the specified path.
+    - name: debug-profile
+      default_value: "false"
+      usage: Generate profiling data for debugging
+    - name: disable-version-check
+      default_value: "false"
+      usage: Disable Bearer version checking
     - name: help
       shorthand: h
       default_value: "false"
       usage: help for remove
+    - name: host
+      default_value: my.bearer.sh
+      usage: Specify the Host for sending the report.
+    - name: no-color
+      default_value: "false"
+      usage: Disable color in output
 example: |-
     # Remove an ignored fingerprint from your bearer.ignore file
     $ bearer ignore remove <fingerprint>

diff --git a/docs/_data/bearer_ignore_show.yaml b/docs/_data/bearer_ignore_show.yaml
@@ -5,13 +5,30 @@ options:
     - name: all
       default_value: "false"
       usage: Show all ignored fingerprints.
+    - name: api-key
+      usage: Use your Bearer API Key to send the report to Bearer.
     - name: bearer-ignore-file
       default_value: bearer.ignore
       usage: Load bearer.ignore file from the specified path.
+    - name: config-file
+      default_value: bearer.yml
+      usage: Load configuration from the specified path.
+    - name: debug-profile
+      default_value: "false"
+      usage: Generate profiling data for debugging
+    - name: disable-version-check
+      default_value: "false"
+      usage: Disable Bearer version checking
     - name: help
       shorthand: h
       default_value: "false"
       usage: help for show
+    - name: host
+      default_value: my.bearer.sh
+      usage: Specify the Host for sending the report.
+    - name: no-color
+      default_value: "false"
+      usage: Disable color in output
 example: |-
     # Show the details of an ignored fingerprint from your bearer.ignore file
     $ bearer ignore show <fingerprint>

diff --git a/docs/_data/bearer_scan.yaml b/docs/_data/bearer_scan.yaml
@@ -4,6 +4,9 @@ usage: ' scan [flags] <path>'
 options:
     - name: api-key
       usage: Use your Bearer API Key to send the report to Bearer.
+    - name: bearer-ignore-file
+      default_value: bearer.ignore
+      usage: Load bearer.ignore file from the specified path.
     - name: config-file
       default_value: bearer.yml
       usage: Load configuration from the specified path.

diff --git a/e2e/flags/.snapshots/TestMetadataFlags-help-scan b/e2e/flags/.snapshots/TestMetadataFlags-help-scan
@@ -37,9 +37,10 @@ Scan Flags
       --skip-path strings                    Specify the comma separated files and directories to skip. Supports * syntax, e.g. --skip-path users/*.go,users/admin.sql
 
 General Flags
-      --config-file string      Load configuration from the specified path. (default "bearer.yml")
-      --disable-version-check   Disable Bearer version checking
-      --no-color                Disable color in output
+      --bearer-ignore-file string   Load bearer.ignore file from the specified path. (default "bearer.ignore")
+      --config-file string          Load configuration from the specified path. (default "bearer.yml")
+      --disable-version-check       Disable Bearer version checking
+      --no-color                    Disable color in output
 
 
 --

diff --git a/e2e/flags/.snapshots/TestMetadataFlags-scan-help b/e2e/flags/.snapshots/TestMetadataFlags-scan-help
@@ -37,9 +37,10 @@ Scan Flags
       --skip-path strings                    Specify the comma separated files and directories to skip. Supports * syntax, e.g. --skip-path users/*.go,users/admin.sql
 
 General Flags
-      --config-file string      Load configuration from the specified path. (default "bearer.yml")
-      --disable-version-check   Disable Bearer version checking
-      --no-color                Disable color in output
+      --bearer-ignore-file string   Load bearer.ignore file from the specified path. (default "bearer.ignore")
+      --config-file string          Load configuration from the specified path. (default "bearer.yml")
+      --disable-version-check       Disable Bearer version checking
+      --no-color                    Disable color in output
 
 
 --

diff --git a/e2e/flags/.snapshots/TestReportFlagsShouldFail-invalid-context-flag b/e2e/flags/.snapshots/TestReportFlagsShouldFail-invalid-context-flag
@@ -38,9 +38,10 @@ Scan Flags
       --skip-path strings                    Specify the comma separated files and directories to skip. Supports * syntax, e.g. --skip-path users/*.go,users/admin.sql
 
 General Flags
-      --config-file string      Load configuration from the specified path. (default "bearer.yml")
-      --disable-version-check   Disable Bearer version checking
-      --no-color                Disable color in output
+      --bearer-ignore-file string   Load bearer.ignore file from the specified path. (default "bearer.ignore")
+      --config-file string          Load configuration from the specified path. (default "bearer.yml")
+      --disable-version-check       Disable Bearer version checking
+      --no-color                    Disable color in output
 
 
 flag error: scan flag error: invalid context argument; supported values: health

diff --git a/e2e/flags/.snapshots/TestReportFlagsShouldFail-invalid-format-flag-privacy b/e2e/flags/.snapshots/TestReportFlagsShouldFail-invalid-format-flag-privacy
@@ -38,9 +38,10 @@ Scan Flags
       --skip-path strings                    Specify the comma separated files and directories to skip. Supports * syntax, e.g. --skip-path users/*.go,users/admin.sql
 
 General Flags
-      --config-file string      Load configuration from the specified path. (default "bearer.yml")
-      --disable-version-check   Disable Bearer version checking
-      --no-color                Disable color in output
+      --bearer-ignore-file string   Load bearer.ignore file from the specified path. (default "bearer.ignore")
+      --config-file string          Load configuration from the specified path. (default "bearer.yml")
+      --disable-version-check       Disable Bearer version checking
+      --no-color                    Disable color in output
 
 
 flag error: report flags error: invalid format argument for privacy report; supported values: json, yaml html

diff --git a/e2e/flags/.snapshots/TestReportFlagsShouldFail-invalid-format-flag-security b/e2e/flags/.snapshots/TestReportFlagsShouldFail-invalid-format-flag-security
@@ -38,9 +38,10 @@ Scan Flags
       --skip-path strings                    Specify the comma separated files and directories to skip. Supports * syntax, e.g. --skip-path users/*.go,users/admin.sql
 
 General Flags
-      --config-file string      Load configuration from the specified path. (default "bearer.yml")
-      --disable-version-check   Disable Bearer version checking
-      --no-color                Disable color in output
+      --bearer-ignore-file string   Load bearer.ignore file from the specified path. (default "bearer.ignore")
+      --config-file string          Load configuration from the specified path. (default "bearer.yml")
+      --disable-version-check       Disable Bearer version checking
+      --no-color                    Disable color in output
 
 
 flag error: report flags error: invalid format argument for security report; supported values: json, yaml, sarif, gitlab-sast, rdjson, html

diff --git a/e2e/flags/.snapshots/TestReportFlagsShouldFail-invalid-report-flag b/e2e/flags/.snapshots/TestReportFlagsShouldFail-invalid-report-flag
@@ -38,9 +38,10 @@ Scan Flags
       --skip-path strings                    Specify the comma separated files and directories to skip. Supports * syntax, e.g. --skip-path users/*.go,users/admin.sql
 
 General Flags
-      --config-file string      Load configuration from the specified path. (default "bearer.yml")
-      --disable-version-check   Disable Bearer version checking
-      --no-color                Disable color in output
+      --bearer-ignore-file string   Load bearer.ignore file from the specified path. (default "bearer.ignore")
+      --config-file string          Load configuration from the specified path. (default "bearer.yml")
+      --disable-version-check       Disable Bearer version checking
+      --no-color                    Disable color in output
 
 
 flag error: report flags error: invalid report argument; supported values: security, privacy

diff --git a/pkg/commands/ignore.go b/pkg/commands/ignore.go
@@ -57,7 +57,7 @@ Examples:
 
 func newIgnoreShowCommand() *cobra.Command {
 	var IgnoreShowFlags = &flag.Flags{
-		IgnoreFlagGroup:     flag.NewIgnoreFlagGroup(),
+		GeneralFlagGroup:    flag.NewGeneralFlagGroup(),
 		IgnoreShowFlagGroup: flag.NewIgnoreShowFlagGroup(),
 	}
 	cmd := &cobra.Command{
@@ -79,7 +79,7 @@ $ bearer ignore show <fingerprint>`,
 				return cmd.Help()
 			}
 
-			ignoredFingerprints, fileExists, err := ignore.GetIgnoredFingerprints(options.IgnoreOptions.BearerIgnoreFile)
+			ignoredFingerprints, fileExists, err := ignore.GetIgnoredFingerprints(options.GeneralOptions.BearerIgnoreFile, nil)
 			if err != nil {
 				cmd.Printf("Issue loading ignored fingerprints from bearer.ignore file: %s", err)
 				return nil
@@ -93,7 +93,7 @@ $ bearer ignore show <fingerprint>`,
 			if options.IgnoreShowOptions.All {
 				// show all fingerprints
 				for fingerprintId, fingerprint := range ignoredFingerprints {
-					cmd.Print(ignore.DisplayIgnoredEntryTextString(fingerprintId, fingerprint))
+					cmd.Print(ignore.DisplayIgnoredEntryTextString(fingerprintId, fingerprint, options.GeneralOptions.NoColor))
 				}
 			} else {
 				// show a specific fingerprint
@@ -103,7 +103,7 @@ $ bearer ignore show <fingerprint>`,
 					cmd.Printf("Ignored fingerprint '%s' was not found in bearer.ignore file\n", fingerprintId)
 					return nil
 				}
-				cmd.Print(ignore.DisplayIgnoredEntryTextString(fingerprintId, selectedIgnoredFingerprint))
+				cmd.Print(ignore.DisplayIgnoredEntryTextString(fingerprintId, selectedIgnoredFingerprint, options.GeneralOptions.NoColor))
 			}
 			cmd.Print("\n\n")
 			return nil
@@ -119,7 +119,7 @@ $ bearer ignore show <fingerprint>`,
 
 func newIgnoreAddCommand() *cobra.Command {
 	var IgnoreAddFlags = &flag.Flags{
-		IgnoreFlagGroup:    flag.NewIgnoreFlagGroup(),
+		GeneralFlagGroup:   flag.NewGeneralFlagGroup(),
 		IgnoreAddFlagGroup: flag.NewIgnoreAddFlagGroup(),
 	}
 	cmd := &cobra.Command{
@@ -153,7 +153,7 @@ $ bearer ignore add <fingerprint> --author Mish --comment "Possible false positi
 				fingerprintId: fingerprintEntry,
 			}
 
-			ignoredFingerprints, fileExists, err := ignore.GetIgnoredFingerprints(options.IgnoreOptions.BearerIgnoreFile)
+			ignoredFingerprints, fileExists, err := ignore.GetIgnoredFingerprints(options.GeneralOptions.BearerIgnoreFile, nil)
 			if err != nil {
 				return fmt.Errorf("error retrieving existing ignores: %s", err)
 			}
@@ -168,12 +168,12 @@ $ bearer ignore add <fingerprint> --author Mish --comment "Possible false positi
 				return nil
 			}
 
-			if err := writeIgnoreFile(ignoredFingerprints, options.IgnoreOptions.BearerIgnoreFile); err != nil {
+			if err := writeIgnoreFile(ignoredFingerprints, options.GeneralOptions.BearerIgnoreFile); err != nil {
 				return err
 			}
 
 			cmd.Print("Fingerprint added to bearer.ignore:\n\n")
-			cmd.Print(ignore.DisplayIgnoredEntryTextString(fingerprintId, ignoredFingerprints[fingerprintId]))
+			cmd.Print(ignore.DisplayIgnoredEntryTextString(fingerprintId, ignoredFingerprints[fingerprintId], options.GeneralOptions.NoColor))
 			cmd.Print("\n\n")
 			return nil
 		},
@@ -188,7 +188,7 @@ $ bearer ignore add <fingerprint> --author Mish --comment "Possible false positi
 
 func newIgnoreRemoveCommand() *cobra.Command {
 	var IgnoreRemoveFlags = &flag.Flags{
-		IgnoreFlagGroup: flag.NewIgnoreFlagGroup(),
+		GeneralFlagGroup: flag.NewGeneralFlagGroup(),
 	}
 	cmd := &cobra.Command{
 		Use:   "remove <fingerprint>",
@@ -209,7 +209,7 @@ $ bearer ignore remove <fingerprint>`,
 				return fmt.Errorf("flag error: %s", err)
 			}
 
-			ignoredFingerprints, fileExists, err := ignore.GetIgnoredFingerprints(options.IgnoreOptions.BearerIgnoreFile)
+			ignoredFingerprints, fileExists, err := ignore.GetIgnoredFingerprints(options.GeneralOptions.BearerIgnoreFile, nil)
 			if err != nil {
 				return fmt.Errorf("error retrieving existing ignores: %s", err)
 			}
@@ -226,12 +226,12 @@ $ bearer ignore remove <fingerprint>`,
 			}
 
 			delete(ignoredFingerprints, fingerprintId)
-			if err := writeIgnoreFile(ignoredFingerprints, options.IgnoreOptions.BearerIgnoreFile); err != nil {
+			if err := writeIgnoreFile(ignoredFingerprints, options.GeneralOptions.BearerIgnoreFile); err != nil {
 				return err
 			}
 
 			cmd.Print("Fingerprint successfully removed from bearer.ignore:\n\n")
-			cmd.Print(ignore.DisplayIgnoredEntryTextString(fingerprintId, removedFingerprint))
+			cmd.Print(ignore.DisplayIgnoredEntryTextString(fingerprintId, removedFingerprint, options.GeneralOptions.NoColor))
 			cmd.Print("\n\n")
 			return nil
 		},
@@ -246,7 +246,7 @@ $ bearer ignore remove <fingerprint>`,
 
 func newIgnoreMigrateCommand() *cobra.Command {
 	IgnoreMigrateFlags := &flag.Flags{
-		IgnoreFlagGroup:        flag.NewIgnoreFlagGroup(),
+		GeneralFlagGroup:       flag.NewGeneralFlagGroup(),
 		IgnoreMigrateFlagGroup: flag.NewIgnoreMigrateFlagGroup(),
 	}
 	cmd := &cobra.Command{
@@ -263,13 +263,14 @@ $ bearer ignore migrate`,
 			if err != nil {
 				return fmt.Errorf("flag error: %s", err)
 			}
+
 			configFilePath := viper.GetString(flag.ConfigFileFlag.ConfigName)
 			fingerprintsToMigrate, err := getIgnoredFingerprintsFromConfig(configFilePath)
 			if err != nil {
 				return fmt.Errorf("error reading config: %s\nPerhaps you need to use --config-file to specify the config path?", err.Error())
 			}
 
-			ignoredFingerprints, fileExists, err := ignore.GetIgnoredFingerprints(options.IgnoreOptions.BearerIgnoreFile)
+			ignoredFingerprints, fileExists, err := ignore.GetIgnoredFingerprints(options.GeneralOptions.BearerIgnoreFile, nil)
 			if err != nil {
 				return fmt.Errorf("error retrieving existing ignores: %s", err)
 			}
@@ -292,7 +293,7 @@ $ bearer ignore migrate`,
 				}
 			}
 
-			cmd.Printf("Added %d ignores to:\n\t%s\n", migratedIgnoredCount, options.IgnoreOptions.BearerIgnoreFile)
+			cmd.Printf("Added %d ignores to:\n\t%s\n", migratedIgnoredCount, options.GeneralOptions.BearerIgnoreFile)
 
 			if skippedIgnoresToMigrate != "" {
 				cmd.Printf("\nThe following ignores already exist in the bearer.ignore file:\n")
@@ -302,7 +303,7 @@ $ bearer ignore migrate`,
 
 			// either no duplicate entries at this point or --force is true so we can ignore merge error
 			_ = ignore.MergeIgnoredFingerprints(fingerprintsToMigrate, ignoredFingerprints, options.IgnoreMigrateOptions.Force)
-			return writeIgnoreFile(ignoredFingerprints, options.IgnoreOptions.BearerIgnoreFile)
+			return writeIgnoreFile(ignoredFingerprints, options.GeneralOptions.BearerIgnoreFile)
 		},
 		SilenceErrors: false,
 		SilenceUsage:  false,

diff --git a/pkg/commands/process/settings/settings.go b/pkg/commands/process/settings/settings.go
@@ -311,7 +311,7 @@ func FromOptions(opts flag.Options, foundLanguages []string) (Config, error) {
 		}
 	}
 
-	ignoredFingerprints, _, err := ignore.GetIgnoredFingerprints(opts.IgnoreOptions.BearerIgnoreFile)
+	ignoredFingerprints, _, err := ignore.GetIgnoredFingerprints(opts.GeneralOptions.BearerIgnoreFile, &opts.ScanOptions.Target)
 	if err != nil {
 		return Config{}, err
 	}