/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-17 18:44:44 UTC
  • mto: This revision was merged to the branch mainline in revision 382.
  • Revision ID: teddy@recompile.se-20190317184444-5o7vougp7c3p87ri
mandos-ctl: Refactor tests

* mandos-ctl (TestBaseCommands.test_DumpJSON_normal): Don't run the
  .output method on command; instead, use capture_stdout_to_buffer().
  (TestBaseCommands.test_DumpJSON_one_client): - '' -
  (TestBaseCommands.test_PrintTable_normal): - '' -
  (TestBaseCommands.test_PrintTable_verbose): - '' -
  (TestBaseCommands.test_PrintTable_one_client): - '' -
  (TestBaseCommands.capture_stdout_to_buffer): New.

Show diffs side-by-side

added added

removed removed

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