/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
#!/usr/bin/python
# -*- mode: python; coding: utf-8; after-save-hook: (lambda () (let ((command (if (and (boundp 'tramp-file-name-structure) (string-match (car tramp-file-name-structure) (buffer-file-name))) (tramp-file-name-localname (tramp-dissect-file-name (buffer-file-name))) (buffer-file-name)))) (if (= (shell-command (format "%s --check" (shell-quote-argument command)) "*Test*") 0) (let ((w (get-buffer-window "*Test*"))) (if w (delete-window w)) (kill-buffer "*Test*")) (display-buffer "*Test*")))); -*-
#
# Mandos Monitor - Control and monitor the Mandos server
#
# Copyright © 2008-2019 Teddy Hogeborn
# Copyright © 2008-2019 Björn Påhlsson
#
# This file is part of Mandos.
#
# Mandos is free software: you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
#     Mandos is distributed in the hope that it will be useful, but
#     WITHOUT ANY WARRANTY; without even the implied warranty of
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#     GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
#
# Contact the authors at <mandos@recompile.se>.
#

from __future__ import (division, absolute_import, print_function,
                        unicode_literals)

try:
    from future_builtins import *
except ImportError:
    pass

import sys
import argparse
import locale
import datetime
import re
import os
import collections
import json
import unittest
import logging
import io
import tempfile
import contextlib

import dbus

# Show warnings by default
if not sys.warnoptions:
    import warnings
    warnings.simplefilter("default")

log = logging.getLogger(sys.argv[0])
logging.basicConfig(level="INFO", # Show info level messages
                    format="%(message)s") # Show basic log messages

logging.captureWarnings(True)   # Show warnings via the logging system

if sys.version_info.major == 2:
    str = unicode

locale.setlocale(locale.LC_ALL, "")

dbus_busname_domain = "se.recompile"
dbus_busname = dbus_busname_domain + ".Mandos"
server_dbus_path = "/"
server_dbus_interface = dbus_busname_domain + ".Mandos"
client_dbus_interface = dbus_busname_domain + ".Mandos.Client"
del dbus_busname_domain
version = "1.8.3"


try:
    dbus.OBJECT_MANAGER_IFACE
except AttributeError:
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"


def main():
    parser = argparse.ArgumentParser()

    add_command_line_options(parser)

    options = parser.parse_args()

    check_option_syntax(parser, options)

    clientnames = options.client

    if options.debug:
        log.setLevel(logging.DEBUG)

    try:
        bus = dbus.SystemBus()
        log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
                  dbus_busname, server_dbus_path)
        mandos_dbus_objc = bus.get_object(dbus_busname,
                                          server_dbus_path)
    except dbus.exceptions.DBusException:
        log.critical("Could not connect to Mandos server")
        sys.exit(1)

    mandos_serv = dbus.Interface(mandos_dbus_objc,
                                 dbus_interface=server_dbus_interface)
    mandos_serv_object_manager = dbus.Interface(
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)

    # Filter out log message from dbus module
    dbus_logger = logging.getLogger("dbus.proxies")
    class NullFilter(logging.Filter):
        def filter(self, record):
            return False
    dbus_filter = NullFilter()
    try:
        dbus_logger.addFilter(dbus_filter)
        log.debug("D-Bus: %s:%s:%s.GetManagedObjects()", dbus_busname,
                  server_dbus_path, dbus.OBJECT_MANAGER_IFACE)
        mandos_clients = {path: ifs_and_props[client_dbus_interface]
                          for path, ifs_and_props in
                          mandos_serv_object_manager
                          .GetManagedObjects().items()
                          if client_dbus_interface in ifs_and_props}
    except dbus.exceptions.DBusException as e:
        log.critical("Failed to access Mandos server through D-Bus:"
                     "\n%s", e)
        sys.exit(1)
    finally:
        # restore dbus logger
        dbus_logger.removeFilter(dbus_filter)

    # Compile dict of (clients: properties) to process
    clients = {}

    if not clientnames:
        clients = {objpath: properties
                   for objpath, properties in mandos_clients.items()}
    else:
        for name in clientnames:
            for objpath, properties in mandos_clients.items():
                if properties["Name"] == name:
                    clients[objpath] = properties
                    break
            else:
                log.critical("Client not found on server: %r", name)
                sys.exit(1)

    # Run all commands on clients
    commands = commands_from_options(options)
    for command in commands:
        command.run(clients, bus, mandos_serv)


def add_command_line_options(parser):
    parser.add_argument("--version", action="version",
                        version="%(prog)s {}".format(version),
                        help="show version number and exit")
    parser.add_argument("-a", "--all", action="store_true",
                        help="Select all clients")
    parser.add_argument("-v", "--verbose", action="store_true",
                        help="Print all fields")
    parser.add_argument("-j", "--dump-json", action="store_true",
                        help="Dump client data in JSON format")
    enable_disable = parser.add_mutually_exclusive_group()
    enable_disable.add_argument("-e", "--enable", action="store_true",
                                help="Enable client")
    enable_disable.add_argument("-d", "--disable",
                                action="store_true",
                                help="disable client")
    parser.add_argument("-b", "--bump-timeout", action="store_true",
                        help="Bump timeout for client")
    start_stop_checker = parser.add_mutually_exclusive_group()
    start_stop_checker.add_argument("--start-checker",
                                    action="store_true",
                                    help="Start checker for client")
    start_stop_checker.add_argument("--stop-checker",
                                    action="store_true",
                                    help="Stop checker for client")
    parser.add_argument("-V", "--is-enabled", action="store_true",
                        help="Check if client is enabled")
    parser.add_argument("-r", "--remove", action="store_true",
                        help="Remove client")
    parser.add_argument("-c", "--checker",
                        help="Set checker command for client")
    parser.add_argument("-t", "--timeout", type=string_to_delta,
                        help="Set timeout for client")
    parser.add_argument("--extended-timeout", type=string_to_delta,
                        help="Set extended timeout for client")
    parser.add_argument("-i", "--interval", type=string_to_delta,
                        help="Set checker interval for client")
    approve_deny_default = parser.add_mutually_exclusive_group()
    approve_deny_default.add_argument(
        "--approve-by-default", action="store_true",
        default=None, dest="approved_by_default",
        help="Set client to be approved by default")
    approve_deny_default.add_argument(
        "--deny-by-default", action="store_false",
        dest="approved_by_default",
        help="Set client to be denied by default")
    parser.add_argument("--approval-delay", type=string_to_delta,
                        help="Set delay before client approve/deny")
    parser.add_argument("--approval-duration", type=string_to_delta,
                        help="Set duration of one client approval")
    parser.add_argument("-H", "--host", help="Set host for client")
    parser.add_argument("-s", "--secret",
                        type=argparse.FileType(mode="rb"),
                        help="Set password blob (file) for client")
    approve_deny = parser.add_mutually_exclusive_group()
    approve_deny.add_argument(
        "-A", "--approve", action="store_true",
        help="Approve any current client request")
    approve_deny.add_argument("-D", "--deny", action="store_true",
                              help="Deny any current client request")
    parser.add_argument("--debug", action="store_true",
                        help="Debug mode (show D-Bus commands)")
    parser.add_argument("--check", action="store_true",
                        help="Run self-test")
    parser.add_argument("client", nargs="*", help="Client name")


