/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-04 20:39:48 UTC
  • Revision ID: teddy@recompile.se-20190304203948-x8cdobs47h1f89xk
mandos-ctl: Bug fix: fix client/properties confusion

* mandos-ctl (Command.run_on_one_client): Take an additional
                                          "properties" argument.  All
                                          callers and users changed.
  (IsEnabledCmd.is_enabled): Don't run client.Get(); just look at the
                             "Enabled" property key.
  (TestCmd.setUp): Set self.clients to the correct form of dict, and
                   set self.one_client to be a dict with only one
                   client.  Also set self.other_client to other client
                   object.  All users of these attributes changed.
  (TestCmd.setUp.MockClient.__getitem__): Removed.
  (TestCmd.setUp.MockClient.__setitem__): - '' -
  (TestIsEnabled.test_is_enabled_does_get_attribute): Removed.
  (TestIsEnabled.test_is_enabled_run_exits_with_failure): Don't use []
  to alter client attribute; modify client.attributes dict directly.
  (TestRemoveCmd.test_remove): Run on full client list.
  (TestApproveCmd.test_approve): - '' -
  (TestDenyCmd.test_approve): - '' - and rename to "test_deny".

Show diffs side-by-side

added added

removed removed

Lines of Context:
42
42
import json
43
43
import unittest
44
44
import logging
45
 
import io
46
 
import tempfile
47
 
import contextlib
48
45
 
49
46
import dbus
50
47
 
64
61
 
65
62
locale.setlocale(locale.LC_ALL, "")
66
63
 
67
 
dbus_busname_domain = "se.recompile"
68
 
dbus_busname = dbus_busname_domain + ".Mandos"
69
 
server_dbus_path = "/"
70
 
server_dbus_interface = dbus_busname_domain + ".Mandos"
71
 
client_dbus_interface = dbus_busname_domain + ".Mandos.Client"
72
 
del dbus_busname_domain
 
64
domain = "se.recompile"
 
65
busname = domain + ".Mandos"
 
66
server_path = "/"
 
67
server_interface = domain + ".Mandos"
 
68
client_interface = domain + ".Mandos.Client"
73
69
version = "1.8.3"
74
70
 
75
71
 
277
273
# Abstract classes first
278
274
class Command(object):
279
275
    """Abstract class for commands"""
280
 
    def run(self, clients, bus=None, mandos=None):
 
276
    def run(self, mandos, clients):
281
277
        """Normal commands should implement run_on_one_client(), but
282
278
        commands which want to operate on all clients at the same time
283
279
        can override this run() method instead."""
284
280
        self.mandos = mandos
285
 
        for clientpath, properties in clients.items():
286
 
            log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
287
 
                      dbus_busname, str(clientpath))
288
 
            client = bus.get_object(dbus_busname, clientpath)
 
281
        for client, properties in clients.items():
289
282
            self.run_on_one_client(client, properties)
290
283
 
291
284
class PrintCmd(Command):
297
290
                    "LastApprovalRequest", "ApprovalDelay",
298
291
                    "ApprovalDuration", "Checker", "ExtendedTimeout",
299
292
                    "Expires", "LastCheckerStatus")
300
 
    def run(self, clients, bus=None, mandos=None):
301
 
        print(self.output(clients.values()))
302
 
    def output(self, clients):
303
 
        raise NotImplementedError()
 
293
    def run(self, mandos, clients):
 
294
        print(self.output(clients))
304
295
 
305
296
class PropertyCmd(Command):
306
297
    """Abstract class for Actions for setting one client property"""
307
298
    def run_on_one_client(self, client, properties):
308
299
        """Set the Client's D-Bus property"""
309
 
        log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
310
 
                  client.__dbus_object_path__,
311
 
                  dbus.PROPERTIES_IFACE, client_dbus_interface,
312
 
                  self.propname, self.value_to_set
313
 
                  if not isinstance(self.value_to_set, dbus.Boolean)
314
 
                  else bool(self.value_to_set))
315
 
        client.Set(client_dbus_interface, self.propname,
316
 
                   self.value_to_set,
 
300
        client.Set(client_interface, self.property, self.value_to_set,
317
301
                   dbus_interface=dbus.PROPERTIES_IFACE)
318
 
    @property
319
 
    def propname(self):
320
 
        raise NotImplementedError()
321
302
 
322
 
class PropertyValueCmd(PropertyCmd):
323
 
    """Abstract class for PropertyCmd recieving a value as argument"""
 
303
class ValueArgumentMixIn(object):
 
304
    """Mixin class for commands taking a value as argument"""
324
305
    def __init__(self, value):
325
306
        self.value_to_set = value
326
307
 
327
 
class MillisecondsPropertyValueArgumentCmd(PropertyValueCmd):
328
 
    """Abstract class for PropertyValueCmd taking a value argument as
329
 
a datetime.timedelta() but should store it as milliseconds."""
 
308
class MillisecondsValueArgumentMixIn(ValueArgumentMixIn):
 
309
    """Mixin class for commands taking a value argument as
 
310
    milliseconds."""
330
311
    @property
331
312
    def value_to_set(self):
332
313
        return self._vts
333
314
    @value_to_set.setter
334
315
    def value_to_set(self, value):
335
 
        """When setting, convert value from a datetime.timedelta"""
336
 
        self._vts = int(round(value.total_seconds() * 1000))
 
316
        """When setting, convert value to a datetime.timedelta"""
 
317
        self._vts = string_to_delta(value).total_seconds() * 1000
337
318
 
338
319
# Actual (non-abstract) command classes
339
320
 
342
323
        self.verbose = verbose
343
324
 
344
325
    def output(self, clients):
345
 
        default_keywords = ("Name", "Enabled", "Timeout",
346
 
                            "LastCheckedOK")
347
 
        keywords = default_keywords
348
326
        if self.verbose:
349
327
            keywords = self.all_keywords
350
 
        return str(self.TableOfClients(clients, keywords))
 
328
        else:
 
329
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
 
330
        return str(self.TableOfClients(clients.values(), keywords))
351
331
 
352
332
    class TableOfClients(object):
353
333
        tableheaders = {
439
419
        return value
440
420
 
441
421
class IsEnabledCmd(Command):
442
 
    def run(self, clients, bus=None, mandos=None):
443
 
        client, properties = next(iter(clients.items()))
 
422
    def run_on_one_client(self, client, properties):
444
423
        if self.is_enabled(client, properties):
445
424
            sys.exit(0)
446
425
        sys.exit(1)
447
426
    def is_enabled(self, client, properties):
448
 
        return properties["Enabled"]
 
427
        return bool(properties["Enabled"])
449
428
 
450
429
class RemoveCmd(Command):
451
430
    def run_on_one_client(self, client, properties):
452
 
        log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)", dbus_busname,
453
 
                  server_dbus_path, server_dbus_interface,
454
 
                  str(client.__dbus_object_path__))
455
431
        self.mandos.RemoveClient(client.__dbus_object_path__)
456
432
 
457
433
class ApproveCmd(Command):
458
434
    def run_on_one_client(self, client, properties):
459
 
        log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
460
 
                  client.__dbus_object_path__, client_dbus_interface)
