/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos-ctl

  • Committer: Teddy Hogeborn
  • Date: 2019-03-02 01:56:35 UTC
  • Revision ID: teddy@recompile.se-20190302015635-xgodxd3ivltju7qn
mandos-ctl: Refactor

* mandos-ctl (global tablewords): Refactor into TableOfClients.
  (TableOfClients.tablewords): New overrideable class attribute.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-ctl
1
1
#!/usr/bin/python
2
 
# -*- mode: python; coding: utf-8 -*-
3
 
# 
 
2
# -*- 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*")))); -*-
 
3
#
4
4
# Mandos Monitor - Control and monitor the Mandos server
5
 
# 
6
 
# Copyright © 2008-2015 Teddy Hogeborn
7
 
# Copyright © 2008-2015 Björn Påhlsson
8
 
# 
9
 
# This program is free software: you can redistribute it and/or modify
10
 
# it under the terms of the GNU General Public License as published by
 
5
#
 
6
# Copyright © 2008-2019 Teddy Hogeborn
 
7
# Copyright © 2008-2019 Björn Påhlsson
 
8
#
 
9
# This file is part of Mandos.
 
10
#
 
11
# Mandos is free software: you can redistribute it and/or modify it
 
12
# under the terms of the GNU General Public License as published by
11
13
# the Free Software Foundation, either version 3 of the License, or
12
14
# (at your option) any later version.
13
15
#
14
 
#     This program is distributed in the hope that it will be useful,
15
 
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
 
16
#     Mandos is distributed in the hope that it will be useful, but
 
17
#     WITHOUT ANY WARRANTY; without even the implied warranty of
16
18
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17
19
#     GNU General Public License for more details.
18
 
# 
 
20
#
19
21
# You should have received a copy of the GNU General Public License
20
 
# along with this program.  If not, see
21
 
# <http://www.gnu.org/licenses/>.
22
 
# 
 
22
# along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
 
23
#
23
24
# Contact the authors at <mandos@recompile.se>.
24
 
# 
 
25
#
25
26
 
26
27
from __future__ import (division, absolute_import, print_function,
27
28
                        unicode_literals)
38
39
import re
39
40
import os
40
41
import collections
41
 
import doctest
 
42
import json
 
43
import unittest
 
44
import logging
42
45
 
43
46
import dbus
44
47
 
 
48
# Show warnings by default
 
49
if not sys.warnoptions:
 
50
    import warnings
 
51
    warnings.simplefilter("default")
 
52
 
 
53
log = logging.getLogger(sys.argv[0])
 
54
logging.basicConfig(level="INFO", # Show info level messages
 
55
                    format="%(message)s") # Show basic log messages
 
56
 
 
57
logging.captureWarnings(True)   # Show warnings via the logging system
 
58
 
45
59
if sys.version_info.major == 2:
46
60
    str = unicode
47
61
 
48
62
locale.setlocale(locale.LC_ALL, "")
49
63
 
50
 
tablewords = {
51
 
    "Name": "Name",
52
 
    "Enabled": "Enabled",
53
 
    "Timeout": "Timeout",
54
 
    "LastCheckedOK": "Last Successful Check",
55
 
    "LastApprovalRequest": "Last Approval Request",
56
 
    "Created": "Created",
57
 
    "Interval": "Interval",
58
 
    "Host": "Host",
59
 
    "Fingerprint": "Fingerprint",
60
 
    "CheckerRunning": "Check Is Running",
61
 
    "LastEnabled": "Last Enabled",
62
 
    "ApprovalPending": "Approval Is Pending",
63
 
    "ApprovedByDefault": "Approved By Default",
64
 
    "ApprovalDelay": "Approval Delay",
65
 
    "ApprovalDuration": "Approval Duration",
66
 
    "Checker": "Checker",
67
 
    "ExtendedTimeout": "Extended Timeout"
68
 
}
69
64
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
70
65
domain = "se.recompile"
71
66
busname = domain + ".Mandos"
72
67
server_path = "/"
73
68
server_interface = domain + ".Mandos"
74
69
client_interface = domain + ".Mandos.Client"
75
 
version = "1.6.9"
 
70
version = "1.8.3"
 
71
 
 
72
 
 
73
try:
 
74
    dbus.OBJECT_MANAGER_IFACE
 
75
except AttributeError:
 
