/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-16 00:10:31 UTC
  • Revision ID: teddy@recompile.se-20190316001031-c5v8it0q3qbvpskx
mandos-ctl: Refactor

* mandos-ctl (main): Call get_managed_objects() to get all client
                     paths and properties.
  (get_managed_objects): New.
  (Test_get_managed_objects): - '' -

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:
108
125
                log.critical("Client not found on server: %r", name)
109
126
                sys.exit(1)
110
127
 
 
128
    # Run all commands on clients
111
129
    commands = commands_from_options(options)
112
 
 
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):
215
232
    >>> rfc3339_duration_to_delta("")
216
233
    Traceback (most recent call last):
217
234
    ...
218
 
    ValueError: Invalid RFC 3339 duration: ""
 
235
    ValueError: Invalid RFC 3339 duration: u''
219
236
    >>> # Must start with "P":
220
237
    >>> rfc3339_duration_to_delta("1D")
221
238
    Traceback (most recent call last):
222
239
    ...
223
 
    ValueError: Invalid RFC 3339 duration: "1D"
 
240
    ValueError: Invalid RFC 3339 duration: u'1D'
224
241
    >>> # Must use correct order
225
242
    >>> rfc3339_duration_to_delta("PT1S2M")
226
243
    Traceback (most recent call last):
227
244
    ...
228
 
    ValueError: Invalid RFC 3339 duration: "PT1S2M"
 
245
    ValueError: Invalid RFC 3339 duration: u'PT1S2M'
229
246
    >>> # Time needs time marker
230
247
    >>> rfc3339_duration_to_delta("P1H2S")
231
248
    Traceback (most recent call last):
232
249
    ...
233
 
    ValueError: Invalid RFC 3339 duration: "P1H2S"
 
250
    ValueError: Invalid RFC 3339 duration: u'P1H2S'
234
251
    >>> # Weeks can not be combined with anything else
235
252
    >>> rfc3339_duration_to_delta("P1D2W")
236
253
    Traceback (most recent call last):
237
254
    ...
238
 
    ValueError: Invalid RFC 3339 duration: "P1D2W"
 
255
    ValueError: Invalid RFC 3339 duration: u'P1D2W'
239
256
    >>> rfc3339_duration_to_delta("P2W2H")
240
257
    Traceback (most recent call last):
241
258
    ...
242
 
    ValueError: Invalid RFC 3339 duration: "P2W2H"
 
259
    ValueError: Invalid RFC 3339 duration: u'P2W2H'
243
260
    """
244
261
 
245
262
    # Parsing an RFC 3339 duration with regular expressions is not
316
333
                break
317
334
        else:
318
335
            # No currently valid tokens were found
319
 
            raise ValueError("Invalid RFC 3339 duration: \"{}\""
 
336
            raise ValueError("Invalid RFC 3339 duration: {!r}"
320
337
                             .format(duration))
321
338
    # End token found
322
339
    return value
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
    try:
 
429
        log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
 
430
                  dbus_busname, server_dbus_path)
 
431
        mandos_dbus_object = bus.get_object(dbus_busname,
 
432
                                            server_dbus_path)
 
433
    except dbus.exceptions.DBusException:
 
434
        log.critical("Could not connect to Mandos server")
 
435
        sys.exit(1)
 
436
 
 
437
    return mandos_dbus_object
 
438
 
 
439
 
 
440
def get_managed_objects(object_manager):
 
441
    log.debug("D-Bus: %s:%s:%s.GetManagedObjects()", dbus_busname,
 
442
              server_dbus_path, dbus.OBJECT_MANAGER_IFACE)
 
443
    try:
 
444
        with SilenceLogger("dbus.proxies"):
 
445
            managed_objects = object_manager.GetManagedObjects()
 
446
    except dbus.exceptions.DBusException as e:
 
447
        log.critical("Failed to access Mandos server through D-Bus:"
 
448
                     "\n%s", e)
 
449
        sys.exit(1)
 
450
    return managed_objects
 
451
 
 
452
 
 
453
class SilenceLogger(object):
 
454
    "Simple context manager to silence a particular logger"
 
455
    def __init__(self, loggername):
 
456
        self.logger = logging.getLogger(loggername)
 
457
 
 
458
    def __enter__(self):
 
459
        self.logger.addFilter(self.nullfilter)
 
460
        return self
 
461
 
 
462
    class NullFilter(logging.Filter):
 
463
        def filter(self, record):
 
464
            return False
 
465
 
 
466
    nullfilter = NullFilter()
 
467
 
 
468
    def __exit__(self, exc_type, exc_val, exc_tb):
 
469
        self.logger.removeFilter(self.nullfilter)
550
470
 
551
471
 
552
472
def commands_from_options(options):
554
474
    commands = []
555
475
 
556
476
    if options.is_enabled:
557
 
        commands.append(command.IsEnabled())
 
477
        commands.append(IsEnabledCmd())
558
478
 
559
479
    if options.approve:
560
 
        commands.append(command.Approve())
 
480
        commands.append(ApproveCmd())
561
481
 
562
482
    if options.deny:
563
 
        commands.append(command.Deny())
 
483
        commands.append(DenyCmd())
564
484
 
565
485
    if options.remove:
566
 
        commands.append(command.Remove())
 
486
        commands.append(RemoveCmd())
567
487
 
568
488
    if options.dump_json:
569
 
        commands.append(command.DumpJSON())
 
489
        commands.append(DumpJSONCmd())
570
490
 
571
491
    if options.enable:
572
 
        commands.append(command.Enable())
 
492
        commands.append(EnableCmd())
573
493
 
574
494
    if options.disable:
575
 
        commands.append(command.Disable())
 
495
        commands.append(DisableCmd())
576
496
 
577
497
    if options.bump_timeout:
578
 
        commands.append(command.BumpTimeout())
 
498
        commands.append(BumpTimeoutCmd())
579
499
 
580
500
    if options.start_checker:
581
 
        commands.append(command.StartChecker())
 
501
        commands.append(StartCheckerCmd())
582
502
 
583
503
    if options.stop_checker:
584
 
        commands.append(command.StopChecker())
 
504
        commands.append(StopCheckerCmd())
585
505
 
586
506
    if options.approved_by_default is not None:
587
507
        if options.approved_by_default:
588
 
            commands.append(command.ApproveByDefault())
 
508
            commands.append(ApproveByDefaultCmd())
589
509
        else:
590
 
            commands.append(command.DenyByDefault())
 
510
            commands.append(DenyByDefaultCmd())
591
511
 
592
512
    if options.checker is not None:
593
 
        commands.append(command.SetChecker(options.checker))
 
513
        commands.append(SetCheckerCmd(options.checker))
594
514
 
595
515
    if options.host is not None:
596
 
        commands.append(command.SetHost(options.host))
 
516
        commands.append(SetHostCmd(options.host))
597
517
 
598
518
    if options.secret is not None:
599
 
        commands.append(command.SetSecret(options.secret))
 
519
        commands.append(SetSecretCmd(options.secret))
600
520
 
601
521
    if options.timeout is not None:
602
 
        commands.append(command.SetTimeout(options.timeout))
 
522
        commands.append(SetTimeoutCmd(options.timeout))
603
523
 
604
524
    if options.extended_timeout:
605
525
        commands.append(
606
 
            command.SetExtendedTimeout(options.extended_timeout))
 
526
            SetExtendedTimeoutCmd(options.extended_timeout))
607
527
 
608
528
    if options.interval is not None:
609
 
        commands.append(command.SetInterval(options.interval))
 
529
        commands.append(SetIntervalCmd(options.interval))
610
530
 
611
531
    if options.approval_delay is not None:
612
 
        commands.append(
613
 
            command.SetApprovalDelay(options.approval_delay))
 
532
        commands.append(SetApprovalDelayCmd(options.approval_delay))
614
533
 
615
534
    if options.approval_duration is not None:
616
535
        commands.append(
617
 
            command.SetApprovalDuration(options.approval_duration))
 
536
            SetApprovalDurationCmd(options.approval_duration))
618
537
 
619
538
    # If no command option has been given, show table of clients,
620
539
    # optionally verbosely
621
540
    if not commands:
622
 
        commands.append(command.PrintTable(verbose=options.verbose))
 
541
        commands.append(PrintTableCmd(verbose=options.verbose))
623
542
 
624
543
    return commands
625
544
 
626
545
 
627
 
class command(object):
628
 
    """A namespace for command classes"""
629
 
 
630
 
    class Base(object):
631
 
        """Abstract base class for commands"""
632
 
        def run(self, clients, bus=None):
633
 
            """Normal commands should implement run_on_one_client(),
634
 
but commands which want to operate on all clients at the same time can
635
 
override this run() method instead.
636
 
