491
614
"ApprovalDelay", "ApprovalDuration",
492
615
"Checker", "ExtendedTimeout", "Expires",
493
616
"LastCheckerStatus")
495
keywords = defaultkeywords
497
if options.dump_json:
498
json.dump({client["Name"]: {key:
500
if isinstance(client[key],
504
for client in clients.values()},
505
fp=sys.stdout, indent=4,
506
separators=(',', ': '))
509
print(TableOfClients(clients.values(), keywords))
511
# Process each client in the list by all selected options
512
for client in clients:
514
def set_client_prop(prop, value):
515
"""Set a Client D-Bus property"""
516
client.Set(client_interface, prop, value,
517
dbus_interface=dbus.PROPERTIES_IFACE)
519
def set_client_prop_ms(prop, value):
520
"""Set a Client D-Bus property, converted
521
from a string to milliseconds."""
522
set_client_prop(prop,
523
string_to_delta(value).total_seconds()
527
mandos_serv.RemoveClient(client.__dbus_object_path__)
529
set_client_prop("Enabled", dbus.Boolean(True))
531
set_client_prop("Enabled", dbus.Boolean(False))
532
if options.bump_timeout:
533
set_client_prop("LastCheckedOK", "")
534
if options.start_checker:
535
set_client_prop("CheckerRunning", dbus.Boolean(True))
536
if options.stop_checker:
537
set_client_prop("CheckerRunning", dbus.Boolean(False))
538
if options.is_enabled:
539
if client.Get(client_interface, "Enabled",
540
dbus_interface=dbus.PROPERTIES_IFACE):
544
if options.checker is not None:
545
set_client_prop("Checker", options.checker)
546
if options.host is not None:
547
set_client_prop("Host", options.host)
548
if options.interval is not None:
549
set_client_prop_ms("Interval", options.interval)
550
if options.approval_delay is not None:
551
set_client_prop_ms("ApprovalDelay",
552
options.approval_delay)
553
if options.approval_duration is not None:
554
set_client_prop_ms("ApprovalDuration",
555
options.approval_duration)
556
if options.timeout is not None:
557
set_client_prop_ms("Timeout", options.timeout)
558
if options.extended_timeout is not None:
559
set_client_prop_ms("ExtendedTimeout",
560
options.extended_timeout)
561
if options.secret is not None:
562
set_client_prop("Secret",
563
dbus.ByteArray(options.secret.read()))
564
if options.approved_by_default is not None:
565
set_client_prop("ApprovedByDefault",
567
.approved_by_default))
569
client.Approve(dbus.Boolean(True),
570
dbus_interface=client_interface)
572
client.Approve(dbus.Boolean(False),
573
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"
576
class Test_milliseconds_to_string(unittest.TestCase):
578
self.assertEqual(milliseconds_to_string(93785000),
580
def test_no_days(self):
581
self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
582
def test_all_zero(self):
583
self.assertEqual(milliseconds_to_string(0), "00:00:00")
584
def test_no_fractional_seconds(self):
585
self.assertEqual(milliseconds_to_string(400), "00:00:00")
586
self.assertEqual(milliseconds_to_string(900), "00:00:00")
587
self.assertEqual(milliseconds_to_string(1900), "00:00:01")
589
class Test_string_to_delta(unittest.TestCase):
590
def test_handles_basic_rfc3339(self):
591
self.assertEqual(string_to_delta("PT2H"),
592
datetime.timedelta(0, 7200))
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"))
593
904
def test_falls_back_to_pre_1_6_1_with_warning(self):
594
# assertLogs only exists in Python 3.4
595
if hasattr(self, "assertLogs"):
596
with self.assertLogs(log, logging.WARNING):
597
value = string_to_delta("2h")
905
with self.assertLogs(log, logging.WARNING):
599
906
value = string_to_delta("2h")
600
self.assertEqual(value, datetime.timedelta(0, 7200))
602
class Test_TableOfClients(unittest.TestCase):
608
"Bool": "A D-BUS Boolean",
609
"NonDbusBoolean": "A Non-D-BUS Boolean",
610
"Integer": "An Integer",
611
"Timeout": "Timedelta 1",
612
"Interval": "Timedelta 2",
613
"ApprovalDelay": "Timedelta 3",
614
"ApprovalDuration": "Timedelta 4",
615
"ExtendedTimeout": "Timedelta 5",
616
"String": "A String",
618
self.keywords = ["Attr1", "AttrTwo"]
624
"Bool": dbus.Boolean(False),
625
"NonDbusBoolean": False,
629
"ApprovalDelay": 2000,
630
"ApprovalDuration": 3000,
631
"ExtendedTimeout": 4000,
638
"Bool": dbus.Boolean(True),
639
"NonDbusBoolean": True,
642
"Interval": 93786000,
643
"ApprovalDelay": 93787000,
644
"ApprovalDuration": 93788000,
645
"ExtendedTimeout": 93789000,
646
"String": "A huge string which will not fit," * 10,
649
def test_short_header(self):
650
text = str(TableOfClients(self.clients, self.keywords,
657
self.assertEqual(text, expected_text)
658
def test_booleans(self):
659
keywords = ["Bool", "NonDbusBoolean"]
660
text = str(TableOfClients(self.clients, keywords,
663
A D-BUS Boolean A Non-D-BUS Boolean
667
self.assertEqual(text, expected_text)
668
def test_milliseconds_detection(self):
669
keywords = ["Integer", "Timeout", "Interval", "ApprovalDelay",
670
"ApprovalDuration", "ExtendedTimeout"]
671
text = str(TableOfClients(self.clients, keywords,
674
An Integer Timedelta 1 Timedelta 2 Timedelta 3 Timedelta 4 Timedelta 5
675
0 00:00:00 00:00:01 00:00:02 00:00:03 00:00:04
676
1 1T02:03:05 1T02:03:06 1T02:03:07 1T02:03:08 1T02:03:09
678
self.assertEqual(text, expected_text)
679
def test_empty_and_long_string_values(self):
680
keywords = ["String"]
681
text = str(TableOfClients(self.clients, keywords,
686
A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,
688
self.assertEqual(text, expected_text)
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 = ["client"]
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 = ["client"]
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 = ["client"]
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 = ["client1", "client2"]
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 = ["client1", "client2"]
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 = ["client1", "client2"]
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 FailingBusStub(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=FailingBusStub())
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/client": { "Name": "client"}}
1111
class ObjectManagerStub(object):
1112
def GetManagedObjects(self):
1113
return managed_objects
1114
retval = get_managed_objects(ObjectManagerStub())
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 ObjectManagerFailingStub(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(ObjectManagerFailingStub())
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", "client"],
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", "client"],
1180
def test_approve(self):
1181
self.assert_command_from_args(["--approve", "client"],
1184
def test_approve_short(self):
1185
self.assert_command_from_args(["-A", "client"],
1188
def test_deny(self):
1189
self.assert_command_from_args(["--deny", "client"],
1192
def test_deny_short(self):
1193
self.assert_command_from_args(["-D", "client"], command.Deny)
1195
def test_remove(self):
1196
self.assert_command_from_args(["--remove", "client"],
1199
def test_deny_before_remove(self):
1200
options = self.parser.parse_args(["--deny", "--remove",
1202
check_option_syntax(self.parser, options)
1203
commands = commands_from_options(options)
1204
self.assertEqual(2, len(commands))
1205
self.assertIsInstance(commands[0], command.Deny)
1206
self.assertIsInstance(commands[1], command.Remove)
1208
def test_deny_before_remove_reversed(self):
1209
options = self.parser.parse_args(["--remove", "--deny",
1211
check_option_syntax(self.parser, options)
1212
commands = commands_from_options(options)
1213
self.assertEqual(2, len(commands))
1214
self.assertIsInstance(commands[0], command.Deny)
1215
self.assertIsInstance(commands[1], command.Remove)
1217
def test_remove_short(self):
1218
self.assert_command_from_args(["-r", "client"],
1221
def test_dump_json(self):
1222
self.assert_command_from_args(["--dump-json"],
1225
def test_enable(self):
1226
self.assert_command_from_args(["--enable", "client"],
1229
def test_enable_short(self):
1230
self.assert_command_from_args(["-e", "client"],
1233
def test_disable(self):
1234
self.assert_command_from_args(["--disable", "client"],
1237
def test_disable_short(self):
1238
self.assert_command_from_args(["-d", "client"],
1241
def test_bump_timeout(self):
1242
self.assert_command_from_args(["--bump-timeout", "client"],
1243
command.BumpTimeout)
1245
def test_bump_timeout_short(self):
1246
self.assert_command_from_args(["-b", "client"],
1247
command.BumpTimeout)
1249
def test_start_checker(self):
1250
self.assert_command_from_args(["--start-checker", "client"],
1251
command.StartChecker)
1253
def test_stop_checker(self):
1254
self.assert_command_from_args(["--stop-checker", "client"],
1255
command.StopChecker)
1257
def test_approve_by_default(self):
1258
self.assert_command_from_args(["--approve-by-default",
1260
command.ApproveByDefault)
1262
def test_deny_by_default(self):
1263
self.assert_command_from_args(["--deny-by-default", "client"],
1264
command.DenyByDefault)
1266
def test_checker(self):
1267
self.assert_command_from_args(["--checker", ":", "client"],
1271
def test_checker_empty(self):
1272
self.assert_command_from_args(["--checker", "", "client"],
1276
def test_checker_short(self):
1277
self.assert_command_from_args(["-c", ":", "client"],
1281
def test_host(self):
1282
self.assert_command_from_args(
1283
["--host", "client.example.org", "client"],
1284
command.SetHost, value_to_set="client.example.org")
1286
def test_host_short(self):
1287
self.assert_command_from_args(
1288
["-H", "client.example.org", "client"], command.SetHost,
1289
value_to_set="client.example.org")
1291
def test_secret_devnull(self):
1292
self.assert_command_from_args(["--secret", os.path.devnull,
1293
"client"], command.SetSecret,
1296
def test_secret_tempfile(self):
1297
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1298
value = b"secret\0xyzzy\nbar"
1301
self.assert_command_from_args(["--secret", f.name,
1306
def test_secret_devnull_short(self):
1307
self.assert_command_from_args(["-s", os.path.devnull,
1308
"client"], command.SetSecret,
1311
def test_secret_tempfile_short(self):
1312
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1313
value = b"secret\0xyzzy\nbar"
1316
self.assert_command_from_args(["-s", f.name, "client"],
1320
def test_timeout(self):
1321
self.assert_command_from_args(["--timeout", "PT5M", "client"],
1323
value_to_set=300000)
1325
def test_timeout_short(self):
1326
self.assert_command_from_args(["-t", "PT5M", "client"],
1328
value_to_set=300000)
1330
def test_extended_timeout(self):
1331
self.assert_command_from_args(["--extended-timeout", "PT15M",
1333
command.SetExtendedTimeout,
1334
value_to_set=900000)
1336
def test_interval(self):
1337
self.assert_command_from_args(["--interval", "PT2M",
1338
"client"], command.SetInterval,
1339
value_to_set=120000)
1341
def test_interval_short(self):
1342
self.assert_command_from_args(["-i", "PT2M", "client"],
1343
command.SetInterval,
1344
value_to_set=120000)
1346
def test_approval_delay(self):
1347
self.assert_command_from_args(["--approval-delay", "PT30S",
1349
command.SetApprovalDelay,
1352
def test_approval_duration(self):
1353
self.assert_command_from_args(["--approval-duration", "PT1S",
1355
command.SetApprovalDuration,
1358
def test_print_table(self):
1359
self.assert_command_from_args([], command.PrintTable,
1362
def test_print_table_verbose(self):
1363
self.assert_command_from_args(["--verbose"],
1367
def test_print_table_verbose_short(self):
1368
self.assert_command_from_args(["-v"], command.PrintTable,
1372
class TestCommand(unittest.TestCase):
1373
"""Abstract class for tests of command classes"""
1377
class MockClient(object):
1378
def __init__(self, name, **attributes):
1379
self.__dbus_object_path__ = "/clients/{}".format(name)
1380
self.attributes = attributes
1381
self.attributes["Name"] = name
1383
def Set(self, interface, propname, value, dbus_interface):
1384
testcase.assertEqual(client_dbus_interface, interface)
1385
testcase.assertEqual(dbus.PROPERTIES_IFACE,
1387
self.attributes[propname] = value
1388
def Approve(self, approve, dbus_interface):
1389
testcase.assertEqual(client_dbus_interface,
1391
self.calls.append(("Approve", (approve,
1393
self.client = MockClient(
1395
KeyID=("92ed150794387c03ce684574b1139a65"
1396
"94a34f895daaaf09fd8ea90a27cddb12"),
1398
Host="foo.example.org",
1399
Enabled=dbus.Boolean(True),
1401
LastCheckedOK="2019-02-03T00:00:00",
1402
Created="2019-01-02T00:00:00",
1404
Fingerprint=("778827225BA7DE539C5A"
1405
"7CFA59CFF7CDBD9A5920"),
1406
CheckerRunning=dbus.Boolean(False),
1407
LastEnabled="2019-01-03T00:00:00",
1408
ApprovalPending=dbus.Boolean(False),
1409
ApprovedByDefault=dbus.Boolean(True),
1410
LastApprovalRequest="",
1412
ApprovalDuration=1000,
1413
Checker="fping -q -- %(host)s",
1414
ExtendedTimeout=900000,
1415
Expires="2019-02-04T00:00:00",
1416
LastCheckerStatus=0)
1417
self.other_client = MockClient(
1419
KeyID=("0558568eedd67d622f5c83b35a115f79"
1420
"6ab612cff5ad227247e46c2b020f441c"),
1421
Secret=b"secretbar",
1423
Enabled=dbus.Boolean(True),
1425
LastCheckedOK="2019-02-04T00:00:00",
1426
Created="2019-01-03T00:00:00",
1428
Fingerprint=("3E393AEAEFB84C7E89E2"
1429
"F547B3A107558FCA3A27"),
1430
CheckerRunning=dbus.Boolean(True),
1431
LastEnabled="2019-01-04T00:00:00",
1432
ApprovalPending=dbus.Boolean(False),
1433
ApprovedByDefault=dbus.Boolean(False),
1434
LastApprovalRequest="2019-01-03T00:00:00",
1435
ApprovalDelay=30000,
1436
ApprovalDuration=93785000,
1438
ExtendedTimeout=900000,
1439
Expires="2019-02-05T00:00:00",
1440
LastCheckerStatus=-2)
1441
self.clients = collections.OrderedDict(
1443
(self.client.__dbus_object_path__,
1444
self.client.attributes),
1445
(self.other_client.__dbus_object_path__,
1446
self.other_client.attributes),
1448
self.one_client = {self.client.__dbus_object_path__:
1449
self.client.attributes}
1453
class MockBus(object):
1455
def get_object(client_bus_name, path):
1456
self.assertEqual(dbus_busname, client_bus_name)
1457
# Note: "self" here is the TestCmd instance, not the
1458
# MockBus instance, since this is a static method!
1459
if path == self.client.__dbus_object_path__:
1461
elif path == self.other_client.__dbus_object_path__:
1462
return self.other_client
1466
class TestBaseCommands(TestCommand):
1468
def test_IsEnabled_exits_successfully(self):
1469
with self.assertRaises(SystemExit) as e:
1470
command.IsEnabled().run(self.one_client)
1471
if e.exception.code is not None:
1472
self.assertEqual(0, e.exception.code)
1474
self.assertIsNone(e.exception.code)
1476
def test_IsEnabled_exits_with_failure(self):
1477
self.client.attributes["Enabled"] = dbus.Boolean(False)
1478
with self.assertRaises(SystemExit) as e:
1479
command.IsEnabled().run(self.one_client)
1480
if isinstance(e.exception.code, int):
1481
self.assertNotEqual(0, e.exception.code)
1483
self.assertIsNotNone(e.exception.code)
1485
def test_Approve(self):
1486
command.Approve().run(self.clients, self.bus)
1487
for clientpath in self.clients:
1488
client = self.bus.get_object(dbus_busname, clientpath)
1489
self.assertIn(("Approve", (True, client_dbus_interface)),
1492
def test_Deny(self):
1493
command.Deny().run(self.clients, self.bus)
1494
for clientpath in self.clients:
1495
client = self.bus.get_object(dbus_busname, clientpath)
1496
self.assertIn(("Approve", (False, client_dbus_interface)),
1499
def test_Remove(self):
1500
class MandosSpy(object):
1503
def RemoveClient(self, dbus_path):
1504
self.calls.append(("RemoveClient", (dbus_path,)))
1505
mandos = MandosSpy()
1506
command.Remove().run(self.clients, self.bus, mandos)
1507
for clientpath in self.clients:
1508
self.assertIn(("RemoveClient", (clientpath,)),
1514
"KeyID": ("92ed150794387c03ce684574b1139a65"
1515
"94a34f895daaaf09fd8ea90a27cddb12"),
1516
"Host": "foo.example.org",
1519
"LastCheckedOK": "2019-02-03T00:00:00",
1520
"Created": "2019-01-02T00:00:00",
1522
"Fingerprint": ("778827225BA7DE539C5A"
1523
"7CFA59CFF7CDBD9A5920"),
1524
"CheckerRunning": False,
1525
"LastEnabled": "2019-01-03T00:00:00",
1526
"ApprovalPending": False,
1527
"ApprovedByDefault": True,
1528
"LastApprovalRequest": "",
1530
"ApprovalDuration": 1000,
1531
"Checker": "fping -q -- %(host)s",
1532
"ExtendedTimeout": 900000,
1533
"Expires": "2019-02-04T00:00:00",
1534
"LastCheckerStatus": 0,
1538
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
1539
"6ab612cff5ad227247e46c2b020f441c"),
1540
"Host": "192.0.2.3",
1543
"LastCheckedOK": "2019-02-04T00:00:00",
1544
"Created": "2019-01-03T00:00:00",
1546
"Fingerprint": ("3E393AEAEFB84C7E89E2"
1547
"F547B3A107558FCA3A27"),
1548
"CheckerRunning": True,
1549
"LastEnabled": "2019-01-04T00:00:00",
1550
"ApprovalPending": False,
1551
"ApprovedByDefault": False,
1552
"LastApprovalRequest": "2019-01-03T00:00:00",
1553
"ApprovalDelay": 30000,
1554
"ApprovalDuration": 93785000,
1556
"ExtendedTimeout": 900000,
1557
"Expires": "2019-02-05T00:00:00",
1558
"LastCheckerStatus": -2,
1562
def test_DumpJSON_normal(self):
1563
with self.capture_stdout_to_buffer() as buffer:
1564
command.DumpJSON().run(self.clients)
1565
json_data = json.loads(buffer.getvalue())
1566
self.assertDictEqual(self.expected_json, json_data)
1569
@contextlib.contextmanager
1570
def capture_stdout_to_buffer():
1571
capture_buffer = io.StringIO()
1572
old_stdout = sys.stdout
1573
sys.stdout = capture_buffer
1575
yield capture_buffer
1577
sys.stdout = old_stdout
1579
def test_DumpJSON_one_client(self):
1580
with self.capture_stdout_to_buffer() as buffer:
1581
command.DumpJSON().run(self.one_client)
1582
json_data = json.loads(buffer.getvalue())
1583
expected_json = {"foo": self.expected_json["foo"]}
1584
self.assertDictEqual(expected_json, json_data)
1586
def test_PrintTable_normal(self):
1587
with self.capture_stdout_to_buffer() as buffer:
1588
command.PrintTable().run(self.clients)
1589
expected_output = "\n".join((
1590
"Name Enabled Timeout Last Successful Check",
1591
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1592
"barbar Yes 00:05:00 2019-02-04T00:00:00 ",
1594
self.assertEqual(expected_output, buffer.getvalue())
1596
def test_PrintTable_verbose(self):
1597
with self.capture_stdout_to_buffer() as buffer:
1598
command.PrintTable(verbose=True).run(self.clients)
1613
"Last Successful Check ",
1614
"2019-02-03T00:00:00 ",
1615
"2019-02-04T00:00:00 ",
1618
"2019-01-02T00:00:00 ",
1619
"2019-01-03T00:00:00 ",
1631
("92ed150794387c03ce684574b1139a6594a34f895daaaf09fd8"
1633
("0558568eedd67d622f5c83b35a115f796ab612cff5ad227247e"
1637
"778827225BA7DE539C5A7CFA59CFF7CDBD9A5920 ",
1638
"3E393AEAEFB84C7E89E2F547B3A107558FCA3A27 ",
1640
"Check Is Running ",
1645
"2019-01-03T00:00:00 ",
1646
"2019-01-04T00:00:00 ",
1648
"Approval Is Pending ",
1652
"Approved By Default ",
1656
"Last Approval Request ",
1658
"2019-01-03T00:00:00 ",
1664
"Approval Duration ",
1669
"fping -q -- %(host)s ",
1672
"Extended Timeout ",
1677
"2019-02-04T00:00:00 ",
1678
"2019-02-05T00:00:00 ",
1680
"Last Checker Status",
1685
num_lines = max(len(rows) for rows in columns)
1686
expected_output = ("\n".join("".join(rows[line]
1687
for rows in columns)
1688
for line in range(num_lines))
1690
self.assertEqual(expected_output, buffer.getvalue())
1692
def test_PrintTable_one_client(self):
1693
with self.capture_stdout_to_buffer() as buffer:
1694
command.PrintTable().run(self.one_client)
1695
expected_output = "\n".join((
1696
"Name Enabled Timeout Last Successful Check",
1697
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1699
self.assertEqual(expected_output, buffer.getvalue())
1702
class TestPropertyCmd(TestCommand):
1703
"""Abstract class for tests of command.Property classes"""
1705
if not hasattr(self, "command"):
1707
values_to_get = getattr(self, "values_to_get",
1709
for value_to_set, value_to_get in zip(self.values_to_set,
1711
for clientpath in self.clients:
1712
client = self.bus.get_object(dbus_busname, clientpath)
1713
old_value = client.attributes[self.propname]
1714
client.attributes[self.propname] = self.Unique()
1715
self.run_command(value_to_set, self.clients)
1716
for clientpath in self.clients:
1717
client = self.bus.get_object(dbus_busname, clientpath)
1718
value = client.attributes[self.propname]
1719
self.assertNotIsInstance(value, self.Unique)
1720
self.assertEqual(value_to_get, value)
1722
class Unique(object):
1723
"""Class for objects which exist only to be unique objects,
1724
since unittest.mock.sentinel only exists in Python 3.3"""
1726
def run_command(self, value, clients):
1727
self.command().run(clients, self.bus)
1730
class TestEnableCmd(TestPropertyCmd):
1731
command = command.Enable
1732
propname = "Enabled"
1733
values_to_set = [dbus.Boolean(True)]
1736
class TestDisableCmd(TestPropertyCmd):
1737
command = command.Disable
1738
propname = "Enabled"
1739
values_to_set = [dbus.Boolean(False)]
1742
class TestBumpTimeoutCmd(TestPropertyCmd):
1743
command = command.BumpTimeout
1744
propname = "LastCheckedOK"
1745
values_to_set = [""]
1748
class TestStartCheckerCmd(TestPropertyCmd):
1749
command = command.StartChecker
1750
propname = "CheckerRunning"
1751
values_to_set = [dbus.Boolean(True)]
1754
class TestStopCheckerCmd(TestPropertyCmd):
1755
command = command.StopChecker
1756
propname = "CheckerRunning"
1757
values_to_set = [dbus.Boolean(False)]
1760
class TestApproveByDefaultCmd(TestPropertyCmd):
1761
command = command.ApproveByDefault
1762
propname = "ApprovedByDefault"
1763
values_to_set = [dbus.Boolean(True)]
1766
class TestDenyByDefaultCmd(TestPropertyCmd):
1767
command = command.DenyByDefault
1768
propname = "ApprovedByDefault"
1769
values_to_set = [dbus.Boolean(False)]
1772
class TestPropertyValueCmd(TestPropertyCmd):
1773
"""Abstract class for tests of PropertyValueCmd classes"""
1776
if type(self) is TestPropertyValueCmd:
1778
return super(TestPropertyValueCmd, self).runTest()
1780
def run_command(self, value, clients):
1781
self.command(value).run(clients, self.bus)
1784
class TestSetCheckerCmd(TestPropertyValueCmd):
1785
command = command.SetChecker
1786
propname = "Checker"
1787
values_to_set = ["", ":", "fping -q -- %s"]
1790
class TestSetHostCmd(TestPropertyValueCmd):
1791
command = command.SetHost
1793
values_to_set = ["192.0.2.3", "client.example.org"]
1796
class TestSetSecretCmd(TestPropertyValueCmd):
1797
command = command.SetSecret
1799
values_to_set = [io.BytesIO(b""),
1800
io.BytesIO(b"secret\0xyzzy\nbar")]
1801
values_to_get = [f.getvalue() for f in values_to_set]
1804
class TestSetTimeoutCmd(TestPropertyValueCmd):
1805
command = command.SetTimeout
1806
propname = "Timeout"
1807
values_to_set = [datetime.timedelta(),
1808
datetime.timedelta(minutes=5),
1809
datetime.timedelta(seconds=1),
1810
datetime.timedelta(weeks=1),
1811
datetime.timedelta(weeks=52)]
1812
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1815
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
1816
command = command.SetExtendedTimeout
1817
propname = "ExtendedTimeout"
1818
values_to_set = [datetime.timedelta(),
1819
datetime.timedelta(minutes=5),
1820
datetime.timedelta(seconds=1),
1821
datetime.timedelta(weeks=1),
1822
datetime.timedelta(weeks=52)]
1823
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1826
class TestSetIntervalCmd(TestPropertyValueCmd):
1827
command = command.SetInterval
1828
propname = "Interval"
1829
values_to_set = [datetime.timedelta(),
1830
datetime.timedelta(minutes=5),
1831
datetime.timedelta(seconds=1),
1832
datetime.timedelta(weeks=1),
1833
datetime.timedelta(weeks=52)]
1834
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1837
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
1838
command = command.SetApprovalDelay
1839
propname = "ApprovalDelay"
1840
values_to_set = [datetime.timedelta(),
1841
datetime.timedelta(minutes=5),
1842
datetime.timedelta(seconds=1),
1843
datetime.timedelta(weeks=1),
1844
datetime.timedelta(weeks=52)]
1845
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1848
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
1849
command = command.SetApprovalDuration
1850
propname = "ApprovalDuration"
1851
values_to_set = [datetime.timedelta(),
1852
datetime.timedelta(minutes=5),
1853
datetime.timedelta(seconds=1),
1854
datetime.timedelta(weeks=1),
1855
datetime.timedelta(weeks=52)]
1856
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]