To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/trunk
« back to all changes in this revision
Viewing changes to mandos-ctl
- browse files at revision 1062
- compare with another revision
- download diff
- download tarball
- view history from revision 1062
- Committer: Teddy Hogeborn
- Date: 2019-03-13 21:38:35 UTC
- Revision ID: teddy@recompile.se-20190313213835-vq9cv3lih2jp3au7
mandos-ctl: Refactor
* mandos-ctl (TestCmd.bus.Bus.get_object): Add explanatory comment
about "self".
(Unique): Move to "TestPropertyCmd.Unique". All callers changed.
* mandos-ctl (TestCmd.bus.Bus.get_object): Add explanatory comment
about "self".
(Unique): Move to "TestPropertyCmd.Unique". All callers changed.
- files modified:
- mandos-ctl
added
removed
mandos-ctl
93
93
if options.debug:
94
94
log.setLevel(logging.DEBUG)
95
95
96
bus = dbus.SystemBus()
97
98
mandos_dbus_object = get_mandos_dbus_object(bus)
99
100
mandos_serv = dbus.Interface(
101
mandos_dbus_object, dbus_interface=server_dbus_interface)
96
try:
97
bus = dbus.SystemBus()
98
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
99
dbus_busname, server_dbus_path)
100
mandos_dbus_objc = bus.get_object(dbus_busname,
101
server_dbus_path)
102
except dbus.exceptions.DBusException:
103
log.critical("Could not connect to Mandos server")
104
sys.exit(1)
105
106
mandos_serv = dbus.Interface(mandos_dbus_objc,
107
dbus_interface=server_dbus_interface)
102
108
mandos_serv_object_manager = dbus.Interface(
103
mandos_dbus_object, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
104
105
managed_objects = get_managed_objects(mandos_serv_object_manager)
106
107
all_clients = {}
108
for path, ifs_and_props in managed_objects.items():
109
try:
110
all_clients[path] = ifs_and_props[client_dbus_interface]
111
except KeyError:
112
pass
113
114
# Compile dict of (clientpath: properties) to process
109
mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
110
111
# Filter out log message from dbus module
112
dbus_logger = logging.getLogger("dbus.proxies")
113
class NullFilter(logging.Filter):
114
def filter(self, record):
115
return False
116
dbus_filter = NullFilter()
117
try:
118
dbus_logger.addFilter(dbus_filter)
119
log.debug("D-Bus: %s:%s:%s.GetManagedObjects()", dbus_busname,
120
server_dbus_path, dbus.OBJECT_MANAGER_IFACE)
121
mandos_clients = {path: ifs_and_props[client_dbus_interface]
122
for path, ifs_and_props in
123
mandos_serv_object_manager
124
.GetManagedObjects().items()
125
if client_dbus_interface in ifs_and_props}
126
except dbus.exceptions.DBusException as e:
127
log.critical("Failed to access Mandos server through D-Bus:"
128
"\n%s", e)
129
sys.exit(1)
130
finally:
131
# restore dbus logger
132
dbus_logger.removeFilter(dbus_filter)
133
134
# Compile dict of (clients: properties) to process
135
clients = {}
136
115
137
if not clientnames:
116
clients = all_clients
138
clients = {objpath: properties
139
for objpath, properties in mandos_clients.items()}
117
140
else:
118
clients = {}
119
141
for name in clientnames:
120
for objpath, properties in all_clients.items():
142
for objpath, properties in mandos_clients.items():
121
143
if properties["Name"] == name:
122
144
clients[objpath] = properties
123
145
break
125
147
log.critical("Client not found on server: %r", name)
126
148
sys.exit(1)
127
149
150
# Run all commands on clients
128
151
commands = commands_from_options(options)
129
130
152
for command in commands:
131
153
command.run(clients, bus, mandos_serv)
132
154
232
254
>>> rfc3339_duration_to_delta("")
233
255
Traceback (most recent call last):
234
256
...
235
ValueError: Invalid RFC 3339 duration: ""
257
ValueError: Invalid RFC 3339 duration: u''
236
258
>>> # Must start with "P":
237
259
>>> rfc3339_duration_to_delta("1D")
238
260
Traceback (most recent call last):
239
261
...
240
ValueError: Invalid RFC 3339 duration: "1D"
262
ValueError: Invalid RFC 3339 duration: u'1D'
241
263
>>> # Must use correct order
242
264
>>> rfc3339_duration_to_delta("PT1S2M")
243
265
Traceback (most recent call last):
244
266
...
245
ValueError: Invalid RFC 3339 duration: "PT1S2M"
267
ValueError: Invalid RFC 3339 duration: u'PT1S2M'
246
268
>>> # Time needs time marker
247
269
>>> rfc3339_duration_to_delta("P1H2S")
248
270
Traceback (most recent call last):
249
271
...
250
ValueError: Invalid RFC 3339 duration: "P1H2S"
272
ValueError: Invalid RFC 3339 duration: u'P1H2S'
251
273
>>> # Weeks can not be combined with anything else
252
274
>>> rfc3339_duration_to_delta("P1D2W")
253
275
Traceback (most recent call last):
254
276
...
255
ValueError: Invalid RFC 3339 duration: "P1D2W"
277
ValueError: Invalid RFC 3339 duration: u'P1D2W'
256
278
>>> rfc3339_duration_to_delta("P2W2H")
257
279
Traceback (most recent call last):
258
280
...
259
ValueError: Invalid RFC 3339 duration: "P2W2H"
281
ValueError: Invalid RFC 3339 duration: u'P2W2H'
260
282
"""
261
283
262
284
# Parsing an RFC 3339 duration with regular expressions is not
333
355
break
334
356
else:
335
357
# No currently valid tokens were found
336
raise ValueError("Invalid RFC 3339 duration: \"{}\""
358
raise ValueError("Invalid RFC 3339 duration: {!r}"
337
359
.format(duration))
338
360
# End token found
339
361
return value
424
446
options.remove = True
425
447
426
448
427
def get_mandos_dbus_object(bus):
428
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
429
dbus_busname, server_dbus_path)
430
with if_dbus_exception_log_with_exception_and_exit(
431
"Could not connect to Mandos server: %s"):
432
mandos_dbus_object = bus.get_object(dbus_busname,
433
server_dbus_path)
434
return mandos_dbus_object
435
436
437
@contextlib.contextmanager
438
def if_dbus_exception_log_with_exception_and_exit(*args, **kwargs):
439
try:
440
yield
441
except dbus.exceptions.DBusException as e:
442
log.critical(*(args + (e,)), **kwargs)
443
sys.exit(1)
444
445
446
def get_managed_objects(object_manager):
447
log.debug("D-Bus: %s:%s:%s.GetManagedObjects()", dbus_busname,
448
server_dbus_path, dbus.OBJECT_MANAGER_IFACE)
449
with if_dbus_exception_log_with_exception_and_exit(
450
"Failed to access Mandos server through D-Bus:\n%s"):
451
with SilenceLogger("dbus.proxies"):
452
managed_objects = object_manager.GetManagedObjects()
453
return managed_objects
454
455
456
class SilenceLogger(object):
457
"Simple context manager to silence a particular logger"
458
def __init__(self, loggername):
459
self.logger = logging.getLogger(loggername)
460
461
def __enter__(self):
462
self.logger.addFilter(self.nullfilter)
463
return self
464
465
class NullFilter(logging.Filter):
466
def filter(self, record):
467
return False
468
469
nullfilter = NullFilter()
470
471
def __exit__(self, exc_type, exc_val, exc_tb):
472
self.logger.removeFilter(self.nullfilter)
473
474
475
449
def commands_from_options(options):
476
450
477
451
commands = []
478
452
479
453
if options.is_enabled:
480
commands.append(command.IsEnabled())
454
commands.append(IsEnabledCmd())
481
455
482
456
if options.approve:
483
commands.append(command.Approve())
457
commands.append(ApproveCmd())
484
458
485
459
if options.deny:
486
commands.append(command.Deny())
460
commands.append(DenyCmd())
487
461
488
462
if options.remove:
489
commands.append(command.Remove())
463
commands.append(RemoveCmd())
490
464
491
465
if options.dump_json:
492
commands.append(command.DumpJSON())
466
commands.append(DumpJSONCmd())
493
467
494
468
if options.enable:
495
commands.append(command.Enable())
469
commands.append(EnableCmd())
496
470
497
471
if options.disable:
498
commands.append(command.Disable())
472
commands.append(DisableCmd())
499
473
500
474
if options.bump_timeout:
501
commands.append(command.BumpTimeout())
475
commands.append(BumpTimeoutCmd())
502
476
503
477
if options.start_checker:
504
commands.append(command.StartChecker())
478
commands.append(StartCheckerCmd())
505
479
506
480
if options.stop_checker:
507
commands.append(command.StopChecker())
481
commands.append(StopCheckerCmd())
508
482
509
483
if options.approved_by_default is not None:
510
484
if options.approved_by_default:
511
commands.append(command.ApproveByDefault())
485
commands.append(ApproveByDefaultCmd())
512
486
else:
513
commands.append(command.DenyByDefault())
487
commands.append(DenyByDefaultCmd())
514
488
515
489
if options.checker is not None:
516
commands.append(command.SetChecker(options.checker))
490
commands.append(SetCheckerCmd(options.checker))
517
491
518
492
if options.host is not None:
519
commands.append(command.SetHost(options.host))
493
commands.append(SetHostCmd(options.host))
520
494
521
495
if options.secret is not None:
522
commands.append(command.SetSecret(options.secret))
496
commands.append(SetSecretCmd(options.secret))
523
497
524
498
if options.timeout is not None:
525
commands.append(command.SetTimeout(options.timeout))
499
commands.append(SetTimeoutCmd(options.timeout))
526
500
527
501
if options.extended_timeout:
528
502
commands.append(
529
command.SetExtendedTimeout(options.extended_timeout))
503
SetExtendedTimeoutCmd(options.extended_timeout))
530
504
531
505
if options.interval is not None:
532
commands.append(command.SetInterval(options.interval))
506
commands.append(SetIntervalCmd(options.interval))
533
507
534
508
if options.approval_delay is not None:
535
commands.append(
536
command.SetApprovalDelay(options.approval_delay))
509
commands.append(SetApprovalDelayCmd(options.approval_delay))
537
510
538
511
if options.approval_duration is not None:
539
512
commands.append(
540
command.SetApprovalDuration(options.approval_duration))
513
SetApprovalDurationCmd(options.approval_duration))
541
514
542
515
# If no command option has been given, show table of clients,
543
516
# optionally verbosely
544
517
if not commands:
545
commands.append(command.PrintTable(verbose=options.verbose))
518
commands.append(PrintTableCmd(verbose=options.verbose))
546
519
547
520
return commands
548
521
549
522
550
class command(object):
551
"""A namespace for command classes"""
552
553
class Base(object):
554
"""Abstract base class for commands"""
555
def run(self, clients, bus=None, mandos=None):
556
"""Normal commands should implement run_on_one_client(),
557
but commands which want to operate on all clients at the same time can
558
override this run() method instead.
559
"""
560
self.mandos = mandos
561
for clientpath, properties in clients.items():
562
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
563
dbus_busname, str(clientpath))
564
client = bus.get_object(dbus_busname, clientpath)
565
self.run_on_one_client(client, properties)
566
567
568
class IsEnabled(Base):
569
def run(self, clients, bus=None, mandos=None):
570
client, properties = next(iter(clients.items()))
571
if self.is_enabled(client, properties):
572
sys.exit(0)
573
sys.exit(1)
574
def is_enabled(self, client, properties):
575
return properties["Enabled"]
576
577
578
class Approve(Base):
579
def run_on_one_client(self, client, properties):
580
log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
581
client.__dbus_object_path__,
582
client_dbus_interface)
583
client.Approve(dbus.Boolean(True),
584
dbus_interface=client_dbus_interface)
585
586
587
class Deny(Base):
588
def run_on_one_client(self, client, properties):
589
log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
590
client.__dbus_object_path__,
591
client_dbus_interface)
592
client.Approve(dbus.Boolean(False),
593
dbus_interface=client_dbus_interface)
594
595
596
class Remove(Base):
597
def run_on_one_client(self, client, properties):
598
log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)",
599
dbus_busname, server_dbus_path,
600
server_dbus_interface,
601
str(client.__dbus_object_path__))
602
self.mandos.RemoveClient(client.__dbus_object_path__)
603
604
605
class Output(Base):
606
"""Abstract class for commands outputting client details"""
607
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
608
"Created", "Interval", "Host", "KeyID",
609
"Fingerprint", "CheckerRunning",
610
"LastEnabled", "ApprovalPending",
611
"ApprovedByDefault", "LastApprovalRequest",
612
"ApprovalDelay", "ApprovalDuration",
613
"Checker", "ExtendedTimeout", "Expires",
614
"LastCheckerStatus")
615
616
def run(self, clients, bus=None, mandos=None):
617
print(self.output(clients.values()))
618
619
def output(self, clients):
620
raise NotImplementedError()
621
622
623
class DumpJSON(Output):
624
def output(self, clients):
625
data = {client["Name"]:
626
{key: self.dbus_boolean_to_bool(client[key])
627
for key in self.all_keywords}
628
for client in clients}
629
return json.dumps(data, indent=4, separators=(',', ': '))
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."""
529
self.mandos = mandos
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)
535
536
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):
541
sys.exit(0)
542
sys.exit(1)
543
def is_enabled(self, client, properties):
544
return properties["Enabled"]
545
546
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)
553
554
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)
561
562
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__)
569
570
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
581
def run(self, clients, bus=None, mandos=None):
582
print(self.output(clients.values()))
583
584
def output(self, clients):
585
raise NotImplementedError()
586
587
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=(',', ': '))
595
596
@staticmethod
597
def dbus_boolean_to_bool(value):
598
if isinstance(value, dbus.Boolean):
599
value = bool(value)
600
return value
601
602
603
class PrintTableCmd(OutputCmd):
604
def __init__(self, verbose=False):
605
self.verbose = verbose
606
607
def output(self, clients):
608
default_keywords = ("Name", "Enabled", "Timeout",
609
"LastCheckedOK")
610
keywords = default_keywords
611
if self.verbose:
612
keywords = self.all_keywords
613
return str(self.TableOfClients(clients, keywords))
614
615
class TableOfClients(object):
616
tableheaders = {
617
"Name": "Name",
618
"Enabled": "Enabled",
619
"Timeout": "Timeout",
620
"LastCheckedOK": "Last Successful Check",
621
"LastApprovalRequest": "Last Approval Request",
622
"Created": "Created",
623
"Interval": "Interval",
624
"Host": "Host",
625
"Fingerprint": "Fingerprint",
626
"KeyID": "Key ID",
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",
637
}
638
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
644
645
def __str__(self):
646
return "\n".join(self.rows())
647
648
if sys.version_info.major == 2:
649
__unicode__ = __str__
650
def __str__(self):
651
return str(self).encode(locale.getpreferredencoding())
652
653
def rows(self):
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)
658
return rows
659
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)),
666
key=key)
667
for key in self.keywords)
668
669
def string_from_client(self, client, key):
670
return self.valuetostring(client[key], key)
671
672
@classmethod
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)
679
return str(value)
680
681
def header_line(self, format_string):
682
return format_string.format(**self.tableheaders)
683
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})
630
688
631
689
@staticmethod
632
def dbus_boolean_to_bool(value):
633
if isinstance(value, dbus.Boolean):
634
value = bool(value)
635
return value
636
637
638
class PrintTable(Output):
639
def __init__(self, verbose=False):
640
self.verbose = verbose
641
642
def output(self, clients):
643
default_keywords = ("Name", "Enabled", "Timeout",
644
"LastCheckedOK")
645
keywords = default_keywords
646
if self.verbose:
647
keywords = self.all_keywords
648
return str(self.TableOfClients(clients, keywords))
649
650
class TableOfClients(object):
651
tableheaders = {
652
"Name": "Name",
653
"Enabled": "Enabled",
654
"Timeout": "Timeout",
655
"LastCheckedOK": "Last Successful Check",
656
"LastApprovalRequest": "Last Approval Request",
657
"Created": "Created",
658
"Interval": "Interval",
659
"Host": "Host",
660
"Fingerprint": "Fingerprint",
661
"KeyID": "Key ID",
662
"CheckerRunning": "Check Is Running",
663
"LastEnabled": "Last Enabled",
664
"ApprovalPending": "Approval Is Pending",
665
"ApprovedByDefault": "Approved By Default",
666
"ApprovalDelay": "Approval Delay",
667
"ApprovalDuration": "Approval Duration",
668
"Checker": "Checker",
669
"ExtendedTimeout": "Extended Timeout",
670
"Expires": "Expires",
671
"LastCheckerStatus": "Last Checker Status",
672
}
673
674
def __init__(self, clients, keywords):
675
self.clients = clients
676
self.keywords = keywords
677
678
def __str__(self):
679
return "\n".join(self.rows())
680
681
if sys.version_info.major == 2:
682
__unicode__ = __str__
683
def __str__(self):
684
return str(self).encode(
685
locale.getpreferredencoding())
686
687
def rows(self):
688
format_string = self.row_formatting_string()
689
rows = [self.header_line(format_string)]
690
rows.extend(self.client_line(client, format_string)
691
for client in self.clients)
692
return rows
693
694
def row_formatting_string(self):
695
"Format string used to format table rows"
696
return " ".join("{{{key}:{width}}}".format(
697
width=max(len(self.tableheaders[key]),
698
*(len(self.string_from_client(client,
699
key))
700
for client in self.clients)),
701
key=key)
702
for key in self.keywords)
703
704
def string_from_client(self, client, key):
705
return self.valuetostring(client[key], key)
706
707
@classmethod
708
def valuetostring(cls, value, keyword):
709
if isinstance(value, dbus.Boolean):
710
return "Yes" if value else "No"
711
if keyword in ("Timeout", "Interval", "ApprovalDelay",
712
"ApprovalDuration", "ExtendedTimeout"):
713
return cls.milliseconds_to_string(value)
714
return str(value)
715
716
def header_line(self, format_string):
717
return format_string.format(**self.tableheaders)
718
719
def client_line(self, client, format_string):
720
return format_string.format(
721
**{key: self.string_from_client(client, key)
722
for key in self.keywords})
723
724
@staticmethod
725
def milliseconds_to_string(ms):
726
td = datetime.timedelta(0, 0, 0, ms)
727
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
728
.format(days="{}T".format(td.days)
729
if td.days else "",
730
hours=td.seconds // 3600,
731
minutes=(td.seconds % 3600) // 60,
732
seconds=td.seconds % 60))
733
734
735
class Property(Base):
736
"Abstract class for Actions for setting one client property"
737
738
def run_on_one_client(self, client, properties):
739
"""Set the Client's D-Bus property"""
740
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
741
client.__dbus_object_path__,
742
dbus.PROPERTIES_IFACE, client_dbus_interface,
743
self.propname, self.value_to_set
744
if not isinstance(self.value_to_set,
745
dbus.Boolean)
746
else bool(self.value_to_set))
747
client.Set(client_dbus_interface, self.propname,
748
self.value_to_set,
749
dbus_interface=dbus.PROPERTIES_IFACE)
750
751
@property
752
def propname(self):
753
raise NotImplementedError()
754
755
756
class Enable(Property):
757
propname = "Enabled"
758
value_to_set = dbus.Boolean(True)
759
760
761
class Disable(Property):
762
propname = "Enabled"
763
value_to_set = dbus.Boolean(False)
764
765
766
class BumpTimeout(Property):
767
propname = "LastCheckedOK"
768
value_to_set = ""
769
770
771
class StartChecker(Property):
772
propname = "CheckerRunning"
773
value_to_set = dbus.Boolean(True)
774
775
776
class StopChecker(Property):
777
propname = "CheckerRunning"
778
value_to_set = dbus.Boolean(False)
779
780
781
class ApproveByDefault(Property):
782
propname = "ApprovedByDefault"
783
value_to_set = dbus.Boolean(True)
784
785
786
class DenyByDefault(Property):
787
propname = "ApprovedByDefault"
788
value_to_set = dbus.Boolean(False)
789
790
791
class PropertyValue(Property):
792
"Abstract class for Property recieving a value as argument"
793
def __init__(self, value):
794
self.value_to_set = value
795
796
797
class SetChecker(PropertyValue):
798
propname = "Checker"
799
800
801
class SetHost(PropertyValue):
802
propname = "Host"
803
804
805
class SetSecret(PropertyValue):
806
propname = "Secret"
807
808
@property
809
def value_to_set(self):
810
return self._vts
811
812
@value_to_set.setter
813
def value_to_set(self, value):
814
"""When setting, read data from supplied file object"""
815
self._vts = value.read()
816
value.close()
817
818
819
class MillisecondsPropertyValueArgument(PropertyValue):
820
"""Abstract class for PropertyValue taking a value argument as
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)
694
if td.days else "",
695
hours=td.seconds // 3600,
696
minutes=(td.seconds % 3600) // 60,
697
seconds=td.seconds % 60))
698
699
700
class PropertyCmd(Command):
701
"""Abstract class for Actions for setting one client property"""
702
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,
712
self.value_to_set,
713
dbus_interface=dbus.PROPERTIES_IFACE)
714
715
@property
716
def propname(self):
717
raise NotImplementedError()
718
719
720
class EnableCmd(PropertyCmd):
721
propname = "Enabled"
722
value_to_set = dbus.Boolean(True)
723
724
725
class DisableCmd(PropertyCmd):
726
propname = "Enabled"
727
value_to_set = dbus.Boolean(False)
728
729
730
class BumpTimeoutCmd(PropertyCmd):
731
propname = "LastCheckedOK"
732
value_to_set = ""
733
734
735
class StartCheckerCmd(PropertyCmd):
736
propname = "CheckerRunning"
737
value_to_set = dbus.Boolean(True)
738
739
740
class StopCheckerCmd(PropertyCmd):
741
propname = "CheckerRunning"
742
value_to_set = dbus.Boolean(False)
743
744
745
class ApproveByDefaultCmd(PropertyCmd):
746
propname = "ApprovedByDefault"
747
value_to_set = dbus.Boolean(True)
748
749
750
class DenyByDefaultCmd(PropertyCmd):
751
propname = "ApprovedByDefault"
752
value_to_set = dbus.Boolean(False)
753
754
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
759
760
761
class SetCheckerCmd(PropertyValueCmd):
762
propname = "Checker"
763
764
765
class SetHostCmd(PropertyValueCmd):
766
propname = "Host"
767
768
769
class SetSecretCmd(PropertyValueCmd):
770
propname = "Secret"
771
772
@property
773
def value_to_set(self):
774
return self._vts
775
776
@value_to_set.setter
777
def value_to_set(self, value):
778
"""When setting, read data from supplied file object"""
779
self._vts = value.read()
780
value.close()
781
782
783
class MillisecondsPropertyValueArgumentCmd(PropertyValueCmd):
784
"""Abstract class for PropertyValueCmd taking a value argument as
821
785
a datetime.timedelta() but should store it as milliseconds."""
822
786
823
@property
824
def value_to_set(self):
825
return self._vts
826
827
@value_to_set.setter
828
def value_to_set(self, value):
829
"When setting, convert value from a datetime.timedelta"
830
self._vts = int(round(value.total_seconds() * 1000))
831
832
833
class SetTimeout(MillisecondsPropertyValueArgument):
834
propname = "Timeout"
835
836
837
class SetExtendedTimeout(MillisecondsPropertyValueArgument):
838
propname = "ExtendedTimeout"
839
840
841
class SetInterval(MillisecondsPropertyValueArgument):
842
propname = "Interval"
843
844
845
class SetApprovalDelay(MillisecondsPropertyValueArgument):
846
propname = "ApprovalDelay"
847
848
849
class SetApprovalDuration(MillisecondsPropertyValueArgument):
850
propname = "ApprovalDuration"
787
@property
788
def value_to_set(self):
789
return self._vts
790
791
@value_to_set.setter
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))
795
796
797
class SetTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
798
propname = "Timeout"
799
800
801
class SetExtendedTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
802
propname = "ExtendedTimeout"
803
804
805
class SetIntervalCmd(MillisecondsPropertyValueArgumentCmd):
806
propname = "Interval"
807
808
809
class SetApprovalDelayCmd(MillisecondsPropertyValueArgumentCmd):
810
propname = "ApprovalDelay"
811
812
813
class SetApprovalDurationCmd(MillisecondsPropertyValueArgumentCmd):
814
propname = "ApprovalDuration"
851
815
852
816
853
817
854
class TestCaseWithAssertLogs(unittest.TestCase):
855
"""unittest.TestCase.assertLogs only exists in Python 3.4"""
856
857
if not hasattr(unittest.TestCase, "assertLogs"):
858
@contextlib.contextmanager
859
def assertLogs(self, logger, level=logging.INFO):
860
capturing_handler = self.CapturingLevelHandler(level)
861
old_level = logger.level
862
old_propagate = logger.propagate
863
logger.addHandler(capturing_handler)
864
logger.setLevel(level)
865
logger.propagate = False
866
try:
867
yield capturing_handler.watcher
868
finally:
869
logger.propagate = old_propagate
870
logger.removeHandler(capturing_handler)
871
logger.setLevel(old_level)
872
self.assertGreater(len(capturing_handler.watcher.records),
873
0)
874
875
class CapturingLevelHandler(logging.Handler):
876
def __init__(self, level, *args, **kwargs):
877
logging.Handler.__init__(self, *args, **kwargs)
878
self.watcher = self.LoggingWatcher([], [])
879
def emit(self, record):
880
self.watcher.records.append(record)
881
self.watcher.output.append(self.format(record))
882
883
LoggingWatcher = collections.namedtuple("LoggingWatcher",
884
("records",
885
"output"))
886
887
888
class Test_string_to_delta(TestCaseWithAssertLogs):
818
class Test_string_to_delta(unittest.TestCase):
889
819
def test_handles_basic_rfc3339(self):
890
820
self.assertEqual(string_to_delta("PT0S"),
891
821
datetime.timedelta())
897
827
datetime.timedelta(0, 7200))
898
828
899
829
def test_falls_back_to_pre_1_6_1_with_warning(self):
900
with self.assertLogs(log, logging.WARNING):
901
value = string_to_delta("2h")
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")
834
else:
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",
840
False)
841
return not is_warning
842
warning_filter = WarningFilter()
843
log.addFilter(warning_filter)
844
try:
845
value = string_to_delta("2h")
846
finally:
847
log.removeFilter(warning_filter)
848
self.assertTrue(getattr(warning_filter, "found", False))
902
849
self.assertEqual(value, datetime.timedelta(0, 7200))
903
850
904
851
943
890
@contextlib.contextmanager
944
891
def assertParseError(self):
945
892
with self.assertRaises(SystemExit) as e:
946
with self.redirect_stderr_to_devnull():
893
with self.temporarily_suppress_stderr():
947
894
yield
948
895
# Exit code from argparse is guaranteed to be "2". Reference:
949
896
# https://docs.python.org/3/library
952
899
953
900
@staticmethod
954
901
@contextlib.contextmanager
955
def redirect_stderr_to_devnull():
902
def temporarily_suppress_stderr():
956
903
null = os.open(os.path.devnull, os.O_RDWR)
957
904
stderrcopy = os.dup(sys.stderr.fileno())
958
905
os.dup2(null, sys.stderr.fileno())
967
914
def check_option_syntax(self, options):
968
915
check_option_syntax(self.parser, options)
969
916
970
def test_actions_all_conflicts_with_verbose(self):
971
for action, value in self.actions.items():
972
options = self.parser.parse_args()
973
setattr(options, action, value)
974
options.all = True
975
options.verbose = True
976
with self.assertParseError():
977
self.check_option_syntax(options)
978
979
def test_actions_with_client_conflicts_with_verbose(self):
980
for action, value in self.actions.items():
981
options = self.parser.parse_args()
982
setattr(options, action, value)
983
options.verbose = True
984
options.client = ["foo"]
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
985
922
with self.assertParseError():
986
923
self.check_option_syntax(options)
987
924
1013
950
options.all = True
1014
951
self.check_option_syntax(options)
1015
952
1016
def test_any_action_is_ok_with_one_client(self):
1017
for action, value in self.actions.items():
1018
options = self.parser.parse_args()
1019
setattr(options, action, value)
1020
options.client = ["foo"]
953
def test_is_enabled_fails_without_client(self):
954
options = self.parser.parse_args()
955
options.is_enabled = True
956
with self.assertParseError():
1021
957
self.check_option_syntax(options)
1022
958
1023
def test_one_client_with_all_actions_except_is_enabled(self):
959
def test_is_enabled_works_with_one_client(self):
1024
960
options = self.parser.parse_args()
1025
for action, value in self.actions.items():
1026
if action == "is_enabled":
1027
continue
1028
setattr(options, action, value)
961
options.is_enabled = True
1029
962
options.client = ["foo"]
1030
963
self.check_option_syntax(options)
1031
964
1032
def test_two_clients_with_all_actions_except_is_enabled(self):
1033
options = self.parser.parse_args()
1034
for action, value in self.actions.items():
1035
if action == "is_enabled":
1036
continue
1037
setattr(options, action, value)
1038
options.client = ["foo", "barbar"]
1039
self.check_option_syntax(options)
1040
1041
def test_two_clients_are_ok_with_actions_except_is_enabled(self):
1042
for action, value in self.actions.items():
1043
if action == "is_enabled":
1044
continue
1045
options = self.parser.parse_args()
1046
setattr(options, action, value)
1047
options.client = ["foo", "barbar"]
1048
self.check_option_syntax(options)
1049
1050
def test_is_enabled_fails_without_client(self):
1051
options = self.parser.parse_args()
1052
options.is_enabled = True
1053
with self.assertParseError():
1054
self.check_option_syntax(options)
1055
1056
965
def test_is_enabled_fails_with_two_clients(self):
1057
966
options = self.parser.parse_args()
1058
967
options.is_enabled = True
1072
981
self.check_option_syntax(options)
1073
982
1074
983
1075
class Test_get_mandos_dbus_object(TestCaseWithAssertLogs):
1076
def test_calls_and_returns_get_object_on_bus(self):
1077
class MockBus(object):
1078
called = False
1079
def get_object(mockbus_self, busname, dbus_path):
1080
# Note that "self" is still the testcase instance,
1081
# this MockBus instance is in "mockbus_self".
1082
self.assertEqual(busname, dbus_busname)
1083
self.assertEqual(dbus_path, server_dbus_path)
1084
mockbus_self.called = True
1085
return mockbus_self
1086
1087
mockbus = get_mandos_dbus_object(bus=MockBus())
1088
self.assertIsInstance(mockbus, MockBus)
1089
self.assertTrue(mockbus.called)
1090
1091
def test_logs_and_exits_on_dbus_error(self):
1092
class MockBusFailing(object):
1093
def get_object(self, busname, dbus_path):
1094
raise dbus.exceptions.DBusException("Test")
1095
1096
with self.assertLogs(log, logging.CRITICAL):
1097
with self.assertRaises(SystemExit) as e:
1098
bus = get_mandos_dbus_object(bus=MockBusFailing())
1099
1100
if isinstance(e.exception.code, int):
1101
self.assertNotEqual(e.exception.code, 0)
1102
else:
1103
self.assertIsNotNone(e.exception.code)
1104
1105
1106
class Test_get_managed_objects(TestCaseWithAssertLogs):
1107
def test_calls_and_returns_GetManagedObjects(self):
1108
managed_objects = {"/clients/foo": { "Name": "foo"}}
1109
class MockObjectManager(object):
1110
def GetManagedObjects(self):
1111
return managed_objects
1112
retval = get_managed_objects(MockObjectManager())
1113
self.assertDictEqual(managed_objects, retval)
1114
1115
def test_logs_and_exits_on_dbus_error(self):
1116
dbus_logger = logging.getLogger("dbus.proxies")
1117
1118
class MockObjectManagerFailing(object):
1119
def GetManagedObjects(self):
1120
dbus_logger.error("Test")
1121
raise dbus.exceptions.DBusException("Test")
1122
1123
class CountingHandler(logging.Handler):
1124
count = 0
1125
def emit(self, record):
1126
self.count += 1
1127
1128
counting_handler = CountingHandler()
1129
1130
dbus_logger.addHandler(counting_handler)
1131
1132
try:
1133
with self.assertLogs(log, logging.CRITICAL) as watcher:
1134
with self.assertRaises(SystemExit) as e:
1135
get_managed_objects(MockObjectManagerFailing())
1136
finally:
1137
dbus_logger.removeFilter(counting_handler)
1138
1139
# Make sure the dbus logger was suppressed
1140
self.assertEqual(counting_handler.count, 0)
1141
1142
# Test that the dbus_logger still works
1143
with self.assertLogs(dbus_logger, logging.ERROR):
1144
dbus_logger.error("Test")
1145
1146
if isinstance(e.exception.code, int):
1147
self.assertNotEqual(e.exception.code, 0)
1148
else:
1149
self.assertIsNotNone(e.exception.code)
1150
1151
1152
984
class Test_commands_from_options(unittest.TestCase):
1153
985
def setUp(self):
1154
986
self.parser = argparse.ArgumentParser()
1156
988
1157
989
def test_is_enabled(self):
1158
990
self.assert_command_from_args(["--is-enabled", "foo"],
1159
command.IsEnabled)
991
IsEnabledCmd)
1160
992
1161
993
def assert_command_from_args(self, args, command_cls,
1162
994
**cmd_attrs):
1172
1004
self.assertEqual(getattr(command, key), value)
1173
1005
1174
1006
def test_is_enabled_short(self):
1175
self.assert_command_from_args(["-V", "foo"],
1176
command.IsEnabled)
1007
self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
1177
1008
1178
1009
def test_approve(self):
1179
1010
self.assert_command_from_args(["--approve", "foo"],
1180
command.Approve)
1011
ApproveCmd)
1181
1012
1182
1013
def test_approve_short(self):
1183
self.assert_command_from_args(["-A", "foo"], command.Approve)
1014
self.assert_command_from_args(["-A", "foo"], ApproveCmd)
1184
1015
1185
1016
def test_deny(self):
1186
self.assert_command_from_args(["--deny", "foo"], command.Deny)
1017
self.assert_command_from_args(["--deny", "foo"], DenyCmd)
1187
1018
1188
1019
def test_deny_short(self):
1189
self.assert_command_from_args(["-D", "foo"], command.Deny)
1020
self.assert_command_from_args(["-D", "foo"], DenyCmd)
1190
1021
1191
1022
def test_remove(self):
1192
1023
self.assert_command_from_args(["--remove", "foo"],
1193
command.Remove)
1024
RemoveCmd)
1194
1025
1195
1026
def test_deny_before_remove(self):
1196
1027
options = self.parser.parse_args(["--deny", "--remove",
1198
1029
check_option_syntax(self.parser, options)
1199
1030
commands = commands_from_options(options)
1200
1031
self.assertEqual(len(commands), 2)
1201
self.assertIsInstance(commands[0], command.Deny)
1202
self.assertIsInstance(commands[1], command.Remove)
1032
self.assertIsInstance(commands[0], DenyCmd)
1033
self.assertIsInstance(commands[1], RemoveCmd)
1203
1034
1204
1035
def test_deny_before_remove_reversed(self):
1205
1036
options = self.parser.parse_args(["--remove", "--deny",
1207
1038
check_option_syntax(self.parser, options)
1208
1039
commands = commands_from_options(options)
1209
1040
self.assertEqual(len(commands), 2)
1210
self.assertIsInstance(commands[0], command.Deny)
1211
self.assertIsInstance(commands[1], command.Remove)
1041
self.assertIsInstance(commands[0], DenyCmd)
1042
self.assertIsInstance(commands[1], RemoveCmd)
1212
1043
1213
1044
def test_remove_short(self):
1214
self.assert_command_from_args(["-r", "foo"], command.Remove)
1045
self.assert_command_from_args(["-r", "foo"], RemoveCmd)
1215
1046
1216
1047
def test_dump_json(self):
1217
self.assert_command_from_args(["--dump-json"],
1218
command.DumpJSON)
1048
self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
1219
1049
1220
1050
def test_enable(self):
1221
self.assert_command_from_args(["--enable", "foo"],
1222
command.Enable)
1051
self.assert_command_from_args(["--enable", "foo"], EnableCmd)
1223
1052
1224
1053
def test_enable_short(self):
1225
self.assert_command_from_args(["-e", "foo"], command.Enable)
1054
self.assert_command_from_args(["-e", "foo"], EnableCmd)
1226
1055
1227
1056
def test_disable(self):
1228
1057
self.assert_command_from_args(["--disable", "foo"],
1229
command.Disable)
1058
DisableCmd)
1230
1059
1231
1060
def test_disable_short(self):
1232
self.assert_command_from_args(["-d", "foo"], command.Disable)
1061
self.assert_command_from_args(["-d", "foo"], DisableCmd)
1233
1062
1234
1063
def test_bump_timeout(self):
1235
1064
self.assert_command_from_args(["--bump-timeout", "foo"],
1236
command.BumpTimeout)
1065
BumpTimeoutCmd)
1237
1066
1238
1067
def test_bump_timeout_short(self):
1239
self.assert_command_from_args(["-b", "foo"],
1240
command.BumpTimeout)
1068
self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
1241
1069
1242
1070
def test_start_checker(self):
1243
1071
self.assert_command_from_args(["--start-checker", "foo"],
1244
command.StartChecker)
1072
StartCheckerCmd)
1245
1073
1246
1074
def test_stop_checker(self):
1247
1075
self.assert_command_from_args(["--stop-checker", "foo"],
1248
command.StopChecker)
1076
StopCheckerCmd)
1249
1077
1250
1078
def test_approve_by_default(self):
1251
1079
self.assert_command_from_args(["--approve-by-default", "foo"],
1252
command.ApproveByDefault)
1080
ApproveByDefaultCmd)
1253
1081
1254
1082
def test_deny_by_default(self):
1255
1083
self.assert_command_from_args(["--deny-by-default", "foo"],
1256
command.DenyByDefault)
1084
DenyByDefaultCmd)
1257
1085
1258
1086
def test_checker(self):
1259
1087
self.assert_command_from_args(["--checker", ":", "foo"],
1260
command.SetChecker,
1261
value_to_set=":")
1088
SetCheckerCmd, value_to_set=":")
1262
1089
1263
1090
def test_checker_empty(self):
1264
1091
self.assert_command_from_args(["--checker", "", "foo"],
1265
command.SetChecker,
1266
value_to_set="")
1092
SetCheckerCmd, value_to_set="")
1267
1093
1268
1094
def test_checker_short(self):
1269
1095
self.assert_command_from_args(["-c", ":", "foo"],
1270
command.SetChecker,
1271
value_to_set=":")
1096
SetCheckerCmd, value_to_set=":")
1272
1097
1273
1098
def test_host(self):
1274
1099
self.assert_command_from_args(["--host", "foo.example.org",
1275
"foo"], command.SetHost,
1100
"foo"], SetHostCmd,
1276
1101
value_to_set="foo.example.org")
1277
1102
1278
1103
def test_host_short(self):
1279
1104
self.assert_command_from_args(["-H", "foo.example.org",
1280
"foo"], command.SetHost,
1105
"foo"], SetHostCmd,
1281
1106
value_to_set="foo.example.org")
1282
1107
1283
1108
def test_secret_devnull(self):
1284
1109
self.assert_command_from_args(["--secret", os.path.devnull,
1285
"foo"], command.SetSecret,
1110
"foo"], SetSecretCmd,
1286
1111
value_to_set=b"")
1287
1112
1288
1113
def test_secret_tempfile(self):
1291
1116
f.write(value)
1292
1117
f.seek(0)
1293
1118
self.assert_command_from_args(["--secret", f.name,
1294
"foo"], command.SetSecret,
1119
"foo"], SetSecretCmd,
1295
1120
value_to_set=value)
1296
1121
1297
1122
def test_secret_devnull_short(self):
1298
1123
self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1299
command.SetSecret,
1300
value_to_set=b"")
1124
SetSecretCmd, value_to_set=b"")
1301
1125
1302
1126
def test_secret_tempfile_short(self):
1303
1127
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1305
1129
f.write(value)
1306
1130
f.seek(0)
1307
1131
self.assert_command_from_args(["-s", f.name, "foo"],
1308
command.SetSecret,
1132
SetSecretCmd,
1309
1133
value_to_set=value)
1310
1134
1311
1135
def test_timeout(self):
1312
1136
self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1313
command.SetTimeout,
1137
SetTimeoutCmd,
1314
1138
value_to_set=300000)
1315
1139
1316
1140
def test_timeout_short(self):
1317
1141
self.assert_command_from_args(["-t", "PT5M", "foo"],
1318
command.SetTimeout,
1142
SetTimeoutCmd,
1319
1143
value_to_set=300000)
1320
1144
1321
1145
def test_extended_timeout(self):
1322
1146
self.assert_command_from_args(["--extended-timeout", "PT15M",
1323
1147
"foo"],
1324
command.SetExtendedTimeout,
1148
SetExtendedTimeoutCmd,
1325
1149
value_to_set=900000)
1326
1150
1327
1151
def test_interval(self):
1328
1152
self.assert_command_from_args(["--interval", "PT2M", "foo"],
1329
command.SetInterval,
1153
SetIntervalCmd,
1330
1154
value_to_set=120000)
1331
1155
1332
1156
def test_interval_short(self):
1333
1157
self.assert_command_from_args(["-i", "PT2M", "foo"],
1334
command.SetInterval,
1158
SetIntervalCmd,
1335
1159
value_to_set=120000)
1336
1160
1337
1161
def test_approval_delay(self):
1338
1162
self.assert_command_from_args(["--approval-delay", "PT30S",
1339
"foo"],
1340
command.SetApprovalDelay,
1163
"foo"], SetApprovalDelayCmd,
1341
1164
value_to_set=30000)
1342
1165
1343
1166
def test_approval_duration(self):
1344
1167
self.assert_command_from_args(["--approval-duration", "PT1S",
1345
"foo"],
1346
command.SetApprovalDuration,
1168
"foo"], SetApprovalDurationCmd,
1347
1169
value_to_set=1000)
1348
1170
1349
1171
def test_print_table(self):
1350
self.assert_command_from_args([], command.PrintTable,
1172
self.assert_command_from_args([], PrintTableCmd,
1351
1173
verbose=False)
1352
1174
1353
1175
def test_print_table_verbose(self):
1354
self.assert_command_from_args(["--verbose"],
1355
command.PrintTable,
1176
self.assert_command_from_args(["--verbose"], PrintTableCmd,
1356
1177
verbose=True)
1357
1178
1358
1179
def test_print_table_verbose_short(self):
1359
self.assert_command_from_args(["-v"], command.PrintTable,
1180
self.assert_command_from_args(["-v"], PrintTableCmd,
1360
1181
verbose=True)
1361
1182
1362
1183
1363
class TestCommand(unittest.TestCase):
1184
class TestCmd(unittest.TestCase):
1364
1185
"""Abstract class for tests of command classes"""
1365
1186
1366
1187
def setUp(self):
1456
1277
return Bus()
1457
1278
1458
1279
1459
class TestBaseCommands(TestCommand):
1460
1280
class TestIsEnabledCmd(TestCmd):
1461
1281
def test_is_enabled(self):
1462
self.assertTrue(all(command.IsEnabled().is_enabled(client,
1282
self.assertTrue(all(IsEnabledCmd().is_enabled(client,
1463
1283
properties)
1464
1284
for client, properties
1465
1285
in self.clients.items()))
1466
1286
1467
1287
def test_is_enabled_run_exits_successfully(self):
1468
1288
with self.assertRaises(SystemExit) as e:
1469
command.IsEnabled().run(self.one_client)
1289
IsEnabledCmd().run(self.one_client)
1470
1290
if e.exception.code is not None:
1471
1291
self.assertEqual(e.exception.code, 0)
1472
1292
else:
1475
1295
def test_is_enabled_run_exits_with_failure(self):
1476
1296
self.client.attributes["Enabled"] = dbus.Boolean(False)
1477
1297
with self.assertRaises(SystemExit) as e:
1478
command.IsEnabled().run(self.one_client)
1298
IsEnabledCmd().run(self.one_client)
1479
1299
if isinstance(e.exception.code, int):
1480
1300
self.assertNotEqual(e.exception.code, 0)
1481
1301
else:
1482
1302
self.assertIsNotNone(e.exception.code)
1483
1303
1304
1305
class TestApproveCmd(TestCmd):
1484
1306
def test_approve(self):
1485
command.Approve().run(self.clients, self.bus)
1307
ApproveCmd().run(self.clients, self.bus)
1486
1308
for clientpath in self.clients:
1487
1309
client = self.bus.get_object(dbus_busname, clientpath)
1488
1310
self.assertIn(("Approve", (True, client_dbus_interface)),
1489
1311
client.calls)
1490
1312
1313
1314
class TestDenyCmd(TestCmd):
1491
1315
def test_deny(self):
1492
command.Deny().run(self.clients, self.bus)
1316
DenyCmd().run(self.clients, self.bus)
1493
1317
for clientpath in self.clients:
1494
1318
client = self.bus.get_object(dbus_busname, clientpath)
1495
1319
self.assertIn(("Approve", (False, client_dbus_interface)),
1496
1320
client.calls)
1497
1321
1322
1323
class TestRemoveCmd(TestCmd):
1498
1324
def test_remove(self):
1499
1325
class MockMandos(object):
1500
1326
def __init__(self):
1502
1328
def RemoveClient(self, dbus_path):
1503
1329
self.calls.append(("RemoveClient", (dbus_path,)))
1504
1330
mandos = MockMandos()
1505
command.Remove().run(self.clients, self.bus, mandos)
1331
super(TestRemoveCmd, self).setUp()
1332
RemoveCmd().run(self.clients, self.bus, mandos)
1506
1333
self.assertEqual(len(mandos.calls), 2)
1507
1334
for clientpath in self.clients:
1508
1335
self.assertIn(("RemoveClient", (clientpath,)),
1509
1336
mandos.calls)
1510
1337
1511
expected_json = {
1512
"foo": {
1513
"Name": "foo",
1514
"KeyID": ("92ed150794387c03ce684574b1139a65"
1515
"94a34f895daaaf09fd8ea90a27cddb12"),
1516
"Host": "foo.example.org",
1517
"Enabled": True,
1518
"Timeout": 300000,
1519
"LastCheckedOK": "2019-02-03T00:00:00",
1520
"Created": "2019-01-02T00:00:00",
1521
"Interval": 120000,
1522
"Fingerprint": ("778827225BA7DE539C5A"
1523
"7CFA59CFF7CDBD9A5920"),
1524
"CheckerRunning": False,
1525
"LastEnabled": "2019-01-03T00:00:00",
1526
"ApprovalPending": False,
1527
"ApprovedByDefault": True,
1528
"LastApprovalRequest": "",
1529
"ApprovalDelay": 0,
1530
"ApprovalDuration": 1000,
1531
"Checker": "fping -q -- %(host)s",
1532
"ExtendedTimeout": 900000,
1533
"Expires": "2019-02-04T00:00:00",
1534
"LastCheckerStatus": 0,
1535
},
1536
"barbar": {
1537
"Name": "barbar",
1538
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
1539
"6ab612cff5ad227247e46c2b020f441c"),
1540
"Host": "192.0.2.3",
1541
"Enabled": True,
1542
"Timeout": 300000,
1543
"LastCheckedOK": "2019-02-04T00:00:00",
1544
"Created": "2019-01-03T00:00:00",
1545
"Interval": 120000,
1546
"Fingerprint": ("3E393AEAEFB84C7E89E2"
1547
"F547B3A107558FCA3A27"),
1548
"CheckerRunning": True,
1549
"LastEnabled": "2019-01-04T00:00:00",
1550
"ApprovalPending": False,
1551
"ApprovedByDefault": False,
1552
"LastApprovalRequest": "2019-01-03T00:00:00",
1553
"ApprovalDelay": 30000,
1554
"ApprovalDuration": 93785000,
1555
"Checker": ":",
1556
"ExtendedTimeout": 900000,
1557
"Expires": "2019-02-05T00:00:00",
1558
"LastCheckerStatus": -2,
1559
},
1560
}
1561
1562
def test_DumpJSON_normal(self):
1563
output = command.DumpJSON().output(self.clients.values())
1564
json_data = json.loads(output)
1338
1339
class TestDumpJSONCmd(TestCmd):
1340
def setUp(self):
1341
self.expected_json = {
1342
"foo": {
1343
"Name": "foo",
1344
"KeyID": ("92ed150794387c03ce684574b1139a65"
1345
"94a34f895daaaf09fd8ea90a27cddb12"),
1346
"Host": "foo.example.org",
1347
"Enabled": True,
1348
"Timeout": 300000,
1349
"LastCheckedOK": "2019-02-03T00:00:00",
1350
"Created": "2019-01-02T00:00:00",
1351
"Interval": 120000,
1352
"Fingerprint": ("778827225BA7DE539C5A"
1353
"7CFA59CFF7CDBD9A5920"),
1354
"CheckerRunning": False,
1355
"LastEnabled": "2019-01-03T00:00:00",
1356
"ApprovalPending": False,
1357
"ApprovedByDefault": True,
1358
"LastApprovalRequest": "",
1359
"ApprovalDelay": 0,
1360
"ApprovalDuration": 1000,
1361
"Checker": "fping -q -- %(host)s",
1362
"ExtendedTimeout": 900000,
1363
"Expires": "2019-02-04T00:00:00",
1364
"LastCheckerStatus": 0,
1365
},
1366
"barbar": {
1367
"Name": "barbar",
1368
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
1369
"6ab612cff5ad227247e46c2b020f441c"),
1370
"Host": "192.0.2.3",
1371
"Enabled": True,
1372
"Timeout": 300000,
1373
"LastCheckedOK": "2019-02-04T00:00:00",
1374
"Created": "2019-01-03T00:00:00",
1375
"Interval": 120000,
1376
"Fingerprint": ("3E393AEAEFB84C7E89E2"
1377
"F547B3A107558FCA3A27"),
1378
"CheckerRunning": True,
1379
"LastEnabled": "2019-01-04T00:00:00",
1380
"ApprovalPending": False,
1381
"ApprovedByDefault": False,
1382
"LastApprovalRequest": "2019-01-03T00:00:00",
1383
"ApprovalDelay": 30000,
1384
"ApprovalDuration": 93785000,
1385
"Checker": ":",
1386
"ExtendedTimeout": 900000,
1387
"Expires": "2019-02-05T00:00:00",
1388
"LastCheckerStatus": -2,
1389
},
1390
}
1391
return super(TestDumpJSONCmd, self).setUp()
1392
1393
def test_normal(self):
1394
json_data = json.loads(DumpJSONCmd().output(self.clients))
1565
1395
self.assertDictEqual(json_data, self.expected_json)
1566
1396
1567
def test_DumpJSON_one_client(self):
1568
output = command.DumpJSON().output(self.one_client.values())
1569
json_data = json.loads(output)
1397
def test_one_client(self):
1398
clients = self.one_client
1399
json_data = json.loads(DumpJSONCmd().output(clients))
1570
1400
expected_json = {"foo": self.expected_json["foo"]}
1571
1401
self.assertDictEqual(json_data, expected_json)
1572
1402
1573
def test_PrintTable_normal(self):
1574
output = command.PrintTable().output(self.clients.values())
1403
1404
class TestPrintTableCmd(TestCmd):
1405
def test_normal(self):
1406
output = PrintTableCmd().output(self.clients.values())
1575
1407
expected_output = "\n".join((
1576
1408
"Name Enabled Timeout Last Successful Check",
1577
1409
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1579
1411
))
1580
1412
self.assertEqual(output, expected_output)
1581
1413
1582
def test_PrintTable_verbose(self):
1583
output = command.PrintTable(verbose=True).output(
1414
def test_verbose(self):
1415
output = PrintTableCmd(verbose=True).output(
1584
1416
self.clients.values())
1585
1417
columns = (
1586
1418
(
1674
1506
for line in range(num_lines))
1675
1507
self.assertEqual(output, expected_output)
1676
1508
1677
def test_PrintTable_one_client(self):
1678
output = command.PrintTable().output(self.one_client.values())
1509
def test_one_client(self):
1510
output = PrintTableCmd().output(self.one_client.values())
1679
1511
expected_output = "\n".join((
1680
1512
"Name Enabled Timeout Last Successful Check",
1681
1513
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1683
1515
self.assertEqual(output, expected_output)
1684
1516
1685
1517
1686
class TestPropertyCmd(TestCommand):
1687
"""Abstract class for tests of command.Property classes"""
1518
class TestPropertyCmd(TestCmd):
1519
"""Abstract class for tests of PropertyCmd classes"""
1688
1520
def runTest(self):
1689
1521
if not hasattr(self, "command"):
1690
1522
return
1713
1545
1714
1546
1715
1547
class TestEnableCmd(TestPropertyCmd):
1716
command = command.Enable
1548
command = EnableCmd
1717
1549
propname = "Enabled"
1718
1550
values_to_set = [dbus.Boolean(True)]
1719
1551
1720
1552
1721
1553
class TestDisableCmd(TestPropertyCmd):
1722
command = command.Disable
1554
command = DisableCmd
1723
1555
propname = "Enabled"
1724
1556
values_to_set = [dbus.Boolean(False)]
1725
1557
1726
1558
1727
1559
class TestBumpTimeoutCmd(TestPropertyCmd):
1728
command = command.BumpTimeout
1560
command = BumpTimeoutCmd
1729
1561
propname = "LastCheckedOK"
1730
1562
values_to_set = [""]
1731
1563
1732
1564
1733
1565
class TestStartCheckerCmd(TestPropertyCmd):
1734
command = command.StartChecker
1566
command = StartCheckerCmd
1735
1567
propname = "CheckerRunning"
1736
1568
values_to_set = [dbus.Boolean(True)]
1737
1569
1738
1570
1739
1571
class TestStopCheckerCmd(TestPropertyCmd):
1740
command = command.StopChecker
1572
command = StopCheckerCmd
1741
1573
propname = "CheckerRunning"
1742
1574
values_to_set = [dbus.Boolean(False)]
1743
1575
1744
1576
1745
1577
class TestApproveByDefaultCmd(TestPropertyCmd):
1746
command = command.ApproveByDefault
1578
command = ApproveByDefaultCmd
1747
1579
propname = "ApprovedByDefault"
1748
1580
values_to_set = [dbus.Boolean(True)]
1749
1581
1750
1582
1751
1583
class TestDenyByDefaultCmd(TestPropertyCmd):
1752
command = command.DenyByDefault
1584
command = DenyByDefaultCmd
1753
1585
propname = "ApprovedByDefault"
1754
1586
values_to_set = [dbus.Boolean(False)]
1755
1587
1767
1599
1768
1600
1769
1601
class TestSetCheckerCmd(TestPropertyValueCmd):
1770
command = command.SetChecker
1602
command = SetCheckerCmd
1771
1603
propname = "Checker"
1772
1604
values_to_set = ["", ":", "fping -q -- %s"]
1773
1605
1774
1606
1775
1607
class TestSetHostCmd(TestPropertyValueCmd):
1776
command = command.SetHost
1608
command = SetHostCmd
1777
1609
propname = "Host"
1778
1610
values_to_set = ["192.0.2.3", "foo.example.org"]
1779
1611
1780
1612
1781
1613
class TestSetSecretCmd(TestPropertyValueCmd):
1782
command = command.SetSecret
1614
command = SetSecretCmd
1783
1615
propname = "Secret"
1784
1616
values_to_set = [io.BytesIO(b""),
1785
1617
io.BytesIO(b"secret\0xyzzy\nbar")]
1787
1619
1788
1620
1789
1621
class TestSetTimeoutCmd(TestPropertyValueCmd):
1790
command = command.SetTimeout
1622
command = SetTimeoutCmd
1791
1623
propname = "Timeout"
1792
1624
values_to_set = [datetime.timedelta(),
1793
1625
datetime.timedelta(minutes=5),
1798
1630
1799
1631
1800
1632
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
1801
command = command.SetExtendedTimeout
1633
command = SetExtendedTimeoutCmd
1802
1634
propname = "ExtendedTimeout"
1803
1635
values_to_set = [datetime.timedelta(),
1804
1636
datetime.timedelta(minutes=5),
1809
1641
1810
1642
1811
1643
class TestSetIntervalCmd(TestPropertyValueCmd):
1812
command = command.SetInterval
1644
command = SetIntervalCmd
1813
1645
propname = "Interval"
1814
1646
values_to_set = [datetime.timedelta(),
1815
1647
datetime.timedelta(minutes=5),
1820
1652
1821
1653
1822
1654
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
1823
command = command.SetApprovalDelay
1655
command = SetApprovalDelayCmd
1824
1656
propname = "ApprovalDelay"
1825
1657
values_to_set = [datetime.timedelta(),
1826
1658
datetime.timedelta(minutes=5),
1831
1663
1832
1664
1833
1665
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
1834
command = command.SetApprovalDuration
1666
command = SetApprovalDurationCmd
1835
1667
propname = "ApprovalDuration"
1836
1668
values_to_set = [datetime.timedelta(),
1837
1669
datetime.timedelta(minutes=5),
1859
1691
return tests
1860
1692
1861
1693
if __name__ == "__main__":
1862
try:
1863
if should_only_run_tests():
1864
# Call using ./tdd-python-script --check [--verbose]
1865
unittest.main()
1866
else:
1867
main()
1868
finally:
1869
logging.shutdown()
1694
if should_only_run_tests():
1695
# Call using ./tdd-python-script --check [--verbose]
1696
unittest.main()
1697
else:
1698
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0