test

Documentation

Overview

Package test contains helper functions for writing plugin tests.

Index

• Constants
• func A(rr string) *dns.A
• func AAAA(rr string) *dns.AAAA
• func CNAME(rr string) *dns.CNAME
• func CNAMEOrder(t *testing.T, res *dns.Msg)
• func DNAME(rr string) *dns.DNAME
• func DNSKEY(rr string) *dns.DNSKEY
• func DS(rr string) *dns.DS
• func Header(t *testing.T, tc Case, resp *dns.Msg) bool
• func MX(rr string) *dns.MX
• func NS(rr string) *dns.NS
• func NSEC(rr string) *dns.NSEC
• func OPT(bufsize int, do bool) *dns.OPT
• func PTR(rr string) *dns.PTR
• func RRSIG(rr string) *dns.RRSIG
• func SOA(rr string) *dns.SOA
• func SRV(rr string) *dns.SRV
• func Section(t *testing.T, tc Case, sec sect, rr []dns.RR) bool
• func SortAndCheck(t *testing.T, resp *dns.Msg, tc Case)
• func TCPServer(laddr string) (*dns.Server, string, error)
• func TXT(rr string) *dns.TXT
• func TempFile(dir, content string) (string, func(), error)
• func UDPServer(laddr string) (*dns.Server, string, error)
• func WritePEMFiles(dir string) (string, func(), error)
• type Case
  • func (c Case) Msg() *dns.Msg
• type Handler
  • func ErrorHandler() Handler
  • func NextHandler(rcode int, err error) Handler
• type HandlerFunc
  • func (f HandlerFunc) Name() string
  • func (f HandlerFunc) ServeDNS(ctx context.Context, w dns.ResponseWriter, r *dns.Msg) (int, error)
• type RRSet
  • func (p RRSet) Len() int
  • func (p RRSet) Less(i, j int) bool
  • func (p RRSet) Swap(i, j int)
• type ResponseWriter
  • func (t *ResponseWriter) Close() error
  • func (t *ResponseWriter) Hijack()
  • func (t *ResponseWriter) LocalAddr() net.Addr
  • func (t *ResponseWriter) RemoteAddr() net.Addr
  • func (t *ResponseWriter) TsigStatus() error
  • func (t *ResponseWriter) TsigTimersOnly(bool)
  • func (t *ResponseWriter) Write(buf []byte) (int, error)
  • func (t *ResponseWriter) WriteMsg(m *dns.Msg) error
• type ResponseWriter6
  • func (t *ResponseWriter6) LocalAddr() net.Addr
  • func (t *ResponseWriter6) RemoteAddr() net.Addr

Constants

const (
	// Answer is the answer section in an Msg.
	Answer sect = iota
	// Ns is the authoritative section in an Msg.
	Ns
	// Extra is the additional section in an Msg.
	Extra
)

Functions

func A

func A(rr string) *dns.A

A returns an A record from rr. It panics on errors.

func AAAA

func AAAA(rr string) *dns.AAAA

AAAA returns an AAAA record from rr. It panics on errors.

func CNAME

func CNAME(rr string) *dns.CNAME

CNAME returns a CNAME record from rr. It panics on errors.

func CNAMEOrder

func CNAMEOrder(t *testing.T, res *dns.Msg)

CNAMEOrder makes sure that CNAMES do not appear after their target records

func DNAME

func DNAME(rr string) *dns.DNAME

DNAME returns a DNAME record from rr. It panics on errors.

func DNSKEY

func DNSKEY(rr string) *dns.DNSKEY

DNSKEY returns a DNSKEY record from rr. It panics on errors.

func DS

func DS(rr string) *dns.DS

DS returns a DS record from rr. It panics on errors.

func Header

func Header(t *testing.T, tc Case, resp *dns.Msg) bool

Header test if the header in resp matches the header as defined in tc.

func MX

func MX(rr string) *dns.MX

MX returns an MX record from rr. It panics on errors.

func NS

func NS(rr string) *dns.NS

NS returns an NS record from rr. It panics on errors.

func NSEC

func NSEC(rr string) *dns.NSEC

NSEC returns an NSEC record from rr. It panics on errors.

func OPT

func OPT(bufsize int, do bool) *dns.OPT

OPT returns an OPT record with UDP buffer size set to bufsize and the DO bit set to do.

func PTR

func PTR(rr string) *dns.PTR

PTR returns a PTR record from rr. It panics on errors.

func RRSIG

func RRSIG(rr string) *dns.RRSIG

RRSIG returns an RRSIG record from rr. It panics on errors.

func SOA

func SOA(rr string) *dns.SOA

SOA returns a SOA record from rr. It panics on errors.

func SRV

func SRV(rr string) *dns.SRV

SRV returns a SRV record from rr. It panics on errors.

func Section

func Section(t *testing.T, tc Case, sec sect, rr []dns.RR) bool

