/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:
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
226
    def valuetostring(value, keyword):
296
 
        if isinstance(value, dbus.Boolean):
 
227
        if type(value) is dbus.Boolean:
297
228
            return "Yes" if value else "No"
298
229
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
299
230
                       "ApprovalDuration", "ExtendedTimeout"):
300
231
            return milliseconds_to_string(value)
301
 
        return str(value)
302
 
 
 
232
        return unicode(value)
 
233
    
303
234
    # Create format string to print table rows
304
235
    format_string = " ".join("{{{key}:{width}}}".format(
305
 
        width=max(len(tablewords[key]),
306
 
                  max(len(valuetostring(client[key], key))
307
 
                      for client in clients)),
308
 
        key=key)
309
 
                             for key in keywords)
 
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)
310
242
    # Print header line
311
243
    print(format_string.format(**tablewords))
312
244
    for client in clients:
313
 
        print(format_string
314
 
              .format(**{key: valuetostring(client[key], key)
315
 
                         for key in keywords}))
316
 
 
 
245
        print(format_string.format(**dict((key,
 
246
                                           valuetostring(client[key],
 
247
                                                         key))
 
248
                                          for key in keywords)))
317
249
 
318
250
def has_actions(options):
319
251
    return any((options.enable,
335
267
                options.approve,
336
268
                options.deny))
337
269
 
338
 
 
339
270
def main():
340
271
    parser = argparse.ArgumentParser()
341
272
    parser.add_argument("--version", action="version",
342
 
                        version="%(prog)s {}".format(version),
 
273
                        version = "%(prog)s {0}".format(version),
343
274
                        help="show version number and exit")
344
275
    parser.add_argument("-a", "--all", action="store_true",
345
276
                        help="Select all clients")
346
277
    parser.add_argument("-v", "--verbose", action="store_true",
347
278
                        help="Print all fields")
348
 
    parser.add_argument("-j", "--dump-json", action="store_true",
349
 
                        help="Dump client data in JSON format")
350
279
    parser.add_argument("-e", "--enable", action="store_true",
351
280
                        help="Enable client")
