Allow the Config to receive a Logger instance, if needed

Author: mathbalduino

config.go

@@ -72,9 +72,16 @@ type Config struct {
 	// typenames, etc)
 	Focus *Focus
 
+	// Logger is an instance of the LoggerCLI, already created
+	// by the lib user.
+	//
+	// Note that by using this field, the value of the LogFlags
+	// field will be ignored
+	Logger LoggerCLI
+
 	// LogFlags controls the logging configuration of the parser.
-	// It can be set using the constants LogTrace, LogDebug and
-	// LogJSON.
+	// It can be set using the constants LogTrace, LogDebug, LogJSON,
+	// etc. If the Logger field is set, this field will be ignored.
 	//
 	// Note that you can use a bitwise-AND operator to combine
 	// multiple flags
@@ -83,7 +90,7 @@ type Config struct {
 
 // packagesLoadConfig returns the configuration struct that is used to
 // call the packages.Load function
-func packagesLoadConfig(config Config, log LoggerCLI) *packages.Config {
+func packagesLoadConfig(config Config) *packages.Config {
 	if config.Fset == nil {
 		config.Fset = token.NewFileSet()
 	}
@@ -99,7 +106,7 @@ func packagesLoadConfig(config Config, log LoggerCLI) *packages.Config {
 		// Constant values, don't exposed
 		Mode: packagesConfigMode,
 		Logf: func(format string, args ...interface{}) {
-			log.Debug(format, args...)
+			config.Logger.Debug(format, args...)
 		},
 
 		// Not used

config_test.go

@@ -9,14 +9,14 @@ import (
 
 func TestConfig(t *testing.T) {
 	t.Run("If not provided, FileSet should be created", func(t *testing.T) {
-		config := Config{Fset: nil}
-		packagesConfig := packagesLoadConfig(config, loggerCLI.New(true, LogDebug|LogTrace))
+		config := Config{Fset: nil, Logger: loggerCLI.New(true, LogDebug|LogTrace)}
+		packagesConfig := packagesLoadConfig(config)
 		if packagesConfig.Fset == nil {
 			t.Fatal("Fset was expected to be not nil")
 		}
 	})
 	t.Run("The PackagesMode should be equal to the defined constant", func(t *testing.T) {
-		packagesConfig := packagesLoadConfig(Config{}, loggerCLI.New(true, LogDebug|LogTrace))
+		packagesConfig := packagesLoadConfig(Config{Logger: loggerCLI.New(true, LogDebug|LogTrace)})
 		if packagesConfig.Mode != packagesConfigMode {
 			t.Fatal("The mode is not set correctly")
 		}
@@ -37,14 +37,14 @@ func TestConfig(t *testing.T) {
 			return mock
 		}
 
-		packagesConfig := packagesLoadConfig(Config{}, mock)
+		packagesConfig := packagesLoadConfig(Config{Logger: mock})
 		packagesConfig.Logf(logMsg, logArgs...)
 		if debugCalls != 1 {
 			t.Fatalf("LogCLI Debug was expected to be called one time")
 		}
 	})
 	t.Run("PackagesConfig Context, ParseFile and Overlay should be always nil", func(t *testing.T) {
-		packagesConfig := packagesLoadConfig(Config{}, loggerCLI.New(true, LogDebug|LogTrace))
+		packagesConfig := packagesLoadConfig(Config{Logger: loggerCLI.New(true, LogDebug|LogTrace)})
 		if packagesConfig.Context != nil {
 			t.Fatalf("Context was expected to be nil")
 		}
@@ -62,8 +62,9 @@ func TestConfig(t *testing.T) {
 			Env:        []string{"a", "b", "c"},
 			BuildFlags: []string{"1", "2", "3"},
 			Fset:       token.NewFileSet(),
+			Logger:     loggerCLI.New(true, LogDebug|LogTrace),
 		}
-		packagesConfig := packagesLoadConfig(config, loggerCLI.New(true, LogDebug|LogTrace))
+		packagesConfig := packagesLoadConfig(config)
 		if packagesConfig.Tests != config.Tests {
 			t.Fatalf("PackagesConfig.Tests was expected to be equal to config.Tests")
 		}

new.go

@@ -57,9 +57,14 @@ type GoParser struct {
 //		 might be matched by multiple patterns: in general it is not possible
 //		 to determine which packages correspond to which patterns.
 func NewGoParser(pattern string, config Config) (*GoParser, error) {
-	logger := loggerCLI.New(config.LogFlags&LogJSON != 0, config.LogFlags&(^LogJSON))
+	logger := config.Logger
+	if logger == nil {
+		logger = loggerCLI.New(config.LogFlags&LogJSON != 0, config.LogFlags&(^LogJSON))
+	}
 	printFinalConfig(pattern, config, logger)
-	packagesLoadConfig := packagesLoadConfig(config, logger)
+
+	config.Logger = logger
+	packagesLoadConfig := packagesLoadConfig(config)
 	pkgs, e := packages.Load(packagesLoadConfig, pattern)
 	if e != nil {
 		return nil, e

new_test.go

@@ -1,6 +1,7 @@
 package parser
 
 import (
+	"github.com/mathbalduino/go-log/loggerCLI"
 	"go/token"
 	"testing"
 )
@@ -24,7 +25,30 @@ func TestNewGoParser(t *testing.T) {
 			t.Fatalf("GoParser expected to be not nil")
 		}
 	})
-	t.Run("The returned GoParser pkgs, focus, log and fileSet should be filled", func(t *testing.T) {
+	t.Run("The returned GoParser pkgs, focus, log (given by the user) and fileSet fields should be filled", func(t *testing.T) {
+		logger := loggerCLI.New(false, 0)
+		config := Config{Focus: &Focus{}, Fset: token.NewFileSet(), Logger: logger}
+		p, _ := NewGoParser("--inexistentPackage--", config)
+		if p == nil {
+			t.Fatalf("GoParser expected to be not nil")
+		}
+		if p.pkgs == nil {
+			t.Fatalf("GoParser.pkgs expected to be not nil")
+		}
+		if p.focus != config.Focus {
+			t.Fatalf("GoParser.focus expected to be equal to config.Focus")
+		}
+		if p.logger == nil {
+			t.Fatalf("GoParser.log expected to not be nil")
+		}
+		if p.logger != logger {
+			t.Fatalf("GoParser.log expected to not be nil")
+		}
+		if p.fileSet != config.Fset {
+			t.Fatalf("GoParser.fileSet expected to be equal to config.Fset")
+		}
+	})
+	t.Run("The returned GoParser pkgs, focus, log (dynamically created) and fileSet fields should be filled", func(t *testing.T) {
 		config := Config{Focus: &Focus{}, Fset: token.NewFileSet()}
 		p, _ := NewGoParser("--inexistentPackage--", config)
 		if p == nil {

printFinalConfig.go

@@ -6,7 +6,7 @@ import (
 )
 
 // printFinalConfig will print, as a Debug log, the final configuration of the parser
-func printFinalConfig(pattern string, config Config, log LoggerCLI) {
+func printFinalConfig(pattern string, config Config, logger LoggerCLI) {
 	focus := nilFocusStr
 	if config.Focus != nil {
 		packagePath, filePath, typeName := "nil", "nil", "nil"
@@ -33,8 +33,15 @@ func printFinalConfig(pattern string, config Config, log LoggerCLI) {
 		dir = config.Dir
 	}
 
-	logFlags := "-"
-	if config.LogFlags != 0 {
+	loggerMsg := nilLoggerStr
+	if config.Logger != nil {
+		loggerMsg = notNilLoggerStr
+	}
+
+	logFlags := emptyLogFlagsStr
+	if config.Logger != nil {
+		logFlags = ignoredLogFlagsStr
+	} else if config.LogFlags != 0 {
 		if config.LogFlags&LogJSON != 0 {
 			logFlags = "LogJSON | "
 		}
@@ -59,14 +66,15 @@ func printFinalConfig(pattern string, config Config, log LoggerCLI) {
 		logFlags = strings.TrimSuffix(logFlags, " | ")
 	}
 
-	log.Debug(finalConfigTemplate,
+	logger.Debug(finalConfigTemplate,
 		pattern,
 		config.Tests,
 		dir,
 		config.Env,
 		config.BuildFlags,
 		focus,
 		fset,
+		loggerMsg,
 		logFlags,
 	)
 }
@@ -75,6 +83,10 @@ const emptyDirStr = "./"
 const nilFsetStr = "Using the FileSet of the library"
 const notNilFsetStr = "Using the FileSet provided by the client"
 const nilFocusStr = "Focus not defined (will not skip anything)"
+const nilLoggerStr = "Logger not defined (will be created using LogFlags)"
+const notNilLoggerStr = "Using the Logger instance provided by the client"
+const emptyLogFlagsStr = "unset"
+const ignoredLogFlagsStr = "Ignored (Logger field is set)"
 
 const finalConfigTemplate = `New GoParser created. Final configuration:
 Pattern: %s
@@ -85,6 +97,7 @@ Config: {
 	BuildFlags: %v
 	Focus: %s
 	Fset: %s
+	Logger: %s
 	LogFlags: %s
 }`