/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-17 16:48:56 UTC
  • Revision ID: teddy@recompile.se-20190317164856-de11glvsfwhnj34w
mandos-ctl: Refactor tests

* mandos-ctl (Test_string_to_delta.test_handles_basic_rfc3339): Split
                                                  into multiple tests.
  (Test_string_to_delta.test_rfc3339_zero_seconds): New.
  (Test_string_to_delta.test_rfc3339_zero_days): - '' -
  (Test_string_to_delta.test_rfc3339_one_second): - '' -
  (Test_string_to_delta.test_rfc3339_two_hours): - '' -
  (TestCommand.setUp.MockClient.Get): Remove; unused.
  (TestBaseCommands.test_Remove): Remove unnecessary assertion.
  (TestPropertyCmd.runTest): - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
64
64
 
65
65
locale.setlocale(locale.LC_ALL, "")
66
66
 
67
 
domain = "se.recompile"
68
 
busname = domain + ".Mandos"
69
 
server_path = "/"
70
 
server_interface = domain + ".Mandos"
71
 
client_interface = domain + ".Mandos.Client"
 
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
72
73
version = "1.8.3"
73
74
 
74
75
 
78
79
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
79
80
 
80
81
 
81
 
def milliseconds_to_string(ms):
82
 
    td = datetime.timedelta(0, 0, 0, ms)
83
 
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
84
 
            .format(days="{}T".format(td.days) if td.days else "",
85
 
                    hours=td.seconds // 3600,
86
 
                    minutes=(td.seconds % 3600) // 60,
87
 
                    seconds=td.seconds % 60))
 
82
def main():
 
83
    parser = argparse.ArgumentParser()
 
84
 
 
85
    add_command_line_options(parser)
 
86
 
 
87
    options = parser.parse_args()
 
88
 
 
89
    check_option_syntax(parser, options)
 
90
 
 
91
    clientnames = options.client
 
92
 
 
93
    if options.debug:
 
94
        log.setLevel(logging.DEBUG)
 
95
 
 
96
    bus = dbus.SystemBus()
 
97
 
 
98
    mandos_dbus_object = get_mandos_dbus_object(bus)
 
99
 
 
100
    mandos_serv = dbus.Interface(
 
101
        mandos_dbus_object, dbus_interface=server_dbus_interface)
 
102
    mandos_serv_object_manager = dbus.Interface(
 
103
        mandos_dbus_object, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
 
104
 
 
105
    managed_objects = get_managed_objects(mandos_serv_object_manager)
 
106
 
 
107
    all_clients = {}
 
108
    for path, ifs_and_props in managed_objects.items():
 
109
        try:
 
110
            all_clients[path] = ifs_and_props[client_dbus_interface]
 
111
        except KeyError:
 
112
            pass
 
113
 
 
114
    # Compile dict of (clientpath: properties) to process
 
115
    if not clientnames:
 
116
        clients = all_clients
 
117
    else:
 
118
        clients = {}
 
119
        for name in clientnames:
 
120
            for objpath, properties in all_clients.items():
 
121
                if properties["Name"] == name:
 
122
                    clients[objpath] = properties
 
123
                    break
 
124
            else:
 
125
                log.critical("Client not found on server: %r", name)
 
126
                sys.exit(1)
 
127
 
 
128
    commands = commands_from_options(options)
 
129
 
 
130
    for command in commands:
 
131
        command.run(clients, bus, mandos_serv)
 
132
 
 
133
 
 
134
def add_command_line_options(parser):
 
135
    parser.add_argument("--version", action="version",
 
136
                        version="%(prog)s {}".format(version),
 
137
                        help="show version number and exit")
 
138
    parser.add_argument("-a", "--all", action="store_true",
 
139
                        help="Select all clients")
 
140
    parser.add_argument("-v", "--verbose", action="store_true",
 
141
                        help="Print all fields")
 
142
    parser.add_argument("-j", "--dump-json", action="store_true",
 
143
                        help="Dump client data in JSON format")
 
144
    enable_disable = parser.add_mutually_exclusive_group()
 
145
    enable_disable.add_argument("-e", "--enable", action="store_true",
 
146
                                help="Enable client")
 
147
    enable_disable.add_argument("-d", "--disable",
 
148
                                action="store_true",
 
149
                                help="disable client")
 
150
    parser.add_argument("-b", "--bump-timeout", action="store_true",
 
151
                        help="Bump timeout for client")
 
152
    start_stop_checker = parser.add_mutually_exclusive_group()
 
153
    start_stop_checker.add_argument("--start-checker",
 
154
                                    action="store_true",
 
155
                                    help="Start checker for client")
 
156
    start_stop_checker.add_argument("--stop-checker",
 
157
                                    action="store_true",
 
158
                                    help="Stop checker for client")
 
159
    parser.add_argument("-V", "--is-enabled", action="store_true",
 
160
                        help="Check if client is enabled")
 
161
    parser.add_argument("-r", "--remove", action="store_true",
 
162
                        help="Remove client")
 
163
    parser.add_argument("-c", "--checker",
 
164
                        help="Set checker command for client")
 
165
    parser.add_argument("-t", "--timeout", type=string_to_delta,
 
166
                        help="Set timeout for client")
 
167
    parser.add_argument("--extended-timeout", type=string_to_delta,
 
168
                        help="Set extended timeout for client")
 
169
    parser.add_argument("-i", "--interval", type=string_to_delta,
 
170
                        help="Set checker interval for client")
 
171
    approve_deny_default = parser.add_mutually_exclusive_group()
 
172
    approve_deny_default.add_argument(
 
173
        "--approve-by-default", action="store_true",
 
174
        default=None, dest="approved_by_default",
 
175
        help="Set client to be approved by default")
 
176
    approve_deny_default.add_argument(
 
177
        "--deny-by-default", action="store_false",
 
178
        dest="approved_by_default",
 
179
        help="Set client to be denied by default")
 
180
    parser.add_argument("--approval-delay", type=string_to_delta,
 
181
                        help="Set delay before client approve/deny")
 
182
    parser.add_argument("--approval-duration", type=string_to_delta,
 
183
                        help="Set duration of one client approval")
 
184
    parser.add_argument("-H", "--host", help="Set host for client")
 
185
    parser.add_argument("-s", "--secret",
 
186
                        type=argparse.FileType(mode="rb"),
 
187
                        help="Set password blob (file) for client")
 
188
    approve_deny = parser.add_mutually_exclusive_group()
 
189
    approve_deny.add_argument(
 
190
        "-A", "--approve", action="store_true",
 
191
        help="Approve any current client request")
 
192
    approve_deny.add_argument("-D", "--deny", action="store_true",
 
193
                              help="Deny any current client request")
 
194
    parser.add_argument("--debug", action="store_true",
 
195
                        help="Debug mode (show D-Bus commands)")
 
196
    parser.add_argument("--check", action="store_true",
 
197
                        help="Run self-test")
 
198
    parser.add_argument("client", nargs="*", help="Client name")
 
199
 
 
200
 
 
201
def string_to_delta(interval):
 
202
    """Parse a string and return a datetime.timedelta"""
 
203
 
 
204
    try:
 
205
        return rfc3339_duration_to_delta(interval)
 
206
    except ValueError as e:
 
207
        log.warning("%s - Parsing as pre-1.6.1 interval instead",
 
208
                    ' '.join(e.args))
 
209
    return parse_pre_1_6_1_interval(interval)
88
210
 
89
211
 
90
212
def rfc3339_duration_to_delta(duration):
110
232
    >>> rfc3339_duration_to_delta("")
111
233
    Traceback (most recent call last):
112
234
    ...
113
 
    ValueError: Invalid RFC 3339 duration: u''
 
235
    ValueError: Invalid RFC 3339 duration: ""
114
236
    >>> # Must start with "P":
115
237
    >>> rfc3339_duration_to_delta("1D")
116
238
    Traceback (most recent call last):
117
239
    ...
118
 
    ValueError: Invalid RFC 3339 duration: u'1D'
 
240
    ValueError: Invalid RFC 3339 duration: "1D"
119
241
    >>> # Must use correct order
120
242
    >>> rfc3339_duration_to_delta("PT1S2M")
121
243
    Traceback (most recent call last):
122
244
    ...
123
 
    ValueError: Invalid RFC 3339 duration: u'PT1S2M'
 
245
    ValueError: Invalid RFC 3339 duration: "PT1S2M"
124
246
    >>> # Time needs time marker
125
247
    >>> rfc3339_duration_to_delta("P1H2S")
126
248
    Traceback (most recent call last):
127
249
    ...
128
 
    ValueError: Invalid RFC 3339 duration: u'P1H2S'
 
250
    ValueError: Invalid RFC 3339 duration: "P1H2S"
129
251
    >>> # Weeks can not be combined with anything else
130
252
    >>> rfc3339_duration_to_delta("P1D2W")
131
253
    Traceback (most recent call last):
132
254
    ...
133
 
    ValueError: Invalid RFC 3339 duration: u'P1D2W'
 
255
    ValueError: Invalid RFC 3339 duration: "P1D2W"
134
256
    >>> rfc3339_duration_to_delta("P2W2H")
135
257
    Traceback (most recent call last):
136
258
    ...
137
 
    ValueError: Invalid RFC 3339 duration: u'P2W2H'
 
259
    ValueError: Invalid RFC 3339 duration: "P2W2H"
138
260
    """
139
261
 
140
262
    # Parsing an RFC 3339 duration with regular expressions is not
211
333
                break
212
334
        else:
213
335
            # No currently valid tokens were found
214
 
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
336
            raise ValueError("Invalid RFC 3339 duration: \"{}\""
215
337
                             .format(duration))
216
338
    # End token found
217
339
    return value
218
340
 
219
341
 
220
 
def string_to_delta(interval):
221
 
    """Parse a string and return a datetime.timedelta"""
222
 
 
223
 
    try:
224
 
        return rfc3339_duration_to_delta(interval)
225
 
    except ValueError as e:
226
 
        log.warning("%s - Parsing as pre-1.6.1 interval instead",
227
 
                    ' '.join(e.args))
228
 
    return parse_pre_1_6_1_interval(interval)
229
 
 
230
 
 
231
342
def parse_pre_1_6_1_interval(interval):
232
343
    """Parse an interval string as documented by Mandos before 1.6.1,
233
344
    and return a datetime.timedelta
271
382
    return value
272
383
 
273
384
 
274
 
## Classes for commands.
275
 
 
276
 
# Abstract classes first
277
 
class Command(object):
278
 
    """Abstract class for commands"""
279
 
    def run(self, mandos, mandos_objmgr, clients):
280
 
        """Normal commands should implement run_on_one_client(), but
281
 
        commands which want to operate on all clients at the same time
282
 
        can override this run() method instead."""
283
 
        self.mandos = mandos
284
 
        for client, properties in clients.items():
285
 
            self.run_on_one_client(client, properties)
286
 
 
287
 
class PrintCmd(Command):
288
 
    """Abstract class for commands printing client details"""
289
 
    all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
290
 
                    "Created", "Interval", "Host", "KeyID",
291
 
                    "Fingerprint", "CheckerRunning", "LastEnabled",
292
 
                    "ApprovalPending", "ApprovedByDefault",
293
 
                    "LastApprovalRequest", "ApprovalDelay",
294
 
                    "ApprovalDuration", "Checker", "ExtendedTimeout",
295
 
                    "Expires", "LastCheckerStatus")
296
 
    def run(self, mandos, mandos_objmgr, clients):
297
 
        print(self.output(mandos_objmgr, clients.values()))
298
 
 
299
 
class PropertyCmd(Command):
300
 
    """Abstract class for Actions for setting one client property"""
301
 
    def run_on_one_client(self, client, properties):
302
 
        """Set the Client's D-Bus property"""
303
 
        log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", busname,
304
 
                  client.__dbus_object_path__,
305
 
                  dbus.PROPERTIES_IFACE, client_interface,
306
 
                  self.property, self.value_to_set
307
 
                  if not isinstance(self.value_to_set, dbus.Boolean)
308
 
                  else bool(self.value_to_set))
309
 
        client.Set(client_interface, self.property, self.value_to_set,
310
 
                   dbus_interface=dbus.PROPERTIES_IFACE)
311
 
 
312
 
class ValueArgumentMixIn(object):
313
 
    """Mixin class for commands taking a value as argument"""
314
 
    def __init__(self, value):
315
 
        self.value_to_set = value
316
 
 
317
 
class MillisecondsValueArgumentMixIn(ValueArgumentMixIn):
318
 
    """Mixin class for commands taking a value argument as
319
 
    milliseconds."""
320
 
    @property
321
 
    def value_to_set(self):
322
 
        return self._vts
323
 
    @value_to_set.setter
324
 
    def value_to_set(self, value):
325
 
        """When setting, convert value to a datetime.timedelta"""
326
 
        self._vts = int(round(value.total_seconds() * 1000))
327
 
 
328
 
# Actual (non-abstract) command classes
329
 
 
330
 
class PrintTableCmd(PrintCmd):
331
 
    def __init__(self, verbose=False):
332
 
        self.verbose = verbose
333
 
 
334
 
    def output(self, mandos_objmgr, clients):
335
 
        default_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
336
 
        keywords = default_keywords
337
 
        if self.verbose:
338
 
            keywords = self.all_keywords
339
 
        return str(self.TableOfClients(clients, keywords))
340
 
 
341
 
    class TableOfClients(object):
342
 
        tableheaders = {
343
 
            "Name": "Name",
344
 
            "Enabled": "Enabled",
345
 
            "Timeout": "Timeout",
346
 
            "LastCheckedOK": "Last Successful Check",
347
 
            "LastApprovalRequest": "Last Approval Request",
348
 
            "Created": "Created",
349
 
            "Interval": "Interval",
350
 
            "Host": "Host",
351
 
            "Fingerprint": "Fingerprint",
352
 
            "KeyID": "Key ID",
353
 
            "CheckerRunning": "Check Is Running",
354
 
            "LastEnabled": "Last Enabled",
355
 
            "ApprovalPending": "Approval Is Pending",
356
 
            "ApprovedByDefault": "Approved By Default",
357
 
            "ApprovalDelay": "Approval Delay",
358
 
            "ApprovalDuration": "Approval Duration",
359
 
            "Checker": "Checker",
360
 
            "ExtendedTimeout": "Extended Timeout",
361
 
            "Expires": "Expires",
362
 
            "LastCheckerStatus": "Last Checker Status",
363
 
        }
364
 
 
365
 
        def __init__(self, clients, keywords, tableheaders=None):
366
 
            self.clients = clients
367
 
            self.keywords = keywords
368
 
            if tableheaders is not None:
369
 
                self.tableheaders = tableheaders
370
 
 
371
 
        def __str__(self):
372
 
            return "\n".join(self.rows())
373
 
 
374
 
        if sys.version_info.major == 2:
375
 
            __unicode__ = __str__
376
 
            def __str__(self):
377
 
                return str(self).encode(locale.getpreferredencoding())
378
 
 
379
 
        def rows(self):
380
 
            format_string = self.row_formatting_string()
381
 
            rows = [self.header_line(format_string)]
382
 
            rows.extend(self.client_line(client, format_string)
383
 
                        for client in self.clients)
384
 
            return rows
385
 
 
386
 
        def row_formatting_string(self):
387
 
            "Format string used to format table rows"
388
 
            return " ".join("{{{key}:{width}}}".format(
389
 
                width=max(len(self.tableheaders[key]),
390
 
                          *(len(self.string_from_client(client, key))
391
 
                            for client in self.clients)),
392
 
                key=key)
393
 
                            for key in self.keywords)
394
 
 
395
 
        def string_from_client(self, client, key):
396
 
            return self.valuetostring(client[key], key)
397
 
 
398
 
        @staticmethod
399
 
        def valuetostring(value, keyword):
400
 
            if isinstance(value, dbus.Boolean):
401
 
                return "Yes" if value else "No"
402
 
            if keyword in ("Timeout", "Interval", "ApprovalDelay",
403
 
                           "ApprovalDuration", "ExtendedTimeout"):
404
 
                return milliseconds_to_string(value)
405
 
            return str(value)
406
 
 
407
 
        def header_line(self, format_string):
408
 
            return format_string.format(**self.tableheaders)
409
 
 
410
 
        def client_line(self, client, format_string):
411
 
            return format_string.format(
412
 
                **{key: self.string_from_client(client, key)
413
 
                   for key in self.keywords})
414
 
 
415
 
 
416
 
 
417
 
class DumpJSONCmd(PrintCmd):
418
 
    def output(self, mandos_objmgr, clients):
419
 
        data = {client["Name"]:
420
 
                {key: self.dbus_boolean_to_bool(client[key])
421
 
                 for key in self.all_keywords}
422
 
                for client in clients.values()}
423
 
        return json.dumps(data, indent=4, separators=(',', ': '))
424
 
    @staticmethod
425
 
    def dbus_boolean_to_bool(value):
426
 
        if isinstance(value, dbus.Boolean):
427
 
            value = bool(value)
428
 
        return value
429
 
 
430
 
class IsEnabledCmd(Command):
431
 
    def run_on_one_client(self, client, properties):
432
 
        if self.is_enabled(client, properties):
433
 
            sys.exit(0)
434
 
        sys.exit(1)
435
 
    def is_enabled(self, client, properties):
436
 
        log.debug("D-Bus: %s:%s:%s.Get(%r, %r)", busname,
437
 
                  client.__dbus_object_path__,
438
 
                  dbus.PROPERTIES_IFACE, client_interface,
439
 
                  "Enabled")
440
 
        return bool(client.Get(client_interface, "Enabled",
441
 
                               dbus_interface=dbus.PROPERTIES_IFACE))
442
 
 
443
 
class RemoveCmd(Command):
444
 
    def run_on_one_client(self, client, properties):
445
 
        log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)", busname,
446
 
                  server_path, server_interface,
447
 
                  str(client.__dbus_object_path__))
448
 
        self.mandos.RemoveClient(client.__dbus_object_path__)
449
 
 
450
 
class ApproveCmd(Command):
451
 
    def run_on_one_client(self, client, properties):
452
 
        log.debug("D-Bus: %s:%s.Approve(True)",
453
 
                  client.__dbus_object_path__, client_interface)
454
 
        client.Approve(dbus.Boolean(True),
455
 
                       dbus_interface=client_interface)
456
 
 
457
 
class DenyCmd(Command):
458
 
    def run_on_one_client(self, client, properties):
459
 
        log.debug("D-Bus: %s:%s.Approve(False)",
460
 
                  client.__dbus_object_path__, client_interface)
461
 
        client.Approve(dbus.Boolean(False),
462
 
                       dbus_interface=client_interface)
463
 
 
464
 
class EnableCmd(PropertyCmd):
465
 
    property = "Enabled"
466
 
    value_to_set = dbus.Boolean(True)
467
 
 
468
 
class DisableCmd(PropertyCmd):
469
 
    property = "Enabled"
470
 
    value_to_set = dbus.Boolean(False)
471
 
 
472
 
class BumpTimeoutCmd(PropertyCmd):
473
 
    property = "LastCheckedOK"
474
 
    value_to_set = ""
475
 
 
476
 
class StartCheckerCmd(PropertyCmd):
477
 
    property = "CheckerRunning"
478
 
    value_to_set = dbus.Boolean(True)
479
 
 
480
 
class StopCheckerCmd(PropertyCmd):
481
 
    property = "CheckerRunning"
482
 
    value_to_set = dbus.Boolean(False)
483
 
 
484
 
class ApproveByDefaultCmd(PropertyCmd):
485
 
    property = "ApprovedByDefault"
486
 
    value_to_set = dbus.Boolean(True)
487
 
 
488
 
class DenyByDefaultCmd(PropertyCmd):
489
 
    property = "ApprovedByDefault"
490
 
    value_to_set = dbus.Boolean(False)
491
 
 
492
 
class SetCheckerCmd(PropertyCmd, ValueArgumentMixIn):
493
 
    property = "Checker"
494
 
 
495
 
class SetHostCmd(PropertyCmd, ValueArgumentMixIn):
496
 
    property = "Host"
497
 
 
498
 
class SetSecretCmd(PropertyCmd, ValueArgumentMixIn):
499
 
    @property
500
 
    def value_to_set(self):
501
 
        return self._vts
502
 
    @value_to_set.setter
503
 
    def value_to_set(self, value):
504
 
        """When setting, read data from supplied file object"""
505
 
        self._vts = value.read()
506
 
        value.close()
507
 
    property = "Secret"
508
 
 
509
 
class SetTimeoutCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
510
 
    property = "Timeout"
511
 
 
512
 
class SetExtendedTimeoutCmd(PropertyCmd,
513
 
                            MillisecondsValueArgumentMixIn):
514
 
    property = "ExtendedTimeout"
515
 
 
516
 
class SetIntervalCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
517
 
    property = "Interval"
518
 
 
519
 
class SetApprovalDelayCmd(PropertyCmd,
520
 
                          MillisecondsValueArgumentMixIn):
521
 
    property = "ApprovalDelay"
522
 
 
523
 
class SetApprovalDurationCmd(PropertyCmd,
524
 
                             MillisecondsValueArgumentMixIn):
525
 
    property = "ApprovalDuration"
526
 
 
527
 
def add_command_line_options(parser):
528
 
    parser.add_argument("--version", action="version",
529
 
                        version="%(prog)s {}".format(version),
530
 
                        help="show version number and exit")
531
 
    parser.add_argument("-a", "--all", action="store_true",
532
 
                        help="Select all clients")
533
 
    parser.add_argument("-v", "--verbose", action="store_true",
534
 
                        help="Print all fields")
535
 
    parser.add_argument("-j", "--dump-json", action="store_true",
536
 
                        help="Dump client data in JSON format")
537
 
    enable_disable = parser.add_mutually_exclusive_group()
538
 
    enable_disable.add_argument("-e", "--enable", action="store_true",
539
 
                                help="Enable client")
540
 
    enable_disable.add_argument("-d", "--disable",
541
 
                                action="store_true",
542
 
                                help="disable client")
543
 
    parser.add_argument("-b", "--bump-timeout", action="store_true",
544
 
                        help="Bump timeout for client")
545
 
    start_stop_checker = parser.add_mutually_exclusive_group()
546
 
    start_stop_checker.add_argument("--start-checker",
547
 
                                    action="store_true",
548
 
                                    help="Start checker for client")
549
 
    start_stop_checker.add_argument("--stop-checker",
550
 
                                    action="store_true",
551
 
                                    help="Stop checker for client")
552
 
    parser.add_argument("-V", "--is-enabled", action="store_true",
553
 
                        help="Check if client is enabled")
554
 
    parser.add_argument("-r", "--remove", action="store_true",
555
 
                        help="Remove client")
556
 
    parser.add_argument("-c", "--checker",
557
 
                        help="Set checker command for client")
558
 
    parser.add_argument("-t", "--timeout", type=string_to_delta,
559
 
                        help="Set timeout for client")
560
 
    parser.add_argument("--extended-timeout", type=string_to_delta,
561
 
                        help="Set extended timeout for client")
562
 
    parser.add_argument("-i", "--interval", type=string_to_delta,
563
 
                        help="Set checker interval for client")
564
 
    approve_deny_default = parser.add_mutually_exclusive_group()
565
 
    approve_deny_default.add_argument(
566
 
        "--approve-by-default", action="store_true",
567
 
        default=None, dest="approved_by_default",
568
 
        help="Set client to be approved by default")
569
 
    approve_deny_default.add_argument(
570
 
        "--deny-by-default", action="store_false",
571
 
        dest="approved_by_default",
572
 
        help="Set client to be denied by default")
573
 
    parser.add_argument("--approval-delay", type=string_to_delta,
574
 
                        help="Set delay before client approve/deny")
575
 
    parser.add_argument("--approval-duration", type=string_to_delta,
576
 
                        help="Set duration of one client approval")
577
 
    parser.add_argument("-H", "--host", help="Set host for client")
578
 
    parser.add_argument("-s", "--secret",
579
 
                        type=argparse.FileType(mode="rb"),
580
 
                        help="Set password blob (file) for client")
581
 
    approve_deny = parser.add_mutually_exclusive_group()
582
 
    approve_deny.add_argument(
583
 
        "-A", "--approve", action="store_true",
584
 
        help="Approve any current client request")
585
 
    approve_deny.add_argument("-D", "--deny", action="store_true",
586
 
                              help="Deny any current client request")
587
 
    parser.add_argument("--debug", action="store_true",
588
 
                        help="Debug mode (show D-Bus commands)")
589
 
    parser.add_argument("--check", action="store_true",
590
 
                        help="Run self-test")
591
 
    parser.add_argument("client", nargs="*", help="Client name")
592
 
 
593
 
 
594
 
def commands_from_options(options):
595
 
 
596
 
    commands = []
597
 
 
598
 
    if options.dump_json:
599
 
        commands.append(DumpJSONCmd())
600
 
 
601
 
    if options.enable:
602
 
        commands.append(EnableCmd())
603
 
 
604
 
    if options.disable:
605
 
        commands.append(DisableCmd())
606
 
 
607
 
    if options.bump_timeout:
608
 
        commands.append(BumpTimeoutCmd())
609
 
 
610
 
    if options.start_checker:
611
 
        commands.append(StartCheckerCmd())
612
 
 
613
 
    if options.stop_checker:
614
 
        commands.append(StopCheckerCmd())
615
 
 
616
 
    if options.is_enabled:
617
 
        commands.append(IsEnabledCmd())
618
 
 
619
 
    if options.checker is not None:
620
 
        commands.append(SetCheckerCmd(options.checker))
621
 
 
622
 
    if options.timeout is not None:
623
 
        commands.append(SetTimeoutCmd(options.timeout))
624
 
 
625
 
    if options.extended_timeout:
626
 
        commands.append(
627
 
            SetExtendedTimeoutCmd(options.extended_timeout))
628
 
 
629
 
    if options.interval is not None:
630
 
        commands.append(SetIntervalCmd(options.interval))
631
 
 
632
 
    if options.approved_by_default is not None:
633
 
        if options.approved_by_default:
634
 
            commands.append(ApproveByDefaultCmd())
635
 
        else:
636
 
            commands.append(DenyByDefaultCmd())
637
 
 
638
 
    if options.approval_delay is not None:
639
 
        commands.append(SetApprovalDelayCmd(options.approval_delay))
640
 
 
641
 
    if options.approval_duration is not None:
642
 
        commands.append(
643
 
            SetApprovalDurationCmd(options.approval_duration))
644
 
 
645
 
    if options.host is not None:
646
 
        commands.append(SetHostCmd(options.host))
647
 
 
648
 
    if options.secret is not None:
649
 
        commands.append(SetSecretCmd(options.secret))
650
 
 
651
 
    if options.approve:
652
 
        commands.append(ApproveCmd())
653
 
 
654
 
    if options.deny:
655
 
        commands.append(DenyCmd())
656
 
 
657
 
    if options.remove:
658
 
        commands.append(RemoveCmd())
659
 
 
660
 
    # If no command option has been given, show table of clients,
661
 
    # optionally verbosely
662
 
    if not commands:
663
 
        commands.append(PrintTableCmd(verbose=options.verbose))
664
 
 
665
 
    return commands
666
 
 
667
 
 
668
385
def check_option_syntax(parser, options):
669
386
    """Apply additional restrictions on options, not expressible in
670
387
argparse"""
707
424
        options.remove = True
708
425
 
709
426
 
710
 
def main():
711
 
    parser = argparse.ArgumentParser()
712
 
 
713
 
    add_command_line_options(parser)
714
 
 
715
 
    options = parser.parse_args()
716
 
 
717
 
    check_option_syntax(parser, options)
718
 
 
719
 
    clientnames = options.client
720
 
 
721
 
    if options.debug:
722
 
        log.setLevel(logging.DEBUG)
723
 
 
 
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):
724
439
    try:
725
 
        bus = dbus.SystemBus()
726
 
        log.debug("D-Bus: Connect to: (name=%r, path=%r)", busname,
727
 
                  server_path)
728
 
        mandos_dbus_objc = bus.get_object(busname, server_path)
729
 
    except dbus.exceptions.DBusException:
730
 
        log.critical("Could not connect to Mandos server")
 
440
        yield
 
441
    except dbus.exceptions.DBusException as e:
 
442
        log.critical(*(args + (e,)), **kwargs)
731
443
        sys.exit(1)
732
444
 
733
 
    mandos_serv = dbus.Interface(mandos_dbus_objc,
734
 
                                 dbus_interface=server_interface)
