/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-23 07:11:22 UTC
  • Revision ID: teddy@recompile.se-20160323071122-55srtjdizr21rr7f
Use HTTPS in home page links

Since we have a real certificate now, change all links to the home
page to use HTTPS.

* README: Use HTTPS in home page links
* debian/control (Source: mandos/Homepage): - '' -
* debian/copyright (Source): - '' -
* intro.xml (SEE ALSO): - '' -
* mandos.lsm (Primary-site): - '' -

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
 
71
57
    "Interval": "Interval",
72
58
    "Host": "Host",
73
59
    "Fingerprint": "Fingerprint",
74
 
    "KeyID": "Key ID",
75
60
    "CheckerRunning": "Check Is Running",
76
61
    "LastEnabled": "Last Enabled",
77
62
    "ApprovalPending": "Approval Is Pending",
79
64
    "ApprovalDelay": "Approval Delay",
80
65
    "ApprovalDuration": "Approval Duration",
81
66
    "Checker": "Checker",
82
 
    "ExtendedTimeout": "Extended Timeout",
83
 
    "Expires": "Expires",
84
 
    "LastCheckerStatus": "Last Checker Status",
 
67
    "ExtendedTimeout": "Extended Timeout"
85
68
}
86
69
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
87
70
domain = "se.recompile"
89
72
server_path = "/"
90
73
server_interface = domain + ".Mandos"
91
74
client_interface = domain + ".Mandos.Client"
92
 
version = "1.8.3"
 
75
version = "1.7.7"
93
76
 
94
77
 
95
78
try:
97
80
except AttributeError:
98
81
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
99
82
 
100
 
 
101
83
def milliseconds_to_string(ms):
102
84
    td = datetime.timedelta(0, 0, 0, ms)
103
 
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
104
 
            .format(days="{}T".format(td.days) if td.days else "",
105
 
                    hours=td.seconds // 3600,
106
 
                    minutes=(td.seconds % 3600) // 60,
107
 
                    seconds=td.seconds % 60))
 
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))
108
90
 
109
91
 
110
92
def rfc3339_duration_to_delta(duration):
111
93
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
112
 
 
 
94
    
113
95
    >>> rfc3339_duration_to_delta("P7D")
114
96
    datetime.timedelta(7)
115
97
    >>> rfc3339_duration_to_delta("PT60S")
116
98
    datetime.timedelta(0, 60)
117
99
    >>> rfc3339_duration_to_delta("PT60M")
118
100
    datetime.timedelta(0, 3600)
119
 
    >>> rfc3339_duration_to_delta("P60M")
120
 
    datetime.timedelta(1680)
121
101
    >>> rfc3339_duration_to_delta("PT24H")
122
102
    datetime.timedelta(1)
123
103
    >>> rfc3339_duration_to_delta("P1W")
126
106
    datetime.timedelta(0, 330)
127
107
    >>> rfc3339_duration_to_delta("P1DT3M20S")
128
108
    datetime.timedelta(1, 200)
129
 
    >>> # Can not be empty:
130
 
    >>> rfc3339_duration_to_delta("")
131
 
    Traceback (most recent call last):
132
 
    ...
133
 
    ValueError: Invalid RFC 3339 duration: u''
134
 
    >>> # Must start with "P":
135
 
    >>> rfc3339_duration_to_delta("1D")
136
 
    Traceback (most recent call last):
137
 
    ...
138
 
    ValueError: Invalid RFC 3339 duration: u'1D'
139
 
    >>> # Must use correct order
140
 
    >>> rfc3339_duration_to_delta("PT1S2M")
141
 
    Traceback (most recent call last):
142
 
    ...
143
 
    ValueError: Invalid RFC 3339 duration: u'PT1S2M'
144
 
    >>> # Time needs time marker
145
 
    >>> rfc3339_duration_to_delta("P1H2S")
146
 
    Traceback (most recent call last):
147
 
    ...
148
 
    ValueError: Invalid RFC 3339 duration: u'P1H2S'
149
 
    >>> # Weeks can not be combined with anything else
150
 
    >>> rfc3339_duration_to_delta("P1D2W")
151
 
    Traceback (most recent call last):
152
 
    ...
153
 
    ValueError: Invalid RFC 3339 duration: u'P1D2W'
154
 
    >>> rfc3339_duration_to_delta("P2W2H")
155
 
    Traceback (most recent call last):
156
 
    ...
157
 
    ValueError: Invalid RFC 3339 duration: u'P2W2H'
