136
161
help="Select all clients")
137
162
parser.add_argument("-v", "--verbose", action="store_true",
138
163
help="Print all fields")
139
parser.add_argument("-j", "--dump-json", dest="commands",
140
action="append_const", default=[],
141
const=command.DumpJSON(),
164
parser.add_argument("-j", "--dump-json", action="store_true",
142
165
help="Dump client data in JSON format")
143
166
enable_disable = parser.add_mutually_exclusive_group()
144
enable_disable.add_argument("-e", "--enable", dest="commands",
145
action="append_const", default=[],
146
const=command.Enable(),
167
enable_disable.add_argument("-e", "--enable", action="store_true",
147
168
help="Enable client")
148
enable_disable.add_argument("-d", "--disable", dest="commands",
149
action="append_const", default=[],
150
const=command.Disable(),
169
enable_disable.add_argument("-d", "--disable",
151
171
help="disable client")
152
parser.add_argument("-b", "--bump-timeout", dest="commands",
153
action="append_const", default=[],
154
const=command.BumpTimeout(),
172
parser.add_argument("-b", "--bump-timeout", action="store_true",
155
173
help="Bump timeout for client")
156
174
start_stop_checker = parser.add_mutually_exclusive_group()
157
175
start_stop_checker.add_argument("--start-checker",
159
action="append_const", default=[],
160
const=command.StartChecker(),
161
177
help="Start checker for client")
162
start_stop_checker.add_argument("--stop-checker", dest="commands",
163
action="append_const", default=[],
164
const=command.StopChecker(),
178
start_stop_checker.add_argument("--stop-checker",
165
180
help="Stop checker for client")
166
parser.add_argument("-V", "--is-enabled", dest="commands",
167
action="append_const", default=[],
168
const=command.IsEnabled(),
181
parser.add_argument("-V", "--is-enabled", action="store_true",
169
182
help="Check if client is enabled")
170
parser.add_argument("-r", "--remove", dest="commands",
171
action="append_const", default=[],
172
const=command.Remove(),
183
parser.add_argument("-r", "--remove", action="store_true",
173
184
help="Remove client")
174
parser.add_argument("-c", "--checker", dest="commands",
175
action="append", default=[],
176
metavar="COMMAND", type=command.SetChecker,
185
parser.add_argument("-c", "--checker",
177
186
help="Set checker command for client")
179
"-t", "--timeout", dest="commands", action="append",
180
default=[], metavar="TIME",
181
type=command.SetTimeout.argparse(string_to_delta),
182
help="Set timeout for client")
184
"--extended-timeout", dest="commands", action="append",
185
default=[], metavar="TIME",
186
type=command.SetExtendedTimeout.argparse(string_to_delta),
187
help="Set extended timeout for client")
189
"-i", "--interval", dest="commands", action="append",
190
default=[], metavar="TIME",
191
type=command.SetInterval.argparse(string_to_delta),
192
help="Set checker interval 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")
193
193
approve_deny_default = parser.add_mutually_exclusive_group()
194
194
approve_deny_default.add_argument(
195
"--approve-by-default", dest="commands",
196
action="append_const", default=[],
197
const=command.ApproveByDefault(),
195
"--approve-by-default", action="store_true",
196
default=None, dest="approved_by_default",
198
197
help="Set client to be approved by default")
199
198
approve_deny_default.add_argument(
200
"--deny-by-default", dest="commands",
201
action="append_const", default=[],
202
const=command.DenyByDefault(),
199
"--deny-by-default", action="store_false",
200
dest="approved_by_default",
203
201
help="Set client to be denied by default")
205
"--approval-delay", dest="commands", action="append",
206
default=[], metavar="TIME",
207
type=command.SetApprovalDelay.argparse(string_to_delta),
208
help="Set delay before client approve/deny")
210
"--approval-duration", dest="commands", action="append",
211
default=[], metavar="TIME",
212
type=command.SetApprovalDuration.argparse(string_to_delta),
213
help="Set duration of one client approval")
214
parser.add_argument("-H", "--host", dest="commands",
215
action="append", default=[], metavar="STRING",
216
type=command.SetHost,
217
help="Set host for client")
219
"-s", "--secret", dest="commands", action="append",
220
default=[], metavar="FILENAME",
221
type=command.SetSecret.argparse(argparse.FileType(mode="rb")),
222
help="Set password blob (file) for client")
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")
223
210
approve_deny = parser.add_mutually_exclusive_group()
224
211
approve_deny.add_argument(
225
"-A", "--approve", dest="commands", action="append_const",
226
default=[], const=command.Approve(),
212
"-A", "--approve", action="store_true",
227
213
help="Approve any current client request")
228
approve_deny.add_argument("-D", "--deny", dest="commands",
229
action="append_const", default=[],
230
const=command.Deny(),
214
approve_deny.add_argument("-D", "--deny", action="store_true",
231
215
help="Deny any current client request")
232
216
parser.add_argument("--debug", action="store_true",
233
217
help="Debug mode (show D-Bus commands)")
425
408
"""Apply additional restrictions on options, not expressible in
428
def has_commands(options, commands=None):
430
commands = (command.Enable,
433
command.StartChecker,
439
command.SetExtendedTimeout,
441
command.ApproveByDefault,
442
command.DenyByDefault,
443
command.SetApprovalDelay,
444
command.SetApprovalDuration,
449
return any(isinstance(cmd, commands)
450
for cmd in options.commands)
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,
452
if has_commands(options) and not (options.client or options.all):
431
if has_actions(options) and not (options.client or options.all):
453
432
parser.error("Options require clients names or --all.")
454
if options.verbose and has_commands(options):
433
if options.verbose and has_actions(options):
455
434
parser.error("--verbose can only be used alone.")
456
if (has_commands(options, (command.DumpJSON,))
457
and (options.verbose or len(options.commands) > 1)):
435
if options.dump_json and (options.verbose
436
or has_actions(options)):
458
437
parser.error("--dump-json can only be used alone.")
459
if options.all and not has_commands(options):
438
if options.all and not has_actions(options):
460
439
parser.error("--all requires an action.")
461
if (has_commands(options, (command.IsEnabled,))
462
and len(options.client) > 1):
440
if options.is_enabled and len(options.client) > 1:
463
441
parser.error("--is-enabled requires exactly one client")
464
if (len(options.commands) > 1
465
and has_commands(options, (command.Remove,))
466
and not has_commands(options, (command.Deny,))):
467
parser.error("--remove can only be combined with --deny")
472
class SystemBus(object):
474
object_manager_iface = "org.freedesktop.DBus.ObjectManager"
475
def get_managed_objects(self, busname, objectpath):
476
return self.call_method("GetManagedObjects", busname,
478
self.object_manager_iface)
480
properties_iface = "org.freedesktop.DBus.Properties"
481
def set_property(self, busname, objectpath, interface, key,
483
self.call_method("Set", busname, objectpath,
484
self.properties_iface, interface, key,
488
class MandosBus(SystemBus):
489
busname_domain = "se.recompile"
490
busname = busname_domain + ".Mandos"
492
server_interface = busname_domain + ".Mandos"
493
client_interface = busname_domain + ".Mandos.Client"
496
def get_clients_and_properties(self):
497
managed_objects = self.get_managed_objects(
498
self.busname, self.server_path)
499
return {objpath: properties[self.client_interface]
500
for objpath, properties in managed_objects.items()
501
if self.client_interface in properties}
503
def set_client_property(self, objectpath, key, value):
504
return self.set_property(self.busname, objectpath,
505
self.client_interface, key,
508
def call_client_method(self, objectpath, method, *args):
509
return self.call_method(method, self.busname, objectpath,
510
self.client_interface, *args)
512
def call_server_method(self, method, *args):
513
return self.call_method(method, self.busname,
515
self.server_interface, *args)
517
class Error(Exception):
520
class ConnectFailed(Error):
524
class dbus_python_adapter(object):
526
class SystemBus(dbus.MandosBus):
527
"""Use dbus-python"""
529
def __init__(self, module=dbus_python):
530
self.dbus_python = module
531
self.bus = self.dbus_python.SystemBus()
533
@contextlib.contextmanager
534
def convert_exception(self, exception_class=dbus.Error):
537
except self.dbus_python.exceptions.DBusException as e:
538
# This does what "raise from" would do
539
exc = exception_class(*e.args)
543
def call_method(self, methodname, busname, objectpath,
545
proxy_object = self.get_object(busname, objectpath)
546
log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
547
interface, methodname,
548
", ".join(repr(a) for a in args))
549
method = getattr(proxy_object, methodname)
550
with self.convert_exception():
551
with dbus_python_adapter.SilenceLogger(
553
value = method(*args, dbus_interface=interface)
554
return self.type_filter(value)
556
def get_object(self, busname, objectpath):
557
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
559
with self.convert_exception(dbus.ConnectFailed):
560
return self.bus.get_object(busname, objectpath)
562
def type_filter(self, value):
563
"""Convert the most bothersome types to Python types"""
564
if isinstance(value, self.dbus_python.Boolean):
566
if isinstance(value, self.dbus_python.ObjectPath):
568
# Also recurse into dictionaries
569
if isinstance(value, self.dbus_python.Dictionary):
570
return {self.type_filter(key):
571
self.type_filter(subval)
572
for key, subval in value.items()}
575
def set_client_property(self, objectpath, key, value):
577
if not isinstance(value, bytes):
578
value = value.encode("utf-8")
579
value = self.dbus_python.ByteArray(value)
580
return self.set_property(self.busname, objectpath,
581
self.client_interface, key,
584
class SilenceLogger(object):
585
"Simple context manager to silence a particular logger"
586
def __init__(self, loggername):
587
self.logger = logging.getLogger(loggername)
590
self.logger.addFilter(self.nullfilter)
592
class NullFilter(logging.Filter):
593
def filter(self, record):
596
nullfilter = NullFilter()
598
def __exit__(self, exc_type, exc_val, exc_tb):
599
self.logger.removeFilter(self.nullfilter)
602
class CachingBus(SystemBus):
603
"""A caching layer for dbus_python_adapter.SystemBus"""
604
def __init__(self, *args, **kwargs):
605
self.object_cache = {}
606
super(dbus_python_adapter.CachingBus,
607
self).__init__(*args, **kwargs)
608
def get_object(self, busname, objectpath):
610
return self.object_cache[(busname, objectpath)]
613
dbus_python_adapter.CachingBus,
614
self).get_object(busname, objectpath)
615
self.object_cache[(busname, objectpath)] = new_object
619
class pydbus_adapter(object):
620
class SystemBus(dbus.MandosBus):
621
def __init__(self, module=pydbus):
623
self.bus = self.pydbus.SystemBus()
625
@contextlib.contextmanager
626
def convert_exception(self, exception_class=dbus.Error):
629
except gi.repository.GLib.Error as e:
630
# This does what "raise from" would do
631
exc = exception_class(*e.args)
635
def call_method(self, methodname, busname, objectpath,
637
proxy_object = self.get(busname, objectpath)
638
log.debug("D-Bus: %s:%s:%s.%s(%s)", busname, objectpath,
639
interface, methodname,
640
", ".join(repr(a) for a in args))
641
method = getattr(proxy_object[interface], methodname)
642
with self.convert_exception():
645
def get(self, busname, objectpath):
646
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
648
with self.convert_exception(dbus.ConnectFailed):
649
if sys.version_info.major <= 2:
650
with warnings.catch_warnings():
651
warnings.filterwarnings(
652
"ignore", "", DeprecationWarning,
653
r"^xml\.etree\.ElementTree$")
654
return self.bus.get(busname, objectpath)
656
return self.bus.get(busname, objectpath)
658
def set_property(self, busname, objectpath, interface, key,
660
proxy_object = self.get(busname, objectpath)
661
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", busname,
662
objectpath, self.properties_iface, interface,
664
setattr(proxy_object[interface], key, value)
666
class CachingBus(SystemBus):
667
"""A caching layer for pydbus_adapter.SystemBus"""
668
def __init__(self, *args, **kwargs):
669
self.object_cache = {}
670
super(pydbus_adapter.CachingBus,
671
self).__init__(*args, **kwargs)
672
def get(self, busname, objectpath):
674
return self.object_cache[(busname, objectpath)]
676
new_object = (super(pydbus_adapter.CachingBus, self)
677
.get(busname, objectpath))
678
self.object_cache[(busname, objectpath)] = new_object
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
682
449
def commands_from_options(options):
684
commands = list(options.commands)
686
def find_cmd(cmd, commands):
688
for i, c in enumerate(commands):
689
if isinstance(c, cmd):
693
# If command.Remove is present, move any instances of command.Deny
694
# to occur ahead of command.Remove.
695
index_of_remove = find_cmd(command.Remove, commands)
696
before_remove = commands[:index_of_remove]
697
after_remove = commands[index_of_remove:]
699
for cmd in after_remove:
700
if isinstance(cmd, command.Deny):
701
before_remove.append(cmd)
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())
703
cleaned_after.append(cmd)
704
if cleaned_after != after_remove:
705
commands = before_remove + cleaned_after
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))
707
515
# If no command option has been given, show table of clients,
708
516
# optionally verbosely
710
commands.append(command.PrintTable(verbose=options.verbose))
518
commands.append(PrintTableCmd(verbose=options.verbose))
715
class command(object):
716
"""A namespace for command classes"""
719
"""Abstract base class for commands"""
720
def run(self, clients, bus=None):
721
"""Normal commands should implement run_on_one_client(),
722
but commands which want to operate on all clients at the same time can
723
override this run() method instead.
726
for client, properties in clients.items():
727
self.run_on_one_client(client, properties)
730
class IsEnabled(Base):
731
def run(self, clients, bus=None):
732
properties = next(iter(clients.values()))
733
if properties["Enabled"]:
739
def run_on_one_client(self, client, properties):
740
self.bus.call_client_method(client, "Approve", True)
744
def run_on_one_client(self, client, properties):
745
self.bus.call_client_method(client, "Approve", False)
749
def run(self, clients, bus):
750
for clientpath in frozenset(clients.keys()):
751
bus.call_server_method("RemoveClient", clientpath)
755
"""Abstract class for commands outputting client details"""
756
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
757
"Created", "Interval", "Host", "KeyID",
758
"Fingerprint", "CheckerRunning",
759
"LastEnabled", "ApprovalPending",
760
"ApprovedByDefault", "LastApprovalRequest",
761
"ApprovalDelay", "ApprovalDuration",
762
"Checker", "ExtendedTimeout", "Expires",
766
class DumpJSON(Output):
767
def run(self, clients, bus=None):
768
data = {properties["Name"]:
769
{key: properties[key]
770
for key in self.all_keywords}
771
for properties in clients.values()}
772
print(json.dumps(data, indent=4, separators=(',', ': ')))
775
class PrintTable(Output):
776
def __init__(self, verbose=False):
777
self.verbose = verbose
779
def run(self, clients, bus=None):
780
default_keywords = ("Name", "Enabled", "Timeout",
782
keywords = default_keywords
784
keywords = self.all_keywords
785
print(self.TableOfClients(clients.values(), keywords))
787
class TableOfClients(object):
790
"Enabled": "Enabled",
791
"Timeout": "Timeout",
792
"LastCheckedOK": "Last Successful Check",
793
"LastApprovalRequest": "Last Approval Request",
794
"Created": "Created",
795
"Interval": "Interval",
797
"Fingerprint": "Fingerprint",
799
"CheckerRunning": "Check Is Running",
800
"LastEnabled": "Last Enabled",
801
"ApprovalPending": "Approval Is Pending",
802
"ApprovedByDefault": "Approved By Default",
803
"ApprovalDelay": "Approval Delay",
804
"ApprovalDuration": "Approval Duration",
805
"Checker": "Checker",
806
"ExtendedTimeout": "Extended Timeout",
807
"Expires": "Expires",
808
"LastCheckerStatus": "Last Checker Status",
811
def __init__(self, clients, keywords):
812
self.clients = clients
813
self.keywords = keywords
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")
580
def run(self, clients, bus=None, mandos=None):
581
print(self.output(clients.values()))
582
def output(self, clients):
583
raise NotImplementedError()
586
class DumpJSONCmd(OutputCmd):
587
def output(self, clients):
588
data = {client["Name"]:
589
{key: self.dbus_boolean_to_bool(client[key])
590
for key in self.all_keywords}
591
for client in clients.values()}
592
return json.dumps(data, indent=4, separators=(',', ': '))
594
def dbus_boolean_to_bool(value):
595
if isinstance(value, dbus.Boolean):
600
class PrintTableCmd(OutputCmd):
601
def __init__(self, verbose=False):
602
self.verbose = verbose
604
def output(self, clients):
605
default_keywords = ("Name", "Enabled", "Timeout",
607
keywords = default_keywords
609
keywords = self.all_keywords
610
return str(self.TableOfClients(clients, keywords))
612
class TableOfClients(object):
615
"Enabled": "Enabled",
616
"Timeout": "Timeout",
617
"LastCheckedOK": "Last Successful Check",
618
"LastApprovalRequest": "Last Approval Request",
619
"Created": "Created",
620
"Interval": "Interval",
622
"Fingerprint": "Fingerprint",
624
"CheckerRunning": "Check Is Running",
625
"LastEnabled": "Last Enabled",
626
"ApprovalPending": "Approval Is Pending",
627
"ApprovedByDefault": "Approved By Default",
628
"ApprovalDelay": "Approval Delay",
629
"ApprovalDuration": "Approval Duration",
630
"Checker": "Checker",
631
"ExtendedTimeout": "Extended Timeout",
632
"Expires": "Expires",
633
"LastCheckerStatus": "Last Checker Status",
636
def __init__(self, clients, keywords, tableheaders=None):
637
self.clients = clients
638
self.keywords = keywords
639
if tableheaders is not None:
640
self.tableheaders = tableheaders
643
return "\n".join(self.rows())
645
if sys.version_info.major == 2:
646
__unicode__ = __str__
815
647
def __str__(self):
816
return "\n".join(self.rows())
818
if sys.version_info.major == 2:
819
__unicode__ = __str__
821
return str(self).encode(
822
locale.getpreferredencoding())
825
format_string = self.row_formatting_string()
826
rows = [self.header_line(format_string)]
827
rows.extend(self.client_line(client, format_string)
828
for client in self.clients)
831
def row_formatting_string(self):
832
"Format string used to format table rows"
833
return " ".join("{{{key}:{width}}}".format(
834
width=max(len(self.tableheaders[key]),
835
*(len(self.string_from_client(client,
837
for client in self.clients)),
839
for key in self.keywords)
841
def string_from_client(self, client, key):
842
return self.valuetostring(client[key], key)
845
def valuetostring(cls, value, keyword):
846
if isinstance(value, bool):
847
return "Yes" if value else "No"
848
if keyword in ("Timeout", "Interval", "ApprovalDelay",
849
"ApprovalDuration", "ExtendedTimeout"):
850
return cls.milliseconds_to_string(value)
853
def header_line(self, format_string):
854
return format_string.format(**self.tableheaders)
856
def client_line(self, client, format_string):
857
return format_string.format(
858
**{key: self.string_from_client(client, key)
859
for key in self.keywords})
862
def milliseconds_to_string(ms):
863
td = datetime.timedelta(0, 0, 0, ms)
864
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
865
.format(days="{}T".format(td.days)
867
hours=td.seconds // 3600,
868
minutes=(td.seconds % 3600) // 60,
869
seconds=td.seconds % 60))
872
class PropertySetter(Base):
873
"Abstract class for Actions for setting one client property"
875
def run_on_one_client(self, client, properties=None):
876
"""Set the Client's D-Bus property"""
877
self.bus.set_client_property(client, self.propname,
882
raise NotImplementedError()
885
class Enable(PropertySetter):
890
class Disable(PropertySetter):
895
class BumpTimeout(PropertySetter):
896
propname = "LastCheckedOK"
900
class StartChecker(PropertySetter):
901
propname = "CheckerRunning"
905
class StopChecker(PropertySetter):
906
propname = "CheckerRunning"
910
class ApproveByDefault(PropertySetter):
911
propname = "ApprovedByDefault"
915
class DenyByDefault(PropertySetter):
916
propname = "ApprovedByDefault"
920
class PropertySetterValue(PropertySetter):
921
"""Abstract class for PropertySetter recieving a value as
922
constructor argument instead of a class attribute."""
923
def __init__(self, value):
924
self.value_to_set = value
648
return str(self).encode(locale.getpreferredencoding())
651
format_string = self.row_formatting_string()
652
rows = [self.header_line(format_string)]
653
rows.extend(self.client_line(client, format_string)
654
for client in self.clients)
657
def row_formatting_string(self):
658
"Format string used to format table rows"
659
return " ".join("{{{key}:{width}}}".format(
660
width=max(len(self.tableheaders[key]),
661
*(len(self.string_from_client(client, key))
662
for client in self.clients)),
664
for key in self.keywords)
666
def string_from_client(self, client, key):
667
return self.valuetostring(client[key], key)
927
def argparse(cls, argtype):
929
return cls(argtype(arg))
932
class SetChecker(PropertySetterValue):
936
class SetHost(PropertySetterValue):
940
class SetSecret(PropertySetterValue):
944
def value_to_set(self):
948
def value_to_set(self, value):
949
"""When setting, read data from supplied file object"""
950
self._vts = value.read()
954
class PropertySetterValueMilliseconds(PropertySetterValue):
955
"""Abstract class for PropertySetterValue taking a value
956
argument as a datetime.timedelta() but should store it as
960
def value_to_set(self):
964
def value_to_set(self, value):
965
"When setting, convert value from a datetime.timedelta"
966
self._vts = int(round(value.total_seconds() * 1000))
969
class SetTimeout(PropertySetterValueMilliseconds):
973
class SetExtendedTimeout(PropertySetterValueMilliseconds):
974
propname = "ExtendedTimeout"
977
class SetInterval(PropertySetterValueMilliseconds):
978
propname = "Interval"
981
class SetApprovalDelay(PropertySetterValueMilliseconds):
982
propname = "ApprovalDelay"
985
class SetApprovalDuration(PropertySetterValueMilliseconds):
986
propname = "ApprovalDuration"
670
def valuetostring(cls, value, keyword):
671
if isinstance(value, dbus.Boolean):
672
return "Yes" if value else "No"
673
if keyword in ("Timeout", "Interval", "ApprovalDelay",
674
"ApprovalDuration", "ExtendedTimeout"):
675
return cls.milliseconds_to_string(value)
678
def header_line(self, format_string):
679
return format_string.format(**self.tableheaders)
681
def client_line(self, client, format_string):
682
return format_string.format(
683
**{key: self.string_from_client(client, key)
684
for key in self.keywords})
687
def milliseconds_to_string(ms):
688
td = datetime.timedelta(0, 0, 0, ms)
689
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
690
.format(days="{}T".format(td.days)
692
hours=td.seconds // 3600,
693
minutes=(td.seconds % 3600) // 60,
694
seconds=td.seconds % 60))
697
class PropertyCmd(Command):
698
"""Abstract class for Actions for setting one client property"""
699
def run_on_one_client(self, client, properties):
700
"""Set the Client's D-Bus property"""
701
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
702
client.__dbus_object_path__,
703
dbus.PROPERTIES_IFACE, client_dbus_interface,
704
self.propname, self.value_to_set
705
if not isinstance(self.value_to_set, dbus.Boolean)
706
else bool(self.value_to_set))
707
client.Set(client_dbus_interface, self.propname,
709
dbus_interface=dbus.PROPERTIES_IFACE)
712
raise NotImplementedError()
715
class EnableCmd(PropertyCmd):
717
value_to_set = dbus.Boolean(True)
720
class DisableCmd(PropertyCmd):
722
value_to_set = dbus.Boolean(False)
725
class BumpTimeoutCmd(PropertyCmd):
726
propname = "LastCheckedOK"
730
class StartCheckerCmd(PropertyCmd):
731
propname = "CheckerRunning"
732
value_to_set = dbus.Boolean(True)
735
class StopCheckerCmd(PropertyCmd):
736
propname = "CheckerRunning"
737
value_to_set = dbus.Boolean(False)
740
class ApproveByDefaultCmd(PropertyCmd):
741
propname = "ApprovedByDefault"
742
value_to_set = dbus.Boolean(True)
745
class DenyByDefaultCmd(PropertyCmd):
746
propname = "ApprovedByDefault"
747
value_to_set = dbus.Boolean(False)
750
class PropertyValueCmd(PropertyCmd):
751
"""Abstract class for PropertyCmd recieving a value as argument"""
752
def __init__(self, value):
753
self.value_to_set = value
756
class SetCheckerCmd(PropertyValueCmd):
760
class SetHostCmd(PropertyValueCmd):
764
class SetSecretCmd(PropertyValueCmd):
767
def value_to_set(self):
770
def value_to_set(self, value):
771
"""When setting, read data from supplied file object"""
772
self._vts = value.read()
776
class MillisecondsPropertyValueArgumentCmd(PropertyValueCmd):
777
"""Abstract class for PropertyValueCmd taking a value argument as
778
a datetime.timedelta() but should store it as milliseconds."""
780
def value_to_set(self):
783
def value_to_set(self, value):
784
"""When setting, convert value from a datetime.timedelta"""
785
self._vts = int(round(value.total_seconds() * 1000))
788
class SetTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
792
class SetExtendedTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
793
propname = "ExtendedTimeout"
796
class SetIntervalCmd(MillisecondsPropertyValueArgumentCmd):
797
propname = "Interval"
800
class SetApprovalDelayCmd(MillisecondsPropertyValueArgumentCmd):
801
propname = "ApprovalDelay"
804
class SetApprovalDurationCmd(MillisecondsPropertyValueArgumentCmd):
805
propname = "ApprovalDuration"
990
class TestCaseWithAssertLogs(unittest.TestCase):
991
"""unittest.TestCase.assertLogs only exists in Python 3.4"""
993
if not hasattr(unittest.TestCase, "assertLogs"):
994
@contextlib.contextmanager
995
def assertLogs(self, logger, level=logging.INFO):
996
capturing_handler = self.CapturingLevelHandler(level)
997
old_level = logger.level
998
old_propagate = logger.propagate
999
logger.addHandler(capturing_handler)
1000
logger.setLevel(level)
1001
logger.propagate = False
1003
yield capturing_handler.watcher
1005
logger.propagate = old_propagate
1006
logger.removeHandler(capturing_handler)
1007
logger.setLevel(old_level)
1008
self.assertGreater(len(capturing_handler.watcher.records),
1011
class CapturingLevelHandler(logging.Handler):
1012
def __init__(self, level, *args, **kwargs):
1013
logging.Handler.__init__(self, *args, **kwargs)
1014
self.watcher = self.LoggingWatcher([], [])
1015
def emit(self, record):
1016
self.watcher.records.append(record)
1017
self.watcher.output.append(self.format(record))
1019
LoggingWatcher = collections.namedtuple("LoggingWatcher",
1024
class Unique(object):
1025
"""Class for objects which exist only to be unique objects, since
1026
unittest.mock.sentinel only exists in Python 3.3"""
1029
class Test_string_to_delta(TestCaseWithAssertLogs):
1030
# Just test basic RFC 3339 functionality here, the doc string for
1031
# rfc3339_duration_to_delta() already has more comprehensive
1032
# tests, which are run by doctest.
1034
def test_rfc3339_zero_seconds(self):
1035
self.assertEqual(datetime.timedelta(),
1036
string_to_delta("PT0S"))
1038
def test_rfc3339_zero_days(self):
1039
self.assertEqual(datetime.timedelta(), string_to_delta("P0D"))
1041
def test_rfc3339_one_second(self):
1042
self.assertEqual(datetime.timedelta(0, 1),
1043
string_to_delta("PT1S"))
1045
def test_rfc3339_two_hours(self):
1046
self.assertEqual(datetime.timedelta(0, 7200),
1047
string_to_delta("PT2H"))
809
class Test_string_to_delta(unittest.TestCase):
810
def test_handles_basic_rfc3339(self):
811
self.assertEqual(string_to_delta("PT0S"),
812
datetime.timedelta())
813
self.assertEqual(string_to_delta("P0D"),
814
datetime.timedelta())
815
self.assertEqual(string_to_delta("PT1S"),
816
datetime.timedelta(0, 1))
817
self.assertEqual(string_to_delta("PT2H"),
818
datetime.timedelta(0, 7200))
1049
819
def test_falls_back_to_pre_1_6_1_with_warning(self):
1050
with self.assertLogs(log, logging.WARNING):
1051
value = string_to_delta("2h")
1052
self.assertEqual(datetime.timedelta(0, 7200), value)
820
# assertLogs only exists in Python 3.4
821
if hasattr(self, "assertLogs"):
822
with self.assertLogs(log, logging.WARNING):
823
value = string_to_delta("2h")
825
class WarningFilter(logging.Filter):
826
"""Don't show, but record the presence of, warnings"""
827
def filter(self, record):
828
is_warning = record.levelno >= logging.WARNING
829
self.found = is_warning or getattr(self, "found",
831
return not is_warning
832
warning_filter = WarningFilter()
833
log.addFilter(warning_filter)
835
value = string_to_delta("2h")
837
log.removeFilter(warning_filter)
838
self.assertTrue(getattr(warning_filter, "found", False))
839
self.assertEqual(value, datetime.timedelta(0, 7200))
1055
842
class Test_check_option_syntax(unittest.TestCase):
1060
847
def test_actions_requires_client_or_all(self):
1061
848
for action, value in self.actions.items():
1062
args = self.actionargs(action, value)
849
options = self.parser.parse_args()
850
setattr(options, action, value)
1063
851
with self.assertParseError():
1064
self.parse_args(args)
852
self.check_option_syntax(options)
1066
# This mostly corresponds to the definition from has_commands() in
854
# This mostly corresponds to the definition from has_actions() in
1067
855
# check_option_syntax()
1071
"--bump-timeout": None,
1072
"--start-checker": None,
1073
"--stop-checker": None,
1074
"--is-enabled": None,
1077
"--timeout": "PT0S",
1078
"--extended-timeout": "PT0S",
1079
"--interval": "PT0S",
1080
"--approve-by-default": None,
1081
"--deny-by-default": None,
1082
"--approval-delay": "PT0S",
1083
"--approval-duration": "PT0S",
1084
"--host": "hostname",
1085
"--secret": "/dev/null",
857
# The actual values set here are not that important, but we do
858
# at least stick to the correct types, even though they are
862
"bump_timeout": True,
863
"start_checker": True,
864
"stop_checker": True,
868
"timeout": datetime.timedelta(),
869
"extended_timeout": datetime.timedelta(),
870
"interval": datetime.timedelta(),
871
"approved_by_default": True,
872
"approval_delay": datetime.timedelta(),
873
"approval_duration": datetime.timedelta(),
875
"secret": io.BytesIO(b"x"),
1091
def actionargs(action, value, *args):
1092
if value is not None:
1093
return [action, value] + list(args)
1095
return [action] + list(args)
1097
880
@contextlib.contextmanager
1098
881
def assertParseError(self):
1099
882
with self.assertRaises(SystemExit) as e:
1100
with self.redirect_stderr_to_devnull():
883
with self.temporarily_suppress_stderr():
1102
885
# Exit code from argparse is guaranteed to be "2". Reference:
1103
886
# https://docs.python.org/3/library
1104
887
# /argparse.html#exiting-methods
1105
self.assertEqual(2, e.exception.code)
1107
def parse_args(self, args):
1108
options = self.parser.parse_args(args)
1109
check_option_syntax(self.parser, options)
888
self.assertEqual(e.exception.code, 2)
1112
891
@contextlib.contextmanager
1113
def redirect_stderr_to_devnull():
1114
old_stderr = sys.stderr
1115
with contextlib.closing(open(os.devnull, "w")) as null:
1120
sys.stderr = old_stderr
892
def temporarily_suppress_stderr():
893
null = os.open(os.path.devnull, os.O_RDWR)
894
stderrcopy = os.dup(sys.stderr.fileno())
895
os.dup2(null, sys.stderr.fileno())
901
os.dup2(stderrcopy, sys.stderr.fileno())
1122
904
def check_option_syntax(self, options):
1123
905
check_option_syntax(self.parser, options)
1125
def test_actions_all_conflicts_with_verbose(self):
1126
for action, value in self.actions.items():
1127
args = self.actionargs(action, value, "--all",
1129
with self.assertParseError():
1130
self.parse_args(args)
1132
def test_actions_with_client_conflicts_with_verbose(self):
1133
for action, value in self.actions.items():
1134
args = self.actionargs(action, value, "--verbose",
1136
with self.assertParseError():
1137
self.parse_args(args)
907
def test_actions_conflicts_with_verbose(self):
908
for action, value in self.actions.items():
909
options = self.parser.parse_args()
910
setattr(options, action, value)
911
options.verbose = True
912
with self.assertParseError():
913
self.check_option_syntax(options)
1139
915
def test_dump_json_conflicts_with_verbose(self):
1140
args = ["--dump-json", "--verbose"]
916
options = self.parser.parse_args()
917
options.dump_json = True
918
options.verbose = True
1141
919
with self.assertParseError():
1142
self.parse_args(args)
920
self.check_option_syntax(options)
1144
922
def test_dump_json_conflicts_with_action(self):
1145
923
for action, value in self.actions.items():
1146
args = self.actionargs(action, value, "--dump-json")
924
options = self.parser.parse_args()
925
setattr(options, action, value)
926
options.dump_json = True
1147
927
with self.assertParseError():
1148
self.parse_args(args)
928
self.check_option_syntax(options)
1150
930
def test_all_can_not_be_alone(self):
931
options = self.parser.parse_args()
1152
933
with self.assertParseError():
1153
self.parse_args(args)
934
self.check_option_syntax(options)
1155
936
def test_all_is_ok_with_any_action(self):
1156
937
for action, value in self.actions.items():
1157
args = self.actionargs(action, value, "--all")
1158
self.parse_args(args)
1160
def test_any_action_is_ok_with_one_client(self):
1161
for action, value in self.actions.items():
1162
args = self.actionargs(action, value, "client")
1163
self.parse_args(args)
1165
def test_one_client_with_all_actions_except_is_enabled(self):
1166
for action, value in self.actions.items():
1167
if action == "--is-enabled":
1169
args = self.actionargs(action, value, "client")
1170
self.parse_args(args)
1172
def test_two_clients_with_all_actions_except_is_enabled(self):
1173
for action, value in self.actions.items():
1174
if action == "--is-enabled":
1176
args = self.actionargs(action, value, "client1",
1178
self.parse_args(args)
1180
def test_two_clients_are_ok_with_actions_except_is_enabled(self):
1181
for action, value in self.actions.items():
1182
if action == "--is-enabled":
1184
args = self.actionargs(action, value, "client1",
1186
self.parse_args(args)
938
options = self.parser.parse_args()
939
setattr(options, action, value)
941
self.check_option_syntax(options)
1188
943
def test_is_enabled_fails_without_client(self):
1189
args = ["--is-enabled"]
944
options = self.parser.parse_args()
945
options.is_enabled = True
1190
946
with self.assertParseError():
1191
self.parse_args(args)
947
self.check_option_syntax(options)
949
def test_is_enabled_works_with_one_client(self):
950
options = self.parser.parse_args()
951
options.is_enabled = True
952
options.client = ["foo"]
953
self.check_option_syntax(options)
1193
955
def test_is_enabled_fails_with_two_clients(self):
1194
args = ["--is-enabled", "client1", "client2"]
956
options = self.parser.parse_args()
957
options.is_enabled = True
958
options.client = ["foo", "barbar"]
1195
959
with self.assertParseError():
1196
self.parse_args(args)
960
self.check_option_syntax(options)
1198
962
def test_remove_can_only_be_combined_with_action_deny(self):
1199
963
for action, value in self.actions.items():
1200
if action in {"--remove", "--deny"}:
964
if action in {"remove", "deny"}:
1202
args = self.actionargs(action, value, "--all",
966
options = self.parser.parse_args()
967
setattr(options, action, value)
969
options.remove = True
1204
970
with self.assertParseError():
1205
self.parse_args(args)
1208
class Test_dbus_exceptions(unittest.TestCase):
1210
def test_dbus_ConnectFailed_is_Error(self):
1211
with self.assertRaises(dbus.Error):
1212
raise dbus.ConnectFailed()
1215
class Test_dbus_MandosBus(unittest.TestCase):
1217
class MockMandosBus(dbus.MandosBus):
1219
self._name = "se.recompile.Mandos"
1220
self._server_path = "/"
1221
self._server_interface = "se.recompile.Mandos"
1222
self._client_interface = "se.recompile.Mandos.Client"
1224
self.call_method_return = Unique()
1226
def call_method(self, methodname, busname, objectpath,
1228
self.calls.append((methodname, busname, objectpath,
1230
return self.call_method_return
1233
self.bus = self.MockMandosBus()
1235
def test_set_client_property(self):
1236
self.bus.set_client_property("objectpath", "key", "value")
1237
expected_call = ("Set", self.bus._name, "objectpath",
1238
"org.freedesktop.DBus.Properties",
1239
(self.bus._client_interface, "key", "value"))
1240
self.assertIn(expected_call, self.bus.calls)
1242
def test_call_client_method(self):
1243
ret = self.bus.call_client_method("objectpath", "methodname")
1244
self.assertIs(self.bus.call_method_return, ret)
1245
expected_call = ("methodname", self.bus._name, "objectpath",
1246
self.bus._client_interface, ())
1247
self.assertIn(expected_call, self.bus.calls)
1249
def test_call_client_method_with_args(self):
1250
args = (Unique(), Unique())
1251
ret = self.bus.call_client_method("objectpath", "methodname",
1253
self.assertIs(self.bus.call_method_return, ret)
1254
expected_call = ("methodname", self.bus._name, "objectpath",
1255
self.bus._client_interface,
1257
self.assertIn(expected_call, self.bus.calls)
1259
def test_get_clients_and_properties(self):
1262
self.bus._client_interface: {
1266
"irrelevant_interface": {
1267
"key": "othervalue",
1271
"other_objectpath": {
1272
"other_irrelevant_interface": {
1278
expected_clients_and_properties = {
1284
self.bus.call_method_return = managed_objects
1285
ret = self.bus.get_clients_and_properties()
1286
self.assertDictEqual(expected_clients_and_properties, ret)
1287
expected_call = ("GetManagedObjects", self.bus._name,
1288
self.bus._server_path,
1289
"org.freedesktop.DBus.ObjectManager", ())
1290
self.assertIn(expected_call, self.bus.calls)
1292
def test_call_server_method(self):
1293
ret = self.bus.call_server_method("methodname")
1294
self.assertIs(self.bus.call_method_return, ret)
1295
expected_call = ("methodname", self.bus._name,
1296
self.bus._server_path,
1297
self.bus._server_interface, ())
1298
self.assertIn(expected_call, self.bus.calls)
1300
def test_call_server_method_with_args(self):
1301
args = (Unique(), Unique())
1302
ret = self.bus.call_server_method("methodname", *args)
1303
self.assertIs(self.bus.call_method_return, ret)
1304
expected_call = ("methodname", self.bus._name,
1305
self.bus._server_path,
1306
self.bus._server_interface,
1308
self.assertIn(expected_call, self.bus.calls)
1311
class Test_dbus_python_adapter_SystemBus(TestCaseWithAssertLogs):
1313
def MockDBusPython_func(self, func):
1314
class mock_dbus_python(object):
1315
"""mock dbus-python module"""
1316
class exceptions(object):
1317
"""Pseudo-namespace"""
1318
class DBusException(Exception):
1320
class SystemBus(object):
1322
def get_object(busname, objectpath):
1323
DBusObject = collections.namedtuple(
1324
"DBusObject", ("methodname", "Set"))
1325
def method(*args, **kwargs):
1326
self.assertEqual({"dbus_interface":
1330
def set_property(interface, key, value,
1331
dbus_interface=None):
1333
"org.freedesktop.DBus.Properties",
1335
self.assertEqual("Secret", key)
1336
return func(interface, key, value,
1337
dbus_interface=dbus_interface)
1338
return DBusObject(methodname=method,
1340
class Boolean(object):
1341
def __init__(self, value):
1342
self.value = bool(value)
1345
if sys.version_info.major == 2:
1346
__nonzero__ = __bool__
1347
class ObjectPath(str):
1349
class Dictionary(dict):
1351
class ByteArray(bytes):
1353
return mock_dbus_python
1355
def call_method(self, bus, methodname, busname, objectpath,
1357
with self.assertLogs(log, logging.DEBUG):
1358
return bus.call_method(methodname, busname, objectpath,
1361
def test_call_method_returns(self):
1362
expected_method_return = Unique()
1363
method_args = (Unique(), Unique())
1365
self.assertEqual(len(method_args), len(args))
1366
for marg, arg in zip(method_args, args):
1367
self.assertIs(marg, arg)
1368
return expected_method_return
1369
mock_dbus_python = self.MockDBusPython_func(func)
1370
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1371
ret = self.call_method(bus, "methodname", "busname",
1372
"objectpath", "interface",
1374
self.assertIs(ret, expected_method_return)
1376
def test_call_method_filters_bool_true(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.Boolean(True)
1382
ret = self.call_method(bus, "methodname", "busname",
1383
"objectpath", "interface")
1384
self.assertTrue(ret)
1385
self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1387
def test_call_method_filters_bool_false(self):
1389
return method_return
1390
mock_dbus_python = self.MockDBusPython_func(func)
1391
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1392
method_return = mock_dbus_python.Boolean(False)
1393
ret = self.call_method(bus, "methodname", "busname",
1394
"objectpath", "interface")
1395
self.assertFalse(ret)
1396
self.assertNotIsInstance(ret, mock_dbus_python.Boolean)
1398
def test_call_method_filters_objectpath(self):
1400
return method_return
1401
mock_dbus_python = self.MockDBusPython_func(func)
1402
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1403
method_return = mock_dbus_python.ObjectPath("objectpath")
1404
ret = self.call_method(bus, "methodname", "busname",
1405
"objectpath", "interface")
1406
self.assertEqual("objectpath", ret)
1407
self.assertIsNot("objectpath", ret)
1408
self.assertNotIsInstance(ret, mock_dbus_python.ObjectPath)
1410
def test_call_method_filters_booleans_in_dict(self):
1412
return method_return
1413
mock_dbus_python = self.MockDBusPython_func(func)
1414
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1415
method_return = mock_dbus_python.Dictionary(
1416
{mock_dbus_python.Boolean(True):
1417
mock_dbus_python.Boolean(False),
1418
mock_dbus_python.Boolean(False):
1419
mock_dbus_python.Boolean(True)})
1420
ret = self.call_method(bus, "methodname", "busname",
1421
"objectpath", "interface")
1422
expected_method_return = {True: False,
1424
self.assertEqual(expected_method_return, ret)
1425
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1427
def test_call_method_filters_objectpaths_in_dict(self):
1429
return method_return
1430
mock_dbus_python = self.MockDBusPython_func(func)
1431
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1432
method_return = mock_dbus_python.Dictionary(
1433
{mock_dbus_python.ObjectPath("objectpath_key_1"):
1434
mock_dbus_python.ObjectPath("objectpath_value_1"),
1435
mock_dbus_python.ObjectPath("objectpath_key_2"):
1436
mock_dbus_python.ObjectPath("objectpath_value_2")})
1437
ret = self.call_method(bus, "methodname", "busname",
1438
"objectpath", "interface")
1439
expected_method_return = {str(key): str(value)
1441
method_return.items()}
1442
self.assertEqual(expected_method_return, ret)
1443
self.assertIsInstance(ret, dict)
1444
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1446
def test_call_method_filters_dict_in_dict(self):
1448
return method_return
1449
mock_dbus_python = self.MockDBusPython_func(func)
1450
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1451
method_return = mock_dbus_python.Dictionary(
1452
{"key1": mock_dbus_python.Dictionary({"key11": "value11",
1453
"key12": "value12"}),
1454
"key2": mock_dbus_python.Dictionary({"key21": "value21",
1455
"key22": "value22"})})
1456
ret = self.call_method(bus, "methodname", "busname",
1457
"objectpath", "interface")
1458
expected_method_return = {
1459
"key1": {"key11": "value11",
1460
"key12": "value12"},
1461
"key2": {"key21": "value21",
1462
"key22": "value22"},
1464
self.assertEqual(expected_method_return, ret)
1465
self.assertIsInstance(ret, dict)
1466
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1467
for key, value in ret.items():
1468
self.assertIsInstance(value, dict)
1469
self.assertEqual(expected_method_return[key], value)
1470
self.assertNotIsInstance(value,
1471
mock_dbus_python.Dictionary)
1473
def test_call_method_filters_dict_three_deep(self):
1475
return method_return
1476
mock_dbus_python = self.MockDBusPython_func(func)
1477
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1478
method_return = mock_dbus_python.Dictionary(
1480
mock_dbus_python.Dictionary(
1482
mock_dbus_python.Dictionary(
1484
mock_dbus_python.Boolean(True),
1488
ret = self.call_method(bus, "methodname", "busname",
1489
"objectpath", "interface")
1490
expected_method_return = {"key1": {"key2": {"key3": True}}}
1491
self.assertEqual(expected_method_return, ret)
1492
self.assertIsInstance(ret, dict)
1493
self.assertNotIsInstance(ret, mock_dbus_python.Dictionary)
1494
self.assertIsInstance(ret["key1"], dict)
1495
self.assertNotIsInstance(ret["key1"],
1496
mock_dbus_python.Dictionary)
1497
self.assertIsInstance(ret["key1"]["key2"], dict)
1498
self.assertNotIsInstance(ret["key1"]["key2"],
1499
mock_dbus_python.Dictionary)
1500
self.assertTrue(ret["key1"]["key2"]["key3"])
1501
self.assertNotIsInstance(ret["key1"]["key2"]["key3"],
1502
mock_dbus_python.Boolean)
1504
def test_call_method_handles_exception(self):
1505
dbus_logger = logging.getLogger("dbus.proxies")
1508
dbus_logger.error("Test")
1509
raise mock_dbus_python.exceptions.DBusException()
1511
mock_dbus_python = self.MockDBusPython_func(func)
1512
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1514
class CountingHandler(logging.Handler):
1516
def emit(self, record):
1519
counting_handler = CountingHandler()
1521
dbus_logger.addHandler(counting_handler)
1524
with self.assertRaises(dbus.Error) as e:
1525
self.call_method(bus, "methodname", "busname",
1526
"objectpath", "interface")
1528
dbus_logger.removeFilter(counting_handler)
1530
self.assertNotIsInstance(e, dbus.ConnectFailed)
1532
# Make sure the dbus logger was suppressed
1533
self.assertEqual(0, counting_handler.count)
1535
def test_Set_Secret_sends_bytearray(self):
1537
def func(*args, **kwargs):
1538
ret[0] = (args, kwargs)
1539
mock_dbus_python = self.MockDBusPython_func(func)
1540
bus = dbus_python_adapter.SystemBus(mock_dbus_python)
1541
bus.set_client_property("objectpath", "Secret", "value")
1542
expected_call = (("se.recompile.Mandos.Client", "Secret",
1543
mock_dbus_python.ByteArray(b"value")),
1545
"org.freedesktop.DBus.Properties"})
1546
self.assertEqual(expected_call, ret[0])
1547
if sys.version_info.major == 2:
1548
self.assertIsInstance(ret[0][0][-1],
1549
mock_dbus_python.ByteArray)
1551
def test_get_object_converts_to_correct_exception(self):
1552
bus = dbus_python_adapter.SystemBus(
1553
self.fake_dbus_python_raises_exception_on_connect)
1554
with self.assertRaises(dbus.ConnectFailed):
1555
self.call_method(bus, "methodname", "busname",
1556
"objectpath", "interface")
1558
class fake_dbus_python_raises_exception_on_connect(object):
1559
"""fake dbus-python module"""
1560
class exceptions(object):
1561
"""Pseudo-namespace"""
1562
class DBusException(Exception):
1567
def get_object(busname, objectpath):
1568
raise cls.exceptions.DBusException()
1569
Bus = collections.namedtuple("Bus", ["get_object"])
1570
return Bus(get_object=get_object)
1573
class Test_dbus_python_adapter_CachingBus(unittest.TestCase):
1574
class mock_dbus_python(object):
1575
"""mock dbus-python modules"""
1576
class SystemBus(object):
1578
def get_object(busname, objectpath):
1582
self.bus = dbus_python_adapter.CachingBus(
1583
self.mock_dbus_python)
1585
def test_returns_distinct_objectpaths(self):
1586
obj1 = self.bus.get_object("busname", "objectpath1")
1587
self.assertIsInstance(obj1, Unique)
1588
obj2 = self.bus.get_object("busname", "objectpath2")
1589
self.assertIsInstance(obj2, Unique)
1590
self.assertIsNot(obj1, obj2)
1592
def test_returns_distinct_busnames(self):
1593
obj1 = self.bus.get_object("busname1", "objectpath")
1594
self.assertIsInstance(obj1, Unique)
1595
obj2 = self.bus.get_object("busname2", "objectpath")
1596
self.assertIsInstance(obj2, Unique)
1597
self.assertIsNot(obj1, obj2)
1599
def test_returns_distinct_both(self):
1600
obj1 = self.bus.get_object("busname1", "objectpath")
1601
self.assertIsInstance(obj1, Unique)
1602
obj2 = self.bus.get_object("busname2", "objectpath")
1603
self.assertIsInstance(obj2, Unique)
1604
self.assertIsNot(obj1, obj2)
1606
def test_returns_same(self):
1607
obj1 = self.bus.get_object("busname", "objectpath")
1608
self.assertIsInstance(obj1, Unique)
1609
obj2 = self.bus.get_object("busname", "objectpath")
1610
self.assertIsInstance(obj2, Unique)
1611
self.assertIs(obj1, obj2)
1613
def test_returns_same_old(self):
1614
obj1 = self.bus.get_object("busname1", "objectpath1")
1615
self.assertIsInstance(obj1, Unique)
1616
obj2 = self.bus.get_object("busname2", "objectpath2")
1617
self.assertIsInstance(obj2, Unique)
1618
obj1b = self.bus.get_object("busname1", "objectpath1")
1619
self.assertIsInstance(obj1b, Unique)
1620
self.assertIsNot(obj1, obj2)
1621
self.assertIsNot(obj2, obj1b)
1622
self.assertIs(obj1, obj1b)
1625
class Test_pydbus_adapter_SystemBus(TestCaseWithAssertLogs):
1627
def Stub_pydbus_func(self, func):
1628
class stub_pydbus(object):
1629
"""stub pydbus module"""
1630
class SystemBus(object):
1632
def get(busname, objectpath):
1633
DBusObject = collections.namedtuple(
1634
"DBusObject", ("methodname",))
1635
return {"interface":
1636
DBusObject(methodname=func)}
1639
def call_method(self, bus, methodname, busname, objectpath,
1641
with self.assertLogs(log, logging.DEBUG):
1642
return bus.call_method(methodname, busname, objectpath,
1645
def test_call_method_returns(self):
1646
expected_method_return = Unique()
1647
method_args = (Unique(), Unique())
1649
self.assertEqual(len(method_args), len(args))
1650
for marg, arg in zip(method_args, args):
1651
self.assertIs(marg, arg)
1652
return expected_method_return
1653
stub_pydbus = self.Stub_pydbus_func(func)
1654
bus = pydbus_adapter.SystemBus(stub_pydbus)
1655
ret = self.call_method(bus, "methodname", "busname",
1656
"objectpath", "interface",
1658
self.assertIs(ret, expected_method_return)
1660
def test_call_method_handles_exception(self):
1661
dbus_logger = logging.getLogger("dbus.proxies")
1664
raise gi.repository.GLib.Error()
1666
stub_pydbus = self.Stub_pydbus_func(func)
1667
bus = pydbus_adapter.SystemBus(stub_pydbus)
1669
with self.assertRaises(dbus.Error) as e:
1670
self.call_method(bus, "methodname", "busname",
1671
"objectpath", "interface")
1673
self.assertNotIsInstance(e, dbus.ConnectFailed)
1675
def test_get_converts_to_correct_exception(self):
1676
bus = pydbus_adapter.SystemBus(
1677
self.fake_pydbus_raises_exception_on_connect)
1678
with self.assertRaises(dbus.ConnectFailed):
1679
self.call_method(bus, "methodname", "busname",
1680
"objectpath", "interface")
1682
class fake_pydbus_raises_exception_on_connect(object):
1683
"""fake dbus-python module"""
1686
def get(busname, objectpath):
1687
raise gi.repository.GLib.Error()
1688
Bus = collections.namedtuple("Bus", ["get"])
1691
def test_set_property_uses_setattr(self):
1692
class Object(object):
1695
class pydbus_spy(object):
1696
class SystemBus(object):
1698
def get(busname, objectpath):
1699
return {"interface": obj}
1700
bus = pydbus_adapter.SystemBus(pydbus_spy)
1702
bus.set_property("busname", "objectpath", "interface", "key",
1704
self.assertIs(value, obj.key)
1706
def test_get_suppresses_xml_deprecation_warning(self):
1707
if sys.version_info.major >= 3:
1709
class stub_pydbus_get(object):
1710
class SystemBus(object):
1712
def get(busname, objectpath):
1713
warnings.warn_explicit(
1714
"deprecated", DeprecationWarning,
1715
"xml.etree.ElementTree", 0)
1716
bus = pydbus_adapter.SystemBus(stub_pydbus_get)
1717
with warnings.catch_warnings(record=True) as w:
1718
warnings.simplefilter("always")
1719
bus.get("busname", "objectpath")
1720
self.assertEqual(0, len(w))
1723
class Test_pydbus_adapter_CachingBus(unittest.TestCase):
1724
class stub_pydbus(object):
1725
"""stub pydbus module"""
1726
class SystemBus(object):
1728
def get(busname, objectpath):
1732
self.bus = pydbus_adapter.CachingBus(self.stub_pydbus)
1734
def test_returns_distinct_objectpaths(self):
1735
obj1 = self.bus.get("busname", "objectpath1")
1736
self.assertIsInstance(obj1, Unique)
1737
obj2 = self.bus.get("busname", "objectpath2")
1738
self.assertIsInstance(obj2, Unique)
1739
self.assertIsNot(obj1, obj2)
1741
def test_returns_distinct_busnames(self):
1742
obj1 = self.bus.get("busname1", "objectpath")
1743
self.assertIsInstance(obj1, Unique)
1744
obj2 = self.bus.get("busname2", "objectpath")
1745
self.assertIsInstance(obj2, Unique)
1746
self.assertIsNot(obj1, obj2)
1748
def test_returns_distinct_both(self):
1749
obj1 = self.bus.get("busname1", "objectpath")
1750
self.assertIsInstance(obj1, Unique)
1751
obj2 = self.bus.get("busname2", "objectpath")
1752
self.assertIsInstance(obj2, Unique)
1753
self.assertIsNot(obj1, obj2)
1755
def test_returns_same(self):
1756
obj1 = self.bus.get("busname", "objectpath")
1757
self.assertIsInstance(obj1, Unique)
1758
obj2 = self.bus.get("busname", "objectpath")
1759
self.assertIsInstance(obj2, Unique)
1760
self.assertIs(obj1, obj2)
1762
def test_returns_same_old(self):
1763
obj1 = self.bus.get("busname1", "objectpath1")
1764
self.assertIsInstance(obj1, Unique)
1765
obj2 = self.bus.get("busname2", "objectpath2")
1766
self.assertIsInstance(obj2, Unique)
1767
obj1b = self.bus.get("busname1", "objectpath1")
1768
self.assertIsInstance(obj1b, Unique)
1769
self.assertIsNot(obj1, obj2)
1770
self.assertIsNot(obj2, obj1b)
1771
self.assertIs(obj1, obj1b)
971
self.check_option_syntax(options)
1774
974
class Test_commands_from_options(unittest.TestCase):
1776
975
def setUp(self):
1777
976
self.parser = argparse.ArgumentParser()
1778
977
add_command_line_options(self.parser)
1780
979
def test_is_enabled(self):
1781
self.assert_command_from_args(["--is-enabled", "client"],
980
self.assert_command_from_args(["--is-enabled", "foo"],
1784
def assert_command_from_args(self, args, command_cls, length=1,
1785
clients=None, **cmd_attrs):
983
def assert_command_from_args(self, args, command_cls,
1786
985
"""Assert that parsing ARGS should result in an instance of
1787
986
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
1788
987
options = self.parser.parse_args(args)
1789
988
check_option_syntax(self.parser, options)
1790
989
commands = commands_from_options(options)
1791
self.assertEqual(length, len(commands))
1792
for command in commands:
1793
if isinstance(command, command_cls):
1796
self.assertIsInstance(command, command_cls)
1797
if clients is not None:
1798
self.assertEqual(clients, options.client)
990
self.assertEqual(len(commands), 1)
991
command = commands[0]
992
self.assertIsInstance(command, command_cls)
1799
993
for key, value in cmd_attrs.items():
1800
self.assertEqual(value, getattr(command, key))
1802
def assert_commands_from_args(self, args, commands, clients=None):
1803
for cmd in commands:
1804
self.assert_command_from_args(args, cmd,
1805
length=len(commands),
994
self.assertEqual(getattr(command, key), value)
1808
996
def test_is_enabled_short(self):
1809
self.assert_command_from_args(["-V", "client"],
997
self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
1812
999
def test_approve(self):
1813
self.assert_command_from_args(["--approve", "client"],
1000
self.assert_command_from_args(["--approve", "foo"],
1816
1003
def test_approve_short(self):
1817
self.assert_command_from_args(["-A", "client"],
1004
self.assert_command_from_args(["-A", "foo"], ApproveCmd)
1820
1006
def test_deny(self):
1821
self.assert_command_from_args(["--deny", "client"],
1007
self.assert_command_from_args(["--deny", "foo"], DenyCmd)
1824
1009
def test_deny_short(self):
1825
self.assert_command_from_args(["-D", "client"], command.Deny)
1010
self.assert_command_from_args(["-D", "foo"], DenyCmd)
1827
1012
def test_remove(self):
1828
self.assert_command_from_args(["--remove", "client"],
1013
self.assert_command_from_args(["--remove", "foo"],
1831
1016
def test_deny_before_remove(self):
1832
1017
options = self.parser.parse_args(["--deny", "--remove",
1834
1019
check_option_syntax(self.parser, options)
1835
1020
commands = commands_from_options(options)
1836
self.assertEqual(2, len(commands))
1837
self.assertIsInstance(commands[0], command.Deny)
1838
self.assertIsInstance(commands[1], command.Remove)
1021
self.assertEqual(len(commands), 2)
1022
self.assertIsInstance(commands[0], DenyCmd)
1023
self.assertIsInstance(commands[1], RemoveCmd)
1840
1025
def test_deny_before_remove_reversed(self):
1841
1026
options = self.parser.parse_args(["--remove", "--deny",
1843
1028
check_option_syntax(self.parser, options)
1844
1029
commands = commands_from_options(options)
1845
self.assertEqual(2, len(commands))
1846
self.assertIsInstance(commands[0], command.Deny)
1847
self.assertIsInstance(commands[1], command.Remove)
1030
self.assertEqual(len(commands), 2)
1031
self.assertIsInstance(commands[0], DenyCmd)
1032
self.assertIsInstance(commands[1], RemoveCmd)
1849
1034
def test_remove_short(self):
1850
self.assert_command_from_args(["-r", "client"],
1035
self.assert_command_from_args(["-r", "foo"], RemoveCmd)
1853
1037
def test_dump_json(self):
1854
self.assert_command_from_args(["--dump-json"],
1038
self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
1857
1040
def test_enable(self):
1858
self.assert_command_from_args(["--enable", "client"],
1041
self.assert_command_from_args(["--enable", "foo"], EnableCmd)
1861
1043
def test_enable_short(self):
1862
self.assert_command_from_args(["-e", "client"],
1044
self.assert_command_from_args(["-e", "foo"], EnableCmd)
1865
1046
def test_disable(self):
1866
self.assert_command_from_args(["--disable", "client"],
1047
self.assert_command_from_args(["--disable", "foo"],
1869
1050
def test_disable_short(self):
1870
self.assert_command_from_args(["-d", "client"],
1051
self.assert_command_from_args(["-d", "foo"], DisableCmd)
1873
1053
def test_bump_timeout(self):
1874
self.assert_command_from_args(["--bump-timeout", "client"],
1875
command.BumpTimeout)
1054
self.assert_command_from_args(["--bump-timeout", "foo"],
1877
1057
def test_bump_timeout_short(self):
1878
self.assert_command_from_args(["-b", "client"],
1879
command.BumpTimeout)
1058
self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
1881
1060
def test_start_checker(self):
1882
self.assert_command_from_args(["--start-checker", "client"],
1883
command.StartChecker)
1061
self.assert_command_from_args(["--start-checker", "foo"],
1885
1064
def test_stop_checker(self):
1886
self.assert_command_from_args(["--stop-checker", "client"],
1887
command.StopChecker)
1065
self.assert_command_from_args(["--stop-checker", "foo"],
1889
1068
def test_approve_by_default(self):
1890
self.assert_command_from_args(["--approve-by-default",
1892
command.ApproveByDefault)
1069
self.assert_command_from_args(["--approve-by-default", "foo"],
1070
ApproveByDefaultCmd)
1894
1072
def test_deny_by_default(self):
1895
self.assert_command_from_args(["--deny-by-default", "client"],
1896
command.DenyByDefault)
1073
self.assert_command_from_args(["--deny-by-default", "foo"],
1898
1076
def test_checker(self):
1899
self.assert_command_from_args(["--checker", ":", "client"],
1077
self.assert_command_from_args(["--checker", ":", "foo"],
1078
SetCheckerCmd, value_to_set=":")
1903
1080
def test_checker_empty(self):
1904
self.assert_command_from_args(["--checker", "", "client"],
1081
self.assert_command_from_args(["--checker", "", "foo"],
1082
SetCheckerCmd, value_to_set="")
1908
1084
def test_checker_short(self):
1909
self.assert_command_from_args(["-c", ":", "client"],
1085
self.assert_command_from_args(["-c", ":", "foo"],
1086
SetCheckerCmd, value_to_set=":")
1913
1088
def test_host(self):
1914
self.assert_command_from_args(
1915
["--host", "client.example.org", "client"],
1916
command.SetHost, value_to_set="client.example.org")
1089
self.assert_command_from_args(["--host", "foo.example.org",
1091
value_to_set="foo.example.org")
1918
1093
def test_host_short(self):
1919
self.assert_command_from_args(
1920
["-H", "client.example.org", "client"], command.SetHost,
1921
value_to_set="client.example.org")
1094
self.assert_command_from_args(["-H", "foo.example.org",
1096
value_to_set="foo.example.org")
1923
1098
def test_secret_devnull(self):
1924
1099
self.assert_command_from_args(["--secret", os.path.devnull,
1925
"client"], command.SetSecret,
1100
"foo"], SetSecretCmd,
1926
1101
value_to_set=b"")
1928
1103
def test_secret_tempfile(self):
1933
1108
self.assert_command_from_args(["--secret", f.name,
1109
"foo"], SetSecretCmd,
1936
1110
value_to_set=value)
1938
1112
def test_secret_devnull_short(self):
1939
self.assert_command_from_args(["-s", os.path.devnull,
1940
"client"], command.SetSecret,
1113
self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1114
SetSecretCmd, value_to_set=b"")
1943
1116
def test_secret_tempfile_short(self):
1944
1117
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1945
1118
value = b"secret\0xyzzy\nbar"
1948
self.assert_command_from_args(["-s", f.name, "client"],
1121
self.assert_command_from_args(["-s", f.name, "foo"],
1950
1123
value_to_set=value)
1952
1125
def test_timeout(self):
1953
self.assert_command_from_args(["--timeout", "PT5M", "client"],
1126
self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1955
1128
value_to_set=300000)
1957
1130
def test_timeout_short(self):
1958
self.assert_command_from_args(["-t", "PT5M", "client"],
1131
self.assert_command_from_args(["-t", "PT5M", "foo"],
1960
1133
value_to_set=300000)
1962
1135
def test_extended_timeout(self):
1963
1136
self.assert_command_from_args(["--extended-timeout", "PT15M",
1965
command.SetExtendedTimeout,
1138
SetExtendedTimeoutCmd,
1966
1139
value_to_set=900000)
1968
1141
def test_interval(self):
1969
self.assert_command_from_args(["--interval", "PT2M",
1970
"client"], command.SetInterval,
1142
self.assert_command_from_args(["--interval", "PT2M", "foo"],
1971
1144
value_to_set=120000)
1973
1146
def test_interval_short(self):
1974
self.assert_command_from_args(["-i", "PT2M", "client"],
1975
command.SetInterval,
1147
self.assert_command_from_args(["-i", "PT2M", "foo"],
1976
1149
value_to_set=120000)
1978
1151
def test_approval_delay(self):
1979
1152
self.assert_command_from_args(["--approval-delay", "PT30S",
1981
command.SetApprovalDelay,
1153
"foo"], SetApprovalDelayCmd,
1982
1154
value_to_set=30000)
1984
1156
def test_approval_duration(self):
1985
1157
self.assert_command_from_args(["--approval-duration", "PT1S",
1987
command.SetApprovalDuration,
1158
"foo"], SetApprovalDurationCmd,
1988
1159
value_to_set=1000)
1990
1161
def test_print_table(self):
1991
self.assert_command_from_args([], command.PrintTable,
1162
self.assert_command_from_args([], PrintTableCmd,
1994
1165
def test_print_table_verbose(self):
1995
self.assert_command_from_args(["--verbose"],
1166
self.assert_command_from_args(["--verbose"], PrintTableCmd,
1999
1169
def test_print_table_verbose_short(self):
2000
self.assert_command_from_args(["-v"], command.PrintTable,
1170
self.assert_command_from_args(["-v"], PrintTableCmd,
2004
def test_manual_page_example_1(self):
2005
self.assert_command_from_args("",
2010
def test_manual_page_example_2(self):
2011
self.assert_command_from_args(
2012
"--verbose foo1.example.org foo2.example.org".split(),
2013
command.PrintTable, clients=["foo1.example.org",
2014
"foo2.example.org"],
2017
def test_manual_page_example_3(self):
2018
self.assert_command_from_args("--enable --all".split(),
2022
def test_manual_page_example_4(self):
2023
self.assert_commands_from_args(
2024
("--timeout=PT5M --interval=PT1M foo1.example.org"
2025
" foo2.example.org").split(),
2026
[command.SetTimeout, command.SetInterval],
2027
clients=["foo1.example.org", "foo2.example.org"])
2029
def test_manual_page_example_5(self):
2030
self.assert_command_from_args("--approve --all".split(),
2035
class TestCommand(unittest.TestCase):
1174
class TestCmd(unittest.TestCase):
2036
1175
"""Abstract class for tests of command classes"""
2038
class FakeMandosBus(dbus.MandosBus):
2039
def __init__(self, testcase):
2040
self.client_properties = {
1178
class MockClient(object):
1179
def __init__(self, name, **attributes):
1180
self.__dbus_object_path__ = "/clients/{}".format(name)
1181
self.attributes = attributes
1182
self.attributes["Name"] = name
1184
def Set(self, interface, propname, value, dbus_interface):
1185
testcase.assertEqual(interface, client_dbus_interface)
1186
testcase.assertEqual(dbus_interface,
1187
dbus.PROPERTIES_IFACE)
1188
self.attributes[propname] = value
1189
def Get(self, interface, propname, dbus_interface):
1190
testcase.assertEqual(interface, client_dbus_interface)
1191
testcase.assertEqual(dbus_interface,
1192
dbus.PROPERTIES_IFACE)
1193
return self.attributes[propname]
1194
def Approve(self, approve, dbus_interface):
1195
testcase.assertEqual(dbus_interface,
1196
client_dbus_interface)
1197
self.calls.append(("Approve", (approve,
1199
self.client = MockClient(
1201
KeyID=("92ed150794387c03ce684574b1139a65"
1202
"94a34f895daaaf09fd8ea90a27cddb12"),
1204
Host="foo.example.org",
1205
Enabled=dbus.Boolean(True),
1207
LastCheckedOK="2019-02-03T00:00:00",
1208
Created="2019-01-02T00:00:00",
1210
Fingerprint=("778827225BA7DE539C5A"
1211
"7CFA59CFF7CDBD9A5920"),
1212
CheckerRunning=dbus.Boolean(False),
1213
LastEnabled="2019-01-03T00:00:00",
1214
ApprovalPending=dbus.Boolean(False),
1215
ApprovedByDefault=dbus.Boolean(True),
1216
LastApprovalRequest="",
1218
ApprovalDuration=1000,
1219
Checker="fping -q -- %(host)s",
1220
ExtendedTimeout=900000,
1221
Expires="2019-02-04T00:00:00",
1222
LastCheckerStatus=0)
1223
self.other_client = MockClient(
1225
KeyID=("0558568eedd67d622f5c83b35a115f79"
1226
"6ab612cff5ad227247e46c2b020f441c"),
1227
Secret=b"secretbar",
1229
Enabled=dbus.Boolean(True),
1231
LastCheckedOK="2019-02-04T00:00:00",
1232
Created="2019-01-03T00:00:00",
1234
Fingerprint=("3E393AEAEFB84C7E89E2"
1235
"F547B3A107558FCA3A27"),
1236
CheckerRunning=dbus.Boolean(True),
1237
LastEnabled="2019-01-04T00:00:00",
1238
ApprovalPending=dbus.Boolean(False),
1239
ApprovedByDefault=dbus.Boolean(False),
1240
LastApprovalRequest="2019-01-03T00:00:00",
1241
ApprovalDelay=30000,
1242
ApprovalDuration=93785000,
1244
ExtendedTimeout=900000,
1245
Expires="2019-02-05T00:00:00",
1246
LastCheckerStatus=-2)
1247
self.clients = collections.OrderedDict(
1249
("/clients/foo", self.client.attributes),
1250
("/clients/barbar", self.other_client.attributes),
1252
self.one_client = {"/clients/foo": self.client.attributes}
1257
def get_object(client_bus_name, path):
1258
self.assertEqual(client_bus_name, dbus_busname)
1260
"/clients/foo": self.client,
1261
"/clients/barbar": self.other_client,
1266
class TestIsEnabledCmd(TestCmd):
1267
def test_is_enabled(self):
1268
self.assertTrue(all(IsEnabledCmd().is_enabled(client,
1270
for client, properties
1271
in self.clients.items()))
1272
def test_is_enabled_run_exits_successfully(self):
1273
with self.assertRaises(SystemExit) as e:
1274
IsEnabledCmd().run(self.one_client)
1275
if e.exception.code is not None:
1276
self.assertEqual(e.exception.code, 0)
1278
self.assertIsNone(e.exception.code)
1279
def test_is_enabled_run_exits_with_failure(self):
1280
self.client.attributes["Enabled"] = dbus.Boolean(False)
1281
with self.assertRaises(SystemExit) as e:
1282
IsEnabledCmd().run(self.one_client)
1283
if isinstance(e.exception.code, int):
1284
self.assertNotEqual(e.exception.code, 0)
1286
self.assertIsNotNone(e.exception.code)
1289
class TestApproveCmd(TestCmd):
1290
def test_approve(self):
1291
ApproveCmd().run(self.clients, self.bus)
1292
for clientpath in self.clients:
1293
client = self.bus.get_object(dbus_busname, clientpath)
1294
self.assertIn(("Approve", (True, client_dbus_interface)),
1298
class TestDenyCmd(TestCmd):
1299
def test_deny(self):
1300
DenyCmd().run(self.clients, self.bus)
1301
for clientpath in self.clients:
1302
client = self.bus.get_object(dbus_busname, clientpath)
1303
self.assertIn(("Approve", (False, client_dbus_interface)),
1306
class TestRemoveCmd(TestCmd):
1307
def test_remove(self):
1308
class MockMandos(object):
1311
def RemoveClient(self, dbus_path):
1312
self.calls.append(("RemoveClient", (dbus_path,)))
1313
mandos = MockMandos()
1314
super(TestRemoveCmd, self).setUp()
1315
RemoveCmd().run(self.clients, self.bus, mandos)
1316
self.assertEqual(len(mandos.calls), 2)
1317
for clientpath in self.clients:
1318
self.assertIn(("RemoveClient", (clientpath,)),
1322
class TestDumpJSONCmd(TestCmd):
1324
self.expected_json = {
2042
1327
"KeyID": ("92ed150794387c03ce684574b1139a65"
2043
1328
"94a34f895daaaf09fd8ea90a27cddb12"),
2044
"Secret": b"secret",
2045
1329
"Host": "foo.example.org",
2046
1330
"Enabled": True,
2047
1331
"Timeout": 300000,
2347
1483
num_lines = max(len(rows) for rows in columns)
2348
expected_output = ("\n".join("".join(rows[line]
2349
for rows in columns)
2350
for line in range(num_lines))
2352
self.assertEqual(expected_output, buffer.getvalue())
2354
def test_PrintTable_one_client(self):
2355
with self.capture_stdout_to_buffer() as buffer:
2356
command.PrintTable().run(self.bus.one_client)
1484
expected_output = "\n".join("".join(rows[line]
1485
for rows in columns)
1486
for line in range(num_lines))
1487
self.assertEqual(output, expected_output)
1488
def test_one_client(self):
1489
output = PrintTableCmd().output(self.one_client.values())
2357
1490
expected_output = "\n".join((
2358
1491
"Name Enabled Timeout Last Successful Check",
2359
1492
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
2361
self.assertEqual(expected_output, buffer.getvalue())
2364
class TestPropertySetterCmd(TestCommand):
2365
"""Abstract class for tests of command.PropertySetter classes"""
1494
self.assertEqual(output, expected_output)
1497
class Unique(object):
1498
"""Class for objects which exist only to be unique objects, since
1499
unittest.mock.sentinel only exists in Python 3.3"""
1502
class TestPropertyCmd(TestCmd):
1503
"""Abstract class for tests of PropertyCmd classes"""
2367
1504
def runTest(self):
2368
1505
if not hasattr(self, "command"):
2369
return # Abstract TestCase class
2371
if hasattr(self, "values_to_set"):
2372
cmd_args = [(value,) for value in self.values_to_set]
2373
values_to_get = getattr(self, "values_to_get",
2376
cmd_args = [() for x in range(len(self.values_to_get))]
2377
values_to_get = self.values_to_get
2378
for value_to_get, cmd_arg in zip(values_to_get, cmd_args):
2379
for clientpath in self.bus.clients:
2380
self.bus.clients[clientpath][self.propname] = (
2382
self.command(*cmd_arg).run(self.bus.clients, self.bus)
2383
for clientpath in self.bus.clients:
2384
value = (self.bus.clients[clientpath]
1507
values_to_get = getattr(self, "values_to_get",
1509
for value_to_set, value_to_get in zip(self.values_to_set,
1511
for clientpath in self.clients:
1512
client = self.bus.get_object(dbus_busname, clientpath)
1513
old_value = client.attributes[self.propname]
1514
self.assertNotIsInstance(old_value, Unique)
1515
client.attributes[self.propname] = Unique()
1516
self.run_command(value_to_set, self.clients)
1517
for clientpath in self.clients:
1518
client = self.bus.get_object(dbus_busname, clientpath)
1519
value = client.attributes[self.propname]
2386
1520
self.assertNotIsInstance(value, Unique)
2387
self.assertEqual(value_to_get, value)
2390
class TestEnableCmd(TestPropertySetterCmd):
2391
command = command.Enable
2392
propname = "Enabled"
2393
values_to_get = [True]
2396
class TestDisableCmd(TestPropertySetterCmd):
2397
command = command.Disable
2398
propname = "Enabled"
2399
values_to_get = [False]
2402
class TestBumpTimeoutCmd(TestPropertySetterCmd):
2403
command = command.BumpTimeout
1521
self.assertEqual(value, value_to_get)
1522
def run_command(self, value, clients):
1523
self.command().run(clients, self.bus)
1526
class TestEnableCmd(TestPropertyCmd):
1528
propname = "Enabled"
1529
values_to_set = [dbus.Boolean(True)]
1532
class TestDisableCmd(TestPropertyCmd):
1533
command = DisableCmd
1534
propname = "Enabled"
1535
values_to_set = [dbus.Boolean(False)]
1538
class TestBumpTimeoutCmd(TestPropertyCmd):
1539
command = BumpTimeoutCmd
2404
1540
propname = "LastCheckedOK"
2405
values_to_get = [""]
2408
class TestStartCheckerCmd(TestPropertySetterCmd):
2409
command = command.StartChecker
2410
propname = "CheckerRunning"
2411
values_to_get = [True]
2414
class TestStopCheckerCmd(TestPropertySetterCmd):
2415
command = command.StopChecker
2416
propname = "CheckerRunning"
2417
values_to_get = [False]
2420
class TestApproveByDefaultCmd(TestPropertySetterCmd):
2421
command = command.ApproveByDefault
2422
propname = "ApprovedByDefault"
2423
values_to_get = [True]
2426
class TestDenyByDefaultCmd(TestPropertySetterCmd):
2427
command = command.DenyByDefault
2428
propname = "ApprovedByDefault"
2429
values_to_get = [False]
2432
class TestSetCheckerCmd(TestPropertySetterCmd):
2433
command = command.SetChecker
1541
values_to_set = [""]
1544
class TestStartCheckerCmd(TestPropertyCmd):
1545
command = StartCheckerCmd
1546
propname = "CheckerRunning"
1547
values_to_set = [dbus.Boolean(True)]
1550
class TestStopCheckerCmd(TestPropertyCmd):
1551
command = StopCheckerCmd
1552
propname = "CheckerRunning"
1553
values_to_set = [dbus.Boolean(False)]
1556
class TestApproveByDefaultCmd(TestPropertyCmd):
1557
command = ApproveByDefaultCmd
1558
propname = "ApprovedByDefault"
1559
values_to_set = [dbus.Boolean(True)]
1562
class TestDenyByDefaultCmd(TestPropertyCmd):
1563
command = DenyByDefaultCmd
1564
propname = "ApprovedByDefault"
1565
values_to_set = [dbus.Boolean(False)]
1568
class TestPropertyValueCmd(TestPropertyCmd):
1569
"""Abstract class for tests of PropertyValueCmd classes"""
1571
if type(self) is TestPropertyValueCmd:
1573
return super(TestPropertyValueCmd, self).runTest()
1574
def run_command(self, value, clients):
1575
self.command(value).run(clients, self.bus)
1578
class TestSetCheckerCmd(TestPropertyValueCmd):
1579
command = SetCheckerCmd
2434
1580
propname = "Checker"
2435
1581
values_to_set = ["", ":", "fping -q -- %s"]
2438
class TestSetHostCmd(TestPropertySetterCmd):
2439
command = command.SetHost
1584
class TestSetHostCmd(TestPropertyValueCmd):
1585
command = SetHostCmd
2440
1586
propname = "Host"
2441
values_to_set = ["192.0.2.3", "client.example.org"]
2444
class TestSetSecretCmd(TestPropertySetterCmd):
2445
command = command.SetSecret
1587
values_to_set = ["192.0.2.3", "foo.example.org"]
1590
class TestSetSecretCmd(TestPropertyValueCmd):
1591
command = SetSecretCmd
2446
1592
propname = "Secret"
2447
1593
values_to_set = [io.BytesIO(b""),
2448
1594
io.BytesIO(b"secret\0xyzzy\nbar")]
2449
values_to_get = [f.getvalue() for f in values_to_set]
2452
class TestSetTimeoutCmd(TestPropertySetterCmd):
2453
command = command.SetTimeout
1595
values_to_get = [b"", b"secret\0xyzzy\nbar"]
1598
class TestSetTimeoutCmd(TestPropertyValueCmd):
1599
command = SetTimeoutCmd
2454
1600
propname = "Timeout"
2455
1601
values_to_set = [datetime.timedelta(),
2456
1602
datetime.timedelta(minutes=5),
2457
1603
datetime.timedelta(seconds=1),
2458
1604
datetime.timedelta(weeks=1),
2459
1605
datetime.timedelta(weeks=52)]
2460
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2463
class TestSetExtendedTimeoutCmd(TestPropertySetterCmd):
2464
command = command.SetExtendedTimeout
1606
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1609
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
1610
command = SetExtendedTimeoutCmd
2465
1611
propname = "ExtendedTimeout"
2466
1612
values_to_set = [datetime.timedelta(),
2467
1613
datetime.timedelta(minutes=5),
2468
1614
datetime.timedelta(seconds=1),
2469
1615
datetime.timedelta(weeks=1),
2470
1616
datetime.timedelta(weeks=52)]
2471
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2474
class TestSetIntervalCmd(TestPropertySetterCmd):
2475
command = command.SetInterval
1617
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1620
class TestSetIntervalCmd(TestPropertyValueCmd):
1621
command = SetIntervalCmd
2476
1622
propname = "Interval"
2477
1623
values_to_set = [datetime.timedelta(),
2478
1624
datetime.timedelta(minutes=5),
2479
1625
datetime.timedelta(seconds=1),
2480
1626
datetime.timedelta(weeks=1),
2481
1627
datetime.timedelta(weeks=52)]
2482
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2485
class TestSetApprovalDelayCmd(TestPropertySetterCmd):
2486
command = command.SetApprovalDelay
1628
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1631
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
1632
command = SetApprovalDelayCmd
2487
1633
propname = "ApprovalDelay"
2488
1634
values_to_set = [datetime.timedelta(),
2489
1635
datetime.timedelta(minutes=5),
2490
1636
datetime.timedelta(seconds=1),
2491
1637
datetime.timedelta(weeks=1),
2492
1638
datetime.timedelta(weeks=52)]
2493
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
2496
class TestSetApprovalDurationCmd(TestPropertySetterCmd):
2497
command = command.SetApprovalDuration
1639
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1642
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
1643
command = SetApprovalDurationCmd
2498
1644
propname = "ApprovalDuration"
2499
1645
values_to_set = [datetime.timedelta(),
2500
1646
datetime.timedelta(minutes=5),
2501
1647
datetime.timedelta(seconds=1),
2502
1648
datetime.timedelta(weeks=1),
2503
1649
datetime.timedelta(weeks=52)]
2504
values_to_get = [dt.total_seconds()*1000 for dt in values_to_set]
1650
values_to_get = [0, 300000, 1000, 604800000, 31449600000]