/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-30 17:02:33 UTC
  • Revision ID: teddy@recompile.se-20190330170233-nxu3cgb98q2g3o5j
Fix typo in intro(8mandos).

* intro.xml (INTRODUCTION): Add missing period at end of last sentence
                            of penultimate paragraph.

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
48
49
 
49
 
import dbus
 
50
import dbus as dbus_python
50
51
 
51
52
# Show warnings by default
52
53
if not sys.warnoptions:
61
62
 
62
63
if sys.version_info.major == 2:
63
64
    str = unicode
 
65
    import StringIO
 
66
    io.StringIO = StringIO.StringIO
64
67
 
65
68
locale.setlocale(locale.LC_ALL, "")
66
69
 
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
73
70
version = "1.8.3"
74
71
 
75
72
 
76
 
try:
77
 
    dbus.OBJECT_MANAGER_IFACE
78
 
except AttributeError:
79
 
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
80
 
 
81
 
 
82
73
def main():
83
74
    parser = argparse.ArgumentParser()
84
 
 
85
75
    add_command_line_options(parser)
86
76
 
87
77
    options = parser.parse_args()
88
 
 
89
78
    check_option_syntax(parser, options)
90
79
 
91
80
    clientnames = options.client
93
82
    if options.debug:
94
83
        log.setLevel(logging.DEBUG)
95
84
 
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
 
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)
113
96
 
114
97
    # Compile dict of (clientpath: properties) to process
115
98
    if not clientnames:
128
111
    commands = commands_from_options(options)
129
112
 
130
113
    for command in commands:
131
 
        command.run(clients, bus, mandos_serv)
 
114
        command.run(clients, bus)
132
115
 
133
116
 
134
117
def add_command_line_options(parser):
424
407
        options.remove = True
425
408
 
426
409
 
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)
 
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
473
550
 
474
551
 
475
552
def commands_from_options(options):
552
629
 
553
630
    class Base(object):
554
631
        """Abstract base class for commands"""
555
 
        def run(self, clients, bus=None, mandos=None):
 
632
        def run(self, clients, bus=None):
556
633
            """Normal commands should implement run_on_one_client(),
557
634
but commands which want to operate on all clients at the same time can
558
635
override this run() method instead.
559
636
"""
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)
 
637
            self.bus = bus
 
638
            for client, properties in clients.items():
565
639
                self.run_on_one_client(client, properties)
566
640
 
567
641
 
568
642
    class IsEnabled(Base):
569
 
        def run(self, clients, bus=None, mandos=None):
570
 
            client, properties = next(iter(clients.items()))
571
 
            if self.is_enabled(client, properties):
 
643
        def run(self, clients, bus=None):
 
644
            properties = next(iter(clients.values()))
 
645
            if properties["Enabled"]:
572
646
                sys.exit(0)
573
647
            sys.exit(1)
574
 
        def is_enabled(self, client, properties):
575
 
            return properties["Enabled"]
576
648
 
577
649
 
578
650
    class Approve(Base):
579
651
        def run_on_one_client(self, client, properties):
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)
 
652
            self.bus.call_client_method(client, "Approve", True)
585
653
 
586
654
 
587
655
    class Deny(Base):
588
656
        def run_on_one_client(self, client, properties):
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)
 
657
            self.bus.call_client_method(client, "Approve", False)
594
658
 
595
659
 
596
660
    class Remove(Base):
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__)
 
661
        def run(self, clients, bus):
 
662
            for clientpath in frozenset(clients.keys()):
 
663
                bus.call_server_method("RemoveClient", clientpath)
603
664
 
604
665
 
605
666
    class Output(Base):
613
674
                        "Checker", "ExtendedTimeout", "Expires",
614
675
                        "LastCheckerStatus")
615
676
 
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
 
 
622
677
 
623
678
    class DumpJSON(Output):
624
 
        def output(self, clients):
625
 
            data = {client["Name"]:
626
 
                    {key: self.dbus_boolean_to_bool(client[key])
 
679
        def run(self, clients, bus=None):
 
680
            data = {properties["Name"]:
 
681
                    {key: properties[key]
627
682
                     for key in self.all_keywords}
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
 
683
                    for properties in clients.values()}
 
684
            print(json.dumps(data, indent=4, separators=(',', ': ')))
636
685
 
637
686
 
638
687
    class PrintTable(Output):
639
688
        def __init__(self, verbose=False):
640
689
            self.verbose = verbose
641
690
 
642
 
        def output(self, clients):
 
691
        def run(self, clients, bus=None):
643
692
            default_keywords = ("Name", "Enabled", "Timeout",
644
693
                                "LastCheckedOK")
645
694
            keywords = default_keywords
646
695
            if self.verbose:
647
696
                keywords = self.all_keywords
648
 
            return str(self.TableOfClients(clients, keywords))
 
697
            print(self.TableOfClients(clients.values(), keywords))
649
698
 
650
699
        class TableOfClients(object):
651
700
            tableheaders = {
706
755
 
707
756
            @classmethod
708
757
            def valuetostring(cls, value, keyword):
709
 
                if isinstance(value, dbus.Boolean):
 
758
                if isinstance(value, bool):
710
759
                    return "Yes" if value else "No"
711
760
                if keyword in ("Timeout", "Interval", "ApprovalDelay",
712
761
                               "ApprovalDuration", "ExtendedTimeout"):
732
781
                                seconds=td.seconds % 60))
733
782
 
734
783
 
735
 
    class Property(Base):
 
784
    class PropertySetter(Base):
736
785
        "Abstract class for Actions for setting one client property"
737
786
 
738
 
        def run_on_one_client(self, client, properties):
 
787
        def run_on_one_client(self, client, properties=None):
739
788
            """Set the Client's D-Bus property"""
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)
 
789
            self.bus.set_client_property(client, self.propname,
 
790
                                         self.value_to_set)
750
791
 
751
792
        @property
752
793
        def propname(self):
753
794
            raise NotImplementedError()
754
795
 
755
796
 
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):
 
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):
767
808
        propname = "LastCheckedOK"
768
809
        value_to_set = ""
769
810
 
