Patch debug feature

Previous changes introduced an annoying bug with the debug feature.
The following patch it, organize logger logic in its own file and fix a
few debug messages.

Author: fbessett

cmd/logger.go

@@ -0,0 +1,60 @@
+package cmd
+
+import (
+	"io"
+	"os"
+
+	"github.com/rs/zerolog"
+	"github.com/rs/zerolog/log"
+)
+
+const (
+	logFile = "./ssl-checker.log"
+)
+
+// LevelWriter interface
+type LevelWriter struct {
+	io.Writer
+	Level zerolog.Level
+}
+
+func (lw *LevelWriter) WriteLevel(l zerolog.Level, p []byte) (n int, err error) {
+	if l >= lw.Level {
+		return lw.Write(p)
+	}
+	return len(p), nil
+}
+
+func setLogger(debug bool) error {
+	var logWriter *os.File
+	var err error
+	zerolog.TimeFieldFormat = zerolog.TimeFormatUnix
+	zerolog.SetGlobalLevel(zerolog.InfoLevel)
+	if debug {
+		zerolog.SetGlobalLevel(zerolog.DebugLevel)
+
+		logWriter, err = os.OpenFile(
+			logFile,
+			os.O_APPEND|os.O_CREATE|os.O_WRONLY,
+			0664,
+		)
+		if err != nil {
+			panic(err)
+		}
+	}
+
+	fileWriter := zerolog.New(zerolog.ConsoleWriter{
+		Out:          logWriter,
+		NoColor:      true,
+		PartsExclude: []string{"time", "level"},
+	})
+	consoleWriter := zerolog.NewConsoleWriter(
+		func(w *zerolog.ConsoleWriter) {
+			w.Out = os.Stderr
+			w.PartsExclude = []string{"time"}
+		},
+	)
+	consoleWriterLeveled := &LevelWriter{Writer: consoleWriter, Level: zerolog.InfoLevel}
+	log.Logger = zerolog.New(zerolog.MultiLevelWriter(fileWriter, consoleWriterLeveled)).With().Timestamp().Logger()
+	return nil
+}

cmd/root.go

@@ -2,23 +2,22 @@ package cmd
 
 import (
 	"fmt"
-	"io"
 	"os"
 	"path/filepath"
 	"strings"
 
 	"github.com/fabio42/ssl-checker/ui"
 
 	tea "github.com/charmbracelet/bubbletea"
-	"github.com/rs/zerolog"
+	// "github.com/rs/zerolog"
 	"github.com/rs/zerolog/log"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 )
 
