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 1083
- compare with another revision
- download diff
- download tarball
- view history from revision 1083
- Committer: Teddy Hogeborn
- Date: 2019-03-17 18:17:02 UTC
- Revision ID: teddy@recompile.se-20190317181702-tf6uvnb0gnyw9z8v
mandos-ctl: Refactor tests
* mandos-ctl (Test_check_option_syntax.redirect_stderr_to_devnull):
Override file objects instead of raw file descriptors.
* mandos-ctl (Test_check_option_syntax.redirect_stderr_to_devnull):
Override file objects instead of raw file descriptors.
- files modified:
- intro.xml
added
removed
mandos-ctl
45
45
import io
46
46
import tempfile
47
47
import contextlib
48
import abc
49
48
50
import dbus as dbus_python
49
import dbus
51
50
52
51
# Show warnings by default
53
52
if not sys.warnoptions:
62
61
63
62
if sys.version_info.major == 2:
64
63
str = unicode
65
import StringIO
66
io.StringIO = StringIO.StringIO
67
64
68
65
locale.setlocale(locale.LC_ALL, "")
69
66
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
70
73
version = "1.8.3"
71
74
72
75
76
try:
77
dbus.OBJECT_MANAGER_IFACE
78
except AttributeError:
79
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
80
81
73
82
def main():
74
83
parser = argparse.ArgumentParser()
84
75
85
add_command_line_options(parser)
76
86
77
87
options = parser.parse_args()
88
78
89
check_option_syntax(parser, options)
79
90
80
91
clientnames = options.client
82
93
if options.debug:
83
94
log.setLevel(logging.DEBUG)
84
95
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)
96
bus = dbus.SystemBus()
97
98
mandos_dbus_object = get_mandos_dbus_object(bus)
99
100
mandos_serv = dbus.Interface(
101
mandos_dbus_object, dbus_interface=server_dbus_interface)
102
mandos_serv_object_manager = dbus.Interface(
103
mandos_dbus_object, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
104
105
managed_objects = get_managed_objects(mandos_serv_object_manager)
106
107
all_clients = {}
108
for path, ifs_and_props in managed_objects.items():
109
try:
110
all_clients[path] = ifs_and_props[client_dbus_interface]
111
except KeyError:
112
pass
96
113
97
114
# Compile dict of (clientpath: properties) to process
98
115
if not clientnames:
111
128
commands = commands_from_options(options)
112
129
113
130
for command in commands:
114
command.run(clients, bus)
131
command.run(clients, bus, mandos_serv)
115
132
116
133
117
134
def add_command_line_options(parser):
122
139
help="Select all clients")
123
140
parser.add_argument("-v", "--verbose", action="store_true",
124
141
help="Print all fields")
125
parser.add_argument("-j", "--dump-json", dest="commands",
126
action="append_const", default=[],
127
const=command.DumpJSON(),
142
parser.add_argument("-j", "--dump-json", action="store_true",
128
143
help="Dump client data in JSON format")
129
144
enable_disable = parser.add_mutually_exclusive_group()
130
enable_disable.add_argument("-e", "--enable", dest="commands",
131
action="append_const", default=[],
132
const=command.Enable(),
145
enable_disable.add_argument("-e", "--enable", action="store_true",
133
146
help="Enable client")
134
enable_disable.add_argument("-d", "--disable", dest="commands",
135
action="append_const", default=[],
136
const=command.Disable(),
147
enable_disable.add_argument("-d", "--disable",
148
action="store_true",
137
149
help="disable client")
138
parser.add_argument("-b", "--bump-timeout", dest="commands",
139
action="append_const", default=[],
140
const=command.BumpTimeout(),
150
parser.add_argument("-b", "--bump-timeout", action="store_true",
141
151
help="Bump timeout for client")
142
152
start_stop_checker = parser.add_mutually_exclusive_group()
143
153
start_stop_checker.add_argument("--start-checker",
144
dest="commands",
145
action="append_const", default=[],
146
const=command.StartChecker(),
154
action="store_true",
147
155
help="Start checker for client")
148
start_stop_checker.add_argument("--stop-checker", dest="commands",
149
action="append_const", default=[],
150
const=command.StopChecker(),
156
start_stop_checker.add_argument("--stop-checker",
157
action="store_true",
151
158
help="Stop checker for client")
152
parser.add_argument("-V", "--is-enabled", dest="commands",
153
action="append_const", default=[],
154
const=command.IsEnabled(),
159
parser.add_argument("-V", "--is-enabled", action="store_true",
155
160
help="Check if client is enabled")
156
parser.add_argument("-r", "--remove", dest="commands",
157
action="append_const", default=[],
158
const=command.Remove(),
161
parser.add_argument("-r", "--remove", action="store_true",
159
162
help="Remove client")
160
parser.add_argument("-c", "--checker", dest="commands",
161
action="append", default=[],
162
metavar="COMMAND", type=command.SetChecker,
163
parser.add_argument("-c", "--checker",
163
164
help="Set checker command 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")
165
parser.add_argument("-t", "--timeout", type=string_to_delta,
166
help="Set timeout for client")
167
parser.add_argument("--extended-timeout", type=string_to_delta,
168
help="Set extended timeout for client")
169
parser.add_argument("-i", "--interval", type=string_to_delta,
170
help="Set checker interval for client")
179
171
approve_deny_default = parser.add_mutually_exclusive_group()
180
172
approve_deny_default.add_argument(
181
"--approve-by-default", dest="commands",
182
action="append_const", default=[],
183
const=command.ApproveByDefault(),
173
"--approve-by-default", action="store_true",
174
default=None, dest="approved_by_default",
184
175
help="Set client to be approved by default")
185
176
approve_deny_default.add_argument(
186
"--deny-by-default", dest="commands",
187
action="append_const", default=[],
188
const=command.DenyByDefault(),
177
"--deny-by-default", action="store_false",
178
dest="approved_by_default",
189
179
help="Set client to be denied by default")
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")
180
parser.add_argument("--approval-delay", type=string_to_delta,
181
help="Set delay before client approve/deny")
182
parser.add_argument("--approval-duration", type=string_to_delta,
183
help="Set duration of one client approval")
184
parser.add_argument("-H", "--host", help="Set host for client")
185
parser.add_argument("-s", "--secret",
186
type=argparse.FileType(mode="rb"),
187
help="Set password blob (file) for client")
209
188
approve_deny = parser.add_mutually_exclusive_group()
210
189
approve_deny.add_argument(
211
"-A", "--approve", dest="commands", action="append_const",
212
default=[], const=command.Approve(),
190
"-A", "--approve", action="store_true",
213
191
help="Approve any current client request")
214
approve_deny.add_argument("-D", "--deny", dest="commands",
215
action="append_const", default=[],
216
const=command.Deny(),
192
approve_deny.add_argument("-D", "--deny", action="store_true",
217
193
help="Deny any current client request")
218
194
parser.add_argument("--debug", action="store_true",
219
195
help="Debug mode (show D-Bus commands)")
410
386
"""Apply additional restrictions on options, not expressible in
411
387
argparse"""
412
388
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)
389
def has_actions(options):
390
return any((options.enable,
391
options.disable,
392
options.bump_timeout,
393
options.start_checker,
394
options.stop_checker,
395
options.is_enabled,
396
options.remove,
397
options.checker is not None,
398
options.timeout is not None,
399
options.extended_timeout is not None,
400
options.interval is not None,
401
options.approved_by_default is not None,
402
options.approval_delay is not None,
403
options.approval_duration is not None,
404
options.host is not None,
405
options.secret is not None,
406
options.approve,
407
options.deny))
436
408
437
if has_commands(options) and not (options.client or options.all):
409
if has_actions(options) and not (options.client or options.all):
438
410
parser.error("Options require clients names or --all.")
439
if options.verbose and has_commands(options):
411
if options.verbose and has_actions(options):
440
412
parser.error("--verbose can only be used alone.")
441
if (has_commands(options, (command.DumpJSON,))
442
and (options.verbose or len(options.commands) > 1)):
413
if options.dump_json and (options.verbose
414
or has_actions(options)):
443
415
parser.error("--dump-json can only be used alone.")
444
if options.all and not has_commands(options):
416
if options.all and not has_actions(options):
445
417
parser.error("--all requires an action.")
446
if (has_commands(options, (command.IsEnabled,))
447
and len(options.client) > 1):
418
if options.is_enabled and len(options.client) > 1:
448
419
parser.error("--is-enabled requires exactly one client")
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
420
if options.remove:
421
options.remove = False
422
if has_actions(options) and not options.deny:
423
parser.error("--remove can only be combined with --deny")
424
options.remove = True
425
426
427
def get_mandos_dbus_object(bus):
428
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
429
dbus_busname, server_dbus_path)
430
with if_dbus_exception_log_with_exception_and_exit(
431
"Could not connect to Mandos server: %s"):
432
mandos_dbus_object = bus.get_object(dbus_busname,
433
server_dbus_path)
434
return mandos_dbus_object
435
436
437
@contextlib.contextmanager
438
def if_dbus_exception_log_with_exception_and_exit(*args, **kwargs):
439
try:
440
yield
441
except dbus.exceptions.DBusException as e:
442
log.critical(*(args + (e,)), **kwargs)
443
sys.exit(1)
444
445
446
def get_managed_objects(object_manager):
447
log.debug("D-Bus: %s:%s:%s.GetManagedObjects()", dbus_busname,
448
server_dbus_path, dbus.OBJECT_MANAGER_IFACE)
449
with if_dbus_exception_log_with_exception_and_exit(
450
"Failed to access Mandos server through D-Bus:\n%s"):
451
with SilenceLogger("dbus.proxies"):
452
managed_objects = object_manager.GetManagedObjects()
453
return managed_objects
454
455
456
class SilenceLogger(object):
457
"Simple context manager to silence a particular logger"
458
def __init__(self, loggername):
459
self.logger = logging.getLogger(loggername)
460
461
def __enter__(self):
462
self.logger.addFilter(self.nullfilter)
463
return self
464
465
class NullFilter(logging.Filter):
466
def filter(self, record):
467
return False
468
469
nullfilter = NullFilter()
470
471
def __exit__(self, exc_type, exc_val, exc_tb):
472
self.logger.removeFilter(self.nullfilter)
594
473
595
474
596
475
def commands_from_options(options):
597
476
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)
477
commands = []
478
479
if options.is_enabled:
480
commands.append(command.IsEnabled())
481
482
if options.approve:
483
commands.append(command.Approve())
484
485
if options.deny:
486
commands.append(command.Deny())
487
488
if options.remove:
489
commands.append(command.Remove())
490
491
if options.dump_json:
492
commands.append(command.DumpJSON())
493
494
if options.enable:
495
commands.append(command.Enable())
496
497
if options.disable:
498
commands.append(command.Disable())
499
500
if options.bump_timeout:
501
commands.append(command.BumpTimeout())
502
503
if options.start_checker:
504
commands.append(command.StartChecker())
505
506
if options.stop_checker:
507
commands.append(command.StopChecker())
508
509
if options.approved_by_default is not None:
510
if options.approved_by_default:
511
commands.append(command.ApproveByDefault())
616
512
else:
617
cleaned_after.append(cmd)
618
if cleaned_after != after_remove:
619
commands = before_remove + cleaned_after
513
commands.append(command.DenyByDefault())
514
515
if options.checker is not None:
516
commands.append(command.SetChecker(options.checker))
517
518
if options.host is not None:
519
commands.append(command.SetHost(options.host))
520
521
if options.secret is not None:
522
commands.append(command.SetSecret(options.secret))
523
524
if options.timeout is not None:
525
commands.append(command.SetTimeout(options.timeout))
526
527
if options.extended_timeout:
528
commands.append(
529
command.SetExtendedTimeout(options.extended_timeout))
530
531
if options.interval is not None:
532
commands.append(command.SetInterval(options.interval))
533
534
if options.approval_delay is not None:
535
commands.append(
536
command.SetApprovalDelay(options.approval_delay))
537
538
if options.approval_duration is not None:
539
commands.append(
540
command.SetApprovalDuration(options.approval_duration))
620
541
621
542
# If no command option has been given, show table of clients,
622
543
# optionally verbosely
631
552
632
553
class Base(object):
633
554
"""Abstract base class for commands"""
634
def run(self, clients, bus=None):
555
def run(self, clients, bus=None, mandos=None):
635
556
"""Normal commands should implement run_on_one_client(),
636
557
but commands which want to operate on all clients at the same time can
637
558
override this run() method instead.
638
559
"""
639
self.bus = bus
640
for client, properties in clients.items():
560
self.mandos = mandos
561
for clientpath, properties in clients.items():
562
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
563
dbus_busname, str(clientpath))
564
client = bus.get_object(dbus_busname, clientpath)
641
565
self.run_on_one_client(client, properties)
642
566
643
567
644
568
class IsEnabled(Base):
645
def run(self, clients, bus=None):
646
properties = next(iter(clients.values()))
647
if properties["Enabled"]:
569
def run(self, clients, bus=None, mandos=None):
570
client, properties = next(iter(clients.items()))
571
if self.is_enabled(client, properties):
648
572
sys.exit(0)
649
573
sys.exit(1)
574
def is_enabled(self, client, properties):
575
return properties["Enabled"]
650
576
651
577
652
578
class Approve(Base):
653
579
def run_on_one_client(self, client, properties):
654
self.bus.call_client_method(client, "Approve", True)
580
log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
581
client.__dbus_object_path__,
582
client_dbus_interface)
583
client.Approve(dbus.Boolean(True),
584
dbus_interface=client_dbus_interface)
655
585
656
586
657
587
class Deny(Base):
658
588
def run_on_one_client(self, client, properties):
659
self.bus.call_client_method(client, "Approve", False)
589
log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
590
client.__dbus_object_path__,
591
client_dbus_interface)
592
client.Approve(dbus.Boolean(False),
593
dbus_interface=client_dbus_interface)
660
594
661
595
662
596
class Remove(Base):
663
def run(self, clients, bus):
664
for clientpath in frozenset(clients.keys()):
665
bus.call_server_method("RemoveClient", clientpath)
597
def run_on_one_client(self, client, properties):
598
log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)",
599
dbus_busname, server_dbus_path,
600
server_dbus_interface,
601
str(client.__dbus_object_path__))
602
self.mandos.RemoveClient(client.__dbus_object_path__)
666
603
667
604
668
605
class Output(Base):
676
613
"Checker", "ExtendedTimeout", "Expires",
677
614
"LastCheckerStatus")
678
615
616
def run(self, clients, bus=None, mandos=None):
617
print(self.output(clients.values()))
618
619
def output(self, clients):
620
raise NotImplementedError()
621
679
622
680
623
class DumpJSON(Output):
681
def run(self, clients, bus=None):
682
data = {properties["Name"]:
683
{key: properties[key]
624
def output(self, clients):
625
data = {client["Name"]:
626
{key: self.dbus_boolean_to_bool(client[key])
684
627
for key in self.all_keywords}
685
for properties in clients.values()}
686
print(json.dumps(data, indent=4, separators=(',', ': ')))
628
for client in clients}
629
return json.dumps(data, indent=4, separators=(',', ': '))
630
631
@staticmethod
632
def dbus_boolean_to_bool(value):
633
if isinstance(value, dbus.Boolean):
634
value = bool(value)
635
return value
687
636
688
637
689
638
class PrintTable(Output):
690
639
def __init__(self, verbose=False):
691
640
self.verbose = verbose
692
641
693
def run(self, clients, bus=None):
642
def output(self, clients):
694
643
default_keywords = ("Name", "Enabled", "Timeout",
695
644
"LastCheckedOK")
696
645
keywords = default_keywords
697
646
if self.verbose:
698
647
keywords = self.all_keywords
699
print(self.TableOfClients(clients.values(), keywords))
648
return str(self.TableOfClients(clients, keywords))
700
649
701
650
class TableOfClients(object):
702
651
tableheaders = {
757
706
758
707
@classmethod
759
708
def valuetostring(cls, value, keyword):
760
if isinstance(value, bool):
709
if isinstance(value, dbus.Boolean):
761
710
return "Yes" if value else "No"
762
711
if keyword in ("Timeout", "Interval", "ApprovalDelay",
763
712
"ApprovalDuration", "ExtendedTimeout"):
783
732
seconds=td.seconds % 60))
784
733
785
734
786
class PropertySetter(Base):
735
class Property(Base):
787
736
"Abstract class for Actions for setting one client property"
788
737
789
def run_on_one_client(self, client, properties=None):
738
def run_on_one_client(self, client, properties):
790
739
"""Set the Client's D-Bus property"""
791
self.bus.set_client_property(client, self.propname,
792
self.value_to_set)
740
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
741
client.__dbus_object_path__,
742
dbus.PROPERTIES_IFACE, client_dbus_interface,
743
self.propname, self.value_to_set
744
if not isinstance(self.value_to_set,
745
dbus.Boolean)
746
else bool(self.value_to_set))
747
client.Set(client_dbus_interface, self.propname,
748
self.value_to_set,
749
dbus_interface=dbus.PROPERTIES_IFACE)
793
750
794
751
@property
795
752
def propname(self):
796
753
raise NotImplementedError()
797
754
798
755
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):
756
class Enable(Property):
757
propname = "Enabled"
758
value_to_set = dbus.Boolean(True)
759
760
761
class Disable(Property):
762
propname = "Enabled"
763
value_to_set = dbus.Boolean(False)
764
765
766
class BumpTimeout(Property):
810
767
propname = "LastCheckedOK"
811
768
value_to_set = ""
812
769
813
770
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."""
771
class StartChecker(Property):
772
propname = "CheckerRunning"
773
value_to_set = dbus.Boolean(True)
774
775
776
class StopChecker(Property):
777
propname = "CheckerRunning"
778
value_to_set = dbus.Boolean(False)
779
780
781
class ApproveByDefault(Property):
782
propname = "ApprovedByDefault"
783
value_to_set = dbus.Boolean(True)
784
785
786
class DenyByDefault(Property):
787
propname = "ApprovedByDefault"
788
value_to_set = dbus.Boolean(False)
789
790
791
class PropertyValue(Property):
792
"Abstract class for Property recieving a value as argument"
837
793
def __init__(self, value):
838
794
self.value_to_set = value
839
795
840
@classmethod
841
def argparse(cls, argtype):
842
def cmdtype(arg):
843
return cls(argtype(arg))
844
return cmdtype
845
796
846
class SetChecker(PropertySetterValue):
797
class SetChecker(PropertyValue):
847
798
propname = "Checker"
848
799
849
800
850
class SetHost(PropertySetterValue):
801
class SetHost(PropertyValue):
851
802
propname = "Host"
852
803
853
804
854
class SetSecret(PropertySetterValue):
805
class SetSecret(PropertyValue):
855
806
propname = "Secret"
856
807
857
808
@property
865
816
value.close()
866
817
867
818
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."""
819
class MillisecondsPropertyValueArgument(PropertyValue):
820
"""Abstract class for PropertyValue taking a value argument as
821
a datetime.timedelta() but should store it as milliseconds."""
872
822
873
823
@property
874
824
def value_to_set(self):
880
830
self._vts = int(round(value.total_seconds() * 1000))
881
831
882
832
883
class SetTimeout(PropertySetterValueMilliseconds):
833
class SetTimeout(MillisecondsPropertyValueArgument):
884
834
propname = "Timeout"
885
835
886
836
887
class SetExtendedTimeout(PropertySetterValueMilliseconds):
837
class SetExtendedTimeout(MillisecondsPropertyValueArgument):
888
838
propname = "ExtendedTimeout"
889
839
890
840
891
class SetInterval(PropertySetterValueMilliseconds):
841
class SetInterval(MillisecondsPropertyValueArgument):
892
842
propname = "Interval"
893
843
894
844
895
class SetApprovalDelay(PropertySetterValueMilliseconds):
845
class SetApprovalDelay(MillisecondsPropertyValueArgument):
896
846
propname = "ApprovalDelay"
897
847
898
848
899
class SetApprovalDuration(PropertySetterValueMilliseconds):
849
class SetApprovalDuration(MillisecondsPropertyValueArgument):
900
850
propname = "ApprovalDuration"
901
851
902
852
935
885
"output"))
936
886
937
887
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
943
888
class Test_string_to_delta(TestCaseWithAssertLogs):
944
889
# Just test basic RFC 3339 functionality here, the doc string for
945
890
# rfc3339_duration_to_delta() already has more comprehensive
946
# tests, which are run by doctest.
891
# tests, which is run by doctest.
947
892
948
893
def test_rfc3339_zero_seconds(self):
949
894
self.assertEqual(datetime.timedelta(),
973
918
974
919
def test_actions_requires_client_or_all(self):
975
920
for action, value in self.actions.items():
976
args = self.actionargs(action, value)
921
options = self.parser.parse_args()
922
setattr(options, action, value)
977
923
with self.assertParseError():
978
self.parse_args(args)
924
self.check_option_syntax(options)
979
925
980
# This mostly corresponds to the definition from has_commands() in
926
# This mostly corresponds to the definition from has_actions() in
981
927
# check_option_syntax()
982
928
actions = {
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,
929
# The actual values set here are not that important, but we do
930
# at least stick to the correct types, even though they are
931
# never used
932
"enable": True,
933
"disable": True,
934
"bump_timeout": True,
935
"start_checker": True,
936
"stop_checker": True,
937
"is_enabled": True,
938
"remove": True,
939
"checker": "x",
940
"timeout": datetime.timedelta(),
941
"extended_timeout": datetime.timedelta(),
942
"interval": datetime.timedelta(),
943
"approved_by_default": True,
944
"approval_delay": datetime.timedelta(),
945
"approval_duration": datetime.timedelta(),
946
"host": "x",
947
"secret": io.BytesIO(b"x"),
948
"approve": True,
949
"deny": True,
1002
950
}
1003
951
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
1011
952
@contextlib.contextmanager
1012
953
def assertParseError(self):
1013
954
with self.assertRaises(SystemExit) as e:
1018
959
# /argparse.html#exiting-methods
1019
960
self.assertEqual(2, e.exception.code)
1020
961
1021
def parse_args(self, args):
1022
options = self.parser.parse_args(args)
1023
check_option_syntax(self.parser, options)
1024
1025
962
@staticmethod
1026
963
@contextlib.contextmanager
1027
964
def redirect_stderr_to_devnull():
1038
975
1039
976
def test_actions_all_conflicts_with_verbose(self):
1040
977
for action, value in self.actions.items():
1041
args = self.actionargs(action, value, "--all",
1042
"--verbose")
978
options = self.parser.parse_args()
979
setattr(options, action, value)
980
options.all = True
981
options.verbose = True
1043
982
with self.assertParseError():
1044
self.parse_args(args)
983
self.check_option_syntax(options)
1045
984
1046
985
def test_actions_with_client_conflicts_with_verbose(self):
1047
986
for action, value in self.actions.items():
1048
args = self.actionargs(action, value, "--verbose",
1049
"client")
987
options = self.parser.parse_args()
988
setattr(options, action, value)
989
options.verbose = True
990
options.client = ["foo"]
1050
991
with self.assertParseError():
1051
self.parse_args(args)
992
self.check_option_syntax(options)
1052
993
1053
994
def test_dump_json_conflicts_with_verbose(self):
1054
args = ["--dump-json", "--verbose"]
995
options = self.parser.parse_args()
996
options.dump_json = True
997
options.verbose = True
1055
998
with self.assertParseError():
1056
self.parse_args(args)
999
self.check_option_syntax(options)
1057
1000
1058
1001
def test_dump_json_conflicts_with_action(self):
1059
1002
for action, value in self.actions.items():
1060
args = self.actionargs(action, value, "--dump-json")
1003
options = self.parser.parse_args()
1004
setattr(options, action, value)
1005
options.dump_json = True
1061
1006
with self.assertParseError():
1062
self.parse_args(args)
1007
self.check_option_syntax(options)
1063
1008
1064
1009
def test_all_can_not_be_alone(self):
1065
args = ["--all"]
1010
options = self.parser.parse_args()
1011
options.all = True
1066
1012
with self.assertParseError():
1067
self.parse_args(args)
1013
self.check_option_syntax(options)
1068
1014
1069
1015
def test_all_is_ok_with_any_action(self):
1070
1016
for action, value in self.actions.items():
1071
args = self.actionargs(action, value, "--all")
1072
self.parse_args(args)
1017
options = self.parser.parse_args()
1018
setattr(options, action, value)
1019
options.all = True
1020
self.check_option_syntax(options)
1073
1021
1074
1022
def test_any_action_is_ok_with_one_client(self):
1075
1023
for action, value in self.actions.items():
1076
args = self.actionargs(action, value, "client")
1077
self.parse_args(args)
1024
options = self.parser.parse_args()
1025
setattr(options, action, value)
1026
options.client = ["foo"]
1027
self.check_option_syntax(options)
1078
1028
1079
1029
def test_one_client_with_all_actions_except_is_enabled(self):
1030
options = self.parser.parse_args()
1080
1031
for action, value in self.actions.items():
1081
if action == "--is-enabled":
1032
if action == "is_enabled":
1082
1033
continue
1083
args = self.actionargs(action, value, "client")
1084
self.parse_args(args)
1034
setattr(options, action, value)
1035
options.client = ["foo"]
1036
self.check_option_syntax(options)
1085
1037
1086
1038
def test_two_clients_with_all_actions_except_is_enabled(self):
1039
options = self.parser.parse_args()
1087
1040
for action, value in self.actions.items():
1088
if action == "--is-enabled":
1041
if action == "is_enabled":
1089
1042
continue
1090
args = self.actionargs(action, value, "client1",
1091
"client2")
1092
self.parse_args(args)
1043
setattr(options, action, value)
1044
options.client = ["foo", "barbar"]
1045
self.check_option_syntax(options)
1093
1046
1094
1047
def test_two_clients_are_ok_with_actions_except_is_enabled(self):
1095
1048
for action, value in self.actions.items():
1096
if action == "--is-enabled":
1049
if action == "is_enabled":
1097
1050
continue
1098
args = self.actionargs(action, value, "client1",
1099
"client2")
1100
self.parse_args(args)
1051
options = self.parser.parse_args()
1052
setattr(options, action, value)
1053
options.client = ["foo", "barbar"]
1054
self.check_option_syntax(options)
1101
1055
1102
1056
def test_is_enabled_fails_without_client(self):
1103
args = ["--is-enabled"]
1057
options = self.parser.parse_args()
1058
options.is_enabled = True
1104
1059
with self.assertParseError():
1105
self.parse_args(args)
1060
self.check_option_syntax(options)
1106
1061
1107
1062
def test_is_enabled_fails_with_two_clients(self):
1108
args = ["--is-enabled", "client1", "client2"]
1063
options = self.parser.parse_args()
1064
options.is_enabled = True
1065
options.client = ["foo", "barbar"]
1109
1066
with self.assertParseError():
1110
self.parse_args(args)
1067
self.check_option_syntax(options)
1111
1068
1112
1069
def test_remove_can_only_be_combined_with_action_deny(self):
1113
1070
for action, value in self.actions.items():
1114
if action in {"--remove", "--deny"}:
1071
if action in {"remove", "deny"}:
1115
1072
continue
1116
args = self.actionargs(action, value, "--all",
1117
"--remove")
1073
options = self.parser.parse_args()
1074
setattr(options, action, value)
1075
options.all = True
1076
options.remove = True
1118
1077
with self.assertParseError():
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):
1078
self.check_option_syntax(options)
1079
1080
1081
class Test_get_mandos_dbus_object(TestCaseWithAssertLogs):
1082
def test_calls_and_returns_get_object_on_bus(self):
1083
class MockBus(object):
1084
called = False
1085
def get_object(mockbus_self, busname, dbus_path):
1086
# Note that "self" is still the testcase instance,
1087
# this MockBus instance is in "mockbus_self".
1088
self.assertEqual(dbus_busname, busname)
1089
self.assertEqual(server_dbus_path, dbus_path)
1090
mockbus_self.called = True
1091
return mockbus_self
1092
1093
mockbus = get_mandos_dbus_object(bus=MockBus())
1094
self.assertIsInstance(mockbus, MockBus)
1095
self.assertTrue(mockbus.called)
1096
1097
def test_logs_and_exits_on_dbus_error(self):
1098
class MockBusFailing(object):
1099
def get_object(self, busname, dbus_path):
1100
raise dbus.exceptions.DBusException("Test")
1101
1102
with self.assertLogs(log, logging.CRITICAL):
1103
with self.assertRaises(SystemExit) as e:
1104
bus = get_mandos_dbus_object(bus=MockBusFailing())
1105
1106
if isinstance(e.exception.code, int):
1107
self.assertNotEqual(0, e.exception.code)
1108
else:
1109
self.assertIsNotNone(e.exception.code)
1110
1111
1112
class Test_get_managed_objects(TestCaseWithAssertLogs):
1113
def test_calls_and_returns_GetManagedObjects(self):
1114
managed_objects = {"/clients/foo": { "Name": "foo"}}
1115
class MockObjectManager(object):
1116
def GetManagedObjects(self):
1117
return managed_objects
1118
retval = get_managed_objects(MockObjectManager())
1119
self.assertDictEqual(managed_objects, retval)
1120
1121
def test_logs_and_exits_on_dbus_error(self):
1408
1122
dbus_logger = logging.getLogger("dbus.proxies")
1409
1123
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
class MockObjectManagerFailing(object):
1125
def GetManagedObjects(self):
1126
dbus_logger.error("Test")
1127
raise dbus.exceptions.DBusException("Test")
1416
1128
1417
1129
class CountingHandler(logging.Handler):
1418
1130
count = 0
1424
1136
dbus_logger.addHandler(counting_handler)
1425
1137
1426
1138
try:
1427
with self.assertRaises(dbus.Error) as e:
1428
self.call_method(bus, "methodname", "busname",
1429
"objectpath", "interface")
1139
with self.assertLogs(log, logging.CRITICAL) as watcher:
1140
with self.assertRaises(SystemExit) as e:
1141
get_managed_objects(MockObjectManagerFailing())
1430
1142
finally:
1431
1143
dbus_logger.removeFilter(counting_handler)
1432
1144
1433
self.assertNotIsInstance(e, dbus.ConnectFailed)
1434
1435
1145
# Make sure the dbus logger was suppressed
1436
1146
self.assertEqual(0, counting_handler.count)
1437
1147
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)
1148
# Test that the dbus_logger still works
1149
with self.assertLogs(dbus_logger, logging.ERROR):
1150
dbus_logger.error("Test")
1151
1152
if isinstance(e.exception.code, int):
1153
self.assertNotEqual(0, e.exception.code)
1154
else:
1155
self.assertIsNotNone(e.exception.code)
1510
1156
1511
1157
1512
1158
class Test_commands_from_options(unittest.TestCase):
1513
1514
1159
def setUp(self):
1515
1160
self.parser = argparse.ArgumentParser()
1516
1161
add_command_line_options(self.parser)
1517
1162
1518
1163
def test_is_enabled(self):
1519
self.assert_command_from_args(["--is-enabled", "client"],
1164
self.assert_command_from_args(["--is-enabled", "foo"],
1520
1165
command.IsEnabled)
1521
1166
1522
1167
def assert_command_from_args(self, args, command_cls,
1533
1178
self.assertEqual(value, getattr(command, key))
1534
1179
1535
1180
def test_is_enabled_short(self):
1536
self.assert_command_from_args(["-V", "client"],
1181
self.assert_command_from_args(["-V", "foo"],
1537
1182
command.IsEnabled)
1538
1183
1539
1184
def test_approve(self):
1540
self.assert_command_from_args(["--approve", "client"],
1185
self.assert_command_from_args(["--approve", "foo"],
1541
1186
command.Approve)
1542
1187
1543
1188
def test_approve_short(self):
1544
self.assert_command_from_args(["-A", "client"],
1545
command.Approve)
1189
self.assert_command_from_args(["-A", "foo"], command.Approve)
1546
1190
1547
1191
def test_deny(self):
1548
self.assert_command_from_args(["--deny", "client"],
1549
command.Deny)
1192
self.assert_command_from_args(["--deny", "foo"], command.Deny)
1550
1193
1551
1194
def test_deny_short(self):
1552
self.assert_command_from_args(["-D", "client"], command.Deny)
1195
self.assert_command_from_args(["-D", "foo"], command.Deny)
1553
1196
1554
1197
def test_remove(self):
1555
self.assert_command_from_args(["--remove", "client"],
1198
self.assert_command_from_args(["--remove", "foo"],
1556
1199
command.Remove)
1557
1200
1558
1201
def test_deny_before_remove(self):
1559
1202
options = self.parser.parse_args(["--deny", "--remove",
1560
"client"])
1203
"foo"])
1561
1204
check_option_syntax(self.parser, options)
1562
1205
commands = commands_from_options(options)
1563
1206
self.assertEqual(2, len(commands))
1574
1217
self.assertIsInstance(commands[1], command.Remove)
1575
1218
1576
1219
def test_remove_short(self):
1577
self.assert_command_from_args(["-r", "client"],
1578
command.Remove)
1220
self.assert_command_from_args(["-r", "foo"], command.Remove)
1579
1221
1580
1222
def test_dump_json(self):
1581
1223
self.assert_command_from_args(["--dump-json"],
1582
1224
command.DumpJSON)
1583
1225
1584
1226
def test_enable(self):
1585
self.assert_command_from_args(["--enable", "client"],
1227
self.assert_command_from_args(["--enable", "foo"],
1586
1228
command.Enable)
1587
1229
1588
1230
def test_enable_short(self):
1589
self.assert_command_from_args(["-e", "client"],
1590
command.Enable)
1231
self.assert_command_from_args(["-e", "foo"], command.Enable)
1591
1232
1592
1233
def test_disable(self):
1593
self.assert_command_from_args(["--disable", "client"],
1234
self.assert_command_from_args(["--disable", "foo"],
1594
1235
command.Disable)
1595
1236
1596
1237
def test_disable_short(self):
1597
self.assert_command_from_args(["-d", "client"],
1598
command.Disable)
1238
self.assert_command_from_args(["-d", "foo"], command.Disable)
1599
1239
1600
1240
def test_bump_timeout(self):
1601
self.assert_command_from_args(["--bump-timeout", "client"],
1241
self.assert_command_from_args(["--bump-timeout", "foo"],
1602
1242
command.BumpTimeout)
1603
1243
1604
1244
def test_bump_timeout_short(self):
1605
self.assert_command_from_args(["-b", "client"],
1245
self.assert_command_from_args(["-b", "foo"],
1606
1246
command.BumpTimeout)
1607
1247
1608
1248
def test_start_checker(self):
1609
self.assert_command_from_args(["--start-checker", "client"],
1249
self.assert_command_from_args(["--start-checker", "foo"],
1610
1250
command.StartChecker)
1611
1251
1612
1252
def test_stop_checker(self):
1613
self.assert_command_from_args(["--stop-checker", "client"],
1253
self.assert_command_from_args(["--stop-checker", "foo"],
1614
1254
command.StopChecker)
1615
1255
1616
1256
def test_approve_by_default(self):
1617
self.assert_command_from_args(["--approve-by-default",
1618
"client"],
1257
self.assert_command_from_args(["--approve-by-default", "foo"],
1619
1258
command.ApproveByDefault)
1620
1259
1621
1260
def test_deny_by_default(self):
1622
self.assert_command_from_args(["--deny-by-default", "client"],
1261
self.assert_command_from_args(["--deny-by-default", "foo"],
1623
1262
command.DenyByDefault)
1624
1263
1625
1264
def test_checker(self):
1626
self.assert_command_from_args(["--checker", ":", "client"],
1265
self.assert_command_from_args(["--checker", ":", "foo"],
1627
1266
command.SetChecker,
1628
1267
value_to_set=":")
1629
1268
1630
1269
def test_checker_empty(self):
1631
self.assert_command_from_args(["--checker", "", "client"],
1270
self.assert_command_from_args(["--checker", "", "foo"],
1632
1271
command.SetChecker,
1633
1272
value_to_set="")
1634
1273
1635
1274
def test_checker_short(self):
1636
self.assert_command_from_args(["-c", ":", "client"],
1275
self.assert_command_from_args(["-c", ":", "foo"],
1637
1276
command.SetChecker,
1638
1277
value_to_set=":")
1639
1278
1640
1279
def test_host(self):
1641
self.assert_command_from_args(
1642
["--host", "client.example.org", "client"],
1643
command.SetHost, value_to_set="client.example.org")
1280
self.assert_command_from_args(["--host", "foo.example.org",
1281
"foo"], command.SetHost,
1282
value_to_set="foo.example.org")
1644
1283
1645
1284
def test_host_short(self):
1646
self.assert_command_from_args(
1647
["-H", "client.example.org", "client"], command.SetHost,
1648
value_to_set="client.example.org")
1285
self.assert_command_from_args(["-H", "foo.example.org",
1286
"foo"], command.SetHost,
1287
value_to_set="foo.example.org")
1649
1288
1650
1289
def test_secret_devnull(self):
1651
1290
self.assert_command_from_args(["--secret", os.path.devnull,
1652
"client"], command.SetSecret,
1291
"foo"], command.SetSecret,
1653
1292
value_to_set=b"")
1654
1293
1655
1294
def test_secret_tempfile(self):
1658
1297
f.write(value)
1659
1298
f.seek(0)
1660
1299
self.assert_command_from_args(["--secret", f.name,
1661
"client"],
1662
command.SetSecret,
1300
"foo"], command.SetSecret,
1663
1301
value_to_set=value)
1664
1302
1665
1303
def test_secret_devnull_short(self):
1666
self.assert_command_from_args(["-s", os.path.devnull,
1667
"client"], command.SetSecret,
1304
self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1305
command.SetSecret,
1668
1306
value_to_set=b"")
1669
1307
1670
1308
def test_secret_tempfile_short(self):
1672
1310
value = b"secret\0xyzzy\nbar"
1673
1311
f.write(value)
1674
1312
f.seek(0)
1675
self.assert_command_from_args(["-s", f.name, "client"],
1313
self.assert_command_from_args(["-s", f.name, "foo"],
1676
1314
command.SetSecret,
1677
1315
value_to_set=value)
1678
1316
1679
1317
def test_timeout(self):
1680
self.assert_command_from_args(["--timeout", "PT5M", "client"],
1318
self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1681
1319
command.SetTimeout,
1682
1320
value_to_set=300000)
1683
1321
1684
1322
def test_timeout_short(self):
1685
self.assert_command_from_args(["-t", "PT5M", "client"],
1323
self.assert_command_from_args(["-t", "PT5M", "foo"],
1686
1324
command.SetTimeout,
1687
1325
value_to_set=300000)
1688
1326
1689
1327
def test_extended_timeout(self):
1690
1328
self.assert_command_from_args(["--extended-timeout", "PT15M",
1691
"client"],
1329
"foo"],
1692
1330
command.SetExtendedTimeout,
1693
1331
value_to_set=900000)
1694
1332
1695
1333
def test_interval(self):
1696
self.assert_command_from_args(["--interval", "PT2M",
1697
"client"], command.SetInterval,
1334
self.assert_command_from_args(["--interval", "PT2M", "foo"],
1335
command.SetInterval,
1698
1336
value_to_set=120000)
1699
1337
1700
1338
def test_interval_short(self):
1701
self.assert_command_from_args(["-i", "PT2M", "client"],
1339
self.assert_command_from_args(["-i", "PT2M", "foo"],
1702
1340
command.SetInterval,
1703
1341
value_to_set=120000)
1704
1342
1705
1343
def test_approval_delay(self):
1706
1344
self.assert_command_from_args(["--approval-delay", "PT30S",
1707
"client"],
1345
"foo"],
1708
1346
command.SetApprovalDelay,
1709
1347
value_to_set=30000)
1710
1348
1711
1349
def test_approval_duration(self):
1712
1350
self.assert_command_from_args(["--approval-duration", "PT1S",
1713
"client"],
1351
"foo"],
1714
1352
command.SetApprovalDuration,
1715
1353
value_to_set=1000)
1716
1354
1731
1369
class TestCommand(unittest.TestCase):
1732
1370
"""Abstract class for tests of command classes"""
1733
1371
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
1822
1372
def setUp(self):
1823
self.bus = self.FakeMandosBus(self)
1373
testcase = self
1374
class MockClient(object):
1375
def __init__(self, name, **attributes):
1376
self.__dbus_object_path__ = "/clients/{}".format(name)
1377
self.attributes = attributes
1378
self.attributes["Name"] = name
1379
self.calls = []
1380
def Set(self, interface, propname, value, dbus_interface):
1381
testcase.assertEqual(client_dbus_interface, interface)
1382
testcase.assertEqual(dbus.PROPERTIES_IFACE,
1383
dbus_interface)
1384
self.attributes[propname] = value
1385
def Approve(self, approve, dbus_interface):
1386
testcase.assertEqual(client_dbus_interface,
1387
dbus_interface)
1388
self.calls.append(("Approve", (approve,
1389
dbus_interface)))
1390
self.client = MockClient(
1391
"foo",
1392
KeyID=("92ed150794387c03ce684574b1139a65"
1393
"94a34f895daaaf09fd8ea90a27cddb12"),
1394
Secret=b"secret",
1395
Host="foo.example.org",
1396
Enabled=dbus.Boolean(True),
1397
Timeout=300000,
1398
LastCheckedOK="2019-02-03T00:00:00",
1399
Created="2019-01-02T00:00:00",
1400
Interval=120000,
1401
Fingerprint=("778827225BA7DE539C5A"
1402
"7CFA59CFF7CDBD9A5920"),
1403
CheckerRunning=dbus.Boolean(False),
1404
LastEnabled="2019-01-03T00:00:00",
1405
ApprovalPending=dbus.Boolean(False),
1406
ApprovedByDefault=dbus.Boolean(True),
1407
LastApprovalRequest="",
1408
ApprovalDelay=0,
1409
ApprovalDuration=1000,
1410
Checker="fping -q -- %(host)s",
1411
ExtendedTimeout=900000,
1412
Expires="2019-02-04T00:00:00",
1413
LastCheckerStatus=0)
1414
self.other_client = MockClient(
1415
"barbar",
1416
KeyID=("0558568eedd67d622f5c83b35a115f79"
1417
"6ab612cff5ad227247e46c2b020f441c"),
1418
Secret=b"secretbar",
1419
Host="192.0.2.3",
1420
Enabled=dbus.Boolean(True),
1421
Timeout=300000,
1422
LastCheckedOK="2019-02-04T00:00:00",
1423
Created="2019-01-03T00:00:00",
1424
Interval=120000,
1425
Fingerprint=("3E393AEAEFB84C7E89E2"
1426
"F547B3A107558FCA3A27"),
1427
CheckerRunning=dbus.Boolean(True),
1428
LastEnabled="2019-01-04T00:00:00",
1429
ApprovalPending=dbus.Boolean(False),
1430
ApprovedByDefault=dbus.Boolean(False),
1431
LastApprovalRequest="2019-01-03T00:00:00",
1432
ApprovalDelay=30000,
1433
ApprovalDuration=93785000,
1434
Checker=":",
1435
ExtendedTimeout=900000,
1436
Expires="2019-02-05T00:00:00",
1437
LastCheckerStatus=-2)
1438
self.clients = collections.OrderedDict(
1439
[
1440
("/clients/foo", self.client.attributes),
1441
("/clients/barbar", self.other_client.attributes),
1442
])
1443
self.one_client = {"/clients/foo": self.client.attributes}
1444
1445
@property
1446
def bus(self):
1447
class Bus(object):
1448
@staticmethod
1449
def get_object(client_bus_name, path):
1450
self.assertEqual(dbus_busname, client_bus_name)
1451
return {
1452
# Note: "self" here is the TestCmd instance, not
1453
# the Bus instance, since this is a static method!
1454
"/clients/foo": self.client,
1455
"/clients/barbar": self.other_client,
1456
}[path]
1457
return Bus()
1824
1458
1825
1459
1826
1460
class TestBaseCommands(TestCommand):
1827
1461
1828
1462
def test_IsEnabled_exits_successfully(self):
1829
1463
with self.assertRaises(SystemExit) as e:
1830
command.IsEnabled().run(self.bus.one_client)
1464
command.IsEnabled().run(self.one_client)
1831
1465
if e.exception.code is not None:
1832
1466
self.assertEqual(0, e.exception.code)
1833
1467
else:
1834
1468
self.assertIsNone(e.exception.code)
1835
1469
1836
1470
def test_IsEnabled_exits_with_failure(self):
1837
self.bus.client_properties["Enabled"] = False
1471
self.client.attributes["Enabled"] = dbus.Boolean(False)
1838
1472
with self.assertRaises(SystemExit) as e:
1839
command.IsEnabled().run(self.bus.one_client)
1473
command.IsEnabled().run(self.one_client)
1840
1474
if isinstance(e.exception.code, int):
1841
1475
self.assertNotEqual(0, e.exception.code)
1842
1476
else:
1843
1477
self.assertIsNotNone(e.exception.code)
1844
1478
1845
1479
def test_Approve(self):
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)
1480
command.Approve().run(self.clients, self.bus)
1481
for clientpath in self.clients:
1482
client = self.bus.get_object(dbus_busname, clientpath)
1483
self.assertIn(("Approve", (True, client_dbus_interface)),
1484
client.calls)
1852
1485
1853
1486
def test_Deny(self):
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)
1487
command.Deny().run(self.clients, self.bus)
1488
for clientpath in self.clients:
1489
client = self.bus.get_object(dbus_busname, clientpath)
1490
self.assertIn(("Approve", (False, client_dbus_interface)),
1491
client.calls)
1861
1492
1862
1493
def test_Remove(self):
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)
1494
class MockMandos(object):
1495
def __init__(self):
1496
self.calls = []
1497
def RemoveClient(self, dbus_path):
1498
self.calls.append(("RemoveClient", (dbus_path,)))
1499
mandos = MockMandos()
1500
command.Remove().run(self.clients, self.bus, mandos)
1501
for clientpath in self.clients:
1502
self.assertIn(("RemoveClient", (clientpath,)),
1503
mandos.calls)
1868
1504
1869
1505
expected_json = {
1870
1506
"foo": {
1918
1554
}
1919
1555
1920
1556
def test_DumpJSON_normal(self):
1921
with self.capture_stdout_to_buffer() as buffer:
1922
command.DumpJSON().run(self.bus.clients)
1923
json_data = json.loads(buffer.getvalue())
1557
output = command.DumpJSON().output(self.clients.values())
1558
json_data = json.loads(output)
1924
1559
self.assertDictEqual(self.expected_json, json_data)
1925
1560
1926
@staticmethod
1927
@contextlib.contextmanager
1928
def capture_stdout_to_buffer():
1929
capture_buffer = io.StringIO()
1930
old_stdout = sys.stdout
1931
sys.stdout = capture_buffer
1932
try:
1933
yield capture_buffer
1934
finally:
1935
sys.stdout = old_stdout
1936
1937
1561
def test_DumpJSON_one_client(self):
1938
with self.capture_stdout_to_buffer() as buffer:
1939
command.DumpJSON().run(self.bus.one_client)
1940
json_data = json.loads(buffer.getvalue())
1562
output = command.DumpJSON().output(self.one_client.values())
1563
json_data = json.loads(output)
1941
1564
expected_json = {"foo": self.expected_json["foo"]}
1942
1565
self.assertDictEqual(expected_json, json_data)
1943
1566
1944
1567
def test_PrintTable_normal(self):
1945
with self.capture_stdout_to_buffer() as buffer:
1946
command.PrintTable().run(self.bus.clients)
1568
output = command.PrintTable().output(self.clients.values())
1947
1569
expected_output = "\n".join((
1948
1570
"Name Enabled Timeout Last Successful Check",
1949
1571
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1950
1572
"barbar Yes 00:05:00 2019-02-04T00:00:00 ",
1951
)) + "\n"
1952
self.assertEqual(expected_output, buffer.getvalue())
1573
))
1574
self.assertEqual(expected_output, output)
1953
1575
1954
1576
def test_PrintTable_verbose(self):
1955
with self.capture_stdout_to_buffer() as buffer:
1956
command.PrintTable(verbose=True).run(self.bus.clients)
1577
output = command.PrintTable(verbose=True).output(
1578
self.clients.values())
1957
1579
columns = (
1958
1580
(
1959
1581
"Name ",
2041
1663
)
2042
1664
)
2043
1665
num_lines = max(len(rows) for rows in columns)
2044
expected_output = ("\n".join("".join(rows[line]
2045
for rows in columns)
2046
for line in range(num_lines))
2047
+ "\n")
2048
self.assertEqual(expected_output, buffer.getvalue())
1666
expected_output = "\n".join("".join(rows[line]
1667
for rows in columns)
1668
for line in range(num_lines))
1669
self.assertEqual(expected_output, output)
2049
1670
2050
1671
def test_PrintTable_one_client(self):
2051
with self.capture_stdout_to_buffer() as buffer:
2052
command.PrintTable().run(self.bus.one_client)
1672
output = command.PrintTable().output(self.one_client.values())
2053
1673
expected_output = "\n".join((
2054
1674
"Name Enabled Timeout Last Successful Check",
2055
1675
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
2056
)) + "\n"
2057
self.assertEqual(expected_output, buffer.getvalue())
2058
2059
2060
class TestPropertySetterCmd(TestCommand):
2061
"""Abstract class for tests of command.PropertySetter classes"""
2062
1676
))
1677
self.assertEqual(expected_output, output)
1678
1679
1680
class TestPropertyCmd(TestCommand):
1681
"""Abstract class for tests of command.Property classes"""
2063
1682
def runTest(self):
2064
1683
if not hasattr(self, "command"):
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)
1684
return
1685
values_to_get = getattr(self, "values_to_get",
1686
self.values_to_set)
1687
for value_to_set, value_to_get in zip(self.values_to_set,
1688
values_to_get):
1689
for clientpath in self.clients:
1690
client = self.bus.get_object(dbus_busname, clientpath)
1691
old_value = client.attributes[self.propname]
1692
client.attributes[self.propname] = self.Unique()
1693
self.run_command(value_to_set, self.clients)
1694
for clientpath in self.clients:
1695
client = self.bus.get_object(dbus_busname, clientpath)
1696
value = client.attributes[self.propname]
1697
self.assertNotIsInstance(value, self.Unique)
2083
1698
self.assertEqual(value_to_get, value)
2084
1699
2085
2086
class TestEnableCmd(TestPropertySetterCmd):
1700
class Unique(object):
1701
"""Class for objects which exist only to be unique objects,
1702
since unittest.mock.sentinel only exists in Python 3.3"""
1703
1704
def run_command(self, value, clients):
1705
self.command().run(clients, self.bus)
1706
1707
1708
class TestEnableCmd(TestPropertyCmd):
2087
1709
command = command.Enable
2088
1710
propname = "Enabled"
2089
values_to_get = [True]
2090
2091
2092
class TestDisableCmd(TestPropertySetterCmd):
1711
values_to_set = [dbus.Boolean(True)]
1712
1713
1714
class TestDisableCmd(TestPropertyCmd):
2093
1715
command = command.Disable
2094
1716
propname = "Enabled"
2095
values_to_get = [False]
2096
2097
2098
class TestBumpTimeoutCmd(TestPropertySetterCmd):
1717
values_to_set = [dbus.Boolean(False)]
1718
1719
1720
class TestBumpTimeoutCmd(TestPropertyCmd):
2099
1721
command = command.BumpTimeout
2100
1722
propname = "LastCheckedOK"
2101
values_to_get = [""]
2102
2103
2104
class TestStartCheckerCmd(TestPropertySetterCmd):
1723
values_to_set = [""]
1724
1725
1726
class TestStartCheckerCmd(TestPropertyCmd):
2105
1727
command = command.StartChecker
2106
1728
propname = "CheckerRunning"
2107
values_to_get = [True]
2108
2109
2110
class TestStopCheckerCmd(TestPropertySetterCmd):
1729
values_to_set = [dbus.Boolean(True)]
1730
1731
1732
class TestStopCheckerCmd(TestPropertyCmd):
2111
1733
command = command.StopChecker
2112
1734
propname = "CheckerRunning"
2113
values_to_get = [False]
2114
2115
2116
class TestApproveByDefaultCmd(TestPropertySetterCmd):
1735
values_to_set = [dbus.Boolean(False)]
1736
1737
1738
class TestApproveByDefaultCmd(TestPropertyCmd):
2117
1739
command = command.ApproveByDefault
2118
1740
propname = "ApprovedByDefault"
2119
values_to_get = [True]
2120
2121
2122
class TestDenyByDefaultCmd(TestPropertySetterCmd):
1741
values_to_set = [dbus.Boolean(True)]
1742
1743
1744
class TestDenyByDefaultCmd(TestPropertyCmd):
2123
1745
command = command.DenyByDefault
2124
1746
propname = "ApprovedByDefault"
2125
values_to_get = [False]
2126
2127
2128
class TestSetCheckerCmd(TestPropertySetterCmd):
1747
values_to_set = [dbus.Boolean(False)]
1748
1749
1750
class TestPropertyValueCmd(TestPropertyCmd):
1751
"""Abstract class for tests of PropertyValueCmd classes"""
1752
1753
def runTest(self):
1754
if type(self) is TestPropertyValueCmd:
1755
return
1756
return super(TestPropertyValueCmd, self).runTest()
1757
1758
def run_command(self, value, clients):
1759
self.command(value).run(clients, self.bus)
1760
1761
1762
class TestSetCheckerCmd(TestPropertyValueCmd):
2129
1763
command = command.SetChecker
2130
1764
propname = "Checker"
2131
1765
values_to_set = ["", ":", "fping -q -- %s"]
2132
1766
2133
1767
2134
class TestSetHostCmd(TestPropertySetterCmd):
1768
class TestSetHostCmd(TestPropertyValueCmd):
2135
1769
command = command.SetHost
2136
1770
propname = "Host"
2137
values_to_set = ["192.0.2.3", "client.example.org"]
2138
2139
2140
class TestSetSecretCmd(TestPropertySetterCmd):
1771
values_to_set = ["192.0.2.3", "foo.example.org"]
1772
1773
1774
class TestSetSecretCmd(TestPropertyValueCmd):
2141
1775
command = command.SetSecret
2142
1776
propname = "Secret"
2143
1777
values_to_set = [io.BytesIO(b""),
2144
1778
io.BytesIO(b"secret\0xyzzy\nbar")]
2145
values_to_get = [f.getvalue() for f in values_to_set]
2146
2147
2148
class TestSetTimeoutCmd(TestPropertySetterCmd):
1779
values_to_get = [b"", b"secret\0xyzzy\nbar"]
1780
1781
1782
class TestSetTimeoutCmd(TestPropertyValueCmd):
2149
1783
command = command.SetTimeout
2150
1784
propname = "Timeout"
2151
1785
values_to_set = [datetime.timedelta(),
2153
1787
datetime.timedelta(seconds=1),
2154
1788
datetime.timedelta(weeks=1),
2155
1789
datetime.timedelta(weeks=52)]
2156
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2157
2158
2159
class TestSetExtendedTimeoutCmd(TestPropertySetterCmd):
1790
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1791
1792
1793
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
2160
1794
command = command.SetExtendedTimeout
2161
1795
propname = "ExtendedTimeout"
2162
1796
values_to_set = [datetime.timedelta(),
2164
1798
datetime.timedelta(seconds=1),
2165
1799
datetime.timedelta(weeks=1),
2166
1800
datetime.timedelta(weeks=52)]
2167
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2168
2169
2170
class TestSetIntervalCmd(TestPropertySetterCmd):
1801
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1802
1803
1804
class TestSetIntervalCmd(TestPropertyValueCmd):
2171
1805
command = command.SetInterval
2172
1806
propname = "Interval"
2173
1807
values_to_set = [datetime.timedelta(),
2175
1809
datetime.timedelta(seconds=1),
2176
1810
datetime.timedelta(weeks=1),
2177
1811
datetime.timedelta(weeks=52)]
2178
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2179
2180
2181
class TestSetApprovalDelayCmd(TestPropertySetterCmd):
1812
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1813
1814
1815
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
2182
1816
command = command.SetApprovalDelay
2183
1817
propname = "ApprovalDelay"
2184
1818
values_to_set = [datetime.timedelta(),
2186
1820
datetime.timedelta(seconds=1),
2187
1821
datetime.timedelta(weeks=1),
2188
1822
datetime.timedelta(weeks=52)]
2189
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2190
2191
2192
class TestSetApprovalDurationCmd(TestPropertySetterCmd):
1823
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1824
1825
1826
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
2193
1827
command = command.SetApprovalDuration
2194
1828
propname = "ApprovalDuration"
2195
1829
values_to_set = [datetime.timedelta(),
2197
1831
datetime.timedelta(seconds=1),
2198
1832
datetime.timedelta(weeks=1),
2199
1833
datetime.timedelta(weeks=52)]
2200
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1834
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
2201
1835
2202
1836
2203
1837
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0