coredns/plugin/dnstap/handler_test.go

package dnstap

import (
	"context"
	"net"
	"testing"

	"github.com/coredns/coredns/plugin/dnstap/msg"
	"github.com/coredns/coredns/plugin/metadata"
	test "github.com/coredns/coredns/plugin/test"

	tap "github.com/dnstap/golang-dnstap"
	"github.com/miekg/dns"
)

func testCase(t *testing.T, tapq, tapr *tap.Dnstap, q, r *dns.Msg, extraFormat string) {
	t.Helper()
	w := writer{t: t}
	w.queue = append(w.queue, tapq, tapr)
	h := Dnstap{
		Next: test.HandlerFunc(func(_ context.Context,
			w dns.ResponseWriter, _ *dns.Msg) (int, error) {
			return 0, w.WriteMsg(r)
		}),
		io:          &w,
		ExtraFormat: extraFormat,
	}
	ctx := metadata.ContextWithMetadata(context.TODO())
	ok := metadata.SetValueFunc(ctx, "metadata/test", func() string {
		return "MetadataValue"
	})
	if !ok {
		t.Fatal("Failed to set metadata")
	}
	_, err := h.ServeDNS(ctx, &test.ResponseWriter{}, q)
	if err != nil {
		t.Fatal(err)
	}
}

type writer struct {
	t     *testing.T
	queue []*tap.Dnstap
}

func (w *writer) Dnstap(e *tap.Dnstap) {
	if len(w.queue) == 0 {
		w.t.Error("Message not expected")
	}

	ex := w.queue[0].GetMessage()
	got := e.GetMessage()

	eaddr := string(ex.GetQueryAddress())
	gaddr := string(got.GetQueryAddress())
	if eaddr != gaddr {
		w.t.Errorf("Expected source address %s, got %s", eaddr, gaddr)
	}

	eraddr := string(ex.GetResponseAddress())
	graddr := string(got.GetResponseAddress())
	if eraddr != graddr {
		w.t.Errorf("Expected response address %s, got %s", eraddr, graddr)
	}

	ep := ex.GetQueryPort()
	gp := got.GetQueryPort()
	if ep != gp {
		w.t.Errorf("Expected port %d, got %d", ep, gp)
	}

	ef := ex.GetSocketFamily()
	sf := got.GetSocketFamily()
	if ef != sf {
		w.t.Errorf("Expected socket family %d, got %d", ef, sf)
	}

	eext := string(w.queue[0].GetExtra())
	gext := string(e.GetExtra())
	if eext != gext {
		w.t.Errorf("Expected extra %s, got %s", eext, gext)
	}
	w.queue = w.queue[1:]
}

func TestDnstap(t *testing.T) {
	q := test.Case{Qname: "example.org", Qtype: dns.TypeA}.Msg()
	r := test.Case{
		Qname: "example.org.", Qtype: dns.TypeA,
		Answer: []dns.RR{
			test.A("example.org. 3600	IN	A 10.0.0.1"),
		},
	}.Msg()

	tapq := &tap.Dnstap{
		Message: testMessage(),
	}
	msg.SetType(tapq.GetMessage(), tap.Message_CLIENT_QUERY)
	tapr := &tap.Dnstap{
		Message: testMessage(),
	}
	msg.SetType(tapr.GetMessage(), tap.Message_CLIENT_RESPONSE)
	testCase(t, tapq, tapr, q, r, "")

	tapq_with_extra := &tap.Dnstap{
		Message: testMessage(), // leave type unset for deepEqual
		Extra:   []byte("extra_field_MetadataValue_A_example.org._IN_udp_29_10.240.0.1_40212_127.0.0.1"),
	}
	msg.SetType(tapq_with_extra.GetMessage(), tap.Message_CLIENT_QUERY)
	tapr_with_extra := &tap.Dnstap{
		Message: testMessage(),
		Extra:   []byte("extra_field_MetadataValue_A_example.org._IN_udp_29_10.240.0.1_40212_127.0.0.1"),
	}
	msg.SetType(tapr_with_extra.GetMessage(), tap.Message_CLIENT_RESPONSE)
	extraFormat := "extra_field_{/metadata/test}_{type}_{name}_{class}_{proto}_{size}_{remote}_{port}_{local}"
	testCase(t, tapq_with_extra, tapr_with_extra, q, r, extraFormat)
}

