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
- browse files at revision 1016
- compare with another revision
- download diff
- download tarball
- view history from revision 1016
- Committer: Teddy Hogeborn
- Date: 2019-03-04 18:38:56 UTC
- Revision ID: teddy@recompile.se-20190304183856-vwfu3gje6wy6pnjn
mandos-ctl: Improve tests
* mandos-ctl (TestIsEnabledCmd.test_is_enabled_run_exits_successfully,
TestIsEnabledCmd.test_is_enabled_run_exits_with_failure): Call
run(), not run_on_one_client().
* mandos-ctl (TestIsEnabledCmd.test_is_enabled_run_exits_successfully,
TestIsEnabledCmd.test_is_enabled_run_exits_with_failure): Call
run(), not run_on_one_client().
- files modified:
- mandos-ctl
added
removed
mandos-ctl
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
281
278
commands which want to operate on all clients at the same time
282
279
can override this run() method instead."""
283
280
self.mandos = mandos
284
for client, properties in clients.items():
285
self.run_on_one_client(client, properties)
281
for client in clients:
282
self.run_on_one_client(client)
286
283
287
284
class PrintCmd(Command):
288
285
"""Abstract class for commands printing client details"""
298
295
299
296
class PropertyCmd(Command):
300
297
"""Abstract class for Actions for setting one client property"""
301
def run_on_one_client(self, client, properties):
298
def run_on_one_client(self, client):
302
299
"""Set the Client's D-Bus property"""
303
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", busname,
304
client.__dbus_object_path__,
305
dbus.PROPERTIES_IFACE, client_interface,
306
self.property, self.value_to_set
307
if not isinstance(self.value_to_set, dbus.Boolean)
308
else bool(self.value_to_set))
309
300
client.Set(client_interface, self.property, self.value_to_set,
310
301
dbus_interface=dbus.PROPERTIES_IFACE)
311
302
323
314
@value_to_set.setter
324
315
def value_to_set(self, value):
325
316
"""When setting, convert value to a datetime.timedelta"""
326
self._vts = int(round(value.total_seconds() * 1000))
317
self._vts = string_to_delta(value).total_seconds() * 1000
327
318
328
319
# Actual (non-abstract) command classes
329
320
332
323
self.verbose = verbose
333
324
334
325
def output(self, clients):
335
default_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
336
keywords = default_keywords
337
326
if self.verbose:
338
327
keywords = self.all_keywords
328
else:
329
keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
339
330
return str(self.TableOfClients(clients.values(), keywords))
340
331
341
332
class TableOfClients(object):
428
419
return value
429
420
430
421
class IsEnabledCmd(Command):
431
def run_on_one_client(self, client, properties):
432
if self.is_enabled(client, properties):
422
def run_on_one_client(self, client):
423
if self.is_enabled(client):
433
424
sys.exit(0)
434
425
sys.exit(1)
435
def is_enabled(self, client, properties):
436
return bool(properties["Enabled"])
426
def is_enabled(self, client):
427
return client.Get(client_interface, "Enabled",
428
dbus_interface=dbus.PROPERTIES_IFACE)
437
429
438
430
class RemoveCmd(Command):
439
def run_on_one_client(self, client, properties):
440
log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)", busname,
441
server_path, server_interface,
442
str(client.__dbus_object_path__))
431
def run_on_one_client(self, client):
443
432
self.mandos.RemoveClient(client.__dbus_object_path__)
444
433
445
434
class ApproveCmd(Command):
446
def run_on_one_client(self, client, properties):
447
log.debug("D-Bus: %s:%s.Approve(True)",
448
client.__dbus_object_path__, client_interface)
435
def run_on_one_client(self, client):
449
436
client.Approve(dbus.Boolean(True),
450
437
dbus_interface=client_interface)
451
438
452
439
class DenyCmd(Command):
453
def run_on_one_client(self, client, properties):
454
log.debug("D-Bus: %s:%s.Approve(False)",
455
client.__dbus_object_path__, client_interface)
440
def run_on_one_client(self, client):
456
441
client.Approve(dbus.Boolean(False),
457
442
dbus_interface=client_interface)
458
443
491
476
property = "Host"
492
477
493
478
class SetSecretCmd(PropertyCmd, ValueArgumentMixIn):
494
@property
495
def value_to_set(self):
496
return self._vts
497
@value_to_set.setter
498
def value_to_set(self, value):
499
"""When setting, read data from supplied file object"""
500
self._vts = value.read()
501
value.close()
502
479
property = "Secret"
503
480
504
481
class SetTimeoutCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
519
496
MillisecondsValueArgumentMixIn):
520
497
property = "ApprovalDuration"
521
498
499
def has_actions(options):
500
return any((options.enable,
501
options.disable,
502
options.bump_timeout,
503
options.start_checker,
504
options.stop_checker,
505
options.is_enabled,
506
options.remove,
507
options.checker is not None,
508
options.timeout is not None,
509
options.extended_timeout is not None,
510
options.interval is not None,
511
options.approved_by_default is not None,
512
options.approval_delay is not None,
513
options.approval_duration is not None,
514
options.host is not None,
515
options.secret is not None,
516
options.approve,
517
options.deny))
518
522
519
def add_command_line_options(parser):
523
520
parser.add_argument("--version", action="version",
524
521
version="%(prog)s {}".format(version),
550
547
help="Remove client")
551
548
parser.add_argument("-c", "--checker",
552
549
help="Set checker command for client")
553
parser.add_argument("-t", "--timeout", type=string_to_delta,
550
parser.add_argument("-t", "--timeout",
554
551
help="Set timeout for client")
555
parser.add_argument("--extended-timeout", type=string_to_delta,
552
parser.add_argument("--extended-timeout",
556
553
help="Set extended timeout for client")
557
parser.add_argument("-i", "--interval", type=string_to_delta,
554
parser.add_argument("-i", "--interval",
558
555
help="Set checker interval for client")
559
556
approve_deny_default = parser.add_mutually_exclusive_group()
560
557
approve_deny_default.add_argument(
565
562
"--deny-by-default", action="store_false",
566
563
dest="approved_by_default",
567
564
help="Set client to be denied by default")
568
parser.add_argument("--approval-delay", type=string_to_delta,
565
parser.add_argument("--approval-delay",
569
566
help="Set delay before client approve/deny")
570
parser.add_argument("--approval-duration", type=string_to_delta,
567
parser.add_argument("--approval-duration",
571
568
help="Set duration of one client approval")
572
569
parser.add_argument("-H", "--host", help="Set host for client")
573
570
parser.add_argument("-s", "--secret",
579
576
help="Approve any current client request")
580
577
approve_deny.add_argument("-D", "--deny", action="store_true",
581
578
help="Deny any current client request")
582
parser.add_argument("--debug", action="store_true",
583
help="Debug mode (show D-Bus commands)")
584
579
parser.add_argument("--check", action="store_true",
585
580
help="Run self-test")
586
581
parser.add_argument("client", nargs="*", help="Client name")
587
582
588
583
589
def commands_from_options(options):
584
def commands_and_clients_from_options(options):
590
585
591
586
commands = []
592
587
600
595
commands.append(DisableCmd())
601
596
602
597
if options.bump_timeout:
603
commands.append(BumpTimeoutCmd())
598
commands.append(BumpTimeoutCmd(options.bump_timeout))
604
599
605
600
if options.start_checker:
606
601
commands.append(StartCheckerCmd())
611
606
if options.is_enabled:
612
607
commands.append(IsEnabledCmd())
613
608
609
if options.remove:
610
commands.append(RemoveCmd())
611
614
612
if options.checker is not None:
615
commands.append(SetCheckerCmd(options.checker))
613
commands.append(SetCheckerCmd())
616
614
617
615
if options.timeout is not None:
618
616
commands.append(SetTimeoutCmd(options.timeout))
622
620
SetExtendedTimeoutCmd(options.extended_timeout))
623
621
624
622
if options.interval is not None:
625
commands.append(SetIntervalCmd(options.interval))
623
command.append(SetIntervalCmd(options.interval))
626
624
627
625
if options.approved_by_default is not None:
628
626
if options.approved_by_default:
629
commands.append(ApproveByDefaultCmd())
627
command.append(ApproveByDefaultCmd())
630
628
else:
631
commands.append(DenyByDefaultCmd())
629
command.append(DenyByDefaultCmd())
632
630
633
631
if options.approval_delay is not None:
634
commands.append(SetApprovalDelayCmd(options.approval_delay))
632
command.append(SetApprovalDelayCmd(options.approval_delay))
635
633
636
634
if options.approval_duration is not None:
637
commands.append(
635
command.append(
638
636
SetApprovalDurationCmd(options.approval_duration))
639
637
640
638
if options.host is not None:
641
commands.append(SetHostCmd(options.host))
639
command.append(SetHostCmd(options.host))
642
640
643
641
if options.secret is not None:
644
commands.append(SetSecretCmd(options.secret))
642
command.append(SetSecretCmd(options.secret))
645
643
646
644
if options.approve:
647
645
commands.append(ApproveCmd())
649
647
if options.deny:
650
648
commands.append(DenyCmd())
651
649
652
if options.remove:
653
commands.append(RemoveCmd())
654
655
650
# If no command option has been given, show table of clients,
656
651
# optionally verbosely
657
652
if not commands:
658
653
commands.append(PrintTableCmd(verbose=options.verbose))
659
654
660
return commands
661
662
663
def check_option_syntax(parser, options):
664
"""Apply additional restrictions on options, not expressible in
665
argparse"""
666
667
def has_actions(options):
668
return any((options.enable,
669
options.disable,
670
options.bump_timeout,
671
options.start_checker,
672
options.stop_checker,
673
options.is_enabled,
674
options.remove,
675
options.checker is not None,
676
options.timeout is not None,
677
options.extended_timeout is not None,
678
options.interval is not None,
679
options.approved_by_default is not None,
680
options.approval_delay is not None,
681
options.approval_duration is not None,
682
options.host is not None,
683
options.secret is not None,
684
options.approve,
685
options.deny))
655
return commands, options.client
656
657
658
def main():
659
parser = argparse.ArgumentParser()
660
661
add_command_line_options(parser)
662
663
options = parser.parse_args()
686
664
687
665
if has_actions(options) and not (options.client or options.all):
688
666
parser.error("Options require clients names or --all.")
695
673
parser.error("--all requires an action.")
696
674
if options.is_enabled and len(options.client) > 1:
697
675
parser.error("--is-enabled requires exactly one client")
698
if options.remove:
699
options.remove = False
700
if has_actions(options) and not options.deny:
701
parser.error("--remove can only be combined with --deny")
702
options.remove = True
703
704
705
def main():
706
parser = argparse.ArgumentParser()
707
708
add_command_line_options(parser)
709
710
options = parser.parse_args()
711
712
check_option_syntax(parser, options)
713
714
clientnames = options.client
715
716
if options.debug:
717
log.setLevel(logging.DEBUG)
676
677
commands, clientnames = commands_and_clients_from_options(options)
718
678
719
679
try:
720
680
bus = dbus.SystemBus()
721
log.debug("D-Bus: Connect to: (name=%r, path=%r)", busname,
722
server_path)
723
681
mandos_dbus_objc = bus.get_object(busname, server_path)
724
682
except dbus.exceptions.DBusException:
725
683
log.critical("Could not connect to Mandos server")
738
696
dbus_filter = NullFilter()
739
697
try:
740
698
dbus_logger.addFilter(dbus_filter)
741
log.debug("D-Bus: %s:%s:%s.GetManagedObjects()", busname,
742
server_path, dbus.OBJECT_MANAGER_IFACE)
743
699
mandos_clients = {path: ifs_and_props[client_interface]
744
700
for path, ifs_and_props in
745
701
mandos_serv_object_manager
771
727
sys.exit(1)
772
728
773
729
# Run all commands on clients
774
commands = commands_from_options(options)
775
730
for command in commands:
776
731
command.run(mandos_serv, clients)
777
732
791
746
792
747
class Test_string_to_delta(unittest.TestCase):
793
748
def test_handles_basic_rfc3339(self):
794
self.assertEqual(string_to_delta("PT0S"),
795
datetime.timedelta())
796
self.assertEqual(string_to_delta("P0D"),
797
datetime.timedelta())
798
self.assertEqual(string_to_delta("PT1S"),
799
datetime.timedelta(0, 1))
800
749
self.assertEqual(string_to_delta("PT2H"),
801
750
datetime.timedelta(0, 7200))
802
751
def test_falls_back_to_pre_1_6_1_with_warning(self):
837
786
testcase.assertEqual(dbus_interface,
838
787
dbus.PROPERTIES_IFACE)
839
788
self.attributes[property] = value
789
self.calls.append(("Set", (interface, property, value,
790
dbus_interface)))
840
791
def Get(self, interface, property, dbus_interface):
841
792
testcase.assertEqual(interface, client_interface)
842
793
testcase.assertEqual(dbus_interface,
843
794
dbus.PROPERTIES_IFACE)
795
self.calls.append(("Get", (interface, property,
796
dbus_interface)))
844
797
return self.attributes[property]
845
def Approve(self, approve, dbus_interface):
846
testcase.assertEqual(dbus_interface, client_interface)
847
self.calls.append(("Approve", (approve,
848
dbus_interface)))
849
self.client = MockClient(
850
"foo",
851
KeyID=("92ed150794387c03ce684574b1139a65"
852
"94a34f895daaaf09fd8ea90a27cddb12"),
853
Secret=b"secret",
854
Host="foo.example.org",
855
Enabled=dbus.Boolean(True),
856
Timeout=300000,
857
LastCheckedOK="2019-02-03T00:00:00",
858
Created="2019-01-02T00:00:00",
859
Interval=120000,
860
Fingerprint=("778827225BA7DE539C5A"
861
"7CFA59CFF7CDBD9A5920"),
862
CheckerRunning=dbus.Boolean(False),
863
LastEnabled="2019-01-03T00:00:00",
864
ApprovalPending=dbus.Boolean(False),
865
ApprovedByDefault=dbus.Boolean(True),
866
LastApprovalRequest="",
867
ApprovalDelay=0,
868
ApprovalDuration=1000,
869
Checker="fping -q -- %(host)s",
870
ExtendedTimeout=900000,
871
Expires="2019-02-04T00:00:00",
872
LastCheckerStatus=0)
873
self.other_client = MockClient(
874
"barbar",
875
KeyID=("0558568eedd67d622f5c83b35a115f79"
876
"6ab612cff5ad227247e46c2b020f441c"),
877
Secret=b"secretbar",
878
Host="192.0.2.3",
879
Enabled=dbus.Boolean(True),
880
Timeout=300000,
881
LastCheckedOK="2019-02-04T00:00:00",
882
Created="2019-01-03T00:00:00",
883
Interval=120000,
884
Fingerprint=("3E393AEAEFB84C7E89E2"
885
"F547B3A107558FCA3A27"),
886
CheckerRunning=dbus.Boolean(True),
887
LastEnabled="2019-01-04T00:00:00",
888
ApprovalPending=dbus.Boolean(False),
889
ApprovedByDefault=dbus.Boolean(False),
890
LastApprovalRequest="2019-01-03T00:00:00",
891
ApprovalDelay=30000,
892
ApprovalDuration=1000,
893
Checker=":",
894
ExtendedTimeout=900000,
895
Expires="2019-02-05T00:00:00",
896
LastCheckerStatus=-2)
897
self.clients = collections.OrderedDict(
898
[
899
(self.client, self.client.attributes),
900
(self.other_client, self.other_client.attributes),
798
def __getitem__(self, key):
799
return self.attributes[key]
800
def __setitem__(self, key, value):
801
self.attributes[key] = value
802
self.clients = collections.OrderedDict([
803
("foo",
804
MockClient(
805
"foo",
806
KeyID=("92ed150794387c03ce684574b1139a65"
807
"94a34f895daaaf09fd8ea90a27cddb12"),
808
Secret=b"secret",
809
Host="foo.example.org",
810
Enabled=dbus.Boolean(True),
811
Timeout=300000,
812
LastCheckedOK="2019-02-03T00:00:00",
813
Created="2019-01-02T00:00:00",
814
Interval=120000,
815
Fingerprint=("778827225BA7DE539C5A"
816
"7CFA59CFF7CDBD9A5920"),
817
CheckerRunning=dbus.Boolean(False),
818
LastEnabled="2019-01-03T00:00:00",
819
ApprovalPending=dbus.Boolean(False),
820
ApprovedByDefault=dbus.Boolean(True),
821
LastApprovalRequest="",
822
ApprovalDelay=0,
823
ApprovalDuration=1000,
824
Checker="fping -q -- %(host)s",
825
ExtendedTimeout=900000,
826
Expires="2019-02-04T00:00:00",
827
LastCheckerStatus=0)),
828
("barbar",
829
MockClient(
830
"barbar",
831
KeyID=("0558568eedd67d622f5c83b35a115f79"
832
"6ab612cff5ad227247e46c2b020f441c"),
833
Secret=b"secretbar",
834
Host="192.0.2.3",
835
Enabled=dbus.Boolean(True),
836
Timeout=300000,
837
LastCheckedOK="2019-02-04T00:00:00",
838
Created="2019-01-03T00:00:00",
839
Interval=120000,
840
Fingerprint=("3E393AEAEFB84C7E89E2"
841
"F547B3A107558FCA3A27"),
842
CheckerRunning=dbus.Boolean(True),
843
LastEnabled="2019-01-04T00:00:00",
844
ApprovalPending=dbus.Boolean(False),
845
ApprovedByDefault=dbus.Boolean(False),
846
LastApprovalRequest="2019-01-03T00:00:00",
847
ApprovalDelay=30000,
848
ApprovalDuration=1000,
849
Checker=":",
850
ExtendedTimeout=900000,
851
Expires="2019-02-05T00:00:00",
852
LastCheckerStatus=-2)),
901
853
])
902
self.one_client = {self.client: self.client.attributes}
903
854
904
855
class TestPrintTableCmd(TestCmd):
905
856
def test_normal(self):
919
870
"""[1:-1]
920
871
self.assertEqual(output, expected_output)
921
872
def test_one_client(self):
922
output = PrintTableCmd().output(self.one_client)
873
output = PrintTableCmd().output({"foo": self.clients["foo"]})
923
874
expected_output = """
924
875
Name Enabled Timeout Last Successful Check
925
876
foo Yes 00:05:00 2019-02-03T00:00:00
983
934
json_data = json.loads(DumpJSONCmd().output(self.clients))
984
935
self.assertDictEqual(json_data, self.expected_json)
985
936
def test_one_client(self):
986
clients = self.one_client
937
clients = {"foo": self.clients["foo"]}
987
938
json_data = json.loads(DumpJSONCmd().output(clients))
988
939
expected_json = {"foo": self.expected_json["foo"]}
989
940
self.assertDictEqual(json_data, expected_json)
990
941
991
942
class TestIsEnabledCmd(TestCmd):
992
943
def test_is_enabled(self):
993
self.assertTrue(all(IsEnabledCmd().is_enabled(client, properties)
994
for client, properties in self.clients.items()))
944
self.assertTrue(all(IsEnabledCmd().is_enabled(client)
945
for client in self.clients.values()))
946
def test_is_enabled_does_get_attribute(self):
947
client = self.clients["foo"]
948
self.assertTrue(IsEnabledCmd().is_enabled(client))
949
self.assertListEqual(client.calls,
950
[("Get",
951
("se.recompile.Mandos.Client",
952
"Enabled",
953
"org.freedesktop.DBus.Properties"))])
995
954
def test_is_enabled_run_exits_successfully(self):
955
client = self.clients["foo"]
996
956
with self.assertRaises(SystemExit) as e:
997
IsEnabledCmd().run(None, self.one_client)
957
IsEnabledCmd().run(None, [client])
998
958
if e.exception.code is not None:
999
959
self.assertEqual(e.exception.code, 0)
1000
960
else:
1001
961
self.assertIsNone(e.exception.code)
1002
962
def test_is_enabled_run_exits_with_failure(self):
1003
self.client.attributes["Enabled"] = dbus.Boolean(False)
963
client = self.clients["foo"]
964
client["Enabled"] = dbus.Boolean(False)
1004
965
with self.assertRaises(SystemExit) as e:
1005
IsEnabledCmd().run(None, self.one_client)
966
IsEnabledCmd().run(None, [client])
1006
967
if isinstance(e.exception.code, int):
1007
968
self.assertNotEqual(e.exception.code, 0)
1008
969
else:
1009
970
self.assertIsNotNone(e.exception.code)
1010
971
1011
class TestRemoveCmd(TestCmd):
1012
def test_remove(self):
1013
class MockMandos(object):
1014
def __init__(self):
1015
self.calls = []
1016
def RemoveClient(self, dbus_path):
1017
self.calls.append(("RemoveClient", (dbus_path,)))
1018
mandos = MockMandos()
1019
super(TestRemoveCmd, self).setUp()
1020
RemoveCmd().run(mandos, self.clients)
1021
self.assertEqual(len(mandos.calls), 2)
1022
for client in self.clients:
1023
self.assertIn(("RemoveClient",
1024
(client.__dbus_object_path__,)),
1025
mandos.calls)
1026
1027
class TestApproveCmd(TestCmd):
1028
def test_approve(self):
1029
ApproveCmd().run(None, self.clients)
1030
for client in self.clients:
1031
self.assertIn(("Approve", (True, client_interface)),
1032
client.calls)
1033
1034
class TestDenyCmd(TestCmd):
1035
def test_deny(self):
1036
DenyCmd().run(None, self.clients)
1037
for client in self.clients:
1038
self.assertIn(("Approve", (False, client_interface)),
1039
client.calls)
1040
1041
class TestEnableCmd(TestCmd):
1042
def test_enable(self):
1043
for client in self.clients:
1044
client.attributes["Enabled"] = False
1045
1046
EnableCmd().run(None, self.clients)
1047
1048
for client in self.clients:
1049
self.assertTrue(client.attributes["Enabled"])
1050
1051
class TestDisableCmd(TestCmd):
1052
def test_disable(self):
1053
DisableCmd().run(None, self.clients)
1054
1055
for client in self.clients:
1056
self.assertFalse(client.attributes["Enabled"])
1057
1058
class Unique(object):
1059
"""Class for objects which exist only to be unique objects, since
1060
unittest.mock.sentinel only exists in Python 3.3"""
1061
1062
class TestPropertyCmd(TestCmd):
1063
"""Abstract class for tests of PropertyCmd classes"""
1064
def runTest(self):
1065
if not hasattr(self, "command"):
1066
return
1067
values_to_get = getattr(self, "values_to_get",
1068
self.values_to_set)
1069
for value_to_set, value_to_get in zip(self.values_to_set,
1070
values_to_get):
1071
for client in self.clients:
1072
old_value = client.attributes[self.property]
1073
self.assertNotIsInstance(old_value, Unique)
1074
client.attributes[self.property] = Unique()
1075
self.run_command(value_to_set, self.clients)
1076
for client in self.clients:
1077
value = client.attributes[self.property]
1078
self.assertNotIsInstance(value, Unique)
1079
self.assertEqual(value, value_to_get)
1080
def run_command(self, value, clients):
1081
self.command().run(None, clients)
1082
1083
class TestBumpTimeoutCmd(TestPropertyCmd):
1084
command = BumpTimeoutCmd
1085
property = "LastCheckedOK"
1086
values_to_set = [""]
1087
1088
class TestStartCheckerCmd(TestPropertyCmd):
1089
command = StartCheckerCmd
1090
property = "CheckerRunning"
1091
values_to_set = [dbus.Boolean(True)]
1092
1093
class TestStopCheckerCmd(TestPropertyCmd):
1094
command = StopCheckerCmd
1095
property = "CheckerRunning"
1096
values_to_set = [dbus.Boolean(False)]
1097
1098
class TestApproveByDefaultCmd(TestPropertyCmd):
1099
command = ApproveByDefaultCmd
1100
property = "ApprovedByDefault"
1101
values_to_set = [dbus.Boolean(True)]
1102
1103
class TestDenyByDefaultCmd(TestPropertyCmd):
1104
command = DenyByDefaultCmd
1105
property = "ApprovedByDefault"
1106
values_to_set = [dbus.Boolean(False)]
1107
1108
class TestValueArgumentPropertyCmd(TestPropertyCmd):
1109
"""Abstract class for tests of PropertyCmd classes using the
1110
ValueArgumentMixIn"""
1111
def runTest(self):
1112
if type(self) is TestValueArgumentPropertyCmd:
1113
return
1114
return super(TestValueArgumentPropertyCmd, self).runTest()
1115
def run_command(self, value, clients):
1116
self.command(value).run(None, clients)
1117
1118
class TestSetCheckerCmd(TestValueArgumentPropertyCmd):
1119
command = SetCheckerCmd
1120
property = "Checker"
1121
values_to_set = ["", ":", "fping -q -- %s"]
1122
1123
class TestSetHostCmd(TestValueArgumentPropertyCmd):
1124
command = SetHostCmd
1125
property = "Host"
1126
values_to_set = ["192.0.2.3", "foo.example.org"]
1127
1128
class TestSetSecretCmd(TestValueArgumentPropertyCmd):
1129
command = SetSecretCmd
1130
property = "Secret"
1131
values_to_set = [io.BytesIO(b""),
1132
io.BytesIO(b"secret\0xyzzy\nbar")]
1133
values_to_get = [b"", b"secret\0xyzzy\nbar"]
1134
1135
class TestSetTimeoutCmd(TestValueArgumentPropertyCmd):
1136
command = SetTimeoutCmd
1137
property = "Timeout"
1138
values_to_set = [datetime.timedelta(),
1139
datetime.timedelta(minutes=5),
1140
datetime.timedelta(seconds=1),
1141
datetime.timedelta(weeks=1),
1142
datetime.timedelta(weeks=52)]
1143
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1144
1145
class TestSetExtendedTimeoutCmd(TestValueArgumentPropertyCmd):
1146
command = SetExtendedTimeoutCmd
1147
property = "ExtendedTimeout"
1148
values_to_set = [datetime.timedelta(),
1149
datetime.timedelta(minutes=5),
1150
datetime.timedelta(seconds=1),
1151
datetime.timedelta(weeks=1),
1152
datetime.timedelta(weeks=52)]
1153
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1154
1155
class TestSetIntervalCmd(TestValueArgumentPropertyCmd):
1156
command = SetIntervalCmd
1157
property = "Interval"
1158
values_to_set = [datetime.timedelta(),
1159
datetime.timedelta(minutes=5),
1160
datetime.timedelta(seconds=1),
1161
datetime.timedelta(weeks=1),
1162
datetime.timedelta(weeks=52)]
1163
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1164
1165
class TestSetApprovalDelayCmd(TestValueArgumentPropertyCmd):
1166
command = SetApprovalDelayCmd
1167
property = "ApprovalDelay"
1168
values_to_set = [datetime.timedelta(),
1169
datetime.timedelta(minutes=5),
1170
datetime.timedelta(seconds=1),
1171
datetime.timedelta(weeks=1),
1172
datetime.timedelta(weeks=52)]
1173
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1174
1175
class TestSetApprovalDurationCmd(TestValueArgumentPropertyCmd):
1176
command = SetApprovalDurationCmd
1177
property = "ApprovalDuration"
1178
values_to_set = [datetime.timedelta(),
1179
datetime.timedelta(minutes=5),
1180
datetime.timedelta(seconds=1),
1181
datetime.timedelta(weeks=1),
1182
datetime.timedelta(weeks=52)]
1183
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1184
1185
class Test_command_from_options(unittest.TestCase):
1186
def setUp(self):
1187
self.parser = argparse.ArgumentParser()
1188
add_command_line_options(self.parser)
1189
def assert_command_from_args(self, args, command_cls, **cmd_attrs):
1190
"""Assert that parsing ARGS should result in an instance of
1191
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
1192
options = self.parser.parse_args(args)
1193
check_option_syntax(self.parser, options)
1194
commands = commands_from_options(options)
1195
self.assertEqual(len(commands), 1)
1196
command = commands[0]
1197
self.assertIsInstance(command, command_cls)
1198
for key, value in cmd_attrs.items():
1199
self.assertEqual(getattr(command, key), value)
1200
def test_print_table(self):
1201
self.assert_command_from_args([], PrintTableCmd,
1202
verbose=False)
1203
1204
def test_print_table_verbose(self):
1205
self.assert_command_from_args(["--verbose"], PrintTableCmd,
1206
verbose=True)
1207
1208
def test_print_table_verbose_short(self):
1209
self.assert_command_from_args(["-v"], PrintTableCmd,
1210
verbose=True)
1211
1212
def test_enable(self):
1213
self.assert_command_from_args(["--enable", "foo"], EnableCmd)
1214
1215
def test_enable_short(self):
1216
self.assert_command_from_args(["-e", "foo"], EnableCmd)
1217
1218
def test_disable(self):
1219
self.assert_command_from_args(["--disable", "foo"],
1220
DisableCmd)
1221
1222
def test_disable_short(self):
1223
self.assert_command_from_args(["-d", "foo"], DisableCmd)
1224
1225
def test_bump_timeout(self):
1226
self.assert_command_from_args(["--bump-timeout", "foo"],
1227
BumpTimeoutCmd)
1228
1229
def test_bump_timeout_short(self):
1230
self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
1231
1232
def test_start_checker(self):
1233
self.assert_command_from_args(["--start-checker", "foo"],
1234
StartCheckerCmd)
1235
1236
def test_stop_checker(self):
1237
self.assert_command_from_args(["--stop-checker", "foo"],
1238
StopCheckerCmd)
1239
1240
def test_remove(self):
1241
self.assert_command_from_args(["--remove", "foo"],
1242
RemoveCmd)
1243
1244
def test_remove_short(self):
1245
self.assert_command_from_args(["-r", "foo"], RemoveCmd)
1246
1247
def test_checker(self):
1248
self.assert_command_from_args(["--checker", ":", "foo"],
1249
SetCheckerCmd, value_to_set=":")
1250
1251
def test_checker_empty(self):
1252
self.assert_command_from_args(["--checker", "", "foo"],
1253
SetCheckerCmd, value_to_set="")
1254
1255
def test_checker_short(self):
1256
self.assert_command_from_args(["-c", ":", "foo"],
1257
SetCheckerCmd, value_to_set=":")
1258
1259
def test_timeout(self):
1260
self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1261
SetTimeoutCmd,
1262
value_to_set=300000)
1263
1264
def test_timeout_short(self):
1265
self.assert_command_from_args(["-t", "PT5M", "foo"],
1266
SetTimeoutCmd,
1267
value_to_set=300000)
1268
1269
def test_extended_timeout(self):
1270
self.assert_command_from_args(["--extended-timeout", "PT15M",
1271
"foo"],
1272
SetExtendedTimeoutCmd,
1273
value_to_set=900000)
1274
1275
def test_interval(self):
1276
self.assert_command_from_args(["--interval", "PT2M", "foo"],
1277
SetIntervalCmd,
1278
value_to_set=120000)
1279
1280
def test_interval_short(self):
1281
self.assert_command_from_args(["-i", "PT2M", "foo"],
1282
SetIntervalCmd,
1283
value_to_set=120000)
1284
1285
def test_approve_by_default(self):
1286
self.assert_command_from_args(["--approve-by-default", "foo"],
1287
ApproveByDefaultCmd)
1288
1289
def test_deny_by_default(self):
1290
self.assert_command_from_args(["--deny-by-default", "foo"],
1291
DenyByDefaultCmd)
1292
1293
def test_approval_delay(self):
1294
self.assert_command_from_args(["--approval-delay", "PT30S",
1295
"foo"], SetApprovalDelayCmd,
1296
value_to_set=30000)
1297
1298
def test_approval_duration(self):
1299
self.assert_command_from_args(["--approval-duration", "PT1S",
1300
"foo"], SetApprovalDurationCmd,
1301
value_to_set=1000)
1302
1303
def test_host(self):
1304
self.assert_command_from_args(["--host", "foo.example.org",
1305
"foo"], SetHostCmd,
1306
value_to_set="foo.example.org")
1307
1308
def test_host_short(self):
1309
self.assert_command_from_args(["-H", "foo.example.org",
1310
"foo"], SetHostCmd,
1311
value_to_set="foo.example.org")
1312
1313
def test_secret_devnull(self):
1314
self.assert_command_from_args(["--secret", os.path.devnull,
1315
"foo"], SetSecretCmd,
1316
value_to_set=b"")
1317
1318
def test_secret_tempfile(self):
1319
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1320
value = b"secret\0xyzzy\nbar"
1321
f.write(value)
1322
f.seek(0)
1323
self.assert_command_from_args(["--secret", f.name,
1324
"foo"], SetSecretCmd,
1325
value_to_set=value)
1326
1327
def test_secret_devnull_short(self):
1328
self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1329
SetSecretCmd, value_to_set=b"")
1330
1331
def test_secret_tempfile_short(self):
1332
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1333
value = b"secret\0xyzzy\nbar"
1334
f.write(value)
1335
f.seek(0)
1336
self.assert_command_from_args(["-s", f.name, "foo"],
1337
SetSecretCmd,
1338
value_to_set=value)
1339
1340
def test_approve(self):
1341
self.assert_command_from_args(["--approve", "foo"],
1342
ApproveCmd)
1343
1344
def test_approve_short(self):
1345
self.assert_command_from_args(["-A", "foo"], ApproveCmd)
1346
1347
def test_deny(self):
1348
self.assert_command_from_args(["--deny", "foo"], DenyCmd)
1349
1350
def test_deny_short(self):
1351
self.assert_command_from_args(["-D", "foo"], DenyCmd)
1352
1353
def test_dump_json(self):
1354
self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
1355
1356
def test_is_enabled(self):
1357
self.assert_command_from_args(["--is-enabled", "foo"],
1358
IsEnabledCmd)
1359
1360
def test_is_enabled_short(self):
1361
self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
1362
1363
def test_deny_before_remove(self):
1364
options = self.parser.parse_args(["--deny", "--remove", "foo"])
1365
check_option_syntax(self.parser, options)
1366
commands = commands_from_options(options)
1367
self.assertEqual(len(commands), 2)
1368
self.assertIsInstance(commands[0], DenyCmd)
1369
self.assertIsInstance(commands[1], RemoveCmd)
1370
1371
def test_deny_before_remove_reversed(self):
1372
options = self.parser.parse_args(["--remove", "--deny", "--all"])
1373
check_option_syntax(self.parser, options)
1374
commands = commands_from_options(options)
1375
self.assertEqual(len(commands), 2)
1376
self.assertIsInstance(commands[0], DenyCmd)
1377
self.assertIsInstance(commands[1], RemoveCmd)
1378
1379
1380
class Test_check_option_syntax(unittest.TestCase):
1381
# This mostly corresponds to the definition from has_actions() in
1382
# check_option_syntax()
1383
actions = {
1384
# The actual values set here are not that important, but we do
1385
# at least stick to the correct types, even though they are
1386
# never used
1387
"enable": True,
1388
"disable": True,
1389
"bump_timeout": True,
1390
"start_checker": True,
1391
"stop_checker": True,
1392
"is_enabled": True,
1393
"remove": True,
1394
"checker": "x",
1395
"timeout": datetime.timedelta(),
1396
"extended_timeout": datetime.timedelta(),
1397
"interval": datetime.timedelta(),
1398
"approved_by_default": True,
1399
"approval_delay": datetime.timedelta(),
1400
"approval_duration": datetime.timedelta(),
1401
"host": "x",
1402
"secret": io.BytesIO(b"x"),
1403
"approve": True,
1404
"deny": True,
1405
}
1406
1407
def setUp(self):
1408
self.parser = argparse.ArgumentParser()
1409
add_command_line_options(self.parser)
1410
1411
@contextlib.contextmanager
1412
def assertParseError(self):
1413
with self.assertRaises(SystemExit) as e:
1414
with self.temporarily_suppress_stderr():
1415
yield
1416
# Exit code from argparse is guaranteed to be "2". Reference:
1417
# https://docs.python.org/3/library/argparse.html#exiting-methods
1418
self.assertEqual(e.exception.code, 2)
1419
1420
@staticmethod
1421
@contextlib.contextmanager
1422
def temporarily_suppress_stderr():
1423
null = os.open(os.path.devnull, os.O_RDWR)
1424
stderrcopy = os.dup(sys.stderr.fileno())
1425
os.dup2(null, sys.stderr.fileno())
1426
os.close(null)
1427
try:
1428
yield
1429
finally:
1430
# restore stderr
1431
os.dup2(stderrcopy, sys.stderr.fileno())
1432
os.close(stderrcopy)
1433
1434
def check_option_syntax(self, options):
1435
check_option_syntax(self.parser, options)
1436
1437
def test_actions_requires_client_or_all(self):
1438
for action, value in self.actions.items():
1439
options = self.parser.parse_args()
1440
setattr(options, action, value)
1441
with self.assertParseError():
1442
self.check_option_syntax(options)
1443
1444
def test_actions_conflicts_with_verbose(self):
1445
for action, value in self.actions.items():
1446
options = self.parser.parse_args()
1447
setattr(options, action, value)
1448
options.verbose = True
1449
with self.assertParseError():
1450
self.check_option_syntax(options)
1451
1452
def test_dump_json_conflicts_with_verbose(self):
1453
options = self.parser.parse_args()
1454
options.dump_json = True
1455
options.verbose = True
1456
with self.assertParseError():
1457
self.check_option_syntax(options)
1458
1459
def test_dump_json_conflicts_with_action(self):
1460
for action, value in self.actions.items():
1461
options = self.parser.parse_args()
1462
setattr(options, action, value)
1463
options.dump_json = True
1464
with self.assertParseError():
1465
self.check_option_syntax(options)
1466
1467
def test_all_can_not_be_alone(self):
1468
options = self.parser.parse_args()
1469
options.all = True
1470
with self.assertParseError():
1471
self.check_option_syntax(options)
1472
1473
def test_all_is_ok_with_any_action(self):
1474
for action, value in self.actions.items():
1475
options = self.parser.parse_args()
1476
setattr(options, action, value)
1477
options.all = True
1478
self.check_option_syntax(options)
1479
1480
def test_is_enabled_fails_without_client(self):
1481
options = self.parser.parse_args()
1482
options.is_enabled = True
1483
with self.assertParseError():
1484
self.check_option_syntax(options)
1485
1486
def test_is_enabled_works_with_one_client(self):
1487
options = self.parser.parse_args()
1488
options.is_enabled = True
1489
options.client = ["foo"]
1490
self.check_option_syntax(options)
1491
1492
def test_is_enabled_fails_with_two_clients(self):
1493
options = self.parser.parse_args()
1494
options.is_enabled = True
1495
options.client = ["foo", "barbar"]
1496
with self.assertParseError():
1497
self.check_option_syntax(options)
1498
1499
def test_remove_can_only_be_combined_with_action_deny(self):
1500
for action, value in self.actions.items():
1501
if action in {"remove", "deny"}:
1502
continue
1503
options = self.parser.parse_args()
1504
setattr(options, action, value)
1505
options.all = True
1506
options.remove = True
1507
with self.assertParseError():
1508
self.check_option_syntax(options)
1509
1510
972
1511
973
1512
974
def should_only_run_tests():
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0