aghtest

Documentation

Overview

Package aghtest contains utilities for testing.

Index

• Constants
• func MatchedResponse(req *dns.Msg, qt uint16, targ, answer string) (resp *dns.Msg)
• func ReplaceLogLevel(t testing.TB, l log.Level)
• func ReplaceLogWriter(t testing.TB, w io.Writer)
• type FS
  • func (fsys *FS) Open(name string) (fs.File, error)
• type FSWatcher
  • func (w *FSWatcher) Add(name string) (err error)
  • func (w *FSWatcher) Close() (err error)
  • func (w *FSWatcher) Events() (e <-chan struct{})
• type GlobFS
  • func (fsys *GlobFS) Glob(pattern string) ([]string, error)
• type Listener
  • func (l *Listener) Accept() (conn net.Conn, err error)
  • func (l *Listener) Addr() (addr net.Addr)
  • func (l *Listener) Close() (err error)
• type ServiceWithConfig
  • func (s *ServiceWithConfig[ConfigType]) Config() (c ConfigType)
  • func (s *ServiceWithConfig[_]) Shutdown(ctx context.Context) (err error)
  • func (s *ServiceWithConfig[_]) Start() (err error)
• type StatFS
  • func (fsys *StatFS) Stat(name string) (fs.FileInfo, error)
• type TestResolver
  • func (r *TestResolver) Counter() int
  • func (r *TestResolver) HostToIPs(host string) (ipv4, ipv6 net.IP)
  • func (r *TestResolver) LookupHost(host string) (addrs []string, err error)
  • func (r *TestResolver) LookupIP(_ context.Context, _, host string) (ips []net.IP, err error)
• type Upstream
  • func (u *Upstream) Address() string
  • func (u *Upstream) Close() (err error)
  • func (u *Upstream) Exchange(m *dns.Msg) (resp *dns.Msg, err error)
• type UpstreamMock
  • func NewBlockUpstream(hostname string, shouldBlock bool) (u *UpstreamMock)
  • func NewErrorUpstream() (u *UpstreamMock)
  • func NewUpstreamMock(onExc func(req *dns.Msg) (resp *dns.Msg, err error)) (u *UpstreamMock)
  • func (u *UpstreamMock) Address() (addr string)
  • func (u *UpstreamMock) Close() (err error)
  • func (u *UpstreamMock) Exchange(req *dns.Msg) (resp *dns.Msg, err error)

Constants

const ErrUpstream errors.Error = "test upstream error"

ErrUpstream is the error returned from the *UpstreamMock created by NewErrorUpstream.

Functions

func MatchedResponse

func MatchedResponse(req *dns.Msg, qt uint16, targ, answer string) (resp *dns.Msg)

MatchedResponse is a test helper that returns a response with answer if req has question type qt, and target targ. Otherwise, it returns nil.

req must not be nil and req.Question must have a length of 1. Answer is interpreted in the following ways:

• For A and AAAA queries, answer must be an IP address of the corresponding protocol version.

• For PTR queries, answer should be a domain name in the response.

If the answer does not correspond to the question type, MatchedResponse panics. Panics are used instead of testing.TB, because the helper is intended to use in [UpstreamMock.OnExchange] callbacks, which are usually called in a separate goroutine.

TODO(a.garipov): Consider adding version with DNS class as well.

func ReplaceLogLevel

func ReplaceLogLevel(t testing.TB, l log.Level)

ReplaceLogLevel sets logging level to l and uses Cleanup method of t to revert changes.

func ReplaceLogWriter

func ReplaceLogWriter(t testing.TB, w io.Writer)

ReplaceLogWriter moves logger output to w and uses Cleanup method of t to revert changes.

Types

type FS

type FS struct {
	OnOpen func(name string) (fs.File, error)
}

FS is a mock fs.FS implementation for tests.

func (*FS) Open

func (fsys *FS) Open(name string) (fs.File, error)

Open implements the fs.FS interface for *FS.

type FSWatcher

type FSWatcher struct {
	OnEvents func() (e <-chan struct{})
	OnAdd    func(name string) (err error)
	OnClose  func() (err error)
}

FSWatcher is a mock aghos.FSWatcher implementation for tests.

func (*FSWatcher) Add

func (w *FSWatcher) Add(name string) (err error)

Add implements the aghos.FSWatcher interface for *FSWatcher.

func (*FSWatcher) Close

func (w *FSWatcher) Close() (err error)

Close implements the aghos.FSWatcher interface for *FSWatcher.

func (*FSWatcher) Events

func (w *FSWatcher) Events() (e <-chan struct{})

Events implements the aghos.FSWatcher interface for *FSWatcher.

type GlobFS

type GlobFS struct {
	// FS is embedded here to avoid implementing all it's methods.
	FS
	OnGlob func(pattern string) ([]string, error)
}

GlobFS is a mock fs.GlobFS implementation for tests.

func (*GlobFS) Glob

func (fsys *GlobFS) Glob(pattern string) ([]string, error)

Glob implements the fs.GlobFS interface for *GlobFS.

type Listener

type Listener struct {
	OnAccept func() (conn net.Conn, err error)
	OnAddr   func() (addr net.Addr)
	OnClose  func() (err error)
}

Listener is a mock net.Listener implementation for tests.

func (*Listener) Accept

