-
Notifications
You must be signed in to change notification settings - Fork 30
/
client.go
384 lines (333 loc) · 9.06 KB
/
client.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
// generated code; DO NOT EDIT
package rpcutilclient
import (
"fmt"
"sync"
"time"
"context"
"github.com/choria-io/go-choria/choria"
coreclient "github.com/choria-io/go-choria/client/client"
"github.com/choria-io/go-choria/config"
"github.com/choria-io/go-choria/protocol"
rpcclient "github.com/choria-io/go-choria/providers/agent/mcorpc/client"
"github.com/choria-io/go-choria/providers/agent/mcorpc/ddl/agent"
"github.com/choria-io/go-choria/srvcache"
"github.com/sirupsen/logrus"
)
// Stats are the statistics for a request
type Stats interface {
Agent() string
Action() string
All() bool
NoResponseFrom() []string
UnexpectedResponseFrom() []string
DiscoveredCount() int
DiscoveredNodes() *[]string
FailCount() int
OKCount() int
ResponsesCount() int
PublishDuration() (time.Duration, error)
RequestDuration() (time.Duration, error)
DiscoveryDuration() (time.Duration, error)
OverrideDiscoveryTime(start time.Time, end time.Time)
}
// NodeSource discovers nodes
type NodeSource interface {
Reset()
Discover(ctx context.Context, fw ChoriaFramework, filters []FilterFunc) ([]string, error)
}
// ChoriaFramework is the Choria framework
type ChoriaFramework interface {
Logger(string) *logrus.Entry
SetLogger(*logrus.Logger)
Configuration() *config.Config
NewMessage(payload string, agent string, collective string, msgType string, request *choria.Message) (msg *choria.Message, err error)
NewReplyFromTransportJSON(payload []byte, skipvalidate bool) (msg protocol.Reply, err error)
NewTransportFromJSON(data string) (message protocol.TransportMessage, err error)
MiddlewareServers() (servers srvcache.Servers, err error)
NewConnector(ctx context.Context, servers func() (srvcache.Servers, error), name string, logger *logrus.Entry) (conn choria.Connector, err error)
NewRequestID() (string, error)
Certname() string
PQLQueryCertNames(query string) ([]string, error)
Colorize(c string, format string, a ...interface{}) string
ProgressWidth() int
}
// FilterFunc can generate a Choria filter
type FilterFunc func(f *protocol.Filter) error
// RenderFormat is the format used by the RenderResults helper
type RenderFormat int
const (
// JSONFormat renders the results as a JSON document
JSONFormat RenderFormat = iota
// TextFormat renders the results as a Choria typical result set in line with choria req output
TextFormat
// TableFormat renders all successful responses in a table
TableFormat
// TXTFooter renders only the request summary statistics
TXTFooter
)
// DisplayMode overrides the DDL display hints
type DisplayMode uint8
const (
// DisplayDDL shows results based on the configuration in the DDL file
DisplayDDL = DisplayMode(iota)
// DisplayOK shows only passing results
DisplayOK
// DisplayFailed shows only failed results
DisplayFailed
// DisplayAll shows all results
DisplayAll
// DisplayNone shows no results
DisplayNone
)
type Log interface {
Debugf(format string, args ...interface{})
Infof(format string, args ...interface{})
Warnf(format string, args ...interface{})
Errorf(format string, args ...interface{})
Fatalf(format string, args ...interface{})
Panicf(format string, args ...interface{})
}
// RpcutilClient to the rpcutil agent
type RpcutilClient struct {
fw ChoriaFramework
cfg *config.Config
ddl *agent.DDL
ns NodeSource
clientOpts *initOptions
clientRPCOpts []rpcclient.RequestOption
filters []FilterFunc
targets []string
workers int
exprFilter string
sync.Mutex
}
// Metadata is the agent metadata
type Metadata struct {
License string `json:"license"`
Author string `json:"author"`
Timeout int `json:"timeout"`
Name string `json:"name"`
Version string `json:"version"`
URL string `json:"url"`
Description string `json:"description"`
}
// Must create a new client and panics on error
func Must(opts ...InitializationOption) (client *RpcutilClient) {
c, err := New(opts...)
if err != nil {
panic(err)
}
return c
}
// New creates a new client to the rpcutil agent
func New(opts ...InitializationOption) (client *RpcutilClient, err error) {
c := &RpcutilClient{
ddl: &agent.DDL{},
clientRPCOpts: []rpcclient.RequestOption{},
filters: []FilterFunc{
FilterFunc(coreclient.AgentFilter("rpcutil")),
},
clientOpts: &initOptions{
cfgFile: choria.UserConfig(),
},
targets: []string{},
}
for _, opt := range opts {
opt(c.clientOpts)
}
c.fw, err = choria.New(c.clientOpts.cfgFile)
if err != nil {
return nil, fmt.Errorf("could not initialize Choria: %s", err)
}
c.cfg = c.fw.Configuration()
if c.clientOpts.dt > 0 {
c.cfg.DiscoveryTimeout = int(c.clientOpts.dt.Seconds())
}
if c.clientOpts.ns == nil {
switch c.cfg.DefaultDiscoveryMethod {
case "choria":
c.clientOpts.ns = &PuppetDBNS{}
default:
c.clientOpts.ns = &BroadcastNS{}
}
}
c.ns = c.clientOpts.ns
if c.clientOpts.logger == nil {
c.clientOpts.logger = c.fw.Logger("rpcutil")
} else {
c.fw.SetLogger(c.clientOpts.logger.Logger)
}
c.ddl, err = DDL()
if err != nil {
return nil, fmt.Errorf("could not parse embedded DDL: %s", err)
}
return c, nil
}
// AgentMetadata is the agent metadata this client supports
func (p *RpcutilClient) AgentMetadata() *Metadata {
return &Metadata{
License: p.ddl.Metadata.License,
Author: p.ddl.Metadata.Author,
Timeout: p.ddl.Metadata.Timeout,
Name: p.ddl.Metadata.Name,
Version: p.ddl.Metadata.Version,
URL: p.ddl.Metadata.URL,
Description: p.ddl.Metadata.Description,
}
}
// DiscoverNodes performs a discovery using the configured filter and node source
func (p *RpcutilClient) DiscoverNodes(ctx context.Context) (nodes []string, err error) {
p.Lock()
defer p.Unlock()
return p.ns.Discover(ctx, p.fw, p.filters)
}
// AgentInventory performs the agent_inventory action
//
// Description: Inventory of all agents on the server
func (p *RpcutilClient) AgentInventory() *AgentInventoryRequester {
d := &AgentInventoryRequester{
outc: nil,
r: &requester{
args: map[string]interface{}{},
action: "agent_inventory",
client: p,
},
}
return d
}
// CollectiveInfo performs the collective_info action
//
// Description: Info about the main and sub collectives
func (p *RpcutilClient) CollectiveInfo() *CollectiveInfoRequester {
d := &CollectiveInfoRequester{
outc: nil,
r: &requester{
args: map[string]interface{}{},
action: "collective_info",
client: p,
},
}
return d
}
// DaemonStats performs the daemon_stats action
//
// Description: Get statistics from the running daemon
func (p *RpcutilClient) DaemonStats() *DaemonStatsRequester {
d := &DaemonStatsRequester{
outc: nil,
r: &requester{
args: map[string]interface{}{},
action: "daemon_stats",
client: p,
},
}
return d
}
// GetConfigItem performs the get_config_item action
//
// Description: Get the active value of a specific config property
//
// Required Inputs:
// - item (string) - The item to retrieve from the server
func (p *RpcutilClient) GetConfigItem(itemI string) *GetConfigItemRequester {
d := &GetConfigItemRequester{
outc: nil,
r: &requester{
args: map[string]interface{}{
"item": itemI,
},
action: "get_config_item",
client: p,
},
}
return d
}
// GetData performs the get_data action
//
// Description: Get data from a data plugin
//
// Required Inputs:
// - source (string) - The data plugin to retrieve information from
//
// Optional Inputs:
// - query (string) - The query argument to supply to the data plugin
func (p *RpcutilClient) GetData(sourceI string) *GetDataRequester {
d := &GetDataRequester{
outc: nil,
r: &requester{
args: map[string]interface{}{
"source": sourceI,
},
action: "get_data",
client: p,
},
}
return d
}
// GetFact performs the get_fact action
//
// Description: Retrieve a single fact from the fact store
//
// Required Inputs:
// - fact (string) - The fact to retrieve
func (p *RpcutilClient) GetFact(factI string) *GetFactRequester {
d := &GetFactRequester{
outc: nil,
r: &requester{
args: map[string]interface{}{
"fact": factI,
},
action: "get_fact",
client: p,
},
}
return d
}
// GetFacts performs the get_facts action
//
// Description: Retrieve multiple facts from the fact store
//
// Required Inputs:
// - facts (string) - Facts to retrieve
func (p *RpcutilClient) GetFacts(factsI string) *GetFactsRequester {
d := &GetFactsRequester{
outc: nil,
r: &requester{
args: map[string]interface{}{
"facts": factsI,
},
action: "get_facts",
client: p,
},
}
return d
}
// Inventory performs the inventory action
//
// Description: System Inventory
func (p *RpcutilClient) Inventory() *InventoryRequester {
d := &InventoryRequester{
outc: nil,
r: &requester{
args: map[string]interface{}{},
action: "inventory",
client: p,
},
}
return d
}
// Ping performs the ping action
//
// Description: Responds to requests for PING with PONG
func (p *RpcutilClient) Ping() *PingRequester {
d := &PingRequester{
outc: nil,
r: &requester{
args: map[string]interface{}{},
action: "ping",
client: p,
},
}
return d
}