76
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
76
77
 
77
78
 
78
79
def milliseconds_to_string(ms):
79
80
    td = datetime.timedelta(0, 0, 0, ms)
80
 
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}".format(
81
 
        days = "{}T".format(td.days) if td.days else "",
82
 
        hours = td.seconds // 3600,
83
 
        minutes = (td.seconds % 3600) // 60,
84
 
        seconds = td.seconds % 60))
 
81
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
 
82
            .format(days="{}T".format(td.days) if td.days else "",
 
83
                    hours=td.seconds // 3600,
 
84
                    minutes=(td.seconds % 3600) // 60,
 
85
                    seconds=td.seconds % 60))
85
86
 
86
87
 
87
88
def rfc3339_duration_to_delta(duration):
88
89
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
89
 
    
 
90
 
90
91
    >>> rfc3339_duration_to_delta("P7D")
91
92
    datetime.timedelta(7)
92
93
    >>> rfc3339_duration_to_delta("PT60S")
93
94
    datetime.timedelta(0, 60)
94
95
    >>> rfc3339_duration_to_delta("PT60M")
95
96
    datetime.timedelta(0, 3600)
 
97
    >>> rfc3339_duration_to_delta("P60M")
 
98
    datetime.timedelta(1680)
96
99
    >>> rfc3339_duration_to_delta("PT24H")
97
100
    datetime.timedelta(1)
98
101
    >>> rfc3339_duration_to_delta("P1W")
101
104
    datetime.timedelta(0, 330)
102
105
    >>> rfc3339_duration_to_delta("P1DT3M20S")
103
106
    datetime.timedelta(1, 200)
 
107
    >>> # Can not be empty:
 
108
    >>> rfc3339_duration_to_delta("")
 
109
    Traceback (most recent call last):
 
110
    ...
 
111
    ValueError: Invalid RFC 3339 duration: u''
 
112
    >>> # Must start with "P":
 
113
    >>> rfc3339_duration_to_delta("1D")
 
114
    Traceback (most recent call last):
 
115
    ...
 
116
    ValueError: Invalid RFC 3339 duration: u'1D'
 
117
    >>> # Must use correct order
 
118
    >>> rfc3339_duration_to_delta("PT1S2M")
 
119
    Traceback (most recent call last):
 
120
    ...
 
121
    ValueError: Invalid RFC 3339 duration: u'PT1S2M'
 
122
    >>> # Time needs time marker
 
123
    >>> rfc3339_duration_to_delta("P1H2S")
 
124
    Traceback (most recent call last):
 
125
    ...
 
126
    ValueError: Invalid RFC 3339 duration: u'P1H2S'
 
127
    >>> # Weeks can not be combined with anything else
 
128
    >>> rfc3339_duration_to_delta("P1D2W")
 
129
    Traceback (most recent call last):
 
130
    ...
 
131
    ValueError: Invalid RFC 3339 duration: u'P1D2W'
 
132
    >>> rfc3339_duration_to_delta("P2W2H")
 
133
    Traceback (most recent call last):
 
134
    ...
 
135
    ValueError: Invalid RFC 3339 duration: u'P2W2H'
