/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos-ctl

  • Committer: Teddy Hogeborn
  • Date: 2019-08-05 21:00:35 UTC
  • Revision ID: teddy@recompile.se-20190805210035-15cra82gas0yf7ok
Create a debconf translation file

* debian/mandos-client.templates (mandos-client/key_id): Line which
  should not be wrapped should be prefixed by a space.
* debian/mandos.templates (mandos/key_id): - '' -
* debian/po/en_US.po: New "translation" from ASCII to UTF-8.
* debian/po/templates.pot: Updated.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
#!/usr/bin/python
2
 
# -*- mode: python; coding: utf-8; after-save-hook: (lambda () (let ((command (if (and (boundp 'tramp-file-name-structure) (string-match (car tramp-file-name-structure) (buffer-file-name))) (tramp-file-name-localname (tramp-dissect-file-name (buffer-file-name))) (buffer-file-name)))) (if (= (shell-command (format "%s --check" (shell-quote-argument command)) "*Test*") 0) (let ((w (get-buffer-window "*Test*"))) (if w (delete-window w)) (kill-buffer "*Test*")) (display-buffer "*Test*")))); -*-
 
2
# -*- after-save-hook: (lambda () (let ((command (if (fboundp 'file-local-name) (file-local-name (buffer-file-name)) (or (file-remote-p (buffer-file-name) 'localname) (buffer-file-name))))) (if (= (progn (if (get-buffer "*Test*") (kill-buffer "*Test*")) (process-file-shell-command (format "%s --check" (shell-quote-argument command)) nil "*Test*")) 0) (let ((w (get-buffer-window "*Test*"))) (if w (delete-window w))) (progn (with-current-buffer "*Test*" (compilation-mode)) (display-buffer "*Test*" '(display-buffer-in-side-window)))))); coding: utf-8 -*-
3
3
#
4
4
# Mandos Monitor - Control and monitor the Mandos server
5
5
#
46
46
import tempfile
47
47
import contextlib
48
48
 
49
 
import dbus
 
49
try:
 
50
    import pydbus
 
51
    import gi
 
52
    dbus_python = None
 
53
except ImportError:
 
54
    import dbus as dbus_python
 
55
    pydbus = None
 
56
    class gi(object):
 
57
        """Dummy gi module, for the tests"""
 
58
        class repository(object):
 
59
            class GLib(object):
 
60
                class Error(Exception):
 
61
                    pass
50
62
 
51
63
# Show warnings by default
52
64
if not sys.warnoptions:
66
78
 
67
79
locale.setlocale(locale.LC_ALL, "")
68
80
 
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"
 
81
version = "1.8.6"
82
82
 
83
83
 
84
84
def main():
93
93
    if options.debug:
94
94
        log.setLevel(logging.DEBUG)
95
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
 
96
    if pydbus is not None:
 
97
        bus = pydbus_adapter.CachingBus(pydbus)
 
98
    else:
 
99
        bus = dbus_python_adapter.CachingBus(dbus_python)
 
100
 
 
101
    try:
 
102
        all_clients = bus.get_clients_and_properties()
 
103
    except dbus.ConnectFailed as e:
 
104
        log.critical("Could not connect to Mandos server: %s", e)
 
105
        sys.exit(1)
 
106
    except dbus.Error as e:
 
107
        log.critical(
 
108
            "Failed to access Mandos server through D-Bus:\n%s", e)
 
109
        sys.exit(1)
113
110
 
114
111
    # Compile dict of (clientpath: properties) to process
115
112
    if not clientnames:
128
125
    commands = commands_from_options(options)
129
126
 
130
127
    for command in commands:
131
 
        command.run(clients, bus, mandos_serv)
 
128
        command.run(clients, bus)
132
129
 
133
130
 
134
131
def add_command_line_options(parser):
139
136
                        help="Select all clients")
140
137
    parser.add_argument("-v", "--verbose", action="store_true",
141
138
                        help="Print all fields")