def string_to_delta(interval):
    """Parse a string and return a datetime.timedelta"""

    try:
        return rfc3339_duration_to_delta(interval)
    except ValueError as e:
        log.warning("%s - Parsing as pre-1.6.1 interval instead",
                    ' '.join(e.args))
    return parse_pre_1_6_1_interval(interval)


def rfc3339_duration_to_delta(duration):
    """Parse an RFC 3339 "duration" and return a datetime.timedelta

    >>> rfc3339_duration_to_delta("P7D")
    datetime.timedelta(7)
    >>> rfc3339_duration_to_delta("PT60S")
    datetime.timedelta(0, 60)
    >>> rfc3339_duration_to_delta("PT60M")
    datetime.timedelta(0, 3600)
    >>> rfc3339_duration_to_delta("P60M")
    datetime.timedelta(1680)
    >>> rfc3339_duration_to_delta("PT24H")
    datetime.timedelta(1)
    >>> rfc3339_duration_to_delta("P1W")
    datetime.timedelta(7)
    >>> rfc3339_duration_to_delta("PT5M30S")
    datetime.timedelta(0, 330)
    >>> rfc3339_duration_to_delta("P1DT3M20S")
    datetime.timedelta(1, 200)
    >>> # Can not be empty:
    >>> rfc3339_duration_to_delta("")
    Traceback (most recent call last):
    ...
    ValueError: Invalid RFC 3339 duration: u''
    >>> # Must start with "P":
    >>> rfc3339_duration_to_delta("1D")
    Traceback (most recent call last):
    ...
    ValueError: Invalid RFC 3339 duration: u'1D'
    >>> # Must use correct order
    >>> rfc3339_duration_to_delta("PT1S2M")
    Traceback (most recent call last):
    ...
    ValueError: Invalid RFC 3339 duration: u'PT1S2M'
    >>> # Time needs time marker
    >>> rfc3339_duration_to_delta("P1H2S")
    Traceback (most recent call last):
    ...
    ValueError: Invalid RFC 3339 duration: u'P1H2S'
    >>> # Weeks can not be combined with anything else
    >>> rfc3339_duration_to_delta("P1D2W")
    Traceback (most recent call last):
    ...
    ValueError: Invalid RFC 3339 duration: u'P1D2W'
    >>> rfc3339_duration_to_delta("P2W2H")
    Traceback (most recent call last):
    ...
    ValueError: Invalid RFC 3339 duration: u'P2W2H'
    """

    # Parsing an RFC 3339 duration with regular expressions is not
    # possible - there would have to be multiple places for the same
    # values, like seconds.  The current code, while more esoteric, is
    # cleaner without depending on a parsing library.  If Python had a
    # built-in library for parsing we would use it, but we'd like to
    # avoid excessive use of external libraries.

    # New type for defining tokens, syntax, and semantics all-in-one
    Token = collections.namedtuple("Token", (
        "regexp",  # To match token; if "value" is not None, must have
                   # a "group" containing digits
        "value",   # datetime.timedelta or None
        "followers"))           # Tokens valid after this token
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
    # the "duration" ABNF definition in RFC 3339, Appendix A.
    token_end = Token(re.compile(r"$"), None, frozenset())
    token_second = Token(re.compile(r"(\d+)S"),
                         datetime.timedelta(seconds=1),
                         frozenset((token_end, )))
    token_minute = Token(re.compile(r"(\d+)M"),
                         datetime.timedelta(minutes=1),
                         frozenset((token_second, token_end)))
    token_hour = Token(re.compile(r"(\d+)H"),
                       datetime.timedelta(hours=1),
                       frozenset((token_minute, token_end)))
    token_time = Token(re.compile(r"T"),
                       None,
                       frozenset((token_hour, token_minute,
                                  token_second)))
    token_day = Token(re.compile(r"(\d+)D"),
                      datetime.timedelta(days=1),
                      frozenset((token_time, token_end)))
    token_month = Token(re.compile(r"(\d+)M"),
                        datetime.timedelta(weeks=4),
                        frozenset((token_day, token_end)))
    token_year = Token(re.compile(r"(\d+)Y"),
                       datetime.timedelta(weeks=52),
                       frozenset((token_month, token_end)))
    token_week = Token(re.compile(r"(\d+)W"),
                       datetime.timedelta(weeks=1),
                       frozenset((token_end, )))
    token_duration = Token(re.compile(r"P"), None,
                           frozenset((token_year, token_month,
                                      token_day, token_time,
                                      token_week)))
    # Define starting values:
    # Value so far
    value = datetime.timedelta()
    found_token = None
    # Following valid tokens
    followers = frozenset((token_duration, ))
    # String left to parse
    s = duration
    # Loop until end token is found
    while found_token is not token_end:
        # Search for any currently valid tokens
        for token in followers:
            match = token.regexp.match(s)
            if match is not None:
                # Token found
                if token.value is not None:
                    # Value found, parse digits
                    factor = int(match.group(1), 10)
                    # Add to value so far
                    value += factor * token.value
                # Strip token from string
                s = token.regexp.sub("", s, 1)
                # Go to found token
                found_token = token
                # Set valid next tokens
                followers = found_token.followers
                break
        else:
            # No currently valid tokens were found
            raise ValueError("Invalid RFC 3339 duration: {!r}"
                             .format(duration))
    # End token found
    return value


def parse_pre_1_6_1_interval(interval):
    """Parse an interval string as documented by Mandos before 1.6.1,
    and return a datetime.timedelta

    >>> parse_pre_1_6_1_interval('7d')
    datetime.timedelta(7)
    >>> parse_pre_1_6_1_interval('60s')
    datetime.timedelta(0, 60)
    >>> parse_pre_1_6_1_interval('60m')
    datetime.timedelta(0, 3600)
    >>> parse_pre_1_6_1_interval('24h')
    datetime.timedelta(1)
    >>> parse_pre_1_6_1_interval('1w')
    datetime.timedelta(7)
    >>> parse_pre_1_6_1_interval('5m 30s')
    datetime.timedelta(0, 330)
    >>> parse_pre_1_6_1_interval('')
    datetime.timedelta(0)
    >>> # Ignore unknown characters, allow any order and repetitions
    >>> parse_pre_1_6_1_interval('2dxy7zz11y3m5m')
    datetime.timedelta(2, 480, 18000)

    """

    value = datetime.timedelta(0)
    regexp = re.compile(r"(\d+)([dsmhw]?)")

    for num, suffix in regexp.findall(interval):
        if suffix == "d":
            value += datetime.timedelta(int(num))
        elif suffix == "s":
            value += datetime.timedelta(0, int(num))
        elif suffix == "m":
            value += datetime.timedelta(0, 0, 0, 0, int(num))
        elif suffix == "h":
            value += datetime.timedelta(0, 0, 0, 0, 0, int(num))
        elif suffix == "w":
            value += datetime.timedelta(0, 0, 0, 0, 0, 0, int(num))
        elif suffix == "":
            value += datetime.timedelta(0, 0, 0, int(num))
    return value


