/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: 2022-04-24 16:54:30 UTC
  • Revision ID: teddy@recompile.se-20220424165430-m687snug7o7vz4ok
Update copyright year

* debian/copyright: Update copyright year to 2022.
* dracut-module/password-agent.c: - '' -
* dracut-module/password-agent.xml: Revert copyright year to 2020.
* intro.xml: - '' -
* mandos: Update copyright year to 2022.
* mandos-ctl: - '' -
* plugin-helpers/mandos-client-iprouteadddel.c: - '' -
* plugin-runner.c: - '' -
* plugins.d/mandos-client.c: - '' -
* plugins.d/password-prompt.c: - '' -
* plugins.d/plymouth.c: - '' -
* plugins.d/splashy.c: - '' -
* plugins.d/usplash.c: - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
 
#
4
 
# Mandos Monitor - Control and monitor the Mandos server
5
 
#
6
 
# Copyright © 2008-2019 Teddy Hogeborn
7
 
# Copyright © 2008-2019 Björn Påhlsson
 
1
#!/usr/bin/python3 -bbI
 
2
# -*- coding: utf-8; lexical-binding: t -*-
 
3
#
 
4
# Mandos Control - Control or query the Mandos server
 
5
#
 
6
# Copyright © 2008-2022 Teddy Hogeborn
 
7
# Copyright © 2008-2022 Björn Påhlsson
8
8
#
9
9
# This file is part of Mandos.
10
10
#
23
23
#
24
24
# Contact the authors at <mandos@recompile.se>.
25
25
#
26
 
 
27
26
from __future__ import (division, absolute_import, print_function,
28
27
                        unicode_literals)
29
28
 
33
32
    pass
34
33
 
35
34
import sys
 
35
import unittest
36
36
import argparse
 
37
import logging
 
38
import os
37
39
import locale
38
40
import datetime
39
41
import re
40
 
import os
41
42
import collections
42
43
import json
43
 
import unittest
44
 
import logging
45
44
import io
46
45
import tempfile
47
46
import contextlib
48
47
 
49
 
import dbus
 
48
if sys.version_info.major == 2:
 
49
    __metaclass__ = type
 
50
    str = unicode
 
51
    input = raw_input
 
52
 
 
53
class gi:
 
54
    """Dummy gi module, for the tests"""
 
55
    class repository:
 
56
        class GLib:
 
57
            class Error(Exception):
 
58
                pass
 
59
dbussy = None
 
60
ravel = None
 
61
dbus_python = None
 
62
pydbus = None
 
63
 
 
64
try:
 
65
    import dbussy
 
66
    import ravel
 
67
except ImportError:
 
68
    try:
 
69
        import pydbus
 
70
        import gi
 
71
    except ImportError:
 
72
        import dbus as dbus_python
 
73
 
50
74
 
51
75
# Show warnings by default
52
76
if not sys.warnoptions:
53
77
    import warnings
54
78
    warnings.simplefilter("default")
55
79
 
56
 
log = logging.getLogger(sys.argv[0])
 
80
log = logging.getLogger(os.path.basename(sys.argv[0]))
57
81
logging.basicConfig(level="INFO", # Show info level messages
58
82
                    format="%(message)s") # Show basic log messages
59
83
 
60
84
logging.captureWarnings(True)   # Show warnings via the logging system
61
85
 
62
86
if sys.version_info.major == 2:
63
 
    str = unicode
64
87
    import StringIO
65
88
    io.StringIO = StringIO.StringIO
66
89
 
67
90
locale.setlocale(locale.LC_ALL, "")
68
91
 
69
 
dbus_busname_domain = "se.recompile"
70
 
dbus_busname = dbus_busname_domain + ".Mandos"
71
 
server_dbus_path = "/"
72
 
server_dbus_interface = dbus_busname_domain + ".Mandos"
73
 
client_dbus_interface = dbus_busname_domain + ".Mandos.Client"
74
 
del dbus_busname_domain
75
 
version = "1.8.3"
76
 
 
77
 
 
78
 
try:
79
 
    dbus.OBJECT_MANAGER_IFACE
80
 
except AttributeError:
81
 
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
 
92
version = "1.8.14"
82
93
 
83
94
 
84
95
def main():
91
102
    clientnames = options.client
92
103
 
93
104
    if options.debug:
94
 
        log.setLevel(logging.DEBUG)
95
 
 
96
 
    bus = dbus.SystemBus()
97
 
 
98
 
    mandos_dbus_object = get_mandos_dbus_object(bus)
99
 
 
100
 
    mandos_serv = dbus.Interface(
101
 
        mandos_dbus_object, dbus_interface=server_dbus_interface)
102
 
    mandos_serv_object_manager = dbus.Interface(
103
 
        mandos_dbus_object, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
104
 
 
105
 
    managed_objects = get_managed_objects(mandos_serv_object_manager)
106
 
 
107
 
    all_clients = {}
108
 
    for path, ifs_and_props in managed_objects.items():
109
 
        try:
110
 
            all_clients[path] = ifs_and_props[client_dbus_interface]
111
 
        except KeyError:
112
 
            pass
 
105
        logging.getLogger("").setLevel(logging.DEBUG)
 
106
 
 
107
    if dbussy is not None and ravel is not None:
 
108
        bus = dbussy_adapter.CachingBus(dbussy, ravel)
 
109
    elif pydbus is not None:
 
110
        bus = pydbus_adapter.CachingBus(pydbus)
 
111
    else:
 
112
        bus = dbus_python_adapter.CachingBus(dbus_python)
 
113
 
 
114
    try:
 
115
        all_clients = bus.get_clients_and_properties()
 
116
    except dbus.ConnectFailed as e:
 
117
        log.critical("Could not connect to Mandos server: %s", e)
 
118
        sys.exit(1)
 
119
    except dbus.Error as e:
 
120
        log.critical(
 
121
            "Failed to access Mandos server through D-Bus:\n%s", e)
 
122
        sys.exit(1)
113
123
 
114
124
    # Compile dict of (clientpath: properties) to process
115
125
    if not clientnames:
128
138
    commands = commands_from_options(options)
129
139
 
130
140
    for command in commands:
131
 
        command.run(clients, bus, mandos_serv)
 
141
        command.run(clients, bus)
132
142
 
133
143
 
134
144
def add_command_line_options(parser):
139
149
                        help="Select all clients")
140
150
    parser.add_argument("-v", "--verbose", action="store_true",
141
151
                        help="Print all fields")
