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 1060
- compare with another revision
- download diff
- download tarball
- view history from revision 1060
- Committer: Teddy Hogeborn
- Date: 2019-03-12 21:11:32 UTC
- Revision ID: teddy@recompile.se-20190312211132-q6mxkrybruj3irbn
mandos-ctl: Refactor
* mandos-ctl (Test_check_option_syntax): Reorder methods into logical
order.
(Test_command_from_options): Rename to "Test_commands_from_options",
and reorder methods to match order in
commands_from_options().
* mandos-ctl (Test_check_option_syntax): Reorder methods into logical
order.
(Test_command_from_options): Rename to "Test_commands_from_options",
and reorder methods to match order in
commands_from_options().
- files modified:
- TODO
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
def run(self, clients, bus=None, mandos=None):
581
print(self.output(clients.values()))
582
def output(self, clients):
583
raise NotImplementedError()
584
585
586
class DumpJSONCmd(OutputCmd):
587
def output(self, clients):
588
data = {client["Name"]:
589
{key: self.dbus_boolean_to_bool(client[key])
590
for key in self.all_keywords}
591
for client in clients.values()}
592
return json.dumps(data, indent=4, separators=(',', ': '))
593
@staticmethod
594
def dbus_boolean_to_bool(value):
595
if isinstance(value, dbus.Boolean):
596
value = bool(value)
597
return value
598
599
600
class PrintTableCmd(OutputCmd):
601
def __init__(self, verbose=False):
602
self.verbose = verbose
603
604
def output(self, clients):
605
default_keywords = ("Name", "Enabled", "Timeout",
606
"LastCheckedOK")
607
keywords = default_keywords
608
if self.verbose:
609
keywords = self.all_keywords
610
return str(self.TableOfClients(clients, keywords))
611
612
class TableOfClients(object):
613
tableheaders = {
614
"Name": "Name",
615
"Enabled": "Enabled",
616
"Timeout": "Timeout",
617
"LastCheckedOK": "Last Successful Check",
618
"LastApprovalRequest": "Last Approval Request",
619
"Created": "Created",
620
"Interval": "Interval",
621
"Host": "Host",
622
"Fingerprint": "Fingerprint",
623
"KeyID": "Key ID",
624
"CheckerRunning": "Check Is Running",
625
"LastEnabled": "Last Enabled",
626
"ApprovalPending": "Approval Is Pending",
627
"ApprovedByDefault": "Approved By Default",
628
"ApprovalDelay": "Approval Delay",
629
"ApprovalDuration": "Approval Duration",
630
"Checker": "Checker",
631
"ExtendedTimeout": "Extended Timeout",
632
"Expires": "Expires",
633
"LastCheckerStatus": "Last Checker Status",
634
}
635
636
def __init__(self, clients, keywords, tableheaders=None):
637
self.clients = clients
638
self.keywords = keywords
639
if tableheaders is not None:
640
self.tableheaders = tableheaders
641
642
def __str__(self):
643
return "\n".join(self.rows())
644
645
if sys.version_info.major == 2:
646
__unicode__ = __str__
647
def __str__(self):
648
return str(self).encode(locale.getpreferredencoding())
649
650
def rows(self):
651
format_string = self.row_formatting_string()
652
rows = [self.header_line(format_string)]
653
rows.extend(self.client_line(client, format_string)
654
for client in self.clients)
655
return rows
656
657
def row_formatting_string(self):
658
"Format string used to format table rows"
659
return " ".join("{{{key}:{width}}}".format(
660
width=max(len(self.tableheaders[key]),
661
*(len(self.string_from_client(client, key))
662
for client in self.clients)),
663
key=key)
664
for key in self.keywords)
665
666
def string_from_client(self, client, key):
667
return self.valuetostring(client[key], key)
668
669
@classmethod
670
def valuetostring(cls, value, keyword):
671
if isinstance(value, dbus.Boolean):
672
return "Yes" if value else "No"
673
if keyword in ("Timeout", "Interval", "ApprovalDelay",
674
"ApprovalDuration", "ExtendedTimeout"):
675
return cls.milliseconds_to_string(value)
676
return str(value)
677
678
def header_line(self, format_string):
679
return format_string.format(**self.tableheaders)
680
681
def client_line(self, client, format_string):
682
return format_string.format(
683
**{key: self.string_from_client(client, key)
684
for key in self.keywords})
630
685
631
686
@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
687
def milliseconds_to_string(ms):
688
td = datetime.timedelta(0, 0, 0, ms)
689
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
690
.format(days="{}T".format(td.days)
691
if td.days else "",
692
hours=td.seconds // 3600,
693
minutes=(td.seconds % 3600) // 60,
694
seconds=td.seconds % 60))
695
696
697
class PropertyCmd(Command):
698
"""Abstract class for Actions for setting one client property"""
699
def run_on_one_client(self, client, properties):
700
"""Set the Client's D-Bus property"""
701
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
702
client.__dbus_object_path__,
703
dbus.PROPERTIES_IFACE, client_dbus_interface,
704
self.propname, self.value_to_set
705
if not isinstance(self.value_to_set, dbus.Boolean)
706
else bool(self.value_to_set))
707
client.Set(client_dbus_interface, self.propname,
708
self.value_to_set,
709
dbus_interface=dbus.PROPERTIES_IFACE)
710
@property
711
def propname(self):
712
raise NotImplementedError()
713
714
715
class EnableCmd(PropertyCmd):
716
propname = "Enabled"
717
value_to_set = dbus.Boolean(True)
718
719
720
class DisableCmd(PropertyCmd):
721
propname = "Enabled"
722
value_to_set = dbus.Boolean(False)
723
724
725
class BumpTimeoutCmd(PropertyCmd):
726
propname = "LastCheckedOK"
727
value_to_set = ""
728
729
730
class StartCheckerCmd(PropertyCmd):
731
propname = "CheckerRunning"
732
value_to_set = dbus.Boolean(True)
733
734
735
class StopCheckerCmd(PropertyCmd):
736
propname = "CheckerRunning"
737
value_to_set = dbus.Boolean(False)
738
739
740
class ApproveByDefaultCmd(PropertyCmd):
741
propname = "ApprovedByDefault"
742
value_to_set = dbus.Boolean(True)
743
744
745
class DenyByDefaultCmd(PropertyCmd):
746
propname = "ApprovedByDefault"
747
value_to_set = dbus.Boolean(False)
748
749
750
class PropertyValueCmd(PropertyCmd):
751
"""Abstract class for PropertyCmd recieving a value as argument"""
752
def __init__(self, value):
753
self.value_to_set = value
754
755
756
class SetCheckerCmd(PropertyValueCmd):
757
propname = "Checker"
758
759
760
class SetHostCmd(PropertyValueCmd):
761
propname = "Host"
762
763
764
class SetSecretCmd(PropertyValueCmd):
765
propname = "Secret"
766
@property
767
def value_to_set(self):
768
return self._vts
769
@value_to_set.setter
770
def value_to_set(self, value):
771
"""When setting, read data from supplied file object"""
772
self._vts = value.read()
773
value.close()
774
775
776
class MillisecondsPropertyValueArgumentCmd(PropertyValueCmd):
777
"""Abstract class for PropertyValueCmd taking a value argument as
821
778
a datetime.timedelta() but should store it as milliseconds."""
822
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"
779
@property
780
def value_to_set(self):
781
return self._vts
782
@value_to_set.setter
783
def value_to_set(self, value):
784
"""When setting, convert value from a datetime.timedelta"""
785
self._vts = int(round(value.total_seconds() * 1000))
786
787
788
class SetTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
789
propname = "Timeout"
790
791
792
class SetExtendedTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
793
propname = "ExtendedTimeout"
794
795
796
class SetIntervalCmd(MillisecondsPropertyValueArgumentCmd):
797
propname = "Interval"
798
799
800
class SetApprovalDelayCmd(MillisecondsPropertyValueArgumentCmd):
801
propname = "ApprovalDelay"
802
803
804
class SetApprovalDurationCmd(MillisecondsPropertyValueArgumentCmd):
805
propname = "ApprovalDuration"
851
806
852
807
853
808
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):
889
# Just test basic RFC 3339 functionality here, the doc string for
890
# rfc3339_duration_to_delta() already has more comprehensive
891
# tests, which is run by doctest.
892
893
def test_rfc3339_zero_seconds(self):
809
class Test_string_to_delta(unittest.TestCase):
810
def test_handles_basic_rfc3339(self):
894
811
self.assertEqual(string_to_delta("PT0S"),
895
812
datetime.timedelta())
896
897
def test_rfc3339_zero_days(self):
898
813
self.assertEqual(string_to_delta("P0D"),
899
814
datetime.timedelta())
900
901
def test_rfc3339_one_second(self):
902
815
self.assertEqual(string_to_delta("PT1S"),
903
816
datetime.timedelta(0, 1))
904
905
def test_rfc3339_two_hours(self):
906
817
self.assertEqual(string_to_delta("PT2H"),
907
818
datetime.timedelta(0, 7200))
908
909
819
def test_falls_back_to_pre_1_6_1_with_warning(self):
910
with self.assertLogs(log, logging.WARNING):
911
value = string_to_delta("2h")
820
# assertLogs only exists in Python 3.4
821
if hasattr(self, "assertLogs"):
822
with self.assertLogs(log, logging.WARNING):
823
value = string_to_delta("2h")
824
else:
825
class WarningFilter(logging.Filter):
826
"""Don't show, but record the presence of, warnings"""
827
def filter(self, record):
828
is_warning = record.levelno >= logging.WARNING
829
self.found = is_warning or getattr(self, "found",
830
False)
831
return not is_warning
832
warning_filter = WarningFilter()
833
log.addFilter(warning_filter)
834
try:
835
value = string_to_delta("2h")
836
finally:
837
log.removeFilter(warning_filter)
838
self.assertTrue(getattr(warning_filter, "found", False))
912
839
self.assertEqual(value, datetime.timedelta(0, 7200))
913
840
914
841
953
880
@contextlib.contextmanager
954
881
def assertParseError(self):
955
882
with self.assertRaises(SystemExit) as e:
956
with self.redirect_stderr_to_devnull():
883
with self.temporarily_suppress_stderr():
957
884
yield
958
885
# Exit code from argparse is guaranteed to be "2". Reference:
959
886
# https://docs.python.org/3/library
962
889
963
890
@staticmethod
964
891
@contextlib.contextmanager
965
def redirect_stderr_to_devnull():
892
def temporarily_suppress_stderr():
966
893
null = os.open(os.path.devnull, os.O_RDWR)
967
894
stderrcopy = os.dup(sys.stderr.fileno())
968
895
os.dup2(null, sys.stderr.fileno())
977
904
def check_option_syntax(self, options):
978
905
check_option_syntax(self.parser, options)
979
906
980
def test_actions_all_conflicts_with_verbose(self):
981
for action, value in self.actions.items():
982
options = self.parser.parse_args()
983
setattr(options, action, value)
984
options.all = True
985
options.verbose = True
986
with self.assertParseError():
987
self.check_option_syntax(options)
988
989
def test_actions_with_client_conflicts_with_verbose(self):
990
for action, value in self.actions.items():
991
options = self.parser.parse_args()
992
setattr(options, action, value)
993
options.verbose = True
994
options.client = ["foo"]
907
def test_actions_conflicts_with_verbose(self):
908
for action, value in self.actions.items():
909
options = self.parser.parse_args()
910
setattr(options, action, value)
911
options.verbose = True
995
912
with self.assertParseError():
996
913
self.check_option_syntax(options)
997
914
1023
940
options.all = True
1024
941
self.check_option_syntax(options)
1025
942
1026
def test_any_action_is_ok_with_one_client(self):
1027
for action, value in self.actions.items():
1028
options = self.parser.parse_args()
1029
setattr(options, action, value)
1030
options.client = ["foo"]
943
def test_is_enabled_fails_without_client(self):
944
options = self.parser.parse_args()
945
options.is_enabled = True
946
with self.assertParseError():
1031
947
self.check_option_syntax(options)
1032
948
1033
def test_one_client_with_all_actions_except_is_enabled(self):
949
def test_is_enabled_works_with_one_client(self):
1034
950
options = self.parser.parse_args()
1035
for action, value in self.actions.items():
1036
if action == "is_enabled":
1037
continue
1038
setattr(options, action, value)
951
options.is_enabled = True
1039
952
options.client = ["foo"]
1040
953
self.check_option_syntax(options)
1041
954
1042
def test_two_clients_with_all_actions_except_is_enabled(self):
1043
options = self.parser.parse_args()
1044
for action, value in self.actions.items():
1045
if action == "is_enabled":
1046
continue
1047
setattr(options, action, value)
1048
options.client = ["foo", "barbar"]
1049
self.check_option_syntax(options)
1050
1051
def test_two_clients_are_ok_with_actions_except_is_enabled(self):
1052
for action, value in self.actions.items():
1053
if action == "is_enabled":
1054
continue
1055
options = self.parser.parse_args()
1056
setattr(options, action, value)
1057
options.client = ["foo", "barbar"]
1058
self.check_option_syntax(options)
1059
1060
def test_is_enabled_fails_without_client(self):
1061
options = self.parser.parse_args()
1062
options.is_enabled = True
1063
with self.assertParseError():
1064
self.check_option_syntax(options)
1065
1066
955
def test_is_enabled_fails_with_two_clients(self):
1067
956
options = self.parser.parse_args()
1068
957
options.is_enabled = True
1082
971
self.check_option_syntax(options)
1083
972
1084
973
1085
class Test_get_mandos_dbus_object(TestCaseWithAssertLogs):
1086
def test_calls_and_returns_get_object_on_bus(self):
1087
class MockBus(object):
1088
called = False
1089
def get_object(mockbus_self, busname, dbus_path):
1090
# Note that "self" is still the testcase instance,
1091
# this MockBus instance is in "mockbus_self".
1092
self.assertEqual(busname, dbus_busname)
1093
self.assertEqual(dbus_path, server_dbus_path)
1094
mockbus_self.called = True
1095
return mockbus_self
1096
1097
mockbus = get_mandos_dbus_object(bus=MockBus())
1098
self.assertIsInstance(mockbus, MockBus)
1099
self.assertTrue(mockbus.called)
1100
1101
def test_logs_and_exits_on_dbus_error(self):
1102
class MockBusFailing(object):
1103
def get_object(self, busname, dbus_path):
1104
raise dbus.exceptions.DBusException("Test")
1105
1106
with self.assertLogs(log, logging.CRITICAL):
1107
with self.assertRaises(SystemExit) as e:
1108
bus = get_mandos_dbus_object(bus=MockBusFailing())
1109
1110
if isinstance(e.exception.code, int):
1111
self.assertNotEqual(e.exception.code, 0)
1112
else:
1113
self.assertIsNotNone(e.exception.code)
1114
1115
1116
class Test_get_managed_objects(TestCaseWithAssertLogs):
1117
def test_calls_and_returns_GetManagedObjects(self):
1118
managed_objects = {"/clients/foo": { "Name": "foo"}}
1119
class MockObjectManager(object):
1120
def GetManagedObjects(self):
1121
return managed_objects
1122
retval = get_managed_objects(MockObjectManager())
1123
self.assertDictEqual(managed_objects, retval)
1124
1125
def test_logs_and_exits_on_dbus_error(self):
1126
dbus_logger = logging.getLogger("dbus.proxies")
1127
1128
class MockObjectManagerFailing(object):
1129
def GetManagedObjects(self):
1130
dbus_logger.error("Test")
1131
raise dbus.exceptions.DBusException("Test")
1132
1133
class CountingHandler(logging.Handler):
1134
count = 0
1135
def emit(self, record):
1136
self.count += 1
1137
1138
counting_handler = CountingHandler()
1139
1140
dbus_logger.addHandler(counting_handler)
1141
1142
try:
1143
with self.assertLogs(log, logging.CRITICAL) as watcher:
1144
with self.assertRaises(SystemExit) as e:
1145
get_managed_objects(MockObjectManagerFailing())
1146
finally:
1147
dbus_logger.removeFilter(counting_handler)
1148
1149
# Make sure the dbus logger was suppressed
1150
self.assertEqual(counting_handler.count, 0)
1151
1152
# Test that the dbus_logger still works
1153
with self.assertLogs(dbus_logger, logging.ERROR):
1154
dbus_logger.error("Test")
1155
1156
if isinstance(e.exception.code, int):
1157
self.assertNotEqual(e.exception.code, 0)
1158
else:
1159
self.assertIsNotNone(e.exception.code)
1160
1161
1162
974
class Test_commands_from_options(unittest.TestCase):
1163
975
def setUp(self):
1164
976
self.parser = argparse.ArgumentParser()
1166
978
1167
979
def test_is_enabled(self):
1168
980
self.assert_command_from_args(["--is-enabled", "foo"],
1169
command.IsEnabled)
981
IsEnabledCmd)
1170
982
1171
983
def assert_command_from_args(self, args, command_cls,
1172
984
**cmd_attrs):
1182
994
self.assertEqual(getattr(command, key), value)
1183
995
1184
996
def test_is_enabled_short(self):
1185
self.assert_command_from_args(["-V", "foo"],
1186
command.IsEnabled)
997
self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
1187
998
1188
999
def test_approve(self):
1189
1000
self.assert_command_from_args(["--approve", "foo"],
1190
command.Approve)
1001
ApproveCmd)
1191
1002
1192
1003
def test_approve_short(self):
1193
self.assert_command_from_args(["-A", "foo"], command.Approve)
1004
self.assert_command_from_args(["-A", "foo"], ApproveCmd)
1194
1005
1195
1006
def test_deny(self):
1196
self.assert_command_from_args(["--deny", "foo"], command.Deny)
1007
self.assert_command_from_args(["--deny", "foo"], DenyCmd)
1197
1008
1198
1009
def test_deny_short(self):
1199
self.assert_command_from_args(["-D", "foo"], command.Deny)
1010
self.assert_command_from_args(["-D", "foo"], DenyCmd)
1200
1011
1201
1012
def test_remove(self):
1202
1013
self.assert_command_from_args(["--remove", "foo"],
1203
command.Remove)
1014
RemoveCmd)
1204
1015
1205
1016
def test_deny_before_remove(self):
1206
1017
options = self.parser.parse_args(["--deny", "--remove",
1208
1019
check_option_syntax(self.parser, options)
1209
1020
commands = commands_from_options(options)
1210
1021
self.assertEqual(len(commands), 2)
1211
self.assertIsInstance(commands[0], command.Deny)
1212
self.assertIsInstance(commands[1], command.Remove)
1022
self.assertIsInstance(commands[0], DenyCmd)
1023
self.assertIsInstance(commands[1], RemoveCmd)
1213
1024
1214
1025
def test_deny_before_remove_reversed(self):
1215
1026
options = self.parser.parse_args(["--remove", "--deny",
1217
1028
check_option_syntax(self.parser, options)
1218
1029
commands = commands_from_options(options)
1219
1030
self.assertEqual(len(commands), 2)
1220
self.assertIsInstance(commands[0], command.Deny)
1221
self.assertIsInstance(commands[1], command.Remove)
1031
self.assertIsInstance(commands[0], DenyCmd)
1032
self.assertIsInstance(commands[1], RemoveCmd)
1222
1033
1223
1034
def test_remove_short(self):
1224
self.assert_command_from_args(["-r", "foo"], command.Remove)
1035
self.assert_command_from_args(["-r", "foo"], RemoveCmd)
1225
1036
1226
1037
def test_dump_json(self):
1227
self.assert_command_from_args(["--dump-json"],
1228
command.DumpJSON)
1038
self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
1229
1039
1230
1040
def test_enable(self):
1231
self.assert_command_from_args(["--enable", "foo"],
1232
command.Enable)
1041
self.assert_command_from_args(["--enable", "foo"], EnableCmd)
1233
1042
1234
1043
def test_enable_short(self):
1235
self.assert_command_from_args(["-e", "foo"], command.Enable)
1044
self.assert_command_from_args(["-e", "foo"], EnableCmd)
1236
1045
1237
1046
def test_disable(self):
1238
1047
self.assert_command_from_args(["--disable", "foo"],
1239
command.Disable)
1048
DisableCmd)
1240
1049
1241
1050
def test_disable_short(self):
1242
self.assert_command_from_args(["-d", "foo"], command.Disable)
1051
self.assert_command_from_args(["-d", "foo"], DisableCmd)
1243
1052
1244
1053
def test_bump_timeout(self):
1245
1054
self.assert_command_from_args(["--bump-timeout", "foo"],
1246
command.BumpTimeout)
1055
BumpTimeoutCmd)
1247
1056
1248
1057
def test_bump_timeout_short(self):
1249
self.assert_command_from_args(["-b", "foo"],
1250
command.BumpTimeout)
1058
self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
1251
1059
1252
1060
def test_start_checker(self):
1253
1061
self.assert_command_from_args(["--start-checker", "foo"],
1254
command.StartChecker)
1062
StartCheckerCmd)
1255
1063
1256
1064
def test_stop_checker(self):
1257
1065
self.assert_command_from_args(["--stop-checker", "foo"],
1258
command.StopChecker)
1066
StopCheckerCmd)
1259
1067
1260
1068
def test_approve_by_default(self):
1261
1069
self.assert_command_from_args(["--approve-by-default", "foo"],
1262
command.ApproveByDefault)
1070
ApproveByDefaultCmd)
1263
1071
1264
1072
def test_deny_by_default(self):
1265
1073
self.assert_command_from_args(["--deny-by-default", "foo"],
1266
command.DenyByDefault)
1074
DenyByDefaultCmd)
1267
1075
1268
1076
def test_checker(self):
1269
1077
self.assert_command_from_args(["--checker", ":", "foo"],
1270
command.SetChecker,
1271
value_to_set=":")
1078
SetCheckerCmd, value_to_set=":")
1272
1079
1273
1080
def test_checker_empty(self):
1274
1081
self.assert_command_from_args(["--checker", "", "foo"],
1275
command.SetChecker,
1276
value_to_set="")
1082
SetCheckerCmd, value_to_set="")
1277
1083
1278
1084
def test_checker_short(self):
1279
1085
self.assert_command_from_args(["-c", ":", "foo"],
1280
command.SetChecker,
1281
value_to_set=":")
1086
SetCheckerCmd, value_to_set=":")
1282
1087
1283
1088
def test_host(self):
1284
1089
self.assert_command_from_args(["--host", "foo.example.org",
1285
"foo"], command.SetHost,
1090
"foo"], SetHostCmd,
1286
1091
value_to_set="foo.example.org")
1287
1092
1288
1093
def test_host_short(self):
1289
1094
self.assert_command_from_args(["-H", "foo.example.org",
1290
"foo"], command.SetHost,
1095
"foo"], SetHostCmd,
1291
1096
value_to_set="foo.example.org")
1292
1097
1293
1098
def test_secret_devnull(self):
1294
1099
self.assert_command_from_args(["--secret", os.path.devnull,
1295
"foo"], command.SetSecret,
1100
"foo"], SetSecretCmd,
1296
1101
value_to_set=b"")
1297
1102
1298
1103
def test_secret_tempfile(self):
1301
1106
f.write(value)
1302
1107
f.seek(0)
1303
1108
self.assert_command_from_args(["--secret", f.name,
1304
"foo"], command.SetSecret,
1109
"foo"], SetSecretCmd,
1305
1110
value_to_set=value)
1306
1111
1307
1112
def test_secret_devnull_short(self):
1308
1113
self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1309
command.SetSecret,
1310
value_to_set=b"")
1114
SetSecretCmd, value_to_set=b"")
1311
1115
1312
1116
def test_secret_tempfile_short(self):
1313
1117
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1315
1119
f.write(value)
1316
1120
f.seek(0)
1317
1121
self.assert_command_from_args(["-s", f.name, "foo"],
1318
command.SetSecret,
1122
SetSecretCmd,
1319
1123
value_to_set=value)
1320
1124
1321
1125
def test_timeout(self):
1322
1126
self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1323
command.SetTimeout,
1127
SetTimeoutCmd,
1324
1128
value_to_set=300000)
1325
1129
1326
1130
def test_timeout_short(self):
1327
1131
self.assert_command_from_args(["-t", "PT5M", "foo"],
1328
command.SetTimeout,
1132
SetTimeoutCmd,
1329
1133
value_to_set=300000)
1330
1134
1331
1135
def test_extended_timeout(self):
1332
1136
self.assert_command_from_args(["--extended-timeout", "PT15M",
1333
1137
"foo"],
1334
command.SetExtendedTimeout,
1138
SetExtendedTimeoutCmd,
1335
1139
value_to_set=900000)
1336
1140
1337
1141
def test_interval(self):
1338
1142
self.assert_command_from_args(["--interval", "PT2M", "foo"],
1339
command.SetInterval,
1143
SetIntervalCmd,
1340
1144
value_to_set=120000)
1341
1145
1342
1146
def test_interval_short(self):
1343
1147
self.assert_command_from_args(["-i", "PT2M", "foo"],
1344
command.SetInterval,
1148
SetIntervalCmd,
1345
1149
value_to_set=120000)
1346
1150
1347
1151
def test_approval_delay(self):
1348
1152
self.assert_command_from_args(["--approval-delay", "PT30S",
1349
"foo"],
1350
command.SetApprovalDelay,
1153
"foo"], SetApprovalDelayCmd,
1351
1154
value_to_set=30000)
1352
1155
1353
1156
def test_approval_duration(self):
1354
1157
self.assert_command_from_args(["--approval-duration", "PT1S",
1355
"foo"],
1356
command.SetApprovalDuration,
1158
"foo"], SetApprovalDurationCmd,
1357
1159
value_to_set=1000)
1358
1160
1359
1161
def test_print_table(self):
1360
self.assert_command_from_args([], command.PrintTable,
1162
self.assert_command_from_args([], PrintTableCmd,
1361
1163
verbose=False)
1362
1164
1363
1165
def test_print_table_verbose(self):
1364
self.assert_command_from_args(["--verbose"],
1365
command.PrintTable,
1166
self.assert_command_from_args(["--verbose"], PrintTableCmd,
1366
1167
verbose=True)
1367
1168
1368
1169
def test_print_table_verbose_short(self):
1369
self.assert_command_from_args(["-v"], command.PrintTable,
1170
self.assert_command_from_args(["-v"], PrintTableCmd,
1370
1171
verbose=True)
1371
1172
1372
1173
1373
class TestCommand(unittest.TestCase):
1174
class TestCmd(unittest.TestCase):
1374
1175
"""Abstract class for tests of command classes"""
1375
1376
1176
def setUp(self):
1377
1177
testcase = self
1378
1178
class MockClient(object):
1386
1186
testcase.assertEqual(dbus_interface,
1387
1187
dbus.PROPERTIES_IFACE)
1388
1188
self.attributes[propname] = value
1189
def Get(self, interface, propname, dbus_interface):
1190
testcase.assertEqual(interface, client_dbus_interface)
1191
testcase.assertEqual(dbus_interface,
1192
dbus.PROPERTIES_IFACE)
1193
return self.attributes[propname]
1389
1194
def Approve(self, approve, dbus_interface):
1390
1195
testcase.assertEqual(dbus_interface,
1391
1196
client_dbus_interface)
1445
1250
("/clients/barbar", self.other_client.attributes),
1446
1251
])
1447
1252
self.one_client = {"/clients/foo": self.client.attributes}
1448
1449
1253
@property
1450
1254
def bus(self):
1451
1255
class Bus(object):
1453
1257
def get_object(client_bus_name, path):
1454
1258
self.assertEqual(client_bus_name, dbus_busname)
1455
1259
return {
1456
# Note: "self" here is the TestCmd instance, not
1457
# the Bus instance, since this is a static method!
1458
1260
"/clients/foo": self.client,
1459
1261
"/clients/barbar": self.other_client,
1460
1262
}[path]
1461
1263
return Bus()
1462
1264
1463
1265
1464
class TestBaseCommands(TestCommand):
1465
1466
def test_IsEnabled(self):
1467
self.assertTrue(all(command.IsEnabled().is_enabled(client,
1266
class TestIsEnabledCmd(TestCmd):
1267
def test_is_enabled(self):
1268
self.assertTrue(all(IsEnabledCmd().is_enabled(client,
1468
1269
properties)
1469
1270
for client, properties
1470
1271
in self.clients.items()))
1471
1472
def test_IsEnabled_run_exits_successfully(self):
1272
def test_is_enabled_run_exits_successfully(self):
1473
1273
with self.assertRaises(SystemExit) as e:
1474
command.IsEnabled().run(self.one_client)
1274
IsEnabledCmd().run(self.one_client)
1475
1275
if e.exception.code is not None:
1476
1276
self.assertEqual(e.exception.code, 0)
1477
1277
else:
1478
1278
self.assertIsNone(e.exception.code)
1479
1480
def test_IsEnabled_run_exits_with_failure(self):
1279
def test_is_enabled_run_exits_with_failure(self):
1481
1280
self.client.attributes["Enabled"] = dbus.Boolean(False)
1482
1281
with self.assertRaises(SystemExit) as e:
1483
command.IsEnabled().run(self.one_client)
1282
IsEnabledCmd().run(self.one_client)
1484
1283
if isinstance(e.exception.code, int):
1485
1284
self.assertNotEqual(e.exception.code, 0)
1486
1285
else:
1487
1286
self.assertIsNotNone(e.exception.code)
1488
1287
1489
def test_Approve(self):
1490
command.Approve().run(self.clients, self.bus)
1288
1289
class TestApproveCmd(TestCmd):
1290
def test_approve(self):
1291
ApproveCmd().run(self.clients, self.bus)
1491
1292
for clientpath in self.clients:
1492
1293
client = self.bus.get_object(dbus_busname, clientpath)
1493
1294
self.assertIn(("Approve", (True, client_dbus_interface)),
1494
1295
client.calls)
1495
1296
1496
def test_Deny(self):
1497
command.Deny().run(self.clients, self.bus)
1297
1298
class TestDenyCmd(TestCmd):
1299
def test_deny(self):
1300
DenyCmd().run(self.clients, self.bus)
1498
1301
for clientpath in self.clients:
1499
1302
client = self.bus.get_object(dbus_busname, clientpath)
1500
1303
self.assertIn(("Approve", (False, client_dbus_interface)),
1501
1304
client.calls)
1502
1305
1503
def test_Remove(self):
1306
class TestRemoveCmd(TestCmd):
1307
def test_remove(self):
1504
1308
class MockMandos(object):
1505
1309
def __init__(self):
1506
1310
self.calls = []
1507
1311
def RemoveClient(self, dbus_path):
1508
1312
self.calls.append(("RemoveClient", (dbus_path,)))
1509
1313
mandos = MockMandos()
1510
command.Remove().run(self.clients, self.bus, mandos)
1314
super(TestRemoveCmd, self).setUp()
1315
RemoveCmd().run(self.clients, self.bus, mandos)
1316
self.assertEqual(len(mandos.calls), 2)
1511
1317
for clientpath in self.clients:
1512
1318
self.assertIn(("RemoveClient", (clientpath,)),
1513
1319
mandos.calls)
1514
1320
1515
expected_json = {
1516
"foo": {
1517
"Name": "foo",
1518
"KeyID": ("92ed150794387c03ce684574b1139a65"
1519
"94a34f895daaaf09fd8ea90a27cddb12"),
1520
"Host": "foo.example.org",
1521
"Enabled": True,
1522
"Timeout": 300000,
1523
"LastCheckedOK": "2019-02-03T00:00:00",
1524
"Created": "2019-01-02T00:00:00",
1525
"Interval": 120000,
1526
"Fingerprint": ("778827225BA7DE539C5A"
1527
"7CFA59CFF7CDBD9A5920"),
1528
"CheckerRunning": False,
1529
"LastEnabled": "2019-01-03T00:00:00",
1530
"ApprovalPending": False,
1531
"ApprovedByDefault": True,
1532
"LastApprovalRequest": "",
1533
"ApprovalDelay": 0,
1534
"ApprovalDuration": 1000,
1535
"Checker": "fping -q -- %(host)s",
1536
"ExtendedTimeout": 900000,
1537
"Expires": "2019-02-04T00:00:00",
1538
"LastCheckerStatus": 0,
1539
},
1540
"barbar": {
1541
"Name": "barbar",
1542
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
1543
"6ab612cff5ad227247e46c2b020f441c"),
1544
"Host": "192.0.2.3",
1545
"Enabled": True,
1546
"Timeout": 300000,
1547
"LastCheckedOK": "2019-02-04T00:00:00",
1548
"Created": "2019-01-03T00:00:00",
1549
"Interval": 120000,
1550
"Fingerprint": ("3E393AEAEFB84C7E89E2"
1551
"F547B3A107558FCA3A27"),
1552
"CheckerRunning": True,
1553
"LastEnabled": "2019-01-04T00:00:00",
1554
"ApprovalPending": False,
1555
"ApprovedByDefault": False,
1556
"LastApprovalRequest": "2019-01-03T00:00:00",
1557
"ApprovalDelay": 30000,
1558
"ApprovalDuration": 93785000,
1559
"Checker": ":",
1560
"ExtendedTimeout": 900000,
1561
"Expires": "2019-02-05T00:00:00",
1562
"LastCheckerStatus": -2,
1563
},
1564
}
1565
1321
1566
def test_DumpJSON_normal(self):
1567
output = command.DumpJSON().output(self.clients.values())
1568
json_data = json.loads(output)
1322
class TestDumpJSONCmd(TestCmd):
1323
def setUp(self):
1324
self.expected_json = {
1325
"foo": {
1326
"Name": "foo",
1327
"KeyID": ("92ed150794387c03ce684574b1139a65"
1328
"94a34f895daaaf09fd8ea90a27cddb12"),
1329
"Host": "foo.example.org",
1330
"Enabled": True,
1331
"Timeout": 300000,
1332
"LastCheckedOK": "2019-02-03T00:00:00",
1333
"Created": "2019-01-02T00:00:00",
1334
"Interval": 120000,
1335
"Fingerprint": ("778827225BA7DE539C5A"
1336
"7CFA59CFF7CDBD9A5920"),
1337
"CheckerRunning": False,
1338
"LastEnabled": "2019-01-03T00:00:00",
1339
"ApprovalPending": False,
1340
"ApprovedByDefault": True,
1341
"LastApprovalRequest": "",
1342
"ApprovalDelay": 0,
1343
"ApprovalDuration": 1000,
1344
"Checker": "fping -q -- %(host)s",
1345
"ExtendedTimeout": 900000,
1346
"Expires": "2019-02-04T00:00:00",
1347
"LastCheckerStatus": 0,
1348
},
1349
"barbar": {
1350
"Name": "barbar",
1351
"KeyID": ("0558568eedd67d622f5c83b35a115f79"
1352
"6ab612cff5ad227247e46c2b020f441c"),
1353
"Host": "192.0.2.3",
1354
"Enabled": True,
1355
"Timeout": 300000,
1356
"LastCheckedOK": "2019-02-04T00:00:00",
1357
"Created": "2019-01-03T00:00:00",
1358
"Interval": 120000,
1359
"Fingerprint": ("3E393AEAEFB84C7E89E2"
1360
"F547B3A107558FCA3A27"),
1361
"CheckerRunning": True,
1362
"LastEnabled": "2019-01-04T00:00:00",
1363
"ApprovalPending": False,
1364
"ApprovedByDefault": False,
1365
"LastApprovalRequest": "2019-01-03T00:00:00",
1366
"ApprovalDelay": 30000,
1367
"ApprovalDuration": 93785000,
1368
"Checker": ":",
1369
"ExtendedTimeout": 900000,
1370
"Expires": "2019-02-05T00:00:00",
1371
"LastCheckerStatus": -2,
1372
},
1373
}
1374
return super(TestDumpJSONCmd, self).setUp()
1375
def test_normal(self):
1376
json_data = json.loads(DumpJSONCmd().output(self.clients))
1569
1377
self.assertDictEqual(json_data, self.expected_json)
1570
1571
def test_DumpJSON_one_client(self):
1572
output = command.DumpJSON().output(self.one_client.values())
1573
json_data = json.loads(output)
1378
def test_one_client(self):
1379
clients = self.one_client
1380
json_data = json.loads(DumpJSONCmd().output(clients))
1574
1381
expected_json = {"foo": self.expected_json["foo"]}
1575
1382
self.assertDictEqual(json_data, expected_json)
1576
1383
1577
def test_PrintTable_normal(self):
1578
output = command.PrintTable().output(self.clients.values())
1384
1385
class TestPrintTableCmd(TestCmd):
1386
def test_normal(self):
1387
output = PrintTableCmd().output(self.clients.values())
1579
1388
expected_output = "\n".join((
1580
1389
"Name Enabled Timeout Last Successful Check",
1581
1390
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1582
1391
"barbar Yes 00:05:00 2019-02-04T00:00:00 ",
1583
1392
))
1584
1393
self.assertEqual(output, expected_output)
1585
1586
def test_PrintTable_verbose(self):
1587
output = command.PrintTable(verbose=True).output(
1394
def test_verbose(self):
1395
output = PrintTableCmd(verbose=True).output(
1588
1396
self.clients.values())
1589
1397
columns = (
1590
1398
(
1677
1485
for rows in columns)
1678
1486
for line in range(num_lines))
1679
1487
self.assertEqual(output, expected_output)
1680
1681
def test_PrintTable_one_client(self):
1682
output = command.PrintTable().output(self.one_client.values())
1488
def test_one_client(self):
1489
output = PrintTableCmd().output(self.one_client.values())
1683
1490
expected_output = "\n".join((
1684
1491
"Name Enabled Timeout Last Successful Check",
1685
1492
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1687
1494
self.assertEqual(output, expected_output)
1688
1495
1689
1496
1690
class TestPropertyCmd(TestCommand):
1691
"""Abstract class for tests of command.Property classes"""
1497
class Unique(object):
1498
"""Class for objects which exist only to be unique objects, since
1499
unittest.mock.sentinel only exists in Python 3.3"""
1500
1501
1502
class TestPropertyCmd(TestCmd):
1503
"""Abstract class for tests of PropertyCmd classes"""
1692
1504
def runTest(self):
1693
1505
if not hasattr(self, "command"):
1694
1506
return
1699
1511
for clientpath in self.clients:
1700
1512
client = self.bus.get_object(dbus_busname, clientpath)
1701
1513
old_value = client.attributes[self.propname]
1702
client.attributes[self.propname] = self.Unique()
1514
self.assertNotIsInstance(old_value, Unique)
1515
client.attributes[self.propname] = Unique()
1703
1516
self.run_command(value_to_set, self.clients)
1704
1517
for clientpath in self.clients:
1705
1518
client = self.bus.get_object(dbus_busname, clientpath)
1706
1519
value = client.attributes[self.propname]
1707
self.assertNotIsInstance(value, self.Unique)
1520
self.assertNotIsInstance(value, Unique)
1708
1521
self.assertEqual(value, value_to_get)
1709
1710
class Unique(object):
1711
"""Class for objects which exist only to be unique objects,
1712
since unittest.mock.sentinel only exists in Python 3.3"""
1713
1714
1522
def run_command(self, value, clients):
1715
1523
self.command().run(clients, self.bus)
1716
1524
1717
1525
1718
1526
class TestEnableCmd(TestPropertyCmd):
1719
command = command.Enable
1527
command = EnableCmd
1720
1528
propname = "Enabled"
1721
1529
values_to_set = [dbus.Boolean(True)]
1722
1530
1723
1531
1724
1532
class TestDisableCmd(TestPropertyCmd):
1725
command = command.Disable
1533
command = DisableCmd
1726
1534
propname = "Enabled"
1727
1535
values_to_set = [dbus.Boolean(False)]
1728
1536
1729
1537
1730
1538
class TestBumpTimeoutCmd(TestPropertyCmd):
1731
command = command.BumpTimeout
1539
command = BumpTimeoutCmd
1732
1540
propname = "LastCheckedOK"
1733
1541
values_to_set = [""]
1734
1542
1735
1543
1736
1544
class TestStartCheckerCmd(TestPropertyCmd):
1737
command = command.StartChecker
1545
command = StartCheckerCmd
1738
1546
propname = "CheckerRunning"
1739
1547
values_to_set = [dbus.Boolean(True)]
1740
1548
1741
1549
1742
1550
class TestStopCheckerCmd(TestPropertyCmd):
1743
command = command.StopChecker
1551
command = StopCheckerCmd
1744
1552
propname = "CheckerRunning"
1745
1553
values_to_set = [dbus.Boolean(False)]
1746
1554
1747
1555
1748
1556
class TestApproveByDefaultCmd(TestPropertyCmd):
1749
command = command.ApproveByDefault
1557
command = ApproveByDefaultCmd
1750
1558
propname = "ApprovedByDefault"
1751
1559
values_to_set = [dbus.Boolean(True)]
1752
1560
1753
1561
1754
1562
class TestDenyByDefaultCmd(TestPropertyCmd):
1755
command = command.DenyByDefault
1563
command = DenyByDefaultCmd
1756
1564
propname = "ApprovedByDefault"
1757
1565
values_to_set = [dbus.Boolean(False)]
1758
1566
1759
1567
1760
1568
class TestPropertyValueCmd(TestPropertyCmd):
1761
1569
"""Abstract class for tests of PropertyValueCmd classes"""
1762
1763
1570
def runTest(self):
1764
1571
if type(self) is TestPropertyValueCmd:
1765
1572
return
1766
1573
return super(TestPropertyValueCmd, self).runTest()
1767
1768
1574
def run_command(self, value, clients):
1769
1575
self.command(value).run(clients, self.bus)
1770
1576
1771
1577
1772
1578
class TestSetCheckerCmd(TestPropertyValueCmd):
1773
command = command.SetChecker
1579
command = SetCheckerCmd
1774
1580
propname = "Checker"
1775
1581
values_to_set = ["", ":", "fping -q -- %s"]
1776
1582
1777
1583
1778
1584
class TestSetHostCmd(TestPropertyValueCmd):
1779
command = command.SetHost
1585
command = SetHostCmd
1780
1586
propname = "Host"
1781
1587
values_to_set = ["192.0.2.3", "foo.example.org"]
1782
1588
1783
1589
1784
1590
class TestSetSecretCmd(TestPropertyValueCmd):
1785
command = command.SetSecret
1591
command = SetSecretCmd
1786
1592
propname = "Secret"
1787
1593
values_to_set = [io.BytesIO(b""),
1788
1594
io.BytesIO(b"secret\0xyzzy\nbar")]
1790
1596
1791
1597
1792
1598
class TestSetTimeoutCmd(TestPropertyValueCmd):
1793
command = command.SetTimeout
1599
command = SetTimeoutCmd
1794
1600
propname = "Timeout"
1795
1601
values_to_set = [datetime.timedelta(),
1796
1602
datetime.timedelta(minutes=5),
1801
1607
1802
1608
1803
1609
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
1804
command = command.SetExtendedTimeout
1610
command = SetExtendedTimeoutCmd
1805
1611
propname = "ExtendedTimeout"
1806
1612
values_to_set = [datetime.timedelta(),
1807
1613
datetime.timedelta(minutes=5),
1812
1618
1813
1619
1814
1620
class TestSetIntervalCmd(TestPropertyValueCmd):
1815
command = command.SetInterval
1621
command = SetIntervalCmd
1816
1622
propname = "Interval"
1817
1623
values_to_set = [datetime.timedelta(),
1818
1624
datetime.timedelta(minutes=5),
1823
1629
1824
1630
1825
1631
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
1826
command = command.SetApprovalDelay
1632
command = SetApprovalDelayCmd
1827
1633
propname = "ApprovalDelay"
1828
1634
values_to_set = [datetime.timedelta(),
1829
1635
datetime.timedelta(minutes=5),
1834
1640
1835
1641
1836
1642
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
1837
command = command.SetApprovalDuration
1643
command = SetApprovalDurationCmd
1838
1644
propname = "ApprovalDuration"
1839
1645
values_to_set = [datetime.timedelta(),
1840
1646
datetime.timedelta(minutes=5),
1862
1668
return tests
1863
1669
1864
1670
if __name__ == "__main__":
1865
try:
1866
if should_only_run_tests():
1867
# Call using ./tdd-python-script --check [--verbose]
1868
unittest.main()
1869
else:
1870
main()
1871
finally:
1872
logging.shutdown()
1671
if should_only_run_tests():
1672
# Call using ./tdd-python-script --check [--verbose]
1673
unittest.main()
1674
else:
1675
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0