/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos-ctl

  • Committer: Teddy Hogeborn
  • Date: 2019-03-02 02:17:17 UTC
  • Revision ID: teddy@recompile.se-20190302021717-kzk7xwjtef3syau6
mandos-ctl: Refactor

* mandos-ctl (TableOfClients.rows): Extract methods.
  (TableOfClients.row_formatting_string): New.
  (TableOfClients.string_from_client): New.
  (TableOfClients.header_line): New.
  (TableOfClients.client_line): 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-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))
227
270
 
228
271
 
229
272
def print_clients(clients, keywords):
 
273
    print('\n'.join(TableOfClients(clients, keywords).rows()))
 
274
 
 
275
class TableOfClients(object):
 
276
    tablewords = {
 
277
        "Name": "Name",
 
278
        "Enabled": "Enabled",
 
279
        "Timeout": "Timeout",
 
280
        "LastCheckedOK": "Last Successful Check",
 
281
        "LastApprovalRequest": "Last Approval Request",
 
282
        "Created": "Created",
 
283
        "Interval": "Interval",
 
284
        "Host": "Host",
 
285
        "Fingerprint": "Fingerprint",
 
286
        "KeyID": "Key ID",
 
287
        "CheckerRunning": "Check Is Running",
 
288
        "LastEnabled": "Last Enabled",
 
289
        "ApprovalPending": "Approval Is Pending",
 
290
        "ApprovedByDefault": "Approved By Default",
 
291
        "ApprovalDelay": "Approval Delay",
 
292
        "ApprovalDuration": "Approval Duration",
 
293
        "Checker": "Checker",
 
294
        "ExtendedTimeout": "Extended Timeout",
 
295
        "Expires": "Expires",
 
296
        "LastCheckerStatus": "Last Checker Status",
 
297
    }
 
298
 
 
299
    def __init__(self, clients, keywords, tablewords=None):
 
300
        self.clients = clients
 
301
        self.keywords = keywords
 
302
        if tablewords is not None:
 
303
            self.tablewords = tablewords
 
304
 
 
305
    def rows(self):
 
306
        format_string = self.row_formatting_string()
 
307
        rows = [self.header_line(format_string)]
 
308
        rows.extend(self.client_line(client, format_string)
 
309
                    for client in self.clients)
 
310
        return rows
 
311
 
 
312
    def row_formatting_string(self):
 
313
        "Format string used to format table rows"
 
314
        return " ".join("{{{key}:{width}}}".format(
 
315
            width=max(len(self.tablewords[key]),
 
316
                      max(len(self.string_from_client(client, key))
 
317
                          for client in self.clients)),
 
318
            key=key)
 
319
                                 for key in self.keywords)
 
320
 
 
321
    def string_from_client(self, client, key):
 
322
        return self.valuetostring(client[key], key)
 
323
 
 
324
    @staticmethod
230
325
    def valuetostring(value, keyword):
231
 
        if type(value) is dbus.Boolean:
 
326
        if isinstance(value, dbus.Boolean):
232
327
            return "Yes" if value else "No"
233
328
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
234
329
                       "ApprovalDuration", "ExtendedTimeout"):
235
330
            return milliseconds_to_string(value)
236
331
        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 }))
 
332
 
 
333
    def header_line(self, format_string):
 
334
        return format_string.format(**self.tablewords)
 
335
 
 
336
    def client_line(self, client, format_string):
 
337
        return format_string.format(
 
338
            **{key: self.string_from_client(client, key)
 
339
               for key in self.keywords})
251
340
 
252
341
 
253
342
def has_actions(options):
274
363
def main():
275
364
    parser = argparse.ArgumentParser()
276
365
    parser.add_argument("--version", action="version",
277
 
                        version = "%(prog)s {}".format(version),
 
366
                        version="%(prog)s {}".format(version),
278
367
                        help="show version number and exit")
279
368
    parser.add_argument("-a", "--all", action="store_true",
280
369
                        help="Select all clients")
281
370
    parser.add_argument("-v", "--verbose", action="store_true",
282
371
                        help="Print all fields")
 
372
    parser.add_argument("-j", "--dump-json", action="store_true",
 
373
                        help="Dump client data in JSON format")
283
374
    parser.add_argument("-e", "--enable", action="store_true",
284
375
                        help="Enable client")