142
 
    parser.add_argument("-j", "--dump-json", action="store_true",
 
152
    parser.add_argument("-j", "--dump-json", dest="commands",
 
153
                        action="append_const", default=[],
 
154
                        const=command.DumpJSON(),
143
155
                        help="Dump client data in JSON format")
144
156
    enable_disable = parser.add_mutually_exclusive_group()
145
 
    enable_disable.add_argument("-e", "--enable", action="store_true",
 
157
    enable_disable.add_argument("-e", "--enable", dest="commands",
 
158
                                action="append_const", default=[],
 
159
                                const=command.Enable(),
146
160
                                help="Enable client")
147
 
    enable_disable.add_argument("-d", "--disable",
148
 
                                action="store_true",
 
161
    enable_disable.add_argument("-d", "--disable", dest="commands",
 
162
                                action="append_const", default=[],
 
163
                                const=command.Disable(),
149
164
                                help="disable client")
150
 
    parser.add_argument("-b", "--bump-timeout", action="store_true",
 
165
    parser.add_argument("-b", "--bump-timeout", dest="commands",
 
166
                        action="append_const", default=[],
 
167
                        const=command.BumpTimeout(),
151
168
                        help="Bump timeout for client")
152
169
    start_stop_checker = parser.add_mutually_exclusive_group()
153
170
    start_stop_checker.add_argument("--start-checker",
154
 
                                    action="store_true",
 
171
                                    dest="commands",
 
172
                                    action="append_const", default=[],
 
173
                                    const=command.StartChecker(),
155
174
                                    help="Start checker for client")
156
 
    start_stop_checker.add_argument("--stop-checker",
157
 
                                    action="store_true",
 
175
    start_stop_checker.add_argument("--stop-checker", dest="commands",
 
176
                                    action="append_const", default=[],
 
177
                                    const=command.StopChecker(),
158
178
                                    help="Stop checker for client")
159
 
    parser.add_argument("-V", "--is-enabled", action="store_true",
 
179
    parser.add_argument("-V", "--is-enabled", dest="commands",
 
180
                        action="append_const", default=[],
 
181
                        const=command.IsEnabled(),
160
182
                        help="Check if client is enabled")
161
 
    parser.add_argument("-r", "--remove", action="store_true",
 
183
    parser.add_argument("-r", "--remove", dest="commands",
 
184
                        action="append_const", default=[],
 
185
                        const=command.Remove(),
162
186
                        help="Remove client")
163
 
    parser.add_argument("-c", "--checker",
 
187
    parser.add_argument("-c", "--checker", dest="commands",
 
188
                        action="append", default=[],
 
189
                        metavar="COMMAND", type=command.SetChecker,
164
190
                        help="Set checker command for client")
165
 
    parser.add_argument("-t", "--timeout", type=string_to_delta,
166
 
                        help="Set timeout for client")
167
 
    parser.add_argument("--extended-timeout", type=string_to_delta,
168
 
                        help="Set extended timeout for client")
169
 
    parser.add_argument("-i", "--interval", type=string_to_delta,
170
 
                        help="Set checker interval for client")
 
191
    parser.add_argument(
 
192
        "-t", "--timeout", dest="commands", action="append",
 
193
        default=[], metavar="TIME",
 
194
        type=command.SetTimeout.argparse(string_to_delta),
 
195
        help="Set timeout for client")
 
196
    parser.add_argument(
 
197
        "--extended-timeout", dest="commands", action="append",
 
198
        default=[], metavar="TIME",
 
199
        type=command.SetExtendedTimeout.argparse(string_to_delta),
 
200
        help="Set extended timeout for client")
 
201
    parser.add_argument(
 
202
        "-i", "--interval", dest="commands", action="append",
 
203
        default=[], metavar="TIME",
 
204
        type=command.SetInterval.argparse(string_to_delta),
 
205
        help="Set checker interval for client")
171
206
    approve_deny_default = parser.add_mutually_exclusive_group()
172
207
    approve_deny_default.add_argument(
173
 
        "--approve-by-default", action="store_true",
174
 
        default=None, dest="approved_by_default",
 
208
        "--approve-by-default", dest="commands",
 
209
        action="append_const", default=[],
 
210
        const=command.ApproveByDefault(),
175
211
        help="Set client to be approved by default")
176
212
    approve_deny_default.add_argument(
177
 
        "--deny-by-default", action="store_false",
178
 
        dest="approved_by_default",
 
213
        "--deny-by-default", dest="commands",
 
214
        action="append_const", default=[],
 
215
        const=command.DenyByDefault(),
179
216
        help="Set client to be denied by default")
180
 
    parser.add_argument("--approval-delay", type=string_to_delta,
181
 
                        help="Set delay before client approve/deny")
182
 
    parser.add_argument("--approval-duration", type=string_to_delta,
183
 
                        help="Set duration of one client approval")
184
 
    parser.add_argument("-H", "--host", help="Set host for client")
185
 
    parser.add_argument("-s", "--secret",
186
 
                        type=argparse.FileType(mode="rb"),
187
 
                        help="Set password blob (file) for client")
 
217
    parser.add_argument(
 
218
        "--approval-delay", dest="commands", action="append",
 
219
        default=[], metavar="TIME",
 
220
        type=command.SetApprovalDelay.argparse(string_to_delta),
 
221
        help="Set delay before client approve/deny")
 
222
    parser.add_argument(
 
223
        "--approval-duration", dest="commands", action="append",
 
224
        default=[], metavar="TIME",
 
225
        type=command.SetApprovalDuration.argparse(string_to_delta),
 
226
        help="Set duration of one client approval")
 
227
    parser.add_argument("-H", "--host", dest="commands",
 
228
                        action="append", default=[], metavar="STRING",
 
229
                        type=command.SetHost,
 
230
                        help="Set host for client")
 
231
    parser.add_argument(
 
232
        "-s", "--secret", dest="commands", action="append",
 
233
        default=[], metavar="FILENAME",
 
234
        type=command.SetSecret.argparse(argparse.FileType(mode="rb")),
 
235
        help="Set password blob (file) for client")
188
236
    approve_deny = parser.add_mutually_exclusive_group()
189
237
    approve_deny.add_argument(
190
 
        "-A", "--approve", action="store_true",
 
238
        "-A", "--approve", dest="commands", action="append_const",
 
239
        default=[], const=command.Approve(),
191
240
        help="Approve any current client request")
192
 
    approve_deny.add_argument("-D", "--deny", action="store_true",
 
241
    approve_deny.add_argument("-D", "--deny", dest="commands",
 
242
                              action="append_const", default=[],
 
243
                              const=command.Deny(),
193
244
                              help="Deny any current client request")
194
245
    parser.add_argument("--debug", action="store_true",
195
246
                        help="Debug mode (show D-Bus commands)")
205
256
        return rfc3339_duration_to_delta(interval)
206
257
    except ValueError as e:
207
258
        log.warning("%s - Parsing as pre-1.6.1 interval instead",
208
 
                    ' '.join(e.args))
 
259
                    " ".join(e.args))
209
260
    return parse_pre_1_6_1_interval(interval)
210
261
 
211
262
 
212
263
def rfc3339_duration_to_delta(duration):
213
264
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
214
265
 
215
 
    >>> rfc3339_duration_to_delta("P7D")
216
 
    datetime.timedelta(7)
217
 
    >>> rfc3339_duration_to_delta("PT60S")
218
 
    datetime.timedelta(0, 60)
219
 
    >>> rfc3339_duration_to_delta("PT60M")
220
 
    datetime.timedelta(0, 3600)
221
 
    >>> rfc3339_duration_to_delta("P60M")
222
 
    datetime.timedelta(1680)
223
 
    >>> rfc3339_duration_to_delta("PT24H")
224
 
    datetime.timedelta(1)
225
 
    >>> rfc3339_duration_to_delta("P1W")
226
 
    datetime.timedelta(7)
227
 
    >>> rfc3339_duration_to_delta("PT5M30S")
228
 
    datetime.timedelta(0, 330)
229
 
    >>> rfc3339_duration_to_delta("P1DT3M20S")
230
 
    datetime.timedelta(1, 200)
 
266
    >>> rfc3339_duration_to_delta("P7D") == datetime.timedelta(7)
 
267
    True
 
268
    >>> rfc3339_duration_to_delta("PT60S") == datetime.timedelta(0, 60)
 
269
    True
 
270
    >>> rfc3339_duration_to_delta("PT60M") == datetime.timedelta(hours=1)
 
271
    True
 
272
    >>> # 60 months
 
273
    >>> rfc3339_duration_to_delta("P60M") == datetime.timedelta(1680)
 
274
    True
 
275
    >>> rfc3339_duration_to_delta("PT24H") == datetime.timedelta(1)
 
276
    True
 
277
    >>> rfc3339_duration_to_delta("P1W") == datetime.timedelta(7)
 
278
    True
 
279
    >>> rfc3339_duration_to_delta("PT5M30S") == datetime.timedelta(0, 330)
 
280
    True
 
281
    >>> rfc3339_duration_to_delta("P1DT3M20S") == datetime.timedelta(1, 200)
 
282
    True
231
283
    >>> # Can not be empty:
232
284
    >>> rfc3339_duration_to_delta("")
233
285
    Traceback (most recent call last):
343
395
    """Parse an interval string as documented by Mandos before 1.6.1,
344
396
    and return a datetime.timedelta
345
397
 
346
 
    >>> parse_pre_1_6_1_interval('7d')
347
 
    datetime.timedelta(7)
348
 
    >>> parse_pre_1_6_1_interval('60s')
349
 
    datetime.timedelta(0, 60)
350
 
    >>> parse_pre_1_6_1_interval('60m')
351
 
    datetime.timedelta(0, 3600)
352
 
    >>> parse_pre_1_6_1_interval('24h')
353
 
    datetime.timedelta(1)
354
 
    >>> parse_pre_1_6_1_interval('1w')
355
 
    datetime.timedelta(7)
356
 
    >>> parse_pre_1_6_1_interval('5m 30s')
357
 
    datetime.timedelta(0, 330)
358
 
    >>> parse_pre_1_6_1_interval('')
359
 
    datetime.timedelta(0)
 
398
    >>> parse_pre_1_6_1_interval("7d") == datetime.timedelta(days=7)
 
399
    True
 
400
    >>> parse_pre_1_6_1_interval("60s") == datetime.timedelta(0, 60)
 
401
    True
 
402
    >>> parse_pre_1_6_1_interval("60m") == datetime.timedelta(hours=1)
 
403
    True
 
404
    >>> parse_pre_1_6_1_interval("24h") == datetime.timedelta(days=1)
 
405
    True
 
406
    >>> parse_pre_1_6_1_interval("1w") == datetime.timedelta(days=7)
 
407
    True
 
408
    >>> parse_pre_1_6_1_interval("5m 30s") == datetime.timedelta(0, 330)
 
409
    True
 
410
    >>> parse_pre_1_6_1_interval("") == datetime.timedelta(0)
 
411
    True
360
412
    >>> # Ignore unknown characters, allow any order and repetitions
361
 
    >>> parse_pre_1_6_1_interval('2dxy7zz11y3m5m')
362
 
    datetime.timedelta(2, 480, 18000)
 
413
    >>> parse_pre_1_6_1_interval("2dxy7zz11y3m5m") == datetime.timedelta(2, 480, 18000)
 
414
    True
363
415
 
364
416
    """
365
417
 
386
438
    """Apply additional restrictions on options, not expressible in
387
439
argparse"""
388
440
 
389
 
    def has_actions(options):
390
 
        return any((options.enable,
391
 
                    options.disable,
392
 
                    options.bump_timeout,
393
 
                    options.start_checker,
394
 
                    options.stop_checker,
395
 
                    options.is_enabled,
396
 
                    options.remove,
397
 
                    options.checker is not None,
398
 
                    options.timeout is not None,
399
 
                    options.extended_timeout is not None,
400
 
                    options.interval is not None,
401
 
                    options.approved_by_default is not None,
402
 
                    options.approval_delay is not None,
403
 
                    options.approval_duration is not None,
404
 
                    options.host is not None,
405
 
                    options.secret is not None,
406
 
                    options.approve,
407
 
                    options.deny))
 
441
    def has_commands(options, commands=None):
 
442
        if commands is None:
 
443
            commands = (command.Enable,
 
444
                        command.Disable,
 
445
                        command.BumpTimeout,
 
446
                        command.StartChecker,
 
447
                        command.StopChecker,
 
448
                        command.IsEnabled,
 
449
                        command.Remove,
 
450
                        command.SetChecker,
 
451
                        command.SetTimeout,
 
452
                        command.SetExtendedTimeout,
 
453
                        command.SetInterval,
 
454
                        command.ApproveByDefault,
 
455
                        command.DenyByDefault,
 
456
                        command.SetApprovalDelay,
 
457
                        command.SetApprovalDuration,
 
458
                        command.SetHost,
 
459
                        command.SetSecret,
 
460
                        command.Approve,
 
461
                        command.Deny)
 
462
        return any(isinstance(cmd, commands)
 
463
                   for cmd in options.commands)
408
464
 
409
 
    if has_actions(options) and not (options.client or options.all):
 
465
    if has_commands(options) and not (options.client or options.all):
410
466
        parser.error("Options require clients names or --all.")
411
 
    if options.verbose and has_actions(options):
 
467
    if options.verbose and has_commands(options):
412
468
        parser.error("--verbose can only be used alone.")
413
 
    if options.dump_json and (options.verbose
414
 
                              or has_actions(options)):
 
469
    if (has_commands(options, (command.DumpJSON,))
 
470
        and (options.verbose or len(options.commands) > 1)):
415
471
        parser.error("--dump-json can only be used alone.")
416
 
    if options.all and not has_actions(options):
 
472
    if options.all and not has_commands(options):
417
473
        parser.error("--all requires an action.")
418
 
    if options.is_enabled and len(options.client) > 1:
 
474
    if (has_commands(options, (command.IsEnabled,))
 
475
        and len(options.client) > 1):
419
476
        parser.error("--is-enabled requires exactly one client")
420
 
    if options.remove:
421
 
        options.remove = False
422
 
        if has_actions(options) and not options.deny:
423
 
            parser.error("--remove can only be combined with --deny")
424
 
        options.remove = True
425
 
 
426
 
 
427
 
def get_mandos_dbus_object(bus):
428
 
    log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
429
 
              dbus_busname, server_dbus_path)
430
 
    with if_dbus_exception_log_with_exception_and_exit(
431
 
            "Could not connect to Mandos server: %s"):
432
 
        mandos_dbus_object = bus.get_object(dbus_busname,
433
 
                                            server_dbus_path)
434
 
    return mandos_dbus_object
435
 
 
436
 
 
437
 
@contextlib.contextmanager
438
 
def if_dbus_exception_log_with_exception_and_exit(*args, **kwargs):
439
 
    try:
440
 
        yield
441
 
    except dbus.exceptions.DBusException as e:
442
 
        log.critical(*(args + (e,)), **kwargs)
443
 
        sys.exit(1)
444
 
 
445
 
 
446
 
def get_managed_objects(object_manager):
447
 
    log.debug("D-Bus: %s:%s:%s.GetManagedObjects()", dbus_busname,
448
 
              server_dbus_path, dbus.OBJECT_MANAGER_IFACE)
449
 
    with if_dbus_exception_log_with_exception_and_exit(
450
 
            "Failed to access Mandos server through D-Bus:\n%s"):
451
 
        with SilenceLogger("dbus.proxies"):
452
 
            managed_objects = object_manager.GetManagedObjects()
453
 
    return managed_objects
454
 
 
455
 
 
456
 
class SilenceLogger(object):
457
 
    "Simple context manager to silence a particular logger"
458
 
    def __init__(self, loggername):
459
 
        self.logger = logging.getLogger(loggername)
460
 
 
461
 
    def __enter__(self):
462
 
        self.logger.addFilter(self.nullfilter)
463
 
 
464
 
    class NullFilter(logging.Filter):
465
 
        def filter(self, record):
466
 
            return False
467
 
 
468
 
    nullfilter = NullFilter()
469
 
 
470
 
    def __exit__(self, exc_type, exc_val, exc_tb):
471
 
        self.logger.removeFilter(self.nullfilter)
 
477
    if (len(options.commands) > 1
 
478
        and has_commands(options, (command.Remove,))
 
479
        and not has_commands(options, (command.Deny,))):
 
480
        parser.error("--remove can only be combined with --deny")
 
481
 
 
482
 
 
483
class dbus:
 
484
 
 
485
    class SystemBus:
 
486
 
 
487
        object_manager_iface = "org.freedesktop.DBus.ObjectManager"
 
488
        def get_managed_objects(self, busname, objectpath):
 
489
            return self.call_method("GetManagedObjects", busname,
 
490
                                    objectpath,
 
491
                                    self.object_manager_iface)
 
492
 
 
493
        properties_iface = "org.freedesktop.DBus.Properties"
 
494
        def set_property(self, busname, objectpath, interface, key,
 
495
                         value):
 
496
            self.call_method("Set", busname, objectpath,
 
497
                             self.properties_iface, interface, key,
 
498
                             value)
 
499
 
 
500
        def call_method(self, methodname, busname, objectpath,
 
501
                        interface, *args):
 
502
            raise NotImplementedError()
 
503
 
 
504
 
 
505
    class MandosBus(SystemBus):
 
506
        busname_domain = "se.recompile"
 
507
        busname = busname_domain + ".Mandos"
 
508
        server_path = "/"
 
509
        server_interface = busname_domain + ".Mandos"
 
510
        client_interface = busname_domain + ".Mandos.Client"
 
511
        del busname_domain
 
512
 
 
513
        def get_clients_and_properties(self):
 
514
            managed_objects = self.get_managed_objects(
 
515
                self.busname, self.server_path)
 
516
            return {objpath: properties[self.client_interface]
 
517
                    for objpath, properties in managed_objects.items()
 
518
                    if self.client_interface in properties}
 
519
 
 
520
        def set_client_property(self, objectpath, key, value):
 
521
            return self.set_property(self.busname, objectpath,
 
522
                                     self.client_interface, key,
 
523
                                     value)
 
524
 
 
525
        def call_client_method(self, objectpath, method, *args):
 
526
            return self.call_method(method, self.busname, objectpath,
 
527
                                    self.client_interface, *args)
 
528
 
 
529
        def call_server_method(self, method, *args):
 
530
            return self.call_method(method, self.busname,
 
531
                                    self.server_path,
 
532
                                    self.server_interface, *args)
 
533
 
 
534
    class Error(Exception):
 
535
        pass
 
536
 
 
537
    class ConnectFailed(Error):
 
538
        pass
 
539
 
 
540
 
 
541
class dbus_python_adapter:
 
542
 
 
543
    class SystemBus(dbus.MandosBus):
 
544
        """Use dbus-python"""
 
545
 
 
546
        def __init__(self, module=dbus_python):
 
547
            self.dbus_python = module
 
548
            self.bus = self.dbus_python.SystemBus()
 
549
 
 
550
        @contextlib.contextmanager
 
551
        def convert_exception(self, exception_class=dbus.Error):
 
552
            try:
 
553
                yield
 
554
            except self.dbus_python.exceptions.DBusException as e:
 
555
                # This does what "raise from" would do
 
556
                exc = exception_class(*e.args)
 
557
                exc.__cause__ = e
 
558
                raise exc
 
559
 
 
560
        def call_method(self, methodname, busname, objectpath,
 
561
                        interface, *args):
 
562
            proxy_object = self.get_object(busname, objectpath)
 
563
            log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
 
564
                      interface, methodname,
 
565
                      ", ".join(repr(a) for a in args))
 
566
            method = getattr(proxy_object, methodname)
 
567
            with self.convert_exception():
 
568
                with dbus_python_adapter.SilenceLogger(
 
569
                        "dbus.proxies"):
 
570
                    value = method(*args, dbus_interface=interface)
 
571
            return self.type_filter(value)
 
572
 
 
573
        def get_object(self, busname, objectpath):
 
574
            log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
 
575
                      busname, objectpath)
 
576
            with self.convert_exception(dbus.ConnectFailed):
 
577
                return self.bus.get_object(busname, objectpath)
 
578
 
 
579
        def type_filter(self, value):
 
580
            """Convert the most bothersome types to Python types"""
 
581
            if isinstance(value, self.dbus_python.Boolean):
 
582
                return bool(value)
 
583
            if isinstance(value, self.dbus_python.ObjectPath):
 
584
                return str(value)
 
585
            # Also recurse into dictionaries
 
586
            if isinstance(value, self.dbus_python.Dictionary):
 
587
                return {self.type_filter(key):
 
588
                        self.type_filter(subval)
 
589
                        for key, subval in value.items()}
 
590
            return value
 
591
 
 
592
        def set_client_property(self, objectpath, key, value):
 
593
            if key == "Secret":
 
594
                if not isinstance(value, bytes):
 
595
                    value = value.encode("utf-8")
 
596
                value = self.dbus_python.ByteArray(value)
 
597
            return self.set_property(self.busname, objectpath,
 
598
                                     self.client_interface, key,
 
599
                                     value)
 
600
 
 
601
    class SilenceLogger:
 
602
        "Simple context manager to silence a particular logger"
 
603
        def __init__(self, loggername):
 
604
            self.logger = logging.getLogger(loggername)
 
605
 
 
606
        def __enter__(self):
 
607
            self.logger.addFilter(self.nullfilter)
 
608
 
 
609
        class NullFilter(logging.Filter):
 
610
            def filter(self, record):
 
611
                return False
 
612
 
 
613
        nullfilter = NullFilter()
 
614
 
 
615
        def __exit__(self, exc_type, exc_val, exc_tb):
 
616
            self.logger.removeFilter(self.nullfilter)
 
617
 
 
618
 
 
619
    class CachingBus(SystemBus):
 
620
        """A caching layer for dbus_python_adapter.SystemBus"""
 
621
        def __init__(self, *args, **kwargs):
 
622
            self.object_cache = {}
 
623
            super(dbus_python_adapter.CachingBus,
 
624
                  self).__init__(*args, **kwargs)
 
625
        def get_object(self, busname, objectpath):
 
626
            try:
 
627
                return self.object_cache[(busname, objectpath)]
 
628
            except KeyError:
 
629
                new_object = super(
 
630
                    dbus_python_adapter.CachingBus,
 
631
                    self).get_object(busname, objectpath)
 
632
                self.object_cache[(busname, objectpath)]  = new_object
 
633
                return new_object
 
634
 
 
635
 
 
636
class pydbus_adapter:
 
637
    class SystemBus(dbus.MandosBus):
 
638
        def __init__(self, module=pydbus):
 
639
            self.pydbus = module
 
640
            self.bus = self.pydbus.SystemBus()
 
641
 
 
642
        @contextlib.contextmanager
 
643
        def convert_exception(self, exception_class=dbus.Error):
 
644
            try:
 
645
                yield
 
646
            except gi.repository.GLib.Error as e:
 
647
                # This does what "raise from" would do
 
648
                exc = exception_class(*e.args)
 
649
                exc.__cause__ = e
 
650
                raise exc
 
651
 
 
652
        def call_method(self, methodname, busname, objectpath,
 
653
                        interface, *args):
 
654
            proxy_object = self.get(busname, objectpath)
 
655
            log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
 
656
                      interface, methodname,
 
657
                      ", ".join(repr(a) for a in args))
 
658
            method = getattr(proxy_object[interface], methodname)
 
659
            with self.convert_exception():
 
660
                return method(*args)
 
661
 
 
662
        def get(self, busname, objectpath):
 
663
            log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
 
664
                      busname, objectpath)
 
665
            with self.convert_exception(dbus.ConnectFailed):
 
666
                if sys.version_info.major <= 2:
 
667
                    with warnings.catch_warnings():
 
668
                        warnings.filterwarnings(
 
669
                            "ignore", "", DeprecationWarning,
 
670
                            r"^xml\.etree\.ElementTree$")
 
671
                        return self.bus.get(busname, objectpath)
 
672
                else:
 
673
                    return self.bus.get(busname, objectpath)
 
674
 
 
675
        def set_property(self, busname, objectpath, interface, key,
 
676
                         value):
 
677
            proxy_object = self.get(busname, objectpath)
 
678
            log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", busname,
 
679
                      objectpath, self.properties_iface, interface,
 
680
                      key, value)
 
681
            setattr(proxy_object[interface], key, value)
 
682
 
 
683
    class CachingBus(SystemBus):
 
684
        """A caching layer for pydbus_adapter.SystemBus"""
 
685
        def __init__(self, *args, **kwargs):
 
686
            self.object_cache = {}
 
687
            super(pydbus_adapter.CachingBus,
 
688
                  self).__init__(*args, **kwargs)
 
689
        def get(self, busname, objectpath):
 
690
            try:
 
691
                return self.object_cache[(busname, objectpath)]
 
692
            except KeyError:
 
693
                new_object = (super(pydbus_adapter.CachingBus, self)
 
694
                              .get(busname, objectpath))
 
695
                self.object_cache[(busname, objectpath)]  = new_object
 
696
                return new_object
 
697
 
 
698
 
 
699
class dbussy_adapter:
 
700
    class SystemBus(dbus.SystemBus):
 
701
        """Use DBussy"""
 
702
 
 
703
        def __init__(self, dbussy, ravel):
 
704
            self.dbussy = dbussy
 
705
            self.ravel = ravel
 
706
            self.bus = ravel.system_bus()
 
707
 
 
708
        @contextlib.contextmanager
 
709
        def convert_exception(self, exception_class=dbus.Error):
 
710
            try:
 
711
                yield
 
712
            except self.dbussy.DBusError as e:
 
713
                # This does what "raise from" would do
 
714
                exc = exception_class(*e.args)
 
715
                exc.__cause__ = e
 
716
                raise exc
 
717
 
 
718
        def call_method(self, methodname, busname, objectpath,
 
719
                        interface, *args):
 
720
            proxy_object = self.get_object(busname, objectpath)
 
721
            log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
 
722
                      interface, methodname,
 
723
                      ", ".join(repr(a) for a in args))
 
724
            iface = proxy_object.get_interface(interface)
 
725
            method = getattr(iface, methodname)
 
726
            with self.convert_exception(dbus.Error):
 
727
                value =  method(*args)
 
728
            # DBussy returns values either as an empty list or as a
 
729
            # list of one element with the return value
 
730
            if value:
 
731
                return self.type_filter(value[0])
 
732
 
 
733
        def get_object(self, busname, objectpath):
 
734
            log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
 
735
                      busname, objectpath)
 
