/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: 2012-06-23 00:58:49 UTC
  • Revision ID: teddy@recompile.se-20120623005849-02wj82cng433rt2k
* clients.conf: Convert all time intervals to new RFC 3339 syntax.
* mandos: All client options for time intervals now take an RFC 3339
          duration.
  (rfc3339_duration_to_delta): New function.
  (string_to_delta): Try rfc3339_duration_to_delta first.
* mandos-clients.conf.xml (OPTIONS/timeout): Document new format.
  (EXAMPLE): Update to new interval format.
  (SEE ALSO): Reference RFC 3339.

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-2012 Teddy Hogeborn
 
7
# Copyright © 2008-2012 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)
29
28
 
30
 
try:
31
 
    from future_builtins import *
32
 
except ImportError:
33
 
    pass
 
29
from future_builtins import *
34
30
 
35
31
import sys
36
32
import argparse
39
35
import re
40
36
import os
41
37
import collections
42
 
import json
43
 
import unittest
44
 
import logging
 
38
import doctest
45
39
 
46
40
import dbus
47
41
 
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
 
if sys.version_info.major == 2:
60
 
    str = unicode
61
 
 
62
42
locale.setlocale(locale.LC_ALL, "")
63
43
 
64
44
tablewords = {
71
51
    "Interval": "Interval",
72
52
    "Host": "Host",
73
53
    "Fingerprint": "Fingerprint",
74
 
    "KeyID": "Key ID",
75
54
    "CheckerRunning": "Check Is Running",
76
55
    "LastEnabled": "Last Enabled",
77
56
    "ApprovalPending": "Approval Is Pending",
79
58
    "ApprovalDelay": "Approval Delay",
80
59
    "ApprovalDuration": "Approval Duration",
81
60
    "Checker": "Checker",
82
 
    "ExtendedTimeout": "Extended Timeout",
83
 
    "Expires": "Expires",
84
 
    "LastCheckerStatus": "Last Checker Status",
85
 
}
 
61
    "ExtendedTimeout" : "Extended Timeout"
 
62
    }
86
63
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
87
64
domain = "se.recompile"
88
65
busname = domain + ".Mandos"
89
66
server_path = "/"
90
67
server_interface = domain + ".Mandos"
91
68
client_interface = domain + ".Mandos.Client"
92
 
version = "1.8.3"
93
 
 
94
 
 
95
 
try:
96
 
    dbus.OBJECT_MANAGER_IFACE
97
 
except AttributeError:
98
 
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
99
 
 
 
69
version = "1.6.0"
 
70
 
 
71
def timedelta_to_milliseconds(td):
 
72
    """Convert a datetime.timedelta object to milliseconds"""
 
73
    return ((td.days * 24 * 60 * 60 * 1000)
 
74
            + (td.seconds * 1000)
 
75
            + (td.microseconds // 1000))
100
76
 
101
77
def milliseconds_to_string(ms):
102
78
    td = datetime.timedelta(0, 0, 0, ms)
103
79
    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))
 
80
            .format(days = "{0}T".format(td.days) if td.days else "",
 
81
                    hours = td.seconds // 3600,
 
82
                    minutes = (td.seconds % 3600) // 60,
 
83
                    seconds = td.seconds % 60,
 
84
                    ))
108
85
 
109
86
 
110
87
def rfc3339_duration_to_delta(duration):
111
88
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
112
 
 
 
89
    
113
90
    >>> rfc3339_duration_to_delta("P7D")
114
91
    datetime.timedelta(7)
115
92
    >>> rfc3339_duration_to_delta("PT60S")
116
93
    datetime.timedelta(0, 60)
117
94
    >>> rfc3339_duration_to_delta("PT60M")
118
95
    datetime.timedelta(0, 3600)
119
 
    >>> rfc3339_duration_to_delta("P60M")
120
 
    datetime.timedelta(1680)
121
96
    >>> rfc3339_duration_to_delta("PT24H")
122
97
    datetime.timedelta(1)
123
98
    >>> rfc3339_duration_to_delta("P1W")
126
101
    datetime.timedelta(0, 330)
127
102
    >>> rfc3339_duration_to_delta("P1DT3M20S")
128
103
    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