def check_option_syntax(parser, options):
    """Apply additional restrictions on options, not expressible in
argparse"""

    def has_actions(options):
        return any((options.enable,
                    options.disable,
                    options.bump_timeout,
                    options.start_checker,
                    options.stop_checker,
                    options.is_enabled,
                    options.remove,
                    options.checker is not None,
                    options.timeout is not None,
                    options.extended_timeout is not None,
                    options.interval is not None,
                    options.approved_by_default is not None,
                    options.approval_delay is not None,
                    options.approval_duration is not None,
                    options.host is not None,
                    options.secret is not None,
                    options.approve,
                    options.deny))

    if has_actions(options) and not (options.client or options.all):
        parser.error("Options require clients names or --all.")
    if options.verbose and has_actions(options):
        parser.error("--verbose can only be used alone.")
    if options.dump_json and (options.verbose
                              or has_actions(options)):
        parser.error("--dump-json can only be used alone.")
    if options.all and not has_actions(options):
        parser.error("--all requires an action.")
    if options.is_enabled and len(options.client) > 1:
        parser.error("--is-enabled requires exactly one client")
    if options.remove:
        options.remove = False
        if has_actions(options) and not options.deny:
            parser.error("--remove can only be combined with --deny")
        options.remove = True


def commands_from_options(options):

    commands = []

    if options.is_enabled:
        commands.append(IsEnabledCmd())

    if options.approve:
        commands.append(ApproveCmd())

    if options.deny:
        commands.append(DenyCmd())

    if options.remove:
        commands.append(RemoveCmd())

    if options.dump_json:
        commands.append(DumpJSONCmd())

    if options.enable:
        commands.append(EnableCmd())

    if options.disable:
        commands.append(DisableCmd())

    if options.bump_timeout:
        commands.append(BumpTimeoutCmd())

    if options.start_checker:
        commands.append(StartCheckerCmd())

    if options.stop_checker:
        commands.append(StopCheckerCmd())

    if options.approved_by_default is not None:
        if options.approved_by_default:
            commands.append(ApproveByDefaultCmd())
        else:
            commands.append(DenyByDefaultCmd())

    if options.checker is not None:
        commands.append(SetCheckerCmd(options.checker))

    if options.host is not None:
        commands.append(SetHostCmd(options.host))

    if options.secret is not None:
        commands.append(SetSecretCmd(options.secret))

    if options.timeout is not None:
        commands.append(SetTimeoutCmd(options.timeout))

    if options.extended_timeout:
        commands.append(
            SetExtendedTimeoutCmd(options.extended_timeout))

    if options.interval is not None:
        commands.append(SetIntervalCmd(options.interval))

    if options.approval_delay is not None:
        commands.append(SetApprovalDelayCmd(options.approval_delay))

    if options.approval_duration is not None:
        commands.append(
            SetApprovalDurationCmd(options.approval_duration))

    # If no command option has been given, show table of clients,
    # optionally verbosely
    if not commands:
        commands.append(PrintTableCmd(verbose=options.verbose))

    return commands


class Command(object):
    """Abstract class for commands"""
    def run(self, clients, bus=None, mandos=None):
        """Normal commands should implement run_on_one_client(), but
        commands which want to operate on all clients at the same time
        can override this run() method instead."""
        self.mandos = mandos
        for clientpath, properties in clients.items():
            log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
                      dbus_busname, str(clientpath))
            client = bus.get_object(dbus_busname, clientpath)
            self.run_on_one_client(client, properties)


class IsEnabledCmd(Command):
    def run(self, clients, bus=None, mandos=None):
        client, properties = next(iter(clients.items()))
        if self.is_enabled(client, properties):
            sys.exit(0)
        sys.exit(1)
    def is_enabled(self, client, properties):
        return properties["Enabled"]


class ApproveCmd(Command):
    def run_on_one_client(self, client, properties):
        log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
                  client.__dbus_object_path__, client_dbus_interface)
        client.Approve(dbus.Boolean(True),
                       dbus_interface=client_dbus_interface)


class DenyCmd(Command):
    def run_on_one_client(self, client, properties):
        log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
                  client.__dbus_object_path__, client_dbus_interface)
        client.Approve(dbus.Boolean(False),
                       dbus_interface=client_dbus_interface)


class RemoveCmd(Command):
    def run_on_one_client(self, client, properties):
        log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)", dbus_busname,
                  server_dbus_path, server_dbus_interface,
                  str(client.__dbus_object_path__))
        self.mandos.RemoveClient(client.__dbus_object_path__)


class OutputCmd(Command):
    """Abstract class for commands outputting client details"""
    all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
                    "Created", "Interval", "Host", "KeyID",
                    "Fingerprint", "CheckerRunning", "LastEnabled",
                    "ApprovalPending", "ApprovedByDefault",
                    "LastApprovalRequest", "ApprovalDelay",
                    "ApprovalDuration", "Checker", "ExtendedTimeout",
                    "Expires", "LastCheckerStatus")

    def run(self, clients, bus=None, mandos=None):
        print(self.output(clients.values()))

    def output(self, clients):
        raise NotImplementedError()


class DumpJSONCmd(OutputCmd):
    def output(self, clients):
        data = {client["Name"]:
                {key: self.dbus_boolean_to_bool(client[key])
                 for key in self.all_keywords}
                for client in clients.values()}
        return json.dumps(data, indent=4, separators=(',', ': '))

    @staticmethod
    def dbus_boolean_to_bool(value):
        if isinstance(value, dbus.Boolean):
            value = bool(value)
        return value


