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 1143
- compare with another revision
- download diff
- download tarball
- view history from revision 1143
- Committer: Teddy Hogeborn
- Date: 2019-08-03 12:27:14 UTC
- Revision ID: teddy@recompile.se-20190803122714-efudxsyomr1k0zbt
dracut-module/password-agent.c: Use O_NOCTTY
Whenever a file is opened using open(), use the O_NOCTTY flag, just to
be safe.
* dracut-module/password-agent.c (test_start_mandos_client_execv): Use
O_NOCTTY.
(test_wait_for_mandos_client_exit_failure): - '' -
(test_wait_for_mandos_client_exit_killed): - '' -
(test_read_mandos_client_output_readerror): - '' -
(test_read_inotify_event_readerror): - '' -
(test_connect_question_socket_bad_epoll): - '' -
(test_send_password_to_socket_bad_epoll): - '' -
(assert_add_existing_questions_to_devnull): - '' -
Whenever a file is opened using open(), use the O_NOCTTY flag, just to
be safe.
* dracut-module/password-agent.c (test_start_mandos_client_execv): Use
O_NOCTTY.
(test_wait_for_mandos_client_exit_failure): - '' -
(test_wait_for_mandos_client_exit_killed): - '' -
(test_read_mandos_client_output_readerror): - '' -
(test_read_inotify_event_readerror): - '' -
(test_connect_question_socket_bad_epoll): - '' -
(test_send_password_to_socket_bad_epoll): - '' -
(assert_add_existing_questions_to_devnull): - '' -
- files added:
- debian/po/POTFILES.in
- debian/tests
- dracut-module
- files modified:
- .bzrignore
added
removed
mandos-ctl
1
1
#!/usr/bin/python
2
# -*- mode: python; coding: utf-8; after-save-hook: (lambda () (let ((command (if (and (boundp 'tramp-file-name-structure) (string-match (car tramp-file-name-structure) (buffer-file-name))) (tramp-file-name-localname (tramp-dissect-file-name (buffer-file-name))) (buffer-file-name)))) (if (= (shell-command (format "%s --check" (shell-quote-argument command)) "*Test*") 0) (let ((w (get-buffer-window "*Test*"))) (if w (delete-window w)) (kill-buffer "*Test*")) (display-buffer "*Test*")))); -*-
2
# -*- after-save-hook: (lambda () (let ((command (if (fboundp 'file-local-name) (file-local-name (buffer-file-name)) (or (file-remote-p (buffer-file-name) 'localname) (buffer-file-name))))) (if (= (progn (if (get-buffer "*Test*") (kill-buffer "*Test*")) (process-file-shell-command (format "%s --check" (shell-quote-argument command)) nil "*Test*")) 0) (let ((w (get-buffer-window "*Test*"))) (if w (delete-window w))) (progn (with-current-buffer "*Test*" (compilation-mode)) (display-buffer "*Test*" '(display-buffer-in-side-window)))))); coding: utf-8 -*-
3
3
#
4
4
# Mandos Monitor - Control and monitor the Mandos server
5
5
#
46
46
import tempfile
47
47
import contextlib
48
48
49
import dbus
49
try:
50
import pydbus
51
import gi
52
dbus_python = None
53
except ImportError:
54
import dbus as dbus_python
55
pydbus = None
56
class gi(object):
57
"""Dummy gi module, for the tests"""
58
class repository(object):
59
class GLib(object):
60
class Error(Exception):
61
pass
50
62
51
63
# Show warnings by default
52
64
if not sys.warnoptions:
61
73
62
74
if sys.version_info.major == 2:
63
75
str = unicode
76
import StringIO
77
io.StringIO = StringIO.StringIO
64
78
65
79
locale.setlocale(locale.LC_ALL, "")
66
80
67
dbus_busname_domain = "se.recompile"
68
dbus_busname = dbus_busname_domain + ".Mandos"
69
server_dbus_path = "/"
70
server_dbus_interface = dbus_busname_domain + ".Mandos"
71
client_dbus_interface = dbus_busname_domain + ".Mandos.Client"
72
del dbus_busname_domain
73
version = "1.8.3"
74
75
76
try:
77
dbus.OBJECT_MANAGER_IFACE
78
except AttributeError:
79
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
81
version = "1.8.5"
80
82
81
83
82
84
def main():
83
85
parser = argparse.ArgumentParser()
84
85
86
add_command_line_options(parser)
86
87
87
88
options = parser.parse_args()
88
89
89
check_option_syntax(parser, options)
90
90
91
91
clientnames = options.client
93
93
if options.debug:
94
94
log.setLevel(logging.DEBUG)
95
95
96
bus = dbus.SystemBus()
97
98
mandos_dbus_object = get_mandos_dbus_object(bus)
99
100
mandos_serv = dbus.Interface(
101
mandos_dbus_object, dbus_interface=server_dbus_interface)
102
mandos_serv_object_manager = dbus.Interface(
103
mandos_dbus_object, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
104
105
managed_objects = get_managed_objects(mandos_serv_object_manager)
106
107
all_clients = {}
108
for path, ifs_and_props in managed_objects.items():
109
try:
110
all_clients[path] = ifs_and_props[client_dbus_interface]
111
except KeyError:
112
pass
96
if pydbus is not None:
97
bus = pydbus_adapter.CachingBus(pydbus)
98
else:
99
bus = dbus_python_adapter.CachingBus(dbus_python)
100
101
try:
102
all_clients = bus.get_clients_and_properties()
103
except dbus.ConnectFailed as e:
104
log.critical("Could not connect to Mandos server: %s", e)
105
sys.exit(1)
106
except dbus.Error as e:
107
log.critical(
108
"Failed to access Mandos server through D-Bus:\n%s", e)
109
sys.exit(1)
113
110
114
111
# Compile dict of (clientpath: properties) to process
115
112
if not clientnames:
128
125
commands = commands_from_options(options)
129
126
130
127
for command in commands:
131
command.run(clients, bus, mandos_serv)
128
command.run(clients, bus)
132
129
133
130
134
131
def add_command_line_options(parser):
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
action="store_true",
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",
154
action="store_true",
158
dest="commands",
159
action="append_const", default=[],
160
const=command.StartChecker(),
155
161
help="Start checker for client")
156
start_stop_checker.add_argument("--stop-checker",
157
action="store_true",
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")
178
parser.add_argument(
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")
183
parser.add_argument(
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")
188
parser.add_argument(
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")
204
parser.add_argument(
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")
209
parser.add_argument(
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")
218
parser.add_argument(
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)")
212
250
def rfc3339_duration_to_delta(duration):
213
251
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
214
252
215
>>> rfc3339_duration_to_delta("P7D")
216
datetime.timedelta(7)
217
>>> rfc3339_duration_to_delta("PT60S")
218
datetime.timedelta(0, 60)
219
>>> rfc3339_duration_to_delta("PT60M")
220
datetime.timedelta(0, 3600)
221
>>> rfc3339_duration_to_delta("P60M")
222
datetime.timedelta(1680)
223
>>> rfc3339_duration_to_delta("PT24H")
224
datetime.timedelta(1)
225
>>> rfc3339_duration_to_delta("P1W")
226
datetime.timedelta(7)
227
>>> rfc3339_duration_to_delta("PT5M30S")
228
datetime.timedelta(0, 330)
229
>>> rfc3339_duration_to_delta("P1DT3M20S")
230
datetime.timedelta(1, 200)
253
>>> rfc3339_duration_to_delta("P7D") == datetime.timedelta(7)
254
True
255
>>> rfc3339_duration_to_delta("PT60S") == datetime.timedelta(0, 60)
256
True
257
>>> rfc3339_duration_to_delta("PT60M") == datetime.timedelta(hours=1)
258
True
259
>>> # 60 months
260
>>> rfc3339_duration_to_delta("P60M") == datetime.timedelta(1680)
261
True
262
>>> rfc3339_duration_to_delta("PT24H") == datetime.timedelta(1)
263
True
264
>>> rfc3339_duration_to_delta("P1W") == datetime.timedelta(7)
265
True
266
>>> rfc3339_duration_to_delta("PT5M30S") == datetime.timedelta(0, 330)
267
True
268
>>> rfc3339_duration_to_delta("P1DT3M20S") == datetime.timedelta(1, 200)
269
True
231
270
>>> # Can not be empty:
232
271
>>> rfc3339_duration_to_delta("")
233
272
Traceback (most recent call last):
343
382
"""Parse an interval string as documented by Mandos before 1.6.1,
344
383
and return a datetime.timedelta
345
384
346
>>> parse_pre_1_6_1_interval('7d')
347
datetime.timedelta(7)
348
>>> parse_pre_1_6_1_interval('60s')
349
datetime.timedelta(0, 60)
350
>>> parse_pre_1_6_1_interval('60m')
351
datetime.timedelta(0, 3600)
352
>>> parse_pre_1_6_1_interval('24h')
353
datetime.timedelta(1)
354
>>> parse_pre_1_6_1_interval('1w')
355
datetime.timedelta(7)
356
>>> parse_pre_1_6_1_interval('5m 30s')
357
datetime.timedelta(0, 330)
358
>>> parse_pre_1_6_1_interval('')
359
datetime.timedelta(0)
385
>>> parse_pre_1_6_1_interval('7d') == datetime.timedelta(days=7)
386
True
387
>>> parse_pre_1_6_1_interval('60s') == datetime.timedelta(0, 60)
388
True
389
>>> parse_pre_1_6_1_interval('60m') == datetime.timedelta(hours=1)
390
True
391
>>> parse_pre_1_6_1_interval('24h') == datetime.timedelta(days=1)
392
True
393
>>> parse_pre_1_6_1_interval('1w') == datetime.timedelta(days=7)
394
True
395
>>> parse_pre_1_6_1_interval('5m 30s') == datetime.timedelta(0, 330)
396
True
397
>>> parse_pre_1_6_1_interval('') == datetime.timedelta(0)
398
True
360
399
>>> # Ignore unknown characters, allow any order and repetitions
361
>>> parse_pre_1_6_1_interval('2dxy7zz11y3m5m')
362
datetime.timedelta(2, 480, 18000)
400
>>> parse_pre_1_6_1_interval('2dxy7zz11y3m5m') == datetime.timedelta(2, 480, 18000)
401
True
363
402
364
403
"""
365
404
386
425
"""Apply additional restrictions on options, not expressible in
387
426
argparse"""
388
427
389
def has_actions(options):
390
return any((options.enable,
391
options.disable,
392
options.bump_timeout,
393
options.start_checker,
394
options.stop_checker,
395
options.is_enabled,
396
options.remove,
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,
406
options.approve,
407
options.deny))
428
def has_commands(options, commands=None):
429
if commands is None:
430
commands = (command.Enable,
431
command.Disable,
432
command.BumpTimeout,
433
command.StartChecker,
434
command.StopChecker,
435
command.IsEnabled,
436
command.Remove,
437
command.SetChecker,
438
command.SetTimeout,
439
command.SetExtendedTimeout,
440
command.SetInterval,
441
command.ApproveByDefault,
442
command.DenyByDefault,
443
command.SetApprovalDelay,
444
command.SetApprovalDuration,
445
command.SetHost,
446
command.SetSecret,
447
command.Approve,
448
command.Deny)
449
return any(isinstance(cmd, commands)
450
for cmd in options.commands)
408
451
409
if has_actions(options) and not (options.client or options.all):
452
if has_commands(options) and not (options.client or options.all):
410
453
parser.error("Options require clients names or --all.")
411
if options.verbose and has_actions(options):
454
if options.verbose and has_commands(options):
412
455
parser.error("--verbose can only be used alone.")
413
if options.dump_json and (options.verbose
414
or has_actions(options)):
456
if (has_commands(options, (command.DumpJSON,))
457
and (options.verbose or len(options.commands) > 1)):
415
458
parser.error("--dump-json can only be used alone.")
416
if options.all and not has_actions(options):
459
if options.all and not has_commands(options):
417
460
parser.error("--all requires an action.")
418
if options.is_enabled and len(options.client) > 1:
461
if (has_commands(options, (command.IsEnabled,))
462
and len(options.client) > 1):
419
463
parser.error("--is-enabled requires exactly one client")
420
if options.remove:
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
425
426
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,
433
server_dbus_path)
434
return mandos_dbus_object
435
436
437
@contextlib.contextmanager
438
def if_dbus_exception_log_with_exception_and_exit(*args, **kwargs):
439
try:
440
yield
441
except dbus.exceptions.DBusException as e:
442
log.critical(*(args + (e,)), **kwargs)
443
sys.exit(1)
444
445
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
454
455
456
class SilenceLogger(object):
457
"Simple context manager to silence a particular logger"
458
def __init__(self, loggername):
459
self.logger = logging.getLogger(loggername)
460
461
def __enter__(self):
462
self.logger.addFilter(self.nullfilter)
463
return self
464
465
class NullFilter(logging.Filter):
466
def filter(self, record):
467
return False
468
469
nullfilter = NullFilter()
470
471
def __exit__(self, exc_type, exc_val, exc_tb):
472
self.logger.removeFilter(self.nullfilter)
464
if (len(options.commands) > 1
465
and has_commands(options, (command.Remove,))
466
and not has_commands(options, (command.Deny,))):
467
parser.error("--remove can only be combined with --deny")
468
469
470
class dbus(object):
471
472
class SystemBus(object):
473
474
object_manager_iface = "org.freedesktop.DBus.ObjectManager"
475
def get_managed_objects(self, busname, objectpath):
476
return self.call_method("GetManagedObjects", busname,
477
objectpath,
478
self.object_manager_iface)
479
480
properties_iface = "org.freedesktop.DBus.Properties"
481
def set_property(self, busname, objectpath, interface, key,
482
value):
483
self.call_method("Set", busname, objectpath,
484
self.properties_iface, interface, key,
485
value)
486
487
488
class MandosBus(SystemBus):
489
busname_domain = "se.recompile"
490
busname = busname_domain + ".Mandos"
491
server_path = "/"
492
server_interface = busname_domain + ".Mandos"
493
client_interface = busname_domain + ".Mandos.Client"
494
del busname_domain
495
496
def get_clients_and_properties(self):
497
managed_objects = self.get_managed_objects(
498
self.busname, self.server_path)
499
return {objpath: properties[self.client_interface]
500
for objpath, properties in managed_objects.items()
501
if self.client_interface in properties}
502
503
def set_client_property(self, objectpath, key, value):
504
return self.set_property(self.busname, objectpath,
505
self.client_interface, key,
506
value)
507
508
def call_client_method(self, objectpath, method, *args):
509
return self.call_method(method, self.busname, objectpath,
510
self.client_interface, *args)
511
512
def call_server_method(self, method, *args):
513
return self.call_method(method, self.busname,
514
self.server_path,
515
self.server_interface, *args)
516
517
class Error(Exception):
518
pass
519
520
class ConnectFailed(Error):
521
pass
522
523
524
class dbus_python_adapter(object):
525
526
class SystemBus(dbus.MandosBus):
527
"""Use dbus-python"""
528
529
def __init__(self, module=dbus_python):
530
self.dbus_python = module
531
self.bus = self.dbus_python.SystemBus()
532
533
@contextlib.contextmanager
534
def convert_exception(self, exception_class=dbus.Error):
535
try:
536
yield
537
except self.dbus_python.exceptions.DBusException as e:
538
# This does what "raise from" would do
539
exc = exception_class(*e.args)
540
exc.__cause__ = e
541
raise exc
542
543
def call_method(self, methodname, busname, objectpath,
544
interface, *args):
545
proxy_object = self.get_object(busname, objectpath)
546
log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
547
interface, methodname,
548
", ".join(repr(a) for a in args))
549
method = getattr(proxy_object, methodname)
550
with self.convert_exception():
551
with dbus_python_adapter.SilenceLogger(
552
"dbus.proxies"):
553
value = method(*args, dbus_interface=interface)
554
return self.type_filter(value)
555
556
def get_object(self, busname, objectpath):
557
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
558
busname, objectpath)
559
with self.convert_exception(dbus.ConnectFailed):
560
return self.bus.get_object(busname, objectpath)
561
562
def type_filter(self, value):
563
"""Convert the most bothersome types to Python types"""
564
if isinstance(value, self.dbus_python.Boolean):
565
return bool(value)
566
if isinstance(value, self.dbus_python.ObjectPath):
567
return str(value)
568
# Also recurse into dictionaries
569
if isinstance(value, self.dbus_python.Dictionary):
570
return {self.type_filter(key):
571
self.type_filter(subval)
572
for key, subval in value.items()}
573
return value
574
575
def set_client_property(self, objectpath, key, value):
576
if key == "Secret":
577
if not isinstance(value, bytes):
578
value = value.encode("utf-8")
579
value = self.dbus_python.ByteArray(value)
580
return self.set_property(self.busname, objectpath,
581
self.client_interface, key,
582
value)
583
584
class SilenceLogger(object):
585
"Simple context manager to silence a particular logger"
586
def __init__(self, loggername):
587
self.logger = logging.getLogger(loggername)
588
589
def __enter__(self):
590
self.logger.addFilter(self.nullfilter)
591
592
class NullFilter(logging.Filter):
593
def filter(self, record):
594
return False
595
596
nullfilter = NullFilter()
597
598
def __exit__(self, exc_type, exc_val, exc_tb):
599
self.logger.removeFilter(self.nullfilter)
600
601
602
class CachingBus(SystemBus):
603
"""A caching layer for dbus_python_adapter.SystemBus"""
604
def __init__(self, *args, **kwargs):
605
self.object_cache = {}
606
super(dbus_python_adapter.CachingBus,
607
self).__init__(*args, **kwargs)
608
def get_object(self, busname, objectpath):
609
try:
610
return self.object_cache[(busname, objectpath)]
611
except KeyError:
612
new_object = super(
613
dbus_python_adapter.CachingBus,
614
self).get_object(busname, objectpath)
615
self.object_cache[(busname, objectpath)] = new_object
616
return new_object
617
618
619
class pydbus_adapter(object):
620
class SystemBus(dbus.MandosBus):
621
def __init__(self, module=pydbus):
622
self.pydbus = module
623
self.bus = self.pydbus.SystemBus()
624
625
@contextlib.contextmanager
626
def convert_exception(self, exception_class=dbus.Error):
627
try:
628
yield
629
except gi.repository.GLib.Error as e:
630
# This does what "raise from" would do
631
exc = exception_class(*e.args)
632
exc.__cause__ = e
633
raise exc
634
635
def call_method(self, methodname, busname, objectpath,
636
interface, *args):
637
proxy_object = self.get(busname, objectpath)
638
log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
639
interface, methodname,
640
", ".join(repr(a) for a in args))
641
method = getattr(proxy_object[interface], methodname)
642
with self.convert_exception():
643
return method(*args)
644
645
def get(self, busname, objectpath):
646
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
647
busname, objectpath)
648
with self.convert_exception(dbus.ConnectFailed):
649
if sys.version_info.major <= 2:
650
with warnings.catch_warnings():
651
warnings.filterwarnings(
652
"ignore", "", DeprecationWarning,
653
r"^xml\.etree\.ElementTree$")
654
return self.bus.get(busname, objectpath)
655
else:
656
return self.bus.get(busname, objectpath)
657
658
def set_property(self, busname, objectpath, interface, key,
659
value):
660
proxy_object = self.get(busname, objectpath)
661
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", busname,
662
objectpath, self.properties_iface, interface,
663
key, value)
664
setattr(proxy_object[interface], key, value)
665
666
class CachingBus(SystemBus):
667
"""A caching layer for pydbus_adapter.SystemBus"""
668
def __init__(self, *args, **kwargs):
669
self.object_cache = {}
670
super(pydbus_adapter.CachingBus,
671
self).__init__(*args, **kwargs)
672
def get(self, busname, objectpath):
673
try:
674
return self.object_cache[(busname, objectpath)]
675
except KeyError:
676
new_object = (super(pydbus_adapter.CachingBus, self)
677
.get(busname, objectpath))
678
self.object_cache[(busname, objectpath)] = new_object
679
return new_object
473
680
474
681
475
682
def commands_from_options(options):
476
683
477
commands = []
478
479
if options.is_enabled:
480
commands.append(command.IsEnabled())
481
482
if options.approve:
483
commands.append(command.Approve())
484
485
if options.deny:
486
commands.append(command.Deny())
487
488
if options.remove:
489
commands.append(command.Remove())
490
491
if options.dump_json:
492
commands.append(command.DumpJSON())
493
494
if options.enable:
495
commands.append(command.Enable())
496
497
if options.disable:
498
commands.append(command.Disable())
499
500
if options.bump_timeout:
501
commands.append(command.BumpTimeout())
502
503
if options.start_checker:
504
commands.append(command.StartChecker())
505
506
if options.stop_checker:
507
commands.append(command.StopChecker())
508
509
if options.approved_by_default is not None:
510
if options.approved_by_default:
511
commands.append(command.ApproveByDefault())
684
commands = list(options.commands)
685
686
def find_cmd(cmd, commands):
687
i = 0
688
for i, c in enumerate(commands):
689
if isinstance(c, cmd):
690
return i
691
return i+1
692
693
# If command.Remove is present, move any instances of command.Deny
694
# to occur ahead of command.Remove.
695
index_of_remove = find_cmd(command.Remove, commands)
696
before_remove = commands[:index_of_remove]
697
after_remove = commands[index_of_remove:]
698
cleaned_after = []
699
for cmd in after_remove:
700
if isinstance(cmd, command.Deny):
701
before_remove.append(cmd)
512
702
else:
513
commands.append(command.DenyByDefault())
514
515
if options.checker is not None:
516
commands.append(command.SetChecker(options.checker))
517
518
if options.host is not None:
519
commands.append(command.SetHost(options.host))
520
521
if options.secret is not None:
522
commands.append(command.SetSecret(options.secret))
523
524
if options.timeout is not None:
525
commands.append(command.SetTimeout(options.timeout))
526
527
if options.extended_timeout:
528
commands.append(
529
command.SetExtendedTimeout(options.extended_timeout))
530
531
if options.interval is not None:
532
commands.append(command.SetInterval(options.interval))
533
534
if options.approval_delay is not None:
535
commands.append(
536
command.SetApprovalDelay(options.approval_delay))
537
538
if options.approval_duration is not None:
539
commands.append(
540
command.SetApprovalDuration(options.approval_duration))
703
cleaned_after.append(cmd)
704
if cleaned_after != after_remove:
705
commands = before_remove + cleaned_after
541
706
542
707
# If no command option has been given, show table of clients,
543
708
# optionally verbosely
552
717
553
718
class Base(object):
554
719
"""Abstract base class for commands"""
555
def run(self, clients, bus=None, mandos=None):
720
def run(self, clients, bus=None):
556
721
"""Normal commands should implement run_on_one_client(),
557
722
but commands which want to operate on all clients at the same time can
558
723
override this run() method instead.
559
724
"""
560
self.mandos = mandos
561
for clientpath, properties in clients.items():
562
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
563
dbus_busname, str(clientpath))
564
client = bus.get_object(dbus_busname, clientpath)
725
self.bus = bus
726
for client, properties in clients.items():
565
727
self.run_on_one_client(client, properties)
566
728
567
729
568
730
class IsEnabled(Base):
569
def run(self, clients, bus=None, mandos=None):
570
client, properties = next(iter(clients.items()))
571
if self.is_enabled(client, properties):
731
def run(self, clients, bus=None):
732
properties = next(iter(clients.values()))
733
if properties["Enabled"]:
572
734
sys.exit(0)
573
735
sys.exit(1)
574
def is_enabled(self, client, properties):
575
return properties["Enabled"]
576
736
577
737
578
738
class Approve(Base):
579
739
def run_on_one_client(self, client, properties):
580
log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
581
client.__dbus_object_path__,
582
client_dbus_interface)
583
client.Approve(dbus.Boolean(True),
584
dbus_interface=client_dbus_interface)
740
self.bus.call_client_method(client, "Approve", True)
585
741
586
742
587
743
class Deny(Base):
588
744
def run_on_one_client(self, client, properties):
589
log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
590
client.__dbus_object_path__,
591
client_dbus_interface)
592
client.Approve(dbus.Boolean(False),
593
dbus_interface=client_dbus_interface)
745
self.bus.call_client_method(client, "Approve", False)
594
746
595
747
596
748
class Remove(Base):
597
def run_on_one_client(self, client, properties):
598
log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)",
599
dbus_busname, server_dbus_path,
600
server_dbus_interface,
601
str(client.__dbus_object_path__))
602
self.mandos.RemoveClient(client.__dbus_object_path__)
749
def run(self, clients, bus):
750
for clientpath in frozenset(clients.keys()):
751
bus.call_server_method("RemoveClient", clientpath)
603
752
604
753
605
754
class Output(Base):
613
762
"Checker", "ExtendedTimeout", "Expires",
614
763
"LastCheckerStatus")
615
764
616
def run(self, clients, bus=None, mandos=None):
617
print(self.output(clients.values()))
618
619
def output(self, clients):
620
raise NotImplementedError()
621
622
765
623
766
class DumpJSON(Output):
624
def output(self, clients):
625
data = {client["Name"]:
626
{key: self.dbus_boolean_to_bool(client[key])
767
def run(self, clients, bus=None):
768
data = {properties["Name"]:
769
{key: properties[key]
627
770
for key in self.all_keywords}
628
for client in clients}
629
return json.dumps(data, indent=4, separators=(',', ': '))
630
631
@staticmethod
632
def dbus_boolean_to_bool(value):
633
if isinstance(value, dbus.Boolean):
634
value = bool(value)
635
return value
771
for properties in clients.values()}
772
print(json.dumps(data, indent=4, separators=(',', ': ')))
636
773
637
774
638
775
class PrintTable(Output):
639
776
def __init__(self, verbose=False):
640
777
self.verbose = verbose
641
778
642
def output(self, clients):
779
def run(self, clients, bus=None):
643
780
default_keywords = ("Name", "Enabled", "Timeout",
644
781
"LastCheckedOK")
645
782
keywords = default_keywords
646
783
if self.verbose:
647
784
keywords = self.all_keywords
648
return str(self.TableOfClients(clients, keywords))
785
print(self.TableOfClients(clients.values(), keywords))
649
786
650
787
class TableOfClients(object):
651
788
tableheaders = {
706
843
707
844
@classmethod
708
845
def valuetostring(cls, value, keyword):
709
if isinstance(value, dbus.Boolean):
846
if isinstance(value, bool):
710
847
return "Yes" if value else "No"
711
848
if keyword in ("Timeout", "Interval", "ApprovalDelay",
712
849
"ApprovalDuration", "ExtendedTimeout"):
732
869
seconds=td.seconds % 60))
733
870
734
871
735
class Property(Base):
872
class PropertySetter(Base):
736
873
"Abstract class for Actions for setting one client property"
737
874
738
def run_on_one_client(self, client, properties):
875
def run_on_one_client(self, client, properties=None):
739
876
"""Set the Client's D-Bus property"""
740
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
741
client.__dbus_object_path__,
742
dbus.PROPERTIES_IFACE, client_dbus_interface,
743
self.propname, self.value_to_set
744
if not isinstance(self.value_to_set,
745
dbus.Boolean)
746
else bool(self.value_to_set))
747
client.Set(client_dbus_interface, self.propname,
748
self.value_to_set,
749
dbus_interface=dbus.PROPERTIES_IFACE)
877
self.bus.set_client_property(client, self.propname,
878
self.value_to_set)
750
879
751
880
@property
752
881
def propname(self):
753
882
raise NotImplementedError()
754
883
755
884
756
class Enable(Property):
757
propname = "Enabled"
758
value_to_set = dbus.Boolean(True)
759
760
761
class Disable(Property):
762
propname = "Enabled"
763
value_to_set = dbus.Boolean(False)
764
765
766
class BumpTimeout(Property):
885
class Enable(PropertySetter):
886
propname = "Enabled"
887
value_to_set = True
888
889
890
class Disable(PropertySetter):
891
propname = "Enabled"
892
value_to_set = False
893
894
895
class BumpTimeout(PropertySetter):
767
896
propname = "LastCheckedOK"
768
897
value_to_set = ""
769
898
770
899
771
class StartChecker(Property):
772
propname = "CheckerRunning"
773
value_to_set = dbus.Boolean(True)
774
775
776
class StopChecker(Property):
777
propname = "CheckerRunning"
778
value_to_set = dbus.Boolean(False)
779
780
781
class ApproveByDefault(Property):
782
propname = "ApprovedByDefault"
783
value_to_set = dbus.Boolean(True)
784
785
786
class DenyByDefault(Property):
787
propname = "ApprovedByDefault"
788
value_to_set = dbus.Boolean(False)
789
790
791
class PropertyValue(Property):
792
"Abstract class for Property recieving a value as argument"
900
class StartChecker(PropertySetter):
901
propname = "CheckerRunning"
902
value_to_set = True
903
904
905
class StopChecker(PropertySetter):
906
propname = "CheckerRunning"
907
value_to_set = False
908
909
910
class ApproveByDefault(PropertySetter):
911
propname = "ApprovedByDefault"
912
value_to_set = True
913
914
915
class DenyByDefault(PropertySetter):
916
propname = "ApprovedByDefault"
917
value_to_set = False
918
919
920
class PropertySetterValue(PropertySetter):
921
"""Abstract class for PropertySetter recieving a value as
922
constructor argument instead of a class attribute."""
793
923
def __init__(self, value):
794
924
self.value_to_set = value
795
925
926
@classmethod
927
def argparse(cls, argtype):
928
def cmdtype(arg):
929
return cls(argtype(arg))
930
return cmdtype
796
931
797
class SetChecker(PropertyValue):
932
class SetChecker(PropertySetterValue):
798
933
propname = "Checker"
799
934
800
935
801
class SetHost(PropertyValue):
936
class SetHost(PropertySetterValue):
802
937
propname = "Host"
803
938
804
939
805
class SetSecret(PropertyValue):
940
class SetSecret(PropertySetterValue):
806
941
propname = "Secret"
807
942
808
943
@property
816
951
value.close()
817
952
818
953
819
class MillisecondsPropertyValueArgument(PropertyValue):
820
"""Abstract class for PropertyValue taking a value argument as
821
a datetime.timedelta() but should store it as milliseconds."""
954
class PropertySetterValueMilliseconds(PropertySetterValue):
955
"""Abstract class for PropertySetterValue taking a value
956
argument as a datetime.timedelta() but should store it as
957
milliseconds."""
822
958
823
959
@property
824
960
def value_to_set(self):
830
966
self._vts = int(round(value.total_seconds() * 1000))
831
967
832
968
833
class SetTimeout(MillisecondsPropertyValueArgument):
969
class SetTimeout(PropertySetterValueMilliseconds):
834
970
propname = "Timeout"
835
971
836
972
837
class SetExtendedTimeout(MillisecondsPropertyValueArgument):
973
class SetExtendedTimeout(PropertySetterValueMilliseconds):
838
974
propname = "ExtendedTimeout"
839
975
840
976
841
class SetInterval(MillisecondsPropertyValueArgument):
977
class SetInterval(PropertySetterValueMilliseconds):
842
978
propname = "Interval"
843
979
844
980
845
class SetApprovalDelay(MillisecondsPropertyValueArgument):
981
class SetApprovalDelay(PropertySetterValueMilliseconds):
846
982
propname = "ApprovalDelay"
847
983
848
984
849
class SetApprovalDuration(MillisecondsPropertyValueArgument):
985
class SetApprovalDuration(PropertySetterValueMilliseconds):
850
986
propname = "ApprovalDuration"
851
987
852
988
885
1021
"output"))
886
1022
887
1023
1024
class Unique(object):
1025
"""Class for objects which exist only to be unique objects, since
1026
unittest.mock.sentinel only exists in Python 3.3"""
1027
1028
888
1029
class Test_string_to_delta(TestCaseWithAssertLogs):
889
1030
# Just test basic RFC 3339 functionality here, the doc string for
890
1031
# rfc3339_duration_to_delta() already has more comprehensive
891
# tests, which is run by doctest.
1032
# tests, which are run by doctest.
892
1033
893
1034
def test_rfc3339_zero_seconds(self):
894
1035
self.assertEqual(datetime.timedelta(),
918
1059
919
1060
def test_actions_requires_client_or_all(self):
920
1061
for action, value in self.actions.items():
921
options = self.parser.parse_args()
922
setattr(options, action, value)
1062
args = self.actionargs(action, value)
923
1063
with self.assertParseError():
924
self.check_option_syntax(options)
1064
self.parse_args(args)
925
1065
926
# This mostly corresponds to the definition from has_actions() in
1066
# This mostly corresponds to the definition from has_commands() in
927
1067
# check_option_syntax()
928
1068
actions = {
929
# The actual values set here are not that important, but we do
930
# at least stick to the correct types, even though they are
931
# never used
932
"enable": True,
933
"disable": True,
934
"bump_timeout": True,
935
"start_checker": True,
936
"stop_checker": True,
937
"is_enabled": True,
938
"remove": True,
939
"checker": "x",
940
"timeout": datetime.timedelta(),
941
"extended_timeout": datetime.timedelta(),
942
"interval": datetime.timedelta(),
943
"approved_by_default": True,
944
"approval_delay": datetime.timedelta(),
945
"approval_duration": datetime.timedelta(),
946
"host": "x",
947
"secret": io.BytesIO(b"x"),
948
"approve": True,
949
"deny": True,
1069
"--enable": None,
1070
"--disable": None,
1071
"--bump-timeout": None,
1072
"--start-checker": None,
1073
"--stop-checker": None,
1074
"--is-enabled": None,
1075
"--remove": None,
1076
"--checker": "x",
1077
"--timeout": "PT0S",
1078
"--extended-timeout": "PT0S",
1079
"--interval": "PT0S",
1080
"--approve-by-default": None,
1081
"--deny-by-default": None,
1082
"--approval-delay": "PT0S",
1083
"--approval-duration": "PT0S",
1084
"--host": "hostname",
1085
"--secret": "/dev/null",
1086
"--approve": None,
1087
"--deny": None,
950
1088
}
951
1089
1090
@staticmethod
1091
def actionargs(action, value, *args):
1092
if value is not None:
1093
return [action, value] + list(args)
1094
else:
1095
return [action] + list(args)
1096
952
1097
@contextlib.contextmanager
953
1098
def assertParseError(self):
954
1099
with self.assertRaises(SystemExit) as e:
959
1104
# /argparse.html#exiting-methods
960
1105
self.assertEqual(2, e.exception.code)
961
1106
1107
def parse_args(self, args):
1108
options = self.parser.parse_args(args)
1109
check_option_syntax(self.parser, options)
1110
962
1111
@staticmethod
963
1112
@contextlib.contextmanager
964
1113
def redirect_stderr_to_devnull():
975
1124
976
1125
def test_actions_all_conflicts_with_verbose(self):
977
1126
for action, value in self.actions.items():
978
options = self.parser.parse_args()
979
setattr(options, action, value)
980
options.all = True
981
options.verbose = True
1127
args = self.actionargs(action, value, "--all",
1128
"--verbose")
982
1129
with self.assertParseError():
983
self.check_option_syntax(options)
1130
self.parse_args(args)
984
1131
985
1132
def test_actions_with_client_conflicts_with_verbose(self):
986
1133
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"]
1134
args = self.actionargs(action, value, "--verbose",
1135
"client")
991
1136
with self.assertParseError():
992
self.check_option_syntax(options)
1137
self.parse_args(args)
993
1138
994
1139
def test_dump_json_conflicts_with_verbose(self):
995
options = self.parser.parse_args()
996
options.dump_json = True
997
options.verbose = True
1140
args = ["--dump-json", "--verbose"]
998
1141
with self.assertParseError():
999
self.check_option_syntax(options)
1142
self.parse_args(args)
1000
1143
1001
1144
def test_dump_json_conflicts_with_action(self):
1002
1145
for action, value in self.actions.items():
1003
options = self.parser.parse_args()
1004
setattr(options, action, value)
1005
options.dump_json = True
1146
args = self.actionargs(action, value, "--dump-json")
1006
1147
with self.assertParseError():
1007
self.check_option_syntax(options)
1148
self.parse_args(args)
1008
1149
1009
1150
def test_all_can_not_be_alone(self):
1010
options = self.parser.parse_args()
1011
options.all = True
1151
args = ["--all"]
1012
1152
with self.assertParseError():
1013
self.check_option_syntax(options)
1153
self.parse_args(args)
1014
1154
1015
1155
def test_all_is_ok_with_any_action(self):
1016
1156
for action, value in self.actions.items():
1017
options = self.parser.parse_args()
1018
setattr(options, action, value)
1019
options.all = True
1020
self.check_option_syntax(options)
1157
args = self.actionargs(action, value, "--all")
1158
self.parse_args(args)
1021
1159
1022
1160
def test_any_action_is_ok_with_one_client(self):
1023
1161
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)
1162
args = self.actionargs(action, value, "client")
1163
self.parse_args(args)
1028
1164
1029
1165
def test_one_client_with_all_actions_except_is_enabled(self):
1030
options = self.parser.parse_args()
1031
1166
for action, value in self.actions.items():
1032
if action == "is_enabled":
1167
if action == "--is-enabled":
1033
1168
continue
1034
setattr(options, action, value)
1035
options.client = ["foo"]
1036
self.check_option_syntax(options)
1169
args = self.actionargs(action, value, "client")
1170
self.parse_args(args)
1037
1171
1038
1172
def test_two_clients_with_all_actions_except_is_enabled(self):
1039
options = self.parser.parse_args()
1040
1173
for action, value in self.actions.items():
1041
if action == "is_enabled":
1174
if action == "--is-enabled":
1042
1175
continue
1043
setattr(options, action, value)
1044
options.client = ["foo", "barbar"]
1045
self.check_option_syntax(options)
1176
args = self.actionargs(action, value, "client1",
1177
"client2")
1178
self.parse_args(args)
1046
1179
1047
1180
def test_two_clients_are_ok_with_actions_except_is_enabled(self):
1048
1181
for action, value in self.actions.items():
1049
if action == "is_enabled":
1182
if action == "--is-enabled":
1050
1183
continue
1051
options = self.parser.parse_args()
1052
setattr(options, action, value)
1053
options.client = ["foo", "barbar"]
1054
self.check_option_syntax(options)
1184
args = self.actionargs(action, value, "client1",
1185
"client2")
1186
self.parse_args(args)
1055
1187
1056
1188
def test_is_enabled_fails_without_client(self):
1057
options = self.parser.parse_args()
1058
options.is_enabled = True
1189
args = ["--is-enabled"]
1059
1190
with self.assertParseError():
1060
self.check_option_syntax(options)
1191
self.parse_args(args)
1061
1192
1062
1193
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"]
1194
args = ["--is-enabled", "client1", "client2"]
1066
1195
with self.assertParseError():
1067
self.check_option_syntax(options)
1196
self.parse_args(args)
1068
1197
1069
1198
def test_remove_can_only_be_combined_with_action_deny(self):
1070
1199
for action, value in self.actions.items():
1071
if action in {"remove", "deny"}:
1200
if action in {"--remove", "--deny"}:
1072
1201
continue
1073
options = self.parser.parse_args()
1074
setattr(options, action, value)
1075
options.all = True
1076
options.remove = True
1202
args = self.actionargs(action, value, "--all",
1203
"--remove")
1077
1204
with self.assertParseError():
1078
self.check_option_syntax(options)
1079
1080
1081
class Test_get_mandos_dbus_object(TestCaseWithAssertLogs):
1082
def test_calls_and_returns_get_object_on_bus(self):
1083
class MockBus(object):
1084
called = False
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
1091
return mockbus_self
1092
1093
mockbus = get_mandos_dbus_object(bus=MockBus())
1094
self.assertIsInstance(mockbus, MockBus)
1095
self.assertTrue(mockbus.called)
1096
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")
1101
1102
with self.assertLogs(log, logging.CRITICAL):
1103
with self.assertRaises(SystemExit) as e:
1104
bus = get_mandos_dbus_object(bus=MockBusFailing())
1105
1106
if isinstance(e.exception.code, int):
1107
self.assertNotEqual(0, e.exception.code)
1108
else:
1109
self.assertIsNotNone(e.exception.code)
1110
1111
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)
1120
1121
def test_logs_and_exits_on_dbus_error(self):
1205
self.parse_args(args)
1206
1207
1208
class Test_dbus_exceptions(unittest.TestCase):
1209
1210
def test_dbus_ConnectFailed_is_Error(self):
1211
with self.assertRaises(dbus.Error):
1212
raise dbus.ConnectFailed()
1213
1214
1215
class Test_dbus_MandosBus(unittest.TestCase):
1216
1217
class MockMandosBus(dbus.MandosBus):
1218
def __init__(self):
1219
self._name = "se.recompile.Mandos"
1220
self._server_path = "/"
1221
self._server_interface = "se.recompile.Mandos"
1222
self._client_interface = "se.recompile.Mandos.Client"
1223
self.calls = []
1224
self.call_method_return = Unique()
1225
1226
def call_method(self, methodname, busname, objectpath,
1227
interface, *args):
1228
self.calls.append((methodname, busname, objectpath,
1229
interface, args))
1230
return self.call_method_return
1231
1232
def setUp(self):
1233
self.bus = self.MockMandosBus()
1234
1235
def test_set_client_property(self):
1236
self.bus.set_client_property("objectpath", "key", "value")
1237
expected_call = ("Set", self.bus._name, "objectpath",
1238
"org.freedesktop.DBus.Properties",
1239
(self.bus._client_interface, "key", "value"))
1240
self.assertIn(expected_call, self.bus.calls)
1241
1242
def test_call_client_method(self):
1243
ret = self.bus.call_client_method("objectpath", "methodname")
1244
self.assertIs(self.bus.call_method_return, ret)
1245
expected_call = ("methodname", self.bus._name, "objectpath",
1246
self.bus._client_interface, ())
1247
self.assertIn(expected_call, self.bus.calls)
1248
1249
def test_call_client_method_with_args(self):
1250
args = (Unique(), Unique())
1251
ret = self.bus.call_client_method("objectpath", "methodname",
1252
*args)
1253
self.assertIs(self.bus.call_method_return, ret)
1254
expected_call = ("methodname", self.bus._name, "objectpath",
1255
self.bus._client_interface,
1256
(args[0], args[1]))
1257
self.assertIn(expected_call, self.bus.calls)
1258
1259
def test_get_clients_and_properties(self):
1260
managed_objects = {
1261
"objectpath": {
1262
self.bus._client_interface: {
1263
"key": "value",
1264
"bool": True,
1265
},
1266
"irrelevant_interface": {
1267
"key": "othervalue",
1268
"bool": False,
1269
},
1270
},
1271
"other_objectpath": {
1272
"other_irrelevant_interface": {
1273
"key": "value 3",
1274
"bool": None,
1275
},
1276
},
1277
}
1278
expected_clients_and_properties = {
1279
"objectpath": {
1280
"key": "value",
1281
"bool": True,
1282
}
1283
}
1284
self.bus.call_method_return = managed_objects
1285
ret = self.bus.get_clients_and_properties()
1286
self.assertDictEqual(expected_clients_and_properties, ret)
1287
expected_call = ("GetManagedObjects", self.bus._name,
1288
self.bus._server_path,
1289
"org.freedesktop.DBus.ObjectManager", ())
1290
self.assertIn(expected_call, self.bus.calls)
1291
1292
def test_call_server_method(self):
1293
ret = self.bus.call_server_method("methodname")
1294
self.assertIs(self.bus.call_method_return, ret)
1295
expected_call = ("methodname", self.bus._name,
1296
self.bus._server_path,
1297
self.bus._server_interface, ())
1298
self.assertIn(expected_call, self.bus.calls)
1299
1300
def test_call_server_method_with_args(self):
1301
args = (Unique(), Unique())
1302
ret = self.bus.call_server_method("methodname", *args)
1303
self.assertIs(self.bus.call_method_return, ret)
1304
expected_call = ("methodname", self.bus._name,
1305
self.bus._server_path,
1306
self.bus._server_interface,
1307
(args[0], args[1]))
1308
self.assertIn(expected_call, self.bus.calls)
1309
1310
1311
class Test_dbus_python_adapter_SystemBus(TestCaseWithAssertLogs):
1312
1313
def MockDBusPython_func(self, func):
1314
class mock_dbus_python(object):
1315
"""mock dbus-python module"""
1316
class exceptions(object):
1317
"""Pseudo-namespace"""
1318
class DBusException(Exception):
1319
pass
1320
class SystemBus(object):
1321
@staticmethod
1322
def get_object(busname, objectpath):
1323
DBusObject = collections.namedtuple(
1324
"DBusObject", ("methodname", "Set"))
1325
def method(*args, **kwargs):
1326
self.assertEqual({"dbus_interface":
1327
"interface"},
1328
kwargs)
1329
return func(*args)
1330
def set_property(interface, key, value,
1331
dbus_interface=None):
1332
self.assertEqual(
1333
"org.freedesktop.DBus.Properties",
1334
dbus_interface)
1335
self.assertEqual("Secret", key)
1336
return func(interface, key, value,
1337
dbus_interface=dbus_interface)
1338
return DBusObject(methodname=method,
1339
Set=set_property)
1340
class Boolean(object):
1341
def __init__(self, value):
1342
self.value = bool(value)
1343
def __bool__(self):
1344
return self.value
1345
if sys.version_info.major == 2:
1346
__nonzero__ = __bool__
1347
class ObjectPath(str):
1348
pass
1349
class Dictionary(dict):
1350
pass
1351
class ByteArray(bytes):
1352
pass
1353
return mock_dbus_python
1354
1355
def call_method(self, bus, methodname, busname, objectpath,
1356
interface, *args):
1357
with self.assertLogs(log, logging.DEBUG):
1358
return bus.call_method(methodname, busname, objectpath,
1359
interface, *args)
1360
1361
def test_call_method_returns(self):
1362
expected_method_return = Unique()
1363
method_args = (Unique(), Unique())
1364
def func(*args):
1365
self.assertEqual(len(method_args), len(args))
1366
for marg, arg in zip(method_args, args):
1367
self.assertIs(marg, arg)
1368
return expected_method_return
1369
mock_dbus_python = self.MockDBusPython_func(func)
1370
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1371
ret = self.call_method(bus, "methodname", "busname",
1372
"objectpath", "interface",
1373
*method_args)
1374
self.assertIs(ret, expected_method_return)
1375
1376
def test_call_method_filters_bool_true(self):
1377
def func():
1378
return method_return
1379
mock_dbus_python = self.MockDBusPython_func(func)
1380
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1381
method_return = mock_dbus_python.Boolean(True)
1382
ret = self.call_method(bus, "methodname", "busname",
1383
"objectpath", "interface")
1384
self.assertTrue(ret)
1385
self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1386
1387
def test_call_method_filters_bool_false(self):
1388
def func():
1389
return method_return
1390
mock_dbus_python = self.MockDBusPython_func(func)
1391
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1392
method_return = mock_dbus_python.Boolean(False)
1393
ret = self.call_method(bus, "methodname", "busname",
1394
"objectpath", "interface")
1395
self.assertFalse(ret)
1396
self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1397
1398
def test_call_method_filters_objectpath(self):
1399
def func():
1400
return method_return
1401
mock_dbus_python = self.MockDBusPython_func(func)
1402
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1403
method_return = mock_dbus_python.ObjectPath("objectpath")
1404
ret = self.call_method(bus, "methodname", "busname",
1405
"objectpath", "interface")
1406
self.assertEqual("objectpath", ret)
1407
self.assertIsNot("objectpath", ret)
1408
self.assertNotIsInstance(ret, mock_dbus_python.ObjectPath)
1409
1410
def test_call_method_filters_booleans_in_dict(self):
1411
def func():
1412
return method_return
1413
mock_dbus_python = self.MockDBusPython_func(func)
1414
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1415
method_return = mock_dbus_python.Dictionary(
1416
{mock_dbus_python.Boolean(True):
1417
mock_dbus_python.Boolean(False),
1418
mock_dbus_python.Boolean(False):
1419
mock_dbus_python.Boolean(True)})
1420
ret = self.call_method(bus, "methodname", "busname",
1421
"objectpath", "interface")
1422
expected_method_return = {True: False,
1423
False: True}
1424
self.assertEqual(expected_method_return, ret)
1425
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1426
1427
def test_call_method_filters_objectpaths_in_dict(self):
1428
def func():
1429
return method_return
1430
mock_dbus_python = self.MockDBusPython_func(func)
1431
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1432
method_return = mock_dbus_python.Dictionary(
1433
{mock_dbus_python.ObjectPath("objectpath_key_1"):
1434
mock_dbus_python.ObjectPath("objectpath_value_1"),
1435
mock_dbus_python.ObjectPath("objectpath_key_2"):
1436
mock_dbus_python.ObjectPath("objectpath_value_2")})
1437
ret = self.call_method(bus, "methodname", "busname",
1438
"objectpath", "interface")
1439
expected_method_return = {str(key): str(value)
1440
for key, value in
1441
method_return.items()}
1442
self.assertEqual(expected_method_return, ret)
1443
self.assertIsInstance(ret, dict)
1444
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1445
1446
def test_call_method_filters_dict_in_dict(self):
1447
def func():
1448
return method_return
1449
mock_dbus_python = self.MockDBusPython_func(func)
1450
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1451
method_return = mock_dbus_python.Dictionary(
1452
{"key1": mock_dbus_python.Dictionary({"key11": "value11",
1453
"key12": "value12"}),
1454
"key2": mock_dbus_python.Dictionary({"key21": "value21",
1455
"key22": "value22"})})
1456
ret = self.call_method(bus, "methodname", "busname",
1457
"objectpath", "interface")
1458
expected_method_return = {
1459
"key1": {"key11": "value11",
1460
"key12": "value12"},
1461
"key2": {"key21": "value21",
1462
"key22": "value22"},
1463
}
1464
self.assertEqual(expected_method_return, ret)
1465
self.assertIsInstance(ret, dict)
1466
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1467
for key, value in ret.items():
1468
self.assertIsInstance(value, dict)
1469
self.assertEqual(expected_method_return[key], value)
1470
self.assertNotIsInstance(value,
1471
mock_dbus_python.Dictionary)
1472
1473
def test_call_method_filters_dict_three_deep(self):
1474
def func():
1475
return method_return
1476
mock_dbus_python = self.MockDBusPython_func(func)
1477
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1478
method_return = mock_dbus_python.Dictionary(
1479
{"key1":
1480
mock_dbus_python.Dictionary(
1481
{"key2":
1482
mock_dbus_python.Dictionary(
1483
{"key3":
1484
mock_dbus_python.Boolean(True),
1485
}),
1486
}),
1487
})
1488
ret = self.call_method(bus, "methodname", "busname",
1489
"objectpath", "interface")
1490
expected_method_return = {"key1": {"key2": {"key3": True}}}
1491
self.assertEqual(expected_method_return, ret)
1492
self.assertIsInstance(ret, dict)
1493
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1494
self.assertIsInstance(ret["key1"], dict)
1495
self.assertNotIsInstance(ret["key1"],
1496
mock_dbus_python.Dictionary)
1497
self.assertIsInstance(ret["key1"]["key2"], dict)
1498
self.assertNotIsInstance(ret["key1"]["key2"],
1499
mock_dbus_python.Dictionary)
1500
self.assertTrue(ret["key1"]["key2"]["key3"])
1501
self.assertNotIsInstance(ret["key1"]["key2"]["key3"],
1502
mock_dbus_python.Boolean)
1503
1504
def test_call_method_handles_exception(self):
1122
1505
dbus_logger = logging.getLogger("dbus.proxies")
1123
1506
1124
class MockObjectManagerFailing(object):
1125
def GetManagedObjects(self):
1126
dbus_logger.error("Test")
1127
raise dbus.exceptions.DBusException("Test")
1507
def func():
1508
dbus_logger.error("Test")
1509
raise mock_dbus_python.exceptions.DBusException()
1510
1511
mock_dbus_python = self.MockDBusPython_func(func)
1512
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1128
1513
1129
1514
class CountingHandler(logging.Handler):
1130
1515
count = 0
1136
1521
dbus_logger.addHandler(counting_handler)
1137
1522
1138
1523
try:
1139
with self.assertLogs(log, logging.CRITICAL) as watcher:
1140
with self.assertRaises(SystemExit) as e:
1141
get_managed_objects(MockObjectManagerFailing())
1524
with self.assertRaises(dbus.Error) as e:
1525
self.call_method(bus, "methodname", "busname",
1526
"objectpath", "interface")
1142
1527
finally:
1143
1528
dbus_logger.removeFilter(counting_handler)
1144
1529
1530
self.assertNotIsInstance(e, dbus.ConnectFailed)
1531
1145
1532
# Make sure the dbus logger was suppressed
1146
1533
self.assertEqual(0, counting_handler.count)
1147
1534
1148
# Test that the dbus_logger still works
1149
with self.assertLogs(dbus_logger, logging.ERROR):
1150
dbus_logger.error("Test")
1151
1152
if isinstance(e.exception.code, int):
1153
self.assertNotEqual(0, e.exception.code)
1154
else:
1155
self.assertIsNotNone(e.exception.code)
1535
def test_Set_Secret_sends_bytearray(self):
1536
ret = [None]
1537
def func(*args, **kwargs):
1538
ret[0] = (args, kwargs)
1539
mock_dbus_python = self.MockDBusPython_func(func)
1540
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1541
bus.set_client_property("objectpath", "Secret", "value")
1542
expected_call = (("se.recompile.Mandos.Client", "Secret",
1543
mock_dbus_python.ByteArray(b"value")),
1544
{"dbus_interface":
1545
"org.freedesktop.DBus.Properties"})
1546
self.assertEqual(expected_call, ret[0])
1547
if sys.version_info.major == 2:
1548
self.assertIsInstance(ret[0][0][-1],
1549
mock_dbus_python.ByteArray)
1550
1551
def test_get_object_converts_to_correct_exception(self):
1552
bus = dbus_python_adapter.SystemBus(
1553
self.fake_dbus_python_raises_exception_on_connect)
1554
with self.assertRaises(dbus.ConnectFailed):
1555
self.call_method(bus, "methodname", "busname",
1556
"objectpath", "interface")
1557
1558
class fake_dbus_python_raises_exception_on_connect(object):
1559
"""fake dbus-python module"""
1560
class exceptions(object):
1561
"""Pseudo-namespace"""
1562
class DBusException(Exception):
1563
pass
1564
1565
@classmethod
1566
def SystemBus(cls):
1567
def get_object(busname, objectpath):
1568
raise cls.exceptions.DBusException()
1569
Bus = collections.namedtuple("Bus", ["get_object"])
1570
return Bus(get_object=get_object)
1571
1572
1573
class Test_dbus_python_adapter_CachingBus(unittest.TestCase):
1574
class mock_dbus_python(object):
1575
"""mock dbus-python modules"""
1576
class SystemBus(object):
1577
@staticmethod
1578
def get_object(busname, objectpath):
1579
return Unique()
1580
1581
def setUp(self):
1582
self.bus = dbus_python_adapter.CachingBus(
1583
self.mock_dbus_python)
1584
1585
def test_returns_distinct_objectpaths(self):
1586
obj1 = self.bus.get_object("busname", "objectpath1")
1587
self.assertIsInstance(obj1, Unique)
1588
obj2 = self.bus.get_object("busname", "objectpath2")
1589
self.assertIsInstance(obj2, Unique)
1590
self.assertIsNot(obj1, obj2)
1591
1592
def test_returns_distinct_busnames(self):
1593
obj1 = self.bus.get_object("busname1", "objectpath")
1594
self.assertIsInstance(obj1, Unique)
1595
obj2 = self.bus.get_object("busname2", "objectpath")
1596
self.assertIsInstance(obj2, Unique)
1597
self.assertIsNot(obj1, obj2)
1598
1599
def test_returns_distinct_both(self):
1600
obj1 = self.bus.get_object("busname1", "objectpath")
1601
self.assertIsInstance(obj1, Unique)
1602
obj2 = self.bus.get_object("busname2", "objectpath")
1603
self.assertIsInstance(obj2, Unique)
1604
self.assertIsNot(obj1, obj2)
1605
1606
def test_returns_same(self):
1607
obj1 = self.bus.get_object("busname", "objectpath")
1608
self.assertIsInstance(obj1, Unique)
1609
obj2 = self.bus.get_object("busname", "objectpath")
1610
self.assertIsInstance(obj2, Unique)
1611
self.assertIs(obj1, obj2)
1612
1613
def test_returns_same_old(self):
1614
obj1 = self.bus.get_object("busname1", "objectpath1")
1615
self.assertIsInstance(obj1, Unique)
1616
obj2 = self.bus.get_object("busname2", "objectpath2")
1617
self.assertIsInstance(obj2, Unique)
1618
obj1b = self.bus.get_object("busname1", "objectpath1")
1619
self.assertIsInstance(obj1b, Unique)
1620
self.assertIsNot(obj1, obj2)
1621
self.assertIsNot(obj2, obj1b)
1622
self.assertIs(obj1, obj1b)
1623
1624
1625
class Test_pydbus_adapter_SystemBus(TestCaseWithAssertLogs):
1626
1627
def Stub_pydbus_func(self, func):
1628
class stub_pydbus(object):
1629
"""stub pydbus module"""
1630
class SystemBus(object):
1631
@staticmethod
1632
def get(busname, objectpath):
1633
DBusObject = collections.namedtuple(
1634
"DBusObject", ("methodname",))
1635
return {"interface":
1636
DBusObject(methodname=func)}
1637
return stub_pydbus
1638
1639
def call_method(self, bus, methodname, busname, objectpath,
1640
interface, *args):
1641
with self.assertLogs(log, logging.DEBUG):
1642
return bus.call_method(methodname, busname, objectpath,
1643
interface, *args)
1644
1645
def test_call_method_returns(self):
1646
expected_method_return = Unique()
1647
method_args = (Unique(), Unique())
1648
def func(*args):
1649
self.assertEqual(len(method_args), len(args))
1650
for marg, arg in zip(method_args, args):
1651
self.assertIs(marg, arg)
1652
return expected_method_return
1653
stub_pydbus = self.Stub_pydbus_func(func)
1654
bus = pydbus_adapter.SystemBus(stub_pydbus)
1655
ret = self.call_method(bus, "methodname", "busname",
1656
"objectpath", "interface",
1657
*method_args)
1658
self.assertIs(ret, expected_method_return)
1659
1660
def test_call_method_handles_exception(self):
1661
dbus_logger = logging.getLogger("dbus.proxies")
1662
1663
def func():
1664
raise gi.repository.GLib.Error()
1665
1666
stub_pydbus = self.Stub_pydbus_func(func)
1667
bus = pydbus_adapter.SystemBus(stub_pydbus)
1668
1669
with self.assertRaises(dbus.Error) as e:
1670
self.call_method(bus, "methodname", "busname",
1671
"objectpath", "interface")
1672
1673
self.assertNotIsInstance(e, dbus.ConnectFailed)
1674
1675
def test_get_converts_to_correct_exception(self):
1676
bus = pydbus_adapter.SystemBus(
1677
self.fake_pydbus_raises_exception_on_connect)
1678
with self.assertRaises(dbus.ConnectFailed):
1679
self.call_method(bus, "methodname", "busname",
1680
"objectpath", "interface")
1681
1682
class fake_pydbus_raises_exception_on_connect(object):
1683
"""fake dbus-python module"""
1684
@classmethod
1685
def SystemBus(cls):
1686
def get(busname, objectpath):
1687
raise gi.repository.GLib.Error()
1688
Bus = collections.namedtuple("Bus", ["get"])
1689
return Bus(get=get)
1690
1691
def test_set_property_uses_setattr(self):
1692
class Object(object):
1693
pass
1694
obj = Object()
1695
class pydbus_spy(object):
1696
class SystemBus(object):
1697
@staticmethod
1698
def get(busname, objectpath):
1699
return {"interface": obj}
1700
bus = pydbus_adapter.SystemBus(pydbus_spy)
1701
value = Unique()
1702
bus.set_property("busname", "objectpath", "interface", "key",
1703
value)
1704
self.assertIs(value, obj.key)
1705
1706
def test_get_suppresses_xml_deprecation_warning(self):
1707
if sys.version_info.major >= 3:
1708
return
1709
class stub_pydbus_get(object):
1710
class SystemBus(object):
1711
@staticmethod
1712
def get(busname, objectpath):
1713
warnings.warn_explicit(
1714
"deprecated", DeprecationWarning,
1715
"xml.etree.ElementTree", 0)
1716
bus = pydbus_adapter.SystemBus(stub_pydbus_get)
1717
with warnings.catch_warnings(record=True) as w:
1718
warnings.simplefilter("always")
1719
bus.get("busname", "objectpath")
1720
self.assertEqual(0, len(w))
1721
1722
1723
class Test_pydbus_adapter_CachingBus(unittest.TestCase):
1724
class stub_pydbus(object):
1725
"""stub pydbus module"""
1726
class SystemBus(object):
1727
@staticmethod
1728
def get(busname, objectpath):
1729
return Unique()
1730
1731
def setUp(self):
1732
self.bus = pydbus_adapter.CachingBus(self.stub_pydbus)
1733
1734
def test_returns_distinct_objectpaths(self):
1735
obj1 = self.bus.get("busname", "objectpath1")
1736
self.assertIsInstance(obj1, Unique)
1737
obj2 = self.bus.get("busname", "objectpath2")
1738
self.assertIsInstance(obj2, Unique)
1739
self.assertIsNot(obj1, obj2)
1740
1741
def test_returns_distinct_busnames(self):
1742
obj1 = self.bus.get("busname1", "objectpath")
1743
self.assertIsInstance(obj1, Unique)
1744
obj2 = self.bus.get("busname2", "objectpath")
1745
self.assertIsInstance(obj2, Unique)
1746
self.assertIsNot(obj1, obj2)
1747
1748
def test_returns_distinct_both(self):
1749
obj1 = self.bus.get("busname1", "objectpath")
1750
self.assertIsInstance(obj1, Unique)
1751
obj2 = self.bus.get("busname2", "objectpath")
1752
self.assertIsInstance(obj2, Unique)
1753
self.assertIsNot(obj1, obj2)
1754
1755
def test_returns_same(self):
1756
obj1 = self.bus.get("busname", "objectpath")
1757
self.assertIsInstance(obj1, Unique)
1758
obj2 = self.bus.get("busname", "objectpath")
1759
self.assertIsInstance(obj2, Unique)
1760
self.assertIs(obj1, obj2)
1761
1762
def test_returns_same_old(self):
1763
obj1 = self.bus.get("busname1", "objectpath1")
1764
self.assertIsInstance(obj1, Unique)
1765
obj2 = self.bus.get("busname2", "objectpath2")
1766
self.assertIsInstance(obj2, Unique)
1767
obj1b = self.bus.get("busname1", "objectpath1")
1768
self.assertIsInstance(obj1b, Unique)
1769
self.assertIsNot(obj1, obj2)
1770
self.assertIsNot(obj2, obj1b)
1771
self.assertIs(obj1, obj1b)
1156
1772
1157
1773
1158
1774
class Test_commands_from_options(unittest.TestCase):
1775
1159
1776
def setUp(self):
1160
1777
self.parser = argparse.ArgumentParser()
1161
1778
add_command_line_options(self.parser)
1162
1779
1163
1780
def test_is_enabled(self):
1164
self.assert_command_from_args(["--is-enabled", "foo"],
1781
self.assert_command_from_args(["--is-enabled", "client"],
1165
1782
command.IsEnabled)
1166
1783
1167
def assert_command_from_args(self, args, command_cls,
1168
**cmd_attrs):
1784
def assert_command_from_args(self, args, command_cls, length=1,
1785
clients=None, **cmd_attrs):
1169
1786
"""Assert that parsing ARGS should result in an instance of
1170
1787
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
1171
1788
options = self.parser.parse_args(args)
1172
1789
check_option_syntax(self.parser, options)
1173
1790
commands = commands_from_options(options)
1174
self.assertEqual(1, len(commands))
1175
command = commands[0]
1176
self.assertIsInstance(command, command_cls)
1791
self.assertEqual(length, len(commands))
1792
for command in commands:
1793
if isinstance(command, command_cls):
1794
break
1795
else:
1796
self.assertIsInstance(command, command_cls)
1797
if clients is not None:
1798
self.assertEqual(clients, options.client)
1177
1799
for key, value in cmd_attrs.items():
1178
1800
self.assertEqual(value, getattr(command, key))
1179
1801
1802
def assert_commands_from_args(self, args, commands, clients=None):
1803
for cmd in commands:
1804
self.assert_command_from_args(args, cmd,
1805
length=len(commands),
1806
clients=clients)
1807
1180
1808
def test_is_enabled_short(self):
1181
self.assert_command_from_args(["-V", "foo"],
1809
self.assert_command_from_args(["-V", "client"],
1182
1810
command.IsEnabled)
1183
1811
1184
1812
def test_approve(self):
1185
self.assert_command_from_args(["--approve", "foo"],
1813
self.assert_command_from_args(["--approve", "client"],
1186
1814
command.Approve)
1187
1815
1188
1816
def test_approve_short(self):
1189
self.assert_command_from_args(["-A", "foo"], command.Approve)
1817
self.assert_command_from_args(["-A", "client"],
1818
command.Approve)
1190
1819
1191
1820
def test_deny(self):
1192
self.assert_command_from_args(["--deny", "foo"], command.Deny)
1821
self.assert_command_from_args(["--deny", "client"],
1822
command.Deny)
1193
1823
1194
1824
def test_deny_short(self):
1195
self.assert_command_from_args(["-D", "foo"], command.Deny)
1825
self.assert_command_from_args(["-D", "client"], command.Deny)
1196
1826
1197
1827
def test_remove(self):
1198
self.assert_command_from_args(["--remove", "foo"],
1828
self.assert_command_from_args(["--remove", "client"],
1199
1829
command.Remove)
1200
1830
1201
1831
def test_deny_before_remove(self):
1202
1832
options = self.parser.parse_args(["--deny", "--remove",
1203
"foo"])
1833
"client"])
1204
1834
check_option_syntax(self.parser, options)
1205
1835
commands = commands_from_options(options)
1206
1836
self.assertEqual(2, len(commands))
1217
1847
self.assertIsInstance(commands[1], command.Remove)
1218
1848
1219
1849
def test_remove_short(self):
1220
self.assert_command_from_args(["-r", "foo"], command.Remove)
1850
self.assert_command_from_args(["-r", "client"],
1851
command.Remove)
1221
1852
1222
1853
def test_dump_json(self):
1223
1854
self.assert_command_from_args(["--dump-json"],
1224
1855
command.DumpJSON)
1225
1856
1226
1857
def test_enable(self):
1227
self.assert_command_from_args(["--enable", "foo"],
1858
self.assert_command_from_args(["--enable", "client"],
1228
1859
command.Enable)
1229
1860
1230
1861
def test_enable_short(self):
1231
self.assert_command_from_args(["-e", "foo"], command.Enable)
1862
self.assert_command_from_args(["-e", "client"],
1863
command.Enable)
1232
1864
1233
1865
def test_disable(self):
1234
self.assert_command_from_args(["--disable", "foo"],
1866
self.assert_command_from_args(["--disable", "client"],
1235
1867
command.Disable)
1236
1868
1237
1869
def test_disable_short(self):
1238
self.assert_command_from_args(["-d", "foo"], command.Disable)
1870
self.assert_command_from_args(["-d", "client"],
1871
command.Disable)
1239
1872
1240
1873
def test_bump_timeout(self):
1241
self.assert_command_from_args(["--bump-timeout", "foo"],
1874
self.assert_command_from_args(["--bump-timeout", "client"],
1242
1875
command.BumpTimeout)
1243
1876
1244
1877
def test_bump_timeout_short(self):
1245
self.assert_command_from_args(["-b", "foo"],
1878
self.assert_command_from_args(["-b", "client"],
1246
1879
command.BumpTimeout)
1247
1880
1248
1881
def test_start_checker(self):
1249
self.assert_command_from_args(["--start-checker", "foo"],
1882
self.assert_command_from_args(["--start-checker", "client"],
1250
1883
command.StartChecker)
1251
1884
1252
1885
def test_stop_checker(self):
1253
self.assert_command_from_args(["--stop-checker", "foo"],
1886
self.assert_command_from_args(["--stop-checker", "client"],
1254
1887
command.StopChecker)
1255
1888
1256
1889
def test_approve_by_default(self):
1257
self.assert_command_from_args(["--approve-by-default", "foo"],
1890
self.assert_command_from_args(["--approve-by-default",
1891
"client"],
1258
1892
command.ApproveByDefault)
1259
1893
1260
1894
def test_deny_by_default(self):
1261
self.assert_command_from_args(["--deny-by-default", "foo"],
1895
self.assert_command_from_args(["--deny-by-default", "client"],
1262
1896
command.DenyByDefault)
1263
1897
1264
1898
def test_checker(self):
1265
self.assert_command_from_args(["--checker", ":", "foo"],
1899
self.assert_command_from_args(["--checker", ":", "client"],
1266
1900
command.SetChecker,
1267
1901
value_to_set=":")
1268
1902
1269
1903
def test_checker_empty(self):
1270
self.assert_command_from_args(["--checker", "", "foo"],
1904
self.assert_command_from_args(["--checker", "", "client"],
1271
1905
command.SetChecker,
1272
1906
value_to_set="")
1273
1907
1274
1908
def test_checker_short(self):
1275
self.assert_command_from_args(["-c", ":", "foo"],
1909
self.assert_command_from_args(["-c", ":", "client"],
1276
1910
command.SetChecker,
1277
1911
value_to_set=":")
1278
1912
1279
1913
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")
1914
self.assert_command_from_args(
1915
["--host", "client.example.org", "client"],
1916
command.SetHost, value_to_set="client.example.org")
1283
1917
1284
1918
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")
1919
self.assert_command_from_args(
1920
["-H", "client.example.org", "client"], command.SetHost,
1921
value_to_set="client.example.org")
1288
1922
1289
1923
def test_secret_devnull(self):
1290
1924
self.assert_command_from_args(["--secret", os.path.devnull,
1291
"foo"], command.SetSecret,
1925
"client"], command.SetSecret,
1292
1926
value_to_set=b"")
1293
1927
1294
1928
def test_secret_tempfile(self):
1297
1931
f.write(value)
1298
1932
f.seek(0)
1299
1933
self.assert_command_from_args(["--secret", f.name,
1300
"foo"], command.SetSecret,
1934
"client"],
1935
command.SetSecret,
1301
1936
value_to_set=value)
1302
1937
1303
1938
def test_secret_devnull_short(self):
1304
self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1305
command.SetSecret,
1939
self.assert_command_from_args(["-s", os.path.devnull,
1940
"client"], command.SetSecret,
1306
1941
value_to_set=b"")
1307
1942
1308
1943
def test_secret_tempfile_short(self):
1310
1945
value = b"secret\0xyzzy\nbar"
1311
1946
f.write(value)
1312
1947
f.seek(0)
1313
self.assert_command_from_args(["-s", f.name, "foo"],
1948
self.assert_command_from_args(["-s", f.name, "client"],
1314
1949
command.SetSecret,
1315
1950
value_to_set=value)
1316
1951
1317
1952
def test_timeout(self):
1318
self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1953
self.assert_command_from_args(["--timeout", "PT5M", "client"],
1319
1954
command.SetTimeout,
1320
1955
value_to_set=300000)
1321
1956
1322
1957
def test_timeout_short(self):
1323
self.assert_command_from_args(["-t", "PT5M", "foo"],
1958
self.assert_command_from_args(["-t", "PT5M", "client"],
1324
1959
command.SetTimeout,
1325
1960
value_to_set=300000)
1326
1961
1327
1962
def test_extended_timeout(self):
1328
1963
self.assert_command_from_args(["--extended-timeout", "PT15M",
1329
"foo"],
1964
"client"],
1330
1965
command.SetExtendedTimeout,
1331
1966
value_to_set=900000)
1332
1967
1333
1968
def test_interval(self):
1334
self.assert_command_from_args(["--interval", "PT2M", "foo"],
1335
command.SetInterval,
1969
self.assert_command_from_args(["--interval", "PT2M",
1970
"client"], command.SetInterval,
1336
1971
value_to_set=120000)
1337
1972
1338
1973
def test_interval_short(self):
1339
self.assert_command_from_args(["-i", "PT2M", "foo"],
1974
self.assert_command_from_args(["-i", "PT2M", "client"],
1340
1975
command.SetInterval,
1341
1976
value_to_set=120000)
1342
1977
1343
1978
def test_approval_delay(self):
1344
1979
self.assert_command_from_args(["--approval-delay", "PT30S",
1345
"foo"],
1980
"client"],
1346
1981
command.SetApprovalDelay,
1347
1982
value_to_set=30000)
1348
1983
1349
1984
def test_approval_duration(self):
1350
1985
self.assert_command_from_args(["--approval-duration", "PT1S",
1351
"foo"],
1986
"client"],
1352
1987
command.SetApprovalDuration,
1353
1988
value_to_set=1000)
1354
1989
1366
2001
verbose=True)
1367
2002
1368
2003
2004
def test_manual_page_example_1(self):
2005
self.assert_command_from_args("",
2006
command.PrintTable,
2007
clients=[],
2008
verbose=False)
2009
2010
def test_manual_page_example_2(self):
2011
self.assert_command_from_args(
2012
"--verbose foo1.example.org foo2.example.org".split(),
2013
command.PrintTable, clients=["foo1.example.org",
2014
"foo2.example.org"],
2015
verbose=True)
2016
2017
def test_manual_page_example_3(self):
2018
self.assert_command_from_args("--enable --all".split(),
2019
command.Enable,
2020
clients=[])
2021
2022
def test_manual_page_example_4(self):
2023
self.assert_commands_from_args(
2024
("--timeout=PT5M --interval=PT1M foo1.example.org"
2025
" foo2.example.org").split(),
2026
[command.SetTimeout, command.SetInterval],
2027
clients=["foo1.example.org", "foo2.example.org"])
2028
2029
def test_manual_page_example_5(self):
2030
self.assert_command_from_args("--approve --all".split(),
2031
command.Approve,
2032
clients=[])
2033
2034
1369
2035
class TestCommand(unittest.TestCase):
1370
2036
"""Abstract class for tests of command classes"""
1371
2037
2038
class FakeMandosBus(dbus.MandosBus):
2039
def __init__(self, testcase):
2040
self.client_properties = {
2041
"Name": "foo",
2042
"KeyID": ("92ed150794387c03ce684574b1139a65"
2043
"94a34f895daaaf09fd8ea90a27cddb12"),
2044
"Secret": b"secret",
2045
"Host": "foo.example.org",
2046
"Enabled": True,
2047
"Timeout": 300000,
2048
"LastCheckedOK": "2019-02-03T00:00:00",
2049
"Created": "2019-01-02T00:00:00",
2050
"Interval": 120000,
2051
"Fingerprint": ("778827225BA7DE539C5A"
2052
"7CFA59CFF7CDBD9A5920"),
2053
"CheckerRunning": False,
2054
"LastEnabled": "2019-01-03T00:00:00",
2055
"ApprovalPending": False,
2056
"ApprovedByDefault": True,
2057
"LastApprovalRequest": "",
2058
"ApprovalDelay": 0,
2059
"ApprovalDuration": 1000,
2060
"Checker": "fping -q -- %(host)s",
2061
"ExtendedTimeout": 900000,
2062
"Expires": "2019-02-04T00:00:00",
2063
"LastCheckerStatus": 0,
2064
}
2065
self.other_client_properties = {
2066
"Name": "barbar",
2067
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
2068
"6ab612cff5ad227247e46c2b020f441c"),
2069
"Secret": b"secretbar",
2070
"Host": "192.0.2.3",
2071
"Enabled": True,
2072
"Timeout": 300000,
2073
"LastCheckedOK": "2019-02-04T00:00:00",
2074
"Created": "2019-01-03T00:00:00",
2075
"Interval": 120000,
2076
"Fingerprint": ("3E393AEAEFB84C7E89E2"
2077
"F547B3A107558FCA3A27"),
2078
"CheckerRunning": True,
2079
"LastEnabled": "2019-01-04T00:00:00",
2080
"ApprovalPending": False,
2081
"ApprovedByDefault": False,
2082
"LastApprovalRequest": "2019-01-03T00:00:00",
2083
"ApprovalDelay": 30000,
2084
"ApprovalDuration": 93785000,
2085
"Checker": ":",
2086
"ExtendedTimeout": 900000,
2087
"Expires": "2019-02-05T00:00:00",
2088
"LastCheckerStatus": -2,
2089
}
2090
self.clients = collections.OrderedDict(
2091
[
2092
("client_objectpath", self.client_properties),
2093
("other_client_objectpath",
2094
self.other_client_properties),
2095
])
2096
self.one_client = {"client_objectpath":
2097
self.client_properties}
2098
self.testcase = testcase
2099
self.calls = []
2100
2101
def call_method(self, methodname, busname, objectpath,
2102
interface, *args):
2103
self.testcase.assertEqual("se.recompile.Mandos", busname)
2104
self.calls.append((methodname, busname, objectpath,
2105
interface, args))
2106
if interface == "org.freedesktop.DBus.Properties":
2107
if methodname == "Set":
2108
self.testcase.assertEqual(3, len(args))
2109
interface, key, value = args
2110
self.testcase.assertEqual(
2111
"se.recompile.Mandos.Client", interface)
2112
self.clients[objectpath][key] = value
2113
return
2114
elif interface == "se.recompile.Mandos":
2115
self.testcase.assertEqual("RemoveClient", methodname)
2116
self.testcase.assertEqual(1, len(args))
2117
clientpath = args[0]
2118
del self.clients[clientpath]
2119
return
2120
elif interface == "se.recompile.Mandos.Client":
2121
if methodname == "Approve":
2122
self.testcase.assertEqual(1, len(args))
2123
return
2124
raise ValueError()
2125
1372
2126
def setUp(self):
1373
testcase = 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
1379
self.calls = []
1380
def Set(self, interface, propname, value, dbus_interface):
1381
testcase.assertEqual(client_dbus_interface, interface)
1382
testcase.assertEqual(dbus.PROPERTIES_IFACE,
1383
dbus_interface)
1384
self.attributes[propname] = value
1385
def Approve(self, approve, dbus_interface):
1386
testcase.assertEqual(client_dbus_interface,
1387
dbus_interface)
1388
self.calls.append(("Approve", (approve,
1389
dbus_interface)))
1390
self.client = MockClient(
1391
"foo",
1392
KeyID=("92ed150794387c03ce684574b1139a65"
1393
"94a34f895daaaf09fd8ea90a27cddb12"),
1394
Secret=b"secret",
1395
Host="foo.example.org",
1396
Enabled=dbus.Boolean(True),
1397
Timeout=300000,
1398
LastCheckedOK="2019-02-03T00:00:00",
1399
Created="2019-01-02T00:00:00",
1400
Interval=120000,
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="",
1408
ApprovalDelay=0,
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(
1415
"barbar",
1416
KeyID=("0558568eedd67d622f5c83b35a115f79"
1417
"6ab612cff5ad227247e46c2b020f441c"),
1418
Secret=b"secretbar",
1419
Host="192.0.2.3",
1420
Enabled=dbus.Boolean(True),
1421
Timeout=300000,
1422
LastCheckedOK="2019-02-04T00:00:00",
1423
Created="2019-01-03T00:00:00",
1424
Interval=120000,
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,
1434
Checker=":",
1435
ExtendedTimeout=900000,
1436
Expires="2019-02-05T00:00:00",
1437
LastCheckerStatus=-2)
1438
self.clients = collections.OrderedDict(
1439
[
1440
("/clients/foo", self.client.attributes),
1441
("/clients/barbar", self.other_client.attributes),
1442
])
1443
self.one_client = {"/clients/foo": self.client.attributes}
1444
1445
@property
1446
def bus(self):
1447
class Bus(object):
1448
@staticmethod
1449
def get_object(client_bus_name, path):
1450
self.assertEqual(dbus_busname, client_bus_name)
1451
return {
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,
1456
}[path]
1457
return Bus()
2127
self.bus = self.FakeMandosBus(self)
1458
2128
1459
2129
1460
2130
class TestBaseCommands(TestCommand):
1461
2131
1462
2132
def test_IsEnabled_exits_successfully(self):
1463
2133
with self.assertRaises(SystemExit) as e:
1464
command.IsEnabled().run(self.one_client)
2134
command.IsEnabled().run(self.bus.one_client)
1465
2135
if e.exception.code is not None:
1466
2136
self.assertEqual(0, e.exception.code)
1467
2137
else:
1468
2138
self.assertIsNone(e.exception.code)
1469
2139
1470
2140
def test_IsEnabled_exits_with_failure(self):
1471
self.client.attributes["Enabled"] = dbus.Boolean(False)
2141
self.bus.client_properties["Enabled"] = False
1472
2142
with self.assertRaises(SystemExit) as e:
1473
command.IsEnabled().run(self.one_client)
2143
command.IsEnabled().run(self.bus.one_client)
1474
2144
if isinstance(e.exception.code, int):
1475
2145
self.assertNotEqual(0, e.exception.code)
1476
2146
else:
1477
2147
self.assertIsNotNone(e.exception.code)
1478
2148
1479
2149
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)),
1484
client.calls)
2150
busname = "se.recompile.Mandos"
2151
client_interface = "se.recompile.Mandos.Client"
2152
command.Approve().run(self.bus.clients, self.bus)
2153
for clientpath in self.bus.clients:
2154
self.assertIn(("Approve", busname, clientpath,
2155
client_interface, (True,)), self.bus.calls)
1485
2156
1486
2157
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)),
1491
client.calls)
2158
busname = "se.recompile.Mandos"
2159
client_interface = "se.recompile.Mandos.Client"
2160
command.Deny().run(self.bus.clients, self.bus)
2161
for clientpath in self.bus.clients:
2162
self.assertIn(("Approve", busname, clientpath,
2163
client_interface, (False,)),
2164
self.bus.calls)
1492
2165
1493
2166
def test_Remove(self):
1494
class MockMandos(object):
1495
def __init__(self):
1496
self.calls = []
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,)),
1503
mandos.calls)
2167
command.Remove().run(self.bus.clients, self.bus)
2168
for clientpath in self.bus.clients:
2169
self.assertIn(("RemoveClient", dbus_busname,
2170
dbus_server_path, dbus_server_interface,
2171
(clientpath,)), self.bus.calls)
1504
2172
1505
2173
expected_json = {
1506
2174
"foo": {
1555
2223
1556
2224
def test_DumpJSON_normal(self):
1557
2225
with self.capture_stdout_to_buffer() as buffer:
1558
command.DumpJSON().run(self.clients)
2226
command.DumpJSON().run(self.bus.clients)
1559
2227
json_data = json.loads(buffer.getvalue())
1560
2228
self.assertDictEqual(self.expected_json, json_data)
1561
2229
1572
2240
1573
2241
def test_DumpJSON_one_client(self):
1574
2242
with self.capture_stdout_to_buffer() as buffer:
1575
command.DumpJSON().run(self.one_client)
2243
command.DumpJSON().run(self.bus.one_client)
1576
2244
json_data = json.loads(buffer.getvalue())
1577
2245
expected_json = {"foo": self.expected_json["foo"]}
1578
2246
self.assertDictEqual(expected_json, json_data)
1579
2247
1580
2248
def test_PrintTable_normal(self):
1581
2249
with self.capture_stdout_to_buffer() as buffer:
1582
command.PrintTable().run(self.clients)
2250
command.PrintTable().run(self.bus.clients)
1583
2251
expected_output = "\n".join((
1584
2252
"Name Enabled Timeout Last Successful Check",
1585
2253
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1589
2257
1590
2258
def test_PrintTable_verbose(self):
1591
2259
with self.capture_stdout_to_buffer() as buffer:
1592
command.PrintTable(verbose=True).run(self.clients)
2260
command.PrintTable(verbose=True).run(self.bus.clients)
1593
2261
columns = (
1594
2262
(
1595
2263
"Name ",
1685
2353
1686
2354
def test_PrintTable_one_client(self):
1687
2355
with self.capture_stdout_to_buffer() as buffer:
1688
command.PrintTable().run(self.one_client)
2356
command.PrintTable().run(self.bus.one_client)
1689
2357
expected_output = "\n".join((
1690
2358
"Name Enabled Timeout Last Successful Check",
1691
2359
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1693
2361
self.assertEqual(expected_output, buffer.getvalue())
1694
2362
1695
2363
1696
class TestPropertyCmd(TestCommand):
1697
"""Abstract class for tests of command.Property classes"""
2364
class TestPropertySetterCmd(TestCommand):
2365
"""Abstract class for tests of command.PropertySetter classes"""
2366
1698
2367
def runTest(self):
1699
2368
if not hasattr(self, "command"):
1700
return
1701
values_to_get = getattr(self, "values_to_get",
1702
self.values_to_set)
1703
for value_to_set, value_to_get in zip(self.values_to_set,
1704
values_to_get):
1705
for clientpath in self.clients:
1706
client = self.bus.get_object(dbus_busname, clientpath)
1707
old_value = client.attributes[self.propname]
1708
client.attributes[self.propname] = self.Unique()
1709
self.run_command(value_to_set, self.clients)
1710
for clientpath in self.clients:
1711
client = self.bus.get_object(dbus_busname, clientpath)
1712
value = client.attributes[self.propname]
1713
self.assertNotIsInstance(value, self.Unique)
2369
return # Abstract TestCase class
2370
2371
if hasattr(self, "values_to_set"):
2372
cmd_args = [(value,) for value in self.values_to_set]
2373
values_to_get = getattr(self, "values_to_get",
2374
self.values_to_set)
2375
else:
2376
cmd_args = [() for x in range(len(self.values_to_get))]
2377
values_to_get = self.values_to_get
2378
for value_to_get, cmd_arg in zip(values_to_get, cmd_args):
2379
for clientpath in self.bus.clients:
2380
self.bus.clients[clientpath][self.propname] = (
2381
Unique())
2382
self.command(*cmd_arg).run(self.bus.clients, self.bus)
2383
for clientpath in self.bus.clients:
2384
value = (self.bus.clients[clientpath]
2385
[self.propname])
2386
self.assertNotIsInstance(value, Unique)
1714
2387
self.assertEqual(value_to_get, value)
1715
2388
1716
class Unique(object):
1717
"""Class for objects which exist only to be unique objects,
1718
since unittest.mock.sentinel only exists in Python 3.3"""
1719
1720
def run_command(self, value, clients):
1721
self.command().run(clients, self.bus)
1722
1723
1724
class TestEnableCmd(TestPropertyCmd):
2389
2390
class TestEnableCmd(TestPropertySetterCmd):
1725
2391
command = command.Enable
1726
2392
propname = "Enabled"
1727
values_to_set = [dbus.Boolean(True)]
1728
1729
1730
class TestDisableCmd(TestPropertyCmd):
2393
values_to_get = [True]
2394
2395
2396
class TestDisableCmd(TestPropertySetterCmd):
1731
2397
command = command.Disable
1732
2398
propname = "Enabled"
1733
values_to_set = [dbus.Boolean(False)]
1734
1735
1736
class TestBumpTimeoutCmd(TestPropertyCmd):
2399
values_to_get = [False]
2400
2401
2402
class TestBumpTimeoutCmd(TestPropertySetterCmd):
1737
2403
command = command.BumpTimeout
1738
2404
propname = "LastCheckedOK"
1739
values_to_set = [""]
1740
1741
1742
class TestStartCheckerCmd(TestPropertyCmd):
2405
values_to_get = [""]
2406
2407
2408
class TestStartCheckerCmd(TestPropertySetterCmd):
1743
2409
command = command.StartChecker
1744
2410
propname = "CheckerRunning"
1745
values_to_set = [dbus.Boolean(True)]
1746
1747
1748
class TestStopCheckerCmd(TestPropertyCmd):
2411
values_to_get = [True]
2412
2413
2414
class TestStopCheckerCmd(TestPropertySetterCmd):
1749
2415
command = command.StopChecker
1750
2416
propname = "CheckerRunning"
1751
values_to_set = [dbus.Boolean(False)]
1752
1753
1754
class TestApproveByDefaultCmd(TestPropertyCmd):
2417
values_to_get = [False]
2418
2419
2420
class TestApproveByDefaultCmd(TestPropertySetterCmd):
1755
2421
command = command.ApproveByDefault
1756
2422
propname = "ApprovedByDefault"
1757
values_to_set = [dbus.Boolean(True)]
1758
1759
1760
class TestDenyByDefaultCmd(TestPropertyCmd):
2423
values_to_get = [True]
2424
2425
2426
class TestDenyByDefaultCmd(TestPropertySetterCmd):
1761
2427
command = command.DenyByDefault
1762
2428
propname = "ApprovedByDefault"
1763
values_to_set = [dbus.Boolean(False)]
1764
1765
1766
class TestPropertyValueCmd(TestPropertyCmd):
1767
"""Abstract class for tests of PropertyValueCmd classes"""
1768
1769
def runTest(self):
1770
if type(self) is TestPropertyValueCmd:
1771
return
1772
return super(TestPropertyValueCmd, self).runTest()
1773
1774
def run_command(self, value, clients):
1775
self.command(value).run(clients, self.bus)
1776
1777
1778
class TestSetCheckerCmd(TestPropertyValueCmd):
2429
values_to_get = [False]
2430
2431
2432
class TestSetCheckerCmd(TestPropertySetterCmd):
1779
2433
command = command.SetChecker
1780
2434
propname = "Checker"
1781
2435
values_to_set = ["", ":", "fping -q -- %s"]
1782
2436
1783
2437
1784
class TestSetHostCmd(TestPropertyValueCmd):
2438
class TestSetHostCmd(TestPropertySetterCmd):
1785
2439
command = command.SetHost
1786
2440
propname = "Host"
1787
values_to_set = ["192.0.2.3", "foo.example.org"]
1788
1789
1790
class TestSetSecretCmd(TestPropertyValueCmd):
2441
values_to_set = ["192.0.2.3", "client.example.org"]
2442
2443
2444
class TestSetSecretCmd(TestPropertySetterCmd):
1791
2445
command = command.SetSecret
1792
2446
propname = "Secret"
1793
2447
values_to_set = [io.BytesIO(b""),
1794
2448
io.BytesIO(b"secret\0xyzzy\nbar")]
1795
values_to_get = [b"", b"secret\0xyzzy\nbar"]
1796
1797
1798
class TestSetTimeoutCmd(TestPropertyValueCmd):
2449
values_to_get = [f.getvalue() for f in values_to_set]
2450
2451
2452
class TestSetTimeoutCmd(TestPropertySetterCmd):
1799
2453
command = command.SetTimeout
1800
2454
propname = "Timeout"
1801
2455
values_to_set = [datetime.timedelta(),
1803
2457
datetime.timedelta(seconds=1),
1804
2458
datetime.timedelta(weeks=1),
1805
2459
datetime.timedelta(weeks=52)]
1806
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1807
1808
1809
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
2460
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2461
2462
2463
class TestSetExtendedTimeoutCmd(TestPropertySetterCmd):
1810
2464
command = command.SetExtendedTimeout
1811
2465
propname = "ExtendedTimeout"
1812
2466
values_to_set = [datetime.timedelta(),
1814
2468
datetime.timedelta(seconds=1),
1815
2469
datetime.timedelta(weeks=1),
1816
2470
datetime.timedelta(weeks=52)]
1817
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1818
1819
1820
class TestSetIntervalCmd(TestPropertyValueCmd):
2471
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2472
2473
2474
class TestSetIntervalCmd(TestPropertySetterCmd):
1821
2475
command = command.SetInterval
1822
2476
propname = "Interval"
1823
2477
values_to_set = [datetime.timedelta(),
1825
2479
datetime.timedelta(seconds=1),
1826
2480
datetime.timedelta(weeks=1),
1827
2481
datetime.timedelta(weeks=52)]
1828
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1829
1830
1831
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
2482
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2483
2484
2485
class TestSetApprovalDelayCmd(TestPropertySetterCmd):
1832
2486
command = command.SetApprovalDelay
1833
2487
propname = "ApprovalDelay"
1834
2488
values_to_set = [datetime.timedelta(),
1836
2490
datetime.timedelta(seconds=1),
1837
2491
datetime.timedelta(weeks=1),
1838
2492
datetime.timedelta(weeks=52)]
1839
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1840
1841
1842
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
2493
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2494
2495
2496
class TestSetApprovalDurationCmd(TestPropertySetterCmd):
1843
2497
command = command.SetApprovalDuration
1844
2498
propname = "ApprovalDuration"
1845
2499
values_to_set = [datetime.timedelta(),
1847
2501
datetime.timedelta(seconds=1),
1848
2502
datetime.timedelta(weeks=1),
1849
2503
datetime.timedelta(weeks=52)]
1850
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
2504
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1851
2505
1852
2506
1853
2507
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0