/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos-ctl

  • Committer: Teddy Hogeborn
  • Date: 2014-07-25 22:17:55 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 321.
  • Revision ID: teddy@recompile.se-20140725221755-7bak9szduz53wwtq
INSTALL: Add org-mode setting to show all text when opening.

* INSTALL (STARTUP): New org-mode setting; set to "showall".

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