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 1076
- compare with another revision
- download diff
- download tarball
- view history from revision 1076
- Committer: Teddy Hogeborn
- Date: 2019-03-16 17:11:12 UTC
- Revision ID: teddy@recompile.se-20190316171112-0tpfk9ved7a2a5x2
mandos-ctl: Refactor and add a few more tests
* mandos-ctl (main): Remove comment and add empty line.
(rfc3339_duration_to_delta): Change ValueError exception message to
use \"{}\"" instead of "{!r}" so Python
2 and Python 3 output is the same.
(Test_check_option_syntax.temporarily_suppress_stderr): Rename to
"redirect_stderr_to_devnull".
(Test_check_option_syntax
.test_actions_except_is_enabled_are_ok_with_two_clients): Rename to
"test_two_clients_are_ok_with_actions_except_is_enabled".
(Test_check_option_syntax
.test_one_client_with_all_actions_except_is_enabled): New.
(Test_check_option_syntax
.test_two_clients_with_all_actions_except_is_enabled): - '' -
* mandos-ctl (main): Remove comment and add empty line.
(rfc3339_duration_to_delta): Change ValueError exception message to
use \"{}\"" instead of "{!r}" so Python
2 and Python 3 output is the same.
(Test_check_option_syntax.temporarily_suppress_stderr): Rename to
"redirect_stderr_to_devnull".
(Test_check_option_syntax
.test_actions_except_is_enabled_are_ok_with_two_clients): Rename to
"test_two_clients_are_ok_with_actions_except_is_enabled".
(Test_check_option_syntax
.test_one_client_with_all_actions_except_is_enabled): New.
(Test_check_option_syntax
.test_two_clients_with_all_actions_except_is_enabled): - '' -
- files modified:
- TODO
added
removed
mandos-ctl
45
45
import io
46
46
import tempfile
47
47
import contextlib
48
import abc
49
48
50
import dbus as dbus_python
49
import dbus
51
50
52
51
# Show warnings by default
53
52
if not sys.warnoptions:
62
61
63
62
if sys.version_info.major == 2:
64
63
str = unicode
65
import StringIO
66
io.StringIO = StringIO.StringIO
67
64
68
65
locale.setlocale(locale.LC_ALL, "")
69
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
70
73
version = "1.8.3"
71
74
72
75
76
try:
77
dbus.OBJECT_MANAGER_IFACE
78
except AttributeError:
79
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
80
81
73
82
def main():
74
83
parser = argparse.ArgumentParser()
84
75
85
add_command_line_options(parser)
76
86
77
87
options = parser.parse_args()
88
78
89
check_option_syntax(parser, options)
79
90
80
91
clientnames = options.client
82
93
if options.debug:
83
94
log.setLevel(logging.DEBUG)
84
95
85
bus = dbus_python_adapter.CachingBus(dbus_python)
86
87
try:
88
all_clients = bus.get_clients_and_properties()
89
except dbus.ConnectFailed as e:
90
log.critical("Could not connect to Mandos server: %s", e)
91
sys.exit(1)
92
except dbus.Error as e:
93
log.critical(
94
"Failed to access Mandos server through D-Bus:\n%s", e)
95
sys.exit(1)
96
bus = dbus.SystemBus()
97
98
mandos_dbus_object = get_mandos_dbus_object(bus)
99
100
mandos_serv = dbus.Interface(
101
mandos_dbus_object, dbus_interface=server_dbus_interface)
102
mandos_serv_object_manager = dbus.Interface(
103
mandos_dbus_object, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
104
105
managed_objects = get_managed_objects(mandos_serv_object_manager)
106
107
all_clients = {}
108
for path, ifs_and_props in managed_objects.items():
109
try:
110
all_clients[path] = ifs_and_props[client_dbus_interface]
111
except KeyError:
112
pass
96
113
97
114
# Compile dict of (clientpath: properties) to process
98
115
if not clientnames:
111
128
commands = commands_from_options(options)
112
129
113
130
for command in commands:
114
command.run(clients, bus)
131
command.run(clients, bus, mandos_serv)
115
132
116
133
117
134
def add_command_line_options(parser):
122
139
help="Select all clients")
123
140
parser.add_argument("-v", "--verbose", action="store_true",
124
141
help="Print all fields")
125
parser.add_argument("-j", "--dump-json", dest="commands",
126
action="append_const", default=[],
127
const=command.DumpJSON(),
142
parser.add_argument("-j", "--dump-json", action="store_true",
128
143
help="Dump client data in JSON format")
129
144
enable_disable = parser.add_mutually_exclusive_group()
130
enable_disable.add_argument("-e", "--enable", dest="commands",
131
action="append_const", default=[],
132
const=command.Enable(),
145
enable_disable.add_argument("-e", "--enable", action="store_true",
133
146
help="Enable client")
134
enable_disable.add_argument("-d", "--disable", dest="commands",
135
action="append_const", default=[],
136
const=command.Disable(),
147
enable_disable.add_argument("-d", "--disable",
148
action="store_true",
137
149
help="disable client")
138
parser.add_argument("-b", "--bump-timeout", dest="commands",
139
action="append_const", default=[],
140
const=command.BumpTimeout(),
150
parser.add_argument("-b", "--bump-timeout", action="store_true",
141
151
help="Bump timeout for client")
142
152
start_stop_checker = parser.add_mutually_exclusive_group()
143
153
start_stop_checker.add_argument("--start-checker",
144
dest="commands",
145
action="append_const", default=[],
146
const=command.StartChecker(),
154
action="store_true",
147
155
help="Start checker for client")
148
start_stop_checker.add_argument("--stop-checker", dest="commands",
149
action="append_const", default=[],
150
const=command.StopChecker(),
156
start_stop_checker.add_argument("--stop-checker",
157
action="store_true",
151
158
help="Stop checker for client")
152
parser.add_argument("-V", "--is-enabled", dest="commands",
153
action="append_const", default=[],
154
const=command.IsEnabled(),
159
parser.add_argument("-V", "--is-enabled", action="store_true",
155
160
help="Check if client is enabled")
156
parser.add_argument("-r", "--remove", dest="commands",
157
action="append_const", default=[],
158
const=command.Remove(),
161
parser.add_argument("-r", "--remove", action="store_true",
159
162
help="Remove client")
160
parser.add_argument("-c", "--checker", dest="commands",
161
action="append", default=[],
162
metavar="COMMAND", type=command.SetChecker,
163
parser.add_argument("-c", "--checker",
163
164
help="Set checker command for client")
164
parser.add_argument(
165
"-t", "--timeout", dest="commands", action="append",
166
default=[], metavar="TIME",
167
type=command.SetTimeout.argparse(string_to_delta),
168
help="Set timeout for client")
169
parser.add_argument(
170
"--extended-timeout", dest="commands", action="append",
171
default=[], metavar="TIME",
172
type=command.SetExtendedTimeout.argparse(string_to_delta),
173
help="Set extended timeout for client")
174
parser.add_argument(
175
"-i", "--interval", dest="commands", action="append",
176
default=[], metavar="TIME",
177
type=command.SetInterval.argparse(string_to_delta),
178
help="Set checker interval for client")
165
parser.add_argument("-t", "--timeout", type=string_to_delta,
166
help="Set timeout for client")
167
parser.add_argument("--extended-timeout", type=string_to_delta,
168
help="Set extended timeout for client")
169
parser.add_argument("-i", "--interval", type=string_to_delta,
170
help="Set checker interval for client")
179
171
approve_deny_default = parser.add_mutually_exclusive_group()
180
172
approve_deny_default.add_argument(
181
"--approve-by-default", dest="commands",
182
action="append_const", default=[],
183
const=command.ApproveByDefault(),
173
"--approve-by-default", action="store_true",
174
default=None, dest="approved_by_default",
184
175
help="Set client to be approved by default")
185
176
approve_deny_default.add_argument(
186
"--deny-by-default", dest="commands",
187
action="append_const", default=[],
188
const=command.DenyByDefault(),
177
"--deny-by-default", action="store_false",
178
dest="approved_by_default",
189
179
help="Set client to be denied by default")
190
parser.add_argument(
191
"--approval-delay", dest="commands", action="append",
192
default=[], metavar="TIME",
193
type=command.SetApprovalDelay.argparse(string_to_delta),
194
help="Set delay before client approve/deny")
195
parser.add_argument(
196
"--approval-duration", dest="commands", action="append",
197
default=[], metavar="TIME",
198
type=command.SetApprovalDuration.argparse(string_to_delta),
199
help="Set duration of one client approval")
200
parser.add_argument("-H", "--host", dest="commands",
201
action="append", default=[], metavar="STRING",
202
type=command.SetHost,
203
help="Set host for client")
204
parser.add_argument(
205
"-s", "--secret", dest="commands", action="append",
206
default=[], metavar="FILENAME",
207
type=command.SetSecret.argparse(argparse.FileType(mode="rb")),
208
help="Set password blob (file) for client")
180
parser.add_argument("--approval-delay", type=string_to_delta,
181
help="Set delay before client approve/deny")
182
parser.add_argument("--approval-duration", type=string_to_delta,
183
help="Set duration of one client approval")
184
parser.add_argument("-H", "--host", help="Set host for client")
185
parser.add_argument("-s", "--secret",
186
type=argparse.FileType(mode="rb"),
187
help="Set password blob (file) for client")
209
188
approve_deny = parser.add_mutually_exclusive_group()
210
189
approve_deny.add_argument(
211
"-A", "--approve", dest="commands", action="append_const",
212
default=[], const=command.Approve(),
190
"-A", "--approve", action="store_true",
213
191
help="Approve any current client request")
214
approve_deny.add_argument("-D", "--deny", dest="commands",
215
action="append_const", default=[],
216
const=command.Deny(),
192
approve_deny.add_argument("-D", "--deny", action="store_true",
217
193
help="Deny any current client request")
218
194
parser.add_argument("--debug", action="store_true",
219
195
help="Debug mode (show D-Bus commands)")
410
386
"""Apply additional restrictions on options, not expressible in
411
387
argparse"""
412
388
413
def has_commands(options, commands=None):
414
if commands is None:
415
commands = (command.Enable,
416
command.Disable,
417
command.BumpTimeout,
418
command.StartChecker,
419
command.StopChecker,
420
command.IsEnabled,
421
command.Remove,
422
command.SetChecker,
423
command.SetTimeout,
424
command.SetExtendedTimeout,
425
command.SetInterval,
426
command.ApproveByDefault,
427
command.DenyByDefault,
428
command.SetApprovalDelay,
429
command.SetApprovalDuration,
430
command.SetHost,
431
command.SetSecret,
432
command.Approve,
433
command.Deny)
434
return any(isinstance(cmd, commands)
435
for cmd in options.commands)
389
def has_actions(options):
390
return any((options.enable,
391
options.disable,
392
options.bump_timeout,
393
options.start_checker,
394
options.stop_checker,
395
options.is_enabled,
396
options.remove,
397
options.checker is not None,
398
options.timeout is not None,
399
options.extended_timeout is not None,
400
options.interval is not None,
401
options.approved_by_default is not None,
402
options.approval_delay is not None,
403
options.approval_duration is not None,
404
options.host is not None,
405
options.secret is not None,
406
options.approve,
407
options.deny))
436
408
437
if has_commands(options) and not (options.client or options.all):
409
if has_actions(options) and not (options.client or options.all):
438
410
parser.error("Options require clients names or --all.")
439
if options.verbose and has_commands(options):
411
if options.verbose and has_actions(options):
440
412
parser.error("--verbose can only be used alone.")
441
if (has_commands(options, (command.DumpJSON,))
442
and (options.verbose or len(options.commands) > 1)):
413
if options.dump_json and (options.verbose
414
or has_actions(options)):
443
415
parser.error("--dump-json can only be used alone.")
444
if options.all and not has_commands(options):
416
if options.all and not has_actions(options):
445
417
parser.error("--all requires an action.")
446
if (has_commands(options, (command.IsEnabled,))
447
and len(options.client) > 1):
418
if options.is_enabled and len(options.client) > 1:
448
419
parser.error("--is-enabled requires exactly one client")
449
if (len(options.commands) > 1
450
and has_commands(options, (command.Remove,))
451
and not has_commands(options, (command.Deny,))):
452
parser.error("--remove can only be combined with --deny")
453
454
455
class dbus(object):
456
457
class SystemBus(object):
458
459
object_manager_iface = "org.freedesktop.DBus.ObjectManager"
460
def get_managed_objects(self, busname, objectpath):
461
return self.call_method("GetManagedObjects", busname,
462
objectpath,
463
self.object_manager_iface)
464
465
properties_iface = "org.freedesktop.DBus.Properties"
466
def set_property(self, busname, objectpath, interface, key,
467
value):
468
self.call_method("Set", busname, objectpath,
469
self.properties_iface, interface, key,
470
value)
471
472
473
class MandosBus(SystemBus):
474
busname_domain = "se.recompile"
475
busname = busname_domain + ".Mandos"
476
server_path = "/"
477
server_interface = busname_domain + ".Mandos"
478
client_interface = busname_domain + ".Mandos.Client"
479
del busname_domain
480
481
def get_clients_and_properties(self):
482
managed_objects = self.get_managed_objects(
483
self.busname, self.server_path)
484
return {objpath: properties[self.client_interface]
485
for objpath, properties in managed_objects.items()
486
if self.client_interface in properties}
487
488
def set_client_property(self, objectpath, key, value):
489
return self.set_property(self.busname, objectpath,
490
self.client_interface, key,
491
value)
492
493
def call_client_method(self, objectpath, method, *args):
494
return self.call_method(method, self.busname, objectpath,
495
self.client_interface, *args)
496
497
def call_server_method(self, method, *args):
498
return self.call_method(method, self.busname,
499
self.server_path,
500
self.server_interface, *args)
501
502
class Error(Exception):
503
pass
504
505
class ConnectFailed(Error):
506
pass
507
508
509
class dbus_python_adapter(object):
510
511
class SystemBus(dbus.MandosBus):
512
"""Use dbus-python"""
513
514
def __init__(self, module=dbus_python):
515
self.dbus_python = module
516
self.bus = self.dbus_python.SystemBus()
517
518
@contextlib.contextmanager
519
def convert_exception(self, exception_class=dbus.Error):
520
try:
521
yield
522
except self.dbus_python.exceptions.DBusException as e:
523
# This does what "raise from" would do
524
exc = exception_class(*e.args)
525
exc.__cause__ = e
526
raise exc
527
528
def call_method(self, methodname, busname, objectpath,
529
interface, *args):
530
proxy_object = self.get_object(busname, objectpath)
531
log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
532
interface, methodname,
533
", ".join(repr(a) for a in args))
534
method = getattr(proxy_object, methodname)
535
with self.convert_exception():
536
with dbus_python_adapter.SilenceLogger(
537
"dbus.proxies"):
538
value = method(*args, dbus_interface=interface)
539
return self.type_filter(value)
540
541
def get_object(self, busname, objectpath):
542
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
543
busname, objectpath)
544
with self.convert_exception(dbus.ConnectFailed):
545
return self.bus.get_object(busname, objectpath)
546
547
def type_filter(self, value):
548
"""Convert the most bothersome types to Python types"""
549
if isinstance(value, self.dbus_python.Boolean):
550
return bool(value)
551
if isinstance(value, self.dbus_python.ObjectPath):
552
return str(value)
553
# Also recurse into dictionaries
554
if isinstance(value, self.dbus_python.Dictionary):
555
return {self.type_filter(key):
556
self.type_filter(subval)
557
for key, subval in value.items()}
558
return value
559
560
561
class SilenceLogger(object):
562
"Simple context manager to silence a particular logger"
563
def __init__(self, loggername):
564
self.logger = logging.getLogger(loggername)
565
566
def __enter__(self):
567
self.logger.addFilter(self.nullfilter)
568
569
class NullFilter(logging.Filter):
570
def filter(self, record):
571
return False
572
573
nullfilter = NullFilter()
574
575
def __exit__(self, exc_type, exc_val, exc_tb):
576
self.logger.removeFilter(self.nullfilter)
577
578
579
class CachingBus(SystemBus):
580
"""A caching layer for dbus_python_adapter.SystemBus"""
581
def __init__(self, *args, **kwargs):
582
self.object_cache = {}
583
super(dbus_python_adapter.CachingBus,
584
self).__init__(*args, **kwargs)
585
def get_object(self, busname, objectpath):
586
try:
587
return self.object_cache[(busname, objectpath)]
588
except KeyError:
589
new_object = super(
590
dbus_python_adapter.CachingBus,
591
self).get_object(busname, objectpath)
592
self.object_cache[(busname, objectpath)] = new_object
593
return new_object
420
if options.remove:
421
options.remove = False
422
if has_actions(options) and not options.deny:
423
parser.error("--remove can only be combined with --deny")
424
options.remove = True
425
426
427
def get_mandos_dbus_object(bus):
428
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
429
dbus_busname, server_dbus_path)
430
with if_dbus_exception_log_with_exception_and_exit(
431
"Could not connect to Mandos server: %s"):
432
mandos_dbus_object = bus.get_object(dbus_busname,
433
server_dbus_path)
434
return mandos_dbus_object
435
436
437
@contextlib.contextmanager
438
def if_dbus_exception_log_with_exception_and_exit(*args, **kwargs):
439
try:
440
yield
441
except dbus.exceptions.DBusException as e:
442
log.critical(*(args + (e,)), **kwargs)
443
sys.exit(1)
444
445
446
def get_managed_objects(object_manager):
447
log.debug("D-Bus: %s:%s:%s.GetManagedObjects()", dbus_busname,
448
server_dbus_path, dbus.OBJECT_MANAGER_IFACE)
449
with if_dbus_exception_log_with_exception_and_exit(
450
"Failed to access Mandos server through D-Bus:\n%s"):
451
with SilenceLogger("dbus.proxies"):
452
managed_objects = object_manager.GetManagedObjects()
453
return managed_objects
454
455
456
class SilenceLogger(object):
457
"Simple context manager to silence a particular logger"
458
def __init__(self, loggername):
459
self.logger = logging.getLogger(loggername)
460
461
def __enter__(self):
462
self.logger.addFilter(self.nullfilter)
463
return self
464
465
class NullFilter(logging.Filter):
466
def filter(self, record):
467
return False
468
469
nullfilter = NullFilter()
470
471
def __exit__(self, exc_type, exc_val, exc_tb):
472
self.logger.removeFilter(self.nullfilter)
594
473
595
474
596
475
def commands_from_options(options):
597
476
598
commands = list(options.commands)
599
600
def find_cmd(cmd, commands):
601
i = 0
602
for i, c in enumerate(commands):
603
if isinstance(c, cmd):
604
return i
605
return i+1
606
607
# If command.Remove is present, move any instances of command.Deny
608
# to occur ahead of command.Remove.
609
index_of_remove = find_cmd(command.Remove, commands)
610
before_remove = commands[:index_of_remove]
611
after_remove = commands[index_of_remove:]
612
cleaned_after = []
613
for cmd in after_remove:
614
if isinstance(cmd, command.Deny):
615
before_remove.append(cmd)
477
commands = []
478
479
if options.is_enabled:
480
commands.append(IsEnabledCmd())
481
482
if options.approve:
483
commands.append(ApproveCmd())
484
485
if options.deny:
486
commands.append(DenyCmd())
487
488
if options.remove:
489
commands.append(RemoveCmd())
490
491
if options.dump_json:
492
commands.append(DumpJSONCmd())
493
494
if options.enable:
495
commands.append(EnableCmd())
496
497
if options.disable:
498
commands.append(DisableCmd())
499
500
if options.bump_timeout:
501
commands.append(BumpTimeoutCmd())
502
503
if options.start_checker:
504
commands.append(StartCheckerCmd())
505
506
if options.stop_checker:
507
commands.append(StopCheckerCmd())
508
509
if options.approved_by_default is not None:
510
if options.approved_by_default:
511
commands.append(ApproveByDefaultCmd())
616
512
else:
617
cleaned_after.append(cmd)
618
if cleaned_after != after_remove:
619
commands = before_remove + cleaned_after
513
commands.append(DenyByDefaultCmd())
514
515
if options.checker is not None:
516
commands.append(SetCheckerCmd(options.checker))
517
518
if options.host is not None:
519
commands.append(SetHostCmd(options.host))
520
521
if options.secret is not None:
522
commands.append(SetSecretCmd(options.secret))
523
524
if options.timeout is not None:
525
commands.append(SetTimeoutCmd(options.timeout))
526
527
if options.extended_timeout:
528
commands.append(
529
SetExtendedTimeoutCmd(options.extended_timeout))
530
531
if options.interval is not None:
532
commands.append(SetIntervalCmd(options.interval))
533
534
if options.approval_delay is not None:
535
commands.append(SetApprovalDelayCmd(options.approval_delay))
536
537
if options.approval_duration is not None:
538
commands.append(
539
SetApprovalDurationCmd(options.approval_duration))
620
540
621
541
# If no command option has been given, show table of clients,
622
542
# optionally verbosely
623
543
if not commands:
624
commands.append(command.PrintTable(verbose=options.verbose))
544
commands.append(PrintTableCmd(verbose=options.verbose))
625
545
626
546
return commands
627
547
628
548
629
class command(object):
630
"""A namespace for command classes"""
631
632
class Base(object):
633
"""Abstract base class for commands"""
634
def run(self, clients, bus=None):
635
"""Normal commands should implement run_on_one_client(),
636
but commands which want to operate on all clients at the same time can
637
override this run() method instead.
638
"""
639
self.bus = bus
640
for client, properties in clients.items():
641
self.run_on_one_client(client, properties)
642
643
644
class IsEnabled(Base):
645
def run(self, clients, bus=None):
646
properties = next(iter(clients.values()))
647
if properties["Enabled"]:
648
sys.exit(0)
649
sys.exit(1)
650
651
652
class Approve(Base):
653
def run_on_one_client(self, client, properties):
654
self.bus.call_client_method(client, "Approve", True)
655
656
657
class Deny(Base):
658
def run_on_one_client(self, client, properties):
659
self.bus.call_client_method(client, "Approve", False)
660
661
662
class Remove(Base):
663
def run(self, clients, bus):
664
for clientpath in frozenset(clients.keys()):
665
bus.call_server_method("RemoveClient", clientpath)
666
667
668
class Output(Base):
669
"""Abstract class for commands outputting client details"""
670
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
671
"Created", "Interval", "Host", "KeyID",
672
"Fingerprint", "CheckerRunning",
673
"LastEnabled", "ApprovalPending",
674
"ApprovedByDefault", "LastApprovalRequest",
675
"ApprovalDelay", "ApprovalDuration",
676
"Checker", "ExtendedTimeout", "Expires",
677
"LastCheckerStatus")
678
679
680
class DumpJSON(Output):
681
def run(self, clients, bus=None):
682
data = {properties["Name"]:
683
{key: properties[key]
684
for key in self.all_keywords}
685
for properties in clients.values()}
686
print(json.dumps(data, indent=4, separators=(',', ': ')))
687
688
689
class PrintTable(Output):
690
def __init__(self, verbose=False):
691
self.verbose = verbose
692
693
def run(self, clients, bus=None):
694
default_keywords = ("Name", "Enabled", "Timeout",
695
"LastCheckedOK")
696
keywords = default_keywords
697
if self.verbose:
698
keywords = self.all_keywords
699
print(self.TableOfClients(clients.values(), keywords))
700
701
class TableOfClients(object):
702
tableheaders = {
703
"Name": "Name",
704
"Enabled": "Enabled",
705
"Timeout": "Timeout",
706
"LastCheckedOK": "Last Successful Check",
707
"LastApprovalRequest": "Last Approval Request",
708
"Created": "Created",
709
"Interval": "Interval",
710
"Host": "Host",
711
"Fingerprint": "Fingerprint",
712
"KeyID": "Key ID",
713
"CheckerRunning": "Check Is Running",
714
"LastEnabled": "Last Enabled",
715
"ApprovalPending": "Approval Is Pending",
716
"ApprovedByDefault": "Approved By Default",
717
"ApprovalDelay": "Approval Delay",
718
"ApprovalDuration": "Approval Duration",
719
"Checker": "Checker",
720
"ExtendedTimeout": "Extended Timeout",
721
"Expires": "Expires",
722
"LastCheckerStatus": "Last Checker Status",
723
}
724
725
def __init__(self, clients, keywords):
726
self.clients = clients
727
self.keywords = keywords
728
549
class Command(object):
550
"""Abstract class for commands"""
551
def run(self, clients, bus=None, mandos=None):
552
"""Normal commands should implement run_on_one_client(), but
553
commands which want to operate on all clients at the same time
554
can override this run() method instead."""
555
self.mandos = mandos
556
for clientpath, properties in clients.items():
557
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
558
dbus_busname, str(clientpath))
559
client = bus.get_object(dbus_busname, clientpath)
560
self.run_on_one_client(client, properties)
561
562
563
class IsEnabledCmd(Command):
564
def run(self, clients, bus=None, mandos=None):
565
client, properties = next(iter(clients.items()))
566
if self.is_enabled(client, properties):
567
sys.exit(0)
568
sys.exit(1)
569
def is_enabled(self, client, properties):
570
return properties["Enabled"]
571
572
573
class ApproveCmd(Command):
574
def run_on_one_client(self, client, properties):
575
log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
576
client.__dbus_object_path__, client_dbus_interface)
577
client.Approve(dbus.Boolean(True),
578
dbus_interface=client_dbus_interface)
579
580
581
class DenyCmd(Command):
582
def run_on_one_client(self, client, properties):
583
log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
584
client.__dbus_object_path__, client_dbus_interface)
585
client.Approve(dbus.Boolean(False),
586
dbus_interface=client_dbus_interface)
587
588
589
class RemoveCmd(Command):
590
def run_on_one_client(self, client, properties):
591
log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)", dbus_busname,
592
server_dbus_path, server_dbus_interface,
593
str(client.__dbus_object_path__))
594
self.mandos.RemoveClient(client.__dbus_object_path__)
595
596
597
class OutputCmd(Command):
598
"""Abstract class for commands outputting client details"""
599
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
600
"Created", "Interval", "Host", "KeyID",
601
"Fingerprint", "CheckerRunning", "LastEnabled",
602
"ApprovalPending", "ApprovedByDefault",
603
"LastApprovalRequest", "ApprovalDelay",
604
"ApprovalDuration", "Checker", "ExtendedTimeout",
605
"Expires", "LastCheckerStatus")
606
607
def run(self, clients, bus=None, mandos=None):
608
print(self.output(clients.values()))
609
610
def output(self, clients):
611
raise NotImplementedError()
612
613
614
class DumpJSONCmd(OutputCmd):
615
def output(self, clients):
616
data = {client["Name"]:
617
{key: self.dbus_boolean_to_bool(client[key])
618
for key in self.all_keywords}
619
for client in clients}
620
return json.dumps(data, indent=4, separators=(',', ': '))
621
622
@staticmethod
623
def dbus_boolean_to_bool(value):
624
if isinstance(value, dbus.Boolean):
625
value = bool(value)
626
return value
627
628
629
class PrintTableCmd(OutputCmd):
630
def __init__(self, verbose=False):
631
self.verbose = verbose
632
633
def output(self, clients):
634
default_keywords = ("Name", "Enabled", "Timeout",
635
"LastCheckedOK")
636
keywords = default_keywords
637
if self.verbose:
638
keywords = self.all_keywords
639
return str(self.TableOfClients(clients, keywords))
640
641
class TableOfClients(object):
642
tableheaders = {
643
"Name": "Name",
644
"Enabled": "Enabled",
645
"Timeout": "Timeout",
646
"LastCheckedOK": "Last Successful Check",
647
"LastApprovalRequest": "Last Approval Request",
648
"Created": "Created",
649
"Interval": "Interval",
650
"Host": "Host",
651
"Fingerprint": "Fingerprint",
652
"KeyID": "Key ID",
653
"CheckerRunning": "Check Is Running",
654
"LastEnabled": "Last Enabled",
655
"ApprovalPending": "Approval Is Pending",
656
"ApprovedByDefault": "Approved By Default",
657
"ApprovalDelay": "Approval Delay",
658
"ApprovalDuration": "Approval Duration",
659
"Checker": "Checker",
660
"ExtendedTimeout": "Extended Timeout",
661
"Expires": "Expires",
662
"LastCheckerStatus": "Last Checker Status",
663
}
664
665
def __init__(self, clients, keywords):
666
self.clients = clients
667
self.keywords = keywords
668
669
def __str__(self):
670
return "\n".join(self.rows())
671
672
if sys.version_info.major == 2:
673
__unicode__ = __str__
729
674
def __str__(self):
730
return "\n".join(self.rows())
731
732
if sys.version_info.major == 2:
733
__unicode__ = __str__
734
def __str__(self):
735
return str(self).encode(
736
locale.getpreferredencoding())
737
738
def rows(self):
739
format_string = self.row_formatting_string()
740
rows = [self.header_line(format_string)]
741
rows.extend(self.client_line(client, format_string)
742
for client in self.clients)
743
return rows
744
745
def row_formatting_string(self):
746
"Format string used to format table rows"
747
return " ".join("{{{key}:{width}}}".format(
748
width=max(len(self.tableheaders[key]),
749
*(len(self.string_from_client(client,
750
key))
751
for client in self.clients)),
752
key=key)
753
for key in self.keywords)
754
755
def string_from_client(self, client, key):
756
return self.valuetostring(client[key], key)
757
758
@classmethod
759
def valuetostring(cls, value, keyword):
760
if isinstance(value, bool):
761
return "Yes" if value else "No"
762
if keyword in ("Timeout", "Interval", "ApprovalDelay",
763
"ApprovalDuration", "ExtendedTimeout"):
764
return cls.milliseconds_to_string(value)
765
return str(value)
766
767
def header_line(self, format_string):
768
return format_string.format(**self.tableheaders)
769
770
def client_line(self, client, format_string):
771
return format_string.format(
772
**{key: self.string_from_client(client, key)
773
for key in self.keywords})
774
775
@staticmethod
776
def milliseconds_to_string(ms):
777
td = datetime.timedelta(0, 0, 0, ms)
778
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
779
.format(days="{}T".format(td.days)
780
if td.days else "",
781
hours=td.seconds // 3600,
782
minutes=(td.seconds % 3600) // 60,
783
seconds=td.seconds % 60))
784
785
786
class PropertySetter(Base):
787
"Abstract class for Actions for setting one client property"
788
789
def run_on_one_client(self, client, properties=None):
790
"""Set the Client's D-Bus property"""
791
self.bus.set_client_property(client, self.propname,
792
self.value_to_set)
793
794
@property
795
def propname(self):
796
raise NotImplementedError()
797
798
799
class Enable(PropertySetter):
800
propname = "Enabled"
801
value_to_set = True
802
803
804
class Disable(PropertySetter):
805
propname = "Enabled"
806
value_to_set = False
807
808
809
class BumpTimeout(PropertySetter):
810
propname = "LastCheckedOK"
811
value_to_set = ""
812
813
814
class StartChecker(PropertySetter):
815
propname = "CheckerRunning"
816
value_to_set = True
817
818
819
class StopChecker(PropertySetter):
820
propname = "CheckerRunning"
821
value_to_set = False
822
823
824
class ApproveByDefault(PropertySetter):
825
propname = "ApprovedByDefault"
826
value_to_set = True
827
828
829
class DenyByDefault(PropertySetter):
830
propname = "ApprovedByDefault"
831
value_to_set = False
832
833
834
class PropertySetterValue(PropertySetter):
835
"""Abstract class for PropertySetter recieving a value as
836
constructor argument instead of a class attribute."""
837
def __init__(self, value):
838
self.value_to_set = value
675
return str(self).encode(locale.getpreferredencoding())
676
677
def rows(self):
678
format_string = self.row_formatting_string()
679
rows = [self.header_line(format_string)]
680
rows.extend(self.client_line(client, format_string)
681
for client in self.clients)
682
return rows
683
684
def row_formatting_string(self):
685
"Format string used to format table rows"
686
return " ".join("{{{key}:{width}}}".format(
687
width=max(len(self.tableheaders[key]),
688
*(len(self.string_from_client(client, key))
689
for client in self.clients)),
690
key=key)
691
for key in self.keywords)
692
693
def string_from_client(self, client, key):
694
return self.valuetostring(client[key], key)
839
695
840
696
@classmethod
841
def argparse(cls, argtype):
842
def cmdtype(arg):
843
return cls(argtype(arg))
844
return cmdtype
845
846
class SetChecker(PropertySetterValue):
847
propname = "Checker"
848
849
850
class SetHost(PropertySetterValue):
851
propname = "Host"
852
853
854
class SetSecret(PropertySetterValue):
855
propname = "Secret"
856
857
@property
858
def value_to_set(self):
859
return self._vts
860
861
@value_to_set.setter
862
def value_to_set(self, value):
863
"""When setting, read data from supplied file object"""
864
self._vts = value.read()
865
value.close()
866
867
868
class PropertySetterValueMilliseconds(PropertySetterValue):
869
"""Abstract class for PropertySetterValue taking a value
870
argument as a datetime.timedelta() but should store it as
871
milliseconds."""
872
873
@property
874
def value_to_set(self):
875
return self._vts
876
877
@value_to_set.setter
878
def value_to_set(self, value):
879
"When setting, convert value from a datetime.timedelta"
880
self._vts = int(round(value.total_seconds() * 1000))
881
882
883
class SetTimeout(PropertySetterValueMilliseconds):
884
propname = "Timeout"
885
886
887
class SetExtendedTimeout(PropertySetterValueMilliseconds):
888
propname = "ExtendedTimeout"
889
890
891
class SetInterval(PropertySetterValueMilliseconds):
892
propname = "Interval"
893
894
895
class SetApprovalDelay(PropertySetterValueMilliseconds):
896
propname = "ApprovalDelay"
897
898
899
class SetApprovalDuration(PropertySetterValueMilliseconds):
900
propname = "ApprovalDuration"
697
def valuetostring(cls, value, keyword):
698
if isinstance(value, dbus.Boolean):
699
return "Yes" if value else "No"
700
if keyword in ("Timeout", "Interval", "ApprovalDelay",
701
"ApprovalDuration", "ExtendedTimeout"):
702
return cls.milliseconds_to_string(value)
703
return str(value)
704
705
def header_line(self, format_string):
706
return format_string.format(**self.tableheaders)
707
708
def client_line(self, client, format_string):
709
return format_string.format(
710
**{key: self.string_from_client(client, key)
711
for key in self.keywords})
712
713
@staticmethod
714
def milliseconds_to_string(ms):
715
td = datetime.timedelta(0, 0, 0, ms)
716
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
717
.format(days="{}T".format(td.days)
718
if td.days else "",
719
hours=td.seconds // 3600,
720
minutes=(td.seconds % 3600) // 60,
721
seconds=td.seconds % 60))
722
723
724
class PropertyCmd(Command):
725
"""Abstract class for Actions for setting one client property"""
726
727
def run_on_one_client(self, client, properties):
728
"""Set the Client's D-Bus property"""
729
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
730
client.__dbus_object_path__,
731
dbus.PROPERTIES_IFACE, client_dbus_interface,
732
self.propname, self.value_to_set
733
if not isinstance(self.value_to_set, dbus.Boolean)
734
else bool(self.value_to_set))
735
client.Set(client_dbus_interface, self.propname,
736
self.value_to_set,
737
dbus_interface=dbus.PROPERTIES_IFACE)
738
739
@property
740
def propname(self):
741
raise NotImplementedError()
742
743
744
class EnableCmd(PropertyCmd):
745
propname = "Enabled"
746
value_to_set = dbus.Boolean(True)
747
748
749
class DisableCmd(PropertyCmd):
750
propname = "Enabled"
751
value_to_set = dbus.Boolean(False)
752
753
754
class BumpTimeoutCmd(PropertyCmd):
755
propname = "LastCheckedOK"
756
value_to_set = ""
757
758
759
class StartCheckerCmd(PropertyCmd):
760
propname = "CheckerRunning"
761
value_to_set = dbus.Boolean(True)
762
763
764
class StopCheckerCmd(PropertyCmd):
765
propname = "CheckerRunning"
766
value_to_set = dbus.Boolean(False)
767
768
769
class ApproveByDefaultCmd(PropertyCmd):
770
propname = "ApprovedByDefault"
771
value_to_set = dbus.Boolean(True)
772
773
774
class DenyByDefaultCmd(PropertyCmd):
775
propname = "ApprovedByDefault"
776
value_to_set = dbus.Boolean(False)
777
778
779
class PropertyValueCmd(PropertyCmd):
780
"""Abstract class for PropertyCmd recieving a value as argument"""
781
def __init__(self, value):
782
self.value_to_set = value
783
784
785
class SetCheckerCmd(PropertyValueCmd):
786
propname = "Checker"
787
788
789
class SetHostCmd(PropertyValueCmd):
790
propname = "Host"
791
792
793
class SetSecretCmd(PropertyValueCmd):
794
propname = "Secret"
795
796
@property
797
def value_to_set(self):
798
return self._vts
799
800
@value_to_set.setter
801
def value_to_set(self, value):
802
"""When setting, read data from supplied file object"""
803
self._vts = value.read()
804
value.close()
805
806
807
class MillisecondsPropertyValueArgumentCmd(PropertyValueCmd):
808
"""Abstract class for PropertyValueCmd taking a value argument as
809
a datetime.timedelta() but should store it as milliseconds."""
810
811
@property
812
def value_to_set(self):
813
return self._vts
814
815
@value_to_set.setter
816
def value_to_set(self, value):
817
"""When setting, convert value from a datetime.timedelta"""
818
self._vts = int(round(value.total_seconds() * 1000))
819
820
821
class SetTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
822
propname = "Timeout"
823
824
825
class SetExtendedTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
826
propname = "ExtendedTimeout"
827
828
829
class SetIntervalCmd(MillisecondsPropertyValueArgumentCmd):
830
propname = "Interval"
831
832
833
class SetApprovalDelayCmd(MillisecondsPropertyValueArgumentCmd):
834
propname = "ApprovalDelay"
835
836
837
class SetApprovalDurationCmd(MillisecondsPropertyValueArgumentCmd):
838
propname = "ApprovalDuration"
901
839
902
840
903
841
935
873
"output"))
936
874
937
875
938
class Unique(object):
939
"""Class for objects which exist only to be unique objects, since
940
unittest.mock.sentinel only exists in Python 3.3"""
941
942
943
876
class Test_string_to_delta(TestCaseWithAssertLogs):
944
# Just test basic RFC 3339 functionality here, the doc string for
945
# rfc3339_duration_to_delta() already has more comprehensive
946
# tests, which are run by doctest.
947
948
def test_rfc3339_zero_seconds(self):
949
self.assertEqual(datetime.timedelta(),
950
string_to_delta("PT0S"))
951
952
def test_rfc3339_zero_days(self):
953
self.assertEqual(datetime.timedelta(), string_to_delta("P0D"))
954
955
def test_rfc3339_one_second(self):
956
self.assertEqual(datetime.timedelta(0, 1),
957
string_to_delta("PT1S"))
958
959
def test_rfc3339_two_hours(self):
960
self.assertEqual(datetime.timedelta(0, 7200),
961
string_to_delta("PT2H"))
877
def test_handles_basic_rfc3339(self):
878
self.assertEqual(string_to_delta("PT0S"),
879
datetime.timedelta())
880
self.assertEqual(string_to_delta("P0D"),
881
datetime.timedelta())
882
self.assertEqual(string_to_delta("PT1S"),
883
datetime.timedelta(0, 1))
884
self.assertEqual(string_to_delta("PT2H"),
885
datetime.timedelta(0, 7200))
962
886
963
887
def test_falls_back_to_pre_1_6_1_with_warning(self):
964
888
with self.assertLogs(log, logging.WARNING):
965
889
value = string_to_delta("2h")
966
self.assertEqual(datetime.timedelta(0, 7200), value)
890
self.assertEqual(value, datetime.timedelta(0, 7200))
967
891
968
892
969
893
class Test_check_option_syntax(unittest.TestCase):
973
897
974
898
def test_actions_requires_client_or_all(self):
975
899
for action, value in self.actions.items():
976
args = self.actionargs(action, value)
900
options = self.parser.parse_args()
901
setattr(options, action, value)
977
902
with self.assertParseError():
978
self.parse_args(args)
903
self.check_option_syntax(options)
979
904
980
# This mostly corresponds to the definition from has_commands() in
905
# This mostly corresponds to the definition from has_actions() in
981
906
# check_option_syntax()
982
907
actions = {
983
"--enable": None,
984
"--disable": None,
985
"--bump-timeout": None,
986
"--start-checker": None,
987
"--stop-checker": None,
988
"--is-enabled": None,
989
"--remove": None,
990
"--checker": "x",
991
"--timeout": "PT0S",
992
"--extended-timeout": "PT0S",
993
"--interval": "PT0S",
994
"--approve-by-default": None,
995
"--deny-by-default": None,
996
"--approval-delay": "PT0S",
997
"--approval-duration": "PT0S",
998
"--host": "hostname",
999
"--secret": "/dev/null",
1000
"--approve": None,
1001
"--deny": None,
908
# The actual values set here are not that important, but we do
909
# at least stick to the correct types, even though they are
910
# never used
911
"enable": True,
912
"disable": True,
913
"bump_timeout": True,
914
"start_checker": True,
915
"stop_checker": True,
916
"is_enabled": True,
917
"remove": True,
918
"checker": "x",
919
"timeout": datetime.timedelta(),
920
"extended_timeout": datetime.timedelta(),
921
"interval": datetime.timedelta(),
922
"approved_by_default": True,
923
"approval_delay": datetime.timedelta(),
924
"approval_duration": datetime.timedelta(),
925
"host": "x",
926
"secret": io.BytesIO(b"x"),
927
"approve": True,
928
"deny": True,
1002
929
}
1003
930
1004
@staticmethod
1005
def actionargs(action, value, *args):
1006
if value is not None:
1007
return [action, value] + list(args)
1008
else:
1009
return [action] + list(args)
1010
1011
931
@contextlib.contextmanager
1012
932
def assertParseError(self):
1013
933
with self.assertRaises(SystemExit) as e:
1016
936
# Exit code from argparse is guaranteed to be "2". Reference:
1017
937
# https://docs.python.org/3/library
1018
938
# /argparse.html#exiting-methods
1019
self.assertEqual(2, e.exception.code)
1020
1021
def parse_args(self, args):
1022
options = self.parser.parse_args(args)
1023
check_option_syntax(self.parser, options)
939
self.assertEqual(e.exception.code, 2)
1024
940
1025
941
@staticmethod
1026
942
@contextlib.contextmanager
1027
943
def redirect_stderr_to_devnull():
1028
old_stderr = sys.stderr
1029
with contextlib.closing(open(os.devnull, "w")) as null:
1030
sys.stderr = null
1031
try:
1032
yield
1033
finally:
1034
sys.stderr = old_stderr
944
null = os.open(os.path.devnull, os.O_RDWR)
945
stderrcopy = os.dup(sys.stderr.fileno())
946
os.dup2(null, sys.stderr.fileno())
947
os.close(null)
948
try:
949
yield
950
finally:
951
# restore stderr
952
os.dup2(stderrcopy, sys.stderr.fileno())
953
os.close(stderrcopy)
1035
954
1036
955
def check_option_syntax(self, options):
1037
956
check_option_syntax(self.parser, options)
1038
957
1039
958
def test_actions_all_conflicts_with_verbose(self):
1040
959
for action, value in self.actions.items():
1041
args = self.actionargs(action, value, "--all",
1042
"--verbose")
960
options = self.parser.parse_args()
961
setattr(options, action, value)
962
options.all = True
963
options.verbose = True
1043
964
with self.assertParseError():
1044
self.parse_args(args)
965
self.check_option_syntax(options)
1045
966
1046
967
def test_actions_with_client_conflicts_with_verbose(self):
1047
968
for action, value in self.actions.items():
1048
args = self.actionargs(action, value, "--verbose",
1049
"client")
969
options = self.parser.parse_args()
970
setattr(options, action, value)
971
options.verbose = True
972
options.client = ["foo"]
1050
973
with self.assertParseError():
1051
self.parse_args(args)
974
self.check_option_syntax(options)
1052
975
1053
976
def test_dump_json_conflicts_with_verbose(self):
1054
args = ["--dump-json", "--verbose"]
977
options = self.parser.parse_args()
978
options.dump_json = True
979
options.verbose = True
1055
980
with self.assertParseError():
1056
self.parse_args(args)
981
self.check_option_syntax(options)
1057
982
1058
983
def test_dump_json_conflicts_with_action(self):
1059
984
for action, value in self.actions.items():
1060
args = self.actionargs(action, value, "--dump-json")
985
options = self.parser.parse_args()
986
setattr(options, action, value)
987
options.dump_json = True
1061
988
with self.assertParseError():
1062
self.parse_args(args)
989
self.check_option_syntax(options)
1063
990
1064
991
def test_all_can_not_be_alone(self):
1065
args = ["--all"]
992
options = self.parser.parse_args()
993
options.all = True
1066
994
with self.assertParseError():
1067
self.parse_args(args)
995
self.check_option_syntax(options)
1068
996
1069
997
def test_all_is_ok_with_any_action(self):
1070
998
for action, value in self.actions.items():
1071
args = self.actionargs(action, value, "--all")
1072
self.parse_args(args)
999
options = self.parser.parse_args()
1000
setattr(options, action, value)
1001
options.all = True
1002
self.check_option_syntax(options)
1073
1003
1074
1004
def test_any_action_is_ok_with_one_client(self):
1075
1005
for action, value in self.actions.items():
1076
args = self.actionargs(action, value, "client")
1077
self.parse_args(args)
1006
options = self.parser.parse_args()
1007
setattr(options, action, value)
1008
options.client = ["foo"]
1009
self.check_option_syntax(options)
1078
1010
1079
1011
def test_one_client_with_all_actions_except_is_enabled(self):
1012
options = self.parser.parse_args()
1080
1013
for action, value in self.actions.items():
1081
if action == "--is-enabled":
1014
if action == "is_enabled":
1082
1015
continue
1083
args = self.actionargs(action, value, "client")
1084
self.parse_args(args)
1016
setattr(options, action, value)
1017
options.client = ["foo"]
1018
self.check_option_syntax(options)
1085
1019
1086
1020
def test_two_clients_with_all_actions_except_is_enabled(self):
1021
options = self.parser.parse_args()
1087
1022
for action, value in self.actions.items():
1088
if action == "--is-enabled":
1023
if action == "is_enabled":
1089
1024
continue
1090
args = self.actionargs(action, value, "client1",
1091
"client2")
1092
self.parse_args(args)
1025
setattr(options, action, value)
1026
options.client = ["foo", "barbar"]
1027
self.check_option_syntax(options)
1093
1028
1094
1029
def test_two_clients_are_ok_with_actions_except_is_enabled(self):
1095
1030
for action, value in self.actions.items():
1096
if action == "--is-enabled":
1031
if action == "is_enabled":
1097
1032
continue
1098
args = self.actionargs(action, value, "client1",
1099
"client2")
1100
self.parse_args(args)
1033
options = self.parser.parse_args()
1034
setattr(options, action, value)
1035
options.client = ["foo", "barbar"]
1036
self.check_option_syntax(options)
1101
1037
1102
1038
def test_is_enabled_fails_without_client(self):
1103
args = ["--is-enabled"]
1039
options = self.parser.parse_args()
1040
options.is_enabled = True
1104
1041
with self.assertParseError():
1105
self.parse_args(args)
1042
self.check_option_syntax(options)
1106
1043
1107
1044
def test_is_enabled_fails_with_two_clients(self):
1108
args = ["--is-enabled", "client1", "client2"]
1045
options = self.parser.parse_args()
1046
options.is_enabled = True
1047
options.client = ["foo", "barbar"]
1109
1048
with self.assertParseError():
1110
self.parse_args(args)
1049
self.check_option_syntax(options)
1111
1050
1112
1051
def test_remove_can_only_be_combined_with_action_deny(self):
1113
1052
for action, value in self.actions.items():
1114
if action in {"--remove", "--deny"}:
1053
if action in {"remove", "deny"}:
1115
1054
continue
1116
args = self.actionargs(action, value, "--all",
1117
"--remove")
1055
options = self.parser.parse_args()
1056
setattr(options, action, value)
1057
options.all = True
1058
options.remove = True
1118
1059
with self.assertParseError():
1119
self.parse_args(args)
1120
1121
1122
class Test_dbus_exceptions(unittest.TestCase):
1123
1124
def test_dbus_ConnectFailed_is_Error(self):
1125
with self.assertRaises(dbus.Error):
1126
raise dbus.ConnectFailed()
1127
1128
1129
class Test_dbus_MandosBus(unittest.TestCase):
1130
1131
class MockMandosBus(dbus.MandosBus):
1132
def __init__(self):
1133
self._name = "se.recompile.Mandos"
1134
self._server_path = "/"
1135
self._server_interface = "se.recompile.Mandos"
1136
self._client_interface = "se.recompile.Mandos.Client"
1137
self.calls = []
1138
self.call_method_return = Unique()
1139
1140
def call_method(self, methodname, busname, objectpath,
1141
interface, *args):
1142
self.calls.append((methodname, busname, objectpath,
1143
interface, args))
1144
return self.call_method_return
1145
1146
def setUp(self):
1147
self.bus = self.MockMandosBus()
1148
1149
def test_set_client_property(self):
1150
self.bus.set_client_property("objectpath", "key", "value")
1151
expected_call = ("Set", self.bus._name, "objectpath",
1152
"org.freedesktop.DBus.Properties",
1153
(self.bus._client_interface, "key", "value"))
1154
self.assertIn(expected_call, self.bus.calls)
1155
1156
def test_call_client_method(self):
1157
ret = self.bus.call_client_method("objectpath", "methodname")
1158
self.assertIs(self.bus.call_method_return, ret)
1159
expected_call = ("methodname", self.bus._name, "objectpath",
1160
self.bus._client_interface, ())
1161
self.assertIn(expected_call, self.bus.calls)
1162
1163
def test_call_client_method_with_args(self):
1164
args = (Unique(), Unique())
1165
ret = self.bus.call_client_method("objectpath", "methodname",
1166
*args)
1167
self.assertIs(self.bus.call_method_return, ret)
1168
expected_call = ("methodname", self.bus._name, "objectpath",
1169
self.bus._client_interface,
1170
(args[0], args[1]))
1171
self.assertIn(expected_call, self.bus.calls)
1172
1173
def test_get_clients_and_properties(self):
1174
managed_objects = {
1175
"objectpath": {
1176
self.bus._client_interface: {
1177
"key": "value",
1178
"bool": True,
1179
},
1180
"irrelevant_interface": {
1181
"key": "othervalue",
1182
"bool": False,
1183
},
1184
},
1185
"other_objectpath": {
1186
"other_irrelevant_interface": {
1187
"key": "value 3",
1188
"bool": None,
1189
},
1190
},
1191
}
1192
expected_clients_and_properties = {
1193
"objectpath": {
1194
"key": "value",
1195
"bool": True,
1196
}
1197
}
1198
self.bus.call_method_return = managed_objects
1199
ret = self.bus.get_clients_and_properties()
1200
self.assertDictEqual(expected_clients_and_properties, ret)
1201
expected_call = ("GetManagedObjects", self.bus._name,
1202
self.bus._server_path,
1203
"org.freedesktop.DBus.ObjectManager", ())
1204
self.assertIn(expected_call, self.bus.calls)
1205
1206
def test_call_server_method(self):
1207
ret = self.bus.call_server_method("methodname")
1208
self.assertIs(self.bus.call_method_return, ret)
1209
expected_call = ("methodname", self.bus._name,
1210
self.bus._server_path,
1211
self.bus._server_interface, ())
1212
self.assertIn(expected_call, self.bus.calls)
1213
1214
def test_call_server_method_with_args(self):
1215
args = (Unique(), Unique())
1216
ret = self.bus.call_server_method("methodname", *args)
1217
self.assertIs(self.bus.call_method_return, ret)
1218
expected_call = ("methodname", self.bus._name,
1219
self.bus._server_path,
1220
self.bus._server_interface,
1221
(args[0], args[1]))
1222
self.assertIn(expected_call, self.bus.calls)
1223
1224
1225
class Test_dbus_python_adapter_SystemBus(TestCaseWithAssertLogs):
1226
1227
def MockDBusPython_func(self, func):
1228
class mock_dbus_python(object):
1229
"""mock dbus-python module"""
1230
class exceptions(object):
1231
"""Pseudo-namespace"""
1232
class DBusException(Exception):
1233
pass
1234
class SystemBus(object):
1235
@staticmethod
1236
def get_object(busname, objectpath):
1237
DBusObject = collections.namedtuple(
1238
"DBusObject", ("methodname",))
1239
def method(*args, **kwargs):
1240
self.assertEqual({"dbus_interface":
1241
"interface"},
1242
kwargs)
1243
return func(*args)
1244
return DBusObject(methodname=method)
1245
class Boolean(object):
1246
def __init__(self, value):
1247
self.value = bool(value)
1248
def __bool__(self):
1249
return self.value
1250
if sys.version_info.major == 2:
1251
__nonzero__ = __bool__
1252
class ObjectPath(str):
1253
pass
1254
class Dictionary(dict):
1255
pass
1256
return mock_dbus_python
1257
1258
def call_method(self, bus, methodname, busname, objectpath,
1259
interface, *args):
1260
with self.assertLogs(log, logging.DEBUG):
1261
return bus.call_method(methodname, busname, objectpath,
1262
interface, *args)
1263
1264
def test_call_method_returns(self):
1265
expected_method_return = Unique()
1266
method_args = (Unique(), Unique())
1267
def func(*args):
1268
self.assertEqual(len(method_args), len(args))
1269
for marg, arg in zip(method_args, args):
1270
self.assertIs(marg, arg)
1271
return expected_method_return
1272
mock_dbus_python = self.MockDBusPython_func(func)
1273
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1274
ret = self.call_method(bus, "methodname", "busname",
1275
"objectpath", "interface",
1276
*method_args)
1277
self.assertIs(ret, expected_method_return)
1278
1279
def test_call_method_filters_bool_true(self):
1280
def func():
1281
return method_return
1282
mock_dbus_python = self.MockDBusPython_func(func)
1283
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1284
method_return = mock_dbus_python.Boolean(True)
1285
ret = self.call_method(bus, "methodname", "busname",
1286
"objectpath", "interface")
1287
self.assertTrue(ret)
1288
self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1289
1290
def test_call_method_filters_bool_false(self):
1291
def func():
1292
return method_return
1293
mock_dbus_python = self.MockDBusPython_func(func)
1294
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1295
method_return = mock_dbus_python.Boolean(False)
1296
ret = self.call_method(bus, "methodname", "busname",
1297
"objectpath", "interface")
1298
self.assertFalse(ret)
1299
self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1300
1301
def test_call_method_filters_objectpath(self):
1302
def func():
1303
return method_return
1304
mock_dbus_python = self.MockDBusPython_func(func)
1305
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1306
method_return = mock_dbus_python.ObjectPath("objectpath")
1307
ret = self.call_method(bus, "methodname", "busname",
1308
"objectpath", "interface")
1309
self.assertEqual("objectpath", ret)
1310
self.assertIsNot("objectpath", ret)
1311
self.assertNotIsInstance(ret, mock_dbus_python.ObjectPath)
1312
1313
def test_call_method_filters_booleans_in_dict(self):
1314
def func():
1315
return method_return
1316
mock_dbus_python = self.MockDBusPython_func(func)
1317
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1318
method_return = mock_dbus_python.Dictionary(
1319
{mock_dbus_python.Boolean(True):
1320
mock_dbus_python.Boolean(False),
1321
mock_dbus_python.Boolean(False):
1322
mock_dbus_python.Boolean(True)})
1323
ret = self.call_method(bus, "methodname", "busname",
1324
"objectpath", "interface")
1325
expected_method_return = {True: False,
1326
False: True}
1327
self.assertEqual(expected_method_return, ret)
1328
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1329
1330
def test_call_method_filters_objectpaths_in_dict(self):
1331
def func():
1332
return method_return
1333
mock_dbus_python = self.MockDBusPython_func(func)
1334
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1335
method_return = mock_dbus_python.Dictionary(
1336
{mock_dbus_python.ObjectPath("objectpath_key_1"):
1337
mock_dbus_python.ObjectPath("objectpath_value_1"),
1338
mock_dbus_python.ObjectPath("objectpath_key_2"):
1339
mock_dbus_python.ObjectPath("objectpath_value_2")})
1340
ret = self.call_method(bus, "methodname", "busname",
1341
"objectpath", "interface")
1342
expected_method_return = {str(key): str(value)
1343
for key, value in
1344
method_return.items()}
1345
self.assertEqual(expected_method_return, ret)
1346
self.assertIsInstance(ret, dict)
1347
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1348
1349
def test_call_method_filters_dict_in_dict(self):
1350
def func():
1351
return method_return
1352
mock_dbus_python = self.MockDBusPython_func(func)
1353
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1354
method_return = mock_dbus_python.Dictionary(
1355
{"key1": mock_dbus_python.Dictionary({"key11": "value11",
1356
"key12": "value12"}),
1357
"key2": mock_dbus_python.Dictionary({"key21": "value21",
1358
"key22": "value22"})})
1359
ret = self.call_method(bus, "methodname", "busname",
1360
"objectpath", "interface")
1361
expected_method_return = {
1362
"key1": {"key11": "value11",
1363
"key12": "value12"},
1364
"key2": {"key21": "value21",
1365
"key22": "value22"},
1366
}
1367
self.assertEqual(expected_method_return, ret)
1368
self.assertIsInstance(ret, dict)
1369
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1370
for key, value in ret.items():
1371
self.assertIsInstance(value, dict)
1372
self.assertEqual(expected_method_return[key], value)
1373
self.assertNotIsInstance(value,
1374
mock_dbus_python.Dictionary)
1375
1376
def test_call_method_filters_dict_three_deep(self):
1377
def func():
1378
return method_return
1379
mock_dbus_python = self.MockDBusPython_func(func)
1380
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1381
method_return = mock_dbus_python.Dictionary(
1382
{"key1":
1383
mock_dbus_python.Dictionary(
1384
{"key2":
1385
mock_dbus_python.Dictionary(
1386
{"key3":
1387
mock_dbus_python.Boolean(True),
1388
}),
1389
}),
1390
})
1391
ret = self.call_method(bus, "methodname", "busname",
1392
"objectpath", "interface")
1393
expected_method_return = {"key1": {"key2": {"key3": True}}}
1394
self.assertEqual(expected_method_return, ret)
1395
self.assertIsInstance(ret, dict)
1396
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1397
self.assertIsInstance(ret["key1"], dict)
1398
self.assertNotIsInstance(ret["key1"],
1399
mock_dbus_python.Dictionary)
1400
self.assertIsInstance(ret["key1"]["key2"], dict)
1401
self.assertNotIsInstance(ret["key1"]["key2"],
1402
mock_dbus_python.Dictionary)
1403
self.assertTrue(ret["key1"]["key2"]["key3"])
1404
self.assertNotIsInstance(ret["key1"]["key2"]["key3"],
1405
mock_dbus_python.Boolean)
1406
1407
def test_call_method_handles_exception(self):
1060
self.check_option_syntax(options)
1061
1062
1063
class Test_get_mandos_dbus_object(TestCaseWithAssertLogs):
1064
def test_calls_and_returns_get_object_on_bus(self):
1065
class MockBus(object):
1066
called = False
1067
def get_object(mockbus_self, busname, dbus_path):
1068
# Note that "self" is still the testcase instance,
1069
# this MockBus instance is in "mockbus_self".
1070
self.assertEqual(busname, dbus_busname)
1071
self.assertEqual(dbus_path, server_dbus_path)
1072
mockbus_self.called = True
1073
return mockbus_self
1074
1075
mockbus = get_mandos_dbus_object(bus=MockBus())
1076
self.assertIsInstance(mockbus, MockBus)
1077
self.assertTrue(mockbus.called)
1078
1079
def test_logs_and_exits_on_dbus_error(self):
1080
class MockBusFailing(object):
1081
def get_object(self, busname, dbus_path):
1082
raise dbus.exceptions.DBusException("Test")
1083
1084
with self.assertLogs(log, logging.CRITICAL):
1085
with self.assertRaises(SystemExit) as e:
1086
bus = get_mandos_dbus_object(bus=MockBusFailing())
1087
1088
if isinstance(e.exception.code, int):
1089
self.assertNotEqual(e.exception.code, 0)
1090
else:
1091
self.assertIsNotNone(e.exception.code)
1092
1093
1094
class Test_get_managed_objects(TestCaseWithAssertLogs):
1095
def test_calls_and_returns_GetManagedObjects(self):
1096
managed_objects = {"/clients/foo": { "Name": "foo"}}
1097
class MockObjectManager(object):
1098
def GetManagedObjects(self):
1099
return managed_objects
1100
retval = get_managed_objects(MockObjectManager())
1101
self.assertDictEqual(managed_objects, retval)
1102
1103
def test_logs_and_exits_on_dbus_error(self):
1408
1104
dbus_logger = logging.getLogger("dbus.proxies")
1409
1105
1410
def func():
1411
dbus_logger.error("Test")
1412
raise mock_dbus_python.exceptions.DBusException()
1413
1414
mock_dbus_python = self.MockDBusPython_func(func)
1415
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1106
class MockObjectManagerFailing(object):
1107
def GetManagedObjects(self):
1108
dbus_logger.error("Test")
1109
raise dbus.exceptions.DBusException("Test")
1416
1110
1417
1111
class CountingHandler(logging.Handler):
1418
1112
count = 0
1424
1118
dbus_logger.addHandler(counting_handler)
1425
1119
1426
1120
try:
1427
with self.assertRaises(dbus.Error) as e:
1428
self.call_method(bus, "methodname", "busname",
1429
"objectpath", "interface")
1121
with self.assertLogs(log, logging.CRITICAL) as watcher:
1122
with self.assertRaises(SystemExit) as e:
1123
get_managed_objects(MockObjectManagerFailing())
1430
1124
finally:
1431
1125
dbus_logger.removeFilter(counting_handler)
1432
1126
1433
self.assertNotIsInstance(e, dbus.ConnectFailed)
1434
1435
1127
# Make sure the dbus logger was suppressed
1436
self.assertEqual(0, counting_handler.count)
1437
1438
def test_get_object_converts_to_correct_exception(self):
1439
bus = dbus_python_adapter.SystemBus(
1440
self.fake_dbus_python_raises_exception_on_connect)
1441
with self.assertRaises(dbus.ConnectFailed):
1442
self.call_method(bus, "methodname", "busname",
1443
"objectpath", "interface")
1444
1445
class fake_dbus_python_raises_exception_on_connect(object):
1446
"""fake dbus-python module"""
1447
class exceptions(object):
1448
"""Pseudo-namespace"""
1449
class DBusException(Exception):
1450
pass
1451
1452
@classmethod
1453
def SystemBus(cls):
1454
def get_object(busname, objectpath):
1455
raise cls.exceptions.DBusException()
1456
Bus = collections.namedtuple("Bus", ["get_object"])
1457
return Bus(get_object=get_object)
1458
1459
1460
class Test_dbus_python_adapter_CachingBus(unittest.TestCase):
1461
class mock_dbus_python(object):
1462
"""mock dbus-python modules"""
1463
class SystemBus(object):
1464
@staticmethod
1465
def get_object(busname, objectpath):
1466
return Unique()
1467
1468
def setUp(self):
1469
self.bus = dbus_python_adapter.CachingBus(
1470
self.mock_dbus_python)
1471
1472
def test_returns_distinct_objectpaths(self):
1473
obj1 = self.bus.get_object("busname", "objectpath1")
1474
self.assertIsInstance(obj1, Unique)
1475
obj2 = self.bus.get_object("busname", "objectpath2")
1476
self.assertIsInstance(obj2, Unique)
1477
self.assertIsNot(obj1, obj2)
1478
1479
def test_returns_distinct_busnames(self):
1480
obj1 = self.bus.get_object("busname1", "objectpath")
1481
self.assertIsInstance(obj1, Unique)
1482
obj2 = self.bus.get_object("busname2", "objectpath")
1483
self.assertIsInstance(obj2, Unique)
1484
self.assertIsNot(obj1, obj2)
1485
1486
def test_returns_distinct_both(self):
1487
obj1 = self.bus.get_object("busname1", "objectpath")
1488
self.assertIsInstance(obj1, Unique)
1489
obj2 = self.bus.get_object("busname2", "objectpath")
1490
self.assertIsInstance(obj2, Unique)
1491
self.assertIsNot(obj1, obj2)
1492
1493
def test_returns_same(self):
1494
obj1 = self.bus.get_object("busname", "objectpath")
1495
self.assertIsInstance(obj1, Unique)
1496
obj2 = self.bus.get_object("busname", "objectpath")
1497
self.assertIsInstance(obj2, Unique)
1498
self.assertIs(obj1, obj2)
1499
1500
def test_returns_same_old(self):
1501
obj1 = self.bus.get_object("busname1", "objectpath1")
1502
self.assertIsInstance(obj1, Unique)
1503
obj2 = self.bus.get_object("busname2", "objectpath2")
1504
self.assertIsInstance(obj2, Unique)
1505
obj1b = self.bus.get_object("busname1", "objectpath1")
1506
self.assertIsInstance(obj1b, Unique)
1507
self.assertIsNot(obj1, obj2)
1508
self.assertIsNot(obj2, obj1b)
1509
self.assertIs(obj1, obj1b)
1128
self.assertEqual(counting_handler.count, 0)
1129
1130
# Test that the dbus_logger still works
1131
with self.assertLogs(dbus_logger, logging.ERROR):
1132
dbus_logger.error("Test")
1133
1134
if isinstance(e.exception.code, int):
1135
self.assertNotEqual(e.exception.code, 0)
1136
else:
1137
self.assertIsNotNone(e.exception.code)
1510
1138
1511
1139
1512
1140
class Test_commands_from_options(unittest.TestCase):
1513
1514
1141
def setUp(self):
1515
1142
self.parser = argparse.ArgumentParser()
1516
1143
add_command_line_options(self.parser)
1517
1144
1518
1145
def test_is_enabled(self):
1519
self.assert_command_from_args(["--is-enabled", "client"],
1520
command.IsEnabled)
1146
self.assert_command_from_args(["--is-enabled", "foo"],
1147
IsEnabledCmd)
1521
1148
1522
1149
def assert_command_from_args(self, args, command_cls,
1523
1150
**cmd_attrs):
1526
1153
options = self.parser.parse_args(args)
1527
1154
check_option_syntax(self.parser, options)
1528
1155
commands = commands_from_options(options)
1529
self.assertEqual(1, len(commands))
1156
self.assertEqual(len(commands), 1)
1530
1157
command = commands[0]
1531
1158
self.assertIsInstance(command, command_cls)
1532
1159
for key, value in cmd_attrs.items():
1533
self.assertEqual(value, getattr(command, key))
1160
self.assertEqual(getattr(command, key), value)
1534
1161
1535
1162
def test_is_enabled_short(self):
1536
self.assert_command_from_args(["-V", "client"],
1537
command.IsEnabled)
1163
self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
1538
1164
1539
1165
def test_approve(self):
1540
self.assert_command_from_args(["--approve", "client"],
1541
command.Approve)
1166
self.assert_command_from_args(["--approve", "foo"],
1167
ApproveCmd)
1542
1168
1543
1169
def test_approve_short(self):
1544
self.assert_command_from_args(["-A", "client"],
1545
command.Approve)
1170
self.assert_command_from_args(["-A", "foo"], ApproveCmd)
1546
1171
1547
1172
def test_deny(self):
1548
self.assert_command_from_args(["--deny", "client"],
1549
command.Deny)
1173
self.assert_command_from_args(["--deny", "foo"], DenyCmd)
1550
1174
1551
1175
def test_deny_short(self):
1552
self.assert_command_from_args(["-D", "client"], command.Deny)
1176
self.assert_command_from_args(["-D", "foo"], DenyCmd)
1553
1177
1554
1178
def test_remove(self):
1555
self.assert_command_from_args(["--remove", "client"],
1556
command.Remove)
1179
self.assert_command_from_args(["--remove", "foo"],
1180
RemoveCmd)
1557
1181
1558
1182
def test_deny_before_remove(self):
1559
1183
options = self.parser.parse_args(["--deny", "--remove",
1560
"client"])
1184
"foo"])
1561
1185
check_option_syntax(self.parser, options)
1562
1186
commands = commands_from_options(options)
1563
self.assertEqual(2, len(commands))
1564
self.assertIsInstance(commands[0], command.Deny)
1565
self.assertIsInstance(commands[1], command.Remove)
1187
self.assertEqual(len(commands), 2)
1188
self.assertIsInstance(commands[0], DenyCmd)
1189
self.assertIsInstance(commands[1], RemoveCmd)
1566
1190
1567
1191
def test_deny_before_remove_reversed(self):
1568
1192
options = self.parser.parse_args(["--remove", "--deny",
1569
1193
"--all"])
1570
1194
check_option_syntax(self.parser, options)
1571
1195
commands = commands_from_options(options)
1572
self.assertEqual(2, len(commands))
1573
self.assertIsInstance(commands[0], command.Deny)
1574
self.assertIsInstance(commands[1], command.Remove)
1196
self.assertEqual(len(commands), 2)
1197
self.assertIsInstance(commands[0], DenyCmd)
1198
self.assertIsInstance(commands[1], RemoveCmd)
1575
1199
1576
1200
def test_remove_short(self):
1577
self.assert_command_from_args(["-r", "client"],
1578
command.Remove)
1201
self.assert_command_from_args(["-r", "foo"], RemoveCmd)
1579
1202
1580
1203
def test_dump_json(self):
1581
self.assert_command_from_args(["--dump-json"],
1582
command.DumpJSON)
1204
self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
1583
1205
1584
1206
def test_enable(self):
1585
self.assert_command_from_args(["--enable", "client"],
1586
command.Enable)
1207
self.assert_command_from_args(["--enable", "foo"], EnableCmd)
1587
1208
1588
1209
def test_enable_short(self):
1589
self.assert_command_from_args(["-e", "client"],
1590
command.Enable)
1210
self.assert_command_from_args(["-e", "foo"], EnableCmd)
1591
1211
1592
1212
def test_disable(self):
1593
self.assert_command_from_args(["--disable", "client"],
1594
command.Disable)
1213
self.assert_command_from_args(["--disable", "foo"],
1214
DisableCmd)
1595
1215
1596
1216
def test_disable_short(self):
1597
self.assert_command_from_args(["-d", "client"],
1598
command.Disable)
1217
self.assert_command_from_args(["-d", "foo"], DisableCmd)
1599
1218
1600
1219
def test_bump_timeout(self):
1601
self.assert_command_from_args(["--bump-timeout", "client"],
1602
command.BumpTimeout)
1220
self.assert_command_from_args(["--bump-timeout", "foo"],
1221
BumpTimeoutCmd)
1603
1222
1604
1223
def test_bump_timeout_short(self):
1605
self.assert_command_from_args(["-b", "client"],
1606
command.BumpTimeout)
1224
self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
1607
1225
1608
1226
def test_start_checker(self):
1609
self.assert_command_from_args(["--start-checker", "client"],
1610
command.StartChecker)
1227
self.assert_command_from_args(["--start-checker", "foo"],
1228
StartCheckerCmd)
1611
1229
1612
1230
def test_stop_checker(self):
1613
self.assert_command_from_args(["--stop-checker", "client"],
1614
command.StopChecker)
1231
self.assert_command_from_args(["--stop-checker", "foo"],
1232
StopCheckerCmd)
1615
1233
1616
1234
def test_approve_by_default(self):
1617
self.assert_command_from_args(["--approve-by-default",
1618
"client"],
1619
command.ApproveByDefault)
1235
self.assert_command_from_args(["--approve-by-default", "foo"],
1236
ApproveByDefaultCmd)
1620
1237
1621
1238
def test_deny_by_default(self):
1622
self.assert_command_from_args(["--deny-by-default", "client"],
1623
command.DenyByDefault)
1239
self.assert_command_from_args(["--deny-by-default", "foo"],
1240
DenyByDefaultCmd)
1624
1241
1625
1242
def test_checker(self):
1626
self.assert_command_from_args(["--checker", ":", "client"],
1627
command.SetChecker,
1628
value_to_set=":")
1243
self.assert_command_from_args(["--checker", ":", "foo"],
1244
SetCheckerCmd, value_to_set=":")
1629
1245
1630
1246
def test_checker_empty(self):
1631
self.assert_command_from_args(["--checker", "", "client"],
1632
command.SetChecker,
1633
value_to_set="")
1247
self.assert_command_from_args(["--checker", "", "foo"],
1248
SetCheckerCmd, value_to_set="")
1634
1249
1635
1250
def test_checker_short(self):
1636
self.assert_command_from_args(["-c", ":", "client"],
1637
command.SetChecker,
1638
value_to_set=":")
1251
self.assert_command_from_args(["-c", ":", "foo"],
1252
SetCheckerCmd, value_to_set=":")
1639
1253
1640
1254
def test_host(self):
1641
self.assert_command_from_args(
1642
["--host", "client.example.org", "client"],
1643
command.SetHost, value_to_set="client.example.org")
1255
self.assert_command_from_args(["--host", "foo.example.org",
1256
"foo"], SetHostCmd,
1257
value_to_set="foo.example.org")
1644
1258
1645
1259
def test_host_short(self):
1646
self.assert_command_from_args(
1647
["-H", "client.example.org", "client"], command.SetHost,
1648
value_to_set="client.example.org")
1260
self.assert_command_from_args(["-H", "foo.example.org",
1261
"foo"], SetHostCmd,
1262
value_to_set="foo.example.org")
1649
1263
1650
1264
def test_secret_devnull(self):
1651
1265
self.assert_command_from_args(["--secret", os.path.devnull,
1652
"client"], command.SetSecret,
1266
"foo"], SetSecretCmd,
1653
1267
value_to_set=b"")
1654
1268
1655
1269
def test_secret_tempfile(self):
1658
1272
f.write(value)
1659
1273
f.seek(0)
1660
1274
self.assert_command_from_args(["--secret", f.name,
1661
"client"],
1662
command.SetSecret,
1275
"foo"], SetSecretCmd,
1663
1276
value_to_set=value)
1664
1277
1665
1278
def test_secret_devnull_short(self):
1666
self.assert_command_from_args(["-s", os.path.devnull,
1667
"client"], command.SetSecret,
1668
value_to_set=b"")
1279
self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1280
SetSecretCmd, value_to_set=b"")
1669
1281
1670
1282
def test_secret_tempfile_short(self):
1671
1283
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1672
1284
value = b"secret\0xyzzy\nbar"
1673
1285
f.write(value)
1674
1286
f.seek(0)
1675
self.assert_command_from_args(["-s", f.name, "client"],
1676
command.SetSecret,
1287
self.assert_command_from_args(["-s", f.name, "foo"],
1288
SetSecretCmd,
1677
1289
value_to_set=value)
1678
1290
1679
1291
def test_timeout(self):
1680
self.assert_command_from_args(["--timeout", "PT5M", "client"],
1681
command.SetTimeout,
1292
self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1293
SetTimeoutCmd,
1682
1294
value_to_set=300000)
1683
1295
1684
1296
def test_timeout_short(self):
1685
self.assert_command_from_args(["-t", "PT5M", "client"],
1686
command.SetTimeout,
1297
self.assert_command_from_args(["-t", "PT5M", "foo"],
1298
SetTimeoutCmd,
1687
1299
value_to_set=300000)
1688
1300
1689
1301
def test_extended_timeout(self):
1690
1302
self.assert_command_from_args(["--extended-timeout", "PT15M",
1691
"client"],
1692
command.SetExtendedTimeout,
1303
"foo"],
1304
SetExtendedTimeoutCmd,
1693
1305
value_to_set=900000)
1694
1306
1695
1307
def test_interval(self):
1696
self.assert_command_from_args(["--interval", "PT2M",
1697
"client"], command.SetInterval,
1308
self.assert_command_from_args(["--interval", "PT2M", "foo"],
1309
SetIntervalCmd,
1698
1310
value_to_set=120000)
1699
1311
1700
1312
def test_interval_short(self):
1701
self.assert_command_from_args(["-i", "PT2M", "client"],
1702
command.SetInterval,
1313
self.assert_command_from_args(["-i", "PT2M", "foo"],
1314
SetIntervalCmd,
1703
1315
value_to_set=120000)
1704
1316
1705
1317
def test_approval_delay(self):
1706
1318
self.assert_command_from_args(["--approval-delay", "PT30S",
1707
"client"],
1708
command.SetApprovalDelay,
1319
"foo"], SetApprovalDelayCmd,
1709
1320
value_to_set=30000)
1710
1321
1711
1322
def test_approval_duration(self):
1712
1323
self.assert_command_from_args(["--approval-duration", "PT1S",
1713
"client"],
1714
command.SetApprovalDuration,
1324
"foo"], SetApprovalDurationCmd,
1715
1325
value_to_set=1000)
1716
1326
1717
1327
def test_print_table(self):
1718
self.assert_command_from_args([], command.PrintTable,
1328
self.assert_command_from_args([], PrintTableCmd,
1719
1329
verbose=False)
1720
1330
1721
1331
def test_print_table_verbose(self):
1722
self.assert_command_from_args(["--verbose"],
1723
command.PrintTable,
1332
self.assert_command_from_args(["--verbose"], PrintTableCmd,
1724
1333
verbose=True)
1725
1334
1726
1335
def test_print_table_verbose_short(self):
1727
self.assert_command_from_args(["-v"], command.PrintTable,
1336
self.assert_command_from_args(["-v"], PrintTableCmd,
1728
1337
verbose=True)
1729
1338
1730
1339
1731
class TestCommand(unittest.TestCase):
1340
class TestCmd(unittest.TestCase):
1732
1341
"""Abstract class for tests of command classes"""
1733
1342
1734
class FakeMandosBus(dbus.MandosBus):
1735
def __init__(self, testcase):
1736
self.client_properties = {
1343
def setUp(self):
1344
testcase = self
1345
class MockClient(object):
1346
def __init__(self, name, **attributes):
1347
self.__dbus_object_path__ = "/clients/{}".format(name)
1348
self.attributes = attributes
1349
self.attributes["Name"] = name
1350
self.calls = []
1351
def Set(self, interface, propname, value, dbus_interface):
1352
testcase.assertEqual(interface, client_dbus_interface)
1353
testcase.assertEqual(dbus_interface,
1354
dbus.PROPERTIES_IFACE)
1355
self.attributes[propname] = value
1356
def Get(self, interface, propname, dbus_interface):
1357
testcase.assertEqual(interface, client_dbus_interface)
1358
testcase.assertEqual(dbus_interface,
1359
dbus.PROPERTIES_IFACE)
1360
return self.attributes[propname]
1361
def Approve(self, approve, dbus_interface):
1362
testcase.assertEqual(dbus_interface,
1363
client_dbus_interface)
1364
self.calls.append(("Approve", (approve,
1365
dbus_interface)))
1366
self.client = MockClient(
1367
"foo",
1368
KeyID=("92ed150794387c03ce684574b1139a65"
1369
"94a34f895daaaf09fd8ea90a27cddb12"),
1370
Secret=b"secret",
1371
Host="foo.example.org",
1372
Enabled=dbus.Boolean(True),
1373
Timeout=300000,
1374
LastCheckedOK="2019-02-03T00:00:00",
1375
Created="2019-01-02T00:00:00",
1376
Interval=120000,
1377
Fingerprint=("778827225BA7DE539C5A"
1378
"7CFA59CFF7CDBD9A5920"),
1379
CheckerRunning=dbus.Boolean(False),
1380
LastEnabled="2019-01-03T00:00:00",
1381
ApprovalPending=dbus.Boolean(False),
1382
ApprovedByDefault=dbus.Boolean(True),
1383
LastApprovalRequest="",
1384
ApprovalDelay=0,
1385
ApprovalDuration=1000,
1386
Checker="fping -q -- %(host)s",
1387
ExtendedTimeout=900000,
1388
Expires="2019-02-04T00:00:00",
1389
LastCheckerStatus=0)
1390
self.other_client = MockClient(
1391
"barbar",
1392
KeyID=("0558568eedd67d622f5c83b35a115f79"
1393
"6ab612cff5ad227247e46c2b020f441c"),
1394
Secret=b"secretbar",
1395
Host="192.0.2.3",
1396
Enabled=dbus.Boolean(True),
1397
Timeout=300000,
1398
LastCheckedOK="2019-02-04T00:00:00",
1399
Created="2019-01-03T00:00:00",
1400
Interval=120000,
1401
Fingerprint=("3E393AEAEFB84C7E89E2"
1402
"F547B3A107558FCA3A27"),
1403
CheckerRunning=dbus.Boolean(True),
1404
LastEnabled="2019-01-04T00:00:00",
1405
ApprovalPending=dbus.Boolean(False),
1406
ApprovedByDefault=dbus.Boolean(False),
1407
LastApprovalRequest="2019-01-03T00:00:00",
1408
ApprovalDelay=30000,
1409
ApprovalDuration=93785000,
1410
Checker=":",
1411
ExtendedTimeout=900000,
1412
Expires="2019-02-05T00:00:00",
1413
LastCheckerStatus=-2)
1414
self.clients = collections.OrderedDict(
1415
[
1416
("/clients/foo", self.client.attributes),
1417
("/clients/barbar", self.other_client.attributes),
1418
])
1419
self.one_client = {"/clients/foo": self.client.attributes}
1420
1421
@property
1422
def bus(self):
1423
class Bus(object):
1424
@staticmethod
1425
def get_object(client_bus_name, path):
1426
self.assertEqual(client_bus_name, dbus_busname)
1427
return {
1428
# Note: "self" here is the TestCmd instance, not
1429
# the Bus instance, since this is a static method!
1430
"/clients/foo": self.client,
1431
"/clients/barbar": self.other_client,
1432
}[path]
1433
return Bus()
1434
1435
1436
class TestIsEnabledCmd(TestCmd):
1437
def test_is_enabled(self):
1438
self.assertTrue(all(IsEnabledCmd().is_enabled(client,
1439
properties)
1440
for client, properties
1441
in self.clients.items()))
1442
1443
def test_is_enabled_run_exits_successfully(self):
1444
with self.assertRaises(SystemExit) as e:
1445
IsEnabledCmd().run(self.one_client)
1446
if e.exception.code is not None:
1447
self.assertEqual(e.exception.code, 0)
1448
else:
1449
self.assertIsNone(e.exception.code)
1450
1451
def test_is_enabled_run_exits_with_failure(self):
1452
self.client.attributes["Enabled"] = dbus.Boolean(False)
1453
with self.assertRaises(SystemExit) as e:
1454
IsEnabledCmd().run(self.one_client)
1455
if isinstance(e.exception.code, int):
1456
self.assertNotEqual(e.exception.code, 0)
1457
else:
1458
self.assertIsNotNone(e.exception.code)
1459
1460
1461
class TestApproveCmd(TestCmd):
1462
def test_approve(self):
1463
ApproveCmd().run(self.clients, self.bus)
1464
for clientpath in self.clients:
1465
client = self.bus.get_object(dbus_busname, clientpath)
1466
self.assertIn(("Approve", (True, client_dbus_interface)),
1467
client.calls)
1468
1469
1470
class TestDenyCmd(TestCmd):
1471
def test_deny(self):
1472
DenyCmd().run(self.clients, self.bus)
1473
for clientpath in self.clients:
1474
client = self.bus.get_object(dbus_busname, clientpath)
1475
self.assertIn(("Approve", (False, client_dbus_interface)),
1476
client.calls)
1477
1478
1479
class TestRemoveCmd(TestCmd):
1480
def test_remove(self):
1481
class MockMandos(object):
1482
def __init__(self):
1483
self.calls = []
1484
def RemoveClient(self, dbus_path):
1485
self.calls.append(("RemoveClient", (dbus_path,)))
1486
mandos = MockMandos()
1487
super(TestRemoveCmd, self).setUp()
1488
RemoveCmd().run(self.clients, self.bus, mandos)
1489
self.assertEqual(len(mandos.calls), 2)
1490
for clientpath in self.clients:
1491
self.assertIn(("RemoveClient", (clientpath,)),
1492
mandos.calls)
1493
1494
1495
class TestDumpJSONCmd(TestCmd):
1496
def setUp(self):
1497
self.expected_json = {
1498
"foo": {
1737
1499
"Name": "foo",
1738
1500
"KeyID": ("92ed150794387c03ce684574b1139a65"
1739
1501
"94a34f895daaaf09fd8ea90a27cddb12"),
1740
"Secret": b"secret",
1741
1502
"Host": "foo.example.org",
1742
1503
"Enabled": True,
1743
1504
"Timeout": 300000,
1757
1518
"ExtendedTimeout": 900000,
1758
1519
"Expires": "2019-02-04T00:00:00",
1759
1520
"LastCheckerStatus": 0,
1760
}
1761
self.other_client_properties = {
1521
},
1522
"barbar": {
1762
1523
"Name": "barbar",
1763
1524
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
1764
1525
"6ab612cff5ad227247e46c2b020f441c"),
1765
"Secret": b"secretbar",
1766
1526
"Host": "192.0.2.3",
1767
1527
"Enabled": True,
1768
1528
"Timeout": 300000,
1782
1542
"ExtendedTimeout": 900000,
1783
1543
"Expires": "2019-02-05T00:00:00",
1784
1544
"LastCheckerStatus": -2,
1785
}
1786
self.clients = collections.OrderedDict(
1787
[
1788
("client_objectpath", self.client_properties),
1789
("other_client_objectpath",
1790
self.other_client_properties),
1791
])
1792
self.one_client = {"client_objectpath":
1793
self.client_properties}
1794
self.testcase = testcase
1795
self.calls = []
1796
1797
def call_method(self, methodname, busname, objectpath,
1798
interface, *args):
1799
self.testcase.assertEqual("se.recompile.Mandos", busname)
1800
self.calls.append((methodname, busname, objectpath,
1801
interface, args))
1802
if interface == "org.freedesktop.DBus.Properties":
1803
if methodname == "Set":
1804
self.testcase.assertEqual(3, len(args))
1805
interface, key, value = args
1806
self.testcase.assertEqual(
1807
"se.recompile.Mandos.Client", interface)
1808
self.clients[objectpath][key] = value
1809
return
1810
elif interface == "se.recompile.Mandos":
1811
self.testcase.assertEqual("RemoveClient", methodname)
1812
self.testcase.assertEqual(1, len(args))
1813
clientpath = args[0]
1814
del self.clients[clientpath]
1815
return
1816
elif interface == "se.recompile.Mandos.Client":
1817
if methodname == "Approve":
1818
self.testcase.assertEqual(1, len(args))
1819
return
1820
raise ValueError()
1821
1822
def setUp(self):
1823
self.bus = self.FakeMandosBus(self)
1824
1825
1826
class TestBaseCommands(TestCommand):
1827
1828
def test_IsEnabled_exits_successfully(self):
1829
with self.assertRaises(SystemExit) as e:
1830
command.IsEnabled().run(self.bus.one_client)
1831
if e.exception.code is not None:
1832
self.assertEqual(0, e.exception.code)
1833
else:
1834
self.assertIsNone(e.exception.code)
1835
1836
def test_IsEnabled_exits_with_failure(self):
1837
self.bus.client_properties["Enabled"] = False
1838
with self.assertRaises(SystemExit) as e:
1839
command.IsEnabled().run(self.bus.one_client)
1840
if isinstance(e.exception.code, int):
1841
self.assertNotEqual(0, e.exception.code)
1842
else:
1843
self.assertIsNotNone(e.exception.code)
1844
1845
def test_Approve(self):
1846
busname = "se.recompile.Mandos"
1847
client_interface = "se.recompile.Mandos.Client"
1848
command.Approve().run(self.bus.clients, self.bus)
1849
for clientpath in self.bus.clients:
1850
self.assertIn(("Approve", busname, clientpath,
1851
client_interface, (True,)), self.bus.calls)
1852
1853
def test_Deny(self):
1854
busname = "se.recompile.Mandos"
1855
client_interface = "se.recompile.Mandos.Client"
1856
command.Deny().run(self.bus.clients, self.bus)
1857
for clientpath in self.bus.clients:
1858
self.assertIn(("Approve", busname, clientpath,
1859
client_interface, (False,)),
1860
self.bus.calls)
1861
1862
def test_Remove(self):
1863
command.Remove().run(self.bus.clients, self.bus)
1864
for clientpath in self.bus.clients:
1865
self.assertIn(("RemoveClient", dbus_busname,
1866
dbus_server_path, dbus_server_interface,
1867
(clientpath,)), self.bus.calls)
1868
1869
expected_json = {
1870
"foo": {
1871
"Name": "foo",
1872
"KeyID": ("92ed150794387c03ce684574b1139a65"
1873
"94a34f895daaaf09fd8ea90a27cddb12"),
1874
"Host": "foo.example.org",
1875
"Enabled": True,
1876
"Timeout": 300000,
1877
"LastCheckedOK": "2019-02-03T00:00:00",
1878
"Created": "2019-01-02T00:00:00",
1879
"Interval": 120000,
1880
"Fingerprint": ("778827225BA7DE539C5A"
1881
"7CFA59CFF7CDBD9A5920"),
1882
"CheckerRunning": False,
1883
"LastEnabled": "2019-01-03T00:00:00",
1884
"ApprovalPending": False,
1885
"ApprovedByDefault": True,
1886
"LastApprovalRequest": "",
1887
"ApprovalDelay": 0,
1888
"ApprovalDuration": 1000,
1889
"Checker": "fping -q -- %(host)s",
1890
"ExtendedTimeout": 900000,
1891
"Expires": "2019-02-04T00:00:00",
1892
"LastCheckerStatus": 0,
1893
},
1894
"barbar": {
1895
"Name": "barbar",
1896
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
1897
"6ab612cff5ad227247e46c2b020f441c"),
1898
"Host": "192.0.2.3",
1899
"Enabled": True,
1900
"Timeout": 300000,
1901
"LastCheckedOK": "2019-02-04T00:00:00",
1902
"Created": "2019-01-03T00:00:00",
1903
"Interval": 120000,
1904
"Fingerprint": ("3E393AEAEFB84C7E89E2"
1905
"F547B3A107558FCA3A27"),
1906
"CheckerRunning": True,
1907
"LastEnabled": "2019-01-04T00:00:00",
1908
"ApprovalPending": False,
1909
"ApprovedByDefault": False,
1910
"LastApprovalRequest": "2019-01-03T00:00:00",
1911
"ApprovalDelay": 30000,
1912
"ApprovalDuration": 93785000,
1913
"Checker": ":",
1914
"ExtendedTimeout": 900000,
1915
"Expires": "2019-02-05T00:00:00",
1916
"LastCheckerStatus": -2,
1917
},
1918
}
1919
1920
def test_DumpJSON_normal(self):
1921
with self.capture_stdout_to_buffer() as buffer:
1922
command.DumpJSON().run(self.bus.clients)
1923
json_data = json.loads(buffer.getvalue())
1924
self.assertDictEqual(self.expected_json, json_data)
1925
1926
@staticmethod
1927
@contextlib.contextmanager
1928
def capture_stdout_to_buffer():
1929
capture_buffer = io.StringIO()
1930
old_stdout = sys.stdout
1931
sys.stdout = capture_buffer
1932
try:
1933
yield capture_buffer
1934
finally:
1935
sys.stdout = old_stdout
1936
1937
def test_DumpJSON_one_client(self):
1938
with self.capture_stdout_to_buffer() as buffer:
1939
command.DumpJSON().run(self.bus.one_client)
1940
json_data = json.loads(buffer.getvalue())
1545
},
1546
}
1547
return super(TestDumpJSONCmd, self).setUp()
1548
1549
def test_normal(self):
1550
output = DumpJSONCmd().output(self.clients.values())
1551
json_data = json.loads(output)
1552
self.assertDictEqual(json_data, self.expected_json)
1553
1554
def test_one_client(self):
1555
output = DumpJSONCmd().output(self.one_client.values())
1556
json_data = json.loads(output)
1941
1557
expected_json = {"foo": self.expected_json["foo"]}
1942
self.assertDictEqual(expected_json, json_data)
1943
1944
def test_PrintTable_normal(self):
1945
with self.capture_stdout_to_buffer() as buffer:
1946
command.PrintTable().run(self.bus.clients)
1558
self.assertDictEqual(json_data, expected_json)
1559
1560
1561
class TestPrintTableCmd(TestCmd):
1562
def test_normal(self):
1563
output = PrintTableCmd().output(self.clients.values())
1947
1564
expected_output = "\n".join((
1948
1565
"Name Enabled Timeout Last Successful Check",
1949
1566
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1950
1567
"barbar Yes 00:05:00 2019-02-04T00:00:00 ",
1951
)) + "\n"
1952
self.assertEqual(expected_output, buffer.getvalue())
1568
))
1569
self.assertEqual(output, expected_output)
1953
1570
1954
def test_PrintTable_verbose(self):
1955
with self.capture_stdout_to_buffer() as buffer:
1956
command.PrintTable(verbose=True).run(self.bus.clients)
1571
def test_verbose(self):
1572
output = PrintTableCmd(verbose=True).output(
1573
self.clients.values())
1957
1574
columns = (
1958
1575
(
1959
1576
"Name ",
2041
1658
)
2042
1659
)
2043
1660
num_lines = max(len(rows) for rows in columns)
2044
expected_output = ("\n".join("".join(rows[line]
2045
for rows in columns)
2046
for line in range(num_lines))
2047
+ "\n")
2048
self.assertEqual(expected_output, buffer.getvalue())
1661
expected_output = "\n".join("".join(rows[line]
1662
for rows in columns)
1663
for line in range(num_lines))
1664
self.assertEqual(output, expected_output)
2049
1665
2050
def test_PrintTable_one_client(self):
2051
with self.capture_stdout_to_buffer() as buffer:
2052
command.PrintTable().run(self.bus.one_client)
1666
def test_one_client(self):
1667
output = PrintTableCmd().output(self.one_client.values())
2053
1668
expected_output = "\n".join((
2054
1669
"Name Enabled Timeout Last Successful Check",
2055
1670
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
2056
)) + "\n"
2057
self.assertEqual(expected_output, buffer.getvalue())
2058
2059
2060
class TestPropertySetterCmd(TestCommand):
2061
"""Abstract class for tests of command.PropertySetter classes"""
2062
1671
))
1672
self.assertEqual(output, expected_output)
1673
1674
1675
class TestPropertyCmd(TestCmd):
1676
"""Abstract class for tests of PropertyCmd classes"""
2063
1677
def runTest(self):
2064
1678
if not hasattr(self, "command"):
2065
return # Abstract TestCase class
2066
2067
if hasattr(self, "values_to_set"):
2068
cmd_args = [(value,) for value in self.values_to_set]
2069
values_to_get = getattr(self, "values_to_get",
2070
self.values_to_set)
2071
else:
2072
cmd_args = [() for x in range(len(self.values_to_get))]
2073
values_to_get = self.values_to_get
2074
for value_to_get, cmd_arg in zip(values_to_get, cmd_args):
2075
for clientpath in self.bus.clients:
2076
self.bus.clients[clientpath][self.propname] = (
2077
Unique())
2078
self.command(*cmd_arg).run(self.bus.clients, self.bus)
2079
for clientpath in self.bus.clients:
2080
value = (self.bus.clients[clientpath]
2081
[self.propname])
2082
self.assertNotIsInstance(value, Unique)
2083
self.assertEqual(value_to_get, value)
2084
2085
2086
class TestEnableCmd(TestPropertySetterCmd):
2087
command = command.Enable
2088
propname = "Enabled"
2089
values_to_get = [True]
2090
2091
2092
class TestDisableCmd(TestPropertySetterCmd):
2093
command = command.Disable
2094
propname = "Enabled"
2095
values_to_get = [False]
2096
2097
2098
class TestBumpTimeoutCmd(TestPropertySetterCmd):
2099
command = command.BumpTimeout
1679
return
1680
values_to_get = getattr(self, "values_to_get",
1681
self.values_to_set)
1682
for value_to_set, value_to_get in zip(self.values_to_set,
1683
values_to_get):
1684
for clientpath in self.clients:
1685
client = self.bus.get_object(dbus_busname, clientpath)
1686
old_value = client.attributes[self.propname]
1687
self.assertNotIsInstance(old_value, self.Unique)
1688
client.attributes[self.propname] = self.Unique()
1689
self.run_command(value_to_set, self.clients)
1690
for clientpath in self.clients:
1691
client = self.bus.get_object(dbus_busname, clientpath)
1692
value = client.attributes[self.propname]
1693
self.assertNotIsInstance(value, self.Unique)
1694
self.assertEqual(value, value_to_get)
1695
1696
class Unique(object):
1697
"""Class for objects which exist only to be unique objects,
1698
since unittest.mock.sentinel only exists in Python 3.3"""
1699
1700
def run_command(self, value, clients):
1701
self.command().run(clients, self.bus)
1702
1703
1704
class TestEnableCmd(TestPropertyCmd):
1705
command = EnableCmd
1706
propname = "Enabled"
1707
values_to_set = [dbus.Boolean(True)]
1708
1709
1710
class TestDisableCmd(TestPropertyCmd):
1711
command = DisableCmd
1712
propname = "Enabled"
1713
values_to_set = [dbus.Boolean(False)]
1714
1715
1716
class TestBumpTimeoutCmd(TestPropertyCmd):
1717
command = BumpTimeoutCmd
2100
1718
propname = "LastCheckedOK"
2101
values_to_get = [""]
2102
2103
2104
class TestStartCheckerCmd(TestPropertySetterCmd):
2105
command = command.StartChecker
2106
propname = "CheckerRunning"
2107
values_to_get = [True]
2108
2109
2110
class TestStopCheckerCmd(TestPropertySetterCmd):
2111
command = command.StopChecker
2112
propname = "CheckerRunning"
2113
values_to_get = [False]
2114
2115
2116
class TestApproveByDefaultCmd(TestPropertySetterCmd):
2117
command = command.ApproveByDefault
2118
propname = "ApprovedByDefault"
2119
values_to_get = [True]
2120
2121
2122
class TestDenyByDefaultCmd(TestPropertySetterCmd):
2123
command = command.DenyByDefault
2124
propname = "ApprovedByDefault"
2125
values_to_get = [False]
2126
2127
2128
class TestSetCheckerCmd(TestPropertySetterCmd):
2129
command = command.SetChecker
1719
values_to_set = [""]
1720
1721
1722
class TestStartCheckerCmd(TestPropertyCmd):
1723
command = StartCheckerCmd
1724
propname = "CheckerRunning"
1725
values_to_set = [dbus.Boolean(True)]
1726
1727
1728
class TestStopCheckerCmd(TestPropertyCmd):
1729
command = StopCheckerCmd
1730
propname = "CheckerRunning"
1731
values_to_set = [dbus.Boolean(False)]
1732
1733
1734
class TestApproveByDefaultCmd(TestPropertyCmd):
1735
command = ApproveByDefaultCmd
1736
propname = "ApprovedByDefault"
1737
values_to_set = [dbus.Boolean(True)]
1738
1739
1740
class TestDenyByDefaultCmd(TestPropertyCmd):
1741
command = DenyByDefaultCmd
1742
propname = "ApprovedByDefault"
1743
values_to_set = [dbus.Boolean(False)]
1744
1745
1746
class TestPropertyValueCmd(TestPropertyCmd):
1747
"""Abstract class for tests of PropertyValueCmd classes"""
1748
1749
def runTest(self):
1750
if type(self) is TestPropertyValueCmd:
1751
return
1752
return super(TestPropertyValueCmd, self).runTest()
1753
1754
def run_command(self, value, clients):
1755
self.command(value).run(clients, self.bus)
1756
1757
1758
class TestSetCheckerCmd(TestPropertyValueCmd):
1759
command = SetCheckerCmd
2130
1760
propname = "Checker"
2131
1761
values_to_set = ["", ":", "fping -q -- %s"]
2132
1762
2133
1763
2134
class TestSetHostCmd(TestPropertySetterCmd):
2135
command = command.SetHost
1764
class TestSetHostCmd(TestPropertyValueCmd):
1765
command = SetHostCmd
2136
1766
propname = "Host"
2137
values_to_set = ["192.0.2.3", "client.example.org"]
2138
2139
2140
class TestSetSecretCmd(TestPropertySetterCmd):
2141
command = command.SetSecret
1767
values_to_set = ["192.0.2.3", "foo.example.org"]
1768
1769
1770
class TestSetSecretCmd(TestPropertyValueCmd):
1771
command = SetSecretCmd
2142
1772
propname = "Secret"
2143
1773
values_to_set = [io.BytesIO(b""),
2144
1774
io.BytesIO(b"secret\0xyzzy\nbar")]
2145
values_to_get = [f.getvalue() for f in values_to_set]
2146
2147
2148
class TestSetTimeoutCmd(TestPropertySetterCmd):
2149
command = command.SetTimeout
1775
values_to_get = [b"", b"secret\0xyzzy\nbar"]
1776
1777
1778
class TestSetTimeoutCmd(TestPropertyValueCmd):
1779
command = SetTimeoutCmd
2150
1780
propname = "Timeout"
2151
1781
values_to_set = [datetime.timedelta(),
2152
1782
datetime.timedelta(minutes=5),
2153
1783
datetime.timedelta(seconds=1),
2154
1784
datetime.timedelta(weeks=1),
2155
1785
datetime.timedelta(weeks=52)]
2156
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2157
2158
2159
class TestSetExtendedTimeoutCmd(TestPropertySetterCmd):
2160
command = command.SetExtendedTimeout
1786
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1787
1788
1789
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
1790
command = SetExtendedTimeoutCmd
2161
1791
propname = "ExtendedTimeout"
2162
1792
values_to_set = [datetime.timedelta(),
2163
1793
datetime.timedelta(minutes=5),
2164
1794
datetime.timedelta(seconds=1),
2165
1795
datetime.timedelta(weeks=1),
2166
1796
datetime.timedelta(weeks=52)]
2167
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2168
2169
2170
class TestSetIntervalCmd(TestPropertySetterCmd):
2171
command = command.SetInterval
1797
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1798
1799
1800
class TestSetIntervalCmd(TestPropertyValueCmd):
1801
command = SetIntervalCmd
2172
1802
propname = "Interval"
2173
1803
values_to_set = [datetime.timedelta(),
2174
1804
datetime.timedelta(minutes=5),
2175
1805
datetime.timedelta(seconds=1),
2176
1806
datetime.timedelta(weeks=1),
2177
1807
datetime.timedelta(weeks=52)]
2178
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2179
2180
2181
class TestSetApprovalDelayCmd(TestPropertySetterCmd):
2182
command = command.SetApprovalDelay
1808
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1809
1810
1811
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
1812
command = SetApprovalDelayCmd
2183
1813
propname = "ApprovalDelay"
2184
1814
values_to_set = [datetime.timedelta(),
2185
1815
datetime.timedelta(minutes=5),
2186
1816
datetime.timedelta(seconds=1),
2187
1817
datetime.timedelta(weeks=1),
2188
1818
datetime.timedelta(weeks=52)]
2189
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2190
2191
2192
class TestSetApprovalDurationCmd(TestPropertySetterCmd):
2193
command = command.SetApprovalDuration
1819
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1820
1821
1822
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
1823
command = SetApprovalDurationCmd
2194
1824
propname = "ApprovalDuration"
2195
1825
values_to_set = [datetime.timedelta(),
2196
1826
datetime.timedelta(minutes=5),
2197
1827
datetime.timedelta(seconds=1),
2198
1828
datetime.timedelta(weeks=1),
2199
1829
datetime.timedelta(weeks=52)]
2200
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1830
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
2201
1831
2202
1832
2203
1833
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0