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