Section tests if the the section in tc matches rr.

func SortAndCheck

func SortAndCheck(t *testing.T, resp *dns.Msg, tc Case)

SortAndCheck sorts resp and the checks the header and three sections against the testcase in tc.

func TCPServer

func TCPServer(laddr string) (*dns.Server, string, error)

TCPServer starts a DNS server with a TCP listener on laddr.

func TXT

func TXT(rr string) *dns.TXT

TXT returns a TXT record from rr. It panics on errors.

func TempFile

func TempFile(dir, content string) (string, func(), error)

TempFile will create a temporary file on disk and returns the name and a cleanup function to remove it later.

func UDPServer

func UDPServer(laddr string) (*dns.Server, string, error)

UDPServer starts a DNS server with an UDP listener on laddr.

func WritePEMFiles

func WritePEMFiles(dir string) (string, func(), error)

WritePEMFiles creates a tmp dir with ca.pem, cert.pem, and key.pem and the func to remove it

Types

type Case

type Case struct {
	Qname  string
	Qtype  uint16
	Rcode  int
	Do     bool
	Answer []dns.RR
	Ns     []dns.RR
	Extra  []dns.RR
	Error  error
}

Case represents a test case that encapsulates various data from a query and response. Note that is the TTL of a record is 303 we don't compare it with the TTL.

func (Case) Msg

func (c Case) Msg() *dns.Msg

Msg returns a *dns.Msg embedded in c.

type Handler

type Handler interface {
	ServeDNS(context.Context, dns.ResponseWriter, *dns.Msg) (int, error)
	Name() string
}

Handler interface defines a plugin.

func ErrorHandler

func ErrorHandler() Handler

ErrorHandler returns a Handler that returns ServerFailure error when called.

func NextHandler

func NextHandler(rcode int, err error) Handler

NextHandler returns a Handler that returns rcode and err.

type HandlerFunc

type HandlerFunc func(context.Context, dns.ResponseWriter, *dns.Msg) (int, error)

HandlerFunc is a convenience type like dns.HandlerFunc, except ServeDNS returns an rcode and an error.

func (HandlerFunc) Name

func (f HandlerFunc) Name() string

Name implements the Handler interface.

func (HandlerFunc) ServeDNS

func (f HandlerFunc) ServeDNS(ctx context.Context, w dns.ResponseWriter, r *dns.Msg) (int, error)

ServeDNS implements the Handler interface.

type RRSet

type RRSet []dns.RR

RRSet represents a list of RRs.

func (RRSet) Len

func (p RRSet) Len() int

func (RRSet) Less

func (p RRSet) Less(i, j int) bool

func (RRSet) Swap

func (p RRSet) Swap(i, j int)

type ResponseWriter

type ResponseWriter struct{}

ResponseWriter is useful for writing tests. It uses some fixed values for the client. The remote will always be 10.240.0.1 and port 40212. The local address is always 127.0.0.1 and port 53.

func (*ResponseWriter) Close

func (t *ResponseWriter) Close() error

Close implement dns.ResponseWriter interface.

func (*ResponseWriter) Hijack

func (t *ResponseWriter) Hijack()

Hijack implement dns.ResponseWriter interface.

func (*ResponseWriter) LocalAddr

func (t *ResponseWriter) LocalAddr() net.Addr

LocalAddr returns the local address, always 127.0.0.1:53 (UDP).

func (*ResponseWriter) RemoteAddr

func (t *ResponseWriter) RemoteAddr() net.Addr

RemoteAddr returns the remote address, always 10.240.0.1:40212 (UDP).

func (*ResponseWriter) TsigStatus

func (t *ResponseWriter) TsigStatus() error

TsigStatus implement dns.ResponseWriter interface.

func (*ResponseWriter) TsigTimersOnly

func (t *ResponseWriter) TsigTimersOnly(bool)

TsigTimersOnly implement dns.ResponseWriter interface.

func (*ResponseWriter) Write

func (t *ResponseWriter) Write(buf []byte) (int, error)

Write implement dns.ResponseWriter interface.

func (*ResponseWriter) WriteMsg

func (t *ResponseWriter) WriteMsg(m *dns.Msg) error

WriteMsg implement dns.ResponseWriter interface.

type ResponseWriter6

type ResponseWriter6 struct {
	ResponseWriter
}

ResponseWriter6 returns fixed client and remote address in IPv6. The remote address is always fe80::42:ff:feca:4c65 and port 40212. The local address is always ::1 and port 53.

func (*ResponseWriter6) LocalAddr

func (t *ResponseWriter6) LocalAddr() net.Addr

LocalAddr returns the local address, always ::1, port 53 (UDP).

func (*ResponseWriter6) RemoteAddr

func (t *ResponseWriter6) RemoteAddr() net.Addr

RemoteAddr returns the remote address, always fe80::42:ff:feca:4c65 port 40212 (UDP).