139
136
help="Select all clients")
140
137
parser.add_argument("-v", "--verbose", action="store_true",
141
138
help="Print all fields")
142
parser.add_argument("-j", "--dump-json", action="store_true",
139
parser.add_argument("-j", "--dump-json", dest="commands",
140
action="append_const", default=[],
141
const=command.DumpJSON(),
143
142
help="Dump client data in JSON format")
144
143
enable_disable = parser.add_mutually_exclusive_group()
145
enable_disable.add_argument("-e", "--enable", action="store_true",
144
enable_disable.add_argument("-e", "--enable", dest="commands",
145
action="append_const", default=[],
146
const=command.Enable(),
146
147
help="Enable client")
147
enable_disable.add_argument("-d", "--disable",
148
enable_disable.add_argument("-d", "--disable", dest="commands",
149
action="append_const", default=[],
150
const=command.Disable(),
149
151
help="disable client")
150
parser.add_argument("-b", "--bump-timeout", action="store_true",
152
parser.add_argument("-b", "--bump-timeout", dest="commands",
153
action="append_const", default=[],
154
const=command.BumpTimeout(),
151
155
help="Bump timeout for client")
152
156
start_stop_checker = parser.add_mutually_exclusive_group()
153
157
start_stop_checker.add_argument("--start-checker",
159
action="append_const", default=[],
160
const=command.StartChecker(),
155
161
help="Start checker for client")
156
start_stop_checker.add_argument("--stop-checker",
162
start_stop_checker.add_argument("--stop-checker", dest="commands",
163
action="append_const", default=[],
164
const=command.StopChecker(),
158
165
help="Stop checker for client")
159
parser.add_argument("-V", "--is-enabled", action="store_true",
166
parser.add_argument("-V", "--is-enabled", dest="commands",
167
action="append_const", default=[],
168
const=command.IsEnabled(),
160
169
help="Check if client is enabled")
161
parser.add_argument("-r", "--remove", action="store_true",
170
parser.add_argument("-r", "--remove", dest="commands",
171
action="append_const", default=[],
172
const=command.Remove(),
162
173
help="Remove client")
163
parser.add_argument("-c", "--checker",
174
parser.add_argument("-c", "--checker", dest="commands",
175
action="append", default=[],
176
metavar="COMMAND", type=command.SetChecker,
164
177
help="Set checker command for client")
165
parser.add_argument("-t", "--timeout", type=string_to_delta,
166
help="Set timeout for client")
167
parser.add_argument("--extended-timeout", type=string_to_delta,
168
help="Set extended timeout for client")
169
parser.add_argument("-i", "--interval", type=string_to_delta,
170
help="Set checker interval for client")
179
"-t", "--timeout", dest="commands", action="append",
180
default=[], metavar="TIME",
181
type=command.SetTimeout.argparse(string_to_delta),
182
help="Set timeout for client")
184
"--extended-timeout", dest="commands", action="append",
185
default=[], metavar="TIME",
186
type=command.SetExtendedTimeout.argparse(string_to_delta),
187
help="Set extended timeout for client")
189
"-i", "--interval", dest="commands", action="append",
190
default=[], metavar="TIME",
191
type=command.SetInterval.argparse(string_to_delta),
192
help="Set checker interval for client")
171
193
approve_deny_default = parser.add_mutually_exclusive_group()
172
194
approve_deny_default.add_argument(
173
"--approve-by-default", action="store_true",
174
default=None, dest="approved_by_default",
195
"--approve-by-default", dest="commands",
196
action="append_const", default=[],
197
const=command.ApproveByDefault(),
175
198
help="Set client to be approved by default")
176
199
approve_deny_default.add_argument(
177
"--deny-by-default", action="store_false",
178
dest="approved_by_default",
200
"--deny-by-default", dest="commands",
201
action="append_const", default=[],
202
const=command.DenyByDefault(),
179
203
help="Set client to be denied by default")
180
parser.add_argument("--approval-delay", type=string_to_delta,
181
help="Set delay before client approve/deny")
182
parser.add_argument("--approval-duration", type=string_to_delta,
183
help="Set duration of one client approval")
184
parser.add_argument("-H", "--host", help="Set host for client")
185
parser.add_argument("-s", "--secret",
186
type=argparse.FileType(mode="rb"),
187
help="Set password blob (file) for client")
205
"--approval-delay", dest="commands", action="append",
206
default=[], metavar="TIME",
207
type=command.SetApprovalDelay.argparse(string_to_delta),
208
help="Set delay before client approve/deny")
210
"--approval-duration", dest="commands", action="append",
211
default=[], metavar="TIME",
212
type=command.SetApprovalDuration.argparse(string_to_delta),
213
help="Set duration of one client approval")
214
parser.add_argument("-H", "--host", dest="commands",
215
action="append", default=[], metavar="STRING",
216
type=command.SetHost,
217
help="Set host for client")
219
"-s", "--secret", dest="commands", action="append",
220
default=[], metavar="FILENAME",
221
type=command.SetSecret.argparse(argparse.FileType(mode="rb")),
222
help="Set password blob (file) for client")
188
223
approve_deny = parser.add_mutually_exclusive_group()
189
224
approve_deny.add_argument(
190
"-A", "--approve", action="store_true",
225
"-A", "--approve", dest="commands", action="append_const",
226
default=[], const=command.Approve(),
191
227
help="Approve any current client request")
192
approve_deny.add_argument("-D", "--deny", action="store_true",
228
approve_deny.add_argument("-D", "--deny", dest="commands",
229
action="append_const", default=[],
230
const=command.Deny(),
193
231
help="Deny any current client request")
194
232
parser.add_argument("--debug", action="store_true",
195
233
help="Debug mode (show D-Bus commands)")
386
424
"""Apply additional restrictions on options, not expressible in
389
def has_actions(options):
390
return any((options.enable,
392
options.bump_timeout,
393
options.start_checker,
394
options.stop_checker,
397
options.checker is not None,
398
options.timeout is not None,
399
options.extended_timeout is not None,
400
options.interval is not None,
401
options.approved_by_default is not None,
402
options.approval_delay is not None,
403
options.approval_duration is not None,
404
options.host is not None,
405
options.secret is not None,
427
def has_commands(options, commands=None):
429
commands = (command.Enable,
432
command.StartChecker,
438
command.SetExtendedTimeout,
440
command.ApproveByDefault,
441
command.DenyByDefault,
442
command.SetApprovalDelay,
443
command.SetApprovalDuration,
448
return any(isinstance(cmd, commands)
449
for cmd in options.commands)
409
if has_actions(options) and not (options.client or options.all):
451
if has_commands(options) and not (options.client or options.all):
410
452
parser.error("Options require clients names or --all.")
411
if options.verbose and has_actions(options):
453
if options.verbose and has_commands(options):
412
454
parser.error("--verbose can only be used alone.")
413
if options.dump_json and (options.verbose
414
or has_actions(options)):
455
if (has_commands(options, (command.DumpJSON,))
456
and (options.verbose or len(options.commands) > 1)):
415
457
parser.error("--dump-json can only be used alone.")
416
if options.all and not has_actions(options):
458
if options.all and not has_commands(options):
417
459
parser.error("--all requires an action.")
418
if options.is_enabled and len(options.client) > 1:
460
if (has_commands(options, (command.IsEnabled,))
461
and len(options.client) > 1):
419
462
parser.error("--is-enabled requires exactly one client")
421
options.remove = False
422
if has_actions(options) and not options.deny:
423
parser.error("--remove can only be combined with --deny")
424
options.remove = True
427
def get_mandos_dbus_object(bus):
428
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
429
dbus_busname, server_dbus_path)
430
with if_dbus_exception_log_with_exception_and_exit(
431
"Could not connect to Mandos server: %s"):
432
mandos_dbus_object = bus.get_object(dbus_busname,
434
return mandos_dbus_object
437
@contextlib.contextmanager
438
def if_dbus_exception_log_with_exception_and_exit(*args, **kwargs):
441
except dbus.exceptions.DBusException as e:
442
log.critical(*(args + (e,)), **kwargs)
446
def get_managed_objects(object_manager):
447
log.debug("D-Bus: %s:%s:%s.GetManagedObjects()", dbus_busname,
448
server_dbus_path, dbus.OBJECT_MANAGER_IFACE)
449
with if_dbus_exception_log_with_exception_and_exit(
450
"Failed to access Mandos server through D-Bus:\n%s"):
451
with SilenceLogger("dbus.proxies"):
452
managed_objects = object_manager.GetManagedObjects()
453
return managed_objects
456
class SilenceLogger(object):
457
"Simple context manager to silence a particular logger"
458
def __init__(self, loggername):
459
self.logger = logging.getLogger(loggername)
462
self.logger.addFilter(self.nullfilter)
465
class NullFilter(logging.Filter):
466
def filter(self, record):
469
nullfilter = NullFilter()
471
def __exit__(self, exc_type, exc_val, exc_tb):
472
self.logger.removeFilter(self.nullfilter)
463
if (len(options.commands) > 1
464
and has_commands(options, (command.Remove,))
465
and not has_commands(options, (command.Deny,))):
466
parser.error("--remove can only be combined with --deny")
471
class SystemBus(object):
473
object_manager_iface = "org.freedesktop.DBus.ObjectManager"
474
def get_managed_objects(self, busname, objectpath):
475
return self.call_method("GetManagedObjects", busname,
477
self.object_manager_iface)
479
properties_iface = "org.freedesktop.DBus.Properties"
480
def set_property(self, busname, objectpath, interface, key,
482
self.call_method("Set", busname, objectpath,
483
self.properties_iface, interface, key,
487
class MandosBus(SystemBus):
488
busname_domain = "se.recompile"
489
busname = busname_domain + ".Mandos"
491
server_interface = busname_domain + ".Mandos"
492
client_interface = busname_domain + ".Mandos.Client"
495
def get_clients_and_properties(self):
496
managed_objects = self.get_managed_objects(
497
self.busname, self.server_path)
498
return {objpath: properties[self.client_interface]
499
for objpath, properties in managed_objects.items()
500
if self.client_interface in properties}
502
def set_client_property(self, objectpath, key, value):
503
return self.set_property(self.busname, objectpath,
504
self.client_interface, key,
507
def call_client_method(self, objectpath, method, *args):
508
return self.call_method(method, self.busname, objectpath,
509
self.client_interface, *args)
511
def call_server_method(self, method, *args):
512
return self.call_method(method, self.busname,
514
self.server_interface, *args)
516
class Error(Exception):
519
class ConnectFailed(Error):
523
class dbus_python_adapter(object):
525
class SystemBus(dbus.MandosBus):
526
"""Use dbus-python"""
528
def __init__(self, module=dbus_python):
529
self.dbus_python = module
530
self.bus = self.dbus_python.SystemBus()
532
@contextlib.contextmanager
533
def convert_exception(self, exception_class=dbus.Error):
536
except self.dbus_python.exceptions.DBusException as e:
537
# This does what "raise from" would do
538
exc = exception_class(*e.args)
542
def call_method(self, methodname, busname, objectpath,
544
proxy_object = self.get_object(busname, objectpath)
545
log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
546
interface, methodname,
547
", ".join(repr(a) for a in args))
548
method = getattr(proxy_object, methodname)
549
with self.convert_exception():
550
with dbus_python_adapter.SilenceLogger(
552
value = method(*args, dbus_interface=interface)
553
return self.type_filter(value)
555
def get_object(self, busname, objectpath):
556
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
558
with self.convert_exception(dbus.ConnectFailed):
559
return self.bus.get_object(busname, objectpath)
561
def type_filter(self, value):
562
"""Convert the most bothersome types to Python types"""
563
if isinstance(value, self.dbus_python.Boolean):
565
if isinstance(value, self.dbus_python.ObjectPath):
567
# Also recurse into dictionaries
568
if isinstance(value, self.dbus_python.Dictionary):
569
return {self.type_filter(key):
570
self.type_filter(subval)
571
for key, subval in value.items()}
574
def set_client_property(self, objectpath, key, value):
576
if not isinstance(value, bytes):
577
value = value.encode("utf-8")
578
value = self.dbus_python.ByteArray(value)
579
return self.set_property(self.busname, objectpath,
580
self.client_interface, key,
583
class SilenceLogger(object):
584
"Simple context manager to silence a particular logger"
585
def __init__(self, loggername):
586
self.logger = logging.getLogger(loggername)
589
self.logger.addFilter(self.nullfilter)
591
class NullFilter(logging.Filter):
592
def filter(self, record):
595
nullfilter = NullFilter()
597
def __exit__(self, exc_type, exc_val, exc_tb):
598
self.logger.removeFilter(self.nullfilter)
601
class CachingBus(SystemBus):
602
"""A caching layer for dbus_python_adapter.SystemBus"""
603
def __init__(self, *args, **kwargs):
604
self.object_cache = {}
605
super(dbus_python_adapter.CachingBus,
606
self).__init__(*args, **kwargs)
607
def get_object(self, busname, objectpath):
609
return self.object_cache[(busname, objectpath)]
612
dbus_python_adapter.CachingBus,
613
self).get_object(busname, objectpath)
614
self.object_cache[(busname, objectpath)] = new_object
618
class pydbus_adapter(object):
619
class SystemBus(dbus.MandosBus):
620
def __init__(self, module=pydbus):
622
self.bus = self.pydbus.SystemBus()
624
@contextlib.contextmanager
625
def convert_exception(self, exception_class=dbus.Error):
628
except gi.repository.GLib.Error as e:
629
# This does what "raise from" would do
630
exc = exception_class(*e.args)
634
def call_method(self, methodname, busname, objectpath,
636
proxy_object = self.get(busname, objectpath)
637
log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
638
interface, methodname,
639
", ".join(repr(a) for a in args))
640
method = getattr(proxy_object[interface], methodname)
641
with self.convert_exception():
644
def get(self, busname, objectpath):
645
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
647
with self.convert_exception(dbus.ConnectFailed):
648
if sys.version_info.major <= 2:
649
with warnings.catch_warnings():
650
warnings.filterwarnings(
651
"ignore", "", DeprecationWarning,
652
r"^xml\.etree\.ElementTree$")
653
return self.bus.get(busname, objectpath)
655
return self.bus.get(busname, objectpath)
657
def set_property(self, busname, objectpath, interface, key,
659
proxy_object = self.get(busname, objectpath)
660
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", busname,
661
objectpath, self.properties_iface, interface,
663
setattr(proxy_object[interface], key, value)
665
class CachingBus(SystemBus):
666
"""A caching layer for pydbus_adapter.SystemBus"""
667
def __init__(self, *args, **kwargs):
668
self.object_cache = {}
669
super(pydbus_adapter.CachingBus,
670
self).__init__(*args, **kwargs)
671
def get(self, busname, objectpath):
673
return self.object_cache[(busname, objectpath)]
675
new_object = (super(pydbus_adapter.CachingBus, self)
676
.get(busname, objectpath))
677
self.object_cache[(busname, objectpath)] = new_object
475
681
def commands_from_options(options):
479
if options.is_enabled:
480
commands.append(command.IsEnabled())
483
commands.append(command.Approve())
486
commands.append(command.Deny())
489
commands.append(command.Remove())
491
if options.dump_json:
492
commands.append(command.DumpJSON())
495
commands.append(command.Enable())
498
commands.append(command.Disable())
500
if options.bump_timeout:
501
commands.append(command.BumpTimeout())
503
if options.start_checker:
504
commands.append(command.StartChecker())
506
if options.stop_checker:
507
commands.append(command.StopChecker())
509
if options.approved_by_default is not None:
510
if options.approved_by_default:
511
commands.append(command.ApproveByDefault())
683
commands = list(options.commands)
685
def find_cmd(cmd, commands):
687
for i, c in enumerate(commands):
688
if isinstance(c, cmd):
692
# If command.Remove is present, move any instances of command.Deny
693
# to occur ahead of command.Remove.
694
index_of_remove = find_cmd(command.Remove, commands)
695
before_remove = commands[:index_of_remove]
696
after_remove = commands[index_of_remove:]
698
for cmd in after_remove:
699
if isinstance(cmd, command.Deny):
700
before_remove.append(cmd)
513
commands.append(command.DenyByDefault())
515
if options.checker is not None:
516
commands.append(command.SetChecker(options.checker))
518
if options.host is not None:
519
commands.append(command.SetHost(options.host))
521
if options.secret is not None:
522
commands.append(command.SetSecret(options.secret))
524
if options.timeout is not None:
525
commands.append(command.SetTimeout(options.timeout))
527
if options.extended_timeout:
529
command.SetExtendedTimeout(options.extended_timeout))
531
if options.interval is not None:
532
commands.append(command.SetInterval(options.interval))
534
if options.approval_delay is not None:
536
command.SetApprovalDelay(options.approval_delay))
538
if options.approval_duration is not None:
540
command.SetApprovalDuration(options.approval_duration))
702
cleaned_after.append(cmd)
703
if cleaned_after != after_remove:
704
commands = before_remove + cleaned_after
542
706
# If no command option has been given, show table of clients,
543
707
# optionally verbosely
976
1124
def test_actions_all_conflicts_with_verbose(self):
977
1125
for action, value in self.actions.items():
978
options = self.parser.parse_args()
979
setattr(options, action, value)
981
options.verbose = True
1126
args = self.actionargs(action, value, "--all",
982
1128
with self.assertParseError():
983
self.check_option_syntax(options)
1129
self.parse_args(args)
985
1131
def test_actions_with_client_conflicts_with_verbose(self):
986
1132
for action, value in self.actions.items():
987
options = self.parser.parse_args()
988
setattr(options, action, value)
989
options.verbose = True
990
options.client = ["foo"]
1133
args = self.actionargs(action, value, "--verbose",
991
1135
with self.assertParseError():
992
self.check_option_syntax(options)
1136
self.parse_args(args)
994
1138
def test_dump_json_conflicts_with_verbose(self):
995
options = self.parser.parse_args()
996
options.dump_json = True
997
options.verbose = True
1139
args = ["--dump-json", "--verbose"]
998
1140
with self.assertParseError():
999
self.check_option_syntax(options)
1141
self.parse_args(args)
1001
1143
def test_dump_json_conflicts_with_action(self):
1002
1144
for action, value in self.actions.items():
1003
options = self.parser.parse_args()
1004
setattr(options, action, value)
1005
options.dump_json = True
1145
args = self.actionargs(action, value, "--dump-json")
1006
1146
with self.assertParseError():
1007
self.check_option_syntax(options)
1147
self.parse_args(args)
1009
1149
def test_all_can_not_be_alone(self):
1010
options = self.parser.parse_args()
1012
1151
with self.assertParseError():
1013
self.check_option_syntax(options)
1152
self.parse_args(args)
1015
1154
def test_all_is_ok_with_any_action(self):
1016
1155
for action, value in self.actions.items():
1017
options = self.parser.parse_args()
1018
setattr(options, action, value)
1020
self.check_option_syntax(options)
1156
args = self.actionargs(action, value, "--all")
1157
self.parse_args(args)
1022
1159
def test_any_action_is_ok_with_one_client(self):
1023
1160
for action, value in self.actions.items():
1024
options = self.parser.parse_args()
1025
setattr(options, action, value)
1026
options.client = ["foo"]
1027
self.check_option_syntax(options)
1161
args = self.actionargs(action, value, "client")
1162
self.parse_args(args)
1029
1164
def test_one_client_with_all_actions_except_is_enabled(self):
1030
options = self.parser.parse_args()
1031
1165
for action, value in self.actions.items():
1032
if action == "is_enabled":
1166
if action == "--is-enabled":
1034
setattr(options, action, value)
1035
options.client = ["foo"]
1036
self.check_option_syntax(options)
1168
args = self.actionargs(action, value, "client")
1169
self.parse_args(args)
1038
1171
def test_two_clients_with_all_actions_except_is_enabled(self):
1039
options = self.parser.parse_args()
1040
1172
for action, value in self.actions.items():
1041
if action == "is_enabled":
1173
if action == "--is-enabled":
1043
setattr(options, action, value)
1044
options.client = ["foo", "barbar"]
1045
self.check_option_syntax(options)
1175
args = self.actionargs(action, value, "client1",
1177
self.parse_args(args)
1047
1179
def test_two_clients_are_ok_with_actions_except_is_enabled(self):
1048
1180
for action, value in self.actions.items():
1049
if action == "is_enabled":
1181
if action == "--is-enabled":
1051
options = self.parser.parse_args()
1052
setattr(options, action, value)
1053
options.client = ["foo", "barbar"]
1054
self.check_option_syntax(options)
1183
args = self.actionargs(action, value, "client1",
1185
self.parse_args(args)
1056
1187
def test_is_enabled_fails_without_client(self):
1057
options = self.parser.parse_args()
1058
options.is_enabled = True
1188
args = ["--is-enabled"]
1059
1189
with self.assertParseError():
1060
self.check_option_syntax(options)
1190
self.parse_args(args)
1062
1192
def test_is_enabled_fails_with_two_clients(self):
1063
options = self.parser.parse_args()
1064
options.is_enabled = True
1065
options.client = ["foo", "barbar"]
1193
args = ["--is-enabled", "client1", "client2"]
1066
1194
with self.assertParseError():
1067
self.check_option_syntax(options)
1195
self.parse_args(args)
1069
1197
def test_remove_can_only_be_combined_with_action_deny(self):
1070
1198
for action, value in self.actions.items():
1071
if action in {"remove", "deny"}:
1199
if action in {"--remove", "--deny"}:
1073
options = self.parser.parse_args()
1074
setattr(options, action, value)
1076
options.remove = True
1201
args = self.actionargs(action, value, "--all",
1077
1203
with self.assertParseError():
1078
self.check_option_syntax(options)
1081
class Test_get_mandos_dbus_object(TestCaseWithAssertLogs):
1082
def test_calls_and_returns_get_object_on_bus(self):
1083
class MockBus(object):
1085
def get_object(mockbus_self, busname, dbus_path):
1086
# Note that "self" is still the testcase instance,
1087
# this MockBus instance is in "mockbus_self".
1088
self.assertEqual(dbus_busname, busname)
1089
self.assertEqual(server_dbus_path, dbus_path)
1090
mockbus_self.called = True
1093
mockbus = get_mandos_dbus_object(bus=MockBus())
1094
self.assertIsInstance(mockbus, MockBus)
1095
self.assertTrue(mockbus.called)
1097
def test_logs_and_exits_on_dbus_error(self):
1098
class MockBusFailing(object):
1099
def get_object(self, busname, dbus_path):
1100
raise dbus.exceptions.DBusException("Test")
1102
with self.assertLogs(log, logging.CRITICAL):
1103
with self.assertRaises(SystemExit) as e:
1104
bus = get_mandos_dbus_object(bus=MockBusFailing())
1106
if isinstance(e.exception.code, int):
1107
self.assertNotEqual(0, e.exception.code)
1109
self.assertIsNotNone(e.exception.code)
1112
class Test_get_managed_objects(TestCaseWithAssertLogs):
1113
def test_calls_and_returns_GetManagedObjects(self):
1114
managed_objects = {"/clients/foo": { "Name": "foo"}}
1115
class MockObjectManager(object):
1116
def GetManagedObjects(self):
1117
return managed_objects
1118
retval = get_managed_objects(MockObjectManager())
1119
self.assertDictEqual(managed_objects, retval)
1121
def test_logs_and_exits_on_dbus_error(self):
1204
self.parse_args(args)
1207
class Test_dbus_exceptions(unittest.TestCase):
1209
def test_dbus_ConnectFailed_is_Error(self):
1210
with self.assertRaises(dbus.Error):
1211
raise dbus.ConnectFailed()
1214
class Test_dbus_MandosBus(unittest.TestCase):
1216
class MockMandosBus(dbus.MandosBus):
1218
self._name = "se.recompile.Mandos"
1219
self._server_path = "/"
1220
self._server_interface = "se.recompile.Mandos"
1221
self._client_interface = "se.recompile.Mandos.Client"
1223
self.call_method_return = Unique()
1225
def call_method(self, methodname, busname, objectpath,
1227
self.calls.append((methodname, busname, objectpath,
1229
return self.call_method_return
1232
self.bus = self.MockMandosBus()
1234
def test_set_client_property(self):
1235
self.bus.set_client_property("objectpath", "key", "value")
1236
expected_call = ("Set", self.bus._name, "objectpath",
1237
"org.freedesktop.DBus.Properties",
1238
(self.bus._client_interface, "key", "value"))
1239
self.assertIn(expected_call, self.bus.calls)
1241
def test_call_client_method(self):
1242
ret = self.bus.call_client_method("objectpath", "methodname")
1243
self.assertIs(self.bus.call_method_return, ret)
1244
expected_call = ("methodname", self.bus._name, "objectpath",
1245
self.bus._client_interface, ())
1246
self.assertIn(expected_call, self.bus.calls)
1248
def test_call_client_method_with_args(self):
1249
args = (Unique(), Unique())
1250
ret = self.bus.call_client_method("objectpath", "methodname",
1252
self.assertIs(self.bus.call_method_return, ret)
1253
expected_call = ("methodname", self.bus._name, "objectpath",
1254
self.bus._client_interface,
1256
self.assertIn(expected_call, self.bus.calls)
1258
def test_get_clients_and_properties(self):
1261
self.bus._client_interface: {
1265
"irrelevant_interface": {
1266
"key": "othervalue",
1270
"other_objectpath": {
1271
"other_irrelevant_interface": {
1277
expected_clients_and_properties = {
1283
self.bus.call_method_return = managed_objects
1284
ret = self.bus.get_clients_and_properties()
1285
self.assertDictEqual(expected_clients_and_properties, ret)
1286
expected_call = ("GetManagedObjects", self.bus._name,
1287
self.bus._server_path,
1288
"org.freedesktop.DBus.ObjectManager", ())
1289
self.assertIn(expected_call, self.bus.calls)
1291
def test_call_server_method(self):
1292
ret = self.bus.call_server_method("methodname")
1293
self.assertIs(self.bus.call_method_return, ret)
1294
expected_call = ("methodname", self.bus._name,
1295
self.bus._server_path,
1296
self.bus._server_interface, ())
1297
self.assertIn(expected_call, self.bus.calls)
1299
def test_call_server_method_with_args(self):
1300
args = (Unique(), Unique())
1301
ret = self.bus.call_server_method("methodname", *args)
1302
self.assertIs(self.bus.call_method_return, ret)
1303
expected_call = ("methodname", self.bus._name,
1304
self.bus._server_path,
1305
self.bus._server_interface,
1307
self.assertIn(expected_call, self.bus.calls)
1310
class Test_dbus_python_adapter_SystemBus(TestCaseWithAssertLogs):
1312
def MockDBusPython_func(self, func):
1313
class mock_dbus_python(object):
1314
"""mock dbus-python module"""
1315
class exceptions(object):
1316
"""Pseudo-namespace"""
1317
class DBusException(Exception):
1319
class SystemBus(object):
1321
def get_object(busname, objectpath):
1322
DBusObject = collections.namedtuple(
1323
"DBusObject", ("methodname", "Set"))
1324
def method(*args, **kwargs):
1325
self.assertEqual({"dbus_interface":
1329
def set_property(interface, key, value,
1330
dbus_interface=None):
1332
"org.freedesktop.DBus.Properties",
1334
self.assertEqual("Secret", key)
1335
return func(interface, key, value,
1336
dbus_interface=dbus_interface)
1337
return DBusObject(methodname=method,
1339
class Boolean(object):
1340
def __init__(self, value):
1341
self.value = bool(value)
1344
if sys.version_info.major == 2:
1345
__nonzero__ = __bool__
1346
class ObjectPath(str):
1348
class Dictionary(dict):
1350
class ByteArray(bytes):
1352
return mock_dbus_python
1354
def call_method(self, bus, methodname, busname, objectpath,
1356
with self.assertLogs(log, logging.DEBUG):
1357
return bus.call_method(methodname, busname, objectpath,
1360
def test_call_method_returns(self):
1361
expected_method_return = Unique()
1362
method_args = (Unique(), Unique())
1364
self.assertEqual(len(method_args), len(args))
1365
for marg, arg in zip(method_args, args):
1366
self.assertIs(marg, arg)
1367
return expected_method_return
1368
mock_dbus_python = self.MockDBusPython_func(func)
1369
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1370
ret = self.call_method(bus, "methodname", "busname",
1371
"objectpath", "interface",
1373
self.assertIs(ret, expected_method_return)
1375
def test_call_method_filters_bool_true(self):
1377
return method_return
1378
mock_dbus_python = self.MockDBusPython_func(func)
1379
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1380
method_return = mock_dbus_python.Boolean(True)
1381
ret = self.call_method(bus, "methodname", "busname",
1382
"objectpath", "interface")
1383
self.assertTrue(ret)
1384
self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1386
def test_call_method_filters_bool_false(self):
1388
return method_return
1389
mock_dbus_python = self.MockDBusPython_func(func)
1390
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1391
method_return = mock_dbus_python.Boolean(False)
1392
ret = self.call_method(bus, "methodname", "busname",
1393
"objectpath", "interface")
1394
self.assertFalse(ret)
1395
self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1397
def test_call_method_filters_objectpath(self):
1399
return method_return
1400
mock_dbus_python = self.MockDBusPython_func(func)
1401
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1402
method_return = mock_dbus_python.ObjectPath("objectpath")
1403
ret = self.call_method(bus, "methodname", "busname",
1404
"objectpath", "interface")
1405
self.assertEqual("objectpath", ret)
1406
self.assertIsNot("objectpath", ret)
1407
self.assertNotIsInstance(ret, mock_dbus_python.ObjectPath)
1409
def test_call_method_filters_booleans_in_dict(self):
1411
return method_return
1412
mock_dbus_python = self.MockDBusPython_func(func)
1413
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1414
method_return = mock_dbus_python.Dictionary(
1415
{mock_dbus_python.Boolean(True):
1416
mock_dbus_python.Boolean(False),
1417
mock_dbus_python.Boolean(False):
1418
mock_dbus_python.Boolean(True)})
1419
ret = self.call_method(bus, "methodname", "busname",
1420
"objectpath", "interface")
1421
expected_method_return = {True: False,
1423
self.assertEqual(expected_method_return, ret)
1424
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1426
def test_call_method_filters_objectpaths_in_dict(self):
1428
return method_return
1429
mock_dbus_python = self.MockDBusPython_func(func)
1430
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1431
method_return = mock_dbus_python.Dictionary(
1432
{mock_dbus_python.ObjectPath("objectpath_key_1"):
1433
mock_dbus_python.ObjectPath("objectpath_value_1"),
1434
mock_dbus_python.ObjectPath("objectpath_key_2"):
1435
mock_dbus_python.ObjectPath("objectpath_value_2")})
1436
ret = self.call_method(bus, "methodname", "busname",
1437
"objectpath", "interface")
1438
expected_method_return = {str(key): str(value)
1440
method_return.items()}
1441
self.assertEqual(expected_method_return, ret)
1442
self.assertIsInstance(ret, dict)
1443
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1445
def test_call_method_filters_dict_in_dict(self):
1447
return method_return
1448
mock_dbus_python = self.MockDBusPython_func(func)
1449
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1450
method_return = mock_dbus_python.Dictionary(
1451
{"key1": mock_dbus_python.Dictionary({"key11": "value11",
1452
"key12": "value12"}),
1453
"key2": mock_dbus_python.Dictionary({"key21": "value21",
1454
"key22": "value22"})})
1455
ret = self.call_method(bus, "methodname", "busname",
1456
"objectpath", "interface")
1457
expected_method_return = {
1458
"key1": {"key11": "value11",
1459
"key12": "value12"},
1460
"key2": {"key21": "value21",
1461
"key22": "value22"},
1463
self.assertEqual(expected_method_return, ret)
1464
self.assertIsInstance(ret, dict)
1465
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1466
for key, value in ret.items():
1467
self.assertIsInstance(value, dict)
1468
self.assertEqual(expected_method_return[key], value)
1469
self.assertNotIsInstance(value,
1470
mock_dbus_python.Dictionary)
1472
def test_call_method_filters_dict_three_deep(self):
1474
return method_return
1475
mock_dbus_python = self.MockDBusPython_func(func)
1476
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1477
method_return = mock_dbus_python.Dictionary(
1479
mock_dbus_python.Dictionary(
1481
mock_dbus_python.Dictionary(
1483
mock_dbus_python.Boolean(True),
1487
ret = self.call_method(bus, "methodname", "busname",
1488
"objectpath", "interface")
1489
expected_method_return = {"key1": {"key2": {"key3": True}}}
1490
self.assertEqual(expected_method_return, ret)
1491
self.assertIsInstance(ret, dict)
1492
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1493
self.assertIsInstance(ret["key1"], dict)
1494
self.assertNotIsInstance(ret["key1"],
1495
mock_dbus_python.Dictionary)
1496
self.assertIsInstance(ret["key1"]["key2"], dict)
1497
self.assertNotIsInstance(ret["key1"]["key2"],
1498
mock_dbus_python.Dictionary)
1499
self.assertTrue(ret["key1"]["key2"]["key3"])
1500
self.assertNotIsInstance(ret["key1"]["key2"]["key3"],
1501
mock_dbus_python.Boolean)
1503
def test_call_method_handles_exception(self):
1122
1504
dbus_logger = logging.getLogger("dbus.proxies")
1124
class MockObjectManagerFailing(object):
1125
def GetManagedObjects(self):
1126
dbus_logger.error("Test")
1127
raise dbus.exceptions.DBusException("Test")
1507
dbus_logger.error("Test")
1508
raise mock_dbus_python.exceptions.DBusException()
1510
mock_dbus_python = self.MockDBusPython_func(func)
1511
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1129
1513
class CountingHandler(logging.Handler):
1136
1520
dbus_logger.addHandler(counting_handler)
1139
with self.assertLogs(log, logging.CRITICAL) as watcher:
1140
with self.assertRaises(SystemExit) as e:
1141
get_managed_objects(MockObjectManagerFailing())
1523
with self.assertRaises(dbus.Error) as e:
1524
self.call_method(bus, "methodname", "busname",
1525
"objectpath", "interface")
1143
1527
dbus_logger.removeFilter(counting_handler)
1529
self.assertNotIsInstance(e, dbus.ConnectFailed)
1145
1531
# Make sure the dbus logger was suppressed
1146
1532
self.assertEqual(0, counting_handler.count)
1148
# Test that the dbus_logger still works
1149
with self.assertLogs(dbus_logger, logging.ERROR):
1150
dbus_logger.error("Test")
1152
if isinstance(e.exception.code, int):
1153
self.assertNotEqual(0, e.exception.code)
1155
self.assertIsNotNone(e.exception.code)
1534
def test_Set_Secret_sends_bytearray(self):
1536
def func(*args, **kwargs):
1537
ret[0] = (args, kwargs)
1538
mock_dbus_python = self.MockDBusPython_func(func)
1539
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1540
bus.set_client_property("objectpath", "Secret", "value")
1541
expected_call = (("se.recompile.Mandos.Client", "Secret",
1542
mock_dbus_python.ByteArray(b"value")),
1544
"org.freedesktop.DBus.Properties"})
1545
self.assertEqual(expected_call, ret[0])
1546
if sys.version_info.major == 2:
1547
self.assertIsInstance(ret[0][0][-1],
1548
mock_dbus_python.ByteArray)
1550
def test_get_object_converts_to_correct_exception(self):
1551
bus = dbus_python_adapter.SystemBus(
1552
self.fake_dbus_python_raises_exception_on_connect)
1553
with self.assertRaises(dbus.ConnectFailed):
1554
self.call_method(bus, "methodname", "busname",
1555
"objectpath", "interface")
1557
class fake_dbus_python_raises_exception_on_connect(object):
1558
"""fake dbus-python module"""
1559
class exceptions(object):
1560
"""Pseudo-namespace"""
1561
class DBusException(Exception):
1566
def get_object(busname, objectpath):
1567
raise cls.exceptions.DBusException()
1568
Bus = collections.namedtuple("Bus", ["get_object"])
1569
return Bus(get_object=get_object)
1572
class Test_dbus_python_adapter_CachingBus(unittest.TestCase):
1573
class mock_dbus_python(object):
1574
"""mock dbus-python modules"""
1575
class SystemBus(object):
1577
def get_object(busname, objectpath):
1581
self.bus = dbus_python_adapter.CachingBus(
1582
self.mock_dbus_python)
1584
def test_returns_distinct_objectpaths(self):
1585
obj1 = self.bus.get_object("busname", "objectpath1")
1586
self.assertIsInstance(obj1, Unique)
1587
obj2 = self.bus.get_object("busname", "objectpath2")
1588
self.assertIsInstance(obj2, Unique)
1589
self.assertIsNot(obj1, obj2)
1591
def test_returns_distinct_busnames(self):
1592
obj1 = self.bus.get_object("busname1", "objectpath")
1593
self.assertIsInstance(obj1, Unique)
1594
obj2 = self.bus.get_object("busname2", "objectpath")
1595
self.assertIsInstance(obj2, Unique)
1596
self.assertIsNot(obj1, obj2)
1598
def test_returns_distinct_both(self):
1599
obj1 = self.bus.get_object("busname1", "objectpath")
1600
self.assertIsInstance(obj1, Unique)
1601
obj2 = self.bus.get_object("busname2", "objectpath")
1602
self.assertIsInstance(obj2, Unique)
1603
self.assertIsNot(obj1, obj2)
1605
def test_returns_same(self):
1606
obj1 = self.bus.get_object("busname", "objectpath")
1607
self.assertIsInstance(obj1, Unique)
1608
obj2 = self.bus.get_object("busname", "objectpath")
1609
self.assertIsInstance(obj2, Unique)
1610
self.assertIs(obj1, obj2)
1612
def test_returns_same_old(self):
1613
obj1 = self.bus.get_object("busname1", "objectpath1")
1614
self.assertIsInstance(obj1, Unique)
1615
obj2 = self.bus.get_object("busname2", "objectpath2")
1616
self.assertIsInstance(obj2, Unique)
1617
obj1b = self.bus.get_object("busname1", "objectpath1")
1618
self.assertIsInstance(obj1b, Unique)
1619
self.assertIsNot(obj1, obj2)
1620
self.assertIsNot(obj2, obj1b)
1621
self.assertIs(obj1, obj1b)
1624
class Test_pydbus_adapter_SystemBus(TestCaseWithAssertLogs):
1626
def Stub_pydbus_func(self, func):
1627
class stub_pydbus(object):
1628
"""stub pydbus module"""
1629
class SystemBus(object):
1631
def get(busname, objectpath):
1632
DBusObject = collections.namedtuple(
1633
"DBusObject", ("methodname",))
1634
return {"interface":
1635
DBusObject(methodname=func)}
1638
def call_method(self, bus, methodname, busname, objectpath,
1640
with self.assertLogs(log, logging.DEBUG):
1641
return bus.call_method(methodname, busname, objectpath,
1644
def test_call_method_returns(self):
1645
expected_method_return = Unique()
1646
method_args = (Unique(), Unique())
1648
self.assertEqual(len(method_args), len(args))
1649
for marg, arg in zip(method_args, args):
1650
self.assertIs(marg, arg)
1651
return expected_method_return
1652
stub_pydbus = self.Stub_pydbus_func(func)
1653
bus = pydbus_adapter.SystemBus(stub_pydbus)
1654
ret = self.call_method(bus, "methodname", "busname",
1655
"objectpath", "interface",
1657
self.assertIs(ret, expected_method_return)
1659
def test_call_method_handles_exception(self):
1660
dbus_logger = logging.getLogger("dbus.proxies")
1663
raise gi.repository.GLib.Error()
1665
stub_pydbus = self.Stub_pydbus_func(func)
1666
bus = pydbus_adapter.SystemBus(stub_pydbus)
1668
with self.assertRaises(dbus.Error) as e:
1669
self.call_method(bus, "methodname", "busname",
1670
"objectpath", "interface")
1672
self.assertNotIsInstance(e, dbus.ConnectFailed)
1674
def test_get_converts_to_correct_exception(self):
1675
bus = pydbus_adapter.SystemBus(
1676
self.fake_pydbus_raises_exception_on_connect)
1677
with self.assertRaises(dbus.ConnectFailed):
1678
self.call_method(bus, "methodname", "busname",
1679
"objectpath", "interface")
1681
class fake_pydbus_raises_exception_on_connect(object):
1682
"""fake dbus-python module"""
1685
def get(busname, objectpath):
1686
raise gi.repository.GLib.Error()
1687
Bus = collections.namedtuple("Bus", ["get"])
1690
def test_set_property_uses_setattr(self):
1691
class Object(object):
1694
class pydbus_spy(object):
1695
class SystemBus(object):
1697
def get(busname, objectpath):
1698
return {"interface": obj}
1699
bus = pydbus_adapter.SystemBus(pydbus_spy)
1701
bus.set_property("busname", "objectpath", "interface", "key",
1703
self.assertIs(value, obj.key)
1705
def test_get_suppresses_xml_deprecation_warning(self):
1706
if sys.version_info.major >= 3:
1708
class stub_pydbus_get(object):
1709
class SystemBus(object):
1711
def get(busname, objectpath):
1712
warnings.warn_explicit(
1713
"deprecated", DeprecationWarning,
1714
"xml.etree.ElementTree", 0)
1715
bus = pydbus_adapter.SystemBus(stub_pydbus_get)
1716
with warnings.catch_warnings(record=True) as w:
1717
warnings.simplefilter("always")
1718
bus.get("busname", "objectpath")
1719
self.assertEqual(0, len(w))
1722
class Test_pydbus_adapter_CachingBus(unittest.TestCase):
1723
class stub_pydbus(object):
1724
"""stub pydbus module"""
1725
class SystemBus(object):
1727
def get(busname, objectpath):
1731
self.bus = pydbus_adapter.CachingBus(self.stub_pydbus)
1733
def test_returns_distinct_objectpaths(self):
1734
obj1 = self.bus.get("busname", "objectpath1")
1735
self.assertIsInstance(obj1, Unique)
1736
obj2 = self.bus.get("busname", "objectpath2")
1737
self.assertIsInstance(obj2, Unique)
1738
self.assertIsNot(obj1, obj2)
1740
def test_returns_distinct_busnames(self):
1741
obj1 = self.bus.get("busname1", "objectpath")
1742
self.assertIsInstance(obj1, Unique)
1743
obj2 = self.bus.get("busname2", "objectpath")
1744
self.assertIsInstance(obj2, Unique)
1745
self.assertIsNot(obj1, obj2)
1747
def test_returns_distinct_both(self):
1748
obj1 = self.bus.get("busname1", "objectpath")
1749
self.assertIsInstance(obj1, Unique)
1750
obj2 = self.bus.get("busname2", "objectpath")
1751
self.assertIsInstance(obj2, Unique)
1752
self.assertIsNot(obj1, obj2)
1754
def test_returns_same(self):
1755
obj1 = self.bus.get("busname", "objectpath")
1756
self.assertIsInstance(obj1, Unique)
1757
obj2 = self.bus.get("busname", "objectpath")
1758
self.assertIsInstance(obj2, Unique)
1759
self.assertIs(obj1, obj2)
1761
def test_returns_same_old(self):
1762
obj1 = self.bus.get("busname1", "objectpath1")
1763
self.assertIsInstance(obj1, Unique)
1764
obj2 = self.bus.get("busname2", "objectpath2")
1765
self.assertIsInstance(obj2, Unique)
1766
obj1b = self.bus.get("busname1", "objectpath1")
1767
self.assertIsInstance(obj1b, Unique)
1768
self.assertIsNot(obj1, obj2)
1769
self.assertIsNot(obj2, obj1b)
1770
self.assertIs(obj1, obj1b)
1158
1773
class Test_commands_from_options(unittest.TestCase):
1159
1775
def setUp(self):
1160
1776
self.parser = argparse.ArgumentParser()
1161
1777
add_command_line_options(self.parser)
1163
1779
def test_is_enabled(self):
1164
self.assert_command_from_args(["--is-enabled", "foo"],
1780
self.assert_command_from_args(["--is-enabled", "client"],
1165
1781
command.IsEnabled)
1167
1783
def assert_command_from_args(self, args, command_cls,
1217
1835
self.assertIsInstance(commands[1], command.Remove)
1219
1837
def test_remove_short(self):
1220
self.assert_command_from_args(["-r", "foo"], command.Remove)
1838
self.assert_command_from_args(["-r", "client"],
1222
1841
def test_dump_json(self):
1223
1842
self.assert_command_from_args(["--dump-json"],
1224
1843
command.DumpJSON)
1226
1845
def test_enable(self):
1227
self.assert_command_from_args(["--enable", "foo"],
1846
self.assert_command_from_args(["--enable", "client"],
1228
1847
command.Enable)
1230
1849
def test_enable_short(self):
1231
self.assert_command_from_args(["-e", "foo"], command.Enable)
1850
self.assert_command_from_args(["-e", "client"],
1233
1853
def test_disable(self):
1234
self.assert_command_from_args(["--disable", "foo"],
1854
self.assert_command_from_args(["--disable", "client"],
1235
1855
command.Disable)
1237
1857
def test_disable_short(self):
1238
self.assert_command_from_args(["-d", "foo"], command.Disable)
1858
self.assert_command_from_args(["-d", "client"],
1240
1861
def test_bump_timeout(self):
1241
self.assert_command_from_args(["--bump-timeout", "foo"],
1862
self.assert_command_from_args(["--bump-timeout", "client"],
1242
1863
command.BumpTimeout)
1244
1865
def test_bump_timeout_short(self):
1245
self.assert_command_from_args(["-b", "foo"],
1866
self.assert_command_from_args(["-b", "client"],
1246
1867
command.BumpTimeout)
1248
1869
def test_start_checker(self):
1249
self.assert_command_from_args(["--start-checker", "foo"],
1870
self.assert_command_from_args(["--start-checker", "client"],
1250
1871
command.StartChecker)
1252
1873
def test_stop_checker(self):
1253
self.assert_command_from_args(["--stop-checker", "foo"],
1874
self.assert_command_from_args(["--stop-checker", "client"],
1254
1875
command.StopChecker)
1256
1877
def test_approve_by_default(self):
1257
self.assert_command_from_args(["--approve-by-default", "foo"],
1878
self.assert_command_from_args(["--approve-by-default",
1258
1880
command.ApproveByDefault)
1260
1882
def test_deny_by_default(self):
1261
self.assert_command_from_args(["--deny-by-default", "foo"],
1883
self.assert_command_from_args(["--deny-by-default", "client"],
1262
1884
command.DenyByDefault)
1264
1886
def test_checker(self):
1265
self.assert_command_from_args(["--checker", ":", "foo"],
1887
self.assert_command_from_args(["--checker", ":", "client"],
1266
1888
command.SetChecker,
1267
1889
value_to_set=":")
1269
1891
def test_checker_empty(self):
1270
self.assert_command_from_args(["--checker", "", "foo"],
1892
self.assert_command_from_args(["--checker", "", "client"],
1271
1893
command.SetChecker,
1272
1894
value_to_set="")
1274
1896
def test_checker_short(self):
1275
self.assert_command_from_args(["-c", ":", "foo"],
1897
self.assert_command_from_args(["-c", ":", "client"],
1276
1898
command.SetChecker,
1277
1899
value_to_set=":")
1279
1901
def test_host(self):
1280
self.assert_command_from_args(["--host", "foo.example.org",
1281
"foo"], command.SetHost,
1282
value_to_set="foo.example.org")
1902
self.assert_command_from_args(
1903
["--host", "client.example.org", "client"],
1904
command.SetHost, value_to_set="client.example.org")
1284
1906
def test_host_short(self):
1285
self.assert_command_from_args(["-H", "foo.example.org",
1286
"foo"], command.SetHost,
1287
value_to_set="foo.example.org")
1907
self.assert_command_from_args(
1908
["-H", "client.example.org", "client"], command.SetHost,
1909
value_to_set="client.example.org")
1289
1911
def test_secret_devnull(self):
1290
1912
self.assert_command_from_args(["--secret", os.path.devnull,
1291
"foo"], command.SetSecret,
1913
"client"], command.SetSecret,
1292
1914
value_to_set=b"")
1294
1916
def test_secret_tempfile(self):
1369
1992
class TestCommand(unittest.TestCase):
1370
1993
"""Abstract class for tests of command classes"""
1995
class FakeMandosBus(dbus.MandosBus):
1996
def __init__(self, testcase):
1997
self.client_properties = {
1999
"KeyID": ("92ed150794387c03ce684574b1139a65"
2000
"94a34f895daaaf09fd8ea90a27cddb12"),
2001
"Secret": b"secret",
2002
"Host": "foo.example.org",
2005
"LastCheckedOK": "2019-02-03T00:00:00",
2006
"Created": "2019-01-02T00:00:00",
2008
"Fingerprint": ("778827225BA7DE539C5A"
2009
"7CFA59CFF7CDBD9A5920"),
2010
"CheckerRunning": False,
2011
"LastEnabled": "2019-01-03T00:00:00",
2012
"ApprovalPending": False,
2013
"ApprovedByDefault": True,
2014
"LastApprovalRequest": "",
2016
"ApprovalDuration": 1000,
2017
"Checker": "fping -q -- %(host)s",
2018
"ExtendedTimeout": 900000,
2019
"Expires": "2019-02-04T00:00:00",
2020
"LastCheckerStatus": 0,
2022
self.other_client_properties = {
2024
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
2025
"6ab612cff5ad227247e46c2b020f441c"),
2026
"Secret": b"secretbar",
2027
"Host": "192.0.2.3",
2030
"LastCheckedOK": "2019-02-04T00:00:00",
2031
"Created": "2019-01-03T00:00:00",
2033
"Fingerprint": ("3E393AEAEFB84C7E89E2"
2034
"F547B3A107558FCA3A27"),
2035
"CheckerRunning": True,
2036
"LastEnabled": "2019-01-04T00:00:00",
2037
"ApprovalPending": False,
2038
"ApprovedByDefault": False,
2039
"LastApprovalRequest": "2019-01-03T00:00:00",
2040
"ApprovalDelay": 30000,
2041
"ApprovalDuration": 93785000,
2043
"ExtendedTimeout": 900000,
2044
"Expires": "2019-02-05T00:00:00",
2045
"LastCheckerStatus": -2,
2047
self.clients = collections.OrderedDict(
2049
("client_objectpath", self.client_properties),
2050
("other_client_objectpath",
2051
self.other_client_properties),
2053
self.one_client = {"client_objectpath":
2054
self.client_properties}
2055
self.testcase = testcase
2058
def call_method(self, methodname, busname, objectpath,
2060
self.testcase.assertEqual("se.recompile.Mandos", busname)
2061
self.calls.append((methodname, busname, objectpath,
2063
if interface == "org.freedesktop.DBus.Properties":
2064
if methodname == "Set":
2065
self.testcase.assertEqual(3, len(args))
2066
interface, key, value = args
2067
self.testcase.assertEqual(
2068
"se.recompile.Mandos.Client", interface)
2069
self.clients[objectpath][key] = value
2071
elif interface == "se.recompile.Mandos":
2072
self.testcase.assertEqual("RemoveClient", methodname)
2073
self.testcase.assertEqual(1, len(args))
2074
clientpath = args[0]
2075
del self.clients[clientpath]
2077
elif interface == "se.recompile.Mandos.Client":
2078
if methodname == "Approve":
2079
self.testcase.assertEqual(1, len(args))
1372
2083
def setUp(self):
1374
class MockClient(object):
1375
def __init__(self, name, **attributes):
1376
self.__dbus_object_path__ = "/clients/{}".format(name)
1377
self.attributes = attributes
1378
self.attributes["Name"] = name
1380
def Set(self, interface, propname, value, dbus_interface):
1381
testcase.assertEqual(client_dbus_interface, interface)
1382
testcase.assertEqual(dbus.PROPERTIES_IFACE,
1384
self.attributes[propname] = value
1385
def Approve(self, approve, dbus_interface):
1386
testcase.assertEqual(client_dbus_interface,
1388
self.calls.append(("Approve", (approve,
1390
self.client = MockClient(
1392
KeyID=("92ed150794387c03ce684574b1139a65"
1393
"94a34f895daaaf09fd8ea90a27cddb12"),
1395
Host="foo.example.org",
1396
Enabled=dbus.Boolean(True),
1398
LastCheckedOK="2019-02-03T00:00:00",
1399
Created="2019-01-02T00:00:00",
1401
Fingerprint=("778827225BA7DE539C5A"
1402
"7CFA59CFF7CDBD9A5920"),
1403
CheckerRunning=dbus.Boolean(False),
1404
LastEnabled="2019-01-03T00:00:00",
1405
ApprovalPending=dbus.Boolean(False),
1406
ApprovedByDefault=dbus.Boolean(True),
1407
LastApprovalRequest="",
1409
ApprovalDuration=1000,
1410
Checker="fping -q -- %(host)s",
1411
ExtendedTimeout=900000,
1412
Expires="2019-02-04T00:00:00",
1413
LastCheckerStatus=0)
1414
self.other_client = MockClient(
1416
KeyID=("0558568eedd67d622f5c83b35a115f79"
1417
"6ab612cff5ad227247e46c2b020f441c"),
1418
Secret=b"secretbar",
1420
Enabled=dbus.Boolean(True),
1422
LastCheckedOK="2019-02-04T00:00:00",
1423
Created="2019-01-03T00:00:00",
1425
Fingerprint=("3E393AEAEFB84C7E89E2"
1426
"F547B3A107558FCA3A27"),
1427
CheckerRunning=dbus.Boolean(True),
1428
LastEnabled="2019-01-04T00:00:00",
1429
ApprovalPending=dbus.Boolean(False),
1430
ApprovedByDefault=dbus.Boolean(False),
1431
LastApprovalRequest="2019-01-03T00:00:00",
1432
ApprovalDelay=30000,
1433
ApprovalDuration=93785000,
1435
ExtendedTimeout=900000,
1436
Expires="2019-02-05T00:00:00",
1437
LastCheckerStatus=-2)
1438
self.clients = collections.OrderedDict(
1440
("/clients/foo", self.client.attributes),
1441
("/clients/barbar", self.other_client.attributes),
1443
self.one_client = {"/clients/foo": self.client.attributes}
1449
def get_object(client_bus_name, path):
1450
self.assertEqual(dbus_busname, client_bus_name)
1452
# Note: "self" here is the TestCmd instance, not
1453
# the Bus instance, since this is a static method!
1454
"/clients/foo": self.client,
1455
"/clients/barbar": self.other_client,
2084
self.bus = self.FakeMandosBus(self)
1460
2087
class TestBaseCommands(TestCommand):
1462
2089
def test_IsEnabled_exits_successfully(self):
1463
2090
with self.assertRaises(SystemExit) as e:
1464
command.IsEnabled().run(self.one_client)
2091
command.IsEnabled().run(self.bus.one_client)
1465
2092
if e.exception.code is not None:
1466
2093
self.assertEqual(0, e.exception.code)
1468
2095
self.assertIsNone(e.exception.code)
1470
2097
def test_IsEnabled_exits_with_failure(self):
1471
self.client.attributes["Enabled"] = dbus.Boolean(False)
2098
self.bus.client_properties["Enabled"] = False
1472
2099
with self.assertRaises(SystemExit) as e:
1473
command.IsEnabled().run(self.one_client)
2100
command.IsEnabled().run(self.bus.one_client)
1474
2101
if isinstance(e.exception.code, int):
1475
2102
self.assertNotEqual(0, e.exception.code)
1477
2104
self.assertIsNotNone(e.exception.code)
1479
2106
def test_Approve(self):
1480
command.Approve().run(self.clients, self.bus)
1481
for clientpath in self.clients:
1482
client = self.bus.get_object(dbus_busname, clientpath)
1483
self.assertIn(("Approve", (True, client_dbus_interface)),
2107
busname = "se.recompile.Mandos"
2108
client_interface = "se.recompile.Mandos.Client"
2109
command.Approve().run(self.bus.clients, self.bus)
2110
for clientpath in self.bus.clients:
2111
self.assertIn(("Approve", busname, clientpath,
2112
client_interface, (True,)), self.bus.calls)
1486
2114
def test_Deny(self):
1487
command.Deny().run(self.clients, self.bus)
1488
for clientpath in self.clients:
1489
client = self.bus.get_object(dbus_busname, clientpath)
1490
self.assertIn(("Approve", (False, client_dbus_interface)),
2115
busname = "se.recompile.Mandos"
2116
client_interface = "se.recompile.Mandos.Client"
2117
command.Deny().run(self.bus.clients, self.bus)
2118
for clientpath in self.bus.clients:
2119
self.assertIn(("Approve", busname, clientpath,
2120
client_interface, (False,)),
1493
2123
def test_Remove(self):
1494
class MockMandos(object):
1497
def RemoveClient(self, dbus_path):
1498
self.calls.append(("RemoveClient", (dbus_path,)))
1499
mandos = MockMandos()
1500
command.Remove().run(self.clients, self.bus, mandos)
1501
for clientpath in self.clients:
1502
self.assertIn(("RemoveClient", (clientpath,)),
2124
command.Remove().run(self.bus.clients, self.bus)
2125
for clientpath in self.bus.clients:
2126
self.assertIn(("RemoveClient", dbus_busname,
2127
dbus_server_path, dbus_server_interface,
2128
(clientpath,)), self.bus.calls)
1505
2130
expected_json = {
1665
2304
num_lines = max(len(rows) for rows in columns)
1666
expected_output = "\n".join("".join(rows[line]
1667
for rows in columns)
1668
for line in range(num_lines))
1669
self.assertEqual(expected_output, output)
2305
expected_output = ("\n".join("".join(rows[line]
2306
for rows in columns)
2307
for line in range(num_lines))
2309
self.assertEqual(expected_output, buffer.getvalue())
1671
2311
def test_PrintTable_one_client(self):
1672
output = command.PrintTable().output(self.one_client.values())
2312
with self.capture_stdout_to_buffer() as buffer:
2313
command.PrintTable().run(self.bus.one_client)
1673
2314
expected_output = "\n".join((
1674
2315
"Name Enabled Timeout Last Successful Check",
1675
2316
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1677
self.assertEqual(expected_output, output)
1680
class TestPropertyCmd(TestCommand):
1681
"""Abstract class for tests of command.Property classes"""
2318
self.assertEqual(expected_output, buffer.getvalue())
2321
class TestPropertySetterCmd(TestCommand):
2322
"""Abstract class for tests of command.PropertySetter classes"""
1682
2324
def runTest(self):
1683
2325
if not hasattr(self, "command"):
1685
values_to_get = getattr(self, "values_to_get",
1687
for value_to_set, value_to_get in zip(self.values_to_set,
1689
for clientpath in self.clients:
1690
client = self.bus.get_object(dbus_busname, clientpath)
1691
old_value = client.attributes[self.propname]
1692
client.attributes[self.propname] = self.Unique()
1693
self.run_command(value_to_set, self.clients)
1694
for clientpath in self.clients:
1695
client = self.bus.get_object(dbus_busname, clientpath)
1696
value = client.attributes[self.propname]
1697
self.assertNotIsInstance(value, self.Unique)
2326
return # Abstract TestCase class
2328
if hasattr(self, "values_to_set"):
2329
cmd_args = [(value,) for value in self.values_to_set]
2330
values_to_get = getattr(self, "values_to_get",
2333
cmd_args = [() for x in range(len(self.values_to_get))]
2334
values_to_get = self.values_to_get
2335
for value_to_get, cmd_arg in zip(values_to_get, cmd_args):
2336
for clientpath in self.bus.clients:
2337
self.bus.clients[clientpath][self.propname] = (
2339
self.command(*cmd_arg).run(self.bus.clients, self.bus)
2340
for clientpath in self.bus.clients:
2341
value = (self.bus.clients[clientpath]
2343
self.assertNotIsInstance(value, Unique)
1698
2344
self.assertEqual(value_to_get, value)
1700
class Unique(object):
1701
"""Class for objects which exist only to be unique objects,
1702
since unittest.mock.sentinel only exists in Python 3.3"""
1704
def run_command(self, value, clients):
1705
self.command().run(clients, self.bus)
1708
class TestEnableCmd(TestPropertyCmd):
2347
class TestEnableCmd(TestPropertySetterCmd):
1709
2348
command = command.Enable
1710
2349
propname = "Enabled"
1711
values_to_set = [dbus.Boolean(True)]
1714
class TestDisableCmd(TestPropertyCmd):
2350
values_to_get = [True]
2353
class TestDisableCmd(TestPropertySetterCmd):
1715
2354
command = command.Disable
1716
2355
propname = "Enabled"
1717
values_to_set = [dbus.Boolean(False)]
1720
class TestBumpTimeoutCmd(TestPropertyCmd):
2356
values_to_get = [False]
2359
class TestBumpTimeoutCmd(TestPropertySetterCmd):
1721
2360
command = command.BumpTimeout
1722
2361
propname = "LastCheckedOK"
1723
values_to_set = [""]
1726
class TestStartCheckerCmd(TestPropertyCmd):
2362
values_to_get = [""]
2365
class TestStartCheckerCmd(TestPropertySetterCmd):
1727
2366
command = command.StartChecker
1728
2367
propname = "CheckerRunning"
1729
values_to_set = [dbus.Boolean(True)]
1732
class TestStopCheckerCmd(TestPropertyCmd):
2368
values_to_get = [True]
2371
class TestStopCheckerCmd(TestPropertySetterCmd):
1733
2372
command = command.StopChecker
1734
2373
propname = "CheckerRunning"
1735
values_to_set = [dbus.Boolean(False)]
1738
class TestApproveByDefaultCmd(TestPropertyCmd):
2374
values_to_get = [False]
2377
class TestApproveByDefaultCmd(TestPropertySetterCmd):
1739
2378
command = command.ApproveByDefault
1740
2379
propname = "ApprovedByDefault"
1741
values_to_set = [dbus.Boolean(True)]
1744
class TestDenyByDefaultCmd(TestPropertyCmd):
2380
values_to_get = [True]
2383
class TestDenyByDefaultCmd(TestPropertySetterCmd):
1745
2384
command = command.DenyByDefault
1746
2385
propname = "ApprovedByDefault"
1747
values_to_set = [dbus.Boolean(False)]
1750
class TestPropertyValueCmd(TestPropertyCmd):
1751
"""Abstract class for tests of PropertyValueCmd classes"""
1754
if type(self) is TestPropertyValueCmd:
1756
return super(TestPropertyValueCmd, self).runTest()
1758
def run_command(self, value, clients):
1759
self.command(value).run(clients, self.bus)
1762
class TestSetCheckerCmd(TestPropertyValueCmd):
2386
values_to_get = [False]
2389
class TestSetCheckerCmd(TestPropertySetterCmd):
1763
2390
command = command.SetChecker
1764
2391
propname = "Checker"
1765
2392
values_to_set = ["", ":", "fping -q -- %s"]
1768
class TestSetHostCmd(TestPropertyValueCmd):
2395
class TestSetHostCmd(TestPropertySetterCmd):
1769
2396
command = command.SetHost
1770
2397
propname = "Host"
1771
values_to_set = ["192.0.2.3", "foo.example.org"]
1774
class TestSetSecretCmd(TestPropertyValueCmd):
2398
values_to_set = ["192.0.2.3", "client.example.org"]
2401
class TestSetSecretCmd(TestPropertySetterCmd):
1775
2402
command = command.SetSecret
1776
2403
propname = "Secret"
1777
2404
values_to_set = [io.BytesIO(b""),
1778
2405
io.BytesIO(b"secret\0xyzzy\nbar")]
1779
values_to_get = [b"", b"secret\0xyzzy\nbar"]
1782
class TestSetTimeoutCmd(TestPropertyValueCmd):
2406
values_to_get = [f.getvalue() for f in values_to_set]
2409
class TestSetTimeoutCmd(TestPropertySetterCmd):
1783
2410
command = command.SetTimeout
1784
2411
propname = "Timeout"
1785
2412
values_to_set = [datetime.timedelta(),