352
281
    parser.add_argument("-d", "--disable", action="store_true",
380
309
    parser.add_argument("--approval-duration",
381
310
                        help="Set duration of one client approval")
382
311
    parser.add_argument("-H", "--host", help="Set host for client")
383
 
    parser.add_argument("-s", "--secret",
384
 
                        type=argparse.FileType(mode="rb"),
 
312
    parser.add_argument("-s", "--secret", type=file,
385
313
                        help="Set password blob (file) for client")
386
314
    parser.add_argument("-A", "--approve", action="store_true",
387
315
                        help="Approve any current client request")
391
319
                        help="Run self-test")
392
320
    parser.add_argument("client", nargs="*", help="Client name")
393
321
    options = parser.parse_args()
394
 
 
 
322
    
395
323
    if has_actions(options) and not (options.client or options.all):
396
324
        parser.error("Options require clients names or --all.")
397
325
    if options.verbose and has_actions(options):
398
 
        parser.error("--verbose can only be used alone.")
399
 
    if options.dump_json and (options.verbose
400
 
                              or has_actions(options)):
401
 
        parser.error("--dump-json can only be used alone.")
 
326
        parser.error("--verbose can only be used alone or with"
 
327
                     " --all.")
402
328
    if options.all and not has_actions(options):
403
329
        parser.error("--all requires an action.")
404
330
 
 
331
    if options.check:
 
332
        fail_count, test_count = doctest.testmod()
 
333
        sys.exit(0 if fail_count == 0 else 1)
 
334
    
405
335
    try:
406
336
        bus = dbus.SystemBus()
407
337
        mandos_dbus_objc = bus.get_object(busname, server_path)
408
338
    except dbus.exceptions.DBusException:
409
 
        log.critical("Could not connect to Mandos server")
 
339
        print("Could not connect to Mandos server",
 
340
              file=sys.stderr)
410
341
        sys.exit(1)
411
 
 
 
342
    
412
343
    mandos_serv = dbus.Interface(mandos_dbus_objc,
413
 
                                 dbus_interface=server_interface)
414
 
    mandos_serv_object_manager = dbus.Interface(
415
 
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
416
 
 
417
 
    # block stderr since dbus library prints to stderr
 
344
                                 dbus_interface = server_interface)
 
345
    
 
346
    #block stderr since dbus library prints to stderr
418
347
    null = os.open(os.path.devnull, os.O_RDWR)
419
348
    stderrcopy = os.dup(sys.stderr.fileno())
420
349
    os.dup2(null, sys.stderr.fileno())
421
350
    os.close(null)
422
351
    try:
423
352
        try:
424
 
            mandos_clients = {path: ifs_and_props[client_interface]
425
 
                              for path, ifs_and_props in
426
 
                              mandos_serv_object_manager
427
 
                              .GetManagedObjects().items()
428
 
                              if client_interface in ifs_and_props}
 
353
            mandos_clients = mandos_serv.GetAllClientsWithProperties()
429
354
        finally:
430
 
            # restore stderr
 
355
            #restore stderr
431
356
            os.dup2(stderrcopy, sys.stderr.fileno())
432
357
            os.close(stderrcopy)
433
 
    except dbus.exceptions.DBusException as e:
434
 
        log.critical("Failed to access Mandos server through D-Bus:"
435
 
                     "\n%s", e)
 
358
    except dbus.exceptions.DBusException:
 
359
        print("Access denied: Accessing mandos server through dbus.",
 
360
              file=sys.stderr)
436
361
        sys.exit(1)
437
 
 
 
362
    
438
363
    # Compile dict of (clients: properties) to process
439
 
    clients = {}
440
 
 
 
364
    clients={}
 
365
    
441
366
    if options.all or not options.client:
442
 
        clients = {bus.get_object(busname, path): properties
443
 
                   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())
444
370
    else:
445
371
        for name in options.client:
446
 
            for path, client in mandos_clients.items():
 
372
            for path, client in mandos_clients.iteritems():
447
373
                if client["Name"] == name:
448
374
                    client_objc = bus.get_object(busname, path)
449
375
                    clients[client_objc] = client
450
376
                    break
451
377
            else:
452
 
                log.critical("Client not found on server: %r", name)
 
378
                print("Client not found on server: {0!r}"
 
379
                      .format(name), file=sys.stderr)
453
380
                sys.exit(1)
454
 
 
 
381
    
455
382
    if not has_actions(options) and clients:
456
 
        if options.verbose or options.dump_json:
457
 
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
458
 
                        "Created", "Interval", "Host", "KeyID",
459
 
                        "Fingerprint", "CheckerRunning",
 
383
        if options.verbose:
 
384
            keywords = ("Name", "Enabled", "Timeout",
 
385
                        "LastCheckedOK", "Created", "Interval",
 
386
                        "Host", "Fingerprint", "CheckerRunning",
460
387
                        "LastEnabled", "ApprovalPending",
461
 
                        "ApprovedByDefault", "LastApprovalRequest",
462
 
                        "ApprovalDelay", "ApprovalDuration",
463
 
                        "Checker", "ExtendedTimeout", "Expires",
464
 
                        "LastCheckerStatus")
 
388
                        "ApprovedByDefault",
 
389
                        "LastApprovalRequest", "ApprovalDelay",
 
390
                        "ApprovalDuration", "Checker",
 
391
                        "ExtendedTimeout")
465
392
        else:
466
393
            keywords = defaultkeywords
467
 
 
468
 
        if options.dump_json:
469
 
            json.dump({client["Name"]: {key:
470
 
                                        bool(client[key])
471
 
                                        if isinstance(client[key],
472
 
                                                      dbus.Boolean)
473
 
                                        else client[key]
474
 
                                        for key in keywords}
475
 
                       for client in clients.values()},
476
 
                      fp=sys.stdout, indent=4,
477
 
                      separators=(',', ': '))
478
 
            print()
479
 
        else:
480
 
            print_clients(clients.values(), keywords)
 
394
        
 
395
        print_clients(clients.values(), keywords)
