Add testing log hook to context
Allows log output to sent along with test output for cleaner output and clearer ordering. Signed-off-by: Derek McGowan <derek@mcgstyle.net>
This commit is contained in:
parent
f2b6c31d0f
commit
f63eab32e1
2
Makefile
2
Makefile
@ -111,7 +111,7 @@ GO_GCFLAGS=$(shell \
|
||||
BINARIES=$(addprefix bin/,$(COMMANDS))
|
||||
|
||||
# Flags passed to `go test`
|
||||
TESTFLAGS ?= -v $(TESTFLAGS_RACE)
|
||||
TESTFLAGS ?= $(TESTFLAGS_RACE)
|
||||
TESTFLAGS_PARALLEL ?= 8
|
||||
|
||||
.PHONY: clean all AUTHORS build binaries test integration generate protos checkprotos coverage ci check help install uninstall vendor release mandir install-man
|
||||
|
49
log/logtest/context.go
Normal file
49
log/logtest/context.go
Normal file
@ -0,0 +1,49 @@
|
||||
/*
|
||||
Copyright The containerd 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 logtest
|
||||
|
||||
import (
|
||||
"context"
|
||||
"io/ioutil"
|
||||
"testing"
|
||||
|
||||
"github.com/containerd/containerd/log"
|
||||
"github.com/sirupsen/logrus"
|
||||
)
|
||||
|
||||
// WithT adds a logging hook for the given test
|
||||
// Changes debug level to debug, clears output, and
|
||||
// outputs all log messages as test logs.
|
||||
func WithT(ctx context.Context, t testing.TB) context.Context {
|
||||
// Create a new logger to avoid adding hooks from multiple tests
|
||||
l := logrus.New()
|
||||
|
||||
// Increase debug level for tests
|
||||
l.SetLevel(logrus.DebugLevel)
|
||||
l.SetOutput(ioutil.Discard)
|
||||
|
||||
// Add testing hook
|
||||
l.AddHook(&testHook{
|
||||
t: t,
|
||||
fmt: &logrus.TextFormatter{
|
||||
DisableColors: true,
|
||||
TimestampFormat: log.RFC3339NanoFixed,
|
||||
},
|
||||
})
|
||||
|
||||
return log.WithLogger(ctx, logrus.NewEntry(l))
|
||||
}
|
42
log/logtest/log_hook.go
Normal file
42
log/logtest/log_hook.go
Normal file
@ -0,0 +1,42 @@
|
||||
/*
|
||||
Copyright The containerd 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 logtest
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"testing"
|
||||
|
||||
"github.com/sirupsen/logrus"
|
||||
)
|
||||
|
||||
type testHook struct {
|
||||
t testing.TB
|
||||
fmt logrus.Formatter
|
||||
}
|
||||
|
||||
func (*testHook) Levels() []logrus.Level {
|
||||
return logrus.AllLevels
|
||||
}
|
||||
|
||||
func (h *testHook) Fire(e *logrus.Entry) error {
|
||||
s, err := h.fmt.Format(e)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
h.t.Log(string(bytes.TrimRight(s, "\n")))
|
||||
return nil
|
||||
}
|
Loading…
Reference in New Issue
Block a user