Add --suppress-error arg to silence runtime errors (#24)

Author: 0sewa0

README.md

@@ -97,6 +97,22 @@ The `dynatrace-bootstrapper` is a small CLI binary built into a [Dynatrace CodeM
 - This is an **optional** arg
 - The `--attribute-container` arg defines the passed in Container attributes that will be used to configure the metadata-enrichment and injected CodeModule. It is a JSON formatted string.
 
+#### `--suppress-error`
+
+*Example*: `--suppress-error`
+
+- This is an **optional** arg
+  - Defaults to `false`
+- The `--suppress-error` arg will silence any errors, causing the executable to return with an exit code 0 even if an error occurred. Intended purpose is to not block the application container from starting, if used as init-container.
+
+#### `--debug`
+
+*Example*: `--debug`
+
+- This is an **optional** arg
+  - Defaults to `false`
+- The `--debug` arg will enabled the debug logs.
+
 ## Development
 
 - To run tests: `make test`

main.go

@@ -15,14 +15,16 @@ import (
 )
 
 const (
-	sourceFolderFlag = "source"
-	targetFolderFlag = "target"
-	debugFlag        = "debug"
+	SourceFolderFlag   = "source"
+	TargetFolderFlag   = "target"
+	DebugFlag          = "debug"
+	SuppressErrorsFlag = "suppress-error"
 )
 
 var (
-	log     logr.Logger
-	isDebug bool
+	log                 logr.Logger
+	isDebug             bool
+	areErrorsSuppressed bool
 
 	sourceFolder string
 	targetFolder string
@@ -52,13 +54,17 @@ func bootstrapper(fs afero.Fs) *cobra.Command {
 }
 
 func AddFlags(cmd *cobra.Command) {
-	cmd.PersistentFlags().StringVar(&sourceFolder, sourceFolderFlag, "", "Base path where to copy the codemodule FROM.")
-	_ = cmd.MarkPersistentFlagRequired(sourceFolderFlag)
+	cmd.PersistentFlags().StringVar(&sourceFolder, SourceFolderFlag, "", "Base path where to copy the codemodule FROM.")
+	_ = cmd.MarkPersistentFlagRequired(SourceFolderFlag)
 
-	cmd.PersistentFlags().StringVar(&targetFolder, targetFolderFlag, "", "Base path where to copy the codemodule TO.")
-	_ = cmd.MarkPersistentFlagRequired(targetFolderFlag)
+	cmd.PersistentFlags().StringVar(&targetFolder, TargetFolderFlag, "", "Base path where to copy the codemodule TO.")
+	_ = cmd.MarkPersistentFlagRequired(TargetFolderFlag)
 
-	cmd.PersistentFlags().BoolVar(&isDebug, debugFlag, false, "Enables debug logs.")
+	cmd.PersistentFlags().BoolVar(&isDebug, DebugFlag, false, "(Optional) Enables debug logs.")
+	cmd.PersistentFlags().Lookup(DebugFlag).NoOptDefVal = "true"
+
+	cmd.PersistentFlags().BoolVar(&areErrorsSuppressed, SuppressErrorsFlag, false, "(Optional) Always return exit code 0, even on error")
+	cmd.PersistentFlags().Lookup(SuppressErrorsFlag).NoOptDefVal = "true"
 }
 
 func run(fs afero.Fs) func(cmd *cobra.Command, _ []string) error {
@@ -69,21 +75,31 @@ func run(fs afero.Fs) func(cmd *cobra.Command, _ []string) error {
 		}
 		version.Print(log)
 
-		err := cmd.ValidateRequiredFlags()
-		if err != nil {
-			return err
-		}
-
 		aferoFs := afero.Afero{
 			Fs: fs,
 		}
 
-		err = move.Execute(log, aferoFs, sourceFolder, targetFolder)
+		err := move.Execute(log, aferoFs, sourceFolder, targetFolder)
 		if err != nil {
+			if areErrorsSuppressed {
+				log.Error(err, "error during moving, the error was suppressed")
+
+				return nil
+			}
+			return err
+		}
+
+		err = configure.Execute(log, aferoFs, targetFolder)
+		if err != nil {
+			if areErrorsSuppressed {
+				log.Error(err, "error during configuration, the error was suppressed")
+
+				return nil
+			}
 			return err
 		}
 
-		return configure.Execute(log, aferoFs, targetFolder)
+		return nil
 	}
 }
 

main_test.go

@@ -23,4 +23,30 @@ func TestBootstrapper(t *testing.T) {
 
 		require.NoError(t, err)
 	})
+
+	t.Run("--suppress-error=true -> no error", func(t *testing.T) {
+		cmd := bootstrapper(afero.NewMemMapFs())
+		cmd.SetArgs([]string{"--source", "\\\\", "--target", "\\\\"})
+
+		err := cmd.Execute()
+
+		require.Error(t, err)
+
+		cmd = bootstrapper(afero.NewMemMapFs())
+		// Note: we can't skip/mask the validation of the required flags
+		cmd.SetArgs([]string{"--source", "\\\\", "--target", "\\\\", "--suppress-error"})
+
+		err = cmd.Execute()
+
+		require.NoError(t, err)
+
+
+		cmd = bootstrapper(afero.NewMemMapFs())
+		// Note: we can't skip/mask the validation of the required flags
+		cmd.SetArgs([]string{"--source", "\\\\", "--target", "\\\\", "--suppress-error", "true"})
+
+		err = cmd.Execute()
+
+		require.NoError(t, err)
+	})
 }

pkg/move/cmd.go

@@ -7,8 +7,8 @@ import (
 )
 
 const (
-	workFolderFlag = "work"
-	technologyFlag = "technology"
+	WorkFolderFlag = "work"
+	TechnologyFlag = "technology"
 )
 
 var (
@@ -17,9 +17,9 @@ var (
 )
 
 func AddFlags(cmd *cobra.Command) {
-	cmd.PersistentFlags().StringVar(&workFolder, workFolderFlag, "", "(Optional) Base path for a tmp folder, this is where the command will do its work, to make sure the operations are atomic. It must be on the same disk as the target folder.")
+	cmd.PersistentFlags().StringVar(&workFolder, WorkFolderFlag, "", "(Optional) Base path for a tmp folder, this is where the command will do its work, to make sure the operations are atomic. It must be on the same disk as the target folder.")
 
-	cmd.PersistentFlags().StringVar(&technology, technologyFlag, "", "(Optional) Comma-separated list of technologies to filter files.")
+	cmd.PersistentFlags().StringVar(&technology, TechnologyFlag, "", "(Optional) Comma-separated list of technologies to filter files.")
 
 }