736
            with self.convert_exception(dbus.ConnectFailed):
 
737
                return self.bus[busname][objectpath]
 
738
 
 
739
        def type_filter(self, value):
 
740
            """Convert the most bothersome types to Python types"""
 
741
            # A D-Bus Variant value is represented as the Python type
 
742
            # Tuple[dbussy.DBUS.Signature, Any]
 
743
            if isinstance(value, tuple):
 
744
                if (len(value) == 2
 
745
                    and isinstance(value[0],
 
746
                                   self.dbussy.DBUS.Signature)):
 
747
                    return self.type_filter(value[1])
 
748
            elif isinstance(value, self.dbussy.DBUS.ObjectPath):
 
749
                return str(value)
 
750
            # Also recurse into dictionaries
 
751
            elif isinstance(value, dict):
 
752
                return {self.type_filter(key):
 
753
                        self.type_filter(subval)
 
754
                        for key, subval in value.items()}
 
755
            return value
 
756
 
 
757
        def set_property(self, busname, objectpath, interface, key,
 
758
                         value):
 
759
            proxy_object = self.get_object(busname, objectpath)
 
760
            log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", busname,
 
761
                      objectpath, self.properties_iface, interface,
 
762
                      key, value)
 
763
            if key == "Secret":
 
764
                # DBussy wants a Byte Array to be a sequence of
 
765
                # values, not a byte string
 
766
                value = tuple(value)
 
767
            setattr(proxy_object.get_interface(interface), key, value)
 
768
 
 
769
    class MandosBus(SystemBus, dbus.MandosBus):
 
770
        pass
 
771
 
 
772
    class CachingBus(MandosBus):
 
773
        """A caching layer for dbussy_adapter.MandosBus"""
 
774
        def __init__(self, *args, **kwargs):
 
775
            self.object_cache = {}
 
776
            super(dbussy_adapter.CachingBus, self).__init__(*args,
 
777
                                                            **kwargs)
 
778
        def get_object(self, busname, objectpath):
 
779
            try:
 
780
                return self.object_cache[(busname, objectpath)]
 
781
            except KeyError:
 
782
                new_object = super(
 
783
                    dbussy_adapter.CachingBus,
 
784
                    self).get_object(busname, objectpath)
 
785
                self.object_cache[(busname, objectpath)]  = new_object
 
786
                return new_object
472
787
 
473
788
 
474
789
def commands_from_options(options):
475
790
 
476
 
    commands = []
477
 
 
478
 
    if options.is_enabled:
479
 
        commands.append(command.IsEnabled())
480
 
 
481
 
    if options.approve:
482
 
        commands.append(command.Approve())
483
 
 
484
 
    if options.deny:
485
 
        commands.append(command.Deny())
486
 
 
487
 
    if options.remove:
488
 
        commands.append(command.Remove())
489
 
 
490
 
    if options.dump_json:
491
 
        commands.append(command.DumpJSON())
492
 
 
493
 
    if options.enable:
494
 
        commands.append(command.Enable())
495
 
 
496
 
    if options.disable:
497
 
        commands.append(command.Disable())
498
 
 
499
 
    if options.bump_timeout:
500
 
        commands.append(command.BumpTimeout())
501
 
 
502
 
    if options.start_checker:
503
 
        commands.append(command.StartChecker())
504
 
 
505
 
    if options.stop_checker:
506
 
        commands.append(command.StopChecker())
507
 
 
508
 
    if options.approved_by_default is not None:
509
 
        if options.approved_by_default:
510
 
            commands.append(command.ApproveByDefault())
 
791
    commands = list(options.commands)
 
792
 
 
793
    def find_cmd(cmd, commands):
 
794
        i = 0
 
795
        for i, c in enumerate(commands):
 
796
            if isinstance(c, cmd):
 
797
                return i
 
798
        return i+1
 
799
 
 
800
    # If command.Remove is present, move any instances of command.Deny
 
801
    # to occur ahead of command.Remove.
 
802
    index_of_remove = find_cmd(command.Remove, commands)
 
803
    before_remove = commands[:index_of_remove]
 
804
    after_remove = commands[index_of_remove:]
 
805
    cleaned_after = []
 
806
    for cmd in after_remove:
 
807
        if isinstance(cmd, command.Deny):
 
808
            before_remove.append(cmd)
511
809
        else:
512
 
            commands.append(command.DenyByDefault())
513
 
 
514
 
    if options.checker is not None:
515
 
        commands.append(command.SetChecker(options.checker))
516
 
 
517
 
    if options.host is not None:
518
 
        commands.append(command.SetHost(options.host))
519
 
 
520
 
    if options.secret is not None:
521
 
        commands.append(command.SetSecret(options.secret))
522
 
 
523
 
    if options.timeout is not None:
524
 
        commands.append(command.SetTimeout(options.timeout))
525
 
 
526
 
    if options.extended_timeout:
527
 
        commands.append(
528
 
            command.SetExtendedTimeout(options.extended_timeout))
529
 
 
530
 
    if options.interval is not None:
531
 
        commands.append(command.SetInterval(options.interval))
532
 
 
533
 
    if options.approval_delay is not None:
534
 
        commands.append(
535
 
            command.SetApprovalDelay(options.approval_delay))
536
 
 
537
 
    if options.approval_duration is not None:
538
 
        commands.append(
539
 
            command.SetApprovalDuration(options.approval_duration))
 
810
            cleaned_after.append(cmd)
 
811
    if cleaned_after != after_remove:
 
812
        commands = before_remove + cleaned_after
540
813
 
541
814
    # If no command option has been given, show table of clients,
542
815
    # optionally verbosely
546
819
    return commands
547
820
 
548
821
 
549
 
class command(object):
 
822
class command:
550
823
    """A namespace for command classes"""
551
824
 
552
 
    class Base(object):
 
825
    class Base:
553
826
        """Abstract base class for commands"""
554
 
        def run(self, clients, bus=None, mandos=None):
 
827
        def run(self, clients, bus=None):
555
828
            """Normal commands should implement run_on_one_client(),
556
829
but commands which want to operate on all clients at the same time can
557
830
override this run() method instead.
558
831
"""
559
 
            self.mandos = mandos
560
 
            for clientpath, properties in clients.items():
561
 
                log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
562
 
                          dbus_busname, str(clientpath))
563
 
                client = bus.get_object(dbus_busname, clientpath)
 
832
            self.bus = bus
 
833
            for client, properties in clients.items():
564
834
                self.run_on_one_client(client, properties)
565
835
 
566
836
 
567
837
    class IsEnabled(Base):
568
 
        def run(self, clients, bus=None, mandos=None):
569
 
            client, properties = next(iter(clients.items()))
570
 
            if self.is_enabled(client, properties):
 
838
        def run(self, clients, bus=None):
 
839
            properties = next(iter(clients.values()))
 
840
            if properties["Enabled"]:
571
841
                sys.exit(0)
572
842
            sys.exit(1)
573
 
        def is_enabled(self, client, properties):
574
 
            return properties["Enabled"]
575
843
 
576
844
 
577
845
    class Approve(Base):
578
846
        def run_on_one_client(self, client, properties):
579
 
            log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
580
 
                      client.__dbus_object_path__,
581
 
                      client_dbus_interface)
582
 
            client.Approve(dbus.Boolean(True),
583
 
                           dbus_interface=client_dbus_interface)
 
847
            self.bus.call_client_method(client, "Approve", True)
584
848
 
585
849
 
586
850
    class Deny(Base):
587
851
        def run_on_one_client(self, client, properties):
588
 
            log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
589
 
                      client.__dbus_object_path__,
590
 
                      client_dbus_interface)
591
 
            client.Approve(dbus.Boolean(False),
592
 
                           dbus_interface=client_dbus_interface)
 
852
            self.bus.call_client_method(client, "Approve", False)
593
853
 
594
854
 
595
855
    class Remove(Base):
596
 
        def run_on_one_client(self, client, properties):
597
 
            log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)",
598
 
                      dbus_busname, server_dbus_path,
599
 
                      server_dbus_interface,
600
 
                      str(client.__dbus_object_path__))
601
 
            self.mandos.RemoveClient(client.__dbus_object_path__)
 
856
        def run(self, clients, bus):
 
857
            for clientpath in frozenset(clients.keys()):
 
858
                bus.call_server_method("RemoveClient", clientpath)
602
859
 
603
860
 
604
861
    class Output(Base):
614
871
 
615
872
 
616
873
    class DumpJSON(Output):
617
 
        def run(self, clients, bus=None, mandos=None):
618
 
            data = {client["Name"]:
619
 
                    {key: self.dbus_boolean_to_bool(client[key])
 
874
        def run(self, clients, bus=None):
 
875
            data = {properties["Name"]:
 
876
                    {key: properties[key]
620
877
                     for key in self.all_keywords}
621
 
                    for client in clients.values()}
622
 
            print(json.dumps(data, indent=4, separators=(',', ': ')))
623
 
 
624
 
        @staticmethod
625
 
        def dbus_boolean_to_bool(value):
626
 
            if isinstance(value, dbus.Boolean):
627
 
                value = bool(value)
628
 
            return value
 
878
                    for properties in clients.values()}
 
879
            print(json.dumps(data, indent=4, separators=(",", ": ")))
629
880
 
630
881
 
631
882
    class PrintTable(Output):
632
883
        def __init__(self, verbose=False):
633
884
            self.verbose = verbose
634
885
 
635
 
        def run(self, clients, bus=None, mandos=None):
 
886
        def run(self, clients, bus=None):
636
887
            default_keywords = ("Name", "Enabled", "Timeout",
637
888
                                "LastCheckedOK")
638
889
            keywords = default_keywords
640
891
                keywords = self.all_keywords
641
892
            print(self.TableOfClients(clients.values(), keywords))
642
893
 
643
 
        class TableOfClients(object):
 
894
        class TableOfClients:
644
895
            tableheaders = {
645
896
                "Name": "Name",
646
897
                "Enabled": "Enabled",
699
950
 
700
951
            @classmethod
701
952
            def valuetostring(cls, value, keyword):
702
 
                if isinstance(value, dbus.Boolean):
 
953
                if isinstance(value, bool):
703
954
                    return "Yes" if value else "No"
704
955
                if keyword in ("Timeout", "Interval", "ApprovalDelay",
705
956
                               "ApprovalDuration", "ExtendedTimeout"):
728
979
    class PropertySetter(Base):
729
980
        "Abstract class for Actions for setting one client property"
730
981
 
731
 
        def run_on_one_client(self, client, properties):
 
982
        def run_on_one_client(self, client, properties=None):
732
983
            """Set the Client's D-Bus property"""
733
 
            log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
734
 
                      client.__dbus_object_path__,
735
 
                      dbus.PROPERTIES_IFACE, client_dbus_interface,
736
 
                      self.propname, self.value_to_set
737
 
                      if not isinstance(self.value_to_set,
738
 
                                        dbus.Boolean)
739
 
                      else bool(self.value_to_set))
740
 
            client.Set(client_dbus_interface, self.propname,
741
 
                       self.value_to_set,
742
 
                       dbus_interface=dbus.PROPERTIES_IFACE)
 
984
            self.bus.set_client_property(client, self.propname,
 
985
                                         self.value_to_set)
743
986
 
744
987
        @property
745
988
        def propname(self):
748
991
 
749
992
    class Enable(PropertySetter):
750
993
        propname = "Enabled"
751
 
        value_to_set = dbus.Boolean(True)
 
994
        value_to_set = True
752
995
 
753
996
 
754
997
    class Disable(PropertySetter):
755
998
        propname = "Enabled"
756
 
        value_to_set = dbus.Boolean(False)
 
999
        value_to_set = False
757
1000
 
758
1001
 
759
1002
    class BumpTimeout(PropertySetter):
763
1006
 
764
1007
    class StartChecker(PropertySetter):
765
1008
        propname = "CheckerRunning"
766
 
        value_to_set = dbus.Boolean(True)
 
1009
        value_to_set = True
767
1010
 
768
1011
 
769
1012
    class StopChecker(PropertySetter):
770
1013
        propname = "CheckerRunning"
771
 
        value_to_set = dbus.Boolean(False)
 
1014
        value_to_set = False
772
1015
 
773
1016
 
774
1017
    class ApproveByDefault(PropertySetter):
775
1018
        propname = "ApprovedByDefault"
776
 
        value_to_set = dbus.Boolean(True)
 
1019
        value_to_set = True
777
1020
 
778
1021
 
779
1022
    class DenyByDefault(PropertySetter):
780
1023
        propname = "ApprovedByDefault"
781
 
        value_to_set = dbus.Boolean(False)
 
1024
        value_to_set = False
782
1025
 
783
1026
 
784
1027
    class PropertySetterValue(PropertySetter):
787
1030
        def __init__(self, value):
788
1031
            self.value_to_set = value
789
1032
 
 
1033
        @classmethod
 
1034
        def argparse(cls, argtype):
 
1035
            def cmdtype(arg):
 
1036
                return cls(argtype(arg))
 
1037
            return cmdtype
790
1038
 
791
1039
    class SetChecker(PropertySetterValue):
792
1040
        propname = "Checker"
880
1128
                                                     "output"))
881
1129
 
882
1130
 
 
1131
class Unique:
 
1132
    """Class for objects which exist only to be unique objects, since
 
1133
unittest.mock.sentinel only exists in Python 3.3"""
 
1134
 
 
1135
 
883
1136
class Test_string_to_delta(TestCaseWithAssertLogs):
884
1137
    # Just test basic RFC 3339 functionality here, the doc string for
885
1138
    # rfc3339_duration_to_delta() already has more comprehensive
886
 
    # tests, which is run by doctest.
 
1139
    # tests, which are run by doctest.
887
1140
 
888
1141
    def test_rfc3339_zero_seconds(self):