142
 
    parser.add_argument("-j", "--dump-json", action="store_true",
 
139
    parser.add_argument("-j", "--dump-json", dest="commands",
 
140
                        action="append_const", default=[],
 
141
                        const=command.DumpJSON(),
143
142
                        help="Dump client data in JSON format")
144
143
    enable_disable = parser.add_mutually_exclusive_group()
145
 
    enable_disable.add_argument("-e", "--enable", action="store_true",
 
144
    enable_disable.add_argument("-e", "--enable", dest="commands",
 
145
                                action="append_const", default=[],
 
146
                                const=command.Enable(),
146
147
                                help="Enable client")
147
 
    enable_disable.add_argument("-d", "--disable",
148
 
                                action="store_true",
 
148
    enable_disable.add_argument("-d", "--disable", dest="commands",
 
149
                                action="append_const", default=[],
 
150
                                const=command.Disable(),
149
151
                                help="disable client")
150
 
    parser.add_argument("-b", "--bump-timeout", action="store_true",
 
152
    parser.add_argument("-b", "--bump-timeout", dest="commands",
 
153
                        action="append_const", default=[],
 
154
                        const=command.BumpTimeout(),
151
155
                        help="Bump timeout for client")
152
156
    start_stop_checker = parser.add_mutually_exclusive_group()
153
157
    start_stop_checker.add_argument("--start-checker",
154
 
                                    action="store_true",
 
158
                                    dest="commands",
 
159
                                    action="append_const", default=[],
 
160
                                    const=command.StartChecker(),
155
161
                                    help="Start checker for client")
156
 
    start_stop_checker.add_argument("--stop-checker",
157
 
                                    action="store_true",
 
162
    start_stop_checker.add_argument("--stop-checker", dest="commands",
 
163
                                    action="append_const", default=[],
 
164
                                    const=command.StopChecker(),
158
165
                                    help="Stop checker for client")
159
 
    parser.add_argument("-V", "--is-enabled", action="store_true",
 
166
    parser.add_argument("-V", "--is-enabled", dest="commands",
 
167
                        action="append_const", default=[],
 
168
                        const=command.IsEnabled(),
160
169
                        help="Check if client is enabled")
161
 
    parser.add_argument("-r", "--remove", action="store_true",
 
170
    parser.add_argument("-r", "--remove", dest="commands",
 
171
                        action="append_const", default=[],
 
172
                        const=command.Remove(),
162
173
                        help="Remove client")
163
 
    parser.add_argument("-c", "--checker",
 
174
    parser.add_argument("-c", "--checker", dest="commands",
 
175
                        action="append", default=[],
 
176
                        metavar="COMMAND", type=command.SetChecker,
164
177
                        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")
 
178
    parser.add_argument(
 
179
        "-t", "--timeout", dest="commands", action="append",
 
180
        default=[], metavar="TIME",
 
181
        type=command.SetTimeout.argparse(string_to_delta),
 
182
        help="Set timeout for client")
 
183
    parser.add_argument(
 
184
        "--extended-timeout", dest="commands", action="append",
 
185
        default=[], metavar="TIME",
 
186
        type=command.SetExtendedTimeout.argparse(string_to_delta),
 
187
        help="Set extended timeout for client")
 
188
    parser.add_argument(
 
189
        "-i", "--interval", dest="commands", action="append",
 
190
        default=[], metavar="TIME",
 
191
        type=command.SetInterval.argparse(string_to_delta),
 
192
        help="Set checker interval for client")
171
193
    approve_deny_default = parser.add_mutually_exclusive_group()
172
194
    approve_deny_default.add_argument(
173
 
        "--approve-by-default", action="store_true",
174
 
        default=None, dest="approved_by_default",
 
195
        "--approve-by-default", dest="commands",
 
196
        action="append_const", default=[],
 
197
        const=command.ApproveByDefault(),
175
198
        help="Set client to be approved by default")
176
199
    approve_deny_default.add_argument(
177
 
        "--deny-by-default", action="store_false",
178
 
        dest="approved_by_default",
 
200
        "--deny-by-default", dest="commands",
 
201
        action="append_const", default=[],
 
202
        const=command.DenyByDefault(),
179
203
        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")
 
204
    parser.add_argument(
 
205
        "--approval-delay", dest="commands", action="append",
 
206
        default=[], metavar="TIME",
 
207
        type=command.SetApprovalDelay.argparse(string_to_delta),
 
208
        help="Set delay before client approve/deny")
 
209
    parser.add_argument(
 
210
        "--approval-duration", dest="commands", action="append",
 
211
        default=[], metavar="TIME",
 
212
        type=command.SetApprovalDuration.argparse(string_to_delta),
 
213
        help="Set duration of one client approval")
 
214
    parser.add_argument("-H", "--host", dest="commands",
 
215
                        action="append", default=[], metavar="STRING",
 
216
                        type=command.SetHost,
 
217
                        help="Set host for client")
 
218
    parser.add_argument(
 
219
        "-s", "--secret", dest="commands", action="append",
 
220
        default=[], metavar="FILENAME",
 
221
        type=command.SetSecret.argparse(argparse.FileType(mode="rb")),
 
222
        help="Set password blob (file) for client")
188
223
    approve_deny = parser.add_mutually_exclusive_group()
189
224
    approve_deny.add_argument(
190
 
        "-A", "--approve", action="store_true",
 
225
        "-A", "--approve", dest="commands", action="append_const",
 
226
        default=[], const=command.Approve(),
191
227
        help="Approve any current client request")
192
 
    approve_deny.add_argument("-D", "--deny", action="store_true",
 
228
    approve_deny.add_argument("-D", "--deny", dest="commands",
 
229
                              action="append_const", default=[],
 
230
                              const=command.Deny(),
193
231
                              help="Deny any current client request")
194
232
    parser.add_argument("--debug", action="store_true",
195
233
                        help="Debug mode (show D-Bus commands)")
212
250
def rfc3339_duration_to_delta(duration):
213
251
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
214
252
 
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)
 
253
    >>> rfc3339_duration_to_delta("P7D") == datetime.timedelta(7)
 
254
    True
 
255
    >>> rfc3339_duration_to_delta("PT60S") == datetime.timedelta(0, 60)
 
256
    True
 
257
    >>> rfc3339_duration_to_delta("PT60M") == datetime.timedelta(hours=1)
 
258
    True
 
259
    >>> # 60 months
 
260
    >>> rfc3339_duration_to_delta("P60M") == datetime.timedelta(1680)
 
261
    True
 
262
    >>> rfc3339_duration_to_delta("PT24H") == datetime.timedelta(1)
 
263
    True
 
264
    >>> rfc3339_duration_to_delta("P1W") == datetime.timedelta(7)
 
265
    True
 
266
    >>> rfc3339_duration_to_delta("PT5M30S") == datetime.timedelta(0, 330)
 
267
    True
 
268
    >>> rfc3339_duration_to_delta("P1DT3M20S") == datetime.timedelta(1, 200)
 
269
    True
231
270
    >>> # Can not be empty:
232
271
    >>> rfc3339_duration_to_delta("")
233
272
    Traceback (most recent call last):
343
382
    """Parse an interval string as documented by Mandos before 1.6.1,
344
383
    and return a datetime.timedelta
345
384
 
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)
 
385
    >>> parse_pre_1_6_1_interval('7d') == datetime.timedelta(days=7)
 
386
    True
 
387
    >>> parse_pre_1_6_1_interval('60s') == datetime.timedelta(0, 60)
 
388
    True
 
389
    >>> parse_pre_1_6_1_interval('60m') == datetime.timedelta(hours=1)
 
390
    True
 
391
    >>> parse_pre_1_6_1_interval('24h') == datetime.timedelta(days=1)
 
392
    True
 
393
    >>> parse_pre_1_6_1_interval('1w') == datetime.timedelta(days=7)
 
394
    True
 
395
    >>> parse_pre_1_6_1_interval('5m 30s') == datetime.timedelta(0, 330)
 
396
    True
 
397
    >>> parse_pre_1_6_1_interval('') == datetime.timedelta(0)
 
398
    True
360
399
    >>> # Ignore unknown characters, allow any order and repetitions
361
 
    >>> parse_pre_1_6_1_interval('2dxy7zz11y3m5m')
362
 
    datetime.timedelta(2, 480, 18000)
 
400
    >>> parse_pre_1_6_1_interval('2dxy7zz11y3m5m') == datetime.timedelta(2, 480, 18000)
 
401
    True
363
402
 
364
403
    """
365
404
 
386
425
    """Apply additional restrictions on options, not expressible in
387
426
argparse"""
388
427
 
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))
 
428
    def has_commands(options, commands=None):
 
429
        if commands is None:
 
430
            commands = (command.Enable,
 
431
                        command.Disable,
 
432
                        command.BumpTimeout,
 
433
                        command.StartChecker,
 
434
                        command.StopChecker,
 
435
                        command.IsEnabled,
 
436
                        command.Remove,
 
437
                        command.SetChecker,
 
438
                        command.SetTimeout,
 
439
                        command.SetExtendedTimeout,
 
440
                        command.SetInterval,
 
441
                        command.ApproveByDefault,
 
442
                        command.DenyByDefault,
 
443
                        command.SetApprovalDelay,
 
444
                        command.SetApprovalDuration,
 
445
                        command.SetHost,
 
446
                        command.SetSecret,
 
447
                        command.Approve,
 
448
                        command.Deny)
 
449
        return any(isinstance(cmd, commands)
 
450
                   for cmd in options.commands)
408
451
 
409
 
    if has_actions(options) and not (options.client or options.all):
 
452
    if has_commands(options) and not (options.client or options.all):
410
453
        parser.error("Options require clients names or --all.")
411
 
    if options.verbose and has_actions(options):
 
454
    if options.verbose and has_commands(options):
412
455
        parser.error("--verbose can only be used alone.")
413
 
    if options.dump_json and (options.verbose
414
 
                              or has_actions(options)):
 
456
    if (has_commands(options, (command.DumpJSON,))
 
457
        and (options.verbose or len(options.commands) > 1)):
415
458
        parser.error("--dump-json can only be used alone.")
416
 
    if options.all and not has_actions(options):
 
459
    if options.all and not has_commands(options):
417
460
        parser.error("--all requires an action.")
418
 
    if options.is_enabled and len(options.client) > 1:
 
461
    if (has_commands(options, (command.IsEnabled,))
 
462
        and len(options.client) > 1):
419
463
        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)
 
464
    if (len(options.commands) > 1
 
465
        and has_commands(options, (command.Remove,))
 
466
        and not has_commands(options, (command.Deny,))):
 
467
        parser.error("--remove can only be combined with --deny")
 
468
 
 
469
 
 
470
class dbus(object):
 
471
 
 
472
    class SystemBus(object):
 
473
 
 
474
        object_manager_iface = "org.freedesktop.DBus.ObjectManager"
 
475
        def get_managed_objects(self, busname, objectpath):
 
476
            return self.call_method("GetManagedObjects", busname,
 
477
                                    objectpath,
 
478
                                    self.object_manager_iface)
 
479
 
 
480
        properties_iface = "org.freedesktop.DBus.Properties"
 
481
        def set_property(self, busname, objectpath, interface, key,
 
482
                         value):
 
483
            self.call_method("Set", busname, objectpath,
 
484
                             self.properties_iface, interface, key,
 
485
                             value)
 
486
 
 
487
 
 
488
    class MandosBus(SystemBus):
 
489
        busname_domain = "se.recompile"
 
490
        busname = busname_domain + ".Mandos"
 
491
        server_path = "/"
 
492
        server_interface = busname_domain + ".Mandos"
 
493
        client_interface = busname_domain + ".Mandos.Client"
 
494
        del busname_domain
 
495
 
 
496
        def get_clients_and_properties(self):
 
497
            managed_objects = self.get_managed_objects(
 
498
                self.busname, self.server_path)
 
499
            return {objpath: properties[self.client_interface]
 
500
                    for objpath, properties in managed_objects.items()
 
501
                    if self.client_interface in properties}
 
502
 
 
503
        def set_client_property(self, objectpath, key, value):
 
504
            return self.set_property(self.busname, objectpath,
 
505
                                     self.client_interface, key,
 
506
                                     value)
 
507
 
 
508
        def call_client_method(self, objectpath, method, *args):
 
509
            return self.call_method(method, self.busname, objectpath,
 
510
                                    self.client_interface, *args)
 
511
 
 
512
        def call_server_method(self, method, *args):
 
513
            return self.call_method(method, self.busname,
 
514
                                    self.server_path,
 
515
                                    self.server_interface, *args)
 
516
 
 
517
    class Error(Exception):
 
518
        pass
 
519
 
 
520
    class ConnectFailed(Error):
 
521
        pass
 
522
 
 
523
 
 
524
class dbus_python_adapter(object):
 
525
 
 
526
    class SystemBus(dbus.MandosBus):
 
527
        """Use dbus-python"""
 
528
 
 
529
        def __init__(self, module=dbus_python):
 
530
            self.dbus_python = module
 
531
            self.bus = self.dbus_python.SystemBus()
 
532
 
 
533
        @contextlib.contextmanager
 
534
        def convert_exception(self, exception_class=dbus.Error):
 
535
            try:
 
536
                yield
 
537
            except self.dbus_python.exceptions.DBusException as e:
 
538
                # This does what "raise from" would do
 
539
                exc = exception_class(*e.args)
 
540
                exc.__cause__ = e
 
541
                raise exc
 
542
 
 
543
        def call_method(self, methodname, busname, objectpath,
 
544
                        interface, *args):
 
545
            proxy_object = self.get_object(busname, objectpath)
 
546
            log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
 
547
                      interface, methodname,
 
548
                      ", ".join(repr(a) for a in args))
 
549
            method = getattr(proxy_object, methodname)
 
550
            with self.convert_exception():
 
551
                with dbus_python_adapter.SilenceLogger(
 
552
                        "dbus.proxies"):
 
553
                    value = method(*args, dbus_interface=interface)
 
554
            return self.type_filter(value)
 
555
 
 
556
        def get_object(self, busname, objectpath):
 
557
            log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
 
558
                      busname, objectpath)
 
559
            with self.convert_exception(dbus.ConnectFailed):
 
560
                return self.bus.get_object(busname, objectpath)
 
561
 
 
562
        def type_filter(self, value):
 
563
            """Convert the most bothersome types to Python types"""
 
564
            if isinstance(value, self.dbus_python.Boolean):
 
565
                return bool(value)
 
566
            if isinstance(value, self.dbus_python.ObjectPath):
 
567
                return str(value)
 
568
            # Also recurse into dictionaries
 
569
            if isinstance(value, self.dbus_python.Dictionary):
 
570
                return {self.type_filter(key):
 
571
                        self.type_filter(subval)
 
572
                        for key, subval in value.items()}
 
573
            return value
 
574
 
 
575
        def set_client_property(self, objectpath, key, value):
 
576
            if key == "Secret":
 
577
                if not isinstance(value, bytes):
 
578
                    value = value.encode("utf-8")
 
579
                value = self.dbus_python.ByteArray(value)
 
580
            return self.set_property(self.busname, objectpath,
 
581
                                     self.client_interface, key,
 
582
                                     value)
 
583
 
 
584
    class SilenceLogger(object):
 
585
        "Simple context manager to silence a particular logger"
 
586
        def __init__(self, loggername):
 
587
            self.logger = logging.getLogger(loggername)
 
588
 
 
589
        def __enter__(self):
 
590
            self.logger.addFilter(self.nullfilter)
 
591
 
 
592
        class NullFilter(logging.Filter):
 
593
            def filter(self, record):
 
594
                return False
 
595
 
 
596
        nullfilter = NullFilter()
 
597
 
 
598
        def __exit__(self, exc_type, exc_val, exc_tb):
 
599
            self.logger.removeFilter(self.nullfilter)
 
600
 
 
601
 
 
602
    class CachingBus(SystemBus):
 
603
        """A caching layer for dbus_python_adapter.SystemBus"""
 
604
        def __init__(self, *args, **kwargs):
 
605
            self.object_cache = {}
 
606
            super(dbus_python_adapter.CachingBus,
 
607
                  self).__init__(*args, **kwargs)
 
608
        def get_object(self, busname, objectpath):
 
609
            try:
 
610
                return self.object_cache[(busname, objectpath)]
 
611
            except KeyError:
 
612
                new_object = super(
 
613
                    dbus_python_adapter.CachingBus,
 
614
                    self).get_object(busname, objectpath)
 
615
                self.object_cache[(busname, objectpath)]  = new_object
 
616
                return new_object
 
617
 
 
618
 
 
619
class pydbus_adapter(object):
 
620
    class SystemBus(dbus.MandosBus):
 
621
        def __init__(self, module=pydbus):
 
622
            self.pydbus = module
 
623
            self.bus = self.pydbus.SystemBus()
 
624
 
 
625
        @contextlib.contextmanager
 
626
        def convert_exception(self, exception_class=dbus.Error):
 
627
            try:
 
628
                yield
 
629
            except gi.repository.GLib.Error as e:
 
630
                # This does what "raise from" would do
 
631
                exc = exception_class(*e.args)
 
632
                exc.__cause__ = e
 
633
                raise exc
 
634
 
 
635
        def call_method(self, methodname, busname, objectpath,
 
636
                        interface, *args):
 
637
            proxy_object = self.get(busname, objectpath)
 
638
            log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
 
639
                      interface, methodname,
 
640
                      ", ".join(repr(a) for a in args))
 
641
            method = getattr(proxy_object[interface], methodname)
 
642
            with self.convert_exception():
 
643
                return method(*args)
 
644
 
 
645
        def get(self, busname, objectpath):
 
646
            log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
 
647
                      busname, objectpath)
 
648
            with self.convert_exception(dbus.ConnectFailed):
 
649
                if sys.version_info.major <= 2:
 
650
                    with warnings.catch_warnings():
 
651
                        warnings.filterwarnings(
 
652
                            "ignore", "", DeprecationWarning,
 
653
                            r"^xml\.etree\.ElementTree$")
 
654
                        return self.bus.get(busname, objectpath)
 
655
                else:
 
656
                    return self.bus.get(busname, objectpath)
 
657
 
 
658
        def set_property(self, busname, objectpath, interface, key,
 
659
                         value):
 
660
            proxy_object = self.get(busname, objectpath)
 
661
            log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", busname,
 
662
                      objectpath, self.properties_iface, interface,
 
663
                      key, value)
 
664
            setattr(proxy_object[interface], key, value)
 
665
 
 
666
    class CachingBus(SystemBus):
 
667
        """A caching layer for pydbus_adapter.SystemBus"""
 
668
        def __init__(self, *args, **kwargs):
 
669
            self.object_cache = {}
 
670
            super(pydbus_adapter.CachingBus,
 
671
                  self).__init__(*args, **kwargs)
 
672
        def get(self, busname, objectpath):
 
673
            try:
 
674
                return self.object_cache[(busname, objectpath)]
 
675
            except KeyError:
 
676
                new_object = (super(pydbus_adapter.CachingBus, self)
 
677
                              .get(busname, objectpath))
 
678
                self.object_cache[(busname, objectpath)]  = new_object
 
679
                return new_object
472
680
 
473
681
 
474
682
def commands_from_options(options):
475
683
 
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())
 
684
    commands = list(options.commands)
 
685
 
 
686
    def find_cmd(cmd, commands):
 
687
        i = 0
 
688
        for i, c in enumerate(commands):
 
689
            if isinstance(c, cmd):
 
690
                return i
 
691
        return i+1
 
692
 
 
693
    # If command.Remove is present, move any instances of command.Deny
 
694
    # to occur ahead of command.Remove.
 
695
    index_of_remove = find_cmd(command.Remove, commands)
 
696
    before_remove = commands[:index_of_remove]
 
697
    after_remove = commands[index_of_remove:]
 
698
    cleaned_after = []
 
699
    for cmd in after_remove:
 
700
        if isinstance(cmd, command.Deny):
 
701
            before_remove.append(cmd)
511
702
        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))
 
703
            cleaned_after.append(cmd)
 
704
    if cleaned_after != after_remove:
 
705
        commands = before_remove + cleaned_after
540
706
 
541
707
    # If no command option has been given, show table of clients,
542
708
    # optionally verbosely
551
717
 
552
718
    class Base(object):
553
719
        """Abstract base class for commands"""
554
 
        def run(self, clients, bus=None, mandos=None):
 
