78
79
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
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))
83
parser = argparse.ArgumentParser()
85
add_command_line_options(parser)
87
options = parser.parse_args()
89
check_option_syntax(parser, options)
91
clientnames = options.client
94
log.setLevel(logging.DEBUG)
96
bus = dbus.SystemBus()
98
mandos_dbus_object = get_mandos_dbus_object(bus)
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)
105
managed_objects = get_managed_objects(mandos_serv_object_manager)
108
for path, ifs_and_props in managed_objects.items():
110
all_clients[path] = ifs_and_props[client_dbus_interface]
114
# Compile dict of (clientpath: properties) to process
116
clients = all_clients
119
for name in clientnames:
120
for objpath, properties in all_clients.items():
121
if properties["Name"] == name:
122
clients[objpath] = properties
125
log.critical("Client not found on server: %r", name)
128
# Run all commands on clients
129
commands = commands_from_options(options)
130
for command in commands:
131
command.run(clients, bus, mandos_serv)
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",
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",
155
help="Start checker for client")
156
start_stop_checker.add_argument("--stop-checker",
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")
201
def string_to_delta(interval):
202
"""Parse a string and return a datetime.timedelta"""
205
return rfc3339_duration_to_delta(interval)
206
except ValueError as e:
207
log.warning("%s - Parsing as pre-1.6.1 interval instead",
209
return parse_pre_1_6_1_interval(interval)
90
212
def rfc3339_duration_to_delta(duration):
274
## Classes for commands.
276
# Abstract classes first
385
def check_option_syntax(parser, options):
386
"""Apply additional restrictions on options, not expressible in
389
def has_actions(options):
390
return any((options.enable,
392
options.bump_timeout,
393
options.start_checker,
394
options.stop_checker,
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,
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")
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
427
def get_mandos_dbus_object(bus):
428
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
429
dbus_busname, server_dbus_path)
430
with if_dbus_exception_log_with_exception_and_exit(
431
"Could not connect to Mandos server: %s"):
432
mandos_dbus_object = bus.get_object(dbus_busname,
434
return mandos_dbus_object
437
@contextlib.contextmanager
438
def if_dbus_exception_log_with_exception_and_exit(*args, **kwargs):
441
except dbus.exceptions.DBusException as e:
442
log.critical(*(args + (e,)), **kwargs)
446
def get_managed_objects(object_manager):
447
log.debug("D-Bus: %s:%s:%s.GetManagedObjects()", dbus_busname,
448
server_dbus_path, dbus.OBJECT_MANAGER_IFACE)
449
with if_dbus_exception_log_with_exception_and_exit(
450
"Failed to access Mandos server through D-Bus:\n%s"):
451
with SilenceLogger("dbus.proxies"):
452
managed_objects = object_manager.GetManagedObjects()
453
return managed_objects
456
class SilenceLogger(object):
457
"Simple context manager to silence a particular logger"
458
def __init__(self, loggername):
459
self.logger = logging.getLogger(loggername)
462
self.logger.addFilter(self.nullfilter)
465
class NullFilter(logging.Filter):
466
def filter(self, record):
469
nullfilter = NullFilter()
471
def __exit__(self, exc_type, exc_val, exc_tb):
472
self.logger.removeFilter(self.nullfilter)
475
def commands_from_options(options):
479
if options.is_enabled:
480
commands.append(IsEnabledCmd())
483
commands.append(ApproveCmd())
486
commands.append(DenyCmd())
489
commands.append(RemoveCmd())
491
if options.dump_json:
492
commands.append(DumpJSONCmd())
495
commands.append(EnableCmd())
498
commands.append(DisableCmd())
500
if options.bump_timeout:
501
commands.append(BumpTimeoutCmd())
503
if options.start_checker:
504
commands.append(StartCheckerCmd())
506
if options.stop_checker:
507
commands.append(StopCheckerCmd())
509
if options.approved_by_default is not None:
510
if options.approved_by_default:
511
commands.append(ApproveByDefaultCmd())
513
commands.append(DenyByDefaultCmd())
515
if options.checker is not None:
516
commands.append(SetCheckerCmd(options.checker))
518
if options.host is not None:
519
commands.append(SetHostCmd(options.host))
521
if options.secret is not None:
522
commands.append(SetSecretCmd(options.secret))
524
if options.timeout is not None:
525
commands.append(SetTimeoutCmd(options.timeout))
527
if options.extended_timeout:
529
SetExtendedTimeoutCmd(options.extended_timeout))
531
if options.interval is not None:
532
commands.append(SetIntervalCmd(options.interval))
534
if options.approval_delay is not None:
535
commands.append(SetApprovalDelayCmd(options.approval_delay))
537
if options.approval_duration is not None:
539
SetApprovalDurationCmd(options.approval_duration))
541
# If no command option has been given, show table of clients,
542
# optionally verbosely
544
commands.append(PrintTableCmd(verbose=options.verbose))
277
549
class Command(object):
278
550
"""Abstract class for commands"""
279
def run(self, mandos, clients):
551
def run(self, clients, bus=None, mandos=None):
280
552
"""Normal commands should implement run_on_one_client(), but
281
553
commands which want to operate on all clients at the same time
282
554
can override this run() method instead."""
283
555
self.mandos = mandos
284
for client, properties in clients.items():
556
for clientpath, properties in clients.items():
557
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
558
dbus_busname, str(clientpath))
559
client = bus.get_object(dbus_busname, clientpath)
285
560
self.run_on_one_client(client, properties)
287
class PrintCmd(Command):
288
"""Abstract class for commands printing client details"""
563
class IsEnabledCmd(Command):
564
def run(self, clients, bus=None, mandos=None):
565
client, properties = next(iter(clients.items()))
566
if self.is_enabled(client, properties):
569
def is_enabled(self, client, properties):
570
return properties["Enabled"]
573
class ApproveCmd(Command):
574
def run_on_one_client(self, client, properties):
575
log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
576
client.__dbus_object_path__, client_dbus_interface)
577
client.Approve(dbus.Boolean(True),
578
dbus_interface=client_dbus_interface)
581
class DenyCmd(Command):
582
def run_on_one_client(self, client, properties):
583
log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
584
client.__dbus_object_path__, client_dbus_interface)
585
client.Approve(dbus.Boolean(False),
586
dbus_interface=client_dbus_interface)
589
class RemoveCmd(Command):
590
def run_on_one_client(self, client, properties):
591
log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)", dbus_busname,
592
server_dbus_path, server_dbus_interface,
593
str(client.__dbus_object_path__))
594
self.mandos.RemoveClient(client.__dbus_object_path__)
597
class OutputCmd(Command):
598
"""Abstract class for commands outputting client details"""
289
599
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
290
600
"Created", "Interval", "Host", "KeyID",
291
601
"Fingerprint", "CheckerRunning", "LastEnabled",
406
710
**{key: self.string_from_client(client, key)
407
711
for key in self.keywords})
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=(',', ': '))
419
def dbus_boolean_to_bool(value):
420
if isinstance(value, dbus.Boolean):
424
class IsEnabledCmd(Command):
425
def run_on_one_client(self, client, properties):
426
if self.is_enabled(client, properties):
429
def is_enabled(self, client, properties):
430
return bool(properties["Enabled"])
432
class RemoveCmd(Command):
433
def run_on_one_client(self, client, properties):
434
self.mandos.RemoveClient(client.__dbus_object_path__)
436
class ApproveCmd(Command):
437
def run_on_one_client(self, client, properties):
438
client.Approve(dbus.Boolean(True),
439
dbus_interface=client_interface)
441
class DenyCmd(Command):
442
def run_on_one_client(self, client, properties):
443
client.Approve(dbus.Boolean(False),
444
dbus_interface=client_interface)
714
def milliseconds_to_string(ms):
715
td = datetime.timedelta(0, 0, 0, ms)
716
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
717
.format(days="{}T".format(td.days)
719
hours=td.seconds // 3600,
720
minutes=(td.seconds % 3600) // 60,
721
seconds=td.seconds % 60))
724
class PropertyCmd(Command):
725
"""Abstract class for Actions for setting one client property"""
727
def run_on_one_client(self, client, properties):
728
"""Set the Client's D-Bus property"""
729
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
730
client.__dbus_object_path__,
731
dbus.PROPERTIES_IFACE, client_dbus_interface,
732
self.propname, self.value_to_set
733
if not isinstance(self.value_to_set, dbus.Boolean)
734
else bool(self.value_to_set))
735
client.Set(client_dbus_interface, self.propname,
737
dbus_interface=dbus.PROPERTIES_IFACE)
741
raise NotImplementedError()
446
744
class EnableCmd(PropertyCmd):
448
746
value_to_set = dbus.Boolean(True)
450
749
class DisableCmd(PropertyCmd):
452
751
value_to_set = dbus.Boolean(False)
454
754
class BumpTimeoutCmd(PropertyCmd):
455
property = "LastCheckedOK"
755
propname = "LastCheckedOK"
456
756
value_to_set = ""
458
759
class StartCheckerCmd(PropertyCmd):
459
property = "CheckerRunning"
760
propname = "CheckerRunning"
460
761
value_to_set = dbus.Boolean(True)
462
764
class StopCheckerCmd(PropertyCmd):
463
property = "CheckerRunning"
765
propname = "CheckerRunning"
464
766
value_to_set = dbus.Boolean(False)
466
769
class ApproveByDefaultCmd(PropertyCmd):
467
property = "ApprovedByDefault"
770
propname = "ApprovedByDefault"
468
771
value_to_set = dbus.Boolean(True)
470
774
class DenyByDefaultCmd(PropertyCmd):
471
property = "ApprovedByDefault"
775
propname = "ApprovedByDefault"
472
776
value_to_set = dbus.Boolean(False)
474
class SetCheckerCmd(PropertyCmd, ValueArgumentMixIn):
477
class SetHostCmd(PropertyCmd, ValueArgumentMixIn):
480
class SetSecretCmd(PropertyCmd, ValueArgumentMixIn):
779
class PropertyValueCmd(PropertyCmd):
780
"""Abstract class for PropertyCmd recieving a value as argument"""
781
def __init__(self, value):
782
self.value_to_set = value
785
class SetCheckerCmd(PropertyValueCmd):
789
class SetHostCmd(PropertyValueCmd):
793
class SetSecretCmd(PropertyValueCmd):
482
797
def value_to_set(self):
484
800
@value_to_set.setter
485
801
def value_to_set(self, value):
486
802
"""When setting, read data from supplied file object"""
487
803
self._vts = value.read()
491
class SetTimeoutCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
494
class SetExtendedTimeoutCmd(PropertyCmd,
495
MillisecondsValueArgumentMixIn):
496
property = "ExtendedTimeout"
498
class SetIntervalCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
499
property = "Interval"
501
class SetApprovalDelayCmd(PropertyCmd,
502
MillisecondsValueArgumentMixIn):
503
property = "ApprovalDelay"
505
class SetApprovalDurationCmd(PropertyCmd,
506
MillisecondsValueArgumentMixIn):
507
property = "ApprovalDuration"
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",
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",
530
help="Start checker for client")
531
start_stop_checker.add_argument("--stop-checker",
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")
574
def commands_from_options(options):
578
if options.dump_json:
579
commands.append(DumpJSONCmd())
582
commands.append(EnableCmd())
585
commands.append(DisableCmd())
587
if options.bump_timeout:
588
commands.append(BumpTimeoutCmd())
590
if options.start_checker:
591
commands.append(StartCheckerCmd())
593
if options.stop_checker:
594
commands.append(StopCheckerCmd())
596
if options.is_enabled:
597
commands.append(IsEnabledCmd())
600
commands.append(RemoveCmd())
602
if options.checker is not None:
603
commands.append(SetCheckerCmd(options.checker))
605
if options.timeout is not None:
606
commands.append(SetTimeoutCmd(options.timeout))
608
if options.extended_timeout:
610
SetExtendedTimeoutCmd(options.extended_timeout))
612
if options.interval is not None:
613
commands.append(SetIntervalCmd(options.interval))
615
if options.approved_by_default is not None:
616
if options.approved_by_default:
617
commands.append(ApproveByDefaultCmd())
619
commands.append(DenyByDefaultCmd())
621
if options.approval_delay is not None:
622
commands.append(SetApprovalDelayCmd(options.approval_delay))
624
if options.approval_duration is not None:
626
SetApprovalDurationCmd(options.approval_duration))
628
if options.host is not None:
629
commands.append(SetHostCmd(options.host))
631
if options.secret is not None:
632
commands.append(SetSecretCmd(options.secret))
635
commands.append(ApproveCmd())
638
commands.append(DenyCmd())
640
# If no command option has been given, show table of clients,
641
# optionally verbosely
643
commands.append(PrintTableCmd(verbose=options.verbose))
648
def check_option_syntax(parser, options):
649
"""Apply additional restrictions on options, not expressible in
652
def has_actions(options):
653
return any((options.enable,
655
options.bump_timeout,
656
options.start_checker,
657
options.stop_checker,
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,
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")
686
parser = argparse.ArgumentParser()
688
add_command_line_options(parser)
690
options = parser.parse_args()
692
check_option_syntax(parser, options)
694
clientnames = options.client
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")
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)
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):
713
dbus_filter = NullFilter()
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:"
726
# restore dbus logger
727
dbus_logger.removeFilter(dbus_filter)
729
# Compile dict of (clients: properties) to process
733
clients = {bus.get_object(busname, path): properties
734
for path, properties in mandos_clients.items()}
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
743
log.critical("Client not found on server: %r", name)
746
# Run all commands on clients
747
commands = commands_from_options(options)
748
for command in commands:
749
command.run(mandos_serv, clients)
807
class MillisecondsPropertyValueArgumentCmd(PropertyValueCmd):
808
"""Abstract class for PropertyValueCmd taking a value argument as
809
a datetime.timedelta() but should store it as milliseconds."""
812
def value_to_set(self):
816
def value_to_set(self, value):
817
"""When setting, convert value from a datetime.timedelta"""
818
self._vts = int(round(value.total_seconds() * 1000))
821
class SetTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
825
class SetExtendedTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
826
propname = "ExtendedTimeout"
829
class SetIntervalCmd(MillisecondsPropertyValueArgumentCmd):
830
propname = "Interval"
833
class SetApprovalDelayCmd(MillisecondsPropertyValueArgumentCmd):
834
propname = "ApprovalDelay"
837
class SetApprovalDurationCmd(MillisecondsPropertyValueArgumentCmd):
838
propname = "ApprovalDuration"
752
class Test_milliseconds_to_string(unittest.TestCase):
754
self.assertEqual(milliseconds_to_string(93785000),
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")
765
class Test_string_to_delta(unittest.TestCase):
842
class TestCaseWithAssertLogs(unittest.TestCase):
843
"""unittest.TestCase.assertLogs only exists in Python 3.4"""
845
if not hasattr(unittest.TestCase, "assertLogs"):
846
@contextlib.contextmanager
847
def assertLogs(self, logger, level=logging.INFO):
848
capturing_handler = self.CapturingLevelHandler(level)
849
old_level = logger.level
850
old_propagate = logger.propagate
851
logger.addHandler(capturing_handler)
852
logger.setLevel(level)
853
logger.propagate = False
855
yield capturing_handler.watcher
857
logger.propagate = old_propagate
858
logger.removeHandler(capturing_handler)
859
logger.setLevel(old_level)
860
self.assertGreater(len(capturing_handler.watcher.records),
863
class CapturingLevelHandler(logging.Handler):
864
def __init__(self, level, *args, **kwargs):
865
logging.Handler.__init__(self, *args, **kwargs)
866
self.watcher = self.LoggingWatcher([], [])
867
def emit(self, record):
868
self.watcher.records.append(record)
869
self.watcher.output.append(self.format(record))
871
LoggingWatcher = collections.namedtuple("LoggingWatcher",
875
class Test_string_to_delta(TestCaseWithAssertLogs):
766
876
def test_handles_basic_rfc3339(self):
767
877
self.assertEqual(string_to_delta("PT0S"),
768
878
datetime.timedelta())
772
882
datetime.timedelta(0, 1))
773
883
self.assertEqual(string_to_delta("PT2H"),
774
884
datetime.timedelta(0, 7200))
775
886
def test_falls_back_to_pre_1_6_1_with_warning(self):
776
# assertLogs only exists in Python 3.4
777
if hasattr(self, "assertLogs"):
778
with self.assertLogs(log, logging.WARNING):
779
value = string_to_delta("2h")
781
class WarningFilter(logging.Filter):
782
"""Don't show, but record the presence of, warnings"""
783
def filter(self, record):
784
is_warning = record.levelno >= logging.WARNING
785
self.found = is_warning or getattr(self, "found",
787
return not is_warning
788
warning_filter = WarningFilter()
789
log.addFilter(warning_filter)
791
value = string_to_delta("2h")
793
log.removeFilter(warning_filter)
794
self.assertTrue(getattr(warning_filter, "found", False))
887
with self.assertLogs(log, logging.WARNING):
888
value = string_to_delta("2h")
795
889
self.assertEqual(value, datetime.timedelta(0, 7200))
892
class Test_check_option_syntax(unittest.TestCase):
894
self.parser = argparse.ArgumentParser()
895
add_command_line_options(self.parser)
897
def test_actions_requires_client_or_all(self):
898
for action, value in self.actions.items():
899
options = self.parser.parse_args()
900
setattr(options, action, value)
901
with self.assertParseError():
902
self.check_option_syntax(options)
904
# This mostly corresponds to the definition from has_actions() in
905
# check_option_syntax()
907
# The actual values set here are not that important, but we do
908
# at least stick to the correct types, even though they are
912
"bump_timeout": True,
913
"start_checker": True,
914
"stop_checker": True,
918
"timeout": datetime.timedelta(),
919
"extended_timeout": datetime.timedelta(),
920
"interval": datetime.timedelta(),
921
"approved_by_default": True,
922
"approval_delay": datetime.timedelta(),
923
"approval_duration": datetime.timedelta(),
925
"secret": io.BytesIO(b"x"),
930
@contextlib.contextmanager
931
def assertParseError(self):
932
with self.assertRaises(SystemExit) as e:
933
with self.temporarily_suppress_stderr():
935
# Exit code from argparse is guaranteed to be "2". Reference:
936
# https://docs.python.org/3/library
937
# /argparse.html#exiting-methods
938
self.assertEqual(e.exception.code, 2)
941
@contextlib.contextmanager
942
def temporarily_suppress_stderr():
943
null = os.open(os.path.devnull, os.O_RDWR)
944
stderrcopy = os.dup(sys.stderr.fileno())
945
os.dup2(null, sys.stderr.fileno())
951
os.dup2(stderrcopy, sys.stderr.fileno())
954
def check_option_syntax(self, options):
955
check_option_syntax(self.parser, options)
957
def test_actions_conflicts_with_verbose(self):
958
for action, value in self.actions.items():
959
options = self.parser.parse_args()
960
setattr(options, action, value)
961
options.verbose = True
962
with self.assertParseError():
963
self.check_option_syntax(options)
965
def test_dump_json_conflicts_with_verbose(self):
966
options = self.parser.parse_args()
967
options.dump_json = True
968
options.verbose = True
969
with self.assertParseError():
970
self.check_option_syntax(options)
972
def test_dump_json_conflicts_with_action(self):
973
for action, value in self.actions.items():
974
options = self.parser.parse_args()
975
setattr(options, action, value)
976
options.dump_json = True
977
with self.assertParseError():
978
self.check_option_syntax(options)
980
def test_all_can_not_be_alone(self):
981
options = self.parser.parse_args()
983
with self.assertParseError():
984
self.check_option_syntax(options)
986
def test_all_is_ok_with_any_action(self):
987
for action, value in self.actions.items():
988
options = self.parser.parse_args()
989
setattr(options, action, value)
991
self.check_option_syntax(options)
993
def test_is_enabled_fails_without_client(self):
994
options = self.parser.parse_args()
995
options.is_enabled = True
996
with self.assertParseError():
997
self.check_option_syntax(options)
999
def test_is_enabled_works_with_one_client(self):
1000
options = self.parser.parse_args()
1001
options.is_enabled = True
1002
options.client = ["foo"]
1003
self.check_option_syntax(options)
1005
def test_is_enabled_fails_with_two_clients(self):
1006
options = self.parser.parse_args()
1007
options.is_enabled = True
1008
options.client = ["foo", "barbar"]
1009
with self.assertParseError():
1010
self.check_option_syntax(options)
1012
def test_remove_can_only_be_combined_with_action_deny(self):
1013
for action, value in self.actions.items():
1014
if action in {"remove", "deny"}:
1016
options = self.parser.parse_args()
1017
setattr(options, action, value)
1019
options.remove = True
1020
with self.assertParseError():
1021
self.check_option_syntax(options)
1024
class Test_get_mandos_dbus_object(TestCaseWithAssertLogs):
1025
def test_calls_and_returns_get_object_on_bus(self):
1026
class MockBus(object):
1028
def get_object(mockbus_self, busname, dbus_path):
1029
# Note that "self" is still the testcase instance,
1030
# this MockBus instance is in "mockbus_self".
1031
self.assertEqual(busname, dbus_busname)
1032
self.assertEqual(dbus_path, server_dbus_path)
1033
mockbus_self.called = True
1036
mockbus = get_mandos_dbus_object(bus=MockBus())
1037
self.assertIsInstance(mockbus, MockBus)
1038
self.assertTrue(mockbus.called)
1040
def test_logs_and_exits_on_dbus_error(self):
1041
class MockBusFailing(object):
1042
def get_object(self, busname, dbus_path):
1043
raise dbus.exceptions.DBusException("Test")
1045
with self.assertLogs(log, logging.CRITICAL):
1046
with self.assertRaises(SystemExit) as e:
1047
bus = get_mandos_dbus_object(bus=MockBusFailing())
1049
if isinstance(e.exception.code, int):
1050
self.assertNotEqual(e.exception.code, 0)
1052
self.assertIsNotNone(e.exception.code)
1055
class Test_get_managed_objects(TestCaseWithAssertLogs):
1056
def test_calls_and_returns_GetManagedObjects(self):
1057
managed_objects = {"/clients/foo": { "Name": "foo"}}
1058
class MockObjectManager(object):
1059
def GetManagedObjects(self):
1060
return managed_objects
1061
retval = get_managed_objects(MockObjectManager())
1062
self.assertDictEqual(managed_objects, retval)
1064
def test_logs_and_exits_on_dbus_error(self):
1065
dbus_logger = logging.getLogger("dbus.proxies")
1067
class MockObjectManagerFailing(object):
1068
def GetManagedObjects(self):
1069
dbus_logger.error("Test")
1070
raise dbus.exceptions.DBusException("Test")
1072
class CountingHandler(logging.Handler):
1074
def emit(self, record):
1077
counting_handler = CountingHandler()
1079
dbus_logger.addHandler(counting_handler)
1082
with self.assertLogs(log, logging.CRITICAL) as watcher:
1083
with self.assertRaises(SystemExit) as e:
1084
get_managed_objects(MockObjectManagerFailing())
1086
dbus_logger.removeFilter(counting_handler)
1087
self.assertEqual(counting_handler.count, 0)
1089
# Test that the dbus_logger still works
1090
with self.assertLogs(dbus_logger, logging.ERROR):
1091
dbus_logger.error("Test")
1093
if isinstance(e.exception.code, int):
1094
self.assertNotEqual(e.exception.code, 0)
1096
self.assertIsNotNone(e.exception.code)
1099
class Test_commands_from_options(unittest.TestCase):
1101
self.parser = argparse.ArgumentParser()
1102
add_command_line_options(self.parser)
1104
def test_is_enabled(self):
1105
self.assert_command_from_args(["--is-enabled", "foo"],
1108
def assert_command_from_args(self, args, command_cls,
1110
"""Assert that parsing ARGS should result in an instance of
1111
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
1112
options = self.parser.parse_args(args)
1113
check_option_syntax(self.parser, options)
1114
commands = commands_from_options(options)
1115
self.assertEqual(len(commands), 1)
1116
command = commands[0]
1117
self.assertIsInstance(command, command_cls)
1118
for key, value in cmd_attrs.items():
1119
self.assertEqual(getattr(command, key), value)
1121
def test_is_enabled_short(self):
1122
self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
1124
def test_approve(self):
1125
self.assert_command_from_args(["--approve", "foo"],
1128
def test_approve_short(self):
1129
self.assert_command_from_args(["-A", "foo"], ApproveCmd)
1131
def test_deny(self):
1132
self.assert_command_from_args(["--deny", "foo"], DenyCmd)
1134
def test_deny_short(self):
1135
self.assert_command_from_args(["-D", "foo"], DenyCmd)
1137
def test_remove(self):
1138
self.assert_command_from_args(["--remove", "foo"],
1141
def test_deny_before_remove(self):
1142
options = self.parser.parse_args(["--deny", "--remove",
1144
check_option_syntax(self.parser, options)
1145
commands = commands_from_options(options)
1146
self.assertEqual(len(commands), 2)
1147
self.assertIsInstance(commands[0], DenyCmd)
1148
self.assertIsInstance(commands[1], RemoveCmd)
1150
def test_deny_before_remove_reversed(self):
1151
options = self.parser.parse_args(["--remove", "--deny",
1153
check_option_syntax(self.parser, options)
1154
commands = commands_from_options(options)
1155
self.assertEqual(len(commands), 2)
1156
self.assertIsInstance(commands[0], DenyCmd)
1157
self.assertIsInstance(commands[1], RemoveCmd)
1159
def test_remove_short(self):
1160
self.assert_command_from_args(["-r", "foo"], RemoveCmd)
1162
def test_dump_json(self):
1163
self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
1165
def test_enable(self):
1166
self.assert_command_from_args(["--enable", "foo"], EnableCmd)
1168
def test_enable_short(self):
1169
self.assert_command_from_args(["-e", "foo"], EnableCmd)
1171
def test_disable(self):
1172
self.assert_command_from_args(["--disable", "foo"],
1175
def test_disable_short(self):
1176
self.assert_command_from_args(["-d", "foo"], DisableCmd)
1178
def test_bump_timeout(self):
1179
self.assert_command_from_args(["--bump-timeout", "foo"],
1182
def test_bump_timeout_short(self):
1183
self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
1185
def test_start_checker(self):
1186
self.assert_command_from_args(["--start-checker", "foo"],
1189
def test_stop_checker(self):
1190
self.assert_command_from_args(["--stop-checker", "foo"],
1193
def test_approve_by_default(self):
1194
self.assert_command_from_args(["--approve-by-default", "foo"],
1195
ApproveByDefaultCmd)
1197
def test_deny_by_default(self):
1198
self.assert_command_from_args(["--deny-by-default", "foo"],
1201
def test_checker(self):
1202
self.assert_command_from_args(["--checker", ":", "foo"],
1203
SetCheckerCmd, value_to_set=":")
1205
def test_checker_empty(self):
1206
self.assert_command_from_args(["--checker", "", "foo"],
1207
SetCheckerCmd, value_to_set="")
1209
def test_checker_short(self):
1210
self.assert_command_from_args(["-c", ":", "foo"],
1211
SetCheckerCmd, value_to_set=":")
1213
def test_host(self):
1214
self.assert_command_from_args(["--host", "foo.example.org",
1216
value_to_set="foo.example.org")
1218
def test_host_short(self):
1219
self.assert_command_from_args(["-H", "foo.example.org",
1221
value_to_set="foo.example.org")
1223
def test_secret_devnull(self):
1224
self.assert_command_from_args(["--secret", os.path.devnull,
1225
"foo"], SetSecretCmd,
1228
def test_secret_tempfile(self):
1229
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1230
value = b"secret\0xyzzy\nbar"
1233
self.assert_command_from_args(["--secret", f.name,
1234
"foo"], SetSecretCmd,
1237
def test_secret_devnull_short(self):
1238
self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1239
SetSecretCmd, value_to_set=b"")
1241
def test_secret_tempfile_short(self):
1242
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1243
value = b"secret\0xyzzy\nbar"
1246
self.assert_command_from_args(["-s", f.name, "foo"],
1250
def test_timeout(self):
1251
self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1253
value_to_set=300000)
1255
def test_timeout_short(self):
1256
self.assert_command_from_args(["-t", "PT5M", "foo"],
1258
value_to_set=300000)
1260
def test_extended_timeout(self):
1261
self.assert_command_from_args(["--extended-timeout", "PT15M",
1263
SetExtendedTimeoutCmd,
1264
value_to_set=900000)
1266
def test_interval(self):
1267
self.assert_command_from_args(["--interval", "PT2M", "foo"],
1269
value_to_set=120000)
1271
def test_interval_short(self):
1272
self.assert_command_from_args(["-i", "PT2M", "foo"],
1274
value_to_set=120000)
1276
def test_approval_delay(self):
1277
self.assert_command_from_args(["--approval-delay", "PT30S",
1278
"foo"], SetApprovalDelayCmd,
1281
def test_approval_duration(self):
1282
self.assert_command_from_args(["--approval-duration", "PT1S",
1283
"foo"], SetApprovalDurationCmd,
1286
def test_print_table(self):
1287
self.assert_command_from_args([], PrintTableCmd,
1290
def test_print_table_verbose(self):
1291
self.assert_command_from_args(["--verbose"], PrintTableCmd,
1294
def test_print_table_verbose_short(self):
1295
self.assert_command_from_args(["-v"], PrintTableCmd,
798
1299
class TestCmd(unittest.TestCase):
799
1300
"""Abstract class for tests of command classes"""
800
1302
def setUp(self):
802
1304
class MockClient(object):
803
1305
def __init__(self, name, **attributes):
804
self.__dbus_object_path__ = "objpath_{}".format(name)
1306
self.__dbus_object_path__ = "/clients/{}".format(name)
805
1307
self.attributes = attributes
806
1308
self.attributes["Name"] = name
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]
1310
def Set(self, interface, propname, value, dbus_interface):
1311
testcase.assertEqual(interface, client_dbus_interface)
1312
testcase.assertEqual(dbus_interface,
1313
dbus.PROPERTIES_IFACE)
1314
self.attributes[propname] = value
1315
def Get(self, interface, propname, dbus_interface):
1316
testcase.assertEqual(interface, client_dbus_interface)
1317
testcase.assertEqual(dbus_interface,
1318
dbus.PROPERTIES_IFACE)
1319
return self.attributes[propname]
818
1320
def Approve(self, approve, dbus_interface):
819
testcase.assertEqual(dbus_interface, client_interface)
1321
testcase.assertEqual(dbus_interface,
1322
client_dbus_interface)
820
1323
self.calls.append(("Approve", (approve,
821
1324
dbus_interface)))
822
1325
self.client = MockClient(
862
1365
ApprovedByDefault=dbus.Boolean(False),
863
1366
LastApprovalRequest="2019-01-03T00:00:00",
864
1367
ApprovalDelay=30000,
865
ApprovalDuration=1000,
1368
ApprovalDuration=93785000,
867
1370
ExtendedTimeout=900000,
868
1371
Expires="2019-02-05T00:00:00",
869
1372
LastCheckerStatus=-2)
870
1373
self.clients = collections.OrderedDict(
872
(self.client, self.client.attributes),
873
(self.other_client, self.other_client.attributes),
1375
("/clients/foo", self.client.attributes),
1376
("/clients/barbar", self.other_client.attributes),
875
self.one_client = {self.client: self.client.attributes}
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
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
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
900
self.assertEqual(output, expected_output)
1378
self.one_client = {"/clients/foo": self.client.attributes}
1384
def get_object(client_bus_name, path):
1385
self.assertEqual(client_bus_name, dbus_busname)
1387
# Note: "self" here is the TestCmd instance, not
1388
# the Bus instance, since this is a static method!
1389
"/clients/foo": self.client,
1390
"/clients/barbar": self.other_client,
1395
class TestIsEnabledCmd(TestCmd):
1396
def test_is_enabled(self):
1397
self.assertTrue(all(IsEnabledCmd().is_enabled(client,
1399
for client, properties
1400
in self.clients.items()))
1402
def test_is_enabled_run_exits_successfully(self):
1403
with self.assertRaises(SystemExit) as e:
1404
IsEnabledCmd().run(self.one_client)
1405
if e.exception.code is not None:
1406
self.assertEqual(e.exception.code, 0)
1408
self.assertIsNone(e.exception.code)
1410
def test_is_enabled_run_exits_with_failure(self):
1411
self.client.attributes["Enabled"] = dbus.Boolean(False)
1412
with self.assertRaises(SystemExit) as e:
1413
IsEnabledCmd().run(self.one_client)
1414
if isinstance(e.exception.code, int):
1415
self.assertNotEqual(e.exception.code, 0)
1417
self.assertIsNotNone(e.exception.code)
1420
class TestApproveCmd(TestCmd):
1421
def test_approve(self):
1422
ApproveCmd().run(self.clients, self.bus)
1423
for clientpath in self.clients:
1424
client = self.bus.get_object(dbus_busname, clientpath)
1425
self.assertIn(("Approve", (True, client_dbus_interface)),
1429
class TestDenyCmd(TestCmd):
1430
def test_deny(self):
1431
DenyCmd().run(self.clients, self.bus)
1432
for clientpath in self.clients:
1433
client = self.bus.get_object(dbus_busname, clientpath)
1434
self.assertIn(("Approve", (False, client_dbus_interface)),
1438
class TestRemoveCmd(TestCmd):
1439
def test_remove(self):
1440
class MockMandos(object):
1443
def RemoveClient(self, dbus_path):
1444
self.calls.append(("RemoveClient", (dbus_path,)))
1445
mandos = MockMandos()
1446
super(TestRemoveCmd, self).setUp()
1447
RemoveCmd().run(self.clients, self.bus, mandos)
1448
self.assertEqual(len(mandos.calls), 2)
1449
for clientpath in self.clients:
1450
self.assertIn(("RemoveClient", (clientpath,)),
902
1454
class TestDumpJSONCmd(TestCmd):
903
1455
def setUp(self):
954
1506
return super(TestDumpJSONCmd, self).setUp()
955
1508
def test_normal(self):
956
json_data = json.loads(DumpJSONCmd().output(self.clients))
1509
output = DumpJSONCmd().output(self.clients.values())
1510
json_data = json.loads(output)
957
1511
self.assertDictEqual(json_data, self.expected_json)
958
1513
def test_one_client(self):
959
clients = self.one_client
960
json_data = json.loads(DumpJSONCmd().output(clients))
1514
output = DumpJSONCmd().output(self.one_client.values())
1515
json_data = json.loads(output)
961
1516
expected_json = {"foo": self.expected_json["foo"]}
962
1517
self.assertDictEqual(json_data, expected_json)
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)
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)
982
self.assertIsNotNone(e.exception.code)
984
class TestRemoveCmd(TestCmd):
985
def test_remove(self):
986
class MockMandos(object):
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__,)),
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)),
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)),
1014
class TestEnableCmd(TestCmd):
1015
def test_enable(self):
1016
for client in self.clients:
1017
client.attributes["Enabled"] = False
1019
EnableCmd().run(None, self.clients)
1021
for client in self.clients:
1022
self.assertTrue(client.attributes["Enabled"])
1024
class TestDisableCmd(TestCmd):
1025
def test_disable(self):
1026
DisableCmd().run(None, self.clients)
1028
for client in self.clients:
1029
self.assertFalse(client.attributes["Enabled"])
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"""
1520
class TestPrintTableCmd(TestCmd):
1521
def test_normal(self):
1522
output = PrintTableCmd().output(self.clients.values())
1523
expected_output = "\n".join((
1524
"Name Enabled Timeout Last Successful Check",
1525
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1526
"barbar Yes 00:05:00 2019-02-04T00:00:00 ",
1528
self.assertEqual(output, expected_output)
1530
def test_verbose(self):
1531
output = PrintTableCmd(verbose=True).output(
1532
self.clients.values())
1547
"Last Successful Check ",
1548
"2019-02-03T00:00:00 ",
1549
"2019-02-04T00:00:00 ",
1552
"2019-01-02T00:00:00 ",
1553
"2019-01-03T00:00:00 ",
1565
("92ed150794387c03ce684574b1139a6594a34f895daaaf09fd8"
1567
("0558568eedd67d622f5c83b35a115f796ab612cff5ad227247e"
1571
"778827225BA7DE539C5A7CFA59CFF7CDBD9A5920 ",
1572
"3E393AEAEFB84C7E89E2F547B3A107558FCA3A27 ",
1574
"Check Is Running ",
1579
"2019-01-03T00:00:00 ",
1580
"2019-01-04T00:00:00 ",
1582
"Approval Is Pending ",
1586
"Approved By Default ",
1590
"Last Approval Request ",
1592
"2019-01-03T00:00:00 ",
1598
"Approval Duration ",
1603
"fping -q -- %(host)s ",
1606
"Extended Timeout ",
1611
"2019-02-04T00:00:00 ",
1612
"2019-02-05T00:00:00 ",
1614
"Last Checker Status",
1619
num_lines = max(len(rows) for rows in columns)
1620
expected_output = "\n".join("".join(rows[line]
1621
for rows in columns)
1622
for line in range(num_lines))
1623
self.assertEqual(output, expected_output)
1625
def test_one_client(self):
1626
output = PrintTableCmd().output(self.one_client.values())
1627
expected_output = "\n".join((
1628
"Name Enabled Timeout Last Successful Check",
1629
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1631
self.assertEqual(output, expected_output)
1035
1634
class TestPropertyCmd(TestCmd):
1036
1635
"""Abstract class for tests of PropertyCmd classes"""
1041
1640
self.values_to_set)
1042
1641
for value_to_set, value_to_get in zip(self.values_to_set,
1043
1642
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()
1643
for clientpath in self.clients:
1644
client = self.bus.get_object(dbus_busname, clientpath)
1645
old_value = client.attributes[self.propname]
1646
self.assertNotIsInstance(old_value, self.Unique)
1647
client.attributes[self.propname] = self.Unique()
1048
1648
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)
1649
for clientpath in self.clients:
1650
client = self.bus.get_object(dbus_busname, clientpath)
1651
value = client.attributes[self.propname]
1652
self.assertNotIsInstance(value, self.Unique)
1052
1653
self.assertEqual(value, value_to_get)
1655
class Unique(object):
1656
"""Class for objects which exist only to be unique objects,
1657
since unittest.mock.sentinel only exists in Python 3.3"""
1053
1659
def run_command(self, value, clients):
1054
self.command().run(None, clients)
1660
self.command().run(clients, self.bus)
1663
class TestEnableCmd(TestPropertyCmd):
1665
propname = "Enabled"
1666
values_to_set = [dbus.Boolean(True)]
1669
class TestDisableCmd(TestPropertyCmd):
1670
command = DisableCmd
1671
propname = "Enabled"
1672
values_to_set = [dbus.Boolean(False)]
1056
1675
class TestBumpTimeoutCmd(TestPropertyCmd):
1057
1676
command = BumpTimeoutCmd
1058
property = "LastCheckedOK"
1677
propname = "LastCheckedOK"
1059
1678
values_to_set = [""]
1061
1681
class TestStartCheckerCmd(TestPropertyCmd):
1062
1682
command = StartCheckerCmd
1063
property = "CheckerRunning"
1683
propname = "CheckerRunning"
1064
1684
values_to_set = [dbus.Boolean(True)]
1066
1687
class TestStopCheckerCmd(TestPropertyCmd):
1067
1688
command = StopCheckerCmd
1068
property = "CheckerRunning"
1689
propname = "CheckerRunning"
1069
1690
values_to_set = [dbus.Boolean(False)]
1071
1693
class TestApproveByDefaultCmd(TestPropertyCmd):
1072
1694
command = ApproveByDefaultCmd
1073
property = "ApprovedByDefault"
1695
propname = "ApprovedByDefault"
1074
1696
values_to_set = [dbus.Boolean(True)]
1076
1699
class TestDenyByDefaultCmd(TestPropertyCmd):
1077
1700
command = DenyByDefaultCmd
1078
property = "ApprovedByDefault"
1701
propname = "ApprovedByDefault"
1079
1702
values_to_set = [dbus.Boolean(False)]
1081
class TestValueArgumentPropertyCmd(TestPropertyCmd):
1082
"""Abstract class for tests of PropertyCmd classes using the
1083
ValueArgumentMixIn"""
1705
class TestPropertyValueCmd(TestPropertyCmd):
1706
"""Abstract class for tests of PropertyValueCmd classes"""
1084
1708
def runTest(self):
1085
if type(self) is TestValueArgumentPropertyCmd:
1709
if type(self) is TestPropertyValueCmd:
1087
return super(TestValueArgumentPropertyCmd, self).runTest()
1711
return super(TestPropertyValueCmd, self).runTest()
1088
1713
def run_command(self, value, clients):
1089
self.command(value).run(None, clients)
1091
class TestSetCheckerCmd(TestValueArgumentPropertyCmd):
1714
self.command(value).run(clients, self.bus)
1717
class TestSetCheckerCmd(TestPropertyValueCmd):
1092
1718
command = SetCheckerCmd
1093
property = "Checker"
1719
propname = "Checker"
1094
1720
values_to_set = ["", ":", "fping -q -- %s"]
1096
class TestSetHostCmd(TestValueArgumentPropertyCmd):
1723
class TestSetHostCmd(TestPropertyValueCmd):
1097
1724
command = SetHostCmd
1099
1726
values_to_set = ["192.0.2.3", "foo.example.org"]
1101
class TestSetSecretCmd(TestValueArgumentPropertyCmd):
1729
class TestSetSecretCmd(TestPropertyValueCmd):
1102
1730
command = SetSecretCmd
1104
values_to_set = [open("/dev/null", "rb"),
1732
values_to_set = [io.BytesIO(b""),
1105
1733
io.BytesIO(b"secret\0xyzzy\nbar")]
1106
1734
values_to_get = [b"", b"secret\0xyzzy\nbar"]
1108
class TestSetTimeoutCmd(TestValueArgumentPropertyCmd):
1737
class TestSetTimeoutCmd(TestPropertyValueCmd):
1109
1738
command = SetTimeoutCmd
1110
property = "Timeout"
1739
propname = "Timeout"
1111
1740
values_to_set = [datetime.timedelta(),
1112
1741
datetime.timedelta(minutes=5),
1113
1742
datetime.timedelta(seconds=1),
1155
1788
datetime.timedelta(weeks=52)]
1156
1789
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1158
class Test_command_from_options(unittest.TestCase):
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,
1177
def test_print_table_verbose(self):
1178
self.assert_command_from_args(["--verbose"], PrintTableCmd,
1181
def test_print_table_verbose_short(self):
1182
self.assert_command_from_args(["-v"], PrintTableCmd,
1185
def test_enable(self):
1186
self.assert_command_from_args(["--enable", "foo"], EnableCmd)
1188
def test_enable_short(self):
1189
self.assert_command_from_args(["-e", "foo"], EnableCmd)
1191
def test_disable(self):
1192
self.assert_command_from_args(["--disable", "foo"],
1195
def test_disable_short(self):
1196
self.assert_command_from_args(["-d", "foo"], DisableCmd)
1198
def test_bump_timeout(self):
1199
self.assert_command_from_args(["--bump-timeout", "foo"],
1202
def test_bump_timeout_short(self):
1203
self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
1205
def test_start_checker(self):
1206
self.assert_command_from_args(["--start-checker", "foo"],
1209
def test_stop_checker(self):
1210
self.assert_command_from_args(["--stop-checker", "foo"],
1213
def test_remove(self):
1214
self.assert_command_from_args(["--remove", "foo"],
1217
def test_remove_short(self):
1218
self.assert_command_from_args(["-r", "foo"], RemoveCmd)
1220
def test_checker(self):
1221
self.assert_command_from_args(["--checker", ":", "foo"],
1222
SetCheckerCmd, value_to_set=":")
1224
def test_checker_empty(self):
1225
self.assert_command_from_args(["--checker", "", "foo"],
1226
SetCheckerCmd, value_to_set="")
1228
def test_checker_short(self):
1229
self.assert_command_from_args(["-c", ":", "foo"],
1230
SetCheckerCmd, value_to_set=":")
1232
def test_timeout(self):
1233
self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1235
value_to_set=300000)
1237
def test_timeout_short(self):
1238
self.assert_command_from_args(["-t", "PT5M", "foo"],
1240
value_to_set=300000)
1242
def test_extended_timeout(self):
1243
self.assert_command_from_args(["--extended-timeout", "PT15M",
1245
SetExtendedTimeoutCmd,
1246
value_to_set=900000)
1248
def test_interval(self):
1249
self.assert_command_from_args(["--interval", "PT2M", "foo"],
1251
value_to_set=120000)
1253
def test_interval_short(self):
1254
self.assert_command_from_args(["-i", "PT2M", "foo"],
1256
value_to_set=120000)
1258
def test_approve_by_default(self):
1259
self.assert_command_from_args(["--approve-by-default", "foo"],
1260
ApproveByDefaultCmd)
1262
def test_deny_by_default(self):
1263
self.assert_command_from_args(["--deny-by-default", "foo"],
1266
def test_approval_delay(self):
1267
self.assert_command_from_args(["--approval-delay", "PT30S",
1268
"foo"], SetApprovalDelayCmd,
1271
def test_approval_duration(self):
1272
self.assert_command_from_args(["--approval-duration", "PT1S",
1273
"foo"], SetApprovalDurationCmd,
1276
def test_host(self):
1277
self.assert_command_from_args(["--host", "foo.example.org",
1279
value_to_set="foo.example.org")
1281
def test_host_short(self):
1282
self.assert_command_from_args(["-H", "foo.example.org",
1284
value_to_set="foo.example.org")
1286
def test_secret_devnull(self):
1287
self.assert_command_from_args(["--secret", os.path.devnull,
1288
"foo"], SetSecretCmd,
1291
def test_secret_tempfile(self):
1292
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1293
value = b"secret\0xyzzy\nbar"
1296
self.assert_command_from_args(["--secret", f.name,
1297
"foo"], SetSecretCmd,
1300
def test_secret_devnull_short(self):
1301
self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1302
SetSecretCmd, value_to_set=b"")
1304
def test_secret_tempfile_short(self):
1305
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1306
value = b"secret\0xyzzy\nbar"
1309
self.assert_command_from_args(["-s", f.name, "foo"],
1313
def test_approve(self):
1314
self.assert_command_from_args(["--approve", "foo"],
1317
def test_approve_short(self):
1318
self.assert_command_from_args(["-A", "foo"], ApproveCmd)
1320
def test_deny(self):
1321
self.assert_command_from_args(["--deny", "foo"], DenyCmd)
1323
def test_deny_short(self):
1324
self.assert_command_from_args(["-D", "foo"], DenyCmd)
1326
def test_dump_json(self):
1327
self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
1329
def test_is_enabled(self):
1330
self.assert_command_from_args(["--is-enabled", "foo"],
1333
def test_is_enabled_short(self):
1334
self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
1337
class Test_check_option_syntax(unittest.TestCase):
1338
# This mostly corresponds to the definition from has_actions() in
1339
# check_option_syntax()
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
1346
"bump_timeout": True,
1347
"start_checker": True,
1348
"stop_checker": True,
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(),
1359
"secret": io.BytesIO(b"x"),
1365
self.parser = argparse.ArgumentParser()
1366
add_command_line_options(self.parser)
1368
@contextlib.contextmanager
1369
def assertParseError(self):
1370
with self.assertRaises(SystemExit) as e:
1371
with self.temporarily_suppress_stderr():
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)
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())
1388
os.dup2(stderrcopy, sys.stderr.fileno())
1389
os.close(stderrcopy)
1391
def check_option_syntax(self, options):
1392
check_option_syntax(self.parser, options)
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)
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)
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)
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)
1424
def test_all_can_not_be_alone(self):
1425
options = self.parser.parse_args()
1427
with self.assertParseError():
1428
self.check_option_syntax(options)
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)
1435
self.check_option_syntax(options)
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)
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)
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)
1458
1793
def should_only_run_tests():