json_test.go

package formatter_test

import (
	"errors"
	"fmt"
	"github.com/valyala/bytebufferpool"
	"testing"
	"time"

	"github.com/gol4ng/logger"
	"github.com/gol4ng/logger/formatter"
	"github.com/stretchr/testify/assert"
)

func TestJson_Format(t *testing.T) {
	tests := []struct {
		name     string
		entry    logger.Entry
		expected string
	}{
		{
			name:     "test simple message without context",
			entry:    logger.Entry{Message: "test message", Level: logger.DebugLevel, Context: nil},
			expected: `{"Message":"test message","Level":7,"Context":null}`,
		},
		{
			name:     "test simple message with context",
			entry:    logger.Entry{Message: "test message", Level: logger.WarningLevel, Context: logger.NewContext().Add("my_key", "my_value")},
			expected: `{"Message":"test message","Level":4,"Context":{"my_key":"my_value"}}`,
		},
	}

	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			f := formatter.NewJSONEncoder()

			assert.Equal(t, tt.expected, f.Format(tt.entry))
		})
	}
}

func TestMarshalContextTo(t *testing.T) {
	tests := []struct {
		name            string
		context         *logger.Context
		expectedStrings []string
	}{
		{
			name:            "test simple message without context",
			context:         nil,
			expectedStrings: []string{"null"},
		},
		{
			name:            "test simple message with context",
			context:         logger.NewContext().Add("my_key", "my_value"),
			expectedStrings: []string{`{"my_key":"my_value"}`},
		},
		{
			name:            "test multiple message with context",
			context:         logger.NewContext().Add("my_key", "my_value").Add("my_key2", "my_value2"),
			expectedStrings: []string{`my_key":"my_value"`, `"my_key2":"my_value2"`},
		},
		{
			name:            "test time message with context",
			context:         logger.NewContext().Add("my_key", time.Date(2020, 1, 2, 3, 4, 5, 6, time.UTC)),
			expectedStrings: []string{`my_key":"2020-01-02T03:04:05.000000006Z"`},
		},
		{
			name:            "test time message with context",
			context:         logger.NewContext().Add("my_key", errors.New("my error message")),
			expectedStrings: []string{`my_key":"my error message"`},
		},
	}

	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			byteBuffer := bytebufferpool.Get()
			defer bytebufferpool.Put(byteBuffer)

			formatter.ContextToJSON(tt.context, byteBuffer)
			str := byteBuffer.String()
			for _, s := range tt.expectedStrings {
				assert.Contains(t, str, s)
			}
		})
	}
}

// =====================================================================================================================
// ================================================= EXAMPLES ==========================================================
// =====================================================================================================================

func ExampleJsonFormatter() {
	jsonFormatter := formatter.NewJSONEncoder()

	fmt.Println(jsonFormatter.Format(
		logger.Entry{
			Message: "My log message",
			Level:   logger.InfoLevel,
			Context: logger.NewContext().Add("my_key", "my_value"),
		},
	))
	//Output:
	//{"Message":"My log message","Level":6,"Context":{"my_key":"my_value"}}
}