770
811
 
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"
 
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."""
793
835
        def __init__(self, value):
794
836
            self.value_to_set = value
795
837
 
796
838
 
797
 
    class SetChecker(PropertyValue):
 
839
    class SetChecker(PropertySetterValue):
798
840
        propname = "Checker"
799
841
 
800
842
 
801
 
    class SetHost(PropertyValue):
 
843
    class SetHost(PropertySetterValue):
802
844
        propname = "Host"
803
845
 
804
846
 
805
 
    class SetSecret(PropertyValue):
 
847
    class SetSecret(PropertySetterValue):
806
848
        propname = "Secret"
807
849
 
808
850
        @property
816
858
            value.close()
817
859
 
818
860
 
819
 
    class MillisecondsPropertyValueArgument(PropertyValue):
820
 
        """Abstract class for PropertyValue taking a value argument as
821
 
a datetime.timedelta() but should store it as milliseconds."""
 
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."""
822
865
 
823
866
        @property
824
867
        def value_to_set(self):
830
873
            self._vts = int(round(value.total_seconds() * 1000))
831
874
 
832
875
 
833
 
    class SetTimeout(MillisecondsPropertyValueArgument):
 
876
    class SetTimeout(PropertySetterValueMilliseconds):
834
877
        propname = "Timeout"
835
878
 
836
879
 
837
 
    class SetExtendedTimeout(MillisecondsPropertyValueArgument):
 
880
    class SetExtendedTimeout(PropertySetterValueMilliseconds):
838
881
        propname = "ExtendedTimeout"
839
882
 
840
883
 
841
 
    class SetInterval(MillisecondsPropertyValueArgument):
 
884
    class SetInterval(PropertySetterValueMilliseconds):
842
885
        propname = "Interval"
843
886
 
844
887
 
845
 
    class SetApprovalDelay(MillisecondsPropertyValueArgument):
 
888
    class SetApprovalDelay(PropertySetterValueMilliseconds):
846
889
        propname = "ApprovalDelay"
847
890
 
848
891
 
849
 
    class SetApprovalDuration(MillisecondsPropertyValueArgument):
 
892
    class SetApprovalDuration(PropertySetterValueMilliseconds):
850
893
        propname = "ApprovalDuration"
851
894
 
852
895
 
885
928
                                                     "output"))
886
929
 
887
930
 
 
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
 
888
936
class Test_string_to_delta(TestCaseWithAssertLogs):
889
 
    def test_handles_basic_rfc3339(self):
890
 
        self.assertEqual(string_to_delta("PT0S"),
891
 
                         datetime.timedelta())
892
 
        self.assertEqual(string_to_delta("P0D"),
893
 
                         datetime.timedelta())
894
 
        self.assertEqual(string_to_delta("PT1S"),
895
 
                         datetime.timedelta(0, 1))
896
 
        self.assertEqual(string_to_delta("PT2H"),
897
 
                         datetime.timedelta(0, 7200))
 
937
    # Just test basic RFC 3339 functionality here, the doc string for
 
938
    # rfc3339_duration_to_delta() already has more comprehensive
 
939
    # tests, which are run by doctest.
 
940
 
 
941
    def test_rfc3339_zero_seconds(self):
 
942
        self.assertEqual(datetime.timedelta(),
 
943
                         string_to_delta("PT0S"))
 
944
 
 
945
    def test_rfc3339_zero_days(self):
 
946
        self.assertEqual(datetime.timedelta(), string_to_delta("P0D"))
 
947
 
 
948
    def test_rfc3339_one_second(self):
 
949
        self.assertEqual(datetime.timedelta(0, 1),
 
950
                         string_to_delta("PT1S"))
 
951
 
 
952
    def test_rfc3339_two_hours(self):
 
953
        self.assertEqual(datetime.timedelta(0, 7200),
 
954
                         string_to_delta("PT2H"))
898
955
 
899
956
    def test_falls_back_to_pre_1_6_1_with_warning(self):
900
957
        with self.assertLogs(log, logging.WARNING):
901
958
            value = string_to_delta("2h")
902
 
        self.assertEqual(value, datetime.timedelta(0, 7200))
 
959
        self.assertEqual(datetime.timedelta(0, 7200), value)
903
960
 
904
961
 
905
962
class Test_check_option_syntax(unittest.TestCase):
948
1005
        # Exit code from argparse is guaranteed to be "2".  Reference:
949
1006
        # https://docs.python.org/3/library
950
1007
        # /argparse.html#exiting-methods
951
 
        self.assertEqual(e.exception.code, 2)
 
1008
        self.assertEqual(2, e.exception.code)
952
1009
 
953
1010
    @staticmethod
954
1011
    @contextlib.contextmanager
955
1012
    def redirect_stderr_to_devnull():
956
 
        null = os.open(os.path.devnull, os.O_RDWR)
957
 
        stderrcopy = os.dup(sys.stderr.fileno())
958
 
        os.dup2(null, sys.stderr.fileno())
959
 
        os.close(null)
960
 
        try:
961
 
            yield
962
 
        finally:
963
 
            # restore stderr
964
 
            os.dup2(stderrcopy, sys.stderr.fileno())
965
 
            os.close(stderrcopy)
 
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
1020
 
967
1021
    def check_option_syntax(self, options):
968
1022
        check_option_syntax(self.parser, options)
981
1035
            options = self.parser.parse_args()
982
1036
            setattr(options, action, value)
983
1037
            options.verbose = True
984
 
            options.client = ["foo"]
 
1038
            options.client = ["client"]
985
1039
            with self.assertParseError():
986
1040
                self.check_option_syntax(options)
987
1041
 
1017
1071
        for action, value in self.actions.items():
1018
1072
            options = self.parser.parse_args()
1019
1073
            setattr(options, action, value)
1020
 
            options.client = ["foo"]
 
1074
            options.client = ["client"]
1021
1075
            self.check_option_syntax(options)
1022
1076
 
1023
1077
    def test_one_client_with_all_actions_except_is_enabled(self):
1026
1080
            if action == "is_enabled":
1027
1081
                continue
1028
1082
            setattr(options, action, value)
1029
 
        options.client = ["foo"]
 
1083
        options.client = ["client"]
1030
1084
        self.check_option_syntax(options)
1031
1085
 
1032
1086
    def test_two_clients_with_all_actions_except_is_enabled(self):
1035
1089
            if action == "is_enabled":
1036
1090
                continue
1037
1091
            setattr(options, action, value)
