/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: 2019-03-02 01:28:12 UTC
  • Revision ID: teddy@recompile.se-20190302012812-3ymo5liufbe9jr6o
mandos-ctl: Add tests for table_rows_of_clients()

* mandos-ctl (class Test_table_rows_of_clients): New.

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 -*-
3
 
# 
 
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
#
4
4
# Mandos Monitor - Control and monitor the Mandos server
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
 
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
11
13
# the Free Software Foundation, either version 3 of the License, or
12
14
# (at your option) any later version.
13
15
#
14
 
#     This program is distributed in the hope that it will be useful,
15
 
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
 
16
#     Mandos is distributed in the hope that it will be useful, but
 
17
#     WITHOUT ANY WARRANTY; without even the implied warranty of
16
18
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17
19
#     GNU General Public License for more details.
18
 
# 
 
20
#
19
21
# You should have received a copy of the GNU General Public License
20
 
# along with this program.  If not, see
21
 
# <http://www.gnu.org/licenses/>.
22
 
# 
 
22
# along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
 
23
#
23
24
# Contact the authors at <mandos@recompile.se>.
24
 
# 
 
25
#
25
26
 
26
27
from __future__ import (division, absolute_import, print_function,
27
28
                        unicode_literals)
28
29
 
29
 
from future_builtins import *
 
30
try:
 
31
    from future_builtins import *
 
32
except ImportError:
 
33
    pass
30
34
 
31
35
import sys
32
 
import dbus
33
36
import argparse
34
37
import locale
35
38
import datetime
36
39
import re
37
40
import os
 
41
import collections
 
42
import json
 
43
import unittest
 
44
import logging
 
45
 
 
46
import dbus
 
47
 
 
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
38
61
 
39
62
locale.setlocale(locale.LC_ALL, "")
40
63
 
48
71
    "Interval": "Interval",
49
72
    "Host": "Host",
50
73
    "Fingerprint": "Fingerprint",
 
74
    "KeyID": "Key ID",
51
75
    "CheckerRunning": "Check Is Running",
52
76
    "LastEnabled": "Last Enabled",
53
77
    "ApprovalPending": "Approval Is Pending",
55
79
    "ApprovalDelay": "Approval Delay",
56
80
    "ApprovalDuration": "Approval Duration",
57
81
    "Checker": "Checker",
58
 
    "ExtendedTimeout" : "Extended Timeout"
59
 
    }
 
82
    "ExtendedTimeout": "Extended Timeout",
 
83
    "Expires": "Expires",
 
84
    "LastCheckerStatus": "Last Checker Status",
 
85
}
60
86
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
61
87
domain = "se.recompile"
62
88
busname = domain + ".Mandos"
63
89
server_path = "/"
64
90
server_interface = domain + ".Mandos"
65
91
client_interface = domain + ".Mandos.Client"
66
 
version = "1.5.4"
67
 
 
68
 
def timedelta_to_milliseconds(td):
69
 
    """Convert a datetime.timedelta object to milliseconds"""
70
 
    return ((td.days * 24 * 60 * 60 * 1000)
71
 
            + (td.seconds * 1000)
72
 
            + (td.microseconds // 1000))
 
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
 
73
100
 
74
101
def milliseconds_to_string(ms):
75
102
    td = datetime.timedelta(0, 0, 0, ms)
76
103
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
77
 
            .format(days = "{0}T".format(td.days) if td.days else "",
78
 
                    hours = td.seconds // 3600,
79
 
                    minutes = (td.seconds % 3600) // 60,
80
 
                    seconds = td.seconds % 60,
81
 
                    ))
 
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))
 
108
 
 
109
 
 
110
def rfc3339_duration_to_delta(duration):
 
111
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
 
112
 
 
113
    >>> rfc3339_duration_to_delta("P7D")
 
114
    datetime.timedelta(7)
 
115
    >>> rfc3339_duration_to_delta("PT60S")
 
116
    datetime.timedelta(0, 60)
 
117
    >>> rfc3339_duration_to_delta("PT60M")
 
118
    datetime.timedelta(0, 3600)
 
119
    >>> rfc3339_duration_to_delta("P60M")
 
120
    datetime.timedelta(1680)
 
121
    >>> rfc3339_duration_to_delta("PT24H")
 
122
    datetime.timedelta(1)
 
123
    >>> rfc3339_duration_to_delta("P1W")
 
124
    datetime.timedelta(7)
 
125
    >>> rfc3339_duration_to_delta("PT5M30S")
 
126
    datetime.timedelta(0, 330)
 
