diff options
Diffstat (limited to '')
-rw-r--r-- | src/go/collectors/go.d.plugin/modules/dnsquery/dnsquery_test.go | 242 |
1 files changed, 242 insertions, 0 deletions
diff --git a/src/go/collectors/go.d.plugin/modules/dnsquery/dnsquery_test.go b/src/go/collectors/go.d.plugin/modules/dnsquery/dnsquery_test.go new file mode 100644 index 000000000..9842e54fd --- /dev/null +++ b/src/go/collectors/go.d.plugin/modules/dnsquery/dnsquery_test.go @@ -0,0 +1,242 @@ +// SPDX-License-Identifier: GPL-3.0-or-later + +package dnsquery + +import ( + "errors" + "os" + "testing" + "time" + + "github.com/netdata/netdata/go/go.d.plugin/agent/module" + "github.com/netdata/netdata/go/go.d.plugin/pkg/web" + + "github.com/miekg/dns" + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" +) + +var ( + dataConfigJSON, _ = os.ReadFile("testdata/config.json") + dataConfigYAML, _ = os.ReadFile("testdata/config.yaml") +) + +func Test_testDataIsValid(t *testing.T) { + for name, data := range map[string][]byte{ + "dataConfigJSON": dataConfigJSON, + "dataConfigYAML": dataConfigYAML, + } { + require.NotNil(t, data, name) + } +} + +func TestDNSQuery_ConfigurationSerialize(t *testing.T) { + module.TestConfigurationSerialize(t, &DNSQuery{}, dataConfigJSON, dataConfigYAML) +} + +func TestDNSQuery_Init(t *testing.T) { + tests := map[string]struct { + wantFail bool + config Config + }{ + "success when all set": { + wantFail: false, + config: Config{ + Domains: []string{"example.com"}, + Servers: []string{"192.0.2.0"}, + Network: "udp", + RecordTypes: []string{"A"}, + Port: 53, + Timeout: web.Duration(time.Second), + }, + }, + "success when using deprecated record_type": { + wantFail: false, + config: Config{ + Domains: []string{"example.com"}, + Servers: []string{"192.0.2.0"}, + Network: "udp", + RecordType: "A", + Port: 53, + Timeout: web.Duration(time.Second), + }, + }, + "fail with default": { + wantFail: true, + config: New().Config, + }, + "fail when domains not set": { + wantFail: true, + config: Config{ + Domains: nil, + Servers: []string{"192.0.2.0"}, + Network: "udp", + RecordTypes: []string{"A"}, + Port: 53, + Timeout: web.Duration(time.Second), + }, + }, + "fail when servers not set": { + wantFail: true, + config: Config{ + Domains: []string{"example.com"}, + Servers: nil, + Network: "udp", + RecordTypes: []string{"A"}, + Port: 53, + Timeout: web.Duration(time.Second), + }, + }, + "fail when network is invalid": { + wantFail: true, + config: Config{ + Domains: []string{"example.com"}, + Servers: []string{"192.0.2.0"}, + Network: "gcp", + RecordTypes: []string{"A"}, + Port: 53, + Timeout: web.Duration(time.Second), + }, + }, + "fail when record_type is invalid": { + wantFail: true, + config: Config{ + Domains: []string{"example.com"}, + Servers: []string{"192.0.2.0"}, + Network: "udp", + RecordTypes: []string{"B"}, + Port: 53, + Timeout: web.Duration(time.Second), + }, + }, + } + + for name, test := range tests { + t.Run(name, func(t *testing.T) { + dq := New() + dq.Config = test.config + + if test.wantFail { + assert.Error(t, dq.Init()) + } else { + assert.NoError(t, dq.Init()) + } + }) + } +} + +func TestDNSQuery_Check(t *testing.T) { + tests := map[string]struct { + wantFail bool + prepare func() *DNSQuery + }{ + "success when DNS query successful": { + wantFail: false, + prepare: caseDNSClientOK, + }, + "success when DNS query returns an error": { + wantFail: false, + prepare: caseDNSClientErr, + }, + } + + for name, test := range tests { + t.Run(name, func(t *testing.T) { + dq := test.prepare() + + require.NoError(t, dq.Init()) + + if test.wantFail { + assert.Error(t, dq.Check()) + } else { + assert.NoError(t, dq.Check()) + } + }) + } +} + +func TestDNSQuery_Charts(t *testing.T) { + dq := New() + + dq.Domains = []string{"google.com"} + dq.Servers = []string{"192.0.2.0", "192.0.2.1"} + require.NoError(t, dq.Init()) + + assert.NotNil(t, dq.Charts()) + assert.Len(t, *dq.Charts(), len(dnsChartsTmpl)*len(dq.Servers)) +} + +func TestDNSQuery_Collect(t *testing.T) { + tests := map[string]struct { + prepare func() *DNSQuery + wantMetrics map[string]int64 + }{ + "success when DNS query successful": { + prepare: caseDNSClientOK, + wantMetrics: map[string]int64{ + "server_192.0.2.0_record_A_query_status_dns_error": 0, + "server_192.0.2.0_record_A_query_status_network_error": 0, + "server_192.0.2.0_record_A_query_status_success": 1, + "server_192.0.2.0_record_A_query_time": 1000000000, + "server_192.0.2.1_record_A_query_status_dns_error": 0, + "server_192.0.2.1_record_A_query_status_network_error": 0, + "server_192.0.2.1_record_A_query_status_success": 1, + "server_192.0.2.1_record_A_query_time": 1000000000, + }, + }, + "fail when DNS query returns an error": { + prepare: caseDNSClientErr, + wantMetrics: map[string]int64{ + "server_192.0.2.0_record_A_query_status_dns_error": 0, + "server_192.0.2.0_record_A_query_status_network_error": 1, + "server_192.0.2.0_record_A_query_status_success": 0, + "server_192.0.2.1_record_A_query_status_dns_error": 0, + "server_192.0.2.1_record_A_query_status_network_error": 1, + "server_192.0.2.1_record_A_query_status_success": 0, + }, + }, + } + + for name, test := range tests { + t.Run(name, func(t *testing.T) { + dq := test.prepare() + + require.NoError(t, dq.Init()) + + mx := dq.Collect() + + require.Equal(t, test.wantMetrics, mx) + }) + } +} + +func caseDNSClientOK() *DNSQuery { + dq := New() + dq.Domains = []string{"example.com"} + dq.Servers = []string{"192.0.2.0", "192.0.2.1"} + dq.newDNSClient = func(_ string, _ time.Duration) dnsClient { + return mockDNSClient{errOnExchange: false} + } + return dq +} + +func caseDNSClientErr() *DNSQuery { + dq := New() + dq.Domains = []string{"example.com"} + dq.Servers = []string{"192.0.2.0", "192.0.2.1"} + dq.newDNSClient = func(_ string, _ time.Duration) dnsClient { + return mockDNSClient{errOnExchange: true} + } + return dq +} + +type mockDNSClient struct { + errOnExchange bool +} + +func (m mockDNSClient) Exchange(_ *dns.Msg, _ string) (response *dns.Msg, rtt time.Duration, err error) { + if m.errOnExchange { + return nil, time.Second, errors.New("mock.Exchange() error") + } + return nil, time.Second, nil +} |