Push environment variables to the program start

Moves the environment variables to the beginning of the program.
With this approach it is obvious what is confgured and how eliminating
sidefects of the order of the code execution.

Signed-off-by: Petr Kotas <[email protected]>

Author: petrkotas

cadctl/cmd/investigate/investigate.go

@@ -44,28 +44,28 @@ var InvestigateCmd = &cobra.Command{
 }
 
 var (
-	logLevelFlag = ""
-	payloadPath  = "./payload.json"
+	logLevelFlag    = ""
+	payloadPath     = "./payload.json"
+	pipelineNameEnv = ""
 )
 
 const pagerdutyTitlePrefix = "[CAD Investigated]"
 
 func init() {
-	InvestigateCmd.Flags().StringVarP(&payloadPath, "payload-path", "p", payloadPath, "the path to the payload")
-	InvestigateCmd.Flags().StringVarP(&logging.LogLevelString, "log-level", "l", "", "the log level [debug,info,warn,error,fatal], default = info")
+	InvestigateCmd.Flags().StringVarP(&payloadPath, "payload-path", "p", payloadPath, "the path to the payload, defaults to './payload.json'")
+	InvestigateCmd.Flags().StringVarP(&logLevelFlag, "log-level", "l", "", "the log level [debug,info,warn,error,fatal], default = info")
 
-	err := InvestigateCmd.MarkFlagRequired("payload-path")
-	if err != nil {
-		logging.Warn("Could not mark flag 'payload-path' as required")
+	if envLogLevel, exists := os.LookupEnv("LOG_LEVEL"); exists {
+		logLevelFlag = envLogLevel
 	}
+
+	pipelineNameEnv = os.Getenv("PIPELINE_NAME")
 }
 
 func run(cmd *cobra.Command, _ []string) error {
 	// early init of logger for logs before clusterID is known
-	if cmd.Flags().Changed("log-level") {
-		flagValue, _ := cmd.Flags().GetString("log-level")
-		logging.RawLogger = logging.InitLogger(flagValue, "")
-	}
+	logging.RawLogger = logging.InitLogger(logLevelFlag, pipelineNameEnv, "")
+
 	payload, err := os.ReadFile(payloadPath)
 	if err != nil {
 		return fmt.Errorf("failed to read webhook payload: %w", err)
@@ -129,12 +129,7 @@ func run(cmd *cobra.Command, _ []string) error {
 	internalClusterID := cluster.ID()
 
 	// re-initialize logger for the internal-cluster-id context
-	// if log-level flag is set, take priority over env + default
-	if cmd.Flags().Changed("log-level") {
-		logging.RawLogger = logging.InitLogger(logLevelFlag, internalClusterID)
-	} else {
-		logging.RawLogger = logging.InitLogger(logging.LogLevelString, internalClusterID)
-	}
+	logging.RawLogger = logging.InitLogger(logLevelFlag, pipelineNameEnv, internalClusterID)
 
 	requiresInvestigation, err := clusterRequiresInvestigation(cluster, pdClient, ocmClient)
 	if err != nil || !requiresInvestigation {

interceptor/main.go

@@ -24,9 +24,19 @@ const (
 	idleTimeout  = 60 * time.Second
 )
 
-var logger = logging.InitLogger(logging.LogLevelString, "")
+var (
+	pipelineNameEnv = ""
+	logLevelEnv     = "info"
+)
+
+func init() {
+	pipelineNameEnv = os.Getenv("PIPELINE_NAME")
+	logLevelEnv = os.Getenv("LOG_LEVEL")
+}
 
 func main() {
+	logger := logging.InitLogger(logLevelEnv, pipelineNameEnv, "")
+
 	// set up signals so we handle the first shutdown signal gracefully
 	ctx := signals.NewContext()
 

pkg/investigations/chgm/chgm_test.go

@@ -37,7 +37,7 @@ var _ = Describe("chgm", func() {
 		event             cloudtrailv2types.Event
 	)
 	BeforeEach(func() {
-		logging.InitLogger("fatal", "") // Mute logger for the tests
+		logging.InitLogger("fatal", "", "") // Mute logger for the tests
 		mockCtrl = gomock.NewController(GinkgoT())
 
 		var err error

pkg/logging/logging.go

@@ -2,31 +2,23 @@
 package logging
 
 import (
-	"fmt"
 	"log"
-	"os"
 
 	"go.uber.org/zap"
 	"go.uber.org/zap/zapcore"
 )
 
-var LogLevelString = getLogLevel()
-
 // RawLogger is the raw global logger object used for calls wrapped by the logging package
-var RawLogger = InitLogger(LogLevelString, "")
+// empty string defaults to "info" log level
+var RawLogger = InitLogger("", "", "")
 
 // InitLogger initializes a cluster-id specific child logger
-func InitLogger(logLevelString string, clusterID string) *zap.SugaredLogger {
+func InitLogger(logLevelString string, pipelineName string, clusterID string) *zap.SugaredLogger {
 	logLevel, err := zap.ParseAtomicLevel(logLevelString)
 	if err != nil {
 		log.Fatalln("Invalid log level:", logLevelString)
 	}
 
-	pipelineName := os.Getenv("PIPELINE_NAME")
-	if pipelineName == "" {
-		fmt.Println("Warning: Unable to retrieve the pipeline ID on logger creation. Continuing with empty value.")
-	}
-
 	config := zap.NewProductionConfig()
 	config.EncoderConfig.TimeKey = "timestamp"
 	config.Level = logLevel
@@ -94,11 +86,3 @@ func Errorf(template string, args ...interface{}) {
 func Fatalf(template string, args ...interface{}) {
 	RawLogger.Fatalf(template, args...)
 }
-
-// getLogLevel returns the log level from the environment variable LOG_LEVEL
-func getLogLevel() string {
-	if envLogLevel, exists := os.LookupEnv("LOG_LEVEL"); exists {
-		return envLogLevel
-	}
-	return "info"
-}