409
408
"""Apply additional restrictions on options, not expressible in
412
def has_commands(options, commands=None):
414
commands = (command.Enable,
417
command.StartChecker,
423
command.SetExtendedTimeout,
425
command.ApproveByDefault,
426
command.DenyByDefault,
427
command.SetApprovalDelay,
428
command.SetApprovalDuration,
433
return any(isinstance(cmd, commands)
434
for cmd in options.commands)
411
def has_actions(options):
412
return any((options.enable,
414
options.bump_timeout,
415
options.start_checker,
416
options.stop_checker,
419
options.checker is not None,
420
options.timeout is not None,
421
options.extended_timeout is not None,
422
options.interval is not None,
423
options.approved_by_default is not None,
424
options.approval_delay is not None,
425
options.approval_duration is not None,
426
options.host is not None,
427
options.secret is not None,
436
if has_commands(options) and not (options.client or options.all):
431
if has_actions(options) and not (options.client or options.all):
437
432
parser.error("Options require clients names or --all.")
438
if options.verbose and has_commands(options):
433
if options.verbose and has_actions(options):
439
434
parser.error("--verbose can only be used alone.")
440
if (has_commands(options, (command.DumpJSON,))
441
and (options.verbose or len(options.commands) > 1)):
435
if options.dump_json and (options.verbose
436
or has_actions(options)):
442
437
parser.error("--dump-json can only be used alone.")
443
if options.all and not has_commands(options):
438
if options.all and not has_actions(options):
444
439
parser.error("--all requires an action.")
445
if (has_commands(options, (command.IsEnabled,))
446
and len(options.client) > 1):
440
if options.is_enabled and len(options.client) > 1:
447
441
parser.error("--is-enabled requires exactly one client")
448
if (len(options.commands) > 1
449
and has_commands(options, (command.Remove,))
450
and not has_commands(options, (command.Deny,))):
451
parser.error("--remove can only be combined with --deny")
456
class SystemBus(object):
458
object_manager_iface = "org.freedesktop.DBus.ObjectManager"
459
def get_managed_objects(self, busname, objectpath):
460
return self.call_method("GetManagedObjects", busname,
462
self.object_manager_iface)
464
properties_iface = "org.freedesktop.DBus.Properties"
465
def set_property(self, busname, objectpath, interface, key,
467
self.call_method("Set", busname, objectpath,
468
self.properties_iface, interface, key,
472
class MandosBus(SystemBus):
473
busname_domain = "se.recompile"
474
busname = busname_domain + ".Mandos"
476
server_interface = busname_domain + ".Mandos"
477
client_interface = busname_domain + ".Mandos.Client"
480
def get_clients_and_properties(self):
481
managed_objects = self.get_managed_objects(
482
self.busname, self.server_path)
483
return {objpath: properties[self.client_interface]
484
for objpath, properties in managed_objects.items()
485
if self.client_interface in properties}
487
def set_client_property(self, objectpath, key, value):
488
return self.set_property(self.busname, objectpath,
489
self.client_interface, key,
492
def call_client_method(self, objectpath, method, *args):
493
return self.call_method(method, self.busname, objectpath,
494
self.client_interface, *args)
496
def call_server_method(self, method, *args):
497
return self.call_method(method, self.busname,
499
self.server_interface, *args)
501
class Error(Exception):
504
class ConnectFailed(Error):
508
class dbus_python_adapter(object):
510
class SystemBus(dbus.MandosBus):
511
"""Use dbus-python"""
513
def __init__(self, module=dbus_python):
514
self.dbus_python = module
515
self.bus = self.dbus_python.SystemBus()
517
@contextlib.contextmanager
518
def convert_exception(self, exception_class=dbus.Error):
521
except self.dbus_python.exceptions.DBusException as e:
522
# This does what "raise from" would do
523
exc = exception_class(*e.args)
527
def call_method(self, methodname, busname, objectpath,
529
proxy_object = self.get_object(busname, objectpath)
530
log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
531
interface, methodname,
532
", ".join(repr(a) for a in args))
533
method = getattr(proxy_object, methodname)
534
with self.convert_exception():
535
with dbus_python_adapter.SilenceLogger(
537
value = method(*args, dbus_interface=interface)
538
return self.type_filter(value)
540
def get_object(self, busname, objectpath):
541
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
543
with self.convert_exception(dbus.ConnectFailed):
544
return self.bus.get_object(busname, objectpath)
546
def type_filter(self, value):
547
"""Convert the most bothersome types to Python types"""
548
if isinstance(value, self.dbus_python.Boolean):
550
if isinstance(value, self.dbus_python.ObjectPath):
552
# Also recurse into dictionaries
553
if isinstance(value, self.dbus_python.Dictionary):
554
return {self.type_filter(key):
555
self.type_filter(subval)
556
for key, subval in value.items()}
560
class SilenceLogger(object):
561
"Simple context manager to silence a particular logger"
562
def __init__(self, loggername):
563
self.logger = logging.getLogger(loggername)
566
self.logger.addFilter(self.nullfilter)
568
class NullFilter(logging.Filter):
569
def filter(self, record):
572
nullfilter = NullFilter()
574
def __exit__(self, exc_type, exc_val, exc_tb):
575
self.logger.removeFilter(self.nullfilter)
578
class CachingBus(SystemBus):
579
"""A caching layer for dbus_python_adapter.SystemBus"""
580
def __init__(self, *args, **kwargs):
581
self.object_cache = {}
582
super(dbus_python_adapter.CachingBus,
583
self).__init__(*args, **kwargs)
584
def get_object(self, busname, objectpath):
586
return self.object_cache[(busname, objectpath)]
589
dbus_python_adapter.CachingBus,
590
self).get_object(busname, objectpath)
591
self.object_cache[(busname, objectpath)] = new_object
443
options.remove = False
444
if has_actions(options) and not options.deny:
445
parser.error("--remove can only be combined with --deny")
446
options.remove = True
595
449
def commands_from_options(options):
597
commands = list(options.commands)
599
def find_cmd(cmd, commands):
601
for i, c in enumerate(commands):
602
if isinstance(c, cmd):
606
# If command.Remove is present, move any instances of command.Deny
607
# to occur ahead of command.Remove.
608
index_of_remove = find_cmd(command.Remove, commands)
609
before_remove = commands[:index_of_remove]
610
after_remove = commands[index_of_remove:]
612
for cmd in after_remove:
613
if isinstance(cmd, command.Deny):
614
before_remove.append(cmd)
453
if options.is_enabled:
454
commands.append(IsEnabledCmd())
457
commands.append(ApproveCmd())
460
commands.append(DenyCmd())
463
commands.append(RemoveCmd())
465
if options.dump_json:
466
commands.append(DumpJSONCmd())
469
commands.append(EnableCmd())
472
commands.append(DisableCmd())
474
if options.bump_timeout:
475
commands.append(BumpTimeoutCmd())
477
if options.start_checker:
478
commands.append(StartCheckerCmd())
480
if options.stop_checker:
481
commands.append(StopCheckerCmd())
483
if options.approved_by_default is not None:
484
if options.approved_by_default:
485
commands.append(ApproveByDefaultCmd())
616
cleaned_after.append(cmd)
617
if cleaned_after != after_remove:
618
commands = before_remove + cleaned_after
487
commands.append(DenyByDefaultCmd())
489
if options.checker is not None:
490
commands.append(SetCheckerCmd(options.checker))
492
if options.host is not None:
493
commands.append(SetHostCmd(options.host))
495
if options.secret is not None:
496
commands.append(SetSecretCmd(options.secret))
498
if options.timeout is not None:
499
commands.append(SetTimeoutCmd(options.timeout))
501
if options.extended_timeout:
503
SetExtendedTimeoutCmd(options.extended_timeout))
505
if options.interval is not None:
506
commands.append(SetIntervalCmd(options.interval))
508
if options.approval_delay is not None:
509
commands.append(SetApprovalDelayCmd(options.approval_delay))
511
if options.approval_duration is not None:
513
SetApprovalDurationCmd(options.approval_duration))
620
515
# If no command option has been given, show table of clients,
621
516
# optionally verbosely
623
commands.append(command.PrintTable(verbose=options.verbose))
518
commands.append(PrintTableCmd(verbose=options.verbose))
628
class command(object):
629
"""A namespace for command classes"""
632
"""Abstract base class for commands"""
633
def run(self, clients, bus=None):
634
"""Normal commands should implement run_on_one_client(),
635
but commands which want to operate on all clients at the same time can
636
override this run() method instead.
639
for client, properties in clients.items():
640
self.run_on_one_client(client, properties)
643
class IsEnabled(Base):
644
def run(self, clients, bus=None):
645
properties = next(iter(clients.values()))
646
if properties["Enabled"]:
652
def run_on_one_client(self, client, properties):
653
self.bus.call_client_method(client, "Approve", True)
657
def run_on_one_client(self, client, properties):
658
self.bus.call_client_method(client, "Approve", False)
662
def run(self, clients, bus):
663
for clientpath in frozenset(clients.keys()):
664
bus.call_server_method("RemoveClient", clientpath)
668
"""Abstract class for commands outputting client details"""
669
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
670
"Created", "Interval", "Host", "KeyID",
671
"Fingerprint", "CheckerRunning",
672
"LastEnabled", "ApprovalPending",
673
"ApprovedByDefault", "LastApprovalRequest",
674
"ApprovalDelay", "ApprovalDuration",
675
"Checker", "ExtendedTimeout", "Expires",
679
class DumpJSON(Output):
680
def run(self, clients, bus=None):
681
data = {properties["Name"]:
682
{key: properties[key]
683
for key in self.all_keywords}
684
for properties in clients.values()}
685
print(json.dumps(data, indent=4, separators=(',', ': ')))
688
class PrintTable(Output):
689
def __init__(self, verbose=False):
690
self.verbose = verbose
692
def run(self, clients, bus=None):
693
default_keywords = ("Name", "Enabled", "Timeout",
695
keywords = default_keywords
697
keywords = self.all_keywords
698
print(self.TableOfClients(clients.values(), keywords))
700
class TableOfClients(object):
703
"Enabled": "Enabled",
704
"Timeout": "Timeout",
705
"LastCheckedOK": "Last Successful Check",
706
"LastApprovalRequest": "Last Approval Request",
707
"Created": "Created",
708
"Interval": "Interval",
710
"Fingerprint": "Fingerprint",
712
"CheckerRunning": "Check Is Running",
713
"LastEnabled": "Last Enabled",
714
"ApprovalPending": "Approval Is Pending",
715
"ApprovedByDefault": "Approved By Default",
716
"ApprovalDelay": "Approval Delay",
717
"ApprovalDuration": "Approval Duration",
718
"Checker": "Checker",
719
"ExtendedTimeout": "Extended Timeout",
720
"Expires": "Expires",
721
"LastCheckerStatus": "Last Checker Status",
724
def __init__(self, clients, keywords):
725
self.clients = clients
726
self.keywords = keywords
523
class Command(object):
524
"""Abstract class for commands"""
525
def run(self, clients, bus=None, mandos=None):
526
"""Normal commands should implement run_on_one_client(), but
527
commands which want to operate on all clients at the same time
528
can override this run() method instead."""
530
for clientpath, properties in clients.items():
531
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
532
dbus_busname, str(clientpath))
533
client = bus.get_object(dbus_busname, clientpath)
534
self.run_on_one_client(client, properties)
537
class IsEnabledCmd(Command):
538
def run(self, clients, bus=None, mandos=None):
539
client, properties = next(iter(clients.items()))
540
if self.is_enabled(client, properties):
543
def is_enabled(self, client, properties):
544
return properties["Enabled"]
547
class ApproveCmd(Command):
548
def run_on_one_client(self, client, properties):
549
log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
550
client.__dbus_object_path__, client_dbus_interface)
551
client.Approve(dbus.Boolean(True),
552
dbus_interface=client_dbus_interface)
555
class DenyCmd(Command):
556
def run_on_one_client(self, client, properties):
557
log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
558
client.__dbus_object_path__, client_dbus_interface)
559
client.Approve(dbus.Boolean(False),
560
dbus_interface=client_dbus_interface)
563
class RemoveCmd(Command):
564
def run_on_one_client(self, client, properties):
565
log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)", dbus_busname,
566
server_dbus_path, server_dbus_interface,
567
str(client.__dbus_object_path__))
568
self.mandos.RemoveClient(client.__dbus_object_path__)
571
class PrintCmd(Command):
572
"""Abstract class for commands printing client details"""
573
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
574
"Created", "Interval", "Host", "KeyID",
575
"Fingerprint", "CheckerRunning", "LastEnabled",
576
"ApprovalPending", "ApprovedByDefault",
577
"LastApprovalRequest", "ApprovalDelay",
578
"ApprovalDuration", "Checker", "ExtendedTimeout",
579
"Expires", "LastCheckerStatus")
580
def run(self, clients, bus=None, mandos=None):
581
print(self.output(clients.values()))
582
def output(self, clients):
583
raise NotImplementedError()
586
class DumpJSONCmd(PrintCmd):
587
def output(self, clients):
588
data = {client["Name"]:
589
{key: self.dbus_boolean_to_bool(client[key])
590
for key in self.all_keywords}
591
for client in clients.values()}
592
return json.dumps(data, indent=4, separators=(',', ': '))
594
def dbus_boolean_to_bool(value):
595
if isinstance(value, dbus.Boolean):
600
class PrintTableCmd(PrintCmd):
601
def __init__(self, verbose=False):
602
self.verbose = verbose
604
def output(self, clients):
605
default_keywords = ("Name", "Enabled", "Timeout",
607
keywords = default_keywords
609
keywords = self.all_keywords
610
return str(self.TableOfClients(clients, keywords))
612
class TableOfClients(object):
615
"Enabled": "Enabled",
616
"Timeout": "Timeout",
617
"LastCheckedOK": "Last Successful Check",
618
"LastApprovalRequest": "Last Approval Request",
619
"Created": "Created",
620
"Interval": "Interval",
622
"Fingerprint": "Fingerprint",
624
"CheckerRunning": "Check Is Running",
625
"LastEnabled": "Last Enabled",
626
"ApprovalPending": "Approval Is Pending",
627
"ApprovedByDefault": "Approved By Default",
628
"ApprovalDelay": "Approval Delay",
629
"ApprovalDuration": "Approval Duration",
630
"Checker": "Checker",
631
"ExtendedTimeout": "Extended Timeout",
632
"Expires": "Expires",
633
"LastCheckerStatus": "Last Checker Status",
636
def __init__(self, clients, keywords, tableheaders=None):
637
self.clients = clients
638
self.keywords = keywords
639
if tableheaders is not None:
640
self.tableheaders = tableheaders
643
return "\n".join(self.rows())
645
if sys.version_info.major == 2:
646
__unicode__ = __str__
728
647
def __str__(self):
729
return "\n".join(self.rows())
731
if sys.version_info.major == 2:
732
__unicode__ = __str__
734
return str(self).encode(
735
locale.getpreferredencoding())
738
format_string = self.row_formatting_string()
739
rows = [self.header_line(format_string)]
740
rows.extend(self.client_line(client, format_string)
741
for client in self.clients)
744
def row_formatting_string(self):
745
"Format string used to format table rows"
746
return " ".join("{{{key}:{width}}}".format(
747
width=max(len(self.tableheaders[key]),
748
*(len(self.string_from_client(client,
750
for client in self.clients)),
752
for key in self.keywords)
754
def string_from_client(self, client, key):
755
return self.valuetostring(client[key], key)
758
def valuetostring(cls, value, keyword):
759
if isinstance(value, bool):
760
return "Yes" if value else "No"
761
if keyword in ("Timeout", "Interval", "ApprovalDelay",
762
"ApprovalDuration", "ExtendedTimeout"):
763
return cls.milliseconds_to_string(value)
766
def header_line(self, format_string):
767
return format_string.format(**self.tableheaders)
769
def client_line(self, client, format_string):
770
return format_string.format(
771
**{key: self.string_from_client(client, key)
772
for key in self.keywords})
775
def milliseconds_to_string(ms):
776
td = datetime.timedelta(0, 0, 0, ms)
777
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
778
.format(days="{}T".format(td.days)
780
hours=td.seconds // 3600,
781
minutes=(td.seconds % 3600) // 60,
782
seconds=td.seconds % 60))
785
class PropertySetter(Base):
786
"Abstract class for Actions for setting one client property"
788
def run_on_one_client(self, client, properties=None):
789
"""Set the Client's D-Bus property"""
790
self.bus.set_client_property(client, self.propname,
795
raise NotImplementedError()
798
class Enable(PropertySetter):
803
class Disable(PropertySetter):
808
class BumpTimeout(PropertySetter):
809
propname = "LastCheckedOK"
813
class StartChecker(PropertySetter):
814
propname = "CheckerRunning"
818
class StopChecker(PropertySetter):
819
propname = "CheckerRunning"
823
class ApproveByDefault(PropertySetter):
824
propname = "ApprovedByDefault"
828
class DenyByDefault(PropertySetter):
829
propname = "ApprovedByDefault"
833
class PropertySetterValue(PropertySetter):
834
"""Abstract class for PropertySetter recieving a value as
835
constructor argument instead of a class attribute."""
836
def __init__(self, value):
837
self.value_to_set = value
840
def argparse(cls, argtype):
842
return cls(argtype(arg))
845
class SetChecker(PropertySetterValue):
849
class SetHost(PropertySetterValue):
853
class SetSecret(PropertySetterValue):
857
def value_to_set(self):
861
def value_to_set(self, value):
862
"""When setting, read data from supplied file object"""
863
self._vts = value.read()
867
class PropertySetterValueMilliseconds(PropertySetterValue):
868
"""Abstract class for PropertySetterValue taking a value
869
argument as a datetime.timedelta() but should store it as
873
def value_to_set(self):
877
def value_to_set(self, value):
878
"When setting, convert value from a datetime.timedelta"
879
self._vts = int(round(value.total_seconds() * 1000))
882
class SetTimeout(PropertySetterValueMilliseconds):
886
class SetExtendedTimeout(PropertySetterValueMilliseconds):
887
propname = "ExtendedTimeout"
890
class SetInterval(PropertySetterValueMilliseconds):
891
propname = "Interval"
894
class SetApprovalDelay(PropertySetterValueMilliseconds):
895
propname = "ApprovalDelay"
898
class SetApprovalDuration(PropertySetterValueMilliseconds):
899
propname = "ApprovalDuration"
648
return str(self).encode(locale.getpreferredencoding())
651
format_string = self.row_formatting_string()
652
rows = [self.header_line(format_string)]
653
rows.extend(self.client_line(client, format_string)
654
for client in self.clients)
657
def row_formatting_string(self):
658
"Format string used to format table rows"
659
return " ".join("{{{key}:{width}}}".format(
660
width=max(len(self.tableheaders[key]),
661
*(len(self.string_from_client(client, key))
662
for client in self.clients)),
664
for key in self.keywords)
666
def string_from_client(self, client, key):
667
return self.valuetostring(client[key], key)
670
def valuetostring(value, keyword):
671
if isinstance(value, dbus.Boolean):
672
return "Yes" if value else "No"
673
if keyword in ("Timeout", "Interval", "ApprovalDelay",
674
"ApprovalDuration", "ExtendedTimeout"):
675
return milliseconds_to_string(value)
678
def header_line(self, format_string):
679
return format_string.format(**self.tableheaders)
681
def client_line(self, client, format_string):
682
return format_string.format(
683
**{key: self.string_from_client(client, key)
684
for key in self.keywords})
687
def milliseconds_to_string(ms):
688
td = datetime.timedelta(0, 0, 0, ms)
689
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
690
.format(days="{}T".format(td.days) if td.days else "",
691
hours=td.seconds // 3600,
692
minutes=(td.seconds % 3600) // 60,
693
seconds=td.seconds % 60))
696
class PropertyCmd(Command):
697
"""Abstract class for Actions for setting one client property"""
698
def run_on_one_client(self, client, properties):
699
"""Set the Client's D-Bus property"""
700
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
701
client.__dbus_object_path__,
702
dbus.PROPERTIES_IFACE, client_dbus_interface,
703
self.propname, self.value_to_set
704
if not isinstance(self.value_to_set, dbus.Boolean)
705
else bool(self.value_to_set))
706
client.Set(client_dbus_interface, self.propname,
708
dbus_interface=dbus.PROPERTIES_IFACE)
711
raise NotImplementedError()
714
class EnableCmd(PropertyCmd):
716
value_to_set = dbus.Boolean(True)
719
class DisableCmd(PropertyCmd):
721
value_to_set = dbus.Boolean(False)
724
class BumpTimeoutCmd(PropertyCmd):
725
propname = "LastCheckedOK"
729
class StartCheckerCmd(PropertyCmd):
730
propname = "CheckerRunning"
731
value_to_set = dbus.Boolean(True)
734
class StopCheckerCmd(PropertyCmd):
735
propname = "CheckerRunning"
736
value_to_set = dbus.Boolean(False)
739
class ApproveByDefaultCmd(PropertyCmd):
740
propname = "ApprovedByDefault"
741
value_to_set = dbus.Boolean(True)
744
class DenyByDefaultCmd(PropertyCmd):
745
propname = "ApprovedByDefault"
746
value_to_set = dbus.Boolean(False)
749
class PropertyValueCmd(PropertyCmd):
750
"""Abstract class for PropertyCmd recieving a value as argument"""
751
def __init__(self, value):
752
self.value_to_set = value
755
class SetCheckerCmd(PropertyValueCmd):
759
class SetHostCmd(PropertyValueCmd):
763
class SetSecretCmd(PropertyValueCmd):
766
def value_to_set(self):
769
def value_to_set(self, value):
770
"""When setting, read data from supplied file object"""
771
self._vts = value.read()
775
class MillisecondsPropertyValueArgumentCmd(PropertyValueCmd):
776
"""Abstract class for PropertyValueCmd taking a value argument as
777
a datetime.timedelta() but should store it as milliseconds."""
779
def value_to_set(self):
782
def value_to_set(self, value):
783
"""When setting, convert value from a datetime.timedelta"""
784
self._vts = int(round(value.total_seconds() * 1000))
787
class SetTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
791
class SetExtendedTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
792
propname = "ExtendedTimeout"
795
class SetIntervalCmd(MillisecondsPropertyValueArgumentCmd):
796
propname = "Interval"
799
class SetApprovalDelayCmd(MillisecondsPropertyValueArgumentCmd):
800
propname = "ApprovalDelay"
803
class SetApprovalDurationCmd(MillisecondsPropertyValueArgumentCmd):
804
propname = "ApprovalDuration"
903
class TestCaseWithAssertLogs(unittest.TestCase):
904
"""unittest.TestCase.assertLogs only exists in Python 3.4"""
906
if not hasattr(unittest.TestCase, "assertLogs"):
907
@contextlib.contextmanager
908
def assertLogs(self, logger, level=logging.INFO):
909
capturing_handler = self.CapturingLevelHandler(level)
910
old_level = logger.level
911
old_propagate = logger.propagate
912
logger.addHandler(capturing_handler)
913
logger.setLevel(level)
914
logger.propagate = False
916
yield capturing_handler.watcher
918
logger.propagate = old_propagate
919
logger.removeHandler(capturing_handler)
920
logger.setLevel(old_level)
921
self.assertGreater(len(capturing_handler.watcher.records),
924
class CapturingLevelHandler(logging.Handler):
925
def __init__(self, level, *args, **kwargs):
926
logging.Handler.__init__(self, *args, **kwargs)
927
self.watcher = self.LoggingWatcher([], [])
928
def emit(self, record):
929
self.watcher.records.append(record)
930
self.watcher.output.append(self.format(record))
932
LoggingWatcher = collections.namedtuple("LoggingWatcher",
937
class Unique(object):
938
"""Class for objects which exist only to be unique objects, since
939
unittest.mock.sentinel only exists in Python 3.3"""
942
class Test_string_to_delta(TestCaseWithAssertLogs):
943
# Just test basic RFC 3339 functionality here, the doc string for
944
# rfc3339_duration_to_delta() already has more comprehensive
945
# tests, which are run by doctest.
947
def test_rfc3339_zero_seconds(self):
948
self.assertEqual(datetime.timedelta(),
949
string_to_delta("PT0S"))
951
def test_rfc3339_zero_days(self):
952
self.assertEqual(datetime.timedelta(), string_to_delta("P0D"))
954
def test_rfc3339_one_second(self):
955
self.assertEqual(datetime.timedelta(0, 1),
956
string_to_delta("PT1S"))
958
def test_rfc3339_two_hours(self):
959
self.assertEqual(datetime.timedelta(0, 7200),
960
string_to_delta("PT2H"))
808
class Test_string_to_delta(unittest.TestCase):
809
def test_handles_basic_rfc3339(self):
810
self.assertEqual(string_to_delta("PT0S"),
811
datetime.timedelta())
812
self.assertEqual(string_to_delta("P0D"),
813
datetime.timedelta())
814
self.assertEqual(string_to_delta("PT1S"),
815
datetime.timedelta(0, 1))
816
self.assertEqual(string_to_delta("PT2H"),
817
datetime.timedelta(0, 7200))
962
818
def test_falls_back_to_pre_1_6_1_with_warning(self):
963
with self.assertLogs(log, logging.WARNING):
964
value = string_to_delta("2h")
965
self.assertEqual(datetime.timedelta(0, 7200), value)
819
# assertLogs only exists in Python 3.4
820
if hasattr(self, "assertLogs"):
821
with self.assertLogs(log, logging.WARNING):
822
value = string_to_delta("2h")
824
class WarningFilter(logging.Filter):
825
"""Don't show, but record the presence of, warnings"""
826
def filter(self, record):
827
is_warning = record.levelno >= logging.WARNING
828
self.found = is_warning or getattr(self, "found",
830
return not is_warning
831
warning_filter = WarningFilter()
832
log.addFilter(warning_filter)
834
value = string_to_delta("2h")
836
log.removeFilter(warning_filter)
837
self.assertTrue(getattr(warning_filter, "found", False))
838
self.assertEqual(value, datetime.timedelta(0, 7200))
968
841
class Test_check_option_syntax(unittest.TestCase):
970
self.parser = argparse.ArgumentParser()
971
add_command_line_options(self.parser)
973
def test_actions_requires_client_or_all(self):
974
for action, value in self.actions.items():
975
args = self.actionargs(action, value)
976
with self.assertParseError():
977
self.parse_args(args)
979
# This mostly corresponds to the definition from has_commands() in
842
# This mostly corresponds to the definition from has_actions() in
980
843
# check_option_syntax()
984
"--bump-timeout": None,
985
"--start-checker": None,
986
"--stop-checker": None,
987
"--is-enabled": None,
991
"--extended-timeout": "PT0S",
992
"--interval": "PT0S",
993
"--approve-by-default": None,
994
"--deny-by-default": None,
995
"--approval-delay": "PT0S",
996
"--approval-duration": "PT0S",
997
"--host": "hostname",
998
"--secret": "/dev/null",
845
# The actual values set here are not that important, but we do
846
# at least stick to the correct types, even though they are
850
"bump_timeout": True,
851
"start_checker": True,
852
"stop_checker": True,
856
"timeout": datetime.timedelta(),
857
"extended_timeout": datetime.timedelta(),
858
"interval": datetime.timedelta(),
859
"approved_by_default": True,
860
"approval_delay": datetime.timedelta(),
861
"approval_duration": datetime.timedelta(),
863
"secret": io.BytesIO(b"x"),
1004
def actionargs(action, value, *args):
1005
if value is not None:
1006
return [action, value] + list(args)
1008
return [action] + list(args)
869
self.parser = argparse.ArgumentParser()
870
add_command_line_options(self.parser)
1010
872
@contextlib.contextmanager
1011
873
def assertParseError(self):
1012
874
with self.assertRaises(SystemExit) as e:
1013
with self.redirect_stderr_to_devnull():
875
with self.temporarily_suppress_stderr():
1015
877
# Exit code from argparse is guaranteed to be "2". Reference:
1016
878
# https://docs.python.org/3/library
1017
879
# /argparse.html#exiting-methods
1018
self.assertEqual(2, e.exception.code)
1020
def parse_args(self, args):
1021
options = self.parser.parse_args(args)
1022
check_option_syntax(self.parser, options)
880
self.assertEqual(e.exception.code, 2)
1025
883
@contextlib.contextmanager
1026
def redirect_stderr_to_devnull():
1027
old_stderr = sys.stderr
1028
with contextlib.closing(open(os.devnull, "w")) as null:
1033
sys.stderr = old_stderr
884
def temporarily_suppress_stderr():
885
null = os.open(os.path.devnull, os.O_RDWR)
886
stderrcopy = os.dup(sys.stderr.fileno())
887
os.dup2(null, sys.stderr.fileno())
893
os.dup2(stderrcopy, sys.stderr.fileno())
1035
896
def check_option_syntax(self, options):
1036
897
check_option_syntax(self.parser, options)
1038
def test_actions_all_conflicts_with_verbose(self):
899
def test_actions_requires_client_or_all(self):
1039
900
for action, value in self.actions.items():
1040
args = self.actionargs(action, value, "--all",
901
options = self.parser.parse_args()
902
setattr(options, action, value)
1042
903
with self.assertParseError():
1043
self.parse_args(args)
904
self.check_option_syntax(options)
1045
def test_actions_with_client_conflicts_with_verbose(self):
906
def test_actions_conflicts_with_verbose(self):
1046
907
for action, value in self.actions.items():
1047
args = self.actionargs(action, value, "--verbose",
908
options = self.parser.parse_args()
909
setattr(options, action, value)
910
options.verbose = True
1049
911
with self.assertParseError():
1050
self.parse_args(args)
912
self.check_option_syntax(options)
1052
914
def test_dump_json_conflicts_with_verbose(self):
1053
args = ["--dump-json", "--verbose"]
915
options = self.parser.parse_args()
916
options.dump_json = True
917
options.verbose = True
1054
918
with self.assertParseError():
1055
self.parse_args(args)
919
self.check_option_syntax(options)
1057
921
def test_dump_json_conflicts_with_action(self):
1058
922
for action, value in self.actions.items():
1059
args = self.actionargs(action, value, "--dump-json")
923
options = self.parser.parse_args()
924
setattr(options, action, value)
925
options.dump_json = True
1060
926
with self.assertParseError():
1061
self.parse_args(args)
927
self.check_option_syntax(options)
1063
929
def test_all_can_not_be_alone(self):
930
options = self.parser.parse_args()
1065
932
with self.assertParseError():
1066
self.parse_args(args)
933
self.check_option_syntax(options)
1068
935
def test_all_is_ok_with_any_action(self):
1069
936
for action, value in self.actions.items():
1070
args = self.actionargs(action, value, "--all")
1071
self.parse_args(args)
1073
def test_any_action_is_ok_with_one_client(self):
1074
for action, value in self.actions.items():
1075
args = self.actionargs(action, value, "client")
1076
self.parse_args(args)
1078
def test_one_client_with_all_actions_except_is_enabled(self):
1079
for action, value in self.actions.items():
1080
if action == "--is-enabled":
1082
args = self.actionargs(action, value, "client")
1083
self.parse_args(args)
1085
def test_two_clients_with_all_actions_except_is_enabled(self):
1086
for action, value in self.actions.items():
1087
if action == "--is-enabled":
1089
args = self.actionargs(action, value, "client1",
1091
self.parse_args(args)
1093
def test_two_clients_are_ok_with_actions_except_is_enabled(self):
1094
for action, value in self.actions.items():
1095
if action == "--is-enabled":
1097
args = self.actionargs(action, value, "client1",
1099
self.parse_args(args)
937
options = self.parser.parse_args()
938
setattr(options, action, value)
940
self.check_option_syntax(options)
1101
942
def test_is_enabled_fails_without_client(self):
1102
args = ["--is-enabled"]
943
options = self.parser.parse_args()
944
options.is_enabled = True
1103
945
with self.assertParseError():
1104
self.parse_args(args)
946
self.check_option_syntax(options)
948
def test_is_enabled_works_with_one_client(self):
949
options = self.parser.parse_args()
950
options.is_enabled = True
951
options.client = ["foo"]
952
self.check_option_syntax(options)
1106
954
def test_is_enabled_fails_with_two_clients(self):
1107
args = ["--is-enabled", "client1", "client2"]
955
options = self.parser.parse_args()
956
options.is_enabled = True
957
options.client = ["foo", "barbar"]
1108
958
with self.assertParseError():
1109
self.parse_args(args)
959
self.check_option_syntax(options)
1111
961
def test_remove_can_only_be_combined_with_action_deny(self):
1112
962
for action, value in self.actions.items():
1113
if action in {"--remove", "--deny"}:
963
if action in {"remove", "deny"}:
1115
args = self.actionargs(action, value, "--all",
965
options = self.parser.parse_args()
966
setattr(options, action, value)
968
options.remove = True
1117
969
with self.assertParseError():
1118
self.parse_args(args)
1121
class Test_dbus_exceptions(unittest.TestCase):
1123
def test_dbus_ConnectFailed_is_Error(self):
1124
with self.assertRaises(dbus.Error):
1125
raise dbus.ConnectFailed()
1128
class Test_dbus_MandosBus(unittest.TestCase):
1130
class MockMandosBus(dbus.MandosBus):
1132
self._name = "se.recompile.Mandos"
1133
self._server_path = "/"
1134
self._server_interface = "se.recompile.Mandos"
1135
self._client_interface = "se.recompile.Mandos.Client"
1137
self.call_method_return = Unique()
1139
def call_method(self, methodname, busname, objectpath,
1141
self.calls.append((methodname, busname, objectpath,
1143
return self.call_method_return
1146
self.bus = self.MockMandosBus()
1148
def test_set_client_property(self):
1149
self.bus.set_client_property("objectpath", "key", "value")
1150
expected_call = ("Set", self.bus._name, "objectpath",
1151
"org.freedesktop.DBus.Properties",
1152
(self.bus._client_interface, "key", "value"))
1153
self.assertIn(expected_call, self.bus.calls)
1155
def test_call_client_method(self):
1156
ret = self.bus.call_client_method("objectpath", "methodname")
1157
self.assertIs(self.bus.call_method_return, ret)
1158
expected_call = ("methodname", self.bus._name, "objectpath",
1159
self.bus._client_interface, ())
1160
self.assertIn(expected_call, self.bus.calls)
1162
def test_call_client_method_with_args(self):
1163
args = (Unique(), Unique())
1164
ret = self.bus.call_client_method("objectpath", "methodname",
1166
self.assertIs(self.bus.call_method_return, ret)
1167
expected_call = ("methodname", self.bus._name, "objectpath",
1168
self.bus._client_interface,
1170
self.assertIn(expected_call, self.bus.calls)
1172
def test_get_clients_and_properties(self):
1175
self.bus._client_interface: {
1179
"irrelevant_interface": {
1180
"key": "othervalue",
1184
"other_objectpath": {
1185
"other_irrelevant_interface": {
1191
expected_clients_and_properties = {
1197
self.bus.call_method_return = managed_objects
1198
ret = self.bus.get_clients_and_properties()
1199
self.assertDictEqual(expected_clients_and_properties, ret)
1200
expected_call = ("GetManagedObjects", self.bus._name,
1201
self.bus._server_path,
1202
"org.freedesktop.DBus.ObjectManager", ())
1203
self.assertIn(expected_call, self.bus.calls)
1205
def test_call_server_method(self):
1206
ret = self.bus.call_server_method("methodname")
1207
self.assertIs(self.bus.call_method_return, ret)
1208
expected_call = ("methodname", self.bus._name,
1209
self.bus._server_path,
1210
self.bus._server_interface, ())
1211
self.assertIn(expected_call, self.bus.calls)
1213
def test_call_server_method_with_args(self):
1214
args = (Unique(), Unique())
1215
ret = self.bus.call_server_method("methodname", *args)
1216
self.assertIs(self.bus.call_method_return, ret)
1217
expected_call = ("methodname", self.bus._name,
1218
self.bus._server_path,
1219
self.bus._server_interface,
1221
self.assertIn(expected_call, self.bus.calls)
1224
class Test_dbus_python_adapter_SystemBus(TestCaseWithAssertLogs):
1226
def MockDBusPython_func(self, func):
1227
class mock_dbus_python(object):
1228
"""mock dbus-python module"""
1229
class exceptions(object):
1230
"""Pseudo-namespace"""
1231
class DBusException(Exception):
1233
class SystemBus(object):
1235
def get_object(busname, objectpath):
1236
DBusObject = collections.namedtuple(
1237
"DBusObject", ("methodname",))
1238
def method(*args, **kwargs):
1239
self.assertEqual({"dbus_interface":
1243
return DBusObject(methodname=method)
1244
class Boolean(object):
1245
def __init__(self, value):
1246
self.value = bool(value)
1249
if sys.version_info.major == 2:
1250
__nonzero__ = __bool__
1251
class ObjectPath(str):
1253
class Dictionary(dict):
1255
return mock_dbus_python
1257
def call_method(self, bus, methodname, busname, objectpath,
1259
with self.assertLogs(log, logging.DEBUG):
1260
return bus.call_method(methodname, busname, objectpath,
1263
def test_call_method_returns(self):
1264
expected_method_return = Unique()
1265
method_args = (Unique(), Unique())
1267
self.assertEqual(len(method_args), len(args))
1268
for marg, arg in zip(method_args, args):
1269
self.assertIs(marg, arg)
1270
return expected_method_return
1271
mock_dbus_python = self.MockDBusPython_func(func)
1272
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1273
ret = self.call_method(bus, "methodname", "busname",
1274
"objectpath", "interface",
1276
self.assertIs(ret, expected_method_return)
1278
def test_call_method_filters_bool_true(self):
1280
return method_return
1281
mock_dbus_python = self.MockDBusPython_func(func)
1282
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1283
method_return = mock_dbus_python.Boolean(True)
1284
ret = self.call_method(bus, "methodname", "busname",
1285
"objectpath", "interface")
1286
self.assertTrue(ret)
1287
self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1289
def test_call_method_filters_bool_false(self):
1291
return method_return
1292
mock_dbus_python = self.MockDBusPython_func(func)
1293
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1294
method_return = mock_dbus_python.Boolean(False)
1295
ret = self.call_method(bus, "methodname", "busname",
1296
"objectpath", "interface")
1297
self.assertFalse(ret)
1298
self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1300
def test_call_method_filters_objectpath(self):
1302
return method_return
1303
mock_dbus_python = self.MockDBusPython_func(func)
1304
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1305
method_return = mock_dbus_python.ObjectPath("objectpath")
1306
ret = self.call_method(bus, "methodname", "busname",
1307
"objectpath", "interface")
1308
self.assertEqual("objectpath", ret)
1309
self.assertIsNot("objectpath", ret)
1310
self.assertNotIsInstance(ret, mock_dbus_python.ObjectPath)
1312
def test_call_method_filters_booleans_in_dict(self):
1314
return method_return
1315
mock_dbus_python = self.MockDBusPython_func(func)
1316
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1317
method_return = mock_dbus_python.Dictionary(
1318
{mock_dbus_python.Boolean(True):
1319
mock_dbus_python.Boolean(False),
1320
mock_dbus_python.Boolean(False):
1321
mock_dbus_python.Boolean(True)})
1322
ret = self.call_method(bus, "methodname", "busname",
1323
"objectpath", "interface")
1324
expected_method_return = {True: False,
1326
self.assertEqual(expected_method_return, ret)
1327
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1329
def test_call_method_filters_objectpaths_in_dict(self):
1331
return method_return
1332
mock_dbus_python = self.MockDBusPython_func(func)
1333
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1334
method_return = mock_dbus_python.Dictionary(
1335
{mock_dbus_python.ObjectPath("objectpath_key_1"):
1336
mock_dbus_python.ObjectPath("objectpath_value_1"),
1337
mock_dbus_python.ObjectPath("objectpath_key_2"):
1338
mock_dbus_python.ObjectPath("objectpath_value_2")})
1339
ret = self.call_method(bus, "methodname", "busname",
1340
"objectpath", "interface")
1341
expected_method_return = {str(key): str(value)
1343
method_return.items()}
1344
self.assertEqual(expected_method_return, ret)
1345
self.assertIsInstance(ret, dict)
1346
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1348
def test_call_method_filters_dict_in_dict(self):
1350
return method_return
1351
mock_dbus_python = self.MockDBusPython_func(func)
1352
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1353
method_return = mock_dbus_python.Dictionary(
1354
{"key1": mock_dbus_python.Dictionary({"key11": "value11",
1355
"key12": "value12"}),
1356
"key2": mock_dbus_python.Dictionary({"key21": "value21",
1357
"key22": "value22"})})
1358
ret = self.call_method(bus, "methodname", "busname",
1359
"objectpath", "interface")
1360
expected_method_return = {
1361
"key1": {"key11": "value11",
1362
"key12": "value12"},
1363
"key2": {"key21": "value21",
1364
"key22": "value22"},
1366
self.assertEqual(expected_method_return, ret)
1367
self.assertIsInstance(ret, dict)
1368
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1369
for key, value in ret.items():
1370
self.assertIsInstance(value, dict)
1371
self.assertEqual(expected_method_return[key], value)
1372
self.assertNotIsInstance(value,
1373
mock_dbus_python.Dictionary)
1375
def test_call_method_filters_dict_three_deep(self):
1377
return method_return
1378
mock_dbus_python = self.MockDBusPython_func(func)
1379
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1380
method_return = mock_dbus_python.Dictionary(
1382
mock_dbus_python.Dictionary(
1384
mock_dbus_python.Dictionary(
1386
mock_dbus_python.Boolean(True),
1390
ret = self.call_method(bus, "methodname", "busname",
1391
"objectpath", "interface")
1392
expected_method_return = {"key1": {"key2": {"key3": True}}}
1393
self.assertEqual(expected_method_return, ret)
1394
self.assertIsInstance(ret, dict)
1395
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1396
self.assertIsInstance(ret["key1"], dict)
1397
self.assertNotIsInstance(ret["key1"],
1398
mock_dbus_python.Dictionary)
1399
self.assertIsInstance(ret["key1"]["key2"], dict)
1400
self.assertNotIsInstance(ret["key1"]["key2"],
1401
mock_dbus_python.Dictionary)
1402
self.assertTrue(ret["key1"]["key2"]["key3"])
1403
self.assertNotIsInstance(ret["key1"]["key2"]["key3"],
1404
mock_dbus_python.Boolean)
1406
def test_call_method_handles_exception(self):
1407
dbus_logger = logging.getLogger("dbus.proxies")
1410
dbus_logger.error("Test")
1411
raise mock_dbus_python.exceptions.DBusException()
1413
mock_dbus_python = self.MockDBusPython_func(func)
1414
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1416
class CountingHandler(logging.Handler):
1418
def emit(self, record):
1421
counting_handler = CountingHandler()
1423
dbus_logger.addHandler(counting_handler)
1426
with self.assertRaises(dbus.Error) as e:
1427
self.call_method(bus, "methodname", "busname",
1428
"objectpath", "interface")
1430
dbus_logger.removeFilter(counting_handler)
1432
self.assertNotIsInstance(e, dbus.ConnectFailed)
1434
# Make sure the dbus logger was suppressed
1435
self.assertEqual(0, counting_handler.count)
1437
def test_get_object_converts_to_correct_exception(self):
1438
bus = dbus_python_adapter.SystemBus(
1439
self.fake_dbus_python_raises_exception_on_connect)
1440
with self.assertRaises(dbus.ConnectFailed):
1441
self.call_method(bus, "methodname", "busname",
1442
"objectpath", "interface")
1444
class fake_dbus_python_raises_exception_on_connect(object):
1445
"""fake dbus-python module"""
1446
class exceptions(object):
1447
"""Pseudo-namespace"""
1448
class DBusException(Exception):
1453
def get_object(busname, objectpath):
1454
raise cls.exceptions.DBusException()
1455
Bus = collections.namedtuple("Bus", ["get_object"])
1456
return Bus(get_object=get_object)
1459
class Test_dbus_python_adapter_CachingBus(unittest.TestCase):
1460
class mock_dbus_python(object):
1461
"""mock dbus-python modules"""
1462
class SystemBus(object):
1464
def get_object(busname, objectpath):
1468
self.bus = dbus_python_adapter.CachingBus(
1469
self.mock_dbus_python)
1471
def test_returns_distinct_objectpaths(self):
1472
obj1 = self.bus.get_object("busname", "objectpath1")
1473
self.assertIsInstance(obj1, Unique)
1474
obj2 = self.bus.get_object("busname", "objectpath2")
1475
self.assertIsInstance(obj2, Unique)
1476
self.assertIsNot(obj1, obj2)
1478
def test_returns_distinct_busnames(self):
1479
obj1 = self.bus.get_object("busname1", "objectpath")
1480
self.assertIsInstance(obj1, Unique)
1481
obj2 = self.bus.get_object("busname2", "objectpath")
1482
self.assertIsInstance(obj2, Unique)
1483
self.assertIsNot(obj1, obj2)
1485
def test_returns_distinct_both(self):
1486
obj1 = self.bus.get_object("busname1", "objectpath")
1487
self.assertIsInstance(obj1, Unique)
1488
obj2 = self.bus.get_object("busname2", "objectpath")
1489
self.assertIsInstance(obj2, Unique)
1490
self.assertIsNot(obj1, obj2)
1492
def test_returns_same(self):
1493
obj1 = self.bus.get_object("busname", "objectpath")
1494
self.assertIsInstance(obj1, Unique)
1495
obj2 = self.bus.get_object("busname", "objectpath")
1496
self.assertIsInstance(obj2, Unique)
1497
self.assertIs(obj1, obj2)
1499
def test_returns_same_old(self):
1500
obj1 = self.bus.get_object("busname1", "objectpath1")
1501
self.assertIsInstance(obj1, Unique)
1502
obj2 = self.bus.get_object("busname2", "objectpath2")
1503
self.assertIsInstance(obj2, Unique)
1504
obj1b = self.bus.get_object("busname1", "objectpath1")
1505
self.assertIsInstance(obj1b, Unique)
1506
self.assertIsNot(obj1, obj2)
1507
self.assertIsNot(obj2, obj1b)
1508
self.assertIs(obj1, obj1b)
1511
class Test_commands_from_options(unittest.TestCase):
970
self.check_option_syntax(options)
973
class Test_command_from_options(unittest.TestCase):
1513
974
def setUp(self):
1514
975
self.parser = argparse.ArgumentParser()
1515
976
add_command_line_options(self.parser)
1517
def test_is_enabled(self):
1518
self.assert_command_from_args(["--is-enabled", "client"],
1521
977
def assert_command_from_args(self, args, command_cls,
1523
979
"""Assert that parsing ARGS should result in an instance of
1525
981
options = self.parser.parse_args(args)
1526
982
check_option_syntax(self.parser, options)
1527
983
commands = commands_from_options(options)
1528
self.assertEqual(1, len(commands))
984
self.assertEqual(len(commands), 1)
1529
985
command = commands[0]
1530
986
self.assertIsInstance(command, command_cls)
1531
987
for key, value in cmd_attrs.items():
1532
self.assertEqual(value, getattr(command, key))
1534
def test_is_enabled_short(self):
1535
self.assert_command_from_args(["-V", "client"],
1538
def test_approve(self):
1539
self.assert_command_from_args(["--approve", "client"],
1542
def test_approve_short(self):
1543
self.assert_command_from_args(["-A", "client"],
1546
def test_deny(self):
1547
self.assert_command_from_args(["--deny", "client"],
1550
def test_deny_short(self):
1551
self.assert_command_from_args(["-D", "client"], command.Deny)
1553
def test_remove(self):
1554
self.assert_command_from_args(["--remove", "client"],
1557
def test_deny_before_remove(self):
1558
options = self.parser.parse_args(["--deny", "--remove",
1560
check_option_syntax(self.parser, options)
1561
commands = commands_from_options(options)
1562
self.assertEqual(2, len(commands))
1563
self.assertIsInstance(commands[0], command.Deny)
1564
self.assertIsInstance(commands[1], command.Remove)
1566
def test_deny_before_remove_reversed(self):
1567
options = self.parser.parse_args(["--remove", "--deny",
1569
check_option_syntax(self.parser, options)
1570
commands = commands_from_options(options)
1571
self.assertEqual(2, len(commands))
1572
self.assertIsInstance(commands[0], command.Deny)
1573
self.assertIsInstance(commands[1], command.Remove)
1575
def test_remove_short(self):
1576
self.assert_command_from_args(["-r", "client"],
1579
def test_dump_json(self):
1580
self.assert_command_from_args(["--dump-json"],
988
self.assertEqual(getattr(command, key), value)
989
def test_print_table(self):
990
self.assert_command_from_args([], PrintTableCmd,
993
def test_print_table_verbose(self):
994
self.assert_command_from_args(["--verbose"], PrintTableCmd,
997
def test_print_table_verbose_short(self):
998
self.assert_command_from_args(["-v"], PrintTableCmd,
1583
1001
def test_enable(self):
1584
self.assert_command_from_args(["--enable", "client"],
1002
self.assert_command_from_args(["--enable", "foo"], EnableCmd)
1587
1004
def test_enable_short(self):
1588
self.assert_command_from_args(["-e", "client"],
1005
self.assert_command_from_args(["-e", "foo"], EnableCmd)
1591
1007
def test_disable(self):
1592
self.assert_command_from_args(["--disable", "client"],
1008
self.assert_command_from_args(["--disable", "foo"],
1595
1011
def test_disable_short(self):
1596
self.assert_command_from_args(["-d", "client"],
1012
self.assert_command_from_args(["-d", "foo"], DisableCmd)
1599
1014
def test_bump_timeout(self):
1600
self.assert_command_from_args(["--bump-timeout", "client"],
1601
command.BumpTimeout)
1015
self.assert_command_from_args(["--bump-timeout", "foo"],
1603
1018
def test_bump_timeout_short(self):
1604
self.assert_command_from_args(["-b", "client"],
1605
command.BumpTimeout)
1019
self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
1607
1021
def test_start_checker(self):
1608
self.assert_command_from_args(["--start-checker", "client"],
1609
command.StartChecker)
1022
self.assert_command_from_args(["--start-checker", "foo"],
1611
1025
def test_stop_checker(self):
1612
self.assert_command_from_args(["--stop-checker", "client"],
1613
command.StopChecker)
1615
def test_approve_by_default(self):
1616
self.assert_command_from_args(["--approve-by-default",
1618
command.ApproveByDefault)
1620
def test_deny_by_default(self):
1621
self.assert_command_from_args(["--deny-by-default", "client"],
1622
command.DenyByDefault)
1026
self.assert_command_from_args(["--stop-checker", "foo"],
1029
def test_remove(self):
1030
self.assert_command_from_args(["--remove", "foo"],
1033
def test_remove_short(self):
1034
self.assert_command_from_args(["-r", "foo"], RemoveCmd)
1624
1036
def test_checker(self):
1625
self.assert_command_from_args(["--checker", ":", "client"],
1037
self.assert_command_from_args(["--checker", ":", "foo"],
1038
SetCheckerCmd, value_to_set=":")
1629
1040
def test_checker_empty(self):
1630
self.assert_command_from_args(["--checker", "", "client"],
1041
self.assert_command_from_args(["--checker", "", "foo"],
1042
SetCheckerCmd, value_to_set="")
1634
1044
def test_checker_short(self):
1635
self.assert_command_from_args(["-c", ":", "client"],
1639
def test_host(self):
1640
self.assert_command_from_args(
1641
["--host", "client.example.org", "client"],
1642
command.SetHost, value_to_set="client.example.org")
1644
def test_host_short(self):
1645
self.assert_command_from_args(
1646
["-H", "client.example.org", "client"], command.SetHost,
1647
value_to_set="client.example.org")
1649
def test_secret_devnull(self):
1650
self.assert_command_from_args(["--secret", os.path.devnull,
1651
"client"], command.SetSecret,
1654
def test_secret_tempfile(self):
1655
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1656
value = b"secret\0xyzzy\nbar"
1659
self.assert_command_from_args(["--secret", f.name,
1664
def test_secret_devnull_short(self):
1665
self.assert_command_from_args(["-s", os.path.devnull,
1666
"client"], command.SetSecret,
1669
def test_secret_tempfile_short(self):
1670
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1671
value = b"secret\0xyzzy\nbar"
1674
self.assert_command_from_args(["-s", f.name, "client"],
1045
self.assert_command_from_args(["-c", ":", "foo"],
1046
SetCheckerCmd, value_to_set=":")
1678
1048
def test_timeout(self):
1679
self.assert_command_from_args(["--timeout", "PT5M", "client"],
1049
self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1681
1051
value_to_set=300000)
1683
1053
def test_timeout_short(self):
1684
self.assert_command_from_args(["-t", "PT5M", "client"],
1054
self.assert_command_from_args(["-t", "PT5M", "foo"],
1686
1056
value_to_set=300000)
1688
1058
def test_extended_timeout(self):
1689
1059
self.assert_command_from_args(["--extended-timeout", "PT15M",
1691
command.SetExtendedTimeout,
1061
SetExtendedTimeoutCmd,
1692
1062
value_to_set=900000)
1694
1064
def test_interval(self):
1695
self.assert_command_from_args(["--interval", "PT2M",
1696
"client"], command.SetInterval,
1065
self.assert_command_from_args(["--interval", "PT2M", "foo"],
1697
1067
value_to_set=120000)
1699
1069
def test_interval_short(self):
1700
self.assert_command_from_args(["-i", "PT2M", "client"],
1701
command.SetInterval,
1070
self.assert_command_from_args(["-i", "PT2M", "foo"],
1702
1072
value_to_set=120000)
1074
def test_approve_by_default(self):
1075
self.assert_command_from_args(["--approve-by-default", "foo"],
1076
ApproveByDefaultCmd)
1078
def test_deny_by_default(self):
1079
self.assert_command_from_args(["--deny-by-default", "foo"],
1704
1082
def test_approval_delay(self):
1705
1083
self.assert_command_from_args(["--approval-delay", "PT30S",
1707
command.SetApprovalDelay,
1084
"foo"], SetApprovalDelayCmd,
1708
1085
value_to_set=30000)
1710
1087
def test_approval_duration(self):
1711
1088
self.assert_command_from_args(["--approval-duration", "PT1S",
1713
command.SetApprovalDuration,
1089
"foo"], SetApprovalDurationCmd,
1714
1090
value_to_set=1000)
1716
def test_print_table(self):
1717
self.assert_command_from_args([], command.PrintTable,
1720
def test_print_table_verbose(self):
1721
self.assert_command_from_args(["--verbose"],
1725
def test_print_table_verbose_short(self):
1726
self.assert_command_from_args(["-v"], command.PrintTable,
1730
class TestCommand(unittest.TestCase):
1092
def test_host(self):
1093
self.assert_command_from_args(["--host", "foo.example.org",
1095
value_to_set="foo.example.org")
1097
def test_host_short(self):
1098
self.assert_command_from_args(["-H", "foo.example.org",
1100
value_to_set="foo.example.org")
1102
def test_secret_devnull(self):
1103
self.assert_command_from_args(["--secret", os.path.devnull,
1104
"foo"], SetSecretCmd,
1107
def test_secret_tempfile(self):
1108
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1109
value = b"secret\0xyzzy\nbar"
1112
self.assert_command_from_args(["--secret", f.name,
1113
"foo"], SetSecretCmd,
1116
def test_secret_devnull_short(self):
1117
self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1118
SetSecretCmd, value_to_set=b"")
1120
def test_secret_tempfile_short(self):
1121
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1122
value = b"secret\0xyzzy\nbar"
1125
self.assert_command_from_args(["-s", f.name, "foo"],
1129
def test_approve(self):
1130
self.assert_command_from_args(["--approve", "foo"],
1133
def test_approve_short(self):
1134
self.assert_command_from_args(["-A", "foo"], ApproveCmd)
1136
def test_deny(self):
1137
self.assert_command_from_args(["--deny", "foo"], DenyCmd)
1139
def test_deny_short(self):
1140
self.assert_command_from_args(["-D", "foo"], DenyCmd)
1142
def test_dump_json(self):
1143
self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
1145
def test_is_enabled(self):
1146
self.assert_command_from_args(["--is-enabled", "foo"],
1149
def test_is_enabled_short(self):
1150
self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
1152
def test_deny_before_remove(self):
1153
options = self.parser.parse_args(["--deny", "--remove",
1155
check_option_syntax(self.parser, options)
1156
commands = commands_from_options(options)
1157
self.assertEqual(len(commands), 2)
1158
self.assertIsInstance(commands[0], DenyCmd)
1159
self.assertIsInstance(commands[1], RemoveCmd)
1161
def test_deny_before_remove_reversed(self):
1162
options = self.parser.parse_args(["--remove", "--deny",
1164
check_option_syntax(self.parser, options)
1165
commands = commands_from_options(options)
1166
self.assertEqual(len(commands), 2)
1167
self.assertIsInstance(commands[0], DenyCmd)
1168
self.assertIsInstance(commands[1], RemoveCmd)
1171
class TestCmd(unittest.TestCase):
1731
1172
"""Abstract class for tests of command classes"""
1733
class FakeMandosBus(dbus.MandosBus):
1734
def __init__(self, testcase):
1735
self.client_properties = {
1175
class MockClient(object):
1176
def __init__(self, name, **attributes):
1177
self.__dbus_object_path__ = "/clients/{}".format(name)
1178
self.attributes = attributes
1179
self.attributes["Name"] = name
1181
def Set(self, interface, propname, value, dbus_interface):
1182
testcase.assertEqual(interface, client_dbus_interface)
1183
testcase.assertEqual(dbus_interface,
1184
dbus.PROPERTIES_IFACE)
1185
self.attributes[propname] = value
1186
def Get(self, interface, propname, dbus_interface):
1187
testcase.assertEqual(interface, client_dbus_interface)
1188
testcase.assertEqual(dbus_interface,
1189
dbus.PROPERTIES_IFACE)
1190
return self.attributes[propname]
1191
def Approve(self, approve, dbus_interface):
1192
testcase.assertEqual(dbus_interface,
1193
client_dbus_interface)
1194
self.calls.append(("Approve", (approve,
1196
self.client = MockClient(
1198
KeyID=("92ed150794387c03ce684574b1139a65"
1199
"94a34f895daaaf09fd8ea90a27cddb12"),
1201
Host="foo.example.org",
1202
Enabled=dbus.Boolean(True),
1204
LastCheckedOK="2019-02-03T00:00:00",
1205
Created="2019-01-02T00:00:00",
1207
Fingerprint=("778827225BA7DE539C5A"
1208
"7CFA59CFF7CDBD9A5920"),
1209
CheckerRunning=dbus.Boolean(False),
1210
LastEnabled="2019-01-03T00:00:00",
1211
ApprovalPending=dbus.Boolean(False),
1212
ApprovedByDefault=dbus.Boolean(True),
1213
LastApprovalRequest="",
1215
ApprovalDuration=1000,
1216
Checker="fping -q -- %(host)s",
1217
ExtendedTimeout=900000,
1218
Expires="2019-02-04T00:00:00",
1219
LastCheckerStatus=0)
1220
self.other_client = MockClient(
1222
KeyID=("0558568eedd67d622f5c83b35a115f79"
1223
"6ab612cff5ad227247e46c2b020f441c"),
1224
Secret=b"secretbar",
1226
Enabled=dbus.Boolean(True),
1228
LastCheckedOK="2019-02-04T00:00:00",
1229
Created="2019-01-03T00:00:00",
1231
Fingerprint=("3E393AEAEFB84C7E89E2"
1232
"F547B3A107558FCA3A27"),
1233
CheckerRunning=dbus.Boolean(True),
1234
LastEnabled="2019-01-04T00:00:00",
1235
ApprovalPending=dbus.Boolean(False),
1236
ApprovedByDefault=dbus.Boolean(False),
1237
LastApprovalRequest="2019-01-03T00:00:00",
1238
ApprovalDelay=30000,
1239
ApprovalDuration=1000,
1241
ExtendedTimeout=900000,
1242
Expires="2019-02-05T00:00:00",
1243
LastCheckerStatus=-2)
1244
self.clients = collections.OrderedDict(
1246
("/clients/foo", self.client.attributes),
1247
("/clients/barbar", self.other_client.attributes),
1249
self.one_client = {"/clients/foo": self.client.attributes}
1254
def get_object(client_bus_name, path):
1255
self.assertEqual(client_bus_name, dbus_busname)
1257
"/clients/foo": self.client,
1258
"/clients/barbar": self.other_client,
1263
class TestIsEnabledCmd(TestCmd):
1264
def test_is_enabled(self):
1265
self.assertTrue(all(IsEnabledCmd().is_enabled(client,
1267
for client, properties
1268
in self.clients.items()))
1269
def test_is_enabled_run_exits_successfully(self):
1270
with self.assertRaises(SystemExit) as e:
1271
IsEnabledCmd().run(self.one_client)
1272
if e.exception.code is not None:
1273
self.assertEqual(e.exception.code, 0)
1275
self.assertIsNone(e.exception.code)
1276
def test_is_enabled_run_exits_with_failure(self):
1277
self.client.attributes["Enabled"] = dbus.Boolean(False)
1278
with self.assertRaises(SystemExit) as e:
1279
IsEnabledCmd().run(self.one_client)
1280
if isinstance(e.exception.code, int):
1281
self.assertNotEqual(e.exception.code, 0)
1283
self.assertIsNotNone(e.exception.code)
1286
class TestApproveCmd(TestCmd):
1287
def test_approve(self):
1288
ApproveCmd().run(self.clients, self.bus)
1289
for clientpath in self.clients:
1290
client = self.bus.get_object(dbus_busname, clientpath)
1291
self.assertIn(("Approve", (True, client_dbus_interface)),
1295
class TestDenyCmd(TestCmd):
1296
def test_deny(self):
1297
DenyCmd().run(self.clients, self.bus)
1298
for clientpath in self.clients:
1299
client = self.bus.get_object(dbus_busname, clientpath)
1300
self.assertIn(("Approve", (False, client_dbus_interface)),
1303
class TestRemoveCmd(TestCmd):
1304
def test_remove(self):
1305
class MockMandos(object):
1308
def RemoveClient(self, dbus_path):
1309
self.calls.append(("RemoveClient", (dbus_path,)))
1310
mandos = MockMandos()
1311
super(TestRemoveCmd, self).setUp()
1312
RemoveCmd().run(self.clients, self.bus, mandos)
1313
self.assertEqual(len(mandos.calls), 2)
1314
for clientpath in self.clients:
1315
self.assertIn(("RemoveClient", (clientpath,)),
1319
class TestDumpJSONCmd(TestCmd):
1321
self.expected_json = {
1737
1324
"KeyID": ("92ed150794387c03ce684574b1139a65"
1738
1325
"94a34f895daaaf09fd8ea90a27cddb12"),
1739
"Secret": b"secret",
1740
1326
"Host": "foo.example.org",
1741
1327
"Enabled": True,
1742
1328
"Timeout": 300000,