Context RequestValues for ygnmi queries

* Values are added at Subscribe/Get calls. * Tests added for both compress/uncompressed queries. NewContext/FromContext are the calls that add/extract context values.
openconfig · Dec 2, 2023 · 34f8a6c · 34f8a6c
1 parent 9cd33e2
commit 34f8a6c
Show file tree

Hide file tree

Showing 46 changed files with 494 additions and 92 deletions.
diff --git a/exampleoc/a/a-0.go b/exampleoc/a/a-0.go
@@ -16,7 +16,7 @@
 Package a is a generated package which contains definitions
 of structs which generate gNMI paths for a YANG schema.
 
-This package was generated by ygnmi version: (devel): (ygot: v0.29.12)
+This package was generated by ygnmi version: (devel): (ygot: v0.29.16)
 using the following YANG input files:
   - ../pathgen/testdata/yang/openconfig-simple.yang
   - ../pathgen/testdata/yang/openconfig-withlistval.yang

diff --git a/exampleoc/enum.go b/exampleoc/enum.go
@@ -18,7 +18,7 @@ of structs which represent a YANG schema. The generated schema can be
 compressed by a series of transformations (compression was true
 in this case).
 
-This package was generated by ygnmi version: (devel): (ygot: v0.29.12)
+This package was generated by ygnmi version: (devel): (ygot: v0.29.16)
 using the following YANG input files:
   - ../pathgen/testdata/yang/openconfig-simple.yang
   - ../pathgen/testdata/yang/openconfig-withlistval.yang

diff --git a/exampleoc/enum_map.go b/exampleoc/enum_map.go
@@ -18,7 +18,7 @@ of structs which represent a YANG schema. The generated schema can be
 compressed by a series of transformations (compression was true
 in this case).
 
-This package was generated by ygnmi version: (devel): (ygot: v0.29.12)
+This package was generated by ygnmi version: (devel): (ygot: v0.29.16)
 using the following YANG input files:
   - ../pathgen/testdata/yang/openconfig-simple.yang
   - ../pathgen/testdata/yang/openconfig-withlistval.yang

diff --git a/exampleoc/exampleocpath/exampleocpath.go b/exampleoc/exampleocpath/exampleocpath.go
@@ -16,7 +16,7 @@
 Package exampleocpath is a generated package which contains definitions
 of structs which generate gNMI paths for a YANG schema.
 
-This package was generated by ygnmi version: (devel): (ygot: v0.29.12)
+This package was generated by ygnmi version: (devel): (ygot: v0.29.16)
 using the following YANG input files:
   - ../pathgen/testdata/yang/openconfig-simple.yang
   - ../pathgen/testdata/yang/openconfig-withlistval.yang

diff --git a/exampleoc/modelb/modelb-0.go b/exampleoc/modelb/modelb-0.go
@@ -16,7 +16,7 @@
 Package modelb is a generated package which contains definitions
 of structs which generate gNMI paths for a YANG schema.
 
-This package was generated by ygnmi version: (devel): (ygot: v0.29.12)
+This package was generated by ygnmi version: (devel): (ygot: v0.29.16)
 using the following YANG input files:
   - ../pathgen/testdata/yang/openconfig-simple.yang
   - ../pathgen/testdata/yang/openconfig-withlistval.yang

diff --git a/exampleoc/schema.go b/exampleoc/schema.go
@@ -18,7 +18,7 @@ of structs which represent a YANG schema. The generated schema can be
 compressed by a series of transformations (compression was true
 in this case).
 
-This package was generated by ygnmi version: (devel): (ygot: v0.29.12)
+This package was generated by ygnmi version: (devel): (ygot: v0.29.16)
 using the following YANG input files:
   - ../pathgen/testdata/yang/openconfig-simple.yang
   - ../pathgen/testdata/yang/openconfig-withlistval.yang

diff --git a/exampleoc/structs-0.go b/exampleoc/structs-0.go
@@ -18,7 +18,7 @@ of structs which represent a YANG schema. The generated schema can be
 compressed by a series of transformations (compression was true
 in this case).
 
