improve testing logger (#5346)

* add loggertesting package

move logger.NewTesting to loggertesting.New
add loggertesting.PrintObservedLogs to pretty print logs from a observer.ObservedLogs

(cherry picked from commit 0126540)

internal/pkg/agent/application/actions/handlers/handler_action_diagnostics_test.go

@@ -18,16 +18,15 @@ import (
 
 	"github.com/elastic/elastic-agent-client/v7/pkg/client"
 	"github.com/elastic/elastic-agent-client/v7/pkg/proto"
-	"github.com/elastic/elastic-agent/pkg/control/v2/cproto"
-
 	"github.com/elastic/elastic-agent/internal/pkg/agent/application/paths"
 	"github.com/elastic/elastic-agent/internal/pkg/agent/errors"
 	"github.com/elastic/elastic-agent/internal/pkg/core/monitoring/config"
 	"github.com/elastic/elastic-agent/internal/pkg/diagnostics"
 	"github.com/elastic/elastic-agent/internal/pkg/fleetapi"
 	"github.com/elastic/elastic-agent/pkg/component"
 	"github.com/elastic/elastic-agent/pkg/component/runtime"
-	"github.com/elastic/elastic-agent/pkg/core/logger"
+	"github.com/elastic/elastic-agent/pkg/control/v2/cproto"
+	"github.com/elastic/elastic-agent/pkg/core/logger/loggertest"
 	mockhandlers "github.com/elastic/elastic-agent/testing/mocks/internal_/pkg/agent/application/actions/handlers"
 	mockackers "github.com/elastic/elastic-agent/testing/mocks/internal_/pkg/fleetapi/acker"
 )
@@ -81,7 +80,7 @@ func TestDiagnosticHandlerHappyPathWithLogs(t *testing.T) {
 
 	mockDiagProvider := mockhandlers.NewDiagnosticsProvider(t)
 	mockUploader := mockhandlers.NewUploader(t)
-	testLogger, observedLogs := logger.NewTesting("diagnostic-handler-test")
+	testLogger, observedLogs := loggertest.New("diagnostic-handler-test")
 	handler := NewDiagnostics(testLogger, tempAgentRoot, mockDiagProvider, defaultRateLimit, mockUploader)
 
 	mockDiagProvider.EXPECT().DiagnosticHooks().Return([]diagnostics.Hook{hook1})
@@ -162,7 +161,7 @@ func TestDiagnosticHandlerUploaderErrorWithLogs(t *testing.T) {
 
 	mockDiagProvider := mockhandlers.NewDiagnosticsProvider(t)
 	mockUploader := mockhandlers.NewUploader(t)
-	testLogger, observedLogs := logger.NewTesting("diagnostic-handler-test")
+	testLogger, observedLogs := loggertest.New("diagnostic-handler-test")
 	handler := NewDiagnostics(testLogger, tempAgentRoot, mockDiagProvider, defaultRateLimit, mockUploader)
 
 	mockDiagProvider.EXPECT().DiagnosticHooks().Return([]diagnostics.Hook{})
@@ -203,7 +202,7 @@ func TestDiagnosticHandlerZipArchiveErrorWithLogs(t *testing.T) {
 
 	mockDiagProvider := mockhandlers.NewDiagnosticsProvider(t)
 	mockUploader := mockhandlers.NewUploader(t)
-	testLogger, observedLogs := logger.NewTesting("diagnostic-handler-test")
+	testLogger, observedLogs := loggertest.New("diagnostic-handler-test")
 	handler := NewDiagnostics(testLogger, tempAgentRoot, mockDiagProvider, defaultRateLimit, mockUploader)
 
 	mockDiagProvider.EXPECT().DiagnosticHooks().Return([]diagnostics.Hook{})
@@ -239,7 +238,7 @@ func TestDiagnosticHandlerAckErrorWithLogs(t *testing.T) {
 
 	mockDiagProvider := mockhandlers.NewDiagnosticsProvider(t)
 	mockUploader := mockhandlers.NewUploader(t)
-	testLogger, observedLogs := logger.NewTesting("diagnostic-handler-test")
+	testLogger, observedLogs := loggertest.New("diagnostic-handler-test")
 	handler := NewDiagnostics(testLogger, tempAgentRoot, mockDiagProvider, defaultRateLimit, mockUploader)
 
 	mockDiagProvider.EXPECT().DiagnosticHooks().Return([]diagnostics.Hook{})
@@ -278,7 +277,7 @@ func TestDiagnosticHandlerCommitErrorWithLogs(t *testing.T) {
 
 	mockDiagProvider := mockhandlers.NewDiagnosticsProvider(t)
 	mockUploader := mockhandlers.NewUploader(t)
-	testLogger, observedLogs := logger.NewTesting("diagnostic-handler-test")
+	testLogger, observedLogs := loggertest.New("diagnostic-handler-test")
 	handler := NewDiagnostics(testLogger, tempAgentRoot, mockDiagProvider, defaultRateLimit, mockUploader)
 
 	mockDiagProvider.EXPECT().DiagnosticHooks().Return([]diagnostics.Hook{})
@@ -318,7 +317,7 @@ func TestDiagnosticHandlerContexteExpiredErrorWithLogs(t *testing.T) {
 
 	mockDiagProvider := mockhandlers.NewDiagnosticsProvider(t)
 	mockUploader := mockhandlers.NewUploader(t)
-	testLogger, observedLogs := logger.NewTesting("diagnostic-handler-test")
+	testLogger, observedLogs := loggertest.New("diagnostic-handler-test")
 	handler := NewDiagnostics(testLogger, tempAgentRoot, mockDiagProvider, defaultRateLimit, mockUploader)
 
 	mockDiagProvider.EXPECT().DiagnosticHooks().Return([]diagnostics.Hook{})
@@ -362,7 +361,7 @@ func TestDiagnosticHandlerWithCPUProfile(t *testing.T) {
 
 	mockDiagProvider := mockhandlers.NewDiagnosticsProvider(t)
 	mockUploader := mockhandlers.NewUploader(t)
-	testLogger, _ := logger.NewTesting("diagnostic-handler-test")
+	testLogger, _ := loggertest.New("diagnostic-handler-test")
 	handler := NewDiagnostics(testLogger, tempAgentRoot, mockDiagProvider, defaultRateLimit, mockUploader)
 
 	mockDiagProvider.EXPECT().DiagnosticHooks().Return([]diagnostics.Hook{hook1})

internal/pkg/agent/application/actions/handlers/handler_action_policy_change_test.go

@@ -39,6 +39,7 @@ import (
 	"github.com/elastic/elastic-agent/internal/pkg/fleetapi/client"
 	"github.com/elastic/elastic-agent/internal/pkg/remote"
 	"github.com/elastic/elastic-agent/pkg/core/logger"
+	"github.com/elastic/elastic-agent/pkg/core/logger/loggertest"
 	mockhandlers "github.com/elastic/elastic-agent/testing/mocks/internal_/pkg/agent/application/actions/handlers"
 )
 
@@ -165,7 +166,7 @@ func TestPolicyChangeHandler_handlePolicyChange_FleetClientSettings(t *testing.T
 	t.Run("policy with proxy config", func(t *testing.T) {
 		t.Run("rollback client changes when cannot create client",
 			func(t *testing.T) {
-				log, _ := logger.NewTesting("TestPolicyChangeHandler")
+				log, _ := loggertest.New("TestPolicyChangeHandler")
 				var setterCalledCount int
 				setter := testSetter{SetClientFn: func(c client.Sender) {
 					setterCalledCount++
@@ -221,7 +222,7 @@ func TestPolicyChangeHandler_handlePolicyChange_FleetClientSettings(t *testing.T
 
 		t.Run("rollback client changes when cannot reach fleet-server",
 			func(t *testing.T) {
-				log, _ := logger.NewTesting("TestPolicyChangeHandler")
+				log, _ := loggertest.New("TestPolicyChangeHandler")
 				var setterCalledCount int
 				setter := testSetter{SetClientFn: func(c client.Sender) {
 					setterCalledCount++
@@ -277,7 +278,7 @@ func TestPolicyChangeHandler_handlePolicyChange_FleetClientSettings(t *testing.T
 			})
 
 		t.Run("a new Hosts and no proxy changes the remote config", func(t *testing.T) {
-			log, _ := logger.NewTesting("TestPolicyChangeHandler")
+			log, _ := loggertest.New("TestPolicyChangeHandler")
 			var setterCalledCount int
 			setter := testSetter{SetClientFn: func(c client.Sender) {
 				setterCalledCount++
@@ -321,7 +322,7 @@ func TestPolicyChangeHandler_handlePolicyChange_FleetClientSettings(t *testing.T
 		})
 
 		t.Run("a proxy changes the fleet client", func(t *testing.T) {
-			log, _ := logger.NewTesting("TestPolicyChangeHandler")
+			log, _ := loggertest.New("TestPolicyChangeHandler")
 			var setterCalledCount int
 			setter := testSetter{SetClientFn: func(c client.Sender) {
 				setterCalledCount++
@@ -371,7 +372,7 @@ func TestPolicyChangeHandler_handlePolicyChange_FleetClientSettings(t *testing.T
 			func(t *testing.T) {
 				wantProxy := mockProxy.URL
 
-				log, _ := logger.NewTesting("TestPolicyChangeHandler")
+				log, _ := loggertest.New("TestPolicyChangeHandler")
 				var setterCalledCount int
 				setter := testSetter{SetClientFn: func(c client.Sender) {
 					setterCalledCount++
@@ -433,7 +434,7 @@ func TestPolicyChangeHandler_handlePolicyChange_FleetClientSettings(t *testing.T
 				}))
 				defer alwaysErroringServer.Close()
 
-				log, _ := logger.NewTesting("TestPolicyChangeHandler")
+				log, _ := loggertest.New("TestPolicyChangeHandler")
 				var setterCalledCount int
 				setter := testSetter{SetClientFn: func(c client.Sender) {
 					setterCalledCount++
@@ -886,7 +887,7 @@ func TestPolicyChangeHandler_handlePolicyChange_FleetClientSettings(t *testing.T
 
 		for _, tc := range tcs {
 			t.Run(tc.name, func(t *testing.T) {
-				log, logs := logger.NewTesting(tc.name)
+				log, logs := loggertest.New(tc.name)
 				defer func() {
 					if t.Failed() {
 						t.Log("test failed, see handler logs below:")
@@ -1081,7 +1082,7 @@ func TestPolicyChangeHandler_handlePolicyChange_LogLevelSet(t *testing.T) {
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 
-			log, _ := logger.NewTesting(tt.name)
+			log, _ := loggertest.New(tt.name)
 			mockLogLevelSetter := mockhandlers.NewLogLevelSetter(t)
 
 			if tt.setupExpectations != nil {

internal/pkg/agent/application/actions/handlers/handler_action_settings_test.go

@@ -15,6 +15,7 @@ import (
 	"github.com/elastic/elastic-agent-libs/logp"
 	"github.com/elastic/elastic-agent/internal/pkg/fleetapi"
 	"github.com/elastic/elastic-agent/pkg/core/logger"
+	"github.com/elastic/elastic-agent/pkg/core/logger/loggertest"
 	mockhandlers "github.com/elastic/elastic-agent/testing/mocks/internal_/pkg/agent/application/actions/handlers"
 	mockinfo "github.com/elastic/elastic-agent/testing/mocks/internal_/pkg/agent/application/info"
 	mockfleetacker "github.com/elastic/elastic-agent/testing/mocks/internal_/pkg/fleetapi/acker"
@@ -88,7 +89,7 @@ func TestSettings_SetLogLevel(t *testing.T) {
 				tt.setupMocks(t, mockLogLevelSetter, mockAgentInfo)
 			}
 
-			log, _ := logger.NewTesting(tt.name)
+			log, _ := loggertest.New(tt.name)
 
 			ctx := context.Background()
 
@@ -191,7 +192,7 @@ func TestSettings_handleLogLevel(t *testing.T) {
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			log, _ := logger.NewTesting(tt.name)
+			log, _ := loggertest.New(tt.name)
 			mockAgentInfo := mockinfo.NewAgent(t)
 			mockLogLevelSetter := mockhandlers.NewLogLevelSetter(t)
 			mockAcker := mockfleetacker.NewAcker(t)

internal/pkg/agent/application/apm_config_modifier_test.go

@@ -14,10 +14,9 @@ import (
 	"gopkg.in/yaml.v2"
 
 	"github.com/elastic/elastic-agent-client/v7/pkg/proto"
-
 	"github.com/elastic/elastic-agent/internal/pkg/config"
 	"github.com/elastic/elastic-agent/pkg/component"
-	"github.com/elastic/elastic-agent/pkg/core/logger"
+	"github.com/elastic/elastic-agent/pkg/core/logger/loggertest"
 )
 
 type injectedConfigAssertion func(*testing.T, []component.Component)
@@ -449,7 +448,7 @@ func TestPatchAPMConfig(t *testing.T) {
 			require.NoError(t, err)
 			agtConf, err := config.NewConfigFrom(tt.args.agentFileCfg)
 			require.NoError(t, err)
-			log, _ := logger.NewTesting(tt.name)
+			log, _ := loggertest.New(tt.name)
 			patcher := PatchAPMConfig(log, agtConf)
 
 			mcc := &mockConfigChange{c: fleetConf}

internal/pkg/agent/application/application_test.go

@@ -17,7 +17,7 @@ import (
 	"github.com/elastic/elastic-agent/internal/pkg/agent/application/info"
 	"github.com/elastic/elastic-agent/internal/pkg/config"
 	"github.com/elastic/elastic-agent/internal/pkg/testutils"
-	"github.com/elastic/elastic-agent/pkg/core/logger"
+	"github.com/elastic/elastic-agent/pkg/core/logger/loggertest"
 	"github.com/elastic/elastic-agent/pkg/limits"
 )
 
@@ -48,7 +48,7 @@ func TestMergeFleetConfig(t *testing.T) {
 }
 
 func TestLimitsLog(t *testing.T) {
-	log, obs := logger.NewTesting("TestLimitsLog")
+	log, obs := loggertest.New("TestLimitsLog")
 	ctx, cn := context.WithCancel(context.Background())
 	defer cn()
 

internal/pkg/agent/application/coordinator/coordinator_unit_test.go

@@ -34,7 +34,7 @@ import (
 	"github.com/elastic/elastic-agent/pkg/component"
 	"github.com/elastic/elastic-agent/pkg/component/runtime"
 	agentclient "github.com/elastic/elastic-agent/pkg/control/v2/client"
-	"github.com/elastic/elastic-agent/pkg/core/logger"
+	"github.com/elastic/elastic-agent/pkg/core/logger/loggertest"
 	"github.com/elastic/elastic-agent/pkg/utils/broadcaster"
 )
 
@@ -338,7 +338,7 @@ func TestCoordinatorReportsInvalidPolicy(t *testing.T) {
 	ctx, cancel := context.WithTimeout(context.Background(), time.Second)
 	defer cancel()
 
-	log, obs := logger.NewTesting("")
+	log, obs := loggertest.New("")
 	defer func() {
 		if t.Failed() {
 			t.Log("test failed, coordinator logs below:")

internal/pkg/agent/application/dispatcher/dispatcher_test.go

@@ -20,7 +20,7 @@ import (
 	"github.com/elastic/elastic-agent/internal/pkg/fleetapi"
 	"github.com/elastic/elastic-agent/internal/pkg/fleetapi/acker"
 	"github.com/elastic/elastic-agent/internal/pkg/fleetapi/acker/noop"
-	"github.com/elastic/elastic-agent/pkg/core/logger"
+	"github.com/elastic/elastic-agent/pkg/core/logger/loggertest"
 )
 
 type mockHandler struct {
@@ -753,7 +753,7 @@ func TestReportNextScheduledUpgrade(t *testing.T) {
 			detailsSetter := func(upgradeDetails *details.Details) {
 				actualDetails = upgradeDetails
 			}
-			log, obs := logger.NewTesting("report_next_upgrade_details")
+			log, obs := loggertest.New("report_next_upgrade_details")
 
 			d.reportNextScheduledUpgrade(test.actions, detailsSetter, log)
 

internal/pkg/agent/application/gateway/fleet/fleet_gateway_test.go

@@ -9,7 +9,6 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
-
 	"io"
 	"net/http"
 	"net/url"
@@ -32,6 +31,7 @@ import (
 	"github.com/elastic/elastic-agent/internal/pkg/scheduler"
 	agentclient "github.com/elastic/elastic-agent/pkg/control/v2/client"
 	"github.com/elastic/elastic-agent/pkg/core/logger"
+	"github.com/elastic/elastic-agent/pkg/core/logger/loggertest"
 )
 
 type clientCallbackFunc func(headers http.Header, body io.Reader) (*http.Response, error)
@@ -317,7 +317,7 @@ func TestFleetGateway(t *testing.T) {
 		scheduler := scheduler.NewStepper()
 		client := newTestingClient()
 
-		log, _ := logger.NewTesting("fleet_gateway")
+		log, _ := loggertest.New("fleet_gateway")
 
 		stateStore := newStateStore(t, log)
 

internal/pkg/agent/application/monitoring/reload/reload_test.go

@@ -12,7 +12,7 @@ import (
 
 	aConfig "github.com/elastic/elastic-agent/internal/pkg/config"
 	monitoringCfg "github.com/elastic/elastic-agent/internal/pkg/core/monitoring/config"
-	"github.com/elastic/elastic-agent/pkg/core/logger"
+	"github.com/elastic/elastic-agent/pkg/core/logger/loggertest"
 )
 
 func TestReload(t *testing.T) {
@@ -78,7 +78,7 @@ agent.monitoring.enabled: false
 	for _, tc := range tcs {
 		t.Run(tc.name, func(t *testing.T) {
 			fsc := &fakeServerController{}
-			log, _ := logger.NewTesting(tc.name)
+			log, _ := loggertest.New(tc.name)
 			cfg := &monitoringCfg.MonitoringConfig{
 				Enabled:        tc.currEnabled,
 				MonitorMetrics: tc.currMetrics,

internal/pkg/agent/application/upgrade/artifact/config_test.go

@@ -16,7 +16,7 @@ import (
 	agentlibsconfig "github.com/elastic/elastic-agent-libs/config"
 	"github.com/elastic/elastic-agent-libs/transport/httpcommon"
 	"github.com/elastic/elastic-agent/internal/pkg/config"
-	"github.com/elastic/elastic-agent/pkg/core/logger"
+	"github.com/elastic/elastic-agent/pkg/core/logger/loggertest"
 )
 
 func TestReload(t *testing.T) {
@@ -224,7 +224,7 @@ func TestReload(t *testing.T) {
 		},
 	}
 
-	l, _ := logger.NewTesting("t")
+	l, _ := loggertest.New("t")
 	for _, tc := range testCases {
 		cfg := tc.initialConfig
 		reloader := NewReloader(cfg, l)

internal/pkg/agent/application/upgrade/artifact/download/fs/verifier_test.go

@@ -22,6 +22,7 @@ import (
 	"github.com/elastic/elastic-agent/internal/pkg/agent/application/upgrade/artifact/download"
 	"github.com/elastic/elastic-agent/internal/pkg/release"
 	"github.com/elastic/elastic-agent/pkg/core/logger"
+	"github.com/elastic/elastic-agent/pkg/core/logger/loggertest"
 	agtversion "github.com/elastic/elastic-agent/pkg/version"
 	"github.com/elastic/elastic-agent/testing/pgptest"
 )
@@ -201,7 +202,7 @@ func TestVerify(t *testing.T) {
 
 	for _, tc := range tt {
 		t.Run(tc.Name, func(t *testing.T) {
-			log, obs := logger.NewTesting("TestVerify")
+			log, obs := loggertest.New("TestVerify")
 			targetDir := t.TempDir()
 
 			timeout := 30 * time.Second

internal/pkg/agent/application/upgrade/artifact/download/http/downloader_test.go

@@ -25,6 +25,7 @@ import (
 	"github.com/elastic/elastic-agent/internal/pkg/agent/application/upgrade/artifact"
 	"github.com/elastic/elastic-agent/internal/pkg/agent/application/upgrade/details"
 	"github.com/elastic/elastic-agent/pkg/core/logger"
+	"github.com/elastic/elastic-agent/pkg/core/logger/loggertest"
 	agtversion "github.com/elastic/elastic-agent/pkg/version"
 
 	"github.com/docker/go-units"
@@ -109,7 +110,7 @@ func TestDownloadBodyError(t *testing.T) {
 		Architecture:    "64",
 	}
 
-	log, obs := logger.NewTesting("downloader")
+	log, obs := loggertest.New("downloader")
 	upgradeDetails := details.NewDetails("8.12.0", details.StateRequested, "")
 	testClient := NewDownloaderWithClient(log, config, *client, upgradeDetails)
 	artifactPath, err := testClient.Download(context.Background(), beatSpec, version)
@@ -166,7 +167,7 @@ func TestDownloadLogProgressWithLength(t *testing.T) {
 		},
 	}
 
-	log, obs := logger.NewTesting("downloader")
+	log, obs := loggertest.New("downloader")
 	upgradeDetails := details.NewDetails("8.12.0", details.StateRequested, "")
 	testClient := NewDownloaderWithClient(log, config, *client, upgradeDetails)
 	artifactPath, err := testClient.Download(context.Background(), beatSpec, version)
@@ -249,7 +250,7 @@ func TestDownloadLogProgressWithoutLength(t *testing.T) {
 		},
 	}
 
-	log, obs := logger.NewTesting("downloader")
+	log, obs := loggertest.New("downloader")
 	upgradeDetails := details.NewDetails("8.12.0", details.StateRequested, "")
 	testClient := NewDownloaderWithClient(log, config, *client, upgradeDetails)
 	artifactPath, err := testClient.Download(context.Background(), beatSpec, version)
@@ -510,7 +511,7 @@ func TestDownloadVersion(t *testing.T) {
 			defer server.Close()
 
 			elasticClient := server.Client()
-			log, _ := logger.NewTesting("downloader")
+			log, _ := loggertest.New("downloader")
 			upgradeDetails := details.NewDetails(tt.args.version.String(), details.StateRequested, "")
 			config := tt.fields.config
 			config.SourceURI = server.URL