/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos-ctl

  • Committer: Teddy Hogeborn
  • Date: 2019-03-17 16:48:56 UTC
  • Revision ID: teddy@recompile.se-20190317164856-de11glvsfwhnj34w
mandos-ctl: Refactor tests

* mandos-ctl (Test_string_to_delta.test_handles_basic_rfc3339): Split
                                                  into multiple tests.
  (Test_string_to_delta.test_rfc3339_zero_seconds): New.
  (Test_string_to_delta.test_rfc3339_zero_days): - '' -
  (Test_string_to_delta.test_rfc3339_one_second): - '' -
  (Test_string_to_delta.test_rfc3339_two_hours): - '' -
  (TestCommand.setUp.MockClient.Get): Remove; unused.
  (TestBaseCommands.test_Remove): Remove unnecessary assertion.
  (TestPropertyCmd.runTest): - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
45
45
import io
46
46
import tempfile
47
47
import contextlib
48
 
import abc
49
48
 
50
 
import dbus as dbus_python
 
49
import dbus
51
50
 
52
51
# Show warnings by default
53
52
if not sys.warnoptions:
62
61
 
63
62
if sys.version_info.major == 2:
64
63
    str = unicode
65
 
    import StringIO
66
 
    io.StringIO = StringIO.StringIO
67
64
 
68
65
locale.setlocale(locale.LC_ALL, "")
69
66
 
 
67
dbus_busname_domain = "se.recompile"
 
68
dbus_busname = dbus_busname_domain + ".Mandos"
 
69
server_dbus_path = "/"
 
70
server_dbus_interface = dbus_busname_domain + ".Mandos"
 
71
client_dbus_interface = dbus_busname_domain + ".Mandos.Client"
 
72
del dbus_busname_domain
70
73
version = "1.8.3"
71
74
 
72
75
 
 
76
try:
 
77
    dbus.OBJECT_MANAGER_IFACE
 
78
except AttributeError:
 
79
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
 
80
 
 
81
 
73
82
def main():
74
83
    parser = argparse.ArgumentParser()
 
84
 
75
85
    add_command_line_options(parser)
76
86
 
77
87
    options = parser.parse_args()
 
88
 
78
89
    check_option_syntax(parser, options)
79
90
 
80
91
    clientnames = options.client
82
93
    if options.debug:
83
94
        log.setLevel(logging.DEBUG)
84
95
 
85
 
    bus = dbus_python_adapter.CachingBus(dbus_python)
86
 
 
87
 
    try:
88
 
        all_clients = bus.get_clients_and_properties()
89
 
    except dbus.ConnectFailed as e:
90
 
        log.critical("Could not connect to Mandos server: %s", e)
91
 
        sys.exit(1)
92
 
    except dbus.Error as e:
93
 
        log.critical(
94
 
            "Failed to access Mandos server through D-Bus:\n%s", e)
95
 
        sys.exit(1)
 
96
    bus = dbus.SystemBus()
 
97
 
 
98
    mandos_dbus_object = get_mandos_dbus_object(bus)
 
99
 
 
100
    mandos_serv = dbus.Interface(
 
101
        mandos_dbus_object, dbus_interface=server_dbus_interface)
 
102
    mandos_serv_object_manager = dbus.Interface(
 
103
        mandos_dbus_object, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
 
104
 
 
105
    managed_objects = get_managed_objects(mandos_serv_object_manager)
 
106
 
 
107
    all_clients = {}
 
108
    for path, ifs_and_props in managed_objects.items():
 
109
        try:
 
110
            all_clients[path] = ifs_and_props[client_dbus_interface]
 
111
        except KeyError:
 
112
            pass
96
113
 
97
114
    # Compile dict of (clientpath: properties) to process
98
115
    if not clientnames:
111
128
    commands = commands_from_options(options)
112
129
 
113
130
    for command in commands:
114
 
        command.run(clients, bus)
 
131
        command.run(clients, bus, mandos_serv)
115
132
 
116
133
 
117
134
def add_command_line_options(parser):
407
424
        options.remove = True
408
425
 
409
426
 
410
 
 
411
 
class dbus(object):
412
 
 
413
 
    class SystemBus(object):
414
 
 
415
 
        object_manager_iface = "org.freedesktop.DBus.ObjectManager"
416
 
        def get_managed_objects(self, busname, objectpath):
417
 
            return self.call_method("GetManagedObjects", busname,
418
 
                                    objectpath,
419
 
                                    self.object_manager_iface)
420
 
 
421
 
        properties_iface = "org.freedesktop.DBus.Properties"
422
 
        def set_property(self, busname, objectpath, interface, key,
423
 
                         value):
424
 
            self.call_method("Set", busname, objectpath,
425
 
                             self.properties_iface, interface, key,
426
 
                             value)
427
 
 
428
 
 
429
 
    class MandosBus(SystemBus):
430
 
        busname_domain = "se.recompile"
431
 
        busname = busname_domain + ".Mandos"
432
 
        server_path = "/"
433
 
        server_interface = busname_domain + ".Mandos"
434
 
        client_interface = busname_domain + ".Mandos.Client"
435
 
        del busname_domain
436
 
 
437
 
        def get_clients_and_properties(self):
438
 
            managed_objects = self.get_managed_objects(
439
 
                self.busname, self.server_path)
440
 
            return {objpath: properties[self.client_interface]
441
 
                    for objpath, properties in managed_objects.items()
442
 
                    if self.client_interface in properties}
443
 
 
444
 
        def set_client_property(self, objectpath, key, value):
445
 
            return self.set_property(self.busname, objectpath,
446
 
                                     self.client_interface, key,
447
 
                                     value)
448
 
 
449
 
        def call_client_method(self, objectpath, method, *args):
450
 
            return self.call_method(method, self.busname, objectpath,
451
 
                                    self.client_interface, *args)
452
 
 
453
 
        def call_server_method(self, method, *args):
454
 
            return self.call_method(method, self.busname,
455
 
                                    self.server_path,
456
 
                                    self.server_interface, *args)
457
 
 
458
 
    class Error(Exception):
459
 
        pass
460
 
 
461
 
    class ConnectFailed(Error):
462
 
        pass
463
 
 
464
 
 
465
 
class dbus_python_adapter(object):
466
 
 
467
 
    class SystemBus(dbus.MandosBus):
468
 
        """Use dbus-python"""
469
 
 
470
 
        def __init__(self, module=dbus_python):
471
 
            self.dbus_python = module
472
 
            self.bus = self.dbus_python.SystemBus()
473
 
 
474
 
        @contextlib.contextmanager
475
 
        def convert_exception(self, exception_class=dbus.Error):
476
 
            try:
477
 
                yield
478
 
            except self.dbus_python.exceptions.DBusException as e:
479
 
                # This does what "raise from" would do
480
 
                exc = exception_class(*e.args)
481
 
                exc.__cause__ = e
482
 
                raise exc
483
 
 
484
 
        def call_method(self, methodname, busname, objectpath,
485
 
                        interface, *args):
486
 
            proxy_object = self.get_object(busname, objectpath)
487
 
            log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
488
 
                      interface, methodname,
489
 
                      ", ".join(repr(a) for a in args))
490
 
            method = getattr(proxy_object, methodname)
491
 
            with self.convert_exception():
492
 
                with dbus_python_adapter.SilenceLogger(
493
 
                        "dbus.proxies"):
494
 
                    value = method(*args, dbus_interface=interface)
495
 
            return self.type_filter(value)
496
 
 
497
 
        def get_object(self, busname, objectpath):
498
 
            log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
499
 
                      busname, objectpath)
500
 
            with self.convert_exception(dbus.ConnectFailed):
501
 
                return self.bus.get_object(busname, objectpath)
502
 
 
503
 
        def type_filter(self, value):
504
 
            """Convert the most bothersome types to Python types"""
505
 
            if isinstance(value, self.dbus_python.Boolean):
506
 
                return bool(value)
507
 
            if isinstance(value, self.dbus_python.ObjectPath):
508
 
                return str(value)
509
 
            # Also recurse into dictionaries
510
 
            if isinstance(value, self.dbus_python.Dictionary):
511
 
                return {self.type_filter(key):
512
 
                        self.type_filter(subval)
513
 
                        for key, subval in value.items()}
514
 
            return value
515
 
 
516
 
 
517
 
    class SilenceLogger(object):
518
 
        "Simple context manager to silence a particular logger"
519
 
        def __init__(self, loggername):
520
 
            self.logger = logging.getLogger(loggername)
521
 
 
522
 
        def __enter__(self):
523
 
            self.logger.addFilter(self.nullfilter)
524
 
 
525
 
        class NullFilter(logging.Filter):
526
 
            def filter(self, record):
527
 
                return False
528
 
 
529
 
        nullfilter = NullFilter()
530
 
 
531
 
        def __exit__(self, exc_type, exc_val, exc_tb):
532
 
            self.logger.removeFilter(self.nullfilter)
533
 
 
534
 
 
535
 
    class CachingBus(SystemBus):
536
 
        """A caching layer for dbus_python_adapter.SystemBus"""
537
 
        def __init__(self, *args, **kwargs):
538
 
            self.object_cache = {}
539
 
            super(dbus_python_adapter.CachingBus,
540
 
                  self).__init__(*args, **kwargs)
541
 
        def get_object(self, busname, objectpath):
542
 
            try:
543
 
                return self.object_cache[(busname, objectpath)]
544
 
            except KeyError:
545
 
                new_object = super(
546
 
                    dbus_python_adapter.CachingBus,
547
 
                    self).get_object(busname, objectpath)
548
 
                self.object_cache[(busname, objectpath)]  = new_object
549
 
                return new_object
 
427
def get_mandos_dbus_object(bus):
 
428
    log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
 
429
              dbus_busname, server_dbus_path)
 
430
    with if_dbus_exception_log_with_exception_and_exit(
 
431
            "Could not connect to Mandos server: %s"):
 
432
        mandos_dbus_object = bus.get_object(dbus_busname,
 
433
                                            server_dbus_path)
 
434
    return mandos_dbus_object
 
435
 
 
436
 
 
437
@contextlib.contextmanager
 
438
def if_dbus_exception_log_with_exception_and_exit(*args, **kwargs):
 
439
    try:
 
440
        yield
 
441
    except dbus.exceptions.DBusException as e:
 
442
        log.critical(*(args + (e,)), **kwargs)
 
443
        sys.exit(1)
 
444
 
 
445
 
 
446
def get_managed_objects(object_manager):
 
447
    log.debug("D-Bus: %s:%s:%s.GetManagedObjects()", dbus_busname,
 
448
              server_dbus_path, dbus.OBJECT_MANAGER_IFACE)
 
449
    with if_dbus_exception_log_with_exception_and_exit(
 
450
            "Failed to access Mandos server through D-Bus:\n%s"):
 
451
        with SilenceLogger("dbus.proxies"):
 
452
            managed_objects = object_manager.GetManagedObjects()
 
453
    return managed_objects
 
454
 
 
455
 
 
456
class SilenceLogger(object):
 
