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
44
44
import logging
45
45
import io
46
46
import tempfile
47
import contextlib
47
48
48
49
import dbus
49
50
63
64
64
65
locale.setlocale(locale.LC_ALL, "")
65
66
66
domain = "se.recompile"
67
busname = domain + ".Mandos"
68
server_path = "/"
69
server_interface = domain + ".Mandos"
70
client_interface = domain + ".Mandos.Client"
67
dbus_busname_domain = "se.recompile"
68
dbus_busname = dbus_busname_domain + ".Mandos"
69
server_dbus_path = "/"
70
server_dbus_interface = dbus_busname_domain + ".Mandos"
71
client_dbus_interface = dbus_busname_domain + ".Mandos.Client"
72
del dbus_busname_domain
71
73
version = "1.8.3"
72
74
73
75
77
79
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
78
80
79
81
80
def milliseconds_to_string(ms):
81
td = datetime.timedelta(0, 0, 0, ms)
82
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
83
.format(days="{}T".format(td.days) if td.days else "",
84
hours=td.seconds // 3600,
85
minutes=(td.seconds % 3600) // 60,
86
seconds=td.seconds % 60))
82
def main():
83
parser = argparse.ArgumentParser()
84
85
add_command_line_options(parser)
86
87
options = parser.parse_args()
88
89
check_option_syntax(parser, options)
90
91
clientnames = options.client
92
93
if options.debug:
94
log.setLevel(logging.DEBUG)
95
96
bus = dbus.SystemBus()
97
98
mandos_dbus_object = get_mandos_dbus_object(bus)
99
100
mandos_serv = dbus.Interface(
101
mandos_dbus_object, dbus_interface=server_dbus_interface)
102
mandos_serv_object_manager = dbus.Interface(
103
mandos_dbus_object, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
104
105
managed_objects = get_managed_objects(mandos_serv_object_manager)
106
107
all_clients = {}
108
for path, ifs_and_props in managed_objects.items():
109
try:
110
all_clients[path] = ifs_and_props[client_dbus_interface]
111
except KeyError:
112
pass
113
114
# Compile dict of (clientpath: properties) to process
115
if not clientnames:
116
clients = all_clients
117
else:
118
clients = {}
119
for name in clientnames:
120
for objpath, properties in all_clients.items():
121
if properties["Name"] == name:
122
clients[objpath] = properties
123
break
124
else:
125
log.critical("Client not found on server: %r", name)
126
sys.exit(1)
127
128
# 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)
87
210
88
211
89
212
def rfc3339_duration_to_delta(duration):
216
339
return value
217
340
218
341
219
def string_to_delta(interval):
220
"""Parse a string and return a datetime.timedelta"""
221
222
try:
223
return rfc3339_duration_to_delta(interval)
224
except ValueError as e:
225
log.warning("%s - Parsing as pre-1.6.1 interval instead",
226
' '.join(e.args))
227
return parse_pre_1_6_1_interval(interval)
228
229
230
342
def parse_pre_1_6_1_interval(interval):
231
343
"""Parse an interval string as documented by Mandos before 1.6.1,
232
344
and return a datetime.timedelta
270
382
return value
271
383
272
384
273
## Classes for commands.
274
275
# Abstract classes first
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
276
546
class Command(object):
277
547
"""Abstract class for commands"""
278
def run(self, mandos, clients):
548
def run(self, clients, bus=None, mandos=None):
279
549
"""Normal commands should implement run_on_one_client(), but
280
550
commands which want to operate on all clients at the same time
281
551
can override this run() method instead."""
282
552
self.mandos = mandos
283
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)
284
557
self.run_on_one_client(client, properties)
285
558
286
class PrintCmd(Command):
287
"""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"""
288
596
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
289
597
"Created", "Interval", "Host", "KeyID",
290
598
"Fingerprint", "CheckerRunning", "LastEnabled",
292
600
"LastApprovalRequest", "ApprovalDelay",
293
601
"ApprovalDuration", "Checker", "ExtendedTimeout",
294
602
"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):
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):
324
627
def __init__(self, verbose=False):
325
628
self.verbose = verbose
326
629
327
630
def output(self, clients):
328
default_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
631
default_keywords = ("Name", "Enabled", "Timeout",
632
"LastCheckedOK")
329
633
keywords = default_keywords
330
634
if self.verbose:
331
635
keywords = self.all_keywords
332
return str(self.TableOfClients(clients.values(), keywords))
636
return str(self.TableOfClients(clients, keywords))
333
637
334
638
class TableOfClients(object):
335
639
tableheaders = {
355
659
"LastCheckerStatus": "Last Checker Status",
356
660
}
357
661
358
def __init__(self, clients, keywords, tableheaders=None):
662
def __init__(self, clients, keywords):
359
663
self.clients = clients
360
664
self.keywords = keywords
361
if tableheaders is not None:
362
self.tableheaders = tableheaders
363
665
364
666
def __str__(self):
365
667
return "\n".join(self.rows())
388
690
def string_from_client(self, client, key):
389
691
return self.valuetostring(client[key], key)
390
692
391
@staticmethod
392
def valuetostring(value, keyword):
693
@classmethod
694
def valuetostring(cls, value, keyword):
393
695
if isinstance(value, dbus.Boolean):
394
696
return "Yes" if value else "No"
395
697
if keyword in ("Timeout", "Interval", "ApprovalDelay",
396
698
"ApprovalDuration", "ExtendedTimeout"):
397
return milliseconds_to_string(value)
699
return cls.milliseconds_to_string(value)
398
700
return str(value)
399
701
400
702
def header_line(self, format_string):
405
707
**{key: self.string_from_client(client, key)
406
708
for key in self.keywords})
407
709
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)
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
444
740
445
741
class EnableCmd(PropertyCmd):
446
property = "Enabled"
742
propname = "Enabled"
447
743
value_to_set = dbus.Boolean(True)
448
744
745
449
746
class DisableCmd(PropertyCmd):
450
property = "Enabled"
747
propname = "Enabled"
451
748
value_to_set = dbus.Boolean(False)
452
749
750
453
751
class BumpTimeoutCmd(PropertyCmd):
454
property = "LastCheckedOK"
752
propname = "LastCheckedOK"
455
753
value_to_set = ""
456
754
755
457
756
class StartCheckerCmd(PropertyCmd):
458
property = "CheckerRunning"
757
propname = "CheckerRunning"
459
758
value_to_set = dbus.Boolean(True)
460
759
760
461
761
class StopCheckerCmd(PropertyCmd):
462
property = "CheckerRunning"
762
propname = "CheckerRunning"
463
763
value_to_set = dbus.Boolean(False)
464
764
765
465
766
class ApproveByDefaultCmd(PropertyCmd):
466
property = "ApprovedByDefault"
767
propname = "ApprovedByDefault"
467
768
value_to_set = dbus.Boolean(True)
468
769
770
469
771
class DenyByDefaultCmd(PropertyCmd):
470
property = "ApprovedByDefault"
772
propname = "ApprovedByDefault"
471
773
value_to_set = dbus.Boolean(False)
472
774
473
class SetCheckerCmd(PropertyCmd, ValueArgumentMixIn):
474
property = "Checker"
475
476
class SetHostCmd(PropertyCmd, ValueArgumentMixIn):
477
property = "Host"
478
479
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
480
793
@property
481
794
def value_to_set(self):
482
795
return self._vts
796
483
797
@value_to_set.setter
484
798
def value_to_set(self, value):
485
799
"""When setting, read data from supplied file object"""
486
800
self._vts = value.read()
487
801
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()
653
654
def has_actions(options):
655
return any((options.enable,
656
options.disable,
657
options.bump_timeout,
658
options.start_checker,
659
options.stop_checker,
660
options.is_enabled,
661
options.remove,
662
options.checker is not None,
663
options.timeout is not None,
664
options.extended_timeout is not None,
665
options.interval is not None,
666
options.approved_by_default is not None,
667
options.approval_delay is not None,
668
options.approval_duration is not None,
669
options.host is not None,
670
options.secret is not None,
671
options.approve,
672
options.deny))
673
674
if has_actions(options) and not (options.client or options.all):
675
parser.error("Options require clients names or --all.")
676
if options.verbose and has_actions(options):
677
parser.error("--verbose can only be used alone.")
678
if options.dump_json and (options.verbose
679
or has_actions(options)):
680
parser.error("--dump-json can only be used alone.")
681
if options.all and not has_actions(options):
682
parser.error("--all requires an action.")
683
if options.is_enabled and len(options.client) > 1:
684
parser.error("--is-enabled requires exactly one client")
685
686
clientnames = options.client
687
688
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")
693
sys.exit(1)
694
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")
702
class NullFilter(logging.Filter):
703
def filter(self, record):
704
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)
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
742
837
743
838
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
839
class Test_string_to_delta(unittest.TestCase):
758
840
def test_handles_basic_rfc3339(self):
759
841
self.assertEqual(string_to_delta("PT0S"),
764
846
datetime.timedelta(0, 1))
765
847
self.assertEqual(string_to_delta("PT2H"),
766
848
datetime.timedelta(0, 7200))
849
767
850
def test_falls_back_to_pre_1_6_1_with_warning(self):
768
851
# assertLogs only exists in Python 3.4
769
852
if hasattr(self, "assertLogs"):
787
870
self.assertEqual(value, datetime.timedelta(0, 7200))
788
871
789
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
790
1325
class TestCmd(unittest.TestCase):
791
1326
"""Abstract class for tests of command classes"""
1327
792
1328
def setUp(self):
793
1329
testcase = self
794
1330
class MockClient(object):
795
1331
def __init__(self, name, **attributes):
796
self.__dbus_object_path__ = "objpath_{}".format(name)
1332
self.__dbus_object_path__ = "/clients/{}".format(name)
797
1333
self.attributes = attributes
798
1334
self.attributes["Name"] = name
799
1335
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]
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]
810
1346
def Approve(self, approve, dbus_interface):
811
testcase.assertEqual(dbus_interface, client_interface)
1347
testcase.assertEqual(dbus_interface,
1348
client_dbus_interface)
812
1349
self.calls.append(("Approve", (approve,
813
1350
dbus_interface)))
814
1351
self.client = MockClient(
854
1391
ApprovedByDefault=dbus.Boolean(False),
855
1392
LastApprovalRequest="2019-01-03T00:00:00",
856
1393
ApprovalDelay=30000,
857
ApprovalDuration=1000,
1394
ApprovalDuration=93785000,
858
1395
Checker=":",
859
1396
ExtendedTimeout=900000,
860
1397
Expires="2019-02-05T00:00:00",
861
1398
LastCheckerStatus=-2)
862
1399
self.clients = collections.OrderedDict(
863
1400
[
864
(self.client, self.client.attributes),
865
(self.other_client, self.other_client.attributes),
1401
("/clients/foo", self.client.attributes),
1402
("/clients/barbar", self.other_client.attributes),
866
1403
])
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)
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
893
1479
894
1480
class TestDumpJSONCmd(TestCmd):
895
1481
def setUp(self):
936
1522
"ApprovedByDefault": False,
937
1523
"LastApprovalRequest": "2019-01-03T00:00:00",
938
1524
"ApprovalDelay": 30000,
939
"ApprovalDuration": 1000,
1525
"ApprovalDuration": 93785000,
940
1526
"Checker": ":",
941
1527
"ExtendedTimeout": 900000,
942
1528
"Expires": "2019-02-05T00:00:00",
944
1530
},
945
1531
}
946
1532
return super(TestDumpJSONCmd, self).setUp()
1533
947
1534
def test_normal(self):
948
json_data = json.loads(DumpJSONCmd().output(self.clients))
1535
output = DumpJSONCmd().output(self.clients.values())
1536
json_data = json.loads(output)
949
1537
self.assertDictEqual(json_data, self.expected_json)
1538
950
1539
def test_one_client(self):
951
clients = self.one_client
952
json_data = json.loads(DumpJSONCmd().output(clients))
1540
output = DumpJSONCmd().output(self.one_client.values())
1541
json_data = json.loads(output)
953
1542
expected_json = {"foo": self.expected_json["foo"]}
954
1543
self.assertDictEqual(json_data, expected_json)
955
1544
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):
961
with self.assertRaises(SystemExit) as e:
962
IsEnabledCmd().run(None, self.one_client)
963
if e.exception.code is not None:
964
self.assertEqual(e.exception.code, 0)
965
else:
966
self.assertIsNone(e.exception.code)
967
def test_is_enabled_run_exits_with_failure(self):
968
self.client.attributes["Enabled"] = dbus.Boolean(False)
969
with self.assertRaises(SystemExit) as e:
970
IsEnabledCmd().run(None, self.one_client)
971
if isinstance(e.exception.code, int):
972
self.assertNotEqual(e.exception.code, 0)
973
else:
974
self.assertIsNotNone(e.exception.code)
975
976
class TestRemoveCmd(TestCmd):
977
def test_remove(self):
978
class MockMandos(object):
979
def __init__(self):
980
self.calls = []
981
def RemoveClient(self, dbus_path):
982
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__,)),
990
mandos.calls)
991
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"""
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
1026
1659
1027
1660
class TestPropertyCmd(TestCmd):
1028
1661
"""Abstract class for tests of PropertyCmd classes"""
1033
1666
self.values_to_set)
1034
1667
for value_to_set, value_to_get in zip(self.values_to_set,
1035
1668
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()
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()
1040
1674
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)
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)
1044
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
1045
1685
def run_command(self, value, clients):
1046
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
1047
1700
1048
1701
class TestBumpTimeoutCmd(TestPropertyCmd):
1049
1702
command = BumpTimeoutCmd
1050
property = "LastCheckedOK"
1703
propname = "LastCheckedOK"
1051
1704
values_to_set = [""]
1052
1705
1706
1053
1707
class TestStartCheckerCmd(TestPropertyCmd):
1054
1708
command = StartCheckerCmd
1055
property = "CheckerRunning"
1709
propname = "CheckerRunning"
1056
1710
values_to_set = [dbus.Boolean(True)]
1057
1711
1712
1058
1713
class TestStopCheckerCmd(TestPropertyCmd):
1059
1714
command = StopCheckerCmd
1060
property = "CheckerRunning"
1715
propname = "CheckerRunning"
1061
1716
values_to_set = [dbus.Boolean(False)]
1062
1717
1718
1063
1719
class TestApproveByDefaultCmd(TestPropertyCmd):
1064
1720
command = ApproveByDefaultCmd
1065
property = "ApprovedByDefault"
1721
propname = "ApprovedByDefault"
1066
1722
values_to_set = [dbus.Boolean(True)]
1067
1723
1724
1068
1725
class TestDenyByDefaultCmd(TestPropertyCmd):
1069
1726
command = DenyByDefaultCmd
1070
property = "ApprovedByDefault"
1727
propname = "ApprovedByDefault"
1071
1728
values_to_set = [dbus.Boolean(False)]
1072
1729
1073
class TestValueArgumentPropertyCmd(TestPropertyCmd):
1074
"""Abstract class for tests of PropertyCmd classes using the
1075
ValueArgumentMixIn"""
1730
1731
class TestPropertyValueCmd(TestPropertyCmd):
1732
"""Abstract class for tests of PropertyValueCmd classes"""
1733
1076
1734
def runTest(self):
1077
if type(self) is TestValueArgumentPropertyCmd:
1735
if type(self) is TestPropertyValueCmd:
1078
1736
return
1079
return super(TestValueArgumentPropertyCmd, self).runTest()
1737
return super(TestPropertyValueCmd, self).runTest()
1738
1080
1739
def run_command(self, value, clients):
1081
self.command(value).run(None, clients)
1082
1083
class TestSetCheckerCmd(TestValueArgumentPropertyCmd):
1740
self.command(value).run(clients, self.bus)
1741
1742
1743
class TestSetCheckerCmd(TestPropertyValueCmd):
1084
1744
command = SetCheckerCmd
1085
property = "Checker"
1745
propname = "Checker"
1086
1746
values_to_set = ["", ":", "fping -q -- %s"]
1087
1747
1088
class TestSetHostCmd(TestValueArgumentPropertyCmd):
1748
1749
class TestSetHostCmd(TestPropertyValueCmd):
1089
1750
command = SetHostCmd
1090
property = "Host"
1751
propname = "Host"
1091
1752
values_to_set = ["192.0.2.3", "foo.example.org"]
1092
1753
1093
class TestSetSecretCmd(TestValueArgumentPropertyCmd):
1754
1755
class TestSetSecretCmd(TestPropertyValueCmd):
1094
1756
command = SetSecretCmd
1095
property = "Secret"
1096
values_to_set = [open("/dev/null", "rb"),
1757
propname = "Secret"
1758
values_to_set = [io.BytesIO(b""),
1097
1759
io.BytesIO(b"secret\0xyzzy\nbar")]
1098
1760
values_to_get = [b"", b"secret\0xyzzy\nbar"]
1099
1761
1100
class TestSetTimeoutCmd(TestValueArgumentPropertyCmd):
1762
1763
class TestSetTimeoutCmd(TestPropertyValueCmd):
1101
1764
command = SetTimeoutCmd
1102
property = "Timeout"
1765
propname = "Timeout"
1103
1766
values_to_set = [datetime.timedelta(),
1104
1767
datetime.timedelta(minutes=5),
1105
1768
datetime.timedelta(seconds=1),
1107
1770
datetime.timedelta(weeks=52)]
1108
1771
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1109
1772
1110
class TestSetExtendedTimeoutCmd(TestValueArgumentPropertyCmd):
1773
1774
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
1111
1775
command = SetExtendedTimeoutCmd
1112
property = "ExtendedTimeout"
1776
propname = "ExtendedTimeout"
1113
1777
values_to_set = [datetime.timedelta(),
1114
1778
datetime.timedelta(minutes=5),
1115
1779
datetime.timedelta(seconds=1),
1117
1781
datetime.timedelta(weeks=52)]
1118
1782
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1119
1783
1120
class TestSetIntervalCmd(TestValueArgumentPropertyCmd):
1784
1785
class TestSetIntervalCmd(TestPropertyValueCmd):
1121
1786
command = SetIntervalCmd
1122
property = "Interval"
1787
propname = "Interval"
1123
1788
values_to_set = [datetime.timedelta(),
1124
1789
datetime.timedelta(minutes=5),
1125
1790
datetime.timedelta(seconds=1),
1127
1792
datetime.timedelta(weeks=52)]
1128
1793
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1129
1794
1130
class TestSetApprovalDelayCmd(TestValueArgumentPropertyCmd):
1795
1796
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
1131
1797
command = SetApprovalDelayCmd
1132
property = "ApprovalDelay"
1798
propname = "ApprovalDelay"
1133
1799
values_to_set = [datetime.timedelta(),
1134
1800
datetime.timedelta(minutes=5),
1135
1801
datetime.timedelta(seconds=1),
1137
1803
datetime.timedelta(weeks=52)]
1138
1804
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1139
1805
1140
class TestSetApprovalDurationCmd(TestValueArgumentPropertyCmd):
1806
1807
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
1141
1808
command = SetApprovalDurationCmd
1142
property = "ApprovalDuration"
1809
propname = "ApprovalDuration"
1143
1810
values_to_set = [datetime.timedelta(),
1144
1811
datetime.timedelta(minutes=5),
1145
1812
datetime.timedelta(seconds=1),
1147
1814
datetime.timedelta(weeks=52)]
1148
1815
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1149
1816
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)
1326
1327
1817
1328
1818
1329
1819
def should_only_run_tests():
1343
1833
return tests
1344
1834
1345
1835
if __name__ == "__main__":
1346
if should_only_run_tests():
1347
# Call using ./tdd-python-script --check [--verbose]
1348
unittest.main()
1349
else:
1350
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