-This package was generated by ygnmi version: (devel): (ygot: v0.29.12)
+This package was generated by ygnmi version: (devel): (ygot: v0.29.16)
 using the following YANG input files:
   - ../pathgen/testdata/yang/openconfig-simple.yang
   - ../pathgen/testdata/yang/openconfig-withlistval.yang

diff --git a/exampleoc/union.go b/exampleoc/union.go
@@ -18,7 +18,7 @@ of structs which represent a YANG schema. The generated schema can be
 compressed by a series of transformations (compression was true
 in this case).
 
-This package was generated by ygnmi version: (devel): (ygot: v0.29.12)
+This package was generated by ygnmi version: (devel): (ygot: v0.29.16)
 using the following YANG input files:
   - ../pathgen/testdata/yang/openconfig-simple.yang
   - ../pathgen/testdata/yang/openconfig-withlistval.yang

diff --git a/internal/exampleocconfig/a/a-0.go b/internal/exampleocconfig/a/a-0.go
@@ -16,7 +16,7 @@
 Package a is a generated package which contains definitions
 of structs which generate gNMI paths for a YANG schema.
 
-This package was generated by ygnmi version: (devel): (ygot: v0.29.12)
+This package was generated by ygnmi version: (devel): (ygot: v0.29.16)
 using the following YANG input files:
   - ../../pathgen/testdata/yang/openconfig-simple.yang
   - ../../pathgen/testdata/yang/openconfig-withlistval.yang

diff --git a/internal/exampleocconfig/enum.go b/internal/exampleocconfig/enum.go
@@ -18,7 +18,7 @@ of structs which represent a YANG schema. The generated schema can be
 compressed by a series of transformations (compression was true
 in this case).
 
-This package was generated by ygnmi version: (devel): (ygot: v0.29.12)
+This package was generated by ygnmi version: (devel): (ygot: v0.29.16)
 using the following YANG input files:
   - ../../pathgen/testdata/yang/openconfig-simple.yang
   - ../../pathgen/testdata/yang/openconfig-withlistval.yang

diff --git a/internal/exampleocconfig/enum_map.go b/internal/exampleocconfig/enum_map.go
@@ -18,7 +18,7 @@ of structs which represent a YANG schema. The generated schema can be
 compressed by a series of transformations (compression was true
 in this case).
 
-This package was generated by ygnmi version: (devel): (ygot: v0.29.12)
+This package was generated by ygnmi version: (devel): (ygot: v0.29.16)
 using the following YANG input files:
   - ../../pathgen/testdata/yang/openconfig-simple.yang
   - ../../pathgen/testdata/yang/openconfig-withlistval.yang

diff --git a/internal/exampleocconfig/exampleocconfigpath/exampleocconfigpath.go b/internal/exampleocconfig/exampleocconfigpath/exampleocconfigpath.go
@@ -16,7 +16,7 @@
 Package exampleocconfigpath is a generated package which contains definitions
 of structs which generate gNMI paths for a YANG schema.
 
-This package was generated by ygnmi version: (devel): (ygot: v0.29.12)
+This package was generated by ygnmi version: (devel): (ygot: v0.29.16)
 using the following YANG input files:
   - ../../pathgen/testdata/yang/openconfig-simple.yang
   - ../../pathgen/testdata/yang/openconfig-withlistval.yang

diff --git a/internal/exampleocconfig/modelb/modelb-0.go b/internal/exampleocconfig/modelb/modelb-0.go
@@ -16,7 +16,7 @@
 Package modelb is a generated package which contains definitions
 of structs which generate gNMI paths for a YANG schema.
 
-This package was generated by ygnmi version: (devel): (ygot: v0.29.12)
+This package was generated by ygnmi version: (devel): (ygot: v0.29.16)
 using the following YANG input files:
   - ../../pathgen/testdata/yang/openconfig-simple.yang
   - ../../pathgen/testdata/yang/openconfig-withlistval.yang

diff --git a/internal/exampleocconfig/schema.go b/internal/exampleocconfig/schema.go
@@ -18,7 +18,7 @@ of structs which represent a YANG schema. The generated schema can be
 compressed by a series of transformations (compression was true
 in this case).
 