457
    "Simple context manager to silence a particular logger"
 
458
    def __init__(self, loggername):
 
459
        self.logger = logging.getLogger(loggername)
 
460
 
 
461
    def __enter__(self):
 
462
        self.logger.addFilter(self.nullfilter)
 
463
        return self
 
464
 
 
465
    class NullFilter(logging.Filter):
 
466
        def filter(self, record):
 
467
            return False
 
468
 
 
469
    nullfilter = NullFilter()
 
470
 
 
471
    def __exit__(self, exc_type, exc_val, exc_tb):
 
472
        self.logger.removeFilter(self.nullfilter)
550
473
 
551
474
 
552
475
def commands_from_options(options):
629
552
 
630
553
    class Base(object):
631
554
        """Abstract base class for commands"""
632
 
        def run(self, clients, bus=None):
 
555
        def run(self, clients, bus=None, mandos=None):
633
556
            """Normal commands should implement run_on_one_client(),
634
557
but commands which want to operate on all clients at the same time can
635
558
override this run() method instead.
636
559
"""
637
 
            self.bus = bus
638
 
            for client, properties in clients.items():
 
560
            self.mandos = mandos
 
561
            for clientpath, properties in clients.items():
 
562
                log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
 
563
                          dbus_busname, str(clientpath))
 
564
                client = bus.get_object(dbus_busname, clientpath)
639
565
                self.run_on_one_client(client, properties)
640
566
 
641
567
 
642
568
    class IsEnabled(Base):
643
 
        def run(self, clients, bus=None):
644
 
            properties = next(iter(clients.values()))
645
 
            if properties["Enabled"]:
 
569
        def run(self, clients, bus=None, mandos=None):
 
570
            client, properties = next(iter(clients.items()))
 
571
            if self.is_enabled(client, properties):
646
572
                sys.exit(0)
647
573
            sys.exit(1)
 
574
        def is_enabled(self, client, properties):
 
575
            return properties["Enabled"]
648
576
 
649
577
 
650
578
    class Approve(Base):
651
579
        def run_on_one_client(self, client, properties):
652
 
            self.bus.call_client_method(client, "Approve", True)
 
580
            log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
 
581
                      client.__dbus_object_path__,
 
582
                      client_dbus_interface)
 
583
            client.Approve(dbus.Boolean(True),
 
584
                           dbus_interface=client_dbus_interface)
653
585
 
654
586
 
655
587
    class Deny(Base):
656
588
        def run_on_one_client(self, client, properties):
657
 
            self.bus.call_client_method(client, "Approve", False)
 
589
            log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
 
590
                      client.__dbus_object_path__,
 
591
                      client_dbus_interface)
 
592
            client.Approve(dbus.Boolean(False),
 
593
                           dbus_interface=client_dbus_interface)
658
594
 
659
595
 
660
596
    class Remove(Base):
661
 
        def run(self, clients, bus):
662
 
            for clientpath in frozenset(clients.keys()):
663
 
                bus.call_server_method("RemoveClient", clientpath)
 
597
        def run_on_one_client(self, client, properties):
 
598
            log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)",
 
599
                      dbus_busname, server_dbus_path,
 
600
                      server_dbus_interface,
 
601
                      str(client.__dbus_object_path__))
 
602
            self.mandos.RemoveClient(client.__dbus_object_path__)
664
603
 
665
604
 
666
605
    class Output(Base):
674
613
                        "Checker", "ExtendedTimeout", "Expires",
675
614
                        "LastCheckerStatus")
676
615
 
 
616
        def run(self, clients, bus=None, mandos=None):
 
617
            print(self.output(clients.values()))
 
618
 
 
619
        def output(self, clients):
 
620
            raise NotImplementedError()
 
621
 
677
622
 
678
623
    class DumpJSON(Output):
679
 
        def run(self, clients, bus=None):
680
 
            data = {properties["Name"]:
681
 
                    {key: properties[key]
 
624
        def output(self, clients):
 
625
            data = {client["Name"]:
 
626
                    {key: self.dbus_boolean_to_bool(client[key])
682
627
                     for key in self.all_keywords}
683
 
                    for properties in clients.values()}
684
 
            print(json.dumps(data, indent=4, separators=(',', ': ')))
 
628
                    for client in clients}
 
629
            return json.dumps(data, indent=4, separators=(',', ': '))
 
630
 
 
631
        @staticmethod
 
632
        def dbus_boolean_to_bool(value):
 
633
            if isinstance(value, dbus.Boolean):
 
634
                value = bool(value)
 
635
            return value
685
636
 
686
637
 
687
638
    class PrintTable(Output):
688
639
        def __init__(self, verbose=False):
689
640
            self.verbose = verbose
690
641
 
691
 
        def run(self, clients, bus=None):
 
642
        def output(self, clients):
692
643
            default_keywords = ("Name", "Enabled", "Timeout",
693
644
                                "LastCheckedOK")
694
645
            keywords = default_keywords
695
646
            if self.verbose:
696
647
                keywords = self.all_keywords
697
 
            print(self.TableOfClients(clients.values(), keywords))
 
648
            return str(self.TableOfClients(clients, keywords))
698
649
 
699
650
        class TableOfClients(object):
700
651
            tableheaders = {
755
706
 
756
707
            @classmethod
757
708
            def valuetostring(cls, value, keyword):
758
 
                if isinstance(value, bool):
 
709
                if isinstance(value, dbus.Boolean):
759
710
                    return "Yes" if value else "No"
760
711
                if keyword in ("Timeout", "Interval", "ApprovalDelay",
761
712
                               "ApprovalDuration", "ExtendedTimeout"):
781
732
                                seconds=td.seconds % 60))
782
733
 
783
734
 
784
 
    class PropertySetter(Base):
 
735
    class Property(Base):
785
736
        "Abstract class for Actions for setting one client property"
786
737
 
787
 
        def run_on_one_client(self, client, properties=None):
 
738
        def run_on_one_client(self, client, properties):
788
739
            """Set the Client's D-Bus property"""
789
 
            self.bus.set_client_property(client, self.propname,
790
 
                                         self.value_to_set)
 
740
            log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
 
741
                      client.__dbus_object_path__,
 
742
                      dbus.PROPERTIES_IFACE, client_dbus_interface,
 
743
                      self.propname, self.value_to_set
 
744
                      if not isinstance(self.value_to_set,
 
745
                                        dbus.Boolean)
 
746
                      else bool(self.value_to_set))
 
747
            client.Set(client_dbus_interface, self.propname,
 
748
                       self.value_to_set,
 
749
                       dbus_interface=dbus.PROPERTIES_IFACE)
791
750
 
792
751
        @property
793
752
        def propname(self):
794
753
            raise NotImplementedError()
795
754
 
796
755
 
797
 
    class Enable(PropertySetter):
798
 
        propname = "Enabled"
799
 
        value_to_set = True
800
 
 
801
 
 
802
 
    class Disable(PropertySetter):
803
 
        propname = "Enabled"
804
 
        value_to_set = False
805
 
 
806
 
 
807
 
    class BumpTimeout(PropertySetter):
 
756
    class Enable(Property):
 
757
        propname = "Enabled"
 
758
        value_to_set = dbus.Boolean(True)
 
759
 
 
760
 
 
761
    class Disable(Property):
 
762
        propname = "Enabled"
 
763
        value_to_set = dbus.Boolean(False)
 
764
 
 
765
 
 
766
    class BumpTimeout(Property):
808
767
        propname = "LastCheckedOK"
809
768
        value_to_set = ""
810
769
 
811
770
 
812
 
    class StartChecker(PropertySetter):
813
 
        propname = "CheckerRunning"
814
 
        value_to_set = True
815
 
 
816
 
 
817
 
    class StopChecker(PropertySetter):
818
 
        propname = "CheckerRunning"
819
 
        value_to_set = False
820
 
 
821
 
 
822
 
    class ApproveByDefault(PropertySetter):
823
 
        propname = "ApprovedByDefault"
824
 
        value_to_set = True
825
 
 
826
 
 
827
 
    class DenyByDefault(PropertySetter):
828
 
        propname = "ApprovedByDefault"
829
 
        value_to_set = False
830
 
 
831
 
 
832
 
    class PropertySetterValue(PropertySetter):
833
 
        """Abstract class for PropertySetter recieving a value as
834
 
constructor argument instead of a class attribute."""
 
771
    class StartChecker(Property):
 
772
        propname = "CheckerRunning"
 
773
        value_to_set = dbus.Boolean(True)
 
774
 
 
775
 
 
776
    class StopChecker(Property):
 
777
        propname = "CheckerRunning"
 
778
        value_to_set = dbus.Boolean(False)
 
779
 
 
780
 
 
781
    class ApproveByDefault(Property):
 
782
        propname = "ApprovedByDefault"
 
783
        value_to_set = dbus.Boolean(True)
 
784
 
 
785
 
 
786
    class DenyByDefault(Property):
 
787
        propname = "ApprovedByDefault"
 
788
        value_to_set = dbus.Boolean(False)
 
789
 
 
790
 
 
791
    class PropertyValue(Property):
 
792
        "Abstract class for Property recieving a value as argument"
835
793
        def __init__(self, value):
836
794
            self.value_to_set = value
837
795
 
838
796
 
839
 
    class SetChecker(PropertySetterValue):
 
797
    class SetChecker(PropertyValue):
840
798
        propname = "Checker"
841
799
 
842
800
 
843
 
    class SetHost(PropertySetterValue):
 
801
    class SetHost(PropertyValue):
844
802
        propname = "Host"
845
803
 
846
804
 
847
 
    class SetSecret(PropertySetterValue):
 
805
    class SetSecret(PropertyValue):
848
806
        propname = "Secret"
849
807
 
850
808
        @property
858
816
            value.close()
859
817
 
860
818
 
861
 
    class PropertySetterValueMilliseconds(PropertySetterValue):
862
 
        """Abstract class for PropertySetterValue taking a value
863
 
argument as a datetime.timedelta() but should store it as
864
 
milliseconds."""
 
819
    class MillisecondsPropertyValueArgument(PropertyValue):
 
820
        """Abstract class for PropertyValue taking a value argument as
 
821
a datetime.timedelta() but should store it as milliseconds."""
865
822
 
866
823
        @property
867
824
        def value_to_set(self):
873
830
            self._vts = int(round(value.total_seconds() * 1000))
874
831
 
875
832
 
876
 
    class SetTimeout(PropertySetterValueMilliseconds):
 
833
    class SetTimeout(MillisecondsPropertyValueArgument):
877
834
        propname = "Timeout"
878
835
 
879
836
 
880
 
    class SetExtendedTimeout(PropertySetterValueMilliseconds):
 
837
    class SetExtendedTimeout(MillisecondsPropertyValueArgument):
881
838
        propname = "ExtendedTimeout"
882
839
 
883
840
 
884
 
    class SetInterval(PropertySetterValueMilliseconds):
 
841
    class SetInterval(MillisecondsPropertyValueArgument):
885
842
        propname = "Interval"
886
843
 
887
844
 
