1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
|
// Copyright 2024 The Prometheus Authors
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package promslog
import (
"bytes"
"context"
"fmt"
"log/slog"
"regexp"
"strings"
"testing"
"github.com/stretchr/testify/require"
"gopkg.in/yaml.v2"
)
var (
slogStyleLogRegexp = regexp.MustCompile(`(?P<TimeKey>time)=.*level=(?P<LevelValue>WARN|INFO|ERROR|DEBUG).*(?P<SourceKey>source)=.*`)
goKitStyleLogRegexp = regexp.MustCompile(`(?P<TimeKey>ts)=.*level=(?P<LevelValue>warn|info|error|debug).*(?P<SourceKey>caller)=.*`)
)
// Make sure creating and using a logger with an empty configuration doesn't
// result in a panic.
func TestDefaultConfig(t *testing.T) {
require.NotPanics(t, func() {
logger := New(&Config{})
logger.Info("empty config `Info()` test", "hello", "world")
logger.Log(context.Background(), slog.LevelInfo, "empty config `Log()` test", "hello", "world")
logger.LogAttrs(context.Background(), slog.LevelInfo, "empty config `LogAttrs()` test", slog.String("hello", "world"))
})
}
func TestUnmarshallLevel(t *testing.T) {
l := NewLevel()
err := yaml.Unmarshal([]byte(`debug`), l)
if err != nil {
t.Error(err)
}
if got := l.String(); got != "debug" {
t.Errorf("expected %s, got %s", "debug", got)
}
}
func TestUnmarshallEmptyLevel(t *testing.T) {
l := NewLevel()
err := yaml.Unmarshal([]byte(``), l)
if err != nil {
t.Error(err)
}
if got := l.String(); got != "info" {
t.Errorf("expected info (default) level, got %s", got)
}
}
func TestUnmarshallBadLevel(t *testing.T) {
l := NewLevel()
err := yaml.Unmarshal([]byte(`debugg`), l)
if err == nil {
t.Error("expected error")
}
expErr := `unrecognized log level debugg`
if err.Error() != expErr {
t.Errorf("expected error %s, got %s", expErr, err.Error())
}
if got := l.String(); got != "info" {
t.Errorf("expected info (default) level, got %s", got)
}
}
func getLogEntryLevelCounts(s string, re *regexp.Regexp) map[string]int {
counters := make(map[string]int)
lines := strings.Split(s, "\n")
for _, line := range lines {
matches := re.FindStringSubmatch(line)
if len(matches) > 1 {
levelIndex := re.SubexpIndex("LevelValue")
counters[strings.ToLower(matches[levelIndex])]++
}
}
return counters
}
func TestDynamicLevels(t *testing.T) {
var buf bytes.Buffer
wantedLevelCounts := map[string]int{"info": 1, "debug": 1}
tests := map[string]struct {
logStyle LogStyle
logStyleRegexp *regexp.Regexp
wantedLevelCount map[string]int
}{
"slog_log_style": {logStyle: SlogStyle, logStyleRegexp: slogStyleLogRegexp, wantedLevelCount: wantedLevelCounts},
"go-kit_log_style": {logStyle: GoKitStyle, logStyleRegexp: goKitStyleLogRegexp, wantedLevelCount: wantedLevelCounts},
}
for name, tc := range tests {
t.Run(name, func(t *testing.T) {
buf.Reset() // Ensure buf is reset prior to tests
config := &Config{Writer: &buf, Style: tc.logStyle}
logger := New(config)
// Test that log level can be adjusted on-the-fly to debug and that a
// log entry can be written to the file.
err := config.Level.Set("debug")
require.NoError(t, err)
logger.Info("info", "hello", "world")
logger.Debug("debug", "hello", "world")
counts := getLogEntryLevelCounts(buf.String(), tc.logStyleRegexp)
require.Equalf(t, tc.wantedLevelCount["info"], counts["info"], "info log successfully detected")
require.Equalf(t, tc.wantedLevelCount["debug"], counts["debug"], "debug log successfully detected")
// Print logs for humans to see, if needed.
fmt.Println(buf.String())
buf.Reset()
// Test that log level can be adjusted on-the-fly to info and that a
// subsequent call to write a debug level log is _not_ written to the
// file.
err = config.Level.Set("info")
require.NoError(t, err)
logger.Info("info", "hello", "world")
logger.Debug("debug", "hello", "world")
counts = getLogEntryLevelCounts(buf.String(), tc.logStyleRegexp)
require.Equalf(t, tc.wantedLevelCount["info"], counts["info"], "info log successfully detected")
require.NotEqualf(t, tc.wantedLevelCount["debug"], counts["debug"], "extra debug log detected")
// Print logs for humans to see, if needed.
fmt.Println(buf.String())
buf.Reset()
})
}
}
func TestTruncateSourceFileName_DefaultStyle(t *testing.T) {
var buf bytes.Buffer
config := &Config{
Writer: &buf,
}
logger := New(config)
logger.Info("test message")
output := buf.String()
if !strings.Contains(output, "source=slog_test.go:") {
t.Errorf("Expected source file name to be truncated to basename, got: %s", output)
}
if strings.Contains(output, "/") {
t.Errorf("Expected no directory separators in source file name, got: %s", output)
}
}
func TestTruncateSourceFileName_GoKitStyle(t *testing.T) {
var buf bytes.Buffer
config := &Config{
Writer: &buf,
Style: GoKitStyle,
}
logger := New(config)
logger.Info("test message")
output := buf.String()
// In GoKitStyle, the source key is "caller".
if !strings.Contains(output, "caller=slog_test.go:") {
t.Errorf("Expected caller to contain basename of source file, got: %s", output)
}
if strings.Contains(output, "/") {
t.Errorf("Expected no directory separators in caller, got: %s", output)
}
}
func TestReservedKeys(t *testing.T) {
var buf bytes.Buffer
reservedKeyTestVal := "surprise! I'm a string"
tests := map[string]struct {
logStyle LogStyle
levelKey string
sourceKey string
timeKey string
}{
"slog_log_style": {logStyle: SlogStyle, levelKey: "level", sourceKey: "source", timeKey: "time"},
"go-kit_log_style": {logStyle: GoKitStyle, levelKey: "level", sourceKey: "caller", timeKey: "ts"},
}
for name, tc := range tests {
t.Run(name, func(t *testing.T) {
buf.Reset() // Ensure buf is reset prior to tests
config := &Config{Writer: &buf, Style: tc.logStyle}
logger := New(config)
logger.LogAttrs(context.Background(),
slog.LevelInfo,
"reserved keys test for "+name,
slog.String(tc.levelKey, reservedKeyTestVal),
slog.String(tc.sourceKey, reservedKeyTestVal),
slog.String(tc.timeKey, reservedKeyTestVal),
)
output := buf.String()
require.Containsf(t, output, fmt.Sprintf("%s%s=\"%s\"", reservedKeyPrefix, tc.levelKey, reservedKeyTestVal), "Expected duplicate level key to be renamed")
require.Containsf(t, output, fmt.Sprintf("%s%s=\"%s\"", reservedKeyPrefix, tc.sourceKey, reservedKeyTestVal), "Expected duplicate source key to be renamed")
require.Containsf(t, output, fmt.Sprintf("%s%s=\"%s\"", reservedKeyPrefix, tc.timeKey, reservedKeyTestVal), "Expected duplicate time key to be renamed")
// Print logs for humans to see, if needed.
fmt.Println(buf.String())
})
}
}
|