720
        def run(self, clients, bus=None):
555
721
            """Normal commands should implement run_on_one_client(),
556
722
but commands which want to operate on all clients at the same time can
557
723
override this run() method instead.
558
724
"""
559
 
            for clientpath, properties in clients.items():
560
 
                log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
561
 
                          dbus_busname, str(clientpath))
562
 
                client = bus.get_object(dbus_busname, clientpath)
 
725
            self.bus = bus
 
726
            for client, properties in clients.items():
563
727
                self.run_on_one_client(client, properties)
564
728
 
565
729
 
566
730
    class IsEnabled(Base):
567
 
        def run(self, clients, bus=None, mandos=None):
568
 
            client, properties = next(iter(clients.items()))
569
 
            if self.is_enabled(client, properties):
 
731
        def run(self, clients, bus=None):
 
732
            properties = next(iter(clients.values()))
 
733
            if properties["Enabled"]:
570
734
                sys.exit(0)
571
735
            sys.exit(1)
572
 
        def is_enabled(self, client, properties):
573
 
            return properties["Enabled"]
574
736
 
575
737
 
576
738
    class Approve(Base):
577
739
        def run_on_one_client(self, client, properties):
578
 
            log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
579
 
                      client.__dbus_object_path__,
580
 
                      client_dbus_interface)
581
 
            client.Approve(dbus.Boolean(True),
582
 
                           dbus_interface=client_dbus_interface)
 
740
            self.bus.call_client_method(client, "Approve", True)
583
741
 
584
742
 
585
743
    class Deny(Base):
586
744
        def run_on_one_client(self, client, properties):
587
 
            log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
588
 
                      client.__dbus_object_path__,
589
 
                      client_dbus_interface)
590
 
            client.Approve(dbus.Boolean(False),
591
 
                           dbus_interface=client_dbus_interface)
 
745
            self.bus.call_client_method(client, "Approve", False)
592
746
 
593
747
 
594
748
    class Remove(Base):
595
 
        def run(self, clients, bus, mandos):
596
 
            for clientpath in clients.keys():
597
 
                log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)",
598
 
                          dbus_busname, server_dbus_path,
599
 
                          server_dbus_interface, clientpath)
600
 
                mandos.RemoveClient(clientpath)
 
749
        def run(self, clients, bus):
 
750
            for clientpath in frozenset(clients.keys()):
 
751
                bus.call_server_method("RemoveClient", clientpath)
601
752
 
602
753
 
603
754
    class Output(Base):
613
764
 
614
765
 
615
766
    class DumpJSON(Output):
616
 
        def run(self, clients, bus=None, mandos=None):
617
 
            data = {client["Name"]:
618
 
                    {key: self.dbus_boolean_to_bool(client[key])
 
767
        def run(self, clients, bus=None):
 
768
            data = {properties["Name"]:
 
769
                    {key: properties[key]
619
770
                     for key in self.all_keywords}
620
 
                    for client in clients.values()}
 
771
                    for properties in clients.values()}
621
772
            print(json.dumps(data, indent=4, separators=(',', ': ')))
622
773
 
623
 
        @staticmethod
624
 
        def dbus_boolean_to_bool(value):
625
 
            if isinstance(value, dbus.Boolean):
626
 
                value = bool(value)
627
 
            return value
628
 
 
629
774
 
630
775
    class PrintTable(Output):
631
776
        def __init__(self, verbose=False):
632
777
            self.verbose = verbose
633
778
 
634
 
        def run(self, clients, bus=None, mandos=None):
 
779
        def run(self, clients, bus=None):
635
780
            default_keywords = ("Name", "Enabled", "Timeout",
636
781
                                "LastCheckedOK")
637
782
            keywords = default_keywords
698
843
 
699
844
            @classmethod
700
845
            def valuetostring(cls, value, keyword):
701
 
                if isinstance(value, dbus.Boolean):
 
846
                if isinstance(value, bool):
702
847
                    return "Yes" if value else "No"
703
848
                if keyword in ("Timeout", "Interval", "ApprovalDelay",
704
849
                               "ApprovalDuration", "ExtendedTimeout"):
727
872
    class PropertySetter(Base):
728
873
        "Abstract class for Actions for setting one client property"
729
874
 
730
 
        def run_on_one_client(self, client, properties):
 
875
        def run_on_one_client(self, client, properties=None):
731
876
            """Set the Client's D-Bus property"""
732
 
            log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
733
 
                      client.__dbus_object_path__,
734
 
                      dbus.PROPERTIES_IFACE, client_dbus_interface,
735
 
                      self.propname, self.value_to_set
736
 
                      if not isinstance(self.value_to_set,
737
 
                                        dbus.Boolean)
738
 
                      else bool(self.value_to_set))
739
 
            client.Set(client_dbus_interface, self.propname,
740
 
                       self.value_to_set,
741
 
                       dbus_interface=dbus.PROPERTIES_IFACE)
 
877
            self.bus.set_client_property(client, self.propname,
 
878
                                         self.value_to_set)
742
879
 
743
880
        @property
744
881
        def propname(self):
747
884
 
748
885
    class Enable(PropertySetter):
749
886
        propname = "Enabled"
750
 
        value_to_set = dbus.Boolean(True)
 
887
        value_to_set = True
751
888
 
752
889
 
753
890
    class Disable(PropertySetter):
754
891
        propname = "Enabled"
755
 
        value_to_set = dbus.Boolean(False)
 
892
        value_to_set = False
756
893
 
757
894
 
758
895
    class BumpTimeout(PropertySetter):
762
899
 
763
900
    class StartChecker(PropertySetter):
764
901
        propname = "CheckerRunning"
765
 
        value_to_set = dbus.Boolean(True)
 
902
        value_to_set = True
766
903
 
767
904
 
768
905
    class StopChecker(PropertySetter):
769
906
        propname = "CheckerRunning"
770
 
        value_to_set = dbus.Boolean(False)
 
907
        value_to_set = False
771
908
 
772
909
 
773
910
    class ApproveByDefault(PropertySetter):
774
911
        propname = "ApprovedByDefault"
775
 
        value_to_set = dbus.Boolean(True)
 
912
        value_to_set = True
776
913
 
777
914
 
778
915
    class DenyByDefault(PropertySetter):
779
916
        propname = "ApprovedByDefault"
780
 
        value_to_set = dbus.Boolean(False)
 
917
        value_to_set = False
781
918
 
782
919
 
783
920
    class PropertySetterValue(PropertySetter):
786
923
        def __init__(self, value):
787
924
            self.value_to_set = value
788
925
 
 
926
        @classmethod
 
927
        def argparse(cls, argtype):
 
928
            def cmdtype(arg):
 
929
                return cls(argtype(arg))
 
930
            return cmdtype
789
931
 
790
932
    class SetChecker(PropertySetterValue):
791
933
        propname = "Checker"
879
1021
                                                     "output"))
880
1022
 
881
1023
 
 
1024
class Unique(object):
 
1025
    """Class for objects which exist only to be unique objects, since
 
1026
unittest.mock.sentinel only exists in Python 3.3"""
 
1027
 
 
1028
 
882
1029
class Test_string_to_delta(TestCaseWithAssertLogs):
883
1030
    # Just test basic RFC 3339 functionality here, the doc string for
884
1031
    # rfc3339_duration_to_delta() already has more comprehensive
885
 
    # tests, which is run by doctest.
 
1032
    # tests, which are run by doctest.
886
1033
 
887
1034
    def test_rfc3339_zero_seconds(self):