"""
637
 
            self.bus = bus
638
 
            for client, properties in clients.items():
639
 
                self.run_on_one_client(client, properties)
640
 
 
641
 
 
642
 
    class IsEnabled(Base):
643
 
        def run(self, clients, bus=None):
644
 
            properties = next(iter(clients.values()))
645
 
            if properties["Enabled"]:
646
 
                sys.exit(0)
647
 
            sys.exit(1)
648
 
 
649
 
 
650
 
    class Approve(Base):
651
 
        def run_on_one_client(self, client, properties):
652
 
            self.bus.call_client_method(client, "Approve", True)
653
 
 
654
 
 
655
 
    class Deny(Base):
656
 
        def run_on_one_client(self, client, properties):
657
 
            self.bus.call_client_method(client, "Approve", False)
658
 
 
659
 
 
660
 
    class Remove(Base):
661
 
        def run(self, clients, bus):
662
 
            for clientpath in frozenset(clients.keys()):
663
 
                bus.call_server_method("RemoveClient", clientpath)
664
 
 
665
 
 
666
 
    class Output(Base):
667
 
        """Abstract class for commands outputting client details"""
668
 
        all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
669
 
                        "Created", "Interval", "Host", "KeyID",
670
 
                        "Fingerprint", "CheckerRunning",
671
 
                        "LastEnabled", "ApprovalPending",
672
 
                        "ApprovedByDefault", "LastApprovalRequest",
673
 
                        "ApprovalDelay", "ApprovalDuration",
674
 
                        "Checker", "ExtendedTimeout", "Expires",
675
 
                        "LastCheckerStatus")
676
 
 
677
 
 
678
 
    class DumpJSON(Output):
679
 
        def run(self, clients, bus=None):
680
 
            data = {properties["Name"]:
681
 
                    {key: properties[key]
682
 
                     for key in self.all_keywords}
683
 
                    for properties in clients.values()}
684
 
            print(json.dumps(data, indent=4, separators=(',', ': ')))
685
 
 
686
 
 
687
 
    class PrintTable(Output):
688
 
        def __init__(self, verbose=False):
689
 
            self.verbose = verbose
690
 
 
691
 
        def run(self, clients, bus=None):
692
 
            default_keywords = ("Name", "Enabled", "Timeout",
693
 
                                "LastCheckedOK")
694
 
            keywords = default_keywords
695
 
            if self.verbose:
696
 
                keywords = self.all_keywords
697
 
            print(self.TableOfClients(clients.values(), keywords))
698
 
 
699
 
        class TableOfClients(object):
700
 
            tableheaders = {
701
 
                "Name": "Name",
702
 
                "Enabled": "Enabled",
703
 
                "Timeout": "Timeout",
704
 
                "LastCheckedOK": "Last Successful Check",
705
 
                "LastApprovalRequest": "Last Approval Request",
706
 
                "Created": "Created",
707
 
                "Interval": "Interval",
708
 
                "Host": "Host",
709
 
                "Fingerprint": "Fingerprint",
710
 
                "KeyID": "Key ID",
711
 
                "CheckerRunning": "Check Is Running",
712
 
                "LastEnabled": "Last Enabled",
713
 
                "ApprovalPending": "Approval Is Pending",
714
 
                "ApprovedByDefault": "Approved By Default",
715
 
                "ApprovalDelay": "Approval Delay",
716
 
                "ApprovalDuration": "Approval Duration",
717
 
                "Checker": "Checker",
718
 
                "ExtendedTimeout": "Extended Timeout",
719
 
                "Expires": "Expires",
720
 
                "LastCheckerStatus": "Last Checker Status",
721
 
            }
722
 
 
723
 
            def __init__(self, clients, keywords):
724
 
                self.clients = clients
725
 
                self.keywords = keywords
726
 
 
 
546
class Command(object):
 
547
    """Abstract class for commands"""
 
548
    def run(self, clients, bus=None, mandos=None):
 
549
        """Normal commands should implement run_on_one_client(), but
 
550
        commands which want to operate on all clients at the same time
 
551
        can override this run() method instead."""
 
552
        self.mandos = mandos
 
553
        for clientpath, properties in clients.items():
 
554
            log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
 
555
                      dbus_busname, str(clientpath))
 
556
            client = bus.get_object(dbus_busname, clientpath)
 
557
            self.run_on_one_client(client, properties)
 
558
 
 
559
 
 
560
class IsEnabledCmd(Command):
 
561
    def run(self, clients, bus=None, mandos=None):
 
562
        client, properties = next(iter(clients.items()))
 
563
        if self.is_enabled(client, properties):
 
564
            sys.exit(0)
 
565
        sys.exit(1)
 
566
    def is_enabled(self, client, properties):
 
567
        return properties["Enabled"]
 
568
 
 
569
 
 
570
class ApproveCmd(Command):
 
571
    def run_on_one_client(self, client, properties):
 
572
        log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
 
573
                  client.__dbus_object_path__, client_dbus_interface)
 
574
        client.Approve(dbus.Boolean(True),
 
575
                       dbus_interface=client_dbus_interface)
 
576
 
 
577
 
 
578
class DenyCmd(Command):
 
579
    def run_on_one_client(self, client, properties):
 
580
        log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
 
581
                  client.__dbus_object_path__, client_dbus_interface)
 
582
        client.Approve(dbus.Boolean(False),
 
583
                       dbus_interface=client_dbus_interface)
 
584
 
 
585
 
 
586
class RemoveCmd(Command):
 
587
    def run_on_one_client(self, client, properties):
 
588
        log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)", dbus_busname,
 
589
                  server_dbus_path, server_dbus_interface,
 
590
                  str(client.__dbus_object_path__))
 
591
        self.mandos.RemoveClient(client.__dbus_object_path__)
 
592
 
 
593
 
 
594
class OutputCmd(Command):
 
595
    """Abstract class for commands outputting client details"""
 
596
    all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
 
597
                    "Created", "Interval", "Host", "KeyID",
 
598
                    "Fingerprint", "CheckerRunning", "LastEnabled",
 
599
                    "ApprovalPending", "ApprovedByDefault",
 
600
                    "LastApprovalRequest", "ApprovalDelay",
 
601
                    "ApprovalDuration", "Checker", "ExtendedTimeout",
 
602
                    "Expires", "LastCheckerStatus")
 
603
 
 
604
    def run(self, clients, bus=None, mandos=None):
 
605
        print(self.output(clients.values()))
 
606
 
 
607
    def output(self, clients):
 
608
        raise NotImplementedError()
 
609
 
 
610
 
 
611
class DumpJSONCmd(OutputCmd):
 
612
    def output(self, clients):
 
613
        data = {client["Name"]:
 
614
                {key: self.dbus_boolean_to_bool(client[key])
 
615
                 for key in self.all_keywords}
 
616
                for client in clients}
 
617
        return json.dumps(data, indent=4, separators=(',', ': '))
 
618
 
 
619
    @staticmethod
 
620
    def dbus_boolean_to_bool(value):
 
621
        if isinstance(value, dbus.Boolean):
 
622
            value = bool(value)
 
623
        return value
 
624
 
 
625
 
 
626
class PrintTableCmd(OutputCmd):
 
627
    def __init__(self, verbose=False):
 
628
        self.verbose = verbose
 
629
 
 
630
    def output(self, clients):
 
631
        default_keywords = ("Name", "Enabled", "Timeout",
 
632
                            "LastCheckedOK")
 
633
        keywords = default_keywords
 
634
        if self.verbose:
 
635
            keywords = self.all_keywords
 
636
        return str(self.TableOfClients(clients, keywords))
 
637
 
 
638
    class TableOfClients(object):
 
639
        tableheaders = {
 
640
            "Name": "Name",
 
641
            "Enabled": "Enabled",
 
642
            "Timeout": "Timeout",
 
643
            "LastCheckedOK": "Last Successful Check",
 
644
            "LastApprovalRequest": "Last Approval Request",
 
645
            "Created": "Created",
 
646
            "Interval": "Interval",
 
647
            "Host": "Host",
 
648
            "Fingerprint": "Fingerprint",
 
649
            "KeyID": "Key ID",
 
650
            "CheckerRunning": "Check Is Running",
 
651
            "LastEnabled": "Last Enabled",
 
652
            "ApprovalPending": "Approval Is Pending",
 
653
            "ApprovedByDefault": "Approved By Default",
 
654
            "ApprovalDelay": "Approval Delay",
 
655
            "ApprovalDuration": "Approval Duration",
 
656
            "Checker": "Checker",
 
657
            "ExtendedTimeout": "Extended Timeout",
 
658
            "Expires": "Expires",
 
659
            "LastCheckerStatus": "Last Checker Status",
 
660
        }
 
661
 
 
662
        def __init__(self, clients, keywords):
 
663
            self.clients = clients
 
664
            self.keywords = keywords
 
665
 
 
666
        def __str__(self):
 
667
            return "\n".join(self.rows())
 
668
 
 
669
        if sys.version_info.major == 2:
 
670
            __unicode__ = __str__
727
671
            def __str__(self):
728
 
                return "\n".join(self.rows())
729
 
 
730
 
            if sys.version_info.major == 2:
731
 
                __unicode__ = __str__
732
 
                def __str__(self):
733
 
                    return str(self).encode(
734
 
                        locale.getpreferredencoding())
735
 
 
736
 
            def rows(self):
737
 
                format_string = self.row_formatting_string()
738
 
                rows = [self.header_line(format_string)]
739
 
                rows.extend(self.client_line(client, format_string)
740
 
                            for client in self.clients)
741
 
                return rows
742
 
 
743
 
            def row_formatting_string(self):
744
 
                "Format string used to format table rows"
745
 
                return " ".join("{{{key}:{width}}}".format(
746
 
                    width=max(len(self.tableheaders[key]),
747
 
                              *(len(self.string_from_client(client,
748
 
                                                            key))
749
 
                                for client in self.clients)),
750
 
                    key=key)
751
 
                                for key in self.keywords)
752
 
 
753
 
            def string_from_client(self, client, key):
754
 
                return self.valuetostring(client[key], key)
755
 
 
756
 
            @classmethod
757
 
            def valuetostring(cls, value, keyword):
758
 
                if isinstance(value, bool):
759
 
                    return "Yes" if value else "No"
760
 
                if keyword in ("Timeout", "Interval", "ApprovalDelay",
761
 
                               "ApprovalDuration", "ExtendedTimeout"):
762
 
                    return cls.milliseconds_to_string(value)
763
 
                return str(value)
764
 
 
765
 
            def header_line(self, format_string):
766
 
                return format_string.format(**self.tableheaders)
767
 
 
768
 
            def client_line(self, client, format_string):
769
 
                return format_string.format(
770
 
                    **{key: self.string_from_client(client, key)
771
 
                       for key in self.keywords})
772
 
 
773
 
            @staticmethod
774
 
            def milliseconds_to_string(ms):
775
 
                td = datetime.timedelta(0, 0, 0, ms)
776
 
                return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
777
 
                        .format(days="{}T".format(td.days)
778
 
                                if td.days else "",
779
 
                                hours=td.seconds // 3600,
780
 
                                minutes=(td.seconds % 3600) // 60,
781
 
                                seconds=td.seconds % 60))
782
 
 
783
 
 
784
 
    class PropertySetter(Base):
785
 
        "Abstract class for Actions for setting one client property"
786
 
 
787
 
        def run_on_one_client(self, client, properties=None):
788
 
            """Set the Client's D-Bus property"""
789
 
            self.bus.set_client_property(client, self.propname,
790
 
                                         self.value_to_set)
791
 
 
792
 
        @property
793
 
        def propname(self):
794
 
            raise NotImplementedError()
795
 
 
796
 
 
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):
808
 
        propname = "LastCheckedOK"
809
 
        value_to_set = ""
810
 
 
811
 
 
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."""
835
 
        def __init__(self, value):
836
 
            self.value_to_set = value
837
 
 
838
 
 
839
 
    class SetChecker(PropertySetterValue):
840
 
        propname = "Checker"
841
 
 
842
 
 
843
 
    class SetHost(PropertySetterValue):
844
 
        propname = "Host"
845
 
 
846
 
 
847
 
    class SetSecret(PropertySetterValue):
848
 
        propname = "Secret"
849
 
 
850
 
        @property
851
 
        def value_to_set(self):
852
 
            return self._vts
853
 
 
854
 
        @value_to_set.setter
855
 
        def value_to_set(self, value):
856
 
            """When setting, read data from supplied file object"""
857
 
            self._vts = value.read()
858
 
            value.close()
859
 
 
860
 
 
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."""
865
 
 
866
 
        @property