127
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
128
    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
    """
 
159
 
 
160
    # Parsing an RFC 3339 duration with regular expressions is not
 
161
    # possible - there would have to be multiple places for the same
 
162
    # values, like seconds.  The current code, while more esoteric, is
 
163
    # cleaner without depending on a parsing library.  If Python had a
 
164
    # built-in library for parsing we would use it, but we'd like to
 
165
    # avoid excessive use of external libraries.
 
166
 
 
167
    # 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
 
173
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
 
174
    # the "duration" ABNF definition in RFC 3339, Appendix A.
 
175
    token_end = Token(re.compile(r"$"), None, frozenset())
 
176
    token_second = Token(re.compile(r"(\d+)S"),
 
177
                         datetime.timedelta(seconds=1),
 
178
                         frozenset((token_end, )))
 
179
    token_minute = Token(re.compile(r"(\d+)M"),
 
180
                         datetime.timedelta(minutes=1),
 
181
                         frozenset((token_second, token_end)))
 
182
    token_hour = Token(re.compile(r"(\d+)H"),
 
183
                       datetime.timedelta(hours=1),
 
184
                       frozenset((token_minute, token_end)))
 
185
    token_time = Token(re.compile(r"T"),
 
186
                       None,
 
187
                       frozenset((token_hour, token_minute,
 
188
                                  token_second)))
 
189
    token_day = Token(re.compile(r"(\d+)D"),
 
190
                      datetime.timedelta(days=1),
 
191
                      frozenset((token_time, token_end)))
 
192
    token_month = Token(re.compile(r"(\d+)M"),
 
193
                        datetime.timedelta(weeks=4),
 
194
                        frozenset((token_day, token_end)))
 
195
    token_year = Token(re.compile(r"(\d+)Y"),
 
196
                       datetime.timedelta(weeks=52),
 
197
                       frozenset((token_month, token_end)))
 
198
    token_week = Token(re.compile(r"(\d+)W"),
 
199
                       datetime.timedelta(weeks=1),
 
200
                       frozenset((token_end, )))
 
201
    token_duration = Token(re.compile(r"P"), None,
 
202
                           frozenset((token_year, token_month,
 
203
                                      token_day, token_time,
 
204
                                      token_week)))
 
205
    # Define starting values:
 
206
    # Value so far
 
207
    value = datetime.timedelta()
 
208
    found_token = None
 
209
    # Following valid tokens
 
210
    followers = frozenset((token_duration, ))
 
211
    # String left to parse
 
212
    s = duration
 
213
    # Loop until end token is found
 
214
    while found_token is not token_end:
 
215
        # Search for any currently valid tokens
 
216
        for token in followers:
 
217
            match = token.regexp.match(s)
 
218
            if match is not None:
 
219
                # Token found
 
220
                if token.value is not None:
 
221
                    # Value found, parse digits
 
222
                    factor = int(match.group(1), 10)
 
223
                    # Add to value so far
 
224
                    value += factor * token.value
 
225
                # Strip token from string
 
226
                s = token.regexp.sub("", s, 1)
 
227
                # Go to found token
 
228
                found_token = token
 
229
                # Set valid next tokens
 
230
                followers = found_token.followers
 
231
                break
 
232
        else:
 
233
            # No currently valid tokens were found
 
234
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
235
                             .format(duration))
 
236
    # End token found
 
237
    return value
 
238
 
82
239
 
83
240
def string_to_delta(interval):
84
241
    """Parse a string and return a datetime.timedelta
85
 
    
86
 
    >>> string_to_delta("7d")
 
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')
87
256
    datetime.timedelta(7)
88
 
    >>> string_to_delta("60s")
 
257
    >>> parse_pre_1_6_1_interval('60s')
89
258
    datetime.timedelta(0, 60)
90
 
    >>> string_to_delta("60m")
 
259
    >>> parse_pre_1_6_1_interval('60m')
91
260
    datetime.timedelta(0, 3600)
92
 
    >>> string_to_delta("24h")
 
261
    >>> parse_pre_1_6_1_interval('24h')
93
262
    datetime.timedelta(1)
94
 
    >>> string_to_delta("1w")
 
263
    >>> parse_pre_1_6_1_interval('1w')
95
264
    datetime.timedelta(7)
96
 
    >>> string_to_delta("5m 30s")
 
265
    >>> parse_pre_1_6_1_interval('5m 30s')
97
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
 