104
    """
159
 
 
 
105
    
160
106
    # Parsing an RFC 3339 duration with regular expressions is not
161
107
    # possible - there would have to be multiple places for the same
162
108
    # values, like seconds.  The current code, while more esoteric, is
163
109
    # cleaner without depending on a parsing library.  If Python had a
164
110
    # built-in library for parsing we would use it, but we'd like to
165
111
    # avoid excessive use of external libraries.
166
 
 
 
112
    
167
113
    # New type for defining tokens, syntax, and semantics all-in-one
168
 
    Token = collections.namedtuple("Token", (
169
 
        "regexp",  # To match token; if "value" is not None, must have
170
 
                   # a "group" containing digits
171
 
        "value",   # datetime.timedelta or None
172
 
        "followers"))           # Tokens valid after this token
 
114
    Token = collections.namedtuple("Token",
 
115
                                   ("regexp", # To match token; if
 
116
                                              # "value" is not None,
 
117
                                              # must have a "group"
 
118
                                              # containing digits
 
119
                                    "value",  # datetime.timedelta or
 
120
                                              # None
 
121
                                    "followers")) # Tokens valid after
 
122
                                                  # this token
173
123
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
174
124
    # the "duration" ABNF definition in RFC 3339, Appendix A.
175
125
    token_end = Token(re.compile(r"$"), None, frozenset())
176
126
    token_second = Token(re.compile(r"(\d+)S"),
177
127
                         datetime.timedelta(seconds=1),
178
 
                         frozenset((token_end, )))
 
128
                         frozenset((token_end,)))
179
129
    token_minute = Token(re.compile(r"(\d+)M"),
180
130
                         datetime.timedelta(minutes=1),
181
131
                         frozenset((token_second, token_end)))
197
147
                       frozenset((token_month, token_end)))
198
148
    token_week = Token(re.compile(r"(\d+)W"),
199
149
                       datetime.timedelta(weeks=1),
200
 
                       frozenset((token_end, )))
 
150
                       frozenset((token_end,)))
201
151
    token_duration = Token(re.compile(r"P"), None,
202
152
                           frozenset((token_year, token_month,
203
153
                                      token_day, token_time,
204
 
                                      token_week)))
205
 
    # Define starting values:
206
 
    # Value so far
207
 
    value = datetime.timedelta()
 
154
                                      token_week))),
 
155
    # Define starting values
 
156
    value = datetime.timedelta() # Value so far
208
157
    found_token = None
209
 
    # Following valid tokens
210
 
    followers = frozenset((token_duration, ))
211
 
    # String left to parse
212
 
    s = duration
 
158
    followers = frozenset(token_duration,) # Following valid tokens
 
159
    s = duration                # String left to parse
213
160
    # Loop until end token is found
214
161
    while found_token is not token_end:
215
162
        # Search for any currently valid tokens
231
178
                break
232
179
        else:
233
180
            # No currently valid tokens were found
234
 
            raise ValueError("Invalid RFC 3339 duration: {!r}"
235
 
                             .format(duration))
 
181
            raise ValueError("Invalid RFC 3339 duration")
236
182
    # End token found
237
183
    return value
238
184
 
239
185
 
240
186
def string_to_delta(interval):
241
187
    """Parse a string and return a datetime.timedelta
242
 
    """
243
 
 
244
 
    try:
245
 
        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')
 
188
    
 
189
    >>> string_to_delta("7d")
256
190
    datetime.timedelta(7)
257
 
    >>> parse_pre_1_6_1_interval('60s')
 
191
    >>> string_to_delta("60s")
258
192
    datetime.timedelta(0, 60)
259
 
    >>> parse_pre_1_6_1_interval('60m')
 
193
    >>> string_to_delta("60m")
260
194
    datetime.timedelta(0, 3600)
261
 
    >>> parse_pre_1_6_1_interval('24h')
 
195
    >>> string_to_delta("24h")
262
196
    datetime.timedelta(1)
263
 
    >>> parse_pre_1_6_1_interval('1w')
 
197
    >>> string_to_delta("1w")
264
198
    datetime.timedelta(7)
265
 
    >>> parse_pre_1_6_1_interval('5m 30s')
 
199
    >>> string_to_delta("5m 30s")
266
200
    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
201
    """
274
 
 
275
202
    value = datetime.timedelta(0)
276
203
    regexp = re.compile(r"(\d+)([dsmhw]?)")
277
 
 
 
204
    
 
205
    try:
 
206
        return rfc3339_duration_to_delta(interval)
 
207
    except ValueError:
 
208
        pass
 
