161
122
help="Select all clients")
162
123
parser.add_argument("-v", "--verbose", action="store_true",
163
124
help="Print all fields")
164
parser.add_argument("-j", "--dump-json", action="store_true",
125
parser.add_argument("-j", "--dump-json", dest="commands",
126
action="append_const", default=[],
127
const=command.DumpJSON(),
165
128
help="Dump client data in JSON format")
166
129
enable_disable = parser.add_mutually_exclusive_group()
167
enable_disable.add_argument("-e", "--enable", action="store_true",
130
enable_disable.add_argument("-e", "--enable", dest="commands",
131
action="append_const", default=[],
132
const=command.Enable(),
168
133
help="Enable client")
169
enable_disable.add_argument("-d", "--disable",
134
enable_disable.add_argument("-d", "--disable", dest="commands",
135
action="append_const", default=[],
136
const=command.Disable(),
171
137
help="disable client")
172
parser.add_argument("-b", "--bump-timeout", action="store_true",
138
parser.add_argument("-b", "--bump-timeout", dest="commands",
139
action="append_const", default=[],
140
const=command.BumpTimeout(),
173
141
help="Bump timeout for client")
174
142
start_stop_checker = parser.add_mutually_exclusive_group()
175
143
start_stop_checker.add_argument("--start-checker",
145
action="append_const", default=[],
146
const=command.StartChecker(),
177
147
help="Start checker for client")
178
start_stop_checker.add_argument("--stop-checker",
148
start_stop_checker.add_argument("--stop-checker", dest="commands",
149
action="append_const", default=[],
150
const=command.StopChecker(),
180
151
help="Stop checker for client")
181
parser.add_argument("-V", "--is-enabled", action="store_true",
152
parser.add_argument("-V", "--is-enabled", dest="commands",
153
action="append_const", default=[],
154
const=command.IsEnabled(),
182
155
help="Check if client is enabled")
183
parser.add_argument("-r", "--remove", action="store_true",
156
parser.add_argument("-r", "--remove", dest="commands",
157
action="append_const", default=[],
158
const=command.Remove(),
184
159
help="Remove client")
185
parser.add_argument("-c", "--checker",
160
parser.add_argument("-c", "--checker", dest="commands",
161
action="append", default=[],
162
metavar="COMMAND", type=command.SetChecker,
186
163
help="Set checker command for client")
187
parser.add_argument("-t", "--timeout", type=string_to_delta,
188
help="Set timeout for client")
189
parser.add_argument("--extended-timeout", type=string_to_delta,
190
help="Set extended timeout for client")
191
parser.add_argument("-i", "--interval", type=string_to_delta,
192
help="Set checker interval for client")
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")
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")
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")
193
179
approve_deny_default = parser.add_mutually_exclusive_group()
194
180
approve_deny_default.add_argument(
195
"--approve-by-default", action="store_true",
196
default=None, dest="approved_by_default",
181
"--approve-by-default", dest="commands",
182
action="append_const", default=[],
183
const=command.ApproveByDefault(),
197
184
help="Set client to be approved by default")
198
185
approve_deny_default.add_argument(
199
"--deny-by-default", action="store_false",
200
dest="approved_by_default",
186
"--deny-by-default", dest="commands",
187
action="append_const", default=[],
188
const=command.DenyByDefault(),
201
189
help="Set client to be denied by default")
202
parser.add_argument("--approval-delay", type=string_to_delta,
203
help="Set delay before client approve/deny")
204
parser.add_argument("--approval-duration", type=string_to_delta,
205
help="Set duration of one client approval")
206
parser.add_argument("-H", "--host", help="Set host for client")
207
parser.add_argument("-s", "--secret",
208
type=argparse.FileType(mode="rb"),
209
help="Set password blob (file) for client")
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")
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")
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")
210
209
approve_deny = parser.add_mutually_exclusive_group()
211
210
approve_deny.add_argument(
212
"-A", "--approve", action="store_true",
211
"-A", "--approve", dest="commands", action="append_const",
212
default=[], const=command.Approve(),
213
213
help="Approve any current client request")
214
approve_deny.add_argument("-D", "--deny", action="store_true",
214
approve_deny.add_argument("-D", "--deny", dest="commands",
215
action="append_const", default=[],
216
const=command.Deny(),
215
217
help="Deny any current client request")
216
218
parser.add_argument("--debug", action="store_true",
217
219
help="Debug mode (show D-Bus commands)")
408
410
"""Apply additional restrictions on options, not expressible in
411
def has_actions(options):
412
return any((options.enable,
414
options.bump_timeout,
415
options.start_checker,
416
options.stop_checker,
419
options.checker is not None,
420
options.timeout is not None,
421
options.extended_timeout is not None,
422
options.interval is not None,
423
options.approved_by_default is not None,
424
options.approval_delay is not None,
425
options.approval_duration is not None,
426
options.host is not None,
427
options.secret is not None,
413
def has_commands(options, commands=None):
415
commands = (command.Enable,
418
command.StartChecker,
424
command.SetExtendedTimeout,
426
command.ApproveByDefault,
427
command.DenyByDefault,
428
command.SetApprovalDelay,
429
command.SetApprovalDuration,
434
return any(isinstance(cmd, commands)
435
for cmd in options.commands)
431
if has_actions(options) and not (options.client or options.all):
437
if has_commands(options) and not (options.client or options.all):
432
438
parser.error("Options require clients names or --all.")
433
if options.verbose and has_actions(options):
439
if options.verbose and has_commands(options):
434
440
parser.error("--verbose can only be used alone.")
435
if options.dump_json and (options.verbose
436
or has_actions(options)):
441
if (has_commands(options, (command.DumpJSON,))
442
and (options.verbose or len(options.commands) > 1)):
437
443
parser.error("--dump-json can only be used alone.")
438
if options.all and not has_actions(options):
444
if options.all and not has_commands(options):
439
445
parser.error("--all requires an action.")
440
if options.is_enabled and len(options.client) > 1:
446
if (has_commands(options, (command.IsEnabled,))
447
and len(options.client) > 1):
441
448
parser.error("--is-enabled requires exactly one client")
443
options.remove = False
444
if has_actions(options) and not options.deny:
445
parser.error("--remove can only be combined with --deny")
446
options.remove = True
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")
457
class SystemBus(object):
459
object_manager_iface = "org.freedesktop.DBus.ObjectManager"
460
def get_managed_objects(self, busname, objectpath):
461
return self.call_method("GetManagedObjects", busname,
463
self.object_manager_iface)
465
properties_iface = "org.freedesktop.DBus.Properties"
466
def set_property(self, busname, objectpath, interface, key,
468
self.call_method("Set", busname, objectpath,
469
self.properties_iface, interface, key,
473
class MandosBus(SystemBus):
474
busname_domain = "se.recompile"
475
busname = busname_domain + ".Mandos"
477
server_interface = busname_domain + ".Mandos"
478
client_interface = busname_domain + ".Mandos.Client"
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}
488
def set_client_property(self, objectpath, key, value):
489
return self.set_property(self.busname, objectpath,
490
self.client_interface, key,
493
def call_client_method(self, objectpath, method, *args):
494
return self.call_method(method, self.busname, objectpath,
495
self.client_interface, *args)
497
def call_server_method(self, method, *args):
498
return self.call_method(method, self.busname,
500
self.server_interface, *args)
502
class Error(Exception):
505
class ConnectFailed(Error):
509
class dbus_python_adapter(object):
511
class SystemBus(dbus.MandosBus):
512
"""Use dbus-python"""
514
def __init__(self, module=dbus_python):
515
self.dbus_python = module
516
self.bus = self.dbus_python.SystemBus()
518
@contextlib.contextmanager
519
def convert_exception(self, exception_class=dbus.Error):
522
except self.dbus_python.exceptions.DBusException as e:
523
# This does what "raise from" would do
524
exc = exception_class(*e.args)
528
def call_method(self, methodname, busname, objectpath,
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(
538
value = method(*args, dbus_interface=interface)
539
return self.type_filter(value)
541
def get_object(self, busname, objectpath):
542
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
544
with self.convert_exception(dbus.ConnectFailed):
545
return self.bus.get_object(busname, objectpath)
547
def type_filter(self, value):
548
"""Convert the most bothersome types to Python types"""
549
if isinstance(value, self.dbus_python.Boolean):
551
if isinstance(value, self.dbus_python.ObjectPath):
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()}
561
class SilenceLogger(object):
562
"Simple context manager to silence a particular logger"
563
def __init__(self, loggername):
564
self.logger = logging.getLogger(loggername)
567
self.logger.addFilter(self.nullfilter)
569
class NullFilter(logging.Filter):
570
def filter(self, record):
573
nullfilter = NullFilter()
575
def __exit__(self, exc_type, exc_val, exc_tb):
576
self.logger.removeFilter(self.nullfilter)
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):
587
return self.object_cache[(busname, objectpath)]
590
dbus_python_adapter.CachingBus,
591
self).get_object(busname, objectpath)
592
self.object_cache[(busname, objectpath)] = new_object
449
596
def commands_from_options(options):
453
if options.is_enabled:
454
commands.append(IsEnabledCmd())
457
commands.append(ApproveCmd())
460
commands.append(DenyCmd())
463
commands.append(RemoveCmd())
465
if options.dump_json:
466
commands.append(DumpJSONCmd())
469
commands.append(EnableCmd())
472
commands.append(DisableCmd())
474
if options.bump_timeout:
475
commands.append(BumpTimeoutCmd())
477
if options.start_checker:
478
commands.append(StartCheckerCmd())
480
if options.stop_checker:
481
commands.append(StopCheckerCmd())
483
if options.approved_by_default is not None:
484
if options.approved_by_default:
485
commands.append(ApproveByDefaultCmd())
598
commands = list(options.commands)
600
def find_cmd(cmd, commands):
602
for i, c in enumerate(commands):
603
if isinstance(c, cmd):
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:]
613
for cmd in after_remove:
614
if isinstance(cmd, command.Deny):
615
before_remove.append(cmd)
487
commands.append(DenyByDefaultCmd())
489
if options.checker is not None:
490
commands.append(SetCheckerCmd(options.checker))
492
if options.host is not None:
493
commands.append(SetHostCmd(options.host))
495
if options.secret is not None:
496
commands.append(SetSecretCmd(options.secret))
498
if options.timeout is not None:
499
commands.append(SetTimeoutCmd(options.timeout))
501
if options.extended_timeout:
503
SetExtendedTimeoutCmd(options.extended_timeout))
505
if options.interval is not None:
506
commands.append(SetIntervalCmd(options.interval))
508
if options.approval_delay is not None:
509
commands.append(SetApprovalDelayCmd(options.approval_delay))
511
if options.approval_duration is not None:
513
SetApprovalDurationCmd(options.approval_duration))
617
cleaned_after.append(cmd)
618
if cleaned_after != after_remove:
619
commands = before_remove + cleaned_after
515
621
# If no command option has been given, show table of clients,
516
622
# optionally verbosely
518
commands.append(PrintTableCmd(verbose=options.verbose))
624
commands.append(command.PrintTable(verbose=options.verbose))
523
class Command(object):
524
"""Abstract class for commands"""
525
def run(self, clients, bus=None, mandos=None):
526
"""Normal commands should implement run_on_one_client(), but
527
commands which want to operate on all clients at the same time
528
can override this run() method instead."""
530
for clientpath, properties in clients.items():
531
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
532
dbus_busname, str(clientpath))
533
client = bus.get_object(dbus_busname, clientpath)
534
self.run_on_one_client(client, properties)
537
class IsEnabledCmd(Command):
538
def run(self, clients, bus=None, mandos=None):
539
client, properties = next(iter(clients.items()))
540
if self.is_enabled(client, properties):
543
def is_enabled(self, client, properties):
544
return properties["Enabled"]
547
class ApproveCmd(Command):
548
def run_on_one_client(self, client, properties):
549
log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
550
client.__dbus_object_path__, client_dbus_interface)
551
client.Approve(dbus.Boolean(True),
552
dbus_interface=client_dbus_interface)
555
class DenyCmd(Command):
556
def run_on_one_client(self, client, properties):
557
log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
558
client.__dbus_object_path__, client_dbus_interface)
559
client.Approve(dbus.Boolean(False),
560
dbus_interface=client_dbus_interface)
563
class RemoveCmd(Command):
564
def run_on_one_client(self, client, properties):
565
log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)", dbus_busname,
566
server_dbus_path, server_dbus_interface,
567
str(client.__dbus_object_path__))
568
self.mandos.RemoveClient(client.__dbus_object_path__)
571
class OutputCmd(Command):
572
"""Abstract class for commands outputting client details"""
573
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
574
"Created", "Interval", "Host", "KeyID",
575
"Fingerprint", "CheckerRunning", "LastEnabled",
576
"ApprovalPending", "ApprovedByDefault",
577
"LastApprovalRequest", "ApprovalDelay",
578
"ApprovalDuration", "Checker", "ExtendedTimeout",
579
"Expires", "LastCheckerStatus")
581
def run(self, clients, bus=None, mandos=None):
582
print(self.output(clients.values()))
584
def output(self, clients):
585
raise NotImplementedError()
588
class DumpJSONCmd(OutputCmd):
589
def output(self, clients):
590
data = {client["Name"]:
591
{key: self.dbus_boolean_to_bool(client[key])
592
for key in self.all_keywords}
593
for client in clients.values()}
594
return json.dumps(data, indent=4, separators=(',', ': '))
597
def dbus_boolean_to_bool(value):
598
if isinstance(value, dbus.Boolean):
603
class PrintTableCmd(OutputCmd):
604
def __init__(self, verbose=False):
605
self.verbose = verbose
607
def output(self, clients):
608
default_keywords = ("Name", "Enabled", "Timeout",
610
keywords = default_keywords
612
keywords = self.all_keywords
613
return str(self.TableOfClients(clients, keywords))
615
class TableOfClients(object):
618
"Enabled": "Enabled",
619
"Timeout": "Timeout",
620
"LastCheckedOK": "Last Successful Check",
621
"LastApprovalRequest": "Last Approval Request",
622
"Created": "Created",
623
"Interval": "Interval",
625
"Fingerprint": "Fingerprint",
627
"CheckerRunning": "Check Is Running",
628
"LastEnabled": "Last Enabled",
629
"ApprovalPending": "Approval Is Pending",
630
"ApprovedByDefault": "Approved By Default",
631
"ApprovalDelay": "Approval Delay",
632
"ApprovalDuration": "Approval Duration",
633
"Checker": "Checker",
634
"ExtendedTimeout": "Extended Timeout",
635
"Expires": "Expires",
636
"LastCheckerStatus": "Last Checker Status",
639
def __init__(self, clients, keywords, tableheaders=None):
640
self.clients = clients
641
self.keywords = keywords
642
if tableheaders is not None:
643
self.tableheaders = tableheaders
646
return "\n".join(self.rows())
648
if sys.version_info.major == 2:
649
__unicode__ = __str__
629
class command(object):
630
"""A namespace for command classes"""
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.
640
for client, properties in clients.items():
641
self.run_on_one_client(client, properties)
644
class IsEnabled(Base):
645
def run(self, clients, bus=None):
646
properties = next(iter(clients.values()))
647
if properties["Enabled"]:
653
def run_on_one_client(self, client, properties):
654
self.bus.call_client_method(client, "Approve", True)
658
def run_on_one_client(self, client, properties):
659
self.bus.call_client_method(client, "Approve", False)
663
def run(self, clients, bus):
664
for clientpath in frozenset(clients.keys()):
665
bus.call_server_method("RemoveClient", clientpath)
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",
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=(',', ': ')))
689
class PrintTable(Output):
690
def __init__(self, verbose=False):
691
self.verbose = verbose
693
def run(self, clients, bus=None):
694
default_keywords = ("Name", "Enabled", "Timeout",
696
keywords = default_keywords
698
keywords = self.all_keywords
699
print(self.TableOfClients(clients.values(), keywords))
701
class TableOfClients(object):
704
"Enabled": "Enabled",
705
"Timeout": "Timeout",
706
"LastCheckedOK": "Last Successful Check",
707
"LastApprovalRequest": "Last Approval Request",
708
"Created": "Created",
709
"Interval": "Interval",
711
"Fingerprint": "Fingerprint",
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",
725
def __init__(self, clients, keywords):
726
self.clients = clients
727
self.keywords = keywords
650
729
def __str__(self):
651
return str(self).encode(locale.getpreferredencoding())
654
format_string = self.row_formatting_string()
655
rows = [self.header_line(format_string)]
656
rows.extend(self.client_line(client, format_string)
657
for client in self.clients)
660
def row_formatting_string(self):
661
"Format string used to format table rows"
662
return " ".join("{{{key}:{width}}}".format(
663
width=max(len(self.tableheaders[key]),
664
*(len(self.string_from_client(client, key))
665
for client in self.clients)),
667
for key in self.keywords)
669
def string_from_client(self, client, key):
670
return self.valuetostring(client[key], key)
730
return "\n".join(self.rows())
732
if sys.version_info.major == 2:
733
__unicode__ = __str__
735
return str(self).encode(
736
locale.getpreferredencoding())
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)
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,
751
for client in self.clients)),
753
for key in self.keywords)
755
def string_from_client(self, client, key):
756
return self.valuetostring(client[key], key)
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)
767
def header_line(self, format_string):
768
return format_string.format(**self.tableheaders)
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})
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)
781
hours=td.seconds // 3600,
782
minutes=(td.seconds % 3600) // 60,
783
seconds=td.seconds % 60))
786
class PropertySetter(Base):
787
"Abstract class for Actions for setting one client property"
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,
796
raise NotImplementedError()
799
class Enable(PropertySetter):
804
class Disable(PropertySetter):
809
class BumpTimeout(PropertySetter):
810
propname = "LastCheckedOK"
814
class StartChecker(PropertySetter):
815
propname = "CheckerRunning"
819
class StopChecker(PropertySetter):
820
propname = "CheckerRunning"
824
class ApproveByDefault(PropertySetter):
825
propname = "ApprovedByDefault"
829
class DenyByDefault(PropertySetter):
830
propname = "ApprovedByDefault"
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
673
def valuetostring(cls, value, keyword):
674
if isinstance(value, dbus.Boolean):
675
return "Yes" if value else "No"
676
if keyword in ("Timeout", "Interval", "ApprovalDelay",
677
"ApprovalDuration", "ExtendedTimeout"):
678
return cls.milliseconds_to_string(value)
681
def header_line(self, format_string):
682
return format_string.format(**self.tableheaders)
684
def client_line(self, client, format_string):
685
return format_string.format(
686
**{key: self.string_from_client(client, key)
687
for key in self.keywords})
690
def milliseconds_to_string(ms):
691
td = datetime.timedelta(0, 0, 0, ms)
692
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
693
.format(days="{}T".format(td.days)
695
hours=td.seconds // 3600,
696
minutes=(td.seconds % 3600) // 60,
697
seconds=td.seconds % 60))
700
class PropertyCmd(Command):
701
"""Abstract class for Actions for setting one client property"""
703
def run_on_one_client(self, client, properties):
704
"""Set the Client's D-Bus property"""
705
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
706
client.__dbus_object_path__,
707
dbus.PROPERTIES_IFACE, client_dbus_interface,
708
self.propname, self.value_to_set
709
if not isinstance(self.value_to_set, dbus.Boolean)
710
else bool(self.value_to_set))
711
client.Set(client_dbus_interface, self.propname,
713
dbus_interface=dbus.PROPERTIES_IFACE)
717
raise NotImplementedError()
720
class EnableCmd(PropertyCmd):
722
value_to_set = dbus.Boolean(True)
725
class DisableCmd(PropertyCmd):
727
value_to_set = dbus.Boolean(False)
730
class BumpTimeoutCmd(PropertyCmd):
731
propname = "LastCheckedOK"
735
class StartCheckerCmd(PropertyCmd):
736
propname = "CheckerRunning"
737
value_to_set = dbus.Boolean(True)
740
class StopCheckerCmd(PropertyCmd):
741
propname = "CheckerRunning"
742
value_to_set = dbus.Boolean(False)
745
class ApproveByDefaultCmd(PropertyCmd):
746
propname = "ApprovedByDefault"
747
value_to_set = dbus.Boolean(True)
750
class DenyByDefaultCmd(PropertyCmd):
751
propname = "ApprovedByDefault"
752
value_to_set = dbus.Boolean(False)
755
class PropertyValueCmd(PropertyCmd):
756
"""Abstract class for PropertyCmd recieving a value as argument"""
757
def __init__(self, value):
758
self.value_to_set = value
761
class SetCheckerCmd(PropertyValueCmd):
765
class SetHostCmd(PropertyValueCmd):
769
class SetSecretCmd(PropertyValueCmd):
773
def value_to_set(self):
777
def value_to_set(self, value):
778
"""When setting, read data from supplied file object"""
779
self._vts = value.read()
783
class MillisecondsPropertyValueArgumentCmd(PropertyValueCmd):
784
"""Abstract class for PropertyValueCmd taking a value argument as
785
a datetime.timedelta() but should store it as milliseconds."""
788
def value_to_set(self):
792
def value_to_set(self, value):
793
"""When setting, convert value from a datetime.timedelta"""
794
self._vts = int(round(value.total_seconds() * 1000))
797
class SetTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
801
class SetExtendedTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
802
propname = "ExtendedTimeout"
805
class SetIntervalCmd(MillisecondsPropertyValueArgumentCmd):
806
propname = "Interval"
809
class SetApprovalDelayCmd(MillisecondsPropertyValueArgumentCmd):
810
propname = "ApprovalDelay"
813
class SetApprovalDurationCmd(MillisecondsPropertyValueArgumentCmd):
814
propname = "ApprovalDuration"
841
def argparse(cls, argtype):
843
return cls(argtype(arg))
846
class SetChecker(PropertySetterValue):
850
class SetHost(PropertySetterValue):
854
class SetSecret(PropertySetterValue):
858
def value_to_set(self):
862
def value_to_set(self, value):
863
"""When setting, read data from supplied file object"""
864
self._vts = value.read()
868
class PropertySetterValueMilliseconds(PropertySetterValue):
869
"""Abstract class for PropertySetterValue taking a value
870
argument as a datetime.timedelta() but should store it as
874
def value_to_set(self):
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))
883
class SetTimeout(PropertySetterValueMilliseconds):
887
class SetExtendedTimeout(PropertySetterValueMilliseconds):
888
propname = "ExtendedTimeout"
891
class SetInterval(PropertySetterValueMilliseconds):
892
propname = "Interval"
895
class SetApprovalDelay(PropertySetterValueMilliseconds):
896
propname = "ApprovalDelay"
899
class SetApprovalDuration(PropertySetterValueMilliseconds):
900
propname = "ApprovalDuration"
818
class Test_string_to_delta(unittest.TestCase):
819
def test_handles_basic_rfc3339(self):
820
self.assertEqual(string_to_delta("PT0S"),
821
datetime.timedelta())
822
self.assertEqual(string_to_delta("P0D"),
823
datetime.timedelta())
824
self.assertEqual(string_to_delta("PT1S"),
825
datetime.timedelta(0, 1))
826
self.assertEqual(string_to_delta("PT2H"),
827
datetime.timedelta(0, 7200))
904
class TestCaseWithAssertLogs(unittest.TestCase):
905
"""unittest.TestCase.assertLogs only exists in Python 3.4"""
907
if not hasattr(unittest.TestCase, "assertLogs"):
908
@contextlib.contextmanager
909
def assertLogs(self, logger, level=logging.INFO):
910
capturing_handler = self.CapturingLevelHandler(level)
911
old_level = logger.level
912
old_propagate = logger.propagate
913
logger.addHandler(capturing_handler)
914
logger.setLevel(level)
915
logger.propagate = False
917
yield capturing_handler.watcher
919
logger.propagate = old_propagate
920
logger.removeHandler(capturing_handler)
921
logger.setLevel(old_level)
922
self.assertGreater(len(capturing_handler.watcher.records),
925
class CapturingLevelHandler(logging.Handler):
926
def __init__(self, level, *args, **kwargs):
927
logging.Handler.__init__(self, *args, **kwargs)
928
self.watcher = self.LoggingWatcher([], [])
929
def emit(self, record):
930
self.watcher.records.append(record)
931
self.watcher.output.append(self.format(record))
933
LoggingWatcher = collections.namedtuple("LoggingWatcher",
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"""
943
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.
948
def test_rfc3339_zero_seconds(self):
949
self.assertEqual(datetime.timedelta(),
950
string_to_delta("PT0S"))
952
def test_rfc3339_zero_days(self):
953
self.assertEqual(datetime.timedelta(), string_to_delta("P0D"))
955
def test_rfc3339_one_second(self):
956
self.assertEqual(datetime.timedelta(0, 1),
957
string_to_delta("PT1S"))
959
def test_rfc3339_two_hours(self):
960
self.assertEqual(datetime.timedelta(0, 7200),
961
string_to_delta("PT2H"))
829
963
def test_falls_back_to_pre_1_6_1_with_warning(self):
830
# assertLogs only exists in Python 3.4
831
if hasattr(self, "assertLogs"):
832
with self.assertLogs(log, logging.WARNING):
833
value = string_to_delta("2h")
835
class WarningFilter(logging.Filter):
836
"""Don't show, but record the presence of, warnings"""
837
def filter(self, record):
838
is_warning = record.levelno >= logging.WARNING
839
self.found = is_warning or getattr(self, "found",
841
return not is_warning
842
warning_filter = WarningFilter()
843
log.addFilter(warning_filter)
845
value = string_to_delta("2h")
847
log.removeFilter(warning_filter)
848
self.assertTrue(getattr(warning_filter, "found", False))
849
self.assertEqual(value, datetime.timedelta(0, 7200))
964
with self.assertLogs(log, logging.WARNING):
965
value = string_to_delta("2h")
966
self.assertEqual(datetime.timedelta(0, 7200), value)
852
969
class Test_check_option_syntax(unittest.TestCase):
857
974
def test_actions_requires_client_or_all(self):
858
975
for action, value in self.actions.items():
859
options = self.parser.parse_args()
860
setattr(options, action, value)
976
args = self.actionargs(action, value)
861
977
with self.assertParseError():
862
self.check_option_syntax(options)
978
self.parse_args(args)
864
# This mostly corresponds to the definition from has_actions() in
980
# This mostly corresponds to the definition from has_commands() in
865
981
# check_option_syntax()
867
# The actual values set here are not that important, but we do
868
# at least stick to the correct types, even though they are
872
"bump_timeout": True,
873
"start_checker": True,
874
"stop_checker": True,
878
"timeout": datetime.timedelta(),
879
"extended_timeout": datetime.timedelta(),
880
"interval": datetime.timedelta(),
881
"approved_by_default": True,
882
"approval_delay": datetime.timedelta(),
883
"approval_duration": datetime.timedelta(),
885
"secret": io.BytesIO(b"x"),
985
"--bump-timeout": None,
986
"--start-checker": None,
987
"--stop-checker": None,
988
"--is-enabled": None,
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",
1005
def actionargs(action, value, *args):
1006
if value is not None:
1007
return [action, value] + list(args)
1009
return [action] + list(args)
890
1011
@contextlib.contextmanager
891
1012
def assertParseError(self):
892
1013
with self.assertRaises(SystemExit) as e:
893
with self.temporarily_suppress_stderr():
1014
with self.redirect_stderr_to_devnull():
895
1016
# Exit code from argparse is guaranteed to be "2". Reference:
896
1017
# https://docs.python.org/3/library
897
1018
# /argparse.html#exiting-methods
898
self.assertEqual(e.exception.code, 2)
1019
self.assertEqual(2, e.exception.code)
1021
def parse_args(self, args):
1022
options = self.parser.parse_args(args)
1023
check_option_syntax(self.parser, options)
901
1026
@contextlib.contextmanager
902
def temporarily_suppress_stderr():
903
null = os.open(os.path.devnull, os.O_RDWR)
904
stderrcopy = os.dup(sys.stderr.fileno())
905
os.dup2(null, sys.stderr.fileno())
911
os.dup2(stderrcopy, sys.stderr.fileno())
1027
def redirect_stderr_to_devnull():
1028
old_stderr = sys.stderr
1029
with contextlib.closing(open(os.devnull, "w")) as null:
1034
sys.stderr = old_stderr
914
1036
def check_option_syntax(self, options):
915
1037
check_option_syntax(self.parser, options)
917
def test_actions_conflicts_with_verbose(self):
918
for action, value in self.actions.items():
919
options = self.parser.parse_args()
920
setattr(options, action, value)
921
options.verbose = True
922
with self.assertParseError():
923
self.check_option_syntax(options)
1039
def test_actions_all_conflicts_with_verbose(self):
1040
for action, value in self.actions.items():
1041
args = self.actionargs(action, value, "--all",
1043
with self.assertParseError():
1044
self.parse_args(args)
1046
def test_actions_with_client_conflicts_with_verbose(self):
1047
for action, value in self.actions.items():
1048
args = self.actionargs(action, value, "--verbose",
1050
with self.assertParseError():
1051
self.parse_args(args)
925
1053
def test_dump_json_conflicts_with_verbose(self):
926
options = self.parser.parse_args()
927
options.dump_json = True
928
options.verbose = True
1054
args = ["--dump-json", "--verbose"]
929
1055
with self.assertParseError():
930
self.check_option_syntax(options)
1056
self.parse_args(args)
932
1058
def test_dump_json_conflicts_with_action(self):
933
1059
for action, value in self.actions.items():
934
options = self.parser.parse_args()
935
setattr(options, action, value)
936
options.dump_json = True
1060
args = self.actionargs(action, value, "--dump-json")
937
1061
with self.assertParseError():
938
self.check_option_syntax(options)
1062
self.parse_args(args)
940
1064
def test_all_can_not_be_alone(self):
941
options = self.parser.parse_args()
943
1066
with self.assertParseError():
944
self.check_option_syntax(options)
1067
self.parse_args(args)
946
1069
def test_all_is_ok_with_any_action(self):
947
1070
for action, value in self.actions.items():
948
options = self.parser.parse_args()
949
setattr(options, action, value)
951
self.check_option_syntax(options)
1071
args = self.actionargs(action, value, "--all")
1072
self.parse_args(args)
1074
def test_any_action_is_ok_with_one_client(self):
1075
for action, value in self.actions.items():
1076
args = self.actionargs(action, value, "client")
1077
self.parse_args(args)
1079
def test_one_client_with_all_actions_except_is_enabled(self):
1080
for action, value in self.actions.items():
1081
if action == "--is-enabled":
1083
args = self.actionargs(action, value, "client")
1084
self.parse_args(args)
1086
def test_two_clients_with_all_actions_except_is_enabled(self):
1087
for action, value in self.actions.items():
1088
if action == "--is-enabled":
1090
args = self.actionargs(action, value, "client1",
1092
self.parse_args(args)
1094
def test_two_clients_are_ok_with_actions_except_is_enabled(self):
1095
for action, value in self.actions.items():
1096
if action == "--is-enabled":
1098
args = self.actionargs(action, value, "client1",
1100
self.parse_args(args)
953
1102
def test_is_enabled_fails_without_client(self):
954
options = self.parser.parse_args()
955
options.is_enabled = True
1103
args = ["--is-enabled"]
956
1104
with self.assertParseError():
957
self.check_option_syntax(options)
959
def test_is_enabled_works_with_one_client(self):
960
options = self.parser.parse_args()
961
options.is_enabled = True
962
options.client = ["foo"]
963
self.check_option_syntax(options)
1105
self.parse_args(args)
965
1107
def test_is_enabled_fails_with_two_clients(self):
966
options = self.parser.parse_args()
967
options.is_enabled = True
968
options.client = ["foo", "barbar"]
1108
args = ["--is-enabled", "client1", "client2"]
969
1109
with self.assertParseError():
970
self.check_option_syntax(options)
1110
self.parse_args(args)
972
1112
def test_remove_can_only_be_combined_with_action_deny(self):
973
1113
for action, value in self.actions.items():
974
if action in {"remove", "deny"}:
1114
if action in {"--remove", "--deny"}:
976
options = self.parser.parse_args()
977
setattr(options, action, value)
979
options.remove = True
1116
args = self.actionargs(action, value, "--all",
980
1118
with self.assertParseError():
981
self.check_option_syntax(options)
1119
self.parse_args(args)
1122
class Test_dbus_exceptions(unittest.TestCase):
1124
def test_dbus_ConnectFailed_is_Error(self):
1125
with self.assertRaises(dbus.Error):
1126
raise dbus.ConnectFailed()
1129
class Test_dbus_MandosBus(unittest.TestCase):
1131
class MockMandosBus(dbus.MandosBus):
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"
1138
self.call_method_return = Unique()
1140
def call_method(self, methodname, busname, objectpath,
1142
self.calls.append((methodname, busname, objectpath,
1144
return self.call_method_return
1147
self.bus = self.MockMandosBus()
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)
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)
1163
def test_call_client_method_with_args(self):
1164
args = (Unique(), Unique())
1165
ret = self.bus.call_client_method("objectpath", "methodname",
1167
self.assertIs(self.bus.call_method_return, ret)
1168
expected_call = ("methodname", self.bus._name, "objectpath",
1169
self.bus._client_interface,
1171
self.assertIn(expected_call, self.bus.calls)
1173
def test_get_clients_and_properties(self):
1176
self.bus._client_interface: {
1180
"irrelevant_interface": {
1181
"key": "othervalue",
1185
"other_objectpath": {
1186
"other_irrelevant_interface": {
1192
expected_clients_and_properties = {
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)
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)
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,
1222
self.assertIn(expected_call, self.bus.calls)
1225
class Test_dbus_python_adapter_SystemBus(TestCaseWithAssertLogs):
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):
1234
class SystemBus(object):
1236
def get_object(busname, objectpath):
1237
DBusObject = collections.namedtuple(
1238
"DBusObject", ("methodname",))
1239
def method(*args, **kwargs):
1240
self.assertEqual({"dbus_interface":
1244
return DBusObject(methodname=method)
1245
class Boolean(object):
1246
def __init__(self, value):
1247
self.value = bool(value)
1250
if sys.version_info.major == 2:
1251
__nonzero__ = __bool__
1252
class ObjectPath(str):
1254
class Dictionary(dict):
1256
return mock_dbus_python
1258
def call_method(self, bus, methodname, busname, objectpath,
1260
with self.assertLogs(log, logging.DEBUG):
1261
return bus.call_method(methodname, busname, objectpath,
1264
def test_call_method_returns(self):
1265
expected_method_return = Unique()
1266
method_args = (Unique(), Unique())
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",
1277
self.assertIs(ret, expected_method_return)
1279
def test_call_method_filters_bool_true(self):
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)
1290
def test_call_method_filters_bool_false(self):
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)
1301
def test_call_method_filters_objectpath(self):
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)
1313
def test_call_method_filters_booleans_in_dict(self):
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,
1327
self.assertEqual(expected_method_return, ret)
1328
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1330
def test_call_method_filters_objectpaths_in_dict(self):
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)
1344
method_return.items()}
1345
self.assertEqual(expected_method_return, ret)
1346
self.assertIsInstance(ret, dict)
1347
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1349
def test_call_method_filters_dict_in_dict(self):
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"},
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)
1376
def test_call_method_filters_dict_three_deep(self):
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(
1383
mock_dbus_python.Dictionary(
1385
mock_dbus_python.Dictionary(
1387
mock_dbus_python.Boolean(True),
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)
1407
def test_call_method_handles_exception(self):
1408
dbus_logger = logging.getLogger("dbus.proxies")
1411
dbus_logger.error("Test")
1412
raise mock_dbus_python.exceptions.DBusException()
1414
mock_dbus_python = self.MockDBusPython_func(func)
1415
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1417
class CountingHandler(logging.Handler):
1419
def emit(self, record):
1422
counting_handler = CountingHandler()
1424
dbus_logger.addHandler(counting_handler)
1427
with self.assertRaises(dbus.Error) as e:
1428
self.call_method(bus, "methodname", "busname",
1429
"objectpath", "interface")
1431
dbus_logger.removeFilter(counting_handler)
1433
self.assertNotIsInstance(e, dbus.ConnectFailed)
1435
# Make sure the dbus logger was suppressed
1436
self.assertEqual(0, counting_handler.count)
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")
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):
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)
1460
class Test_dbus_python_adapter_CachingBus(unittest.TestCase):
1461
class mock_dbus_python(object):
1462
"""mock dbus-python modules"""
1463
class SystemBus(object):
1465
def get_object(busname, objectpath):
1469
self.bus = dbus_python_adapter.CachingBus(
1470
self.mock_dbus_python)
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)
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)
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)
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)
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)
984
1512
class Test_commands_from_options(unittest.TestCase):
985
1514
def setUp(self):
986
1515
self.parser = argparse.ArgumentParser()
987
1516
add_command_line_options(self.parser)
989
1518
def test_is_enabled(self):
990
self.assert_command_from_args(["--is-enabled", "foo"],
1519
self.assert_command_from_args(["--is-enabled", "client"],
993
1522
def assert_command_from_args(self, args, command_cls,
997
1526
options = self.parser.parse_args(args)
998
1527
check_option_syntax(self.parser, options)
999
1528
commands = commands_from_options(options)
1000
self.assertEqual(len(commands), 1)
1529
self.assertEqual(1, len(commands))
1001
1530
command = commands[0]
1002
1531
self.assertIsInstance(command, command_cls)
1003
1532
for key, value in cmd_attrs.items():
1004
self.assertEqual(getattr(command, key), value)
1533
self.assertEqual(value, getattr(command, key))
1006
1535
def test_is_enabled_short(self):
1007
self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
1536
self.assert_command_from_args(["-V", "client"],
1009
1539
def test_approve(self):
1010
self.assert_command_from_args(["--approve", "foo"],
1540
self.assert_command_from_args(["--approve", "client"],
1013
1543
def test_approve_short(self):
1014
self.assert_command_from_args(["-A", "foo"], ApproveCmd)
1544
self.assert_command_from_args(["-A", "client"],
1016
1547
def test_deny(self):
1017
self.assert_command_from_args(["--deny", "foo"], DenyCmd)
1548
self.assert_command_from_args(["--deny", "client"],
1019
1551
def test_deny_short(self):
1020
self.assert_command_from_args(["-D", "foo"], DenyCmd)
1552
self.assert_command_from_args(["-D", "client"], command.Deny)
1022
1554
def test_remove(self):
1023
self.assert_command_from_args(["--remove", "foo"],
1555
self.assert_command_from_args(["--remove", "client"],
1026
1558
def test_deny_before_remove(self):
1027
1559
options = self.parser.parse_args(["--deny", "--remove",
1029
1561
check_option_syntax(self.parser, options)
1030
1562
commands = commands_from_options(options)
1031
self.assertEqual(len(commands), 2)
1032
self.assertIsInstance(commands[0], DenyCmd)
1033
self.assertIsInstance(commands[1], RemoveCmd)
1563
self.assertEqual(2, len(commands))
1564
self.assertIsInstance(commands[0], command.Deny)
1565
self.assertIsInstance(commands[1], command.Remove)
1035
1567
def test_deny_before_remove_reversed(self):
1036
1568
options = self.parser.parse_args(["--remove", "--deny",
1038
1570
check_option_syntax(self.parser, options)
1039
1571
commands = commands_from_options(options)
1040
self.assertEqual(len(commands), 2)
1041
self.assertIsInstance(commands[0], DenyCmd)
1042
self.assertIsInstance(commands[1], RemoveCmd)
1572
self.assertEqual(2, len(commands))
1573
self.assertIsInstance(commands[0], command.Deny)
1574
self.assertIsInstance(commands[1], command.Remove)
1044
1576
def test_remove_short(self):
1045
self.assert_command_from_args(["-r", "foo"], RemoveCmd)
1577
self.assert_command_from_args(["-r", "client"],
1047
1580
def test_dump_json(self):
1048
self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
1581
self.assert_command_from_args(["--dump-json"],
1050
1584
def test_enable(self):
1051
self.assert_command_from_args(["--enable", "foo"], EnableCmd)
1585
self.assert_command_from_args(["--enable", "client"],
1053
1588
def test_enable_short(self):
1054
self.assert_command_from_args(["-e", "foo"], EnableCmd)
1589
self.assert_command_from_args(["-e", "client"],
1056
1592
def test_disable(self):
1057
self.assert_command_from_args(["--disable", "foo"],
1593
self.assert_command_from_args(["--disable", "client"],
1060
1596
def test_disable_short(self):
1061
self.assert_command_from_args(["-d", "foo"], DisableCmd)
1597
self.assert_command_from_args(["-d", "client"],
1063
1600
def test_bump_timeout(self):
1064
self.assert_command_from_args(["--bump-timeout", "foo"],
1601
self.assert_command_from_args(["--bump-timeout", "client"],
1602
command.BumpTimeout)
1067
1604
def test_bump_timeout_short(self):
1068
self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
1605
self.assert_command_from_args(["-b", "client"],
1606
command.BumpTimeout)
1070
1608
def test_start_checker(self):
1071
self.assert_command_from_args(["--start-checker", "foo"],
1609
self.assert_command_from_args(["--start-checker", "client"],
1610
command.StartChecker)
1074
1612
def test_stop_checker(self):
1075
self.assert_command_from_args(["--stop-checker", "foo"],
1613
self.assert_command_from_args(["--stop-checker", "client"],
1614
command.StopChecker)
1078
1616
def test_approve_by_default(self):
1079
self.assert_command_from_args(["--approve-by-default", "foo"],
1080
ApproveByDefaultCmd)
1617
self.assert_command_from_args(["--approve-by-default",
1619
command.ApproveByDefault)
1082
1621
def test_deny_by_default(self):
1083
self.assert_command_from_args(["--deny-by-default", "foo"],
1622
self.assert_command_from_args(["--deny-by-default", "client"],
1623
command.DenyByDefault)
1086
1625
def test_checker(self):
1087
self.assert_command_from_args(["--checker", ":", "foo"],
1088
SetCheckerCmd, value_to_set=":")
1626
self.assert_command_from_args(["--checker", ":", "client"],
1090
1630
def test_checker_empty(self):
1091
self.assert_command_from_args(["--checker", "", "foo"],
1092
SetCheckerCmd, value_to_set="")
1631
self.assert_command_from_args(["--checker", "", "client"],
1094
1635
def test_checker_short(self):
1095
self.assert_command_from_args(["-c", ":", "foo"],
1096
SetCheckerCmd, value_to_set=":")
1636
self.assert_command_from_args(["-c", ":", "client"],
1098
1640
def test_host(self):
1099
self.assert_command_from_args(["--host", "foo.example.org",
1101
value_to_set="foo.example.org")
1641
self.assert_command_from_args(
1642
["--host", "client.example.org", "client"],
1643
command.SetHost, value_to_set="client.example.org")
1103
1645
def test_host_short(self):
1104
self.assert_command_from_args(["-H", "foo.example.org",
1106
value_to_set="foo.example.org")
1646
self.assert_command_from_args(
1647
["-H", "client.example.org", "client"], command.SetHost,
1648
value_to_set="client.example.org")
1108
1650
def test_secret_devnull(self):
1109
1651
self.assert_command_from_args(["--secret", os.path.devnull,
1110
"foo"], SetSecretCmd,
1652
"client"], command.SetSecret,
1111
1653
value_to_set=b"")
1113
1655
def test_secret_tempfile(self):
1118
1660
self.assert_command_from_args(["--secret", f.name,
1119
"foo"], SetSecretCmd,
1120
1663
value_to_set=value)
1122
1665
def test_secret_devnull_short(self):
1123
self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1124
SetSecretCmd, value_to_set=b"")
1666
self.assert_command_from_args(["-s", os.path.devnull,
1667
"client"], command.SetSecret,
1126
1670
def test_secret_tempfile_short(self):
1127
1671
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1128
1672
value = b"secret\0xyzzy\nbar"
1131
self.assert_command_from_args(["-s", f.name, "foo"],
1675
self.assert_command_from_args(["-s", f.name, "client"],
1133
1677
value_to_set=value)
1135
1679
def test_timeout(self):
1136
self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1680
self.assert_command_from_args(["--timeout", "PT5M", "client"],
1138
1682
value_to_set=300000)
1140
1684
def test_timeout_short(self):
1141
self.assert_command_from_args(["-t", "PT5M", "foo"],
1685
self.assert_command_from_args(["-t", "PT5M", "client"],
1143
1687
value_to_set=300000)
1145
1689
def test_extended_timeout(self):
1146
1690
self.assert_command_from_args(["--extended-timeout", "PT15M",
1148
SetExtendedTimeoutCmd,
1692
command.SetExtendedTimeout,
1149
1693
value_to_set=900000)
1151
1695
def test_interval(self):
1152
self.assert_command_from_args(["--interval", "PT2M", "foo"],
1696
self.assert_command_from_args(["--interval", "PT2M",
1697
"client"], command.SetInterval,
1154
1698
value_to_set=120000)
1156
1700
def test_interval_short(self):
1157
self.assert_command_from_args(["-i", "PT2M", "foo"],
1701
self.assert_command_from_args(["-i", "PT2M", "client"],
1702
command.SetInterval,
1159
1703
value_to_set=120000)
1161
1705
def test_approval_delay(self):
1162
1706
self.assert_command_from_args(["--approval-delay", "PT30S",
1163
"foo"], SetApprovalDelayCmd,
1708
command.SetApprovalDelay,
1164
1709
value_to_set=30000)
1166
1711
def test_approval_duration(self):
1167
1712
self.assert_command_from_args(["--approval-duration", "PT1S",
1168
"foo"], SetApprovalDurationCmd,
1714
command.SetApprovalDuration,
1169
1715
value_to_set=1000)
1171
1717
def test_print_table(self):
1172
self.assert_command_from_args([], PrintTableCmd,
1718
self.assert_command_from_args([], command.PrintTable,
1175
1721
def test_print_table_verbose(self):
1176
self.assert_command_from_args(["--verbose"], PrintTableCmd,
1722
self.assert_command_from_args(["--verbose"],
1179
1726
def test_print_table_verbose_short(self):
1180
self.assert_command_from_args(["-v"], PrintTableCmd,
1727
self.assert_command_from_args(["-v"], command.PrintTable,
1184
class TestCmd(unittest.TestCase):
1731
class TestCommand(unittest.TestCase):
1185
1732
"""Abstract class for tests of command classes"""
1189
class MockClient(object):
1190
def __init__(self, name, **attributes):
1191
self.__dbus_object_path__ = "/clients/{}".format(name)
1192
self.attributes = attributes
1193
self.attributes["Name"] = name
1195
def Set(self, interface, propname, value, dbus_interface):
1196
testcase.assertEqual(interface, client_dbus_interface)
1197
testcase.assertEqual(dbus_interface,
1198
dbus.PROPERTIES_IFACE)
1199
self.attributes[propname] = value
1200
def Get(self, interface, propname, dbus_interface):
1201
testcase.assertEqual(interface, client_dbus_interface)
1202
testcase.assertEqual(dbus_interface,
1203
dbus.PROPERTIES_IFACE)
1204
return self.attributes[propname]
1205
def Approve(self, approve, dbus_interface):
1206
testcase.assertEqual(dbus_interface,
1207
client_dbus_interface)
1208
self.calls.append(("Approve", (approve,
1210
self.client = MockClient(
1212
KeyID=("92ed150794387c03ce684574b1139a65"
1213
"94a34f895daaaf09fd8ea90a27cddb12"),
1215
Host="foo.example.org",
1216
Enabled=dbus.Boolean(True),
1218
LastCheckedOK="2019-02-03T00:00:00",
1219
Created="2019-01-02T00:00:00",
1221
Fingerprint=("778827225BA7DE539C5A"
1222
"7CFA59CFF7CDBD9A5920"),
1223
CheckerRunning=dbus.Boolean(False),
1224
LastEnabled="2019-01-03T00:00:00",
1225
ApprovalPending=dbus.Boolean(False),
1226
ApprovedByDefault=dbus.Boolean(True),
1227
LastApprovalRequest="",
1229
ApprovalDuration=1000,
1230
Checker="fping -q -- %(host)s",
1231
ExtendedTimeout=900000,
1232
Expires="2019-02-04T00:00:00",
1233
LastCheckerStatus=0)
1234
self.other_client = MockClient(
1236
KeyID=("0558568eedd67d622f5c83b35a115f79"
1237
"6ab612cff5ad227247e46c2b020f441c"),
1238
Secret=b"secretbar",
1240
Enabled=dbus.Boolean(True),
1242
LastCheckedOK="2019-02-04T00:00:00",
1243
Created="2019-01-03T00:00:00",
1245
Fingerprint=("3E393AEAEFB84C7E89E2"
1246
"F547B3A107558FCA3A27"),
1247
CheckerRunning=dbus.Boolean(True),
1248
LastEnabled="2019-01-04T00:00:00",
1249
ApprovalPending=dbus.Boolean(False),
1250
ApprovedByDefault=dbus.Boolean(False),
1251
LastApprovalRequest="2019-01-03T00:00:00",
1252
ApprovalDelay=30000,
1253
ApprovalDuration=93785000,
1255
ExtendedTimeout=900000,
1256
Expires="2019-02-05T00:00:00",
1257
LastCheckerStatus=-2)
1258
self.clients = collections.OrderedDict(
1260
("/clients/foo", self.client.attributes),
1261
("/clients/barbar", self.other_client.attributes),
1263
self.one_client = {"/clients/foo": self.client.attributes}
1269
def get_object(client_bus_name, path):
1270
self.assertEqual(client_bus_name, dbus_busname)
1272
"/clients/foo": self.client,
1273
"/clients/barbar": self.other_client,
1278
class TestIsEnabledCmd(TestCmd):
1279
def test_is_enabled(self):
1280
self.assertTrue(all(IsEnabledCmd().is_enabled(client,
1282
for client, properties
1283
in self.clients.items()))
1285
def test_is_enabled_run_exits_successfully(self):
1286
with self.assertRaises(SystemExit) as e:
1287
IsEnabledCmd().run(self.one_client)
1288
if e.exception.code is not None:
1289
self.assertEqual(e.exception.code, 0)
1291
self.assertIsNone(e.exception.code)
1293
def test_is_enabled_run_exits_with_failure(self):
1294
self.client.attributes["Enabled"] = dbus.Boolean(False)
1295
with self.assertRaises(SystemExit) as e:
1296
IsEnabledCmd().run(self.one_client)
1297
if isinstance(e.exception.code, int):
1298
self.assertNotEqual(e.exception.code, 0)
1300
self.assertIsNotNone(e.exception.code)
1303
class TestApproveCmd(TestCmd):
1304
def test_approve(self):
1305
ApproveCmd().run(self.clients, self.bus)
1306
for clientpath in self.clients:
1307
client = self.bus.get_object(dbus_busname, clientpath)
1308
self.assertIn(("Approve", (True, client_dbus_interface)),
1312
class TestDenyCmd(TestCmd):
1313
def test_deny(self):
1314
DenyCmd().run(self.clients, self.bus)
1315
for clientpath in self.clients:
1316
client = self.bus.get_object(dbus_busname, clientpath)
1317
self.assertIn(("Approve", (False, client_dbus_interface)),
1321
class TestRemoveCmd(TestCmd):
1322
def test_remove(self):
1323
class MockMandos(object):
1326
def RemoveClient(self, dbus_path):
1327
self.calls.append(("RemoveClient", (dbus_path,)))
1328
mandos = MockMandos()
1329
super(TestRemoveCmd, self).setUp()
1330
RemoveCmd().run(self.clients, self.bus, mandos)
1331
self.assertEqual(len(mandos.calls), 2)
1332
for clientpath in self.clients:
1333
self.assertIn(("RemoveClient", (clientpath,)),
1337
class TestDumpJSONCmd(TestCmd):
1339
self.expected_json = {
1734
class FakeMandosBus(dbus.MandosBus):
1735
def __init__(self, testcase):
1736
self.client_properties = {
1342
1738
"KeyID": ("92ed150794387c03ce684574b1139a65"
1343
1739
"94a34f895daaaf09fd8ea90a27cddb12"),
1740
"Secret": b"secret",
1344
1741
"Host": "foo.example.org",
1345
1742
"Enabled": True,
1346
1743
"Timeout": 300000,
1384
1782
"ExtendedTimeout": 900000,
1385
1783
"Expires": "2019-02-05T00:00:00",
1386
1784
"LastCheckerStatus": -2,
1389
return super(TestDumpJSONCmd, self).setUp()
1391
def test_normal(self):
1392
json_data = json.loads(DumpJSONCmd().output(self.clients))
1393
self.assertDictEqual(json_data, self.expected_json)
1395
def test_one_client(self):
1396
clients = self.one_client
1397
json_data = json.loads(DumpJSONCmd().output(clients))
1786
self.clients = collections.OrderedDict(
1788
("client_objectpath", self.client_properties),
1789
("other_client_objectpath",
1790
self.other_client_properties),
1792
self.one_client = {"client_objectpath":
1793
self.client_properties}
1794
self.testcase = testcase
1797
def call_method(self, methodname, busname, objectpath,
1799
self.testcase.assertEqual("se.recompile.Mandos", busname)
1800
self.calls.append((methodname, busname, objectpath,
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
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]
1816
elif interface == "se.recompile.Mandos.Client":
1817
if methodname == "Approve":
1818
self.testcase.assertEqual(1, len(args))
1823
self.bus = self.FakeMandosBus(self)
1826
class TestBaseCommands(TestCommand):
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)
1834
self.assertIsNone(e.exception.code)
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)
1843
self.assertIsNotNone(e.exception.code)
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)
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,)),
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)
1872
"KeyID": ("92ed150794387c03ce684574b1139a65"
1873
"94a34f895daaaf09fd8ea90a27cddb12"),
1874
"Host": "foo.example.org",
1877
"LastCheckedOK": "2019-02-03T00:00:00",
1878
"Created": "2019-01-02T00:00:00",
1880
"Fingerprint": ("778827225BA7DE539C5A"
1881
"7CFA59CFF7CDBD9A5920"),
1882
"CheckerRunning": False,
1883
"LastEnabled": "2019-01-03T00:00:00",
1884
"ApprovalPending": False,
1885
"ApprovedByDefault": True,
1886
"LastApprovalRequest": "",
1888
"ApprovalDuration": 1000,
1889
"Checker": "fping -q -- %(host)s",
1890
"ExtendedTimeout": 900000,
1891
"Expires": "2019-02-04T00:00:00",
1892
"LastCheckerStatus": 0,
1896
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
1897
"6ab612cff5ad227247e46c2b020f441c"),
1898
"Host": "192.0.2.3",
1901
"LastCheckedOK": "2019-02-04T00:00:00",
1902
"Created": "2019-01-03T00:00:00",
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,
1914
"ExtendedTimeout": 900000,
1915
"Expires": "2019-02-05T00:00:00",
1916
"LastCheckerStatus": -2,
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)
1927
@contextlib.contextmanager
1928
def capture_stdout_to_buffer():
1929
capture_buffer = io.StringIO()
1930
old_stdout = sys.stdout
1931
sys.stdout = capture_buffer
1933
yield capture_buffer
1935
sys.stdout = old_stdout
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())
1398
1941
expected_json = {"foo": self.expected_json["foo"]}
1399
self.assertDictEqual(json_data, expected_json)
1402
class TestPrintTableCmd(TestCmd):
1403
def test_normal(self):
1404
output = PrintTableCmd().output(self.clients.values())
1942
self.assertDictEqual(expected_json, json_data)
1944
def test_PrintTable_normal(self):
1945
with self.capture_stdout_to_buffer() as buffer:
1946
command.PrintTable().run(self.bus.clients)
1405
1947
expected_output = "\n".join((
1406
1948
"Name Enabled Timeout Last Successful Check",
1407
1949
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1408
1950
"barbar Yes 00:05:00 2019-02-04T00:00:00 ",
1410
self.assertEqual(output, expected_output)
1952
self.assertEqual(expected_output, buffer.getvalue())
1412
def test_verbose(self):
1413
output = PrintTableCmd(verbose=True).output(
1414
self.clients.values())
1954
def test_PrintTable_verbose(self):
1955
with self.capture_stdout_to_buffer() as buffer:
1956
command.PrintTable(verbose=True).run(self.bus.clients)
1501
2043
num_lines = max(len(rows) for rows in columns)
1502
expected_output = "\n".join("".join(rows[line]
1503
for rows in columns)
1504
for line in range(num_lines))
1505
self.assertEqual(output, expected_output)
2044
expected_output = ("\n".join("".join(rows[line]
2045
for rows in columns)
2046
for line in range(num_lines))
2048
self.assertEqual(expected_output, buffer.getvalue())
1507
def test_one_client(self):
1508
output = PrintTableCmd().output(self.one_client.values())
2050
def test_PrintTable_one_client(self):
2051
with self.capture_stdout_to_buffer() as buffer:
2052
command.PrintTable().run(self.bus.one_client)
1509
2053
expected_output = "\n".join((
1510
2054
"Name Enabled Timeout Last Successful Check",
1511
2055
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1513
self.assertEqual(output, expected_output)
1516
class Unique(object):
1517
"""Class for objects which exist only to be unique objects, since
1518
unittest.mock.sentinel only exists in Python 3.3"""
1521
class TestPropertyCmd(TestCmd):
1522
"""Abstract class for tests of PropertyCmd classes"""
2057
self.assertEqual(expected_output, buffer.getvalue())
2060
class TestPropertySetterCmd(TestCommand):
2061
"""Abstract class for tests of command.PropertySetter classes"""
1523
2063
def runTest(self):
1524
2064
if not hasattr(self, "command"):
1526
values_to_get = getattr(self, "values_to_get",
1528
for value_to_set, value_to_get in zip(self.values_to_set,
1530
for clientpath in self.clients:
1531
client = self.bus.get_object(dbus_busname, clientpath)
1532
old_value = client.attributes[self.propname]
1533
self.assertNotIsInstance(old_value, Unique)
1534
client.attributes[self.propname] = Unique()
1535
self.run_command(value_to_set, self.clients)
1536
for clientpath in self.clients:
1537
client = self.bus.get_object(dbus_busname, clientpath)
1538
value = client.attributes[self.propname]
2065
return # Abstract TestCase class
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",
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] = (
2078
self.command(*cmd_arg).run(self.bus.clients, self.bus)
2079
for clientpath in self.bus.clients:
2080
value = (self.bus.clients[clientpath]
1539
2082
self.assertNotIsInstance(value, Unique)
1540
self.assertEqual(value, value_to_get)
1541
def run_command(self, value, clients):
1542
self.command().run(clients, self.bus)
1545
class TestEnableCmd(TestPropertyCmd):
1547
propname = "Enabled"
1548
values_to_set = [dbus.Boolean(True)]
1551
class TestDisableCmd(TestPropertyCmd):
1552
command = DisableCmd
1553
propname = "Enabled"
1554
values_to_set = [dbus.Boolean(False)]
1557
class TestBumpTimeoutCmd(TestPropertyCmd):
1558
command = BumpTimeoutCmd
2083
self.assertEqual(value_to_get, value)
2086
class TestEnableCmd(TestPropertySetterCmd):
2087
command = command.Enable
2088
propname = "Enabled"
2089
values_to_get = [True]
2092
class TestDisableCmd(TestPropertySetterCmd):
2093
command = command.Disable
2094
propname = "Enabled"
2095
values_to_get = [False]
2098
class TestBumpTimeoutCmd(TestPropertySetterCmd):
2099
command = command.BumpTimeout
1559
2100
propname = "LastCheckedOK"
1560
values_to_set = [""]
1563
class TestStartCheckerCmd(TestPropertyCmd):
1564
command = StartCheckerCmd
1565
propname = "CheckerRunning"
1566
values_to_set = [dbus.Boolean(True)]
1569
class TestStopCheckerCmd(TestPropertyCmd):
1570
command = StopCheckerCmd
1571
propname = "CheckerRunning"
1572
values_to_set = [dbus.Boolean(False)]
1575
class TestApproveByDefaultCmd(TestPropertyCmd):
1576
command = ApproveByDefaultCmd
1577
propname = "ApprovedByDefault"
1578
values_to_set = [dbus.Boolean(True)]
1581
class TestDenyByDefaultCmd(TestPropertyCmd):
1582
command = DenyByDefaultCmd
1583
propname = "ApprovedByDefault"
1584
values_to_set = [dbus.Boolean(False)]
1587
class TestPropertyValueCmd(TestPropertyCmd):
1588
"""Abstract class for tests of PropertyValueCmd classes"""
1591
if type(self) is TestPropertyValueCmd:
1593
return super(TestPropertyValueCmd, self).runTest()
1595
def run_command(self, value, clients):
1596
self.command(value).run(clients, self.bus)
1599
class TestSetCheckerCmd(TestPropertyValueCmd):
1600
command = SetCheckerCmd
2101
values_to_get = [""]
2104
class TestStartCheckerCmd(TestPropertySetterCmd):
2105
command = command.StartChecker
2106
propname = "CheckerRunning"
2107
values_to_get = [True]
2110
class TestStopCheckerCmd(TestPropertySetterCmd):
2111
command = command.StopChecker
2112
propname = "CheckerRunning"
2113
values_to_get = [False]
2116
class TestApproveByDefaultCmd(TestPropertySetterCmd):
2117
command = command.ApproveByDefault
2118
propname = "ApprovedByDefault"
2119
values_to_get = [True]
2122
class TestDenyByDefaultCmd(TestPropertySetterCmd):
2123
command = command.DenyByDefault
2124
propname = "ApprovedByDefault"
2125
values_to_get = [False]
2128
class TestSetCheckerCmd(TestPropertySetterCmd):
2129
command = command.SetChecker
1601
2130
propname = "Checker"
1602
2131
values_to_set = ["", ":", "fping -q -- %s"]
1605
class TestSetHostCmd(TestPropertyValueCmd):
1606
command = SetHostCmd
2134
class TestSetHostCmd(TestPropertySetterCmd):
2135
command = command.SetHost
1607
2136
propname = "Host"
1608
values_to_set = ["192.0.2.3", "foo.example.org"]
1611
class TestSetSecretCmd(TestPropertyValueCmd):
1612
command = SetSecretCmd
2137
values_to_set = ["192.0.2.3", "client.example.org"]
2140
class TestSetSecretCmd(TestPropertySetterCmd):
2141
command = command.SetSecret
1613
2142
propname = "Secret"
1614
2143
values_to_set = [io.BytesIO(b""),
1615
2144
io.BytesIO(b"secret\0xyzzy\nbar")]
1616
values_to_get = [b"", b"secret\0xyzzy\nbar"]
1619
class TestSetTimeoutCmd(TestPropertyValueCmd):
1620
command = SetTimeoutCmd
2145
values_to_get = [f.getvalue() for f in values_to_set]
2148
class TestSetTimeoutCmd(TestPropertySetterCmd):
2149
command = command.SetTimeout
1621
2150
propname = "Timeout"
1622
2151
values_to_set = [datetime.timedelta(),
1623
2152
datetime.timedelta(minutes=5),
1624
2153
datetime.timedelta(seconds=1),
1625
2154
datetime.timedelta(weeks=1),
1626
2155
datetime.timedelta(weeks=52)]
1627
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1630
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
1631
command = SetExtendedTimeoutCmd
2156
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2159
class TestSetExtendedTimeoutCmd(TestPropertySetterCmd):
2160
command = command.SetExtendedTimeout
1632
2161
propname = "ExtendedTimeout"
1633
2162
values_to_set = [datetime.timedelta(),
1634
2163
datetime.timedelta(minutes=5),
1635
2164
datetime.timedelta(seconds=1),
1636
2165
datetime.timedelta(weeks=1),
1637
2166
datetime.timedelta(weeks=52)]
1638
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1641
class TestSetIntervalCmd(TestPropertyValueCmd):
1642
command = SetIntervalCmd
2167
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2170
class TestSetIntervalCmd(TestPropertySetterCmd):
2171
command = command.SetInterval
1643
2172
propname = "Interval"
1644
2173
values_to_set = [datetime.timedelta(),
1645
2174
datetime.timedelta(minutes=5),
1646
2175
datetime.timedelta(seconds=1),
1647
2176
datetime.timedelta(weeks=1),
1648
2177
datetime.timedelta(weeks=52)]
1649
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1652
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
1653
command = SetApprovalDelayCmd
2178
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2181
class TestSetApprovalDelayCmd(TestPropertySetterCmd):
2182
command = command.SetApprovalDelay
1654
2183
propname = "ApprovalDelay"
1655
2184
values_to_set = [datetime.timedelta(),
1656
2185
datetime.timedelta(minutes=5),
1657
2186
datetime.timedelta(seconds=1),
1658
2187
datetime.timedelta(weeks=1),
1659
2188
datetime.timedelta(weeks=52)]
1660
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1663
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
1664
command = SetApprovalDurationCmd
2189
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2192
class TestSetApprovalDurationCmd(TestPropertySetterCmd):
2193
command = command.SetApprovalDuration
1665
2194
propname = "ApprovalDuration"
1666
2195
values_to_set = [datetime.timedelta(),
1667
2196
datetime.timedelta(minutes=5),
1668
2197
datetime.timedelta(seconds=1),
1669
2198
datetime.timedelta(weeks=1),
1670
2199
datetime.timedelta(weeks=52)]
1671
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
2200
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]