func testMessage() *tap.Message {
	inet := tap.SocketFamily_INET
	udp := tap.SocketProtocol_UDP
	port := uint32(40212)
	return &tap.Message{
		SocketFamily:   &inet,
		SocketProtocol: &udp,
		// Explicit 4-octet form, because that's the expected dnstap message representation when SocketFamily is INET.
		QueryAddress: net.ParseIP("10.240.0.1").To4(),
		QueryPort:    &port,
	}
}

func TestTapMessage(t *testing.T) {
	extraFormat := "extra_field_no_replacement_{/metadata/test}_{type}_{name}_{class}_{proto}_{size}_{remote}_{port}_{local}"
	tapq := &tap.Dnstap{
		Message: testMessage(),
		// extra field would not be replaced, since TapMessage won't pass context
		Extra: []byte(extraFormat),
	}
	msg.SetType(tapq.GetMessage(), tap.Message_CLIENT_QUERY)

	w := writer{t: t}
	w.queue = append(w.queue, tapq)
	h := Dnstap{
		Next: test.HandlerFunc(func(_ context.Context,
			w dns.ResponseWriter, r *dns.Msg) (int, error) {
			return 0, w.WriteMsg(r)
		}),
		io:          &w,
		ExtraFormat: extraFormat,
	}
	h.TapMessage(tapq.GetMessage())
}

// TestNilIoAndListener tests that the handler works correctly when io or listener is nil
func TestNilIoAndListener(t *testing.T) {
	testMsg := testMessage()
	msg.SetType(testMsg, tap.Message_CLIENT_QUERY)

	// Test with nil io (listener-only mode)
	h1 := Dnstap{
		io:       nil,
		listener: nil,
	}
	// Should not panic
	h1.TapMessage(testMsg)

	// Test with only io set
	w := &writer{t: t}
	tapq := &tap.Dnstap{Message: testMsg}
	w.queue = append(w.queue, tapq)
	h2 := Dnstap{
		io:       w,
		listener: nil,
	}
	h2.TapMessage(testMsg)
	if len(w.queue) != 0 {
		t.Errorf("Expected io to receive message")
	}
}

// collectTapper records every dnstap payload it receives so a test can inspect
// the sequence and contents of the emitted messages.
type collectTapper struct {
	msgs []*tap.Dnstap
}

func (c *collectTapper) Dnstap(e *tap.Dnstap) { c.msgs = append(c.msgs, e) }

func TestDnstapDeferredError(t *testing.T) {
	// When the plugin chain returns an error rcode without writing a response,
	// the server generates and sends the error to the client after dnstap's
	// ServeDNS returns, so ResponseWriter.WriteMsg is never called. dnstap must
	// still emit a CLIENT_RESPONSE reflecting that deferred error, otherwise a
	// dnstap stream shows a CLIENT_QUERY with no matching CLIENT_RESPONSE (#6532).
	q := test.Case{Qname: "example.org.", Qtype: dns.TypeA}.Msg()

	c := &collectTapper{}
	h := Dnstap{
		Next: test.HandlerFunc(func(_ context.Context, _ dns.ResponseWriter, _ *dns.Msg) (int, error) {
			// Return an error rcode WITHOUT calling WriteMsg, deferring the
			// response to the server (as e.g. an unmatched plugin/auto does).
			return dns.RcodeServerFailure, nil
		}),
		io:                c,
		IncludeRawMessage: true,
	}

	rcode, err := h.ServeDNS(context.TODO(), &test.ResponseWriter{}, q)
	if err != nil {
		t.Fatalf("ServeDNS returned error: %v", err)
	}
	if rcode != dns.RcodeServerFailure {
		t.Fatalf("expected rcode SERVFAIL, got %d", rcode)
	}

	if len(c.msgs) != 2 {
		t.Fatalf("expected 2 dnstap messages (CLIENT_QUERY + CLIENT_RESPONSE), got %d", len(c.msgs))
	}
	if got := c.msgs[0].GetMessage().GetType(); got != tap.Message_CLIENT_QUERY {
		t.Errorf("first message: expected CLIENT_QUERY, got %v", got)
	}
	respMsg := c.msgs[1].GetMessage()
	if got := respMsg.GetType(); got != tap.Message_CLIENT_RESPONSE {
		t.Fatalf("second message: expected CLIENT_RESPONSE, got %v", got)
	}
	unpacked := new(dns.Msg)
	if err := unpacked.Unpack(respMsg.GetResponseMessage()); err != nil {
		t.Fatalf("failed to unpack tapped CLIENT_RESPONSE: %v", err)
	}
	if unpacked.Rcode != dns.RcodeServerFailure {
		t.Errorf("expected SERVFAIL in tapped response, got %s", dns.RcodeToString[unpacked.Rcode])
	}
}