274
## Classes for commands.
276
# Abstract classes first
277
class Command(object):
278
"""Abstract class for commands"""
279
def run(self, clients, bus=None, mandos=None):
280
"""Normal commands should implement run_on_one_client(), but
281
commands which want to operate on all clients at the same time
282
can override this run() method instead."""
284
for clientpath, properties in clients.items():
285
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
286
busname, str(clientpath))
287
client = bus.get_object(busname, clientpath)
288
self.run_on_one_client(client, properties)
290
class PrintCmd(Command):
291
"""Abstract class for commands printing client details"""
292
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
293
"Created", "Interval", "Host", "KeyID",
294
"Fingerprint", "CheckerRunning", "LastEnabled",
295
"ApprovalPending", "ApprovedByDefault",
296
"LastApprovalRequest", "ApprovalDelay",
297
"ApprovalDuration", "Checker", "ExtendedTimeout",
298
"Expires", "LastCheckerStatus")
299
def run(self, clients, bus=None, mandos=None):
300
print(self.output(clients.values()))
301
def output(self, clients):
302
raise NotImplementedError()
304
class PropertyCmd(Command):
305
"""Abstract class for Actions for setting one client property"""
306
def run_on_one_client(self, client, properties):
307
"""Set the Client's D-Bus property"""
308
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", busname,
309
client.__dbus_object_path__,
310
dbus.PROPERTIES_IFACE, client_interface,
311
self.propname, self.value_to_set
312
if not isinstance(self.value_to_set, dbus.Boolean)
313
else bool(self.value_to_set))
314
client.Set(client_interface, self.propname, self.value_to_set,
315
dbus_interface=dbus.PROPERTIES_IFACE)
318
raise NotImplementedError()
320
class ValueArgumentMixIn(object):
321
"""Mixin class for commands taking a value as argument"""
322
def __init__(self, value):
323
self.value_to_set = value
325
class MillisecondsValueArgumentMixIn(ValueArgumentMixIn):
326
"""Mixin class for commands taking a value argument as
329
def value_to_set(self):
332
def value_to_set(self, value):
333
"""When setting, convert value to a datetime.timedelta"""
334
self._vts = int(round(value.total_seconds() * 1000))
336
# Actual (non-abstract) command classes
338
class PrintTableCmd(PrintCmd):
339
def __init__(self, verbose=False):
340
self.verbose = verbose
342
def output(self, clients):
343
default_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
344
keywords = default_keywords
346
keywords = self.all_keywords
347
return str(self.TableOfClients(clients, keywords))
349
class TableOfClients(object):
352
"Enabled": "Enabled",
353
"Timeout": "Timeout",
354
"LastCheckedOK": "Last Successful Check",
355
"LastApprovalRequest": "Last Approval Request",
356
"Created": "Created",
357
"Interval": "Interval",
359
"Fingerprint": "Fingerprint",
361
"CheckerRunning": "Check Is Running",
362
"LastEnabled": "Last Enabled",
363
"ApprovalPending": "Approval Is Pending",
364
"ApprovedByDefault": "Approved By Default",
365
"ApprovalDelay": "Approval Delay",
366
"ApprovalDuration": "Approval Duration",
367
"Checker": "Checker",
368
"ExtendedTimeout": "Extended Timeout",
369
"Expires": "Expires",
370
"LastCheckerStatus": "Last Checker Status",
373
def __init__(self, clients, keywords, tableheaders=None):
374
self.clients = clients
375
self.keywords = keywords
376
if tableheaders is not None:
377
self.tableheaders = tableheaders
380
return "\n".join(self.rows())
382
if sys.version_info.major == 2:
383
__unicode__ = __str__
385
return str(self).encode(locale.getpreferredencoding())
388
format_string = self.row_formatting_string()
389
rows = [self.header_line(format_string)]
390
rows.extend(self.client_line(client, format_string)
391
for client in self.clients)
394
def row_formatting_string(self):
395
"Format string used to format table rows"
396
return " ".join("{{{key}:{width}}}".format(
397
width=max(len(self.tableheaders[key]),
398
*(len(self.string_from_client(client, key))
399
for client in self.clients)),
401
for key in self.keywords)
403
def string_from_client(self, client, key):
404
return self.valuetostring(client[key], key)
407
def valuetostring(value, keyword):
408
if isinstance(value, dbus.Boolean):
409
return "Yes" if value else "No"
410
if keyword in ("Timeout", "Interval", "ApprovalDelay",
411
"ApprovalDuration", "ExtendedTimeout"):
412
return milliseconds_to_string(value)
415
def header_line(self, format_string):
416
return format_string.format(**self.tableheaders)
418
def client_line(self, client, format_string):
419
return format_string.format(
420
**{key: self.string_from_client(client, key)
421
for key in self.keywords})
425
class DumpJSONCmd(PrintCmd):
426
def output(self, clients):
427
data = {client["Name"]:
428
{key: self.dbus_boolean_to_bool(client[key])
429
for key in self.all_keywords}
430
for client in clients.values()}
431
return json.dumps(data, indent=4, separators=(',', ': '))
433
def dbus_boolean_to_bool(value):
434
if isinstance(value, dbus.Boolean):
438
class IsEnabledCmd(Command):
439
def run(self, clients, bus=None, mandos=None):
440
client, properties = next(iter(clients.items()))
441
if self.is_enabled(client, properties):
444
def is_enabled(self, client, properties):
445
return properties["Enabled"]
447
class RemoveCmd(Command):
448
def run_on_one_client(self, client, properties):
449
log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)", busname,
450
server_path, server_interface,
451
str(client.__dbus_object_path__))
452
self.mandos.RemoveClient(client.__dbus_object_path__)
454
class ApproveCmd(Command):
455
def run_on_one_client(self, client, properties):
456
log.debug("D-Bus: %s:%s:%s.Approve(True)", busname,
457
client.__dbus_object_path__, client_interface)
458
client.Approve(dbus.Boolean(True),
459
dbus_interface=client_interface)
461
class DenyCmd(Command):
462
def run_on_one_client(self, client, properties):
463
log.debug("D-Bus: %s:%s:%s.Approve(False)", busname,
464
client.__dbus_object_path__, client_interface)
465
client.Approve(dbus.Boolean(False),
466
dbus_interface=client_interface)
468
class EnableCmd(PropertyCmd):
470
value_to_set = dbus.Boolean(True)
472
class DisableCmd(PropertyCmd):
474
value_to_set = dbus.Boolean(False)
476
class BumpTimeoutCmd(PropertyCmd):
477
propname = "LastCheckedOK"
480
class StartCheckerCmd(PropertyCmd):
481
propname = "CheckerRunning"
482
value_to_set = dbus.Boolean(True)
484
class StopCheckerCmd(PropertyCmd):
485
propname = "CheckerRunning"
486
value_to_set = dbus.Boolean(False)
488
class ApproveByDefaultCmd(PropertyCmd):
489
propname = "ApprovedByDefault"
490
value_to_set = dbus.Boolean(True)
492
class DenyByDefaultCmd(PropertyCmd):
493
propname = "ApprovedByDefault"
494
value_to_set = dbus.Boolean(False)
496
class SetCheckerCmd(PropertyCmd, ValueArgumentMixIn):
499
class SetHostCmd(PropertyCmd, ValueArgumentMixIn):
502
class SetSecretCmd(PropertyCmd, ValueArgumentMixIn):
505
def value_to_set(self):
508
def value_to_set(self, value):
509
"""When setting, read data from supplied file object"""
510
self._vts = value.read()
513
class SetTimeoutCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
516
class SetExtendedTimeoutCmd(PropertyCmd,
517
MillisecondsValueArgumentMixIn):
518
propname = "ExtendedTimeout"
520
class SetIntervalCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
521
propname = "Interval"
523
class SetApprovalDelayCmd(PropertyCmd,
524
MillisecondsValueArgumentMixIn):
525
propname = "ApprovalDelay"
527
class SetApprovalDurationCmd(PropertyCmd,
528
MillisecondsValueArgumentMixIn):
529
propname = "ApprovalDuration"
531
def add_command_line_options(parser):
532
parser.add_argument("--version", action="version",
533
version="%(prog)s {}".format(version),
534
help="show version number and exit")
535
parser.add_argument("-a", "--all", action="store_true",
536
help="Select all clients")
537
parser.add_argument("-v", "--verbose", action="store_true",
538
help="Print all fields")
539
parser.add_argument("-j", "--dump-json", action="store_true",
540
help="Dump client data in JSON format")
541
enable_disable = parser.add_mutually_exclusive_group()
542
enable_disable.add_argument("-e", "--enable", action="store_true",
543
help="Enable client")
544
enable_disable.add_argument("-d", "--disable",
546
help="disable client")
547
parser.add_argument("-b", "--bump-timeout", action="store_true",
548
help="Bump timeout for client")
549
start_stop_checker = parser.add_mutually_exclusive_group()
550
start_stop_checker.add_argument("--start-checker",
552
help="Start checker for client")
553
start_stop_checker.add_argument("--stop-checker",
555
help="Stop checker for client")
556
parser.add_argument("-V", "--is-enabled", action="store_true",
557
help="Check if client is enabled")
558
parser.add_argument("-r", "--remove", action="store_true",
559
help="Remove client")
560
parser.add_argument("-c", "--checker",
561
help="Set checker command for client")
562
parser.add_argument("-t", "--timeout", type=string_to_delta,
563
help="Set timeout for client")
564
parser.add_argument("--extended-timeout", type=string_to_delta,
565
help="Set extended timeout for client")
566
parser.add_argument("-i", "--interval", type=string_to_delta,
567
help="Set checker interval for client")
568
approve_deny_default = parser.add_mutually_exclusive_group()
569
approve_deny_default.add_argument(
570
"--approve-by-default", action="store_true",
571
default=None, dest="approved_by_default",
572
help="Set client to be approved by default")
573
approve_deny_default.add_argument(
574
"--deny-by-default", action="store_false",
575
dest="approved_by_default",
576
help="Set client to be denied by default")
577
parser.add_argument("--approval-delay", type=string_to_delta,
578
help="Set delay before client approve/deny")
579
parser.add_argument("--approval-duration", type=string_to_delta,
580
help="Set duration of one client approval")
581
parser.add_argument("-H", "--host", help="Set host for client")
582
parser.add_argument("-s", "--secret",
583
type=argparse.FileType(mode="rb"),
584
help="Set password blob (file) for client")
585
approve_deny = parser.add_mutually_exclusive_group()
586
approve_deny.add_argument(
587
"-A", "--approve", action="store_true",
588
help="Approve any current client request")
589
approve_deny.add_argument("-D", "--deny", action="store_true",
590
help="Deny any current client request")
591
parser.add_argument("--debug", action="store_true",
592
help="Debug mode (show D-Bus commands)")
593
parser.add_argument("--check", action="store_true",
594
help="Run self-test")
595
parser.add_argument("client", nargs="*", help="Client name")
598
def commands_from_options(options):
602
if options.dump_json:
603
commands.append(DumpJSONCmd())
606
commands.append(EnableCmd())
609
commands.append(DisableCmd())
611
if options.bump_timeout:
612
commands.append(BumpTimeoutCmd())
614
if options.start_checker:
615
commands.append(StartCheckerCmd())
617
if options.stop_checker:
618
commands.append(StopCheckerCmd())
620
if options.is_enabled:
621
commands.append(IsEnabledCmd())
623
if options.checker is not None:
624
commands.append(SetCheckerCmd(options.checker))
626
if options.timeout is not None:
627
commands.append(SetTimeoutCmd(options.timeout))
629
if options.extended_timeout:
631
SetExtendedTimeoutCmd(options.extended_timeout))
633
if options.interval is not None:
634
commands.append(SetIntervalCmd(options.interval))
636
if options.approved_by_default is not None:
637
if options.approved_by_default:
638
commands.append(ApproveByDefaultCmd())
640
commands.append(DenyByDefaultCmd())
642
if options.approval_delay is not None:
643
commands.append(SetApprovalDelayCmd(options.approval_delay))
645
if options.approval_duration is not None:
647
SetApprovalDurationCmd(options.approval_duration))
649
if options.host is not None:
650
commands.append(SetHostCmd(options.host))
652
if options.secret is not None:
653
commands.append(SetSecretCmd(options.secret))
656
commands.append(ApproveCmd())
659
commands.append(DenyCmd())
662
commands.append(RemoveCmd())
664
# If no command option has been given, show table of clients,
665
# optionally verbosely
667
commands.append(PrintTableCmd(verbose=options.verbose))
672
437
def check_option_syntax(parser, options):
673
438
"""Apply additional restrictions on options, not expressible in
676
def has_actions(options):
677
return any((options.enable,
679
options.bump_timeout,
680
options.start_checker,
681
options.stop_checker,
684
options.checker is not None,
685
options.timeout is not None,
686
options.extended_timeout is not None,
687
options.interval is not None,
688
options.approved_by_default is not None,
689
options.approval_delay is not None,
690
options.approval_duration is not None,
691
options.host is not None,
692
options.secret is not None,
441
def has_commands(options, commands=None):
443
commands = (command.Enable,
446
command.StartChecker,
452
command.SetExtendedTimeout,
454
command.ApproveByDefault,
455
command.DenyByDefault,
456
command.SetApprovalDelay,
457
command.SetApprovalDuration,
462
return any(isinstance(cmd, commands)
463
for cmd in options.commands)
696
if has_actions(options) and not (options.client or options.all):
465
if has_commands(options) and not (options.client or options.all):
697
466
parser.error("Options require clients names or --all.")
698
if options.verbose and has_actions(options):
467
if options.verbose and has_commands(options):
699
468
parser.error("--verbose can only be used alone.")
700
if options.dump_json and (options.verbose
701
or has_actions(options)):
469
if (has_commands(options, (command.DumpJSON,))
470
and (options.verbose or len(options.commands) > 1)):
702
471
parser.error("--dump-json can only be used alone.")
703
if options.all and not has_actions(options):
472
if options.all and not has_commands(options):
704
473
parser.error("--all requires an action.")
705
if options.is_enabled and len(options.client) > 1:
474
if (has_commands(options, (command.IsEnabled,))
475
and len(options.client) > 1):
706
476
parser.error("--is-enabled requires exactly one client")
708
options.remove = False
709
if has_actions(options) and not options.deny:
710
parser.error("--remove can only be combined with --deny")
711
options.remove = True
715
parser = argparse.ArgumentParser()
717
add_command_line_options(parser)
719
options = parser.parse_args()
721
check_option_syntax(parser, options)
723
clientnames = options.client
726
log.setLevel(logging.DEBUG)
729
bus = dbus.SystemBus()
730
log.debug("D-Bus: Connect to: (busname=%r, path=%r)", busname,
732
mandos_dbus_objc = bus.get_object(busname, server_path)
733
except dbus.exceptions.DBusException:
734
log.critical("Could not connect to Mandos server")
737
mandos_serv = dbus.Interface(mandos_dbus_objc,
738
dbus_interface=server_interface)
739
mandos_serv_object_manager = dbus.Interface(
740
mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
742
# Filter out log message from dbus module
743
dbus_logger = logging.getLogger("dbus.proxies")
744
class NullFilter(logging.Filter):
745
def filter(self, record):
747
dbus_filter = NullFilter()
749
dbus_logger.addFilter(dbus_filter)
750
log.debug("D-Bus: %s:%s:%s.GetManagedObjects()", busname,
751
server_path, dbus.OBJECT_MANAGER_IFACE)
752
mandos_clients = {path: ifs_and_props[client_interface]
753
for path, ifs_and_props in
754
mandos_serv_object_manager
755
.GetManagedObjects().items()
756
if client_interface in ifs_and_props}
757
except dbus.exceptions.DBusException as e:
758
log.critical("Failed to access Mandos server through D-Bus:"
762
# restore dbus logger
763
dbus_logger.removeFilter(dbus_filter)
765
# Compile dict of (clients: properties) to process
769
clients = {objpath: properties
770
for objpath, properties in mandos_clients.items()}
772
for name in clientnames:
773
for objpath, properties in mandos_clients.items():
774
if properties["Name"] == name:
775
clients[objpath] = properties
778
log.critical("Client not found on server: %r", name)
781
# Run all commands on clients
782
commands = commands_from_options(options)
783
for command in commands:
784
command.run(clients, bus, mandos_serv)
477
if (len(options.commands) > 1
478
and has_commands(options, (command.Remove,))
479
and not has_commands(options, (command.Deny,))):
480
parser.error("--remove can only be combined with --deny")
487
object_manager_iface = "org.freedesktop.DBus.ObjectManager"
488
def get_managed_objects(self, busname, objectpath):
489
return self.call_method("GetManagedObjects", busname,
491
self.object_manager_iface)
493
properties_iface = "org.freedesktop.DBus.Properties"
494
def set_property(self, busname, objectpath, interface, key,
496
self.call_method("Set", busname, objectpath,
497
self.properties_iface, interface, key,
500
class MandosBus(SystemBus):
501
busname_domain = "se.recompile"
502
busname = busname_domain + ".Mandos"
504
server_interface = busname_domain + ".Mandos"
505
client_interface = busname_domain + ".Mandos.Client"
508
def get_clients_and_properties(self):
509
managed_objects = self.get_managed_objects(
510
self.busname, self.server_path)
511
return {objpath: properties[self.client_interface]
512
for objpath, properties in managed_objects.items()
513
if self.client_interface in properties}
515
def set_client_property(self, objectpath, key, value):
516
return self.set_property(self.busname, objectpath,
517
self.client_interface, key,
520
def call_client_method(self, objectpath, method, *args):
521
return self.call_method(method, self.busname, objectpath,
522
self.client_interface, *args)
524
def call_server_method(self, method, *args):
525
return self.call_method(method, self.busname,
527
self.server_interface, *args)
529
class Error(Exception):
532
class ConnectFailed(Error):
536
class dbus_python_adapter:
538
class SystemBus(dbus.MandosBus):
539
"""Use dbus-python"""
541
def __init__(self, module=dbus_python):
542
self.dbus_python = module
543
self.bus = self.dbus_python.SystemBus()
545
@contextlib.contextmanager
546
def convert_exception(self, exception_class=dbus.Error):
549
except self.dbus_python.exceptions.DBusException as e:
550
# This does what "raise from" would do
551
exc = exception_class(*e.args)
555
def call_method(self, methodname, busname, objectpath,
557
proxy_object = self.get_object(busname, objectpath)
558
log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
559
interface, methodname,
560
", ".join(repr(a) for a in args))
561
method = getattr(proxy_object, methodname)
562
with self.convert_exception():
563
with dbus_python_adapter.SilenceLogger(
565
value = method(*args, dbus_interface=interface)
566
return self.type_filter(value)
568
def get_object(self, busname, objectpath):
569
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
571
with self.convert_exception(dbus.ConnectFailed):
572
return self.bus.get_object(busname, objectpath)
574
def type_filter(self, value):
575
"""Convert the most bothersome types to Python types"""
576
if isinstance(value, self.dbus_python.Boolean):
578
if isinstance(value, self.dbus_python.ObjectPath):
580
# Also recurse into dictionaries
581
if isinstance(value, self.dbus_python.Dictionary):
582
return {self.type_filter(key):
583
self.type_filter(subval)
584
for key, subval in value.items()}
587
def set_client_property(self, objectpath, key, value):
589
if not isinstance(value, bytes):
590
value = value.encode("utf-8")
591
value = self.dbus_python.ByteArray(value)
592
return self.set_property(self.busname, objectpath,
593
self.client_interface, key,
597
"Simple context manager to silence a particular logger"
598
def __init__(self, loggername):
599
self.logger = logging.getLogger(loggername)
602
self.logger.addFilter(self.nullfilter)
604
class NullFilter(logging.Filter):
605
def filter(self, record):
608
nullfilter = NullFilter()
610
def __exit__(self, exc_type, exc_val, exc_tb):
611
self.logger.removeFilter(self.nullfilter)
614
class CachingBus(SystemBus):
615
"""A caching layer for dbus_python_adapter.SystemBus"""
616
def __init__(self, *args, **kwargs):
617
self.object_cache = {}
618
super(dbus_python_adapter.CachingBus,
619
self).__init__(*args, **kwargs)
620
def get_object(self, busname, objectpath):
622
return self.object_cache[(busname, objectpath)]
625
dbus_python_adapter.CachingBus,
626
self).get_object(busname, objectpath)
627
self.object_cache[(busname, objectpath)] = new_object
631
class pydbus_adapter:
632
class SystemBus(dbus.MandosBus):
633
def __init__(self, module=pydbus):
635
self.bus = self.pydbus.SystemBus()
637
@contextlib.contextmanager
638
def convert_exception(self, exception_class=dbus.Error):
641
except gi.repository.GLib.Error as e:
642
# This does what "raise from" would do
643
exc = exception_class(*e.args)
647
def call_method(self, methodname, busname, objectpath,
649
proxy_object = self.get(busname, objectpath)
650
log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
651
interface, methodname,
652
", ".join(repr(a) for a in args))
653
method = getattr(proxy_object[interface], methodname)
654
with self.convert_exception():
657
def get(self, busname, objectpath):
658
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
660
with self.convert_exception(dbus.ConnectFailed):
661
if sys.version_info.major <= 2:
662
with warnings.catch_warnings():
663
warnings.filterwarnings(
664
"ignore", "", DeprecationWarning,
665
r"^xml\.etree\.ElementTree$")
666
return self.bus.get(busname, objectpath)
668
return self.bus.get(busname, objectpath)
670
def set_property(self, busname, objectpath, interface, key,
672
proxy_object = self.get(busname, objectpath)
673
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", busname,
674
objectpath, self.properties_iface, interface,
676
setattr(proxy_object[interface], key, value)
678
class CachingBus(SystemBus):
679
"""A caching layer for pydbus_adapter.SystemBus"""
680
def __init__(self, *args, **kwargs):
681
self.object_cache = {}
682
super(pydbus_adapter.CachingBus,
683
self).__init__(*args, **kwargs)
684
def get(self, busname, objectpath):
686
return self.object_cache[(busname, objectpath)]
688
new_object = (super(pydbus_adapter.CachingBus, self)
689
.get(busname, objectpath))
690
self.object_cache[(busname, objectpath)] = new_object
694
class dbussy_adapter:
695
class SystemBus(dbus.SystemBus):
698
def __init__(self, dbussy, ravel):
701
self.bus = ravel.system_bus()
703
@contextlib.contextmanager
704
def convert_exception(self, exception_class=dbus.Error):
707
except self.dbussy.DBusError as e:
708
# This does what "raise from" would do
709
exc = exception_class(*e.args)
713
def call_method(self, methodname, busname, objectpath,
715
proxy_object = self.get_object(busname, objectpath)
716
log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
717
interface, methodname,
718
", ".join(repr(a) for a in args))
719
iface = proxy_object.get_interface(interface)
720
method = getattr(iface, methodname)
721
with self.convert_exception(dbus.Error):
722
value = method(*args)
723
# DBussy returns values either as an empty list or as a
724
# tuple: (signature, value)
726
return self.type_filter(value[0])
728
def get_object(self, busname, objectpath):
729
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
731
with self.convert_exception(dbus.ConnectFailed):
732
return self.bus[busname][objectpath]
734
def type_filter(self, value):
735
"""Convert the most bothersome types to Python types"""
736
if isinstance(value, tuple):
738
and isinstance(value[0],
739
self.dbussy.DBUS.Signature)):
740
return self.type_filter(value[1])
741
elif isinstance(value, self.dbussy.DBUS.ObjectPath):
743
# Also recurse into dictionaries
744
elif isinstance(value, dict):
745
return {self.type_filter(key):
746
self.type_filter(subval)
747
for key, subval in value.items()}
750
def set_property(self, busname, objectpath, interface, key,
752
proxy_object = self.get_object(busname, objectpath)
753
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", busname,
754
objectpath, self.properties_iface, interface,
757
# DBussy wants a Byte Array to be a sequence of
758
# values, not a byte string
760
setattr(proxy_object.get_interface(interface), key, value)
762
class MandosBus(SystemBus, dbus.MandosBus):
765
class CachingBus(MandosBus):
766
"""A caching layer for dbussy_adapter.MandosBus"""
767
def __init__(self, *args, **kwargs):
768
self.object_cache = {}
769
super(dbussy_adapter.CachingBus, self).__init__(*args,
771
def get_object(self, busname, objectpath):
773
return self.object_cache[(busname, objectpath)]
776
dbussy_adapter.CachingBus,
777
self).get_object(busname, objectpath)
778
self.object_cache[(busname, objectpath)] = new_object
782
def commands_from_options(options):
784
commands = list(options.commands)
786
def find_cmd(cmd, commands):
788
for i, c in enumerate(commands):
789
if isinstance(c, cmd):
793
# If command.Remove is present, move any instances of command.Deny
794
# to occur ahead of command.Remove.
795
index_of_remove = find_cmd(command.Remove, commands)
796
before_remove = commands[:index_of_remove]
797
after_remove = commands[index_of_remove:]
799
for cmd in after_remove:
800
if isinstance(cmd, command.Deny):
801
before_remove.append(cmd)
803
cleaned_after.append(cmd)
804
if cleaned_after != after_remove:
805
commands = before_remove + cleaned_after
807
# If no command option has been given, show table of clients,
808
# optionally verbosely
810
commands.append(command.PrintTable(verbose=options.verbose))
816
"""A namespace for command classes"""
819
"""Abstract base class for commands"""
820
def run(self, clients, bus=None):
821
"""Normal commands should implement run_on_one_client(),
822
but commands which want to operate on all clients at the same time can
823
override this run() method instead.
826
for client, properties in clients.items():
827
self.run_on_one_client(client, properties)
830
class IsEnabled(Base):
831
def run(self, clients, bus=None):
832
properties = next(iter(clients.values()))
833
if properties["Enabled"]:
839
def run_on_one_client(self, client, properties):
840
self.bus.call_client_method(client, "Approve", True)
844
def run_on_one_client(self, client, properties):
845
self.bus.call_client_method(client, "Approve", False)
849
def run(self, clients, bus):
850
for clientpath in frozenset(clients.keys()):
851
bus.call_server_method("RemoveClient", clientpath)
855
"""Abstract class for commands outputting client details"""
856
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
857
"Created", "Interval", "Host", "KeyID",
858
"Fingerprint", "CheckerRunning",
859
"LastEnabled", "ApprovalPending",
860
"ApprovedByDefault", "LastApprovalRequest",
861
"ApprovalDelay", "ApprovalDuration",
862
"Checker", "ExtendedTimeout", "Expires",
866
class DumpJSON(Output):
867
def run(self, clients, bus=None):
868
data = {properties["Name"]:
869
{key: properties[key]
870
for key in self.all_keywords}
871
for properties in clients.values()}
872
print(json.dumps(data, indent=4, separators=(',', ': ')))
875
class PrintTable(Output):
876
def __init__(self, verbose=False):
877
self.verbose = verbose
879
def run(self, clients, bus=None):
880
default_keywords = ("Name", "Enabled", "Timeout",
882
keywords = default_keywords
884
keywords = self.all_keywords
885
print(self.TableOfClients(clients.values(), keywords))
887
class TableOfClients:
890
"Enabled": "Enabled",
891
"Timeout": "Timeout",
892
"LastCheckedOK": "Last Successful Check",
893
"LastApprovalRequest": "Last Approval Request",
894
"Created": "Created",
895
"Interval": "Interval",
897
"Fingerprint": "Fingerprint",
899
"CheckerRunning": "Check Is Running",
900
"LastEnabled": "Last Enabled",
901
"ApprovalPending": "Approval Is Pending",
902
"ApprovedByDefault": "Approved By Default",
903
"ApprovalDelay": "Approval Delay",
904
"ApprovalDuration": "Approval Duration",
905
"Checker": "Checker",
906
"ExtendedTimeout": "Extended Timeout",
907
"Expires": "Expires",
908
"LastCheckerStatus": "Last Checker Status",
911
def __init__(self, clients, keywords):
912
self.clients = clients
913
self.keywords = keywords
916
return "\n".join(self.rows())
918
if sys.version_info.major == 2:
919
__unicode__ = __str__
921
return str(self).encode(
922
locale.getpreferredencoding())
925
format_string = self.row_formatting_string()
926
rows = [self.header_line(format_string)]
927
rows.extend(self.client_line(client, format_string)
928
for client in self.clients)
931
def row_formatting_string(self):
932
"Format string used to format table rows"
933
return " ".join("{{{key}:{width}}}".format(
934
width=max(len(self.tableheaders[key]),
935
*(len(self.string_from_client(client,
937
for client in self.clients)),
939
for key in self.keywords)
941
def string_from_client(self, client, key):
942
return self.valuetostring(client[key], key)
945
def valuetostring(cls, value, keyword):
946
if isinstance(value, bool):
947
return "Yes" if value else "No"
948
if keyword in ("Timeout", "Interval", "ApprovalDelay",
949
"ApprovalDuration", "ExtendedTimeout"):
950
return cls.milliseconds_to_string(value)
953
def header_line(self, format_string):
954
return format_string.format(**self.tableheaders)
956
def client_line(self, client, format_string):
957
return format_string.format(
958
**{key: self.string_from_client(client, key)
959
for key in self.keywords})
962
def milliseconds_to_string(ms):
963
td = datetime.timedelta(0, 0, 0, ms)
964
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
965
.format(days="{}T".format(td.days)
967
hours=td.seconds // 3600,
968
minutes=(td.seconds % 3600) // 60,
969
seconds=td.seconds % 60))
972
class PropertySetter(Base):
973
"Abstract class for Actions for setting one client property"
975
def run_on_one_client(self, client, properties=None):
976
"""Set the Client's D-Bus property"""
977
self.bus.set_client_property(client, self.propname,
982
raise NotImplementedError()
985
class Enable(PropertySetter):
990
class Disable(PropertySetter):
995
class BumpTimeout(PropertySetter):
996
propname = "LastCheckedOK"
1000
class StartChecker(PropertySetter):
1001
propname = "CheckerRunning"
1005
class StopChecker(PropertySetter):
1006
propname = "CheckerRunning"
1007
value_to_set = False
1010
class ApproveByDefault(PropertySetter):
1011
propname = "ApprovedByDefault"
1015
class DenyByDefault(PropertySetter):
1016
propname = "ApprovedByDefault"
1017
value_to_set = False
1020
class PropertySetterValue(PropertySetter):
1021
"""Abstract class for PropertySetter recieving a value as
1022
constructor argument instead of a class attribute."""
1023
def __init__(self, value):
1024
self.value_to_set = value
1027
def argparse(cls, argtype):
1029
return cls(argtype(arg))
1032
class SetChecker(PropertySetterValue):
1033
propname = "Checker"
1036
class SetHost(PropertySetterValue):
1040
class SetSecret(PropertySetterValue):
1044
def value_to_set(self):
1047
@value_to_set.setter
1048
def value_to_set(self, value):
1049
"""When setting, read data from supplied file object"""
1050
self._vts = value.read()
1054
class PropertySetterValueMilliseconds(PropertySetterValue):
1055
"""Abstract class for PropertySetterValue taking a value
1056
argument as a datetime.timedelta() but should store it as
1060
def value_to_set(self):
1063
@value_to_set.setter
1064
def value_to_set(self, value):
1065
"When setting, convert value from a datetime.timedelta"
1066
self._vts = int(round(value.total_seconds() * 1000))
1069
class SetTimeout(PropertySetterValueMilliseconds):
1070
propname = "Timeout"
1073
class SetExtendedTimeout(PropertySetterValueMilliseconds):
1074
propname = "ExtendedTimeout"
1077
class SetInterval(PropertySetterValueMilliseconds):
1078
propname = "Interval"
1081
class SetApprovalDelay(PropertySetterValueMilliseconds):
1082
propname = "ApprovalDelay"
1085
class SetApprovalDuration(PropertySetterValueMilliseconds):
1086
propname = "ApprovalDuration"
787
class Test_milliseconds_to_string(unittest.TestCase):
789
self.assertEqual(milliseconds_to_string(93785000),
791
def test_no_days(self):
792
self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
793
def test_all_zero(self):
794
self.assertEqual(milliseconds_to_string(0), "00:00:00")
795
def test_no_fractional_seconds(self):
796
self.assertEqual(milliseconds_to_string(400), "00:00:00")
797
self.assertEqual(milliseconds_to_string(900), "00:00:00")
798
self.assertEqual(milliseconds_to_string(1900), "00:00:01")
800
class Test_string_to_delta(unittest.TestCase):
801
def test_handles_basic_rfc3339(self):
802
self.assertEqual(string_to_delta("PT0S"),
803
datetime.timedelta())
804
self.assertEqual(string_to_delta("P0D"),
805
datetime.timedelta())
806
self.assertEqual(string_to_delta("PT1S"),
807
datetime.timedelta(0, 1))
808
self.assertEqual(string_to_delta("PT2H"),
809
datetime.timedelta(0, 7200))
1090
class TestCaseWithAssertLogs(unittest.TestCase):
1091
"""unittest.TestCase.assertLogs only exists in Python 3.4"""
1093
if not hasattr(unittest.TestCase, "assertLogs"):
1094
@contextlib.contextmanager
1095
def assertLogs(self, logger, level=logging.INFO):
1096
capturing_handler = self.CapturingLevelHandler(level)
1097
old_level = logger.level
1098
old_propagate = logger.propagate
1099
logger.addHandler(capturing_handler)
1100
logger.setLevel(level)
1101
logger.propagate = False
1103
yield capturing_handler.watcher
1105
logger.propagate = old_propagate
1106
logger.removeHandler(capturing_handler)
1107
logger.setLevel(old_level)
1108
self.assertGreater(len(capturing_handler.watcher.records),
1111
class CapturingLevelHandler(logging.Handler):
1112
def __init__(self, level, *args, **kwargs):
1113
logging.Handler.__init__(self, *args, **kwargs)
1114
self.watcher = self.LoggingWatcher([], [])
1115
def emit(self, record):
1116
self.watcher.records.append(record)
1117
self.watcher.output.append(self.format(record))
1119
LoggingWatcher = collections.namedtuple("LoggingWatcher",
1125
"""Class for objects which exist only to be unique objects, since
1126
unittest.mock.sentinel only exists in Python 3.3"""
1129
class Test_string_to_delta(TestCaseWithAssertLogs):
1130
# Just test basic RFC 3339 functionality here, the doc string for
1131
# rfc3339_duration_to_delta() already has more comprehensive
1132
# tests, which are run by doctest.
1134
def test_rfc3339_zero_seconds(self):
1135
self.assertEqual(datetime.timedelta(),
1136
string_to_delta("PT0S"))
1138
def test_rfc3339_zero_days(self):
1139
self.assertEqual(datetime.timedelta(), string_to_delta("P0D"))
1141
def test_rfc3339_one_second(self):
1142
self.assertEqual(datetime.timedelta(0, 1),
1143
string_to_delta("PT1S"))
1145
def test_rfc3339_two_hours(self):
1146
self.assertEqual(datetime.timedelta(0, 7200),
1147
string_to_delta("PT2H"))
810
1149
def test_falls_back_to_pre_1_6_1_with_warning(self):
811
# assertLogs only exists in Python 3.4
812
if hasattr(self, "assertLogs"):
813
with self.assertLogs(log, logging.WARNING):
814
value = string_to_delta("2h")
1150
with self.assertLogs(log, logging.WARNING):
1151
value = string_to_delta("2h")
1152
self.assertEqual(datetime.timedelta(0, 7200), value)
1155
class Test_check_option_syntax(unittest.TestCase):
1157
self.parser = argparse.ArgumentParser()
1158
add_command_line_options(self.parser)
1160
def test_actions_requires_client_or_all(self):
1161
for action, value in self.actions.items():
1162
args = self.actionargs(action, value)
1163
with self.assertParseError():
1164
self.parse_args(args)
1166
# This mostly corresponds to the definition from has_commands() in
1167
# check_option_syntax()
1171
"--bump-timeout": None,
1172
"--start-checker": None,
1173
"--stop-checker": None,
1174
"--is-enabled": None,
1177
"--timeout": "PT0S",
1178
"--extended-timeout": "PT0S",
1179
"--interval": "PT0S",
1180
"--approve-by-default": None,
1181
"--deny-by-default": None,
1182
"--approval-delay": "PT0S",
1183
"--approval-duration": "PT0S",
1184
"--host": "hostname",
1185
"--secret": "/dev/null",
1191
def actionargs(action, value, *args):
1192
if value is not None:
1193
return [action, value] + list(args)
816
class WarningFilter(logging.Filter):
817
"""Don't show, but record the presence of, warnings"""
818
def filter(self, record):
819
is_warning = record.levelno >= logging.WARNING
820
self.found = is_warning or getattr(self, "found",
822
return not is_warning
823
warning_filter = WarningFilter()
824
log.addFilter(warning_filter)
1195
return [action] + list(args)
1197
@contextlib.contextmanager
1198
def assertParseError(self):
1199
with self.assertRaises(SystemExit) as e:
1200
with self.redirect_stderr_to_devnull():
1202
# Exit code from argparse is guaranteed to be "2". Reference:
1203
# https://docs.python.org/3/library
1204
# /argparse.html#exiting-methods
1205
self.assertEqual(2, e.exception.code)
1207
def parse_args(self, args):
1208
options = self.parser.parse_args(args)
1209
check_option_syntax(self.parser, options)
1212
@contextlib.contextmanager
1213
def redirect_stderr_to_devnull():
1214
old_stderr = sys.stderr
1215
with contextlib.closing(open(os.devnull, "w")) as null:
826
value = string_to_delta("2h")
828
log.removeFilter(warning_filter)
829
self.assertTrue(getattr(warning_filter, "found", False))
830
self.assertEqual(value, datetime.timedelta(0, 7200))
833
class TestCmd(unittest.TestCase):
1220
sys.stderr = old_stderr
1222
def check_option_syntax(self, options):
1223
check_option_syntax(self.parser, options)
1225
def test_actions_all_conflicts_with_verbose(self):
1226
for action, value in self.actions.items():
1227
args = self.actionargs(action, value, "--all",
1229
with self.assertParseError():
1230
self.parse_args(args)
1232
def test_actions_with_client_conflicts_with_verbose(self):
1233
for action, value in self.actions.items():
1234
args = self.actionargs(action, value, "--verbose",
1236
with self.assertParseError():
1237
self.parse_args(args)
1239
def test_dump_json_conflicts_with_verbose(self):
1240
args = ["--dump-json", "--verbose"]
1241
with self.assertParseError():
1242
self.parse_args(args)
1244
def test_dump_json_conflicts_with_action(self):
1245
for action, value in self.actions.items():
1246
args = self.actionargs(action, value, "--dump-json")
1247
with self.assertParseError():
1248
self.parse_args(args)
1250
def test_all_can_not_be_alone(self):
1252
with self.assertParseError():
1253
self.parse_args(args)
1255
def test_all_is_ok_with_any_action(self):
1256
for action, value in self.actions.items():
1257
args = self.actionargs(action, value, "--all")
1258
self.parse_args(args)
1260
def test_any_action_is_ok_with_one_client(self):
1261
for action, value in self.actions.items():
1262
args = self.actionargs(action, value, "client")
1263
self.parse_args(args)
1265
def test_one_client_with_all_actions_except_is_enabled(self):
1266
for action, value in self.actions.items():
1267
if action == "--is-enabled":
1269
args = self.actionargs(action, value, "client")
1270
self.parse_args(args)
1272
def test_two_clients_with_all_actions_except_is_enabled(self):
1273
for action, value in self.actions.items():
1274
if action == "--is-enabled":
1276
args = self.actionargs(action, value, "client1",
1278
self.parse_args(args)
1280
def test_two_clients_are_ok_with_actions_except_is_enabled(self):
1281
for action, value in self.actions.items():
1282
if action == "--is-enabled":
1284
args = self.actionargs(action, value, "client1",
1286
self.parse_args(args)
1288
def test_is_enabled_fails_without_client(self):
1289
args = ["--is-enabled"]
1290
with self.assertParseError():
1291
self.parse_args(args)
1293
def test_is_enabled_fails_with_two_clients(self):
1294
args = ["--is-enabled", "client1", "client2"]
1295
with self.assertParseError():
1296
self.parse_args(args)
1298
def test_remove_can_only_be_combined_with_action_deny(self):
1299
for action, value in self.actions.items():
1300
if action in {"--remove", "--deny"}:
1302
args = self.actionargs(action, value, "--all",
1304
with self.assertParseError():
1305
self.parse_args(args)
1308
class Test_dbus_exceptions(unittest.TestCase):
1310
def test_dbus_ConnectFailed_is_Error(self):
1311
with self.assertRaises(dbus.Error):
1312
raise dbus.ConnectFailed()
1315
class Test_dbus_MandosBus(unittest.TestCase):
1317
class MockMandosBus(dbus.MandosBus):
1319
self._name = "se.recompile.Mandos"
1320
self._server_path = "/"
1321
self._server_interface = "se.recompile.Mandos"
1322
self._client_interface = "se.recompile.Mandos.Client"
1324
self.call_method_return = Unique()
1326
def call_method(self, methodname, busname, objectpath,
1328
self.calls.append((methodname, busname, objectpath,
1330
return self.call_method_return
1333
self.bus = self.MockMandosBus()
1335
def test_set_client_property(self):
1336
self.bus.set_client_property("objectpath", "key", "value")
1337
expected_call = ("Set", self.bus._name, "objectpath",
1338
"org.freedesktop.DBus.Properties",
1339
(self.bus._client_interface, "key", "value"))
1340
self.assertIn(expected_call, self.bus.calls)
1342
def test_call_client_method(self):
1343
ret = self.bus.call_client_method("objectpath", "methodname")
1344
self.assertIs(self.bus.call_method_return, ret)
1345
expected_call = ("methodname", self.bus._name, "objectpath",
1346
self.bus._client_interface, ())
1347
self.assertIn(expected_call, self.bus.calls)
1349
def test_call_client_method_with_args(self):
1350
args = (Unique(), Unique())
1351
ret = self.bus.call_client_method("objectpath", "methodname",
1353
self.assertIs(self.bus.call_method_return, ret)
1354
expected_call = ("methodname", self.bus._name, "objectpath",
1355
self.bus._client_interface,
1357
self.assertIn(expected_call, self.bus.calls)
1359
def test_get_clients_and_properties(self):
1362
self.bus._client_interface: {
1366
"irrelevant_interface": {
1367
"key": "othervalue",
1371
"other_objectpath": {
1372
"other_irrelevant_interface": {
1378
expected_clients_and_properties = {
1384
self.bus.call_method_return = managed_objects
1385
ret = self.bus.get_clients_and_properties()
1386
self.assertDictEqual(expected_clients_and_properties, ret)
1387
expected_call = ("GetManagedObjects", self.bus._name,
1388
self.bus._server_path,
1389
"org.freedesktop.DBus.ObjectManager", ())
1390
self.assertIn(expected_call, self.bus.calls)
1392
def test_call_server_method(self):
1393
ret = self.bus.call_server_method("methodname")
1394
self.assertIs(self.bus.call_method_return, ret)
1395
expected_call = ("methodname", self.bus._name,
1396
self.bus._server_path,
1397
self.bus._server_interface, ())
1398
self.assertIn(expected_call, self.bus.calls)
1400
def test_call_server_method_with_args(self):
1401
args = (Unique(), Unique())
1402
ret = self.bus.call_server_method("methodname", *args)
1403
self.assertIs(self.bus.call_method_return, ret)
1404
expected_call = ("methodname", self.bus._name,
1405
self.bus._server_path,
1406
self.bus._server_interface,
1408
self.assertIn(expected_call, self.bus.calls)
1411
class Test_dbus_python_adapter_SystemBus(TestCaseWithAssertLogs):
1413
def MockDBusPython_func(self, func):
1414
class mock_dbus_python:
1415
"""mock dbus-python module"""
1417
"""Pseudo-namespace"""
1418
class DBusException(Exception):
1422
def get_object(busname, objectpath):
1423
DBusObject = collections.namedtuple(
1424
"DBusObject", ("methodname", "Set"))
1425
def method(*args, **kwargs):
1426
self.assertEqual({"dbus_interface":
1430
def set_property(interface, key, value,
1431
dbus_interface=None):
1433
"org.freedesktop.DBus.Properties",
1435
self.assertEqual("Secret", key)
1436
return func(interface, key, value,
1437
dbus_interface=dbus_interface)
1438
return DBusObject(methodname=method,
1441
def __init__(self, value):
1442
self.value = bool(value)
1445
if sys.version_info.major == 2:
1446
__nonzero__ = __bool__
1447
class ObjectPath(str):
1449
class Dictionary(dict):
1451
class ByteArray(bytes):
1453
return mock_dbus_python
1455
def call_method(self, bus, methodname, busname, objectpath,
1457
with self.assertLogs(log, logging.DEBUG):
1458
return bus.call_method(methodname, busname, objectpath,
1461
def test_call_method_returns(self):
1462
expected_method_return = Unique()
1463
method_args = (Unique(), Unique())
1465
self.assertEqual(len(method_args), len(args))
1466
for marg, arg in zip(method_args, args):
1467
self.assertIs(marg, arg)
1468
return expected_method_return
1469
mock_dbus_python = self.MockDBusPython_func(func)
1470
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1471
ret = self.call_method(bus, "methodname", "busname",
1472
"objectpath", "interface",
1474
self.assertIs(ret, expected_method_return)
1476
def test_call_method_filters_bool_true(self):
1478
return method_return
1479
mock_dbus_python = self.MockDBusPython_func(func)
1480
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1481
method_return = mock_dbus_python.Boolean(True)
1482
ret = self.call_method(bus, "methodname", "busname",
1483
"objectpath", "interface")
1484
self.assertTrue(ret)
1485
self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1487
def test_call_method_filters_bool_false(self):
1489
return method_return
1490
mock_dbus_python = self.MockDBusPython_func(func)
1491
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1492
method_return = mock_dbus_python.Boolean(False)
1493
ret = self.call_method(bus, "methodname", "busname",
1494
"objectpath", "interface")
1495
self.assertFalse(ret)
1496
self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1498
def test_call_method_filters_objectpath(self):
1500
return method_return
1501
mock_dbus_python = self.MockDBusPython_func(func)
1502
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1503
method_return = mock_dbus_python.ObjectPath("objectpath")
1504
ret = self.call_method(bus, "methodname", "busname",
1505
"objectpath", "interface")
1506
self.assertEqual("objectpath", ret)
1507
self.assertIsNot("objectpath", ret)
1508
self.assertNotIsInstance(ret, mock_dbus_python.ObjectPath)
1510
def test_call_method_filters_booleans_in_dict(self):
1512
return method_return
1513
mock_dbus_python = self.MockDBusPython_func(func)
1514
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1515
method_return = mock_dbus_python.Dictionary(
1516
{mock_dbus_python.Boolean(True):
1517
mock_dbus_python.Boolean(False),
1518
mock_dbus_python.Boolean(False):
1519
mock_dbus_python.Boolean(True)})
1520
ret = self.call_method(bus, "methodname", "busname",
1521
"objectpath", "interface")
1522
expected_method_return = {True: False,
1524
self.assertEqual(expected_method_return, ret)
1525
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1527
def test_call_method_filters_objectpaths_in_dict(self):
1529
return method_return
1530
mock_dbus_python = self.MockDBusPython_func(func)
1531
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1532
method_return = mock_dbus_python.Dictionary(
1533
{mock_dbus_python.ObjectPath("objectpath_key_1"):
1534
mock_dbus_python.ObjectPath("objectpath_value_1"),
1535
mock_dbus_python.ObjectPath("objectpath_key_2"):
1536
mock_dbus_python.ObjectPath("objectpath_value_2")})
1537
ret = self.call_method(bus, "methodname", "busname",
1538
"objectpath", "interface")
1539
expected_method_return = {str(key): str(value)
1541
method_return.items()}
1542
self.assertEqual(expected_method_return, ret)
1543
self.assertIsInstance(ret, dict)
1544
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1546
def test_call_method_filters_dict_in_dict(self):
1548
return method_return
1549
mock_dbus_python = self.MockDBusPython_func(func)
1550
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1551
method_return = mock_dbus_python.Dictionary(
1552
{"key1": mock_dbus_python.Dictionary({"key11": "value11",
1553
"key12": "value12"}),
1554
"key2": mock_dbus_python.Dictionary({"key21": "value21",
1555
"key22": "value22"})})
1556
ret = self.call_method(bus, "methodname", "busname",
1557
"objectpath", "interface")
1558
expected_method_return = {
1559
"key1": {"key11": "value11",
1560
"key12": "value12"},
1561
"key2": {"key21": "value21",
1562
"key22": "value22"},
1564
self.assertEqual(expected_method_return, ret)
1565
self.assertIsInstance(ret, dict)
1566
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1567
for key, value in ret.items():
1568
self.assertIsInstance(value, dict)
1569
self.assertEqual(expected_method_return[key], value)
1570
self.assertNotIsInstance(value,
1571
mock_dbus_python.Dictionary)
1573
def test_call_method_filters_dict_three_deep(self):
1575
return method_return
1576
mock_dbus_python = self.MockDBusPython_func(func)
1577
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1578
method_return = mock_dbus_python.Dictionary(
1580
mock_dbus_python.Dictionary(
1582
mock_dbus_python.Dictionary(
1584
mock_dbus_python.Boolean(True),
1588
ret = self.call_method(bus, "methodname", "busname",
1589
"objectpath", "interface")
1590
expected_method_return = {"key1": {"key2": {"key3": True}}}
1591
self.assertEqual(expected_method_return, ret)
1592
self.assertIsInstance(ret, dict)
1593
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1594
self.assertIsInstance(ret["key1"], dict)
1595
self.assertNotIsInstance(ret["key1"],
1596
mock_dbus_python.Dictionary)
1597
self.assertIsInstance(ret["key1"]["key2"], dict)
1598
self.assertNotIsInstance(ret["key1"]["key2"],
1599
mock_dbus_python.Dictionary)
1600
self.assertTrue(ret["key1"]["key2"]["key3"])
1601
self.assertNotIsInstance(ret["key1"]["key2"]["key3"],
1602
mock_dbus_python.Boolean)
1604
def test_call_method_handles_exception(self):
1605
dbus_logger = logging.getLogger("dbus.proxies")
1608
dbus_logger.error("Test")
1609
raise mock_dbus_python.exceptions.DBusException()
1611
mock_dbus_python = self.MockDBusPython_func(func)
1612
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1614
class CountingHandler(logging.Handler):
1616
def emit(self, record):
1619
counting_handler = CountingHandler()
1621
dbus_logger.addHandler(counting_handler)
1624
with self.assertRaises(dbus.Error) as e:
1625
self.call_method(bus, "methodname", "busname",
1626
"objectpath", "interface")
1628
dbus_logger.removeFilter(counting_handler)
1630
self.assertNotIsInstance(e, dbus.ConnectFailed)
1632
# Make sure the dbus logger was suppressed
1633
self.assertEqual(0, counting_handler.count)
1635
def test_Set_Secret_sends_bytearray(self):
1637
def func(*args, **kwargs):
1638
ret[0] = (args, kwargs)
1639
mock_dbus_python = self.MockDBusPython_func(func)
1640
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1641
bus.set_client_property("objectpath", "Secret", "value")
1642
expected_call = (("se.recompile.Mandos.Client", "Secret",
1643
mock_dbus_python.ByteArray(b"value")),
1645
"org.freedesktop.DBus.Properties"})
1646
self.assertEqual(expected_call, ret[0])
1647
if sys.version_info.major == 2:
1648
self.assertIsInstance(ret[0][0][-1],
1649
mock_dbus_python.ByteArray)
1651
def test_get_object_converts_to_correct_exception(self):
1652
bus = dbus_python_adapter.SystemBus(
1653
self.fake_dbus_python_raises_exception_on_connect)
1654
with self.assertRaises(dbus.ConnectFailed):
1655
self.call_method(bus, "methodname", "busname",
1656
"objectpath", "interface")
1658
class fake_dbus_python_raises_exception_on_connect:
1659
"""fake dbus-python module"""
1661
"""Pseudo-namespace"""
1662
class DBusException(Exception):
1667
def get_object(busname, objectpath):
1668
raise cls.exceptions.DBusException()
1669
Bus = collections.namedtuple("Bus", ["get_object"])
1670
return Bus(get_object=get_object)
1673
class Test_dbus_python_adapter_CachingBus(unittest.TestCase):
1674
class mock_dbus_python:
1675
"""mock dbus-python modules"""
1678
def get_object(busname, objectpath):
1682
self.bus = dbus_python_adapter.CachingBus(
1683
self.mock_dbus_python)
1685
def test_returns_distinct_objectpaths(self):
1686
obj1 = self.bus.get_object("busname", "objectpath1")
1687
self.assertIsInstance(obj1, Unique)
1688
obj2 = self.bus.get_object("busname", "objectpath2")
1689
self.assertIsInstance(obj2, Unique)
1690
self.assertIsNot(obj1, obj2)
1692
def test_returns_distinct_busnames(self):
1693
obj1 = self.bus.get_object("busname1", "objectpath")
1694
self.assertIsInstance(obj1, Unique)
1695
obj2 = self.bus.get_object("busname2", "objectpath")
1696
self.assertIsInstance(obj2, Unique)
1697
self.assertIsNot(obj1, obj2)
1699
def test_returns_distinct_both(self):
1700
obj1 = self.bus.get_object("busname1", "objectpath")
1701
self.assertIsInstance(obj1, Unique)
1702
obj2 = self.bus.get_object("busname2", "objectpath")
1703
self.assertIsInstance(obj2, Unique)
1704
self.assertIsNot(obj1, obj2)
1706
def test_returns_same(self):
1707
obj1 = self.bus.get_object("busname", "objectpath")
1708
self.assertIsInstance(obj1, Unique)
1709
obj2 = self.bus.get_object("busname", "objectpath")
1710
self.assertIsInstance(obj2, Unique)
1711
self.assertIs(obj1, obj2)
1713
def test_returns_same_old(self):
1714
obj1 = self.bus.get_object("busname1", "objectpath1")
1715
self.assertIsInstance(obj1, Unique)
1716
obj2 = self.bus.get_object("busname2", "objectpath2")
1717
self.assertIsInstance(obj2, Unique)
1718
obj1b = self.bus.get_object("busname1", "objectpath1")
1719
self.assertIsInstance(obj1b, Unique)
1720
self.assertIsNot(obj1, obj2)
1721
self.assertIsNot(obj2, obj1b)
1722
self.assertIs(obj1, obj1b)
1725
class Test_pydbus_adapter_SystemBus(TestCaseWithAssertLogs):
1727
def Stub_pydbus_func(self, func):
1729
"""stub pydbus module"""
1732
def get(busname, objectpath):
1733
DBusObject = collections.namedtuple(
1734
"DBusObject", ("methodname",))
1735
return {"interface":
1736
DBusObject(methodname=func)}
1739
def call_method(self, bus, methodname, busname, objectpath,
1741
with self.assertLogs(log, logging.DEBUG):
1742
return bus.call_method(methodname, busname, objectpath,
1745
def test_call_method_returns(self):
1746
expected_method_return = Unique()
1747
method_args = (Unique(), Unique())
1749
self.assertEqual(len(method_args), len(args))
1750
for marg, arg in zip(method_args, args):
1751
self.assertIs(marg, arg)
1752
return expected_method_return
1753
stub_pydbus = self.Stub_pydbus_func(func)
1754
bus = pydbus_adapter.SystemBus(stub_pydbus)
1755
ret = self.call_method(bus, "methodname", "busname",
1756
"objectpath", "interface",
1758
self.assertIs(ret, expected_method_return)
1760
def test_call_method_handles_exception(self):
1761
dbus_logger = logging.getLogger("dbus.proxies")
1764
raise gi.repository.GLib.Error()
1766
stub_pydbus = self.Stub_pydbus_func(func)
1767
bus = pydbus_adapter.SystemBus(stub_pydbus)
1769
with self.assertRaises(dbus.Error) as e:
1770
self.call_method(bus, "methodname", "busname",
1771
"objectpath", "interface")
1773
self.assertNotIsInstance(e, dbus.ConnectFailed)
1775
def test_get_converts_to_correct_exception(self):
1776
bus = pydbus_adapter.SystemBus(
1777
self.fake_pydbus_raises_exception_on_connect)
1778
with self.assertRaises(dbus.ConnectFailed):
1779
self.call_method(bus, "methodname", "busname",
1780
"objectpath", "interface")
1782
class fake_pydbus_raises_exception_on_connect:
1783
"""fake dbus-python module"""
1786
def get(busname, objectpath):
1787
raise gi.repository.GLib.Error()
1788
Bus = collections.namedtuple("Bus", ["get"])
1791
def test_set_property_uses_setattr(self):
1798
def get(busname, objectpath):
1799
return {"interface": obj}
1800
bus = pydbus_adapter.SystemBus(pydbus_spy)
1802
bus.set_property("busname", "objectpath", "interface", "key",
1804
self.assertIs(value, obj.key)
1806
def test_get_suppresses_xml_deprecation_warning(self):
1807
if sys.version_info.major >= 3:
1809
class stub_pydbus_get:
1812
def get(busname, objectpath):
1813
warnings.warn_explicit(
1814
"deprecated", DeprecationWarning,
1815
"xml.etree.ElementTree", 0)
1816
bus = pydbus_adapter.SystemBus(stub_pydbus_get)
1817
with warnings.catch_warnings(record=True) as w:
1818
warnings.simplefilter("always")
1819
bus.get("busname", "objectpath")
1820
self.assertEqual(0, len(w))
1823
class Test_pydbus_adapter_CachingBus(unittest.TestCase):
1825
"""stub pydbus module"""
1828
def get(busname, objectpath):
1832
self.bus = pydbus_adapter.CachingBus(self.stub_pydbus)
1834
def test_returns_distinct_objectpaths(self):
1835
obj1 = self.bus.get("busname", "objectpath1")
1836
self.assertIsInstance(obj1, Unique)
1837
obj2 = self.bus.get("busname", "objectpath2")
1838
self.assertIsInstance(obj2, Unique)
1839
self.assertIsNot(obj1, obj2)
1841
def test_returns_distinct_busnames(self):
1842
obj1 = self.bus.get("busname1", "objectpath")
1843
self.assertIsInstance(obj1, Unique)
1844
obj2 = self.bus.get("busname2", "objectpath")
1845
self.assertIsInstance(obj2, Unique)
1846
self.assertIsNot(obj1, obj2)
1848
def test_returns_distinct_both(self):
1849
obj1 = self.bus.get("busname1", "objectpath")
1850
self.assertIsInstance(obj1, Unique)
1851
obj2 = self.bus.get("busname2", "objectpath")
1852
self.assertIsInstance(obj2, Unique)
1853
self.assertIsNot(obj1, obj2)
1855
def test_returns_same(self):
1856
obj1 = self.bus.get("busname", "objectpath")
1857
self.assertIsInstance(obj1, Unique)
1858
obj2 = self.bus.get("busname", "objectpath")
1859
self.assertIsInstance(obj2, Unique)
1860
self.assertIs(obj1, obj2)
1862
def test_returns_same_old(self):
1863
obj1 = self.bus.get("busname1", "objectpath1")
1864
self.assertIsInstance(obj1, Unique)
1865
obj2 = self.bus.get("busname2", "objectpath2")
1866
self.assertIsInstance(obj2, Unique)
1867
obj1b = self.bus.get("busname1", "objectpath1")
1868
self.assertIsInstance(obj1b, Unique)
1869
self.assertIsNot(obj1, obj2)
1870
self.assertIsNot(obj2, obj1b)
1871
self.assertIs(obj1, obj1b)
1874
class Test_dbussy_adapter_SystemBus(TestCaseWithAssertLogs):
1878
class ObjectPath(str):
1880
class DBusError(Exception):
1883
def fake_ravel_func(self, func):
1887
class DBusInterfaceProxy:
1889
def methodname(*args):
1890
return [func(*args)]
1893
def get_interface(interface):
1894
if interface == "interface":
1895
return DBusInterfaceProxy()
1896
return {"busname": {"objectpath": DBusObject()}}
1899
def call_method(self, bus, methodname, busname, objectpath,
1901
with self.assertLogs(log, logging.DEBUG):
1902
return bus.call_method(methodname, busname, objectpath,
1905
def test_call_method_returns(self):
1906
expected_method_return = Unique()
1907
method_args = (Unique(), Unique())
1909
self.assertEqual(len(method_args), len(args))
1910
for marg, arg in zip(method_args, args):
1911
self.assertIs(marg, arg)
1912
return expected_method_return
1913
fake_ravel = self.fake_ravel_func(func)
1914
bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
1915
ret = self.call_method(bus, "methodname", "busname",
1916
"objectpath", "interface",
1918
self.assertIs(ret, expected_method_return)
1920
def test_call_method_filters_objectpath(self):
1922
return method_return
1923
fake_ravel = self.fake_ravel_func(func)
1924
bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
1925
method_return = (self.dummy_dbussy.DBUS
1926
.ObjectPath("objectpath"))
1927
ret = self.call_method(bus, "methodname", "busname",
1928
"objectpath", "interface")
1929
self.assertEqual("objectpath", ret)
1930
self.assertNotIsInstance(ret,
1931
self.dummy_dbussy.DBUS.ObjectPath)
1933
def test_call_method_filters_objectpaths_in_dict(self):
1934
ObjectPath = self.dummy_dbussy.DBUS.ObjectPath
1936
return method_return
1937
fake_ravel = self.fake_ravel_func(func)
1938
bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
1940
ObjectPath("objectpath_key_1"):
1941
ObjectPath("objectpath_value_1"),
1942
ObjectPath("objectpath_key_2"):
1943
ObjectPath("objectpath_value_2"),
1945
ret = self.call_method(bus, "methodname", "busname",
1946
"objectpath", "interface")
1947
expected_method_return = {str(key): str(value)
1949
method_return.items()}
1950
for key, value in ret.items():
1951
self.assertNotIsInstance(key, ObjectPath)
1952
self.assertNotIsInstance(value, ObjectPath)
1953
self.assertEqual(expected_method_return, ret)
1954
self.assertIsInstance(ret, dict)
1956
def test_call_method_filters_objectpaths_in_dict_in_dict(self):
1957
ObjectPath = self.dummy_dbussy.DBUS.ObjectPath
1959
return method_return
1960
fake_ravel = self.fake_ravel_func(func)
1961
bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
1963
ObjectPath("key1"): {
1964
ObjectPath("key11"): ObjectPath("value11"),
1965
ObjectPath("key12"): ObjectPath("value12"),
1967
ObjectPath("key2"): {
1968
ObjectPath("key21"): ObjectPath("value21"),
1969
ObjectPath("key22"): ObjectPath("value22"),
1972
ret = self.call_method(bus, "methodname", "busname",
1973
"objectpath", "interface")
1974
expected_method_return = {
1975
"key1": {"key11": "value11",
1976
"key12": "value12"},
1977
"key2": {"key21": "value21",
1978
"key22": "value22"},
1980
self.assertEqual(expected_method_return, ret)
1981
for key, value in ret.items():
1982
self.assertIsInstance(value, dict)
1983
self.assertEqual(expected_method_return[key], value)
1984
self.assertNotIsInstance(key, ObjectPath)
1985
for inner_key, inner_value in value.items():
1986
self.assertIsInstance(value, dict)
1988
expected_method_return[key][inner_key],
1990
self.assertNotIsInstance(key, ObjectPath)
1992
def test_call_method_filters_objectpaths_in_dict_three_deep(self):
1993
ObjectPath = self.dummy_dbussy.DBUS.ObjectPath
1995
return method_return
1996
fake_ravel = self.fake_ravel_func(func)
1997
bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
1999
ObjectPath("key1"): {
2000
ObjectPath("key2"): {
2001
ObjectPath("key3"): ObjectPath("value"),
2005
ret = self.call_method(bus, "methodname", "busname",
2006
"objectpath", "interface")
2007
expected_method_return = {"key1": {"key2": {"key3": "value"}}}
2008
self.assertEqual(expected_method_return, ret)
2009
self.assertIsInstance(ret, dict)
2010
self.assertNotIsInstance(next(iter(ret.keys())), ObjectPath)
2011
self.assertIsInstance(ret["key1"], dict)
2012
self.assertNotIsInstance(next(iter(ret["key1"].keys())),
2014
self.assertIsInstance(ret["key1"]["key2"], dict)
2015
self.assertNotIsInstance(
2016
next(iter(ret["key1"]["key2"].keys())),
2018
self.assertEqual("value", ret["key1"]["key2"]["key3"])
2019
self.assertNotIsInstance(ret["key1"]["key2"]["key3"],
2020
self.dummy_dbussy.DBUS.ObjectPath)
2022
def test_call_method_handles_exception(self):
2024
raise self.dummy_dbussy.DBusError()
2026
fake_ravel = self.fake_ravel_func(func)
2027
bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
2029
with self.assertRaises(dbus.Error) as e:
2030
self.call_method(bus, "methodname", "busname",
2031
"objectpath", "interface")
2033
self.assertNotIsInstance(e.exception, dbus.ConnectFailed)
2035
def test_get_object_converts_to_correct_exception(self):
2036
class fake_ravel_raises_exception_on_connect:
2041
def __getitem__(key):
2042
if key == "objectpath":
2043
raise self.dummy_dbussy.DBusError()
2044
raise Exception(key)
2045
return {"busname": Bus()}
2047
raise self.dummy_dbussy.DBusError()
2048
bus = dbussy_adapter.SystemBus(
2050
fake_ravel_raises_exception_on_connect)
2051
with self.assertRaises(dbus.ConnectFailed):
2052
self.call_method(bus, "methodname", "busname",
2053
"objectpath", "interface")
2056
class Test_commands_from_options(unittest.TestCase):
2059
self.parser = argparse.ArgumentParser()
2060
add_command_line_options(self.parser)
2062
def test_is_enabled(self):
2063
self.assert_command_from_args(["--is-enabled", "client"],
2066
def assert_command_from_args(self, args, command_cls, length=1,
2067
clients=None, **cmd_attrs):
2068
"""Assert that parsing ARGS should result in an instance of
2069
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
2070
options = self.parser.parse_args(args)
2071
check_option_syntax(self.parser, options)
2072
commands = commands_from_options(options)
2073
self.assertEqual(length, len(commands))
2074
for command in commands:
2075
if isinstance(command, command_cls):
2078
self.assertIsInstance(command, command_cls)
2079
if clients is not None:
2080
self.assertEqual(clients, options.client)
2081
for key, value in cmd_attrs.items():
2082
self.assertEqual(value, getattr(command, key))
2084
def assert_commands_from_args(self, args, commands, clients=None):
2085
for cmd in commands:
2086
self.assert_command_from_args(args, cmd,
2087
length=len(commands),
2090
def test_is_enabled_short(self):
2091
self.assert_command_from_args(["-V", "client"],
2094
def test_approve(self):
2095
self.assert_command_from_args(["--approve", "client"],
2098
def test_approve_short(self):
2099
self.assert_command_from_args(["-A", "client"],
2102
def test_deny(self):
2103
self.assert_command_from_args(["--deny", "client"],
2106
def test_deny_short(self):
2107
self.assert_command_from_args(["-D", "client"], command.Deny)
2109
def test_remove(self):
2110
self.assert_command_from_args(["--remove", "client"],
2113
def test_deny_before_remove(self):
2114
options = self.parser.parse_args(["--deny", "--remove",
2116
check_option_syntax(self.parser, options)
2117
commands = commands_from_options(options)
2118
self.assertEqual(2, len(commands))
2119
self.assertIsInstance(commands[0], command.Deny)
2120
self.assertIsInstance(commands[1], command.Remove)
2122
def test_deny_before_remove_reversed(self):
2123
options = self.parser.parse_args(["--remove", "--deny",
2125
check_option_syntax(self.parser, options)
2126
commands = commands_from_options(options)
2127
self.assertEqual(2, len(commands))
2128
self.assertIsInstance(commands[0], command.Deny)
2129
self.assertIsInstance(commands[1], command.Remove)
2131
def test_remove_short(self):
2132
self.assert_command_from_args(["-r", "client"],
2135
def test_dump_json(self):
2136
self.assert_command_from_args(["--dump-json"],
2139
def test_enable(self):
2140
self.assert_command_from_args(["--enable", "client"],
2143
def test_enable_short(self):
2144
self.assert_command_from_args(["-e", "client"],
2147
def test_disable(self):
2148
self.assert_command_from_args(["--disable", "client"],
2151
def test_disable_short(self):
2152
self.assert_command_from_args(["-d", "client"],
2155
def test_bump_timeout(self):
2156
self.assert_command_from_args(["--bump-timeout", "client"],
2157
command.BumpTimeout)
2159
def test_bump_timeout_short(self):
2160
self.assert_command_from_args(["-b", "client"],
2161
command.BumpTimeout)
2163
def test_start_checker(self):
2164
self.assert_command_from_args(["--start-checker", "client"],
2165
command.StartChecker)
2167
def test_stop_checker(self):
2168
self.assert_command_from_args(["--stop-checker", "client"],
2169
command.StopChecker)
2171
def test_approve_by_default(self):
2172
self.assert_command_from_args(["--approve-by-default",
2174
command.ApproveByDefault)
2176
def test_deny_by_default(self):
2177
self.assert_command_from_args(["--deny-by-default", "client"],
2178
command.DenyByDefault)
2180
def test_checker(self):
2181
self.assert_command_from_args(["--checker", ":", "client"],
2185
def test_checker_empty(self):
2186
self.assert_command_from_args(["--checker", "", "client"],
2190
def test_checker_short(self):
2191
self.assert_command_from_args(["-c", ":", "client"],
2195
def test_host(self):
2196
self.assert_command_from_args(
2197
["--host", "client.example.org", "client"],
2198
command.SetHost, value_to_set="client.example.org")
2200
def test_host_short(self):
2201
self.assert_command_from_args(
2202
["-H", "client.example.org", "client"], command.SetHost,
2203
value_to_set="client.example.org")
2205
def test_secret_devnull(self):
2206
self.assert_command_from_args(["--secret", os.path.devnull,
2207
"client"], command.SetSecret,
2210
def test_secret_tempfile(self):
2211
with tempfile.NamedTemporaryFile(mode="r+b") as f:
2212
value = b"secret\0xyzzy\nbar"
2215
self.assert_command_from_args(["--secret", f.name,
2220
def test_secret_devnull_short(self):
2221
self.assert_command_from_args(["-s", os.path.devnull,
2222
"client"], command.SetSecret,
2225
def test_secret_tempfile_short(self):
2226
with tempfile.NamedTemporaryFile(mode="r+b") as f:
2227
value = b"secret\0xyzzy\nbar"
2230
self.assert_command_from_args(["-s", f.name, "client"],
2234
def test_timeout(self):
2235
self.assert_command_from_args(["--timeout", "PT5M", "client"],
2237
value_to_set=300000)
2239
def test_timeout_short(self):
2240
self.assert_command_from_args(["-t", "PT5M", "client"],
2242
value_to_set=300000)
2244
def test_extended_timeout(self):
2245
self.assert_command_from_args(["--extended-timeout", "PT15M",
2247
command.SetExtendedTimeout,
2248
value_to_set=900000)
2250
def test_interval(self):
2251
self.assert_command_from_args(["--interval", "PT2M",
2252
"client"], command.SetInterval,
2253
value_to_set=120000)
2255
def test_interval_short(self):
2256
self.assert_command_from_args(["-i", "PT2M", "client"],
2257
command.SetInterval,
2258
value_to_set=120000)
2260
def test_approval_delay(self):
2261
self.assert_command_from_args(["--approval-delay", "PT30S",
2263
command.SetApprovalDelay,
2266
def test_approval_duration(self):
2267
self.assert_command_from_args(["--approval-duration", "PT1S",
2269
command.SetApprovalDuration,
2272
def test_print_table(self):
2273
self.assert_command_from_args([], command.PrintTable,
2276
def test_print_table_verbose(self):
2277
self.assert_command_from_args(["--verbose"],
2281
def test_print_table_verbose_short(self):
2282
self.assert_command_from_args(["-v"], command.PrintTable,
2286
def test_manual_page_example_1(self):
2287
self.assert_command_from_args("",
2292
def test_manual_page_example_2(self):
2293
self.assert_command_from_args(
2294
"--verbose foo1.example.org foo2.example.org".split(),
2295
command.PrintTable, clients=["foo1.example.org",
2296
"foo2.example.org"],
2299
def test_manual_page_example_3(self):
2300
self.assert_command_from_args("--enable --all".split(),
2304
def test_manual_page_example_4(self):
2305
self.assert_commands_from_args(
2306
("--timeout=PT5M --interval=PT1M foo1.example.org"
2307
" foo2.example.org").split(),
2308
[command.SetTimeout, command.SetInterval],
2309
clients=["foo1.example.org", "foo2.example.org"])
2311
def test_manual_page_example_5(self):
2312
self.assert_command_from_args("--approve --all".split(),
2317
class TestCommand(unittest.TestCase):
834
2318
"""Abstract class for tests of command classes"""
837
class MockClient(object):
838
def __init__(self, name, **attributes):
839
self.__dbus_object_path__ = "/clients/{}".format(name)
840
self.attributes = attributes
841
self.attributes["Name"] = name
843
def Set(self, interface, propname, value, dbus_interface):
844
testcase.assertEqual(interface, client_interface)
845
testcase.assertEqual(dbus_interface,
846
dbus.PROPERTIES_IFACE)
847
self.attributes[propname] = value
848
def Get(self, interface, propname, dbus_interface):
849
testcase.assertEqual(interface, client_interface)
850
testcase.assertEqual(dbus_interface,
851
dbus.PROPERTIES_IFACE)
852
return self.attributes[propname]
853
def Approve(self, approve, dbus_interface):
854
testcase.assertEqual(dbus_interface, client_interface)
855
self.calls.append(("Approve", (approve,
857
self.client = MockClient(
859
KeyID=("92ed150794387c03ce684574b1139a65"
860
"94a34f895daaaf09fd8ea90a27cddb12"),
862
Host="foo.example.org",
863
Enabled=dbus.Boolean(True),
865
LastCheckedOK="2019-02-03T00:00:00",
866
Created="2019-01-02T00:00:00",
868
Fingerprint=("778827225BA7DE539C5A"
869
"7CFA59CFF7CDBD9A5920"),
870
CheckerRunning=dbus.Boolean(False),
871
LastEnabled="2019-01-03T00:00:00",
872
ApprovalPending=dbus.Boolean(False),
873
ApprovedByDefault=dbus.Boolean(True),
874
LastApprovalRequest="",
876
ApprovalDuration=1000,
877
Checker="fping -q -- %(host)s",
878
ExtendedTimeout=900000,
879
Expires="2019-02-04T00:00:00",
881
self.other_client = MockClient(
883
KeyID=("0558568eedd67d622f5c83b35a115f79"
884
"6ab612cff5ad227247e46c2b020f441c"),
887
Enabled=dbus.Boolean(True),
889
LastCheckedOK="2019-02-04T00:00:00",
890
Created="2019-01-03T00:00:00",
892
Fingerprint=("3E393AEAEFB84C7E89E2"
893
"F547B3A107558FCA3A27"),
894
CheckerRunning=dbus.Boolean(True),
895
LastEnabled="2019-01-04T00:00:00",
896
ApprovalPending=dbus.Boolean(False),
897
ApprovedByDefault=dbus.Boolean(False),
898
LastApprovalRequest="2019-01-03T00:00:00",
900
ApprovalDuration=1000,
902
ExtendedTimeout=900000,
903
Expires="2019-02-05T00:00:00",
904
LastCheckerStatus=-2)
905
self.clients = collections.OrderedDict(
907
("/clients/foo", self.client.attributes),
908
("/clients/barbar", self.other_client.attributes),
910
self.one_client = {"/clients/foo": self.client.attributes}
915
def get_object(client_bus_name, path):
916
self.assertEqual(client_bus_name, busname)
918
"/clients/foo": self.client,
919
"/clients/barbar": self.other_client,
923
class TestPrintTableCmd(TestCmd):
924
def test_normal(self):
925
output = PrintTableCmd().output(self.clients.values())
926
expected_output = """
927
Name Enabled Timeout Last Successful Check
928
foo Yes 00:05:00 2019-02-03T00:00:00
929
barbar Yes 00:05:00 2019-02-04T00:00:00
931
self.assertEqual(output, expected_output)
932
def test_verbose(self):
933
output = PrintTableCmd(verbose=True).output(
934
self.clients.values())
935
expected_output = """
936
Name Enabled Timeout Last Successful Check Created Interval Host Key ID Fingerprint Check Is Running Last Enabled Approval Is Pending Approved By Default Last Approval Request Approval Delay Approval Duration Checker Extended Timeout Expires Last Checker Status
937
foo Yes 00:05:00 2019-02-03T00:00:00 2019-01-02T00:00:00 00:02:00 foo.example.org 92ed150794387c03ce684574b1139a6594a34f895daaaf09fd8ea90a27cddb12 778827225BA7DE539C5A7CFA59CFF7CDBD9A5920 No 2019-01-03T00:00:00 No Yes 00:00:00 00:00:01 fping -q -- %(host)s 00:15:00 2019-02-04T00:00:00 0
938
barbar Yes 00:05:00 2019-02-04T00:00:00 2019-01-03T00:00:00 00:02:00 192.0.2.3 0558568eedd67d622f5c83b35a115f796ab612cff5ad227247e46c2b020f441c 3E393AEAEFB84C7E89E2F547B3A107558FCA3A27 Yes 2019-01-04T00:00:00 No No 2019-01-03T00:00:00 00:00:30 00:00:01 : 00:15:00 2019-02-05T00:00:00 -2
940
self.assertEqual(output, expected_output)
941
def test_one_client(self):
942
output = PrintTableCmd().output(self.one_client.values())
943
expected_output = """
944
Name Enabled Timeout Last Successful Check
945
foo Yes 00:05:00 2019-02-03T00:00:00
947
self.assertEqual(output, expected_output)
949
class TestDumpJSONCmd(TestCmd):
951
self.expected_json = {
2320
class FakeMandosBus(dbus.MandosBus):
2321
def __init__(self, testcase):
2322
self.client_properties = {
954
2324
"KeyID": ("92ed150794387c03ce684574b1139a65"
955
2325
"94a34f895daaaf09fd8ea90a27cddb12"),
2326
"Secret": b"secret",
956
2327
"Host": "foo.example.org",
957
2328
"Enabled": True,
958
2329
"Timeout": 300000,
991
2363
"ApprovedByDefault": False,
992
2364
"LastApprovalRequest": "2019-01-03T00:00:00",
993
2365
"ApprovalDelay": 30000,
994
"ApprovalDuration": 1000,
2366
"ApprovalDuration": 93785000,
996
2368
"ExtendedTimeout": 900000,
997
2369
"Expires": "2019-02-05T00:00:00",
998
2370
"LastCheckerStatus": -2,
1001
return super(TestDumpJSONCmd, self).setUp()
1002
def test_normal(self):
1003
json_data = json.loads(DumpJSONCmd().output(self.clients))
1004
self.assertDictEqual(json_data, self.expected_json)
1005
def test_one_client(self):
1006
clients = self.one_client
1007
json_data = json.loads(DumpJSONCmd().output(clients))
1008
expected_json = {"foo": self.expected_json["foo"]}
1009
self.assertDictEqual(json_data, expected_json)
1011
class TestIsEnabledCmd(TestCmd):
1012
def test_is_enabled(self):
1013
self.assertTrue(all(IsEnabledCmd().is_enabled(client, properties)
1014
for client, properties in self.clients.items()))
1015
def test_is_enabled_run_exits_successfully(self):
2372
self.clients = collections.OrderedDict(
2374
("client_objectpath", self.client_properties),
2375
("other_client_objectpath",
2376
self.other_client_properties),
2378
self.one_client = {"client_objectpath":
2379
self.client_properties}
2380
self.testcase = testcase
2383
def call_method(self, methodname, busname, objectpath,
2385
self.testcase.assertEqual("se.recompile.Mandos", busname)
2386
self.calls.append((methodname, busname, objectpath,
2388
if interface == "org.freedesktop.DBus.Properties":
2389
if methodname == "Set":
2390
self.testcase.assertEqual(3, len(args))
2391
interface, key, value = args
2392
self.testcase.assertEqual(
2393
"se.recompile.Mandos.Client", interface)
2394
self.clients[objectpath][key] = value
2396
elif interface == "se.recompile.Mandos":
2397
self.testcase.assertEqual("RemoveClient", methodname)
2398
self.testcase.assertEqual(1, len(args))
2399
clientpath = args[0]
2400
del self.clients[clientpath]
2402
elif interface == "se.recompile.Mandos.Client":
2403
if methodname == "Approve":
2404
self.testcase.assertEqual(1, len(args))
2409
self.bus = self.FakeMandosBus(self)
2412
class TestBaseCommands(TestCommand):
2414
def test_IsEnabled_exits_successfully(self):
1016
2415
with self.assertRaises(SystemExit) as e:
1017
IsEnabledCmd().run(self.one_client)
2416
command.IsEnabled().run(self.bus.one_client)
1018
2417
if e.exception.code is not None:
1019
self.assertEqual(e.exception.code, 0)
2418
self.assertEqual(0, e.exception.code)
1021
2420
self.assertIsNone(e.exception.code)
1022
def test_is_enabled_run_exits_with_failure(self):
1023
self.client.attributes["Enabled"] = dbus.Boolean(False)
2422
def test_IsEnabled_exits_with_failure(self):
2423
self.bus.client_properties["Enabled"] = False
1024
2424
with self.assertRaises(SystemExit) as e:
1025
IsEnabledCmd().run(self.one_client)
2425
command.IsEnabled().run(self.bus.one_client)
1026
2426
if isinstance(e.exception.code, int):
1027
self.assertNotEqual(e.exception.code, 0)
2427
self.assertNotEqual(0, e.exception.code)
1029
2429
self.assertIsNotNone(e.exception.code)
1031
class TestRemoveCmd(TestCmd):
1032
def test_remove(self):
1033
class MockMandos(object):
1036
def RemoveClient(self, dbus_path):
1037
self.calls.append(("RemoveClient", (dbus_path,)))
1038
mandos = MockMandos()
1039
super(TestRemoveCmd, self).setUp()
1040
RemoveCmd().run(self.clients, self.bus, mandos)
1041
self.assertEqual(len(mandos.calls), 2)
1042
for clientpath in self.clients:
1043
self.assertIn(("RemoveClient", (clientpath,)),
1046
class TestApproveCmd(TestCmd):
1047
def test_approve(self):
1048
ApproveCmd().run(self.clients, self.bus)
1049
for clientpath in self.clients:
1050
client = self.bus.get_object(busname, clientpath)
1051
self.assertIn(("Approve", (True, client_interface)),
1054
class TestDenyCmd(TestCmd):
1055
def test_deny(self):
1056
DenyCmd().run(self.clients, self.bus)
1057
for clientpath in self.clients:
1058
client = self.bus.get_object(busname, clientpath)
1059
self.assertIn(("Approve", (False, client_interface)),
1062
class TestEnableCmd(TestCmd):
1063
def test_enable(self):
1064
for clientpath in self.clients:
1065
client = self.bus.get_object(busname, clientpath)
1066
client.attributes["Enabled"] = False
1068
EnableCmd().run(self.clients, self.bus)
1070
for clientpath in self.clients:
1071
client = self.bus.get_object(busname, clientpath)
1072
self.assertTrue(client.attributes["Enabled"])
1074
class TestDisableCmd(TestCmd):
1075
def test_disable(self):
1076
DisableCmd().run(self.clients, self.bus)
1077
for clientpath in self.clients:
1078
client = self.bus.get_object(busname, clientpath)
1079
self.assertFalse(client.attributes["Enabled"])
1081
class Unique(object):
1082
"""Class for objects which exist only to be unique objects, since
1083
unittest.mock.sentinel only exists in Python 3.3"""
1085
class TestPropertyCmd(TestCmd):
1086
"""Abstract class for tests of PropertyCmd classes"""
2431
def test_Approve(self):
2432
busname = "se.recompile.Mandos"
2433
client_interface = "se.recompile.Mandos.Client"
2434
command.Approve().run(self.bus.clients, self.bus)
2435
for clientpath in self.bus.clients:
2436
self.assertIn(("Approve", busname, clientpath,
2437
client_interface, (True,)), self.bus.calls)
2439
def test_Deny(self):
2440
busname = "se.recompile.Mandos"
2441
client_interface = "se.recompile.Mandos.Client"
2442
command.Deny().run(self.bus.clients, self.bus)
2443
for clientpath in self.bus.clients:
2444
self.assertIn(("Approve", busname, clientpath,
2445
client_interface, (False,)),
2448
def test_Remove(self):
2449
command.Remove().run(self.bus.clients, self.bus)
2450
for clientpath in self.bus.clients:
2451
self.assertIn(("RemoveClient", dbus_busname,
2452
dbus_server_path, dbus_server_interface,
2453
(clientpath,)), self.bus.calls)
2458
"KeyID": ("92ed150794387c03ce684574b1139a65"
2459
"94a34f895daaaf09fd8ea90a27cddb12"),
2460
"Host": "foo.example.org",
2463
"LastCheckedOK": "2019-02-03T00:00:00",
2464
"Created": "2019-01-02T00:00:00",
2466
"Fingerprint": ("778827225BA7DE539C5A"
2467
"7CFA59CFF7CDBD9A5920"),
2468
"CheckerRunning": False,
2469
"LastEnabled": "2019-01-03T00:00:00",
2470
"ApprovalPending": False,
2471
"ApprovedByDefault": True,
2472
"LastApprovalRequest": "",
2474
"ApprovalDuration": 1000,
2475
"Checker": "fping -q -- %(host)s",
2476
"ExtendedTimeout": 900000,
2477
"Expires": "2019-02-04T00:00:00",
2478
"LastCheckerStatus": 0,
2482
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
2483
"6ab612cff5ad227247e46c2b020f441c"),
2484
"Host": "192.0.2.3",
2487
"LastCheckedOK": "2019-02-04T00:00:00",
2488
"Created": "2019-01-03T00:00:00",
2490
"Fingerprint": ("3E393AEAEFB84C7E89E2"
2491
"F547B3A107558FCA3A27"),
2492
"CheckerRunning": True,
2493
"LastEnabled": "2019-01-04T00:00:00",
2494
"ApprovalPending": False,
2495
"ApprovedByDefault": False,
2496
"LastApprovalRequest": "2019-01-03T00:00:00",
2497
"ApprovalDelay": 30000,
2498
"ApprovalDuration": 93785000,
2500
"ExtendedTimeout": 900000,
2501
"Expires": "2019-02-05T00:00:00",
2502
"LastCheckerStatus": -2,
2506
def test_DumpJSON_normal(self):
2507
with self.capture_stdout_to_buffer() as buffer:
2508
command.DumpJSON().run(self.bus.clients)
2509
json_data = json.loads(buffer.getvalue())
2510
self.assertDictEqual(self.expected_json, json_data)
2513
@contextlib.contextmanager
2514
def capture_stdout_to_buffer():
2515
capture_buffer = io.StringIO()
2516
old_stdout = sys.stdout
2517
sys.stdout = capture_buffer
2519
yield capture_buffer
2521
sys.stdout = old_stdout
2523
def test_DumpJSON_one_client(self):
2524
with self.capture_stdout_to_buffer() as buffer:
2525
command.DumpJSON().run(self.bus.one_client)
2526
json_data = json.loads(buffer.getvalue())
2527
expected_json = {"foo": self.expected_json["foo"]}
2528
self.assertDictEqual(expected_json, json_data)
2530
def test_PrintTable_normal(self):
2531
with self.capture_stdout_to_buffer() as buffer:
2532
command.PrintTable().run(self.bus.clients)
2533
expected_output = "\n".join((
2534
"Name Enabled Timeout Last Successful Check",
2535
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
2536
"barbar Yes 00:05:00 2019-02-04T00:00:00 ",
2538
self.assertEqual(expected_output, buffer.getvalue())
2540
def test_PrintTable_verbose(self):
2541
with self.capture_stdout_to_buffer() as buffer:
2542
command.PrintTable(verbose=True).run(self.bus.clients)
2557
"Last Successful Check ",
2558
"2019-02-03T00:00:00 ",
2559
"2019-02-04T00:00:00 ",
2562
"2019-01-02T00:00:00 ",
2563
"2019-01-03T00:00:00 ",
2575
("92ed150794387c03ce684574b1139a6594a34f895daaaf09fd8"
2577
("0558568eedd67d622f5c83b35a115f796ab612cff5ad227247e"
2581
"778827225BA7DE539C5A7CFA59CFF7CDBD9A5920 ",
2582
"3E393AEAEFB84C7E89E2F547B3A107558FCA3A27 ",
2584
"Check Is Running ",
2589
"2019-01-03T00:00:00 ",
2590
"2019-01-04T00:00:00 ",
2592
"Approval Is Pending ",
2596
"Approved By Default ",
2600
"Last Approval Request ",
2602
"2019-01-03T00:00:00 ",
2608
"Approval Duration ",
2613
"fping -q -- %(host)s ",
2616
"Extended Timeout ",
2621
"2019-02-04T00:00:00 ",
2622
"2019-02-05T00:00:00 ",
2624
"Last Checker Status",
2629
num_lines = max(len(rows) for rows in columns)
2630
expected_output = ("\n".join("".join(rows[line]
2631
for rows in columns)
2632
for line in range(num_lines))
2634
self.assertEqual(expected_output, buffer.getvalue())
2636
def test_PrintTable_one_client(self):
2637
with self.capture_stdout_to_buffer() as buffer:
2638
command.PrintTable().run(self.bus.one_client)
2639
expected_output = "\n".join((
2640
"Name Enabled Timeout Last Successful Check",
2641
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
2643
self.assertEqual(expected_output, buffer.getvalue())
2646
class TestPropertySetterCmd(TestCommand):
2647
"""Abstract class for tests of command.PropertySetter classes"""
1087
2649
def runTest(self):
1088
2650
if not hasattr(self, "command"):
1090
values_to_get = getattr(self, "values_to_get",
1092
for value_to_set, value_to_get in zip(self.values_to_set,
1094
for clientpath in self.clients:
1095
client = self.bus.get_object(busname, clientpath)
1096
old_value = client.attributes[self.propname]
1097
self.assertNotIsInstance(old_value, Unique)
1098
client.attributes[self.propname] = Unique()
1099
self.run_command(value_to_set, self.clients)
1100
for clientpath in self.clients:
1101
client = self.bus.get_object(busname, clientpath)
1102
value = client.attributes[self.propname]
2651
return # Abstract TestCase class
2653
if hasattr(self, "values_to_set"):
2654
cmd_args = [(value,) for value in self.values_to_set]
2655
values_to_get = getattr(self, "values_to_get",
2658
cmd_args = [() for x in range(len(self.values_to_get))]
2659
values_to_get = self.values_to_get
2660
for value_to_get, cmd_arg in zip(values_to_get, cmd_args):
2661
for clientpath in self.bus.clients:
2662
self.bus.clients[clientpath][self.propname] = (
2664
self.command(*cmd_arg).run(self.bus.clients, self.bus)
2665
for clientpath in self.bus.clients:
2666
value = (self.bus.clients[clientpath]
1103
2668
self.assertNotIsInstance(value, Unique)
1104
self.assertEqual(value, value_to_get)
1105
def run_command(self, value, clients):
1106
self.command().run(clients, self.bus)
1108
class TestBumpTimeoutCmd(TestPropertyCmd):
1109
command = BumpTimeoutCmd
2669
self.assertEqual(value_to_get, value)
2672
class TestEnableCmd(TestPropertySetterCmd):
2673
command = command.Enable
2674
propname = "Enabled"
2675
values_to_get = [True]
2678
class TestDisableCmd(TestPropertySetterCmd):
2679
command = command.Disable
2680
propname = "Enabled"
2681
values_to_get = [False]
2684
class TestBumpTimeoutCmd(TestPropertySetterCmd):
2685
command = command.BumpTimeout
1110
2686
propname = "LastCheckedOK"
1111
values_to_set = [""]
1113
class TestStartCheckerCmd(TestPropertyCmd):
1114
command = StartCheckerCmd
1115
propname = "CheckerRunning"
1116
values_to_set = [dbus.Boolean(True)]
1118
class TestStopCheckerCmd(TestPropertyCmd):
1119
command = StopCheckerCmd
1120
propname = "CheckerRunning"
1121
values_to_set = [dbus.Boolean(False)]
1123
class TestApproveByDefaultCmd(TestPropertyCmd):
1124
command = ApproveByDefaultCmd
1125
propname = "ApprovedByDefault"
1126
values_to_set = [dbus.Boolean(True)]
1128
class TestDenyByDefaultCmd(TestPropertyCmd):
1129
command = DenyByDefaultCmd
1130
propname = "ApprovedByDefault"
1131
values_to_set = [dbus.Boolean(False)]
1133
class TestValueArgumentPropertyCmd(TestPropertyCmd):
1134
"""Abstract class for tests of PropertyCmd classes using the
1135
ValueArgumentMixIn"""
1137
if type(self) is TestValueArgumentPropertyCmd:
1139
return super(TestValueArgumentPropertyCmd, self).runTest()
1140
def run_command(self, value, clients):
1141
self.command(value).run(clients, self.bus)
1143
class TestSetCheckerCmd(TestValueArgumentPropertyCmd):
1144
command = SetCheckerCmd
2687
values_to_get = [""]
2690
class TestStartCheckerCmd(TestPropertySetterCmd):
2691
command = command.StartChecker
2692
propname = "CheckerRunning"
2693
values_to_get = [True]
2696
class TestStopCheckerCmd(TestPropertySetterCmd):
2697
command = command.StopChecker
2698
propname = "CheckerRunning"
2699
values_to_get = [False]
2702
class TestApproveByDefaultCmd(TestPropertySetterCmd):
2703
command = command.ApproveByDefault
2704
propname = "ApprovedByDefault"
2705
values_to_get = [True]
2708
class TestDenyByDefaultCmd(TestPropertySetterCmd):
2709
command = command.DenyByDefault
2710
propname = "ApprovedByDefault"
2711
values_to_get = [False]
2714
class TestSetCheckerCmd(TestPropertySetterCmd):
2715
command = command.SetChecker
1145
2716
propname = "Checker"
1146
2717
values_to_set = ["", ":", "fping -q -- %s"]
1148
class TestSetHostCmd(TestValueArgumentPropertyCmd):
1149
command = SetHostCmd
2720
class TestSetHostCmd(TestPropertySetterCmd):
2721
command = command.SetHost
1150
2722
propname = "Host"
1151
values_to_set = ["192.0.2.3", "foo.example.org"]
1153
class TestSetSecretCmd(TestValueArgumentPropertyCmd):
1154
command = SetSecretCmd
2723
values_to_set = ["192.0.2.3", "client.example.org"]
2726
class TestSetSecretCmd(TestPropertySetterCmd):
2727
command = command.SetSecret
1155
2728
propname = "Secret"
1156
2729
values_to_set = [io.BytesIO(b""),
1157
2730
io.BytesIO(b"secret\0xyzzy\nbar")]
1158
values_to_get = [b"", b"secret\0xyzzy\nbar"]
1160
class TestSetTimeoutCmd(TestValueArgumentPropertyCmd):
1161
command = SetTimeoutCmd
2731
values_to_get = [f.getvalue() for f in values_to_set]
2734
class TestSetTimeoutCmd(TestPropertySetterCmd):
2735
command = command.SetTimeout
1162
2736
propname = "Timeout"
1163
2737
values_to_set = [datetime.timedelta(),
1164
2738
datetime.timedelta(minutes=5),
1165
2739
datetime.timedelta(seconds=1),
1166
2740
datetime.timedelta(weeks=1),
1167
2741
datetime.timedelta(weeks=52)]
1168
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1170
class TestSetExtendedTimeoutCmd(TestValueArgumentPropertyCmd):
1171
command = SetExtendedTimeoutCmd
2742
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2745
class TestSetExtendedTimeoutCmd(TestPropertySetterCmd):
2746
command = command.SetExtendedTimeout
1172
2747
propname = "ExtendedTimeout"
1173
2748
values_to_set = [datetime.timedelta(),
1174
2749
datetime.timedelta(minutes=5),
1175
2750
datetime.timedelta(seconds=1),
1176
2751
datetime.timedelta(weeks=1),
1177
2752
datetime.timedelta(weeks=52)]
1178
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1180
class TestSetIntervalCmd(TestValueArgumentPropertyCmd):
1181
command = SetIntervalCmd
2753
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2756
class TestSetIntervalCmd(TestPropertySetterCmd):
2757
command = command.SetInterval
1182
2758
propname = "Interval"
1183
2759
values_to_set = [datetime.timedelta(),
1184
2760
datetime.timedelta(minutes=5),
1185
2761
datetime.timedelta(seconds=1),
1186
2762
datetime.timedelta(weeks=1),
1187
2763
datetime.timedelta(weeks=52)]
1188
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1190
class TestSetApprovalDelayCmd(TestValueArgumentPropertyCmd):
1191
command = SetApprovalDelayCmd
2764
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2767
class TestSetApprovalDelayCmd(TestPropertySetterCmd):
2768
command = command.SetApprovalDelay
1192
2769
propname = "ApprovalDelay"
1193
2770
values_to_set = [datetime.timedelta(),
1194
2771
datetime.timedelta(minutes=5),
1195
2772
datetime.timedelta(seconds=1),
1196
2773
datetime.timedelta(weeks=1),
1197
2774
datetime.timedelta(weeks=52)]
1198
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1200
class TestSetApprovalDurationCmd(TestValueArgumentPropertyCmd):
1201
command = SetApprovalDurationCmd
2775
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2778
class TestSetApprovalDurationCmd(TestPropertySetterCmd):
2779
command = command.SetApprovalDuration
1202
2780
propname = "ApprovalDuration"
1203
2781
values_to_set = [datetime.timedelta(),
1204
2782
datetime.timedelta(minutes=5),
1205
2783
datetime.timedelta(seconds=1),
1206
2784
datetime.timedelta(weeks=1),
1207
2785
datetime.timedelta(weeks=52)]
1208
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1210
class Test_command_from_options(unittest.TestCase):
1212
self.parser = argparse.ArgumentParser()
1213
add_command_line_options(self.parser)
1214
def assert_command_from_args(self, args, command_cls, **cmd_attrs):
1215
"""Assert that parsing ARGS should result in an instance of
1216
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
1217
options = self.parser.parse_args(args)
1218
check_option_syntax(self.parser, options)
1219
commands = commands_from_options(options)
1220
self.assertEqual(len(commands), 1)
1221
command = commands[0]
1222
self.assertIsInstance(command, command_cls)
1223
for key, value in cmd_attrs.items():
1224
self.assertEqual(getattr(command, key), value)
1225
def test_print_table(self):
1226
self.assert_command_from_args([], PrintTableCmd,
1229
def test_print_table_verbose(self):
1230
self.assert_command_from_args(["--verbose"], PrintTableCmd,
1233
def test_print_table_verbose_short(self):
1234
self.assert_command_from_args(["-v"], PrintTableCmd,
1237
def test_enable(self):
1238
self.assert_command_from_args(["--enable", "foo"], EnableCmd)
1240
def test_enable_short(self):
1241
self.assert_command_from_args(["-e", "foo"], EnableCmd)
1243
def test_disable(self):
1244
self.assert_command_from_args(["--disable", "foo"],
1247
def test_disable_short(self):
1248
self.assert_command_from_args(["-d", "foo"], DisableCmd)
1250
def test_bump_timeout(self):
1251
self.assert_command_from_args(["--bump-timeout", "foo"],
1254
def test_bump_timeout_short(self):
1255
self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
1257
def test_start_checker(self):
1258
self.assert_command_from_args(["--start-checker", "foo"],
1261
def test_stop_checker(self):
1262
self.assert_command_from_args(["--stop-checker", "foo"],
1265
def test_remove(self):
1266
self.assert_command_from_args(["--remove", "foo"],
1269
def test_remove_short(self):
1270
self.assert_command_from_args(["-r", "foo"], RemoveCmd)
1272
def test_checker(self):
1273
self.assert_command_from_args(["--checker", ":", "foo"],
1274
SetCheckerCmd, value_to_set=":")
1276
def test_checker_empty(self):
1277
self.assert_command_from_args(["--checker", "", "foo"],
1278
SetCheckerCmd, value_to_set="")
1280
def test_checker_short(self):
1281
self.assert_command_from_args(["-c", ":", "foo"],
1282
SetCheckerCmd, value_to_set=":")
1284
def test_timeout(self):
1285
self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1287
value_to_set=300000)
1289
def test_timeout_short(self):
1290
self.assert_command_from_args(["-t", "PT5M", "foo"],
1292
value_to_set=300000)
1294
def test_extended_timeout(self):
1295
self.assert_command_from_args(["--extended-timeout", "PT15M",
1297
SetExtendedTimeoutCmd,
1298
value_to_set=900000)
1300
def test_interval(self):
1301
self.assert_command_from_args(["--interval", "PT2M", "foo"],
1303
value_to_set=120000)
1305
def test_interval_short(self):
1306
self.assert_command_from_args(["-i", "PT2M", "foo"],
1308
value_to_set=120000)
1310
def test_approve_by_default(self):
1311
self.assert_command_from_args(["--approve-by-default", "foo"],
1312
ApproveByDefaultCmd)
1314
def test_deny_by_default(self):
1315
self.assert_command_from_args(["--deny-by-default", "foo"],
1318
def test_approval_delay(self):
1319
self.assert_command_from_args(["--approval-delay", "PT30S",
1320
"foo"], SetApprovalDelayCmd,
1323
def test_approval_duration(self):
1324
self.assert_command_from_args(["--approval-duration", "PT1S",
1325
"foo"], SetApprovalDurationCmd,
1328
def test_host(self):
1329
self.assert_command_from_args(["--host", "foo.example.org",
1331
value_to_set="foo.example.org")
1333
def test_host_short(self):
1334
self.assert_command_from_args(["-H", "foo.example.org",
1336
value_to_set="foo.example.org")
1338
def test_secret_devnull(self):
1339
self.assert_command_from_args(["--secret", os.path.devnull,
1340
"foo"], SetSecretCmd,
1343
def test_secret_tempfile(self):
1344
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1345
value = b"secret\0xyzzy\nbar"
1348
self.assert_command_from_args(["--secret", f.name,
1349
"foo"], SetSecretCmd,
1352
def test_secret_devnull_short(self):
1353
self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1354
SetSecretCmd, value_to_set=b"")
1356
def test_secret_tempfile_short(self):
1357
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1358
value = b"secret\0xyzzy\nbar"
1361
self.assert_command_from_args(["-s", f.name, "foo"],
1365
def test_approve(self):
1366
self.assert_command_from_args(["--approve", "foo"],
1369
def test_approve_short(self):
1370
self.assert_command_from_args(["-A", "foo"], ApproveCmd)
1372
def test_deny(self):
1373
self.assert_command_from_args(["--deny", "foo"], DenyCmd)
1375
def test_deny_short(self):
1376
self.assert_command_from_args(["-D", "foo"], DenyCmd)
1378
def test_dump_json(self):
1379
self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
1381
def test_is_enabled(self):
1382
self.assert_command_from_args(["--is-enabled", "foo"],
1385
def test_is_enabled_short(self):
1386
self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
1388
def test_deny_before_remove(self):
1389
options = self.parser.parse_args(["--deny", "--remove", "foo"])
1390
check_option_syntax(self.parser, options)
1391
commands = commands_from_options(options)
1392
self.assertEqual(len(commands), 2)
1393
self.assertIsInstance(commands[0], DenyCmd)
1394
self.assertIsInstance(commands[1], RemoveCmd)
1396
def test_deny_before_remove_reversed(self):
1397
options = self.parser.parse_args(["--remove", "--deny", "--all"])
1398
check_option_syntax(self.parser, options)
1399
commands = commands_from_options(options)
1400
self.assertEqual(len(commands), 2)
1401
self.assertIsInstance(commands[0], DenyCmd)
1402
self.assertIsInstance(commands[1], RemoveCmd)
1405
class Test_check_option_syntax(unittest.TestCase):
1406
# This mostly corresponds to the definition from has_actions() in
1407
# check_option_syntax()
1409
# The actual values set here are not that important, but we do
1410
# at least stick to the correct types, even though they are
1414
"bump_timeout": True,
1415
"start_checker": True,
1416
"stop_checker": True,
1420
"timeout": datetime.timedelta(),
1421
"extended_timeout": datetime.timedelta(),
1422
"interval": datetime.timedelta(),
1423
"approved_by_default": True,
1424
"approval_delay": datetime.timedelta(),
1425
"approval_duration": datetime.timedelta(),
1427
"secret": io.BytesIO(b"x"),
1433
self.parser = argparse.ArgumentParser()
1434
add_command_line_options(self.parser)
1436
@contextlib.contextmanager
1437
def assertParseError(self):
1438
with self.assertRaises(SystemExit) as e:
1439
with self.temporarily_suppress_stderr():
1441
# Exit code from argparse is guaranteed to be "2". Reference:
1442
# https://docs.python.org/3/library/argparse.html#exiting-methods
1443
self.assertEqual(e.exception.code, 2)
1446
@contextlib.contextmanager
1447
def temporarily_suppress_stderr():
1448
null = os.open(os.path.devnull, os.O_RDWR)
1449
stderrcopy = os.dup(sys.stderr.fileno())
1450
os.dup2(null, sys.stderr.fileno())
1456
os.dup2(stderrcopy, sys.stderr.fileno())
1457
os.close(stderrcopy)
1459
def check_option_syntax(self, options):
1460
check_option_syntax(self.parser, options)
1462
def test_actions_requires_client_or_all(self):
1463
for action, value in self.actions.items():
1464
options = self.parser.parse_args()
1465
setattr(options, action, value)
1466
with self.assertParseError():
1467
self.check_option_syntax(options)
1469
def test_actions_conflicts_with_verbose(self):
1470
for action, value in self.actions.items():
1471
options = self.parser.parse_args()
1472
setattr(options, action, value)
1473
options.verbose = True
1474
with self.assertParseError():
1475
self.check_option_syntax(options)
1477
def test_dump_json_conflicts_with_verbose(self):
1478
options = self.parser.parse_args()
1479
options.dump_json = True
1480
options.verbose = True
1481
with self.assertParseError():
1482
self.check_option_syntax(options)
1484
def test_dump_json_conflicts_with_action(self):
1485
for action, value in self.actions.items():
1486
options = self.parser.parse_args()
1487
setattr(options, action, value)
1488
options.dump_json = True
1489
with self.assertParseError():
1490
self.check_option_syntax(options)
1492
def test_all_can_not_be_alone(self):
1493
options = self.parser.parse_args()
1495
with self.assertParseError():
1496
self.check_option_syntax(options)
1498
def test_all_is_ok_with_any_action(self):
1499
for action, value in self.actions.items():
1500
options = self.parser.parse_args()
1501
setattr(options, action, value)
1503
self.check_option_syntax(options)
1505
def test_is_enabled_fails_without_client(self):
1506
options = self.parser.parse_args()
1507
options.is_enabled = True
1508
with self.assertParseError():
1509
self.check_option_syntax(options)
1511
def test_is_enabled_works_with_one_client(self):
1512
options = self.parser.parse_args()
1513
options.is_enabled = True
1514
options.client = ["foo"]
1515
self.check_option_syntax(options)
1517
def test_is_enabled_fails_with_two_clients(self):
1518
options = self.parser.parse_args()
1519
options.is_enabled = True
1520
options.client = ["foo", "barbar"]
1521
with self.assertParseError():
1522
self.check_option_syntax(options)
1524
def test_remove_can_only_be_combined_with_action_deny(self):
1525
for action, value in self.actions.items():
1526
if action in {"remove", "deny"}:
1528
options = self.parser.parse_args()
1529
setattr(options, action, value)
1531
options.remove = True
1532
with self.assertParseError():
1533
self.check_option_syntax(options)
2786
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]