494 lines
12 KiB
Go
494 lines
12 KiB
Go
package snmp2
|
|
|
|
import (
|
|
"fmt"
|
|
"net"
|
|
"sync"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/influxdata/telegraf/testutil"
|
|
"github.com/influxdata/toml"
|
|
"github.com/soniah/gosnmp"
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
type testSNMPConnection struct {
|
|
host string
|
|
values map[string]interface{}
|
|
}
|
|
|
|
func (tsc *testSNMPConnection) Host() string {
|
|
return tsc.host
|
|
}
|
|
|
|
func (tsc *testSNMPConnection) Get(oids []string) (*gosnmp.SnmpPacket, error) {
|
|
sp := &gosnmp.SnmpPacket{}
|
|
for _, oid := range oids {
|
|
v, ok := tsc.values[oid]
|
|
if !ok {
|
|
sp.Variables = append(sp.Variables, gosnmp.SnmpPDU{
|
|
Name: oid,
|
|
Type: gosnmp.NoSuchObject,
|
|
})
|
|
continue
|
|
}
|
|
sp.Variables = append(sp.Variables, gosnmp.SnmpPDU{
|
|
Name: oid,
|
|
Value: v,
|
|
})
|
|
}
|
|
return sp, nil
|
|
}
|
|
func (tsc *testSNMPConnection) Walk(oid string, wf gosnmp.WalkFunc) error {
|
|
for void, v := range tsc.values {
|
|
if void == oid || (len(void) > len(oid) && void[:len(oid)+1] == oid+".") {
|
|
if err := wf(gosnmp.SnmpPDU{
|
|
Name: void,
|
|
Value: v,
|
|
}); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
var tsc = &testSNMPConnection{
|
|
host: "tsc",
|
|
values: map[string]interface{}{
|
|
".1.2.3.0.0.1.0": "foo",
|
|
".1.2.3.0.0.1.1": []byte("bar"),
|
|
".1.2.3.0.0.102": "bad",
|
|
".1.2.3.0.0.2.0": 1,
|
|
".1.2.3.0.0.2.1": 2,
|
|
".1.2.3.0.0.3.0": "0.123",
|
|
".1.2.3.0.0.3.1": "0.456",
|
|
".1.2.3.0.0.3.2": "9.999",
|
|
".1.2.3.0.0.4.0": 123456,
|
|
".1.2.3.0.1": "baz",
|
|
".1.2.3.0.2": 234,
|
|
".1.2.3.0.3": []byte("byte slice"),
|
|
},
|
|
}
|
|
|
|
func TestSampleConfig(t *testing.T) {
|
|
conf := struct {
|
|
Inputs struct {
|
|
Snmp2 []*Snmp2
|
|
}
|
|
}{}
|
|
err := toml.Unmarshal([]byte("[[inputs.snmp2]]\n"+(*Snmp2)(nil).SampleConfig()), &conf)
|
|
assert.NoError(t, err)
|
|
|
|
s := Snmp2{
|
|
Agents: []string{"127.0.0.1:161"},
|
|
Version: 2,
|
|
Community: "public",
|
|
MaxRepetitions: 50,
|
|
|
|
Name: "system",
|
|
Fields: []Field{
|
|
{Name: "hostname", Oid: ".1.2.3.0.1.1"},
|
|
{Name: "uptime", Oid: ".1.2.3.0.1.200"},
|
|
{Name: "load", Oid: ".1.2.3.0.1.201"},
|
|
},
|
|
Tables: []Table{
|
|
{
|
|
Name: "remote_servers",
|
|
InheritTags: []string{"hostname"},
|
|
Fields: []Field{
|
|
{Name: "server", Oid: ".1.2.3.0.0.0", IsTag: true},
|
|
{Name: "connections", Oid: ".1.2.3.0.0.1"},
|
|
{Name: "latency", Oid: ".1.2.3.0.0.2"},
|
|
},
|
|
},
|
|
},
|
|
}
|
|
assert.Equal(t, s, *conf.Inputs.Snmp2[0])
|
|
}
|
|
|
|
func TestGetSNMPConnection_v2(t *testing.T) {
|
|
s := &Snmp2{
|
|
Timeout: "3s",
|
|
Retries: 4,
|
|
Version: 2,
|
|
Community: "foo",
|
|
}
|
|
|
|
gsc, err := s.getConnection("1.2.3.4:567")
|
|
require.NoError(t, err)
|
|
gs := gsc.(gosnmpWrapper)
|
|
assert.Equal(t, "1.2.3.4", gs.Target)
|
|
assert.EqualValues(t, 567, gs.Port)
|
|
assert.Equal(t, gosnmp.Version2c, gs.Version)
|
|
assert.Equal(t, "foo", gs.Community)
|
|
|
|
gsc, err = s.getConnection("1.2.3.4")
|
|
require.NoError(t, err)
|
|
gs = gsc.(gosnmpWrapper)
|
|
assert.Equal(t, "1.2.3.4", gs.Target)
|
|
assert.EqualValues(t, 161, gs.Port)
|
|
}
|
|
|
|
func TestGetSNMPConnection_v3(t *testing.T) {
|
|
s := &Snmp2{
|
|
Version: 3,
|
|
MaxRepetitions: 20,
|
|
ContextName: "mycontext",
|
|
SecLevel: "authPriv",
|
|
SecName: "myuser",
|
|
AuthProtocol: "md5",
|
|
AuthPassword: "password123",
|
|
PrivProtocol: "des",
|
|
PrivPassword: "321drowssap",
|
|
EngineID: "myengineid",
|
|
EngineBoots: 1,
|
|
EngineTime: 2,
|
|
}
|
|
|
|
gsc, err := s.getConnection("1.2.3.4")
|
|
require.NoError(t, err)
|
|
gs := gsc.(gosnmpWrapper)
|
|
assert.Equal(t, gs.Version, gosnmp.Version3)
|
|
sp := gs.SecurityParameters.(*gosnmp.UsmSecurityParameters)
|
|
assert.Equal(t, "1.2.3.4", gsc.Host())
|
|
assert.Equal(t, 20, gs.MaxRepetitions)
|
|
assert.Equal(t, "mycontext", gs.ContextName)
|
|
assert.Equal(t, gosnmp.AuthPriv, gs.MsgFlags&gosnmp.AuthPriv)
|
|
assert.Equal(t, "myuser", sp.UserName)
|
|
assert.Equal(t, gosnmp.MD5, sp.AuthenticationProtocol)
|
|
assert.Equal(t, "password123", sp.AuthenticationPassphrase)
|
|
assert.Equal(t, gosnmp.DES, sp.PrivacyProtocol)
|
|
assert.Equal(t, "321drowssap", sp.PrivacyPassphrase)
|
|
assert.Equal(t, "myengineid", sp.AuthoritativeEngineID)
|
|
assert.EqualValues(t, 1, sp.AuthoritativeEngineBoots)
|
|
assert.EqualValues(t, 2, sp.AuthoritativeEngineTime)
|
|
}
|
|
|
|
func TestGetSNMPConnection_caching(t *testing.T) {
|
|
s := &Snmp2{}
|
|
gs1, err := s.getConnection("1.2.3.4")
|
|
require.NoError(t, err)
|
|
gs2, err := s.getConnection("1.2.3.4")
|
|
require.NoError(t, err)
|
|
gs3, err := s.getConnection("1.2.3.5")
|
|
require.NoError(t, err)
|
|
assert.True(t, gs1 == gs2)
|
|
assert.False(t, gs2 == gs3)
|
|
}
|
|
|
|
func TestGosnmpWrapper_walk_retry(t *testing.T) {
|
|
srvr, err := net.ListenUDP("udp4", &net.UDPAddr{})
|
|
defer srvr.Close()
|
|
require.NoError(t, err)
|
|
reqCount := 0
|
|
// Set up a WaitGroup to wait for the server goroutine to exit and protect
|
|
// reqCount.
|
|
// Even though simultaneous access is impossible because the server will be
|
|
// blocked on ReadFrom, without this the race detector gets unhappy.
|
|
wg := sync.WaitGroup{}
|
|
wg.Add(1)
|
|
go func() {
|
|
defer wg.Done()
|
|
buf := make([]byte, 256)
|
|
for {
|
|
_, addr, err := srvr.ReadFrom(buf)
|
|
if err != nil {
|
|
return
|
|
}
|
|
reqCount++
|
|
|
|
srvr.WriteTo([]byte{'X'}, addr) // will cause decoding error
|
|
}
|
|
}()
|
|
|
|
gs := &gosnmp.GoSNMP{
|
|
Target: srvr.LocalAddr().(*net.UDPAddr).IP.String(),
|
|
Port: uint16(srvr.LocalAddr().(*net.UDPAddr).Port),
|
|
Version: gosnmp.Version2c,
|
|
Community: "public",
|
|
Timeout: time.Millisecond * 10,
|
|
Retries: 1,
|
|
}
|
|
err = gs.Connect()
|
|
require.NoError(t, err)
|
|
conn := gs.Conn
|
|
|
|
gsw := gosnmpWrapper{gs}
|
|
err = gsw.Walk(".1.2.3", func(_ gosnmp.SnmpPDU) error { return nil })
|
|
srvr.Close()
|
|
wg.Wait()
|
|
assert.Error(t, err)
|
|
assert.False(t, gs.Conn == conn)
|
|
assert.Equal(t, (gs.Retries+1)*2, reqCount)
|
|
}
|
|
|
|
func TestGosnmpWrapper_get_retry(t *testing.T) {
|
|
srvr, err := net.ListenUDP("udp4", &net.UDPAddr{})
|
|
defer srvr.Close()
|
|
require.NoError(t, err)
|
|
reqCount := 0
|
|
// Set up a WaitGroup to wait for the server goroutine to exit and protect
|
|
// reqCount.
|
|
// Even though simultaneous access is impossible because the server will be
|
|
// blocked on ReadFrom, without this the race detector gets unhappy.
|
|
wg := sync.WaitGroup{}
|
|
wg.Add(1)
|
|
go func() {
|
|
defer wg.Done()
|
|
buf := make([]byte, 256)
|
|
for {
|
|
_, addr, err := srvr.ReadFrom(buf)
|
|
if err != nil {
|
|
return
|
|
}
|
|
reqCount++
|
|
|
|
srvr.WriteTo([]byte{'X'}, addr) // will cause decoding error
|
|
}
|
|
}()
|
|
|
|
gs := &gosnmp.GoSNMP{
|
|
Target: srvr.LocalAddr().(*net.UDPAddr).IP.String(),
|
|
Port: uint16(srvr.LocalAddr().(*net.UDPAddr).Port),
|
|
Version: gosnmp.Version2c,
|
|
Community: "public",
|
|
Timeout: time.Millisecond * 10,
|
|
Retries: 1,
|
|
}
|
|
err = gs.Connect()
|
|
require.NoError(t, err)
|
|
conn := gs.Conn
|
|
|
|
gsw := gosnmpWrapper{gs}
|
|
_, err = gsw.Get([]string{".1.2.3"})
|
|
srvr.Close()
|
|
wg.Wait()
|
|
assert.Error(t, err)
|
|
assert.False(t, gs.Conn == conn)
|
|
assert.Equal(t, (gs.Retries+1)*2, reqCount)
|
|
}
|
|
|
|
func TestTableBuild_walk(t *testing.T) {
|
|
tbl := Table{
|
|
Name: "mytable",
|
|
Fields: []Field{
|
|
{
|
|
Name: "myfield1",
|
|
Oid: ".1.2.3.0.0.1",
|
|
IsTag: true,
|
|
},
|
|
{
|
|
Name: "myfield2",
|
|
Oid: ".1.2.3.0.0.2",
|
|
},
|
|
{
|
|
Name: "myfield3",
|
|
Oid: ".1.2.3.0.0.3",
|
|
Conversion: "float",
|
|
},
|
|
},
|
|
}
|
|
|
|
tb, err := tbl.Build(tsc, true)
|
|
require.NoError(t, err)
|
|
|
|
assert.Equal(t, tb.Name, "mytable")
|
|
rtr1 := RTableRow{
|
|
Tags: map[string]string{"myfield1": "foo"},
|
|
Fields: map[string]interface{}{"myfield2": 1, "myfield3": float64(0.123)},
|
|
}
|
|
rtr2 := RTableRow{
|
|
Tags: map[string]string{"myfield1": "bar"},
|
|
Fields: map[string]interface{}{"myfield2": 2, "myfield3": float64(0.456)},
|
|
}
|
|
assert.Len(t, tb.Rows, 2)
|
|
assert.Contains(t, tb.Rows, rtr1)
|
|
assert.Contains(t, tb.Rows, rtr2)
|
|
}
|
|
|
|
func TestTableBuild_noWalk(t *testing.T) {
|
|
tbl := Table{
|
|
Name: "mytable",
|
|
Fields: []Field{
|
|
{
|
|
Name: "myfield1",
|
|
Oid: ".1.2.3.0.1",
|
|
IsTag: true,
|
|
},
|
|
{
|
|
Name: "myfield2",
|
|
Oid: ".1.2.3.0.2",
|
|
},
|
|
{
|
|
Name: "myfield3",
|
|
Oid: ".1.2.3.0.2",
|
|
IsTag: true,
|
|
},
|
|
},
|
|
}
|
|
|
|
tb, err := tbl.Build(tsc, false)
|
|
require.NoError(t, err)
|
|
|
|
rtr := RTableRow{
|
|
Tags: map[string]string{"myfield1": "baz", "myfield3": "234"},
|
|
Fields: map[string]interface{}{"myfield2": 234},
|
|
}
|
|
assert.Len(t, tb.Rows, 1)
|
|
assert.Contains(t, tb.Rows, rtr)
|
|
}
|
|
|
|
func TestGather(t *testing.T) {
|
|
s := &Snmp2{
|
|
Agents: []string{"TestGather"},
|
|
Name: "mytable",
|
|
Fields: []Field{
|
|
{
|
|
Name: "myfield1",
|
|
Oid: ".1.2.3.0.1",
|
|
IsTag: true,
|
|
},
|
|
{
|
|
Name: "myfield2",
|
|
Oid: ".1.2.3.0.2",
|
|
},
|
|
{
|
|
Name: "myfield3",
|
|
Oid: "1.2.3.0.1",
|
|
},
|
|
},
|
|
Tables: []Table{
|
|
{
|
|
Name: "myOtherTable",
|
|
InheritTags: []string{"myfield1"},
|
|
Fields: []Field{
|
|
{
|
|
Name: "myOtherField",
|
|
Oid: ".1.2.3.0.0.4",
|
|
},
|
|
},
|
|
},
|
|
},
|
|
|
|
connectionCache: map[string]snmpConnection{
|
|
"TestGather": tsc,
|
|
},
|
|
}
|
|
|
|
acc := &testutil.Accumulator{}
|
|
|
|
tstart := time.Now()
|
|
s.Gather(acc)
|
|
tstop := time.Now()
|
|
|
|
require.Len(t, acc.Metrics, 2)
|
|
|
|
m := acc.Metrics[0]
|
|
assert.Equal(t, "mytable", m.Measurement)
|
|
assert.Equal(t, "tsc", m.Tags["agent_host"])
|
|
assert.Equal(t, "baz", m.Tags["myfield1"])
|
|
assert.Len(t, m.Fields, 2)
|
|
assert.Equal(t, 234, m.Fields["myfield2"])
|
|
assert.Equal(t, "baz", m.Fields["myfield3"])
|
|
assert.True(t, tstart.Before(m.Time))
|
|
assert.True(t, tstop.After(m.Time))
|
|
|
|
m2 := acc.Metrics[1]
|
|
assert.Equal(t, "myOtherTable", m2.Measurement)
|
|
assert.Equal(t, "tsc", m2.Tags["agent_host"])
|
|
assert.Equal(t, "baz", m2.Tags["myfield1"])
|
|
assert.Len(t, m2.Fields, 1)
|
|
assert.Equal(t, 123456, m2.Fields["myOtherField"])
|
|
}
|
|
|
|
func TestGather_host(t *testing.T) {
|
|
s := &Snmp2{
|
|
Agents: []string{"TestGather"},
|
|
Name: "mytable",
|
|
Fields: []Field{
|
|
{
|
|
Name: "host",
|
|
Oid: ".1.2.3.0.1",
|
|
IsTag: true,
|
|
},
|
|
{
|
|
Name: "myfield2",
|
|
Oid: ".1.2.3.0.2",
|
|
},
|
|
},
|
|
|
|
connectionCache: map[string]snmpConnection{
|
|
"TestGather": tsc,
|
|
},
|
|
}
|
|
|
|
acc := &testutil.Accumulator{}
|
|
|
|
s.Gather(acc)
|
|
|
|
require.Len(t, acc.Metrics, 1)
|
|
m := acc.Metrics[0]
|
|
assert.Equal(t, "baz", m.Tags["host"])
|
|
}
|
|
|
|
func TestFieldConvert(t *testing.T) {
|
|
testTable := []struct {
|
|
input interface{}
|
|
conv string
|
|
expected interface{}
|
|
}{
|
|
{[]byte("foo"), "", string("foo")},
|
|
{"0.123", "float", float64(0.123)},
|
|
{[]byte("0.123"), "float", float64(0.123)},
|
|
{float32(0.123), "float", float64(float32(0.123))},
|
|
{float64(0.123), "float", float64(0.123)},
|
|
{123, "float", float64(123)},
|
|
{123, "float(0)", float64(123)},
|
|
{123, "float(4)", float64(0.0123)},
|
|
{int8(123), "float(3)", float64(0.123)},
|
|
{int16(123), "float(3)", float64(0.123)},
|
|
{int32(123), "float(3)", float64(0.123)},
|
|
{int64(123), "float(3)", float64(0.123)},
|
|
{uint(123), "float(3)", float64(0.123)},
|
|
{uint8(123), "float(3)", float64(0.123)},
|
|
{uint16(123), "float(3)", float64(0.123)},
|
|
{uint32(123), "float(3)", float64(0.123)},
|
|
{uint64(123), "float(3)", float64(0.123)},
|
|
{"123", "int", int64(123)},
|
|
{[]byte("123"), "int", int64(123)},
|
|
{float32(12.3), "int", int64(12)},
|
|
{float64(12.3), "int", int64(12)},
|
|
{int(123), "int", int64(123)},
|
|
{int8(123), "int", int64(123)},
|
|
{int16(123), "int", int64(123)},
|
|
{int32(123), "int", int64(123)},
|
|
{int64(123), "int", int64(123)},
|
|
{uint(123), "int", int64(123)},
|
|
{uint8(123), "int", int64(123)},
|
|
{uint16(123), "int", int64(123)},
|
|
{uint32(123), "int", int64(123)},
|
|
{uint64(123), "int", int64(123)},
|
|
}
|
|
|
|
for _, tc := range testTable {
|
|
act := fieldConvert(tc.conv, tc.input)
|
|
assert.EqualValues(t, tc.expected, act, "input=%T(%v) conv=%s expected=%T(%v)", tc.input, tc.input, tc.conv, tc.expected, tc.expected)
|
|
}
|
|
}
|
|
|
|
func TestError(t *testing.T) {
|
|
e := fmt.Errorf("nested error")
|
|
err := Errorf(e, "top error %d", 123)
|
|
require.Error(t, err)
|
|
|
|
ne, ok := err.(NestedError)
|
|
require.True(t, ok)
|
|
assert.Equal(t, e, ne.NestedErr)
|
|
|
|
assert.Contains(t, err.Error(), "top error 123")
|
|
assert.Contains(t, err.Error(), "nested error")
|
|
}
|