To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/trunk
« back to all changes in this revision
Viewing changes to mandos-ctl
- browse files at revision 1094
- compare with another revision
- download diff
- download tarball
- view history from revision 1094
- Committer: Teddy Hogeborn
- Date: 2019-03-31 04:39:25 UTC
- Revision ID: teddy@recompile.se-20190331043925-0j9pdspo3hux5nka
mandos-ctl: Refactor: Move command list generation into argparse
* mandos-ctl (add_command_line_options): Don't simply set flags for
each option; instead, add
command objects to a
"commands" list.
(check_option_syntax): Rework to deal with an already-generated
command list.
(commands_from_options): Remove all code to generate command list,
but add more code to move command.Deny
ahead of command.Remove in command list.
(command.PropertySetterValue.argparse): New; used in
add_command_line_options.
(Test_check_option_syntax): Refactor to pass actual string arguments
to parse_args() instead of modifying an
argparse.Namespace.
* mandos-ctl (add_command_line_options): Don't simply set flags for
each option; instead, add
command objects to a
"commands" list.
(check_option_syntax): Rework to deal with an already-generated
command list.
(commands_from_options): Remove all code to generate command list,
but add more code to move command.Deny
ahead of command.Remove in command list.
(command.PropertySetterValue.argparse): New; used in
add_command_line_options.
(Test_check_option_syntax): Refactor to pass actual string arguments
to parse_args() instead of modifying an
argparse.Namespace.
- files modified:
- intro.xml
added
removed
mandos-ctl
45
45
import io
46
46
import tempfile
47
47
import contextlib
48
import abc
48
49
49
import dbus
50
import dbus as dbus_python
50
51
51
52
# Show warnings by default
52
53
if not sys.warnoptions:
66
67
67
68
locale.setlocale(locale.LC_ALL, "")
68
69
69
dbus_busname_domain = "se.recompile"
70
dbus_busname = dbus_busname_domain + ".Mandos"
71
server_dbus_path = "/"
72
server_dbus_interface = dbus_busname_domain + ".Mandos"
73
client_dbus_interface = dbus_busname_domain + ".Mandos.Client"
74
del dbus_busname_domain
75
70
version = "1.8.3"
76
71
77
72
78
try:
79
dbus.OBJECT_MANAGER_IFACE
80
except AttributeError:
81
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
82
83
84
73
def main():
85
74
parser = argparse.ArgumentParser()
86
87
75
add_command_line_options(parser)
88
76
89
77
options = parser.parse_args()
90
91
78
check_option_syntax(parser, options)
92
79
93
80
clientnames = options.client
95
82
if options.debug:
96
83
log.setLevel(logging.DEBUG)
97
84
98
bus = dbus.SystemBus()
99
100
mandos_dbus_object = get_mandos_dbus_object(bus)
101
102
mandos_serv = dbus.Interface(
103
mandos_dbus_object, dbus_interface=server_dbus_interface)
104
mandos_serv_object_manager = dbus.Interface(
105
mandos_dbus_object, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
106
107
managed_objects = get_managed_objects(mandos_serv_object_manager)
108
109
all_clients = {}
110
for path, ifs_and_props in managed_objects.items():
111
try:
112
all_clients[path] = ifs_and_props[client_dbus_interface]
113
except KeyError:
114
pass
85
bus = dbus_python_adapter.CachingBus(dbus_python)
86
87
try:
88
all_clients = bus.get_clients_and_properties()
89
except dbus.ConnectFailed as e:
90
log.critical("Could not connect to Mandos server: %s", e)
91
sys.exit(1)
92
except dbus.Error as e:
93
log.critical(
94
"Failed to access Mandos server through D-Bus:\n%s", e)
95
sys.exit(1)
115
96
116
97
# Compile dict of (clientpath: properties) to process
117
98
if not clientnames:
130
111
commands = commands_from_options(options)
131
112
132
113
for command in commands:
133
command.run(clients, bus, mandos_serv)
114
command.run(clients, bus)
134
115
135
116
136
117
def add_command_line_options(parser):
141
122
help="Select all clients")
142
123
parser.add_argument("-v", "--verbose", action="store_true",
143
124
help="Print all fields")
144
parser.add_argument("-j", "--dump-json", action="store_true",
125
parser.add_argument("-j", "--dump-json", dest="commands",
126
action="append_const", default=[],
127
const=command.DumpJSON(),
145
128
help="Dump client data in JSON format")
146
129
enable_disable = parser.add_mutually_exclusive_group()
147
enable_disable.add_argument("-e", "--enable", action="store_true",
130
enable_disable.add_argument("-e", "--enable", dest="commands",
131
action="append_const", default=[],
132
const=command.Enable(),
148
133
help="Enable client")
149
enable_disable.add_argument("-d", "--disable",
150
action="store_true",
134
enable_disable.add_argument("-d", "--disable", dest="commands",
135
action="append_const", default=[],
136
const=command.Disable(),
151
137
help="disable client")
152
parser.add_argument("-b", "--bump-timeout", action="store_true",
138
parser.add_argument("-b", "--bump-timeout", dest="commands",
139
action="append_const", default=[],
140
const=command.BumpTimeout(),
153
141
help="Bump timeout for client")
154
142
start_stop_checker = parser.add_mutually_exclusive_group()
155
143
start_stop_checker.add_argument("--start-checker",
156
action="store_true",
144
dest="commands",
145
action="append_const", default=[],
146
const=command.StartChecker(),
157
147
help="Start checker for client")
158
start_stop_checker.add_argument("--stop-checker",
159
action="store_true",
148
start_stop_checker.add_argument("--stop-checker", dest="commands",
149
action="append_const", default=[],
150
const=command.StopChecker(),
160
151
help="Stop checker for client")
161
parser.add_argument("-V", "--is-enabled", action="store_true",
152
parser.add_argument("-V", "--is-enabled", dest="commands",
153
action="append_const", default=[],
154
const=command.IsEnabled(),
162
155
help="Check if client is enabled")
163
parser.add_argument("-r", "--remove", action="store_true",
156
parser.add_argument("-r", "--remove", dest="commands",
157
action="append_const", default=[],
158
const=command.Remove(),
164
159
help="Remove client")
165
parser.add_argument("-c", "--checker",
160
parser.add_argument("-c", "--checker", dest="commands",
161
action="append", default=[],
162
metavar="COMMAND", type=command.SetChecker,
166
163
help="Set checker command for client")
167
parser.add_argument("-t", "--timeout", type=string_to_delta,
168
help="Set timeout for client")
169
parser.add_argument("--extended-timeout", type=string_to_delta,
170
help="Set extended timeout for client")
171
parser.add_argument("-i", "--interval", type=string_to_delta,
172
help="Set checker interval for client")
164
parser.add_argument(
165
"-t", "--timeout", dest="commands", action="append",
166
default=[], metavar="TIME",
167
type=command.SetTimeout.argparse(string_to_delta),
168
help="Set timeout for client")
169
parser.add_argument(
170
"--extended-timeout", dest="commands", action="append",
171
default=[], metavar="TIME",
172
type=command.SetExtendedTimeout.argparse(string_to_delta),
173
help="Set extended timeout for client")
174
parser.add_argument(
175
"-i", "--interval", dest="commands", action="append",
176
default=[], metavar="TIME",
177
type=command.SetInterval.argparse(string_to_delta),
178
help="Set checker interval for client")
173
179
approve_deny_default = parser.add_mutually_exclusive_group()
174
180
approve_deny_default.add_argument(
175
"--approve-by-default", action="store_true",
176
default=None, dest="approved_by_default",
181
"--approve-by-default", dest="commands",
182
action="append_const", default=[],
183
const=command.ApproveByDefault(),
177
184
help="Set client to be approved by default")
178
185
approve_deny_default.add_argument(
179
"--deny-by-default", action="store_false",
180
dest="approved_by_default",
186
"--deny-by-default", dest="commands",
187
action="append_const", default=[],
188
const=command.DenyByDefault(),
181
189
help="Set client to be denied by default")
182
parser.add_argument("--approval-delay", type=string_to_delta,
183
help="Set delay before client approve/deny")
184
parser.add_argument("--approval-duration", type=string_to_delta,
185
help="Set duration of one client approval")
186
parser.add_argument("-H", "--host", help="Set host for client")
187
parser.add_argument("-s", "--secret",
188
type=argparse.FileType(mode="rb"),
189
help="Set password blob (file) for client")
190
parser.add_argument(
191
"--approval-delay", dest="commands", action="append",
192
default=[], metavar="TIME",
193
type=command.SetApprovalDelay.argparse(string_to_delta),
194
help="Set delay before client approve/deny")
195
parser.add_argument(
196
"--approval-duration", dest="commands", action="append",
197
default=[], metavar="TIME",
198
type=command.SetApprovalDuration.argparse(string_to_delta),
199
help="Set duration of one client approval")
200
parser.add_argument("-H", "--host", dest="commands",
201
action="append", default=[], metavar="STRING",
202
type=command.SetHost,
203
help="Set host for client")
204
parser.add_argument(
205
"-s", "--secret", dest="commands", action="append",
206
default=[], metavar="FILENAME",
207
type=command.SetSecret.argparse(argparse.FileType(mode="rb")),
208
help="Set password blob (file) for client")
190
209
approve_deny = parser.add_mutually_exclusive_group()
191
210
approve_deny.add_argument(
192
"-A", "--approve", action="store_true",
211
"-A", "--approve", dest="commands", action="append_const",
212
default=[], const=command.Approve(),
193
213
help="Approve any current client request")
194
approve_deny.add_argument("-D", "--deny", action="store_true",
214
approve_deny.add_argument("-D", "--deny", dest="commands",
215
action="append_const", default=[],
216
const=command.Deny(),
195
217
help="Deny any current client request")
196
218
parser.add_argument("--debug", action="store_true",
197
219
help="Debug mode (show D-Bus commands)")
388
410
"""Apply additional restrictions on options, not expressible in
389
411
argparse"""
390
412
391
def has_actions(options):
392
return any((options.enable,
393
options.disable,
394
options.bump_timeout,
395
options.start_checker,
396
options.stop_checker,
397
options.is_enabled,
398
options.remove,
399
options.checker is not None,
400
options.timeout is not None,
401
options.extended_timeout is not None,
402
options.interval is not None,
403
options.approved_by_default is not None,
404
options.approval_delay is not None,
405
options.approval_duration is not None,
406
options.host is not None,
407
options.secret is not None,
408
options.approve,
409
options.deny))
413
def has_commands(options, commands=None):
414
if commands is None:
415
commands = (command.Enable,
416
command.Disable,
417
command.BumpTimeout,
418
command.StartChecker,
419
command.StopChecker,
420
command.IsEnabled,
421
command.Remove,
422
command.SetChecker,
423
command.SetTimeout,
424
command.SetExtendedTimeout,
425
command.SetInterval,
426
command.ApproveByDefault,
427
command.DenyByDefault,
428
command.SetApprovalDelay,
429
command.SetApprovalDuration,
430
command.SetHost,
431
command.SetSecret,
432
command.Approve,
433
command.Deny)
434
return any(isinstance(cmd, commands)
435
for cmd in options.commands)
410
436
411
if has_actions(options) and not (options.client or options.all):
437
if has_commands(options) and not (options.client or options.all):
412
438
parser.error("Options require clients names or --all.")
413
if options.verbose and has_actions(options):
439
if options.verbose and has_commands(options):
414
440
parser.error("--verbose can only be used alone.")
415
if options.dump_json and (options.verbose
416
or has_actions(options)):
441
if (has_commands(options, (command.DumpJSON,))
442
and (options.verbose or len(options.commands) > 1)):
417
443
parser.error("--dump-json can only be used alone.")
418
if options.all and not has_actions(options):
444
if options.all and not has_commands(options):
419
445
parser.error("--all requires an action.")
420
if options.is_enabled and len(options.client) > 1:
446
if (has_commands(options, (command.IsEnabled,))
447
and len(options.client) > 1):
421
448
parser.error("--is-enabled requires exactly one client")
422
if options.remove:
423
options.remove = False
424
if has_actions(options) and not options.deny:
425
parser.error("--remove can only be combined with --deny")
426
options.remove = True
427
428
429
def get_mandos_dbus_object(bus):
430
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
431
dbus_busname, server_dbus_path)
432
with if_dbus_exception_log_with_exception_and_exit(
433
"Could not connect to Mandos server: %s"):
434
mandos_dbus_object = bus.get_object(dbus_busname,
435
server_dbus_path)
436
return mandos_dbus_object
437
438
439
@contextlib.contextmanager
440
def if_dbus_exception_log_with_exception_and_exit(*args, **kwargs):
441
try:
442
yield
443
except dbus.exceptions.DBusException as e:
444
log.critical(*(args + (e,)), **kwargs)
445
sys.exit(1)
446
447
448
def get_managed_objects(object_manager):
449
log.debug("D-Bus: %s:%s:%s.GetManagedObjects()", dbus_busname,
450
server_dbus_path, dbus.OBJECT_MANAGER_IFACE)
451
with if_dbus_exception_log_with_exception_and_exit(
452
"Failed to access Mandos server through D-Bus:\n%s"):
453
with SilenceLogger("dbus.proxies"):
454
managed_objects = object_manager.GetManagedObjects()
455
return managed_objects
456
457
458
class SilenceLogger(object):
459
"Simple context manager to silence a particular logger"
460
def __init__(self, loggername):
461
self.logger = logging.getLogger(loggername)
462
463
def __enter__(self):
464
self.logger.addFilter(self.nullfilter)
465
return self
466
467
class NullFilter(logging.Filter):
468
def filter(self, record):
469
return False
470
471
nullfilter = NullFilter()
472
473
def __exit__(self, exc_type, exc_val, exc_tb):
474
self.logger.removeFilter(self.nullfilter)
449
if (len(options.commands) > 1
450
and has_commands(options, (command.Remove,))
451
and not has_commands(options, (command.Deny,))):
452
parser.error("--remove can only be combined with --deny")
453
454
455
class dbus(object):
456
457
class SystemBus(object):
458
459
object_manager_iface = "org.freedesktop.DBus.ObjectManager"
460
def get_managed_objects(self, busname, objectpath):
461
return self.call_method("GetManagedObjects", busname,
462
objectpath,
463
self.object_manager_iface)
464
465
properties_iface = "org.freedesktop.DBus.Properties"
466
def set_property(self, busname, objectpath, interface, key,
467
value):
468
self.call_method("Set", busname, objectpath,
469
self.properties_iface, interface, key,
470
value)
471
472
473
class MandosBus(SystemBus):
474
busname_domain = "se.recompile"
475
busname = busname_domain + ".Mandos"
476
server_path = "/"
477
server_interface = busname_domain + ".Mandos"
478
client_interface = busname_domain + ".Mandos.Client"
479
del busname_domain
480
481
def get_clients_and_properties(self):
482
managed_objects = self.get_managed_objects(
483
self.busname, self.server_path)
484
return {objpath: properties[self.client_interface]
485
for objpath, properties in managed_objects.items()
486
if self.client_interface in properties}
487
488
def set_client_property(self, objectpath, key, value):
489
return self.set_property(self.busname, objectpath,
490
self.client_interface, key,
491
value)
492
493
def call_client_method(self, objectpath, method, *args):
494
return self.call_method(method, self.busname, objectpath,
495
self.client_interface, *args)
496
497
def call_server_method(self, method, *args):
498
return self.call_method(method, self.busname,
499
self.server_path,
500
self.server_interface, *args)
501
502
class Error(Exception):
503
pass
504
505
class ConnectFailed(Error):
506
pass
507
508
509
class dbus_python_adapter(object):
510
511
class SystemBus(dbus.MandosBus):
512
"""Use dbus-python"""
513
514
def __init__(self, module=dbus_python):
515
self.dbus_python = module
516
self.bus = self.dbus_python.SystemBus()
517
518
@contextlib.contextmanager
519
def convert_exception(self, exception_class=dbus.Error):
520
try:
521
yield
522
except self.dbus_python.exceptions.DBusException as e:
523
# This does what "raise from" would do
524
exc = exception_class(*e.args)
525
exc.__cause__ = e
526
raise exc
527
528
def call_method(self, methodname, busname, objectpath,
529
interface, *args):
530
proxy_object = self.get_object(busname, objectpath)
531
log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
532
interface, methodname,
533
", ".join(repr(a) for a in args))
534
method = getattr(proxy_object, methodname)
535
with self.convert_exception():
536
with dbus_python_adapter.SilenceLogger(
537
"dbus.proxies"):
538
value = method(*args, dbus_interface=interface)
539
return self.type_filter(value)
540
541
def get_object(self, busname, objectpath):
542
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
543
busname, objectpath)
544
with self.convert_exception(dbus.ConnectFailed):
545
return self.bus.get_object(busname, objectpath)
546
547
def type_filter(self, value):
548
"""Convert the most bothersome types to Python types"""
549
if isinstance(value, self.dbus_python.Boolean):
550
return bool(value)
551
if isinstance(value, self.dbus_python.ObjectPath):
552
return str(value)
553
# Also recurse into dictionaries
554
if isinstance(value, self.dbus_python.Dictionary):
555
return {self.type_filter(key):
556
self.type_filter(subval)
557
for key, subval in value.items()}
558
return value
559
560
561
class SilenceLogger(object):
562
"Simple context manager to silence a particular logger"
563
def __init__(self, loggername):
564
self.logger = logging.getLogger(loggername)
565
566
def __enter__(self):
567
self.logger.addFilter(self.nullfilter)
568
569
class NullFilter(logging.Filter):
570
def filter(self, record):
571
return False
572
573
nullfilter = NullFilter()
574
575
def __exit__(self, exc_type, exc_val, exc_tb):
576
self.logger.removeFilter(self.nullfilter)
577
578
579
class CachingBus(SystemBus):
580
"""A caching layer for dbus_python_adapter.SystemBus"""
581
def __init__(self, *args, **kwargs):
582
self.object_cache = {}
583
super(dbus_python_adapter.CachingBus,
584
self).__init__(*args, **kwargs)
585
def get_object(self, busname, objectpath):
586
try:
587
return self.object_cache[(busname, objectpath)]
588
except KeyError:
589
new_object = super(
590
dbus_python_adapter.CachingBus,
591
self).get_object(busname, objectpath)
592
self.object_cache[(busname, objectpath)] = new_object
593
return new_object
475
594
476
595
477
596
def commands_from_options(options):
478
597
479
commands = []
480
481
if options.is_enabled:
482
commands.append(command.IsEnabled())
483
484
if options.approve:
485
commands.append(command.Approve())
486
487
if options.deny:
488
commands.append(command.Deny())
489
490
if options.remove:
491
commands.append(command.Remove())
492
493
if options.dump_json:
494
commands.append(command.DumpJSON())
495
496
if options.enable:
497
commands.append(command.Enable())
498
499
if options.disable:
500
commands.append(command.Disable())
501
502
if options.bump_timeout:
503
commands.append(command.BumpTimeout())
504
505
if options.start_checker:
506
commands.append(command.StartChecker())
507
508
if options.stop_checker:
509
commands.append(command.StopChecker())
510
511
if options.approved_by_default is not None:
512
if options.approved_by_default:
513
commands.append(command.ApproveByDefault())
598
commands = list(options.commands)
599
600
def find_cmd(cmd, commands):
601
i = 0
602
for i, c in enumerate(commands):
603
if isinstance(c, cmd):
604
return i
605
return i+1
606
607
# If command.Remove is present, move any instances of command.Deny
608
# to occur ahead of command.Remove.
609
index_of_remove = find_cmd(command.Remove, commands)
610
before_remove = commands[:index_of_remove]
611
after_remove = commands[index_of_remove:]
612
cleaned_after = []
613
for cmd in after_remove:
614
if isinstance(cmd, command.Deny):
615
before_remove.append(cmd)
514
616
else:
515
commands.append(command.DenyByDefault())
516
517
if options.checker is not None:
518
commands.append(command.SetChecker(options.checker))
519
520
if options.host is not None:
521
commands.append(command.SetHost(options.host))
522
523
if options.secret is not None:
524
commands.append(command.SetSecret(options.secret))
525
526
if options.timeout is not None:
527
commands.append(command.SetTimeout(options.timeout))
528
529
if options.extended_timeout:
530
commands.append(
531
command.SetExtendedTimeout(options.extended_timeout))
532
533
if options.interval is not None:
534
commands.append(command.SetInterval(options.interval))
535
536
if options.approval_delay is not None:
537
commands.append(
538
command.SetApprovalDelay(options.approval_delay))
539
540
if options.approval_duration is not None:
541
commands.append(
542
command.SetApprovalDuration(options.approval_duration))
617
cleaned_after.append(cmd)
618
if cleaned_after != after_remove:
619
commands = before_remove + cleaned_after
543
620
544
621
# If no command option has been given, show table of clients,
545
622
# optionally verbosely
554
631
555
632
class Base(object):
556
633
"""Abstract base class for commands"""
557
def run(self, clients, bus=None, mandos=None):
634
def run(self, clients, bus=None):
558
635
"""Normal commands should implement run_on_one_client(),
559
636
but commands which want to operate on all clients at the same time can
560
637
override this run() method instead.
561
638
"""
562
self.mandos = mandos
563
for clientpath, properties in clients.items():
564
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
565
dbus_busname, str(clientpath))
566
client = bus.get_object(dbus_busname, clientpath)
639
self.bus = bus
640
for client, properties in clients.items():
567
641
self.run_on_one_client(client, properties)
568
642
569
643
570
644
class IsEnabled(Base):
571
def run(self, clients, bus=None, mandos=None):
572
client, properties = next(iter(clients.items()))
573
if self.is_enabled(client, properties):
645
def run(self, clients, bus=None):
646
properties = next(iter(clients.values()))
647
if properties["Enabled"]:
574
648
sys.exit(0)
575
649
sys.exit(1)
576
def is_enabled(self, client, properties):
577
return properties["Enabled"]
578
650
579
651
580
652
class Approve(Base):
581
653
def run_on_one_client(self, client, properties):
582
log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
583
client.__dbus_object_path__,
584
client_dbus_interface)
585
client.Approve(dbus.Boolean(True),
586
dbus_interface=client_dbus_interface)
654
self.bus.call_client_method(client, "Approve", True)
587
655
588
656
589
657
class Deny(Base):
590
658
def run_on_one_client(self, client, properties):
591
log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
592
client.__dbus_object_path__,
593
client_dbus_interface)
594
client.Approve(dbus.Boolean(False),
595
dbus_interface=client_dbus_interface)
659
self.bus.call_client_method(client, "Approve", False)
596
660
597
661
598
662
class Remove(Base):
599
def run_on_one_client(self, client, properties):
600
log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)",
601
dbus_busname, server_dbus_path,
602
server_dbus_interface,
603
str(client.__dbus_object_path__))
604
self.mandos.RemoveClient(client.__dbus_object_path__)
663
def run(self, clients, bus):
664
for clientpath in frozenset(clients.keys()):
665
bus.call_server_method("RemoveClient", clientpath)
605
666
606
667
607
668
class Output(Base):
617
678
618
679
619
680
class DumpJSON(Output):
620
def run(self, clients, bus=None, mandos=None):
621
data = {client["Name"]:
622
{key: self.dbus_boolean_to_bool(client[key])
681
def run(self, clients, bus=None):
682
data = {properties["Name"]:
683
{key: properties[key]
623
684
for key in self.all_keywords}
624
for client in clients.values()}
685
for properties in clients.values()}
625
686
print(json.dumps(data, indent=4, separators=(',', ': ')))
626
687
627
@staticmethod
628
def dbus_boolean_to_bool(value):
629
if isinstance(value, dbus.Boolean):
630
value = bool(value)
631
return value
632
633
688
634
689
class PrintTable(Output):
635
690
def __init__(self, verbose=False):
636
691
self.verbose = verbose
637
692
638
def run(self, clients, bus=None, mandos=None):
693
def run(self, clients, bus=None):
639
694
default_keywords = ("Name", "Enabled", "Timeout",
640
695
"LastCheckedOK")
641
696
keywords = default_keywords
702
757
703
758
@classmethod
704
759
def valuetostring(cls, value, keyword):
705
if isinstance(value, dbus.Boolean):
760
if isinstance(value, bool):
706
761
return "Yes" if value else "No"
707
762
if keyword in ("Timeout", "Interval", "ApprovalDelay",
708
763
"ApprovalDuration", "ExtendedTimeout"):
728
783
seconds=td.seconds % 60))
729
784
730
785
731
class Property(Base):
786
class PropertySetter(Base):
732
787
"Abstract class for Actions for setting one client property"
733
788
734
def run_on_one_client(self, client, properties):
789
def run_on_one_client(self, client, properties=None):
735
790
"""Set the Client's D-Bus property"""
736
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
737
client.__dbus_object_path__,
738
dbus.PROPERTIES_IFACE, client_dbus_interface,
739
self.propname, self.value_to_set
740
if not isinstance(self.value_to_set,
741
dbus.Boolean)
742
else bool(self.value_to_set))
743
client.Set(client_dbus_interface, self.propname,
744
self.value_to_set,
745
dbus_interface=dbus.PROPERTIES_IFACE)
791
self.bus.set_client_property(client, self.propname,
792
self.value_to_set)
746
793
747
794
@property
748
795
def propname(self):
749
796
raise NotImplementedError()
750
797
751
798
752
class Enable(Property):
753
propname = "Enabled"
754
value_to_set = dbus.Boolean(True)
755
756
757
class Disable(Property):
758
propname = "Enabled"
759
value_to_set = dbus.Boolean(False)
760
761
762
class BumpTimeout(Property):
799
class Enable(PropertySetter):
800
propname = "Enabled"
801
value_to_set = True
802
803
804
class Disable(PropertySetter):
805
propname = "Enabled"
806
value_to_set = False
807
808
809
class BumpTimeout(PropertySetter):
763
810
propname = "LastCheckedOK"
764
811
value_to_set = ""
765
812
766
813
767
class StartChecker(Property):
768
propname = "CheckerRunning"
769
value_to_set = dbus.Boolean(True)
770
771
772
class StopChecker(Property):
773
propname = "CheckerRunning"
774
value_to_set = dbus.Boolean(False)
775
776
777
class ApproveByDefault(Property):
778
propname = "ApprovedByDefault"
779
value_to_set = dbus.Boolean(True)
780
781
782
class DenyByDefault(Property):
783
propname = "ApprovedByDefault"
784
value_to_set = dbus.Boolean(False)
785
786
787
class PropertyValue(Property):
788
"Abstract class for Property recieving a value as argument"
814
class StartChecker(PropertySetter):
815
propname = "CheckerRunning"
816
value_to_set = True
817
818
819
class StopChecker(PropertySetter):
820
propname = "CheckerRunning"
821
value_to_set = False
822
823
824
class ApproveByDefault(PropertySetter):
825
propname = "ApprovedByDefault"
826
value_to_set = True
827
828
829
class DenyByDefault(PropertySetter):
830
propname = "ApprovedByDefault"
831
value_to_set = False
832
833
834
class PropertySetterValue(PropertySetter):
835
"""Abstract class for PropertySetter recieving a value as
836
constructor argument instead of a class attribute."""
789
837
def __init__(self, value):
790
838
self.value_to_set = value
791
839
840
@classmethod
841
def argparse(cls, argtype):
842
def cmdtype(arg):
843
return cls(argtype(arg))
844
return cmdtype
792
845
793
class SetChecker(PropertyValue):
846
class SetChecker(PropertySetterValue):
794
847
propname = "Checker"
795
848
796
849
797
class SetHost(PropertyValue):
850
class SetHost(PropertySetterValue):
798
851
propname = "Host"
799
852
800
853
801
class SetSecret(PropertyValue):
854
class SetSecret(PropertySetterValue):
802
855
propname = "Secret"
803
856
804
857
@property
812
865
value.close()
813
866
814
867
815
class MillisecondsPropertyValueArgument(PropertyValue):
816
"""Abstract class for PropertyValue taking a value argument as
817
a datetime.timedelta() but should store it as milliseconds."""
868
class PropertySetterValueMilliseconds(PropertySetterValue):
869
"""Abstract class for PropertySetterValue taking a value
870
argument as a datetime.timedelta() but should store it as
871
milliseconds."""
818
872
819
873
@property
820
874
def value_to_set(self):
826
880
self._vts = int(round(value.total_seconds() * 1000))
827
881
828
882
829
class SetTimeout(MillisecondsPropertyValueArgument):
883
class SetTimeout(PropertySetterValueMilliseconds):
830
884
propname = "Timeout"
831
885
832
886
833
class SetExtendedTimeout(MillisecondsPropertyValueArgument):
887
class SetExtendedTimeout(PropertySetterValueMilliseconds):
834
888
propname = "ExtendedTimeout"
835
889
836
890
837
class SetInterval(MillisecondsPropertyValueArgument):
891
class SetInterval(PropertySetterValueMilliseconds):
838
892
propname = "Interval"
839
893
840
894
841
class SetApprovalDelay(MillisecondsPropertyValueArgument):
895
class SetApprovalDelay(PropertySetterValueMilliseconds):
842
896
propname = "ApprovalDelay"
843
897
844
898
845
class SetApprovalDuration(MillisecondsPropertyValueArgument):
899
class SetApprovalDuration(PropertySetterValueMilliseconds):
846
900
propname = "ApprovalDuration"
847
901
848
902
881
935
"output"))
882
936
883
937
938
class Unique(object):
939
"""Class for objects which exist only to be unique objects, since
940
unittest.mock.sentinel only exists in Python 3.3"""
941
942
884
943
class Test_string_to_delta(TestCaseWithAssertLogs):
885
944
# Just test basic RFC 3339 functionality here, the doc string for
886
945
# rfc3339_duration_to_delta() already has more comprehensive
887
# tests, which is run by doctest.
946
# tests, which are run by doctest.
888
947
889
948
def test_rfc3339_zero_seconds(self):
890
949
self.assertEqual(datetime.timedelta(),
914
973
915
974
def test_actions_requires_client_or_all(self):
916
975
for action, value in self.actions.items():
917
options = self.parser.parse_args()
918
setattr(options, action, value)
976
args = self.actionargs(action, value)
919
977
with self.assertParseError():
920
self.check_option_syntax(options)
978
self.parse_args(args)
921
979
922
# This mostly corresponds to the definition from has_actions() in
980
# This mostly corresponds to the definition from has_commands() in
923
981
# check_option_syntax()
924
982
actions = {
925
# The actual values set here are not that important, but we do
926
# at least stick to the correct types, even though they are
927
# never used
928
"enable": True,
929
"disable": True,
930
"bump_timeout": True,
931
"start_checker": True,
932
"stop_checker": True,
933
"is_enabled": True,
934
"remove": True,
935
"checker": "x",
936
"timeout": datetime.timedelta(),
937
"extended_timeout": datetime.timedelta(),
938
"interval": datetime.timedelta(),
939
"approved_by_default": True,
940
"approval_delay": datetime.timedelta(),
941
"approval_duration": datetime.timedelta(),
942
"host": "x",
943
"secret": io.BytesIO(b"x"),
944
"approve": True,
945
"deny": True,
983
"--enable": None,
984
"--disable": None,
985
"--bump-timeout": None,
986
"--start-checker": None,
987
"--stop-checker": None,
988
"--is-enabled": None,
989
"--remove": None,
990
"--checker": "x",
991
"--timeout": "PT0S",
992
"--extended-timeout": "PT0S",
993
"--interval": "PT0S",
994
"--approve-by-default": None,
995
"--deny-by-default": None,
996
"--approval-delay": "PT0S",
997
"--approval-duration": "PT0S",
998
"--host": "hostname",
999
"--secret": "/dev/null",
1000
"--approve": None,
1001
"--deny": None,
946
1002
}
947
1003
1004
@staticmethod
1005
def actionargs(action, value, *args):
1006
if value is not None:
1007
return [action, value] + list(args)
1008
else:
1009
return [action] + list(args)
1010
948
1011
@contextlib.contextmanager
949
1012
def assertParseError(self):
950
1013
with self.assertRaises(SystemExit) as e:
955
1018
# /argparse.html#exiting-methods
956
1019
self.assertEqual(2, e.exception.code)
957
1020
1021
def parse_args(self, args):
1022
options = self.parser.parse_args(args)
1023
check_option_syntax(self.parser, options)
1024
958
1025
@staticmethod
959
1026
@contextlib.contextmanager
960
1027
def redirect_stderr_to_devnull():
971
1038
972
1039
def test_actions_all_conflicts_with_verbose(self):
973
1040
for action, value in self.actions.items():
974
options = self.parser.parse_args()
975
setattr(options, action, value)
976
options.all = True
977
options.verbose = True
1041
args = self.actionargs(action, value, "--all",
1042
"--verbose")
978
1043
with self.assertParseError():
979
self.check_option_syntax(options)
1044
self.parse_args(args)
980
1045
981
1046
def test_actions_with_client_conflicts_with_verbose(self):
982
1047
for action, value in self.actions.items():
983
options = self.parser.parse_args()
984
setattr(options, action, value)
985
options.verbose = True
986
options.client = ["client"]
1048
args = self.actionargs(action, value, "--verbose",
1049
"client")
987
1050
with self.assertParseError():
988
self.check_option_syntax(options)
1051
self.parse_args(args)
989
1052
990
1053
def test_dump_json_conflicts_with_verbose(self):
991
options = self.parser.parse_args()
992
options.dump_json = True
993
options.verbose = True
1054
args = ["--dump-json", "--verbose"]
994
1055
with self.assertParseError():
995
self.check_option_syntax(options)
1056
self.parse_args(args)
996
1057
997
1058
def test_dump_json_conflicts_with_action(self):
998
1059
for action, value in self.actions.items():
999
options = self.parser.parse_args()
1000
setattr(options, action, value)
1001
options.dump_json = True
1060
args = self.actionargs(action, value, "--dump-json")
1002
1061
with self.assertParseError():
1003
self.check_option_syntax(options)
1062
self.parse_args(args)
1004
1063
1005
1064
def test_all_can_not_be_alone(self):
1006
options = self.parser.parse_args()
1007
options.all = True
1065
args = ["--all"]
1008
1066
with self.assertParseError():
1009
self.check_option_syntax(options)
1067
self.parse_args(args)
1010
1068
1011
1069
def test_all_is_ok_with_any_action(self):
1012
1070
for action, value in self.actions.items():
1013
options = self.parser.parse_args()
1014
setattr(options, action, value)
1015
options.all = True
1016
self.check_option_syntax(options)
1071
args = self.actionargs(action, value, "--all")
1072
self.parse_args(args)
1017
1073
1018
1074
def test_any_action_is_ok_with_one_client(self):
1019
1075
for action, value in self.actions.items():
1020
options = self.parser.parse_args()
1021
setattr(options, action, value)
1022
options.client = ["client"]
1023
self.check_option_syntax(options)
1076
args = self.actionargs(action, value, "client")
1077
self.parse_args(args)
1024
1078
1025
1079
def test_one_client_with_all_actions_except_is_enabled(self):
1026
options = self.parser.parse_args()
1027
1080
for action, value in self.actions.items():
1028
if action == "is_enabled":
1081
if action == "--is-enabled":
1029
1082
continue
1030
setattr(options, action, value)
1031
options.client = ["client"]
1032
self.check_option_syntax(options)
1083
args = self.actionargs(action, value, "client")
1084
self.parse_args(args)
1033
1085
1034
1086
def test_two_clients_with_all_actions_except_is_enabled(self):
1035
options = self.parser.parse_args()
1036
1087
for action, value in self.actions.items():
1037
if action == "is_enabled":
1088
if action == "--is-enabled":
1038
1089
continue
1039
setattr(options, action, value)
1040
options.client = ["client1", "client2"]
1041
self.check_option_syntax(options)
1090
args = self.actionargs(action, value, "client1",
1091
"client2")
1092
self.parse_args(args)
1042
1093
1043
1094
def test_two_clients_are_ok_with_actions_except_is_enabled(self):
1044
1095
for action, value in self.actions.items():
1045
if action == "is_enabled":
1096
if action == "--is-enabled":
1046
1097
continue
1047
options = self.parser.parse_args()
1048
setattr(options, action, value)
1049
options.client = ["client1", "client2"]
1050
self.check_option_syntax(options)
1098
args = self.actionargs(action, value, "client1",
1099
"client2")
1100
self.parse_args(args)
1051
1101
1052
1102
def test_is_enabled_fails_without_client(self):
1053
options = self.parser.parse_args()
1054
options.is_enabled = True
1103
args = ["--is-enabled"]
1055
1104
with self.assertParseError():
1056
self.check_option_syntax(options)
1105
self.parse_args(args)
1057
1106
1058
1107
def test_is_enabled_fails_with_two_clients(self):
1059
options = self.parser.parse_args()
1060
options.is_enabled = True
1061
options.client = ["client1", "client2"]
1108
args = ["--is-enabled", "client1", "client2"]
1062
1109
with self.assertParseError():
1063
self.check_option_syntax(options)
1110
self.parse_args(args)
1064
1111
1065
1112
def test_remove_can_only_be_combined_with_action_deny(self):
1066
1113
for action, value in self.actions.items():
1067
if action in {"remove", "deny"}:
1114
if action in {"--remove", "--deny"}:
1068
1115
continue
1069
options = self.parser.parse_args()
1070
setattr(options, action, value)
1071
options.all = True
1072
options.remove = True
1116
args = self.actionargs(action, value, "--all",
1117
"--remove")
1073
1118
with self.assertParseError():
1074
self.check_option_syntax(options)
1075
1076
1077
class Test_get_mandos_dbus_object(TestCaseWithAssertLogs):
1078
def test_calls_and_returns_get_object_on_bus(self):
1079
class MockBus(object):
1080
called = False
1081
def get_object(mockbus_self, busname, dbus_path):
1082
# Note that "self" is still the testcase instance,
1083
# this MockBus instance is in "mockbus_self".
1084
self.assertEqual(dbus_busname, busname)
1085
self.assertEqual(server_dbus_path, dbus_path)
1086
mockbus_self.called = True
1087
return mockbus_self
1088
1089
mockbus = get_mandos_dbus_object(bus=MockBus())
1090
self.assertIsInstance(mockbus, MockBus)
1091
self.assertTrue(mockbus.called)
1092
1093
def test_logs_and_exits_on_dbus_error(self):
1094
class FailingBusStub(object):
1095
def get_object(self, busname, dbus_path):
1096
raise dbus.exceptions.DBusException("Test")
1097
1098
with self.assertLogs(log, logging.CRITICAL):
1099
with self.assertRaises(SystemExit) as e:
1100
bus = get_mandos_dbus_object(bus=FailingBusStub())
1101
1102
if isinstance(e.exception.code, int):
1103
self.assertNotEqual(0, e.exception.code)
1104
else:
1105
self.assertIsNotNone(e.exception.code)
1106
1107
1108
class Test_get_managed_objects(TestCaseWithAssertLogs):
1109
def test_calls_and_returns_GetManagedObjects(self):
1110
managed_objects = {"/clients/client": { "Name": "client"}}
1111
class ObjectManagerStub(object):
1112
def GetManagedObjects(self):
1113
return managed_objects
1114
retval = get_managed_objects(ObjectManagerStub())
1115
self.assertDictEqual(managed_objects, retval)
1116
1117
def test_logs_and_exits_on_dbus_error(self):
1119
self.parse_args(args)
1120
1121
1122
class Test_dbus_exceptions(unittest.TestCase):
1123
1124
def test_dbus_ConnectFailed_is_Error(self):
1125
with self.assertRaises(dbus.Error):
1126
raise dbus.ConnectFailed()
1127
1128
1129
class Test_dbus_MandosBus(unittest.TestCase):
1130
1131
class MockMandosBus(dbus.MandosBus):
1132
def __init__(self):
1133
self._name = "se.recompile.Mandos"
1134
self._server_path = "/"
1135
self._server_interface = "se.recompile.Mandos"
1136
self._client_interface = "se.recompile.Mandos.Client"
1137
self.calls = []
1138
self.call_method_return = Unique()
1139
1140
def call_method(self, methodname, busname, objectpath,
1141
interface, *args):
1142
self.calls.append((methodname, busname, objectpath,
1143
interface, args))
1144
return self.call_method_return
1145
1146
def setUp(self):
1147
self.bus = self.MockMandosBus()
1148
1149
def test_set_client_property(self):
1150
self.bus.set_client_property("objectpath", "key", "value")
1151
expected_call = ("Set", self.bus._name, "objectpath",
1152
"org.freedesktop.DBus.Properties",
1153
(self.bus._client_interface, "key", "value"))
1154
self.assertIn(expected_call, self.bus.calls)
1155
1156
def test_call_client_method(self):
1157
ret = self.bus.call_client_method("objectpath", "methodname")
1158
self.assertIs(self.bus.call_method_return, ret)
1159
expected_call = ("methodname", self.bus._name, "objectpath",
1160
self.bus._client_interface, ())
1161
self.assertIn(expected_call, self.bus.calls)
1162
1163
def test_call_client_method_with_args(self):
1164
args = (Unique(), Unique())
1165
ret = self.bus.call_client_method("objectpath", "methodname",
1166
*args)
1167
self.assertIs(self.bus.call_method_return, ret)
1168
expected_call = ("methodname", self.bus._name, "objectpath",
1169
self.bus._client_interface,
1170
(args[0], args[1]))
1171
self.assertIn(expected_call, self.bus.calls)
1172
1173
def test_get_clients_and_properties(self):
1174
managed_objects = {
1175
"objectpath": {
1176
self.bus._client_interface: {
1177
"key": "value",
1178
"bool": True,
1179
},
1180
"irrelevant_interface": {
1181
"key": "othervalue",
1182
"bool": False,
1183
},
1184
},
1185
"other_objectpath": {
1186
"other_irrelevant_interface": {
1187
"key": "value 3",
1188
"bool": None,
1189
},
1190
},
1191
}
1192
expected_clients_and_properties = {
1193
"objectpath": {
1194
"key": "value",
1195
"bool": True,
1196
}
1197
}
1198
self.bus.call_method_return = managed_objects
1199
ret = self.bus.get_clients_and_properties()
1200
self.assertDictEqual(expected_clients_and_properties, ret)
1201
expected_call = ("GetManagedObjects", self.bus._name,
1202
self.bus._server_path,
1203
"org.freedesktop.DBus.ObjectManager", ())
1204
self.assertIn(expected_call, self.bus.calls)
1205
1206
def test_call_server_method(self):
1207
ret = self.bus.call_server_method("methodname")
1208
self.assertIs(self.bus.call_method_return, ret)
1209
expected_call = ("methodname", self.bus._name,
1210
self.bus._server_path,
1211
self.bus._server_interface, ())
1212
self.assertIn(expected_call, self.bus.calls)
1213
1214
def test_call_server_method_with_args(self):
1215
args = (Unique(), Unique())
1216
ret = self.bus.call_server_method("methodname", *args)
1217
self.assertIs(self.bus.call_method_return, ret)
1218
expected_call = ("methodname", self.bus._name,
1219
self.bus._server_path,
1220
self.bus._server_interface,
1221
(args[0], args[1]))
1222
self.assertIn(expected_call, self.bus.calls)
1223
1224
1225
class Test_dbus_python_adapter_SystemBus(TestCaseWithAssertLogs):
1226
1227
def MockDBusPython_func(self, func):
1228
class mock_dbus_python(object):
1229
"""mock dbus-python module"""
1230
class exceptions(object):
1231
"""Pseudo-namespace"""
1232
class DBusException(Exception):
1233
pass
1234
class SystemBus(object):
1235
@staticmethod
1236
def get_object(busname, objectpath):
1237
DBusObject = collections.namedtuple(
1238
"DBusObject", ("methodname",))
1239
def method(*args, **kwargs):
1240
self.assertEqual({"dbus_interface":
1241
"interface"},
1242
kwargs)
1243
return func(*args)
1244
return DBusObject(methodname=method)
1245
class Boolean(object):
1246
def __init__(self, value):
1247
self.value = bool(value)
1248
def __bool__(self):
1249
return self.value
1250
if sys.version_info.major == 2:
1251
__nonzero__ = __bool__
1252
class ObjectPath(str):
1253
pass
1254
class Dictionary(dict):
1255
pass
1256
return mock_dbus_python
1257
1258
def call_method(self, bus, methodname, busname, objectpath,
1259
interface, *args):
1260
with self.assertLogs(log, logging.DEBUG):
1261
return bus.call_method(methodname, busname, objectpath,
1262
interface, *args)
1263
1264
def test_call_method_returns(self):
1265
expected_method_return = Unique()
1266
method_args = (Unique(), Unique())
1267
def func(*args):
1268
self.assertEqual(len(method_args), len(args))
1269
for marg, arg in zip(method_args, args):
1270
self.assertIs(marg, arg)
1271
return expected_method_return
1272
mock_dbus_python = self.MockDBusPython_func(func)
1273
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1274
ret = self.call_method(bus, "methodname", "busname",
1275
"objectpath", "interface",
1276
*method_args)
1277
self.assertIs(ret, expected_method_return)
1278
1279
def test_call_method_filters_bool_true(self):
1280
def func():
1281
return method_return
1282
mock_dbus_python = self.MockDBusPython_func(func)
1283
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1284
method_return = mock_dbus_python.Boolean(True)
1285
ret = self.call_method(bus, "methodname", "busname",
1286
"objectpath", "interface")
1287
self.assertTrue(ret)
1288
self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1289
1290
def test_call_method_filters_bool_false(self):
1291
def func():
1292
return method_return
1293
mock_dbus_python = self.MockDBusPython_func(func)
1294
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1295
method_return = mock_dbus_python.Boolean(False)
1296
ret = self.call_method(bus, "methodname", "busname",
1297
"objectpath", "interface")
1298
self.assertFalse(ret)
1299
self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1300
1301
def test_call_method_filters_objectpath(self):
1302
def func():
1303
return method_return
1304
mock_dbus_python = self.MockDBusPython_func(func)
1305
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1306
method_return = mock_dbus_python.ObjectPath("objectpath")
1307
ret = self.call_method(bus, "methodname", "busname",
1308
"objectpath", "interface")
1309
self.assertEqual("objectpath", ret)
1310
self.assertIsNot("objectpath", ret)
1311
self.assertNotIsInstance(ret, mock_dbus_python.ObjectPath)
1312
1313
def test_call_method_filters_booleans_in_dict(self):
1314
def func():
1315
return method_return
1316
mock_dbus_python = self.MockDBusPython_func(func)
1317
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1318
method_return = mock_dbus_python.Dictionary(
1319
{mock_dbus_python.Boolean(True):
1320
mock_dbus_python.Boolean(False),
1321
mock_dbus_python.Boolean(False):
1322
mock_dbus_python.Boolean(True)})
1323
ret = self.call_method(bus, "methodname", "busname",
1324
"objectpath", "interface")
1325
expected_method_return = {True: False,
1326
False: True}
1327
self.assertEqual(expected_method_return, ret)
1328
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1329
1330
def test_call_method_filters_objectpaths_in_dict(self):
1331
def func():
1332
return method_return
1333
mock_dbus_python = self.MockDBusPython_func(func)
1334
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1335
method_return = mock_dbus_python.Dictionary(
1336
{mock_dbus_python.ObjectPath("objectpath_key_1"):
1337
mock_dbus_python.ObjectPath("objectpath_value_1"),
1338
mock_dbus_python.ObjectPath("objectpath_key_2"):
1339
mock_dbus_python.ObjectPath("objectpath_value_2")})
1340
ret = self.call_method(bus, "methodname", "busname",
1341
"objectpath", "interface")
1342
expected_method_return = {str(key): str(value)
1343
for key, value in
1344
method_return.items()}
1345
self.assertEqual(expected_method_return, ret)
1346
self.assertIsInstance(ret, dict)
1347
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1348
1349
def test_call_method_filters_dict_in_dict(self):
1350
def func():
1351
return method_return
1352
mock_dbus_python = self.MockDBusPython_func(func)
1353
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1354
method_return = mock_dbus_python.Dictionary(
1355
{"key1": mock_dbus_python.Dictionary({"key11": "value11",
1356
"key12": "value12"}),
1357
"key2": mock_dbus_python.Dictionary({"key21": "value21",
1358
"key22": "value22"})})
1359
ret = self.call_method(bus, "methodname", "busname",
1360
"objectpath", "interface")
1361
expected_method_return = {
1362
"key1": {"key11": "value11",
1363
"key12": "value12"},
1364
"key2": {"key21": "value21",
1365
"key22": "value22"},
1366
}
1367
self.assertEqual(expected_method_return, ret)
1368
self.assertIsInstance(ret, dict)
1369
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1370
for key, value in ret.items():
1371
self.assertIsInstance(value, dict)
1372
self.assertEqual(expected_method_return[key], value)
1373
self.assertNotIsInstance(value,
1374
mock_dbus_python.Dictionary)
1375
1376
def test_call_method_filters_dict_three_deep(self):
1377
def func():
1378
return method_return
1379
mock_dbus_python = self.MockDBusPython_func(func)
1380
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1381
method_return = mock_dbus_python.Dictionary(
1382
{"key1":
1383
mock_dbus_python.Dictionary(
1384
{"key2":
1385
mock_dbus_python.Dictionary(
1386
{"key3":
1387
mock_dbus_python.Boolean(True),
1388
}),
1389
}),
1390
})
1391
ret = self.call_method(bus, "methodname", "busname",
1392
"objectpath", "interface")
1393
expected_method_return = {"key1": {"key2": {"key3": True}}}
1394
self.assertEqual(expected_method_return, ret)
1395
self.assertIsInstance(ret, dict)
1396
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1397
self.assertIsInstance(ret["key1"], dict)
1398
self.assertNotIsInstance(ret["key1"],
1399
mock_dbus_python.Dictionary)
1400
self.assertIsInstance(ret["key1"]["key2"], dict)
1401
self.assertNotIsInstance(ret["key1"]["key2"],
1402
mock_dbus_python.Dictionary)
1403
self.assertTrue(ret["key1"]["key2"]["key3"])
1404
self.assertNotIsInstance(ret["key1"]["key2"]["key3"],
1405
mock_dbus_python.Boolean)
1406
1407
def test_call_method_handles_exception(self):
1118
1408
dbus_logger = logging.getLogger("dbus.proxies")
1119
1409
1120
class ObjectManagerFailingStub(object):
1121
def GetManagedObjects(self):
1122
dbus_logger.error("Test")
1123
raise dbus.exceptions.DBusException("Test")
1410
def func():
1411
dbus_logger.error("Test")
1412
raise mock_dbus_python.exceptions.DBusException()
1413
1414
mock_dbus_python = self.MockDBusPython_func(func)
1415
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1124
1416
1125
1417
class CountingHandler(logging.Handler):
1126
1418
count = 0
1132
1424
dbus_logger.addHandler(counting_handler)
1133
1425
1134
1426
try:
1135
with self.assertLogs(log, logging.CRITICAL) as watcher:
1136
with self.assertRaises(SystemExit) as e:
1137
get_managed_objects(ObjectManagerFailingStub())
1427
with self.assertRaises(dbus.Error) as e:
1428
self.call_method(bus, "methodname", "busname",
1429
"objectpath", "interface")
1138
1430
finally:
1139
1431
dbus_logger.removeFilter(counting_handler)
1140
1432
1433
self.assertNotIsInstance(e, dbus.ConnectFailed)
1434
1141
1435
# Make sure the dbus logger was suppressed
1142
1436
self.assertEqual(0, counting_handler.count)
1143
1437
1144
# Test that the dbus_logger still works
1145
with self.assertLogs(dbus_logger, logging.ERROR):
1146
dbus_logger.error("Test")
1147
1148
if isinstance(e.exception.code, int):
1149
self.assertNotEqual(0, e.exception.code)
1150
else:
1151
self.assertIsNotNone(e.exception.code)
1438
def test_get_object_converts_to_correct_exception(self):
1439
bus = dbus_python_adapter.SystemBus(
1440
self.fake_dbus_python_raises_exception_on_connect)
1441
with self.assertRaises(dbus.ConnectFailed):
1442
self.call_method(bus, "methodname", "busname",
1443
"objectpath", "interface")
1444
1445
class fake_dbus_python_raises_exception_on_connect(object):
1446
"""fake dbus-python module"""
1447
class exceptions(object):
1448
"""Pseudo-namespace"""
1449
class DBusException(Exception):
1450
pass
1451
1452
@classmethod
1453
def SystemBus(cls):
1454
def get_object(busname, objectpath):
1455
raise cls.exceptions.DBusException()
1456
Bus = collections.namedtuple("Bus", ["get_object"])
1457
return Bus(get_object=get_object)
1458
1459
1460
class Test_dbus_python_adapter_CachingBus(unittest.TestCase):
1461
class mock_dbus_python(object):
1462
"""mock dbus-python modules"""
1463
class SystemBus(object):
1464
@staticmethod
1465
def get_object(busname, objectpath):
1466
return Unique()
1467
1468
def setUp(self):
1469
self.bus = dbus_python_adapter.CachingBus(
1470
self.mock_dbus_python)
1471
1472
def test_returns_distinct_objectpaths(self):
1473
obj1 = self.bus.get_object("busname", "objectpath1")
1474
self.assertIsInstance(obj1, Unique)
1475
obj2 = self.bus.get_object("busname", "objectpath2")
1476
self.assertIsInstance(obj2, Unique)
1477
self.assertIsNot(obj1, obj2)
1478
1479
def test_returns_distinct_busnames(self):
1480
obj1 = self.bus.get_object("busname1", "objectpath")
1481
self.assertIsInstance(obj1, Unique)
1482
obj2 = self.bus.get_object("busname2", "objectpath")
1483
self.assertIsInstance(obj2, Unique)
1484
self.assertIsNot(obj1, obj2)
1485
1486
def test_returns_distinct_both(self):
1487
obj1 = self.bus.get_object("busname1", "objectpath")
1488
self.assertIsInstance(obj1, Unique)
1489
obj2 = self.bus.get_object("busname2", "objectpath")
1490
self.assertIsInstance(obj2, Unique)
1491
self.assertIsNot(obj1, obj2)
1492
1493
def test_returns_same(self):
1494
obj1 = self.bus.get_object("busname", "objectpath")
1495
self.assertIsInstance(obj1, Unique)
1496
obj2 = self.bus.get_object("busname", "objectpath")
1497
self.assertIsInstance(obj2, Unique)
1498
self.assertIs(obj1, obj2)
1499
1500
def test_returns_same_old(self):
1501
obj1 = self.bus.get_object("busname1", "objectpath1")
1502
self.assertIsInstance(obj1, Unique)
1503
obj2 = self.bus.get_object("busname2", "objectpath2")
1504
self.assertIsInstance(obj2, Unique)
1505
obj1b = self.bus.get_object("busname1", "objectpath1")
1506
self.assertIsInstance(obj1b, Unique)
1507
self.assertIsNot(obj1, obj2)
1508
self.assertIsNot(obj2, obj1b)
1509
self.assertIs(obj1, obj1b)
1152
1510
1153
1511
1154
1512
class Test_commands_from_options(unittest.TestCase):
1513
1155
1514
def setUp(self):
1156
1515
self.parser = argparse.ArgumentParser()
1157
1516
add_command_line_options(self.parser)
1372
1731
class TestCommand(unittest.TestCase):
1373
1732
"""Abstract class for tests of command classes"""
1374
1733
1734
class FakeMandosBus(dbus.MandosBus):
1735
def __init__(self, testcase):
1736
self.client_properties = {
1737
"Name": "foo",
1738
"KeyID": ("92ed150794387c03ce684574b1139a65"
1739
"94a34f895daaaf09fd8ea90a27cddb12"),
1740
"Secret": b"secret",
1741
"Host": "foo.example.org",
1742
"Enabled": True,
1743
"Timeout": 300000,
1744
"LastCheckedOK": "2019-02-03T00:00:00",
1745
"Created": "2019-01-02T00:00:00",
1746
"Interval": 120000,
1747
"Fingerprint": ("778827225BA7DE539C5A"
1748
"7CFA59CFF7CDBD9A5920"),
1749
"CheckerRunning": False,
1750
"LastEnabled": "2019-01-03T00:00:00",
1751
"ApprovalPending": False,
1752
"ApprovedByDefault": True,
1753
"LastApprovalRequest": "",
1754
"ApprovalDelay": 0,
1755
"ApprovalDuration": 1000,
1756
"Checker": "fping -q -- %(host)s",
1757
"ExtendedTimeout": 900000,
1758
"Expires": "2019-02-04T00:00:00",
1759
"LastCheckerStatus": 0,
1760
}
1761
self.other_client_properties = {
1762
"Name": "barbar",
1763
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
1764
"6ab612cff5ad227247e46c2b020f441c"),
1765
"Secret": b"secretbar",
1766
"Host": "192.0.2.3",
1767
"Enabled": True,
1768
"Timeout": 300000,
1769
"LastCheckedOK": "2019-02-04T00:00:00",
1770
"Created": "2019-01-03T00:00:00",
1771
"Interval": 120000,
1772
"Fingerprint": ("3E393AEAEFB84C7E89E2"
1773
"F547B3A107558FCA3A27"),
1774
"CheckerRunning": True,
1775
"LastEnabled": "2019-01-04T00:00:00",
1776
"ApprovalPending": False,
1777
"ApprovedByDefault": False,
1778
"LastApprovalRequest": "2019-01-03T00:00:00",
1779
"ApprovalDelay": 30000,
1780
"ApprovalDuration": 93785000,
1781
"Checker": ":",
1782
"ExtendedTimeout": 900000,
1783
"Expires": "2019-02-05T00:00:00",
1784
"LastCheckerStatus": -2,
1785
}
1786
self.clients = collections.OrderedDict(
1787
[
1788
("client_objectpath", self.client_properties),
1789
("other_client_objectpath",
1790
self.other_client_properties),
1791
])
1792
self.one_client = {"client_objectpath":
1793
self.client_properties}
1794
self.testcase = testcase
1795
self.calls = []
1796
1797
def call_method(self, methodname, busname, objectpath,
1798
interface, *args):
1799
self.testcase.assertEqual("se.recompile.Mandos", busname)
1800
self.calls.append((methodname, busname, objectpath,
1801
interface, args))
1802
if interface == "org.freedesktop.DBus.Properties":
1803
if methodname == "Set":
1804
self.testcase.assertEqual(3, len(args))
1805
interface, key, value = args
1806
self.testcase.assertEqual(
1807
"se.recompile.Mandos.Client", interface)
1808
self.clients[objectpath][key] = value
1809
return
1810
elif interface == "se.recompile.Mandos":
1811
self.testcase.assertEqual("RemoveClient", methodname)
1812
self.testcase.assertEqual(1, len(args))
1813
clientpath = args[0]
1814
del self.clients[clientpath]
1815
return
1816
elif interface == "se.recompile.Mandos.Client":
1817
if methodname == "Approve":
1818
self.testcase.assertEqual(1, len(args))
1819
return
1820
raise ValueError()
1821
1375
1822
def setUp(self):
1376
testcase = self
1377
class MockClient(object):
1378
def __init__(self, name, **attributes):
1379
self.__dbus_object_path__ = "/clients/{}".format(name)
1380
self.attributes = attributes
1381
self.attributes["Name"] = name
1382
self.calls = []
1383
def Set(self, interface, propname, value, dbus_interface):
1384
testcase.assertEqual(client_dbus_interface, interface)
1385
testcase.assertEqual(dbus.PROPERTIES_IFACE,
1386
dbus_interface)
1387
self.attributes[propname] = value
1388
def Approve(self, approve, dbus_interface):
1389
testcase.assertEqual(client_dbus_interface,
1390
dbus_interface)
1391
self.calls.append(("Approve", (approve,
1392
dbus_interface)))
1393
self.client = MockClient(
1394
"foo",
1395
KeyID=("92ed150794387c03ce684574b1139a65"
1396
"94a34f895daaaf09fd8ea90a27cddb12"),
1397
Secret=b"secret",
1398
Host="foo.example.org",
1399
Enabled=dbus.Boolean(True),
1400
Timeout=300000,
1401
LastCheckedOK="2019-02-03T00:00:00",
1402
Created="2019-01-02T00:00:00",
1403
Interval=120000,
1404
Fingerprint=("778827225BA7DE539C5A"
1405
"7CFA59CFF7CDBD9A5920"),
1406
CheckerRunning=dbus.Boolean(False),
1407
LastEnabled="2019-01-03T00:00:00",
1408
ApprovalPending=dbus.Boolean(False),
1409
ApprovedByDefault=dbus.Boolean(True),
1410
LastApprovalRequest="",
1411
ApprovalDelay=0,
1412
ApprovalDuration=1000,
1413
Checker="fping -q -- %(host)s",
1414
ExtendedTimeout=900000,
1415
Expires="2019-02-04T00:00:00",
1416
LastCheckerStatus=0)
1417
self.other_client = MockClient(
1418
"barbar",
1419
KeyID=("0558568eedd67d622f5c83b35a115f79"
1420
"6ab612cff5ad227247e46c2b020f441c"),
1421
Secret=b"secretbar",
1422
Host="192.0.2.3",
1423
Enabled=dbus.Boolean(True),
1424
Timeout=300000,
1425
LastCheckedOK="2019-02-04T00:00:00",
1426
Created="2019-01-03T00:00:00",
1427
Interval=120000,
1428
Fingerprint=("3E393AEAEFB84C7E89E2"
1429
"F547B3A107558FCA3A27"),
1430
CheckerRunning=dbus.Boolean(True),
1431
LastEnabled="2019-01-04T00:00:00",
1432
ApprovalPending=dbus.Boolean(False),
1433
ApprovedByDefault=dbus.Boolean(False),
1434
LastApprovalRequest="2019-01-03T00:00:00",
1435
ApprovalDelay=30000,
1436
ApprovalDuration=93785000,
1437
Checker=":",
1438
ExtendedTimeout=900000,
1439
Expires="2019-02-05T00:00:00",
1440
LastCheckerStatus=-2)
1441
self.clients = collections.OrderedDict(
1442
[
1443
(self.client.__dbus_object_path__,
1444
self.client.attributes),
1445
(self.other_client.__dbus_object_path__,
1446
self.other_client.attributes),
1447
])
1448
self.one_client = {self.client.__dbus_object_path__:
1449
self.client.attributes}
1450
1451
@property
1452
def bus(self):
1453
class MockBus(object):
1454
@staticmethod
1455
def get_object(client_bus_name, path):
1456
self.assertEqual(dbus_busname, client_bus_name)
1457
# Note: "self" here is the TestCmd instance, not the
1458
# MockBus instance, since this is a static method!
1459
if path == self.client.__dbus_object_path__:
1460
return self.client
1461
elif path == self.other_client.__dbus_object_path__:
1462
return self.other_client
1463
return MockBus()
1823
self.bus = self.FakeMandosBus(self)
1464
1824
1465
1825
1466
1826
class TestBaseCommands(TestCommand):
1467
1827
1468
1828
def test_IsEnabled_exits_successfully(self):
1469
1829
with self.assertRaises(SystemExit) as e:
1470
command.IsEnabled().run(self.one_client)
1830
command.IsEnabled().run(self.bus.one_client)
1471
1831
if e.exception.code is not None:
1472
1832
self.assertEqual(0, e.exception.code)
1473
1833
else:
1474
1834
self.assertIsNone(e.exception.code)
1475
1835
1476
1836
def test_IsEnabled_exits_with_failure(self):
1477
self.client.attributes["Enabled"] = dbus.Boolean(False)
1837
self.bus.client_properties["Enabled"] = False
1478
1838
with self.assertRaises(SystemExit) as e:
1479
command.IsEnabled().run(self.one_client)
1839
command.IsEnabled().run(self.bus.one_client)
1480
1840
if isinstance(e.exception.code, int):
1481
1841
self.assertNotEqual(0, e.exception.code)
1482
1842
else:
1483
1843
self.assertIsNotNone(e.exception.code)
1484
1844
1485
1845
def test_Approve(self):
1486
command.Approve().run(self.clients, self.bus)
1487
for clientpath in self.clients:
1488
client = self.bus.get_object(dbus_busname, clientpath)
1489
self.assertIn(("Approve", (True, client_dbus_interface)),
1490
client.calls)
1846
busname = "se.recompile.Mandos"
1847
client_interface = "se.recompile.Mandos.Client"
1848
command.Approve().run(self.bus.clients, self.bus)
1849
for clientpath in self.bus.clients:
1850
self.assertIn(("Approve", busname, clientpath,
1851
client_interface, (True,)), self.bus.calls)
1491
1852
1492
1853
def test_Deny(self):
1493
command.Deny().run(self.clients, self.bus)
1494
for clientpath in self.clients:
1495
client = self.bus.get_object(dbus_busname, clientpath)
1496
self.assertIn(("Approve", (False, client_dbus_interface)),
1497
client.calls)
1854
busname = "se.recompile.Mandos"
1855
client_interface = "se.recompile.Mandos.Client"
1856
command.Deny().run(self.bus.clients, self.bus)
1857
for clientpath in self.bus.clients:
1858
self.assertIn(("Approve", busname, clientpath,
1859
client_interface, (False,)),
1860
self.bus.calls)
1498
1861
1499
1862
def test_Remove(self):
1500
class MandosSpy(object):
1501
def __init__(self):
1502
self.calls = []
1503
def RemoveClient(self, dbus_path):
1504
self.calls.append(("RemoveClient", (dbus_path,)))
1505
mandos = MandosSpy()
1506
command.Remove().run(self.clients, self.bus, mandos)
1507
for clientpath in self.clients:
1508
self.assertIn(("RemoveClient", (clientpath,)),
1509
mandos.calls)
1863
command.Remove().run(self.bus.clients, self.bus)
1864
for clientpath in self.bus.clients:
1865
self.assertIn(("RemoveClient", dbus_busname,
1866
dbus_server_path, dbus_server_interface,
1867
(clientpath,)), self.bus.calls)
1510
1868
1511
1869
expected_json = {
1512
1870
"foo": {
1561
1919
1562
1920
def test_DumpJSON_normal(self):
1563
1921
with self.capture_stdout_to_buffer() as buffer:
1564
command.DumpJSON().run(self.clients)
1922
command.DumpJSON().run(self.bus.clients)
1565
1923
json_data = json.loads(buffer.getvalue())
1566
1924
self.assertDictEqual(self.expected_json, json_data)
1567
1925
1578
1936
1579
1937
def test_DumpJSON_one_client(self):
1580
1938
with self.capture_stdout_to_buffer() as buffer:
1581
command.DumpJSON().run(self.one_client)
1939
command.DumpJSON().run(self.bus.one_client)
1582
1940
json_data = json.loads(buffer.getvalue())
1583
1941
expected_json = {"foo": self.expected_json["foo"]}
1584
1942
self.assertDictEqual(expected_json, json_data)
1585
1943
1586
1944
def test_PrintTable_normal(self):
1587
1945
with self.capture_stdout_to_buffer() as buffer:
1588
command.PrintTable().run(self.clients)
1946
command.PrintTable().run(self.bus.clients)
1589
1947
expected_output = "\n".join((
1590
1948
"Name Enabled Timeout Last Successful Check",
1591
1949
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1595
1953
1596
1954
def test_PrintTable_verbose(self):
1597
1955
with self.capture_stdout_to_buffer() as buffer:
1598
command.PrintTable(verbose=True).run(self.clients)
1956
command.PrintTable(verbose=True).run(self.bus.clients)
1599
1957
columns = (
1600
1958
(
1601
1959
"Name ",
1691
2049
1692
2050
def test_PrintTable_one_client(self):
1693
2051
with self.capture_stdout_to_buffer() as buffer:
1694
command.PrintTable().run(self.one_client)
2052
command.PrintTable().run(self.bus.one_client)
1695
2053
expected_output = "\n".join((
1696
2054
"Name Enabled Timeout Last Successful Check",
1697
2055
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1699
2057
self.assertEqual(expected_output, buffer.getvalue())
1700
2058
1701
2059
1702
class TestPropertyCmd(TestCommand):
1703
"""Abstract class for tests of command.Property classes"""
2060
class TestPropertySetterCmd(TestCommand):
2061
"""Abstract class for tests of command.PropertySetter classes"""
2062
1704
2063
def runTest(self):
1705
2064
if not hasattr(self, "command"):
1706
return
1707
values_to_get = getattr(self, "values_to_get",
1708
self.values_to_set)
1709
for value_to_set, value_to_get in zip(self.values_to_set,
1710
values_to_get):
1711
for clientpath in self.clients:
1712
client = self.bus.get_object(dbus_busname, clientpath)
1713
old_value = client.attributes[self.propname]
1714
client.attributes[self.propname] = self.Unique()
1715
self.run_command(value_to_set, self.clients)
1716
for clientpath in self.clients:
1717
client = self.bus.get_object(dbus_busname, clientpath)
1718
value = client.attributes[self.propname]
1719
self.assertNotIsInstance(value, self.Unique)
2065
return # Abstract TestCase class
2066
2067
if hasattr(self, "values_to_set"):
2068
cmd_args = [(value,) for value in self.values_to_set]
2069
values_to_get = getattr(self, "values_to_get",
2070
self.values_to_set)
2071
else:
2072
cmd_args = [() for x in range(len(self.values_to_get))]
2073
values_to_get = self.values_to_get
2074
for value_to_get, cmd_arg in zip(values_to_get, cmd_args):
2075
for clientpath in self.bus.clients:
2076
self.bus.clients[clientpath][self.propname] = (
2077
Unique())
2078
self.command(*cmd_arg).run(self.bus.clients, self.bus)
2079
for clientpath in self.bus.clients:
2080
value = (self.bus.clients[clientpath]
2081
[self.propname])
2082
self.assertNotIsInstance(value, Unique)
1720
2083
self.assertEqual(value_to_get, value)
1721
2084
1722
class Unique(object):
1723
"""Class for objects which exist only to be unique objects,
1724
since unittest.mock.sentinel only exists in Python 3.3"""
1725
1726
def run_command(self, value, clients):
1727
self.command().run(clients, self.bus)
1728
1729
1730
class TestEnableCmd(TestPropertyCmd):
2085
2086
class TestEnableCmd(TestPropertySetterCmd):
1731
2087
command = command.Enable
1732
2088
propname = "Enabled"
1733
values_to_set = [dbus.Boolean(True)]
1734
1735
1736
class TestDisableCmd(TestPropertyCmd):
2089
values_to_get = [True]
2090
2091
2092
class TestDisableCmd(TestPropertySetterCmd):
1737
2093
command = command.Disable
1738
2094
propname = "Enabled"
1739
values_to_set = [dbus.Boolean(False)]
1740
1741
1742
class TestBumpTimeoutCmd(TestPropertyCmd):
2095
values_to_get = [False]
2096
2097
2098
class TestBumpTimeoutCmd(TestPropertySetterCmd):
1743
2099
command = command.BumpTimeout
1744
2100
propname = "LastCheckedOK"
1745
values_to_set = [""]
1746
1747
1748
class TestStartCheckerCmd(TestPropertyCmd):
2101
values_to_get = [""]
2102
2103
2104
class TestStartCheckerCmd(TestPropertySetterCmd):
1749
2105
command = command.StartChecker
1750
2106
propname = "CheckerRunning"
1751
values_to_set = [dbus.Boolean(True)]
1752
1753
1754
class TestStopCheckerCmd(TestPropertyCmd):
2107
values_to_get = [True]
2108
2109
2110
class TestStopCheckerCmd(TestPropertySetterCmd):
1755
2111
command = command.StopChecker
1756
2112
propname = "CheckerRunning"
1757
values_to_set = [dbus.Boolean(False)]
1758
1759
1760
class TestApproveByDefaultCmd(TestPropertyCmd):
2113
values_to_get = [False]
2114
2115
2116
class TestApproveByDefaultCmd(TestPropertySetterCmd):
1761
2117
command = command.ApproveByDefault
1762
2118
propname = "ApprovedByDefault"
1763
values_to_set = [dbus.Boolean(True)]
1764
1765
1766
class TestDenyByDefaultCmd(TestPropertyCmd):
2119
values_to_get = [True]
2120
2121
2122
class TestDenyByDefaultCmd(TestPropertySetterCmd):
1767
2123
command = command.DenyByDefault
1768
2124
propname = "ApprovedByDefault"
1769
values_to_set = [dbus.Boolean(False)]
1770
1771
1772
class TestPropertyValueCmd(TestPropertyCmd):
1773
"""Abstract class for tests of PropertyValueCmd classes"""
1774
1775
def runTest(self):
1776
if type(self) is TestPropertyValueCmd:
1777
return
1778
return super(TestPropertyValueCmd, self).runTest()
1779
1780
def run_command(self, value, clients):
1781
self.command(value).run(clients, self.bus)
1782
1783
1784
class TestSetCheckerCmd(TestPropertyValueCmd):
2125
values_to_get = [False]
2126
2127
2128
class TestSetCheckerCmd(TestPropertySetterCmd):
1785
2129
command = command.SetChecker
1786
2130
propname = "Checker"
1787
2131
values_to_set = ["", ":", "fping -q -- %s"]
1788
2132
1789
2133
1790
class TestSetHostCmd(TestPropertyValueCmd):
2134
class TestSetHostCmd(TestPropertySetterCmd):
1791
2135
command = command.SetHost
1792
2136
propname = "Host"
1793
2137
values_to_set = ["192.0.2.3", "client.example.org"]
1794
2138
1795
2139
1796
class TestSetSecretCmd(TestPropertyValueCmd):
2140
class TestSetSecretCmd(TestPropertySetterCmd):
1797
2141
command = command.SetSecret
1798
2142
propname = "Secret"
1799
2143
values_to_set = [io.BytesIO(b""),
1801
2145
values_to_get = [f.getvalue() for f in values_to_set]
1802
2146
1803
2147
1804
class TestSetTimeoutCmd(TestPropertyValueCmd):
2148
class TestSetTimeoutCmd(TestPropertySetterCmd):
1805
2149
command = command.SetTimeout
1806
2150
propname = "Timeout"
1807
2151
values_to_set = [datetime.timedelta(),
1812
2156
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1813
2157
1814
2158
1815
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
2159
class TestSetExtendedTimeoutCmd(TestPropertySetterCmd):
1816
2160
command = command.SetExtendedTimeout
1817
2161
propname = "ExtendedTimeout"
1818
2162
values_to_set = [datetime.timedelta(),
1823
2167
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1824
2168
1825
2169
1826
class TestSetIntervalCmd(TestPropertyValueCmd):
2170
class TestSetIntervalCmd(TestPropertySetterCmd):
1827
2171
command = command.SetInterval
1828
2172
propname = "Interval"
1829
2173
values_to_set = [datetime.timedelta(),
1834
2178
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1835
2179
1836
2180
1837
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
2181
class TestSetApprovalDelayCmd(TestPropertySetterCmd):
1838
2182
command = command.SetApprovalDelay
1839
2183
propname = "ApprovalDelay"
1840
2184
values_to_set = [datetime.timedelta(),
1845
2189
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1846
2190
1847
2191
1848
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
2192
class TestSetApprovalDurationCmd(TestPropertySetterCmd):
1849
2193
command = command.SetApprovalDuration
1850
2194
propname = "ApprovalDuration"
1851
2195
values_to_set = [datetime.timedelta(),
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0