/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-06-28 18:46:40 UTC
  • Revision ID: teddy@recompile.se-20160628184640-22uh54op9nw0908b
mandos-ctl: Dump booleans as booleans in --dump-json output.

* mandos-ctl (main): Detect dbus.Boolean objects and recast them to
                     regular Python bool() objects to make them show
                     as boolean values in dump output.

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
 
41
import doctest
42
42
import json
43
 
import unittest
44
 
import logging
45
43
 
46
44
import dbus
47
45
 
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
46
if sys.version_info.major == 2:
60
47
    str = unicode
61
48
 
62
49
locale.setlocale(locale.LC_ALL, "")
63
50
 
 
51
tablewords = {
 
52
    "Name": "Name",
 
53
    "Enabled": "Enabled",
 
54
    "Timeout": "Timeout",
 
55
    "LastCheckedOK": "Last Successful Check",
 
56
    "LastApprovalRequest": "Last Approval Request",
 
57
    "Created": "Created",
 
58
    "Interval": "Interval",
 
59
    "Host": "Host",
 
60
    "Fingerprint": "Fingerprint",
 
61
    "CheckerRunning": "Check Is Running",
 
62
    "LastEnabled": "Last Enabled",
 
63
    "ApprovalPending": "Approval Is Pending",
 
64
    "ApprovedByDefault": "Approved By Default",
 
65
    "ApprovalDelay": "Approval Delay",
 
66
    "ApprovalDuration": "Approval Duration",
 
67
    "Checker": "Checker",
 
68
    "ExtendedTimeout": "Extended Timeout"
 
69
}
64
70
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
65
71
domain = "se.recompile"
66
72
busname = domain + ".Mandos"
67
73
server_path = "/"
68
74
server_interface = domain + ".Mandos"
69
75
client_interface = domain + ".Mandos.Client"
70
 
version = "1.8.3"
 
76
version = "1.7.10"
71
77
 
72
78
 
73
79
try:
75
81
except AttributeError:
76
82
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
77
83
 
78
 
 
79
84
def milliseconds_to_string(ms):
80
85
    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))
 
86
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}".format(
 
87
        days = "{}T".format(td.days) if td.days else "",
 
88
        hours = td.seconds // 3600,
 
89
        minutes = (td.seconds % 3600) // 60,
 
90
        seconds = td.seconds % 60))
86
91
 
87
92
 
88
93
def rfc3339_duration_to_delta(duration):
89
94
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
90
 
 
 
95
    
91
96
    >>> rfc3339_duration_to_delta("P7D")
92
97
    datetime.timedelta(7)
93
98
    >>> rfc3339_duration_to_delta("PT60S")
94
99
    datetime.timedelta(0, 60)
95
100
    >>> rfc3339_duration_to_delta("PT60M")
96
101
    datetime.timedelta(0, 3600)
97
 
    >>> rfc3339_duration_to_delta("P60M")
98
 
    datetime.timedelta(1680)
99
102
    >>> rfc3339_duration_to_delta("PT24H")
100
103
    datetime.timedelta(1)
101
104
    >>> rfc3339_duration_to_delta("P1W")
104
107
    datetime.timedelta(0, 330)
105
108
    >>> rfc3339_duration_to_delta("P1DT3M20S")
106
109
    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
110
    """
137
 
 
 
111
    
138
112
    # Parsing an RFC 3339 duration with regular expressions is not
139
113
    # possible - there would have to be multiple places for the same
140
114
    # values, like seconds.  The current code, while more esoteric, is
141
115
    # cleaner without depending on a parsing library.  If Python had a
142
116
    # built-in library for parsing we would use it, but we'd like to
143
117
    # avoid excessive use of external libraries.
144
 
 
 
118
    
145
119
    # New type for defining tokens, syntax, and semantics all-in-one
146
120
    Token = collections.namedtuple("Token", (
147
121
        "regexp",  # To match token; if "value" is not None, must have
180
154
                           frozenset((token_year, token_month,
181
155
                                      token_day, token_time,
182
156
                                      token_week)))
183
 
    # Define starting values:
184
 
    # Value so far
185
 
    value = datetime.timedelta()
 
157
    # Define starting values
 
158
    value = datetime.timedelta() # Value so far
186
159
    found_token = None
187
 
    # Following valid tokens
188
 
    followers = frozenset((token_duration, ))
189
 
    # String left to parse
190
 
    s = duration
 
160
    followers = frozenset((token_duration, )) # Following valid tokens
 
161
    s = duration                # String left to parse
191
162
    # Loop until end token is found
192
163
    while found_token is not token_end:
193
164
        # Search for any currently valid tokens
216
187
 
217
188
 
218
189
def string_to_delta(interval):
219
 
    """Parse a string and return a datetime.timedelta"""
220
 
 
 
190
    """Parse a string and return a datetime.timedelta
 