158
109
    """
159
 
 
 
110
    
160
111
    # Parsing an RFC 3339 duration with regular expressions is not
161
112
    # possible - there would have to be multiple places for the same
162
113
    # values, like seconds.  The current code, while more esoteric, is
163
114
    # cleaner without depending on a parsing library.  If Python had a
164
115
    # built-in library for parsing we would use it, but we'd like to
165
116
    # avoid excessive use of external libraries.
166
 
 
 
117
    
167
118
    # New type for defining tokens, syntax, and semantics all-in-one
168
119
    Token = collections.namedtuple("Token", (
169
120
        "regexp",  # To match token; if "value" is not None, must have
202
153
                           frozenset((token_year, token_month,
203
154
                                      token_day, token_time,
204
155
                                      token_week)))
205
 
    # Define starting values:
206
 
    # Value so far
207
 
    value = datetime.timedelta()
 
156
    # Define starting values
 
157
    value = datetime.timedelta() # Value so far
208
158
    found_token = None
209
 
    # Following valid tokens
210
 
    followers = frozenset((token_duration, ))
211
 
    # String left to parse
212
 
    s = duration
 
159
    followers = frozenset((token_duration, )) # Following valid tokens
 
160
    s = duration                # String left to parse
213
161
    # Loop until end token is found
214
162
    while found_token is not token_end:
215
163
        # Search for any currently valid tokens
239
187
 
240
188
def string_to_delta(interval):
241
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)
242
203
    """
243
 
 
 
204
    
244
205
    try:
245
206
        return rfc3339_duration_to_delta(interval)
246
 
    except ValueError as e:
247
 
        log.warning("%s - Parsing as pre-1.6.1 interval instead",
248
 
                    ' '.join(e.args))
249
 
    return parse_pre_1_6_1_interval(interval)
250
 
 
251
 
 
252
 
def parse_pre_1_6_1_interval(interval):
253
 
    """Parse an interval string as documented by Mandos before 1.6.1, and
254
 
    return a datetime.timedelta
255
 
    >>> parse_pre_1_6_1_interval('7d')
256
 
    datetime.timedelta(7)
257
 
    >>> parse_pre_1_6_1_interval('60s')
258
 
    datetime.timedelta(0, 60)
259
 
    >>> parse_pre_1_6_1_interval('60m')
260
 
    datetime.timedelta(0, 3600)
261
 
    >>> parse_pre_1_6_1_interval('24h')
262
 
    datetime.timedelta(1)
263
 
    >>> parse_pre_1_6_1_interval('1w')
264
 
    datetime.timedelta(7)
265
 
    >>> parse_pre_1_6_1_interval('5m 30s')
266
 
    datetime.timedelta(0, 330)
267
 
    >>> parse_pre_1_6_1_interval('')
268
 
    datetime.timedelta(0)
269
 
    >>> # Ignore unknown characters, allow any order and repetitions
270
 
    >>> parse_pre_1_6_1_interval('2dxy7zz11y3m5m')
271
 
    datetime.timedelta(2, 480, 18000)
272
 
 
273
 
    """
274
 
 
 
207
    except ValueError:
 
208
        pass
 
209
    
275
210
    value = datetime.timedelta(0)
276
211
    regexp = re.compile(r"(\d+)([dsmhw]?)")
277
 
 
 
212
    
278
213
    for num, suffix in regexp.findall(interval):
279
214
        if suffix == "d":
280
215
            value += datetime.timedelta(int(num))
292
227
 
293
228
 
294
229
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
303
230
    def valuetostring(value, keyword):
304
 
        if isinstance(value, dbus.Boolean):
 
231
        if type(value) is dbus.Boolean:
305
232
            return "Yes" if value else "No"
306
233
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
307
234
                       "ApprovalDuration", "ExtendedTimeout"):
308
235
            return milliseconds_to_string(value)
309
236
        return str(value)
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
 
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 }))
326
251
 
327
252
 
328
253
def has_actions(options):
349
274
def main():
350
275
    parser = argparse.ArgumentParser()
351
276
    parser.add_argument("--version", action="version",
352
 
                        version="%(prog)s {}".format(version),
 
277
                        version = "%(prog)s {}".format(version),
353
278
                        help="show version number and exit")
354
279
    parser.add_argument("-a", "--all", action="store_true",
355
280
                        help="Select all clients")
356
281
    parser.add_argument("-v", "--verbose", action="store_true",
357
282
                        help="Print all fields")
358
 
    parser.add_argument("-j", "--dump-json", action="store_true",
359
 
                        help="Dump client data in JSON format")
360
283
    parser.add_argument("-e", "--enable", action="store_true",
361
284
                        help="Enable client")
362
285
    parser.add_argument("-d", "--disable", action="store_true",
401
324
                        help="Run self-test")
402
325
    parser.add_argument("client", nargs="*", help="Client name")
403
326
    options = parser.parse_args()
404
 
 
 
327
    
405
328
    if has_actions(options) and not (options.client or options.all):
406
329
        parser.error("Options require clients names or --all.")
407
330
    if options.verbose and has_actions(options):
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.")
 
331
        parser.error("--verbose can only be used alone or with"
 
332
                     " --all.")
412
333
    if options.all and not has_actions(options):
413
334
        parser.error("--all requires an action.")
414
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
    
415
340
    try:
416
341
        bus = dbus.SystemBus()
417
342
        mandos_dbus_objc = bus.get_object(busname, server_path)
418
343
    except dbus.exceptions.DBusException:
419
 
        log.critical("Could not connect to Mandos server")
 
344
        print("Could not connect to Mandos server", file=sys.stderr)
420
345
        sys.exit(1)
421
 
 
 
346
    
