add tests for getLogLevelFromEnv

xray/xrayslog/xrayslog.go

@@ -1,7 +1,7 @@
 //go:build go1.21
 // +build go1.21
 
-// Package xrayslog provides a [log/slog.Handler] that adds trace ID to the log record.
+// Package xrayslog provides utilities for interfacing with the slog package.
 package xrayslog
 
 import (
@@ -100,7 +100,7 @@ func (h *handler) WithGroup(name string) slog.Handler {
 	return &h2
 }
 
-// NewHandler returns a slog.Handler that adds trace ID to the log record.
+// NewHandler returns a [slog.Handler] that adds trace ID to the log record.
 func NewHandler(parent slog.Handler, traceIDKey string) slog.Handler {
 	return &handler{
 		parent:     parent,
@@ -115,7 +115,10 @@ type xrayLogger struct {
 
 // NewXRayLogger returns a new [xraylog.Logger] such that each call to its Output method dispatches a Record to the specified handler.
 // The logger acts as a bridge from the older xraylog API to newer structured logging handlers.
-// The log level is determined by the environment variable AWS_XRAY_LOG_LEVEL.
+// The log level can be set by using either the AWS_XRAY_DEBUG_MODE or AWS_XRAY_LOG_LEVEL environment variables.
+// If AWS_XRAY_DEBUG_MODE is set, the log level is set to the debug level.
+// AWS_XRAY_LOG_LEVEL may be set to debug, info, warn, error or silent.
+// This value is ignored if AWS_XRAY_DEBUG_MODE is set.
 func NewXRayLogger(h slog.Handler) xraylog.Logger {
 	return NewXRayLoggerWithMinLevel(h, getLogLevelFromEnv())
 }

xray/xrayslog/xrayslog_test.go

@@ -15,6 +15,42 @@ import (
 	"github.com/shogo82148/aws-xray-yasdk-go/xray/xraylog"
 )
 
+func Test_getLogLevelFromEnv(t *testing.T) {
+	t.Run("AWS_XRAY_DEBUG_MODE is enable", func(t *testing.T) {
+		t.Setenv("AWS_XRAY_DEBUG_MODE", "1")
+		t.Setenv("AWS_XRAY_LOG_LEVEL", "info")
+		got := getLogLevelFromEnv()
+		want := xraylog.LogLevelDebug
+		if got != want {
+			t.Errorf("got %v; want %v", got, want)
+		}
+	})
+
+	tests := []struct {
+		env  string
+		want xraylog.LogLevel
+	}{
+		{"debug", xraylog.LogLevelDebug},
+		{"info", xraylog.LogLevelInfo},
+		{"warn", xraylog.LogLevelWarn},
+		{"error", xraylog.LogLevelError},
+		{"silent", xraylog.LogLevelSilent},
+	}
+
+	for _, tt := range tests {
+		tt := tt
+		t.Run(tt.env, func(t *testing.T) {
+			t.Setenv("AWS_XRAY_DEBUG_MODE", "")
+			t.Setenv("AWS_XRAY_LOG_LEVEL", tt.env)
+			got := getLogLevelFromEnv()
+			want := tt.want
+			if got != want {
+				t.Errorf("got %v; want %v", got, want)
+			}
+		})
+	}
+}
+
 func TestHandle_WithoutTraceID(t *testing.T) {
 	// build the logger
 	w := &bytes.Buffer{}
@@ -145,9 +181,10 @@ func TestNewXRayLogger(t *testing.T) {
 
 	// log
 	ctx := context.Background()
-	logger := NewXRayLogger(h)
+	logger := NewXRayLoggerWithMinLevel(h, xraylog.LogLevelInfo)
 	ctx = xraylog.WithLogger(ctx, logger)
 	xraylog.Info(ctx, "Hello, World!")
+	xraylog.Debug(ctx, "Hello, It's debug log and should be ignored")
 
 	// check the result
 	var v struct {