481
396
    else:
482
397
        # Process each client in the list by all selected options
483
398
        for client in clients:
484
 
 
485
399
            def set_client_prop(prop, value):
486
400
                """Set a Client D-Bus property"""
487
401
                client.Set(client_interface, prop, value,
488
402
                           dbus_interface=dbus.PROPERTIES_IFACE)
489
 
 
490
403
            def set_client_prop_ms(prop, value):
491
404
                """Set a Client D-Bus property, converted
492
405
                from a string to milliseconds."""
493
406
                set_client_prop(prop,
494
 
                                string_to_delta(value).total_seconds()
495
 
                                * 1000)
496
 
 
 
407
                                timedelta_to_milliseconds
 
408
                                (string_to_delta(value)))
497
409
            if options.remove:
498
410
                mandos_serv.RemoveClient(client.__dbus_object_path__)
499
411
            if options.enable:
507
419
            if options.stop_checker:
508
420
                set_client_prop("CheckerRunning", dbus.Boolean(False))
509
421
            if options.is_enabled:
510
 
                if client.Get(client_interface, "Enabled",
511
 
                              dbus_interface=dbus.PROPERTIES_IFACE):
512
 
                    sys.exit(0)
513
 
                else:
514
 
                    sys.exit(1)
 
422
                sys.exit(0 if client.Get(client_interface,
 
423
                                         "Enabled",
 
424
                                         dbus_interface=
 
425
                                         dbus.PROPERTIES_IFACE)
 
426
                         else 1)
515
427
            if options.checker is not None:
516
428
                set_client_prop("Checker", options.checker)
517
429
            if options.host is not None:
543
455
                client.Approve(dbus.Boolean(False),
544
456
                               dbus_interface=client_interface)
545
457
 
546
 
 
547
 
class Test_milliseconds_to_string(unittest.TestCase):
548
 
    def test_all(self):
549
 
        self.assertEqual(milliseconds_to_string(93785000),
550
 
                         "1T02:03:05")
551
 
    def test_no_days(self):
552
 
        self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
553
 
    def test_all_zero(self):
554
 
        self.assertEqual(milliseconds_to_string(0), "00:00:00")
555
 
    def test_no_fractional_seconds(self):
556
 
        self.assertEqual(milliseconds_to_string(400), "00:00:00")
557
 
        self.assertEqual(milliseconds_to_string(900), "00:00:00")
558
 
        self.assertEqual(milliseconds_to_string(1900), "00:00:01")
559
 
 
560
 
class Test_string_to_delta(unittest.TestCase):
561
 
    def test_handles_basic_rfc3339(self):
562
 
        self.assertEqual(string_to_delta("PT2H"),
563
 
                         datetime.timedelta(0, 7200))
564
 
    def test_falls_back_to_pre_1_6_1_with_warning(self):
565
 
        # assertLogs only exists in Python 3.4
566
 
        if hasattr(self, "assertLogs"):
567
 
            with self.assertLogs(log, logging.WARNING):
568
 
                value = string_to_delta("2h")
569
 
        else:
570
 
            value = string_to_delta("2h")
571
 
        self.assertEqual(value, datetime.timedelta(0, 7200))
572
 
 
573
 
 
574
 
def should_only_run_tests():
575
 
    parser = argparse.ArgumentParser(add_help=False)
576
 
    parser.add_argument("--check", action='store_true')
577
 
    args, unknown_args = parser.parse_known_args()
578
 
    run_tests = args.check
579
 
    if run_tests:
580
 
        # Remove --check argument from sys.argv
581
 
        sys.argv[1:] = unknown_args
582
 
    return run_tests
583
 
 
584
 
# Add all tests from doctest strings
585
 
def load_tests(loader, tests, none):
586
 
    import doctest
587
 
    tests.addTests(doctest.DocTestSuite())
588
 
    return tests
589
 
 
590
458
if __name__ == "__main__":
591
 
    if should_only_run_tests():
592
 
        # Call using ./tdd-python-script --check [--verbose]
593
 
        unittest.main()
594
 
    else:
595
 
        main()
 
459
    main()