/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos-ctl

  • Committer: Teddy Hogeborn
  • Date: 2019-03-16 04:51:11 UTC
  • Revision ID: teddy@recompile.se-20190316045111-63jv8d18i2tcakuw
mandos-ctl: Add comment

* mandos-ctl
  (Test_get_managed_objects.test_logs_and_exits_on_dbus_error): Add a
  comment.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#!/usr/bin/python3 -bbI
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 -*-
 
1
#!/usr/bin/python
 
2
# -*- mode: python; coding: utf-8; after-save-hook: (lambda () (let ((command (if (and (boundp 'tramp-file-name-structure) (string-match (car tramp-file-name-structure) (buffer-file-name))) (tramp-file-name-localname (tramp-dissect-file-name (buffer-file-name))) (buffer-file-name)))) (if (= (shell-command (format "%s --check" (shell-quote-argument command)) "*Test*") 0) (let ((w (get-buffer-window "*Test*"))) (if w (delete-window w)) (kill-buffer "*Test*")) (display-buffer "*Test*")))); -*-
3
3
#
4
4
# Mandos Monitor - Control and monitor the Mandos server
5
5
#
46
46
import tempfile
47
47
import contextlib
48
48
 
49
 
if sys.version_info.major == 2:
50
 
    __metaclass__ = type
51
 
    str = unicode
52
 
 
53
 
class gi:
54
 
    """Dummy gi module, for the tests"""
55
 
    class repository:
56
 
        class GLib:
57
 
            class Error(Exception):
58
 
                pass
59
 
dbussy = None
60
 
ravel = None
61
 
dbus_python = None
62
 
pydbus = None
63
 
 
64
 
try:
65
 
    import dbussy
66
 
    import ravel
67
 
except ImportError:
68
 
    try:
69
 
        import pydbus
70
 
        import gi
71
 
    except ImportError:
72
 
        import dbus as dbus_python
73
 
 
 
49
import dbus
74
50
 
75
51
# Show warnings by default
76
52
if not sys.warnoptions:
84
60
logging.captureWarnings(True)   # Show warnings via the logging system
85
61
 
86
62
if sys.version_info.major == 2:
87
 
    import StringIO
88
 
    io.StringIO = StringIO.StringIO
 
63
    str = unicode
89
64
 
90
65
locale.setlocale(locale.LC_ALL, "")
91
66
 
92
 
version = "1.8.9"
 
67
dbus_busname_domain = "se.recompile"
 
68
dbus_busname = dbus_busname_domain + ".Mandos"
 
69
server_dbus_path = "/"
 
70
server_dbus_interface = dbus_busname_domain + ".Mandos"
 
71
client_dbus_interface = dbus_busname_domain + ".Mandos.Client"
 
72
del dbus_busname_domain
 
73
version = "1.8.3"
 
74
 
 
75
 
 
76
try:
 
77
    dbus.OBJECT_MANAGER_IFACE
 
78
except AttributeError:
 
79
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
93
80
 
94
81
 
95
82
def main():
96
83
    parser = argparse.ArgumentParser()
 
84
 
97
85
    add_command_line_options(parser)
98
86
 
99
87
    options = parser.parse_args()
 
88
 
100
89
    check_option_syntax(parser, options)
101
90
 
102
91
    clientnames = options.client
104
93
    if options.debug:
105
94
        log.setLevel(logging.DEBUG)
106
95
 
107
 
    if dbussy is not None and ravel is not None:
108
 
        bus = dbussy_adapter.CachingBus(dbussy, ravel)
109
 
    elif pydbus is not None:
110
 
        bus = pydbus_adapter.CachingBus(pydbus)
111
 
    else:
112
 
        bus = dbus_python_adapter.CachingBus(dbus_python)
113
 
 
114
 
    try:
115
 
        all_clients = bus.get_clients_and_properties()
116
 
    except dbus.ConnectFailed as e:
117
 
        log.critical("Could not connect to Mandos server: %s", e)
118
 
        sys.exit(1)
119
 
    except dbus.Error as e:
120
 
        log.critical(
121
 
            "Failed to access Mandos server through D-Bus:\n%s", e)
122
 
        sys.exit(1)
 
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
123
113
 
124
114
    # Compile dict of (clientpath: properties) to process
125
115
    if not clientnames:
135
125
                log.critical("Client not found on server: %r", name)
136
126
                sys.exit(1)
137
127
 
 
128
    # Run all commands on clients
138
129
    commands = commands_from_options(options)
139
 
 
140
130
    for command in commands:
141
 
        command.run(clients, bus)
 
131
        command.run(clients, bus, mandos_serv)
142
132
 
143
133
 
144
134
def add_command_line_options(parser):
149
139
                        help="Select all clients")
150
140
    parser.add_argument("-v", "--verbose", action="store_true",
151
141
                        help="Print all fields")
