9599ffcfb9
Highlights from this dep bump: 1. Made a copy of the v0.4.0 github.com/go-logr/stdr implementation for use in tests. We must bump this dep as Kube code uses a newer version now. We would have to rewrite hundreds of test log assertions without this copy. 2. Use github.com/felixge/httpsnoop to undo the changes made by ory/fosite#636 for CLI based login flows. This is required for backwards compatibility with older versions of our CLI. A separate change after this will update the CLI to be more flexible (it is purposefully not part of this change to confirm that we did not break anything). For all browser login flows, we now redirect using http.StatusSeeOther instead of http.StatusFound. 3. Drop plog.RemoveKlogGlobalFlags as klog no longer mutates global process flags 4. Only bump github.com/ory/x to v0.0.297 instead of the latest v0.0.321 because v0.0.298+ pulls in a newer version of go.opentelemetry.io/otel/semconv which breaks k8s.io/apiserver. We should update k8s.io/apiserver to use the newer code. 5. Migrate all code from k8s.io/apimachinery/pkg/util/clock to k8s.io/utils/clock and k8s.io/utils/clock/testing 6. Delete testutil.NewDeleteOptionsRecorder and migrate to the new kubetesting.NewDeleteActionWithOptions 7. Updated ExpectedAuthorizeCodeSessionJSONFromFuzzing caused by fosite's new rotated_secrets OAuth client field. This new field is currently not relevant to us as we have no private clients. Signed-off-by: Monis Khan <mok@vmware.com>
90 lines
2.1 KiB
Go
90 lines
2.1 KiB
Go
// Copyright 2020 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
|
|
}
|
|
|
|
// New returns a new test Logger. Use this for all new tests.
|
|
func New(t *testing.T) *Logger {
|
|
res := Logger{t: t}
|
|
res.Logger = stdr.New(log.New(&res.buffer, "", 0))
|
|
return &res
|
|
}
|
|
|
|
// Deprecated: NewLegacy returns a new test Logger. Use this for old tests if necessary.
|
|
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"))
|
|
}
|