make logging more consistent

Use consistent capitalization and naming conventions for the loggers.

Use the test logging function for test messages instead of mixing
those in with the regular log output.

Signed-off-by: Doug Hellmann <dhellmann@redhat.com>

Author: dhellmann

controllers/metal3.io/baremetalhost_controller.go

@@ -516,7 +516,7 @@ func (r *BareMetalHostReconciler) actionMatchProfile(prov provisioner.Provisione
 func (r *BareMetalHostReconciler) actionProvisioning(prov provisioner.Provisioner, info *reconcileInfo) actionResult {
 	hostConf := &hostConfigData{
 		host:   info.host,
-		log:    info.log,
+		log:    info.log.WithName("host_config_data"),
 		client: r,
 	}
 	info.log.Info("provisioning")

controllers/metal3.io/baremetalhost_controller_test.go

@@ -99,7 +99,7 @@ func newTestReconcilerWithProvisionerFactory(factory provisioner.Factory, initOb
 		Client:             c,
 		Scheme:             scheme.Scheme,
 		ProvisionerFactory: factory,
-		Log:                ctrl.Log.WithName("controller").WithName("baremetalhost").WithName("test"),
+		Log:                ctrl.Log.WithName("controllers").WithName("BareMetalHost"),
 	}
 }
 
@@ -122,8 +122,7 @@ func tryReconcile(t *testing.T, r *BareMetalHostReconciler, host *metal3v1alpha1
 	request := newRequest(host)
 
 	for i := 0; ; i++ {
-		logger := r.Log.WithValues("iteration", i)
-		logger.Info("tryReconcile: top of loop")
+		t.Logf("tryReconcile: top of loop %d", i)
 		if i >= 25 {
 			t.Fatal(fmt.Errorf("Exceeded 25 iterations"))
 		}
@@ -143,11 +142,11 @@ func tryReconcile(t *testing.T, r *BareMetalHostReconciler, host *metal3v1alpha1
 		updatedHost.DeepCopyInto(host)
 
 		if isDone(host, result) {
-			logger.Info("tryReconcile: loop done")
+			t.Logf("tryReconcile: loop done %d", i)
 			break
 		}
 
-		logger.Info("tryReconcile: loop bottom", "result", result)
+		t.Logf("tryReconcile: loop bottom %d result=%v", i, result)
 		if !result.Requeue && result.RequeueAfter == 0 {
 			t.Fatal(fmt.Errorf("Ended reconcile at iteration %d without test condition being true", i))
 			break
@@ -156,11 +155,10 @@ func tryReconcile(t *testing.T, r *BareMetalHostReconciler, host *metal3v1alpha1
 }
 
 func waitForStatus(t *testing.T, r *BareMetalHostReconciler, host *metal3v1alpha1.BareMetalHost, desiredStatus metal3v1alpha1.OperationalStatus) {
-	logger := r.Log.WithValues("desiredStatus", desiredStatus)
 	tryReconcile(t, r, host,
 		func(host *metal3v1alpha1.BareMetalHost, result reconcile.Result) bool {
 			state := host.OperationalStatus()
-			logger.Info("WAIT FOR STATUS", "State", state)
+			t.Logf("Waiting for status %s: %s", desiredStatus, state)
 			return state == desiredStatus
 		},
 	)
@@ -169,7 +167,7 @@ func waitForStatus(t *testing.T, r *BareMetalHostReconciler, host *metal3v1alpha
 func waitForError(t *testing.T, r *BareMetalHostReconciler, host *metal3v1alpha1.BareMetalHost) {
 	tryReconcile(t, r, host,
 		func(host *metal3v1alpha1.BareMetalHost, result reconcile.Result) bool {
-			r.Log.Info("WAIT FOR ERROR", "ErrorMessage", host.Status.ErrorMessage)
+			t.Logf("Waiting for error: %q", host.Status.ErrorMessage)
 			return host.HasError()
 		},
 	)
@@ -178,7 +176,7 @@ func waitForError(t *testing.T, r *BareMetalHostReconciler, host *metal3v1alpha1
 func waitForNoError(t *testing.T, r *BareMetalHostReconciler, host *metal3v1alpha1.BareMetalHost) {
 	tryReconcile(t, r, host,
 		func(host *metal3v1alpha1.BareMetalHost, result reconcile.Result) bool {
-			r.Log.Info("WAIT FOR NO ERROR", "ErrorMessage", host.Status.ErrorMessage)
+			t.Logf("Waiting for no error message: %q", host.Status.ErrorMessage)
 			return !host.HasError()
 		},
 	)
@@ -749,8 +747,6 @@ func TestFixSecret(t *testing.T) {
 // moves out of the error state.
 func TestBreakThenFixSecret(t *testing.T) {
 
-	logger := ctrl.Log.WithName("Test").WithName("TestBreakThenFixSecret")
-
 	// Create the host without any errors and wait for it to be
 	// registered and get a provisioning ID.
 	secret := newBMCCredsSecret("bmc-creds-toggle-user", "User", "Pass")
@@ -765,7 +761,7 @@ func TestBreakThenFixSecret(t *testing.T) {
 	tryReconcile(t, r, host,
 		func(host *metal3v1alpha1.BareMetalHost, result reconcile.Result) bool {
 			id := host.Status.Provisioning.ID
-			logger.Info("WAIT FOR PROVISIONING ID", "ID", id)
+			t.Logf("Waiting for provisioning ID to be set: %q", id)
 			return id != ""
 		},
 	)

controllers/metal3.io/demo_test.go

@@ -28,7 +28,7 @@ func newDemoReconciler(initObjs ...runtime.Object) *BareMetalHostReconciler {
 		Client:             c,
 		Scheme:             scheme.Scheme,
 		ProvisionerFactory: demo.New,
-		Log:                ctrl.Log.WithName("controller").WithName("baremetalhost").WithName("demo").WithName("test"),
+		Log:                ctrl.Log.WithName("controller").WithName("BareMetalHost"),
 	}
 }
 

controllers/metal3.io/host_config_data_test.go

@@ -227,7 +227,7 @@ func TestProvisionWithHostConfig(t *testing.T) {
 			c.Create(goctx.TODO(), tc.NetworkDataSecret)
 			hcd := &hostConfigData{
 				host:   tc.Host,
-				log:    ctrl.Log.WithName("Test").WithName(tc.Scenario),
+				log:    ctrl.Log.WithName("controllers").WithName("BareMetalHost").WithName("host_config_data"),
 				client: c,
 			}
 

controllers/metal3.io/host_state_machine_test.go

@@ -315,7 +315,7 @@ func (hb *hostBuilder) SetImageURL(url string) *hostBuilder {
 
 func makeDefaultReconcileInfo(host *metal3v1alpha1.BareMetalHost) *reconcileInfo {
 	return &reconcileInfo{
-		log:     logf.Log.WithName("test"),
+		log:     logf.Log.WithName("controllers").WithName("BareMetalHost").WithName("host_state_machine"),
 		host:    host,
 		request: ctrl.Request{},
 		bmcCredsSecret: &corev1.Secret{

pkg/provisioner/demo/demo.go

@@ -11,7 +11,7 @@ import (
 	"github.com/metal3-io/baremetal-operator/pkg/provisioner"
 )
 
-var log = logf.Log.WithName("demo")
+var log = logf.Log.WithName("provisioner").WithName("demo")
 var deprovisionRequeueDelay = time.Second * 10
 var provisionRequeueDelay = time.Second * 10
 

pkg/provisioner/fixture/fixture.go

@@ -11,7 +11,7 @@ import (
 	"github.com/metal3-io/baremetal-operator/pkg/provisioner"
 )
 
-var log = logf.Log.WithName("fixture")
+var log = logf.Log.WithName("provisioner").WithName("fixture")
 var deprovisionRequeueDelay = time.Second * 10
 var provisionRequeueDelay = time.Second * 10
 

pkg/provisioner/ironic/ironic.go

@@ -27,7 +27,7 @@ import (
 	"github.com/metal3-io/baremetal-operator/pkg/provisioner/ironic/hardwaredetails"
 )
 
-var log = logf.Log.WithName("baremetalhost_ironic")
+var log = logf.Log.WithName("provisioner").WithName("ironic")
 var deprovisionRequeueDelay = time.Second * 10
 var provisionRequeueDelay = time.Second * 10
 var powerRequeueDelay = time.Second * 10