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
|
#!/usr/bin/python
"""This tool loads the Bcfg2 core into an interactive debugger."""
__revision__ = '$Revision$'
from code import InteractiveConsole
import cmd
import errno
import getopt
import logging
import lxml.etree
import os
import sys
import tempfile
try:
import profile
import pstats
have_profile = True
except:
have_profile = False
import Bcfg2.Logger
import Bcfg2.Options
import Bcfg2.Server.Core
import Bcfg2.Server.Plugins.Metadata
import Bcfg2.Server.Plugin
logger = logging.getLogger('bcfg2-info')
class dummyError(Exception):
pass
class FileNotBuilt(Exception):
"""Thrown when File entry contains no content."""
def __init__(self, value):
Exception.__init__(self)
self.value = value
def __str__(self):
return repr(self.value)
def printTabular(rows):
"""Print data in tabular format."""
cmax = tuple([max([len(str(row[index])) for row in rows]) + 1 \
for index in range(len(rows[0]))])
fstring = (" %%-%ss |" * len(cmax)) % cmax
fstring = ('|'.join([" %%-%ss "] * len(cmax))) % cmax
print(fstring % rows[0])
print((sum(cmax) + (len(cmax) * 2) + (len(cmax) - 1)) * '=')
for row in rows[1:]:
print(fstring % row)
def displayTrace(trace, num=80, sort=('time', 'calls')):
stats = pstats.Stats(trace)
stats.sort_stats('cumulative', 'calls', 'time')
stats.print_stats(200)
def write_config_file(outputdir, cfg):
"""Store file content of an <ConfigFile name='/path/to/file' ...>...</ConfigFile> entry
in the appropriate directory under the output directory.
"""
name = cfg.get('name')
# directory creation
try:
os.makedirs(os.path.dirname(outputdir + name))
except OSError, err:
if err.errno != errno.EEXIST:
raise
except:
raise
# write config file
config_file = open(outputdir + name, "w")
try:
config_file.write(cfg.text)
except: # plugin throw an exception and therefore there is no content => None
raise FileNotBuilt(name)
config_file.close()
class infoCore(cmd.Cmd, Bcfg2.Server.Core.Core):
def __init__(self, repo, plgs, passwd, encoding, event_debug):
cmd.Cmd.__init__(self)
try:
Bcfg2.Server.Core.Core.__init__(self, repo, plgs, passwd,
encoding)
if event_debug:
self.fam.debug = True
except Bcfg2.Server.Core.CoreInitError, msg:
print("Core load failed because %s" % msg)
raise SystemExit(1)
self.prompt = '> '
self.cont = True
self.fam.handle_events_in_interval(4)
def do_loop(self):
self.cont = True
while self.cont:
try:
self.cmdloop('Welcome to bcfg2-info\n'
'Type "help" for more information')
except SystemExit, val:
raise
except Bcfg2.Server.Plugin.PluginExecutionError:
continue
except KeyboardInterrupt:
print("Ctrl-C pressed exiting...")
self.do_exit([])
except dummyError:
continue
except:
logger.error("command failure", exc_info=1)
def do_debug(self, args):
try:
opts, _ = getopt.getopt(args.split(), 'nf:')
except:
print "Usage: debug [-n] [-f <command list>]"
return
self.cont = False
scriptmode = False
interactive = True
for opt in opts:
if opt[0] == '-f':
scriptmode = True
spath = opt[1]
elif opt[0] == '-n':
interactive = False
sh = InteractiveConsole(locals())
if scriptmode:
for command in [c.strip() for c in open(spath).readlines()]:
if command:
sh.push(command)
if interactive:
print("dropping to python interpreter; press ^D to resume")
try:
import IPython
shell = IPython.Shell.IPShell(argv=[], user_ns=locals())
shell.mainloop()
except ImportError:
sh.interact()
def do_quit(self, _):
"""
Exit program.
Usage: [quit|exit]
"""
for plugin in self.plugins.values():
plugin.shutdown()
os._exit(0)
do_EOF = do_quit
do_exit = do_quit
def do_help(self, _):
"""Print out usage info."""
print 'Commands:'
print 'build <hostname> <filename> - build config for hostname, writing to filename'
print 'builddir <hostname> <dirname> - build config for hostname, writing separate files to dirname'
print 'buildall <directory> - build configs for all clients in directory'
print 'buildfile <filename> <hostname> - build config file for hostname (not written to disk)'
print 'bundles - print out group/bundle information'
print 'clients - print out client/profile information'
print 'debug - shell out to native python interpreter'
print 'event_debug - display filesystem events as they are processed'
print 'generators - list current versions of generators'
print 'groups - list groups'
print 'help - print this list of available commands'
print 'mappings <type*> <name*> - print generator mappings for optional type and name'
print 'profile <command> <args> - profile a single bcfg2-info command'
print 'quit - Exit the bcfg2-info command line'
print 'showentries <hostname> <type> - show abstract configuration entries for a given host'
print 'showclient <client1> <client2> - show metadata for given hosts'
print 'update - process pending file events'
print 'version - print version of this tool'
def do_update(self, _):
"""Process pending fs events."""
self.fam.handle_events_in_interval(0.1)
def do_version(self, _):
"""Print out code version."""
print(__revision__)
def do_build(self, args):
"""Build client configuration."""
alist = args.split()
path_force = False
if '-f' in args:
alist.remove('-f')
path_force = True
if len(alist) == 2:
client, ofile = alist
if not ofile.startswith('/tmp') and not path_force:
print("Refusing to write files outside of /tmp without -f option")
return
output = open(ofile, 'w')
data = lxml.etree.tostring(self.BuildConfiguration(client),
encoding='UTF-8', xml_declaration=True,
pretty_print=True)
output.write(data)
output.close()
else:
print('Usage: build [-f] <hostname> <output file>')
def help_builddir(self):
"""Display help for builddir command."""
print('Usage: builddir [-f] <hostname> <output dir>')
print('')
print('Generates a config for client <hostname> and writes the')
print('individual configuration files out separately in a tree')
print('under <output dir>. The <output dir> directory must be')
print('rooted under /tmp unless the -f argument is provided, in')
print('which case it can be located anywhere.')
print('')
print('NOTE: Currently only handles ConfigFile entries and writes')
print('all content with the default owner and permissions. These')
print('could be much more permissive than would be created by the')
print('bcfg2 client itself.')
def do_builddir(self, args):
"""Build client configuration as separate files within a dir."""
alist = args.split()
path_force = False
if '-f' in args:
alist.remove('-f')
path_force = True
if len(alist) == 2:
client, odir = alist
if not odir.startswith('/tmp') and not path_force:
print("Refusing to write files outside of /tmp without -f option")
return
client_config = self.BuildConfiguration(client)
if client_config.tag == 'error':
print("Building client configuration failed.")
return
# handle <Path type='file'> entries
for configfile in client_config.findall(".//Path[@type='file']"):
try:
write_config_file(odir, configfile)
except FileNotBuilt, ex:
print("Warning: No file content generated for ConfigFile %s!" % ex)
pass
except Exception, ex:
print("unknown error, I give up: %s" %ex)
return
print("Config for %s written to %s" % (client, odir))
else:
print('Error: Incorrect number of parameters')
self.help_builddir()
def do_buildall(self, args):
if len(args.split()) != 1:
print("Usage: buildall <directory>")
return
try:
os.mkdir(args)
except:
pass
for client in self.metadata.clients:
self.do_build("%s %s/%s.xml" % (client, args, client))
def do_buildfile(self, args):
"""Build a config file for client."""
if len(args.split()) == 2:
fname, client = args.split()
entry = lxml.etree.Element('Path', type='file', name=fname)
metadata = self.build_metadata(client)
self.Bind(entry, metadata)
print(lxml.etree.tostring(entry, encoding="UTF-8", xml_declaration=True))
else:
print('Usage: buildfile filename hostname')
def do_bundles(self, _):
"""Print out group/bundle info."""
data = [('Group', 'Bundles')]
groups = list(self.metadata.groups.keys())
groups.sort()
for group in groups:
data.append((group,
','.join(self.metadata.groups[group][0])))
printTabular(data)
def do_clients(self, _):
"""Print out client info."""
data = [('Client', 'Profile')]
clist = list(self.metadata.clients.keys())
clist.sort()
for client in clist:
data.append((client, self.metadata.clients[client]))
printTabular(data)
def do_generators(self, _):
"""Print out generator info."""
for generator in self.generators:
print(generator.__version__)
def do_showentries(self, args):
"""Show abstract configuration entries for a given host."""
arglen = len(args.split())
if arglen not in [1, 2]:
print("Usage: showentries <hostname> <type>")
return
client = args.split()[0]
try:
meta = self.build_metadata(client)
except Bcfg2.Server.Plugins.Metadata.MetadataConsistencyError:
print("Unable to find metadata for host %s" % client)
return
structures = self.GetStructures(meta)
output = [('entrytype', 'name')]
if arglen == 1:
for item in structures:
for child in item.getchildren():
output.append((child.tag, child.get('name')))
if arglen == 2:
etype = args.split()[1]
for item in structures:
for child in item.getchildren():
if child.tag in [etype, "Bound%s" % etype]:
output.append((child.tag, child.get('name')))
printTabular(output)
def do_groups(self, _):
"""Print out group info."""
data = [("Groups", "Profile", "Category", "Contains")]
grouplist = list(self.metadata.groups.keys())
grouplist.sort()
for group in grouplist:
if group in self.metadata.profiles:
prof = 'yes'
else:
prof = 'no'
if group in self.metadata.categories:
cat = self.metadata.categories[group]
else:
cat = ''
gdata = [grp for grp in self.metadata.groups[group][1]]
if group in gdata:
gdata.remove(group)
data.append((group, prof, cat, ','.join(gdata)))
printTabular(data)
def do_showclient(self, args):
"""Print host metadata."""
data = [('Client', 'Profile', "Groups", "Bundles")]
if not len(args):
print("Usage:\nshowclient <client> ... <clientN>")
return
for client in args.split():
try:
client_meta = self.build_metadata(client)
except:
print("Client %s not defined" % client)
continue
print "Hostname:\t", client_meta.hostname
print "Profile:\t", client_meta.profile
print "Groups:\t\t", list(client_meta.groups)[0]
for grp in list(client_meta.groups)[1:]:
print '\t\t%s' % grp
if client_meta.bundles:
print "Bundles:\t", list(client_meta.bundles)[0]
for bnd in list(client_meta.bundles)[1:]:
print '\t\t%s' % bnd
if client_meta.connectors:
print "Connector data"
print "=" * 80
for conn in client_meta.connectors:
if getattr(client_meta, conn):
print "%s:\t" % (conn), getattr(client_meta, conn)
print "=" * 80
def do_mappings(self, args):
"""Print out mapping info."""
# dump all mappings unless type specified
data = [('Plugin', 'Type', 'Name')]
arglen = len(args.split())
for generator in self.generators:
if arglen == 0:
etypes = list(generator.Entries.keys())
else:
etypes = [args.split()[0]]
if arglen == 2:
interested = [(etype, [args.split()[1]]) \
for etype in etypes]
else:
interested = [(etype, generator.Entries[etype]) \
for etype in etypes \
if etype in generator.Entries]
for etype, names in interested:
for name in [name for name in names if name in \
generator.Entries.get(etype, {})]:
data.append((generator.name, etype, name))
printTabular(data)
def do_event_debug(self, args):
self.fam.debug = True
def do_cfgdebug(self, args):
try:
meta = self.build_metadata(args)
except Bcfg2.Server.Plugins.Metadata.MetadataConsistencyError:
print("Unable to find metadata for host %s" % client)
return
structures = self.GetStructures(meta)
for clist in [struct.findall('Path') for struct in structures]:
for cfile in clist:
if cfile.get('name') in self.plugins['Cfg'].Entries['ConfigFile']:
cset = self.plugins['Cfg'].entries[cfile.get('name')]
cand = cset.get_matching(meta)
fields = ['all', 'group']
while len(cand) > 1 and fields:
field = fields.pop(0)
[cand.remove(c) for c in cand[:]
if getattr(c.specific, field)]
if len(cand) != 1:
sys.stderr.write("Entry %s failed" % cfile.get('name'))
continue
print(cand[0].name)
def do_profile(self, arg):
if not have_profile:
print("Profiling functionality not available")
return
tracefname = tempfile.mktemp()
p = profile.Profile()
p.runcall(self.onecmd, arg)
displayTrace(p)
def Run(self, args):
if args:
self.onecmd(" ".join(args))
os._exit(0)
else:
self.do_loop()
if __name__ == '__main__':
Bcfg2.Logger.setup_logging('bcfg2-info', to_syslog=False)
optinfo = {
'configfile': Bcfg2.Options.CFILE,
'help': Bcfg2.Options.HELP,
}
optinfo.update({'repo': Bcfg2.Options.SERVER_REPOSITORY,
'plugins': Bcfg2.Options.SERVER_PLUGINS,
'password': Bcfg2.Options.SERVER_PASSWORD,
'event debug': Bcfg2.Options.DEBUG,
'profile': Bcfg2.Options.CORE_PROFILE,
'encoding': Bcfg2.Options.ENCODING})
setup = Bcfg2.Options.OptionParser(optinfo)
setup.parse(sys.argv[1:])
if setup['profile'] and have_profile:
prof = profile.Profile()
loop = prof.runcall(infoCore, setup['repo'], setup['plugins'],
setup['password'], setup['encoding'],
setup['event debug'])
displayTrace(prof)
else:
if setup['profile']:
print("Profiling functionality not available")
loop = infoCore(setup['repo'], setup['plugins'], setup['password'],
setup['encoding'], setup['event debug'])
loop.Run(setup['args'])
|