/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos-ctl

  • Committer: Teddy Hogeborn
  • Date: 2019-03-13 21:52:43 UTC
  • Revision ID: teddy@recompile.se-20190313215243-nq6o9hqve19qlwxe
mandos-ctl: Bug fix: Make --dump-json/-j work again.

* mandos-ctl (DumpJSONCmd.output): Don't do .values() on "clients".
  (TestDumpJSONCmd.test_normal, TestDumpJSONCmd.test_one_client): Call
  .values on clients dict before passing to output() method.

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
66
64
 
67
65
locale.setlocale(locale.LC_ALL, "")
68
66
 
83
81
 
84
82
def main():
85
83
    parser = argparse.ArgumentParser()
 
84
 
86
85
    add_command_line_options(parser)
87
86
 
88
87
    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
 
    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)
 
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)
102
108
    mandos_serv_object_manager = dbus.Interface(
103
 
        mandos_dbus_object, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
104
 
 
105
 
    managed_objects = get_managed_objects(mandos_serv_object_manager)
106
 
 
107
 
    all_clients = {}
108
 
    for path, ifs_and_props in managed_objects.items():
109
 
        try:
110
 
            all_clients[path] = ifs_and_props[client_dbus_interface]
111
 
        except KeyError:
112
 
            pass
113
 
 
114
 
    # Compile dict of (clientpath: properties) to process
 
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
 
115
137
    if not clientnames:
116
 
        clients = all_clients
 
138
        clients = {objpath: properties
 
139
                   for objpath, properties in mandos_clients.items()}
117
140
    else:
118
 
        clients = {}
119
141
        for name in clientnames:
120
 
            for objpath, properties in all_clients.items():
 
142
            for objpath, properties in mandos_clients.items():
121
143
                if properties["Name"] == name:
122
144
                    clients[objpath] = properties
123
145
                    break
125
147
                log.critical("Client not found on server: %r", name)
126
148
                sys.exit(1)
127
149
 
 
150
    # Run all commands on clients
128
151
    commands = commands_from_options(options)
129
 
 
130
152
    for command in commands:
131
153
        command.run(clients, bus, mandos_serv)
132
154
 
232
254
    >>> rfc3339_duration_to_delta("")
233
255
    Traceback (most recent call last):
234
256
    ...
235
 
    ValueError: Invalid RFC 3339 duration: ""
 
257
    ValueError: Invalid RFC 3339 duration: u''
236
258
    >>> # Must start with "P":
237
259
    >>> rfc3339_duration_to_delta("1D")
238
260
    Traceback (most recent call last):
239
261
    ...
240
 
    ValueError: Invalid RFC 3339 duration: "1D"
 
262
    ValueError: Invalid RFC 3339 duration: u'1D'
241
263
    >>> # Must use correct order
242
264
    >>> rfc3339_duration_to_delta("PT1S2M")
243
265
    Traceback (most recent call last):
244
266
    ...
245
 
    ValueError: Invalid RFC 3339 duration: "PT1S2M"
 
267
    ValueError: Invalid RFC 3339 duration: u'PT1S2M'
246
268
    >>> # Time needs time marker
247
269
    >>> rfc3339_duration_to_delta("P1H2S")
248
270
    Traceback (most recent call last):
249
271
    ...
250
 
    ValueError: Invalid RFC 3339 duration: "P1H2S"
 
272
    ValueError: Invalid RFC 3339 duration: u'P1H2S'
251
273
    >>> # Weeks can not be combined with anything else
252
274
    >>> rfc3339_duration_to_delta("P1D2W")
253
275
    Traceback (most recent call last):
254
276
    ...
255
 
    ValueError: Invalid RFC 3339 duration: "P1D2W"
 
277
    ValueError: Invalid RFC 3339 duration: u'P1D2W'
256
278
    >>> rfc3339_duration_to_delta("P2W2H")
257
279
    Traceback (most recent call last):
258
280
    ...
259
 
    ValueError: Invalid RFC 3339 duration: "P2W2H"
 
281
    ValueError: Invalid RFC 3339 duration: u'P2W2H'
260
282
    """
261
283
 
262
284
    # Parsing an RFC 3339 duration with regular expressions is not
333
355
                break
334
356
        else:
335
357
            # No currently valid tokens were found
336
 
            raise ValueError("Invalid RFC 3339 duration: \"{}\""
 
358
            raise ValueError("Invalid RFC 3339 duration: {!r}"
337
359
                             .format(duration))
338
360
    # End token found
339
361
    return value
424
446
        options.remove = True
425
447
 
426
448
 
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
 
 
474
449
def commands_from_options(options):
475
450
 
476
451
    commands = []
477
452
 
478
453
    if options.is_enabled:
479
 
        commands.append(command.IsEnabled())
 
454
        commands.append(IsEnabledCmd())
480
455
 
481
456
    if options.approve:
482
 
        commands.append(command.Approve())
 
457
        commands.append(ApproveCmd())
483
458
 
484
459
    if options.deny:
485
 
        commands.append(command.Deny())
 
460
        commands.append(DenyCmd())
486
461
 
487
462
    if options.remove:
488
 
        commands.append(command.Remove())
 
463
        commands.append(RemoveCmd())
489
464
 
490
465
    if options.dump_json:
491
 
        commands.append(command.DumpJSON())
 
466
        commands.append(DumpJSONCmd())
492
467
 
493
468
    if options.enable:
494
 
        commands.append(command.Enable())
 
469
        commands.append(EnableCmd())
495
470
 
496
471
    if options.disable:
497
 
        commands.append(command.Disable())
 
472
        commands.append(DisableCmd())
498
473
 
499
474
    if options.bump_timeout:
500
 
        commands.append(command.BumpTimeout())
 
475
        commands.append(BumpTimeoutCmd())
501
476
 
502
477
    if options.start_checker:
503
 
        commands.append(command.StartChecker())
 
478
        commands.append(StartCheckerCmd())
504
479
 
505
480
    if options.stop_checker:
506
 
        commands.append(command.StopChecker())
 
481
        commands.append(StopCheckerCmd())
507
482
 
508
483
    if options.approved_by_default is not None:
509
484
        if options.approved_by_default:
510
 
            commands.append(command.ApproveByDefault())
 
485
            commands.append(ApproveByDefaultCmd())
511
486
        else:
512
 
            commands.append(command.DenyByDefault())
 
487
            commands.append(DenyByDefaultCmd())
513
488
 
514
489
    if options.checker is not None:
515
 
        commands.append(command.SetChecker(options.checker))
 
490
        commands.append(SetCheckerCmd(options.checker))
516
491
 
517
492
    if options.host is not None:
518
 
        commands.append(command.SetHost(options.host))
 
493
        commands.append(SetHostCmd(options.host))
519
494
 
520
495
    if options.secret is not None:
521
 
        commands.append(command.SetSecret(options.secret))
 
496
        commands.append(SetSecretCmd(options.secret))
522
497
 
523
498
    if options.timeout is not None:
524
 
        commands.append(command.SetTimeout(options.timeout))
 
499
        commands.append(SetTimeoutCmd(options.timeout))
525
500
 
526
501
    if options.extended_timeout:
527
502
        commands.append(
528
 
            command.SetExtendedTimeout(options.extended_timeout))
 
503
            SetExtendedTimeoutCmd(options.extended_timeout))
529
504
 
530
505
    if options.interval is not None:
531
 
        commands.append(command.SetInterval(options.interval))
 
506
        commands.append(SetIntervalCmd(options.interval))
532
507
 
533
508
    if options.approval_delay is not None:
534
 
        commands.append(
535
 
            command.SetApprovalDelay(options.approval_delay))
 
509
        commands.append(SetApprovalDelayCmd(options.approval_delay))
536
510
 
537
511
    if options.approval_duration is not None:
538
512
        commands.append(
539
 
            command.SetApprovalDuration(options.approval_duration))
 
513
            SetApprovalDurationCmd(options.approval_duration))
540
514
 
541
515
    # If no command option has been given, show table of clients,
542
516
    # optionally verbosely
543
517
    if not commands:
544
 
        commands.append(command.PrintTable(verbose=options.verbose))
 
518
        commands.append(PrintTableCmd(verbose=options.verbose))
545
519
 
546
520
    return commands
547
521
 
548
522
 
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=(',', ': ')))
 
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}
 
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__
 
650
            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})
622
688
 
623
689
        @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
 
 
670
 
            def __str__(self):
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"
 
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"
845
815
 
846
816
 
847
817
 
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"))
 
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))
901
828
 
902
829
    def test_falls_back_to_pre_1_6_1_with_warning(self):
903
 
        with self.assertLogs(log, logging.WARNING):
904
 
            value = string_to_delta("2h")
905
 
        self.assertEqual(datetime.timedelta(0, 7200), value)
 
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))
906
850
 
907
851
 
908
852
class Test_check_option_syntax(unittest.TestCase):
946
890
    @contextlib.contextmanager
947
891
    def assertParseError(self):
948
892
        with self.assertRaises(SystemExit) as e:
949
 
            with self.redirect_stderr_to_devnull():
 
893
            with self.temporarily_suppress_stderr():
950
894
                yield
951
895
        # Exit code from argparse is guaranteed to be "2".  Reference:
952
896
        # https://docs.python.org/3/library
953
897
        # /argparse.html#exiting-methods
954
 
        self.assertEqual(2, e.exception.code)
 
898
        self.assertEqual(e.exception.code, 2)
955
899
 
956
900
    @staticmethod
957
901
    @contextlib.contextmanager
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
 
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)
966
913
 
967
914
    def check_option_syntax(self, options):
968
915
        check_option_syntax(self.parser, options)
969
916
 
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"]
 
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
985
922
            with self.assertParseError():
986
923
                self.check_option_syntax(options)
987
924
 
1013
950
            options.all = True
1014
951
            self.check_option_syntax(options)
1015
952
 
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
 
 
1050
953
    def test_is_enabled_fails_without_client(self):
1051
954
        options = self.parser.parse_args()
1052
955
        options.is_enabled = True
1053
956
        with self.assertParseError():
1054
957
            self.check_option_syntax(options)
1055
958
 
 
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
 
1056
965
    def test_is_enabled_fails_with_two_clients(self):
1057
966
        options = self.parser.parse_args()
1058
967
        options.is_enabled = True
1059
 
        options.client = ["client1", "client2"]
 
968
        options.client = ["foo", "barbar"]
1060
969
        with self.assertParseError():
1061
970
            self.check_option_syntax(options)
1062
971
 
1072
981
                self.check_option_syntax(options)
1073
982
 
1074
983
 
1075
 
class Test_get_mandos_dbus_object(TestCaseWithAssertLogs):
1076
 
    def test_calls_and_returns_get_object_on_bus(self):
1077
 
        class MockBus(object):
1078
 
            called = False
1079
 
            def get_object(mockbus_self, busname, dbus_path):
1080
 
                # Note that "self" is still the testcase instance,
1081
 
                # this MockBus instance is in "mockbus_self".
1082
 
                self.assertEqual(dbus_busname, busname)
1083
 
                self.assertEqual(server_dbus_path, dbus_path)
1084
 
                mockbus_self.called = True
1085
 
                return mockbus_self
1086
 
 
1087
 
        mockbus = get_mandos_dbus_object(bus=MockBus())
1088
 
        self.assertIsInstance(mockbus, MockBus)
1089
 
        self.assertTrue(mockbus.called)
1090
 
 
1091
 
    def test_logs_and_exits_on_dbus_error(self):
1092
 
        class FailingBusStub(object):
1093
 
            def get_object(self, busname, dbus_path):
1094
 
                raise dbus.exceptions.DBusException("Test")
1095
 
 
1096
 
        with self.assertLogs(log, logging.CRITICAL):
1097
 
            with self.assertRaises(SystemExit) as e:
1098
 
                bus = get_mandos_dbus_object(bus=FailingBusStub())
1099
 
 
1100
 
        if isinstance(e.exception.code, int):
1101
 
            self.assertNotEqual(0, e.exception.code)
1102
 
        else:
1103
 
            self.assertIsNotNone(e.exception.code)
1104
 
 
1105
 
 
1106
 
class Test_get_managed_objects(TestCaseWithAssertLogs):
1107
 
    def test_calls_and_returns_GetManagedObjects(self):
1108
 
        managed_objects = {"/clients/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
 
 
1132
 
        try:
1133
 
            with self.assertLogs(log, logging.CRITICAL) as watcher:
1134
 
                with self.assertRaises(SystemExit) as e:
1135
 
                    get_managed_objects(ObjectManagerFailingStub())
1136
 
        finally:
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)
1150
 
 
1151
 
 
1152
984
class Test_commands_from_options(unittest.TestCase):
1153
985
    def setUp(self):
1154
986
        self.parser = argparse.ArgumentParser()
1155
987
        add_command_line_options(self.parser)
1156
988
 
1157
989
    def test_is_enabled(self):
1158
 
        self.assert_command_from_args(["--is-enabled", "client"],
1159
 
                                      command.IsEnabled)
 
990
        self.assert_command_from_args(["--is-enabled", "foo"],
 
991
                                      IsEnabledCmd)
1160
992
 
1161
993
    def assert_command_from_args(self, args, command_cls,
1162
994
                                 **cmd_attrs):
1165
997
        options = self.parser.parse_args(args)
1166
998
        check_option_syntax(self.parser, options)
1167
999
        commands = commands_from_options(options)
1168
 
        self.assertEqual(1, len(commands))
 
1000
        self.assertEqual(len(commands), 1)
1169
1001
        command = commands[0]
1170
1002
        self.assertIsInstance(command, command_cls)
1171
1003
        for key, value in cmd_attrs.items():
1172
 
            self.assertEqual(value, getattr(command, key))
 
1004
            self.assertEqual(getattr(command, key), value)
1173
1005
 
1174
1006
    def test_is_enabled_short(self):
1175
 
        self.assert_command_from_args(["-V", "client"],
1176
 
                                      command.IsEnabled)
 
1007
        self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
1177
1008
 
1178
1009
    def test_approve(self):
1179
 
        self.assert_command_from_args(["--approve", "client"],
1180
 
                                      command.Approve)
 
1010
        self.assert_command_from_args(["--approve", "foo"],
 
1011
                                      ApproveCmd)
1181
1012
 
1182
1013
    def test_approve_short(self):
1183
 
        self.assert_command_from_args(["-A", "client"],
1184
 
                                      command.Approve)
 
1014
        self.assert_command_from_args(["-A", "foo"], ApproveCmd)
1185
1015
 
1186
1016
    def test_deny(self):
1187
 
        self.assert_command_from_args(["--deny", "client"],
1188
 
                                      command.Deny)
 
1017
        self.assert_command_from_args(["--deny", "foo"], DenyCmd)
1189
1018
 
1190
1019
    def test_deny_short(self):
1191
 
        self.assert_command_from_args(["-D", "client"], command.Deny)
 
1020
        self.assert_command_from_args(["-D", "foo"], DenyCmd)
1192
1021
 
1193
1022
    def test_remove(self):
1194
 
        self.assert_command_from_args(["--remove", "client"],
1195
 
                                      command.Remove)
 
1023
        self.assert_command_from_args(["--remove", "foo"],
 
1024
                                      RemoveCmd)
1196
1025
 
1197
1026
    def test_deny_before_remove(self):
1198
1027
        options = self.parser.parse_args(["--deny", "--remove",
1199
 
                                          "client"])
 
1028
                                          "foo"])
1200
1029
        check_option_syntax(self.parser, options)
1201
1030
        commands = commands_from_options(options)
1202
 
        self.assertEqual(2, len(commands))
1203
 
        self.assertIsInstance(commands[0], command.Deny)
1204
 
        self.assertIsInstance(commands[1], command.Remove)
 
1031
        self.assertEqual(len(commands), 2)
 
1032
        self.assertIsInstance(commands[0], DenyCmd)
 
1033
        self.assertIsInstance(commands[1], RemoveCmd)
1205
1034
 
1206
1035
    def test_deny_before_remove_reversed(self):
1207
1036
        options = self.parser.parse_args(["--remove", "--deny",
1208
1037
                                          "--all"])
1209
1038
        check_option_syntax(self.parser, options)
1210
1039
        commands = commands_from_options(options)
1211
 
        self.assertEqual(2, len(commands))
1212
 
        self.assertIsInstance(commands[0], command.Deny)
1213
 
        self.assertIsInstance(commands[1], command.Remove)
 
1040
        self.assertEqual(len(commands), 2)
 
1041
        self.assertIsInstance(commands[0], DenyCmd)
 
1042
        self.assertIsInstance(commands[1], RemoveCmd)
1214
1043
 
1215
1044
    def test_remove_short(self):
1216
 
        self.assert_command_from_args(["-r", "client"],
1217
 
                                      command.Remove)
 
1045
        self.assert_command_from_args(["-r", "foo"], RemoveCmd)
1218
1046
 
1219
1047
    def test_dump_json(self):
1220
 
        self.assert_command_from_args(["--dump-json"],
1221
 
                                      command.DumpJSON)
 
1048
        self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
1222
1049
 
1223
1050
    def test_enable(self):
1224
 
        self.assert_command_from_args(["--enable", "client"],
1225
 
                                      command.Enable)
 
1051
        self.assert_command_from_args(["--enable", "foo"], EnableCmd)
1226
1052
 
1227
1053
    def test_enable_short(self):
1228
 
        self.assert_command_from_args(["-e", "client"],
1229
 
                                      command.Enable)
 
1054
        self.assert_command_from_args(["-e", "foo"], EnableCmd)
1230
1055
 
1231
1056
    def test_disable(self):
1232
 
        self.assert_command_from_args(["--disable", "client"],
1233
 
                                      command.Disable)
 
1057
        self.assert_command_from_args(["--disable", "foo"],
 
1058
                                      DisableCmd)
1234
1059
 
1235
1060
    def test_disable_short(self):
1236
 
        self.assert_command_from_args(["-d", "client"],
1237
 
                                      command.Disable)
 
1061
        self.assert_command_from_args(["-d", "foo"], DisableCmd)
1238
1062
 
1239
1063
    def test_bump_timeout(self):
1240
 
        self.assert_command_from_args(["--bump-timeout", "client"],
1241
 
                                      command.BumpTimeout)
 
1064
        self.assert_command_from_args(["--bump-timeout", "foo"],
 
1065
                                      BumpTimeoutCmd)
1242
1066
 
1243
1067
    def test_bump_timeout_short(self):
1244
 
        self.assert_command_from_args(["-b", "client"],
1245
 
                                      command.BumpTimeout)
 
1068
        self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
1246
1069
 
1247
1070
    def test_start_checker(self):
1248
 
        self.assert_command_from_args(["--start-checker", "client"],
1249
 
                                      command.StartChecker)
 
1071
        self.assert_command_from_args(["--start-checker", "foo"],
 
1072
                                      StartCheckerCmd)
1250
1073
 
1251
1074
    def test_stop_checker(self):
1252
 
        self.assert_command_from_args(["--stop-checker", "client"],
1253
 
                                      command.StopChecker)
 
1075
        self.assert_command_from_args(["--stop-checker", "foo"],
 
1076
                                      StopCheckerCmd)
1254
1077
 
1255
1078
    def test_approve_by_default(self):
1256
 
        self.assert_command_from_args(["--approve-by-default",
1257
 
                                       "client"],
1258
 
                                      command.ApproveByDefault)
 
1079
        self.assert_command_from_args(["--approve-by-default", "foo"],
 
1080
                                      ApproveByDefaultCmd)
1259
1081
 
1260
1082
    def test_deny_by_default(self):
1261
 
        self.assert_command_from_args(["--deny-by-default", "client"],
1262
 
                                      command.DenyByDefault)
 
1083
        self.assert_command_from_args(["--deny-by-default", "foo"],
 
1084
                                      DenyByDefaultCmd)
1263
1085
 
1264
1086
    def test_checker(self):
1265
 
        self.assert_command_from_args(["--checker", ":", "client"],
1266
 
                                      command.SetChecker,
1267
 
                                      value_to_set=":")
 
1087
        self.assert_command_from_args(["--checker", ":", "foo"],
 
1088
                                      SetCheckerCmd, value_to_set=":")
1268
1089
 
1269
1090
    def test_checker_empty(self):
1270
 
        self.assert_command_from_args(["--checker", "", "client"],
1271
 
                                      command.SetChecker,
1272
 
                                      value_to_set="")
 
1091
        self.assert_command_from_args(["--checker", "", "foo"],
 
1092
                                      SetCheckerCmd, value_to_set="")
1273
1093
 
1274
1094
    def test_checker_short(self):
1275
 
        self.assert_command_from_args(["-c", ":", "client"],
1276
 
                                      command.SetChecker,
1277
 
                                      value_to_set=":")
 
1095
        self.assert_command_from_args(["-c", ":", "foo"],
 
1096
                                      SetCheckerCmd, value_to_set=":")
1278
1097
 
1279
1098
    def test_host(self):
1280
 
        self.assert_command_from_args(
1281
 
            ["--host", "client.example.org", "client"],
1282
 
            command.SetHost, value_to_set="client.example.org")
 
1099
        self.assert_command_from_args(["--host", "foo.example.org",
 
1100
                                       "foo"], SetHostCmd,
 
1101
                                      value_to_set="foo.example.org")
1283
1102
 
1284
1103
    def test_host_short(self):
1285
 
        self.assert_command_from_args(
1286
 
            ["-H", "client.example.org", "client"], command.SetHost,
1287
 
            value_to_set="client.example.org")
 
1104
        self.assert_command_from_args(["-H", "foo.example.org",
 
1105
                                       "foo"], SetHostCmd,
 
1106
                                      value_to_set="foo.example.org")
1288
1107
 
1289
1108
    def test_secret_devnull(self):
1290
1109
        self.assert_command_from_args(["--secret", os.path.devnull,
1291
 
                                       "client"], command.SetSecret,
 
1110
                                       "foo"], SetSecretCmd,
1292
1111
                                      value_to_set=b"")
1293
1112
 
1294
1113
    def test_secret_tempfile(self):
1297
1116
            f.write(value)
1298
1117
            f.seek(0)
1299
1118
            self.assert_command_from_args(["--secret", f.name,
1300
 
                                           "client"],
1301
 
                                          command.SetSecret,
 
1119
                                           "foo"], SetSecretCmd,
1302
1120
                                          value_to_set=value)
1303
1121
 
1304
1122
    def test_secret_devnull_short(self):
1305
 
        self.assert_command_from_args(["-s", os.path.devnull,
1306
 
                                       "client"], command.SetSecret,
1307
 
                                      value_to_set=b"")
 
1123
        self.assert_command_from_args(["-s", os.path.devnull, "foo"],
 
1124
                                      SetSecretCmd, value_to_set=b"")
1308
1125
 
1309
1126
    def test_secret_tempfile_short(self):
1310
1127
        with tempfile.NamedTemporaryFile(mode="r+b") as f:
1311
1128
            value = b"secret\0xyzzy\nbar"
1312
1129
            f.write(value)
1313
1130
            f.seek(0)
1314
 
            self.assert_command_from_args(["-s", f.name, "client"],
1315
 
                                          command.SetSecret,
 
1131
            self.assert_command_from_args(["-s", f.name, "foo"],
 
1132
                                          SetSecretCmd,
1316
1133
                                          value_to_set=value)
1317
1134
 
1318
1135
    def test_timeout(self):
1319
 
        self.assert_command_from_args(["--timeout", "PT5M", "client"],
1320
 
                                      command.SetTimeout,
 
1136
        self.assert_command_from_args(["--timeout", "PT5M", "foo"],
 
1137
                                      SetTimeoutCmd,
1321
1138
                                      value_to_set=300000)
1322
1139
 
1323
1140
    def test_timeout_short(self):
1324
 
        self.assert_command_from_args(["-t", "PT5M", "client"],
1325
 
                                      command.SetTimeout,
 
1141
        self.assert_command_from_args(["-t", "PT5M", "foo"],
 
1142
                                      SetTimeoutCmd,
1326
1143
                                      value_to_set=300000)
1327
1144
 
1328
1145
    def test_extended_timeout(self):
1329
1146
        self.assert_command_from_args(["--extended-timeout", "PT15M",
1330
 
                                       "client"],
1331
 
                                      command.SetExtendedTimeout,
 
1147
                                       "foo"],
 
1148
                                      SetExtendedTimeoutCmd,
1332
1149
                                      value_to_set=900000)
1333
1150
 
1334
1151
    def test_interval(self):
1335
 
        self.assert_command_from_args(["--interval", "PT2M",
1336
 
                                       "client"], command.SetInterval,
 
1152
        self.assert_command_from_args(["--interval", "PT2M", "foo"],
 
1153
                                      SetIntervalCmd,
1337
1154
                                      value_to_set=120000)
1338
1155
 
1339
1156
    def test_interval_short(self):
1340
 
        self.assert_command_from_args(["-i", "PT2M", "client"],
1341
 
                                      command.SetInterval,
 
1157
        self.assert_command_from_args(["-i", "PT2M", "foo"],
 
1158
                                      SetIntervalCmd,
1342
1159
                                      value_to_set=120000)
1343
1160
 
1344
1161
    def test_approval_delay(self):
1345
1162
        self.assert_command_from_args(["--approval-delay", "PT30S",
1346
 
                                       "client"],
1347
 
                                      command.SetApprovalDelay,
 
1163
                                       "foo"], SetApprovalDelayCmd,
1348
1164
                                      value_to_set=30000)
1349
1165
 
1350
1166
    def test_approval_duration(self):
1351
1167
        self.assert_command_from_args(["--approval-duration", "PT1S",
1352
 
                                       "client"],
1353
 
                                      command.SetApprovalDuration,
 
1168
                                       "foo"], SetApprovalDurationCmd,
1354
1169
                                      value_to_set=1000)
1355
1170
 
1356
1171
    def test_print_table(self):
1357
 
        self.assert_command_from_args([], command.PrintTable,
 
1172
        self.assert_command_from_args([], PrintTableCmd,
1358
1173
                                      verbose=False)
1359
1174
 
1360
1175
    def test_print_table_verbose(self):
1361
 
        self.assert_command_from_args(["--verbose"],
1362
 
                                      command.PrintTable,
 
1176
        self.assert_command_from_args(["--verbose"], PrintTableCmd,
1363
1177
                                      verbose=True)
1364
1178
 
1365
1179
    def test_print_table_verbose_short(self):
1366
 
        self.assert_command_from_args(["-v"], command.PrintTable,
 
1180
        self.assert_command_from_args(["-v"], PrintTableCmd,
1367
1181
                                      verbose=True)
1368
1182
 
1369
1183
 
1370
 
class TestCommand(unittest.TestCase):
 
1184
class TestCmd(unittest.TestCase):
1371
1185
    """Abstract class for tests of command classes"""
1372
1186
 
1373
1187
    def setUp(self):
1379
1193
                self.attributes["Name"] = name
1380
1194
                self.calls = []
1381
1195
            def Set(self, interface, propname, value, dbus_interface):
1382
 
                testcase.assertEqual(client_dbus_interface, interface)
1383
 
                testcase.assertEqual(dbus.PROPERTIES_IFACE,
1384
 
                                     dbus_interface)
 
1196
                testcase.assertEqual(interface, client_dbus_interface)
 
1197
                testcase.assertEqual(dbus_interface,
 
1198
                                     dbus.PROPERTIES_IFACE)
1385
1199
                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]
1386
1205
            def Approve(self, approve, dbus_interface):
1387
 
                testcase.assertEqual(client_dbus_interface,
1388
 
                                     dbus_interface)
 
1206
                testcase.assertEqual(dbus_interface,
 
1207
                                     client_dbus_interface)
1389
1208
                self.calls.append(("Approve", (approve,
1390
1209
                                               dbus_interface)))
1391
1210
        self.client = MockClient(
1438
1257
            LastCheckerStatus=-2)
1439
1258
        self.clients =  collections.OrderedDict(
1440
1259
            [
1441
 
                (self.client.__dbus_object_path__,
1442
 
                 self.client.attributes),
1443
 
                (self.other_client.__dbus_object_path__,
1444
 
                 self.other_client.attributes),
 
1260
                ("/clients/foo", self.client.attributes),
 
1261
                ("/clients/barbar", self.other_client.attributes),
1445
1262
            ])
1446
 
        self.one_client = {self.client.__dbus_object_path__:
1447
 
                           self.client.attributes}
 
1263
        self.one_client = {"/clients/foo": self.client.attributes}
1448
1264
 
1449
1265
    @property
1450
1266
    def bus(self):
1451
 
        class MockBus(object):
 
1267
        class Bus(object):
1452
1268
            @staticmethod
1453
1269
            def get_object(client_bus_name, path):
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):
 
1270
                self.assertEqual(client_bus_name, dbus_busname)
 
1271
                return {
 
1272
                    # Note: "self" here is the TestCmd instance, not
 
1273
                    # the Bus instance, since this is a static method!
 
1274
                    "/clients/foo": self.client,
 
1275
                    "/clients/barbar": self.other_client,
 
1276
                }[path]
 
1277
        return Bus()
 
1278
 
 
1279
 
 
1280
class TestIsEnabledCmd(TestCmd):
 
1281
    def test_is_enabled(self):
 
1282
        self.assertTrue(all(IsEnabledCmd().is_enabled(client,
 
1283
                                                      properties)
 
1284
                            for client, properties
 
1285
                            in self.clients.items()))
 
1286
 
 
1287
    def test_is_enabled_run_exits_successfully(self):
1467
1288
        with self.assertRaises(SystemExit) as e:
1468
 
            command.IsEnabled().run(self.one_client)
 
1289
            IsEnabledCmd().run(self.one_client)
1469
1290
        if e.exception.code is not None:
1470
 
            self.assertEqual(0, e.exception.code)
 
1291
            self.assertEqual(e.exception.code, 0)
1471
1292
        else:
1472
1293
            self.assertIsNone(e.exception.code)
1473
1294
 
1474
 
    def test_IsEnabled_exits_with_failure(self):
 
1295
    def test_is_enabled_run_exits_with_failure(self):
1475
1296
        self.client.attributes["Enabled"] = dbus.Boolean(False)
1476
1297
        with self.assertRaises(SystemExit) as e:
1477
 
            command.IsEnabled().run(self.one_client)
 
1298
            IsEnabledCmd().run(self.one_client)
1478
1299
        if isinstance(e.exception.code, int):
1479
 
            self.assertNotEqual(0, e.exception.code)
 
1300
            self.assertNotEqual(e.exception.code, 0)
1480
1301
        else:
1481
1302
            self.assertIsNotNone(e.exception.code)
1482
1303
 
1483
 
    def test_Approve(self):
1484
 
        command.Approve().run(self.clients, self.bus)
 
1304
 
 
1305
class TestApproveCmd(TestCmd):
 
1306
    def test_approve(self):
 
1307
        ApproveCmd().run(self.clients, self.bus)
1485
1308
        for clientpath in self.clients:
1486
1309
            client = self.bus.get_object(dbus_busname, clientpath)
1487
1310
            self.assertIn(("Approve", (True, client_dbus_interface)),
1488
1311
                          client.calls)
1489
1312
 
1490
 
    def test_Deny(self):
1491
 
        command.Deny().run(self.clients, self.bus)
 
1313
 
 
1314
class TestDenyCmd(TestCmd):
 
1315
    def test_deny(self):
 
1316
        DenyCmd().run(self.clients, self.bus)
1492
1317
        for clientpath in self.clients:
1493
1318
            client = self.bus.get_object(dbus_busname, clientpath)
1494
1319
            self.assertIn(("Approve", (False, client_dbus_interface)),
1495
1320
                          client.calls)
1496
1321
 
1497
 
    def test_Remove(self):
1498
 
        class MandosSpy(object):
 
1322
 
 
1323
class TestRemoveCmd(TestCmd):
 
1324
    def test_remove(self):
 
1325
        class MockMandos(object):
1499
1326
            def __init__(self):
1500
1327
                self.calls = []
1501
1328
            def RemoveClient(self, dbus_path):
1502
1329
                self.calls.append(("RemoveClient", (dbus_path,)))
1503
 
        mandos = MandosSpy()
1504
 
        command.Remove().run(self.clients, self.bus, mandos)
 
1330
        mandos = MockMandos()
 
1331
        super(TestRemoveCmd, self).setUp()
 
1332
        RemoveCmd().run(self.clients, self.bus, mandos)
 
1333
        self.assertEqual(len(mandos.calls), 2)
1505
1334
        for clientpath in self.clients:
1506
1335
            self.assertIn(("RemoveClient", (clientpath,)),
1507
1336
                          mandos.calls)
1508
1337
 
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())
 
1338
 
 
1339
class TestDumpJSONCmd(TestCmd):
 
1340
    def setUp(self):
 
1341
        self.expected_json = {
 
1342
            "foo": {
 
1343
                "Name": "foo",
 
1344
                "KeyID": ("92ed150794387c03ce684574b1139a65"
 
1345
                          "94a34f895daaaf09fd8ea90a27cddb12"),
 
1346
                "Host": "foo.example.org",
 
1347
                "Enabled": True,
 
1348
                "Timeout": 300000,
 
1349
                "LastCheckedOK": "2019-02-03T00:00:00",
 
1350
                "Created": "2019-01-02T00:00:00",
 
1351
                "Interval": 120000,
 
1352
                "Fingerprint": ("778827225BA7DE539C5A"
 
1353
                                "7CFA59CFF7CDBD9A5920"),
 
1354
                "CheckerRunning": False,
 
1355
                "LastEnabled": "2019-01-03T00:00:00",
 
1356
                "ApprovalPending": False,
 
1357
                "ApprovedByDefault": True,
 
1358
                "LastApprovalRequest": "",
 
1359
                "ApprovalDelay": 0,
 
1360
                "ApprovalDuration": 1000,
 
1361
                "Checker": "fping -q -- %(host)s",
 
1362
                "ExtendedTimeout": 900000,
 
1363
                "Expires": "2019-02-04T00:00:00",
 
1364
                "LastCheckerStatus": 0,
 
1365
            },
 
1366
            "barbar": {
 
1367
                "Name": "barbar",
 
1368
                "KeyID": ("0558568eedd67d622f5c83b35a115f79"
 
1369
                          "6ab612cff5ad227247e46c2b020f441c"),
 
1370
                "Host": "192.0.2.3",
 
1371
                "Enabled": True,
 
1372
                "Timeout": 300000,
 
1373
                "LastCheckedOK": "2019-02-04T00:00:00",
 
1374
                "Created": "2019-01-03T00:00:00",
 
1375
                "Interval": 120000,
 
1376
                "Fingerprint": ("3E393AEAEFB84C7E89E2"
 
1377
                                "F547B3A107558FCA3A27"),
 
1378
                "CheckerRunning": True,
 
1379
                "LastEnabled": "2019-01-04T00:00:00",
 
1380
                "ApprovalPending": False,
 
1381
                "ApprovedByDefault": False,
 
1382
                "LastApprovalRequest": "2019-01-03T00:00:00",
 
1383
                "ApprovalDelay": 30000,
 
1384
                "ApprovalDuration": 93785000,
 
1385
                "Checker": ":",
 
1386
                "ExtendedTimeout": 900000,
 
1387
                "Expires": "2019-02-05T00:00:00",
 
1388
                "LastCheckerStatus": -2,
 
1389
            },
 
1390
        }
 
1391
        return super(TestDumpJSONCmd, self).setUp()
 
1392
 
 
1393
    def test_normal(self):
 
1394
        output = DumpJSONCmd().output(self.clients.values())
 
1395
        json_data = json.loads(output)
 
1396
        self.assertDictEqual(json_data, self.expected_json)
 
1397
 
 
1398
    def test_one_client(self):
 
1399
        output = DumpJSONCmd().output(self.one_client.values())
 
1400
        json_data = json.loads(output)
1581
1401
        expected_json = {"foo": self.expected_json["foo"]}
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)
 
1402
        self.assertDictEqual(json_data, expected_json)
 
1403
 
 
1404
 
 
1405
class TestPrintTableCmd(TestCmd):
 
1406
    def test_normal(self):
 
1407
        output = PrintTableCmd().output(self.clients.values())
1587
1408
        expected_output = "\n".join((
1588
1409
            "Name   Enabled Timeout  Last Successful Check",
1589
1410
            "foo    Yes     00:05:00 2019-02-03T00:00:00  ",
1590
1411
            "barbar Yes     00:05:00 2019-02-04T00:00:00  ",
1591
 
        )) + "\n"
1592
 
        self.assertEqual(expected_output, buffer.getvalue())
 
1412
        ))
 
1413
        self.assertEqual(output, expected_output)
1593
1414
 
1594
 
    def test_PrintTable_verbose(self):
1595
 
        with self.capture_stdout_to_buffer() as buffer:
1596
 
            command.PrintTable(verbose=True).run(self.clients)
 
1415
    def test_verbose(self):
 
1416
        output = PrintTableCmd(verbose=True).output(
 
1417
            self.clients.values())
1597
1418
        columns = (
1598
1419
            (
1599
1420
                "Name   ",
1681
1502
            )
1682
1503
        )
1683
1504
        num_lines = max(len(rows) for rows in columns)
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())
 
1505
        expected_output = "\n".join("".join(rows[line]
 
1506
                                            for rows in columns)
 
1507
                                    for line in range(num_lines))
 
1508
        self.assertEqual(output, expected_output)
1689
1509
 
1690
 
    def test_PrintTable_one_client(self):
1691
 
        with self.capture_stdout_to_buffer() as buffer:
1692
 
            command.PrintTable().run(self.one_client)
 
1510
    def test_one_client(self):
 
1511
        output = PrintTableCmd().output(self.one_client.values())
1693
1512
        expected_output = "\n".join((
1694
1513
            "Name Enabled Timeout  Last Successful Check",
1695
1514
            "foo  Yes     00:05:00 2019-02-03T00:00:00  ",
1696
 
        )) + "\n"
1697
 
        self.assertEqual(expected_output, buffer.getvalue())
1698
 
 
1699
 
 
1700
 
class TestPropertySetterCmd(TestCommand):
1701
 
    """Abstract class for tests of command.PropertySetter classes"""
 
1515
        ))
 
1516
        self.assertEqual(output, expected_output)
 
1517
 
 
1518
 
 
1519
class TestPropertyCmd(TestCmd):
 
1520
    """Abstract class for tests of PropertyCmd classes"""
1702
1521
    def runTest(self):
1703
1522
        if not hasattr(self, "command"):
1704
1523
            return
1709
1528
            for clientpath in self.clients:
1710
1529
                client = self.bus.get_object(dbus_busname, clientpath)
1711
1530
                old_value = client.attributes[self.propname]
 
1531
                self.assertNotIsInstance(old_value, self.Unique)
1712
1532
                client.attributes[self.propname] = self.Unique()
1713
1533
            self.run_command(value_to_set, self.clients)
1714
1534
            for clientpath in self.clients:
1715
1535
                client = self.bus.get_object(dbus_busname, clientpath)
1716
1536
                value = client.attributes[self.propname]
1717
1537
                self.assertNotIsInstance(value, self.Unique)
1718
 
                self.assertEqual(value_to_get, value)
 
1538
                self.assertEqual(value, value_to_get)
1719
1539
 
1720
1540
    class Unique(object):
1721
1541
        """Class for objects which exist only to be unique objects,
1725
1545
        self.command().run(clients, self.bus)
1726
1546
 
1727
1547
 
1728
 
class TestEnableCmd(TestPropertySetterCmd):
1729
 
    command = command.Enable
 
1548
class TestEnableCmd(TestPropertyCmd):
 
1549
    command = EnableCmd
1730
1550
    propname = "Enabled"
1731
1551
    values_to_set = [dbus.Boolean(True)]
1732
1552
 
1733
1553
 
1734
 
class TestDisableCmd(TestPropertySetterCmd):
1735
 
    command = command.Disable
 
1554
class TestDisableCmd(TestPropertyCmd):
 
1555
    command = DisableCmd
1736
1556
    propname = "Enabled"
1737
1557
    values_to_set = [dbus.Boolean(False)]
1738
1558
 
1739
1559
 
1740
 
class TestBumpTimeoutCmd(TestPropertySetterCmd):
1741
 
    command = command.BumpTimeout
 
1560
class TestBumpTimeoutCmd(TestPropertyCmd):
 
1561
    command = BumpTimeoutCmd
1742
1562
    propname = "LastCheckedOK"
1743
1563
    values_to_set = [""]
1744
1564
 
1745
1565
 
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"""
 
1566
class TestStartCheckerCmd(TestPropertyCmd):
 
1567
    command = StartCheckerCmd
 
1568
    propname = "CheckerRunning"
 
1569
    values_to_set = [dbus.Boolean(True)]
 
1570
 
 
1571
 
 
1572
class TestStopCheckerCmd(TestPropertyCmd):
 
1573
    command = StopCheckerCmd
 
1574
    propname = "CheckerRunning"
 
1575
    values_to_set = [dbus.Boolean(False)]
 
1576
 
 
1577
 
 
1578
class TestApproveByDefaultCmd(TestPropertyCmd):
 
1579
    command = ApproveByDefaultCmd
 
1580
    propname = "ApprovedByDefault"
 
1581
    values_to_set = [dbus.Boolean(True)]
 
1582
 
 
1583
 
 
1584
class TestDenyByDefaultCmd(TestPropertyCmd):
 
1585
    command = DenyByDefaultCmd
 
1586
    propname = "ApprovedByDefault"
 
1587
    values_to_set = [dbus.Boolean(False)]
 
1588
 
 
1589
 
 
1590
class TestPropertyValueCmd(TestPropertyCmd):
 
1591
    """Abstract class for tests of PropertyValueCmd classes"""
1772
1592
 
1773
1593
    def runTest(self):
1774
 
        if type(self) is TestPropertySetterValueCmd:
 
1594
        if type(self) is TestPropertyValueCmd:
1775
1595
            return
1776
 
        return super(TestPropertySetterValueCmd, self).runTest()
 
1596
        return super(TestPropertyValueCmd, self).runTest()
1777
1597
 
1778
1598
    def run_command(self, value, clients):
1779
1599
        self.command(value).run(clients, self.bus)
1780
1600
 
1781
1601
 
1782
 
class TestSetCheckerCmd(TestPropertySetterValueCmd):
1783
 
    command = command.SetChecker
 
1602
class TestSetCheckerCmd(TestPropertyValueCmd):
 
1603
    command = SetCheckerCmd
1784
1604
    propname = "Checker"
1785
1605
    values_to_set = ["", ":", "fping -q -- %s"]
1786
1606
 
1787
1607
 
1788
 
class TestSetHostCmd(TestPropertySetterValueCmd):
1789
 
    command = command.SetHost
 
1608
class TestSetHostCmd(TestPropertyValueCmd):
 
1609
    command = SetHostCmd
1790
1610
    propname = "Host"
1791
 
    values_to_set = ["192.0.2.3", "client.example.org"]
1792
 
 
1793
 
 
1794
 
class TestSetSecretCmd(TestPropertySetterValueCmd):
1795
 
    command = command.SetSecret
 
1611
    values_to_set = ["192.0.2.3", "foo.example.org"]
 
1612
 
 
1613
 
 
1614
class TestSetSecretCmd(TestPropertyValueCmd):
 
1615
    command = SetSecretCmd
1796
1616
    propname = "Secret"
1797
1617
    values_to_set = [io.BytesIO(b""),
1798
1618
                     io.BytesIO(b"secret\0xyzzy\nbar")]
1799
 
    values_to_get = [f.getvalue() for f in values_to_set]
1800
 
 
1801
 
 
1802
 
class TestSetTimeoutCmd(TestPropertySetterValueCmd):
1803
 
    command = command.SetTimeout
 
1619
    values_to_get = [b"", b"secret\0xyzzy\nbar"]
 
1620
 
 
1621
 
 
1622
class TestSetTimeoutCmd(TestPropertyValueCmd):
 
1623
    command = SetTimeoutCmd
1804
1624
    propname = "Timeout"
1805
1625
    values_to_set = [datetime.timedelta(),
1806
1626
                     datetime.timedelta(minutes=5),
1807
1627
                     datetime.timedelta(seconds=1),
1808
1628
                     datetime.timedelta(weeks=1),
1809
1629
                     datetime.timedelta(weeks=52)]
1810
 
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1811
 
 
1812
 
 
1813
 
class TestSetExtendedTimeoutCmd(TestPropertySetterValueCmd):
1814
 
    command = command.SetExtendedTimeout
 
1630
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1631
 
 
1632
 
 
1633
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
 
1634
    command = SetExtendedTimeoutCmd
1815
1635
    propname = "ExtendedTimeout"
1816
1636
    values_to_set = [datetime.timedelta(),
1817
1637
                     datetime.timedelta(minutes=5),
1818
1638
                     datetime.timedelta(seconds=1),
1819
1639
                     datetime.timedelta(weeks=1),
1820
1640
                     datetime.timedelta(weeks=52)]
1821
 
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1822
 
 
1823
 
 
1824
 
class TestSetIntervalCmd(TestPropertySetterValueCmd):
1825
 
    command = command.SetInterval
 
1641
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1642
 
 
1643
 
 
1644
class TestSetIntervalCmd(TestPropertyValueCmd):
 
1645
    command = SetIntervalCmd
1826
1646
    propname = "Interval"
1827
1647
    values_to_set = [datetime.timedelta(),
1828
1648
                     datetime.timedelta(minutes=5),
1829
1649
                     datetime.timedelta(seconds=1),
1830
1650
                     datetime.timedelta(weeks=1),
1831
1651
                     datetime.timedelta(weeks=52)]
1832
 
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1833
 
 
1834
 
 
1835
 
class TestSetApprovalDelayCmd(TestPropertySetterValueCmd):
1836
 
    command = command.SetApprovalDelay
 
1652
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1653
 
 
1654
 
 
1655
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
 
1656
    command = SetApprovalDelayCmd
1837
1657
    propname = "ApprovalDelay"
1838
1658
    values_to_set = [datetime.timedelta(),
1839
1659
                     datetime.timedelta(minutes=5),
1840
1660
                     datetime.timedelta(seconds=1),
1841
1661
                     datetime.timedelta(weeks=1),
1842
1662
                     datetime.timedelta(weeks=52)]
1843
 
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1844
 
 
1845
 
 
1846
 
class TestSetApprovalDurationCmd(TestPropertySetterValueCmd):
1847
 
    command = command.SetApprovalDuration
 
1663
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1664
 
 
1665
 
 
1666
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
 
1667
    command = SetApprovalDurationCmd
1848
1668
    propname = "ApprovalDuration"
1849
1669
    values_to_set = [datetime.timedelta(),
1850
1670
                     datetime.timedelta(minutes=5),
1851
1671
                     datetime.timedelta(seconds=1),
1852
1672
                     datetime.timedelta(weeks=1),
1853
1673
                     datetime.timedelta(weeks=52)]
1854
 
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
 
1674
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1855
1675
 
1856
1676
 
1857
1677
 
1872
1692
    return tests
1873
1693
 
1874
1694
if __name__ == "__main__":
1875
 
    try:
1876
 
        if should_only_run_tests():
1877
 
            # Call using ./tdd-python-script --check [--verbose]
1878
 
            unittest.main()
1879
 
        else:
1880
 
            main()
1881
 
    finally:
1882
 
        logging.shutdown()
 
1695
    if should_only_run_tests():
 
1696
        # Call using ./tdd-python-script --check [--verbose]
 
1697
        unittest.main()
 
1698
    else:
 
1699
        main()