Revert "Revert "Ban functions that exit the process (#5359)" (#5365)"

.golangci.yml

@@ -0,0 +1,15 @@
+# see https://golangci-lint.run/usage/configuration/ for documentation
+linters:
+  enable:
+  - forbidigo
+linters-settings:
+  forbidigo:
+    # Forbid the following identifiers (list of regexp)
+    #
+    # Add a comment to the offending line with '//nolint:forbidigo' to suppress the rule if
+    # you're working inside the main() function.
+    forbid:
+      # These APIs exit the process. These are OK to use in the main() function,
+      # and not ANYWHERE else.
+      - 'os\.Exit(# Do not use except for inside main(). Suppress this message with //nolint:forbidigo at the end of the line if it is correct.)?'
+      - 'log\.Fatal(f|ln)?(# Do not use except for inside main(). Suppress this message with //nolint:forbidigo at the end of the line if it is correct.)?'

cmd/appcore-async/main.go

@@ -32,19 +32,19 @@ func main() {
 	defaultConfig := fmt.Sprintf("radius-%s.yaml", hostoptions.Environment())
 	flag.StringVar(&configFile, "config-file", defaultConfig, "The service configuration file.")
 	if configFile == "" {
-		log.Fatal("config-file is empty.")
+		log.Fatal("config-file is empty.") //nolint:forbidigo // this is OK inside the main function.
 	}
 
 	flag.Parse()
 
 	options, err := hostoptions.NewHostOptionsFromEnvironment(configFile)
 	if err != nil {
-		log.Fatal(err)
+		log.Fatal(err) //nolint:forbidigo // this is OK inside the main function.
 	}
 
 	logger, flush, err := ucplog.NewLogger(logging.AppCoreLoggerName, &options.Config.Logging)
 	if err != nil {
-		log.Fatal(err)
+		log.Fatal(err) //nolint:forbidigo // this is OK inside the main function.
 	}
 	defer flush()
 
@@ -95,7 +95,7 @@ func main() {
 	// gracefully, so just crash if that happens.
 	err = <-stopped
 	if err == nil {
-		os.Exit(0)
+		os.Exit(0) //nolint:forbidigo // this is OK inside the main function.
 	} else {
 		panic(err)
 	}

cmd/appcore-rp/main.go

@@ -34,18 +34,18 @@ import (
 
 const serviceName = "applications.core"
 
-func newLinkHosts(configFile string, enableAsyncWorker bool) ([]hosting.Service, *hostoptions.HostOptions) {
+func newLinkHosts(configFile string, enableAsyncWorker bool) ([]hosting.Service, *hostoptions.HostOptions, error) {
 	hostings := []hosting.Service{}
 	options, err := hostoptions.NewHostOptionsFromEnvironment(configFile)
 	if err != nil {
-		log.Fatal(err)
+		return nil, nil, err
 	}
 	hostings = append(hostings, link_frontend.NewService(options))
 	if enableAsyncWorker {
 		hostings = append(hostings, link_backend.NewService(options))
 	}
 
-	return hostings, &options
+	return hostings, &options, nil
 }
 
 func main() {
@@ -64,14 +64,14 @@ func main() {
 	flag.StringVar(&linkConfigFile, "link-config", defaultLinkConfig, "The service configuration file for Applications.Link.")
 
 	if configFile == "" {
-		log.Fatal("config-file is empty.")
+		log.Fatal("config-file is empty.") //nolint:forbidigo // this is OK inside the main function.
 	}
 
 	flag.Parse()
 
 	options, err := hostoptions.NewHostOptionsFromEnvironment(configFile)
 	if err != nil {
-		log.Fatal(err)
+		log.Fatal(err) //nolint:forbidigo // this is OK inside the main function.
 	}
 	hostingSvc := []hosting.Service{frontend.NewService(options)}
 
@@ -88,7 +88,7 @@ func main() {
 
 	logger, flush, err := ucplog.NewLogger(logging.AppCoreLoggerName, &options.Config.Logging)
 	if err != nil {
-		log.Fatal(err)
+		log.Fatal(err) //nolint:forbidigo // this is OK inside the main function.
 	}
 	defer flush()
 
@@ -102,7 +102,11 @@ func main() {
 	if runLink && linkConfigFile != "" {
 		logger.Info("Run Applications.Link.")
 		var linkSvcs []hosting.Service
-		linkSvcs, linkOpts = newLinkHosts(linkConfigFile, enableAsyncWorker)
+		var err error
+		linkSvcs, linkOpts, err = newLinkHosts(linkConfigFile, enableAsyncWorker)
+		if err != nil {
+			log.Fatal(err) //nolint:forbidigo // this is OK inside the main function.
+		}
 		hostingSvc = append(hostingSvc, linkSvcs...)
 	}
 
@@ -136,11 +140,11 @@ func main() {
 	tracerOpts.ServiceName = serviceName
 	shutdown, err := trace.InitTracer(tracerOpts)
 	if err != nil {
-		log.Fatal(err)
+		log.Fatal(err) //nolint:forbidigo // this is OK inside the main function.
 	}
 	defer func() {
 		if err := shutdown(ctx); err != nil {
-			log.Fatal("failed to shutdown TracerProvider: %w", err)
+			log.Printf("failed to shutdown TracerProvider: %v\n", err)
 		}
 
 	}()
@@ -165,7 +169,7 @@ func main() {
 	// gracefully, so just crash if that happens.
 	err = <-stopped
 	if err == nil {
-		os.Exit(0)
+		os.Exit(0) //nolint:forbidigo // this is OK inside the main function.
 	} else {
 		panic(err)
 	}

cmd/applink-rp/main.go

@@ -40,14 +40,14 @@ func main() {
 	flag.BoolVar(&enableAsyncWorker, "enable-asyncworker", true, "Flag to run async request process worker (for private preview and dev/test purpose).")
 
 	if configFile == "" {
-		log.Fatal("config-file is empty.")
+		log.Fatal("config-file is empty.") //nolint:forbidigo // this is OK inside the main function.
 	}
 
 	flag.Parse()
 
 	options, err := hostoptions.NewHostOptionsFromEnvironment(configFile)
 	if err != nil {
-		log.Fatal(err)
+		log.Fatal(err) //nolint:forbidigo // this is OK inside the main function.
 	}
 	hostingSvc := []hosting.Service{frontend.NewService(options)}
 
@@ -64,7 +64,7 @@ func main() {
 
 	logger, flush, err := ucplog.NewLogger(logging.AppLinkLoggerName, &options.Config.Logging)
 	if err != nil {
-		log.Fatal(err)
+		log.Fatal(err) //nolint:forbidigo // this is OK inside the main function.
 	}
 	defer flush()
 
@@ -98,11 +98,11 @@ func main() {
 	tracerOpts.ServiceName = serviceName
 	shutdown, err := trace.InitTracer(tracerOpts)
 	if err != nil {
-		log.Fatal(err)
+		log.Fatal(err) //nolint:forbidigo // this is OK inside the main function.
 	}
 	defer func() {
 		if err := shutdown(ctx); err != nil {
-			log.Fatal("failed to shutdown TracerProvider: %w", err)
+			log.Printf("failed to shutdown TracerProvider: %v\n", err)
 		}
 
 	}()
@@ -127,7 +127,7 @@ func main() {
 	// gracefully, so just crash if that happens.
 	err = <-stopped
 	if err == nil {
-		os.Exit(0)
+		os.Exit(0) //nolint:forbidigo // this is OK inside the main function.
 	} else {
 		panic(err)
 	}

cmd/docgen/main.go

@@ -20,23 +20,23 @@ import (
 
 func main() {
 	if len(os.Args) != 2 {
-		log.Fatal("usage: go run cmd/docgen/main.go <output directory>")
+		log.Fatal("usage: go run cmd/docgen/main.go <output directory>") //nolint:forbidigo // this is OK inside the main function.
 	}
 
 	output := os.Args[1]
 	_, err := os.Stat(output)
 	if os.IsNotExist(err) {
 		err = os.Mkdir(output, 0755)
 		if err != nil {
-			log.Fatal(err)
+			log.Fatal(err) //nolint:forbidigo // this is OK inside the main function.
 		}
 	} else if err != nil {
-		log.Fatal(err)
+		log.Fatal(err) //nolint:forbidigo // this is OK inside the main function.
 	}
 
 	err = doc.GenMarkdownTreeCustom(cmd.RootCmd, output, frontmatter, link)
 	if err != nil {
-		log.Fatal(err)
+		log.Fatal(err) //nolint:forbidigo // this is OK inside the main function.
 	}
 }
 

cmd/rad/cmd/root.go

@@ -10,7 +10,6 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
-	"log"
 	"os"
 	"strings"
 
@@ -109,15 +108,19 @@ func prettyPrintJSON(o any) (string, error) {
 // Execute adds all child commands to the root command and sets flags appropriately.
 // This is called by main.main(). It only needs to happen once to the rootCmd.
 // It also initializes the tracerprovider for cli.
-func Execute() {
+//
+// Execute returns true
+func Execute() error {
 	ctx := context.WithValue(context.Background(), ConfigHolderKey, ConfigHolder)
 
 	shutdown, err := trace.InitTracer(trace.Options{
 		ServiceName: serviceName,
 	})
 	if err != nil {
-		log.Fatal(err)
+		fmt.Println("Error:", err)
+		return err
 	}
+
 	defer func() {
 		_ = shutdown(ctx)
 	}()
@@ -130,12 +133,14 @@ func Execute() {
 	if errors.Is(&cli.FriendlyError{}, err) {
 		fmt.Println(err.Error())
 		fmt.Println("\nTraceId: ", span.SpanContext().TraceID().String())
-		os.Exit(1)
+		return err
 	} else if err != nil {
 		fmt.Println("Error:", prettyPrintRPError(err))
 		fmt.Println("\nTraceId: ", span.SpanContext().TraceID().String())
-		os.Exit(1)
+		return err
 	}
+
+	return nil
 }
 
 func init() {
@@ -262,21 +267,21 @@ func initConfig() {
 	v, err := cli.LoadConfig(ConfigHolder.ConfigFilePath)
 	if err != nil {
 		fmt.Printf("Error: failed to load config: %v\n", err)
-		os.Exit(1)
+		os.Exit(1) //nolint:forbidigo // this is OK inside the CLI startup.
 	}
 
 	ConfigHolder.Config = v
 
 	wd, err := os.Getwd()
 	if err != nil {
 		fmt.Printf("Error: failed to find current working directory: %v\n", err)
-		os.Exit(1)
+		os.Exit(1) //nolint:forbidigo // this is OK inside the CLI startup.
 	}
 
 	dc, err := config.LoadDirectoryConfig(wd)
 	if err != nil {
 		fmt.Printf("Error: failed to load config: %v\n", err)
-		os.Exit(1)
+		os.Exit(1) //nolint:forbidigo // this is OK inside the CLI startup.
 	}
 
 	ConfigHolder.DirectoryConfig = dc

cmd/rad/main.go

@@ -6,9 +6,14 @@
 package main
 
 import (
+	"os"
+
 	"github.com/project-radius/radius/cmd/rad/cmd"
 )
 
 func main() {
-	cmd.Execute()
+	err := cmd.Execute()
+	if err != nil {
+		os.Exit(1) //nolint:forbidigo // this is OK inside the main function.
+	}
 }

cmd/ucpd/cmd/root.go

@@ -34,7 +34,7 @@ var rootCmd = &cobra.Command{
 
 		logger, flush, err := ucplog.NewLogger(ucplog.LoggerName, &options.LoggingOptions)
 		if err != nil {
-			log.Fatal(err)
+			log.Fatal(err) //nolint:forbidigo // this is OK inside the main function.
 		}
 		defer flush()
 
@@ -58,11 +58,11 @@ var rootCmd = &cobra.Command{
 		options.TracerProviderOptions.ServiceName = server.ServiceName
 		shutdown, err := trace.InitTracer(options.TracerProviderOptions)
 		if err != nil {
-			log.Fatal(err)
+			log.Fatal(err) //nolint:forbidigo // this is OK inside the main function.
 		}
 		defer func() {
 			if err := shutdown(ctx); err != nil {
-				log.Fatal("failed to shutdown TracerProvider: %w", err)
+				log.Printf("failed to shutdown TracerProvider: %v\n", err)
 			}
 		}()
 
@@ -87,7 +87,7 @@ var rootCmd = &cobra.Command{
 		// gracefully, so just crash if that happens.
 		err = <-stopped
 		if err == nil {
-			os.Exit(0)
+			os.Exit(0) //nolint:forbidigo // this is OK inside the main function.
 		} else {
 			panic(err)
 		}