735
 
    mandos_serv_object_manager = dbus.Interface(
736
 
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
737
 
 
738
 
    # Filter out log message from dbus module
739
 
    dbus_logger = logging.getLogger("dbus.proxies")
 
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
 
740
465
    class NullFilter(logging.Filter):
741
466
        def filter(self, record):
742
467
            return False
743
 
    dbus_filter = NullFilter()
744
 
    try:
745
 
        dbus_logger.addFilter(dbus_filter)
746
 
        log.debug("D-Bus: %s:%s:%s.GetManagedObjects()", busname,
747
 
                  server_path, dbus.OBJECT_MANAGER_IFACE)
748
 
        mandos_clients = {path: ifs_and_props[client_interface]
749
 
                          for path, ifs_and_props in
750
 
                          mandos_serv_object_manager
751
 
                          .GetManagedObjects().items()
752
 
                          if client_interface in ifs_and_props}
753
 
    except dbus.exceptions.DBusException as e:
754
 
        log.critical("Failed to access Mandos server through D-Bus:"
755
 
                     "\n%s", e)
756
 
        sys.exit(1)
757
 
    finally:
758
 
        # restore dbus logger
759
 
        dbus_logger.removeFilter(dbus_filter)
760
 
 
761
 
    # Compile dict of (clients: properties) to process
762
 
    clients = {}
763
 
 
764
 
    if not clientnames:
765
 
        clients = {(log.debug("D-Bus: Connect to: (name=%r, path=%r)",
766
 
                              busname, str(path)) and False) or
767
 
                   bus.get_object(busname, path): properties
768
 
                   for path, properties in mandos_clients.items()}
769
 
    else:
770
 
        for name in clientnames:
771
 
            for path, client in mandos_clients.items():
772
 
                if client["Name"] == name:
773
 
                    log.debug("D-Bus: Connect to: (name=%r, path=%r)",
774
 
                              busname, str(path))
775
 
                    client_objc = bus.get_object(busname, path)
776
 
                    clients[client_objc] = client
777
 
                    break
778
 
            else:
779
 
                log.critical("Client not found on server: %r", name)
780
 
                sys.exit(1)
781
 
 
782
 
    # Run all commands on clients
783
 
    commands = commands_from_options(options)
784
 
    for command in commands:
785
 
        command.run(mandos_serv, mandos_serv_object_manager, clients)
 
468
 
 
469
    nullfilter = NullFilter()
 
470
 
 
471
    def __exit__(self, exc_type, exc_val, exc_tb):
 
472
        self.logger.removeFilter(self.nullfilter)
 
473
 
 
474
 
 
475
def commands_from_options(options):
 
476
 
 
477
    commands = []
 
478
 
 
479
    if options.is_enabled:
 
480
        commands.append(command.IsEnabled())
 
481
 
 
482
    if options.approve:
 
483
        commands.append(command.Approve())
 
484
 
 
485
    if options.deny:
 
486
        commands.append(command.Deny())
 
487
 
 
488
    if options.remove:
 
489
        commands.append(command.Remove())
 
490
 
 
491
    if options.dump_json:
 
492
        commands.append(command.DumpJSON())
 
493
 
 
494
    if options.enable:
 
495
        commands.append(command.Enable())
 
496
 
 
497
    if options.disable:
 
498
        commands.append(command.Disable())
 
499
 
 
500
    if options.bump_timeout:
 
501
        commands.append(command.BumpTimeout())
 
502
 
 
503
    if options.start_checker:
 
504
        commands.append(command.StartChecker())
 
505
 
 
506
    if options.stop_checker:
 
507
        commands.append(command.StopChecker())
 
508
 
 
509
    if options.approved_by_default is not None:
 
510
        if options.approved_by_default:
 
511
            commands.append(command.ApproveByDefault())
 
512
        else:
 
513
            commands.append(command.DenyByDefault())
 
514
 
 
515
    if options.checker is not None:
 
516
        commands.append(command.SetChecker(options.checker))
 
517
 
 
518
    if options.host is not None:
 
519
        commands.append(command.SetHost(options.host))
 
520
 
 
521
    if options.secret is not None:
 
522
        commands.append(command.SetSecret(options.secret))
 
523
 
 
524
    if options.timeout is not None:
 
525
        commands.append(command.SetTimeout(options.timeout))
 
526
 
 
527
    if options.extended_timeout:
 
528
        commands.append(
 
529
            command.SetExtendedTimeout(options.extended_timeout))
 
530
 
 
531
    if options.interval is not None:
 
532
        commands.append(command.SetInterval(options.interval))
 
533
 
 
534
    if options.approval_delay is not None:
 
535
        commands.append(
 
536
            command.SetApprovalDelay(options.approval_delay))
 
537
 
 
538
    if options.approval_duration is not None:
 
539
        commands.append(
 
540
            command.SetApprovalDuration(options.approval_duration))
 
541
 
 
542
    # If no command option has been given, show table of clients,
 
543
    # optionally verbosely
 
544
    if not commands:
 
545
        commands.append(command.PrintTable(verbose=options.verbose))
 
546
 
 
547
    return commands
 
548
 
 
549
 
 
550
class command(object):
 
551
    """A namespace for command classes"""
 
552
 
 
553
    class Base(object):
 
554
        """Abstract base class for commands"""
 
555
        def run(self, clients, bus=None, mandos=None):
 
556
            """Normal commands should implement run_on_one_client(),
 
557
but commands which want to operate on all clients at the same time can
 
558
override this run() method instead.
 
559
"""
 
560
            self.mandos = mandos
 
561
            for clientpath, properties in clients.items():
 
562
                log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
 
563
                          dbus_busname, str(clientpath))
 
564
                client = bus.get_object(dbus_busname, clientpath)
 
565
                self.run_on_one_client(client, properties)
 
566
 
 
567
 
 
568
    class IsEnabled(Base):
 
569
        def run(self, clients, bus=None, mandos=None):
 
570
            client, properties = next(iter(clients.items()))
 
571
            if self.is_enabled(client, properties):
 
572
                sys.exit(0)
 
573
            sys.exit(1)
 
574
        def is_enabled(self, client, properties):
 
575
            return properties["Enabled"]
 
576
 
 
577
 
 
578
    class Approve(Base):
 
579
        def run_on_one_client(self, client, properties):
 
580
            log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
 
581
                      client.__dbus_object_path__,
 
582
                      client_dbus_interface)
 
583
            client.Approve(dbus.Boolean(True),
 
584
                           dbus_interface=client_dbus_interface)
 
585
 
 
586
 
 
587
    class Deny(Base):
 
588
        def run_on_one_client(self, client, properties):
 
589
            log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
 
590
                      client.__dbus_object_path__,
 
591
                      client_dbus_interface)
 
592
            client.Approve(dbus.Boolean(False),
 
593
                           dbus_interface=client_dbus_interface)
 
594
 
 
595
 
 
596
    class Remove(Base):
 
597
        def run_on_one_client(self, client, properties):
 
598
            log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)",
 
599
                      dbus_busname, server_dbus_path,
 
600
                      server_dbus_interface,
 
601
                      str(client.__dbus_object_path__))
 
602
            self.mandos.RemoveClient(client.__dbus_object_path__)
 
603
 
 
604
 
 
605
    class Output(Base):
 
606
        """Abstract class for commands outputting client details"""
 
607
        all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
 
608
                        "Created", "Interval", "Host", "KeyID",
 
609
                        "Fingerprint", "CheckerRunning",
 
610
                        "LastEnabled", "ApprovalPending",
 
611
                        "ApprovedByDefault", "LastApprovalRequest",
 
612
                        "ApprovalDelay", "ApprovalDuration",
 
613
                        "Checker", "ExtendedTimeout", "Expires",
 
614
                        "LastCheckerStatus")
 
615
 
 
616
        def run(self, clients, bus=None, mandos=None):
 
617
            print(self.output(clients.values()))
 
618
 
 
619
        def output(self, clients):
 
620
            raise NotImplementedError()
 
621
 
 
622
 
 
623
    class DumpJSON(Output):
 
624
        def output(self, clients):
 
625
            data = {client["Name"]:
 
626
                    {key: self.dbus_boolean_to_bool(client[key])
 
627
                     for key in self.all_keywords}
 
628
                    for client in clients}
 
629
            return json.dumps(data, indent=4, separators=(',', ': '))
 
630
 
 
631
        @staticmethod
 
632
        def dbus_boolean_to_bool(value):
 
633
            if isinstance(value, dbus.Boolean):
 
634
                value = bool(value)
 
635
            return value
 
636
 
 
637
 
 
638
    class PrintTable(Output):
 
639
        def __init__(self, verbose=False):
 
640
            self.verbose = verbose
 
641
 
 
642
        def output(self, clients):
 
643
            default_keywords = ("Name", "Enabled", "Timeout",
 
644
                                "LastCheckedOK")
 
645
            keywords = default_keywords
 
646
            if self.verbose:
 
647
                keywords = self.all_keywords
 
648
            return str(self.TableOfClients(clients, keywords))
 
649
 
 
650
        class TableOfClients(object):
 
651
            tableheaders = {
 
652
                "Name": "Name",
 
653
                "Enabled": "Enabled",
 
654
                "Timeout": "Timeout",
 
655
                "LastCheckedOK": "Last Successful Check",
 
656
                "LastApprovalRequest": "Last Approval Request",
 
657
                "Created": "Created",
 
658
                "Interval": "Interval",
 
659
                "Host": "Host",
 
660
                "Fingerprint": "Fingerprint",
 
661
                "KeyID": "Key ID",
 
662
                "CheckerRunning": "Check Is Running",
 
663
                "LastEnabled": "Last Enabled",
 
664
                "ApprovalPending": "Approval Is Pending",
 
665
                "ApprovedByDefault": "Approved By Default",
 
666
                "ApprovalDelay": "Approval Delay",
 
667
                "ApprovalDuration": "Approval Duration",
 
668
                "Checker": "Checker",
 
669
                "ExtendedTimeout": "Extended Timeout",
 
670
                "Expires": "Expires",
 
671
                "LastCheckerStatus": "Last Checker Status",
 
672
            }
 
673
 
 
674
            def __init__(self, clients, keywords):
 
675
                self.clients = clients
 
676
                self.keywords = keywords
 
677
 
 
678
            def __str__(self):
 
679
                return "\n".join(self.rows())
 
680
 
 
681
            if sys.version_info.major == 2:
 
682
                __unicode__ = __str__
 
683
                def __str__(self):
 
684
                    return str(self).encode(
 
685
                        locale.getpreferredencoding())
 
686
 
 
687
            def rows(self):
 
688
                format_string = self.row_formatting_string()
 
689
                rows = [self.header_line(format_string)]
 
690
                rows.extend(self.client_line(client, format_string)
 
691
                            for client in self.clients)
 
692
                return rows
 
693
 
 
694
            def row_formatting_string(self):
 
695
                "Format string used to format table rows"
 
696
                return " ".join("{{{key}:{width}}}".format(
 
697
                    width=max(len(self.tableheaders[key]),
 
698
                              *(len(self.string_from_client(client,
 
699
                                                            key))
 
700
                                for client in self.clients)),
 
701
                    key=key)
 
702
                                for key in self.keywords)
 
703
 
 
704
            def string_from_client(self, client, key):
 
705
                return self.valuetostring(client[key], key)
 
706
 
 
707
            @classmethod
 
708
            def valuetostring(cls, value, keyword):
 
709
                if isinstance(value, dbus.Boolean):
 
710
                    return "Yes" if value else "No"
 
711
                if keyword in ("Timeout", "Interval", "ApprovalDelay",
 
712
                               "ApprovalDuration", "ExtendedTimeout"):
 
713
                    return cls.milliseconds_to_string(value)
 
714
                return str(value)
 
715
 
 
716
            def header_line(self, format_string):
 
717
                return format_string.format(**self.tableheaders)
 
718
 
 
719
            def client_line(self, client, format_string):
 
720
                return format_string.format(
 
721
                    **{key: self.string_from_client(client, key)
 
722
                       for key in self.keywords})
 
723
 
 
724
            @staticmethod
 
725
            def milliseconds_to_string(ms):
 
726
                td = datetime.timedelta(0, 0, 0, ms)
 
727
                return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
 
728
                        .format(days="{}T".format(td.days)
 
729
                                if td.days else "",
 
730
                                hours=td.seconds // 3600,
 
731
                                minutes=(td.seconds % 3600) // 60,
 
732
                                seconds=td.seconds % 60))
 
733
 
 
734
 
 
735
    class Property(Base):
 
736
        "Abstract class for Actions for setting one client property"
 
737
 
 
738
        def run_on_one_client(self, client, properties):
 
739
            """Set the Client's D-Bus property"""
 
740
            log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
 
741
                      client.__dbus_object_path__,
 
742
                      dbus.PROPERTIES_IFACE, client_dbus_interface,
 
743
                      self.propname, self.value_to_set
 
744
                      if not isinstance(self.value_to_set,
 
745
                                        dbus.Boolean)
 
746
                      else bool(self.value_to_set))
 
747
            client.Set(client_dbus_interface, self.propname,
 
748
                       self.value_to_set,
 
749
                       dbus_interface=dbus.PROPERTIES_IFACE)
 
750
 
 
751
        @property
 
752
        def propname(self):
 
753
            raise NotImplementedError()
 
754
 
 
755
 
 
756
    class Enable(Property):
 
757
        propname = "Enabled"
 
758
        value_to_set = dbus.Boolean(True)
 
759
 
 
760
 
 
761
    class Disable(Property):
 
762
        propname = "Enabled"
 
763
        value_to_set = dbus.Boolean(False)
 
764
 
 
765
 
 
766
    class BumpTimeout(Property):
 
767
        propname = "LastCheckedOK"
 
768
        value_to_set = ""
 
769
 
 
770
 
 
771
    class StartChecker(Property):
 
772
        propname = "CheckerRunning"
 
773
        value_to_set = dbus.Boolean(True)
 
774
 
 
775
 
 
776
    class StopChecker(Property):
 
777
        propname = "CheckerRunning"
 
778
        value_to_set = dbus.Boolean(False)
 
779
 
 
780
 
 
781
    class ApproveByDefault(Property):
 
782
        propname = "ApprovedByDefault"
 
783
        value_to_set = dbus.Boolean(True)
 
784
 
 
785
 
 
786
    class DenyByDefault(Property):
 
787
        propname = "ApprovedByDefault"
 
788
        value_to_set = dbus.Boolean(False)
 
789
 
 
790
 
 
791
    class PropertyValue(Property):
 
792
        "Abstract class for Property recieving a value as argument"
 
793
        def __init__(self, value):
 
794
            self.value_to_set = value
 
795
 
 
796
 
 
797
    class SetChecker(PropertyValue):
 
798
        propname = "Checker"
 
799
 
 
800
 
 
801
    class SetHost(PropertyValue):
 
802
        propname = "Host"
 
803
 
 
804
 
 
805
    class SetSecret(PropertyValue):
 
806
        propname = "Secret"
 
807
 
 
808
        @property
 
809
        def value_to_set(self):
 
810
            return self._vts
 
811
 
 
812
        @value_to_set.setter
 
813
        def value_to_set(self, value):
 
814
            """When setting, read data from supplied file object"""
 
815
            self._vts = value.read()
 
816
            value.close()
 
817
 
 
818
 
 
819
    class MillisecondsPropertyValueArgument(PropertyValue):
 
820
        """Abstract class for PropertyValue taking a value argument as
 
821
a datetime.timedelta() but should store it as milliseconds."""
 
822
 
 
823
        @property
 
824
        def value_to_set(self):
 
825
            return self._vts
 
826
 
 
827
        @value_to_set.setter
 
828
        def value_to_set(self, value):
 
