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