Skip to content

Commit

Permalink
Add function to convert []Field to map[string]interface{}
Browse files Browse the repository at this point in the history
Tests often care about specific fields, or want fields without worrying
about order, or marshalling objects etc. It makes more sense for tests
to compare a fields `map[string]interface{}` rather than `[]zap.Field`
  • Loading branch information
prashantv committed Aug 15, 2017
1 parent e68420e commit 83a3834
Show file tree
Hide file tree
Showing 2 changed files with 118 additions and 0 deletions.
32 changes: 32 additions & 0 deletions zaptest/observer/fields.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
// Copyright (c) 2017 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

package observer

import "go.uber.org/zap/zapcore"

// FieldsMap takes a list of fields and converts it to a map.
func FieldsMap(fields []zapcore.Field) map[string]interface{} {
encoder := zapcore.NewMapObjectEncoder()
for _, f := range fields {
f.AddTo(encoder)
}
return encoder.Fields
}
86 changes: 86 additions & 0 deletions zaptest/observer/fields_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
// Copyright (c) 2017 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

package observer

import (
"testing"

"go.uber.org/zap"
"go.uber.org/zap/zapcore"

"github.com/stretchr/testify/assert"
)

func TestFieldsMap(t *testing.T) {
tests := []struct {
msg string
fields []zapcore.Field
want map[string]interface{}
}{
{
msg: "no fields",
fields: nil,
want: map[string]interface{}{},
},
{
msg: "simple",
fields: []zapcore.Field{
zap.String("k1", "v"),
zap.Int64("k2", 10),
},
want: map[string]interface{}{
"k1": "v",
"k2": int64(10),
},
},
{
msg: "overwrite",
fields: []zapcore.Field{
zap.String("k1", "v1"),
zap.String("k1", "v2"),
},
want: map[string]interface{}{
"k1": "v2",
},
},
{
msg: "nested",
fields: []zapcore.Field{
zap.String("k1", "v1"),
zap.Namespace("nested"),
zap.String("k2", "v2"),
},
want: map[string]interface{}{
"k1": "v1",
"nested": map[string]interface{}{
"k2": "v2",
},
},
},
}

for _, tt := range tests {
t.Run(tt.msg, func(t *testing.T) {
assert.Equal(t, tt.want, FieldsMap(tt.fields))

})
}
}

0 comments on commit 83a3834

Please # to comment.