98
273
    """
 
274
 
99
275
    value = datetime.timedelta(0)
100
 
    regexp = re.compile("(\d+)([dsmhw]?)")
101
 
    
 
276
    regexp = re.compile(r"(\d+)([dsmhw]?)")
 
277
 
102
278
    for num, suffix in regexp.findall(interval):
103
279
        if suffix == "d":
104
280
            value += datetime.timedelta(int(num))
114
290
            value += datetime.timedelta(0, 0, 0, int(num))
115
291
    return value
116
292
 
 
293
 
117
294
def print_clients(clients, keywords):
 
295
    print('\n'.join(table_rows_of_clients(clients, keywords)))
 
296
 
 
297
def table_rows_of_clients(clients, keywords):
118
298
    def valuetostring(value, keyword):
119
 
        if type(value) is dbus.Boolean:
 
299
        if isinstance(value, dbus.Boolean):
120
300
            return "Yes" if value else "No"
121
301
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
122
302
                       "ApprovalDuration", "ExtendedTimeout"):
123
303
            return milliseconds_to_string(value)
124
 
        return unicode(value)
125
 
    
 
304
        return str(value)
 
305
 
126
306
    # Create format string to print table rows
127
307
    format_string = " ".join("{{{key}:{width}}}".format(
128
 
            width = max(len(tablewords[key]),
129
 
                        max(len(valuetostring(client[key],
130
 
                                              key))
131
 
                            for client in
132
 
                            clients)),
133
 
            key = key) for key in keywords)
134
 
    # Print header line
135
 
    print(format_string.format(**tablewords))
 
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)]
136
315
    for client in clients:
137
 
        print(format_string.format(**dict((key,
138
 
                                           valuetostring(client[key],
139
 
                                                         key))
140
 
                                          for key in keywords)))
 
316
        rows.append(format_string
 
317
                    .format(**{key: valuetostring(client[key], key)
 
318
                               for key in keywords}))
 
319
    return rows
 
320
 
141
321
 
142
322
def has_actions(options):
143
323
    return any((options.enable,
159
339
                options.approve,
160
340
                options.deny))
161
341
 
 
342
 
162
343
def main():
163
344
    parser = argparse.ArgumentParser()
164
345
    parser.add_argument("--version", action="version",
165
 
                        version = "%(prog)s {0}".format(version),
 
346
                        version="%(prog)s {}".format(version),
166
347
                        help="show version number and exit")
167
348
    parser.add_argument("-a", "--all", action="store_true",
168
349
                        help="Select all clients")
169
350
    parser.add_argument("-v", "--verbose", action="store_true",
170
351
                        help="Print all fields")
 
352
    parser.add_argument("-j", "--dump-json", action="store_true",
 
353
                        help="Dump client data in JSON format")
171
354
    parser.add_argument("-e", "--enable", action="store_true",
172
355
                        help="Enable client")
173
356
    parser.add_argument("-d", "--disable", action="store_true",
201
384
    parser.add_argument("--approval-duration",
202
385
                        help="Set duration of one client approval")
203
386
    parser.add_argument("-H", "--host", help="Set host for client")
204
 
    parser.add_argument("-s", "--secret", type=file,
 
387
    parser.add_argument("-s", "--secret",
 
388
                        type=argparse.FileType(mode="rb"),
205
389
                        help="Set password blob (file) for client")
206
390
    parser.add_argument("-A", "--approve", action="store_true",
207
391
                        help="Approve any current client request")
208
392
    parser.add_argument("-D", "--deny", action="store_true",
209
393
                        help="Deny any current client request")
 
394
    parser.add_argument("--check", action="store_true",
 
395
                        help="Run self-test")
210
396
    parser.add_argument("client", nargs="*", help="Client name")
211
397
    options = parser.parse_args()
212
 
    
 
398
 
213
399
    if has_actions(options) and not (options.client or options.all):
214
400
        parser.error("Options require clients names or --all.")
215
401
    if options.verbose and has_actions(options):
216
 
        parser.error("--verbose can only be used alone or with"
217
 
                     " --all.")
 
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.")
218
406
    if options.all and not has_actions(options):
219
407
        parser.error("--all requires an action.")
220
 
    
 
408
 
221
409
    try:
222
410
        bus = dbus.SystemBus()
223
411
        mandos_dbus_objc = bus.get_object(busname, server_path)
224
412
    except dbus.exceptions.DBusException:
225
 
        print("Could not connect to Mandos server",
226
 
              file=sys.stderr)
 
413
        log.critical("Could not connect to Mandos server")
227
414
        sys.exit(1)
228
 
    
 
415
 
229
416
    mandos_serv = dbus.Interface(mandos_dbus_objc,
230
 
                                 dbus_interface = server_interface)
231
 
    
232
 
    #block stderr since dbus library prints to stderr
 
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
233
422
    null = os.open(os.path.devnull, os.O_RDWR)
234
423
    stderrcopy = os.dup(sys.stderr.fileno())
235
424
    os.dup2(null, sys.stderr.fileno())
236
425
    os.close(null)
237
426
    try:
238
427
        try:
239
 
            mandos_clients = mandos_serv.GetAllClientsWithProperties()
 
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}
240
433
        finally:
241
 
            #restore stderr
 
434
            # restore stderr
242
435
            os.dup2(stderrcopy, sys.stderr.fileno())
243
436
            os.close(stderrcopy)
244
 
    except dbus.exceptions.DBusException:
245
 
        print("Access denied: Accessing mandos server through dbus.",
246
 
              file=sys.stderr)
 
437
    except dbus.exceptions.DBusException as e:
 
438
        log.critical("Failed to access Mandos server through D-Bus:"
 
439
                     "\n%s", e)
247
440
        sys.exit(1)
248
 
    
 
441
 
249
442
    # Compile dict of (clients: properties) to process
250
 
    clients={}
251
 
    
 
443
    clients = {}
 
444
 
252
445
    if options.all or not options.client:
253
 
        clients = dict((bus.get_object(busname, path), properties)
254
 
                       for path, properties in
255
 
                       mandos_clients.iteritems())
 
446
        clients = {bus.get_object(busname, path): properties
 
447
                   for path, properties in mandos_clients.items()}
256
448
    else:
257
449
        for name in options.client:
258
 
            for path, client in mandos_clients.iteritems():
 
450
            for path, client in mandos_clients.items():
259
451
                if client["Name"] == name:
260
452
                    client_objc = bus.get_object(busname, path)
261
453
                    clients[client_objc] = client
262
454
                    break
263
455
            else:
264
 
                print("Client not found on server: {0!r}"
265
 
                      .format(name), file=sys.stderr)
 
456
                log.critical("Client not found on server: %r", name)
266
457
                sys.exit(1)
267
 
    
 
458
 
268
459
    if not has_actions(options) and clients:
269
 
        if options.verbose:
270
 
            keywords = ("Name", "Enabled", "Timeout",
271
 
                        "LastCheckedOK", "Created", "Interval",
272
 
                        "Host", "Fingerprint", "CheckerRunning",
 
460
        if options.verbose or options.dump_json:
 
461
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
 
462
                        "Created", "Interval", "Host", "KeyID",
 
463
                        "Fingerprint", "CheckerRunning",
273
464
                        "LastEnabled", "ApprovalPending",
274
 
                        "ApprovedByDefault",
275
 
                        "LastApprovalRequest", "ApprovalDelay",
276
 
                        "ApprovalDuration", "Checker",
277
 
                        "ExtendedTimeout")
 
465
                        "ApprovedByDefault", "LastApprovalRequest",
 
466
                        "ApprovalDelay", "ApprovalDuration",
 
467
                        "Checker", "ExtendedTimeout", "Expires",
 
468
                        "LastCheckerStatus")
278
469
        else:
279
470
            keywords = defaultkeywords
280
 
        
281
 
        print_clients(clients.values(), keywords)
 
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)
282
485
    else:
283
486
        # Process each client in the list by all selected options
284
487
        for client in clients:
 
488
 
285
489
            def set_client_prop(prop, value):
286
490
                """Set a Client D-Bus property"""
287
491
                client.Set(client_interface, prop, value,
288
492
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
493
 
289
494
            def set_client_prop_ms(prop, value):
290
495
                """Set a Client D-Bus property, converted