152
 
    parser.add_argument("-j", "--dump-json", dest="commands",
153
 
                        action="append_const", default=[],
154
 
                        const=command.DumpJSON(),
 
142
    parser.add_argument("-j", "--dump-json", action="store_true",
155
143
                        help="Dump client data in JSON format")
156
144
    enable_disable = parser.add_mutually_exclusive_group()
157
 
    enable_disable.add_argument("-e", "--enable", dest="commands",
158
 
                                action="append_const", default=[],
159
 
                                const=command.Enable(),
 
145
    enable_disable.add_argument("-e", "--enable", action="store_true",
160
146
                                help="Enable client")
161
 
    enable_disable.add_argument("-d", "--disable", dest="commands",
162
 
                                action="append_const", default=[],
163
 
                                const=command.Disable(),
 
147
    enable_disable.add_argument("-d", "--disable",
 
148
                                action="store_true",
164
149
                                help="disable client")
165
 
    parser.add_argument("-b", "--bump-timeout", dest="commands",
166
 
                        action="append_const", default=[],
167
 
                        const=command.BumpTimeout(),
 
150
    parser.add_argument("-b", "--bump-timeout", action="store_true",
168
151
                        help="Bump timeout for client")
169
152
    start_stop_checker = parser.add_mutually_exclusive_group()
170
153
    start_stop_checker.add_argument("--start-checker",
171
 
                                    dest="commands",
172
 
                                    action="append_const", default=[],
173
 
                                    const=command.StartChecker(),
 
154
                                    action="store_true",
174
155
                                    help="Start checker for client")
175
 
    start_stop_checker.add_argument("--stop-checker", dest="commands",
176
 
                                    action="append_const", default=[],
177
 
                                    const=command.StopChecker(),
 
156
    start_stop_checker.add_argument("--stop-checker",
 
157
                                    action="store_true",
178
158
                                    help="Stop checker for client")
179
 
    parser.add_argument("-V", "--is-enabled", dest="commands",
180
 
                        action="append_const", default=[],
181
 
                        const=command.IsEnabled(),
 
159
    parser.add_argument("-V", "--is-enabled", action="store_true",
182
160
                        help="Check if client is enabled")
183
 
    parser.add_argument("-r", "--remove", dest="commands",
184
 
                        action="append_const", default=[],
185
 
                        const=command.Remove(),
 
161
    parser.add_argument("-r", "--remove", action="store_true",
186
162
                        help="Remove client")
187
 
    parser.add_argument("-c", "--checker", dest="commands",
188
 
                        action="append", default=[],
189
 
                        metavar="COMMAND", type=command.SetChecker,
 
163
    parser.add_argument("-c", "--checker",
190
164
                        help="Set checker command for client")
191
 
    parser.add_argument(
192
 
        "-t", "--timeout", dest="commands", action="append",
193
 
        default=[], metavar="TIME",
194
 
        type=command.SetTimeout.argparse(string_to_delta),
195
 
        help="Set timeout for client")
196
 
    parser.add_argument(
197
 
        "--extended-timeout", dest="commands", action="append",
198
 
        default=[], metavar="TIME",
199
 
        type=command.SetExtendedTimeout.argparse(string_to_delta),
200
 
        help="Set extended timeout for client")
201
 
    parser.add_argument(
202
 
        "-i", "--interval", dest="commands", action="append",
203
 
        default=[], metavar="TIME",
204
 
        type=command.SetInterval.argparse(string_to_delta),
205
 
        help="Set checker interval for client")
 
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")
206
171
    approve_deny_default = parser.add_mutually_exclusive_group()
207
172
    approve_deny_default.add_argument(
208
 
        "--approve-by-default", dest="commands",
209
 
        action="append_const", default=[],
210
 
        const=command.ApproveByDefault(),
 
173
        "--approve-by-default", action="store_true",
 
174
        default=None, dest="approved_by_default",
211
175
        help="Set client to be approved by default")
212
176
    approve_deny_default.add_argument(
213
 
        "--deny-by-default", dest="commands",
214
 
        action="append_const", default=[],
215
 
        const=command.DenyByDefault(),
 
177
        "--deny-by-default", action="store_false",
 
178
        dest="approved_by_default",
216
179
        help="Set client to be denied by default")
217
 
    parser.add_argument(
218
 
        "--approval-delay", dest="commands", action="append",
219
 
        default=[], metavar="TIME",
220
 
        type=command.SetApprovalDelay.argparse(string_to_delta),
221
 
        help="Set delay before client approve/deny")
222
 
    parser.add_argument(
223
 
        "--approval-duration", dest="commands", action="append",
224
 
        default=[], metavar="TIME",
225
 
        type=command.SetApprovalDuration.argparse(string_to_delta),
226
 
        help="Set duration of one client approval")
227
 
    parser.add_argument("-H", "--host", dest="commands",
228
 
                        action="append", default=[], metavar="STRING",
229
 
                        type=command.SetHost,
230
 
                        help="Set host for client")
231
 
    parser.add_argument(
232
 
        "-s", "--secret", dest="commands", action="append",
233
 
        default=[], metavar="FILENAME",
234
 
        type=command.SetSecret.argparse(argparse.FileType(mode="rb")),
235
 
        help="Set password blob (file) for client")
 
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")
236
188
    approve_deny = parser.add_mutually_exclusive_group()
237
189
    approve_deny.add_argument(
238
 
        "-A", "--approve", dest="commands", action="append_const",
239
 
        default=[], const=command.Approve(),
 
190
        "-A", "--approve", action="store_true",
240
191
        help="Approve any current client request")
241
 
    approve_deny.add_argument("-D", "--deny", dest="commands",
242
 
                              action="append_const", default=[],
243
 
                              const=command.Deny(),
 
192
    approve_deny.add_argument("-D", "--deny", action="store_true",
244
193
                              help="Deny any current client request")
245
194
    parser.add_argument("--debug", action="store_true",
246
195
                        help="Debug mode (show D-Bus commands)")
263
212
def rfc3339_duration_to_delta(duration):
264
213
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
265
214
 
266
 
    >>> rfc3339_duration_to_delta("P7D") == datetime.timedelta(7)
267
 
    True
268
 
    >>> rfc3339_duration_to_delta("PT60S") == datetime.timedelta(0, 60)
269
 
    True
270
 
    >>> rfc3339_duration_to_delta("PT60M") == datetime.timedelta(hours=1)
271
 
    True
272
 
    >>> # 60 months
273
 
    >>> rfc3339_duration_to_delta("P60M") == datetime.timedelta(1680)
274
 
    True
275
 
    >>> rfc3339_duration_to_delta("PT24H") == datetime.timedelta(1)
276
 
    True
277
 
    >>> rfc3339_duration_to_delta("P1W") == datetime.timedelta(7)
278
 
    True
279
 
    >>> rfc3339_duration_to_delta("PT5M30S") == datetime.timedelta(0, 330)
280
 
    True
281
 
    >>> rfc3339_duration_to_delta("P1DT3M20S") == datetime.timedelta(1, 200)
282
 
    True
 
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)
283
231
    >>> # Can not be empty:
284
232
    >>> rfc3339_duration_to_delta("")
285
233
    Traceback (most recent call last):
286
234
    ...
287
 
    ValueError: Invalid RFC 3339 duration: ""
 
235
    ValueError: Invalid RFC 3339 duration: u''
288
236
    >>> # Must start with "P":
289
237
    >>> rfc3339_duration_to_delta("1D")
290
238
    Traceback (most recent call last):
291
239
    ...
292
 
    ValueError: Invalid RFC 3339 duration: "1D"
 
240
    ValueError: Invalid RFC 3339 duration: u'1D'
293
241
    >>> # Must use correct order
294
242
    >>> rfc3339_duration_to_delta("PT1S2M")
295
243
    Traceback (most recent call last):
296
244
    ...
297
 
    ValueError: Invalid RFC 3339 duration: "PT1S2M"
 
245
    ValueError: Invalid RFC 3339 duration: u'PT1S2M'
298
246
    >>> # Time needs time marker
299
247
    >>> rfc3339_duration_to_delta("P1H2S")
300
248
    Traceback (most recent call last):
301
249
    ...
302
 
    ValueError: Invalid RFC 3339 duration: "P1H2S"
 
250
    ValueError: Invalid RFC 3339 duration: u'P1H2S'
303
251
    >>> # Weeks can not be combined with anything else
304
252
    >>> rfc3339_duration_to_delta("P1D2W")
305
253
    Traceback (most recent call last):
306
254
    ...
307
 
    ValueError: Invalid RFC 3339 duration: "P1D2W"
 
255
    ValueError: Invalid RFC 3339 duration: u'P1D2W'
308
256
    >>> rfc3339_duration_to_delta("P2W2H")
309
257
    Traceback (most recent call last):
310
258
    ...
311
 
    ValueError: Invalid RFC 3339 duration: "P2W2H"
 
259
    ValueError: Invalid RFC 3339 duration: u'P2W2H'
312
260
    """
313
261
 
314
262
    # Parsing an RFC 3339 duration with regular expressions is not
385
333
                break
386
334
        else:
387
335
            # No currently valid tokens were found
388
 
            raise ValueError("Invalid RFC 3339 duration: \"{}\""
 
336
            raise ValueError("Invalid RFC 3339 duration: {!r}"
389
337
                             .format(duration))
390
338
    # End token found
391
339
    return value
395
343
    """Parse an interval string as documented by Mandos before 1.6.1,
396
344
    and return a datetime.timedelta
397
345
 
398
 
    >>> parse_pre_1_6_1_interval('7d') == datetime.timedelta(days=7)
399
 
    True
400
 
    >>> parse_pre_1_6_1_interval('60s') == datetime.timedelta(0, 60)
401
 
    True
402
 
    >>> parse_pre_1_6_1_interval('60m') == datetime.timedelta(hours=1)
403
 
    True
404
 
    >>> parse_pre_1_6_1_interval('24h') == datetime.timedelta(days=1)
405
 
    True
406
 
    >>> parse_pre_1_6_1_interval('1w') == datetime.timedelta(days=7)
407
 
    True
408
 
    >>> parse_pre_1_6_1_interval('5m 30s') == datetime.timedelta(0, 330)
409
 
    True
410
 
    >>> parse_pre_1_6_1_interval('') == datetime.timedelta(0)
411
 
    True
 
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)
412
360
    >>> # Ignore unknown characters, allow any order and repetitions
413
 
    >>> parse_pre_1_6_1_interval('2dxy7zz11y3m5m') == datetime.timedelta(2, 480, 18000)
414
 
    True
 
361
    >>> parse_pre_1_6_1_interval('2dxy7zz11y3m5m')
 
362
    datetime.timedelta(2, 480, 18000)
415
363
 
416
364
    """
417
365
 
438
386
    """Apply additional restrictions on options, not expressible in
439
387
argparse"""
440
388
 
441
 
    def has_commands(options, commands=None):
442
 
        if commands is None:
443
 
            commands = (command.Enable,
444
 
                        command.Disable,
445
 
                        command.BumpTimeout,
446
 
                        command.StartChecker,
447
 
                        command.StopChecker,
448
 
                        command.IsEnabled,
449
 
                        command.Remove,
450
 
                        command.SetChecker,
451
 
                        command.SetTimeout,
452
 
                        command.SetExtendedTimeout,
453
 
                        command.SetInterval,
454
 
                        command.ApproveByDefault,
455
 
                        command.DenyByDefault,
456
 
                        command.SetApprovalDelay,
457
 
                        command.SetApprovalDuration,
458
 
                        command.SetHost,
459
 
                        command.SetSecret,
460
 
                        command.Approve,
461
 
                        command.Deny)
462
 
        return any(isinstance(cmd, commands)
463
 
                   for cmd in options.commands)
 
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))
464
408
 
465
 
    if has_commands(options) and not (options.client or options.all):
 
409
    if has_actions(options) and not (options.client or options.all):
466
410
        parser.error("Options require clients names or --all.")
467
 
    if options.verbose and has_commands(options):
 
411
    if options.verbose and has_actions(options):
468
412
        parser.error("--verbose can only be used alone.")
469
 
    if (has_commands(options, (command.DumpJSON,))
470
 
        and (options.verbose or len(options.commands) > 1)):
 
413
    if options.dump_json and (options.verbose
 
414
                              or has_actions(options)):
471
415
        parser.error("--dump-json can only be used alone.")
472
 
    if options.all and not has_commands(options):
 
416
    if options.all and not has_actions(options):
473
417
        parser.error("--all requires an action.")
474
 
    if (has_commands(options, (command.IsEnabled,))
475
 
        and len(options.client) > 1):
 
418
    if options.is_enabled and len(options.client) > 1:
476
419
        parser.error("--is-enabled requires exactly one client")
477
 
    if (len(options.commands) > 1
478
 
        and has_commands(options, (command.Remove,))
479
 
        and not has_commands(options, (command.Deny,))):
480
 
        parser.error("--remove can only be combined with --deny")
481
 
 
482
 
 
483
 
class dbus:
484
 
 
485
 
    class SystemBus:
486
 
 
487
 
        object_manager_iface = "org.freedesktop.DBus.ObjectManager"
488
 
        def get_managed_objects(self, busname, objectpath):
489
 
            return self.call_method("GetManagedObjects", busname,
490
 
                                    objectpath,
491
 
                                    self.object_manager_iface)
492
 
 
493
 
        properties_iface = "org.freedesktop.DBus.Properties"
494
 
        def set_property(self, busname, objectpath, interface, key,
495
 
                         value):
496
 
            self.call_method("Set", busname, objectpath,
497
 
                             self.properties_iface, interface, key,
498
 
                             value)
499
 
 
500
 
        def call_method(self, methodname, busname, objectpath,
501
 
                        interface, *args):
502
 
            raise NotImplementedError()
503
 
 
504
 
 
505
 
    class MandosBus(SystemBus):
506
 
        busname_domain = "se.recompile"
507
 
        busname = busname_domain + ".Mandos"
508
 
        server_path = "/"
509
 
        server_interface = busname_domain + ".Mandos"
510
 
        client_interface = busname_domain + ".Mandos.Client"
511
 
        del busname_domain
512
 
 
513
 
        def get_clients_and_properties(self):
514
 
            managed_objects = self.get_managed_objects(
515
 
                self.busname, self.server_path)
516
 
            return {objpath: properties[self.client_interface]
517
 
                    for objpath, properties in managed_objects.items()
518
 
                    if self.client_interface in properties}
519
 
 
520
 
        def set_client_property(self, objectpath, key, value):
521
 
            return self.set_property(self.busname, objectpath,
522
 
                                     self.client_interface, key,
523
 
                                     value)
524
 
 
525
 
        def call_client_method(self, objectpath, method, *args):
526
 
            return self.call_method(method, self.busname, objectpath,
527
 
                                    self.client_interface, *args)
528
 
 
529
 
        def call_server_method(self, method, *args):
530
 
            return self.call_method(method, self.busname,
531
 
                                    self.server_path,
532
 
                                    self.server_interface, *args)
533
 
 
534
 
    class Error(Exception):
535
 
        pass
536
 
 
537
 
    class ConnectFailed(Error):
538
 
        pass
539
 
 
540
 
 
541
 
class dbus_python_adapter:
542
 
 
543
 
    class SystemBus(dbus.MandosBus):
544
 
        """Use dbus-python"""
545
 
 
546
 
        def __init__(self, module=dbus_python):
547
 
            self.dbus_python = module
548
 
            self.bus = self.dbus_python.SystemBus()
549
 
 
550
 
        @contextlib.contextmanager
551
 
        def convert_exception(self, exception_class=dbus.Error):
552
 
            try:
553
 
                yield
554
 
            except self.dbus_python.exceptions.DBusException as e:
555
 
                # This does what "raise from" would do
556
 
                exc = exception_class(*e.args)
557
 
                exc.__cause__ = e
558
 
                raise exc
559
 
 
560
 
        def call_method(self, methodname, busname, objectpath,
561
 
                        interface, *args):
562
 
            proxy_object = self.get_object(busname, objectpath)
563
 
            log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
564
 
                      interface, methodname,
565
 
                      ", ".join(repr(a) for a in args))
566
 
            method = getattr(proxy_object, methodname)
567
 
            with self.convert_exception():
568
 
                with dbus_python_adapter.SilenceLogger(
569
 
                        "dbus.proxies"):
570
 
                    value = method(*args, dbus_interface=interface)
571
 
            return self.type_filter(value)
572
 
 
573
 
        def get_object(self, busname, objectpath):
574
 
            log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
575
 
                      busname, objectpath)
576
 
            with self.convert_exception(dbus.ConnectFailed):
577
 
                return self.bus.get_object(busname, objectpath)
578
 
 
579
 
        def type_filter(self, value):
580
 
            """Convert the most bothersome types to Python types"""
581
 
            if isinstance(value, self.dbus_python.Boolean):
582
 
                return bool(value)
583
 
            if isinstance(value, self.dbus_python.ObjectPath):
584
 
                return str(value)
585
 
            # Also recurse into dictionaries
586
 
            if isinstance(value, self.dbus_python.Dictionary):
587
 
                return {self.type_filter(key):
588
 
                        self.type_filter(subval)
589
 
                        for key, subval in value.items()}
590
 
            return value
591
 
 
592
 
        def set_client_property(self, objectpath, key, value):
593
 
            if key == "Secret":
594
 
                if not isinstance(value, bytes):
595
 
                    value = value.encode("utf-8")
596
 
                value = self.dbus_python.ByteArray(value)
597
 
            return self.set_property(self.busname, objectpath,
598
 
                                     self.client_interface, key,
599
 
                                     value)
600
 
 
601
 
    class SilenceLogger:
602
 
        "Simple context manager to silence a particular logger"
603
 
        def __init__(self, loggername):
604
 
            self.logger = logging.getLogger(loggername)
605
 
 
606
 
        def __enter__(self):
607
 
            self.logger.addFilter(self.nullfilter)
608
 
 
609
 
        class NullFilter(logging.Filter):
610
 
            def filter(self, record):
611
 
                return False
612
 
 
613
 
        nullfilter = NullFilter()
614
 
 
615
 
        def __exit__(self, exc_type, exc_val, exc_tb):
616
 
            self.logger.removeFilter(self.nullfilter)
617
 
 
618
 
 
619
 
    class CachingBus(SystemBus):
620
 
        """A caching layer for dbus_python_adapter.SystemBus"""
621
 
        def __init__(self, *args, **kwargs):
622
 
            self.object_cache = {}
623
 
            super(dbus_python_adapter.CachingBus,
624
 
                  self).__init__(*args, **kwargs)
625
 
        def get_object(self, busname, objectpath):
626
 
            try:
627
 
                return self.object_cache[(busname, objectpath)]
628
 
            except KeyError:
629
 
                new_object = super(
630
 
                    dbus_python_adapter.CachingBus,
631
 
                    self).get_object(busname, objectpath)
632
 
                self.object_cache[(busname, objectpath)]  = new_object
633
 
                return new_object
634
 
 
635
 
 
636
 
class pydbus_adapter:
637
 
    class SystemBus(dbus.MandosBus):
638
 
        def __init__(self, module=pydbus):
639
 
            self.pydbus = module
640
 
            self.bus = self.pydbus.SystemBus()
641
 
 
642
 
        @contextlib.contextmanager
643
 
        def convert_exception(self, exception_class=dbus.Error):
644
 
            try:
645
 
                yield
646
 
            except gi.repository.GLib.Error as e:
647
 
                # This does what "raise from" would do
648
 
                exc = exception_class(*e.args)
649
 
                exc.__cause__ = e
650
 
                raise exc
651
 
 
652
 
        def call_method(self, methodname, busname, objectpath,
653
 
                        interface, *args):
654
 
            proxy_object = self.get(busname, objectpath)
655
 
            log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
656
 
                      interface, methodname,
657
 
                      ", ".join(repr(a) for a in args))
658
 
            method = getattr(proxy_object[interface], methodname)
659
 
            with self.convert_exception():
660
 
                return method(*args)
661
 
 
662
 
        def get(self, busname, objectpath):
663
 
            log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
664
 
                      busname, objectpath)
665
 
            with self.convert_exception(dbus.ConnectFailed):
666
 
                if sys.version_info.major <= 2:
667
 
                    with warnings.catch_warnings():
668
 
                        warnings.filterwarnings(
669
 
                            "ignore", "", DeprecationWarning,
670
 
                            r"^xml\.etree\.ElementTree$")
671
 
                        return self.bus.get(busname, objectpath)
672
 
                else:
673
 
                    return self.bus.get(busname, objectpath)
674
 
 
675
 
        def set_property(self, busname, objectpath, interface, key,
676
 
                         value):
677
 
            proxy_object = self.get(busname, objectpath)
678
 
            log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", busname,
679
 
                      objectpath, self.properties_iface, interface,
680
 
                      key, value)
681
 
            setattr(proxy_object[interface], key, value)
682
 
 
683
 
    class CachingBus(SystemBus):
684
 
        """A caching layer for pydbus_adapter.SystemBus"""
685
 
        def __init__(self, *args, **kwargs):
686
 
            self.object_cache = {}
687
 
            super(pydbus_adapter.CachingBus,
688
 
                  self).__init__(*args, **kwargs)
689
 
        def get(self, busname, objectpath):
690
 
            try:
691
 
                return self.object_cache[(busname, objectpath)]
692
 
            except KeyError:
693
 
                new_object = (super(pydbus_adapter.CachingBus, self)
694
 
                              .get(busname, objectpath))
695
 
                self.object_cache[(busname, objectpath)]  = new_object
696
 
                return new_object
697
 
 
698
 
 
699
 
class dbussy_adapter:
700
 
    class SystemBus(dbus.SystemBus):
701
 
        """Use DBussy"""
702
 
 
703
 
        def __init__(self, dbussy, ravel):
704
 
            self.dbussy = dbussy
705
 
            self.ravel = ravel
706
 
            self.bus = ravel.system_bus()
707
 
 
708
 
        @contextlib.contextmanager
709
 
        def convert_exception(self, exception_class=dbus.Error):
710
 
            try:
711
 
                yield
712
 
            except self.dbussy.DBusError as e:
713
 
                # This does what "raise from" would do
714
 
                exc = exception_class(*e.args)
715
 
                exc.__cause__ = e
716
 
                raise exc
717
 
 
718
 
        def call_method(self, methodname, busname, objectpath,
719
 
                        interface, *args):
720
 
            proxy_object = self.get_object(busname, objectpath)
721
 
            log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
722
 
                      interface, methodname,
723
 
                      ", ".join(repr(a) for a in args))
724
 
            iface = proxy_object.get_interface(interface)
725
 
            method = getattr(iface, methodname)
726
 
            with self.convert_exception(dbus.Error):
727
 
                value =  method(*args)
728
 
            # DBussy returns values either as an empty list or as a
729
 
            # tuple: (signature, value)
730
 
            if value:
731
 
                return self.type_filter(value[0])
732
 
 
733
 
        def get_object(self, busname, objectpath):
734
 
            log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
735
 
                      busname, objectpath)
736
 
            with self.convert_exception(dbus.ConnectFailed):
737
 
                return self.bus[busname][objectpath]
738
 
 
739
 
        def type_filter(self, value):
740
 
            """Convert the most bothersome types to Python types"""
741
 
            if isinstance(value, tuple):
742
 
                if (len(value) == 2
743
 
                    and isinstance(value[0],
744
 
                                   self.dbussy.DBUS.Signature)):
745
 
                    return self.type_filter(value[1])
746
 
            elif isinstance(value, self.dbussy.DBUS.ObjectPath):
747
 
                return str(value)
748
 
            # Also recurse into dictionaries
749
 
            elif isinstance(value, dict):
750
 
                return {self.type_filter(key):
751
 
                        self.type_filter(subval)
752
 
                        for key, subval in value.items()}
753
 
            return value
754
 
 
755
 
        def set_property(self, busname, objectpath, interface, key,
756
 
                         value):
757
 
            proxy_object = self.get_object(busname, objectpath)
758
 
            log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", busname,
759
 
                      objectpath, self.properties_iface, interface,
760
 
                      key, value)
761
 
            if key == "Secret":
762
 
                # DBussy wants a Byte Array to be a sequence of
763
 
                # values, not a byte string
764
 
                value = tuple(value)
765
 
            setattr(proxy_object.get_interface(interface), key, value)
766
 
 
767
 
    class MandosBus(SystemBus, dbus.MandosBus):
768
 
        pass
769
 
 
770
 
    class CachingBus(MandosBus):
771
 
        """A caching layer for dbussy_adapter.MandosBus"""
772
 
        def __init__(self, *args, **kwargs):
773
 
            self.object_cache = {}
774
 
            super(dbussy_adapter.CachingBus, self).__init__(*args,
775
 
                                                            **kwargs)
776
 
        def get_object(self, busname, objectpath):
777
 
            try:
778
 
                return self.object_cache[(busname, objectpath)]
779
 
            except KeyError:
780
 
                new_object = super(
781
 
                    dbussy_adapter.CachingBus,
782
 
                    self).get_object(busname, objectpath)
783
 
                self.object_cache[(busname, objectpath)]  = new_object
784
 
                return new_object
 
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
        return self
 
464
 
 
465
    class NullFilter(logging.Filter):
 
466
        def filter(self, record):
 
467
            return False
 
468
 
 
469
    nullfilter = NullFilter()
 
470
 
 
471
    def __exit__(self, exc_type, exc_val, exc_tb):
 
472
        self.logger.removeFilter(self.nullfilter)
785
473
 
786
474
 
787
475
def commands_from_options(options):
788
476
 
789
 
    commands = list(options.commands)
790
 
 
791
 
    def find_cmd(cmd, commands):
792
 
        i = 0
793
 
        for i, c in enumerate(commands):
794
 
            if isinstance(c, cmd):
795
 
                return i
796
 
        return i+1
797
 
 
798
 
    # If command.Remove is present, move any instances of command.Deny
799
 
    # to occur ahead of command.Remove.
800
 
    index_of_remove = find_cmd(command.Remove, commands)
801
 
    before_remove = commands[:index_of_remove]
802
 
    after_remove = commands[index_of_remove:]
803
 
    cleaned_after = []
804
 
    for cmd in after_remove:
805
 
        if isinstance(cmd, command.Deny):
806
 
            before_remove.append(cmd)
 
477
    commands = []
 
478
 
 
479
    if options.is_enabled:
 
480
        commands.append(IsEnabledCmd())
 
481
 
 
482
    if options.approve:
 
483
        commands.append(ApproveCmd())
 
484
 
 
485
    if options.deny:
 
486
        commands.append(DenyCmd())
 
487
 
 
488
    if options.remove:
 
489
        commands.append(RemoveCmd())
 
490
 
 
491
    if options.dump_json:
 
492
        commands.append(DumpJSONCmd())
 
493
 
 
494
    if options.enable:
 
495
        commands.append(EnableCmd())
 
496
 
 
497
    if options.disable:
 
498
        commands.append(DisableCmd())
 
499
 
 
500
    if options.bump_timeout:
 
501
        commands.append(BumpTimeoutCmd())
 
502
 
 
503
    if options.start_checker:
 
504
        commands.append(StartCheckerCmd())
 
505
 
 
506
    if options.stop_checker:
 
507
        commands.append(StopCheckerCmd())
 
508
 
 
509
    if options.approved_by_default is not None:
 
510
        if options.approved_by_default:
 
511
            commands.append(ApproveByDefaultCmd())
807
512
        else:
808
 
            cleaned_after.append(cmd)
809
 
    if cleaned_after != after_remove:
810
 
        commands = before_remove + cleaned_after
 
513
            commands.append(DenyByDefaultCmd())
 
514
 
 
515
    if options.checker is not None:
 
516
        commands.append(SetCheckerCmd(options.checker))
 
517
 
 
518
    if options.host is not None:
 
519
        commands.append(SetHostCmd(options.host))
 
520
 
 
521
    if options.secret is not None:
 
522
        commands.append(SetSecretCmd(options.secret))
 
523
 
 
524
    if options.timeout is not None:
 
525
        commands.append(SetTimeoutCmd(options.timeout))
 
526
 
 
527
    if options.extended_timeout:
 
528
        commands.append(
 
529
            SetExtendedTimeoutCmd(options.extended_timeout))
 
530
 
 
531
    if options.interval is not None:
 
532
        commands.append(SetIntervalCmd(options.interval))
 
533
 
 
534
    if options.approval_delay is not None:
 
535
        commands.append(SetApprovalDelayCmd(options.approval_delay))
 
536
 
 
537
    if options.approval_duration is not None:
 
538
        commands.append(
 
539
            SetApprovalDurationCmd(options.approval_duration))
811
540
 
812
541
    # If no command option has been given, show table of clients,
813
542
    # optionally verbosely
814
543
    if not commands:
815
 
        commands.append(command.PrintTable(verbose=options.verbose))
 
544
        commands.append(PrintTableCmd(verbose=options.verbose))
816
545
 
817
546
    return commands
818
547
 
819
548
 
820
 
class command:
821
 
    """A namespace for command classes"""
822
 
 
823
 
    class Base:
824
 
        """Abstract base class for commands"""
825
 
        def run(self, clients, bus=None):
826
 
            """Normal commands should implement run_on_one_client(),
827
 
but commands which want to operate on all clients at the same time can
828
 
override this run() method instead.
829
 
"""
830
 
            self.bus = bus
831
 
            for client, properties in clients.items():
832
 
                self.run_on_one_client(client, properties)
833
 
 
834
 
 
835
 
    class IsEnabled(Base):
836
 
        def run(self, clients, bus=None):
837
 
            properties = next(iter(clients.values()))
838
 
            if properties["Enabled"]:
839
 
                sys.exit(0)
840
 
            sys.exit(1)
841
 
 
842
 
 
843
 
    class Approve(Base):
844
 
        def run_on_one_client(self, client, properties):
845
 
            self.bus.call_client_method(client, "Approve", True)
846
 
 
847
 
 
848
 
    class Deny(Base):
849
 
        def run_on_one_client(self, client, properties):
850
 
            self.bus.call_client_method(client, "Approve", False)
851
 
 
852
 
 
853
 
    class Remove(Base):
854
 
        def run(self, clients, bus):
855
 
            for clientpath in frozenset(clients.keys()):
856
 
                bus.call_server_method("RemoveClient", clientpath)
857
 
 
858
 
 
859
 
    class Output(Base):
860
 
        """Abstract class for commands outputting client details"""
861
 
        all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
862
 
                        "Created", "Interval", "Host", "KeyID",
863
 
                        "Fingerprint", "CheckerRunning",
864
 
                        "LastEnabled", "ApprovalPending",
865
 
                        "ApprovedByDefault", "LastApprovalRequest",
866
 
                        "ApprovalDelay", "ApprovalDuration",
867
 
                        "Checker", "ExtendedTimeout", "Expires",
868
 
                        "LastCheckerStatus")
869
 
 
870
 
 
871
 
    class DumpJSON(Output):
872
 
        def run(self, clients, bus=None):
873
 
            data = {properties["Name"]:
874
 
                    {key: properties[key]
875
 
                     for key in self.all_keywords}
876
 
                    for properties in clients.values()}
877
 
            print(json.dumps(data, indent=4, separators=(',', ': ')))
878
 
 
879
 
 
880
 
    class PrintTable(Output):
881
 
        def __init__(self, verbose=False):
882
 
            self.verbose = verbose
883
 
 
884
 
        def run(self, clients, bus=None):
885
 
            default_keywords = ("Name", "Enabled", "Timeout",
886
 
                                "LastCheckedOK")
887
 
            keywords = default_keywords
888
 
            if self.verbose:
889
 
                keywords = self.all_keywords
890
 
            print(self.TableOfClients(clients.values(), keywords))
891
 
 
892
 
        class TableOfClients:
893
 
            tableheaders = {
894
 
                "Name": "Name",
895
 
                "Enabled": "Enabled",
896
 
                "Timeout": "Timeout",
897
 
                "LastCheckedOK": "Last Successful Check",
898
 
                "LastApprovalRequest": "Last Approval Request",
899
 
                "Created": "Created",
900
 
                "Interval": "Interval",
901
 
                "Host": "Host",
902
 
                "Fingerprint": "Fingerprint",
903
 
                "KeyID": "Key ID",
904
 
                "CheckerRunning": "Check Is Running",
905
 
                "LastEnabled": "Last Enabled",
906
 
                "ApprovalPending": "Approval Is Pending",
907
 
                "ApprovedByDefault": "Approved By Default",
908
 
                "ApprovalDelay": "Approval Delay",
909
 
                "ApprovalDuration": "Approval Duration",
910
 
                "Checker": "Checker",
911
 
                "ExtendedTimeout": "Extended Timeout",
912
 
                "Expires": "Expires",
913
 
                "LastCheckerStatus": "Last Checker Status",
914
 
            }
915
 
 
916
 
            def __init__(self, clients, keywords):
917
 
                self.clients = clients
918
 
                self.keywords = keywords
919
 
 
 
549
class Command(object):
 
550
    """Abstract class for commands"""
 
551
    def run(self, clients, bus=None, mandos=None):
 
552
        """Normal commands should implement run_on_one_client(), but
 
553
        commands which want to operate on all clients at the same time
 
554
        can override this run() method instead."""
 
555
        self.mandos = mandos
 
556
        for clientpath, properties in clients.items():
 
557
            log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
 
558
                      dbus_busname, str(clientpath))
 
559
            client = bus.get_object(dbus_busname, clientpath)
 
560
            self.run_on_one_client(client, properties)
 
561
 
 
562
 
 
563
class IsEnabledCmd(Command):
 
564
    def run(self, clients, bus=None, mandos=None):
 
565
        client, properties = next(iter(clients.items()))
 
566
        if self.is_enabled(client, properties):
 
567
            sys.exit(0)
 
568
        sys.exit(1)
 
569
    def is_enabled(self, client, properties):
 
570
        return properties["Enabled"]
 
571
 
 
572
 
 
573
class ApproveCmd(Command):
 
574
    def run_on_one_client(self, client, properties):
 
575
        log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
 
576
                  client.__dbus_object_path__, client_dbus_interface)
 
577
        client.Approve(dbus.Boolean(True),
 
578
                       dbus_interface=client_dbus_interface)
 
579
 
 
580
 
 
581
class DenyCmd(Command):
 
582
    def run_on_one_client(self, client, properties):
 
583
        log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
 
584
                  client.__dbus_object_path__, client_dbus_interface)
 
585
        client.Approve(dbus.Boolean(False),
 
586
                       dbus_interface=client_dbus_interface)
 
587
 
 
588
 
 
589
class RemoveCmd(Command):
 
590
    def run_on_one_client(self, client, properties):
 
591
        log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)", dbus_busname,
 
592
                  server_dbus_path, server_dbus_interface,
 
593
                  str(client.__dbus_object_path__))
 
594
        self.mandos.RemoveClient(client.__dbus_object_path__)
 
595
 
 
596
 
 
597
class OutputCmd(Command):
 
598
    """Abstract class for commands outputting client details"""
 
599
    all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
 
600
                    "Created", "Interval", "Host", "KeyID",
 
601
                    "Fingerprint", "CheckerRunning", "LastEnabled",
 
602
                    "ApprovalPending", "ApprovedByDefault",
 
603
                    "LastApprovalRequest", "ApprovalDelay",
 
604
                    "ApprovalDuration", "Checker", "ExtendedTimeout",
 
605
                    "Expires", "LastCheckerStatus")
 
606
 
 
607
    def run(self, clients, bus=None, mandos=None):
 
608
        print(self.output(clients.values()))
 
609
 
 
610
    def output(self, clients):
 
611
        raise NotImplementedError()
 
612
 
 
613
 
 
614
class DumpJSONCmd(OutputCmd):
 
615
    def output(self, clients):
 
616
        data = {client["Name"]:
 
617
                {key: self.dbus_boolean_to_bool(client[key])
 
618
                 for key in self.all_keywords}
 
619
                for client in clients}
 
620
        return json.dumps(data, indent=4, separators=(',', ': '))
 
621
 
 
622
    @staticmethod
 
623
    def dbus_boolean_to_bool(value):
 
624
        if isinstance(value, dbus.Boolean):
 
625
            value = bool(value)
 
626
        return value
 
627
 
 
628
 
 
629
class PrintTableCmd(OutputCmd):
 
630
    def __init__(self, verbose=False):
 
631
        self.verbose = verbose
 
632
 
 
633
    def output(self, clients):
 
634
        default_keywords = ("Name", "Enabled", "Timeout",
 
635
                            "LastCheckedOK")
 
636
        keywords = default_keywords
 
637
        if self.verbose:
 
638
            keywords = self.all_keywords
 
639
        return str(self.TableOfClients(clients, keywords))
 
640
 
 
641
    class TableOfClients(object):
 
642
        tableheaders = {
 
643
            "Name": "Name",
 
644
            "Enabled": "Enabled",
 
645
            "Timeout": "Timeout",
 
646
            "LastCheckedOK": "Last Successful Check",
 
647
            "LastApprovalRequest": "Last Approval Request",
 
648
            "Created": "Created",
 
649
            "Interval": "Interval",
 
650
            "Host": "Host",
 
651
            "Fingerprint": "Fingerprint",
 
652
            "KeyID": "Key ID",
 
653
            "CheckerRunning": "Check Is Running",
 
654
            "LastEnabled": "Last Enabled",
 
655
            "ApprovalPending": "Approval Is Pending",
 
656
            "ApprovedByDefault": "Approved By Default",
 
657
            "ApprovalDelay": "Approval Delay",
 
658
            "ApprovalDuration": "Approval Duration",
 
659
            "Checker": "Checker",
 
660
            "ExtendedTimeout": "Extended Timeout",
 
661
            "Expires": "Expires",
 
662
            "LastCheckerStatus": "Last Checker Status",
 
663
        }
 
664
 
 
665
        def __init__(self, clients, keywords):
 
666
            self.clients = clients
 
667
            self.keywords = keywords
 
668
 
 
669
        def __str__(self):
 
670
            return "\n".join(self.rows())
 
671
 
 
672
        if sys.version_info.major == 2:
 
673
            __unicode__ = __str__
920
674
            def __str__(self):
921
 
                return "\n".join(self.rows())
922
 
 
923
 
            if sys.version_info.major == 2:
924
 
                __unicode__ = __str__
925
 
                def __str__(self):
926
 
                    return str(self).encode(
927
 
                        locale.getpreferredencoding())
928
 
 
929
 
            def rows(self):
930
 
                format_string = self.row_formatting_string()
931
 
                rows = [self.header_line(format_string)]
932
 
                rows.extend(self.client_line(client, format_string)
933
 
                            for client in self.clients)
934
 
                return rows
935
 
 
936
 
            def row_formatting_string(self):
937
 
                "Format string used to format table rows"
938
 
                return " ".join("{{{key}:{width}}}".format(
939
 
                    width=max(len(self.tableheaders[key]),
940
 
                              *(len(self.string_from_client(client,
941
 
                                                            key))
942
 
                                for client in self.clients)),
943
 
                    key=key)
944
 
                                for key in self.keywords)
945
 
 
946
 
            def string_from_client(self, client, key):
947
 
                return self.valuetostring(client[key], key)
948
 
 
949
 
            @classmethod
950
 
            def valuetostring(cls, value, keyword):
951
 
                if isinstance(value, bool):
952
 
                    return "Yes" if value else "No"
953
 
                if keyword in ("Timeout", "Interval", "ApprovalDelay",
954
 
                               "ApprovalDuration", "ExtendedTimeout"):
955
 
                    return cls.milliseconds_to_string(value)
956
 
                return str(value)
957
 
 
958
 
            def header_line(self, format_string):
959
 
                return format_string.format(**self.tableheaders)
960
 
 
961
 
            def client_line(self, client, format_string):
962
 
                return format_string.format(
963
 
                    **{key: self.string_from_client(client, key)
964
 
                       for key in self.keywords})
965
 
 
966
 
            @staticmethod
967
 
            def milliseconds_to_string(ms):
968
 
                td = datetime.timedelta(0, 0, 0, ms)
969
 
                return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
970
 
                        .format(days="{}T".format(td.days)
971
 
                                if td.days else "",
972
 
                                hours=td.seconds // 3600,
973
 
                                minutes=(td.seconds % 3600) // 60,
974
 
                                seconds=td.seconds % 60))
975
 
 
976
 
 
977
 
    class PropertySetter(Base):
978
 
        "Abstract class for Actions for setting one client property"
979
 
 
980
 
        def run_on_one_client(self, client, properties=None):
981
 
            """Set the Client's D-Bus property"""
982
 
            self.bus.set_client_property(client, self.propname,
983
 
                                         self.value_to_set)
984
 
 
985
 
        @property
986
 
        def propname(self):
987
 
            raise NotImplementedError()
988
 
 
989
 
 
990
 
    class Enable(PropertySetter):
991
 
        propname = "Enabled"
992
 
        value_to_set = True
993
 
 
994
 
 
995
 
    class Disable(PropertySetter):
996
 
        propname = "Enabled"
997
 
        value_to_set = False
998
 
 
999
 
 
1000
 
    class BumpTimeout(PropertySetter):
1001
 
        propname = "LastCheckedOK"
1002
 
        value_to_set = ""
1003
 
 
1004
 
 
1005
 
    class StartChecker(PropertySetter):
1006
 
        propname = "CheckerRunning"
1007
 
        value_to_set = True
1008
 
 
1009
 
 
1010
 
    class StopChecker(PropertySetter):
1011
 
        propname = "CheckerRunning"
1012
 
        value_to_set = False
1013
 
 
1014
 
 
1015
 
    class ApproveByDefault(PropertySetter):
1016
 
        propname = "ApprovedByDefault"
1017
 
        value_to_set = True
1018
 
 
1019
 
 
1020
 
    class DenyByDefault(PropertySetter):
1021
 
        propname = "ApprovedByDefault"
1022
 
        value_to_set = False
1023
 
 
1024
 
 
1025
 
    class PropertySetterValue(PropertySetter):
1026
 
        """Abstract class for PropertySetter recieving a value as
1027
 
constructor argument instead of a class attribute."""
1028
 
        def __init__(self, value):
1029
 
            self.value_to_set = value
 
675
                return str(self).encode(locale.getpreferredencoding())
 
676
 
 
677
        def rows(self):
 
678
            format_string = self.row_formatting_string()
 
679
            rows = [self.header_line(format_string)]
 
680
            rows.extend(self.client_line(client, format_string)
 
681
                        for client in self.clients)
 
682
            return rows
 
683
 
 
684
        def row_formatting_string(self):
 
685
            "Format string used to format table rows"
 
686
            return " ".join("{{{key}:{width}}}".format(
 
687
                width=max(len(self.tableheaders[key]),
 
688
                          *(len(self.string_from_client(client, key))
 
689
                            for client in self.clients)),
 
690
                key=key)
 
691
                            for key in self.keywords)
 
692
 
 
693
        def string_from_client(self, client, key):
 
694
            return self.valuetostring(client[key], key)
1030
695
 
1031
696
        @classmethod
1032
 
        def argparse(cls, argtype):
1033
 
            def cmdtype(arg):
1034
 
                return cls(argtype(arg))
1035
 
            return cmdtype
1036
 
 
1037
 
    class SetChecker(PropertySetterValue):
1038
 
        propname = "Checker"
1039
 
 
1040
 
 
1041
 
    class SetHost(PropertySetterValue):
1042
 
        propname = "Host"
1043
 
 
1044
 
 
1045
 
    class SetSecret(PropertySetterValue):
1046
 
        propname = "Secret"
1047
 
 
1048
 
        @property
1049
 
        def value_to_set(self):
1050
 
            return self._vts
1051
 
 
1052
 
        @value_to_set.setter
1053
 
        def value_to_set(self, value):
1054
 
            """When setting, read data from supplied file object"""
1055
 
            self._vts = value.read()
1056
 
            value.close()
1057
 
 
1058
 
 
1059
 
    class PropertySetterValueMilliseconds(PropertySetterValue):
1060
 
        """Abstract class for PropertySetterValue taking a value
1061
 
argument as a datetime.timedelta() but should store it as
1062
 
milliseconds."""
1063
 
 
1064
 
        @property
1065
 
        def value_to_set(self):
1066
 
            return self._vts
1067
 
 
1068
 
        @value_to_set.setter
1069
 
        def value_to_set(self, value):
1070
 
            "When setting, convert value from a datetime.timedelta"
1071
 
            self._vts = int(round(value.total_seconds() * 1000))
1072
 
 
1073
 
 
1074
 
    class SetTimeout(PropertySetterValueMilliseconds):
1075
 
        propname = "Timeout"
1076
 
 
1077
 
 
1078
 
    class SetExtendedTimeout(PropertySetterValueMilliseconds):
1079
 
        propname = "ExtendedTimeout"
1080
 
 
1081
 
 
1082
 
    class SetInterval(PropertySetterValueMilliseconds):
1083
 
        propname = "Interval"
1084
 
 
1085
 
 
1086
 
    class SetApprovalDelay(PropertySetterValueMilliseconds):
1087
 
        propname = "ApprovalDelay"
1088
 
 
1089
 
 
1090
 
    class SetApprovalDuration(PropertySetterValueMilliseconds):
1091
 
        propname = "ApprovalDuration"
 
697
        def valuetostring(cls, value, keyword):
 
698
            if isinstance(value, dbus.Boolean):
 
699
                return "Yes" if value else "No"
 
700
            if keyword in ("Timeout", "Interval", "ApprovalDelay",
 
701
                           "ApprovalDuration", "ExtendedTimeout"):
 
702
                return cls.milliseconds_to_string(value)
 
703
            return str(value)
 
704
 
 
705
        def header_line(self, format_string):
 
706
            return format_string.format(**self.tableheaders)
 
707
 
 
708
        def client_line(self, client, format_string):
 
709
            return format_string.format(
 
710
                **{key: self.string_from_client(client, key)
 
711
                   for key in self.keywords})
 
712
 
 
713
        @staticmethod
 
714
        def milliseconds_to_string(ms):
 
715
            td = datetime.timedelta(0, 0, 0, ms)
 
716
            return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
 
717
                    .format(days="{}T".format(td.days)
 
718
                            if td.days else "",
 
719
                            hours=td.seconds // 3600,
 
720
                            minutes=(td.seconds % 3600) // 60,
 
721
                            seconds=td.seconds % 60))
 
722
 
 
723
 
 
724
class PropertyCmd(Command):
 
725
    """Abstract class for Actions for setting one client property"""
 
726
 
 
727
    def run_on_one_client(self, client, properties):
 
728
        """Set the Client's D-Bus property"""
 
729
        log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
 
730
                  client.__dbus_object_path__,
 
731
                  dbus.PROPERTIES_IFACE, client_dbus_interface,
 
732
                  self.propname, self.value_to_set
 
733
                  if not isinstance(self.value_to_set, dbus.Boolean)
 
734
                  else bool(self.value_to_set))
 
735
        client.Set(client_dbus_interface, self.propname,
 
736
                   self.value_to_set,
 
737
                   dbus_interface=dbus.PROPERTIES_IFACE)
 
738
 
 
739
    @property
 
740
    def propname(self):
 
741
        raise NotImplementedError()
 
742
 
 
743
 
 
744
class EnableCmd(PropertyCmd):
 
745
    propname = "Enabled"
 
746
    value_to_set = dbus.Boolean(True)
 
747
 
 
748
 
 
749
class DisableCmd(PropertyCmd):
 
750
    propname = "Enabled"
 
751
    value_to_set = dbus.Boolean(False)
 
752
 
 
753
 
 
754
class BumpTimeoutCmd(PropertyCmd):
 
755
    propname = "LastCheckedOK"
 
756
    value_to_set = ""
 
757
 
 
758
 
 
759
class StartCheckerCmd(PropertyCmd):
 
760
    propname = "CheckerRunning"
 
761
    value_to_set = dbus.Boolean(True)
 
762
 
 
763
 
 
764
class StopCheckerCmd(PropertyCmd):
 
765
    propname = "CheckerRunning"
 
766
    value_to_set = dbus.Boolean(False)
 
767
 
 
768
 
 
769
class ApproveByDefaultCmd(PropertyCmd):
 
770
    propname = "ApprovedByDefault"
 
771
    value_to_set = dbus.Boolean(True)
 
772
 
 
773
 
 
774
class DenyByDefaultCmd(PropertyCmd):
 
775
    propname = "ApprovedByDefault"
 
776
    value_to_set = dbus.Boolean(False)
 
777
 
 
778
 
 
779
class PropertyValueCmd(PropertyCmd):
 
780
    """Abstract class for PropertyCmd recieving a value as argument"""
 
781
    def __init__(self, value):
 
782
        self.value_to_set = value
 
783
 
 
784
 
 
785
class SetCheckerCmd(PropertyValueCmd):
 
786
    propname = "Checker"
 
787
 
 
788
 
 
789
class SetHostCmd(PropertyValueCmd):
 
790
    propname = "Host"
 
791
 
 
792
 
 
793
class SetSecretCmd(PropertyValueCmd):
 
794
    propname = "Secret"
 
795
 
 
796
    @property
 
797
    def value_to_set(self):
 
798
        return self._vts
 
799
 
 
800
    @value_to_set.setter
 
801
    def value_to_set(self, value):
 
802
        """When setting, read data from supplied file object"""
 
803
        self._vts = value.read()
 
804
        value.close()
 
805
 
 
806
 
 
807
class MillisecondsPropertyValueArgumentCmd(PropertyValueCmd):
 
808
    """Abstract class for PropertyValueCmd taking a value argument as
 
809
a datetime.timedelta() but should store it as milliseconds."""
 
810
 
 
811
    @property
 
812
    def value_to_set(self):
 
813
        return self._vts
 
814
 
 
815
    @value_to_set.setter
 
816
    def value_to_set(self, value):
 
817
        """When setting, convert value from a datetime.timedelta"""
 
818
        self._vts = int(round(value.total_seconds() * 1000))
 
819
 
 
820
 
 
821
class SetTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
 
822
    propname = "Timeout"
 
823
 
 
824
 
 
825
class SetExtendedTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
 
826
    propname = "ExtendedTimeout"
 
827
 
 
828
 
 
829
class SetIntervalCmd(MillisecondsPropertyValueArgumentCmd):
 
830
    propname = "Interval"
 
831
 
 
832
 
 
833
class SetApprovalDelayCmd(MillisecondsPropertyValueArgumentCmd):
 
834
    propname = "ApprovalDelay"
 
835
 
 
836
 
 
837
class SetApprovalDurationCmd(MillisecondsPropertyValueArgumentCmd):
 
838
    propname = "ApprovalDuration"
1092
839
 
1093
840
 
1094
841
 
1125
872
                                                    ("records",
1126
873
                                                     "output"))
1127
874
 
1128
 
 
1129
 
class Unique:
1130
 
    """Class for objects which exist only to be unique objects, since
1131
 
unittest.mock.sentinel only exists in Python 3.3"""
1132
 
 
1133
 
 
1134
875
class Test_string_to_delta(TestCaseWithAssertLogs):
1135
 
    # Just test basic RFC 3339 functionality here, the doc string for
1136
 
    # rfc3339_duration_to_delta() already has more comprehensive
1137
 
    # tests, which are run by doctest.
1138
 
 
1139
 
    def test_rfc3339_zero_seconds(self):
1140
 
        self.assertEqual(datetime.timedelta(),
1141
 
                         string_to_delta("PT0S"))
1142
 
 
1143
 
    def test_rfc3339_zero_days(self):
1144
 
        self.assertEqual(datetime.timedelta(), string_to_delta("P0D"))
1145
 
 
1146
 
    def test_rfc3339_one_second(self):
1147
 
        self.assertEqual(datetime.timedelta(0, 1),
1148
 
                         string_to_delta("PT1S"))
1149
 
 
1150
 
    def test_rfc3339_two_hours(self):
1151
 
        self.assertEqual(datetime.timedelta(0, 7200),
1152
 
                         string_to_delta("PT2H"))
 
876
    def test_handles_basic_rfc3339(self):
 
877
        self.assertEqual(string_to_delta("PT0S"),
 
878
                         datetime.timedelta())
 
879
        self.assertEqual(string_to_delta("P0D"),
 
880
                         datetime.timedelta())
 
881
        self.assertEqual(string_to_delta("PT1S"),
 
882
                         datetime.timedelta(0, 1))
 
883
        self.assertEqual(string_to_delta("PT2H"),
 
884
                         datetime.timedelta(0, 7200))
1153
885
 
1154
886
    def test_falls_back_to_pre_1_6_1_with_warning(self):
1155
887
        with self.assertLogs(log, logging.WARNING):
1156
888
            value = string_to_delta("2h")
1157
 
        self.assertEqual(datetime.timedelta(0, 7200), value)
 
889
        self.assertEqual(value, datetime.timedelta(0, 7200))
1158
890
 
1159
891
 
1160
892
class Test_check_option_syntax(unittest.TestCase):
1164
896
 
1165
897
    def test_actions_requires_client_or_all(self):
1166
898
        for action, value in self.actions.items():
1167
 
            args = self.actionargs(action, value)
 
899
            options = self.parser.parse_args()
 
900
            setattr(options, action, value)
1168
901
            with self.assertParseError():
1169
 
                self.parse_args(args)
 
902
                self.check_option_syntax(options)
1170
903
 
1171
 
    # This mostly corresponds to the definition from has_commands() in
 
904
    # This mostly corresponds to the definition from has_actions() in
1172
905
    # check_option_syntax()
1173
906
    actions = {
1174
 
        "--enable": None,
1175
 
        "--disable": None,
1176
 
        "--bump-timeout": None,
1177
 
        "--start-checker": None,
1178
 
        "--stop-checker": None,
1179
 
        "--is-enabled": None,
1180
 
        "--remove": None,
1181
 
        "--checker": "x",
1182
 
        "--timeout": "PT0S",
1183
 
        "--extended-timeout": "PT0S",
1184
 
        "--interval": "PT0S",
1185
 
        "--approve-by-default": None,
1186
 
        "--deny-by-default": None,
1187
 
        "--approval-delay": "PT0S",
1188
 
        "--approval-duration": "PT0S",
1189
 
        "--host": "hostname",
1190
 
        "--secret": "/dev/null",
1191
 
        "--approve": None,
1192
 
        "--deny": None,
 
907
        # The actual values set here are not that important, but we do
 
908
        # at least stick to the correct types, even though they are
 
909
        # never used
 
910
        "enable": True,
 
911
        "disable": True,
 
912
        "bump_timeout": True,
 
913
        "start_checker": True,
 
914
        "stop_checker": True,
 
915
        "is_enabled": True,
 
916
        "remove": True,
 
917
        "checker": "x",
 
918
        "timeout": datetime.timedelta(),
 
919
        "extended_timeout": datetime.timedelta(),
 
920
        "interval": datetime.timedelta(),
 
921
        "approved_by_default": True,
 
922
        "approval_delay": datetime.timedelta(),
 
923
        "approval_duration": datetime.timedelta(),
 
924
        "host": "x",
 
925
        "secret": io.BytesIO(b"x"),
 
926
        "approve": True,
 
927
        "deny": True,
1193
928
    }
1194
929
 
1195
 
    @staticmethod
1196
 
    def actionargs(action, value, *args):
1197
 
        if value is not None:
1198
 
            return [action, value] + list(args)
1199
 
        else:
1200
 
            return [action] + list(args)
1201
 
 
1202
930
    @contextlib.contextmanager
1203
931
    def assertParseError(self):
1204
932
        with self.assertRaises(SystemExit) as e:
1205
 
            with self.redirect_stderr_to_devnull():
 
933
            with self.temporarily_suppress_stderr():
1206
934
                yield
1207
935
        # Exit code from argparse is guaranteed to be "2".  Reference:
1208
936
        # https://docs.python.org/3/library
1209
937
        # /argparse.html#exiting-methods
1210
 
        self.assertEqual(2, e.exception.code)
1211
 
 
1212
 
    def parse_args(self, args):
1213
 
        options = self.parser.parse_args(args)
1214
 
        check_option_syntax(self.parser, options)
 
938
        self.assertEqual(e.exception.code, 2)
1215
939
 
1216
940
    @staticmethod
1217
941
    @contextlib.contextmanager
1218
 
    def redirect_stderr_to_devnull():
1219
 
        old_stderr = sys.stderr
1220
 
        with contextlib.closing(open(os.devnull, "w")) as null:
1221
 
            sys.stderr = null
1222
 
            try:
1223
 
                yield
1224
 
            finally:
1225
 
                sys.stderr = old_stderr
 
942
    def temporarily_suppress_stderr():
 
943
        null = os.open(os.path.devnull, os.O_RDWR)
 
944
        stderrcopy = os.dup(sys.stderr.fileno())
 
945
        os.dup2(null, sys.stderr.fileno())
 
946
        os.close(null)
 
947
        try:
 
948
            yield
 
949
        finally:
 
950
            # restore stderr
 
951
            os.dup2(stderrcopy, sys.stderr.fileno())
 
952
            os.close(stderrcopy)
1226
953
 
1227
954
    def check_option_syntax(self, options):
1228
955
        check_option_syntax(self.parser, options)
1229
956
 
1230
 
    def test_actions_all_conflicts_with_verbose(self):
1231
 
        for action, value in self.actions.items():
1232
 
            args = self.actionargs(action, value, "--all",
1233
 
                                   "--verbose")
1234
 
            with self.assertParseError():
1235
 
                self.parse_args(args)
1236
 
 
1237
 
    def test_actions_with_client_conflicts_with_verbose(self):
1238
 
        for action, value in self.actions.items():
1239
 
            args = self.actionargs(action, value, "--verbose",
1240
 
                                   "client")
1241
 
            with self.assertParseError():
1242
 
                self.parse_args(args)
 
957
    def test_actions_conflicts_with_verbose(self):
 
958
        for action, value in self.actions.items():
 
959
            options = self.parser.parse_args()
 
960
            setattr(options, action, value)
 
961
            options.verbose = True
 
962
            with self.assertParseError():
 
963
                self.check_option_syntax(options)
1243
964
 
1244
965
    def test_dump_json_conflicts_with_verbose(self):
1245
 
        args = ["--dump-json", "--verbose"]
 
966
        options = self.parser.parse_args()
 
967
        options.dump_json = True
 
968
        options.verbose = True
1246
969
        with self.assertParseError():
1247
 
            self.parse_args(args)
 
970
            self.check_option_syntax(options)
1248
971
 
1249
972
    def test_dump_json_conflicts_with_action(self):
1250
973
        for action, value in self.actions.items():
1251
 
            args = self.actionargs(action, value, "--dump-json")
 
974
            options = self.parser.parse_args()
 
975
            setattr(options, action, value)
 
976
            options.dump_json = True
1252
977
            with self.assertParseError():
1253
 
                self.parse_args(args)
 
978
                self.check_option_syntax(options)
1254
979
 
1255
980
    def test_all_can_not_be_alone(self):
1256
 
        args = ["--all"]
 
981
        options = self.parser.parse_args()
 
982
        options.all = True
1257
983
        with self.assertParseError():
1258
 
            self.parse_args(args)
 
984
            self.check_option_syntax(options)
1259
985
 
1260
986
    def test_all_is_ok_with_any_action(self):
1261
987
        for action, value in self.actions.items():
1262
 
            args = self.actionargs(action, value, "--all")
1263
 
            self.parse_args(args)
1264
 
 
1265
 
    def test_any_action_is_ok_with_one_client(self):
1266
 
        for action, value in self.actions.items():
1267
 
            args = self.actionargs(action, value, "client")
1268
 
            self.parse_args(args)
1269
 
 
1270
 
    def test_one_client_with_all_actions_except_is_enabled(self):
1271
 
        for action, value in self.actions.items():
1272
 
            if action == "--is-enabled":
1273
 
                continue
1274
 
            args = self.actionargs(action, value, "client")
1275
 
            self.parse_args(args)
1276
 
 
1277
 
    def test_two_clients_with_all_actions_except_is_enabled(self):
1278
 
        for action, value in self.actions.items():
1279
 
            if action == "--is-enabled":
1280
 
                continue
1281
 
            args = self.actionargs(action, value, "client1",
1282
 
                                   "client2")
1283
 
            self.parse_args(args)
1284
 
 
1285
 
    def test_two_clients_are_ok_with_actions_except_is_enabled(self):
1286
 
        for action, value in self.actions.items():
1287
 
            if action == "--is-enabled":
1288
 
                continue
1289
 
            args = self.actionargs(action, value, "client1",
1290
 
                                   "client2")
1291
 
            self.parse_args(args)
 
988
            options = self.parser.parse_args()
 
989
            setattr(options, action, value)
 
990
            options.all = True
 
991
            self.check_option_syntax(options)
1292
992
 
1293
993
    def test_is_enabled_fails_without_client(self):
1294
 
        args = ["--is-enabled"]
 
994
        options = self.parser.parse_args()
 
995
        options.is_enabled = True
1295
996
        with self.assertParseError():
1296
 
            self.parse_args(args)
 
997
            self.check_option_syntax(options)
 
998
 
 
999
    def test_is_enabled_works_with_one_client(self):
 
1000
        options = self.parser.parse_args()
 
1001
        options.is_enabled = True
 
1002
        options.client = ["foo"]
 
1003
        self.check_option_syntax(options)
1297
1004
 
1298
1005
    def test_is_enabled_fails_with_two_clients(self):
1299
 
        args = ["--is-enabled", "client1", "client2"]
 
1006
        options = self.parser.parse_args()
 
1007
        options.is_enabled = True
 
1008
        options.client = ["foo", "barbar"]
1300
1009
        with self.assertParseError():
1301
 
            self.parse_args(args)
 
1010
            self.check_option_syntax(options)
1302
1011
 
1303
1012
    def test_remove_can_only_be_combined_with_action_deny(self):
1304
1013
        for action, value in self.actions.items():
1305
 
            if action in {"--remove", "--deny"}:
 
1014
            if action in {"remove", "deny"}:
1306
1015
                continue
1307
 
            args = self.actionargs(action, value, "--all",
1308
 
                                   "--remove")
 
1016
            options = self.parser.parse_args()
 
1017
            setattr(options, action, value)
 
1018
            options.all = True
 
1019
            options.remove = True
1309
1020
            with self.assertParseError():
1310
 
                self.parse_args(args)
1311
 
 
1312
 
 
1313
 
class Test_dbus_exceptions(unittest.TestCase):
1314
 
 
1315
 
    def test_dbus_ConnectFailed_is_Error(self):
1316
 
        with self.assertRaises(dbus.Error):
1317
 
            raise dbus.ConnectFailed()
1318
 
 
1319
 
 
1320
 
class Test_dbus_MandosBus(unittest.TestCase):
1321
 
 
1322
 
    class MockMandosBus(dbus.MandosBus):
1323
 
        def __init__(self):
1324
 
            self._name = "se.recompile.Mandos"
1325
 
            self._server_path = "/"
1326
 
            self._server_interface = "se.recompile.Mandos"
1327
 
            self._client_interface = "se.recompile.Mandos.Client"
1328
 
            self.calls = []
1329
 
            self.call_method_return = Unique()
1330
 
 
1331
 
        def call_method(self, methodname, busname, objectpath,
1332
 
                        interface, *args):
1333
 
            self.calls.append((methodname, busname, objectpath,
1334
 
                               interface, args))
1335
 
            return self.call_method_return
1336
 
 
1337
 
    def setUp(self):
1338
 
        self.bus = self.MockMandosBus()
1339
 
 
1340
 
    def test_set_client_property(self):
1341
 
        self.bus.set_client_property("objectpath", "key", "value")
1342
 
        expected_call = ("Set", self.bus._name, "objectpath",
1343
 
                         "org.freedesktop.DBus.Properties",
1344
 
                         (self.bus._client_interface, "key", "value"))
1345
 
        self.assertIn(expected_call, self.bus.calls)
1346
 
 
1347
 
    def test_call_client_method(self):
1348
 
        ret = self.bus.call_client_method("objectpath", "methodname")
1349
 
        self.assertIs(self.bus.call_method_return, ret)
1350
 
        expected_call = ("methodname", self.bus._name, "objectpath",
1351
 
                         self.bus._client_interface, ())
1352
 
        self.assertIn(expected_call, self.bus.calls)
1353
 
 
1354
 
    def test_call_client_method_with_args(self):
1355
 
        args = (Unique(), Unique())
1356
 
        ret = self.bus.call_client_method("objectpath", "methodname",
1357
 
                                          *args)
1358
 
        self.assertIs(self.bus.call_method_return, ret)
1359
 
        expected_call = ("methodname", self.bus._name, "objectpath",
1360
 
                         self.bus._client_interface,
1361
 
                         (args[0], args[1]))
1362
 
        self.assertIn(expected_call, self.bus.calls)
1363
 
 
1364
 
    def test_get_clients_and_properties(self):
1365
 
        managed_objects = {
1366
 
            "objectpath": {
1367
 
                self.bus._client_interface: {
1368
 
                    "key": "value",
1369
 
                    "bool": True,
1370
 
                },
1371
 
                "irrelevant_interface": {
1372
 
                    "key": "othervalue",
1373
 
                    "bool": False,
1374
 
                },
1375
 
            },
1376
 
            "other_objectpath": {
1377
 
                "other_irrelevant_interface": {
1378
 
                    "key": "value 3",
1379
 
                    "bool": None,
1380
 
                },
1381
 
            },
1382
 
        }
1383
 
        expected_clients_and_properties = {
1384
 
            "objectpath": {
1385
 
                "key": "value",
1386
 
                "bool": True,
1387
 
            }
1388
 
        }
1389
 
        self.bus.call_method_return = managed_objects
1390
 
        ret = self.bus.get_clients_and_properties()
1391
 
        self.assertDictEqual(expected_clients_and_properties, ret)
1392
 
        expected_call = ("GetManagedObjects", self.bus._name,
1393
 
                         self.bus._server_path,
1394
 
                         "org.freedesktop.DBus.ObjectManager", ())
1395
 
        self.assertIn(expected_call, self.bus.calls)
1396
 
 
1397
 
    def test_call_server_method(self):
1398
 
        ret = self.bus.call_server_method("methodname")
1399
 
        self.assertIs(self.bus.call_method_return, ret)
1400
 
        expected_call = ("methodname", self.bus._name,
1401
 
                         self.bus._server_path,
1402
 
                         self.bus._server_interface, ())
1403
 
        self.assertIn(expected_call, self.bus.calls)
1404
 
 
1405
 
    def test_call_server_method_with_args(self):
1406
 
        args = (Unique(), Unique())
1407
 
        ret = self.bus.call_server_method("methodname", *args)
1408
 
        self.assertIs(self.bus.call_method_return, ret)
1409
 
        expected_call = ("methodname", self.bus._name,
1410
 
                         self.bus._server_path,
1411
 
                         self.bus._server_interface,
1412
 
                         (args[0], args[1]))
1413
 
        self.assertIn(expected_call, self.bus.calls)
1414
 
 
1415
 
 
1416
 
class Test_dbus_python_adapter_SystemBus(TestCaseWithAssertLogs):
1417
 
 
1418
 
    def MockDBusPython_func(self, func):
1419
 
        class mock_dbus_python:
1420
 
            """mock dbus-python module"""
1421
 
            class exceptions:
1422
 
                """Pseudo-namespace"""
1423
 
                class DBusException(Exception):
1424
 
                    pass
1425
 
            class SystemBus:
1426
 
                @staticmethod
1427
 
                def get_object(busname, objectpath):
1428
 
                    DBusObject = collections.namedtuple(
1429
 
                        "DBusObject", ("methodname", "Set"))
1430
 
                    def method(*args, **kwargs):
1431
 
                        self.assertEqual({"dbus_interface":
1432
 
                                          "interface"},
1433
 
                                         kwargs)
1434
 
                        return func(*args)
1435
 
                    def set_property(interface, key, value,
1436
 
                                     dbus_interface=None):
1437
 
                        self.assertEqual(
1438
 
                            "org.freedesktop.DBus.Properties",
1439
 
                            dbus_interface)
1440
 
                        self.assertEqual("Secret", key)
1441
 
                        return func(interface, key, value,
1442
 
                                    dbus_interface=dbus_interface)
1443
 
                    return DBusObject(methodname=method,
1444
 
                                      Set=set_property)
1445
 
            class Boolean:
1446
 
                def __init__(self, value):
1447
 
                    self.value = bool(value)
1448
 
                def __bool__(self):
1449
 
                    return self.value
1450
 
                if sys.version_info.major == 2:
1451
 
                    __nonzero__ = __bool__
1452
 
            class ObjectPath(str):
1453
 
                pass
1454
 
            class Dictionary(dict):
1455
 
                pass
1456
 
            class ByteArray(bytes):
1457
 
                pass
1458
 
        return mock_dbus_python
1459
 
 
1460
 
    def call_method(self, bus, methodname, busname, objectpath,
1461
 
                    interface, *args):
1462
 
        with self.assertLogs(log, logging.DEBUG):
1463
 
            return bus.call_method(methodname, busname, objectpath,
1464
 
                                   interface, *args)
1465
 
 
1466
 
    def test_call_method_returns(self):
1467
 
        expected_method_return = Unique()
1468
 
        method_args = (Unique(), Unique())
1469
 
        def func(*args):
1470
 
            self.assertEqual(len(method_args), len(args))
1471
 
            for marg, arg in zip(method_args, args):
1472
 
                self.assertIs(marg, arg)
1473
 
            return expected_method_return
1474
 
        mock_dbus_python = self.MockDBusPython_func(func)
1475
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1476
 
        ret = self.call_method(bus, "methodname", "busname",
1477
 
                               "objectpath", "interface",
1478
 
                               *method_args)
1479
 
        self.assertIs(ret, expected_method_return)
1480
 
 
1481
 
    def test_call_method_filters_bool_true(self):
1482
 
        def func():
1483
 
            return method_return
1484
 
        mock_dbus_python = self.MockDBusPython_func(func)
1485
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1486
 
        method_return = mock_dbus_python.Boolean(True)
1487
 
        ret = self.call_method(bus, "methodname", "busname",
1488
 
                               "objectpath", "interface")
1489
 
        self.assertTrue(ret)
1490
 
        self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1491
 
 
1492
 
    def test_call_method_filters_bool_false(self):
1493
 
        def func():
1494
 
            return method_return
1495
 
        mock_dbus_python = self.MockDBusPython_func(func)
1496
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1497
 
        method_return = mock_dbus_python.Boolean(False)
1498
 
        ret = self.call_method(bus, "methodname", "busname",
1499
 
                               "objectpath", "interface")
1500
 
        self.assertFalse(ret)
1501
 
        self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1502
 
 
1503
 
    def test_call_method_filters_objectpath(self):
1504
 
        def func():
1505
 
            return method_return
1506
 
        mock_dbus_python = self.MockDBusPython_func(func)
1507
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1508
 
        method_return = mock_dbus_python.ObjectPath("objectpath")
1509
 
        ret = self.call_method(bus, "methodname", "busname",
1510
 
                               "objectpath", "interface")
1511
 
        self.assertEqual("objectpath", ret)
1512
 
        self.assertIsNot("objectpath", ret)
1513
 
        self.assertNotIsInstance(ret, mock_dbus_python.ObjectPath)
1514
 
 
1515
 
    def test_call_method_filters_booleans_in_dict(self):
1516
 
        def func():
1517
 
            return method_return
1518
 
        mock_dbus_python = self.MockDBusPython_func(func)
1519
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1520
 
        method_return = mock_dbus_python.Dictionary(
1521
 
        {mock_dbus_python.Boolean(True):
1522
 
         mock_dbus_python.Boolean(False),
1523
 
         mock_dbus_python.Boolean(False):
1524
 
         mock_dbus_python.Boolean(True)})
1525
 
        ret = self.call_method(bus, "methodname", "busname",
1526
 
                               "objectpath", "interface")
1527
 
        expected_method_return = {True: False,
1528
 
                                  False: True}
1529
 
        self.assertEqual(expected_method_return, ret)
1530
 
        self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1531
 
 
1532
 
    def test_call_method_filters_objectpaths_in_dict(self):
1533
 
        def func():
1534
 
            return method_return
1535
 
        mock_dbus_python = self.MockDBusPython_func(func)
1536
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1537
 
        method_return = mock_dbus_python.Dictionary(
1538
 
        {mock_dbus_python.ObjectPath("objectpath_key_1"):
1539
 
         mock_dbus_python.ObjectPath("objectpath_value_1"),
1540
 
         mock_dbus_python.ObjectPath("objectpath_key_2"):
1541
 
         mock_dbus_python.ObjectPath("objectpath_value_2")})
1542
 
        ret = self.call_method(bus, "methodname", "busname",
1543
 
                               "objectpath", "interface")
1544
 
        expected_method_return = {str(key): str(value)
1545
 
                                  for key, value in
1546
 
                                  method_return.items()}
1547
 
        self.assertEqual(expected_method_return, ret)
1548
 
        self.assertIsInstance(ret, dict)
1549
 
        self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1550
 
 
1551
 
    def test_call_method_filters_dict_in_dict(self):
1552
 
        def func():
1553
 
            return method_return
1554
 
        mock_dbus_python = self.MockDBusPython_func(func)
1555
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1556
 
        method_return = mock_dbus_python.Dictionary(
1557
 
        {"key1": mock_dbus_python.Dictionary({"key11": "value11",
1558
 
                                              "key12": "value12"}),
1559
 
         "key2": mock_dbus_python.Dictionary({"key21": "value21",
1560
 
                                              "key22": "value22"})})
1561
 
        ret = self.call_method(bus, "methodname", "busname",
1562
 
                               "objectpath", "interface")
1563
 
        expected_method_return = {
1564
 
            "key1": {"key11": "value11",
1565
 
                     "key12": "value12"},
1566
 
            "key2": {"key21": "value21",
1567
 
                     "key22": "value22"},
1568
 
        }
1569
 
        self.assertEqual(expected_method_return, ret)
1570
 
        self.assertIsInstance(ret, dict)
1571
 
        self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1572
 
        for key, value in ret.items():
1573
 
            self.assertIsInstance(value, dict)
1574
 
            self.assertEqual(expected_method_return[key], value)
1575
 
            self.assertNotIsInstance(value,
1576
 
                                     mock_dbus_python.Dictionary)
1577
 
 
1578
 
    def test_call_method_filters_dict_three_deep(self):
1579
 
        def func():
1580
 
            return method_return
1581
 
        mock_dbus_python = self.MockDBusPython_func(func)
1582
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1583
 
        method_return = mock_dbus_python.Dictionary(
1584
 
            {"key1":
1585
 
             mock_dbus_python.Dictionary(
1586
 
                 {"key2":
1587
 
                  mock_dbus_python.Dictionary(
1588
 
                      {"key3":
1589
 
                       mock_dbus_python.Boolean(True),
1590
 
                       }),
1591
 
                  }),
1592
 
             })
1593
 
        ret = self.call_method(bus, "methodname", "busname",
1594
 
                               "objectpath", "interface")
1595
 
        expected_method_return = {"key1": {"key2": {"key3": True}}}
1596
 
        self.assertEqual(expected_method_return, ret)
1597
 
        self.assertIsInstance(ret, dict)
1598
 
        self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1599
 
        self.assertIsInstance(ret["key1"], dict)
1600
 
        self.assertNotIsInstance(ret["key1"],
1601
 
                                 mock_dbus_python.Dictionary)
1602
 
        self.assertIsInstance(ret["key1"]["key2"], dict)
1603
 
        self.assertNotIsInstance(ret["key1"]["key2"],
1604
 
                                 mock_dbus_python.Dictionary)
1605
 
        self.assertTrue(ret["key1"]["key2"]["key3"])
1606
 
        self.assertNotIsInstance(ret["key1"]["key2"]["key3"],
1607
 
                                 mock_dbus_python.Boolean)
1608
 
 
1609
 
    def test_call_method_handles_exception(self):
 
1021
                self.check_option_syntax(options)
 
1022
 
 
1023
 
 
1024
class Test_get_mandos_dbus_object(TestCaseWithAssertLogs):
 
1025
    def test_calls_and_returns_get_object_on_bus(self):
 
1026
        class MockBus(object):
 
1027
            called = False
 
1028
            def get_object(mockbus_self, busname, dbus_path):
 
1029
                # Note that "self" is still the testcase instance,
 
1030
                # this MockBus instance is in "mockbus_self".
 
1031
                self.assertEqual(busname, dbus_busname)
 
1032
                self.assertEqual(dbus_path, server_dbus_path)
 
1033
                mockbus_self.called = True
 
1034
                return mockbus_self
 
1035
 
 
1036
        mockbus = get_mandos_dbus_object(bus=MockBus())
 
1037
        self.assertIsInstance(mockbus, MockBus)
 
1038
        self.assertTrue(mockbus.called)
 
1039
 
 
1040
    def test_logs_and_exits_on_dbus_error(self):
 
1041
        class MockBusFailing(object):
 
1042
            def get_object(self, busname, dbus_path):
 
1043
                raise dbus.exceptions.DBusException("Test")
 
1044
 
 
1045
        with self.assertLogs(log, logging.CRITICAL):
 
1046
            with self.assertRaises(SystemExit) as e:
 
1047
                bus = get_mandos_dbus_object(bus=MockBusFailing())
 
1048
 
 
1049
        if isinstance(e.exception.code, int):
 
1050
            self.assertNotEqual(e.exception.code, 0)
 
1051
        else:
 
1052
            self.assertIsNotNone(e.exception.code)
 
1053
 
 
1054
 
 
1055
class Test_get_managed_objects(TestCaseWithAssertLogs):
 
1056
    def test_calls_and_returns_GetManagedObjects(self):
 
1057
        managed_objects = {"/clients/foo": { "Name": "foo"}}
 
1058
        class MockObjectManager(object):
 
1059
            def GetManagedObjects(self):
 
1060
                return managed_objects
 
1061
        retval = get_managed_objects(MockObjectManager())
 
1062
        self.assertDictEqual(managed_objects, retval)
 
1063
 
 
1064
    def test_logs_and_exits_on_dbus_error(self):
1610
1065
        dbus_logger = logging.getLogger("dbus.proxies")
1611
1066
 
1612
 
        def func():
1613
 
            dbus_logger.error("Test")
1614
 
            raise mock_dbus_python.exceptions.DBusException()
1615
 
 
1616
 
        mock_dbus_python = self.MockDBusPython_func(func)
1617
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
 
1067
        class MockObjectManagerFailing(object):
 
1068
            def GetManagedObjects(self):
 
1069
                dbus_logger.error("Test")
 
1070
                raise dbus.exceptions.DBusException("Test")
1618
1071
 
1619
1072
        class CountingHandler(logging.Handler):
1620
1073
            count = 0
1626
1079
        dbus_logger.addHandler(counting_handler)
1627
1080
 
1628
1081
        try:
1629
 
            with self.assertRaises(dbus.Error) as e:
1630
 
                self.call_method(bus, "methodname", "busname",
1631
 
                                 "objectpath", "interface")
 
1082
            with self.assertLogs(log, logging.CRITICAL) as watcher:
 
1083
                with self.assertRaises(SystemExit) as e:
 
1084
                    get_managed_objects(MockObjectManagerFailing())
1632
1085
        finally:
1633
1086
            dbus_logger.removeFilter(counting_handler)
1634
1087
 
1635
 
        self.assertNotIsInstance(e.exception, dbus.ConnectFailed)
1636
 
 
1637
1088
        # Make sure the dbus logger was suppressed
1638
 
        self.assertEqual(0, counting_handler.count)
1639
 
 
1640
 
    def test_Set_Secret_sends_bytearray(self):
1641
 
        ret = [None]
1642
 
        def func(*args, **kwargs):
1643
 
            ret[0] = (args, kwargs)
1644
 
        mock_dbus_python = self.MockDBusPython_func(func)
1645
 
        bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1646
 
        bus.set_client_property("objectpath", "Secret", "value")
1647
 
        expected_call = (("se.recompile.Mandos.Client", "Secret",
1648
 
                          mock_dbus_python.ByteArray(b"value")),
1649
 
                         {"dbus_interface":
1650
 
                          "org.freedesktop.DBus.Properties"})
1651
 
        self.assertEqual(expected_call, ret[0])
1652
 
        if sys.version_info.major == 2:
1653
 
            self.assertIsInstance(ret[0][0][-1],
1654
 
                                  mock_dbus_python.ByteArray)
1655
 
 
1656
 
    def test_get_object_converts_to_correct_exception(self):
1657
 
        bus = dbus_python_adapter.SystemBus(
1658
 
            self.fake_dbus_python_raises_exception_on_connect)
1659
 
        with self.assertRaises(dbus.ConnectFailed):
1660
 
            self.call_method(bus, "methodname", "busname",
1661
 
                             "objectpath", "interface")
1662
 
 
1663
 
    class fake_dbus_python_raises_exception_on_connect:
1664
 
        """fake dbus-python module"""
1665
 
        class exceptions:
1666
 
            """Pseudo-namespace"""
1667
 
            class DBusException(Exception):
1668
 
                pass
1669
 
 
1670
 
        @classmethod
1671
 
        def SystemBus(cls):
1672
 
            def get_object(busname, objectpath):
1673
 
                raise cls.exceptions.DBusException()
1674
 
            Bus = collections.namedtuple("Bus", ["get_object"])
1675
 
            return Bus(get_object=get_object)
1676
 
 
1677
 
 
1678
 
class Test_dbus_python_adapter_CachingBus(unittest.TestCase):
1679
 
    class mock_dbus_python:
1680
 
        """mock dbus-python modules"""
1681
 
        class SystemBus:
1682
 
            @staticmethod
1683
 
            def get_object(busname, objectpath):
1684
 
                return Unique()
1685
 
 
1686
 
    def setUp(self):
1687
 
        self.bus = dbus_python_adapter.CachingBus(
1688
 
            self.mock_dbus_python)
1689
 
 
1690
 
    def test_returns_distinct_objectpaths(self):
1691
 
        obj1 = self.bus.get_object("busname", "objectpath1")
1692
 
        self.assertIsInstance(obj1, Unique)
1693
 
        obj2 = self.bus.get_object("busname", "objectpath2")
1694
 
        self.assertIsInstance(obj2, Unique)
1695
 
        self.assertIsNot(obj1, obj2)
1696
 
 
1697
 
    def test_returns_distinct_busnames(self):
1698
 
        obj1 = self.bus.get_object("busname1", "objectpath")
1699
 
        self.assertIsInstance(obj1, Unique)
1700
 
        obj2 = self.bus.get_object("busname2", "objectpath")
1701
 
        self.assertIsInstance(obj2, Unique)
1702
 
        self.assertIsNot(obj1, obj2)
1703
 
 
1704
 
    def test_returns_distinct_both(self):
1705
 
        obj1 = self.bus.get_object("busname1", "objectpath")
1706
 
        self.assertIsInstance(obj1, Unique)
1707
 
        obj2 = self.bus.get_object("busname2", "objectpath")
1708
 
        self.assertIsInstance(obj2, Unique)
1709
 
        self.assertIsNot(obj1, obj2)
1710
 
 
1711
 
    def test_returns_same(self):
1712
 
        obj1 = self.bus.get_object("busname", "objectpath")
1713
 
        self.assertIsInstance(obj1, Unique)
1714
 
        obj2 = self.bus.get_object("busname", "objectpath")
1715
 
        self.assertIsInstance(obj2, Unique)
1716
 
        self.assertIs(obj1, obj2)
1717
 
 
1718
 
    def test_returns_same_old(self):
1719
 
        obj1 = self.bus.get_object("busname1", "objectpath1")
1720
 
        self.assertIsInstance(obj1, Unique)
1721
 
        obj2 = self.bus.get_object("busname2", "objectpath2")
1722
 
        self.assertIsInstance(obj2, Unique)
1723
 
        obj1b = self.bus.get_object("busname1", "objectpath1")
1724
 
        self.assertIsInstance(obj1b, Unique)
1725
 
        self.assertIsNot(obj1, obj2)
1726
 
        self.assertIsNot(obj2, obj1b)
1727
 
        self.assertIs(obj1, obj1b)
1728
 
 
1729
 
 
1730
 
class Test_pydbus_adapter_SystemBus(TestCaseWithAssertLogs):
1731
 
 
1732
 
    def Stub_pydbus_func(self, func):
1733
 
        class stub_pydbus:
1734
 
            """stub pydbus module"""
1735
 
            class SystemBus:
1736
 
                @staticmethod
1737
 
                def get(busname, objectpath):
1738
 
                    DBusObject = collections.namedtuple(
1739
 
                        "DBusObject", ("methodname",))
1740
 
                    return {"interface":
1741
 
                            DBusObject(methodname=func)}
1742
 
        return stub_pydbus
1743
 
 
1744
 
    def call_method(self, bus, methodname, busname, objectpath,
1745
 
                    interface, *args):
1746
 
        with self.assertLogs(log, logging.DEBUG):
1747
 
            return bus.call_method(methodname, busname, objectpath,
1748
 
                                   interface, *args)
1749
 
 
1750
 
    def test_call_method_returns(self):
1751
 
        expected_method_return = Unique()
1752
 
        method_args = (Unique(), Unique())
1753
 
        def func(*args):
1754
 
            self.assertEqual(len(method_args), len(args))
1755
 
            for marg, arg in zip(method_args, args):
1756
 
                self.assertIs(marg, arg)
1757
 
            return expected_method_return
1758
 
        stub_pydbus = self.Stub_pydbus_func(func)
1759
 
        bus = pydbus_adapter.SystemBus(stub_pydbus)
1760
 
        ret = self.call_method(bus, "methodname", "busname",
1761
 
                               "objectpath", "interface",
1762
 
                               *method_args)
1763
 
        self.assertIs(ret, expected_method_return)
1764
 
 
1765
 
    def test_call_method_handles_exception(self):
1766
 
        dbus_logger = logging.getLogger("dbus.proxies")
1767
 
 
1768
 
        def func():
1769
 
            raise gi.repository.GLib.Error()
1770
 
 
1771
 
        stub_pydbus = self.Stub_pydbus_func(func)
1772
 
        bus = pydbus_adapter.SystemBus(stub_pydbus)
1773
 
 
1774
 
        with self.assertRaises(dbus.Error) as e:
1775
 
            self.call_method(bus, "methodname", "busname",
1776
 
                             "objectpath", "interface")
1777
 
 
1778
 
        self.assertNotIsInstance(e.exception, dbus.ConnectFailed)
1779
 
 
1780
 
    def test_get_converts_to_correct_exception(self):
1781
 
        bus = pydbus_adapter.SystemBus(
1782
 
            self.fake_pydbus_raises_exception_on_connect)
1783
 
        with self.assertRaises(dbus.ConnectFailed):
1784
 
            self.call_method(bus, "methodname", "busname",
1785
 
                             "objectpath", "interface")
1786
 
 
1787
 
    class fake_pydbus_raises_exception_on_connect:
1788
 
        """fake dbus-python module"""
1789
 
        @classmethod
1790
 
        def SystemBus(cls):
1791
 
            def get(busname, objectpath):
1792
 
                raise gi.repository.GLib.Error()
1793
 
            Bus = collections.namedtuple("Bus", ["get"])
1794
 
            return Bus(get=get)
1795
 
 
1796
 
    def test_set_property_uses_setattr(self):
1797
 
        class Object:
1798
 
            pass
1799
 
        obj = Object()
1800
 
        class pydbus_spy:
1801
 
            class SystemBus:
1802
 
                @staticmethod
1803
 
                def get(busname, objectpath):
1804
 
                    return {"interface": obj}
1805
 
        bus = pydbus_adapter.SystemBus(pydbus_spy)
1806
 
        value = Unique()
1807
 
        bus.set_property("busname", "objectpath", "interface", "key",
1808
 
                         value)
1809
 
        self.assertIs(value, obj.key)
1810
 
 
1811
 
    def test_get_suppresses_xml_deprecation_warning(self):
1812
 
        if sys.version_info.major >= 3:
1813
 
            return
1814
 
        class stub_pydbus_get:
1815
 
            class SystemBus:
1816
 
                @staticmethod
1817
 
                def get(busname, objectpath):
1818
 
                    warnings.warn_explicit(
1819
 
                        "deprecated", DeprecationWarning,
1820
 
                        "xml.etree.ElementTree", 0)
1821
 
        bus = pydbus_adapter.SystemBus(stub_pydbus_get)
1822
 
        with warnings.catch_warnings(record=True) as w:
1823
 
            warnings.simplefilter("always")
1824
 
            bus.get("busname", "objectpath")
1825
 
            self.assertEqual(0, len(w))
1826
 
 
1827
 
 
1828
 
class Test_pydbus_adapter_CachingBus(unittest.TestCase):
1829
 
    class stub_pydbus:
1830
 
        """stub pydbus module"""
1831
 
        class SystemBus:
1832
 
            @staticmethod
1833
 
            def get(busname, objectpath):
1834
 
                return Unique()
1835
 
 
1836
 
    def setUp(self):
1837
 
        self.bus = pydbus_adapter.CachingBus(self.stub_pydbus)
1838
 
 
1839
 
    def test_returns_distinct_objectpaths(self):
1840
 
        obj1 = self.bus.get("busname", "objectpath1")
1841
 
        self.assertIsInstance(obj1, Unique)
1842
 
        obj2 = self.bus.get("busname", "objectpath2")
1843
 
        self.assertIsInstance(obj2, Unique)
1844
 
        self.assertIsNot(obj1, obj2)
1845
 
 
1846
 
    def test_returns_distinct_busnames(self):
1847
 
        obj1 = self.bus.get("busname1", "objectpath")
1848
 
        self.assertIsInstance(obj1, Unique)
1849
 
        obj2 = self.bus.get("busname2", "objectpath")
1850
 
        self.assertIsInstance(obj2, Unique)
1851
 
        self.assertIsNot(obj1, obj2)
1852
 
 
1853
 
    def test_returns_distinct_both(self):
1854
 
        obj1 = self.bus.get("busname1", "objectpath")
1855
 
        self.assertIsInstance(obj1, Unique)
1856
 
        obj2 = self.bus.get("busname2", "objectpath")
1857
 
        self.assertIsInstance(obj2, Unique)
1858
 
        self.assertIsNot(obj1, obj2)
1859
 
 
1860
 
    def test_returns_same(self):
1861
 
        obj1 = self.bus.get("busname", "objectpath")
1862
 
        self.assertIsInstance(obj1, Unique)
1863
 
        obj2 = self.bus.get("busname", "objectpath")
1864
 
        self.assertIsInstance(obj2, Unique)
1865
 
        self.assertIs(obj1, obj2)
1866
 
 
1867
 
    def test_returns_same_old(self):
1868
 
        obj1 = self.bus.get("busname1", "objectpath1")
1869
 
        self.assertIsInstance(obj1, Unique)
1870
 
        obj2 = self.bus.get("busname2", "objectpath2")
1871
 
        self.assertIsInstance(obj2, Unique)
1872
 
        obj1b = self.bus.get("busname1", "objectpath1")
1873
 
        self.assertIsInstance(obj1b, Unique)
1874
 
        self.assertIsNot(obj1, obj2)
1875
 
        self.assertIsNot(obj2, obj1b)
1876
 
        self.assertIs(obj1, obj1b)
1877
 
 
1878
 
 
1879
 
class Test_dbussy_adapter_SystemBus(TestCaseWithAssertLogs):
1880
 
 
1881
 
    class dummy_dbussy:
1882
 
        class DBUS:
1883
 
            class ObjectPath(str):
1884
 
                pass
1885
 
        class DBusError(Exception):
1886
 
            pass
1887
 
 
1888
 
    def fake_ravel_func(self, func):
1889
 
        class fake_ravel:
1890
 
            @staticmethod
1891
 
            def system_bus():
1892
 
                class DBusInterfaceProxy:
1893
 
                    @staticmethod
1894
 
                    def methodname(*args):
1895
 
                        return [func(*args)]
1896
 
                class DBusObject:
1897
 
                    @staticmethod
1898
 
                    def get_interface(interface):
1899
 
                        if interface == "interface":
1900
 
                            return DBusInterfaceProxy()
1901
 
                return {"busname": {"objectpath": DBusObject()}}
1902
 
        return fake_ravel
1903
 
 
1904
 
    def call_method(self, bus, methodname, busname, objectpath,
1905
 
                    interface, *args):
1906
 
        with self.assertLogs(log, logging.DEBUG):
1907
 
            return bus.call_method(methodname, busname, objectpath,
1908
 
                                   interface, *args)
1909
 
 
1910
 
    def test_call_method_returns(self):
1911
 
        expected_method_return = Unique()
1912
 
        method_args = (Unique(), Unique())
1913
 
        def func(*args):
1914
 
            self.assertEqual(len(method_args), len(args))
1915
 
            for marg, arg in zip(method_args, args):
1916
 
                self.assertIs(marg, arg)
1917
 
            return expected_method_return
1918
 
        fake_ravel = self.fake_ravel_func(func)
1919
 
        bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
1920
 
        ret = self.call_method(bus, "methodname", "busname",
1921
 
                               "objectpath", "interface",
1922
 
                               *method_args)
1923
 
        self.assertIs(ret, expected_method_return)
1924
 
 
1925
 
    def test_call_method_filters_objectpath(self):
1926
 
        def func():
1927
 
            return method_return
1928
 
        fake_ravel = self.fake_ravel_func(func)
1929
 
        bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
1930
 
        method_return = (self.dummy_dbussy.DBUS
1931
 
                         .ObjectPath("objectpath"))
1932
 
        ret = self.call_method(bus, "methodname", "busname",
1933
 
                               "objectpath", "interface")
1934
 
        self.assertEqual("objectpath", ret)
1935
 
        self.assertNotIsInstance(ret,
1936
 
                                 self.dummy_dbussy.DBUS.ObjectPath)
1937
 
 
1938
 
    def test_call_method_filters_objectpaths_in_dict(self):
1939
 
        ObjectPath = self.dummy_dbussy.DBUS.ObjectPath
1940
 
        def func():
1941
 
            return method_return
1942
 
        fake_ravel = self.fake_ravel_func(func)
1943
 
        bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
1944
 
        method_return = {
1945
 
            ObjectPath("objectpath_key_1"):
1946
 
            ObjectPath("objectpath_value_1"),
1947
 
            ObjectPath("objectpath_key_2"):
1948
 
            ObjectPath("objectpath_value_2"),
1949
 
        }
1950
 
        ret = self.call_method(bus, "methodname", "busname",
1951
 
                               "objectpath", "interface")
1952
 
        expected_method_return = {str(key): str(value)
1953
 
                                  for key, value in
1954
 
                                  method_return.items()}
1955
 
        for key, value in ret.items():
1956
 
            self.assertNotIsInstance(key, ObjectPath)
1957
 
            self.assertNotIsInstance(value, ObjectPath)
1958
 
        self.assertEqual(expected_method_return, ret)
1959
 
        self.assertIsInstance(ret, dict)
1960
 
 
1961
 
    def test_call_method_filters_objectpaths_in_dict_in_dict(self):
1962
 
        ObjectPath = self.dummy_dbussy.DBUS.ObjectPath
1963
 
        def func():
1964
 
            return method_return
1965
 
        fake_ravel = self.fake_ravel_func(func)
1966
 
        bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
1967
 
        method_return = {
1968
 
            ObjectPath("key1"): {
1969
 
                ObjectPath("key11"): ObjectPath("value11"),
1970
 
                ObjectPath("key12"): ObjectPath("value12"),
1971
 
            },
1972
 
            ObjectPath("key2"): {
1973
 
                ObjectPath("key21"): ObjectPath("value21"),
1974
 
                ObjectPath("key22"): ObjectPath("value22"),
1975
 
            },
1976
 
        }
1977
 
        ret = self.call_method(bus, "methodname", "busname",
1978
 
                               "objectpath", "interface")
1979
 
        expected_method_return = {
1980
 
            "key1": {"key11": "value11",
1981
 
                     "key12": "value12"},
1982
 
            "key2": {"key21": "value21",
1983
 
                     "key22": "value22"},
1984
 
        }
1985
 
        self.assertEqual(expected_method_return, ret)
1986
 
        for key, value in ret.items():
1987
 
            self.assertIsInstance(value, dict)
1988
 
            self.assertEqual(expected_method_return[key], value)
1989
 
            self.assertNotIsInstance(key, ObjectPath)
1990
 
            for inner_key, inner_value in value.items():
1991
 
                self.assertIsInstance(value, dict)
1992
 
                self.assertEqual(
1993
 
                    expected_method_return[key][inner_key],
1994
 
                    inner_value)
1995
 
                self.assertNotIsInstance(key, ObjectPath)
1996
 
 
1997
 
    def test_call_method_filters_objectpaths_in_dict_three_deep(self):
1998
 
        ObjectPath = self.dummy_dbussy.DBUS.ObjectPath
1999
 
        def func():
2000
 
            return method_return
2001
 
        fake_ravel = self.fake_ravel_func(func)
2002
 
        bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
2003
 
        method_return = {
2004
 
            ObjectPath("key1"): {
2005
 
                ObjectPath("key2"): {
2006
 
                    ObjectPath("key3"): ObjectPath("value"),
2007
 
                },
2008
 
            },
2009
 
        }
2010
 
        ret = self.call_method(bus, "methodname", "busname",
2011
 
                               "objectpath", "interface")
2012
 
        expected_method_return = {"key1": {"key2": {"key3": "value"}}}
2013
 
        self.assertEqual(expected_method_return, ret)
2014
 
        self.assertIsInstance(ret, dict)
2015
 
        self.assertNotIsInstance(next(iter(ret.keys())), ObjectPath)
2016
 
        self.assertIsInstance(ret["key1"], dict)
2017
 
        self.assertNotIsInstance(next(iter(ret["key1"].keys())),
2018
 
                                 ObjectPath)
2019
 
        self.assertIsInstance(ret["key1"]["key2"], dict)
2020
 
        self.assertNotIsInstance(
2021
 
            next(iter(ret["key1"]["key2"].keys())),
2022
 
            ObjectPath)
2023
 
        self.assertEqual("value", ret["key1"]["key2"]["key3"])
2024
 
        self.assertNotIsInstance(ret["key1"]["key2"]["key3"],
2025
 
                                 self.dummy_dbussy.DBUS.ObjectPath)
2026
 
 
2027
 
    def test_call_method_handles_exception(self):
2028
 
        def func():
2029
 
            raise self.dummy_dbussy.DBusError()
2030
 
 
2031
 
        fake_ravel = self.fake_ravel_func(func)
2032
 
        bus = dbussy_adapter.SystemBus(self.dummy_dbussy, fake_ravel)
2033
 
 
2034
 
        with self.assertRaises(dbus.Error) as e:
2035
 
            self.call_method(bus, "methodname", "busname",
2036
 
                             "objectpath", "interface")
2037
 
 
2038
 
        self.assertNotIsInstance(e.exception, dbus.ConnectFailed)
2039
 
 
2040
 
    def test_get_object_converts_to_correct_exception(self):
2041
 
        class fake_ravel_raises_exception_on_connect:
2042
 
            @staticmethod
2043
 
            def system_bus():
2044
 
                class Bus:
2045
 
                    @staticmethod
2046
 
                    def __getitem__(key):
2047
 
                        if key == "objectpath":
2048
 
                            raise self.dummy_dbussy.DBusError()
2049
 
                        raise Exception(key)
2050
 
                return {"busname": Bus()}
2051
 
        def func():
2052
 
            raise self.dummy_dbussy.DBusError()
2053
 
        bus = dbussy_adapter.SystemBus(
2054
 
            self.dummy_dbussy,
2055
 
            fake_ravel_raises_exception_on_connect)
2056
 
        with self.assertRaises(dbus.ConnectFailed):
2057
 
            self.call_method(bus, "methodname", "busname",
2058
 
                             "objectpath", "interface")
 
1089
        self.assertEqual(counting_handler.count, 0)
 
1090
 
 
1091
        # Test that the dbus_logger still works
 
1092
        with self.assertLogs(dbus_logger, logging.ERROR):
 
1093
            dbus_logger.error("Test")
 
1094
 
 
1095
        if isinstance(e.exception.code, int):
 
1096
            self.assertNotEqual(e.exception.code, 0)
 
1097
        else:
 
1098
            self.assertIsNotNone(e.exception.code)
2059
1099
 
2060
1100
 
2061
1101
class Test_commands_from_options(unittest.TestCase):
2062
 
 
2063
1102
    def setUp(self):
2064
1103
        self.parser = argparse.ArgumentParser()
2065
1104
        add_command_line_options(self.parser)
2066
1105
 
2067
1106
    def test_is_enabled(self):
2068
 
        self.assert_command_from_args(["--is-enabled", "client"],
2069
 
                                      command.IsEnabled)
 
1107
        self.assert_command_from_args(["--is-enabled", "foo"],
 
1108
                                      IsEnabledCmd)
2070
1109
 
2071
 
    def assert_command_from_args(self, args, command_cls, length=1,
2072
 
                                 clients=None, **cmd_attrs):
 
1110
    def assert_command_from_args(self, args, command_cls,
 
1111
                                 **cmd_attrs):
2073
1112
        """Assert that parsing ARGS should result in an instance of
2074
1113
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
2075
1114
        options = self.parser.parse_args(args)
2076
1115
        check_option_syntax(self.parser, options)
2077
1116
        commands = commands_from_options(options)
2078
 
        self.assertEqual(length, len(commands))
2079
 
        for command in commands:
2080
 
            if isinstance(command, command_cls):
2081
 
                break
2082
 
        else:
2083
 
            self.assertIsInstance(command, command_cls)
2084
 
        if clients is not None:
2085
 
            self.assertEqual(clients, options.client)
 
1117
        self.assertEqual(len(commands), 1)
 
1118
        command = commands[0]
 
1119
        self.assertIsInstance(command, command_cls)
2086
1120
        for key, value in cmd_attrs.items():
2087
 
            self.assertEqual(value, getattr(command, key))
2088
 
 
2089
 
    def assert_commands_from_args(self, args, commands, clients=None):
2090
 
        for cmd in commands:
2091
 
            self.assert_command_from_args(args, cmd,
2092
 
                                          length=len(commands),
2093
 
                                          clients=clients)
 
1121
            self.assertEqual(getattr(command, key), value)
2094
1122
 
2095
1123
    def test_is_enabled_short(self):
2096
 
        self.assert_command_from_args(["-V", "client"],
2097
 
                                      command.IsEnabled)
 
1124
        self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
2098
1125
 
2099
1126
    def test_approve(self):
2100
 
        self.assert_command_from_args(["--approve", "client"],
2101
 
                                      command.Approve)
 
1127
        self.assert_command_from_args(["--approve", "foo"],
 
1128
                                      ApproveCmd)
2102
1129
 
2103
1130
    def test_approve_short(self):
2104
 
        self.assert_command_from_args(["-A", "client"],
2105
 
                                      command.Approve)
 
1131
        self.assert_command_from_args(["-A", "foo"], ApproveCmd)
2106
1132
 
2107
1133
    def test_deny(self):
2108
 
        self.assert_command_from_args(["--deny", "client"],
2109
 
                                      command.Deny)
 
1134
        self.assert_command_from_args(["--deny", "foo"], DenyCmd)
2110
1135
 
2111
1136
    def test_deny_short(self):
2112
 
        self.assert_command_from_args(["-D", "client"], command.Deny)
 
1137
        self.assert_command_from_args(["-D", "foo"], DenyCmd)
2113
1138
 
2114
1139
    def test_remove(self):
2115
 
        self.assert_command_from_args(["--remove", "client"],
2116
 
                                      command.Remove)
 
1140
        self.assert_command_from_args(["--remove", "foo"],
 
1141
                                      RemoveCmd)
2117
1142
 
2118
1143
    def test_deny_before_remove(self):
2119
1144
        options = self.parser.parse_args(["--deny", "--remove",
2120
 
                                          "client"])
 
1145
                                          "foo"])
2121
1146
        check_option_syntax(self.parser, options)
2122
1147
        commands = commands_from_options(options)
2123
 
        self.assertEqual(2, len(commands))
2124
 
        self.assertIsInstance(commands[0], command.Deny)
2125
 
        self.assertIsInstance(commands[1], command.Remove)
 
1148
        self.assertEqual(len(commands), 2)
 
1149
        self.assertIsInstance(commands[0], DenyCmd)
 
1150
        self.assertIsInstance(commands[1], RemoveCmd)
2126
1151
 
2127
1152
    def test_deny_before_remove_reversed(self):
2128
1153
        options = self.parser.parse_args(["--remove", "--deny",
2129
1154
                                          "--all"])
2130
1155
        check_option_syntax(self.parser, options)
2131
1156
        commands = commands_from_options(options)
2132
 
        self.assertEqual(2, len(commands))
2133
 
        self.assertIsInstance(commands[0], command.Deny)
2134
 
        self.assertIsInstance(commands[1], command.Remove)
 
1157
        self.assertEqual(len(commands), 2)
 
1158
        self.assertIsInstance(commands[0], DenyCmd)
 
1159
        self.assertIsInstance(commands[1], RemoveCmd)
2135
1160
 
2136
1161
    def test_remove_short(self):
2137
 
        self.assert_command_from_args(["-r", "client"],
2138
 
                                      command.Remove)
 
1162
        self.assert_command_from_args(["-r", "foo"], RemoveCmd)
2139
1163
 
2140
1164
    def test_dump_json(self):
2141
 
        self.assert_command_from_args(["--dump-json"],
2142
 
                                      command.DumpJSON)
 
1165
        self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
2143
1166
 
2144
1167
    def test_enable(self):
2145
 
        self.assert_command_from_args(["--enable", "client"],
2146
 
                                      command.Enable)
 
1168
        self.assert_command_from_args(["--enable", "foo"], EnableCmd)
2147
1169
 
2148
1170
    def test_enable_short(self):
2149
 
        self.assert_command_from_args(["-e", "client"],
2150
 
                                      command.Enable)
 
1171
        self.assert_command_from_args(["-e", "foo"], EnableCmd)
2151
1172
 
2152
1173
    def test_disable(self):
2153
 
        self.assert_command_from_args(["--disable", "client"],
2154
 
                                      command.Disable)
 
1174
        self.assert_command_from_args(["--disable", "foo"],
 
1175
                                      DisableCmd)
2155
1176
 
2156
1177
    def test_disable_short(self):
2157
 
        self.assert_command_from_args(["-d", "client"],
2158
 
                                      command.Disable)
 
1178
        self.assert_command_from_args(["-d", "foo"], DisableCmd)
2159
1179
 
2160
1180
    def test_bump_timeout(self):
2161
 
        self.assert_command_from_args(["--bump-timeout", "client"],
2162
 
                                      command.BumpTimeout)
 
1181
        self.assert_command_from_args(["--bump-timeout", "foo"],
 
1182
                                      BumpTimeoutCmd)
2163
1183
 
2164
1184
    def test_bump_timeout_short(self):
2165
 
        self.assert_command_from_args(["-b", "client"],
2166
 
                                      command.BumpTimeout)
 
1185
        self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
2167
1186
 
2168
1187
    def test_start_checker(self):
2169
 
        self.assert_command_from_args(["--start-checker", "client"],
2170
 
                                      command.StartChecker)
 
1188
        self.assert_command_from_args(["--start-checker", "foo"],
 
1189
                                      StartCheckerCmd)
2171
1190
 
2172
1191
    def test_stop_checker(self):
2173
 
        self.assert_command_from_args(["--stop-checker", "client"],
2174
 
                                      command.StopChecker)
 
1192
        self.assert_command_from_args(["--stop-checker", "foo"],
 
1193
                                      StopCheckerCmd)
2175
1194
 
2176
1195
    def test_approve_by_default(self):
2177
 
        self.assert_command_from_args(["--approve-by-default",
2178
 
                                       "client"],
2179
 
                                      command.ApproveByDefault)
 
1196
        self.assert_command_from_args(["--approve-by-default", "foo"],
 
1197
                                      ApproveByDefaultCmd)
2180
1198
 
2181
1199
    def test_deny_by_default(self):
2182
 
        self.assert_command_from_args(["--deny-by-default", "client"],
2183
 
                                      command.DenyByDefault)
 
1200
        self.assert_command_from_args(["--deny-by-default", "foo"],
 
1201
                                      DenyByDefaultCmd)
2184
1202
 
2185
1203
    def test_checker(self):
2186
 
        self.assert_command_from_args(["--checker", ":", "client"],
2187
 
                                      command.SetChecker,
2188
 
                                      value_to_set=":")
 
1204
        self.assert_command_from_args(["--checker", ":", "foo"],
 
1205
                                      SetCheckerCmd, value_to_set=":")
2189
1206
 
2190
1207
    def test_checker_empty(self):
2191
 
        self.assert_command_from_args(["--checker", "", "client"],
2192
 
                                      command.SetChecker,
2193
 
                                      value_to_set="")
 
1208
        self.assert_command_from_args(["--checker", "", "foo"],
 
1209
                                      SetCheckerCmd, value_to_set="")
2194
1210
 
2195
1211
    def test_checker_short(self):
2196
 
        self.assert_command_from_args(["-c", ":", "client"],
2197
 
                                      command.SetChecker,
2198
 
                                      value_to_set=":")
 
1212
        self.assert_command_from_args(["-c", ":", "foo"],
 
1213
                                      SetCheckerCmd, value_to_set=":")
2199
1214
 
2200
1215
    def test_host(self):
2201
 
        self.assert_command_from_args(
2202
 
            ["--host", "client.example.org", "client"],
2203
 
            command.SetHost, value_to_set="client.example.org")
 
1216
        self.assert_command_from_args(["--host", "foo.example.org",
 
1217
                                       "foo"], SetHostCmd,
 
1218
                                      value_to_set="foo.example.org")
2204
1219
 
2205
1220
    def test_host_short(self):
2206
 
        self.assert_command_from_args(
2207
 
            ["-H", "client.example.org", "client"], command.SetHost,
2208
 
            value_to_set="client.example.org")
 
1221
        self.assert_command_from_args(["-H", "foo.example.org",
 
1222
                                       "foo"], SetHostCmd,
 
1223
                                      value_to_set="foo.example.org")
2209
1224
 
2210
1225
    def test_secret_devnull(self):
2211
1226
        self.assert_command_from_args(["--secret", os.path.devnull,
2212
 
                                       "client"], command.SetSecret,
 
1227
                                       "foo"], SetSecretCmd,
2213
1228
                                      value_to_set=b"")
2214
1229
 
2215
1230
    def test_secret_tempfile(self):
2218
1233
            f.write(value)
2219
1234
            f.seek(0)
2220
1235
            self.assert_command_from_args(["--secret", f.name,
2221
 
                                           "client"],
2222
 
                                          command.SetSecret,
 
1236
                                           "foo"], SetSecretCmd,
2223
1237
                                          value_to_set=value)
2224
1238
 
2225
1239
    def test_secret_devnull_short(self):
2226
 
        self.assert_command_from_args(["-s", os.path.devnull,
2227
 
                                       "client"], command.SetSecret,
2228
 
                                      value_to_set=b"")
 
1240
        self.assert_command_from_args(["-s", os.path.devnull, "foo"],
 
1241
                                      SetSecretCmd, value_to_set=b"")
2229
1242
 
2230
1243
    def test_secret_tempfile_short(self):
2231
1244
        with tempfile.NamedTemporaryFile(mode="r+b") as f:
2232
1245
            value = b"secret\0xyzzy\nbar"
2233
1246
            f.write(value)
2234
1247
            f.seek(0)
2235
 
            self.assert_command_from_args(["-s", f.name, "client"],
2236
 
                                          command.SetSecret,
 
1248
            self.assert_command_from_args(["-s", f.name, "foo"],
 
1249
                                          SetSecretCmd,
2237
1250
                                          value_to_set=value)
2238
1251
 
2239
1252
    def test_timeout(self):
2240
 
        self.assert_command_from_args(["--timeout", "PT5M", "client"],
2241
 
                                      command.SetTimeout,
 
1253
        self.assert_command_from_args(["--timeout", "PT5M", "foo"],
 
1254
                                      SetTimeoutCmd,
2242
1255
                                      value_to_set=300000)
2243
1256
 
2244
1257
    def test_timeout_short(self):
2245
 
        self.assert_command_from_args(["-t", "PT5M", "client"],
2246
 
                                      command.SetTimeout,
 
1258
        self.assert_command_from_args(["-t", "PT5M", "foo"],
 
1259
                                      SetTimeoutCmd,
2247
1260
                                      value_to_set=300000)
2248
1261
 
2249
1262
    def test_extended_timeout(self):
2250
1263
        self.assert_command_from_args(["--extended-timeout", "PT15M",
2251
 
                                       "client"],
2252
 
                                      command.SetExtendedTimeout,
 
1264
                                       "foo"],
 
1265
                                      SetExtendedTimeoutCmd,
2253
1266
                                      value_to_set=900000)
2254
1267
 
2255
1268
    def test_interval(self):
2256
 
        self.assert_command_from_args(["--interval", "PT2M",
2257
 
                                       "client"], command.SetInterval,
 
1269
        self.assert_command_from_args(["--interval", "PT2M", "foo"],
 
1270
                                      SetIntervalCmd,
2258
1271
                                      value_to_set=120000)
2259
1272
 
2260
1273
    def test_interval_short(self):
2261
 
        self.assert_command_from_args(["-i", "PT2M", "client"],
2262
 
                                      command.SetInterval,
 
1274
        self.assert_command_from_args(["-i", "PT2M", "foo"],
 
1275
                                      SetIntervalCmd,
2263
1276
                                      value_to_set=120000)
2264
1277
 
2265
1278
    def test_approval_delay(self):
2266
1279
        self.assert_command_from_args(["--approval-delay", "PT30S",
2267
 
                                       "client"],
2268
 
                                      command.SetApprovalDelay,
 
1280
                                       "foo"], SetApprovalDelayCmd,
2269
1281
                                      value_to_set=30000)
2270
1282
 
2271
1283
    def test_approval_duration(self):
2272
1284
        self.assert_command_from_args(["--approval-duration", "PT1S",
2273
 
                                       "client"],
2274
 
                                      command.SetApprovalDuration,
 
1285
                                       "foo"], SetApprovalDurationCmd,
2275
1286
                                      value_to_set=1000)
2276
1287
 
2277
1288
    def test_print_table(self):
2278
 
        self.assert_command_from_args([], command.PrintTable,
 
1289
        self.assert_command_from_args([], PrintTableCmd,
2279
1290
                                      verbose=False)
2280
1291
 
2281
1292
    def test_print_table_verbose(self):
2282
 
        self.assert_command_from_args(["--verbose"],
2283
 
                                      command.PrintTable,
 
1293
        self.assert_command_from_args(["--verbose"], PrintTableCmd,
2284
1294
                                      verbose=True)
2285
1295
 
2286
1296
    def test_print_table_verbose_short(self):
2287
 
        self.assert_command_from_args(["-v"], command.PrintTable,
 
1297
        self.assert_command_from_args(["-v"], PrintTableCmd,
2288
1298
                                      verbose=True)
2289
1299
 
2290
1300
 
2291
 
    def test_manual_page_example_1(self):
2292
 
        self.assert_command_from_args("",
2293
 
                                      command.PrintTable,
2294
 
                                      clients=[],
2295
 
                                      verbose=False)
2296
 
 
2297
 
    def test_manual_page_example_2(self):
2298
 
        self.assert_command_from_args(
2299
 
            "--verbose foo1.example.org foo2.example.org".split(),
2300
 
            command.PrintTable, clients=["foo1.example.org",
2301
 
                                         "foo2.example.org"],
2302
 
            verbose=True)
2303
 
 
2304
 
    def test_manual_page_example_3(self):
2305
 
        self.assert_command_from_args("--enable --all".split(),
2306
 
                                      command.Enable,
2307
 
                                      clients=[])
2308
 
 
2309
 
    def test_manual_page_example_4(self):
2310
 
        self.assert_commands_from_args(
2311
 
            ("--timeout=PT5M --interval=PT1M foo1.example.org"
2312
 
             " foo2.example.org").split(),
2313
 
            [command.SetTimeout, command.SetInterval],
2314
 
            clients=["foo1.example.org", "foo2.example.org"])
2315
 
 
2316
 
    def test_manual_page_example_5(self):
2317
 
        self.assert_command_from_args("--approve --all".split(),
2318
 
                                      command.Approve,
2319
 
                                      clients=[])
2320
 
 
2321
 
 
2322
 
class TestCommand(unittest.TestCase):
 
1301
class TestCmd(unittest.TestCase):
2323
1302
    """Abstract class for tests of command classes"""
2324
1303
 
2325
 
    class FakeMandosBus(dbus.MandosBus):
2326
 
        def __init__(self, testcase):
2327
 
            self.client_properties = {
 
1304
    def setUp(self):
 
1305
        testcase = self
 
1306
        class MockClient(object):
 
1307
            def __init__(self, name, **attributes):
 
1308
                self.__dbus_object_path__ = "/clients/{}".format(name)
 
1309
                self.attributes = attributes
 
1310
                self.attributes["Name"] = name
 
1311
                self.calls = []
 
1312
            def Set(self, interface, propname, value, dbus_interface):
 
1313
                testcase.assertEqual(interface, client_dbus_interface)
 
1314
                testcase.assertEqual(dbus_interface,
 
1315
                                     dbus.PROPERTIES_IFACE)
 
1316
                self.attributes[propname] = value
 
1317
            def Get(self, interface, propname, dbus_interface):
 
1318
                testcase.assertEqual(interface, client_dbus_interface)
 
1319
                testcase.assertEqual(dbus_interface,
 
1320
                                     dbus.PROPERTIES_IFACE)
 
1321
                return self.attributes[propname]
 
1322
            def Approve(self, approve, dbus_interface):
 
1323
                testcase.assertEqual(dbus_interface,
 
1324
                                     client_dbus_interface)
 
1325
                self.calls.append(("Approve", (approve,
 
1326
                                               dbus_interface)))
 
1327
        self.client = MockClient(
 
1328
            "foo",
 
1329
            KeyID=("92ed150794387c03ce684574b1139a65"
 
1330
                   "94a34f895daaaf09fd8ea90a27cddb12"),
 
1331
            Secret=b"secret",
 
1332
            Host="foo.example.org",
 
1333
            Enabled=dbus.Boolean(True),
 
1334
            Timeout=300000,
 
1335
            LastCheckedOK="2019-02-03T00:00:00",
 
1336
            Created="2019-01-02T00:00:00",
 
1337
            Interval=120000,
 
1338
            Fingerprint=("778827225BA7DE539C5A"
 
1339
                         "7CFA59CFF7CDBD9A5920"),
 
1340
            CheckerRunning=dbus.Boolean(False),
 
1341
            LastEnabled="2019-01-03T00:00:00",
 
1342
            ApprovalPending=dbus.Boolean(False),
 
1343
            ApprovedByDefault=dbus.Boolean(True),
 
1344
            LastApprovalRequest="",
 
1345
            ApprovalDelay=0,
 
1346
            ApprovalDuration=1000,
 
1347
            Checker="fping -q -- %(host)s",
 
1348
            ExtendedTimeout=900000,
 
1349
            Expires="2019-02-04T00:00:00",
 
1350
            LastCheckerStatus=0)
 
1351
        self.other_client = MockClient(
 
1352
            "barbar",
 
1353
            KeyID=("0558568eedd67d622f5c83b35a115f79"
 
1354
                   "6ab612cff5ad227247e46c2b020f441c"),
 
1355
            Secret=b"secretbar",
 
1356
            Host="192.0.2.3",
 
1357
            Enabled=dbus.Boolean(True),
 
1358
            Timeout=300000,
 
1359
            LastCheckedOK="2019-02-04T00:00:00",
 
1360
            Created="2019-01-03T00:00:00",
 
1361
            Interval=120000,
 
1362
            Fingerprint=("3E393AEAEFB84C7E89E2"
 
1363
                         "F547B3A107558FCA3A27"),
 
1364
            CheckerRunning=dbus.Boolean(True),
 
1365
            LastEnabled="2019-01-04T00:00:00",
 
1366
            ApprovalPending=dbus.Boolean(False),
 
1367
            ApprovedByDefault=dbus.Boolean(False),
 
1368
            LastApprovalRequest="2019-01-03T00:00:00",
 
1369
            ApprovalDelay=30000,
 
1370
            ApprovalDuration=93785000,
 
1371
            Checker=":",
 
1372
            ExtendedTimeout=900000,
 
1373
            Expires="2019-02-05T00:00:00",
 
1374
            LastCheckerStatus=-2)
 
1375
        self.clients =  collections.OrderedDict(
 
1376
            [
 
1377
                ("/clients/foo", self.client.attributes),
 
1378
                ("/clients/barbar", self.other_client.attributes),
 
1379
            ])
 
1380
        self.one_client = {"/clients/foo": self.client.attributes}
 
1381
 
 
1382
    @property
 
1383
    def bus(self):
 
1384
        class Bus(object):
 
1385
            @staticmethod
 
1386
            def get_object(client_bus_name, path):
 
1387
                self.assertEqual(client_bus_name, dbus_busname)
 
1388
                return {
 
1389
                    # Note: "self" here is the TestCmd instance, not
 
1390
                    # the Bus instance, since this is a static method!
 
1391
                    "/clients/foo": self.client,
 
1392
                    "/clients/barbar": self.other_client,
 
1393
                }[path]
 
1394
        return Bus()
 
1395
 
 
1396
 
 
1397
class TestIsEnabledCmd(TestCmd):
 
1398
    def test_is_enabled(self):
 
1399
        self.assertTrue(all(IsEnabledCmd().is_enabled(client,
 
1400
                                                      properties)
 
1401
                            for client, properties
 
1402
                            in self.clients.items()))
 
1403
 
 
1404
    def test_is_enabled_run_exits_successfully(self):
 
1405
        with self.assertRaises(SystemExit) as e:
 
1406
            IsEnabledCmd().run(self.one_client)
 
1407
        if e.exception.code is not None:
 
1408
            self.assertEqual(e.exception.code, 0)
 
1409
        else:
 
1410
            self.assertIsNone(e.exception.code)
 
1411
 
 
1412
    def test_is_enabled_run_exits_with_failure(self):
 
1413
        self.client.attributes["Enabled"] = dbus.Boolean(False)
 
1414
        with self.assertRaises(SystemExit) as e:
 
1415
            IsEnabledCmd().run(self.one_client)
 
1416
        if isinstance(e.exception.code, int):
 
1417
            self.assertNotEqual(e.exception.code, 0)
 
1418
        else:
 
1419
            self.assertIsNotNone(e.exception.code)
 
1420
 
 
1421
 
 
1422
class TestApproveCmd(TestCmd):
 
1423
    def test_approve(self):
 
1424
        ApproveCmd().run(self.clients, self.bus)
 
1425
        for clientpath in self.clients:
 
1426
            client = self.bus.get_object(dbus_busname, clientpath)
 
1427
            self.assertIn(("Approve", (True, client_dbus_interface)),
 
1428
                          client.calls)
 
1429
 
 
1430
 
 
1431
class TestDenyCmd(TestCmd):
 
1432
    def test_deny(self):
 
1433
        DenyCmd().run(self.clients, self.bus)
 
1434
        for clientpath in self.clients:
 
1435
            client = self.bus.get_object(dbus_busname, clientpath)
 
1436
            self.assertIn(("Approve", (False, client_dbus_interface)),
 
1437
                          client.calls)
 
1438
 
 
1439
 
 
1440
class TestRemoveCmd(TestCmd):
 
1441
    def test_remove(self):
 
1442
        class MockMandos(object):
 
1443
            def __init__(self):
 
1444
                self.calls = []
 
1445
            def RemoveClient(self, dbus_path):
 
1446
                self.calls.append(("RemoveClient", (dbus_path,)))
 
1447
        mandos = MockMandos()
 
1448
        super(TestRemoveCmd, self).setUp()
 
1449
        RemoveCmd().run(self.clients, self.bus, mandos)
 
1450
        self.assertEqual(len(mandos.calls), 2)
 
1451
        for clientpath in self.clients:
 
1452
            self.assertIn(("RemoveClient", (clientpath,)),
 
1453
                          mandos.calls)
 
1454
 
 
1455
 
 
1456
class TestDumpJSONCmd(TestCmd):
 
1457
    def setUp(self):
 
1458
        self.expected_json = {
 
1459
            "foo": {
2328
1460
                "Name": "foo",
2329
1461
                "KeyID": ("92ed150794387c03ce684574b1139a65"
2330
1462
                          "94a34f895daaaf09fd8ea90a27cddb12"),
2331
 
                "Secret": b"secret",
2332
1463
                "Host": "foo.example.org",
2333
1464
                "Enabled": True,
2334
1465
                "Timeout": 300000,
2348
1479
                "ExtendedTimeout": 900000,
2349
1480
                "Expires": "2019-02-04T00:00:00",
2350
1481
                "LastCheckerStatus": 0,
2351
 
            }
2352
 
            self.other_client_properties = {
 
1482
            },
 
1483
            "barbar": {
2353
1484
                "Name": "barbar",
2354
1485
                "KeyID": ("0558568eedd67d622f5c83b35a115f79"
2355
1486
                          "6ab612cff5ad227247e46c2b020f441c"),
2356
 
                "Secret": b"secretbar",
2357
1487
                "Host": "192.0.2.3",
2358
1488
                "Enabled": True,
2359
1489
                "Timeout": 300000,
2373
1503
                "ExtendedTimeout": 900000,
2374
1504
                "Expires": "2019-02-05T00:00:00",
2375
1505
                "LastCheckerStatus": -2,
2376
 
            }
2377
 
            self.clients =  collections.OrderedDict(
2378
 
                [
2379
 
                    ("client_objectpath", self.client_properties),
2380
 
                    ("other_client_objectpath",
2381
 
                     self.other_client_properties),
2382
 
                ])
2383
 
            self.one_client = {"client_objectpath":
2384
 
                               self.client_properties}
2385
 
            self.testcase = testcase
2386
 
            self.calls = []
2387
 
 
2388
 
        def call_method(self, methodname, busname, objectpath,
2389
 
                        interface, *args):
2390
 
            self.testcase.assertEqual("se.recompile.Mandos", busname)
2391
 
            self.calls.append((methodname, busname, objectpath,
2392
 
                               interface, args))
2393
 
            if interface == "org.freedesktop.DBus.Properties":
2394
 
                if methodname == "Set":
2395
 
                    self.testcase.assertEqual(3, len(args))
2396
 
                    interface, key, value = args
2397
 
                    self.testcase.assertEqual(
2398
 
                        "se.recompile.Mandos.Client", interface)
2399
 
                    self.clients[objectpath][key] = value
2400
 
                    return
2401
 
            elif interface == "se.recompile.Mandos":
2402
 
                self.testcase.assertEqual("RemoveClient", methodname)
2403
 
                self.testcase.assertEqual(1, len(args))
2404
 
                clientpath = args[0]
2405
 
                del self.clients[clientpath]
2406
 
                return
2407
 
            elif interface == "se.recompile.Mandos.Client":
2408
 
                if methodname == "Approve":
2409
 
                    self.testcase.assertEqual(1, len(args))
2410
 
                    return
2411
 
            raise ValueError()
2412
 
 
2413
 
    def setUp(self):
2414
 
        self.bus = self.FakeMandosBus(self)
2415
 
 
2416
 
 
2417
 
class TestBaseCommands(TestCommand):
2418
 
 
2419
 
    def test_IsEnabled_exits_successfully(self):
2420
 
        with self.assertRaises(SystemExit) as e:
2421
 
            command.IsEnabled().run(self.bus.one_client)
2422
 
        if e.exception.code is not None:
2423
 
            self.assertEqual(0, e.exception.code)
2424
 
        else:
2425
 
            self.assertIsNone(e.exception.code)
2426
 
 
2427
 
    def test_IsEnabled_exits_with_failure(self):
2428
 
        self.bus.client_properties["Enabled"] = False
2429
 
        with self.assertRaises(SystemExit) as e:
2430
 
            command.IsEnabled().run(self.bus.one_client)
2431
 
        if isinstance(e.exception.code, int):
2432
 
            self.assertNotEqual(0, e.exception.code)
2433
 
        else:
2434
 
            self.assertIsNotNone(e.exception.code)
2435
 
 
2436
 
    def test_Approve(self):
2437
 
        busname = "se.recompile.Mandos"
2438
 
        client_interface = "se.recompile.Mandos.Client"
2439
 
        command.Approve().run(self.bus.clients, self.bus)
2440
 
        for clientpath in self.bus.clients:
2441
 
            self.assertIn(("Approve", busname, clientpath,
2442
 
                           client_interface, (True,)), self.bus.calls)
2443
 
 
2444
 
    def test_Deny(self):
2445
 
        busname = "se.recompile.Mandos"
2446
 
        client_interface = "se.recompile.Mandos.Client"
2447
 
        command.Deny().run(self.bus.clients, self.bus)
2448
 
        for clientpath in self.bus.clients:
2449
 
            self.assertIn(("Approve", busname, clientpath,
2450
 
                           client_interface, (False,)),
2451
 
                          self.bus.calls)
2452
 
 
2453
 
    def test_Remove(self):
2454
 
        command.Remove().run(self.bus.clients, self.bus)
2455
 
        for clientpath in self.bus.clients:
2456
 
            self.assertIn(("RemoveClient", dbus_busname,
2457
 
                           dbus_server_path, dbus_server_interface,
2458
 
                           (clientpath,)), self.bus.calls)
2459
 
 
2460
 
    expected_json = {
2461
 
        "foo": {
2462
 
            "Name": "foo",
2463
 
            "KeyID": ("92ed150794387c03ce684574b1139a65"
2464
 
                      "94a34f895daaaf09fd8ea90a27cddb12"),
2465
 
            "Host": "foo.example.org",
2466
 
            "Enabled": True,
2467
 
            "Timeout": 300000,
2468
 
            "LastCheckedOK": "2019-02-03T00:00:00",
2469
 
            "Created": "2019-01-02T00:00:00",
2470
 
            "Interval": 120000,
2471
 
            "Fingerprint": ("778827225BA7DE539C5A"
2472
 
                            "7CFA59CFF7CDBD9A5920"),
2473
 
            "CheckerRunning": False,
2474
 
            "LastEnabled": "2019-01-03T00:00:00",
2475
 
            "ApprovalPending": False,
2476
 
            "ApprovedByDefault": True,
2477
 
            "LastApprovalRequest": "",
2478
 
            "ApprovalDelay": 0,
2479
 
            "ApprovalDuration": 1000,
2480
 
            "Checker": "fping -q -- %(host)s",
2481
 
            "ExtendedTimeout": 900000,
2482
 
            "Expires": "2019-02-04T00:00:00",
2483
 
            "LastCheckerStatus": 0,
2484
 
        },
2485
 
        "barbar": {
2486
 
            "Name": "barbar",
2487
 
            "KeyID": ("0558568eedd67d622f5c83b35a115f79"
2488
 
                      "6ab612cff5ad227247e46c2b020f441c"),
2489
 
            "Host": "192.0.2.3",
2490
 
            "Enabled": True,
2491
 
            "Timeout": 300000,
2492
 
            "LastCheckedOK": "2019-02-04T00:00:00",
2493
 
            "Created": "2019-01-03T00:00:00",
2494
 
            "Interval": 120000,
2495
 
            "Fingerprint": ("3E393AEAEFB84C7E89E2"
2496
 
                            "F547B3A107558FCA3A27"),
2497
 
            "CheckerRunning": True,
2498
 
            "LastEnabled": "2019-01-04T00:00:00",
2499
 
            "ApprovalPending": False,
2500
 
            "ApprovedByDefault": False,
2501
 
            "LastApprovalRequest": "2019-01-03T00:00:00",
2502
 
            "ApprovalDelay": 30000,
2503
 
            "ApprovalDuration": 93785000,
2504
 
            "Checker": ":",
2505
 
            "ExtendedTimeout": 900000,
2506
 
            "Expires": "2019-02-05T00:00:00",
2507
 
            "LastCheckerStatus": -2,
2508
 
        },
2509
 
    }
2510
 
 
2511
 
    def test_DumpJSON_normal(self):
2512
 
        with self.capture_stdout_to_buffer() as buffer:
2513
 
            command.DumpJSON().run(self.bus.clients)
2514
 
        json_data = json.loads(buffer.getvalue())
2515
 
        self.assertDictEqual(self.expected_json, json_data)
2516
 
 
2517
 
    @staticmethod
2518
 
    @contextlib.contextmanager
2519
 
    def capture_stdout_to_buffer():
2520
 
        capture_buffer = io.StringIO()
2521
 
        old_stdout = sys.stdout
2522
 
        sys.stdout = capture_buffer
2523
 
        try:
2524
 
            yield capture_buffer
2525
 
        finally:
2526
 
            sys.stdout = old_stdout
2527
 
 
2528
 
    def test_DumpJSON_one_client(self):
2529
 
        with self.capture_stdout_to_buffer() as buffer:
2530
 
            command.DumpJSON().run(self.bus.one_client)
2531
 
        json_data = json.loads(buffer.getvalue())
 
1506
            },
 
1507
        }
 
1508
        return super(TestDumpJSONCmd, self).setUp()
 
1509
 
 
1510
    def test_normal(self):
 
1511
        output = DumpJSONCmd().output(self.clients.values())
 
1512
        json_data = json.loads(output)
 
1513
        self.assertDictEqual(json_data, self.expected_json)
 
1514
 
 
1515
    def test_one_client(self):
 
1516
        output = DumpJSONCmd().output(self.one_client.values())
 
1517
        json_data = json.loads(output)
2532
1518
        expected_json = {"foo": self.expected_json["foo"]}
2533
 
        self.assertDictEqual(expected_json, json_data)
2534
 
 
2535
 
    def test_PrintTable_normal(self):
2536
 
        with self.capture_stdout_to_buffer() as buffer:
2537
 
            command.PrintTable().run(self.bus.clients)
 
1519
        self.assertDictEqual(json_data, expected_json)
 
1520
 
 
1521
 
 
1522
class TestPrintTableCmd(TestCmd):
 
1523
    def test_normal(self):
 
1524
        output = PrintTableCmd().output(self.clients.values())
2538
1525
        expected_output = "\n".join((
2539
1526
            "Name   Enabled Timeout  Last Successful Check",
2540
1527
            "foo    Yes     00:05:00 2019-02-03T00:00:00  ",
2541
1528
            "barbar Yes     00:05:00 2019-02-04T00:00:00  ",
2542
 
        )) + "\n"
2543
 
        self.assertEqual(expected_output, buffer.getvalue())
 
1529
        ))
 
1530
        self.assertEqual(output, expected_output)
2544
1531
 
2545
 
    def test_PrintTable_verbose(self):
2546
 
        with self.capture_stdout_to_buffer() as buffer:
2547
 
            command.PrintTable(verbose=True).run(self.bus.clients)
 
1532
    def test_verbose(self):
 
1533
        output = PrintTableCmd(verbose=True).output(
 
1534
            self.clients.values())
2548
1535
        columns = (
2549
1536
            (
2550
1537
                "Name   ",
2632
1619
            )
2633
1620
        )
2634
1621
        num_lines = max(len(rows) for rows in columns)
2635
 
        expected_output = ("\n".join("".join(rows[line]
2636
 
                                             for rows in columns)
2637
 
                                     for line in range(num_lines))
2638
 
                           + "\n")
2639
 
        self.assertEqual(expected_output, buffer.getvalue())
 
1622
        expected_output = "\n".join("".join(rows[line]
 
1623
                                            for rows in columns)
 
1624
                                    for line in range(num_lines))
 
1625
        self.assertEqual(output, expected_output)
2640
1626
 
2641
 
    def test_PrintTable_one_client(self):
2642
 
        with self.capture_stdout_to_buffer() as buffer:
2643
 
            command.PrintTable().run(self.bus.one_client)
 
1627
    def test_one_client(self):
 
1628
        output = PrintTableCmd().output(self.one_client.values())
2644
1629
        expected_output = "\n".join((
2645
1630
            "Name Enabled Timeout  Last Successful Check",
2646
1631
            "foo  Yes     00:05:00 2019-02-03T00:00:00  ",
2647
 
        )) + "\n"
2648
 
        self.assertEqual(expected_output, buffer.getvalue())
2649
 
 
2650
 
 
2651
 
class TestPropertySetterCmd(TestCommand):
2652
 
    """Abstract class for tests of command.PropertySetter classes"""
2653
 
 
 
1632
        ))
 
1633
        self.assertEqual(output, expected_output)
 
1634
 
 
1635
 
 
1636
class TestPropertyCmd(TestCmd):
 
1637
    """Abstract class for tests of PropertyCmd classes"""
2654
1638
    def runTest(self):
2655
1639
        if not hasattr(self, "command"):
2656
 
            return              # Abstract TestCase class
2657
 
 
2658
 
        if hasattr(self, "values_to_set"):
2659
 
            cmd_args = [(value,) for value in self.values_to_set]
2660
 
            values_to_get = getattr(self, "values_to_get",
2661
 
                                    self.values_to_set)
2662
 
        else:
2663
 
            cmd_args = [() for x in range(len(self.values_to_get))]
2664
 
            values_to_get = self.values_to_get
2665
 
        for value_to_get, cmd_arg in zip(values_to_get, cmd_args):
2666
 
            for clientpath in self.bus.clients:
2667
 
                self.bus.clients[clientpath][self.propname] = (
2668
 
                    Unique())
2669
 
            self.command(*cmd_arg).run(self.bus.clients, self.bus)
2670
 
            for clientpath in self.bus.clients:
2671
 
                value = (self.bus.clients[clientpath]
2672
 
                         [self.propname])
2673
 
                self.assertNotIsInstance(value, Unique)
2674
 
                self.assertEqual(value_to_get, value)
2675
 
 
2676
 
 
2677
 
class TestEnableCmd(TestPropertySetterCmd):
2678
 
    command = command.Enable
2679
 
    propname = "Enabled"
2680
 
    values_to_get = [True]
2681
 
 
2682
 
 
2683
 
class TestDisableCmd(TestPropertySetterCmd):
2684
 
    command = command.Disable
2685
 
    propname = "Enabled"
2686
 
    values_to_get = [False]
2687
 
 
2688
 
 
2689
 
class TestBumpTimeoutCmd(TestPropertySetterCmd):
2690
 
    command = command.BumpTimeout
 
1640
            return
 
1641
        values_to_get = getattr(self, "values_to_get",
 
1642
                                self.values_to_set)
 
1643
        for value_to_set, value_to_get in zip(self.values_to_set,
 
1644
                                              values_to_get):
 
1645
            for clientpath in self.clients:
 
1646
                client = self.bus.get_object(dbus_busname, clientpath)
 
1647
                old_value = client.attributes[self.propname]
 
1648
                self.assertNotIsInstance(old_value, self.Unique)
 
1649
                client.attributes[self.propname] = self.Unique()
 
1650
            self.run_command(value_to_set, self.clients)
 
1651
            for clientpath in self.clients:
 
1652
                client = self.bus.get_object(dbus_busname, clientpath)
 
1653
                value = client.attributes[self.propname]
 
1654
                self.assertNotIsInstance(value, self.Unique)
 
1655
                self.assertEqual(value, value_to_get)
 
1656
 
 
1657
    class Unique(object):
 
1658
        """Class for objects which exist only to be unique objects,
 
1659
since unittest.mock.sentinel only exists in Python 3.3"""
 
1660
 
 
1661
    def run_command(self, value, clients):
 
1662
        self.command().run(clients, self.bus)
 
1663
 
 
1664
 
 
1665
class TestEnableCmd(TestPropertyCmd):
 
1666
    command = EnableCmd
 
1667
    propname = "Enabled"
 
1668
    values_to_set = [dbus.Boolean(True)]
 
1669
 
 
1670
 
 
1671
class TestDisableCmd(TestPropertyCmd):
 
1672
    command = DisableCmd
 
1673
    propname = "Enabled"
 
1674
    values_to_set = [dbus.Boolean(False)]
 
1675
 
 
1676
 
 
1677
class TestBumpTimeoutCmd(TestPropertyCmd):
 
1678
    command = BumpTimeoutCmd
2691
1679
    propname = "LastCheckedOK"
2692
 
    values_to_get = [""]
2693
 
 
2694
 
 
2695
 
class TestStartCheckerCmd(TestPropertySetterCmd):
2696
 
    command = command.StartChecker
2697
 
    propname = "CheckerRunning"
2698
 
    values_to_get = [True]
2699
 
 
2700
 
 
2701
 
class TestStopCheckerCmd(TestPropertySetterCmd):
2702
 
    command = command.StopChecker
2703
 
    propname = "CheckerRunning"
2704
 
    values_to_get = [False]
2705
 
 
2706
 
 
2707
 
class TestApproveByDefaultCmd(TestPropertySetterCmd):
2708
 
    command = command.ApproveByDefault
2709
 
    propname = "ApprovedByDefault"
2710
 
    values_to_get = [True]
2711
 
 
2712
 
 
2713
 
class TestDenyByDefaultCmd(TestPropertySetterCmd):
2714
 
    command = command.DenyByDefault
2715
 
    propname = "ApprovedByDefault"
2716
 
    values_to_get = [False]
2717
 
 
2718
 
 
2719
 
class TestSetCheckerCmd(TestPropertySetterCmd):
2720
 
    command = command.SetChecker
 
1680
    values_to_set = [""]
 
1681
 
 
1682
 
 
1683
class TestStartCheckerCmd(TestPropertyCmd):
 
1684
    command = StartCheckerCmd
 
1685
    propname = "CheckerRunning"
 
1686
    values_to_set = [dbus.Boolean(True)]
 
1687
 
 
1688
 
 
1689
class TestStopCheckerCmd(TestPropertyCmd):
 
1690
    command = StopCheckerCmd
 
1691
    propname = "CheckerRunning"
 
1692
    values_to_set = [dbus.Boolean(False)]
 
1693
 
 
1694
 
 
1695
class TestApproveByDefaultCmd(TestPropertyCmd):
 
1696
    command = ApproveByDefaultCmd
 
1697
    propname = "ApprovedByDefault"
 
1698
    values_to_set = [dbus.Boolean(True)]
 
1699
 
 
1700
 
 
1701
class TestDenyByDefaultCmd(TestPropertyCmd):
 
1702
    command = DenyByDefaultCmd
 
1703
    propname = "ApprovedByDefault"
 
1704
    values_to_set = [dbus.Boolean(False)]
 
1705
 
 
1706
 
 
1707
class TestPropertyValueCmd(TestPropertyCmd):
 
1708
    """Abstract class for tests of PropertyValueCmd classes"""
 
1709
 
 
1710
    def runTest(self):
 
1711
        if type(self) is TestPropertyValueCmd:
 
1712
            return
 
1713
        return super(TestPropertyValueCmd, self).runTest()
 
1714
 
 
1715
    def run_command(self, value, clients):
 
1716
        self.command(value).run(clients, self.bus)
 
1717
 
 
1718
 
 
1719
class TestSetCheckerCmd(TestPropertyValueCmd):
 
1720
    command = SetCheckerCmd
2721
1721
    propname = "Checker"
2722
1722
    values_to_set = ["", ":", "fping -q -- %s"]
2723
1723
 
2724
1724
 
2725
 
class TestSetHostCmd(TestPropertySetterCmd):
2726
 
    command = command.SetHost
 
1725
class TestSetHostCmd(TestPropertyValueCmd):
 
1726
    command = SetHostCmd
2727
1727
    propname = "Host"
2728
 
    values_to_set = ["192.0.2.3", "client.example.org"]
2729
 
 
2730
 
 
2731
 
class TestSetSecretCmd(TestPropertySetterCmd):
2732
 
    command = command.SetSecret
 
1728
    values_to_set = ["192.0.2.3", "foo.example.org"]
 
1729
 
 
1730
 
 
1731
class TestSetSecretCmd(TestPropertyValueCmd):
 
1732
    command = SetSecretCmd
2733
1733
    propname = "Secret"
2734
1734
    values_to_set = [io.BytesIO(b""),
2735
1735
                     io.BytesIO(b"secret\0xyzzy\nbar")]
2736
 
    values_to_get = [f.getvalue() for f in values_to_set]
2737
 
 
2738
 
 
2739
 
class TestSetTimeoutCmd(TestPropertySetterCmd):
2740
 
    command = command.SetTimeout
 
1736
    values_to_get = [b"", b"secret\0xyzzy\nbar"]
 
1737
 
 
1738
 
 
1739
class TestSetTimeoutCmd(TestPropertyValueCmd):
 
1740
    command = SetTimeoutCmd
2741
1741
    propname = "Timeout"
2742
1742
    values_to_set = [datetime.timedelta(),
2743
1743
                     datetime.timedelta(minutes=5),
2744
1744
                     datetime.timedelta(seconds=1),
2745
1745
                     datetime.timedelta(weeks=1),
2746
1746
                     datetime.timedelta(weeks=52)]
2747
 
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2748
 
 
2749
 
 
2750
 
class TestSetExtendedTimeoutCmd(TestPropertySetterCmd):
2751
 
    command = command.SetExtendedTimeout
 
1747
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1748
 
 
1749
 
 
1750
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
 
1751
    command = SetExtendedTimeoutCmd
2752
1752
    propname = "ExtendedTimeout"
2753
1753
    values_to_set = [datetime.timedelta(),
2754
1754
                     datetime.timedelta(minutes=5),
2755
1755
                     datetime.timedelta(seconds=1),
2756
1756
                     datetime.timedelta(weeks=1),
2757
1757
                     datetime.timedelta(weeks=52)]
2758
 
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2759
 
 
2760
 
 
2761
 
class TestSetIntervalCmd(TestPropertySetterCmd):
2762
 
    command = command.SetInterval
 
1758
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1759
 
 
1760
 
 
1761
class TestSetIntervalCmd(TestPropertyValueCmd):
 
1762
    command = SetIntervalCmd
2763
1763
    propname = "Interval"
2764
1764
    values_to_set = [datetime.timedelta(),
2765
1765
                     datetime.timedelta(minutes=5),
2766
1766
                     datetime.timedelta(seconds=1),
2767
1767
                     datetime.timedelta(weeks=1),
2768
1768
                     datetime.timedelta(weeks=52)]
2769
 
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2770
 
 
2771
 
 
2772
 
class TestSetApprovalDelayCmd(TestPropertySetterCmd):
2773
 
    command = command.SetApprovalDelay
 
1769
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1770
 
 
1771
 
 
1772
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
 
1773
    command = SetApprovalDelayCmd
2774
1774
    propname = "ApprovalDelay"
2775
1775
    values_to_set = [datetime.timedelta(),
2776
1776
                     datetime.timedelta(minutes=5),
2777
1777
                     datetime.timedelta(seconds=1),
2778
1778
                     datetime.timedelta(weeks=1),
2779
1779
                     datetime.timedelta(weeks=52)]
2780
 
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2781
 
 
2782
 
 
2783
 
class TestSetApprovalDurationCmd(TestPropertySetterCmd):
2784
 
    command = command.SetApprovalDuration
 
1780
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1781
 
 
1782
 
 
1783
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
 
1784
    command = SetApprovalDurationCmd
2785
1785
    propname = "ApprovalDuration"
2786
1786
    values_to_set = [datetime.timedelta(),
2787
1787
                     datetime.timedelta(minutes=5),
2788
1788
                     datetime.timedelta(seconds=1),
2789
1789
                     datetime.timedelta(weeks=1),
2790
1790
                     datetime.timedelta(weeks=52)]
2791
 
    values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
 
1791
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
2792
1792
 
2793
1793
 
2794
1794