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