435
426
def is_enabled(self, client, properties):
436
log.debug("D-Bus: %s:%s:%s.Get(%r, %r)", busname,
437
client.__dbus_object_path__,
438
dbus.PROPERTIES_IFACE, client_interface,
440
return bool(client.Get(client_interface, "Enabled",
441
dbus_interface=dbus.PROPERTIES_IFACE))
427
return bool(properties["Enabled"])
443
429
class RemoveCmd(Command):
444
430
def run_on_one_client(self, client, properties):
445
log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)", busname,
446
server_path, server_interface,
447
str(client.__dbus_object_path__))
448
431
self.mandos.RemoveClient(client.__dbus_object_path__)
450
433
class ApproveCmd(Command):
451
434
def run_on_one_client(self, client, properties):
452
log.debug("D-Bus: %s:%s.Approve(True)",
453
client.__dbus_object_path__, client_interface)
454
435
client.Approve(dbus.Boolean(True),
455
436
dbus_interface=client_interface)
457
438
class DenyCmd(Command):
458
439
def run_on_one_client(self, client, properties):
459
log.debug("D-Bus: %s:%s.Approve(False)",
460
client.__dbus_object_path__, client_interface)
461
440
client.Approve(dbus.Boolean(False),
462
441
dbus_interface=client_interface)
464
443
class EnableCmd(PropertyCmd):
466
445
value_to_set = dbus.Boolean(True)
468
447
class DisableCmd(PropertyCmd):
470
449
value_to_set = dbus.Boolean(False)
472
451
class BumpTimeoutCmd(PropertyCmd):
473
propname = "LastCheckedOK"
452
property = "LastCheckedOK"
474
453
value_to_set = ""
476
455
class StartCheckerCmd(PropertyCmd):
477
propname = "CheckerRunning"
456
property = "CheckerRunning"
478
457
value_to_set = dbus.Boolean(True)
480
459
class StopCheckerCmd(PropertyCmd):
481
propname = "CheckerRunning"
460
property = "CheckerRunning"
482
461
value_to_set = dbus.Boolean(False)
484
463
class ApproveByDefaultCmd(PropertyCmd):
485
propname = "ApprovedByDefault"
464
property = "ApprovedByDefault"
486
465
value_to_set = dbus.Boolean(True)
488
467
class DenyByDefaultCmd(PropertyCmd):
489
propname = "ApprovedByDefault"
468
property = "ApprovedByDefault"
490
469
value_to_set = dbus.Boolean(False)
492
471
class SetCheckerCmd(PropertyCmd, ValueArgumentMixIn):
495
474
class SetHostCmd(PropertyCmd, ValueArgumentMixIn):
498
477
class SetSecretCmd(PropertyCmd, ValueArgumentMixIn):
501
def value_to_set(self):
504
def value_to_set(self, value):
505
"""When setting, read data from supplied file object"""
506
self._vts = value.read()
509
480
class SetTimeoutCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
512
483
class SetExtendedTimeoutCmd(PropertyCmd,
513
484
MillisecondsValueArgumentMixIn):
514
propname = "ExtendedTimeout"
485
property = "ExtendedTimeout"
516
487
class SetIntervalCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
517
propname = "Interval"
488
property = "Interval"
519
490
class SetApprovalDelayCmd(PropertyCmd,
520
491
MillisecondsValueArgumentMixIn):
521
propname = "ApprovalDelay"
492
property = "ApprovalDelay"
523
494
class SetApprovalDurationCmd(PropertyCmd,
524
495
MillisecondsValueArgumentMixIn):
525
propname = "ApprovalDuration"
496
property = "ApprovalDuration"
498
def has_actions(options):
499
return any((options.enable,
501
options.bump_timeout,
502
options.start_checker,
503
options.stop_checker,
506
options.checker is not None,
507
options.timeout is not None,
508
options.extended_timeout is not None,
509
options.interval is not None,
510
options.approved_by_default is not None,
511
options.approval_delay is not None,
512
options.approval_duration is not None,
513
options.host is not None,
514
options.secret is not None,
527
518
def add_command_line_options(parser):
528
519
parser.add_argument("--version", action="version",
1128
1073
class TestSetCheckerCmd(TestValueArgumentPropertyCmd):
1129
1074
command = SetCheckerCmd
1130
propname = "Checker"
1075
property = "Checker"
1131
1076
values_to_set = ["", ":", "fping -q -- %s"]
1133
1078
class TestSetHostCmd(TestValueArgumentPropertyCmd):
1134
1079
command = SetHostCmd
1136
1081
values_to_set = ["192.0.2.3", "foo.example.org"]
1138
1083
class TestSetSecretCmd(TestValueArgumentPropertyCmd):
1139
1084
command = SetSecretCmd
1141
values_to_set = [io.BytesIO(b""),
1142
io.BytesIO(b"secret\0xyzzy\nbar")]
1143
values_to_get = [b"", b"secret\0xyzzy\nbar"]
1086
values_to_set = [b"", b"secret"]
1145
1088
class TestSetTimeoutCmd(TestValueArgumentPropertyCmd):
1146
1089
command = SetTimeoutCmd
1147
propname = "Timeout"
1148
values_to_set = [datetime.timedelta(),
1149
datetime.timedelta(minutes=5),
1150
datetime.timedelta(seconds=1),
1151
datetime.timedelta(weeks=1),
1152
datetime.timedelta(weeks=52)]
1153
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1090
property = "Timeout"
1091
values_to_set = ["P0D", "PT5M", "PT1S", "PT120S", "P1Y"]
1092
values_to_get = [0, 300000, 1000, 120000, 31449600000]
1155
1094
class TestSetExtendedTimeoutCmd(TestValueArgumentPropertyCmd):
1156
1095
command = SetExtendedTimeoutCmd
1157
propname = "ExtendedTimeout"
1158
values_to_set = [datetime.timedelta(),
1159
datetime.timedelta(minutes=5),
1160
datetime.timedelta(seconds=1),
1161
datetime.timedelta(weeks=1),
1162
datetime.timedelta(weeks=52)]
1163
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1096
property = "ExtendedTimeout"
1097
values_to_set = ["P0D", "PT5M", "PT1S", "PT120S", "P1Y"]
1098
values_to_get = [0, 300000, 1000, 120000, 31449600000]
1165
1100
class TestSetIntervalCmd(TestValueArgumentPropertyCmd):
1166
1101
command = SetIntervalCmd
1167
propname = "Interval"
1168
values_to_set = [datetime.timedelta(),
1169
datetime.timedelta(minutes=5),
1170
datetime.timedelta(seconds=1),
1171
datetime.timedelta(weeks=1),
1172
datetime.timedelta(weeks=52)]
1173
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1102
property = "Interval"
1103
values_to_set = ["P0D", "PT5M", "PT1S", "PT120S", "P1Y"]
1104
values_to_get = [0, 300000, 1000, 120000, 31449600000]
1175
1106
class TestSetApprovalDelayCmd(TestValueArgumentPropertyCmd):
1176
1107
command = SetApprovalDelayCmd
1177
propname = "ApprovalDelay"
1178
values_to_set = [datetime.timedelta(),
1179
datetime.timedelta(minutes=5),
1180
datetime.timedelta(seconds=1),
1181
datetime.timedelta(weeks=1),
1182
datetime.timedelta(weeks=52)]
1183
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1108
property = "ApprovalDelay"
1109
values_to_set = ["P0D", "PT5M", "PT1S", "PT120S", "P1Y"]
1110
values_to_get = [0, 300000, 1000, 120000, 31449600000]
1185
1112
class TestSetApprovalDurationCmd(TestValueArgumentPropertyCmd):
1186
1113
command = SetApprovalDurationCmd
1187
propname = "ApprovalDuration"
1188
values_to_set = [datetime.timedelta(),
1189
datetime.timedelta(minutes=5),
1190
datetime.timedelta(seconds=1),
1191
datetime.timedelta(weeks=1),
1192
datetime.timedelta(weeks=52)]
1193
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1114
property = "ApprovalDuration"
1115
values_to_set = ["P0D", "PT5M", "PT1S", "PT120S", "P1Y"]
1116
values_to_get = [0, 300000, 1000, 120000, 31449600000]
1195
class Test_command_from_options(unittest.TestCase):
1118
class TestOptions(unittest.TestCase):
1196
1119
def setUp(self):
1197
1120
self.parser = argparse.ArgumentParser()
1198
1121
add_command_line_options(self.parser)
1200
1123
"""Assert that parsing ARGS should result in an instance of
1201
1124
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
1202
1125
options = self.parser.parse_args(args)
1203
check_option_syntax(self.parser, options)
1204
1126
commands = commands_from_options(options)
1205
1127
self.assertEqual(len(commands), 1)
1206
1128
command = commands[0]
1207
1129
self.assertIsInstance(command, command_cls)
1208
1130
for key, value in cmd_attrs.items():
1209
1131
self.assertEqual(getattr(command, key), value)
1210
def test_print_table(self):
1132
def test_default_is_show_table(self):
1211
1133
self.assert_command_from_args([], PrintTableCmd,
1214
def test_print_table_verbose(self):
1135
def test_show_table_verbose(self):
1215
1136
self.assert_command_from_args(["--verbose"], PrintTableCmd,
1218
def test_print_table_verbose_short(self):
1219
self.assert_command_from_args(["-v"], PrintTableCmd,
1222
1138
def test_enable(self):
1223
self.assert_command_from_args(["--enable", "foo"], EnableCmd)
1225
def test_enable_short(self):
1226
self.assert_command_from_args(["-e", "foo"], EnableCmd)
1139
self.assert_command_from_args(["--enable"], EnableCmd)
1228
1140
def test_disable(self):
1229
self.assert_command_from_args(["--disable", "foo"],
1232
def test_disable_short(self):
1233
self.assert_command_from_args(["-d", "foo"], DisableCmd)
1235
def test_bump_timeout(self):
1236
self.assert_command_from_args(["--bump-timeout", "foo"],
1239
def test_bump_timeout_short(self):
1240
self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
1242
def test_start_checker(self):
1243
self.assert_command_from_args(["--start-checker", "foo"],
1246
def test_stop_checker(self):
1247
self.assert_command_from_args(["--stop-checker", "foo"],
1250
def test_remove(self):
1251
self.assert_command_from_args(["--remove", "foo"],
1254
def test_remove_short(self):
1255
self.assert_command_from_args(["-r", "foo"], RemoveCmd)
1257
def test_checker(self):
1258
self.assert_command_from_args(["--checker", ":", "foo"],
1259
SetCheckerCmd, value_to_set=":")
1261
def test_checker_empty(self):
1262
self.assert_command_from_args(["--checker", "", "foo"],
1263
SetCheckerCmd, value_to_set="")
1265
def test_checker_short(self):
1266
self.assert_command_from_args(["-c", ":", "foo"],
1267
SetCheckerCmd, value_to_set=":")
1269
def test_timeout(self):
1270
self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1272
value_to_set=300000)
1274
def test_timeout_short(self):
1275
self.assert_command_from_args(["-t", "PT5M", "foo"],
1277
value_to_set=300000)
1279
def test_extended_timeout(self):
1280
self.assert_command_from_args(["--extended-timeout", "PT15M",
1282
SetExtendedTimeoutCmd,
1283
value_to_set=900000)
1285
def test_interval(self):
1286
self.assert_command_from_args(["--interval", "PT2M", "foo"],
1288
value_to_set=120000)
1290
def test_interval_short(self):
1291
self.assert_command_from_args(["-i", "PT2M", "foo"],
1293
value_to_set=120000)
1295
def test_approve_by_default(self):
1296
self.assert_command_from_args(["--approve-by-default", "foo"],
1297
ApproveByDefaultCmd)
1299
def test_deny_by_default(self):
1300
self.assert_command_from_args(["--deny-by-default", "foo"],
1303
def test_approval_delay(self):
1304
self.assert_command_from_args(["--approval-delay", "PT30S",
1305
"foo"], SetApprovalDelayCmd,
1308
def test_approval_duration(self):
1309
self.assert_command_from_args(["--approval-duration", "PT1S",
1310
"foo"], SetApprovalDurationCmd,
1313
def test_host(self):
1314
self.assert_command_from_args(["--host", "foo.example.org",
1316
value_to_set="foo.example.org")
1318
def test_host_short(self):
1319
self.assert_command_from_args(["-H", "foo.example.org",
1321
value_to_set="foo.example.org")
1323
def test_secret_devnull(self):
1324
self.assert_command_from_args(["--secret", os.path.devnull,
1325
"foo"], SetSecretCmd,
1328
def test_secret_tempfile(self):
1329
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1330
value = b"secret\0xyzzy\nbar"
1333
self.assert_command_from_args(["--secret", f.name,
1334
"foo"], SetSecretCmd,
1337
def test_secret_devnull_short(self):
1338
self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1339
SetSecretCmd, value_to_set=b"")
1341
def test_secret_tempfile_short(self):
1342
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1343
value = b"secret\0xyzzy\nbar"
1346
self.assert_command_from_args(["-s", f.name, "foo"],
1350
def test_approve(self):
1351
self.assert_command_from_args(["--approve", "foo"],
1354
def test_approve_short(self):
1355
self.assert_command_from_args(["-A", "foo"], ApproveCmd)
1357
def test_deny(self):
1358
self.assert_command_from_args(["--deny", "foo"], DenyCmd)
1360
def test_deny_short(self):
1361
self.assert_command_from_args(["-D", "foo"], DenyCmd)
1363
def test_dump_json(self):
1364
self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
1366
def test_is_enabled(self):
1367
self.assert_command_from_args(["--is-enabled", "foo"],
1370
def test_is_enabled_short(self):
1371
self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
1373
def test_deny_before_remove(self):
1374
options = self.parser.parse_args(["--deny", "--remove", "foo"])
1375
check_option_syntax(self.parser, options)
1376
commands = commands_from_options(options)
1377
self.assertEqual(len(commands), 2)
1378
self.assertIsInstance(commands[0], DenyCmd)
1379
self.assertIsInstance(commands[1], RemoveCmd)
1381
def test_deny_before_remove_reversed(self):
1382
options = self.parser.parse_args(["--remove", "--deny", "--all"])
1383
check_option_syntax(self.parser, options)
1384
commands = commands_from_options(options)
1385
self.assertEqual(len(commands), 2)
1386
self.assertIsInstance(commands[0], DenyCmd)
1387
self.assertIsInstance(commands[1], RemoveCmd)
1390
class Test_check_option_syntax(unittest.TestCase):
1391
# This mostly corresponds to the definition from has_actions() in
1392
# check_option_syntax()
1394
# The actual values set here are not that important, but we do
1395
# at least stick to the correct types, even though they are
1399
"bump_timeout": True,
1400
"start_checker": True,
1401
"stop_checker": True,
1405
"timeout": datetime.timedelta(),
1406
"extended_timeout": datetime.timedelta(),
1407
"interval": datetime.timedelta(),
1408
"approved_by_default": True,
1409
"approval_delay": datetime.timedelta(),
1410
"approval_duration": datetime.timedelta(),
1412
"secret": io.BytesIO(b"x"),
1418
self.parser = argparse.ArgumentParser()
1419
add_command_line_options(self.parser)
1421
@contextlib.contextmanager
1422
def assertParseError(self):
1423
with self.assertRaises(SystemExit) as e:
1424
with self.temporarily_suppress_stderr():
1426
# Exit code from argparse is guaranteed to be "2". Reference:
1427
# https://docs.python.org/3/library/argparse.html#exiting-methods
1428
self.assertEqual(e.exception.code, 2)
1431
@contextlib.contextmanager
1432
def temporarily_suppress_stderr():
1433
null = os.open(os.path.devnull, os.O_RDWR)
1434
stderrcopy = os.dup(sys.stderr.fileno())
1435
os.dup2(null, sys.stderr.fileno())
1441
os.dup2(stderrcopy, sys.stderr.fileno())
1442
os.close(stderrcopy)
1444
def check_option_syntax(self, options):
1445
check_option_syntax(self.parser, options)
1447
def test_actions_requires_client_or_all(self):
1448
for action, value in self.actions.items():
1449
options = self.parser.parse_args()
1450
setattr(options, action, value)
1451
with self.assertParseError():
1452
self.check_option_syntax(options)
1454
def test_actions_conflicts_with_verbose(self):
1455
for action, value in self.actions.items():
1456
options = self.parser.parse_args()
1457
setattr(options, action, value)
1458
options.verbose = True
1459
with self.assertParseError():
1460
self.check_option_syntax(options)
1462
def test_dump_json_conflicts_with_verbose(self):
1463
options = self.parser.parse_args()
1464
options.dump_json = True
1465
options.verbose = True
1466
with self.assertParseError():
1467
self.check_option_syntax(options)
1469
def test_dump_json_conflicts_with_action(self):
1470
for action, value in self.actions.items():
1471
options = self.parser.parse_args()
1472
setattr(options, action, value)
1473
options.dump_json = True
1474
with self.assertParseError():
1475
self.check_option_syntax(options)
1477
def test_all_can_not_be_alone(self):
1478
options = self.parser.parse_args()
1480
with self.assertParseError():
1481
self.check_option_syntax(options)
1483
def test_all_is_ok_with_any_action(self):
1484
for action, value in self.actions.items():
1485
options = self.parser.parse_args()
1486
setattr(options, action, value)
1488
self.check_option_syntax(options)
1490
def test_is_enabled_fails_without_client(self):
1491
options = self.parser.parse_args()
1492
options.is_enabled = True
1493
with self.assertParseError():
1494
self.check_option_syntax(options)
1496
def test_is_enabled_works_with_one_client(self):
1497
options = self.parser.parse_args()
1498
options.is_enabled = True
1499
options.client = ["foo"]
1500
self.check_option_syntax(options)
1502
def test_is_enabled_fails_with_two_clients(self):
1503
options = self.parser.parse_args()
1504
options.is_enabled = True
1505
options.client = ["foo", "barbar"]
1506
with self.assertParseError():
1507
self.check_option_syntax(options)
1509
def test_remove_can_only_be_combined_with_action_deny(self):
1510
for action, value in self.actions.items():
1511
if action in {"remove", "deny"}:
1513
options = self.parser.parse_args()
1514
setattr(options, action, value)
1516
options.remove = True
1517
with self.assertParseError():
1518
self.check_option_syntax(options)
1141
self.assert_command_from_args(["--disable"], DisableCmd)