1038
 
        options.client = ["foo", "barbar"]
 
1092
        options.client = ["client1", "client2"]
1039
1093
        self.check_option_syntax(options)
1040
1094
 
1041
1095
    def test_two_clients_are_ok_with_actions_except_is_enabled(self):
1044
1098
                continue
1045
1099
            options = self.parser.parse_args()
1046
1100
            setattr(options, action, value)
1047
 
            options.client = ["foo", "barbar"]
 
1101
            options.client = ["client1", "client2"]
1048
1102
            self.check_option_syntax(options)
1049
1103
 
1050
1104
    def test_is_enabled_fails_without_client(self):
1056
1110
    def test_is_enabled_fails_with_two_clients(self):
1057
1111
        options = self.parser.parse_args()
1058
1112
        options.is_enabled = True
1059
 
        options.client = ["foo", "barbar"]
 
1113
        options.client = ["client1", "client2"]
1060
1114
        with self.assertParseError():
1061
1115
            self.check_option_syntax(options)
1062
1116
 
1072
1126
                self.check_option_syntax(options)
1073
1127
 
1074
1128
 
1075
 
class Test_get_mandos_dbus_object(TestCaseWithAssertLogs):
1076
 
    def test_calls_and_returns_get_object_on_bus(self):
1077
 
        class MockBus(object):
1078
 
            called = False
1079
 
            def get_object(mockbus_self, busname, dbus_path):
1080
 
                # Note that "self" is still the testcase instance,
1081
 
                # this MockBus instance is in "mockbus_self".
1082
 
                self.assertEqual(busname, dbus_busname)
1083
 
                self.assertEqual(dbus_path, server_dbus_path)
1084
 
                mockbus_self.called = True
1085
 
                return mockbus_self
1086
 
 
1087
 
        mockbus = get_mandos_dbus_object(bus=MockBus())
1088
 
        self.assertIsInstance(mockbus, MockBus)
1089
 
        self.assertTrue(mockbus.called)
1090
 
 
1091
 
    def test_logs_and_exits_on_dbus_error(self):
1092
 
        class MockBusFailing(object):
1093
 
            def get_object(self, busname, dbus_path):
1094
 
                raise dbus.exceptions.DBusException("Test")
1095
 
 
1096
 
        with self.assertLogs(log, logging.CRITICAL):
1097
 
            with self.assertRaises(SystemExit) as e:
1098
 
                bus = get_mandos_dbus_object(bus=MockBusFailing())
1099
 
 
1100
 
        if isinstance(e.exception.code, int):
1101
 
            self.assertNotEqual(e.exception.code, 0)
1102
 
        else:
1103
 
            self.assertIsNotNone(e.exception.code)
1104
 
 
1105
 
 
1106
 
class Test_get_managed_objects(TestCaseWithAssertLogs):
1107
 
    def test_calls_and_returns_GetManagedObjects(self):
1108
 
        managed_objects = {"/clients/foo": { "Name": "foo"}}
1109
 
        class MockObjectManager(object):
1110
 
            def GetManagedObjects(self):
1111
 
                return managed_objects
1112
 
        retval = get_managed_objects(MockObjectManager())
1113
 
        self.assertDictEqual(managed_objects, retval)
1114
 
 
1115
 
    def test_logs_and_exits_on_dbus_error(self):
 
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):
1116
1415
        dbus_logger = logging.getLogger("dbus.proxies")
1117
1416
 
1118
 
        class MockObjectManagerFailing(object):
1119
 
            def GetManagedObjects(self):
1120
 
                dbus_logger.error("Test")
1121
 
                raise dbus.exceptions.DBusException("Test")
 
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)
1122
1423
 
1123
1424
        class CountingHandler(logging.Handler):
1124
1425
            count = 0
1130
1431
        dbus_logger.addHandler(counting_handler)
1131
1432
 
1132
1433
        try:
1133
 
            with self.assertLogs(log, logging.CRITICAL) as watcher:
1134
 
                with self.assertRaises(SystemExit) as e:
1135
 
                    get_managed_objects(MockObjectManagerFailing())
 
1434
            with self.assertRaises(dbus.Error) as e:
 
1435
                self.call_method(bus, "methodname", "busname",
 
1436
                                 "objectpath", "interface")
1136
1437
        finally:
1137
1438
            dbus_logger.removeFilter(counting_handler)
1138
1439
 
 
1440
        self.assertNotIsInstance(e, dbus.ConnectFailed)
 
1441
 
1139
1442
        # Make sure the dbus logger was suppressed
1140
 
        self.assertEqual(counting_handler.count, 0)
1141
 
 
1142
 
        # Test that the dbus_logger still works
1143
 
        with self.assertLogs(dbus_logger, logging.ERROR):
1144
 
            dbus_logger.error("Test")
1145
 
 
1146
 
        if isinstance(e.exception.code, int):
1147
 
            self.assertNotEqual(e.exception.code, 0)
1148
 
        else:
1149
 
            self.assertIsNotNone(e.exception.code)
 
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
1517
 
1151
1518
 
1152
1519
class Test_commands_from_options(unittest.TestCase):
 
1520
 
1153
1521
    def setUp(self):
1154
1522
        self.parser = argparse.ArgumentParser()
1155
1523
        add_command_line_options(self.parser)
1156
1524
 
1157
1525
    def test_is_enabled(self):
