/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 14:59:54 UTC
  • mto: This revision was merged to the branch mainline in revision 382.
  • Revision ID: teddy@recompile.se-20190323145954-latqk2bg6xt989d5
mandos: Refactor; use classes, not instances, as namespaces

* mandos (Avahi): Rename to "avahi".
  (avahi.string_array_to_txt_array): Make static method.
  (GnuTLS): Rename to "gnutls".
  (gnutls.__init__): Remove; move version check up to class body.
  (gnutls.Error): Don't use class name anymore.

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