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