func (l *Listener) Accept() (conn net.Conn, err error)

Accept implements the net.Listener interface for *Listener.

func (*Listener) Addr

func (l *Listener) Addr() (addr net.Addr)

Addr implements the net.Listener interface for *Listener.

func (*Listener) Close

func (l *Listener) Close() (err error)

Close implements the net.Listener interface for *Listener.

type ServiceWithConfig

type ServiceWithConfig[ConfigType any] struct {
	OnStart    func() (err error)
	OnShutdown func(ctx context.Context) (err error)
	OnConfig   func() (c ConfigType)
}

ServiceWithConfig is a mock agh.ServiceWithConfig implementation for tests.

func (*ServiceWithConfig[ConfigType]) Config

func (s *ServiceWithConfig[ConfigType]) Config() (c ConfigType)

Config implements the agh.ServiceWithConfig interface for *ServiceWithConfig.

func (*ServiceWithConfig[_]) Shutdown

func (s *ServiceWithConfig[_]) Shutdown(ctx context.Context) (err error)

Shutdown implements the agh.ServiceWithConfig interface for *ServiceWithConfig.

func (*ServiceWithConfig[_]) Start

func (s *ServiceWithConfig[_]) Start() (err error)

Start implements the agh.ServiceWithConfig interface for *ServiceWithConfig.

type StatFS

type StatFS struct {
	// FS is embedded here to avoid implementing all it's methods.
	FS
	OnStat func(name string) (fs.FileInfo, error)
}

StatFS is a mock fs.StatFS implementation for tests.

func (*StatFS) Stat

func (fsys *StatFS) Stat(name string) (fs.FileInfo, error)

Stat implements the fs.StatFS interface for *StatFS.

type TestResolver

type TestResolver struct {
	// contains filtered or unexported fields
}

TestResolver is a Resolver for tests.

func (*TestResolver) Counter

func (r *TestResolver) Counter() int

Counter returns the number of requests handled.

func (*TestResolver) HostToIPs

func (r *TestResolver) HostToIPs(host string) (ipv4, ipv6 net.IP)

HostToIPs generates IPv4 and IPv6 from host.

func (*TestResolver) LookupHost

func (r *TestResolver) LookupHost(host string) (addrs []string, err error)

LookupHost implements Resolver interface for *testResolver. It returns the slice of IPv4 and IPv6 instances converted to strings.

func (*TestResolver) LookupIP

func (r *TestResolver) LookupIP(_ context.Context, _, host string) (ips []net.IP, err error)

LookupIP implements Resolver interface for *testResolver. It returns the slice of net.IP with IPv4 and IPv6 instances.

type Upstream

type Upstream struct {
	// CName is a map of hostname to canonical name.
	CName map[string][]string
	// IPv4 is a map of hostname to IPv4.
	IPv4 map[string][]net.IP
	// IPv6 is a map of hostname to IPv6.
	IPv6 map[string][]net.IP
}

Upstream is a mock implementation of upstream.Upstream.

TODO(a.garipov): Replace with UpstreamMock and rename it to just Upstream.

func (*Upstream) Address

func (u *Upstream) Address() string

Address implements upstream.Upstream interface for *Upstream.

func (*Upstream) Close

func (u *Upstream) Close() (err error)

Close implements upstream.Upstream interface for *Upstream.

func (*Upstream) Exchange

func (u *Upstream) Exchange(m *dns.Msg) (resp *dns.Msg, err error)

Exchange implements the upstream.Upstream interface for *Upstream.

TODO(a.garipov): Split further into handlers.

type UpstreamMock

type UpstreamMock struct {
	OnAddress  func() (addr string)
	OnExchange func(req *dns.Msg) (resp *dns.Msg, err error)
	OnClose    func() (err error)
}

UpstreamMock is a mock upstream.Upstream implementation for tests.

TODO(a.garipov): Replace with all uses of Upstream with UpstreamMock and rename it to just Upstream.

func NewBlockUpstream

func NewBlockUpstream(hostname string, shouldBlock bool) (u *UpstreamMock)

NewBlockUpstream returns an *UpstreamMock that works like an upstream that supports hash-based safe-browsing/adult-blocking feature. If shouldBlock is true, hostname's actual hash is returned, blocking it. Otherwise, it returns a different hash.

func NewErrorUpstream

func NewErrorUpstream() (u *UpstreamMock)

NewErrorUpstream returns an *UpstreamMock that returns ErrUpstream from its Exchange method.

func NewUpstreamMock

func NewUpstreamMock(onExc func(req *dns.Msg) (resp *dns.Msg, err error)) (u *UpstreamMock)

NewUpstreamMock returns an *UpstreamMock, fields OnAddress and OnClose of which are set to stubs that return "upstream.example" and nil respectively. The field OnExchange is set to onExc.

func (*UpstreamMock) Address

func (u *UpstreamMock) Address() (addr string)

Address implements the upstream.Upstream interface for *UpstreamMock.

func (*UpstreamMock) Close

func (u *UpstreamMock) Close() (err error)

Close implements the upstream.Upstream interface for *UpstreamMock.

func (*UpstreamMock) Exchange

func (u *UpstreamMock) Exchange(req *dns.Msg) (resp *dns.Msg, err error)

Exchange implements the upstream.Upstream interface for *UpstreamMock.