/* Copyright 2021 The logr 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 funcr import ( "encoding/json" "fmt" "path/filepath" "reflect" "runtime" "testing" "github.com/go-logr/logr" ) // Will be handled via reflection instead of type assertions. type substr string func ptrint(i int) *int { return &i } func ptrstr(s string) *string { return &s } // point implements encoding.TextMarshaler and can be used as a map key. type point struct{ x, y int } func (p point) MarshalText() ([]byte, error) { return []byte(fmt.Sprintf("(%d, %d)", p.x, p.y)), nil } // pointErr implements encoding.TextMarshaler but returns an error. type pointErr struct{ x, y int } func (p pointErr) MarshalText() ([]byte, error) { return nil, fmt.Errorf("uh oh: %d, %d", p.x, p.y) } // Logging this should result in the MarshalLog() value. type Tmarshaler struct{ val string } func (t Tmarshaler) MarshalLog() any { return struct{ Inner string }{"I am a logr.Marshaler"} } func (t Tmarshaler) String() string { return "String(): you should not see this" } func (t Tmarshaler) Error() string { return "Error(): you should not see this" } // Logging this should result in a panic. type Tmarshalerpanic struct{ val string } func (t Tmarshalerpanic) MarshalLog() any { panic("Tmarshalerpanic") } // Logging this should result in the String() value. type Tstringer struct{ val string } func (t Tstringer) String() string { return "I am a fmt.Stringer" } func (t Tstringer) Error() string { return "Error(): you should not see this" } // Logging this should result in a panic. type Tstringerpanic struct{ val string } func (t Tstringerpanic) String() string { panic("Tstringerpanic") } // Logging this should result in the Error() value. type Terror struct{ val string } func (t Terror) Error() string { return "I am an error" } // Logging this should result in a panic. type Terrorpanic struct{ val string } func (t Terrorpanic) Error() string { panic("Terrorpanic") } type TjsontagsString struct { String0 string `json:"-"` // first field ignored String1 string `json:"string1"` // renamed String2 string `json:"-"` // ignored String3 string `json:"-,"` // named "-" String4 string `json:"string4,omitempty"` // renamed, ignore if empty String5 string `json:","` // no-op String6 string `json:",omitempty"` // ignore if empty } type TjsontagsBool struct { Bool0 bool `json:"-"` // first field ignored Bool1 bool `json:"bool1"` // renamed Bool2 bool `json:"-"` // ignored Bool3 bool `json:"-,"` // named "-" Bool4 bool `json:"bool4,omitempty"` // renamed, ignore if empty Bool5 bool `json:","` // no-op Bool6 bool `json:",omitempty"` // ignore if empty } type TjsontagsInt struct { Int0 int `json:"-"` // first field ignored Int1 int `json:"int1"` // renamed Int2 int `json:"-"` // ignored Int3 int `json:"-,"` // named "-" Int4 int `json:"int4,omitempty"` // renamed, ignore if empty Int5 int `json:","` // no-op Int6 int `json:",omitempty"` // ignore if empty } type TjsontagsUint struct { Uint0 int `json:"-"` // first field ignored Uint1 uint `json:"uint1"` // renamed Uint2 uint `json:"-"` // ignored Uint3 uint `json:"-,"` // named "-" Uint4 uint `json:"uint4,omitempty"` // renamed, ignore if empty Uint5 uint `json:","` // no-op Uint6 uint `json:",omitempty"` // ignore if empty } type TjsontagsFloat struct { Float0 float64 `json:"-"` // first field ignored Float1 float64 `json:"float1"` // renamed Float2 float64 `json:"-"` // ignored Float3 float64 `json:"-,"` // named "-" Float4 float64 `json:"float4,omitempty"` // renamed, ignore if empty Float5 float64 `json:","` // no-op Float6 float64 `json:",omitempty"` // ignore if empty } type TjsontagsComplex struct { Complex0 complex128 `json:"-"` // first field ignored Complex1 complex128 `json:"complex1"` // renamed Complex2 complex128 `json:"-"` // ignored Complex3 complex128 `json:"-,"` // named "-" Complex4 complex128 `json:"complex4,omitempty"` // renamed, ignore if empty Complex5 complex128 `json:","` // no-op Complex6 complex128 `json:",omitempty"` // ignore if empty } type TjsontagsPtr struct { Ptr0 *string `json:"-"` // first field ignored Ptr1 *string `json:"ptr1"` // renamed Ptr2 *string `json:"-"` // ignored Ptr3 *string `json:"-,"` // named "-" Ptr4 *string `json:"ptr4,omitempty"` // renamed, ignore if empty Ptr5 *string `json:","` // no-op Ptr6 *string `json:",omitempty"` // ignore if empty } type TjsontagsArray struct { Array0 [2]string `json:"-"` // first field ignored Array1 [2]string `json:"array1"` // renamed Array2 [2]string `json:"-"` // ignored Array3 [2]string `json:"-,"` // named "-" Array4 [2]string `json:"array4,omitempty"` // renamed, ignore if empty Array5 [2]string `json:","` // no-op Array6 [2]string `json:",omitempty"` // ignore if empty } type TjsontagsSlice struct { Slice0 []string `json:"-"` // first field ignored Slice1 []string `json:"slice1"` // renamed Slice2 []string `json:"-"` // ignored Slice3 []string `json:"-,"` // named "-" Slice4 []string `json:"slice4,omitempty"` // renamed, ignore if empty Slice5 []string `json:","` // no-op Slice6 []string `json:",omitempty"` // ignore if empty } type TjsontagsMap struct { Map0 map[string]string `json:"-"` // first field ignored Map1 map[string]string `json:"map1"` // renamed Map2 map[string]string `json:"-"` // ignored Map3 map[string]string `json:"-,"` // named "-" Map4 map[string]string `json:"map4,omitempty"` // renamed, ignore if empty Map5 map[string]string `json:","` // no-op Map6 map[string]string `json:",omitempty"` // ignore if empty } type Tinnerstruct struct { Inner string } type Tinnerint int type Tinnermap map[string]string type Tinnerslice []string type Tembedstruct struct { Tinnerstruct Outer string } type Tembednonstruct struct { Tinnerint Tinnermap Tinnerslice } type Tinner1 Tinnerstruct type Tinner2 Tinnerstruct type Tinner3 Tinnerstruct type Tinner4 Tinnerstruct type Tinner5 Tinnerstruct type Tinner6 Tinnerstruct type Tembedjsontags struct { Outer string Tinner1 `json:"inner1"` Tinner2 `json:"-"` Tinner3 `json:"-,"` Tinner4 `json:"inner4,omitempty"` Tinner5 `json:","` Tinner6 `json:"inner6,omitempty"` } type Trawjson struct { Message json.RawMessage `json:"message"` } func TestPretty(t *testing.T) { // used below newStr := func(s string) *string { return &s } cases := []struct { val any exp string // used in cases where JSON can't handle it }{{ val: "strval", }, { val: "strval\nwith\t\"escapes\"", }, { val: substr("substrval"), }, { val: substr("substrval\nwith\t\"escapes\""), }, { val: true, }, { val: false, }, { val: int(93), }, { val: int8(93), }, { val: int16(93), }, { val: int32(93), }, { val: int64(93), }, { val: int(-93), }, { val: int8(-93), }, { val: int16(-93), }, { val: int32(-93), }, { val: int64(-93), }, { val: uint(93), }, { val: uint8(93), }, { val: uint16(93), }, { val: uint32(93), }, { val: uint64(93), }, { val: uintptr(93), }, { val: float32(93.76), }, { val: float64(93.76), }, { val: complex64(93i), exp: `"(0+93i)"`, }, { val: complex128(93i), exp: `"(0+93i)"`, }, { val: ptrint(93), }, { val: ptrstr("pstrval"), }, { val: []int{}, }, { val: []int(nil), exp: `[]`, }, { val: []int{9, 3, 7, 6}, }, { val: []string{"str", "with\tescape"}, }, { val: []substr{"substr", "with\tescape"}, }, { val: [4]int{9, 3, 7, 6}, }, { val: [2]string{"str", "with\tescape"}, }, { val: [2]substr{"substr", "with\tescape"}, }, { val: struct { Int int notExported string String string }{ 93, "you should not see this", "seventy-six", }, }, { val: map[string]int{}, }, { val: map[string]int(nil), exp: `{}`, }, { val: map[string]int{ "nine": 3, }, }, { val: map[string]int{ "with\tescape": 76, }, }, { val: map[substr]int{ "nine": 3, }, }, { val: map[substr]int{ "with\tescape": 76, }, }, { val: map[int]int{ 9: 3, }, }, { val: map[float64]int{ 9.5: 3, }, exp: `{"9.5":3}`, }, { val: map[point]int{ {x: 1, y: 2}: 3, }, }, { val: map[pointErr]int{ {x: 1, y: 2}: 3, }, exp: `{"":3}`, }, { val: struct { X int `json:"x"` Y int `json:"y"` }{ 93, 76, }, }, { val: struct { X []int Y map[int]int Z struct{ P, Q int } }{ []int{9, 3, 7, 6}, map[int]int{9: 3}, struct{ P, Q int }{9, 3}, }, }, { val: []struct{ X, Y string }{ {"nine", "three"}, {"seven", "six"}, {"with\t", "\tescapes"}, }, }, { val: struct { A *int B *int C any D any }{ B: ptrint(1), D: any(2), }, }, { val: Tmarshaler{"foobar"}, exp: `{"Inner":"I am a logr.Marshaler"}`, }, { val: &Tmarshaler{"foobar"}, exp: `{"Inner":"I am a logr.Marshaler"}`, }, { val: (*Tmarshaler)(nil), exp: `""`, }, { val: Tmarshalerpanic{"foobar"}, exp: `""`, }, { val: Tstringer{"foobar"}, exp: `"I am a fmt.Stringer"`, }, { val: &Tstringer{"foobar"}, exp: `"I am a fmt.Stringer"`, }, { val: (*Tstringer)(nil), exp: `""`, }, { val: Tstringerpanic{"foobar"}, exp: `""`, }, { val: Terror{"foobar"}, exp: `"I am an error"`, }, { val: &Terror{"foobar"}, exp: `"I am an error"`, }, { val: (*Terror)(nil), exp: `""`, }, { val: Terrorpanic{"foobar"}, exp: `""`, }, { val: TjsontagsString{ String1: "v1", String2: "v2", String3: "v3", String4: "v4", String5: "v5", String6: "v6", }, }, { val: TjsontagsString{}, }, { val: TjsontagsBool{ Bool1: true, Bool2: true, Bool3: true, Bool4: true, Bool5: true, Bool6: true, }, }, { val: TjsontagsBool{}, }, { val: TjsontagsInt{ Int1: 1, Int2: 2, Int3: 3, Int4: 4, Int5: 5, Int6: 6, }, }, { val: TjsontagsInt{}, }, { val: TjsontagsUint{ Uint1: 1, Uint2: 2, Uint3: 3, Uint4: 4, Uint5: 5, Uint6: 6, }, }, { val: TjsontagsUint{}, }, { val: TjsontagsFloat{ Float1: 1.1, Float2: 2.2, Float3: 3.3, Float4: 4.4, Float5: 5.5, Float6: 6.6, }, }, { val: TjsontagsFloat{}, }, { val: TjsontagsComplex{ Complex1: 1i, Complex2: 2i, Complex3: 3i, Complex4: 4i, Complex5: 5i, Complex6: 6i, }, exp: `{"complex1":"(0+1i)","-":"(0+3i)","complex4":"(0+4i)","Complex5":"(0+5i)","Complex6":"(0+6i)"}`, }, { val: TjsontagsComplex{}, exp: `{"complex1":"(0+0i)","-":"(0+0i)","Complex5":"(0+0i)"}`, }, { val: TjsontagsPtr{ Ptr1: newStr("1"), Ptr2: newStr("2"), Ptr3: newStr("3"), Ptr4: newStr("4"), Ptr5: newStr("5"), Ptr6: newStr("6"), }, }, { val: TjsontagsPtr{}, }, { val: TjsontagsArray{ Array1: [2]string{"v1", "v1"}, Array2: [2]string{"v2", "v2"}, Array3: [2]string{"v3", "v3"}, Array4: [2]string{"v4", "v4"}, Array5: [2]string{"v5", "v5"}, Array6: [2]string{"v6", "v6"}, }, }, { val: TjsontagsArray{}, }, { val: TjsontagsSlice{ Slice1: []string{"v1", "v1"}, Slice2: []string{"v2", "v2"}, Slice3: []string{"v3", "v3"}, Slice4: []string{"v4", "v4"}, Slice5: []string{"v5", "v5"}, Slice6: []string{"v6", "v6"}, }, }, { val: TjsontagsSlice{}, exp: `{"slice1":[],"-":[],"Slice5":[]}`, }, { val: TjsontagsMap{ Map1: map[string]string{"k1": "v1"}, Map2: map[string]string{"k2": "v2"}, Map3: map[string]string{"k3": "v3"}, Map4: map[string]string{"k4": "v4"}, Map5: map[string]string{"k5": "v5"}, Map6: map[string]string{"k6": "v6"}, }, }, { val: TjsontagsMap{}, exp: `{"map1":{},"-":{},"Map5":{}}`, }, { val: Tembedstruct{}, }, { val: Tembednonstruct{}, exp: `{"Tinnerint":0,"Tinnermap":{},"Tinnerslice":[]}`, }, { val: Tembedjsontags{}, }, { val: PseudoStruct(makeKV("f1", 1, "f2", true, "f3", []int{})), exp: `{"f1":1,"f2":true,"f3":[]}`, }, { val: map[TjsontagsString]int{ {String1: `"quoted"`, String4: `unquoted`}: 1, }, exp: `{"{\"string1\":\"\\\"quoted\\\"\",\"-\":\"\",\"string4\":\"unquoted\",\"String5\":\"\"}":1}`, }, { val: map[TjsontagsInt]int{ {Int1: 1, Int2: 2}: 3, }, exp: `{"{\"int1\":1,\"-\":0,\"Int5\":0}":3}`, }, { val: map[[2]struct{ S string }]int{ {{S: `"quoted"`}, {S: "unquoted"}}: 1, }, exp: `{"[{\"S\":\"\\\"quoted\\\"\"},{\"S\":\"unquoted\"}]":1}`, }, { val: TjsontagsComplex{}, exp: `{"complex1":"(0+0i)","-":"(0+0i)","Complex5":"(0+0i)"}`, }, { val: TjsontagsPtr{ Ptr1: newStr("1"), Ptr2: newStr("2"), Ptr3: newStr("3"), Ptr4: newStr("4"), Ptr5: newStr("5"), Ptr6: newStr("6"), }, }, { val: TjsontagsPtr{}, }, { val: TjsontagsArray{ Array1: [2]string{"v1", "v1"}, Array2: [2]string{"v2", "v2"}, Array3: [2]string{"v3", "v3"}, Array4: [2]string{"v4", "v4"}, Array5: [2]string{"v5", "v5"}, Array6: [2]string{"v6", "v6"}, }, }, { val: TjsontagsArray{}, }, { val: TjsontagsSlice{ Slice1: []string{"v1", "v1"}, Slice2: []string{"v2", "v2"}, Slice3: []string{"v3", "v3"}, Slice4: []string{"v4", "v4"}, Slice5: []string{"v5", "v5"}, Slice6: []string{"v6", "v6"}, }, }, { val: TjsontagsSlice{}, exp: `{"slice1":[],"-":[],"Slice5":[]}`, }, { val: TjsontagsMap{ Map1: map[string]string{"k1": "v1"}, Map2: map[string]string{"k2": "v2"}, Map3: map[string]string{"k3": "v3"}, Map4: map[string]string{"k4": "v4"}, Map5: map[string]string{"k5": "v5"}, Map6: map[string]string{"k6": "v6"}, }, }, { val: TjsontagsMap{}, exp: `{"map1":{},"-":{},"Map5":{}}`, }, { val: Tembedstruct{}, }, { val: Tembednonstruct{}, exp: `{"Tinnerint":0,"Tinnermap":{},"Tinnerslice":[]}`, }, { val: Tembedjsontags{}, }, { val: PseudoStruct(makeKV("f1", 1, "f2", true, "f3", []int{})), exp: `{"f1":1,"f2":true,"f3":[]}`, }, { val: map[TjsontagsString]int{ {String1: `"quoted"`, String4: `unquoted`}: 1, }, exp: `{"{\"string1\":\"\\\"quoted\\\"\",\"-\":\"\",\"string4\":\"unquoted\",\"String5\":\"\"}":1}`, }, { val: map[TjsontagsInt]int{ {Int1: 1, Int2: 2}: 3, }, exp: `{"{\"int1\":1,\"-\":0,\"Int5\":0}":3}`, }, { val: map[[2]struct{ S string }]int{ {{S: `"quoted"`}, {S: "unquoted"}}: 1, }, exp: `{"[{\"S\":\"\\\"quoted\\\"\"},{\"S\":\"unquoted\"}]":1}`, }} f := NewFormatterJSON(Options{}) for i, tc := range cases { ours := f.pretty(tc.val) want := "" if tc.exp != "" { want = tc.exp } else { jb, err := json.Marshal(tc.val) if err != nil { t.Fatalf("[%d]: unexpected error: %v\ngot: %q", i, err, ours) } want = string(jb) } if ours != want { t.Errorf("[%d]:\n\texpected %q\n\tgot %q", i, want, ours) } } } func makeKV(args ...any) []any { return args } func TestRender(t *testing.T) { // used below raw := &Trawjson{} marshal := &TjsontagsInt{} var err error raw.Message, err = json.Marshal(marshal) if err != nil { t.Fatalf("json.Marshal error: %v", err) } testCases := []struct { name string builtins []any values []any args []any expectKV string expectJSON string }{{ name: "nil", expectKV: "", expectJSON: "{}", }, { name: "empty", builtins: []any{}, values: []any{}, args: []any{}, expectKV: "", expectJSON: "{}", }, { name: "primitives", builtins: makeKV("int1", 1, "int2", 2), values: makeKV("str1", "ABC", "str2", "DEF"), args: makeKV("bool1", true, "bool2", false), expectKV: `"int1"=1 "int2"=2 "str1"="ABC" "str2"="DEF" "bool1"=true "bool2"=false`, expectJSON: `{"int1":1,"int2":2,"str1":"ABC","str2":"DEF","bool1":true,"bool2":false}`, }, { name: "pseudo structs", builtins: makeKV("int", PseudoStruct(makeKV("intsub", 1))), values: makeKV("str", PseudoStruct(makeKV("strsub", "2"))), args: makeKV("bool", PseudoStruct(makeKV("boolsub", true))), expectKV: `"int"={"intsub"=1} "str"={"strsub"="2"} "bool"={"boolsub"=true}`, expectJSON: `{"int":{"intsub":1},"str":{"strsub":"2"},"bool":{"boolsub":true}}`, }, { name: "escapes", builtins: makeKV("\"1\"", 1), // will not be escaped, but should never happen values: makeKV("\tstr", "ABC"), // escaped args: makeKV("bool\n", true), // escaped expectKV: `""1""=1 "\tstr"="ABC" "bool\n"=true`, expectJSON: `{""1"":1,"\tstr":"ABC","bool\n":true}`, }, { name: "missing value", builtins: makeKV("builtin"), values: makeKV("value"), args: makeKV("arg"), expectKV: `"builtin"="" "value"="" "arg"=""`, expectJSON: `{"builtin":"","value":"","arg":""}`, }, { name: "non-string key int", builtins: makeKV(123, "val"), // should never happen values: makeKV(456, "val"), args: makeKV(789, "val"), expectKV: `""="val" ""="val" ""="val"`, expectJSON: `{"":"val","":"val","":"val"}`, }, { name: "non-string key struct", builtins: makeKV(struct { // will not be escaped, but should never happen F1 string F2 int }{"builtin", 123}, "val"), values: makeKV(struct { F1 string F2 int }{"value", 456}, "val"), args: makeKV(struct { F1 string F2 int }{"arg", 789}, "val"), expectKV: `""="val" ""="val" ""="val"`, expectJSON: `{"":"val","":"val","":"val"}`, }, { name: "json rendering with json.RawMessage", args: makeKV("key", raw), expectKV: `"key"={"message"=[123 34 105 110 116 49 34 58 48 44 34 45 34 58 48 44 34 73 110 116 53 34 58 48 125]}`, expectJSON: `{"key":{"message":{"int1":0,"-":0,"Int5":0}}}`, }, { name: "byte array not json.RawMessage", args: makeKV("key", []byte{1, 2, 3, 4}), expectKV: `"key"=[1 2 3 4]`, expectJSON: `{"key":[1,2,3,4]}`, }, { name: "json rendering with empty json.RawMessage", args: makeKV("key", &Trawjson{}), expectKV: `"key"={"message"=[]}`, expectJSON: `{"key":{"message":null}}`, }} for _, tc := range testCases { t.Run(tc.name, func(t *testing.T) { test := func(t *testing.T, formatter Formatter, expect string) { formatter.AddValues(tc.values) r := formatter.render(tc.builtins, tc.args) if r != expect { t.Errorf("wrong output:\nexpected %q\n got %q", expect, r) } } t.Run("KV", func(t *testing.T) { test(t, NewFormatter(Options{}), tc.expectKV) }) t.Run("JSON", func(t *testing.T) { test(t, NewFormatterJSON(Options{}), tc.expectJSON) }) }) } } func TestSanitize(t *testing.T) { testCases := []struct { name string kv []any expect []any }{{ name: "empty", kv: []any{}, expect: []any{}, }, { name: "already sane", kv: makeKV("int", 1, "str", "ABC", "bool", true), expect: makeKV("int", 1, "str", "ABC", "bool", true), }, { name: "missing value", kv: makeKV("key"), expect: makeKV("key", ""), }, { name: "non-string key int", kv: makeKV(123, "val"), expect: makeKV("", "val"), }, { name: "non-string key struct", kv: makeKV(struct { F1 string F2 int }{"f1", 8675309}, "val"), expect: makeKV(``, "val"), }} f := NewFormatterJSON(Options{}) for _, tc := range testCases { t.Run(tc.name, func(t *testing.T) { r := f.sanitize(tc.kv) if !reflect.DeepEqual(r, tc.expect) { t.Errorf("wrong output:\nexpected %q\n got %q", tc.expect, r) } }) } } func TestEnabled(t *testing.T) { t.Run("default V", func(t *testing.T) { log := newSink(func(_, _ string) {}, NewFormatter(Options{})) if !log.Enabled(0) { t.Errorf("expected true") } if log.Enabled(1) { t.Errorf("expected false") } }) t.Run("V=9", func(t *testing.T) { log := newSink(func(_, _ string) {}, NewFormatter(Options{Verbosity: 9})) if !log.Enabled(8) { t.Errorf("expected true") } if !log.Enabled(9) { t.Errorf("expected true") } if log.Enabled(10) { t.Errorf("expected false") } }) } type capture struct { log string } func (c *capture) Func(prefix, args string) { space := " " if len(prefix) == 0 { space = "" } c.log = prefix + space + args } func TestInfo(t *testing.T) { testCases := []struct { name string args []any expectKV string expectJSON string }{{ name: "just msg", args: makeKV(), expectKV: `"level"=0 "msg"="msg"`, expectJSON: `{"logger":"","level":0,"msg":"msg"}`, }, { name: "primitives", args: makeKV("int", 1, "str", "ABC", "bool", true), expectKV: `"level"=0 "msg"="msg" "int"=1 "str"="ABC" "bool"=true`, expectJSON: `{"logger":"","level":0,"msg":"msg","int":1,"str":"ABC","bool":true}`, }} for _, tc := range testCases { t.Run("KV: "+tc.name, func(t *testing.T) { capt := &capture{} sink := newSink(capt.Func, NewFormatter(Options{})) sink.Info(0, "msg", tc.args...) if capt.log != tc.expectKV { t.Errorf("\nexpected %q\n got %q", tc.expectKV, capt.log) } }) t.Run("JSON: "+tc.name, func(t *testing.T) { capt := &capture{} sink := newSink(capt.Func, NewFormatterJSON(Options{})) sink.Info(0, "msg", tc.args...) if capt.log != tc.expectJSON { t.Errorf("\nexpected %q\n got %q", tc.expectJSON, capt.log) } }) } } func TestInfoWithCaller(t *testing.T) { t.Run("KV: LogCaller=All", func(t *testing.T) { capt := &capture{} sink := newSink(capt.Func, NewFormatter(Options{LogCaller: All})) sink.Info(0, "msg") _, file, line, _ := runtime.Caller(0) expect := fmt.Sprintf(`"caller"={"file"=%q "line"=%d} "level"=0 "msg"="msg"`, filepath.Base(file), line-1) if capt.log != expect { t.Errorf("\nexpected %q\n got %q", expect, capt.log) } sink.Error(fmt.Errorf("error"), "msg") _, file, line, _ = runtime.Caller(0) expect = fmt.Sprintf(`"caller"={"file"=%q "line"=%d} "msg"="msg" "error"="error"`, filepath.Base(file), line-1) if capt.log != expect { t.Errorf("\nexpected %q\n got %q", expect, capt.log) } }) t.Run("JSON: LogCaller=All", func(t *testing.T) { capt := &capture{} sink := newSink(capt.Func, NewFormatterJSON(Options{LogCaller: All})) sink.Info(0, "msg") _, file, line, _ := runtime.Caller(0) expect := fmt.Sprintf(`{"logger":"","caller":{"file":%q,"line":%d},"level":0,"msg":"msg"}`, filepath.Base(file), line-1) if capt.log != expect { t.Errorf("\nexpected %q\n got %q", expect, capt.log) } sink.Error(fmt.Errorf("error"), "msg") _, file, line, _ = runtime.Caller(0) expect = fmt.Sprintf(`{"logger":"","caller":{"file":%q,"line":%d},"msg":"msg","error":"error"}`, filepath.Base(file), line-1) if capt.log != expect { t.Errorf("\nexpected %q\n got %q", expect, capt.log) } }) t.Run("KV: LogCaller=All, LogCallerFunc=true", func(t *testing.T) { thisFunc := "github.com/go-logr/logr/funcr.TestInfoWithCaller.func3" capt := &capture{} sink := newSink(capt.Func, NewFormatter(Options{LogCaller: All, LogCallerFunc: true})) sink.Info(0, "msg") _, file, line, _ := runtime.Caller(0) expect := fmt.Sprintf(`"caller"={"file"=%q "line"=%d "function"=%q} "level"=0 "msg"="msg"`, filepath.Base(file), line-1, thisFunc) if capt.log != expect { t.Errorf("\nexpected %q\n got %q", expect, capt.log) } sink.Error(fmt.Errorf("error"), "msg") _, file, line, _ = runtime.Caller(0) expect = fmt.Sprintf(`"caller"={"file"=%q "line"=%d "function"=%q} "msg"="msg" "error"="error"`, filepath.Base(file), line-1, thisFunc) if capt.log != expect { t.Errorf("\nexpected %q\n got %q", expect, capt.log) } }) t.Run("JSON: LogCaller=All, LogCallerFunc=true", func(t *testing.T) { thisFunc := "github.com/go-logr/logr/funcr.TestInfoWithCaller.func4" capt := &capture{} sink := newSink(capt.Func, NewFormatterJSON(Options{LogCaller: All, LogCallerFunc: true})) sink.Info(0, "msg") _, file, line, _ := runtime.Caller(0) expect := fmt.Sprintf(`{"logger":"","caller":{"file":%q,"line":%d,"function":%q},"level":0,"msg":"msg"}`, filepath.Base(file), line-1, thisFunc) if capt.log != expect { t.Errorf("\nexpected %q\n got %q", expect, capt.log) } sink.Error(fmt.Errorf("error"), "msg") _, file, line, _ = runtime.Caller(0) expect = fmt.Sprintf(`{"logger":"","caller":{"file":%q,"line":%d,"function":%q},"msg":"msg","error":"error"}`, filepath.Base(file), line-1, thisFunc) if capt.log != expect { t.Errorf("\nexpected %q\n got %q", expect, capt.log) } }) t.Run("LogCaller=Info", func(t *testing.T) { capt := &capture{} sink := newSink(capt.Func, NewFormatter(Options{LogCaller: Info})) sink.Info(0, "msg") _, file, line, _ := runtime.Caller(0) expect := fmt.Sprintf(`"caller"={"file"=%q "line"=%d} "level"=0 "msg"="msg"`, filepath.Base(file), line-1) if capt.log != expect { t.Errorf("\nexpected %q\n got %q", expect, capt.log) } sink.Error(fmt.Errorf("error"), "msg") expect = `"msg"="msg" "error"="error"` if capt.log != expect { t.Errorf("\nexpected %q\n got %q", expect, capt.log) } }) t.Run("LogCaller=Error", func(t *testing.T) { capt := &capture{} sink := newSink(capt.Func, NewFormatter(Options{LogCaller: Error})) sink.Info(0, "msg") expect := `"level"=0 "msg"="msg"` if capt.log != expect { t.Errorf("\nexpected %q\n got %q", expect, capt.log) } sink.Error(fmt.Errorf("error"), "msg") _, file, line, _ := runtime.Caller(0) expect = fmt.Sprintf(`"caller"={"file"=%q "line"=%d} "msg"="msg" "error"="error"`, filepath.Base(file), line-1) if capt.log != expect { t.Errorf("\nexpected %q\n got %q", expect, capt.log) } }) t.Run("LogCaller=None", func(t *testing.T) { capt := &capture{} sink := newSink(capt.Func, NewFormatter(Options{LogCaller: None})) sink.Info(0, "msg") expect := `"level"=0 "msg"="msg"` if capt.log != expect { t.Errorf("\nexpected %q\n got %q", expect, capt.log) } sink.Error(fmt.Errorf("error"), "msg") expect = `"msg"="msg" "error"="error"` if capt.log != expect { t.Errorf("\nexpected %q\n got %q", expect, capt.log) } }) } func TestError(t *testing.T) { testCases := []struct { name string args []any expectKV string expectJSON string }{{ name: "just msg", args: makeKV(), expectKV: `"msg"="msg" "error"="err"`, expectJSON: `{"logger":"","msg":"msg","error":"err"}`, }, { name: "primitives", args: makeKV("int", 1, "str", "ABC", "bool", true), expectKV: `"msg"="msg" "error"="err" "int"=1 "str"="ABC" "bool"=true`, expectJSON: `{"logger":"","msg":"msg","error":"err","int":1,"str":"ABC","bool":true}`, }} for _, tc := range testCases { t.Run("KV: "+tc.name, func(t *testing.T) { capt := &capture{} sink := newSink(capt.Func, NewFormatter(Options{})) sink.Error(fmt.Errorf("err"), "msg", tc.args...) if capt.log != tc.expectKV { t.Errorf("\nexpected %q\n got %q", tc.expectKV, capt.log) } }) t.Run("JSON: "+tc.name, func(t *testing.T) { capt := &capture{} sink := newSink(capt.Func, NewFormatterJSON(Options{})) sink.Error(fmt.Errorf("err"), "msg", tc.args...) if capt.log != tc.expectJSON { t.Errorf("\nexpected %q\n got %q", tc.expectJSON, capt.log) } }) } } func TestErrorWithCaller(t *testing.T) { t.Run("KV: LogCaller=All", func(t *testing.T) { capt := &capture{} sink := newSink(capt.Func, NewFormatter(Options{LogCaller: All})) sink.Error(fmt.Errorf("err"), "msg") _, file, line, _ := runtime.Caller(0) expect := fmt.Sprintf(`"caller"={"file"=%q "line"=%d} "msg"="msg" "error"="err"`, filepath.Base(file), line-1) if capt.log != expect { t.Errorf("\nexpected %q\n got %q", expect, capt.log) } }) t.Run("JSON: LogCaller=All", func(t *testing.T) { capt := &capture{} sink := newSink(capt.Func, NewFormatterJSON(Options{LogCaller: All})) sink.Error(fmt.Errorf("err"), "msg") _, file, line, _ := runtime.Caller(0) expect := fmt.Sprintf(`{"logger":"","caller":{"file":%q,"line":%d},"msg":"msg","error":"err"}`, filepath.Base(file), line-1) if capt.log != expect { t.Errorf("\nexpected %q\n got %q", expect, capt.log) } }) t.Run("LogCaller=Error", func(t *testing.T) { capt := &capture{} sink := newSink(capt.Func, NewFormatter(Options{LogCaller: Error})) sink.Error(fmt.Errorf("err"), "msg") _, file, line, _ := runtime.Caller(0) expect := fmt.Sprintf(`"caller"={"file"=%q "line"=%d} "msg"="msg" "error"="err"`, filepath.Base(file), line-1) if capt.log != expect { t.Errorf("\nexpected %q\n got %q", expect, capt.log) } }) t.Run("LogCaller=Info", func(t *testing.T) { capt := &capture{} sink := newSink(capt.Func, NewFormatter(Options{LogCaller: Info})) sink.Error(fmt.Errorf("err"), "msg") expect := `"msg"="msg" "error"="err"` if capt.log != expect { t.Errorf("\nexpected %q\n got %q", expect, capt.log) } }) t.Run("LogCaller=None", func(t *testing.T) { capt := &capture{} sink := newSink(capt.Func, NewFormatter(Options{LogCaller: None})) sink.Error(fmt.Errorf("err"), "msg") expect := `"msg"="msg" "error"="err"` if capt.log != expect { t.Errorf("\nexpected %q\n got %q", expect, capt.log) } }) } func TestInfoWithName(t *testing.T) { testCases := []struct { name string names []string args []any expectKV string expectJSON string }{{ name: "one", names: []string{"pfx1"}, args: makeKV("k", "v"), expectKV: `pfx1 "level"=0 "msg"="msg" "k"="v"`, expectJSON: `{"logger":"pfx1","level":0,"msg":"msg","k":"v"}`, }, { name: "two", names: []string{"pfx1", "pfx2"}, args: makeKV("k", "v"), expectKV: `pfx1/pfx2 "level"=0 "msg"="msg" "k"="v"`, expectJSON: `{"logger":"pfx1/pfx2","level":0,"msg":"msg","k":"v"}`, }} for _, tc := range testCases { t.Run("KV: "+tc.name, func(t *testing.T) { capt := &capture{} sink := newSink(capt.Func, NewFormatter(Options{})) for _, n := range tc.names { sink = sink.WithName(n) } sink.Info(0, "msg", tc.args...) if capt.log != tc.expectKV { t.Errorf("\nexpected %q\n got %q", tc.expectKV, capt.log) } }) t.Run("JSON: "+tc.name, func(t *testing.T) { capt := &capture{} sink := newSink(capt.Func, NewFormatterJSON(Options{})) for _, n := range tc.names { sink = sink.WithName(n) } sink.Info(0, "msg", tc.args...) if capt.log != tc.expectJSON { t.Errorf("\nexpected %q\n got %q", tc.expectJSON, capt.log) } }) } } func TestErrorWithName(t *testing.T) { testCases := []struct { name string names []string args []any expectKV string expectJSON string }{{ name: "one", names: []string{"pfx1"}, args: makeKV("k", "v"), expectKV: `pfx1 "msg"="msg" "error"="err" "k"="v"`, expectJSON: `{"logger":"pfx1","msg":"msg","error":"err","k":"v"}`, }, { name: "two", names: []string{"pfx1", "pfx2"}, args: makeKV("k", "v"), expectKV: `pfx1/pfx2 "msg"="msg" "error"="err" "k"="v"`, expectJSON: `{"logger":"pfx1/pfx2","msg":"msg","error":"err","k":"v"}`, }} for _, tc := range testCases { t.Run("KV: "+tc.name, func(t *testing.T) { capt := &capture{} sink := newSink(capt.Func, NewFormatter(Options{})) for _, n := range tc.names { sink = sink.WithName(n) } sink.Error(fmt.Errorf("err"), "msg", tc.args...) if capt.log != tc.expectKV { t.Errorf("\nexpected %q\n got %q", tc.expectKV, capt.log) } }) t.Run("JSON: "+tc.name, func(t *testing.T) { capt := &capture{} sink := newSink(capt.Func, NewFormatterJSON(Options{})) for _, n := range tc.names { sink = sink.WithName(n) } sink.Error(fmt.Errorf("err"), "msg", tc.args...) if capt.log != tc.expectJSON { t.Errorf("\nexpected %q\n got %q", tc.expectJSON, capt.log) } }) } } func TestInfoWithValues(t *testing.T) { testCases := []struct { name string values []any args []any expectKV string expectJSON string }{{ name: "zero", values: makeKV(), args: makeKV("k", "v"), expectKV: `"level"=0 "msg"="msg" "k"="v"`, expectJSON: `{"logger":"","level":0,"msg":"msg","k":"v"}`, }, { name: "one", values: makeKV("one", 1), args: makeKV("k", "v"), expectKV: `"level"=0 "msg"="msg" "one"=1 "k"="v"`, expectJSON: `{"logger":"","level":0,"msg":"msg","one":1,"k":"v"}`, }, { name: "two", values: makeKV("one", 1, "two", 2), args: makeKV("k", "v"), expectKV: `"level"=0 "msg"="msg" "one"=1 "two"=2 "k"="v"`, expectJSON: `{"logger":"","level":0,"msg":"msg","one":1,"two":2,"k":"v"}`, }, { name: "dangling", values: makeKV("dangling"), args: makeKV("k", "v"), expectKV: `"level"=0 "msg"="msg" "dangling"="" "k"="v"`, expectJSON: `{"logger":"","level":0,"msg":"msg","dangling":"","k":"v"}`, }} for _, tc := range testCases { t.Run("KV: "+tc.name, func(t *testing.T) { capt := &capture{} sink := newSink(capt.Func, NewFormatter(Options{})) sink = sink.WithValues(tc.values...) sink.Info(0, "msg", tc.args...) if capt.log != tc.expectKV { t.Errorf("\nexpected %q\n got %q", tc.expectKV, capt.log) } }) t.Run("JSON: "+tc.name, func(t *testing.T) { capt := &capture{} sink := newSink(capt.Func, NewFormatterJSON(Options{})) sink = sink.WithValues(tc.values...) sink.Info(0, "msg", tc.args...) if capt.log != tc.expectJSON { t.Errorf("\nexpected %q\n got %q", tc.expectJSON, capt.log) } }) } } func TestErrorWithValues(t *testing.T) { testCases := []struct { name string values []any args []any expectKV string expectJSON string }{{ name: "zero", values: makeKV(), args: makeKV("k", "v"), expectKV: `"msg"="msg" "error"="err" "k"="v"`, expectJSON: `{"logger":"","msg":"msg","error":"err","k":"v"}`, }, { name: "one", values: makeKV("one", 1), args: makeKV("k", "v"), expectKV: `"msg"="msg" "error"="err" "one"=1 "k"="v"`, expectJSON: `{"logger":"","msg":"msg","error":"err","one":1,"k":"v"}`, }, { name: "two", values: makeKV("one", 1, "two", 2), args: makeKV("k", "v"), expectKV: `"msg"="msg" "error"="err" "one"=1 "two"=2 "k"="v"`, expectJSON: `{"logger":"","msg":"msg","error":"err","one":1,"two":2,"k":"v"}`, }, { name: "dangling", values: makeKV("dangling"), args: makeKV("k", "v"), expectKV: `"msg"="msg" "error"="err" "dangling"="" "k"="v"`, expectJSON: `{"logger":"","msg":"msg","error":"err","dangling":"","k":"v"}`, }} for _, tc := range testCases { t.Run("KV: "+tc.name, func(t *testing.T) { capt := &capture{} sink := newSink(capt.Func, NewFormatter(Options{})) sink = sink.WithValues(tc.values...) sink.Error(fmt.Errorf("err"), "msg", tc.args...) if capt.log != tc.expectKV { t.Errorf("\nexpected %q\n got %q", tc.expectKV, capt.log) } }) t.Run("JSON: "+tc.name, func(t *testing.T) { capt := &capture{} sink := newSink(capt.Func, NewFormatterJSON(Options{})) sink = sink.WithValues(tc.values...) sink.Error(fmt.Errorf("err"), "msg", tc.args...) if capt.log != tc.expectJSON { t.Errorf("\nexpected %q\n got %q", tc.expectJSON, capt.log) } }) } } func TestInfoWithCallDepth(t *testing.T) { t.Run("one", func(t *testing.T) { capt := &capture{} sink := newSink(capt.Func, NewFormatter(Options{LogCaller: All})) dSink, _ := sink.(logr.CallDepthLogSink) sink = dSink.WithCallDepth(1) sink.Info(0, "msg") _, file, line, _ := runtime.Caller(1) expect := fmt.Sprintf(`"caller"={"file"=%q "line"=%d} "level"=0 "msg"="msg"`, filepath.Base(file), line) if capt.log != expect { t.Errorf("\nexpected %q\n got %q", expect, capt.log) } }) } func TestErrorWithCallDepth(t *testing.T) { t.Run("one", func(t *testing.T) { capt := &capture{} sink := newSink(capt.Func, NewFormatter(Options{LogCaller: All})) dSink, _ := sink.(logr.CallDepthLogSink) sink = dSink.WithCallDepth(1) sink.Error(fmt.Errorf("err"), "msg") _, file, line, _ := runtime.Caller(1) expect := fmt.Sprintf(`"caller"={"file"=%q "line"=%d} "msg"="msg" "error"="err"`, filepath.Base(file), line) if capt.log != expect { t.Errorf("\nexpected %q\n got %q", expect, capt.log) } }) } func TestOptionsTimestampFormat(t *testing.T) { capt := &capture{} // This timestamp format contains none of the characters that are // considered placeholders, so will produce a constant result. sink := newSink(capt.Func, NewFormatter(Options{LogTimestamp: true, TimestampFormat: "TIMESTAMP"})) dSink, _ := sink.(logr.CallDepthLogSink) sink = dSink.WithCallDepth(1) sink.Info(0, "msg") expect := `"ts"="TIMESTAMP" "level"=0 "msg"="msg"` if capt.log != expect { t.Errorf("\nexpected %q\n got %q", expect, capt.log) } } func TestOptionsLogInfoLevel(t *testing.T) { testCases := []struct { name string level *string expect string }{ { name: "custom key", level: ptrstr("info_level"), expect: `"info_level"=0 "msg"="msg"`, }, { name: "no level", level: ptrstr(""), expect: `"msg"="msg"`, }, { name: "default", level: nil, expect: `"level"=0 "msg"="msg"`, }, } for _, tc := range testCases { t.Run("Run: "+tc.name, func(t *testing.T) { capt := &capture{} sink := newSink(capt.Func, NewFormatter(Options{LogInfoLevel: tc.level})) dSink, _ := sink.(logr.CallDepthLogSink) sink = dSink.WithCallDepth(1) sink.Info(0, "msg") if capt.log != tc.expect { t.Errorf("\nexpected %q\n got %q", tc.expect, capt.log) } }) } }