1158
 
        self.assert_command_from_args(["--is-enabled", "foo"],
 
1526
        self.assert_command_from_args(["--is-enabled", "client"],
1159
1527
                                      command.IsEnabled)
1160
1528
 
1161
1529
    def assert_command_from_args(self, args, command_cls,
1165
1533
        options = self.parser.parse_args(args)
1166
1534
        check_option_syntax(self.parser, options)
1167
1535
        commands = commands_from_options(options)
1168
 
        self.assertEqual(len(commands), 1)
 
1536
        self.assertEqual(1, len(commands))
1169
1537
        command = commands[0]
1170
1538
        self.assertIsInstance(command, command_cls)
1171
1539
        for key, value in cmd_attrs.items():
1172
 
            self.assertEqual(getattr(command, key), value)
 
1540
            self.assertEqual(value, getattr(command, key))
1173
1541
 
1174
1542
    def test_is_enabled_short(self):
1175
 
        self.assert_command_from_args(["-V", "foo"],
 
1543
        self.assert_command_from_args(["-V", "client"],
1176
1544
                                      command.IsEnabled)
1177
1545
 
1178
1546
    def test_approve(self):
1179
 
        self.assert_command_from_args(["--approve", "foo"],
 
1547
        self.assert_command_from_args(["--approve", "client"],
1180
1548
                                      command.Approve)
1181
1549
 
1182
1550
    def test_approve_short(self):
1183
 
        self.assert_command_from_args(["-A", "foo"], command.Approve)
 
1551
        self.assert_command_from_args(["-A", "client"],
 
1552
                                      command.Approve)
1184
1553
 
1185
1554
    def test_deny(self):
1186
 
        self.assert_command_from_args(["--deny", "foo"], command.Deny)
 
1555
        self.assert_command_from_args(["--deny", "client"],
 
1556
                                      command.Deny)
1187
1557
 
1188
1558
    def test_deny_short(self):
1189
 
        self.assert_command_from_args(["-D", "foo"], command.Deny)
 
1559
        self.assert_command_from_args(["-D", "client"], command.Deny)
1190
1560
 
1191
1561
    def test_remove(self):
1192
 
        self.assert_command_from_args(["--remove", "foo"],
 
1562
        self.assert_command_from_args(["--remove", "client"],
1193
1563
                                      command.Remove)
1194
1564
 
1195
1565
    def test_deny_before_remove(self):
1196
1566
        options = self.parser.parse_args(["--deny", "--remove",
1197
 
                                          "foo"])
 
1567
                                          "client"])
1198
1568
        check_option_syntax(self.parser, options)
1199
1569
        commands = commands_from_options(options)
1200
 
        self.assertEqual(len(commands), 2)
 
1570
        self.assertEqual(2, len(commands))
1201
1571
        self.assertIsInstance(commands[0], command.Deny)
1202
1572
        self.assertIsInstance(commands[1], command.Remove)
1203
1573
 
1206
1576
                                          "--all"])
1207
1577
        check_option_syntax(self.parser, options)
1208
1578
        commands = commands_from_options(options)
1209
 
        self.assertEqual(len(commands), 2)
 
1579
        self.assertEqual(2, len(commands))
1210
1580
        self.assertIsInstance(commands[0], command.Deny)
1211
1581
        self.assertIsInstance(commands[1], command.Remove)
1212
1582
 
1213
1583
    def test_remove_short(self):
1214
 
        self.assert_command_from_args(["-r", "foo"], command.Remove)
 
1584
        self.assert_command_from_args(["-r", "client"],
 
1585
                                      command.Remove)
1215
1586
 
1216
1587
    def test_dump_json(self):
1217
1588
        self.assert_command_from_args(["--dump-json"],
1218
1589
                                      command.DumpJSON)
1219
1590
 
1220
1591
    def test_enable(self):
1221
 
        self.assert_command_from_args(["--enable", "foo"],
 
1592
        self.assert_command_from_args(["--enable", "client"],
1222
1593
                                      command.Enable)
1223
1594
 
1224
1595
    def test_enable_short(self):
1225
 
        self.assert_command_from_args(["-e", "foo"], command.Enable)
 
1596
        self.assert_command_from_args(["-e", "client"],
 
1597
                                      command.Enable)
1226
1598
 
1227
1599
    def test_disable(self):
1228
 
        self.assert_command_from_args(["--disable", "foo"],
 
1600
        self.assert_command_from_args(["--disable", "client"],
1229
1601
                                      command.Disable)
1230
1602
 
1231
1603
    def test_disable_short(self):
1232
 
        self.assert_command_from_args(["-d", "foo"], command.Disable)
 
1604
        self.assert_command_from_args(["-d", "client"],
 
1605
                                      command.Disable)
1233
1606
 
1234
1607
    def test_bump_timeout(self):
1235
 
        self.assert_command_from_args(["--bump-timeout", "foo"],
 
1608
        self.assert_command_from_args(["--bump-timeout", "client"],
1236
1609
                                      command.BumpTimeout)
1237
1610
 
1238
1611
    def test_bump_timeout_short(self):
1239
 
        self.assert_command_from_args(["-b", "foo"],
 
1612
        self.assert_command_from_args(["-b", "client"],
1240
1613
                                      command.BumpTimeout)
1241
1614
 
1242
1615
    def test_start_checker(self):
1243
 
        self.assert_command_from_args(["--start-checker", "foo"],
 
1616
        self.assert_command_from_args(["--start-checker", "client"],
1244
1617
                                      command.StartChecker)
1245
1618
 
1246
1619
    def test_stop_checker(self):
1247
 
        self.assert_command_from_args(["--stop-checker", "foo"],
 
1620
        self.assert_command_from_args(["--stop-checker", "client"],
1248
1621
                                      command.StopChecker)
1249
1622
 
1250
1623
    def test_approve_by_default(self):
1251
 
        self.assert_command_from_args(["--approve-by-default", "foo"],
 
1624
        self.assert_command_from_args(["--approve-by-default",
 
1625
                                       "client"],
1252
1626
                                      command.ApproveByDefault)
1253
1627
 
1254
1628
    def test_deny_by_default(self):
1255
 
        self.assert_command_from_args(["--deny-by-default", "foo"],
 
1629
        self.assert_command_from_args(["--deny-by-default", "client"],
1256
1630
                                      command.DenyByDefault)
1257
1631
 
1258
1632
    def test_checker(self):
1259
 
        self.assert_command_from_args(["--checker", ":", "foo"],
 
1633
        self.assert_command_from_args(["--checker", ":", "client"],
1260
1634
                                      command.SetChecker,
1261
1635
                                      value_to_set=":")
1262
1636
 
1263
1637
    def test_checker_empty(self):
1264
 
        self.assert_command_from_args(["--checker", "", "foo"],
 
1638
        self.assert_command_from_args(["--checker", "", "client"],
1265
1639
                                      command.SetChecker,
1266
1640
                                      value_to_set="")
1267
1641
 
1268
1642
    def test_checker_short(self):
1269
 
        self.assert_command_from_args(["-c", ":", "foo"],
 
1643
        self.assert_command_from_args(["-c", ":", "client"],
1270
1644
                                      command.SetChecker,
1271
1645
                                      value_to_set=":")
1272
1646
 
1273
1647
    def test_host(self):
1274
 
        self.assert_command_from_args(["--host", "foo.example.org",
1275
 
                                       "foo"], command.SetHost,
1276
 
                                      value_to_set="foo.example.org")
 
1648
        self.assert_command_from_args(
 
1649
            ["--host", "client.example.org", "client"],
 
1650
            command.SetHost, value_to_set="client.example.org")
1277
1651
 
1278
1652
    def test_host_short(self):
1279
 
        self.assert_command_from_args(["-H", "foo.example.org",
1280
 
                                       "foo"], command.SetHost,
1281
 
                                      value_to_set="foo.example.org")
 
1653
        self.assert_command_from_args(
 
1654
            ["-H", "client.example.org", "client"], command.SetHost,
 
1655
            value_to_set="client.example.org")
1282
1656
 
1283
1657
    def test_secret_devnull(self):
1284
1658
        self.assert_command_from_args(["--secret", os.path.devnull,
1285
 
                                       "foo"], command.SetSecret,
 
1659
                                       "client"], command.SetSecret,
1286
1660
                                      value_to_set=b"")
1287
1661
 
1288
1662
    def test_secret_tempfile(self):
1291
1665
            f.write(value)
1292
1666
            f.seek(0)
1293
1667
            self.assert_command_from_args(["--secret", f.name,
1294
 
                                           "foo"], command.SetSecret,
 
1668
                                           "client"],
 
1669
                                          command.SetSecret,
1295
1670
                                          value_to_set=value)
1296
1671
 
1297
1672
    def test_secret_devnull_short(self):
1298
 
        self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1299
 
                                      command.SetSecret,
 
1673
        self.assert_command_from_args(["-s", os.path.devnull,
 
1674
                                       "client"], command.SetSecret,
1300
1675
                                      value_to_set=b"")
1301
1676
 
1302
1677
    def test_secret_tempfile_short(self):
1304
1679
            value = b"secret\0xyzzy\nbar"
1305
1680
            f.write(value)
1306
1681
            f.seek(0)
1307
 
            self.assert_command_from_args(["-s", f.name, "foo"],
 
1682
            self.assert_command_from_args(["-s", f.name, "client"],
1308
1683
                                          command.SetSecret,
1309
1684
                                          value_to_set=value)
1310
1685
 
1311
1686
    def test_timeout(self):
1312
 
        self.assert_command_from_args(["--timeout", "PT5M", "foo"],
 
1687
        self.assert_command_from_args(["--timeout", "PT5M", "client"],
1313
1688
                                      command.SetTimeout,
1314
1689
                                      value_to_set=300000)
1315
1690
 
1316
1691
    def test_timeout_short(self):
1317
 
        self.assert_command_from_args(["-t", "PT5M", "foo"],
 
1692
        self.assert_command_from_args(["-t", "PT5M", "client"],
1318
1693
                                      command.SetTimeout,
1319
1694
                                      value_to_set=300000)
1320
1695
 
1321
1696
    def test_extended_timeout(self):
1322
1697
        self.assert_command_from_args(["--extended-timeout", "PT15M",
1323
 
                                       "foo"],
 
1698
                                       "client"],
1324
1699
                                      command.SetExtendedTimeout,
1325
1700
                                      value_to_set=900000)
1326
1701
 
1327
1702
    def test_interval(self):
1328
 
        self.assert_command_from_args(["--interval", "PT2M", "foo"],
1329
 
                                      command.SetInterval,
 
1703
        self.assert_command_from_args(["--interval", "PT2M",
 
1704
                                       "client"], command.SetInterval,
1330
1705
                                      value_to_set=120000)
1331
1706
 
1332
1707
    def test_interval_short(self):
1333
 
        self.assert_command_from_args(["-i", "PT2M", "foo"],
 
1708
        self.assert_command_from_args(["-i", "PT2M", "client"],
1334
1709
                                      command.SetInterval,
1335
1710
                                      value_to_set=120000)
1336
1711
 
1337
1712
    def test_approval_delay(self):
1338
1713
        self.assert_command_from_args(["--approval-delay", "PT30S",
1339
 
                                       "foo"],
 
1714
                                       "client"],
1340
1715
                                      command.SetApprovalDelay,
1341
1716
                                      value_to_set=30000)
1342
1717
 
1343
1718
    def test_approval_duration(self):
1344
1719
        self.assert_command_from_args(["--approval-duration", "PT1S",
1345
 
                                       "foo"],
 
1720
                                       "client"],
1346
1721
                                      command.SetApprovalDuration,
1347
1722
                                      value_to_set=1000)
1348
1723
 
1363
1738
class TestCommand(unittest.TestCase):
1364
1739
    """Abstract class for tests of command classes"""
1365
1740
 
 
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
 
1366
1829
    def setUp(self):
1367
 
        testcase = self
1368
 
        class MockClient(object):
1369
 
            def __init__(self, name, **attributes):
1370
 
                self.__dbus_object_path__ = "/clients/{}".format(name)
1371
 
                self.attributes = attributes
1372
 
                self.attributes["Name"] = name
1373
 
                self.calls = []
1374
 
            def Set(self, interface, propname, value, dbus_interface):
1375
 
                testcase.assertEqual(interface, client_dbus_interface)
1376
 
                testcase.assertEqual(dbus_interface,
1377
 
                                     dbus.PROPERTIES_IFACE)
1378
 
                self.attributes[propname] = value
1379
 
            def Get(self, interface, propname, dbus_interface):
1380
 
                testcase.assertEqual(interface, client_dbus_interface)
1381
 
                testcase.assertEqual(dbus_interface,
1382
 
                                     dbus.PROPERTIES_IFACE)
1383
 
                return self.attributes[propname]
1384
 
            def Approve(self, approve, dbus_interface):
1385
 
                testcase.assertEqual(dbus_interface,
1386
 
                                     client_dbus_interface)
1387
 
                self.calls.append(("Approve", (approve,
1388
 
                                               dbus_interface)))
1389
 
        self.client = MockClient(
1390
 
            "foo",
1391
 
            KeyID=("92ed150794387c03ce684574b1139a65"
1392
 
                   "94a34f895daaaf09fd8ea90a27cddb12"),
1393
 
            Secret=b"secret",
1394
 
            Host="foo.example.org",
1395
 
            Enabled=dbus.Boolean(True),
1396
 
            Timeout=300000,
1397
 
            LastCheckedOK="2019-02-03T00:00:00",
1398
 
            Created="2019-01-02T00:00:00",
1399
 
            Interval=120000,
1400
 
            Fingerprint=("778827225BA7DE539C5A"
1401
 
                         "7CFA59CFF7CDBD9A5920"),
1402
 
            CheckerRunning=dbus.Boolean(False),
1403
 
            LastEnabled="2019-01-03T00:00:00",
1404
 
            ApprovalPending=dbus.Boolean(False),
1405
 
            ApprovedByDefault=dbus.Boolean(True),
1406
 
            LastApprovalRequest="",
1407
 
            ApprovalDelay=0,
1408
 
            ApprovalDuration=1000,
1409
 
            Checker="fping -q -- %(host)s",
1410
 
            ExtendedTimeout=900000,
1411
 
            Expires="2019-02-04T00:00:00",
1412
 
            LastCheckerStatus=0)
1413
 
        self.other_client = MockClient(
1414
 
            "barbar",
1415
 
            KeyID=("0558568eedd67d622f5c83b35a115f79"
1416
 
                   "6ab612cff5ad227247e46c2b020f441c"),
1417
 
            Secret=b"secretbar",
1418
 
            Host="192.0.2.3",
1419
 
            Enabled=dbus.Boolean(True),
1420
 
            Timeout=300000,
1421
 
            LastCheckedOK="2019-02-04T00:00:00",
1422
 
            Created="2019-01-03T00:00:00",
1423
 
            Interval=120000,
1424
 
            Fingerprint=("3E393AEAEFB84C7E89E2"
1425
 
                         "F547B3A107558FCA3A27"),
1426
 
            CheckerRunning=dbus.Boolean(True),
1427
 
            LastEnabled="2019-01-04T00:00:00",
1428
 
            ApprovalPending=dbus.Boolean(False),
1429
 
            ApprovedByDefault=dbus.Boolean(False),
1430
 
            LastApprovalRequest="2019-01-03T00:00:00",
1431
 
            ApprovalDelay=30000,
1432
 
            ApprovalDuration=93785000,
1433
 
            Checker=":",
1434
 
            ExtendedTimeout=900000,
1435
 
            Expires="2019-02-05T00:00:00",
1436
 
            LastCheckerStatus=-2)
1437
 
        self.clients =  collections.OrderedDict(
1438
 
            [
1439
 
                ("/clients/foo", self.client.attributes),
1440
 
                ("/clients/barbar", self.other_client.attributes),
1441
 
            ])
1442
 
        self.one_client = {"/clients/foo": self.client.attributes}
1443
 
 
1444
 
    @property
1445
 
    def bus(self):
1446
 
        class Bus(object):
1447
 
            @staticmethod
1448
 
            def get_object(client_bus_name, path):
1449
 
                self.assertEqual(client_bus_name, dbus_busname)
1450
 
                return {
1451
 
                    # Note: "self" here is the TestCmd instance, not
1452
 
                    # the Bus instance, since this is a static method!
1453
 
                    "/clients/foo": self.client,
1454
 
                    "/clients/barbar": self.other_client,
1455
 
                }[path]
1456
 
        return Bus()
 
1830
        self.bus = self.FakeMandosBus(self)
1457
1831
 
1458
1832
 
1459
1833
class TestBaseCommands(TestCommand):
1460
1834
 
1461
 
    def test_IsEnabled(self):
1462
 
        self.assertTrue(all(command.IsEnabled().is_enabled(client,
1463
 
                                                      properties)
1464
 
                            for client, properties
1465
 
                            in self.clients.items()))
1466
 
 
1467
 
    def test_IsEnabled_run_exits_successfully(self):
 
1835
    def test_IsEnabled_exits_successfully(self):
1468
1836
        with self.assertRaises(SystemExit) as e:
1469
 
            command.IsEnabled().run(self.one_client)
 
1837
            command.IsEnabled().run(self.bus.one_client)
1470
1838
        if e.exception.code is not None:
1471
 
            self.assertEqual(e.exception.code, 0)
 
1839
            self.assertEqual(0, e.exception.code)
1472
1840
        else:
1473
1841
            self.assertIsNone(e.exception.code)
1474
1842
 
1475
 
    def test_IsEnabled_run_exits_with_failure(self):
1476
 
        self.client.attributes["Enabled"] = dbus.Boolean(False)
 
1843
    def test_IsEnabled_exits_with_failure(self):
 
1844
        self.bus.client_properties["Enabled"] = False
1477
1845
        with self.assertRaises(SystemExit) as e:
1478
 
            command.IsEnabled().run(self.one_client)
 
1846
            command.IsEnabled().run(self.bus.one_client)
1479
1847
        if isinstance(e.exception.code, int):
1480
 
            self.assertNotEqual(e.exception.code, 0)
 
1848
            self.assertNotEqual(0, e.exception.code)
1481
1849
        else:
1482
1850
            self.assertIsNotNone(e.exception.code)
1483
1851
 
1484
1852
    def test_Approve(self):
1485
 
        command.Approve().run(self.clients, self.bus)
1486
 
        for clientpath in self.clients:
1487
 
            client = self.bus.get_object(dbus_busname, clientpath)
1488
 
            self.assertIn(("Approve", (True, client_dbus_interface)),
1489
 
                          client.calls)
 
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
1859
 
1491
1860
    def test_Deny(self):
1492
 
        command.Deny().run(self.clients, self.bus)
1493
 
        for clientpath in self.clients:
1494
 
            client = self.bus.get_object(dbus_busname, clientpath)
1495
 
            self.assertIn(("Approve", (False, client_dbus_interface)),
1496
 
                          client.calls)
 
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
1868
 
1498
1869
    def test_Remove(self):
1499
 
        class MockMandos(object):
1500
 
            def __init__(self):
1501
 
                self.calls = []
1502
 
            def RemoveClient(self, dbus_path):
1503
 
                self.calls.append(("RemoveClient", (dbus_path,)))
1504
 
        mandos = MockMandos()
1505
 
        command.Remove().run(self.clients, self.bus, mandos)
1506
 
        self.assertEqual(len(mandos.calls), 2)
1507
 
        for clientpath in self.clients:
1508
 
            self.assertIn(("RemoveClient", (clientpath,)),
1509
 
                          mandos.calls)
 
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)
1510
1875
 
1511
1876
    expected_json = {
1512
1877
        "foo": {
1560
1925
    }
1561
1926
 
1562
1927
    def test_DumpJSON_normal(self):
1563
 
        output = command.DumpJSON().output(self.clients.values())
1564
 
        json_data = json.loads(output)
1565
 
        self.assertDictEqual(json_data, self.expected_json)
 
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
1566
1943
 
1567
1944
    def test_DumpJSON_one_client(self):
1568
 
        output = command.DumpJSON().output(self.one_client.values())
1569
 
        json_data = json.loads(output)
 
1945
        with self.capture_stdout_to_buffer() as buffer:
 
1946
            command.DumpJSON().run(self.bus.one_client)
 
1947
        json_data = json.loads(buffer.getvalue())
1570
1948
        expected_json = {"foo": self.expected_json["foo"]}
1571
 
        self.assertDictEqual(json_data, expected_json)
 
1949
        self.assertDictEqual(expected_json, json_data)
1572
1950
 
1573
1951
    def test_PrintTable_normal(self):
1574
 
        output = command.PrintTable().output(self.clients.values())
 
1952
        with self.capture_stdout_to_buffer() as buffer:
 
1953
            command.PrintTable().run(self.bus.clients)
1575
1954
        expected_output = "\n".join((
1576
1955
            "Name   Enabled Timeout  Last Successful Check",
1577
1956
            "foo    Yes     00:05:00 2019-02-03T00:00:00  ",
1578
1957
            "barbar Yes     00:05:00 2019-02-04T00:00:00  ",
1579
 
        ))
1580
 
        self.assertEqual(output, expected_output)
 
1958
        )) + "\n"
 
1959
        self.assertEqual(expected_output, buffer.getvalue())
1581
1960
 
1582
1961
    def test_PrintTable_verbose(self):
1583
 
        output = command.PrintTable(verbose=True).output(
1584
 
            self.clients.values())
 
1962
        with self.capture_stdout_to_buffer() as buffer:
 
1963
            command.PrintTable(verbose=True).run(self.bus.clients)
1585
1964
        columns = (
1586
1965
            (
1587
1966
                "Name   ",
1669
2048
            )
1670
2049
        )
1671
2050
        num_lines = max(len(rows) for rows in columns)
1672
 
        expected_output = "\n".join("".join(rows[line]
1673
 
                                            for rows in columns)
1674
 
                                    for line in range(num_lines))
1675
 
        self.assertEqual(output, expected_output)
 
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
2056
 
1677
2057
    def test_PrintTable_one_client(self):
1678
 
        output = command.PrintTable().output(self.one_client.values())
 
2058
        with self.capture_stdout_to_buffer() as buffer:
 
2059
            command.PrintTable().run(self.bus.one_client)
1679
2060
        expected_output = "\n".join((
1680
2061
            "Name Enabled Timeout  Last Successful Check",
1681
2062
            "foo  Yes     00:05:00 2019-02-03T00:00:00  ",
1682
 
        ))
1683
 
        self.assertEqual(output, expected_output)
1684
 
 
1685
 
 
1686
 
class TestPropertyCmd(TestCommand):
1687
 
    """Abstract class for tests of command.Property classes"""
 
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
 
1688
2070
    def runTest(self):
1689
2071
        if not hasattr(self, "command"):
1690
 
            return
 
2072
            return              # Abstract TestCase class
1691
2073
        values_to_get = getattr(self, "values_to_get",
1692
2074
                                self.values_to_set)
1693
2075
        for value_to_set, value_to_get in zip(self.values_to_set,
1694
2076
                                              values_to_get):
1695
 
            for clientpath in self.clients:
1696
 
                client = self.bus.get_object(dbus_busname, clientpath)
1697
 
                old_value = client.attributes[self.propname]
1698
 
                self.assertNotIsInstance(old_value, self.Unique)
1699
 
                client.attributes[self.propname] = self.Unique()
1700
 
            self.run_command(value_to_set, self.clients)
1701
 
            for clientpath in self.clients:
1702
 
                client = self.bus.get_object(dbus_busname, clientpath)
1703
 
                value = client.attributes[self.propname]
1704
 
                self.assertNotIsInstance(value, self.Unique)
1705
 
                self.assertEqual(value, value_to_get)
1706
 
 
1707
 
    class Unique(object):
1708
 
        """Class for objects which exist only to be unique objects,
1709
 
since unittest.mock.sentinel only exists in Python 3.3"""
 
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)
1710
2084
 
1711
2085
    def run_command(self, value, clients):
1712
2086
        self.command().run(clients, self.bus)
1713
2087
 
1714
2088
 
1715
 
class TestEnableCmd(TestPropertyCmd):
 
2089
class TestEnableCmd(TestPropertySetterCmd):
1716
2090
    command = command.Enable
1717
2091
    propname = "Enabled"
1718
 
    values_to_set = [dbus.Boolean(True)]
1719
 
 
1720
 
 
1721
 
class TestDisableCmd(TestPropertyCmd):
 
2092
    values_to_set = [True]
 
2093
 
 
2094
 
 
2095
class TestDisableCmd(TestPropertySetterCmd):
1722
2096
    command = command.Disable
1723
2097
    propname = "Enabled"
1724
 
    values_to_set = [dbus.Boolean(False)]
1725
 
 
1726
 
 
1727
 
class TestBumpTimeoutCmd(TestPropertyCmd):
 
2098
    values_to_set = [False]
 
2099
 
 
2100
 
 
2101
class TestBumpTimeoutCmd(TestPropertySetterCmd):
1728
2102
    command = command.BumpTimeout
1729
2103
    propname = "LastCheckedOK"
1730
2104
    values_to_set = [""]
1731
2105
 
1732
2106
 
1733
 
class TestStartCheckerCmd(TestPropertyCmd):
 
2107
class TestStartCheckerCmd(TestPropertySetterCmd):
1734
2108
    command = command.StartChecker
1735
2109
    propname = "CheckerRunning"
1736
 
    values_to_set = [dbus.Boolean(True)]
1737
 
 
1738
 
 
1739
 
class TestStopCheckerCmd(TestPropertyCmd):
 
2110
    values_to_set = [True]
 
2111
 
 
2112
 
 
2113
class TestStopCheckerCmd(TestPropertySetterCmd):
1740
2114
    command = command.StopChecker
1741
2115
    propname = "CheckerRunning"
1742
 
    values_to_set = [dbus.Boolean(False)]
1743
 
 
1744
 
 
1745
 
class TestApproveByDefaultCmd(TestPropertyCmd):
 
2116
    values_to_set = [False]
 
2117
 
 
2118
 
 
2119
class TestApproveByDefaultCmd(TestPropertySetterCmd):
1746
2120
    command = command.ApproveByDefault
1747
2121
    propname = "ApprovedByDefault"
1748
 
    values_to_set = [dbus.Boolean(True)]
1749
 
 
1750
 
 
1751
 
class TestDenyByDefaultCmd(TestPropertyCmd):
 
2122
    values_to_set = [True]
 
2123
 
 
2124
 
 
2125
class TestDenyByDefaultCmd(TestPropertySetterCmd):
1752
2126
    command = command.DenyByDefault
1753
2127
    propname = "ApprovedByDefault"
1754
 
    values_to_set = [dbus.Boolean(False)]
1755
 
 
1756
 
 
1757
 
class TestPropertyValueCmd(TestPropertyCmd):
1758
 
    """Abstract class for tests of PropertyValueCmd classes"""
1759
 
 
1760
 
    def runTest(self):
1761
 
        if type(self) is TestPropertyValueCmd:
1762
 
            return
1763
 
        return super(TestPropertyValueCmd, self).runTest()
 
2128
    values_to_set = [False]
 
2129
 
 
2130
 
 
2131
class TestPropertySetterValueCmd(TestPropertySetterCmd):
 
2132
    """Abstract class for tests of PropertySetterValueCmd classes"""
1764
2133
 
1765
2134
    def run_command(self, value, clients):
1766
2135
        self.command(value).run(clients, self.bus)
1767
2136
 
1768
2137
 
1769
 
class TestSetCheckerCmd(TestPropertyValueCmd):
 
2138
class TestSetCheckerCmd(TestPropertySetterValueCmd):
1770
2139
    command = command.SetChecker
1771
2140
    propname = "Checker"
1772
2141
    values_to_set = ["", ":", "fping -q -- %s"]
1773
2142
 
1774
2143
 
1775
 
class TestSetHostCmd(TestPropertyValueCmd):
 
2144
class TestSetHostCmd(TestPropertySetterValueCmd):
1776
2145
    command = command.SetHost
1777
2146
    propname = "Host"
1778
 
    values_to_set = ["192.0.2.3", "foo.example.org"]
1779
 
 
1780
 
 
1781
 
class TestSetSecretCmd(TestPropertyValueCmd):
 
2147
    values_to_set = ["192.0.2.3", "client.example.org"]
 
2148
 
 
2149
 
 
2150
class TestSetSecretCmd(TestPropertySetterValueCmd):
1782
2151
    command = command.SetSecret
1783
2152
    propname = "Secret"
1784
2153
    values_to_set = [io.BytesIO(b""),
1785
2154
                     io.BytesIO(b"secret\0xyzzy\nbar")]
1786
 
    values_to_get = [b"", b"secret\0xyzzy\nbar"]
1787
 
 
1788
 
 
1789
 
class TestSetTimeoutCmd(TestPropertyValueCmd):
 
2155
    values_to_get = [f.getvalue() for f in values_to_set]
 
2156
 
 
2157
 
 
2158
class TestSetTimeoutCmd(TestPropertySetterValueCmd):
1790
2159
    command = command.SetTimeout
1791
2160
    propname = "Timeout"
1792
2161
    values_to_set = [datetime.timedelta(),
1794
2163
                     datetime.timedelta(seconds=1),
1795
2164
                     datetime.timedelta(weeks=1),
1796
2165
                     datetime.timedelta(weeks=52)]
1797
 
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1798
 
 
1799
 
 
1800
 
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
 
2166
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
 
2167
 
 
2168
 
 
2169
class TestSetExtendedTimeoutCmd(TestPropertySetterValueCmd):
1801
2170
    command = command.SetExtendedTimeout
1802
2171
    propname = "ExtendedTimeout"
1803
2172
    values_to_set = [datetime.timedelta(),
1805
2174
                     datetime.timedelta(seconds=1),
1806
2175
                     datetime.timedelta(weeks=1),
1807
2176
                     datetime.timedelta(weeks=52)]
1808
 
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1809
 
 
1810
 
 
1811
 
class TestSetIntervalCmd(TestPropertyValueCmd):
 
2177
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
 
2178
 
 
2179
 
 
2180
class TestSetIntervalCmd(TestPropertySetterValueCmd):
1812
2181
    command = command.SetInterval
1813
2182
    propname = "Interval"
1814
2183
    values_to_set = [datetime.timedelta(),
1816
2185
                     datetime.timedelta(seconds=1),
1817
2186
                     datetime.timedelta(weeks=1),
1818
2187
                     datetime.timedelta(weeks=52)]
1819
 
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1820
 
 
1821
 
 
1822
 
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
 
2188
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
 
2189
 
 
2190
 
 
2191
class TestSetApprovalDelayCmd(TestPropertySetterValueCmd):
1823
2192
    command = command.SetApprovalDelay
1824
2193
    propname = "ApprovalDelay"
1825
2194
    values_to_set = [datetime.timedelta(),
1827
2196
                     datetime.timedelta(seconds=1),
1828
2197
                     datetime.timedelta(weeks=1),
1829
2198
                     datetime.timedelta(weeks=52)]
1830
 
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1831
 
 
1832
 
 
1833
 
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
 
2199
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
 
2200
 
 
2201
 
 
2202
class TestSetApprovalDurationCmd(TestPropertySetterValueCmd):
1834
2203
    command = command.SetApprovalDuration
1835
2204
    propname = "ApprovalDuration"
1836
2205
    values_to_set = [datetime.timedelta(),
1838
2207
                     datetime.timedelta(seconds=1),
1839
2208
                     datetime.timedelta(weeks=1),
1840
2209
                     datetime.timedelta(weeks=52)]
1841
 
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
2210
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1842
2211
 
1843
2212
 
1844
2213