class PrintTableCmd(OutputCmd):
    def __init__(self, verbose=False):
        self.verbose = verbose

    def output(self, clients):
        default_keywords = ("Name", "Enabled", "Timeout",
                            "LastCheckedOK")
        keywords = default_keywords
        if self.verbose:
            keywords = self.all_keywords
        return str(self.TableOfClients(clients, keywords))

    class TableOfClients(object):
        tableheaders = {
            "Name": "Name",
            "Enabled": "Enabled",
            "Timeout": "Timeout",
            "LastCheckedOK": "Last Successful Check",
            "LastApprovalRequest": "Last Approval Request",
            "Created": "Created",
            "Interval": "Interval",
            "Host": "Host",
            "Fingerprint": "Fingerprint",
            "KeyID": "Key ID",
            "CheckerRunning": "Check Is Running",
            "LastEnabled": "Last Enabled",
            "ApprovalPending": "Approval Is Pending",
            "ApprovedByDefault": "Approved By Default",
            "ApprovalDelay": "Approval Delay",
            "ApprovalDuration": "Approval Duration",
            "Checker": "Checker",
            "ExtendedTimeout": "Extended Timeout",
            "Expires": "Expires",
            "LastCheckerStatus": "Last Checker Status",
        }

        def __init__(self, clients, keywords, tableheaders=None):
            self.clients = clients
            self.keywords = keywords
            if tableheaders is not None:
                self.tableheaders = tableheaders

        def __str__(self):
            return "\n".join(self.rows())

        if sys.version_info.major == 2:
            __unicode__ = __str__
            def __str__(self):
                return str(self).encode(locale.getpreferredencoding())

        def rows(self):
            format_string = self.row_formatting_string()
            rows = [self.header_line(format_string)]
            rows.extend(self.client_line(client, format_string)
                        for client in self.clients)
            return rows

        def row_formatting_string(self):
            "Format string used to format table rows"
            return " ".join("{{{key}:{width}}}".format(
                width=max(len(self.tableheaders[key]),
                          *(len(self.string_from_client(client, key))
                            for client in self.clients)),
                key=key)
                            for key in self.keywords)

        def string_from_client(self, client, key):
            return self.valuetostring(client[key], key)

        @classmethod
        def valuetostring(cls, value, keyword):
            if isinstance(value, dbus.Boolean):
                return "Yes" if value else "No"
            if keyword in ("Timeout", "Interval", "ApprovalDelay",
                           "ApprovalDuration", "ExtendedTimeout"):
                return cls.milliseconds_to_string(value)
            return str(value)

        def header_line(self, format_string):
            return format_string.format(**self.tableheaders)

        def client_line(self, client, format_string):
            return format_string.format(
                **{key: self.string_from_client(client, key)
                   for key in self.keywords})

        @staticmethod
        def milliseconds_to_string(ms):
            td = datetime.timedelta(0, 0, 0, ms)
            return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
                    .format(days="{}T".format(td.days)
                            if td.days else "",
                            hours=td.seconds // 3600,
                            minutes=(td.seconds % 3600) // 60,
                            seconds=td.seconds % 60))


class PropertyCmd(Command):
    """Abstract class for Actions for setting one client property"""

    def run_on_one_client(self, client, properties):
        """Set the Client's D-Bus property"""
        log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
                  client.__dbus_object_path__,
                  dbus.PROPERTIES_IFACE, client_dbus_interface,
                  self.propname, self.value_to_set
                  if not isinstance(self.value_to_set, dbus.Boolean)
                  else bool(self.value_to_set))
        client.Set(client_dbus_interface, self.propname,
                   self.value_to_set,
                   dbus_interface=dbus.PROPERTIES_IFACE)

    @property
    def propname(self):
        raise NotImplementedError()


class EnableCmd(PropertyCmd):
    propname = "Enabled"
    value_to_set = dbus.Boolean(True)


class DisableCmd(PropertyCmd):
    propname = "Enabled"
    value_to_set = dbus.Boolean(False)


class BumpTimeoutCmd(PropertyCmd):
    propname = "LastCheckedOK"
    value_to_set = ""


class StartCheckerCmd(PropertyCmd):
    propname = "CheckerRunning"
    value_to_set = dbus.Boolean(True)


class StopCheckerCmd(PropertyCmd):
    propname = "CheckerRunning"
    value_to_set = dbus.Boolean(False)


class ApproveByDefaultCmd(PropertyCmd):
    propname = "ApprovedByDefault"
    value_to_set = dbus.Boolean(True)


class DenyByDefaultCmd(PropertyCmd):
    propname = "ApprovedByDefault"
    value_to_set = dbus.Boolean(False)


class PropertyValueCmd(PropertyCmd):
    """Abstract class for PropertyCmd recieving a value as argument"""
    def __init__(self, value):
        self.value_to_set = value


class SetCheckerCmd(PropertyValueCmd):
    propname = "Checker"


class SetHostCmd(PropertyValueCmd):
    propname = "Host"


class SetSecretCmd(PropertyValueCmd):
    propname = "Secret"

    @property
    def value_to_set(self):
        return self._vts

    @value_to_set.setter
    def value_to_set(self, value):
        """When setting, read data from supplied file object"""
        self._vts = value.read()
        value.close()


class MillisecondsPropertyValueArgumentCmd(PropertyValueCmd):
    """Abstract class for PropertyValueCmd taking a value argument as
a datetime.timedelta() but should store it as milliseconds."""

    @property
    def value_to_set(self):
        return self._vts

    @value_to_set.setter
    def value_to_set(self, value):
        """When setting, convert value from a datetime.timedelta"""
        self._vts = int(round(value.total_seconds() * 1000))


class SetTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
    propname = "Timeout"


class SetExtendedTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
    propname = "ExtendedTimeout"


class SetIntervalCmd(MillisecondsPropertyValueArgumentCmd):
    propname = "Interval"


class SetApprovalDelayCmd(MillisecondsPropertyValueArgumentCmd):
    propname = "ApprovalDelay"


class SetApprovalDurationCmd(MillisecondsPropertyValueArgumentCmd):
    propname = "ApprovalDuration"



class Test_string_to_delta(unittest.TestCase):
    def test_handles_basic_rfc3339(self):
        self.assertEqual(string_to_delta("PT0S"),
                         datetime.timedelta())
        self.assertEqual(string_to_delta("P0D"),
                         datetime.timedelta())
        self.assertEqual(string_to_delta("PT1S"),
                         datetime.timedelta(0, 1))
        self.assertEqual(string_to_delta("PT2H"),
                         datetime.timedelta(0, 7200))

    def test_falls_back_to_pre_1_6_1_with_warning(self):
        # assertLogs only exists in Python 3.4
        if hasattr(self, "assertLogs"):
            with self.assertLogs(log, logging.WARNING):
                value = string_to_delta("2h")
        else:
            class WarningFilter(logging.Filter):
                """Don't show, but record the presence of, warnings"""
                def filter(self, record):
                    is_warning = record.levelno >= logging.WARNING
                    self.found = is_warning or getattr(self, "found",
                                                       False)
                    return not is_warning
            warning_filter = WarningFilter()
            log.addFilter(warning_filter)
            try:
                value = string_to_delta("2h")
            finally:
                log.removeFilter(warning_filter)
            self.assertTrue(getattr(warning_filter, "found", False))
        self.assertEqual(value, datetime.timedelta(0, 7200))