191
    
 
192
    >>> string_to_delta('7d')
 
193
    datetime.timedelta(7)
 
194
    >>> string_to_delta('60s')
 
195
    datetime.timedelta(0, 60)
 
196
    >>> string_to_delta('60m')
 
197
    datetime.timedelta(0, 3600)
 
198
    >>> string_to_delta('24h')
 
199
    datetime.timedelta(1)
 
200
    >>> string_to_delta('1w')
 
201
    datetime.timedelta(7)
 
202
    >>> string_to_delta('5m 30s')
 
203
    datetime.timedelta(0, 330)
 
204
    """
 
205
    
221
206
    try:
222
207
        return rfc3339_duration_to_delta(interval)
223
 
    except ValueError as e:
224
 
        log.warning("%s - Parsing as pre-1.6.1 interval instead",
225
 
                    ' '.join(e.args))
226
 
    return parse_pre_1_6_1_interval(interval)
227
 
 
228
 
 
229
 
def parse_pre_1_6_1_interval(interval):
230
 
    """Parse an interval string as documented by Mandos before 1.6.1,
231
 
    and return a datetime.timedelta
232
 
 
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
 
 
 
208
    except ValueError:
 
209
        pass
 
210
    
253
211
    value = datetime.timedelta(0)
254
212
    regexp = re.compile(r"(\d+)([dsmhw]?)")
255
 
 
 
213
    
256
214
    for num, suffix in regexp.findall(interval):
257
215
        if suffix == "d":
258
216
            value += datetime.timedelta(int(num))
269
227
    return value
270
228
 
271
229
 
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
 
                      *(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
def print_clients(clients, keywords):
330
231
    def valuetostring(value, keyword):
331
 
        if isinstance(value, dbus.Boolean):
 
232
        if type(value) is dbus.Boolean:
332
233
            return "Yes" if value else "No"
333
234
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
334
235
                       "ApprovalDuration", "ExtendedTimeout"):
335
236
            return milliseconds_to_string(value)
336
237
        return str(value)
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})
 
238
    
 
239
    # Create format string to print table rows
 
240
    format_string = " ".join("{{{key}:{width}}}".format(
 
241
        width = max(len(tablewords[key]),
 
242
                    max(len(valuetostring(client[key], key))
 
243
                        for client in clients)),
 
244
        key = key)
 
245
                             for key in keywords)
 
246
    # Print header line
 
247
    print(format_string.format(**tablewords))
 
248
    for client in clients:
 
249
        print(format_string.format(**{
 
250
            key: valuetostring(client[key], key)
 
251
            for key in keywords }))
345
252
 
346
253
 
347
254
def has_actions(options):
368
275
def main():
369
276
    parser = argparse.ArgumentParser()
370
277
    parser.add_argument("--version", action="version",
371
 
                        version="%(prog)s {}".format(version),
 
278
                        version = "%(prog)s {}".format(version),
372
279
                        help="show version number and exit")
373
280
    parser.add_argument("-a", "--all", action="store_true",
374
281
                        help="Select all clients")
420
327
                        help="Run self-test")
421
328
    parser.add_argument("client", nargs="*", help="Client name")
422
329
    options = parser.parse_args()
423
 
 
 
330
    
424
331
    if has_actions(options) and not (options.client or options.all):
425
332
        parser.error("Options require clients names or --all.")
426
333
    if options.verbose and has_actions(options):
427
334
        parser.error("--verbose can only be used alone.")
428
 
    if options.dump_json and (options.verbose
429
 
                              or has_actions(options)):
 
335
    if options.dump_json and (options.verbose or has_actions(options)):
430
336
        parser.error("--dump-json can only be used alone.")
431
337
    if options.all and not has_actions(options):
432
338
        parser.error("--all requires an action.")
433
 
 
 
339
    
 
340
    if options.check:
 
341
        fail_count, test_count = doctest.testmod()
 
342
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
343
    
434
344
    try:
435
345
        bus = dbus.SystemBus()
436
346
        mandos_dbus_objc = bus.get_object(busname, server_path)
437
347
    except dbus.exceptions.DBusException:
438
 
        log.critical("Could not connect to Mandos server")
 
348
        print("Could not connect to Mandos server", file=sys.stderr)
439
349
        sys.exit(1)
440
 
 
 
350
    
441
351
    mandos_serv = dbus.Interface(mandos_dbus_objc,
442
 
                                 dbus_interface=server_interface)
 
352
                                 dbus_interface = server_interface)
443
353
    mandos_serv_object_manager = dbus.Interface(
444
 
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
445
 
 
446
 
    # block stderr since dbus library prints to stderr
 
354
        mandos_dbus_objc, dbus_interface = dbus.OBJECT_MANAGER_IFACE)
 
355
    
 
356
    #block stderr since dbus library prints to stderr
447
357
    null = os.open(os.path.devnull, os.O_RDWR)
448
358
    stderrcopy = os.dup(sys.stderr.fileno())
449
359
    os.dup2(null, sys.stderr.fileno())
450
360
    os.close(null)
451
361
    try:
452
362
        try:
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}
 
363
            mandos_clients = { path: ifs_and_props[client_interface]
 
364
                               for path, ifs_and_props in
 
365
                               mandos_serv_object_manager
 
366
                               .GetManagedObjects().items()
 
367
                               if client_interface in ifs_and_props }
458
368
        finally:
459
 
            # restore stderr
 
369
            #restore stderr
460
370
            os.dup2(stderrcopy, sys.stderr.fileno())
461
371
            os.close(stderrcopy)
462
372
    except dbus.exceptions.DBusException as e:
463
 
        log.critical("Failed to access Mandos server through D-Bus:"
464
 
                     "\n%s", e)
 
373
        print("Access denied: Accessing mandos server through D-Bus: {}"
 
374
              .format(e), file=sys.stderr)
465
375
        sys.exit(1)
466
 
 
 
376
    
467
377
    # Compile dict of (clients: properties) to process
468
 
    clients = {}
469
 
 
 
378
    clients={}
 
379
    
470
380
    if options.all or not options.client:
471
 
        clients = {bus.get_object(busname, path): properties
472
 
                   for path, properties in mandos_clients.items()}
 
381
        clients = { bus.get_object(busname, path): properties
 
382
                    for path, properties in mandos_clients.items() }
473
383
    else:
474
384
        for name in options.client:
475
385
            for path, client in mandos_clients.items():
478
388
                    clients[client_objc] = client
479
389
                    break
480
390
            else:
481
 
                log.critical("Client not found on server: %r", name)
 
391
                print("Client not found on server: {!r}"
 
392
                      .format(name), file=sys.stderr)
482
393
                sys.exit(1)
483
 
 
 
394
    
484
395
    if not has_actions(options) and clients:
485
396
        if options.verbose or options.dump_json:
486
397
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
487
 
                        "Created", "Interval", "Host", "KeyID",
488
 
                        "Fingerprint", "CheckerRunning",
489
 
                        "LastEnabled", "ApprovalPending",
490
 
                        "ApprovedByDefault", "LastApprovalRequest",
491
 
                        "ApprovalDelay", "ApprovalDuration",
492
 
                        "Checker", "ExtendedTimeout", "Expires",
493
 
                        "LastCheckerStatus")
 
398
                        "Created", "Interval", "Host", "Fingerprint",
 
399
                        "CheckerRunning", "LastEnabled",
 
400
                        "ApprovalPending", "ApprovedByDefault",
 
401
                        "LastApprovalRequest", "ApprovalDelay",
 
402
                        "ApprovalDuration", "Checker",
 
403
                        "ExtendedTimeout")
494
404
        else:
495
405
            keywords = defaultkeywords
496
 
 
 
406
        
497
407
        if options.dump_json:
498
408
            json.dump({client["Name"]: {key:
499
409
                                        bool(client[key])
500
410
                                        if isinstance(client[key],
501
411
                                                      dbus.Boolean)
502
412
                                        else client[key]
503
 
                                        for key in keywords}
504
 
                       for client in clients.values()},
505
 
                      fp=sys.stdout, indent=4,
506
 
                      separators=(',', ': '))
 
413
                                        for key in keywords }
 
414
                       for client in clients.values() },
 
415
                      fp = sys.stdout, indent = 4,
 
416
                      separators = (',', ': '))
507
417
            print()
508
418
        else:
509
 
            print(TableOfClients(clients.values(), keywords))
 
419
            print_clients(clients.values(), keywords)