422
347
    mandos_serv = dbus.Interface(mandos_dbus_objc,
423
 
                                 dbus_interface=server_interface)
 
348
                                 dbus_interface = server_interface)
424
349
    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
 
350
        mandos_dbus_objc, dbus_interface = dbus.OBJECT_MANAGER_IFACE)
 
351
    
 
352
    #block stderr since dbus library prints to stderr
428
353
    null = os.open(os.path.devnull, os.O_RDWR)
429
354
    stderrcopy = os.dup(sys.stderr.fileno())
430
355
    os.dup2(null, sys.stderr.fileno())
431
356
    os.close(null)
432
357
    try:
433
358
        try:
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}
 
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 }
439
364
        finally:
440
 
            # restore stderr
 
365
            #restore stderr
441
366
            os.dup2(stderrcopy, sys.stderr.fileno())
442
367
            os.close(stderrcopy)
443
368
    except dbus.exceptions.DBusException as e:
444
 
        log.critical("Failed to access Mandos server through D-Bus:"
445
 
                     "\n%s", e)
 
369
        print("Access denied: Accessing mandos server through D-Bus: {}"
 
370
              .format(e), file=sys.stderr)
446
371
        sys.exit(1)
447
 
 
 
372
    
448
373
    # Compile dict of (clients: properties) to process
449
 
    clients = {}
450
 
 
 
374
    clients={}
 
375
    
451
376
    if options.all or not options.client:
452
 
        clients = {bus.get_object(busname, path): properties
453
 
                   for path, properties in mandos_clients.items()}
 
377
        clients = { bus.get_object(busname, path): properties
 
378
                    for path, properties in mandos_clients.items() }
454
379
    else:
455
380
        for name in options.client:
456
381
            for path, client in mandos_clients.items():
459
384
                    clients[client_objc] = client
460
385
                    break
461
386
            else:
462
 
                log.critical("Client not found on server: %r", name)
 
387
                print("Client not found on server: {!r}"
 
388
                      .format(name), file=sys.stderr)
463
389
                sys.exit(1)
464
 
 
 
390
    
465
391
    if not has_actions(options) and clients:
466
 
        if options.verbose or options.dump_json:
 
392
        if options.verbose:
467
393
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
468
 
                        "Created", "Interval", "Host", "KeyID",
469
 
                        "Fingerprint", "CheckerRunning",
470
 
                        "LastEnabled", "ApprovalPending",
471
 
                        "ApprovedByDefault", "LastApprovalRequest",
472
 
                        "ApprovalDelay", "ApprovalDuration",
473
 
                        "Checker", "ExtendedTimeout", "Expires",
474
 
                        "LastCheckerStatus")
 
394
                        "Created", "Interval", "Host", "Fingerprint",
 
395
                        "CheckerRunning", "LastEnabled",
 
396
                        "ApprovalPending", "ApprovedByDefault",
 
397
                        "LastApprovalRequest", "ApprovalDelay",
 
398
                        "ApprovalDuration", "Checker",
 
399
                        "ExtendedTimeout")
475
400
        else:
476
401
            keywords = defaultkeywords
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)
 
402
        
 
403
        print_clients(clients.values(), keywords)
491
404
    else:
492
405
        # Process each client in the list by all selected options
493
406
        for client in clients:
494
 
 
 
407
            
495
408
            def set_client_prop(prop, value):
496
409
                """Set a Client D-Bus property"""
497
410
                client.Set(client_interface, prop, value,
498
411
                           dbus_interface=dbus.PROPERTIES_IFACE)
499
 
 
 
412
            
500
413
            def set_client_prop_ms(prop, value):
501
414
                """Set a Client D-Bus property, converted
502
415
                from a string to milliseconds."""
503
416
                set_client_prop(prop,
504
417
                                string_to_delta(value).total_seconds()
505
418
                                * 1000)
506
 
 
 
419
            
507
420
            if options.remove:
508
421
                mandos_serv.RemoveClient(client.__dbus_object_path__)
509
422
            if options.enable:
517
430
            if options.stop_checker:
518
431
                set_client_prop("CheckerRunning", dbus.Boolean(False))
519
432
            if options.is_enabled:
520
 
                if client.Get(client_interface, "Enabled",
521
 
                              dbus_interface=dbus.PROPERTIES_IFACE):
522
 
                    sys.exit(0)
523
 
                else:
524
 
                    sys.exit(1)
 
433
                sys.exit(0 if client.Get(client_interface,
 
434
                                         "Enabled",
 
435
                                         dbus_interface=
 
436
                                         dbus.PROPERTIES_IFACE)
 
437
                         else 1)
525
438
            if options.checker is not None:
526
439
                set_client_prop("Checker", options.checker)
527
440
            if options.host is not None:
553
466
                client.Approve(dbus.Boolean(False),
554
467
                               dbus_interface=client_interface)
555
468
 
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
469
 
691
470
if __name__ == "__main__":
692
 
    if should_only_run_tests():
693
 
        # Call using ./tdd-python-script --check [--verbose]
694
 
        unittest.main()
695
 
    else:
696
 
        main()
 
471
    main()