pkg/debuglog/formatter_test.go - develop - wax_boy/semaphore_custom

pkg/debuglog/formatter_test.go
89 строк3 KB
Denis Gukov
feat(logs): add debug filters (#3924)
07 июн 2026, 22:57
07 июн 2026, 22:573f03b96
package debuglog

import (
	"bytes"
	"testing"

	log "github.com/sirupsen/logrus"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
)

// newTestLogger returns a logrus logger wired with the FilteringFormatter at
// DEBUG level, writing into the returned buffer.
func newTestLogger(spec string) (*log.Logger, *bytes.Buffer) {
	buf := &bytes.Buffer{}
	logger := log.New()
	logger.SetOutput(buf)
	logger.SetLevel(log.DebugLevel)
	logger.SetFormatter(NewFilteringFormatter(&log.TextFormatter{DisableColors: true}, Parse(spec)))
	return logger, buf
}

func TestFilteringFormatter_SuppressesNonMatchingDebug(t *testing.T) {
	logger, buf := newTestLogger("runner")

	logger.WithField("context", "task_pool").Debug("should be hidden")

	assert.Empty(t, buf.String())
}

func TestFilteringFormatter_PassesMatchingDebug(t *testing.T) {
	logger, buf := newTestLogger("runner")

	logger.WithField("context", "runner").Debug("should appear")

	assert.Contains(t, buf.String(), "should appear")
	assert.Contains(t, buf.String(), "context=runner")
}

func TestFilteringFormatter_NeverTouchesHigherLevels(t *testing.T) {
	// Even a namespace that is NOT enabled must still emit at Info and above.
	logger, buf := newTestLogger("runner")

	logger.WithField("context", "task_pool").Info("info stays")
	logger.WithField("context", "task_pool").Warn("warn stays")
	logger.WithField("context", "task_pool").Error("error stays")

	out := buf.String()
	assert.Contains(t, out, "info stays")
	assert.Contains(t, out, "warn stays")
	assert.Contains(t, out, "error stays")
}

func TestFilteringFormatter_ContextlessDebug(t *testing.T) {
	t.Run("narrow filter hides contextless", func(t *testing.T) {
		logger, buf := newTestLogger("runner")
		logger.Debug("no context here")
		assert.Empty(t, buf.String())
	})

	t.Run("global filter shows contextless", func(t *testing.T) {
		logger, buf := newTestLogger("*")
		logger.Debug("no context here")
		assert.Contains(t, buf.String(), "no context here")
	})
}

func TestFilteringFormatter_NilFilterSuppressesDebug(t *testing.T) {
	buf := &bytes.Buffer{}
	logger := log.New()
	logger.SetOutput(buf)
	logger.SetLevel(log.DebugLevel)
	logger.SetFormatter(NewFilteringFormatter(&log.TextFormatter{DisableColors: true}, nil))

	logger.WithField("context", "runner").Debug("hidden")
	logger.WithField("context", "runner").Info("shown")

	assert.NotContains(t, buf.String(), "hidden")
	assert.Contains(t, buf.String(), "shown")
}

func TestFilteringFormatter_SuppressedEntryWritesNoBytes(t *testing.T) {
	logger, buf := newTestLogger("runner")

	logger.WithField("context", "task_pool").Debug("x")

	// Suppressed debug entries must produce zero output, not a bare newline.
	require.Equal(t, 0, buf.Len())
}