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 1214
- compare with another revision
- download diff
- download tarball
- view history from revision 1214
- Committer: teddy at recompile
- Date: 2020-04-08 19:15:13 UTC
- mfrom: (237.4.130 release)
- Revision ID: teddy@recompile.se-20200408191513-n0ke303478rw1g0b
Merge from release branch
- files added:
- debian/po/POTFILES.in
- debian/tests
- dracut-module
- files modified:
- .bzrignore
added
removed
mandos-ctl
1
#!/usr/bin/python
2
# -*- mode: python; coding: utf-8; after-save-hook: (lambda () (let ((command (if (and (boundp 'tramp-file-name-structure) (string-match (car tramp-file-name-structure) (buffer-file-name))) (tramp-file-name-localname (tramp-dissect-file-name (buffer-file-name))) (buffer-file-name)))) (if (= (shell-command (format "%s --check" (shell-quote-argument command)) "*Test*") 0) (let ((w (get-buffer-window "*Test*"))) (if w (delete-window w)) (kill-buffer "*Test*")) (display-buffer "*Test*")))); -*-
1
#!/usr/bin/python3 -bbI
2
# -*- after-save-hook: (lambda () (let ((command (if (fboundp 'file-local-name) (file-local-name (buffer-file-name)) (or (file-remote-p (buffer-file-name) 'localname) (buffer-file-name))))) (if (= (progn (if (get-buffer "*Test*") (kill-buffer "*Test*")) (process-file-shell-command (format "%s --check" (shell-quote-argument command)) nil "*Test*")) 0) (let ((w (get-buffer-window "*Test*"))) (if w (delete-window w))) (progn (with-current-buffer "*Test*" (compilation-mode)) (display-buffer "*Test*" '(display-buffer-in-side-window)))))); coding: utf-8 -*-
3
3
#
4
4
# Mandos Monitor - Control and monitor the Mandos server
5
5
#
45
45
import io
46
46
import tempfile
47
47
import contextlib
48
import abc
49
50
import dbus as dbus_python
48
49
if sys.version_info.major == 2:
50
__metaclass__ = type
51
str = unicode
52
53
class gi:
54
"""Dummy gi module, for the tests"""
55
class repository:
56
class GLib:
57
class Error(Exception):
58
pass
59
dbussy = None
60
ravel = None
61
dbus_python = None
62
pydbus = None
63
64
try:
65
import dbussy
66
import ravel
67
except ImportError:
68
try:
69
import pydbus
70
import gi
71
except ImportError:
72
import dbus as dbus_python
73
51
74
52
75
# Show warnings by default
53
76
if not sys.warnoptions:
61
84
logging.captureWarnings(True) # Show warnings via the logging system
62
85
63
86
if sys.version_info.major == 2:
64
str = unicode
65
87
import StringIO
66
88
io.StringIO = StringIO.StringIO
67
89
68
90
locale.setlocale(locale.LC_ALL, "")
69
91
70
version = "1.8.3"
92
version = "1.8.11"
71
93
72
94
73
95
def main():
82
104
if options.debug:
83
105
log.setLevel(logging.DEBUG)
84
106
85
bus = dbus_python_adapter.CachingBus(dbus_python)
107
if dbussy is not None and ravel is not None:
108
bus = dbussy_adapter.CachingBus(dbussy, ravel)
109
elif pydbus is not None:
110
bus = pydbus_adapter.CachingBus(pydbus)
111
else:
112
bus = dbus_python_adapter.CachingBus(dbus_python)
86
113
87
114
try:
88
115
all_clients = bus.get_clients_and_properties()
122
149
help="Select all clients")
123
150
parser.add_argument("-v", "--verbose", action="store_true",
124
151
help="Print all fields")
125
parser.add_argument("-j", "--dump-json", action="store_true",
152
parser.add_argument("-j", "--dump-json", dest="commands",
153
action="append_const", default=[],
154
const=command.DumpJSON(),
126
155
help="Dump client data in JSON format")
127
156
enable_disable = parser.add_mutually_exclusive_group()
128
enable_disable.add_argument("-e", "--enable", action="store_true",
157
enable_disable.add_argument("-e", "--enable", dest="commands",
158
action="append_const", default=[],
159
const=command.Enable(),
129
160
help="Enable client")
130
enable_disable.add_argument("-d", "--disable",
131
action="store_true",
161
enable_disable.add_argument("-d", "--disable", dest="commands",
162
action="append_const", default=[],
163
const=command.Disable(),
132
164
help="disable client")
133
parser.add_argument("-b", "--bump-timeout", action="store_true",
165
parser.add_argument("-b", "--bump-timeout", dest="commands",
166
action="append_const", default=[],
167
const=command.BumpTimeout(),
134
168
help="Bump timeout for client")
135
169
start_stop_checker = parser.add_mutually_exclusive_group()
136
170
start_stop_checker.add_argument("--start-checker",
137
action="store_true",
171
dest="commands",
172
action="append_const", default=[],
173
const=command.StartChecker(),
138
174
help="Start checker for client")
139
start_stop_checker.add_argument("--stop-checker",
140
action="store_true",
175
start_stop_checker.add_argument("--stop-checker", dest="commands",
176
action="append_const", default=[],
177
const=command.StopChecker(),
141
178
help="Stop checker for client")
142
parser.add_argument("-V", "--is-enabled", action="store_true",
179
parser.add_argument("-V", "--is-enabled", dest="commands",
180
action="append_const", default=[],
181
const=command.IsEnabled(),
143
182
help="Check if client is enabled")
144
parser.add_argument("-r", "--remove", action="store_true",
183
parser.add_argument("-r", "--remove", dest="commands",
184
action="append_const", default=[],
185
const=command.Remove(),
145
186
help="Remove client")
146
parser.add_argument("-c", "--checker",
187
parser.add_argument("-c", "--checker", dest="commands",
188
action="append", default=[],
189
metavar="COMMAND", type=command.SetChecker,
147
190
help="Set checker command for client")
148
parser.add_argument("-t", "--timeout", type=string_to_delta,
149
help="Set timeout for client")
150
parser.add_argument("--extended-timeout", type=string_to_delta,
151
help="Set extended timeout for client")
152
parser.add_argument("-i", "--interval", type=string_to_delta,
153
help="Set checker interval for client")
191
parser.add_argument(
192
"-t", "--timeout", dest="commands", action="append",
193
default=[], metavar="TIME",
194
type=command.SetTimeout.argparse(string_to_delta),
195
help="Set timeout for client")
196
parser.add_argument(
197
"--extended-timeout", dest="commands", action="append",
198
default=[], metavar="TIME",
199
type=command.SetExtendedTimeout.argparse(string_to_delta),
200
help="Set extended timeout for client")
201
parser.add_argument(
202
"-i", "--interval", dest="commands", action="append",
203
default=[], metavar="TIME",
204
type=command.SetInterval.argparse(string_to_delta),
205
help="Set checker interval for client")
154
206
approve_deny_default = parser.add_mutually_exclusive_group()
155
207
approve_deny_default.add_argument(
156
"--approve-by-default", action="store_true",
157
default=None, dest="approved_by_default",
208
"--approve-by-default", dest="commands",
209
action="append_const", default=[],
210
const=command.ApproveByDefault(),
158
211
help="Set client to be approved by default")
159
212
approve_deny_default.add_argument(
160
"--deny-by-default", action="store_false",
161
dest="approved_by_default",
213
"--deny-by-default", dest="commands",
214
action="append_const", default=[],
215
const=command.DenyByDefault(),
162
216
help="Set client to be denied by default")
163
parser.add_argument("--approval-delay", type=string_to_delta,
164
help="Set delay before client approve/deny")
165
parser.add_argument("--approval-duration", type=string_to_delta,
166
help="Set duration of one client approval")
167
parser.add_argument("-H", "--host", help="Set host for client")
168
parser.add_argument("-s", "--secret",
169
type=argparse.FileType(mode="rb"),
170
help="Set password blob (file) for client")
217
parser.add_argument(
218
"--approval-delay", dest="commands", action="append",
219
default=[], metavar="TIME",
220
type=command.SetApprovalDelay.argparse(string_to_delta),
221
help="Set delay before client approve/deny")
222
parser.add_argument(
223
"--approval-duration", dest="commands", action="append",
224
default=[], metavar="TIME",
225
type=command.SetApprovalDuration.argparse(string_to_delta),
226
help="Set duration of one client approval")
227
parser.add_argument("-H", "--host", dest="commands",
228
action="append", default=[], metavar="STRING",
229
type=command.SetHost,
230
help="Set host for client")
231
parser.add_argument(
232
"-s", "--secret", dest="commands", action="append",
233
default=[], metavar="FILENAME",
234
type=command.SetSecret.argparse(argparse.FileType(mode="rb")),
235
help="Set password blob (file) for client")
171
236
approve_deny = parser.add_mutually_exclusive_group()
172
237
approve_deny.add_argument(
173
"-A", "--approve", action="store_true",
238
"-A", "--approve", dest="commands", action="append_const",
239
default=[], const=command.Approve(),
174
240
help="Approve any current client request")
175
approve_deny.add_argument("-D", "--deny", action="store_true",
241
approve_deny.add_argument("-D", "--deny", dest="commands",
242
action="append_const", default=[],
243
const=command.Deny(),
176
244
help="Deny any current client request")
177
245
parser.add_argument("--debug", action="store_true",
178
246
help="Debug mode (show D-Bus commands)")
195
263
def rfc3339_duration_to_delta(duration):
196
264
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
197
265
198
>>> rfc3339_duration_to_delta("P7D")
199
datetime.timedelta(7)
200
>>> rfc3339_duration_to_delta("PT60S")
201
datetime.timedelta(0, 60)
202
>>> rfc3339_duration_to_delta("PT60M")
203
datetime.timedelta(0, 3600)
204
>>> rfc3339_duration_to_delta("P60M")
205
datetime.timedelta(1680)
206
>>> rfc3339_duration_to_delta("PT24H")
207
datetime.timedelta(1)
208
>>> rfc3339_duration_to_delta("P1W")
209
datetime.timedelta(7)
210
>>> rfc3339_duration_to_delta("PT5M30S")
211
datetime.timedelta(0, 330)
212
>>> rfc3339_duration_to_delta("P1DT3M20S")
213
datetime.timedelta(1, 200)
266
>>> rfc3339_duration_to_delta("P7D") == datetime.timedelta(7)
267
True
268
>>> rfc3339_duration_to_delta("PT60S") == datetime.timedelta(0, 60)
269
True
270
>>> rfc3339_duration_to_delta("PT60M") == datetime.timedelta(hours=1)
271
True
272
>>> # 60 months
273
>>> rfc3339_duration_to_delta("P60M") == datetime.timedelta(1680)
274
True
275
>>> rfc3339_duration_to_delta("PT24H") == datetime.timedelta(1)
276
True
277
>>> rfc3339_duration_to_delta("P1W") == datetime.timedelta(7)
278
True
279
>>> rfc3339_duration_to_delta("PT5M30S") == datetime.timedelta(0, 330)
280
True
281
>>> rfc3339_duration_to_delta("P1DT3M20S") == datetime.timedelta(1, 200)
282
True
214
283
>>> # Can not be empty:
215
284
>>> rfc3339_duration_to_delta("")
216
285
Traceback (most recent call last):
326
395
"""Parse an interval string as documented by Mandos before 1.6.1,
327
396
and return a datetime.timedelta
328
397
329
>>> parse_pre_1_6_1_interval('7d')
330
datetime.timedelta(7)
331
>>> parse_pre_1_6_1_interval('60s')
332
datetime.timedelta(0, 60)
333
>>> parse_pre_1_6_1_interval('60m')
334
datetime.timedelta(0, 3600)
335
>>> parse_pre_1_6_1_interval('24h')
336
datetime.timedelta(1)
337
>>> parse_pre_1_6_1_interval('1w')
338
datetime.timedelta(7)
339
>>> parse_pre_1_6_1_interval('5m 30s')
340
datetime.timedelta(0, 330)
341
>>> parse_pre_1_6_1_interval('')
342
datetime.timedelta(0)
398
>>> parse_pre_1_6_1_interval('7d') == datetime.timedelta(days=7)
399
True
400
>>> parse_pre_1_6_1_interval('60s') == datetime.timedelta(0, 60)
401
True
402
>>> parse_pre_1_6_1_interval('60m') == datetime.timedelta(hours=1)
403
True
404
>>> parse_pre_1_6_1_interval('24h') == datetime.timedelta(days=1)
405
True
406
>>> parse_pre_1_6_1_interval('1w') == datetime.timedelta(days=7)
407
True
408
>>> parse_pre_1_6_1_interval('5m 30s') == datetime.timedelta(0, 330)
409
True
410
>>> parse_pre_1_6_1_interval('') == datetime.timedelta(0)
411
True
343
412
>>> # Ignore unknown characters, allow any order and repetitions
344
>>> parse_pre_1_6_1_interval('2dxy7zz11y3m5m')
345
datetime.timedelta(2, 480, 18000)
413
>>> parse_pre_1_6_1_interval('2dxy7zz11y3m5m') == datetime.timedelta(2, 480, 18000)
414
True
346
415
347
416
"""
348
417
369
438
"""Apply additional restrictions on options, not expressible in
370
439
argparse"""
371
440
372
def has_actions(options):
373
return any((options.enable,
374
options.disable,
375
options.bump_timeout,
376
options.start_checker,
377
options.stop_checker,
378
options.is_enabled,
379
options.remove,
380
options.checker is not None,
381
options.timeout is not None,
382
options.extended_timeout is not None,
383
options.interval is not None,
384
options.approved_by_default is not None,
385
options.approval_delay is not None,
386
options.approval_duration is not None,
387
options.host is not None,
388
options.secret is not None,
389
options.approve,
390
options.deny))
441
def has_commands(options, commands=None):
442
if commands is None:
443
commands = (command.Enable,
444
command.Disable,
445
command.BumpTimeout,
446
command.StartChecker,
447
command.StopChecker,
448
command.IsEnabled,
449
command.Remove,
450
command.SetChecker,
451
command.SetTimeout,
452
command.SetExtendedTimeout,
453
command.SetInterval,
454
command.ApproveByDefault,
455
command.DenyByDefault,
456
command.SetApprovalDelay,
457
command.SetApprovalDuration,
458
command.SetHost,
459
command.SetSecret,
460
command.Approve,
461
command.Deny)
462
return any(isinstance(cmd, commands)
463
for cmd in options.commands)
391
464
392
if has_actions(options) and not (options.client or options.all):
465
if has_commands(options) and not (options.client or options.all):
393
466
parser.error("Options require clients names or --all.")
394
if options.verbose and has_actions(options):
467
if options.verbose and has_commands(options):
395
468
parser.error("--verbose can only be used alone.")
396
if options.dump_json and (options.verbose
397
or has_actions(options)):
469
if (has_commands(options, (command.DumpJSON,))
470
and (options.verbose or len(options.commands) > 1)):
398
471
parser.error("--dump-json can only be used alone.")
399
if options.all and not has_actions(options):
472
if options.all and not has_commands(options):
400
473
parser.error("--all requires an action.")
401
if options.is_enabled and len(options.client) > 1:
474
if (has_commands(options, (command.IsEnabled,))
475
and len(options.client) > 1):
402
476
parser.error("--is-enabled requires exactly one client")
403
if options.remove:
404
options.remove = False
405
if has_actions(options) and not options.deny:
406
parser.error("--remove can only be combined with --deny")
407
options.remove = True
408
409
410
411
class dbus(object):
412
413
class SystemBus(object):
477
if (len(options.commands) > 1
478
and has_commands(options, (command.Remove,))
479
and not has_commands(options, (command.Deny,))):
480
parser.error("--remove can only be combined with --deny")
481
482
483
class dbus:
484
485
class SystemBus:
414
486
415
487
object_manager_iface = "org.freedesktop.DBus.ObjectManager"
416
488
def get_managed_objects(self, busname, objectpath):
425
497
self.properties_iface, interface, key,
426
498
value)
427
499
500
def call_method(self, methodname, busname, objectpath,
501
interface, *args):
502
raise NotImplementedError()
503
428
504
429
505
class MandosBus(SystemBus):
430
506
busname_domain = "se.recompile"
462
538
pass
463
539
464
540
465
class dbus_python_adapter(object):
541
class dbus_python_adapter:
466
542
467
543
class SystemBus(dbus.MandosBus):
468
544
"""Use dbus-python"""
513
589
for key, subval in value.items()}
514
590
return value
515
591
592
def set_client_property(self, objectpath, key, value):
593
if key == "Secret":
594
if not isinstance(value, bytes):
595
value = value.encode("utf-8")
596
value = self.dbus_python.ByteArray(value)
597
return self.set_property(self.busname, objectpath,
598
self.client_interface, key,
599
value)
516
600
517
class SilenceLogger(object):
601
class SilenceLogger:
518
602
"Simple context manager to silence a particular logger"
519
603
def __init__(self, loggername):
520
604
self.logger = logging.getLogger(loggername)
549
633
return new_object
550
634
551
635
636
class pydbus_adapter:
637
class SystemBus(dbus.MandosBus):
638
def __init__(self, module=pydbus):
639
self.pydbus = module
640
self.bus = self.pydbus.SystemBus()
641
642
@contextlib.contextmanager
643
def convert_exception(self, exception_class=dbus.Error):
644
try:
645
yield
646
except gi.repository.GLib.Error as e:
647
# This does what "raise from" would do
648
exc = exception_class(*e.args)
649
exc.__cause__ = e
650
raise exc
651
652
def call_method(self, methodname, busname, objectpath,
653
interface, *args):
654
proxy_object = self.get(busname, objectpath)
655
log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
656
interface, methodname,
657
", ".join(repr(a) for a in args))
658
method = getattr(proxy_object[interface], methodname)
659
with self.convert_exception():
660
return method(*args)
661
662
def get(self, busname, objectpath):
663
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
664
busname, objectpath)
665
with self.convert_exception(dbus.ConnectFailed):
666
if sys.version_info.major <= 2:
667
with warnings.catch_warnings():
668
warnings.filterwarnings(
669
"ignore", "", DeprecationWarning,
670
r"^xml\.etree\.ElementTree$")
671
return self.bus.get(busname, objectpath)
672
else:
673
return self.bus.get(busname, objectpath)
674
675
def set_property(self, busname, objectpath, interface, key,
676
value):
677
proxy_object = self.get(busname, objectpath)
678
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", busname,
679
objectpath, self.properties_iface, interface,
680
key, value)
681
setattr(proxy_object[interface], key, value)
682
683
class CachingBus(SystemBus):
684
"""A caching layer for pydbus_adapter.SystemBus"""
685
def __init__(self, *args, **kwargs):
686
self.object_cache = {}
687
super(pydbus_adapter.CachingBus,
688
self).__init__(*args, **kwargs)
689
def get(self, busname, objectpath):
690
try:
691
return self.object_cache[(busname, objectpath)]
692
except KeyError:
693
new_object = (super(pydbus_adapter.CachingBus, self)
694
.get(busname, objectpath))
695
self.object_cache[(busname, objectpath)] = new_object
696
return new_object
697
698
699
class dbussy_adapter:
700
class SystemBus(dbus.SystemBus):
701
"""Use DBussy"""
702
703
def __init__(self, dbussy, ravel):
704
self.dbussy = dbussy
705
self.ravel = ravel
706
self.bus = ravel.system_bus()
707
708
@contextlib.contextmanager
709
def convert_exception(self, exception_class=dbus.Error):
710
try:
711
yield
712
except self.dbussy.DBusError as e:
713
# This does what "raise from" would do
714
exc = exception_class(*e.args)
715
exc.__cause__ = e
716
raise exc
717
718
def call_method(self, methodname, busname, objectpath,
719
interface, *args):
720
proxy_object = self.get_object(busname, objectpath)
721
log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
722
interface, methodname,
723
", ".join(repr(a) for a in args))
724
iface = proxy_object.get_interface(interface)
725
method = getattr(iface, methodname)
726
with self.convert_exception(dbus.Error):
727
value = method(*args)
728
# DBussy returns values either as an empty list or as a
729
# tuple: (signature, value)
730
if value:
731
return self.type_filter(value[0])
732
733
def get_object(self, busname, objectpath):
734
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
735
busname, objectpath)
736
with self.convert_exception(dbus.ConnectFailed):
737
return self.bus[busname][objectpath]
738
739
def type_filter(self, value):
740
"""Convert the most bothersome types to Python types"""
741
if isinstance(value, tuple):
742
if (len(value) == 2
743
and isinstance(value[0],
744
self.dbussy.DBUS.Signature)):
745
return self.type_filter(value[1])
746
elif isinstance(value, self.dbussy.DBUS.ObjectPath):
747
return str(value)
748
# Also recurse into dictionaries
749
elif isinstance(value, dict):
750
return {self.type_filter(key):
751
self.type_filter(subval)
752
for key, subval in value.items()}
753
return value
754
755
def set_property(self, busname, objectpath, interface, key,
756
value):
757
proxy_object = self.get_object(busname, objectpath)
758
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", busname,
759
objectpath, self.properties_iface, interface,
760
key, value)
761
if key == "Secret":
762
# DBussy wants a Byte Array to be a sequence of
763
# values, not a byte string
764
value = tuple(value)
765
setattr(proxy_object.get_interface(interface), key, value)
766
767
class MandosBus(SystemBus, dbus.MandosBus):
768
pass
769
770
class CachingBus(MandosBus):
771
"""A caching layer for dbussy_adapter.MandosBus"""
772
def __init__(self, *args, **kwargs):
773
self.object_cache = {}
774
super(dbussy_adapter.CachingBus, self).__init__(*args,
775
**kwargs)
776
def get_object(self, busname, objectpath):
777
try:
778
return self.object_cache[(busname, objectpath)]
779
except KeyError:
780
new_object = super(
781
dbussy_adapter.CachingBus,
782
self).get_object(busname, objectpath)
783
self.object_cache[(busname, objectpath)] = new_object
784
return new_object
785
786
552
787
def commands_from_options(options):
553
788
554
commands = []
555
556
if options.is_enabled:
557
commands.append(command.IsEnabled())
558
559
if options.approve:
560
commands.append(command.Approve())
561
562
if options.deny:
563
commands.append(command.Deny())
564
565
if options.remove:
566
commands.append(command.Remove())
567
568
if options.dump_json:
569
commands.append(command.DumpJSON())
570
571
if options.enable:
572
commands.append(command.Enable())
573
574
if options.disable:
575
commands.append(command.Disable())
576
577
if options.bump_timeout:
578
commands.append(command.BumpTimeout())
579
580
if options.start_checker:
581
commands.append(command.StartChecker())
582
583
if options.stop_checker:
584
commands.append(command.StopChecker())
585
586
if options.approved_by_default is not None:
587
if options.approved_by_default:
588
commands.append(command.ApproveByDefault())
789
commands = list(options.commands)
790
791
def find_cmd(cmd, commands):
792
i = 0
793
for i, c in enumerate(commands):
794
if isinstance(c, cmd):
795
return i
796
return i+1
797
798
# If command.Remove is present, move any instances of command.Deny
799
# to occur ahead of command.Remove.
800
index_of_remove = find_cmd(command.Remove, commands)
801
before_remove = commands[:index_of_remove]
802
after_remove = commands[index_of_remove:]
803
cleaned_after = []
804
for cmd in after_remove:
805
if isinstance(cmd, command.Deny):
806
before_remove.append(cmd)
589
807
else:
590
commands.append(command.DenyByDefault())
591
592
if options.checker is not None:
593
commands.append(command.SetChecker(options.checker))
594
595
if options.host is not None:
596
commands.append(command.SetHost(options.host))
597
598
if options.secret is not None:
599
commands.append(command.SetSecret(options.secret))
600
601
if options.timeout is not None:
602
commands.append(command.SetTimeout(options.timeout))
603
604
if options.extended_timeout:
605
commands.append(
606
command.SetExtendedTimeout(options.extended_timeout))
607
608
if options.interval is not None:
609
commands.append(command.SetInterval(options.interval))
610
611
if options.approval_delay is not None:
612
commands.append(
613
command.SetApprovalDelay(options.approval_delay))
614
615
if options.approval_duration is not None:
616
commands.append(
617
command.SetApprovalDuration(options.approval_duration))
808
cleaned_after.append(cmd)
809
if cleaned_after != after_remove:
810
commands = before_remove + cleaned_after
618
811
619
812
# If no command option has been given, show table of clients,
620
813
# optionally verbosely
624
817
return commands
625
818
626
819
627
class command(object):
820
class command:
628
821
"""A namespace for command classes"""
629
822
630
class Base(object):
823
class Base:
631
824
"""Abstract base class for commands"""
632
825
def run(self, clients, bus=None):
633
826
"""Normal commands should implement run_on_one_client(),
696
889
keywords = self.all_keywords
697
890
print(self.TableOfClients(clients.values(), keywords))
698
891
699
class TableOfClients(object):
892
class TableOfClients:
700
893
tableheaders = {
701
894
"Name": "Name",
702
895
"Enabled": "Enabled",
835
1028
def __init__(self, value):
836
1029
self.value_to_set = value
837
1030
1031
@classmethod
1032
def argparse(cls, argtype):
1033
def cmdtype(arg):
1034
return cls(argtype(arg))
1035
return cmdtype
838
1036
839
1037
class SetChecker(PropertySetterValue):
840
1038
propname = "Checker"
928
1126
"output"))
929
1127
930
1128
931
class Unique(object):
1129
class Unique:
932
1130
"""Class for objects which exist only to be unique objects, since
933
1131
unittest.mock.sentinel only exists in Python 3.3"""
934
1132
936
1134
class Test_string_to_delta(TestCaseWithAssertLogs):
937
1135
# Just test basic RFC 3339 functionality here, the doc string for
938
1136
# rfc3339_duration_to_delta() already has more comprehensive
939
# tests, which is run by doctest.
1137
# tests, which are run by doctest.
940
1138
941
1139
def test_rfc3339_zero_seconds(self):
942
1140
self.assertEqual(datetime.timedelta(),
966
1164
967
1165
def test_actions_requires_client_or_all(self):
968
1166
for action, value in self.actions.items():
969
options = self.parser.parse_args()
970
setattr(options, action, value)
1167
args = self.actionargs(action, value)
971
1168
with self.assertParseError():
972
self.check_option_syntax(options)
1169
self.parse_args(args)
973
1170
974
# This mostly corresponds to the definition from has_actions() in
1171
# This mostly corresponds to the definition from has_commands() in
975
1172
# check_option_syntax()
976
1173
actions = {
977
# The actual values set here are not that important, but we do
978
# at least stick to the correct types, even though they are
979
# never used
980
"enable": True,
981
"disable": True,
982
"bump_timeout": True,
983
"start_checker": True,
984
"stop_checker": True,
985
"is_enabled": True,
986
"remove": True,
987
"checker": "x",
988
"timeout": datetime.timedelta(),
989
"extended_timeout": datetime.timedelta(),
990
"interval": datetime.timedelta(),
991
"approved_by_default": True,
992
"approval_delay": datetime.timedelta(),
993
"approval_duration": datetime.timedelta(),
994
"host": "x",
995
"secret": io.BytesIO(b"x"),
996
"approve": True,
997
"deny": True,
1174
"--enable": None,
1175
"--disable": None,
1176
"--bump-timeout": None,
1177
"--start-checker": None,
1178
"--stop-checker": None,
1179
"--is-enabled": None,
1180
"--remove": None,
1181
"--checker": "x",
1182
"--timeout": "PT0S",
1183
"--extended-timeout": "PT0S",
1184
"--interval": "PT0S",
1185
"--approve-by-default": None,
1186
"--deny-by-default": None,
1187
"--approval-delay": "PT0S",
1188
"--approval-duration": "PT0S",
1189
"--host": "hostname",
1190
"--secret": "/dev/null",
1191
"--approve": None,
1192
"--deny": None,
998
1193
}
999
1194
1195
@staticmethod
1196
def actionargs(action, value, *args):
1197
if value is not None:
1198
return [action, value] + list(args)
1199
else:
1200
return [action] + list(args)
1201
1000
1202
@contextlib.contextmanager
1001
1203
def assertParseError(self):
1002
1204
with self.assertRaises(SystemExit) as e:
1007
1209
# /argparse.html#exiting-methods
1008
1210
self.assertEqual(2, e.exception.code)
1009
1211
1212
def parse_args(self, args):
1213
options = self.parser.parse_args(args)
1214
check_option_syntax(self.parser, options)
1215
1010
1216
@staticmethod
1011
1217
@contextlib.contextmanager
1012
1218
def redirect_stderr_to_devnull():
1023
1229
1024
1230
def test_actions_all_conflicts_with_verbose(self):
1025
1231
for action, value in self.actions.items():
1026
options = self.parser.parse_args()
1027
setattr(options, action, value)
1028
options.all = True
1029
options.verbose = True
1232
args = self.actionargs(action, value, "--all",
1233
"--verbose")
1030
1234
with self.assertParseError():
1031
self.check_option_syntax(options)
1235
self.parse_args(args)
1032
1236
1033
1237
def test_actions_with_client_conflicts_with_verbose(self):
1034
1238
for action, value in self.actions.items():
1035
options = self.parser.parse_args()
1036
setattr(options, action, value)
1037
options.verbose = True
1038
options.client = ["client"]
1239
args = self.actionargs(action, value, "--verbose",
1240
"client")
1039
1241
with self.assertParseError():
1040
self.check_option_syntax(options)
1242
self.parse_args(args)
1041
1243
1042
1244
def test_dump_json_conflicts_with_verbose(self):
1043
options = self.parser.parse_args()
1044
options.dump_json = True
1045
options.verbose = True
1245
args = ["--dump-json", "--verbose"]
1046
1246
with self.assertParseError():
1047
self.check_option_syntax(options)
1247
self.parse_args(args)
1048
1248
1049
1249
def test_dump_json_conflicts_with_action(self):
1050
1250
for action, value in self.actions.items():
1051
options = self.parser.parse_args()
1052
setattr(options, action, value)
1053
options.dump_json = True
1251
args = self.actionargs(action, value, "--dump-json")
1054
1252
with self.assertParseError():
1055
self.check_option_syntax(options)
1253
self.parse_args(args)
1056
1254
1057
1255
def test_all_can_not_be_alone(self):
1058
options = self.parser.parse_args()
1059
options.all = True
1256
args = ["--all"]
1060
1257
with self.assertParseError():
1061
self.check_option_syntax(options)
1258
self.parse_args(args)
1062
1259
1063
1260
def test_all_is_ok_with_any_action(self):
1064
1261
for action, value in self.actions.items():
1065
options = self.parser.parse_args()
1066
setattr(options, action, value)
1067
options.all = True
1068
self.check_option_syntax(options)
1262
args = self.actionargs(action, value, "--all")
1263
self.parse_args(args)
1069
1264
1070
1265
def test_any_action_is_ok_with_one_client(self):
1071
1266
for action, value in self.actions.items():
1072
options = self.parser.parse_args()
1073
setattr(options, action, value)
1074
options.client = ["client"]
1075
self.check_option_syntax(options)
1267
args = self.actionargs(action, value, "client")
1268
self.parse_args(args)
1076
1269
1077
1270
def test_one_client_with_all_actions_except_is_enabled(self):
1078
options = self.parser.parse_args()
1079
1271
for action, value in self.actions.items():
1080
if action == "is_enabled":
1272
if action == "--is-enabled":
1081
1273
continue
1082
setattr(options, action, value)
1083
options.client = ["client"]
1084
self.check_option_syntax(options)
1274
args = self.actionargs(action, value, "client")
1275
self.parse_args(args)
1085
1276
1086
1277
def test_two_clients_with_all_actions_except_is_enabled(self):
1087
options = self.parser.parse_args()
1088
1278
for action, value in self.actions.items():
1089
if action == "is_enabled":
1279
if action == "--is-enabled":
1090
1280
continue
1091
setattr(options, action, value)
1092
options.client = ["client1", "client2"]
1093
self.check_option_syntax(options)
1281
args = self.actionargs(action, value, "client1",
1282
"client2")
1283
self.parse_args(args)
1094
1284
1095
1285
def test_two_clients_are_ok_with_actions_except_is_enabled(self):
1096
1286
for action, value in self.actions.items():
1097
if action == "is_enabled":
1287
if action == "--is-enabled":
1098
1288
continue
1099
options = self.parser.parse_args()
1100
setattr(options, action, value)
1101
options.client = ["client1", "client2"]
1102
self.check_option_syntax(options)
1289
args = self.actionargs(action, value, "client1",
1290
"client2")
1291
self.parse_args(args)
1103
1292
1104
1293
def test_is_enabled_fails_without_client(self):
1105
options = self.parser.parse_args()
1106
options.is_enabled = True
1294
args = ["--is-enabled"]
1107
1295
with self.assertParseError():
1108
self.check_option_syntax(options)
1296
self.parse_args(args)
1109
1297
1110
1298
def test_is_enabled_fails_with_two_clients(self):
1111
options = self.parser.parse_args()
1112
options.is_enabled = True
1113
options.client = ["client1", "client2"]
1299
args = ["--is-enabled", "client1", "client2"]
1114
1300
with self.assertParseError():
1115
self.check_option_syntax(options)
1301
self.parse_args(args)
1116
1302
1117
1303
def test_remove_can_only_be_combined_with_action_deny(self):
1118
1304
for action, value in self.actions.items():
1119
if action in {"remove", "deny"}:
1305
if action in {"--remove", "--deny"}:
1120
1306
continue
1121
options = self.parser.parse_args()
1122
setattr(options, action, value)
1123
options.all = True
1124
options.remove = True
1307
args = self.actionargs(action, value, "--all",
1308
"--remove")
1125
1309
with self.assertParseError():
1126
self.check_option_syntax(options)
1310
self.parse_args(args)
1127
1311
1128
1312
1129
1313
class Test_dbus_exceptions(unittest.TestCase):
1232
1416
class Test_dbus_python_adapter_SystemBus(TestCaseWithAssertLogs):
1233
1417
1234
1418
def MockDBusPython_func(self, func):
1235
class mock_dbus_python(object):
1419
class mock_dbus_python:
1236
1420
"""mock dbus-python module"""
1237
class exceptions(object):
1421
class exceptions:
1238
1422
"""Pseudo-namespace"""
1239
1423
class DBusException(Exception):
1240
1424
pass
1241
class SystemBus(object):
1425
class SystemBus:
1242
1426
@staticmethod
1243
1427
def get_object(busname, objectpath):
1244
1428
DBusObject = collections.namedtuple(
1245
"DBusObject", ("methodname",))
1429
"DBusObject", ("methodname", "Set"))
1246
1430
def method(*args, **kwargs):
1247
1431
self.assertEqual({"dbus_interface":
1248
1432
"interface"},
1249
1433
kwargs)
1250
1434
return func(*args)
1251
return DBusObject(methodname=method)
1252
class Boolean(object):
1435
def set_property(interface, key, value,
1436
dbus_interface=None):
1437
self.assertEqual(
1438
"org.freedesktop.DBus.Properties",
1439
dbus_interface)
1440
self.assertEqual("Secret", key)
1441
return func(interface, key, value,
1442
dbus_interface=dbus_interface)
1443
return DBusObject(methodname=method,
1444
Set=set_property)
1445
class Boolean:
1253
1446
def __init__(self, value):
1254
1447
self.value = bool(value)
1255
1448
def __bool__(self):
1260
1453
pass
1261
1454
class Dictionary(dict):
1262
1455
pass
1456
class ByteArray(bytes):
1457
pass
1263
1458
return mock_dbus_python
1264
1459
1265
1460
def call_method(self, bus, methodname, busname, objectpath,
1437
1632
finally:
1438
1633
dbus_logger.removeFilter(counting_handler)
1439
1634
1440
self.assertNotIsInstance(e, dbus.ConnectFailed)
1635
self.assertNotIsInstance(e.exception, dbus.ConnectFailed)
1441
1636
1442
1637
# Make sure the dbus logger was suppressed
1443
1638
self.assertEqual(0, counting_handler.count)
1444
1639
1640
def test_Set_Secret_sends_bytearray(self):
1641
ret = [None]
1642
def func(*args, **kwargs):
1643
ret[0] = (args, kwargs)
1644
mock_dbus_python = self.MockDBusPython_func(func)
1645
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1646
bus.set_client_property("objectpath", "Secret", "value")
1647
expected_call = (("se.recompile.Mandos.Client", "Secret",
1648
mock_dbus_python.ByteArray(b"value")),
1649
{"dbus_interface":
1650
"org.freedesktop.DBus.Properties"})
1651
self.assertEqual(expected_call, ret[0])
1652
if sys.version_info.major == 2:
1653
self.assertIsInstance(ret[0][0][-1],
1654
mock_dbus_python.ByteArray)
1655
1445
1656
def test_get_object_converts_to_correct_exception(self):
1446
1657
bus = dbus_python_adapter.SystemBus(
1447
1658
self.fake_dbus_python_raises_exception_on_connect)
1449
1660
self.call_method(bus, "methodname", "busname",
1450
1661
"objectpath", "interface")
1451
1662
1452
class fake_dbus_python_raises_exception_on_connect(object):
1663
class fake_dbus_python_raises_exception_on_connect:
1453
1664
"""fake dbus-python module"""
1454
class exceptions(object):
1665
class exceptions:
1455
1666
"""Pseudo-namespace"""
1456
1667
class DBusException(Exception):
1457
1668
pass
1465
1676
1466
1677
1467
1678
class Test_dbus_python_adapter_CachingBus(unittest.TestCase):
1468
class mock_dbus_python(object):
1679
class mock_dbus_python:
1469
1680
"""mock dbus-python modules"""
1470
class SystemBus(object):
1681
class SystemBus:
1471
1682
@staticmethod
1472
1683
def get_object(busname, objectpath):
1473
1684
return Unique()
1516
1727
self.assertIs(obj1, obj1b)
1517
1728
1518
1729
1730
class Test_pydbus_adapter_SystemBus(TestCaseWithAssertLogs):
1731
1732
def Stub_pydbus_func(self, func):
1733
class stub_pydbus:
1734
"""stub pydbus module"""
1735
class SystemBus:
1736
@staticmethod
1737
def get(busname, objectpath):
1738
DBusObject = collections.namedtuple(
1739
"DBusObject", ("methodname",))
1740
return {"interface":
1741
DBusObject(methodname=func)}
1742
return stub_pydbus
1743
1744
def call_method(self, bus, methodname, busname, objectpath,
1745
interface, *args):
1746
with self.assertLogs(log, logging.DEBUG):
1747
return bus.call_method(methodname, busname, objectpath,
1748
interface, *args)
1749
1750
def test_call_method_returns(self):
1751
expected_method_return = Unique()
1752
method_args = (Unique(), Unique())
1753
def func(*args):
1754
self.assertEqual(len(method_args), len(args))
1755
for marg, arg in zip(method_args, args):
1756
self.assertIs(marg, arg)
1757
return expected_method_return
1758
stub_pydbus = self.Stub_pydbus_func(func)
1759
bus = pydbus_adapter.SystemBus(stub_pydbus)
1760
ret = self.call_method(bus, "methodname", "busname",
1761
"objectpath", "interface",
1762
*method_args)
1763
self.assertIs(ret, expected_method_return)
1764
1765
def test_call_method_handles_exception(self):
1766
dbus_logger = logging.getLogger("dbus.proxies")
1767
1768
def func():
1769
raise gi.repository.GLib.Error()
1770
1771
stub_pydbus = self.Stub_pydbus_func(func)
1772
bus = pydbus_adapter.SystemBus(stub_pydbus)
1773
1774
with self.assertRaises(dbus.Error) as e:
1775
self.call_method(bus, "methodname", "busname",
1776
"objectpath", "interface")
1777
1778
self.assertNotIsInstance(e.exception, dbus.ConnectFailed)
1779
1780
def test_get_converts_to_correct_exception(self):
1781
bus = pydbus_adapter.SystemBus(
1782
self.fake_pydbus_raises_exception_on_connect)
1783
with self.assertRaises(dbus.ConnectFailed):
1784
self.call_method(bus, "methodname", "busname",
1785
"objectpath", "interface")
1786
1787
class fake_pydbus_raises_exception_on_connect:
1788
"""fake dbus-python module"""
1789
@classmethod
1790
def SystemBus(cls):
1791
def get(busname, objectpath):
1792
raise gi.repository.GLib.Error()
1793
Bus = collections.namedtuple("Bus", ["get"])
1794
return Bus(get=get)
1795
1796
def test_set_property_uses_setattr(self):
1797
class Object:
1798
pass
1799
obj = Object()
1800
class pydbus_spy:
1801
class SystemBus:
1802
@staticmethod
1803
def get(busname, objectpath):
1804
return {"interface": obj}
1805
bus = pydbus_adapter.SystemBus(pydbus_spy)
1806
value = Unique()
1807
bus.set_property("busname", "objectpath", "interface", "key",
1808
value)
1809
self.assertIs(value, obj.key)
1810
1811
def test_get_suppresses_xml_deprecation_warning(self):
1812
if sys.version_info.major >= 3:
1813
return
1814
class stub_pydbus_get:
1815
class SystemBus:
1816
@staticmethod
1817
def get(busname, objectpath):
1818
warnings.warn_explicit(
1819
"deprecated", DeprecationWarning,
1820
"xml.etree.ElementTree", 0)
1821
bus = pydbus_adapter.SystemBus(stub_pydbus_get)
1822
with warnings.catch_warnings(record=True) as w:
1823
warnings.simplefilter("always")
1824
bus.get("busname", "objectpath")
1825
self.assertEqual(0, len(w))
1826
1827
1828
class Test_pydbus_adapter_CachingBus(unittest.TestCase):
1829
class stub_pydbus:
1830
"""stub pydbus module"""
1831
class SystemBus:
1832
@staticmethod
1833
def get(busname, objectpath):
1834
return Unique()
1835
1836
def setUp(self):
1837
self.bus = pydbus_adapter.CachingBus(self.stub_pydbus)
1838
1839
def test_returns_distinct_objectpaths(self):
1840
obj1 = self.bus.get("busname", "objectpath1")
1841
self.assertIsInstance(obj1, Unique)
1842
obj2 = self.bus.get("busname", "objectpath2")
1843
self.assertIsInstance(obj2, Unique)
1844
self.assertIsNot(obj1, obj2)
1845
1846
def test_returns_distinct_busnames(self):
1847
obj1 = self.bus.get("busname1", "objectpath")
1848
self.assertIsInstance(obj1, Unique)
1849
obj2 = self.bus.get("busname2", "objectpath")
1850
self.assertIsInstance(obj2, Unique)
1851
self.assertIsNot(obj1, obj2)
1852
1853
def test_returns_distinct_both(self):
1854
obj1 = self.bus.get("busname1", "objectpath")
1855
self.assertIsInstance(obj1, Unique)
1856
obj2 = self.bus.get("busname2", "objectpath")
1857
self.assertIsInstance(obj2, Unique)
1858
self.assertIsNot(obj1, obj2)
1859
1860
def test_returns_same(self):
1861
obj1 = self.bus.get("busname", "objectpath")
1862
self.assertIsInstance(obj1, Unique)
1863
obj2 = self.bus.get("busname", "objectpath")
1864
self.assertIsInstance(obj2, Unique)
1865
self.assertIs(obj1, obj2)
1866
1867
def test_returns_same_old(self):
1868
obj1 = self.bus.get("busname1", "objectpath1")
1869
self.assertIsInstance(obj1, Unique)
1870
obj2 = self.bus.get("busname2", "objectpath2")
1871
self.assertIsInstance(obj2, Unique)
1872
obj1b = self.bus.get("busname1", "objectpath1")
1873
self.assertIsInstance(obj1b, Unique)
1874
self.assertIsNot(obj1, obj2)
1875
self.assertIsNot(obj2, obj1b)
1876
self.assertIs(obj1, obj1b)
1877
1878
1879
class Test_dbussy_adapter_SystemBus(TestCaseWithAssertLogs):
1880
1881
class dummy_dbussy:
1882
class DBUS:
1883
class ObjectPath(str):
1884
pass
1885
class DBusError(Exception):
1886
pass
1887
1888
def fake_ravel_func(self, func):
1889
class fake_ravel:
1890
@staticmethod
1891
def system_bus():
1892
class DBusInterfaceProxy:
1893
@staticmethod
1894
def methodname(*args):
1895
return [func(*args)]
1896
class DBusObject:
1897
@staticmethod
1898
def get_interface(interface):
1899
if interface == "interface":
1900
return DBusInterfaceProxy()
1901
return {"busname": {"objectpath": DBusObject()}}
1902
return fake_ravel
1903
1904
def call_method(self, bus, methodname, busname, objectpath,
1905
interface, *args):
1906
with self.assertLogs(log, logging.DEBUG):
1907
return bus.call_method(methodname, busname, objectpath,
1908
interface, *args)
1909
1910
def test_call_method_returns(self):
1911
expected_method_return = Unique()
1912
method_args = (Unique(), Unique())
1913
def func(*args):
1914
self.assertEqual(len(method_args), len(args))
1915
for marg, arg in zip(method_args, args):
1916
self.assertIs(marg, arg)
1917
return expected_method_return
1918
fake_ravel = self.fake_ravel_func(func)
1919
bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
1920
ret = self.call_method(bus, "methodname", "busname",
1921
"objectpath", "interface",
1922
*method_args)
1923
self.assertIs(ret, expected_method_return)
1924
1925
def test_call_method_filters_objectpath(self):
1926
def func():
1927
return method_return
1928
fake_ravel = self.fake_ravel_func(func)
1929
bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
1930
method_return = (self.dummy_dbussy.DBUS
1931
.ObjectPath("objectpath"))
1932
ret = self.call_method(bus, "methodname", "busname",
1933
"objectpath", "interface")
1934
self.assertEqual("objectpath", ret)
1935
self.assertNotIsInstance(ret,
1936
self.dummy_dbussy.DBUS.ObjectPath)
1937
1938
def test_call_method_filters_objectpaths_in_dict(self):
1939
ObjectPath = self.dummy_dbussy.DBUS.ObjectPath
1940
def func():
1941
return method_return
1942
fake_ravel = self.fake_ravel_func(func)
1943
bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
1944
method_return = {
1945
ObjectPath("objectpath_key_1"):
1946
ObjectPath("objectpath_value_1"),
1947
ObjectPath("objectpath_key_2"):
1948
ObjectPath("objectpath_value_2"),
1949
}
1950
ret = self.call_method(bus, "methodname", "busname",
1951
"objectpath", "interface")
1952
expected_method_return = {str(key): str(value)
1953
for key, value in
1954
method_return.items()}
1955
for key, value in ret.items():
1956
self.assertNotIsInstance(key, ObjectPath)
1957
self.assertNotIsInstance(value, ObjectPath)
1958
self.assertEqual(expected_method_return, ret)
1959
self.assertIsInstance(ret, dict)
1960
1961
def test_call_method_filters_objectpaths_in_dict_in_dict(self):
1962
ObjectPath = self.dummy_dbussy.DBUS.ObjectPath
1963
def func():
1964
return method_return
1965
fake_ravel = self.fake_ravel_func(func)
1966
bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
1967
method_return = {
1968
ObjectPath("key1"): {
1969
ObjectPath("key11"): ObjectPath("value11"),
1970
ObjectPath("key12"): ObjectPath("value12"),
1971
},
1972
ObjectPath("key2"): {
1973
ObjectPath("key21"): ObjectPath("value21"),
1974
ObjectPath("key22"): ObjectPath("value22"),
1975
},
1976
}
1977
ret = self.call_method(bus, "methodname", "busname",
1978
"objectpath", "interface")
1979
expected_method_return = {
1980
"key1": {"key11": "value11",
1981
"key12": "value12"},
1982
"key2": {"key21": "value21",
1983
"key22": "value22"},
1984
}
1985
self.assertEqual(expected_method_return, ret)
1986
for key, value in ret.items():
1987
self.assertIsInstance(value, dict)
1988
self.assertEqual(expected_method_return[key], value)
1989
self.assertNotIsInstance(key, ObjectPath)
1990
for inner_key, inner_value in value.items():
1991
self.assertIsInstance(value, dict)
1992
self.assertEqual(
1993
expected_method_return[key][inner_key],
1994
inner_value)
1995
self.assertNotIsInstance(key, ObjectPath)
1996
1997
def test_call_method_filters_objectpaths_in_dict_three_deep(self):
1998
ObjectPath = self.dummy_dbussy.DBUS.ObjectPath
1999
def func():
2000
return method_return
2001
fake_ravel = self.fake_ravel_func(func)
2002
bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
2003
method_return = {
2004
ObjectPath("key1"): {
2005
ObjectPath("key2"): {
2006
ObjectPath("key3"): ObjectPath("value"),
2007
},
2008
},
2009
}
2010
ret = self.call_method(bus, "methodname", "busname",
2011
"objectpath", "interface")
2012
expected_method_return = {"key1": {"key2": {"key3": "value"}}}
2013
self.assertEqual(expected_method_return, ret)
2014
self.assertIsInstance(ret, dict)
2015
self.assertNotIsInstance(next(iter(ret.keys())), ObjectPath)
2016
self.assertIsInstance(ret["key1"], dict)
2017
self.assertNotIsInstance(next(iter(ret["key1"].keys())),
2018
ObjectPath)
2019
self.assertIsInstance(ret["key1"]["key2"], dict)
2020
self.assertNotIsInstance(
2021
next(iter(ret["key1"]["key2"].keys())),
2022
ObjectPath)
2023
self.assertEqual("value", ret["key1"]["key2"]["key3"])
2024
self.assertNotIsInstance(ret["key1"]["key2"]["key3"],
2025
self.dummy_dbussy.DBUS.ObjectPath)
2026
2027
def test_call_method_handles_exception(self):
2028
def func():
2029
raise self.dummy_dbussy.DBusError()
2030
2031
fake_ravel = self.fake_ravel_func(func)
2032
bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
2033
2034
with self.assertRaises(dbus.Error) as e:
2035
self.call_method(bus, "methodname", "busname",
2036
"objectpath", "interface")
2037
2038
self.assertNotIsInstance(e.exception, dbus.ConnectFailed)
2039
2040
def test_get_object_converts_to_correct_exception(self):
2041
class fake_ravel_raises_exception_on_connect:
2042
@staticmethod
2043
def system_bus():
2044
class Bus:
2045
@staticmethod
2046
def __getitem__(key):
2047
if key == "objectpath":
2048
raise self.dummy_dbussy.DBusError()
2049
raise Exception(key)
2050
return {"busname": Bus()}
2051
def func():
2052
raise self.dummy_dbussy.DBusError()
2053
bus = dbussy_adapter.SystemBus(
2054
self.dummy_dbussy,
2055
fake_ravel_raises_exception_on_connect)
2056
with self.assertRaises(dbus.ConnectFailed):
2057
self.call_method(bus, "methodname", "busname",
2058
"objectpath", "interface")
2059
2060
1519
2061
class Test_commands_from_options(unittest.TestCase):
1520
2062
1521
2063
def setUp(self):
1526
2068
self.assert_command_from_args(["--is-enabled", "client"],
1527
2069
command.IsEnabled)
1528
2070
1529
def assert_command_from_args(self, args, command_cls,
1530
**cmd_attrs):
2071
def assert_command_from_args(self, args, command_cls, length=1,
2072
clients=None, **cmd_attrs):
1531
2073
"""Assert that parsing ARGS should result in an instance of
1532
2074
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
1533
2075
options = self.parser.parse_args(args)
1534
2076
check_option_syntax(self.parser, options)
1535
2077
commands = commands_from_options(options)
1536
self.assertEqual(1, len(commands))
1537
command = commands[0]
1538
self.assertIsInstance(command, command_cls)
2078
self.assertEqual(length, len(commands))
2079
for command in commands:
2080
if isinstance(command, command_cls):
2081
break
2082
else:
2083
self.assertIsInstance(command, command_cls)
2084
if clients is not None:
2085
self.assertEqual(clients, options.client)
1539
2086
for key, value in cmd_attrs.items():
1540
2087
self.assertEqual(value, getattr(command, key))
1541
2088
2089
def assert_commands_from_args(self, args, commands, clients=None):
2090
for cmd in commands:
2091
self.assert_command_from_args(args, cmd,
2092
length=len(commands),
2093
clients=clients)
2094
1542
2095
def test_is_enabled_short(self):
1543
2096
self.assert_command_from_args(["-V", "client"],
1544
2097
command.IsEnabled)
1735
2288
verbose=True)
1736
2289
1737
2290
2291
def test_manual_page_example_1(self):
2292
self.assert_command_from_args("",
2293
command.PrintTable,
2294
clients=[],
2295
verbose=False)
2296
2297
def test_manual_page_example_2(self):
2298
self.assert_command_from_args(
2299
"--verbose foo1.example.org foo2.example.org".split(),
2300
command.PrintTable, clients=["foo1.example.org",
2301
"foo2.example.org"],
2302
verbose=True)
2303
2304
def test_manual_page_example_3(self):
2305
self.assert_command_from_args("--enable --all".split(),
2306
command.Enable,
2307
clients=[])
2308
2309
def test_manual_page_example_4(self):
2310
self.assert_commands_from_args(
2311
("--timeout=PT5M --interval=PT1M foo1.example.org"
2312
" foo2.example.org").split(),
2313
[command.SetTimeout, command.SetInterval],
2314
clients=["foo1.example.org", "foo2.example.org"])
2315
2316
def test_manual_page_example_5(self):
2317
self.assert_command_from_args("--approve --all".split(),
2318
command.Approve,
2319
clients=[])
2320
2321
1738
2322
class TestCommand(unittest.TestCase):
1739
2323
"""Abstract class for tests of command classes"""
1740
2324
2070
2654
def runTest(self):
2071
2655
if not hasattr(self, "command"):
2072
2656
return # Abstract TestCase class
2073
values_to_get = getattr(self, "values_to_get",
2074
self.values_to_set)
2075
for value_to_set, value_to_get in zip(self.values_to_set,
2076
values_to_get):
2077
for clientpath in self.bus.clients:
2078
self.bus.clients[clientpath][self.propname] = Unique()
2079
self.run_command(value_to_set, self.bus.clients)
2080
for clientpath in self.bus.clients:
2081
value = self.bus.clients[clientpath][self.propname]
2657
2658
if hasattr(self, "values_to_set"):
2659
cmd_args = [(value,) for value in self.values_to_set]
2660
values_to_get = getattr(self, "values_to_get",
2661
self.values_to_set)
2662
else:
2663
cmd_args = [() for x in range(len(self.values_to_get))]
2664
values_to_get = self.values_to_get
2665
for value_to_get, cmd_arg in zip(values_to_get, cmd_args):
2666
for clientpath in self.bus.clients:
2667
self.bus.clients[clientpath][self.propname] = (
2668
Unique())
2669
self.command(*cmd_arg).run(self.bus.clients, self.bus)
2670
for clientpath in self.bus.clients:
2671
value = (self.bus.clients[clientpath]
2672
[self.propname])
2082
2673
self.assertNotIsInstance(value, Unique)
2083
2674
self.assertEqual(value_to_get, value)
2084
2675
2085
def run_command(self, value, clients):
2086
self.command().run(clients, self.bus)
2087
2088
2676
2089
2677
class TestEnableCmd(TestPropertySetterCmd):
2090
2678
command = command.Enable
2091
2679
propname = "Enabled"
2092
values_to_set = [True]
2680
values_to_get = [True]
2093
2681
2094
2682
2095
2683
class TestDisableCmd(TestPropertySetterCmd):
2096
2684
command = command.Disable
2097
2685
propname = "Enabled"
2098
values_to_set = [False]
2686
values_to_get = [False]
2099
2687
2100
2688
2101
2689
class TestBumpTimeoutCmd(TestPropertySetterCmd):
2102
2690
command = command.BumpTimeout
2103
2691
propname = "LastCheckedOK"
2104
values_to_set = [""]
2692
values_to_get = [""]
2105
2693
2106
2694
2107
2695
class TestStartCheckerCmd(TestPropertySetterCmd):
2108
2696
command = command.StartChecker
2109
2697
propname = "CheckerRunning"
2110
values_to_set = [True]
2698
values_to_get = [True]
2111
2699
2112
2700
2113
2701
class TestStopCheckerCmd(TestPropertySetterCmd):
2114
2702
command = command.StopChecker
2115
2703
propname = "CheckerRunning"
2116
values_to_set = [False]
2704
values_to_get = [False]
2117
2705
2118
2706
2119
2707
class TestApproveByDefaultCmd(TestPropertySetterCmd):
2120
2708
command = command.ApproveByDefault
2121
2709
propname = "ApprovedByDefault"
2122
values_to_set = [True]
2710
values_to_get = [True]
2123
2711
2124
2712
2125
2713
class TestDenyByDefaultCmd(TestPropertySetterCmd):
2126
2714
command = command.DenyByDefault
2127
2715
propname = "ApprovedByDefault"
2128
values_to_set = [False]
2129
2130
2131
class TestPropertySetterValueCmd(TestPropertySetterCmd):
2132
"""Abstract class for tests of PropertySetterValueCmd classes"""
2133
2134
def run_command(self, value, clients):
2135
self.command(value).run(clients, self.bus)
2136
2137
2138
class TestSetCheckerCmd(TestPropertySetterValueCmd):
2716
values_to_get = [False]
2717
2718
2719
class TestSetCheckerCmd(TestPropertySetterCmd):
2139
2720
command = command.SetChecker
2140
2721
propname = "Checker"
2141
2722
values_to_set = ["", ":", "fping -q -- %s"]
2142
2723
2143
2724
2144
class TestSetHostCmd(TestPropertySetterValueCmd):
2725
class TestSetHostCmd(TestPropertySetterCmd):
2145
2726
command = command.SetHost
2146
2727
propname = "Host"
2147
2728
values_to_set = ["192.0.2.3", "client.example.org"]
2148
2729
2149
2730
2150
class TestSetSecretCmd(TestPropertySetterValueCmd):
2731
class TestSetSecretCmd(TestPropertySetterCmd):
2151
2732
command = command.SetSecret
2152
2733
propname = "Secret"
2153
2734
values_to_set = [io.BytesIO(b""),
2155
2736
values_to_get = [f.getvalue() for f in values_to_set]
2156
2737
2157
2738
2158
class TestSetTimeoutCmd(TestPropertySetterValueCmd):
2739
class TestSetTimeoutCmd(TestPropertySetterCmd):
2159
2740
command = command.SetTimeout
2160
2741
propname = "Timeout"
2161
2742
values_to_set = [datetime.timedelta(),
2166
2747
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2167
2748
2168
2749
2169
class TestSetExtendedTimeoutCmd(TestPropertySetterValueCmd):
2750
class TestSetExtendedTimeoutCmd(TestPropertySetterCmd):
2170
2751
command = command.SetExtendedTimeout
2171
2752
propname = "ExtendedTimeout"
2172
2753
values_to_set = [datetime.timedelta(),
2177
2758
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2178
2759
2179
2760
2180
class TestSetIntervalCmd(TestPropertySetterValueCmd):
2761
class TestSetIntervalCmd(TestPropertySetterCmd):
2181
2762
command = command.SetInterval
2182
2763
propname = "Interval"
2183
2764
values_to_set = [datetime.timedelta(),
2188
2769
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2189
2770
2190
2771
2191
class TestSetApprovalDelayCmd(TestPropertySetterValueCmd):
2772
class TestSetApprovalDelayCmd(TestPropertySetterCmd):
2192
2773
command = command.SetApprovalDelay
2193
2774
propname = "ApprovalDelay"
2194
2775
values_to_set = [datetime.timedelta(),
2199
2780
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2200
2781
2201
2782
2202
class TestSetApprovalDurationCmd(TestPropertySetterValueCmd):
2783
class TestSetApprovalDurationCmd(TestPropertySetterCmd):
2203
2784
command = command.SetApprovalDuration
2204
2785
propname = "ApprovalDuration"
2205
2786
values_to_set = [datetime.timedelta(),
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0