Clean up tests logging (#1979)

* Clean up tests logging

This cleans up the travis logs so you can see the failures better.

Older tests in tests/ would call log.SetOutput(ioutil.Discard) in
a haphazard way. This add log.Discard and put an `init` function in each
package's dir (no way to do this globally). The cleanup in tests/ is
clear.

All plugins also got this init function to have some uniformity and kill
any (future) logging there in the tests as well.

There is a one-off in pkg/healthcheck because that does log.
Signed-off-by: Miek Gieben <miek@miek.nl>

* bring back original log_test.go
Signed-off-by: Miek Gieben <miek@miek.nl>

* suppress logging here as well
Signed-off-by: Miek Gieben <miek@miek.nl>

core/dnsserver/log_test.go

+package dnsserver
+
+import clog "github.com/coredns/coredns/plugin/pkg/log"
+
+func init() { clog.Discard() }

plugin/auto/log_test.go

+package auto
+
+import clog "github.com/coredns/coredns/plugin/pkg/log"
+
+func init() { clog.Discard() }

plugin/bind/log_test.go

+package bind
+
+import clog "github.com/coredns/coredns/plugin/pkg/log"
+
+func init() { clog.Discard() }

plugin/cache/log_test.go

+package cache
+
+import clog "github.com/coredns/coredns/plugin/pkg/log"
+
+func init() { clog.Discard() }

plugin/chaos/log_test.go

+package chaos
+
+import clog "github.com/coredns/coredns/plugin/pkg/log"
+
+func init() { clog.Discard() }

plugin/debug/log_test.go

+package debug
+
+import clog "github.com/coredns/coredns/plugin/pkg/log"
+
+func init() { clog.Discard() }

plugin/dnssec/log_test.go

+package dnssec
+
+import clog "github.com/coredns/coredns/plugin/pkg/log"
+
+func init() { clog.Discard() }

plugin/dnstap/dnstapio/log_test.go

+package dnstapio
+
+import clog "github.com/coredns/coredns/plugin/pkg/log"
+
+func init() { clog.Discard() }

plugin/dnstap/log_test.go

+package dnstap
+
+import clog "github.com/coredns/coredns/plugin/pkg/log"
+
+func init() { clog.Discard() }

plugin/erratic/log_test.go

+package erratic
+
+import clog "github.com/coredns/coredns/plugin/pkg/log"
+
+func init() { clog.Discard() }

plugin/errors/log_test.go

+package errors
+
+import clog "github.com/coredns/coredns/plugin/pkg/log"
+
+func init() { clog.Discard() }

plugin/etcd/log_test.go

+package etcd
+
+import clog "github.com/coredns/coredns/plugin/pkg/log"
+
+func init() { clog.Discard() }

plugin/federation/log_test.go

+package federation
+
+import clog "github.com/coredns/coredns/plugin/pkg/log"
+
+func init() { clog.Discard() }

plugin/file/log_test.go

+package file
+
+import clog "github.com/coredns/coredns/plugin/pkg/log"
+
+func init() { clog.Discard() }

plugin/forward/log_test.go

+package forward
+
+import clog "github.com/coredns/coredns/plugin/pkg/log"
+
+func init() { clog.Discard() }

plugin/health/log_test.go

+package health
+
+import clog "github.com/coredns/coredns/plugin/pkg/log"
+
+func init() { clog.Discard() }

plugin/hosts/log_test.go

+package hosts
+
+import clog "github.com/coredns/coredns/plugin/pkg/log"
+
+func init() { clog.Discard() }

plugin/kubernetes/log_test.go

+package kubernetes
+
+import clog "github.com/coredns/coredns/plugin/pkg/log"
+
+func init() { clog.Discard() }

plugin/loadbalance/log_test.go

+package loadbalance
+
+import clog "github.com/coredns/coredns/plugin/pkg/log"
+
+func init() { clog.Discard() }

plugin/log/log_test.go

@@ -8,12 +8,15 @@ import (
 	"testing"
 
 	"github.com/coredns/coredns/plugin/pkg/dnstest"
+	clog "github.com/coredns/coredns/plugin/pkg/log"
 	"github.com/coredns/coredns/plugin/pkg/response"
 	"github.com/coredns/coredns/plugin/test"
 
 	"github.com/miekg/dns"
 )
 
+func init() { clog.Discard() }
+
 func TestLoggedStatus(t *testing.T) {
 	var f bytes.Buffer
 	rule := Rule{

plugin/log_test.go

+package plugin
+
+import clog "github.com/coredns/coredns/plugin/pkg/log"
+
+func init() { clog.Discard() }

plugin/metadata/log_test.go

+package metadata
+
+import clog "github.com/coredns/coredns/plugin/pkg/log"
+
+func init() { clog.Discard() }

plugin/metrics/log_test.go

+package metrics
+
+import clog "github.com/coredns/coredns/plugin/pkg/log"
+
+func init() { clog.Discard() }

plugin/nsid/log_test.go

+package nsid
+
+import clog "github.com/coredns/coredns/plugin/pkg/log"
+
+func init() { clog.Discard() }

plugin/pkg/healthcheck/log_test.go

+package healthcheck
+
+import clog "github.com/coredns/coredns/plugin/pkg/log"
+
+func init() { clog.Discard() }

plugin/pkg/log/log.go

@@ -10,6 +10,7 @@ package log
 
 import (
 	"fmt"
+	"io/ioutil"
 	golog "log"
 )
 
@@ -61,6 +62,9 @@ func Error(v ...interface{}) { log(err, v...) }
 // Errorf is equivalent to log.Printf, but prefixed with "[ERROR] ".
 func Errorf(format string, v ...interface{}) { logf(err, format, v...) }
 
+// Discard sets the log output to /dev/null.
+func Discard() { golog.SetOutput(ioutil.Discard) }
+
 const (
 	debug   = "[DEBUG] "
 	err     = "[ERROR] "

plugin/pprof/log_test.go

+package pprof
+
+import clog "github.com/coredns/coredns/plugin/pkg/log"
+
+func init() { clog.Discard() }

plugin/proxy/log_test.go

+package proxy
+
+import clog "github.com/coredns/coredns/plugin/pkg/log"
+
+func init() { clog.Discard() }

plugin/reload/log_test.go

+package reload
+
+import clog "github.com/coredns/coredns/plugin/pkg/log"
+
+func init() { clog.Discard() }

plugin/rewrite/log_test.go

+package rewrite
+
+import clog "github.com/coredns/coredns/plugin/pkg/log"
+
+func init() { clog.Discard() }

plugin/root/log_test.go

+package root
+
+import clog "github.com/coredns/coredns/plugin/pkg/log"
+
+func init() { clog.Discard() }

plugin/route53/log_test.go

+package route53
+
+import clog "github.com/coredns/coredns/plugin/pkg/log"
+
+func init() { clog.Discard() }

plugin/secondary/log_test.go

+package secondary
+
+import clog "github.com/coredns/coredns/plugin/pkg/log"
+
+func init() { clog.Discard() }

plugin/template/log_test.go

+package template
+
+import clog "github.com/coredns/coredns/plugin/pkg/log"
+
+func init() { clog.Discard() }

plugin/tls/log_test.go

+package tls
+
+import clog "github.com/coredns/coredns/plugin/pkg/log"
+
+func init() { clog.Discard() }

plugin/trace/log_test.go

+package trace
+
+import clog "github.com/coredns/coredns/plugin/pkg/log"
+
+func init() { clog.Discard() }

plugin/whoami/log_test.go

+package whoami
+
+import clog "github.com/coredns/coredns/plugin/pkg/log"
+
+func init() { clog.Discard() }

test/auto_test.go

@@ -2,7 +2,6 @@ package test
 
 import (
 	"io/ioutil"
-	"log"
 	"os"
 	"path"
 	"testing"
@@ -35,8 +34,6 @@ func TestAuto(t *testing.T) {
 	}
 	defer i.Stop()
 
-	log.SetOutput(ioutil.Discard)
-
 	p := proxy.NewLookup([]string{udp})
 	state := request.Request{W: &test.ResponseWriter{}, Req: new(dns.Msg)}
 
@@ -82,7 +79,6 @@ func TestAutoNonExistentZone(t *testing.T) {
 	if err != nil {
 		t.Fatal(err)
 	}
-	log.SetOutput(ioutil.Discard)
 
 	corefile := `.:0 {
 		auto {
@@ -117,7 +113,6 @@ func TestAutoNonExistentZone(t *testing.T) {
 
 func TestAutoAXFR(t *testing.T) {
 	t.Parallel()
-	log.SetOutput(ioutil.Discard)
 
 	tmpdir, err := ioutil.TempDir(os.TempDir(), "coredns")
 	if err != nil {

test/chaos_test.go

 package test
 
 import (
-	"io/ioutil"
-	"log"
 	"testing"
 
 	// Plug in CoreDNS, needed for AppVersion and AppName in this test.
@@ -24,8 +22,6 @@ func TestChaos(t *testing.T) {
 	}
 	defer i.Stop()
 
-	log.SetOutput(ioutil.Discard)
-
 	m := new(dns.Msg)
 	m.SetQuestion("version.bind.", dns.TypeTXT)
 	m.Question[0].Qclass = dns.ClassCHAOS

test/ds_file_test.go

 package test
 
 import (
-	"io/ioutil"
-	"log"
 	"testing"
 
 	"github.com/coredns/coredns/plugin/proxy"
@@ -49,8 +47,6 @@ func TestLookupDS(t *testing.T) {
 	}
 	defer i.Stop()
 
-	log.SetOutput(ioutil.Discard)
-
 	p := proxy.NewLookup([]string{udp})
 	state := request.Request{W: &mtest.ResponseWriter{}, Req: new(dns.Msg)}
 

test/etcd_cache_test.go

@@ -4,8 +4,6 @@ package test
 
 import (
 	"context"
-	"io/ioutil"
-	"log"
 	"testing"
 
 	"github.com/coredns/coredns/plugin/etcd/msg"
@@ -33,7 +31,6 @@ func TestEtcdCache(t *testing.T) {
 	defer ex.Stop()
 
 	etc := etcdPlugin()
-	log.SetOutput(ioutil.Discard)
 
 	var ctx = context.TODO()
 	for _, serv := range servicesCacheTest {

test/etcd_test.go

@@ -5,8 +5,6 @@ package test
 import (
 	"context"
 	"encoding/json"
-	"io/ioutil"
-	"log"
 	"testing"
 	"time"
 
@@ -53,7 +51,6 @@ func TestEtcdStubAndProxyLookup(t *testing.T) {
 	defer ex.Stop()
 
 	etc := etcdPlugin()
-	log.SetOutput(ioutil.Discard)
 
 	var ctx = context.TODO()
 	for _, serv := range servicesStub { // adds example.{net,org} as stubs

test/file_cname_proxy_test.go

 package test
 
 import (
-	"io/ioutil"
-	"log"
 	"testing"
 
 	"github.com/coredns/coredns/plugin/proxy"
@@ -14,7 +12,6 @@ import (
 
 func TestZoneExternalCNAMELookupWithoutProxy(t *testing.T) {
 	t.Parallel()
-	log.SetOutput(ioutil.Discard)
 
 	name, rm, err := TempFile(".", exampleOrg)
 	if err != nil {
@@ -48,7 +45,6 @@ func TestZoneExternalCNAMELookupWithoutProxy(t *testing.T) {
 
 func TestZoneExternalCNAMELookupWithProxy(t *testing.T) {
 	t.Parallel()
-	log.SetOutput(ioutil.Discard)
 
 	name, rm, err := TempFile(".", exampleOrg)
 	if err != nil {

test/file_serve_test.go

 package test
 
 import (
-	"io/ioutil"
-	"log"
 	"testing"
 
 	"github.com/miekg/dns"
@@ -10,7 +8,6 @@ import (
 
 func TestZoneEDNS0Lookup(t *testing.T) {
 	t.Parallel()
-	log.SetOutput(ioutil.Discard)
 
 	name, rm, err := TempFile(".", `$ORIGIN example.org.
 @	3600 IN	SOA sns.dns.icann.org. noc.dns.icann.org. (
@@ -58,7 +55,6 @@ www     IN AAAA ::1
 
 func TestZoneNoNS(t *testing.T) {
 	t.Parallel()
-	log.SetOutput(ioutil.Discard)
 
 	name, rm, err := TempFile(".", `$ORIGIN example.org.
 @	3600 IN	SOA sns.dns.icann.org. noc.dns.icann.org. (

test/file_srv_additional_test.go

 package test
 
 import (
-	"io/ioutil"
-	"log"
 	"testing"
 
 	"github.com/coredns/coredns/plugin/proxy"
@@ -14,7 +12,6 @@ import (
 
 func TestZoneSRVAdditional(t *testing.T) {
 	t.Parallel()
-	log.SetOutput(ioutil.Discard)
 
 	name, rm, err := TempFile(".", exampleOrg)
 	if err != nil {

test/grpc_test.go

@@ -2,8 +2,6 @@ package test
 
 import (
 	"context"
-	"io/ioutil"
-	"log"
 	"testing"
 	"time"
 
@@ -14,8 +12,6 @@ import (
 )
 
 func TestGrpc(t *testing.T) {
-	log.SetOutput(ioutil.Discard)
-
 	corefile := `grpc://.:0 {
 		whoami
 }

test/hosts_file_test.go

 package test
 
 import (
-	"io/ioutil"
-	"log"
 	"testing"
 
 	"github.com/coredns/coredns/plugin/proxy"
@@ -26,8 +24,6 @@ func TestHostsInlineLookup(t *testing.T) {
 	}
 	defer i.Stop()
 
-	log.SetOutput(ioutil.Discard)
-
 	p := proxy.NewLookup([]string{udp})
 	state := request.Request{W: &test.ResponseWriter{}, Req: new(dns.Msg)}
 

test/log_test.go

+package test
+
+import clog "github.com/coredns/coredns/plugin/pkg/log"
+
+func init() { clog.Discard() }

test/metrics_test.go

@@ -2,7 +2,6 @@ package test
 
 import (
 	"io/ioutil"
-	"log"
 	"os"
 	"path"
 	"testing"
@@ -145,8 +144,6 @@ func TestMetricsAuto(t *testing.T) {
 	}
 	defer i.Stop()
 
-	log.SetOutput(ioutil.Discard)
-
 	// Write db.example.org to get example.org.
 	if err = ioutil.WriteFile(path.Join(tmpdir, "db.example.org"), []byte(zoneContent), 0644); err != nil {
 		t.Fatal(err)

test/plugin_dnssec_test.go

@@ -2,7 +2,6 @@ package test
 
 import (
 	"io/ioutil"
-	"log"
 	"os"
 	"testing"
 
@@ -36,7 +35,6 @@ func TestLookupBalanceRewriteCacheDnssec(t *testing.T) {
 	}
 	defer ex.Stop()
 
-	log.SetOutput(ioutil.Discard)
 	c := new(dns.Client)
 	m := new(dns.Msg)
 	m.SetQuestion("example.org.", dns.TypeA)

test/plugin_test.go

 package test
 
 import (
-	"io/ioutil"
-	"log"
 	"testing"
 
 	"github.com/coredns/coredns/plugin/test"
@@ -34,7 +32,6 @@ func benchmarkLookupBalanceRewriteCache(b *testing.B) {
 	}
 	defer ex.Stop()
 
-	log.SetOutput(ioutil.Discard)
 	c := new(dns.Client)
 	m := new(dns.Msg)
 	m.SetQuestion("example.org.", dns.TypeA)

test/proxy_health_test.go

 package test
 
 import (
-	"io/ioutil"
-	"log"
 	"testing"
 
 	"github.com/coredns/coredns/plugin/proxy"
@@ -13,8 +11,6 @@ import (
 )
 
 func TestProxyErratic(t *testing.T) {
-	log.SetOutput(ioutil.Discard)
-
 	corefile := `example.org:0 {
 		erratic {
 			drop 2
@@ -39,8 +35,7 @@ func TestProxyErratic(t *testing.T) {
 
 func TestProxyThreeWay(t *testing.T) {
 	// Run 3 CoreDNS server, 2 upstream ones and a proxy. 1 Upstream is unhealthy after 1 query, but after
-	// that we should still be able to send to the other one
-	log.SetOutput(ioutil.Discard)
+	// that we should still be able to send to the other one.
 
 	// Backend CoreDNS's.
 	corefileUp1 := `example.org:0 {

test/proxy_http_health_test.go

@@ -2,8 +2,6 @@ package test
 
 import (
 	"io"
-	"io/ioutil"
-	"log"
 	"net"
 	"net/http"
 	"net/http/httptest"
@@ -17,8 +15,6 @@ import (
 )
 
 func TestProxyWithHTTPCheckOK(t *testing.T) {
-	log.SetOutput(ioutil.Discard)
-
 	healthCheckServer := httptest.NewServer(http.HandlerFunc(
 		func(w http.ResponseWriter, r *http.Request) {
 			w.WriteHeader(http.StatusOK)

test/proxy_test.go

 package test
 
 import (
-	"io/ioutil"
-	"log"
 	"testing"
 
 	"github.com/coredns/coredns/plugin/proxy"
@@ -31,8 +29,6 @@ func TestLookupProxy(t *testing.T) {
 	}
 	defer i.Stop()
 
-	log.SetOutput(ioutil.Discard)
-
 	p := proxy.NewLookup([]string{udp})
 	state := request.Request{W: &test.ResponseWriter{}, Req: new(dns.Msg)}
 	resp, err := p.Lookup(state, "example.org.", dns.TypeA)
@@ -70,8 +66,6 @@ func TestLookupDnsWithForcedTcp(t *testing.T) {
 	}
 	defer i.Stop()
 
-	log.SetOutput(ioutil.Discard)
-
 	p := proxy.NewLookupWithOption([]string{tcp}, proxy.Options{ForceTCP: true})
 	state := request.Request{W: &test.ResponseWriter{}, Req: new(dns.Msg)}
 	resp, err := p.Lookup(state, "example.org.", dns.TypeA)
@@ -114,8 +108,6 @@ func BenchmarkProxyLookup(b *testing.B) {
 	}
 	defer i.Stop()
 
-	log.SetOutput(ioutil.Discard)
-
 	p := proxy.NewLookup([]string{udp})
 	state := request.Request{W: &test.ResponseWriter{}, Req: new(dns.Msg)}
 

test/readme_test.go

@@ -3,7 +3,6 @@ package test
 import (
 	"bufio"
 	"io/ioutil"
-	"log"
 	"os"
 	"path/filepath"
 	"strconv"
@@ -48,8 +47,6 @@ func TestReadme(t *testing.T) {
 	create(contents)
 	defer remove(contents)
 
-	log.SetOutput(ioutil.Discard)
-
 	middle := filepath.Join("..", "plugin")
 	dirs, err := ioutil.ReadDir(middle)
 	if err != nil {

test/reverse_test.go

 package test
 
 import (
-	"io/ioutil"
-	"log"
 	"testing"
 
 	"github.com/coredns/coredns/plugin/proxy"
@@ -28,8 +26,6 @@ func TestReverseCorefile(t *testing.T) {
 		t.Fatalf("Could not get UDP listening port")
 	}
 
-	log.SetOutput(ioutil.Discard)
-
 	p := proxy.NewLookup([]string{udp})
 	state := request.Request{W: &test.ResponseWriter{}, Req: new(dns.Msg)}
 	resp, err := p.Lookup(state, "17.0.0.10.in-addr.arpa.", dns.TypePTR)

test/rewrite_test.go

@@ -2,8 +2,6 @@ package test
 
 import (
 	"bytes"
-	"io/ioutil"
-	"log"
 	"testing"
 
 	"github.com/miekg/dns"
@@ -26,8 +24,6 @@ func TestRewrite(t *testing.T) {
 
 	defer i.Stop()
 
-	log.SetOutput(ioutil.Discard)
-
 	testMX(t, udp)
 	testEdns0(t, udp)
 }

test/server.go

 package test
 
 import (
-	"io/ioutil"
-	"log"
 	"sync"
 
 	"github.com/coredns/coredns/core/dnsserver"
@@ -21,7 +19,6 @@ func CoreDNSServer(corefile string) (*caddy.Instance, error) {
 	defer mu.Unlock()
 	caddy.Quiet = true
 	dnsserver.Quiet = true
-	log.SetOutput(ioutil.Discard)
 
 	return caddy.Start(NewInput(corefile))
 }

test/wildcard_test.go

 package test
 
 import (
-	"io/ioutil"
-	"log"
 	"testing"
 
 	"github.com/coredns/coredns/plugin/proxy"
@@ -31,8 +29,6 @@ func TestLookupWildcard(t *testing.T) {
 	}
 	defer i.Stop()
 
-	log.SetOutput(ioutil.Discard)
-
 	p := proxy.NewLookup([]string{udp})
 	state := request.Request{W: &test.ResponseWriter{}, Req: new(dns.Msg)}