/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos-ctl

  • Committer: Teddy Hogeborn
  • Date: 2019-03-23 16:00:26 UTC
  • mto: This revision was merged to the branch mainline in revision 382.
  • Revision ID: teddy@recompile.se-20190323160026-u82ba6lkh7jeq0zj
mandos-ctl: Eliminate unnecessary D-Bus call

* mandos-ctl (command.Base.run): Don't set self.mandos.
  (command.Remove): Implement .run() instead of .run_on_one_client()
                    to avoid the command.Base.run() unnecessarily
                    connecting to a client object.

Show diffs side-by-side

added added

removed removed

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