291
496
                from a string to milliseconds."""
292
497
                set_client_prop(prop,
293
 
                                timedelta_to_milliseconds
294
 
                                (string_to_delta(value)))
 
498
                                string_to_delta(value).total_seconds()
 
499
                                * 1000)
 
500
 
295
501
            if options.remove:
296
502
                mandos_serv.RemoveClient(client.__dbus_object_path__)
297
503
            if options.enable:
305
511
            if options.stop_checker:
306
512
                set_client_prop("CheckerRunning", dbus.Boolean(False))
307
513
            if options.is_enabled:
308
 
                sys.exit(0 if client.Get(client_interface,
309
 
                                         "Enabled",
310
 
                                         dbus_interface=
311
 
                                         dbus.PROPERTIES_IFACE)
312
 
                         else 1)
 
514
                if client.Get(client_interface, "Enabled",
 
515
                              dbus_interface=dbus.PROPERTIES_IFACE):
 
516
                    sys.exit(0)
 
517
                else:
 
518
                    sys.exit(1)
313
519
            if options.checker is not None:
314
520
                set_client_prop("Checker", options.checker)
315
521
            if options.host is not None:
341
547
                client.Approve(dbus.Boolean(False),
342
548
                               dbus_interface=client_interface)
343
549
 
 
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
 
344
685
if __name__ == "__main__":
345
 
    main()
 
686
    if should_only_run_tests():
 
687
        # Call using ./tdd-python-script --check [--verbose]
 
688
        unittest.main()
 
689
    else:
 
690
        main()