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