343
415
parser.error("--dump-json can only be used alone.")
344
416
if options.all and not has_actions(options):
345
417
parser.error("--all requires an action.")
349
fail_count, test_count = doctest.testmod()
350
sys.exit(os.EX_OK if fail_count == 0 else 1)
353
bus = dbus.SystemBus()
354
mandos_dbus_objc = bus.get_object(busname, server_path)
355
except dbus.exceptions.DBusException:
356
print("Could not connect to Mandos server", file=sys.stderr)
359
mandos_serv = dbus.Interface(mandos_dbus_objc,
360
dbus_interface=server_interface)
361
mandos_serv_object_manager = dbus.Interface(
362
mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
364
# block stderr since dbus library prints to stderr
365
null = os.open(os.path.devnull, os.O_RDWR)
366
stderrcopy = os.dup(sys.stderr.fileno())
367
os.dup2(null, sys.stderr.fileno())
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))
549
class Command(object):
550
"""Abstract class for commands"""
551
def run(self, clients, bus=None, mandos=None):
552
"""Normal commands should implement run_on_one_client(), but
553
commands which want to operate on all clients at the same time
554
can override this run() method instead."""
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)
560
self.run_on_one_client(client, properties)
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"""
599
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
600
"Created", "Interval", "Host", "KeyID",
601
"Fingerprint", "CheckerRunning", "LastEnabled",
602
"ApprovalPending", "ApprovedByDefault",
603
"LastApprovalRequest", "ApprovalDelay",
604
"ApprovalDuration", "Checker", "ExtendedTimeout",
605
"Expires", "LastCheckerStatus")
607
def run(self, clients, bus=None, mandos=None):
608
print(self.output(clients.values()))
610
def output(self, clients):
611
raise NotImplementedError()
614
class DumpJSONCmd(OutputCmd):
615
def output(self, clients):
616
data = {client["Name"]:
617
{key: self.dbus_boolean_to_bool(client[key])
618
for key in self.all_keywords}
619
for client in clients}
620
return json.dumps(data, indent=4, separators=(',', ': '))
623
def dbus_boolean_to_bool(value):
624
if isinstance(value, dbus.Boolean):
629
class PrintTableCmd(OutputCmd):
630
def __init__(self, verbose=False):
631
self.verbose = verbose
633
def output(self, clients):
634
default_keywords = ("Name", "Enabled", "Timeout",
636
keywords = default_keywords
638
keywords = self.all_keywords
639
return str(self.TableOfClients(clients, keywords))
641
class TableOfClients(object):
644
"Enabled": "Enabled",
645
"Timeout": "Timeout",
646
"LastCheckedOK": "Last Successful Check",
647
"LastApprovalRequest": "Last Approval Request",
648
"Created": "Created",
649
"Interval": "Interval",
651
"Fingerprint": "Fingerprint",
653
"CheckerRunning": "Check Is Running",
654
"LastEnabled": "Last Enabled",
655
"ApprovalPending": "Approval Is Pending",
656
"ApprovedByDefault": "Approved By Default",
657
"ApprovalDelay": "Approval Delay",
658
"ApprovalDuration": "Approval Duration",
659
"Checker": "Checker",
660
"ExtendedTimeout": "Extended Timeout",
661
"Expires": "Expires",
662
"LastCheckerStatus": "Last Checker Status",
665
def __init__(self, clients, keywords):
666
self.clients = clients
667
self.keywords = keywords
670
return "\n".join(self.rows())
672
if sys.version_info.major == 2:
673
__unicode__ = __str__
675
return str(self).encode(locale.getpreferredencoding())
678
format_string = self.row_formatting_string()
679
rows = [self.header_line(format_string)]
680
rows.extend(self.client_line(client, format_string)
681
for client in self.clients)
684
def row_formatting_string(self):
685
"Format string used to format table rows"
686
return " ".join("{{{key}:{width}}}".format(
687
width=max(len(self.tableheaders[key]),
688
*(len(self.string_from_client(client, key))
689
for client in self.clients)),
691
for key in self.keywords)
693
def string_from_client(self, client, key):
694
return self.valuetostring(client[key], key)
697
def valuetostring(cls, value, keyword):
698
if isinstance(value, dbus.Boolean):
699
return "Yes" if value else "No"
700
if keyword in ("Timeout", "Interval", "ApprovalDelay",
701
"ApprovalDuration", "ExtendedTimeout"):
702
return cls.milliseconds_to_string(value)
705
def header_line(self, format_string):
706
return format_string.format(**self.tableheaders)
708
def client_line(self, client, format_string):
709
return format_string.format(
710
**{key: self.string_from_client(client, key)
711
for key in self.keywords})
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()
744
class EnableCmd(PropertyCmd):
746
value_to_set = dbus.Boolean(True)
749
class DisableCmd(PropertyCmd):
751
value_to_set = dbus.Boolean(False)
754
class BumpTimeoutCmd(PropertyCmd):
755
propname = "LastCheckedOK"
759
class StartCheckerCmd(PropertyCmd):
760
propname = "CheckerRunning"
761
value_to_set = dbus.Boolean(True)
764
class StopCheckerCmd(PropertyCmd):
765
propname = "CheckerRunning"
766
value_to_set = dbus.Boolean(False)
769
class ApproveByDefaultCmd(PropertyCmd):
770
propname = "ApprovedByDefault"
771
value_to_set = dbus.Boolean(True)
774
class DenyByDefaultCmd(PropertyCmd):
775
propname = "ApprovedByDefault"
776
value_to_set = dbus.Boolean(False)
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):
797
def value_to_set(self):
801
def value_to_set(self, value):
802
"""When setting, read data from supplied file object"""
803
self._vts = value.read()
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"
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",
876
class Test_string_to_delta(TestCaseWithAssertLogs):
877
def test_handles_basic_rfc3339(self):
878
self.assertEqual(string_to_delta("PT0S"),
879
datetime.timedelta())
880
self.assertEqual(string_to_delta("P0D"),
881
datetime.timedelta())
882
self.assertEqual(string_to_delta("PT1S"),
883
datetime.timedelta(0, 1))
884
self.assertEqual(string_to_delta("PT2H"),
885
datetime.timedelta(0, 7200))
887
def test_falls_back_to_pre_1_6_1_with_warning(self):
888
with self.assertLogs(log, logging.WARNING):
889
value = string_to_delta("2h")
890
self.assertEqual(value, datetime.timedelta(0, 7200))
893
class Test_check_option_syntax(unittest.TestCase):
895
self.parser = argparse.ArgumentParser()
896
add_command_line_options(self.parser)
898
def test_actions_requires_client_or_all(self):
899
for action, value in self.actions.items():
900
options = self.parser.parse_args()
901
setattr(options, action, value)
902
with self.assertParseError():
903
self.check_option_syntax(options)
905
# This mostly corresponds to the definition from has_actions() in
906
# check_option_syntax()
908
# The actual values set here are not that important, but we do
909
# at least stick to the correct types, even though they are
913
"bump_timeout": True,
914
"start_checker": True,
915
"stop_checker": True,
919
"timeout": datetime.timedelta(),
920
"extended_timeout": datetime.timedelta(),
921
"interval": datetime.timedelta(),
922
"approved_by_default": True,
923
"approval_delay": datetime.timedelta(),
924
"approval_duration": datetime.timedelta(),
926
"secret": io.BytesIO(b"x"),
931
@contextlib.contextmanager
932
def assertParseError(self):
933
with self.assertRaises(SystemExit) as e:
934
with self.redirect_stderr_to_devnull():
936
# Exit code from argparse is guaranteed to be "2". Reference:
937
# https://docs.python.org/3/library
938
# /argparse.html#exiting-methods
939
self.assertEqual(e.exception.code, 2)
942
@contextlib.contextmanager
943
def redirect_stderr_to_devnull():
944
null = os.open(os.path.devnull, os.O_RDWR)
945
stderrcopy = os.dup(sys.stderr.fileno())
946
os.dup2(null, sys.stderr.fileno())
371
mandos_clients = {path: ifs_and_props[client_interface]
372
for path, ifs_and_props in
373
mandos_serv_object_manager
374
.GetManagedObjects().items()
375
if client_interface in ifs_and_props}
378
952
os.dup2(stderrcopy, sys.stderr.fileno())
379
953
os.close(stderrcopy)
380
except dbus.exceptions.DBusException as e:
381
print("Access denied: "
382
"Accessing mandos server through D-Bus: {}".format(e),
386
# Compile dict of (clients: properties) to process
389
if options.all or not options.client:
390
clients = {bus.get_object(busname, path): properties
391
for path, properties in mandos_clients.items()}
393
for name in options.client:
394
for path, client in mandos_clients.items():
395
if client["Name"] == name:
396
client_objc = bus.get_object(busname, path)
397
clients[client_objc] = client
400
print("Client not found on server: {!r}"
401
.format(name), file=sys.stderr)
404
if not has_actions(options) and clients:
405
if options.verbose or options.dump_json:
406
keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
407
"Created", "Interval", "Host", "Fingerprint",
408
"CheckerRunning", "LastEnabled",
409
"ApprovalPending", "ApprovedByDefault",
410
"LastApprovalRequest", "ApprovalDelay",
411
"ApprovalDuration", "Checker",
412
"ExtendedTimeout", "Expires",
415
keywords = defaultkeywords
417
if options.dump_json:
418
json.dump({client["Name"]: {key:
420
if isinstance(client[key],
424
for client in clients.values()},
425
fp=sys.stdout, indent=4,
426
separators=(',', ': '))
429
print_clients(clients.values(), keywords)
431
# Process each client in the list by all selected options
432
for client in clients:
434
def set_client_prop(prop, value):
435
"""Set a Client D-Bus property"""
436
client.Set(client_interface, prop, value,
437
dbus_interface=dbus.PROPERTIES_IFACE)
439
def set_client_prop_ms(prop, value):
440
"""Set a Client D-Bus property, converted
441
from a string to milliseconds."""
442
set_client_prop(prop,
443
string_to_delta(value).total_seconds()
447
mandos_serv.RemoveClient(client.__dbus_object_path__)
449
set_client_prop("Enabled", dbus.Boolean(True))
451
set_client_prop("Enabled", dbus.Boolean(False))
452
if options.bump_timeout:
453
set_client_prop("LastCheckedOK", "")
454
if options.start_checker:
455
set_client_prop("CheckerRunning", dbus.Boolean(True))
456
if options.stop_checker:
457
set_client_prop("CheckerRunning", dbus.Boolean(False))
458
if options.is_enabled:
459
if client.Get(client_interface, "Enabled",
460
dbus_interface=dbus.PROPERTIES_IFACE):
464
if options.checker is not None:
465
set_client_prop("Checker", options.checker)
466
if options.host is not None:
467
set_client_prop("Host", options.host)
468
if options.interval is not None:
469
set_client_prop_ms("Interval", options.interval)
470
if options.approval_delay is not None:
471
set_client_prop_ms("ApprovalDelay",
472
options.approval_delay)
473
if options.approval_duration is not None:
474
set_client_prop_ms("ApprovalDuration",
475
options.approval_duration)
476
if options.timeout is not None:
477
set_client_prop_ms("Timeout", options.timeout)
478
if options.extended_timeout is not None:
479
set_client_prop_ms("ExtendedTimeout",
480
options.extended_timeout)
481
if options.secret is not None:
482
set_client_prop("Secret",
483
dbus.ByteArray(options.secret.read()))
484
if options.approved_by_default is not None:
485
set_client_prop("ApprovedByDefault",
487
.approved_by_default))
489
client.Approve(dbus.Boolean(True),
490
dbus_interface=client_interface)
492
client.Approve(dbus.Boolean(False),
493
dbus_interface=client_interface)
955
def check_option_syntax(self, options):
956
check_option_syntax(self.parser, options)
958
def test_actions_all_conflicts_with_verbose(self):
959
for action, value in self.actions.items():
960
options = self.parser.parse_args()
961
setattr(options, action, value)
963
options.verbose = True
964
with self.assertParseError():
965
self.check_option_syntax(options)
967
def test_actions_with_client_conflicts_with_verbose(self):
968
for action, value in self.actions.items():
969
options = self.parser.parse_args()
970
setattr(options, action, value)
971
options.verbose = True
972
options.client = ["foo"]
973
with self.assertParseError():
974
self.check_option_syntax(options)
976
def test_dump_json_conflicts_with_verbose(self):
977
options = self.parser.parse_args()
978
options.dump_json = True
979
options.verbose = True
980
with self.assertParseError():
981
self.check_option_syntax(options)
983
def test_dump_json_conflicts_with_action(self):
984
for action, value in self.actions.items():
985
options = self.parser.parse_args()
986
setattr(options, action, value)
987
options.dump_json = True
988
with self.assertParseError():
989
self.check_option_syntax(options)
991
def test_all_can_not_be_alone(self):
992
options = self.parser.parse_args()
994
with self.assertParseError():
995
self.check_option_syntax(options)
997
def test_all_is_ok_with_any_action(self):
998
for action, value in self.actions.items():
999
options = self.parser.parse_args()
1000
setattr(options, action, value)
1002
self.check_option_syntax(options)
1004
def test_any_action_is_ok_with_one_client(self):
1005
for action, value in self.actions.items():
1006
options = self.parser.parse_args()
1007
setattr(options, action, value)
1008
options.client = ["foo"]
1009
self.check_option_syntax(options)
1011
def test_one_client_with_all_actions_except_is_enabled(self):
1012
options = self.parser.parse_args()
1013
for action, value in self.actions.items():
1014
if action == "is_enabled":
1016
setattr(options, action, value)
1017
options.client = ["foo"]
1018
self.check_option_syntax(options)
1020
def test_two_clients_with_all_actions_except_is_enabled(self):
1021
options = self.parser.parse_args()
1022
for action, value in self.actions.items():
1023
if action == "is_enabled":
1025
setattr(options, action, value)
1026
options.client = ["foo", "barbar"]
1027
self.check_option_syntax(options)
1029
def test_two_clients_are_ok_with_actions_except_is_enabled(self):
1030
for action, value in self.actions.items():
1031
if action == "is_enabled":
1033
options = self.parser.parse_args()
1034
setattr(options, action, value)
1035
options.client = ["foo", "barbar"]
1036
self.check_option_syntax(options)
1038
def test_is_enabled_fails_without_client(self):
1039
options = self.parser.parse_args()
1040
options.is_enabled = True
1041
with self.assertParseError():
1042
self.check_option_syntax(options)
1044
def test_is_enabled_fails_with_two_clients(self):
1045
options = self.parser.parse_args()
1046
options.is_enabled = True
1047
options.client = ["foo", "barbar"]
1048
with self.assertParseError():
1049
self.check_option_syntax(options)
1051
def test_remove_can_only_be_combined_with_action_deny(self):
1052
for action, value in self.actions.items():
1053
if action in {"remove", "deny"}:
1055
options = self.parser.parse_args()
1056
setattr(options, action, value)
1058
options.remove = True
1059
with self.assertParseError():
1060
self.check_option_syntax(options)
1063
class Test_get_mandos_dbus_object(TestCaseWithAssertLogs):
1064
def test_calls_and_returns_get_object_on_bus(self):
1065
class MockBus(object):
1067
def get_object(mockbus_self, busname, dbus_path):
1068
# Note that "self" is still the testcase instance,
1069
# this MockBus instance is in "mockbus_self".
1070
self.assertEqual(busname, dbus_busname)
1071
self.assertEqual(dbus_path, server_dbus_path)
1072
mockbus_self.called = True
1075
mockbus = get_mandos_dbus_object(bus=MockBus())
1076
self.assertIsInstance(mockbus, MockBus)
1077
self.assertTrue(mockbus.called)
1079
def test_logs_and_exits_on_dbus_error(self):
1080
class MockBusFailing(object):
1081
def get_object(self, busname, dbus_path):
1082
raise dbus.exceptions.DBusException("Test")
1084
with self.assertLogs(log, logging.CRITICAL):
1085
with self.assertRaises(SystemExit) as e:
1086
bus = get_mandos_dbus_object(bus=MockBusFailing())
1088
if isinstance(e.exception.code, int):
1089
self.assertNotEqual(e.exception.code, 0)
1091
self.assertIsNotNone(e.exception.code)
1094
class Test_get_managed_objects(TestCaseWithAssertLogs):
1095
def test_calls_and_returns_GetManagedObjects(self):
1096
managed_objects = {"/clients/foo": { "Name": "foo"}}
1097
class MockObjectManager(object):
1098
def GetManagedObjects(self):
1099
return managed_objects
1100
retval = get_managed_objects(MockObjectManager())
1101
self.assertDictEqual(managed_objects, retval)
1103
def test_logs_and_exits_on_dbus_error(self):
1104
dbus_logger = logging.getLogger("dbus.proxies")
1106
class MockObjectManagerFailing(object):
1107
def GetManagedObjects(self):
1108
dbus_logger.error("Test")
1109
raise dbus.exceptions.DBusException("Test")
1111
class CountingHandler(logging.Handler):
1113
def emit(self, record):
1116
counting_handler = CountingHandler()
1118
dbus_logger.addHandler(counting_handler)
1121
with self.assertLogs(log, logging.CRITICAL) as watcher:
1122
with self.assertRaises(SystemExit) as e:
1123
get_managed_objects(MockObjectManagerFailing())
1125
dbus_logger.removeFilter(counting_handler)
1127
# Make sure the dbus logger was suppressed
1128
self.assertEqual(counting_handler.count, 0)
1130
# Test that the dbus_logger still works
1131
with self.assertLogs(dbus_logger, logging.ERROR):
1132
dbus_logger.error("Test")
1134
if isinstance(e.exception.code, int):
1135
self.assertNotEqual(e.exception.code, 0)
1137
self.assertIsNotNone(e.exception.code)
1140
class Test_commands_from_options(unittest.TestCase):
1142
self.parser = argparse.ArgumentParser()
1143
add_command_line_options(self.parser)
1145
def test_is_enabled(self):
1146
self.assert_command_from_args(["--is-enabled", "foo"],
1149
def assert_command_from_args(self, args, command_cls,
1151
"""Assert that parsing ARGS should result in an instance of
1152
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
1153
options = self.parser.parse_args(args)
1154
check_option_syntax(self.parser, options)
1155
commands = commands_from_options(options)
1156
self.assertEqual(len(commands), 1)
1157
command = commands[0]
1158
self.assertIsInstance(command, command_cls)
1159
for key, value in cmd_attrs.items():
1160
self.assertEqual(getattr(command, key), value)
1162
def test_is_enabled_short(self):
1163
self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
1165
def test_approve(self):
1166
self.assert_command_from_args(["--approve", "foo"],
1169
def test_approve_short(self):
1170
self.assert_command_from_args(["-A", "foo"], ApproveCmd)
1172
def test_deny(self):
1173
self.assert_command_from_args(["--deny", "foo"], DenyCmd)
1175
def test_deny_short(self):
1176
self.assert_command_from_args(["-D", "foo"], DenyCmd)
1178
def test_remove(self):
1179
self.assert_command_from_args(["--remove", "foo"],
1182
def test_deny_before_remove(self):
1183
options = self.parser.parse_args(["--deny", "--remove",
1185
check_option_syntax(self.parser, options)
1186
commands = commands_from_options(options)
1187
self.assertEqual(len(commands), 2)
1188
self.assertIsInstance(commands[0], DenyCmd)
1189
self.assertIsInstance(commands[1], RemoveCmd)
1191
def test_deny_before_remove_reversed(self):
1192
options = self.parser.parse_args(["--remove", "--deny",
1194
check_option_syntax(self.parser, options)
1195
commands = commands_from_options(options)
1196
self.assertEqual(len(commands), 2)
1197
self.assertIsInstance(commands[0], DenyCmd)
1198
self.assertIsInstance(commands[1], RemoveCmd)
1200
def test_remove_short(self):
1201
self.assert_command_from_args(["-r", "foo"], RemoveCmd)
1203
def test_dump_json(self):
1204
self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
1206
def test_enable(self):
1207
self.assert_command_from_args(["--enable", "foo"], EnableCmd)
1209
def test_enable_short(self):
1210
self.assert_command_from_args(["-e", "foo"], EnableCmd)
1212
def test_disable(self):
1213
self.assert_command_from_args(["--disable", "foo"],
1216
def test_disable_short(self):
1217
self.assert_command_from_args(["-d", "foo"], DisableCmd)
1219
def test_bump_timeout(self):
1220
self.assert_command_from_args(["--bump-timeout", "foo"],
1223
def test_bump_timeout_short(self):
1224
self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
1226
def test_start_checker(self):
1227
self.assert_command_from_args(["--start-checker", "foo"],
1230
def test_stop_checker(self):
1231
self.assert_command_from_args(["--stop-checker", "foo"],
1234
def test_approve_by_default(self):
1235
self.assert_command_from_args(["--approve-by-default", "foo"],
1236
ApproveByDefaultCmd)
1238
def test_deny_by_default(self):
1239
self.assert_command_from_args(["--deny-by-default", "foo"],
1242
def test_checker(self):
1243
self.assert_command_from_args(["--checker", ":", "foo"],
1244
SetCheckerCmd, value_to_set=":")
1246
def test_checker_empty(self):
1247
self.assert_command_from_args(["--checker", "", "foo"],
1248
SetCheckerCmd, value_to_set="")
1250
def test_checker_short(self):
1251
self.assert_command_from_args(["-c", ":", "foo"],
1252
SetCheckerCmd, value_to_set=":")
1254
def test_host(self):
1255
self.assert_command_from_args(["--host", "foo.example.org",
1257
value_to_set="foo.example.org")
1259
def test_host_short(self):
1260
self.assert_command_from_args(["-H", "foo.example.org",
1262
value_to_set="foo.example.org")
1264
def test_secret_devnull(self):
1265
self.assert_command_from_args(["--secret", os.path.devnull,
1266
"foo"], SetSecretCmd,
1269
def test_secret_tempfile(self):
1270
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1271
value = b"secret\0xyzzy\nbar"
1274
self.assert_command_from_args(["--secret", f.name,
1275
"foo"], SetSecretCmd,
1278
def test_secret_devnull_short(self):
1279
self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1280
SetSecretCmd, value_to_set=b"")
1282
def test_secret_tempfile_short(self):
1283
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1284
value = b"secret\0xyzzy\nbar"
1287
self.assert_command_from_args(["-s", f.name, "foo"],
1291
def test_timeout(self):
1292
self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1294
value_to_set=300000)
1296
def test_timeout_short(self):
1297
self.assert_command_from_args(["-t", "PT5M", "foo"],
1299
value_to_set=300000)
1301
def test_extended_timeout(self):
1302
self.assert_command_from_args(["--extended-timeout", "PT15M",
1304
SetExtendedTimeoutCmd,
1305
value_to_set=900000)
1307
def test_interval(self):
1308
self.assert_command_from_args(["--interval", "PT2M", "foo"],
1310
value_to_set=120000)
1312
def test_interval_short(self):
1313
self.assert_command_from_args(["-i", "PT2M", "foo"],
1315
value_to_set=120000)
1317
def test_approval_delay(self):
1318
self.assert_command_from_args(["--approval-delay", "PT30S",
1319
"foo"], SetApprovalDelayCmd,
1322
def test_approval_duration(self):
1323
self.assert_command_from_args(["--approval-duration", "PT1S",
1324
"foo"], SetApprovalDurationCmd,
1327
def test_print_table(self):
1328
self.assert_command_from_args([], PrintTableCmd,
1331
def test_print_table_verbose(self):
1332
self.assert_command_from_args(["--verbose"], PrintTableCmd,
1335
def test_print_table_verbose_short(self):
1336
self.assert_command_from_args(["-v"], PrintTableCmd,
1340
class TestCmd(unittest.TestCase):
1341
"""Abstract class for tests of command classes"""
1345
class MockClient(object):
1346
def __init__(self, name, **attributes):
1347
self.__dbus_object_path__ = "/clients/{}".format(name)
1348
self.attributes = attributes
1349
self.attributes["Name"] = name
1351
def Set(self, interface, propname, value, dbus_interface):
1352
testcase.assertEqual(interface, client_dbus_interface)
1353
testcase.assertEqual(dbus_interface,
1354
dbus.PROPERTIES_IFACE)
1355
self.attributes[propname] = value
1356
def Get(self, interface, propname, dbus_interface):
1357
testcase.assertEqual(interface, client_dbus_interface)
1358
testcase.assertEqual(dbus_interface,
1359
dbus.PROPERTIES_IFACE)
1360
return self.attributes[propname]
1361
def Approve(self, approve, dbus_interface):
1362
testcase.assertEqual(dbus_interface,
1363
client_dbus_interface)
1364
self.calls.append(("Approve", (approve,
1366
self.client = MockClient(
1368
KeyID=("92ed150794387c03ce684574b1139a65"
1369
"94a34f895daaaf09fd8ea90a27cddb12"),
1371
Host="foo.example.org",
1372
Enabled=dbus.Boolean(True),
1374
LastCheckedOK="2019-02-03T00:00:00",
1375
Created="2019-01-02T00:00:00",
1377
Fingerprint=("778827225BA7DE539C5A"
1378
"7CFA59CFF7CDBD9A5920"),
1379
CheckerRunning=dbus.Boolean(False),
1380
LastEnabled="2019-01-03T00:00:00",
1381
ApprovalPending=dbus.Boolean(False),
1382
ApprovedByDefault=dbus.Boolean(True),
1383
LastApprovalRequest="",
1385
ApprovalDuration=1000,
1386
Checker="fping -q -- %(host)s",
1387
ExtendedTimeout=900000,
1388
Expires="2019-02-04T00:00:00",
1389
LastCheckerStatus=0)
1390
self.other_client = MockClient(
1392
KeyID=("0558568eedd67d622f5c83b35a115f79"
1393
"6ab612cff5ad227247e46c2b020f441c"),
1394
Secret=b"secretbar",
1396
Enabled=dbus.Boolean(True),
1398
LastCheckedOK="2019-02-04T00:00:00",
1399
Created="2019-01-03T00:00:00",
1401
Fingerprint=("3E393AEAEFB84C7E89E2"
1402
"F547B3A107558FCA3A27"),
1403
CheckerRunning=dbus.Boolean(True),
1404
LastEnabled="2019-01-04T00:00:00",
1405
ApprovalPending=dbus.Boolean(False),
1406
ApprovedByDefault=dbus.Boolean(False),
1407
LastApprovalRequest="2019-01-03T00:00:00",
1408
ApprovalDelay=30000,
1409
ApprovalDuration=93785000,
1411
ExtendedTimeout=900000,
1412
Expires="2019-02-05T00:00:00",
1413
LastCheckerStatus=-2)
1414
self.clients = collections.OrderedDict(
1416
("/clients/foo", self.client.attributes),
1417
("/clients/barbar", self.other_client.attributes),
1419
self.one_client = {"/clients/foo": self.client.attributes}
1425
def get_object(client_bus_name, path):
1426
self.assertEqual(client_bus_name, dbus_busname)
1428
# Note: "self" here is the TestCmd instance, not
1429
# the Bus instance, since this is a static method!
1430
"/clients/foo": self.client,
1431
"/clients/barbar": self.other_client,
1436
class TestIsEnabledCmd(TestCmd):
1437
def test_is_enabled(self):
1438
self.assertTrue(all(IsEnabledCmd().is_enabled(client,
1440
for client, properties
1441
in self.clients.items()))
1443
def test_is_enabled_run_exits_successfully(self):
1444
with self.assertRaises(SystemExit) as e:
1445
IsEnabledCmd().run(self.one_client)
1446
if e.exception.code is not None:
1447
self.assertEqual(e.exception.code, 0)
1449
self.assertIsNone(e.exception.code)
1451
def test_is_enabled_run_exits_with_failure(self):
1452
self.client.attributes["Enabled"] = dbus.Boolean(False)
1453
with self.assertRaises(SystemExit) as e:
1454
IsEnabledCmd().run(self.one_client)
1455
if isinstance(e.exception.code, int):
1456
self.assertNotEqual(e.exception.code, 0)
1458
self.assertIsNotNone(e.exception.code)
1461
class TestApproveCmd(TestCmd):
1462
def test_approve(self):
1463
ApproveCmd().run(self.clients, self.bus)
1464
for clientpath in self.clients:
1465
client = self.bus.get_object(dbus_busname, clientpath)
1466
self.assertIn(("Approve", (True, client_dbus_interface)),
1470
class TestDenyCmd(TestCmd):
1471
def test_deny(self):
1472
DenyCmd().run(self.clients, self.bus)
1473
for clientpath in self.clients:
1474
client = self.bus.get_object(dbus_busname, clientpath)
1475
self.assertIn(("Approve", (False, client_dbus_interface)),
1479
class TestRemoveCmd(TestCmd):
1480
def test_remove(self):
1481
class MockMandos(object):
1484
def RemoveClient(self, dbus_path):
1485
self.calls.append(("RemoveClient", (dbus_path,)))
1486
mandos = MockMandos()
1487
super(TestRemoveCmd, self).setUp()
1488
RemoveCmd().run(self.clients, self.bus, mandos)
1489
self.assertEqual(len(mandos.calls), 2)
1490
for clientpath in self.clients:
1491
self.assertIn(("RemoveClient", (clientpath,)),
1495
class TestDumpJSONCmd(TestCmd):
1497
self.expected_json = {
1500
"KeyID": ("92ed150794387c03ce684574b1139a65"
1501
"94a34f895daaaf09fd8ea90a27cddb12"),
1502
"Host": "foo.example.org",
1505
"LastCheckedOK": "2019-02-03T00:00:00",
1506
"Created": "2019-01-02T00:00:00",
1508
"Fingerprint": ("778827225BA7DE539C5A"
1509
"7CFA59CFF7CDBD9A5920"),
1510
"CheckerRunning": False,
1511
"LastEnabled": "2019-01-03T00:00:00",
1512
"ApprovalPending": False,
1513
"ApprovedByDefault": True,
1514
"LastApprovalRequest": "",
1516
"ApprovalDuration": 1000,
1517
"Checker": "fping -q -- %(host)s",
1518
"ExtendedTimeout": 900000,
1519
"Expires": "2019-02-04T00:00:00",
1520
"LastCheckerStatus": 0,
1524
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
1525
"6ab612cff5ad227247e46c2b020f441c"),
1526
"Host": "192.0.2.3",
1529
"LastCheckedOK": "2019-02-04T00:00:00",
1530
"Created": "2019-01-03T00:00:00",
1532
"Fingerprint": ("3E393AEAEFB84C7E89E2"
1533
"F547B3A107558FCA3A27"),
1534
"CheckerRunning": True,
1535
"LastEnabled": "2019-01-04T00:00:00",
1536
"ApprovalPending": False,
1537
"ApprovedByDefault": False,
1538
"LastApprovalRequest": "2019-01-03T00:00:00",
1539
"ApprovalDelay": 30000,
1540
"ApprovalDuration": 93785000,
1542
"ExtendedTimeout": 900000,
1543
"Expires": "2019-02-05T00:00:00",
1544
"LastCheckerStatus": -2,
1547
return super(TestDumpJSONCmd, self).setUp()
1549
def test_normal(self):
1550
output = DumpJSONCmd().output(self.clients.values())
1551
json_data = json.loads(output)
1552
self.assertDictEqual(json_data, self.expected_json)
1554
def test_one_client(self):
1555
output = DumpJSONCmd().output(self.one_client.values())
1556
json_data = json.loads(output)
1557
expected_json = {"foo": self.expected_json["foo"]}
1558
self.assertDictEqual(json_data, expected_json)
1561
class TestPrintTableCmd(TestCmd):
1562
def test_normal(self):
1563
output = PrintTableCmd().output(self.clients.values())
1564
expected_output = "\n".join((
1565
"Name Enabled Timeout Last Successful Check",
1566
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1567
"barbar Yes 00:05:00 2019-02-04T00:00:00 ",
1569
self.assertEqual(output, expected_output)
1571
def test_verbose(self):
1572
output = PrintTableCmd(verbose=True).output(
1573
self.clients.values())
1588
"Last Successful Check ",
1589
"2019-02-03T00:00:00 ",
1590
"2019-02-04T00:00:00 ",
1593
"2019-01-02T00:00:00 ",
1594
"2019-01-03T00:00:00 ",
1606
("92ed150794387c03ce684574b1139a6594a34f895daaaf09fd8"
1608
("0558568eedd67d622f5c83b35a115f796ab612cff5ad227247e"
1612
"778827225BA7DE539C5A7CFA59CFF7CDBD9A5920 ",
1613
"3E393AEAEFB84C7E89E2F547B3A107558FCA3A27 ",
1615
"Check Is Running ",
1620
"2019-01-03T00:00:00 ",
1621
"2019-01-04T00:00:00 ",
1623
"Approval Is Pending ",
1627
"Approved By Default ",
1631
"Last Approval Request ",
1633
"2019-01-03T00:00:00 ",
1639
"Approval Duration ",
1644
"fping -q -- %(host)s ",
1647
"Extended Timeout ",
1652
"2019-02-04T00:00:00 ",
1653
"2019-02-05T00:00:00 ",
1655
"Last Checker Status",
1660
num_lines = max(len(rows) for rows in columns)
1661
expected_output = "\n".join("".join(rows[line]
1662
for rows in columns)
1663
for line in range(num_lines))
1664
self.assertEqual(output, expected_output)
1666
def test_one_client(self):
1667
output = PrintTableCmd().output(self.one_client.values())
1668
expected_output = "\n".join((
1669
"Name Enabled Timeout Last Successful Check",
1670
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1672
self.assertEqual(output, expected_output)
1675
class TestPropertyCmd(TestCmd):
1676
"""Abstract class for tests of PropertyCmd classes"""
1678
if not hasattr(self, "command"):
1680
values_to_get = getattr(self, "values_to_get",
1682
for value_to_set, value_to_get in zip(self.values_to_set,
1684
for clientpath in self.clients:
1685
client = self.bus.get_object(dbus_busname, clientpath)
1686
old_value = client.attributes[self.propname]
1687
self.assertNotIsInstance(old_value, self.Unique)
1688
client.attributes[self.propname] = self.Unique()
1689
self.run_command(value_to_set, self.clients)
1690
for clientpath in self.clients:
1691
client = self.bus.get_object(dbus_busname, clientpath)
1692
value = client.attributes[self.propname]
1693
self.assertNotIsInstance(value, self.Unique)
1694
self.assertEqual(value, value_to_get)
1696
class Unique(object):
1697
"""Class for objects which exist only to be unique objects,
1698
since unittest.mock.sentinel only exists in Python 3.3"""
1700
def run_command(self, value, clients):
1701
self.command().run(clients, self.bus)
1704
class TestEnableCmd(TestPropertyCmd):
1706
propname = "Enabled"
1707
values_to_set = [dbus.Boolean(True)]
1710
class TestDisableCmd(TestPropertyCmd):
1711
command = DisableCmd
1712
propname = "Enabled"
1713
values_to_set = [dbus.Boolean(False)]
1716
class TestBumpTimeoutCmd(TestPropertyCmd):
1717
command = BumpTimeoutCmd
1718
propname = "LastCheckedOK"
1719
values_to_set = [""]
1722
class TestStartCheckerCmd(TestPropertyCmd):
1723
command = StartCheckerCmd
1724
propname = "CheckerRunning"
1725
values_to_set = [dbus.Boolean(True)]
1728
class TestStopCheckerCmd(TestPropertyCmd):
1729
command = StopCheckerCmd
1730
propname = "CheckerRunning"
1731
values_to_set = [dbus.Boolean(False)]
1734
class TestApproveByDefaultCmd(TestPropertyCmd):
1735
command = ApproveByDefaultCmd
1736
propname = "ApprovedByDefault"
1737
values_to_set = [dbus.Boolean(True)]
1740
class TestDenyByDefaultCmd(TestPropertyCmd):
1741
command = DenyByDefaultCmd
1742
propname = "ApprovedByDefault"
1743
values_to_set = [dbus.Boolean(False)]
1746
class TestPropertyValueCmd(TestPropertyCmd):
1747
"""Abstract class for tests of PropertyValueCmd classes"""
1750
if type(self) is TestPropertyValueCmd:
1752
return super(TestPropertyValueCmd, self).runTest()
1754
def run_command(self, value, clients):
1755
self.command(value).run(clients, self.bus)
1758
class TestSetCheckerCmd(TestPropertyValueCmd):
1759
command = SetCheckerCmd
1760
propname = "Checker"
1761
values_to_set = ["", ":", "fping -q -- %s"]
1764
class TestSetHostCmd(TestPropertyValueCmd):
1765
command = SetHostCmd
1767
values_to_set = ["192.0.2.3", "foo.example.org"]
1770
class TestSetSecretCmd(TestPropertyValueCmd):
1771
command = SetSecretCmd
1773
values_to_set = [io.BytesIO(b""),
1774
io.BytesIO(b"secret\0xyzzy\nbar")]
1775
values_to_get = [b"", b"secret\0xyzzy\nbar"]
1778
class TestSetTimeoutCmd(TestPropertyValueCmd):
1779
command = SetTimeoutCmd
1780
propname = "Timeout"
1781
values_to_set = [datetime.timedelta(),
1782
datetime.timedelta(minutes=5),
1783
datetime.timedelta(seconds=1),
1784
datetime.timedelta(weeks=1),
1785
datetime.timedelta(weeks=52)]
1786
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1789
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
1790
command = SetExtendedTimeoutCmd
1791
propname = "ExtendedTimeout"
1792
values_to_set = [datetime.timedelta(),
1793
datetime.timedelta(minutes=5),
1794
datetime.timedelta(seconds=1),
1795
datetime.timedelta(weeks=1),
1796
datetime.timedelta(weeks=52)]
1797
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1800
class TestSetIntervalCmd(TestPropertyValueCmd):
1801
command = SetIntervalCmd
1802
propname = "Interval"
1803
values_to_set = [datetime.timedelta(),
1804
datetime.timedelta(minutes=5),
1805
datetime.timedelta(seconds=1),
1806
datetime.timedelta(weeks=1),
1807
datetime.timedelta(weeks=52)]
1808
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1811
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
1812
command = SetApprovalDelayCmd
1813
propname = "ApprovalDelay"
1814
values_to_set = [datetime.timedelta(),
1815
datetime.timedelta(minutes=5),
1816
datetime.timedelta(seconds=1),
1817
datetime.timedelta(weeks=1),
1818
datetime.timedelta(weeks=52)]
1819
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1822
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
1823
command = SetApprovalDurationCmd
1824
propname = "ApprovalDuration"
1825
values_to_set = [datetime.timedelta(),
1826
datetime.timedelta(minutes=5),
1827
datetime.timedelta(seconds=1),
1828
datetime.timedelta(weeks=1),
1829
datetime.timedelta(weeks=52)]
1830
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1834
def should_only_run_tests():
1835
parser = argparse.ArgumentParser(add_help=False)
1836
parser.add_argument("--check", action='store_true')
1837
args, unknown_args = parser.parse_known_args()
1838
run_tests = args.check
1840
# Remove --check argument from sys.argv
1841
sys.argv[1:] = unknown_args
1844
# Add all tests from doctest strings
1845
def load_tests(loader, tests, none):
1847
tests.addTests(doctest.DocTestSuite())
496
1850
if __name__ == "__main__":
1852
if should_only_run_tests():
1853
# Call using ./tdd-python-script --check [--verbose]