/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 02:33:00 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 382.
  • Revision ID: teddy@recompile.se-20190302023300-cgss6bf71mwfb0ma
mandos-ctl: Refactor

* mandos-ctl (TableOfClients.__str__): New.
  (TableOfClients.__unicode__): New.
  (print_clients): Remove.
  (main): Create and print TableOfClients object directly.

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