Add Cisco model-driven telemetry & GNMI inputs (#5852)
This commit is contained in:
Steven Barth
committed by
Daniel Nelson
Daniel Nelson
parent
25471f6722
commit
e18393fabf
247
plugins/inputs/cisco_telemetry_gnmi/cisco_telemetry_gnmi_test.go
Normal file
247
plugins/inputs/cisco_telemetry_gnmi/cisco_telemetry_gnmi_test.go
Normal file
@@ -0,0 +1,247 @@
|
||||
package cisco_telemetry_gnmi
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"fmt"
|
||||
"net"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"google.golang.org/grpc/metadata"
|
||||
|
||||
"github.com/influxdata/telegraf/internal"
|
||||
"github.com/influxdata/telegraf/testutil"
|
||||
"google.golang.org/grpc"
|
||||
|
||||
"github.com/openconfig/gnmi/proto/gnmi"
|
||||
"github.com/stretchr/testify/assert"
|
||||
)
|
||||
|
||||
func TestParsePath(t *testing.T) {
|
||||
path := "/foo/bar/bla[shoo=woo][shoop=/woop/]/z"
|
||||
parsed, err := parsePath("theorigin", path, "thetarget")
|
||||
|
||||
assert.Nil(t, err)
|
||||
assert.Equal(t, parsed.Origin, "theorigin")
|
||||
assert.Equal(t, parsed.Target, "thetarget")
|
||||
assert.Equal(t, parsed.Element, []string{"foo", "bar", "bla[shoo=woo][shoop=/woop/]", "z"})
|
||||
assert.Equal(t, parsed.Elem, []*gnmi.PathElem{{Name: "foo"}, {Name: "bar"},
|
||||
{Name: "bla", Key: map[string]string{"shoo": "woo", "shoop": "/woop/"}}, {Name: "z"}})
|
||||
|
||||
parsed, err = parsePath("", "", "")
|
||||
assert.Nil(t, err)
|
||||
assert.Equal(t, *parsed, gnmi.Path{})
|
||||
|
||||
parsed, err = parsePath("", "/foo[[", "")
|
||||
assert.Nil(t, parsed)
|
||||
assert.Equal(t, errors.New("Invalid GNMI path: /foo[[/"), err)
|
||||
}
|
||||
|
||||
type mockGNMIServer struct {
|
||||
t *testing.T
|
||||
acc *testutil.Accumulator
|
||||
server *grpc.Server
|
||||
scenario int
|
||||
}
|
||||
|
||||
func (m *mockGNMIServer) Capabilities(context.Context, *gnmi.CapabilityRequest) (*gnmi.CapabilityResponse, error) {
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
func (m *mockGNMIServer) Get(context.Context, *gnmi.GetRequest) (*gnmi.GetResponse, error) {
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
func (m *mockGNMIServer) Set(context.Context, *gnmi.SetRequest) (*gnmi.SetResponse, error) {
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
func (m *mockGNMIServer) Subscribe(server gnmi.GNMI_SubscribeServer) error {
|
||||
// Avoid race conditions
|
||||
go func() {
|
||||
if m.scenario == 0 {
|
||||
m.acc.WaitError(1)
|
||||
} else if m.scenario == 1 || m.scenario == 3 {
|
||||
m.acc.Wait(4)
|
||||
} else if m.scenario == 2 {
|
||||
m.acc.Wait(2)
|
||||
}
|
||||
if m.scenario >= 0 {
|
||||
m.server.Stop()
|
||||
}
|
||||
}()
|
||||
|
||||
metadata, ok := metadata.FromIncomingContext(server.Context())
|
||||
assert.Equal(m.t, ok, true)
|
||||
assert.Equal(m.t, metadata.Get("username"), []string{"theuser"})
|
||||
assert.Equal(m.t, metadata.Get("password"), []string{"thepassword"})
|
||||
|
||||
switch m.scenario {
|
||||
case 0:
|
||||
return fmt.Errorf("testerror")
|
||||
case 1:
|
||||
notification := mockGNMINotification()
|
||||
server.Send(&gnmi.SubscribeResponse{Response: &gnmi.SubscribeResponse_Update{Update: notification}})
|
||||
server.Send(&gnmi.SubscribeResponse{Response: &gnmi.SubscribeResponse_SyncResponse{SyncResponse: true}})
|
||||
notification.Prefix.Elem[0].Key["foo"] = "bar2"
|
||||
notification.Update[0].Path.Elem[1].Key["name"] = "str2"
|
||||
notification.Update[0].Val = &gnmi.TypedValue{Value: &gnmi.TypedValue_JsonVal{JsonVal: []byte{'"', '1', '2', '3', '"'}}}
|
||||
server.Send(&gnmi.SubscribeResponse{Response: &gnmi.SubscribeResponse_Update{Update: notification}})
|
||||
return nil
|
||||
case 2:
|
||||
notification := mockGNMINotification()
|
||||
server.Send(&gnmi.SubscribeResponse{Response: &gnmi.SubscribeResponse_Update{Update: notification}})
|
||||
return nil
|
||||
case 3:
|
||||
notification := mockGNMINotification()
|
||||
notification.Prefix.Elem[0].Key["foo"] = "bar2"
|
||||
notification.Update[0].Path.Elem[1].Key["name"] = "str2"
|
||||
notification.Update[0].Val = &gnmi.TypedValue{Value: &gnmi.TypedValue_BoolVal{BoolVal: false}}
|
||||
server.Send(&gnmi.SubscribeResponse{Response: &gnmi.SubscribeResponse_Update{Update: notification}})
|
||||
return nil
|
||||
default:
|
||||
return fmt.Errorf("test not implemented ;)")
|
||||
}
|
||||
}
|
||||
|
||||
func TestGNMIError(t *testing.T) {
|
||||
listener, _ := net.Listen("tcp", "127.0.0.1:57003")
|
||||
server := grpc.NewServer()
|
||||
acc := &testutil.Accumulator{}
|
||||
gnmi.RegisterGNMIServer(server, &mockGNMIServer{t: t, scenario: 0, server: server, acc: acc})
|
||||
|
||||
c := &CiscoTelemetryGNMI{Addresses: []string{"127.0.0.1:57003"},
|
||||
Username: "theuser", Password: "thepassword", Encoding: "proto",
|
||||
Redial: internal.Duration{Duration: 1 * time.Second}}
|
||||
|
||||
assert.Nil(t, c.Start(acc))
|
||||
server.Serve(listener)
|
||||
c.Stop()
|
||||
|
||||
assert.Contains(t, acc.Errors, errors.New("aborted GNMI subscription: rpc error: code = Unknown desc = testerror"))
|
||||
}
|
||||
|
||||
func mockGNMINotification() *gnmi.Notification {
|
||||
return &gnmi.Notification{
|
||||
Timestamp: 1543236572000000000,
|
||||
Prefix: &gnmi.Path{
|
||||
Origin: "type",
|
||||
Elem: []*gnmi.PathElem{
|
||||
{
|
||||
Name: "model",
|
||||
Key: map[string]string{"foo": "bar"},
|
||||
},
|
||||
},
|
||||
Target: "subscription",
|
||||
},
|
||||
Update: []*gnmi.Update{
|
||||
{
|
||||
Path: &gnmi.Path{
|
||||
Elem: []*gnmi.PathElem{
|
||||
{Name: "some"},
|
||||
{
|
||||
Name: "path",
|
||||
Key: map[string]string{"name": "str", "uint64": "1234"}},
|
||||
},
|
||||
},
|
||||
Val: &gnmi.TypedValue{Value: &gnmi.TypedValue_IntVal{IntVal: 5678}},
|
||||
},
|
||||
{
|
||||
Path: &gnmi.Path{
|
||||
Elem: []*gnmi.PathElem{
|
||||
{Name: "other"},
|
||||
{Name: "path"},
|
||||
},
|
||||
},
|
||||
Val: &gnmi.TypedValue{Value: &gnmi.TypedValue_StringVal{StringVal: "foobar"}},
|
||||
},
|
||||
{
|
||||
Path: &gnmi.Path{
|
||||
Elem: []*gnmi.PathElem{
|
||||
{Name: "other"},
|
||||
{Name: "this"},
|
||||
},
|
||||
},
|
||||
Val: &gnmi.TypedValue{Value: &gnmi.TypedValue_StringVal{StringVal: "that"}},
|
||||
},
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
func TestGNMIMultiple(t *testing.T) {
|
||||
listener, _ := net.Listen("tcp", "127.0.0.1:57004")
|
||||
server := grpc.NewServer()
|
||||
acc := &testutil.Accumulator{}
|
||||
gnmi.RegisterGNMIServer(server, &mockGNMIServer{t: t, scenario: 1, server: server, acc: acc})
|
||||
|
||||
c := &CiscoTelemetryGNMI{Addresses: []string{"127.0.0.1:57004"},
|
||||
Username: "theuser", Password: "thepassword", Encoding: "proto",
|
||||
Redial: internal.Duration{Duration: 1 * time.Second},
|
||||
Subscriptions: []Subscription{{Name: "alias", Origin: "type", Path: "/model", SubscriptionMode: "sample"}},
|
||||
}
|
||||
|
||||
assert.Nil(t, c.Start(acc))
|
||||
|
||||
server.Serve(listener)
|
||||
c.Stop()
|
||||
|
||||
assert.Empty(t, acc.Errors)
|
||||
|
||||
tags := map[string]string{"path": "type:/model", "source": "127.0.0.1", "foo": "bar", "name": "str", "uint64": "1234"}
|
||||
fields := map[string]interface{}{"some/path": int64(5678)}
|
||||
acc.AssertContainsTaggedFields(t, "alias", fields, tags)
|
||||
|
||||
tags = map[string]string{"path": "type:/model", "source": "127.0.0.1", "foo": "bar"}
|
||||
fields = map[string]interface{}{"other/path": "foobar", "other/this": "that"}
|
||||
acc.AssertContainsTaggedFields(t, "alias", fields, tags)
|
||||
|
||||
tags = map[string]string{"path": "type:/model", "foo": "bar2", "source": "127.0.0.1", "name": "str2", "uint64": "1234"}
|
||||
fields = map[string]interface{}{"some/path": "123"}
|
||||
acc.AssertContainsTaggedFields(t, "alias", fields, tags)
|
||||
|
||||
tags = map[string]string{"path": "type:/model", "source": "127.0.0.1", "foo": "bar2"}
|
||||
fields = map[string]interface{}{"other/path": "foobar", "other/this": "that"}
|
||||
acc.AssertContainsTaggedFields(t, "alias", fields, tags)
|
||||
}
|
||||
|
||||
func TestGNMIMultipleRedial(t *testing.T) {
|
||||
listener, _ := net.Listen("tcp", "127.0.0.1:57004")
|
||||
server := grpc.NewServer()
|
||||
acc := &testutil.Accumulator{}
|
||||
gnmi.RegisterGNMIServer(server, &mockGNMIServer{t: t, scenario: 2, server: server, acc: acc})
|
||||
|
||||
c := &CiscoTelemetryGNMI{Addresses: []string{"127.0.0.1:57004"},
|
||||
Username: "theuser", Password: "thepassword", Encoding: "proto",
|
||||
Redial: internal.Duration{Duration: 500 * time.Millisecond},
|
||||
Subscriptions: []Subscription{{Name: "alias", Origin: "type", Path: "/model", SubscriptionMode: "sample"}},
|
||||
}
|
||||
|
||||
assert.Nil(t, c.Start(acc))
|
||||
server.Serve(listener)
|
||||
|
||||
listener, _ = net.Listen("tcp", "127.0.0.1:57004")
|
||||
server = grpc.NewServer()
|
||||
gnmi.RegisterGNMIServer(server, &mockGNMIServer{t: t, scenario: 3, server: server, acc: acc})
|
||||
|
||||
server.Serve(listener)
|
||||
c.Stop()
|
||||
|
||||
assert.Empty(t, acc.Errors)
|
||||
|
||||
tags := map[string]string{"path": "type:/model", "source": "127.0.0.1", "foo": "bar", "name": "str", "uint64": "1234"}
|
||||
fields := map[string]interface{}{"some/path": int64(5678)}
|
||||
acc.AssertContainsTaggedFields(t, "alias", fields, tags)
|
||||
|
||||
tags = map[string]string{"path": "type:/model", "source": "127.0.0.1", "foo": "bar"}
|
||||
fields = map[string]interface{}{"other/path": "foobar", "other/this": "that"}
|
||||
acc.AssertContainsTaggedFields(t, "alias", fields, tags)
|
||||
|
||||
tags = map[string]string{"path": "type:/model", "foo": "bar2", "source": "127.0.0.1", "name": "str2", "uint64": "1234"}
|
||||
fields = map[string]interface{}{"some/path": false}
|
||||
acc.AssertContainsTaggedFields(t, "alias", fields, tags)
|
||||
|
||||
tags = map[string]string{"path": "type:/model", "source": "127.0.0.1", "foo": "bar2"}
|
||||
fields = map[string]interface{}{"other/path": "foobar", "other/this": "that"}
|
||||
acc.AssertContainsTaggedFields(t, "alias", fields, tags)
|
||||
}
|
||||
Reference in New Issue
Block a user