-const (
-	logFile = "./ssl-checker.log"
-)
+// const (
+// 	logFile = "./ssl-checker.log"
+// )
 
 var (
 	configFile string
@@ -31,6 +30,16 @@ var rootCmd = &cobra.Command{
 	Long:  "ssl-checker is a tool to _quickly_ check certificate details of multiple https targets.",
 
 	PersistentPreRun: func(cmd *cobra.Command, args []string) {
+		err := setLogger(viper.GetBool("debug"))
+		if err != nil {
+			log.Fatal().Msgf("Error failed to configure logger:", err)
+		}
+
+		if viper.GetBool("debug") {
+			// zerolog.SetGlobalLevel(zerolog.DebugLevel)
+			log.Warn().Msgf("Debug is enabled, log will be found in %v", logFile)
+		}
+
 		cfgFile := filepath.Base(configFile)
 		cfgPath := filepath.Dir(configFile)
 		viper.SetConfigName(cfgFile[:len(cfgFile)-len(filepath.Ext(cfgFile))])
@@ -44,11 +53,6 @@ var rootCmd = &cobra.Command{
 		}
 	},
 	Run: func(cmd *cobra.Command, args []string) {
-		if viper.GetBool("debug") {
-			zerolog.SetGlobalLevel(zerolog.DebugLevel)
-			log.Warn().Msgf("Debug is enabled, log will be found in ./zeroDebug.log")
-		}
-
 		envQuery := strings.Split(envCheck, ",")
 
 		if viper.IsSet("queries") {
@@ -134,11 +138,6 @@ func sliceContains(s []string, str string) bool {
 }
 
 func init() {
-	err := setLogger()
-	if err != nil {
-		log.Fatal().Msgf("Error failed to configure logger:", err)
-	}
-
 	rootCmd.PersistentFlags().StringVarP(&configFile, "config", "c", "$HOME/.config/ssl-checker/config.yaml", "Configuration file location")
 	rootCmd.PersistentFlags().BoolP("silent", "s", false, "disable ui")
 	rootCmd.PersistentFlags().BoolP("debug", "d", false, "Enable debug log, out will be saved in "+logFile)
@@ -149,6 +148,11 @@ func init() {
 	viper.BindPFlag("debug", rootCmd.PersistentFlags().Lookup("debug"))
 	viper.BindPFlag("timeout", rootCmd.PersistentFlags().Lookup("timeout"))
 
+	// err := setLogger(viper.GetBool("debug"))
+	// if err != nil {
+	// 	log.Fatal().Msgf("Error failed to configure logger:", err)
+	// }
+
 	rootCmd.AddCommand(listEnvs)
 }
 
@@ -157,50 +161,3 @@ func Execute() {
 		log.Fatal().Msgf("Whoops. There was an error while executing your CLI '%s'", err)
 	}
 }
-
-// https://github.com/rs/zerolog/issues/150
-type LevelWriter struct {
-	io.Writer
-	Level zerolog.Level
-}
-
-func (lw *LevelWriter) WriteLevel(l zerolog.Level, p []byte) (n int, err error) {
-	if l >= lw.Level {
-		return lw.Write(p)
-	}
-	return len(p), nil
-}
-
-func setLogger() error {
-	var logWriter *os.File
-	var err error
-	zerolog.TimeFieldFormat = zerolog.TimeFormatUnix
-	zerolog.SetGlobalLevel(zerolog.InfoLevel)
-	if viper.GetBool("debug") {
-		zerolog.SetGlobalLevel(zerolog.DebugLevel)
-
-		logWriter, err = os.OpenFile(
-			logFile,
-			os.O_APPEND|os.O_CREATE|os.O_WRONLY,
-			0664,
-		)
-		if err != nil {
-			panic(err)
-		}
-	}
-
-	fileWriter := zerolog.New(zerolog.ConsoleWriter{
-		Out:          logWriter,
-		NoColor:      true,
-		PartsExclude: []string{"time", "level"},
-	})
-	consoleWriter := zerolog.NewConsoleWriter(
-		func(w *zerolog.ConsoleWriter) {
-			w.Out = os.Stderr
-			w.PartsExclude = []string{"time"}
-		},
-	)
-	consoleWriterLeveled := &LevelWriter{Writer: consoleWriter, Level: zerolog.InfoLevel}
-	log.Logger = zerolog.New(zerolog.MultiLevelWriter(fileWriter, consoleWriterLeveled)).With().Timestamp().Logger()
-	return nil
-}

domains/domains.go

@@ -60,7 +60,7 @@ func (i Response) Description() string { return i.Environment }
 
 func TestDomain(domain, env string, timeO int, out chan<- Response) {
 	var resp Response
-	log.Debug().Msgf("SSL query for ", domain)
+	log.Debug().Msgf("SSL query for %v", domain)
 
 	nDialer := net.Dialer{
 		Timeout: time.Duration(timeO) * time.Second,
@@ -91,7 +91,7 @@ func TestDomain(domain, env string, timeO int, out chan<- Response) {
 			SAN:          tlsConn.ConnectionState().PeerCertificates[0].DNSNames,
 			Error:        err,
 		}
-		log.Debug().Msgf("SSL query completed for ", domain)
+		log.Debug().Msgf("SSL query completed for %v", domain)
 	}
 	out <- resp
 }