To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/trunk
« back to all changes in this revision
Viewing changes to mandos-ctl
- browse files at revision 1084
- compare with another revision
- download diff
- download tarball
- view history from revision 1084
- Committer: Teddy Hogeborn
- Date: 2019-03-17 18:44:44 UTC
- Revision ID: teddy@recompile.se-20190317184444-5o7vougp7c3p87ri
mandos-ctl: Refactor tests
* mandos-ctl (TestBaseCommands.test_DumpJSON_normal): Don't run the
.output method on command; instead, use capture_stdout_to_buffer().
(TestBaseCommands.test_DumpJSON_one_client): - '' -
(TestBaseCommands.test_PrintTable_normal): - '' -
(TestBaseCommands.test_PrintTable_verbose): - '' -
(TestBaseCommands.test_PrintTable_one_client): - '' -
(TestBaseCommands.capture_stdout_to_buffer): New.
* mandos-ctl (TestBaseCommands.test_DumpJSON_normal): Don't run the
.output method on command; instead, use capture_stdout_to_buffer().
(TestBaseCommands.test_DumpJSON_one_client): - '' -
(TestBaseCommands.test_PrintTable_normal): - '' -
(TestBaseCommands.test_PrintTable_verbose): - '' -
(TestBaseCommands.test_PrintTable_one_client): - '' -
(TestBaseCommands.capture_stdout_to_buffer): New.
- files modified:
- TODO
added
removed
mandos-ctl
42
42
import json
43
43
import unittest
44
44
import logging
45
import io
46
import tempfile
47
import contextlib
45
48
46
49
import dbus
47
50
61
64
62
65
locale.setlocale(locale.LC_ALL, "")
63
66
64
domain = "se.recompile"
65
busname = domain + ".Mandos"
66
server_path = "/"
67
server_interface = domain + ".Mandos"
68
client_interface = domain + ".Mandos.Client"
67
dbus_busname_domain = "se.recompile"
68
dbus_busname = dbus_busname_domain + ".Mandos"
69
server_dbus_path = "/"
70
server_dbus_interface = dbus_busname_domain + ".Mandos"
71
client_dbus_interface = dbus_busname_domain + ".Mandos.Client"
72
del dbus_busname_domain
69
73
version = "1.8.3"
70
74
71
75
75
79
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
76
80
77
81
78
def milliseconds_to_string(ms):
79
td = datetime.timedelta(0, 0, 0, ms)
80
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
81
.format(days="{}T".format(td.days) if td.days else "",
82
hours=td.seconds // 3600,
83
minutes=(td.seconds % 3600) // 60,
84
seconds=td.seconds % 60))
82
def main():
83
parser = argparse.ArgumentParser()
84
85
add_command_line_options(parser)
86
87
options = parser.parse_args()
88
89
check_option_syntax(parser, options)
90
91
clientnames = options.client
92
93
if options.debug:
94
log.setLevel(logging.DEBUG)
95
96
bus = dbus.SystemBus()
97
98
mandos_dbus_object = get_mandos_dbus_object(bus)
99
100
mandos_serv = dbus.Interface(
101
mandos_dbus_object, dbus_interface=server_dbus_interface)
102
mandos_serv_object_manager = dbus.Interface(
103
mandos_dbus_object, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
104
105
managed_objects = get_managed_objects(mandos_serv_object_manager)
106
107
all_clients = {}
108
for path, ifs_and_props in managed_objects.items():
109
try:
110
all_clients[path] = ifs_and_props[client_dbus_interface]
111
except KeyError:
112
pass
113
114
# Compile dict of (clientpath: properties) to process
115
if not clientnames:
116
clients = all_clients
117
else:
118
clients = {}
119
for name in clientnames:
120
for objpath, properties in all_clients.items():
121
if properties["Name"] == name:
122
clients[objpath] = properties
123
break
124
else:
125
log.critical("Client not found on server: %r", name)
126
sys.exit(1)
127
128
commands = commands_from_options(options)
129
130
for command in commands:
131
command.run(clients, bus, mandos_serv)
132
133
134
def add_command_line_options(parser):
135
parser.add_argument("--version", action="version",
136
version="%(prog)s {}".format(version),
137
help="show version number and exit")
138
parser.add_argument("-a", "--all", action="store_true",
139
help="Select all clients")
140
parser.add_argument("-v", "--verbose", action="store_true",
141
help="Print all fields")
142
parser.add_argument("-j", "--dump-json", action="store_true",
143
help="Dump client data in JSON format")
144
enable_disable = parser.add_mutually_exclusive_group()
145
enable_disable.add_argument("-e", "--enable", action="store_true",
146
help="Enable client")
147
enable_disable.add_argument("-d", "--disable",
148
action="store_true",
149
help="disable client")
150
parser.add_argument("-b", "--bump-timeout", action="store_true",
151
help="Bump timeout for client")
152
start_stop_checker = parser.add_mutually_exclusive_group()
153
start_stop_checker.add_argument("--start-checker",
154
action="store_true",
155
help="Start checker for client")
156
start_stop_checker.add_argument("--stop-checker",
157
action="store_true",
158
help="Stop checker for client")
159
parser.add_argument("-V", "--is-enabled", action="store_true",
160
help="Check if client is enabled")
161
parser.add_argument("-r", "--remove", action="store_true",
162
help="Remove client")
163
parser.add_argument("-c", "--checker",
164
help="Set checker command for client")
165
parser.add_argument("-t", "--timeout", type=string_to_delta,
166
help="Set timeout for client")
167
parser.add_argument("--extended-timeout", type=string_to_delta,
168
help="Set extended timeout for client")
169
parser.add_argument("-i", "--interval", type=string_to_delta,
170
help="Set checker interval for client")
171
approve_deny_default = parser.add_mutually_exclusive_group()
172
approve_deny_default.add_argument(
173
"--approve-by-default", action="store_true",
174
default=None, dest="approved_by_default",
175
help="Set client to be approved by default")
176
approve_deny_default.add_argument(
177
"--deny-by-default", action="store_false",
178
dest="approved_by_default",
179
help="Set client to be denied by default")
180
parser.add_argument("--approval-delay", type=string_to_delta,
181
help="Set delay before client approve/deny")
182
parser.add_argument("--approval-duration", type=string_to_delta,
183
help="Set duration of one client approval")
184
parser.add_argument("-H", "--host", help="Set host for client")
185
parser.add_argument("-s", "--secret",
186
type=argparse.FileType(mode="rb"),
187
help="Set password blob (file) for client")
188
approve_deny = parser.add_mutually_exclusive_group()
189
approve_deny.add_argument(
190
"-A", "--approve", action="store_true",
191
help="Approve any current client request")
192
approve_deny.add_argument("-D", "--deny", action="store_true",
193
help="Deny any current client request")
194
parser.add_argument("--debug", action="store_true",
195
help="Debug mode (show D-Bus commands)")
196
parser.add_argument("--check", action="store_true",
197
help="Run self-test")
198
parser.add_argument("client", nargs="*", help="Client name")
199
200
201
def string_to_delta(interval):
202
"""Parse a string and return a datetime.timedelta"""
203
204
try:
205
return rfc3339_duration_to_delta(interval)
206
except ValueError as e:
207
log.warning("%s - Parsing as pre-1.6.1 interval instead",
208
' '.join(e.args))
209
return parse_pre_1_6_1_interval(interval)
85
210
86
211
87
212
def rfc3339_duration_to_delta(duration):
107
232
>>> rfc3339_duration_to_delta("")
108
233
Traceback (most recent call last):
109
234
...
110
ValueError: Invalid RFC 3339 duration: u''
235
ValueError: Invalid RFC 3339 duration: ""
111
236
>>> # Must start with "P":
112
237
>>> rfc3339_duration_to_delta("1D")
113
238
Traceback (most recent call last):
114
239
...
115
ValueError: Invalid RFC 3339 duration: u'1D'
240
ValueError: Invalid RFC 3339 duration: "1D"
116
241
>>> # Must use correct order
117
242
>>> rfc3339_duration_to_delta("PT1S2M")
118
243
Traceback (most recent call last):
119
244
...
120
ValueError: Invalid RFC 3339 duration: u'PT1S2M'
245
ValueError: Invalid RFC 3339 duration: "PT1S2M"
121
246
>>> # Time needs time marker
122
247
>>> rfc3339_duration_to_delta("P1H2S")
123
248
Traceback (most recent call last):
124
249
...
125
ValueError: Invalid RFC 3339 duration: u'P1H2S'
250
ValueError: Invalid RFC 3339 duration: "P1H2S"
126
251
>>> # Weeks can not be combined with anything else
127
252
>>> rfc3339_duration_to_delta("P1D2W")
128
253
Traceback (most recent call last):
129
254
...
130
ValueError: Invalid RFC 3339 duration: u'P1D2W'
255
ValueError: Invalid RFC 3339 duration: "P1D2W"
131
256
>>> rfc3339_duration_to_delta("P2W2H")
132
257
Traceback (most recent call last):
133
258
...
134
ValueError: Invalid RFC 3339 duration: u'P2W2H'
259
ValueError: Invalid RFC 3339 duration: "P2W2H"
135
260
"""
136
261
137
262
# Parsing an RFC 3339 duration with regular expressions is not
208
333
break
209
334
else:
210
335
# No currently valid tokens were found
211
raise ValueError("Invalid RFC 3339 duration: {!r}"
336
raise ValueError("Invalid RFC 3339 duration: \"{}\""
212
337
.format(duration))
213
338
# End token found
214
339
return value
215
340
216
341
217
def string_to_delta(interval):
218
"""Parse a string and return a datetime.timedelta"""
219
220
try:
221
return rfc3339_duration_to_delta(interval)
222
except ValueError as e:
223
log.warning("%s - Parsing as pre-1.6.1 interval instead",
224
' '.join(e.args))
225
return parse_pre_1_6_1_interval(interval)
226
227
228
342
def parse_pre_1_6_1_interval(interval):
229
343
"""Parse an interval string as documented by Mandos before 1.6.1,
230
344
and return a datetime.timedelta
268
382
return value
269
383
270
384
271
## Classes for commands.
272
273
# Abstract classes first
274
class Command(object):
275
"""Abstract class for commands"""
276
def run(self, mandos, clients):
277
"""Normal commands should implement run_on_one_client(), but
278
commands which want to operate on all clients at the same time
279
can override this run() method instead."""
280
self.mandos = mandos
281
for client, properties in clients.items():
282
self.run_on_one_client(client, properties)
283
284
class PrintCmd(Command):
285
"""Abstract class for commands printing client details"""
286
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
287
"Created", "Interval", "Host", "KeyID",
288
"Fingerprint", "CheckerRunning", "LastEnabled",
289
"ApprovalPending", "ApprovedByDefault",
290
"LastApprovalRequest", "ApprovalDelay",
291
"ApprovalDuration", "Checker", "ExtendedTimeout",
292
"Expires", "LastCheckerStatus")
293
def run(self, mandos, clients):
294
print(self.output(clients))
295
296
class PropertyCmd(Command):
297
"""Abstract class for Actions for setting one client property"""
298
def run_on_one_client(self, client, properties):
299
"""Set the Client's D-Bus property"""
300
client.Set(client_interface, self.property, self.value_to_set,
301
dbus_interface=dbus.PROPERTIES_IFACE)
302
303
class ValueArgumentMixIn(object):
304
"""Mixin class for commands taking a value as argument"""
305
def __init__(self, value):
306
self.value_to_set = value
307
308
class MillisecondsValueArgumentMixIn(ValueArgumentMixIn):
309
"""Mixin class for commands taking a value argument as
310
milliseconds."""
311
@property
312
def value_to_set(self):
313
return self._vts
314
@value_to_set.setter
315
def value_to_set(self, value):
316
"""When setting, convert value to a datetime.timedelta"""
317
self._vts = string_to_delta(value).total_seconds() * 1000
318
319
# Actual (non-abstract) command classes
320
321
class PrintTableCmd(PrintCmd):
322
def __init__(self, verbose=False):
323
self.verbose = verbose
324
325
def output(self, clients):
326
if self.verbose:
327
keywords = self.all_keywords
328
else:
329
keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
330
return str(self.TableOfClients(clients.values(), keywords))
331
332
class TableOfClients(object):
333
tableheaders = {
334
"Name": "Name",
335
"Enabled": "Enabled",
336
"Timeout": "Timeout",
337
"LastCheckedOK": "Last Successful Check",
338
"LastApprovalRequest": "Last Approval Request",
339
"Created": "Created",
340
"Interval": "Interval",
341
"Host": "Host",
342
"Fingerprint": "Fingerprint",
343
"KeyID": "Key ID",
344
"CheckerRunning": "Check Is Running",
345
"LastEnabled": "Last Enabled",
346
"ApprovalPending": "Approval Is Pending",
347
"ApprovedByDefault": "Approved By Default",
348
"ApprovalDelay": "Approval Delay",
349
"ApprovalDuration": "Approval Duration",
350
"Checker": "Checker",
351
"ExtendedTimeout": "Extended Timeout",
352
"Expires": "Expires",
353
"LastCheckerStatus": "Last Checker Status",
354
}
355
356
def __init__(self, clients, keywords, tableheaders=None):
357
self.clients = clients
358
self.keywords = keywords
359
if tableheaders is not None:
360
self.tableheaders = tableheaders
361
362
def __str__(self):
363
return "\n".join(self.rows())
364
365
if sys.version_info.major == 2:
366
__unicode__ = __str__
367
def __str__(self):
368
return str(self).encode(locale.getpreferredencoding())
369
370
def rows(self):
371
format_string = self.row_formatting_string()
372
rows = [self.header_line(format_string)]
373
rows.extend(self.client_line(client, format_string)
374
for client in self.clients)
375
return rows
376
377
def row_formatting_string(self):
378
"Format string used to format table rows"
379
return " ".join("{{{key}:{width}}}".format(
380
width=max(len(self.tableheaders[key]),
381
*(len(self.string_from_client(client, key))
382
for client in self.clients)),
383
key=key)
384
for key in self.keywords)
385
386
def string_from_client(self, client, key):
387
return self.valuetostring(client[key], key)
388
389
@staticmethod
390
def valuetostring(value, keyword):
391
if isinstance(value, dbus.Boolean):
392
return "Yes" if value else "No"
393
if keyword in ("Timeout", "Interval", "ApprovalDelay",
394
"ApprovalDuration", "ExtendedTimeout"):
395
return milliseconds_to_string(value)
396
return str(value)
397
398
def header_line(self, format_string):
399
return format_string.format(**self.tableheaders)
400
401
def client_line(self, client, format_string):
402
return format_string.format(
403
**{key: self.string_from_client(client, key)
404
for key in self.keywords})
405
406
407
408
class DumpJSONCmd(PrintCmd):
409
def output(self, clients):
410
data = {client["Name"]:
411
{key: self.dbus_boolean_to_bool(client[key])
412
for key in self.all_keywords}
413
for client in clients.values()}
414
return json.dumps(data, indent=4, separators=(',', ': '))
415
@staticmethod
416
def dbus_boolean_to_bool(value):
417
if isinstance(value, dbus.Boolean):
418
value = bool(value)
419
return value
420
421
class IsEnabledCmd(Command):
422
def run_on_one_client(self, client, properties):
423
if self.is_enabled(client, properties):
424
sys.exit(0)
385
def check_option_syntax(parser, options):
386
"""Apply additional restrictions on options, not expressible in
387
argparse"""
388
389
def has_actions(options):
390
return any((options.enable,
391
options.disable,
392
options.bump_timeout,
393
options.start_checker,
394
options.stop_checker,
395
options.is_enabled,
396
options.remove,
397
options.checker is not None,
398
options.timeout is not None,
399
options.extended_timeout is not None,
400
options.interval is not None,
401
options.approved_by_default is not None,
402
options.approval_delay is not None,
403
options.approval_duration is not None,
404
options.host is not None,
405
options.secret is not None,
406
options.approve,
407
options.deny))
408
409
if has_actions(options) and not (options.client or options.all):
410
parser.error("Options require clients names or --all.")
411
if options.verbose and has_actions(options):
412
parser.error("--verbose can only be used alone.")
413
if options.dump_json and (options.verbose
414
or has_actions(options)):
415
parser.error("--dump-json can only be used alone.")
416
if options.all and not has_actions(options):
417
parser.error("--all requires an action.")
418
if options.is_enabled and len(options.client) > 1:
419
parser.error("--is-enabled requires exactly one client")
420
if options.remove:
421
options.remove = False
422
if has_actions(options) and not options.deny:
423
parser.error("--remove can only be combined with --deny")
424
options.remove = True
425
426
427
def get_mandos_dbus_object(bus):
428
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
429
dbus_busname, server_dbus_path)
430
with if_dbus_exception_log_with_exception_and_exit(
431
"Could not connect to Mandos server: %s"):
432
mandos_dbus_object = bus.get_object(dbus_busname,
433
server_dbus_path)
434
return mandos_dbus_object
435
436
437
@contextlib.contextmanager
438
def if_dbus_exception_log_with_exception_and_exit(*args, **kwargs):
439
try:
440
yield
441
except dbus.exceptions.DBusException as e:
442
log.critical(*(args + (e,)), **kwargs)
425
443
sys.exit(1)
426
def is_enabled(self, client, properties):
427
return bool(properties["Enabled"])
428
429
class RemoveCmd(Command):
430
def run_on_one_client(self, client, properties):
431
self.mandos.RemoveClient(client.__dbus_object_path__)
432
433
class ApproveCmd(Command):
434
def run_on_one_client(self, client, properties):
435
client.Approve(dbus.Boolean(True),
436
dbus_interface=client_interface)
437
438
class DenyCmd(Command):
439
def run_on_one_client(self, client, properties):
440
client.Approve(dbus.Boolean(False),
441
dbus_interface=client_interface)
442
443
class EnableCmd(PropertyCmd):
444
property = "Enabled"
445
value_to_set = dbus.Boolean(True)
446
447
class DisableCmd(PropertyCmd):
448
property = "Enabled"
449
value_to_set = dbus.Boolean(False)
450
451
class BumpTimeoutCmd(PropertyCmd):
452
property = "LastCheckedOK"
453
value_to_set = ""
454
455
class StartCheckerCmd(PropertyCmd):
456
property = "CheckerRunning"
457
value_to_set = dbus.Boolean(True)
458
459
class StopCheckerCmd(PropertyCmd):
460
property = "CheckerRunning"
461
value_to_set = dbus.Boolean(False)
462
463
class ApproveByDefaultCmd(PropertyCmd):
464
property = "ApprovedByDefault"
465
value_to_set = dbus.Boolean(True)
466
467
class DenyByDefaultCmd(PropertyCmd):
468
property = "ApprovedByDefault"
469
value_to_set = dbus.Boolean(False)
470
471
class SetCheckerCmd(PropertyCmd, ValueArgumentMixIn):
472
property = "Checker"
473
474
class SetHostCmd(PropertyCmd, ValueArgumentMixIn):
475
property = "Host"
476
477
class SetSecretCmd(PropertyCmd, ValueArgumentMixIn):
478
property = "Secret"
479
480
class SetTimeoutCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
481
property = "Timeout"
482
483
class SetExtendedTimeoutCmd(PropertyCmd,
484
MillisecondsValueArgumentMixIn):
485
property = "ExtendedTimeout"
486
487
class SetIntervalCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
488
property = "Interval"
489
490
class SetApprovalDelayCmd(PropertyCmd,
491
MillisecondsValueArgumentMixIn):
492
property = "ApprovalDelay"
493
494
class SetApprovalDurationCmd(PropertyCmd,
495
MillisecondsValueArgumentMixIn):
496
property = "ApprovalDuration"
497
498
def has_actions(options):
499
return any((options.enable,
500
options.disable,
501
options.bump_timeout,
502
options.start_checker,
503
options.stop_checker,
504
options.is_enabled,
505
options.remove,
506
options.checker is not None,
507
options.timeout is not None,
508
options.extended_timeout is not None,
509
options.interval is not None,
510
options.approved_by_default is not None,
511
options.approval_delay is not None,
512
options.approval_duration is not None,
513
options.host is not None,
514
options.secret is not None,
515
options.approve,
516
options.deny))
517
518
def add_command_line_options(parser):
519
parser.add_argument("--version", action="version",
520
version="%(prog)s {}".format(version),
521
help="show version number and exit")
522
parser.add_argument("-a", "--all", action="store_true",
523
help="Select all clients")
524
parser.add_argument("-v", "--verbose", action="store_true",
525
help="Print all fields")
526
parser.add_argument("-j", "--dump-json", action="store_true",
527
help="Dump client data in JSON format")
528
enable_disable = parser.add_mutually_exclusive_group()
529
enable_disable.add_argument("-e", "--enable", action="store_true",
530
help="Enable client")
531
enable_disable.add_argument("-d", "--disable",
532
action="store_true",
533
help="disable client")
534
parser.add_argument("-b", "--bump-timeout", action="store_true",
535
help="Bump timeout for client")
536
start_stop_checker = parser.add_mutually_exclusive_group()
537
start_stop_checker.add_argument("--start-checker",
538
action="store_true",
539
help="Start checker for client")
540
start_stop_checker.add_argument("--stop-checker",
541
action="store_true",
542
help="Stop checker for client")
543
parser.add_argument("-V", "--is-enabled", action="store_true",
544
help="Check if client is enabled")
545
parser.add_argument("-r", "--remove", action="store_true",
546
help="Remove client")
547
parser.add_argument("-c", "--checker",
548
help="Set checker command for client")
549
parser.add_argument("-t", "--timeout",
550
help="Set timeout for client")
551
parser.add_argument("--extended-timeout",
552
help="Set extended timeout for client")
553
parser.add_argument("-i", "--interval",
554
help="Set checker interval for client")
555
approve_deny_default = parser.add_mutually_exclusive_group()
556
approve_deny_default.add_argument(
557
"--approve-by-default", action="store_true",
558
default=None, dest="approved_by_default",
559
help="Set client to be approved by default")
560
approve_deny_default.add_argument(
561
"--deny-by-default", action="store_false",
562
dest="approved_by_default",
563
help="Set client to be denied by default")
564
parser.add_argument("--approval-delay",
565
help="Set delay before client approve/deny")
566
parser.add_argument("--approval-duration",
567
help="Set duration of one client approval")
568
parser.add_argument("-H", "--host", help="Set host for client")
569
parser.add_argument("-s", "--secret",
570
type=argparse.FileType(mode="rb"),
571
help="Set password blob (file) for client")
572
approve_deny = parser.add_mutually_exclusive_group()
573
approve_deny.add_argument(
574
"-A", "--approve", action="store_true",
575
help="Approve any current client request")
576
approve_deny.add_argument("-D", "--deny", action="store_true",
577
help="Deny any current client request")
578
parser.add_argument("--check", action="store_true",
579
help="Run self-test")
580
parser.add_argument("client", nargs="*", help="Client name")
444
445
446
def get_managed_objects(object_manager):
447
log.debug("D-Bus: %s:%s:%s.GetManagedObjects()", dbus_busname,
448
server_dbus_path, dbus.OBJECT_MANAGER_IFACE)
449
with if_dbus_exception_log_with_exception_and_exit(
450
"Failed to access Mandos server through D-Bus:\n%s"):
451
with SilenceLogger("dbus.proxies"):
452
managed_objects = object_manager.GetManagedObjects()
453
return managed_objects
454
455
456
class SilenceLogger(object):
457
"Simple context manager to silence a particular logger"
458
def __init__(self, loggername):
459
self.logger = logging.getLogger(loggername)
460
461
def __enter__(self):
462
self.logger.addFilter(self.nullfilter)
463
return self
464
465
class NullFilter(logging.Filter):
466
def filter(self, record):
467
return False
468
469
nullfilter = NullFilter()
470
471
def __exit__(self, exc_type, exc_val, exc_tb):
472
self.logger.removeFilter(self.nullfilter)
581
473
582
474
583
475
def commands_from_options(options):
584
476
585
477
commands = []
586
478
479
if options.is_enabled:
480
commands.append(command.IsEnabled())
481
482
if options.approve:
483
commands.append(command.Approve())
484
485
if options.deny:
486
commands.append(command.Deny())
487
488
if options.remove:
489
commands.append(command.Remove())
490
587
491
if options.dump_json:
588
commands.append(DumpJSONCmd())
492
commands.append(command.DumpJSON())
589
493
590
494
if options.enable:
591
commands.append(EnableCmd())
495
commands.append(command.Enable())
592
496
593
497
if options.disable:
594
commands.append(DisableCmd())
498
commands.append(command.Disable())
595
499
596
500
if options.bump_timeout:
597
commands.append(BumpTimeoutCmd())
501
commands.append(command.BumpTimeout())
598
502
599
503
if options.start_checker:
600
commands.append(StartCheckerCmd())
504
commands.append(command.StartChecker())
601
505
602
506
if options.stop_checker:
603
commands.append(StopCheckerCmd())
604
605
if options.is_enabled:
606
commands.append(IsEnabledCmd())
607
608
if options.remove:
609
commands.append(RemoveCmd())
507
commands.append(command.StopChecker())
508
509
if options.approved_by_default is not None:
510
if options.approved_by_default:
511
commands.append(command.ApproveByDefault())
512
else:
513
commands.append(command.DenyByDefault())
610
514
611
515
if options.checker is not None:
612
commands.append(SetCheckerCmd())
516
commands.append(command.SetChecker(options.checker))
517
518
if options.host is not None:
519
commands.append(command.SetHost(options.host))
520
521
if options.secret is not None:
522
commands.append(command.SetSecret(options.secret))
613
523
614
524
if options.timeout is not None:
615
commands.append(SetTimeoutCmd(options.timeout))
525
commands.append(command.SetTimeout(options.timeout))
616
526
617
527
if options.extended_timeout:
618
528
commands.append(
619
SetExtendedTimeoutCmd(options.extended_timeout))
529
command.SetExtendedTimeout(options.extended_timeout))
620
530
621
531
if options.interval is not None:
622
command.append(SetIntervalCmd(options.interval))
623
624
if options.approved_by_default is not None:
625
if options.approved_by_default:
626
command.append(ApproveByDefaultCmd())
627
else:
628
command.append(DenyByDefaultCmd())
532
commands.append(command.SetInterval(options.interval))
629
533
630
534
if options.approval_delay is not None:
631
command.append(SetApprovalDelayCmd(options.approval_delay))
535
commands.append(
536
command.SetApprovalDelay(options.approval_delay))
632
537
633
538
if options.approval_duration is not None:
634
command.append(
635
SetApprovalDurationCmd(options.approval_duration))
636
637
if options.host is not None:
638
command.append(SetHostCmd(options.host))
639
640
if options.secret is not None:
641
command.append(SetSecretCmd(options.secret))
642
643
if options.approve:
644
commands.append(ApproveCmd())
645
646
if options.deny:
647
commands.append(DenyCmd())
539
commands.append(
540
command.SetApprovalDuration(options.approval_duration))
648
541
649
542
# If no command option has been given, show table of clients,
650
543
# optionally verbosely
651
544
if not commands:
652
commands.append(PrintTableCmd(verbose=options.verbose))
545
commands.append(command.PrintTable(verbose=options.verbose))
653
546
654
547
return commands
655
548
656
549
657
def main():
658
parser = argparse.ArgumentParser()
659
660
add_command_line_options(parser)
661
662
options = parser.parse_args()
663
664
if has_actions(options) and not (options.client or options.all):
665
parser.error("Options require clients names or --all.")
666
if options.verbose and has_actions(options):
667
parser.error("--verbose can only be used alone.")
668
if options.dump_json and (options.verbose
669
or has_actions(options)):
670
parser.error("--dump-json can only be used alone.")
671
if options.all and not has_actions(options):
672
parser.error("--all requires an action.")
673
if options.is_enabled and len(options.client) > 1:
674
parser.error("--is-enabled requires exactly one client")
675
676
clientnames = options.client
677
678
try:
679
bus = dbus.SystemBus()
680
mandos_dbus_objc = bus.get_object(busname, server_path)
681
except dbus.exceptions.DBusException:
682
log.critical("Could not connect to Mandos server")
683
sys.exit(1)
684
685
mandos_serv = dbus.Interface(mandos_dbus_objc,
686
dbus_interface=server_interface)
687
mandos_serv_object_manager = dbus.Interface(
688
mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
689
690
# Filter out log message from dbus module
691
dbus_logger = logging.getLogger("dbus.proxies")
692
class NullFilter(logging.Filter):
693
def filter(self, record):
694
return False
695
dbus_filter = NullFilter()
696
try:
697
dbus_logger.addFilter(dbus_filter)
698
mandos_clients = {path: ifs_and_props[client_interface]
699
for path, ifs_and_props in
700
mandos_serv_object_manager
701
.GetManagedObjects().items()
702
if client_interface in ifs_and_props}
703
except dbus.exceptions.DBusException as e:
704
log.critical("Failed to access Mandos server through D-Bus:"
705
"\n%s", e)
706
sys.exit(1)
707
finally:
708
# restore dbus logger
709
dbus_logger.removeFilter(dbus_filter)
710
711
# Compile dict of (clients: properties) to process
712
clients = {}
713
714
if not clientnames:
715
clients = {bus.get_object(busname, path): properties
716
for path, properties in mandos_clients.items()}
717
else:
718
for name in clientnames:
719
for path, client in mandos_clients.items():
720
if client["Name"] == name:
721
client_objc = bus.get_object(busname, path)
722
clients[client_objc] = client
723
break
724
else:
725
log.critical("Client not found on server: %r", name)
726
sys.exit(1)
727
728
# Run all commands on clients
729
commands = commands_from_options(options)
730
for command in commands:
731
command.run(mandos_serv, clients)
550
class command(object):
551
"""A namespace for command classes"""
552
553
class Base(object):
554
"""Abstract base class for commands"""
555
def run(self, clients, bus=None, mandos=None):
556
"""Normal commands should implement run_on_one_client(),
557
but commands which want to operate on all clients at the same time can
558
override this run() method instead.
559
"""
560
self.mandos = mandos
561
for clientpath, properties in clients.items():
562
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
563
dbus_busname, str(clientpath))
564
client = bus.get_object(dbus_busname, clientpath)
565
self.run_on_one_client(client, properties)
566
567
568
class IsEnabled(Base):
569
def run(self, clients, bus=None, mandos=None):
570
client, properties = next(iter(clients.items()))
571
if self.is_enabled(client, properties):
572
sys.exit(0)
573
sys.exit(1)
574
def is_enabled(self, client, properties):
575
return properties["Enabled"]
576
577
578
class Approve(Base):
579
def run_on_one_client(self, client, properties):
580
log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
581
client.__dbus_object_path__,
582
client_dbus_interface)
583
client.Approve(dbus.Boolean(True),
584
dbus_interface=client_dbus_interface)
585
586
587
class Deny(Base):
588
def run_on_one_client(self, client, properties):
589
log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
590
client.__dbus_object_path__,
591
client_dbus_interface)
592
client.Approve(dbus.Boolean(False),
593
dbus_interface=client_dbus_interface)
594
595
596
class Remove(Base):
597
def run_on_one_client(self, client, properties):
598
log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)",
599
dbus_busname, server_dbus_path,
600
server_dbus_interface,
601
str(client.__dbus_object_path__))
602
self.mandos.RemoveClient(client.__dbus_object_path__)
603
604
605
class Output(Base):
606
"""Abstract class for commands outputting client details"""
607
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
608
"Created", "Interval", "Host", "KeyID",
609
"Fingerprint", "CheckerRunning",
610
"LastEnabled", "ApprovalPending",
611
"ApprovedByDefault", "LastApprovalRequest",
612
"ApprovalDelay", "ApprovalDuration",
613
"Checker", "ExtendedTimeout", "Expires",
614
"LastCheckerStatus")
615
616
def run(self, clients, bus=None, mandos=None):
617
print(self.output(clients.values()))
618
619
def output(self, clients):
620
raise NotImplementedError()
621
622
623
class DumpJSON(Output):
624
def output(self, clients):
625
data = {client["Name"]:
626
{key: self.dbus_boolean_to_bool(client[key])
627
for key in self.all_keywords}
628
for client in clients}
629
return json.dumps(data, indent=4, separators=(',', ': '))
630
631
@staticmethod
632
def dbus_boolean_to_bool(value):
633
if isinstance(value, dbus.Boolean):
634
value = bool(value)
635
return value
636
637
638
class PrintTable(Output):
639
def __init__(self, verbose=False):
640
self.verbose = verbose
641
642
def output(self, clients):
643
default_keywords = ("Name", "Enabled", "Timeout",
644
"LastCheckedOK")
645
keywords = default_keywords
646
if self.verbose:
647
keywords = self.all_keywords
648
return str(self.TableOfClients(clients, keywords))
649
650
class TableOfClients(object):
651
tableheaders = {
652
"Name": "Name",
653
"Enabled": "Enabled",
654
"Timeout": "Timeout",
655
"LastCheckedOK": "Last Successful Check",
656
"LastApprovalRequest": "Last Approval Request",
657
"Created": "Created",
658
"Interval": "Interval",
659
"Host": "Host",
660
"Fingerprint": "Fingerprint",
661
"KeyID": "Key ID",
662
"CheckerRunning": "Check Is Running",
663
"LastEnabled": "Last Enabled",
664
"ApprovalPending": "Approval Is Pending",
665
"ApprovedByDefault": "Approved By Default",
666
"ApprovalDelay": "Approval Delay",
667
"ApprovalDuration": "Approval Duration",
668
"Checker": "Checker",
669
"ExtendedTimeout": "Extended Timeout",
670
"Expires": "Expires",
671
"LastCheckerStatus": "Last Checker Status",
672
}
673
674
def __init__(self, clients, keywords):
675
self.clients = clients
676
self.keywords = keywords
677
678
def __str__(self):
679
return "\n".join(self.rows())
680
681
if sys.version_info.major == 2:
682
__unicode__ = __str__
683
def __str__(self):
684
return str(self).encode(
685
locale.getpreferredencoding())
686
687
def rows(self):
688
format_string = self.row_formatting_string()
689
rows = [self.header_line(format_string)]
690
rows.extend(self.client_line(client, format_string)
691
for client in self.clients)
692
return rows
693
694
def row_formatting_string(self):
695
"Format string used to format table rows"
696
return " ".join("{{{key}:{width}}}".format(
697
width=max(len(self.tableheaders[key]),
698
*(len(self.string_from_client(client,
699
key))
700
for client in self.clients)),
701
key=key)
702
for key in self.keywords)
703
704
def string_from_client(self, client, key):
705
return self.valuetostring(client[key], key)
706
707
@classmethod
708
def valuetostring(cls, value, keyword):
709
if isinstance(value, dbus.Boolean):
710
return "Yes" if value else "No"
711
if keyword in ("Timeout", "Interval", "ApprovalDelay",
712
"ApprovalDuration", "ExtendedTimeout"):
713
return cls.milliseconds_to_string(value)
714
return str(value)
715
716
def header_line(self, format_string):
717
return format_string.format(**self.tableheaders)
718
719
def client_line(self, client, format_string):
720
return format_string.format(
721
**{key: self.string_from_client(client, key)
722
for key in self.keywords})
723
724
@staticmethod
725
def milliseconds_to_string(ms):
726
td = datetime.timedelta(0, 0, 0, ms)
727
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
728
.format(days="{}T".format(td.days)
729
if td.days else "",
730
hours=td.seconds // 3600,
731
minutes=(td.seconds % 3600) // 60,
732
seconds=td.seconds % 60))
733
734
735
class Property(Base):
736
"Abstract class for Actions for setting one client property"
737
738
def run_on_one_client(self, client, properties):
739
"""Set the Client's D-Bus property"""
740
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
741
client.__dbus_object_path__,
742
dbus.PROPERTIES_IFACE, client_dbus_interface,
743
self.propname, self.value_to_set
744
if not isinstance(self.value_to_set,
745
dbus.Boolean)
746
else bool(self.value_to_set))
747
client.Set(client_dbus_interface, self.propname,
748
self.value_to_set,
749
dbus_interface=dbus.PROPERTIES_IFACE)
750
751
@property
752
def propname(self):
753
raise NotImplementedError()
754
755
756
class Enable(Property):
757
propname = "Enabled"
758
value_to_set = dbus.Boolean(True)
759
760
761
class Disable(Property):
762
propname = "Enabled"
763
value_to_set = dbus.Boolean(False)
764
765
766
class BumpTimeout(Property):
767
propname = "LastCheckedOK"
768
value_to_set = ""
769
770
771
class StartChecker(Property):
772
propname = "CheckerRunning"
773
value_to_set = dbus.Boolean(True)
774
775
776
class StopChecker(Property):
777
propname = "CheckerRunning"
778
value_to_set = dbus.Boolean(False)
779
780
781
class ApproveByDefault(Property):
782
propname = "ApprovedByDefault"
783
value_to_set = dbus.Boolean(True)
784
785
786
class DenyByDefault(Property):
787
propname = "ApprovedByDefault"
788
value_to_set = dbus.Boolean(False)
789
790
791
class PropertyValue(Property):
792
"Abstract class for Property recieving a value as argument"
793
def __init__(self, value):
794
self.value_to_set = value
795
796
797
class SetChecker(PropertyValue):
798
propname = "Checker"
799
800
801
class SetHost(PropertyValue):
802
propname = "Host"
803
804
805
class SetSecret(PropertyValue):
806
propname = "Secret"
807
808
@property
809
def value_to_set(self):
810
return self._vts
811
812
@value_to_set.setter
813
def value_to_set(self, value):
814
"""When setting, read data from supplied file object"""
815
self._vts = value.read()
816
value.close()
817
818
819
class MillisecondsPropertyValueArgument(PropertyValue):
820
"""Abstract class for PropertyValue taking a value argument as
821
a datetime.timedelta() but should store it as milliseconds."""
822
823
@property
824
def value_to_set(self):
825
return self._vts
826
827
@value_to_set.setter
828
def value_to_set(self, value):
829
"When setting, convert value from a datetime.timedelta"
830
self._vts = int(round(value.total_seconds() * 1000))
831
832
833
class SetTimeout(MillisecondsPropertyValueArgument):
834
propname = "Timeout"
835
836
837
class SetExtendedTimeout(MillisecondsPropertyValueArgument):
838
propname = "ExtendedTimeout"
839
840
841
class SetInterval(MillisecondsPropertyValueArgument):
842
propname = "Interval"
843
844
845
class SetApprovalDelay(MillisecondsPropertyValueArgument):
846
propname = "ApprovalDelay"
847
848
849
class SetApprovalDuration(MillisecondsPropertyValueArgument):
850
propname = "ApprovalDuration"
851
732
852
733
853
734
class Test_milliseconds_to_string(unittest.TestCase):
735
def test_all(self):
736
self.assertEqual(milliseconds_to_string(93785000),
737
"1T02:03:05")
738
def test_no_days(self):
739
self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
740
def test_all_zero(self):
741
self.assertEqual(milliseconds_to_string(0), "00:00:00")
742
def test_no_fractional_seconds(self):
743
self.assertEqual(milliseconds_to_string(400), "00:00:00")
744
self.assertEqual(milliseconds_to_string(900), "00:00:00")
745
self.assertEqual(milliseconds_to_string(1900), "00:00:01")
746
747
class Test_string_to_delta(unittest.TestCase):
748
def test_handles_basic_rfc3339(self):
749
self.assertEqual(string_to_delta("PT2H"),
750
datetime.timedelta(0, 7200))
854
class TestCaseWithAssertLogs(unittest.TestCase):
855
"""unittest.TestCase.assertLogs only exists in Python 3.4"""
856
857
if not hasattr(unittest.TestCase, "assertLogs"):
858
@contextlib.contextmanager
859
def assertLogs(self, logger, level=logging.INFO):
860
capturing_handler = self.CapturingLevelHandler(level)
861
old_level = logger.level
862
old_propagate = logger.propagate
863
logger.addHandler(capturing_handler)
864
logger.setLevel(level)
865
logger.propagate = False
866
try:
867
yield capturing_handler.watcher
868
finally:
869
logger.propagate = old_propagate
870
logger.removeHandler(capturing_handler)
871
logger.setLevel(old_level)
872
self.assertGreater(len(capturing_handler.watcher.records),
873
0)
874
875
class CapturingLevelHandler(logging.Handler):
876
def __init__(self, level, *args, **kwargs):
877
logging.Handler.__init__(self, *args, **kwargs)
878
self.watcher = self.LoggingWatcher([], [])
879
def emit(self, record):
880
self.watcher.records.append(record)
881
self.watcher.output.append(self.format(record))
882
883
LoggingWatcher = collections.namedtuple("LoggingWatcher",
884
("records",
885
"output"))
886
887
888
class Test_string_to_delta(TestCaseWithAssertLogs):
889
# Just test basic RFC 3339 functionality here, the doc string for
890
# rfc3339_duration_to_delta() already has more comprehensive
891
# tests, which is run by doctest.
892
893
def test_rfc3339_zero_seconds(self):
894
self.assertEqual(datetime.timedelta(),
895
string_to_delta("PT0S"))
896
897
def test_rfc3339_zero_days(self):
898
self.assertEqual(datetime.timedelta(), string_to_delta("P0D"))
899
900
def test_rfc3339_one_second(self):
901
self.assertEqual(datetime.timedelta(0, 1),
902
string_to_delta("PT1S"))
903
904
def test_rfc3339_two_hours(self):
905
self.assertEqual(datetime.timedelta(0, 7200),
906
string_to_delta("PT2H"))
907
751
908
def test_falls_back_to_pre_1_6_1_with_warning(self):
752
# assertLogs only exists in Python 3.4
753
if hasattr(self, "assertLogs"):
754
with self.assertLogs(log, logging.WARNING):
755
value = string_to_delta("2h")
756
else:
757
class WarningFilter(logging.Filter):
758
"""Don't show, but record the presence of, warnings"""
759
def filter(self, record):
760
is_warning = record.levelno >= logging.WARNING
761
self.found = is_warning or getattr(self, "found",
762
False)
763
return not is_warning
764
warning_filter = WarningFilter()
765
log.addFilter(warning_filter)
909
with self.assertLogs(log, logging.WARNING):
910
value = string_to_delta("2h")
911
self.assertEqual(datetime.timedelta(0, 7200), value)
912
913
914
class Test_check_option_syntax(unittest.TestCase):
915
def setUp(self):
916
self.parser = argparse.ArgumentParser()
917
add_command_line_options(self.parser)
918
919
def test_actions_requires_client_or_all(self):
920
for action, value in self.actions.items():
921
options = self.parser.parse_args()
922
setattr(options, action, value)
923
with self.assertParseError():
924
self.check_option_syntax(options)
925
926
# This mostly corresponds to the definition from has_actions() in
927
# check_option_syntax()
928
actions = {
929
# The actual values set here are not that important, but we do
930
# at least stick to the correct types, even though they are
931
# never used
932
"enable": True,
933
"disable": True,
934
"bump_timeout": True,
935
"start_checker": True,
936
"stop_checker": True,
937
"is_enabled": True,
938
"remove": True,
939
"checker": "x",
940
"timeout": datetime.timedelta(),
941
"extended_timeout": datetime.timedelta(),
942
"interval": datetime.timedelta(),
943
"approved_by_default": True,
944
"approval_delay": datetime.timedelta(),
945
"approval_duration": datetime.timedelta(),
946
"host": "x",
947
"secret": io.BytesIO(b"x"),
948
"approve": True,
949
"deny": True,
950
}
951
952
@contextlib.contextmanager
953
def assertParseError(self):
954
with self.assertRaises(SystemExit) as e:
955
with self.redirect_stderr_to_devnull():
956
yield
957
# Exit code from argparse is guaranteed to be "2". Reference:
958
# https://docs.python.org/3/library
959
# /argparse.html#exiting-methods
960
self.assertEqual(2, e.exception.code)
961
962
@staticmethod
963
@contextlib.contextmanager
964
def redirect_stderr_to_devnull():
965
old_stderr = sys.stderr
966
with contextlib.closing(open(os.devnull, "w")) as null:
967
sys.stderr = null
766
968
try:
767
value = string_to_delta("2h")
969
yield
768
970
finally:
769
log.removeFilter(warning_filter)
770
self.assertTrue(getattr(warning_filter, "found", False))
771
self.assertEqual(value, datetime.timedelta(0, 7200))
772
773
774
class TestCmd(unittest.TestCase):
971
sys.stderr = old_stderr
972
973
def check_option_syntax(self, options):
974
check_option_syntax(self.parser, options)
975
976
def test_actions_all_conflicts_with_verbose(self):
977
for action, value in self.actions.items():
978
options = self.parser.parse_args()
979
setattr(options, action, value)
980
options.all = True
981
options.verbose = True
982
with self.assertParseError():
983
self.check_option_syntax(options)
984
985
def test_actions_with_client_conflicts_with_verbose(self):
986
for action, value in self.actions.items():
987
options = self.parser.parse_args()
988
setattr(options, action, value)
989
options.verbose = True
990
options.client = ["foo"]
991
with self.assertParseError():
992
self.check_option_syntax(options)
993
994
def test_dump_json_conflicts_with_verbose(self):
995
options = self.parser.parse_args()
996
options.dump_json = True
997
options.verbose = True
998
with self.assertParseError():
999
self.check_option_syntax(options)
1000
1001
def test_dump_json_conflicts_with_action(self):
1002
for action, value in self.actions.items():
1003
options = self.parser.parse_args()
1004
setattr(options, action, value)
1005
options.dump_json = True
1006
with self.assertParseError():
1007
self.check_option_syntax(options)
1008
1009
def test_all_can_not_be_alone(self):
1010
options = self.parser.parse_args()
1011
options.all = True
1012
with self.assertParseError():
1013
self.check_option_syntax(options)
1014
1015
def test_all_is_ok_with_any_action(self):
1016
for action, value in self.actions.items():
1017
options = self.parser.parse_args()
1018
setattr(options, action, value)
1019
options.all = True
1020
self.check_option_syntax(options)
1021
1022
def test_any_action_is_ok_with_one_client(self):
1023
for action, value in self.actions.items():
1024
options = self.parser.parse_args()
1025
setattr(options, action, value)
1026
options.client = ["foo"]
1027
self.check_option_syntax(options)
1028
1029
def test_one_client_with_all_actions_except_is_enabled(self):
1030
options = self.parser.parse_args()
1031
for action, value in self.actions.items():
1032
if action == "is_enabled":
1033
continue
1034
setattr(options, action, value)
1035
options.client = ["foo"]
1036
self.check_option_syntax(options)
1037
1038
def test_two_clients_with_all_actions_except_is_enabled(self):
1039
options = self.parser.parse_args()
1040
for action, value in self.actions.items():
1041
if action == "is_enabled":
1042
continue
1043
setattr(options, action, value)
1044
options.client = ["foo", "barbar"]
1045
self.check_option_syntax(options)
1046
1047
def test_two_clients_are_ok_with_actions_except_is_enabled(self):
1048
for action, value in self.actions.items():
1049
if action == "is_enabled":
1050
continue
1051
options = self.parser.parse_args()
1052
setattr(options, action, value)
1053
options.client = ["foo", "barbar"]
1054
self.check_option_syntax(options)
1055
1056
def test_is_enabled_fails_without_client(self):
1057
options = self.parser.parse_args()
1058
options.is_enabled = True
1059
with self.assertParseError():
1060
self.check_option_syntax(options)
1061
1062
def test_is_enabled_fails_with_two_clients(self):
1063
options = self.parser.parse_args()
1064
options.is_enabled = True
1065
options.client = ["foo", "barbar"]
1066
with self.assertParseError():
1067
self.check_option_syntax(options)
1068
1069
def test_remove_can_only_be_combined_with_action_deny(self):
1070
for action, value in self.actions.items():
1071
if action in {"remove", "deny"}:
1072
continue
1073
options = self.parser.parse_args()
1074
setattr(options, action, value)
1075
options.all = True
1076
options.remove = True
1077
with self.assertParseError():
1078
self.check_option_syntax(options)
1079
1080
1081
class Test_get_mandos_dbus_object(TestCaseWithAssertLogs):
1082
def test_calls_and_returns_get_object_on_bus(self):
1083
class MockBus(object):
1084
called = False
1085
def get_object(mockbus_self, busname, dbus_path):
1086
# Note that "self" is still the testcase instance,
1087
# this MockBus instance is in "mockbus_self".
1088
self.assertEqual(dbus_busname, busname)
1089
self.assertEqual(server_dbus_path, dbus_path)
1090
mockbus_self.called = True
1091
return mockbus_self
1092
1093
mockbus = get_mandos_dbus_object(bus=MockBus())
1094
self.assertIsInstance(mockbus, MockBus)
1095
self.assertTrue(mockbus.called)
1096
1097
def test_logs_and_exits_on_dbus_error(self):
1098
class MockBusFailing(object):
1099
def get_object(self, busname, dbus_path):
1100
raise dbus.exceptions.DBusException("Test")
1101
1102
with self.assertLogs(log, logging.CRITICAL):
1103
with self.assertRaises(SystemExit) as e:
1104
bus = get_mandos_dbus_object(bus=MockBusFailing())
1105
1106
if isinstance(e.exception.code, int):
1107
self.assertNotEqual(0, e.exception.code)
1108
else:
1109
self.assertIsNotNone(e.exception.code)
1110
1111
1112
class Test_get_managed_objects(TestCaseWithAssertLogs):
1113
def test_calls_and_returns_GetManagedObjects(self):
1114
managed_objects = {"/clients/foo": { "Name": "foo"}}
1115
class MockObjectManager(object):
1116
def GetManagedObjects(self):
1117
return managed_objects
1118
retval = get_managed_objects(MockObjectManager())
1119
self.assertDictEqual(managed_objects, retval)
1120
1121
def test_logs_and_exits_on_dbus_error(self):
1122
dbus_logger = logging.getLogger("dbus.proxies")
1123
1124
class MockObjectManagerFailing(object):
1125
def GetManagedObjects(self):
1126
dbus_logger.error("Test")
1127
raise dbus.exceptions.DBusException("Test")
1128
1129
class CountingHandler(logging.Handler):
1130
count = 0
1131
def emit(self, record):
1132
self.count += 1
1133
1134
counting_handler = CountingHandler()
1135
1136
dbus_logger.addHandler(counting_handler)
1137
1138
try:
1139
with self.assertLogs(log, logging.CRITICAL) as watcher:
1140
with self.assertRaises(SystemExit) as e:
1141
get_managed_objects(MockObjectManagerFailing())
1142
finally:
1143
dbus_logger.removeFilter(counting_handler)
1144
1145
# Make sure the dbus logger was suppressed
1146
self.assertEqual(0, counting_handler.count)
1147
1148
# Test that the dbus_logger still works
1149
with self.assertLogs(dbus_logger, logging.ERROR):
1150
dbus_logger.error("Test")
1151
1152
if isinstance(e.exception.code, int):
1153
self.assertNotEqual(0, e.exception.code)
1154
else:
1155
self.assertIsNotNone(e.exception.code)
1156
1157
1158
class Test_commands_from_options(unittest.TestCase):
1159
def setUp(self):
1160
self.parser = argparse.ArgumentParser()
1161
add_command_line_options(self.parser)
1162
1163
def test_is_enabled(self):
1164
self.assert_command_from_args(["--is-enabled", "foo"],
1165
command.IsEnabled)
1166
1167
def assert_command_from_args(self, args, command_cls,
1168
**cmd_attrs):
1169
"""Assert that parsing ARGS should result in an instance of
1170
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
1171
options = self.parser.parse_args(args)
1172
check_option_syntax(self.parser, options)
1173
commands = commands_from_options(options)
1174
self.assertEqual(1, len(commands))
1175
command = commands[0]
1176
self.assertIsInstance(command, command_cls)
1177
for key, value in cmd_attrs.items():
1178
self.assertEqual(value, getattr(command, key))
1179
1180
def test_is_enabled_short(self):
1181
self.assert_command_from_args(["-V", "foo"],
1182
command.IsEnabled)
1183
1184
def test_approve(self):
1185
self.assert_command_from_args(["--approve", "foo"],
1186
command.Approve)
1187
1188
def test_approve_short(self):
1189
self.assert_command_from_args(["-A", "foo"], command.Approve)
1190
1191
def test_deny(self):
1192
self.assert_command_from_args(["--deny", "foo"], command.Deny)
1193
1194
def test_deny_short(self):
1195
self.assert_command_from_args(["-D", "foo"], command.Deny)
1196
1197
def test_remove(self):
1198
self.assert_command_from_args(["--remove", "foo"],
1199
command.Remove)
1200
1201
def test_deny_before_remove(self):
1202
options = self.parser.parse_args(["--deny", "--remove",
1203
"foo"])
1204
check_option_syntax(self.parser, options)
1205
commands = commands_from_options(options)
1206
self.assertEqual(2, len(commands))
1207
self.assertIsInstance(commands[0], command.Deny)
1208
self.assertIsInstance(commands[1], command.Remove)
1209
1210
def test_deny_before_remove_reversed(self):
1211
options = self.parser.parse_args(["--remove", "--deny",
1212
"--all"])
1213
check_option_syntax(self.parser, options)
1214
commands = commands_from_options(options)
1215
self.assertEqual(2, len(commands))
1216
self.assertIsInstance(commands[0], command.Deny)
1217
self.assertIsInstance(commands[1], command.Remove)
1218
1219
def test_remove_short(self):
1220
self.assert_command_from_args(["-r", "foo"], command.Remove)
1221
1222
def test_dump_json(self):
1223
self.assert_command_from_args(["--dump-json"],
1224
command.DumpJSON)
1225
1226
def test_enable(self):
1227
self.assert_command_from_args(["--enable", "foo"],
1228
command.Enable)
1229
1230
def test_enable_short(self):
1231
self.assert_command_from_args(["-e", "foo"], command.Enable)
1232
1233
def test_disable(self):
1234
self.assert_command_from_args(["--disable", "foo"],
1235
command.Disable)
1236
1237
def test_disable_short(self):
1238
self.assert_command_from_args(["-d", "foo"], command.Disable)
1239
1240
def test_bump_timeout(self):
1241
self.assert_command_from_args(["--bump-timeout", "foo"],
1242
command.BumpTimeout)
1243
1244
def test_bump_timeout_short(self):
1245
self.assert_command_from_args(["-b", "foo"],
1246
command.BumpTimeout)
1247
1248
def test_start_checker(self):
1249
self.assert_command_from_args(["--start-checker", "foo"],
1250
command.StartChecker)
1251
1252
def test_stop_checker(self):
1253
self.assert_command_from_args(["--stop-checker", "foo"],
1254
command.StopChecker)
1255
1256
def test_approve_by_default(self):
1257
self.assert_command_from_args(["--approve-by-default", "foo"],
1258
command.ApproveByDefault)
1259
1260
def test_deny_by_default(self):
1261
self.assert_command_from_args(["--deny-by-default", "foo"],
1262
command.DenyByDefault)
1263
1264
def test_checker(self):
1265
self.assert_command_from_args(["--checker", ":", "foo"],
1266
command.SetChecker,
1267
value_to_set=":")
1268
1269
def test_checker_empty(self):
1270
self.assert_command_from_args(["--checker", "", "foo"],
1271
command.SetChecker,
1272
value_to_set="")
1273
1274
def test_checker_short(self):
1275
self.assert_command_from_args(["-c", ":", "foo"],
1276
command.SetChecker,
1277
value_to_set=":")
1278
1279
def test_host(self):
1280
self.assert_command_from_args(["--host", "foo.example.org",
1281
"foo"], command.SetHost,
1282
value_to_set="foo.example.org")
1283
1284
def test_host_short(self):
1285
self.assert_command_from_args(["-H", "foo.example.org",
1286
"foo"], command.SetHost,
1287
value_to_set="foo.example.org")
1288
1289
def test_secret_devnull(self):
1290
self.assert_command_from_args(["--secret", os.path.devnull,
1291
"foo"], command.SetSecret,
1292
value_to_set=b"")
1293
1294
def test_secret_tempfile(self):
1295
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1296
value = b"secret\0xyzzy\nbar"
1297
f.write(value)
1298
f.seek(0)
1299
self.assert_command_from_args(["--secret", f.name,
1300
"foo"], command.SetSecret,
1301
value_to_set=value)
1302
1303
def test_secret_devnull_short(self):
1304
self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1305
command.SetSecret,
1306
value_to_set=b"")
1307
1308
def test_secret_tempfile_short(self):
1309
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1310
value = b"secret\0xyzzy\nbar"
1311
f.write(value)
1312
f.seek(0)
1313
self.assert_command_from_args(["-s", f.name, "foo"],
1314
command.SetSecret,
1315
value_to_set=value)
1316
1317
def test_timeout(self):
1318
self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1319
command.SetTimeout,
1320
value_to_set=300000)
1321
1322
def test_timeout_short(self):
1323
self.assert_command_from_args(["-t", "PT5M", "foo"],
1324
command.SetTimeout,
1325
value_to_set=300000)
1326
1327
def test_extended_timeout(self):
1328
self.assert_command_from_args(["--extended-timeout", "PT15M",
1329
"foo"],
1330
command.SetExtendedTimeout,
1331
value_to_set=900000)
1332
1333
def test_interval(self):
1334
self.assert_command_from_args(["--interval", "PT2M", "foo"],
1335
command.SetInterval,
1336
value_to_set=120000)
1337
1338
def test_interval_short(self):
1339
self.assert_command_from_args(["-i", "PT2M", "foo"],
1340
command.SetInterval,
1341
value_to_set=120000)
1342
1343
def test_approval_delay(self):
1344
self.assert_command_from_args(["--approval-delay", "PT30S",
1345
"foo"],
1346
command.SetApprovalDelay,
1347
value_to_set=30000)
1348
1349
def test_approval_duration(self):
1350
self.assert_command_from_args(["--approval-duration", "PT1S",
1351
"foo"],
1352
command.SetApprovalDuration,
1353
value_to_set=1000)
1354
1355
def test_print_table(self):
1356
self.assert_command_from_args([], command.PrintTable,
1357
verbose=False)
1358
1359
def test_print_table_verbose(self):
1360
self.assert_command_from_args(["--verbose"],
1361
command.PrintTable,
1362
verbose=True)
1363
1364
def test_print_table_verbose_short(self):
1365
self.assert_command_from_args(["-v"], command.PrintTable,
1366
verbose=True)
1367
1368
1369
class TestCommand(unittest.TestCase):
775
1370
"""Abstract class for tests of command classes"""
1371
776
1372
def setUp(self):
777
1373
testcase = self
778
1374
class MockClient(object):
779
1375
def __init__(self, name, **attributes):
780
self.__dbus_object_path__ = "objpath_{}".format(name)
1376
self.__dbus_object_path__ = "/clients/{}".format(name)
781
1377
self.attributes = attributes
782
1378
self.attributes["Name"] = name
783
1379
self.calls = []
784
def Set(self, interface, property, value, dbus_interface):
785
testcase.assertEqual(interface, client_interface)
786
testcase.assertEqual(dbus_interface,
787
dbus.PROPERTIES_IFACE)
788
self.attributes[property] = value
789
self.calls.append(("Set", (interface, property, value,
790
dbus_interface)))
791
def Get(self, interface, property, dbus_interface):
792
testcase.assertEqual(interface, client_interface)
793
testcase.assertEqual(dbus_interface,
794
dbus.PROPERTIES_IFACE)
795
self.calls.append(("Get", (interface, property,
796
dbus_interface)))
797
return self.attributes[property]
1380
def Set(self, interface, propname, value, dbus_interface):
1381
testcase.assertEqual(client_dbus_interface, interface)
1382
testcase.assertEqual(dbus.PROPERTIES_IFACE,
1383
dbus_interface)
1384
self.attributes[propname] = value
798
1385
def Approve(self, approve, dbus_interface):
799
testcase.assertEqual(dbus_interface, client_interface)
1386
testcase.assertEqual(client_dbus_interface,
1387
dbus_interface)
800
1388
self.calls.append(("Approve", (approve,
801
1389
dbus_interface)))
802
1390
self.client = MockClient(
842
1430
ApprovedByDefault=dbus.Boolean(False),
843
1431
LastApprovalRequest="2019-01-03T00:00:00",
844
1432
ApprovalDelay=30000,
845
ApprovalDuration=1000,
1433
ApprovalDuration=93785000,
846
1434
Checker=":",
847
1435
ExtendedTimeout=900000,
848
1436
Expires="2019-02-05T00:00:00",
849
1437
LastCheckerStatus=-2)
850
1438
self.clients = collections.OrderedDict(
851
1439
[
852
(self.client, self.client.attributes),
853
(self.other_client, self.other_client.attributes),
1440
("/clients/foo", self.client.attributes),
1441
("/clients/barbar", self.other_client.attributes),
854
1442
])
855
self.one_client = {self.client: self.client.attributes}
856
857
class TestPrintTableCmd(TestCmd):
858
def test_normal(self):
859
output = PrintTableCmd().output(self.clients)
860
expected_output = """
861
Name Enabled Timeout Last Successful Check
862
foo Yes 00:05:00 2019-02-03T00:00:00
863
barbar Yes 00:05:00 2019-02-04T00:00:00
864
"""[1:-1]
865
self.assertEqual(output, expected_output)
866
def test_verbose(self):
867
output = PrintTableCmd(verbose=True).output(self.clients)
868
expected_output = """
869
Name Enabled Timeout Last Successful Check Created Interval Host Key ID Fingerprint Check Is Running Last Enabled Approval Is Pending Approved By Default Last Approval Request Approval Delay Approval Duration Checker Extended Timeout Expires Last Checker Status
870
foo Yes 00:05:00 2019-02-03T00:00:00 2019-01-02T00:00:00 00:02:00 foo.example.org 92ed150794387c03ce684574b1139a6594a34f895daaaf09fd8ea90a27cddb12 778827225BA7DE539C5A7CFA59CFF7CDBD9A5920 No 2019-01-03T00:00:00 No Yes 00:00:00 00:00:01 fping -q -- %(host)s 00:15:00 2019-02-04T00:00:00 0
871
barbar Yes 00:05:00 2019-02-04T00:00:00 2019-01-03T00:00:00 00:02:00 192.0.2.3 0558568eedd67d622f5c83b35a115f796ab612cff5ad227247e46c2b020f441c 3E393AEAEFB84C7E89E2F547B3A107558FCA3A27 Yes 2019-01-04T00:00:00 No No 2019-01-03T00:00:00 00:00:30 00:00:01 : 00:15:00 2019-02-05T00:00:00 -2
872
"""[1:-1]
873
self.assertEqual(output, expected_output)
874
def test_one_client(self):
875
output = PrintTableCmd().output(self.one_client)
876
expected_output = """
877
Name Enabled Timeout Last Successful Check
878
foo Yes 00:05:00 2019-02-03T00:00:00
879
"""[1:-1]
880
self.assertEqual(output, expected_output)
881
882
class TestDumpJSONCmd(TestCmd):
883
def setUp(self):
884
self.expected_json = {
885
"foo": {
886
"Name": "foo",
887
"KeyID": ("92ed150794387c03ce684574b1139a65"
888
"94a34f895daaaf09fd8ea90a27cddb12"),
889
"Host": "foo.example.org",
890
"Enabled": True,
891
"Timeout": 300000,
892
"LastCheckedOK": "2019-02-03T00:00:00",
893
"Created": "2019-01-02T00:00:00",
894
"Interval": 120000,
895
"Fingerprint": ("778827225BA7DE539C5A"
896
"7CFA59CFF7CDBD9A5920"),
897
"CheckerRunning": False,
898
"LastEnabled": "2019-01-03T00:00:00",
899
"ApprovalPending": False,
900
"ApprovedByDefault": True,
901
"LastApprovalRequest": "",
902
"ApprovalDelay": 0,
903
"ApprovalDuration": 1000,
904
"Checker": "fping -q -- %(host)s",
905
"ExtendedTimeout": 900000,
906
"Expires": "2019-02-04T00:00:00",
907
"LastCheckerStatus": 0,
908
},
909
"barbar": {
910
"Name": "barbar",
911
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
912
"6ab612cff5ad227247e46c2b020f441c"),
913
"Host": "192.0.2.3",
914
"Enabled": True,
915
"Timeout": 300000,
916
"LastCheckedOK": "2019-02-04T00:00:00",
917
"Created": "2019-01-03T00:00:00",
918
"Interval": 120000,
919
"Fingerprint": ("3E393AEAEFB84C7E89E2"
920
"F547B3A107558FCA3A27"),
921
"CheckerRunning": True,
922
"LastEnabled": "2019-01-04T00:00:00",
923
"ApprovalPending": False,
924
"ApprovedByDefault": False,
925
"LastApprovalRequest": "2019-01-03T00:00:00",
926
"ApprovalDelay": 30000,
927
"ApprovalDuration": 1000,
928
"Checker": ":",
929
"ExtendedTimeout": 900000,
930
"Expires": "2019-02-05T00:00:00",
931
"LastCheckerStatus": -2,
932
},
933
}
934
return super(TestDumpJSONCmd, self).setUp()
935
def test_normal(self):
936
json_data = json.loads(DumpJSONCmd().output(self.clients))
937
self.assertDictEqual(json_data, self.expected_json)
938
def test_one_client(self):
939
clients = self.one_client
940
json_data = json.loads(DumpJSONCmd().output(clients))
941
expected_json = {"foo": self.expected_json["foo"]}
942
self.assertDictEqual(json_data, expected_json)
943
944
class TestIsEnabledCmd(TestCmd):
945
def test_is_enabled(self):
946
self.assertTrue(all(IsEnabledCmd().is_enabled(client, properties)
947
for client, properties in self.clients.items()))
948
def test_is_enabled_run_exits_successfully(self):
1443
self.one_client = {"/clients/foo": self.client.attributes}
1444
1445
@property
1446
def bus(self):
1447
class Bus(object):
1448
@staticmethod
1449
def get_object(client_bus_name, path):
1450
self.assertEqual(dbus_busname, client_bus_name)
1451
return {
1452
# Note: "self" here is the TestCmd instance, not
1453
# the Bus instance, since this is a static method!
1454
"/clients/foo": self.client,
1455
"/clients/barbar": self.other_client,
1456
}[path]
1457
return Bus()
1458
1459
1460
class TestBaseCommands(TestCommand):
1461
1462
def test_IsEnabled_exits_successfully(self):
949
1463
with self.assertRaises(SystemExit) as e:
950
IsEnabledCmd().run(None, self.one_client)
1464
command.IsEnabled().run(self.one_client)
951
1465
if e.exception.code is not None:
952
self.assertEqual(e.exception.code, 0)
1466
self.assertEqual(0, e.exception.code)
953
1467
else:
954
1468
self.assertIsNone(e.exception.code)
955
def test_is_enabled_run_exits_with_failure(self):
1469
1470
def test_IsEnabled_exits_with_failure(self):
956
1471
self.client.attributes["Enabled"] = dbus.Boolean(False)
957
1472
with self.assertRaises(SystemExit) as e:
958
IsEnabledCmd().run(None, self.one_client)
1473
command.IsEnabled().run(self.one_client)
959
1474
if isinstance(e.exception.code, int):
960
self.assertNotEqual(e.exception.code, 0)
1475
self.assertNotEqual(0, e.exception.code)
961
1476
else:
962
1477
self.assertIsNotNone(e.exception.code)
963
1478
964
class TestRemoveCmd(TestCmd):
965
def test_remove(self):
1479
def test_Approve(self):
1480
command.Approve().run(self.clients, self.bus)
1481
for clientpath in self.clients:
1482
client = self.bus.get_object(dbus_busname, clientpath)
1483
self.assertIn(("Approve", (True, client_dbus_interface)),
1484
client.calls)
1485
1486
def test_Deny(self):
1487
command.Deny().run(self.clients, self.bus)
1488
for clientpath in self.clients:
1489
client = self.bus.get_object(dbus_busname, clientpath)
1490
self.assertIn(("Approve", (False, client_dbus_interface)),
1491
client.calls)
1492
1493
def test_Remove(self):
966
1494
class MockMandos(object):
967
1495
def __init__(self):
968
1496
self.calls = []
969
1497
def RemoveClient(self, dbus_path):
970
1498
self.calls.append(("RemoveClient", (dbus_path,)))
971
1499
mandos = MockMandos()
972
super(TestRemoveCmd, self).setUp()
973
RemoveCmd().run(mandos, self.clients)
974
self.assertEqual(len(mandos.calls), 2)
975
for client in self.clients:
976
self.assertIn(("RemoveClient",
977
(client.__dbus_object_path__,)),
1500
command.Remove().run(self.clients, self.bus, mandos)
1501
for clientpath in self.clients:
1502
self.assertIn(("RemoveClient", (clientpath,)),
978
1503
mandos.calls)
979
1504
980
class TestApproveCmd(TestCmd):
981
def test_approve(self):
982
ApproveCmd().run(None, self.clients)
983
for client in self.clients:
984
self.assertIn(("Approve", (True, client_interface)),
985
client.calls)
986
987
class TestDenyCmd(TestCmd):
988
def test_deny(self):
989
DenyCmd().run(None, self.clients)
990
for client in self.clients:
991
self.assertIn(("Approve", (False, client_interface)),
992
client.calls)
993
994
class TestEnableCmd(TestCmd):
995
def test_enable(self):
996
for client in self.clients:
997
client.attributes["Enabled"] = False
998
999
EnableCmd().run(None, self.clients)
1000
1001
for client in self.clients:
1002
self.assertTrue(client.attributes["Enabled"])
1003
1004
class TestDisableCmd(TestCmd):
1005
def test_disable(self):
1006
DisableCmd().run(None, self.clients)
1007
1008
for client in self.clients:
1009
self.assertFalse(client.attributes["Enabled"])
1505
expected_json = {
1506
"foo": {
1507
"Name": "foo",
1508
"KeyID": ("92ed150794387c03ce684574b1139a65"
1509
"94a34f895daaaf09fd8ea90a27cddb12"),
1510
"Host": "foo.example.org",
1511
"Enabled": True,
1512
"Timeout": 300000,
1513
"LastCheckedOK": "2019-02-03T00:00:00",
1514
"Created": "2019-01-02T00:00:00",
1515
"Interval": 120000,
1516
"Fingerprint": ("778827225BA7DE539C5A"
1517
"7CFA59CFF7CDBD9A5920"),
1518
"CheckerRunning": False,
1519
"LastEnabled": "2019-01-03T00:00:00",
1520
"ApprovalPending": False,
1521
"ApprovedByDefault": True,
1522
"LastApprovalRequest": "",
1523
"ApprovalDelay": 0,
1524
"ApprovalDuration": 1000,
1525
"Checker": "fping -q -- %(host)s",
1526
"ExtendedTimeout": 900000,
1527
"Expires": "2019-02-04T00:00:00",
1528
"LastCheckerStatus": 0,
1529
},
1530
"barbar": {
1531
"Name": "barbar",
1532
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
1533
"6ab612cff5ad227247e46c2b020f441c"),
1534
"Host": "192.0.2.3",
1535
"Enabled": True,
1536
"Timeout": 300000,
1537
"LastCheckedOK": "2019-02-04T00:00:00",
1538
"Created": "2019-01-03T00:00:00",
1539
"Interval": 120000,
1540
"Fingerprint": ("3E393AEAEFB84C7E89E2"
1541
"F547B3A107558FCA3A27"),
1542
"CheckerRunning": True,
1543
"LastEnabled": "2019-01-04T00:00:00",
1544
"ApprovalPending": False,
1545
"ApprovedByDefault": False,
1546
"LastApprovalRequest": "2019-01-03T00:00:00",
1547
"ApprovalDelay": 30000,
1548
"ApprovalDuration": 93785000,
1549
"Checker": ":",
1550
"ExtendedTimeout": 900000,
1551
"Expires": "2019-02-05T00:00:00",
1552
"LastCheckerStatus": -2,
1553
},
1554
}
1555
1556
def test_DumpJSON_normal(self):
1557
with self.capture_stdout_to_buffer() as buffer:
1558
command.DumpJSON().run(self.clients)
1559
json_data = json.loads(buffer.getvalue())
1560
self.assertDictEqual(self.expected_json, json_data)
1561
1562
@staticmethod
1563
@contextlib.contextmanager
1564
def capture_stdout_to_buffer():
1565
capture_buffer = io.StringIO()
1566
old_stdout = sys.stdout
1567
sys.stdout = capture_buffer
1568
try:
1569
yield capture_buffer
1570
finally:
1571
sys.stdout = old_stdout
1572
1573
def test_DumpJSON_one_client(self):
1574
with self.capture_stdout_to_buffer() as buffer:
1575
command.DumpJSON().run(self.one_client)
1576
json_data = json.loads(buffer.getvalue())
1577
expected_json = {"foo": self.expected_json["foo"]}
1578
self.assertDictEqual(expected_json, json_data)
1579
1580
def test_PrintTable_normal(self):
1581
with self.capture_stdout_to_buffer() as buffer:
1582
command.PrintTable().run(self.clients)
1583
expected_output = "\n".join((
1584
"Name Enabled Timeout Last Successful Check",
1585
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1586
"barbar Yes 00:05:00 2019-02-04T00:00:00 ",
1587
)) + "\n"
1588
self.assertEqual(expected_output, buffer.getvalue())
1589
1590
def test_PrintTable_verbose(self):
1591
with self.capture_stdout_to_buffer() as buffer:
1592
command.PrintTable(verbose=True).run(self.clients)
1593
columns = (
1594
(
1595
"Name ",
1596
"foo ",
1597
"barbar ",
1598
),(
1599
"Enabled ",
1600
"Yes ",
1601
"Yes ",
1602
),(
1603
"Timeout ",
1604
"00:05:00 ",
1605
"00:05:00 ",
1606
),(
1607
"Last Successful Check ",
1608
"2019-02-03T00:00:00 ",
1609
"2019-02-04T00:00:00 ",
1610
),(
1611
"Created ",
1612
"2019-01-02T00:00:00 ",
1613
"2019-01-03T00:00:00 ",
1614
),(
1615
"Interval ",
1616
"00:02:00 ",
1617
"00:02:00 ",
1618
),(
1619
"Host ",
1620
"foo.example.org ",
1621
"192.0.2.3 ",
1622
),(
1623
("Key ID "
1624
" "),
1625
("92ed150794387c03ce684574b1139a6594a34f895daaaf09fd8"
1626
"ea90a27cddb12 "),
1627
("0558568eedd67d622f5c83b35a115f796ab612cff5ad227247e"
1628
"46c2b020f441c "),
1629
),(
1630
"Fingerprint ",
1631
"778827225BA7DE539C5A7CFA59CFF7CDBD9A5920 ",
1632
"3E393AEAEFB84C7E89E2F547B3A107558FCA3A27 ",
1633
),(
1634
"Check Is Running ",
1635
"No ",
1636
"Yes ",
1637
),(
1638
"Last Enabled ",
1639
"2019-01-03T00:00:00 ",
1640
"2019-01-04T00:00:00 ",
1641
),(
1642
"Approval Is Pending ",
1643
"No ",
1644
"No ",
1645
),(
1646
"Approved By Default ",
1647
"Yes ",
1648
"No ",
1649
),(
1650
"Last Approval Request ",
1651
" ",
1652
"2019-01-03T00:00:00 ",
1653
),(
1654
"Approval Delay ",
1655
"00:00:00 ",
1656
"00:00:30 ",
1657
),(
1658
"Approval Duration ",
1659
"00:00:01 ",
1660
"1T02:03:05 ",
1661
),(
1662
"Checker ",
1663
"fping -q -- %(host)s ",
1664
": ",
1665
),(
1666
"Extended Timeout ",
1667
"00:15:00 ",
1668
"00:15:00 ",
1669
),(
1670
"Expires ",
1671
"2019-02-04T00:00:00 ",
1672
"2019-02-05T00:00:00 ",
1673
),(
1674
"Last Checker Status",
1675
"0 ",
1676
"-2 ",
1677
)
1678
)
1679
num_lines = max(len(rows) for rows in columns)
1680
expected_output = ("\n".join("".join(rows[line]
1681
for rows in columns)
1682
for line in range(num_lines))
1683
+ "\n")
1684
self.assertEqual(expected_output, buffer.getvalue())
1685
1686
def test_PrintTable_one_client(self):
1687
with self.capture_stdout_to_buffer() as buffer:
1688
command.PrintTable().run(self.one_client)
1689
expected_output = "\n".join((
1690
"Name Enabled Timeout Last Successful Check",
1691
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1692
)) + "\n"
1693
self.assertEqual(expected_output, buffer.getvalue())
1694
1695
1696
class TestPropertyCmd(TestCommand):
1697
"""Abstract class for tests of command.Property classes"""
1698
def runTest(self):
1699
if not hasattr(self, "command"):
1700
return
1701
values_to_get = getattr(self, "values_to_get",
1702
self.values_to_set)
1703
for value_to_set, value_to_get in zip(self.values_to_set,
1704
values_to_get):
1705
for clientpath in self.clients:
1706
client = self.bus.get_object(dbus_busname, clientpath)
1707
old_value = client.attributes[self.propname]
1708
client.attributes[self.propname] = self.Unique()
1709
self.run_command(value_to_set, self.clients)
1710
for clientpath in self.clients:
1711
client = self.bus.get_object(dbus_busname, clientpath)
1712
value = client.attributes[self.propname]
1713
self.assertNotIsInstance(value, self.Unique)
1714
self.assertEqual(value_to_get, value)
1715
1716
class Unique(object):
1717
"""Class for objects which exist only to be unique objects,
1718
since unittest.mock.sentinel only exists in Python 3.3"""
1719
1720
def run_command(self, value, clients):
1721
self.command().run(clients, self.bus)
1722
1723
1724
class TestEnableCmd(TestPropertyCmd):
1725
command = command.Enable
1726
propname = "Enabled"
1727
values_to_set = [dbus.Boolean(True)]
1728
1729
1730
class TestDisableCmd(TestPropertyCmd):
1731
command = command.Disable
1732
propname = "Enabled"
1733
values_to_set = [dbus.Boolean(False)]
1734
1735
1736
class TestBumpTimeoutCmd(TestPropertyCmd):
1737
command = command.BumpTimeout
1738
propname = "LastCheckedOK"
1739
values_to_set = [""]
1740
1741
1742
class TestStartCheckerCmd(TestPropertyCmd):
1743
command = command.StartChecker
1744
propname = "CheckerRunning"
1745
values_to_set = [dbus.Boolean(True)]
1746
1747
1748
class TestStopCheckerCmd(TestPropertyCmd):
1749
command = command.StopChecker
1750
propname = "CheckerRunning"
1751
values_to_set = [dbus.Boolean(False)]
1752
1753
1754
class TestApproveByDefaultCmd(TestPropertyCmd):
1755
command = command.ApproveByDefault
1756
propname = "ApprovedByDefault"
1757
values_to_set = [dbus.Boolean(True)]
1758
1759
1760
class TestDenyByDefaultCmd(TestPropertyCmd):
1761
command = command.DenyByDefault
1762
propname = "ApprovedByDefault"
1763
values_to_set = [dbus.Boolean(False)]
1764
1765
1766
class TestPropertyValueCmd(TestPropertyCmd):
1767
"""Abstract class for tests of PropertyValueCmd classes"""
1768
1769
def runTest(self):
1770
if type(self) is TestPropertyValueCmd:
1771
return
1772
return super(TestPropertyValueCmd, self).runTest()
1773
1774
def run_command(self, value, clients):
1775
self.command(value).run(clients, self.bus)
1776
1777
1778
class TestSetCheckerCmd(TestPropertyValueCmd):
1779
command = command.SetChecker
1780
propname = "Checker"
1781
values_to_set = ["", ":", "fping -q -- %s"]
1782
1783
1784
class TestSetHostCmd(TestPropertyValueCmd):
1785
command = command.SetHost
1786
propname = "Host"
1787
values_to_set = ["192.0.2.3", "foo.example.org"]
1788
1789
1790
class TestSetSecretCmd(TestPropertyValueCmd):
1791
command = command.SetSecret
1792
propname = "Secret"
1793
values_to_set = [io.BytesIO(b""),
1794
io.BytesIO(b"secret\0xyzzy\nbar")]
1795
values_to_get = [b"", b"secret\0xyzzy\nbar"]
1796
1797
1798
class TestSetTimeoutCmd(TestPropertyValueCmd):
1799
command = command.SetTimeout
1800
propname = "Timeout"
1801
values_to_set = [datetime.timedelta(),
1802
datetime.timedelta(minutes=5),
1803
datetime.timedelta(seconds=1),
1804
datetime.timedelta(weeks=1),
1805
datetime.timedelta(weeks=52)]
1806
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1807
1808
1809
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
1810
command = command.SetExtendedTimeout
1811
propname = "ExtendedTimeout"
1812
values_to_set = [datetime.timedelta(),
1813
datetime.timedelta(minutes=5),
1814
datetime.timedelta(seconds=1),
1815
datetime.timedelta(weeks=1),
1816
datetime.timedelta(weeks=52)]
1817
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1818
1819
1820
class TestSetIntervalCmd(TestPropertyValueCmd):
1821
command = command.SetInterval
1822
propname = "Interval"
1823
values_to_set = [datetime.timedelta(),
1824
datetime.timedelta(minutes=5),
1825
datetime.timedelta(seconds=1),
1826
datetime.timedelta(weeks=1),
1827
datetime.timedelta(weeks=52)]
1828
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1829
1830
1831
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
1832
command = command.SetApprovalDelay
1833
propname = "ApprovalDelay"
1834
values_to_set = [datetime.timedelta(),
1835
datetime.timedelta(minutes=5),
1836
datetime.timedelta(seconds=1),
1837
datetime.timedelta(weeks=1),
1838
datetime.timedelta(weeks=52)]
1839
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1840
1841
1842
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
1843
command = command.SetApprovalDuration
1844
propname = "ApprovalDuration"
1845
values_to_set = [datetime.timedelta(),
1846
datetime.timedelta(minutes=5),
1847
datetime.timedelta(seconds=1),
1848
datetime.timedelta(weeks=1),
1849
datetime.timedelta(weeks=52)]
1850
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1010
1851
1011
1852
1012
1853
1027
1868
return tests
1028
1869
1029
1870
if __name__ == "__main__":
1030
if should_only_run_tests():
1031
# Call using ./tdd-python-script --check [--verbose]
1032
unittest.main()
1033
else:
1034
main()
1871
try:
1872
if should_only_run_tests():
1873
# Call using ./tdd-python-script --check [--verbose]
1874
unittest.main()
1875
else:
1876
main()
1877
finally:
1878
logging.shutdown()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0