//go:generate go run -tags generate snmp_mocks_generate.go package snmp import ( "fmt" "net" "os/exec" "sync" "testing" "time" "github.com/gosnmp/gosnmp" "github.com/influxdata/telegraf/config" "github.com/influxdata/telegraf/internal/snmp" "github.com/influxdata/telegraf/plugins/inputs" "github.com/influxdata/telegraf/testutil" "github.com/influxdata/toml" "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.0.0.0.1.1.0": "foo", ".1.0.0.0.1.1.1": []byte("bar"), ".1.0.0.0.1.1.2": []byte(""), ".1.0.0.0.1.102": "bad", ".1.0.0.0.1.2.0": 1, ".1.0.0.0.1.2.1": 2, ".1.0.0.0.1.2.2": 0, ".1.0.0.0.1.3.0": "0.123", ".1.0.0.0.1.3.1": "0.456", ".1.0.0.0.1.3.2": "0.000", ".1.0.0.0.1.3.3": "9.999", ".1.0.0.0.1.5.0": 123456, ".1.0.0.1.1": "baz", ".1.0.0.1.2": 234, ".1.0.0.1.3": []byte("byte slice"), ".1.0.0.2.1.5.0.9.9": 11, ".1.0.0.2.1.5.1.9.9": 22, ".1.0.0.0.1.6.0": ".1.0.0.0.1.7", ".1.0.0.3.1.1.10": "instance", ".1.0.0.3.1.1.11": "instance2", ".1.0.0.3.1.1.12": "instance3", ".1.0.0.3.1.2.10": 10, ".1.0.0.3.1.2.11": 20, ".1.0.0.3.1.2.12": 20, ".1.0.0.3.1.3.10": 1, ".1.0.0.3.1.3.11": 2, ".1.0.0.3.1.3.12": 3, }, } func TestSampleConfig(t *testing.T) { conf := inputs.Inputs["snmp"]() err := toml.Unmarshal([]byte(conf.SampleConfig()), conf) require.NoError(t, err) expected := &Snmp{ Agents: []string{"udp://127.0.0.1:161"}, AgentHostTag: "", ClientConfig: snmp.ClientConfig{ Timeout: config.Duration(5 * time.Second), Version: 2, Path: []string{"/usr/share/snmp/mibs"}, Community: "public", MaxRepetitions: 10, Retries: 3, }, Name: "snmp", } require.Equal(t, expected, conf) } func TestFieldInit(t *testing.T) { translations := []struct { inputOid string inputName string inputConversion string expectedOid string expectedName string expectedConversion string }{ {".1.2.3", "foo", "", ".1.2.3", "foo", ""}, {".iso.2.3", "foo", "", ".1.2.3", "foo", ""}, {".1.0.0.0.1.1", "", "", ".1.0.0.0.1.1", "server", ""}, {".1.0.0.0.1.1.0", "", "", ".1.0.0.0.1.1.0", "server.0", ""}, {".999", "", "", ".999", ".999", ""}, {"TEST::server", "", "", ".1.0.0.0.1.1", "server", ""}, {"TEST::server.0", "", "", ".1.0.0.0.1.1.0", "server.0", ""}, {"TEST::server", "foo", "", ".1.0.0.0.1.1", "foo", ""}, {"IF-MIB::ifPhysAddress.1", "", "", ".1.3.6.1.2.1.2.2.1.6.1", "ifPhysAddress.1", "hwaddr"}, {"IF-MIB::ifPhysAddress.1", "", "none", ".1.3.6.1.2.1.2.2.1.6.1", "ifPhysAddress.1", "none"}, {"BRIDGE-MIB::dot1dTpFdbAddress.1", "", "", ".1.3.6.1.2.1.17.4.3.1.1.1", "dot1dTpFdbAddress.1", "hwaddr"}, {"TCP-MIB::tcpConnectionLocalAddress.1", "", "", ".1.3.6.1.2.1.6.19.1.2.1", "tcpConnectionLocalAddress.1", "ipaddr"}, } tr := NewNetsnmpTranslator() for _, txl := range translations { f := Field{Oid: txl.inputOid, Name: txl.inputName, Conversion: txl.inputConversion} err := f.init(tr) if !assert.NoError(t, err, "inputOid='%s' inputName='%s'", txl.inputOid, txl.inputName) { continue } assert.Equal(t, txl.expectedOid, f.Oid, "inputOid='%s' inputName='%s' inputConversion='%s'", txl.inputOid, txl.inputName, txl.inputConversion) assert.Equal(t, txl.expectedName, f.Name, "inputOid='%s' inputName='%s' inputConversion='%s'", txl.inputOid, txl.inputName, txl.inputConversion) } } func TestTableInit(t *testing.T) { tbl := Table{ Oid: ".1.0.0.0", Fields: []Field{ {Oid: ".999", Name: "foo"}, {Oid: "TEST::description", Name: "description", IsTag: true}, }, } err := tbl.Init(NewNetsnmpTranslator()) require.NoError(t, err) assert.Equal(t, "testTable", tbl.Name) assert.Len(t, tbl.Fields, 5) assert.Contains(t, tbl.Fields, Field{Oid: ".999", Name: "foo", initialized: true}) assert.Contains(t, tbl.Fields, Field{Oid: ".1.0.0.0.1.1", Name: "server", IsTag: true, initialized: true}) assert.Contains(t, tbl.Fields, Field{Oid: ".1.0.0.0.1.2", Name: "connections", initialized: true}) assert.Contains(t, tbl.Fields, Field{Oid: ".1.0.0.0.1.3", Name: "latency", initialized: true}) assert.Contains(t, tbl.Fields, Field{Oid: ".1.0.0.0.1.4", Name: "description", IsTag: true, initialized: true}) } func TestSnmpInit(t *testing.T) { s := &Snmp{ Tables: []Table{ {Oid: "TEST::testTable"}, }, Fields: []Field{ {Oid: "TEST::hostname"}, }, ClientConfig: snmp.ClientConfig{ Translator: "netsnmp", }, } err := s.Init() require.NoError(t, err) assert.Len(t, s.Tables[0].Fields, 4) assert.Contains(t, s.Tables[0].Fields, Field{Oid: ".1.0.0.0.1.1", Name: "server", IsTag: true, initialized: true}) assert.Contains(t, s.Tables[0].Fields, Field{Oid: ".1.0.0.0.1.2", Name: "connections", initialized: true}) assert.Contains(t, s.Tables[0].Fields, Field{Oid: ".1.0.0.0.1.3", Name: "latency", initialized: true}) assert.Contains(t, s.Tables[0].Fields, Field{Oid: ".1.0.0.0.1.4", Name: "description", initialized: true}) assert.Equal(t, Field{ Oid: ".1.0.0.1.1", Name: "hostname", initialized: true, }, s.Fields[0]) } func TestSnmpInit_noTranslate(t *testing.T) { // override execCommand so it returns exec.ErrNotFound defer func(ec func(string, ...string) *exec.Cmd) { execCommand = ec }(execCommand) execCommand = func(_ string, _ ...string) *exec.Cmd { return exec.Command("snmptranslateExecErrNotFound") } s := &Snmp{ Fields: []Field{ {Oid: ".1.1.1.1", Name: "one", IsTag: true}, {Oid: ".1.1.1.2", Name: "two"}, {Oid: ".1.1.1.3"}, }, Tables: []Table{ {Name: "testing", Fields: []Field{ {Oid: ".1.1.1.4", Name: "four", IsTag: true}, {Oid: ".1.1.1.5", Name: "five"}, {Oid: ".1.1.1.6"}, }}, }, ClientConfig: snmp.ClientConfig{ Translator: "netsnmp", }, } err := s.Init() require.NoError(t, err) assert.Equal(t, ".1.1.1.1", s.Fields[0].Oid) assert.Equal(t, "one", s.Fields[0].Name) assert.Equal(t, true, s.Fields[0].IsTag) assert.Equal(t, ".1.1.1.2", s.Fields[1].Oid) assert.Equal(t, "two", s.Fields[1].Name) assert.Equal(t, false, s.Fields[1].IsTag) assert.Equal(t, ".1.1.1.3", s.Fields[2].Oid) assert.Equal(t, ".1.1.1.3", s.Fields[2].Name) assert.Equal(t, false, s.Fields[2].IsTag) assert.Equal(t, ".1.1.1.4", s.Tables[0].Fields[0].Oid) assert.Equal(t, "four", s.Tables[0].Fields[0].Name) assert.Equal(t, true, s.Tables[0].Fields[0].IsTag) assert.Equal(t, ".1.1.1.5", s.Tables[0].Fields[1].Oid) assert.Equal(t, "five", s.Tables[0].Fields[1].Name) assert.Equal(t, false, s.Tables[0].Fields[1].IsTag) assert.Equal(t, ".1.1.1.6", s.Tables[0].Fields[2].Oid) assert.Equal(t, ".1.1.1.6", s.Tables[0].Fields[2].Name) assert.Equal(t, false, s.Tables[0].Fields[2].IsTag) } func TestSnmpInit_noName_noOid(t *testing.T) { s := &Snmp{ Tables: []Table{ {Fields: []Field{ {Oid: ".1.1.1.4", Name: "four", IsTag: true}, {Oid: ".1.1.1.5", Name: "five"}, {Oid: ".1.1.1.6"}, }}, }, } err := s.Init() require.Error(t, err) } func TestGetSNMPConnection_v2(t *testing.T) { s := &Snmp{ Agents: []string{"1.2.3.4:567", "1.2.3.4", "udp://127.0.0.1"}, ClientConfig: snmp.ClientConfig{ Timeout: config.Duration(3 * time.Second), Retries: 4, Version: 2, Community: "foo", Translator: "netsnmp", }, } err := s.Init() require.NoError(t, err) gsc, err := s.getConnection(0) require.NoError(t, err) gs := gsc.(snmp.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) assert.Equal(t, "udp", gs.Transport) gsc, err = s.getConnection(1) require.NoError(t, err) gs = gsc.(snmp.GosnmpWrapper) assert.Equal(t, "1.2.3.4", gs.Target) assert.EqualValues(t, 161, gs.Port) assert.Equal(t, "udp", gs.Transport) gsc, err = s.getConnection(2) require.NoError(t, err) gs = gsc.(snmp.GosnmpWrapper) assert.Equal(t, "127.0.0.1", gs.Target) assert.EqualValues(t, 161, gs.Port) assert.Equal(t, "udp", gs.Transport) } func TestGetSNMPConnectionTCP(t *testing.T) { var wg sync.WaitGroup wg.Add(1) go stubTCPServer(&wg) wg.Wait() s := &Snmp{ Agents: []string{"tcp://127.0.0.1:56789"}, ClientConfig: snmp.ClientConfig{ Translator: "netsnmp", }, } err := s.Init() require.NoError(t, err) wg.Add(1) gsc, err := s.getConnection(0) require.NoError(t, err) gs := gsc.(snmp.GosnmpWrapper) assert.Equal(t, "127.0.0.1", gs.Target) assert.EqualValues(t, 56789, gs.Port) assert.Equal(t, "tcp", gs.Transport) wg.Wait() } func stubTCPServer(wg *sync.WaitGroup) { defer wg.Done() tcpAddr, _ := net.ResolveTCPAddr("tcp", "127.0.0.1:56789") tcpServer, _ := net.ListenTCP("tcp", tcpAddr) defer tcpServer.Close() wg.Done() conn, _ := tcpServer.AcceptTCP() defer conn.Close() } func TestGetSNMPConnection_v3(t *testing.T) { s := &Snmp{ Agents: []string{"1.2.3.4"}, ClientConfig: snmp.ClientConfig{ Version: 3, MaxRepetitions: 20, ContextName: "mycontext", SecLevel: "authPriv", SecName: "myuser", AuthProtocol: "md5", AuthPassword: "password123", PrivProtocol: "des", PrivPassword: "321drowssap", EngineID: "myengineid", EngineBoots: 1, EngineTime: 2, Translator: "netsnmp", }, } err := s.Init() require.NoError(t, err) gsc, err := s.getConnection(0) require.NoError(t, err) gs := gsc.(snmp.GosnmpWrapper) assert.Equal(t, gs.Version, gosnmp.Version3) sp := gs.SecurityParameters.(*gosnmp.UsmSecurityParameters) assert.Equal(t, "1.2.3.4", gsc.Host()) assert.EqualValues(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_v3_blumenthal(t *testing.T) { testCases := []struct { Name string Algorithm gosnmp.SnmpV3PrivProtocol Config *Snmp }{ { Name: "AES192", Algorithm: gosnmp.AES192, Config: &Snmp{ Agents: []string{"1.2.3.4"}, ClientConfig: snmp.ClientConfig{ Version: 3, MaxRepetitions: 20, ContextName: "mycontext", SecLevel: "authPriv", SecName: "myuser", AuthProtocol: "md5", AuthPassword: "password123", PrivProtocol: "AES192", PrivPassword: "password123", EngineID: "myengineid", EngineBoots: 1, EngineTime: 2, Translator: "netsnmp", }, }, }, { Name: "AES192C", Algorithm: gosnmp.AES192C, Config: &Snmp{ Agents: []string{"1.2.3.4"}, ClientConfig: snmp.ClientConfig{ Version: 3, MaxRepetitions: 20, ContextName: "mycontext", SecLevel: "authPriv", SecName: "myuser", AuthProtocol: "md5", AuthPassword: "password123", PrivProtocol: "AES192C", PrivPassword: "password123", EngineID: "myengineid", EngineBoots: 1, EngineTime: 2, Translator: "netsnmp", }, }, }, { Name: "AES256", Algorithm: gosnmp.AES256, Config: &Snmp{ Agents: []string{"1.2.3.4"}, ClientConfig: snmp.ClientConfig{ Version: 3, MaxRepetitions: 20, ContextName: "mycontext", SecLevel: "authPriv", SecName: "myuser", AuthProtocol: "md5", AuthPassword: "password123", PrivProtocol: "AES256", PrivPassword: "password123", EngineID: "myengineid", EngineBoots: 1, EngineTime: 2, Translator: "netsnmp", }, }, }, { Name: "AES256C", Algorithm: gosnmp.AES256C, Config: &Snmp{ Agents: []string{"1.2.3.4"}, ClientConfig: snmp.ClientConfig{ Version: 3, MaxRepetitions: 20, ContextName: "mycontext", SecLevel: "authPriv", SecName: "myuser", AuthProtocol: "md5", AuthPassword: "password123", PrivProtocol: "AES256C", PrivPassword: "password123", EngineID: "myengineid", EngineBoots: 1, EngineTime: 2, Translator: "netsnmp", }, }, }, } for _, tc := range testCases { t.Run(tc.Name, func(t *testing.T) { s := tc.Config err := s.Init() require.NoError(t, err) gsc, err := s.getConnection(0) require.NoError(t, err) gs := gsc.(snmp.GosnmpWrapper) assert.Equal(t, gs.Version, gosnmp.Version3) sp := gs.SecurityParameters.(*gosnmp.UsmSecurityParameters) assert.Equal(t, "1.2.3.4", gsc.Host()) assert.EqualValues(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, tc.Algorithm, sp.PrivacyProtocol) assert.Equal(t, "password123", 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 := &Snmp{ Agents: []string{"1.2.3.4", "1.2.3.5", "1.2.3.5"}, ClientConfig: snmp.ClientConfig{ Translator: "netsnmp", }, } err := s.Init() require.NoError(t, err) gs1, err := s.getConnection(0) require.NoError(t, err) gs2, err := s.getConnection(0) require.NoError(t, err) gs3, err := s.getConnection(1) require.NoError(t, err) gs4, err := s.getConnection(2) require.NoError(t, err) assert.Equal(t, gs1, gs2) assert.NotEqual(t, gs2, gs3) assert.NotEqual(t, gs3, gs4) } func TestGosnmpWrapper_walk_retry(t *testing.T) { if testing.Short() { t.Skip("Skipping test due to random failures.") } srvr, err := net.ListenUDP("udp4", &net.UDPAddr{}) require.NoError(t, err) defer srvr.Close() 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++ // will cause decoding error if _, err := srvr.WriteTo([]byte{'X'}, addr); err != nil { return } } }() 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 := snmp.GosnmpWrapper{ GoSNMP: gs, } err = gsw.Walk(".1.0.0", func(_ gosnmp.SnmpPDU) error { return nil }) require.NoError(t, srvr.Close()) wg.Wait() assert.Error(t, err) assert.NotEqual(t, gs.Conn, conn) assert.Equal(t, (gs.Retries+1)*2, reqCount) } func TestGosnmpWrapper_get_retry(t *testing.T) { // TODO: Fix this test t.Skip("Test failing too often, skip for now and revisit later.") srvr, err := net.ListenUDP("udp4", &net.UDPAddr{}) require.NoError(t, err) defer srvr.Close() 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++ // will cause decoding error if _, err := srvr.WriteTo([]byte{'X'}, addr); err != nil { return } } }() 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 := snmp.GosnmpWrapper{ GoSNMP: gs, } _, err = gsw.Get([]string{".1.0.0"}) require.NoError(t, srvr.Close()) wg.Wait() assert.Error(t, err) assert.NotEqual(t, gs.Conn, conn) assert.Equal(t, (gs.Retries+1)*2, reqCount) } func TestTableBuild_walk(t *testing.T) { tbl := Table{ Name: "mytable", IndexAsTag: true, Fields: []Field{ { Name: "myfield1", Oid: ".1.0.0.0.1.1", IsTag: true, }, { Name: "myfield2", Oid: ".1.0.0.0.1.2", }, { Name: "myfield3", Oid: ".1.0.0.0.1.3", Conversion: "float", }, { Name: "myfield4", Oid: ".1.0.0.2.1.5", OidIndexSuffix: ".9.9", }, { Name: "myfield5", Oid: ".1.0.0.2.1.5", OidIndexLength: 1, }, { Name: "myfield6", Oid: ".1.0.0.0.1.6", Translate: true, }, { Name: "myfield7", Oid: ".1.0.0.0.1.6", Translate: false, }, }, } tb, err := tbl.Build(tsc, true, NewNetsnmpTranslator()) require.NoError(t, err) assert.Equal(t, tb.Name, "mytable") rtr1 := RTableRow{ Tags: map[string]string{ "myfield1": "foo", "index": "0", }, Fields: map[string]interface{}{ "myfield2": 1, "myfield3": float64(0.123), "myfield4": 11, "myfield5": 11, "myfield6": "testTableEntry.7", "myfield7": ".1.0.0.0.1.7", }, } rtr2 := RTableRow{ Tags: map[string]string{ "myfield1": "bar", "index": "1", }, Fields: map[string]interface{}{ "myfield2": 2, "myfield3": float64(0.456), "myfield4": 22, "myfield5": 22, }, } rtr3 := RTableRow{ Tags: map[string]string{ "index": "2", }, Fields: map[string]interface{}{ "myfield2": 0, "myfield3": float64(0.0), }, } rtr4 := RTableRow{ Tags: map[string]string{ "index": "3", }, Fields: map[string]interface{}{ "myfield3": float64(9.999), }, } assert.Len(t, tb.Rows, 4) assert.Contains(t, tb.Rows, rtr1) assert.Contains(t, tb.Rows, rtr2) assert.Contains(t, tb.Rows, rtr3) assert.Contains(t, tb.Rows, rtr4) } func TestTableBuild_noWalk(t *testing.T) { tbl := Table{ Name: "mytable", Fields: []Field{ { Name: "myfield1", Oid: ".1.0.0.1.1", IsTag: true, }, { Name: "myfield2", Oid: ".1.0.0.1.2", }, { Name: "myfield3", Oid: ".1.0.0.1.2", IsTag: true, }, { Name: "empty", Oid: ".1.0.0.0.1.1.2", }, { Name: "noexist", Oid: ".1.2.3.4.5", }, }, } tb, err := tbl.Build(tsc, false, NewNetsnmpTranslator()) 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 := &Snmp{ Agents: []string{"TestGather"}, Name: "mytable", Fields: []Field{ { Name: "myfield1", Oid: ".1.0.0.1.1", IsTag: true, }, { Name: "myfield2", Oid: ".1.0.0.1.2", }, { Name: "myfield3", Oid: "1.0.0.1.1", }, }, Tables: []Table{ { Name: "myOtherTable", InheritTags: []string{"myfield1"}, Fields: []Field{ { Name: "myOtherField", Oid: ".1.0.0.0.1.5", }, }, }, }, connectionCache: []snmpConnection{ tsc, }, } acc := &testutil.Accumulator{} tstart := time.Now() require.NoError(t, 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[s.AgentHostTag]) 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.After(m.Time)) assert.True(t, !tstop.Before(m.Time)) m2 := acc.Metrics[1] assert.Equal(t, "myOtherTable", m2.Measurement) assert.Equal(t, "tsc", m2.Tags[s.AgentHostTag]) 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 := &Snmp{ Agents: []string{"TestGather"}, Name: "mytable", Fields: []Field{ { Name: "host", Oid: ".1.0.0.1.1", IsTag: true, }, { Name: "myfield2", Oid: ".1.0.0.1.2", }, }, connectionCache: []snmpConnection{ tsc, }, } acc := &testutil.Accumulator{} require.NoError(t, 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"), "", "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)}, {float64(0.123123123123), "float", float64(0.123123123123)}, {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)}, {"123123123123", "int", int64(123123123123)}, {[]byte("123123123123"), "int", int64(123123123123)}, {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)}, {[]byte("abcdef"), "hwaddr", "61:62:63:64:65:66"}, {"abcdef", "hwaddr", "61:62:63:64:65:66"}, {[]byte("abcd"), "ipaddr", "97.98.99.100"}, {"abcd", "ipaddr", "97.98.99.100"}, {[]byte("abcdefghijklmnop"), "ipaddr", "6162:6364:6566:6768:696a:6b6c:6d6e:6f70"}, {[]byte{0x00, 0x09, 0x3E, 0xE3, 0xF6, 0xD5, 0x3B, 0x60}, "hextoint:BigEndian:uint64", uint64(2602423610063712)}, {[]byte{0x00, 0x09, 0x3E, 0xE3}, "hextoint:BigEndian:uint32", uint32(605923)}, {[]byte{0x00, 0x09}, "hextoint:BigEndian:uint16", uint16(9)}, {[]byte{0x00, 0x09, 0x3E, 0xE3, 0xF6, 0xD5, 0x3B, 0x60}, "hextoint:LittleEndian:uint64", uint64(6934371307618175232)}, {[]byte{0x00, 0x09, 0x3E, 0xE3}, "hextoint:LittleEndian:uint32", uint32(3812493568)}, {[]byte{0x00, 0x09}, "hextoint:LittleEndian:uint16", uint16(2304)}, } for _, tc := range testTable { act, err := fieldConvert(tc.conv, tc.input) if !assert.NoError(t, err, "input=%T(%v) conv=%s expected=%T(%v)", tc.input, tc.input, tc.conv, tc.expected, tc.expected) { continue } 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 TestSnmpTranslateCache_miss(t *testing.T) { snmpTranslateCaches = nil oid := "IF-MIB::ifPhysAddress.1" mibName, oidNum, oidText, conversion, err := NewNetsnmpTranslator().SnmpTranslate(oid) assert.Len(t, snmpTranslateCaches, 1) stc := snmpTranslateCaches[oid] require.NotNil(t, stc) assert.Equal(t, mibName, stc.mibName) assert.Equal(t, oidNum, stc.oidNum) assert.Equal(t, oidText, stc.oidText) assert.Equal(t, conversion, stc.conversion) assert.Equal(t, err, stc.err) } func TestSnmpTranslateCache_hit(t *testing.T) { snmpTranslateCaches = map[string]snmpTranslateCache{ "foo": { mibName: "a", oidNum: "b", oidText: "c", conversion: "d", err: fmt.Errorf("e"), }, } mibName, oidNum, oidText, conversion, err := NewNetsnmpTranslator().SnmpTranslate("foo") assert.Equal(t, "a", mibName) assert.Equal(t, "b", oidNum) assert.Equal(t, "c", oidText) assert.Equal(t, "d", conversion) assert.Equal(t, fmt.Errorf("e"), err) snmpTranslateCaches = nil } func TestSnmpTableCache_miss(t *testing.T) { snmpTableCaches = nil oid := ".1.0.0.0" mibName, oidNum, oidText, fields, err := NewNetsnmpTranslator().SnmpTable(oid) assert.Len(t, snmpTableCaches, 1) stc := snmpTableCaches[oid] require.NotNil(t, stc) assert.Equal(t, mibName, stc.mibName) assert.Equal(t, oidNum, stc.oidNum) assert.Equal(t, oidText, stc.oidText) assert.Equal(t, fields, stc.fields) assert.Equal(t, err, stc.err) } func TestSnmpTableCache_hit(t *testing.T) { snmpTableCaches = map[string]snmpTableCache{ "foo": { mibName: "a", oidNum: "b", oidText: "c", fields: []Field{{Name: "d"}}, err: fmt.Errorf("e"), }, } mibName, oidNum, oidText, fields, err := NewNetsnmpTranslator().SnmpTable("foo") assert.Equal(t, "a", mibName) assert.Equal(t, "b", oidNum) assert.Equal(t, "c", oidText) assert.Equal(t, []Field{{Name: "d"}}, fields) assert.Equal(t, fmt.Errorf("e"), err) } func TestTableJoin_walk(t *testing.T) { tbl := Table{ Name: "mytable", IndexAsTag: true, Fields: []Field{ { Name: "myfield1", Oid: ".1.0.0.3.1.1", IsTag: true, }, { Name: "myfield2", Oid: ".1.0.0.3.1.2", }, { Name: "myfield3", Oid: ".1.0.0.3.1.3", SecondaryIndexTable: true, }, { Name: "myfield4", Oid: ".1.0.0.0.1.1", SecondaryIndexUse: true, IsTag: true, }, { Name: "myfield5", Oid: ".1.0.0.0.1.2", SecondaryIndexUse: true, }, }, } tb, err := tbl.Build(tsc, true, NewNetsnmpTranslator()) require.NoError(t, err) assert.Equal(t, tb.Name, "mytable") rtr1 := RTableRow{ Tags: map[string]string{ "myfield1": "instance", "myfield4": "bar", "index": "10", }, Fields: map[string]interface{}{ "myfield2": 10, "myfield3": 1, "myfield5": 2, }, } rtr2 := RTableRow{ Tags: map[string]string{ "myfield1": "instance2", "index": "11", }, Fields: map[string]interface{}{ "myfield2": 20, "myfield3": 2, "myfield5": 0, }, } rtr3 := RTableRow{ Tags: map[string]string{ "myfield1": "instance3", "index": "12", }, Fields: map[string]interface{}{ "myfield2": 20, "myfield3": 3, }, } assert.Len(t, tb.Rows, 3) assert.Contains(t, tb.Rows, rtr1) assert.Contains(t, tb.Rows, rtr2) assert.Contains(t, tb.Rows, rtr3) } func TestTableOuterJoin_walk(t *testing.T) { tbl := Table{ Name: "mytable", IndexAsTag: true, Fields: []Field{ { Name: "myfield1", Oid: ".1.0.0.3.1.1", IsTag: true, }, { Name: "myfield2", Oid: ".1.0.0.3.1.2", }, { Name: "myfield3", Oid: ".1.0.0.3.1.3", SecondaryIndexTable: true, SecondaryOuterJoin: true, }, { Name: "myfield4", Oid: ".1.0.0.0.1.1", SecondaryIndexUse: true, IsTag: true, }, { Name: "myfield5", Oid: ".1.0.0.0.1.2", SecondaryIndexUse: true, }, }, } tb, err := tbl.Build(tsc, true, NewNetsnmpTranslator()) require.NoError(t, err) assert.Equal(t, tb.Name, "mytable") rtr1 := RTableRow{ Tags: map[string]string{ "myfield1": "instance", "myfield4": "bar", "index": "10", }, Fields: map[string]interface{}{ "myfield2": 10, "myfield3": 1, "myfield5": 2, }, } rtr2 := RTableRow{ Tags: map[string]string{ "myfield1": "instance2", "index": "11", }, Fields: map[string]interface{}{ "myfield2": 20, "myfield3": 2, "myfield5": 0, }, } rtr3 := RTableRow{ Tags: map[string]string{ "myfield1": "instance3", "index": "12", }, Fields: map[string]interface{}{ "myfield2": 20, "myfield3": 3, }, } rtr4 := RTableRow{ Tags: map[string]string{ "index": "Secondary.0", "myfield4": "foo", }, Fields: map[string]interface{}{ "myfield5": 1, }, } assert.Len(t, tb.Rows, 4) assert.Contains(t, tb.Rows, rtr1) assert.Contains(t, tb.Rows, rtr2) assert.Contains(t, tb.Rows, rtr3) assert.Contains(t, tb.Rows, rtr4) } func TestTableJoinNoIndexAsTag_walk(t *testing.T) { tbl := Table{ Name: "mytable", IndexAsTag: false, Fields: []Field{ { Name: "myfield1", Oid: ".1.0.0.3.1.1", IsTag: true, }, { Name: "myfield2", Oid: ".1.0.0.3.1.2", }, { Name: "myfield3", Oid: ".1.0.0.3.1.3", SecondaryIndexTable: true, }, { Name: "myfield4", Oid: ".1.0.0.0.1.1", SecondaryIndexUse: true, IsTag: true, }, { Name: "myfield5", Oid: ".1.0.0.0.1.2", SecondaryIndexUse: true, }, }, } tb, err := tbl.Build(tsc, true, NewNetsnmpTranslator()) require.NoError(t, err) assert.Equal(t, tb.Name, "mytable") rtr1 := RTableRow{ Tags: map[string]string{ "myfield1": "instance", "myfield4": "bar", //"index": "10", }, Fields: map[string]interface{}{ "myfield2": 10, "myfield3": 1, "myfield5": 2, }, } rtr2 := RTableRow{ Tags: map[string]string{ "myfield1": "instance2", //"index": "11", }, Fields: map[string]interface{}{ "myfield2": 20, "myfield3": 2, "myfield5": 0, }, } rtr3 := RTableRow{ Tags: map[string]string{ "myfield1": "instance3", //"index": "12", }, Fields: map[string]interface{}{ "myfield2": 20, "myfield3": 3, }, } assert.Len(t, tb.Rows, 3) assert.Contains(t, tb.Rows, rtr1) assert.Contains(t, tb.Rows, rtr2) assert.Contains(t, tb.Rows, rtr3) }