274
## Classes for commands.
276
# Abstract classes first
277
class Command(object):
278
"""Abstract class for commands"""
279
def run(self, mandos, clients):
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 client, properties in clients.items():
285
self.run_on_one_client(client, properties)
287
class PrintCmd(Command):
288
"""Abstract class for commands printing client details"""
289
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
290
"Created", "Interval", "Host", "KeyID",
291
"Fingerprint", "CheckerRunning", "LastEnabled",
292
"ApprovalPending", "ApprovedByDefault",
293
"LastApprovalRequest", "ApprovalDelay",
294
"ApprovalDuration", "Checker", "ExtendedTimeout",
295
"Expires", "LastCheckerStatus")
296
def run(self, mandos, clients):
297
print(self.output(clients))
299
class PropertyCmd(Command):
300
"""Abstract class for Actions for setting one client property"""
301
def run_on_one_client(self, client, properties):
302
"""Set the Client's D-Bus property"""
303
client.Set(client_interface, self.property, self.value_to_set,
304
dbus_interface=dbus.PROPERTIES_IFACE)
306
class ValueArgumentMixIn(object):
307
"""Mixin class for commands taking a value as argument"""
308
def __init__(self, value):
309
self.value_to_set = value
311
class MillisecondsValueArgumentMixIn(ValueArgumentMixIn):
312
"""Mixin class for commands taking a value argument as
315
def value_to_set(self):
318
def value_to_set(self, value):
319
"""When setting, convert value to a datetime.timedelta"""
320
self._vts = int(round(value.total_seconds() * 1000))
322
# Actual (non-abstract) command classes
324
class PrintTableCmd(PrintCmd):
325
def __init__(self, verbose=False):
326
self.verbose = verbose
328
def output(self, clients):
329
default_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
330
keywords = default_keywords
332
keywords = self.all_keywords
333
return str(self.TableOfClients(clients.values(), keywords))
335
class TableOfClients(object):
338
"Enabled": "Enabled",
339
"Timeout": "Timeout",
340
"LastCheckedOK": "Last Successful Check",
341
"LastApprovalRequest": "Last Approval Request",
342
"Created": "Created",
343
"Interval": "Interval",
345
"Fingerprint": "Fingerprint",
347
"CheckerRunning": "Check Is Running",
348
"LastEnabled": "Last Enabled",
349
"ApprovalPending": "Approval Is Pending",
350
"ApprovedByDefault": "Approved By Default",
351
"ApprovalDelay": "Approval Delay",
352
"ApprovalDuration": "Approval Duration",
353
"Checker": "Checker",
354
"ExtendedTimeout": "Extended Timeout",
355
"Expires": "Expires",
356
"LastCheckerStatus": "Last Checker Status",
359
def __init__(self, clients, keywords, tableheaders=None):
360
self.clients = clients
361
self.keywords = keywords
362
if tableheaders is not None:
363
self.tableheaders = tableheaders
366
return "\n".join(self.rows())
368
if sys.version_info.major == 2:
369
__unicode__ = __str__
371
return str(self).encode(locale.getpreferredencoding())
374
format_string = self.row_formatting_string()
375
rows = [self.header_line(format_string)]
376
rows.extend(self.client_line(client, format_string)
377
for client in self.clients)
380
def row_formatting_string(self):
381
"Format string used to format table rows"
382
return " ".join("{{{key}:{width}}}".format(
383
width=max(len(self.tableheaders[key]),
384
*(len(self.string_from_client(client, key))
385
for client in self.clients)),
387
for key in self.keywords)
389
def string_from_client(self, client, key):
390
return self.valuetostring(client[key], key)
393
def valuetostring(value, keyword):
394
if isinstance(value, dbus.Boolean):
395
return "Yes" if value else "No"
396
if keyword in ("Timeout", "Interval", "ApprovalDelay",
397
"ApprovalDuration", "ExtendedTimeout"):
398
return milliseconds_to_string(value)
401
def header_line(self, format_string):
402
return format_string.format(**self.tableheaders)
404
def client_line(self, client, format_string):
405
return format_string.format(
406
**{key: self.string_from_client(client, key)
407
for key in self.keywords})
411
class DumpJSONCmd(PrintCmd):
412
def output(self, clients):
413
data = {client["Name"]:
414
{key: self.dbus_boolean_to_bool(client[key])
415
for key in self.all_keywords}
416
for client in clients.values()}
417
return json.dumps(data, indent=4, separators=(',', ': '))
419
def dbus_boolean_to_bool(value):
420
if isinstance(value, dbus.Boolean):
424
class IsEnabledCmd(Command):
425
def run_on_one_client(self, client, properties):
426
if self.is_enabled(client, properties):
429
def is_enabled(self, client, properties):
430
return bool(properties["Enabled"])
432
class RemoveCmd(Command):
433
def run_on_one_client(self, client, properties):
434
self.mandos.RemoveClient(client.__dbus_object_path__)
436
class ApproveCmd(Command):
437
def run_on_one_client(self, client, properties):
438
client.Approve(dbus.Boolean(True),
439
dbus_interface=client_interface)
441
class DenyCmd(Command):
442
def run_on_one_client(self, client, properties):
443
client.Approve(dbus.Boolean(False),
444
dbus_interface=client_interface)
446
class EnableCmd(PropertyCmd):
448
value_to_set = dbus.Boolean(True)
450
class DisableCmd(PropertyCmd):
452
value_to_set = dbus.Boolean(False)
454
class BumpTimeoutCmd(PropertyCmd):
455
property = "LastCheckedOK"
458
class StartCheckerCmd(PropertyCmd):
459
property = "CheckerRunning"
460
value_to_set = dbus.Boolean(True)
462
class StopCheckerCmd(PropertyCmd):
463
property = "CheckerRunning"
464
value_to_set = dbus.Boolean(False)
466
class ApproveByDefaultCmd(PropertyCmd):
467
property = "ApprovedByDefault"
468
value_to_set = dbus.Boolean(True)
470
class DenyByDefaultCmd(PropertyCmd):
471
property = "ApprovedByDefault"
472
value_to_set = dbus.Boolean(False)
474
class SetCheckerCmd(PropertyCmd, ValueArgumentMixIn):
477
class SetHostCmd(PropertyCmd, ValueArgumentMixIn):
480
class SetSecretCmd(PropertyCmd, ValueArgumentMixIn):
482
def value_to_set(self):
485
def value_to_set(self, value):
486
"""When setting, read data from supplied file object"""
487
self._vts = value.read()
491
class SetTimeoutCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
494
class SetExtendedTimeoutCmd(PropertyCmd,
495
MillisecondsValueArgumentMixIn):
496
property = "ExtendedTimeout"
498
class SetIntervalCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
499
property = "Interval"
501
class SetApprovalDelayCmd(PropertyCmd,
502
MillisecondsValueArgumentMixIn):
503
property = "ApprovalDelay"
505
class SetApprovalDurationCmd(PropertyCmd,
506
MillisecondsValueArgumentMixIn):
507
property = "ApprovalDuration"
509
def add_command_line_options(parser):
510
parser.add_argument("--version", action="version",
511
version="%(prog)s {}".format(version),
512
help="show version number and exit")
513
parser.add_argument("-a", "--all", action="store_true",
514
help="Select all clients")
515
parser.add_argument("-v", "--verbose", action="store_true",
516
help="Print all fields")
517
parser.add_argument("-j", "--dump-json", action="store_true",
518
help="Dump client data in JSON format")
519
enable_disable = parser.add_mutually_exclusive_group()
520
enable_disable.add_argument("-e", "--enable", action="store_true",
521
help="Enable client")
522
enable_disable.add_argument("-d", "--disable",
524
help="disable client")
525
parser.add_argument("-b", "--bump-timeout", action="store_true",
526
help="Bump timeout for client")
527
start_stop_checker = parser.add_mutually_exclusive_group()
528
start_stop_checker.add_argument("--start-checker",
530
help="Start checker for client")
531
start_stop_checker.add_argument("--stop-checker",
533
help="Stop checker for client")
534
parser.add_argument("-V", "--is-enabled", action="store_true",
535
help="Check if client is enabled")
536
parser.add_argument("-r", "--remove", action="store_true",
537
help="Remove client")
538
parser.add_argument("-c", "--checker",
539
help="Set checker command for client")
540
parser.add_argument("-t", "--timeout", type=string_to_delta,
541
help="Set timeout for client")
542
parser.add_argument("--extended-timeout", type=string_to_delta,
543
help="Set extended timeout for client")
544
parser.add_argument("-i", "--interval", type=string_to_delta,
545
help="Set checker interval for client")
546
approve_deny_default = parser.add_mutually_exclusive_group()
547
approve_deny_default.add_argument(
548
"--approve-by-default", action="store_true",
549
default=None, dest="approved_by_default",
550
help="Set client to be approved by default")
551
approve_deny_default.add_argument(
552
"--deny-by-default", action="store_false",
553
dest="approved_by_default",
554
help="Set client to be denied by default")
555
parser.add_argument("--approval-delay", type=string_to_delta,
556
help="Set delay before client approve/deny")
557
parser.add_argument("--approval-duration", type=string_to_delta,
558
help="Set duration of one client approval")
559
parser.add_argument("-H", "--host", help="Set host for client")
560
parser.add_argument("-s", "--secret",
561
type=argparse.FileType(mode="rb"),
562
help="Set password blob (file) for client")
563
approve_deny = parser.add_mutually_exclusive_group()
564
approve_deny.add_argument(
565
"-A", "--approve", action="store_true",
566
help="Approve any current client request")
567
approve_deny.add_argument("-D", "--deny", action="store_true",
568
help="Deny any current client request")
569
parser.add_argument("--check", action="store_true",
570
help="Run self-test")
571
parser.add_argument("client", nargs="*", help="Client name")
574
def commands_from_options(options):
578
if options.dump_json:
579
commands.append(DumpJSONCmd())
582
commands.append(EnableCmd())
585
commands.append(DisableCmd())
587
if options.bump_timeout:
588
commands.append(BumpTimeoutCmd())
590
if options.start_checker:
591
commands.append(StartCheckerCmd())
593
if options.stop_checker:
594
commands.append(StopCheckerCmd())
596
if options.is_enabled:
597
commands.append(IsEnabledCmd())
600
commands.append(RemoveCmd())
602
if options.checker is not None:
603
commands.append(SetCheckerCmd(options.checker))
605
if options.timeout is not None:
606
commands.append(SetTimeoutCmd(options.timeout))
608
if options.extended_timeout:
610
SetExtendedTimeoutCmd(options.extended_timeout))
612
if options.interval is not None:
613
commands.append(SetIntervalCmd(options.interval))
615
if options.approved_by_default is not None:
616
if options.approved_by_default:
617
commands.append(ApproveByDefaultCmd())
619
commands.append(DenyByDefaultCmd())
621
if options.approval_delay is not None:
622
commands.append(SetApprovalDelayCmd(options.approval_delay))
624
if options.approval_duration is not None:
626
SetApprovalDurationCmd(options.approval_duration))
628
if options.host is not None:
629
commands.append(SetHostCmd(options.host))
631
if options.secret is not None:
632
commands.append(SetSecretCmd(options.secret))
635
commands.append(ApproveCmd())
638
commands.append(DenyCmd())
640
# If no command option has been given, show table of clients,
641
# optionally verbosely
643
commands.append(PrintTableCmd(verbose=options.verbose))
648
423
def check_option_syntax(parser, options):
649
424
"""Apply additional restrictions on options, not expressible in
652
def has_actions(options):
653
return any((options.enable,
655
options.bump_timeout,
656
options.start_checker,
657
options.stop_checker,
660
options.checker is not None,
661
options.timeout is not None,
662
options.extended_timeout is not None,
663
options.interval is not None,
664
options.approved_by_default is not None,
665
options.approval_delay is not None,
666
options.approval_duration is not None,
667
options.host is not None,
668
options.secret is not None,
427
def has_commands(options, commands=None):
429
commands = (command.Enable,
432
command.StartChecker,
438
command.SetExtendedTimeout,
440
command.ApproveByDefault,
441
command.DenyByDefault,
442
command.SetApprovalDelay,
443
command.SetApprovalDuration,
448
return any(isinstance(cmd, commands)
449
for cmd in options.commands)
672
if has_actions(options) and not (options.client or options.all):
451
if has_commands(options) and not (options.client or options.all):
673
452
parser.error("Options require clients names or --all.")
674
if options.verbose and has_actions(options):
453
if options.verbose and has_commands(options):
675
454
parser.error("--verbose can only be used alone.")
676
if options.dump_json and (options.verbose
677
or has_actions(options)):
455
if (has_commands(options, (command.DumpJSON,))
456
and (options.verbose or len(options.commands) > 1)):
678
457
parser.error("--dump-json can only be used alone.")
679
if options.all and not has_actions(options):
458
if options.all and not has_commands(options):
680
459
parser.error("--all requires an action.")
681
if options.is_enabled and len(options.client) > 1:
460
if (has_commands(options, (command.IsEnabled,))
461
and len(options.client) > 1):
682
462
parser.error("--is-enabled requires exactly one client")
686
parser = argparse.ArgumentParser()
688
add_command_line_options(parser)
690
options = parser.parse_args()
692
check_option_syntax(parser, options)
694
clientnames = options.client
697
bus = dbus.SystemBus()
698
mandos_dbus_objc = bus.get_object(busname, server_path)
699
except dbus.exceptions.DBusException:
700
log.critical("Could not connect to Mandos server")
703
mandos_serv = dbus.Interface(mandos_dbus_objc,
704
dbus_interface=server_interface)
705
mandos_serv_object_manager = dbus.Interface(
706
mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
708
# Filter out log message from dbus module
709
dbus_logger = logging.getLogger("dbus.proxies")
710
class NullFilter(logging.Filter):
711
def filter(self, record):
713
dbus_filter = NullFilter()
715
dbus_logger.addFilter(dbus_filter)
716
mandos_clients = {path: ifs_and_props[client_interface]
717
for path, ifs_and_props in
718
mandos_serv_object_manager
719
.GetManagedObjects().items()
720
if client_interface in ifs_and_props}
721
except dbus.exceptions.DBusException as e:
722
log.critical("Failed to access Mandos server through D-Bus:"
726
# restore dbus logger
727
dbus_logger.removeFilter(dbus_filter)
729
# Compile dict of (clients: properties) to process
733
clients = {bus.get_object(busname, path): properties
734
for path, properties in mandos_clients.items()}
736
for name in clientnames:
737
for path, client in mandos_clients.items():
738
if client["Name"] == name:
739
client_objc = bus.get_object(busname, path)
740
clients[client_objc] = client
743
log.critical("Client not found on server: %r", name)
746
# Run all commands on clients
747
commands = commands_from_options(options)
748
for command in commands:
749
command.run(mandos_serv, clients)
463
if (len(options.commands) > 1
464
and has_commands(options, (command.Remove,))
465
and not has_commands(options, (command.Deny,))):
466
parser.error("--remove can only be combined with --deny")
471
class SystemBus(object):
473
object_manager_iface = "org.freedesktop.DBus.ObjectManager"
474
def get_managed_objects(self, busname, objectpath):
475
return self.call_method("GetManagedObjects", busname,
477
self.object_manager_iface)
479
properties_iface = "org.freedesktop.DBus.Properties"
480
def set_property(self, busname, objectpath, interface, key,
482
self.call_method("Set", busname, objectpath,
483
self.properties_iface, interface, key,
487
class MandosBus(SystemBus):
488
busname_domain = "se.recompile"
489
busname = busname_domain + ".Mandos"
491
server_interface = busname_domain + ".Mandos"
492
client_interface = busname_domain + ".Mandos.Client"
495
def get_clients_and_properties(self):
496
managed_objects = self.get_managed_objects(
497
self.busname, self.server_path)
498
return {objpath: properties[self.client_interface]
499
for objpath, properties in managed_objects.items()
500
if self.client_interface in properties}
502
def set_client_property(self, objectpath, key, value):
503
return self.set_property(self.busname, objectpath,
504
self.client_interface, key,
507
def call_client_method(self, objectpath, method, *args):
508
return self.call_method(method, self.busname, objectpath,
509
self.client_interface, *args)
511
def call_server_method(self, method, *args):
512
return self.call_method(method, self.busname,
514
self.server_interface, *args)
516
class Error(Exception):
519
class ConnectFailed(Error):
523
class dbus_python_adapter(object):
525
class SystemBus(dbus.MandosBus):
526
"""Use dbus-python"""
528
def __init__(self, module=dbus_python):
529
self.dbus_python = module
530
self.bus = self.dbus_python.SystemBus()
532
@contextlib.contextmanager
533
def convert_exception(self, exception_class=dbus.Error):
536
except self.dbus_python.exceptions.DBusException as e:
537
# This does what "raise from" would do
538
exc = exception_class(*e.args)
542
def call_method(self, methodname, busname, objectpath,
544
proxy_object = self.get_object(busname, objectpath)
545
log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
546
interface, methodname,
547
", ".join(repr(a) for a in args))
548
method = getattr(proxy_object, methodname)
549
with self.convert_exception():
550
with dbus_python_adapter.SilenceLogger(
552
value = method(*args, dbus_interface=interface)
553
return self.type_filter(value)
555
def get_object(self, busname, objectpath):
556
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
558
with self.convert_exception(dbus.ConnectFailed):
559
return self.bus.get_object(busname, objectpath)
561
def type_filter(self, value):
562
"""Convert the most bothersome types to Python types"""
563
if isinstance(value, self.dbus_python.Boolean):
565
if isinstance(value, self.dbus_python.ObjectPath):
567
# Also recurse into dictionaries
568
if isinstance(value, self.dbus_python.Dictionary):
569
return {self.type_filter(key):
570
self.type_filter(subval)
571
for key, subval in value.items()}
575
class SilenceLogger(object):
576
"Simple context manager to silence a particular logger"
577
def __init__(self, loggername):
578
self.logger = logging.getLogger(loggername)
581
self.logger.addFilter(self.nullfilter)
583
class NullFilter(logging.Filter):
584
def filter(self, record):
587
nullfilter = NullFilter()
589
def __exit__(self, exc_type, exc_val, exc_tb):
590
self.logger.removeFilter(self.nullfilter)
593
class CachingBus(SystemBus):
594
"""A caching layer for dbus_python_adapter.SystemBus"""
595
def __init__(self, *args, **kwargs):
596
self.object_cache = {}
597
super(dbus_python_adapter.CachingBus,
598
self).__init__(*args, **kwargs)
599
def get_object(self, busname, objectpath):
601
return self.object_cache[(busname, objectpath)]
604
dbus_python_adapter.CachingBus,
605
self).get_object(busname, objectpath)
606
self.object_cache[(busname, objectpath)] = new_object
610
class pydbus_adapter(object):
611
class SystemBus(dbus.MandosBus):
612
def __init__(self, module=pydbus):
614
self.bus = self.pydbus.SystemBus()
616
@contextlib.contextmanager
617
def convert_exception(self, exception_class=dbus.Error):
620
except gi.repository.GLib.Error as e:
621
# This does what "raise from" would do
622
exc = exception_class(*e.args)
626
def call_method(self, methodname, busname, objectpath,
628
proxy_object = self.get(busname, objectpath)
629
log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
630
interface, methodname,
631
", ".join(repr(a) for a in args))
632
method = getattr(proxy_object[interface], methodname)
633
with self.convert_exception():
636
def get(self, busname, objectpath):
637
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
639
with self.convert_exception(dbus.ConnectFailed):
640
if sys.version_info.major <= 2:
641
with warnings.catch_warnings():
642
warnings.filterwarnings(
643
"ignore", "", DeprecationWarning,
644
r"^xml\.etree\.ElementTree$")
645
return self.bus.get(busname, objectpath)
647
return self.bus.get(busname, objectpath)
649
def set_property(self, busname, objectpath, interface, key,
651
proxy_object = self.get(busname, objectpath)
652
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", busname,
653
objectpath, self.properties_iface, interface,
655
setattr(proxy_object[interface], key, value)
657
class CachingBus(SystemBus):
658
"""A caching layer for pydbus_adapter.SystemBus"""
659
def __init__(self, *args, **kwargs):
660
self.object_cache = {}
661
super(pydbus_adapter.CachingBus,
662
self).__init__(*args, **kwargs)
663
def get(self, busname, objectpath):
665
return self.object_cache[(busname, objectpath)]
667
new_object = (super(pydbus_adapter.CachingBus, self)
668
.get(busname, objectpath))
669
self.object_cache[(busname, objectpath)] = new_object
673
def commands_from_options(options):
675
commands = list(options.commands)
677
def find_cmd(cmd, commands):
679
for i, c in enumerate(commands):
680
if isinstance(c, cmd):
684
# If command.Remove is present, move any instances of command.Deny
685
# to occur ahead of command.Remove.
686
index_of_remove = find_cmd(command.Remove, commands)
687
before_remove = commands[:index_of_remove]
688
after_remove = commands[index_of_remove:]
690
for cmd in after_remove:
691
if isinstance(cmd, command.Deny):
692
before_remove.append(cmd)
694
cleaned_after.append(cmd)
695
if cleaned_after != after_remove:
696
commands = before_remove + cleaned_after
698
# If no command option has been given, show table of clients,
699
# optionally verbosely
701
commands.append(command.PrintTable(verbose=options.verbose))
706
class command(object):
707
"""A namespace for command classes"""
710
"""Abstract base class for commands"""
711
def run(self, clients, bus=None):
712
"""Normal commands should implement run_on_one_client(),
713
but commands which want to operate on all clients at the same time can
714
override this run() method instead.
717
for client, properties in clients.items():
718
self.run_on_one_client(client, properties)
721
class IsEnabled(Base):
722
def run(self, clients, bus=None):
723
properties = next(iter(clients.values()))
724
if properties["Enabled"]:
730
def run_on_one_client(self, client, properties):
731
self.bus.call_client_method(client, "Approve", True)
735
def run_on_one_client(self, client, properties):
736
self.bus.call_client_method(client, "Approve", False)
740
def run(self, clients, bus):
741
for clientpath in frozenset(clients.keys()):
742
bus.call_server_method("RemoveClient", clientpath)
746
"""Abstract class for commands outputting client details"""
747
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
748
"Created", "Interval", "Host", "KeyID",
749
"Fingerprint", "CheckerRunning",
750
"LastEnabled", "ApprovalPending",
751
"ApprovedByDefault", "LastApprovalRequest",
752
"ApprovalDelay", "ApprovalDuration",
753
"Checker", "ExtendedTimeout", "Expires",
757
class DumpJSON(Output):
758
def run(self, clients, bus=None):
759
data = {properties["Name"]:
760
{key: properties[key]
761
for key in self.all_keywords}
762
for properties in clients.values()}
763
print(json.dumps(data, indent=4, separators=(',', ': ')))
766
class PrintTable(Output):
767
def __init__(self, verbose=False):
768
self.verbose = verbose
770
def run(self, clients, bus=None):
771
default_keywords = ("Name", "Enabled", "Timeout",
773
keywords = default_keywords
775
keywords = self.all_keywords
776
print(self.TableOfClients(clients.values(), keywords))
778
class TableOfClients(object):
781
"Enabled": "Enabled",
782
"Timeout": "Timeout",
783
"LastCheckedOK": "Last Successful Check",
784
"LastApprovalRequest": "Last Approval Request",
785
"Created": "Created",
786
"Interval": "Interval",
788
"Fingerprint": "Fingerprint",
790
"CheckerRunning": "Check Is Running",
791
"LastEnabled": "Last Enabled",
792
"ApprovalPending": "Approval Is Pending",
793
"ApprovedByDefault": "Approved By Default",
794
"ApprovalDelay": "Approval Delay",
795
"ApprovalDuration": "Approval Duration",
796
"Checker": "Checker",
797
"ExtendedTimeout": "Extended Timeout",
798
"Expires": "Expires",
799
"LastCheckerStatus": "Last Checker Status",
802
def __init__(self, clients, keywords):
803
self.clients = clients
804
self.keywords = keywords
807
return "\n".join(self.rows())
809
if sys.version_info.major == 2:
810
__unicode__ = __str__
812
return str(self).encode(
813
locale.getpreferredencoding())
816
format_string = self.row_formatting_string()
817
rows = [self.header_line(format_string)]
818
rows.extend(self.client_line(client, format_string)
819
for client in self.clients)
822
def row_formatting_string(self):
823
"Format string used to format table rows"
824
return " ".join("{{{key}:{width}}}".format(
825
width=max(len(self.tableheaders[key]),
826
*(len(self.string_from_client(client,
828
for client in self.clients)),
830
for key in self.keywords)
832
def string_from_client(self, client, key):
833
return self.valuetostring(client[key], key)
836
def valuetostring(cls, value, keyword):
837
if isinstance(value, bool):
838
return "Yes" if value else "No"
839
if keyword in ("Timeout", "Interval", "ApprovalDelay",
840
"ApprovalDuration", "ExtendedTimeout"):
841
return cls.milliseconds_to_string(value)
844
def header_line(self, format_string):
845
return format_string.format(**self.tableheaders)
847
def client_line(self, client, format_string):
848
return format_string.format(
849
**{key: self.string_from_client(client, key)
850
for key in self.keywords})
853
def milliseconds_to_string(ms):
854
td = datetime.timedelta(0, 0, 0, ms)
855
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
856
.format(days="{}T".format(td.days)
858
hours=td.seconds // 3600,
859
minutes=(td.seconds % 3600) // 60,
860
seconds=td.seconds % 60))
863
class PropertySetter(Base):
864
"Abstract class for Actions for setting one client property"
866
def run_on_one_client(self, client, properties=None):
867
"""Set the Client's D-Bus property"""
868
self.bus.set_client_property(client, self.propname,
873
raise NotImplementedError()
876
class Enable(PropertySetter):
881
class Disable(PropertySetter):
886
class BumpTimeout(PropertySetter):
887
propname = "LastCheckedOK"
891
class StartChecker(PropertySetter):
892
propname = "CheckerRunning"
896
class StopChecker(PropertySetter):
897
propname = "CheckerRunning"
901
class ApproveByDefault(PropertySetter):
902
propname = "ApprovedByDefault"
906
class DenyByDefault(PropertySetter):
907
propname = "ApprovedByDefault"
911
class PropertySetterValue(PropertySetter):
912
"""Abstract class for PropertySetter recieving a value as
913
constructor argument instead of a class attribute."""
914
def __init__(self, value):
915
self.value_to_set = value
918
def argparse(cls, argtype):
920
return cls(argtype(arg))
923
class SetChecker(PropertySetterValue):
927
class SetHost(PropertySetterValue):
931
class SetSecret(PropertySetterValue):
935
def value_to_set(self):
939
def value_to_set(self, value):
940
"""When setting, read data from supplied file object"""
941
self._vts = value.read()
945
class PropertySetterValueMilliseconds(PropertySetterValue):
946
"""Abstract class for PropertySetterValue taking a value
947
argument as a datetime.timedelta() but should store it as
951
def value_to_set(self):
955
def value_to_set(self, value):
956
"When setting, convert value from a datetime.timedelta"
957
self._vts = int(round(value.total_seconds() * 1000))
960
class SetTimeout(PropertySetterValueMilliseconds):
964
class SetExtendedTimeout(PropertySetterValueMilliseconds):
965
propname = "ExtendedTimeout"
968
class SetInterval(PropertySetterValueMilliseconds):
969
propname = "Interval"
972
class SetApprovalDelay(PropertySetterValueMilliseconds):
973
propname = "ApprovalDelay"
976
class SetApprovalDuration(PropertySetterValueMilliseconds):
977
propname = "ApprovalDuration"
752
class Test_milliseconds_to_string(unittest.TestCase):
754
self.assertEqual(milliseconds_to_string(93785000),
756
def test_no_days(self):
757
self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
758
def test_all_zero(self):
759
self.assertEqual(milliseconds_to_string(0), "00:00:00")
760
def test_no_fractional_seconds(self):
761
self.assertEqual(milliseconds_to_string(400), "00:00:00")
762
self.assertEqual(milliseconds_to_string(900), "00:00:00")
763
self.assertEqual(milliseconds_to_string(1900), "00:00:01")
765
class Test_string_to_delta(unittest.TestCase):
766
def test_handles_basic_rfc3339(self):
767
self.assertEqual(string_to_delta("PT0S"),
768
datetime.timedelta())
769
self.assertEqual(string_to_delta("P0D"),
770
datetime.timedelta())
771
self.assertEqual(string_to_delta("PT1S"),
772
datetime.timedelta(0, 1))
773
self.assertEqual(string_to_delta("PT2H"),
774
datetime.timedelta(0, 7200))
981
class TestCaseWithAssertLogs(unittest.TestCase):
982
"""unittest.TestCase.assertLogs only exists in Python 3.4"""
984
if not hasattr(unittest.TestCase, "assertLogs"):
985
@contextlib.contextmanager
986
def assertLogs(self, logger, level=logging.INFO):
987
capturing_handler = self.CapturingLevelHandler(level)
988
old_level = logger.level
989
old_propagate = logger.propagate
990
logger.addHandler(capturing_handler)
991
logger.setLevel(level)
992
logger.propagate = False
994
yield capturing_handler.watcher
996
logger.propagate = old_propagate
997
logger.removeHandler(capturing_handler)
998
logger.setLevel(old_level)
999
self.assertGreater(len(capturing_handler.watcher.records),
1002
class CapturingLevelHandler(logging.Handler):
1003
def __init__(self, level, *args, **kwargs):
1004
logging.Handler.__init__(self, *args, **kwargs)
1005
self.watcher = self.LoggingWatcher([], [])
1006
def emit(self, record):
1007
self.watcher.records.append(record)
1008
self.watcher.output.append(self.format(record))
1010
LoggingWatcher = collections.namedtuple("LoggingWatcher",
1015
class Unique(object):
1016
"""Class for objects which exist only to be unique objects, since
1017
unittest.mock.sentinel only exists in Python 3.3"""
1020
class Test_string_to_delta(TestCaseWithAssertLogs):
1021
# Just test basic RFC 3339 functionality here, the doc string for
1022
# rfc3339_duration_to_delta() already has more comprehensive
1023
# tests, which are run by doctest.
1025
def test_rfc3339_zero_seconds(self):
1026
self.assertEqual(datetime.timedelta(),
1027
string_to_delta("PT0S"))
1029
def test_rfc3339_zero_days(self):
1030
self.assertEqual(datetime.timedelta(), string_to_delta("P0D"))
1032
def test_rfc3339_one_second(self):
1033
self.assertEqual(datetime.timedelta(0, 1),
1034
string_to_delta("PT1S"))
1036
def test_rfc3339_two_hours(self):
1037
self.assertEqual(datetime.timedelta(0, 7200),
1038
string_to_delta("PT2H"))
775
1040
def test_falls_back_to_pre_1_6_1_with_warning(self):
776
# assertLogs only exists in Python 3.4
777
if hasattr(self, "assertLogs"):
778
with self.assertLogs(log, logging.WARNING):
779
value = string_to_delta("2h")
1041
with self.assertLogs(log, logging.WARNING):
1042
value = string_to_delta("2h")
1043
self.assertEqual(datetime.timedelta(0, 7200), value)
1046
class Test_check_option_syntax(unittest.TestCase):
1048
self.parser = argparse.ArgumentParser()
1049
add_command_line_options(self.parser)
1051
def test_actions_requires_client_or_all(self):
1052
for action, value in self.actions.items():
1053
args = self.actionargs(action, value)
1054
with self.assertParseError():
1055
self.parse_args(args)
1057
# This mostly corresponds to the definition from has_commands() in
1058
# check_option_syntax()
1062
"--bump-timeout": None,
1063
"--start-checker": None,
1064
"--stop-checker": None,
1065
"--is-enabled": None,
1068
"--timeout": "PT0S",
1069
"--extended-timeout": "PT0S",
1070
"--interval": "PT0S",
1071
"--approve-by-default": None,
1072
"--deny-by-default": None,
1073
"--approval-delay": "PT0S",
1074
"--approval-duration": "PT0S",
1075
"--host": "hostname",
1076
"--secret": "/dev/null",
1082
def actionargs(action, value, *args):
1083
if value is not None:
1084
return [action, value] + list(args)
781
class WarningFilter(logging.Filter):
782
"""Don't show, but record the presence of, warnings"""
783
def filter(self, record):
784
is_warning = record.levelno >= logging.WARNING
785
self.found = is_warning or getattr(self, "found",
787
return not is_warning
788
warning_filter = WarningFilter()
789
log.addFilter(warning_filter)
1086
return [action] + list(args)
1088
@contextlib.contextmanager
1089
def assertParseError(self):
1090
with self.assertRaises(SystemExit) as e:
1091
with self.redirect_stderr_to_devnull():
1093
# Exit code from argparse is guaranteed to be "2". Reference:
1094
# https://docs.python.org/3/library
1095
# /argparse.html#exiting-methods
1096
self.assertEqual(2, e.exception.code)
1098
def parse_args(self, args):
1099
options = self.parser.parse_args(args)
1100
check_option_syntax(self.parser, options)
1103
@contextlib.contextmanager
1104
def redirect_stderr_to_devnull():
1105
old_stderr = sys.stderr
1106
with contextlib.closing(open(os.devnull, "w")) as null:
791
value = string_to_delta("2h")
793
log.removeFilter(warning_filter)
794
self.assertTrue(getattr(warning_filter, "found", False))
795
self.assertEqual(value, datetime.timedelta(0, 7200))
798
class TestCmd(unittest.TestCase):
1111
sys.stderr = old_stderr
1113
def check_option_syntax(self, options):
1114
check_option_syntax(self.parser, options)
1116
def test_actions_all_conflicts_with_verbose(self):
1117
for action, value in self.actions.items():
1118
args = self.actionargs(action, value, "--all",
1120
with self.assertParseError():
1121
self.parse_args(args)
1123
def test_actions_with_client_conflicts_with_verbose(self):
1124
for action, value in self.actions.items():
1125
args = self.actionargs(action, value, "--verbose",
1127
with self.assertParseError():
1128
self.parse_args(args)
1130
def test_dump_json_conflicts_with_verbose(self):
1131
args = ["--dump-json", "--verbose"]
1132
with self.assertParseError():
1133
self.parse_args(args)
1135
def test_dump_json_conflicts_with_action(self):
1136
for action, value in self.actions.items():
1137
args = self.actionargs(action, value, "--dump-json")
1138
with self.assertParseError():
1139
self.parse_args(args)
1141
def test_all_can_not_be_alone(self):
1143
with self.assertParseError():
1144
self.parse_args(args)
1146
def test_all_is_ok_with_any_action(self):
1147
for action, value in self.actions.items():
1148
args = self.actionargs(action, value, "--all")
1149
self.parse_args(args)
1151
def test_any_action_is_ok_with_one_client(self):
1152
for action, value in self.actions.items():
1153
args = self.actionargs(action, value, "client")
1154
self.parse_args(args)
1156
def test_one_client_with_all_actions_except_is_enabled(self):
1157
for action, value in self.actions.items():
1158
if action == "--is-enabled":
1160
args = self.actionargs(action, value, "client")
1161
self.parse_args(args)
1163
def test_two_clients_with_all_actions_except_is_enabled(self):
1164
for action, value in self.actions.items():
1165
if action == "--is-enabled":
1167
args = self.actionargs(action, value, "client1",
1169
self.parse_args(args)
1171
def test_two_clients_are_ok_with_actions_except_is_enabled(self):
1172
for action, value in self.actions.items():
1173
if action == "--is-enabled":
1175
args = self.actionargs(action, value, "client1",
1177
self.parse_args(args)
1179
def test_is_enabled_fails_without_client(self):
1180
args = ["--is-enabled"]
1181
with self.assertParseError():
1182
self.parse_args(args)
1184
def test_is_enabled_fails_with_two_clients(self):
1185
args = ["--is-enabled", "client1", "client2"]
1186
with self.assertParseError():
1187
self.parse_args(args)
1189
def test_remove_can_only_be_combined_with_action_deny(self):
1190
for action, value in self.actions.items():
1191
if action in {"--remove", "--deny"}:
1193
args = self.actionargs(action, value, "--all",
1195
with self.assertParseError():
1196
self.parse_args(args)
1199
class Test_dbus_exceptions(unittest.TestCase):
1201
def test_dbus_ConnectFailed_is_Error(self):
1202
with self.assertRaises(dbus.Error):
1203
raise dbus.ConnectFailed()
1206
class Test_dbus_MandosBus(unittest.TestCase):
1208
class MockMandosBus(dbus.MandosBus):
1210
self._name = "se.recompile.Mandos"
1211
self._server_path = "/"
1212
self._server_interface = "se.recompile.Mandos"
1213
self._client_interface = "se.recompile.Mandos.Client"
1215
self.call_method_return = Unique()
1217
def call_method(self, methodname, busname, objectpath,
1219
self.calls.append((methodname, busname, objectpath,
1221
return self.call_method_return
1224
self.bus = self.MockMandosBus()
1226
def test_set_client_property(self):
1227
self.bus.set_client_property("objectpath", "key", "value")
1228
expected_call = ("Set", self.bus._name, "objectpath",
1229
"org.freedesktop.DBus.Properties",
1230
(self.bus._client_interface, "key", "value"))
1231
self.assertIn(expected_call, self.bus.calls)
1233
def test_call_client_method(self):
1234
ret = self.bus.call_client_method("objectpath", "methodname")
1235
self.assertIs(self.bus.call_method_return, ret)
1236
expected_call = ("methodname", self.bus._name, "objectpath",
1237
self.bus._client_interface, ())
1238
self.assertIn(expected_call, self.bus.calls)
1240
def test_call_client_method_with_args(self):
1241
args = (Unique(), Unique())
1242
ret = self.bus.call_client_method("objectpath", "methodname",
1244
self.assertIs(self.bus.call_method_return, ret)
1245
expected_call = ("methodname", self.bus._name, "objectpath",
1246
self.bus._client_interface,
1248
self.assertIn(expected_call, self.bus.calls)
1250
def test_get_clients_and_properties(self):
1253
self.bus._client_interface: {
1257
"irrelevant_interface": {
1258
"key": "othervalue",
1262
"other_objectpath": {
1263
"other_irrelevant_interface": {
1269
expected_clients_and_properties = {
1275
self.bus.call_method_return = managed_objects
1276
ret = self.bus.get_clients_and_properties()
1277
self.assertDictEqual(expected_clients_and_properties, ret)
1278
expected_call = ("GetManagedObjects", self.bus._name,
1279
self.bus._server_path,
1280
"org.freedesktop.DBus.ObjectManager", ())
1281
self.assertIn(expected_call, self.bus.calls)
1283
def test_call_server_method(self):
1284
ret = self.bus.call_server_method("methodname")
1285
self.assertIs(self.bus.call_method_return, ret)
1286
expected_call = ("methodname", self.bus._name,
1287
self.bus._server_path,
1288
self.bus._server_interface, ())
1289
self.assertIn(expected_call, self.bus.calls)
1291
def test_call_server_method_with_args(self):
1292
args = (Unique(), Unique())
1293
ret = self.bus.call_server_method("methodname", *args)
1294
self.assertIs(self.bus.call_method_return, ret)
1295
expected_call = ("methodname", self.bus._name,
1296
self.bus._server_path,
1297
self.bus._server_interface,
1299
self.assertIn(expected_call, self.bus.calls)
1302
class Test_dbus_python_adapter_SystemBus(TestCaseWithAssertLogs):
1304
def MockDBusPython_func(self, func):
1305
class mock_dbus_python(object):
1306
"""mock dbus-python module"""
1307
class exceptions(object):
1308
"""Pseudo-namespace"""
1309
class DBusException(Exception):
1311
class SystemBus(object):
1313
def get_object(busname, objectpath):
1314
DBusObject = collections.namedtuple(
1315
"DBusObject", ("methodname",))
1316
def method(*args, **kwargs):
1317
self.assertEqual({"dbus_interface":
1321
return DBusObject(methodname=method)
1322
class Boolean(object):
1323
def __init__(self, value):
1324
self.value = bool(value)
1327
if sys.version_info.major == 2:
1328
__nonzero__ = __bool__
1329
class ObjectPath(str):
1331
class Dictionary(dict):
1333
return mock_dbus_python
1335
def call_method(self, bus, methodname, busname, objectpath,
1337
with self.assertLogs(log, logging.DEBUG):
1338
return bus.call_method(methodname, busname, objectpath,
1341
def test_call_method_returns(self):
1342
expected_method_return = Unique()
1343
method_args = (Unique(), Unique())
1345
self.assertEqual(len(method_args), len(args))
1346
for marg, arg in zip(method_args, args):
1347
self.assertIs(marg, arg)
1348
return expected_method_return
1349
mock_dbus_python = self.MockDBusPython_func(func)
1350
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1351
ret = self.call_method(bus, "methodname", "busname",
1352
"objectpath", "interface",
1354
self.assertIs(ret, expected_method_return)
1356
def test_call_method_filters_bool_true(self):
1358
return method_return
1359
mock_dbus_python = self.MockDBusPython_func(func)
1360
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1361
method_return = mock_dbus_python.Boolean(True)
1362
ret = self.call_method(bus, "methodname", "busname",
1363
"objectpath", "interface")
1364
self.assertTrue(ret)
1365
self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1367
def test_call_method_filters_bool_false(self):
1369
return method_return
1370
mock_dbus_python = self.MockDBusPython_func(func)
1371
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1372
method_return = mock_dbus_python.Boolean(False)
1373
ret = self.call_method(bus, "methodname", "busname",
1374
"objectpath", "interface")
1375
self.assertFalse(ret)
1376
self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1378
def test_call_method_filters_objectpath(self):
1380
return method_return
1381
mock_dbus_python = self.MockDBusPython_func(func)
1382
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1383
method_return = mock_dbus_python.ObjectPath("objectpath")
1384
ret = self.call_method(bus, "methodname", "busname",
1385
"objectpath", "interface")
1386
self.assertEqual("objectpath", ret)
1387
self.assertIsNot("objectpath", ret)
1388
self.assertNotIsInstance(ret, mock_dbus_python.ObjectPath)
1390
def test_call_method_filters_booleans_in_dict(self):
1392
return method_return
1393
mock_dbus_python = self.MockDBusPython_func(func)
1394
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1395
method_return = mock_dbus_python.Dictionary(
1396
{mock_dbus_python.Boolean(True):
1397
mock_dbus_python.Boolean(False),
1398
mock_dbus_python.Boolean(False):
1399
mock_dbus_python.Boolean(True)})
1400
ret = self.call_method(bus, "methodname", "busname",
1401
"objectpath", "interface")
1402
expected_method_return = {True: False,
1404
self.assertEqual(expected_method_return, ret)
1405
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1407
def test_call_method_filters_objectpaths_in_dict(self):
1409
return method_return
1410
mock_dbus_python = self.MockDBusPython_func(func)
1411
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1412
method_return = mock_dbus_python.Dictionary(
1413
{mock_dbus_python.ObjectPath("objectpath_key_1"):
1414
mock_dbus_python.ObjectPath("objectpath_value_1"),
1415
mock_dbus_python.ObjectPath("objectpath_key_2"):
1416
mock_dbus_python.ObjectPath("objectpath_value_2")})
1417
ret = self.call_method(bus, "methodname", "busname",
1418
"objectpath", "interface")
1419
expected_method_return = {str(key): str(value)
1421
method_return.items()}
1422
self.assertEqual(expected_method_return, ret)
1423
self.assertIsInstance(ret, dict)
1424
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1426
def test_call_method_filters_dict_in_dict(self):
1428
return method_return
1429
mock_dbus_python = self.MockDBusPython_func(func)
1430
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1431
method_return = mock_dbus_python.Dictionary(
1432
{"key1": mock_dbus_python.Dictionary({"key11": "value11",
1433
"key12": "value12"}),
1434
"key2": mock_dbus_python.Dictionary({"key21": "value21",
1435
"key22": "value22"})})
1436
ret = self.call_method(bus, "methodname", "busname",
1437
"objectpath", "interface")
1438
expected_method_return = {
1439
"key1": {"key11": "value11",
1440
"key12": "value12"},
1441
"key2": {"key21": "value21",
1442
"key22": "value22"},
1444
self.assertEqual(expected_method_return, ret)
1445
self.assertIsInstance(ret, dict)
1446
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1447
for key, value in ret.items():
1448
self.assertIsInstance(value, dict)
1449
self.assertEqual(expected_method_return[key], value)
1450
self.assertNotIsInstance(value,
1451
mock_dbus_python.Dictionary)
1453
def test_call_method_filters_dict_three_deep(self):
1455
return method_return
1456
mock_dbus_python = self.MockDBusPython_func(func)
1457
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1458
method_return = mock_dbus_python.Dictionary(
1460
mock_dbus_python.Dictionary(
1462
mock_dbus_python.Dictionary(
1464
mock_dbus_python.Boolean(True),
1468
ret = self.call_method(bus, "methodname", "busname",
1469
"objectpath", "interface")
1470
expected_method_return = {"key1": {"key2": {"key3": True}}}
1471
self.assertEqual(expected_method_return, ret)
1472
self.assertIsInstance(ret, dict)
1473
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1474
self.assertIsInstance(ret["key1"], dict)
1475
self.assertNotIsInstance(ret["key1"],
1476
mock_dbus_python.Dictionary)
1477
self.assertIsInstance(ret["key1"]["key2"], dict)
1478
self.assertNotIsInstance(ret["key1"]["key2"],
1479
mock_dbus_python.Dictionary)
1480
self.assertTrue(ret["key1"]["key2"]["key3"])
1481
self.assertNotIsInstance(ret["key1"]["key2"]["key3"],
1482
mock_dbus_python.Boolean)
1484
def test_call_method_handles_exception(self):
1485
dbus_logger = logging.getLogger("dbus.proxies")
1488
dbus_logger.error("Test")
1489
raise mock_dbus_python.exceptions.DBusException()
1491
mock_dbus_python = self.MockDBusPython_func(func)
1492
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1494
class CountingHandler(logging.Handler):
1496
def emit(self, record):
1499
counting_handler = CountingHandler()
1501
dbus_logger.addHandler(counting_handler)
1504
with self.assertRaises(dbus.Error) as e:
1505
self.call_method(bus, "methodname", "busname",
1506
"objectpath", "interface")
1508
dbus_logger.removeFilter(counting_handler)
1510
self.assertNotIsInstance(e, dbus.ConnectFailed)
1512
# Make sure the dbus logger was suppressed
1513
self.assertEqual(0, counting_handler.count)
1515
def test_get_object_converts_to_correct_exception(self):
1516
bus = dbus_python_adapter.SystemBus(
1517
self.fake_dbus_python_raises_exception_on_connect)
1518
with self.assertRaises(dbus.ConnectFailed):
1519
self.call_method(bus, "methodname", "busname",
1520
"objectpath", "interface")
1522
class fake_dbus_python_raises_exception_on_connect(object):
1523
"""fake dbus-python module"""
1524
class exceptions(object):
1525
"""Pseudo-namespace"""
1526
class DBusException(Exception):
1531
def get_object(busname, objectpath):
1532
raise cls.exceptions.DBusException()
1533
Bus = collections.namedtuple("Bus", ["get_object"])
1534
return Bus(get_object=get_object)
1537
class Test_dbus_python_adapter_CachingBus(unittest.TestCase):
1538
class mock_dbus_python(object):
1539
"""mock dbus-python modules"""
1540
class SystemBus(object):
1542
def get_object(busname, objectpath):
1546
self.bus = dbus_python_adapter.CachingBus(
1547
self.mock_dbus_python)
1549
def test_returns_distinct_objectpaths(self):
1550
obj1 = self.bus.get_object("busname", "objectpath1")
1551
self.assertIsInstance(obj1, Unique)
1552
obj2 = self.bus.get_object("busname", "objectpath2")
1553
self.assertIsInstance(obj2, Unique)
1554
self.assertIsNot(obj1, obj2)
1556
def test_returns_distinct_busnames(self):
1557
obj1 = self.bus.get_object("busname1", "objectpath")
1558
self.assertIsInstance(obj1, Unique)
1559
obj2 = self.bus.get_object("busname2", "objectpath")
1560
self.assertIsInstance(obj2, Unique)
1561
self.assertIsNot(obj1, obj2)
1563
def test_returns_distinct_both(self):
1564
obj1 = self.bus.get_object("busname1", "objectpath")
1565
self.assertIsInstance(obj1, Unique)
1566
obj2 = self.bus.get_object("busname2", "objectpath")
1567
self.assertIsInstance(obj2, Unique)
1568
self.assertIsNot(obj1, obj2)
1570
def test_returns_same(self):
1571
obj1 = self.bus.get_object("busname", "objectpath")
1572
self.assertIsInstance(obj1, Unique)
1573
obj2 = self.bus.get_object("busname", "objectpath")
1574
self.assertIsInstance(obj2, Unique)
1575
self.assertIs(obj1, obj2)
1577
def test_returns_same_old(self):
1578
obj1 = self.bus.get_object("busname1", "objectpath1")
1579
self.assertIsInstance(obj1, Unique)
1580
obj2 = self.bus.get_object("busname2", "objectpath2")
1581
self.assertIsInstance(obj2, Unique)
1582
obj1b = self.bus.get_object("busname1", "objectpath1")
1583
self.assertIsInstance(obj1b, Unique)
1584
self.assertIsNot(obj1, obj2)
1585
self.assertIsNot(obj2, obj1b)
1586
self.assertIs(obj1, obj1b)
1589
class Test_pydbus_adapter_SystemBus(TestCaseWithAssertLogs):
1591
def Stub_pydbus_func(self, func):
1592
class stub_pydbus(object):
1593
"""stub pydbus module"""
1594
class SystemBus(object):
1596
def get(busname, objectpath):
1597
DBusObject = collections.namedtuple(
1598
"DBusObject", ("methodname",))
1599
return {"interface":
1600
DBusObject(methodname=func)}
1603
def call_method(self, bus, methodname, busname, objectpath,
1605
with self.assertLogs(log, logging.DEBUG):
1606
return bus.call_method(methodname, busname, objectpath,
1609
def test_call_method_returns(self):
1610
expected_method_return = Unique()
1611
method_args = (Unique(), Unique())
1613
self.assertEqual(len(method_args), len(args))
1614
for marg, arg in zip(method_args, args):
1615
self.assertIs(marg, arg)
1616
return expected_method_return
1617
stub_pydbus = self.Stub_pydbus_func(func)
1618
bus = pydbus_adapter.SystemBus(stub_pydbus)
1619
ret = self.call_method(bus, "methodname", "busname",
1620
"objectpath", "interface",
1622
self.assertIs(ret, expected_method_return)
1624
def test_call_method_handles_exception(self):
1625
dbus_logger = logging.getLogger("dbus.proxies")
1628
raise gi.repository.GLib.Error()
1630
stub_pydbus = self.Stub_pydbus_func(func)
1631
bus = pydbus_adapter.SystemBus(stub_pydbus)
1633
with self.assertRaises(dbus.Error) as e:
1634
self.call_method(bus, "methodname", "busname",
1635
"objectpath", "interface")
1637
self.assertNotIsInstance(e, dbus.ConnectFailed)
1639
def test_get_converts_to_correct_exception(self):
1640
bus = pydbus_adapter.SystemBus(
1641
self.fake_pydbus_raises_exception_on_connect)
1642
with self.assertRaises(dbus.ConnectFailed):
1643
self.call_method(bus, "methodname", "busname",
1644
"objectpath", "interface")
1646
class fake_pydbus_raises_exception_on_connect(object):
1647
"""fake dbus-python module"""
1650
def get(busname, objectpath):
1651
raise gi.repository.GLib.Error()
1652
Bus = collections.namedtuple("Bus", ["get"])
1655
def test_set_property_uses_setattr(self):
1656
class Object(object):
1659
class pydbus_spy(object):
1660
class SystemBus(object):
1662
def get(busname, objectpath):
1663
return {"interface": obj}
1664
bus = pydbus_adapter.SystemBus(pydbus_spy)
1666
bus.set_property("busname", "objectpath", "interface", "key",
1668
self.assertIs(value, obj.key)
1670
def test_get_suppresses_xml_deprecation_warning(self):
1671
if sys.version_info.major >= 3:
1673
class stub_pydbus_get(object):
1674
class SystemBus(object):
1676
def get(busname, objectpath):
1677
warnings.warn_explicit(
1678
"deprecated", DeprecationWarning,
1679
"xml.etree.ElementTree", 0)
1680
bus = pydbus_adapter.SystemBus(stub_pydbus_get)
1681
with warnings.catch_warnings(record=True) as w:
1682
warnings.simplefilter("always")
1683
bus.get("busname", "objectpath")
1684
self.assertEqual(0, len(w))
1687
class Test_pydbus_adapter_CachingBus(unittest.TestCase):
1688
class stub_pydbus(object):
1689
"""stub pydbus module"""
1690
class SystemBus(object):
1692
def get(busname, objectpath):
1696
self.bus = pydbus_adapter.CachingBus(self.stub_pydbus)
1698
def test_returns_distinct_objectpaths(self):
1699
obj1 = self.bus.get("busname", "objectpath1")
1700
self.assertIsInstance(obj1, Unique)
1701
obj2 = self.bus.get("busname", "objectpath2")
1702
self.assertIsInstance(obj2, Unique)
1703
self.assertIsNot(obj1, obj2)
1705
def test_returns_distinct_busnames(self):
1706
obj1 = self.bus.get("busname1", "objectpath")
1707
self.assertIsInstance(obj1, Unique)
1708
obj2 = self.bus.get("busname2", "objectpath")
1709
self.assertIsInstance(obj2, Unique)
1710
self.assertIsNot(obj1, obj2)
1712
def test_returns_distinct_both(self):
1713
obj1 = self.bus.get("busname1", "objectpath")
1714
self.assertIsInstance(obj1, Unique)
1715
obj2 = self.bus.get("busname2", "objectpath")
1716
self.assertIsInstance(obj2, Unique)
1717
self.assertIsNot(obj1, obj2)
1719
def test_returns_same(self):
1720
obj1 = self.bus.get("busname", "objectpath")
1721
self.assertIsInstance(obj1, Unique)
1722
obj2 = self.bus.get("busname", "objectpath")
1723
self.assertIsInstance(obj2, Unique)
1724
self.assertIs(obj1, obj2)
1726
def test_returns_same_old(self):
1727
obj1 = self.bus.get("busname1", "objectpath1")
1728
self.assertIsInstance(obj1, Unique)
1729
obj2 = self.bus.get("busname2", "objectpath2")
1730
self.assertIsInstance(obj2, Unique)
1731
obj1b = self.bus.get("busname1", "objectpath1")
1732
self.assertIsInstance(obj1b, Unique)
1733
self.assertIsNot(obj1, obj2)
1734
self.assertIsNot(obj2, obj1b)
1735
self.assertIs(obj1, obj1b)
1738
class Test_commands_from_options(unittest.TestCase):
1741
self.parser = argparse.ArgumentParser()
1742
add_command_line_options(self.parser)
1744
def test_is_enabled(self):
1745
self.assert_command_from_args(["--is-enabled", "client"],
1748
def assert_command_from_args(self, args, command_cls,
1750
"""Assert that parsing ARGS should result in an instance of
1751
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
1752
options = self.parser.parse_args(args)
1753
check_option_syntax(self.parser, options)
1754
commands = commands_from_options(options)
1755
self.assertEqual(1, len(commands))
1756
command = commands[0]
1757
self.assertIsInstance(command, command_cls)
1758
for key, value in cmd_attrs.items():
1759
self.assertEqual(value, getattr(command, key))
1761
def test_is_enabled_short(self):
1762
self.assert_command_from_args(["-V", "client"],
1765
def test_approve(self):
1766
self.assert_command_from_args(["--approve", "client"],
1769
def test_approve_short(self):
1770
self.assert_command_from_args(["-A", "client"],
1773
def test_deny(self):
1774
self.assert_command_from_args(["--deny", "client"],
1777
def test_deny_short(self):
1778
self.assert_command_from_args(["-D", "client"], command.Deny)
1780
def test_remove(self):
1781
self.assert_command_from_args(["--remove", "client"],
1784
def test_deny_before_remove(self):
1785
options = self.parser.parse_args(["--deny", "--remove",
1787
check_option_syntax(self.parser, options)
1788
commands = commands_from_options(options)
1789
self.assertEqual(2, len(commands))
1790
self.assertIsInstance(commands[0], command.Deny)
1791
self.assertIsInstance(commands[1], command.Remove)
1793
def test_deny_before_remove_reversed(self):
1794
options = self.parser.parse_args(["--remove", "--deny",
1796
check_option_syntax(self.parser, options)
1797
commands = commands_from_options(options)
1798
self.assertEqual(2, len(commands))
1799
self.assertIsInstance(commands[0], command.Deny)
1800
self.assertIsInstance(commands[1], command.Remove)
1802
def test_remove_short(self):
1803
self.assert_command_from_args(["-r", "client"],
1806
def test_dump_json(self):
1807
self.assert_command_from_args(["--dump-json"],
1810
def test_enable(self):
1811
self.assert_command_from_args(["--enable", "client"],
1814
def test_enable_short(self):
1815
self.assert_command_from_args(["-e", "client"],
1818
def test_disable(self):
1819
self.assert_command_from_args(["--disable", "client"],
1822
def test_disable_short(self):
1823
self.assert_command_from_args(["-d", "client"],
1826
def test_bump_timeout(self):
1827
self.assert_command_from_args(["--bump-timeout", "client"],
1828
command.BumpTimeout)
1830
def test_bump_timeout_short(self):
1831
self.assert_command_from_args(["-b", "client"],
1832
command.BumpTimeout)
1834
def test_start_checker(self):
1835
self.assert_command_from_args(["--start-checker", "client"],
1836
command.StartChecker)
1838
def test_stop_checker(self):
1839
self.assert_command_from_args(["--stop-checker", "client"],
1840
command.StopChecker)
1842
def test_approve_by_default(self):
1843
self.assert_command_from_args(["--approve-by-default",
1845
command.ApproveByDefault)
1847
def test_deny_by_default(self):
1848
self.assert_command_from_args(["--deny-by-default", "client"],
1849
command.DenyByDefault)
1851
def test_checker(self):
1852
self.assert_command_from_args(["--checker", ":", "client"],
1856
def test_checker_empty(self):
1857
self.assert_command_from_args(["--checker", "", "client"],
1861
def test_checker_short(self):
1862
self.assert_command_from_args(["-c", ":", "client"],
1866
def test_host(self):
1867
self.assert_command_from_args(
1868
["--host", "client.example.org", "client"],
1869
command.SetHost, value_to_set="client.example.org")
1871
def test_host_short(self):
1872
self.assert_command_from_args(
1873
["-H", "client.example.org", "client"], command.SetHost,
1874
value_to_set="client.example.org")
1876
def test_secret_devnull(self):
1877
self.assert_command_from_args(["--secret", os.path.devnull,
1878
"client"], command.SetSecret,
1881
def test_secret_tempfile(self):
1882
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1883
value = b"secret\0xyzzy\nbar"
1886
self.assert_command_from_args(["--secret", f.name,
1891
def test_secret_devnull_short(self):
1892
self.assert_command_from_args(["-s", os.path.devnull,
1893
"client"], command.SetSecret,
1896
def test_secret_tempfile_short(self):
1897
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1898
value = b"secret\0xyzzy\nbar"
1901
self.assert_command_from_args(["-s", f.name, "client"],
1905
def test_timeout(self):
1906
self.assert_command_from_args(["--timeout", "PT5M", "client"],
1908
value_to_set=300000)
1910
def test_timeout_short(self):
1911
self.assert_command_from_args(["-t", "PT5M", "client"],
1913
value_to_set=300000)
1915
def test_extended_timeout(self):
1916
self.assert_command_from_args(["--extended-timeout", "PT15M",
1918
command.SetExtendedTimeout,
1919
value_to_set=900000)
1921
def test_interval(self):
1922
self.assert_command_from_args(["--interval", "PT2M",
1923
"client"], command.SetInterval,
1924
value_to_set=120000)
1926
def test_interval_short(self):
1927
self.assert_command_from_args(["-i", "PT2M", "client"],
1928
command.SetInterval,
1929
value_to_set=120000)
1931
def test_approval_delay(self):
1932
self.assert_command_from_args(["--approval-delay", "PT30S",
1934
command.SetApprovalDelay,
1937
def test_approval_duration(self):
1938
self.assert_command_from_args(["--approval-duration", "PT1S",
1940
command.SetApprovalDuration,
1943
def test_print_table(self):
1944
self.assert_command_from_args([], command.PrintTable,
1947
def test_print_table_verbose(self):
1948
self.assert_command_from_args(["--verbose"],
1952
def test_print_table_verbose_short(self):
1953
self.assert_command_from_args(["-v"], command.PrintTable,
1957
class TestCommand(unittest.TestCase):
799
1958
"""Abstract class for tests of command classes"""
802
class MockClient(object):
803
def __init__(self, name, **attributes):
804
self.__dbus_object_path__ = "objpath_{}".format(name)
805
self.attributes = attributes
806
self.attributes["Name"] = name
808
def Set(self, interface, property, value, dbus_interface):
809
testcase.assertEqual(interface, client_interface)
810
testcase.assertEqual(dbus_interface,
811
dbus.PROPERTIES_IFACE)
812
self.attributes[property] = value
813
def Get(self, interface, property, dbus_interface):
814
testcase.assertEqual(interface, client_interface)
815
testcase.assertEqual(dbus_interface,
816
dbus.PROPERTIES_IFACE)
817
return self.attributes[property]
818
def Approve(self, approve, dbus_interface):
819
testcase.assertEqual(dbus_interface, client_interface)
820
self.calls.append(("Approve", (approve,
822
self.client = MockClient(
824
KeyID=("92ed150794387c03ce684574b1139a65"
825
"94a34f895daaaf09fd8ea90a27cddb12"),
827
Host="foo.example.org",
828
Enabled=dbus.Boolean(True),
830
LastCheckedOK="2019-02-03T00:00:00",
831
Created="2019-01-02T00:00:00",
833
Fingerprint=("778827225BA7DE539C5A"
834
"7CFA59CFF7CDBD9A5920"),
835
CheckerRunning=dbus.Boolean(False),
836
LastEnabled="2019-01-03T00:00:00",
837
ApprovalPending=dbus.Boolean(False),
838
ApprovedByDefault=dbus.Boolean(True),
839
LastApprovalRequest="",
841
ApprovalDuration=1000,
842
Checker="fping -q -- %(host)s",
843
ExtendedTimeout=900000,
844
Expires="2019-02-04T00:00:00",
846
self.other_client = MockClient(
848
KeyID=("0558568eedd67d622f5c83b35a115f79"
849
"6ab612cff5ad227247e46c2b020f441c"),
852
Enabled=dbus.Boolean(True),
854
LastCheckedOK="2019-02-04T00:00:00",
855
Created="2019-01-03T00:00:00",
857
Fingerprint=("3E393AEAEFB84C7E89E2"
858
"F547B3A107558FCA3A27"),
859
CheckerRunning=dbus.Boolean(True),
860
LastEnabled="2019-01-04T00:00:00",
861
ApprovalPending=dbus.Boolean(False),
862
ApprovedByDefault=dbus.Boolean(False),
863
LastApprovalRequest="2019-01-03T00:00:00",
865
ApprovalDuration=1000,
867
ExtendedTimeout=900000,
868
Expires="2019-02-05T00:00:00",
869
LastCheckerStatus=-2)
870
self.clients = collections.OrderedDict(
872
(self.client, self.client.attributes),
873
(self.other_client, self.other_client.attributes),
875
self.one_client = {self.client: self.client.attributes}
877
class TestPrintTableCmd(TestCmd):
878
def test_normal(self):
879
output = PrintTableCmd().output(self.clients)
880
expected_output = """
881
Name Enabled Timeout Last Successful Check
882
foo Yes 00:05:00 2019-02-03T00:00:00
883
barbar Yes 00:05:00 2019-02-04T00:00:00
885
self.assertEqual(output, expected_output)
886
def test_verbose(self):
887
output = PrintTableCmd(verbose=True).output(self.clients)
888
expected_output = """
889
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
890
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
891
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
893
self.assertEqual(output, expected_output)
894
def test_one_client(self):
895
output = PrintTableCmd().output(self.one_client)
896
expected_output = """
897
Name Enabled Timeout Last Successful Check
898
foo Yes 00:05:00 2019-02-03T00:00:00
900
self.assertEqual(output, expected_output)
902
class TestDumpJSONCmd(TestCmd):
904
self.expected_json = {
1960
class FakeMandosBus(dbus.MandosBus):
1961
def __init__(self, testcase):
1962
self.client_properties = {
907
1964
"KeyID": ("92ed150794387c03ce684574b1139a65"
908
1965
"94a34f895daaaf09fd8ea90a27cddb12"),
1966
"Secret": b"secret",
909
1967
"Host": "foo.example.org",
910
1968
"Enabled": True,
911
1969
"Timeout": 300000,
944
2003
"ApprovedByDefault": False,
945
2004
"LastApprovalRequest": "2019-01-03T00:00:00",
946
2005
"ApprovalDelay": 30000,
947
"ApprovalDuration": 1000,
2006
"ApprovalDuration": 93785000,
949
2008
"ExtendedTimeout": 900000,
950
2009
"Expires": "2019-02-05T00:00:00",
951
2010
"LastCheckerStatus": -2,
954
return super(TestDumpJSONCmd, self).setUp()
955
def test_normal(self):
956
json_data = json.loads(DumpJSONCmd().output(self.clients))
957
self.assertDictEqual(json_data, self.expected_json)
958
def test_one_client(self):
959
clients = self.one_client
960
json_data = json.loads(DumpJSONCmd().output(clients))
961
expected_json = {"foo": self.expected_json["foo"]}
962
self.assertDictEqual(json_data, expected_json)
964
class TestIsEnabledCmd(TestCmd):
965
def test_is_enabled(self):
966
self.assertTrue(all(IsEnabledCmd().is_enabled(client, properties)
967
for client, properties in self.clients.items()))
968
def test_is_enabled_run_exits_successfully(self):
2012
self.clients = collections.OrderedDict(
2014
("client_objectpath", self.client_properties),
2015
("other_client_objectpath",
2016
self.other_client_properties),
2018
self.one_client = {"client_objectpath":
2019
self.client_properties}
2020
self.testcase = testcase
2023
def call_method(self, methodname, busname, objectpath,
2025
self.testcase.assertEqual("se.recompile.Mandos", busname)
2026
self.calls.append((methodname, busname, objectpath,
2028
if interface == "org.freedesktop.DBus.Properties":
2029
if methodname == "Set":
2030
self.testcase.assertEqual(3, len(args))
2031
interface, key, value = args
2032
self.testcase.assertEqual(
2033
"se.recompile.Mandos.Client", interface)
2034
self.clients[objectpath][key] = value
2036
elif interface == "se.recompile.Mandos":
2037
self.testcase.assertEqual("RemoveClient", methodname)
2038
self.testcase.assertEqual(1, len(args))
2039
clientpath = args[0]
2040
del self.clients[clientpath]
2042
elif interface == "se.recompile.Mandos.Client":
2043
if methodname == "Approve":
2044
self.testcase.assertEqual(1, len(args))
2049
self.bus = self.FakeMandosBus(self)
2052
class TestBaseCommands(TestCommand):
2054
def test_IsEnabled_exits_successfully(self):
969
2055
with self.assertRaises(SystemExit) as e:
970
IsEnabledCmd().run(None, self.one_client)
2056
command.IsEnabled().run(self.bus.one_client)
971
2057
if e.exception.code is not None:
972
self.assertEqual(e.exception.code, 0)
2058
self.assertEqual(0, e.exception.code)
974
2060
self.assertIsNone(e.exception.code)
975
def test_is_enabled_run_exits_with_failure(self):
976
self.client.attributes["Enabled"] = dbus.Boolean(False)
2062
def test_IsEnabled_exits_with_failure(self):
2063
self.bus.client_properties["Enabled"] = False
977
2064
with self.assertRaises(SystemExit) as e:
978
IsEnabledCmd().run(None, self.one_client)
2065
command.IsEnabled().run(self.bus.one_client)
979
2066
if isinstance(e.exception.code, int):
980
self.assertNotEqual(e.exception.code, 0)
2067
self.assertNotEqual(0, e.exception.code)
982
2069
self.assertIsNotNone(e.exception.code)
984
class TestRemoveCmd(TestCmd):
985
def test_remove(self):
986
class MockMandos(object):
989
def RemoveClient(self, dbus_path):
990
self.calls.append(("RemoveClient", (dbus_path,)))
991
mandos = MockMandos()
992
super(TestRemoveCmd, self).setUp()
993
RemoveCmd().run(mandos, self.clients)
994
self.assertEqual(len(mandos.calls), 2)
995
for client in self.clients:
996
self.assertIn(("RemoveClient",
997
(client.__dbus_object_path__,)),
1000
class TestApproveCmd(TestCmd):
1001
def test_approve(self):
1002
ApproveCmd().run(None, self.clients)
1003
for client in self.clients:
1004
self.assertIn(("Approve", (True, client_interface)),
1007
class TestDenyCmd(TestCmd):
1008
def test_deny(self):
1009
DenyCmd().run(None, self.clients)
1010
for client in self.clients:
1011
self.assertIn(("Approve", (False, client_interface)),
1014
class TestEnableCmd(TestCmd):
1015
def test_enable(self):
1016
for client in self.clients:
1017
client.attributes["Enabled"] = False
1019
EnableCmd().run(None, self.clients)
1021
for client in self.clients:
1022
self.assertTrue(client.attributes["Enabled"])
1024
class TestDisableCmd(TestCmd):
1025
def test_disable(self):
1026
DisableCmd().run(None, self.clients)
1028
for client in self.clients:
1029
self.assertFalse(client.attributes["Enabled"])
1031
class Unique(object):
1032
"""Class for objects which exist only to be unique objects, since
1033
unittest.mock.sentinel only exists in Python 3.3"""
1035
class TestPropertyCmd(TestCmd):
1036
"""Abstract class for tests of PropertyCmd classes"""
2071
def test_Approve(self):
2072
busname = "se.recompile.Mandos"
2073
client_interface = "se.recompile.Mandos.Client"
2074
command.Approve().run(self.bus.clients, self.bus)
2075
for clientpath in self.bus.clients:
2076
self.assertIn(("Approve", busname, clientpath,
2077
client_interface, (True,)), self.bus.calls)
2079
def test_Deny(self):
2080
busname = "se.recompile.Mandos"
2081
client_interface = "se.recompile.Mandos.Client"
2082
command.Deny().run(self.bus.clients, self.bus)
2083
for clientpath in self.bus.clients:
2084
self.assertIn(("Approve", busname, clientpath,
2085
client_interface, (False,)),
2088
def test_Remove(self):
2089
command.Remove().run(self.bus.clients, self.bus)
2090
for clientpath in self.bus.clients:
2091
self.assertIn(("RemoveClient", dbus_busname,
2092
dbus_server_path, dbus_server_interface,
2093
(clientpath,)), self.bus.calls)
2098
"KeyID": ("92ed150794387c03ce684574b1139a65"
2099
"94a34f895daaaf09fd8ea90a27cddb12"),
2100
"Host": "foo.example.org",
2103
"LastCheckedOK": "2019-02-03T00:00:00",
2104
"Created": "2019-01-02T00:00:00",
2106
"Fingerprint": ("778827225BA7DE539C5A"
2107
"7CFA59CFF7CDBD9A5920"),
2108
"CheckerRunning": False,
2109
"LastEnabled": "2019-01-03T00:00:00",
2110
"ApprovalPending": False,
2111
"ApprovedByDefault": True,
2112
"LastApprovalRequest": "",
2114
"ApprovalDuration": 1000,
2115
"Checker": "fping -q -- %(host)s",
2116
"ExtendedTimeout": 900000,
2117
"Expires": "2019-02-04T00:00:00",
2118
"LastCheckerStatus": 0,
2122
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
2123
"6ab612cff5ad227247e46c2b020f441c"),
2124
"Host": "192.0.2.3",
2127
"LastCheckedOK": "2019-02-04T00:00:00",
2128
"Created": "2019-01-03T00:00:00",
2130
"Fingerprint": ("3E393AEAEFB84C7E89E2"
2131
"F547B3A107558FCA3A27"),
2132
"CheckerRunning": True,
2133
"LastEnabled": "2019-01-04T00:00:00",
2134
"ApprovalPending": False,
2135
"ApprovedByDefault": False,
2136
"LastApprovalRequest": "2019-01-03T00:00:00",
2137
"ApprovalDelay": 30000,
2138
"ApprovalDuration": 93785000,
2140
"ExtendedTimeout": 900000,
2141
"Expires": "2019-02-05T00:00:00",
2142
"LastCheckerStatus": -2,
2146
def test_DumpJSON_normal(self):
2147
with self.capture_stdout_to_buffer() as buffer:
2148
command.DumpJSON().run(self.bus.clients)
2149
json_data = json.loads(buffer.getvalue())
2150
self.assertDictEqual(self.expected_json, json_data)
2153
@contextlib.contextmanager
2154
def capture_stdout_to_buffer():
2155
capture_buffer = io.StringIO()
2156
old_stdout = sys.stdout
2157
sys.stdout = capture_buffer
2159
yield capture_buffer
2161
sys.stdout = old_stdout
2163
def test_DumpJSON_one_client(self):
2164
with self.capture_stdout_to_buffer() as buffer:
2165
command.DumpJSON().run(self.bus.one_client)
2166
json_data = json.loads(buffer.getvalue())
2167
expected_json = {"foo": self.expected_json["foo"]}
2168
self.assertDictEqual(expected_json, json_data)
2170
def test_PrintTable_normal(self):
2171
with self.capture_stdout_to_buffer() as buffer:
2172
command.PrintTable().run(self.bus.clients)
2173
expected_output = "\n".join((
2174
"Name Enabled Timeout Last Successful Check",
2175
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
2176
"barbar Yes 00:05:00 2019-02-04T00:00:00 ",
2178
self.assertEqual(expected_output, buffer.getvalue())
2180
def test_PrintTable_verbose(self):
2181
with self.capture_stdout_to_buffer() as buffer:
2182
command.PrintTable(verbose=True).run(self.bus.clients)
2197
"Last Successful Check ",
2198
"2019-02-03T00:00:00 ",
2199
"2019-02-04T00:00:00 ",
2202
"2019-01-02T00:00:00 ",
2203
"2019-01-03T00:00:00 ",
2215
("92ed150794387c03ce684574b1139a6594a34f895daaaf09fd8"
2217
("0558568eedd67d622f5c83b35a115f796ab612cff5ad227247e"
2221
"778827225BA7DE539C5A7CFA59CFF7CDBD9A5920 ",
2222
"3E393AEAEFB84C7E89E2F547B3A107558FCA3A27 ",
2224
"Check Is Running ",
2229
"2019-01-03T00:00:00 ",
2230
"2019-01-04T00:00:00 ",
2232
"Approval Is Pending ",
2236
"Approved By Default ",
2240
"Last Approval Request ",
2242
"2019-01-03T00:00:00 ",
2248
"Approval Duration ",
2253
"fping -q -- %(host)s ",
2256
"Extended Timeout ",
2261
"2019-02-04T00:00:00 ",
2262
"2019-02-05T00:00:00 ",
2264
"Last Checker Status",
2269
num_lines = max(len(rows) for rows in columns)
2270
expected_output = ("\n".join("".join(rows[line]
2271
for rows in columns)
2272
for line in range(num_lines))
2274
self.assertEqual(expected_output, buffer.getvalue())
2276
def test_PrintTable_one_client(self):
2277
with self.capture_stdout_to_buffer() as buffer:
2278
command.PrintTable().run(self.bus.one_client)
2279
expected_output = "\n".join((
2280
"Name Enabled Timeout Last Successful Check",
2281
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
2283
self.assertEqual(expected_output, buffer.getvalue())
2286
class TestPropertySetterCmd(TestCommand):
2287
"""Abstract class for tests of command.PropertySetter classes"""
1037
2289
def runTest(self):
1038
2290
if not hasattr(self, "command"):
1040
values_to_get = getattr(self, "values_to_get",
1042
for value_to_set, value_to_get in zip(self.values_to_set,
1044
for client in self.clients:
1045
old_value = client.attributes[self.property]
1046
self.assertNotIsInstance(old_value, Unique)
1047
client.attributes[self.property] = Unique()
1048
self.run_command(value_to_set, self.clients)
1049
for client in self.clients:
1050
value = client.attributes[self.property]
2291
return # Abstract TestCase class
2293
if hasattr(self, "values_to_set"):
2294
cmd_args = [(value,) for value in self.values_to_set]
2295
values_to_get = getattr(self, "values_to_get",
2298
cmd_args = [() for x in range(len(self.values_to_get))]
2299
values_to_get = self.values_to_get
2300
for value_to_get, cmd_arg in zip(values_to_get, cmd_args):
2301
for clientpath in self.bus.clients:
2302
self.bus.clients[clientpath][self.propname] = (
2304
self.command(*cmd_arg).run(self.bus.clients, self.bus)
2305
for clientpath in self.bus.clients:
2306
value = (self.bus.clients[clientpath]
1051
2308
self.assertNotIsInstance(value, Unique)
1052
self.assertEqual(value, value_to_get)
1053
def run_command(self, value, clients):
1054
self.command().run(None, clients)
1056
class TestBumpTimeoutCmd(TestPropertyCmd):
1057
command = BumpTimeoutCmd
1058
property = "LastCheckedOK"
1059
values_to_set = [""]
1061
class TestStartCheckerCmd(TestPropertyCmd):
1062
command = StartCheckerCmd
1063
property = "CheckerRunning"
1064
values_to_set = [dbus.Boolean(True)]
1066
class TestStopCheckerCmd(TestPropertyCmd):
1067
command = StopCheckerCmd
1068
property = "CheckerRunning"
1069
values_to_set = [dbus.Boolean(False)]
1071
class TestApproveByDefaultCmd(TestPropertyCmd):
1072
command = ApproveByDefaultCmd
1073
property = "ApprovedByDefault"
1074
values_to_set = [dbus.Boolean(True)]
1076
class TestDenyByDefaultCmd(TestPropertyCmd):
1077
command = DenyByDefaultCmd
1078
property = "ApprovedByDefault"
1079
values_to_set = [dbus.Boolean(False)]
1081
class TestValueArgumentPropertyCmd(TestPropertyCmd):
1082
"""Abstract class for tests of PropertyCmd classes using the
1083
ValueArgumentMixIn"""
1085
if type(self) is TestValueArgumentPropertyCmd:
1087
return super(TestValueArgumentPropertyCmd, self).runTest()
1088
def run_command(self, value, clients):
1089
self.command(value).run(None, clients)
1091
class TestSetCheckerCmd(TestValueArgumentPropertyCmd):
1092
command = SetCheckerCmd
1093
property = "Checker"
2309
self.assertEqual(value_to_get, value)
2312
class TestEnableCmd(TestPropertySetterCmd):
2313
command = command.Enable
2314
propname = "Enabled"
2315
values_to_get = [True]
2318
class TestDisableCmd(TestPropertySetterCmd):
2319
command = command.Disable
2320
propname = "Enabled"
2321
values_to_get = [False]
2324
class TestBumpTimeoutCmd(TestPropertySetterCmd):
2325
command = command.BumpTimeout
2326
propname = "LastCheckedOK"
2327
values_to_get = [""]
2330
class TestStartCheckerCmd(TestPropertySetterCmd):
2331
command = command.StartChecker
2332
propname = "CheckerRunning"
2333
values_to_get = [True]
2336
class TestStopCheckerCmd(TestPropertySetterCmd):
2337
command = command.StopChecker
2338
propname = "CheckerRunning"
2339
values_to_get = [False]
2342
class TestApproveByDefaultCmd(TestPropertySetterCmd):
2343
command = command.ApproveByDefault
2344
propname = "ApprovedByDefault"
2345
values_to_get = [True]
2348
class TestDenyByDefaultCmd(TestPropertySetterCmd):
2349
command = command.DenyByDefault
2350
propname = "ApprovedByDefault"
2351
values_to_get = [False]
2354
class TestSetCheckerCmd(TestPropertySetterCmd):
2355
command = command.SetChecker
2356
propname = "Checker"
1094
2357
values_to_set = ["", ":", "fping -q -- %s"]
1096
class TestSetHostCmd(TestValueArgumentPropertyCmd):
1097
command = SetHostCmd
1099
values_to_set = ["192.0.2.3", "foo.example.org"]
1101
class TestSetSecretCmd(TestValueArgumentPropertyCmd):
1102
command = SetSecretCmd
2360
class TestSetHostCmd(TestPropertySetterCmd):
2361
command = command.SetHost
2363
values_to_set = ["192.0.2.3", "client.example.org"]
2366
class TestSetSecretCmd(TestPropertySetterCmd):
2367
command = command.SetSecret
1104
2369
values_to_set = [io.BytesIO(b""),
1105
2370
io.BytesIO(b"secret\0xyzzy\nbar")]
1106
values_to_get = [b"", b"secret\0xyzzy\nbar"]
1108
class TestSetTimeoutCmd(TestValueArgumentPropertyCmd):
1109
command = SetTimeoutCmd
1110
property = "Timeout"
1111
values_to_set = [datetime.timedelta(),
1112
datetime.timedelta(minutes=5),
1113
datetime.timedelta(seconds=1),
1114
datetime.timedelta(weeks=1),
1115
datetime.timedelta(weeks=52)]
1116
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1118
class TestSetExtendedTimeoutCmd(TestValueArgumentPropertyCmd):
1119
command = SetExtendedTimeoutCmd
1120
property = "ExtendedTimeout"
1121
values_to_set = [datetime.timedelta(),
1122
datetime.timedelta(minutes=5),
1123
datetime.timedelta(seconds=1),
1124
datetime.timedelta(weeks=1),
1125
datetime.timedelta(weeks=52)]
1126
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1128
class TestSetIntervalCmd(TestValueArgumentPropertyCmd):
1129
command = SetIntervalCmd
1130
property = "Interval"
1131
values_to_set = [datetime.timedelta(),
1132
datetime.timedelta(minutes=5),
1133
datetime.timedelta(seconds=1),
1134
datetime.timedelta(weeks=1),
1135
datetime.timedelta(weeks=52)]
1136
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1138
class TestSetApprovalDelayCmd(TestValueArgumentPropertyCmd):
1139
command = SetApprovalDelayCmd
1140
property = "ApprovalDelay"
1141
values_to_set = [datetime.timedelta(),
1142
datetime.timedelta(minutes=5),
1143
datetime.timedelta(seconds=1),
1144
datetime.timedelta(weeks=1),
1145
datetime.timedelta(weeks=52)]
1146
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1148
class TestSetApprovalDurationCmd(TestValueArgumentPropertyCmd):
1149
command = SetApprovalDurationCmd
1150
property = "ApprovalDuration"
1151
values_to_set = [datetime.timedelta(),
1152
datetime.timedelta(minutes=5),
1153
datetime.timedelta(seconds=1),
1154
datetime.timedelta(weeks=1),
1155
datetime.timedelta(weeks=52)]
1156
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1158
class Test_command_from_options(unittest.TestCase):
1160
self.parser = argparse.ArgumentParser()
1161
add_command_line_options(self.parser)
1162
def assert_command_from_args(self, args, command_cls, **cmd_attrs):
1163
"""Assert that parsing ARGS should result in an instance of
1164
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
1165
options = self.parser.parse_args(args)
1166
check_option_syntax(self.parser, options)
1167
commands = commands_from_options(options)
1168
self.assertEqual(len(commands), 1)
1169
command = commands[0]
1170
self.assertIsInstance(command, command_cls)
1171
for key, value in cmd_attrs.items():
1172
self.assertEqual(getattr(command, key), value)
1173
def test_print_table(self):
1174
self.assert_command_from_args([], PrintTableCmd,
1177
def test_print_table_verbose(self):
1178
self.assert_command_from_args(["--verbose"], PrintTableCmd,
1181
def test_print_table_verbose_short(self):
1182
self.assert_command_from_args(["-v"], PrintTableCmd,
1185
def test_enable(self):
1186
self.assert_command_from_args(["--enable", "foo"], EnableCmd)
1188
def test_enable_short(self):
1189
self.assert_command_from_args(["-e", "foo"], EnableCmd)
1191
def test_disable(self):
1192
self.assert_command_from_args(["--disable", "foo"],
1195
def test_disable_short(self):
1196
self.assert_command_from_args(["-d", "foo"], DisableCmd)
1198
def test_bump_timeout(self):
1199
self.assert_command_from_args(["--bump-timeout", "foo"],
1202
def test_bump_timeout_short(self):
1203
self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
1205
def test_start_checker(self):
1206
self.assert_command_from_args(["--start-checker", "foo"],
1209
def test_stop_checker(self):
1210
self.assert_command_from_args(["--stop-checker", "foo"],
1213
def test_remove(self):
1214
self.assert_command_from_args(["--remove", "foo"],
1217
def test_remove_short(self):
1218
self.assert_command_from_args(["-r", "foo"], RemoveCmd)
1220
def test_checker(self):
1221
self.assert_command_from_args(["--checker", ":", "foo"],
1222
SetCheckerCmd, value_to_set=":")
1224
def test_checker_empty(self):
1225
self.assert_command_from_args(["--checker", "", "foo"],
1226
SetCheckerCmd, value_to_set="")
1228
def test_checker_short(self):
1229
self.assert_command_from_args(["-c", ":", "foo"],
1230
SetCheckerCmd, value_to_set=":")
1232
def test_timeout(self):
1233
self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1235
value_to_set=300000)
1237
def test_timeout_short(self):
1238
self.assert_command_from_args(["-t", "PT5M", "foo"],
1240
value_to_set=300000)
1242
def test_extended_timeout(self):
1243
self.assert_command_from_args(["--extended-timeout", "PT15M",
1245
SetExtendedTimeoutCmd,
1246
value_to_set=900000)
1248
def test_interval(self):
1249
self.assert_command_from_args(["--interval", "PT2M", "foo"],
1251
value_to_set=120000)
1253
def test_interval_short(self):
1254
self.assert_command_from_args(["-i", "PT2M", "foo"],
1256
value_to_set=120000)
1258
def test_approve_by_default(self):
1259
self.assert_command_from_args(["--approve-by-default", "foo"],
1260
ApproveByDefaultCmd)
1262
def test_deny_by_default(self):
1263
self.assert_command_from_args(["--deny-by-default", "foo"],
1266
def test_approval_delay(self):
1267
self.assert_command_from_args(["--approval-delay", "PT30S",
1268
"foo"], SetApprovalDelayCmd,
1271
def test_approval_duration(self):
1272
self.assert_command_from_args(["--approval-duration", "PT1S",
1273
"foo"], SetApprovalDurationCmd,
1276
def test_host(self):
1277
self.assert_command_from_args(["--host", "foo.example.org",
1279
value_to_set="foo.example.org")
1281
def test_host_short(self):
1282
self.assert_command_from_args(["-H", "foo.example.org",
1284
value_to_set="foo.example.org")
1286
def test_secret_devnull(self):
1287
self.assert_command_from_args(["--secret", os.path.devnull,
1288
"foo"], SetSecretCmd,
1291
def test_secret_tempfile(self):
1292
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1293
value = b"secret\0xyzzy\nbar"
1296
self.assert_command_from_args(["--secret", f.name,
1297
"foo"], SetSecretCmd,
1300
def test_secret_devnull_short(self):
1301
self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1302
SetSecretCmd, value_to_set=b"")
1304
def test_secret_tempfile_short(self):
1305
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1306
value = b"secret\0xyzzy\nbar"
1309
self.assert_command_from_args(["-s", f.name, "foo"],
1313
def test_approve(self):
1314
self.assert_command_from_args(["--approve", "foo"],
1317
def test_approve_short(self):
1318
self.assert_command_from_args(["-A", "foo"], ApproveCmd)
1320
def test_deny(self):
1321
self.assert_command_from_args(["--deny", "foo"], DenyCmd)
1323
def test_deny_short(self):
1324
self.assert_command_from_args(["-D", "foo"], DenyCmd)
1326
def test_dump_json(self):
1327
self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
1329
def test_is_enabled(self):
1330
self.assert_command_from_args(["--is-enabled", "foo"],
1333
def test_is_enabled_short(self):
1334
self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
1337
class Test_check_option_syntax(unittest.TestCase):
1338
# This mostly corresponds to the definition from has_actions() in
1339
# check_option_syntax()
1341
# The actual values set here are not that important, but we do
1342
# at least stick to the correct types, even though they are
1346
"bump_timeout": True,
1347
"start_checker": True,
1348
"stop_checker": True,
1352
"timeout": datetime.timedelta(),
1353
"extended_timeout": datetime.timedelta(),
1354
"interval": datetime.timedelta(),
1355
"approved_by_default": True,
1356
"approval_delay": datetime.timedelta(),
1357
"approval_duration": datetime.timedelta(),
1359
"secret": io.BytesIO(b"x"),
1365
self.parser = argparse.ArgumentParser()
1366
add_command_line_options(self.parser)
1368
@contextlib.contextmanager
1369
def assertParseError(self):
1370
with self.assertRaises(SystemExit) as e:
1371
with self.temporarily_suppress_stderr():
1373
# Exit code from argparse is guaranteed to be "2". Reference:
1374
# https://docs.python.org/3/library/argparse.html#exiting-methods
1375
self.assertEqual(e.exception.code, 2)
1378
@contextlib.contextmanager
1379
def temporarily_suppress_stderr():
1380
null = os.open(os.path.devnull, os.O_RDWR)
1381
stderrcopy = os.dup(sys.stderr.fileno())
1382
os.dup2(null, sys.stderr.fileno())
1388
os.dup2(stderrcopy, sys.stderr.fileno())
1389
os.close(stderrcopy)
1391
def check_option_syntax(self, options):
1392
check_option_syntax(self.parser, options)
1394
def test_actions_requires_client_or_all(self):
1395
for action, value in self.actions.items():
1396
options = self.parser.parse_args()
1397
setattr(options, action, value)
1398
with self.assertParseError():
1399
self.check_option_syntax(options)
1401
def test_actions_conflicts_with_verbose(self):
1402
for action, value in self.actions.items():
1403
options = self.parser.parse_args()
1404
setattr(options, action, value)
1405
options.verbose = True
1406
with self.assertParseError():
1407
self.check_option_syntax(options)
1409
def test_dump_json_conflicts_with_verbose(self):
1410
options = self.parser.parse_args()
1411
options.dump_json = True
1412
options.verbose = True
1413
with self.assertParseError():
1414
self.check_option_syntax(options)
1416
def test_dump_json_conflicts_with_action(self):
1417
for action, value in self.actions.items():
1418
options = self.parser.parse_args()
1419
setattr(options, action, value)
1420
options.dump_json = True
1421
with self.assertParseError():
1422
self.check_option_syntax(options)
1424
def test_all_can_not_be_alone(self):
1425
options = self.parser.parse_args()
1427
with self.assertParseError():
1428
self.check_option_syntax(options)
1430
def test_all_is_ok_with_any_action(self):
1431
for action, value in self.actions.items():
1432
options = self.parser.parse_args()
1433
setattr(options, action, value)
1435
self.check_option_syntax(options)
1437
def test_is_enabled_fails_without_client(self):
1438
options = self.parser.parse_args()
1439
options.is_enabled = True
1440
with self.assertParseError():
1441
self.check_option_syntax(options)
1443
def test_is_enabled_works_with_one_client(self):
1444
options = self.parser.parse_args()
1445
options.is_enabled = True
1446
options.client = ["foo"]
1447
self.check_option_syntax(options)
1449
def test_is_enabled_fails_with_two_clients(self):
1450
options = self.parser.parse_args()
1451
options.is_enabled = True
1452
options.client = ["foo", "barbar"]
1453
with self.assertParseError():
1454
self.check_option_syntax(options)
2371
values_to_get = [f.getvalue() for f in values_to_set]
2374
class TestSetTimeoutCmd(TestPropertySetterCmd):
2375
command = command.SetTimeout
2376
propname = "Timeout"
2377
values_to_set = [datetime.timedelta(),
2378
datetime.timedelta(minutes=5),
2379
datetime.timedelta(seconds=1),
2380
datetime.timedelta(weeks=1),
2381
datetime.timedelta(weeks=52)]
2382
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2385
class TestSetExtendedTimeoutCmd(TestPropertySetterCmd):
2386
command = command.SetExtendedTimeout
2387
propname = "ExtendedTimeout"
2388
values_to_set = [datetime.timedelta(),
2389
datetime.timedelta(minutes=5),
2390
datetime.timedelta(seconds=1),
2391
datetime.timedelta(weeks=1),
2392
datetime.timedelta(weeks=52)]
2393
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2396
class TestSetIntervalCmd(TestPropertySetterCmd):
2397
command = command.SetInterval
2398
propname = "Interval"
2399
values_to_set = [datetime.timedelta(),
2400
datetime.timedelta(minutes=5),
2401
datetime.timedelta(seconds=1),
2402
datetime.timedelta(weeks=1),
2403
datetime.timedelta(weeks=52)]
2404
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2407
class TestSetApprovalDelayCmd(TestPropertySetterCmd):
2408
command = command.SetApprovalDelay
2409
propname = "ApprovalDelay"
2410
values_to_set = [datetime.timedelta(),
2411
datetime.timedelta(minutes=5),
2412
datetime.timedelta(seconds=1),
2413
datetime.timedelta(weeks=1),
2414
datetime.timedelta(weeks=52)]
2415
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2418
class TestSetApprovalDurationCmd(TestPropertySetterCmd):
2419
command = command.SetApprovalDuration
2420
propname = "ApprovalDuration"
2421
values_to_set = [datetime.timedelta(),
2422
datetime.timedelta(minutes=5),
2423
datetime.timedelta(seconds=1),
2424
datetime.timedelta(weeks=1),
2425
datetime.timedelta(weeks=52)]
2426
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]