Skip to content

Commit

Permalink
Merge pull request #246 from thockin/slog_context_tests
Browse files Browse the repository at this point in the history
Add tests for context with slog
  • Loading branch information
pohly authored Dec 8, 2023
2 parents 5153ab2 + 2665157 commit 006d752
Show file tree
Hide file tree
Showing 3 changed files with 116 additions and 29 deletions.
66 changes: 66 additions & 0 deletions context_slog_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
//go:build go1.21
// +build go1.21

/*
Copyright 2021 The logr Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package logr

import (
"context"
"log/slog"
"os"
"testing"
)

func TestContextWithSlog(t *testing.T) {
ctx := context.Background()

if out := FromContextAsSlogLogger(ctx); out != nil {
t.Errorf("expected no logger, got %#v", out)
}

// Write as slog...
slogger := slog.New(slog.NewJSONHandler(os.Stderr, nil))
sctx := NewContextWithSlogLogger(ctx, slogger)

// ...read as logr
if out, err := FromContext(sctx); err != nil {
t.Errorf("unexpected error: %v", err)
} else if _, ok := out.sink.(*slogSink); !ok {
t.Errorf("expected output to be type *logr.slogSink, got %T", out.sink)
}

// ...read as slog
if out := FromContextAsSlogLogger(sctx); out == nil {
t.Errorf("expected a *slog.JSONHandler, got nil")
} else if _, ok := out.Handler().(*slog.JSONHandler); !ok {
t.Errorf("expected output to be type *slog.JSONHandler, got %T", out.Handler())
}

// Write as logr...
logger := Discard()
lctx := NewContext(ctx, logger)

// ...read as slog
if out := FromContextAsSlogLogger(lctx); out == nil {
t.Errorf("expected a *log.slogHandler, got nil")
} else if _, ok := out.Handler().(*slogHandler); !ok {
t.Errorf("expected output to be type *logr.slogHandler, got %T", out.Handler())
}

// ...read as logr is covered in the non-slog test
}
50 changes: 50 additions & 0 deletions context_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
/*
Copyright 2021 The logr Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package logr

import (
"context"
"testing"
)

func TestContext(t *testing.T) {
ctx := context.Background()

if out, err := FromContext(ctx); err == nil {
t.Errorf("expected error, got %#v", out)
} else if _, ok := err.(notFoundError); !ok {
t.Errorf("expected a notFoundError, got %#v", err)
}

out := FromContextOrDiscard(ctx)
if out.sink != nil {
t.Errorf("expected a nil sink, got %#v", out)
}

sink := &testLogSink{}
logger := New(sink)
lctx := NewContext(ctx, logger)
if out, err := FromContext(lctx); err != nil {
t.Errorf("unexpected error: %v", err)
} else if p, _ := out.sink.(*testLogSink); p != sink {
t.Errorf("expected output to be the same as input, got in=%p, out=%p", sink, p)
}
out = FromContextOrDiscard(lctx)
if p, _ := out.sink.(*testLogSink); p != sink {
t.Errorf("expected output to be the same as input, got in=%p, out=%p", sink, p)
}
}
29 changes: 0 additions & 29 deletions logr_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ limitations under the License.
package logr

import (
"context"
"errors"
"fmt"
"reflect"
Expand Down Expand Up @@ -414,34 +413,6 @@ func TestWithCallDepthIncremental(t *testing.T) {
}
}

func TestContext(t *testing.T) {
ctx := context.TODO()

if out, err := FromContext(ctx); err == nil {
t.Errorf("expected error, got %#v", out)
} else if _, ok := err.(notFoundError); !ok {
t.Errorf("expected a notFoundError, got %#v", err)
}

out := FromContextOrDiscard(ctx)
if out.sink != nil {
t.Errorf("expected a nil sink, got %#v", out)
}

sink := &testLogSink{}
logger := New(sink)
lctx := NewContext(ctx, logger)
if out, err := FromContext(lctx); err != nil {
t.Errorf("unexpected error: %v", err)
} else if p, _ := out.sink.(*testLogSink); p != sink {
t.Errorf("expected output to be the same as input, got in=%p, out=%p", sink, p)
}
out = FromContextOrDiscard(lctx)
if p, _ := out.sink.(*testLogSink); p != sink {
t.Errorf("expected output to be the same as input, got in=%p, out=%p", sink, p)
}
}

func TestIsZero(t *testing.T) {
var l Logger
if !l.IsZero() {
Expand Down

0 comments on commit 006d752

Please sign in to comment.