/
get.go
277 lines (256 loc) · 8.38 KB
/
get.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
// © 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 app
import (
"context"
"encoding/json"
"fmt"
"strings"
"github.com/openconfig/gnmi/proto/gnmi"
"github.com/openconfig/grpctunnel/tunnel"
"github.com/spf13/cobra"
"github.com/spf13/pflag"
"github.com/openconfig/gnmic/pkg/api/types"
"github.com/openconfig/gnmic/pkg/config"
"github.com/openconfig/gnmic/pkg/formatters"
)
func (a *App) GetPreRunE(cmd *cobra.Command, args []string) error {
a.Config.SetLocalFlagsFromFile(cmd)
a.Config.LocalFlags.GetPath = config.SanitizeArrayFlagValue(a.Config.LocalFlags.GetPath)
a.Config.LocalFlags.GetModel = config.SanitizeArrayFlagValue(a.Config.LocalFlags.GetModel)
a.Config.LocalFlags.GetProcessor = config.SanitizeArrayFlagValue(a.Config.LocalFlags.GetProcessor)
err := a.initPluginManager()
if err != nil {
return err
}
a.createCollectorDialOpts()
return a.initTunnelServer(tunnel.ServerConfig{
AddTargetHandler: a.tunServerAddTargetHandler,
DeleteTargetHandler: a.tunServerDeleteTargetHandler,
RegisterHandler: a.tunServerRegisterHandler,
Handler: a.tunServerHandler,
})
}
func (a *App) GetRun(cmd *cobra.Command, args []string) error {
defer a.InitGetFlags(cmd)
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
// setupCloseHandler(cancel)
targetsConfig, err := a.GetTargets()
if err != nil {
return fmt.Errorf("failed getting targets config: %v", err)
}
_, err = a.Config.GetActions()
if err != nil {
return fmt.Errorf("failed reading actions config: %v", err)
}
evps, err := a.intializeEventProcessors()
if err != nil {
return fmt.Errorf("failed to init event processors: %v", err)
}
if a.PromptMode {
// prompt mode
for _, tc := range targetsConfig {
a.AddTargetConfig(tc)
}
}
// event format
if len(a.Config.GetProcessor) > 0 {
a.Config.Format = formatEvent
}
if a.Config.Format == formatEvent {
return a.handleGetRequestEvent(ctx, evps)
}
// other formats
numTargets := len(a.Config.Targets)
a.errCh = make(chan error, numTargets*3)
a.wg.Add(numTargets)
for _, tc := range a.Config.Targets {
go a.GetRequest(ctx, tc)
}
a.wg.Wait()
err = a.checkErrors()
if err != nil {
return err
}
return nil
}
func (a *App) GetRequest(ctx context.Context, tc *types.TargetConfig) {
defer a.wg.Done()
req, err := a.Config.CreateGetRequest(tc)
if err != nil {
a.logError(fmt.Errorf("target %q building Get request failed: %v", tc.Name, err))
return
}
response, err := a.getRequest(ctx, tc, req)
if err != nil {
a.logError(fmt.Errorf("target %q Get request failed: %v", tc.Name, err))
return
}
err = a.PrintMsg(tc.Name, "Get Response:", response)
if err != nil {
a.logError(fmt.Errorf("target %q: %v", tc.Name, err))
}
}
func (a *App) getRequest(ctx context.Context, tc *types.TargetConfig, req *gnmi.GetRequest) (*gnmi.GetResponse, error) {
xreq := req
if len(a.Config.LocalFlags.GetModel) > 0 {
spModels, unspModels, err := a.filterModels(ctx, tc, a.Config.LocalFlags.GetModel)
if err != nil {
a.logError(fmt.Errorf("failed getting supported models from %q: %v", tc.Name, err))
return nil, err
}
if len(unspModels) > 0 {
a.logError(fmt.Errorf("found unsupported models for target %q: %+v", tc.Name, unspModels))
}
for _, m := range spModels {
xreq.UseModels = append(xreq.UseModels, m)
}
}
if a.Config.PrintRequest {
err := a.PrintMsg(tc.Name, "Get Request:", req)
if err != nil {
a.logError(fmt.Errorf("target %q Get Request printing failed: %v", tc.Name, err))
}
}
a.Logger.Printf("sending gNMI GetRequest: prefix='%v', path='%v', type='%v', encoding='%v', models='%+v', extension='%+v' to %s",
xreq.Prefix, xreq.Path, xreq.Type, xreq.Encoding, xreq.UseModels, xreq.Extension, tc.Name)
response, err := a.ClientGet(ctx, tc, xreq)
if err != nil {
a.logError(fmt.Errorf("target %q get request failed: %v", tc.Name, err))
return nil, err
}
return response, nil
}
func (a *App) filterModels(ctx context.Context, tc *types.TargetConfig, modelsNames []string) (map[string]*gnmi.ModelData, []string, error) {
supModels, err := a.GetModels(ctx, tc)
if err != nil {
return nil, nil, err
}
unsupportedModels := make([]string, 0)
supportedModels := make(map[string]*gnmi.ModelData)
var found bool
for _, m := range modelsNames {
found = false
for _, tModel := range supModels {
if m == tModel.Name {
supportedModels[m] = tModel
found = true
break
}
}
if !found {
unsupportedModels = append(unsupportedModels, m)
}
}
return supportedModels, unsupportedModels, nil
}
// InitGetFlags used to init or reset getCmd flags for gnmic-prompt mode
func (a *App) InitGetFlags(cmd *cobra.Command) {
cmd.ResetFlags()
cmd.Flags().StringArrayVarP(&a.Config.LocalFlags.GetPath, "path", "", []string{}, "get request paths")
cmd.MarkFlagRequired("path")
cmd.Flags().StringVarP(&a.Config.LocalFlags.GetPrefix, "prefix", "", "", "get request prefix")
cmd.Flags().StringSliceVarP(&a.Config.LocalFlags.GetModel, "model", "", []string{}, "get request models")
cmd.Flags().StringVarP(&a.Config.LocalFlags.GetType, "type", "t", "ALL", "data type requested from the target. one of: ALL, CONFIG, STATE, OPERATIONAL")
cmd.Flags().StringVarP(&a.Config.LocalFlags.GetTarget, "target", "", "", "get request target")
cmd.Flags().BoolVarP(&a.Config.LocalFlags.GetValuesOnly, "values-only", "", false, "print GetResponse values only")
cmd.Flags().StringArrayVarP(&a.Config.LocalFlags.GetProcessor, "processor", "", []string{}, "list of processor names to run")
cmd.LocalFlags().VisitAll(func(flag *pflag.Flag) {
a.Config.FileConfig.BindPFlag(fmt.Sprintf("%s-%s", cmd.Name(), flag.Name), flag)
})
}
func (a *App) intializeEventProcessors() ([]formatters.EventProcessor, error) {
_, err := a.Config.GetEventProcessors()
if err != nil {
return nil, fmt.Errorf("failed reading event processors config: %v", err)
}
var evps = make([]formatters.EventProcessor, 0)
for _, epName := range a.Config.GetProcessor {
if epCfg, ok := a.Config.Processors[epName]; ok {
epType := ""
for k := range epCfg {
epType = k
break
}
if in, ok := formatters.EventProcessors[epType]; ok {
ep := in()
err := ep.Init(epCfg[epType],
formatters.WithLogger(a.Logger),
formatters.WithTargets(a.Config.Targets),
formatters.WithActions(a.Config.Actions),
)
if err != nil {
return nil, fmt.Errorf("failed initializing event processor '%s' of type='%s': %v", epName, epType, err)
}
evps = append(evps, ep)
continue
}
return nil, fmt.Errorf("%q event processor has an unknown type=%q", epName, epType)
}
return nil, fmt.Errorf("%q event processor not found", epName)
}
return evps, nil
}
func (a *App) handleGetRequestEvent(ctx context.Context, evps []formatters.EventProcessor) error {
numTargets := len(a.Config.Targets)
a.errCh = make(chan error, numTargets*3)
a.wg.Add(numTargets)
rsps := make(chan *getResponseEvents, numTargets)
for _, tc := range a.Config.Targets {
go func(tc *types.TargetConfig) {
defer a.wg.Done()
req, err := a.Config.CreateGetRequest(tc)
if err != nil {
a.errCh <- err
return
}
resp, err := a.getRequest(ctx, tc, req)
if err != nil {
a.errCh <- err
return
}
evs, err := formatters.GetResponseToEventMsgs(resp, map[string]string{"source": tc.Name}, evps...)
if err != nil {
a.errCh <- err
}
rsps <- &getResponseEvents{name: tc.Name, rsp: evs}
}(tc)
}
a.wg.Wait()
close(rsps)
responses := make(map[string][]*formatters.EventMsg)
for r := range rsps {
responses[r.name] = r.rsp
}
err := a.checkErrors()
if err != nil {
return err
}
//
sb := strings.Builder{}
for name, r := range responses {
sb.Reset()
printPrefix := ""
if len(a.Config.TargetsList()) > 1 && !a.Config.NoPrefix {
printPrefix = fmt.Sprintf("[%s] ", name)
}
b, err := json.MarshalIndent(r, "", " ")
if err != nil {
return err
}
sb.Write(b)
fmt.Fprintf(a.out, "%s\n", indent(printPrefix, sb.String()))
}
return nil
}
type getResponseEvents struct {
// target name
name string
rsp []*formatters.EventMsg
}