888
 
    class SetApprovalDelay(PropertySetterValueMilliseconds):
 
845
    class SetApprovalDelay(MillisecondsPropertyValueArgument):
889
846
        propname = "ApprovalDelay"
890
847
 
891
848
 
892
 
    class SetApprovalDuration(PropertySetterValueMilliseconds):
 
849
    class SetApprovalDuration(MillisecondsPropertyValueArgument):
893
850
        propname = "ApprovalDuration"
894
851
 
895
852
 
928
885
                                                     "output"))
929
886
 
930
887
 
931
 
class Unique(object):
932
 
    """Class for objects which exist only to be unique objects, since
933
 
unittest.mock.sentinel only exists in Python 3.3"""
934
 
 
935
 
 
936
888
class Test_string_to_delta(TestCaseWithAssertLogs):
937
889
    # Just test basic RFC 3339 functionality here, the doc string for
938
890
    # rfc3339_duration_to_delta() already has more comprehensive
939
891
    # tests, which is run by doctest.
940
892
 
941
893
    def test_rfc3339_zero_seconds(self):
942
 
        self.assertEqual(datetime.timedelta(),
943
 
                         string_to_delta("PT0S"))
 
894
        self.assertEqual(string_to_delta("PT0S"),
 
895
                         datetime.timedelta())
944
896
 
945
897
    def test_rfc3339_zero_days(self):
946
 
        self.assertEqual(datetime.timedelta(), string_to_delta("P0D"))
 
898
        self.assertEqual(string_to_delta("P0D"),
 
899
                         datetime.timedelta())
947
900
 
948
901
    def test_rfc3339_one_second(self):
949
 
        self.assertEqual(datetime.timedelta(0, 1),
950
 
                         string_to_delta("PT1S"))
 
902
        self.assertEqual(string_to_delta("PT1S"),
 
903
                         datetime.timedelta(0, 1))
951
904
 
952
905
    def test_rfc3339_two_hours(self):
953
 
        self.assertEqual(datetime.timedelta(0, 7200),
954
 
                         string_to_delta("PT2H"))
 
906
        self.assertEqual(string_to_delta("PT2H"),
 
907
                         datetime.timedelta(0, 7200))
955
908
 
956
909
    def test_falls_back_to_pre_1_6_1_with_warning(self):
957
910
        with self.assertLogs(log, logging.WARNING):
958
911
            value = string_to_delta("2h")
959
 
        self.assertEqual(datetime.timedelta(0, 7200), value)
 
912
        self.assertEqual(value, datetime.timedelta(0, 7200))
960
913
 
961
914
 
962
915
class Test_check_option_syntax(unittest.TestCase):
1005
958
        # Exit code from argparse is guaranteed to be "2".  Reference:
1006
959
        # https://docs.python.org/3/library
1007
960
        # /argparse.html#exiting-methods
1008
 
        self.assertEqual(2, e.exception.code)
 
961
        self.assertEqual(e.exception.code, 2)
1009
962
 
1010
963
    @staticmethod
1011
964
    @contextlib.contextmanager
1012
965
    def redirect_stderr_to_devnull():
1013
 
        old_stderr = sys.stderr
1014
 
        with contextlib.closing(open(os.devnull, "w")) as null:
1015
 
            sys.stderr = null
1016
 
            try:
1017
 
                yield
1018
 
            finally:
1019
 
                sys.stderr = old_stderr
 
966
        null = os.open(os.path.devnull, os.O_RDWR)
 
967
        stderrcopy = os.dup(sys.stderr.fileno())
 
968
        os.dup2(null, sys.stderr.fileno())
 
969
        os.close(null)
 
970
        try:
 
971
            yield
 
972
        finally:
 
973
            # restore stderr
 
974
            os.dup2(stderrcopy, sys.stderr.fileno())
 
975
            os.close(stderrcopy)
1020
976
 
1021
977
    def check_option_syntax(self, options):
1022
978
        check_option_syntax(self.parser, options)
1035
991
            options = self.parser.parse_args()
1036
992
            setattr(options, action, value)
1037
993
            options.verbose = True
1038
 
            options.client = ["client"]
 
994
            options.client = ["foo"]
1039
995
            with self.assertParseError():
1040
996
                self.check_option_syntax(options)
1041
997
 
1071
1027
        for action, value in self.actions.items():
1072
1028
            options = self.parser.parse_args()
1073
1029
            setattr(options, action, value)
1074
 
            options.client = ["client"]
 
1030
            options.client = ["foo"]
1075
1031
            self.check_option_syntax(options)
1076
1032
 
1077
1033
    def test_one_client_with_all_actions_except_is_enabled(self):
1080
1036
            if action == "is_enabled":
1081
1037
                continue
1082
1038
            setattr(options, action, value)
1083
 
        options.client = ["client"]
 
1039
        options.client = ["foo"]
1084
1040
        self.check_option_syntax(options)
1085
1041
 
1086
1042
    def test_two_clients_with_all_actions_except_is_enabled(self):
1089
1045
            if action == "is_enabled":
1090
1046
                continue
1091
1047
            setattr(options, action, value)
1092
 
        options.client = ["client1", "client2"]
 
1048
        options.client = ["foo", "barbar"]
1093
1049
        self.check_option_syntax(options)
1094
1050
 
1095
1051
    def test_two_clients_are_ok_with_actions_except_is_enabled(self):
1098
1054
                continue
1099
1055
            options = self.parser.parse_args()
1100
1056
            setattr(options, action, value)
1101
 
            options.client = ["client1", "client2"]
 
1057
            options.client = ["foo", "barbar"]
1102
1058
            self.check_option_syntax(options)
1103
1059
 
1104
1060
    def test_is_enabled_fails_without_client(self):
1110
1066
    def test_is_enabled_fails_with_two_clients(self):
1111
1067
        options = self.parser.parse_args()
1112
1068
        options.is_enabled = True
1113
 
        options.client = ["client1", "client2"]
 
1069
        options.client = ["foo", "barbar"]
1114
1070
        with self.assertParseError():
1115
1071
            self.check_option_syntax(options)
1116
1072
 
1126
1082
                self.check_option_syntax(options)
1127
1083
 
1128
1084
 
1129
 
class Test_dbus_exceptions(unittest.TestCase):
1130
 
 
1131
 
    def test_dbus_ConnectFailed_is_Error(self):
1132
 
        with self.assertRaises(dbus.Error):
1133
 
            raise dbus.ConnectFailed()
1134
 
 
1135
 
 
1136
 
class Test_dbus_MandosBus(unittest.TestCase):
1137
 
 
1138
 
    class MockMandosBus(dbus.MandosBus):
1139
 
        def __init__(self):
1140
 
            self._name = "se.recompile.Mandos"
1141
 
            self._server_path = "/"
1142
 
            self._server_interface = "se.recompile.Mandos"
1143
 
            self._client_interface = "se.recompile.Mandos.Client"
1144
 
            self.calls = []
1145
 
            self.call_method_return = Unique()
1146
 
 
1147
 
        def call_method(self, methodname, busname, objectpath,
1148
 
                        interface, *args):
1149
 
            self.calls.append((methodname, busname, objectpath,
1150
 
                               interface, args))
1151
 
            return self.call_method_return
1152
 
 
1153
 
    def setUp(self):
1154
 
        self.bus = self.MockMandosBus()
1155
 
 
1156
 
    def test_set_client_property(self):
1157
 
        self.bus.set_client_property("objectpath", "key", "value")
1158
 
        expected_call = ("Set", self.bus._name, "objectpath",
1159
 
                         "org.freedesktop.DBus.Properties",
1160
 
                         (self.bus._client_interface, "key", "value"))
1161
 
        self.assertIn(expected_call, self.bus.calls)
1162
 
 
1163
 
    def test_call_client_method(self):
1164
 
        ret = self.bus.call_client_method("objectpath", "methodname")
1165
 
        self.assertIs(self.bus.call_method_return, ret)
1166
 
        expected_call = ("methodname", self.bus._name, "objectpath",
1167
 
                         self.bus._client_interface, ())
1168
 
        self.assertIn(expected_call, self.bus.calls)
1169
 
 
1170
 
    def test_call_client_method_with_args(self):
1171
 
        args = (Unique(), Unique())
1172
 
        ret = self.bus.call_client_method("objectpath", "methodname",
1173
 
                                          *args)
1174
 
        self.assertIs(self.bus.call_method_return, ret)
1175
 
        expected_call = ("methodname", self.bus._name, "objectpath",
1176
 
                         self.bus._client_interface,
1177
 
                         (args[0], args[1]))
1178
 
        self.assertIn(expected_call, self.bus.calls)
1179
 
 
1180
 
    def test_get_clients_and_properties(self):
1181
 
        managed_objects = {
1182
 
            "objectpath": {
1183
 
                self.bus._client_interface: {
1184
 
                    "key": "value",
1185
 
                    "bool": True,
1186
 
                },
1187
 
                "irrelevant_interface": {
1188
 
                    "key": "othervalue",
1189
 
                    "bool": False,
1190
 
                },
1191
 
            },
1192
 
            "other_objectpath": {
1193
 
                "other_irrelevant_interface": {
1194
 
                    "key": "value 3",
1195
 
                    "bool": None,
1196
 
                },
1197
 
            },
1198
 
        }
1199
 
        expected_clients_and_properties = {
1200
 
            "objectpath": {
1201
 
                "key": "value",
1202
 
                "bool": True,
1203
 
            }
1204
 
        }
1205
 
        self.bus.call_method_return = managed_objects
1206
 
        ret = self.bus.get_clients_and_properties()
1207
 
        self.assertDictEqual(expected_clients_and_properties, ret)
1208
 
        expected_call = ("GetManagedObjects", self.bus._name,
1209
 
                         self.bus._server_path,
1210
 
                         "org.freedesktop.DBus.ObjectManager", ())
1211
 
        self.assertIn(expected_call, self.bus.calls)
1212
 
 
1213
 
    def test_call_server_method(self):
1214
 
        ret = self.bus.call_server_method("methodname")
1215
 
        self.assertIs(self.bus.call_method_return, ret)
1216
 
        expected_call = ("methodname", self.bus._name,
1217
 
                         self.bus._server_path,
1218
 
                         self.bus._server_interface, ())
1219
 
        self.assertIn(expected_call, self.bus.calls)
1220
 
 
1221
 
    def test_call_server_method_with_args(self):
1222
 
        args = (Unique(), Unique())
1223
 
        ret = self.bus.call_server_method("methodname", *args)
1224
 
        self.assertIs(self.bus.call_method_return, ret)
1225
 
        expected_call = ("methodname", self.bus._name,
1226
 
                         self.bus._server_path,
1227
 
                         self.bus._server_interface,
1228
 
                         (args[0], args[1]))
1229
 
        self.assertIn(expected_call, self.bus.calls)
1230
 
 
1231
 
 
1232
 
class Test_dbus_python_adapter_SystemBus(TestCaseWithAssertLogs):
1233
 
 
1234
 
    def MockDBusPython_func(self, func):
1235
 
        class mock_dbus_python(object):