104
136
    """
105
 
    
 
137
 
106
138
    # Parsing an RFC 3339 duration with regular expressions is not
107
139
    # possible - there would have to be multiple places for the same
108
140
    # values, like seconds.  The current code, while more esoteric, is
109
141
    # cleaner without depending on a parsing library.  If Python had a
110
142
    # built-in library for parsing we would use it, but we'd like to
111
143
    # avoid excessive use of external libraries.
112
 
    
 
144
 
113
145
    # New type for defining tokens, syntax, and semantics all-in-one
114
 
    Token = collections.namedtuple("Token",
115
 
                                   ("regexp", # To match token; if
116
 
                                              # "value" is not None,
117
 
                                              # must have a "group"
118
 
                                              # containing digits
119
 
                                    "value",  # datetime.timedelta or
120
 
                                              # None
121
 
                                    "followers")) # Tokens valid after
122
 
                                                  # this token
 
146
    Token = collections.namedtuple("Token", (
 
147
        "regexp",  # To match token; if "value" is not None, must have
 
148
                   # a "group" containing digits
 
149
        "value",   # datetime.timedelta or None
 
150
        "followers"))           # Tokens valid after this token
123
151
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
124
152
    # the "duration" ABNF definition in RFC 3339, Appendix A.
125
153
    token_end = Token(re.compile(r"$"), None, frozenset())
152
180
                           frozenset((token_year, token_month,
153
181
                                      token_day, token_time,
154
182
                                      token_week)))
155
 
    # Define starting values
156
 
    value = datetime.timedelta() # Value so far
 
183
    # Define starting values:
 
184
    # Value so far
 
185
    value = datetime.timedelta()
157
186
    found_token = None
158
 
    followers = frozenset((token_duration, )) # Following valid tokens
159
 
    s = duration                # String left to parse
 
187
    # Following valid tokens
 
188
    followers = frozenset((token_duration, ))
 
189
    # String left to parse
 
190
    s = duration
160
191
    # Loop until end token is found
161
192
    while found_token is not token_end:
162
193
        # Search for any currently valid tokens
178
209
                break
179
210
        else:
180
211
            # No currently valid tokens were found
181
 
            raise ValueError("Invalid RFC 3339 duration")
 
212
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
213
                             .format(duration))
182
214
    # End token found
183
215
    return value
184
216
 
185
217
 
186
218
def string_to_delta(interval):
187
219
    """Parse a string and return a datetime.timedelta
188
 
    
189
 
    >>> string_to_delta("7d")
190
 
    datetime.timedelta(7)
191
 
    >>> string_to_delta("60s")
192
 
    datetime.timedelta(0, 60)
193
 
    >>> string_to_delta("60m")
194
 
    datetime.timedelta(0, 3600)
195
 
    >>> string_to_delta("24h")
196
 
    datetime.timedelta(1)
197
 
    >>> string_to_delta("1w")
198
 
    datetime.timedelta(7)
199
 
    >>> string_to_delta("5m 30s")
200
 
    datetime.timedelta(0, 330)
201
220
    """
202
 
    
 
221
 
203
222
    try:
204
223
        return rfc3339_duration_to_delta(interval)
205
 
    except ValueError:
206
 
        pass
207
 
    
 
224
    except ValueError as e:
 
225
        log.warning("%s - Parsing as pre-1.6.1 interval instead",
 
226
                    ' '.join(e.args))
 
227
    return parse_pre_1_6_1_interval(interval)
 
228
 
 
229
 
 
230
def parse_pre_1_6_1_interval(interval):
 
231
    """Parse an interval string as documented by Mandos before 1.6.1, and
 
232
    return a datetime.timedelta
 
233
    >>> parse_pre_1_6_1_interval('7d')
 
234
    datetime.timedelta(7)
 
235
    >>> parse_pre_1_6_1_interval('60s')
 
236
    datetime.timedelta(0, 60)
 
237
    >>> parse_pre_1_6_1_interval('60m')
 
238
    datetime.timedelta(0, 3600)
 
239
    >>> parse_pre_1_6_1_interval('24h')
 
240
    datetime.timedelta(1)
 
241
    >>> parse_pre_1_6_1_interval('1w')
 
242
    datetime.timedelta(7)
 
243
    >>> parse_pre_1_6_1_interval('5m 30s')
 
244
    datetime.timedelta(0, 330)
 
245
    >>> parse_pre_1_6_1_interval('')
 
246
    datetime.timedelta(0)
 
247
    >>> # Ignore unknown characters, allow any order and repetitions
 
248
    >>> parse_pre_1_6_1_interval('2dxy7zz11y3m5m')
 
249
    datetime.timedelta(2, 480, 18000)
 