510
420
    else:
511
421
        # Process each client in the list by all selected options
512
422
        for client in clients:
513
 
 
 
423
            
514
424
            def set_client_prop(prop, value):
515
425
                """Set a Client D-Bus property"""
516
426
                client.Set(client_interface, prop, value,
517
427
                           dbus_interface=dbus.PROPERTIES_IFACE)
518
 
 
 
428
            
519
429
            def set_client_prop_ms(prop, value):
520
430
                """Set a Client D-Bus property, converted
521
431
                from a string to milliseconds."""
522
432
                set_client_prop(prop,
523
433
                                string_to_delta(value).total_seconds()
524
434
                                * 1000)
525
 
 
 
435
            
526
436
            if options.remove:
527
437
                mandos_serv.RemoveClient(client.__dbus_object_path__)
528
438
            if options.enable:
536
446
            if options.stop_checker:
537
447
                set_client_prop("CheckerRunning", dbus.Boolean(False))
538
448
            if options.is_enabled:
539
 
                if client.Get(client_interface, "Enabled",
540
 
                              dbus_interface=dbus.PROPERTIES_IFACE):
541
 
                    sys.exit(0)
542
 
                else:
543
 
                    sys.exit(1)
 
449
                sys.exit(0 if client.Get(client_interface,
 
450
                                         "Enabled",
 
451
                                         dbus_interface=
 
452
                                         dbus.PROPERTIES_IFACE)
 
453
                         else 1)
544
454
            if options.checker is not None:
545
455
                set_client_prop("Checker", options.checker)
546
456
            if options.host is not None:
572
482
                client.Approve(dbus.Boolean(False),
573
483
                               dbus_interface=client_interface)
574
484
 
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
 
        text = str(TableOfClients(self.clients, self.keywords,
651
 
                                  self.tablewords))
652
 
        expected_text = """
653
 
X  Yy
654
 
x1 y1
655
 
x2 y2
656
 
"""[1:-1]
657
 
        self.assertEqual(text, expected_text)
658
 
    def test_booleans(self):
659
 
        keywords = ["Bool", "NonDbusBoolean"]
660
 
        text = str(TableOfClients(self.clients, keywords,
661
 
                                  self.tablewords))
662
 
        expected_text = """
663
 
A D-BUS Boolean A Non-D-BUS Boolean
664
 
No              False              
665
 
Yes             True               
666
 
"""[1:-1]
667
 
        self.assertEqual(text, expected_text)
668
 
    def test_milliseconds_detection(self):
669
 
        keywords = ["Integer", "Timeout", "Interval", "ApprovalDelay",
670
 
                    "ApprovalDuration", "ExtendedTimeout"]
671
 
        text = str(TableOfClients(self.clients, keywords,
672
 
                                  self.tablewords))
673
 
        expected_text = """
674
 
An Integer Timedelta 1 Timedelta 2 Timedelta 3 Timedelta 4 Timedelta 5
675
 
0          00:00:00    00:00:01    00:00:02    00:00:03    00:00:04   
676
 
1          1T02:03:05  1T02:03:06  1T02:03:07  1T02:03:08  1T02:03:09 
677
 
"""[1:-1]
678
 
        self.assertEqual(text, expected_text)
679
 
    def test_empty_and_long_string_values(self):
680
 
        keywords = ["String"]
681
 
        text = str(TableOfClients(self.clients, keywords,
682
 
                                  self.tablewords))
683
 
        expected_text = """
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
 
"""[1:-1]
688
 
        self.assertEqual(text, expected_text)
689
 
 
690
 
 
691
 
 
692
 
def should_only_run_tests():
693
 
    parser = argparse.ArgumentParser(add_help=False)
694
 
    parser.add_argument("--check", action='store_true')
695
 
    args, unknown_args = parser.parse_known_args()
696
 
    run_tests = args.check
697
 
    if run_tests:
698
 
        # Remove --check argument from sys.argv
699
 
        sys.argv[1:] = unknown_args
700
 
    return run_tests
701
 
 
702
 
# Add all tests from doctest strings
703
 
def load_tests(loader, tests, none):
704
 
    import doctest
705
 
    tests.addTests(doctest.DocTestSuite())
706
 
    return tests
707
485
 
708
486
if __name__ == "__main__":
709
 
    if should_only_run_tests():
710
 
        # Call using ./tdd-python-script --check [--verbose]
711
 
        unittest.main()
712
 
    else:
713
 
        main()
 
487
    main()