867
 
        def value_to_set(self):
868
 
            return self._vts
869
 
 
870
 
        @value_to_set.setter
871
 
        def value_to_set(self, value):
872
 
            "When setting, convert value from a datetime.timedelta"
873
 
            self._vts = int(round(value.total_seconds() * 1000))
874
 
 
875
 
 
876
 
    class SetTimeout(PropertySetterValueMilliseconds):
877
 
        propname = "Timeout"
878
 
 
879
 
 
880
 
    class SetExtendedTimeout(PropertySetterValueMilliseconds):
881
 
        propname = "ExtendedTimeout"
882
 
 
883
 
 
884
 
    class SetInterval(PropertySetterValueMilliseconds):
885
 
        propname = "Interval"
886
 
 
887
 
 
888
 
    class SetApprovalDelay(PropertySetterValueMilliseconds):
889
 
        propname = "ApprovalDelay"
890
 
 
891
 
 
892
 
    class SetApprovalDuration(PropertySetterValueMilliseconds):
893
 
        propname = "ApprovalDuration"
 
672
                return str(self).encode(locale.getpreferredencoding())
 
673
 
 
674
        def rows(self):
 
675
            format_string = self.row_formatting_string()
 
676
            rows = [self.header_line(format_string)]
 
677
            rows.extend(self.client_line(client, format_string)
 
678
                        for client in self.clients)
 
679
            return rows
 
680
 
 
681
        def row_formatting_string(self):
 
682
            "Format string used to format table rows"
 
683
            return " ".join("{{{key}:{width}}}".format(
 
684
                width=max(len(self.tableheaders[key]),
 
685
                          *(len(self.string_from_client(client, key))
 
686
                            for client in self.clients)),
 
687
                key=key)
 
688
                            for key in self.keywords)
 
689
 
 
690
        def string_from_client(self, client, key):
 
691
            return self.valuetostring(client[key], key)
 
692
 
 
693
        @classmethod
 
694
        def valuetostring(cls, value, keyword):
 
695
            if isinstance(value, dbus.Boolean):
 
696
                return "Yes" if value else "No"
 
697
            if keyword in ("Timeout", "Interval", "ApprovalDelay",
 
698
                           "ApprovalDuration", "ExtendedTimeout"):
 
699
                return cls.milliseconds_to_string(value)
 
700
            return str(value)
 
701
 
 
702
        def header_line(self, format_string):
 
703
            return format_string.format(**self.tableheaders)
 
704
 
 
705
        def client_line(self, client, format_string):
 
706
            return format_string.format(
 
707
                **{key: self.string_from_client(client, key)
 
708
                   for key in self.keywords})
 
709
 
 
710
        @staticmethod
 
711
        def milliseconds_to_string(ms):
 
712
            td = datetime.timedelta(0, 0, 0, ms)
 
713
            return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
 
714
                    .format(days="{}T".format(td.days)
 
715
                            if td.days else "",
 
716
                            hours=td.seconds // 3600,
 
717
                            minutes=(td.seconds % 3600) // 60,
 
718
                            seconds=td.seconds % 60))
 
719
 
 
720
 
 
721
class PropertyCmd(Command):
 
722
    """Abstract class for Actions for setting one client property"""
 
723
 
 
724
    def run_on_one_client(self, client, properties):
 
725
        """Set the Client's D-Bus property"""
 
726
        log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
 
727
                  client.__dbus_object_path__,
 
728
                  dbus.PROPERTIES_IFACE, client_dbus_interface,
 
729
                  self.propname, self.value_to_set
 
730
                  if not isinstance(self.value_to_set, dbus.Boolean)
 
731
                  else bool(self.value_to_set))
 
732
        client.Set(client_dbus_interface, self.propname,
 
733
                   self.value_to_set,
 
734
                   dbus_interface=dbus.PROPERTIES_IFACE)
 
735
 
 
736
    @property
 
737
    def propname(self):
 
738
        raise NotImplementedError()
 
739
 
 
740
 
 
741
class EnableCmd(PropertyCmd):
 
742
    propname = "Enabled"
 
743
    value_to_set = dbus.Boolean(True)
 
744
 
 
745
 
 
746
class DisableCmd(PropertyCmd):
 
747
    propname = "Enabled"
 
748
    value_to_set = dbus.Boolean(False)
 
749
 
 
750
 
 
751
class BumpTimeoutCmd(PropertyCmd):
 
752
    propname = "LastCheckedOK"
 
753
    value_to_set = ""
 
754
 
 
755
 
 
756
class StartCheckerCmd(PropertyCmd):
 
757
    propname = "CheckerRunning"
 
758
    value_to_set = dbus.Boolean(True)
 
759
 
 
760
 
 
761
class StopCheckerCmd(PropertyCmd):
 
762
    propname = "CheckerRunning"
 
763
    value_to_set = dbus.Boolean(False)
 
764
 
 
765
 
 
766
class ApproveByDefaultCmd(PropertyCmd):
 
767
    propname = "ApprovedByDefault"
 
768
    value_to_set = dbus.Boolean(True)
 
769
 
 
770
 
 
771
class DenyByDefaultCmd(PropertyCmd):
 
772
    propname = "ApprovedByDefault"
 
773
    value_to_set = dbus.Boolean(False)
 
774
 
 
775
 
 
776
class PropertyValueCmd(PropertyCmd):
 
777
    """Abstract class for PropertyCmd recieving a value as argument"""
 
778
    def __init__(self, value):
 
779
        self.value_to_set = value
 
780
 
 
781
 
 
782
class SetCheckerCmd(PropertyValueCmd):
 
783
    propname = "Checker"
 
784
 
 
785
 
 
786
class SetHostCmd(PropertyValueCmd):
 
787
    propname = "Host"
 
788
 
 
789
 
 
790
class SetSecretCmd(PropertyValueCmd):
 
791
    propname = "Secret"
 
792
 
 
793
    @property
 
794
    def value_to_set(self):
 
795
        return self._vts
 
796
 
 
797
    @value_to_set.setter
 
798
    def value_to_set(self, value):
 
799
        """When setting, read data from supplied file object"""
 
800
        self._vts = value.read()
 
801
        value.close()
 
802
 
 
803
 
 
804
class MillisecondsPropertyValueArgumentCmd(PropertyValueCmd):
 
805
    """Abstract class for PropertyValueCmd taking a value argument as
 
806
a datetime.timedelta() but should store it as milliseconds."""
 
807
 
 
808
    @property
 
809
    def value_to_set(self):
 
810
        return self._vts
 
811
 
 
812
    @value_to_set.setter
 
813
    def value_to_set(self, value):
 
814
        """When setting, convert value from a datetime.timedelta"""
 
815
        self._vts = int(round(value.total_seconds() * 1000))
 
816
 
 
817
 
 
818
class SetTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
 
819
    propname = "Timeout"
 
820
 
 
821
 
 
822
class SetExtendedTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
 
823
    propname = "ExtendedTimeout"
 
824
 
 
825
 
 
826
class SetIntervalCmd(MillisecondsPropertyValueArgumentCmd):
 
827
    propname = "Interval"
 
828
 
 
829
 
 
830
class SetApprovalDelayCmd(MillisecondsPropertyValueArgumentCmd):
 
831
    propname = "ApprovalDelay"
 
832
 
 
833
 
 
834
class SetApprovalDurationCmd(MillisecondsPropertyValueArgumentCmd):
 
835
    propname = "ApprovalDuration"
894
836
 
895
837
 
896
838
 
897
 
class TestCaseWithAssertLogs(unittest.TestCase):
898
 
    """unittest.TestCase.assertLogs only exists in Python 3.4"""
899
 
 
900
 
    if not hasattr(unittest.TestCase, "assertLogs"):
901
 
        @contextlib.contextmanager
902
 
        def assertLogs(self, logger, level=logging.INFO):
903
 
            capturing_handler = self.CapturingLevelHandler(level)
904
 
            old_level = logger.level
905
 
            old_propagate = logger.propagate
906
 
            logger.addHandler(capturing_handler)
907
 
            logger.setLevel(level)
908
 
            logger.propagate = False
909
 
            try:
910
 
                yield capturing_handler.watcher
911
 
            finally:
912
 
                logger.propagate = old_propagate
913
 
                logger.removeHandler(capturing_handler)
914
 
                logger.setLevel(old_level)
915
 
            self.assertGreater(len(capturing_handler.watcher.records),
916
 
                               0)
917
 
 
918
 
        class CapturingLevelHandler(logging.Handler):
919
 
            def __init__(self, level, *args, **kwargs):
920
 
                logging.Handler.__init__(self, *args, **kwargs)
921
 
                self.watcher = self.LoggingWatcher([], [])
922
 
            def emit(self, record):
923
 
                self.watcher.records.append(record)
924
 
                self.watcher.output.append(self.format(record))
925
 
 
926
 
            LoggingWatcher = collections.namedtuple("LoggingWatcher",
927
 
                                                    ("records",
928
 
                                                     "output"))
929
 
 
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
 
 
936
 
class Test_string_to_delta(TestCaseWithAssertLogs):
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"))
 
839
class Test_string_to_delta(unittest.TestCase):
 
840
    def test_handles_basic_rfc3339(self):
 
841
        self.assertEqual(string_to_delta("PT0S"),
 
842
                         datetime.timedelta())
 
843
        self.assertEqual(string_to_delta("P0D"),
 
844
                         datetime.timedelta())
 
845
        self.assertEqual(string_to_delta("PT1S"),
 
846
                         datetime.timedelta(0, 1))
 
847
        self.assertEqual(string_to_delta("PT2H"),
 
848
                         datetime.timedelta(0, 7200))
955
849
 
956
850
    def test_falls_back_to_pre_1_6_1_with_warning(self):
957
 
        with self.assertLogs(log, logging.WARNING):
958
 
            value = string_to_delta("2h")
959
 
        self.assertEqual(datetime.timedelta(0, 7200), value)
 
851
        # assertLogs only exists in Python 3.4
 
852
        if hasattr(self, "assertLogs"):
 
853
            with self.assertLogs(log, logging.WARNING):
 
854
                value = string_to_delta("2h")
 
855
        else:
 
856
            class WarningFilter(logging.Filter):
 
857
                """Don't show, but record the presence of, warnings"""
 
858
                def filter(self, record):
 
859
                    is_warning = record.levelno >= logging.WARNING
 
860
                    self.found = is_warning or getattr(self, "found",
 
861
                                                       False)
 
862
                    return not is_warning
 
863
            warning_filter = WarningFilter()
 
