context.go

/*
   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))
}