250
 
 
251
    """
 
252
 
208
253
    value = datetime.timedelta(0)
209
254
    regexp = re.compile(r"(\d+)([dsmhw]?)")
210
 
    
 
255
 
211
256
    for num, suffix in regexp.findall(interval):
212
257
        if suffix == "d":
213
258
            value += datetime.timedelta(int(num))
225
270
 
226
271
 
227
272
def print_clients(clients, keywords):
 
273
    print('\n'.join(TableOfClients(clients, keywords).rows()))
 
274
 
 
275
class TableOfClients(object):
 
276
    tablewords = {
 
277
        "Name": "Name",
 
278
        "Enabled": "Enabled",
 
279
        "Timeout": "Timeout",
 
280
        "LastCheckedOK": "Last Successful Check",
 
281
        "LastApprovalRequest": "Last Approval Request",
 
282
        "Created": "Created",
 
283
        "Interval": "Interval",
 
284
        "Host": "Host",
 
285
        "Fingerprint": "Fingerprint",
 
286
        "KeyID": "Key ID",
 
287
        "CheckerRunning": "Check Is Running",
 
288
        "LastEnabled": "Last Enabled",
 
289
        "ApprovalPending": "Approval Is Pending",
 
290
        "ApprovedByDefault": "Approved By Default",
 
291
        "ApprovalDelay": "Approval Delay",
 
292
        "ApprovalDuration": "Approval Duration",
 
293
        "Checker": "Checker",
 
294
        "ExtendedTimeout": "Extended Timeout",
 
295
        "Expires": "Expires",
 
296
        "LastCheckerStatus": "Last Checker Status",
 
297
    }
 
298
 
 
299
    def __init__(self, clients, keywords, tablewords=None):
 
300
        self.clients = clients
 
301
        self.keywords = keywords
 
302
        if tablewords is not None:
 
303
            self.tablewords = tablewords
 
304
 
 
305
    @staticmethod
228
306
    def valuetostring(value, keyword):
229
 
        if type(value) is dbus.Boolean:
 
307
        if isinstance(value, dbus.Boolean):
230
308
            return "Yes" if value else "No"
231
309
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
232
310
                       "ApprovalDuration", "ExtendedTimeout"):
233
311
            return milliseconds_to_string(value)
234
312
        return str(value)
235
 
    
236
 
    # Create format string to print table rows
237
 
    format_string = " ".join("{{{key}:{width}}}".format(
238
 
        width = max(len(tablewords[key]),
239
 
                    max(len(valuetostring(client[key], key))
240
 
                        for client in clients)),
241
 
        key = key)
242
 
                             for key in keywords)
243
 
    # Print header line
244
 
    print(format_string.format(**tablewords))
245
 
    for client in clients:
246
 
        print(format_string.format(**{
247
 
            key: valuetostring(client[key], key)
248
 
            for key in keywords }))
 
313
 
 
314
    def rows(self):
 
315
        # Create format string to format table rows
 
316
        format_string = " ".join("{{{key}:{width}}}".format(
 
317
            width=max(len(self.tablewords[key]),
 
318
                      max(len(self.valuetostring(client[key], key))
 
319
                          for client in self.clients)),
 
320
            key=key)
 
321
                                 for key in self.keywords)
 
322
        # Start with header line
 
323
        rows = [format_string.format(**self.tablewords)]
 
324
        for client in self.clients:
 
325
            rows.append(format_string
 
326
                        .format(**{key: self.valuetostring(client[key], key)
 
327
                                   for key in self.keywords}))
 
328
        return rows
249
329
 
250
330
 
251
331
def has_actions(options):
272
352
def main():
273
353
    parser = argparse.ArgumentParser()
274
354
    parser.add_argument("--version", action="version",
275
 
                        version = "%(prog)s {}".format(version),
 
355
                        version="%(prog)s {}".format(version),
276
356
                        help="show version number and exit")
277
357
    parser.add_argument("-a", "--all", action="store_true",
278
358
                        help="Select all clients")
279
359
    parser.add_argument("-v", "--verbose", action="store_true",
280
360
                        help="Print all fields")
 
361
    parser.add_argument("-j", "--dump-json", action="store_true",
 
362
                        help="Dump client data in JSON format")
281
363
    parser.add_argument("-e", "--enable", action="store_true",
282
364
                        help="Enable client")
283
365
    parser.add_argument("-d", "--disable", action="store_true",
322
404
                        help="Run self-test")
323
405
    parser.add_argument("client", nargs="*", help="Client name")
324
406
    options = parser.parse_args()
325
 
    
 
407
 
326
408
    if has_actions(options) and not (options.client or options.all):
327
409
        parser.error("Options require clients names or --all.")
328
410
    if options.verbose and has_actions(options):
329
 
        parser.error("--verbose can only be used alone or with"
330
 
                     " --all.")
 
411
        parser.error("--verbose can only be used alone.")
 
412
    if options.dump_json and (options.verbose
 
413
                              or has_actions(options)):
 
414
        parser.error("--dump-json can only be used alone.")
331
415
    if options.all and not has_actions(options):
332
416
        parser.error("--all requires an action.")
333
417
 
334
 
    if options.check:
335
 
        fail_count, test_count = doctest.testmod()
336
 
        sys.exit(os.EX_OK if fail_count == 0 else 1)
337
 
    
338
418
    try:
339
419
        bus = dbus.SystemBus()
340
420
        mandos_dbus_objc = bus.get_object(busname, server_path)
341
421
    except dbus.exceptions.DBusException:
342
 
        print("Could not connect to Mandos server", file=sys.stderr)
 
422
        log.critical("Could not connect to Mandos server")
343
423
        sys.exit(1)
344
 
    
 
424
 
345
425
    mandos_serv = dbus.Interface(mandos_dbus_objc,
346
 
                                 dbus_interface = server_interface)
347
 
    
348
 
    #block stderr since dbus library prints to stderr
 
426
                                 dbus_interface=server_interface)
 
427
    mandos_serv_object_manager = dbus.Interface(
 
428
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
 
429
 
 
430
    # block stderr since dbus library prints to stderr
349
431
    null = os.open(os.path.devnull, os.O_RDWR)
350
432
    stderrcopy = os.dup(sys.stderr.fileno())
351
433
    os.dup2(null, sys.stderr.fileno())
352
434
    os.close(null)
353
435
    try:
354
436
        try:
355
 
            mandos_clients = mandos_serv.GetAllClientsWithProperties()
 
437
            mandos_clients = {path: ifs_and_props[client_interface]
 
438
                              for path, ifs_and_props in
 
439
                              mandos_serv_object_manager
 
440
                              .GetManagedObjects().items()
 
441
                              if client_interface in ifs_and_props}
356
442
        finally:
357
 
            #restore stderr
 
443
            # restore stderr
358
444
            os.dup2(stderrcopy, sys.stderr.fileno())
359
445
            os.close(stderrcopy)
360
 
    except dbus.exceptions.DBusException:
361
 
        print("Access denied: Accessing mandos server through dbus.",
362
 
              file=sys.stderr)
 
446
    except dbus.exceptions.DBusException as e:
 
447
        log.critical("Failed to access Mandos server through D-Bus:"
 
448
                     "\n%s", e)
363
449
        sys.exit(1)
364
 
    
 
450
 
365
451
    # Compile dict of (clients: properties) to process
366
 
    clients={}
367
 
    
 
452
    clients = {}
 
453
 
368
454
    if options.all or not options.client:
369
 
        clients = { bus.get_object(busname, path): properties
370
 
                    for path, properties in mandos_clients.items() }
 
455
        clients = {bus.get_object(busname, path): properties
 
456
                   for path, properties in mandos_clients.items()}
371
457
    else:
372
458
        for name in options.client:
373
459
            for path, client in mandos_clients.items():
376
462
                    clients[client_objc] = client
377
463
                    break
378
464
            else:
379
 
                print("Client not found on server: {!r}"
380
 
                      .format(name), file=sys.stderr)
 
465
                log.critical("Client not found on server: %r", name)
381
466
                sys.exit(1)
382
 
    
 
467
 
383
468
    if not has_actions(options) and clients:
384
 
        if options.verbose:
 
469
        if options.verbose or options.dump_json:
385
470
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
386
 
                        "Created", "Interval", "Host", "Fingerprint",
387
 
                        "CheckerRunning", "LastEnabled",
388
 
                        "ApprovalPending", "ApprovedByDefault",
389
 
                        "LastApprovalRequest", "ApprovalDelay",
390
 
                        "ApprovalDuration", "Checker",
391
 
                        "ExtendedTimeout")
 
471
                        "Created", "Interval", "Host", "KeyID",
 
472
                        "Fingerprint", "CheckerRunning",
 
473
                        "LastEnabled", "ApprovalPending",
 
474
                        "ApprovedByDefault", "LastApprovalRequest",
 
475
                        "ApprovalDelay", "ApprovalDuration",
 
476
                        "Checker", "ExtendedTimeout", "Expires",
 
477
                        "LastCheckerStatus")
392
478
        else:
393
479
            keywords = defaultkeywords
394
 
        
395
 
        print_clients(clients.values(), keywords)
 
480
 
 
481
        if options.dump_json:
 
482
            json.dump({client["Name"]: {key:
 
483
                                        bool(client[key])
 
484
                                        if isinstance(client[key],
 
485
                                                      dbus.Boolean)
 
486
                                        else client[key]
 
487
                                        for key in keywords}
 
488
                       for client in clients.values()},
 
489
                      fp=sys.stdout, indent=4,
 
490
                      separators=(',', ': '))
 
491
            print()
 
492
        else:
 
493
            print_clients(clients.values(), keywords)
396
494
    else:
397
495
        # Process each client in the list by all selected options
398
496
        for client in clients:
399
 
            
 
497
 
400
498
            def set_client_prop(prop, value):
401
499
                """Set a Client D-Bus property"""
402
500
                client.Set(client_interface, prop, value,
403
501
                           dbus_interface=dbus.PROPERTIES_IFACE)
404
 
            
 
502
 
405
503
            def set_client_prop_ms(prop, value):
406
504
                """Set a Client D-Bus property, converted