285
376
    parser.add_argument("-d", "--disable", action="store_true",
324
415
                        help="Run self-test")
325
416
    parser.add_argument("client", nargs="*", help="Client name")
326
417
    options = parser.parse_args()
327
 
    
 
418
 
328
419
    if has_actions(options) and not (options.client or options.all):
329
420
        parser.error("Options require clients names or --all.")
330
421
    if options.verbose and has_actions(options):
331
 
        parser.error("--verbose can only be used alone or with"
332
 
                     " --all.")
 
422
        parser.error("--verbose can only be used alone.")
 
423
    if options.dump_json and (options.verbose
 
424
                              or has_actions(options)):
 
425
        parser.error("--dump-json can only be used alone.")
333
426
    if options.all and not has_actions(options):
334
427
        parser.error("--all requires an action.")
335
428
 
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
429
    try:
341
430
        bus = dbus.SystemBus()
342
431
        mandos_dbus_objc = bus.get_object(busname, server_path)
343
432
    except dbus.exceptions.DBusException:
344
 
        print("Could not connect to Mandos server", file=sys.stderr)
 
433
        log.critical("Could not connect to Mandos server")
345
434
        sys.exit(1)
346
 
    
 
435
 
347
436
    mandos_serv = dbus.Interface(mandos_dbus_objc,
348
 
                                 dbus_interface = server_interface)
 
437
                                 dbus_interface=server_interface)
349
438
    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
 
439
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
 
440
 
 
441
    # block stderr since dbus library prints to stderr
353
442
    null = os.open(os.path.devnull, os.O_RDWR)
354
443
    stderrcopy = os.dup(sys.stderr.fileno())
355
444
    os.dup2(null, sys.stderr.fileno())
356
445
    os.close(null)
357
446
    try:
358
447
        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 }
 
448
            mandos_clients = {path: ifs_and_props[client_interface]
 
449
                              for path, ifs_and_props in
 
450
                              mandos_serv_object_manager
 
451
                              .GetManagedObjects().items()
 
452
                              if client_interface in ifs_and_props}
364
453
        finally:
365
 
            #restore stderr
 
454
            # restore stderr
366
455
            os.dup2(stderrcopy, sys.stderr.fileno())
367
456
            os.close(stderrcopy)
368
457
    except dbus.exceptions.DBusException as e:
369
 
        print("Access denied: Accessing mandos server through D-Bus: {}"
370
 
              .format(e), file=sys.stderr)
 
458
        log.critical("Failed to access Mandos server through D-Bus:"
 
459
                     "\n%s", e)
371
460
        sys.exit(1)
372
 
    
 
461
 
373
462
    # Compile dict of (clients: properties) to process
374
 
    clients={}
375
 
    
 
463
    clients = {}
 
464
 
376
465
    if options.all or not options.client:
377
 
        clients = { bus.get_object(busname, path): properties
378
 
                    for path, properties in mandos_clients.items() }
 
466
        clients = {bus.get_object(busname, path): properties
 
467
                   for path, properties in mandos_clients.items()}
379
468
    else:
380
469
        for name in options.client:
381
470
            for path, client in mandos_clients.items():
384
473
                    clients[client_objc] = client
385
474
                    break
386
475
            else:
387
 
                print("Client not found on server: {!r}"
388
 
                      .format(name), file=sys.stderr)
 
476
                log.critical("Client not found on server: %r", name)
389
477
                sys.exit(1)
390
 
    
 
478
 
391
479
    if not has_actions(options) and clients:
392
 
        if options.verbose:
 
480
        if options.verbose or options.dump_json:
393
481
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
394
 
                        "Created", "Interval", "Host", "Fingerprint",
395
 
                        "CheckerRunning", "LastEnabled",
396
 
                        "ApprovalPending", "ApprovedByDefault",
397
 
                        "LastApprovalRequest", "ApprovalDelay",
398
 
                        "ApprovalDuration", "Checker",
399
 
                        "ExtendedTimeout")
 
482
                        "Created", "Interval", "Host", "KeyID",
 
483
                        "Fingerprint", "CheckerRunning",
 
484
                        "LastEnabled", "ApprovalPending",
 
485
                        "ApprovedByDefault", "LastApprovalRequest",
 
486
                        "ApprovalDelay", "ApprovalDuration",
 
487
                        "Checker", "ExtendedTimeout", "Expires",
 
488
                        "LastCheckerStatus")