888
1035
        self.assertEqual(datetime.timedelta(),
912
1059
 
913
1060
    def test_actions_requires_client_or_all(self):
914
1061
        for action, value in self.actions.items():
915
 
            options = self.parser.parse_args()
916
 
            setattr(options, action, value)
 
1062
            args = self.actionargs(action, value)
917
1063
            with self.assertParseError():
918
 
                self.check_option_syntax(options)
 
1064
                self.parse_args(args)
919
1065
 
920
 
    # This mostly corresponds to the definition from has_actions() in
 
1066
    # This mostly corresponds to the definition from has_commands() in
921
1067
    # check_option_syntax()
922
1068
    actions = {
923
 
        # The actual values set here are not that important, but we do
924
 
        # at least stick to the correct types, even though they are
925
 
        # never used
926
 
        "enable": True,
927
 
        "disable": True,
928
 
        "bump_timeout": True,
929
 
        "start_checker": True,
930
 
        "stop_checker": True,
931
 
        "is_enabled": True,
932
 
        "remove": True,
933
 
        "checker": "x",
934
 
        "timeout": datetime.timedelta(),
935
 
        "extended_timeout": datetime.timedelta(),
936
 
        "interval": datetime.timedelta(),
937
 
        "approved_by_default": True,
938
 
        "approval_delay": datetime.timedelta(),
939
 
        "approval_duration": datetime.timedelta(),
940
 
        "host": "x",
941
 
        "secret": io.BytesIO(b"x"),
942
 
        "approve": True,
943
 
        "deny": True,
 
1069
        "--enable": None,
 
1070
        "--disable": None,
 
1071
        "--bump-timeout": None,
 
1072
        "--start-checker": None,
 
1073
        "--stop-checker": None,
 
1074
        "--is-enabled": None,
 
1075
        "--remove": None,
 
1076
        "--checker": "x",
 
1077
        "--timeout": "PT0S",
 
1078
        "--extended-timeout": "PT0S",
 
1079
        "--interval": "PT0S",
 
1080
        "--approve-by-default": None,
 
1081
        "--deny-by-default": None,
 
1082
        "--approval-delay": "PT0S",
 
1083
        "--approval-duration": "PT0S",
 
1084
        "--host": "hostname",
 
1085
        "--secret": "/dev/null",
 
1086
        "--approve": None,
 
1087
        "--deny": None,
944
1088
    }
945
1089
 
 
1090
    @staticmethod
 
1091
    def actionargs(action, value, *args):
 
1092
        if value is not None:
 
1093
            return [action, value] + list(args)
 
1094
        else:
 
1095
            return [action] + list(args)
 
1096
 
946
1097
    @contextlib.contextmanager
947
1098
    def assertParseError(self):
948
1099
        with self.assertRaises(SystemExit) as e:
953
1104
        # /argparse.html#exiting-methods
954
1105
        self.assertEqual(2, e.exception.code)
955
1106
 
 
1107
    def parse_args(self, args):
 
1108
        options = self.parser.parse_args(args)
 
1109
        check_option_syntax(self.parser, options)
 
1110
 
956
1111
    @staticmethod
957
1112
    @contextlib.contextmanager
958
1113
    def redirect_stderr_to_devnull():
969
1124
 
970
1125
    def test_actions_all_conflicts_with_verbose(self):
971
1126
        for action, value in self.actions.items():
972
 
            options = self.parser.parse_args()
973
 
            setattr(options, action, value)
974
 
            options.all = True
975
 
            options.verbose = True
 
1127
            args = self.actionargs(action, value, "--all",
 
1128
                                   "--verbose")
976
1129
            with self.assertParseError():
977
 
                self.check_option_syntax(options)
 
1130
                self.parse_args(args)
978
1131
 
979
1132
    def test_actions_with_client_conflicts_with_verbose(self):
980
1133
        for action, value in self.actions.items():
981
 
            options = self.parser.parse_args()
982
 
            setattr(options, action, value)
983
 
            options.verbose = True
984
 
            options.client = ["client"]
 
1134
            args = self.actionargs(action, value, "--verbose",
 
1135
                                   "client")
985
1136
            with self.assertParseError():
986
 
                self.check_option_syntax(options)
 
1137
                self.parse_args(args)
987
1138
 
988
1139
    def test_dump_json_conflicts_with_verbose(self):
989
 
        options = self.parser.parse_args()
990
 
        options.dump_json = True
991
 
        options.verbose = True
 
1140
        args = ["--dump-json", "--verbose"]
992
1141
        with self.assertParseError():
993
 
            self.check_option_syntax(options)
 
1142
            self.parse_args(args)
994
1143
 
995
1144
    def test_dump_json_conflicts_with_action(self):
996
1145
        for action, value in self.actions.items():
997
 
            options = self.parser.parse_args()
998
 
            setattr(options, action, value)
999
 
            options.dump_json = True
 
1146
            args = self.actionargs(action, value, "--dump-json")
1000
1147
            with self.assertParseError():
1001
 
                self.check_option_syntax(options)
 
1148
                self.parse_args(args)
1002
1149
 
1003
1150
    def test_all_can_not_be_alone(self):
1004
 
        options = self.parser.parse_args()
1005
 
        options.all = True
 
1151
        args = ["--all"]
1006
1152
        with self.assertParseError():
1007
 
            self.check_option_syntax(options)
 
1153
            self.parse_args(args)
1008
1154
 
1009
1155
    def test_all_is_ok_with_any_action(self):
1010
1156
        for action, value in self.actions.items():
1011
 
            options = self.parser.parse_args()
1012
 
            setattr(options, action, value)
1013
 
            options.all = True
1014
 
            self.check_option_syntax(options)
 
1157
            args = self.actionargs(action, value, "--all")
 
1158
            self.parse_args(args)
1015
1159
 
1016
1160
    def test_any_action_is_ok_with_one_client(self):
1017
1161
        for action, value in self.actions.items():
1018
 
            options = self.parser.parse_args()
1019
 
            setattr(options, action, value)
1020
 
            options.client = ["client"]
1021
 
            self.check_option_syntax(options)
 
1162
            args = self.actionargs(action, value, "client")
 
1163
            self.parse_args(args)
1022
1164
 
1023
1165
    def test_one_client_with_all_actions_except_is_enabled(self):
1024
 
        options = self.parser.parse_args()
1025
1166
        for action, value in self.actions.items():
1026
 
            if action == "is_enabled":
 
1167
            if action == "--is-enabled":
1027
1168
                continue
1028
 
            setattr(options, action, value)
1029
 
        options.client = ["client"]
1030
 
        self.check_option_syntax(options)
 
1169
            args = self.actionargs(action, value, "client")
 
1170
            self.parse_args(args)
1031
1171
 
1032
1172
    def test_two_clients_with_all_actions_except_is_enabled(self):
1033
 
        options = self.parser.parse_args()
1034
1173
        for action, value in self.actions.items():
1035
 
            if action == "is_enabled":
 
1174
            if action == "--is-enabled":
1036
1175
                continue
1037
 
            setattr(options, action, value)
1038
 
        options.client = ["client1", "client2"]
1039
 
        self.check_option_syntax(options)
 
1176
            args = self.actionargs(action, value, "client1",
 
1177
                                   "client2")
 
1178
            self.parse_args(args)
1040
1179
 
1041
1180
    def test_two_clients_are_ok_with_actions_except_is_enabled(self):
1042
1181
        for action, value in self.actions.items():
1043
 
            if action == "is_enabled":
 
1182
            if action == "--is-enabled":
1044
1183
                continue
1045
 
            options = self.parser.parse_args()
1046
 
            setattr(options, action, value)
1047
 
            options.client = ["client1", "client2"]
1048
 
            self.check_option_syntax(options)
 
1184
            args = self.actionargs(action, value, "client1",
 
1185
                                   "client2")
 
1186
            self.parse_args(args)
1049
1187
 
1050
1188
    def test_is_enabled_fails_without_client(self):
1051
 
        options = self.parser.parse_args()
1052
 
        options.is_enabled = True
 
1189
        args = ["--is-enabled"]
1053
1190
        with self.assertParseError():
1054
 
            self.check_option_syntax(options)
 
1191
            self.parse_args(args)
1055
1192
 
1056
1193
    def test_is_enabled_fails_with_two_clients(self):
1057
 
        options = self.parser.parse_args()
1058
 
        options.is_enabled = True
1059
 
        options.client = ["client1", "client2"]
 
1194
        args = ["--is-enabled", "client1", "client2"]
1060
1195
        with self.assertParseError():
1061
 
            self.check_option_syntax(options)
 
1196
            self.parse_args(args)
1062
1197
 
1063
1198
    def test_remove_can_only_be_combined_with_action_deny(self):
1064
1199
        for action, value in self.actions.items():
1065
 
            if action in {"remove", "deny"}:
 
1200
            if action in {"--remove", "--deny"}:
1066
1201
                continue
1067
 
            options = self.parser.parse_args()
1068
 
            setattr(options, action, value)
1069
 
            options.all = True
1070
 
            options.remove = True
 
1202
            args = self.actionargs(action, value, "--all",
 
1203
                                   "--remove")
1071
1204
            with self.assertParseError():
1072
 
                self.check_option_syntax(options)
1073
 
 
1074
 
 
1075
 
class Test_get_mandos_dbus_object(TestCaseWithAssertLogs):
1076
 
    def test_calls_and_returns_get_object_on_bus(self):
1077
 
        class MockBus(object):
1078
 
            called = False
1079
 
            def get_object(mockbus_self, busname, dbus_path):
1080
 
                # Note that "self" is still the testcase instance,
1081
 
                # this MockBus instance is in "mockbus_self".
1082
 
                self.assertEqual(dbus_busname, busname)
1083
 
                self.assertEqual(server_dbus_path, dbus_path)
1084
 
                mockbus_self.called = True
1085
 
                return mockbus_self
1086
 
 
1087
 
        mockbus = get_mandos_dbus_object(bus=MockBus())
1088
 
        self.assertIsInstance(mockbus, MockBus)
1089
 
        self.assertTrue(mockbus.called)
1090
 
 
1091
 
    def test_logs_and_exits_on_dbus_error(self):
1092
 
        class FailingBusStub(object):
1093
 
            def get_object(self, busname, dbus_path):
1094
 
                raise dbus.exceptions.DBusException("Test")
1095
 
 
1096
 
        with self.assertLogs(log, logging.CRITICAL):
1097
 
            with self.assertRaises(SystemExit) as e:
1098
 
                bus = get_mandos_dbus_object(bus=FailingBusStub())
1099
 
 
1100
 
        if isinstance(e.exception.code, int):
1101
 
            self.assertNotEqual(0, e.exception.code)
1102
 
        else:
1103
 
            self.assertIsNotNone(e.exception.code)
1104
 
 
1105
 
 
1106
 
class Test_get_managed_objects(TestCaseWithAssertLogs):
1107
 
    def test_calls_and_returns_GetManagedObjects(self):
1108
 
        managed_objects = {"/clients/client": { "Name": "client"}}
1109
 
        class ObjectManagerStub(object):
1110
 
            def GetManagedObjects(self):
1111
 
                return managed_objects
1112
 
        retval = get_managed_objects(ObjectManagerStub())
1113
 
        self.assertDictEqual(managed_objects, retval)
1114
 
 
1115
 
    def test_logs_and_exits_on_dbus_error(self):
 
1205
                self.parse_args(args)
 
1206
 
 
1207
 
 
1208
class Test_dbus_exceptions(unittest.TestCase):
 
1209
 
 
1210
    def test_dbus_ConnectFailed_is_Error(self):
 
1211
        with self.assertRaises(dbus.Error):
 
1212
            raise dbus.ConnectFailed()
 
1213
 
 
1214
 
 
1215
class Test_dbus_MandosBus(unittest.TestCase):
 
1216
 
 
1217
    class MockMandosBus(dbus.MandosBus):
 
1218
        def __init__(self):
 
1219
            self._name = "se.recompile.Mandos"
 
1220
            self._server_path = "/"
 
1221
            self._server_interface = "se.recompile.Mandos"
 
1222
            self._client_interface = "se.recompile.Mandos.Client"
 
1223
            self.calls = []
 
1224
            self.call_method_return = Unique()
 
1225
 
 
1226
        def call_method(self, methodname, busname, objectpath,
 
1227
                        interface, *args):
 
1228
            self.calls.append((methodname, busname, objectpath,
 
1229
                               interface, args))
 
1230
            return self.call_method_return
 
1231
 
 
1232
    def setUp(self):
 
1233
        self.bus = self.MockMandosBus()
 
1234
 
 
1235
    def test_set_client_property(self):
 
1236
        self.bus.set_client_property("objectpath", "key", "value")
 
1237
        expected_call = ("Set", self.bus._name, "objectpath",
 
1238
                         "org.freedesktop.DBus.Properties",
 
1239
                         (self.bus._client_interface, "key", "value"))
 
1240
        self.assertIn(expected_call, self.bus.calls)
 
1241
 
 
1242
    def test_call_client_method(self):
 
1243
        ret = self.bus.call_client_method("objectpath", "methodname")
 
1244
        self.assertIs(self.bus.call_method_return, ret)
 
1245
        expected_call = ("methodname", self.bus._name, "objectpath",
 
1246
                         self.bus._client_interface, ())
 
1247
        self.assertIn(expected_call, self.bus.calls)
 
1248
 
 
1249
    def test_call_client_method_with_args(self):
 
1250
        args = (Unique(), Unique())
 
1251
        ret = self.bus.call_client_method("objectpath", "methodname",
 
1252
                                          *args)
 
1253
        self.assertIs(self.bus.call_method_return, ret)
 
1254
        expected_call = ("methodname", self.bus._name, "objectpath",
 
1255
                         self.bus._client_interface,
 
1256
                         (args[0], args[1]))
 
1257
        self.assertIn(expected_call, self.bus.calls)
 
1258
 
 
1259
    def test_get_clients_and_properties(self):
 
1260
        managed_objects = {
 
1261
            "objectpath": {
 
1262
                self.bus._client_interface: {
 
1263
                    "key": "value",
 
1264
                    "bool": True,
 
1265
                },
 
1266
                "irrelevant_interface": {
 
1267
                    "key": "othervalue",
 
1268
                    "bool": False,
 
1269
                },
 
1270
            },
 
1271
            "other_objectpath": {
 
1272
                "other_irrelevant_interface": {
 
1273
                    "key": "value 3",
 
1274
                    "bool": None,
 
1275
                },
 
1276
            },
 
1277
        }
 
1278
        expected_clients_and_properties = {
 
1279
            "objectpath": {
 
1280
                "key": "value",
 
1281
                "bool": True,
 
1282
            }
 
1283
        }
 
1284
        self.bus.call_method_return = managed_objects
 
1285
        ret = self.bus.get_clients_and_properties()
 
1286
        self.assertDictEqual(expected_clients_and_properties, ret)
 
1287
        expected_call = ("GetManagedObjects", self.bus._name,
 
1288
                         self.bus._server_path,
 
1289
                         "org.freedesktop.DBus.ObjectManager", ())
 
1290
        self.assertIn(expected_call, self.bus.calls)
 
1291
 
 
1292
    def test_call_server_method(self):
 
1293
        ret = self.bus.call_server_method("methodname")
 
1294
        self.assertIs(self.bus.call_method_return, ret)
 
1295
        expected_call = ("methodname", self.bus._name,
 
1296
                         self.bus._server_path,
 
1297
                         self.bus._server_interface, ())
 
1298
        self.assertIn(expected_call, self.bus.calls)
 
1299
 
 
1300
    def test_call_server_method_with_args(self):
 
1301
        args = (Unique(), Unique())
 
1302
        ret = self.bus.call_server_method("methodname", *args)
 
1303
        self.assertIs(self.bus.call_method_return, ret)
 
1304
        expected_call = ("methodname", self.bus._name,
 
1305
                         self.bus._server_path,
 
1306
                         self.bus._server_interface,
 
1307
                         (args[0], args[1]))
 
1308
        self.assertIn(expected_call, self.bus.calls)
 
1309
 
 
1310
 
 
1311
class Test_dbus_python_adapter_SystemBus(TestCaseWithAssertLogs):
 
1312
 
 
1313
    def MockDBusPython_func(self, func):
 
1314
        class mock_dbus_python(object):
 
1315
            """mock dbus-python module"""
 
1316
            class exceptions(object):
 
1317
                """Pseudo-namespace"""
 
1318
                class DBusException(Exception):
 
1319
                    pass
 
1320
            class SystemBus(object):
 
1321
                @staticmethod
 
1322
                def get_object(busname, objectpath):
 
1323
                    DBusObject = collections.namedtuple(
 
1324
                        "DBusObject", ("methodname", "Set"))
 
1325
                    def method(*args, **kwargs):
 
1326
                        self.assertEqual({"dbus_interface":
 
1327
                                          "interface"},
 
1328
                                         kwargs)
 
1329
                        return func(*args)
 
1330
                    def set_property(interface, key, value,
 
1331
                                     dbus_interface=None):
 
1332
                        self.assertEqual(
 
1333
                            "org.freedesktop.DBus.Properties",
 
1334
                            dbus_interface)
 
1335
                        self.assertEqual("Secret", key)
 
1336
                        return func(interface, key, value,
 
1337
                                    dbus_interface=dbus_interface)
 
1338
                    return DBusObject(methodname=method,
 
1339
                                      Set=set_property)
 
1340
            class Boolean(object):
 
1341
                def __init__(self, value):
 
1342
                    self.value = bool(value)
 
1343
                def __bool__(self):
 
1344
                    return self.value
 
1345
                if sys.version_info.major == 2:
 
1346
                    __nonzero__ = __bool__
 
1347
            class ObjectPath(str):
 
1348
                pass
 
1349
            class Dictionary(dict):
 
1350
                pass
 
1351
            class ByteArray(bytes):
 
1352
                pass
 
1353
        return mock_dbus_python
 
1354
 
 
1355
    def call_method(self, bus, methodname, busname, objectpath,
 
1356
                    interface, *args):
 
1357
        with self.assertLogs(log, logging.DEBUG):
 
1358
            return bus.call_method(methodname, busname, objectpath,
 
1359
                                   interface, *args)
 
1360
 
 
1361
    def test_call_method_returns(self):
 
1362
        expected_method_return = Unique()
 
1363
        method_args = (Unique(), Unique())
 
1364
        def func(*args):
 
1365
            self.assertEqual(len(method_args), len(args))
 
1366
            for marg, arg in zip(method_args, args):
 
1367
                self.assertIs(marg, arg)
 
1368
            return expected_method_return
 
1369
        mock_dbus_python = self.MockDBusPython_func(func)
 
1370
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
 
1371
        ret = self.call_method(bus, "methodname", "busname",
 
1372
                               "objectpath", "interface",
 
1373
                               *method_args)
 
1374
        self.assertIs(ret, expected_method_return)
 
1375
 
 
1376
    def test_call_method_filters_bool_true(self):
 
1377
        def func():
 
1378
            return method_return
 
1379
        mock_dbus_python = self.MockDBusPython_func(func)
 
1380
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
 
1381
        method_return = mock_dbus_python.Boolean(True)
 
1382
        ret = self.call_method(bus, "methodname", "busname",
 
1383
                               "objectpath", "interface")
 
1384
        self.assertTrue(ret)
 
1385
        self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
 
1386
 
 
1387
    def test_call_method_filters_bool_false(self):
 
1388
        def func():
 
1389
            return method_return
 
1390
        mock_dbus_python = self.MockDBusPython_func(func)
 
1391
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
 
1392
        method_return = mock_dbus_python.Boolean(False)
 
1393
        ret = self.call_method(bus, "methodname", "busname",
 
1394
                               "objectpath", "interface")
 
1395
        self.assertFalse(ret)
 
1396
        self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
 
1397
 
 
1398
    def test_call_method_filters_objectpath(self):
 
1399
        def func():
 
1400
            return method_return
 
1401
        mock_dbus_python = self.MockDBusPython_func(func)
 
1402
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
 
1403
        method_return = mock_dbus_python.ObjectPath("objectpath")
 
1404
        ret = self.call_method(bus, "methodname", "busname",
 
1405
                               "objectpath", "interface")
 
1406
        self.assertEqual("objectpath", ret)
 
1407
        self.assertIsNot("objectpath", ret)
 
1408
        self.assertNotIsInstance(ret, mock_dbus_python.ObjectPath)
 
1409
 
 
1410
    def test_call_method_filters_booleans_in_dict(self):
 
1411
        def func():
 
1412
            return method_return
 
1413
        mock_dbus_python = self.MockDBusPython_func(func)
 
1414
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
 
1415
        method_return = mock_dbus_python.Dictionary(
 
1416
        {mock_dbus_python.Boolean(True):
 
1417
         mock_dbus_python.Boolean(False),
 
1418
         mock_dbus_python.Boolean(False):
 
1419
         mock_dbus_python.Boolean(True)})
 
1420
        ret = self.call_method(bus, "methodname", "busname",
 
1421
                               "objectpath", "interface")
 
1422
        expected_method_return = {True: False,
 
1423
                                  False: True}
 
1424
        self.assertEqual(expected_method_return, ret)
 
1425
        self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
 
1426
 
 
1427
    def test_call_method_filters_objectpaths_in_dict(self):
 
1428
        def func():
 
1429
            return method_return
 
1430
        mock_dbus_python = self.MockDBusPython_func(func)
 
1431
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
 
1432
        method_return = mock_dbus_python.Dictionary(
 
1433
        {mock_dbus_python.ObjectPath("objectpath_key_1"):
 
1434
         mock_dbus_python.ObjectPath("objectpath_value_1"),
 
1435
         mock_dbus_python.ObjectPath("objectpath_key_2"):
 
1436
         mock_dbus_python.ObjectPath("objectpath_value_2")})
 
1437
        ret = self.call_method(bus, "methodname", "busname",
 
1438
                               "objectpath", "interface")
 
1439
        expected_method_return = {str(key): str(value)
 
1440
                                  for key, value in
 
1441
                                  method_return.items()}
 
1442
        self.assertEqual(expected_method_return, ret)
 
1443
        self.assertIsInstance(ret, dict)
 
1444
        self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
 
1445
 
 
1446
    def test_call_method_filters_dict_in_dict(self):
 
1447
        def func():
 
1448
            return method_return
 
1449
        mock_dbus_python = self.MockDBusPython_func(func)
 
1450
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
 
1451
        method_return = mock_dbus_python.Dictionary(
 
1452
        {"key1": mock_dbus_python.Dictionary({"key11": "value11",
 
1453
                                              "key12": "value12"}),
 
1454
         "key2": mock_dbus_python.Dictionary({"key21": "value21",
 
1455
                                              "key22": "value22"})})
 
1456
        ret = self.call_method(bus, "methodname", "busname",
 
1457
                               "objectpath", "interface")
 
1458
        expected_method_return = {
 
1459
            "key1": {"key11": "value11",
 
1460
                     "key12": "value12"},
 
1461
            "key2": {"key21": "value21",
 
1462
                     "key22": "value22"},
 
1463
        }
 
1464
        self.assertEqual(expected_method_return, ret)
 
1465
        self.assertIsInstance(ret, dict)
 
1466
        self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
 
1467
        for key, value in ret.items():
 
1468
            self.assertIsInstance(value, dict)
 
1469
            self.assertEqual(expected_method_return[key], value)
 
1470
            self.assertNotIsInstance(value,
 
1471
                                     mock_dbus_python.Dictionary)
 
1472
 
 
1473
    def test_call_method_filters_dict_three_deep(self):
 
1474
        def func():
 
1475
            return method_return
 
1476
        mock_dbus_python = self.MockDBusPython_func(func)
 
1477
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
 
1478
        method_return = mock_dbus_python.Dictionary(
 
1479
            {"key1":
 
1480
             mock_dbus_python.Dictionary(
 
1481
                 {"key2":
 
1482
                  mock_dbus_python.Dictionary(
 
1483
                      {"key3":
 
1484
                       mock_dbus_python.Boolean(True),
 
1485
                       }),
 
1486
                  }),
 
1487
             })
 
1488
        ret = self.call_method(bus, "methodname", "busname",
 
1489
                               "objectpath", "interface")
 
1490
        expected_method_return = {"key1": {"key2": {"key3": True}}}
 
1491
        self.assertEqual(expected_method_return, ret)
 
1492
        self.assertIsInstance(ret, dict)
 
1493
        self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
 
1494
        self.assertIsInstance(ret["key1"], dict)
 
1495
        self.assertNotIsInstance(ret["key1"],
 
1496
                                 mock_dbus_python.Dictionary)
 
1497
        self.assertIsInstance(ret["key1"]["key2"], dict)
 
1498
        self.assertNotIsInstance(ret["key1"]["key2"],
 
1499
                                 mock_dbus_python.Dictionary)
 
1500
        self.assertTrue(ret["key1"]["key2"]["key3"])
 
1501
        self.assertNotIsInstance(ret["key1"]["key2"]["key3"],
 
1502
                                 mock_dbus_python.Boolean)
 
1503
 
 
1504
    def test_call_method_handles_exception(self):
1116
1505
        dbus_logger = logging.getLogger("dbus.proxies")
1117
1506
 
1118
 
        class ObjectManagerFailingStub(object):
1119
 
            def GetManagedObjects(self):
1120
 
                dbus_logger.error("Test")
1121
 
                raise dbus.exceptions.DBusException("Test")
 
1507
        def func():
 
1508
            dbus_logger.error("Test")
 
1509
            raise mock_dbus_python.exceptions.DBusException()
 
1510
 
 
1511
        mock_dbus_python = self.MockDBusPython_func(func)
 
1512
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1122
1513
 
1123
1514
        class CountingHandler(logging.Handler):
1124
1515
            count = 0
1130
1521
        dbus_logger.addHandler(counting_handler)
1131
1522
 
1132
1523
        try:
1133
 
            with self.assertLogs(log, logging.CRITICAL) as watcher:
1134
 
                with self.assertRaises(SystemExit) as e:
1135
 
                    get_managed_objects(ObjectManagerFailingStub())
 
1524
            with self.assertRaises(dbus.Error) as e:
 
1525
                self.call_method(bus, "methodname", "busname",
 
1526
                                 "objectpath", "interface")
1136
1527
        finally:
1137
1528
            dbus_logger.removeFilter(counting_handler)
1138
1529
 
 
1530
        self.assertNotIsInstance(e, dbus.ConnectFailed)
 
1531
 
1139
1532
        # Make sure the dbus logger was suppressed
1140
1533
        self.assertEqual(0, counting_handler.count)
1141
1534
 
1142
 
        # Test that the dbus_logger still works
1143
 
        with self.assertLogs(dbus_logger, logging.ERROR):
1144
 
            dbus_logger.error("Test")
1145
 
 
1146
 
        if isinstance(e.exception.code, int):
1147
 
            self.assertNotEqual(0, e.exception.code)
1148
 
        else:
1149
 
            self.assertIsNotNone(e.exception.code)
 
1535
    def test_Set_Secret_sends_bytearray(self):
 
1536
        ret = [None]
 
1537
        def func(*args, **kwargs):
 
1538
            ret[0] = (args, kwargs)
 
1539
        mock_dbus_python = self.MockDBusPython_func(func)
 
1540
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
 
1541
        bus.set_client_property("objectpath", "Secret", "value")
 
1542
        expected_call = (("se.recompile.Mandos.Client", "Secret",
 
1543
                          mock_dbus_python.ByteArray(b"value")),
 
1544
                         {"dbus_interface":
 
1545
                          "org.freedesktop.DBus.Properties"})
 
1546
        self.assertEqual(expected_call, ret[0])
 
1547
        if sys.version_info.major == 2:
 
1548
            self.assertIsInstance(ret[0][0][-1],
 
1549
                                  mock_dbus_python.ByteArray)
 
1550
 
 
1551
    def test_get_object_converts_to_correct_exception(self):
 
1552
        bus = dbus_python_adapter.SystemBus(
 
1553
            self.fake_dbus_python_raises_exception_on_connect)
 
1554
        with self.assertRaises(dbus.ConnectFailed):
 
1555
            self.call_method(bus, "methodname", "busname",
 
1556
                             "objectpath", "interface")
 
1557
 
 
1558
    class fake_dbus_python_raises_exception_on_connect(object):
 
1559
        """fake dbus-python module"""
 
1560
        class exceptions(object):
 
1561
            """Pseudo-namespace"""
 
1562
            class DBusException(Exception):
 
1563
                pass
 
1564
 
 
1565
        @classmethod
 
1566
        def SystemBus(cls):
 
1567
            def get_object(busname, objectpath):
 
1568
                raise cls.exceptions.DBusException()
 
1569
            Bus = collections.namedtuple("Bus", ["get_object"])
 
1570
            return Bus(get_object=get_object)
 
1571
 
 
1572
 
 
1573
class Test_dbus_python_adapter_CachingBus(unittest.TestCase):
 
1574
    class mock_dbus_python(object):
 
1575
        """mock dbus-python modules"""
 
1576
        class SystemBus(object):
 
1577
            @staticmethod
 
1578
            def get_object(busname, objectpath):
 
1579
                return Unique()
 
1580
 
 
1581
    def setUp(self):
 
1582
        self.bus = dbus_python_adapter.CachingBus(
 
1583
            self.mock_dbus_python)
 
1584
 
 
1585
    def test_returns_distinct_objectpaths(self):
 
1586
        obj1 = self.bus.get_object("busname", "objectpath1")
 
1587
        self.assertIsInstance(obj1, Unique)
 
1588
        obj2 = self.bus.get_object("busname", "objectpath2")
 
1589
        self.assertIsInstance(obj2, Unique)
 
1590
        self.assertIsNot(obj1, obj2)
 
1591
 
 
1592
    def test_returns_distinct_busnames(self):
 
1593
        obj1 = self.bus.get_object("busname1", "objectpath")
 
1594
        self.assertIsInstance(obj1, Unique)
 
1595
        obj2 = self.bus.get_object("busname2", "objectpath")
 
1596
        self.assertIsInstance(obj2, Unique)
 
1597
        self.assertIsNot(obj1, obj2)
 
1598
 
 
1599
    def test_returns_distinct_both(self):
 
1600
        obj1 = self.bus.get_object("busname1", "objectpath")
 
1601
        self.assertIsInstance(obj1, Unique)
 
1602
        obj2 = self.bus.get_object("busname2", "objectpath")
 
1603
        self.assertIsInstance(obj2, Unique)
 
1604
        self.assertIsNot(obj1, obj2)
 
1605
 
 
1606
    def test_returns_same(self):
 
1607
        obj1 = self.bus.get_object("busname", "objectpath")
 
1608
        self.assertIsInstance(obj1, Unique)
 
1609
        obj2 = self.bus.get_object("busname", "objectpath")
 
1610
        self.assertIsInstance(obj2, Unique)
 
1611
        self.assertIs(obj1, obj2)
 
1612
 
 
1613
    def test_returns_same_old(self):
 
1614
        obj1 = self.bus.get_object("busname1", "objectpath1")
 
1615
        self.assertIsInstance(obj1, Unique)
 
1616
        obj2 = self.bus.get_object("busname2", "objectpath2")
 
1617
        self.assertIsInstance(obj2, Unique)
 
1618
        obj1b = self.bus.get_object("busname1", "objectpath1")
 
1619
        self.assertIsInstance(obj1b, Unique)
 
1620
        self.assertIsNot(obj1, obj2)
 
1621
        self.assertIsNot(obj2, obj1b)
 
1622
        self.assertIs(obj1, obj1b)
 
1623
 
 
1624
 
 
1625
class Test_pydbus_adapter_SystemBus(TestCaseWithAssertLogs):
 
1626
 
 
1627
    def Stub_pydbus_func(self, func):
 
1628
        class stub_pydbus(object):
 
1629
            """stub pydbus module"""
 
1630
            class SystemBus(object):
 
1631
                @staticmethod
 
1632
                def get(busname, objectpath):
 
1633
                    DBusObject = collections.namedtuple(
 
1634
                        "DBusObject", ("methodname",))
 
1635
                    return {"interface":
 
1636
                            DBusObject(methodname=func)}
 
1637
        return stub_pydbus
 
1638
 
 
1639
    def call_method(self, bus, methodname, busname, objectpath,
 
1640
                    interface, *args):
 
1641
        with self.assertLogs(log, logging.DEBUG):
 
1642
            return bus.call_method(methodname, busname, objectpath,
 
1643
                                   interface, *args)
 
1644
 
 
1645
    def test_call_method_returns(self):
 
1646
        expected_method_return = Unique()
 
1647
        method_args = (Unique(), Unique())
 
1648
        def func(*args):
 
1649
            self.assertEqual(len(method_args), len(args))
 
1650
            for marg, arg in zip(method_args, args):
 
1651
                self.assertIs(marg, arg)
 
1652
            return expected_method_return
 
1653
        stub_pydbus = self.Stub_pydbus_func(func)
 
1654
        bus = pydbus_adapter.SystemBus(stub_pydbus)
 
1655
        ret = self.call_method(bus, "methodname", "busname",
 
1656
                               "objectpath", "interface",
 
1657
                               *method_args)
 
1658
        self.assertIs(ret, expected_method_return)
 
1659
 
 
1660
    def test_call_method_handles_exception(self):
 
1661
        dbus_logger = logging.getLogger("dbus.proxies")
 
1662
 
 
1663
        def func():
 
1664
            raise gi.repository.GLib.Error()
 
1665
 
 
1666
        stub_pydbus = self.Stub_pydbus_func(func)
 
1667
        bus = pydbus_adapter.SystemBus(stub_pydbus)
 
1668
 
 
1669
        with self.assertRaises(dbus.Error) as e:
 
1670
            self.call_method(bus, "methodname", "busname",
 
1671
                             "objectpath", "interface")
 
1672
 
 
1673
        self.assertNotIsInstance(e, dbus.ConnectFailed)
 
1674
 
 
1675
    def test_get_converts_to_correct_exception(self):
 
1676
        bus = pydbus_adapter.SystemBus(
 
1677
            self.fake_pydbus_raises_exception_on_connect)
 
1678
        with self.assertRaises(dbus.ConnectFailed):
 
1679
            self.call_method(bus, "methodname", "busname",
 
1680
                             "objectpath", "interface")
 
1681
 
 
1682
    class fake_pydbus_raises_exception_on_connect(object):
 
1683
        """fake dbus-python module"""
 
1684
        @classmethod
 
1685
        def SystemBus(cls):
 
1686
            def get(busname, objectpath):
 
1687
                raise gi.repository.GLib.Error()
 
1688
            Bus = collections.namedtuple("Bus", ["get"])
 
1689
            return Bus(get=get)
 
1690
 
 
1691
    def test_set_property_uses_setattr(self):
 
1692
        class Object(object):
 
1693
            pass
 
1694
        obj = Object()
 
1695
        class pydbus_spy(object):
 
1696
            class SystemBus(object):
 
1697
                @staticmethod
 
1698
                def get(busname, objectpath):
 
1699
                    return {"interface": obj}
 
1700
        bus = pydbus_adapter.SystemBus(pydbus_spy)
 
1701
        value = Unique()
 
1702
        bus.set_property("busname", "objectpath", "interface", "key",
 
1703
                         value)
 
1704
        self.assertIs(value, obj.key)
 
1705
 
 
1706
    def test_get_suppresses_xml_deprecation_warning(self):
 
1707
        if sys.version_info.major >= 3:
 
1708
            return
 
1709
        class stub_pydbus_get(object):
 
1710
            class SystemBus(object):
 
1711
                @staticmethod
 
1712
                def get(busname, objectpath):
 
1713
                    warnings.warn_explicit(
 
1714
                        "deprecated", DeprecationWarning,
 
1715
                        "xml.etree.ElementTree", 0)
 
1716
        bus = pydbus_adapter.SystemBus(stub_pydbus_get)
 
1717
        with warnings.catch_warnings(record=True) as w:
 
1718
            warnings.simplefilter("always")
 
1719
            bus.get("busname", "objectpath")
 
1720
            self.assertEqual(0, len(w))
 
1721
 
 
1722
 
 
1723
class Test_pydbus_adapter_CachingBus(unittest.TestCase):
 
1724
    class stub_pydbus(object):
 
1725
        """stub pydbus module"""
 
1726
        class SystemBus(object):
 
1727
            @staticmethod
 
1728
            def get(busname, objectpath):
 
1729
                return Unique()
 
1730
 
 
1731
    def setUp(self):
 
1732
        self.bus = pydbus_adapter.CachingBus(self.stub_pydbus)
 
1733
 
 
1734
    def test_returns_distinct_objectpaths(self):
 
1735
        obj1 = self.bus.get("busname", "objectpath1")
 
1736
        self.assertIsInstance(obj1, Unique)
 
1737
        obj2 = self.bus.get("busname", "objectpath2")
 
1738
        self.assertIsInstance(obj2, Unique)
 
1739
        self.assertIsNot(obj1, obj2)
 
1740
 
 
1741
    def test_returns_distinct_busnames(self):
 
1742
        obj1 = self.bus.get("busname1", "objectpath")
 
1743
        self.assertIsInstance(obj1, Unique)
 
1744
        obj2 = self.bus.get("busname2", "objectpath")
 
1745
        self.assertIsInstance(obj2, Unique)
 
1746
        self.assertIsNot(obj1, obj2)
 
1747
 
 
1748
    def test_returns_distinct_both(self):
 
1749
        obj1 = self.bus.get("busname1", "objectpath")
 
1750
        self.assertIsInstance(obj1, Unique)
 
1751
        obj2 = self.bus.get("busname2", "objectpath")
 
1752
        self.assertIsInstance(obj2, Unique)
 
1753
        self.assertIsNot(obj1, obj2)
 
1754
 
 
1755
    def test_returns_same(self):
 
1756
        obj1 = self.bus.get("busname", "objectpath")
 
1757
        self.assertIsInstance(obj1, Unique)
 
1758
        obj2 = self.bus.get("busname", "objectpath")
 
1759
        self.assertIsInstance(obj2, Unique)
 
1760
        self.assertIs(obj1, obj2)
 
1761
 
 
1762
    def test_returns_same_old(self):
 
1763
        obj1 = self.bus.get("busname1", "objectpath1")
 
1764
        self.assertIsInstance(obj1, Unique)
 
1765
        obj2 = self.bus.get("busname2", "objectpath2")
 
1766
        self.assertIsInstance(obj2, Unique)
 
1767
        obj1b = self.bus.get("busname1", "objectpath1")
 
1768
        self.assertIsInstance(obj1b, Unique)
 
1769
        self.assertIsNot(obj1, obj2)
 
1770
        self.assertIsNot(obj2, obj1b)
 
1771
        self.assertIs(obj1, obj1b)
1150
1772
 
1151
1773
 
1152
1774
class Test_commands_from_options(unittest.TestCase):
 
1775
 
1153
1776
    def setUp(self):
1154
1777
        self.parser = argparse.ArgumentParser()
1155
1778
        add_command_line_options(self.parser)
1158
1781
        self.assert_command_from_args(["--is-enabled", "client"],
1159
1782
                                      command.IsEnabled)
1160
1783
 
1161
 
    def assert_command_from_args(self, args, command_cls,
1162
 
                                 **cmd_attrs):
 
1784
    def assert_command_from_args(self, args, command_cls, length=1,
 
1785
                                 clients=None, **cmd_attrs):
1163
1786
        """Assert that parsing ARGS should result in an instance of
1164
1787
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
1165
1788
        options = self.parser.parse_args(args)
1166
1789
        check_option_syntax(self.parser, options)
1167
1790
        commands = commands_from_options(options)
1168
 
        self.assertEqual(1, len(commands))
1169
 
        command = commands[0]
1170
 
        self.assertIsInstance(command, command_cls)
 
1791
        self.assertEqual(length, len(commands))
 
1792
        for command in commands:
 
1793
            if isinstance(command, command_cls):
 
1794
                break
 
1795
        else:
 
1796
            self.assertIsInstance(command, command_cls)
 
1797
        if clients is not None:
 
1798
            self.assertEqual(clients, options.client)
1171
1799
        for key, value in cmd_attrs.items():
1172
1800
            self.assertEqual(value, getattr(command, key))
1173
1801
 
 
1802
    def assert_commands_from_args(self, args, commands, clients=None):
 
1803
        for cmd in commands:
 
1804
            self.assert_command_from_args(args, cmd,
 
1805
                                          length=len(commands),
 
1806
                                          clients=clients)
 
1807
 
1174
1808
    def test_is_enabled_short(self):
1175
1809
        self.assert_command_from_args(["-V", "client"],
1176
1810
                                      command.IsEnabled)
1367
2001
                                      verbose=True)
1368
2002
 
1369
2003
 
 
2004
    def test_manual_page_example_1(self):
 
2005
        self.assert_command_from_args("",
 
2006
                                      command.PrintTable,
 
2007
                                      clients=[],
 
2008
                                      verbose=False)
 
2009
 
 
2010
    def test_manual_page_example_2(self):
 
2011
        self.assert_command_from_args(
 
2012
            "--verbose foo1.example.org foo2.example.org".split(),
 
2013
            command.PrintTable, clients=["foo1.example.org",
 
2014
                                         "foo2.example.org"],
 
2015
            verbose=True)
 
2016
 
 
2017
    def test_manual_page_example_3(self):
 
2018
        self.assert_command_from_args("--enable --all".split(),
 
2019
                                      command.Enable,
 
2020
                                      clients=[])
 
2021
 
 
2022
    def test_manual_page_example_4(self):
 
2023
        self.assert_commands_from_args(
 
2024
            ("--timeout=PT5M --interval=PT1M foo1.example.org"
 
2025
             " foo2.example.org").split(),
 
2026
            [command.SetTimeout, command.SetInterval],
 
2027
            clients=["foo1.example.org", "foo2.example.org"])
 
2028
 
 
2029
    def test_manual_page_example_5(self):
 
2030
        self.assert_command_from_args("--approve --all".split(),
 
2031
                                      command.Approve,
 
2032
                                      clients=[])
 
2033
 
 
2034
 
1370
2035
class TestCommand(unittest.TestCase):
1371
2036
    """Abstract class for tests of command classes"""
1372
2037
 
 
2038
    class FakeMandosBus(dbus.MandosBus):
 
2039
        def __init__(self, testcase):
 
2040
            self.client_properties = {
 
2041
                "Name": "foo",
 
2042
                "KeyID": ("92ed150794387c03ce684574b1139a65"
 
2043
                          "94a34f895daaaf09fd8ea90a27cddb12"),
 
2044
                "Secret": b"secret",
 
2045
                "Host": "foo.example.org",
 
2046
                "Enabled": True,
 
2047
                "Timeout": 300000,
 
2048
                "LastCheckedOK": "2019-02-03T00:00:00",
 
2049
                "Created": "2019-01-02T00:00:00",
 
2050
                "Interval": 120000,
 
2051
                "Fingerprint": ("778827225BA7DE539C5A"
 
2052
                                "7CFA59CFF7CDBD9A5920"),
 
2053
                "CheckerRunning": False,
 
2054
                "LastEnabled": "2019-01-03T00:00:00",
 
2055
                "ApprovalPending": False,
 
2056
                "ApprovedByDefault": True,
 
2057
                "LastApprovalRequest": "",
 
2058
                "ApprovalDelay": 0,
 
2059
                "ApprovalDuration": 1000,
 
2060
                "Checker": "fping -q -- %(host)s",
 
2061
                "ExtendedTimeout": 900000,
 
2062
                "Expires": "2019-02-04T00:00:00",
 
2063
                "LastCheckerStatus": 0,
 
2064
            }
 
2065
            self.other_client_properties = {
 
2066
                "Name": "barbar",
 
2067
                "KeyID": ("0558568eedd67d622f5c83b35a115f79"
 
2068
                          "6ab612cff5ad227247e46c2b020f441c"),
 
2069
                "Secret": b"secretbar",
 
2070
                "Host": "192.0.2.3",
 
2071
                "Enabled": True,
 
2072
                "Timeout": 300000,
 
2073
                "LastCheckedOK": "2019-02-04T00:00:00",
 
2074
                "Created": "2019-01-03T00:00:00",
 
2075
                "Interval": 120000,
 
2076
                "Fingerprint": ("3E393AEAEFB84C7E89E2"
 
2077
                                "F547B3A107558FCA3A27"),
 
2078
                "CheckerRunning": True,
 
2079
                "LastEnabled": "2019-01-04T00:00:00",
 
2080
                "ApprovalPending": False,
 
2081
                "ApprovedByDefault": False,
 
2082
                "LastApprovalRequest": "2019-01-03T00:00:00",
 
2083
                "ApprovalDelay": 30000,
 
2084
                "ApprovalDuration": 93785000,
 
2085
                "Checker": ":",
 
2086
                "ExtendedTimeout": 900000,
 
2087
                "Expires": "2019-02-05T00:00:00",
 
2088
                "LastCheckerStatus": -2,
 
2089
            }
 
2090
            self.clients =  collections.OrderedDict(
 
2091
                [
 
2092
                    ("client_objectpath", self.client_properties),
 
2093
                    ("other_client_objectpath",
 
2094
                     self.other_client_properties),
 
2095
                ])
 
2096
            self.one_client = {"client_objectpath":
 
2097
                               self.client_properties}
 
2098
            self.testcase = testcase
 
2099
            self.calls = []
 
2100
 
 
2101
        def call_method(self, methodname, busname, objectpath,
 
2102
                        interface, *args):
 
2103
            self.testcase.assertEqual("se.recompile.Mandos", busname)
 
2104
            self.calls.append((methodname, busname, objectpath,
 
2105
                               interface, args))
 
2106
            if interface == "org.freedesktop.DBus.Properties":
 
2107
                if methodname == "Set":
 
2108
                    self.testcase.assertEqual(3, len(args))
 
2109
                    interface, key, value = args
 
2110
                    self.testcase.assertEqual(
 
2111
                        "se.recompile.Mandos.Client", interface)
 
2112
                    self.clients[objectpath][key] = value
 
2113
                    return
 
2114
            elif interface == "se.recompile.Mandos":
 
2115
                self.testcase.assertEqual("RemoveClient", methodname)
 
2116
                self.testcase.assertEqual(1, len(args))
 
2117
                clientpath = args[0]
 
2118
                del self.clients[clientpath]
 
2119
                return
 
2120
            elif interface == "se.recompile.Mandos.Client":
 
2121
                if methodname == "Approve":
 
2122
                    self.testcase.assertEqual(1, len(args))
 
2123
                    return
 
2124
            raise ValueError()
 
2125
 
1373
2126
    def setUp(self):
1374
 
        testcase = self
1375
 
        class MockClient(object):
1376
 
            def __init__(self, name, **attributes):
1377
 
                self.__dbus_object_path__ = "/clients/{}".format(name)
1378
 
                self.attributes = attributes
1379
 
                self.attributes["Name"] = name
1380
 
                self.calls = []
1381
 
            def Set(self, interface, propname, value, dbus_interface):
1382
 
                testcase.assertEqual(client_dbus_interface, interface)
1383
 
                testcase.assertEqual(dbus.PROPERTIES_IFACE,
1384
 
                                     dbus_interface)
1385
 
                self.attributes[propname] = value
1386
 
            def Approve(self, approve, dbus_interface):
1387
 
                testcase.assertEqual(client_dbus_interface,
1388
 
                                     dbus_interface)
1389
 
                self.calls.append(("Approve", (approve,
1390
 
                                               dbus_interface)))
1391
 
        self.client = MockClient(
1392
 
            "foo",
1393
 
            KeyID=("92ed150794387c03ce684574b1139a65"
1394
 
                   "94a34f895daaaf09fd8ea90a27cddb12"),
1395
 
            Secret=b"secret",
1396
 
            Host="foo.example.org",
1397
 
            Enabled=dbus.Boolean(True),
1398
 
            Timeout=300000,
1399
 
            LastCheckedOK="2019-02-03T00:00:00",
1400
 
            Created="2019-01-02T00:00:00",
1401
 
            Interval=120000,
1402
 
            Fingerprint=("778827225BA7DE539C5A"
1403
 
                         "7CFA59CFF7CDBD9A5920"),
1404
 
            CheckerRunning=dbus.Boolean(False),
1405
 
            LastEnabled="2019-01-03T00:00:00",
1406
 
            ApprovalPending=dbus.Boolean(False),
1407
 
            ApprovedByDefault=dbus.Boolean(True),
1408
 
            LastApprovalRequest="",
1409
 
            ApprovalDelay=0,
1410
 
            ApprovalDuration=1000,
1411
 
            Checker="fping -q -- %(host)s",
1412
 
            ExtendedTimeout=900000,
1413
 
            Expires="2019-02-04T00:00:00",
1414
 
            LastCheckerStatus=0)
1415
 
        self.other_client = MockClient(
1416
 
            "barbar",
1417
 
            KeyID=("0558568eedd67d622f5c83b35a115f79"
1418
 
                   "6ab612cff5ad227247e46c2b020f441c"),
1419
 
            Secret=b"secretbar",
1420
 
            Host="192.0.2.3",
1421
 
            Enabled=dbus.Boolean(True),
1422
 
            Timeout=300000,
1423
 
            LastCheckedOK="2019-02-04T00:00:00",
1424
 
            Created="2019-01-03T00:00:00",
1425
 
            Interval=120000,
1426
 
            Fingerprint=("3E393AEAEFB84C7E89E2"
1427
 
                         "F547B3A107558FCA3A27"),
1428
 
            CheckerRunning=dbus.Boolean(True),
1429
 
            LastEnabled="2019-01-04T00:00:00",
1430
 
            ApprovalPending=dbus.Boolean(False),
1431
 
            ApprovedByDefault=dbus.Boolean(False),
1432
 
            LastApprovalRequest="2019-01-03T00:00:00",
1433
 
            ApprovalDelay=30000,
1434
 
            ApprovalDuration=93785000,
1435
 
            Checker=":",
1436
 
            ExtendedTimeout=900000,
1437
 
            Expires="2019-02-05T00:00:00",
1438
 
            LastCheckerStatus=-2)
1439
 
        self.clients =  collections.OrderedDict(
1440
 
            [
1441
 
                (self.client.__dbus_object_path__,
1442
 
                 self.client.attributes),
1443
 
                (self.other_client.__dbus_object_path__,
1444
 
                 self.other_client.attributes),
1445
 
            ])
1446
 
        self.one_client = {self.client.__dbus_object_path__:
1447
 
                           self.client.attributes}
1448
 
 
1449
 
    @property
1450
 
    def bus(self):
1451
 
        class MockBus(object):
1452
 
            @staticmethod
1453
 
            def get_object(client_bus_name, path):
1454
 
                self.assertEqual(dbus_busname, client_bus_name)
1455
 
                # Note: "self" here is the TestCmd instance, not the
1456
 
                # MockBus instance, since this is a static method!
1457
 
                if path == self.client.__dbus_object_path__:
1458
 
                    return self.client
1459
 
                elif path == self.other_client.__dbus_object_path__:
1460
 
                    return self.other_client
1461
 
        return MockBus()
 
2127
        self.bus = self.FakeMandosBus(self)
1462
2128
 
1463
2129
 
1464
2130
class TestBaseCommands(TestCommand):
1465
2131
 
1466
2132
    def test_IsEnabled_exits_successfully(self):
1467
2133
        with self.assertRaises(SystemExit) as e:
1468
 
            command.IsEnabled().run(self.one_client)
 
2134
            command.IsEnabled().run(self.bus.one_client)
1469
2135
        if e.exception.code is not None:
1470
2136
            self.assertEqual(0, e.exception.code)
1471
2137
        else:
1472
2138
            self.assertIsNone(e.exception.code)
1473
2139
 
1474
2140
    def test_IsEnabled_exits_with_failure(self):
1475
 
        self.client.attributes["Enabled"] = dbus.Boolean(False)
 
2141
        self.bus.client_properties["Enabled"] = False
1476
2142
        with self.assertRaises(SystemExit) as e:
1477
 
            command.IsEnabled().run(self.one_client)
 
2143
            command.IsEnabled().run(self.bus.one_client)
1478
2144
        if isinstance(e.exception.code, int):
1479
2145
            self.assertNotEqual(0, e.exception.code)
1480
2146
        else:
1481
2147
            self.assertIsNotNone(e.exception.code)
1482
2148
 
1483
2149
    def test_Approve(self):
1484
 
        command.Approve().run(self.clients, self.bus)
1485
 
        for clientpath in self.clients:
1486
 
            client = self.bus.get_object(dbus_busname, clientpath)
1487
 
            self.assertIn(("Approve", (True, client_dbus_interface)),
1488
 
                          client.calls)
 
2150
        busname = "se.recompile.Mandos"
 
2151
        client_interface = "se.recompile.Mandos.Client"
 
2152
        command.Approve().run(self.bus.clients, self.bus)
 
2153
        for clientpath in self.bus.clients:
 
2154
            self.assertIn(("Approve", busname, clientpath,
 
2155
                           client_interface, (True,)), self.bus.calls)
1489
2156
 
1490
2157
    def test_Deny(self):
1491
 
        command.Deny().run(self.clients, self.bus)
1492
 
        for clientpath in self.clients:
1493
 
            client = self.bus.get_object(dbus_busname, clientpath)
1494
 
            self.assertIn(("Approve", (False, client_dbus_interface)),
1495
 
                          client.calls)
 
2158
        busname = "se.recompile.Mandos"
 
2159
        client_interface = "se.recompile.Mandos.Client"
 
2160
        command.Deny().run(self.bus.clients, self.bus)
 
2161
        for clientpath in self.bus.clients:
 
2162
            self.assertIn(("Approve", busname, clientpath,
 
2163
                           client_interface, (False,)),
 
2164
                          self.bus.calls)
1496
2165
 
1497
2166
    def test_Remove(self):
1498
 
        class MandosSpy(object):
1499
 
            def __init__(self):
1500
 
                self.calls = []
1501
 
            def RemoveClient(self, dbus_path):
1502
 
                self.calls.append(("RemoveClient", (dbus_path,)))
1503
 
        mandos = MandosSpy()
1504
 
        command.Remove().run(self.clients, self.bus, mandos)
1505
 
        for clientpath in self.clients:
1506
 
            self.assertIn(("RemoveClient", (clientpath,)),
1507
 
                          mandos.calls)
 
2167
        command.Remove().run(self.bus.clients, self.bus)
 
2168
        for clientpath in self.bus.clients:
 
2169
            self.assertIn(("RemoveClient", dbus_busname,
 
2170
                           dbus_server_path, dbus_server_interface,
 
2171
                           (clientpath,)), self.bus.calls)
1508
2172
 
1509
2173
    expected_json = {
1510
2174
        "foo": {
1559
2223
 
1560
2224
    def test_DumpJSON_normal(self):
1561
2225
        with self.capture_stdout_to_buffer() as buffer:
1562
 
            command.DumpJSON().run(self.clients)
 
2226
            command.DumpJSON().run(self.bus.clients)
1563
2227
        json_data = json.loads(buffer.getvalue())
1564
2228
        self.assertDictEqual(self.expected_json, json_data)
1565
2229
 
1576
2240
 
1577
2241
    def test_DumpJSON_one_client(self):
1578
2242
        with self.capture_stdout_to_buffer() as buffer:
1579
 
            command.DumpJSON().run(self.one_client)
 
2243
            command.DumpJSON().run(self.bus.one_client)
1580
2244
        json_data = json.loads(buffer.getvalue())
1581
2245
        expected_json = {"foo": self.expected_json["foo"]}
1582
2246
        self.assertDictEqual(expected_json, json_data)
1583
2247
 
1584
2248
    def test_PrintTable_normal(self):
1585
2249
        with self.capture_stdout_to_buffer() as buffer:
1586
 
            command.PrintTable().run(self.clients)
 
2250
            command.PrintTable().run(self.bus.clients)
1587
2251
        expected_output = "\n".join((
1588
2252
            "Name   Enabled Timeout  Last Successful Check",
1589
2253
            "foo    Yes     00:05:00 2019-02-03T00:00:00  ",
1593
2257
 
1594
2258
    def test_PrintTable_verbose(self):
1595
2259
        with self.capture_stdout_to_buffer() as buffer:
1596
 
            command.PrintTable(verbose=True).run(self.clients)
 
2260
            command.PrintTable(verbose=True).run(self.bus.clients)
1597
2261
        columns = (
1598
2262
            (
1599
2263
                "Name   ",
1689
2353
 
1690
2354
    def test_PrintTable_one_client(self):
1691
2355
        with self.capture_stdout_to_buffer() as buffer:
1692
 
            command.PrintTable().run(self.one_client)
 
2356
            command.PrintTable().run(self.bus.one_client)
1693
2357
        expected_output = "\n".join((
1694
2358
            "Name Enabled Timeout  Last Successful Check",
1695
2359
            "foo  Yes     00:05:00 2019-02-03T00:00:00  ",
1699
2363
 
1700
2364
class TestPropertySetterCmd(TestCommand):
1701
2365
    """Abstract class for tests of command.PropertySetter classes"""
 
2366
 
1702
2367
    def runTest(self):
1703
2368
        if not hasattr(self, "command"):
1704
 
            return
1705
 
        values_to_get = getattr(self, "values_to_get",
1706
 
                                self.values_to_set)
1707
 
        for value_to_set, value_to_get in zip(self.values_to_set,
1708
 
                                              values_to_get):
1709
 
            for clientpath in self.clients:
1710
 
                client = self.bus.get_object(dbus_busname, clientpath)
1711
 
                old_value = client.attributes[self.propname]
1712
 
                client.attributes[self.propname] = self.Unique()
1713
 
            self.run_command(value_to_set, self.clients)
1714
 
            for clientpath in self.clients:
1715
 
                client = self.bus.get_object(dbus_busname, clientpath)
1716
 
                value = client.attributes[self.propname]
1717
 
                self.assertNotIsInstance(value, self.Unique)
 
2369
            return              # Abstract TestCase class
 
2370
 
 
2371
        if hasattr(self, "values_to_set"):
 
2372
            cmd_args = [(value,) for value in self.values_to_set]
 
2373
            values_to_get = getattr(self, "values_to_get",
 
2374
                                    self.values_to_set)
 
2375
        else:
 
2376
            cmd_args = [() for x in range(len(self.values_to_get))]
 
2377
            values_to_get = self.values_to_get
 
2378
        for value_to_get, cmd_arg in zip(values_to_get, cmd_args):
 
2379
            for clientpath in self.bus.clients:
 
2380
                self.bus.clients[clientpath][self.propname] = (
 
2381
                    Unique())
 
2382
            self.command(*cmd_arg).run(self.bus.clients, self.bus)
 
2383
            for clientpath in self.bus.clients:
 
2384
                value = (self.bus.clients[clientpath]
 
2385
                         [self.propname])
 
2386
                self.assertNotIsInstance(value, Unique)
1718
2387
                self.assertEqual(value_to_get, value)
1719
2388
 
1720
 
    class Unique(object):
1721
 
        """Class for objects which exist only to be unique objects,
1722
 
since unittest.mock.sentinel only exists in Python 3.3"""
1723
 
 
1724
 
    def run_command(self, value, clients):
1725
 
        self.command().run(clients, self.bus)
1726
 
 
1727
2389
 
1728
2390
class TestEnableCmd(TestPropertySetterCmd):
1729
2391
    command = command.Enable
1730
2392
    propname = "Enabled"
1731
 
    values_to_set = [dbus.Boolean(True)]
 
2393
    values_to_get = [True]
1732
2394
 
1733
2395
 
1734
2396
class TestDisableCmd(TestPropertySetterCmd):
1735
2397
    command = command.Disable
1736
2398
    propname = "Enabled"
1737
 
    values_to_set = [dbus.Boolean(False)]
 
2399
    values_to_get = [False]
1738
2400
 
1739
2401
 
1740
2402
class TestBumpTimeoutCmd(TestPropertySetterCmd):
1741
2403
    command = command.BumpTimeout
1742
2404
    propname = "LastCheckedOK"
1743
 
    values_to_set = [""]
 
2405
    values_to_get = [""]
1744
2406
 
1745
2407
 
1746
2408
class TestStartCheckerCmd(TestPropertySetterCmd):
1747
2409
    command = command.StartChecker
1748
2410
    propname = "CheckerRunning"
1749
 
    values_to_set = [dbus.Boolean(True)]
 
2411
    values_to_get = [True]
1750
2412
 
1751
2413
 
1752
2414
class TestStopCheckerCmd(TestPropertySetterCmd):
1753
2415
    command = command.StopChecker
1754
2416
    propname = "CheckerRunning"
1755
 
    values_to_set = [dbus.Boolean(False)]
 
2417
    values_to_get = [False]
1756
2418
 
1757
2419
 
1758
2420
class TestApproveByDefaultCmd(TestPropertySetterCmd):
1759
2421
    command = command.ApproveByDefault
1760
2422
    propname = "ApprovedByDefault"
1761
 
    values_to_set = [dbus.Boolean(True)]
 
2423
    values_to_get = [True]
1762
2424
 
1763
2425
 
1764
2426
class TestDenyByDefaultCmd(TestPropertySetterCmd):
1765
2427
    command = command.DenyByDefault
1766
2428
    propname = "ApprovedByDefault"
1767
 
    values_to_set = [dbus.Boolean(False)]
1768
 
 
1769
 
 
1770
 
class TestPropertySetterValueCmd(TestPropertySetterCmd):
1771
 
    """Abstract class for tests of PropertySetterValueCmd classes"""
1772
 
 
1773
 
    def runTest(self):
1774
 
        if type(self) is TestPropertySetterValueCmd:
1775
 
            return
1776
 
        return super(TestPropertySetterValueCmd, self).runTest()
1777
 
 
1778
 
    def run_command(self, value, clients):
1779
 
        self.command(value).run(clients, self.bus)
1780
 
 
1781
 
 
1782
 
class TestSetCheckerCmd(TestPropertySetterValueCmd):
 
2429
    values_to_get = [False]
 
2430
 
 
2431
 
 
2432
class TestSetCheckerCmd(TestPropertySetterCmd):
1783
2433
    command = command.SetChecker
1784
2434
    propname = "Checker"
1785
2435
    values_to_set = ["", ":", "fping -q -- %s"]
1786
2436
 
1787
2437
 
1788
 
class TestSetHostCmd(TestPropertySetterValueCmd):
 
2438
class TestSetHostCmd(TestPropertySetterCmd):
1789
2439
    command = command.SetHost
1790
2440
    propname = "Host"
1791
2441
    values_to_set = ["192.0.2.3", "client.example.org"]
1792
2442
 
1793
2443
 
1794
 
class TestSetSecretCmd(TestPropertySetterValueCmd):
 
2444
class TestSetSecretCmd(TestPropertySetterCmd):
1795
2445
    command = command.SetSecret
1796
2446
    propname = "Secret"
1797
2447
    values_to_set = [io.BytesIO(b""),
1799
2449
    values_to_get = [f.getvalue() for f in values_to_set]
1800
2450
 
1801
2451
 
1802
 
class TestSetTimeoutCmd(TestPropertySetterValueCmd):
 
2452
class TestSetTimeoutCmd(TestPropertySetterCmd):
1803
2453
    command = command.SetTimeout
1804
2454
    propname = "Timeout"
1805
2455
    values_to_set = [datetime.timedelta(),
1810
2460
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1811
2461
 
1812
2462
 
1813
 
class TestSetExtendedTimeoutCmd(TestPropertySetterValueCmd):
 
2463
class TestSetExtendedTimeoutCmd(TestPropertySetterCmd):
1814
2464
    command = command.SetExtendedTimeout
1815
2465
    propname = "ExtendedTimeout"
1816
2466
    values_to_set = [datetime.timedelta(),
1821
2471
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1822
2472
 
1823
2473
 
1824
 
class TestSetIntervalCmd(TestPropertySetterValueCmd):
 
2474
class TestSetIntervalCmd(TestPropertySetterCmd):
1825
2475
    command = command.SetInterval
1826
2476
    propname = "Interval"
1827
2477
    values_to_set = [datetime.timedelta(),
1832
2482
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1833
2483
 
1834
2484
 
1835
 
class TestSetApprovalDelayCmd(TestPropertySetterValueCmd):
 
2485
class TestSetApprovalDelayCmd(TestPropertySetterCmd):
1836
2486
    command = command.SetApprovalDelay
1837
2487
    propname = "ApprovalDelay"
1838
2488
    values_to_set = [datetime.timedelta(),
1843
2493
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1844
2494
 
1845
2495
 
1846
 
class TestSetApprovalDurationCmd(TestPropertySetterValueCmd):
 
2496
class TestSetApprovalDurationCmd(TestPropertySetterCmd):
1847
2497
    command = command.SetApprovalDuration
1848
2498
    propname = "ApprovalDuration"
1849
2499
    values_to_set = [datetime.timedelta(),