e2e: Pass logr.Logger by value

This is the recommended way based on logr docs, probably to make it easier to use, since you don't need to check if the logger is nil, and zero value of a logger just discards data. This is also the way logr is used in ramen, so there is no reason to use it differently in the e2e code. Part-of: RamenDR#1597 Signed-off-by: Nir Soffer <[email protected]>
nirs · Oct 31, 2024 · e94f115 · e94f115
1 parent b4f58e9
commit e94f115
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/e2e/main_test.go b/e2e/main_test.go
@@ -31,7 +31,7 @@ func TestMain(m *testing.M) {
 		TimeEncoder: zapcore.ISO8601TimeEncoder,
 	}))
 
-	util.Ctx, err = util.NewContext(&log, util.ConfigFile)
+	util.Ctx, err = util.NewContext(log, util.ConfigFile)
 	if err != nil {
 		log.Error(err, "unable to create new testing context")
 

diff --git a/e2e/util/config.go b/e2e/util/config.go
@@ -27,7 +27,7 @@ type TestConfig struct {
 var config = &TestConfig{}
 
 //nolint:cyclop
-func ReadConfig(log *logr.Logger, configFile string) error {
+func ReadConfig(log logr.Logger, configFile string) error {
 	viper.SetDefault("ChannelName", defaultChannelName)
 	viper.SetDefault("ChannelNamespace", defaultChannelNamespace)
 	viper.SetDefault("GitURL", defaultGitURL)

diff --git a/e2e/util/context.go b/e2e/util/context.go
@@ -33,7 +33,7 @@ type Cluster struct {
 }
 
 type Context struct {
-	Log *logr.Logger
+	Log logr.Logger
 	Hub Cluster
 	C1  Cluster
 	C2  Cluster
@@ -99,7 +99,7 @@ func setupClient(kubeconfigPath string) (*kubernetes.Clientset, client.Client, e
 	return k8sClientSet, ctrlClient, nil
 }
 
-func NewContext(log *logr.Logger, configFile string) (*Context, error) {
+func NewContext(log logr.Logger, configFile string) (*Context, error) {
 	var err error
 
 	ctx := new(Context)