889
1142
        self.assertEqual(datetime.timedelta(),
913
1166
 
914
1167
    def test_actions_requires_client_or_all(self):
915
1168
        for action, value in self.actions.items():
916
 
            options = self.parser.parse_args()
917
 
            setattr(options, action, value)
 
1169
            args = self.actionargs(action, value)
918
1170
            with self.assertParseError():
919
 
                self.check_option_syntax(options)
 
1171
                self.parse_args(args)
920
1172
 
921
 
    # This mostly corresponds to the definition from has_actions() in
 
1173
    # This mostly corresponds to the definition from has_commands() in
922
1174
    # check_option_syntax()
923
1175
    actions = {
924
 
        # The actual values set here are not that important, but we do
925
 
        # at least stick to the correct types, even though they are
926
 
        # never used
927
 
        "enable": True,
928
 
        "disable": True,
929
 
        "bump_timeout": True,
930
 
        "start_checker": True,
931
 
        "stop_checker": True,
932
 
        "is_enabled": True,
933
 
        "remove": True,
934
 
        "checker": "x",
935
 
        "timeout": datetime.timedelta(),
936
 
        "extended_timeout": datetime.timedelta(),
937
 
        "interval": datetime.timedelta(),
938
 
        "approved_by_default": True,
939
 
        "approval_delay": datetime.timedelta(),
940
 
        "approval_duration": datetime.timedelta(),
941
 
        "host": "x",
942
 
        "secret": io.BytesIO(b"x"),
943
 
        "approve": True,
944
 
        "deny": True,
 
1176
        "--enable": None,
 
1177
        "--disable": None,
 
1178
        "--bump-timeout": None,
 
1179
        "--start-checker": None,
 
1180
        "--stop-checker": None,
 
1181
        "--is-enabled": None,
 
1182
        "--remove": None,
 
1183
        "--checker": "x",
 
1184
        "--timeout": "PT0S",
 
1185
        "--extended-timeout": "PT0S",
 
1186
        "--interval": "PT0S",
 
1187
        "--approve-by-default": None,
 
1188
        "--deny-by-default": None,
 
1189
        "--approval-delay": "PT0S",
 
1190
        "--approval-duration": "PT0S",
 
1191
        "--host": "hostname",
 
1192
        "--secret": "/dev/null",
 
1193
        "--approve": None,
 
1194
        "--deny": None,
945
1195
    }
946
1196
 
 
1197
    @staticmethod
 
1198
    def actionargs(action, value, *args):
 
1199
        if value is not None:
 
1200
            return [action, value] + list(args)
 
1201
        else:
 
1202
            return [action] + list(args)
 
1203
 
947
1204
    @contextlib.contextmanager
948
1205
    def assertParseError(self):
949
1206
        with self.assertRaises(SystemExit) as e:
954
1211
        # /argparse.html#exiting-methods
955
1212
        self.assertEqual(2, e.exception.code)
956
1213
 
 
1214
    def parse_args(self, args):
 
1215
        options = self.parser.parse_args(args)
 
1216
        check_option_syntax(self.parser, options)
 
1217
 
957
1218
    @staticmethod
958
1219
    @contextlib.contextmanager
959
1220
    def redirect_stderr_to_devnull():
970
1231
 
971
1232
    def test_actions_all_conflicts_with_verbose(self):
972
1233
        for action, value in self.actions.items():
973
 
            options = self.parser.parse_args()
974
 
            setattr(options, action, value)
975
 
            options.all = True
976
 
            options.verbose = True
 
1234
            args = self.actionargs(action, value, "--all",
 
1235
                                   "--verbose")
977
1236
            with self.assertParseError():
978
 
                self.check_option_syntax(options)
 
1237
                self.parse_args(args)
979
1238
 
980
1239
    def test_actions_with_client_conflicts_with_verbose(self):
981
1240
        for action, value in self.actions.items():
982
 
            options = self.parser.parse_args()
983
 
            setattr(options, action, value)
984
 
            options.verbose = True
985
 
            options.client = ["client"]
 
1241
            args = self.actionargs(action, value, "--verbose",
 
1242
                                   "client")
986
1243
            with self.assertParseError():
987
 
                self.check_option_syntax(options)
 
1244
                self.parse_args(args)
988
1245
 
989
1246
    def test_dump_json_conflicts_with_verbose(self):
990
 
        options = self.parser.parse_args()
991
 
        options.dump_json = True
992
 
        options.verbose = True
 
1247
        args = ["--dump-json", "--verbose"]
993
1248
        with self.assertParseError():
994
 
            self.check_option_syntax(options)
 
1249
            self.parse_args(args)
995
1250
 
996
1251
    def test_dump_json_conflicts_with_action(self):
997
1252
        for action, value in self.actions.items():
998
 
            options = self.parser.parse_args()
999
 
            setattr(options, action, value)
1000
 
            options.dump_json = True
 
1253
            args = self.actionargs(action, value, "--dump-json")
1001
1254
            with self.assertParseError():
1002
 
                self.check_option_syntax(options)
 
1255
                self.parse_args(args)
1003
1256
 
1004
1257
    def test_all_can_not_be_alone(self):
1005
 
        options = self.parser.parse_args()
1006
 
        options.all = True
 
1258
        args = ["--all"]
1007
1259
        with self.assertParseError():
1008
 
            self.check_option_syntax(options)
 
1260
            self.parse_args(args)
1009
1261
 
1010
1262
    def test_all_is_ok_with_any_action(self):
1011
1263
        for action, value in self.actions.items():
1012
 
            options = self.parser.parse_args()
1013
 
            setattr(options, action, value)
1014
 
            options.all = True
1015
 
            self.check_option_syntax(options)
 
1264
            args = self.actionargs(action, value, "--all")
 
1265
            self.parse_args(args)
1016
1266
 
1017
1267
    def test_any_action_is_ok_with_one_client(self):
1018
1268
        for action, value in self.actions.items():
1019
 
            options = self.parser.parse_args()
1020
 
            setattr(options, action, value)
1021
 
            options.client = ["client"]
1022
 
            self.check_option_syntax(options)
 
1269
            args = self.actionargs(action, value, "client")
 
1270
            self.parse_args(args)
1023
1271
 
1024
1272
    def test_one_client_with_all_actions_except_is_enabled(self):
1025
 
        options = self.parser.parse_args()
1026
1273
        for action, value in self.actions.items():
1027
 
            if action == "is_enabled":
 
1274
            if action == "--is-enabled":
1028
1275
                continue
1029
 
            setattr(options, action, value)
1030
 
        options.client = ["client"]
1031
 
        self.check_option_syntax(options)
 
1276
            args = self.actionargs(action, value, "client")
 
1277
            self.parse_args(args)
1032
1278
 
1033
1279
    def test_two_clients_with_all_actions_except_is_enabled(self):
1034
 
        options = self.parser.parse_args()
1035
1280
        for action, value in self.actions.items():
1036
 
            if action == "is_enabled":
 
1281
            if action == "--is-enabled":
1037
1282
                continue
1038
 
            setattr(options, action, value)
1039
 
        options.client = ["client1", "client2"]
1040
 
        self.check_option_syntax(options)
 
1283
            args = self.actionargs(action, value, "client1",
 
1284
                                   "client2")
 
1285
            self.parse_args(args)
1041
1286
 
1042
1287
    def test_two_clients_are_ok_with_actions_except_is_enabled(self):
1043
1288
        for action, value in self.actions.items():
1044
 
            if action == "is_enabled":
 
1289
            if action == "--is-enabled":
1045
1290
                continue
1046
 
            options = self.parser.parse_args()
1047
 
            setattr(options, action, value)
1048
 
            options.client = ["client1", "client2"]
1049
 
            self.check_option_syntax(options)
 
1291
            args = self.actionargs(action, value, "client1",
 
1292
                                   "client2")
 
1293
            self.parse_args(args)
1050
1294
 
1051
1295
    def test_is_enabled_fails_without_client(self):
1052
 
        options = self.parser.parse_args()
1053
 
        options.is_enabled = True
 
1296
        args = ["--is-enabled"]
1054
1297
        with self.assertParseError():
1055
 
            self.check_option_syntax(options)
 
1298
            self.parse_args(args)
1056
1299
 
1057
1300
    def test_is_enabled_fails_with_two_clients(self):
1058
 
        options = self.parser.parse_args()
1059
 
        options.is_enabled = True
1060
 
        options.client = ["client1", "client2"]
 
1301
        args = ["--is-enabled", "client1", "client2"]
1061
1302
        with self.assertParseError():
1062
 
            self.check_option_syntax(options)
 
1303
            self.parse_args(args)
1063
1304
 
1064
1305
    def test_remove_can_only_be_combined_with_action_deny(self):
1065
1306
        for action, value in self.actions.items():
1066
 
            if action in {"remove", "deny"}:
 
1307
            if action in {"--remove", "--deny"}:
1067
1308
                continue
1068
 
            options = self.parser.parse_args()
1069
 
            setattr(options, action, value)
1070
 
            options.all = True
1071
 
            options.remove = True
 
1309
            args = self.actionargs(action, value, "--all",
 
1310
                                   "--remove")
1072
1311
            with self.assertParseError():
1073
 
                self.check_option_syntax(options)
1074
 
 
1075
 
 
1076
 
class Test_get_mandos_dbus_object(TestCaseWithAssertLogs):
1077
 
    def test_calls_and_returns_get_object_on_bus(self):
1078
 
        class MockBus(object):
1079
 
            called = False
1080
 
            def get_object(mockbus_self, busname, dbus_path):
1081
 
                # Note that "self" is still the testcase instance,
1082
 
                # this MockBus instance is in "mockbus_self".
1083
 
                self.assertEqual(dbus_busname, busname)
1084
 
                self.assertEqual(server_dbus_path, dbus_path)
1085
 
                mockbus_self.called = True
1086
 
                return mockbus_self
1087
 
 
1088
 
        mockbus = get_mandos_dbus_object(bus=MockBus())
1089
 
        self.assertIsInstance(mockbus, MockBus)
1090
 
        self.assertTrue(mockbus.called)
1091
 
 
1092
 
    def test_logs_and_exits_on_dbus_error(self):
1093
 
        class FailingBusStub(object):
1094
 
            def get_object(self, busname, dbus_path):
1095
 
                raise dbus.exceptions.DBusException("Test")
1096
 
 
1097
 
        with self.assertLogs(log, logging.CRITICAL):
1098
 
            with self.assertRaises(SystemExit) as e:
1099
 
                bus = get_mandos_dbus_object(bus=FailingBusStub())
1100
 
 
1101
 
        if isinstance(e.exception.code, int):
1102
 
            self.assertNotEqual(0, e.exception.code)
1103
 
        else:
1104
 
            self.assertIsNotNone(e.exception.code)
1105
 
 
1106
 
 
1107
 
class Test_get_managed_objects(TestCaseWithAssertLogs):
1108
 
    def test_calls_and_returns_GetManagedObjects(self):
1109
 
        managed_objects = {"/clients/client": { "Name": "client"}}
1110
 
        class ObjectManagerStub(object):
1111
 
            def GetManagedObjects(self):
1112
 
                return managed_objects
1113
 
        retval = get_managed_objects(ObjectManagerStub())
1114
 
        self.assertDictEqual(managed_objects, retval)
1115
 
 
1116
 
    def test_logs_and_exits_on_dbus_error(self):
 
1312
                self.parse_args(args)
 
1313
 
 
1314
 
 
1315
class Test_dbus_exceptions(unittest.TestCase):
 
1316
 
 
1317
    def test_dbus_ConnectFailed_is_Error(self):
 
1318
        with self.assertRaises(dbus.Error):
 
1319
            raise dbus.ConnectFailed()
 
1320
 
 
1321
 
 
1322
class Test_dbus_MandosBus(unittest.TestCase):
 
1323
 
 
1324
    class MockMandosBus(dbus.MandosBus):
 
1325
        def __init__(self):
 
1326
            self._name = "se.recompile.Mandos"
 
1327
            self._server_path = "/"
 
1328
            self._server_interface = "se.recompile.Mandos"
 
1329
            self._client_interface = "se.recompile.Mandos.Client"
 
1330
            self.calls = []
 
1331
            self.call_method_return = Unique()
 
1332
 
 
1333
        def call_method(self, methodname, busname, objectpath,
 
1334
                        interface, *args):
 
1335
            self.calls.append((methodname, busname, objectpath,
 
1336
                               interface, args))
 
1337
            return self.call_method_return
 
1338
 
 
1339
    def setUp(self):
 
1340
        self.bus = self.MockMandosBus()
 
1341
 
 
1342
    def test_set_client_property(self):
 
1343
        self.bus.set_client_property("objectpath", "key", "value")
 
1344
        expected_call = ("Set", self.bus._name, "objectpath",
 
1345
                         "org.freedesktop.DBus.Properties",
 
1346
                         (self.bus._client_interface, "key", "value"))
 
1347
        self.assertIn(expected_call, self.bus.calls)
 
1348
 
 
1349
    def test_call_client_method(self):
 
1350
        ret = self.bus.call_client_method("objectpath", "methodname")
 
1351
        self.assertIs(self.bus.call_method_return, ret)
 
1352
        expected_call = ("methodname", self.bus._name, "objectpath",
 
1353
                         self.bus._client_interface, ())
 
1354
        self.assertIn(expected_call, self.bus.calls)
 
1355
 
 
1356
    def test_call_client_method_with_args(self):
 
1357
        args = (Unique(), Unique())
 
1358
        ret = self.bus.call_client_method("objectpath", "methodname",
 
1359
                                          *args)
 
1360
        self.assertIs(self.bus.call_method_return, ret)
 
1361
        expected_call = ("methodname", self.bus._name, "objectpath",
 
1362
                         self.bus._client_interface,
 
1363
                         (args[0], args[1]))
 
1364
        self.assertIn(expected_call, self.bus.calls)
 
1365
 
 
1366
    def test_get_clients_and_properties(self):
 
1367
        managed_objects = {
 
1368
            "objectpath": {
 
1369
                self.bus._client_interface: {
 
1370
                    "key": "value",
 
1371
                    "bool": True,
 
1372
                },
 
1373
                "irrelevant_interface": {
 
1374
                    "key": "othervalue",
 
1375
                    "bool": False,
 
1376
                },
 
1377
            },
 
1378
            "other_objectpath": {
 
1379
                "other_irrelevant_interface": {
 
1380
                    "key": "value 3",
 
1381
                    "bool": None,
 
1382
                },
 
1383
            },
 
1384
        }
 
1385
        expected_clients_and_properties = {
 
1386
            "objectpath": {
 
1387
                "key": "value",
 
1388
                "bool": True,
 
1389
            }
 
1390
        }
 
1391
        self.bus.call_method_return = managed_objects
 
1392
        ret = self.bus.get_clients_and_properties()
 
1393
        self.assertDictEqual(expected_clients_and_properties, ret)
 
1394
        expected_call = ("GetManagedObjects", self.bus._name,
 
1395
                         self.bus._server_path,
 
1396
                         "org.freedesktop.DBus.ObjectManager", ())
 
1397
        self.assertIn(expected_call, self.bus.calls)
 
1398
 
 
1399
    def test_call_server_method(self):
 
1400
        ret = self.bus.call_server_method("methodname")
 
1401
        self.assertIs(self.bus.call_method_return, ret)
 
1402
        expected_call = ("methodname", self.bus._name,
 
1403
                         self.bus._server_path,
 
1404
                         self.bus._server_interface, ())
 
1405
        self.assertIn(expected_call, self.bus.calls)
 
1406
 
 
1407
    def test_call_server_method_with_args(self):
 
1408
        args = (Unique(), Unique())
 
1409
        ret = self.bus.call_server_method("methodname", *args)
 
1410
        self.assertIs(self.bus.call_method_return, ret)
 
1411
        expected_call = ("methodname", self.bus._name,
 
1412
                         self.bus._server_path,
 
1413
                         self.bus._server_interface,
 
1414
                         (args[0], args[1]))
 
1415
        self.assertIn(expected_call, self.bus.calls)
 
1416
 
 
1417
 
 
1418
class Test_dbus_python_adapter_SystemBus(TestCaseWithAssertLogs):
 
1419
 
 
1420
    def MockDBusPython_func(self, func):
 
1421
        class mock_dbus_python:
 
1422
            """mock dbus-python module"""
 
1423
            class exceptions:
 
1424
                """Pseudo-namespace"""
 
1425
                class DBusException(Exception):
 
1426
                    pass
 
1427
            class SystemBus:
 
1428
                @staticmethod
 
1429
                def get_object(busname, objectpath):
 
1430
                    DBusObject = collections.namedtuple(
 
1431
                        "DBusObject", ("methodname", "Set"))
 
1432
                    def method(*args, **kwargs):
 
1433
                        self.assertEqual({"dbus_interface":
 
1434
                                          "interface"},
 
1435
                                         kwargs)
 
1436
                        return func(*args)
 
1437
                    def set_property(interface, key, value,
 
1438
                                     dbus_interface=None):
 
1439
                        self.assertEqual(
 
1440
                            "org.freedesktop.DBus.Properties",
 
1441
                            dbus_interface)
 
1442
                        self.assertEqual("Secret", key)
 
1443
                        return func(interface, key, value,
 
1444
                                    dbus_interface=dbus_interface)
 
1445
                    return DBusObject(methodname=method,
 
1446
                                      Set=set_property)
 
1447
            class Boolean:
 
1448
                def __init__(self, value):
 
1449
                    self.value = bool(value)
 
1450
                def __bool__(self):
 
1451
                    return self.value
 
1452
                if sys.version_info.major == 2:
 
1453
                    __nonzero__ = __bool__
 
1454
            class ObjectPath(str):
 
1455
                pass
 
1456
            class Dictionary(dict):
 
1457
                pass
 
1458
            class ByteArray(bytes):
 
1459
                pass
 
1460
        return mock_dbus_python
 
1461
 
 
1462
    def call_method(self, bus, methodname, busname, objectpath,
 
1463
                    interface, *args):
 
1464
        with self.assertLogs(log, logging.DEBUG):
 
1465
            return bus.call_method(methodname, busname, objectpath,
 
1466
                                   interface, *args)
 
1467
 
 
1468
    def test_call_method_returns(self):
 
1469
        expected_method_return = Unique()
 
1470
        method_args = (Unique(), Unique())
 
1471
        def func(*args):
 
1472
            self.assertEqual(len(method_args), len(args))
 
1473
            for marg, arg in zip(method_args, args):
 
1474
                self.assertIs(marg, arg)
 
1475
            return expected_method_return
 
1476
        mock_dbus_python = self.MockDBusPython_func(func)
 
1477
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
 
1478
        ret = self.call_method(bus, "methodname", "busname",
 
1479
                               "objectpath", "interface",
 
1480
                               *method_args)
 
1481
        self.assertIs(ret, expected_method_return)
 
1482
 
 
1483
    def test_call_method_filters_bool_true(self):
 
1484
        def func():
 
1485
            return method_return
 
1486
        mock_dbus_python = self.MockDBusPython_func(func)
 
1487
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
 
1488
        method_return = mock_dbus_python.Boolean(True)
 
1489
        ret = self.call_method(bus, "methodname", "busname",
 
1490
                               "objectpath", "interface")
 
1491
        self.assertTrue(ret)
 
1492
        self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
 
1493
 
 
1494
    def test_call_method_filters_bool_false(self):
 
1495
        def func():
 
1496
            return method_return
 
1497
        mock_dbus_python = self.MockDBusPython_func(func)
 
1498
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
 
1499
        method_return = mock_dbus_python.Boolean(False)
 
1500
        ret = self.call_method(bus, "methodname", "busname",
 
1501
                               "objectpath", "interface")
 
1502
        self.assertFalse(ret)
 
1503
        self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
 
1504
 
 
1505
    def test_call_method_filters_objectpath(self):
 
1506
        def func():
 
1507
            return method_return
 
1508
        mock_dbus_python = self.MockDBusPython_func(func)
 
1509
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
 
1510
        method_return = mock_dbus_python.ObjectPath("objectpath")
 
1511
        ret = self.call_method(bus, "methodname", "busname",
 
1512
                               "objectpath", "interface")
 
1513
        self.assertEqual("objectpath", ret)
 
1514
        self.assertIsNot("objectpath", ret)
 
1515
        self.assertNotIsInstance(ret, mock_dbus_python.ObjectPath)
 
1516
 
 
1517
    def test_call_method_filters_booleans_in_dict(self):
 
1518
        def func():
 
1519
            return method_return
 
1520
        mock_dbus_python = self.MockDBusPython_func(func)
 
1521
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
 
1522
        method_return = mock_dbus_python.Dictionary(
 
1523
        {mock_dbus_python.Boolean(True):
 
1524
         mock_dbus_python.Boolean(False),
 
1525
         mock_dbus_python.Boolean(False):
 
1526
         mock_dbus_python.Boolean(True)})
 
1527
        ret = self.call_method(bus, "methodname", "busname",
 
1528
                               "objectpath", "interface")
 
1529
        expected_method_return = {True: False,
 
1530
                                  False: True}
 
1531
        self.assertEqual(expected_method_return, ret)
 
1532
        self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
 
1533
 
 
1534
    def test_call_method_filters_objectpaths_in_dict(self):
 
1535
        def func():
 
1536
            return method_return
 
1537
        mock_dbus_python = self.MockDBusPython_func(func)
 
1538
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
 
1539
        method_return = mock_dbus_python.Dictionary(
 
1540
        {mock_dbus_python.ObjectPath("objectpath_key_1"):
 
1541
         mock_dbus_python.ObjectPath("objectpath_value_1"),
 
1542
         mock_dbus_python.ObjectPath("objectpath_key_2"):
 
1543
         mock_dbus_python.ObjectPath("objectpath_value_2")})
 
1544
        ret = self.call_method(bus, "methodname", "busname",
 
1545
                               "objectpath", "interface")
 
1546
        expected_method_return = {str(key): str(value)
 
1547
                                  for key, value in
 
1548
                                  method_return.items()}
 
1549
        self.assertEqual(expected_method_return, ret)
 
1550
        self.assertIsInstance(ret, dict)
 
1551
        self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
 
1552
 
 
1553
    def test_call_method_filters_dict_in_dict(self):
 
1554
        def func():
 
1555
            return method_return
 
1556
        mock_dbus_python = self.MockDBusPython_func(func)
 
1557
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
 
1558
        method_return = mock_dbus_python.Dictionary(
 
1559
        {"key1": mock_dbus_python.Dictionary({"key11": "value11",
 
1560
                                              "key12": "value12"}),
 
1561
         "key2": mock_dbus_python.Dictionary({"key21": "value21",
 
1562
                                              "key22": "value22"})})
 
1563
        ret = self.call_method(bus, "methodname", "busname",
 
1564
                               "objectpath", "interface")
 
1565
        expected_method_return = {
 
1566
            "key1": {"key11": "value11",
 
1567
                     "key12": "value12"},
 
1568
            "key2": {"key21": "value21",
 
1569
                     "key22": "value22"},
 
1570
        }
 
1571
        self.assertEqual(expected_method_return, ret)
 
1572
        self.assertIsInstance(ret, dict)
 
1573
        self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
 
1574
        for key, value in ret.items():
 
1575
            self.assertIsInstance(value, dict)
 
1576
            self.assertEqual(expected_method_return[key], value)
 
1577
            self.assertNotIsInstance(value,
 
1578
                                     mock_dbus_python.Dictionary)
 
1579
 
 
1580
    def test_call_method_filters_dict_three_deep(self):
 
1581
        def func():
 
1582
            return method_return
 
1583
        mock_dbus_python = self.MockDBusPython_func(func)
 
1584
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
 
1585
        method_return = mock_dbus_python.Dictionary(
 
1586
            {"key1":
 
1587
             mock_dbus_python.Dictionary(
 
1588
                 {"key2":
 
1589
                  mock_dbus_python.Dictionary(
 
1590
                      {"key3":
 
1591
                       mock_dbus_python.Boolean(True),
 
1592
                       }),
 
1593
                  }),
 
1594
             })
 
1595
        ret = self.call_method(bus, "methodname", "busname",
 
1596
                               "objectpath", "interface")
 
1597
        expected_method_return = {"key1": {"key2": {"key3": True}}}
 
1598
        self.assertEqual(expected_method_return, ret)
 
1599
        self.assertIsInstance(ret, dict)
 
1600
        self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
 
1601
        self.assertIsInstance(ret["key1"], dict)
 
1602
        self.assertNotIsInstance(ret["key1"],
 
1603
                                 mock_dbus_python.Dictionary)
 
1604
        self.assertIsInstance(ret["key1"]["key2"], dict)
 
1605
        self.assertNotIsInstance(ret["key1"]["key2"],
 
1606
                                 mock_dbus_python.Dictionary)
 
1607
        self.assertTrue(ret["key1"]["key2"]["key3"])
 
1608
        self.assertNotIsInstance(ret["key1"]["key2"]["key3"],
 
1609
                                 mock_dbus_python.Boolean)
 
1610
 
 
1611
    def test_call_method_handles_exception(self):
1117
1612
        dbus_logger = logging.getLogger("dbus.proxies")
1118
1613
 
1119
 
        class ObjectManagerFailingStub(object):
1120
 
            def GetManagedObjects(self):
1121
 
                dbus_logger.error("Test")
1122
 
                raise dbus.exceptions.DBusException("Test")
 
1614
        def func():
 
1615
            dbus_logger.error("Test")
 
1616
            raise mock_dbus_python.exceptions.DBusException()
 
1617
 
 
1618
        mock_dbus_python = self.MockDBusPython_func(func)
 
1619
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1123
1620
 
1124
1621
        class CountingHandler(logging.Handler):
1125
1622
            count = 0
1131
1628
        dbus_logger.addHandler(counting_handler)
1132
1629
 
1133
1630
        try:
1134
 
            with self.assertLogs(log, logging.CRITICAL) as watcher:
1135
 
                with self.assertRaises(SystemExit) as e:
1136
 
                    get_managed_objects(ObjectManagerFailingStub())
 
1631
            with self.assertRaises(dbus.Error) as e:
 
1632
                self.call_method(bus, "methodname", "busname",
 
1633
                                 "objectpath", "interface")
1137
1634
        finally:
1138
1635
            dbus_logger.removeFilter(counting_handler)
1139
1636
 
 
1637
        self.assertNotIsInstance(e.exception, dbus.ConnectFailed)
 
1638
 
1140
1639
        # Make sure the dbus logger was suppressed
1141
1640
        self.assertEqual(0, counting_handler.count)
1142
1641
 
1143
 
        # Test that the dbus_logger still works
1144
 
        with self.assertLogs(dbus_logger, logging.ERROR):
1145
 
            dbus_logger.error("Test")
1146
 
 
1147
 
        if isinstance(e.exception.code, int):
1148
 
            self.assertNotEqual(0, e.exception.code)
1149
 
        else:
1150
 
            self.assertIsNotNone(e.exception.code)
 
1642
    def test_Set_Secret_sends_bytearray(self):
 
1643
        ret = [None]
 
1644
        def func(*args, **kwargs):
 
1645
            ret[0] = (args, kwargs)
 
1646
        mock_dbus_python = self.MockDBusPython_func(func)
 
1647
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
 
1648
        bus.set_client_property("objectpath", "Secret", "value")
 
1649
        expected_call = (("se.recompile.Mandos.Client", "Secret",
 
1650
                          mock_dbus_python.ByteArray(b"value")),
 
1651
                         {"dbus_interface":
 
1652
                          "org.freedesktop.DBus.Properties"})
 
1653
        self.assertEqual(expected_call, ret[0])
 
1654
        if sys.version_info.major == 2:
 
1655
            self.assertIsInstance(ret[0][0][-1],
 
1656
                                  mock_dbus_python.ByteArray)
 
1657
 
 
1658
    def test_get_object_converts_to_correct_exception(self):
 
1659
        bus = dbus_python_adapter.SystemBus(
 
1660
            self.fake_dbus_python_raises_exception_on_connect)
 
1661
        with self.assertRaises(dbus.ConnectFailed):
 
1662
            self.call_method(bus, "methodname", "busname",
 
1663
                             "objectpath", "interface")
 
1664
 
 
1665
    class fake_dbus_python_raises_exception_on_connect:
 
1666
        """fake dbus-python module"""
 
1667
        class exceptions:
 
1668
            """Pseudo-namespace"""
 
1669
            class DBusException(Exception):
 
1670
                pass
 
1671
 
 
1672
        @classmethod
 
1673
        def SystemBus(cls):
 
1674
            def get_object(busname, objectpath):
 
1675
                raise cls.exceptions.DBusException()
 
1676
            Bus = collections.namedtuple("Bus", ["get_object"])
 
1677
            return Bus(get_object=get_object)
 
1678
 
 
1679
 
 
1680
class Test_dbus_python_adapter_CachingBus(unittest.TestCase):
 
1681
    class mock_dbus_python:
 
1682
        """mock dbus-python modules"""
 
1683
        class SystemBus:
 
1684
            @staticmethod
 
1685
            def get_object(busname, objectpath):
 
1686
                return Unique()
 
1687
 
 
1688
    def setUp(self):
 
1689
        self.bus = dbus_python_adapter.CachingBus(
 
1690
            self.mock_dbus_python)
 
1691
 
 
1692
    def test_returns_distinct_objectpaths(self):
 
1693
        obj1 = self.bus.get_object("busname", "objectpath1")
 
1694
        self.assertIsInstance(obj1, Unique)
 
1695
        obj2 = self.bus.get_object("busname", "objectpath2")
 
1696
        self.assertIsInstance(obj2, Unique)
 
1697
        self.assertIsNot(obj1, obj2)
 
1698
 
 
1699
    def test_returns_distinct_busnames(self):
 
1700
        obj1 = self.bus.get_object("busname1", "objectpath")
 
1701
        self.assertIsInstance(obj1, Unique)
 
1702
        obj2 = self.bus.get_object("busname2", "objectpath")
 
1703
        self.assertIsInstance(obj2, Unique)
 
1704
        self.assertIsNot(obj1, obj2)
 
1705
 
 
1706
    def test_returns_distinct_both(self):
 
1707
        obj1 = self.bus.get_object("busname1", "objectpath")
 
1708
        self.assertIsInstance(obj1, Unique)
 
1709
        obj2 = self.bus.get_object("busname2", "objectpath")
 
1710
        self.assertIsInstance(obj2, Unique)
 
1711
        self.assertIsNot(obj1, obj2)
 
1712
 
 
1713
    def test_returns_same(self):
 
1714
        obj1 = self.bus.get_object("busname", "objectpath")
 
1715
        self.assertIsInstance(obj1, Unique)
 
1716
        obj2 = self.bus.get_object("busname", "objectpath")
 
1717
        self.assertIsInstance(obj2, Unique)
 
1718
        self.assertIs(obj1, obj2)
 
1719
 
 
1720
    def test_returns_same_old(self):
 
1721
        obj1 = self.bus.get_object("busname1", "objectpath1")
 
1722
        self.assertIsInstance(obj1, Unique)
 
1723
        obj2 = self.bus.get_object("busname2", "objectpath2")
 
1724
        self.assertIsInstance(obj2, Unique)
 
1725
        obj1b = self.bus.get_object("busname1", "objectpath1")
 
1726
        self.assertIsInstance(obj1b, Unique)
 
1727
        self.assertIsNot(obj1, obj2)
 
1728
        self.assertIsNot(obj2, obj1b)
 
1729
        self.assertIs(obj1, obj1b)
 
1730
 
 
1731
 
 
1732
class Test_pydbus_adapter_SystemBus(TestCaseWithAssertLogs):
 
1733
 
 
1734
    def Stub_pydbus_func(self, func):
 
1735
        class stub_pydbus:
 
1736
            """stub pydbus module"""
 
1737
            class SystemBus:
 
1738
                @staticmethod
 
1739
                def get(busname, objectpath):
 
1740
                    DBusObject = collections.namedtuple(
 
1741
                        "DBusObject", ("methodname",))
 
1742
                    return {"interface":
 
1743
                            DBusObject(methodname=func)}
 
1744
        return stub_pydbus
 
1745
 
 
1746
    def call_method(self, bus, methodname, busname, objectpath,
 
1747
                    interface, *args):
 
1748
        with self.assertLogs(log, logging.DEBUG):
 
1749
            return bus.call_method(methodname, busname, objectpath,
 
1750
                                   interface, *args)
 
1751
 
 
1752
    def test_call_method_returns(self):
 
1753
        expected_method_return = Unique()
 
1754
        method_args = (Unique(), Unique())
 
1755
        def func(*args):
 
1756
            self.assertEqual(len(method_args), len(args))
 
1757
            for marg, arg in zip(method_args, args):
 
1758
                self.assertIs(marg, arg)
 
1759
            return expected_method_return
 
1760
        stub_pydbus = self.Stub_pydbus_func(func)
 
1761
        bus = pydbus_adapter.SystemBus(stub_pydbus)
 
1762
        ret = self.call_method(bus, "methodname", "busname",
 
1763
                               "objectpath", "interface",
 
1764
                               *method_args)
 
1765
        self.assertIs(ret, expected_method_return)
 
1766
 
 
1767
    def test_call_method_handles_exception(self):
 
1768
        dbus_logger = logging.getLogger("dbus.proxies")
 
1769
 
 
1770
        def func():
 
1771
            raise gi.repository.GLib.Error()
 
1772
 
 
1773
        stub_pydbus = self.Stub_pydbus_func(func)
 
1774
        bus = pydbus_adapter.SystemBus(stub_pydbus)
 
1775
 
 
1776
        with self.assertRaises(dbus.Error) as e:
 
1777
            self.call_method(bus, "methodname", "busname",
 
1778
                             "objectpath", "interface")
 
1779
 
 
1780
        self.assertNotIsInstance(e.exception, dbus.ConnectFailed)
 
1781
 
 
1782
    def test_get_converts_to_correct_exception(self):
 
1783
        bus = pydbus_adapter.SystemBus(
 
1784
            self.fake_pydbus_raises_exception_on_connect)
 
1785
        with self.assertRaises(dbus.ConnectFailed):
 
1786
            self.call_method(bus, "methodname", "busname",
 
1787
                             "objectpath", "interface")
 
1788
 
 
1789
    class fake_pydbus_raises_exception_on_connect:
 
1790
        """fake dbus-python module"""
 
1791
        @classmethod
 
1792
        def SystemBus(cls):
 
1793
            def get(busname, objectpath):
 
1794
                raise gi.repository.GLib.Error()
 
1795
            Bus = collections.namedtuple("Bus", ["get"])
 
1796
            return Bus(get=get)
 
1797
 
 
1798
    def test_set_property_uses_setattr(self):
 
1799
        class Object:
 
1800
            pass
 
1801
        obj = Object()
 
1802
        class pydbus_spy:
 
1803
            class SystemBus:
 
1804
                @staticmethod
 
1805
                def get(busname, objectpath):
 
1806
                    return {"interface": obj}
 
1807
        bus = pydbus_adapter.SystemBus(pydbus_spy)
 
1808
        value = Unique()
 
1809
        bus.set_property("busname", "objectpath", "interface", "key",
 
1810
                         value)
 
1811
        self.assertIs(value, obj.key)
 
1812
 
 
1813
    def test_get_suppresses_xml_deprecation_warning(self):
 
1814
        if sys.version_info.major >= 3:
 
1815
            return
 
1816
        class stub_pydbus_get:
 
1817
            class SystemBus:
 
1818
                @staticmethod
 
1819
                def get(busname, objectpath):
 
1820
                    warnings.warn_explicit(
 
1821
                        "deprecated", DeprecationWarning,
 
1822
                        "xml.etree.ElementTree", 0)
 
1823
        bus = pydbus_adapter.SystemBus(stub_pydbus_get)
 
1824
        with warnings.catch_warnings(record=True) as w:
 
1825
            warnings.simplefilter("always")
 
1826
            bus.get("busname", "objectpath")
 
1827
            self.assertEqual(0, len(w))
 
1828
 
 
1829
 
 
1830
class Test_pydbus_adapter_CachingBus(unittest.TestCase):
 
1831
    class stub_pydbus:
 
1832
        """stub pydbus module"""
 
1833
        class SystemBus:
 
1834
            @staticmethod
 
1835
            def get(busname, objectpath):
 
1836
                return Unique()
 
1837
 
 
1838
    def setUp(self):
 
1839
        self.bus = pydbus_adapter.CachingBus(self.stub_pydbus)
 
1840
 
 
1841
    def test_returns_distinct_objectpaths(self):
 
1842
        obj1 = self.bus.get("busname", "objectpath1")
 
1843
        self.assertIsInstance(obj1, Unique)
 
1844
        obj2 = self.bus.get("busname", "objectpath2")
 
1845
        self.assertIsInstance(obj2, Unique)
 
1846
        self.assertIsNot(obj1, obj2)
 
1847
 
 
1848
    def test_returns_distinct_busnames(self):
 
1849
        obj1 = self.bus.get("busname1", "objectpath")
 
1850
        self.assertIsInstance(obj1, Unique)
 
1851
        obj2 = self.bus.get("busname2", "objectpath")
 
1852
        self.assertIsInstance(obj2, Unique)
 
1853
        self.assertIsNot(obj1, obj2)
 
1854
 
 
1855
    def test_returns_distinct_both(self):
 
1856
        obj1 = self.bus.get("busname1", "objectpath")
 
1857
        self.assertIsInstance(obj1, Unique)
 
1858
        obj2 = self.bus.get("busname2", "objectpath")
 
1859
        self.assertIsInstance(obj2, Unique)
 
1860
        self.assertIsNot(obj1, obj2)
 
1861
 
 
1862
    def test_returns_same(self):
 
1863
        obj1 = self.bus.get("busname", "objectpath")
 
1864
        self.assertIsInstance(obj1, Unique)
 
1865
        obj2 = self.bus.get("busname", "objectpath")
 
1866
        self.assertIsInstance(obj2, Unique)
 
1867
        self.assertIs(obj1, obj2)
 
1868
 
 
1869
    def test_returns_same_old(self):
 
1870
        obj1 = self.bus.get("busname1", "objectpath1")
 
1871
        self.assertIsInstance(obj1, Unique)
 
1872
        obj2 = self.bus.get("busname2", "objectpath2")
 
1873
        self.assertIsInstance(obj2, Unique)
 
1874
        obj1b = self.bus.get("busname1", "objectpath1")
 
1875
        self.assertIsInstance(obj1b, Unique)
 
1876
        self.assertIsNot(obj1, obj2)
 
1877
        self.assertIsNot(obj2, obj1b)
 
1878
        self.assertIs(obj1, obj1b)
 
1879
 
 
1880
 
 
1881
class Test_dbussy_adapter_SystemBus(TestCaseWithAssertLogs):
 
1882
 
 
1883
    class dummy_dbussy:
 
1884
        class DBUS:
 
1885
            class ObjectPath(str):
 
1886
                pass
 
1887
        class DBusError(Exception):
 
1888
            pass
 
1889
 
 
1890
    def fake_ravel_func(self, func):
 
1891
        class fake_ravel:
 
1892
            @staticmethod
 
1893
            def system_bus():
 
1894
                class DBusInterfaceProxy:
 
1895
                    @staticmethod
 
1896
                    def methodname(*args):
 
1897
                        return [func(*args)]
 
1898
                class DBusObject:
 
1899
                    @staticmethod
 
1900
                    def get_interface(interface):
 
1901
                        if interface == "interface":
 
1902
                            return DBusInterfaceProxy()
 
1903
                return {"busname": {"objectpath": DBusObject()}}
 
1904
        return fake_ravel
 
1905
 
 
1906
    def call_method(self, bus, methodname, busname, objectpath,
 
1907
                    interface, *args):
 
1908
        with self.assertLogs(log, logging.DEBUG):
 
1909
            return bus.call_method(methodname, busname, objectpath,
 
1910
                                   interface, *args)
 
1911
 
 
1912
    def test_call_method_returns(self):
 
1913
        expected_method_return = Unique()
 
1914
        method_args = (Unique(), Unique())
 
1915
        def func(*args):
 
1916
            self.assertEqual(len(method_args), len(args))
 
1917
            for marg, arg in zip(method_args, args):
 
1918
                self.assertIs(marg, arg)
 
1919
            return expected_method_return
 
1920
        fake_ravel = self.fake_ravel_func(func)
 
1921
        bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
 
1922
        ret = self.call_method(bus, "methodname", "busname",
 
1923
                               "objectpath", "interface",
 
1924
                               *method_args)
 
1925
        self.assertIs(ret, expected_method_return)
 
1926
 
 
1927
    def test_call_method_filters_objectpath(self):
 
1928
        def func():
 
1929
            return method_return
 
1930
        fake_ravel = self.fake_ravel_func(func)
 
1931
        bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
 
1932
        method_return = (self.dummy_dbussy.DBUS
 
1933
                         .ObjectPath("objectpath"))
 
1934
        ret = self.call_method(bus, "methodname", "busname",
 
1935
                               "objectpath", "interface")
 
1936
        self.assertEqual("objectpath", ret)
 
1937
        self.assertNotIsInstance(ret,
 
1938
                                 self.dummy_dbussy.DBUS.ObjectPath)
 
1939
 
 
1940
    def test_call_method_filters_objectpaths_in_dict(self):
 
1941
        ObjectPath = self.dummy_dbussy.DBUS.ObjectPath
 
1942
        def func():
 
1943
            return method_return
 
1944
        fake_ravel = self.fake_ravel_func(func)
 
1945
        bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
 
1946
        method_return = {
 
1947
            ObjectPath("objectpath_key_1"):
 
1948
            ObjectPath("objectpath_value_1"),
 
1949
            ObjectPath("objectpath_key_2"):
 
1950
            ObjectPath("objectpath_value_2"),
 
1951
        }
 
1952
        ret = self.call_method(bus, "methodname", "busname",
 
1953
                               "objectpath", "interface")
 
1954
        expected_method_return = {str(key): str(value)
 
1955
                                  for key, value in
 
1956
                                  method_return.items()}
 
1957
        for key, value in ret.items():
 
1958
            self.assertNotIsInstance(key, ObjectPath)
 
1959
            self.assertNotIsInstance(value, ObjectPath)
 
1960
        self.assertEqual(expected_method_return, ret)
 
1961
        self.assertIsInstance(ret, dict)
 
1962
 
 
1963
    def test_call_method_filters_objectpaths_in_dict_in_dict(self):
 
1964
        ObjectPath = self.dummy_dbussy.DBUS.ObjectPath
 
1965
        def func():
 
1966
            return method_return
 
1967
        fake_ravel = self.fake_ravel_func(func)
 
1968
        bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
 
1969
        method_return = {
 
1970
            ObjectPath("key1"): {
 
1971
                ObjectPath("key11"): ObjectPath("value11"),
 
1972
                ObjectPath("key12"): ObjectPath("value12"),
 
1973
            },
 
1974
            ObjectPath("key2"): {
 
1975
                ObjectPath("key21"): ObjectPath("value21"),
 
1976
                ObjectPath("key22"): ObjectPath("value22"),
 
1977
            },
 
1978
        }
 
1979
        ret = self.call_method(bus, "methodname", "busname",
 
1980
                               "objectpath", "interface")
 
1981
        expected_method_return = {
 
1982
            "key1": {"key11": "value11",
 
1983
                     "key12": "value12"},
 
1984
            "key2": {"key21": "value21",
 
1985
                     "key22": "value22"},
 
1986
        }
 
1987
        self.assertEqual(expected_method_return, ret)
 
1988
        for key, value in ret.items():
 
1989
            self.assertIsInstance(value, dict)
 
1990
            self.assertEqual(expected_method_return[key], value)
 
1991
            self.assertNotIsInstance(key, ObjectPath)
 
1992
            for inner_key, inner_value in value.items():
 
1993
                self.assertIsInstance(value, dict)
 
1994
                self.assertEqual(
 
1995
                    expected_method_return[key][inner_key],
 
1996
                    inner_value)
 
1997
                self.assertNotIsInstance(key, ObjectPath)
 
1998
 
 
1999
    def test_call_method_filters_objectpaths_in_dict_three_deep(self):
 
2000
        ObjectPath = self.dummy_dbussy.DBUS.ObjectPath
 
2001
        def func():
 
2002
            return method_return
 
2003
        fake_ravel = self.fake_ravel_func(func)
 
2004
        bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
 
2005
        method_return = {
 
2006
            ObjectPath("key1"): {
 
2007
                ObjectPath("key2"): {
 
2008
                    ObjectPath("key3"): ObjectPath("value"),
 
2009
                },
 
2010
            },
 
2011
        }
 
2012
        ret = self.call_method(bus, "methodname", "busname",
 
2013
                               "objectpath", "interface")
 
2014
        expected_method_return = {"key1": {"key2": {"key3": "value"}}}
 
2015
        self.assertEqual(expected_method_return, ret)
 
2016
        self.assertIsInstance(ret, dict)
 
2017
        self.assertNotIsInstance(next(iter(ret.keys())), ObjectPath)
 
2018
        self.assertIsInstance(ret["key1"], dict)
 
2019
        self.assertNotIsInstance(next(iter(ret["key1"].keys())),
 
2020
                                 ObjectPath)
 
2021
        self.assertIsInstance(ret["key1"]["key2"], dict)
 
2022
        self.assertNotIsInstance(
 
2023
            next(iter(ret["key1"]["key2"].keys())),
 
2024
            ObjectPath)
 
2025
        self.assertEqual("value", ret["key1"]["key2"]["key3"])
 
2026
        self.assertNotIsInstance(ret["key1"]["key2"]["key3"],
 
2027
                                 self.dummy_dbussy.DBUS.ObjectPath)
 
2028
 
 
2029
    def test_call_method_handles_exception(self):
 
2030
        def func():
 
2031
            raise self.dummy_dbussy.DBusError()
 
2032
 
 
2033
        fake_ravel = self.fake_ravel_func(func)
 
2034
        bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
 
2035
 
 
2036
        with self.assertRaises(dbus.Error) as e:
 
2037
            self.call_method(bus, "methodname", "busname",
 
2038
                             "objectpath", "interface")
 
2039
 
 
2040
        self.assertNotIsInstance(e.exception, dbus.ConnectFailed)
 
2041
 
 
2042
    def test_get_object_converts_to_correct_exception(self):
 
2043
        class fake_ravel_raises_exception_on_connect:
 
2044
            @staticmethod
 
2045
            def system_bus():
 
2046
                class Bus:
 
2047
                    @staticmethod
 
2048
                    def __getitem__(key):
 
2049
                        if key == "objectpath":
 
2050
                            raise self.dummy_dbussy.DBusError()
 
2051
                        raise Exception(key)
 
2052
                return {"busname": Bus()}
 
2053
        def func():
 
2054
            raise self.dummy_dbussy.DBusError()
 
2055
        bus = dbussy_adapter.SystemBus(
 
2056
            self.dummy_dbussy,
 
2057
            fake_ravel_raises_exception_on_connect)
 
2058
        with self.assertRaises(dbus.ConnectFailed):
 
2059
            self.call_method(bus, "methodname", "busname",
 
2060
                             "objectpath", "interface")
1151
2061
 
1152
2062
 
1153
2063
class Test_commands_from_options(unittest.TestCase):
 
2064
 
1154
2065
    def setUp(self):
1155
2066
        self.parser = argparse.ArgumentParser()
1156
2067
        add_command_line_options(self.parser)
1159
2070
        self.assert_command_from_args(["--is-enabled", "client"],
1160
2071
                                      command.IsEnabled)
1161
2072
 
1162
 
    def assert_command_from_args(self, args, command_cls,
1163
 
                                 **cmd_attrs):
 
2073
    def assert_command_from_args(self, args, command_cls, length=1,
 
2074
                                 clients=None, **cmd_attrs):
1164
2075
        """Assert that parsing ARGS should result in an instance of
1165
2076
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
1166
2077
        options = self.parser.parse_args(args)
1167
2078
        check_option_syntax(self.parser, options)
1168
2079
        commands = commands_from_options(options)
1169
 
        self.assertEqual(1, len(commands))
1170
 
        command = commands[0]
1171
 
        self.assertIsInstance(command, command_cls)
 
2080
        self.assertEqual(length, len(commands))
 
2081
        for command in commands:
 
2082
            if isinstance(command, command_cls):
 
2083
                break
 
2084
        else:
 
2085
            self.assertIsInstance(command, command_cls)
 
2086
        if clients is not None:
 
2087
            self.assertEqual(clients, options.client)
1172
2088
        for key, value in cmd_attrs.items():
1173
2089
            self.assertEqual(value, getattr(command, key))
1174
2090
 
 
2091
    def assert_commands_from_args(self, args, commands, clients=None):
 
2092
        for cmd in commands:
 
2093
            self.assert_command_from_args(args, cmd,
 
2094
                                          length=len(commands),
 
2095
                                          clients=clients)
 
2096
 
1175
2097
    def test_is_enabled_short(self):
1176
2098
        self.assert_command_from_args(["-V", "client"],
1177
2099
                                      command.IsEnabled)
1368
2290
                                      verbose=True)
1369
2291
 
1370
2292
 
 
2293
    def test_manual_page_example_1(self):
 
2294
        self.assert_command_from_args("",
 
2295
                                      command.PrintTable,
 
2296
                                      clients=[],
 
2297
                                      verbose=False)
 
2298
 
 
2299
    def test_manual_page_example_2(self):
 
2300
        self.assert_command_from_args(
 
2301
            "--verbose foo1.example.org foo2.example.org".split(),
 
2302
            command.PrintTable, clients=["foo1.example.org",
 
2303
                                         "foo2.example.org"],
 
2304
            verbose=True)
 
2305
 
 
2306
    def test_manual_page_example_3(self):
 
2307
        self.assert_command_from_args("--enable --all".split(),
 
2308
                                      command.Enable,
 
2309
                                      clients=[])
 
2310
 
 
2311
    def test_manual_page_example_4(self):
 
2312
        self.assert_commands_from_args(
 
2313
            ("--timeout=PT5M --interval=PT1M foo1.example.org"
 
2314
             " foo2.example.org").split(),
 
2315
            [command.SetTimeout, command.SetInterval],
 
2316
            clients=["foo1.example.org", "foo2.example.org"])
 
2317
 
 
2318
    def test_manual_page_example_5(self):
 
2319
        self.assert_command_from_args("--approve --all".split(),
 
2320
                                      command.Approve,
 
2321
                                      clients=[])
 
2322
 
 
2323
 
1371
2324
class TestCommand(unittest.TestCase):
1372
2325
    """Abstract class for tests of command classes"""
1373
2326
 
 
2327
    class FakeMandosBus(dbus.MandosBus):
 
2328
        def __init__(self, testcase):
 
2329
            self.client_properties = {
 
2330
                "Name": "foo",
 
2331
                "KeyID": ("92ed150794387c03ce684574b1139a65"
 
2332
                          "94a34f895daaaf09fd8ea90a27cddb12"),
 
2333
                "Secret": b"secret",
 
2334
                "Host": "foo.example.org",
 
2335
                "Enabled": True,
 
2336
                "Timeout": 300000,
 
2337
                "LastCheckedOK": "2019-02-03T00:00:00",
 
2338
                "Created": "2019-01-02T00:00:00",
 
2339
                "Interval": 120000,
 
2340
                "Fingerprint": ("778827225BA7DE539C5A"
 
2341
                                "7CFA59CFF7CDBD9A5920"),
 
2342
                "CheckerRunning": False,
 
2343
                "LastEnabled": "2019-01-03T00:00:00",
 
2344
                "ApprovalPending": False,
 
2345
                "ApprovedByDefault": True,
 
2346
                "LastApprovalRequest": "",
 
2347
                "ApprovalDelay": 0,
 
2348
                "ApprovalDuration": 1000,
 
2349
                "Checker": "fping -q -- %(host)s",
 
2350
                "ExtendedTimeout": 900000,
 
2351
                "Expires": "2019-02-04T00:00:00",
 
2352
                "LastCheckerStatus": 0,
 
2353
            }
 
2354
            self.other_client_properties = {
 
2355
                "Name": "barbar",
 
2356
                "KeyID": ("0558568eedd67d622f5c83b35a115f79"
 
2357
                          "6ab612cff5ad227247e46c2b020f441c"),
 
2358
                "Secret": b"secretbar",
 
2359
                "Host": "192.0.2.3",
 
2360
                "Enabled": True,
 
2361
                "Timeout": 300000,
 
2362
                "LastCheckedOK": "2019-02-04T00:00:00",
 
2363
                "Created": "2019-01-03T00:00:00",
 
2364
                "Interval": 120000,
 
2365
                "Fingerprint": ("3E393AEAEFB84C7E89E2"
 
2366
                                "F547B3A107558FCA3A27"),
 
2367
                "CheckerRunning": True,
 
2368
                "LastEnabled": "2019-01-04T00:00:00",
 
2369
                "ApprovalPending": False,
 
2370
                "ApprovedByDefault": False,
 
2371
                "LastApprovalRequest": "2019-01-03T00:00:00",
 
2372
                "ApprovalDelay": 30000,
 
2373
                "ApprovalDuration": 93785000,
 
2374
                "Checker": ":",
 
2375
                "ExtendedTimeout": 900000,
 
2376
                "Expires": "2019-02-05T00:00:00",
 
2377
                "LastCheckerStatus": -2,
 
2378
            }
 
2379
            self.clients =  collections.OrderedDict(
 
2380
                [
 
2381
                    ("client_objectpath", self.client_properties),
 
2382
                    ("other_client_objectpath",
 
2383
                     self.other_client_properties),
 
2384
                ])
 
2385
            self.one_client = {"client_objectpath":
 
2386
                               self.client_properties}
 
2387
            self.testcase = testcase
 
2388
            self.calls = []
 
2389
 
 
2390
        def call_method(self, methodname, busname, objectpath,
 
2391
                        interface, *args):
 
2392
            self.testcase.assertEqual("se.recompile.Mandos", busname)
 
2393
            self.calls.append((methodname, busname, objectpath,
 
2394
                               interface, args))
 
2395
            if interface == "org.freedesktop.DBus.Properties":
 
2396
                if methodname == "Set":
 
2397
                    self.testcase.assertEqual(3, len(args))
 
2398
                    interface, key, value = args
 
2399
                    self.testcase.assertEqual(
 
2400
                        "se.recompile.Mandos.Client", interface)
 
2401
                    self.clients[objectpath][key] = value
 
2402
                    return
 
2403
            elif interface == "se.recompile.Mandos":
 
2404
                self.testcase.assertEqual("RemoveClient", methodname)
 
2405
                self.testcase.assertEqual(1, len(args))
 
2406
                clientpath = args[0]
 
2407
                del self.clients[clientpath]
 
2408
                return
 
2409
            elif interface == "se.recompile.Mandos.Client":
 
2410
                if methodname == "Approve":
 
2411
                    self.testcase.assertEqual(1, len(args))
 
2412
                    return
 
2413
            raise ValueError()
 
2414
 
1374
2415
    def setUp(self):
1375
 
        testcase = self
1376
 
        class MockClient(object):
1377
 
            def __init__(self, name, **attributes):
1378
 
                self.__dbus_object_path__ = "/clients/{}".format(name)
1379
 
                self.attributes = attributes
1380
 
                self.attributes["Name"] = name
1381
 
                self.calls = []
1382
 
            def Set(self, interface, propname, value, dbus_interface):
1383
 
                testcase.assertEqual(client_dbus_interface, interface)
1384
 
                testcase.assertEqual(dbus.PROPERTIES_IFACE,
1385
 
                                     dbus_interface)
1386
 
                self.attributes[propname] = value
1387
 
            def Approve(self, approve, dbus_interface):
1388
 
                testcase.assertEqual(client_dbus_interface,
1389
 
                                     dbus_interface)
1390
 
                self.calls.append(("Approve", (approve,
1391
 
                                               dbus_interface)))
1392
 
        self.client = MockClient(
1393
 
            "foo",
1394
 
            KeyID=("92ed150794387c03ce684574b1139a65"
1395
 
                   "94a34f895daaaf09fd8ea90a27cddb12"),
1396
 
            Secret=b"secret",
1397
 
            Host="foo.example.org",
1398
 
            Enabled=dbus.Boolean(True),
1399
 
            Timeout=300000,
1400
 
            LastCheckedOK="2019-02-03T00:00:00",
1401
 
            Created="2019-01-02T00:00:00",
1402
 
            Interval=120000,
1403
 
            Fingerprint=("778827225BA7DE539C5A"
1404
 
                         "7CFA59CFF7CDBD9A5920"),
1405
 
            CheckerRunning=dbus.Boolean(False),
1406
 
            LastEnabled="2019-01-03T00:00:00",
1407
 
            ApprovalPending=dbus.Boolean(False),
1408
 
            ApprovedByDefault=dbus.Boolean(True),
1409
 
            LastApprovalRequest="",
1410
 
            ApprovalDelay=0,
1411
 
            ApprovalDuration=1000,
1412
 
            Checker="fping -q -- %(host)s",
1413
 
            ExtendedTimeout=900000,
1414
 
            Expires="2019-02-04T00:00:00",
1415
 
            LastCheckerStatus=0)
1416
 
        self.other_client = MockClient(
1417
 
            "barbar",
1418
 
            KeyID=("0558568eedd67d622f5c83b35a115f79"
1419
 
                   "6ab612cff5ad227247e46c2b020f441c"),
1420
 
            Secret=b"secretbar",
1421
 
            Host="192.0.2.3",
1422
 
            Enabled=dbus.Boolean(True),
1423
 
            Timeout=300000,
1424
 
            LastCheckedOK="2019-02-04T00:00:00",
1425
 
            Created="2019-01-03T00:00:00",
1426
 
            Interval=120000,
1427
 
            Fingerprint=("3E393AEAEFB84C7E89E2"
1428
 
                         "F547B3A107558FCA3A27"),
1429
 
            CheckerRunning=dbus.Boolean(True),
1430
 
            LastEnabled="2019-01-04T00:00:00",
1431
 
            ApprovalPending=dbus.Boolean(False),
1432
 
            ApprovedByDefault=dbus.Boolean(False),
1433
 
            LastApprovalRequest="2019-01-03T00:00:00",
1434
 
            ApprovalDelay=30000,
1435
 
            ApprovalDuration=93785000,
1436
 
            Checker=":",
1437
 
            ExtendedTimeout=900000,
1438
 
            Expires="2019-02-05T00:00:00",
1439
 
            LastCheckerStatus=-2)
1440
 
        self.clients =  collections.OrderedDict(
1441
 
            [
1442
 
                (self.client.__dbus_object_path__,
1443
 
                 self.client.attributes),
1444
 
                (self.other_client.__dbus_object_path__,
1445
 
                 self.other_client.attributes),
1446
 
            ])
1447
 
        self.one_client = {self.client.__dbus_object_path__:
1448
 
                           self.client.attributes}
1449
 
 
1450
 
    @property
1451
 
    def bus(self):
1452
 
        class MockBus(object):
1453
 
            @staticmethod
1454
 
            def get_object(client_bus_name, path):
1455
 
                self.assertEqual(dbus_busname, client_bus_name)
1456
 
                # Note: "self" here is the TestCmd instance, not the
1457
 
                # MockBus instance, since this is a static method!
1458
 
                if path == self.client.__dbus_object_path__:
1459
 
                    return self.client
1460
 
                elif path == self.other_client.__dbus_object_path__:
1461
 
                    return self.other_client
1462
 
        return MockBus()
 
2416
        self.bus = self.FakeMandosBus(self)
1463
2417
 
1464
2418
 
1465
2419
class TestBaseCommands(TestCommand):
1466
2420
 
1467
2421
    def test_IsEnabled_exits_successfully(self):
1468
2422
        with self.assertRaises(SystemExit) as e:
1469
 
            command.IsEnabled().run(self.one_client)
 
2423
            command.IsEnabled().run(self.bus.one_client)
1470
2424
        if e.exception.code is not None:
1471
2425
            self.assertEqual(0, e.exception.code)
1472
2426
        else:
1473
2427
            self.assertIsNone(e.exception.code)
1474
2428
 
1475
2429
    def test_IsEnabled_exits_with_failure(self):
1476
 
        self.client.attributes["Enabled"] = dbus.Boolean(False)
 
2430
        self.bus.client_properties["Enabled"] = False
1477
2431
        with self.assertRaises(SystemExit) as e:
1478
 
            command.IsEnabled().run(self.one_client)
 
2432
            command.IsEnabled().run(self.bus.one_client)
1479
2433
        if isinstance(e.exception.code, int):
1480
2434
            self.assertNotEqual(0, e.exception.code)
1481
2435
        else:
1482
2436
            self.assertIsNotNone(e.exception.code)
1483
2437
 
1484
2438
    def test_Approve(self):
1485
 
        command.Approve().run(self.clients, self.bus)
1486
 
        for clientpath in self.clients:
1487
 
            client = self.bus.get_object(dbus_busname, clientpath)
1488
 
            self.assertIn(("Approve", (True, client_dbus_interface)),
1489
 
                          client.calls)
 
2439
        busname = "se.recompile.Mandos"
 
2440
        client_interface = "se.recompile.Mandos.Client"
 
2441
        command.Approve().run(self.bus.clients, self.bus)
 
2442
        self.assertTrue(self.bus.clients)
 
2443
        for clientpath in self.bus.clients:
 
2444
            self.assertIn(("Approve", busname, clientpath,
 
2445
                           client_interface, (True,)), self.bus.calls)
1490
2446
 
1491
2447
    def test_Deny(self):
1492
 
        command.Deny().run(self.clients, self.bus)
1493
 
        for clientpath in self.clients:
1494
 
            client = self.bus.get_object(dbus_busname, clientpath)
1495
 
            self.assertIn(("Approve", (False, client_dbus_interface)),
1496
 
                          client.calls)
 
2448
        busname = "se.recompile.Mandos"
 
2449
        client_interface = "se.recompile.Mandos.Client"
 
2450
        command.Deny().run(self.bus.clients, self.bus)
 
2451
        self.assertTrue(self.bus.clients)
 
2452
        for clientpath in self.bus.clients:
 
2453
            self.assertIn(("Approve", busname, clientpath,
 
2454
                           client_interface, (False,)),
 
2455
                          self.bus.calls)
1497
2456
 
1498
2457
    def test_Remove(self):
1499
 
        class MandosSpy(object):
1500
 
            def __init__(self):
1501
 
                self.calls = []
1502
 
            def RemoveClient(self, dbus_path):
1503
 
                self.calls.append(("RemoveClient", (dbus_path,)))
1504
 
        mandos = MandosSpy()
1505
 
        command.Remove().run(self.clients, self.bus, mandos)
1506
 
        for clientpath in self.clients:
1507
 
            self.assertIn(("RemoveClient", (clientpath,)),
1508
 
                          mandos.calls)
 
2458
        busname = "se.recompile.Mandos"
 
2459
        server_path = "/"
 
2460
        server_interface = "se.recompile.Mandos"
 
2461
        orig_clients = self.bus.clients.copy()
 
2462
        command.Remove().run(self.bus.clients, self.bus)
 
2463
        self.assertFalse(self.bus.clients)
 
2464
        for clientpath in orig_clients:
 
2465
            self.assertIn(("RemoveClient", busname,
 
2466
                           server_path, server_interface,
 
2467
                           (clientpath,)), self.bus.calls)
1509
2468
 
1510
2469
    expected_json = {
1511
2470
        "foo": {
1560
2519
 
1561
2520
    def test_DumpJSON_normal(self):
1562
2521
        with self.capture_stdout_to_buffer() as buffer:
1563
 
            command.DumpJSON().run(self.clients)
 
2522
            command.DumpJSON().run(self.bus.clients)
1564
2523
        json_data = json.loads(buffer.getvalue())
1565
2524
        self.assertDictEqual(self.expected_json, json_data)
1566
2525
 
1577
2536
 
1578
2537
    def test_DumpJSON_one_client(self):
1579
2538
        with self.capture_stdout_to_buffer() as buffer:
1580
 
            command.DumpJSON().run(self.one_client)
 
2539
            command.DumpJSON().run(self.bus.one_client)
1581
2540
        json_data = json.loads(buffer.getvalue())
1582
2541
        expected_json = {"foo": self.expected_json["foo"]}
1583
2542
        self.assertDictEqual(expected_json, json_data)
1584
2543
 
1585
2544
    def test_PrintTable_normal(self):
1586
2545
        with self.capture_stdout_to_buffer() as buffer:
1587
 
            command.PrintTable().run(self.clients)
 
2546
            command.PrintTable().run(self.bus.clients)
1588
2547
        expected_output = "\n".join((
1589
2548
            "Name   Enabled Timeout  Last Successful Check",
1590
2549
            "foo    Yes     00:05:00 2019-02-03T00:00:00  ",
1594
2553
 
1595
2554
    def test_PrintTable_verbose(self):
1596
2555
        with self.capture_stdout_to_buffer() as buffer:
1597
 
            command.PrintTable(verbose=True).run(self.clients)
 
2556
            command.PrintTable(verbose=True).run(self.bus.clients)
1598
2557
        columns = (
1599
2558
            (
1600
2559
                "Name   ",
1690
2649
 
1691
2650
    def test_PrintTable_one_client(self):
1692
2651
        with self.capture_stdout_to_buffer() as buffer:
1693
 
            command.PrintTable().run(self.one_client)
 
2652
            command.PrintTable().run(self.bus.one_client)
1694
2653
        expected_output = "\n".join((
1695
2654
            "Name Enabled Timeout  Last Successful Check",
1696
2655
            "foo  Yes     00:05:00 2019-02-03T00:00:00  ",
1700
2659
 
1701
2660
class TestPropertySetterCmd(TestCommand):
1702
2661
    """Abstract class for tests of command.PropertySetter classes"""
 
2662
 
1703
2663
    def runTest(self):
1704
2664
        if not hasattr(self, "command"):
1705
 
            return
1706
 
        values_to_get = getattr(self, "values_to_get",
1707
 
                                self.values_to_set)
1708
 
        for value_to_set, value_to_get in zip(self.values_to_set,
1709
 
                                              values_to_get):
1710
 
            for clientpath in self.clients:
1711
 
                client = self.bus.get_object(dbus_busname, clientpath)
1712
 
                old_value = client.attributes[self.propname]
1713
 
                client.attributes[self.propname] = self.Unique()
1714
 
            self.run_command(value_to_set, self.clients)
1715
 
            for clientpath in self.clients:
1716
 
                client = self.bus.get_object(dbus_busname, clientpath)
1717
 
                value = client.attributes[self.propname]
1718
 
                self.assertNotIsInstance(value, self.Unique)
 
2665
            return              # Abstract TestCase class
 
2666
 
 
2667
        if hasattr(self, "values_to_set"):
 
2668
            cmd_args = [(value,) for value in self.values_to_set]
 
2669
            values_to_get = getattr(self, "values_to_get",
 
2670
                                    self.values_to_set)
 
2671
        else:
 
2672
            cmd_args = [() for x in range(len(self.values_to_get))]
 
2673
            values_to_get = self.values_to_get
 
2674
        self.assertTrue(values_to_get)
 
2675
        for value_to_get, cmd_arg in zip(values_to_get, cmd_args):
 
2676
            for clientpath in self.bus.clients:
 
2677
                self.bus.clients[clientpath][self.propname] = (
 
2678
                    Unique())
 
2679
            self.command(*cmd_arg).run(self.bus.clients, self.bus)
 
2680
            self.assertTrue(self.bus.clients)
 
2681
            for clientpath in self.bus.clients:
 
2682
                value = (self.bus.clients[clientpath]
 
2683
                         [self.propname])
 
2684
                self.assertNotIsInstance(value, Unique)
1719
2685
                self.assertEqual(value_to_get, value)
1720
2686
 
1721
 
    class Unique(object):
1722
 
        """Class for objects which exist only to be unique objects,
1723
 
since unittest.mock.sentinel only exists in Python 3.3"""
1724
 
 
1725
 
    def run_command(self, value, clients):
1726
 
        self.command().run(clients, self.bus)
1727
 
 
1728
2687
 
1729
2688
class TestEnableCmd(TestPropertySetterCmd):
1730
2689
    command = command.Enable
1731
2690
    propname = "Enabled"
1732
 
    values_to_set = [dbus.Boolean(True)]
 
2691
    values_to_get = [True]
1733
2692
 
1734
2693
 
1735
2694
class TestDisableCmd(TestPropertySetterCmd):
1736
2695
    command = command.Disable
1737
2696
    propname = "Enabled"
1738
 
    values_to_set = [dbus.Boolean(False)]
 
2697
    values_to_get = [False]
1739
2698
 
1740
2699
 
1741
2700
class TestBumpTimeoutCmd(TestPropertySetterCmd):
1742
2701
    command = command.BumpTimeout
1743
2702
    propname = "LastCheckedOK"
1744
 
    values_to_set = [""]
 
2703
    values_to_get = [""]
1745
2704
 
1746
2705
 
1747
2706
class TestStartCheckerCmd(TestPropertySetterCmd):
1748
2707
    command = command.StartChecker
1749
2708
    propname = "CheckerRunning"
1750
 
    values_to_set = [dbus.Boolean(True)]
 
2709
    values_to_get = [True]
1751
2710
 
1752
2711
 
1753
2712
class TestStopCheckerCmd(TestPropertySetterCmd):
1754
2713
    command = command.StopChecker
1755
2714
    propname = "CheckerRunning"
1756
 
    values_to_set = [dbus.Boolean(False)]
 
2715
    values_to_get = [False]
1757
2716
 
1758
2717
 
1759
2718
class TestApproveByDefaultCmd(TestPropertySetterCmd):
1760
2719
    command = command.ApproveByDefault
1761
2720
    propname = "ApprovedByDefault"
1762
 
    values_to_set = [dbus.Boolean(True)]
 
2721
    values_to_get = [True]
1763
2722
 
1764
2723
 
1765
2724
class TestDenyByDefaultCmd(TestPropertySetterCmd):
1766
2725
    command = command.DenyByDefault
1767
2726
    propname = "ApprovedByDefault"
1768
 
    values_to_set = [dbus.Boolean(False)]
1769
 
 
1770
 
 
1771
 
class TestPropertySetterValueCmd(TestPropertySetterCmd):
1772
 
    """Abstract class for tests of PropertySetterValueCmd classes"""
1773
 
 
1774
 
    def runTest(self):
1775
 
        if type(self) is TestPropertySetterValueCmd:
1776
 
            return
1777
 
        return super(TestPropertySetterValueCmd, self).runTest()
1778
 
 
1779
 
    def run_command(self, value, clients):
1780
 
        self.command(value).run(clients, self.bus)
1781
 
 
1782
 
 
1783
 
class TestSetCheckerCmd(TestPropertySetterValueCmd):
 
2727
    values_to_get = [False]
 
2728
 
 
2729
 
 
2730
class TestSetCheckerCmd(TestPropertySetterCmd):
1784
2731
    command = command.SetChecker
1785
2732
    propname = "Checker"
1786
2733
    values_to_set = ["", ":", "fping -q -- %s"]
1787
2734
 
1788
2735
 
1789
 
class TestSetHostCmd(TestPropertySetterValueCmd):
 
2736
class TestSetHostCmd(TestPropertySetterCmd):
1790
2737
    command = command.SetHost
1791
2738
    propname = "Host"
1792
2739
    values_to_set = ["192.0.2.3", "client.example.org"]
1793
2740
 
1794
2741
 
1795
 
class TestSetSecretCmd(TestPropertySetterValueCmd):
 
2742
class TestSetSecretCmd(TestPropertySetterCmd):
1796
2743
    command = command.SetSecret
1797
2744
    propname = "Secret"
1798
 
    values_to_set = [io.BytesIO(b""),
1799
 
                     io.BytesIO(b"secret\0xyzzy\nbar")]
1800
 
    values_to_get = [f.getvalue() for f in values_to_set]
1801
 
 
1802
 
 
1803
 
class TestSetTimeoutCmd(TestPropertySetterValueCmd):
 
2745
    def __init__(self, *args, **kwargs):
 
2746
        self.values_to_set = [io.BytesIO(b""),
 
2747
                              io.BytesIO(b"secret\0xyzzy\nbar")]
 
2748
        self.values_to_get = [f.getvalue() for f in
 
2749
                              self.values_to_set]
 
2750
        super(TestSetSecretCmd, self).__init__(*args, **kwargs)
 
2751
 
 
2752
 
 
2753
class TestSetTimeoutCmd(TestPropertySetterCmd):
1804
2754
    command = command.SetTimeout
1805
2755
    propname = "Timeout"
1806
2756
    values_to_set = [datetime.timedelta(),
1811
2761
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1812
2762
 
1813
2763
 
1814
 
class TestSetExtendedTimeoutCmd(TestPropertySetterValueCmd):
 
2764
class TestSetExtendedTimeoutCmd(TestPropertySetterCmd):
1815
2765
    command = command.SetExtendedTimeout
1816
2766
    propname = "ExtendedTimeout"
1817
2767
    values_to_set = [datetime.timedelta(),
1822
2772
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1823
2773
 
1824
2774
 
1825
 
class TestSetIntervalCmd(TestPropertySetterValueCmd):
 
2775
class TestSetIntervalCmd(TestPropertySetterCmd):
1826
2776
    command = command.SetInterval
1827
2777
    propname = "Interval"
1828
2778
    values_to_set = [datetime.timedelta(),
1833
2783
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1834
2784
 
1835
2785
 
1836
 
class TestSetApprovalDelayCmd(TestPropertySetterValueCmd):
 
2786
class TestSetApprovalDelayCmd(TestPropertySetterCmd):
1837
2787
    command = command.SetApprovalDelay
1838
2788
    propname = "ApprovalDelay"
1839
2789
    values_to_set = [datetime.timedelta(),
1844
2794
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1845
2795
 
1846
2796
 
1847
 
class TestSetApprovalDurationCmd(TestPropertySetterValueCmd):
 
2797
class TestSetApprovalDurationCmd(TestPropertySetterCmd):
1848
2798
    command = command.SetApprovalDuration
1849
2799
    propname = "ApprovalDuration"
1850
2800
    values_to_set = [datetime.timedelta(),
1856
2806
 
1857
2807
 
1858
2808
 
1859
 
def should_only_run_tests():
 
2809
def parse_test_args():
 
2810
    # type: () -> argparse.Namespace
1860
2811
    parser = argparse.ArgumentParser(add_help=False)
1861
 
    parser.add_argument("--check", action='store_true')
 
2812
    parser.add_argument("--check", action="store_true")
 
2813
    parser.add_argument("--prefix", )
1862
2814
    args, unknown_args = parser.parse_known_args()
1863
 
    run_tests = args.check
1864
 
    if run_tests:
1865
 
        # Remove --check argument from sys.argv
 
2815
    if args.check:
 
2816
        # Remove test options from sys.argv
1866
2817
        sys.argv[1:] = unknown_args
1867
 
    return run_tests
 
2818
    return args
1868
2819
 
1869
2820
# Add all tests from doctest strings
1870
2821
def load_tests(loader, tests, none):
1873
2824
    return tests
1874
2825
 
1875
2826
if __name__ == "__main__":
 
2827
    options = parse_test_args()
1876
2828
    try:
1877
 
        if should_only_run_tests():
1878
 
            # Call using ./tdd-python-script --check [--verbose]
1879
 
            unittest.main()
 
2829
        if options.check:
 
2830
            extra_test_prefix = options.prefix
 
2831
            if extra_test_prefix is not None:
 
2832
                if not (unittest.main(argv=[""], exit=False)
 
2833
                        .result.wasSuccessful()):
 
2834
                    sys.exit(1)
 
2835
                class ExtraTestLoader(unittest.TestLoader):
 
2836
                    testMethodPrefix = extra_test_prefix
 
2837
                # Call using ./scriptname --check [--verbose]
 
2838
                unittest.main(argv=[""], testLoader=ExtraTestLoader())
 
2839
            else:
 
2840
                unittest.main(argv=[""])
1880
2841
        else:
1881
2842
            main()
1882
2843
    finally:
1883
2844
        logging.shutdown()
 
2845
 
 
2846
# Local Variables:
 
2847
# run-tests:
 
2848
# (lambda (&optional extra)
 
2849
#   (if (not (funcall run-tests-in-test-buffer default-directory
 
2850
#             extra))
 
2851
#       (funcall show-test-buffer-in-test-window)
 
2852
#     (funcall remove-test-window)
 
2853
#     (if extra (message "Extra tests run successfully!"))))
 
2854
# run-tests-in-test-buffer:
 
2855
# (lambda (dir &optional extra)
 
2856
#   (with-current-buffer (get-buffer-create "*Test*")
 
2857
#     (setq buffer-read-only nil
 
2858
#           default-directory dir)
 
2859
#     (erase-buffer)
 
2860
#     (compilation-mode))
 
2861
#   (let ((process-result
 
2862
#          (let ((inhibit-read-only t))
 
2863
#            (process-file-shell-command
 
2864
#             (funcall get-command-line extra) nil "*Test*"))))
 
2865
#     (and (numberp process-result)
 
2866
#          (= process-result 0))))
 
2867
# get-command-line:
 
2868
# (lambda (&optional extra)
 
2869
#   (let ((quoted-script
 
2870
#          (shell-quote-argument (funcall get-script-name))))
 
2871
#     (format
 
2872
#      (concat "%s --check" (if extra " --prefix=atest" ""))
 
2873
#      quoted-script)))
 
2874
# get-script-name:
 
2875
# (lambda ()
 
2876
#   (if (fboundp 'file-local-name)
 
2877
#       (file-local-name (buffer-file-name))
 
2878
#     (or (file-remote-p (buffer-file-name) 'localname)
 
2879
#         (buffer-file-name))))
 
2880
# remove-test-window:
 
2881
# (lambda ()
 
2882
#   (let ((test-window (get-buffer-window "*Test*")))
 
2883
#     (if test-window (delete-window test-window))))
 
2884
# show-test-buffer-in-test-window:
 
2885
# (lambda ()
 
2886
#   (when (not (get-buffer-window-list "*Test*"))
 
2887
#     (setq next-error-last-buffer (get-buffer "*Test*"))
 
2888
#     (let* ((side (if (>= (window-width) 146) 'right 'bottom))
 
2889
#            (display-buffer-overriding-action
 
2890
#             `((display-buffer-in-side-window) (side . ,side)
 
2891
#               (window-height . fit-window-to-buffer)
 
2892
#               (window-width . fit-window-to-buffer))))
 
2893
#       (display-buffer "*Test*"))))
 
2894
# eval:
 
2895
# (progn
 
2896
#   (let* ((run-extra-tests (lambda () (interactive)
 
2897
#                             (funcall run-tests t)))
 
2898
#          (inner-keymap `(keymap (116 . ,run-extra-tests))) ; t
 
2899
#          (outer-keymap `(keymap (3 . ,inner-keymap))))     ; C-c
 
2900
#     (setq minor-mode-overriding-map-alist
 
2901
#           (cons `(run-tests . ,outer-keymap)
 
2902
#                 minor-mode-overriding-map-alist)))
 
2903
#   (add-hook 'after-save-hook run-tests 90 t))
 
2904
# End: