612
412
"ApprovalDelay", "ApprovalDuration",
613
413
"Checker", "ExtendedTimeout", "Expires",
614
414
"LastCheckerStatus")
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
# Just test basic RFC 3339 functionality here, the doc string for
890
# rfc3339_duration_to_delta() already has more comprehensive
891
# tests, which is run by doctest.
893
def test_rfc3339_zero_seconds(self):
894
self.assertEqual(datetime.timedelta(),
895
string_to_delta("PT0S"))
897
def test_rfc3339_zero_days(self):
898
self.assertEqual(datetime.timedelta(), string_to_delta("P0D"))
900
def test_rfc3339_one_second(self):
901
self.assertEqual(datetime.timedelta(0, 1),
902
string_to_delta("PT1S"))
904
def test_rfc3339_two_hours(self):
905
self.assertEqual(datetime.timedelta(0, 7200),
906
string_to_delta("PT2H"))
908
def test_falls_back_to_pre_1_6_1_with_warning(self):
909
with self.assertLogs(log, logging.WARNING):
910
value = string_to_delta("2h")
911
self.assertEqual(datetime.timedelta(0, 7200), value)
914
class Test_check_option_syntax(unittest.TestCase):
916
self.parser = argparse.ArgumentParser()
917
add_command_line_options(self.parser)
919
def test_actions_requires_client_or_all(self):
920
for action, value in self.actions.items():
921
options = self.parser.parse_args()
922
setattr(options, action, value)
923
with self.assertParseError():
924
self.check_option_syntax(options)
926
# This mostly corresponds to the definition from has_actions() in
927
# check_option_syntax()
929
# The actual values set here are not that important, but we do
930
# at least stick to the correct types, even though they are
934
"bump_timeout": True,
935
"start_checker": True,
936
"stop_checker": True,
940
"timeout": datetime.timedelta(),
941
"extended_timeout": datetime.timedelta(),
942
"interval": datetime.timedelta(),
943
"approved_by_default": True,
944
"approval_delay": datetime.timedelta(),
945
"approval_duration": datetime.timedelta(),
947
"secret": io.BytesIO(b"x"),
952
@contextlib.contextmanager
953
def assertParseError(self):
954
with self.assertRaises(SystemExit) as e:
955
with self.redirect_stderr_to_devnull():
957
# Exit code from argparse is guaranteed to be "2". Reference:
958
# https://docs.python.org/3/library
959
# /argparse.html#exiting-methods
960
self.assertEqual(2, e.exception.code)
963
@contextlib.contextmanager
964
def redirect_stderr_to_devnull():
965
old_stderr = sys.stderr
966
with contextlib.closing(open(os.devnull, "w")) as null:
971
sys.stderr = old_stderr
973
def check_option_syntax(self, options):
974
check_option_syntax(self.parser, options)
976
def test_actions_all_conflicts_with_verbose(self):
977
for action, value in self.actions.items():
978
options = self.parser.parse_args()
979
setattr(options, action, value)
981
options.verbose = True
982
with self.assertParseError():
983
self.check_option_syntax(options)
985
def test_actions_with_client_conflicts_with_verbose(self):
986
for action, value in self.actions.items():
987
options = self.parser.parse_args()
988
setattr(options, action, value)
989
options.verbose = True
990
options.client = ["foo"]
991
with self.assertParseError():
992
self.check_option_syntax(options)
994
def test_dump_json_conflicts_with_verbose(self):
995
options = self.parser.parse_args()
996
options.dump_json = True
997
options.verbose = True
998
with self.assertParseError():
999
self.check_option_syntax(options)
1001
def test_dump_json_conflicts_with_action(self):
1002
for action, value in self.actions.items():
1003
options = self.parser.parse_args()
1004
setattr(options, action, value)
1005
options.dump_json = True
1006
with self.assertParseError():
1007
self.check_option_syntax(options)
1009
def test_all_can_not_be_alone(self):
1010
options = self.parser.parse_args()
1012
with self.assertParseError():
1013
self.check_option_syntax(options)
1015
def test_all_is_ok_with_any_action(self):
1016
for action, value in self.actions.items():
1017
options = self.parser.parse_args()
1018
setattr(options, action, value)
1020
self.check_option_syntax(options)
1022
def test_any_action_is_ok_with_one_client(self):
1023
for action, value in self.actions.items():
1024
options = self.parser.parse_args()
1025
setattr(options, action, value)
1026
options.client = ["foo"]
1027
self.check_option_syntax(options)
1029
def test_one_client_with_all_actions_except_is_enabled(self):
1030
options = self.parser.parse_args()
1031
for action, value in self.actions.items():
1032
if action == "is_enabled":
1034
setattr(options, action, value)
1035
options.client = ["foo"]
1036
self.check_option_syntax(options)
1038
def test_two_clients_with_all_actions_except_is_enabled(self):
1039
options = self.parser.parse_args()
1040
for action, value in self.actions.items():
1041
if action == "is_enabled":
1043
setattr(options, action, value)
1044
options.client = ["foo", "barbar"]
1045
self.check_option_syntax(options)
1047
def test_two_clients_are_ok_with_actions_except_is_enabled(self):
1048
for action, value in self.actions.items():
1049
if action == "is_enabled":
1051
options = self.parser.parse_args()
1052
setattr(options, action, value)
1053
options.client = ["foo", "barbar"]
1054
self.check_option_syntax(options)
1056
def test_is_enabled_fails_without_client(self):
1057
options = self.parser.parse_args()
1058
options.is_enabled = True
1059
with self.assertParseError():
1060
self.check_option_syntax(options)
1062
def test_is_enabled_fails_with_two_clients(self):
1063
options = self.parser.parse_args()
1064
options.is_enabled = True
1065
options.client = ["foo", "barbar"]
1066
with self.assertParseError():
1067
self.check_option_syntax(options)
1069
def test_remove_can_only_be_combined_with_action_deny(self):
1070
for action, value in self.actions.items():
1071
if action in {"remove", "deny"}:
1073
options = self.parser.parse_args()
1074
setattr(options, action, value)
1076
options.remove = True
1077
with self.assertParseError():
1078
self.check_option_syntax(options)
1081
class Test_get_mandos_dbus_object(TestCaseWithAssertLogs):
1082
def test_calls_and_returns_get_object_on_bus(self):
1083
class MockBus(object):
1085
def get_object(mockbus_self, busname, dbus_path):
1086
# Note that "self" is still the testcase instance,
1087
# this MockBus instance is in "mockbus_self".
1088
self.assertEqual(dbus_busname, busname)
1089
self.assertEqual(server_dbus_path, dbus_path)
1090
mockbus_self.called = True
1093
mockbus = get_mandos_dbus_object(bus=MockBus())
1094
self.assertIsInstance(mockbus, MockBus)
1095
self.assertTrue(mockbus.called)
1097
def test_logs_and_exits_on_dbus_error(self):
1098
class MockBusFailing(object):
1099
def get_object(self, busname, dbus_path):
1100
raise dbus.exceptions.DBusException("Test")
1102
with self.assertLogs(log, logging.CRITICAL):
1103
with self.assertRaises(SystemExit) as e:
1104
bus = get_mandos_dbus_object(bus=MockBusFailing())
1106
if isinstance(e.exception.code, int):
1107
self.assertNotEqual(0, e.exception.code)
1109
self.assertIsNotNone(e.exception.code)
1112
class Test_get_managed_objects(TestCaseWithAssertLogs):
1113
def test_calls_and_returns_GetManagedObjects(self):
1114
managed_objects = {"/clients/foo": { "Name": "foo"}}
1115
class MockObjectManager(object):
1116
def GetManagedObjects(self):
1117
return managed_objects
1118
retval = get_managed_objects(MockObjectManager())
1119
self.assertDictEqual(managed_objects, retval)
1121
def test_logs_and_exits_on_dbus_error(self):
1122
dbus_logger = logging.getLogger("dbus.proxies")
1124
class MockObjectManagerFailing(object):
1125
def GetManagedObjects(self):
1126
dbus_logger.error("Test")
1127
raise dbus.exceptions.DBusException("Test")
1129
class CountingHandler(logging.Handler):
1131
def emit(self, record):
1134
counting_handler = CountingHandler()
1136
dbus_logger.addHandler(counting_handler)
1139
with self.assertLogs(log, logging.CRITICAL) as watcher:
1140
with self.assertRaises(SystemExit) as e:
1141
get_managed_objects(MockObjectManagerFailing())
1143
dbus_logger.removeFilter(counting_handler)
1145
# Make sure the dbus logger was suppressed
1146
self.assertEqual(0, counting_handler.count)
1148
# Test that the dbus_logger still works
1149
with self.assertLogs(dbus_logger, logging.ERROR):
1150
dbus_logger.error("Test")
1152
if isinstance(e.exception.code, int):
1153
self.assertNotEqual(0, e.exception.code)
1155
self.assertIsNotNone(e.exception.code)
1158
class Test_commands_from_options(unittest.TestCase):
1160
self.parser = argparse.ArgumentParser()
1161
add_command_line_options(self.parser)
1163
def test_is_enabled(self):
1164
self.assert_command_from_args(["--is-enabled", "foo"],
1167
def assert_command_from_args(self, args, command_cls,
1169
"""Assert that parsing ARGS should result in an instance of
1170
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
1171
options = self.parser.parse_args(args)
1172
check_option_syntax(self.parser, options)
1173
commands = commands_from_options(options)
1174
self.assertEqual(1, len(commands))
1175
command = commands[0]
1176
self.assertIsInstance(command, command_cls)
1177
for key, value in cmd_attrs.items():
1178
self.assertEqual(value, getattr(command, key))
1180
def test_is_enabled_short(self):
1181
self.assert_command_from_args(["-V", "foo"],
1184
def test_approve(self):
1185
self.assert_command_from_args(["--approve", "foo"],
1188
def test_approve_short(self):
1189
self.assert_command_from_args(["-A", "foo"], command.Approve)
1191
def test_deny(self):
1192
self.assert_command_from_args(["--deny", "foo"], command.Deny)
1194
def test_deny_short(self):
1195
self.assert_command_from_args(["-D", "foo"], command.Deny)
1197
def test_remove(self):
1198
self.assert_command_from_args(["--remove", "foo"],
1201
def test_deny_before_remove(self):
1202
options = self.parser.parse_args(["--deny", "--remove",
1204
check_option_syntax(self.parser, options)
1205
commands = commands_from_options(options)
1206
self.assertEqual(2, len(commands))
1207
self.assertIsInstance(commands[0], command.Deny)
1208
self.assertIsInstance(commands[1], command.Remove)
1210
def test_deny_before_remove_reversed(self):
1211
options = self.parser.parse_args(["--remove", "--deny",
1213
check_option_syntax(self.parser, options)
1214
commands = commands_from_options(options)
1215
self.assertEqual(2, len(commands))
1216
self.assertIsInstance(commands[0], command.Deny)
1217
self.assertIsInstance(commands[1], command.Remove)
1219
def test_remove_short(self):
1220
self.assert_command_from_args(["-r", "foo"], command.Remove)
1222
def test_dump_json(self):
1223
self.assert_command_from_args(["--dump-json"],
1226
def test_enable(self):
1227
self.assert_command_from_args(["--enable", "foo"],
1230
def test_enable_short(self):
1231
self.assert_command_from_args(["-e", "foo"], command.Enable)
1233
def test_disable(self):
1234
self.assert_command_from_args(["--disable", "foo"],
1237
def test_disable_short(self):
1238
self.assert_command_from_args(["-d", "foo"], command.Disable)
1240
def test_bump_timeout(self):
1241
self.assert_command_from_args(["--bump-timeout", "foo"],
1242
command.BumpTimeout)
1244
def test_bump_timeout_short(self):
1245
self.assert_command_from_args(["-b", "foo"],
1246
command.BumpTimeout)
1248
def test_start_checker(self):
1249
self.assert_command_from_args(["--start-checker", "foo"],
1250
command.StartChecker)
1252
def test_stop_checker(self):
1253
self.assert_command_from_args(["--stop-checker", "foo"],
1254
command.StopChecker)
1256
def test_approve_by_default(self):
1257
self.assert_command_from_args(["--approve-by-default", "foo"],
1258
command.ApproveByDefault)
1260
def test_deny_by_default(self):
1261
self.assert_command_from_args(["--deny-by-default", "foo"],
1262
command.DenyByDefault)
1264
def test_checker(self):
1265
self.assert_command_from_args(["--checker", ":", "foo"],
1269
def test_checker_empty(self):
1270
self.assert_command_from_args(["--checker", "", "foo"],
1274
def test_checker_short(self):
1275
self.assert_command_from_args(["-c", ":", "foo"],
1279
def test_host(self):
1280
self.assert_command_from_args(["--host", "foo.example.org",
1281
"foo"], command.SetHost,
1282
value_to_set="foo.example.org")
1284
def test_host_short(self):
1285
self.assert_command_from_args(["-H", "foo.example.org",
1286
"foo"], command.SetHost,
1287
value_to_set="foo.example.org")
1289
def test_secret_devnull(self):
1290
self.assert_command_from_args(["--secret", os.path.devnull,
1291
"foo"], command.SetSecret,
1294
def test_secret_tempfile(self):
1295
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1296
value = b"secret\0xyzzy\nbar"
1299
self.assert_command_from_args(["--secret", f.name,
1300
"foo"], command.SetSecret,
1303
def test_secret_devnull_short(self):
1304
self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1308
def test_secret_tempfile_short(self):
1309
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1310
value = b"secret\0xyzzy\nbar"
1313
self.assert_command_from_args(["-s", f.name, "foo"],
1317
def test_timeout(self):
1318
self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1320
value_to_set=300000)
1322
def test_timeout_short(self):
1323
self.assert_command_from_args(["-t", "PT5M", "foo"],
1325
value_to_set=300000)
1327
def test_extended_timeout(self):
1328
self.assert_command_from_args(["--extended-timeout", "PT15M",
1330
command.SetExtendedTimeout,
1331
value_to_set=900000)
1333
def test_interval(self):
1334
self.assert_command_from_args(["--interval", "PT2M", "foo"],
1335
command.SetInterval,
1336
value_to_set=120000)
1338
def test_interval_short(self):
1339
self.assert_command_from_args(["-i", "PT2M", "foo"],
1340
command.SetInterval,
1341
value_to_set=120000)
1343
def test_approval_delay(self):
1344
self.assert_command_from_args(["--approval-delay", "PT30S",
1346
command.SetApprovalDelay,
1349
def test_approval_duration(self):
1350
self.assert_command_from_args(["--approval-duration", "PT1S",
1352
command.SetApprovalDuration,
1355
def test_print_table(self):
1356
self.assert_command_from_args([], command.PrintTable,
1359
def test_print_table_verbose(self):
1360
self.assert_command_from_args(["--verbose"],
1364
def test_print_table_verbose_short(self):
1365
self.assert_command_from_args(["-v"], command.PrintTable,
1369
class TestCommand(unittest.TestCase):
1370
"""Abstract class for tests of command classes"""
1374
class MockClient(object):
1375
def __init__(self, name, **attributes):
1376
self.__dbus_object_path__ = "/clients/{}".format(name)
1377
self.attributes = attributes
1378
self.attributes["Name"] = name
1380
def Set(self, interface, propname, value, dbus_interface):
1381
testcase.assertEqual(client_dbus_interface, interface)
1382
testcase.assertEqual(dbus.PROPERTIES_IFACE,
1384
self.attributes[propname] = value
1385
def Approve(self, approve, dbus_interface):
1386
testcase.assertEqual(client_dbus_interface,
1388
self.calls.append(("Approve", (approve,
1390
self.client = MockClient(
1392
KeyID=("92ed150794387c03ce684574b1139a65"
1393
"94a34f895daaaf09fd8ea90a27cddb12"),
1395
Host="foo.example.org",
1396
Enabled=dbus.Boolean(True),
1398
LastCheckedOK="2019-02-03T00:00:00",
1399
Created="2019-01-02T00:00:00",
1401
Fingerprint=("778827225BA7DE539C5A"
1402
"7CFA59CFF7CDBD9A5920"),
1403
CheckerRunning=dbus.Boolean(False),
1404
LastEnabled="2019-01-03T00:00:00",
1405
ApprovalPending=dbus.Boolean(False),
1406
ApprovedByDefault=dbus.Boolean(True),
1407
LastApprovalRequest="",
1409
ApprovalDuration=1000,
1410
Checker="fping -q -- %(host)s",
1411
ExtendedTimeout=900000,
1412
Expires="2019-02-04T00:00:00",
1413
LastCheckerStatus=0)
1414
self.other_client = MockClient(
1416
KeyID=("0558568eedd67d622f5c83b35a115f79"
1417
"6ab612cff5ad227247e46c2b020f441c"),
1418
Secret=b"secretbar",
1420
Enabled=dbus.Boolean(True),
1422
LastCheckedOK="2019-02-04T00:00:00",
1423
Created="2019-01-03T00:00:00",
1425
Fingerprint=("3E393AEAEFB84C7E89E2"
1426
"F547B3A107558FCA3A27"),
1427
CheckerRunning=dbus.Boolean(True),
1428
LastEnabled="2019-01-04T00:00:00",
1429
ApprovalPending=dbus.Boolean(False),
1430
ApprovedByDefault=dbus.Boolean(False),
1431
LastApprovalRequest="2019-01-03T00:00:00",
1432
ApprovalDelay=30000,
1433
ApprovalDuration=93785000,
1435
ExtendedTimeout=900000,
1436
Expires="2019-02-05T00:00:00",
1437
LastCheckerStatus=-2)
1438
self.clients = collections.OrderedDict(
1440
("/clients/foo", self.client.attributes),
1441
("/clients/barbar", self.other_client.attributes),
1443
self.one_client = {"/clients/foo": self.client.attributes}
1449
def get_object(client_bus_name, path):
1450
self.assertEqual(dbus_busname, client_bus_name)
1452
# Note: "self" here is the TestCmd instance, not
1453
# the Bus instance, since this is a static method!
1454
"/clients/foo": self.client,
1455
"/clients/barbar": self.other_client,
1460
class TestBaseCommands(TestCommand):
1462
def test_IsEnabled_exits_successfully(self):
1463
with self.assertRaises(SystemExit) as e:
1464
command.IsEnabled().run(self.one_client)
1465
if e.exception.code is not None:
1466
self.assertEqual(0, e.exception.code)
1468
self.assertIsNone(e.exception.code)
1470
def test_IsEnabled_exits_with_failure(self):
1471
self.client.attributes["Enabled"] = dbus.Boolean(False)
1472
with self.assertRaises(SystemExit) as e:
1473
command.IsEnabled().run(self.one_client)
1474
if isinstance(e.exception.code, int):
1475
self.assertNotEqual(0, e.exception.code)
1477
self.assertIsNotNone(e.exception.code)
1479
def test_Approve(self):
1480
command.Approve().run(self.clients, self.bus)
1481
for clientpath in self.clients:
1482
client = self.bus.get_object(dbus_busname, clientpath)
1483
self.assertIn(("Approve", (True, client_dbus_interface)),
1486
def test_Deny(self):
1487
command.Deny().run(self.clients, self.bus)
1488
for clientpath in self.clients:
1489
client = self.bus.get_object(dbus_busname, clientpath)
1490
self.assertIn(("Approve", (False, client_dbus_interface)),
1493
def test_Remove(self):
1494
class MockMandos(object):
1497
def RemoveClient(self, dbus_path):
1498
self.calls.append(("RemoveClient", (dbus_path,)))
1499
mandos = MockMandos()
1500
command.Remove().run(self.clients, self.bus, mandos)
1501
for clientpath in self.clients:
1502
self.assertIn(("RemoveClient", (clientpath,)),
1508
"KeyID": ("92ed150794387c03ce684574b1139a65"
1509
"94a34f895daaaf09fd8ea90a27cddb12"),
1510
"Host": "foo.example.org",
1513
"LastCheckedOK": "2019-02-03T00:00:00",
1514
"Created": "2019-01-02T00:00:00",
1516
"Fingerprint": ("778827225BA7DE539C5A"
1517
"7CFA59CFF7CDBD9A5920"),
1518
"CheckerRunning": False,
1519
"LastEnabled": "2019-01-03T00:00:00",
1520
"ApprovalPending": False,
1521
"ApprovedByDefault": True,
1522
"LastApprovalRequest": "",
1524
"ApprovalDuration": 1000,
1525
"Checker": "fping -q -- %(host)s",
1526
"ExtendedTimeout": 900000,
1527
"Expires": "2019-02-04T00:00:00",
1528
"LastCheckerStatus": 0,
1532
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
1533
"6ab612cff5ad227247e46c2b020f441c"),
1534
"Host": "192.0.2.3",
1537
"LastCheckedOK": "2019-02-04T00:00:00",
1538
"Created": "2019-01-03T00:00:00",
1540
"Fingerprint": ("3E393AEAEFB84C7E89E2"
1541
"F547B3A107558FCA3A27"),
1542
"CheckerRunning": True,
1543
"LastEnabled": "2019-01-04T00:00:00",
1544
"ApprovalPending": False,
1545
"ApprovedByDefault": False,
1546
"LastApprovalRequest": "2019-01-03T00:00:00",
1547
"ApprovalDelay": 30000,
1548
"ApprovalDuration": 93785000,
1550
"ExtendedTimeout": 900000,
1551
"Expires": "2019-02-05T00:00:00",
1552
"LastCheckerStatus": -2,
1556
def test_DumpJSON_normal(self):
1557
with self.capture_stdout_to_buffer() as buffer:
1558
command.DumpJSON().run(self.clients)
1559
json_data = json.loads(buffer.getvalue())
1560
self.assertDictEqual(self.expected_json, json_data)
1563
@contextlib.contextmanager
1564
def capture_stdout_to_buffer():
1565
capture_buffer = io.StringIO()
1566
old_stdout = sys.stdout
1567
sys.stdout = capture_buffer
1569
yield capture_buffer
1571
sys.stdout = old_stdout
1573
def test_DumpJSON_one_client(self):
1574
with self.capture_stdout_to_buffer() as buffer:
1575
command.DumpJSON().run(self.one_client)
1576
json_data = json.loads(buffer.getvalue())
1577
expected_json = {"foo": self.expected_json["foo"]}
1578
self.assertDictEqual(expected_json, json_data)
1580
def test_PrintTable_normal(self):
1581
with self.capture_stdout_to_buffer() as buffer:
1582
command.PrintTable().run(self.clients)
1583
expected_output = "\n".join((
1584
"Name Enabled Timeout Last Successful Check",
1585
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1586
"barbar Yes 00:05:00 2019-02-04T00:00:00 ",
1588
self.assertEqual(expected_output, buffer.getvalue())
1590
def test_PrintTable_verbose(self):
1591
with self.capture_stdout_to_buffer() as buffer:
1592
command.PrintTable(verbose=True).run(self.clients)
1607
"Last Successful Check ",
1608
"2019-02-03T00:00:00 ",
1609
"2019-02-04T00:00:00 ",
1612
"2019-01-02T00:00:00 ",
1613
"2019-01-03T00:00:00 ",
1625
("92ed150794387c03ce684574b1139a6594a34f895daaaf09fd8"
1627
("0558568eedd67d622f5c83b35a115f796ab612cff5ad227247e"
1631
"778827225BA7DE539C5A7CFA59CFF7CDBD9A5920 ",
1632
"3E393AEAEFB84C7E89E2F547B3A107558FCA3A27 ",
1634
"Check Is Running ",
1639
"2019-01-03T00:00:00 ",
1640
"2019-01-04T00:00:00 ",
1642
"Approval Is Pending ",
1646
"Approved By Default ",
1650
"Last Approval Request ",
1652
"2019-01-03T00:00:00 ",
1658
"Approval Duration ",
1663
"fping -q -- %(host)s ",
1666
"Extended Timeout ",
1671
"2019-02-04T00:00:00 ",
1672
"2019-02-05T00:00:00 ",
1674
"Last Checker Status",
1679
num_lines = max(len(rows) for rows in columns)
1680
expected_output = ("\n".join("".join(rows[line]
1681
for rows in columns)
1682
for line in range(num_lines))
1684
self.assertEqual(expected_output, buffer.getvalue())
1686
def test_PrintTable_one_client(self):
1687
with self.capture_stdout_to_buffer() as buffer:
1688
command.PrintTable().run(self.one_client)
1689
expected_output = "\n".join((
1690
"Name Enabled Timeout Last Successful Check",
1691
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1693
self.assertEqual(expected_output, buffer.getvalue())
1696
class TestPropertyCmd(TestCommand):
1697
"""Abstract class for tests of command.Property classes"""
1699
if not hasattr(self, "command"):
1701
values_to_get = getattr(self, "values_to_get",
1703
for value_to_set, value_to_get in zip(self.values_to_set,
1705
for clientpath in self.clients:
1706
client = self.bus.get_object(dbus_busname, clientpath)
1707
old_value = client.attributes[self.propname]
1708
client.attributes[self.propname] = self.Unique()
1709
self.run_command(value_to_set, self.clients)
1710
for clientpath in self.clients:
1711
client = self.bus.get_object(dbus_busname, clientpath)
1712
value = client.attributes[self.propname]
1713
self.assertNotIsInstance(value, self.Unique)
1714
self.assertEqual(value_to_get, value)
1716
class Unique(object):
1717
"""Class for objects which exist only to be unique objects,
1718
since unittest.mock.sentinel only exists in Python 3.3"""
1720
def run_command(self, value, clients):
1721
self.command().run(clients, self.bus)
1724
class TestEnableCmd(TestPropertyCmd):
1725
command = command.Enable
1726
propname = "Enabled"
1727
values_to_set = [dbus.Boolean(True)]
1730
class TestDisableCmd(TestPropertyCmd):
1731
command = command.Disable
1732
propname = "Enabled"
1733
values_to_set = [dbus.Boolean(False)]
1736
class TestBumpTimeoutCmd(TestPropertyCmd):
1737
command = command.BumpTimeout
1738
propname = "LastCheckedOK"
1739
values_to_set = [""]
1742
class TestStartCheckerCmd(TestPropertyCmd):
1743
command = command.StartChecker
1744
propname = "CheckerRunning"
1745
values_to_set = [dbus.Boolean(True)]
1748
class TestStopCheckerCmd(TestPropertyCmd):
1749
command = command.StopChecker
1750
propname = "CheckerRunning"
1751
values_to_set = [dbus.Boolean(False)]
1754
class TestApproveByDefaultCmd(TestPropertyCmd):
1755
command = command.ApproveByDefault
1756
propname = "ApprovedByDefault"
1757
values_to_set = [dbus.Boolean(True)]
1760
class TestDenyByDefaultCmd(TestPropertyCmd):
1761
command = command.DenyByDefault
1762
propname = "ApprovedByDefault"
1763
values_to_set = [dbus.Boolean(False)]
1766
class TestPropertyValueCmd(TestPropertyCmd):
1767
"""Abstract class for tests of PropertyValueCmd classes"""
1770
if type(self) is TestPropertyValueCmd:
1772
return super(TestPropertyValueCmd, self).runTest()
1774
def run_command(self, value, clients):
1775
self.command(value).run(clients, self.bus)
1778
class TestSetCheckerCmd(TestPropertyValueCmd):
1779
command = command.SetChecker
1780
propname = "Checker"
1781
values_to_set = ["", ":", "fping -q -- %s"]
1784
class TestSetHostCmd(TestPropertyValueCmd):
1785
command = command.SetHost
1787
values_to_set = ["192.0.2.3", "foo.example.org"]
1790
class TestSetSecretCmd(TestPropertyValueCmd):
1791
command = command.SetSecret
1793
values_to_set = [io.BytesIO(b""),
1794
io.BytesIO(b"secret\0xyzzy\nbar")]
1795
values_to_get = [b"", b"secret\0xyzzy\nbar"]
1798
class TestSetTimeoutCmd(TestPropertyValueCmd):
1799
command = command.SetTimeout
1800
propname = "Timeout"
1801
values_to_set = [datetime.timedelta(),
1802
datetime.timedelta(minutes=5),
1803
datetime.timedelta(seconds=1),
1804
datetime.timedelta(weeks=1),
1805
datetime.timedelta(weeks=52)]
1806
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1809
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
1810
command = command.SetExtendedTimeout
1811
propname = "ExtendedTimeout"
1812
values_to_set = [datetime.timedelta(),
1813
datetime.timedelta(minutes=5),
1814
datetime.timedelta(seconds=1),
1815
datetime.timedelta(weeks=1),
1816
datetime.timedelta(weeks=52)]
1817
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1820
class TestSetIntervalCmd(TestPropertyValueCmd):
1821
command = command.SetInterval
1822
propname = "Interval"
1823
values_to_set = [datetime.timedelta(),
1824
datetime.timedelta(minutes=5),
1825
datetime.timedelta(seconds=1),
1826
datetime.timedelta(weeks=1),
1827
datetime.timedelta(weeks=52)]
1828
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1831
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
1832
command = command.SetApprovalDelay
1833
propname = "ApprovalDelay"
1834
values_to_set = [datetime.timedelta(),
1835
datetime.timedelta(minutes=5),
1836
datetime.timedelta(seconds=1),
1837
datetime.timedelta(weeks=1),
1838
datetime.timedelta(weeks=52)]
1839
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1842
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
1843
command = command.SetApprovalDuration
1844
propname = "ApprovalDuration"
1845
values_to_set = [datetime.timedelta(),
1846
datetime.timedelta(minutes=5),
1847
datetime.timedelta(seconds=1),
1848
datetime.timedelta(weeks=1),
1849
datetime.timedelta(weeks=52)]
1850
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1854
def should_only_run_tests():
1855
parser = argparse.ArgumentParser(add_help=False)
1856
parser.add_argument("--check", action='store_true')
1857
args, unknown_args = parser.parse_known_args()
1858
run_tests = args.check
1860
# Remove --check argument from sys.argv
1861
sys.argv[1:] = unknown_args
1864
# Add all tests from doctest strings
1865
def load_tests(loader, tests, none):
1867
tests.addTests(doctest.DocTestSuite())
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)
1870
497
if __name__ == "__main__":
1872
if should_only_run_tests():
1873
# Call using ./tdd-python-script --check [--verbose]