/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: 2019-03-02 01:40:17 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 382.
  • Revision ID: teddy@recompile.se-20190302014017-w6c8qytzlroqej24
mandos-ctl: Refactor

* mandos-ctl (table_rows_of_clients): Refactor into TableOfClients
                                      class.  All callers changed.
  (class TableOfClients): New.

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-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
 
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
 
57
71
    "Interval": "Interval",
58
72
    "Host": "Host",
59
73
    "Fingerprint": "Fingerprint",
 
74
    "KeyID": "Key ID",
60
75
    "CheckerRunning": "Check Is Running",
61
76
    "LastEnabled": "Last Enabled",
62
77
    "ApprovalPending": "Approval Is Pending",
64
79
    "ApprovalDelay": "Approval Delay",
65
80
    "ApprovalDuration": "Approval Duration",
66
81
    "Checker": "Checker",
67
 
    "ExtendedTimeout" : "Extended Timeout"
68
 
    }
 
82
    "ExtendedTimeout": "Extended Timeout",
 
83
    "Expires": "Expires",
 
84
    "LastCheckerStatus": "Last Checker Status",
 
85
}
69
86
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
70
87
domain = "se.recompile"
71
88
busname = domain + ".Mandos"
72
89
server_path = "/"
73
90
server_interface = domain + ".Mandos"
74
91
client_interface = domain + ".Mandos.Client"
75
 
version = "1.6.9"
 
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
 
76
100
 
77
101
def milliseconds_to_string(ms):
78
102
    td = datetime.timedelta(0, 0, 0, ms)
79
103
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
80
 
            .format(days = "{}T".format(td.days) if td.days else "",
81
 
                    hours = td.seconds // 3600,
82
 
                    minutes = (td.seconds % 3600) // 60,
83
 
                    seconds = td.seconds % 60,
84
 
                    ))
 
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))
85
108
 
86
109
 
87
110
def rfc3339_duration_to_delta(duration):
88
111
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
89
 
    
 
112
 
90
113
    >>> rfc3339_duration_to_delta("P7D")
91
114
    datetime.timedelta(7)
92
115
    >>> rfc3339_duration_to_delta("PT60S")
93
116
    datetime.timedelta(0, 60)
94
117
    >>> rfc3339_duration_to_delta("PT60M")
95
118
    datetime.timedelta(0, 3600)
 
119
    >>> rfc3339_duration_to_delta("P60M")
 
120
    datetime.timedelta(1680)
96
121
    >>> rfc3339_duration_to_delta("PT24H")
97
122
    datetime.timedelta(1)
98
123
    >>> rfc3339_duration_to_delta("P1W")
101
126
    datetime.timedelta(0, 330)
102
127
    >>> rfc3339_duration_to_delta("P1DT3M20S")
103
128
    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'
104
158
    """
105
 
    
 
159
 
106
160
    # Parsing an RFC 3339 duration with regular expressions is not
107
161
    # possible - there would have to be multiple places for the same
108
162
    # values, like seconds.  The current code, while more esoteric, is
109
163
    # cleaner without depending on a parsing library.  If Python had a
110
164
    # built-in library for parsing we would use it, but we'd like to
111
165
    # avoid excessive use of external libraries.
112
 
    
 
166
 
113
167
    # 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
 
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
123
173
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
124
174
    # the "duration" ABNF definition in RFC 3339, Appendix A.
125
175
    token_end = Token(re.compile(r"$"), None, frozenset())
126
176
    token_second = Token(re.compile(r"(\d+)S"),
127
177
                         datetime.timedelta(seconds=1),
128
 
                         frozenset((token_end,)))
 
178
                         frozenset((token_end, )))
129
179
    token_minute = Token(re.compile(r"(\d+)M"),
130
180
                         datetime.timedelta(minutes=1),
131
181
                         frozenset((token_second, token_end)))
147
197
                       frozenset((token_month, token_end)))
148
198
    token_week = Token(re.compile(r"(\d+)W"),
149
199
                       datetime.timedelta(weeks=1),
150
 
                       frozenset((token_end,)))
 
200
                       frozenset((token_end, )))
151
201
    token_duration = Token(re.compile(r"P"), None,
152
202
                           frozenset((token_year, token_month,
153
203
                                      token_day, token_time,
154
204
                                      token_week)))
155
 
    # Define starting values
156
 
    value = datetime.timedelta() # Value so far
 
205
    # Define starting values:
 
206
    # Value so far
 
207
    value = datetime.timedelta()
157
208
    found_token = None
158
 
    followers = frozenset((token_duration,)) # Following valid tokens
159
 
    s = duration                # String left to parse
 
209
    # Following valid tokens
 
210
    followers = frozenset((token_duration, ))
 
211
    # String left to parse
 
212
    s = duration
160
213
    # Loop until end token is found
161
214
    while found_token is not token_end:
162
215
        # Search for any currently valid tokens
178
231
                break
179
232
        else:
180
233
            # No currently valid tokens were found
181
 
            raise ValueError("Invalid RFC 3339 duration")
 
234
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
235
                             .format(duration))
182
236
    # End token found
183
237
    return value
184
238
 
185
239
 
186
240
def string_to_delta(interval):
187
241
    """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