829
            "When setting, convert value from a datetime.timedelta"
 
830
            self._vts = int(round(value.total_seconds() * 1000))
 
831
 
 
832
 
 
833
    class SetTimeout(MillisecondsPropertyValueArgument):
 
834
        propname = "Timeout"
 
835
 
 
836
 
 
837
    class SetExtendedTimeout(MillisecondsPropertyValueArgument):
 
838
        propname = "ExtendedTimeout"
 
839
 
 
840
 
 
841
    class SetInterval(MillisecondsPropertyValueArgument):
 
842
        propname = "Interval"
 
843
 
 
844
 
 
845
    class SetApprovalDelay(MillisecondsPropertyValueArgument):
 
846
        propname = "ApprovalDelay"
 
847
 
 
848
 
 
849
    class SetApprovalDuration(MillisecondsPropertyValueArgument):
 
850
        propname = "ApprovalDuration"
 
851
 
786
852
 
787
853
 
788
 
class Test_milliseconds_to_string(unittest.TestCase):
789
 
    def test_all(self):
790
 
        self.assertEqual(milliseconds_to_string(93785000),
791
 
                         "1T02:03:05")
792
 
    def test_no_days(self):
793
 
        self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
794
 
    def test_all_zero(self):
795
 
        self.assertEqual(milliseconds_to_string(0), "00:00:00")
796
 
    def test_no_fractional_seconds(self):
797
 
        self.assertEqual(milliseconds_to_string(400), "00:00:00")
798
 
        self.assertEqual(milliseconds_to_string(900), "00:00:00")
799
 
        self.assertEqual(milliseconds_to_string(1900), "00:00:01")
800
 
 
801
 
class Test_string_to_delta(unittest.TestCase):
802
 
    def test_handles_basic_rfc3339(self):
 
854
class TestCaseWithAssertLogs(unittest.TestCase):
 
855
    """unittest.TestCase.assertLogs only exists in Python 3.4"""
 
856
 
 
857
    if not hasattr(unittest.TestCase, "assertLogs"):
 
858
        @contextlib.contextmanager
 
859
        def assertLogs(self, logger, level=logging.INFO):
 
860
            capturing_handler = self.CapturingLevelHandler(level)
 
861
            old_level = logger.level
 
862
            old_propagate = logger.propagate
 
863
            logger.addHandler(capturing_handler)
 
864
            logger.setLevel(level)
 
865
            logger.propagate = False
 
866
            try:
 
867
                yield capturing_handler.watcher
 
868
            finally:
 
869
                logger.propagate = old_propagate
 
870
                logger.removeHandler(capturing_handler)
 
871
                logger.setLevel(old_level)
 
872
            self.assertGreater(len(capturing_handler.watcher.records),
 
873
                               0)
 
874
 
 
875
        class CapturingLevelHandler(logging.Handler):
 
876
            def __init__(self, level, *args, **kwargs):
 
877
                logging.Handler.__init__(self, *args, **kwargs)
 
878
                self.watcher = self.LoggingWatcher([], [])
 
879
            def emit(self, record):
 
880
                self.watcher.records.append(record)
 
881
                self.watcher.output.append(self.format(record))
 
882
 
 
883
            LoggingWatcher = collections.namedtuple("LoggingWatcher",
 
884
                                                    ("records",
 
885
                                                     "output"))
 
886
 
 
887
 
 
888
class Test_string_to_delta(TestCaseWithAssertLogs):
 
889
    # Just test basic RFC 3339 functionality here, the doc string for
 
890
    # rfc3339_duration_to_delta() already has more comprehensive
 
891
    # tests, which is run by doctest.
 
892
 
 
893
    def test_rfc3339_zero_seconds(self):
803
894
        self.assertEqual(string_to_delta("PT0S"),
804
895
                         datetime.timedelta())
 
896
 
 
897
    def test_rfc3339_zero_days(self):
805
898
        self.assertEqual(string_to_delta("P0D"),
806
899
                         datetime.timedelta())
 
900
 
 
901
    def test_rfc3339_one_second(self):
807
902
        self.assertEqual(string_to_delta("PT1S"),
808
903
                         datetime.timedelta(0, 1))
 
904
 
 
905
    def test_rfc3339_two_hours(self):
809
906
        self.assertEqual(string_to_delta("PT2H"),
810
907
                         datetime.timedelta(0, 7200))
 
908
 
811
909
    def test_falls_back_to_pre_1_6_1_with_warning(self):
812
 
        # assertLogs only exists in Python 3.4
813
 
        if hasattr(self, "assertLogs"):
814
 
            with self.assertLogs(log, logging.WARNING):
815
 
                value = string_to_delta("2h")
816
 
        else:
817
 
            class WarningFilter(logging.Filter):
818
 
                """Don't show, but record the presence of, warnings"""
819
 
                def filter(self, record):
820
 
                    is_warning = record.levelno >= logging.WARNING
821
 
                    self.found = is_warning or getattr(self, "found",
822
 
                                                       False)
823
 
                    return not is_warning
824
 
            warning_filter = WarningFilter()
825
 
            log.addFilter(warning_filter)
826
 
            try:
827
 
                value = string_to_delta("2h")
828
 
            finally:
829
 
                log.removeFilter(warning_filter)
830
 
            self.assertTrue(getattr(warning_filter, "found", False))
 
910
        with self.assertLogs(log, logging.WARNING):
 
911
            value = string_to_delta("2h")
831
912
        self.assertEqual(value, datetime.timedelta(0, 7200))
832
913
 
833
914
 
834
 
class TestCmd(unittest.TestCase):
 
915
class Test_check_option_syntax(unittest.TestCase):
 
916
    def setUp(self):
 
917
        self.parser = argparse.ArgumentParser()
 
918
        add_command_line_options(self.parser)
 
919
 
 
920
    def test_actions_requires_client_or_all(self):
 
921
        for action, value in self.actions.items():
 
922
            options = self.parser.parse_args()
 
923
            setattr(options, action, value)
 
924
            with self.assertParseError():
 
925
                self.check_option_syntax(options)
 
926
 
 
927
    # This mostly corresponds to the definition from has_actions() in
 
928
    # check_option_syntax()
 
929
    actions = {
 
930
        # The actual values set here are not that important, but we do
 
931
        # at least stick to the correct types, even though they are
 
932
        # never used
 
933
        "enable": True,
 
934
        "disable": True,
 
935
        "bump_timeout": True,
 
936
        "start_checker": True,
 
937
        "stop_checker": True,
 
938
        "is_enabled": True,
 
939
        "remove": True,
 
940
        "checker": "x",
 
941
        "timeout": datetime.timedelta(),
 
942
        "extended_timeout": datetime.timedelta(),
 
943
        "interval": datetime.timedelta(),
 
944
        "approved_by_default": True,
 
945
        "approval_delay": datetime.timedelta(),
 
946
        "approval_duration": datetime.timedelta(),
 
947
        "host": "x",
 
948
        "secret": io.BytesIO(b"x"),
 
949
        "approve": True,
 
950
        "deny": True,
 
951
    }
 
952
 
 
953
    @contextlib.contextmanager
 
954
    def assertParseError(self):
 
955
        with self.assertRaises(SystemExit) as e:
 
956
            with self.redirect_stderr_to_devnull():
 
957
                yield
 
958
        # Exit code from argparse is guaranteed to be "2".  Reference:
 
959
        # https://docs.python.org/3/library
 
960
        # /argparse.html#exiting-methods
 
961
        self.assertEqual(e.exception.code, 2)
 
962
 
 
963
    @staticmethod
 
964
    @contextlib.contextmanager
 
965
    def redirect_stderr_to_devnull():
 
966
        null = os.open(os.path.devnull, os.O_RDWR)
 
967
        stderrcopy = os.dup(sys.stderr.fileno())
 
968
        os.dup2(null, sys.stderr.fileno())
 
969
        os.close(null)
 
970
        try:
 
971
            yield
 
972
        finally:
 
973
            # restore stderr
 
974
            os.dup2(stderrcopy, sys.stderr.fileno())
 
975
            os.close(stderrcopy)
 
976
 
 
977
    def check_option_syntax(self, options):
 
978
        check_option_syntax(self.parser, options)
 
979
 
 
980
    def test_actions_all_conflicts_with_verbose(self):
 
981
        for action, value in self.actions.items():
 
982
            options = self.parser.parse_args()
 
983
            setattr(options, action, value)
 
984
            options.all = True
 
985
            options.verbose = True
 
986
            with self.assertParseError():
 
987
                self.check_option_syntax(options)
 
988
 
 
989
    def test_actions_with_client_conflicts_with_verbose(self):
 
990
        for action, value in self.actions.items():
 
991
            options = self.parser.parse_args()
 
992
            setattr(options, action, value)
 
993
            options.verbose = True
 
994
            options.client = ["foo"]
 
995
            with self.assertParseError():
 
996
                self.check_option_syntax(options)
 
997
 
 
998
    def test_dump_json_conflicts_with_verbose(self):
 
999
        options = self.parser.parse_args()
 
1000
        options.dump_json = True
 
1001
        options.verbose = True
 
1002
        with self.assertParseError():
 
1003
            self.check_option_syntax(options)
 
1004
 
 
1005
    def test_dump_json_conflicts_with_action(self):
 
1006
        for action, value in self.actions.items():
 
1007
            options = self.parser.parse_args()
 
1008
            setattr(options, action, value)
 
1009
            options.dump_json = True
 
1010
            with self.assertParseError():
 
1011
                self.check_option_syntax(options)
 
1012
 
 
1013
    def test_all_can_not_be_alone(self):
 
1014
        options = self.parser.parse_args()
 
1015
        options.all = True
 
1016
        with self.assertParseError():
 
1017
            self.check_option_syntax(options)
 
1018
 
 
1019
    def test_all_is_ok_with_any_action(self):
 
1020
        for action, value in self.actions.items():
 
1021
            options = self.parser.parse_args()
 
1022
            setattr(options, action, value)
 
1023
            options.all = True
 
1024
            self.check_option_syntax(options)
 
1025
 
 
1026
    def test_any_action_is_ok_with_one_client(self):
 
1027
        for action, value in self.actions.items():
 
1028
            options = self.parser.parse_args()
 
1029
            setattr(options, action, value)
 
1030
            options.client = ["foo"]
 
1031
            self.check_option_syntax(options)
 
1032
 
 
1033
    def test_one_client_with_all_actions_except_is_enabled(self):
 
1034
        options = self.parser.parse_args()
 
1035
        for action, value in self.actions.items():
 
1036
            if action == "is_enabled":
 
1037
                continue
 
1038
            setattr(options, action, value)
 
1039
        options.client = ["foo"]
 
1040
        self.check_option_syntax(options)
 
1041
 
 
1042
    def test_two_clients_with_all_actions_except_is_enabled(self):
 
1043
        options = self.parser.parse_args()
 
1044
        for action, value in self.actions.items():
 
1045
            if action == "is_enabled":
 
1046
                continue
 
1047
            setattr(options, action, value)
 
1048
        options.client = ["foo", "barbar"]
 
1049
        self.check_option_syntax(options)
 
1050
 
 
1051
    def test_two_clients_are_ok_with_actions_except_is_enabled(self):
 
1052
        for action, value in self.actions.items():
 
1053
            if action == "is_enabled":
 
1054
                continue
 
1055
            options = self.parser.parse_args()
 
1056
            setattr(options, action, value)
 
1057
            options.client = ["foo", "barbar"]
 
1058
            self.check_option_syntax(options)
 
1059
 
 
1060
    def test_is_enabled_fails_without_client(self):
 
1061
        options = self.parser.parse_args()
 
1062
        options.is_enabled = True
 
1063
        with self.assertParseError():
 
1064
            self.check_option_syntax(options)
 
1065
 
 
1066
    def test_is_enabled_fails_with_two_clients(self):
 
1067
        options = self.parser.parse_args()
 
1068
        options.is_enabled = True
 
1069
        options.client = ["foo", "barbar"]
 
1070
        with self.assertParseError():
 
1071
            self.check_option_syntax(options)
 
1072
 
 
1073
    def test_remove_can_only_be_combined_with_action_deny(self):
 
1074
        for action, value in self.actions.items():
 
1075
            if action in {"remove", "deny"}:
 
1076
                continue
 
1077
            options = self.parser.parse_args()
 
1078
            setattr(options, action, value)
 
1079
            options.all = True
 
1080
            options.remove = True
 
1081
            with self.assertParseError():
 
1082
                self.check_option_syntax(options)
 
1083
 
 
1084
 
 
1085
class Test_get_mandos_dbus_object(TestCaseWithAssertLogs):
 
1086
    def test_calls_and_returns_get_object_on_bus(self):
 
1087
        class MockBus(object):
 
1088
            called = False
 
1089
            def get_object(mockbus_self, busname, dbus_path):
 
1090
                # Note that "self" is still the testcase instance,
 
1091
                # this MockBus instance is in "mockbus_self".
 
1092
                self.assertEqual(busname, dbus_busname)
 
1093
                self.assertEqual(dbus_path, server_dbus_path)
 
1094
                mockbus_self.called = True
 
1095
                return mockbus_self
 
1096
 
 
1097
        mockbus = get_mandos_dbus_object(bus=MockBus())
 
1098
        self.assertIsInstance(mockbus, MockBus)
 
1099
        self.assertTrue(mockbus.called)
 
1100
 
 
1101
    def test_logs_and_exits_on_dbus_error(self):
 
1102
        class MockBusFailing(object):
 
1103
            def get_object(self, busname, dbus_path):
 
1104
                raise dbus.exceptions.DBusException("Test")
 
1105
 
 
1106
        with self.assertLogs(log, logging.CRITICAL):
 
1107
            with self.assertRaises(SystemExit) as e:
 
1108
                bus = get_mandos_dbus_object(bus=MockBusFailing())
 
1109
 
 
1110
        if isinstance(e.exception.code, int):
 
1111
            self.assertNotEqual(e.exception.code, 0)
 
1112
        else:
 
1113
            self.assertIsNotNone(e.exception.code)
 
1114
 
 
1115
 
 
1116
class Test_get_managed_objects(TestCaseWithAssertLogs):
 
1117
    def test_calls_and_returns_GetManagedObjects(self):
 
1118
        managed_objects = {"/clients/foo": { "Name": "foo"}}
 
1119
        class MockObjectManager(object):
 
1120
            def GetManagedObjects(self):
 
1121
                return managed_objects
 
1122
        retval = get_managed_objects(MockObjectManager())
 
1123
        self.assertDictEqual(managed_objects, retval)
 
1124
 
 
1125
    def test_logs_and_exits_on_dbus_error(self):
 
1126
        dbus_logger = logging.getLogger("dbus.proxies")
 
1127
 
 
1128
        class MockObjectManagerFailing(object):
 
1129
            def GetManagedObjects(self):
 