864
            log.addFilter(warning_filter)
 
865
            try:
 
866
                value = string_to_delta("2h")
 
867
            finally:
 
868
                log.removeFilter(warning_filter)
 
869
            self.assertTrue(getattr(warning_filter, "found", False))
 
870
        self.assertEqual(value, datetime.timedelta(0, 7200))
960
871
 
961
872
 
962
873
class Test_check_option_syntax(unittest.TestCase):
1000
911
    @contextlib.contextmanager
1001
912
    def assertParseError(self):
1002
913
        with self.assertRaises(SystemExit) as e:
1003
 
            with self.redirect_stderr_to_devnull():
 
914
            with self.temporarily_suppress_stderr():
1004
915
                yield
1005
916
        # Exit code from argparse is guaranteed to be "2".  Reference:
1006
917
        # https://docs.python.org/3/library
1007
918
        # /argparse.html#exiting-methods
1008
 
        self.assertEqual(2, e.exception.code)
 
919
        self.assertEqual(e.exception.code, 2)
1009
920
 
1010
921
    @staticmethod
1011
922
    @contextlib.contextmanager
1012
 
    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
 
923
    def temporarily_suppress_stderr():
 
924
        null = os.open(os.path.devnull, os.O_RDWR)
 
925
        stderrcopy = os.dup(sys.stderr.fileno())
 
926
        os.dup2(null, sys.stderr.fileno())
 
927
        os.close(null)
 
928
        try:
 
929
            yield
 
930
        finally:
 
931
            # restore stderr
 
932
            os.dup2(stderrcopy, sys.stderr.fileno())
 
933
            os.close(stderrcopy)
1020
934
 
1021
935
    def check_option_syntax(self, options):
1022
936
        check_option_syntax(self.parser, options)
1023
937
 
1024
 
    def test_actions_all_conflicts_with_verbose(self):
1025
 
        for action, value in self.actions.items():
1026
 
            options = self.parser.parse_args()
1027
 
            setattr(options, action, value)
1028
 
            options.all = True
1029
 
            options.verbose = True
1030
 
            with self.assertParseError():
1031
 
                self.check_option_syntax(options)
1032
 
 
1033
 
    def test_actions_with_client_conflicts_with_verbose(self):
1034
 
        for action, value in self.actions.items():
1035
 
            options = self.parser.parse_args()
1036
 
            setattr(options, action, value)
1037
 
            options.verbose = True
1038
 
            options.client = ["client"]
 
938
    def test_actions_conflicts_with_verbose(self):
 
939
        for action, value in self.actions.items():
 
940
            options = self.parser.parse_args()
 
941
            setattr(options, action, value)
 
942
            options.verbose = True
1039
943
            with self.assertParseError():
1040
944
                self.check_option_syntax(options)
1041
945
 
1067
971
            options.all = True
1068
972
            self.check_option_syntax(options)
1069
973
 
1070
 
    def test_any_action_is_ok_with_one_client(self):
1071
 
        for action, value in self.actions.items():
1072
 
            options = self.parser.parse_args()
1073
 
            setattr(options, action, value)
1074
 
            options.client = ["client"]
1075
 
            self.check_option_syntax(options)
1076
 
 
1077
 
    def test_one_client_with_all_actions_except_is_enabled(self):
1078
 
        options = self.parser.parse_args()
1079
 
        for action, value in self.actions.items():
1080
 
            if action == "is_enabled":
1081
 
                continue
1082
 
            setattr(options, action, value)
1083
 
        options.client = ["client"]
1084
 
        self.check_option_syntax(options)
1085
 
 
1086
 
    def test_two_clients_with_all_actions_except_is_enabled(self):
1087
 
        options = self.parser.parse_args()
1088
 
        for action, value in self.actions.items():
1089
 
            if action == "is_enabled":
1090
 
                continue
1091
 
            setattr(options, action, value)
1092
 
        options.client = ["client1", "client2"]
1093
 
        self.check_option_syntax(options)
1094
 
 
1095
 
    def test_two_clients_are_ok_with_actions_except_is_enabled(self):
1096
 
        for action, value in self.actions.items():
1097
 
            if action == "is_enabled":
1098
 
                continue
1099
 
            options = self.parser.parse_args()
1100
 
            setattr(options, action, value)
1101
 
            options.client = ["client1", "client2"]
1102
 
            self.check_option_syntax(options)
1103
 
 
1104
974
    def test_is_enabled_fails_without_client(self):
1105
975
        options = self.parser.parse_args()
1106
976
        options.is_enabled = True
1107
977
        with self.assertParseError():
1108
978
            self.check_option_syntax(options)
1109
979
 
 
980
    def test_is_enabled_works_with_one_client(self):
 
981
        options = self.parser.parse_args()
 
982
        options.is_enabled = True
 
983
        options.client = ["foo"]
 
984
        self.check_option_syntax(options)
 
985
 
1110
986
    def test_is_enabled_fails_with_two_clients(self):
1111
987
        options = self.parser.parse_args()
1112
988
        options.is_enabled = True
1113
 
        options.client = ["client1", "client2"]
 
989
        options.client = ["foo", "barbar"]
1114
990
        with self.assertParseError():
1115
991
            self.check_option_syntax(options)
1116
992
 
1126
1002
                self.check_option_syntax(options)
1127
1003
 
1128
1004
 
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
 
1005
class Test_get_mandos_dbus_object(unittest.TestCase):
 
1006
    def test_calls_and_returns_get_object_on_bus(self):
 
1007
        class MockBus(object):
 
1008
            called = False
 
1009
            def get_object(mockbus_self, busname, dbus_path):
 
1010
                # Note that "self" is still the testcase instance,
 
1011
                # this MockBus instance is in "mockbus_self".
 
1012
                self.assertEqual(busname, dbus_busname)
 
1013
                self.assertEqual(dbus_path, server_dbus_path)
 
1014
                mockbus_self.called = True
 
1015
                return mockbus_self
 
1016
 
 
1017
        mockbus = get_mandos_dbus_object(bus=MockBus())
 
1018
        self.assertIsInstance(mockbus, MockBus)
 
1019
        self.assertTrue(mockbus.called)
 
1020
 
 
1021
    def test_logs_and_exits_on_dbus_error(self):
 
1022
        class MockBusFailing(object):
 
1023
            def get_object(self, busname, dbus_path):
 
1024
                raise dbus.exceptions.DBusException("Test")
 
1025
 
 
1026
        # assertLogs only exists in Python 3.4
 
1027
        if hasattr(self, "assertLogs"):
 
1028
            with self.assertLogs(log, logging.CRITICAL):
 
1029
                with self.assertRaises(SystemExit) as e:
 
1030
                    bus = get_mandos_dbus_object(bus=MockBus())
 
1031
        else:
 
1032
            critical_filter = self.CriticalFilter()
 
1033
            log.addFilter(critical_filter)
 
1034
            try:
 
1035
                with self.assertRaises(SystemExit) as e:
 
1036
                    get_mandos_dbus_object(bus=MockBusFailing())
 
1037
            finally:
 
1038
                log.removeFilter(critical_filter)
 
1039
            self.assertTrue(critical_filter.found)
 
1040
        if isinstance(e.exception.code, int):
 
1041
            self.assertNotEqual(e.exception.code, 0)
 
1042
        else:
 
1043
            self.assertIsNotNone(e.exception.code)
 
1044
 
 
1045
    class CriticalFilter(logging.Filter):
 
1046
        """Don't show, but register, critical messages"""
 
1047
        found = False
 
1048
        def filter(self, record):
 
1049
            is_critical = record.levelno >= logging.CRITICAL
 
1050
            self.found = is_critical or self.found
 
1051
            return not is_critical
 
1052
 
 
1053
 
 
1054
class Test_get_managed_objects(unittest.TestCase):
 
1055
    def test_calls_and_returns_GetManagedObjects(self):
 
1056
        managed_objects = {"/clients/foo": { "Name": "foo"}}
 
1057
        class MockObjectManager(object):
 
1058
            @staticmethod
 
1059
            def GetManagedObjects():
 
1060
                return managed_objects
 
1061
        retval = get_managed_objects(MockObjectManager())
 
1062
        self.assertDictEqual(managed_objects, retval)
 
1063
 
 
1064
    def test_logs_and_exits_on_dbus_error(self):
 
1065
        class MockObjectManagerFailing(object):
 
1066
            @staticmethod
 
1067
            def GetManagedObjects():
 
1068
                raise dbus.exceptions.DBusException("Test")
 
1069
 
 
1070
        if hasattr(self, "assertLogs"):
 
1071
            with self.assertLogs(log, logging.CRITICAL):
 
1072
                with self.assertRaises(SystemExit):
 
1073
                    get_managed_objects(MockObjectManagerFailing())
 
1074
        else:
 
1075
            critical_filter = self.CriticalFilter()
 
1076
            log.addFilter(critical_filter)
 
1077
            try:
 
1078
                with self.assertRaises(SystemExit) as e:
 
1079
                    get_managed_objects(MockObjectManagerFailing())
 
1080
            finally:
 
1081
                log.removeFilter(critical_filter)
 
1082
            self.assertTrue(critical_filter.found)
 
1083
        if isinstance(e.exception.code, int):
 
1084
            self.assertNotEqual(e.exception.code, 0)
 
1085
        else:
 
1086
            self.assertIsNotNone(e.exception.code)
 
1087
 
 
1088
    class CriticalFilter(logging.Filter):
 
1089
        """Don't show, but register, critical messages"""
 
1090
        found = False
 
1091
        def filter(self, record):
 
1092
            is_critical = record.levelno >= logging.CRITICAL
 
1093
            self.found = is_critical or self.found
 
1094
            return not is_critical
 
1095
 
 
1096
 
 
1097
class Test_SilenceLogger(unittest.TestCase):
 
1098
    loggername = "mandos-ctl.Test_SilenceLogger"
 
1099
    log = logging.getLogger(loggername)
 
1100
    log.propagate = False
 
1101
    log.addHandler(logging.NullHandler())
1152
1102
 
1153
1103
    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):
1415
 
        dbus_logger = logging.getLogger("dbus.proxies")
1416
 
 
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)
1423
 
 
1424
 
        class CountingHandler(logging.Handler):
1425
 
            count = 0
1426
 
            def emit(self, record):
1427
 
                self.count += 1
1428
 
 
1429
 
        counting_handler = CountingHandler()
1430
 
 
1431
 
        dbus_logger.addHandler(counting_handler)
1432
 
 
 
1104
        self.counting_filter = self.CountingFilter()
 
1105
 
 
1106
    class CountingFilter(logging.Filter):
 
1107
        "Count number of records"
 
