Add new flag to use non-zero exit code when checks fail

Signed-off-by: Caleb Xu <[email protected]>

Author: caxu-rh

cmd/preflight/cmd/root.go

@@ -3,11 +3,13 @@ package cmd
 
 import (
 	"context"
+	"errors"
 	"io"
 	"os"
 	"path/filepath"
 
 	"github.com/redhat-openshift-ecosystem/openshift-preflight/artifacts"
+	"github.com/redhat-openshift-ecosystem/openshift-preflight/internal/cli"
 	"github.com/redhat-openshift-ecosystem/openshift-preflight/internal/runtime"
 	"github.com/redhat-openshift-ecosystem/openshift-preflight/internal/viper"
 	"github.com/redhat-openshift-ecosystem/openshift-preflight/version"
@@ -45,6 +47,9 @@ func rootCmd() *cobra.Command {
 	rootCmd.PersistentFlags().String("loglevel", "", "The verbosity of the preflight tool itself. Ex. warn, debug, trace, info, error. (env: PFLT_LOGLEVEL)")
 	_ = viper.BindPFlag("loglevel", rootCmd.PersistentFlags().Lookup("loglevel"))
 
+	rootCmd.PersistentFlags().Bool("exit-with-failure", false, "Exit with exit code 2 if any checks encounter an error or exit code 1 if any checks fail. (env: PFLT_EXIT_WITH_FAILURE)")
+	_ = viper.BindPFlag("exit_with_failure", rootCmd.PersistentFlags().Lookup("exit-with-failure"))
+
 	rootCmd.AddCommand(checkCmd())
 	rootCmd.AddCommand(listChecksCmd())
 	rootCmd.AddCommand(runtimeAssetsCmd())
@@ -53,8 +58,37 @@ func rootCmd() *cobra.Command {
 	return rootCmd
 }
 
+type ChecksFailedError struct {
+	error
+}
+
+func (e ChecksFailedError) Error() string {
+	return e.error.Error()
+}
+
+type ChecksErroredError struct {
+	error
+}
+
+func (e ChecksErroredError) Error() string {
+	return e.error.Error()
+}
+
 func Execute() error {
-	return rootCmd().ExecuteContext(context.Background())
+	err := rootCmd().ExecuteContext(context.Background())
+	if errors.Is(err, &cli.ChecksErroredError{}) {
+		if viper.Instance().GetBool("exit_with_failure") {
+			return ChecksErroredError{error: err}
+		}
+	} else if errors.Is(err, &cli.ChecksFailedError{}) {
+		if viper.Instance().GetBool("exit_with_failure") {
+			return ChecksFailedError{error: err}
+		}
+	} else if err != nil {
+		return err
+	}
+
+	return nil
 }
 
 func initConfig(viper *spfviper.Viper) {

cmd/preflight/main.go

@@ -1,13 +1,23 @@
 package main
 
 import (
+	"errors"
 	"log"
+	"os"
 
 	"github.com/redhat-openshift-ecosystem/openshift-preflight/cmd/preflight/cmd"
 )
 
 func main() {
 	if err := cmd.Execute(); err != nil {
-		log.Fatal(err)
+		if errors.Is(err, &cmd.ChecksErroredError{}) {
+			log.Println(err)
+			os.Exit(1)
+		} else if errors.Is(err, &cmd.ChecksFailedError{}) {
+			log.Println(err)
+			os.Exit(2)
+		} else {
+			log.Fatal(err)
+		}
 	}
 }

internal/cli/cli.go

@@ -23,6 +23,18 @@ type CheckConfig struct {
 	SubmitResults       bool
 }
 
+type ChecksFailedError struct{}
+
+func (e *ChecksFailedError) Error() string {
+	return "one or more checks failed"
+}
+
+type ChecksErroredError struct{}
+
+func (e *ChecksErroredError) Error() string {
+	return "one or more checks encountered an error"
+}
+
 // RunPreflight executes checks, writes logs, results, and submits results if requested.
 func RunPreflight(
 	ctx context.Context,
@@ -84,6 +96,14 @@ func RunPreflight(
 
 	logger.Info(fmt.Sprintf("Preflight result: %s", convertPassedOverall(results.PassedOverall)))
 
+	if len(results.Errors) > 0 {
+		return &ChecksErroredError{}
+	}
+
+	if len(results.Failed) > 0 {
+		return &ChecksFailedError{}
+	}
+
 	return nil
 }