From 3cbacb6858ea2dda67719de64854ed30dea3b626 Mon Sep 17 00:00:00 2001 From: Chris Date: Mon, 30 Oct 2017 11:58:00 -0500 Subject: Remove unused variables / code (#7736) * remove unused variables / code * fix bug in testPostStoreGetOldest --- utils/logger/logger.go | 11 +- utils/logger/logger_test.go | 281 -------------------------------------------- 2 files changed, 5 insertions(+), 287 deletions(-) delete mode 100644 utils/logger/logger_test.go (limited to 'utils/logger') diff --git a/utils/logger/logger.go b/utils/logger/logger.go index 410a5a5fc..da549dcc4 100644 --- a/utils/logger/logger.go +++ b/utils/logger/logger.go @@ -28,15 +28,14 @@ var infoLog = l4g.Info var errorLog = l4g.Error func init() { + // listens for configuration changes that we might need to respond to + utils.AddConfigListener(func(oldConfig *model.Config, newConfig *model.Config) { + infoLog("Configuration change detected, reloading log settings") + initL4g(newConfig.LogSettings) + }) initL4g(utils.Cfg.LogSettings) } -// listens for configuration changes that we might need to respond to -var configListenerID = utils.AddConfigListener(func(oldConfig *model.Config, newConfig *model.Config) { - infoLog("Configuration change detected, reloading log settings") - initL4g(newConfig.LogSettings) -}) - // assumes that ../config.go::configureLog has already been called, and has in turn called l4g.close() to clean up // any old filters that we might have previously created func initL4g(logSettings model.LogSettings) { diff --git a/utils/logger/logger_test.go b/utils/logger/logger_test.go deleted file mode 100644 index 3aba48561..000000000 --- a/utils/logger/logger_test.go +++ /dev/null @@ -1,281 +0,0 @@ -// this is a new logger interface for mattermost - -package logger - -type LogMessage struct { - Context map[string]string - File string - Message string -} - -const validPath = `^utils/([a-z_]+/)*logger_test.go$` - -/* - -Broken because code somehow depends on path - -// ensures that the relative path of the file that called into the logger is returned -func TestGetCallerFilename(t *testing.T) { - filename, _ := getCallerFilename() - fmt.Println("Thing: " + filename) - matched, err := regexp.MatchString(validPath, filename) - require.NoError(t, err) - assert.True(t, matched) -} - -// ensures that values can be recorded on a Context object, and that the data in question is serialized as a part of the log message -func TestSerializeContext(t *testing.T) { - ctx := context.Background() - - expectedUserId := "some-fake-user-id" - ctx = WithUserId(ctx, expectedUserId) - - expectedRequestId := "some-fake-request-id" - ctx = WithRequestId(ctx, expectedRequestId) - - serialized := serializeContext(ctx) - - assert.Equal(t, map[string]string{ - "user_id": expectedUserId, - "request_id": expectedRequestId, - }, serialized) -} - -// ensures that an entire log message with an empty context can be properly serialized into a JSON object -func TestSerializeLogMessageEmptyContext(t *testing.T) { - emptyContext := context.Background() - - var logMessage = "This is a log message" - var serialized = serializeLogMessage(emptyContext, logMessage) - - var deserialized LogMessage - json.Unmarshal([]byte(serialized), &deserialized) - - assert.Empty(t, deserialized.Context) - assert.Equal(t, logMessage, deserialized.Message) - matched, err := regexp.MatchString(validPath, deserialized.File) - require.NoError(t, err) - assert.True(t, matched) -} - -// ensures that an entire log message with a populated context can be properly serialized into a JSON object -func TestSerializeLogMessagePopulatedContext(t *testing.T) { - populatedContext := context.Background() - - populatedContext = WithRequestId(populatedContext, "foo") - populatedContext = WithUserId(populatedContext, "bar") - - var logMessage = "This is a log message" - var serialized = serializeLogMessage(populatedContext, logMessage) - - var deserialized LogMessage - json.Unmarshal([]byte(serialized), &deserialized) - - assert.Equal(t, map[string]string{ - "request_id": "foo", - "user_id": "bar", - }, deserialized.Context) - assert.Equal(t, logMessage, deserialized.Message) - matched, err := regexp.MatchString(validPath, deserialized.File) - require.NoError(t, err) - assert.True(t, matched) -} - -// ensures that a debugLog message is passed through to the underlying logger as expected -func TestDebugc(t *testing.T) { - // inject a "mocked" debugLog method that captures the first argument that is passed to it - var capture string - oldDebug := debugLog - defer func() { debugLog = oldDebug }() - type WrapperType func() string - debugLog = func(format interface{}, args ...interface{}) { - // the code that we're testing passes a closure to the debugLog method, so we have to execute it to get the actual message back - if f, ok := format.(func() string); ok { - capture = WrapperType(f)() - } else { - t.Error("First parameter passed to Debug is not a closure") - } - } - - // log something - emptyContext := context.Background() - var logMessage = "Some log message" - Debugc(emptyContext, logMessage) - - // check to see that the message is logged to the underlying log system, in this case our mock method - var deserialized LogMessage - json.Unmarshal([]byte(capture), &deserialized) - - assert.Empty(t, deserialized.Context) - assert.Equal(t, logMessage, deserialized.Message) - matched, err := regexp.MatchString(validPath, deserialized.File) - require.NoError(t, err) - assert.True(t, matched) -} - -// ensures that a debugLog message is passed through to the underlying logger as expected -func TestDebugf(t *testing.T) { - // inject a "mocked" debugLog method that captures the first argument that is passed to it - var capture string - oldDebug := debugLog - defer func() { debugLog = oldDebug }() - type WrapperType func() string - debugLog = func(format interface{}, args ...interface{}) { - // the code that we're testing passes a closure to the debugLog method, so we have to execute it to get the actual message back - if f, ok := format.(func() string); ok { - capture = WrapperType(f)() - } else { - t.Error("First parameter passed to Debug is not a closure") - } - } - - // log something - formatString := "Some %v message" - param := "log" - Debugf(formatString, param) - - // check to see that the message is logged to the underlying log system, in this case our mock method - var deserialized LogMessage - json.Unmarshal([]byte(capture), &deserialized) - - assert.Empty(t, deserialized.Context) - assert.Equal(t, fmt.Sprintf(formatString, param), deserialized.Message) - matched, err := regexp.MatchString(validPath, deserialized.File) - require.NoError(t, err) - assert.True(t, matched) -} - -// ensures that an infoLog message is passed through to the underlying logger as expected -func TestInfoc(t *testing.T) { - // inject a "mocked" infoLog method that captures the first argument that is passed to it - var capture string - oldInfo := infoLog - defer func() { infoLog = oldInfo }() - type WrapperType func() string - infoLog = func(format interface{}, args ...interface{}) { - // the code that we're testing passes a closure to the infoLog method, so we have to execute it to get the actual message back - if f, ok := format.(func() string); ok { - capture = WrapperType(f)() - } else { - t.Error("First parameter passed to Info is not a closure") - } - } - - // log something - emptyContext := context.Background() - var logMessage = "Some log message" - Infoc(emptyContext, logMessage) - - // check to see that the message is logged to the underlying log system, in this case our mock method - var deserialized LogMessage - json.Unmarshal([]byte(capture), &deserialized) - - assert.Empty(t, deserialized.Context) - assert.Equal(t, logMessage, deserialized.Message) - matched, err := regexp.MatchString(validPath, deserialized.File) - require.NoError(t, err) - assert.True(t, matched) -} - -// ensures that an infoLog message is passed through to the underlying logger as expected -func TestInfof(t *testing.T) { - // inject a "mocked" infoLog method that captures the first argument that is passed to it - var capture string - oldInfo := infoLog - defer func() { infoLog = oldInfo }() - type WrapperType func() string - infoLog = func(format interface{}, args ...interface{}) { - // the code that we're testing passes a closure to the infoLog method, so we have to execute it to get the actual message back - if f, ok := format.(func() string); ok { - capture = WrapperType(f)() - } else { - t.Error("First parameter passed to Info is not a closure") - } - } - - // log something - format := "Some %v message" - param := "log" - Infof(format, param) - - // check to see that the message is logged to the underlying log system, in this case our mock method - var deserialized LogMessage - json.Unmarshal([]byte(capture), &deserialized) - - assert.Empty(t, deserialized.Context) - assert.Equal(t, fmt.Sprintf(format, param), deserialized.Message) - matched, err := regexp.MatchString(validPath, deserialized.File) - require.NoError(t, err) - assert.True(t, matched) -} - -// ensures that an error message is passed through to the underlying logger as expected -func TestErrorc(t *testing.T) { - // inject a "mocked" err method that captures the first argument that is passed to it - var capture string - oldError := errorLog - defer func() { errorLog = oldError }() - type WrapperType func() string - errorLog = func(format interface{}, args ...interface{}) error { - // the code that we're testing passes a closure to the err method, so we have to execute it to get the actual message back - if f, ok := format.(func() string); ok { - capture = WrapperType(f)() - } else { - t.Error("First parameter passed to Error is not a closure") - } - - // the code under test doesn't care about this return value - return errors.New(capture) - } - - // log something - emptyContext := context.Background() - var logMessage = "Some log message" - Errorc(emptyContext, logMessage) - - // check to see that the message is logged to the underlying log system, in this case our mock method - var deserialized LogMessage - json.Unmarshal([]byte(capture), &deserialized) - - assert.Empty(t, deserialized.Context) - assert.Equal(t, logMessage, deserialized.Message) - matched, err := regexp.MatchString(validPath, deserialized.File) - require.NoError(t, err) - assert.True(t, matched) -} - -// ensures that an error message is passed through to the underlying logger as expected -func TestErrorf(t *testing.T) { - // inject a "mocked" err method that captures the first argument that is passed to it - var capture string - oldError := errorLog - defer func() { errorLog = oldError }() - type WrapperType func() string - errorLog = func(format interface{}, args ...interface{}) error { - // the code that we're testing passes a closure to the err method, so we have to execute it to get the actual message back - if f, ok := format.(func() string); ok { - capture = WrapperType(f)() - } else { - t.Error("First parameter passed to Error is not a closure") - } - - // the code under test doesn't care about this return value - return errors.New(capture) - } - - // log something - format := "Some %v message" - param := "log" - Errorf(format, param) - - // check to see that the message is logged to the underlying log system, in this case our mock method - var deserialized LogMessage - json.Unmarshal([]byte(capture), &deserialized) - - assert.Empty(t, deserialized.Context) - assert.Equal(t, fmt.Sprintf(format, param), deserialized.Message) - matched, err := regexp.MatchString(validPath, deserialized.File) - require.NoError(t, err) - assert.True(t, matched) -} -*/ -- cgit v1.2.3-1-g7c22