242
    """
202
 
    
 
243
 
203
244
    try:
204
245
        return rfc3339_duration_to_delta(interval)
205
 
    except ValueError:
206
 
        pass
207
 
    
 
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
 
208
275
    value = datetime.timedelta(0)
209
276
    regexp = re.compile(r"(\d+)([dsmhw]?)")
210
 
    
 
277
 
211
278
    for num, suffix in regexp.findall(interval):
212
279
        if suffix == "d":
213
280
            value += datetime.timedelta(int(num))
223
290
            value += datetime.timedelta(0, 0, 0, int(num))
224
291
    return value
225
292
 
 
293
 
226
294
def print_clients(clients, keywords):
 
295
    print('\n'.join(TableOfClients(clients, keywords).rows()))
 
296
 
 
297
class TableOfClients(object):
 
298
    def __init__(self, clients, keywords):
 
299
        self.clients = clients
 
300
        self.keywords = keywords
 
301
 
 
302
    @staticmethod
227
303
    def valuetostring(value, keyword):
228
 
        if type(value) is dbus.Boolean:
 
304
        if isinstance(value, dbus.Boolean):
229
305
            return "Yes" if value else "No"
230
306
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
231
307
                       "ApprovalDuration", "ExtendedTimeout"):
232
308
            return milliseconds_to_string(value)
233
309
        return str(value)
234
 
    
235
 
    # Create format string to print table rows
236
 
    format_string = " ".join("{{{key}:{width}}}".format(
237
 
            width = max(len(tablewords[key]),
238
 
                        max(len(valuetostring(client[key],
239
 
                                              key))
240
 
                            for client in
241
 
                            clients)),
242
 
            key = key) for key in keywords)
243
 
    # Print header line
244
 
    print(format_string.format(**tablewords))
245
 
    for client in clients:
246
 
        print(format_string.format(**{ key:
247
 
                                           valuetostring(client[key],
248
 
                                                         key)
249
 
                                       for key in keywords }))
 
310
 
 
311
    def rows(self):
 
312
        # Create format string to format table rows
 
313
        format_string = " ".join("{{{key}:{width}}}".format(
 
314
            width=max(len(tablewords[key]),
 
315
                      max(len(self.valuetostring(client[key], key))
 
316
                          for client in self.clients)),
 
317
            key=key)
 
318
                                 for key in self.keywords)
 
319
        # Start with header line
 
320
        rows = [format_string.format(**tablewords)]
 
321
        for client in self.clients:
 
322
            rows.append(format_string
 
323
                        .format(**{key: self.valuetostring(client[key], key)
 
324
                                   for key in self.keywords}))
 
325
        return rows
 
326
 
250
327
 
251
328
def has_actions(options):
252
329
    return any((options.enable,
268
345
                options.approve,
269
346
                options.deny))
270
347
 
 
348
 
271
349
def main():
272
350
    parser = argparse.ArgumentParser()
273
351
    parser.add_argument("--version", action="version",
274
 
                        version = "%(prog)s {}".format(version),
 
352
                        version="%(prog)s {}".format(version),
275
353
                        help="show version number and exit")
276
354
    parser.add_argument("-a", "--all", action="store_true",
277
355
                        help="Select all clients")
278
356
    parser.add_argument("-v", "--verbose", action="store_true",
279
357
                        help="Print all fields")
 
358
    parser.add_argument("-j", "--dump-json", action="store_true",
 
359
                        help="Dump client data in JSON format")
280
360
    parser.add_argument("-e", "--enable", action="store_true",
281
361
                        help="Enable client")
282
362
    parser.add_argument("-d", "--disable", action="store_true",
321
401
                        help="Run self-test")
322
402
    parser.add_argument("client", nargs="*", help="Client name")
323
403
    options = parser.parse_args()
324
 
    
 
404
 
325
405
    if has_actions(options) and not (options.client or options.all):
326
406
        parser.error("Options require clients names or --all.")
327
407
    if options.verbose and has_actions(options):
328
 
        parser.error("--verbose can only be used alone or with"
329
 
                     " --all.")
 
408
        parser.error("--verbose can only be used alone.")
 
409
    if options.dump_json and (options.verbose
 
410
                              or has_actions(options)):
 
411
        parser.error("--dump-json can only be used alone.")
330
412
    if options.all and not has_actions(options):
331
413
        parser.error("--all requires an action.")
332
414
 
333
 
    if options.check:
334
 
        fail_count, test_count = doctest.testmod()
335
 
        sys.exit(os.EX_OK if fail_count == 0 else 1)
336
 
    
337
415
    try:
338
416
        bus = dbus.SystemBus()
339
417
        mandos_dbus_objc = bus.get_object(busname, server_path)
340
418
    except dbus.exceptions.DBusException:
341
 
        print("Could not connect to Mandos server",
342
 
              file=sys.stderr)
 
419
        log.critical("Could not connect to Mandos server")
343
420
        sys.exit(1)
344
 
    
 
421
 
345
422
    mandos_serv = dbus.Interface(mandos_dbus_objc,
346
 
                                 dbus_interface = server_interface)
347
 
    
348
 
    #block stderr since dbus library prints to stderr
 
423
                                 dbus_interface=server_interface)
 
424
    mandos_serv_object_manager = dbus.Interface(
 
425
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
 
426
 
 
427
    # block stderr since dbus library prints to stderr
349
428
    null = os.open(os.path.devnull, os.O_RDWR)
350
429
    stderrcopy = os.dup(sys.stderr.fileno())
351
430
    os.dup2(null, sys.stderr.fileno())
352
431
    os.close(null)
353
432
    try:
354
433
        try:
355
 
            mandos_clients = mandos_serv.GetAllClientsWithProperties()
 
434
            mandos_clients = {path: ifs_and_props[client_interface]
 
435
                              for path, ifs_and_props in
 
436
                              mandos_serv_object_manager
 
437
                              .GetManagedObjects().items()
 
438
                              if client_interface in ifs_and_props}
356
439
        finally:
357
 
            #restore stderr
 
440
            # restore stderr
358
441
            os.dup2(stderrcopy, sys.stderr.fileno())
359
442
            os.close(stderrcopy)
360
 
    except dbus.exceptions.DBusException:
361
 
        print("Access denied: Accessing mandos server through dbus.",
362
 
              file=sys.stderr)
 
443
    except dbus.exceptions.DBusException as e:
 
444
        log.critical("Failed to access Mandos server through D-Bus:"
 
445
                     "\n%s", e)
363
446
        sys.exit(1)
364
 
    
 
447
 
365
448
    # Compile dict of (clients: properties) to process
366
 
    clients={}
367
 
    
 
449
    clients = {}
 
450
 
368
451
    if options.all or not options.client:
369
 
        clients = { bus.get_object(busname, path): properties
370
 
                    for path, properties in mandos_clients.items() }
 
452
        clients = {bus.get_object(busname, path): properties
 
453
                   for path, properties in mandos_clients.items()}
371
454
    else:
372
455
        for name in options.client:
373
456
            for path, client in mandos_clients.items():
376
459
                    clients[client_objc] = client
377
460
                    break
378
461
            else:
379
 
                print("Client not found on server: {!r}"
380
 
                      .format(name), file=sys.stderr)
 
462
                log.critical("Client not found on server: %r", name)
381
463
                sys.exit(1)
382
 
    
 
464
 
383
465
    if not has_actions(options) and clients:
384
 
        if options.verbose:
385
 
            keywords = ("Name", "Enabled", "Timeout",
386
 
                        "LastCheckedOK", "Created", "Interval",
387
 
                        "Host", "Fingerprint", "CheckerRunning",
 
466
        if options.verbose or options.dump_json:
 
467
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
 
468
                        "Created", "Interval", "Host", "KeyID",
 
469
                        "Fingerprint", "CheckerRunning",
388
470
                        "LastEnabled", "ApprovalPending",
389
 
                        "ApprovedByDefault",
390
 
                        "LastApprovalRequest", "ApprovalDelay",
391
 
                        "ApprovalDuration", "Checker",
392
 
                        "ExtendedTimeout")
 
471
                        "ApprovedByDefault", "LastApprovalRequest",
 
472
                        "ApprovalDelay", "ApprovalDuration",
 
473
                        "Checker", "ExtendedTimeout", "Expires",
 
474
                        "LastCheckerStatus")
393
475
        else:
394
476
            keywords = defaultkeywords
395
 
        
396
 
        print_clients(clients.values(), keywords)
 
477
 
 
478
        if options.dump_json:
 
479
            json.dump({client["Name"]: {key:
 
480
                                        bool(client[key])
 
481
                                        if isinstance(client[key],
 
482
                                                      dbus.Boolean)
 
483
                                        else client[key]
 
484
                                        for key in keywords}
 
485
                       for client in clients.values()},
 
486
                      fp=sys.stdout, indent=4,
 
487
                      separators=(',', ': '))
 
488
            print()
 
489
        else:
 
490
            print_clients(clients.values(), keywords)
397
491
    else:
398
492
        # Process each client in the list by all selected options
399
493
        for client in clients:
 
494
 
400
495
            def set_client_prop(prop, value):
401
496
                """Set a Client D-Bus property"""
402
497
                client.Set(client_interface, prop, value,
403
498
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
499
 
404
500
            def set_client_prop_ms(prop, value):
405
501
                """Set a Client D-Bus property, converted