-This package was generated by ygnmi version: (devel): (ygot: v0.29.12)
+This package was generated by ygnmi version: (devel): (ygot: v0.29.16)
 using the following YANG input files:
   - ../../pathgen/testdata/yang/openconfig-simple.yang
   - ../../pathgen/testdata/yang/openconfig-withlistval.yang

diff --git a/internal/exampleocconfig/structs-0.go b/internal/exampleocconfig/structs-0.go
@@ -18,7 +18,7 @@ of structs which represent a YANG schema. The generated schema can be
 compressed by a series of transformations (compression was true
 in this case).
 
-This package was generated by ygnmi version: (devel): (ygot: v0.29.12)
+This package was generated by ygnmi version: (devel): (ygot: v0.29.16)
 using the following YANG input files:
   - ../../pathgen/testdata/yang/openconfig-simple.yang
   - ../../pathgen/testdata/yang/openconfig-withlistval.yang

diff --git a/internal/exampleocconfig/union.go b/internal/exampleocconfig/union.go
@@ -18,7 +18,7 @@ of structs which represent a YANG schema. The generated schema can be
 compressed by a series of transformations (compression was true
 in this case).
 
-This package was generated by ygnmi version: (devel): (ygot: v0.29.12)
+This package was generated by ygnmi version: (devel): (ygot: v0.29.16)
 using the following YANG input files:
   - ../../pathgen/testdata/yang/openconfig-simple.yang
   - ../../pathgen/testdata/yang/openconfig-withlistval.yang

diff --git a/internal/exampleocunordered/enum.go b/internal/exampleocunordered/enum.go
@@ -18,7 +18,7 @@ of structs which represent a YANG schema. The generated schema can be
 compressed by a series of transformations (compression was true
 in this case).
 
-This package was generated by ygnmi version: (devel): (ygot: v0.29.12)
+This package was generated by ygnmi version: (devel): (ygot: v0.29.16)
 using the following YANG input files:
   - ../../pathgen/testdata/yang/openconfig-simple.yang
   - ../../pathgen/testdata/yang/openconfig-withlistval.yang

diff --git a/internal/exampleocunordered/enum_map.go b/internal/exampleocunordered/enum_map.go
@@ -18,7 +18,7 @@ of structs which represent a YANG schema. The generated schema can be
 compressed by a series of transformations (compression was true
 in this case).
 
-This package was generated by ygnmi version: (devel): (ygot: v0.29.12)
+This package was generated by ygnmi version: (devel): (ygot: v0.29.16)
 using the following YANG input files:
   - ../../pathgen/testdata/yang/openconfig-simple.yang
   - ../../pathgen/testdata/yang/openconfig-withlistval.yang

diff --git a/internal/exampleocunordered/exampleocunorderedpath/exampleocunorderedpath.go b/internal/exampleocunordered/exampleocunorderedpath/exampleocunorderedpath.go
@@ -16,7 +16,7 @@
 Package exampleocunorderedpath is a generated package which contains definitions
 of structs which generate gNMI paths for a YANG schema.
 
-This package was generated by ygnmi version: (devel): (ygot: v0.29.12)
+This package was generated by ygnmi version: (devel): (ygot: v0.29.16)
 using the following YANG input files:
   - ../../pathgen/testdata/yang/openconfig-simple.yang
   - ../../pathgen/testdata/yang/openconfig-withlistval.yang

diff --git a/internal/exampleocunordered/nested/nested-0.go b/internal/exampleocunordered/nested/nested-0.go
@@ -16,7 +16,7 @@
 Package nested is a generated package which contains definitions
 of structs which generate gNMI paths for a YANG schema.
 
-This package was generated by ygnmi version: (devel): (ygot: v0.29.12)
+This package was generated by ygnmi version: (devel): (ygot: v0.29.16)
 using the following YANG input files:
   - ../../pathgen/testdata/yang/openconfig-simple.yang
   - ../../pathgen/testdata/yang/openconfig-withlistval.yang

diff --git a/internal/exampleocunordered/schema.go b/internal/exampleocunordered/schema.go
@@ -18,7 +18,7 @@ of structs which represent a YANG schema. The generated schema can be
 compressed by a series of transformations (compression was true
 in this case).
 