461
435
        client.Approve(dbus.Boolean(True),
462
 
                       dbus_interface=client_dbus_interface)
 
436
                       dbus_interface=client_interface)
463
437
 
464
438
class DenyCmd(Command):
465
439
    def run_on_one_client(self, client, properties):
466
 
        log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
467
 
                  client.__dbus_object_path__, client_dbus_interface)
468
440
        client.Approve(dbus.Boolean(False),
469
 
                       dbus_interface=client_dbus_interface)
 
441
                       dbus_interface=client_interface)
470
442
 
471
443
class EnableCmd(PropertyCmd):
472
 
    propname = "Enabled"
 
444
    property = "Enabled"
473
445
    value_to_set = dbus.Boolean(True)
474
446
 
475
447
class DisableCmd(PropertyCmd):
476
 
    propname = "Enabled"
 
448
    property = "Enabled"
477
449
    value_to_set = dbus.Boolean(False)
478
450
 
479
451
class BumpTimeoutCmd(PropertyCmd):
480
 
    propname = "LastCheckedOK"
 
452
    property = "LastCheckedOK"
481
453
    value_to_set = ""
482
454
 
483
455
class StartCheckerCmd(PropertyCmd):
484
 
    propname = "CheckerRunning"
 
456
    property = "CheckerRunning"
485
457
    value_to_set = dbus.Boolean(True)
486
458
 
487
459
class StopCheckerCmd(PropertyCmd):
488
 
    propname = "CheckerRunning"
 
460
    property = "CheckerRunning"
489
461
    value_to_set = dbus.Boolean(False)
490
462
 
491
463
class ApproveByDefaultCmd(PropertyCmd):
492
 
    propname = "ApprovedByDefault"
 
464
    property = "ApprovedByDefault"
493
465
    value_to_set = dbus.Boolean(True)
494
466
 
495
467
class DenyByDefaultCmd(PropertyCmd):
496
 
    propname = "ApprovedByDefault"
 
468
    property = "ApprovedByDefault"
497
469
    value_to_set = dbus.Boolean(False)
498
470
 
499
 
class SetCheckerCmd(PropertyValueCmd):
500
 
    propname = "Checker"
501
 
 
502
 
class SetHostCmd(PropertyValueCmd):
503
 
    propname = "Host"
504
 
 
505
 
class SetSecretCmd(PropertyValueCmd):
506
 
    propname = "Secret"
507
 
    @property
508
 
    def value_to_set(self):
509
 
        return self._vts
510
 
    @value_to_set.setter
511
 
    def value_to_set(self, value):
512
 
        """When setting, read data from supplied file object"""
513
 
        self._vts = value.read()
514
 
        value.close()
515
 
 
516
 
class SetTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
517
 
    propname = "Timeout"
518
 
 
519
 
class SetExtendedTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
520
 
    propname = "ExtendedTimeout"
521
 
 
522
 
class SetIntervalCmd(MillisecondsPropertyValueArgumentCmd):
523
 
    propname = "Interval"
524
 
 
525
 
class SetApprovalDelayCmd(MillisecondsPropertyValueArgumentCmd):
526
 
    propname = "ApprovalDelay"
527
 
 
528
 
class SetApprovalDurationCmd(MillisecondsPropertyValueArgumentCmd):
529
 
    propname = "ApprovalDuration"
 
471
class SetCheckerCmd(PropertyCmd, ValueArgumentMixIn):
 
472
    property = "Checker"
 
473
 
 
474
class SetHostCmd(PropertyCmd, ValueArgumentMixIn):
 
475
    property = "Host"
 
476
 
 
477
class SetSecretCmd(PropertyCmd, ValueArgumentMixIn):
 
478
    property = "Secret"
 
479
 
 
480
class SetTimeoutCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
 
481
    property = "Timeout"
 
482
 
 
483
class SetExtendedTimeoutCmd(PropertyCmd,
 
484
                            MillisecondsValueArgumentMixIn):
 
485
    property = "ExtendedTimeout"
 
486
 
 
487
class SetIntervalCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
 
488
    property = "Interval"
 
489
 
 
490
class SetApprovalDelayCmd(PropertyCmd,
 
491
                          MillisecondsValueArgumentMixIn):
 
492
    property = "ApprovalDelay"
 
493
 
 
494
class SetApprovalDurationCmd(PropertyCmd,
 
495
                             MillisecondsValueArgumentMixIn):
 
496
    property = "ApprovalDuration"
 
497
 
 
498
def has_actions(options):
 
499
    return any((options.enable,
 
500
                options.disable,
 
501
                options.bump_timeout,
 
502
                options.start_checker,
 
503
                options.stop_checker,
 
504
                options.is_enabled,
 
505
                options.remove,
 
506
                options.checker is not None,
 
507
                options.timeout is not None,
 
508
                options.extended_timeout is not None,
 
509
                options.interval is not None,
 
510
                options.approved_by_default is not None,
 
511
                options.approval_delay is not None,
 
512
                options.approval_duration is not None,
 
513
                options.host is not None,
 
514
                options.secret is not None,
 
515
                options.approve,
 
516
                options.deny))
530
517
 
531
518
def add_command_line_options(parser):
532
519
    parser.add_argument("--version", action="version",
559
546
                        help="Remove client")
560
547
    parser.add_argument("-c", "--checker",
561
548
                        help="Set checker command for client")
