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