1108
        count = 0
 
1109
        def filter(self, record):
 
1110
            self.count += 1
 
1111
            return True
 
1112
 
 
1113
    def test_should_filter_records_only_when_active(self):
1433
1114
        try:
1434
 
            with self.assertRaises(dbus.Error) as e:
1435
 
                self.call_method(bus, "methodname", "busname",
1436
 
                                 "objectpath", "interface")
 
1115
            with SilenceLogger(self.loggername):
 
1116
                self.log.addFilter(self.counting_filter)
 
1117
                self.log.info("Filtered log message 1")
 
1118
            self.log.info("Non-filtered message 2")
 
1119
            self.log.info("Non-filtered message 3")
1437
1120
        finally:
1438
 
            dbus_logger.removeFilter(counting_handler)
1439
 
 
1440
 
        self.assertNotIsInstance(e, dbus.ConnectFailed)
1441
 
 
1442
 
        # 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)
 
1121
            self.log.removeFilter(self.counting_filter)
 
1122
        self.assertEqual(self.counting_filter.count, 2)
1517
1123
 
1518
1124
 
1519
1125
class Test_commands_from_options(unittest.TestCase):
1520
 
 
1521
1126
    def setUp(self):
1522
1127
        self.parser = argparse.ArgumentParser()
1523
1128
        add_command_line_options(self.parser)
1524
1129
 
1525
1130
    def test_is_enabled(self):
1526
 
        self.assert_command_from_args(["--is-enabled", "client"],
1527
 
                                      command.IsEnabled)
 
1131
        self.assert_command_from_args(["--is-enabled", "foo"],
 
1132
                                      IsEnabledCmd)
1528
1133
 
1529
1134
    def assert_command_from_args(self, args, command_cls,
1530
1135
                                 **cmd_attrs):
1533
1138
        options = self.parser.parse_args(args)
1534
1139
        check_option_syntax(self.parser, options)
1535
1140
        commands = commands_from_options(options)
1536
 
        self.assertEqual(1, len(commands))
 
1141
        self.assertEqual(len(commands), 1)
1537
1142
        command = commands[0]
1538
1143
        self.assertIsInstance(command, command_cls)
1539
1144
        for key, value in cmd_attrs.items():
1540
 
            self.assertEqual(value, getattr(command, key))
 
1145
            self.assertEqual(getattr(command, key), value)
1541
1146
 
1542
1147
    def test_is_enabled_short(self):
1543
 
        self.assert_command_from_args(["-V", "client"],
1544
 
                                      command.IsEnabled)
 
1148
        self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
1545
1149
 
1546
1150
    def test_approve(self):
1547
 
        self.assert_command_from_args(["--approve", "client"],
1548
 
                                      command.Approve)
 
1151
        self.assert_command_from_args(["--approve", "foo"],
 
1152
                                      ApproveCmd)
1549
1153
 
1550
1154
    def test_approve_short(self):
1551
 
        self.assert_command_from_args(["-A", "client"],
1552
 
                                      command.Approve)
 
1155
        self.assert_command_from_args(["-A", "foo"], ApproveCmd)
1553
1156
 
1554
1157
    def test_deny(self):
1555
 
        self.assert_command_from_args(["--deny", "client"],
1556
 
                                      command.Deny)
 
1158
        self.assert_command_from_args(["--deny", "foo"], DenyCmd)
1557
1159
 
1558
1160
    def test_deny_short(self):
1559
 
        self.assert_command_from_args(["-D", "client"], command.Deny)
 
1161
        self.assert_command_from_args(["-D", "foo"], DenyCmd)
1560
1162
 
1561
1163
    def test_remove(self):
1562
 
        self.assert_command_from_args(["--remove", "client"],
1563
 
                                      command.Remove)
 
1164
        self.assert_command_from_args(["--remove", "foo"],
 
1165
                                      RemoveCmd)
1564
1166
 
1565
1167
    def test_deny_before_remove(self):
1566
1168
        options = self.parser.parse_args(["--deny", "--remove",
1567
 
                                          "client"])
 
1169
                                          "foo"])
1568
1170
        check_option_syntax(self.parser, options)
1569
1171
        commands = commands_from_options(options)
1570
 
        self.assertEqual(2, len(commands))
1571
 
        self.assertIsInstance(commands[0], command.Deny)
1572
 
        self.assertIsInstance(commands[1], command.Remove)
 
1172
        self.assertEqual(len(commands), 2)
 
1173
        self.assertIsInstance(commands[0], DenyCmd)
 
1174
        self.assertIsInstance(commands[1], RemoveCmd)
1573
1175
 
1574
1176
    def test_deny_before_remove_reversed(self):
1575
1177
        options = self.parser.parse_args(["--remove", "--deny",
1576
1178
                                          "--all"])
1577
1179
        check_option_syntax(self.parser, options)
1578
1180
        commands = commands_from_options(options)
1579
 
        self.assertEqual(2, len(commands))
1580
 
        self.assertIsInstance(commands[0], command.Deny)
1581
 
        self.assertIsInstance(commands[1], command.Remove)
 
1181
        self.assertEqual(len(commands), 2)
 
1182
        self.assertIsInstance(commands[0], DenyCmd)
 
1183
        self.assertIsInstance(commands[1], RemoveCmd)
1582
1184
 
1583
1185
    def test_remove_short(self):
1584
 
        self.assert_command_from_args(["-r", "client"],
1585
 
                                      command.Remove)
 
1186
        self.assert_command_from_args(["-r", "foo"], RemoveCmd)
1586
1187
 
1587
1188
    def test_dump_json(self):
1588
 
        self.assert_command_from_args(["--dump-json"],
1589
 
                                      command.DumpJSON)
 
1189
        self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
1590
1190
 
1591
1191
    def test_enable(self):
1592
 
        self.assert_command_from_args(["--enable", "client"],
1593
 
                                      command.Enable)
 
1192
        self.assert_command_from_args(["--enable", "foo"], EnableCmd)
1594
1193
 
1595
1194
    def test_enable_short(self):
1596
 
        self.assert_command_from_args(["-e", "client"],
1597
 
                                      command.Enable)
 
1195
        self.assert_command_from_args(["-e", "foo"], EnableCmd)
1598
1196
 
1599
1197
    def test_disable(self):
1600
 
        self.assert_command_from_args(["--disable", "client"],
1601
 
                                      command.Disable)
 
1198
        self.assert_command_from_args(["--disable", "foo"],
 
1199
                                      DisableCmd)
1602
1200
 
1603
1201
    def test_disable_short(self):
1604
 
        self.assert_command_from_args(["-d", "client"],
1605
 
                                      command.Disable)
 
1202
        self.assert_command_from_args(["-d", "foo"], DisableCmd)
1606
1203
 
1607
1204
    def test_bump_timeout(self):
1608
 
        self.assert_command_from_args(["--bump-timeout", "client"],
1609
 
                                      command.BumpTimeout)
 
1205
        self.assert_command_from_args(["--bump-timeout", "foo"],
 
1206
                                      BumpTimeoutCmd)
1610
1207
 
1611
1208
    def test_bump_timeout_short(self):
1612
 
        self.assert_command_from_args(["-b", "client"],
1613
 
                                      command.BumpTimeout)
 
1209
        self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
1614
1210
 
1615
1211
    def test_start_checker(self):
1616
 
        self.assert_command_from_args(["--start-checker", "client"],
1617
 
                                      command.StartChecker)
 
1212
        self.assert_command_from_args(["--start-checker", "foo"],
 
1213
                                      StartCheckerCmd)
1618
1214
 
1619
1215
    def test_stop_checker(self):
1620
 
        self.assert_command_from_args(["--stop-checker", "client"],
1621
 
                                      command.StopChecker)
 
1216
        self.assert_command_from_args(["--stop-checker", "foo"],
 
1217
                                      StopCheckerCmd)
1622
1218
 
1623
1219
    def test_approve_by_default(self):
1624
 
        self.assert_command_from_args(["--approve-by-default",
1625
 
                                       "client"],
1626
 
                                      command.ApproveByDefault)
 
1220
        self.assert_command_from_args(["--approve-by-default", "foo"],
 
1221
                                      ApproveByDefaultCmd)
1627
1222
 
1628
1223
    def test_deny_by_default(self):
1629
 
        self.assert_command_from_args(["--deny-by-default", "client"],
1630
 
                                      command.DenyByDefault)
 
1224
        self.assert_command_from_args(["--deny-by-default", "foo"],
 
1225
                                      DenyByDefaultCmd)
1631
1226
 
1632
1227
    def test_checker(self):
1633
 
        self.assert_command_from_args(["--checker", ":", "client"],
1634
 
                                      command.SetChecker,
1635
 
                                      value_to_set=":")
 
1228
        self.assert_command_from_args(["--checker", ":", "foo"],
 
1229
                                      SetCheckerCmd, value_to_set=":")
1636
1230
 
1637
1231
    def test_checker_empty(self):
1638
 
        self.assert_command_from_args(["--checker", "", "client"],
1639
 
                                      command.SetChecker,
1640
 
                                      value_to_set="")
 
1232
        self.assert_command_from_args(["--checker", "", "foo"],
 
1233
                                      SetCheckerCmd, value_to_set="")
1641
1234
 
1642
1235
    def test_checker_short(self):
1643
 
        self.assert_command_from_args(["-c", ":", "client"],
1644
 
                                      command.SetChecker,
1645
 
                                      value_to_set=":")
 
1236
        self.assert_command_from_args(["-c", ":", "foo"],
 
1237
                                      SetCheckerCmd, value_to_set=":")
1646
1238
 
1647
1239
    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")
 
1240
        self.assert_command_from_args(["--host", "foo.example.org",
 
1241
                                       "foo"], SetHostCmd,
 
1242
                                      value_to_set="foo.example.org")
1651
1243
 
1652
1244
    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")
 
1245
        self.assert_command_from_args(["-H", "foo.example.org",
 
1246
                                       "foo"], SetHostCmd,
 
1247
                                      value_to_set="foo.example.org")
1656
1248
 
1657
1249
    def test_secret_devnull(self):
1658
1250
        self.assert_command_from_args(["--secret", os.path.devnull,
1659
 
                                       "client"], command.SetSecret,
 
1251
                                       "foo"], SetSecretCmd,
1660
1252
                                      value_to_set=b"")
1661
1253
 
1662
1254
    def test_secret_tempfile(self):
1665
1257
            f.write(value)
1666
1258
            f.seek(0)
1667
1259
            self.assert_command_from_args(["--secret", f.name,
1668
 
                                           "client"],
1669
 
                                          command.SetSecret,
 
1260
                                           "foo"], SetSecretCmd,
