-
Notifications
You must be signed in to change notification settings - Fork 55
/
gnmi_msgs.go
1326 lines (1252 loc) · 39.9 KB
/
gnmi_msgs.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// © 2022 Nokia.
//
// This code is a Contribution to the gNMIc project (“Work”) made under the Google Software Grant and Corporate Contributor License Agreement (“CLA”) and governed by the Apache License 2.0.
// No other rights or licenses in or to any of Nokia’s intellectual property are granted for any other purpose.
// This code is provided on an “as is” basis without any warranties of any kind.
//
// SPDX-License-Identifier: Apache-2.0
package api
import (
"bytes"
"encoding/json"
"errors"
"fmt"
"strconv"
"strings"
"time"
"github.com/openconfig/gnmi/proto/gnmi"
"github.com/openconfig/gnmi/proto/gnmi_ext"
gvalue "github.com/openconfig/gnmi/value"
"github.com/openconfig/gnmic/pkg/api/path"
"google.golang.org/protobuf/proto"
)
const (
DefaultGNMIVersion = "0.7.0"
encodingJSON = "json"
encodingJSON_IETF = "json_ietf"
)
// GNMIOption is a function that acts on the supplied proto.Message.
// The message is expected to be one of the protobuf defined gNMI messages
// exchanged by the RPCs or any of the nested messages.
type GNMIOption func(proto.Message) error
// ErrInvalidMsgType is returned by a GNMIOption in case the Option is supplied
// an unexpected proto.Message
var ErrInvalidMsgType = errors.New("invalid message type")
// ErrInvalidValue is returned by a GNMIOption in case the Option is supplied
// an unexpected value.
var ErrInvalidValue = errors.New("invalid value")
// apply is a helper function that simply applies the options to the proto.Message.
// It returns an error if any of the options fails.
func apply(m proto.Message, opts ...GNMIOption) error {
for _, o := range opts {
if err := o(m); err != nil {
return err
}
}
return nil
}
// NewCapabilitiesRequest creates a new *gnmi.CapabilityeRequest using the provided GNMIOption list.
// returns an error in case one of the options is invalid
func NewCapabilitiesRequest(opts ...GNMIOption) (*gnmi.CapabilityRequest, error) {
m := new(gnmi.CapabilityRequest)
err := apply(m, opts...)
if err != nil {
return nil, err
}
return m, nil
}
// NewCapabilitiesResponse creates a new *gnmi.CapabilityResponse using the provided GNMIOption list.
// returns an error in case one of the options is invalid
func NewCapabilitiesResponse(opts ...GNMIOption) (*gnmi.CapabilityResponse, error) {
m := new(gnmi.CapabilityResponse)
err := apply(m, opts...)
if err != nil {
return nil, err
}
if m.GNMIVersion == "" {
m.GNMIVersion = DefaultGNMIVersion
}
return m, nil
}
// NewGetRequest creates a new *gnmi.GetRequest using the provided GNMIOption list.
// returns an error in case one of the options is invalid
func NewGetRequest(opts ...GNMIOption) (*gnmi.GetRequest, error) {
m := new(gnmi.GetRequest)
err := apply(m, opts...)
if err != nil {
return nil, err
}
return m, nil
}
// NewGetResponse creates a new *gnmi.GetResponse using the provided GNMIOption list.
// returns an error in case one of the options is invalid
func NewGetResponse(opts ...GNMIOption) (*gnmi.GetResponse, error) {
m := new(gnmi.GetResponse)
err := apply(m, opts...)
if err != nil {
return nil, err
}
return m, nil
}
// NewSetRequest creates a new *gnmi.SetRequest using the provided GNMIOption list.
// returns an error in case one of the options is invalid
func NewSetRequest(opts ...GNMIOption) (*gnmi.SetRequest, error) {
m := new(gnmi.SetRequest)
err := apply(m, opts...)
return m, err
}
// NewSetResponse creates a new *gnmi.SetResponse using the provided GNMIOption list.
// returns an error in case one of the options is invalid
func NewSetResponse(opts ...GNMIOption) (*gnmi.SetResponse, error) {
m := new(gnmi.SetResponse)
err := apply(m, opts...)
if err != nil {
return nil, err
}
return m, nil
}
// NewSubscribeRequest creates a new *gnmi.SubscribeRequest using the provided GNMIOption list.
// returns an error in case one of the options is invalid
func NewSubscribeRequest(opts ...GNMIOption) (*gnmi.SubscribeRequest, error) {
m := &gnmi.SubscribeRequest{
Request: &gnmi.SubscribeRequest_Subscribe{
Subscribe: new(gnmi.SubscriptionList),
},
}
err := apply(m, opts...)
return m, err
}
// NewSubscribePollRequest creates a new *gnmi.SubscribeRequest with request type Poll
// using the provided GNMIOption list.
// returns an error in case one of the options is invalid
func NewSubscribePollRequest(opts ...GNMIOption) (*gnmi.SubscribeRequest, error) {
m := &gnmi.SubscribeRequest{
Request: &gnmi.SubscribeRequest_Poll{
Poll: new(gnmi.Poll),
},
}
err := apply(m, opts...)
return m, err
}
// NewSubscribeResponse creates a *gnmi.SubscribeResponse with a gnmi.SubscribeResponse_Update as
// response type.
func NewSubscribeResponse(opts ...GNMIOption) (*gnmi.SubscribeResponse, error) {
m := &gnmi.SubscribeResponse{
Response: &gnmi.SubscribeResponse_Update{
Update: new(gnmi.Notification),
},
}
err := apply(m, opts...)
if err != nil {
return nil, err
}
return m, nil
}
// NewSubscribeResponse creates a *gnmi.SubscribeResponse with a gnmi.SubscribeResponse_SyncResponse as
// response type.
func NewSubscribeSyncResponse(opts ...GNMIOption) (*gnmi.SubscribeResponse, error) {
m := &gnmi.SubscribeResponse{
Response: &gnmi.SubscribeResponse_SyncResponse{
SyncResponse: true,
},
}
err := apply(m, opts...)
if err != nil {
return nil, err
}
return m, nil
}
// Messages options
// Version sets the provided gNMI version string in a gnmi.CapabilityResponse message.
func Version(v string) func(msg proto.Message) error {
return func(msg proto.Message) error {
if msg == nil {
return ErrInvalidMsgType
}
switch msg := msg.ProtoReflect().Interface().(type) {
case *gnmi.CapabilityResponse:
msg.GNMIVersion = v
default:
return fmt.Errorf("option Version: %w: %T", ErrInvalidMsgType, msg)
}
return nil
}
}
// SupportedEncoding creates an GNMIOption that sets the provided encodings as supported encodings in a gnmi.CapabilitiesResponse
func SupportedEncoding(encodings ...string) func(msg proto.Message) error {
return func(msg proto.Message) error {
if msg == nil {
return ErrInvalidMsgType
}
switch msg := msg.ProtoReflect().Interface().(type) {
case *gnmi.CapabilityResponse:
if len(msg.SupportedEncodings) == 0 {
msg.SupportedEncodings = make([]gnmi.Encoding, 0)
}
for _, encoding := range encodings {
enc, ok := gnmi.Encoding_value[strings.ToUpper(encoding)]
if !ok {
return fmt.Errorf("option SupportedEncoding: %w: %s", ErrInvalidValue, encoding)
}
msg.SupportedEncodings = append(msg.SupportedEncodings, gnmi.Encoding(enc))
}
default:
return fmt.Errorf("option SupportedEncoding: %w: %T", ErrInvalidMsgType, msg)
}
return nil
}
}
// SupportedModel creates an GNMIOption that sets the provided name, org and version as a supported model in a gnmi.CapabilitiesResponse.
func SupportedModel(name, org, version string) func(msg proto.Message) error {
return func(msg proto.Message) error {
if msg == nil {
return ErrInvalidMsgType
}
switch msg := msg.ProtoReflect().Interface().(type) {
case *gnmi.CapabilityResponse:
if len(msg.SupportedModels) == 0 {
msg.SupportedModels = make([]*gnmi.ModelData, 0)
}
msg.SupportedModels = append(msg.SupportedModels,
&gnmi.ModelData{
Name: name,
Organization: org,
Version: version,
})
default:
return fmt.Errorf("option SupportedModel: %w: %T", ErrInvalidMsgType, msg)
}
return nil
}
}
// Extension creates a GNMIOption that applies the supplied gnmi_ext.Extension to the provided
// proto.Message.
func Extension(ext *gnmi_ext.Extension) func(msg proto.Message) error {
return func(msg proto.Message) error {
if msg == nil {
return ErrInvalidMsgType
}
switch msg := msg.ProtoReflect().Interface().(type) {
case *gnmi.CapabilityRequest:
if len(msg.Extension) == 0 {
msg.Extension = make([]*gnmi_ext.Extension, 0)
}
msg.Extension = append(msg.Extension, ext)
case *gnmi.GetRequest:
if len(msg.Extension) == 0 {
msg.Extension = make([]*gnmi_ext.Extension, 0)
}
msg.Extension = append(msg.Extension, ext)
case *gnmi.GetResponse:
if len(msg.Extension) == 0 {
msg.Extension = make([]*gnmi_ext.Extension, 0)
}
msg.Extension = append(msg.Extension, ext)
case *gnmi.SetRequest:
if len(msg.Extension) == 0 {
msg.Extension = make([]*gnmi_ext.Extension, 0)
}
msg.Extension = append(msg.Extension, ext)
case *gnmi.SetResponse:
if len(msg.Extension) == 0 {
msg.Extension = make([]*gnmi_ext.Extension, 0)
}
msg.Extension = append(msg.Extension, ext)
case *gnmi.SubscribeRequest:
if len(msg.Extension) == 0 {
msg.Extension = make([]*gnmi_ext.Extension, 0)
}
msg.Extension = append(msg.Extension, ext)
case *gnmi.SubscribeResponse:
if len(msg.Extension) == 0 {
msg.Extension = make([]*gnmi_ext.Extension, 0)
}
msg.Extension = append(msg.Extension, ext)
}
return nil
}
}
// Extension_HistorySnapshotTime creates a GNMIOption that adds a gNMI extension of
// type History Snapshot with the supplied snapshot time.
// the snapshot value can be nanoseconds since Unix epoch or a date in RFC3339 format
func Extension_HistorySnapshotTime(tm time.Time) func(msg proto.Message) error {
return func(msg proto.Message) error {
if msg == nil {
return ErrInvalidMsgType
}
switch msg := msg.ProtoReflect().Interface().(type) {
case *gnmi.SubscribeRequest:
fn := Extension(
&gnmi_ext.Extension{
Ext: &gnmi_ext.Extension_History{
History: &gnmi_ext.History{
Request: &gnmi_ext.History_SnapshotTime{
SnapshotTime: tm.UnixNano(),
},
},
},
},
)
return fn(msg)
default:
return fmt.Errorf("option Extension_HistorySnapshotTime: %w: %T", ErrInvalidMsgType, msg)
}
}
}
// Extension_HistoryRange creates a GNMIOption that adds a gNMI extension of
// type History TimeRange with the supplied start and end times.
// the start/end values can be nanoseconds since Unix epoch or a date in RFC3339 format
func Extension_HistoryRange(start, end time.Time) func(msg proto.Message) error {
return func(msg proto.Message) error {
if msg == nil {
return ErrInvalidMsgType
}
switch msg := msg.ProtoReflect().Interface().(type) {
case *gnmi.SubscribeRequest:
fn := Extension(
&gnmi_ext.Extension{
Ext: &gnmi_ext.Extension_History{
History: &gnmi_ext.History{
Request: &gnmi_ext.History_Range{
Range: &gnmi_ext.TimeRange{
Start: start.UnixNano(),
End: end.UnixNano(),
},
},
},
},
},
)
return fn(msg)
default:
return fmt.Errorf("option Extension_HistoryRange: %w: %T", ErrInvalidMsgType, msg)
}
}
}
// Prefix creates a GNMIOption that creates a *gnmi.Path and adds it to the supplied
// proto.Message (as a Path Prefix).
// The proto.Message can be a *gnmi.GetRequest, *gnmi.SetRequest or a *gnmi.SubscribeRequest with RequestType Subscribe.
func Prefix(prefix string) func(msg proto.Message) error {
return func(msg proto.Message) error {
if msg == nil {
return ErrInvalidMsgType
}
var err error
switch msg := msg.ProtoReflect().Interface().(type) {
case *gnmi.GetRequest:
msg.Prefix, err = path.CreatePrefix(prefix, "")
case *gnmi.SetRequest:
msg.Prefix, err = path.CreatePrefix(prefix, "")
case *gnmi.SetResponse:
msg.Prefix, err = path.CreatePrefix(prefix, "")
case *gnmi.SubscribeRequest:
switch msg := msg.Request.(type) {
case *gnmi.SubscribeRequest_Subscribe:
if msg.Subscribe == nil {
msg.Subscribe = new(gnmi.SubscriptionList)
}
msg.Subscribe.Prefix, err = path.CreatePrefix(prefix, "")
default:
return fmt.Errorf("option Prefix: %w: %T", ErrInvalidMsgType, msg)
}
case *gnmi.Notification:
msg.Prefix, err = path.CreatePrefix(prefix, "")
default:
return fmt.Errorf("option Prefix: %w: %T", ErrInvalidMsgType, msg)
}
if err != nil {
return fmt.Errorf("%w: %v", ErrInvalidValue, err)
}
return nil
}
}
// Target creates a GNMIOption that set the gnmi Prefix target to the supplied string value.
// The proto.Message can be a *gnmi.GetRequest, *gnmi.SetRequest or a *gnmi.SubscribeRequest with RequestType Subscribe.
func Target(target string) func(msg proto.Message) error {
return func(msg proto.Message) error {
if msg == nil {
return ErrInvalidMsgType
}
if target == "" {
return nil
}
var err error
switch msg := msg.ProtoReflect().Interface().(type) {
case *gnmi.GetRequest:
if msg.Prefix == nil {
msg.Prefix = new(gnmi.Path)
}
msg.Prefix.Target = target
case *gnmi.SetRequest:
if msg.Prefix == nil {
msg.Prefix = new(gnmi.Path)
}
msg.Prefix.Target = target
case *gnmi.SubscribeRequest:
switch msg := msg.Request.(type) {
case *gnmi.SubscribeRequest_Subscribe:
if msg.Subscribe == nil {
msg.Subscribe = new(gnmi.SubscriptionList)
}
if msg.Subscribe.Prefix == nil {
msg.Subscribe.Prefix = new(gnmi.Path)
}
msg.Subscribe.Prefix.Target = target
default:
return fmt.Errorf("option Target: %w: %T", ErrInvalidMsgType, msg)
}
default:
return fmt.Errorf("option Target: %w: %T", ErrInvalidMsgType, msg)
}
return err
}
}
// Path creates a GNMIOption that creates a *gnmi.Path and adds it to the supplied proto.Message
// which can be a *gnmi.GetRequest, *gnmi.SetRequest or a *gnmi.Subscription.
func Path(p string) func(msg proto.Message) error {
return func(msg proto.Message) error {
if msg == nil {
return ErrInvalidMsgType
}
var err error
switch msg := msg.ProtoReflect().Interface().(type) {
case *gnmi.GetRequest:
gp, err := path.ParsePath(p)
if err != nil {
return fmt.Errorf("%w: %v", ErrInvalidValue, err)
}
if len(msg.Path) == 0 {
msg.Path = make([]*gnmi.Path, 0)
}
msg.Path = append(msg.Path, gp)
case *gnmi.Update:
msg.Path, err = path.ParsePath(p)
if err != nil {
return fmt.Errorf("%w: %v", ErrInvalidValue, err)
}
case *gnmi.UpdateResult:
msg.Path, err = path.ParsePath(p)
if err != nil {
return fmt.Errorf("%w: %v", ErrInvalidValue, err)
}
case *gnmi.Subscription:
msg.Path, err = path.ParsePath(p)
if err != nil {
return fmt.Errorf("%w: %v", ErrInvalidValue, err)
}
default:
return fmt.Errorf("option Path: %w: %T", ErrInvalidMsgType, msg)
}
return nil
}
}
// Encoding creates a GNMIOption that adds the encoding type to the supplied proto.Message
// which can be a *gnmi.GetRequest, *gnmi.SetRequest or a *gnmi.SubscribeRequest with RequestType Subscribe.
func Encoding(encoding string) func(msg proto.Message) error {
return func(msg proto.Message) error {
if msg == nil {
return ErrInvalidMsgType
}
enc, ok := gnmi.Encoding_value[strings.ToUpper(encoding)]
if !ok {
return fmt.Errorf("option Encoding: %w: %s", ErrInvalidValue, encoding)
}
switch msg := msg.ProtoReflect().Interface().(type) {
case *gnmi.GetRequest:
msg.Encoding = gnmi.Encoding(enc)
case *gnmi.SubscribeRequest:
switch msg := msg.Request.(type) {
case *gnmi.SubscribeRequest_Subscribe:
if msg.Subscribe == nil {
msg.Subscribe = new(gnmi.SubscriptionList)
}
msg.Subscribe.Encoding = gnmi.Encoding(enc)
}
default:
return fmt.Errorf("option Encoding: %w: %T", ErrInvalidMsgType, msg)
}
return nil
}
}
// EncodingJSON creates a GNMIOption that sets the encoding type to JSON in a gnmi.GetRequest or
// gnmi.SubscribeRequest.
func EncodingJSON() func(msg proto.Message) error {
return Encoding("JSON")
}
// EncodingBYTES creates a GNMIOption that sets the encoding type to BYTES in a gnmi.GetRequest or
// gnmi.SubscribeRequest.
func EncodingBYTES() func(msg proto.Message) error {
return Encoding("BYTES")
}
// EncodingPROTO creates a GNMIOption that sets the encoding type to PROTO in a gnmi.GetRequest or
// gnmi.SubscribeRequest.
func EncodingPROTO() func(msg proto.Message) error {
return Encoding("PROTO")
}
// EncodingASCII creates a GNMIOption that sets the encoding type to ASCII in a gnmi.GetRequest or
// gnmi.SubscribeRequest.
func EncodingASCII() func(msg proto.Message) error {
return Encoding("ASCII")
}
// EncodingJSON_IETF creates a GNMIOption that sets the encoding type to JSON_IETF in a gnmi.GetRequest or
// gnmi.SubscribeRequest.
func EncodingJSON_IETF() func(msg proto.Message) error {
return Encoding("JSON_IETF")
}
// EncodingCustom creates a GNMIOption that adds the encoding type to the supplied proto.Message
// which can be a *gnmi.GetRequest, *gnmi.SetRequest or a *gnmi.SubscribeRequest with RequestType Subscribe.
// Unlike Encoding, this GNMIOption does not validate if the provided encoding is defined by the gNMI spec.
func EncodingCustom(enc int) func(msg proto.Message) error {
return func(msg proto.Message) error {
if msg == nil {
return ErrInvalidMsgType
}
switch msg := msg.ProtoReflect().Interface().(type) {
case *gnmi.GetRequest:
msg.Encoding = gnmi.Encoding(enc)
case *gnmi.SubscribeRequest:
switch msg := msg.Request.(type) {
case *gnmi.SubscribeRequest_Subscribe:
if msg.Subscribe == nil {
msg.Subscribe = new(gnmi.SubscriptionList)
}
msg.Subscribe.Encoding = gnmi.Encoding(enc)
}
default:
return fmt.Errorf("option EncodingCustom: %w: %T", ErrInvalidMsgType, msg)
}
return nil
}
}
// DataType creates a GNMIOption that adds the data type to the supplied proto.Message
// which must be a *gnmi.GetRequest.
func DataType(datat string) func(msg proto.Message) error {
return func(msg proto.Message) error {
if msg == nil {
return ErrInvalidMsgType
}
if datat == "" {
return nil
}
switch msg := msg.ProtoReflect().Interface().(type) {
case *gnmi.GetRequest:
dt, ok := gnmi.GetRequest_DataType_value[strings.ToUpper(datat)]
if !ok {
return fmt.Errorf("option DataType: %w: %s", ErrInvalidValue, datat)
}
msg.Type = gnmi.GetRequest_DataType(dt)
default:
return fmt.Errorf("option DataType: %w: %T", ErrInvalidMsgType, msg)
}
return nil
}
}
// DataTypeALL creates a GNMIOption that sets the gnmi.GetRequest data type to ALL
func DataTypeALL() func(msg proto.Message) error {
return DataType("ALL")
}
// DataTypeCONFIG creates a GNMIOption that sets the gnmi.GetRequest data type to CONFIG
func DataTypeCONFIG() func(msg proto.Message) error {
return DataType("CONFIG")
}
// DataTypeSTATE creates a GNMIOption that sets the gnmi.GetRequest data type to STATE
func DataTypeSTATE() func(msg proto.Message) error {
return DataType("STATE")
}
// DataTypeOPERATIONAL creates a GNMIOption that sets the gnmi.GetRequest data type to OPERATIONAL
func DataTypeOPERATIONAL() func(msg proto.Message) error {
return DataType("OPERATIONAL")
}
// UseModel creates a GNMIOption that add a gnmi.DataModel to a gnmi.GetRequest or gnmi.SubscribeRequest
// based on the name, org and version strings provided.
func UseModel(name, org, version string) func(msg proto.Message) error {
return func(msg proto.Message) error {
if msg == nil {
return ErrInvalidMsgType
}
switch msg := msg.ProtoReflect().Interface().(type) {
case *gnmi.GetRequest:
if len(msg.UseModels) == 0 {
msg.UseModels = make([]*gnmi.ModelData, 0)
}
msg.UseModels = append(msg.UseModels,
&gnmi.ModelData{
Name: name,
Organization: org,
Version: version,
})
case *gnmi.SubscribeRequest:
switch msg := msg.Request.(type) {
case *gnmi.SubscribeRequest_Subscribe:
if msg.Subscribe == nil {
msg.Subscribe = new(gnmi.SubscriptionList)
}
if len(msg.Subscribe.UseModels) == 0 {
msg.Subscribe.UseModels = make([]*gnmi.ModelData, 0)
}
msg.Subscribe.UseModels = append(msg.Subscribe.UseModels,
&gnmi.ModelData{
Name: name,
Organization: org,
Version: version,
})
}
default:
return fmt.Errorf("option UseModel: %w: %T", ErrInvalidMsgType, msg)
}
return nil
}
}
// Update creates a GNMIOption that creates a *gnmi.Update message and adds it to the supplied proto.Message,
// the supplied message must be a *gnmi.SetRequest.
func Update(opts ...GNMIOption) func(msg proto.Message) error {
return func(msg proto.Message) error {
if msg == nil {
return ErrInvalidMsgType
}
switch msg := msg.ProtoReflect().Interface().(type) {
case *gnmi.SetRequest:
if len(msg.Update) == 0 {
msg.Update = make([]*gnmi.Update, 0)
}
upd := new(gnmi.Update)
err := apply(upd, opts...)
if err != nil {
return err
}
msg.Update = append(msg.Update, upd)
case *gnmi.Notification:
if len(msg.Update) == 0 {
msg.Update = make([]*gnmi.Update, 0)
}
upd := new(gnmi.Update)
err := apply(upd, opts...)
if err != nil {
return err
}
msg.Update = append(msg.Update, upd)
default:
return fmt.Errorf("option Update: %w: %T", ErrInvalidMsgType, msg)
}
return nil
}
}
// Replace creates a GNMIOption that creates a *gnmi.Update message and adds it to the supplied proto.Message.
// the supplied message must be a *gnmi.SetRequest.
func Replace(opts ...GNMIOption) func(msg proto.Message) error {
return func(msg proto.Message) error {
if msg == nil {
return ErrInvalidMsgType
}
switch msg := msg.ProtoReflect().Interface().(type) {
case *gnmi.SetRequest:
if len(msg.Update) == 0 {
msg.Update = make([]*gnmi.Update, 0)
}
upd := new(gnmi.Update)
err := apply(upd, opts...)
if err != nil {
return err
}
msg.Replace = append(msg.Replace, upd)
default:
return fmt.Errorf("option Replace: %w: %T", ErrInvalidMsgType, msg)
}
return nil
}
}
// Value creates a GNMIOption that creates a *gnmi.TypedValue and adds it to the supplied proto.Message.
// the supplied message must be a *gnmi.Update.
// If a map is supplied as `data interface{}` it has to be a map[string]interface{}.
func Value(data interface{}, encoding string) func(msg proto.Message) error {
return func(msg proto.Message) error {
if msg == nil {
return ErrInvalidMsgType
}
var err error
switch msg := msg.ProtoReflect().Interface().(type) {
case *gnmi.Update:
msg.Val, err = value(data, encoding)
if err != nil {
return err
}
default:
return fmt.Errorf("option Value: %w: %T", ErrInvalidMsgType, msg)
}
return nil
}
}
func value(data interface{}, encoding string) (*gnmi.TypedValue, error) {
switch data := data.(type) {
case []interface{}, []string:
switch strings.ToLower(encoding) {
case "":
encoding = encodingJSON
fallthrough
case encodingJSON:
b, err := json.Marshal(data)
if err != nil {
return nil, err
}
return &gnmi.TypedValue{
Value: &gnmi.TypedValue_JsonVal{
JsonVal: bytes.Trim(b, " \r\n\t"),
}}, nil
case encodingJSON_IETF:
b, err := json.Marshal(data)
if err != nil {
return nil, err
}
return &gnmi.TypedValue{
Value: &gnmi.TypedValue_JsonIetfVal{
JsonIetfVal: bytes.Trim(b, " \r\n\t"),
}}, nil
default:
return gvalue.FromScalar(data)
}
case map[string]interface{}:
switch strings.ToLower(encoding) {
case "":
encoding = encodingJSON
fallthrough
case encodingJSON:
b := new(bytes.Buffer)
enc := json.NewEncoder(b)
enc.SetEscapeHTML(false)
err := enc.Encode(data)
if err != nil {
return nil, err
}
return &gnmi.TypedValue{
Value: &gnmi.TypedValue_JsonVal{
JsonVal: bytes.Trim(b.Bytes(), " \r\n\t"),
}}, nil
case encodingJSON_IETF:
b := new(bytes.Buffer)
enc := json.NewEncoder(b)
enc.SetEscapeHTML(false)
err := enc.Encode(data)
if err != nil {
return nil, err
}
return &gnmi.TypedValue{
Value: &gnmi.TypedValue_JsonIetfVal{
JsonIetfVal: bytes.Trim(b.Bytes(), " \r\n\t"),
}}, nil
}
case string:
switch strings.ToLower(encoding) {
case "":
encoding = encodingJSON
fallthrough
case encodingJSON:
b := new(bytes.Buffer)
if json.Valid([]byte(data)) {
b.WriteString(data)
} else {
enc := json.NewEncoder(b)
enc.SetEscapeHTML(false)
err := enc.Encode(data)
if err != nil {
return nil, err
}
}
return &gnmi.TypedValue{
Value: &gnmi.TypedValue_JsonVal{
JsonVal: bytes.Trim(b.Bytes(), " \r\n\t"),
}}, nil
case encodingJSON_IETF:
b := new(bytes.Buffer)
if json.Valid([]byte(data)) {
b.WriteString(data)
} else {
enc := json.NewEncoder(b)
enc.SetEscapeHTML(false)
err := enc.Encode(data)
if err != nil {
return nil, err
}
}
return &gnmi.TypedValue{
Value: &gnmi.TypedValue_JsonIetfVal{
JsonIetfVal: bytes.Trim(b.Bytes(), " \r\n\t"),
}}, nil
case "ascii":
return &gnmi.TypedValue{
Value: &gnmi.TypedValue_AsciiVal{
AsciiVal: data,
}}, nil
case "bool":
bval, err := strconv.ParseBool(data)
if err != nil {
return nil, err
}
return &gnmi.TypedValue{
Value: &gnmi.TypedValue_BoolVal{
BoolVal: bval,
}}, nil
case "bytes":
return &gnmi.TypedValue{
Value: &gnmi.TypedValue_BytesVal{
BytesVal: []byte(data),
}}, nil
case "decimal":
return nil, fmt.Errorf("decimal type not implemented")
case "float":
f, err := strconv.ParseFloat(data, 32)
if err != nil {
return nil, err
}
return &gnmi.TypedValue{
Value: &gnmi.TypedValue_FloatVal{
FloatVal: float32(f),
}}, nil
case "int":
k, err := strconv.ParseInt(data, 10, 64)
if err != nil {
return nil, err
}
return &gnmi.TypedValue{
Value: &gnmi.TypedValue_IntVal{
IntVal: k,
}}, nil
case "uint":
u, err := strconv.ParseUint(data, 10, 64)
if err != nil {
return nil, err
}
return &gnmi.TypedValue{
Value: &gnmi.TypedValue_UintVal{
UintVal: u,
}}, nil
case "string":
return &gnmi.TypedValue{
Value: &gnmi.TypedValue_StringVal{
StringVal: data,
}}, nil
default:
return nil, fmt.Errorf("invalid encoding %s", encoding)
}
case *gnmi.TypedValue:
return data, nil
case *gnmi.TypedValue_AnyVal:
return &gnmi.TypedValue{Value: data}, nil
case *gnmi.TypedValue_AsciiVal:
return &gnmi.TypedValue{Value: data}, nil
case *gnmi.TypedValue_BoolVal:
return &gnmi.TypedValue{Value: data}, nil
case *gnmi.TypedValue_BytesVal:
return &gnmi.TypedValue{Value: data}, nil
case *gnmi.TypedValue_DecimalVal:
return &gnmi.TypedValue{Value: data}, nil
case *gnmi.TypedValue_FloatVal:
return &gnmi.TypedValue{Value: data}, nil
case *gnmi.TypedValue_IntVal:
return &gnmi.TypedValue{Value: data}, nil
case *gnmi.TypedValue_JsonIetfVal:
return &gnmi.TypedValue{Value: data}, nil
case *gnmi.TypedValue_JsonVal:
return &gnmi.TypedValue{Value: data}, nil
case *gnmi.TypedValue_LeaflistVal:
return &gnmi.TypedValue{Value: data}, nil
case *gnmi.TypedValue_ProtoBytes:
return &gnmi.TypedValue{Value: data}, nil
case *gnmi.TypedValue_StringVal:
return &gnmi.TypedValue{Value: data}, nil
case *gnmi.TypedValue_UintVal:
return &gnmi.TypedValue{Value: data}, nil
default:
v, err := gvalue.FromScalar(data)
if err != nil {
return nil, fmt.Errorf("%w: %v", ErrInvalidValue, err)
}
return v, nil
}
return nil, fmt.Errorf("unexpected value type and encoding %w: %T and %s", ErrInvalidValue, data, encoding)
}
// Delete creates a GNMIOption that creates a *gnmi.Path and adds it to the supplied proto.Message.
// the supplied message must be a *gnmi.SetRequest. The *gnmi.Path is added the .Delete list.
func Delete(p string) func(msg proto.Message) error {
return func(msg proto.Message) error {
if msg == nil {
return ErrInvalidMsgType
}
switch msg := msg.ProtoReflect().Interface().(type) {
case *gnmi.SetRequest:
gp, err := path.ParsePath(p)
if err != nil {
return fmt.Errorf("%w: %v", ErrInvalidValue, err)
}
if len(msg.Delete) == 0 {
msg.Delete = make([]*gnmi.Path, 0)
}
msg.Delete = append(msg.Delete, gp)
case *gnmi.Notification:
gp, err := path.ParsePath(p)
if err != nil {
return fmt.Errorf("%w: %v", ErrInvalidValue, err)
}
if len(msg.Delete) == 0 {
msg.Delete = make([]*gnmi.Path, 0)
}
msg.Delete = append(msg.Delete, gp)
default:
return fmt.Errorf("option Delete: %w: %T", ErrInvalidMsgType, msg)
}
return nil
}
}
// SubscriptionListMode creates a GNMIOption that sets the SubscribeRequest Mode.
// The variable mode must be one of "once", "poll" or "stream".
// The supplied proto.Message must be a *gnmi.SubscribeRequest with RequestType Subscribe.
func SubscriptionListMode(mode string) func(msg proto.Message) error {
return func(msg proto.Message) error {
if msg == nil {
return ErrInvalidMsgType
}
switch msg := msg.ProtoReflect().Interface().(type) {
case *gnmi.SubscribeRequest:
switch msg := msg.Request.(type) {
case *gnmi.SubscribeRequest_Subscribe:
if msg.Subscribe == nil {
msg.Subscribe = new(gnmi.SubscriptionList)
}
gmode, ok := gnmi.SubscriptionList_Mode_value[strings.ToUpper(mode)]
if !ok {
return fmt.Errorf("option SubscriptionListMode: %w: %s", ErrInvalidValue, mode)
}
msg.Subscribe.Mode = gnmi.SubscriptionList_Mode(gmode)
default:
return fmt.Errorf("option SubscriptionListMode: %w: %T", ErrInvalidMsgType, msg)
}
default:
return fmt.Errorf("option SubscriptionListMode: %w: %T", ErrInvalidMsgType, msg)
}
return nil
}
}
// SubscriptionListModeSTREAM creates a GNMIOption that sets the Subscription List Mode to STREAM
func SubscriptionListModeSTREAM() func(msg proto.Message) error {
return SubscriptionListMode("STREAM")
}
// SubscriptionListModeONCE creates a GNMIOption that sets the Subscription List Mode to ONCE
func SubscriptionListModeONCE() func(msg proto.Message) error {
return SubscriptionListMode("ONCE")
}
// SubscriptionListModePOLL creates a GNMIOption that sets the Subscription List Mode to POLL
func SubscriptionListModePOLL() func(msg proto.Message) error {
return SubscriptionListMode("POLL")
}
// Qos creates a GNMIOption that sets the QosMarking field in a *gnmi.SubscribeRequest with RequestType Subscribe.
func Qos(qos uint32) func(msg proto.Message) error {
return func(msg proto.Message) error {
switch msg := msg.ProtoReflect().Interface().(type) {
case *gnmi.SubscribeRequest:
switch msg := msg.Request.(type) {
case *gnmi.SubscribeRequest_Subscribe:
if msg.Subscribe == nil {