Documentation
¶
Overview ¶
Package test contains helper functions for writing plugin tests.
Package test will scrape a target and you can inspect the variables. Basic usage:
result := Scrape("http://localhost:9153/metrics") v := MetricValue("coredns_cache_capacity", result)
Index ¶
- Constants
- func A(rr string) *dns.A
- func AAAA(rr string) *dns.AAAA
- func CNAME(rr string) *dns.CNAME
- func CNAMEOrder(res *dns.Msg) error
- func DNAME(rr string) *dns.DNAME
- func DNSKEY(rr string) *dns.DNSKEY
- func DS(rr string) *dns.DS
- func HINFO(rr string) *dns.HINFO
- func Header(tc Case, resp *dns.Msg) error
- func MX(rr string) *dns.MX
- func MetricValue(name string, mfs []*MetricFamily) (string, map[string]string)
- func MetricValueLabel(name, label string, mfs []*MetricFamily) (string, map[string]string)
- 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 ScrapeMetricAsInt(addr string, name string, label string, nometricvalue int) int
- func Section(tc Case, sec sect, rr []dns.RR) error
- func SortAndCheck(resp *dns.Msg, tc Case) error
- func TXT(rr string) *dns.TXT
- func TempFile(dir, content string) (string, func(), error)
- func WritePEMFiles(dir string) (string, func(), error)
- type Case
- type Handler
- type HandlerFunc
- type MetricFamily
- type RRSet
- 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
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 )
Variables ¶
This section is empty.
Functions ¶
func CNAMEOrder ¶
CNAMEOrder makes sure that CNAMES do not appear after their target records
func MetricValue ¶ added in v1.4.0
func MetricValue(name string, mfs []*MetricFamily) (string, map[string]string)
MetricValue returns the value associated with name as a string as well as the labels. It only returns the first metrics of the slice.
func MetricValueLabel ¶ added in v1.4.0
func MetricValueLabel(name, label string, mfs []*MetricFamily) (string, map[string]string)
MetricValueLabel returns the value for name *and* label *value*.
func ScrapeMetricAsInt ¶ added in v1.4.0
ScrapeMetricAsInt provide a sum of all metrics collected for the name and label provided. if the metric is not a numeric value, it will be counted a 0.
func SortAndCheck ¶
SortAndCheck sorts resp and the checks the header and three sections against the testcase in tc.
func TempFile ¶
TempFile will create a temporary file on disk and returns the name and a cleanup function to remove it later.
func WritePEMFiles ¶
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.
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 ¶
NextHandler returns a Handler that returns rcode and err.
type HandlerFunc ¶
HandlerFunc is a convenience type like dns.HandlerFunc, except ServeDNS returns an rcode and an error.
type MetricFamily ¶ added in v1.4.0
type MetricFamily struct { Name string `json:"name"` Help string `json:"help"` Type string `json:"type"` Metrics []interface{} `json:"metrics,omitempty"` // Either metric or summary. }
MetricFamily holds a prometheus metric.
func Scrape ¶ added in v1.4.0
func Scrape(url string) []*MetricFamily
Scrape returns the all the vars a []*metricFamily.
type ResponseWriter ¶
type ResponseWriter struct { TCP bool // if TCP is true we return an TCP connection instead of an UDP one. RemoteIP string }
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, 127.0.0.1:53 (UDP, TCP if t.TCP is true).
func (*ResponseWriter) RemoteAddr ¶
func (t *ResponseWriter) RemoteAddr() net.Addr
RemoteAddr returns the remote address, defaults to 10.240.0.1:40212 (UDP, TCP is t.TCP is true).
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.
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, TCP is t.TCP is true).
func (*ResponseWriter6) RemoteAddr ¶
func (t *ResponseWriter6) RemoteAddr() net.Addr
RemoteAddr returns the remote address, always fe80::42:ff:feca:4c65 port 40212 (UDP, TCP is t.TCP is true).