400
489
        else:
401
490
            keywords = defaultkeywords
402
 
        
403
 
        print_clients(clients.values(), keywords)
 
491
 
 
492
        if options.dump_json:
 
493
            json.dump({client["Name"]: {key:
 
494
                                        bool(client[key])
 
495
                                        if isinstance(client[key],
 
496
                                                      dbus.Boolean)
 
497
                                        else client[key]
 
498
                                        for key in keywords}
 
499
                       for client in clients.values()},
 
500
                      fp=sys.stdout, indent=4,
 
501
                      separators=(',', ': '))
 
502
            print()
 
503
        else:
 
504
            print_clients(clients.values(), keywords)
404
505
    else:
405
506
        # Process each client in the list by all selected options
406
507
        for client in clients:
407
 
            
 
508
 
408
509
            def set_client_prop(prop, value):
409
510
                """Set a Client D-Bus property"""
410
511
                client.Set(client_interface, prop, value,
411
512
                           dbus_interface=dbus.PROPERTIES_IFACE)
412
 
            
 
513
 
413
514
            def set_client_prop_ms(prop, value):
414
515
                """Set a Client D-Bus property, converted
415
516
                from a string to milliseconds."""
416
517
                set_client_prop(prop,
417
518
                                string_to_delta(value).total_seconds()
418
519
                                * 1000)
419
 
            
 
520
 
420
521
            if options.remove:
421
522
                mandos_serv.RemoveClient(client.__dbus_object_path__)
422
523
            if options.enable:
430
531
            if options.stop_checker:
431
532
                set_client_prop("CheckerRunning", dbus.Boolean(False))
432
533
            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)
 
534
                if client.Get(client_interface, "Enabled",
 
535
                              dbus_interface=dbus.PROPERTIES_IFACE):
 
536
                    sys.exit(0)
 
537
                else:
 
538
                    sys.exit(1)
438
539
            if options.checker is not None:
439
540
                set_client_prop("Checker", options.checker)
440
541
            if options.host is not None:
466
567
                client.Approve(dbus.Boolean(False),
467
568
                               dbus_interface=client_interface)
468
569
 
 
570
 
 
571
class Test_milliseconds_to_string(unittest.TestCase):
 
572
    def test_all(self):
 
573
        self.assertEqual(milliseconds_to_string(93785000),
 
574
                         "1T02:03:05")
 
575
    def test_no_days(self):
 
576
        self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
 
577
    def test_all_zero(self):
 
578
        self.assertEqual(milliseconds_to_string(0), "00:00:00")
 
579
    def test_no_fractional_seconds(self):
 
580
        self.assertEqual(milliseconds_to_string(400), "00:00:00")
 
581
        self.assertEqual(milliseconds_to_string(900), "00:00:00")
 
582
        self.assertEqual(milliseconds_to_string(1900), "00:00:01")
 
583
 
 
584
class Test_string_to_delta(unittest.TestCase):
 
585
    def test_handles_basic_rfc3339(self):
 
586
        self.assertEqual(string_to_delta("PT2H"),
 
587
                         datetime.timedelta(0, 7200))
 
588
    def test_falls_back_to_pre_1_6_1_with_warning(self):
 
589
        # assertLogs only exists in Python 3.4
 
590
        if hasattr(self, "assertLogs"):
 
591
            with self.assertLogs(log, logging.WARNING):
 
592
                value = string_to_delta("2h")
 
593
        else:
 
594
            value = string_to_delta("2h")
 
595
        self.assertEqual(value, datetime.timedelta(0, 7200))
 
596
 
 
597
class Test_TableOfClients(unittest.TestCase):
 
598
    def setUp(self):
 
599
        self.tablewords = {
 
600
            "Attr1": "X",
 
601
            "AttrTwo": "Yy",
 
602
            "AttrThree": "Zzz",
 
603
            "Bool": "A D-BUS Boolean",
 
604
            "NonDbusBoolean": "A Non-D-BUS Boolean",
 
605
            "Integer": "An Integer",
 
606
            "Timeout": "Timedelta 1",
 
607
            "Interval": "Timedelta 2",
 
608
            "ApprovalDelay": "Timedelta 3",
 
609
            "ApprovalDuration": "Timedelta 4",
 
610
            "ExtendedTimeout": "Timedelta 5",
 
611
            "String": "A String",
 
612
        }
 