1236
 
            """mock dbus-python module"""
1237
 
            class exceptions(object):
1238
 
                """Pseudo-namespace"""
1239
 
                class DBusException(Exception):
1240
 
                    pass
1241
 
            class SystemBus(object):
1242
 
                @staticmethod
1243
 
                def get_object(busname, objectpath):
1244
 
                    DBusObject = collections.namedtuple(
1245
 
                        "DBusObject", ("methodname",))
1246
 
                    def method(*args, **kwargs):
1247
 
                        self.assertEqual({"dbus_interface":
1248
 
                                          "interface"},
1249
 
                                         kwargs)
1250
 
                        return func(*args)
1251
 
                    return DBusObject(methodname=method)
1252
 
            class Boolean(object):
1253
 
                def __init__(self, value):
1254
 
                    self.value = bool(value)
1255
 
                def __bool__(self):
1256
 
                    return self.value
1257
 
                if sys.version_info.major == 2:
1258
 
                    __nonzero__ = __bool__
1259
 
            class ObjectPath(str):
1260
 
                pass
1261
 
            class Dictionary(dict):
1262
 
                pass
1263
 
        return mock_dbus_python
1264
 
 
1265
 
    def call_method(self, bus, methodname, busname, objectpath,
1266
 
                    interface, *args):
1267
 
        with self.assertLogs(log, logging.DEBUG):
1268
 
            return bus.call_method(methodname, busname, objectpath,
1269
 
                                   interface, *args)
1270
 
 
1271
 
    def test_call_method_returns(self):
1272
 
        expected_method_return = Unique()
1273
 
        method_args = (Unique(), Unique())
1274
 
        def func(*args):
1275
 
            self.assertEqual(len(method_args), len(args))
1276
 
            for marg, arg in zip(method_args, args):
1277
 
                self.assertIs(marg, arg)
1278
 
            return expected_method_return
1279
 
        mock_dbus_python = self.MockDBusPython_func(func)
1280
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1281
 
        ret = self.call_method(bus, "methodname", "busname",
1282
 
                               "objectpath", "interface",
1283
 
                               *method_args)
1284
 
        self.assertIs(ret, expected_method_return)
1285
 
 
1286
 
    def test_call_method_filters_bool_true(self):
1287
 
        def func():
1288
 
            return method_return
1289
 
        mock_dbus_python = self.MockDBusPython_func(func)
1290
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1291
 
        method_return = mock_dbus_python.Boolean(True)
1292
 
        ret = self.call_method(bus, "methodname", "busname",
1293
 
                               "objectpath", "interface")
1294
 
        self.assertTrue(ret)
1295
 
        self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1296
 
 
1297
 
    def test_call_method_filters_bool_false(self):
1298
 
        def func():
1299
 
            return method_return
1300
 
        mock_dbus_python = self.MockDBusPython_func(func)
1301
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1302
 
        method_return = mock_dbus_python.Boolean(False)
1303
 
        ret = self.call_method(bus, "methodname", "busname",
1304
 
                               "objectpath", "interface")
1305
 
        self.assertFalse(ret)
1306
 
        self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1307
 
 
1308
 
    def test_call_method_filters_objectpath(self):
1309
 
        def func():
1310
 
            return method_return
1311
 
        mock_dbus_python = self.MockDBusPython_func(func)
1312
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1313
 
        method_return = mock_dbus_python.ObjectPath("objectpath")
1314
 
        ret = self.call_method(bus, "methodname", "busname",
1315
 
                               "objectpath", "interface")
1316
 
        self.assertEqual("objectpath", ret)
1317
 
        self.assertIsNot("objectpath", ret)
1318
 
        self.assertNotIsInstance(ret, mock_dbus_python.ObjectPath)
1319
 
 
1320
 
    def test_call_method_filters_booleans_in_dict(self):
1321
 
        def func():
1322
 
            return method_return
1323
 
        mock_dbus_python = self.MockDBusPython_func(func)
1324
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1325
 
        method_return = mock_dbus_python.Dictionary(
1326
 
        {mock_dbus_python.Boolean(True):
1327
 
         mock_dbus_python.Boolean(False),
1328
 
         mock_dbus_python.Boolean(False):
1329
 
         mock_dbus_python.Boolean(True)})
1330
 
        ret = self.call_method(bus, "methodname", "busname",
1331
 
                               "objectpath", "interface")
1332
 
        expected_method_return = {True: False,
1333
 
                                  False: True}
1334
 
        self.assertEqual(expected_method_return, ret)
1335
 
        self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1336
 
 
1337
 
    def test_call_method_filters_objectpaths_in_dict(self):
1338
 
        def func():
1339
 
            return method_return
1340
 
        mock_dbus_python = self.MockDBusPython_func(func)
1341
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1342
 
        method_return = mock_dbus_python.Dictionary(
1343
 
        {mock_dbus_python.ObjectPath("objectpath_key_1"):
1344
 
         mock_dbus_python.ObjectPath("objectpath_value_1"),
1345
 
         mock_dbus_python.ObjectPath("objectpath_key_2"):
1346
 
         mock_dbus_python.ObjectPath("objectpath_value_2")})
1347
 
        ret = self.call_method(bus, "methodname", "busname",
1348
 
                               "objectpath", "interface")
1349
 
        expected_method_return = {str(key): str(value)
1350
 
                                  for key, value in
1351
 
                                  method_return.items()}
1352
 
        self.assertEqual(expected_method_return, ret)
1353
 
        self.assertIsInstance(ret, dict)
1354
 
        self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1355
 
 
1356
 
    def test_call_method_filters_dict_in_dict(self):
1357
 
        def func():
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.Dictionary(
1362
 
        {"key1": mock_dbus_python.Dictionary({"key11": "value11",
1363
 
                                              "key12": "value12"}),
1364
 
         "key2": mock_dbus_python.Dictionary({"key21": "value21",
1365
 
                                              "key22": "value22"})})
1366
 
        ret = self.call_method(bus, "methodname", "busname",
1367
 
                               "objectpath", "interface")
1368
 
        expected_method_return = {
1369
 
            "key1": {"key11": "value11",
1370
 
                     "key12": "value12"},
1371
 
            "key2": {"key21": "value21",
1372
 
                     "key22": "value22"},
1373
 
        }
1374
 
        self.assertEqual(expected_method_return, ret)
1375
 
        self.assertIsInstance(ret, dict)
1376
 
        self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1377
 
        for key, value in ret.items():
1378
 
            self.assertIsInstance(value, dict)
1379
 
            self.assertEqual(expected_method_return[key], value)
1380
 
            self.assertNotIsInstance(value,
1381
 
                                     mock_dbus_python.Dictionary)
1382
 
 
1383
 
    def test_call_method_filters_dict_three_deep(self):
1384
 
        def func():
1385
 
            return method_return
1386
 
        mock_dbus_python = self.MockDBusPython_func(func)
1387
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1388
 
        method_return = mock_dbus_python.Dictionary(
1389
 
            {"key1":
1390
 
             mock_dbus_python.Dictionary(
1391
 
                 {"key2":
1392
 
                  mock_dbus_python.Dictionary(
1393
 
                      {"key3":
1394
 
                       mock_dbus_python.Boolean(True),
1395
 
                       }),
1396
 
                  }),
1397
 
             })
1398
 
        ret = self.call_method(bus, "methodname", "busname",
1399
 
                               "objectpath", "interface")
1400
 
        expected_method_return = {"key1": {"key2": {"key3": True}}}
1401
 
        self.assertEqual(expected_method_return, ret)
1402
 
        self.assertIsInstance(ret, dict)
1403
 
        self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1404
 
        self.assertIsInstance(ret["key1"], dict)
1405
 
        self.assertNotIsInstance(ret["key1"],
1406
 
                                 mock_dbus_python.Dictionary)
1407
 
        self.assertIsInstance(ret["key1"]["key2"], dict)
1408
 
        self.assertNotIsInstance(ret["key1"]["key2"],
1409
 
                                 mock_dbus_python.Dictionary)
1410
 
        self.assertTrue(ret["key1"]["key2"]["key3"])
1411
 
        self.assertNotIsInstance(ret["key1"]["key2"]["key3"],
1412
 
                                 mock_dbus_python.Boolean)
1413
 
 
1414
 
    def test_call_method_handles_exception(self):
 
1085
class Test_get_mandos_dbus_object(TestCaseWithAssertLogs):
 
1086
    def test_calls_and_returns_get_object_on_bus(self):
 
1087
        class MockBus(object):
 
1088
            called = False
 
1089
            def get_object(mockbus_self, busname, dbus_path):
 
1090
                # Note that "self" is still the testcase instance,
 
1091
                # this MockBus instance is in "mockbus_self".
 
1092
                self.assertEqual(busname, dbus_busname)
 
1093
                self.assertEqual(dbus_path, server_dbus_path)
 
1094
                mockbus_self.called = True
 
1095
                return mockbus_self
 
1096
 
 
1097
        mockbus = get_mandos_dbus_object(bus=MockBus())
 
1098
        self.assertIsInstance(mockbus, MockBus)
 
1099
        self.assertTrue(mockbus.called)
 
1100
 
 
1101
    def test_logs_and_exits_on_dbus_error(self):
 
1102
        class MockBusFailing(object):
 
1103
            def get_object(self, busname, dbus_path):
 
1104
                raise dbus.exceptions.DBusException("Test")
 
1105
 
 
1106
        with self.assertLogs(log, logging.CRITICAL):
 
1107
            with self.assertRaises(SystemExit) as e:
 
1108
                bus = get_mandos_dbus_object(bus=MockBusFailing())
 
1109
 
 
1110
        if isinstance(e.exception.code, int):
 
1111
            self.assertNotEqual(e.exception.code, 0)
 
1112
        else:
 
1113
            self.assertIsNotNone(e.exception.code)
 
1114
 
 
1115
 
 
1116
class Test_get_managed_objects(TestCaseWithAssertLogs):
 
1117
    def test_calls_and_returns_GetManagedObjects(self):
 
1118
        managed_objects = {"/clients/foo": { "Name": "foo"}}
 
1119
        class MockObjectManager(object):
 
1120
            def GetManagedObjects(self):
 
1121
                return managed_objects
 
1122
        retval = get_managed_objects(MockObjectManager())
 
1123
        self.assertDictEqual(managed_objects, retval)
 
1124
 
 
1125
    def test_logs_and_exits_on_dbus_error(self):
1415
1126
        dbus_logger = logging.getLogger("dbus.proxies")
1416
1127
 
1417
 
        def func():
1418
 
            dbus_logger.error("Test")
1419
 
            raise mock_dbus_python.exceptions.DBusException()
1420
 
 
1421
 
        mock_dbus_python = self.MockDBusPython_func(func)
1422
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
 
1128
        class MockObjectManagerFailing(object):
 
1129
            def GetManagedObjects(self):
 
1130
                dbus_logger.error("Test")
 
1131
                raise dbus.exceptions.DBusException("Test")
1423
1132
 
1424
1133
        class CountingHandler(logging.Handler):
1425
1134
            count = 0