209
    
278
210
    for num, suffix in regexp.findall(interval):
279
211
        if suffix == "d":
280
212
            value += datetime.timedelta(int(num))
290
222
            value += datetime.timedelta(0, 0, 0, int(num))
291
223
    return value
292
224
 
293
 
 
294
225
def print_clients(clients, keywords):
295
 
    print('\n'.join(table_rows_of_clients(clients, keywords)))
296
 
 
297
 
def table_rows_of_clients(clients, keywords):
298
226
    def valuetostring(value, keyword):
299
 
        if isinstance(value, dbus.Boolean):
 
227
        if type(value) is dbus.Boolean:
300
228
            return "Yes" if value else "No"
301
229
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
302
230
                       "ApprovalDuration", "ExtendedTimeout"):
303
231
            return milliseconds_to_string(value)
304
 
        return str(value)
305
 
 
 
232
        return unicode(value)
 
233
    
306
234
    # Create format string to print table rows
307
235
    format_string = " ".join("{{{key}:{width}}}".format(
308
 
        width=max(len(tablewords[key]),
309
 
                  max(len(valuetostring(client[key], key))
310
 
                      for client in clients)),
311
 
        key=key)
312
 
                             for key in keywords)
313
 
    # Start with header line
314
 
    rows = [format_string.format(**tablewords)]
 
236
            width = max(len(tablewords[key]),
 
237
                        max(len(valuetostring(client[key],
 
238
                                              key))
 
239
                            for client in
 
240
                            clients)),
 
241
            key = key) for key in keywords)
 
242
    # Print header line
 
243
    print(format_string.format(**tablewords))
315
244
    for client in clients:
316
 
        rows.append(format_string
317
 
                    .format(**{key: valuetostring(client[key], key)
318
 
                               for key in keywords}))
319
 
    return rows
320
 
 
 
245
        print(format_string.format(**dict((key,
 
246
                                           valuetostring(client[key],
 
247
                                                         key))
 
248
                                          for key in keywords)))
321
249
 
322
250
def has_actions(options):
323
251
    return any((options.enable,
339
267
                options.approve,
340
268
                options.deny))
341
269
 
342
 
 
343
270
def main():
344
271
    parser = argparse.ArgumentParser()
345
272
    parser.add_argument("--version", action="version",
346
 
                        version="%(prog)s {}".format(version),
 
273
                        version = "%(prog)s {0}".format(version),
347
274
                        help="show version number and exit")
348
275
    parser.add_argument("-a", "--all", action="store_true",
349
276
                        help="Select all clients")
350
277
    parser.add_argument("-v", "--verbose", action="store_true",
351
278
                        help="Print all fields")
352
 
    parser.add_argument("-j", "--dump-json", action="store_true",
353
 
                        help="Dump client data in JSON format")
354
279
    parser.add_argument("-e", "--enable", action="store_true",
355
280
                        help="Enable client")