406
502
                from a string to milliseconds."""
407
503
                set_client_prop(prop,
408
504
                                string_to_delta(value).total_seconds()
409
505
                                * 1000)
 
506
 
410
507
            if options.remove:
411
508
                mandos_serv.RemoveClient(client.__dbus_object_path__)
412
509
            if options.enable:
420
517
            if options.stop_checker:
421
518
                set_client_prop("CheckerRunning", dbus.Boolean(False))
422
519
            if options.is_enabled:
423
 
                sys.exit(0 if client.Get(client_interface,
424
 
                                         "Enabled",
425
 
                                         dbus_interface=
426
 
                                         dbus.PROPERTIES_IFACE)
427
 
                         else 1)
 
520
                if client.Get(client_interface, "Enabled",
 
521
                              dbus_interface=dbus.PROPERTIES_IFACE):
 
522
                    sys.exit(0)
 
523
                else:
 
524
                    sys.exit(1)
428
525
            if options.checker is not None:
429
526
                set_client_prop("Checker", options.checker)
430
527
            if options.host is not None:
456
553
                client.Approve(dbus.Boolean(False),
457
554
                               dbus_interface=client_interface)
458
555
 
 
556
 
 
557
class Test_milliseconds_to_string(unittest.TestCase):
 
558
    def test_all(self):
 
559
        self.assertEqual(milliseconds_to_string(93785000),
 
560
                         "1T02:03:05")
 
561
    def test_no_days(self):
 
562
        self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
 
563
    def test_all_zero(self):
 
564
        self.assertEqual(milliseconds_to_string(0), "00:00:00")
 
565
    def test_no_fractional_seconds(self):
 
566
        self.assertEqual(milliseconds_to_string(400), "00:00:00")
 
567
        self.assertEqual(milliseconds_to_string(900), "00:00:00")
 
568
        self.assertEqual(milliseconds_to_string(1900), "00:00:01")
 
569
 
 
570
class Test_string_to_delta(unittest.TestCase):
 
571
    def test_handles_basic_rfc3339(self):
 
572
        self.assertEqual(string_to_delta("PT2H"),
 
573
                         datetime.timedelta(0, 7200))
 
574
    def test_falls_back_to_pre_1_6_1_with_warning(self):
 
575
        # assertLogs only exists in Python 3.4
 
576
        if hasattr(self, "assertLogs"):
 
577
            with self.assertLogs(log, logging.WARNING):
 
578
                value = string_to_delta("2h")
 
579
        else:
 
580
            value = string_to_delta("2h")
 
581
        self.assertEqual(value, datetime.timedelta(0, 7200))
 
582
 
 
583
class Test_TableOfClients(unittest.TestCase):
 
584
    def setUp(self):
 
585
        global tablewords
 
586
        self.old_tablewords = tablewords
 
587
        tablewords = {
 
588
            "Attr1": "X",
 
589
            "AttrTwo": "Yy",
 
590
            "AttrThree": "Zzz",
 
591
            "Bool": "A D-BUS Boolean",
 
592
            "NonDbusBoolean": "A Non-D-BUS Boolean",
 
593
            "Integer": "An Integer",
 
594
            "Timeout": "Timedelta 1",
 
595
            "Interval": "Timedelta 2",
 
596
            "ApprovalDelay": "Timedelta 3",
 
597
            "ApprovalDuration": "Timedelta 4",
 
598
            "ExtendedTimeout": "Timedelta 5",
 
599
            "String": "A String",
 
600
        }
 
601
        self.keywords = ["Attr1", "AttrTwo"]
 
602
        self.clients = [
 
603
            {
 
604
                "Attr1": "x1",
 
605
                "AttrTwo": "y1",
 
606
                "AttrThree": "z1",
 
607
                "Bool": dbus.Boolean(False),
 
608
                "NonDbusBoolean": False,
 
609
                "Integer": 0,
 
610
                "Timeout": 0,
 
611
                "Interval": 1000,
 
612
                "ApprovalDelay": 2000,
 
613
                "ApprovalDuration": 3000,
 
614
                "ExtendedTimeout": 4000,
 
615
                "String": "",
 
616
            },
 
617
            {
 
618
                "Attr1": "x2",
 
619
                "AttrTwo": "y2",
 
620
                "AttrThree": "z2",
 
621
                "Bool": dbus.Boolean(True),
 
622
                "NonDbusBoolean": True,
 
623
                "Integer": 1,
 
624
                "Timeout": 93785000,
 
625
                "Interval": 93786000,
 
626
                "ApprovalDelay": 93787000,
 
627
                "ApprovalDuration": 93788000,
 
628
                "ExtendedTimeout": 93789000,
 
629
                "String": "A huge string which will not fit," * 10,
 
630
            },
 
631
        ]
 
632
    def tearDown(self):
 
633
        global tablewords
 
634
        tablewords = self.old_tablewords
 
635
    def test_short_header(self):
 
636
        rows = TableOfClients(self.clients, self.keywords).rows()
 
637
        expected_rows = [
 
638
            "X  Yy",
 
639
            "x1 y1",
 
640
            "x2 y2"]
 
641
        self.assertEqual(rows, expected_rows)
 
642
    def test_booleans(self):
 
643
        keywords = ["Bool", "NonDbusBoolean"]
 
644
        rows = TableOfClients(self.clients, keywords).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).rows()
 
655
        expected_rows = ("""
 
