12 "github.com/go-logfmt/logfmt"
15 func TestEncodeKeyval(t *testing.T) {
17 key, value interface{}
21 {key: "k", value: "v", want: "k=v"},
22 {key: "k", value: nil, want: "k=null"},
23 {key: `\`, value: "v", want: `\=v`},
24 {key: "k", value: "", want: "k="},
25 {key: "k", value: "null", want: `k="null"`},
26 {key: "k", value: "<nil>", want: `k=<nil>`},
27 {key: "k", value: true, want: "k=true"},
28 {key: "k", value: 1, want: "k=1"},
29 {key: "k", value: 1.025, want: "k=1.025"},
30 {key: "k", value: 1e-3, want: "k=0.001"},
31 {key: "k", value: 3.5 + 2i, want: "k=(3.5+2i)"},
32 {key: "k", value: "v v", want: `k="v v"`},
33 {key: "k", value: " ", want: `k=" "`},
34 {key: "k", value: `"`, want: `k="\""`},
35 {key: "k", value: `=`, want: `k="="`},
36 {key: "k", value: `\`, want: `k=\`},
37 {key: "k", value: `=\`, want: `k="=\\"`},
38 {key: "k", value: `\"`, want: `k="\\\""`},
39 {key: "k", value: [2]int{2, 19}, err: logfmt.ErrUnsupportedValueType},
40 {key: "k", value: []string{"e1", "e 2"}, err: logfmt.ErrUnsupportedValueType},
41 {key: "k", value: structData{"a a", 9}, err: logfmt.ErrUnsupportedValueType},
42 {key: "k", value: decimalMarshaler{5, 9}, want: "k=5.9"},
43 {key: "k", value: (*decimalMarshaler)(nil), want: "k=null"},
44 {key: "k", value: decimalStringer{5, 9}, want: "k=5.9"},
45 {key: "k", value: (*decimalStringer)(nil), want: "k=null"},
46 {key: "k", value: marshalerStringer{5, 9}, want: "k=5.9"},
47 {key: "k", value: (*marshalerStringer)(nil), want: "k=null"},
48 {key: "k", value: new(nilMarshaler), want: "k=notnilmarshaler"},
49 {key: "k", value: (*nilMarshaler)(nil), want: "k=nilmarshaler"},
50 {key: (*marshalerStringer)(nil), value: "v", err: logfmt.ErrNilKey},
51 {key: decimalMarshaler{5, 9}, value: "v", want: "5.9=v"},
52 {key: (*decimalMarshaler)(nil), value: "v", err: logfmt.ErrNilKey},
53 {key: decimalStringer{5, 9}, value: "v", want: "5.9=v"},
54 {key: (*decimalStringer)(nil), value: "v", err: logfmt.ErrNilKey},
55 {key: marshalerStringer{5, 9}, value: "v", want: "5.9=v"},
56 {key: "k", value: "\xbd", want: `k="\ufffd"`},
57 {key: "k", value: "\ufffd\x00", want: `k="\ufffd\u0000"`},
58 {key: "k", value: "\ufffd", want: `k="\ufffd"`},
59 {key: "k", value: []byte("\ufffd\x00"), want: `k="\ufffd\u0000"`},
60 {key: "k", value: []byte("\ufffd"), want: `k="\ufffd"`},
63 for _, d := range data {
65 enc := logfmt.NewEncoder(w)
66 err := enc.EncodeKeyval(d.key, d.value)
68 t.Errorf("%#v, %#v: got error: %v, want error: %v", d.key, d.value, err, d.err)
70 if got, want := w.String(), d.want; got != want {
71 t.Errorf("%#v, %#v: got '%s', want '%s'", d.key, d.value, got, want)
76 func TestMarshalKeyvals(t *testing.T) {
87 {in: kv(), want: nil},
88 {in: kv(nil, "v"), err: logfmt.ErrNilKey},
89 {in: kv(nilPtr, "v"), err: logfmt.ErrNilKey},
90 {in: kv("\ufffd"), err: logfmt.ErrInvalidKey},
91 {in: kv("\xbd"), err: logfmt.ErrInvalidKey},
92 {in: kv("k"), want: []byte("k=null")},
93 {in: kv("k", nil), want: []byte("k=null")},
94 {in: kv("k", ""), want: []byte("k=")},
95 {in: kv("k", "null"), want: []byte(`k="null"`)},
96 {in: kv("k", "v"), want: []byte("k=v")},
97 {in: kv("k", true), want: []byte("k=true")},
98 {in: kv("k", 1), want: []byte("k=1")},
99 {in: kv("k", ptr), want: []byte("k=1")},
100 {in: kv("k", nilPtr), want: []byte("k=null")},
101 {in: kv("k", 1.025), want: []byte("k=1.025")},
102 {in: kv("k", 1e-3), want: []byte("k=0.001")},
103 {in: kv("k", "v v"), want: []byte(`k="v v"`)},
104 {in: kv("k", `"`), want: []byte(`k="\""`)},
105 {in: kv("k", `=`), want: []byte(`k="="`)},
106 {in: kv("k", `\`), want: []byte(`k=\`)},
107 {in: kv("k", `=\`), want: []byte(`k="=\\"`)},
108 {in: kv("k", `\"`), want: []byte(`k="\\\""`)},
109 {in: kv("k1", "v1", "k2", "v2"), want: []byte("k1=v1 k2=v2")},
110 {in: kv("k1", "v1", "k2", [2]int{}), want: []byte("k1=v1 k2=\"unsupported value type\"")},
111 {in: kv([2]int{}, "v1", "k2", "v2"), want: []byte("k2=v2")},
112 {in: kv("k", time.Date(2009, time.November, 10, 23, 0, 0, 0, time.UTC)), want: []byte("k=2009-11-10T23:00:00Z")},
113 {in: kv("k", errorMarshaler{}), want: []byte("k=\"error marshaling value of type logfmt_test.errorMarshaler: marshal error\"")},
114 {in: kv("k", decimalMarshaler{5, 9}), want: []byte("k=5.9")},
115 {in: kv("k", (*decimalMarshaler)(nil)), want: []byte("k=null")},
116 {in: kv("k", decimalStringer{5, 9}), want: []byte("k=5.9")},
117 {in: kv("k", (*decimalStringer)(nil)), want: []byte("k=null")},
118 {in: kv("k", marshalerStringer{5, 9}), want: []byte("k=5.9")},
119 {in: kv("k", (*marshalerStringer)(nil)), want: []byte("k=null")},
120 {in: kv(one, "v"), want: []byte("1=v")},
121 {in: kv(ptr, "v"), want: []byte("1=v")},
122 {in: kv((*marshalerStringer)(nil), "v"), err: logfmt.ErrNilKey},
123 {in: kv(decimalMarshaler{5, 9}, "v"), want: []byte("5.9=v")},
124 {in: kv((*decimalMarshaler)(nil), "v"), err: logfmt.ErrNilKey},
125 {in: kv(decimalStringer{5, 9}, "v"), want: []byte("5.9=v")},
126 {in: kv((*decimalStringer)(nil), "v"), err: logfmt.ErrNilKey},
127 {in: kv(marshalerStringer{5, 9}, "v"), want: []byte("5.9=v")},
130 for _, d := range data {
131 got, err := logfmt.MarshalKeyvals(d.in...)
133 t.Errorf("%#v: got error: %v, want error: %v", d.in, err, d.err)
135 if !reflect.DeepEqual(got, d.want) {
136 t.Errorf("%#v: got '%s', want '%s'", d.in, got, d.want)
141 func kv(keyvals ...interface{}) []interface{} {
145 type structData struct {
146 A string `logfmt:"fieldA"`
150 type nilMarshaler int
152 func (m *nilMarshaler) MarshalText() ([]byte, error) {
154 return []byte("nilmarshaler"), nil
156 return []byte("notnilmarshaler"), nil
159 type decimalMarshaler struct {
163 func (t decimalMarshaler) MarshalText() ([]byte, error) {
164 buf := &bytes.Buffer{}
165 fmt.Fprintf(buf, "%d.%d", t.a, t.b)
166 return buf.Bytes(), nil
169 type decimalStringer struct {
173 func (s decimalStringer) String() string {
174 return fmt.Sprintf("%d.%d", s.a, s.b)
177 type marshalerStringer struct {
181 func (t marshalerStringer) MarshalText() ([]byte, error) {
182 buf := &bytes.Buffer{}
183 fmt.Fprintf(buf, "%d.%d", t.a, t.b)
184 return buf.Bytes(), nil
187 func (t marshalerStringer) String() string {
188 return fmt.Sprint(t.a + t.b)
191 var errMarshal = errors.New("marshal error")
193 type errorMarshaler struct{}
195 func (errorMarshaler) MarshalText() ([]byte, error) {
196 return nil, errMarshal
199 func BenchmarkEncodeKeyval(b *testing.B) {
201 enc := logfmt.NewEncoder(ioutil.Discard)
202 for i := 0; i < b.N; i++ {
203 enc.EncodeKeyval("sk", "10")
204 enc.EncodeKeyval("some-key", "a rather long string with spaces")