343
417
parser.error("--dump-json can only be used alone.")
344
418
if options.all and not has_actions(options):
345
419
parser.error("--all requires an action.")
348
fail_count, test_count = doctest.testmod()
349
sys.exit(os.EX_OK if fail_count == 0 else 1)
352
bus = dbus.SystemBus()
353
mandos_dbus_objc = bus.get_object(busname, server_path)
354
except dbus.exceptions.DBusException:
355
print("Could not connect to Mandos server", file=sys.stderr)
358
mandos_serv = dbus.Interface(mandos_dbus_objc,
359
dbus_interface=server_interface)
360
mandos_serv_object_manager = dbus.Interface(
361
mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
363
# block stderr since dbus library prints to stderr
364
null = os.open(os.path.devnull, os.O_RDWR)
365
stderrcopy = os.dup(sys.stderr.fileno())
366
os.dup2(null, sys.stderr.fileno())
370
mandos_clients = {path: ifs_and_props[client_interface]
371
for path, ifs_and_props in
372
mandos_serv_object_manager
373
.GetManagedObjects().items()
374
if client_interface in ifs_and_props}
377
os.dup2(stderrcopy, sys.stderr.fileno())
420
if options.is_enabled and len(options.client) > 1:
421
parser.error("--is-enabled requires exactly one client")
423
options.remove = False
424
if has_actions(options) and not options.deny:
425
parser.error("--remove can only be combined with --deny")
426
options.remove = True
429
def get_mandos_dbus_object(bus):
430
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
431
dbus_busname, server_dbus_path)
432
with if_dbus_exception_log_with_exception_and_exit(
433
"Could not connect to Mandos server: %s"):
434
mandos_dbus_object = bus.get_object(dbus_busname,
436
return mandos_dbus_object
439
@contextlib.contextmanager
440
def if_dbus_exception_log_with_exception_and_exit(*args, **kwargs):
379
443
except dbus.exceptions.DBusException as e:
380
print("Access denied: "
381
"Accessing mandos server through D-Bus: {}".format(e),
444
log.critical(*(args + (e,)), **kwargs)
385
# Compile dict of (clients: properties) to process
388
if options.all or not options.client:
389
clients = {bus.get_object(busname, path): properties
390
for path, properties in mandos_clients.items()}
392
for name in options.client:
393
for path, client in mandos_clients.items():
394
if client["Name"] == name:
395
client_objc = bus.get_object(busname, path)
396
clients[client_objc] = client
399
print("Client not found on server: {!r}"
400
.format(name), file=sys.stderr)
403
if not has_actions(options) and clients:
404
if options.verbose or options.dump_json:
405
keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
406
"Created", "Interval", "Host", "Fingerprint",
407
"CheckerRunning", "LastEnabled",
408
"ApprovalPending", "ApprovedByDefault",
409
"LastApprovalRequest", "ApprovalDelay",
410
"ApprovalDuration", "Checker",
411
"ExtendedTimeout", "Expires",
448
def get_managed_objects(object_manager):
449
log.debug("D-Bus: %s:%s:%s.GetManagedObjects()", dbus_busname,
450
server_dbus_path, dbus.OBJECT_MANAGER_IFACE)
451
with if_dbus_exception_log_with_exception_and_exit(
452
"Failed to access Mandos server through D-Bus:\n%s"):
453
with SilenceLogger("dbus.proxies"):
454
managed_objects = object_manager.GetManagedObjects()
455
return managed_objects
458
class SilenceLogger(object):
459
"Simple context manager to silence a particular logger"
460
def __init__(self, loggername):
461
self.logger = logging.getLogger(loggername)
464
self.logger.addFilter(self.nullfilter)
467
class NullFilter(logging.Filter):
468
def filter(self, record):
471
nullfilter = NullFilter()
473
def __exit__(self, exc_type, exc_val, exc_tb):
474
self.logger.removeFilter(self.nullfilter)
477
def commands_from_options(options):
481
if options.is_enabled:
482
commands.append(command.IsEnabled())
485
commands.append(command.Approve())
488
commands.append(command.Deny())
491
commands.append(command.Remove())
493
if options.dump_json:
494
commands.append(command.DumpJSON())
497
commands.append(command.Enable())
500
commands.append(command.Disable())
502
if options.bump_timeout:
503
commands.append(command.BumpTimeout())
505
if options.start_checker:
506
commands.append(command.StartChecker())
508
if options.stop_checker:
509
commands.append(command.StopChecker())
511
if options.approved_by_default is not None:
512
if options.approved_by_default:
513
commands.append(command.ApproveByDefault())
515
commands.append(command.DenyByDefault())
517
if options.checker is not None:
518
commands.append(command.SetChecker(options.checker))
520
if options.host is not None:
521
commands.append(command.SetHost(options.host))
523
if options.secret is not None:
524
commands.append(command.SetSecret(options.secret))
526
if options.timeout is not None:
527
commands.append(command.SetTimeout(options.timeout))
529
if options.extended_timeout:
531
command.SetExtendedTimeout(options.extended_timeout))
533
if options.interval is not None:
534
commands.append(command.SetInterval(options.interval))
536
if options.approval_delay is not None:
538
command.SetApprovalDelay(options.approval_delay))
540
if options.approval_duration is not None:
542
command.SetApprovalDuration(options.approval_duration))
544
# If no command option has been given, show table of clients,
545
# optionally verbosely
547
commands.append(command.PrintTable(verbose=options.verbose))
552
class command(object):
553
"""A namespace for command classes"""
556
"""Abstract base class for commands"""
557
def run(self, clients, bus=None, mandos=None):
558
"""Normal commands should implement run_on_one_client(),
559
but commands which want to operate on all clients at the same time can
560
override this run() method instead.
563
for clientpath, properties in clients.items():
564
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
565
dbus_busname, str(clientpath))
566
client = bus.get_object(dbus_busname, clientpath)
567
self.run_on_one_client(client, properties)
570
class IsEnabled(Base):
571
def run(self, clients, bus=None, mandos=None):
572
client, properties = next(iter(clients.items()))
573
if self.is_enabled(client, properties):
576
def is_enabled(self, client, properties):
577
return properties["Enabled"]
581
def run_on_one_client(self, client, properties):
582
log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
583
client.__dbus_object_path__,
584
client_dbus_interface)
585
client.Approve(dbus.Boolean(True),
586
dbus_interface=client_dbus_interface)
590
def run_on_one_client(self, client, properties):
591
log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
592
client.__dbus_object_path__,
593
client_dbus_interface)
594
client.Approve(dbus.Boolean(False),
595
dbus_interface=client_dbus_interface)
599
def run_on_one_client(self, client, properties):
600
log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)",
601
dbus_busname, server_dbus_path,
602
server_dbus_interface,
603
str(client.__dbus_object_path__))
604
self.mandos.RemoveClient(client.__dbus_object_path__)
608
"""Abstract class for commands outputting client details"""
609
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
610
"Created", "Interval", "Host", "KeyID",
611
"Fingerprint", "CheckerRunning",
612
"LastEnabled", "ApprovalPending",
613
"ApprovedByDefault", "LastApprovalRequest",
614
"ApprovalDelay", "ApprovalDuration",
615
"Checker", "ExtendedTimeout", "Expires",
412
616
"LastCheckerStatus")
414
keywords = defaultkeywords
416
if options.dump_json:
417
json.dump({client["Name"]: {key:
419
if isinstance(client[key],
423
for client in clients.values()},
424
fp=sys.stdout, indent=4,
425
separators=(',', ': '))
428
print_clients(clients.values(), keywords)
430
# Process each client in the list by all selected options
431
for client in clients:
433
def set_client_prop(prop, value):
434
"""Set a Client D-Bus property"""
435
client.Set(client_interface, prop, value,
436
dbus_interface=dbus.PROPERTIES_IFACE)
438
def set_client_prop_ms(prop, value):
439
"""Set a Client D-Bus property, converted
440
from a string to milliseconds."""
441
set_client_prop(prop,
442
string_to_delta(value).total_seconds()
446
mandos_serv.RemoveClient(client.__dbus_object_path__)
448
set_client_prop("Enabled", dbus.Boolean(True))
450
set_client_prop("Enabled", dbus.Boolean(False))
451
if options.bump_timeout:
452
set_client_prop("LastCheckedOK", "")
453
if options.start_checker:
454
set_client_prop("CheckerRunning", dbus.Boolean(True))
455
if options.stop_checker:
456
set_client_prop("CheckerRunning", dbus.Boolean(False))
457
if options.is_enabled:
458
if client.Get(client_interface, "Enabled",
459
dbus_interface=dbus.PROPERTIES_IFACE):
463
if options.checker is not None:
464
set_client_prop("Checker", options.checker)
465
if options.host is not None:
466
set_client_prop("Host", options.host)
467
if options.interval is not None:
468
set_client_prop_ms("Interval", options.interval)
469
if options.approval_delay is not None:
470
set_client_prop_ms("ApprovalDelay",
471
options.approval_delay)
472
if options.approval_duration is not None:
473
set_client_prop_ms("ApprovalDuration",
474
options.approval_duration)
475
if options.timeout is not None:
476
set_client_prop_ms("Timeout", options.timeout)
477
if options.extended_timeout is not None:
478
set_client_prop_ms("ExtendedTimeout",
479
options.extended_timeout)
480
if options.secret is not None:
481
set_client_prop("Secret",
482
dbus.ByteArray(options.secret.read()))
483
if options.approved_by_default is not None:
484
set_client_prop("ApprovedByDefault",
486
.approved_by_default))
488
client.Approve(dbus.Boolean(True),
489
dbus_interface=client_interface)
491
client.Approve(dbus.Boolean(False),
492
dbus_interface=client_interface)
619
class DumpJSON(Output):
620
def run(self, clients, bus=None, mandos=None):
621
data = {client["Name"]:
622
{key: self.dbus_boolean_to_bool(client[key])
623
for key in self.all_keywords}
624
for client in clients.values()}
625
print(json.dumps(data, indent=4, separators=(',', ': ')))
628
def dbus_boolean_to_bool(value):
629
if isinstance(value, dbus.Boolean):
634
class PrintTable(Output):
635
def __init__(self, verbose=False):
636
self.verbose = verbose
638
def run(self, clients, bus=None, mandos=None):
639
default_keywords = ("Name", "Enabled", "Timeout",
641
keywords = default_keywords
643
keywords = self.all_keywords
644
print(self.TableOfClients(clients.values(), keywords))
646
class TableOfClients(object):
649
"Enabled": "Enabled",
650
"Timeout": "Timeout",
651
"LastCheckedOK": "Last Successful Check",
652
"LastApprovalRequest": "Last Approval Request",
653
"Created": "Created",
654
"Interval": "Interval",
656
"Fingerprint": "Fingerprint",
658
"CheckerRunning": "Check Is Running",
659
"LastEnabled": "Last Enabled",
660
"ApprovalPending": "Approval Is Pending",
661
"ApprovedByDefault": "Approved By Default",
662
"ApprovalDelay": "Approval Delay",
663
"ApprovalDuration": "Approval Duration",
664
"Checker": "Checker",
665
"ExtendedTimeout": "Extended Timeout",
666
"Expires": "Expires",
667
"LastCheckerStatus": "Last Checker Status",
670
def __init__(self, clients, keywords):
671
self.clients = clients
672
self.keywords = keywords
675
return "\n".join(self.rows())
677
if sys.version_info.major == 2:
678
__unicode__ = __str__
680
return str(self).encode(
681
locale.getpreferredencoding())
684
format_string = self.row_formatting_string()
685
rows = [self.header_line(format_string)]
686
rows.extend(self.client_line(client, format_string)
687
for client in self.clients)
690
def row_formatting_string(self):
691
"Format string used to format table rows"
692
return " ".join("{{{key}:{width}}}".format(
693
width=max(len(self.tableheaders[key]),
694
*(len(self.string_from_client(client,
696
for client in self.clients)),
698
for key in self.keywords)
700
def string_from_client(self, client, key):
701
return self.valuetostring(client[key], key)
704
def valuetostring(cls, value, keyword):
705
if isinstance(value, dbus.Boolean):
706
return "Yes" if value else "No"
707
if keyword in ("Timeout", "Interval", "ApprovalDelay",
708
"ApprovalDuration", "ExtendedTimeout"):
709
return cls.milliseconds_to_string(value)
712
def header_line(self, format_string):
713
return format_string.format(**self.tableheaders)
715
def client_line(self, client, format_string):
716
return format_string.format(
717
**{key: self.string_from_client(client, key)
718
for key in self.keywords})
721
def milliseconds_to_string(ms):
722
td = datetime.timedelta(0, 0, 0, ms)
723
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
724
.format(days="{}T".format(td.days)
726
hours=td.seconds // 3600,
727
minutes=(td.seconds % 3600) // 60,
728
seconds=td.seconds % 60))
731
class Property(Base):
732
"Abstract class for Actions for setting one client property"
734
def run_on_one_client(self, client, properties):
735
"""Set the Client's D-Bus property"""
736
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
737
client.__dbus_object_path__,
738
dbus.PROPERTIES_IFACE, client_dbus_interface,
739
self.propname, self.value_to_set
740
if not isinstance(self.value_to_set,
742
else bool(self.value_to_set))
743
client.Set(client_dbus_interface, self.propname,
745
dbus_interface=dbus.PROPERTIES_IFACE)
749
raise NotImplementedError()
752
class Enable(Property):
754
value_to_set = dbus.Boolean(True)
757
class Disable(Property):
759
value_to_set = dbus.Boolean(False)
762
class BumpTimeout(Property):
763
propname = "LastCheckedOK"
767
class StartChecker(Property):
768
propname = "CheckerRunning"
769
value_to_set = dbus.Boolean(True)
772
class StopChecker(Property):
773
propname = "CheckerRunning"
774
value_to_set = dbus.Boolean(False)
777
class ApproveByDefault(Property):
778
propname = "ApprovedByDefault"
779
value_to_set = dbus.Boolean(True)
782
class DenyByDefault(Property):
783
propname = "ApprovedByDefault"
784
value_to_set = dbus.Boolean(False)
787
class PropertyValue(Property):
788
"Abstract class for Property recieving a value as argument"
789
def __init__(self, value):
790
self.value_to_set = value
793
class SetChecker(PropertyValue):
797
class SetHost(PropertyValue):
801
class SetSecret(PropertyValue):
805
def value_to_set(self):
809
def value_to_set(self, value):
810
"""When setting, read data from supplied file object"""
811
self._vts = value.read()
815
class MillisecondsPropertyValueArgument(PropertyValue):
816
"""Abstract class for PropertyValue taking a value argument as
817
a datetime.timedelta() but should store it as milliseconds."""
820
def value_to_set(self):
824
def value_to_set(self, value):
825
"When setting, convert value from a datetime.timedelta"
826
self._vts = int(round(value.total_seconds() * 1000))
829
class SetTimeout(MillisecondsPropertyValueArgument):
833
class SetExtendedTimeout(MillisecondsPropertyValueArgument):
834
propname = "ExtendedTimeout"
837
class SetInterval(MillisecondsPropertyValueArgument):
838
propname = "Interval"
841
class SetApprovalDelay(MillisecondsPropertyValueArgument):
842
propname = "ApprovalDelay"
845
class SetApprovalDuration(MillisecondsPropertyValueArgument):
846
propname = "ApprovalDuration"
850
class TestCaseWithAssertLogs(unittest.TestCase):
851
"""unittest.TestCase.assertLogs only exists in Python 3.4"""
853
if not hasattr(unittest.TestCase, "assertLogs"):
854
@contextlib.contextmanager
855
def assertLogs(self, logger, level=logging.INFO):
856
capturing_handler = self.CapturingLevelHandler(level)
857
old_level = logger.level
858
old_propagate = logger.propagate
859
logger.addHandler(capturing_handler)
860
logger.setLevel(level)
861
logger.propagate = False
863
yield capturing_handler.watcher
865
logger.propagate = old_propagate
866
logger.removeHandler(capturing_handler)
867
logger.setLevel(old_level)
868
self.assertGreater(len(capturing_handler.watcher.records),
871
class CapturingLevelHandler(logging.Handler):
872
def __init__(self, level, *args, **kwargs):
873
logging.Handler.__init__(self, *args, **kwargs)
874
self.watcher = self.LoggingWatcher([], [])
875
def emit(self, record):
876
self.watcher.records.append(record)
877
self.watcher.output.append(self.format(record))
879
LoggingWatcher = collections.namedtuple("LoggingWatcher",
884
class Test_string_to_delta(TestCaseWithAssertLogs):
885
# Just test basic RFC 3339 functionality here, the doc string for
886
# rfc3339_duration_to_delta() already has more comprehensive
887
# tests, which is run by doctest.
889
def test_rfc3339_zero_seconds(self):
890
self.assertEqual(datetime.timedelta(),
891
string_to_delta("PT0S"))
893
def test_rfc3339_zero_days(self):
894
self.assertEqual(datetime.timedelta(), string_to_delta("P0D"))
896
def test_rfc3339_one_second(self):
897
self.assertEqual(datetime.timedelta(0, 1),
898
string_to_delta("PT1S"))
900
def test_rfc3339_two_hours(self):
901
self.assertEqual(datetime.timedelta(0, 7200),
902
string_to_delta("PT2H"))
904
def test_falls_back_to_pre_1_6_1_with_warning(self):
905
with self.assertLogs(log, logging.WARNING):
906
value = string_to_delta("2h")
907
self.assertEqual(datetime.timedelta(0, 7200), value)
910
class Test_check_option_syntax(unittest.TestCase):
912
self.parser = argparse.ArgumentParser()
913
add_command_line_options(self.parser)
915
def test_actions_requires_client_or_all(self):
916
for action, value in self.actions.items():
917
options = self.parser.parse_args()
918
setattr(options, action, value)
919
with self.assertParseError():
920
self.check_option_syntax(options)
922
# This mostly corresponds to the definition from has_actions() in
923
# check_option_syntax()
925
# The actual values set here are not that important, but we do
926
# at least stick to the correct types, even though they are
930
"bump_timeout": True,
931
"start_checker": True,
932
"stop_checker": True,
936
"timeout": datetime.timedelta(),
937
"extended_timeout": datetime.timedelta(),
938
"interval": datetime.timedelta(),
939
"approved_by_default": True,
940
"approval_delay": datetime.timedelta(),
941
"approval_duration": datetime.timedelta(),
943
"secret": io.BytesIO(b"x"),
948
@contextlib.contextmanager
949
def assertParseError(self):
950
with self.assertRaises(SystemExit) as e:
951
with self.redirect_stderr_to_devnull():
953
# Exit code from argparse is guaranteed to be "2". Reference:
954
# https://docs.python.org/3/library
955
# /argparse.html#exiting-methods
956
self.assertEqual(2, e.exception.code)
959
@contextlib.contextmanager
960
def redirect_stderr_to_devnull():
961
old_stderr = sys.stderr
962
with contextlib.closing(open(os.devnull, "w")) as null:
967
sys.stderr = old_stderr
969
def check_option_syntax(self, options):
970
check_option_syntax(self.parser, options)
972
def test_actions_all_conflicts_with_verbose(self):
973
for action, value in self.actions.items():
974
options = self.parser.parse_args()
975
setattr(options, action, value)
977
options.verbose = True
978
with self.assertParseError():
979
self.check_option_syntax(options)
981
def test_actions_with_client_conflicts_with_verbose(self):
982
for action, value in self.actions.items():
983
options = self.parser.parse_args()
984
setattr(options, action, value)
985
options.verbose = True
986
options.client = ["foo"]
987
with self.assertParseError():
988
self.check_option_syntax(options)
990
def test_dump_json_conflicts_with_verbose(self):
991
options = self.parser.parse_args()
992
options.dump_json = True
993
options.verbose = True
994
with self.assertParseError():
995
self.check_option_syntax(options)
997
def test_dump_json_conflicts_with_action(self):
998
for action, value in self.actions.items():
999
options = self.parser.parse_args()
1000
setattr(options, action, value)
1001
options.dump_json = True
1002
with self.assertParseError():
1003
self.check_option_syntax(options)
1005
def test_all_can_not_be_alone(self):
1006
options = self.parser.parse_args()
1008
with self.assertParseError():
1009
self.check_option_syntax(options)
1011
def test_all_is_ok_with_any_action(self):
1012
for action, value in self.actions.items():
1013
options = self.parser.parse_args()
1014
setattr(options, action, value)
1016
self.check_option_syntax(options)
1018
def test_any_action_is_ok_with_one_client(self):
1019
for action, value in self.actions.items():
1020
options = self.parser.parse_args()
1021
setattr(options, action, value)
1022
options.client = ["foo"]
1023
self.check_option_syntax(options)
1025
def test_one_client_with_all_actions_except_is_enabled(self):
1026
options = self.parser.parse_args()
1027
for action, value in self.actions.items():
1028
if action == "is_enabled":
1030
setattr(options, action, value)
1031
options.client = ["foo"]
1032
self.check_option_syntax(options)
1034
def test_two_clients_with_all_actions_except_is_enabled(self):
1035
options = self.parser.parse_args()
1036
for action, value in self.actions.items():
1037
if action == "is_enabled":
1039
setattr(options, action, value)
1040
options.client = ["foo", "barbar"]
1041
self.check_option_syntax(options)
1043
def test_two_clients_are_ok_with_actions_except_is_enabled(self):
1044
for action, value in self.actions.items():
1045
if action == "is_enabled":
1047
options = self.parser.parse_args()
1048
setattr(options, action, value)
1049
options.client = ["foo", "barbar"]
1050
self.check_option_syntax(options)
1052
def test_is_enabled_fails_without_client(self):
1053
options = self.parser.parse_args()
1054
options.is_enabled = True
1055
with self.assertParseError():
1056
self.check_option_syntax(options)
1058
def test_is_enabled_fails_with_two_clients(self):
1059
options = self.parser.parse_args()
1060
options.is_enabled = True
1061
options.client = ["foo", "barbar"]
1062
with self.assertParseError():
1063
self.check_option_syntax(options)
1065
def test_remove_can_only_be_combined_with_action_deny(self):
1066
for action, value in self.actions.items():
1067
if action in {"remove", "deny"}:
1069
options = self.parser.parse_args()
1070
setattr(options, action, value)
1072
options.remove = True
1073
with self.assertParseError():
1074
self.check_option_syntax(options)
1077
class Test_get_mandos_dbus_object(TestCaseWithAssertLogs):
1078
def test_calls_and_returns_get_object_on_bus(self):
1079
class MockBus(object):
1081
def get_object(mockbus_self, busname, dbus_path):
1082
# Note that "self" is still the testcase instance,
1083
# this MockBus instance is in "mockbus_self".
1084
self.assertEqual(dbus_busname, busname)
1085
self.assertEqual(server_dbus_path, dbus_path)
1086
mockbus_self.called = True
1089
mockbus = get_mandos_dbus_object(bus=MockBus())
1090
self.assertIsInstance(mockbus, MockBus)
1091
self.assertTrue(mockbus.called)
1093
def test_logs_and_exits_on_dbus_error(self):
1094
class MockBusFailing(object):
1095
def get_object(self, busname, dbus_path):
1096
raise dbus.exceptions.DBusException("Test")
1098
with self.assertLogs(log, logging.CRITICAL):
1099
with self.assertRaises(SystemExit) as e:
1100
bus = get_mandos_dbus_object(bus=MockBusFailing())
1102
if isinstance(e.exception.code, int):
1103
self.assertNotEqual(0, e.exception.code)
1105
self.assertIsNotNone(e.exception.code)
1108
class Test_get_managed_objects(TestCaseWithAssertLogs):
1109
def test_calls_and_returns_GetManagedObjects(self):
1110
managed_objects = {"/clients/foo": { "Name": "foo"}}
1111
class MockObjectManager(object):
1112
def GetManagedObjects(self):
1113
return managed_objects
1114
retval = get_managed_objects(MockObjectManager())
1115
self.assertDictEqual(managed_objects, retval)
1117
def test_logs_and_exits_on_dbus_error(self):
1118
dbus_logger = logging.getLogger("dbus.proxies")
1120
class MockObjectManagerFailing(object):
1121
def GetManagedObjects(self):
1122
dbus_logger.error("Test")
1123
raise dbus.exceptions.DBusException("Test")
1125
class CountingHandler(logging.Handler):
1127
def emit(self, record):
1130
counting_handler = CountingHandler()
1132
dbus_logger.addHandler(counting_handler)
1135
with self.assertLogs(log, logging.CRITICAL) as watcher:
1136
with self.assertRaises(SystemExit) as e:
1137
get_managed_objects(MockObjectManagerFailing())
1139
dbus_logger.removeFilter(counting_handler)
1141
# Make sure the dbus logger was suppressed
1142
self.assertEqual(0, counting_handler.count)
1144
# Test that the dbus_logger still works
1145
with self.assertLogs(dbus_logger, logging.ERROR):
1146
dbus_logger.error("Test")
1148
if isinstance(e.exception.code, int):
1149
self.assertNotEqual(0, e.exception.code)
1151
self.assertIsNotNone(e.exception.code)
1154
class Test_commands_from_options(unittest.TestCase):
1156
self.parser = argparse.ArgumentParser()
1157
add_command_line_options(self.parser)
1159
def test_is_enabled(self):
1160
self.assert_command_from_args(["--is-enabled", "foo"],
1163
def assert_command_from_args(self, args, command_cls,
1165
"""Assert that parsing ARGS should result in an instance of
1166
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
1167
options = self.parser.parse_args(args)
1168
check_option_syntax(self.parser, options)
1169
commands = commands_from_options(options)
1170
self.assertEqual(1, len(commands))
1171
command = commands[0]
1172
self.assertIsInstance(command, command_cls)
1173
for key, value in cmd_attrs.items():
1174
self.assertEqual(value, getattr(command, key))
1176
def test_is_enabled_short(self):
1177
self.assert_command_from_args(["-V", "foo"],
1180
def test_approve(self):
1181
self.assert_command_from_args(["--approve", "foo"],
1184
def test_approve_short(self):
1185
self.assert_command_from_args(["-A", "foo"], command.Approve)
1187
def test_deny(self):
1188
self.assert_command_from_args(["--deny", "foo"], command.Deny)
1190
def test_deny_short(self):
1191
self.assert_command_from_args(["-D", "foo"], command.Deny)
1193
def test_remove(self):
1194
self.assert_command_from_args(["--remove", "foo"],
1197
def test_deny_before_remove(self):
1198
options = self.parser.parse_args(["--deny", "--remove",
1200
check_option_syntax(self.parser, options)
1201
commands = commands_from_options(options)
1202
self.assertEqual(2, len(commands))
1203
self.assertIsInstance(commands[0], command.Deny)
1204
self.assertIsInstance(commands[1], command.Remove)
1206
def test_deny_before_remove_reversed(self):
1207
options = self.parser.parse_args(["--remove", "--deny",
1209
check_option_syntax(self.parser, options)
1210
commands = commands_from_options(options)
1211
self.assertEqual(2, len(commands))
1212
self.assertIsInstance(commands[0], command.Deny)
1213
self.assertIsInstance(commands[1], command.Remove)
1215
def test_remove_short(self):
1216
self.assert_command_from_args(["-r", "foo"], command.Remove)
1218
def test_dump_json(self):
1219
self.assert_command_from_args(["--dump-json"],
1222
def test_enable(self):
1223
self.assert_command_from_args(["--enable", "foo"],
1226
def test_enable_short(self):
1227
self.assert_command_from_args(["-e", "foo"], command.Enable)
1229
def test_disable(self):
1230
self.assert_command_from_args(["--disable", "foo"],
1233
def test_disable_short(self):
1234
self.assert_command_from_args(["-d", "foo"], command.Disable)
1236
def test_bump_timeout(self):
1237
self.assert_command_from_args(["--bump-timeout", "foo"],
1238
command.BumpTimeout)
1240
def test_bump_timeout_short(self):
1241
self.assert_command_from_args(["-b", "foo"],
1242
command.BumpTimeout)
1244
def test_start_checker(self):
1245
self.assert_command_from_args(["--start-checker", "foo"],
1246
command.StartChecker)
1248
def test_stop_checker(self):
1249
self.assert_command_from_args(["--stop-checker", "foo"],
1250
command.StopChecker)
1252
def test_approve_by_default(self):
1253
self.assert_command_from_args(["--approve-by-default", "foo"],
1254
command.ApproveByDefault)
1256
def test_deny_by_default(self):
1257
self.assert_command_from_args(["--deny-by-default", "foo"],
1258
command.DenyByDefault)
1260
def test_checker(self):
1261
self.assert_command_from_args(["--checker", ":", "foo"],
1265
def test_checker_empty(self):
1266
self.assert_command_from_args(["--checker", "", "foo"],
1270
def test_checker_short(self):
1271
self.assert_command_from_args(["-c", ":", "foo"],
1275
def test_host(self):
1276
self.assert_command_from_args(["--host", "foo.example.org",
1277
"foo"], command.SetHost,
1278
value_to_set="foo.example.org")
1280
def test_host_short(self):
1281
self.assert_command_from_args(["-H", "foo.example.org",
1282
"foo"], command.SetHost,
1283
value_to_set="foo.example.org")
1285
def test_secret_devnull(self):
1286
self.assert_command_from_args(["--secret", os.path.devnull,
1287
"foo"], command.SetSecret,
1290
def test_secret_tempfile(self):
1291
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1292
value = b"secret\0xyzzy\nbar"
1295
self.assert_command_from_args(["--secret", f.name,
1296
"foo"], command.SetSecret,
1299
def test_secret_devnull_short(self):
1300
self.assert_command_from_args(["-s", os.path.devnull, "foo"],
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_timeout(self):
1314
self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1316
value_to_set=300000)
1318
def test_timeout_short(self):
1319
self.assert_command_from_args(["-t", "PT5M", "foo"],
1321
value_to_set=300000)
1323
def test_extended_timeout(self):
1324
self.assert_command_from_args(["--extended-timeout", "PT15M",
1326
command.SetExtendedTimeout,
1327
value_to_set=900000)
1329
def test_interval(self):
1330
self.assert_command_from_args(["--interval", "PT2M", "foo"],
1331
command.SetInterval,
1332
value_to_set=120000)
1334
def test_interval_short(self):
1335
self.assert_command_from_args(["-i", "PT2M", "foo"],
1336
command.SetInterval,
1337
value_to_set=120000)
1339
def test_approval_delay(self):
1340
self.assert_command_from_args(["--approval-delay", "PT30S",
1342
command.SetApprovalDelay,
1345
def test_approval_duration(self):
1346
self.assert_command_from_args(["--approval-duration", "PT1S",
1348
command.SetApprovalDuration,
1351
def test_print_table(self):
1352
self.assert_command_from_args([], command.PrintTable,
1355
def test_print_table_verbose(self):
1356
self.assert_command_from_args(["--verbose"],
1360
def test_print_table_verbose_short(self):
1361
self.assert_command_from_args(["-v"], command.PrintTable,
1365
class TestCommand(unittest.TestCase):
1366
"""Abstract class for tests of command classes"""
1370
class MockClient(object):
1371
def __init__(self, name, **attributes):
1372
self.__dbus_object_path__ = "/clients/{}".format(name)
1373
self.attributes = attributes
1374
self.attributes["Name"] = name
1376
def Set(self, interface, propname, value, dbus_interface):
1377
testcase.assertEqual(client_dbus_interface, interface)
1378
testcase.assertEqual(dbus.PROPERTIES_IFACE,
1380
self.attributes[propname] = value
1381
def Approve(self, approve, dbus_interface):
1382
testcase.assertEqual(client_dbus_interface,
1384
self.calls.append(("Approve", (approve,
1386
self.client = MockClient(
1388
KeyID=("92ed150794387c03ce684574b1139a65"
1389
"94a34f895daaaf09fd8ea90a27cddb12"),
1391
Host="foo.example.org",
1392
Enabled=dbus.Boolean(True),
1394
LastCheckedOK="2019-02-03T00:00:00",
1395
Created="2019-01-02T00:00:00",
1397
Fingerprint=("778827225BA7DE539C5A"
1398
"7CFA59CFF7CDBD9A5920"),
1399
CheckerRunning=dbus.Boolean(False),
1400
LastEnabled="2019-01-03T00:00:00",
1401
ApprovalPending=dbus.Boolean(False),
1402
ApprovedByDefault=dbus.Boolean(True),
1403
LastApprovalRequest="",
1405
ApprovalDuration=1000,
1406
Checker="fping -q -- %(host)s",
1407
ExtendedTimeout=900000,
1408
Expires="2019-02-04T00:00:00",
1409
LastCheckerStatus=0)
1410
self.other_client = MockClient(
1412
KeyID=("0558568eedd67d622f5c83b35a115f79"
1413
"6ab612cff5ad227247e46c2b020f441c"),
1414
Secret=b"secretbar",
1416
Enabled=dbus.Boolean(True),
1418
LastCheckedOK="2019-02-04T00:00:00",
1419
Created="2019-01-03T00:00:00",
1421
Fingerprint=("3E393AEAEFB84C7E89E2"
1422
"F547B3A107558FCA3A27"),
1423
CheckerRunning=dbus.Boolean(True),
1424
LastEnabled="2019-01-04T00:00:00",
1425
ApprovalPending=dbus.Boolean(False),
1426
ApprovedByDefault=dbus.Boolean(False),
1427
LastApprovalRequest="2019-01-03T00:00:00",
1428
ApprovalDelay=30000,
1429
ApprovalDuration=93785000,
1431
ExtendedTimeout=900000,
1432
Expires="2019-02-05T00:00:00",
1433
LastCheckerStatus=-2)
1434
self.clients = collections.OrderedDict(
1436
("/clients/foo", self.client.attributes),
1437
("/clients/barbar", self.other_client.attributes),
1439
self.one_client = {"/clients/foo": self.client.attributes}
1445
def get_object(client_bus_name, path):
1446
self.assertEqual(dbus_busname, client_bus_name)
1448
# Note: "self" here is the TestCmd instance, not
1449
# the Bus instance, since this is a static method!
1450
"/clients/foo": self.client,
1451
"/clients/barbar": self.other_client,
1456
class TestBaseCommands(TestCommand):
1458
def test_IsEnabled_exits_successfully(self):
1459
with self.assertRaises(SystemExit) as e:
1460
command.IsEnabled().run(self.one_client)
1461
if e.exception.code is not None:
1462
self.assertEqual(0, e.exception.code)
1464
self.assertIsNone(e.exception.code)
1466
def test_IsEnabled_exits_with_failure(self):
1467
self.client.attributes["Enabled"] = dbus.Boolean(False)
1468
with self.assertRaises(SystemExit) as e:
1469
command.IsEnabled().run(self.one_client)
1470
if isinstance(e.exception.code, int):
1471
self.assertNotEqual(0, e.exception.code)
1473
self.assertIsNotNone(e.exception.code)
1475
def test_Approve(self):
1476
command.Approve().run(self.clients, self.bus)
1477
for clientpath in self.clients:
1478
client = self.bus.get_object(dbus_busname, clientpath)
1479
self.assertIn(("Approve", (True, client_dbus_interface)),
1482
def test_Deny(self):
1483
command.Deny().run(self.clients, self.bus)
1484
for clientpath in self.clients:
1485
client = self.bus.get_object(dbus_busname, clientpath)
1486
self.assertIn(("Approve", (False, client_dbus_interface)),
1489
def test_Remove(self):
1490
class MockMandos(object):
1493
def RemoveClient(self, dbus_path):
1494
self.calls.append(("RemoveClient", (dbus_path,)))
1495
mandos = MockMandos()
1496
command.Remove().run(self.clients, self.bus, mandos)
1497
for clientpath in self.clients:
1498
self.assertIn(("RemoveClient", (clientpath,)),
1504
"KeyID": ("92ed150794387c03ce684574b1139a65"
1505
"94a34f895daaaf09fd8ea90a27cddb12"),
1506
"Host": "foo.example.org",
1509
"LastCheckedOK": "2019-02-03T00:00:00",
1510
"Created": "2019-01-02T00:00:00",
1512
"Fingerprint": ("778827225BA7DE539C5A"
1513
"7CFA59CFF7CDBD9A5920"),
1514
"CheckerRunning": False,
1515
"LastEnabled": "2019-01-03T00:00:00",
1516
"ApprovalPending": False,
1517
"ApprovedByDefault": True,
1518
"LastApprovalRequest": "",
1520
"ApprovalDuration": 1000,
1521
"Checker": "fping -q -- %(host)s",
1522
"ExtendedTimeout": 900000,
1523
"Expires": "2019-02-04T00:00:00",
1524
"LastCheckerStatus": 0,
1528
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
1529
"6ab612cff5ad227247e46c2b020f441c"),
1530
"Host": "192.0.2.3",
1533
"LastCheckedOK": "2019-02-04T00:00:00",
1534
"Created": "2019-01-03T00:00:00",
1536
"Fingerprint": ("3E393AEAEFB84C7E89E2"
1537
"F547B3A107558FCA3A27"),
1538
"CheckerRunning": True,
1539
"LastEnabled": "2019-01-04T00:00:00",
1540
"ApprovalPending": False,
1541
"ApprovedByDefault": False,
1542
"LastApprovalRequest": "2019-01-03T00:00:00",
1543
"ApprovalDelay": 30000,
1544
"ApprovalDuration": 93785000,
1546
"ExtendedTimeout": 900000,
1547
"Expires": "2019-02-05T00:00:00",
1548
"LastCheckerStatus": -2,
1552
def test_DumpJSON_normal(self):
1553
with self.capture_stdout_to_buffer() as buffer:
1554
command.DumpJSON().run(self.clients)
1555
json_data = json.loads(buffer.getvalue())
1556
self.assertDictEqual(self.expected_json, json_data)
1559
@contextlib.contextmanager
1560
def capture_stdout_to_buffer():
1561
capture_buffer = io.StringIO()
1562
old_stdout = sys.stdout
1563
sys.stdout = capture_buffer
1565
yield capture_buffer
1567
sys.stdout = old_stdout
1569
def test_DumpJSON_one_client(self):
1570
with self.capture_stdout_to_buffer() as buffer:
1571
command.DumpJSON().run(self.one_client)
1572
json_data = json.loads(buffer.getvalue())
1573
expected_json = {"foo": self.expected_json["foo"]}
1574
self.assertDictEqual(expected_json, json_data)
1576
def test_PrintTable_normal(self):
1577
with self.capture_stdout_to_buffer() as buffer:
1578
command.PrintTable().run(self.clients)
1579
expected_output = "\n".join((
1580
"Name Enabled Timeout Last Successful Check",
1581
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1582
"barbar Yes 00:05:00 2019-02-04T00:00:00 ",
1584
self.assertEqual(expected_output, buffer.getvalue())
1586
def test_PrintTable_verbose(self):
1587
with self.capture_stdout_to_buffer() as buffer:
1588
command.PrintTable(verbose=True).run(self.clients)
1603
"Last Successful Check ",
1604
"2019-02-03T00:00:00 ",
1605
"2019-02-04T00:00:00 ",
1608
"2019-01-02T00:00:00 ",
1609
"2019-01-03T00:00:00 ",
1621
("92ed150794387c03ce684574b1139a6594a34f895daaaf09fd8"
1623
("0558568eedd67d622f5c83b35a115f796ab612cff5ad227247e"
1627
"778827225BA7DE539C5A7CFA59CFF7CDBD9A5920 ",
1628
"3E393AEAEFB84C7E89E2F547B3A107558FCA3A27 ",
1630
"Check Is Running ",
1635
"2019-01-03T00:00:00 ",
1636
"2019-01-04T00:00:00 ",
1638
"Approval Is Pending ",
1642
"Approved By Default ",
1646
"Last Approval Request ",
1648
"2019-01-03T00:00:00 ",
1654
"Approval Duration ",
1659
"fping -q -- %(host)s ",
1662
"Extended Timeout ",
1667
"2019-02-04T00:00:00 ",
1668
"2019-02-05T00:00:00 ",
1670
"Last Checker Status",
1675
num_lines = max(len(rows) for rows in columns)
1676
expected_output = ("\n".join("".join(rows[line]
1677
for rows in columns)
1678
for line in range(num_lines))
1680
self.assertEqual(expected_output, buffer.getvalue())
1682
def test_PrintTable_one_client(self):
1683
with self.capture_stdout_to_buffer() as buffer:
1684
command.PrintTable().run(self.one_client)
1685
expected_output = "\n".join((
1686
"Name Enabled Timeout Last Successful Check",
1687
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1689
self.assertEqual(expected_output, buffer.getvalue())
1692
class TestPropertyCmd(TestCommand):
1693
"""Abstract class for tests of command.Property classes"""
1695
if not hasattr(self, "command"):
1697
values_to_get = getattr(self, "values_to_get",
1699
for value_to_set, value_to_get in zip(self.values_to_set,
1701
for clientpath in self.clients:
1702
client = self.bus.get_object(dbus_busname, clientpath)
1703
old_value = client.attributes[self.propname]
1704
client.attributes[self.propname] = self.Unique()
1705
self.run_command(value_to_set, self.clients)
1706
for clientpath in self.clients:
1707
client = self.bus.get_object(dbus_busname, clientpath)
1708
value = client.attributes[self.propname]
1709
self.assertNotIsInstance(value, self.Unique)
1710
self.assertEqual(value_to_get, value)
1712
class Unique(object):
1713
"""Class for objects which exist only to be unique objects,
1714
since unittest.mock.sentinel only exists in Python 3.3"""
1716
def run_command(self, value, clients):
1717
self.command().run(clients, self.bus)
1720
class TestEnableCmd(TestPropertyCmd):
1721
command = command.Enable
1722
propname = "Enabled"
1723
values_to_set = [dbus.Boolean(True)]
1726
class TestDisableCmd(TestPropertyCmd):
1727
command = command.Disable
1728
propname = "Enabled"
1729
values_to_set = [dbus.Boolean(False)]
1732
class TestBumpTimeoutCmd(TestPropertyCmd):
1733
command = command.BumpTimeout
1734
propname = "LastCheckedOK"
1735
values_to_set = [""]
1738
class TestStartCheckerCmd(TestPropertyCmd):
1739
command = command.StartChecker
1740
propname = "CheckerRunning"
1741
values_to_set = [dbus.Boolean(True)]
1744
class TestStopCheckerCmd(TestPropertyCmd):
1745
command = command.StopChecker
1746
propname = "CheckerRunning"
1747
values_to_set = [dbus.Boolean(False)]
1750
class TestApproveByDefaultCmd(TestPropertyCmd):
1751
command = command.ApproveByDefault
1752
propname = "ApprovedByDefault"
1753
values_to_set = [dbus.Boolean(True)]
1756
class TestDenyByDefaultCmd(TestPropertyCmd):
1757
command = command.DenyByDefault
1758
propname = "ApprovedByDefault"
1759
values_to_set = [dbus.Boolean(False)]
1762
class TestPropertyValueCmd(TestPropertyCmd):
1763
"""Abstract class for tests of PropertyValueCmd classes"""
1766
if type(self) is TestPropertyValueCmd:
1768
return super(TestPropertyValueCmd, self).runTest()
1770
def run_command(self, value, clients):
1771
self.command(value).run(clients, self.bus)
1774
class TestSetCheckerCmd(TestPropertyValueCmd):
1775
command = command.SetChecker
1776
propname = "Checker"
1777
values_to_set = ["", ":", "fping -q -- %s"]
1780
class TestSetHostCmd(TestPropertyValueCmd):
1781
command = command.SetHost
1783
values_to_set = ["192.0.2.3", "foo.example.org"]
1786
class TestSetSecretCmd(TestPropertyValueCmd):
1787
command = command.SetSecret
1789
values_to_set = [io.BytesIO(b""),
1790
io.BytesIO(b"secret\0xyzzy\nbar")]
1791
values_to_get = [b"", b"secret\0xyzzy\nbar"]
1794
class TestSetTimeoutCmd(TestPropertyValueCmd):
1795
command = command.SetTimeout
1796
propname = "Timeout"
1797
values_to_set = [datetime.timedelta(),
1798
datetime.timedelta(minutes=5),
1799
datetime.timedelta(seconds=1),
1800
datetime.timedelta(weeks=1),
1801
datetime.timedelta(weeks=52)]
1802
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1805
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
1806
command = command.SetExtendedTimeout
1807
propname = "ExtendedTimeout"
1808
values_to_set = [datetime.timedelta(),
1809
datetime.timedelta(minutes=5),
1810
datetime.timedelta(seconds=1),
1811
datetime.timedelta(weeks=1),
1812
datetime.timedelta(weeks=52)]
1813
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1816
class TestSetIntervalCmd(TestPropertyValueCmd):
1817
command = command.SetInterval
1818
propname = "Interval"
1819
values_to_set = [datetime.timedelta(),
1820
datetime.timedelta(minutes=5),
1821
datetime.timedelta(seconds=1),
1822
datetime.timedelta(weeks=1),
1823
datetime.timedelta(weeks=52)]
1824
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1827
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
1828
command = command.SetApprovalDelay
1829
propname = "ApprovalDelay"
1830
values_to_set = [datetime.timedelta(),
1831
datetime.timedelta(minutes=5),
1832
datetime.timedelta(seconds=1),
1833
datetime.timedelta(weeks=1),
1834
datetime.timedelta(weeks=52)]
1835
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1838
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
1839
command = command.SetApprovalDuration
1840
propname = "ApprovalDuration"
1841
values_to_set = [datetime.timedelta(),
1842
datetime.timedelta(minutes=5),
1843
datetime.timedelta(seconds=1),
1844
datetime.timedelta(weeks=1),
1845
datetime.timedelta(weeks=52)]
1846
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1850
def should_only_run_tests():
1851
parser = argparse.ArgumentParser(add_help=False)
1852
parser.add_argument("--check", action='store_true')
1853
args, unknown_args = parser.parse_known_args()
1854
run_tests = args.check
1856
# Remove --check argument from sys.argv
1857
sys.argv[1:] = unknown_args
1860
# Add all tests from doctest strings
1861
def load_tests(loader, tests, none):
1863
tests.addTests(doctest.DocTestSuite())
495
1866
if __name__ == "__main__":
1868
if should_only_run_tests():
1869
# Call using ./tdd-python-script --check [--verbose]