class Test_check_option_syntax(unittest.TestCase):
    def setUp(self):
        self.parser = argparse.ArgumentParser()
        add_command_line_options(self.parser)

    def test_actions_requires_client_or_all(self):
        for action, value in self.actions.items():
            options = self.parser.parse_args()
            setattr(options, action, value)
            with self.assertParseError():
                self.check_option_syntax(options)

    # This mostly corresponds to the definition from has_actions() in
    # check_option_syntax()
    actions = {
        # The actual values set here are not that important, but we do
        # at least stick to the correct types, even though they are
        # never used
        "enable": True,
        "disable": True,
        "bump_timeout": True,
        "start_checker": True,
        "stop_checker": True,
        "is_enabled": True,
        "remove": True,
        "checker": "x",
        "timeout": datetime.timedelta(),
        "extended_timeout": datetime.timedelta(),
        "interval": datetime.timedelta(),
        "approved_by_default": True,
        "approval_delay": datetime.timedelta(),
        "approval_duration": datetime.timedelta(),
        "host": "x",
        "secret": io.BytesIO(b"x"),
        "approve": True,
        "deny": True,
    }

    @contextlib.contextmanager
    def assertParseError(self):
        with self.assertRaises(SystemExit) as e:
            with self.temporarily_suppress_stderr():
                yield
        # Exit code from argparse is guaranteed to be "2".  Reference:
        # https://docs.python.org/3/library
        # /argparse.html#exiting-methods
        self.assertEqual(e.exception.code, 2)

    @staticmethod
    @contextlib.contextmanager
    def temporarily_suppress_stderr():
        null = os.open(os.path.devnull, os.O_RDWR)
        stderrcopy = os.dup(sys.stderr.fileno())
        os.dup2(null, sys.stderr.fileno())
        os.close(null)
        try:
            yield
        finally:
            # restore stderr
            os.dup2(stderrcopy, sys.stderr.fileno())
            os.close(stderrcopy)

    def check_option_syntax(self, options):
        check_option_syntax(self.parser, options)

    def test_actions_conflicts_with_verbose(self):
        for action, value in self.actions.items():
            options = self.parser.parse_args()
            setattr(options, action, value)
            options.verbose = True
            with self.assertParseError():
                self.check_option_syntax(options)

    def test_dump_json_conflicts_with_verbose(self):
        options = self.parser.parse_args()
        options.dump_json = True
        options.verbose = True
        with self.assertParseError():
            self.check_option_syntax(options)

    def test_dump_json_conflicts_with_action(self):
        for action, value in self.actions.items():
            options = self.parser.parse_args()
            setattr(options, action, value)
            options.dump_json = True
            with self.assertParseError():
                self.check_option_syntax(options)

    def test_all_can_not_be_alone(self):
        options = self.parser.parse_args()
        options.all = True
        with self.assertParseError():
            self.check_option_syntax(options)

    def test_all_is_ok_with_any_action(self):
        for action, value in self.actions.items():
            options = self.parser.parse_args()
            setattr(options, action, value)
            options.all = True
            self.check_option_syntax(options)

    def test_is_enabled_fails_without_client(self):
        options = self.parser.parse_args()
        options.is_enabled = True
        with self.assertParseError():
            self.check_option_syntax(options)

    def test_is_enabled_works_with_one_client(self):
        options = self.parser.parse_args()
        options.is_enabled = True
        options.client = ["foo"]
        self.check_option_syntax(options)

    def test_is_enabled_fails_with_two_clients(self):
        options = self.parser.parse_args()
        options.is_enabled = True
        options.client = ["foo", "barbar"]
        with self.assertParseError():
            self.check_option_syntax(options)

    def test_remove_can_only_be_combined_with_action_deny(self):
        for action, value in self.actions.items():
            if action in {"remove", "deny"}:
                continue
            options = self.parser.parse_args()
            setattr(options, action, value)
            options.all = True
            options.remove = True
            with self.assertParseError():
                self.check_option_syntax(options)