656
An Integer Timedelta 1 Timedelta 2 Timedelta 3 Timedelta 4 Timedelta 5
 
657
0          00:00:00    00:00:01    00:00:02    00:00:03    00:00:04   
 
658
1          1T02:03:05  1T02:03:06  1T02:03:07  1T02:03:08  1T02:03:09 
 
659
"""
 
660
        ).splitlines()[1:]
 
661
        self.assertEqual(rows, expected_rows)
 
662
    def test_empty_and_long_string_values(self):
 
663
        keywords = ["String"]
 
664
        rows = TableOfClients(self.clients, keywords).rows()
 
665
        expected_rows = ("""
 
666
A String                                                                                                                                                                                                                                                                                                                                  
 
667
                                                                                                                                                                                                                                                                                                                                          
 
668
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,
 
669
"""
 
670
        ).splitlines()[1:]
 
671
        self.assertEqual(rows, expected_rows)
 
672
 
 
673
 
 
674
 
 
675
def should_only_run_tests():
 
676
    parser = argparse.ArgumentParser(add_help=False)
 
677
    parser.add_argument("--check", action='store_true')
 
678
    args, unknown_args = parser.parse_known_args()
 
679
    run_tests = args.check
 
680
    if run_tests:
 
681
        # Remove --check argument from sys.argv
 
682
        sys.argv[1:] = unknown_args
 
683
    return run_tests
 
684
 
 
685
# Add all tests from doctest strings
 
686
def load_tests(loader, tests, none):
 
687
    import doctest
 
688
    tests.addTests(doctest.DocTestSuite())
 
689
    return tests
 
690
 
459
691
if __name__ == "__main__":
460
 
    main()
 
692
    if should_only_run_tests():
 
693
        # Call using ./tdd-python-script --check [--verbose]
 
694
        unittest.main()
 
695
    else:
 
696
        main()