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