class Test_commands_from_options(unittest.TestCase):
    def setUp(self):
        self.parser = argparse.ArgumentParser()
        add_command_line_options(self.parser)

    def test_is_enabled(self):
        self.assert_command_from_args(["--is-enabled", "foo"],
                                      IsEnabledCmd)

    def assert_command_from_args(self, args, command_cls,
                                 **cmd_attrs):
        """Assert that parsing ARGS should result in an instance of
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
        options = self.parser.parse_args(args)
        check_option_syntax(self.parser, options)
        commands = commands_from_options(options)
        self.assertEqual(len(commands), 1)
        command = commands[0]
        self.assertIsInstance(command, command_cls)
        for key, value in cmd_attrs.items():
            self.assertEqual(getattr(command, key), value)

    def test_is_enabled_short(self):
        self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)

    def test_approve(self):
        self.assert_command_from_args(["--approve", "foo"],
                                      ApproveCmd)

    def test_approve_short(self):
        self.assert_command_from_args(["-A", "foo"], ApproveCmd)

    def test_deny(self):
        self.assert_command_from_args(["--deny", "foo"], DenyCmd)

    def test_deny_short(self):
        self.assert_command_from_args(["-D", "foo"], DenyCmd)

    def test_remove(self):
        self.assert_command_from_args(["--remove", "foo"],
                                      RemoveCmd)

    def test_deny_before_remove(self):
        options = self.parser.parse_args(["--deny", "--remove",
                                          "foo"])
        check_option_syntax(self.parser, options)
        commands = commands_from_options(options)
        self.assertEqual(len(commands), 2)
        self.assertIsInstance(commands[0], DenyCmd)
        self.assertIsInstance(commands[1], RemoveCmd)

    def test_deny_before_remove_reversed(self):
        options = self.parser.parse_args(["--remove", "--deny",
                                          "--all"])
        check_option_syntax(self.parser, options)
        commands = commands_from_options(options)
        self.assertEqual(len(commands), 2)
        self.assertIsInstance(commands[0], DenyCmd)
        self.assertIsInstance(commands[1], RemoveCmd)

    def test_remove_short(self):
        self.assert_command_from_args(["-r", "foo"], RemoveCmd)

    def test_dump_json(self):
        self.assert_command_from_args(["--dump-json"], DumpJSONCmd)

    def test_enable(self):
        self.assert_command_from_args(["--enable", "foo"], EnableCmd)

    def test_enable_short(self):
        self.assert_command_from_args(["-e", "foo"], EnableCmd)

    def test_disable(self):
        self.assert_command_from_args(["--disable", "foo"],
                                      DisableCmd)

    def test_disable_short(self):
        self.assert_command_from_args(["-d", "foo"], DisableCmd)

    def test_bump_timeout(self):
        self.assert_command_from_args(["--bump-timeout", "foo"],
                                      BumpTimeoutCmd)

    def test_bump_timeout_short(self):
        self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)

    def test_start_checker(self):
        self.assert_command_from_args(["--start-checker", "foo"],
                                      StartCheckerCmd)

    def test_stop_checker(self):
        self.assert_command_from_args(["--stop-checker", "foo"],
                                      StopCheckerCmd)

    def test_approve_by_default(self):
        self.assert_command_from_args(["--approve-by-default", "foo"],
                                      ApproveByDefaultCmd)

    def test_deny_by_default(self):
        self.assert_command_from_args(["--deny-by-default", "foo"],
                                      DenyByDefaultCmd)

    def test_checker(self):
        self.assert_command_from_args(["--checker", ":", "foo"],
                                      SetCheckerCmd, value_to_set=":")

    def test_checker_empty(self):
        self.assert_command_from_args(["--checker", "", "foo"],
                                      SetCheckerCmd, value_to_set="")

    def test_checker_short(self):
        self.assert_command_from_args(["-c", ":", "foo"],
                                      SetCheckerCmd, value_to_set=":")

    def test_host(self):
        self.assert_command_from_args(["--host", "foo.example.org",
                                       "foo"], SetHostCmd,
                                      value_to_set="foo.example.org")

    def test_host_short(self):
        self.assert_command_from_args(["-H", "foo.example.org",
                                       "foo"], SetHostCmd,
                                      value_to_set="foo.example.org")

    def test_secret_devnull(self):
        self.assert_command_from_args(["--secret", os.path.devnull,
                                       "foo"], SetSecretCmd,
                                      value_to_set=b"")

    def test_secret_tempfile(self):
        with tempfile.NamedTemporaryFile(mode="r+b") as f:
            value = b"secret\0xyzzy\nbar"
            f.write(value)
            f.seek(0)
            self.assert_command_from_args(["--secret", f.name,
                                           "foo"], SetSecretCmd,
                                          value_to_set=value)

    def test_secret_devnull_short(self):
        self.assert_command_from_args(["-s", os.path.devnull, "foo"],
                                      SetSecretCmd, value_to_set=b"")

    def test_secret_tempfile_short(self):
        with tempfile.NamedTemporaryFile(mode="r+b") as f:
            value = b"secret\0xyzzy\nbar"
            f.write(value)
            f.seek(0)
            self.assert_command_from_args(["-s", f.name, "foo"],
                                          SetSecretCmd,
                                          value_to_set=value)

    def test_timeout(self):
        self.assert_command_from_args(["--timeout", "PT5M", "foo"],
                                      SetTimeoutCmd,
                                      value_to_set=300000)

    def test_timeout_short(self):
        self.assert_command_from_args(["-t", "PT5M", "foo"],
                                      SetTimeoutCmd,
                                      value_to_set=300000)

    def test_extended_timeout(self):
        self.assert_command_from_args(["--extended-timeout", "PT15M",
                                       "foo"],
                                      SetExtendedTimeoutCmd,
                                      value_to_set=900000)

    def test_interval(self):
        self.assert_command_from_args(["--interval", "PT2M", "foo"],
                                      SetIntervalCmd,
                                      value_to_set=120000)

    def test_interval_short(self):
        self.assert_command_from_args(["-i", "PT2M", "foo"],
                                      SetIntervalCmd,
                                      value_to_set=120000)

    def test_approval_delay(self):
        self.assert_command_from_args(["--approval-delay", "PT30S",
                                       "foo"], SetApprovalDelayCmd,
                                      value_to_set=30000)

    def test_approval_duration(self):
        self.assert_command_from_args(["--approval-duration", "PT1S",
                                       "foo"], SetApprovalDurationCmd,
                                      value_to_set=1000)

    def test_print_table(self):
        self.assert_command_from_args([], PrintTableCmd,
                                      verbose=False)

    def test_print_table_verbose(self):
        self.assert_command_from_args(["--verbose"], PrintTableCmd,
                                      verbose=True)

    def test_print_table_verbose_short(self):
        self.assert_command_from_args(["-v"], PrintTableCmd,
                                      verbose=True)


class TestCmd(unittest.TestCase):
    """Abstract class for tests of command classes"""

    def setUp(self):
        testcase = self
        class MockClient(object):
            def __init__(self, name, **attributes):
                self.__dbus_object_path__ = "/clients/{}".format(name)
                self.attributes = attributes
                self.attributes["Name"] = name
                self.calls = []
            def Set(self, interface, propname, value, dbus_interface):
                testcase.assertEqual(interface, client_dbus_interface)
                testcase.assertEqual(dbus_interface,
                                     dbus.PROPERTIES_IFACE)
                self.attributes[propname] = value
            def Get(self, interface, propname, dbus_interface):
                testcase.assertEqual(interface, client_dbus_interface)
                testcase.assertEqual(dbus_interface,
                                     dbus.PROPERTIES_IFACE)
                return self.attributes[propname]
            def Approve(self, approve, dbus_interface):
                testcase.assertEqual(dbus_interface,
                                     client_dbus_interface)
                self.calls.append(("Approve", (approve,
                                               dbus_interface)))
        self.client = MockClient(
            "foo",
            KeyID=("92ed150794387c03ce684574b1139a65"
                   "94a34f895daaaf09fd8ea90a27cddb12"),
            Secret=b"secret",
            Host="foo.example.org",
            Enabled=dbus.Boolean(True),
            Timeout=300000,
            LastCheckedOK="2019-02-03T00:00:00",
            Created="2019-01-02T00:00:00",
            Interval=120000,
            Fingerprint=("778827225BA7DE539C5A"
                         "7CFA59CFF7CDBD9A5920"),
            CheckerRunning=dbus.Boolean(False),
            LastEnabled="2019-01-03T00:00:00",
            ApprovalPending=dbus.Boolean(False),
            ApprovedByDefault=dbus.Boolean(True),
            LastApprovalRequest="",
            ApprovalDelay=0,
            ApprovalDuration=1000,
            Checker="fping -q -- %(host)s",
            ExtendedTimeout=900000,
            Expires="2019-02-04T00:00:00",
            LastCheckerStatus=0)
        self.other_client = MockClient(
            "barbar",
            KeyID=("0558568eedd67d622f5c83b35a115f79"
                   "6ab612cff5ad227247e46c2b020f441c"),
            Secret=b"secretbar",
            Host="192.0.2.3",
            Enabled=dbus.Boolean(True),
            Timeout=300000,
            LastCheckedOK="2019-02-04T00:00:00",
            Created="2019-01-03T00:00:00",
            Interval=120000,
            Fingerprint=("3E393AEAEFB84C7E89E2"
                         "F547B3A107558FCA3A27"),
            CheckerRunning=dbus.Boolean(True),
            LastEnabled="2019-01-04T00:00:00",
            ApprovalPending=dbus.Boolean(False),
            ApprovedByDefault=dbus.Boolean(False),
            LastApprovalRequest="2019-01-03T00:00:00",
            ApprovalDelay=30000,
            ApprovalDuration=93785000,
            Checker=":",
            ExtendedTimeout=900000,
            Expires="2019-02-05T00:00:00",
            LastCheckerStatus=-2)
        self.clients =  collections.OrderedDict(
            [
                ("/clients/foo", self.client.attributes),
                ("/clients/barbar", self.other_client.attributes),
            ])
        self.one_client = {"/clients/foo": self.client.attributes}

    @property
    def bus(self):
        class Bus(object):
            @staticmethod
            def get_object(client_bus_name, path):
                self.assertEqual(client_bus_name, dbus_busname)
                return {
                    # Note: "self" here is the TestCmd instance, not
                    # the Bus instance, since this is a static method!
                    "/clients/foo": self.client,
                    "/clients/barbar": self.other_client,
                }[path]
        return Bus()


class TestIsEnabledCmd(TestCmd):
    def test_is_enabled(self):
        self.assertTrue(all(IsEnabledCmd().is_enabled(client,
                                                      properties)
                            for client, properties
                            in self.clients.items()))

    def test_is_enabled_run_exits_successfully(self):
        with self.assertRaises(SystemExit) as e:
            IsEnabledCmd().run(self.one_client)
        if e.exception.code is not None:
            self.assertEqual(e.exception.code, 0)
        else:
            self.assertIsNone(e.exception.code)

    def test_is_enabled_run_exits_with_failure(self):
        self.client.attributes["Enabled"] = dbus.Boolean(False)
        with self.assertRaises(SystemExit) as e:
            IsEnabledCmd().run(self.one_client)
        if isinstance(e.exception.code, int):
            self.assertNotEqual(e.exception.code, 0)
        else:
            self.assertIsNotNone(e.exception.code)


class TestApproveCmd(TestCmd):
    def test_approve(self):
        ApproveCmd().run(self.clients, self.bus)
        for clientpath in self.clients:
            client = self.bus.get_object(dbus_busname, clientpath)
            self.assertIn(("Approve", (True, client_dbus_interface)),
                          client.calls)


class TestDenyCmd(TestCmd):
    def test_deny(self):
        DenyCmd().run(self.clients, self.bus)
        for clientpath in self.clients:
            client = self.bus.get_object(dbus_busname, clientpath)
            self.assertIn(("Approve", (False, client_dbus_interface)),
                          client.calls)


class TestRemoveCmd(TestCmd):
    def test_remove(self):
        class MockMandos(object):
            def __init__(self):
                self.calls = []
            def RemoveClient(self, dbus_path):
                self.calls.append(("RemoveClient", (dbus_path,)))
        mandos = MockMandos()
        super(TestRemoveCmd, self).setUp()
        RemoveCmd().run(self.clients, self.bus, mandos)
        self.assertEqual(len(mandos.calls), 2)
        for clientpath in self.clients:
            self.assertIn(("RemoveClient", (clientpath,)),
                          mandos.calls)


class TestDumpJSONCmd(TestCmd):
    def setUp(self):
        self.expected_json = {
            "foo": {
                "Name": "foo",
                "KeyID": ("92ed150794387c03ce684574b1139a65"
                          "94a34f895daaaf09fd8ea90a27cddb12"),
                "Host": "foo.example.org",
                "Enabled": True,
                "Timeout": 300000,
                "LastCheckedOK": "2019-02-03T00:00:00",
                "Created": "2019-01-02T00:00:00",
                "Interval": 120000,
                "Fingerprint": ("778827225BA7DE539C5A"
                                "7CFA59CFF7CDBD9A5920"),
                "CheckerRunning": False,
                "LastEnabled": "2019-01-03T00:00:00",
                "ApprovalPending": False,
                "ApprovedByDefault": True,
                "LastApprovalRequest": "",
                "ApprovalDelay": 0,
                "ApprovalDuration": 1000,
                "Checker": "fping -q -- %(host)s",
                "ExtendedTimeout": 900000,
                "Expires": "2019-02-04T00:00:00",
                "LastCheckerStatus": 0,
            },
            "barbar": {
                "Name": "barbar",
                "KeyID": ("0558568eedd67d622f5c83b35a115f79"
                          "6ab612cff5ad227247e46c2b020f441c"),
                "Host": "192.0.2.3",
                "Enabled": True,
                "Timeout": 300000,
                "LastCheckedOK": "2019-02-04T00:00:00",
                "Created": "2019-01-03T00:00:00",
                "Interval": 120000,
                "Fingerprint": ("3E393AEAEFB84C7E89E2"
                                "F547B3A107558FCA3A27"),
                "CheckerRunning": True,
                "LastEnabled": "2019-01-04T00:00:00",
                "ApprovalPending": False,
                "ApprovedByDefault": False,
                "LastApprovalRequest": "2019-01-03T00:00:00",
                "ApprovalDelay": 30000,
                "ApprovalDuration": 93785000,
                "Checker": ":",
                "ExtendedTimeout": 900000,
                "Expires": "2019-02-05T00:00:00",
                "LastCheckerStatus": -2,
            },
        }
        return super(TestDumpJSONCmd, self).setUp()

    def test_normal(self):
        json_data = json.loads(DumpJSONCmd().output(self.clients))
        self.assertDictEqual(json_data, self.expected_json)

    def test_one_client(self):
        clients = self.one_client
        json_data = json.loads(DumpJSONCmd().output(clients))
        expected_json = {"foo": self.expected_json["foo"]}
        self.assertDictEqual(json_data, expected_json)


class TestPrintTableCmd(TestCmd):
    def test_normal(self):
        output = PrintTableCmd().output(self.clients.values())
        expected_output = "\n".join((
            "Name   Enabled Timeout  Last Successful Check",
            "foo    Yes     00:05:00 2019-02-03T00:00:00  ",
            "barbar Yes     00:05:00 2019-02-04T00:00:00  ",
        ))
        self.assertEqual(output, expected_output)

    def test_verbose(self):
        output = PrintTableCmd(verbose=True).output(
            self.clients.values())
        columns = (
            (
                "Name   ",
                "foo    ",
                "barbar ",
            ),(
                "Enabled ",
                "Yes     ",
                "Yes     ",
            ),(
                "Timeout  ",
                "00:05:00 ",
                "00:05:00 ",
            ),(
                "Last Successful Check ",
                "2019-02-03T00:00:00   ",
                "2019-02-04T00:00:00   ",
            ),(
                "Created             ",
                "2019-01-02T00:00:00 ",
                "2019-01-03T00:00:00 ",
            ),(
                "Interval ",
                "00:02:00 ",
                "00:02:00 ",
            ),(
                "Host            ",
                "foo.example.org ",
                "192.0.2.3       ",
            ),(
                ("Key ID                                             "
                 "              "),
                ("92ed150794387c03ce684574b1139a6594a34f895daaaf09fd8"
                 "ea90a27cddb12 "),
                ("0558568eedd67d622f5c83b35a115f796ab612cff5ad227247e"
                 "46c2b020f441c "),
            ),(
                "Fingerprint                              ",
                "778827225BA7DE539C5A7CFA59CFF7CDBD9A5920 ",
                "3E393AEAEFB84C7E89E2F547B3A107558FCA3A27 ",
            ),(
                "Check Is Running ",
                "No               ",
                "Yes              ",
            ),(
                "Last Enabled        ",
                "2019-01-03T00:00:00 ",
                "2019-01-04T00:00:00 ",
            ),(
                "Approval Is Pending ",
                "No                  ",
                "No                  ",
            ),(
                "Approved By Default ",
                "Yes                 ",
                "No                  ",
            ),(
                "Last Approval Request ",
                "                      ",
                "2019-01-03T00:00:00   ",
            ),(
                "Approval Delay ",
                "00:00:00       ",
                "00:00:30       ",
            ),(
                "Approval Duration ",
                "00:00:01          ",
                "1T02:03:05        ",
            ),(
                "Checker              ",
                "fping -q -- %(host)s ",
                ":                    ",
            ),(
                "Extended Timeout ",
                "00:15:00         ",
                "00:15:00         ",
            ),(
                "Expires             ",
                "2019-02-04T00:00:00 ",
                "2019-02-05T00:00:00 ",
            ),(
                "Last Checker Status",
                "0                  ",
                "-2                 ",
            )
        )
        num_lines = max(len(rows) for rows in columns)
        expected_output = "\n".join("".join(rows[line]
                                            for rows in columns)
                                    for line in range(num_lines))
        self.assertEqual(output, expected_output)

    def test_one_client(self):
        output = PrintTableCmd().output(self.one_client.values())
        expected_output = "\n".join((
            "Name Enabled Timeout  Last Successful Check",
            "foo  Yes     00:05:00 2019-02-03T00:00:00  ",
        ))
        self.assertEqual(output, expected_output)


class TestPropertyCmd(TestCmd):
    """Abstract class for tests of PropertyCmd classes"""
    def runTest(self):
        if not hasattr(self, "command"):
            return
        values_to_get = getattr(self, "values_to_get",
                                self.values_to_set)
        for value_to_set, value_to_get in zip(self.values_to_set,
                                              values_to_get):
            for clientpath in self.clients:
                client = self.bus.get_object(dbus_busname, clientpath)
                old_value = client.attributes[self.propname]
                self.assertNotIsInstance(old_value, self.Unique)
                client.attributes[self.propname] = self.Unique()
            self.run_command(value_to_set, self.clients)
            for clientpath in self.clients:
                client = self.bus.get_object(dbus_busname, clientpath)
                value = client.attributes[self.propname]
                self.assertNotIsInstance(value, self.Unique)
                self.assertEqual(value, value_to_get)

    class Unique(object):
        """Class for objects which exist only to be unique objects,
