logger_loc_test.go

// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: MIT

package hclog

import (
	"bytes"
	"fmt"
	"runtime"
	"strings"
	"testing"

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

// This file contains tests that are sensitive to their location in the file,
// because they contain line numbers. They're basically "quarantined" from the
// other tests because they break all the time when new tests are added.

func TestLoggerLoc(t *testing.T) {
	t.Run("includes the caller location", func(t *testing.T) {
		var buf bytes.Buffer

		logger := New(&LoggerOptions{
			Name:            "test",
			Output:          &buf,
			IncludeLocation: true,
		})

		_, _, line, _ := runtime.Caller(0)

		logger.Info("this is test", "who", "programmer", "why", "testing is fun")

		str := buf.String()
		dataIdx := strings.IndexByte(str, ' ')
		rest := str[dataIdx+1:]

		assert.Equal(t,
			fmt.Sprintf(
				"[INFO]  go-hclog/logger_loc_test.go:%d: test: this is test: who=programmer why=\"testing is fun\"\n",
				line+2),
			rest)
	})

	t.Run("includes the caller location excluding helper functions", func(t *testing.T) {
		var buf bytes.Buffer

		logMe := func(l Logger) {
			l.Info("this is test", "who", "programmer", "why", "testing is fun")
		}

		logger := New(&LoggerOptions{
			Name:                     "test",
			Output:                   &buf,
			IncludeLocation:          true,
			AdditionalLocationOffset: 1,
		})

		_, _, line, _ := runtime.Caller(0)

		logMe(logger)

		str := buf.String()
		dataIdx := strings.IndexByte(str, ' ')
		rest := str[dataIdx+1:]

		assert.Equal(t,
			fmt.Sprintf(
				"[INFO]  go-hclog/logger_loc_test.go:%d: test: this is test: who=programmer why=\"testing is fun\"\n",
				line+2,
			),
			rest)
	})

}