github.com/sirupsen/logrus usage refactoring

.golangci.yml

@@ -58,6 +58,7 @@ linters-settings:
       - '^os\.(.*)$(# Using anything except Signal and SyscallError from the os package is forbidden )?'
       # Forbid everything in syscall except the uppercase constants
       - '^syscall\.[^A-Z_]+$(# Using anything except constants from the syscall package is forbidden )?'
+      - '^logrus\.Logger$'
 
 linters:
   disable-all: true

api/v1/group_routes_test.go

@@ -7,7 +7,6 @@ import (
 	"net/http/httptest"
 	"testing"
 
-	"github.com/sirupsen/logrus"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
@@ -22,7 +21,6 @@ import (
 func getTestPreInitState(tb testing.TB) *lib.TestPreInitState {
 	reg := metrics.NewRegistry()
 	logger := testutils.NewLogger(tb)
-	logger.SetLevel(logrus.DebugLevel)
 	return &lib.TestPreInitState{
 		Logger:         logger,
 		RuntimeOptions: lib.RuntimeOptions{},

cloudapi/logs_test.go

@@ -92,7 +92,7 @@ func TestMSGLog(t *testing.T) {
 
 	logger := logrus.New()
 	logger.Out = ioutil.Discard
-	hook := &testutils.SimpleLogrusHook{HookedLevels: logrus.AllLevels}
+	hook := testutils.NewLogHook()
 	logger.AddHook(hook)
 	expectMsg.Log(logger)
 	logLines := hook.Drain()
@@ -250,7 +250,7 @@ func TestStreamLogsToLogger(t *testing.T) {
 
 		logger := logrus.New()
 		logger.Out = ioutil.Discard
-		hook := &testutils.SimpleLogrusHook{HookedLevels: logrus.AllLevels}
+		hook := testutils.NewLogHook()
 		logger.AddHook(hook)
 
 		c := configFromHTTPMultiBin(tb)
@@ -322,7 +322,7 @@ func TestStreamLogsToLogger(t *testing.T) {
 
 		logger := logrus.New()
 		logger.Out = ioutil.Discard
-		hook := &testutils.SimpleLogrusHook{HookedLevels: logrus.AllLevels}
+		hook := testutils.NewLogHook()
 		logger.AddHook(hook)
 
 		c := configFromHTTPMultiBin(tb)
@@ -390,7 +390,7 @@ func TestStreamLogsToLogger(t *testing.T) {
 
 		logger := logrus.New()
 		logger.Out = ioutil.Discard
-		hook := &testutils.SimpleLogrusHook{HookedLevels: logrus.AllLevels}
+		hook := testutils.NewLogHook()
 		logger.AddHook(hook)
 
 		c := configFromHTTPMultiBin(tb)

cmd/run.go

@@ -355,19 +355,19 @@ func getCmdRun(gs *state.GlobalState) *cobra.Command {
 	exampleText := getExampleText(gs, `
   # Run a single VU, once.
   {{.}} run script.js
-  
+
   # Run a single VU, 10 times.
   {{.}} run -i 10 script.js
-  
+
   # Run 5 VUs, splitting 10 iterations between them.
   {{.}} run -u 5 -i 10 script.js
-  
+
   # Run 5 VUs for 10s.
   {{.}} run -u 5 -d 10s script.js
-  
+
   # Ramp VUs from 0 to 100 over 10s, stay there for 60s, then 10s down to 0.
   {{.}} run -u 0 -s 10s:100 -s 60s -s 10s:0
-  
+
   # Send metrics to an influxdb server
   {{.}} run -o influxdb=http://1.2.3.4:8086/k6`[1:])
 

cmd/run_test.go

@@ -7,7 +7,6 @@ import (
 	"io"
 	"io/fs"
 	"io/ioutil"
-	"log"
 	"path"
 	"path/filepath"
 	"runtime"
@@ -318,7 +317,7 @@ func TestThresholdsRuntimeBehavior(t *testing.T) {
 			}
 
 			if tc.expStdoutNotContains != "" {
-				log.Println(ts.Stdout.String())
+				t.Log(ts.Stdout.String())
 				assert.NotContains(t, ts.Stdout.String(), tc.expStdoutNotContains)
 			}
 		})

cmd/test_load.go

@@ -248,7 +248,7 @@ func loadAndConfigureTest(
 }
 
 // loadSystemCertPool attempts to load system certificates.
-func loadSystemCertPool(logger *logrus.Logger) {
+func loadSystemCertPool(logger logrus.FieldLogger) {
 	if _, err := x509.SystemCertPool(); err != nil {
 		logger.WithError(err).Warning("Unable to load system cert pool")
 	}

cmd/tests/test_state.go

@@ -49,7 +49,7 @@ func NewGlobalTestState(tb testing.TB) *GlobalTestState {
 	logger := logrus.New()
 	logger.SetLevel(logrus.InfoLevel)
 	logger.Out = testutils.NewTestOutput(tb)
-	hook := &testutils.SimpleLogrusHook{HookedLevels: logrus.AllLevels}
+	hook := testutils.NewLogHook()
 	logger.AddHook(hook)
 
 	ts := &GlobalTestState{

execution/scheduler_ext_exec_test.go

@@ -64,8 +64,8 @@ func TestExecutionInfoVUSharing(t *testing.T) {
 
 	logger := logrus.New()
 	logger.SetOutput(ioutil.Discard)
-	logHook := testutils.SimpleLogrusHook{HookedLevels: []logrus.Level{logrus.InfoLevel}}
-	logger.AddHook(&logHook)
+	logHook := testutils.NewLogHook(logrus.InfoLevel)
+	logger.AddHook(logHook)
 
 	registry := metrics.NewRegistry()
 	builtinMetrics := metrics.RegisterBuiltinMetrics(registry)
@@ -177,8 +177,8 @@ func TestExecutionInfoScenarioIter(t *testing.T) {
 
 	logger := logrus.New()
 	logger.SetOutput(ioutil.Discard)
-	logHook := testutils.SimpleLogrusHook{HookedLevels: []logrus.Level{logrus.InfoLevel}}
-	logger.AddHook(&logHook)
+	logHook := testutils.NewLogHook(logrus.InfoLevel)
+	logger.AddHook(logHook)
 
 	registry := metrics.NewRegistry()
 	builtinMetrics := metrics.RegisterBuiltinMetrics(registry)
@@ -259,8 +259,8 @@ func TestSharedIterationsStable(t *testing.T) {
 
 	logger := logrus.New()
 	logger.SetOutput(ioutil.Discard)
-	logHook := testutils.SimpleLogrusHook{HookedLevels: []logrus.Level{logrus.InfoLevel}}
-	logger.AddHook(&logHook)
+	logHook := testutils.NewLogHook(logrus.InfoLevel)
+	logger.AddHook(logHook)
 
 	registry := metrics.NewRegistry()
 	builtinMetrics := metrics.RegisterBuiltinMetrics(registry)
@@ -394,8 +394,8 @@ func TestExecutionInfoAll(t *testing.T) {
 
 			logger := logrus.New()
 			logger.SetOutput(ioutil.Discard)
-			logHook := testutils.SimpleLogrusHook{HookedLevels: []logrus.Level{logrus.InfoLevel}}
-			logger.AddHook(&logHook)
+			logHook := testutils.NewLogHook(logrus.InfoLevel)
+			logger.AddHook(logHook)
 
 			registry := metrics.NewRegistry()
 			builtinMetrics := metrics.RegisterBuiltinMetrics(registry)

execution/scheduler_ext_test.go

@@ -58,7 +58,7 @@ func getTestRunState(
 }
 
 func newTestScheduler(
-	t *testing.T, runner lib.Runner, logger *logrus.Logger, opts lib.Options,
+	t *testing.T, runner lib.Runner, logger logrus.FieldLogger, opts lib.Options,
 ) (ctx context.Context, cancel func(), execScheduler *execution.Scheduler, samples chan metrics.SampleContainer) {
 	if runner == nil {
 		runner = &minirunner.MiniRunner{}
@@ -1083,8 +1083,8 @@ func TestDNSResolver(t *testing.T) {
 				t.Parallel()
 				logger := logrus.New()
 				logger.SetOutput(ioutil.Discard)
-				logHook := testutils.SimpleLogrusHook{HookedLevels: []logrus.Level{logrus.WarnLevel}}
-				logger.AddHook(&logHook)
+				logHook := testutils.NewLogHook(logrus.WarnLevel)
+				logger.AddHook(logHook)
 
 				registry := metrics.NewRegistry()
 				builtinMetrics := metrics.RegisterBuiltinMetrics(registry)

js/bundle_test.go

@@ -31,7 +31,7 @@ import (
 
 const isWindows = runtime.GOOS == "windows"
 
-func getTestPreInitState(tb testing.TB, logger *logrus.Logger, rtOpts *lib.RuntimeOptions) *lib.TestPreInitState {
+func getTestPreInitState(tb testing.TB, logger logrus.FieldLogger, rtOpts *lib.RuntimeOptions) *lib.TestPreInitState {
 	if logger == nil {
 		logger = testutils.NewLogger(tb)
 	}
@@ -50,14 +50,14 @@ func getTestPreInitState(tb testing.TB, logger *logrus.Logger, rtOpts *lib.Runti
 func getSimpleBundle(tb testing.TB, filename, data string, opts ...interface{}) (*Bundle, error) {
 	fs := afero.NewMemMapFs()
 	var rtOpts *lib.RuntimeOptions
-	var logger *logrus.Logger
+	var logger logrus.FieldLogger
 	for _, o := range opts {
 		switch opt := o.(type) {
 		case afero.Fs:
 			fs = opt
 		case lib.RuntimeOptions:
 			rtOpts = &opt
-		case *logrus.Logger:
+		case logrus.FieldLogger:
 			logger = opt
 		default:
 			tb.Fatalf("unknown test option %q", opt)
@@ -435,10 +435,10 @@ func TestNewBundle(t *testing.T) {
 			logger := logrus.New()
 			logger.SetLevel(logrus.InfoLevel)
 			logger.Out = ioutil.Discard
-			hook := testutils.SimpleLogrusHook{
-				HookedLevels: []logrus.Level{logrus.WarnLevel, logrus.InfoLevel, logrus.ErrorLevel, logrus.FatalLevel, logrus.PanicLevel},
-			}
-			logger.AddHook(&hook)
+			hook := testutils.NewLogHook(
+				logrus.WarnLevel, logrus.InfoLevel, logrus.ErrorLevel, logrus.FatalLevel, logrus.PanicLevel,
+			)
+			logger.AddHook(hook)
 
 			_, err := getSimpleBundle(t, "/script.js", `
 				export let options = {

js/compiler/compiler_test.go

@@ -168,10 +168,8 @@ func TestCorruptSourceMap(t *testing.T) {
 	logger := logrus.New()
 	logger.SetLevel(logrus.DebugLevel)
 	logger.Out = ioutil.Discard
-	hook := testutils.SimpleLogrusHook{
-		HookedLevels: []logrus.Level{logrus.InfoLevel, logrus.WarnLevel},
-	}
-	logger.AddHook(&hook)
+	hook := testutils.NewLogHook(logrus.InfoLevel, logrus.WarnLevel)
+	logger.AddHook(hook)
 
 	compiler := New(logger)
 	compiler.Options = Options{
@@ -199,10 +197,8 @@ func TestCorruptSourceMapOnlyForBabel(t *testing.T) {
 	logger := logrus.New()
 	logger.SetLevel(logrus.DebugLevel)
 	logger.Out = ioutil.Discard
-	hook := testutils.SimpleLogrusHook{
-		HookedLevels: []logrus.Level{logrus.InfoLevel, logrus.WarnLevel},
-	}
-	logger.AddHook(&hook)
+	hook := testutils.NewLogHook(logrus.InfoLevel, logrus.WarnLevel)
+	logger.AddHook(hook)
 
 	compiler := New(logger)
 	compiler.Options = Options{
@@ -231,10 +227,8 @@ func TestMinimalSourceMap(t *testing.T) {
 	logger := logrus.New()
 	logger.SetLevel(logrus.DebugLevel)
 	logger.Out = ioutil.Discard
-	hook := testutils.SimpleLogrusHook{
-		HookedLevels: []logrus.Level{logrus.InfoLevel, logrus.WarnLevel},
-	}
-	logger.AddHook(&hook)
+	hook := testutils.NewLogHook(logrus.InfoLevel, logrus.WarnLevel)
+	logger.AddHook(hook)
 
 	compiler := New(logger)
 	compiler.Options = Options{

js/console.go

@@ -9,7 +9,7 @@ import (
 	"github.com/sirupsen/logrus"
 )
 
-// console represents a JS console implemented as a logrus.Logger.
+// console represents a JS console implemented as a logrus.FieldLogger.
 type console struct {
 	logger logrus.FieldLogger
 }

js/console_test.go

@@ -58,7 +58,7 @@ func getSimpleRunner(tb testing.TB, filename, data string, opts ...interface{})
 			fsResolvers = opt
 		case lib.RuntimeOptions:
 			rtOpts = opt
-		case *logrus.Logger:
+		case logrus.FieldLogger:
 			logger = opt
 		default:
 			tb.Fatalf("unknown test option %q", opt)
@@ -82,6 +82,7 @@ func getSimpleRunner(tb testing.TB, filename, data string, opts ...interface{})
 	)
 }
 
+// TODO: remove the need for this function, see https://github.com/grafana/k6/issues/2968
 func extractLogger(fl logrus.FieldLogger) *logrus.Logger {
 	switch e := fl.(type) {
 	case *logrus.Entry:
@@ -103,8 +104,7 @@ func TestConsoleLogWithGojaNativeObject(t *testing.T) {
 	err := obj.Set("text", "nativeObject")
 	require.NoError(t, err)
 
-	logger := testutils.NewLogger(t)
-	hook := logtest.NewLocal(logger)
+	logger, hook := testutils.NewLoggerWithHook(t)
 
 	c := newConsole(logger)
 	c.Log(obj)
@@ -160,8 +160,7 @@ func TestConsoleLogObjectsWithGoTypes(t *testing.T) {
 			rt.SetFieldNameMapper(common.FieldNameMapper{})
 			obj := rt.ToValue(tt.in)
 
-			logger := testutils.NewLogger(t)
-			hook := logtest.NewLocal(logger)
+			logger, hook := testutils.NewLoggerWithHook(t)
 
 			c := newConsole(logger)
 			c.Log(obj)

js/modules/k6/execution/execution_test.go

@@ -119,7 +119,7 @@ func TestVUTagsSuccessOverwriteSystemTag(t *testing.T) {
 func TestVUTagsErrorOutOnInvalidValues(t *testing.T) {
 	t.Parallel()
 
-	logHook := &testutils.SimpleLogrusHook{HookedLevels: []logrus.Level{logrus.WarnLevel}}
+	logHook := testutils.NewLogHook(logrus.WarnLevel)
 	testLog := logrus.New()
 	testLog.AddHook(logHook)
 	testLog.SetOutput(ioutil.Discard)

js/modules/k6/grpc/client_test.go

@@ -949,9 +949,7 @@ func TestClientInvokeHeadersDeprecated(t *testing.T) {
 
 	registry := metrics.NewRegistry()
 
-	logHook := &testutils.SimpleLogrusHook{
-		HookedLevels: []logrus.Level{logrus.WarnLevel},
-	}
+	logHook := testutils.NewLogHook(logrus.WarnLevel)
 	testLog := logrus.New()
 	testLog.AddHook(logHook)
 	testLog.SetOutput(ioutil.Discard)