fix(tests): properly silence log output

Using `init` allows it to also work for benchmarks. And `log.Silence` was sometimes getting overridden by `log.init`.
ThinkChaos · Nov 18, 2023 · a47e8d1 · a47e8d1
1 parent 94663ee
commit a47e8d1
Show file tree

Hide file tree

Showing 16 changed files with 80 additions and 16 deletions.
diff --git a/.golangci.yml b/.golangci.yml
@@ -105,5 +105,6 @@ issues:
       linters:
         - dupl
         - funlen
+        - gochecknoinits
         - gochecknoglobals
         - gosec
diff --git a/api/api_suite_test.go b/api/api_suite_test.go
@@ -8,8 +8,11 @@ import (
 	. "github.com/onsi/gomega"
 )
 
-func TestResolver(t *testing.T) {
+func init() {
 	log.Silence()
+}
+
+func TestResolver(t *testing.T) {
 	RegisterFailHandler(Fail)
 	RunSpecs(t, "API Suite")
 }
diff --git a/cache/expirationcache/expiration_cache_suite_test.go b/cache/expirationcache/expiration_cache_suite_test.go
@@ -9,8 +9,11 @@ import (
 	. "github.com/onsi/gomega"
 )
 
-func TestCache(t *testing.T) {
+func init() {
 	log.Silence()
+}
+
+func TestCache(t *testing.T) {
 	RegisterFailHandler(Fail)
 	RunSpecs(t, "Expiration cache suite")
 }
diff --git a/cache/stringcache/string_cache_suite_test.go b/cache/stringcache/string_cache_suite_test.go
@@ -9,8 +9,11 @@ import (
 	. "github.com/onsi/gomega"
 )
 
-func TestCache(t *testing.T) {
+func init() {
 	log.Silence()
+}
+
+func TestCache(t *testing.T) {
 	RegisterFailHandler(Fail)
 	RunSpecs(t, "String cache suite")
 }
diff --git a/cmd/cmd_suite_test.go b/cmd/cmd_suite_test.go
@@ -9,8 +9,11 @@ import (
 	. "github.com/onsi/gomega"
 )
 
-func TestCmd(t *testing.T) {
+func init() {
 	log.Silence()
+}
+
+func TestCmd(t *testing.T) {
 	RegisterFailHandler(Fail)
 	RunSpecs(t, "Command Suite")
 }
diff --git a/config/config_suite_test.go b/config/config_suite_test.go
@@ -14,8 +14,11 @@ var (
 	hook   *log.MockLoggerHook
 )
 
-func TestConfig(t *testing.T) {
+func init() {
 	log.Silence()
+}
+
+func TestConfig(t *testing.T) {
 	RegisterFailHandler(Fail)
 	RunSpecs(t, "Config Suite")
 }

diff --git a/e2e/e2e_suite_test.go b/e2e/e2e_suite_test.go
@@ -14,8 +14,11 @@ import (
 	"github.com/testcontainers/testcontainers-go"
 )
 
-func TestLists(t *testing.T) {
+func init() {
 	log.Silence()
+}
+
+func TestLists(t *testing.T) {
 	RegisterFailHandler(Fail)
 	RunSpecs(t, "e2e Suite", Label("e2e"))
 }

diff --git a/lists/list_suite_test.go b/lists/list_suite_test.go
@@ -9,8 +9,11 @@ import (
 	. "github.com/onsi/gomega"
 )
 
-func TestLists(t *testing.T) {
+func init() {
 	log.Silence()
+}
+
+func TestLists(t *testing.T) {
 	RegisterFailHandler(Fail)
 	RunSpecs(t, "Lists Suite")
 }
diff --git a/lists/parsers/parsers_suite_test.go b/lists/parsers/parsers_suite_test.go
@@ -9,8 +9,11 @@ import (
 	. "github.com/onsi/gomega"
 )
 
-func TestLists(t *testing.T) {
+func init() {
 	log.Silence()
+}
+
+func TestLists(t *testing.T) {
 	RegisterFailHandler(Fail)
 	RunSpecs(t, "Parsers Suite")
 }
diff --git a/log/logger.go b/log/logger.go
@@ -5,8 +5,10 @@ package log
 import (
 	"fmt"
 	"io"
+	"math"
 	"strings"
 	"sync"
+	"sync/atomic"
 
 	"github.com/mattn/go-colorable"
 	"github.com/sirupsen/logrus"
@@ -19,7 +21,10 @@ const prefixField = "prefix"
 // Logger is the global logging instance
 //
 //nolint:gochecknoglobals
-var logger *logrus.Logger
+var (
+	logger   *logrus.Logger
+	initDone atomic.Bool
+)
 
 // FormatType format for logging ENUM(
 // text // logging as text
@@ -47,6 +52,10 @@ type Config struct {
 
 //nolint:gochecknoinits
 func init() {
+	if !initDone.CompareAndSwap(false, true) {
+		return
+	}
+
 	logger = logrus.New()
 
 	defaultConfig := &Config{
@@ -122,7 +131,19 @@ func ConfigureLogger(cfg *Config) {
 
 // Silence disables the logger output
 func Silence() {
-	logger.Out = io.Discard
+	initDone.Store(true)
+
+	logger.SetFormatter(discardFormatter{}) // skip expensive formatting
+
+	// not actually needed but doesn't hurt
+	logger.SetOutput(io.Discard)
+	logger.SetLevel(math.MaxUint32)
+}
+
+type discardFormatter struct{}
+
+func (f discardFormatter) Format(*logrus.Entry) ([]byte, error) {
+	return nil, nil
 }
 
 func WithIndent(log *logrus.Entry, prefix string, callback func(*logrus.Entry)) {

diff --git a/querylog/querylog_suite_test.go b/querylog/querylog_suite_test.go
@@ -9,8 +9,11 @@ import (
 	. "github.com/onsi/gomega"
 )
 
-func TestResolver(t *testing.T) {
+func init() {
 	log.Silence()
+}
+
+func TestResolver(t *testing.T) {
 	RegisterFailHandler(Fail)
 	RunSpecs(t, "Querylog Suite")
 }
diff --git a/redis/redis_suite_test.go b/redis/redis_suite_test.go
@@ -10,9 +10,12 @@ import (
 	. "github.com/onsi/gomega"
 )
 
-func TestRedisClient(t *testing.T) {
+func init() {
 	log.Silence()
 	redis.SetLogger(NoLogs{})
+}
+
+func TestRedisClient(t *testing.T) {
 	RegisterFailHandler(Fail)
 	RunSpecs(t, "Redis Suite")
 }

diff --git a/resolver/resolver_suite_test.go b/resolver/resolver_suite_test.go
@@ -12,9 +12,12 @@ import (
 	. "github.com/onsi/gomega"
 )
 
-func TestResolver(t *testing.T) {
+func init() {
 	log.Silence()
 	redis.SetLogger(NoLogs{})
+}
+
+func TestResolver(t *testing.T) {
 	RegisterFailHandler(Fail)
 	RunSpecs(t, "Resolver Suite")
 }

diff --git a/server/server_suite_test.go b/server/server_suite_test.go
@@ -8,8 +8,11 @@ import (
 	. "github.com/onsi/gomega"
 )
 
-func TestDNSServer(t *testing.T) {
+func init() {
 	log.Silence()
+}
+
+func TestDNSServer(t *testing.T) {
 	RegisterFailHandler(Fail)
 	RunSpecs(t, "Server Suite")
 }
diff --git a/trie/trie_suite_test.go b/trie/trie_suite_test.go
@@ -9,8 +9,11 @@ import (
 	. "github.com/onsi/gomega"
 )
 
-func TestTrie(t *testing.T) {
+func init() {
 	log.Silence()
+}
+
+func TestTrie(t *testing.T) {
 	RegisterFailHandler(Fail)
 	RunSpecs(t, "Trie Suite")
 }
diff --git a/util/util_suite_test.go b/util/util_suite_test.go
@@ -8,8 +8,11 @@ import (
 	. "github.com/onsi/gomega"
 )
 
-func TestLists(t *testing.T) {
+func init() {
 	log.Silence()
+}
+
+func TestLists(t *testing.T) {
 	RegisterFailHandler(Fail)
 	RunSpecs(t, "Util Suite")
 }