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