1130
                dbus_logger.error("Test")
 
1131
                raise dbus.exceptions.DBusException("Test")
 
1132
 
 
1133
        class CountingHandler(logging.Handler):
 
1134
            count = 0
 
1135
            def emit(self, record):
 
1136
                self.count += 1
 
1137
 
 
1138
        counting_handler = CountingHandler()
 
1139
 
 
1140
        dbus_logger.addHandler(counting_handler)
 
1141
 
 
1142
        try:
 
1143
            with self.assertLogs(log, logging.CRITICAL) as watcher:
 
1144
                with self.assertRaises(SystemExit) as e:
 
1145
                    get_managed_objects(MockObjectManagerFailing())
 
1146
        finally:
 
1147
            dbus_logger.removeFilter(counting_handler)
 
1148
 
 
1149
        # Make sure the dbus logger was suppressed
 
1150
        self.assertEqual(counting_handler.count, 0)
 
1151
 
 
1152
        # Test that the dbus_logger still works
 
1153
        with self.assertLogs(dbus_logger, logging.ERROR):
 
1154
            dbus_logger.error("Test")
 
1155
 
 
1156
        if isinstance(e.exception.code, int):
 
1157
            self.assertNotEqual(e.exception.code, 0)
 
1158
        else:
 
1159
            self.assertIsNotNone(e.exception.code)
 
1160
 
 
1161
 
 
1162
class Test_commands_from_options(unittest.TestCase):
 
1163
    def setUp(self):
 
1164
        self.parser = argparse.ArgumentParser()
 
1165
        add_command_line_options(self.parser)
 
1166
 
 
1167
    def test_is_enabled(self):
 
1168
        self.assert_command_from_args(["--is-enabled", "foo"],
 
1169
                                      command.IsEnabled)
 
1170
 
 
1171
    def assert_command_from_args(self, args, command_cls,
 
1172
                                 **cmd_attrs):
 
1173
        """Assert that parsing ARGS should result in an instance of
 
1174
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
 
1175
        options = self.parser.parse_args(args)
 
1176
        check_option_syntax(self.parser, options)
 
1177
        commands = commands_from_options(options)
 
1178
        self.assertEqual(len(commands), 1)
 
1179
        command = commands[0]
 
1180
        self.assertIsInstance(command, command_cls)
 
1181
        for key, value in cmd_attrs.items():
 
1182
            self.assertEqual(getattr(command, key), value)
 
1183
 
 
1184
    def test_is_enabled_short(self):
 
1185
        self.assert_command_from_args(["-V", "foo"],
 
1186
                                      command.IsEnabled)
 
1187
 
 
1188
    def test_approve(self):
 
1189
        self.assert_command_from_args(["--approve", "foo"],
 
1190
                                      command.Approve)
 
1191
 
 
1192
    def test_approve_short(self):
 
1193
        self.assert_command_from_args(["-A", "foo"], command.Approve)
 
1194
 
 
1195
    def test_deny(self):
 
1196
        self.assert_command_from_args(["--deny", "foo"], command.Deny)
 
1197
 
 
1198
    def test_deny_short(self):
 
1199
        self.assert_command_from_args(["-D", "foo"], command.Deny)
 
1200
 
 
1201
    def test_remove(self):
 
1202
        self.assert_command_from_args(["--remove", "foo"],
 
1203
                                      command.Remove)
 
1204
 
 
1205
    def test_deny_before_remove(self):
 
1206
        options = self.parser.parse_args(["--deny", "--remove",
 
1207
                                          "foo"])
 
1208
        check_option_syntax(self.parser, options)
 
1209
        commands = commands_from_options(options)
 
1210
        self.assertEqual(len(commands), 2)
 
1211
        self.assertIsInstance(commands[0], command.Deny)
 
1212
        self.assertIsInstance(commands[1], command.Remove)
 
1213
 
 
1214
    def test_deny_before_remove_reversed(self):
 
1215
        options = self.parser.parse_args(["--remove", "--deny",
 
1216
                                          "--all"])
 
1217
        check_option_syntax(self.parser, options)
 
1218
        commands = commands_from_options(options)
 
1219
        self.assertEqual(len(commands), 2)
 
1220
        self.assertIsInstance(commands[0], command.Deny)
 
1221
        self.assertIsInstance(commands[1], command.Remove)
 
1222
 
 
1223
    def test_remove_short(self):
 
1224
        self.assert_command_from_args(["-r", "foo"], command.Remove)
 
1225
 
 
1226
    def test_dump_json(self):
 
1227
        self.assert_command_from_args(["--dump-json"],
 
1228
                                      command.DumpJSON)
 
1229
 
 
1230
    def test_enable(self):
 
1231
        self.assert_command_from_args(["--enable", "foo"],
 
1232
                                      command.Enable)
 
1233
 
 
1234
    def test_enable_short(self):
 
1235
        self.assert_command_from_args(["-e", "foo"], command.Enable)
 
1236
 
 
1237
    def test_disable(self):
 
1238
        self.assert_command_from_args(["--disable", "foo"],
 
1239
                                      command.Disable)
 
1240
 
 
1241
    def test_disable_short(self):
 
1242
        self.assert_command_from_args(["-d", "foo"], command.Disable)
 
1243
 
 
1244
    def test_bump_timeout(self):
 
1245
        self.assert_command_from_args(["--bump-timeout", "foo"],
 
1246
                                      command.BumpTimeout)
 
1247
 
 
1248
    def test_bump_timeout_short(self):
 
1249
        self.assert_command_from_args(["-b", "foo"],
 
1250
                                      command.BumpTimeout)
 
1251
 
 
1252
    def test_start_checker(self):
 
1253
        self.assert_command_from_args(["--start-checker", "foo"],
 
1254
                                      command.StartChecker)
 
1255
 
 
1256
    def test_stop_checker(self):
 
1257
        self.assert_command_from_args(["--stop-checker", "foo"],
 
1258
                                      command.StopChecker)
 
1259
 
 
1260
    def test_approve_by_default(self):
 
1261
        self.assert_command_from_args(["--approve-by-default", "foo"],
 
1262
                                      command.ApproveByDefault)
 
1263
 
 
1264
    def test_deny_by_default(self):
 
1265
        self.assert_command_from_args(["--deny-by-default", "foo"],
 
1266
                                      command.DenyByDefault)
 
1267
 
 
1268
    def test_checker(self):
 
1269
        self.assert_command_from_args(["--checker", ":", "foo"],
 
1270
                                      command.SetChecker,
 
1271
                                      value_to_set=":")
 
1272
 
 
1273
    def test_checker_empty(self):
 
1274
        self.assert_command_from_args(["--checker", "", "foo"],
 
1275
                                      command.SetChecker,
 
1276
                                      value_to_set="")
 
1277
 
 
1278
    def test_checker_short(self):
 
1279
        self.assert_command_from_args(["-c", ":", "foo"],
 
1280
                                      command.SetChecker,
 
1281
                                      value_to_set=":")
 
1282
 
 
1283
    def test_host(self):
 
1284
        self.assert_command_from_args(["--host", "foo.example.org",
 
1285
                                       "foo"], command.SetHost,
 
1286
                                      value_to_set="foo.example.org")
 
1287
 
 
1288
    def test_host_short(self):
 
1289
        self.assert_command_from_args(["-H", "foo.example.org",
 
1290
                                       "foo"], command.SetHost,
 
1291
                                      value_to_set="foo.example.org")
 
1292
 
 
1293
    def test_secret_devnull(self):
 
1294
        self.assert_command_from_args(["--secret", os.path.devnull,
 
1295
                                       "foo"], command.SetSecret,
 
1296
                                      value_to_set=b"")
 
1297
 
 
1298
    def test_secret_tempfile(self):
 
1299
        with tempfile.NamedTemporaryFile(mode="r+b") as f:
 
1300
            value = b"secret\0xyzzy\nbar"
 
1301
            f.write(value)
 
1302
            f.seek(0)
 
1303
            self.assert_command_from_args(["--secret", f.name,
 
1304
                                           "foo"], command.SetSecret,
 
1305
                                          value_to_set=value)
 
1306
 
 
1307
    def test_secret_devnull_short(self):
 
1308
        self.assert_command_from_args(["-s", os.path.devnull, "foo"],
 
1309
                                      command.SetSecret,
 
1310
                                      value_to_set=b"")
 
1311
 
 
1312
    def test_secret_tempfile_short(self):
 
1313
        with tempfile.NamedTemporaryFile(mode="r+b") as f:
 
1314
            value = b"secret\0xyzzy\nbar"
 
1315
            f.write(value)
 
1316
            f.seek(0)
 
1317
            self.assert_command_from_args(["-s", f.name, "foo"],
 
1318
                                          command.SetSecret,
 
1319
                                          value_to_set=value)
 
1320
 
 
1321
    def test_timeout(self):
 
1322
        self.assert_command_from_args(["--timeout", "PT5M", "foo"],
 
1323
                                      command.SetTimeout,
 
1324
                                      value_to_set=300000)
 
1325
 
 
1326
    def test_timeout_short(self):
 
1327
        self.assert_command_from_args(["-t", "PT5M", "foo"],
 
1328
                                      command.SetTimeout,
 
1329
                                      value_to_set=300000)
 
1330
 
 
1331
    def test_extended_timeout(self):
 
1332
        self.assert_command_from_args(["--extended-timeout", "PT15M",
 
1333
                                       "foo"],
 
1334
                                      command.SetExtendedTimeout,
 
1335
                                      value_to_set=900000)
 
1336
 
 
1337
    def test_interval(self):
 
1338
        self.assert_command_from_args(["--interval", "PT2M", "foo"],
 
1339
                                      command.SetInterval,
 
1340
                                      value_to_set=120000)
 
1341
 
 
1342
    def test_interval_short(self):
 
1343
        self.assert_command_from_args(["-i", "PT2M", "foo"],
 
1344
                                      command.SetInterval,
 
1345
                                      value_to_set=120000)
 
1346
 
 
1347
    def test_approval_delay(self):
 
1348
        self.assert_command_from_args(["--approval-delay", "PT30S",
 
1349
                                       "foo"],
 
1350
                                      command.SetApprovalDelay,
 
1351
                                      value_to_set=30000)
 
1352
 
 
1353
    def test_approval_duration(self):
 
1354
        self.assert_command_from_args(["--approval-duration", "PT1S",
 
1355
                                       "foo"],
 
1356
                                      command.SetApprovalDuration,
 
1357
                                      value_to_set=1000)
 
1358
 
 
1359
    def test_print_table(self):
 
1360
        self.assert_command_from_args([], command.PrintTable,
 
1361
                                      verbose=False)
 
1362
 
 
1363
    def test_print_table_verbose(self):
 
1364
        self.assert_command_from_args(["--verbose"],
 
1365
                                      command.PrintTable,
 
1366
                                      verbose=True)
 
1367
 
 
1368
    def test_print_table_verbose_short(self):
 
1369
        self.assert_command_from_args(["-v"], command.PrintTable,
 
1370
                                      verbose=True)
 
1371
 
 
1372
 
 
1373
class TestCommand(unittest.TestCase):
835
1374
    """Abstract class for tests of command classes"""
 
1375
 
836
1376
    def setUp(self):
837
1377
        testcase = self
838
1378
        class MockClient(object):
839
1379
            def __init__(self, name, **attributes):
840
 
                self.__dbus_object_path__ = "objpath_{}".format(name)
 
1380
                self.__dbus_object_path__ = "/clients/{}".format(name)
841
1381
                self.attributes = attributes
842
1382
                self.attributes["Name"] = name
843
1383
                self.calls = []
844
 
            def Set(self, interface, property, value, dbus_interface):
845
 
                testcase.assertEqual(interface, client_interface)
846
 
                testcase.assertEqual(dbus_interface,
847
 
                                     dbus.PROPERTIES_IFACE)
848
 
                self.attributes[property] = value
849
 
            def Get(self, interface, property, dbus_interface):
850
 
                testcase.assertEqual(interface, client_interface)
851
 
                testcase.assertEqual(dbus_interface,
852
 
                                     dbus.PROPERTIES_IFACE)
853
 
                return self.attributes[property]
 
1384
            def Set(self, interface, propname, value, dbus_interface):
 
1385
                testcase.assertEqual(interface, client_dbus_interface)
 
1386
                testcase.assertEqual(dbus_interface,
 
1387
                                     dbus.PROPERTIES_IFACE)
 
1388
                self.attributes[propname] = value
854
1389
            def Approve(self, approve, dbus_interface):
855
 
                testcase.assertEqual(dbus_interface, client_interface)
 
1390
                testcase.assertEqual(dbus_interface,
 
1391
                                     client_dbus_interface)
856
1392
                self.calls.append(("Approve", (approve,
857
1393
                                               dbus_interface)))
858
1394
        self.client = MockClient(
898
1434
            ApprovedByDefault=dbus.Boolean(False),
899
1435
            LastApprovalRequest="2019-01-03T00:00:00",
900
1436
            ApprovalDelay=30000,
901
 
            ApprovalDuration=1000,
 
1437
            ApprovalDuration=93785000,
902
1438
            Checker=":",
903
1439
            ExtendedTimeout=900000,
904
1440
            Expires="2019-02-05T00:00:00",
905
1441
            LastCheckerStatus=-2)
906
1442
        self.clients =  collections.OrderedDict(
907
1443
            [
908
 
                (self.client, self.client.attributes),
909
 
                (self.other_client, self.other_client.attributes),
 
1444
                ("/clients/foo", self.client.attributes),
 
1445
                ("/clients/barbar", self.other_client.attributes),
910
1446
            ])
911
 
        self.one_client = {self.client: self.client.attributes}
912
 
 
913
 
class TestPrintTableCmd(TestCmd):
914
 
    def test_normal(self):
915
 
        output = PrintTableCmd().output(None, self.clients.values())
916
 
        expected_output = """
917
 
Name   Enabled Timeout  Last Successful Check
918
 
foo    Yes     00:05:00 2019-02-03T00:00:00  
919
 
barbar Yes     00:05:00 2019-02-04T00:00:00  
920
 
"""[1:-1]
921
 
        self.assertEqual(output, expected_output)
922
 
    def test_verbose(self):
923
 
        output = PrintTableCmd(verbose=True).output(
924
 
            None, self.clients.values())
925
 
        expected_output = """
926
 
Name   Enabled Timeout  Last Successful Check Created             Interval Host            Key ID                                                           Fingerprint                              Check Is Running Last Enabled        Approval Is Pending Approved By Default Last Approval Request Approval Delay Approval Duration Checker              Extended Timeout Expires             Last Checker Status
927
 
