To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/trunk
« back to all changes in this revision
Viewing changes to mandos-ctl
- browse files at revision 1085
- compare with another revision
- download diff
- download tarball
- view history from revision 1085
- Committer: Teddy Hogeborn
- Date: 2019-03-17 21:29:32 UTC
- Revision ID: teddy@recompile.se-20190317212932-r3libgz33mkb85rw
mandos-ctl: Refactor
* mandos-ctl: For Python 2, use StringIO.StringIO as a replacement for
io.StringIO, since Python 2's io.StringIO won't work
with print redirection.
(Output.run, Output.output): Remove.
(DumpJSON.output): Rename to "run" and change signature to match.
Also change code to print instead of returning
string.
(PrintTable.output): - '' -
* mandos-ctl: For Python 2, use StringIO.StringIO as a replacement for
io.StringIO, since Python 2's io.StringIO won't work
with print redirection.
(Output.run, Output.output): Remove.
(DumpJSON.output): Rename to "run" and change signature to match.
Also change code to print instead of returning
string.
(PrintTable.output): - '' -
- files modified:
- intro.xml
added
removed
mandos-ctl
45
45
import io
46
46
import tempfile
47
47
import contextlib
48
import abc
49
48
50
import dbus as dbus_python
49
import dbus
51
50
52
51
# Show warnings by default
53
52
if not sys.warnoptions:
67
66
68
67
locale.setlocale(locale.LC_ALL, "")
69
68
69
dbus_busname_domain = "se.recompile"
70
dbus_busname = dbus_busname_domain + ".Mandos"
71
server_dbus_path = "/"
72
server_dbus_interface = dbus_busname_domain + ".Mandos"
73
client_dbus_interface = dbus_busname_domain + ".Mandos.Client"
74
del dbus_busname_domain
70
75
version = "1.8.3"
71
76
72
77
78
try:
79
dbus.OBJECT_MANAGER_IFACE
80
except AttributeError:
81
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
82
83
73
84
def main():
74
85
parser = argparse.ArgumentParser()
86
75
87
add_command_line_options(parser)
76
88
77
89
options = parser.parse_args()
90
78
91
check_option_syntax(parser, options)
79
92
80
93
clientnames = options.client
82
95
if options.debug:
83
96
log.setLevel(logging.DEBUG)
84
97
85
bus = dbus_python_adapter.CachingBus(dbus_python)
86
87
try:
88
all_clients = bus.get_clients_and_properties()
89
except dbus.ConnectFailed as e:
90
log.critical("Could not connect to Mandos server: %s", e)
91
sys.exit(1)
92
except dbus.Error as e:
93
log.critical(
94
"Failed to access Mandos server through D-Bus:\n%s", e)
95
sys.exit(1)
98
bus = dbus.SystemBus()
99
100
mandos_dbus_object = get_mandos_dbus_object(bus)
101
102
mandos_serv = dbus.Interface(
103
mandos_dbus_object, dbus_interface=server_dbus_interface)
104
mandos_serv_object_manager = dbus.Interface(
105
mandos_dbus_object, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
106
107
managed_objects = get_managed_objects(mandos_serv_object_manager)
108
109
all_clients = {}
110
for path, ifs_and_props in managed_objects.items():
111
try:
112
all_clients[path] = ifs_and_props[client_dbus_interface]
113
except KeyError:
114
pass
96
115
97
116
# Compile dict of (clientpath: properties) to process
98
117
if not clientnames:
111
130
commands = commands_from_options(options)
112
131
113
132
for command in commands:
114
command.run(clients, bus)
133
command.run(clients, bus, mandos_serv)
115
134
116
135
117
136
def add_command_line_options(parser):
407
426
options.remove = True
408
427
409
428
410
411
class dbus(object):
412
413
class SystemBus(object):
414
415
object_manager_iface = "org.freedesktop.DBus.ObjectManager"
416
def get_managed_objects(self, busname, objectpath):
417
return self.call_method("GetManagedObjects", busname,
418
objectpath,
419
self.object_manager_iface)
420
421
properties_iface = "org.freedesktop.DBus.Properties"
422
def set_property(self, busname, objectpath, interface, key,
423
value):
424
self.call_method("Set", busname, objectpath,
425
self.properties_iface, interface, key,
426
value)
427
428
429
class MandosBus(SystemBus):
430
busname_domain = "se.recompile"
431
busname = busname_domain + ".Mandos"
432
server_path = "/"
433
server_interface = busname_domain + ".Mandos"
434
client_interface = busname_domain + ".Mandos.Client"
435
del busname_domain
436
437
def get_clients_and_properties(self):
438
managed_objects = self.get_managed_objects(
439
self.busname, self.server_path)
440
return {objpath: properties[self.client_interface]
441
for objpath, properties in managed_objects.items()
442
if self.client_interface in properties}
443
444
def set_client_property(self, objectpath, key, value):
445
return self.set_property(self.busname, objectpath,
446
self.client_interface, key,
447
value)
448
449
def call_client_method(self, objectpath, method, *args):
450
return self.call_method(method, self.busname, objectpath,
451
self.client_interface, *args)
452
453
def call_server_method(self, method, *args):
454
return self.call_method(method, self.busname,
455
self.server_path,
456
self.server_interface, *args)
457
458
class Error(Exception):
459
pass
460
461
class ConnectFailed(Error):
462
pass
463
464
465
class dbus_python_adapter(object):
466
467
class SystemBus(dbus.MandosBus):
468
"""Use dbus-python"""
469
470
def __init__(self, module=dbus_python):
471
self.dbus_python = module
472
self.bus = self.dbus_python.SystemBus()
473
474
@contextlib.contextmanager
475
def convert_exception(self, exception_class=dbus.Error):
476
try:
477
yield
478
except self.dbus_python.exceptions.DBusException as e:
479
# This does what "raise from" would do
480
exc = exception_class(*e.args)
481
exc.__cause__ = e
482
raise exc
483
484
def call_method(self, methodname, busname, objectpath,
485
interface, *args):
486
proxy_object = self.get_object(busname, objectpath)
487
log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
488
interface, methodname,
489
", ".join(repr(a) for a in args))
490
method = getattr(proxy_object, methodname)
491
with self.convert_exception():
492
with dbus_python_adapter.SilenceLogger(
493
"dbus.proxies"):
494
value = method(*args, dbus_interface=interface)
495
return self.type_filter(value)
496
497
def get_object(self, busname, objectpath):
498
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
499
busname, objectpath)
500
with self.convert_exception(dbus.ConnectFailed):
501
return self.bus.get_object(busname, objectpath)
502
503
def type_filter(self, value):
504
"""Convert the most bothersome types to Python types"""
505
if isinstance(value, self.dbus_python.Boolean):
506
return bool(value)
507
if isinstance(value, self.dbus_python.ObjectPath):
508
return str(value)
509
# Also recurse into dictionaries
510
if isinstance(value, self.dbus_python.Dictionary):
511
return {self.type_filter(key):
512
self.type_filter(subval)
513
for key, subval in value.items()}
514
return value
515
516
517
class SilenceLogger(object):
518
"Simple context manager to silence a particular logger"
519
def __init__(self, loggername):
520
self.logger = logging.getLogger(loggername)
521
522
def __enter__(self):
523
self.logger.addFilter(self.nullfilter)
524
525
class NullFilter(logging.Filter):
526
def filter(self, record):
527
return False
528
529
nullfilter = NullFilter()
530
531
def __exit__(self, exc_type, exc_val, exc_tb):
532
self.logger.removeFilter(self.nullfilter)
533
534
535
class CachingBus(SystemBus):
536
"""A caching layer for dbus_python_adapter.SystemBus"""
537
def __init__(self, *args, **kwargs):
538
self.object_cache = {}
539
super(dbus_python_adapter.CachingBus,
540
self).__init__(*args, **kwargs)
541
def get_object(self, busname, objectpath):
542
try:
543
return self.object_cache[(busname, objectpath)]
544
except KeyError:
545
new_object = super(
546
dbus_python_adapter.CachingBus,
547
self).get_object(busname, objectpath)
548
self.object_cache[(busname, objectpath)] = new_object
549
return new_object
429
def get_mandos_dbus_object(bus):
430
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
431
dbus_busname, server_dbus_path)
432
with if_dbus_exception_log_with_exception_and_exit(
433
"Could not connect to Mandos server: %s"):
434
mandos_dbus_object = bus.get_object(dbus_busname,
435
server_dbus_path)
436
return mandos_dbus_object
437
438
439
@contextlib.contextmanager
440
def if_dbus_exception_log_with_exception_and_exit(*args, **kwargs):
441
try:
442
yield
443
except dbus.exceptions.DBusException as e:
444
log.critical(*(args + (e,)), **kwargs)
445
sys.exit(1)
446
447
448
def get_managed_objects(object_manager):
449
log.debug("D-Bus: %s:%s:%s.GetManagedObjects()", dbus_busname,
450
server_dbus_path, dbus.OBJECT_MANAGER_IFACE)
451
with if_dbus_exception_log_with_exception_and_exit(
452
"Failed to access Mandos server through D-Bus:\n%s"):
453
with SilenceLogger("dbus.proxies"):
454
managed_objects = object_manager.GetManagedObjects()
455
return managed_objects
456
457
458
class SilenceLogger(object):
459
"Simple context manager to silence a particular logger"
460
def __init__(self, loggername):
461
self.logger = logging.getLogger(loggername)
462
463
def __enter__(self):
464
self.logger.addFilter(self.nullfilter)
465
return self
466
467
class NullFilter(logging.Filter):
468
def filter(self, record):
469
return False
470
471
nullfilter = NullFilter()
472
473
def __exit__(self, exc_type, exc_val, exc_tb):
474
self.logger.removeFilter(self.nullfilter)
550
475
551
476
552
477
def commands_from_options(options):
629
554
630
555
class Base(object):
631
556
"""Abstract base class for commands"""
632
def run(self, clients, bus=None):
557
def run(self, clients, bus=None, mandos=None):
633
558
"""Normal commands should implement run_on_one_client(),
634
559
but commands which want to operate on all clients at the same time can
635
560
override this run() method instead.
636
561
"""
637
self.bus = bus
638
for client, properties in clients.items():
562
self.mandos = mandos
563
for clientpath, properties in clients.items():
564
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
565
dbus_busname, str(clientpath))
566
client = bus.get_object(dbus_busname, clientpath)
639
567
self.run_on_one_client(client, properties)
640
568
641
569
642
570
class IsEnabled(Base):
643
def run(self, clients, bus=None):
644
properties = next(iter(clients.values()))
645
if properties["Enabled"]:
571
def run(self, clients, bus=None, mandos=None):
572
client, properties = next(iter(clients.items()))
573
if self.is_enabled(client, properties):
646
574
sys.exit(0)
647
575
sys.exit(1)
576
def is_enabled(self, client, properties):
577
return properties["Enabled"]
648
578
649
579
650
580
class Approve(Base):
651
581
def run_on_one_client(self, client, properties):
652
self.bus.call_client_method(client, "Approve", True)
582
log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
583
client.__dbus_object_path__,
584
client_dbus_interface)
585
client.Approve(dbus.Boolean(True),
586
dbus_interface=client_dbus_interface)
653
587
654
588
655
589
class Deny(Base):
656
590
def run_on_one_client(self, client, properties):
657
self.bus.call_client_method(client, "Approve", False)
591
log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
592
client.__dbus_object_path__,
593
client_dbus_interface)
594
client.Approve(dbus.Boolean(False),
595
dbus_interface=client_dbus_interface)
658
596
659
597
660
598
class Remove(Base):
661
def run(self, clients, bus):
662
for clientpath in frozenset(clients.keys()):
663
bus.call_server_method("RemoveClient", clientpath)
599
def run_on_one_client(self, client, properties):
600
log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)",
601
dbus_busname, server_dbus_path,
602
server_dbus_interface,
603
str(client.__dbus_object_path__))
604
self.mandos.RemoveClient(client.__dbus_object_path__)
664
605
665
606
666
607
class Output(Base):
676
617
677
618
678
619
class DumpJSON(Output):
679
def run(self, clients, bus=None):
680
data = {properties["Name"]:
681
{key: properties[key]
620
def run(self, clients, bus=None, mandos=None):
621
data = {client["Name"]:
622
{key: self.dbus_boolean_to_bool(client[key])
682
623
for key in self.all_keywords}
683
for properties in clients.values()}
624
for client in clients.values()}
684
625
print(json.dumps(data, indent=4, separators=(',', ': ')))
685
626
627
@staticmethod
628
def dbus_boolean_to_bool(value):
629
if isinstance(value, dbus.Boolean):
630
value = bool(value)
631
return value
632
686
633
687
634
class PrintTable(Output):
688
635
def __init__(self, verbose=False):
689
636
self.verbose = verbose
690
637
691
def run(self, clients, bus=None):
638
def run(self, clients, bus=None, mandos=None):
692
639
default_keywords = ("Name", "Enabled", "Timeout",
693
640
"LastCheckedOK")
694
641
keywords = default_keywords
755
702
756
703
@classmethod
757
704
def valuetostring(cls, value, keyword):
758
if isinstance(value, bool):
705
if isinstance(value, dbus.Boolean):
759
706
return "Yes" if value else "No"
760
707
if keyword in ("Timeout", "Interval", "ApprovalDelay",
761
708
"ApprovalDuration", "ExtendedTimeout"):
781
728
seconds=td.seconds % 60))
782
729
783
730
784
class PropertySetter(Base):
731
class Property(Base):
785
732
"Abstract class for Actions for setting one client property"
786
733
787
def run_on_one_client(self, client, properties=None):
734
def run_on_one_client(self, client, properties):
788
735
"""Set the Client's D-Bus property"""
789
self.bus.set_client_property(client, self.propname,
790
self.value_to_set)
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,
741
dbus.Boolean)
742
else bool(self.value_to_set))
743
client.Set(client_dbus_interface, self.propname,
744
self.value_to_set,
745
dbus_interface=dbus.PROPERTIES_IFACE)
791
746
792
747
@property
793
748
def propname(self):
794
749
raise NotImplementedError()
795
750
796
751
797
class Enable(PropertySetter):
798
propname = "Enabled"
799
value_to_set = True
800
801
802
class Disable(PropertySetter):
803
propname = "Enabled"
804
value_to_set = False
805
806
807
class BumpTimeout(PropertySetter):
752
class Enable(Property):
753
propname = "Enabled"
754
value_to_set = dbus.Boolean(True)
755
756
757
class Disable(Property):
758
propname = "Enabled"
759
value_to_set = dbus.Boolean(False)
760
761
762
class BumpTimeout(Property):
808
763
propname = "LastCheckedOK"
809
764
value_to_set = ""
810
765
811
766
812
class StartChecker(PropertySetter):
813
propname = "CheckerRunning"
814
value_to_set = True
815
816
817
class StopChecker(PropertySetter):
818
propname = "CheckerRunning"
819
value_to_set = False
820
821
822
class ApproveByDefault(PropertySetter):
823
propname = "ApprovedByDefault"
824
value_to_set = True
825
826
827
class DenyByDefault(PropertySetter):
828
propname = "ApprovedByDefault"
829
value_to_set = False
830
831
832
class PropertySetterValue(PropertySetter):
833
"""Abstract class for PropertySetter recieving a value as
834
constructor argument instead of a class attribute."""
767
class StartChecker(Property):
768
propname = "CheckerRunning"
769
value_to_set = dbus.Boolean(True)
770
771
772
class StopChecker(Property):
773
propname = "CheckerRunning"
774
value_to_set = dbus.Boolean(False)
775
776
777
class ApproveByDefault(Property):
778
propname = "ApprovedByDefault"
779
value_to_set = dbus.Boolean(True)
780
781
782
class DenyByDefault(Property):
783
propname = "ApprovedByDefault"
784
value_to_set = dbus.Boolean(False)
785
786
787
class PropertyValue(Property):
788
"Abstract class for Property recieving a value as argument"
835
789
def __init__(self, value):
836
790
self.value_to_set = value
837
791
838
792
839
class SetChecker(PropertySetterValue):
793
class SetChecker(PropertyValue):
840
794
propname = "Checker"
841
795
842
796
843
class SetHost(PropertySetterValue):
797
class SetHost(PropertyValue):
844
798
propname = "Host"
845
799
846
800
847
class SetSecret(PropertySetterValue):
801
class SetSecret(PropertyValue):
848
802
propname = "Secret"
849
803
850
804
@property
858
812
value.close()
859
813
860
814
861
class PropertySetterValueMilliseconds(PropertySetterValue):
862
"""Abstract class for PropertySetterValue taking a value
863
argument as a datetime.timedelta() but should store it as
864
milliseconds."""
815
class MillisecondsPropertyValueArgument(PropertyValue):
816
"""Abstract class for PropertyValue taking a value argument as
817
a datetime.timedelta() but should store it as milliseconds."""
865
818
866
819
@property
867
820
def value_to_set(self):
873
826
self._vts = int(round(value.total_seconds() * 1000))
874
827
875
828
876
class SetTimeout(PropertySetterValueMilliseconds):
829
class SetTimeout(MillisecondsPropertyValueArgument):
877
830
propname = "Timeout"
878
831
879
832
880
class SetExtendedTimeout(PropertySetterValueMilliseconds):
833
class SetExtendedTimeout(MillisecondsPropertyValueArgument):
881
834
propname = "ExtendedTimeout"
882
835
883
836
884
class SetInterval(PropertySetterValueMilliseconds):
837
class SetInterval(MillisecondsPropertyValueArgument):
885
838
propname = "Interval"
886
839
887
840
888
class SetApprovalDelay(PropertySetterValueMilliseconds):
841
class SetApprovalDelay(MillisecondsPropertyValueArgument):
889
842
propname = "ApprovalDelay"
890
843
891
844
892
class SetApprovalDuration(PropertySetterValueMilliseconds):
845
class SetApprovalDuration(MillisecondsPropertyValueArgument):
893
846
propname = "ApprovalDuration"
894
847
895
848
928
881
"output"))
929
882
930
883
931
class Unique(object):
932
"""Class for objects which exist only to be unique objects, since
933
unittest.mock.sentinel only exists in Python 3.3"""
934
935
936
884
class Test_string_to_delta(TestCaseWithAssertLogs):
937
885
# Just test basic RFC 3339 functionality here, the doc string for
938
886
# rfc3339_duration_to_delta() already has more comprehensive
939
# tests, which are run by doctest.
887
# tests, which is run by doctest.
940
888
941
889
def test_rfc3339_zero_seconds(self):
942
890
self.assertEqual(datetime.timedelta(),
1035
983
options = self.parser.parse_args()
1036
984
setattr(options, action, value)
1037
985
options.verbose = True
1038
options.client = ["client"]
986
options.client = ["foo"]
1039
987
with self.assertParseError():
1040
988
self.check_option_syntax(options)
1041
989
1071
1019
for action, value in self.actions.items():
1072
1020
options = self.parser.parse_args()
1073
1021
setattr(options, action, value)
1074
options.client = ["client"]
1022
options.client = ["foo"]
1075
1023
self.check_option_syntax(options)
1076
1024
1077
1025
def test_one_client_with_all_actions_except_is_enabled(self):
1080
1028
if action == "is_enabled":
1081
1029
continue
1082
1030
setattr(options, action, value)
1083
options.client = ["client"]
1031
options.client = ["foo"]
1084
1032
self.check_option_syntax(options)
1085
1033
1086
1034
def test_two_clients_with_all_actions_except_is_enabled(self):
1089
1037
if action == "is_enabled":
1090
1038
continue
1091
1039
setattr(options, action, value)
1092
options.client = ["client1", "client2"]
1040
options.client = ["foo", "barbar"]
1093
1041
self.check_option_syntax(options)
1094
1042
1095
1043
def test_two_clients_are_ok_with_actions_except_is_enabled(self):
1098
1046
continue
1099
1047
options = self.parser.parse_args()
1100
1048
setattr(options, action, value)
1101
options.client = ["client1", "client2"]
1049
options.client = ["foo", "barbar"]
1102
1050
self.check_option_syntax(options)
1103
1051
1104
1052
def test_is_enabled_fails_without_client(self):
1110
1058
def test_is_enabled_fails_with_two_clients(self):
1111
1059
options = self.parser.parse_args()
1112
1060
options.is_enabled = True
1113
options.client = ["client1", "client2"]
1061
options.client = ["foo", "barbar"]
1114
1062
with self.assertParseError():
1115
1063
self.check_option_syntax(options)
1116
1064
1126
1074
self.check_option_syntax(options)
1127
1075
1128
1076
1129
class Test_dbus_exceptions(unittest.TestCase):
1130
1131
def test_dbus_ConnectFailed_is_Error(self):
1132
with self.assertRaises(dbus.Error):
1133
raise dbus.ConnectFailed()
1134
1135
1136
class Test_dbus_MandosBus(unittest.TestCase):
1137
1138
class MockMandosBus(dbus.MandosBus):
1139
def __init__(self):
1140
self._name = "se.recompile.Mandos"
1141
self._server_path = "/"
1142
self._server_interface = "se.recompile.Mandos"
1143
self._client_interface = "se.recompile.Mandos.Client"
1144
self.calls = []
1145
self.call_method_return = Unique()
1146
1147
def call_method(self, methodname, busname, objectpath,
1148
interface, *args):
1149
self.calls.append((methodname, busname, objectpath,
1150
interface, args))
1151
return self.call_method_return
1152
1153
def setUp(self):
1154
self.bus = self.MockMandosBus()
1155
1156
def test_set_client_property(self):
1157
self.bus.set_client_property("objectpath", "key", "value")
1158
expected_call = ("Set", self.bus._name, "objectpath",
1159
"org.freedesktop.DBus.Properties",
1160
(self.bus._client_interface, "key", "value"))
1161
self.assertIn(expected_call, self.bus.calls)
1162
1163
def test_call_client_method(self):
1164
ret = self.bus.call_client_method("objectpath", "methodname")
1165
self.assertIs(self.bus.call_method_return, ret)
1166
expected_call = ("methodname", self.bus._name, "objectpath",
1167
self.bus._client_interface, ())
1168
self.assertIn(expected_call, self.bus.calls)
1169
1170
def test_call_client_method_with_args(self):
1171
args = (Unique(), Unique())
1172
ret = self.bus.call_client_method("objectpath", "methodname",
1173
*args)
1174
self.assertIs(self.bus.call_method_return, ret)
1175
expected_call = ("methodname", self.bus._name, "objectpath",
1176
self.bus._client_interface,
1177
(args[0], args[1]))
1178
self.assertIn(expected_call, self.bus.calls)
1179
1180
def test_get_clients_and_properties(self):
1181
managed_objects = {
1182
"objectpath": {
1183
self.bus._client_interface: {
1184
"key": "value",
1185
"bool": True,
1186
},
1187
"irrelevant_interface": {
1188
"key": "othervalue",
1189
"bool": False,
1190
},
1191
},
1192
"other_objectpath": {
1193
"other_irrelevant_interface": {
1194
"key": "value 3",
1195
"bool": None,
1196
},
1197
},
1198
}
1199
expected_clients_and_properties = {
1200
"objectpath": {
1201
"key": "value",
1202
"bool": True,
1203
}
1204
}
1205
self.bus.call_method_return = managed_objects
1206
ret = self.bus.get_clients_and_properties()
1207
self.assertDictEqual(expected_clients_and_properties, ret)
1208
expected_call = ("GetManagedObjects", self.bus._name,
1209
self.bus._server_path,
1210
"org.freedesktop.DBus.ObjectManager", ())
1211
self.assertIn(expected_call, self.bus.calls)
1212
1213
def test_call_server_method(self):
1214
ret = self.bus.call_server_method("methodname")
1215
self.assertIs(self.bus.call_method_return, ret)
1216
expected_call = ("methodname", self.bus._name,
1217
self.bus._server_path,
1218
self.bus._server_interface, ())
1219
self.assertIn(expected_call, self.bus.calls)
1220
1221
def test_call_server_method_with_args(self):
1222
args = (Unique(), Unique())
1223
ret = self.bus.call_server_method("methodname", *args)
1224
self.assertIs(self.bus.call_method_return, ret)
1225
expected_call = ("methodname", self.bus._name,
1226
self.bus._server_path,
1227
self.bus._server_interface,
1228
(args[0], args[1]))
1229
self.assertIn(expected_call, self.bus.calls)
1230
1231
1232
class Test_dbus_python_adapter_SystemBus(TestCaseWithAssertLogs):
1233
1234
def MockDBusPython_func(self, func):
1235
class mock_dbus_python(object):
1236
"""mock dbus-python module"""
1237
class exceptions(object):
1238
"""Pseudo-namespace"""
1239
class DBusException(Exception):
1240
pass
1241
class SystemBus(object):
1242
@staticmethod
1243
def get_object(busname, objectpath):
1244
DBusObject = collections.namedtuple(
1245
"DBusObject", ("methodname",))
1246
def method(*args, **kwargs):
1247
self.assertEqual({"dbus_interface":
1248
"interface"},
1249
kwargs)
1250
return func(*args)
1251
return DBusObject(methodname=method)
1252
class Boolean(object):
1253
def __init__(self, value):
1254
self.value = bool(value)
1255
def __bool__(self):
1256
return self.value
1257
if sys.version_info.major == 2:
1258
__nonzero__ = __bool__
1259
class ObjectPath(str):
1260
pass
1261
class Dictionary(dict):
1262
pass
1263
return mock_dbus_python
1264
1265
def call_method(self, bus, methodname, busname, objectpath,
1266
interface, *args):
1267
with self.assertLogs(log, logging.DEBUG):
1268
return bus.call_method(methodname, busname, objectpath,
1269
interface, *args)
1270
1271
def test_call_method_returns(self):
1272
expected_method_return = Unique()
1273
method_args = (Unique(), Unique())
1274
def func(*args):
1275
self.assertEqual(len(method_args), len(args))
1276
for marg, arg in zip(method_args, args):
1277
self.assertIs(marg, arg)
1278
return expected_method_return
1279
mock_dbus_python = self.MockDBusPython_func(func)
1280
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1281
ret = self.call_method(bus, "methodname", "busname",
1282
"objectpath", "interface",
1283
*method_args)
1284
self.assertIs(ret, expected_method_return)
1285
1286
def test_call_method_filters_bool_true(self):
1287
def func():
1288
return method_return
1289
mock_dbus_python = self.MockDBusPython_func(func)
1290
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1291
method_return = mock_dbus_python.Boolean(True)
1292
ret = self.call_method(bus, "methodname", "busname",
1293
"objectpath", "interface")
1294
self.assertTrue(ret)
1295
self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1296
1297
def test_call_method_filters_bool_false(self):
1298
def func():
1299
return method_return
1300
mock_dbus_python = self.MockDBusPython_func(func)
1301
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1302
method_return = mock_dbus_python.Boolean(False)
1303
ret = self.call_method(bus, "methodname", "busname",
1304
"objectpath", "interface")
1305
self.assertFalse(ret)
1306
self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1307
1308
def test_call_method_filters_objectpath(self):
1309
def func():
1310
return method_return
1311
mock_dbus_python = self.MockDBusPython_func(func)
1312
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1313
method_return = mock_dbus_python.ObjectPath("objectpath")
1314
ret = self.call_method(bus, "methodname", "busname",
1315
"objectpath", "interface")
1316
self.assertEqual("objectpath", ret)
1317
self.assertIsNot("objectpath", ret)
1318
self.assertNotIsInstance(ret, mock_dbus_python.ObjectPath)
1319
1320
def test_call_method_filters_booleans_in_dict(self):
1321
def func():
1322
return method_return
1323
mock_dbus_python = self.MockDBusPython_func(func)
1324
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1325
method_return = mock_dbus_python.Dictionary(
1326
{mock_dbus_python.Boolean(True):
1327
mock_dbus_python.Boolean(False),
1328
mock_dbus_python.Boolean(False):
1329
mock_dbus_python.Boolean(True)})
1330
ret = self.call_method(bus, "methodname", "busname",
1331
"objectpath", "interface")
1332
expected_method_return = {True: False,
1333
False: True}
1334
self.assertEqual(expected_method_return, ret)
1335
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1336
1337
def test_call_method_filters_objectpaths_in_dict(self):
1338
def func():
1339
return method_return
1340
mock_dbus_python = self.MockDBusPython_func(func)
1341
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1342
method_return = mock_dbus_python.Dictionary(
1343
{mock_dbus_python.ObjectPath("objectpath_key_1"):
1344
mock_dbus_python.ObjectPath("objectpath_value_1"),
1345
mock_dbus_python.ObjectPath("objectpath_key_2"):
1346
mock_dbus_python.ObjectPath("objectpath_value_2")})
1347
ret = self.call_method(bus, "methodname", "busname",
1348
"objectpath", "interface")
1349
expected_method_return = {str(key): str(value)
1350
for key, value in
1351
method_return.items()}
1352
self.assertEqual(expected_method_return, ret)
1353
self.assertIsInstance(ret, dict)
1354
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1355
1356
def test_call_method_filters_dict_in_dict(self):
1357
def func():
1358
return method_return
1359
mock_dbus_python = self.MockDBusPython_func(func)
1360
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1361
method_return = mock_dbus_python.Dictionary(
1362
{"key1": mock_dbus_python.Dictionary({"key11": "value11",
1363
"key12": "value12"}),
1364
"key2": mock_dbus_python.Dictionary({"key21": "value21",
1365
"key22": "value22"})})
1366
ret = self.call_method(bus, "methodname", "busname",
1367
"objectpath", "interface")
1368
expected_method_return = {
1369
"key1": {"key11": "value11",
1370
"key12": "value12"},
1371
"key2": {"key21": "value21",
1372
"key22": "value22"},
1373
}
1374
self.assertEqual(expected_method_return, ret)
1375
self.assertIsInstance(ret, dict)
1376
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1377
for key, value in ret.items():
1378
self.assertIsInstance(value, dict)
1379
self.assertEqual(expected_method_return[key], value)
1380
self.assertNotIsInstance(value,
1381
mock_dbus_python.Dictionary)
1382
1383
def test_call_method_filters_dict_three_deep(self):
1384
def func():
1385
return method_return
1386
mock_dbus_python = self.MockDBusPython_func(func)
1387
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1388
method_return = mock_dbus_python.Dictionary(
1389
{"key1":
1390
mock_dbus_python.Dictionary(
1391
{"key2":
1392
mock_dbus_python.Dictionary(
1393
{"key3":
1394
mock_dbus_python.Boolean(True),
1395
}),
1396
}),
1397
})
1398
ret = self.call_method(bus, "methodname", "busname",
1399
"objectpath", "interface")
1400
expected_method_return = {"key1": {"key2": {"key3": True}}}
1401
self.assertEqual(expected_method_return, ret)
1402
self.assertIsInstance(ret, dict)
1403
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1404
self.assertIsInstance(ret["key1"], dict)
1405
self.assertNotIsInstance(ret["key1"],
1406
mock_dbus_python.Dictionary)
1407
self.assertIsInstance(ret["key1"]["key2"], dict)
1408
self.assertNotIsInstance(ret["key1"]["key2"],
1409
mock_dbus_python.Dictionary)
1410
self.assertTrue(ret["key1"]["key2"]["key3"])
1411
self.assertNotIsInstance(ret["key1"]["key2"]["key3"],
1412
mock_dbus_python.Boolean)
1413
1414
def test_call_method_handles_exception(self):
1077
class Test_get_mandos_dbus_object(TestCaseWithAssertLogs):
1078
def test_calls_and_returns_get_object_on_bus(self):
1079
class MockBus(object):
1080
called = False
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
1087
return mockbus_self
1088
1089
mockbus = get_mandos_dbus_object(bus=MockBus())
1090
self.assertIsInstance(mockbus, MockBus)
1091
self.assertTrue(mockbus.called)
1092
1093
def test_logs_and_exits_on_dbus_error(self):
1094
class MockBusFailing(object):
1095
def get_object(self, busname, dbus_path):
1096
raise dbus.exceptions.DBusException("Test")
1097
1098
with self.assertLogs(log, logging.CRITICAL):
1099
with self.assertRaises(SystemExit) as e:
1100
bus = get_mandos_dbus_object(bus=MockBusFailing())
1101
1102
if isinstance(e.exception.code, int):
1103
self.assertNotEqual(0, e.exception.code)
1104
else:
1105
self.assertIsNotNone(e.exception.code)
1106
1107
1108
class Test_get_managed_objects(TestCaseWithAssertLogs):
1109
def test_calls_and_returns_GetManagedObjects(self):
1110
managed_objects = {"/clients/foo": { "Name": "foo"}}
1111
class MockObjectManager(object):
1112
def GetManagedObjects(self):
1113
return managed_objects
1114
retval = get_managed_objects(MockObjectManager())
1115
self.assertDictEqual(managed_objects, retval)
1116
1117
def test_logs_and_exits_on_dbus_error(self):
1415
1118
dbus_logger = logging.getLogger("dbus.proxies")
1416
1119
1417
def func():
1418
dbus_logger.error("Test")
1419
raise mock_dbus_python.exceptions.DBusException()
1420
1421
mock_dbus_python = self.MockDBusPython_func(func)
1422
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1120
class MockObjectManagerFailing(object):
1121
def GetManagedObjects(self):
1122
dbus_logger.error("Test")
1123
raise dbus.exceptions.DBusException("Test")
1423
1124
1424
1125
class CountingHandler(logging.Handler):
1425
1126
count = 0
1431
1132
dbus_logger.addHandler(counting_handler)
1432
1133
1433
1134
try:
1434
with self.assertRaises(dbus.Error) as e:
1435
self.call_method(bus, "methodname", "busname",
1436
"objectpath", "interface")
1135
with self.assertLogs(log, logging.CRITICAL) as watcher:
1136
with self.assertRaises(SystemExit) as e:
1137
get_managed_objects(MockObjectManagerFailing())
1437
1138
finally:
1438
1139
dbus_logger.removeFilter(counting_handler)
1439
1140
1440
self.assertNotIsInstance(e, dbus.ConnectFailed)
1441
1442
1141
# Make sure the dbus logger was suppressed
1443
1142
self.assertEqual(0, counting_handler.count)
1444
1143
1445
def test_get_object_converts_to_correct_exception(self):
1446
bus = dbus_python_adapter.SystemBus(
1447
self.fake_dbus_python_raises_exception_on_connect)
1448
with self.assertRaises(dbus.ConnectFailed):
1449
self.call_method(bus, "methodname", "busname",
1450
"objectpath", "interface")
1451
1452
class fake_dbus_python_raises_exception_on_connect(object):
1453
"""fake dbus-python module"""
1454
class exceptions(object):
1455
"""Pseudo-namespace"""
1456
class DBusException(Exception):
1457
pass
1458
1459
@classmethod
1460
def SystemBus(cls):
1461
def get_object(busname, objectpath):
1462
raise cls.exceptions.DBusException()
1463
Bus = collections.namedtuple("Bus", ["get_object"])
1464
return Bus(get_object=get_object)
1465
1466
1467
class Test_dbus_python_adapter_CachingBus(unittest.TestCase):
1468
class mock_dbus_python(object):
1469
"""mock dbus-python modules"""
1470
class SystemBus(object):
1471
@staticmethod
1472
def get_object(busname, objectpath):
1473
return Unique()
1474
1475
def setUp(self):
1476
self.bus = dbus_python_adapter.CachingBus(
1477
self.mock_dbus_python)
1478
1479
def test_returns_distinct_objectpaths(self):
1480
obj1 = self.bus.get_object("busname", "objectpath1")
1481
self.assertIsInstance(obj1, Unique)
1482
obj2 = self.bus.get_object("busname", "objectpath2")
1483
self.assertIsInstance(obj2, Unique)
1484
self.assertIsNot(obj1, obj2)
1485
1486
def test_returns_distinct_busnames(self):
1487
obj1 = self.bus.get_object("busname1", "objectpath")
1488
self.assertIsInstance(obj1, Unique)
1489
obj2 = self.bus.get_object("busname2", "objectpath")
1490
self.assertIsInstance(obj2, Unique)
1491
self.assertIsNot(obj1, obj2)
1492
1493
def test_returns_distinct_both(self):
1494
obj1 = self.bus.get_object("busname1", "objectpath")
1495
self.assertIsInstance(obj1, Unique)
1496
obj2 = self.bus.get_object("busname2", "objectpath")
1497
self.assertIsInstance(obj2, Unique)
1498
self.assertIsNot(obj1, obj2)
1499
1500
def test_returns_same(self):
1501
obj1 = self.bus.get_object("busname", "objectpath")
1502
self.assertIsInstance(obj1, Unique)
1503
obj2 = self.bus.get_object("busname", "objectpath")
1504
self.assertIsInstance(obj2, Unique)
1505
self.assertIs(obj1, obj2)
1506
1507
def test_returns_same_old(self):
1508
obj1 = self.bus.get_object("busname1", "objectpath1")
1509
self.assertIsInstance(obj1, Unique)
1510
obj2 = self.bus.get_object("busname2", "objectpath2")
1511
self.assertIsInstance(obj2, Unique)
1512
obj1b = self.bus.get_object("busname1", "objectpath1")
1513
self.assertIsInstance(obj1b, Unique)
1514
self.assertIsNot(obj1, obj2)
1515
self.assertIsNot(obj2, obj1b)
1516
self.assertIs(obj1, obj1b)
1144
# Test that the dbus_logger still works
1145
with self.assertLogs(dbus_logger, logging.ERROR):
1146
dbus_logger.error("Test")
1147
1148
if isinstance(e.exception.code, int):
1149
self.assertNotEqual(0, e.exception.code)
1150
else:
1151
self.assertIsNotNone(e.exception.code)
1517
1152
1518
1153
1519
1154
class Test_commands_from_options(unittest.TestCase):
1520
1521
1155
def setUp(self):
1522
1156
self.parser = argparse.ArgumentParser()
1523
1157
add_command_line_options(self.parser)
1524
1158
1525
1159
def test_is_enabled(self):
1526
self.assert_command_from_args(["--is-enabled", "client"],
1160
self.assert_command_from_args(["--is-enabled", "foo"],
1527
1161
command.IsEnabled)
1528
1162
1529
1163
def assert_command_from_args(self, args, command_cls,
1540
1174
self.assertEqual(value, getattr(command, key))
1541
1175
1542
1176
def test_is_enabled_short(self):
1543
self.assert_command_from_args(["-V", "client"],
1177
self.assert_command_from_args(["-V", "foo"],
1544
1178
command.IsEnabled)
1545
1179
1546
1180
def test_approve(self):
1547
self.assert_command_from_args(["--approve", "client"],
1181
self.assert_command_from_args(["--approve", "foo"],
1548
1182
command.Approve)
1549
1183
1550
1184
def test_approve_short(self):
1551
self.assert_command_from_args(["-A", "client"],
1552
command.Approve)
1185
self.assert_command_from_args(["-A", "foo"], command.Approve)
1553
1186
1554
1187
def test_deny(self):
1555
self.assert_command_from_args(["--deny", "client"],
1556
command.Deny)
1188
self.assert_command_from_args(["--deny", "foo"], command.Deny)
1557
1189
1558
1190
def test_deny_short(self):
1559
self.assert_command_from_args(["-D", "client"], command.Deny)
1191
self.assert_command_from_args(["-D", "foo"], command.Deny)
1560
1192
1561
1193
def test_remove(self):
1562
self.assert_command_from_args(["--remove", "client"],
1194
self.assert_command_from_args(["--remove", "foo"],
1563
1195
command.Remove)
1564
1196
1565
1197
def test_deny_before_remove(self):
1566
1198
options = self.parser.parse_args(["--deny", "--remove",
1567
"client"])
1199
"foo"])
1568
1200
check_option_syntax(self.parser, options)
1569
1201
commands = commands_from_options(options)
1570
1202
self.assertEqual(2, len(commands))
1581
1213
self.assertIsInstance(commands[1], command.Remove)
1582
1214
1583
1215
def test_remove_short(self):
1584
self.assert_command_from_args(["-r", "client"],
1585
command.Remove)
1216
self.assert_command_from_args(["-r", "foo"], command.Remove)
1586
1217
1587
1218
def test_dump_json(self):
1588
1219
self.assert_command_from_args(["--dump-json"],
1589
1220
command.DumpJSON)
1590
1221
1591
1222
def test_enable(self):
1592
self.assert_command_from_args(["--enable", "client"],
1223
self.assert_command_from_args(["--enable", "foo"],
1593
1224
command.Enable)
1594
1225
1595
1226
def test_enable_short(self):
1596
self.assert_command_from_args(["-e", "client"],
1597
command.Enable)
1227
self.assert_command_from_args(["-e", "foo"], command.Enable)
1598
1228
1599
1229
def test_disable(self):
1600
self.assert_command_from_args(["--disable", "client"],
1230
self.assert_command_from_args(["--disable", "foo"],
1601
1231
command.Disable)
1602
1232
1603
1233
def test_disable_short(self):
1604
self.assert_command_from_args(["-d", "client"],
1605
command.Disable)
1234
self.assert_command_from_args(["-d", "foo"], command.Disable)
1606
1235
1607
1236
def test_bump_timeout(self):
1608
self.assert_command_from_args(["--bump-timeout", "client"],
1237
self.assert_command_from_args(["--bump-timeout", "foo"],
1609
1238
command.BumpTimeout)
1610
1239
1611
1240
def test_bump_timeout_short(self):
1612
self.assert_command_from_args(["-b", "client"],
1241
self.assert_command_from_args(["-b", "foo"],
1613
1242
command.BumpTimeout)
1614
1243
1615
1244
def test_start_checker(self):
1616
self.assert_command_from_args(["--start-checker", "client"],
1245
self.assert_command_from_args(["--start-checker", "foo"],
1617
1246
command.StartChecker)
1618
1247
1619
1248
def test_stop_checker(self):
1620
self.assert_command_from_args(["--stop-checker", "client"],
1249
self.assert_command_from_args(["--stop-checker", "foo"],
1621
1250
command.StopChecker)
1622
1251
1623
1252
def test_approve_by_default(self):
1624
self.assert_command_from_args(["--approve-by-default",
1625
"client"],
1253
self.assert_command_from_args(["--approve-by-default", "foo"],
1626
1254
command.ApproveByDefault)
1627
1255
1628
1256
def test_deny_by_default(self):
1629
self.assert_command_from_args(["--deny-by-default", "client"],
1257
self.assert_command_from_args(["--deny-by-default", "foo"],
1630
1258
command.DenyByDefault)
1631
1259
1632
1260
def test_checker(self):
1633
self.assert_command_from_args(["--checker", ":", "client"],
1261
self.assert_command_from_args(["--checker", ":", "foo"],
1634
1262
command.SetChecker,
1635
1263
value_to_set=":")
1636
1264
1637
1265
def test_checker_empty(self):
1638
self.assert_command_from_args(["--checker", "", "client"],
1266
self.assert_command_from_args(["--checker", "", "foo"],
1639
1267
command.SetChecker,
1640
1268
value_to_set="")
1641
1269
1642
1270
def test_checker_short(self):
1643
self.assert_command_from_args(["-c", ":", "client"],
1271
self.assert_command_from_args(["-c", ":", "foo"],
1644
1272
command.SetChecker,
1645
1273
value_to_set=":")
1646
1274
1647
1275
def test_host(self):
1648
self.assert_command_from_args(
1649
["--host", "client.example.org", "client"],
1650
command.SetHost, value_to_set="client.example.org")
1276
self.assert_command_from_args(["--host", "foo.example.org",
1277
"foo"], command.SetHost,
1278
value_to_set="foo.example.org")
1651
1279
1652
1280
def test_host_short(self):
1653
self.assert_command_from_args(
1654
["-H", "client.example.org", "client"], command.SetHost,
1655
value_to_set="client.example.org")
1281
self.assert_command_from_args(["-H", "foo.example.org",
1282
"foo"], command.SetHost,
1283
value_to_set="foo.example.org")
1656
1284
1657
1285
def test_secret_devnull(self):
1658
1286
self.assert_command_from_args(["--secret", os.path.devnull,
1659
"client"], command.SetSecret,
1287
"foo"], command.SetSecret,
1660
1288
value_to_set=b"")
1661
1289
1662
1290
def test_secret_tempfile(self):
1665
1293
f.write(value)
1666
1294
f.seek(0)
1667
1295
self.assert_command_from_args(["--secret", f.name,
1668
"client"],
1669
command.SetSecret,
1296
"foo"], command.SetSecret,
1670
1297
value_to_set=value)
1671
1298
1672
1299
def test_secret_devnull_short(self):
1673
self.assert_command_from_args(["-s", os.path.devnull,
1674
"client"], command.SetSecret,
1300
self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1301
command.SetSecret,
1675
1302
value_to_set=b"")
1676
1303
1677
1304
def test_secret_tempfile_short(self):
1679
1306
value = b"secret\0xyzzy\nbar"
1680
1307
f.write(value)
1681
1308
f.seek(0)
1682
self.assert_command_from_args(["-s", f.name, "client"],
1309
self.assert_command_from_args(["-s", f.name, "foo"],
1683
1310
command.SetSecret,
1684
1311
value_to_set=value)
1685
1312
1686
1313
def test_timeout(self):
1687
self.assert_command_from_args(["--timeout", "PT5M", "client"],
1314
self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1688
1315
command.SetTimeout,
1689
1316
value_to_set=300000)
1690
1317
1691
1318
def test_timeout_short(self):
1692
self.assert_command_from_args(["-t", "PT5M", "client"],
1319
self.assert_command_from_args(["-t", "PT5M", "foo"],
1693
1320
command.SetTimeout,
1694
1321
value_to_set=300000)
1695
1322
1696
1323
def test_extended_timeout(self):
1697
1324
self.assert_command_from_args(["--extended-timeout", "PT15M",
1698
"client"],
1325
"foo"],
1699
1326
command.SetExtendedTimeout,
1700
1327
value_to_set=900000)
1701
1328
1702
1329
def test_interval(self):
1703
self.assert_command_from_args(["--interval", "PT2M",
1704
"client"], command.SetInterval,
1330
self.assert_command_from_args(["--interval", "PT2M", "foo"],
1331
command.SetInterval,
1705
1332
value_to_set=120000)
1706
1333
1707
1334
def test_interval_short(self):
1708
self.assert_command_from_args(["-i", "PT2M", "client"],
1335
self.assert_command_from_args(["-i", "PT2M", "foo"],
1709
1336
command.SetInterval,
1710
1337
value_to_set=120000)
1711
1338
1712
1339
def test_approval_delay(self):
1713
1340
self.assert_command_from_args(["--approval-delay", "PT30S",
1714
"client"],
1341
"foo"],
1715
1342
command.SetApprovalDelay,
1716
1343
value_to_set=30000)
1717
1344
1718
1345
def test_approval_duration(self):
1719
1346
self.assert_command_from_args(["--approval-duration", "PT1S",
1720
"client"],
1347
"foo"],
1721
1348
command.SetApprovalDuration,
1722
1349
value_to_set=1000)
1723
1350
1738
1365
class TestCommand(unittest.TestCase):
1739
1366
"""Abstract class for tests of command classes"""
1740
1367
1741
class FakeMandosBus(dbus.MandosBus):
1742
def __init__(self, testcase):
1743
self.client_properties = {
1744
"Name": "foo",
1745
"KeyID": ("92ed150794387c03ce684574b1139a65"
1746
"94a34f895daaaf09fd8ea90a27cddb12"),
1747
"Secret": b"secret",
1748
"Host": "foo.example.org",
1749
"Enabled": True,
1750
"Timeout": 300000,
1751
"LastCheckedOK": "2019-02-03T00:00:00",
1752
"Created": "2019-01-02T00:00:00",
1753
"Interval": 120000,
1754
"Fingerprint": ("778827225BA7DE539C5A"
1755
"7CFA59CFF7CDBD9A5920"),
1756
"CheckerRunning": False,
1757
"LastEnabled": "2019-01-03T00:00:00",
1758
"ApprovalPending": False,
1759
"ApprovedByDefault": True,
1760
"LastApprovalRequest": "",
1761
"ApprovalDelay": 0,
1762
"ApprovalDuration": 1000,
1763
"Checker": "fping -q -- %(host)s",
1764
"ExtendedTimeout": 900000,
1765
"Expires": "2019-02-04T00:00:00",
1766
"LastCheckerStatus": 0,
1767
}
1768
self.other_client_properties = {
1769
"Name": "barbar",
1770
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
1771
"6ab612cff5ad227247e46c2b020f441c"),
1772
"Secret": b"secretbar",
1773
"Host": "192.0.2.3",
1774
"Enabled": True,
1775
"Timeout": 300000,
1776
"LastCheckedOK": "2019-02-04T00:00:00",
1777
"Created": "2019-01-03T00:00:00",
1778
"Interval": 120000,
1779
"Fingerprint": ("3E393AEAEFB84C7E89E2"
1780
"F547B3A107558FCA3A27"),
1781
"CheckerRunning": True,
1782
"LastEnabled": "2019-01-04T00:00:00",
1783
"ApprovalPending": False,
1784
"ApprovedByDefault": False,
1785
"LastApprovalRequest": "2019-01-03T00:00:00",
1786
"ApprovalDelay": 30000,
1787
"ApprovalDuration": 93785000,
1788
"Checker": ":",
1789
"ExtendedTimeout": 900000,
1790
"Expires": "2019-02-05T00:00:00",
1791
"LastCheckerStatus": -2,
1792
}
1793
self.clients = collections.OrderedDict(
1794
[
1795
("client_objectpath", self.client_properties),
1796
("other_client_objectpath",
1797
self.other_client_properties),
1798
])
1799
self.one_client = {"client_objectpath":
1800
self.client_properties}
1801
self.testcase = testcase
1802
self.calls = []
1803
1804
def call_method(self, methodname, busname, objectpath,
1805
interface, *args):
1806
self.testcase.assertEqual("se.recompile.Mandos", busname)
1807
self.calls.append((methodname, busname, objectpath,
1808
interface, args))
1809
if interface == "org.freedesktop.DBus.Properties":
1810
if methodname == "Set":
1811
self.testcase.assertEqual(3, len(args))
1812
interface, key, value = args
1813
self.testcase.assertEqual(
1814
"se.recompile.Mandos.Client", interface)
1815
self.clients[objectpath][key] = value
1816
return
1817
elif interface == "se.recompile.Mandos":
1818
self.testcase.assertEqual("RemoveClient", methodname)
1819
self.testcase.assertEqual(1, len(args))
1820
clientpath = args[0]
1821
del self.clients[clientpath]
1822
return
1823
elif interface == "se.recompile.Mandos.Client":
1824
if methodname == "Approve":
1825
self.testcase.assertEqual(1, len(args))
1826
return
1827
raise ValueError()
1828
1829
1368
def setUp(self):
1830
self.bus = self.FakeMandosBus(self)
1369
testcase = self
1370
class MockClient(object):
1371
def __init__(self, name, **attributes):
1372
self.__dbus_object_path__ = "/clients/{}".format(name)
1373
self.attributes = attributes
1374
self.attributes["Name"] = name
1375
self.calls = []
1376
def Set(self, interface, propname, value, dbus_interface):
1377
testcase.assertEqual(client_dbus_interface, interface)
1378
testcase.assertEqual(dbus.PROPERTIES_IFACE,
1379
dbus_interface)
1380
self.attributes[propname] = value
1381
def Approve(self, approve, dbus_interface):
1382
testcase.assertEqual(client_dbus_interface,
1383
dbus_interface)
1384
self.calls.append(("Approve", (approve,
1385
dbus_interface)))
1386
self.client = MockClient(
1387
"foo",
1388
KeyID=("92ed150794387c03ce684574b1139a65"
1389
"94a34f895daaaf09fd8ea90a27cddb12"),
1390
Secret=b"secret",
1391
Host="foo.example.org",
1392
Enabled=dbus.Boolean(True),
1393
Timeout=300000,
1394
LastCheckedOK="2019-02-03T00:00:00",
1395
Created="2019-01-02T00:00:00",
1396
Interval=120000,
1397
Fingerprint=("778827225BA7DE539C5A"
1398
"7CFA59CFF7CDBD9A5920"),
1399
CheckerRunning=dbus.Boolean(False),
1400
LastEnabled="2019-01-03T00:00:00",
1401
ApprovalPending=dbus.Boolean(False),
1402
ApprovedByDefault=dbus.Boolean(True),
1403
LastApprovalRequest="",
1404
ApprovalDelay=0,
1405
ApprovalDuration=1000,
1406
Checker="fping -q -- %(host)s",
1407
ExtendedTimeout=900000,
1408
Expires="2019-02-04T00:00:00",
1409
LastCheckerStatus=0)
1410
self.other_client = MockClient(
1411
"barbar",
1412
KeyID=("0558568eedd67d622f5c83b35a115f79"
1413
"6ab612cff5ad227247e46c2b020f441c"),
1414
Secret=b"secretbar",
1415
Host="192.0.2.3",
1416
Enabled=dbus.Boolean(True),
1417
Timeout=300000,
1418
LastCheckedOK="2019-02-04T00:00:00",
1419
Created="2019-01-03T00:00:00",
1420
Interval=120000,
1421
Fingerprint=("3E393AEAEFB84C7E89E2"
1422
"F547B3A107558FCA3A27"),
1423
CheckerRunning=dbus.Boolean(True),
1424
LastEnabled="2019-01-04T00:00:00",
1425
ApprovalPending=dbus.Boolean(False),
1426
ApprovedByDefault=dbus.Boolean(False),
1427
LastApprovalRequest="2019-01-03T00:00:00",
1428
ApprovalDelay=30000,
1429
ApprovalDuration=93785000,
1430
Checker=":",
1431
ExtendedTimeout=900000,
1432
Expires="2019-02-05T00:00:00",
1433
LastCheckerStatus=-2)
1434
self.clients = collections.OrderedDict(
1435
[
1436
("/clients/foo", self.client.attributes),
1437
("/clients/barbar", self.other_client.attributes),
1438
])
1439
self.one_client = {"/clients/foo": self.client.attributes}
1440
1441
@property
1442
def bus(self):
1443
class Bus(object):
1444
@staticmethod
1445
def get_object(client_bus_name, path):
1446
self.assertEqual(dbus_busname, client_bus_name)
1447
return {
1448
# Note: "self" here is the TestCmd instance, not
1449
# the Bus instance, since this is a static method!
1450
"/clients/foo": self.client,
1451
"/clients/barbar": self.other_client,
1452
}[path]
1453
return Bus()
1831
1454
1832
1455
1833
1456
class TestBaseCommands(TestCommand):
1834
1457
1835
1458
def test_IsEnabled_exits_successfully(self):
1836
1459
with self.assertRaises(SystemExit) as e:
1837
command.IsEnabled().run(self.bus.one_client)
1460
command.IsEnabled().run(self.one_client)
1838
1461
if e.exception.code is not None:
1839
1462
self.assertEqual(0, e.exception.code)
1840
1463
else:
1841
1464
self.assertIsNone(e.exception.code)
1842
1465
1843
1466
def test_IsEnabled_exits_with_failure(self):
1844
self.bus.client_properties["Enabled"] = False
1467
self.client.attributes["Enabled"] = dbus.Boolean(False)
1845
1468
with self.assertRaises(SystemExit) as e:
1846
command.IsEnabled().run(self.bus.one_client)
1469
command.IsEnabled().run(self.one_client)
1847
1470
if isinstance(e.exception.code, int):
1848
1471
self.assertNotEqual(0, e.exception.code)
1849
1472
else:
1850
1473
self.assertIsNotNone(e.exception.code)
1851
1474
1852
1475
def test_Approve(self):
1853
busname = "se.recompile.Mandos"
1854
client_interface = "se.recompile.Mandos.Client"
1855
command.Approve().run(self.bus.clients, self.bus)
1856
for clientpath in self.bus.clients:
1857
self.assertIn(("Approve", busname, clientpath,
1858
client_interface, (True,)), self.bus.calls)
1476
command.Approve().run(self.clients, self.bus)
1477
for clientpath in self.clients:
1478
client = self.bus.get_object(dbus_busname, clientpath)
1479
self.assertIn(("Approve", (True, client_dbus_interface)),
1480
client.calls)
1859
1481
1860
1482
def test_Deny(self):
1861
busname = "se.recompile.Mandos"
1862
client_interface = "se.recompile.Mandos.Client"
1863
command.Deny().run(self.bus.clients, self.bus)
1864
for clientpath in self.bus.clients:
1865
self.assertIn(("Approve", busname, clientpath,
1866
client_interface, (False,)),
1867
self.bus.calls)
1483
command.Deny().run(self.clients, self.bus)
1484
for clientpath in self.clients:
1485
client = self.bus.get_object(dbus_busname, clientpath)
1486
self.assertIn(("Approve", (False, client_dbus_interface)),
1487
client.calls)
1868
1488
1869
1489
def test_Remove(self):
1870
command.Remove().run(self.bus.clients, self.bus)
1871
for clientpath in self.bus.clients:
1872
self.assertIn(("RemoveClient", dbus_busname,
1873
dbus_server_path, dbus_server_interface,
1874
(clientpath,)), self.bus.calls)
1490
class MockMandos(object):
1491
def __init__(self):
1492
self.calls = []
1493
def RemoveClient(self, dbus_path):
1494
self.calls.append(("RemoveClient", (dbus_path,)))
1495
mandos = MockMandos()
1496
command.Remove().run(self.clients, self.bus, mandos)
1497
for clientpath in self.clients:
1498
self.assertIn(("RemoveClient", (clientpath,)),
1499
mandos.calls)
1875
1500
1876
1501
expected_json = {
1877
1502
"foo": {
1926
1551
1927
1552
def test_DumpJSON_normal(self):
1928
1553
with self.capture_stdout_to_buffer() as buffer:
1929
command.DumpJSON().run(self.bus.clients)
1554
command.DumpJSON().run(self.clients)
1930
1555
json_data = json.loads(buffer.getvalue())
1931
1556
self.assertDictEqual(self.expected_json, json_data)
1932
1557
1943
1568
1944
1569
def test_DumpJSON_one_client(self):
1945
1570
with self.capture_stdout_to_buffer() as buffer:
1946
command.DumpJSON().run(self.bus.one_client)
1571
command.DumpJSON().run(self.one_client)
1947
1572
json_data = json.loads(buffer.getvalue())
1948
1573
expected_json = {"foo": self.expected_json["foo"]}
1949
1574
self.assertDictEqual(expected_json, json_data)
1950
1575
1951
1576
def test_PrintTable_normal(self):
1952
1577
with self.capture_stdout_to_buffer() as buffer:
1953
command.PrintTable().run(self.bus.clients)
1578
command.PrintTable().run(self.clients)
1954
1579
expected_output = "\n".join((
1955
1580
"Name Enabled Timeout Last Successful Check",
1956
1581
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1960
1585
1961
1586
def test_PrintTable_verbose(self):
1962
1587
with self.capture_stdout_to_buffer() as buffer:
1963
command.PrintTable(verbose=True).run(self.bus.clients)
1588
command.PrintTable(verbose=True).run(self.clients)
1964
1589
columns = (
1965
1590
(
1966
1591
"Name ",
2056
1681
2057
1682
def test_PrintTable_one_client(self):
2058
1683
with self.capture_stdout_to_buffer() as buffer:
2059
command.PrintTable().run(self.bus.one_client)
1684
command.PrintTable().run(self.one_client)
2060
1685
expected_output = "\n".join((
2061
1686
"Name Enabled Timeout Last Successful Check",
2062
1687
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
2064
1689
self.assertEqual(expected_output, buffer.getvalue())
2065
1690
2066
1691
2067
class TestPropertySetterCmd(TestCommand):
2068
"""Abstract class for tests of command.PropertySetter classes"""
2069
1692
class TestPropertyCmd(TestCommand):
1693
"""Abstract class for tests of command.Property classes"""
2070
1694
def runTest(self):
2071
1695
if not hasattr(self, "command"):
2072
return # Abstract TestCase class
1696
return
2073
1697
values_to_get = getattr(self, "values_to_get",
2074
1698
self.values_to_set)
2075
1699
for value_to_set, value_to_get in zip(self.values_to_set,
2076
1700
values_to_get):
2077
for clientpath in self.bus.clients:
2078
self.bus.clients[clientpath][self.propname] = Unique()
2079
self.run_command(value_to_set, self.bus.clients)
2080
for clientpath in self.bus.clients:
2081
value = self.bus.clients[clientpath][self.propname]
2082
self.assertNotIsInstance(value, Unique)
1701
for clientpath in self.clients:
1702
client = self.bus.get_object(dbus_busname, clientpath)
1703
old_value = client.attributes[self.propname]
1704
client.attributes[self.propname] = self.Unique()
1705
self.run_command(value_to_set, self.clients)
1706
for clientpath in self.clients:
1707
client = self.bus.get_object(dbus_busname, clientpath)
1708
value = client.attributes[self.propname]
1709
self.assertNotIsInstance(value, self.Unique)
2083
1710
self.assertEqual(value_to_get, value)
2084
1711
1712
class Unique(object):
1713
"""Class for objects which exist only to be unique objects,
1714
since unittest.mock.sentinel only exists in Python 3.3"""
1715
2085
1716
def run_command(self, value, clients):
2086
1717
self.command().run(clients, self.bus)
2087
1718
2088
1719
2089
class TestEnableCmd(TestPropertySetterCmd):
1720
class TestEnableCmd(TestPropertyCmd):
2090
1721
command = command.Enable
2091
1722
propname = "Enabled"
2092
values_to_set = [True]
2093
2094
2095
class TestDisableCmd(TestPropertySetterCmd):
1723
values_to_set = [dbus.Boolean(True)]
1724
1725
1726
class TestDisableCmd(TestPropertyCmd):
2096
1727
command = command.Disable
2097
1728
propname = "Enabled"
2098
values_to_set = [False]
2099
2100
2101
class TestBumpTimeoutCmd(TestPropertySetterCmd):
1729
values_to_set = [dbus.Boolean(False)]
1730
1731
1732
class TestBumpTimeoutCmd(TestPropertyCmd):
2102
1733
command = command.BumpTimeout
2103
1734
propname = "LastCheckedOK"
2104
1735
values_to_set = [""]
2105
1736
2106
1737
2107
class TestStartCheckerCmd(TestPropertySetterCmd):
1738
class TestStartCheckerCmd(TestPropertyCmd):
2108
1739
command = command.StartChecker
2109
1740
propname = "CheckerRunning"
2110
values_to_set = [True]
2111
2112
2113
class TestStopCheckerCmd(TestPropertySetterCmd):
1741
values_to_set = [dbus.Boolean(True)]
1742
1743
1744
class TestStopCheckerCmd(TestPropertyCmd):
2114
1745
command = command.StopChecker
2115
1746
propname = "CheckerRunning"
2116
values_to_set = [False]
2117
2118
2119
class TestApproveByDefaultCmd(TestPropertySetterCmd):
1747
values_to_set = [dbus.Boolean(False)]
1748
1749
1750
class TestApproveByDefaultCmd(TestPropertyCmd):
2120
1751
command = command.ApproveByDefault
2121
1752
propname = "ApprovedByDefault"
2122
values_to_set = [True]
2123
2124
2125
class TestDenyByDefaultCmd(TestPropertySetterCmd):
1753
values_to_set = [dbus.Boolean(True)]
1754
1755
1756
class TestDenyByDefaultCmd(TestPropertyCmd):
2126
1757
command = command.DenyByDefault
2127
1758
propname = "ApprovedByDefault"
2128
values_to_set = [False]
2129
2130
2131
class TestPropertySetterValueCmd(TestPropertySetterCmd):
2132
"""Abstract class for tests of PropertySetterValueCmd classes"""
1759
values_to_set = [dbus.Boolean(False)]
1760
1761
1762
class TestPropertyValueCmd(TestPropertyCmd):
1763
"""Abstract class for tests of PropertyValueCmd classes"""
1764
1765
def runTest(self):
1766
if type(self) is TestPropertyValueCmd:
1767
return
1768
return super(TestPropertyValueCmd, self).runTest()
2133
1769
2134
1770
def run_command(self, value, clients):
2135
1771
self.command(value).run(clients, self.bus)
2136
1772
2137
1773
2138
class TestSetCheckerCmd(TestPropertySetterValueCmd):
1774
class TestSetCheckerCmd(TestPropertyValueCmd):
2139
1775
command = command.SetChecker
2140
1776
propname = "Checker"
2141
1777
values_to_set = ["", ":", "fping -q -- %s"]
2142
1778
2143
1779
2144
class TestSetHostCmd(TestPropertySetterValueCmd):
1780
class TestSetHostCmd(TestPropertyValueCmd):
2145
1781
command = command.SetHost
2146
1782
propname = "Host"
2147
values_to_set = ["192.0.2.3", "client.example.org"]
2148
2149
2150
class TestSetSecretCmd(TestPropertySetterValueCmd):
1783
values_to_set = ["192.0.2.3", "foo.example.org"]
1784
1785
1786
class TestSetSecretCmd(TestPropertyValueCmd):
2151
1787
command = command.SetSecret
2152
1788
propname = "Secret"
2153
1789
values_to_set = [io.BytesIO(b""),
2154
1790
io.BytesIO(b"secret\0xyzzy\nbar")]
2155
values_to_get = [f.getvalue() for f in values_to_set]
2156
2157
2158
class TestSetTimeoutCmd(TestPropertySetterValueCmd):
1791
values_to_get = [b"", b"secret\0xyzzy\nbar"]
1792
1793
1794
class TestSetTimeoutCmd(TestPropertyValueCmd):
2159
1795
command = command.SetTimeout
2160
1796
propname = "Timeout"
2161
1797
values_to_set = [datetime.timedelta(),
2163
1799
datetime.timedelta(seconds=1),
2164
1800
datetime.timedelta(weeks=1),
2165
1801
datetime.timedelta(weeks=52)]
2166
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2167
2168
2169
class TestSetExtendedTimeoutCmd(TestPropertySetterValueCmd):
1802
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1803
1804
1805
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
2170
1806
command = command.SetExtendedTimeout
2171
1807
propname = "ExtendedTimeout"
2172
1808
values_to_set = [datetime.timedelta(),
2174
1810
datetime.timedelta(seconds=1),
2175
1811
datetime.timedelta(weeks=1),
2176
1812
datetime.timedelta(weeks=52)]
2177
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2178
2179
2180
class TestSetIntervalCmd(TestPropertySetterValueCmd):
1813
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1814
1815
1816
class TestSetIntervalCmd(TestPropertyValueCmd):
2181
1817
command = command.SetInterval
2182
1818
propname = "Interval"
2183
1819
values_to_set = [datetime.timedelta(),
2185
1821
datetime.timedelta(seconds=1),
2186
1822
datetime.timedelta(weeks=1),
2187
1823
datetime.timedelta(weeks=52)]
2188
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2189
2190
2191
class TestSetApprovalDelayCmd(TestPropertySetterValueCmd):
1824
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1825
1826
1827
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
2192
1828
command = command.SetApprovalDelay
2193
1829
propname = "ApprovalDelay"
2194
1830
values_to_set = [datetime.timedelta(),
2196
1832
datetime.timedelta(seconds=1),
2197
1833
datetime.timedelta(weeks=1),
2198
1834
datetime.timedelta(weeks=52)]
2199
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2200
2201
2202
class TestSetApprovalDurationCmd(TestPropertySetterValueCmd):
1835
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1836
1837
1838
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
2203
1839
command = command.SetApprovalDuration
2204
1840
propname = "ApprovalDuration"
2205
1841
values_to_set = [datetime.timedelta(),
2207
1843
datetime.timedelta(seconds=1),
2208
1844
datetime.timedelta(weeks=1),
2209
1845
datetime.timedelta(weeks=52)]
2210
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1846
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
2211
1847
2212
1848
2213
1849
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0