since unittest.mock.sentinel only exists in Python 3.3"""

    def run_command(self, value, clients):
        self.command().run(clients, self.bus)


class TestEnableCmd(TestPropertyCmd):
    command = EnableCmd
    propname = "Enabled"
    values_to_set = [dbus.Boolean(True)]


class TestDisableCmd(TestPropertyCmd):
    command = DisableCmd
    propname = "Enabled"
    values_to_set = [dbus.Boolean(False)]


class TestBumpTimeoutCmd(TestPropertyCmd):
    command = BumpTimeoutCmd
    propname = "LastCheckedOK"
    values_to_set = [""]


class TestStartCheckerCmd(TestPropertyCmd):
    command = StartCheckerCmd
    propname = "CheckerRunning"
    values_to_set = [dbus.Boolean(True)]


class TestStopCheckerCmd(TestPropertyCmd):
    command = StopCheckerCmd
    propname = "CheckerRunning"
    values_to_set = [dbus.Boolean(False)]


class TestApproveByDefaultCmd(TestPropertyCmd):
    command = ApproveByDefaultCmd
    propname = "ApprovedByDefault"
    values_to_set = [dbus.Boolean(True)]


class TestDenyByDefaultCmd(TestPropertyCmd):
    command = DenyByDefaultCmd
    propname = "ApprovedByDefault"
    values_to_set = [dbus.Boolean(False)]


class TestPropertyValueCmd(TestPropertyCmd):
    """Abstract class for tests of PropertyValueCmd classes"""

    def runTest(self):
        if type(self) is TestPropertyValueCmd:
            return
        return super(TestPropertyValueCmd, self).runTest()

    def run_command(self, value, clients):
        self.command(value).run(clients, self.bus)


class TestSetCheckerCmd(TestPropertyValueCmd):
    command = SetCheckerCmd
    propname = "Checker"
    values_to_set = ["", ":", "fping -q -- %s"]


class TestSetHostCmd(TestPropertyValueCmd):
    command = SetHostCmd
    propname = "Host"
    values_to_set = ["192.0.2.3", "foo.example.org"]


class TestSetSecretCmd(TestPropertyValueCmd):
    command = SetSecretCmd
    propname = "Secret"
    values_to_set = [io.BytesIO(b""),
                     io.BytesIO(b"secret\0xyzzy\nbar")]
    values_to_get = [b"", b"secret\0xyzzy\nbar"]


class TestSetTimeoutCmd(TestPropertyValueCmd):
    command = SetTimeoutCmd
    propname = "Timeout"
    values_to_set = [datetime.timedelta(),
                     datetime.timedelta(minutes=5),
                     datetime.timedelta(seconds=1),
                     datetime.timedelta(weeks=1),
                     datetime.timedelta(weeks=52)]
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]


class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
    command = SetExtendedTimeoutCmd
    propname = "ExtendedTimeout"
    values_to_set = [datetime.timedelta(),
                     datetime.timedelta(minutes=5),
                     datetime.timedelta(seconds=1),
                     datetime.timedelta(weeks=1),
                     datetime.timedelta(weeks=52)]
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]


class TestSetIntervalCmd(TestPropertyValueCmd):
    command = SetIntervalCmd
    propname = "Interval"
    values_to_set = [datetime.timedelta(),
                     datetime.timedelta(minutes=5),
                     datetime.timedelta(seconds=1),
                     datetime.timedelta(weeks=1),
                     datetime.timedelta(weeks=52)]
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]


class TestSetApprovalDelayCmd(TestPropertyValueCmd):
    command = SetApprovalDelayCmd
    propname = "ApprovalDelay"
    values_to_set = [datetime.timedelta(),
                     datetime.timedelta(minutes=5),
                     datetime.timedelta(seconds=1),
                     datetime.timedelta(weeks=1),
                     datetime.timedelta(weeks=52)]
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]


class TestSetApprovalDurationCmd(TestPropertyValueCmd):
    command = SetApprovalDurationCmd
    propname = "ApprovalDuration"
    values_to_set = [datetime.timedelta(),
                     datetime.timedelta(minutes=5),
                     datetime.timedelta(seconds=1),
                     datetime.timedelta(weeks=1),
                     datetime.timedelta(weeks=52)]
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]



def should_only_run_tests():
    parser = argparse.ArgumentParser(add_help=False)
    parser.add_argument("--check", action='store_true')
    args, unknown_args = parser.parse_known_args()
    run_tests = args.check
    if run_tests:
        # Remove --check argument from sys.argv
        sys.argv[1:] = unknown_args
    return run_tests

# Add all tests from doctest strings
def load_tests(loader, tests, none):
    import doctest
    tests.addTests(doctest.DocTestSuite())
    return tests

if __name__ == "__main__":
    if should_only_run_tests():
        # Call using ./tdd-python-script --check [--verbose]
        unittest.main()
    else:
        main()