407
505
                from a string to milliseconds."""
408
506
                set_client_prop(prop,
409
507
                                string_to_delta(value).total_seconds()
410
508
                                * 1000)
411
 
            
 
509
 
412
510
            if options.remove:
413
511
                mandos_serv.RemoveClient(client.__dbus_object_path__)
414
512
            if options.enable:
422
520
            if options.stop_checker:
423
521
                set_client_prop("CheckerRunning", dbus.Boolean(False))
424
522
            if options.is_enabled:
425
 
                sys.exit(0 if client.Get(client_interface,
426
 
                                         "Enabled",
427
 
                                         dbus_interface=
428
 
                                         dbus.PROPERTIES_IFACE)
429
 
                         else 1)
 
523
                if client.Get(client_interface, "Enabled",
 
524
                              dbus_interface=dbus.PROPERTIES_IFACE):
 
525
                    sys.exit(0)
 
526
                else:
 
527
                    sys.exit(1)
430
528
            if options.checker is not None:
431
529
                set_client_prop("Checker", options.checker)
432
530
            if options.host is not None:
458
556
                client.Approve(dbus.Boolean(False),
459
557
                               dbus_interface=client_interface)
460
558
 
 
559
 
 
560
class Test_milliseconds_to_string(unittest.TestCase):
 
561
    def test_all(self):
 
562
        self.assertEqual(milliseconds_to_string(93785000),
 
563
                         "1T02:03:05")
 
564
    def test_no_days(self):
 
565
        self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
 
566
    def test_all_zero(self):
 
567
        self.assertEqual(milliseconds_to_string(0), "00:00:00")
 
568
    def test_no_fractional_seconds(self):
 
569
        self.assertEqual(milliseconds_to_string(400), "00:00:00")
 
570
        self.assertEqual(milliseconds_to_string(900), "00:00:00")
 
571
        self.assertEqual(milliseconds_to_string(1900), "00:00:01")
 
572
 
 
573
class Test_string_to_delta(unittest.TestCase):
 
574
    def test_handles_basic_rfc3339(self):
 
575
        self.assertEqual(string_to_delta("PT2H"),
 
576
                         datetime.timedelta(0, 7200))
 
577
    def test_falls_back_to_pre_1_6_1_with_warning(self):
 
578
        # assertLogs only exists in Python 3.4
 
579
        if hasattr(self, "assertLogs"):
 
580
            with self.assertLogs(log, logging.WARNING):
 
581
                value = string_to_delta("2h")
 
582
        else:
 
583
            value = string_to_delta("2h")
 
584
        self.assertEqual(value, datetime.timedelta(0, 7200))
 
585
 
 
586
class Test_TableOfClients(unittest.TestCase):
 
587
    def setUp(self):
 
588
        self.tablewords = {
 
589
            "Attr1": "X",
 
590
            "AttrTwo": "Yy",
 
591
            "AttrThree": "Zzz",
 
592
            "Bool": "A D-BUS Boolean",
 
593
            "NonDbusBoolean": "A Non-D-BUS Boolean",
 
594
            "Integer": "An Integer",
 
595
            "Timeout": "Timedelta 1",
 
596
            "Interval": "Timedelta 2",
 
597
            "ApprovalDelay": "Timedelta 3",
 
598
            "ApprovalDuration": "Timedelta 4",
 
599
            "ExtendedTimeout": "Timedelta 5",
 
600
            "String": "A String",
 
601
        }
 
602
        self.keywords = ["Attr1", "AttrTwo"]
 
603
        self.clients = [
 
604
            {
 
605
                "Attr1": "x1",
 
606
                "AttrTwo": "y1",
 
607
                "AttrThree": "z1",
 
608
                "Bool": dbus.Boolean(False),
 
609
                "NonDbusBoolean": False,
 
610
                "Integer": 0,
 
611
                "Timeout": 0,
 
612
                "Interval": 1000,
 
613
                "ApprovalDelay": 2000,
 
614
                "ApprovalDuration": 3000,
 
615
                "ExtendedTimeout": 4000,
 
616
                "String": "",
 
617
            },
 
618
            {
 
619
                "Attr1": "x2",
 
620
                "AttrTwo": "y2",
 
621
                "AttrThree": "z2",
 
622
                "Bool": dbus.Boolean(True),
 
623
                "NonDbusBoolean": True,
 
624
                "Integer": 1,
 
625
                "Timeout": 93785000,
 
626
                "Interval": 93786000,
 
627
                "ApprovalDelay": 93787000,
 
628
                "ApprovalDuration": 93788000,
 
629
                "ExtendedTimeout": 93789000,
 
630
                "String": "A huge string which will not fit," * 10,
 
631
            },
 
632
        ]
 
633
    def test_short_header(self):
 
634
        rows = TableOfClients(self.clients, self.keywords,
 
635
                              self.tablewords).rows()
 
636
        expected_rows = [
 
637
            "X  Yy",
 
638
            "x1 y1",
 
639
            "x2 y2"]
 
640
        self.assertEqual(rows, expected_rows)
 
641
    def test_booleans(self):
 
642
        keywords = ["Bool", "NonDbusBoolean"]
 
643
        rows = TableOfClients(self.clients, keywords,
 
644
                              self.tablewords).rows()
 
645
        expected_rows = [
 
646
            "A D-BUS Boolean A Non-D-BUS Boolean",
 
647
            "No              False              ",
 
648
            "Yes             True               ",
 
649
        ]
 
650
        self.assertEqual(rows, expected_rows)
 
651
    def test_milliseconds_detection(self):
 
652
        keywords = ["Integer", "Timeout", "Interval", "ApprovalDelay",
 
653
                    "ApprovalDuration", "ExtendedTimeout"]
 
654
        rows = TableOfClients(self.clients, keywords,
 
655
                              self.tablewords).rows()
 
656
        expected_rows = ("""
 