1670
1261
                                          value_to_set=value)
1671
1262
 
1672
1263
    def test_secret_devnull_short(self):
1673
 
        self.assert_command_from_args(["-s", os.path.devnull,
1674
 
                                       "client"], command.SetSecret,
1675
 
                                      value_to_set=b"")
 
1264
        self.assert_command_from_args(["-s", os.path.devnull, "foo"],
 
1265
                                      SetSecretCmd, value_to_set=b"")
1676
1266
 
1677
1267
    def test_secret_tempfile_short(self):
1678
1268
        with tempfile.NamedTemporaryFile(mode="r+b") as f:
1679
1269
            value = b"secret\0xyzzy\nbar"
1680
1270
            f.write(value)
1681
1271
            f.seek(0)
1682
 
            self.assert_command_from_args(["-s", f.name, "client"],
1683
 
                                          command.SetSecret,
 
1272
            self.assert_command_from_args(["-s", f.name, "foo"],
 
1273
                                          SetSecretCmd,
1684
1274
                                          value_to_set=value)
1685
1275
 
1686
1276
    def test_timeout(self):
1687
 
        self.assert_command_from_args(["--timeout", "PT5M", "client"],
1688
 
                                      command.SetTimeout,
 
1277
        self.assert_command_from_args(["--timeout", "PT5M", "foo"],
 
1278
                                      SetTimeoutCmd,
1689
1279
                                      value_to_set=300000)
1690
1280
 
1691
1281
    def test_timeout_short(self):
1692
 
        self.assert_command_from_args(["-t", "PT5M", "client"],
1693
 
                                      command.SetTimeout,
 
1282
        self.assert_command_from_args(["-t", "PT5M", "foo"],
 
1283
                                      SetTimeoutCmd,
1694
1284
                                      value_to_set=300000)
1695
1285
 
1696
1286
    def test_extended_timeout(self):
1697
1287
        self.assert_command_from_args(["--extended-timeout", "PT15M",
1698
 
                                       "client"],
1699
 
                                      command.SetExtendedTimeout,
 
1288
                                       "foo"],
 
1289
                                      SetExtendedTimeoutCmd,
1700
1290
                                      value_to_set=900000)
1701
1291
 
1702
1292
    def test_interval(self):
1703
 
        self.assert_command_from_args(["--interval", "PT2M",
1704
 
                                       "client"], command.SetInterval,
 
1293
        self.assert_command_from_args(["--interval", "PT2M", "foo"],
 
1294
                                      SetIntervalCmd,
1705
1295
                                      value_to_set=120000)
1706
1296
 
1707
1297
    def test_interval_short(self):
1708
 
        self.assert_command_from_args(["-i", "PT2M", "client"],
1709
 
                                      command.SetInterval,
 
1298
        self.assert_command_from_args(["-i", "PT2M", "foo"],
 
1299
                                      SetIntervalCmd,
1710
1300
                                      value_to_set=120000)
1711
1301
 
1712
1302
    def test_approval_delay(self):
1713
1303
        self.assert_command_from_args(["--approval-delay", "PT30S",
1714
 
                                       "client"],
1715
 
                                      command.SetApprovalDelay,
 
1304
                                       "foo"], SetApprovalDelayCmd,
1716
1305
                                      value_to_set=30000)
1717
1306
 
1718
1307
    def test_approval_duration(self):
1719
1308
        self.assert_command_from_args(["--approval-duration", "PT1S",
1720
 
                                       "client"],
1721
 
                                      command.SetApprovalDuration,
 
1309
                                       "foo"], SetApprovalDurationCmd,
1722
1310
                                      value_to_set=1000)
1723
1311
 
1724
1312
    def test_print_table(self):
1725
 
        self.assert_command_from_args([], command.PrintTable,
 
1313
        self.assert_command_from_args([], PrintTableCmd,
1726
1314
                                      verbose=False)
1727
1315
 
1728
1316
    def test_print_table_verbose(self):
1729
 
        self.assert_command_from_args(["--verbose"],
1730
 
                                      command.PrintTable,
 
1317
        self.assert_command_from_args(["--verbose"], PrintTableCmd,
1731
1318
                                      verbose=True)
1732
1319
 
1733
1320
    def test_print_table_verbose_short(self):
1734
 
        self.assert_command_from_args(["-v"], command.PrintTable,
 
1321
        self.assert_command_from_args(["-v"], PrintTableCmd,
1735
1322
                                      verbose=True)
1736
1323
 
1737
1324
 
1738
 
class TestCommand(unittest.TestCase):
 
1325
class TestCmd(unittest.TestCase):
1739
1326
    """Abstract class for tests of command classes"""
1740
1327
 
1741
 
    class FakeMandosBus(dbus.MandosBus):
1742
 
        def __init__(self, testcase):
1743
 
            self.client_properties = {
 
1328
    def setUp(self):
 
1329
        testcase = self
 
1330
        class MockClient(object):
 
1331
            def __init__(self, name, **attributes):
 
1332
                self.__dbus_object_path__ = "/clients/{}".format(name)
 
1333
                self.attributes = attributes
 
1334
                self.attributes["Name"] = name
 
1335
                self.calls = []
 
1336
            def Set(self, interface, propname, value, dbus_interface):
 
1337
                testcase.assertEqual(interface, client_dbus_interface)
 
1338
                testcase.assertEqual(dbus_interface,
 
1339
                                     dbus.PROPERTIES_IFACE)
 
1340
                self.attributes[propname] = value
 
1341
            def Get(self, interface, propname, dbus_interface):
 
1342
                testcase.assertEqual(interface, client_dbus_interface)
 
1343
                testcase.assertEqual(dbus_interface,
 
1344
                                     dbus.PROPERTIES_IFACE)
 
1345
                return self.attributes[propname]
 
1346
            def Approve(self, approve, dbus_interface):
 
1347
                testcase.assertEqual(dbus_interface,
 
1348
                                     client_dbus_interface)
 
1349
                self.calls.append(("Approve", (approve,
 
1350
                                               dbus_interface)))
 
1351
        self.client = MockClient(
 
1352
            "foo",
 
1353
            KeyID=("92ed150794387c03ce684574b1139a65"
 
1354
                   "94a34f895daaaf09fd8ea90a27cddb12"),
 
1355
            Secret=b"secret",
 
1356
            Host="foo.example.org",
 
1357
            Enabled=dbus.Boolean(True),
 
1358
            Timeout=300000,
 
1359
            LastCheckedOK="2019-02-03T00:00:00",
 
1360
            Created="2019-01-02T00:00:00",
 
1361
            Interval=120000,
 
1362
            Fingerprint=("778827225BA7DE539C5A"
 
1363
                         "7CFA59CFF7CDBD9A5920"),
 
1364
            CheckerRunning=dbus.Boolean(False),
 
1365
            LastEnabled="2019-01-03T00:00:00",
 
1366
            ApprovalPending=dbus.Boolean(False),
 
1367
            ApprovedByDefault=dbus.Boolean(True),
 
1368
            LastApprovalRequest="",
 
1369
            ApprovalDelay=0,
 
1370
            ApprovalDuration=1000,
 
1371
            Checker="fping -q -- %(host)s",
 
1372
            ExtendedTimeout=900000,
 
1373
            Expires="2019-02-04T00:00:00",
 
1374
            LastCheckerStatus=0)
 
1375
        self.other_client = MockClient(
 
1376
            "barbar",
 
1377
            KeyID=("0558568eedd67d622f5c83b35a115f79"
 
1378
                   "6ab612cff5ad227247e46c2b020f441c"),
 
1379
            Secret=b"secretbar",
 
1380
            Host="192.0.2.3",
 
1381
            Enabled=dbus.Boolean(True),
 
1382
            Timeout=300000,
 
1383
            LastCheckedOK="2019-02-04T00:00:00",
 
1384
            Created="2019-01-03T00:00:00",
 
1385
            Interval=120000,
 
1386
            Fingerprint=("3E393AEAEFB84C7E89E2"
 
1387
                         "F547B3A107558FCA3A27"),
 
1388
            CheckerRunning=dbus.Boolean(True),
 
1389
            LastEnabled="2019-01-04T00:00:00",
 
1390
            ApprovalPending=dbus.Boolean(False),
 
1391
            ApprovedByDefault=dbus.Boolean(False),
 
1392
            LastApprovalRequest="2019-01-03T00:00:00",
 
1393
            ApprovalDelay=30000,
 
1394
            ApprovalDuration=93785000,
 
1395
            Checker=":",
 
1396
            ExtendedTimeout=900000,
 
1397
            Expires="2019-02-05T00:00:00",
 
1398
            LastCheckerStatus=-2)
 
1399
        self.clients =  collections.OrderedDict(
 
1400
            [
 
1401
                ("/clients/foo", self.client.attributes),
 
1402
                ("/clients/barbar", self.other_client.attributes),
 
1403
            ])
 
1404
        self.one_client = {"/clients/foo": self.client.attributes}
 
1405
 
 
1406
    @property
 
1407
    def bus(self):
 
1408
        class Bus(object):
 
1409
            @staticmethod
 
1410
            def get_object(client_bus_name, path):
 
1411
                self.assertEqual(client_bus_name, dbus_busname)
 
1412
                return {
 
1413
                    # Note: "self" here is the TestCmd instance, not
 
1414
                    # the Bus instance, since this is a static method!
 
1415
                    "/clients/foo": self.client,
 
1416
                    "/clients/barbar": self.other_client,
 
1417
                }[path]
 
1418
        return Bus()
 
1419
 
 
1420
 
 
1421
class TestIsEnabledCmd(TestCmd):
 
1422
    def test_is_enabled(self):
 
1423
        self.assertTrue(all(IsEnabledCmd().is_enabled(client,
 
1424
                                                      properties)
 
1425
                            for client, properties
 
1426
                            in self.clients.items()))
 
1427
 
 
1428
    def test_is_enabled_run_exits_successfully(self):
 
1429
        with self.assertRaises(SystemExit) as e:
 
1430
            IsEnabledCmd().run(self.one_client)
 
1431
        if e.exception.code is not None:
 
1432
            self.assertEqual(e.exception.code, 0)
 
1433
        else:
 
1434
            self.assertIsNone(e.exception.code)
 
1435
 
 
1436
    def test_is_enabled_run_exits_with_failure(self):
 
1437
        self.client.attributes["Enabled"] = dbus.Boolean(False)
 
1438
        with self.assertRaises(SystemExit) as e:
 
1439
            IsEnabledCmd().run(self.one_client)
 
1440
        if isinstance(e.exception.code, int):
 
1441
            self.assertNotEqual(e.exception.code, 0)
 
1442
        else:
 
1443
            self.assertIsNotNone(e.exception.code)
 
1444
 
 
1445
 
 
1446
class TestApproveCmd(TestCmd):
 
1447
    def test_approve(self):
 
1448
        ApproveCmd().run(self.clients, self.bus)
 
1449
        for clientpath in self.clients:
 
1450
            client = self.bus.get_object(dbus_busname, clientpath)
 
1451
            self.assertIn(("Approve", (True, client_dbus_interface)),
 
1452
                          client.calls)
 
1453
 
 
1454
 
 
1455
class TestDenyCmd(TestCmd):
 
1456
    def test_deny(self):
 
1457
        DenyCmd().run(self.clients, self.bus)
 
1458
        for clientpath in self.clients:
 
1459
            client = self.bus.get_object(dbus_busname, clientpath)
 
1460
            self.assertIn(("Approve", (False, client_dbus_interface)),
 
1461
                          client.calls)
 
1462
 
 
1463
 
 
1464
class TestRemoveCmd(TestCmd):
 
1465
    def test_remove(self):
 
1466
        class MockMandos(object):
 
1467
            def __init__(self):
 
1468
                self.calls = []
 
1469
            def RemoveClient(self, dbus_path):
 
1470
                self.calls.append(("RemoveClient", (dbus_path,)))
 
1471
        mandos = MockMandos()
 
1472
        super(TestRemoveCmd, self).setUp()
 
1473
        RemoveCmd().run(self.clients, self.bus, mandos)
 
1474
        self.assertEqual(len(mandos.calls), 2)
 
1475
        for clientpath in self.clients:
 
1476
            self.assertIn(("RemoveClient", (clientpath,)),
 
1477
                          mandos.calls)
 
1478
 
 
1479
 
 
1480
class TestDumpJSONCmd(TestCmd):
 
1481
    def setUp(self):
 
1482
        self.expected_json = {
 
1483
            "foo": {
1744
1484
                "Name": "foo",
1745
1485
                "KeyID": ("92ed150794387c03ce684574b1139a65"
1746
1486
                          "94a34f895daaaf09fd8ea90a27cddb12"),
1747
 
                "Secret": b"secret",
1748
1487
                "Host": "foo.example.org",
1749
1488
                "Enabled": True,
1750
1489
                "Timeout": 300000,
1764
1503
                "ExtendedTimeout": 900000,
1765
1504
                "Expires": "2019-02-04T00:00:00",
1766
1505
                "LastCheckerStatus": 0,
1767
 
            }
1768
 
            self.other_client_properties = {
 
1506
            },
 
1507
            "barbar": {
1769
1508
                "Name": "barbar",
1770
1509
                "KeyID": ("0558568eedd67d622f5c83b35a115f79"
1771
1510
                          "6ab612cff5ad227247e46c2b020f441c"),
1772
 
                "Secret": b"secretbar",
1773
1511
                "Host": "192.0.2.3",
1774
1512
                "Enabled": True,
1775
1513
                "Timeout": 300000,
1789
1527
                "ExtendedTimeout": 900000,
1790
1528
                "Expires": "2019-02-05T00:00:00",
1791
1529
                "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
 
    def setUp(self):
1830
 
        self.bus = self.FakeMandosBus(self)
1831
 
 
1832
 
 
1833
 
class TestBaseCommands(TestCommand):
1834
 
 
1835
 
    def test_IsEnabled_exits_successfully(self):
1836
 
        with self.assertRaises(SystemExit) as e:
1837
 
            command.IsEnabled().run(self.bus.one_client)
1838
 
        if e.exception.code is not None:
1839
 
            self.assertEqual(0, e.exception.code)
1840
 
        else:
1841
 
            self.assertIsNone(e.exception.code)
1842
 
 
1843
 
    def test_IsEnabled_exits_with_failure(self):
1844
 
        self.bus.client_properties["Enabled"] = False
1845
 
        with self.assertRaises(SystemExit) as e:
1846
 
            command.IsEnabled().run(self.bus.one_client)
1847
 
        if isinstance(e.exception.code, int):
1848
 
            self.assertNotEqual(0, e.exception.code)
1849
 
        else:
1850
 
            self.assertIsNotNone(e.exception.code)
1851
 
 
1852
 
    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)
1859
 
 
1860
 
    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)
1868
 
 
1869
 
    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)
1875
 
 
1876
 
    expected_json = {
1877
 
        "foo": {
1878
 
            "Name": "foo",
1879
 
            "KeyID": ("92ed150794387c03ce684574b1139a65"
1880
 
                      "94a34f895daaaf09fd8ea90a27cddb12"),
1881
 
            "Host": "foo.example.org",
1882
 
            "Enabled": True,
1883
 
            "Timeout": 300000,
1884
 
            "LastCheckedOK": "2019-02-03T00:00:00",
1885
 
            "Created": "2019-01-02T00:00:00",
1886
 
            "Interval": 120000,
1887
 
            "Fingerprint": ("778827225BA7DE539C5A"
1888
 
                            "7CFA59CFF7CDBD9A5920"),
1889
 
            "CheckerRunning": False,
1890
 
            "LastEnabled": "2019-01-03T00:00:00",
1891
 
            "ApprovalPending": False,
1892
 
            "ApprovedByDefault": True,
1893
 
            "LastApprovalRequest": "",
1894
 
            "ApprovalDelay": 0,
1895
 
            "ApprovalDuration": 1000,
1896
 
            "Checker": "fping -q -- %(host)s",
1897
 
            "ExtendedTimeout": 900000,
1898
 
            "Expires": "2019-02-04T00:00:00",
1899
 
            "LastCheckerStatus": 0,
1900
 
        },
1901
 
        "barbar": {
1902
 
            "Name": "barbar",
1903
 
            "KeyID": ("0558568eedd67d622f5c83b35a115f79"
1904
 
                      "6ab612cff5ad227247e46c2b020f441c"),
1905
 
            "Host": "192.0.2.3",
1906
 
            "Enabled": True,
1907
 
            "Timeout": 300000,
1908
 
            "LastCheckedOK": "2019-02-04T00:00:00",
1909
 
            "Created": "2019-01-03T00:00:00",
1910
 
            "Interval": 120000,
1911
 
            "Fingerprint": ("3E393AEAEFB84C7E89E2"
1912
 
                            "F547B3A107558FCA3A27"),
1913
 
            "CheckerRunning": True,
1914
 
            "LastEnabled": "2019-01-04T00:00:00",
1915
 
            "ApprovalPending": False,
1916
 
            "ApprovedByDefault": False,
1917
 
            "LastApprovalRequest": "2019-01-03T00:00:00",
1918
 
            "ApprovalDelay": 30000,
1919
 
            "ApprovalDuration": 93785000,
1920
 
            "Checker": ":",
1921
 
            "ExtendedTimeout": 900000,
1922
 
            "Expires": "2019-02-05T00:00:00",
1923
 
            "LastCheckerStatus": -2,
1924
 
        },
1925
 
    }
1926
 
 
1927
 
    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
1943
 
 
1944
 
    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())
 
1530
            },
 
1531
        }
 
1532
        return super(TestDumpJSONCmd, self).setUp()
 
1533
 
 
1534
    def test_normal(self):
 
1535
        output = DumpJSONCmd().output(self.clients.values())
 
1536
        json_data = json.loads(output)
 
1537
        self.assertDictEqual(json_data, self.expected_json)
 
1538
 
 
1539
    def test_one_client(self):
 
1540
        output = DumpJSONCmd().output(self.one_client.values())
 
1541
        json_data = json.loads(output)
1948
1542
        expected_json = {"foo": self.expected_json["foo"]}
1949
 
        self.assertDictEqual(expected_json, json_data)
1950
 
 
1951
 
    def test_PrintTable_normal(self):
1952
 
        with self.capture_stdout_to_buffer() as buffer:
1953
 
            command.PrintTable().run(self.bus.clients)
 
1543
        self.assertDictEqual(json_data, expected_json)
 
1544
 
 
1545
 
 
1546
class TestPrintTableCmd(TestCmd):
 
1547
    def test_normal(self):
 
1548
        output = PrintTableCmd().output(self.clients.values())
1954
1549
        expected_output = "\n".join((
1955
1550
            "Name   Enabled Timeout  Last Successful Check",
1956
1551
            "foo    Yes     00:05:00 2019-02-03T00:00:00  ",
1957
1552
            "barbar Yes     00:05:00 2019-02-04T00:00:00  ",
1958
 
        )) + "\n"
1959
 
        self.assertEqual(expected_output, buffer.getvalue())
 
1553
        ))
 
