/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: 2016-03-05 21:46:00 UTC
  • Revision ID: teddy@recompile.se-20160305214600-2d7peg8qb5xhpi64
Fix incorrect documentation of minor limitation

* mandos-monitor.xml (BUGS): The name which is hard-coded is the D-Bus
                             *bus* name, not the service name.  Fix
                             the documentation.

Show diffs side-by-side

added added

removed removed

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