To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/trunk
« back to all changes in this revision
Viewing changes to mandos-ctl
- browse files at revision 1301
- compare with another revision
- download diff
- download tarball
- view history from revision 1301
- Committer: Teddy Hogeborn
- Date: 2024-09-12 02:53:43 UTC
- Revision ID: teddy@recompile.se-20240912025343-05elzcldczplvk89
Ignore some more files
* .bzrignore: Ignore "cl", which is used to temporarily save the
commit message. Ignore the .mypy_cache directories. Ignore
*.c.local files which are used by the tools to sort #include
directives and associated comments.
* .bzrignore: Ignore "cl", which is used to temporarily save the
commit message. Ignore the .mypy_cache directories. Ignore
*.c.local files which are used by the tools to sort #include
directives and associated comments.
- files added:
- debian/mandos.maintscript
- 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*")))); -*-
3
#
4
# Mandos Monitor - Control and monitor the Mandos server
5
#
6
# Copyright © 2008-2019 Teddy Hogeborn
7
# Copyright © 2008-2019 Björn Påhlsson
1
#!/usr/bin/python3 -bbI
2
# -*- coding: utf-8; lexical-binding: t -*-
3
#
4
# Mandos Control - Control or query the Mandos server
5
#
6
# Copyright © 2008-2022 Teddy Hogeborn
7
# Copyright © 2008-2022 Björn Påhlsson
8
8
#
9
9
# This file is part of Mandos.
10
10
#
23
23
#
24
24
# Contact the authors at <mandos@recompile.se>.
25
25
#
26
27
26
from __future__ import (division, absolute_import, print_function,
28
27
unicode_literals)
29
28
33
32
pass
34
33
35
34
import sys
35
import unittest
36
36
import argparse
37
import logging
38
import os
37
39
import locale
38
40
import datetime
39
41
import re
40
import os
41
42
import collections
42
43
import json
43
import unittest
44
import logging
45
44
import io
46
45
import tempfile
47
46
import contextlib
48
47
49
import dbus
48
if sys.version_info.major == 2:
49
__metaclass__ = type
50
str = unicode
51
input = raw_input
52
53
54
class gi:
55
"""Dummy gi module, for the tests"""
56
class repository:
57
class GLib:
58
class Error(Exception):
59
pass
60
61
62
dbussy = None
63
ravel = None
64
dbus_python = None
65
pydbus = None
66
67
try:
68
import dbussy
69
import ravel
70
except ImportError:
71
try:
72
import pydbus
73
import gi
74
except ImportError:
75
import dbus as dbus_python
76
50
77
51
78
# Show warnings by default
52
79
if not sys.warnoptions:
53
80
import warnings
54
81
warnings.simplefilter("default")
55
82
56
log = logging.getLogger(sys.argv[0])
57
logging.basicConfig(level="INFO", # Show info level messages
83
log = logging.getLogger(os.path.basename(sys.argv[0]))
84
logging.basicConfig(level="INFO", # Show info level messages
58
85
format="%(message)s") # Show basic log messages
59
86
60
87
logging.captureWarnings(True) # Show warnings via the logging system
61
88
62
89
if sys.version_info.major == 2:
63
str = unicode
64
90
import StringIO
65
91
io.StringIO = StringIO.StringIO
66
92
67
93
locale.setlocale(locale.LC_ALL, "")
68
94
69
dbus_busname_domain = "se.recompile"
70
dbus_busname = dbus_busname_domain + ".Mandos"
71
server_dbus_path = "/"
72
server_dbus_interface = dbus_busname_domain + ".Mandos"
73
client_dbus_interface = dbus_busname_domain + ".Mandos.Client"
74
del dbus_busname_domain
75
version = "1.8.3"
76
77
78
try:
79
dbus.OBJECT_MANAGER_IFACE
80
except AttributeError:
81
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
95
version = "1.8.16"
82
96
83
97
84
98
def main():
91
105
clientnames = options.client
92
106
93
107
if options.debug:
94
log.setLevel(logging.DEBUG)
95
96
bus = dbus.SystemBus()
97
98
mandos_dbus_object = get_mandos_dbus_object(bus)
99
100
mandos_serv = dbus.Interface(
101
mandos_dbus_object, dbus_interface=server_dbus_interface)
102
mandos_serv_object_manager = dbus.Interface(
103
mandos_dbus_object, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
104
105
managed_objects = get_managed_objects(mandos_serv_object_manager)
106
107
all_clients = {}
108
for path, ifs_and_props in managed_objects.items():
109
try:
110
all_clients[path] = ifs_and_props[client_dbus_interface]
111
except KeyError:
112
pass
108
logging.getLogger("").setLevel(logging.DEBUG)
109
110
if dbussy is not None and ravel is not None:
111
bus = dbussy_adapter.CachingBus(dbussy, ravel)
112
elif pydbus is not None:
113
bus = pydbus_adapter.CachingBus(pydbus)
114
else:
115
bus = dbus_python_adapter.CachingBus(dbus_python)
116
117
try:
118
all_clients = bus.get_clients_and_properties()
119
except dbus.ConnectFailed as e:
120
log.critical("Could not connect to Mandos server: %s", e)
121
sys.exit(1)
122
except dbus.Error as e:
123
log.critical(
124
"Failed to access Mandos server through D-Bus:\n%s", e)
125
sys.exit(1)
113
126
114
127
# Compile dict of (clientpath: properties) to process
115
128
if not clientnames:
128
141
commands = commands_from_options(options)
129
142
130
143
for command in commands:
131
command.run(clients, bus, mandos_serv)
144
command.run(clients, bus)
132
145
133
146
134
147
def add_command_line_options(parser):
139
152
help="Select all clients")
140
153
parser.add_argument("-v", "--verbose", action="store_true",
141
154
help="Print all fields")
142
parser.add_argument("-j", "--dump-json", action="store_true",
155
parser.add_argument("-j", "--dump-json", dest="commands",
156
action="append_const", default=[],
157
const=command.DumpJSON(),
143
158
help="Dump client data in JSON format")
144
159
enable_disable = parser.add_mutually_exclusive_group()
145
enable_disable.add_argument("-e", "--enable", action="store_true",
160
enable_disable.add_argument("-e", "--enable", dest="commands",
161
action="append_const", default=[],
162
const=command.Enable(),
146
163
help="Enable client")
147
enable_disable.add_argument("-d", "--disable",
148
action="store_true",
164
enable_disable.add_argument("-d", "--disable", dest="commands",
165
action="append_const", default=[],
166
const=command.Disable(),
149
167
help="disable client")
150
parser.add_argument("-b", "--bump-timeout", action="store_true",
168
parser.add_argument("-b", "--bump-timeout", dest="commands",
169
action="append_const", default=[],
170
const=command.BumpTimeout(),
151
171
help="Bump timeout for client")
152
172
start_stop_checker = parser.add_mutually_exclusive_group()
153
173
start_stop_checker.add_argument("--start-checker",
154
action="store_true",
174
dest="commands",
175
action="append_const", default=[],
176
const=command.StartChecker(),
155
177
help="Start checker for client")
156
start_stop_checker.add_argument("--stop-checker",
157
action="store_true",
178
start_stop_checker.add_argument("--stop-checker", dest="commands",
179
action="append_const", default=[],
180
const=command.StopChecker(),
158
181
help="Stop checker for client")
159
parser.add_argument("-V", "--is-enabled", action="store_true",
182
parser.add_argument("-V", "--is-enabled", dest="commands",
183
action="append_const", default=[],
184
const=command.IsEnabled(),
160
185
help="Check if client is enabled")
161
parser.add_argument("-r", "--remove", action="store_true",
186
parser.add_argument("-r", "--remove", dest="commands",
187
action="append_const", default=[],
188
const=command.Remove(),
162
189
help="Remove client")
163
parser.add_argument("-c", "--checker",
190
parser.add_argument("-c", "--checker", dest="commands",
191
action="append", default=[],
192
metavar="COMMAND", type=command.SetChecker,
164
193
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")
194
parser.add_argument(
195
"-t", "--timeout", dest="commands", action="append",
196
default=[], metavar="TIME",
197
type=command.SetTimeout.argparse(string_to_delta),
198
help="Set timeout for client")
199
parser.add_argument(
200
"--extended-timeout", dest="commands", action="append",
201
default=[], metavar="TIME",
202
type=command.SetExtendedTimeout.argparse(string_to_delta),
203
help="Set extended timeout for client")
204
parser.add_argument(
205
"-i", "--interval", dest="commands", action="append",
206
default=[], metavar="TIME",
207
type=command.SetInterval.argparse(string_to_delta),
208
help="Set checker interval for client")
171
209
approve_deny_default = parser.add_mutually_exclusive_group()
172
210
approve_deny_default.add_argument(
173
"--approve-by-default", action="store_true",
174
default=None, dest="approved_by_default",
211
"--approve-by-default", dest="commands",
212
action="append_const", default=[],
213
const=command.ApproveByDefault(),
175
214
help="Set client to be approved by default")
176
215
approve_deny_default.add_argument(
177
"--deny-by-default", action="store_false",
178
dest="approved_by_default",
216
"--deny-by-default", dest="commands",
217
action="append_const", default=[],
218
const=command.DenyByDefault(),
179
219
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")
220
parser.add_argument(
221
"--approval-delay", dest="commands", action="append",
222
default=[], metavar="TIME",
223
type=command.SetApprovalDelay.argparse(string_to_delta),
224
help="Set delay before client approve/deny")
225
parser.add_argument(
226
"--approval-duration", dest="commands", action="append",
227
default=[], metavar="TIME",
228
type=command.SetApprovalDuration.argparse(string_to_delta),
229
help="Set duration of one client approval")
230
parser.add_argument("-H", "--host", dest="commands",
231
action="append", default=[], metavar="STRING",
232
type=command.SetHost,
233
help="Set host for client")
234
parser.add_argument(
235
"-s", "--secret", dest="commands", action="append",
236
default=[], metavar="FILENAME",
237
type=command.SetSecret.argparse(argparse.FileType(mode="rb")),
238
help="Set password blob (file) for client")
188
239
approve_deny = parser.add_mutually_exclusive_group()
189
240
approve_deny.add_argument(
190
"-A", "--approve", action="store_true",
241
"-A", "--approve", dest="commands", action="append_const",
242
default=[], const=command.Approve(),
191
243
help="Approve any current client request")
192
approve_deny.add_argument("-D", "--deny", action="store_true",
244
approve_deny.add_argument("-D", "--deny", dest="commands",
245
action="append_const", default=[],
246
const=command.Deny(),
193
247
help="Deny any current client request")
194
248
parser.add_argument("--debug", action="store_true",
195
249
help="Debug mode (show D-Bus commands)")
205
259
return rfc3339_duration_to_delta(interval)
206
260
except ValueError as e:
207
261
log.warning("%s - Parsing as pre-1.6.1 interval instead",
208
' '.join(e.args))
262
" ".join(e.args))
209
263
return parse_pre_1_6_1_interval(interval)
210
264
211
265
212
266
def rfc3339_duration_to_delta(duration):
213
267
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
214
268
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)
269
>>> rfc3339_duration_to_delta("P7D") == datetime.timedelta(7)
270
True
271
>>> rfc3339_duration_to_delta("PT60S") == datetime.timedelta(0, 60)
272
True
273
>>> rfc3339_duration_to_delta("PT60M") == datetime.timedelta(hours=1)
274
True
275
>>> # 60 months
276
>>> rfc3339_duration_to_delta("P60M") == datetime.timedelta(1680)
277
True
278
>>> rfc3339_duration_to_delta("PT24H") == datetime.timedelta(1)
279
True
280
>>> rfc3339_duration_to_delta("P1W") == datetime.timedelta(7)
281
True
282
>>> rfc3339_duration_to_delta("PT5M30S") == datetime.timedelta(0, 330)
283
True
284
>>> rfc3339_duration_to_delta("P1DT3M20S") == datetime.timedelta(1, 200)
285
True
231
286
>>> # Can not be empty:
232
287
>>> rfc3339_duration_to_delta("")
233
288
Traceback (most recent call last):
340
395
341
396
342
397
def parse_pre_1_6_1_interval(interval):
343
"""Parse an interval string as documented by Mandos before 1.6.1,
398
r"""Parse an interval string as documented by Mandos before 1.6.1,
344
399
and return a datetime.timedelta
345
400
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)
401
>>> parse_pre_1_6_1_interval("7d") == datetime.timedelta(days=7)
402
True
403
>>> parse_pre_1_6_1_interval("60s") == datetime.timedelta(0, 60)
404
True
405
>>> parse_pre_1_6_1_interval("60m") == datetime.timedelta(hours=1)
406
True
407
>>> parse_pre_1_6_1_interval("24h") == datetime.timedelta(days=1)
408
True
409
>>> parse_pre_1_6_1_interval("1w") == datetime.timedelta(days=7)
410
True
411
>>> parse_pre_1_6_1_interval("5m 30s") == datetime.timedelta(0, 330)
412
True
413
>>> parse_pre_1_6_1_interval("") == datetime.timedelta(0)
414
True
360
415
>>> # Ignore unknown characters, allow any order and repetitions
361
>>> parse_pre_1_6_1_interval('2dxy7zz11y3m5m')
362
datetime.timedelta(2, 480, 18000)
416
>>> parse_pre_1_6_1_interval("2dxy7zz11y3m5m") \
417
... == datetime.timedelta(2, 480, 18000)
418
True
363
419
364
420
"""
365
421
386
442
"""Apply additional restrictions on options, not expressible in
387
443
argparse"""
388
444
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))
445
def has_commands(options, commands=None):
446
if commands is None:
447
commands = (command.Enable,
448
command.Disable,
449
command.BumpTimeout,
450
command.StartChecker,
451
command.StopChecker,
452
command.IsEnabled,
453
command.Remove,
454
command.SetChecker,
455
command.SetTimeout,
456
command.SetExtendedTimeout,
457
command.SetInterval,
458
command.ApproveByDefault,
459
command.DenyByDefault,
460
command.SetApprovalDelay,
461
command.SetApprovalDuration,
462
command.SetHost,
463
command.SetSecret,
464
command.Approve,
465
command.Deny)
466
return any(isinstance(cmd, commands)
467
for cmd in options.commands)
408
468
409
if has_actions(options) and not (options.client or options.all):
469
if has_commands(options) and not (options.client or options.all):
410
470
parser.error("Options require clients names or --all.")
411
if options.verbose and has_actions(options):
471
if options.verbose and has_commands(options):
412
472
parser.error("--verbose can only be used alone.")
413
if options.dump_json and (options.verbose
414
or has_actions(options)):
473
if (has_commands(options, (command.DumpJSON,))
474
and (options.verbose or len(options.commands) > 1)):
415
475
parser.error("--dump-json can only be used alone.")
416
if options.all and not has_actions(options):
476
if options.all and not has_commands(options):
417
477
parser.error("--all requires an action.")
418
if options.is_enabled and len(options.client) > 1:
478
if (has_commands(options, (command.IsEnabled,))
479
and len(options.client) > 1):
419
480
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
464
class NullFilter(logging.Filter):
465
def filter(self, record):
466
return False
467
468
nullfilter = NullFilter()
469
470
def __exit__(self, exc_type, exc_val, exc_tb):
471
self.logger.removeFilter(self.nullfilter)
481
if (len(options.commands) > 1
482
and has_commands(options, (command.Remove,))
483
and not has_commands(options, (command.Deny,))):
484
parser.error("--remove can only be combined with --deny")
485
486
487
class dbus:
488
489
class SystemBus:
490
491
object_manager_iface = "org.freedesktop.DBus.ObjectManager"
492
493
def get_managed_objects(self, busname, objectpath):
494
return self.call_method("GetManagedObjects", busname,
495
objectpath,
496
self.object_manager_iface)
497
498
properties_iface = "org.freedesktop.DBus.Properties"
499
500
def set_property(self, busname, objectpath, interface, key,
501
value):
502
self.call_method("Set", busname, objectpath,
503
self.properties_iface, interface, key,
504
value)
505
506
def call_method(self, methodname, busname, objectpath,
507
interface, *args):
508
raise NotImplementedError()
509
510
class MandosBus(SystemBus):
511
busname_domain = "se.recompile"
512
busname = busname_domain + ".Mandos"
513
server_path = "/"
514
server_interface = busname_domain + ".Mandos"
515
client_interface = busname_domain + ".Mandos.Client"
516
del busname_domain
517
518
def get_clients_and_properties(self):
519
managed_objects = self.get_managed_objects(
520
self.busname, self.server_path)
521
return {objpath: properties[self.client_interface]
522
for objpath, properties in managed_objects.items()
523
if self.client_interface in properties}
524
525
def set_client_property(self, objectpath, key, value):
526
return self.set_property(self.busname, objectpath,
527
self.client_interface, key,
528
value)
529
530
def call_client_method(self, objectpath, method, *args):
531
return self.call_method(method, self.busname, objectpath,
532
self.client_interface, *args)
533
534
def call_server_method(self, method, *args):
535
return self.call_method(method, self.busname,
536
self.server_path,
537
self.server_interface, *args)
538
539
class Error(Exception):
540
pass
541
542
class ConnectFailed(Error):
543
pass
544
545
546
class dbus_python_adapter:
547
548
class SystemBus(dbus.MandosBus):
549
"""Use dbus-python"""
550
551
def __init__(self, module=dbus_python):
552
self.dbus_python = module
553
self.bus = self.dbus_python.SystemBus()
554
555
@contextlib.contextmanager
556
def convert_exception(self, exception_class=dbus.Error):
557
try:
558
yield
559
except self.dbus_python.exceptions.DBusException as e:
560
# This does what "raise from" would do
561
exc = exception_class(*e.args)
562
exc.__cause__ = e
563
raise exc
564
565
def call_method(self, methodname, busname, objectpath,
566
interface, *args):
567
proxy_object = self.get_object(busname, objectpath)
568
log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
569
interface, methodname,
570
", ".join(repr(a) for a in args))
571
method = getattr(proxy_object, methodname)
572
with self.convert_exception():
573
with dbus_python_adapter.SilenceLogger(
574
"dbus.proxies"):
575
value = method(*args, dbus_interface=interface)
576
return self.type_filter(value)
577
578
def get_object(self, busname, objectpath):
579
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
580
busname, objectpath)
581
with self.convert_exception(dbus.ConnectFailed):
582
return self.bus.get_object(busname, objectpath)
583
584
def type_filter(self, value):
585
"""Convert the most bothersome types to Python types"""
586
if isinstance(value, self.dbus_python.Boolean):
587
return bool(value)
588
if isinstance(value, self.dbus_python.ObjectPath):
589
return str(value)
590
# Also recurse into dictionaries
591
if isinstance(value, self.dbus_python.Dictionary):
592
return {self.type_filter(key):
593
self.type_filter(subval)
594
for key, subval in value.items()}
595
return value
596
597
def set_client_property(self, objectpath, key, value):
598
if key == "Secret":
599
if not isinstance(value, bytes):
600
value = value.encode("utf-8")
601
value = self.dbus_python.ByteArray(value)
602
return self.set_property(self.busname, objectpath,
603
self.client_interface, key,
604
value)
605
606
class SilenceLogger:
607
"Simple context manager to silence a particular logger"
608
609
def __init__(self, loggername):
610
self.logger = logging.getLogger(loggername)
611
612
def __enter__(self):
613
self.logger.addFilter(self.nullfilter)
614
615
class NullFilter(logging.Filter):
616
def filter(self, record):
617
return False
618
619
nullfilter = NullFilter()
620
621
def __exit__(self, exc_type, exc_val, exc_tb):
622
self.logger.removeFilter(self.nullfilter)
623
624
class CachingBus(SystemBus):
625
"""A caching layer for dbus_python_adapter.SystemBus"""
626
627
def __init__(self, *args, **kwargs):
628
self.object_cache = {}
629
super(dbus_python_adapter.CachingBus,
630
self).__init__(*args, **kwargs)
631
632
def get_object(self, busname, objectpath):
633
try:
634
return self.object_cache[(busname, objectpath)]
635
except KeyError:
636
new_object = super(
637
dbus_python_adapter.CachingBus,
638
self).get_object(busname, objectpath)
639
self.object_cache[(busname, objectpath)] = new_object
640
return new_object
641
642
643
class pydbus_adapter:
644
class SystemBus(dbus.MandosBus):
645
def __init__(self, module=pydbus):
646
self.pydbus = module
647
self.bus = self.pydbus.SystemBus()
648
649
@contextlib.contextmanager
650
def convert_exception(self, exception_class=dbus.Error):
651
try:
652
yield
653
except gi.repository.GLib.Error as e:
654
# This does what "raise from" would do
655
exc = exception_class(*e.args)
656
exc.__cause__ = e
657
raise exc
658
659
def call_method(self, methodname, busname, objectpath,
660
interface, *args):
661
proxy_object = self.get(busname, objectpath)
662
log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
663
interface, methodname,
664
", ".join(repr(a) for a in args))
665
method = getattr(proxy_object[interface], methodname)
666
with self.convert_exception():
667
return method(*args)
668
669
def get(self, busname, objectpath):
670
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
671
busname, objectpath)
672
with self.convert_exception(dbus.ConnectFailed):
673
if sys.version_info.major <= 2:
674
with warnings.catch_warnings():
675
warnings.filterwarnings(
676
"ignore", "", DeprecationWarning,
677
r"^xml\.etree\.ElementTree$")
678
return self.bus.get(busname, objectpath)
679
else:
680
return self.bus.get(busname, objectpath)
681
682
def set_property(self, busname, objectpath, interface, key,
683
value):
684
proxy_object = self.get(busname, objectpath)
685
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", busname,
686
objectpath, self.properties_iface, interface,
687
key, value)
688
setattr(proxy_object[interface], key, value)
689
690
class CachingBus(SystemBus):
691
"""A caching layer for pydbus_adapter.SystemBus"""
692
693
def __init__(self, *args, **kwargs):
694
self.object_cache = {}
695
super(pydbus_adapter.CachingBus,
696
self).__init__(*args, **kwargs)
697
698
def get(self, busname, objectpath):
699
try:
700
return self.object_cache[(busname, objectpath)]
701
except KeyError:
702
new_object = (super(pydbus_adapter.CachingBus, self)
703
.get(busname, objectpath))
704
self.object_cache[(busname, objectpath)] = new_object
705
return new_object
706
707
708
class dbussy_adapter:
709
class SystemBus(dbus.SystemBus):
710
"""Use DBussy"""
711
712
def __init__(self, dbussy, ravel):
713
self.dbussy = dbussy
714
self.ravel = ravel
715
self.bus = ravel.system_bus()
716
717
@contextlib.contextmanager
718
def convert_exception(self, exception_class=dbus.Error):
719
try:
720
yield
721
except self.dbussy.DBusError as e:
722
# This does what "raise from" would do
723
exc = exception_class(*e.args)
724
exc.__cause__ = e
725
raise exc
726
727
def call_method(self, methodname, busname, objectpath,
728
interface, *args):
729
proxy_object = self.get_object(busname, objectpath)
730
log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
731
interface, methodname,
732
", ".join(repr(a) for a in args))
733
iface = proxy_object.get_interface(interface)
734
method = getattr(iface, methodname)
735
with self.convert_exception(dbus.Error):
736
value = method(*args)
737
# DBussy returns values either as an empty list or as a
738
# list of one element with the return value
739
if value:
740
return self.type_filter(value[0])
741
742
def get_object(self, busname, objectpath):
743
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
744
busname, objectpath)
745
with self.convert_exception(dbus.ConnectFailed):
746
return self.bus[busname][objectpath]
747
748
def type_filter(self, value):
749
"""Convert the most bothersome types to Python types"""
750
# A D-Bus Variant value is represented as the Python type
751
# Tuple[dbussy.DBUS.Signature, Any]
752
if isinstance(value, tuple):
753
if (len(value) == 2
754
and isinstance(value[0],
755
self.dbussy.DBUS.Signature)):
756
return self.type_filter(value[1])
757
elif isinstance(value, self.dbussy.DBUS.ObjectPath):
758
return str(value)
759
# Also recurse into dictionaries
760
elif isinstance(value, dict):
761
return {self.type_filter(key):
762
self.type_filter(subval)
763
for key, subval in value.items()}
764
return value
765
766
def set_property(self, busname, objectpath, interface, key,
767
value):
768
proxy_object = self.get_object(busname, objectpath)
769
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", busname,
770
objectpath, self.properties_iface, interface,
771
key, value)
772
if key == "Secret":
773
# DBussy wants a Byte Array to be a sequence of
774
# values, not a byte string
775
value = tuple(value)
776
setattr(proxy_object.get_interface(interface), key, value)
777
778
class MandosBus(SystemBus, dbus.MandosBus):
779
pass
780
781
class CachingBus(MandosBus):
782
"""A caching layer for dbussy_adapter.MandosBus"""
783
784
def __init__(self, *args, **kwargs):
785
self.object_cache = {}
786
super(dbussy_adapter.CachingBus, self).__init__(*args,
787
**kwargs)
788
789
def get_object(self, busname, objectpath):
790
try:
791
return self.object_cache[(busname, objectpath)]
792
except KeyError:
793
new_object = super(
794
dbussy_adapter.CachingBus,
795
self).get_object(busname, objectpath)
796
self.object_cache[(busname, objectpath)] = new_object
797
return new_object
472
798
473
799
474
800
def commands_from_options(options):
475
801
476
commands = []
477
478
if options.is_enabled:
479
commands.append(command.IsEnabled())
480
481
if options.approve:
482
commands.append(command.Approve())
483
484
if options.deny:
485
commands.append(command.Deny())
486
487
if options.remove:
488
commands.append(command.Remove())
489
490
if options.dump_json:
491
commands.append(command.DumpJSON())
492
493
if options.enable:
494
commands.append(command.Enable())
495
496
if options.disable:
497
commands.append(command.Disable())
498
499
if options.bump_timeout:
500
commands.append(command.BumpTimeout())
501
502
if options.start_checker:
503
commands.append(command.StartChecker())
504
505
if options.stop_checker:
506
commands.append(command.StopChecker())
507
508
if options.approved_by_default is not None:
509
if options.approved_by_default:
510
commands.append(command.ApproveByDefault())
802
commands = list(options.commands)
803
804
def find_cmd(cmd, commands):
805
i = 0
806
for i, c in enumerate(commands):
807
if isinstance(c, cmd):
808
return i
809
return i+1
810
811
# If command.Remove is present, move any instances of command.Deny
812
# to occur ahead of command.Remove.
813
index_of_remove = find_cmd(command.Remove, commands)
814
before_remove = commands[:index_of_remove]
815
after_remove = commands[index_of_remove:]
816
cleaned_after = []
817
for cmd in after_remove:
818
if isinstance(cmd, command.Deny):
819
before_remove.append(cmd)
511
820
else:
512
commands.append(command.DenyByDefault())
513
514
if options.checker is not None:
515
commands.append(command.SetChecker(options.checker))
516
517
if options.host is not None:
518
commands.append(command.SetHost(options.host))
519
520
if options.secret is not None:
521
commands.append(command.SetSecret(options.secret))
522
523
if options.timeout is not None:
524
commands.append(command.SetTimeout(options.timeout))
525
526
if options.extended_timeout:
527
commands.append(
528
command.SetExtendedTimeout(options.extended_timeout))
529
530
if options.interval is not None:
531
commands.append(command.SetInterval(options.interval))
532
533
if options.approval_delay is not None:
534
commands.append(
535
command.SetApprovalDelay(options.approval_delay))
536
537
if options.approval_duration is not None:
538
commands.append(
539
command.SetApprovalDuration(options.approval_duration))
821
cleaned_after.append(cmd)
822
if cleaned_after != after_remove:
823
commands = before_remove + cleaned_after
540
824
541
825
# If no command option has been given, show table of clients,
542
826
# optionally verbosely
546
830
return commands
547
831
548
832
549
class command(object):
833
class command:
550
834
"""A namespace for command classes"""
551
835
552
class Base(object):
836
class Base:
553
837
"""Abstract base class for commands"""
554
def run(self, clients, bus=None, mandos=None):
838
839
def run(self, clients, bus=None):
555
840
"""Normal commands should implement run_on_one_client(),
556
841
but commands which want to operate on all clients at the same time can
557
842
override this run() method instead.
558
843
"""
559
self.mandos = mandos
560
for clientpath, properties in clients.items():
561
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
562
dbus_busname, str(clientpath))
563
client = bus.get_object(dbus_busname, clientpath)
844
self.bus = bus
845
for client, properties in clients.items():
564
846
self.run_on_one_client(client, properties)
565
847
566
567
848
class IsEnabled(Base):
568
def run(self, clients, bus=None, mandos=None):
569
client, properties = next(iter(clients.items()))
570
if self.is_enabled(client, properties):
849
def run(self, clients, bus=None):
850
properties = next(iter(clients.values()))
851
if properties["Enabled"]:
571
852
sys.exit(0)
572
853
sys.exit(1)
573
def is_enabled(self, client, properties):
574
return properties["Enabled"]
575
576
854
577
855
class Approve(Base):
578
856
def run_on_one_client(self, client, properties):
579
log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
580
client.__dbus_object_path__,
581
client_dbus_interface)
582
client.Approve(dbus.Boolean(True),
583
dbus_interface=client_dbus_interface)
584
857
self.bus.call_client_method(client, "Approve", True)
585
858
586
859
class Deny(Base):
587
860
def run_on_one_client(self, client, properties):
588
log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
589
client.__dbus_object_path__,
590
client_dbus_interface)
591
client.Approve(dbus.Boolean(False),
592
dbus_interface=client_dbus_interface)
593
861
self.bus.call_client_method(client, "Approve", False)
594
862
595
863
class Remove(Base):
596
def run_on_one_client(self, client, properties):
597
log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)",
598
dbus_busname, server_dbus_path,
599
server_dbus_interface,
600
str(client.__dbus_object_path__))
601
self.mandos.RemoveClient(client.__dbus_object_path__)
602
864
def run(self, clients, bus):
865
for clientpath in frozenset(clients.keys()):
866
bus.call_server_method("RemoveClient", clientpath)
603
867
604
868
class Output(Base):
605
869
"""Abstract class for commands outputting client details"""
612
876
"Checker", "ExtendedTimeout", "Expires",
613
877
"LastCheckerStatus")
614
878
615
616
879
class DumpJSON(Output):
617
def run(self, clients, bus=None, mandos=None):
618
data = {client["Name"]:
619
{key: self.dbus_boolean_to_bool(client[key])
880
def run(self, clients, bus=None):
881
data = {properties["Name"]:
882
{key: properties[key]
620
883
for key in self.all_keywords}
621
for client in clients.values()}
622
print(json.dumps(data, indent=4, separators=(',', ': ')))
623
624
@staticmethod
625
def dbus_boolean_to_bool(value):
626
if isinstance(value, dbus.Boolean):
627
value = bool(value)
628
return value
629
884
for properties in clients.values()}
885
print(json.dumps(data, indent=4, separators=(",", ": ")))
630
886
631
887
class PrintTable(Output):
632
888
def __init__(self, verbose=False):
633
889
self.verbose = verbose
634
890
635
def run(self, clients, bus=None, mandos=None):
891
def run(self, clients, bus=None):
636
892
default_keywords = ("Name", "Enabled", "Timeout",
637
893
"LastCheckedOK")
638
894
keywords = default_keywords
640
896
keywords = self.all_keywords
641
897
print(self.TableOfClients(clients.values(), keywords))
642
898
643
class TableOfClients(object):
899
class TableOfClients:
644
900
tableheaders = {
645
901
"Name": "Name",
646
902
"Enabled": "Enabled",
673
929
674
930
if sys.version_info.major == 2:
675
931
__unicode__ = __str__
932
676
933
def __str__(self):
677
934
return str(self).encode(
678
935
locale.getpreferredencoding())
699
956
700
957
@classmethod
701
958
def valuetostring(cls, value, keyword):
702
if isinstance(value, dbus.Boolean):
959
if isinstance(value, bool):
703
960
return "Yes" if value else "No"
704
961
if keyword in ("Timeout", "Interval", "ApprovalDelay",
705
962
"ApprovalDuration", "ExtendedTimeout"):
724
981
minutes=(td.seconds % 3600) // 60,
725
982
seconds=td.seconds % 60))
726
983
727
728
984
class PropertySetter(Base):
729
985
"Abstract class for Actions for setting one client property"
730
986
731
def run_on_one_client(self, client, properties):
987
def run_on_one_client(self, client, properties=None):
732
988
"""Set the Client's D-Bus property"""
733
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
734
client.__dbus_object_path__,
735
dbus.PROPERTIES_IFACE, client_dbus_interface,
736
self.propname, self.value_to_set
737
if not isinstance(self.value_to_set,
738
dbus.Boolean)
739
else bool(self.value_to_set))
740
client.Set(client_dbus_interface, self.propname,
741
self.value_to_set,
742
dbus_interface=dbus.PROPERTIES_IFACE)
989
self.bus.set_client_property(client, self.propname,
990
self.value_to_set)
743
991
744
992
@property
745
993
def propname(self):
746
994
raise NotImplementedError()
747
995
748
749
996
class Enable(PropertySetter):
750
997
propname = "Enabled"
751
value_to_set = dbus.Boolean(True)
752
998
value_to_set = True
753
999
754
1000
class Disable(PropertySetter):
755
1001
propname = "Enabled"
756
value_to_set = dbus.Boolean(False)
757
1002
value_to_set = False
758
1003
759
1004
class BumpTimeout(PropertySetter):
760
1005
propname = "LastCheckedOK"
761
1006
value_to_set = ""
762
1007
763
764
1008
class StartChecker(PropertySetter):
765
1009
propname = "CheckerRunning"
766
value_to_set = dbus.Boolean(True)
767
1010
value_to_set = True
768
1011
769
1012
class StopChecker(PropertySetter):
770
1013
propname = "CheckerRunning"
771
value_to_set = dbus.Boolean(False)
772
1014
value_to_set = False
773
1015
774
1016
class ApproveByDefault(PropertySetter):
775
1017
propname = "ApprovedByDefault"
776
value_to_set = dbus.Boolean(True)
777
1018
value_to_set = True
778
1019
779
1020
class DenyByDefault(PropertySetter):
780
1021
propname = "ApprovedByDefault"
781
value_to_set = dbus.Boolean(False)
782
1022
value_to_set = False
783
1023
784
1024
class PropertySetterValue(PropertySetter):
785
1025
"""Abstract class for PropertySetter recieving a value as
786
1026
constructor argument instead of a class attribute."""
1027
787
1028
def __init__(self, value):
788
1029
self.value_to_set = value
789
1030
1031
@classmethod
1032
def argparse(cls, argtype):
1033
def cmdtype(arg):
1034
return cls(argtype(arg))
1035
return cmdtype
790
1036
791
1037
class SetChecker(PropertySetterValue):
792
1038
propname = "Checker"
793
1039
794
795
1040
class SetHost(PropertySetterValue):
796
1041
propname = "Host"
797
1042
798
799
1043
class SetSecret(PropertySetterValue):
800
1044
propname = "Secret"
801
1045
809
1053
self._vts = value.read()
810
1054
value.close()
811
1055
812
813
1056
class PropertySetterValueMilliseconds(PropertySetterValue):
814
1057
"""Abstract class for PropertySetterValue taking a value
815
1058
argument as a datetime.timedelta() but should store it as
824
1067
"When setting, convert value from a datetime.timedelta"
825
1068
self._vts = int(round(value.total_seconds() * 1000))
826
1069
827
828
1070
class SetTimeout(PropertySetterValueMilliseconds):
829
1071
propname = "Timeout"
830
1072
831
832
1073
class SetExtendedTimeout(PropertySetterValueMilliseconds):
833
1074
propname = "ExtendedTimeout"
834
1075
835
836
1076
class SetInterval(PropertySetterValueMilliseconds):
837
1077
propname = "Interval"
838
1078
839
840
1079
class SetApprovalDelay(PropertySetterValueMilliseconds):
841
1080
propname = "ApprovalDelay"
842
1081
843
844
1082
class SetApprovalDuration(PropertySetterValueMilliseconds):
845
1083
propname = "ApprovalDuration"
846
1084
880
1118
"output"))
881
1119
882
1120
1121
class Unique:
1122
"""Class for objects which exist only to be unique objects, since
1123
unittest.mock.sentinel only exists in Python 3.3"""
1124
1125
883
1126
class Test_string_to_delta(TestCaseWithAssertLogs):
884
1127
# Just test basic RFC 3339 functionality here, the doc string for
885
1128
# rfc3339_duration_to_delta() already has more comprehensive
886
# tests, which is run by doctest.
1129
# tests, which are run by doctest.
887
1130
888
1131
def test_rfc3339_zero_seconds(self):
889
1132
self.assertEqual(datetime.timedelta(),
913
1156
914
1157
def test_actions_requires_client_or_all(self):
915
1158
for action, value in self.actions.items():
916
options = self.parser.parse_args()
917
setattr(options, action, value)
1159
args = self.actionargs(action, value)
918
1160
with self.assertParseError():
919
self.check_option_syntax(options)
1161
self.parse_args(args)
920
1162
921
# This mostly corresponds to the definition from has_actions() in
1163
# This mostly corresponds to the definition from has_commands() in
922
1164
# check_option_syntax()
923
1165
actions = {
924
# The actual values set here are not that important, but we do
925
# at least stick to the correct types, even though they are
926
# never used
927
"enable": True,
928
"disable": True,
929
"bump_timeout": True,
930
"start_checker": True,
931
"stop_checker": True,
932
"is_enabled": True,
933
"remove": True,
934
"checker": "x",
935
"timeout": datetime.timedelta(),
936
"extended_timeout": datetime.timedelta(),
937
"interval": datetime.timedelta(),
938
"approved_by_default": True,
939
"approval_delay": datetime.timedelta(),
940
"approval_duration": datetime.timedelta(),
941
"host": "x",
942
"secret": io.BytesIO(b"x"),
943
"approve": True,
944
"deny": True,
1166
"--enable": None,
1167
"--disable": None,
1168
"--bump-timeout": None,
1169
"--start-checker": None,
1170
"--stop-checker": None,
1171
"--is-enabled": None,
1172
"--remove": None,
1173
"--checker": "x",
1174
"--timeout": "PT0S",
1175
"--extended-timeout": "PT0S",
1176
"--interval": "PT0S",
1177
"--approve-by-default": None,
1178
"--deny-by-default": None,
1179
"--approval-delay": "PT0S",
1180
"--approval-duration": "PT0S",
1181
"--host": "hostname",
1182
"--secret": "/dev/null",
1183
"--approve": None,
1184
"--deny": None,
945
1185
}
946
1186
1187
@staticmethod
1188
def actionargs(action, value, *args):
1189
if value is not None:
1190
return [action, value] + list(args)
1191
else:
1192
return [action] + list(args)
1193
947
1194
@contextlib.contextmanager
948
1195
def assertParseError(self):
949
1196
with self.assertRaises(SystemExit) as e:
954
1201
# /argparse.html#exiting-methods
955
1202
self.assertEqual(2, e.exception.code)
956
1203
1204
def parse_args(self, args):
1205
options = self.parser.parse_args(args)
1206
check_option_syntax(self.parser, options)
1207
957
1208
@staticmethod
958
1209
@contextlib.contextmanager
959
1210
def redirect_stderr_to_devnull():
970
1221
971
1222
def test_actions_all_conflicts_with_verbose(self):
972
1223
for action, value in self.actions.items():
973
options = self.parser.parse_args()
974
setattr(options, action, value)
975
options.all = True
976
options.verbose = True
1224
args = self.actionargs(action, value, "--all",
1225
"--verbose")
977
1226
with self.assertParseError():
978
self.check_option_syntax(options)
1227
self.parse_args(args)
979
1228
980
1229
def test_actions_with_client_conflicts_with_verbose(self):
981
1230
for action, value in self.actions.items():
982
options = self.parser.parse_args()
983
setattr(options, action, value)
984
options.verbose = True
985
options.client = ["client"]
1231
args = self.actionargs(action, value, "--verbose",
1232
"client")
986
1233
with self.assertParseError():
987
self.check_option_syntax(options)
1234
self.parse_args(args)
988
1235
989
1236
def test_dump_json_conflicts_with_verbose(self):
990
options = self.parser.parse_args()
991
options.dump_json = True
992
options.verbose = True
1237
args = ["--dump-json", "--verbose"]
993
1238
with self.assertParseError():
994
self.check_option_syntax(options)
1239
self.parse_args(args)
995
1240
996
1241
def test_dump_json_conflicts_with_action(self):
997
1242
for action, value in self.actions.items():
998
options = self.parser.parse_args()
999
setattr(options, action, value)
1000
options.dump_json = True
1243
args = self.actionargs(action, value, "--dump-json")
1001
1244
with self.assertParseError():
1002
self.check_option_syntax(options)
1245
self.parse_args(args)
1003
1246
1004
1247
def test_all_can_not_be_alone(self):
1005
options = self.parser.parse_args()
1006
options.all = True
1248
args = ["--all"]
1007
1249
with self.assertParseError():
1008
self.check_option_syntax(options)
1250
self.parse_args(args)
1009
1251
1010
1252
def test_all_is_ok_with_any_action(self):
1011
1253
for action, value in self.actions.items():
1012
options = self.parser.parse_args()
1013
setattr(options, action, value)
1014
options.all = True
1015
self.check_option_syntax(options)
1254
args = self.actionargs(action, value, "--all")
1255
self.parse_args(args)
1016
1256
1017
1257
def test_any_action_is_ok_with_one_client(self):
1018
1258
for action, value in self.actions.items():
1019
options = self.parser.parse_args()
1020
setattr(options, action, value)
1021
options.client = ["client"]
1022
self.check_option_syntax(options)
1259
args = self.actionargs(action, value, "client")
1260
self.parse_args(args)
1023
1261
1024
1262
def test_one_client_with_all_actions_except_is_enabled(self):
1025
options = self.parser.parse_args()
1026
1263
for action, value in self.actions.items():
1027
if action == "is_enabled":
1264
if action == "--is-enabled":
1028
1265
continue
1029
setattr(options, action, value)
1030
options.client = ["client"]
1031
self.check_option_syntax(options)
1266
args = self.actionargs(action, value, "client")
1267
self.parse_args(args)
1032
1268
1033
1269
def test_two_clients_with_all_actions_except_is_enabled(self):
1034
options = self.parser.parse_args()
1035
1270
for action, value in self.actions.items():
1036
if action == "is_enabled":
1271
if action == "--is-enabled":
1037
1272
continue
1038
setattr(options, action, value)
1039
options.client = ["client1", "client2"]
1040
self.check_option_syntax(options)
1273
args = self.actionargs(action, value, "client1",
1274
"client2")
1275
self.parse_args(args)
1041
1276
1042
1277
def test_two_clients_are_ok_with_actions_except_is_enabled(self):
1043
1278
for action, value in self.actions.items():
1044
if action == "is_enabled":
1279
if action == "--is-enabled":
1045
1280
continue
1046
options = self.parser.parse_args()
1047
setattr(options, action, value)
1048
options.client = ["client1", "client2"]
1049
self.check_option_syntax(options)
1281
args = self.actionargs(action, value, "client1",
1282
"client2")
1283
self.parse_args(args)
1050
1284
1051
1285
def test_is_enabled_fails_without_client(self):
1052
options = self.parser.parse_args()
1053
options.is_enabled = True
1286
args = ["--is-enabled"]
1054
1287
with self.assertParseError():
1055
self.check_option_syntax(options)
1288
self.parse_args(args)
1056
1289
1057
1290
def test_is_enabled_fails_with_two_clients(self):
1058
options = self.parser.parse_args()
1059
options.is_enabled = True
1060
options.client = ["client1", "client2"]
1291
args = ["--is-enabled", "client1", "client2"]
1061
1292
with self.assertParseError():
1062
self.check_option_syntax(options)
1293
self.parse_args(args)
1063
1294
1064
1295
def test_remove_can_only_be_combined_with_action_deny(self):
1065
1296
for action, value in self.actions.items():
1066
if action in {"remove", "deny"}:
1297
if action in {"--remove", "--deny"}:
1067
1298
continue
1068
options = self.parser.parse_args()
1069
setattr(options, action, value)
1070
options.all = True
1071
options.remove = True
1299
args = self.actionargs(action, value, "--all",
1300
"--remove")
1072
1301
with self.assertParseError():
1073
self.check_option_syntax(options)
1074
1075
1076
class Test_get_mandos_dbus_object(TestCaseWithAssertLogs):
1077
def test_calls_and_returns_get_object_on_bus(self):
1078
class MockBus(object):
1079
called = False
1080
def get_object(mockbus_self, busname, dbus_path):
1081
# Note that "self" is still the testcase instance,
1082
# this MockBus instance is in "mockbus_self".
1083
self.assertEqual(dbus_busname, busname)
1084
self.assertEqual(server_dbus_path, dbus_path)
1085
mockbus_self.called = True
1086
return mockbus_self
1087
1088
mockbus = get_mandos_dbus_object(bus=MockBus())
1089
self.assertIsInstance(mockbus, MockBus)
1090
self.assertTrue(mockbus.called)
1091
1092
def test_logs_and_exits_on_dbus_error(self):
1093
class FailingBusStub(object):
1094
def get_object(self, busname, dbus_path):
1095
raise dbus.exceptions.DBusException("Test")
1096
1097
with self.assertLogs(log, logging.CRITICAL):
1098
with self.assertRaises(SystemExit) as e:
1099
bus = get_mandos_dbus_object(bus=FailingBusStub())
1100
1101
if isinstance(e.exception.code, int):
1102
self.assertNotEqual(0, e.exception.code)
1103
else:
1104
self.assertIsNotNone(e.exception.code)
1105
1106
1107
class Test_get_managed_objects(TestCaseWithAssertLogs):
1108
def test_calls_and_returns_GetManagedObjects(self):
1109
managed_objects = {"/clients/client": { "Name": "client"}}
1110
class ObjectManagerStub(object):
1111
def GetManagedObjects(self):
1112
return managed_objects
1113
retval = get_managed_objects(ObjectManagerStub())
1114
self.assertDictEqual(managed_objects, retval)
1115
1116
def test_logs_and_exits_on_dbus_error(self):
1302
self.parse_args(args)
1303
1304
1305
class Test_dbus_exceptions(unittest.TestCase):
1306
1307
def test_dbus_ConnectFailed_is_Error(self):
1308
with self.assertRaises(dbus.Error):
1309
raise dbus.ConnectFailed()
1310
1311
1312
class Test_dbus_MandosBus(unittest.TestCase):
1313
1314
class MockMandosBus(dbus.MandosBus):
1315
def __init__(self):
1316
self._name = "se.recompile.Mandos"
1317
self._server_path = "/"
1318
self._server_interface = "se.recompile.Mandos"
1319
self._client_interface = "se.recompile.Mandos.Client"
1320
self.calls = []
1321
self.call_method_return = Unique()
1322
1323
def call_method(self, methodname, busname, objectpath,
1324
interface, *args):
1325
self.calls.append((methodname, busname, objectpath,
1326
interface, args))
1327
return self.call_method_return
1328
1329
def setUp(self):
1330
self.bus = self.MockMandosBus()
1331
1332
def test_set_client_property(self):
1333
self.bus.set_client_property("objectpath", "key", "value")
1334
expected_call = ("Set", self.bus._name, "objectpath",
1335
"org.freedesktop.DBus.Properties",
1336
(self.bus._client_interface, "key", "value"))
1337
self.assertIn(expected_call, self.bus.calls)
1338
1339
def test_call_client_method(self):
1340
ret = self.bus.call_client_method("objectpath", "methodname")
1341
self.assertIs(self.bus.call_method_return, ret)
1342
expected_call = ("methodname", self.bus._name, "objectpath",
1343
self.bus._client_interface, ())
1344
self.assertIn(expected_call, self.bus.calls)
1345
1346
def test_call_client_method_with_args(self):
1347
args = (Unique(), Unique())
1348
ret = self.bus.call_client_method("objectpath", "methodname",
1349
*args)
1350
self.assertIs(self.bus.call_method_return, ret)
1351
expected_call = ("methodname", self.bus._name, "objectpath",
1352
self.bus._client_interface,
1353
(args[0], args[1]))
1354
self.assertIn(expected_call, self.bus.calls)
1355
1356
def test_get_clients_and_properties(self):
1357
managed_objects = {
1358
"objectpath": {
1359
self.bus._client_interface: {
1360
"key": "value",
1361
"bool": True,
1362
},
1363
"irrelevant_interface": {
1364
"key": "othervalue",
1365
"bool": False,
1366
},
1367
},
1368
"other_objectpath": {
1369
"other_irrelevant_interface": {
1370
"key": "value 3",
1371
"bool": None,
1372
},
1373
},
1374
}
1375
expected_clients_and_properties = {
1376
"objectpath": {
1377
"key": "value",
1378
"bool": True,
1379
}
1380
}
1381
self.bus.call_method_return = managed_objects
1382
ret = self.bus.get_clients_and_properties()
1383
self.assertDictEqual(expected_clients_and_properties, ret)
1384
expected_call = ("GetManagedObjects", self.bus._name,
1385
self.bus._server_path,
1386
"org.freedesktop.DBus.ObjectManager", ())
1387
self.assertIn(expected_call, self.bus.calls)
1388
1389
def test_call_server_method(self):
1390
ret = self.bus.call_server_method("methodname")
1391
self.assertIs(self.bus.call_method_return, ret)
1392
expected_call = ("methodname", self.bus._name,
1393
self.bus._server_path,
1394
self.bus._server_interface, ())
1395
self.assertIn(expected_call, self.bus.calls)
1396
1397
def test_call_server_method_with_args(self):
1398
args = (Unique(), Unique())
1399
ret = self.bus.call_server_method("methodname", *args)
1400
self.assertIs(self.bus.call_method_return, ret)
1401
expected_call = ("methodname", self.bus._name,
1402
self.bus._server_path,
1403
self.bus._server_interface,
1404
(args[0], args[1]))
1405
self.assertIn(expected_call, self.bus.calls)
1406
1407
1408
class Test_dbus_python_adapter_SystemBus(TestCaseWithAssertLogs):
1409
1410
def MockDBusPython_func(self, func):
1411
class mock_dbus_python:
1412
"""mock dbus-python module"""
1413
class exceptions:
1414
"""Pseudo-namespace"""
1415
class DBusException(Exception):
1416
pass
1417
class SystemBus:
1418
@staticmethod
1419
def get_object(busname, objectpath):
1420
DBusObject = collections.namedtuple(
1421
"DBusObject", ("methodname", "Set"))
1422
def method(*args, **kwargs):
1423
self.assertEqual({"dbus_interface":
1424
"interface"},
1425
kwargs)
1426
return func(*args)
1427
def set_property(interface, key, value,
1428
dbus_interface=None):
1429
self.assertEqual(
1430
"org.freedesktop.DBus.Properties",
1431
dbus_interface)
1432
self.assertEqual("Secret", key)
1433
return func(interface, key, value,
1434
dbus_interface=dbus_interface)
1435
return DBusObject(methodname=method,
1436
Set=set_property)
1437
class Boolean:
1438
def __init__(self, value):
1439
self.value = bool(value)
1440
def __bool__(self):
1441
return self.value
1442
if sys.version_info.major == 2:
1443
__nonzero__ = __bool__
1444
class ObjectPath(str):
1445
pass
1446
class Dictionary(dict):
1447
pass
1448
class ByteArray(bytes):
1449
pass
1450
return mock_dbus_python
1451
1452
def call_method(self, bus, methodname, busname, objectpath,
1453
interface, *args):
1454
with self.assertLogs(log, logging.DEBUG):
1455
return bus.call_method(methodname, busname, objectpath,
1456
interface, *args)
1457
1458
def test_call_method_returns(self):
1459
expected_method_return = Unique()
1460
method_args = (Unique(), Unique())
1461
def func(*args):
1462
self.assertEqual(len(method_args), len(args))
1463
for marg, arg in zip(method_args, args):
1464
self.assertIs(marg, arg)
1465
return expected_method_return
1466
mock_dbus_python = self.MockDBusPython_func(func)
1467
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1468
ret = self.call_method(bus, "methodname", "busname",
1469
"objectpath", "interface",
1470
*method_args)
1471
self.assertIs(ret, expected_method_return)
1472
1473
def test_call_method_filters_bool_true(self):
1474
def func():
1475
return method_return
1476
mock_dbus_python = self.MockDBusPython_func(func)
1477
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1478
method_return = mock_dbus_python.Boolean(True)
1479
ret = self.call_method(bus, "methodname", "busname",
1480
"objectpath", "interface")
1481
self.assertTrue(ret)
1482
self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1483
1484
def test_call_method_filters_bool_false(self):
1485
def func():
1486
return method_return
1487
mock_dbus_python = self.MockDBusPython_func(func)
1488
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1489
method_return = mock_dbus_python.Boolean(False)
1490
ret = self.call_method(bus, "methodname", "busname",
1491
"objectpath", "interface")
1492
self.assertFalse(ret)
1493
self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1494
1495
def test_call_method_filters_objectpath(self):
1496
def func():
1497
return method_return
1498
mock_dbus_python = self.MockDBusPython_func(func)
1499
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1500
method_return = mock_dbus_python.ObjectPath("objectpath")
1501
ret = self.call_method(bus, "methodname", "busname",
1502
"objectpath", "interface")
1503
self.assertEqual("objectpath", ret)
1504
self.assertIsNot("objectpath", ret)
1505
self.assertNotIsInstance(ret, mock_dbus_python.ObjectPath)
1506
1507
def test_call_method_filters_booleans_in_dict(self):
1508
def func():
1509
return method_return
1510
mock_dbus_python = self.MockDBusPython_func(func)
1511
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1512
method_return = mock_dbus_python.Dictionary(
1513
{mock_dbus_python.Boolean(True):
1514
mock_dbus_python.Boolean(False),
1515
mock_dbus_python.Boolean(False):
1516
mock_dbus_python.Boolean(True)})
1517
ret = self.call_method(bus, "methodname", "busname",
1518
"objectpath", "interface")
1519
expected_method_return = {True: False,
1520
False: True}
1521
self.assertEqual(expected_method_return, ret)
1522
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1523
1524
def test_call_method_filters_objectpaths_in_dict(self):
1525
def func():
1526
return method_return
1527
mock_dbus_python = self.MockDBusPython_func(func)
1528
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1529
method_return = mock_dbus_python.Dictionary(
1530
{mock_dbus_python.ObjectPath("objectpath_key_1"):
1531
mock_dbus_python.ObjectPath("objectpath_value_1"),
1532
mock_dbus_python.ObjectPath("objectpath_key_2"):
1533
mock_dbus_python.ObjectPath("objectpath_value_2")})
1534
ret = self.call_method(bus, "methodname", "busname",
1535
"objectpath", "interface")
1536
expected_method_return = {str(key): str(value)
1537
for key, value in
1538
method_return.items()}
1539
self.assertEqual(expected_method_return, ret)
1540
self.assertIsInstance(ret, dict)
1541
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1542
1543
def test_call_method_filters_dict_in_dict(self):
1544
def func():
1545
return method_return
1546
mock_dbus_python = self.MockDBusPython_func(func)
1547
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1548
method_return = mock_dbus_python.Dictionary(
1549
{"key1": mock_dbus_python.Dictionary({"key11": "value11",
1550
"key12": "value12"}),
1551
"key2": mock_dbus_python.Dictionary({"key21": "value21",
1552
"key22": "value22"})})
1553
ret = self.call_method(bus, "methodname", "busname",
1554
"objectpath", "interface")
1555
expected_method_return = {
1556
"key1": {"key11": "value11",
1557
"key12": "value12"},
1558
"key2": {"key21": "value21",
1559
"key22": "value22"},
1560
}
1561
self.assertEqual(expected_method_return, ret)
1562
self.assertIsInstance(ret, dict)
1563
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1564
for key, value in ret.items():
1565
self.assertIsInstance(value, dict)
1566
self.assertEqual(expected_method_return[key], value)
1567
self.assertNotIsInstance(value,
1568
mock_dbus_python.Dictionary)
1569
1570
def test_call_method_filters_dict_three_deep(self):
1571
def func():
1572
return method_return
1573
mock_dbus_python = self.MockDBusPython_func(func)
1574
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1575
method_return = mock_dbus_python.Dictionary(
1576
{"key1":
1577
mock_dbus_python.Dictionary(
1578
{"key2":
1579
mock_dbus_python.Dictionary(
1580
{"key3":
1581
mock_dbus_python.Boolean(True),
1582
}),
1583
}),
1584
})
1585
ret = self.call_method(bus, "methodname", "busname",
1586
"objectpath", "interface")
1587
expected_method_return = {"key1": {"key2": {"key3": True}}}
1588
self.assertEqual(expected_method_return, ret)
1589
self.assertIsInstance(ret, dict)
1590
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1591
self.assertIsInstance(ret["key1"], dict)
1592
self.assertNotIsInstance(ret["key1"],
1593
mock_dbus_python.Dictionary)
1594
self.assertIsInstance(ret["key1"]["key2"], dict)
1595
self.assertNotIsInstance(ret["key1"]["key2"],
1596
mock_dbus_python.Dictionary)
1597
self.assertTrue(ret["key1"]["key2"]["key3"])
1598
self.assertNotIsInstance(ret["key1"]["key2"]["key3"],
1599
mock_dbus_python.Boolean)
1600
1601
def test_call_method_handles_exception(self):
1117
1602
dbus_logger = logging.getLogger("dbus.proxies")
1118
1603
1119
class ObjectManagerFailingStub(object):
1120
def GetManagedObjects(self):
1121
dbus_logger.error("Test")
1122
raise dbus.exceptions.DBusException("Test")
1604
def func():
1605
dbus_logger.error("Test")
1606
raise mock_dbus_python.exceptions.DBusException()
1607
1608
mock_dbus_python = self.MockDBusPython_func(func)
1609
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1123
1610
1124
1611
class CountingHandler(logging.Handler):
1125
1612
count = 0
1131
1618
dbus_logger.addHandler(counting_handler)
1132
1619
1133
1620
try:
1134
with self.assertLogs(log, logging.CRITICAL) as watcher:
1135
with self.assertRaises(SystemExit) as e:
1136
get_managed_objects(ObjectManagerFailingStub())
1621
with self.assertRaises(dbus.Error) as e:
1622
self.call_method(bus, "methodname", "busname",
1623
"objectpath", "interface")
1137
1624
finally:
1138
1625
dbus_logger.removeFilter(counting_handler)
1139
1626
1627
self.assertNotIsInstance(e.exception, dbus.ConnectFailed)
1628
1140
1629
# Make sure the dbus logger was suppressed
1141
1630
self.assertEqual(0, counting_handler.count)
1142
1631
1143
# Test that the dbus_logger still works
1144
with self.assertLogs(dbus_logger, logging.ERROR):
1145
dbus_logger.error("Test")
1146
1147
if isinstance(e.exception.code, int):
1148
self.assertNotEqual(0, e.exception.code)
1149
else:
1150
self.assertIsNotNone(e.exception.code)
1632
def test_Set_Secret_sends_bytearray(self):
1633
ret = [None]
1634
def func(*args, **kwargs):
1635
ret[0] = (args, kwargs)
1636
mock_dbus_python = self.MockDBusPython_func(func)
1637
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1638
bus.set_client_property("objectpath", "Secret", "value")
1639
expected_call = (("se.recompile.Mandos.Client", "Secret",
1640
mock_dbus_python.ByteArray(b"value")),
1641
{"dbus_interface":
1642
"org.freedesktop.DBus.Properties"})
1643
self.assertEqual(expected_call, ret[0])
1644
if sys.version_info.major == 2:
1645
self.assertIsInstance(ret[0][0][-1],
1646
mock_dbus_python.ByteArray)
1647
1648
def test_get_object_converts_to_correct_exception(self):
1649
bus = dbus_python_adapter.SystemBus(
1650
self.fake_dbus_python_raises_exception_on_connect)
1651
with self.assertRaises(dbus.ConnectFailed):
1652
self.call_method(bus, "methodname", "busname",
1653
"objectpath", "interface")
1654
1655
class fake_dbus_python_raises_exception_on_connect:
1656
"""fake dbus-python module"""
1657
class exceptions:
1658
"""Pseudo-namespace"""
1659
class DBusException(Exception):
1660
pass
1661
1662
@classmethod
1663
def SystemBus(cls):
1664
def get_object(busname, objectpath):
1665
raise cls.exceptions.DBusException()
1666
Bus = collections.namedtuple("Bus", ["get_object"])
1667
return Bus(get_object=get_object)
1668
1669
1670
class Test_dbus_python_adapter_CachingBus(unittest.TestCase):
1671
class mock_dbus_python:
1672
"""mock dbus-python modules"""
1673
class SystemBus:
1674
@staticmethod
1675
def get_object(busname, objectpath):
1676
return Unique()
1677
1678
def setUp(self):
1679
self.bus = dbus_python_adapter.CachingBus(
1680
self.mock_dbus_python)
1681
1682
def test_returns_distinct_objectpaths(self):
1683
obj1 = self.bus.get_object("busname", "objectpath1")
1684
self.assertIsInstance(obj1, Unique)
1685
obj2 = self.bus.get_object("busname", "objectpath2")
1686
self.assertIsInstance(obj2, Unique)
1687
self.assertIsNot(obj1, obj2)
1688
1689
def test_returns_distinct_busnames(self):
1690
obj1 = self.bus.get_object("busname1", "objectpath")
1691
self.assertIsInstance(obj1, Unique)
1692
obj2 = self.bus.get_object("busname2", "objectpath")
1693
self.assertIsInstance(obj2, Unique)
1694
self.assertIsNot(obj1, obj2)
1695
1696
def test_returns_distinct_both(self):
1697
obj1 = self.bus.get_object("busname1", "objectpath")
1698
self.assertIsInstance(obj1, Unique)
1699
obj2 = self.bus.get_object("busname2", "objectpath")
1700
self.assertIsInstance(obj2, Unique)
1701
self.assertIsNot(obj1, obj2)
1702
1703
def test_returns_same(self):
1704
obj1 = self.bus.get_object("busname", "objectpath")
1705
self.assertIsInstance(obj1, Unique)
1706
obj2 = self.bus.get_object("busname", "objectpath")
1707
self.assertIsInstance(obj2, Unique)
1708
self.assertIs(obj1, obj2)
1709
1710
def test_returns_same_old(self):
1711
obj1 = self.bus.get_object("busname1", "objectpath1")
1712
self.assertIsInstance(obj1, Unique)
1713
obj2 = self.bus.get_object("busname2", "objectpath2")
1714
self.assertIsInstance(obj2, Unique)
1715
obj1b = self.bus.get_object("busname1", "objectpath1")
1716
self.assertIsInstance(obj1b, Unique)
1717
self.assertIsNot(obj1, obj2)
1718
self.assertIsNot(obj2, obj1b)
1719
self.assertIs(obj1, obj1b)
1720
1721
1722
class Test_pydbus_adapter_SystemBus(TestCaseWithAssertLogs):
1723
1724
def Stub_pydbus_func(self, func):
1725
class stub_pydbus:
1726
"""stub pydbus module"""
1727
class SystemBus:
1728
@staticmethod
1729
def get(busname, objectpath):
1730
DBusObject = collections.namedtuple(
1731
"DBusObject", ("methodname",))
1732
return {"interface":
1733
DBusObject(methodname=func)}
1734
return stub_pydbus
1735
1736
def call_method(self, bus, methodname, busname, objectpath,
1737
interface, *args):
1738
with self.assertLogs(log, logging.DEBUG):
1739
return bus.call_method(methodname, busname, objectpath,
1740
interface, *args)
1741
1742
def test_call_method_returns(self):
1743
expected_method_return = Unique()
1744
method_args = (Unique(), Unique())
1745
def func(*args):
1746
self.assertEqual(len(method_args), len(args))
1747
for marg, arg in zip(method_args, args):
1748
self.assertIs(marg, arg)
1749
return expected_method_return
1750
stub_pydbus = self.Stub_pydbus_func(func)
1751
bus = pydbus_adapter.SystemBus(stub_pydbus)
1752
ret = self.call_method(bus, "methodname", "busname",
1753
"objectpath", "interface",
1754
*method_args)
1755
self.assertIs(ret, expected_method_return)
1756
1757
def test_call_method_handles_exception(self):
1758
def func():
1759
raise gi.repository.GLib.Error()
1760
1761
stub_pydbus = self.Stub_pydbus_func(func)
1762
bus = pydbus_adapter.SystemBus(stub_pydbus)
1763
1764
with self.assertRaises(dbus.Error) as e:
1765
self.call_method(bus, "methodname", "busname",
1766
"objectpath", "interface")
1767
1768
self.assertNotIsInstance(e.exception, dbus.ConnectFailed)
1769
1770
def test_get_converts_to_correct_exception(self):
1771
bus = pydbus_adapter.SystemBus(
1772
self.fake_pydbus_raises_exception_on_connect)
1773
with self.assertRaises(dbus.ConnectFailed):
1774
self.call_method(bus, "methodname", "busname",
1775
"objectpath", "interface")
1776
1777
class fake_pydbus_raises_exception_on_connect:
1778
"""fake dbus-python module"""
1779
@classmethod
1780
def SystemBus(cls):
1781
def get(busname, objectpath):
1782
raise gi.repository.GLib.Error()
1783
Bus = collections.namedtuple("Bus", ["get"])
1784
return Bus(get=get)
1785
1786
def test_set_property_uses_setattr(self):
1787
class Object:
1788
pass
1789
obj = Object()
1790
class pydbus_spy:
1791
class SystemBus:
1792
@staticmethod
1793
def get(busname, objectpath):
1794
return {"interface": obj}
1795
bus = pydbus_adapter.SystemBus(pydbus_spy)
1796
value = Unique()
1797
bus.set_property("busname", "objectpath", "interface", "key",
1798
value)
1799
self.assertIs(value, obj.key)
1800
1801
def test_get_suppresses_xml_deprecation_warning(self):
1802
if sys.version_info.major >= 3:
1803
return
1804
class stub_pydbus_get:
1805
class SystemBus:
1806
@staticmethod
1807
def get(busname, objectpath):
1808
warnings.warn_explicit(
1809
"deprecated", DeprecationWarning,
1810
"xml.etree.ElementTree", 0)
1811
bus = pydbus_adapter.SystemBus(stub_pydbus_get)
1812
with warnings.catch_warnings(record=True) as w:
1813
warnings.simplefilter("always")
1814
bus.get("busname", "objectpath")
1815
self.assertEqual(0, len(w))
1816
1817
1818
class Test_pydbus_adapter_CachingBus(unittest.TestCase):
1819
class stub_pydbus:
1820
"""stub pydbus module"""
1821
class SystemBus:
1822
@staticmethod
1823
def get(busname, objectpath):
1824
return Unique()
1825
1826
def setUp(self):
1827
self.bus = pydbus_adapter.CachingBus(self.stub_pydbus)
1828
1829
def test_returns_distinct_objectpaths(self):
1830
obj1 = self.bus.get("busname", "objectpath1")
1831
self.assertIsInstance(obj1, Unique)
1832
obj2 = self.bus.get("busname", "objectpath2")
1833
self.assertIsInstance(obj2, Unique)
1834
self.assertIsNot(obj1, obj2)
1835
1836
def test_returns_distinct_busnames(self):
1837
obj1 = self.bus.get("busname1", "objectpath")
1838
self.assertIsInstance(obj1, Unique)
1839
obj2 = self.bus.get("busname2", "objectpath")
1840
self.assertIsInstance(obj2, Unique)
1841
self.assertIsNot(obj1, obj2)
1842
1843
def test_returns_distinct_both(self):
1844
obj1 = self.bus.get("busname1", "objectpath")
1845
self.assertIsInstance(obj1, Unique)
1846
obj2 = self.bus.get("busname2", "objectpath")
1847
self.assertIsInstance(obj2, Unique)
1848
self.assertIsNot(obj1, obj2)
1849
1850
def test_returns_same(self):
1851
obj1 = self.bus.get("busname", "objectpath")
1852
self.assertIsInstance(obj1, Unique)
1853
obj2 = self.bus.get("busname", "objectpath")
1854
self.assertIsInstance(obj2, Unique)
1855
self.assertIs(obj1, obj2)
1856
1857
def test_returns_same_old(self):
1858
obj1 = self.bus.get("busname1", "objectpath1")
1859
self.assertIsInstance(obj1, Unique)
1860
obj2 = self.bus.get("busname2", "objectpath2")
1861
self.assertIsInstance(obj2, Unique)
1862
obj1b = self.bus.get("busname1", "objectpath1")
1863
self.assertIsInstance(obj1b, Unique)
1864
self.assertIsNot(obj1, obj2)
1865
self.assertIsNot(obj2, obj1b)
1866
self.assertIs(obj1, obj1b)
1867
1868
1869
class Test_dbussy_adapter_SystemBus(TestCaseWithAssertLogs):
1870
1871
class dummy_dbussy:
1872
class DBUS:
1873
class ObjectPath(str):
1874
pass
1875
class DBusError(Exception):
1876
pass
1877
1878
def fake_ravel_func(self, func):
1879
class fake_ravel:
1880
@staticmethod
1881
def system_bus():
1882
class DBusInterfaceProxy:
1883
@staticmethod
1884
def methodname(*args):
1885
return [func(*args)]
1886
class DBusObject:
1887
@staticmethod
1888
def get_interface(interface):
1889
if interface == "interface":
1890
return DBusInterfaceProxy()
1891
return {"busname": {"objectpath": DBusObject()}}
1892
return fake_ravel
1893
1894
def call_method(self, bus, methodname, busname, objectpath,
1895
interface, *args):
1896
with self.assertLogs(log, logging.DEBUG):
1897
return bus.call_method(methodname, busname, objectpath,
1898
interface, *args)
1899
1900
def test_call_method_returns(self):
1901
expected_method_return = Unique()
1902
method_args = (Unique(), Unique())
1903
def func(*args):
1904
self.assertEqual(len(method_args), len(args))
1905
for marg, arg in zip(method_args, args):
1906
self.assertIs(marg, arg)
1907
return expected_method_return
1908
fake_ravel = self.fake_ravel_func(func)
1909
bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
1910
ret = self.call_method(bus, "methodname", "busname",
1911
"objectpath", "interface",
1912
*method_args)
1913
self.assertIs(ret, expected_method_return)
1914
1915
def test_call_method_filters_objectpath(self):
1916
def func():
1917
return method_return
1918
fake_ravel = self.fake_ravel_func(func)
1919
bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
1920
method_return = (self.dummy_dbussy.DBUS
1921
.ObjectPath("objectpath"))
1922
ret = self.call_method(bus, "methodname", "busname",
1923
"objectpath", "interface")
1924
self.assertEqual("objectpath", ret)
1925
self.assertNotIsInstance(ret,
1926
self.dummy_dbussy.DBUS.ObjectPath)
1927
1928
def test_call_method_filters_objectpaths_in_dict(self):
1929
ObjectPath = self.dummy_dbussy.DBUS.ObjectPath
1930
def func():
1931
return method_return
1932
fake_ravel = self.fake_ravel_func(func)
1933
bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
1934
method_return = {
1935
ObjectPath("objectpath_key_1"):
1936
ObjectPath("objectpath_value_1"),
1937
ObjectPath("objectpath_key_2"):
1938
ObjectPath("objectpath_value_2"),
1939
}
1940
ret = self.call_method(bus, "methodname", "busname",
1941
"objectpath", "interface")
1942
expected_method_return = {str(key): str(value)
1943
for key, value in
1944
method_return.items()}
1945
for key, value in ret.items():
1946
self.assertNotIsInstance(key, ObjectPath)
1947
self.assertNotIsInstance(value, ObjectPath)
1948
self.assertEqual(expected_method_return, ret)
1949
self.assertIsInstance(ret, dict)
1950
1951
def test_call_method_filters_objectpaths_in_dict_in_dict(self):
1952
ObjectPath = self.dummy_dbussy.DBUS.ObjectPath
1953
def func():
1954
return method_return
1955
fake_ravel = self.fake_ravel_func(func)
1956
bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
1957
method_return = {
1958
ObjectPath("key1"): {
1959
ObjectPath("key11"): ObjectPath("value11"),
1960
ObjectPath("key12"): ObjectPath("value12"),
1961
},
1962
ObjectPath("key2"): {
1963
ObjectPath("key21"): ObjectPath("value21"),
1964
ObjectPath("key22"): ObjectPath("value22"),
1965
},
1966
}
1967
ret = self.call_method(bus, "methodname", "busname",
1968
"objectpath", "interface")
1969
expected_method_return = {
1970
"key1": {"key11": "value11",
1971
"key12": "value12"},
1972
"key2": {"key21": "value21",
1973
"key22": "value22"},
1974
}
1975
self.assertEqual(expected_method_return, ret)
1976
for key, value in ret.items():
1977
self.assertIsInstance(value, dict)
1978
self.assertEqual(expected_method_return[key], value)
1979
self.assertNotIsInstance(key, ObjectPath)
1980
for inner_key, inner_value in value.items():
1981
self.assertIsInstance(value, dict)
1982
self.assertEqual(
1983
expected_method_return[key][inner_key],
1984
inner_value)
1985
self.assertNotIsInstance(key, ObjectPath)
1986
1987
def test_call_method_filters_objectpaths_in_dict_three_deep(self):
1988
ObjectPath = self.dummy_dbussy.DBUS.ObjectPath
1989
def func():
1990
return method_return
1991
fake_ravel = self.fake_ravel_func(func)
1992
bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
1993
method_return = {
1994
ObjectPath("key1"): {
1995
ObjectPath("key2"): {
1996
ObjectPath("key3"): ObjectPath("value"),
1997
},
1998
},
1999
}
2000
ret = self.call_method(bus, "methodname", "busname",
2001
"objectpath", "interface")
2002
expected_method_return = {"key1": {"key2": {"key3": "value"}}}
2003
self.assertEqual(expected_method_return, ret)
2004
self.assertIsInstance(ret, dict)
2005
self.assertNotIsInstance(next(iter(ret.keys())), ObjectPath)
2006
self.assertIsInstance(ret["key1"], dict)
2007
self.assertNotIsInstance(next(iter(ret["key1"].keys())),
2008
ObjectPath)
2009
self.assertIsInstance(ret["key1"]["key2"], dict)
2010
self.assertNotIsInstance(
2011
next(iter(ret["key1"]["key2"].keys())),
2012
ObjectPath)
2013
self.assertEqual("value", ret["key1"]["key2"]["key3"])
2014
self.assertNotIsInstance(ret["key1"]["key2"]["key3"],
2015
self.dummy_dbussy.DBUS.ObjectPath)
2016
2017
def test_call_method_handles_exception(self):
2018
def func():
2019
raise self.dummy_dbussy.DBusError()
2020
2021
fake_ravel = self.fake_ravel_func(func)
2022
bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
2023
2024
with self.assertRaises(dbus.Error) as e:
2025
self.call_method(bus, "methodname", "busname",
2026
"objectpath", "interface")
2027
2028
self.assertNotIsInstance(e.exception, dbus.ConnectFailed)
2029
2030
def test_get_object_converts_to_correct_exception(self):
2031
class fake_ravel_raises_exception_on_connect:
2032
@staticmethod
2033
def system_bus():
2034
class Bus:
2035
@staticmethod
2036
def __getitem__(key):
2037
if key == "objectpath":
2038
raise self.dummy_dbussy.DBusError()
2039
raise Exception(key)
2040
return {"busname": Bus()}
2041
def func():
2042
raise self.dummy_dbussy.DBusError()
2043
bus = dbussy_adapter.SystemBus(
2044
self.dummy_dbussy,
2045
fake_ravel_raises_exception_on_connect)
2046
with self.assertRaises(dbus.ConnectFailed):
2047
self.call_method(bus, "methodname", "busname",
2048
"objectpath", "interface")
1151
2049
1152
2050
1153
2051
class Test_commands_from_options(unittest.TestCase):
2052
1154
2053
def setUp(self):
1155
2054
self.parser = argparse.ArgumentParser()
1156
2055
add_command_line_options(self.parser)
1159
2058
self.assert_command_from_args(["--is-enabled", "client"],
1160
2059
command.IsEnabled)
1161
2060
1162
def assert_command_from_args(self, args, command_cls,
1163
**cmd_attrs):
2061
def assert_command_from_args(self, args, command_cls, length=1,
2062
clients=None, **cmd_attrs):
1164
2063
"""Assert that parsing ARGS should result in an instance of
1165
2064
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
1166
2065
options = self.parser.parse_args(args)
1167
2066
check_option_syntax(self.parser, options)
1168
2067
commands = commands_from_options(options)
1169
self.assertEqual(1, len(commands))
1170
command = commands[0]
1171
self.assertIsInstance(command, command_cls)
2068
self.assertEqual(length, len(commands))
2069
for command in commands:
2070
if isinstance(command, command_cls):
2071
break
2072
else:
2073
self.assertIsInstance(command, command_cls)
2074
if clients is not None:
2075
self.assertEqual(clients, options.client)
1172
2076
for key, value in cmd_attrs.items():
1173
2077
self.assertEqual(value, getattr(command, key))
1174
2078
2079
def assert_commands_from_args(self, args, commands, clients=None):
2080
for cmd in commands:
2081
self.assert_command_from_args(args, cmd,
2082
length=len(commands),
2083
clients=clients)
2084
1175
2085
def test_is_enabled_short(self):
1176
2086
self.assert_command_from_args(["-V", "client"],
1177
2087
command.IsEnabled)
1368
2278
verbose=True)
1369
2279
1370
2280
2281
def test_manual_page_example_1(self):
2282
self.assert_command_from_args("",
2283
command.PrintTable,
2284
clients=[],
2285
verbose=False)
2286
2287
def test_manual_page_example_2(self):
2288
self.assert_command_from_args(
2289
"--verbose foo1.example.org foo2.example.org".split(),
2290
command.PrintTable, clients=["foo1.example.org",
2291
"foo2.example.org"],
2292
verbose=True)
2293
2294
def test_manual_page_example_3(self):
2295
self.assert_command_from_args("--enable --all".split(),
2296
command.Enable,
2297
clients=[])
2298
2299
def test_manual_page_example_4(self):
2300
self.assert_commands_from_args(
2301
("--timeout=PT5M --interval=PT1M foo1.example.org"
2302
" foo2.example.org").split(),
2303
[command.SetTimeout, command.SetInterval],
2304
clients=["foo1.example.org", "foo2.example.org"])
2305
2306
def test_manual_page_example_5(self):
2307
self.assert_command_from_args("--approve --all".split(),
2308
command.Approve,
2309
clients=[])
2310
2311
1371
2312
class TestCommand(unittest.TestCase):
1372
2313
"""Abstract class for tests of command classes"""
1373
2314
2315
class FakeMandosBus(dbus.MandosBus):
2316
def __init__(self, testcase):
2317
self.client_properties = {
2318
"Name": "foo",
2319
"KeyID": ("92ed150794387c03ce684574b1139a65"
2320
"94a34f895daaaf09fd8ea90a27cddb12"),
2321
"Secret": b"secret",
2322
"Host": "foo.example.org",
2323
"Enabled": True,
2324
"Timeout": 300000,
2325
"LastCheckedOK": "2019-02-03T00:00:00",
2326
"Created": "2019-01-02T00:00:00",
2327
"Interval": 120000,
2328
"Fingerprint": ("778827225BA7DE539C5A"
2329
"7CFA59CFF7CDBD9A5920"),
2330
"CheckerRunning": False,
2331
"LastEnabled": "2019-01-03T00:00:00",
2332
"ApprovalPending": False,
2333
"ApprovedByDefault": True,
2334
"LastApprovalRequest": "",
2335
"ApprovalDelay": 0,
2336
"ApprovalDuration": 1000,
2337
"Checker": "fping -q -- %(host)s",
2338
"ExtendedTimeout": 900000,
2339
"Expires": "2019-02-04T00:00:00",
2340
"LastCheckerStatus": 0,
2341
}
2342
self.other_client_properties = {
2343
"Name": "barbar",
2344
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
2345
"6ab612cff5ad227247e46c2b020f441c"),
2346
"Secret": b"secretbar",
2347
"Host": "192.0.2.3",
2348
"Enabled": True,
2349
"Timeout": 300000,
2350
"LastCheckedOK": "2019-02-04T00:00:00",
2351
"Created": "2019-01-03T00:00:00",
2352
"Interval": 120000,
2353
"Fingerprint": ("3E393AEAEFB84C7E89E2"
2354
"F547B3A107558FCA3A27"),
2355
"CheckerRunning": True,
2356
"LastEnabled": "2019-01-04T00:00:00",
2357
"ApprovalPending": False,
2358
"ApprovedByDefault": False,
2359
"LastApprovalRequest": "2019-01-03T00:00:00",
2360
"ApprovalDelay": 30000,
2361
"ApprovalDuration": 93785000,
2362
"Checker": ":",
2363
"ExtendedTimeout": 900000,
2364
"Expires": "2019-02-05T00:00:00",
2365
"LastCheckerStatus": -2,
2366
}
2367
self.clients = collections.OrderedDict(
2368
[
2369
("client_objectpath", self.client_properties),
2370
("other_client_objectpath",
2371
self.other_client_properties),
2372
])
2373
self.one_client = {"client_objectpath":
2374
self.client_properties}
2375
self.testcase = testcase
2376
self.calls = []
2377
2378
def call_method(self, methodname, busname, objectpath,
2379
interface, *args):
2380
self.testcase.assertEqual("se.recompile.Mandos", busname)
2381
self.calls.append((methodname, busname, objectpath,
2382
interface, args))
2383
if interface == "org.freedesktop.DBus.Properties":
2384
if methodname == "Set":
2385
self.testcase.assertEqual(3, len(args))
2386
interface, key, value = args
2387
self.testcase.assertEqual(
2388
"se.recompile.Mandos.Client", interface)
2389
self.clients[objectpath][key] = value
2390
return
2391
elif interface == "se.recompile.Mandos":
2392
self.testcase.assertEqual("RemoveClient", methodname)
2393
self.testcase.assertEqual(1, len(args))
2394
clientpath = args[0]
2395
del self.clients[clientpath]
2396
return
2397
elif interface == "se.recompile.Mandos.Client":
2398
if methodname == "Approve":
2399
self.testcase.assertEqual(1, len(args))
2400
return
2401
raise ValueError()
2402
1374
2403
def setUp(self):
1375
testcase = self
1376
class MockClient(object):
1377
def __init__(self, name, **attributes):
1378
self.__dbus_object_path__ = "/clients/{}".format(name)
1379
self.attributes = attributes
1380
self.attributes["Name"] = name
1381
self.calls = []
1382
def Set(self, interface, propname, value, dbus_interface):
1383
testcase.assertEqual(client_dbus_interface, interface)
1384
testcase.assertEqual(dbus.PROPERTIES_IFACE,
1385
dbus_interface)
1386
self.attributes[propname] = value
1387
def Approve(self, approve, dbus_interface):
1388
testcase.assertEqual(client_dbus_interface,
1389
dbus_interface)
1390
self.calls.append(("Approve", (approve,
1391
dbus_interface)))
1392
self.client = MockClient(
1393
"foo",
1394
KeyID=("92ed150794387c03ce684574b1139a65"
1395
"94a34f895daaaf09fd8ea90a27cddb12"),
1396
Secret=b"secret",
1397
Host="foo.example.org",
1398
Enabled=dbus.Boolean(True),
1399
Timeout=300000,
1400
LastCheckedOK="2019-02-03T00:00:00",
1401
Created="2019-01-02T00:00:00",
1402
Interval=120000,
1403
Fingerprint=("778827225BA7DE539C5A"
1404
"7CFA59CFF7CDBD9A5920"),
1405
CheckerRunning=dbus.Boolean(False),
1406
LastEnabled="2019-01-03T00:00:00",
1407
ApprovalPending=dbus.Boolean(False),
1408
ApprovedByDefault=dbus.Boolean(True),
1409
LastApprovalRequest="",
1410
ApprovalDelay=0,
1411
ApprovalDuration=1000,
1412
Checker="fping -q -- %(host)s",
1413
ExtendedTimeout=900000,
1414
Expires="2019-02-04T00:00:00",
1415
LastCheckerStatus=0)
1416
self.other_client = MockClient(
1417
"barbar",
1418
KeyID=("0558568eedd67d622f5c83b35a115f79"
1419
"6ab612cff5ad227247e46c2b020f441c"),
1420
Secret=b"secretbar",
1421
Host="192.0.2.3",
1422
Enabled=dbus.Boolean(True),
1423
Timeout=300000,
1424
LastCheckedOK="2019-02-04T00:00:00",
1425
Created="2019-01-03T00:00:00",
1426
Interval=120000,
1427
Fingerprint=("3E393AEAEFB84C7E89E2"
1428
"F547B3A107558FCA3A27"),
1429
CheckerRunning=dbus.Boolean(True),
1430
LastEnabled="2019-01-04T00:00:00",
1431
ApprovalPending=dbus.Boolean(False),
1432
ApprovedByDefault=dbus.Boolean(False),
1433
LastApprovalRequest="2019-01-03T00:00:00",
1434
ApprovalDelay=30000,
1435
ApprovalDuration=93785000,
1436
Checker=":",
1437
ExtendedTimeout=900000,
1438
Expires="2019-02-05T00:00:00",
1439
LastCheckerStatus=-2)
1440
self.clients = collections.OrderedDict(
1441
[
1442
(self.client.__dbus_object_path__,
1443
self.client.attributes),
1444
(self.other_client.__dbus_object_path__,
1445
self.other_client.attributes),
1446
])
1447
self.one_client = {self.client.__dbus_object_path__:
1448
self.client.attributes}
1449
1450
@property
1451
def bus(self):
1452
class MockBus(object):
1453
@staticmethod
1454
def get_object(client_bus_name, path):
1455
self.assertEqual(dbus_busname, client_bus_name)
1456
# Note: "self" here is the TestCmd instance, not the
1457
# MockBus instance, since this is a static method!
1458
if path == self.client.__dbus_object_path__:
1459
return self.client
1460
elif path == self.other_client.__dbus_object_path__:
1461
return self.other_client
1462
return MockBus()
2404
self.bus = self.FakeMandosBus(self)
1463
2405
1464
2406
1465
2407
class TestBaseCommands(TestCommand):
1466
2408
1467
2409
def test_IsEnabled_exits_successfully(self):
1468
2410
with self.assertRaises(SystemExit) as e:
1469
command.IsEnabled().run(self.one_client)
2411
command.IsEnabled().run(self.bus.one_client)
1470
2412
if e.exception.code is not None:
1471
2413
self.assertEqual(0, e.exception.code)
1472
2414
else:
1473
2415
self.assertIsNone(e.exception.code)
1474
2416
1475
2417
def test_IsEnabled_exits_with_failure(self):
1476
self.client.attributes["Enabled"] = dbus.Boolean(False)
2418
self.bus.client_properties["Enabled"] = False
1477
2419
with self.assertRaises(SystemExit) as e:
1478
command.IsEnabled().run(self.one_client)
2420
command.IsEnabled().run(self.bus.one_client)
1479
2421
if isinstance(e.exception.code, int):
1480
2422
self.assertNotEqual(0, e.exception.code)
1481
2423
else:
1482
2424
self.assertIsNotNone(e.exception.code)
1483
2425
1484
2426
def test_Approve(self):
1485
command.Approve().run(self.clients, self.bus)
1486
for clientpath in self.clients:
1487
client = self.bus.get_object(dbus_busname, clientpath)
1488
self.assertIn(("Approve", (True, client_dbus_interface)),
1489
client.calls)
2427
busname = "se.recompile.Mandos"
2428
client_interface = "se.recompile.Mandos.Client"
2429
command.Approve().run(self.bus.clients, self.bus)
2430
self.assertTrue(self.bus.clients)
2431
for clientpath in self.bus.clients:
2432
self.assertIn(("Approve", busname, clientpath,
2433
client_interface, (True,)), self.bus.calls)
1490
2434
1491
2435
def test_Deny(self):
1492
command.Deny().run(self.clients, self.bus)
1493
for clientpath in self.clients:
1494
client = self.bus.get_object(dbus_busname, clientpath)
1495
self.assertIn(("Approve", (False, client_dbus_interface)),
1496
client.calls)
2436
busname = "se.recompile.Mandos"
2437
client_interface = "se.recompile.Mandos.Client"
2438
command.Deny().run(self.bus.clients, self.bus)
2439
self.assertTrue(self.bus.clients)
2440
for clientpath in self.bus.clients:
2441
self.assertIn(("Approve", busname, clientpath,
2442
client_interface, (False,)),
2443
self.bus.calls)
1497
2444
1498
2445
def test_Remove(self):
1499
class MandosSpy(object):
1500
def __init__(self):
1501
self.calls = []
1502
def RemoveClient(self, dbus_path):
1503
self.calls.append(("RemoveClient", (dbus_path,)))
1504
mandos = MandosSpy()
1505
command.Remove().run(self.clients, self.bus, mandos)
1506
for clientpath in self.clients:
1507
self.assertIn(("RemoveClient", (clientpath,)),
1508
mandos.calls)
2446
busname = "se.recompile.Mandos"
2447
server_path = "/"
2448
server_interface = "se.recompile.Mandos"
2449
orig_clients = self.bus.clients.copy()
2450
command.Remove().run(self.bus.clients, self.bus)
2451
self.assertFalse(self.bus.clients)
2452
for clientpath in orig_clients:
2453
self.assertIn(("RemoveClient", busname,
2454
server_path, server_interface,
2455
(clientpath,)), self.bus.calls)
1509
2456
1510
2457
expected_json = {
1511
2458
"foo": {
1560
2507
1561
2508
def test_DumpJSON_normal(self):
1562
2509
with self.capture_stdout_to_buffer() as buffer:
1563
command.DumpJSON().run(self.clients)
2510
command.DumpJSON().run(self.bus.clients)
1564
2511
json_data = json.loads(buffer.getvalue())
1565
2512
self.assertDictEqual(self.expected_json, json_data)
1566
2513
1577
2524
1578
2525
def test_DumpJSON_one_client(self):
1579
2526
with self.capture_stdout_to_buffer() as buffer:
1580
command.DumpJSON().run(self.one_client)
2527
command.DumpJSON().run(self.bus.one_client)
1581
2528
json_data = json.loads(buffer.getvalue())
1582
2529
expected_json = {"foo": self.expected_json["foo"]}
1583
2530
self.assertDictEqual(expected_json, json_data)
1584
2531
1585
2532
def test_PrintTable_normal(self):
1586
2533
with self.capture_stdout_to_buffer() as buffer:
1587
command.PrintTable().run(self.clients)
2534
command.PrintTable().run(self.bus.clients)
1588
2535
expected_output = "\n".join((
1589
2536
"Name Enabled Timeout Last Successful Check",
1590
2537
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1594
2541
1595
2542
def test_PrintTable_verbose(self):
1596
2543
with self.capture_stdout_to_buffer() as buffer:
1597
command.PrintTable(verbose=True).run(self.clients)
2544
command.PrintTable(verbose=True).run(self.bus.clients)
1598
2545
columns = (
1599
2546
(
1600
2547
"Name ",
1690
2637
1691
2638
def test_PrintTable_one_client(self):
1692
2639
with self.capture_stdout_to_buffer() as buffer:
1693
command.PrintTable().run(self.one_client)
2640
command.PrintTable().run(self.bus.one_client)
1694
2641
expected_output = "\n".join((
1695
2642
"Name Enabled Timeout Last Successful Check",
1696
2643
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1700
2647
1701
2648
class TestPropertySetterCmd(TestCommand):
1702
2649
"""Abstract class for tests of command.PropertySetter classes"""
2650
1703
2651
def runTest(self):
1704
2652
if not hasattr(self, "command"):
1705
return
1706
values_to_get = getattr(self, "values_to_get",
1707
self.values_to_set)
1708
for value_to_set, value_to_get in zip(self.values_to_set,
1709
values_to_get):
1710
for clientpath in self.clients:
1711
client = self.bus.get_object(dbus_busname, clientpath)
1712
old_value = client.attributes[self.propname]
1713
client.attributes[self.propname] = self.Unique()
1714
self.run_command(value_to_set, self.clients)
1715
for clientpath in self.clients:
1716
client = self.bus.get_object(dbus_busname, clientpath)
1717
value = client.attributes[self.propname]
1718
self.assertNotIsInstance(value, self.Unique)
2653
return # Abstract TestCase class
2654
2655
if hasattr(self, "values_to_set"):
2656
cmd_args = [(value,) for value in self.values_to_set]
2657
values_to_get = getattr(self, "values_to_get",
2658
self.values_to_set)
2659
else:
2660
cmd_args = [() for x in range(len(self.values_to_get))]
2661
values_to_get = self.values_to_get
2662
self.assertTrue(values_to_get)
2663
for value_to_get, cmd_arg in zip(values_to_get, cmd_args):
2664
for clientpath in self.bus.clients:
2665
self.bus.clients[clientpath][self.propname] = (
2666
Unique())
2667
self.command(*cmd_arg).run(self.bus.clients, self.bus)
2668
self.assertTrue(self.bus.clients)
2669
for clientpath in self.bus.clients:
2670
value = (self.bus.clients[clientpath]
2671
[self.propname])
2672
self.assertNotIsInstance(value, Unique)
1719
2673
self.assertEqual(value_to_get, value)
1720
2674
1721
class Unique(object):
1722
"""Class for objects which exist only to be unique objects,
1723
since unittest.mock.sentinel only exists in Python 3.3"""
1724
1725
def run_command(self, value, clients):
1726
self.command().run(clients, self.bus)
1727
1728
2675
1729
2676
class TestEnableCmd(TestPropertySetterCmd):
1730
2677
command = command.Enable
1731
2678
propname = "Enabled"
1732
values_to_set = [dbus.Boolean(True)]
2679
values_to_get = [True]
1733
2680
1734
2681
1735
2682
class TestDisableCmd(TestPropertySetterCmd):
1736
2683
command = command.Disable
1737
2684
propname = "Enabled"
1738
values_to_set = [dbus.Boolean(False)]
2685
values_to_get = [False]
1739
2686
1740
2687
1741
2688
class TestBumpTimeoutCmd(TestPropertySetterCmd):
1742
2689
command = command.BumpTimeout
1743
2690
propname = "LastCheckedOK"
1744
values_to_set = [""]
2691
values_to_get = [""]
1745
2692
1746
2693
1747
2694
class TestStartCheckerCmd(TestPropertySetterCmd):
1748
2695
command = command.StartChecker
1749
2696
propname = "CheckerRunning"
1750
values_to_set = [dbus.Boolean(True)]
2697
values_to_get = [True]
1751
2698
1752
2699
1753
2700
class TestStopCheckerCmd(TestPropertySetterCmd):
1754
2701
command = command.StopChecker
1755
2702
propname = "CheckerRunning"
1756
values_to_set = [dbus.Boolean(False)]
2703
values_to_get = [False]
1757
2704
1758
2705
1759
2706
class TestApproveByDefaultCmd(TestPropertySetterCmd):
1760
2707
command = command.ApproveByDefault
1761
2708
propname = "ApprovedByDefault"
1762
values_to_set = [dbus.Boolean(True)]
2709
values_to_get = [True]
1763
2710
1764
2711
1765
2712
class TestDenyByDefaultCmd(TestPropertySetterCmd):
1766
2713
command = command.DenyByDefault
1767
2714
propname = "ApprovedByDefault"
1768
values_to_set = [dbus.Boolean(False)]
1769
1770
1771
class TestPropertySetterValueCmd(TestPropertySetterCmd):
1772
"""Abstract class for tests of PropertySetterValueCmd classes"""
1773
1774
def runTest(self):
1775
if type(self) is TestPropertySetterValueCmd:
1776
return
1777
return super(TestPropertySetterValueCmd, self).runTest()
1778
1779
def run_command(self, value, clients):
1780
self.command(value).run(clients, self.bus)
1781
1782
1783
class TestSetCheckerCmd(TestPropertySetterValueCmd):
2715
values_to_get = [False]
2716
2717
2718
class TestSetCheckerCmd(TestPropertySetterCmd):
1784
2719
command = command.SetChecker
1785
2720
propname = "Checker"
1786
2721
values_to_set = ["", ":", "fping -q -- %s"]
1787
2722
1788
2723
1789
class TestSetHostCmd(TestPropertySetterValueCmd):
2724
class TestSetHostCmd(TestPropertySetterCmd):
1790
2725
command = command.SetHost
1791
2726
propname = "Host"
1792
2727
values_to_set = ["192.0.2.3", "client.example.org"]
1793
2728
1794
2729
1795
class TestSetSecretCmd(TestPropertySetterValueCmd):
2730
class TestSetSecretCmd(TestPropertySetterCmd):
1796
2731
command = command.SetSecret
1797
2732
propname = "Secret"
1798
values_to_set = [io.BytesIO(b""),
1799
io.BytesIO(b"secret\0xyzzy\nbar")]
1800
values_to_get = [f.getvalue() for f in values_to_set]
1801
1802
1803
class TestSetTimeoutCmd(TestPropertySetterValueCmd):
2733
def __init__(self, *args, **kwargs):
2734
self.values_to_set = [io.BytesIO(b""),
2735
io.BytesIO(b"secret\0xyzzy\nbar")]
2736
self.values_to_get = [f.getvalue() for f in
2737
self.values_to_set]
2738
super(TestSetSecretCmd, self).__init__(*args, **kwargs)
2739
2740
2741
class TestSetTimeoutCmd(TestPropertySetterCmd):
1804
2742
command = command.SetTimeout
1805
2743
propname = "Timeout"
1806
2744
values_to_set = [datetime.timedelta(),
1811
2749
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1812
2750
1813
2751
1814
class TestSetExtendedTimeoutCmd(TestPropertySetterValueCmd):
2752
class TestSetExtendedTimeoutCmd(TestPropertySetterCmd):
1815
2753
command = command.SetExtendedTimeout
1816
2754
propname = "ExtendedTimeout"
1817
2755
values_to_set = [datetime.timedelta(),
1822
2760
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1823
2761
1824
2762
1825
class TestSetIntervalCmd(TestPropertySetterValueCmd):
2763
class TestSetIntervalCmd(TestPropertySetterCmd):
1826
2764
command = command.SetInterval
1827
2765
propname = "Interval"
1828
2766
values_to_set = [datetime.timedelta(),
1833
2771
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1834
2772
1835
2773
1836
class TestSetApprovalDelayCmd(TestPropertySetterValueCmd):
2774
class TestSetApprovalDelayCmd(TestPropertySetterCmd):
1837
2775
command = command.SetApprovalDelay
1838
2776
propname = "ApprovalDelay"
1839
2777
values_to_set = [datetime.timedelta(),
1844
2782
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1845
2783
1846
2784
1847
class TestSetApprovalDurationCmd(TestPropertySetterValueCmd):
2785
class TestSetApprovalDurationCmd(TestPropertySetterCmd):
1848
2786
command = command.SetApprovalDuration
1849
2787
propname = "ApprovalDuration"
1850
2788
values_to_set = [datetime.timedelta(),
1856
2794
1857
2795
1858
2796
1859
def should_only_run_tests():
2797
def parse_test_args():
2798
# type: () -> argparse.Namespace
1860
2799
parser = argparse.ArgumentParser(add_help=False)
1861
parser.add_argument("--check", action='store_true')
2800
parser.add_argument("--check", action="store_true")
2801
parser.add_argument("--prefix", )
1862
2802
args, unknown_args = parser.parse_known_args()
1863
run_tests = args.check
1864
if run_tests:
1865
# Remove --check argument from sys.argv
2803
if args.check:
2804
# Remove test options from sys.argv
1866
2805
sys.argv[1:] = unknown_args
1867
return run_tests
2806
return args
1868
2807
1869
2808
# Add all tests from doctest strings
1870
2809
def load_tests(loader, tests, none):
1873
2812
return tests
1874
2813
1875
2814
if __name__ == "__main__":
2815
options = parse_test_args()
1876
2816
try:
1877
if should_only_run_tests():
1878
# Call using ./tdd-python-script --check [--verbose]
1879
unittest.main()
2817
if options.check:
2818
extra_test_prefix = options.prefix
2819
if extra_test_prefix is not None:
2820
if not (unittest.main(argv=[""], exit=False)
2821
.result.wasSuccessful()):
2822
sys.exit(1)
2823
class ExtraTestLoader(unittest.TestLoader):
2824
testMethodPrefix = extra_test_prefix
2825
# Call using ./scriptname --check [--verbose]
2826
unittest.main(argv=[""], testLoader=ExtraTestLoader())
2827
else:
2828
unittest.main(argv=[""])
1880
2829
else:
1881
2830
main()
1882
2831
finally:
1883
2832
logging.shutdown()
2833
2834
# Local Variables:
2835
# run-tests:
2836
# (lambda (&optional extra)
2837
# (if (not (funcall run-tests-in-test-buffer default-directory
2838
# extra))
2839
# (funcall show-test-buffer-in-test-window)
2840
# (funcall remove-test-window)
2841
# (if extra (message "Extra tests run successfully!"))))
2842
# run-tests-in-test-buffer:
2843
# (lambda (dir &optional extra)
2844
# (with-current-buffer (get-buffer-create "*Test*")
2845
# (setq buffer-read-only nil
2846
# default-directory dir)
2847
# (erase-buffer)
2848
# (compilation-mode))
2849
# (let ((process-result
2850
# (let ((inhibit-read-only t))
2851
# (process-file-shell-command
2852
# (funcall get-command-line extra) nil "*Test*"))))
2853
# (and (numberp process-result)
2854
# (= process-result 0))))
2855
# get-command-line:
2856
# (lambda (&optional extra)
2857
# (let ((quoted-script
2858
# (shell-quote-argument (funcall get-script-name))))
2859
# (format
2860
# (concat "%s --check" (if extra " --prefix=atest" ""))
2861
# quoted-script)))
2862
# get-script-name:
2863
# (lambda ()
2864
# (if (fboundp 'file-local-name)
2865
# (file-local-name (buffer-file-name))
2866
# (or (file-remote-p (buffer-file-name) 'localname)
2867
# (buffer-file-name))))
2868
# remove-test-window:
2869
# (lambda ()
2870
# (let ((test-window (get-buffer-window "*Test*")))
2871
# (if test-window (delete-window test-window))))
2872
# show-test-buffer-in-test-window:
2873
# (lambda ()
2874
# (when (not (get-buffer-window-list "*Test*"))
2875
# (setq next-error-last-buffer (get-buffer "*Test*"))
2876
# (let* ((side (if (>= (window-width) 146) 'right 'bottom))
2877
# (display-buffer-overriding-action
2878
# `((display-buffer-in-side-window) (side . ,side)
2879
# (window-height . fit-window-to-buffer)
2880
# (window-width . fit-window-to-buffer))))
2881
# (display-buffer "*Test*"))))
2882
# eval:
2883
# (progn
2884
# (let* ((run-extra-tests (lambda () (interactive)
2885
# (funcall run-tests t)))
2886
# (inner-keymap `(keymap (116 . ,run-extra-tests))) ; t
2887
# (outer-keymap `(keymap (3 . ,inner-keymap)))) ; C-c
2888
# (setq minor-mode-overriding-map-alist
2889
# (cons `(run-tests . ,outer-keymap)
2890
# minor-mode-overriding-map-alist)))
2891
# (add-hook 'after-save-hook run-tests 90 t))
2892
# End:
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0