foo    Yes     00:05:00 2019-02-03T00:00:00   2019-01-02T00:00:00 00:02:00 foo.example.org 92ed150794387c03ce684574b1139a6594a34f895daaaf09fd8ea90a27cddb12 778827225BA7DE539C5A7CFA59CFF7CDBD9A5920 No               2019-01-03T00:00:00 No                  Yes                                       00:00:00       00:00:01          fping -q -- %(host)s 00:15:00         2019-02-04T00:00:00 0                  
928
 
barbar Yes     00:05:00 2019-02-04T00:00:00   2019-01-03T00:00:00 00:02:00 192.0.2.3       0558568eedd67d622f5c83b35a115f796ab612cff5ad227247e46c2b020f441c 3E393AEAEFB84C7E89E2F547B3A107558FCA3A27 Yes              2019-01-04T00:00:00 No                  No                  2019-01-03T00:00:00   00:00:30       00:00:01          :                    00:15:00         2019-02-05T00:00:00 -2                 
929
 
"""[1:-1]
930
 
        self.assertEqual(output, expected_output)
931
 
    def test_one_client(self):
932
 
        output = PrintTableCmd().output(None, self.one_client.values())
933
 
        expected_output = """
934
 
Name Enabled Timeout  Last Successful Check
935
 
foo  Yes     00:05:00 2019-02-03T00:00:00  
936
 
"""[1:-1]
937
 
        self.assertEqual(output, expected_output)
938
 
 
939
 
class TestDumpJSONCmd(TestCmd):
940
 
    def setUp(self):
941
 
        self.expected_json = {
942
 
            "foo": {
943
 
                "Name": "foo",
944
 
                "KeyID": ("92ed150794387c03ce684574b1139a65"
945
 
                          "94a34f895daaaf09fd8ea90a27cddb12"),
946
 
                "Host": "foo.example.org",
947
 
                "Enabled": True,
948
 
                "Timeout": 300000,
949
 
                "LastCheckedOK": "2019-02-03T00:00:00",
950
 
                "Created": "2019-01-02T00:00:00",
951
 
                "Interval": 120000,
952
 
                "Fingerprint": ("778827225BA7DE539C5A"
953
 
                                "7CFA59CFF7CDBD9A5920"),
954
 
                "CheckerRunning": False,
955
 
                "LastEnabled": "2019-01-03T00:00:00",
956
 
                "ApprovalPending": False,
957
 
                "ApprovedByDefault": True,
958
 
                "LastApprovalRequest": "",
959
 
                "ApprovalDelay": 0,
960
 
                "ApprovalDuration": 1000,
961
 
                "Checker": "fping -q -- %(host)s",
962
 
                "ExtendedTimeout": 900000,
963
 
                "Expires": "2019-02-04T00:00:00",
964
 
                "LastCheckerStatus": 0,
965
 
            },
966
 
            "barbar": {
967
 
                "Name": "barbar",
968
 
                "KeyID": ("0558568eedd67d622f5c83b35a115f79"
969
 
                          "6ab612cff5ad227247e46c2b020f441c"),
970
 
                "Host": "192.0.2.3",
971
 
                "Enabled": True,
972
 
                "Timeout": 300000,
973
 
                "LastCheckedOK": "2019-02-04T00:00:00",
974
 
                "Created": "2019-01-03T00:00:00",
975
 
                "Interval": 120000,
976
 
                "Fingerprint": ("3E393AEAEFB84C7E89E2"
977
 
                                "F547B3A107558FCA3A27"),
978
 
                "CheckerRunning": True,
979
 
                "LastEnabled": "2019-01-04T00:00:00",
980
 
                "ApprovalPending": False,
981
 
                "ApprovedByDefault": False,
982
 
                "LastApprovalRequest": "2019-01-03T00:00:00",
983
 
                "ApprovalDelay": 30000,
984
 
                "ApprovalDuration": 1000,
985
 
                "Checker": ":",
986
 
                "ExtendedTimeout": 900000,
987
 
                "Expires": "2019-02-05T00:00:00",
988
 
                "LastCheckerStatus": -2,
989
 
            },
990
 
        }
991
 
        return super(TestDumpJSONCmd, self).setUp()
992
 
    def test_normal(self):
993
 
        json_data = json.loads(DumpJSONCmd().output(None,
994
 
                                                    self.clients))
995
 
        self.assertDictEqual(json_data, self.expected_json)
996
 
    def test_one_client(self):
997
 
        clients = self.one_client
998
 
        json_data = json.loads(DumpJSONCmd().output(None, clients))
999
 
        expected_json = {"foo": self.expected_json["foo"]}
1000
 
        self.assertDictEqual(json_data, expected_json)
1001
 
 
1002
 
class TestIsEnabledCmd(TestCmd):
1003
 
    def test_is_enabled(self):
1004
 
        self.assertTrue(all(IsEnabledCmd().is_enabled(client, properties)
1005
 
                            for client, properties in self.clients.items()))
1006
 
    def test_is_enabled_run_exits_successfully(self):
 
1447
        self.one_client = {"/clients/foo": self.client.attributes}
 
1448
 
 
1449
    @property
 
1450
    def bus(self):
 
1451
        class Bus(object):
 
1452
            @staticmethod
 
1453
            def get_object(client_bus_name, path):
 
1454
                self.assertEqual(client_bus_name, dbus_busname)
 
1455
                return {
 
1456
                    # Note: "self" here is the TestCmd instance, not
 
1457
                    # the Bus instance, since this is a static method!
 
1458
                    "/clients/foo": self.client,
 
1459
                    "/clients/barbar": self.other_client,
 
1460
                }[path]
 
1461
        return Bus()
 
1462
 
 
1463
 
 
1464
class TestBaseCommands(TestCommand):
 
1465
 
 
1466
    def test_IsEnabled(self):
 
1467
        self.assertTrue(all(command.IsEnabled().is_enabled(client,
 
1468
                                                      properties)
 
1469
                            for client, properties
 
1470
                            in self.clients.items()))
 
1471
 
 
1472
    def test_IsEnabled_run_exits_successfully(self):
1007
1473
        with self.assertRaises(SystemExit) as e:
1008
 
            IsEnabledCmd().run(None, None, self.one_client)
 
1474
            command.IsEnabled().run(self.one_client)
1009
1475
        if e.exception.code is not None:
1010
1476
            self.assertEqual(e.exception.code, 0)
1011
1477
        else:
1012
1478
            self.assertIsNone(e.exception.code)
1013
 
    def test_is_enabled_run_exits_with_failure(self):
 
1479
 
 
1480
    def test_IsEnabled_run_exits_with_failure(self):
1014
1481
        self.client.attributes["Enabled"] = dbus.Boolean(False)
1015
1482
        with self.assertRaises(SystemExit) as e:
1016
 
            IsEnabledCmd().run(None, None, self.one_client)
 
1483
            command.IsEnabled().run(self.one_client)
1017
1484
        if isinstance(e.exception.code, int):
1018
1485
            self.assertNotEqual(e.exception.code, 0)
1019
1486
        else:
1020
1487
            self.assertIsNotNone(e.exception.code)
1021
1488
 
1022
 
class TestRemoveCmd(TestCmd):
1023
 
    def test_remove(self):
 
1489
    def test_Approve(self):
 
1490
        command.Approve().run(self.clients, self.bus)
 
1491
        for clientpath in self.clients:
 
1492
            client = self.bus.get_object(dbus_busname, clientpath)
 
1493
            self.assertIn(("Approve", (True, client_dbus_interface)),
 
1494
                          client.calls)
 
1495
 
 
1496
    def test_Deny(self):
 
1497
        command.Deny().run(self.clients, self.bus)
 
1498
        for clientpath in self.clients:
 
1499
            client = self.bus.get_object(dbus_busname, clientpath)
 
1500
            self.assertIn(("Approve", (False, client_dbus_interface)),
 
1501
                          client.calls)
 
1502
 
 
1503
    def test_Remove(self):
1024
1504
        class MockMandos(object):
1025
1505
            def __init__(self):
1026
1506
                self.calls = []
1027
1507
            def RemoveClient(self, dbus_path):
1028
1508
                self.calls.append(("RemoveClient", (dbus_path,)))
1029
1509
        mandos = MockMandos()
1030
 
        super(TestRemoveCmd, self).setUp()
1031
 
        RemoveCmd().run(mandos, None, self.clients)
1032
 
        self.assertEqual(len(mandos.calls), 2)
1033
 
        for client in self.clients:
1034
 
            self.assertIn(("RemoveClient",
1035
 
                           (client.__dbus_object_path__,)),
 
1510
        command.Remove().run(self.clients, self.bus, mandos)
 
1511
        for clientpath in self.clients:
 
1512
            self.assertIn(("RemoveClient", (clientpath,)),
1036
1513
                          mandos.calls)
1037
1514
 
1038
 
class TestApproveCmd(TestCmd):
1039
 
    def test_approve(self):
1040
 
        ApproveCmd().run(None, None, self.clients)
1041
 
        for client in self.clients:
1042
 
            self.assertIn(("Approve", (True, client_interface)),
1043
 
                          client.calls)
1044
 
 
1045
 
class TestDenyCmd(TestCmd):
1046
 
    def test_deny(self):
1047
 
        DenyCmd().run(None, None, self.clients)
1048
 
        for client in self.clients:
1049
 
            self.assertIn(("Approve", (False, client_interface)),
1050
 
                          client.calls)
1051
 
 
1052
 
class TestEnableCmd(TestCmd):
1053
 
    def test_enable(self):
1054
 
        for client in self.clients:
1055
 
            client.attributes["Enabled"] = False
1056
 
 
1057
 
        EnableCmd().run(None, None, self.clients)
1058
 
 
1059
 
        for client in self.clients:
1060
 
            self.assertTrue(client.attributes["Enabled"])
1061
 
 
1062
 
class TestDisableCmd(TestCmd):
1063
 
    def test_disable(self):
1064
 
        DisableCmd().run(None, None, self.clients)
1065
 
 
1066
 
        for client in self.clients:
1067
 
            self.assertFalse(client.attributes["Enabled"])
1068
 
 
1069
 
class Unique(object):
1070
 
    """Class for objects which exist only to be unique objects, since
1071
 
unittest.mock.sentinel only exists in Python 3.3"""
1072
 
 
1073
 
class TestPropertyCmd(TestCmd):
1074
 
    """Abstract class for tests of PropertyCmd classes"""
 
1515
    expected_json = {
 
1516
        "foo": {
 
1517
            "Name": "foo",
 
1518
            "KeyID": ("92ed150794387c03ce684574b1139a65"
 
1519
                      "94a34f895daaaf09fd8ea90a27cddb12"),
 
1520
            "Host": "foo.example.org",
 
1521
            "Enabled": True,
 
1522
            "Timeout": 300000,
 
1523
            "LastCheckedOK": "2019-02-03T00:00:00",
 
1524
            "Created": "2019-01-02T00:00:00",
 
1525
            "Interval": 120000,
 
1526
            "Fingerprint": ("778827225BA7DE539C5A"
 
1527
                            "7CFA59CFF7CDBD9A5920"),
 
1528
            "CheckerRunning": False,
 
1529
            "LastEnabled": "2019-01-03T00:00:00",
 
1530
            "ApprovalPending": False,
 
1531
            "ApprovedByDefault": True,
 
1532
            "LastApprovalRequest": "",
 
1533
            "ApprovalDelay": 0,
 
1534
            "ApprovalDuration": 1000,
 
1535
            "Checker": "fping -q -- %(host)s",
 
1536
            "ExtendedTimeout": 900000,
 
1537
            "Expires": "2019-02-04T00:00:00",
 
1538
            "LastCheckerStatus": 0,
 
1539
        },
 
1540
        "barbar": {
 
1541
            "Name": "barbar",
 
1542
            "KeyID": ("0558568eedd67d622f5c83b35a115f79"
 
1543
                      "6ab612cff5ad227247e46c2b020f441c"),
 
1544
            "Host": "192.0.2.3",
 
1545
            "Enabled": True,
 
1546
            "Timeout": 300000,
 
1547
            "LastCheckedOK": "2019-02-04T00:00:00",
 
1548
            "Created": "2019-01-03T00:00:00",
 
1549
            "Interval": 120000,
 
1550
            "Fingerprint": ("3E393AEAEFB84C7E89E2"
 
1551
                            "F547B3A107558FCA3A27"),
 
1552
            "CheckerRunning": True,
 
1553
            "LastEnabled": "2019-01-04T00:00:00",
 
1554
            "ApprovalPending": False,
 
1555
            "ApprovedByDefault": False,
 
1556
            "LastApprovalRequest": "2019-01-03T00:00:00",
 
1557
            "ApprovalDelay": 30000,
 
1558
            "ApprovalDuration": 93785000,
 
1559
            "Checker": ":",
 
1560
            "ExtendedTimeout": 900000,
 
1561
            "Expires": "2019-02-05T00:00:00",
 
1562
            "LastCheckerStatus": -2,
 
1563
        },
 
1564
    }
 
1565
 
 
1566
    def test_DumpJSON_normal(self):
 
1567
        output = command.DumpJSON().output(self.clients.values())
 
1568
        json_data = json.loads(output)
 
1569
        self.assertDictEqual(json_data, self.expected_json)
 
1570
 
 
1571
    def test_DumpJSON_one_client(self):
 
1572
        output = command.DumpJSON().output(self.one_client.values())
 
1573
        json_data = json.loads(output)
 
1574
        expected_json = {"foo": self.expected_json["foo"]}
 
1575
        self.assertDictEqual(json_data, expected_json)
 
1576
 
 
1577
    def test_PrintTable_normal(self):
 
1578
        output = command.PrintTable().output(self.clients.values())
 
1579
        expected_output = "\n".join((
 
1580
            "Name   Enabled Timeout  Last Successful Check",
 
1581
            "foo    Yes     00:05:00 2019-02-03T00:00:00  ",
 
1582
            "barbar Yes     00:05:00 2019-02-04T00:00:00  ",
 
1583
        ))
 
1584
        self.assertEqual(output, expected_output)
 
1585
 
 
1586
    def test_PrintTable_verbose(self):
 
1587
        output = command.PrintTable(verbose=True).output(
 
1588
            self.clients.values())
 
1589
        columns = (
 
1590
            (
 
1591
                "Name   ",
 
1592
                "foo    ",
 
1593
                "barbar ",
 
1594
            ),(
 
1595
                "Enabled ",
 
1596
                "Yes     ",
 
1597
                "Yes     ",
 
1598
            ),(
 
1599
                "Timeout  ",
 
1600
                "00:05:00 ",
 
1601
                "00:05:00 ",
 
1602
            ),(
 
1603
                "Last Successful Check ",
 
1604
                "2019-02-03T00:00:00   ",
 
1605
                "2019-02-04T00:00:00   ",
 
1606
            ),(
 
1607
                "Created             ",
 
1608
                "2019-01-02T00:00:00 ",
 
1609
                "2019-01-03T00:00:00 ",
 
1610
            ),(
 
1611
                "Interval ",
 
1612
                "00:02:00 ",
 
1613
                "00:02:00 ",
 
1614
            ),(
 
1615
                "Host            ",
 
1616
                "foo.example.org ",
 
1617
                "192.0.2.3       ",
 
1618
            ),(
 
1619
                ("Key ID                                             "
 
1620
                 "              "),
 
1621
                ("92ed150794387c03ce684574b1139a6594a34f895daaaf09fd8"
 
1622
                 "ea90a27cddb12 "),
 
1623
                ("0558568eedd67d622f5c83b35a115f796ab612cff5ad227247e"
 
1624
                 "46c2b020f441c "),
 
1625
            ),(
 
1626
                "Fingerprint                              ",
 
1627
                "778827225BA7DE539C5A7CFA59CFF7CDBD9A5920 ",
 
1628
                "3E393AEAEFB84C7E89E2F547B3A107558FCA3A27 ",
 
1629
            ),(
 
1630
                "Check Is Running ",
 
1631
                "No               ",
 
1632
                "Yes              ",
 
1633
            ),(
 
1634
                "Last Enabled        ",
 
1635
                "2019-01-03T00:00:00 ",
 
1636
                "2019-01-04T00:00:00 ",
 
1637
            ),(
 
1638
                "Approval Is Pending ",
 
1639
                "No                  ",
 
1640
                "No                  ",
 
1641
            ),(
 
1642
                "Approved By Default ",
 
1643
                "Yes                 ",
 
1644
                "No                  ",
 
1645
            ),(
 
1646
                "Last Approval Request ",
 
1647
                "                      ",
 
1648
                "2019-01-03T00:00:00   ",
 
1649
            ),(
 
1650
                "Approval Delay ",
 
1651
                "00:00:00       ",
 
1652
                "00:00:30       ",
 
1653
            ),(
 
1654
                "Approval Duration ",
 
1655
                "00:00:01          ",
 
1656
                "1T02:03:05        ",
 
1657
            ),(
 
1658
                "Checker              ",
 
1659
                "fping -q -- %(host)s ",
 
1660
                ":                    ",
 
1661
            ),(
 
1662
                "Extended Timeout ",
 
1663
                "00:15:00         ",
 
1664
                "00:15:00         ",
 
1665
            ),(
 
1666
                "Expires             ",
 
1667
                "2019-02-04T00:00:00 ",
 
1668
                "2019-02-05T00:00:00 ",
 
1669
            ),(
 
1670
                "Last Checker Status",
 
1671
                "0                  ",
 
1672
                "-2                 ",
 
1673
            )
 
1674
        )
 
1675
        num_lines = max(len(rows) for rows in columns)
 
1676
        expected_output = "\n".join("".join(rows[line]
 
1677
                                            for rows in columns)
 
1678
                                    for line in range(num_lines))
 
1679
        self.assertEqual(output, expected_output)
 
1680
 
 
1681
    def test_PrintTable_one_client(self):
 
1682
        output = command.PrintTable().output(self.one_client.values())
 
1683
        expected_output = "\n".join((
 
1684
            "Name Enabled Timeout  Last Successful Check",
 
1685
            "foo  Yes     00:05:00 2019-02-03T00:00:00  ",
 
1686
        ))
 
1687
        self.assertEqual(output, expected_output)
 
1688
 
 
1689
 
 
1690
class TestPropertyCmd(TestCommand):
 
1691
    """Abstract class for tests of command.Property classes"""
1075
1692
    def runTest(self):
1076
1693
        if not hasattr(self, "command"):
1077
1694
            return
1079
1696
                                self.values_to_set)
1080
1697
        for value_to_set, value_to_get in zip(self.values_to_set,
1081
1698
                                              values_to_get):
1082
 
            for client in self.clients:
1083
 
                old_value = client.attributes[self.property]
1084
 
                self.assertNotIsInstance(old_value, Unique)
1085
 
                client.attributes[self.property] = Unique()
 
1699
            for clientpath in self.clients:
 
1700
                client = self.bus.get_object(dbus_busname, clientpath)
 
1701
                old_value = client.attributes[self.propname]
 
1702
                client.attributes[self.propname] = self.Unique()
1086
1703
            self.run_command(value_to_set, self.clients)
1087
 
            for client in self.clients:
1088
 
                value = client.attributes[self.property]
1089
 
                self.assertNotIsInstance(value, Unique)
 
1704
            for clientpath in self.clients:
 
1705
                client = self.bus.get_object(dbus_busname, clientpath)
 
1706
                value = client.attributes[self.propname]
 
1707
                self.assertNotIsInstance(value, self.Unique)
1090
1708
                self.assertEqual(value, value_to_get)
 
1709
 
 
1710
    class Unique(object):
 
1711
        """Class for objects which exist only to be unique objects,
 