1431
1140
        dbus_logger.addHandler(counting_handler)
1432
1141
 
1433
1142
        try:
1434
 
            with self.assertRaises(dbus.Error) as e:
1435
 
                self.call_method(bus, "methodname", "busname",
1436
 
                                 "objectpath", "interface")
 
1143
            with self.assertLogs(log, logging.CRITICAL) as watcher:
 
1144
                with self.assertRaises(SystemExit) as e:
 
1145
                    get_managed_objects(MockObjectManagerFailing())
1437
1146
        finally:
1438
1147
            dbus_logger.removeFilter(counting_handler)
1439
1148
 
1440
 
        self.assertNotIsInstance(e, dbus.ConnectFailed)
1441
 
 
1442
1149
        # Make sure the dbus logger was suppressed
1443
 
        self.assertEqual(0, counting_handler.count)
1444
 
 
1445
 
    def test_get_object_converts_to_correct_exception(self):
1446
 
        bus = dbus_python_adapter.SystemBus(
1447
 
            self.fake_dbus_python_raises_exception_on_connect)
1448
 
        with self.assertRaises(dbus.ConnectFailed):
1449
 
            self.call_method(bus, "methodname", "busname",
1450
 
                             "objectpath", "interface")
1451
 
 
1452
 
    class fake_dbus_python_raises_exception_on_connect(object):
1453
 
        """fake dbus-python module"""
1454
 
        class exceptions(object):
1455
 
            """Pseudo-namespace"""
1456
 
            class DBusException(Exception):
1457
 
                pass
1458
 
 
1459
 
        @classmethod
1460
 
        def SystemBus(cls):
1461
 
            def get_object(busname, objectpath):
1462
 
                raise cls.exceptions.DBusException()
1463
 
            Bus = collections.namedtuple("Bus", ["get_object"])
1464
 
            return Bus(get_object=get_object)
1465
 
 
1466
 
 
1467
 
class Test_dbus_python_adapter_CachingBus(unittest.TestCase):
1468
 
    class mock_dbus_python(object):
1469
 
        """mock dbus-python modules"""
1470
 
        class SystemBus(object):
1471
 
            @staticmethod
1472
 
            def get_object(busname, objectpath):
1473
 
                return Unique()
1474
 
 
1475
 
    def setUp(self):
1476
 
        self.bus = dbus_python_adapter.CachingBus(
1477
 
            self.mock_dbus_python)
1478
 
 
1479
 
    def test_returns_distinct_objectpaths(self):
1480
 
        obj1 = self.bus.get_object("busname", "objectpath1")
1481
 
        self.assertIsInstance(obj1, Unique)
1482
 
        obj2 = self.bus.get_object("busname", "objectpath2")
1483
 
        self.assertIsInstance(obj2, Unique)
1484
 
        self.assertIsNot(obj1, obj2)
1485
 
 
1486
 
    def test_returns_distinct_busnames(self):
1487
 
        obj1 = self.bus.get_object("busname1", "objectpath")
1488
 
        self.assertIsInstance(obj1, Unique)
1489
 
        obj2 = self.bus.get_object("busname2", "objectpath")
1490
 
        self.assertIsInstance(obj2, Unique)
1491
 
        self.assertIsNot(obj1, obj2)
1492
 
 
1493
 
    def test_returns_distinct_both(self):
1494
 
        obj1 = self.bus.get_object("busname1", "objectpath")
1495
 
        self.assertIsInstance(obj1, Unique)
1496
 
        obj2 = self.bus.get_object("busname2", "objectpath")
1497
 
        self.assertIsInstance(obj2, Unique)
1498
 
        self.assertIsNot(obj1, obj2)
1499
 
 
1500
 
    def test_returns_same(self):
1501
 
        obj1 = self.bus.get_object("busname", "objectpath")
1502
 
        self.assertIsInstance(obj1, Unique)
1503
 
        obj2 = self.bus.get_object("busname", "objectpath")
1504
 
        self.assertIsInstance(obj2, Unique)
1505
 
        self.assertIs(obj1, obj2)
1506
 
 
1507
 
    def test_returns_same_old(self):
1508
 
        obj1 = self.bus.get_object("busname1", "objectpath1")
1509
 
        self.assertIsInstance(obj1, Unique)
1510
 
        obj2 = self.bus.get_object("busname2", "objectpath2")
1511
 
        self.assertIsInstance(obj2, Unique)
1512
 
        obj1b = self.bus.get_object("busname1", "objectpath1")
1513
 
        self.assertIsInstance(obj1b, Unique)
1514
 
        self.assertIsNot(obj1, obj2)
1515
 
        self.assertIsNot(obj2, obj1b)
1516
 
        self.assertIs(obj1, obj1b)
 
1150
        self.assertEqual(counting_handler.count, 0)
 
1151
 
 
1152
        # Test that the dbus_logger still works
 
1153
        with self.assertLogs(dbus_logger, logging.ERROR):
 
1154
            dbus_logger.error("Test")
 
1155
 
 
1156
        if isinstance(e.exception.code, int):
 
1157
            self.assertNotEqual(e.exception.code, 0)
 
1158
        else:
 
1159
            self.assertIsNotNone(e.exception.code)
1517
1160
 
1518
1161
 
1519
1162
class Test_commands_from_options(unittest.TestCase):
1520
 
 
1521
1163
    def setUp(self):
1522
1164
        self.parser = argparse.ArgumentParser()
1523
1165
        add_command_line_options(self.parser)
1524
1166
 
1525
1167
    def test_is_enabled(self):
