|
| 1 | +//go:build go1.21 |
| 2 | +// +build go1.21 |
| 3 | + |
| 4 | +/* |
| 5 | +Copyright 2023 The logr Authors. |
| 6 | +
|
| 7 | +Licensed under the Apache License, Version 2.0 (the "License"); |
| 8 | +you may not use this file except in compliance with the License. |
| 9 | +You may obtain a copy of the License at |
| 10 | +
|
| 11 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 12 | +
|
| 13 | +Unless required by applicable law or agreed to in writing, software |
| 14 | +distributed under the License is distributed on an "AS IS" BASIS, |
| 15 | +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 16 | +See the License for the specific language governing permissions and |
| 17 | +limitations under the License. |
| 18 | +*/ |
| 19 | + |
| 20 | +package zapr_test |
| 21 | + |
| 22 | +import ( |
| 23 | + "bytes" |
| 24 | + "context" |
| 25 | + "encoding/json" |
| 26 | + "log/slog" |
| 27 | + "strings" |
| 28 | + "testing" |
| 29 | + "testing/slogtest" |
| 30 | + |
| 31 | + "github.com/go-logr/logr/slogr" |
| 32 | + "github.com/go-logr/zapr" |
| 33 | + "github.com/stretchr/testify/require" |
| 34 | + "go.uber.org/zap" |
| 35 | + "go.uber.org/zap/zapcore" |
| 36 | +) |
| 37 | + |
| 38 | +func TestSlogHandler(t *testing.T) { |
| 39 | + var buffer bytes.Buffer |
| 40 | + encoder := zapcore.NewJSONEncoder(zapcore.EncoderConfig{ |
| 41 | + MessageKey: slog.MessageKey, |
| 42 | + TimeKey: slog.TimeKey, |
| 43 | + LevelKey: slog.LevelKey, |
| 44 | + EncodeLevel: func(level zapcore.Level, encoder zapcore.PrimitiveArrayEncoder) { |
| 45 | + encoder.AppendInt(int(level)) |
| 46 | + }, |
| 47 | + }) |
| 48 | + core := zapcore.NewCore(encoder, zapcore.AddSync(&buffer), zapcore.Level(0)) |
| 49 | + zl := zap.New(core) |
| 50 | + logger := zapr.NewLogger(zl) |
| 51 | + handler := slogr.NewSlogHandler(logger) |
| 52 | + |
| 53 | + err := slogtest.TestHandler(handler, func() []map[string]any { |
| 54 | + zl.Sync() |
| 55 | + return parseOutput(t, buffer.Bytes()) |
| 56 | + }) |
| 57 | + t.Logf("Log output:\n%s\nAs JSON:\n%v\n", buffer.String(), parseOutput(t, buffer.Bytes())) |
| 58 | + // Correlating failures with individual test cases is hard with the current API. |
| 59 | + // See https://github.com/golang/go/issues/61758 |
| 60 | + t.Logf("Output:\n%s", buffer.String()) |
| 61 | + if err != nil { |
| 62 | + if err, ok := err.(interface { |
| 63 | + Unwrap() []error |
| 64 | + }); ok { |
| 65 | + for _, err := range err.Unwrap() { |
| 66 | + if !containsOne(err.Error(), |
| 67 | + "a Handler should ignore a zero Record.Time", // zapr always writes a time field. |
| 68 | + "a Handler should not output groups for an empty Record", // Relies on WithGroup and that always opens a group. Text may change, see https://go.dev/cl/516155 |
| 69 | + ) { |
| 70 | + t.Errorf("Unexpected error: %v", err) |
| 71 | + } |
| 72 | + } |
| 73 | + } else { |
| 74 | + // Shouldn't be reached, errors from errors.Join can be split up. |
| 75 | + t.Errorf("Unexpected errors:\n%v", err) |
| 76 | + } |
| 77 | + } |
| 78 | +} |
| 79 | + |
| 80 | +func containsOne(hay string, needles ...string) bool { |
| 81 | + for _, needle := range needles { |
| 82 | + if strings.Contains(hay, needle) { |
| 83 | + return true |
| 84 | + } |
| 85 | + } |
| 86 | + return false |
| 87 | +} |
| 88 | + |
| 89 | +// TestSlogCases covers some gaps in the coverage we get from |
| 90 | +// slogtest.TestHandler (empty and invalud PC, see |
| 91 | +// https://github.com/golang/go/issues/62280) and verbosity handling in |
| 92 | +// combination with V(). |
| 93 | +func TestSlogCases(t *testing.T) { |
| 94 | + for name, tc := range map[string]struct { |
| 95 | + record slog.Record |
| 96 | + v int |
| 97 | + expected string |
| 98 | + }{ |
| 99 | + "empty": { |
| 100 | + expected: `{"msg":"", "level":"info", "v":0}`, |
| 101 | + }, |
| 102 | + "invalid-pc": { |
| 103 | + record: slog.Record{PC: 1}, |
| 104 | + expected: `{"msg":"", "level":"info", "v":0}`, |
| 105 | + }, |
| 106 | + "debug": { |
| 107 | + record: slog.Record{Level: slog.LevelDebug}, |
| 108 | + expected: `{"msg":"", "level":"Level(-4)", "v":4}`, |
| 109 | + }, |
| 110 | + "warn": { |
| 111 | + record: slog.Record{Level: slog.LevelWarn}, |
| 112 | + expected: `{"msg":"", "level":"warn", "v":0}`, |
| 113 | + }, |
| 114 | + "error": { |
| 115 | + record: slog.Record{Level: slog.LevelError}, |
| 116 | + expected: `{"msg":"", "level":"error"}`, |
| 117 | + }, |
| 118 | + "debug-v1": { |
| 119 | + v: 1, |
| 120 | + record: slog.Record{Level: slog.LevelDebug}, |
| 121 | + expected: `{"msg":"", "level":"Level(-5)", "v":5}`, |
| 122 | + }, |
| 123 | + "warn-v1": { |
| 124 | + v: 1, |
| 125 | + record: slog.Record{Level: slog.LevelWarn}, |
| 126 | + expected: `{"msg":"", "level":"info", "v":0}`, |
| 127 | + }, |
| 128 | + "error-v1": { |
| 129 | + v: 1, |
| 130 | + record: slog.Record{Level: slog.LevelError}, |
| 131 | + expected: `{"msg":"", "level":"error"}`, |
| 132 | + }, |
| 133 | + "debug-v4": { |
| 134 | + v: 4, |
| 135 | + record: slog.Record{Level: slog.LevelDebug}, |
| 136 | + expected: `{"msg":"", "level":"Level(-8)", "v":8}`, |
| 137 | + }, |
| 138 | + "warn-v4": { |
| 139 | + v: 4, |
| 140 | + record: slog.Record{Level: slog.LevelWarn}, |
| 141 | + expected: `{"msg":"", "level":"info", "v":0}`, |
| 142 | + }, |
| 143 | + "error-v4": { |
| 144 | + v: 4, |
| 145 | + record: slog.Record{Level: slog.LevelError}, |
| 146 | + expected: `{"msg":"", "level":"error"}`, |
| 147 | + }, |
| 148 | + } { |
| 149 | + t.Run(name, func(t *testing.T) { |
| 150 | + var buffer bytes.Buffer |
| 151 | + encoder := zapcore.NewJSONEncoder(zapcore.EncoderConfig{ |
| 152 | + MessageKey: slog.MessageKey, |
| 153 | + LevelKey: slog.LevelKey, |
| 154 | + EncodeLevel: func(level zapcore.Level, encoder zapcore.PrimitiveArrayEncoder) { |
| 155 | + encoder.AppendString(level.String()) |
| 156 | + }, |
| 157 | + }) |
| 158 | + core := zapcore.NewCore(encoder, zapcore.AddSync(&buffer), zapcore.Level(-10)) |
| 159 | + zl := zap.New(core) |
| 160 | + logger := zapr.NewLoggerWithOptions(zl, zapr.LogInfoLevel("v")) |
| 161 | + handler := slogr.NewSlogHandler(logger.V(tc.v)) |
| 162 | + require.NoError(t, handler.Handle(context.Background(), tc.record)) |
| 163 | + zl.Sync() |
| 164 | + require.JSONEq(t, tc.expected, buffer.String()) |
| 165 | + }) |
| 166 | + } |
| 167 | +} |
| 168 | + |
| 169 | +func parseOutput(t *testing.T, output []byte) []map[string]any { |
| 170 | + var ms []map[string]any |
| 171 | + for _, line := range bytes.Split(output, []byte{'\n'}) { |
| 172 | + if len(line) == 0 { |
| 173 | + continue |
| 174 | + } |
| 175 | + var m map[string]any |
| 176 | + if err := json.Unmarshal(line, &m); err != nil { |
| 177 | + t.Fatal(err) |
| 178 | + } |
| 179 | + ms = append(ms, m) |
| 180 | + } |
| 181 | + return ms |
| 182 | +} |
0 commit comments