To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/release
« back to all changes in this revision
Viewing changes to mandos-ctl
- browse files at revision 237.7.645
- compare with another revision
- download diff
- download tarball
- view history from revision 237.7.645
- Committer: Teddy Hogeborn
- Date: 2019-04-08 21:53:22 UTC
- mto: This revision was merged to the branch mainline in revision 382.
- Revision ID: teddy@recompile.se-20190408215322-y3hmfxzdgs9t84l1
plugin-runner: Fix minor memory leak
* plugin-runner.c (free_plugin): Even if argv[0] is NULL, as for the
pseudo-plugin for global options,
free all other arguments by simply
starting at argv[1] and freeing
plugin_node->name (which is always
argv[0]) separately.
* plugin-runner.c (free_plugin): Even if argv[0] is NULL, as for the
pseudo-plugin for global options,
free all other arguments by simply
starting at argv[1] and freeing
plugin_node->name (which is always
argv[0]) separately.
- files modified:
- TODO
added
removed
mandos-ctl
46
46
import tempfile
47
47
import contextlib
48
48
49
import dbus
49
try:
50
import pydbus
51
import gi
52
dbus_python = None
53
except ImportError:
54
import dbus as dbus_python
55
pydbus = None
56
class gi(object):
57
"""Dummy gi module, for the tests"""
58
class repository(object):
59
class GLib(object):
60
class Error(Exception):
61
pass
50
62
51
63
# Show warnings by default
52
64
if not sys.warnoptions:
61
73
62
74
if sys.version_info.major == 2:
63
75
str = unicode
76
import StringIO
77
io.StringIO = StringIO.StringIO
64
78
65
79
locale.setlocale(locale.LC_ALL, "")
66
80
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
81
version = "1.8.3"
74
82
75
83
76
try:
77
dbus.OBJECT_MANAGER_IFACE
78
except AttributeError:
79
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
80
81
82
84
def main():
83
85
parser = argparse.ArgumentParser()
84
85
86
add_command_line_options(parser)
86
87
87
88
options = parser.parse_args()
88
89
89
check_option_syntax(parser, options)
90
90
91
91
clientnames = options.client
93
93
if options.debug:
94
94
log.setLevel(logging.DEBUG)
95
95
96
try:
97
bus = dbus.SystemBus()
98
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
99
dbus_busname, server_dbus_path)
100
mandos_dbus_objc = bus.get_object(dbus_busname,
101
server_dbus_path)
102
except dbus.exceptions.DBusException:
103
log.critical("Could not connect to Mandos server")
104
sys.exit(1)
105
106
mandos_serv = dbus.Interface(mandos_dbus_objc,
107
dbus_interface=server_dbus_interface)
108
mandos_serv_object_manager = dbus.Interface(
109
mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
110
111
# Filter out log message from dbus module
112
dbus_logger = logging.getLogger("dbus.proxies")
113
class NullFilter(logging.Filter):
114
def filter(self, record):
115
return False
116
dbus_filter = NullFilter()
117
try:
118
dbus_logger.addFilter(dbus_filter)
119
log.debug("D-Bus: %s:%s:%s.GetManagedObjects()", dbus_busname,
120
server_dbus_path, dbus.OBJECT_MANAGER_IFACE)
121
mandos_clients = {path: ifs_and_props[client_dbus_interface]
122
for path, ifs_and_props in
123
mandos_serv_object_manager
124
.GetManagedObjects().items()
125
if client_dbus_interface in ifs_and_props}
126
except dbus.exceptions.DBusException as e:
127
log.critical("Failed to access Mandos server through D-Bus:"
128
"\n%s", e)
129
sys.exit(1)
130
finally:
131
# restore dbus logger
132
dbus_logger.removeFilter(dbus_filter)
133
134
# Compile dict of (clients: properties) to process
135
clients = {}
136
96
if pydbus is not None:
97
bus = pydbus_adapter.CachingBus(pydbus)
98
else:
99
bus = dbus_python_adapter.CachingBus(dbus_python)
100
101
try:
102
all_clients = bus.get_clients_and_properties()
103
except dbus.ConnectFailed as e:
104
log.critical("Could not connect to Mandos server: %s", e)
105
sys.exit(1)
106
except dbus.Error as e:
107
log.critical(
108
"Failed to access Mandos server through D-Bus:\n%s", e)
109
sys.exit(1)
110
111
# Compile dict of (clientpath: properties) to process
137
112
if not clientnames:
138
clients = {objpath: properties
139
for objpath, properties in mandos_clients.items()}
113
clients = all_clients
140
114
else:
115
clients = {}
141
116
for name in clientnames:
142
for objpath, properties in mandos_clients.items():
117
for objpath, properties in all_clients.items():
143
118
if properties["Name"] == name:
144
119
clients[objpath] = properties
145
120
break
147
122
log.critical("Client not found on server: %r", name)
148
123
sys.exit(1)
149
124
150
# Run all commands on clients
151
125
commands = commands_from_options(options)
126
152
127
for command in commands:
153
command.run(clients, bus, mandos_serv)
128
command.run(clients, bus)
154
129
155
130
156
131
def add_command_line_options(parser):
161
136
help="Select all clients")
162
137
parser.add_argument("-v", "--verbose", action="store_true",
163
138
help="Print all fields")
164
parser.add_argument("-j", "--dump-json", action="store_true",
139
parser.add_argument("-j", "--dump-json", dest="commands",
140
action="append_const", default=[],
141
const=command.DumpJSON(),
165
142
help="Dump client data in JSON format")
166
143
enable_disable = parser.add_mutually_exclusive_group()
167
enable_disable.add_argument("-e", "--enable", action="store_true",
144
enable_disable.add_argument("-e", "--enable", dest="commands",
145
action="append_const", default=[],
146
const=command.Enable(),
168
147
help="Enable client")
169
enable_disable.add_argument("-d", "--disable",
170
action="store_true",
148
enable_disable.add_argument("-d", "--disable", dest="commands",
149
action="append_const", default=[],
150
const=command.Disable(),
171
151
help="disable client")
172
parser.add_argument("-b", "--bump-timeout", action="store_true",
152
parser.add_argument("-b", "--bump-timeout", dest="commands",
153
action="append_const", default=[],
154
const=command.BumpTimeout(),
173
155
help="Bump timeout for client")
174
156
start_stop_checker = parser.add_mutually_exclusive_group()
175
157
start_stop_checker.add_argument("--start-checker",
176
action="store_true",
158
dest="commands",
159
action="append_const", default=[],
160
const=command.StartChecker(),
177
161
help="Start checker for client")
178
start_stop_checker.add_argument("--stop-checker",
179
action="store_true",
162
start_stop_checker.add_argument("--stop-checker", dest="commands",
163
action="append_const", default=[],
164
const=command.StopChecker(),
180
165
help="Stop checker for client")
181
parser.add_argument("-V", "--is-enabled", action="store_true",
166
parser.add_argument("-V", "--is-enabled", dest="commands",
167
action="append_const", default=[],
168
const=command.IsEnabled(),
182
169
help="Check if client is enabled")
183
parser.add_argument("-r", "--remove", action="store_true",
170
parser.add_argument("-r", "--remove", dest="commands",
171
action="append_const", default=[],
172
const=command.Remove(),
184
173
help="Remove client")
185
parser.add_argument("-c", "--checker",
174
parser.add_argument("-c", "--checker", dest="commands",
175
action="append", default=[],
176
metavar="COMMAND", type=command.SetChecker,
186
177
help="Set checker command for client")
187
parser.add_argument("-t", "--timeout", type=string_to_delta,
188
help="Set timeout for client")
189
parser.add_argument("--extended-timeout", type=string_to_delta,
190
help="Set extended timeout for client")
191
parser.add_argument("-i", "--interval", type=string_to_delta,
192
help="Set checker interval for client")
178
parser.add_argument(
179
"-t", "--timeout", dest="commands", action="append",
180
default=[], metavar="TIME",
181
type=command.SetTimeout.argparse(string_to_delta),
182
help="Set timeout for client")
183
parser.add_argument(
184
"--extended-timeout", dest="commands", action="append",
185
default=[], metavar="TIME",
186
type=command.SetExtendedTimeout.argparse(string_to_delta),
187
help="Set extended timeout for client")
188
parser.add_argument(
189
"-i", "--interval", dest="commands", action="append",
190
default=[], metavar="TIME",
191
type=command.SetInterval.argparse(string_to_delta),
192
help="Set checker interval for client")
193
193
approve_deny_default = parser.add_mutually_exclusive_group()
194
194
approve_deny_default.add_argument(
195
"--approve-by-default", action="store_true",
196
default=None, dest="approved_by_default",
195
"--approve-by-default", dest="commands",
196
action="append_const", default=[],
197
const=command.ApproveByDefault(),
197
198
help="Set client to be approved by default")
198
199
approve_deny_default.add_argument(
199
"--deny-by-default", action="store_false",
200
dest="approved_by_default",
200
"--deny-by-default", dest="commands",
201
action="append_const", default=[],
202
const=command.DenyByDefault(),
201
203
help="Set client to be denied by default")
202
parser.add_argument("--approval-delay", type=string_to_delta,
203
help="Set delay before client approve/deny")
204
parser.add_argument("--approval-duration", type=string_to_delta,
205
help="Set duration of one client approval")
206
parser.add_argument("-H", "--host", help="Set host for client")
207
parser.add_argument("-s", "--secret",
208
type=argparse.FileType(mode="rb"),
209
help="Set password blob (file) for client")
204
parser.add_argument(
205
"--approval-delay", dest="commands", action="append",
206
default=[], metavar="TIME",
207
type=command.SetApprovalDelay.argparse(string_to_delta),
208
help="Set delay before client approve/deny")
209
parser.add_argument(
210
"--approval-duration", dest="commands", action="append",
211
default=[], metavar="TIME",
212
type=command.SetApprovalDuration.argparse(string_to_delta),
213
help="Set duration of one client approval")
214
parser.add_argument("-H", "--host", dest="commands",
215
action="append", default=[], metavar="STRING",
216
type=command.SetHost,
217
help="Set host for client")
218
parser.add_argument(
219
"-s", "--secret", dest="commands", action="append",
220
default=[], metavar="FILENAME",
221
type=command.SetSecret.argparse(argparse.FileType(mode="rb")),
222
help="Set password blob (file) for client")
210
223
approve_deny = parser.add_mutually_exclusive_group()
211
224
approve_deny.add_argument(
212
"-A", "--approve", action="store_true",
225
"-A", "--approve", dest="commands", action="append_const",
226
default=[], const=command.Approve(),
213
227
help="Approve any current client request")
214
approve_deny.add_argument("-D", "--deny", action="store_true",
228
approve_deny.add_argument("-D", "--deny", dest="commands",
229
action="append_const", default=[],
230
const=command.Deny(),
215
231
help="Deny any current client request")
216
232
parser.add_argument("--debug", action="store_true",
217
233
help="Debug mode (show D-Bus commands)")
254
270
>>> rfc3339_duration_to_delta("")
255
271
Traceback (most recent call last):
256
272
...
257
ValueError: Invalid RFC 3339 duration: u''
273
ValueError: Invalid RFC 3339 duration: ""
258
274
>>> # Must start with "P":
259
275
>>> rfc3339_duration_to_delta("1D")
260
276
Traceback (most recent call last):
261
277
...
262
ValueError: Invalid RFC 3339 duration: u'1D'
278
ValueError: Invalid RFC 3339 duration: "1D"
263
279
>>> # Must use correct order
264
280
>>> rfc3339_duration_to_delta("PT1S2M")
265
281
Traceback (most recent call last):
266
282
...
267
ValueError: Invalid RFC 3339 duration: u'PT1S2M'
283
ValueError: Invalid RFC 3339 duration: "PT1S2M"
268
284
>>> # Time needs time marker
269
285
>>> rfc3339_duration_to_delta("P1H2S")
270
286
Traceback (most recent call last):
271
287
...
272
ValueError: Invalid RFC 3339 duration: u'P1H2S'
288
ValueError: Invalid RFC 3339 duration: "P1H2S"
273
289
>>> # Weeks can not be combined with anything else
274
290
>>> rfc3339_duration_to_delta("P1D2W")
275
291
Traceback (most recent call last):
276
292
...
277
ValueError: Invalid RFC 3339 duration: u'P1D2W'
293
ValueError: Invalid RFC 3339 duration: "P1D2W"
278
294
>>> rfc3339_duration_to_delta("P2W2H")
279
295
Traceback (most recent call last):
280
296
...
281
ValueError: Invalid RFC 3339 duration: u'P2W2H'
297
ValueError: Invalid RFC 3339 duration: "P2W2H"
282
298
"""
283
299
284
300
# Parsing an RFC 3339 duration with regular expressions is not
355
371
break
356
372
else:
357
373
# No currently valid tokens were found
358
raise ValueError("Invalid RFC 3339 duration: {!r}"
374
raise ValueError("Invalid RFC 3339 duration: \"{}\""
359
375
.format(duration))
360
376
# End token found
361
377
return value
408
424
"""Apply additional restrictions on options, not expressible in
409
425
argparse"""
410
426
411
def has_actions(options):
412
return any((options.enable,
413
options.disable,
414
options.bump_timeout,
415
options.start_checker,
416
options.stop_checker,
417
options.is_enabled,
418
options.remove,
419
options.checker is not None,
420
options.timeout is not None,
421
options.extended_timeout is not None,
422
options.interval is not None,
423
options.approved_by_default is not None,
424
options.approval_delay is not None,
425
options.approval_duration is not None,
426
options.host is not None,
427
options.secret is not None,
428
options.approve,
429
options.deny))
427
def has_commands(options, commands=None):
428
if commands is None:
429
commands = (command.Enable,
430
command.Disable,
431
command.BumpTimeout,
432
command.StartChecker,
433
command.StopChecker,
434
command.IsEnabled,
435
command.Remove,
436
command.SetChecker,
437
command.SetTimeout,
438
command.SetExtendedTimeout,
439
command.SetInterval,
440
command.ApproveByDefault,
441
command.DenyByDefault,
442
command.SetApprovalDelay,
443
command.SetApprovalDuration,
444
command.SetHost,
445
command.SetSecret,
446
command.Approve,
447
command.Deny)
448
return any(isinstance(cmd, commands)
449
for cmd in options.commands)
430
450
431
if has_actions(options) and not (options.client or options.all):
451
if has_commands(options) and not (options.client or options.all):
432
452
parser.error("Options require clients names or --all.")
433
if options.verbose and has_actions(options):
453
if options.verbose and has_commands(options):
434
454
parser.error("--verbose can only be used alone.")
435
if options.dump_json and (options.verbose
436
or has_actions(options)):
455
if (has_commands(options, (command.DumpJSON,))
456
and (options.verbose or len(options.commands) > 1)):
437
457
parser.error("--dump-json can only be used alone.")
438
if options.all and not has_actions(options):
458
if options.all and not has_commands(options):
439
459
parser.error("--all requires an action.")
440
if options.is_enabled and len(options.client) > 1:
460
if (has_commands(options, (command.IsEnabled,))
461
and len(options.client) > 1):
441
462
parser.error("--is-enabled requires exactly one client")
442
if options.remove:
443
options.remove = False
444
if has_actions(options) and not options.deny:
445
parser.error("--remove can only be combined with --deny")
446
options.remove = True
463
if (len(options.commands) > 1
464
and has_commands(options, (command.Remove,))
465
and not has_commands(options, (command.Deny,))):
466
parser.error("--remove can only be combined with --deny")
467
468
469
class dbus(object):
470
471
class SystemBus(object):
472
473
object_manager_iface = "org.freedesktop.DBus.ObjectManager"
474
def get_managed_objects(self, busname, objectpath):
475
return self.call_method("GetManagedObjects", busname,
476
objectpath,
477
self.object_manager_iface)
478
479
properties_iface = "org.freedesktop.DBus.Properties"
480
def set_property(self, busname, objectpath, interface, key,
481
value):
482
self.call_method("Set", busname, objectpath,
483
self.properties_iface, interface, key,
484
value)
485
486
487
class MandosBus(SystemBus):
488
busname_domain = "se.recompile"
489
busname = busname_domain + ".Mandos"
490
server_path = "/"
491
server_interface = busname_domain + ".Mandos"
492
client_interface = busname_domain + ".Mandos.Client"
493
del busname_domain
494
495
def get_clients_and_properties(self):
496
managed_objects = self.get_managed_objects(
497
self.busname, self.server_path)
498
return {objpath: properties[self.client_interface]
499
for objpath, properties in managed_objects.items()
500
if self.client_interface in properties}
501
502
def set_client_property(self, objectpath, key, value):
503
return self.set_property(self.busname, objectpath,
504
self.client_interface, key,
505
value)
506
507
def call_client_method(self, objectpath, method, *args):
508
return self.call_method(method, self.busname, objectpath,
509
self.client_interface, *args)
510
511
def call_server_method(self, method, *args):
512
return self.call_method(method, self.busname,
513
self.server_path,
514
self.server_interface, *args)
515
516
class Error(Exception):
517
pass
518
519
class ConnectFailed(Error):
520
pass
521
522
523
class dbus_python_adapter(object):
524
525
class SystemBus(dbus.MandosBus):
526
"""Use dbus-python"""
527
528
def __init__(self, module=dbus_python):
529
self.dbus_python = module
530
self.bus = self.dbus_python.SystemBus()
531
532
@contextlib.contextmanager
533
def convert_exception(self, exception_class=dbus.Error):
534
try:
535
yield
536
except self.dbus_python.exceptions.DBusException as e:
537
# This does what "raise from" would do
538
exc = exception_class(*e.args)
539
exc.__cause__ = e
540
raise exc
541
542
def call_method(self, methodname, busname, objectpath,
543
interface, *args):
544
proxy_object = self.get_object(busname, objectpath)
545
log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
546
interface, methodname,
547
", ".join(repr(a) for a in args))
548
method = getattr(proxy_object, methodname)
549
with self.convert_exception():
550
with dbus_python_adapter.SilenceLogger(
551
"dbus.proxies"):
552
value = method(*args, dbus_interface=interface)
553
return self.type_filter(value)
554
555
def get_object(self, busname, objectpath):
556
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
557
busname, objectpath)
558
with self.convert_exception(dbus.ConnectFailed):
559
return self.bus.get_object(busname, objectpath)
560
561
def type_filter(self, value):
562
"""Convert the most bothersome types to Python types"""
563
if isinstance(value, self.dbus_python.Boolean):
564
return bool(value)
565
if isinstance(value, self.dbus_python.ObjectPath):
566
return str(value)
567
# Also recurse into dictionaries
568
if isinstance(value, self.dbus_python.Dictionary):
569
return {self.type_filter(key):
570
self.type_filter(subval)
571
for key, subval in value.items()}
572
return value
573
574
575
class SilenceLogger(object):
576
"Simple context manager to silence a particular logger"
577
def __init__(self, loggername):
578
self.logger = logging.getLogger(loggername)
579
580
def __enter__(self):
581
self.logger.addFilter(self.nullfilter)
582
583
class NullFilter(logging.Filter):
584
def filter(self, record):
585
return False
586
587
nullfilter = NullFilter()
588
589
def __exit__(self, exc_type, exc_val, exc_tb):
590
self.logger.removeFilter(self.nullfilter)
591
592
593
class CachingBus(SystemBus):
594
"""A caching layer for dbus_python_adapter.SystemBus"""
595
def __init__(self, *args, **kwargs):
596
self.object_cache = {}
597
super(dbus_python_adapter.CachingBus,
598
self).__init__(*args, **kwargs)
599
def get_object(self, busname, objectpath):
600
try:
601
return self.object_cache[(busname, objectpath)]
602
except KeyError:
603
new_object = super(
604
dbus_python_adapter.CachingBus,
605
self).get_object(busname, objectpath)
606
self.object_cache[(busname, objectpath)] = new_object
607
return new_object
608
609
610
class pydbus_adapter(object):
611
class SystemBus(dbus.MandosBus):
612
def __init__(self, module=pydbus):
613
self.pydbus = module
614
self.bus = self.pydbus.SystemBus()
615
616
@contextlib.contextmanager
617
def convert_exception(self, exception_class=dbus.Error):
618
try:
619
yield
620
except gi.repository.GLib.Error as e:
621
# This does what "raise from" would do
622
exc = exception_class(*e.args)
623
exc.__cause__ = e
624
raise exc
625
626
def call_method(self, methodname, busname, objectpath,
627
interface, *args):
628
proxy_object = self.get(busname, objectpath)
629
log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
630
interface, methodname,
631
", ".join(repr(a) for a in args))
632
method = getattr(proxy_object[interface], methodname)
633
with self.convert_exception():
634
return method(*args)
635
636
def get(self, busname, objectpath):
637
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
638
busname, objectpath)
639
with self.convert_exception(dbus.ConnectFailed):
640
if sys.version_info.major <= 2:
641
with warnings.catch_warnings():
642
warnings.filterwarnings(
643
"ignore", "", DeprecationWarning,
644
r"^xml\.etree\.ElementTree$")
645
return self.bus.get(busname, objectpath)
646
else:
647
return self.bus.get(busname, objectpath)
648
649
def set_property(self, busname, objectpath, interface, key,
650
value):
651
proxy_object = self.get(busname, objectpath)
652
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", busname,
653
objectpath, self.properties_iface, interface,
654
key, value)
655
setattr(proxy_object[interface], key, value)
656
657
class CachingBus(SystemBus):
658
"""A caching layer for pydbus_adapter.SystemBus"""
659
def __init__(self, *args, **kwargs):
660
self.object_cache = {}
661
super(pydbus_adapter.CachingBus,
662
self).__init__(*args, **kwargs)
663
def get(self, busname, objectpath):
664
try:
665
return self.object_cache[(busname, objectpath)]
666
except KeyError:
667
new_object = (super(pydbus_adapter.CachingBus, self)
668
.get(busname, objectpath))
669
self.object_cache[(busname, objectpath)] = new_object
670
return new_object
447
671
448
672
449
673
def commands_from_options(options):
450
674
451
commands = []
452
453
if options.is_enabled:
454
commands.append(IsEnabledCmd())
455
456
if options.approve:
457
commands.append(ApproveCmd())
458
459
if options.deny:
460
commands.append(DenyCmd())
461
462
if options.remove:
463
commands.append(RemoveCmd())
464
465
if options.dump_json:
466
commands.append(DumpJSONCmd())
467
468
if options.enable:
469
commands.append(EnableCmd())
470
471
if options.disable:
472
commands.append(DisableCmd())
473
474
if options.bump_timeout:
475
commands.append(BumpTimeoutCmd())
476
477
if options.start_checker:
478
commands.append(StartCheckerCmd())
479
480
if options.stop_checker:
481
commands.append(StopCheckerCmd())
482
483
if options.approved_by_default is not None:
484
if options.approved_by_default:
485
commands.append(ApproveByDefaultCmd())
675
commands = list(options.commands)
676
677
def find_cmd(cmd, commands):
678
i = 0
679
for i, c in enumerate(commands):
680
if isinstance(c, cmd):
681
return i
682
return i+1
683
684
# If command.Remove is present, move any instances of command.Deny
685
# to occur ahead of command.Remove.
686
index_of_remove = find_cmd(command.Remove, commands)
687
before_remove = commands[:index_of_remove]
688
after_remove = commands[index_of_remove:]
689
cleaned_after = []
690
for cmd in after_remove:
691
if isinstance(cmd, command.Deny):
692
before_remove.append(cmd)
486
693
else:
487
commands.append(DenyByDefaultCmd())
488
489
if options.checker is not None:
490
commands.append(SetCheckerCmd(options.checker))
491
492
if options.host is not None:
493
commands.append(SetHostCmd(options.host))
494
495
if options.secret is not None:
496
commands.append(SetSecretCmd(options.secret))
497
498
if options.timeout is not None:
499
commands.append(SetTimeoutCmd(options.timeout))
500
501
if options.extended_timeout:
502
commands.append(
503
SetExtendedTimeoutCmd(options.extended_timeout))
504
505
if options.interval is not None:
506
commands.append(SetIntervalCmd(options.interval))
507
508
if options.approval_delay is not None:
509
commands.append(SetApprovalDelayCmd(options.approval_delay))
510
511
if options.approval_duration is not None:
512
commands.append(
513
SetApprovalDurationCmd(options.approval_duration))
694
cleaned_after.append(cmd)
695
if cleaned_after != after_remove:
696
commands = before_remove + cleaned_after
514
697
515
698
# If no command option has been given, show table of clients,
516
699
# optionally verbosely
517
700
if not commands:
518
commands.append(PrintTableCmd(verbose=options.verbose))
701
commands.append(command.PrintTable(verbose=options.verbose))
519
702
520
703
return commands
521
704
522
705
523
class Command(object):
524
"""Abstract class for commands"""
525
def run(self, clients, bus=None, mandos=None):
526
"""Normal commands should implement run_on_one_client(), but
527
commands which want to operate on all clients at the same time
528
can override this run() method instead."""
529
self.mandos = mandos
530
for clientpath, properties in clients.items():
531
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
532
dbus_busname, str(clientpath))
533
client = bus.get_object(dbus_busname, clientpath)
534
self.run_on_one_client(client, properties)
535
536
537
class IsEnabledCmd(Command):
538
def run(self, clients, bus=None, mandos=None):
539
client, properties = next(iter(clients.items()))
540
if self.is_enabled(client, properties):
541
sys.exit(0)
542
sys.exit(1)
543
def is_enabled(self, client, properties):
544
return properties["Enabled"]
545
546
547
class ApproveCmd(Command):
548
def run_on_one_client(self, client, properties):
549
log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
550
client.__dbus_object_path__, client_dbus_interface)
551
client.Approve(dbus.Boolean(True),
552
dbus_interface=client_dbus_interface)
553
554
555
class DenyCmd(Command):
556
def run_on_one_client(self, client, properties):
557
log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
558
client.__dbus_object_path__, client_dbus_interface)
559
client.Approve(dbus.Boolean(False),
560
dbus_interface=client_dbus_interface)
561
562
563
class RemoveCmd(Command):
564
def run_on_one_client(self, client, properties):
565
log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)", dbus_busname,
566
server_dbus_path, server_dbus_interface,
567
str(client.__dbus_object_path__))
568
self.mandos.RemoveClient(client.__dbus_object_path__)
569
570
571
class OutputCmd(Command):
572
"""Abstract class for commands outputting client details"""
573
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
574
"Created", "Interval", "Host", "KeyID",
575
"Fingerprint", "CheckerRunning", "LastEnabled",
576
"ApprovalPending", "ApprovedByDefault",
577
"LastApprovalRequest", "ApprovalDelay",
578
"ApprovalDuration", "Checker", "ExtendedTimeout",
579
"Expires", "LastCheckerStatus")
580
581
def run(self, clients, bus=None, mandos=None):
582
print(self.output(clients.values()))
583
584
def output(self, clients):
585
raise NotImplementedError()
586
587
588
class DumpJSONCmd(OutputCmd):
589
def output(self, clients):
590
data = {client["Name"]:
591
{key: self.dbus_boolean_to_bool(client[key])
592
for key in self.all_keywords}
593
for client in clients.values()}
594
return json.dumps(data, indent=4, separators=(',', ': '))
595
596
@staticmethod
597
def dbus_boolean_to_bool(value):
598
if isinstance(value, dbus.Boolean):
599
value = bool(value)
600
return value
601
602
603
class PrintTableCmd(OutputCmd):
604
def __init__(self, verbose=False):
605
self.verbose = verbose
606
607
def output(self, clients):
608
default_keywords = ("Name", "Enabled", "Timeout",
609
"LastCheckedOK")
610
keywords = default_keywords
611
if self.verbose:
612
keywords = self.all_keywords
613
return str(self.TableOfClients(clients, keywords))
614
615
class TableOfClients(object):
616
tableheaders = {
617
"Name": "Name",
618
"Enabled": "Enabled",
619
"Timeout": "Timeout",
620
"LastCheckedOK": "Last Successful Check",
621
"LastApprovalRequest": "Last Approval Request",
622
"Created": "Created",
623
"Interval": "Interval",
624
"Host": "Host",
625
"Fingerprint": "Fingerprint",
626
"KeyID": "Key ID",
627
"CheckerRunning": "Check Is Running",
628
"LastEnabled": "Last Enabled",
629
"ApprovalPending": "Approval Is Pending",
630
"ApprovedByDefault": "Approved By Default",
631
"ApprovalDelay": "Approval Delay",
632
"ApprovalDuration": "Approval Duration",
633
"Checker": "Checker",
634
"ExtendedTimeout": "Extended Timeout",
635
"Expires": "Expires",
636
"LastCheckerStatus": "Last Checker Status",
637
}
638
639
def __init__(self, clients, keywords, tableheaders=None):
640
self.clients = clients
641
self.keywords = keywords
642
if tableheaders is not None:
643
self.tableheaders = tableheaders
644
645
def __str__(self):
646
return "\n".join(self.rows())
647
648
if sys.version_info.major == 2:
649
__unicode__ = __str__
706
class command(object):
707
"""A namespace for command classes"""
708
709
class Base(object):
710
"""Abstract base class for commands"""
711
def run(self, clients, bus=None):
712
"""Normal commands should implement run_on_one_client(),
713
but commands which want to operate on all clients at the same time can
714
override this run() method instead.
715
"""
716
self.bus = bus
717
for client, properties in clients.items():
718
self.run_on_one_client(client, properties)
719
720
721
class IsEnabled(Base):
722
def run(self, clients, bus=None):
723
properties = next(iter(clients.values()))
724
if properties["Enabled"]:
725
sys.exit(0)
726
sys.exit(1)
727
728
729
class Approve(Base):
730
def run_on_one_client(self, client, properties):
731
self.bus.call_client_method(client, "Approve", True)
732
733
734
class Deny(Base):
735
def run_on_one_client(self, client, properties):
736
self.bus.call_client_method(client, "Approve", False)
737
738
739
class Remove(Base):
740
def run(self, clients, bus):
741
for clientpath in frozenset(clients.keys()):
742
bus.call_server_method("RemoveClient", clientpath)
743
744
745
class Output(Base):
746
"""Abstract class for commands outputting client details"""
747
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
748
"Created", "Interval", "Host", "KeyID",
749
"Fingerprint", "CheckerRunning",
750
"LastEnabled", "ApprovalPending",
751
"ApprovedByDefault", "LastApprovalRequest",
752
"ApprovalDelay", "ApprovalDuration",
753
"Checker", "ExtendedTimeout", "Expires",
754
"LastCheckerStatus")
755
756
757
class DumpJSON(Output):
758
def run(self, clients, bus=None):
759
data = {properties["Name"]:
760
{key: properties[key]
761
for key in self.all_keywords}
762
for properties in clients.values()}
763
print(json.dumps(data, indent=4, separators=(',', ': ')))
764
765
766
class PrintTable(Output):
767
def __init__(self, verbose=False):
768
self.verbose = verbose
769
770
def run(self, clients, bus=None):
771
default_keywords = ("Name", "Enabled", "Timeout",
772
"LastCheckedOK")
773
keywords = default_keywords
774
if self.verbose:
775
keywords = self.all_keywords
776
print(self.TableOfClients(clients.values(), keywords))
777
778
class TableOfClients(object):
779
tableheaders = {
780
"Name": "Name",
781
"Enabled": "Enabled",
782
"Timeout": "Timeout",
783
"LastCheckedOK": "Last Successful Check",
784
"LastApprovalRequest": "Last Approval Request",
785
"Created": "Created",
786
"Interval": "Interval",
787
"Host": "Host",
788
"Fingerprint": "Fingerprint",
789
"KeyID": "Key ID",
790
"CheckerRunning": "Check Is Running",
791
"LastEnabled": "Last Enabled",
792
"ApprovalPending": "Approval Is Pending",
793
"ApprovedByDefault": "Approved By Default",
794
"ApprovalDelay": "Approval Delay",
795
"ApprovalDuration": "Approval Duration",
796
"Checker": "Checker",
797
"ExtendedTimeout": "Extended Timeout",
798
"Expires": "Expires",
799
"LastCheckerStatus": "Last Checker Status",
800
}
801
802
def __init__(self, clients, keywords):
803
self.clients = clients
804
self.keywords = keywords
805
650
806
def __str__(self):
651
return str(self).encode(locale.getpreferredencoding())
652
653
def rows(self):
654
format_string = self.row_formatting_string()
655
rows = [self.header_line(format_string)]
656
rows.extend(self.client_line(client, format_string)
657
for client in self.clients)
658
return rows
659
660
def row_formatting_string(self):
661
"Format string used to format table rows"
662
return " ".join("{{{key}:{width}}}".format(
663
width=max(len(self.tableheaders[key]),
664
*(len(self.string_from_client(client, key))
665
for client in self.clients)),
666
key=key)
667
for key in self.keywords)
668
669
def string_from_client(self, client, key):
670
return self.valuetostring(client[key], key)
807
return "\n".join(self.rows())
808
809
if sys.version_info.major == 2:
810
__unicode__ = __str__
811
def __str__(self):
812
return str(self).encode(
813
locale.getpreferredencoding())
814
815
def rows(self):
816
format_string = self.row_formatting_string()
817
rows = [self.header_line(format_string)]
818
rows.extend(self.client_line(client, format_string)
819
for client in self.clients)
820
return rows
821
822
def row_formatting_string(self):
823
"Format string used to format table rows"
824
return " ".join("{{{key}:{width}}}".format(
825
width=max(len(self.tableheaders[key]),
826
*(len(self.string_from_client(client,
827
key))
828
for client in self.clients)),
829
key=key)
830
for key in self.keywords)
831
832
def string_from_client(self, client, key):
833
return self.valuetostring(client[key], key)
834
835
@classmethod
836
def valuetostring(cls, value, keyword):
837
if isinstance(value, bool):
838
return "Yes" if value else "No"
839
if keyword in ("Timeout", "Interval", "ApprovalDelay",
840
"ApprovalDuration", "ExtendedTimeout"):
841
return cls.milliseconds_to_string(value)
842
return str(value)
843
844
def header_line(self, format_string):
845
return format_string.format(**self.tableheaders)
846
847
def client_line(self, client, format_string):
848
return format_string.format(
849
**{key: self.string_from_client(client, key)
850
for key in self.keywords})
851
852
@staticmethod
853
def milliseconds_to_string(ms):
854
td = datetime.timedelta(0, 0, 0, ms)
855
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
856
.format(days="{}T".format(td.days)
857
if td.days else "",
858
hours=td.seconds // 3600,
859
minutes=(td.seconds % 3600) // 60,
860
seconds=td.seconds % 60))
861
862
863
class PropertySetter(Base):
864
"Abstract class for Actions for setting one client property"
865
866
def run_on_one_client(self, client, properties=None):
867
"""Set the Client's D-Bus property"""
868
self.bus.set_client_property(client, self.propname,
869
self.value_to_set)
870
871
@property
872
def propname(self):
873
raise NotImplementedError()
874
875
876
class Enable(PropertySetter):
877
propname = "Enabled"
878
value_to_set = True
879
880
881
class Disable(PropertySetter):
882
propname = "Enabled"
883
value_to_set = False
884
885
886
class BumpTimeout(PropertySetter):
887
propname = "LastCheckedOK"
888
value_to_set = ""
889
890
891
class StartChecker(PropertySetter):
892
propname = "CheckerRunning"
893
value_to_set = True
894
895
896
class StopChecker(PropertySetter):
897
propname = "CheckerRunning"
898
value_to_set = False
899
900
901
class ApproveByDefault(PropertySetter):
902
propname = "ApprovedByDefault"
903
value_to_set = True
904
905
906
class DenyByDefault(PropertySetter):
907
propname = "ApprovedByDefault"
908
value_to_set = False
909
910
911
class PropertySetterValue(PropertySetter):
912
"""Abstract class for PropertySetter recieving a value as
913
constructor argument instead of a class attribute."""
914
def __init__(self, value):
915
self.value_to_set = value
671
916
672
917
@classmethod
673
def valuetostring(cls, value, keyword):
674
if isinstance(value, dbus.Boolean):
675
return "Yes" if value else "No"
676
if keyword in ("Timeout", "Interval", "ApprovalDelay",
677
"ApprovalDuration", "ExtendedTimeout"):
678
return cls.milliseconds_to_string(value)
679
return str(value)
680
681
def header_line(self, format_string):
682
return format_string.format(**self.tableheaders)
683
684
def client_line(self, client, format_string):
685
return format_string.format(
686
**{key: self.string_from_client(client, key)
687
for key in self.keywords})
688
689
@staticmethod
690
def milliseconds_to_string(ms):
691
td = datetime.timedelta(0, 0, 0, ms)
692
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
693
.format(days="{}T".format(td.days)
694
if td.days else "",
695
hours=td.seconds // 3600,
696
minutes=(td.seconds % 3600) // 60,
697
seconds=td.seconds % 60))
698
699
700
class PropertyCmd(Command):
701
"""Abstract class for Actions for setting one client property"""
702
703
def run_on_one_client(self, client, properties):
704
"""Set the Client's D-Bus property"""
705
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
706
client.__dbus_object_path__,
707
dbus.PROPERTIES_IFACE, client_dbus_interface,
708
self.propname, self.value_to_set
709
if not isinstance(self.value_to_set, dbus.Boolean)
710
else bool(self.value_to_set))
711
client.Set(client_dbus_interface, self.propname,
712
self.value_to_set,
713
dbus_interface=dbus.PROPERTIES_IFACE)
714
715
@property
716
def propname(self):
717
raise NotImplementedError()
718
719
720
class EnableCmd(PropertyCmd):
721
propname = "Enabled"
722
value_to_set = dbus.Boolean(True)
723
724
725
class DisableCmd(PropertyCmd):
726
propname = "Enabled"
727
value_to_set = dbus.Boolean(False)
728
729
730
class BumpTimeoutCmd(PropertyCmd):
731
propname = "LastCheckedOK"
732
value_to_set = ""
733
734
735
class StartCheckerCmd(PropertyCmd):
736
propname = "CheckerRunning"
737
value_to_set = dbus.Boolean(True)
738
739
740
class StopCheckerCmd(PropertyCmd):
741
propname = "CheckerRunning"
742
value_to_set = dbus.Boolean(False)
743
744
745
class ApproveByDefaultCmd(PropertyCmd):
746
propname = "ApprovedByDefault"
747
value_to_set = dbus.Boolean(True)
748
749
750
class DenyByDefaultCmd(PropertyCmd):
751
propname = "ApprovedByDefault"
752
value_to_set = dbus.Boolean(False)
753
754
755
class PropertyValueCmd(PropertyCmd):
756
"""Abstract class for PropertyCmd recieving a value as argument"""
757
def __init__(self, value):
758
self.value_to_set = value
759
760
761
class SetCheckerCmd(PropertyValueCmd):
762
propname = "Checker"
763
764
765
class SetHostCmd(PropertyValueCmd):
766
propname = "Host"
767
768
769
class SetSecretCmd(PropertyValueCmd):
770
propname = "Secret"
771
772
@property
773
def value_to_set(self):
774
return self._vts
775
776
@value_to_set.setter
777
def value_to_set(self, value):
778
"""When setting, read data from supplied file object"""
779
self._vts = value.read()
780
value.close()
781
782
783
class MillisecondsPropertyValueArgumentCmd(PropertyValueCmd):
784
"""Abstract class for PropertyValueCmd taking a value argument as
785
a datetime.timedelta() but should store it as milliseconds."""
786
787
@property
788
def value_to_set(self):
789
return self._vts
790
791
@value_to_set.setter
792
def value_to_set(self, value):
793
"""When setting, convert value from a datetime.timedelta"""
794
self._vts = int(round(value.total_seconds() * 1000))
795
796
797
class SetTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
798
propname = "Timeout"
799
800
801
class SetExtendedTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
802
propname = "ExtendedTimeout"
803
804
805
class SetIntervalCmd(MillisecondsPropertyValueArgumentCmd):
806
propname = "Interval"
807
808
809
class SetApprovalDelayCmd(MillisecondsPropertyValueArgumentCmd):
810
propname = "ApprovalDelay"
811
812
813
class SetApprovalDurationCmd(MillisecondsPropertyValueArgumentCmd):
814
propname = "ApprovalDuration"
918
def argparse(cls, argtype):
919
def cmdtype(arg):
920
return cls(argtype(arg))
921
return cmdtype
922
923
class SetChecker(PropertySetterValue):
924
propname = "Checker"
925
926
927
class SetHost(PropertySetterValue):
928
propname = "Host"
929
930
931
class SetSecret(PropertySetterValue):
932
propname = "Secret"
933
934
@property
935
def value_to_set(self):
936
return self._vts
937
938
@value_to_set.setter
939
def value_to_set(self, value):
940
"""When setting, read data from supplied file object"""
941
self._vts = value.read()
942
value.close()
943
944
945
class PropertySetterValueMilliseconds(PropertySetterValue):
946
"""Abstract class for PropertySetterValue taking a value
947
argument as a datetime.timedelta() but should store it as
948
milliseconds."""
949
950
@property
951
def value_to_set(self):
952
return self._vts
953
954
@value_to_set.setter
955
def value_to_set(self, value):
956
"When setting, convert value from a datetime.timedelta"
957
self._vts = int(round(value.total_seconds() * 1000))
958
959
960
class SetTimeout(PropertySetterValueMilliseconds):
961
propname = "Timeout"
962
963
964
class SetExtendedTimeout(PropertySetterValueMilliseconds):
965
propname = "ExtendedTimeout"
966
967
968
class SetInterval(PropertySetterValueMilliseconds):
969
propname = "Interval"
970
971
972
class SetApprovalDelay(PropertySetterValueMilliseconds):
973
propname = "ApprovalDelay"
974
975
976
class SetApprovalDuration(PropertySetterValueMilliseconds):
977
propname = "ApprovalDuration"
815
978
816
979
817
980
818
class Test_string_to_delta(unittest.TestCase):
819
def test_handles_basic_rfc3339(self):
820
self.assertEqual(string_to_delta("PT0S"),
821
datetime.timedelta())
822
self.assertEqual(string_to_delta("P0D"),
823
datetime.timedelta())
824
self.assertEqual(string_to_delta("PT1S"),
825
datetime.timedelta(0, 1))
826
self.assertEqual(string_to_delta("PT2H"),
827
datetime.timedelta(0, 7200))
981
class TestCaseWithAssertLogs(unittest.TestCase):
982
"""unittest.TestCase.assertLogs only exists in Python 3.4"""
983
984
if not hasattr(unittest.TestCase, "assertLogs"):
985
@contextlib.contextmanager
986
def assertLogs(self, logger, level=logging.INFO):
987
capturing_handler = self.CapturingLevelHandler(level)
988
old_level = logger.level
989
old_propagate = logger.propagate
990
logger.addHandler(capturing_handler)
991
logger.setLevel(level)
992
logger.propagate = False
993
try:
994
yield capturing_handler.watcher
995
finally:
996
logger.propagate = old_propagate
997
logger.removeHandler(capturing_handler)
998
logger.setLevel(old_level)
999
self.assertGreater(len(capturing_handler.watcher.records),
1000
0)
1001
1002
class CapturingLevelHandler(logging.Handler):
1003
def __init__(self, level, *args, **kwargs):
1004
logging.Handler.__init__(self, *args, **kwargs)
1005
self.watcher = self.LoggingWatcher([], [])
1006
def emit(self, record):
1007
self.watcher.records.append(record)
1008
self.watcher.output.append(self.format(record))
1009
1010
LoggingWatcher = collections.namedtuple("LoggingWatcher",
1011
("records",
1012
"output"))
1013
1014
1015
class Unique(object):
1016
"""Class for objects which exist only to be unique objects, since
1017
unittest.mock.sentinel only exists in Python 3.3"""
1018
1019
1020
class Test_string_to_delta(TestCaseWithAssertLogs):
1021
# Just test basic RFC 3339 functionality here, the doc string for
1022
# rfc3339_duration_to_delta() already has more comprehensive
1023
# tests, which are run by doctest.
1024
1025
def test_rfc3339_zero_seconds(self):
1026
self.assertEqual(datetime.timedelta(),
1027
string_to_delta("PT0S"))
1028
1029
def test_rfc3339_zero_days(self):
1030
self.assertEqual(datetime.timedelta(), string_to_delta("P0D"))
1031
1032
def test_rfc3339_one_second(self):
1033
self.assertEqual(datetime.timedelta(0, 1),
1034
string_to_delta("PT1S"))
1035
1036
def test_rfc3339_two_hours(self):
1037
self.assertEqual(datetime.timedelta(0, 7200),
1038
string_to_delta("PT2H"))
828
1039
829
1040
def test_falls_back_to_pre_1_6_1_with_warning(self):
830
# assertLogs only exists in Python 3.4
831
if hasattr(self, "assertLogs"):
832
with self.assertLogs(log, logging.WARNING):
833
value = string_to_delta("2h")
834
else:
835
class WarningFilter(logging.Filter):
836
"""Don't show, but record the presence of, warnings"""
837
def filter(self, record):
838
is_warning = record.levelno >= logging.WARNING
839
self.found = is_warning or getattr(self, "found",
840
False)
841
return not is_warning
842
warning_filter = WarningFilter()
843
log.addFilter(warning_filter)
844
try:
845
value = string_to_delta("2h")
846
finally:
847
log.removeFilter(warning_filter)
848
self.assertTrue(getattr(warning_filter, "found", False))
849
self.assertEqual(value, datetime.timedelta(0, 7200))
1041
with self.assertLogs(log, logging.WARNING):
1042
value = string_to_delta("2h")
1043
self.assertEqual(datetime.timedelta(0, 7200), value)
850
1044
851
1045
852
1046
class Test_check_option_syntax(unittest.TestCase):
856
1050
857
1051
def test_actions_requires_client_or_all(self):
858
1052
for action, value in self.actions.items():
859
options = self.parser.parse_args()
860
setattr(options, action, value)
1053
args = self.actionargs(action, value)
861
1054
with self.assertParseError():
862
self.check_option_syntax(options)
1055
self.parse_args(args)
863
1056
864
# This mostly corresponds to the definition from has_actions() in
1057
# This mostly corresponds to the definition from has_commands() in
865
1058
# check_option_syntax()
866
1059
actions = {
867
# The actual values set here are not that important, but we do
868
# at least stick to the correct types, even though they are
869
# never used
870
"enable": True,
871
"disable": True,
872
"bump_timeout": True,
873
"start_checker": True,
874
"stop_checker": True,
875
"is_enabled": True,
876
"remove": True,
877
"checker": "x",
878
"timeout": datetime.timedelta(),
879
"extended_timeout": datetime.timedelta(),
880
"interval": datetime.timedelta(),
881
"approved_by_default": True,
882
"approval_delay": datetime.timedelta(),
883
"approval_duration": datetime.timedelta(),
884
"host": "x",
885
"secret": io.BytesIO(b"x"),
886
"approve": True,
887
"deny": True,
1060
"--enable": None,
1061
"--disable": None,
1062
"--bump-timeout": None,
1063
"--start-checker": None,
1064
"--stop-checker": None,
1065
"--is-enabled": None,
1066
"--remove": None,
1067
"--checker": "x",
1068
"--timeout": "PT0S",
1069
"--extended-timeout": "PT0S",
1070
"--interval": "PT0S",
1071
"--approve-by-default": None,
1072
"--deny-by-default": None,
1073
"--approval-delay": "PT0S",
1074
"--approval-duration": "PT0S",
1075
"--host": "hostname",
1076
"--secret": "/dev/null",
1077
"--approve": None,
1078
"--deny": None,
888
1079
}
889
1080
1081
@staticmethod
1082
def actionargs(action, value, *args):
1083
if value is not None:
1084
return [action, value] + list(args)
1085
else:
1086
return [action] + list(args)
1087
890
1088
@contextlib.contextmanager
891
1089
def assertParseError(self):
892
1090
with self.assertRaises(SystemExit) as e:
893
with self.temporarily_suppress_stderr():
1091
with self.redirect_stderr_to_devnull():
894
1092
yield
895
1093
# Exit code from argparse is guaranteed to be "2". Reference:
896
1094
# https://docs.python.org/3/library
897
1095
# /argparse.html#exiting-methods
898
self.assertEqual(e.exception.code, 2)
1096
self.assertEqual(2, e.exception.code)
1097
1098
def parse_args(self, args):
1099
options = self.parser.parse_args(args)
1100
check_option_syntax(self.parser, options)
899
1101
900
1102
@staticmethod
901
1103
@contextlib.contextmanager
902
def temporarily_suppress_stderr():
903
null = os.open(os.path.devnull, os.O_RDWR)
904
stderrcopy = os.dup(sys.stderr.fileno())
905
os.dup2(null, sys.stderr.fileno())
906
os.close(null)
907
try:
908
yield
909
finally:
910
# restore stderr
911
os.dup2(stderrcopy, sys.stderr.fileno())
912
os.close(stderrcopy)
1104
def redirect_stderr_to_devnull():
1105
old_stderr = sys.stderr
1106
with contextlib.closing(open(os.devnull, "w")) as null:
1107
sys.stderr = null
1108
try:
1109
yield
1110
finally:
1111
sys.stderr = old_stderr
913
1112
914
1113
def check_option_syntax(self, options):
915
1114
check_option_syntax(self.parser, options)
916
1115
917
def test_actions_conflicts_with_verbose(self):
918
for action, value in self.actions.items():
919
options = self.parser.parse_args()
920
setattr(options, action, value)
921
options.verbose = True
922
with self.assertParseError():
923
self.check_option_syntax(options)
1116
def test_actions_all_conflicts_with_verbose(self):
1117
for action, value in self.actions.items():
1118
args = self.actionargs(action, value, "--all",
1119
"--verbose")
1120
with self.assertParseError():
1121
self.parse_args(args)
1122
1123
def test_actions_with_client_conflicts_with_verbose(self):
1124
for action, value in self.actions.items():
1125
args = self.actionargs(action, value, "--verbose",
1126
"client")
1127
with self.assertParseError():
1128
self.parse_args(args)
924
1129
925
1130
def test_dump_json_conflicts_with_verbose(self):
926
options = self.parser.parse_args()
927
options.dump_json = True
928
options.verbose = True
1131
args = ["--dump-json", "--verbose"]
929
1132
with self.assertParseError():
930
self.check_option_syntax(options)
1133
self.parse_args(args)
931
1134
932
1135
def test_dump_json_conflicts_with_action(self):
933
1136
for action, value in self.actions.items():
934
options = self.parser.parse_args()
935
setattr(options, action, value)
936
options.dump_json = True
1137
args = self.actionargs(action, value, "--dump-json")
937
1138
with self.assertParseError():
938
self.check_option_syntax(options)
1139
self.parse_args(args)
939
1140
940
1141
def test_all_can_not_be_alone(self):
941
options = self.parser.parse_args()
942
options.all = True
1142
args = ["--all"]
943
1143
with self.assertParseError():
944
self.check_option_syntax(options)
1144
self.parse_args(args)
945
1145
946
1146
def test_all_is_ok_with_any_action(self):
947
1147
for action, value in self.actions.items():
948
options = self.parser.parse_args()
949
setattr(options, action, value)
950
options.all = True
951
self.check_option_syntax(options)
1148
args = self.actionargs(action, value, "--all")
1149
self.parse_args(args)
1150
1151
def test_any_action_is_ok_with_one_client(self):
1152
for action, value in self.actions.items():
1153
args = self.actionargs(action, value, "client")
1154
self.parse_args(args)
1155
1156
def test_one_client_with_all_actions_except_is_enabled(self):
1157
for action, value in self.actions.items():
1158
if action == "--is-enabled":
1159
continue
1160
args = self.actionargs(action, value, "client")
1161
self.parse_args(args)
1162
1163
def test_two_clients_with_all_actions_except_is_enabled(self):
1164
for action, value in self.actions.items():
1165
if action == "--is-enabled":
1166
continue
1167
args = self.actionargs(action, value, "client1",
1168
"client2")
1169
self.parse_args(args)
1170
1171
def test_two_clients_are_ok_with_actions_except_is_enabled(self):
1172
for action, value in self.actions.items():
1173
if action == "--is-enabled":
1174
continue
1175
args = self.actionargs(action, value, "client1",
1176
"client2")
1177
self.parse_args(args)
952
1178
953
1179
def test_is_enabled_fails_without_client(self):
954
options = self.parser.parse_args()
955
options.is_enabled = True
1180
args = ["--is-enabled"]
956
1181
with self.assertParseError():
957
self.check_option_syntax(options)
958
959
def test_is_enabled_works_with_one_client(self):
960
options = self.parser.parse_args()
961
options.is_enabled = True
962
options.client = ["foo"]
963
self.check_option_syntax(options)
1182
self.parse_args(args)
964
1183
965
1184
def test_is_enabled_fails_with_two_clients(self):
966
options = self.parser.parse_args()
967
options.is_enabled = True
968
options.client = ["foo", "barbar"]
1185
args = ["--is-enabled", "client1", "client2"]
969
1186
with self.assertParseError():
970
self.check_option_syntax(options)
1187
self.parse_args(args)
971
1188
972
1189
def test_remove_can_only_be_combined_with_action_deny(self):
973
1190
for action, value in self.actions.items():
974
if action in {"remove", "deny"}:
1191
if action in {"--remove", "--deny"}:
975
1192
continue
976
options = self.parser.parse_args()
977
setattr(options, action, value)
978
options.all = True
979
options.remove = True
1193
args = self.actionargs(action, value, "--all",
1194
"--remove")
980
1195
with self.assertParseError():
981
self.check_option_syntax(options)
1196
self.parse_args(args)
1197
1198
1199
class Test_dbus_exceptions(unittest.TestCase):
1200
1201
def test_dbus_ConnectFailed_is_Error(self):
1202
with self.assertRaises(dbus.Error):
1203
raise dbus.ConnectFailed()
1204
1205
1206
class Test_dbus_MandosBus(unittest.TestCase):
1207
1208
class MockMandosBus(dbus.MandosBus):
1209
def __init__(self):
1210
self._name = "se.recompile.Mandos"
1211
self._server_path = "/"
1212
self._server_interface = "se.recompile.Mandos"
1213
self._client_interface = "se.recompile.Mandos.Client"
1214
self.calls = []
1215
self.call_method_return = Unique()
1216
1217
def call_method(self, methodname, busname, objectpath,
1218
interface, *args):
1219
self.calls.append((methodname, busname, objectpath,
1220
interface, args))
1221
return self.call_method_return
1222
1223
def setUp(self):
1224
self.bus = self.MockMandosBus()
1225
1226
def test_set_client_property(self):
1227
self.bus.set_client_property("objectpath", "key", "value")
1228
expected_call = ("Set", self.bus._name, "objectpath",
1229
"org.freedesktop.DBus.Properties",
1230
(self.bus._client_interface, "key", "value"))
1231
self.assertIn(expected_call, self.bus.calls)
1232
1233
def test_call_client_method(self):
1234
ret = self.bus.call_client_method("objectpath", "methodname")
1235
self.assertIs(self.bus.call_method_return, ret)
1236
expected_call = ("methodname", self.bus._name, "objectpath",
1237
self.bus._client_interface, ())
1238
self.assertIn(expected_call, self.bus.calls)
1239
1240
def test_call_client_method_with_args(self):
1241
args = (Unique(), Unique())
1242
ret = self.bus.call_client_method("objectpath", "methodname",
1243
*args)
1244
self.assertIs(self.bus.call_method_return, ret)
1245
expected_call = ("methodname", self.bus._name, "objectpath",
1246
self.bus._client_interface,
1247
(args[0], args[1]))
1248
self.assertIn(expected_call, self.bus.calls)
1249
1250
def test_get_clients_and_properties(self):
1251
managed_objects = {
1252
"objectpath": {
1253
self.bus._client_interface: {
1254
"key": "value",
1255
"bool": True,
1256
},
1257
"irrelevant_interface": {
1258
"key": "othervalue",
1259
"bool": False,
1260
},
1261
},
1262
"other_objectpath": {
1263
"other_irrelevant_interface": {
1264
"key": "value 3",
1265
"bool": None,
1266
},
1267
},
1268
}
1269
expected_clients_and_properties = {
1270
"objectpath": {
1271
"key": "value",
1272
"bool": True,
1273
}
1274
}
1275
self.bus.call_method_return = managed_objects
1276
ret = self.bus.get_clients_and_properties()
1277
self.assertDictEqual(expected_clients_and_properties, ret)
1278
expected_call = ("GetManagedObjects", self.bus._name,
1279
self.bus._server_path,
1280
"org.freedesktop.DBus.ObjectManager", ())
1281
self.assertIn(expected_call, self.bus.calls)
1282
1283
def test_call_server_method(self):
1284
ret = self.bus.call_server_method("methodname")
1285
self.assertIs(self.bus.call_method_return, ret)
1286
expected_call = ("methodname", self.bus._name,
1287
self.bus._server_path,
1288
self.bus._server_interface, ())
1289
self.assertIn(expected_call, self.bus.calls)
1290
1291
def test_call_server_method_with_args(self):
1292
args = (Unique(), Unique())
1293
ret = self.bus.call_server_method("methodname", *args)
1294
self.assertIs(self.bus.call_method_return, ret)
1295
expected_call = ("methodname", self.bus._name,
1296
self.bus._server_path,
1297
self.bus._server_interface,
1298
(args[0], args[1]))
1299
self.assertIn(expected_call, self.bus.calls)
1300
1301
1302
class Test_dbus_python_adapter_SystemBus(TestCaseWithAssertLogs):
1303
1304
def MockDBusPython_func(self, func):
1305
class mock_dbus_python(object):
1306
"""mock dbus-python module"""
1307
class exceptions(object):
1308
"""Pseudo-namespace"""
1309
class DBusException(Exception):
1310
pass
1311
class SystemBus(object):
1312
@staticmethod
1313
def get_object(busname, objectpath):
1314
DBusObject = collections.namedtuple(
1315
"DBusObject", ("methodname",))
1316
def method(*args, **kwargs):
1317
self.assertEqual({"dbus_interface":
1318
"interface"},
1319
kwargs)
1320
return func(*args)
1321
return DBusObject(methodname=method)
1322
class Boolean(object):
1323
def __init__(self, value):
1324
self.value = bool(value)
1325
def __bool__(self):
1326
return self.value
1327
if sys.version_info.major == 2:
1328
__nonzero__ = __bool__
1329
class ObjectPath(str):
1330
pass
1331
class Dictionary(dict):
1332
pass
1333
return mock_dbus_python
1334
1335
def call_method(self, bus, methodname, busname, objectpath,
1336
interface, *args):
1337
with self.assertLogs(log, logging.DEBUG):
1338
return bus.call_method(methodname, busname, objectpath,
1339
interface, *args)
1340
1341
def test_call_method_returns(self):
1342
expected_method_return = Unique()
1343
method_args = (Unique(), Unique())
1344
def func(*args):
1345
self.assertEqual(len(method_args), len(args))
1346
for marg, arg in zip(method_args, args):
1347
self.assertIs(marg, arg)
1348
return expected_method_return
1349
mock_dbus_python = self.MockDBusPython_func(func)
1350
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1351
ret = self.call_method(bus, "methodname", "busname",
1352
"objectpath", "interface",
1353
*method_args)
1354
self.assertIs(ret, expected_method_return)
1355
1356
def test_call_method_filters_bool_true(self):
1357
def func():
1358
return method_return
1359
mock_dbus_python = self.MockDBusPython_func(func)
1360
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1361
method_return = mock_dbus_python.Boolean(True)
1362
ret = self.call_method(bus, "methodname", "busname",
1363
"objectpath", "interface")
1364
self.assertTrue(ret)
1365
self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1366
1367
def test_call_method_filters_bool_false(self):
1368
def func():
1369
return method_return
1370
mock_dbus_python = self.MockDBusPython_func(func)
1371
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1372
method_return = mock_dbus_python.Boolean(False)
1373
ret = self.call_method(bus, "methodname", "busname",
1374
"objectpath", "interface")
1375
self.assertFalse(ret)
1376
self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1377
1378
def test_call_method_filters_objectpath(self):
1379
def func():
1380
return method_return
1381
mock_dbus_python = self.MockDBusPython_func(func)
1382
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1383
method_return = mock_dbus_python.ObjectPath("objectpath")
1384
ret = self.call_method(bus, "methodname", "busname",
1385
"objectpath", "interface")
1386
self.assertEqual("objectpath", ret)
1387
self.assertIsNot("objectpath", ret)
1388
self.assertNotIsInstance(ret, mock_dbus_python.ObjectPath)
1389
1390
def test_call_method_filters_booleans_in_dict(self):
1391
def func():
1392
return method_return
1393
mock_dbus_python = self.MockDBusPython_func(func)
1394
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1395
method_return = mock_dbus_python.Dictionary(
1396
{mock_dbus_python.Boolean(True):
1397
mock_dbus_python.Boolean(False),
1398
mock_dbus_python.Boolean(False):
1399
mock_dbus_python.Boolean(True)})
1400
ret = self.call_method(bus, "methodname", "busname",
1401
"objectpath", "interface")
1402
expected_method_return = {True: False,
1403
False: True}
1404
self.assertEqual(expected_method_return, ret)
1405
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1406
1407
def test_call_method_filters_objectpaths_in_dict(self):
1408
def func():
1409
return method_return
1410
mock_dbus_python = self.MockDBusPython_func(func)
1411
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1412
method_return = mock_dbus_python.Dictionary(
1413
{mock_dbus_python.ObjectPath("objectpath_key_1"):
1414
mock_dbus_python.ObjectPath("objectpath_value_1"),
1415
mock_dbus_python.ObjectPath("objectpath_key_2"):
1416
mock_dbus_python.ObjectPath("objectpath_value_2")})
1417
ret = self.call_method(bus, "methodname", "busname",
1418
"objectpath", "interface")
1419
expected_method_return = {str(key): str(value)
1420
for key, value in
1421
method_return.items()}
1422
self.assertEqual(expected_method_return, ret)
1423
self.assertIsInstance(ret, dict)
1424
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1425
1426
def test_call_method_filters_dict_in_dict(self):
1427
def func():
1428
return method_return
1429
mock_dbus_python = self.MockDBusPython_func(func)
1430
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1431
method_return = mock_dbus_python.Dictionary(
1432
{"key1": mock_dbus_python.Dictionary({"key11": "value11",
1433
"key12": "value12"}),
1434
"key2": mock_dbus_python.Dictionary({"key21": "value21",
1435
"key22": "value22"})})
1436
ret = self.call_method(bus, "methodname", "busname",
1437
"objectpath", "interface")
1438
expected_method_return = {
1439
"key1": {"key11": "value11",
1440
"key12": "value12"},
1441
"key2": {"key21": "value21",
1442
"key22": "value22"},
1443
}
1444
self.assertEqual(expected_method_return, ret)
1445
self.assertIsInstance(ret, dict)
1446
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1447
for key, value in ret.items():
1448
self.assertIsInstance(value, dict)
1449
self.assertEqual(expected_method_return[key], value)
1450
self.assertNotIsInstance(value,
1451
mock_dbus_python.Dictionary)
1452
1453
def test_call_method_filters_dict_three_deep(self):
1454
def func():
1455
return method_return
1456
mock_dbus_python = self.MockDBusPython_func(func)
1457
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1458
method_return = mock_dbus_python.Dictionary(
1459
{"key1":
1460
mock_dbus_python.Dictionary(
1461
{"key2":
1462
mock_dbus_python.Dictionary(
1463
{"key3":
1464
mock_dbus_python.Boolean(True),
1465
}),
1466
}),
1467
})
1468
ret = self.call_method(bus, "methodname", "busname",
1469
"objectpath", "interface")
1470
expected_method_return = {"key1": {"key2": {"key3": True}}}
1471
self.assertEqual(expected_method_return, ret)
1472
self.assertIsInstance(ret, dict)
1473
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1474
self.assertIsInstance(ret["key1"], dict)
1475
self.assertNotIsInstance(ret["key1"],
1476
mock_dbus_python.Dictionary)
1477
self.assertIsInstance(ret["key1"]["key2"], dict)
1478
self.assertNotIsInstance(ret["key1"]["key2"],
1479
mock_dbus_python.Dictionary)
1480
self.assertTrue(ret["key1"]["key2"]["key3"])
1481
self.assertNotIsInstance(ret["key1"]["key2"]["key3"],
1482
mock_dbus_python.Boolean)
1483
1484
def test_call_method_handles_exception(self):
1485
dbus_logger = logging.getLogger("dbus.proxies")
1486
1487
def func():
1488
dbus_logger.error("Test")
1489
raise mock_dbus_python.exceptions.DBusException()
1490
1491
mock_dbus_python = self.MockDBusPython_func(func)
1492
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1493
1494
class CountingHandler(logging.Handler):
1495
count = 0
1496
def emit(self, record):
1497
self.count += 1
1498
1499
counting_handler = CountingHandler()
1500
1501
dbus_logger.addHandler(counting_handler)
1502
1503
try:
1504
with self.assertRaises(dbus.Error) as e:
1505
self.call_method(bus, "methodname", "busname",
1506
"objectpath", "interface")
1507
finally:
1508
dbus_logger.removeFilter(counting_handler)
1509
1510
self.assertNotIsInstance(e, dbus.ConnectFailed)
1511
1512
# Make sure the dbus logger was suppressed
1513
self.assertEqual(0, counting_handler.count)
1514
1515
def test_get_object_converts_to_correct_exception(self):
1516
bus = dbus_python_adapter.SystemBus(
1517
self.fake_dbus_python_raises_exception_on_connect)
1518
with self.assertRaises(dbus.ConnectFailed):
1519
self.call_method(bus, "methodname", "busname",
1520
"objectpath", "interface")
1521
1522
class fake_dbus_python_raises_exception_on_connect(object):
1523
"""fake dbus-python module"""
1524
class exceptions(object):
1525
"""Pseudo-namespace"""
1526
class DBusException(Exception):
1527
pass
1528
1529
@classmethod
1530
def SystemBus(cls):
1531
def get_object(busname, objectpath):
1532
raise cls.exceptions.DBusException()
1533
Bus = collections.namedtuple("Bus", ["get_object"])
1534
return Bus(get_object=get_object)
1535
1536
1537
class Test_dbus_python_adapter_CachingBus(unittest.TestCase):
1538
class mock_dbus_python(object):
1539
"""mock dbus-python modules"""
1540
class SystemBus(object):
1541
@staticmethod
1542
def get_object(busname, objectpath):
1543
return Unique()
1544
1545
def setUp(self):
1546
self.bus = dbus_python_adapter.CachingBus(
1547
self.mock_dbus_python)
1548
1549
def test_returns_distinct_objectpaths(self):
1550
obj1 = self.bus.get_object("busname", "objectpath1")
1551
self.assertIsInstance(obj1, Unique)
1552
obj2 = self.bus.get_object("busname", "objectpath2")
1553
self.assertIsInstance(obj2, Unique)
1554
self.assertIsNot(obj1, obj2)
1555
1556
def test_returns_distinct_busnames(self):
1557
obj1 = self.bus.get_object("busname1", "objectpath")
1558
self.assertIsInstance(obj1, Unique)
1559
obj2 = self.bus.get_object("busname2", "objectpath")
1560
self.assertIsInstance(obj2, Unique)
1561
self.assertIsNot(obj1, obj2)
1562
1563
def test_returns_distinct_both(self):
1564
obj1 = self.bus.get_object("busname1", "objectpath")
1565
self.assertIsInstance(obj1, Unique)
1566
obj2 = self.bus.get_object("busname2", "objectpath")
1567
self.assertIsInstance(obj2, Unique)
1568
self.assertIsNot(obj1, obj2)
1569
1570
def test_returns_same(self):
1571
obj1 = self.bus.get_object("busname", "objectpath")
1572
self.assertIsInstance(obj1, Unique)
1573
obj2 = self.bus.get_object("busname", "objectpath")
1574
self.assertIsInstance(obj2, Unique)
1575
self.assertIs(obj1, obj2)
1576
1577
def test_returns_same_old(self):
1578
obj1 = self.bus.get_object("busname1", "objectpath1")
1579
self.assertIsInstance(obj1, Unique)
1580
obj2 = self.bus.get_object("busname2", "objectpath2")
1581
self.assertIsInstance(obj2, Unique)
1582
obj1b = self.bus.get_object("busname1", "objectpath1")
1583
self.assertIsInstance(obj1b, Unique)
1584
self.assertIsNot(obj1, obj2)
1585
self.assertIsNot(obj2, obj1b)
1586
self.assertIs(obj1, obj1b)
1587
1588
1589
class Test_pydbus_adapter_SystemBus(TestCaseWithAssertLogs):
1590
1591
def Stub_pydbus_func(self, func):
1592
class stub_pydbus(object):
1593
"""stub pydbus module"""
1594
class SystemBus(object):
1595
@staticmethod
1596
def get(busname, objectpath):
1597
DBusObject = collections.namedtuple(
1598
"DBusObject", ("methodname",))
1599
return {"interface":
1600
DBusObject(methodname=func)}
1601
return stub_pydbus
1602
1603
def call_method(self, bus, methodname, busname, objectpath,
1604
interface, *args):
1605
with self.assertLogs(log, logging.DEBUG):
1606
return bus.call_method(methodname, busname, objectpath,
1607
interface, *args)
1608
1609
def test_call_method_returns(self):
1610
expected_method_return = Unique()
1611
method_args = (Unique(), Unique())
1612
def func(*args):
1613
self.assertEqual(len(method_args), len(args))
1614
for marg, arg in zip(method_args, args):
1615
self.assertIs(marg, arg)
1616
return expected_method_return
1617
stub_pydbus = self.Stub_pydbus_func(func)
1618
bus = pydbus_adapter.SystemBus(stub_pydbus)
1619
ret = self.call_method(bus, "methodname", "busname",
1620
"objectpath", "interface",
1621
*method_args)
1622
self.assertIs(ret, expected_method_return)
1623
1624
def test_call_method_handles_exception(self):
1625
dbus_logger = logging.getLogger("dbus.proxies")
1626
1627
def func():
1628
raise gi.repository.GLib.Error()
1629
1630
stub_pydbus = self.Stub_pydbus_func(func)
1631
bus = pydbus_adapter.SystemBus(stub_pydbus)
1632
1633
with self.assertRaises(dbus.Error) as e:
1634
self.call_method(bus, "methodname", "busname",
1635
"objectpath", "interface")
1636
1637
self.assertNotIsInstance(e, dbus.ConnectFailed)
1638
1639
def test_get_converts_to_correct_exception(self):
1640
bus = pydbus_adapter.SystemBus(
1641
self.fake_pydbus_raises_exception_on_connect)
1642
with self.assertRaises(dbus.ConnectFailed):
1643
self.call_method(bus, "methodname", "busname",
1644
"objectpath", "interface")
1645
1646
class fake_pydbus_raises_exception_on_connect(object):
1647
"""fake dbus-python module"""
1648
@classmethod
1649
def SystemBus(cls):
1650
def get(busname, objectpath):
1651
raise gi.repository.GLib.Error()
1652
Bus = collections.namedtuple("Bus", ["get"])
1653
return Bus(get=get)
1654
1655
def test_set_property_uses_setattr(self):
1656
class Object(object):
1657
pass
1658
obj = Object()
1659
class pydbus_spy(object):
1660
class SystemBus(object):
1661
@staticmethod
1662
def get(busname, objectpath):
1663
return {"interface": obj}
1664
bus = pydbus_adapter.SystemBus(pydbus_spy)
1665
value = Unique()
1666
bus.set_property("busname", "objectpath", "interface", "key",
1667
value)
1668
self.assertIs(value, obj.key)
1669
1670
def test_get_suppresses_xml_deprecation_warning(self):
1671
if sys.version_info.major >= 3:
1672
return
1673
class stub_pydbus_get(object):
1674
class SystemBus(object):
1675
@staticmethod
1676
def get(busname, objectpath):
1677
warnings.warn_explicit(
1678
"deprecated", DeprecationWarning,
1679
"xml.etree.ElementTree", 0)
1680
bus = pydbus_adapter.SystemBus(stub_pydbus_get)
1681
with warnings.catch_warnings(record=True) as w:
1682
warnings.simplefilter("always")
1683
bus.get("busname", "objectpath")
1684
self.assertEqual(0, len(w))
1685
1686
1687
class Test_pydbus_adapter_CachingBus(unittest.TestCase):
1688
class stub_pydbus(object):
1689
"""stub pydbus module"""
1690
class SystemBus(object):
1691
@staticmethod
1692
def get(busname, objectpath):
1693
return Unique()
1694
1695
def setUp(self):
1696
self.bus = pydbus_adapter.CachingBus(self.stub_pydbus)
1697
1698
def test_returns_distinct_objectpaths(self):
1699
obj1 = self.bus.get("busname", "objectpath1")
1700
self.assertIsInstance(obj1, Unique)
1701
obj2 = self.bus.get("busname", "objectpath2")
1702
self.assertIsInstance(obj2, Unique)
1703
self.assertIsNot(obj1, obj2)
1704
1705
def test_returns_distinct_busnames(self):
1706
obj1 = self.bus.get("busname1", "objectpath")
1707
self.assertIsInstance(obj1, Unique)
1708
obj2 = self.bus.get("busname2", "objectpath")
1709
self.assertIsInstance(obj2, Unique)
1710
self.assertIsNot(obj1, obj2)
1711
1712
def test_returns_distinct_both(self):
1713
obj1 = self.bus.get("busname1", "objectpath")
1714
self.assertIsInstance(obj1, Unique)
1715
obj2 = self.bus.get("busname2", "objectpath")
1716
self.assertIsInstance(obj2, Unique)
1717
self.assertIsNot(obj1, obj2)
1718
1719
def test_returns_same(self):
1720
obj1 = self.bus.get("busname", "objectpath")
1721
self.assertIsInstance(obj1, Unique)
1722
obj2 = self.bus.get("busname", "objectpath")
1723
self.assertIsInstance(obj2, Unique)
1724
self.assertIs(obj1, obj2)
1725
1726
def test_returns_same_old(self):
1727
obj1 = self.bus.get("busname1", "objectpath1")
1728
self.assertIsInstance(obj1, Unique)
1729
obj2 = self.bus.get("busname2", "objectpath2")
1730
self.assertIsInstance(obj2, Unique)
1731
obj1b = self.bus.get("busname1", "objectpath1")
1732
self.assertIsInstance(obj1b, Unique)
1733
self.assertIsNot(obj1, obj2)
1734
self.assertIsNot(obj2, obj1b)
1735
self.assertIs(obj1, obj1b)
982
1736
983
1737
984
1738
class Test_commands_from_options(unittest.TestCase):
1739
985
1740
def setUp(self):
986
1741
self.parser = argparse.ArgumentParser()
987
1742
add_command_line_options(self.parser)
988
1743
989
1744
def test_is_enabled(self):
990
self.assert_command_from_args(["--is-enabled", "foo"],
991
IsEnabledCmd)
1745
self.assert_command_from_args(["--is-enabled", "client"],
1746
command.IsEnabled)
992
1747
993
1748
def assert_command_from_args(self, args, command_cls,
994
1749
**cmd_attrs):
997
1752
options = self.parser.parse_args(args)
998
1753
check_option_syntax(self.parser, options)
999
1754
commands = commands_from_options(options)
1000
self.assertEqual(len(commands), 1)
1755
self.assertEqual(1, len(commands))
1001
1756
command = commands[0]
1002
1757
self.assertIsInstance(command, command_cls)
1003
1758
for key, value in cmd_attrs.items():
1004
self.assertEqual(getattr(command, key), value)
1759
self.assertEqual(value, getattr(command, key))
1005
1760
1006
1761
def test_is_enabled_short(self):
1007
self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
1762
self.assert_command_from_args(["-V", "client"],
1763
command.IsEnabled)
1008
1764
1009
1765
def test_approve(self):
1010
self.assert_command_from_args(["--approve", "foo"],
1011
ApproveCmd)
1766
self.assert_command_from_args(["--approve", "client"],
1767
command.Approve)
1012
1768
1013
1769
def test_approve_short(self):
1014
self.assert_command_from_args(["-A", "foo"], ApproveCmd)
1770
self.assert_command_from_args(["-A", "client"],
1771
command.Approve)
1015
1772
1016
1773
def test_deny(self):
1017
self.assert_command_from_args(["--deny", "foo"], DenyCmd)
1774
self.assert_command_from_args(["--deny", "client"],
1775
command.Deny)
1018
1776
1019
1777
def test_deny_short(self):
1020
self.assert_command_from_args(["-D", "foo"], DenyCmd)
1778
self.assert_command_from_args(["-D", "client"], command.Deny)
1021
1779
1022
1780
def test_remove(self):
1023
self.assert_command_from_args(["--remove", "foo"],
1024
RemoveCmd)
1781
self.assert_command_from_args(["--remove", "client"],
1782
command.Remove)
1025
1783
1026
1784
def test_deny_before_remove(self):
1027
1785
options = self.parser.parse_args(["--deny", "--remove",
1028
"foo"])
1786
"client"])
1029
1787
check_option_syntax(self.parser, options)
1030
1788
commands = commands_from_options(options)
1031
self.assertEqual(len(commands), 2)
1032
self.assertIsInstance(commands[0], DenyCmd)
1033
self.assertIsInstance(commands[1], RemoveCmd)
1789
self.assertEqual(2, len(commands))
1790
self.assertIsInstance(commands[0], command.Deny)
1791
self.assertIsInstance(commands[1], command.Remove)
1034
1792
1035
1793
def test_deny_before_remove_reversed(self):
1036
1794
options = self.parser.parse_args(["--remove", "--deny",
1037
1795
"--all"])
1038
1796
check_option_syntax(self.parser, options)
1039
1797
commands = commands_from_options(options)
1040
self.assertEqual(len(commands), 2)
1041
self.assertIsInstance(commands[0], DenyCmd)
1042
self.assertIsInstance(commands[1], RemoveCmd)
1798
self.assertEqual(2, len(commands))
1799
self.assertIsInstance(commands[0], command.Deny)
1800
self.assertIsInstance(commands[1], command.Remove)
1043
1801
1044
1802
def test_remove_short(self):
1045
self.assert_command_from_args(["-r", "foo"], RemoveCmd)
1803
self.assert_command_from_args(["-r", "client"],
1804
command.Remove)
1046
1805
1047
1806
def test_dump_json(self):
1048
self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
1807
self.assert_command_from_args(["--dump-json"],
1808
command.DumpJSON)
1049
1809
1050
1810
def test_enable(self):
1051
self.assert_command_from_args(["--enable", "foo"], EnableCmd)
1811
self.assert_command_from_args(["--enable", "client"],
1812
command.Enable)
1052
1813
1053
1814
def test_enable_short(self):
1054
self.assert_command_from_args(["-e", "foo"], EnableCmd)
1815
self.assert_command_from_args(["-e", "client"],
1816
command.Enable)
1055
1817
1056
1818
def test_disable(self):
1057
self.assert_command_from_args(["--disable", "foo"],
1058
DisableCmd)
1819
self.assert_command_from_args(["--disable", "client"],
1820
command.Disable)
1059
1821
1060
1822
def test_disable_short(self):
1061
self.assert_command_from_args(["-d", "foo"], DisableCmd)
1823
self.assert_command_from_args(["-d", "client"],
1824
command.Disable)
1062
1825
1063
1826
def test_bump_timeout(self):
1064
self.assert_command_from_args(["--bump-timeout", "foo"],
1065
BumpTimeoutCmd)
1827
self.assert_command_from_args(["--bump-timeout", "client"],
1828
command.BumpTimeout)
1066
1829
1067
1830
def test_bump_timeout_short(self):
1068
self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
1831
self.assert_command_from_args(["-b", "client"],
1832
command.BumpTimeout)
1069
1833
1070
1834
def test_start_checker(self):
1071
self.assert_command_from_args(["--start-checker", "foo"],
1072
StartCheckerCmd)
1835
self.assert_command_from_args(["--start-checker", "client"],
1836
command.StartChecker)
1073
1837
1074
1838
def test_stop_checker(self):
1075
self.assert_command_from_args(["--stop-checker", "foo"],
1076
StopCheckerCmd)
1839
self.assert_command_from_args(["--stop-checker", "client"],
1840
command.StopChecker)
1077
1841
1078
1842
def test_approve_by_default(self):
1079
self.assert_command_from_args(["--approve-by-default", "foo"],
1080
ApproveByDefaultCmd)
1843
self.assert_command_from_args(["--approve-by-default",
1844
"client"],
1845
command.ApproveByDefault)
1081
1846
1082
1847
def test_deny_by_default(self):
1083
self.assert_command_from_args(["--deny-by-default", "foo"],
1084
DenyByDefaultCmd)
1848
self.assert_command_from_args(["--deny-by-default", "client"],
1849
command.DenyByDefault)
1085
1850
1086
1851
def test_checker(self):
1087
self.assert_command_from_args(["--checker", ":", "foo"],
1088
SetCheckerCmd, value_to_set=":")
1852
self.assert_command_from_args(["--checker", ":", "client"],
1853
command.SetChecker,
1854
value_to_set=":")
1089
1855
1090
1856
def test_checker_empty(self):
1091
self.assert_command_from_args(["--checker", "", "foo"],
1092
SetCheckerCmd, value_to_set="")
1857
self.assert_command_from_args(["--checker", "", "client"],
1858
command.SetChecker,
1859
value_to_set="")
1093
1860
1094
1861
def test_checker_short(self):
1095
self.assert_command_from_args(["-c", ":", "foo"],
1096
SetCheckerCmd, value_to_set=":")
1862
self.assert_command_from_args(["-c", ":", "client"],
1863
command.SetChecker,
1864
value_to_set=":")
1097
1865
1098
1866
def test_host(self):
1099
self.assert_command_from_args(["--host", "foo.example.org",
1100
"foo"], SetHostCmd,
1101
value_to_set="foo.example.org")
1867
self.assert_command_from_args(
1868
["--host", "client.example.org", "client"],
1869
command.SetHost, value_to_set="client.example.org")
1102
1870
1103
1871
def test_host_short(self):
1104
self.assert_command_from_args(["-H", "foo.example.org",
1105
"foo"], SetHostCmd,
1106
value_to_set="foo.example.org")
1872
self.assert_command_from_args(
1873
["-H", "client.example.org", "client"], command.SetHost,
1874
value_to_set="client.example.org")
1107
1875
1108
1876
def test_secret_devnull(self):
1109
1877
self.assert_command_from_args(["--secret", os.path.devnull,
1110
"foo"], SetSecretCmd,
1878
"client"], command.SetSecret,
1111
1879
value_to_set=b"")
1112
1880
1113
1881
def test_secret_tempfile(self):
1116
1884
f.write(value)
1117
1885
f.seek(0)
1118
1886
self.assert_command_from_args(["--secret", f.name,
1119
"foo"], SetSecretCmd,
1887
"client"],
1888
command.SetSecret,
1120
1889
value_to_set=value)
1121
1890
1122
1891
def test_secret_devnull_short(self):
1123
self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1124
SetSecretCmd, value_to_set=b"")
1892
self.assert_command_from_args(["-s", os.path.devnull,
1893
"client"], command.SetSecret,
1894
value_to_set=b"")
1125
1895
1126
1896
def test_secret_tempfile_short(self):
1127
1897
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1128
1898
value = b"secret\0xyzzy\nbar"
1129
1899
f.write(value)
1130
1900
f.seek(0)
1131
self.assert_command_from_args(["-s", f.name, "foo"],
1132
SetSecretCmd,
1901
self.assert_command_from_args(["-s", f.name, "client"],
1902
command.SetSecret,
1133
1903
value_to_set=value)
1134
1904
1135
1905
def test_timeout(self):
1136
self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1137
SetTimeoutCmd,
1906
self.assert_command_from_args(["--timeout", "PT5M", "client"],
1907
command.SetTimeout,
1138
1908
value_to_set=300000)
1139
1909
1140
1910
def test_timeout_short(self):
1141
self.assert_command_from_args(["-t", "PT5M", "foo"],
1142
SetTimeoutCmd,
1911
self.assert_command_from_args(["-t", "PT5M", "client"],
1912
command.SetTimeout,
1143
1913
value_to_set=300000)
1144
1914
1145
1915
def test_extended_timeout(self):
1146
1916
self.assert_command_from_args(["--extended-timeout", "PT15M",
1147
"foo"],
1148
SetExtendedTimeoutCmd,
1917
"client"],
1918
command.SetExtendedTimeout,
1149
1919
value_to_set=900000)
1150
1920
1151
1921
def test_interval(self):
1152
self.assert_command_from_args(["--interval", "PT2M", "foo"],
1153
SetIntervalCmd,
1922
self.assert_command_from_args(["--interval", "PT2M",
1923
"client"], command.SetInterval,
1154
1924
value_to_set=120000)
1155
1925
1156
1926
def test_interval_short(self):
1157
self.assert_command_from_args(["-i", "PT2M", "foo"],
1158
SetIntervalCmd,
1927
self.assert_command_from_args(["-i", "PT2M", "client"],
1928
command.SetInterval,
1159
1929
value_to_set=120000)
1160
1930
1161
1931
def test_approval_delay(self):
1162
1932
self.assert_command_from_args(["--approval-delay", "PT30S",
1163
"foo"], SetApprovalDelayCmd,
1933
"client"],
1934
command.SetApprovalDelay,
1164
1935
value_to_set=30000)
1165
1936
1166
1937
def test_approval_duration(self):
1167
1938
self.assert_command_from_args(["--approval-duration", "PT1S",
1168
"foo"], SetApprovalDurationCmd,
1939
"client"],
1940
command.SetApprovalDuration,
1169
1941
value_to_set=1000)
1170
1942
1171
1943
def test_print_table(self):
1172
self.assert_command_from_args([], PrintTableCmd,
1944
self.assert_command_from_args([], command.PrintTable,
1173
1945
verbose=False)
1174
1946
1175
1947
def test_print_table_verbose(self):
1176
self.assert_command_from_args(["--verbose"], PrintTableCmd,
1948
self.assert_command_from_args(["--verbose"],
1949
command.PrintTable,
1177
1950
verbose=True)
1178
1951
1179
1952
def test_print_table_verbose_short(self):
1180
self.assert_command_from_args(["-v"], PrintTableCmd,
1953
self.assert_command_from_args(["-v"], command.PrintTable,
1181
1954
verbose=True)
1182
1955
1183
1956
1184
class TestCmd(unittest.TestCase):
1957
class TestCommand(unittest.TestCase):
1185
1958
"""Abstract class for tests of command classes"""
1186
1959
1187
def setUp(self):
1188
testcase = self
1189
class MockClient(object):
1190
def __init__(self, name, **attributes):
1191
self.__dbus_object_path__ = "/clients/{}".format(name)
1192
self.attributes = attributes
1193
self.attributes["Name"] = name
1194
self.calls = []
1195
def Set(self, interface, propname, value, dbus_interface):
1196
testcase.assertEqual(interface, client_dbus_interface)
1197
testcase.assertEqual(dbus_interface,
1198
dbus.PROPERTIES_IFACE)
1199
self.attributes[propname] = value
1200
def Get(self, interface, propname, dbus_interface):
1201
testcase.assertEqual(interface, client_dbus_interface)
1202
testcase.assertEqual(dbus_interface,
1203
dbus.PROPERTIES_IFACE)
1204
return self.attributes[propname]
1205
def Approve(self, approve, dbus_interface):
1206
testcase.assertEqual(dbus_interface,
1207
client_dbus_interface)
1208
self.calls.append(("Approve", (approve,
1209
dbus_interface)))
1210
self.client = MockClient(
1211
"foo",
1212
KeyID=("92ed150794387c03ce684574b1139a65"
1213
"94a34f895daaaf09fd8ea90a27cddb12"),
1214
Secret=b"secret",
1215
Host="foo.example.org",
1216
Enabled=dbus.Boolean(True),
1217
Timeout=300000,
1218
LastCheckedOK="2019-02-03T00:00:00",
1219
Created="2019-01-02T00:00:00",
1220
Interval=120000,
1221
Fingerprint=("778827225BA7DE539C5A"
1222
"7CFA59CFF7CDBD9A5920"),
1223
CheckerRunning=dbus.Boolean(False),
1224
LastEnabled="2019-01-03T00:00:00",
1225
ApprovalPending=dbus.Boolean(False),
1226
ApprovedByDefault=dbus.Boolean(True),
1227
LastApprovalRequest="",
1228
ApprovalDelay=0,
1229
ApprovalDuration=1000,
1230
Checker="fping -q -- %(host)s",
1231
ExtendedTimeout=900000,
1232
Expires="2019-02-04T00:00:00",
1233
LastCheckerStatus=0)
1234
self.other_client = MockClient(
1235
"barbar",
1236
KeyID=("0558568eedd67d622f5c83b35a115f79"
1237
"6ab612cff5ad227247e46c2b020f441c"),
1238
Secret=b"secretbar",
1239
Host="192.0.2.3",
1240
Enabled=dbus.Boolean(True),
1241
Timeout=300000,
1242
LastCheckedOK="2019-02-04T00:00:00",
1243
Created="2019-01-03T00:00:00",
1244
Interval=120000,
1245
Fingerprint=("3E393AEAEFB84C7E89E2"
1246
"F547B3A107558FCA3A27"),
1247
CheckerRunning=dbus.Boolean(True),
1248
LastEnabled="2019-01-04T00:00:00",
1249
ApprovalPending=dbus.Boolean(False),
1250
ApprovedByDefault=dbus.Boolean(False),
1251
LastApprovalRequest="2019-01-03T00:00:00",
1252
ApprovalDelay=30000,
1253
ApprovalDuration=93785000,
1254
Checker=":",
1255
ExtendedTimeout=900000,
1256
Expires="2019-02-05T00:00:00",
1257
LastCheckerStatus=-2)
1258
self.clients = collections.OrderedDict(
1259
[
1260
("/clients/foo", self.client.attributes),
1261
("/clients/barbar", self.other_client.attributes),
1262
])
1263
self.one_client = {"/clients/foo": self.client.attributes}
1264
1265
@property
1266
def bus(self):
1267
class Bus(object):
1268
@staticmethod
1269
def get_object(client_bus_name, path):
1270
self.assertEqual(client_bus_name, dbus_busname)
1271
return {
1272
"/clients/foo": self.client,
1273
"/clients/barbar": self.other_client,
1274
}[path]
1275
return Bus()
1276
1277
1278
class TestIsEnabledCmd(TestCmd):
1279
def test_is_enabled(self):
1280
self.assertTrue(all(IsEnabledCmd().is_enabled(client,
1281
properties)
1282
for client, properties
1283
in self.clients.items()))
1284
1285
def test_is_enabled_run_exits_successfully(self):
1286
with self.assertRaises(SystemExit) as e:
1287
IsEnabledCmd().run(self.one_client)
1288
if e.exception.code is not None:
1289
self.assertEqual(e.exception.code, 0)
1290
else:
1291
self.assertIsNone(e.exception.code)
1292
1293
def test_is_enabled_run_exits_with_failure(self):
1294
self.client.attributes["Enabled"] = dbus.Boolean(False)
1295
with self.assertRaises(SystemExit) as e:
1296
IsEnabledCmd().run(self.one_client)
1297
if isinstance(e.exception.code, int):
1298
self.assertNotEqual(e.exception.code, 0)
1299
else:
1300
self.assertIsNotNone(e.exception.code)
1301
1302
1303
class TestApproveCmd(TestCmd):
1304
def test_approve(self):
1305
ApproveCmd().run(self.clients, self.bus)
1306
for clientpath in self.clients:
1307
client = self.bus.get_object(dbus_busname, clientpath)
1308
self.assertIn(("Approve", (True, client_dbus_interface)),
1309
client.calls)
1310
1311
1312
class TestDenyCmd(TestCmd):
1313
def test_deny(self):
1314
DenyCmd().run(self.clients, self.bus)
1315
for clientpath in self.clients:
1316
client = self.bus.get_object(dbus_busname, clientpath)
1317
self.assertIn(("Approve", (False, client_dbus_interface)),
1318
client.calls)
1319
1320
1321
class TestRemoveCmd(TestCmd):
1322
def test_remove(self):
1323
class MockMandos(object):
1324
def __init__(self):
1325
self.calls = []
1326
def RemoveClient(self, dbus_path):
1327
self.calls.append(("RemoveClient", (dbus_path,)))
1328
mandos = MockMandos()
1329
super(TestRemoveCmd, self).setUp()
1330
RemoveCmd().run(self.clients, self.bus, mandos)
1331
self.assertEqual(len(mandos.calls), 2)
1332
for clientpath in self.clients:
1333
self.assertIn(("RemoveClient", (clientpath,)),
1334
mandos.calls)
1335
1336
1337
class TestDumpJSONCmd(TestCmd):
1338
def setUp(self):
1339
self.expected_json = {
1340
"foo": {
1960
class FakeMandosBus(dbus.MandosBus):
1961
def __init__(self, testcase):
1962
self.client_properties = {
1341
1963
"Name": "foo",
1342
1964
"KeyID": ("92ed150794387c03ce684574b1139a65"
1343
1965
"94a34f895daaaf09fd8ea90a27cddb12"),
1966
"Secret": b"secret",
1344
1967
"Host": "foo.example.org",
1345
1968
"Enabled": True,
1346
1969
"Timeout": 300000,
1360
1983
"ExtendedTimeout": 900000,
1361
1984
"Expires": "2019-02-04T00:00:00",
1362
1985
"LastCheckerStatus": 0,
1363
},
1364
"barbar": {
1986
}
1987
self.other_client_properties = {
1365
1988
"Name": "barbar",
1366
1989
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
1367
1990
"6ab612cff5ad227247e46c2b020f441c"),
1991
"Secret": b"secretbar",
1368
1992
"Host": "192.0.2.3",
1369
1993
"Enabled": True,
1370
1994
"Timeout": 300000,
1384
2008
"ExtendedTimeout": 900000,
1385
2009
"Expires": "2019-02-05T00:00:00",
1386
2010
"LastCheckerStatus": -2,
1387
},
1388
}
1389
return super(TestDumpJSONCmd, self).setUp()
1390
1391
def test_normal(self):
1392
json_data = json.loads(DumpJSONCmd().output(self.clients))
1393
self.assertDictEqual(json_data, self.expected_json)
1394
1395
def test_one_client(self):
1396
clients = self.one_client
1397
json_data = json.loads(DumpJSONCmd().output(clients))
2011
}
2012
self.clients = collections.OrderedDict(
2013
[
2014
("client_objectpath", self.client_properties),
2015
("other_client_objectpath",
2016
self.other_client_properties),
2017
])
2018
self.one_client = {"client_objectpath":
2019
self.client_properties}
2020
self.testcase = testcase
2021
self.calls = []
2022
2023
def call_method(self, methodname, busname, objectpath,
2024
interface, *args):
2025
self.testcase.assertEqual("se.recompile.Mandos", busname)
2026
self.calls.append((methodname, busname, objectpath,
2027
interface, args))
2028
if interface == "org.freedesktop.DBus.Properties":
2029
if methodname == "Set":
2030
self.testcase.assertEqual(3, len(args))
2031
interface, key, value = args
2032
self.testcase.assertEqual(
2033
"se.recompile.Mandos.Client", interface)
2034
self.clients[objectpath][key] = value
2035
return
2036
elif interface == "se.recompile.Mandos":
2037
self.testcase.assertEqual("RemoveClient", methodname)
2038
self.testcase.assertEqual(1, len(args))
2039
clientpath = args[0]
2040
del self.clients[clientpath]
2041
return
2042
elif interface == "se.recompile.Mandos.Client":
2043
if methodname == "Approve":
2044
self.testcase.assertEqual(1, len(args))
2045
return
2046
raise ValueError()
2047
2048
def setUp(self):
2049
self.bus = self.FakeMandosBus(self)
2050
2051
2052
class TestBaseCommands(TestCommand):
2053
2054
def test_IsEnabled_exits_successfully(self):
2055
with self.assertRaises(SystemExit) as e:
2056
command.IsEnabled().run(self.bus.one_client)
2057
if e.exception.code is not None:
2058
self.assertEqual(0, e.exception.code)
2059
else:
2060
self.assertIsNone(e.exception.code)
2061
2062
def test_IsEnabled_exits_with_failure(self):
2063
self.bus.client_properties["Enabled"] = False
2064
with self.assertRaises(SystemExit) as e:
2065
command.IsEnabled().run(self.bus.one_client)
2066
if isinstance(e.exception.code, int):
2067
self.assertNotEqual(0, e.exception.code)
2068
else:
2069
self.assertIsNotNone(e.exception.code)
2070
2071
def test_Approve(self):
2072
busname = "se.recompile.Mandos"
2073
client_interface = "se.recompile.Mandos.Client"
2074
command.Approve().run(self.bus.clients, self.bus)
2075
for clientpath in self.bus.clients:
2076
self.assertIn(("Approve", busname, clientpath,
2077
client_interface, (True,)), self.bus.calls)
2078
2079
def test_Deny(self):
2080
busname = "se.recompile.Mandos"
2081
client_interface = "se.recompile.Mandos.Client"
2082
command.Deny().run(self.bus.clients, self.bus)
2083
for clientpath in self.bus.clients:
2084
self.assertIn(("Approve", busname, clientpath,
2085
client_interface, (False,)),
2086
self.bus.calls)
2087
2088
def test_Remove(self):
2089
command.Remove().run(self.bus.clients, self.bus)
2090
for clientpath in self.bus.clients:
2091
self.assertIn(("RemoveClient", dbus_busname,
2092
dbus_server_path, dbus_server_interface,
2093
(clientpath,)), self.bus.calls)
2094
2095
expected_json = {
2096
"foo": {
2097
"Name": "foo",
2098
"KeyID": ("92ed150794387c03ce684574b1139a65"
2099
"94a34f895daaaf09fd8ea90a27cddb12"),
2100
"Host": "foo.example.org",
2101
"Enabled": True,
2102
"Timeout": 300000,
2103
"LastCheckedOK": "2019-02-03T00:00:00",
2104
"Created": "2019-01-02T00:00:00",
2105
"Interval": 120000,
2106
"Fingerprint": ("778827225BA7DE539C5A"
2107
"7CFA59CFF7CDBD9A5920"),
2108
"CheckerRunning": False,
2109
"LastEnabled": "2019-01-03T00:00:00",
2110
"ApprovalPending": False,
2111
"ApprovedByDefault": True,
2112
"LastApprovalRequest": "",
2113
"ApprovalDelay": 0,
2114
"ApprovalDuration": 1000,
2115
"Checker": "fping -q -- %(host)s",
2116
"ExtendedTimeout": 900000,
2117
"Expires": "2019-02-04T00:00:00",
2118
"LastCheckerStatus": 0,
2119
},
2120
"barbar": {
2121
"Name": "barbar",
2122
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
2123
"6ab612cff5ad227247e46c2b020f441c"),
2124
"Host": "192.0.2.3",
2125
"Enabled": True,
2126
"Timeout": 300000,
2127
"LastCheckedOK": "2019-02-04T00:00:00",
2128
"Created": "2019-01-03T00:00:00",
2129
"Interval": 120000,
2130
"Fingerprint": ("3E393AEAEFB84C7E89E2"
2131
"F547B3A107558FCA3A27"),
2132
"CheckerRunning": True,
2133
"LastEnabled": "2019-01-04T00:00:00",
2134
"ApprovalPending": False,
2135
"ApprovedByDefault": False,
2136
"LastApprovalRequest": "2019-01-03T00:00:00",
2137
"ApprovalDelay": 30000,
2138
"ApprovalDuration": 93785000,
2139
"Checker": ":",
2140
"ExtendedTimeout": 900000,
2141
"Expires": "2019-02-05T00:00:00",
2142
"LastCheckerStatus": -2,
2143
},
2144
}
2145
2146
def test_DumpJSON_normal(self):
2147
with self.capture_stdout_to_buffer() as buffer:
2148
command.DumpJSON().run(self.bus.clients)
2149
json_data = json.loads(buffer.getvalue())
2150
self.assertDictEqual(self.expected_json, json_data)
2151
2152
@staticmethod
2153
@contextlib.contextmanager
2154
def capture_stdout_to_buffer():
2155
capture_buffer = io.StringIO()
2156
old_stdout = sys.stdout
2157
sys.stdout = capture_buffer
2158
try:
2159
yield capture_buffer
2160
finally:
2161
sys.stdout = old_stdout
2162
2163
def test_DumpJSON_one_client(self):
2164
with self.capture_stdout_to_buffer() as buffer:
2165
command.DumpJSON().run(self.bus.one_client)
2166
json_data = json.loads(buffer.getvalue())
1398
2167
expected_json = {"foo": self.expected_json["foo"]}
1399
self.assertDictEqual(json_data, expected_json)
1400
1401
1402
class TestPrintTableCmd(TestCmd):
1403
def test_normal(self):
1404
output = PrintTableCmd().output(self.clients.values())
2168
self.assertDictEqual(expected_json, json_data)
2169
2170
def test_PrintTable_normal(self):
2171
with self.capture_stdout_to_buffer() as buffer:
2172
command.PrintTable().run(self.bus.clients)
1405
2173
expected_output = "\n".join((
1406
2174
"Name Enabled Timeout Last Successful Check",
1407
2175
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1408
2176
"barbar Yes 00:05:00 2019-02-04T00:00:00 ",
1409
))
1410
self.assertEqual(output, expected_output)
2177
)) + "\n"
2178
self.assertEqual(expected_output, buffer.getvalue())
1411
2179
1412
def test_verbose(self):
1413
output = PrintTableCmd(verbose=True).output(
1414
self.clients.values())
2180
def test_PrintTable_verbose(self):
2181
with self.capture_stdout_to_buffer() as buffer:
2182
command.PrintTable(verbose=True).run(self.bus.clients)
1415
2183
columns = (
1416
2184
(
1417
2185
"Name ",
1499
2267
)
1500
2268
)
1501
2269
num_lines = max(len(rows) for rows in columns)
1502
expected_output = "\n".join("".join(rows[line]
1503
for rows in columns)
1504
for line in range(num_lines))
1505
self.assertEqual(output, expected_output)
2270
expected_output = ("\n".join("".join(rows[line]
2271
for rows in columns)
2272
for line in range(num_lines))
2273
+ "\n")
2274
self.assertEqual(expected_output, buffer.getvalue())
1506
2275
1507
def test_one_client(self):
1508
output = PrintTableCmd().output(self.one_client.values())
2276
def test_PrintTable_one_client(self):
2277
with self.capture_stdout_to_buffer() as buffer:
2278
command.PrintTable().run(self.bus.one_client)
1509
2279
expected_output = "\n".join((
1510
2280
"Name Enabled Timeout Last Successful Check",
1511
2281
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1512
))
1513
self.assertEqual(output, expected_output)
1514
1515
1516
class Unique(object):
1517
"""Class for objects which exist only to be unique objects, since
1518
unittest.mock.sentinel only exists in Python 3.3"""
1519
1520
1521
class TestPropertyCmd(TestCmd):
1522
"""Abstract class for tests of PropertyCmd classes"""
2282
)) + "\n"
2283
self.assertEqual(expected_output, buffer.getvalue())
2284
2285
2286
class TestPropertySetterCmd(TestCommand):
2287
"""Abstract class for tests of command.PropertySetter classes"""
2288
1523
2289
def runTest(self):
1524
2290
if not hasattr(self, "command"):
1525
return
1526
values_to_get = getattr(self, "values_to_get",
1527
self.values_to_set)
1528
for value_to_set, value_to_get in zip(self.values_to_set,
1529
values_to_get):
1530
for clientpath in self.clients:
1531
client = self.bus.get_object(dbus_busname, clientpath)
1532
old_value = client.attributes[self.propname]
1533
self.assertNotIsInstance(old_value, Unique)
1534
client.attributes[self.propname] = Unique()
1535
self.run_command(value_to_set, self.clients)
1536
for clientpath in self.clients:
1537
client = self.bus.get_object(dbus_busname, clientpath)
1538
value = client.attributes[self.propname]
2291
return # Abstract TestCase class
2292
2293
if hasattr(self, "values_to_set"):
2294
cmd_args = [(value,) for value in self.values_to_set]
2295
values_to_get = getattr(self, "values_to_get",
2296
self.values_to_set)
2297
else:
2298
cmd_args = [() for x in range(len(self.values_to_get))]
2299
values_to_get = self.values_to_get
2300
for value_to_get, cmd_arg in zip(values_to_get, cmd_args):
2301
for clientpath in self.bus.clients:
2302
self.bus.clients[clientpath][self.propname] = (
2303
Unique())
2304
self.command(*cmd_arg).run(self.bus.clients, self.bus)
2305
for clientpath in self.bus.clients:
2306
value = (self.bus.clients[clientpath]
2307
[self.propname])
1539
2308
self.assertNotIsInstance(value, Unique)
1540
self.assertEqual(value, value_to_get)
1541
def run_command(self, value, clients):
1542
self.command().run(clients, self.bus)
1543
1544
1545
class TestEnableCmd(TestPropertyCmd):
1546
command = EnableCmd
1547
propname = "Enabled"
1548
values_to_set = [dbus.Boolean(True)]
1549
1550
1551
class TestDisableCmd(TestPropertyCmd):
1552
command = DisableCmd
1553
propname = "Enabled"
1554
values_to_set = [dbus.Boolean(False)]
1555
1556
1557
class TestBumpTimeoutCmd(TestPropertyCmd):
1558
command = BumpTimeoutCmd
2309
self.assertEqual(value_to_get, value)
2310
2311
2312
class TestEnableCmd(TestPropertySetterCmd):
2313
command = command.Enable
2314
propname = "Enabled"
2315
values_to_get = [True]
2316
2317
2318
class TestDisableCmd(TestPropertySetterCmd):
2319
command = command.Disable
2320
propname = "Enabled"
2321
values_to_get = [False]
2322
2323
2324
class TestBumpTimeoutCmd(TestPropertySetterCmd):
2325
command = command.BumpTimeout
1559
2326
propname = "LastCheckedOK"
1560
values_to_set = [""]
1561
1562
1563
class TestStartCheckerCmd(TestPropertyCmd):
1564
command = StartCheckerCmd
1565
propname = "CheckerRunning"
1566
values_to_set = [dbus.Boolean(True)]
1567
1568
1569
class TestStopCheckerCmd(TestPropertyCmd):
1570
command = StopCheckerCmd
1571
propname = "CheckerRunning"
1572
values_to_set = [dbus.Boolean(False)]
1573
1574
1575
class TestApproveByDefaultCmd(TestPropertyCmd):
1576
command = ApproveByDefaultCmd
1577
propname = "ApprovedByDefault"
1578
values_to_set = [dbus.Boolean(True)]
1579
1580
1581
class TestDenyByDefaultCmd(TestPropertyCmd):
1582
command = DenyByDefaultCmd
1583
propname = "ApprovedByDefault"
1584
values_to_set = [dbus.Boolean(False)]
1585
1586
1587
class TestPropertyValueCmd(TestPropertyCmd):
1588
"""Abstract class for tests of PropertyValueCmd classes"""
1589
1590
def runTest(self):
1591
if type(self) is TestPropertyValueCmd:
1592
return
1593
return super(TestPropertyValueCmd, self).runTest()
1594
1595
def run_command(self, value, clients):
1596
self.command(value).run(clients, self.bus)
1597
1598
1599
class TestSetCheckerCmd(TestPropertyValueCmd):
1600
command = SetCheckerCmd
2327
values_to_get = [""]
2328
2329
2330
class TestStartCheckerCmd(TestPropertySetterCmd):
2331
command = command.StartChecker
2332
propname = "CheckerRunning"
2333
values_to_get = [True]
2334
2335
2336
class TestStopCheckerCmd(TestPropertySetterCmd):
2337
command = command.StopChecker
2338
propname = "CheckerRunning"
2339
values_to_get = [False]
2340
2341
2342
class TestApproveByDefaultCmd(TestPropertySetterCmd):
2343
command = command.ApproveByDefault
2344
propname = "ApprovedByDefault"
2345
values_to_get = [True]
2346
2347
2348
class TestDenyByDefaultCmd(TestPropertySetterCmd):
2349
command = command.DenyByDefault
2350
propname = "ApprovedByDefault"
2351
values_to_get = [False]
2352
2353
2354
class TestSetCheckerCmd(TestPropertySetterCmd):
2355
command = command.SetChecker
1601
2356
propname = "Checker"
1602
2357
values_to_set = ["", ":", "fping -q -- %s"]
1603
2358
1604
2359
1605
class TestSetHostCmd(TestPropertyValueCmd):
1606
command = SetHostCmd
2360
class TestSetHostCmd(TestPropertySetterCmd):
2361
command = command.SetHost
1607
2362
propname = "Host"
1608
values_to_set = ["192.0.2.3", "foo.example.org"]
1609
1610
1611
class TestSetSecretCmd(TestPropertyValueCmd):
1612
command = SetSecretCmd
2363
values_to_set = ["192.0.2.3", "client.example.org"]
2364
2365
2366
class TestSetSecretCmd(TestPropertySetterCmd):
2367
command = command.SetSecret
1613
2368
propname = "Secret"
1614
2369
values_to_set = [io.BytesIO(b""),
1615
2370
io.BytesIO(b"secret\0xyzzy\nbar")]
1616
values_to_get = [b"", b"secret\0xyzzy\nbar"]
1617
1618
1619
class TestSetTimeoutCmd(TestPropertyValueCmd):
1620
command = SetTimeoutCmd
2371
values_to_get = [f.getvalue() for f in values_to_set]
2372
2373
2374
class TestSetTimeoutCmd(TestPropertySetterCmd):
2375
command = command.SetTimeout
1621
2376
propname = "Timeout"
1622
2377
values_to_set = [datetime.timedelta(),
1623
2378
datetime.timedelta(minutes=5),
1624
2379
datetime.timedelta(seconds=1),
1625
2380
datetime.timedelta(weeks=1),
1626
2381
datetime.timedelta(weeks=52)]
1627
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1628
1629
1630
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
1631
command = SetExtendedTimeoutCmd
2382
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2383
2384
2385
class TestSetExtendedTimeoutCmd(TestPropertySetterCmd):
2386
command = command.SetExtendedTimeout
1632
2387
propname = "ExtendedTimeout"
1633
2388
values_to_set = [datetime.timedelta(),
1634
2389
datetime.timedelta(minutes=5),
1635
2390
datetime.timedelta(seconds=1),
1636
2391
datetime.timedelta(weeks=1),
1637
2392
datetime.timedelta(weeks=52)]
1638
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1639
1640
1641
class TestSetIntervalCmd(TestPropertyValueCmd):
1642
command = SetIntervalCmd
2393
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2394
2395
2396
class TestSetIntervalCmd(TestPropertySetterCmd):
2397
command = command.SetInterval
1643
2398
propname = "Interval"
1644
2399
values_to_set = [datetime.timedelta(),
1645
2400
datetime.timedelta(minutes=5),
1646
2401
datetime.timedelta(seconds=1),
1647
2402
datetime.timedelta(weeks=1),
1648
2403
datetime.timedelta(weeks=52)]
1649
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1650
1651
1652
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
1653
command = SetApprovalDelayCmd
2404
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2405
2406
2407
class TestSetApprovalDelayCmd(TestPropertySetterCmd):
2408
command = command.SetApprovalDelay
1654
2409
propname = "ApprovalDelay"
1655
2410
values_to_set = [datetime.timedelta(),
1656
2411
datetime.timedelta(minutes=5),
1657
2412
datetime.timedelta(seconds=1),
1658
2413
datetime.timedelta(weeks=1),
1659
2414
datetime.timedelta(weeks=52)]
1660
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1661
1662
1663
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
1664
command = SetApprovalDurationCmd
2415
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2416
2417
2418
class TestSetApprovalDurationCmd(TestPropertySetterCmd):
2419
command = command.SetApprovalDuration
1665
2420
propname = "ApprovalDuration"
1666
2421
values_to_set = [datetime.timedelta(),
1667
2422
datetime.timedelta(minutes=5),
1668
2423
datetime.timedelta(seconds=1),
1669
2424
datetime.timedelta(weeks=1),
1670
2425
datetime.timedelta(weeks=52)]
1671
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
2426
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1672
2427
1673
2428
1674
2429
1689
2444
return tests
1690
2445
1691
2446
if __name__ == "__main__":
1692
if should_only_run_tests():
1693
# Call using ./tdd-python-script --check [--verbose]
1694
unittest.main()
1695
else:
1696
main()
2447
try:
2448
if should_only_run_tests():
2449
# Call using ./tdd-python-script --check [--verbose]
2450
unittest.main()
2451
else:
2452
main()
2453
finally:
2454
logging.shutdown()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0