412
612
"ApprovalDelay", "ApprovalDuration",
413
613
"Checker", "ExtendedTimeout", "Expires",
414
614
"LastCheckerStatus")
416
keywords = defaultkeywords
418
if options.dump_json:
419
json.dump({client["Name"]: {key:
421
if isinstance(client[key],
425
for client in clients.values()},
426
fp=sys.stdout, indent=4,
427
separators=(',', ': '))
430
print_clients(clients.values(), keywords)
432
# Process each client in the list by all selected options
433
for client in clients:
435
def set_client_prop(prop, value):
436
"""Set a Client D-Bus property"""
437
client.Set(client_interface, prop, value,
438
dbus_interface=dbus.PROPERTIES_IFACE)
440
def set_client_prop_ms(prop, value):
441
"""Set a Client D-Bus property, converted
442
from a string to milliseconds."""
443
set_client_prop(prop,
444
string_to_delta(value).total_seconds()
448
mandos_serv.RemoveClient(client.__dbus_object_path__)
450
set_client_prop("Enabled", dbus.Boolean(True))
452
set_client_prop("Enabled", dbus.Boolean(False))
453
if options.bump_timeout:
454
set_client_prop("LastCheckedOK", "")
455
if options.start_checker:
456
set_client_prop("CheckerRunning", dbus.Boolean(True))
457
if options.stop_checker:
458
set_client_prop("CheckerRunning", dbus.Boolean(False))
459
if options.is_enabled:
460
if client.Get(client_interface, "Enabled",
461
dbus_interface=dbus.PROPERTIES_IFACE):
465
if options.checker is not None:
466
set_client_prop("Checker", options.checker)
467
if options.host is not None:
468
set_client_prop("Host", options.host)
469
if options.interval is not None:
470
set_client_prop_ms("Interval", options.interval)
471
if options.approval_delay is not None:
472
set_client_prop_ms("ApprovalDelay",
473
options.approval_delay)
474
if options.approval_duration is not None:
475
set_client_prop_ms("ApprovalDuration",
476
options.approval_duration)
477
if options.timeout is not None:
478
set_client_prop_ms("Timeout", options.timeout)
479
if options.extended_timeout is not None:
480
set_client_prop_ms("ExtendedTimeout",
481
options.extended_timeout)
482
if options.secret is not None:
483
set_client_prop("Secret",
484
dbus.ByteArray(options.secret.read()))
485
if options.approved_by_default is not None:
486
set_client_prop("ApprovedByDefault",
488
.approved_by_default))
490
client.Approve(dbus.Boolean(True),
491
dbus_interface=client_interface)
493
client.Approve(dbus.Boolean(False),
494
dbus_interface=client_interface)
616
def run(self, clients, bus=None, mandos=None):
617
print(self.output(clients.values()))
619
def output(self, clients):
620
raise NotImplementedError()
623
class DumpJSON(Output):
624
def output(self, clients):
625
data = {client["Name"]:
626
{key: self.dbus_boolean_to_bool(client[key])
627
for key in self.all_keywords}
628
for client in clients}
629
return json.dumps(data, indent=4, separators=(',', ': '))
632
def dbus_boolean_to_bool(value):
633
if isinstance(value, dbus.Boolean):
638
class PrintTable(Output):
639
def __init__(self, verbose=False):
640
self.verbose = verbose
642
def output(self, clients):
643
default_keywords = ("Name", "Enabled", "Timeout",
645
keywords = default_keywords
647
keywords = self.all_keywords
648
return str(self.TableOfClients(clients, keywords))
650
class TableOfClients(object):
653
"Enabled": "Enabled",
654
"Timeout": "Timeout",
655
"LastCheckedOK": "Last Successful Check",
656
"LastApprovalRequest": "Last Approval Request",
657
"Created": "Created",
658
"Interval": "Interval",
660
"Fingerprint": "Fingerprint",
662
"CheckerRunning": "Check Is Running",
663
"LastEnabled": "Last Enabled",
664
"ApprovalPending": "Approval Is Pending",
665
"ApprovedByDefault": "Approved By Default",
666
"ApprovalDelay": "Approval Delay",
667
"ApprovalDuration": "Approval Duration",
668
"Checker": "Checker",
669
"ExtendedTimeout": "Extended Timeout",
670
"Expires": "Expires",
671
"LastCheckerStatus": "Last Checker Status",
674
def __init__(self, clients, keywords):
675
self.clients = clients
676
self.keywords = keywords
679
return "\n".join(self.rows())
681
if sys.version_info.major == 2:
682
__unicode__ = __str__
684
return str(self).encode(
685
locale.getpreferredencoding())
688
format_string = self.row_formatting_string()
689
rows = [self.header_line(format_string)]
690
rows.extend(self.client_line(client, format_string)
691
for client in self.clients)
694
def row_formatting_string(self):
695
"Format string used to format table rows"
696
return " ".join("{{{key}:{width}}}".format(
697
width=max(len(self.tableheaders[key]),
698
*(len(self.string_from_client(client,
700
for client in self.clients)),
702
for key in self.keywords)
704
def string_from_client(self, client, key):
705
return self.valuetostring(client[key], key)
708
def valuetostring(cls, value, keyword):
709
if isinstance(value, dbus.Boolean):
710
return "Yes" if value else "No"
711
if keyword in ("Timeout", "Interval", "ApprovalDelay",
712
"ApprovalDuration", "ExtendedTimeout"):
713
return cls.milliseconds_to_string(value)
716
def header_line(self, format_string):
717
return format_string.format(**self.tableheaders)
719
def client_line(self, client, format_string):
720
return format_string.format(
721
**{key: self.string_from_client(client, key)
722
for key in self.keywords})
725
def milliseconds_to_string(ms):
726
td = datetime.timedelta(0, 0, 0, ms)
727
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
728
.format(days="{}T".format(td.days)
730
hours=td.seconds // 3600,
731
minutes=(td.seconds % 3600) // 60,
732
seconds=td.seconds % 60))
735
class Property(Base):
736
"Abstract class for Actions for setting one client property"
738
def run_on_one_client(self, client, properties):
739
"""Set the Client's D-Bus property"""
740
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
741
client.__dbus_object_path__,
742
dbus.PROPERTIES_IFACE, client_dbus_interface,
743
self.propname, self.value_to_set
744
if not isinstance(self.value_to_set,
746
else bool(self.value_to_set))
747
client.Set(client_dbus_interface, self.propname,
749
dbus_interface=dbus.PROPERTIES_IFACE)
753
raise NotImplementedError()
756
class Enable(Property):
758
value_to_set = dbus.Boolean(True)
761
class Disable(Property):
763
value_to_set = dbus.Boolean(False)
766
class BumpTimeout(Property):
767
propname = "LastCheckedOK"
771
class StartChecker(Property):
772
propname = "CheckerRunning"
773
value_to_set = dbus.Boolean(True)
776
class StopChecker(Property):
777
propname = "CheckerRunning"
778
value_to_set = dbus.Boolean(False)
781
class ApproveByDefault(Property):
782
propname = "ApprovedByDefault"
783
value_to_set = dbus.Boolean(True)
786
class DenyByDefault(Property):
787
propname = "ApprovedByDefault"
788
value_to_set = dbus.Boolean(False)
791
class PropertyValue(Property):
792
"Abstract class for Property recieving a value as argument"
793
def __init__(self, value):
794
self.value_to_set = value
797
class SetChecker(PropertyValue):
801
class SetHost(PropertyValue):
805
class SetSecret(PropertyValue):
809
def value_to_set(self):
813
def value_to_set(self, value):
814
"""When setting, read data from supplied file object"""
815
self._vts = value.read()
819
class MillisecondsPropertyValueArgument(PropertyValue):
820
"""Abstract class for PropertyValue taking a value argument as
821
a datetime.timedelta() but should store it as milliseconds."""
824
def value_to_set(self):
828
def value_to_set(self, value):
829
"When setting, convert value from a datetime.timedelta"
830
self._vts = int(round(value.total_seconds() * 1000))
833
class SetTimeout(MillisecondsPropertyValueArgument):
837
class SetExtendedTimeout(MillisecondsPropertyValueArgument):
838
propname = "ExtendedTimeout"
841
class SetInterval(MillisecondsPropertyValueArgument):
842
propname = "Interval"
845
class SetApprovalDelay(MillisecondsPropertyValueArgument):
846
propname = "ApprovalDelay"
849
class SetApprovalDuration(MillisecondsPropertyValueArgument):
850
propname = "ApprovalDuration"
854
class TestCaseWithAssertLogs(unittest.TestCase):
855
"""unittest.TestCase.assertLogs only exists in Python 3.4"""
857
if not hasattr(unittest.TestCase, "assertLogs"):
858
@contextlib.contextmanager
859
def assertLogs(self, logger, level=logging.INFO):
860
capturing_handler = self.CapturingLevelHandler(level)
861
old_level = logger.level
862
old_propagate = logger.propagate
863
logger.addHandler(capturing_handler)
864
logger.setLevel(level)
865
logger.propagate = False
867
yield capturing_handler.watcher
869
logger.propagate = old_propagate
870
logger.removeHandler(capturing_handler)
871
logger.setLevel(old_level)
872
self.assertGreater(len(capturing_handler.watcher.records),
875
class CapturingLevelHandler(logging.Handler):
876
def __init__(self, level, *args, **kwargs):
877
logging.Handler.__init__(self, *args, **kwargs)
878
self.watcher = self.LoggingWatcher([], [])
879
def emit(self, record):
880
self.watcher.records.append(record)
881
self.watcher.output.append(self.format(record))
883
LoggingWatcher = collections.namedtuple("LoggingWatcher",
888
class Test_string_to_delta(TestCaseWithAssertLogs):
889
def test_handles_basic_rfc3339(self):
890
self.assertEqual(string_to_delta("PT0S"),
891
datetime.timedelta())
892
self.assertEqual(string_to_delta("P0D"),
893
datetime.timedelta())
894
self.assertEqual(string_to_delta("PT1S"),
895
datetime.timedelta(0, 1))
896
self.assertEqual(string_to_delta("PT2H"),
897
datetime.timedelta(0, 7200))
899
def test_falls_back_to_pre_1_6_1_with_warning(self):
900
with self.assertLogs(log, logging.WARNING):
901
value = string_to_delta("2h")
902
self.assertEqual(value, datetime.timedelta(0, 7200))
905
class Test_check_option_syntax(unittest.TestCase):
907
self.parser = argparse.ArgumentParser()
908
add_command_line_options(self.parser)
910
def test_actions_requires_client_or_all(self):
911
for action, value in self.actions.items():
912
options = self.parser.parse_args()
913
setattr(options, action, value)
914
with self.assertParseError():
915
self.check_option_syntax(options)
917
# This mostly corresponds to the definition from has_actions() in
918
# check_option_syntax()
920
# The actual values set here are not that important, but we do
921
# at least stick to the correct types, even though they are
925
"bump_timeout": True,
926
"start_checker": True,
927
"stop_checker": True,
931
"timeout": datetime.timedelta(),
932
"extended_timeout": datetime.timedelta(),
933
"interval": datetime.timedelta(),
934
"approved_by_default": True,
935
"approval_delay": datetime.timedelta(),
936
"approval_duration": datetime.timedelta(),
938
"secret": io.BytesIO(b"x"),
943
@contextlib.contextmanager
944
def assertParseError(self):
945
with self.assertRaises(SystemExit) as e:
946
with self.redirect_stderr_to_devnull():
948
# Exit code from argparse is guaranteed to be "2". Reference:
949
# https://docs.python.org/3/library
950
# /argparse.html#exiting-methods
951
self.assertEqual(e.exception.code, 2)
954
@contextlib.contextmanager
955
def redirect_stderr_to_devnull():
956
null = os.open(os.path.devnull, os.O_RDWR)
957
stderrcopy = os.dup(sys.stderr.fileno())
958
os.dup2(null, sys.stderr.fileno())
964
os.dup2(stderrcopy, sys.stderr.fileno())
967
def check_option_syntax(self, options):
968
check_option_syntax(self.parser, options)
970
def test_actions_all_conflicts_with_verbose(self):
971
for action, value in self.actions.items():
972
options = self.parser.parse_args()
973
setattr(options, action, value)
975
options.verbose = True
976
with self.assertParseError():
977
self.check_option_syntax(options)
979
def test_actions_with_client_conflicts_with_verbose(self):
980
for action, value in self.actions.items():
981
options = self.parser.parse_args()
982
setattr(options, action, value)
983
options.verbose = True
984
options.client = ["foo"]
985
with self.assertParseError():
986
self.check_option_syntax(options)
988
def test_dump_json_conflicts_with_verbose(self):
989
options = self.parser.parse_args()
990
options.dump_json = True
991
options.verbose = True
992
with self.assertParseError():
993
self.check_option_syntax(options)
995
def test_dump_json_conflicts_with_action(self):
996
for action, value in self.actions.items():
997
options = self.parser.parse_args()
998
setattr(options, action, value)
999
options.dump_json = True
1000
with self.assertParseError():
1001
self.check_option_syntax(options)
1003
def test_all_can_not_be_alone(self):
1004
options = self.parser.parse_args()
1006
with self.assertParseError():
1007
self.check_option_syntax(options)
1009
def test_all_is_ok_with_any_action(self):
1010
for action, value in self.actions.items():
1011
options = self.parser.parse_args()
1012
setattr(options, action, value)
1014
self.check_option_syntax(options)
1016
def test_any_action_is_ok_with_one_client(self):
1017
for action, value in self.actions.items():
1018
options = self.parser.parse_args()
1019
setattr(options, action, value)
1020
options.client = ["foo"]
1021
self.check_option_syntax(options)
1023
def test_one_client_with_all_actions_except_is_enabled(self):
1024
options = self.parser.parse_args()
1025
for action, value in self.actions.items():
1026
if action == "is_enabled":
1028
setattr(options, action, value)
1029
options.client = ["foo"]
1030
self.check_option_syntax(options)
1032
def test_two_clients_with_all_actions_except_is_enabled(self):
1033
options = self.parser.parse_args()
1034
for action, value in self.actions.items():
1035
if action == "is_enabled":
1037
setattr(options, action, value)
1038
options.client = ["foo", "barbar"]
1039
self.check_option_syntax(options)
1041
def test_two_clients_are_ok_with_actions_except_is_enabled(self):
1042
for action, value in self.actions.items():
1043
if action == "is_enabled":
1045
options = self.parser.parse_args()
1046
setattr(options, action, value)
1047
options.client = ["foo", "barbar"]
1048
self.check_option_syntax(options)
1050
def test_is_enabled_fails_without_client(self):
1051
options = self.parser.parse_args()
1052
options.is_enabled = True
1053
with self.assertParseError():
1054
self.check_option_syntax(options)
1056
def test_is_enabled_fails_with_two_clients(self):
1057
options = self.parser.parse_args()
1058
options.is_enabled = True
1059
options.client = ["foo", "barbar"]
1060
with self.assertParseError():
1061
self.check_option_syntax(options)
1063
def test_remove_can_only_be_combined_with_action_deny(self):
1064
for action, value in self.actions.items():
1065
if action in {"remove", "deny"}:
1067
options = self.parser.parse_args()
1068
setattr(options, action, value)
1070
options.remove = True
1071
with self.assertParseError():
1072
self.check_option_syntax(options)
1075
class Test_get_mandos_dbus_object(TestCaseWithAssertLogs):
1076
def test_calls_and_returns_get_object_on_bus(self):
1077
class MockBus(object):
1079
def get_object(mockbus_self, busname, dbus_path):
1080
# Note that "self" is still the testcase instance,
1081
# this MockBus instance is in "mockbus_self".
1082
self.assertEqual(busname, dbus_busname)
1083
self.assertEqual(dbus_path, server_dbus_path)
1084
mockbus_self.called = True
1087
mockbus = get_mandos_dbus_object(bus=MockBus())
1088
self.assertIsInstance(mockbus, MockBus)
1089
self.assertTrue(mockbus.called)
1091
def test_logs_and_exits_on_dbus_error(self):
1092
class MockBusFailing(object):
1093
def get_object(self, busname, dbus_path):
1094
raise dbus.exceptions.DBusException("Test")
1096
with self.assertLogs(log, logging.CRITICAL):
1097
with self.assertRaises(SystemExit) as e:
1098
bus = get_mandos_dbus_object(bus=MockBusFailing())
1100
if isinstance(e.exception.code, int):
1101
self.assertNotEqual(e.exception.code, 0)
1103
self.assertIsNotNone(e.exception.code)
1106
class Test_get_managed_objects(TestCaseWithAssertLogs):
1107
def test_calls_and_returns_GetManagedObjects(self):
1108
managed_objects = {"/clients/foo": { "Name": "foo"}}
1109
class MockObjectManager(object):
1110
def GetManagedObjects(self):
1111
return managed_objects
1112
retval = get_managed_objects(MockObjectManager())
1113
self.assertDictEqual(managed_objects, retval)
1115
def test_logs_and_exits_on_dbus_error(self):
1116
dbus_logger = logging.getLogger("dbus.proxies")
1118
class MockObjectManagerFailing(object):
1119
def GetManagedObjects(self):
1120
dbus_logger.error("Test")
1121
raise dbus.exceptions.DBusException("Test")
1123
class CountingHandler(logging.Handler):
1125
def emit(self, record):
1128
counting_handler = CountingHandler()
1130
dbus_logger.addHandler(counting_handler)
1133
with self.assertLogs(log, logging.CRITICAL) as watcher:
1134
with self.assertRaises(SystemExit) as e:
1135
get_managed_objects(MockObjectManagerFailing())
1137
dbus_logger.removeFilter(counting_handler)
1139
# Make sure the dbus logger was suppressed
1140
self.assertEqual(counting_handler.count, 0)
1142
# Test that the dbus_logger still works
1143
with self.assertLogs(dbus_logger, logging.ERROR):
1144
dbus_logger.error("Test")
1146
if isinstance(e.exception.code, int):
1147
self.assertNotEqual(e.exception.code, 0)
1149
self.assertIsNotNone(e.exception.code)
1152
class Test_commands_from_options(unittest.TestCase):
1154
self.parser = argparse.ArgumentParser()
1155
add_command_line_options(self.parser)
1157
def test_is_enabled(self):
1158
self.assert_command_from_args(["--is-enabled", "foo"],
1161
def assert_command_from_args(self, args, command_cls,
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)
1174
def test_is_enabled_short(self):
1175
self.assert_command_from_args(["-V", "foo"],
1178
def test_approve(self):
1179
self.assert_command_from_args(["--approve", "foo"],
1182
def test_approve_short(self):
1183
self.assert_command_from_args(["-A", "foo"], command.Approve)
1185
def test_deny(self):
1186
self.assert_command_from_args(["--deny", "foo"], command.Deny)
1188
def test_deny_short(self):
1189
self.assert_command_from_args(["-D", "foo"], command.Deny)
1191
def test_remove(self):
1192
self.assert_command_from_args(["--remove", "foo"],
1195
def test_deny_before_remove(self):
1196
options = self.parser.parse_args(["--deny", "--remove",
1198
check_option_syntax(self.parser, options)
1199
commands = commands_from_options(options)
1200
self.assertEqual(len(commands), 2)
1201
self.assertIsInstance(commands[0], command.Deny)
1202
self.assertIsInstance(commands[1], command.Remove)
1204
def test_deny_before_remove_reversed(self):
1205
options = self.parser.parse_args(["--remove", "--deny",
1207
check_option_syntax(self.parser, options)
1208
commands = commands_from_options(options)
1209
self.assertEqual(len(commands), 2)
1210
self.assertIsInstance(commands[0], command.Deny)
1211
self.assertIsInstance(commands[1], command.Remove)
1213
def test_remove_short(self):
1214
self.assert_command_from_args(["-r", "foo"], command.Remove)
1216
def test_dump_json(self):
1217
self.assert_command_from_args(["--dump-json"],
1220
def test_enable(self):
1221
self.assert_command_from_args(["--enable", "foo"],
1224
def test_enable_short(self):
1225
self.assert_command_from_args(["-e", "foo"], command.Enable)
1227
def test_disable(self):
1228
self.assert_command_from_args(["--disable", "foo"],
1231
def test_disable_short(self):
1232
self.assert_command_from_args(["-d", "foo"], command.Disable)
1234
def test_bump_timeout(self):
1235
self.assert_command_from_args(["--bump-timeout", "foo"],
1236
command.BumpTimeout)
1238
def test_bump_timeout_short(self):
1239
self.assert_command_from_args(["-b", "foo"],
1240
command.BumpTimeout)
1242
def test_start_checker(self):
1243
self.assert_command_from_args(["--start-checker", "foo"],
1244
command.StartChecker)
1246
def test_stop_checker(self):
1247
self.assert_command_from_args(["--stop-checker", "foo"],
1248
command.StopChecker)
1250
def test_approve_by_default(self):
1251
self.assert_command_from_args(["--approve-by-default", "foo"],
1252
command.ApproveByDefault)
1254
def test_deny_by_default(self):
1255
self.assert_command_from_args(["--deny-by-default", "foo"],
1256
command.DenyByDefault)
1258
def test_checker(self):
1259
self.assert_command_from_args(["--checker", ":", "foo"],
1263
def test_checker_empty(self):
1264
self.assert_command_from_args(["--checker", "", "foo"],
1268
def test_checker_short(self):
1269
self.assert_command_from_args(["-c", ":", "foo"],
1273
def test_host(self):
1274
self.assert_command_from_args(["--host", "foo.example.org",
1275
"foo"], command.SetHost,
1276
value_to_set="foo.example.org")
1278
def test_host_short(self):
1279
self.assert_command_from_args(["-H", "foo.example.org",
1280
"foo"], command.SetHost,
1281
value_to_set="foo.example.org")
1283
def test_secret_devnull(self):
1284
self.assert_command_from_args(["--secret", os.path.devnull,
1285
"foo"], command.SetSecret,
1288
def test_secret_tempfile(self):
1289
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1290
value = b"secret\0xyzzy\nbar"
1293
self.assert_command_from_args(["--secret", f.name,
1294
"foo"], command.SetSecret,
1297
def test_secret_devnull_short(self):
1298
self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1302
def test_secret_tempfile_short(self):
1303
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1304
value = b"secret\0xyzzy\nbar"
1307
self.assert_command_from_args(["-s", f.name, "foo"],
1311
def test_timeout(self):
1312
self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1314
value_to_set=300000)
1316
def test_timeout_short(self):
1317
self.assert_command_from_args(["-t", "PT5M", "foo"],
1319
value_to_set=300000)
1321
def test_extended_timeout(self):
1322
self.assert_command_from_args(["--extended-timeout", "PT15M",
1324
command.SetExtendedTimeout,
1325
value_to_set=900000)
1327
def test_interval(self):
1328
self.assert_command_from_args(["--interval", "PT2M", "foo"],
1329
command.SetInterval,
1330
value_to_set=120000)
1332
def test_interval_short(self):
1333
self.assert_command_from_args(["-i", "PT2M", "foo"],
1334
command.SetInterval,
1335
value_to_set=120000)
1337
def test_approval_delay(self):
1338
self.assert_command_from_args(["--approval-delay", "PT30S",
1340
command.SetApprovalDelay,
1343
def test_approval_duration(self):
1344
self.assert_command_from_args(["--approval-duration", "PT1S",
1346
command.SetApprovalDuration,
1349
def test_print_table(self):
1350
self.assert_command_from_args([], command.PrintTable,
1353
def test_print_table_verbose(self):
1354
self.assert_command_from_args(["--verbose"],
1358
def test_print_table_verbose_short(self):
1359
self.assert_command_from_args(["-v"], command.PrintTable,
1363
class TestCommand(unittest.TestCase):
1364
"""Abstract class for tests of command classes"""
1368
class MockClient(object):
1369
def __init__(self, name, **attributes):
1370
self.__dbus_object_path__ = "/clients/{}".format(name)
1371
self.attributes = attributes
1372
self.attributes["Name"] = name
1374
def Set(self, interface, propname, value, dbus_interface):
1375
testcase.assertEqual(interface, client_dbus_interface)
1376
testcase.assertEqual(dbus_interface,
1377
dbus.PROPERTIES_IFACE)
1378
self.attributes[propname] = value
1379
def Get(self, interface, propname, dbus_interface):
1380
testcase.assertEqual(interface, client_dbus_interface)
1381
testcase.assertEqual(dbus_interface,
1382
dbus.PROPERTIES_IFACE)
1383
return self.attributes[propname]
1384
def Approve(self, approve, dbus_interface):
1385
testcase.assertEqual(dbus_interface,
1386
client_dbus_interface)
1387
self.calls.append(("Approve", (approve,
1389
self.client = MockClient(
1391
KeyID=("92ed150794387c03ce684574b1139a65"
1392
"94a34f895daaaf09fd8ea90a27cddb12"),
1394
Host="foo.example.org",
1395
Enabled=dbus.Boolean(True),
1397
LastCheckedOK="2019-02-03T00:00:00",
1398
Created="2019-01-02T00:00:00",
1400
Fingerprint=("778827225BA7DE539C5A"
1401
"7CFA59CFF7CDBD9A5920"),
1402
CheckerRunning=dbus.Boolean(False),
1403
LastEnabled="2019-01-03T00:00:00",
1404
ApprovalPending=dbus.Boolean(False),
1405
ApprovedByDefault=dbus.Boolean(True),
1406
LastApprovalRequest="",
1408
ApprovalDuration=1000,
1409
Checker="fping -q -- %(host)s",
1410
ExtendedTimeout=900000,
1411
Expires="2019-02-04T00:00:00",
1412
LastCheckerStatus=0)
1413
self.other_client = MockClient(
1415
KeyID=("0558568eedd67d622f5c83b35a115f79"
1416
"6ab612cff5ad227247e46c2b020f441c"),
1417
Secret=b"secretbar",
1419
Enabled=dbus.Boolean(True),
1421
LastCheckedOK="2019-02-04T00:00:00",
1422
Created="2019-01-03T00:00:00",
1424
Fingerprint=("3E393AEAEFB84C7E89E2"
1425
"F547B3A107558FCA3A27"),
1426
CheckerRunning=dbus.Boolean(True),
1427
LastEnabled="2019-01-04T00:00:00",
1428
ApprovalPending=dbus.Boolean(False),
1429
ApprovedByDefault=dbus.Boolean(False),
1430
LastApprovalRequest="2019-01-03T00:00:00",
1431
ApprovalDelay=30000,
1432
ApprovalDuration=93785000,
1434
ExtendedTimeout=900000,
1435
Expires="2019-02-05T00:00:00",
1436
LastCheckerStatus=-2)
1437
self.clients = collections.OrderedDict(
1439
("/clients/foo", self.client.attributes),
1440
("/clients/barbar", self.other_client.attributes),
1442
self.one_client = {"/clients/foo": self.client.attributes}
1448
def get_object(client_bus_name, path):
1449
self.assertEqual(client_bus_name, dbus_busname)
1451
# Note: "self" here is the TestCmd instance, not
1452
# the Bus instance, since this is a static method!
1453
"/clients/foo": self.client,
1454
"/clients/barbar": self.other_client,
1459
class TestBaseCommands(TestCommand):
1461
def test_is_enabled(self):
1462
self.assertTrue(all(command.IsEnabled().is_enabled(client,
1464
for client, properties
1465
in self.clients.items()))
1467
def test_is_enabled_run_exits_successfully(self):
1468
with self.assertRaises(SystemExit) as e:
1469
command.IsEnabled().run(self.one_client)
1470
if e.exception.code is not None:
1471
self.assertEqual(e.exception.code, 0)
1473
self.assertIsNone(e.exception.code)
1475
def test_is_enabled_run_exits_with_failure(self):
1476
self.client.attributes["Enabled"] = dbus.Boolean(False)
1477
with self.assertRaises(SystemExit) as e:
1478
command.IsEnabled().run(self.one_client)
1479
if isinstance(e.exception.code, int):
1480
self.assertNotEqual(e.exception.code, 0)
1482
self.assertIsNotNone(e.exception.code)
1484
def test_approve(self):
1485
command.Approve().run(self.clients, self.bus)
1486
for clientpath in self.clients:
1487
client = self.bus.get_object(dbus_busname, clientpath)
1488
self.assertIn(("Approve", (True, client_dbus_interface)),
1491
def test_deny(self):
1492
command.Deny().run(self.clients, self.bus)
1493
for clientpath in self.clients:
1494
client = self.bus.get_object(dbus_busname, clientpath)
1495
self.assertIn(("Approve", (False, client_dbus_interface)),
1498
def test_remove(self):
1499
class MockMandos(object):
1502
def RemoveClient(self, dbus_path):
1503
self.calls.append(("RemoveClient", (dbus_path,)))
1504
mandos = MockMandos()
1505
super(TestBaseCommands, self).setUp()
1506
command.Remove().run(self.clients, self.bus, mandos)
1507
self.assertEqual(len(mandos.calls), 2)
1508
for clientpath in self.clients:
1509
self.assertIn(("RemoveClient", (clientpath,)),
1515
"KeyID": ("92ed150794387c03ce684574b1139a65"
1516
"94a34f895daaaf09fd8ea90a27cddb12"),
1517
"Host": "foo.example.org",
1520
"LastCheckedOK": "2019-02-03T00:00:00",
1521
"Created": "2019-01-02T00:00:00",
1523
"Fingerprint": ("778827225BA7DE539C5A"
1524
"7CFA59CFF7CDBD9A5920"),
1525
"CheckerRunning": False,
1526
"LastEnabled": "2019-01-03T00:00:00",
1527
"ApprovalPending": False,
1528
"ApprovedByDefault": True,
1529
"LastApprovalRequest": "",
1531
"ApprovalDuration": 1000,
1532
"Checker": "fping -q -- %(host)s",
1533
"ExtendedTimeout": 900000,
1534
"Expires": "2019-02-04T00:00:00",
1535
"LastCheckerStatus": 0,
1539
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
1540
"6ab612cff5ad227247e46c2b020f441c"),
1541
"Host": "192.0.2.3",
1544
"LastCheckedOK": "2019-02-04T00:00:00",
1545
"Created": "2019-01-03T00:00:00",
1547
"Fingerprint": ("3E393AEAEFB84C7E89E2"
1548
"F547B3A107558FCA3A27"),
1549
"CheckerRunning": True,
1550
"LastEnabled": "2019-01-04T00:00:00",
1551
"ApprovalPending": False,
1552
"ApprovedByDefault": False,
1553
"LastApprovalRequest": "2019-01-03T00:00:00",
1554
"ApprovalDelay": 30000,
1555
"ApprovalDuration": 93785000,
1557
"ExtendedTimeout": 900000,
1558
"Expires": "2019-02-05T00:00:00",
1559
"LastCheckerStatus": -2,
1563
def test_DumpJSON_normal(self):
1564
output = command.DumpJSON().output(self.clients.values())
1565
json_data = json.loads(output)
1566
self.assertDictEqual(json_data, self.expected_json)
1568
def test_DumpJSON_one_client(self):
1569
output = command.DumpJSON().output(self.one_client.values())
1570
json_data = json.loads(output)
1571
expected_json = {"foo": self.expected_json["foo"]}
1572
self.assertDictEqual(json_data, expected_json)
1574
def test_PrintTable_normal(self):
1575
output = command.PrintTable().output(self.clients.values())
1576
expected_output = "\n".join((
1577
"Name Enabled Timeout Last Successful Check",
1578
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1579
"barbar Yes 00:05:00 2019-02-04T00:00:00 ",
1581
self.assertEqual(output, expected_output)
1583
def test_PrintTable_verbose(self):
1584
output = command.PrintTable(verbose=True).output(
1585
self.clients.values())
1600
"Last Successful Check ",
1601
"2019-02-03T00:00:00 ",
1602
"2019-02-04T00:00:00 ",
1605
"2019-01-02T00:00:00 ",
1606
"2019-01-03T00:00:00 ",
1618
("92ed150794387c03ce684574b1139a6594a34f895daaaf09fd8"
1620
("0558568eedd67d622f5c83b35a115f796ab612cff5ad227247e"
1624
"778827225BA7DE539C5A7CFA59CFF7CDBD9A5920 ",
1625
"3E393AEAEFB84C7E89E2F547B3A107558FCA3A27 ",
1627
"Check Is Running ",
1632
"2019-01-03T00:00:00 ",
1633
"2019-01-04T00:00:00 ",
1635
"Approval Is Pending ",
1639
"Approved By Default ",
1643
"Last Approval Request ",
1645
"2019-01-03T00:00:00 ",
1651
"Approval Duration ",
1656
"fping -q -- %(host)s ",
1659
"Extended Timeout ",
1664
"2019-02-04T00:00:00 ",
1665
"2019-02-05T00:00:00 ",
1667
"Last Checker Status",
1672
num_lines = max(len(rows) for rows in columns)
1673
expected_output = "\n".join("".join(rows[line]
1674
for rows in columns)
1675
for line in range(num_lines))
1676
self.assertEqual(output, expected_output)
1678
def test_PrintTable_one_client(self):
1679
output = command.PrintTable().output(self.one_client.values())
1680
expected_output = "\n".join((
1681
"Name Enabled Timeout Last Successful Check",
1682
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1684
self.assertEqual(output, expected_output)
1687
class TestPropertyCmd(TestCommand):
1688
"""Abstract class for tests of command.Property classes"""
1690
if not hasattr(self, "command"):
1692
values_to_get = getattr(self, "values_to_get",
1694
for value_to_set, value_to_get in zip(self.values_to_set,
1696
for clientpath in self.clients:
1697
client = self.bus.get_object(dbus_busname, clientpath)
1698
old_value = client.attributes[self.propname]
1699
self.assertNotIsInstance(old_value, self.Unique)
1700
client.attributes[self.propname] = self.Unique()
1701
self.run_command(value_to_set, self.clients)
1702
for clientpath in self.clients:
1703
client = self.bus.get_object(dbus_busname, clientpath)
1704
value = client.attributes[self.propname]
1705
self.assertNotIsInstance(value, self.Unique)
1706
self.assertEqual(value, value_to_get)
1708
class Unique(object):
1709
"""Class for objects which exist only to be unique objects,
1710
since unittest.mock.sentinel only exists in Python 3.3"""
1712
def run_command(self, value, clients):
1713
self.command().run(clients, self.bus)
1716
class TestEnableCmd(TestPropertyCmd):
1717
command = command.Enable
1718
propname = "Enabled"
1719
values_to_set = [dbus.Boolean(True)]
1722
class TestDisableCmd(TestPropertyCmd):
1723
command = command.Disable
1724
propname = "Enabled"
1725
values_to_set = [dbus.Boolean(False)]
1728
class TestBumpTimeoutCmd(TestPropertyCmd):
1729
command = command.BumpTimeout
1730
propname = "LastCheckedOK"
1731
values_to_set = [""]
1734
class TestStartCheckerCmd(TestPropertyCmd):
1735
command = command.StartChecker
1736
propname = "CheckerRunning"
1737
values_to_set = [dbus.Boolean(True)]
1740
class TestStopCheckerCmd(TestPropertyCmd):
1741
command = command.StopChecker
1742
propname = "CheckerRunning"
1743
values_to_set = [dbus.Boolean(False)]
1746
class TestApproveByDefaultCmd(TestPropertyCmd):
1747
command = command.ApproveByDefault
1748
propname = "ApprovedByDefault"
1749
values_to_set = [dbus.Boolean(True)]
1752
class TestDenyByDefaultCmd(TestPropertyCmd):
1753
command = command.DenyByDefault
1754
propname = "ApprovedByDefault"
1755
values_to_set = [dbus.Boolean(False)]
1758
class TestPropertyValueCmd(TestPropertyCmd):
1759
"""Abstract class for tests of PropertyValueCmd classes"""
1762
if type(self) is TestPropertyValueCmd:
1764
return super(TestPropertyValueCmd, self).runTest()
1766
def run_command(self, value, clients):
1767
self.command(value).run(clients, self.bus)
1770
class TestSetCheckerCmd(TestPropertyValueCmd):
1771
command = command.SetChecker
1772
propname = "Checker"
1773
values_to_set = ["", ":", "fping -q -- %s"]
1776
class TestSetHostCmd(TestPropertyValueCmd):
1777
command = command.SetHost
1779
values_to_set = ["192.0.2.3", "foo.example.org"]
1782
class TestSetSecretCmd(TestPropertyValueCmd):
1783
command = command.SetSecret
1785
values_to_set = [io.BytesIO(b""),
1786
io.BytesIO(b"secret\0xyzzy\nbar")]
1787
values_to_get = [b"", b"secret\0xyzzy\nbar"]
1790
class TestSetTimeoutCmd(TestPropertyValueCmd):
1791
command = command.SetTimeout
1792
propname = "Timeout"
1793
values_to_set = [datetime.timedelta(),
1794
datetime.timedelta(minutes=5),
1795
datetime.timedelta(seconds=1),
1796
datetime.timedelta(weeks=1),
1797
datetime.timedelta(weeks=52)]
1798
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1801
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
1802
command = command.SetExtendedTimeout
1803
propname = "ExtendedTimeout"
1804
values_to_set = [datetime.timedelta(),
1805
datetime.timedelta(minutes=5),
1806
datetime.timedelta(seconds=1),
1807
datetime.timedelta(weeks=1),
1808
datetime.timedelta(weeks=52)]
1809
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1812
class TestSetIntervalCmd(TestPropertyValueCmd):
1813
command = command.SetInterval
1814
propname = "Interval"
1815
values_to_set = [datetime.timedelta(),
1816
datetime.timedelta(minutes=5),
1817
datetime.timedelta(seconds=1),
1818
datetime.timedelta(weeks=1),
1819
datetime.timedelta(weeks=52)]
1820
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1823
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
1824
command = command.SetApprovalDelay
1825
propname = "ApprovalDelay"
1826
values_to_set = [datetime.timedelta(),
1827
datetime.timedelta(minutes=5),
1828
datetime.timedelta(seconds=1),
1829
datetime.timedelta(weeks=1),
1830
datetime.timedelta(weeks=52)]
1831
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1834
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
1835
command = command.SetApprovalDuration
1836
propname = "ApprovalDuration"
1837
values_to_set = [datetime.timedelta(),
1838
datetime.timedelta(minutes=5),
1839
datetime.timedelta(seconds=1),
1840
datetime.timedelta(weeks=1),
1841
datetime.timedelta(weeks=52)]
1842
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1846
def should_only_run_tests():
1847
parser = argparse.ArgumentParser(add_help=False)
1848
parser.add_argument("--check", action='store_true')
1849
args, unknown_args = parser.parse_known_args()
1850
run_tests = args.check
1852
# Remove --check argument from sys.argv
1853
sys.argv[1:] = unknown_args
1856
# Add all tests from doctest strings
1857
def load_tests(loader, tests, none):
1859
tests.addTests(doctest.DocTestSuite())
497
1862
if __name__ == "__main__":
1864
if should_only_run_tests():
1865
# Call using ./tdd-python-script --check [--verbose]