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