refactor the logger to be a singleton and use init()

Cleanup the logger to better follow Go best practices. Refs: #1001
synfinatic · Jul 20, 2024 · 673ece4 · 673ece4
1 parent 81e0984
commit 673ece4
Show file tree

Hide file tree

Showing 24 changed files with 102 additions and 349 deletions.
diff --git a/cmd/aws-sso/logger.go b/cmd/aws-sso/logger.go
@@ -18,18 +18,10 @@ package main
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-import (
-	"github.com/sirupsen/logrus"
-)
+import "github.com/synfinatic/aws-sso-cli/internal/logger"
 
-var log *logrus.Logger
+var log *logger.Logger
 
-/*
-func SetLogger(l *logrus.Logger) {
-	log = l
-}
-
-func GetLogger() *logrus.Logger {
-	return log
+func init() {
+	log = logger.GetLogger()
 }
-*/
diff --git a/cmd/aws-sso/main.go b/cmd/aws-sso/main.go
@@ -28,17 +28,11 @@ import (
 	"github.com/posener/complete"
 
 	// "github.com/davecgh/go-spew/spew"
-	"github.com/sirupsen/logrus"
+
 	"github.com/synfinatic/aws-sso-cli/internal/config"
-	"github.com/synfinatic/aws-sso-cli/internal/ecs"
-	"github.com/synfinatic/aws-sso-cli/internal/ecs/client"
-	"github.com/synfinatic/aws-sso-cli/internal/ecs/server"
-	"github.com/synfinatic/aws-sso-cli/internal/helper"
 	"github.com/synfinatic/aws-sso-cli/internal/predictor"
 	"github.com/synfinatic/aws-sso-cli/internal/sso"
 	"github.com/synfinatic/aws-sso-cli/internal/storage"
-	"github.com/synfinatic/aws-sso-cli/internal/tags"
-	"github.com/synfinatic/aws-sso-cli/internal/url"
 	"github.com/synfinatic/aws-sso-cli/internal/utils"
 	"github.com/willabides/kongplete"
 )
@@ -158,20 +152,8 @@ func main() {
 		Auth: AUTH_UNKNOWN,
 	}
 
-	log = logrus.New()
 	override := parseArgs(&runCtx)
 