1712
since unittest.mock.sentinel only exists in Python 3.3"""
 
1713
 
1091
1714
    def run_command(self, value, clients):
1092
 
        self.command().run(None, None, clients)
 
1715
        self.command().run(clients, self.bus)
 
1716
 
 
1717
 
 
1718
class TestEnableCmd(TestPropertyCmd):
 
1719
    command = command.Enable
 
1720
    propname = "Enabled"
 
1721
    values_to_set = [dbus.Boolean(True)]
 
1722
 
 
1723
 
 
1724
class TestDisableCmd(TestPropertyCmd):
 
1725
    command = command.Disable
 
1726
    propname = "Enabled"
 
1727
    values_to_set = [dbus.Boolean(False)]
 
1728
 
1093
1729
 
1094
1730
class TestBumpTimeoutCmd(TestPropertyCmd):
1095
 
    command = BumpTimeoutCmd
1096
 
    property = "LastCheckedOK"
 
1731
    command = command.BumpTimeout
 
1732
    propname = "LastCheckedOK"
1097
1733
    values_to_set = [""]
1098
1734
 
 
1735
 
1099
1736
class TestStartCheckerCmd(TestPropertyCmd):
1100
 
    command = StartCheckerCmd
1101
 
    property = "CheckerRunning"
 
1737
    command = command.StartChecker
 
1738
    propname = "CheckerRunning"
1102
1739
    values_to_set = [dbus.Boolean(True)]
1103
1740
 
 
1741
 
1104
1742
class TestStopCheckerCmd(TestPropertyCmd):
1105
 
    command = StopCheckerCmd
1106
 
    property = "CheckerRunning"
 
1743
    command = command.StopChecker
 
1744
    propname = "CheckerRunning"
1107
1745
    values_to_set = [dbus.Boolean(False)]
1108
1746
 
 
1747
 
1109
1748
class TestApproveByDefaultCmd(TestPropertyCmd):
1110
 
    command = ApproveByDefaultCmd
1111
 
    property = "ApprovedByDefault"
 
1749
    command = command.ApproveByDefault
 
1750
    propname = "ApprovedByDefault"
1112
1751
    values_to_set = [dbus.Boolean(True)]
1113
1752
 
 
1753
 
1114
1754
class TestDenyByDefaultCmd(TestPropertyCmd):
1115
 
    command = DenyByDefaultCmd
1116
 
    property = "ApprovedByDefault"
 
1755
    command = command.DenyByDefault
 
1756
    propname = "ApprovedByDefault"
1117
1757
    values_to_set = [dbus.Boolean(False)]
1118
1758
 
1119
 
class TestValueArgumentPropertyCmd(TestPropertyCmd):
1120
 
    """Abstract class for tests of PropertyCmd classes using the
1121
 
ValueArgumentMixIn"""
 
1759
 
 
1760
class TestPropertyValueCmd(TestPropertyCmd):
 
1761
    """Abstract class for tests of PropertyValueCmd classes"""
 
1762
 
1122
1763
    def runTest(self):
1123
 
        if type(self) is TestValueArgumentPropertyCmd:
 
1764
        if type(self) is TestPropertyValueCmd:
1124
1765
            return
1125
 
        return super(TestValueArgumentPropertyCmd, self).runTest()
 
1766
        return super(TestPropertyValueCmd, self).runTest()
 
1767
 
1126
1768
    def run_command(self, value, clients):
1127
 
        self.command(value).run(None, None, clients)
1128
 
 
1129
 
class TestSetCheckerCmd(TestValueArgumentPropertyCmd):
1130
 
    command = SetCheckerCmd
1131
 
    property = "Checker"
 
1769
        self.command(value).run(clients, self.bus)
 
1770
 
 
1771
 
 
1772
class TestSetCheckerCmd(TestPropertyValueCmd):
 
1773
    command = command.SetChecker
 
1774
    propname = "Checker"
1132
1775
    values_to_set = ["", ":", "fping -q -- %s"]
1133
1776
 
1134
 
class TestSetHostCmd(TestValueArgumentPropertyCmd):
1135
 
    command = SetHostCmd
1136
 
    property = "Host"
 
1777
 
 
1778
class TestSetHostCmd(TestPropertyValueCmd):
 
1779
    command = command.SetHost
 
1780
    propname = "Host"
1137
1781
    values_to_set = ["192.0.2.3", "foo.example.org"]
1138
1782
 
1139
 
class TestSetSecretCmd(TestValueArgumentPropertyCmd):
1140
 
    command = SetSecretCmd
1141
 
    property = "Secret"
 
1783
 
 
1784
class TestSetSecretCmd(TestPropertyValueCmd):
 
1785
    command = command.SetSecret
 
1786
    propname = "Secret"
1142
1787
    values_to_set = [io.BytesIO(b""),
1143
1788
                     io.BytesIO(b"secret\0xyzzy\nbar")]
1144
1789
    values_to_get = [b"", b"secret\0xyzzy\nbar"]
1145
1790
 
1146
 
class TestSetTimeoutCmd(TestValueArgumentPropertyCmd):
1147
 
    command = SetTimeoutCmd
1148
 
    property = "Timeout"
1149
 
    values_to_set = [datetime.timedelta(),
1150
 
                     datetime.timedelta(minutes=5),
1151
 
                     datetime.timedelta(seconds=1),
1152
 
                     datetime.timedelta(weeks=1),
1153
 
                     datetime.timedelta(weeks=52)]
1154
 
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1155
 
 
1156
 
class TestSetExtendedTimeoutCmd(TestValueArgumentPropertyCmd):
1157
 
    command = SetExtendedTimeoutCmd
1158
 
    property = "ExtendedTimeout"
1159
 
    values_to_set = [datetime.timedelta(),
1160
 
                     datetime.timedelta(minutes=5),
1161
 
                     datetime.timedelta(seconds=1),
1162
 
                     datetime.timedelta(weeks=1),
1163
 
                     datetime.timedelta(weeks=52)]
1164
 
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1165
 
 
1166
 
class TestSetIntervalCmd(TestValueArgumentPropertyCmd):
1167
 
    command = SetIntervalCmd
1168
 
    property = "Interval"
1169
 
    values_to_set = [datetime.timedelta(),
1170
 
                     datetime.timedelta(minutes=5),
1171
 
                     datetime.timedelta(seconds=1),
1172
 
                     datetime.timedelta(weeks=1),
1173
 
                     datetime.timedelta(weeks=52)]
1174
 
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1175
 
 
1176
 
class TestSetApprovalDelayCmd(TestValueArgumentPropertyCmd):
1177
 
    command = SetApprovalDelayCmd
1178
 
    property = "ApprovalDelay"
1179
 
    values_to_set = [datetime.timedelta(),
1180
 
                     datetime.timedelta(minutes=5),
1181
 
                     datetime.timedelta(seconds=1),
1182
 
                     datetime.timedelta(weeks=1),
1183
 
                     datetime.timedelta(weeks=52)]
1184
 
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1185
 
 
1186
 
class TestSetApprovalDurationCmd(TestValueArgumentPropertyCmd):
1187
 
    command = SetApprovalDurationCmd
1188
 
    property = "ApprovalDuration"
1189
 
    values_to_set = [datetime.timedelta(),
1190
 
                     datetime.timedelta(minutes=5),
1191
 
                     datetime.timedelta(seconds=1),
1192
 
                     datetime.timedelta(weeks=1),
1193
 
                     datetime.timedelta(weeks=52)]
1194
 
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1195
 
 
1196
 
class Test_command_from_options(unittest.TestCase):
1197
 
    def setUp(self):
1198
 
        self.parser = argparse.ArgumentParser()
1199
 
        add_command_line_options(self.parser)
1200
 
    def assert_command_from_args(self, args, command_cls, **cmd_attrs):
1201
 
        """Assert that parsing ARGS should result in an instance of
1202
 
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
1203
 
        options = self.parser.parse_args(args)
1204
 
        check_option_syntax(self.parser, options)
1205
 
        commands = commands_from_options(options)
1206
 
        self.assertEqual(len(commands), 1)
1207
 
        command = commands[0]
1208
 
        self.assertIsInstance(command, command_cls)
1209
 
        for key, value in cmd_attrs.items():
1210
 
            self.assertEqual(getattr(command, key), value)
1211
 
    def test_print_table(self):
1212
 
        self.assert_command_from_args([], PrintTableCmd,
1213
 
                                      verbose=False)
1214
 
 
1215
 
    def test_print_table_verbose(self):
1216
 
        self.assert_command_from_args(["--verbose"], PrintTableCmd,
1217
 
                                      verbose=True)
1218
 
 
1219
 
    def test_print_table_verbose_short(self):
1220
 
        self.assert_command_from_args(["-v"], PrintTableCmd,
1221
 
                                      verbose=True)
1222
 
 
1223
 
    def test_enable(self):
1224
 
        self.assert_command_from_args(["--enable", "foo"], EnableCmd)
1225
 
 
1226
 
    def test_enable_short(self):
1227
 
        self.assert_command_from_args(["-e", "foo"], EnableCmd)
1228
 
 
1229
 
    def test_disable(self):
1230
 
        self.assert_command_from_args(["--disable", "foo"],
1231
 
                                      DisableCmd)
1232
 
 
1233
 
    def test_disable_short(self):
1234
 
        self.assert_command_from_args(["-d", "foo"], DisableCmd)
1235
 
 
1236
 
    def test_bump_timeout(self):
1237
 
        self.assert_command_from_args(["--bump-timeout", "foo"],
1238
 
                                      BumpTimeoutCmd)
1239
 
 
1240
 
    def test_bump_timeout_short(self):
1241
 
        self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
1242
 
 
1243
 
    def test_start_checker(self):
1244
 
        self.assert_command_from_args(["--start-checker", "foo"],
1245
 
                                      StartCheckerCmd)
1246
 
 
1247
 
    def test_stop_checker(self):
1248
 
        self.assert_command_from_args(["--stop-checker", "foo"],
1249
 
                                      StopCheckerCmd)
1250
 
 
1251
 
    def test_remove(self):
1252
 
        self.assert_command_from_args(["--remove", "foo"],
1253
 
                                      RemoveCmd)
1254
 
 
1255
 
    def test_remove_short(self):
