[MM-55990] Logger improvements for tests (#25467)

server/channels/api4/apitestlib.go

@@ -97,6 +97,8 @@ func setupTestHelper(dbStore store.Store, searchEngine *searchengine.Broker, ent
 	*memoryConfig.PluginSettings.ClientDirectory = filepath.Join(tempWorkspace, "webapp")
 	memoryConfig.ServiceSettings.EnableLocalMode = model.NewBool(true)
 	*memoryConfig.ServiceSettings.LocalModeSocketLocation = filepath.Join(tempWorkspace, "mattermost_local.sock")
+	*memoryConfig.LogSettings.EnableSentry = false // disable error reporting during tests
+	*memoryConfig.LogSettings.ConsoleLevel = mlog.LvlStdLog.Name
 	*memoryConfig.AnnouncementSettings.AdminNoticesEnabled = false
 	*memoryConfig.AnnouncementSettings.UserNoticesEnabled = false
 	*memoryConfig.PluginSettings.AutomaticPrepackagedPlugins = false

server/channels/api4/config_test.go

@@ -640,6 +640,13 @@ func TestPatchConfig(t *testing.T) {
 	th := Setup(t)
 	defer th.TearDown()
 
+	// Ensure ConsoleLevel is set to DEBUG
+	config := model.Config{LogSettings: model.LogSettings{
+		ConsoleLevel: model.NewString("DEBUG"),
+	}}
+	_, _, err := th.SystemAdminClient.PatchConfig(context.Background(), &config)
+	require.NoError(t, err)
+
 	t.Run("config is missing", func(t *testing.T) {
 		_, response, err := th.Client.PatchConfig(context.Background(), nil)
 		require.Error(t, err)

server/channels/app/helper_test.go

@@ -59,6 +59,7 @@ func setupTestHelper(dbStore store.Store, enterprise bool, includeCacheLayer boo
 	*memoryConfig.PluginSettings.ClientDirectory = filepath.Join(tempWorkspace, "webapp")
 	*memoryConfig.PluginSettings.AutomaticPrepackagedPlugins = false
 	*memoryConfig.LogSettings.EnableSentry = false // disable error reporting during tests
+	*memoryConfig.LogSettings.ConsoleLevel = mlog.LvlStdLog.Name
 	*memoryConfig.AnnouncementSettings.AdminNoticesEnabled = false
 	*memoryConfig.AnnouncementSettings.UserNoticesEnabled = false
 	configStore.Set(memoryConfig)

server/channels/app/slashcommands/helper_test.go

@@ -56,6 +56,7 @@ func setupTestHelper(dbStore store.Store, enterprise bool, includeCacheLayer boo
 	*memoryConfig.PluginSettings.ClientDirectory = filepath.Join(tempWorkspace, "webapp")
 	*memoryConfig.PluginSettings.AutomaticPrepackagedPlugins = false
 	*memoryConfig.LogSettings.EnableSentry = false // disable error reporting during tests
+	*memoryConfig.LogSettings.ConsoleLevel = mlog.LvlStdLog.Name
 	memoryStore.Set(memoryConfig)
 
 	buffer := &bytes.Buffer{}

server/channels/jobs/helper_test.go

@@ -48,6 +48,7 @@ func setupTestHelper(dbStore store.Store, enterprise bool, includeCacheLayer boo
 	*memoryConfig.PluginSettings.ClientDirectory = filepath.Join(tempWorkspace, "webapp")
 	*memoryConfig.PluginSettings.AutomaticPrepackagedPlugins = false
 	*memoryConfig.LogSettings.EnableSentry = false // disable error reporting during tests
+	*memoryConfig.LogSettings.ConsoleLevel = mlog.LvlStdLog.Name
 	*memoryConfig.AnnouncementSettings.AdminNoticesEnabled = false
 	*memoryConfig.AnnouncementSettings.UserNoticesEnabled = false
 	configStore.Set(memoryConfig)

server/channels/web/web_test.go

@@ -78,6 +78,9 @@ func setupTestHelper(tb testing.TB, includeCacheLayer bool, options []app.Option
 	*newConfig.AnnouncementSettings.AdminNoticesEnabled = false
 	*newConfig.AnnouncementSettings.UserNoticesEnabled = false
 	*newConfig.PluginSettings.AutomaticPrepackagedPlugins = false
+	*newConfig.LogSettings.EnableSentry = false // disable error reporting during tests
+	*newConfig.LogSettings.ConsoleJson = false
+	*newConfig.LogSettings.ConsoleLevel = mlog.LvlStdLog.Name
 	memoryStore.Set(newConfig)
 	options = append(options, app.ConfigStore(memoryStore))
 	options = append(options, app.StoreOverride(mainHelper.Store))

server/platform/services/sharedchannel/channelinvite_test.go

@@ -22,9 +22,8 @@ import (
 func TestOnReceiveChannelInvite(t *testing.T) {
 	t.Run("when msg payload is empty, it does nothing", func(t *testing.T) {
 		mockServer := &MockServerIface{}
-		mockLogger, err := mlog.NewLogger()
+		logger := mlog.CreateConsoleTestLogger(t)
-		require.NoError(t, err)
+		mockServer.On("Log").Return(logger)
-		mockServer.On("Log").Return(mockLogger)
 		mockApp := &MockAppIface{}
 		scs := &Service{
 			server: mockServer,
@@ -38,16 +37,15 @@ func TestOnReceiveChannelInvite(t *testing.T) {
 		remoteCluster := &model.RemoteCluster{}
 		msg := model.RemoteClusterMsg{}
 
-		err = scs.onReceiveChannelInvite(msg, remoteCluster, nil)
+		err := scs.onReceiveChannelInvite(msg, remoteCluster, nil)
 		require.NoError(t, err)
 		mockStore.AssertNotCalled(t, "Channel")
 	})
 
 	t.Run("when invitation prescribes a readonly channel, it does create a readonly channel", func(t *testing.T) {
 		mockServer := &MockServerIface{}
-		mockLogger, err := mlog.NewLogger()
+		logger := mlog.CreateConsoleTestLogger(t)
-		require.NoError(t, err)
+		mockServer.On("Log").Return(logger)
-		mockServer.On("Log").Return(mockLogger)
 		mockApp := &MockAppIface{}
 		scs := &Service{
 			server: mockServer,
@@ -106,9 +104,8 @@ func TestOnReceiveChannelInvite(t *testing.T) {
 
 	t.Run("when invitation prescribes a readonly channel and readonly update fails, it returns an error", func(t *testing.T) {
 		mockServer := &MockServerIface{}
-		mockLogger, err := mlog.NewLogger()
+		logger := mlog.CreateConsoleTestLogger(t)
-		require.NoError(t, err)
+		mockServer.On("Log").Return(logger)
-		mockServer.On("Log").Return(mockLogger)
 		mockApp := &MockAppIface{}
 		scs := &Service{
 			server: mockServer,
@@ -149,9 +146,8 @@ func TestOnReceiveChannelInvite(t *testing.T) {
 
 	t.Run("when invitation prescribes a direct channel, it does create a direct channel", func(t *testing.T) {
 		mockServer := &MockServerIface{}
-		mockLogger, err := mlog.NewLogger()
+		logger := mlog.CreateConsoleTestLogger(t)
-		require.NoError(t, err)
+		mockServer.On("Log").Return(logger)
-		mockServer.On("Log").Return(mockLogger)
 		mockApp := &MockAppIface{}
 		scs := &Service{
 			server: mockServer,

server/platform/services/sharedchannel/permalink_test.go

@@ -26,6 +26,7 @@ func TestProcessPermalinkToRemote(t *testing.T) {
 	mockStore := &mocks.Store{}
 	mockPostStore := mocks.PostStore{}
 	utils.TranslationsPreInit()
+	logger := mlog.CreateConsoleTestLogger(t)
 
 	pl := &model.PostList{}
 	mockPostStore.On("Get", context.Background(), "postID", model.GetPostsOptions{SkipFetchThreads: true}, "", map[string]bool{}).Return(pl, nil)
@@ -34,7 +35,7 @@ func TestProcessPermalinkToRemote(t *testing.T) {
 
 	mockServer := scs.server.(*MockServerIface)
 	mockServer.On("GetStore").Return(mockStore)
-	mockServer.On("Log").Return(mlog.NewLogger())
+	mockServer.On("Log").Return(logger)
 
 	mockApp := scs.app.(*MockAppIface)
 	mockApp.On("SendEphemeralPost", mock.Anything, "user", mock.AnythingOfType("*model.Post")).Return(&model.Post{}).Times(1)

server/public/plugin/environment_test.go

@@ -22,10 +22,10 @@ func TestAvailablePlugins(t *testing.T) {
 		os.RemoveAll(dir)
 	})
 
-	testLogger, _ := mlog.NewLogger()
+	logger := mlog.CreateConsoleTestLogger(t)
 	env := Environment{
 		pluginDir: dir,
-		logger:    testLogger,
+		logger:    logger,
 	}
 
 	t.Run("Should be able to load available plugins", func(t *testing.T) {