356
281
    parser.add_argument("-d", "--disable", action="store_true",
384
309
    parser.add_argument("--approval-duration",
385
310
                        help="Set duration of one client approval")
386
311
    parser.add_argument("-H", "--host", help="Set host for client")
387
 
    parser.add_argument("-s", "--secret",
388
 
                        type=argparse.FileType(mode="rb"),
 
312
    parser.add_argument("-s", "--secret", type=file,
389
313
                        help="Set password blob (file) for client")
390
314
    parser.add_argument("-A", "--approve", action="store_true",
391
315
                        help="Approve any current client request")
395
319
                        help="Run self-test")
396
320
    parser.add_argument("client", nargs="*", help="Client name")
397
321
    options = parser.parse_args()
398
 
 
 
322
    
399
323
    if has_actions(options) and not (options.client or options.all):
400
324
        parser.error("Options require clients names or --all.")
401
325
    if options.verbose and has_actions(options):
402
 
        parser.error("--verbose can only be used alone.")
403
 
    if options.dump_json and (options.verbose
404
 
                              or has_actions(options)):
405
 
        parser.error("--dump-json can only be used alone.")
 
326
        parser.error("--verbose can only be used alone or with"
 
327
                     " --all.")
406
328
    if options.all and not has_actions(options):
407
329
        parser.error("--all requires an action.")
408
330
 
 
331
    if options.check:
 
332
        fail_count, test_count = doctest.testmod()
 
333
        sys.exit(0 if fail_count == 0 else 1)
 
334
    
409
335
    try:
410
336
        bus = dbus.SystemBus()
411
337
        mandos_dbus_objc = bus.get_object(busname, server_path)
412
338
    except dbus.exceptions.DBusException:
413
 
        log.critical("Could not connect to Mandos server")
 
339
        print("Could not connect to Mandos server",
 
340
              file=sys.stderr)
414
341
        sys.exit(1)
415
 
 
 
342
    
416
343
    mandos_serv = dbus.Interface(mandos_dbus_objc,
417
 
                                 dbus_interface=server_interface)
418
 
    mandos_serv_object_manager = dbus.Interface(
419
 
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
420
 
 
421
 
    # block stderr since dbus library prints to stderr
 
344
                                 dbus_interface = server_interface)
 
345
    
 
346
    #block stderr since dbus library prints to stderr
422
347
    null = os.open(os.path.devnull, os.O_RDWR)
423
348
    stderrcopy = os.dup(sys.stderr.fileno())
424
349
    os.dup2(null, sys.stderr.fileno())
425
350
    os.close(null)
426
351
    try:
427
352
        try:
428
 
            mandos_clients = {path: ifs_and_props[client_interface]
429
 
                              for path, ifs_and_props in
430
 
                              mandos_serv_object_manager
431
 
                              .GetManagedObjects().items()
432
 
                              if client_interface in ifs_and_props}
 
353
            mandos_clients = mandos_serv.GetAllClientsWithProperties()
433
354
        finally:
434
 
            # restore stderr
 
355
            #restore stderr
435
356
            os.dup2(stderrcopy, sys.stderr.fileno())
436
357
            os.close(stderrcopy)
437
 
    except dbus.exceptions.DBusException as e:
438
 
        log.critical("Failed to access Mandos server through D-Bus:"
439
 
                     "\n%s", e)
 
358
    except dbus.exceptions.DBusException:
 
359
        print("Access denied: Accessing mandos server through dbus.",
 
360
              file=sys.stderr)
440
361
        sys.exit(1)
441
 
 
 
362
    
442
363
    # Compile dict of (clients: properties) to process
443
 
    clients = {}
444
 
 
 
364
    clients={}
 
365
    
445
366
    if options.all or not options.client:
446
 
        clients = {bus.get_object(busname, path): properties
447
 
                   for path, properties in mandos_clients.items()}
 
367
        clients = dict((bus.get_object(busname, path), properties)
 
368
                       for path, properties in
 
369
                       mandos_clients.iteritems())
448
370
    else:
449
371
        for name in options.client:
450
 
            for path, client in mandos_clients.items():
 
372
            for path, client in mandos_clients.iteritems():
451
373
                if client["Name"] == name:
452
374
                    client_objc = bus.get_object(busname, path)
453
375
                    clients[client_objc] = client
454
376
                    break
455
377
            else:
456
 
                log.critical("Client not found on server: %r", name)
 
378
                print("Client not found on server: {0!r}"
 
379
                      .format(name), file=sys.stderr)
457
380
                sys.exit(1)
458
 
 
 
381
    
459
382
    if not has_actions(options) and clients:
460
 
        if options.verbose or options.dump_json:
461
 
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
462
 
                        "Created", "Interval", "Host", "KeyID",
463
 
                        "Fingerprint", "CheckerRunning",
 
383
        if options.verbose:
 
384
            keywords = ("Name", "Enabled", "Timeout",
 
385
                        "LastCheckedOK", "Created", "Interval",
 
386
                        "Host", "Fingerprint", "CheckerRunning",
464
387
                        "LastEnabled", "ApprovalPending",
465
 
                        "ApprovedByDefault", "LastApprovalRequest",
466
 
                        "ApprovalDelay", "ApprovalDuration",
467
 
                        "Checker", "ExtendedTimeout", "Expires",
468
 
                        "LastCheckerStatus")
 
388
                        "ApprovedByDefault",
 
389
                        "LastApprovalRequest", "ApprovalDelay",
 
390
                        "ApprovalDuration", "Checker",
 
391
                        "ExtendedTimeout")
469
392
        else:
470
393
            keywords = defaultkeywords
471
 
 
472
 
        if options.dump_json:
473
 
            json.dump({client["Name"]: {key:
474
 
                                        bool(client[key])
475
 
                                        if isinstance(client[key],
476
 
                                                      dbus.Boolean)
477
 
                                        else client[key]
478
 
                                        for key in keywords}
479
 
                       for client in clients.values()},
480
 
                      fp=sys.stdout, indent=4,
481
 
                      separators=(',', ': '))
482
 
            print()
483
 
        else:
484
 
            print_clients(clients.values(), keywords)
 
394
        
 
395
        print_clients(clients.values(), keywords)
485
396
    else:
486
397
        # Process each client in the list by all selected options
487
398
        for client in clients:
488
 
 
489
399
            def set_client_prop(prop, value):
490
400
                """Set a Client D-Bus property"""
491
401
                client.Set(client_interface, prop, value,
492
402
                           dbus_interface=dbus.PROPERTIES_IFACE)
493
 
 
494
403
            def set_client_prop_ms(prop, value):
495
404
                """Set a Client D-Bus property, converted
496
405
                from a string to milliseconds."""
497
406
                set_client_prop(prop,
498
 
                                string_to_delta(value).total_seconds()
499
 
                                * 1000)
500
 
 
 
407
                                timedelta_to_milliseconds
 
408
                                (string_to_delta(value)))
501
409
            if options.remove:
502
410
                mandos_serv.RemoveClient(client.__dbus_object_path__)
503
411
            if options.enable:
511
419
            if options.stop_checker:
512
420
                set_client_prop("CheckerRunning", dbus.Boolean(False))
513
421
            if options.is_enabled:
514
 
                if client.Get(client_interface, "Enabled",
515
 
                              dbus_interface=dbus.PROPERTIES_IFACE):
516
 
                    sys.exit(0)
517
 
                else:
518
 
                    sys.exit(1)
 
422
                sys.exit(0 if client.Get(client_interface,
 
423
                                         "Enabled",
 
424
                                         dbus_interface=
 
425
                                         dbus.PROPERTIES_IFACE)
 
426
                         else 1)
519
427
            if options.checker is not None:
520
428
                set_client_prop("Checker", options.checker)
521
429
            if options.host is not None:
547
455
                client.Approve(dbus.Boolean(False),
548
456
                               dbus_interface=client_interface)
549
457
 
550
 
 
551
 
class Test_milliseconds_to_string(unittest.TestCase):
552
 
    def test_all(self):
553
 
        self.assertEqual(milliseconds_to_string(93785000),
554
 
                         "1T02:03:05")
555
 
    def test_no_days(self):
556
 
        self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
557
 
    def test_all_zero(self):
558
 
        self.assertEqual(milliseconds_to_string(0), "00:00:00")
559
 
    def test_no_fractional_seconds(self):
560
 
        self.assertEqual(milliseconds_to_string(400), "00:00:00")
561
 
        self.assertEqual(milliseconds_to_string(900), "00:00:00")
562
 
        self.assertEqual(milliseconds_to_string(1900), "00:00:01")
563
 
 
564
 
class Test_string_to_delta(unittest.TestCase):
565
 
    def test_handles_basic_rfc3339(self):
566
 
        self.assertEqual(string_to_delta("PT2H"),
567
 
                         datetime.timedelta(0, 7200))
568
 
    def test_falls_back_to_pre_1_6_1_with_warning(self):
569
 
        # assertLogs only exists in Python 3.4
570
 
        if hasattr(self, "assertLogs"):
571
 
            with self.assertLogs(log, logging.WARNING):
572
 
                value = string_to_delta("2h")
573
 
        else:
574
 
            value = string_to_delta("2h")
575
 
        self.assertEqual(value, datetime.timedelta(0, 7200))
576
 
 
577
 
class Test_table_rows_of_clients(unittest.TestCase):
578
 
    def setUp(self):
579
 
        global tablewords
580
 
        self.old_tablewords = tablewords
581
 
        tablewords = {
582
 
            "Attr1": "X",
583
 
            "AttrTwo": "Yy",
584
 
            "AttrThree": "Zzz",
585
 
            "Bool": "A D-BUS Boolean",
586
 
            "NonDbusBoolean": "A Non-D-BUS Boolean",
587
 
            "Integer": "An Integer",
588
 
            "Timeout": "Timedelta 1",
589
 
            "Interval": "Timedelta 2",
590
 
            "ApprovalDelay": "Timedelta 3",
591
 
            "ApprovalDuration": "Timedelta 4",
592
 
            "ExtendedTimeout": "Timedelta 5",
593
 
            "String": "A String",
594
 
        }