613
        self.keywords = ["Attr1", "AttrTwo"]
 
614
        self.clients = [
 
615
            {
 
616
                "Attr1": "x1",
 
617
                "AttrTwo": "y1",
 
618
                "AttrThree": "z1",
 
619
                "Bool": dbus.Boolean(False),
 
620
                "NonDbusBoolean": False,
 
621
                "Integer": 0,
 
622
                "Timeout": 0,
 
623
                "Interval": 1000,
 
624
                "ApprovalDelay": 2000,
 
625
                "ApprovalDuration": 3000,
 
626
                "ExtendedTimeout": 4000,
 
627
                "String": "",
 
628
            },
 
629
            {
 
630
                "Attr1": "x2",
 
631
                "AttrTwo": "y2",
 
632
                "AttrThree": "z2",
 
633
                "Bool": dbus.Boolean(True),
 
634
                "NonDbusBoolean": True,
 
635
                "Integer": 1,
 
636
                "Timeout": 93785000,
 
637
                "Interval": 93786000,
 
638
                "ApprovalDelay": 93787000,
 
639
                "ApprovalDuration": 93788000,
 
640
                "ExtendedTimeout": 93789000,
 
641
                "String": "A huge string which will not fit," * 10,
 
642
            },
 
643
        ]
 
644
    def test_short_header(self):
 
645
        rows = TableOfClients(self.clients, self.keywords,
 
646
                              self.tablewords).rows()
 
647
        expected_rows = [
 
648
            "X  Yy",
 
649
            "x1 y1",
 
650
            "x2 y2"]
 
651
        self.assertEqual(rows, expected_rows)
 
652
    def test_booleans(self):
 
653
        keywords = ["Bool", "NonDbusBoolean"]
 
654
        rows = TableOfClients(self.clients, keywords,
 
655
                              self.tablewords).rows()
 
656
        expected_rows = [
 
657
            "A D-BUS Boolean A Non-D-BUS Boolean",
 
658
            "No              False              ",
 
659
            "Yes             True               ",
 
660
        ]
 
661
        self.assertEqual(rows, expected_rows)
 
662
    def test_milliseconds_detection(self):
 
663
        keywords = ["Integer", "Timeout", "Interval", "ApprovalDelay",
 
664
                    "ApprovalDuration", "ExtendedTimeout"]
 
665
        rows = TableOfClients(self.clients, keywords,
 
666
                              self.tablewords).rows()
 
667
        expected_rows = ("""
 
668
An Integer Timedelta 1 Timedelta 2 Timedelta 3 Timedelta 4 Timedelta 5
 
669
0          00:00:00    00:00:01    00:00:02    00:00:03    00:00:04   
 
670
1          1T02:03:05  1T02:03:06  1T02:03:07  1T02:03:08  1T02:03:09 
 
671
"""
 
672
        ).splitlines()[1:]
 
673
        self.assertEqual(rows, expected_rows)
 
674
    def test_empty_and_long_string_values(self):
 
675
        keywords = ["String"]
 
676
        rows = TableOfClients(self.clients, keywords,
 
677
                              self.tablewords).rows()
 
678
        expected_rows = ("""
 
679
A String                                                                                                                                                                                                                                                                                                                                  
 
680
                                                                                                                                                                                                                                                                                                                                          
 
681
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,
 
682
"""
 
683
        ).splitlines()[1:]
 
684
        self.assertEqual(rows, expected_rows)
 
685
 
 
686
 
 
687
 
 
688
def should_only_run_tests():
 
689
    parser = argparse.ArgumentParser(add_help=False)
 
690
    parser.add_argument("--check", action='store_true')
 
691
    args, unknown_args = parser.parse_known_args()
 
692
    run_tests = args.check
 
693
    if run_tests:
 
694
        # Remove --check argument from sys.argv
 
695
        sys.argv[1:] = unknown_args
 
696
    return run_tests
 
697
 
 
698
# Add all tests from doctest strings
 
699
def load_tests(loader, tests, none):
 
700
    import doctest
 
701
    tests.addTests(doctest.DocTestSuite())
 
702
    return tests
469
703
 
470
704
if __name__ == "__main__":
471
 
    main()
 
705
    if should_only_run_tests():
 
706
        # Call using ./tdd-python-script --check [--verbose]
 
707
        unittest.main()
 
708
    else:
 
709
        main()