-This package was generated by ygnmi version: (devel): (ygot: v0.29.12)
+This package was generated by ygnmi version: (devel): (ygot: v0.29.16)
 using the following YANG input files:
   - ../../pathgen/testdata/yang/openconfig-simple.yang
   - ../../pathgen/testdata/yang/openconfig-withlistval.yang

diff --git a/internal/exampleocunordered/simple/simple-0.go b/internal/exampleocunordered/simple/simple-0.go
@@ -16,7 +16,7 @@
 Package simple is a generated package which contains definitions
 of structs which generate gNMI paths for a YANG schema.
 
-This package was generated by ygnmi version: (devel): (ygot: v0.29.12)
+This package was generated by ygnmi version: (devel): (ygot: v0.29.16)
 using the following YANG input files:
   - ../../pathgen/testdata/yang/openconfig-simple.yang
   - ../../pathgen/testdata/yang/openconfig-withlistval.yang

diff --git a/internal/exampleocunordered/structs-0.go b/internal/exampleocunordered/structs-0.go
@@ -18,7 +18,7 @@ of structs which represent a YANG schema. The generated schema can be
 compressed by a series of transformations (compression was true
 in this case).
 
-This package was generated by ygnmi version: (devel): (ygot: v0.29.12)
+This package was generated by ygnmi version: (devel): (ygot: v0.29.16)
 using the following YANG input files:
   - ../../pathgen/testdata/yang/openconfig-simple.yang
   - ../../pathgen/testdata/yang/openconfig-withlistval.yang

diff --git a/internal/exampleocunordered/union.go b/internal/exampleocunordered/union.go
@@ -18,7 +18,7 @@ of structs which represent a YANG schema. The generated schema can be
 compressed by a series of transformations (compression was true
 in this case).
 
-This package was generated by ygnmi version: (devel): (ygot: v0.29.12)
+This package was generated by ygnmi version: (devel): (ygot: v0.29.16)
 using the following YANG input files:
   - ../../pathgen/testdata/yang/openconfig-simple.yang
   - ../../pathgen/testdata/yang/openconfig-withlistval.yang

diff --git a/internal/exampleocunordered/withlistval/withlistval-0.go b/internal/exampleocunordered/withlistval/withlistval-0.go
@@ -16,7 +16,7 @@
 Package withlistval is a generated package which contains definitions
 of structs which generate gNMI paths for a YANG schema.
 
-This package was generated by ygnmi version: (devel): (ygot: v0.29.12)
+This package was generated by ygnmi version: (devel): (ygot: v0.29.16)
 using the following YANG input files:
   - ../../pathgen/testdata/yang/openconfig-simple.yang
   - ../../pathgen/testdata/yang/openconfig-withlistval.yang