1256
 
        self.assert_command_from_args(["-r", "foo"], RemoveCmd)
1257
 
 
1258
 
    def test_checker(self):
1259
 
        self.assert_command_from_args(["--checker", ":", "foo"],
1260
 
                                      SetCheckerCmd, value_to_set=":")
1261
 
 
1262
 
    def test_checker_empty(self):
1263
 
        self.assert_command_from_args(["--checker", "", "foo"],
1264
 
                                      SetCheckerCmd, value_to_set="")
1265
 
 
1266
 
    def test_checker_short(self):
1267
 
        self.assert_command_from_args(["-c", ":", "foo"],
1268
 
                                      SetCheckerCmd, value_to_set=":")
1269
 
 
1270
 
    def test_timeout(self):
1271
 
        self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1272
 
                                      SetTimeoutCmd,
1273
 
                                      value_to_set=300000)
1274
 
 
1275
 
    def test_timeout_short(self):
1276
 
        self.assert_command_from_args(["-t", "PT5M", "foo"],
1277
 
                                      SetTimeoutCmd,
1278
 
                                      value_to_set=300000)
1279
 
 
1280
 
    def test_extended_timeout(self):
1281
 
        self.assert_command_from_args(["--extended-timeout", "PT15M",
1282
 
                                       "foo"],
1283
 
                                      SetExtendedTimeoutCmd,
1284
 
                                      value_to_set=900000)
1285
 
 
1286
 
    def test_interval(self):
1287
 
        self.assert_command_from_args(["--interval", "PT2M", "foo"],
1288
 
                                      SetIntervalCmd,
1289
 
                                      value_to_set=120000)
1290
 
 
1291
 
    def test_interval_short(self):
1292
 
        self.assert_command_from_args(["-i", "PT2M", "foo"],
1293
 
                                      SetIntervalCmd,
1294
 
                                      value_to_set=120000)
1295
 
 
1296
 
    def test_approve_by_default(self):
1297
 
        self.assert_command_from_args(["--approve-by-default", "foo"],
1298
 
                                      ApproveByDefaultCmd)
1299
 
 
1300
 
    def test_deny_by_default(self):
1301
 
        self.assert_command_from_args(["--deny-by-default", "foo"],
1302
 
                                      DenyByDefaultCmd)
1303
 
 
1304
 
    def test_approval_delay(self):
1305
 
        self.assert_command_from_args(["--approval-delay", "PT30S",
1306
 
                                       "foo"], SetApprovalDelayCmd,
1307
 
                                      value_to_set=30000)
1308
 
 
1309
 
    def test_approval_duration(self):
1310
 
        self.assert_command_from_args(["--approval-duration", "PT1S",
1311
 
                                       "foo"], SetApprovalDurationCmd,
1312
 
                                      value_to_set=1000)
1313
 
 
1314
 
    def test_host(self):
1315
 
        self.assert_command_from_args(["--host", "foo.example.org",
1316
 
                                       "foo"], SetHostCmd,
1317
 
                                      value_to_set="foo.example.org")
1318
 
 
1319
 
    def test_host_short(self):
1320
 
        self.assert_command_from_args(["-H", "foo.example.org",
1321
 
                                       "foo"], SetHostCmd,
1322
 
                                      value_to_set="foo.example.org")
1323
 
 
1324
 
    def test_secret_devnull(self):
1325
 
        self.assert_command_from_args(["--secret", os.path.devnull,
1326
 
                                       "foo"], SetSecretCmd,
1327
 
                                      value_to_set=b"")
1328
 
 
1329
 
    def test_secret_tempfile(self):
1330
 
        with tempfile.NamedTemporaryFile(mode="r+b") as f:
1331
 
            value = b"secret\0xyzzy\nbar"
1332
 
            f.write(value)
1333
 
            f.seek(0)
1334
 
            self.assert_command_from_args(["--secret", f.name,
1335
 
                                           "foo"], SetSecretCmd,
1336
 
                                          value_to_set=value)
1337
 
 
1338
 
    def test_secret_devnull_short(self):
1339
 
        self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1340
 
                                      SetSecretCmd, value_to_set=b"")
1341
 
 
1342
 
    def test_secret_tempfile_short(self):
1343
 
        with tempfile.NamedTemporaryFile(mode="r+b") as f:
1344
 
            value = b"secret\0xyzzy\nbar"
1345
 
            f.write(value)
1346
 
            f.seek(0)
1347
 
            self.assert_command_from_args(["-s", f.name, "foo"],
1348
 
                                          SetSecretCmd,
1349
 
                                          value_to_set=value)
1350
 
 
1351
 
    def test_approve(self):
1352
 
        self.assert_command_from_args(["--approve", "foo"],
1353
 
                                      ApproveCmd)
1354
 
 
1355
 
    def test_approve_short(self):
1356
 
        self.assert_command_from_args(["-A", "foo"], ApproveCmd)
1357
 
 
1358
 
    def test_deny(self):
1359
 
        self.assert_command_from_args(["--deny", "foo"], DenyCmd)
1360
 
 
1361
 
    def test_deny_short(self):
1362
 
        self.assert_command_from_args(["-D", "foo"], DenyCmd)
1363
 
 
1364
 
    def test_dump_json(self):
1365
 
        self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
1366
 
 
1367
 
    def test_is_enabled(self):
1368
 
        self.assert_command_from_args(["--is-enabled", "foo"],
1369
 
                                      IsEnabledCmd)
1370
 
 
1371
 
    def test_is_enabled_short(self):
1372
 
        self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
1373
 
 
1374
 
    def test_deny_before_remove(self):
1375
 
        options = self.parser.parse_args(["--deny", "--remove", "foo"])
1376
 
        check_option_syntax(self.parser, options)
1377
 
        commands = commands_from_options(options)
1378
 
        self.assertEqual(len(commands), 2)
1379
 
        self.assertIsInstance(commands[0], DenyCmd)
1380
 
        self.assertIsInstance(commands[1], RemoveCmd)
1381
 
 
1382
 
    def test_deny_before_remove_reversed(self):
1383
 
        options = self.parser.parse_args(["--remove", "--deny", "--all"])
1384
 
        check_option_syntax(self.parser, options)
1385
 
        commands = commands_from_options(options)
1386
 
        self.assertEqual(len(commands), 2)
1387
 
        self.assertIsInstance(commands[0], DenyCmd)
1388
 
        self.assertIsInstance(commands[1], RemoveCmd)
1389
 
 
1390
 
 
1391
 
class Test_check_option_syntax(unittest.TestCase):
1392
 
    # This mostly corresponds to the definition from has_actions() in
1393
 
    # check_option_syntax()
1394
 
    actions = {
1395
 
        # The actual values set here are not that important, but we do
1396
 
        # at least stick to the correct types, even though they are
1397
 
        # never used
1398
 
        "enable": True,
1399
 
        "disable": True,
1400
 
        "bump_timeout": True,
1401
 
        "start_checker": True,
1402
 
        "stop_checker": True,
1403
 
        "is_enabled": True,
1404
 
        "remove": True,
1405
 
        "checker": "x",
1406
 
        "timeout": datetime.timedelta(),
1407
 
        "extended_timeout": datetime.timedelta(),
1408
 
        "interval": datetime.timedelta(),
1409
 
        "approved_by_default": True,
1410
 
        "approval_delay": datetime.timedelta(),
1411
 
        "approval_duration": datetime.timedelta(),
1412
 
        "host": "x",
1413
 
        "secret": io.BytesIO(b"x"),
1414
 
        "approve": True,
1415
 
        "deny": True,
1416
 
    }
1417
 
 
1418
 
    def setUp(self):
1419
 
        self.parser = argparse.ArgumentParser()
1420
 
        add_command_line_options(self.parser)
1421
 
 
1422
 
    @contextlib.contextmanager
1423
 
    def assertParseError(self):
1424
 
        with self.assertRaises(SystemExit) as e:
1425
 
            with self.temporarily_suppress_stderr():
1426
 
                yield
1427
 
        # Exit code from argparse is guaranteed to be "2".  Reference:
1428
 
        # https://docs.python.org/3/library/argparse.html#exiting-methods
1429
 
        self.assertEqual(e.exception.code, 2)
1430
 
 
1431
 
    @staticmethod
1432
 
    @contextlib.contextmanager
1433
 
    def temporarily_suppress_stderr():
1434
 
        null = os.open(os.path.devnull, os.O_RDWR)
1435
 
        stderrcopy = os.dup(sys.stderr.fileno())
1436
 
        os.dup2(null, sys.stderr.fileno())
1437
 
        os.close(null)
1438
 
        try:
1439
 
            yield
1440
 
        finally:
1441
 
            # restore stderr
1442
 
            os.dup2(stderrcopy, sys.stderr.fileno())
1443
 
            os.close(stderrcopy)
1444
 
 
1445
 
    def check_option_syntax(self, options):
1446
 
        check_option_syntax(self.parser, options)
1447
 
 
1448
 
    def test_actions_requires_client_or_all(self):
1449
 
        for action, value in self.actions.items():
1450
 
            options = self.parser.parse_args()
1451
 
            setattr(options, action, value)
1452
 
            with self.assertParseError():
1453
 
                self.check_option_syntax(options)
1454
 
 
1455
 
    def test_actions_conflicts_with_verbose(self):
1456
 
        for action, value in self.actions.items():
1457
 
            options = self.parser.parse_args()
1458
 
            setattr(options, action, value)
1459
 
            options.verbose = True
1460
 
            with self.assertParseError():
1461
 
                self.check_option_syntax(options)
1462
 
 
1463
 
    def test_dump_json_conflicts_with_verbose(self):
1464
 
        options = self.parser.parse_args()
1465
 
        options.dump_json = True
1466
 
        options.verbose = True
1467
 
        with self.assertParseError():
1468
 
            self.check_option_syntax(options)
1469
 
 
1470
 
    def test_dump_json_conflicts_with_action(self):
1471
 
        for action, value in self.actions.items():
1472
 
            options = self.parser.parse_args()
1473
 
            setattr(options, action, value)
1474
 
            options.dump_json = True
1475
 
            with self.assertParseError():
1476
 
                self.check_option_syntax(options)
1477
 
 
1478
 
    def test_all_can_not_be_alone(self):
1479
 
        options = self.parser.parse_args()
1480
 
        options.all = True
1481
 
        with self.assertParseError():
1482
 
            self.check_option_syntax(options)
1483
 
 
1484
 
    def test_all_is_ok_with_any_action(self):
1485
 
        for action, value in self.actions.items():
1486
 
            options = self.parser.parse_args()
1487
 
            setattr(options, action, value)
1488
 
            options.all = True
1489
 
            self.check_option_syntax(options)
1490
 
 
1491
 
    def test_is_enabled_fails_without_client(self):
1492
 
        options = self.parser.parse_args()
1493
 
        options.is_enabled = True
1494
 
        with self.assertParseError():
1495
 
            self.check_option_syntax(options)
1496
 
 
1497
 
    def test_is_enabled_works_with_one_client(self):
1498
 
        options = self.parser.parse_args()
1499
 
        options.is_enabled = True
1500
 
        options.client = ["foo"]
1501
 
        self.check_option_syntax(options)
1502
 
 
1503
 
    def test_is_enabled_fails_with_two_clients(self):
1504
 
        options = self.parser.parse_args()
1505
 
        options.is_enabled = True
1506
 
        options.client = ["foo", "barbar"]
1507
 
        with self.assertParseError():
1508
 
            self.check_option_syntax(options)
1509
 
 
1510
 
    def test_remove_can_only_be_combined_with_action_deny(self):
1511
 
        for action, value in self.actions.items():
1512
 
            if action in {"remove", "deny"}:
1513
 
                continue
1514
 
            options = self.parser.parse_args()
1515
 
            setattr(options, action, value)
1516
 
            options.all = True
1517
 
            options.remove = True
1518
 
            with self.assertParseError():
1519
 
                self.check_option_syntax(options)
 
1791
 
 
1792
class TestSetTimeoutCmd(TestPropertyValueCmd):
 
1793
    command = command.SetTimeout
 
1794
    propname = "Timeout"
 
1795
    values_to_set = [datetime.timedelta(),
 
1796
                     datetime.timedelta(minutes=5),
 
1797
                     datetime.timedelta(seconds=1),
 
1798
                     datetime.timedelta(weeks=1),
 
1799
                     datetime.timedelta(weeks=52)]
 
1800
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1801
 
 
1802
 
 
1803
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
 
1804
    command = command.SetExtendedTimeout
 
1805
    propname = "ExtendedTimeout"
 
1806
    values_to_set = [datetime.timedelta(),
 
1807
                     datetime.timedelta(minutes=5),
 
1808
                     datetime.timedelta(seconds=1),
 
1809
                     datetime.timedelta(weeks=1),
 
1810
                     datetime.timedelta(weeks=52)]
 
1811
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1812
 
 
1813
 
 
1814
class TestSetIntervalCmd(TestPropertyValueCmd):
 
1815
    command = command.SetInterval
 
1816
    propname = "Interval"
 
1817
    values_to_set = [datetime.timedelta(),
 
1818
                     datetime.timedelta(minutes=5),
 
1819
                     datetime.timedelta(seconds=1),
 
1820
                     datetime.timedelta(weeks=1),
 
1821
                     datetime.timedelta(weeks=52)]
 
1822
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1823
 
 
1824
 
 
1825
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
 
1826
    command = command.SetApprovalDelay
 
1827
    propname = "ApprovalDelay"
 
1828
    values_to_set = [datetime.timedelta(),
 
1829
                     datetime.timedelta(minutes=5),
 
1830
                     datetime.timedelta(seconds=1),
 
1831
                     datetime.timedelta(weeks=1),
 
1832
                     datetime.timedelta(weeks=52)]
 
1833
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
 
1834
 
 
1835
 
 
1836
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
 
1837
    command = command.SetApprovalDuration
 
1838
    propname = "ApprovalDuration"
 
1839
    values_to_set = [datetime.timedelta(),
 
1840
                     datetime.timedelta(minutes=5),
 
1841
                     datetime.timedelta(seconds=1),
 
1842
                     datetime.timedelta(weeks=1),
 
1843
                     datetime.timedelta(weeks=52)]
 
1844
    values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1520
1845
 
1521
1846
 
1522
1847
 
1537
1862
    return tests
1538
1863
 
1539
1864
if __name__ == "__main__":
1540
 
    if should_only_run_tests():
1541
 
        # Call using ./tdd-python-script --check [--verbose]
1542
 
        unittest.main()
1543
 
    else:
1544
 
        main()
 
1865
    try:
 
1866
        if should_only_run_tests():
 
1867
            # Call using ./tdd-python-script --check [--verbose]
 
1868
            unittest.main()
 
1869
        else:
 
1870
            main()
 
1871
    finally:
 
1872
        logging.shutdown()