595
 
        self.keywords = ["Attr1", "AttrTwo"]
596
 
        self.clients = [
597
 
            {
598
 
                "Attr1": "x1",
599
 
                "AttrTwo": "y1",
600
 
                "AttrThree": "z1",
601
 
                "Bool": dbus.Boolean(False),
602
 
                "NonDbusBoolean": False,
603
 
                "Integer": 0,
604
 
                "Timeout": 0,
605
 
                "Interval": 1000,
606
 
                "ApprovalDelay": 2000,
607
 
                "ApprovalDuration": 3000,
608
 
                "ExtendedTimeout": 4000,
609
 
                "String": "",
610
 
            },
611
 
            {
612
 
                "Attr1": "x2",
613
 
                "AttrTwo": "y2",
614
 
                "AttrThree": "z2",
615
 
                "Bool": dbus.Boolean(True),
616
 
                "NonDbusBoolean": True,
617
 
                "Integer": 1,
618
 
                "Timeout": 93785000,
619
 
                "Interval": 93786000,
620
 
                "ApprovalDelay": 93787000,
621
 
                "ApprovalDuration": 93788000,
622
 
                "ExtendedTimeout": 93789000,
623
 
                "String": "A huge string which will not fit," * 10,
624
 
            },
625
 
        ]
626
 
    def tearDown(self):
627
 
        global tablewords
628
 
        tablewords = self.old_tablewords
629
 
    def test_short_header(self):
630
 
        rows = table_rows_of_clients(self.clients, self.keywords)
631
 
        expected_rows = [
632
 
            "X  Yy",
633
 
            "x1 y1",
634
 
            "x2 y2"]
635
 
        self.assertEqual(rows, expected_rows)
636
 
    def test_booleans(self):
637
 
        keywords = ["Bool", "NonDbusBoolean"]
638
 
        rows = table_rows_of_clients(self.clients, keywords)
639
 
        expected_rows = [
640
 
            "A D-BUS Boolean A Non-D-BUS Boolean",
641
 
            "No              False              ",
642
 
            "Yes             True               ",
643
 
        ]
644
 
        self.assertEqual(rows, expected_rows)
645
 
    def test_milliseconds_detection(self):
646
 
        keywords = ["Integer", "Timeout", "Interval", "ApprovalDelay",
647
 
                    "ApprovalDuration", "ExtendedTimeout"]
648
 
        rows = table_rows_of_clients(self.clients, keywords)
649
 
        expected_rows = ("""
650
 
An Integer Timedelta 1 Timedelta 2 Timedelta 3 Timedelta 4 Timedelta 5
651
 
0          00:00:00    00:00:01    00:00:02    00:00:03    00:00:04   
652
 
1          1T02:03:05  1T02:03:06  1T02:03:07  1T02:03:08  1T02:03:09 
653
 
"""
654
 
        ).splitlines()[1:]
655
 
        self.assertEqual(rows, expected_rows)
656
 
    def test_empty_and_long_string_values(self):
657
 
        keywords = ["String"]
658
 
        rows = table_rows_of_clients(self.clients, keywords)
659
 
        expected_rows = ("""
660
 
A String                                                                                                                                                                                                                                                                                                                                  
661
 
                                                                                                                                                                                                                                                                                                                                          
662
 
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,
663
 
"""
664
 
        ).splitlines()[1:]
665
 
        self.assertEqual(rows, expected_rows)
666
 
 
667
 
 
668
 
 
669
 
def should_only_run_tests():
670
 
    parser = argparse.ArgumentParser(add_help=False)
671
 
    parser.add_argument("--check", action='store_true')
672
 
    args, unknown_args = parser.parse_known_args()
673
 
    run_tests = args.check
674
 
    if run_tests:
675
 
        # Remove --check argument from sys.argv
676
 
        sys.argv[1:] = unknown_args
677
 
    return run_tests
678
 
 
679
 
# Add all tests from doctest strings
680
 
def load_tests(loader, tests, none):
681
 
    import doctest
682
 
    tests.addTests(doctest.DocTestSuite())
683
 
    return tests
684
 
 
685
458
if __name__ == "__main__":
686
 
    if should_only_run_tests():
687
 
        # Call using ./tdd-python-script --check [--verbose]
688
 
        unittest.main()
689
 
    else:
690
 
        main()
 
459
    main()