-	helper.SetLogger(log)
-	predictor.SetLogger(log)
-	sso.SetLogger(log)
-	storage.SetLogger(log)
-	tags.SetLogger(log)
-	url.SetLogger(log)
-	utils.SetLogger(log)
-	ecs.SetLogger(log)
-	server.SetLogger(log)
-	client.SetLogger(log)
-
 	if runCtx.Auth == AUTH_NO_CONFIG {
 		// side-step the rest of the setup...
 		if err = runCtx.Kctx.Run(&runCtx); err != nil {
@@ -331,12 +313,6 @@ func parseArgs(ctx *RunContext) sso.OverrideSettings {
 		Threads:    threads, // must be > 0 to override config
 	}
 
-	log.SetFormatter(&logrus.TextFormatter{
-		DisableLevelTruncation: true,
-		PadLevelText:           true,
-		DisableTimestamp:       true,
-	})
-
 	return override
 }
 

diff --git a/internal/ecs/client/client.go b/internal/ecs/client/client.go
@@ -32,9 +32,16 @@ import (
 
 	"github.com/davecgh/go-spew/spew"
 	"github.com/synfinatic/aws-sso-cli/internal/ecs"
+	"github.com/synfinatic/aws-sso-cli/internal/logger"
 	"github.com/synfinatic/aws-sso-cli/internal/storage"
 )
 
+var log *logger.Logger
+
+func init() {
+	log = logger.GetLogger()
+}
+
 type ECSClient struct {
 	server      string
 	authToken   string

diff --git a/internal/ecs/client_request_test.go b/internal/ecs/client_request_test.go
@@ -2,7 +2,7 @@ package ecs
 
 /*
  * AWS SSO CLI
- * Copyright (c) 2021-2022 Aaron Turner  <synfinatic at gmail dot com>
+ * Copyright (c) 2021-202 Aaron Turner  <synfinatic at gmail dot com>
  *
  * This program is free software: you can redistribute it
  * and/or modify it under the terms of the GNU General Public License as

diff --git a/internal/ecs/http.go b/internal/ecs/http.go
@@ -5,6 +5,7 @@ import (
 	"net/http"
 	"strconv"
 
+	"github.com/synfinatic/aws-sso-cli/internal/logger"
 	"github.com/synfinatic/aws-sso-cli/internal/storage"
 )
 
@@ -34,6 +35,7 @@ func WriteCreds(w http.ResponseWriter, creds *storage.RoleCredentials) {
 
 // JSONResponse return a JSON blob as a result
 func JSONResponse(w http.ResponseWriter, jdata interface{}) {
+	log := logger.GetLogger()
 	w.Header().Set("Content-Type", CHARSET_JSON)
 	if err := json.NewEncoder(w).Encode(jdata); err != nil {
 		log.Error(err.Error())

diff --git a/internal/ecs/logger.go b/internal/ecs/logger.go
@@ -18,23 +18,10 @@ package ecs
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-import (
-	"github.com/sirupsen/logrus"
-)
+import "github.com/synfinatic/aws-sso-cli/internal/logger"
 
-var log *logrus.Logger
+var log *logger.Logger
 
-func SetLogger(l *logrus.Logger) {
-	log = l
-}
-
-/*
-func GetLogger() *logrus.Logger {
-	return log
-}
-*/
-
-// this is configured by cmd/main.go, but we have this here for unit tests
 func init() {
-	log = logrus.New()
+	log = logger.GetLogger()
 }
diff --git a/internal/ecs/server/logger.go b/internal/ecs/server/logger.go
diff --git a/internal/ecs/server/server.go b/internal/ecs/server/server.go
@@ -28,9 +28,16 @@ import (
 
 	// "github.com/davecgh/go-spew/spew"
 	"github.com/synfinatic/aws-sso-cli/internal/ecs"
+	"github.com/synfinatic/aws-sso-cli/internal/logger"
 	"github.com/synfinatic/aws-sso-cli/internal/storage"
 )
 
+var log *logger.Logger
+
+func init() {
+	log = logger.GetLogger()
+}
+
 type EcsServer struct {
 	listener     net.Listener
 	authToken    string

diff --git a/internal/helper/helper.go b/internal/helper/helper.go
@@ -27,9 +27,16 @@ import (
 	"path"
 
 	"github.com/riywo/loginshell"
+	"github.com/synfinatic/aws-sso-cli/internal/logger"
 	"github.com/synfinatic/aws-sso-cli/internal/utils"
 )
 
+var log *logger.Logger
+
+func init() {
+	log = logger.GetLogger()
+}
+
 //go:embed bash_profile.sh zshrc.sh aws-sso.fish
 var embedFiles embed.FS
 

diff --git a/internal/helper/logger.go b/internal/helper/logger.go
diff --git a/internal/ecs/client/logger.go → internal/logger/logger.go b/internal/ecs/client/logger.go → internal/logger/logger.go
@@ -1,4 +1,4 @@
-package client
+package logger
 
 /*
  * AWS SSO CLI
@@ -22,19 +22,30 @@ import (
 	"github.com/sirupsen/logrus"
 )
 
-var log *logrus.Logger
+var log *Logger
 
-func SetLogger(l *logrus.Logger) {
-	log = l
+type Logger struct {
+	*logrus.Logger
 }
 
-/*
-func GetLogger() *logrus.Logger {
-	return log
+func NewLogger(l *logrus.Logger) *Logger {
+	return &Logger{l}
 }
-*/
 
-// this is configured by cmd/main.go, but we have this here for unit tests
 func init() {
-	log = logrus.New()
+	log = &Logger{logrus.New()}
+	log.SetFormatter(&logrus.TextFormatter{
+		DisableLevelTruncation: true,
+		PadLevelText:           true,
+		DisableTimestamp:       true,
+	})
+
+}
+
+func SetLogger(l *Logger) {
+	log = l
+}
+
+func GetLogger() *Logger {
+	return log
 }
diff --git a/internal/predictor/logger.go b/internal/predictor/logger.go
diff --git a/internal/predictor/predictor.go b/internal/predictor/predictor.go
@@ -25,10 +25,17 @@ import (
 	// "github.com/davecgh/go-spew/spew"
 	"github.com/goccy/go-yaml"
 	"github.com/posener/complete"
+	"github.com/synfinatic/aws-sso-cli/internal/logger"
 	"github.com/synfinatic/aws-sso-cli/internal/sso"
 	"github.com/synfinatic/aws-sso-cli/internal/utils"
 )
 
+var log *logger.Logger
+
+func init() {
+	log = logger.GetLogger()
+}
+
 type Predictor struct {
 	configFile string
 	accountids []string

diff --git a/internal/sso/cache_test.go b/internal/sso/cache_test.go
@@ -29,6 +29,7 @@ import (
 	"github.com/sirupsen/logrus/hooks/test"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/suite"
+	"github.com/synfinatic/aws-sso-cli/internal/logger"
 )
 
 const (
@@ -264,11 +265,11 @@ func (suite *CacheTestSuite) TestDeleteOldHistory() {
 		c.SSO["Default"].Roles.Accounts[123456789012].Roles["Foo"].Tags)
 
 	// setup logger for tests
-	logger, hook := test.NewNullLogger()
-	logger.SetLevel(logrus.DebugLevel)
-	oldLogger := GetLogger()
-	SetLogger(logger)
-	defer SetLogger(oldLogger)
+	logrus_logger, hook := test.NewNullLogger()
+	logrus_logger.SetLevel(logrus.DebugLevel)
+	old_log := log
+	log = logger.NewLogger(logrus_logger)
+	defer func() { log = old_log }()
 
 	// remove one because of HistoryMinutes expires
 	c = suite.setupDeleteOldHistory()