90 lines
2.2 KiB
Go
90 lines
2.2 KiB
Go
// Copyright 2020-2022 the Pinniped contributors. All Rights Reserved.
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
// Package testlogger wraps logr.Logger to allow for writing test assertions.
|
|
package testlogger
|
|
|
|
import (
|
|
"bytes"
|
|
"fmt"
|
|
"log"
|
|
"strings"
|
|
"sync"
|
|
"testing"
|
|
|
|
"github.com/go-logr/logr"
|
|
"github.com/go-logr/stdr"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
// Logger wraps logr.Logger in a way that captures logs for test assertions.
|
|
type Logger struct {
|
|
Logger logr.Logger
|
|
t *testing.T
|
|
buffer syncBuffer
|
|
}
|
|
|
|
// Deprecated: Use plog.TestLogger or plog.TestZapr instead. This is meant for old tests only.
|
|
func New(t *testing.T) *Logger {
|
|
res := Logger{t: t}
|
|
res.Logger = stdr.New(log.New(&res.buffer, "", 0))
|
|
return &res
|
|
}
|
|
|
|
// Deprecated: Use plog.TestLogger or plog.TestZapr instead. This is meant for old tests only.
|
|
func NewLegacy(t *testing.T) *Logger {
|
|
res := New(t)
|
|
res.Logger = newStdLogger(log.New(&res.buffer, "", 0))
|
|
return res
|
|
}
|
|
|
|
// Lines returns the lines written to the test logger.
|
|
func (l *Logger) Lines() []string {
|
|
l.t.Helper()
|
|
l.buffer.mutex.Lock()
|
|
defer l.buffer.mutex.Unlock()
|
|
|
|
// Trim leading/trailing whitespace and omit empty lines.
|
|
var result []string
|
|
for _, line := range strings.Split(l.buffer.buffer.String(), "\n") {
|
|
line = strings.TrimSpace(line)
|
|
if line != "" {
|
|
result = append(result, line)
|
|
}
|
|
}
|
|
return result
|
|
}
|
|
|
|
// Expect the emitted lines to match known-good output.
|
|
func (l *Logger) Expect(expected []string) {
|
|
actual := l.Lines()
|
|
require.Equalf(l.t, expected, actual, "did not see expected log output, actual output:\n%#v", backtickStrings(actual))
|
|
}
|
|
|
|
// syncBuffer synchronizes access to a bytes.Buffer.
|
|
type syncBuffer struct {
|
|
mutex sync.Mutex
|
|
buffer bytes.Buffer
|
|
}
|
|
|
|
func (s *syncBuffer) Write(p []byte) (n int, err error) {
|
|
s.mutex.Lock()
|
|
defer s.mutex.Unlock()
|
|
return s.buffer.Write(p)
|
|
}
|
|
|
|
type backtickStrings []string
|
|
|
|
func (b backtickStrings) GoString() string {
|
|
lines := make([]string, 0, len(b))
|
|
for _, s := range b {
|
|
if strings.Contains(s, "`") {
|
|
s = fmt.Sprintf("%#v", s)
|
|
} else {
|
|
s = fmt.Sprintf("`%s`", s)
|
|
}
|
|
lines = append(lines, fmt.Sprintf("\t%s,", s))
|
|
}
|
|
return fmt.Sprintf("[]string{\n%s\n}", strings.Join(lines, "\n"))
|
|
}
|