562
 
    parser.add_argument("-t", "--timeout", type=string_to_delta,
 
549
    parser.add_argument("-t", "--timeout",
563
550
                        help="Set timeout for client")
564
 
    parser.add_argument("--extended-timeout", type=string_to_delta,
 
551
    parser.add_argument("--extended-timeout",
565
552
                        help="Set extended timeout for client")
566
 
    parser.add_argument("-i", "--interval", type=string_to_delta,
 
553
    parser.add_argument("-i", "--interval",
567
554
                        help="Set checker interval for client")
568
555
    approve_deny_default = parser.add_mutually_exclusive_group()
569
556
    approve_deny_default.add_argument(
574
561
        "--deny-by-default", action="store_false",
575
562
        dest="approved_by_default",
576
563
        help="Set client to be denied by default")
577
 
    parser.add_argument("--approval-delay", type=string_to_delta,
 
564
    parser.add_argument("--approval-delay",
578
565
                        help="Set delay before client approve/deny")
579
 
    parser.add_argument("--approval-duration", type=string_to_delta,
 
566
    parser.add_argument("--approval-duration",
580
567
                        help="Set duration of one client approval")
581
568
    parser.add_argument("-H", "--host", help="Set host for client")
582
569
    parser.add_argument("-s", "--secret",
588
575
        help="Approve any current client request")
589
576
    approve_deny.add_argument("-D", "--deny", action="store_true",
590
577
                              help="Deny any current client request")
591
 
    parser.add_argument("--debug", action="store_true",
592
 
                        help="Debug mode (show D-Bus commands)")
593
578
    parser.add_argument("--check", action="store_true",
594
579
                        help="Run self-test")
595
580
    parser.add_argument("client", nargs="*", help="Client name")
596
581
 
597
582
 
598
 
def commands_from_options(options):
 
583
def commands_and_clients_from_options(options):
599
584
 
600
585
    commands = []
601
586
 
609
594
        commands.append(DisableCmd())
610
595
 
611
596
    if options.bump_timeout:
612
 
        commands.append(BumpTimeoutCmd())
 
597
        commands.append(BumpTimeoutCmd(options.bump_timeout))
613
598
 
614
599
    if options.start_checker:
615
600
        commands.append(StartCheckerCmd())
620
605
    if options.is_enabled:
621
606
        commands.append(IsEnabledCmd())
622
607
 
 
608
    if options.remove:
 
609
        commands.append(RemoveCmd())
 
610
 
623
611
    if options.checker is not None:
624
 
        commands.append(SetCheckerCmd(options.checker))
 
612
        commands.append(SetCheckerCmd())
625
613
 
626
614
    if options.timeout is not None:
627
615
        commands.append(SetTimeoutCmd(options.timeout))
631
619
            SetExtendedTimeoutCmd(options.extended_timeout))
632
620
 
633
621
    if options.interval is not None:
634
 
        commands.append(SetIntervalCmd(options.interval))
 
622
        command.append(SetIntervalCmd(options.interval))
635
623
 
636
624
    if options.approved_by_default is not None:
637
625
        if options.approved_by_default:
638
 
            commands.append(ApproveByDefaultCmd())
 
626
            command.append(ApproveByDefaultCmd())
639
627
        else:
640
 
            commands.append(DenyByDefaultCmd())
 
628
            command.append(DenyByDefaultCmd())
641
629
 
642
630
    if options.approval_delay is not None:
643
 
        commands.append(SetApprovalDelayCmd(options.approval_delay))
 
631
        command.append(SetApprovalDelayCmd(options.approval_delay))
644
632
 
645
633
    if options.approval_duration is not None:
646
 
        commands.append(
 
634
        command.append(
647
635
            SetApprovalDurationCmd(options.approval_duration))
648
636
 
649
637
    if options.host is not None:
650
 
        commands.append(SetHostCmd(options.host))
 
638
        command.append(SetHostCmd(options.host))
651
639
 
652
640
    if options.secret is not None:
653
 
        commands.append(SetSecretCmd(options.secret))
 
641
        command.append(SetSecretCmd(options.secret))
654
642
 
655
643
    if options.approve:
656
644
        commands.append(ApproveCmd())
658
646
    if options.deny:
659
647
        commands.append(DenyCmd())
660
648
 
661
 
    if options.remove:
662
 
        commands.append(RemoveCmd())
663
 
 
664
649
    # If no command option has been given, show table of clients,
665
650
    # optionally verbosely
666
651
    if not commands:
667
652
        commands.append(PrintTableCmd(verbose=options.verbose))
668
653
 
669
 
    return commands
670
 
 
671
 
 
672
 
def check_option_syntax(parser, options):
673
 
    """Apply additional restrictions on options, not expressible in
674
 
argparse"""
675
 
 
676
 
    def has_actions(options):
677
 
        return any((options.enable,
678
 
                    options.disable,
679
 
                    options.bump_timeout,
680
 
                    options.start_checker,
681
 
                    options.stop_checker,
682
 
                    options.is_enabled,
683
 
                    options.remove,
684
 
                    options.checker is not None,
685
 
                    options.timeout is not None,
686
 
                    options.extended_timeout is not None,
687
 
                    options.interval is not None,
688
 
                    options.approved_by_default is not None,
689
 
                    options.approval_delay is not None,
690
 
                    options.approval_duration is not None,
691
 
                    options.host is not None,
692
 
                    options.secret is not None,
693
 
                    options.approve,
694
 
                    options.deny))
 
654
    return commands, options.client
 
655
 
 
656
 
 
657
def main():
 
658
    parser = argparse.ArgumentParser()
 
659
 
 
660
    add_command_line_options(parser)
 
661
 
 
662
    options = parser.parse_args()
695
663
 
696
664
    if has_actions(options) and not (options.client or options.all):
697
665
        parser.error("Options require clients names or --all.")
704
672
        parser.error("--all requires an action.")
705
673
    if options.is_enabled and len(options.client) > 1:
706
674
        parser.error("--is-enabled requires exactly one client")
707
 
    if options.remove:
708
 
        options.remove = False
709
 
        if has_actions(options) and not options.deny:
710
 
            parser.error("--remove can only be combined with --deny")
711
 
        options.remove = True
712
 
 
713
 
 
714
 
def main():
715
 
    parser = argparse.ArgumentParser()
716
 
 
717
 
    add_command_line_options(parser)
718
 
 
719
 
    options = parser.parse_args()
720
 
 
721
 
    check_option_syntax(parser, options)
722
 
 
723
 
    clientnames = options.client
724
 
 
725
 
    if options.debug:
726
 
        log.setLevel(logging.DEBUG)
 
675
 
 
676
    commands, clientnames = commands_and_clients_from_options(options)
727
677
 
728
678
    try:
729
679
        bus = dbus.SystemBus()
730
 
        log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
731
 
                  dbus_busname, server_dbus_path)
732
 
        mandos_dbus_objc = bus.get_object(dbus_busname,
733
 
                                          server_dbus_path)
 
680
        mandos_dbus_objc = bus.get_object(busname, server_path)
734
681
    except dbus.exceptions.DBusException:
735
682
        log.critical("Could not connect to Mandos server")
736
683
        sys.exit(1)
737
684
 
738
685
    mandos_serv = dbus.Interface(mandos_dbus_objc,
739
 
                                 dbus_interface=server_dbus_interface)
 
686
                                 dbus_interface=server_interface)
740
687
    mandos_serv_object_manager = dbus.Interface(
741
688
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
742
689
 
748
695
    dbus_filter = NullFilter()
749
696
    try:
750
697
        dbus_logger.addFilter(dbus_filter)
751
 
        log.debug("D-Bus: %s:%s:%s.GetManagedObjects()", dbus_busname,
752
 
                  server_dbus_path, dbus.OBJECT_MANAGER_IFACE)
753
 
        mandos_clients = {path: ifs_and_props[client_dbus_interface]
 
698
        mandos_clients = {path: ifs_and_props[client_interface]
754
699
                          for path, ifs_and_props in
755
700
                          mandos_serv_object_manager
756
701
                          .GetManagedObjects().items()
757
 
                          if client_dbus_interface in ifs_and_props}
 
702
                          if client_interface in ifs_and_props}
758
703
    except dbus.exceptions.DBusException as e:
759
704
        log.critical("Failed to access Mandos server through D-Bus:"
760
705
                     "\n%s", e)
767
712
    clients = {}
768
713
 
769
714
    if not clientnames:
770
 
        clients = {objpath: properties
771
 
                   for objpath, properties in mandos_clients.items()}
 
715
        clients = {bus.get_object(busname, path): properties
 
716
                   for path, properties in mandos_clients.items()}
772
717
    else:
773
718
        for name in clientnames:
774
 
            for objpath, properties in mandos_clients.items():
775
 
                if properties["Name"] == name:
776
 
                    clients[objpath] = properties
 
719
            for path, client in mandos_clients.items():
 
720
                if client["Name"] == name:
 
721
                    client_objc = bus.get_object(busname, path)
 
722
                    clients[client_objc] = client
777
723
                    break
778
724
            else:
779
725
                log.critical("Client not found on server: %r", name)
780
726
                sys.exit(1)
781
727
 
782
728
    # Run all commands on clients
783
 
    commands = commands_from_options(options)
784
729
    for command in commands:
785
 
        command.run(clients, bus, mandos_serv)
 
730
        command.run(mandos_serv, clients)
786
731
 
787
732
 
788
733
class Test_milliseconds_to_string(unittest.TestCase):
800
745
 
801
746
class Test_string_to_delta(unittest.TestCase):
802
747
    def test_handles_basic_rfc3339(self):
803
 
        self.assertEqual(string_to_delta("PT0S"),
804
 
                         datetime.timedelta())
805
 
        self.assertEqual(string_to_delta("P0D"),
806
 
                         datetime.timedelta())
807
 
        self.assertEqual(string_to_delta("PT1S"),
808
 
                         datetime.timedelta(0, 1))
809
748
        self.assertEqual(string_to_delta("PT2H"),
810
749
                         datetime.timedelta(0, 7200))
811
750
    def test_falls_back_to_pre_1_6_1_with_warning(self):
837
776
        testcase = self
838
777
        class MockClient(object):
839
778
            def __init__(self, name, **attributes):
840
 
                self.__dbus_object_path__ = "/clients/{}".format(name)
 
779
                self.__dbus_object_path__ = "objpath_{}".format(name)
841
780
                self.attributes = attributes
842
781
                self.attributes["Name"] = name
843
782
                self.calls = []
844
 
            def Set(self, interface, propname, value, dbus_interface):
845
 
                testcase.assertEqual(interface, client_dbus_interface)
846
 
                testcase.assertEqual(dbus_interface,
847
 
                                     dbus.PROPERTIES_IFACE)
848
 
                self.attributes[propname] = value
849
 
            def Get(self, interface, propname, dbus_interface):
850
 
                testcase.assertEqual(interface, client_dbus_interface)
851
 
                testcase.assertEqual(dbus_interface,
852
 
                                     dbus.PROPERTIES_IFACE)
853
 
                return self.attributes[propname]
 
783
            def Set(self, interface, property, value, dbus_interface):
 
784
                testcase.assertEqual(interface, client_interface)
 
785
                testcase.assertEqual(dbus_interface,
 
786
                                     dbus.PROPERTIES_IFACE)
 
787
                self.attributes[property] = value
 
788
                self.calls.append(("Set", (interface, property, value,
 
789
                                           dbus_interface)))
 
790
            def Get(self, interface, property, dbus_interface):
 
791
                testcase.assertEqual(interface, client_interface)
 
792
                testcase.assertEqual(dbus_interface,
 
793
                                     dbus.PROPERTIES_IFACE)
 
794
                self.calls.append(("Get", (interface, property,
 
795
                                           dbus_interface)))
 
796
                return self.attributes[property]
854
797
            def Approve(self, approve, dbus_interface):
855
 
                testcase.assertEqual(dbus_interface,
856
 
                                     client_dbus_interface)
 
798
                testcase.assertEqual(dbus_interface, client_interface)
857
799
                self.calls.append(("Approve", (approve,
858
800
                                               dbus_interface)))
859
801
        self.client = MockClient(
906
848
            LastCheckerStatus=-2)
907
849
        self.clients =  collections.OrderedDict(
908
850
            [
909
 
                ("/clients/foo", self.client.attributes),
910
 
                ("/clients/barbar", self.other_client.attributes),
 
851
                (self.client, self.client.attributes),
 
852
                (self.other_client, self.other_client.attributes),
911
853
            ])
912
 
        self.one_client = {"/clients/foo": self.client.attributes}
913
 
    @property
914
 
    def bus(self):
915
 
        class Bus(object):
916
 
            @staticmethod
917
 
            def get_object(client_bus_name, path):
918
 
                self.assertEqual(client_bus_name, dbus_busname)
919
 
                return {
920
 
                    "/clients/foo": self.client,
921
 
                    "/clients/barbar": self.other_client,
922
 
                }[path]
923
 
        return Bus()
 
854
        self.one_client = {self.client: self.client.attributes}
924
855
 
925
856
class TestPrintTableCmd(TestCmd):
926
857
    def test_normal(self):
927
 
        output = PrintTableCmd().output(self.clients.values())
928
 
        expected_output = "\n".join((
929
 
            "Name   Enabled Timeout  Last Successful Check",
930
 
            "foo    Yes     00:05:00 2019-02-03T00:00:00  ",
931
 
            "barbar Yes     00:05:00 2019-02-04T00:00:00  ",
932
 
        ))
 
858
        output = PrintTableCmd().output(self.clients)
 
859
        expected_output = """
 
860
Name   Enabled Timeout  Last Successful Check
 
861
foo    Yes     00:05:00 2019-02-03T00:00:00  
 
862
barbar Yes     00:05:00 2019-02-04T00:00:00  
 
863
"""[1:-1]
933
864
        self.assertEqual(output, expected_output)
934
865
    def test_verbose(self):
935
 
        output = PrintTableCmd(verbose=True).output(
936
 
            self.clients.values())
937
 
        columns = (
938
 
            (
939
 
                "Name   ",
940
 
                "foo    ",
941
 
                "barbar ",
942
 
            ),(
943
 
                "Enabled ",
944
 
                "Yes     ",
945
 
                "Yes     ",
946
 
            ),(
947
 
                "Timeout  ",
948
 
                "00:05:00 ",
949
 
                "00:05:00 ",
950
 
            ),(
951
 
                "Last Successful Check ",
952
 
                "2019-02-03T00:00:00   ",
953
 
                "2019-02-04T00:00:00   ",
954
 
            ),(
955
 
                "Created             ",
956
 
                "2019-01-02T00:00:00 ",
957
 
                "2019-01-03T00:00:00 ",
958
 
            ),(
959
 
                "Interval ",
960
 
                "00:02:00 ",
961
 
                "00:02:00 ",
962
 
            ),(
963
 
                "Host            ",
964
 
                "foo.example.org ",
965
 
                "192.0.2.3       ",
966
 
            ),(
967
 
                ("Key ID                                             "
968
 
                 "              "),
969
 
                ("92ed150794387c03ce684574b1139a6594a34f895daaaf09fd8"
970
 
                 "ea90a27cddb12 "),
971
 
                ("0558568eedd67d622f5c83b35a115f796ab612cff5ad227247e"
972
 
                 "46c2b020f441c "),
973
 
            ),(
974
 
                "Fingerprint                              ",
975
 
                "778827225BA7DE539C5A7CFA59CFF7CDBD9A5920 ",
976
 
                "3E393AEAEFB84C7E89E2F547B3A107558FCA3A27 ",
977
 
            ),(
978
 
                "Check Is Running ",
979
 
                "No               ",
980
 
                "Yes              ",
981
 
            ),(
982
 
                "Last Enabled        ",
983
 
                "2019-01-03T00:00:00 ",
984
 
                "2019-01-04T00:00:00 ",
985
 
            ),(
986
 
                "Approval Is Pending ",
987
 
                "No                  ",
988
 
                "No                  ",
989
 
            ),(
990
 
                "Approved By Default ",
991
 
                "Yes                 ",
992
 
                "No                  ",
993
 
            ),(
994
 
                "Last Approval Request ",
995
 
                "                      ",
996
 
                "2019-01-03T00:00:00   ",
997
 
            ),(
998
 
                "Approval Delay ",
999
 
                "00:00:00       ",
1000
 
                "00:00:30       ",
1001
 
            ),(
1002
 
                "Approval Duration ",
1003
 
                "00:00:01          ",
1004
 
                "00:00:01          ",
1005
 
            ),(
1006
 
                "Checker              ",
1007
 
                "fping -q -- %(host)s ",
1008
 
                ":                    ",
1009
 
            ),(
1010
 
                "Extended Timeout ",
1011
 
                "00:15:00         ",
1012
 
                "00:15:00         ",
1013
 
            ),(
1014
 
                "Expires             ",
1015
 
                "2019-02-04T00:00:00 ",
1016
 
                "2019-02-05T00:00:00 ",
1017
 
            ),(
1018
 
                "Last Checker Status",
1019
 
                "0                  ",
1020
 
                "-2                 ",
1021
 
            )
1022
 
        )
1023
 
        num_lines = max(len(rows) for rows in columns)
1024
 
        expected_output = "\n".join("".join(rows[line]
1025
 
                                            for rows in columns)
1026
 
                                    for line in range(num_lines))
 
866
        output = PrintTableCmd(verbose=True).output(self.clients)
 
867
        expected_output = """
 
868
Name   Enabled Timeout  Last Successful Check Created             Interval Host            Key ID                                                           Fingerprint                              Check Is Running Last Enabled        Approval Is Pending Approved By Default Last Approval Request Approval Delay Approval Duration Checker              Extended Timeout Expires             Last Checker Status
 
869
foo    Yes     00:05:00 2019-02-03T00:00:00   2019-01-02T00:00:00 00:02:00 foo.example.org 92ed150794387c03ce684574b1139a6594a34f895daaaf09fd8ea90a27cddb12 778827225BA7DE539C5A7CFA59CFF7CDBD9A5920 No               2019-01-03T00:00:00 No                  Yes                                       00:00:00       00:00:01          fping -q -- %(host)s 00:15:00         2019-02-04T00:00:00 0                  
 
870
barbar Yes     00:05:00 2019-02-04T00:00:00   2019-01-03T00:00:00 00:02:00 192.0.2.3       0558568eedd67d622f5c83b35a115f796ab612cff5ad227247e46c2b020f441c 3E393AEAEFB84C7E89E2F547B3A107558FCA3A27 Yes              2019-01-04T00:00:00 No                  No                  2019-01-03T00:00:00   00:00:30       00:00:01          :                    00:15:00         2019-02-05T00:00:00 -2                 
 
871
"""[1:-1]
1027
872
        self.assertEqual(output, expected_output)
1028
873
    def test_one_client(self):
1029
 
        output = PrintTableCmd().output(self.one_client.values())
 
874
        output = PrintTableCmd().output(self.one_client)
1030
875
        expected_output = """
1031
876
Name Enabled Timeout  Last Successful Check
1032
877
foo  Yes     00:05:00 2019-02-03T00:00:00  
1097
942
 
1098
943
class TestIsEnabledCmd(TestCmd):
1099
944
    def test_is_enabled(self):
1100
 
        self.assertTrue(all(IsEnabledCmd().is_enabled(client,
1101
 
                                                      properties)
1102
 
                            for client, properties
1103
 
                            in self.clients.items()))
 
945
        self.assertTrue(all(IsEnabledCmd().is_enabled(client, properties)
 
946
                            for client, properties in self.clients.items()))
1104
947
    def test_is_enabled_run_exits_successfully(self):
1105
948
        with self.assertRaises(SystemExit) as e:
1106
 
            IsEnabledCmd().run(self.one_client)
 
949
            IsEnabledCmd().run(None, self.one_client)
1107
950
        if e.exception.code is not None:
1108
951
            self.assertEqual(e.exception.code, 0)
1109
952
        else:
1111
954
    def test_is_enabled_run_exits_with_failure(self):
1112
955
        self.client.attributes["Enabled"] = dbus.Boolean(False)
1113
956
        with self.assertRaises(SystemExit) as e:
1114
 
            IsEnabledCmd().run(self.one_client)
 
957
            IsEnabledCmd().run(None, self.one_client)
1115
958
        if isinstance(e.exception.code, int):
1116
959
            self.assertNotEqual(e.exception.code, 0)
1117
960
        else:
1126
969
                self.calls.append(("RemoveClient", (dbus_path,)))
1127
970
        mandos = MockMandos()
1128
971
        super(TestRemoveCmd, self).setUp()
1129
 
        RemoveCmd().run(self.clients, self.bus, mandos)
 
972
        RemoveCmd().run(mandos, self.clients)
1130
973
        self.assertEqual(len(mandos.calls), 2)
1131
 
        for clientpath in self.clients:
1132
 
            self.assertIn(("RemoveClient", (clientpath,)),
 
974
        for client in self.clients:
 
975
            self.assertIn(("RemoveClient",
 
976
                           (client.__dbus_object_path__,)),
1133
977
                          mandos.calls)
1134
978
 
1135
979
class TestApproveCmd(TestCmd):
1136
980
    def test_approve(self):
1137
 
        ApproveCmd().run(self.clients, self.bus)
1138
 
        for clientpath in self.clients:
1139
 
            client = self.bus.get_object(dbus_busname, clientpath)
1140
 
            self.assertIn(("Approve", (True, client_dbus_interface)),
 
981
        ApproveCmd().run(None, self.clients)
 
982
        for client in self.clients:
 
983
            self.assertIn(("Approve", (True, client_interface)),
1141
984
                          client.calls)
1142
985
 
1143
986
class TestDenyCmd(TestCmd):
1144
987
    def test_deny(self):
1145
 
        DenyCmd().run(self.clients, self.bus)
1146
 
        for clientpath in self.clients:
1147
 
            client = self.bus.get_object(dbus_busname, clientpath)
1148
 
            self.assertIn(("Approve", (False, client_dbus_interface)),
 
988
        DenyCmd().run(None, self.clients)
 
989
        for client in self.clients:
 
990
            self.assertIn(("Approve", (False, client_interface)),
1149
991
                          client.calls)
1150
992
 
1151
 
class TestEnableCmd(TestCmd):
1152
 
    def test_enable(self):
1153
 
        for clientpath in self.clients:
1154
 
            client = self.bus.get_object(dbus_busname, clientpath)
1155
 
            client.attributes["Enabled"] = False
1156
 
 
1157
 
        EnableCmd().run(self.clients, self.bus)
1158
 
 
1159
 
        for clientpath in self.clients:
1160
 
            client = self.bus.get_object(dbus_busname, clientpath)
1161
 
            self.assertTrue(client.attributes["Enabled"])
1162
 
 
1163
 
class TestDisableCmd(TestCmd):
1164
 
    def test_disable(self):
1165
 
        DisableCmd().run(self.clients, self.bus)
1166
 
        for clientpath in self.clients:
1167
 
            client = self.bus.get_object(dbus_busname, clientpath)
1168
 
            self.assertFalse(client.attributes["Enabled"])
1169
 
 
1170
 
class Unique(object):
1171
 
    """Class for objects which exist only to be unique objects, since
1172
 
unittest.mock.sentinel only exists in Python 3.3"""
1173
 
 
1174
 
class TestPropertyCmd(TestCmd):
1175
 
    """Abstract class for tests of PropertyCmd classes"""
1176
 
    def runTest(self):
1177
 
        if not hasattr(self, "command"):
1178
 
            return
1179
 
        values_to_get = getattr(self, "values_to_get",
1180
 
                                self.values_to_set)
1181
 
        for value_to_set, value_to_get in zip(self.values_to_set,
1182
 
                                              values_to_get):
1183
 
            for clientpath in self.clients:
1184
 
                client = self.bus.get_object(dbus_busname, clientpath)
1185
 
                old_value = client.attributes[self.propname]
1186
 
                self.assertNotIsInstance(old_value, Unique)
1187
 
                client.attributes[self.propname] = Unique()
1188
 
            self.run_command(value_to_set, self.clients)
1189
 
            for clientpath in self.clients:
1190
 
                client = self.bus.get_object(dbus_busname, clientpath)
1191
 
                value = client.attributes[self.propname]
1192
 
                self.assertNotIsInstance(value, Unique)
1193
 
                self.assertEqual(value, value_to_get)
1194
 
    def run_command(self, value, clients):
1195
 
        self.command().run(clients, self.bus)
1196
 
 
1197
 
class TestBumpTimeoutCmd(TestPropertyCmd):
1198
 
    command = BumpTimeoutCmd
1199
 
    propname = "LastCheckedOK"
1200
 
    values_to_set = [""]
1201
 
 
1202
 
class TestStartCheckerCmd(TestPropertyCmd):
1203
 
    command = StartCheckerCmd
1204
 
    propname = "CheckerRunning"
1205
 
    values_to_set = [dbus.Boolean(True)]
1206
 
 
1207
 
class TestStopCheckerCmd(TestPropertyCmd):
1208
 
    command = StopCheckerCmd
1209
 
    propname = "CheckerRunning"
1210
 
    values_to_set = [dbus.Boolean(False)]
1211
 
 
1212
 
class TestApproveByDefaultCmd(TestPropertyCmd):
1213
 
    command = ApproveByDefaultCmd
1214
 
    propname = "ApprovedByDefault"
1215
 
    values_to_set = [dbus.Boolean(True)]
1216
 
 
1217
 
class TestDenyByDefaultCmd(TestPropertyCmd):
1218
 
    command = DenyByDefaultCmd
1219
 
    propname = "ApprovedByDefault"
1220
 
    values_to_set = [dbus.Boolean(False)]
1221
 
 
1222
 
class TestPropertyValueCmd(TestPropertyCmd):
1223
 
    """Abstract class for tests of PropertyValueCmd classes"""
1224
 
    def runTest(self):
1225
 
        if type(self) is TestPropertyValueCmd:
1226
 
            return
1227
 
        return super(TestPropertyValueCmd, self).runTest()
1228
 
    def run_command(self, value, clients):
1229
 
        self.command(value).run(clients, self.bus)
1230
 
 
1231
 
class TestSetCheckerCmd(TestPropertyValueCmd):
1232
 
    command = SetCheckerCmd
1233
 
    propname = "Checker"
1234
 
    values_to_set = ["", ":", "fping -q -- %s"]
1235
 
 
1236
 
class TestSetHostCmd(TestPropertyValueCmd):
1237
 
    command = SetHostCmd
1238
 
    propname = "Host"
1239
 
    values_to_set = ["192.0.2.3", "foo.example.org"]
1240
 
 
1241
 
class TestSetSecretCmd(TestPropertyValueCmd):
1242
 
    command = SetSecretCmd
1243
 
    propname = "Secret"
1244
 
    values_to_set = [io.BytesIO(b""),
1245
 
                     io.BytesIO(b"secret\0xyzzy\nbar")]
1246
 
    values_to_get = [b"", b"secret\0xyzzy\nbar"]
1247
 
 
1248
 
class TestSetTimeoutCmd(TestPropertyValueCmd):
1249
 
    command = SetTimeoutCmd
1250
 
    propname = "Timeout"
1251
 
    values_to_set = [datetime.timedelta(),
1252
 
                     datetime.timedelta(minutes=5),
1253
 
                     datetime.timedelta(seconds=1),
1254
 
                     datetime.timedelta(weeks=1),
1255
 
                     datetime.timedelta(weeks=52)]
1256
 
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1257
 
 
1258
 
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
1259
 
    command = SetExtendedTimeoutCmd
1260
 
    propname = "ExtendedTimeout"
1261
 
    values_to_set = [datetime.timedelta(),
1262
 
                     datetime.timedelta(minutes=5),
1263
 
                     datetime.timedelta(seconds=1),
1264
 
                     datetime.timedelta(weeks=1),
1265
 
                     datetime.timedelta(weeks=52)]
1266
 
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1267
 
 
1268
 
class TestSetIntervalCmd(TestPropertyValueCmd):
1269
 
    command = SetIntervalCmd
1270
 
    propname = "Interval"
1271
 
    values_to_set = [datetime.timedelta(),
1272
 
                     datetime.timedelta(minutes=5),
1273
 
                     datetime.timedelta(seconds=1),
1274
 
                     datetime.timedelta(weeks=1),
1275
 
                     datetime.timedelta(weeks=52)]
1276
 
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1277
 
 
1278
 
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
1279
 
    command = SetApprovalDelayCmd
1280
 
    propname = "ApprovalDelay"
1281
 
    values_to_set = [datetime.timedelta(),
1282
 
                     datetime.timedelta(minutes=5),
1283
 
                     datetime.timedelta(seconds=1),
1284
 
                     datetime.timedelta(weeks=1),
1285
 
                     datetime.timedelta(weeks=52)]
1286
 
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1287
 
 
1288
 
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
1289
 
    command = SetApprovalDurationCmd
1290
 
    propname = "ApprovalDuration"
1291
 
    values_to_set = [datetime.timedelta(),
1292
 
                     datetime.timedelta(minutes=5),
1293
 
                     datetime.timedelta(seconds=1),
1294
 
                     datetime.timedelta(weeks=1),
1295
 
                     datetime.timedelta(weeks=52)]
1296
 
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1297
 
 
1298
 
class Test_command_from_options(unittest.TestCase):
1299
 
    def setUp(self):
1300
 
        self.parser = argparse.ArgumentParser()
1301
 
        add_command_line_options(self.parser)
1302
 
    def assert_command_from_args(self, args, command_cls,
1303
 
                                 **cmd_attrs):
1304
 
        """Assert that parsing ARGS should result in an instance of
1305
 
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
1306
 
        options = self.parser.parse_args(args)
1307
 
        check_option_syntax(self.parser, options)
1308
 
        commands = commands_from_options(options)
1309
 
        self.assertEqual(len(commands), 1)
1310
 
        command = commands[0]
1311
 
        self.assertIsInstance(command, command_cls)
1312
 
        for key, value in cmd_attrs.items():
1313
 
            self.assertEqual(getattr(command, key), value)
1314
 
    def test_print_table(self):
1315
 
        self.assert_command_from_args([], PrintTableCmd,
1316
 
                                      verbose=False)
1317
 
 
1318
 
    def test_print_table_verbose(self):
1319
 
        self.assert_command_from_args(["--verbose"], PrintTableCmd,
1320
 
                                      verbose=True)
1321
 
 
1322
 
    def test_print_table_verbose_short(self):
1323
 
        self.assert_command_from_args(["-v"], PrintTableCmd,
1324
 
                                      verbose=True)
1325
 
 
1326
 
    def test_enable(self):
1327
 
        self.assert_command_from_args(["--enable", "foo"], EnableCmd)
1328
 
 
1329
 
    def test_enable_short(self):
1330
 
        self.assert_command_from_args(["-e", "foo"], EnableCmd)
1331
 
 
1332
 
    def test_disable(self):
1333
 
        self.assert_command_from_args(["--disable", "foo"],
1334
 
                                      DisableCmd)
1335
 
 
1336
 
    def test_disable_short(self):
1337
 
        self.assert_command_from_args(["-d", "foo"], DisableCmd)
1338
 
 
1339
 
    def test_bump_timeout(self):
1340
 
        self.assert_command_from_args(["--bump-timeout", "foo"],
1341
 
                                      BumpTimeoutCmd)
1342
 
 
1343
 
    def test_bump_timeout_short(self):
1344
 
        self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
1345
 
 
1346
 
    def test_start_checker(self):
1347
 
        self.assert_command_from_args(["--start-checker", "foo"],
1348
 
                                      StartCheckerCmd)
1349
 
 
1350
 
    def test_stop_checker(self):
1351
 
        self.assert_command_from_args(["--stop-checker", "foo"],
1352
 
                                      StopCheckerCmd)
1353
 
 
1354
 
    def test_remove(self):
1355
 
        self.assert_command_from_args(["--remove", "foo"],
1356
 
                                      RemoveCmd)
1357
 
 
1358
 
    def test_remove_short(self):
1359
 
        self.assert_command_from_args(["-r", "foo"], RemoveCmd)
1360
 
 
1361
 
    def test_checker(self):
1362
 
        self.assert_command_from_args(["--checker", ":", "foo"],
1363
 
                                      SetCheckerCmd, value_to_set=":")
1364
 
 
1365
 
    def test_checker_empty(self):
1366
 
        self.assert_command_from_args(["--checker", "", "foo"],
1367
 
                                      SetCheckerCmd, value_to_set="")
1368
 
 
1369
 
    def test_checker_short(self):
1370
 
        self.assert_command_from_args(["-c", ":", "foo"],
1371
 
                                      SetCheckerCmd, value_to_set=":")
1372
 
 
1373
 
    def test_timeout(self):
1374
 
        self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1375
 
                                      SetTimeoutCmd,
1376
 
                                      value_to_set=300000)
1377
 
 
1378
 
    def test_timeout_short(self):
1379
 
        self.assert_command_from_args(["-t", "PT5M", "foo"],
1380
 
                                      SetTimeoutCmd,
1381
 
                                      value_to_set=300000)
1382
 
 
1383
 
    def test_extended_timeout(self):
1384
 
        self.assert_command_from_args(["--extended-timeout", "PT15M",
1385
 
                                       "foo"],
1386
 
                                      SetExtendedTimeoutCmd,
1387
 
                                      value_to_set=900000)
1388
 
 
1389
 
    def test_interval(self):
1390
 
        self.assert_command_from_args(["--interval", "PT2M", "foo"],
1391
 
                                      SetIntervalCmd,
1392
 
                                      value_to_set=120000)
1393
 
 
1394
 
    def test_interval_short(self):
1395
 
        self.assert_command_from_args(["-i", "PT2M", "foo"],
1396
 
                                      SetIntervalCmd,
1397
 
                                      value_to_set=120000)
1398
 
 
1399
 
    def test_approve_by_default(self):
1400
 
        self.assert_command_from_args(["--approve-by-default", "foo"],
1401
 
                                      ApproveByDefaultCmd)
1402
 
 
1403
 
    def test_deny_by_default(self):
1404
 
        self.assert_command_from_args(["--deny-by-default", "foo"],
1405
 
                                      DenyByDefaultCmd)
1406
 
 
1407
 
    def test_approval_delay(self):
1408
 
        self.assert_command_from_args(["--approval-delay", "PT30S",
1409
 
                                       "foo"], SetApprovalDelayCmd,
1410
 
                                      value_to_set=30000)
1411
 
 
1412
 
    def test_approval_duration(self):
1413
 
        self.assert_command_from_args(["--approval-duration", "PT1S",
1414
 
                                       "foo"], SetApprovalDurationCmd,
1415
 
                                      value_to_set=1000)
1416
 
 
1417
 
    def test_host(self):
1418
 
        self.assert_command_from_args(["--host", "foo.example.org",
1419
 
                                       "foo"], SetHostCmd,
1420
 
                                      value_to_set="foo.example.org")
1421
 
 
1422
 
    def test_host_short(self):
1423
 
        self.assert_command_from_args(["-H", "foo.example.org",
1424
 
                                       "foo"], SetHostCmd,
1425
 
                                      value_to_set="foo.example.org")
1426
 
 
1427
 
    def test_secret_devnull(self):
1428
 
        self.assert_command_from_args(["--secret", os.path.devnull,
1429
 
                                       "foo"], SetSecretCmd,
1430
 
                                      value_to_set=b"")
1431
 
 
1432
 
    def test_secret_tempfile(self):
1433
 
        with tempfile.NamedTemporaryFile(mode="r+b") as f:
1434
 
            value = b"secret\0xyzzy\nbar"
1435
 
            f.write(value)
1436
 
            f.seek(0)
1437
 
            self.assert_command_from_args(["--secret", f.name,
1438
 
                                           "foo"], SetSecretCmd,
1439
 
                                          value_to_set=value)
1440
 
 
1441
 
    def test_secret_devnull_short(self):
1442
 
        self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1443
 
                                      SetSecretCmd, value_to_set=b"")
1444
 
 
1445
 
    def test_secret_tempfile_short(self):
1446
 
        with tempfile.NamedTemporaryFile(mode="r+b") as f:
1447
 
            value = b"secret\0xyzzy\nbar"
1448
 
            f.write(value)
1449
 
            f.seek(0)
1450
 
            self.assert_command_from_args(["-s", f.name, "foo"],
1451
 
                                          SetSecretCmd,
1452
 
                                          value_to_set=value)
1453
 
 
1454
 
    def test_approve(self):
1455
 
        self.assert_command_from_args(["--approve", "foo"],
1456
 
                                      ApproveCmd)
1457
 
 
1458
 
    def test_approve_short(self):
1459
 
        self.assert_command_from_args(["-A", "foo"], ApproveCmd)
1460
 
 
1461
 
    def test_deny(self):
1462
 
        self.assert_command_from_args(["--deny", "foo"], DenyCmd)
1463
 
 
1464
 
    def test_deny_short(self):
1465
 
        self.assert_command_from_args(["-D", "foo"], DenyCmd)
1466
 
 
1467
 
    def test_dump_json(self):
1468
 
        self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
1469
 
 
1470
 
    def test_is_enabled(self):
1471
 
        self.assert_command_from_args(["--is-enabled", "foo"],
1472
 
                                      IsEnabledCmd)
1473
 
 
1474
 
    def test_is_enabled_short(self):
1475
 
        self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
1476
 
 
1477
 
    def test_deny_before_remove(self):
1478
 
        options = self.parser.parse_args(["--deny", "--remove",
1479
 
                                          "foo"])
1480
 
        check_option_syntax(self.parser, options)
1481
 
        commands = commands_from_options(options)
1482
 
        self.assertEqual(len(commands), 2)
1483
 
        self.assertIsInstance(commands[0], DenyCmd)
1484
 
        self.assertIsInstance(commands[1], RemoveCmd)
1485
 
 
1486
 
    def test_deny_before_remove_reversed(self):
1487
 
        options = self.parser.parse_args(["--remove", "--deny",
1488
 
                                          "--all"])
1489
 
        check_option_syntax(self.parser, options)
1490
 
        commands = commands_from_options(options)
1491
 
        self.assertEqual(len(commands), 2)
1492
 
        self.assertIsInstance(commands[0], DenyCmd)
1493
 
        self.assertIsInstance(commands[1], RemoveCmd)
1494
 
 
1495
 
 
1496
 
class Test_check_option_syntax(unittest.TestCase):
1497
 
    # This mostly corresponds to the definition from has_actions() in
1498
 
    # check_option_syntax()
1499
 
    actions = {
1500
 
        # The actual values set here are not that important, but we do
1501
 
        # at least stick to the correct types, even though they are
1502
 
        # never used
1503
 
        "enable": True,
1504
 
        "disable": True,
1505
 
        "bump_timeout": True,
1506
 
        "start_checker": True,
1507
 
        "stop_checker": True,
1508
 
        "is_enabled": True,
1509
 
        "remove": True,
1510
 
        "checker": "x",
1511
 
        "timeout": datetime.timedelta(),
1512
 
        "extended_timeout": datetime.timedelta(),
1513
 
        "interval": datetime.timedelta(),
1514
 
        "approved_by_default": True,
1515
 
        "approval_delay": datetime.timedelta(),
1516
 
        "approval_duration": datetime.timedelta(),
1517
 
        "host": "x",
1518
 
        "secret": io.BytesIO(b"x"),
1519
 
        "approve": True,
1520
 
        "deny": True,
1521
 
    }
1522
 
 
1523
 
    def setUp(self):
1524
 
        self.parser = argparse.ArgumentParser()
1525
 
        add_command_line_options(self.parser)
1526
 
 
1527
 
    @contextlib.contextmanager
1528
 
    def assertParseError(self):
1529
 
        with self.assertRaises(SystemExit) as e:
1530
 
            with self.temporarily_suppress_stderr():
1531
 
                yield
1532
 
        # Exit code from argparse is guaranteed to be "2".  Reference:
1533
 
        # https://docs.python.org/3/library
1534
 
        # /argparse.html#exiting-methods
1535
 
        self.assertEqual(e.exception.code, 2)
1536
 
 
1537
 
    @staticmethod
1538
 
    @contextlib.contextmanager
1539
 
    def temporarily_suppress_stderr():
1540
 
        null = os.open(os.path.devnull, os.O_RDWR)
1541
 
        stderrcopy = os.dup(sys.stderr.fileno())
1542
 
        os.dup2(null, sys.stderr.fileno())
1543
 
        os.close(null)
1544
 
        try:
1545
 
            yield
1546
 
        finally:
1547
 
            # restore stderr
1548
 
            os.dup2(stderrcopy, sys.stderr.fileno())
1549
 
            os.close(stderrcopy)
1550
 
 
1551
 
    def check_option_syntax(self, options):
1552
 
        check_option_syntax(self.parser, options)
1553
 
 
1554
 
    def test_actions_requires_client_or_all(self):
1555
 
        for action, value in self.actions.items():
1556
 
            options = self.parser.parse_args()
1557
 
            setattr(options, action, value)
1558
 
            with self.assertParseError():
1559
 
                self.check_option_syntax(options)
1560
 
 
1561
 
    def test_actions_conflicts_with_verbose(self):
1562
 
        for action, value in self.actions.items():
1563
 
            options = self.parser.parse_args()
1564
 
            setattr(options, action, value)
1565
 
            options.verbose = True
1566
 
            with self.assertParseError():
1567
 
                self.check_option_syntax(options)
1568
 
 
1569
 
    def test_dump_json_conflicts_with_verbose(self):
1570
 
        options = self.parser.parse_args()
1571
 
        options.dump_json = True
1572
 
        options.verbose = True
1573
 
        with self.assertParseError():
1574
 
            self.check_option_syntax(options)
1575
 
 
1576
 
    def test_dump_json_conflicts_with_action(self):
1577
 
        for action, value in self.actions.items():
1578
 
            options = self.parser.parse_args()
1579
 
            setattr(options, action, value)
1580
 
            options.dump_json = True
1581
 
            with self.assertParseError():
1582
 
                self.check_option_syntax(options)
1583
 
 
1584
 
    def test_all_can_not_be_alone(self):
1585
 
        options = self.parser.parse_args()
1586
 
        options.all = True
1587
 
        with self.assertParseError():
1588
 
            self.check_option_syntax(options)
1589
 
 
1590
 
    def test_all_is_ok_with_any_action(self):
1591
 
        for action, value in self.actions.items():
1592
 
            options = self.parser.parse_args()
1593
 
            setattr(options, action, value)
1594
 
            options.all = True
1595
 
            self.check_option_syntax(options)
1596
 
 
1597
 
    def test_is_enabled_fails_without_client(self):
1598
 
        options = self.parser.parse_args()
1599
 
        options.is_enabled = True
1600
 
        with self.assertParseError():
1601
 
            self.check_option_syntax(options)
1602
 
 
1603
 
    def test_is_enabled_works_with_one_client(self):
1604
 
        options = self.parser.parse_args()
1605
 
        options.is_enabled = True
1606
 
        options.client = ["foo"]
1607
 
        self.check_option_syntax(options)
1608
 
 
1609
 
    def test_is_enabled_fails_with_two_clients(self):
1610
 
        options = self.parser.parse_args()
1611
 
        options.is_enabled = True
1612
 
        options.client = ["foo", "barbar"]
1613
 
        with self.assertParseError():
1614
 
            self.check_option_syntax(options)
1615
 
 
1616
 
    def test_remove_can_only_be_combined_with_action_deny(self):
1617
 
        for action, value in self.actions.items():
1618
 
            if action in {"remove", "deny"}:
1619
 
                continue
1620
 
            options = self.parser.parse_args()
1621
 
            setattr(options, action, value)
1622
 
            options.all = True
1623
 
            options.remove = True
1624
 
            with self.assertParseError():
1625
 
                self.check_option_syntax(options)
1626
 
 
1627
993
 
1628
994
 
1629
995
def should_only_run_tests():