657
An Integer Timedelta 1 Timedelta 2 Timedelta 3 Timedelta 4 Timedelta 5
 
658
0          00:00:00    00:00:01    00:00:02    00:00:03    00:00:04   
 
659
1          1T02:03:05  1T02:03:06  1T02:03:07  1T02:03:08  1T02:03:09 
 
660
"""
 
661
        ).splitlines()[1:]
 
662
        self.assertEqual(rows, expected_rows)
 
663
    def test_empty_and_long_string_values(self):
 
664
        keywords = ["String"]
 
665
        rows = TableOfClients(self.clients, keywords,
 
666
                              self.tablewords).rows()
 
667
        expected_rows = ("""
 
668
A String                                                                                                                                                                                                                                                                                                                                  
 
669
                                                                                                                                                                                                                                                                                                                                          
 
670
A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,
 
671
"""
 
672
        ).splitlines()[1:]
 
673
        self.assertEqual(rows, expected_rows)
 
674
 
 
675
 
 
676
 
 
677
def should_only_run_tests():
 
678
    parser = argparse.ArgumentParser(add_help=False)
 
679
    parser.add_argument("--check", action='store_true')
 
680
    args, unknown_args = parser.parse_known_args()
 
681
    run_tests = args.check
 
682
    if run_tests:
 
683
        # Remove --check argument from sys.argv
 
684
        sys.argv[1:] = unknown_args
 
685
    return run_tests
 
686
 
 
687
# Add all tests from doctest strings
 
688
def load_tests(loader, tests, none):
 
689
    import doctest
 
690
    tests.addTests(doctest.DocTestSuite())
 
691
    return tests
461
692
 
462
693
if __name__ == "__main__":
463
 
    main()
 
694
    if should_only_run_tests():
 
695
        # Call using ./tdd-python-script --check [--verbose]
 
696
        unittest.main()
 
697
    else:
 
698
        main()