1554
        self.assertEqual(output, expected_output)
1960
1555
 
1961
 
    def test_PrintTable_verbose(self):
1962
 
        with self.capture_stdout_to_buffer() as buffer:
1963
 
            command.PrintTable(verbose=True).run(self.bus.clients)
 
1556
    def test_verbose(self):
 
1557
        output = PrintTableCmd(verbose=True).output(
 
1558
            self.clients.values())
1964
1559
        columns = (
1965
1560
            (
1966
1561
                "Name   ",
2048
1643
            )
2049
1644
        )
2050
1645
        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())
 
1646
        expected_output = "\n".join("".join(rows[line]
 
1647
                                            for rows in columns)
 
1648
                                    for line in range(num_lines))
 
1649
        self.assertEqual(output, expected_output)
2056
1650
 
2057
 
    def test_PrintTable_one_client(self):
2058
 
        with self.capture_stdout_to_buffer() as buffer:
2059
 
            command.PrintTable().run(self.bus.one_client)
 
1651
    def test_one_client(self):
 
1652
        output = PrintTableCmd().output(self.one_client.values())
2060
1653
        expected_output = "\n".join((
2061
1654
            "Name Enabled Timeout  Last Successful Check",
2062
1655
            "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
 
 
 
1656
        ))
 
1657
        self.assertEqual(output, expected_output)
 
1658
 
 
1659
 
 
1660
class TestPropertyCmd(TestCmd):
 
1661
    """Abstract class for tests of PropertyCmd classes"""
2070
1662
    def runTest(self):
2071
1663
        if not hasattr(self, "command"):
2072
 
            return              # Abstract TestCase class
2073
 
 
2074
 
        if hasattr(self, "values_to_set"):
2075
 
            cmd_args = [(value,) for value in self.values_to_set]
2076
 
            values_to_get = getattr(self, "values_to_get",
2077
 
                                    self.values_to_set)
2078
 
        else:
2079
 
            cmd_args = [() for x in range(len(self.values_to_get))]
2080
 
            values_to_get = self.values_to_get
