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 1064
- compare with another revision
- download diff
- download tarball
- view history from revision 1064
- Committer: Teddy Hogeborn
- Date: 2019-03-13 22:21:45 UTC
- Revision ID: teddy@recompile.se-20190313222145-2icvxn9caz7zcr0c
mandos-ctl: Refactor
* mandos-ctl (PrintTableCmd.TableOfClients.__init__): Remove unused
parameter
"tableheaders".
* mandos-ctl (PrintTableCmd.TableOfClients.__init__): Remove unused
parameter
"tableheaders".
- 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}
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):
640
self.clients = clients
641
self.keywords = keywords
642
643
def __str__(self):
644
return "\n".join(self.rows())
645
646
if sys.version_info.major == 2:
647
__unicode__ = __str__
648
def __str__(self):
649
return str(self).encode(locale.getpreferredencoding())
650
651
def rows(self):
652
format_string = self.row_formatting_string()
653
rows = [self.header_line(format_string)]
654
rows.extend(self.client_line(client, format_string)
655
for client in self.clients)
656
return rows
657
658
def row_formatting_string(self):
659
"Format string used to format table rows"
660
return " ".join("{{{key}:{width}}}".format(
661
width=max(len(self.tableheaders[key]),
662
*(len(self.string_from_client(client, key))
663
for client in self.clients)),
664
key=key)
665
for key in self.keywords)
666
667
def string_from_client(self, client, key):
668
return self.valuetostring(client[key], key)
669
670
@classmethod
671
def valuetostring(cls, value, keyword):
672
if isinstance(value, dbus.Boolean):
673
return "Yes" if value else "No"
674
if keyword in ("Timeout", "Interval", "ApprovalDelay",
675
"ApprovalDuration", "ExtendedTimeout"):
676
return cls.milliseconds_to_string(value)
677
return str(value)
678
679
def header_line(self, format_string):
680
return format_string.format(**self.tableheaders)
681
682
def client_line(self, client, format_string):
683
return format_string.format(
684
**{key: self.string_from_client(client, key)
685
for key in self.keywords})
630
686
631
687
@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
688
def milliseconds_to_string(ms):
689
td = datetime.timedelta(0, 0, 0, ms)
690
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
691
.format(days="{}T".format(td.days)
692
if td.days else "",
693
hours=td.seconds // 3600,
694
minutes=(td.seconds % 3600) // 60,
695
seconds=td.seconds % 60))
696
697
698
class PropertyCmd(Command):
699
"""Abstract class for Actions for setting one client property"""
700
701
def run_on_one_client(self, client, properties):
702
"""Set the Client's D-Bus property"""
703
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
704
client.__dbus_object_path__,
705
dbus.PROPERTIES_IFACE, client_dbus_interface,
706
self.propname, self.value_to_set
707
if not isinstance(self.value_to_set, dbus.Boolean)
708
else bool(self.value_to_set))
709
client.Set(client_dbus_interface, self.propname,
710
self.value_to_set,
711
dbus_interface=dbus.PROPERTIES_IFACE)
712
713
@property
714
def propname(self):
715
raise NotImplementedError()
716
717
718
class EnableCmd(PropertyCmd):
719
propname = "Enabled"
720
value_to_set = dbus.Boolean(True)
721
722
723
class DisableCmd(PropertyCmd):
724
propname = "Enabled"
725
value_to_set = dbus.Boolean(False)
726
727
728
class BumpTimeoutCmd(PropertyCmd):
729
propname = "LastCheckedOK"
730
value_to_set = ""
731
732
733
class StartCheckerCmd(PropertyCmd):
734
propname = "CheckerRunning"
735
value_to_set = dbus.Boolean(True)
736
737
738
class StopCheckerCmd(PropertyCmd):
739
propname = "CheckerRunning"
740
value_to_set = dbus.Boolean(False)
741
742
743
class ApproveByDefaultCmd(PropertyCmd):
744
propname = "ApprovedByDefault"
745
value_to_set = dbus.Boolean(True)
746
747
748
class DenyByDefaultCmd(PropertyCmd):
749
propname = "ApprovedByDefault"
750
value_to_set = dbus.Boolean(False)
751
752
753
class PropertyValueCmd(PropertyCmd):
754
"""Abstract class for PropertyCmd recieving a value as argument"""
755
def __init__(self, value):
756
self.value_to_set = value
757
758
759
class SetCheckerCmd(PropertyValueCmd):
760
propname = "Checker"
761
762
763
class SetHostCmd(PropertyValueCmd):
764
propname = "Host"
765
766
767
class SetSecretCmd(PropertyValueCmd):
768
propname = "Secret"
769
770
@property
771
def value_to_set(self):
772
return self._vts
773
774
@value_to_set.setter
775
def value_to_set(self, value):
776
"""When setting, read data from supplied file object"""
777
self._vts = value.read()
778
value.close()
779
780
781
class MillisecondsPropertyValueArgumentCmd(PropertyValueCmd):
782
"""Abstract class for PropertyValueCmd taking a value argument as
821
783
a datetime.timedelta() but should store it as milliseconds."""
822
784
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"
785
@property
786
def value_to_set(self):
787
return self._vts
788
789
@value_to_set.setter
790
def value_to_set(self, value):
791
"""When setting, convert value from a datetime.timedelta"""
792
self._vts = int(round(value.total_seconds() * 1000))
793
794
795
class SetTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
796
propname = "Timeout"
797
798
799
class SetExtendedTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
800
propname = "ExtendedTimeout"
801
802
803
class SetIntervalCmd(MillisecondsPropertyValueArgumentCmd):
804
propname = "Interval"
805
806
807
class SetApprovalDelayCmd(MillisecondsPropertyValueArgumentCmd):
808
propname = "ApprovalDelay"
809
810
811
class SetApprovalDurationCmd(MillisecondsPropertyValueArgumentCmd):
812
propname = "ApprovalDuration"
851
813
852
814
853
815
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):
816
class Test_string_to_delta(unittest.TestCase):
889
817
def test_handles_basic_rfc3339(self):
890
818
self.assertEqual(string_to_delta("PT0S"),
891
819
datetime.timedelta())
897
825
datetime.timedelta(0, 7200))
898
826
899
827
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")
828
# assertLogs only exists in Python 3.4
829
if hasattr(self, "assertLogs"):
830
with self.assertLogs(log, logging.WARNING):
831
value = string_to_delta("2h")
832
else:
833
class WarningFilter(logging.Filter):
834
"""Don't show, but record the presence of, warnings"""
835
def filter(self, record):
836
is_warning = record.levelno >= logging.WARNING
837
self.found = is_warning or getattr(self, "found",
838
False)
839
return not is_warning
840
warning_filter = WarningFilter()
841
log.addFilter(warning_filter)
842
try:
843
value = string_to_delta("2h")
844
finally:
845
log.removeFilter(warning_filter)
846
self.assertTrue(getattr(warning_filter, "found", False))
902
847
self.assertEqual(value, datetime.timedelta(0, 7200))
903
848
904
849
943
888
@contextlib.contextmanager
944
889
def assertParseError(self):
945
890
with self.assertRaises(SystemExit) as e:
946
with self.redirect_stderr_to_devnull():
891
with self.temporarily_suppress_stderr():
947
892
yield
948
893
# Exit code from argparse is guaranteed to be "2". Reference:
949
894
# https://docs.python.org/3/library
952
897
953
898
@staticmethod
954
899
@contextlib.contextmanager
955
def redirect_stderr_to_devnull():
900
def temporarily_suppress_stderr():
956
901
null = os.open(os.path.devnull, os.O_RDWR)
957
902
stderrcopy = os.dup(sys.stderr.fileno())
958
903
os.dup2(null, sys.stderr.fileno())
967
912
def check_option_syntax(self, options):
968
913
check_option_syntax(self.parser, options)
969
914
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"]
915
def test_actions_conflicts_with_verbose(self):
916
for action, value in self.actions.items():
917
options = self.parser.parse_args()
918
setattr(options, action, value)
919
options.verbose = True
985
920
with self.assertParseError():
986
921
self.check_option_syntax(options)
987
922
1013
948
options.all = True
1014
949
self.check_option_syntax(options)
1015
950
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"]
951
def test_is_enabled_fails_without_client(self):
952
options = self.parser.parse_args()
953
options.is_enabled = True
954
with self.assertParseError():
1021
955
self.check_option_syntax(options)
1022
956
1023
def test_one_client_with_all_actions_except_is_enabled(self):
957
def test_is_enabled_works_with_one_client(self):
1024
958
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)
959
options.is_enabled = True
1029
960
options.client = ["foo"]
1030
961
self.check_option_syntax(options)
1031
962
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
963
def test_is_enabled_fails_with_two_clients(self):
1057
964
options = self.parser.parse_args()
1058
965
options.is_enabled = True
1072
979
self.check_option_syntax(options)
1073
980
1074
981
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
982
class Test_commands_from_options(unittest.TestCase):
1153
983
def setUp(self):
1154
984
self.parser = argparse.ArgumentParser()
1156
986
1157
987
def test_is_enabled(self):
1158
988
self.assert_command_from_args(["--is-enabled", "foo"],
1159
command.IsEnabled)
989
IsEnabledCmd)
1160
990
1161
991
def assert_command_from_args(self, args, command_cls,
1162
992
**cmd_attrs):
1172
1002
self.assertEqual(getattr(command, key), value)
1173
1003
1174
1004
def test_is_enabled_short(self):
1175
self.assert_command_from_args(["-V", "foo"],
1176
command.IsEnabled)
1005
self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
1177
1006
1178
1007
def test_approve(self):
1179
1008
self.assert_command_from_args(["--approve", "foo"],
1180
command.Approve)
1009
ApproveCmd)
1181
1010
1182
1011
def test_approve_short(self):
1183
self.assert_command_from_args(["-A", "foo"], command.Approve)
1012
self.assert_command_from_args(["-A", "foo"], ApproveCmd)
1184
1013
1185
1014
def test_deny(self):
1186
self.assert_command_from_args(["--deny", "foo"], command.Deny)
1015
self.assert_command_from_args(["--deny", "foo"], DenyCmd)
1187
1016
1188
1017
def test_deny_short(self):
1189
self.assert_command_from_args(["-D", "foo"], command.Deny)
1018
self.assert_command_from_args(["-D", "foo"], DenyCmd)
1190
1019
1191
1020
def test_remove(self):
1192
1021
self.assert_command_from_args(["--remove", "foo"],
1193
command.Remove)
1022
RemoveCmd)
1194
1023
1195
1024
def test_deny_before_remove(self):
1196
1025
options = self.parser.parse_args(["--deny", "--remove",
1198
1027
check_option_syntax(self.parser, options)
1199
1028
commands = commands_from_options(options)
1200
1029
self.assertEqual(len(commands), 2)
1201
self.assertIsInstance(commands[0], command.Deny)
1202
self.assertIsInstance(commands[1], command.Remove)
1030
self.assertIsInstance(commands[0], DenyCmd)
1031
self.assertIsInstance(commands[1], RemoveCmd)
1203
1032
1204
1033
def test_deny_before_remove_reversed(self):
1205
1034
options = self.parser.parse_args(["--remove", "--deny",
1207
1036
check_option_syntax(self.parser, options)
1208
1037
commands = commands_from_options(options)
1209
1038
self.assertEqual(len(commands), 2)
1210
self.assertIsInstance(commands[0], command.Deny)
1211
self.assertIsInstance(commands[1], command.Remove)
1039
self.assertIsInstance(commands[0], DenyCmd)
1040
self.assertIsInstance(commands[1], RemoveCmd)
1212
1041
1213
1042
def test_remove_short(self):
1214
self.assert_command_from_args(["-r", "foo"], command.Remove)
1043
self.assert_command_from_args(["-r", "foo"], RemoveCmd)
1215
1044
1216
1045
def test_dump_json(self):
1217
self.assert_command_from_args(["--dump-json"],
1218
command.DumpJSON)
1046
self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
1219
1047
1220
1048
def test_enable(self):
1221
self.assert_command_from_args(["--enable", "foo"],
1222
command.Enable)
1049
self.assert_command_from_args(["--enable", "foo"], EnableCmd)
1223
1050
1224
1051
def test_enable_short(self):
1225
self.assert_command_from_args(["-e", "foo"], command.Enable)
1052
self.assert_command_from_args(["-e", "foo"], EnableCmd)
1226
1053
1227
1054
def test_disable(self):
1228
1055
self.assert_command_from_args(["--disable", "foo"],
1229
command.Disable)
1056
DisableCmd)
1230
1057
1231
1058
def test_disable_short(self):
1232
self.assert_command_from_args(["-d", "foo"], command.Disable)
1059
self.assert_command_from_args(["-d", "foo"], DisableCmd)
1233
1060
1234
1061
def test_bump_timeout(self):
1235
1062
self.assert_command_from_args(["--bump-timeout", "foo"],
1236
command.BumpTimeout)
1063
BumpTimeoutCmd)
1237
1064
1238
1065
def test_bump_timeout_short(self):
1239
self.assert_command_from_args(["-b", "foo"],
1240
command.BumpTimeout)
1066
self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
1241
1067
1242
1068
def test_start_checker(self):
1243
1069
self.assert_command_from_args(["--start-checker", "foo"],
1244
command.StartChecker)
1070
StartCheckerCmd)
1245
1071
1246
1072
def test_stop_checker(self):
1247
1073
self.assert_command_from_args(["--stop-checker", "foo"],
1248
command.StopChecker)
1074
StopCheckerCmd)
1249
1075
1250
1076
def test_approve_by_default(self):
1251
1077
self.assert_command_from_args(["--approve-by-default", "foo"],
1252
command.ApproveByDefault)
1078
ApproveByDefaultCmd)
1253
1079
1254
1080
def test_deny_by_default(self):
1255
1081
self.assert_command_from_args(["--deny-by-default", "foo"],
1256
command.DenyByDefault)
1082
DenyByDefaultCmd)
1257
1083
1258
1084
def test_checker(self):
1259
1085
self.assert_command_from_args(["--checker", ":", "foo"],
1260
command.SetChecker,
1261
value_to_set=":")
1086
SetCheckerCmd, value_to_set=":")
1262
1087
1263
1088
def test_checker_empty(self):
1264
1089
self.assert_command_from_args(["--checker", "", "foo"],
1265
command.SetChecker,
1266
value_to_set="")
1090
SetCheckerCmd, value_to_set="")
1267
1091
1268
1092
def test_checker_short(self):
1269
1093
self.assert_command_from_args(["-c", ":", "foo"],
1270
command.SetChecker,
1271
value_to_set=":")
1094
SetCheckerCmd, value_to_set=":")
1272
1095
1273
1096
def test_host(self):
1274
1097
self.assert_command_from_args(["--host", "foo.example.org",
1275
"foo"], command.SetHost,
1098
"foo"], SetHostCmd,
1276
1099
value_to_set="foo.example.org")
1277
1100
1278
1101
def test_host_short(self):
1279
1102
self.assert_command_from_args(["-H", "foo.example.org",
1280
"foo"], command.SetHost,
1103
"foo"], SetHostCmd,
1281
1104
value_to_set="foo.example.org")
1282
1105
1283
1106
def test_secret_devnull(self):
1284
1107
self.assert_command_from_args(["--secret", os.path.devnull,
1285
"foo"], command.SetSecret,
1108
"foo"], SetSecretCmd,
1286
1109
value_to_set=b"")
1287
1110
1288
1111
def test_secret_tempfile(self):
1291
1114
f.write(value)
1292
1115
f.seek(0)
1293
1116
self.assert_command_from_args(["--secret", f.name,
1294
"foo"], command.SetSecret,
1117
"foo"], SetSecretCmd,
1295
1118
value_to_set=value)
1296
1119
1297
1120
def test_secret_devnull_short(self):
1298
1121
self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1299
command.SetSecret,
1300
value_to_set=b"")
1122
SetSecretCmd, value_to_set=b"")
1301
1123
1302
1124
def test_secret_tempfile_short(self):
1303
1125
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1305
1127
f.write(value)
1306
1128
f.seek(0)
1307
1129
self.assert_command_from_args(["-s", f.name, "foo"],
1308
command.SetSecret,
1130
SetSecretCmd,
1309
1131
value_to_set=value)
1310
1132
1311
1133
def test_timeout(self):
1312
1134
self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1313
command.SetTimeout,
1135
SetTimeoutCmd,
1314
1136
value_to_set=300000)
1315
1137
1316
1138
def test_timeout_short(self):
1317
1139
self.assert_command_from_args(["-t", "PT5M", "foo"],
1318
command.SetTimeout,
1140
SetTimeoutCmd,
1319
1141
value_to_set=300000)
1320
1142
1321
1143
def test_extended_timeout(self):
1322
1144
self.assert_command_from_args(["--extended-timeout", "PT15M",
1323
1145
"foo"],
1324
command.SetExtendedTimeout,
1146
SetExtendedTimeoutCmd,
1325
1147
value_to_set=900000)
1326
1148
1327
1149
def test_interval(self):
1328
1150
self.assert_command_from_args(["--interval", "PT2M", "foo"],
1329
command.SetInterval,
1151
SetIntervalCmd,
1330
1152
value_to_set=120000)
1331
1153
1332
1154
def test_interval_short(self):
1333
1155
self.assert_command_from_args(["-i", "PT2M", "foo"],
1334
command.SetInterval,
1156
SetIntervalCmd,
1335
1157
value_to_set=120000)
1336
1158
1337
1159
def test_approval_delay(self):
1338
1160
self.assert_command_from_args(["--approval-delay", "PT30S",
1339
"foo"],
1340
command.SetApprovalDelay,
1161
"foo"], SetApprovalDelayCmd,
1341
1162
value_to_set=30000)
1342
1163
1343
1164
def test_approval_duration(self):
1344
1165
self.assert_command_from_args(["--approval-duration", "PT1S",
1345
"foo"],
1346
command.SetApprovalDuration,
1166
"foo"], SetApprovalDurationCmd,
1347
1167
value_to_set=1000)
1348
1168
1349
1169
def test_print_table(self):
1350
self.assert_command_from_args([], command.PrintTable,
1170
self.assert_command_from_args([], PrintTableCmd,
1351
1171
verbose=False)
1352
1172
1353
1173
def test_print_table_verbose(self):
1354
self.assert_command_from_args(["--verbose"],
1355
command.PrintTable,
1174
self.assert_command_from_args(["--verbose"], PrintTableCmd,
1356
1175
verbose=True)
1357
1176
1358
1177
def test_print_table_verbose_short(self):
1359
self.assert_command_from_args(["-v"], command.PrintTable,
1178
self.assert_command_from_args(["-v"], PrintTableCmd,
1360
1179
verbose=True)
1361
1180
1362
1181
1363
class TestCommand(unittest.TestCase):
1182
class TestCmd(unittest.TestCase):
1364
1183
"""Abstract class for tests of command classes"""
1365
1184
1366
1185
def setUp(self):
1456
1275
return Bus()
1457
1276
1458
1277
1459
class TestBaseCommands(TestCommand):
1460
1278
class TestIsEnabledCmd(TestCmd):
1461
1279
def test_is_enabled(self):
1462
self.assertTrue(all(command.IsEnabled().is_enabled(client,
1280
self.assertTrue(all(IsEnabledCmd().is_enabled(client,
1463
1281
properties)
1464
1282
for client, properties
1465
1283
in self.clients.items()))
1466
1284
1467
1285
def test_is_enabled_run_exits_successfully(self):
1468
1286
with self.assertRaises(SystemExit) as e:
1469
command.IsEnabled().run(self.one_client)
1287
IsEnabledCmd().run(self.one_client)
1470
1288
if e.exception.code is not None:
1471
1289
self.assertEqual(e.exception.code, 0)
1472
1290
else:
1475
1293
def test_is_enabled_run_exits_with_failure(self):
1476
1294
self.client.attributes["Enabled"] = dbus.Boolean(False)
1477
1295
with self.assertRaises(SystemExit) as e:
1478
command.IsEnabled().run(self.one_client)
1296
IsEnabledCmd().run(self.one_client)
1479
1297
if isinstance(e.exception.code, int):
1480
1298
self.assertNotEqual(e.exception.code, 0)
1481
1299
else:
1482
1300
self.assertIsNotNone(e.exception.code)
1483
1301
1302
1303
class TestApproveCmd(TestCmd):
1484
1304
def test_approve(self):
1485
command.Approve().run(self.clients, self.bus)
1305
ApproveCmd().run(self.clients, self.bus)
1486
1306
for clientpath in self.clients:
1487
1307
client = self.bus.get_object(dbus_busname, clientpath)
1488
1308
self.assertIn(("Approve", (True, client_dbus_interface)),
1489
1309
client.calls)
1490
1310
1311
1312
class TestDenyCmd(TestCmd):
1491
1313
def test_deny(self):
1492
command.Deny().run(self.clients, self.bus)
1314
DenyCmd().run(self.clients, self.bus)
1493
1315
for clientpath in self.clients:
1494
1316
client = self.bus.get_object(dbus_busname, clientpath)
1495
1317
self.assertIn(("Approve", (False, client_dbus_interface)),
1496
1318
client.calls)
1497
1319
1320
1321
class TestRemoveCmd(TestCmd):
1498
1322
def test_remove(self):
1499
1323
class MockMandos(object):
1500
1324
def __init__(self):
1502
1326
def RemoveClient(self, dbus_path):
1503
1327
self.calls.append(("RemoveClient", (dbus_path,)))
1504
1328
mandos = MockMandos()
1505
super(TestBaseCommands, self).setUp()
1506
command.Remove().run(self.clients, self.bus, mandos)
1329
super(TestRemoveCmd, self).setUp()
1330
RemoveCmd().run(self.clients, self.bus, mandos)
1507
1331
self.assertEqual(len(mandos.calls), 2)
1508
1332
for clientpath in self.clients:
1509
1333
self.assertIn(("RemoveClient", (clientpath,)),
1510
1334
mandos.calls)
1511
1335
1512
expected_json = {
1513
"foo": {
1514
"Name": "foo",
1515
"KeyID": ("92ed150794387c03ce684574b1139a65"
1516
"94a34f895daaaf09fd8ea90a27cddb12"),
1517
"Host": "foo.example.org",
1518
"Enabled": True,
1519
"Timeout": 300000,
1520
"LastCheckedOK": "2019-02-03T00:00:00",
1521
"Created": "2019-01-02T00:00:00",
1522
"Interval": 120000,
1523
"Fingerprint": ("778827225BA7DE539C5A"
1524
"7CFA59CFF7CDBD9A5920"),
1525
"CheckerRunning": False,
1526
"LastEnabled": "2019-01-03T00:00:00",
1527
"ApprovalPending": False,
1528
"ApprovedByDefault": True,
1529
"LastApprovalRequest": "",
1530
"ApprovalDelay": 0,
1531
"ApprovalDuration": 1000,
1532
"Checker": "fping -q -- %(host)s",
1533
"ExtendedTimeout": 900000,
1534
"Expires": "2019-02-04T00:00:00",
1535
"LastCheckerStatus": 0,
1536
},
1537
"barbar": {
1538
"Name": "barbar",
1539
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
1540
"6ab612cff5ad227247e46c2b020f441c"),
1541
"Host": "192.0.2.3",
1542
"Enabled": True,
1543
"Timeout": 300000,
1544
"LastCheckedOK": "2019-02-04T00:00:00",
1545
"Created": "2019-01-03T00:00:00",
1546
"Interval": 120000,
1547
"Fingerprint": ("3E393AEAEFB84C7E89E2"
1548
"F547B3A107558FCA3A27"),
1549
"CheckerRunning": True,
1550
"LastEnabled": "2019-01-04T00:00:00",
1551
"ApprovalPending": False,
1552
"ApprovedByDefault": False,
1553
"LastApprovalRequest": "2019-01-03T00:00:00",
1554
"ApprovalDelay": 30000,
1555
"ApprovalDuration": 93785000,
1556
"Checker": ":",
1557
"ExtendedTimeout": 900000,
1558
"Expires": "2019-02-05T00:00:00",
1559
"LastCheckerStatus": -2,
1560
},
1561
}
1562
1563
def test_DumpJSON_normal(self):
1564
output = command.DumpJSON().output(self.clients.values())
1336
1337
class TestDumpJSONCmd(TestCmd):
1338
def setUp(self):
1339
self.expected_json = {
1340
"foo": {
1341
"Name": "foo",
1342
"KeyID": ("92ed150794387c03ce684574b1139a65"
1343
"94a34f895daaaf09fd8ea90a27cddb12"),
1344
"Host": "foo.example.org",
1345
"Enabled": True,
1346
"Timeout": 300000,
1347
"LastCheckedOK": "2019-02-03T00:00:00",
1348
"Created": "2019-01-02T00:00:00",
1349
"Interval": 120000,
1350
"Fingerprint": ("778827225BA7DE539C5A"
1351
"7CFA59CFF7CDBD9A5920"),
1352
"CheckerRunning": False,
1353
"LastEnabled": "2019-01-03T00:00:00",
1354
"ApprovalPending": False,
1355
"ApprovedByDefault": True,
1356
"LastApprovalRequest": "",
1357
"ApprovalDelay": 0,
1358
"ApprovalDuration": 1000,
1359
"Checker": "fping -q -- %(host)s",
1360
"ExtendedTimeout": 900000,
1361
"Expires": "2019-02-04T00:00:00",
1362
"LastCheckerStatus": 0,
1363
},
1364
"barbar": {
1365
"Name": "barbar",
1366
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
1367
"6ab612cff5ad227247e46c2b020f441c"),
1368
"Host": "192.0.2.3",
1369
"Enabled": True,
1370
"Timeout": 300000,
1371
"LastCheckedOK": "2019-02-04T00:00:00",
1372
"Created": "2019-01-03T00:00:00",
1373
"Interval": 120000,
1374
"Fingerprint": ("3E393AEAEFB84C7E89E2"
1375
"F547B3A107558FCA3A27"),
1376
"CheckerRunning": True,
1377
"LastEnabled": "2019-01-04T00:00:00",
1378
"ApprovalPending": False,
1379
"ApprovedByDefault": False,
1380
"LastApprovalRequest": "2019-01-03T00:00:00",
1381
"ApprovalDelay": 30000,
1382
"ApprovalDuration": 93785000,
1383
"Checker": ":",
1384
"ExtendedTimeout": 900000,
1385
"Expires": "2019-02-05T00:00:00",
1386
"LastCheckerStatus": -2,
1387
},
1388
}
1389
return super(TestDumpJSONCmd, self).setUp()
1390
1391
def test_normal(self):
1392
output = DumpJSONCmd().output(self.clients.values())
1565
1393
json_data = json.loads(output)
1566
1394
self.assertDictEqual(json_data, self.expected_json)
1567
1395
1568
def test_DumpJSON_one_client(self):
1569
output = command.DumpJSON().output(self.one_client.values())
1396
def test_one_client(self):
1397
output = DumpJSONCmd().output(self.one_client.values())
1570
1398
json_data = json.loads(output)
1571
1399
expected_json = {"foo": self.expected_json["foo"]}
1572
1400
self.assertDictEqual(json_data, expected_json)
1573
1401
1574
def test_PrintTable_normal(self):
1575
output = command.PrintTable().output(self.clients.values())
1402
1403
class TestPrintTableCmd(TestCmd):
1404
def test_normal(self):
1405
output = PrintTableCmd().output(self.clients.values())
1576
1406
expected_output = "\n".join((
1577
1407
"Name Enabled Timeout Last Successful Check",
1578
1408
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1580
1410
))
1581
1411
self.assertEqual(output, expected_output)
1582
1412
1583
def test_PrintTable_verbose(self):
1584
output = command.PrintTable(verbose=True).output(
1413
def test_verbose(self):
1414
output = PrintTableCmd(verbose=True).output(
1585
1415
self.clients.values())
1586
1416
columns = (
1587
1417
(
1675
1505
for line in range(num_lines))
1676
1506
self.assertEqual(output, expected_output)
1677
1507
1678
def test_PrintTable_one_client(self):
1679
output = command.PrintTable().output(self.one_client.values())
1508
def test_one_client(self):
1509
output = PrintTableCmd().output(self.one_client.values())
1680
1510
expected_output = "\n".join((
1681
1511
"Name Enabled Timeout Last Successful Check",
1682
1512
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1684
1514
self.assertEqual(output, expected_output)
1685
1515
1686
1516
1687
class TestPropertyCmd(TestCommand):
1688
"""Abstract class for tests of command.Property classes"""
1517
class TestPropertyCmd(TestCmd):
1518
"""Abstract class for tests of PropertyCmd classes"""
1689
1519
def runTest(self):
1690
1520
if not hasattr(self, "command"):
1691
1521
return
1714
1544
1715
1545
1716
1546
class TestEnableCmd(TestPropertyCmd):
1717
command = command.Enable
1547
command = EnableCmd
1718
1548
propname = "Enabled"
1719
1549
values_to_set = [dbus.Boolean(True)]
1720
1550
1721
1551
1722
1552
class TestDisableCmd(TestPropertyCmd):
1723
command = command.Disable
1553
command = DisableCmd
1724
1554
propname = "Enabled"
1725
1555
values_to_set = [dbus.Boolean(False)]
1726
1556
1727
1557
1728
1558
class TestBumpTimeoutCmd(TestPropertyCmd):
1729
command = command.BumpTimeout
1559
command = BumpTimeoutCmd
1730
1560
propname = "LastCheckedOK"
1731
1561
values_to_set = [""]
1732
1562
1733
1563
1734
1564
class TestStartCheckerCmd(TestPropertyCmd):
1735
command = command.StartChecker
1565
command = StartCheckerCmd
1736
1566
propname = "CheckerRunning"
1737
1567
values_to_set = [dbus.Boolean(True)]
1738
1568
1739
1569
1740
1570
class TestStopCheckerCmd(TestPropertyCmd):
1741
command = command.StopChecker
1571
command = StopCheckerCmd
1742
1572
propname = "CheckerRunning"
1743
1573
values_to_set = [dbus.Boolean(False)]
1744
1574
1745
1575
1746
1576
class TestApproveByDefaultCmd(TestPropertyCmd):
1747
command = command.ApproveByDefault
1577
command = ApproveByDefaultCmd
1748
1578
propname = "ApprovedByDefault"
1749
1579
values_to_set = [dbus.Boolean(True)]
1750
1580
1751
1581
1752
1582
class TestDenyByDefaultCmd(TestPropertyCmd):
1753
command = command.DenyByDefault
1583
command = DenyByDefaultCmd
1754
1584
propname = "ApprovedByDefault"
1755
1585
values_to_set = [dbus.Boolean(False)]
1756
1586
1768
1598
1769
1599
1770
1600
class TestSetCheckerCmd(TestPropertyValueCmd):
1771
command = command.SetChecker
1601
command = SetCheckerCmd
1772
1602
propname = "Checker"
1773
1603
values_to_set = ["", ":", "fping -q -- %s"]
1774
1604
1775
1605
1776
1606
class TestSetHostCmd(TestPropertyValueCmd):
1777
command = command.SetHost
1607
command = SetHostCmd
1778
1608
propname = "Host"
1779
1609
values_to_set = ["192.0.2.3", "foo.example.org"]
1780
1610
1781
1611
1782
1612
class TestSetSecretCmd(TestPropertyValueCmd):
1783
command = command.SetSecret
1613
command = SetSecretCmd
1784
1614
propname = "Secret"
1785
1615
values_to_set = [io.BytesIO(b""),
1786
1616
io.BytesIO(b"secret\0xyzzy\nbar")]
1788
1618
1789
1619
1790
1620
class TestSetTimeoutCmd(TestPropertyValueCmd):
1791
command = command.SetTimeout
1621
command = SetTimeoutCmd
1792
1622
propname = "Timeout"
1793
1623
values_to_set = [datetime.timedelta(),
1794
1624
datetime.timedelta(minutes=5),
1799
1629
1800
1630
1801
1631
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
1802
command = command.SetExtendedTimeout
1632
command = SetExtendedTimeoutCmd
1803
1633
propname = "ExtendedTimeout"
1804
1634
values_to_set = [datetime.timedelta(),
1805
1635
datetime.timedelta(minutes=5),
1810
1640
1811
1641
1812
1642
class TestSetIntervalCmd(TestPropertyValueCmd):
1813
command = command.SetInterval
1643
command = SetIntervalCmd
1814
1644
propname = "Interval"
1815
1645
values_to_set = [datetime.timedelta(),
1816
1646
datetime.timedelta(minutes=5),
1821
1651
1822
1652
1823
1653
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
1824
command = command.SetApprovalDelay
1654
command = SetApprovalDelayCmd
1825
1655
propname = "ApprovalDelay"
1826
1656
values_to_set = [datetime.timedelta(),
1827
1657
datetime.timedelta(minutes=5),
1832
1662
1833
1663
1834
1664
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
1835
command = command.SetApprovalDuration
1665
command = SetApprovalDurationCmd
1836
1666
propname = "ApprovalDuration"
1837
1667
values_to_set = [datetime.timedelta(),
1838
1668
datetime.timedelta(minutes=5),
1860
1690
return tests
1861
1691
1862
1692
if __name__ == "__main__":
1863
try:
1864
if should_only_run_tests():
1865
# Call using ./tdd-python-script --check [--verbose]
1866
unittest.main()
1867
else:
1868
main()
1869
finally:
1870
logging.shutdown()
1693
if should_only_run_tests():
1694
# Call using ./tdd-python-script --check [--verbose]
1695
unittest.main()
1696
else:
1697
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0