Merge branch '140-standardize-logging-timestamp-format' into 'main'

Standardize logging timestamp format

Closes #140

See merge request gitlab-org/gitlab-shell!485

internal/logger/logger.go

@@ -10,9 +10,21 @@ import (
 	"gitlab.com/gitlab-org/gitlab-shell/internal/config"
 )
 
+type UTCFormatter struct {
+	log.Formatter
+}
+
+func (u UTCFormatter) Format(e *log.Entry) ([]byte, error) {
+	e.Time = e.Time.UTC()
+
+	return u.Formatter.Format(e)
+}
+
 func configureLogFormat(cfg *config.Config) {
 	if cfg.LogFormat == "json" {
-		log.SetFormatter(&log.JSONFormatter{})
+		log.SetFormatter(UTCFormatter{&log.JSONFormatter{}})
+	} else {
+		log.SetFormatter(UTCFormatter{&log.TextFormatter{}})
 	}
 }
 

internal/logger/logger_test.go

@@ -3,6 +3,7 @@ package logger
 import (
 	"io/ioutil"
 	"os"
+	"regexp"
 	"strings"
 	"testing"
 
@@ -44,3 +45,27 @@ func TestConfigureWithPermissionError(t *testing.T) {
 	Configure(&config)
 	log.Info("this is a test")
 }
+
+func TestLogInUTC(t *testing.T) {
+	tmpFile, err := ioutil.TempFile(os.TempDir(), "logtest-")
+	require.NoError(t, err)
+	defer tmpFile.Close()
+	defer os.Remove(tmpFile.Name())
+
+	config := config.Config{
+		LogFile:   tmpFile.Name(),
+		LogFormat: "json",
+	}
+
+	Configure(&config)
+	log.Info("this is a test")
+
+	data, err := ioutil.ReadFile(tmpFile.Name())
+	require.NoError(t, err)
+
+	utc := `[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z`
+	r, e := regexp.MatchString(utc, string(data))
+
+	require.NoError(t, e)
+	require.True(t, r)
+}