github.com/netdata/go.d.plugin@v0.58.1/modules/dnsmasq/dnsmasq_test.go

// SPDX-License-Identifier: GPL-3.0-or-later

package dnsmasq

import (
	"errors"
	"fmt"
	"testing"
	"time"

	"github.com/miekg/dns"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
)

func TestNew(t *testing.T) {
	assert.IsType(t, (*Dnsmasq)(nil), New())
}

func TestDnsmasq_Init(t *testing.T) {
	tests := map[string]struct {
		config   Config
		wantFail bool
	}{
		"success on default config": {
			config: New().Config,
		},
		"fails on unset 'address'": {
			wantFail: true,
			config: Config{
				Protocol: "udp",
				Address:  "",
			},
		},
		"fails on unset 'protocol'": {
			wantFail: true,
			config: Config{
				Protocol: "",
				Address:  "127.0.0.1:53",
			},
		},
		"fails on invalid 'protocol'": {
			wantFail: true,
			config: Config{
				Protocol: "http",
				Address:  "127.0.0.1:53",
			},
		},
	}

	for name, test := range tests {
		t.Run(name, func(t *testing.T) {
			ns := New()
			ns.Config = test.config

			if test.wantFail {
				assert.False(t, ns.Init())
			} else {
				assert.True(t, ns.Init())
			}
		})
	}
}

func TestDnsmasq_Check(t *testing.T) {
	tests := map[string]struct {
		prepare  func() *Dnsmasq
		wantFail bool
	}{
		"success on valid response": {
			prepare: prepareOKDnsmasq,
		},
		"fails on error on cache stats query": {
			wantFail: true,
			prepare:  prepareErrorOnExchangeDnsmasq,
		},
		"fails on response rcode is not success": {
			wantFail: true,
			prepare:  prepareRcodeServerFailureOnExchangeDnsmasq,
		},
	}

	for name, test := range tests {
		t.Run(name, func(t *testing.T) {
			dnsmasq := test.prepare()
			require.True(t, dnsmasq.Init())

			if test.wantFail {
				assert.False(t, dnsmasq.Check())
			} else {
				assert.True(t, dnsmasq.Check())
			}
		})
	}
}

func TestDnsmasq_Charts(t *testing.T) {
	dnsmasq := New()
	require.True(t, dnsmasq.Init())
	assert.NotNil(t, dnsmasq.Charts())
}

func TestDnsmasq_Cleanup(t *testing.T) {
	assert.NotPanics(t, New().Cleanup)
}

func TestDnsmasq_Collect(t *testing.T) {
	tests := map[string]struct {
		prepare       func() *Dnsmasq
		wantCollected map[string]int64
	}{
		"success on valid response": {
			prepare: prepareOKDnsmasq,
			wantCollected: map[string]int64{
				//"auth":           5,
				"cachesize":      999,
				"evictions":      5,
				"failed_queries": 9,
				"hits":           100,
				"insertions":     10,
				"misses":         50,
				"queries":        17,
			},
		},
		"fails on error on cache stats query": {
			prepare: prepareErrorOnExchangeDnsmasq,
		},
		"fails on response rcode is not success": {
			prepare: prepareRcodeServerFailureOnExchangeDnsmasq,
		},
	}

	for name, test := range tests {
		t.Run(name, func(t *testing.T) {
			dnsmasq := test.prepare()
			require.True(t, dnsmasq.Init())

			collected := dnsmasq.Collect()

			assert.Equal(t, test.wantCollected, collected)
			if len(test.wantCollected) > 0 {
				ensureCollectedHasAllChartsDimsVarsIDs(t, dnsmasq, collected)
			}
		})
	}
}

func ensureCollectedHasAllChartsDimsVarsIDs(t *testing.T, dnsmasq *Dnsmasq, collected map[string]int64) {
	for _, chart := range *dnsmasq.Charts() {
		if chart.Obsolete {
			continue
		}
		for _, dim := range chart.Dims {
			_, ok := collected[dim.ID]
			assert.Truef(t, ok, "chart '%s' dim '%s': no dim in collected", dim.ID, chart.ID)
		}
		for _, v := range chart.Vars {
			_, ok := collected[v.ID]
			assert.Truef(t, ok, "chart '%s' dim '%s': no dim in collected", v.ID, chart.ID)
		}
	}
}

func prepareOKDnsmasq() *Dnsmasq {
	dnsmasq := New()
	dnsmasq.newDNSClient = func(network string, timeout time.Duration) dnsClient {
		return &mockDNSClient{}
	}
	return dnsmasq
}

func prepareErrorOnExchangeDnsmasq() *Dnsmasq {
	dnsmasq := New()
	dnsmasq.newDNSClient = func(network string, timeout time.Duration) dnsClient {
		return &mockDNSClient{
			errOnExchange: true,
		}
	}
	return dnsmasq
}

func prepareRcodeServerFailureOnExchangeDnsmasq() *Dnsmasq {
	dnsmasq := New()
	dnsmasq.newDNSClient = func(network string, timeout time.Duration) dnsClient {
		return &mockDNSClient{
			rcodeServerFailureOnExchange: true,
		}
	}
	return dnsmasq
}

type mockDNSClient struct {
	errOnExchange                bool
	rcodeServerFailureOnExchange bool
}

func (m mockDNSClient) Exchange(msg *dns.Msg, _ string) (*dns.Msg, time.Duration, error) {
	if m.errOnExchange {
		return nil, 0, errors.New("'Exchange' error")
	}
	if m.rcodeServerFailureOnExchange {
		resp := &dns.Msg{MsgHdr: dns.MsgHdr{Rcode: dns.RcodeServerFailure}}
		return resp, 0, nil
	}

	var answers []dns.RR
	for _, q := range msg.Question {
		a, err := prepareDNSAnswer(q)
		if err != nil {
			return nil, 0, err
		}
		answers = append(answers, a)
	}

	resp := &dns.Msg{
		MsgHdr: dns.MsgHdr{
			Rcode: dns.RcodeSuccess,
		},
		Answer: answers,
	}
	return resp, 0, nil
}

func prepareDNSAnswer(q dns.Question) (dns.RR, error) {
	if want, got := dns.TypeToString[dns.TypeTXT], dns.TypeToString[q.Qtype]; want != got {
		return nil, fmt.Errorf("unexpected Qtype, want=%s, got=%s", want, got)
	}
	if want, got := dns.ClassToString[dns.ClassCHAOS], dns.ClassToString[q.Qclass]; want != got {
		return nil, fmt.Errorf("unexpected Qclass, want=%s, got=%s", want, got)
	}

	var txt []string
	switch q.Name {
	case "cachesize.bind.":
		txt = []string{"999"}
	case "insertions.bind.":
		txt = []string{"10"}
	case "evictions.bind.":
		txt = []string{"5"}
	case "hits.bind.":
		txt = []string{"100"}
	case "misses.bind.":
		txt = []string{"50"}
	case "auth.bind.":
		txt = []string{"5"}
	case "servers.bind.":
		txt = []string{"10.0.0.1#53 10 5", "1.1.1.1#53 4 3", "1.0.0.1#53 3 1"}
	default:
		return nil, fmt.Errorf("unexpected question Name: %s", q.Name)
	}

	rr := &dns.TXT{
		Hdr: dns.RR_Header{
			Name:   q.Name,
			Rrtype: dns.TypeTXT,
			Class:  dns.ClassCHAOS,
		},
		Txt: txt,
	}
	return rr, nil
}