2081
 
        for value_to_get, cmd_arg in zip(values_to_get, cmd_args):
2082
 
            for clientpath in self.bus.clients:
2083
 
                self.bus.clients[clientpath][self.propname] = (
2084
 
                    Unique())
2085
 
            self.command(*cmd_arg).run(self.bus.clients, self.bus)
2086
 
            for clientpath in self.bus.clients:
2087
 
                value = (self.bus.clients[clientpath]
2088
 
                         [self.propname])
2089
 
                self.assertNotIsInstance(value, Unique)
2090
 
                self.assertEqual(value_to_get, value)
2091
 
 
2092
 
 
2093
 
class TestEnableCmd(TestPropertySetterCmd):
2094
 
    command = command.Enable
2095
 
    propname = "Enabled"
2096
 
    values_to_get = [True]
2097
 
 
2098
 
 
2099
 
class TestDisableCmd(TestPropertySetterCmd):
2100
 
    command = command.Disable
2101
 
    propname = "Enabled"
2102
 
    values_to_get = [False]
2103
 
 
2104
 
 
2105
 
class TestBumpTimeoutCmd(TestPropertySetterCmd):
2106
 
    command = command.BumpTimeout
 
1664
            return
 
1665
        values_to_get = getattr(self, "values_to_get",
 
1666
                                self.values_to_set)
 
1667
        for value_to_set, value_to_get in zip(self.values_to_set,
 
1668
                                              values_to_get):
 
1669
            for clientpath in self.clients:
 
1670
                client = self.bus.get_object(dbus_busname, clientpath)
 
1671
                old_value = client.attributes[self.propname]
 
1672
                self.assertNotIsInstance(old_value, self.Unique)
 
1673
                client.attributes[self.propname] = self.Unique()
 
1674
            self.run_command(value_to_set, self.clients)
 
1675
            for clientpath in self.clients:
 
1676
                client = self.bus.get_object(dbus_busname, clientpath)
 
1677
                value = client.attributes[self.propname]
 
1678
                self.assertNotIsInstance(value, self.Unique)
 
1679
                self.assertEqual(value, value_to_get)
 
1680
 
 
1681
    class Unique(object):
 
1682
        """Class for objects which exist only to be unique objects,
 
1683
since unittest.mock.sentinel only exists in Python 3.3"""
 
1684
 
 
1685
    def run_command(self, value, clients):
 
1686
        self.command().run(clients, self.bus)
 
1687
 
 
1688
 
 
1689
class TestEnableCmd(TestPropertyCmd):
 
1690
    command = EnableCmd
 
1691
    propname = "Enabled"
 
1692
    values_to_set = [dbus.Boolean(True)]
 
1693
 
 
1694
 
 
1695
class TestDisableCmd(TestPropertyCmd):
 
1696
    command = DisableCmd
 
1697
    propname = "Enabled"
 
1698
    values_to_set = [dbus.Boolean(False)]
 
1699
 
 
1700
 
 
1701
class TestBumpTimeoutCmd(TestPropertyCmd):
 
1702
    command = BumpTimeoutCmd
2107
1703
    propname = "LastCheckedOK"
2108
 
    values_to_get = [""]
2109
 
 
2110
 
 
2111
 
class TestStartCheckerCmd(TestPropertySetterCmd):
2112
 
    command = command.StartChecker
2113
 
    propname = "CheckerRunning"
2114
 
    values_to_get = [True]
2115
 
 
2116
 
 
2117
 
class TestStopCheckerCmd(TestPropertySetterCmd):
2118
 
    command = command.StopChecker
2119
 
    propname = "CheckerRunning"
2120
 
    values_to_get = [False]
2121
 
 
2122
 
 
2123
 
class TestApproveByDefaultCmd(TestPropertySetterCmd):
2124
 
    command = command.ApproveByDefault
2125
 
    propname = "ApprovedByDefault"
2126
 
    values_to_get = [True]
2127
 
 
2128
 
 
2129
 
class TestDenyByDefaultCmd(TestPropertySetterCmd):
2130
 
    command = command.DenyByDefault
2131
 
    propname = "ApprovedByDefault"
2132
 
    values_to_get = [False]
2133
 
 
2134
 
 
2135
 
class TestSetCheckerCmd(TestPropertySetterCmd):
2136
 
    command = command.SetChecker
 
1704
    values_to_set = [""]
 
1705
 
 
1706
 
 
1707
class TestStartCheckerCmd(TestPropertyCmd):
 
1708
    command = StartCheckerCmd
 
1709
    propname = "CheckerRunning"
 
1710
    values_to_set = [dbus.Boolean(True)]
 
1711
 
 
1712
 
 
1713
class TestStopCheckerCmd(TestPropertyCmd):
 
1714
    command = StopCheckerCmd
 
1715
    propname = "CheckerRunning"
 
1716
    values_to_set = [dbus.Boolean(False)]
 
1717
 
 
1718
 
 
1719
class TestApproveByDefaultCmd(TestPropertyCmd):
 
1720
    command = ApproveByDefaultCmd
 
1721
    propname = "ApprovedByDefault"
 
1722
    values_to_set = [dbus.Boolean(True)]
 
1723
 
 
1724
 
 
1725
class TestDenyByDefaultCmd(TestPropertyCmd):
 
1726
    command = DenyByDefaultCmd
 
1727
    propname = "ApprovedByDefault"
 
1728
    values_to_set = [dbus.Boolean(False)]
 
1729
 
 
1730
 
 
1731
class TestPropertyValueCmd(TestPropertyCmd):
 
1732
    """Abstract class for tests of PropertyValueCmd classes"""
 
1733
 
 
1734
    def runTest(self):
 
1735
        if type(self) is TestPropertyValueCmd:
 
1736
            return
 
1737
        return super(TestPropertyValueCmd, self).runTest()
 
1738
 
 
1739
    def run_command(self, value, clients):
 
1740
        self.command(value).run(clients, self.bus)
 
1741
 
 
1742
 
 
1743
class TestSetCheckerCmd(TestPropertyValueCmd):
 
1744
    command = SetCheckerCmd
2137
1745
    propname = "Checker"
2138
1746
    values_to_set = ["", ":", "fping -q -- %s"]
2139
1747
 
2140
1748
 
2141
 
class TestSetHostCmd(TestPropertySetterCmd):
2142
 
    command = command.SetHost
 
1749
class TestSetHostCmd(TestPropertyValueCmd):
 
1750
    command = SetHostCmd
2143
1751
    propname = "Host"
2144
 
    values_to_set = ["192.0.2.3", "client.example.org"]
2145
 
 
2146
 
 
2147
 
class TestSetSecretCmd(TestPropertySetterCmd):
2148
 
    command = command.SetSecret
 
1752
    values_to_set = ["192.0.2.3", "foo.example.org"]
 
1753
 
 
1754
 
 
1755
class TestSetSecretCmd(TestPropertyValueCmd):
 
1756
    command = SetSecretCmd
2149
1757
    propname = "Secret"
2150
1758
    values_to_set = [io.BytesIO(b""),
2151
1759
                     io.BytesIO(b"secret\0xyzzy\nbar")]
2152
 
    values_to_get = [f.getvalue() for f in values_to_set]
2153
 
 
2154
 
 
2155
 
class TestSetTimeoutCmd(TestPropertySetterCmd):
2156
 
    command = command.SetTimeout
 
1760
    values_to_get = [b"", b"secret\0xyzzy\nbar"]
 
1761
 
 
1762
 
 
1763
class TestSetTimeoutCmd(TestPropertyValueCmd):
 
1764
    command = SetTimeoutCmd
2157
1765
    propname = "Timeout"
2158
1766
    values_to_set = [datetime.timedelta(),
2159
1767
                     datetime.timedelta(minutes=5),
2160
1768
                     datetime.timedelta(seconds=1),
2161
1769
                     datetime.timedelta(weeks=1),
2162
1770
                     datetime.timedelta(weeks=52)]
2163
 
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2164
 
 
2165
 
 
2166
 
class TestSetExtendedTimeoutCmd(TestPropertySetterCmd):
2167
 
    command = command.SetExtendedTimeout
 
1771
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1772
 
 
1773
 
 
1774
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
 
1775
    command = SetExtendedTimeoutCmd
2168
1776
    propname = "ExtendedTimeout"
2169
1777
    values_to_set = [datetime.timedelta(),
2170
1778
                     datetime.timedelta(minutes=5),
2171
1779
                     datetime.timedelta(seconds=1),
2172
1780
                     datetime.timedelta(weeks=1),
2173
1781
                     datetime.timedelta(weeks=52)]
2174
 
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2175
 
 
2176
 
 
2177
 
class TestSetIntervalCmd(TestPropertySetterCmd):
2178
 
    command = command.SetInterval
 
1782
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1783
 
 
1784
 
 
1785
class TestSetIntervalCmd(TestPropertyValueCmd):
 
1786
    command = SetIntervalCmd
2179
1787
    propname = "Interval"
2180
1788
    values_to_set = [datetime.timedelta(),
2181
1789
                     datetime.timedelta(minutes=5),
2182
1790
                     datetime.timedelta(seconds=1),
2183
1791
                     datetime.timedelta(weeks=1),
2184
1792
                     datetime.timedelta(weeks=52)]
2185
 
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2186
 
 
2187
 
 
2188
 
class TestSetApprovalDelayCmd(TestPropertySetterCmd):
2189
 
    command = command.SetApprovalDelay
 
1793
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1794
 
 
1795
 
 
1796
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
 
1797
    command = SetApprovalDelayCmd
2190
1798
    propname = "ApprovalDelay"
2191
1799
    values_to_set = [datetime.timedelta(),
2192
1800
                     datetime.timedelta(minutes=5),
2193
1801
                     datetime.timedelta(seconds=1),
2194
1802
                     datetime.timedelta(weeks=1),
2195
1803
                     datetime.timedelta(weeks=52)]
2196
 
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2197
 
 
2198
 
 
2199
 
class TestSetApprovalDurationCmd(TestPropertySetterCmd):
2200
 
    command = command.SetApprovalDuration
 
1804
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1805
 
 
1806
 
 
1807
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
 
1808
    command = SetApprovalDurationCmd
2201
1809
    propname = "ApprovalDuration"
2202
1810
    values_to_set = [datetime.timedelta(),
2203
1811
                     datetime.timedelta(minutes=5),
2204
1812
                     datetime.timedelta(seconds=1),
2205
1813
                     datetime.timedelta(weeks=1),
2206
1814
                     datetime.timedelta(weeks=52)]
2207
 
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
 
1815
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
2208
1816
 
2209
1817
 
2210
1818