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
90
import StringIO
91
io.StringIO = StringIO.StringIO
64
92
65
93
locale.setlocale(locale.LC_ALL, "")
66
94
67
dbus_busname_domain = "se.recompile"
68
dbus_busname = dbus_busname_domain + ".Mandos"
69
server_dbus_path = "/"
70
server_dbus_interface = dbus_busname_domain + ".Mandos"
71
client_dbus_interface = dbus_busname_domain + ".Mandos.Client"
72
del dbus_busname_domain
73
version = "1.8.3"
74
75
76
try:
77
dbus.OBJECT_MANAGER_IFACE
78
except AttributeError:
79
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
95
version = "1.8.16"
80
96
81
97
82
98
def main():
83
99
parser = argparse.ArgumentParser()
84
85
100
add_command_line_options(parser)
86
101
87
102
options = parser.parse_args()
88
89
103
check_option_syntax(parser, options)
90
104
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:
125
138
log.critical("Client not found on server: %r", name)
126
139
sys.exit(1)
127
140
128
# Run all commands on clients
129
141
commands = commands_from_options(options)
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):
234
289
...
235
ValueError: Invalid RFC 3339 duration: u''
290
ValueError: Invalid RFC 3339 duration: ""
236
291
>>> # Must start with "P":
237
292
>>> rfc3339_duration_to_delta("1D")
238
293
Traceback (most recent call last):
239
294
...
240
ValueError: Invalid RFC 3339 duration: u'1D'
295
ValueError: Invalid RFC 3339 duration: "1D"
241
296
>>> # Must use correct order
242
297
>>> rfc3339_duration_to_delta("PT1S2M")
243
298
Traceback (most recent call last):
244
299
...
245
ValueError: Invalid RFC 3339 duration: u'PT1S2M'
300
ValueError: Invalid RFC 3339 duration: "PT1S2M"
246
301
>>> # Time needs time marker
247
302
>>> rfc3339_duration_to_delta("P1H2S")
248
303
Traceback (most recent call last):
249
304
...
250
ValueError: Invalid RFC 3339 duration: u'P1H2S'
305
ValueError: Invalid RFC 3339 duration: "P1H2S"
251
306
>>> # Weeks can not be combined with anything else
252
307
>>> rfc3339_duration_to_delta("P1D2W")
253
308
Traceback (most recent call last):
254
309
...
255
ValueError: Invalid RFC 3339 duration: u'P1D2W'
310
ValueError: Invalid RFC 3339 duration: "P1D2W"
256
311
>>> rfc3339_duration_to_delta("P2W2H")
257
312
Traceback (most recent call last):
258
313
...
259
ValueError: Invalid RFC 3339 duration: u'P2W2H'
314
ValueError: Invalid RFC 3339 duration: "P2W2H"
260
315
"""
261
316
262
317
# Parsing an RFC 3339 duration with regular expressions is not
333
388
break
334
389
else:
335
390
# No currently valid tokens were found
336
raise ValueError("Invalid RFC 3339 duration: {!r}"
391
raise ValueError("Invalid RFC 3339 duration: \"{}\""
337
392
.format(duration))
338
393
# End token found
339
394
return value
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
return self
464
465
class NullFilter(logging.Filter):
466
def filter(self, record):
467
return False
468
469
nullfilter = NullFilter()
470
471
def __exit__(self, exc_type, exc_val, exc_tb):
472
self.logger.removeFilter(self.nullfilter)
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
473
798
474
799
475
800
def commands_from_options(options):
476
801
477
commands = []
478
479
if options.is_enabled:
480
commands.append(IsEnabledCmd())
481
482
if options.approve:
483
commands.append(ApproveCmd())
484
485
if options.deny:
486
commands.append(DenyCmd())
487
488
if options.remove:
489
commands.append(RemoveCmd())
490
491
if options.dump_json:
492
commands.append(DumpJSONCmd())
493
494
if options.enable:
495
commands.append(EnableCmd())
496
497
if options.disable:
498
commands.append(DisableCmd())
499
500
if options.bump_timeout:
501
commands.append(BumpTimeoutCmd())
502
503
if options.start_checker:
504
commands.append(StartCheckerCmd())
505
506
if options.stop_checker:
507
commands.append(StopCheckerCmd())
508
509
if options.approved_by_default is not None:
510
if options.approved_by_default:
511
commands.append(ApproveByDefaultCmd())
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)
512
820
else:
513
commands.append(DenyByDefaultCmd())
514
515
if options.checker is not None:
516
commands.append(SetCheckerCmd(options.checker))
517
518
if options.host is not None:
519
commands.append(SetHostCmd(options.host))
520
521
if options.secret is not None:
522
commands.append(SetSecretCmd(options.secret))
523
524
if options.timeout is not None:
525
commands.append(SetTimeoutCmd(options.timeout))
526
527
if options.extended_timeout:
528
commands.append(
529
SetExtendedTimeoutCmd(options.extended_timeout))
530
531
if options.interval is not None:
532
commands.append(SetIntervalCmd(options.interval))
533
534
if options.approval_delay is not None:
535
commands.append(SetApprovalDelayCmd(options.approval_delay))
536
537
if options.approval_duration is not None:
538
commands.append(
539
SetApprovalDurationCmd(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
543
827
if not commands:
544
commands.append(PrintTableCmd(verbose=options.verbose))
828
commands.append(command.PrintTable(verbose=options.verbose))
545
829
546
830
return commands
547
831
548
832
549
class Command(object):
550
"""Abstract class for commands"""
551
def run(self, clients, bus=None, mandos=None):
552
"""Normal commands should implement run_on_one_client(), but
553
commands which want to operate on all clients at the same time
554
can override this run() method instead."""
555
self.mandos = mandos
556
for clientpath, properties in clients.items():
557
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
558
dbus_busname, str(clientpath))
559
client = bus.get_object(dbus_busname, clientpath)
560
self.run_on_one_client(client, properties)
561
562
563
class IsEnabledCmd(Command):
564
def run(self, clients, bus=None, mandos=None):
565
client, properties = next(iter(clients.items()))
566
if self.is_enabled(client, properties):
567
sys.exit(0)
568
sys.exit(1)
569
def is_enabled(self, client, properties):
570
return properties["Enabled"]
571
572
573
class ApproveCmd(Command):
574
def run_on_one_client(self, client, properties):
575
log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
576
client.__dbus_object_path__, client_dbus_interface)
577
client.Approve(dbus.Boolean(True),
578
dbus_interface=client_dbus_interface)
579
580
581
class DenyCmd(Command):
582
def run_on_one_client(self, client, properties):
583
log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
584
client.__dbus_object_path__, client_dbus_interface)
585
client.Approve(dbus.Boolean(False),
586
dbus_interface=client_dbus_interface)
587
588
589
class RemoveCmd(Command):
590
def run_on_one_client(self, client, properties):
591
log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)", dbus_busname,
592
server_dbus_path, server_dbus_interface,
593
str(client.__dbus_object_path__))
594
self.mandos.RemoveClient(client.__dbus_object_path__)
595
596
597
class OutputCmd(Command):
598
"""Abstract class for commands outputting client details"""
599
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
600
"Created", "Interval", "Host", "KeyID",
601
"Fingerprint", "CheckerRunning", "LastEnabled",
602
"ApprovalPending", "ApprovedByDefault",
603
"LastApprovalRequest", "ApprovalDelay",
604
"ApprovalDuration", "Checker", "ExtendedTimeout",
605
"Expires", "LastCheckerStatus")
606
607
def run(self, clients, bus=None, mandos=None):
608
print(self.output(clients.values()))
609
610
def output(self, clients):
611
raise NotImplementedError()
612
613
614
class DumpJSONCmd(OutputCmd):
615
def output(self, clients):
616
data = {client["Name"]:
617
{key: self.dbus_boolean_to_bool(client[key])
618
for key in self.all_keywords}
619
for client in clients}
620
return json.dumps(data, indent=4, separators=(',', ': '))
621
622
@staticmethod
623
def dbus_boolean_to_bool(value):
624
if isinstance(value, dbus.Boolean):
625
value = bool(value)
626
return value
627
628
629
class PrintTableCmd(OutputCmd):
630
def __init__(self, verbose=False):
631
self.verbose = verbose
632
633
def output(self, clients):
634
default_keywords = ("Name", "Enabled", "Timeout",
635
"LastCheckedOK")
636
keywords = default_keywords
637
if self.verbose:
638
keywords = self.all_keywords
639
return str(self.TableOfClients(clients, keywords))
640
641
class TableOfClients(object):
642
tableheaders = {
643
"Name": "Name",
644
"Enabled": "Enabled",
645
"Timeout": "Timeout",
646
"LastCheckedOK": "Last Successful Check",
647
"LastApprovalRequest": "Last Approval Request",
648
"Created": "Created",
649
"Interval": "Interval",
650
"Host": "Host",
651
"Fingerprint": "Fingerprint",
652
"KeyID": "Key ID",
653
"CheckerRunning": "Check Is Running",
654
"LastEnabled": "Last Enabled",
655
"ApprovalPending": "Approval Is Pending",
656
"ApprovedByDefault": "Approved By Default",
657
"ApprovalDelay": "Approval Delay",
658
"ApprovalDuration": "Approval Duration",
659
"Checker": "Checker",
660
"ExtendedTimeout": "Extended Timeout",
661
"Expires": "Expires",
662
"LastCheckerStatus": "Last Checker Status",
663
}
664
665
def __init__(self, clients, keywords):
666
self.clients = clients
667
self.keywords = keywords
668
669
def __str__(self):
670
return "\n".join(self.rows())
671
672
if sys.version_info.major == 2:
673
__unicode__ = __str__
833
class command:
834
"""A namespace for command classes"""
835
836
class Base:
837
"""Abstract base class for commands"""
838
839
def run(self, clients, bus=None):
840
"""Normal commands should implement run_on_one_client(),
841
but commands which want to operate on all clients at the same time can
842
override this run() method instead.
843
"""
844
self.bus = bus
845
for client, properties in clients.items():
846
self.run_on_one_client(client, properties)
847
848
class IsEnabled(Base):
849
def run(self, clients, bus=None):
850
properties = next(iter(clients.values()))
851
if properties["Enabled"]:
852
sys.exit(0)
853
sys.exit(1)
854
855
class Approve(Base):
856
def run_on_one_client(self, client, properties):
857
self.bus.call_client_method(client, "Approve", True)
858
859
class Deny(Base):
860
def run_on_one_client(self, client, properties):
861
self.bus.call_client_method(client, "Approve", False)
862
863
class Remove(Base):
864
def run(self, clients, bus):
865
for clientpath in frozenset(clients.keys()):
866
bus.call_server_method("RemoveClient", clientpath)
867
868
class Output(Base):
869
"""Abstract class for commands outputting client details"""
870
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
871
"Created", "Interval", "Host", "KeyID",
872
"Fingerprint", "CheckerRunning",
873
"LastEnabled", "ApprovalPending",
874
"ApprovedByDefault", "LastApprovalRequest",
875
"ApprovalDelay", "ApprovalDuration",
876
"Checker", "ExtendedTimeout", "Expires",
877
"LastCheckerStatus")
878
879
class DumpJSON(Output):
880
def run(self, clients, bus=None):
881
data = {properties["Name"]:
882
{key: properties[key]
883
for key in self.all_keywords}
884
for properties in clients.values()}
885
print(json.dumps(data, indent=4, separators=(",", ": ")))
886
887
class PrintTable(Output):
888
def __init__(self, verbose=False):
889
self.verbose = verbose
890
891
def run(self, clients, bus=None):
892
default_keywords = ("Name", "Enabled", "Timeout",
893
"LastCheckedOK")
894
keywords = default_keywords
895
if self.verbose:
896
keywords = self.all_keywords
897
print(self.TableOfClients(clients.values(), keywords))
898
899
class TableOfClients:
900
tableheaders = {
901
"Name": "Name",
902
"Enabled": "Enabled",
903
"Timeout": "Timeout",
904
"LastCheckedOK": "Last Successful Check",
905
"LastApprovalRequest": "Last Approval Request",
906
"Created": "Created",
907
"Interval": "Interval",
908
"Host": "Host",
909
"Fingerprint": "Fingerprint",
910
"KeyID": "Key ID",
911
"CheckerRunning": "Check Is Running",
912
"LastEnabled": "Last Enabled",
913
"ApprovalPending": "Approval Is Pending",
914
"ApprovedByDefault": "Approved By Default",
915
"ApprovalDelay": "Approval Delay",
916
"ApprovalDuration": "Approval Duration",
917
"Checker": "Checker",
918
"ExtendedTimeout": "Extended Timeout",
919
"Expires": "Expires",
920
"LastCheckerStatus": "Last Checker Status",
921
}
922
923
def __init__(self, clients, keywords):
924
self.clients = clients
925
self.keywords = keywords
926
674
927
def __str__(self):
675
return str(self).encode(locale.getpreferredencoding())
676
677
def rows(self):
678
format_string = self.row_formatting_string()
679
rows = [self.header_line(format_string)]
680
rows.extend(self.client_line(client, format_string)
681
for client in self.clients)
682
return rows
683
684
def row_formatting_string(self):
685
"Format string used to format table rows"
686
return " ".join("{{{key}:{width}}}".format(
687
width=max(len(self.tableheaders[key]),
688
*(len(self.string_from_client(client, key))
689
for client in self.clients)),
690
key=key)
691
for key in self.keywords)
692
693
def string_from_client(self, client, key):
694
return self.valuetostring(client[key], key)
928
return "\n".join(self.rows())
929
930
if sys.version_info.major == 2:
931
__unicode__ = __str__
932
933
def __str__(self):
934
return str(self).encode(
935
locale.getpreferredencoding())
936
937
def rows(self):
938
format_string = self.row_formatting_string()
939
rows = [self.header_line(format_string)]
940
rows.extend(self.client_line(client, format_string)
941
for client in self.clients)
942
return rows
943
944
def row_formatting_string(self):
945
"Format string used to format table rows"
946
return " ".join("{{{key}:{width}}}".format(
947
width=max(len(self.tableheaders[key]),
948
*(len(self.string_from_client(client,
949
key))
950
for client in self.clients)),
951
key=key)
952
for key in self.keywords)
953
954
def string_from_client(self, client, key):
955
return self.valuetostring(client[key], key)
956
957
@classmethod
958
def valuetostring(cls, value, keyword):
959
if isinstance(value, bool):
960
return "Yes" if value else "No"
961
if keyword in ("Timeout", "Interval", "ApprovalDelay",
962
"ApprovalDuration", "ExtendedTimeout"):
963
return cls.milliseconds_to_string(value)
964
return str(value)
965
966
def header_line(self, format_string):
967
return format_string.format(**self.tableheaders)
968
969
def client_line(self, client, format_string):
970
return format_string.format(
971
**{key: self.string_from_client(client, key)
972
for key in self.keywords})
973
974
@staticmethod
975
def milliseconds_to_string(ms):
976
td = datetime.timedelta(0, 0, 0, ms)
977
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
978
.format(days="{}T".format(td.days)
979
if td.days else "",
980
hours=td.seconds // 3600,
981
minutes=(td.seconds % 3600) // 60,
982
seconds=td.seconds % 60))
983
984
class PropertySetter(Base):
985
"Abstract class for Actions for setting one client property"
986
987
def run_on_one_client(self, client, properties=None):
988
"""Set the Client's D-Bus property"""
989
self.bus.set_client_property(client, self.propname,
990
self.value_to_set)
991
992
@property
993
def propname(self):
994
raise NotImplementedError()
995
996
class Enable(PropertySetter):
997
propname = "Enabled"
998
value_to_set = True
999
1000
class Disable(PropertySetter):
1001
propname = "Enabled"
1002
value_to_set = False
1003
1004
class BumpTimeout(PropertySetter):
1005
propname = "LastCheckedOK"
1006
value_to_set = ""
1007
1008
class StartChecker(PropertySetter):
1009
propname = "CheckerRunning"
1010
value_to_set = True
1011
1012
class StopChecker(PropertySetter):
1013
propname = "CheckerRunning"
1014
value_to_set = False
1015
1016
class ApproveByDefault(PropertySetter):
1017
propname = "ApprovedByDefault"
1018
value_to_set = True
1019
1020
class DenyByDefault(PropertySetter):
1021
propname = "ApprovedByDefault"
1022
value_to_set = False
1023
1024
class PropertySetterValue(PropertySetter):
1025
"""Abstract class for PropertySetter recieving a value as
1026
constructor argument instead of a class attribute."""
1027
1028
def __init__(self, value):
1029
self.value_to_set = value
695
1030
696
1031
@classmethod
697
def valuetostring(cls, value, keyword):
698
if isinstance(value, dbus.Boolean):
699
return "Yes" if value else "No"
700
if keyword in ("Timeout", "Interval", "ApprovalDelay",
701
"ApprovalDuration", "ExtendedTimeout"):
702
return cls.milliseconds_to_string(value)
703
return str(value)
704
705
def header_line(self, format_string):
706
return format_string.format(**self.tableheaders)
707
708
def client_line(self, client, format_string):
709
return format_string.format(
710
**{key: self.string_from_client(client, key)
711
for key in self.keywords})
712
713
@staticmethod
714
def milliseconds_to_string(ms):
715
td = datetime.timedelta(0, 0, 0, ms)
716
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
717
.format(days="{}T".format(td.days)
718
if td.days else "",
719
hours=td.seconds // 3600,
720
minutes=(td.seconds % 3600) // 60,
721
seconds=td.seconds % 60))
722
723
724
class PropertyCmd(Command):
725
"""Abstract class for Actions for setting one client property"""
726
727
def run_on_one_client(self, client, properties):
728
"""Set the Client's D-Bus property"""
729
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
730
client.__dbus_object_path__,
731
dbus.PROPERTIES_IFACE, client_dbus_interface,
732
self.propname, self.value_to_set
733
if not isinstance(self.value_to_set, dbus.Boolean)
734
else bool(self.value_to_set))
735
client.Set(client_dbus_interface, self.propname,
736
self.value_to_set,
737
dbus_interface=dbus.PROPERTIES_IFACE)
738
739
@property
740
def propname(self):
741
raise NotImplementedError()
742
743
744
class EnableCmd(PropertyCmd):
745
propname = "Enabled"
746
value_to_set = dbus.Boolean(True)
747
748
749
class DisableCmd(PropertyCmd):
750
propname = "Enabled"
751
value_to_set = dbus.Boolean(False)
752
753
754
class BumpTimeoutCmd(PropertyCmd):
755
propname = "LastCheckedOK"
756
value_to_set = ""
757
758
759
class StartCheckerCmd(PropertyCmd):
760
propname = "CheckerRunning"
761
value_to_set = dbus.Boolean(True)
762
763
764
class StopCheckerCmd(PropertyCmd):
765
propname = "CheckerRunning"
766
value_to_set = dbus.Boolean(False)
767
768
769
class ApproveByDefaultCmd(PropertyCmd):
770
propname = "ApprovedByDefault"
771
value_to_set = dbus.Boolean(True)
772
773
774
class DenyByDefaultCmd(PropertyCmd):
775
propname = "ApprovedByDefault"
776
value_to_set = dbus.Boolean(False)
777
778
779
class PropertyValueCmd(PropertyCmd):
780
"""Abstract class for PropertyCmd recieving a value as argument"""
781
def __init__(self, value):
782
self.value_to_set = value
783
784
785
class SetCheckerCmd(PropertyValueCmd):
786
propname = "Checker"
787
788
789
class SetHostCmd(PropertyValueCmd):
790
propname = "Host"
791
792
793
class SetSecretCmd(PropertyValueCmd):
794
propname = "Secret"
795
796
@property
797
def value_to_set(self):
798
return self._vts
799
800
@value_to_set.setter
801
def value_to_set(self, value):
802
"""When setting, read data from supplied file object"""
803
self._vts = value.read()
804
value.close()
805
806
807
class MillisecondsPropertyValueArgumentCmd(PropertyValueCmd):
808
"""Abstract class for PropertyValueCmd taking a value argument as
809
a datetime.timedelta() but should store it as milliseconds."""
810
811
@property
812
def value_to_set(self):
813
return self._vts
814
815
@value_to_set.setter
816
def value_to_set(self, value):
817
"""When setting, convert value from a datetime.timedelta"""
818
self._vts = int(round(value.total_seconds() * 1000))
819
820
821
class SetTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
822
propname = "Timeout"
823
824
825
class SetExtendedTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
826
propname = "ExtendedTimeout"
827
828
829
class SetIntervalCmd(MillisecondsPropertyValueArgumentCmd):
830
propname = "Interval"
831
832
833
class SetApprovalDelayCmd(MillisecondsPropertyValueArgumentCmd):
834
propname = "ApprovalDelay"
835
836
837
class SetApprovalDurationCmd(MillisecondsPropertyValueArgumentCmd):
838
propname = "ApprovalDuration"
1032
def argparse(cls, argtype):
1033
def cmdtype(arg):
1034
return cls(argtype(arg))
1035
return cmdtype
1036
1037
class SetChecker(PropertySetterValue):
1038
propname = "Checker"
1039
1040
class SetHost(PropertySetterValue):
1041
propname = "Host"
1042
1043
class SetSecret(PropertySetterValue):
1044
propname = "Secret"
1045
1046
@property
1047
def value_to_set(self):
1048
return self._vts
1049
1050
@value_to_set.setter
1051
def value_to_set(self, value):
1052
"""When setting, read data from supplied file object"""
1053
self._vts = value.read()
1054
value.close()
1055
1056
class PropertySetterValueMilliseconds(PropertySetterValue):
1057
"""Abstract class for PropertySetterValue taking a value
1058
argument as a datetime.timedelta() but should store it as
1059
milliseconds."""
1060
1061
@property
1062
def value_to_set(self):
1063
return self._vts
1064
1065
@value_to_set.setter
1066
def value_to_set(self, value):
1067
"When setting, convert value from a datetime.timedelta"
1068
self._vts = int(round(value.total_seconds() * 1000))
1069
1070
class SetTimeout(PropertySetterValueMilliseconds):
1071
propname = "Timeout"
1072
1073
class SetExtendedTimeout(PropertySetterValueMilliseconds):
1074
propname = "ExtendedTimeout"
1075
1076
class SetInterval(PropertySetterValueMilliseconds):
1077
propname = "Interval"
1078
1079
class SetApprovalDelay(PropertySetterValueMilliseconds):
1080
propname = "ApprovalDelay"
1081
1082
class SetApprovalDuration(PropertySetterValueMilliseconds):
1083
propname = "ApprovalDuration"
839
1084
840
1085
841
1086
872
1117
("records",
873
1118
"output"))
874
1119
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
875
1126
class Test_string_to_delta(TestCaseWithAssertLogs):
876
def test_handles_basic_rfc3339(self):
877
self.assertEqual(string_to_delta("PT0S"),
878
datetime.timedelta())
879
self.assertEqual(string_to_delta("P0D"),
880
datetime.timedelta())
881
self.assertEqual(string_to_delta("PT1S"),
882
datetime.timedelta(0, 1))
883
self.assertEqual(string_to_delta("PT2H"),
884
datetime.timedelta(0, 7200))
1127
# Just test basic RFC 3339 functionality here, the doc string for
1128
# rfc3339_duration_to_delta() already has more comprehensive
1129
# tests, which are run by doctest.
1130
1131
def test_rfc3339_zero_seconds(self):
1132
self.assertEqual(datetime.timedelta(),
1133
string_to_delta("PT0S"))
1134
1135
def test_rfc3339_zero_days(self):
1136
self.assertEqual(datetime.timedelta(), string_to_delta("P0D"))
1137
1138
def test_rfc3339_one_second(self):
1139
self.assertEqual(datetime.timedelta(0, 1),
1140
string_to_delta("PT1S"))
1141
1142
def test_rfc3339_two_hours(self):
1143
self.assertEqual(datetime.timedelta(0, 7200),
1144
string_to_delta("PT2H"))
885
1145
886
1146
def test_falls_back_to_pre_1_6_1_with_warning(self):
887
1147
with self.assertLogs(log, logging.WARNING):
888
1148
value = string_to_delta("2h")
889
self.assertEqual(value, datetime.timedelta(0, 7200))
1149
self.assertEqual(datetime.timedelta(0, 7200), value)
890
1150
891
1151
892
1152
class Test_check_option_syntax(unittest.TestCase):
896
1156
897
1157
def test_actions_requires_client_or_all(self):
898
1158
for action, value in self.actions.items():
899
options = self.parser.parse_args()
900
setattr(options, action, value)
1159
args = self.actionargs(action, value)
901
1160
with self.assertParseError():
902
self.check_option_syntax(options)
1161
self.parse_args(args)
903
1162
904
# This mostly corresponds to the definition from has_actions() in
1163
# This mostly corresponds to the definition from has_commands() in
905
1164
# check_option_syntax()
906
1165
actions = {
907
# The actual values set here are not that important, but we do
908
# at least stick to the correct types, even though they are
909
# never used
910
"enable": True,
911
"disable": True,
912
"bump_timeout": True,
913
"start_checker": True,
914
"stop_checker": True,
915
"is_enabled": True,
916
"remove": True,
917
"checker": "x",
918
"timeout": datetime.timedelta(),
919
"extended_timeout": datetime.timedelta(),
920
"interval": datetime.timedelta(),
921
"approved_by_default": True,
922
"approval_delay": datetime.timedelta(),
923
"approval_duration": datetime.timedelta(),
924
"host": "x",
925
"secret": io.BytesIO(b"x"),
926
"approve": True,
927
"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,
928
1185
}
929
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
930
1194
@contextlib.contextmanager
931
1195
def assertParseError(self):
932
1196
with self.assertRaises(SystemExit) as e:
933
with self.temporarily_suppress_stderr():
1197
with self.redirect_stderr_to_devnull():
934
1198
yield
935
1199
# Exit code from argparse is guaranteed to be "2". Reference:
936
1200
# https://docs.python.org/3/library
937
1201
# /argparse.html#exiting-methods
938
self.assertEqual(e.exception.code, 2)
1202
self.assertEqual(2, e.exception.code)
1203
1204
def parse_args(self, args):
1205
options = self.parser.parse_args(args)
1206
check_option_syntax(self.parser, options)
939
1207
940
1208
@staticmethod
941
1209
@contextlib.contextmanager
942
def temporarily_suppress_stderr():
943
null = os.open(os.path.devnull, os.O_RDWR)
944
stderrcopy = os.dup(sys.stderr.fileno())
945
os.dup2(null, sys.stderr.fileno())
946
os.close(null)
947
try:
948
yield
949
finally:
950
# restore stderr
951
os.dup2(stderrcopy, sys.stderr.fileno())
952
os.close(stderrcopy)
1210
def redirect_stderr_to_devnull():
1211
old_stderr = sys.stderr
1212
with contextlib.closing(open(os.devnull, "w")) as null:
1213
sys.stderr = null
1214
try:
1215
yield
1216
finally:
1217
sys.stderr = old_stderr
953
1218
954
1219
def check_option_syntax(self, options):
955
1220
check_option_syntax(self.parser, options)
956
1221
957
def test_actions_conflicts_with_verbose(self):
958
for action, value in self.actions.items():
959
options = self.parser.parse_args()
960
setattr(options, action, value)
961
options.verbose = True
962
with self.assertParseError():
963
self.check_option_syntax(options)
1222
def test_actions_all_conflicts_with_verbose(self):
1223
for action, value in self.actions.items():
1224
args = self.actionargs(action, value, "--all",
1225
"--verbose")
1226
with self.assertParseError():
1227
self.parse_args(args)
1228
1229
def test_actions_with_client_conflicts_with_verbose(self):
1230
for action, value in self.actions.items():
1231
args = self.actionargs(action, value, "--verbose",
1232
"client")
1233
with self.assertParseError():
1234
self.parse_args(args)
964
1235
965
1236
def test_dump_json_conflicts_with_verbose(self):
966
options = self.parser.parse_args()
967
options.dump_json = True
968
options.verbose = True
1237
args = ["--dump-json", "--verbose"]
969
1238
with self.assertParseError():
970
self.check_option_syntax(options)
1239
self.parse_args(args)
971
1240
972
1241
def test_dump_json_conflicts_with_action(self):
973
1242
for action, value in self.actions.items():
974
options = self.parser.parse_args()
975
setattr(options, action, value)
976
options.dump_json = True
1243
args = self.actionargs(action, value, "--dump-json")
977
1244
with self.assertParseError():
978
self.check_option_syntax(options)
1245
self.parse_args(args)
979
1246
980
1247
def test_all_can_not_be_alone(self):
981
options = self.parser.parse_args()
982
options.all = True
1248
args = ["--all"]
983
1249
with self.assertParseError():
984
self.check_option_syntax(options)
1250
self.parse_args(args)
985
1251
986
1252
def test_all_is_ok_with_any_action(self):
987
1253
for action, value in self.actions.items():
988
options = self.parser.parse_args()
989
setattr(options, action, value)
990
options.all = True
991
self.check_option_syntax(options)
1254
args = self.actionargs(action, value, "--all")
1255
self.parse_args(args)
1256
1257
def test_any_action_is_ok_with_one_client(self):
1258
for action, value in self.actions.items():
1259
args = self.actionargs(action, value, "client")
1260
self.parse_args(args)
1261
1262
def test_one_client_with_all_actions_except_is_enabled(self):
1263
for action, value in self.actions.items():
1264
if action == "--is-enabled":
1265
continue
1266
args = self.actionargs(action, value, "client")
1267
self.parse_args(args)
1268
1269
def test_two_clients_with_all_actions_except_is_enabled(self):
1270
for action, value in self.actions.items():
1271
if action == "--is-enabled":
1272
continue
1273
args = self.actionargs(action, value, "client1",
1274
"client2")
1275
self.parse_args(args)
1276
1277
def test_two_clients_are_ok_with_actions_except_is_enabled(self):
1278
for action, value in self.actions.items():
1279
if action == "--is-enabled":
1280
continue
1281
args = self.actionargs(action, value, "client1",
1282
"client2")
1283
self.parse_args(args)
992
1284
993
1285
def test_is_enabled_fails_without_client(self):
994
options = self.parser.parse_args()
995
options.is_enabled = True
1286
args = ["--is-enabled"]
996
1287
with self.assertParseError():
997
self.check_option_syntax(options)
998
999
def test_is_enabled_works_with_one_client(self):
1000
options = self.parser.parse_args()
1001
options.is_enabled = True
1002
options.client = ["foo"]
1003
self.check_option_syntax(options)
1288
self.parse_args(args)
1004
1289
1005
1290
def test_is_enabled_fails_with_two_clients(self):
1006
options = self.parser.parse_args()
1007
options.is_enabled = True
1008
options.client = ["foo", "barbar"]
1291
args = ["--is-enabled", "client1", "client2"]
1009
1292
with self.assertParseError():
1010
self.check_option_syntax(options)
1293
self.parse_args(args)
1011
1294
1012
1295
def test_remove_can_only_be_combined_with_action_deny(self):
1013
1296
for action, value in self.actions.items():
1014
if action in {"remove", "deny"}:
1297
if action in {"--remove", "--deny"}:
1015
1298
continue
1016
options = self.parser.parse_args()
1017
setattr(options, action, value)
1018
options.all = True
1019
options.remove = True
1299
args = self.actionargs(action, value, "--all",
1300
"--remove")
1020
1301
with self.assertParseError():
1021
self.check_option_syntax(options)
1022
1023
1024
class Test_get_mandos_dbus_object(TestCaseWithAssertLogs):
1025
def test_calls_and_returns_get_object_on_bus(self):
1026
class MockBus(object):
1027
called = False
1028
def get_object(mockbus_self, busname, dbus_path):
1029
# Note that "self" is still the testcase instance,
1030
# this MockBus instance is in "mockbus_self".
1031
self.assertEqual(busname, dbus_busname)
1032
self.assertEqual(dbus_path, server_dbus_path)
1033
mockbus_self.called = True
1034
return mockbus_self
1035
1036
mockbus = get_mandos_dbus_object(bus=MockBus())
1037
self.assertIsInstance(mockbus, MockBus)
1038
self.assertTrue(mockbus.called)
1039
1040
def test_logs_and_exits_on_dbus_error(self):
1041
class MockBusFailing(object):
1042
def get_object(self, busname, dbus_path):
1043
raise dbus.exceptions.DBusException("Test")
1044
1045
with self.assertLogs(log, logging.CRITICAL):
1046
with self.assertRaises(SystemExit) as e:
1047
bus = get_mandos_dbus_object(bus=MockBusFailing())
1048
1049
if isinstance(e.exception.code, int):
1050
self.assertNotEqual(e.exception.code, 0)
1051
else:
1052
self.assertIsNotNone(e.exception.code)
1053
1054
1055
class Test_get_managed_objects(TestCaseWithAssertLogs):
1056
def test_calls_and_returns_GetManagedObjects(self):
1057
managed_objects = {"/clients/foo": { "Name": "foo"}}
1058
class MockObjectManager(object):
1059
def GetManagedObjects(self):
1060
return managed_objects
1061
retval = get_managed_objects(MockObjectManager())
1062
self.assertDictEqual(managed_objects, retval)
1063
1064
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):
1065
1602
dbus_logger = logging.getLogger("dbus.proxies")
1066
1603
1067
class MockObjectManagerFailing(object):
1068
def GetManagedObjects(self):
1069
dbus_logger.error("Test")
1070
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)
1071
1610
1072
1611
class CountingHandler(logging.Handler):
1073
1612
count = 0
1079
1618
dbus_logger.addHandler(counting_handler)
1080
1619
1081
1620
try:
1082
with self.assertLogs(log, logging.CRITICAL) as watcher:
1083
with self.assertRaises(SystemExit) as e:
1084
get_managed_objects(MockObjectManagerFailing())
1621
with self.assertRaises(dbus.Error) as e:
1622
self.call_method(bus, "methodname", "busname",
1623
"objectpath", "interface")
1085
1624
finally:
1086
1625
dbus_logger.removeFilter(counting_handler)
1087
1626
1627
self.assertNotIsInstance(e.exception, dbus.ConnectFailed)
1628
1088
1629
# Make sure the dbus logger was suppressed
1089
self.assertEqual(counting_handler.count, 0)
1090
1091
# Test that the dbus_logger still works
1092
with self.assertLogs(dbus_logger, logging.ERROR):
1093
dbus_logger.error("Test")
1094
1095
if isinstance(e.exception.code, int):
1096
self.assertNotEqual(e.exception.code, 0)
1097
else:
1098
self.assertIsNotNone(e.exception.code)
1630
self.assertEqual(0, counting_handler.count)
1631
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")
1099
2049
1100
2050
1101
2051
class Test_commands_from_options(unittest.TestCase):
2052
1102
2053
def setUp(self):
1103
2054
self.parser = argparse.ArgumentParser()
1104
2055
add_command_line_options(self.parser)
1105
2056
1106
2057
def test_is_enabled(self):
1107
self.assert_command_from_args(["--is-enabled", "foo"],
1108
IsEnabledCmd)
2058
self.assert_command_from_args(["--is-enabled", "client"],
2059
command.IsEnabled)
1109
2060
1110
def assert_command_from_args(self, args, command_cls,
1111
**cmd_attrs):
2061
def assert_command_from_args(self, args, command_cls, length=1,
2062
clients=None, **cmd_attrs):
1112
2063
"""Assert that parsing ARGS should result in an instance of
1113
2064
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
1114
2065
options = self.parser.parse_args(args)
1115
2066
check_option_syntax(self.parser, options)
1116
2067
commands = commands_from_options(options)
1117
self.assertEqual(len(commands), 1)
1118
command = commands[0]
1119
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)
1120
2076
for key, value in cmd_attrs.items():
1121
self.assertEqual(getattr(command, key), value)
2077
self.assertEqual(value, getattr(command, key))
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)
1122
2084
1123
2085
def test_is_enabled_short(self):
1124
self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
2086
self.assert_command_from_args(["-V", "client"],
2087
command.IsEnabled)
1125
2088
1126
2089
def test_approve(self):
1127
self.assert_command_from_args(["--approve", "foo"],
1128
ApproveCmd)
2090
self.assert_command_from_args(["--approve", "client"],
2091
command.Approve)
1129
2092
1130
2093
def test_approve_short(self):
1131
self.assert_command_from_args(["-A", "foo"], ApproveCmd)
2094
self.assert_command_from_args(["-A", "client"],
2095
command.Approve)
1132
2096
1133
2097
def test_deny(self):
1134
self.assert_command_from_args(["--deny", "foo"], DenyCmd)
2098
self.assert_command_from_args(["--deny", "client"],
2099
command.Deny)
1135
2100
1136
2101
def test_deny_short(self):
1137
self.assert_command_from_args(["-D", "foo"], DenyCmd)
2102
self.assert_command_from_args(["-D", "client"], command.Deny)
1138
2103
1139
2104
def test_remove(self):
1140
self.assert_command_from_args(["--remove", "foo"],
1141
RemoveCmd)
2105
self.assert_command_from_args(["--remove", "client"],
2106
command.Remove)
1142
2107
1143
2108
def test_deny_before_remove(self):
1144
2109
options = self.parser.parse_args(["--deny", "--remove",
1145
"foo"])
2110
"client"])
1146
2111
check_option_syntax(self.parser, options)
1147
2112
commands = commands_from_options(options)
1148
self.assertEqual(len(commands), 2)
1149
self.assertIsInstance(commands[0], DenyCmd)
1150
self.assertIsInstance(commands[1], RemoveCmd)
2113
self.assertEqual(2, len(commands))
2114
self.assertIsInstance(commands[0], command.Deny)
2115
self.assertIsInstance(commands[1], command.Remove)
1151
2116
1152
2117
def test_deny_before_remove_reversed(self):
1153
2118
options = self.parser.parse_args(["--remove", "--deny",
1154
2119
"--all"])
1155
2120
check_option_syntax(self.parser, options)
1156
2121
commands = commands_from_options(options)
1157
self.assertEqual(len(commands), 2)
1158
self.assertIsInstance(commands[0], DenyCmd)
1159
self.assertIsInstance(commands[1], RemoveCmd)
2122
self.assertEqual(2, len(commands))
2123
self.assertIsInstance(commands[0], command.Deny)
2124
self.assertIsInstance(commands[1], command.Remove)
1160
2125
1161
2126
def test_remove_short(self):
1162
self.assert_command_from_args(["-r", "foo"], RemoveCmd)
2127
self.assert_command_from_args(["-r", "client"],
2128
command.Remove)
1163
2129
1164
2130
def test_dump_json(self):
1165
self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
2131
self.assert_command_from_args(["--dump-json"],
2132
command.DumpJSON)
1166
2133
1167
2134
def test_enable(self):
1168
self.assert_command_from_args(["--enable", "foo"], EnableCmd)
2135
self.assert_command_from_args(["--enable", "client"],
2136
command.Enable)
1169
2137
1170
2138
def test_enable_short(self):
1171
self.assert_command_from_args(["-e", "foo"], EnableCmd)
2139
self.assert_command_from_args(["-e", "client"],
2140
command.Enable)
1172
2141
1173
2142
def test_disable(self):
1174
self.assert_command_from_args(["--disable", "foo"],
1175
DisableCmd)
2143
self.assert_command_from_args(["--disable", "client"],
2144
command.Disable)
1176
2145
1177
2146
def test_disable_short(self):
1178
self.assert_command_from_args(["-d", "foo"], DisableCmd)
2147
self.assert_command_from_args(["-d", "client"],
2148
command.Disable)
1179
2149
1180
2150
def test_bump_timeout(self):
1181
self.assert_command_from_args(["--bump-timeout", "foo"],
1182
BumpTimeoutCmd)
2151
self.assert_command_from_args(["--bump-timeout", "client"],
2152
command.BumpTimeout)
1183
2153
1184
2154
def test_bump_timeout_short(self):
1185
self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
2155
self.assert_command_from_args(["-b", "client"],
2156
command.BumpTimeout)
1186
2157
1187
2158
def test_start_checker(self):
1188
self.assert_command_from_args(["--start-checker", "foo"],
1189
StartCheckerCmd)
2159
self.assert_command_from_args(["--start-checker", "client"],
2160
command.StartChecker)
1190
2161
1191
2162
def test_stop_checker(self):
1192
self.assert_command_from_args(["--stop-checker", "foo"],
1193
StopCheckerCmd)
2163
self.assert_command_from_args(["--stop-checker", "client"],
2164
command.StopChecker)
1194
2165
1195
2166
def test_approve_by_default(self):
1196
self.assert_command_from_args(["--approve-by-default", "foo"],
1197
ApproveByDefaultCmd)
2167
self.assert_command_from_args(["--approve-by-default",
2168
"client"],
2169
command.ApproveByDefault)
1198
2170
1199
2171
def test_deny_by_default(self):
1200
self.assert_command_from_args(["--deny-by-default", "foo"],
1201
DenyByDefaultCmd)
2172
self.assert_command_from_args(["--deny-by-default", "client"],
2173
command.DenyByDefault)
1202
2174
1203
2175
def test_checker(self):
1204
self.assert_command_from_args(["--checker", ":", "foo"],
1205
SetCheckerCmd, value_to_set=":")
2176
self.assert_command_from_args(["--checker", ":", "client"],
2177
command.SetChecker,
2178
value_to_set=":")
1206
2179
1207
2180
def test_checker_empty(self):
1208
self.assert_command_from_args(["--checker", "", "foo"],
1209
SetCheckerCmd, value_to_set="")
2181
self.assert_command_from_args(["--checker", "", "client"],
2182
command.SetChecker,
2183
value_to_set="")
1210
2184
1211
2185
def test_checker_short(self):
1212
self.assert_command_from_args(["-c", ":", "foo"],
1213
SetCheckerCmd, value_to_set=":")
2186
self.assert_command_from_args(["-c", ":", "client"],
2187
command.SetChecker,
2188
value_to_set=":")
1214
2189
1215
2190
def test_host(self):
1216
self.assert_command_from_args(["--host", "foo.example.org",
1217
"foo"], SetHostCmd,
1218
value_to_set="foo.example.org")
2191
self.assert_command_from_args(
2192
["--host", "client.example.org", "client"],
2193
command.SetHost, value_to_set="client.example.org")
1219
2194
1220
2195
def test_host_short(self):
1221
self.assert_command_from_args(["-H", "foo.example.org",
1222
"foo"], SetHostCmd,
1223
value_to_set="foo.example.org")
2196
self.assert_command_from_args(
2197
["-H", "client.example.org", "client"], command.SetHost,
2198
value_to_set="client.example.org")
1224
2199
1225
2200
def test_secret_devnull(self):
1226
2201
self.assert_command_from_args(["--secret", os.path.devnull,
1227
"foo"], SetSecretCmd,
2202
"client"], command.SetSecret,
1228
2203
value_to_set=b"")
1229
2204
1230
2205
def test_secret_tempfile(self):
1233
2208
f.write(value)
1234
2209
f.seek(0)
1235
2210
self.assert_command_from_args(["--secret", f.name,
1236
"foo"], SetSecretCmd,
2211
"client"],
2212
command.SetSecret,
1237
2213
value_to_set=value)
1238
2214
1239
2215
def test_secret_devnull_short(self):
1240
self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1241
SetSecretCmd, value_to_set=b"")
2216
self.assert_command_from_args(["-s", os.path.devnull,
2217
"client"], command.SetSecret,
2218
value_to_set=b"")
1242
2219
1243
2220
def test_secret_tempfile_short(self):
1244
2221
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1245
2222
value = b"secret\0xyzzy\nbar"
1246
2223
f.write(value)
1247
2224
f.seek(0)
1248
self.assert_command_from_args(["-s", f.name, "foo"],
1249
SetSecretCmd,
2225
self.assert_command_from_args(["-s", f.name, "client"],
2226
command.SetSecret,
1250
2227
value_to_set=value)
1251
2228
1252
2229
def test_timeout(self):
1253
self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1254
SetTimeoutCmd,
2230
self.assert_command_from_args(["--timeout", "PT5M", "client"],
2231
command.SetTimeout,
1255
2232
value_to_set=300000)
1256
2233
1257
2234
def test_timeout_short(self):
1258
self.assert_command_from_args(["-t", "PT5M", "foo"],
1259
SetTimeoutCmd,
2235
self.assert_command_from_args(["-t", "PT5M", "client"],
2236
command.SetTimeout,
1260
2237
value_to_set=300000)
1261
2238
1262
2239
def test_extended_timeout(self):
1263
2240
self.assert_command_from_args(["--extended-timeout", "PT15M",
1264
"foo"],
1265
SetExtendedTimeoutCmd,
2241
"client"],
2242
command.SetExtendedTimeout,
1266
2243
value_to_set=900000)
1267
2244
1268
2245
def test_interval(self):
1269
self.assert_command_from_args(["--interval", "PT2M", "foo"],
1270
SetIntervalCmd,
2246
self.assert_command_from_args(["--interval", "PT2M",
2247
"client"], command.SetInterval,
1271
2248
value_to_set=120000)
1272
2249
1273
2250
def test_interval_short(self):
1274
self.assert_command_from_args(["-i", "PT2M", "foo"],
1275
SetIntervalCmd,
2251
self.assert_command_from_args(["-i", "PT2M", "client"],
2252
command.SetInterval,
1276
2253
value_to_set=120000)
1277
2254
1278
2255
def test_approval_delay(self):
1279
2256
self.assert_command_from_args(["--approval-delay", "PT30S",
1280
"foo"], SetApprovalDelayCmd,
2257
"client"],
2258
command.SetApprovalDelay,
1281
2259
value_to_set=30000)
1282
2260
1283
2261
def test_approval_duration(self):
1284
2262
self.assert_command_from_args(["--approval-duration", "PT1S",
1285
"foo"], SetApprovalDurationCmd,
2263
"client"],
2264
command.SetApprovalDuration,
1286
2265
value_to_set=1000)
1287
2266
1288
2267
def test_print_table(self):
1289
self.assert_command_from_args([], PrintTableCmd,
2268
self.assert_command_from_args([], command.PrintTable,
1290
2269
verbose=False)
1291
2270
1292
2271
def test_print_table_verbose(self):
1293
self.assert_command_from_args(["--verbose"], PrintTableCmd,
2272
self.assert_command_from_args(["--verbose"],
2273
command.PrintTable,
1294
2274
verbose=True)
1295
2275
1296
2276
def test_print_table_verbose_short(self):
1297
self.assert_command_from_args(["-v"], PrintTableCmd,
2277
self.assert_command_from_args(["-v"], command.PrintTable,
1298
2278
verbose=True)
1299
2279
1300
2280
1301
class TestCmd(unittest.TestCase):
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
2312
class TestCommand(unittest.TestCase):
1302
2313
"""Abstract class for tests of command classes"""
1303
2314
1304
def setUp(self):
1305
testcase = self
1306
class MockClient(object):
1307
def __init__(self, name, **attributes):
1308
self.__dbus_object_path__ = "/clients/{}".format(name)
1309
self.attributes = attributes
1310
self.attributes["Name"] = name
1311
self.calls = []
1312
def Set(self, interface, propname, value, dbus_interface):
1313
testcase.assertEqual(interface, client_dbus_interface)
1314
testcase.assertEqual(dbus_interface,
1315
dbus.PROPERTIES_IFACE)
1316
self.attributes[propname] = value
1317
def Get(self, interface, propname, dbus_interface):
1318
testcase.assertEqual(interface, client_dbus_interface)
1319
testcase.assertEqual(dbus_interface,
1320
dbus.PROPERTIES_IFACE)
1321
return self.attributes[propname]
1322
def Approve(self, approve, dbus_interface):
1323
testcase.assertEqual(dbus_interface,
1324
client_dbus_interface)
1325
self.calls.append(("Approve", (approve,
1326
dbus_interface)))
1327
self.client = MockClient(
1328
"foo",
1329
KeyID=("92ed150794387c03ce684574b1139a65"
1330
"94a34f895daaaf09fd8ea90a27cddb12"),
1331
Secret=b"secret",
1332
Host="foo.example.org",
1333
Enabled=dbus.Boolean(True),
1334
Timeout=300000,
1335
LastCheckedOK="2019-02-03T00:00:00",
1336
Created="2019-01-02T00:00:00",
1337
Interval=120000,
1338
Fingerprint=("778827225BA7DE539C5A"
1339
"7CFA59CFF7CDBD9A5920"),
1340
CheckerRunning=dbus.Boolean(False),
1341
LastEnabled="2019-01-03T00:00:00",
1342
ApprovalPending=dbus.Boolean(False),
1343
ApprovedByDefault=dbus.Boolean(True),
1344
LastApprovalRequest="",
1345
ApprovalDelay=0,
1346
ApprovalDuration=1000,
1347
Checker="fping -q -- %(host)s",
1348
ExtendedTimeout=900000,
1349
Expires="2019-02-04T00:00:00",
1350
LastCheckerStatus=0)
1351
self.other_client = MockClient(
1352
"barbar",
1353
KeyID=("0558568eedd67d622f5c83b35a115f79"
1354
"6ab612cff5ad227247e46c2b020f441c"),
1355
Secret=b"secretbar",
1356
Host="192.0.2.3",
1357
Enabled=dbus.Boolean(True),
1358
Timeout=300000,
1359
LastCheckedOK="2019-02-04T00:00:00",
1360
Created="2019-01-03T00:00:00",
1361
Interval=120000,
1362
Fingerprint=("3E393AEAEFB84C7E89E2"
1363
"F547B3A107558FCA3A27"),
1364
CheckerRunning=dbus.Boolean(True),
1365
LastEnabled="2019-01-04T00:00:00",
1366
ApprovalPending=dbus.Boolean(False),
1367
ApprovedByDefault=dbus.Boolean(False),
1368
LastApprovalRequest="2019-01-03T00:00:00",
1369
ApprovalDelay=30000,
1370
ApprovalDuration=93785000,
1371
Checker=":",
1372
ExtendedTimeout=900000,
1373
Expires="2019-02-05T00:00:00",
1374
LastCheckerStatus=-2)
1375
self.clients = collections.OrderedDict(
1376
[
1377
("/clients/foo", self.client.attributes),
1378
("/clients/barbar", self.other_client.attributes),
1379
])
1380
self.one_client = {"/clients/foo": self.client.attributes}
1381
1382
@property
1383
def bus(self):
1384
class Bus(object):
1385
@staticmethod
1386
def get_object(client_bus_name, path):
1387
self.assertEqual(client_bus_name, dbus_busname)
1388
return {
1389
# Note: "self" here is the TestCmd instance, not
1390
# the Bus instance, since this is a static method!
1391
"/clients/foo": self.client,
1392
"/clients/barbar": self.other_client,
1393
}[path]
1394
return Bus()
1395
1396
1397
class TestIsEnabledCmd(TestCmd):
1398
def test_is_enabled(self):
1399
self.assertTrue(all(IsEnabledCmd().is_enabled(client,
1400
properties)
1401
for client, properties
1402
in self.clients.items()))
1403
1404
def test_is_enabled_run_exits_successfully(self):
1405
with self.assertRaises(SystemExit) as e:
1406
IsEnabledCmd().run(self.one_client)
1407
if e.exception.code is not None:
1408
self.assertEqual(e.exception.code, 0)
1409
else:
1410
self.assertIsNone(e.exception.code)
1411
1412
def test_is_enabled_run_exits_with_failure(self):
1413
self.client.attributes["Enabled"] = dbus.Boolean(False)
1414
with self.assertRaises(SystemExit) as e:
1415
IsEnabledCmd().run(self.one_client)
1416
if isinstance(e.exception.code, int):
1417
self.assertNotEqual(e.exception.code, 0)
1418
else:
1419
self.assertIsNotNone(e.exception.code)
1420
1421
1422
class TestApproveCmd(TestCmd):
1423
def test_approve(self):
1424
ApproveCmd().run(self.clients, self.bus)
1425
for clientpath in self.clients:
1426
client = self.bus.get_object(dbus_busname, clientpath)
1427
self.assertIn(("Approve", (True, client_dbus_interface)),
1428
client.calls)
1429
1430
1431
class TestDenyCmd(TestCmd):
1432
def test_deny(self):
1433
DenyCmd().run(self.clients, self.bus)
1434
for clientpath in self.clients:
1435
client = self.bus.get_object(dbus_busname, clientpath)
1436
self.assertIn(("Approve", (False, client_dbus_interface)),
1437
client.calls)
1438
1439
1440
class TestRemoveCmd(TestCmd):
1441
def test_remove(self):
1442
class MockMandos(object):
1443
def __init__(self):
1444
self.calls = []
1445
def RemoveClient(self, dbus_path):
1446
self.calls.append(("RemoveClient", (dbus_path,)))
1447
mandos = MockMandos()
1448
super(TestRemoveCmd, self).setUp()
1449
RemoveCmd().run(self.clients, self.bus, mandos)
1450
self.assertEqual(len(mandos.calls), 2)
1451
for clientpath in self.clients:
1452
self.assertIn(("RemoveClient", (clientpath,)),
1453
mandos.calls)
1454
1455
1456
class TestDumpJSONCmd(TestCmd):
1457
def setUp(self):
1458
self.expected_json = {
1459
"foo": {
2315
class FakeMandosBus(dbus.MandosBus):
2316
def __init__(self, testcase):
2317
self.client_properties = {
1460
2318
"Name": "foo",
1461
2319
"KeyID": ("92ed150794387c03ce684574b1139a65"
1462
2320
"94a34f895daaaf09fd8ea90a27cddb12"),
2321
"Secret": b"secret",
1463
2322
"Host": "foo.example.org",
1464
2323
"Enabled": True,
1465
2324
"Timeout": 300000,
1479
2338
"ExtendedTimeout": 900000,
1480
2339
"Expires": "2019-02-04T00:00:00",
1481
2340
"LastCheckerStatus": 0,
1482
},
1483
"barbar": {
2341
}
2342
self.other_client_properties = {
1484
2343
"Name": "barbar",
1485
2344
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
1486
2345
"6ab612cff5ad227247e46c2b020f441c"),
2346
"Secret": b"secretbar",
1487
2347
"Host": "192.0.2.3",
1488
2348
"Enabled": True,
1489
2349
"Timeout": 300000,
1503
2363
"ExtendedTimeout": 900000,
1504
2364
"Expires": "2019-02-05T00:00:00",
1505
2365
"LastCheckerStatus": -2,
1506
},
1507
}
1508
return super(TestDumpJSONCmd, self).setUp()
1509
1510
def test_normal(self):
1511
output = DumpJSONCmd().output(self.clients.values())
1512
json_data = json.loads(output)
1513
self.assertDictEqual(json_data, self.expected_json)
1514
1515
def test_one_client(self):
1516
output = DumpJSONCmd().output(self.one_client.values())
1517
json_data = json.loads(output)
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
2403
def setUp(self):
2404
self.bus = self.FakeMandosBus(self)
2405
2406
2407
class TestBaseCommands(TestCommand):
2408
2409
def test_IsEnabled_exits_successfully(self):
2410
with self.assertRaises(SystemExit) as e:
2411
command.IsEnabled().run(self.bus.one_client)
2412
if e.exception.code is not None:
2413
self.assertEqual(0, e.exception.code)
2414
else:
2415
self.assertIsNone(e.exception.code)
2416
2417
def test_IsEnabled_exits_with_failure(self):
2418
self.bus.client_properties["Enabled"] = False
2419
with self.assertRaises(SystemExit) as e:
2420
command.IsEnabled().run(self.bus.one_client)
2421
if isinstance(e.exception.code, int):
2422
self.assertNotEqual(0, e.exception.code)
2423
else:
2424
self.assertIsNotNone(e.exception.code)
2425
2426
def test_Approve(self):
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)
2434
2435
def test_Deny(self):
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)
2444
2445
def test_Remove(self):
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)
2456
2457
expected_json = {
2458
"foo": {
2459
"Name": "foo",
2460
"KeyID": ("92ed150794387c03ce684574b1139a65"
2461
"94a34f895daaaf09fd8ea90a27cddb12"),
2462
"Host": "foo.example.org",
2463
"Enabled": True,
2464
"Timeout": 300000,
2465
"LastCheckedOK": "2019-02-03T00:00:00",
2466
"Created": "2019-01-02T00:00:00",
2467
"Interval": 120000,
2468
"Fingerprint": ("778827225BA7DE539C5A"
2469
"7CFA59CFF7CDBD9A5920"),
2470
"CheckerRunning": False,
2471
"LastEnabled": "2019-01-03T00:00:00",
2472
"ApprovalPending": False,
2473
"ApprovedByDefault": True,
2474
"LastApprovalRequest": "",
2475
"ApprovalDelay": 0,
2476
"ApprovalDuration": 1000,
2477
"Checker": "fping -q -- %(host)s",
2478
"ExtendedTimeout": 900000,
2479
"Expires": "2019-02-04T00:00:00",
2480
"LastCheckerStatus": 0,
2481
},
2482
"barbar": {
2483
"Name": "barbar",
2484
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
2485
"6ab612cff5ad227247e46c2b020f441c"),
2486
"Host": "192.0.2.3",
2487
"Enabled": True,
2488
"Timeout": 300000,
2489
"LastCheckedOK": "2019-02-04T00:00:00",
2490
"Created": "2019-01-03T00:00:00",
2491
"Interval": 120000,
2492
"Fingerprint": ("3E393AEAEFB84C7E89E2"
2493
"F547B3A107558FCA3A27"),
2494
"CheckerRunning": True,
2495
"LastEnabled": "2019-01-04T00:00:00",
2496
"ApprovalPending": False,
2497
"ApprovedByDefault": False,
2498
"LastApprovalRequest": "2019-01-03T00:00:00",
2499
"ApprovalDelay": 30000,
2500
"ApprovalDuration": 93785000,
2501
"Checker": ":",
2502
"ExtendedTimeout": 900000,
2503
"Expires": "2019-02-05T00:00:00",
2504
"LastCheckerStatus": -2,
2505
},
2506
}
2507
2508
def test_DumpJSON_normal(self):
2509
with self.capture_stdout_to_buffer() as buffer:
2510
command.DumpJSON().run(self.bus.clients)
2511
json_data = json.loads(buffer.getvalue())
2512
self.assertDictEqual(self.expected_json, json_data)
2513
2514
@staticmethod
2515
@contextlib.contextmanager
2516
def capture_stdout_to_buffer():
2517
capture_buffer = io.StringIO()
2518
old_stdout = sys.stdout
2519
sys.stdout = capture_buffer
2520
try:
2521
yield capture_buffer
2522
finally:
2523
sys.stdout = old_stdout
2524
2525
def test_DumpJSON_one_client(self):
2526
with self.capture_stdout_to_buffer() as buffer:
2527
command.DumpJSON().run(self.bus.one_client)
2528
json_data = json.loads(buffer.getvalue())
1518
2529
expected_json = {"foo": self.expected_json["foo"]}
1519
self.assertDictEqual(json_data, expected_json)
1520
1521
1522
class TestPrintTableCmd(TestCmd):
1523
def test_normal(self):
1524
output = PrintTableCmd().output(self.clients.values())
2530
self.assertDictEqual(expected_json, json_data)
2531
2532
def test_PrintTable_normal(self):
2533
with self.capture_stdout_to_buffer() as buffer:
2534
command.PrintTable().run(self.bus.clients)
1525
2535
expected_output = "\n".join((
1526
2536
"Name Enabled Timeout Last Successful Check",
1527
2537
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1528
2538
"barbar Yes 00:05:00 2019-02-04T00:00:00 ",
1529
))
1530
self.assertEqual(output, expected_output)
2539
)) + "\n"
2540
self.assertEqual(expected_output, buffer.getvalue())
1531
2541
1532
def test_verbose(self):
1533
output = PrintTableCmd(verbose=True).output(
1534
self.clients.values())
2542
def test_PrintTable_verbose(self):
2543
with self.capture_stdout_to_buffer() as buffer:
2544
command.PrintTable(verbose=True).run(self.bus.clients)
1535
2545
columns = (
1536
2546
(
1537
2547
"Name ",
1619
2629
)
1620
2630
)
1621
2631
num_lines = max(len(rows) for rows in columns)
1622
expected_output = "\n".join("".join(rows[line]
1623
for rows in columns)
1624
for line in range(num_lines))
1625
self.assertEqual(output, expected_output)
2632
expected_output = ("\n".join("".join(rows[line]
2633
for rows in columns)
2634
for line in range(num_lines))
2635
+ "\n")
2636
self.assertEqual(expected_output, buffer.getvalue())
1626
2637
1627
def test_one_client(self):
1628
output = PrintTableCmd().output(self.one_client.values())
2638
def test_PrintTable_one_client(self):
2639
with self.capture_stdout_to_buffer() as buffer:
2640
command.PrintTable().run(self.bus.one_client)
1629
2641
expected_output = "\n".join((
1630
2642
"Name Enabled Timeout Last Successful Check",
1631
2643
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1632
))
1633
self.assertEqual(output, expected_output)
1634
1635
1636
class TestPropertyCmd(TestCmd):
1637
"""Abstract class for tests of PropertyCmd classes"""
2644
)) + "\n"
2645
self.assertEqual(expected_output, buffer.getvalue())
2646
2647
2648
class TestPropertySetterCmd(TestCommand):
2649
"""Abstract class for tests of command.PropertySetter classes"""
2650
1638
2651
def runTest(self):
1639
2652
if not hasattr(self, "command"):
1640
return
1641
values_to_get = getattr(self, "values_to_get",
1642
self.values_to_set)
1643
for value_to_set, value_to_get in zip(self.values_to_set,
1644
values_to_get):
1645
for clientpath in self.clients:
1646
client = self.bus.get_object(dbus_busname, clientpath)
1647
old_value = client.attributes[self.propname]
1648
self.assertNotIsInstance(old_value, self.Unique)
1649
client.attributes[self.propname] = self.Unique()
1650
self.run_command(value_to_set, self.clients)
1651
for clientpath in self.clients:
1652
client = self.bus.get_object(dbus_busname, clientpath)
1653
value = client.attributes[self.propname]
1654
self.assertNotIsInstance(value, self.Unique)
1655
self.assertEqual(value, value_to_get)
1656
1657
class Unique(object):
1658
"""Class for objects which exist only to be unique objects,
1659
since unittest.mock.sentinel only exists in Python 3.3"""
1660
1661
def run_command(self, value, clients):
1662
self.command().run(clients, self.bus)
1663
1664
1665
class TestEnableCmd(TestPropertyCmd):
1666
command = EnableCmd
1667
propname = "Enabled"
1668
values_to_set = [dbus.Boolean(True)]
1669
1670
1671
class TestDisableCmd(TestPropertyCmd):
1672
command = DisableCmd
1673
propname = "Enabled"
1674
values_to_set = [dbus.Boolean(False)]
1675
1676
1677
class TestBumpTimeoutCmd(TestPropertyCmd):
1678
command = BumpTimeoutCmd
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)
2673
self.assertEqual(value_to_get, value)
2674
2675
2676
class TestEnableCmd(TestPropertySetterCmd):
2677
command = command.Enable
2678
propname = "Enabled"
2679
values_to_get = [True]
2680
2681
2682
class TestDisableCmd(TestPropertySetterCmd):
2683
command = command.Disable
2684
propname = "Enabled"
2685
values_to_get = [False]
2686
2687
2688
class TestBumpTimeoutCmd(TestPropertySetterCmd):
2689
command = command.BumpTimeout
1679
2690
propname = "LastCheckedOK"
1680
values_to_set = [""]
1681
1682
1683
class TestStartCheckerCmd(TestPropertyCmd):
1684
command = StartCheckerCmd
1685
propname = "CheckerRunning"
1686
values_to_set = [dbus.Boolean(True)]
1687
1688
1689
class TestStopCheckerCmd(TestPropertyCmd):
1690
command = StopCheckerCmd
1691
propname = "CheckerRunning"
1692
values_to_set = [dbus.Boolean(False)]
1693
1694
1695
class TestApproveByDefaultCmd(TestPropertyCmd):
1696
command = ApproveByDefaultCmd
1697
propname = "ApprovedByDefault"
1698
values_to_set = [dbus.Boolean(True)]
1699
1700
1701
class TestDenyByDefaultCmd(TestPropertyCmd):
1702
command = DenyByDefaultCmd
1703
propname = "ApprovedByDefault"
1704
values_to_set = [dbus.Boolean(False)]
1705
1706
1707
class TestPropertyValueCmd(TestPropertyCmd):
1708
"""Abstract class for tests of PropertyValueCmd classes"""
1709
1710
def runTest(self):
1711
if type(self) is TestPropertyValueCmd:
1712
return
1713
return super(TestPropertyValueCmd, self).runTest()
1714
1715
def run_command(self, value, clients):
1716
self.command(value).run(clients, self.bus)
1717
1718
1719
class TestSetCheckerCmd(TestPropertyValueCmd):
1720
command = SetCheckerCmd
2691
values_to_get = [""]
2692
2693
2694
class TestStartCheckerCmd(TestPropertySetterCmd):
2695
command = command.StartChecker
2696
propname = "CheckerRunning"
2697
values_to_get = [True]
2698
2699
2700
class TestStopCheckerCmd(TestPropertySetterCmd):
2701
command = command.StopChecker
2702
propname = "CheckerRunning"
2703
values_to_get = [False]
2704
2705
2706
class TestApproveByDefaultCmd(TestPropertySetterCmd):
2707
command = command.ApproveByDefault
2708
propname = "ApprovedByDefault"
2709
values_to_get = [True]
2710
2711
2712
class TestDenyByDefaultCmd(TestPropertySetterCmd):
2713
command = command.DenyByDefault
2714
propname = "ApprovedByDefault"
2715
values_to_get = [False]
2716
2717
2718
class TestSetCheckerCmd(TestPropertySetterCmd):
2719
command = command.SetChecker
1721
2720
propname = "Checker"
1722
2721
values_to_set = ["", ":", "fping -q -- %s"]
1723
2722
1724
2723
1725
class TestSetHostCmd(TestPropertyValueCmd):
1726
command = SetHostCmd
2724
class TestSetHostCmd(TestPropertySetterCmd):
2725
command = command.SetHost
1727
2726
propname = "Host"
1728
values_to_set = ["192.0.2.3", "foo.example.org"]
1729
1730
1731
class TestSetSecretCmd(TestPropertyValueCmd):
1732
command = SetSecretCmd
2727
values_to_set = ["192.0.2.3", "client.example.org"]
2728
2729
2730
class TestSetSecretCmd(TestPropertySetterCmd):
2731
command = command.SetSecret
1733
2732
propname = "Secret"
1734
values_to_set = [io.BytesIO(b""),
1735
io.BytesIO(b"secret\0xyzzy\nbar")]
1736
values_to_get = [b"", b"secret\0xyzzy\nbar"]
1737
1738
1739
class TestSetTimeoutCmd(TestPropertyValueCmd):
1740
command = SetTimeoutCmd
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):
2742
command = command.SetTimeout
1741
2743
propname = "Timeout"
1742
2744
values_to_set = [datetime.timedelta(),
1743
2745
datetime.timedelta(minutes=5),
1744
2746
datetime.timedelta(seconds=1),
1745
2747
datetime.timedelta(weeks=1),
1746
2748
datetime.timedelta(weeks=52)]
1747
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1748
1749
1750
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
1751
command = SetExtendedTimeoutCmd
2749
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2750
2751
2752
class TestSetExtendedTimeoutCmd(TestPropertySetterCmd):
2753
command = command.SetExtendedTimeout
1752
2754
propname = "ExtendedTimeout"
1753
2755
values_to_set = [datetime.timedelta(),
1754
2756
datetime.timedelta(minutes=5),
1755
2757
datetime.timedelta(seconds=1),
1756
2758
datetime.timedelta(weeks=1),
1757
2759
datetime.timedelta(weeks=52)]
1758
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1759
1760
1761
class TestSetIntervalCmd(TestPropertyValueCmd):
1762
command = SetIntervalCmd
2760
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2761
2762
2763
class TestSetIntervalCmd(TestPropertySetterCmd):
2764
command = command.SetInterval
1763
2765
propname = "Interval"
1764
2766
values_to_set = [datetime.timedelta(),
1765
2767
datetime.timedelta(minutes=5),
1766
2768
datetime.timedelta(seconds=1),
1767
2769
datetime.timedelta(weeks=1),
1768
2770
datetime.timedelta(weeks=52)]
1769
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1770
1771
1772
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
1773
command = SetApprovalDelayCmd
2771
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2772
2773
2774
class TestSetApprovalDelayCmd(TestPropertySetterCmd):
2775
command = command.SetApprovalDelay
1774
2776
propname = "ApprovalDelay"
1775
2777
values_to_set = [datetime.timedelta(),
1776
2778
datetime.timedelta(minutes=5),
1777
2779
datetime.timedelta(seconds=1),
1778
2780
datetime.timedelta(weeks=1),
1779
2781
datetime.timedelta(weeks=52)]
1780
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1781
1782
1783
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
1784
command = SetApprovalDurationCmd
2782
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2783
2784
2785
class TestSetApprovalDurationCmd(TestPropertySetterCmd):
2786
command = command.SetApprovalDuration
1785
2787
propname = "ApprovalDuration"
1786
2788
values_to_set = [datetime.timedelta(),
1787
2789
datetime.timedelta(minutes=5),
1788
2790
datetime.timedelta(seconds=1),
1789
2791
datetime.timedelta(weeks=1),
1790
2792
datetime.timedelta(weeks=52)]
1791
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
2793
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1792
2794
1793
2795
1794
2796
1795
def should_only_run_tests():
2797
def parse_test_args():
2798
# type: () -> argparse.Namespace
1796
2799
parser = argparse.ArgumentParser(add_help=False)
1797
parser.add_argument("--check", action='store_true')
2800
parser.add_argument("--check", action="store_true")
2801
parser.add_argument("--prefix", )
1798
2802
args, unknown_args = parser.parse_known_args()
1799
run_tests = args.check
1800
if run_tests:
1801
# Remove --check argument from sys.argv
2803
if args.check:
2804
# Remove test options from sys.argv
1802
2805
sys.argv[1:] = unknown_args
1803
return run_tests
2806
return args
1804
2807
1805
2808
# Add all tests from doctest strings
1806
2809
def load_tests(loader, tests, none):
1809
2812
return tests
1810
2813
1811
2814
if __name__ == "__main__":
2815
options = parse_test_args()
1812
2816
try:
1813
if should_only_run_tests():
1814
# Call using ./tdd-python-script --check [--verbose]
1815
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=[""])
1816
2829
else:
1817
2830
main()
1818
2831
finally:
1819
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