1526
 
        self.assert_command_from_args(["--is-enabled", "client"],
 
1168
        self.assert_command_from_args(["--is-enabled", "foo"],
1527
1169
                                      command.IsEnabled)
1528
1170
 
1529
1171
    def assert_command_from_args(self, args, command_cls,
1533
1175
        options = self.parser.parse_args(args)
1534
1176
        check_option_syntax(self.parser, options)
1535
1177
        commands = commands_from_options(options)
1536
 
        self.assertEqual(1, len(commands))
 
1178
        self.assertEqual(len(commands), 1)
1537
1179
        command = commands[0]
1538
1180
        self.assertIsInstance(command, command_cls)
1539
1181
        for key, value in cmd_attrs.items():
1540
 
            self.assertEqual(value, getattr(command, key))
 
1182
            self.assertEqual(getattr(command, key), value)
1541
1183
 
1542
1184
    def test_is_enabled_short(self):
1543
 
        self.assert_command_from_args(["-V", "client"],
 
1185
        self.assert_command_from_args(["-V", "foo"],
1544
1186
                                      command.IsEnabled)
1545
1187
 
1546
1188
    def test_approve(self):
1547
 
        self.assert_command_from_args(["--approve", "client"],
 
1189
        self.assert_command_from_args(["--approve", "foo"],
1548
1190
                                      command.Approve)
1549
1191
 
1550
1192
    def test_approve_short(self):
1551
 
        self.assert_command_from_args(["-A", "client"],
1552
 
                                      command.Approve)
 
1193
        self.assert_command_from_args(["-A", "foo"], command.Approve)
1553
1194
 
1554
1195
    def test_deny(self):
1555
 
        self.assert_command_from_args(["--deny", "client"],
1556
 
                                      command.Deny)
 
1196
        self.assert_command_from_args(["--deny", "foo"], command.Deny)
1557
1197
 
1558
1198
    def test_deny_short(self):
1559
 
        self.assert_command_from_args(["-D", "client"], command.Deny)
 
1199
        self.assert_command_from_args(["-D", "foo"], command.Deny)
1560
1200
 
1561
1201
    def test_remove(self):
1562
 
        self.assert_command_from_args(["--remove", "client"],
 
1202
        self.assert_command_from_args(["--remove", "foo"],
1563
1203
                                      command.Remove)
1564
1204
 
1565
1205
    def test_deny_before_remove(self):
1566
1206
        options = self.parser.parse_args(["--deny", "--remove",
1567
 
                                          "client"])
 
1207
                                          "foo"])
1568
1208
        check_option_syntax(self.parser, options)
1569
1209
        commands = commands_from_options(options)
1570
 
        self.assertEqual(2, len(commands))
 
1210
        self.assertEqual(len(commands), 2)
1571
1211
        self.assertIsInstance(commands[0], command.Deny)
1572
1212
        self.assertIsInstance(commands[1], command.Remove)
1573
1213
 
1576
1216
                                          "--all"])
1577
1217
        check_option_syntax(self.parser, options)
1578
1218
        commands = commands_from_options(options)
1579
 
        self.assertEqual(2, len(commands))
 
1219
        self.assertEqual(len(commands), 2)
1580
1220
        self.assertIsInstance(commands[0], command.Deny)
1581
1221
        self.assertIsInstance(commands[1], command.Remove)
1582
1222
 
1583
1223
    def test_remove_short(self):
1584
 
        self.assert_command_from_args(["-r", "client"],
1585
 
                                      command.Remove)
 
1224
        self.assert_command_from_args(["-r", "foo"], command.Remove)
1586
1225
 
1587
1226
    def test_dump_json(self):
1588
1227
        self.assert_command_from_args(["--dump-json"],
1589
1228
                                      command.DumpJSON)
1590
1229
 
1591
1230
    def test_enable(self):
1592
 
        self.assert_command_from_args(["--enable", "client"],
 
1231
        self.assert_command_from_args(["--enable", "foo"],
1593
1232
                                      command.Enable)
1594
1233
 
1595
1234
    def test_enable_short(self):
1596
 
        self.assert_command_from_args(["-e", "client"],
1597
 
                                      command.Enable)
 
1235
        self.assert_command_from_args(["-e", "foo"], command.Enable)
1598
1236
 
1599
1237
    def test_disable(self):
1600
 
        self.assert_command_from_args(["--disable", "client"],
 
1238
        self.assert_command_from_args(["--disable", "foo"],
1601
1239
                                      command.Disable)
1602
1240
 
1603
1241
    def test_disable_short(self):
1604
 
        self.assert_command_from_args(["-d", "client"],
1605
 
                                      command.Disable)
 
1242
        self.assert_command_from_args(["-d", "foo"], command.Disable)
1606
1243
 
1607
1244
    def test_bump_timeout(self):
1608
 
        self.assert_command_from_args(["--bump-timeout", "client"],
 
1245
        self.assert_command_from_args(["--bump-timeout", "foo"],
1609
1246
                                      command.BumpTimeout)
1610
1247
 
1611
1248
    def test_bump_timeout_short(self):
1612
 
        self.assert_command_from_args(["-b", "client"],
 
1249
        self.assert_command_from_args(["-b", "foo"],
1613
1250
                                      command.BumpTimeout)
1614
1251
 
1615
1252
    def test_start_checker(self):
1616
 
        self.assert_command_from_args(["--start-checker", "client"],
 
1253
        self.assert_command_from_args(["--start-checker", "foo"],
1617
1254
                                      command.StartChecker)
1618
1255
 
1619
1256
    def test_stop_checker(self):
1620
 
        self.assert_command_from_args(["--stop-checker", "client"],
 
1257
        self.assert_command_from_args(["--stop-checker", "foo"],
1621
1258
                                      command.StopChecker)
1622
1259
 
1623
1260
    def test_approve_by_default(self):
1624
 
        self.assert_command_from_args(["--approve-by-default",
1625
 
                                       "client"],
 
1261
        self.assert_command_from_args(["--approve-by-default", "foo"],
1626
1262
                                      command.ApproveByDefault)
1627
1263
 
1628
1264
    def test_deny_by_default(self):
1629
 
        self.assert_command_from_args(["--deny-by-default", "client"],
 
1265
        self.assert_command_from_args(["--deny-by-default", "foo"],
1630
1266
                                      command.DenyByDefault)
1631
1267
 
1632
1268
    def test_checker(self):
1633
 
        self.assert_command_from_args(["--checker", ":", "client"],
 
1269
        self.assert_command_from_args(["--checker", ":", "foo"],
1634
1270
                                      command.SetChecker,
1635
1271
                                      value_to_set=":")
1636
1272
 
1637
1273
    def test_checker_empty(self):
1638
 
        self.assert_command_from_args(["--checker", "", "client"],
 
1274
        self.assert_command_from_args(["--checker", "", "foo"],
1639
1275
                                      command.SetChecker,
1640
1276
                                      value_to_set="")
1641
1277
 
1642
1278
    def test_checker_short(self):
1643
 
        self.assert_command_from_args(["-c", ":", "client"],
 
1279
        self.assert_command_from_args(["-c", ":", "foo"],
1644
1280
                                      command.SetChecker,
1645
1281
                                      value_to_set=":")
1646
1282
 
1647
1283
    def test_host(self):
1648
 
        self.assert_command_from_args(
1649
 
            ["--host", "client.example.org", "client"],
1650
 
            command.SetHost, value_to_set="client.example.org")
 
1284
        self.assert_command_from_args(["--host", "foo.example.org",
 
1285
                                       "foo"], command.SetHost,
 
1286
                                      value_to_set="foo.example.org")
1651
1287
 
1652
1288
    def test_host_short(self):
1653
 
        self.assert_command_from_args(
1654
 
            ["-H", "client.example.org", "client"], command.SetHost,
1655
 
            value_to_set="client.example.org")
 
1289
        self.assert_command_from_args(["-H", "foo.example.org",
 
1290
                                       "foo"], command.SetHost,
 
1291
                                      value_to_set="foo.example.org")
1656
1292
 
1657
1293
    def test_secret_devnull(self):
1658
1294
        self.assert_command_from_args(["--secret", os.path.devnull,
1659
 
                                       "client"], command.SetSecret,
 
1295
                                       "foo"], command.SetSecret,
1660
1296
                                      value_to_set=b"")
1661
1297
 
1662
1298
    def test_secret_tempfile(self):
1665
1301
            f.write(value)
1666
1302
            f.seek(0)
1667
1303
            self.assert_command_from_args(["--secret", f.name,
1668
 
                                           "client"],
1669
 
                                          command.SetSecret,
 
1304
                                           "foo"], command.SetSecret,
1670
1305
                                          value_to_set=value)
1671
1306
 
1672
1307
    def test_secret_devnull_short(self):
1673
 
        self.assert_command_from_args(["-s", os.path.devnull,
1674
 
                                       "client"], command.SetSecret,
 
1308
        self.assert_command_from_args(["-s", os.path.devnull, "foo"],
 
1309
                                      command.SetSecret,
1675
1310
                                      value_to_set=b"")
1676
1311
 
1677
1312
    def test_secret_tempfile_short(self):
1679
1314
            value = b"secret\0xyzzy\nbar"
1680
1315
            f.write(value)
1681
1316
            f.seek(0)
1682
 
            self.assert_command_from_args(["-s", f.name, "client"],
 
1317
            self.assert_command_from_args(["-s", f.name, "foo"],
1683
1318
                                          command.SetSecret,
1684
1319
                                          value_to_set=value)
1685
1320
 
1686
1321
    def test_timeout(self):
1687
 
        self.assert_command_from_args(["--timeout", "PT5M", "client"],
 
1322
        self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1688
1323
                                      command.SetTimeout,
1689
1324
                                      value_to_set=300000)
1690
1325
 
1691
1326
    def test_timeout_short(self):
1692
 
        self.assert_command_from_args(["-t", "PT5M", "client"],
 
1327
        self.assert_command_from_args(["-t", "PT5M", "foo"],
1693
1328
                                      command.SetTimeout,
1694
1329
                                      value_to_set=300000)
1695
1330
 
1696
1331
    def test_extended_timeout(self):
1697
1332
        self.assert_command_from_args(["--extended-timeout", "PT15M",
1698
 
                                       "client"],
 
1333
                                       "foo"],
1699
1334
                                      command.SetExtendedTimeout,
1700
1335
                                      value_to_set=900000)
1701
1336
 
1702
1337
    def test_interval(self):
1703
 
        self.assert_command_from_args(["--interval", "PT2M",
1704
 
                                       "client"], command.SetInterval,
 
1338
        self.assert_command_from_args(["--interval", "PT2M", "foo"],
 
1339
                                      command.SetInterval,
1705
1340
                                      value_to_set=120000)
1706
1341
 
1707
1342
    def test_interval_short(self):
1708
 
        self.assert_command_from_args(["-i", "PT2M", "client"],
 
1343
        self.assert_command_from_args(["-i", "PT2M", "foo"],
1709
1344
                                      command.SetInterval,
1710
1345
                                      value_to_set=120000)
1711
1346
 
1712
1347
    def test_approval_delay(self):
1713
1348
        self.assert_command_from_args(["--approval-delay", "PT30S",
1714
 
                                       "client"],
 
1349
                                       "foo"],
1715
1350
                                      command.SetApprovalDelay,
1716
1351
                                      value_to_set=30000)
1717
1352
 
1718
1353
    def test_approval_duration(self):
1719
1354
        self.assert_command_from_args(["--approval-duration", "PT1S",
1720
 
                                       "client"],
 
1355
                                       "foo"],
1721
1356
                                      command.SetApprovalDuration,
1722
1357
                                      value_to_set=1000)
1723
1358
 
1738
1373
class TestCommand(unittest.TestCase):
1739
1374
    """Abstract class for tests of command classes"""
1740
1375
 
1741
 
    class FakeMandosBus(dbus.MandosBus):
1742
 
        def __init__(self, testcase):
1743
 
            self.client_properties = {
1744
 
                "Name": "foo",
1745
 
                "KeyID": ("92ed150794387c03ce684574b1139a65"
1746
 
                          "94a34f895daaaf09fd8ea90a27cddb12"),
1747
 
                "Secret": b"secret",
1748
 
                "Host": "foo.example.org",
1749
 
                "Enabled": True,
1750
 
                "Timeout": 300000,
1751
 
                "LastCheckedOK": "2019-02-03T00:00:00",
1752
 
                "Created": "2019-01-02T00:00:00",
1753
 
                "Interval": 120000,
1754
 
                "Fingerprint": ("778827225BA7DE539C5A"
1755
 
                                "7CFA59CFF7CDBD9A5920"),
1756
 
                "CheckerRunning": False,
1757
 
                "LastEnabled": "2019-01-03T00:00:00",
1758
 
                "ApprovalPending": False,
1759
 
                "ApprovedByDefault": True,
1760
 
                "LastApprovalRequest": "",
1761
 
                "ApprovalDelay": 0,
1762
 
                "ApprovalDuration": 1000,
1763
 
                "Checker": "fping -q -- %(host)s",
1764
 
                "ExtendedTimeout": 900000,
1765
 
                "Expires": "2019-02-04T00:00:00",
1766
 
                "LastCheckerStatus": 0,
1767
 
            }
1768
 
            self.other_client_properties = {
1769
 
                "Name": "barbar",
1770
 
                "KeyID": ("0558568eedd67d622f5c83b35a115f79"
1771
 
                          "6ab612cff5ad227247e46c2b020f441c"),
1772
 
                "Secret": b"secretbar",
1773
 
                "Host": "192.0.2.3",
1774
 
                "Enabled": True,
1775
 
                "Timeout": 300000,
1776
 
                "LastCheckedOK": "2019-02-04T00:00:00",
1777
 
                "Created": "2019-01-03T00:00:00",
1778
 
                "Interval": 120000,
1779
 
                "Fingerprint": ("3E393AEAEFB84C7E89E2"
1780
 
                                "F547B3A107558FCA3A27"),
1781
 
                "CheckerRunning": True,
1782
 
                "LastEnabled": "2019-01-04T00:00:00",
1783
 
                "ApprovalPending": False,
1784
 
                "ApprovedByDefault": False,
1785
 
                "LastApprovalRequest": "2019-01-03T00:00:00",
1786
 
                "ApprovalDelay": 30000,
1787
 
                "ApprovalDuration": 93785000,
1788
 
                "Checker": ":",
1789
 
                "ExtendedTimeout": 900000,
1790
 
                "Expires": "2019-02-05T00:00:00",
1791
 
                "LastCheckerStatus": -2,
1792
 
            }
1793
 
            self.clients =  collections.OrderedDict(
1794
 
                [
1795
 
                    ("client_objectpath", self.client_properties),
1796
 
                    ("other_client_objectpath",
1797
 
                     self.other_client_properties),
1798
 
                ])
1799
 
            self.one_client = {"client_objectpath":
1800
 
                               self.client_properties}
1801
 
            self.testcase = testcase
1802
 
            self.calls = []
1803
 
 
1804
 
        def call_method(self, methodname, busname, objectpath,
1805
 
                        interface, *args):
1806
 
            self.testcase.assertEqual("se.recompile.Mandos", busname)
1807
 
            self.calls.append((methodname, busname, objectpath,
1808
 
                               interface, args))
1809
 
            if interface == "org.freedesktop.DBus.Properties":
1810
 
                if methodname == "Set":
1811
 
                    self.testcase.assertEqual(3, len(args))
1812
 
                    interface, key, value = args
1813
 
                    self.testcase.assertEqual(
1814
 
                        "se.recompile.Mandos.Client", interface)
1815
 
                    self.clients[objectpath][key] = value
1816
 
                    return
1817
 
            elif interface == "se.recompile.Mandos":
1818
 
                self.testcase.assertEqual("RemoveClient", methodname)
1819
 
                self.testcase.assertEqual(1, len(args))
1820
 
                clientpath = args[0]
1821
 
                del self.clients[clientpath]
1822
 
                return
1823
 
            elif interface == "se.recompile.Mandos.Client":
1824
 
                if methodname == "Approve":
1825
 
                    self.testcase.assertEqual(1, len(args))
1826
 
                    return
1827
 
            raise ValueError()
1828
 
 
1829
1376
    def setUp(self):
1830
 
        self.bus = self.FakeMandosBus(self)
 
1377
        testcase = self
 
1378
        class MockClient(object):
 
1379
            def __init__(self, name, **attributes):
 
1380
                self.__dbus_object_path__ = "/clients/{}".format(name)
 
1381
                self.attributes = attributes
 
1382
                self.attributes["Name"] = name
 
1383
                self.calls = []
 
1384
            def Set(self, interface, propname, value, dbus_interface):
 
1385
                testcase.assertEqual(interface, client_dbus_interface)
 
1386
                testcase.assertEqual(dbus_interface,
 
1387
                                     dbus.PROPERTIES_IFACE)
 
1388
                self.attributes[propname] = value
 
1389
            def Approve(self, approve, dbus_interface):
 
1390
                testcase.assertEqual(dbus_interface,
 
1391
                                     client_dbus_interface)
 
1392
                self.calls.append(("Approve", (approve,
 
1393
                                               dbus_interface)))
 
1394
        self.client = MockClient(
 
1395
            "foo",
 
1396
            KeyID=("92ed150794387c03ce684574b1139a65"
 
1397
                   "94a34f895daaaf09fd8ea90a27cddb12"),
 
1398
            Secret=b"secret",
 
1399
            Host="foo.example.org",
 
1400
            Enabled=dbus.Boolean(True),
 
1401
            Timeout=300000,
 
1402
            LastCheckedOK="2019-02-03T00:00:00",
 
1403
            Created="2019-01-02T00:00:00",
 
1404
            Interval=120000,
 
1405
            Fingerprint=("778827225BA7DE539C5A"
 
1406
                         "7CFA59CFF7CDBD9A5920"),
 
1407
            CheckerRunning=dbus.Boolean(False),
 
1408
            LastEnabled="2019-01-03T00:00:00",
 
1409
            ApprovalPending=dbus.Boolean(False),
 
1410
            ApprovedByDefault=dbus.Boolean(True),
 
1411
            LastApprovalRequest="",
 
1412
            ApprovalDelay=0,
 
1413
            ApprovalDuration=1000,
 
1414
            Checker="fping -q -- %(host)s",
 
1415
            ExtendedTimeout=900000,
 
1416
            Expires="2019-02-04T00:00:00",
 
1417
            LastCheckerStatus=0)
 
1418
        self.other_client = MockClient(
 
1419
            "barbar",
 
1420
            KeyID=("0558568eedd67d622f5c83b35a115f79"
 
1421
                   "6ab612cff5ad227247e46c2b020f441c"),
 
1422
            Secret=b"secretbar",
 
1423
            Host="192.0.2.3",
 
1424
            Enabled=dbus.Boolean(True),
 
1425
            Timeout=300000,
 
1426
            LastCheckedOK="2019-02-04T00:00:00",
 
1427
            Created="2019-01-03T00:00:00",
 
1428
            Interval=120000,
 
1429
            Fingerprint=("3E393AEAEFB84C7E89E2"
 
1430
                         "F547B3A107558FCA3A27"),
 
1431
            CheckerRunning=dbus.Boolean(True),
 
1432
            LastEnabled="2019-01-04T00:00:00",
 
1433
            ApprovalPending=dbus.Boolean(False),
 
1434
            ApprovedByDefault=dbus.Boolean(False),
 
1435
            LastApprovalRequest="2019-01-03T00:00:00",
 
1436
            ApprovalDelay=30000,
 
1437
            ApprovalDuration=93785000,
 
1438
            Checker=":",
 
1439
            ExtendedTimeout=900000,
 
1440
            Expires="2019-02-05T00:00:00",
 
1441
            LastCheckerStatus=-2)
 
1442
        self.clients =  collections.OrderedDict(
 
1443
            [
 
1444
                ("/clients/foo", self.client.attributes),
 
1445
                ("/clients/barbar", self.other_client.attributes),
 
1446
            ])
 
1447
        self.one_client = {"/clients/foo": self.client.attributes}
 
1448
 
 
1449
    @property
 
1450
    def bus(self):
 
1451
        class Bus(object):
 
1452
            @staticmethod
 
1453
            def get_object(client_bus_name, path):
 
1454
                self.assertEqual(client_bus_name, dbus_busname)
 
1455
                return {
 
1456
                    # Note: "self" here is the TestCmd instance, not
 
1457
                    # the Bus instance, since this is a static method!
 
1458
                    "/clients/foo": self.client,
 
1459
                    "/clients/barbar": self.other_client,
 
1460
                }[path]
 
1461
        return Bus()
1831
1462
 
1832
1463
 
1833
1464
class TestBaseCommands(TestCommand):
1834
1465
 
1835
 
    def test_IsEnabled_exits_successfully(self):
 
1466
    def test_IsEnabled(self):
 
1467
        self.assertTrue(all(command.IsEnabled().is_enabled(client,
 
1468
                                                      properties)
 
1469
                            for client, properties
 
1470
                            in self.clients.items()))
 
1471
 
 
1472
    def test_IsEnabled_run_exits_successfully(self):
1836
1473
        with self.assertRaises(SystemExit) as e:
1837
 
            command.IsEnabled().run(self.bus.one_client)
 
1474
            command.IsEnabled().run(self.one_client)
1838
1475
        if e.exception.code is not None:
1839
 
            self.assertEqual(0, e.exception.code)
 
1476
            self.assertEqual(e.exception.code, 0)
1840
1477
        else:
1841
1478
            self.assertIsNone(e.exception.code)
1842
1479
 
1843
 
    def test_IsEnabled_exits_with_failure(self):
1844
 
        self.bus.client_properties["Enabled"] = False
 
1480
    def test_IsEnabled_run_exits_with_failure(self):
 
1481
        self.client.attributes["Enabled"] = dbus.Boolean(False)
1845
1482
        with self.assertRaises(SystemExit) as e:
1846
 
            command.IsEnabled().run(self.bus.one_client)
 
1483
            command.IsEnabled().run(self.one_client)
1847
1484
        if isinstance(e.exception.code, int):
1848
 
            self.assertNotEqual(0, e.exception.code)
 
1485
            self.assertNotEqual(e.exception.code, 0)
1849
1486
        else:
1850
1487
            self.assertIsNotNone(e.exception.code)
1851
1488
 
1852
1489
    def test_Approve(self):
1853
 
        busname = "se.recompile.Mandos"
1854
 
        client_interface = "se.recompile.Mandos.Client"
1855
 
        command.Approve().run(self.bus.clients, self.bus)
1856
 
        for clientpath in self.bus.clients:
1857
 
            self.assertIn(("Approve", busname, clientpath,
1858
 
                           client_interface, (True,)), self.bus.calls)
 
1490
        command.Approve().run(self.clients, self.bus)
 
1491
        for clientpath in self.clients:
 
1492
            client = self.bus.get_object(dbus_busname, clientpath)
 
1493
            self.assertIn(("Approve", (True, client_dbus_interface)),
 
1494
                          client.calls)
1859
1495
 
1860
1496
    def test_Deny(self):
1861
 
        busname = "se.recompile.Mandos"
1862
 
        client_interface = "se.recompile.Mandos.Client"
1863
 
        command.Deny().run(self.bus.clients, self.bus)
1864
 
        for clientpath in self.bus.clients:
1865
 
            self.assertIn(("Approve", busname, clientpath,
1866
 
                           client_interface, (False,)),
1867
 
                          self.bus.calls)
 
1497
        command.Deny().run(self.clients, self.bus)
 
1498
        for clientpath in self.clients:
 
1499
            client = self.bus.get_object(dbus_busname, clientpath)
 
1500
            self.assertIn(("Approve", (False, client_dbus_interface)),
 
1501
                          client.calls)
1868
1502
 
1869
1503
    def test_Remove(self):
1870
 
        command.Remove().run(self.bus.clients, self.bus)
1871
 
        for clientpath in self.bus.clients:
1872
 
            self.assertIn(("RemoveClient", dbus_busname,
1873
 
                           dbus_server_path, dbus_server_interface,
1874
 
                           (clientpath,)), self.bus.calls)
 
1504
        class MockMandos(object):
 
1505
            def __init__(self):
 
1506
                self.calls = []
 
1507
            def RemoveClient(self, dbus_path):
 
1508
                self.calls.append(("RemoveClient", (dbus_path,)))
 
1509
        mandos = MockMandos()
 
1510
        command.Remove().run(self.clients, self.bus, mandos)
 
1511
        for clientpath in self.clients:
 
1512
            self.assertIn(("RemoveClient", (clientpath,)),
 
1513
                          mandos.calls)
1875
1514
 
1876
1515
    expected_json = {
1877
1516
        "foo": {
1925
1564
    }
1926
1565
 
1927
1566
    def test_DumpJSON_normal(self):
1928
 
        with self.capture_stdout_to_buffer() as buffer:
1929
 
            command.DumpJSON().run(self.bus.clients)
1930
 
        json_data = json.loads(buffer.getvalue())
1931
 
        self.assertDictEqual(self.expected_json, json_data)
1932
 
 
1933
 
    @staticmethod
1934
 
    @contextlib.contextmanager
1935
 
    def capture_stdout_to_buffer():
1936
 
        capture_buffer = io.StringIO()
1937
 
        old_stdout = sys.stdout
1938
 
        sys.stdout = capture_buffer
1939
 
        try:
1940
 
            yield capture_buffer
1941
 
        finally:
1942
 
            sys.stdout = old_stdout
 
1567
        output = command.DumpJSON().output(self.clients.values())
 
1568
        json_data = json.loads(output)
 
1569
        self.assertDictEqual(json_data, self.expected_json)
1943
1570
 
1944
1571
    def test_DumpJSON_one_client(self):
1945
 
        with self.capture_stdout_to_buffer() as buffer:
1946
 
            command.DumpJSON().run(self.bus.one_client)
1947
 
        json_data = json.loads(buffer.getvalue())
 
1572
        output = command.DumpJSON().output(self.one_client.values())
 
1573
        json_data = json.loads(output)
1948
1574
        expected_json = {"foo": self.expected_json["foo"]}
1949
 
        self.assertDictEqual(expected_json, json_data)
 
1575
        self.assertDictEqual(json_data, expected_json)
1950
1576
 
1951
1577
    def test_PrintTable_normal(self):
1952
 
        with self.capture_stdout_to_buffer() as buffer:
1953
 
            command.PrintTable().run(self.bus.clients)
 
1578
        output = command.PrintTable().output(self.clients.values())
1954
1579
        expected_output = "\n".join((
1955
1580
            "Name   Enabled Timeout  Last Successful Check",
1956
1581
            "foo    Yes     00:05:00 2019-02-03T00:00:00  ",
1957
1582
            "barbar Yes     00:05:00 2019-02-04T00:00:00  ",
1958
 
        )) + "\n"
1959
 
        self.assertEqual(expected_output, buffer.getvalue())
 
1583
        ))
 
1584
        self.assertEqual(output, expected_output)
1960
1585
 
1961
1586
    def test_PrintTable_verbose(self):
1962
 
        with self.capture_stdout_to_buffer() as buffer:
1963
 
            command.PrintTable(verbose=True).run(self.bus.clients)
 
1587
        output = command.PrintTable(verbose=True).output(
 
1588
            self.clients.values())
1964
1589
        columns = (
1965
1590
            (
1966
1591
                "Name   ",
2048
1673
            )
2049
1674
        )
2050
1675
        num_lines = max(len(rows) for rows in columns)
2051
 
        expected_output = ("\n".join("".join(rows[line]
2052
 
                                             for rows in columns)
2053
 
                                     for line in range(num_lines))
2054
 
                           + "\n")
2055
 
        self.assertEqual(expected_output, buffer.getvalue())
 
1676
        expected_output = "\n".join("".join(rows[line]
 
1677
                                            for rows in columns)
 
1678
                                    for line in range(num_lines))
 
1679
        self.assertEqual(output, expected_output)
2056
1680
 
2057
1681
    def test_PrintTable_one_client(self):
2058
 
        with self.capture_stdout_to_buffer() as buffer:
2059
 
            command.PrintTable().run(self.bus.one_client)
 
1682
        output = command.PrintTable().output(self.one_client.values())
2060
1683
        expected_output = "\n".join((
2061
1684
            "Name Enabled Timeout  Last Successful Check",
2062
1685
            "foo  Yes     00:05:00 2019-02-03T00:00:00  ",
2063
 
        )) + "\n"
2064
 
        self.assertEqual(expected_output, buffer.getvalue())
2065
 
 
2066
 
 
2067
 
class TestPropertySetterCmd(TestCommand):
2068
 
    """Abstract class for tests of command.PropertySetter classes"""
2069
 
 
 
1686
        ))
 
1687
        self.assertEqual(output, expected_output)
 
1688
 
 
1689
 
 
1690
class TestPropertyCmd(TestCommand):
 
1691
    """Abstract class for tests of command.Property classes"""
2070
1692
    def runTest(self):
2071
1693
        if not hasattr(self, "command"):
2072
 
            return              # Abstract TestCase class
 
1694
            return
2073
1695
        values_to_get = getattr(self, "values_to_get",
2074
1696
                                self.values_to_set)
2075
1697
        for value_to_set, value_to_get in zip(self.values_to_set,
2076
1698
                                              values_to_get):
2077
 
            for clientpath in self.bus.clients:
2078
 
                self.bus.clients[clientpath][self.propname] = Unique()
2079
 
            self.run_command(value_to_set, self.bus.clients)
2080
 
            for clientpath in self.bus.clients:
2081
 
                value = self.bus.clients[clientpath][self.propname]
2082
 
                self.assertNotIsInstance(value, Unique)
2083
 
                self.assertEqual(value_to_get, value)
 
1699
            for clientpath in self.clients:
 
1700
                client = self.bus.get_object(dbus_busname, clientpath)
 
1701
                old_value = client.attributes[self.propname]
 
1702
                client.attributes[self.propname] = self.Unique()
 
1703
            self.run_command(value_to_set, self.clients)
 
1704
            for clientpath in self.clients:
 
1705
                client = self.bus.get_object(dbus_busname, clientpath)
 
1706
                value = client.attributes[self.propname]
 
1707
                self.assertNotIsInstance(value, self.Unique)
 
1708
                self.assertEqual(value, value_to_get)
 
1709
 
 
1710
    class Unique(object):
 
1711
        """Class for objects which exist only to be unique objects,
 
1712
since unittest.mock.sentinel only exists in Python 3.3"""
2084
1713
 
2085
1714
    def run_command(self, value, clients):
2086
1715
        self.command().run(clients, self.bus)
2087
1716
 
2088
1717
 
2089
 
class TestEnableCmd(TestPropertySetterCmd):
 
1718
class TestEnableCmd(TestPropertyCmd):
2090
1719
    command = command.Enable
2091
1720
    propname = "Enabled"
2092
 
    values_to_set = [True]
2093
 
 
2094
 
 
2095
 
class TestDisableCmd(TestPropertySetterCmd):
 
1721
    values_to_set = [dbus.Boolean(True)]
 
1722
 
 
1723
 
 
1724
class TestDisableCmd(TestPropertyCmd):
2096
1725
    command = command.Disable
2097
1726
    propname = "Enabled"
2098
 
    values_to_set = [False]
2099
 
 
2100
 
 
2101
 
class TestBumpTimeoutCmd(TestPropertySetterCmd):
 
1727
    values_to_set = [dbus.Boolean(False)]
 
1728
 
 
1729
 
 
1730
class TestBumpTimeoutCmd(TestPropertyCmd):
2102
1731
    command = command.BumpTimeout
2103
1732
    propname = "LastCheckedOK"
2104
1733
    values_to_set = [""]
2105
1734
 
2106
1735
 
2107
 
class TestStartCheckerCmd(TestPropertySetterCmd):
 
1736
class TestStartCheckerCmd(TestPropertyCmd):
2108
1737
    command = command.StartChecker
2109
1738
    propname = "CheckerRunning"
2110
 
    values_to_set = [True]
2111
 
 
2112
 
 
2113
 
class TestStopCheckerCmd(TestPropertySetterCmd):
 
1739
    values_to_set = [dbus.Boolean(True)]
 
1740
 
 
1741
 
 
1742
class TestStopCheckerCmd(TestPropertyCmd):
2114
1743
    command = command.StopChecker
2115
1744
    propname = "CheckerRunning"
2116
 
    values_to_set = [False]
2117
 
 
2118
 
 
2119
 
class TestApproveByDefaultCmd(TestPropertySetterCmd):
 
1745
    values_to_set = [dbus.Boolean(False)]
 
1746
 
 
1747
 
 
1748
class TestApproveByDefaultCmd(TestPropertyCmd):
2120
1749
    command = command.ApproveByDefault
2121
1750
    propname = "ApprovedByDefault"
2122
 
    values_to_set = [True]
2123
 
 
2124
 
 
2125
 
class TestDenyByDefaultCmd(TestPropertySetterCmd):
 
1751
    values_to_set = [dbus.Boolean(True)]
 
1752
 
 
1753
 
 
1754
class TestDenyByDefaultCmd(TestPropertyCmd):
2126
1755
    command = command.DenyByDefault
2127
1756
    propname = "ApprovedByDefault"
2128
 
    values_to_set = [False]
2129
 
 
2130
 
 
2131
 
class TestPropertySetterValueCmd(TestPropertySetterCmd):
2132
 
    """Abstract class for tests of PropertySetterValueCmd classes"""
 
1757
    values_to_set = [dbus.Boolean(False)]
 
1758
 
 
1759
 
 
1760
class TestPropertyValueCmd(TestPropertyCmd):
 
1761
    """Abstract class for tests of PropertyValueCmd classes"""
 
1762
 
 
1763
    def runTest(self):
 
1764
        if type(self) is TestPropertyValueCmd:
 
1765
            return
 
1766
        return super(TestPropertyValueCmd, self).runTest()
2133
1767
 
2134
1768
    def run_command(self, value, clients):
2135
1769
        self.command(value).run(clients, self.bus)
2136
1770
 
2137
1771
 
2138
 
class TestSetCheckerCmd(TestPropertySetterValueCmd):
 
1772
class TestSetCheckerCmd(TestPropertyValueCmd):
2139
1773
    command = command.SetChecker
2140
1774
    propname = "Checker"
2141
1775
    values_to_set = ["", ":", "fping -q -- %s"]
2142
1776
 
2143
1777
 
2144
 
class TestSetHostCmd(TestPropertySetterValueCmd):
 
1778
class TestSetHostCmd(TestPropertyValueCmd):
2145
1779
    command = command.SetHost
2146
1780
    propname = "Host"
2147
 
    values_to_set = ["192.0.2.3", "client.example.org"]
2148
 
 
2149
 
 
2150
 
class TestSetSecretCmd(TestPropertySetterValueCmd):
 
1781
    values_to_set = ["192.0.2.3", "foo.example.org"]
 
1782
 
 
1783
 
 
1784
class TestSetSecretCmd(TestPropertyValueCmd):
2151
1785
    command = command.SetSecret
2152
1786
    propname = "Secret"
2153
1787
    values_to_set = [io.BytesIO(b""),
2154
1788
                     io.BytesIO(b"secret\0xyzzy\nbar")]
2155
 
    values_to_get = [f.getvalue() for f in values_to_set]
2156
 
 
2157
 
 
2158
 
class TestSetTimeoutCmd(TestPropertySetterValueCmd):
 
1789
    values_to_get = [b"", b"secret\0xyzzy\nbar"]
 
1790
 
 
1791
 
 
1792
class TestSetTimeoutCmd(TestPropertyValueCmd):
2159
1793
    command = command.SetTimeout
2160
1794
    propname = "Timeout"
2161
1795
    values_to_set = [datetime.timedelta(),
2163
1797
                     datetime.timedelta(seconds=1),
2164
1798
                     datetime.timedelta(weeks=1),
2165
1799
                     datetime.timedelta(weeks=52)]
2166
 
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2167
 
 
2168
 
 
2169
 
class TestSetExtendedTimeoutCmd(TestPropertySetterValueCmd):
 
1800
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1801
 
 
1802
 
 
1803
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
2170
1804
    command = command.SetExtendedTimeout
2171
1805
    propname = "ExtendedTimeout"
2172
1806
    values_to_set = [datetime.timedelta(),
2174
1808
                     datetime.timedelta(seconds=1),
2175
1809
                     datetime.timedelta(weeks=1),
2176
1810
                     datetime.timedelta(weeks=52)]
2177
 
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2178
 
 
2179
 
 
2180
 
class TestSetIntervalCmd(TestPropertySetterValueCmd):
 
1811
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1812
 
 
1813
 
 
1814
class TestSetIntervalCmd(TestPropertyValueCmd):
2181
1815
    command = command.SetInterval
2182
1816
    propname = "Interval"
2183
1817
    values_to_set = [datetime.timedelta(),
2185
1819
                     datetime.timedelta(seconds=1),
2186
1820
                     datetime.timedelta(weeks=1),
2187
1821
                     datetime.timedelta(weeks=52)]
2188
 
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2189
 
 
2190
 
 
2191
 
class TestSetApprovalDelayCmd(TestPropertySetterValueCmd):
 
1822
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1823
 
 
1824
 
 
1825
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
2192
1826
    command = command.SetApprovalDelay
2193
1827
    propname = "ApprovalDelay"
2194
1828
    values_to_set = [datetime.timedelta(),
2196
1830
                     datetime.timedelta(seconds=1),
2197
1831
                     datetime.timedelta(weeks=1),
2198
1832
                     datetime.timedelta(weeks=52)]
2199
 
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2200
 
 
2201
 
 
2202
 
class TestSetApprovalDurationCmd(TestPropertySetterValueCmd):
 
1833
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1834
 
 
1835
 
 
1836
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
2203
1837
    command = command.SetApprovalDuration
2204
1838
    propname = "ApprovalDuration"
2205
1839
    values_to_set = [datetime.timedelta(),
2207
1841
                     datetime.timedelta(seconds=1),
2208
1842
                     datetime.timedelta(weeks=1),
2209
1843
                     datetime.timedelta(weeks=52)]
2210
 
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
 
1844
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
2211
1845
 
2212
1846
 
2213
1847