diff --git a/internal/gnmitestutil/gnmi.go b/internal/gnmitestutil/gnmi.go
@@ -20,6 +20,7 @@ import (
 	"io"
 
 	"github.com/openconfig/gnmi/testing/fake/gnmi"
+	"github.com/openconfig/ygnmi/ygnmi"
 	"github.com/pkg/errors"
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/credentials/local"
@@ -32,7 +33,7 @@ import (
 type FakeGNMI struct {
 	agent         *gnmi.Agent
 	stub          *Stubber
-	clientWrapper *clientWithGetter
+	clientWrapper *clientWrap
 }
 
 // StartGNMI launches a new fake GNMI server on the given port
@@ -53,7 +54,7 @@ func StartGNMI(port int) (*FakeGNMI, error) {
 	return &FakeGNMI{
 		agent:         agent,
 		stub:          stub,
-		clientWrapper: &clientWithGetter{stub: stub},
+		clientWrapper: &clientWrap{stub: stub},
 	}, nil
 }
 
@@ -79,22 +80,30 @@ func (g *FakeGNMI) Requests() []*gpb.SubscribeRequest {
 	return g.agent.Requests()
 }
 
+// Requests returns the request-scoped values from the last ygnmi request sent
+// to the gNMI server.
+func (g *FakeGNMI) LastRequestContextValues() *ygnmi.RequestValues {
+	return g.clientWrapper.requestValues
+}
+
 // GetRequests returns the set of GetRequests sent to the gNMI server.
 //
 // They're ordered in reverse time of request.
 func (g *FakeGNMI) GetRequests() []*gpb.GetRequest {
 	return g.clientWrapper.getRequests
 }
 
-// clientWithGetter adds gNMI Get functionality to a GNMI client.
-type clientWithGetter struct {
+// clientWrap adds gNMI Get functionality to a GNMI client.
+type clientWrap struct {
 	gpb.GNMIClient
-	stub        *Stubber
-	getRequests []*gpb.GetRequest
+	stub          *Stubber
+	getRequests   []*gpb.GetRequest
+	requestValues *ygnmi.RequestValues
 }
 
 // Get is a fake implementation of gnmi.Get, it returns the GetResponse contained in the stub.
-func (g *clientWithGetter) Get(ctx context.Context, req *gpb.GetRequest, _ ...grpc.CallOption) (*gpb.GetResponse, error) {
+func (g *clientWrap) Get(ctx context.Context, req *gpb.GetRequest, _ ...grpc.CallOption) (*gpb.GetResponse, error) {
+	g.requestValues = ygnmi.FromContext(ctx)
 	g.getRequests = append([]*gpb.GetRequest{req}, g.getRequests...)
 	if len(g.stub.getResponses) == 0 {
 		return nil, io.EOF
@@ -106,6 +115,12 @@ func (g *clientWithGetter) Get(ctx context.Context, req *gpb.GetRequest, _ ...gr
 	return resp, err
 }
 
+// Subscribe is a wrapper of the fake implementation of gnmi.Subscribe.
+func (g *clientWrap) Subscribe(ctx context.Context, opts ...grpc.CallOption) (gpb.GNMI_SubscribeClient, error) {
+	g.requestValues = ygnmi.FromContext(ctx)
+	return g.GNMIClient.Subscribe(ctx, opts...)
+}
+
 // Stubber is a handle to add stubbed responses.
 type Stubber struct {
 	gen          *fpb.FixedGenerator

diff --git a/internal/uexampleoc/a/a-0.go b/internal/uexampleoc/a/a-0.go
@@ -16,7 +16,7 @@
 Package a is a generated package which contains definitions
 of structs which generate gNMI paths for a YANG schema.
 
-This package was generated by ygnmi version: (devel): (ygot: v0.29.12)
+This package was generated by ygnmi version: (devel): (ygot: v0.29.16)
 using the following YANG input files:
   - ../../pathgen/testdata/yang/openconfig-simple.yang
   - ../../pathgen/testdata/yang/openconfig-withlistval.yang

diff --git a/internal/uexampleoc/enum.go b/internal/uexampleoc/enum.go
@@ -18,7 +18,7 @@ of structs which represent a YANG schema. The generated schema can be
 compressed by a series of transformations (compression was false
 in this case).
 
-This package was generated by ygnmi version: (devel): (ygot: v0.29.12)
+This package was generated by ygnmi version: (devel): (ygot: v0.29.16)
 using the following YANG input files:
   - ../../pathgen/testdata/yang/openconfig-simple.yang
   - ../../pathgen/testdata/yang/openconfig-withlistval.yang

diff --git a/internal/uexampleoc/enum_map.go b/internal/uexampleoc/enum_map.go
@@ -18,7 +18,7 @@ of structs which represent a YANG schema. The generated schema can be
 compressed by a series of transformations (compression was false
 in this case).
 
-This package was generated by ygnmi version: (devel): (ygot: v0.29.12)
+This package was generated by ygnmi version: (devel): (ygot: v0.29.16)
 using the following YANG input files:
   - ../../pathgen/testdata/yang/openconfig-simple.yang
   - ../../pathgen/testdata/yang/openconfig-withlistval.yang

diff --git a/internal/uexampleoc/modelb/modelb-0.go b/internal/uexampleoc/modelb/modelb-0.go
@@ -16,7 +16,7 @@
 Package modelb is a generated package which contains definitions
 of structs which generate gNMI paths for a YANG schema.
 
-This package was generated by ygnmi version: (devel): (ygot: v0.29.12)
+This package was generated by ygnmi version: (devel): (ygot: v0.29.16)
 using the following YANG input files:
   - ../../pathgen/testdata/yang/openconfig-simple.yang
   - ../../pathgen/testdata/yang/openconfig-withlistval.yang

diff --git a/internal/uexampleoc/nested/nested-0.go b/internal/uexampleoc/nested/nested-0.go
@@ -16,7 +16,7 @@
 Package nested is a generated package which contains definitions
 of structs which generate gNMI paths for a YANG schema.
 
-This package was generated by ygnmi version: (devel): (ygot: v0.29.12)
+This package was generated by ygnmi version: (devel): (ygot: v0.29.16)
 using the following YANG input files:
   - ../../pathgen/testdata/yang/openconfig-simple.yang
   - ../../pathgen/testdata/yang/openconfig-withlistval.yang

diff --git a/internal/uexampleoc/schema.go b/internal/uexampleoc/schema.go
@@ -18,7 +18,7 @@ of structs which represent a YANG schema. The generated schema can be
 compressed by a series of transformations (compression was false
 in this case).
 
-This package was generated by ygnmi version: (devel): (ygot: v0.29.12)
+This package was generated by ygnmi version: (devel): (ygot: v0.29.16)
 using the following YANG input files:
   - ../../pathgen/testdata/yang/openconfig-simple.yang
   - ../../pathgen/testdata/yang/openconfig-withlistval.yang

diff --git a/internal/uexampleoc/simple/simple-0.go b/internal/uexampleoc/simple/simple-0.go
@@ -16,7 +16,7 @@
 Package simple is a generated package which contains definitions
 of structs which generate gNMI paths for a YANG schema.
 
-This package was generated by ygnmi version: (devel): (ygot: v0.29.12)
+This package was generated by ygnmi version: (devel): (ygot: v0.29.16)
 using the following YANG input files:
   - ../../pathgen/testdata/yang/openconfig-simple.yang
   - ../../pathgen/testdata/yang/openconfig-withlistval.yang

diff --git a/internal/uexampleoc/structs-0.go b/internal/uexampleoc/structs-0.go
@@ -18,7 +18,7 @@ of structs which represent a YANG schema. The generated schema can be
 compressed by a series of transformations (compression was false
 in this case).
 
-This package was generated by ygnmi version: (devel): (ygot: v0.29.12)
+This package was generated by ygnmi version: (devel): (ygot: v0.29.16)
 using the following YANG input files:
   - ../../pathgen/testdata/yang/openconfig-simple.yang
   - ../../pathgen/testdata/yang/openconfig-withlistval.yang

diff --git a/internal/uexampleoc/uexampleocpath/uexampleocpath.go b/internal/uexampleoc/uexampleocpath/uexampleocpath.go
@@ -16,7 +16,7 @@
 Package uexampleocpath is a generated package which contains definitions
 of structs which generate gNMI paths for a YANG schema.
 
-This package was generated by ygnmi version: (devel): (ygot: v0.29.12)
+This package was generated by ygnmi version: (devel): (ygot: v0.29.16)
 using the following YANG input files:
   - ../../pathgen/testdata/yang/openconfig-simple.yang
   - ../../pathgen/testdata/yang/openconfig-withlistval.yang
@@ -265,7 +265,7 @@ func (b *Batch) Query() ygnmi.SingletonQuery[*oc.Device] {
 		false,
 		false,
 		false,
-		true,
+		false,
 		false,
 		ygnmi.NewDeviceRootBase(),
 		nil,

diff --git a/internal/uexampleoc/union.go b/internal/uexampleoc/union.go
@@ -18,7 +18,7 @@ of structs which represent a YANG schema. The generated schema can be
 compressed by a series of transformations (compression was false
 in this case).
 
-This package was generated by ygnmi version: (devel): (ygot: v0.29.12)
+This package was generated by ygnmi version: (devel): (ygot: v0.29.16)
 using the following YANG input files:
   - ../../pathgen/testdata/yang/openconfig-simple.yang
   - ../../pathgen/testdata/yang/openconfig-withlistval.yang