/usr/lib/python3/dist-packages/pytestsalt/fixtures/config.py is in python3-pytestsalt 2018.1.13-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 | # -*- coding: utf-8 -*-
'''
:codeauthor: :email:`Pedro Algarvio (pedro@algarvio.me)`
:copyright: Copyright 2015 by the SaltStack Team, see AUTHORS for more details.
:license: Apache 2.0, see LICENSE for more details.
pytestsalt.fixtures.config
~~~~~~~~~~~~~~~~~~~~~~~~~~
pytest salt configuration related fixtures
'''
# pylint: disable=redefined-outer-name,too-many-arguments,too-many-locals
# Import python libs
from __future__ import absolute_import, print_function
import os
import sys
import copy
import logging
import subprocess
# Import 3rd-party libs
import pytest
# Import pytest salt libs
import pytestsalt.salt.engines
import pytestsalt.salt.log_handlers
IS_WINDOWS = sys.platform.startswith('win')
if IS_WINDOWS:
import win32api # pylint: disable=import-error
else:
import pwd
DEFAULT_MOM_ID = 'pytest-salt-mom'
DEFAULT_MASTER_ID = 'pytest-salt-master'
DEFAULT_MINION_ID = 'pytest-salt-minion'
DEFAULT_SYNDIC_ID = 'pytest-salt-syndic'
DEFAULT_SESSION_MASTER_ID = 'pytest-session-salt-mom'
DEFAULT_SESSION_MASTER_ID = 'pytest-session-salt-master'
DEFAULT_SESSION_MINION_ID = 'pytest-session-salt-minion'
DEFAULT_SESSION_SYNDIC_ID = 'pytest-session-salt-syndic'
log = logging.getLogger(__name__)
class Counter(object): # pylint: disable=too-few-public-methods
'''
Simple counter class which increases count on every call to it's instance
'''
def __init__(self):
self.counter = 0
def __call__(self):
try:
return self.counter
finally:
self.counter += 1
def pytest_addoption(parser):
'''
Add pytest salt plugin daemons related options
'''
saltparser = parser.getgroup('Salt Plugin Options')
saltparser.addoption(
'--cli-bin-dir',
default=None,
help=('Path to the bin directory where the salt CLI scripts can be '
'found. Defaults to the directory name of the python executable '
'running py.test')
)
saltparser.addoption(
'--salt-fail-hard',
default=None,
action='store_true',
help=('If a salt daemon fails to start, the test is marked as XFailed. '
'If this flag is passed, then a test failure is raised instead of XFail.')
)
parser.addini(
'cli_bin_dir',
default=None,
help=('Path to the bin directory where the salt CLI scripts can be '
'found. Defaults to the directory name of the python executable '
'running py.test')
)
parser.addini(
'salt_fail_hard',
default=None,
type='bool',
help=('If a salt daemon fails to start, the test is marked as XFailed. '
'If this flag is set, then a test failure is raised instead of XFail.')
)
@pytest.hookimpl(trylast=True)
def pytest_report_header(config, startdir):
'''
return a string to be displayed as header info for terminal reporting.
'''
# Store a reference to where the base directory of the project is
config.startdir = startdir
@pytest.fixture(scope='session')
def python_executable_path():
'''
return the python executable path
'''
return sys.executable
@pytest.fixture(scope='session')
def cli_bin_dir(request, python_executable_path):
'''
Return the path to the CLI script directory to use
'''
# Default to the directory of the current python executable
return os.path.dirname(python_executable_path)
@pytest.fixture(scope='session')
def _cli_bin_dir(request, cli_bin_dir):
'''
Return the path to the CLI script directory to use
'''
path = request.config.getoption('cli_bin_dir')
if path is not None:
# We were passed --cli-bin-dir as a CLI option
return path
# The path was not passed as a CLI option
path = request.config.getini('cli_bin_dir')
if path:
# We were passed cli_bin_dir as a INI option
return path
return cli_bin_dir
@pytest.fixture(scope='session')
def salt_fail_hard(request):
'''
Return the salt fail hard value
'''
return False
@pytest.fixture(scope='function')
def _salt_fail_hard(request, salt_fail_hard):
'''
Return the salt fail hard value
'''
fail_hard = request.config.getoption('salt_fail_hard')
if fail_hard is not None:
# We were passed --salt-fail-hard as a CLI option
return fail_hard
# The salt fail hard was not passed as a CLI option
fail_hard = request.config.getini('salt_fail_hard')
if fail_hard != []:
# We were passed salt_fail_hard as a INI option
return fail_hard
return salt_fail_hard
@pytest.fixture(scope='session')
def running_username():
'''
Returns the current username
'''
if IS_WINDOWS:
return win32api.GetUserName()
return pwd.getpwuid(os.getuid()).pw_name
@pytest.fixture(scope='session')
def salt_master_id_counter():
'''
Fixture which return a number to include in the master ID.
Every call to this fixture increases the counter.
'''
return Counter()
@pytest.fixture(scope='session')
def salt_master_of_masters_id_counter():
'''
Fixture which return a number to include in the master ID.
Every call to this fixture increases the counter.
'''
return Counter()
@pytest.fixture(scope='session')
def salt_minion_id_counter():
'''
Fixture which return a number to include in the minion ID.
Every call to this fixture increases the counter.
'''
return Counter()
@pytest.fixture(scope='session')
def salt_syndic_id_counter():
'''
Fixture which return a number to include in the syndic ID.
Every call to this fixture increases the counter.
'''
return Counter()
@pytest.fixture(scope='session')
def cli_master_script_name():
'''
Return the CLI script basename
'''
return 'salt-master'
@pytest.fixture(scope='session')
def cli_minion_script_name():
'''
Return the CLI script basename
'''
return 'salt-minion'
@pytest.fixture(scope='session')
def cli_proxy_script_name():
'''
Return the CLI script basename
'''
return 'salt-proxy'
@pytest.fixture(scope='session')
def cli_salt_script_name():
'''
Return the CLI script basename
'''
return 'salt'
@pytest.fixture(scope='session')
def cli_run_script_name():
'''
Return the CLI script basename
'''
return 'salt-run'
@pytest.fixture(scope='session')
def cli_key_script_name():
'''
Return the CLI script basename
'''
return 'salt-key'
@pytest.fixture(scope='session')
def cli_call_script_name():
'''
Return the CLI script basename
'''
return 'salt-call'
@pytest.fixture(scope='session')
def cli_syndic_script_name():
'''
Return the CLI script basename
'''
return 'salt-syndic'
@pytest.fixture(scope='session')
def cli_ssh_script_name():
'''
Return the CLI script basename
'''
return 'salt-ssh'
@pytest.fixture
def master_of_masters_id(salt_master_of_masters_id_counter):
'''
Returns the master of masters id
'''
return DEFAULT_MOM_ID + '-{0}'.format(salt_master_of_masters_id_counter())
@pytest.fixture
def master_id(salt_master_id_counter):
'''
Returns the master id
'''
return DEFAULT_MASTER_ID + '-{0}'.format(salt_master_id_counter())
@pytest.fixture
def minion_id(salt_minion_id_counter):
'''
Returns the minion id
'''
return DEFAULT_MINION_ID + '-{0}'.format(salt_minion_id_counter())
@pytest.fixture
def secondary_minion_id(salt_minion_id_counter):
'''
Returns the secondary minion id
'''
return DEFAULT_MINION_ID + '-{0}'.format(salt_minion_id_counter())
@pytest.fixture
def syndic_id(salt_syndic_id_counter):
'''
Returns the syndic id
'''
return DEFAULT_SESSION_SYNDIC_ID + '-{0}'.format(salt_syndic_id_counter())
@pytest.fixture(scope='session')
def session_master_of_masters_id(salt_master_of_masters_id_counter):
'''
Returns the master of masters id
'''
return DEFAULT_MOM_ID + '-{0}'.format(salt_master_of_masters_id_counter())
@pytest.fixture(scope='session')
def session_master_id(salt_master_id_counter):
'''
Returns the session scoped master id
'''
return DEFAULT_SESSION_MASTER_ID + '-{0}'.format(salt_master_id_counter())
@pytest.fixture(scope='session')
def session_minion_id(salt_minion_id_counter):
'''
Returns the session scoped minion id
'''
return DEFAULT_SESSION_MINION_ID + '-{0}'.format(salt_minion_id_counter())
@pytest.fixture(scope='session')
def session_secondary_minion_id(salt_minion_id_counter):
'''
Returns the session scoped secondary minion id
'''
return DEFAULT_SESSION_MINION_ID + '-{0}'.format(salt_minion_id_counter())
@pytest.fixture(scope='session')
def session_syndic_id(salt_syndic_id_counter):
'''
Returns the session scoped syndic id
'''
return DEFAULT_SESSION_SYNDIC_ID + '-{0}'.format(salt_syndic_id_counter())
@pytest.fixture
def master_config_file(conf_dir):
'''
Returns the path to the salt master configuration file
'''
return conf_dir.join('master').realpath().strpath
@pytest.fixture
def master_of_masters_config_file(master_of_masters_conf_dir):
'''
Returns the path to the salt master configuration file
'''
return master_of_masters_conf_dir.join('master').realpath().strpath
@pytest.fixture
def minion_config_file(conf_dir):
'''
Returns the path to the salt minion configuration file
'''
return conf_dir.join('minion').realpath().strpath
@pytest.fixture
def secondary_minion_config_file(secondary_conf_dir):
'''
Returns the path to the salt secondary minion configuration file
'''
return secondary_conf_dir.join('minion').realpath().strpath
@pytest.fixture
def proxy_config_file(conf_dir):
'''
Returns the path to the salt minion configuration file
'''
return conf_dir.join('proxy').realpath().strpath
@pytest.fixture
def master_config_overrides():
'''
This fixture should be implemented to overwrite default salt master
configuration options.
It will be applied over the loaded default options
'''
@pytest.fixture
def master_of_masters_config_overrides():
'''
This fixture should be implemented to overwrite default salt master
configuration options.
It will be applied over the loaded default options
'''
@pytest.fixture
def minion_config_overrides():
'''
This fixture should be implemented to overwrite default salt minion
configuration options.
It will be applied over the loaded default options
'''
@pytest.fixture
def secondary_minion_config_overrides():
'''
This fixture should be implemented to overwrite default secondary salt minion
configuration options.
It will be applied over the loaded default options
'''
@pytest.fixture
def syndic_master_config_overrides():
'''
This fixture should be implemented to overwrite default salt syndic
master configuration options.
It will be applied over the loaded default options
'''
@pytest.fixture
def syndic_minion_config_overrides():
'''
This fixture should be implemented to overwrite default salt syndic
minion configuration options.
It will be applied over the loaded default options
'''
@pytest.fixture(scope='session')
def session_master_config_file(session_conf_dir):
'''
Returns the path to the salt master configuration file
'''
return session_conf_dir.join('master').realpath().strpath
@pytest.fixture(scope='session')
def session_master_of_masters_config_file(session_master_of_masters_conf_dir):
'''
Returns the path to the salt master configuration file
'''
return session_master_of_masters_conf_dir.join('master').realpath().strpath
@pytest.fixture(scope='session')
def session_minion_config_file(session_conf_dir):
'''
Returns the path to the salt minion configuration file
'''
return session_conf_dir.join('minion').realpath().strpath
@pytest.fixture(scope='session')
def session_secondary_minion_config_file(session_secondary_conf_dir):
'''
Returns the path to the salt secondary minion configuration file
'''
return session_secondary_conf_dir.join('minion').realpath().strpath
@pytest.fixture(scope='session')
def session_master_config_overrides():
'''
This fixture should be implemented to overwrite default salt master
configuration options.
It will be applied over the loaded default options
'''
@pytest.fixture(scope='session')
def session_master_of_masters_config_overrides():
'''
This fixture should be implemented to overwrite default salt master
configuration options.
It will be applied over the loaded default options
'''
@pytest.fixture(scope='session')
def session_minion_config_overrides():
'''
This fixture should be implemented to overwrite default salt minion
configuration options.
It will be applied over the loaded default options
'''
@pytest.fixture(scope='session')
def session_secondary_minion_config_overrides():
'''
This fixture should be implemented to overwrite default secondary salt minion
configuration options.
It will be applied over the loaded default options
'''
@pytest.fixture(scope='session')
def session_syndic_master_config_overrides():
'''
This fixture should be implemented to overwrite default salt syndic
master configuration options.
It will be applied over the loaded default options
'''
@pytest.fixture(scope='session')
def session_syndic_minion_config_overrides():
'''
This fixture should be implemented to overwrite default salt syndic
minion configuration options.
It will be applied over the loaded default options
'''
@pytest.fixture
def master_log_prefix(master_id):
return 'salt-master/{0}'.format(master_id)
@pytest.fixture(scope='session')
def session_master_log_prefix(session_master_id):
return 'salt-master/{0}'.format(session_master_id)
@pytest.fixture
def master_of_masters_log_prefix(master_of_masters_id):
return 'salt-master/{0}'.format(master_of_masters_id)
@pytest.fixture(scope='session')
def session_master_of_masters_log_prefix(session_master_of_masters_id):
return 'salt-master/{0}'.format(session_master_of_masters_id)
@pytest.fixture
def minion_log_prefix(minion_id):
return 'salt-minion/{0}'.format(minion_id)
@pytest.fixture(scope='session')
def session_minion_log_prefix(session_minion_id):
return 'salt-minion/{0}'.format(session_minion_id)
@pytest.fixture
def proxy_log_prefix(minion_id):
return 'salt-proxy/{0}'.format(minion_id)
@pytest.fixture(scope='session')
def session_proxy_log_prefix(session_minion_id):
return 'salt-proxy/{0}'.format(session_minion_id)
@pytest.fixture
def secondary_minion_log_prefix(secondary_minion_id):
return 'salt-minion/{0}'.format(secondary_minion_id)
@pytest.fixture(scope='session')
def session_secondary_minion_log_prefix(session_secondary_minion_id):
return 'salt-minion/{0}'.format(session_secondary_minion_id)
@pytest.fixture
def syndic_log_prefix(syndic_id):
return 'salt-syndic/{0}'.format(syndic_id)
@pytest.fixture(scope='session')
def session_syndic_log_prefix(session_syndic_id):
return 'salt-syndic/{0}'.format(session_syndic_id)
@pytest.fixture
def salt_log_prefix(minion_id):
return 'salt/{0}'.format(minion_id)
@pytest.fixture(scope='session')
def session_salt_log_prefix(session_minion_id):
return 'salt/{0}'.format(session_minion_id)
@pytest.fixture
def salt_call_log_prefix(master_id):
return 'salt-call/{0}'.format(master_id)
@pytest.fixture(scope='session')
def session_salt_call_log_prefix(session_master_id):
return 'salt-call/{0}'.format(session_master_id)
@pytest.fixture
def salt_key_log_prefix(master_id):
return 'salt-key/{0}'.format(master_id)
@pytest.fixture(scope='session')
def session_salt_key_log_prefix(session_master_id):
return 'salt-key/{0}'.format(session_master_id)
@pytest.fixture
def salt_run_log_prefix(master_id):
return 'salt-run/{0}'.format(master_id)
@pytest.fixture(scope='session')
def session_salt_run_log_prefix(session_master_id):
return 'salt-run/{0}'.format(session_master_id)
def apply_master_config(root_dir,
config_file,
publish_port,
return_port,
engine_port,
config_overrides,
master_id,
base_env_state_tree_root_dirs,
prod_env_state_tree_root_dirs,
base_env_pillar_tree_root_dirs,
prod_env_pillar_tree_root_dirs,
running_username,
salt_log_port,
master_log_prefix,
tcp_master_pub_port,
tcp_master_pull_port,
tcp_master_publish_pull,
tcp_master_workers,
direct_overrides=None):
'''
This fixture will return the salt master configuration options after being
overridden with any options passed from ``master_config_overrides``
'''
import salt.config
import salt.utils
import salt.utils.dictupdate as dictupdate
import salt.utils.verify as salt_verify
import salt.serializers.yaml as yamlserialize
default_options = {
'id': master_id,
'interface': '127.0.0.1',
'root_dir': root_dir.strpath,
'publish_port': publish_port,
'ret_port': return_port,
'tcp_master_pub_port': tcp_master_pub_port,
'tcp_master_pull_port': tcp_master_pull_port,
'tcp_master_publish_pull': tcp_master_publish_pull,
'tcp_master_workers': tcp_master_workers,
'worker_threads': 3,
'pidfile': 'run/master.pid',
'pki_dir': 'pki',
'cachedir': 'cache',
'timeout': 3,
'sock_dir': '.salt-unix',
'open_mode': True,
'syndic_master': 'localhost',
'fileserver_list_cache_time': 0,
'fileserver_backend': ['roots'],
'pillar_opts': False,
'peer': {
'.*': [
'test.*'
]
},
'log_file': 'logs/master.log',
'log_level_logfile': 'debug',
'key_logfile': 'logs/key.log',
'token_dir': 'tokens',
'token_file': root_dir.join('ksfjhdgiuebfgnkefvsikhfjdgvkjahcsidk').strpath,
'file_buffer_size': 8192,
'user': running_username,
'log_fmt_console': "[%(levelname)-8s][%(name)-5s:%(lineno)-4d] %(message)s",
'log_fmt_logfile': "[%(asctime)s,%(msecs)03.0f][%(name)-5s:%(lineno)-4d][%(levelname)-8s] %(message)s",
'file_roots': {
'base': base_env_state_tree_root_dirs,
'prod': prod_env_state_tree_root_dirs,
},
'pillar_roots': {
'base': base_env_pillar_tree_root_dirs,
'prod': prod_env_pillar_tree_root_dirs,
},
'hash_type': 'sha256'
}
if config_overrides:
# Merge in the default options with the master_config_overrides
dictupdate.update(default_options, config_overrides, merge_lists=True)
default_options.setdefault('engines', [])
if 'pytest' not in default_options['engines']:
default_options['engines'].append('pytest')
if 'engines_dirs' not in default_options:
default_options['engines_dirs'] = []
default_options['engines_dirs'].insert(0, os.path.dirname(pytestsalt.salt.engines.__file__))
default_options['pytest_port'] = engine_port
if 'log_handlers_dirs' not in default_options:
default_options['log_handlers_dirs'] = []
default_options['log_handlers_dirs'].insert(0, os.path.dirname(pytestsalt.salt.log_handlers.__file__))
default_options['pytest_log_port'] = salt_log_port
default_options['pytest_log_prefix'] = '[{0}] '.format(master_log_prefix)
if direct_overrides is not None:
# We've been passed some direct override configuration.
# Apply it!
dictupdate.update(default_options, direct_overrides, merge_lists=True)
log.info('Writing configuration file to %s', config_file)
# Write down the computed configuration into the config file
with salt.utils.fopen(config_file, 'w') as wfh:
wfh.write(yamlserialize.serialize(default_options))
# Make sure to load the config file as a salt-master starting from CLI
options = salt.config.master_config(config_file)
# verify env to make sure all required directories are created and have the
# right permissions
verify_env_entries = [
os.path.join(options['pki_dir'], 'minions'),
os.path.join(options['pki_dir'], 'minions_pre'),
os.path.join(options['pki_dir'], 'minions_rejected'),
os.path.join(options['pki_dir'], 'accepted'),
os.path.join(options['pki_dir'], 'rejected'),
os.path.join(options['pki_dir'], 'pending'),
os.path.dirname(options['log_file']),
options['token_dir'],
#options['extension_modules'],
options['sock_dir'],
]
verify_env_entries += base_env_state_tree_root_dirs
verify_env_entries += prod_env_state_tree_root_dirs
verify_env_entries += base_env_pillar_tree_root_dirs
verify_env_entries += prod_env_pillar_tree_root_dirs
if default_options.get('transport', None) == 'raet':
verify_env_entries.extend([
os.path.join(options['cachedir'], 'raet'),
])
else:
verify_env_entries.extend([
os.path.join(options['cachedir'], 'jobs'),
])
try:
salt_verify.verify_env(
verify_env_entries,
running_username,
sensitive_dirs=[options['pki_dir']]
)
except TypeError:
salt_verify.verify_env(
verify_env_entries,
running_username,
pki_dir=options['pki_dir']
)
return options
@pytest.fixture
def master_config(root_dir,
master_config_file,
master_publish_port,
master_return_port,
master_engine_port,
master_config_overrides,
master_id,
base_env_state_tree_root_dir,
prod_env_state_tree_root_dir,
base_env_pillar_tree_root_dir,
prod_env_pillar_tree_root_dir,
running_username,
salt_log_port,
master_log_prefix,
master_tcp_master_pub_port,
master_tcp_master_pull_port,
master_tcp_master_publish_pull,
master_tcp_master_workers):
'''
This fixture will return the salt master configuration options after being
overridden with any options passed from ``master_config_overrides``
'''
return apply_master_config(root_dir,
master_config_file,
master_publish_port,
master_return_port,
master_engine_port,
master_config_overrides,
master_id,
[base_env_state_tree_root_dir.strpath],
[prod_env_state_tree_root_dir.strpath],
[base_env_pillar_tree_root_dir.strpath],
[prod_env_pillar_tree_root_dir.strpath],
running_username,
salt_log_port,
master_log_prefix,
master_tcp_master_pub_port,
master_tcp_master_pull_port,
master_tcp_master_publish_pull,
master_tcp_master_workers)
@pytest.fixture(scope='session')
def session_master_config(session_root_dir,
session_master_config_file,
session_master_publish_port,
session_master_return_port,
session_master_engine_port,
session_master_config_overrides,
session_master_id,
session_base_env_state_tree_root_dir,
session_prod_env_state_tree_root_dir,
session_base_env_pillar_tree_root_dir,
session_prod_env_pillar_tree_root_dir,
running_username,
salt_log_port,
session_master_log_prefix,
session_master_tcp_master_pub_port,
session_master_tcp_master_pull_port,
session_master_tcp_master_publish_pull,
session_master_tcp_master_workers):
'''
This fixture will return the salt master configuration options after being
overridden with any options passed from ``session_master_config_overrides``
'''
return apply_master_config(session_root_dir,
session_master_config_file,
session_master_publish_port,
session_master_return_port,
session_master_engine_port,
session_master_config_overrides,
session_master_id,
[session_base_env_state_tree_root_dir.strpath],
[session_prod_env_state_tree_root_dir.strpath],
[session_base_env_pillar_tree_root_dir.strpath],
[session_prod_env_pillar_tree_root_dir.strpath],
running_username,
salt_log_port,
session_master_log_prefix,
session_master_tcp_master_pub_port,
session_master_tcp_master_pull_port,
session_master_tcp_master_publish_pull,
session_master_tcp_master_workers)
@pytest.fixture
def master_of_masters_config(master_of_masters_root_dir,
master_of_masters_config_file,
master_of_masters_publish_port,
master_of_masters_return_port,
master_of_masters_engine_port,
master_of_masters_config_overrides,
master_of_masters_id,
master_of_masters_base_env_state_tree_root_dir,
master_of_masters_prod_env_state_tree_root_dir,
master_of_masters_base_env_pillar_tree_root_dir,
master_of_masters_prod_env_pillar_tree_root_dir,
running_username,
salt_log_port,
master_of_masters_log_prefix,
master_of_masters_master_tcp_master_pub_port,
master_of_masters_master_tcp_master_pull_port,
master_of_masters_master_tcp_master_publish_pull,
master_of_masters_master_tcp_master_workers):
'''
This fixture will return the salt master configuration options after being
overridden with any options passed from ``master_config_overrides``
'''
direct_overrides = {
'order_masters': True,
}
return apply_master_config(master_of_masters_root_dir,
master_of_masters_config_file,
master_of_masters_publish_port,
master_of_masters_return_port,
master_of_masters_engine_port,
master_of_masters_config_overrides,
master_of_masters_id,
[master_of_masters_base_env_state_tree_root_dir.strpath],
[master_of_masters_prod_env_state_tree_root_dir.strpath],
[master_of_masters_base_env_pillar_tree_root_dir.strpath],
[master_of_masters_prod_env_pillar_tree_root_dir.strpath],
running_username,
salt_log_port,
master_of_masters_log_prefix,
master_of_masters_master_tcp_master_pub_port,
master_of_masters_master_tcp_master_pull_port,
master_of_masters_master_tcp_master_publish_pull,
master_of_masters_master_tcp_master_workers,
direct_overrides=direct_overrides)
@pytest.fixture(scope='session')
def session_master_of_masters_config(session_master_of_masters_root_dir,
session_master_of_masters_config_file,
session_master_of_masters_publish_port,
session_master_of_masters_return_port,
session_master_of_masters_engine_port,
session_master_of_masters_config_overrides,
session_master_of_masters_id,
session_base_env_state_tree_root_dir,
session_prod_env_state_tree_root_dir,
session_base_env_pillar_tree_root_dir,
session_prod_env_pillar_tree_root_dir,
running_username,
salt_log_port,
session_master_of_masters_log_prefix,
session_master_of_masters_master_tcp_master_pub_port,
session_master_of_masters_master_tcp_master_pull_port,
session_master_of_masters_master_tcp_master_publish_pull,
session_master_of_masters_master_tcp_master_workers):
'''
This fixture will return the salt master configuration options after being
overridden with any options passed from ``session_master_config_overrides``
'''
direct_overrides = {
'order_masters': True,
}
return apply_master_config(session_master_of_masters_root_dir,
session_master_of_masters_config_file,
session_master_of_masters_publish_port,
session_master_of_masters_return_port,
session_master_of_masters_engine_port,
session_master_of_masters_config_overrides,
session_master_of_masters_id,
[session_base_env_state_tree_root_dir.strpath],
[session_prod_env_state_tree_root_dir.strpath],
[session_base_env_pillar_tree_root_dir.strpath],
[session_prod_env_pillar_tree_root_dir.strpath],
running_username,
salt_log_port,
session_master_of_masters_log_prefix,
session_master_of_masters_master_tcp_master_pub_port,
session_master_of_masters_master_tcp_master_pull_port,
session_master_of_masters_master_tcp_master_publish_pull,
session_master_of_masters_master_tcp_master_workers,
direct_overrides=direct_overrides)
def apply_minion_config(root_dir,
config_file,
return_port,
engine_port,
config_overrides,
minion_id,
running_username,
salt_log_port,
minion_log_prefix,
tcp_pub_port,
tcp_pull_port):
'''
This fixture will return the salt minion configuration options after being
overridden with any options passed from ``config_overrides``
'''
import salt.config
import salt.utils
import salt.utils.dictupdate as dictupdate
import salt.utils.verify as salt_verify
import salt.serializers.yaml as yamlserialize
default_options = {
'root_dir': root_dir.strpath,
'interface': '127.0.0.1',
'master': '127.0.0.1',
'master_port': return_port,
'tcp_pub_port': tcp_pub_port,
'tcp_pull_port': tcp_pull_port,
'id': minion_id,
'pidfile': 'run/minion.pid',
'pki_dir': 'pki',
'cachedir': 'cache',
'sock_dir': '.salt-unix',
'log_file': 'logs/minion.log',
'log_level_logfile': 'debug',
'loop_interval': 0.05,
'open_mode': True,
'user': running_username,
#'multiprocessing': False,
'log_fmt_console': "[%(levelname)-8s][%(name)-5s:%(lineno)-4d] %(message)s",
'log_fmt_logfile': "[%(asctime)s,%(msecs)03.0f][%(name)-5s:%(lineno)-4d][%(levelname)-8s] %(message)s",
'hash_type': 'sha256'
}
if config_overrides:
# Merge in the default options with the minion_config_overrides
dictupdate.update(default_options, config_overrides, merge_lists=True)
#default_options.setdefault('engines', [])
#if 'pytest' not in default_options['engines']:
# default_options['engines'].append('pytest')
#if 'engines_dirs' not in default_options:
# default_options['engines_dirs'] = []
#default_options['engines_dirs'].insert(0, os.path.dirname(pytestsalt.salt.engines.__file__))
#default_options['pytest_port'] = engine_port
if 'log_handlers_dirs' not in default_options:
default_options['log_handlers_dirs'] = []
default_options['log_handlers_dirs'].insert(0, os.path.dirname(pytestsalt.salt.log_handlers.__file__))
default_options['pytest_log_port'] = salt_log_port
default_options['pytest_log_prefix'] = '[{0}] '.format(minion_log_prefix)
log.info('Writing configuration file to %s', config_file)
# Write down the computed configuration into the config file
with salt.utils.fopen(config_file, 'w') as wfh:
wfh.write(yamlserialize.serialize(default_options))
# Make sure to load the config file as a salt-master starting from CLI
options = salt.config.minion_config(config_file)
# verify env to make sure all required directories are created and have the
# right permissions
verify_env_entries = [
os.path.join(options['pki_dir'], 'minions'),
os.path.join(options['pki_dir'], 'minions_pre'),
os.path.join(options['pki_dir'], 'minions_rejected'),
os.path.join(options['pki_dir'], 'accepted'),
os.path.join(options['pki_dir'], 'rejected'),
os.path.join(options['pki_dir'], 'pending'),
os.path.dirname(options['log_file']),
os.path.join(options['cachedir'], 'proc'),
#options['extension_modules'],
options['sock_dir'],
]
try:
# Salt > v2017.7.x
salt_verify.verify_env(
verify_env_entries,
running_username,
sensitive_dirs=[options['pki_dir']]
)
except TypeError:
# Salt <= v2017.7.x
salt_verify.verify_env(
verify_env_entries,
running_username,
pki_dir=options['pki_dir']
)
return options
@pytest.fixture
def minion_config(root_dir,
minion_config_file,
master_return_port,
minion_engine_port,
minion_config_overrides,
minion_id,
running_username,
salt_log_port,
minion_log_prefix,
minion_tcp_pub_port,
minion_tcp_pull_port):
'''
This fixture will return the salt minion configuration options after being
overrided with any options passed from ``minion_config_overrides``
'''
return apply_minion_config(root_dir,
minion_config_file,
master_return_port,
minion_engine_port,
minion_config_overrides,
minion_id,
running_username,
salt_log_port,
minion_log_prefix,
minion_tcp_pub_port,
minion_tcp_pull_port)
@pytest.fixture(scope='session')
def session_minion_config(session_root_dir,
session_minion_config_file,
session_master_return_port,
session_minion_engine_port,
session_minion_config_overrides,
session_minion_id,
running_username,
salt_log_port,
session_minion_log_prefix,
session_minion_tcp_pub_port,
session_minion_tcp_pull_port):
'''
This fixture will return the session salt minion configuration options after being
overrided with any options passed from ``session_minion_config_overrides``
'''
return apply_minion_config(session_root_dir,
session_minion_config_file,
session_master_return_port,
session_minion_engine_port,
session_minion_config_overrides,
session_minion_id,
running_username,
salt_log_port,
session_minion_log_prefix,
session_minion_tcp_pub_port,
session_minion_tcp_pull_port)
@pytest.fixture
def secondary_minion_config(secondary_root_dir,
secondary_minion_config_file,
master_return_port,
secondary_minion_engine_port,
secondary_minion_config_overrides,
secondary_minion_id,
running_username,
salt_log_port,
secondary_minion_log_prefix,
secondary_minion_tcp_pub_port,
secondary_minion_tcp_pull_port):
'''
This fixture will return the secondary salt minion configuration options after being
overrided with any options passed from ``secondary_minion_config_overrides``
'''
return apply_minion_config(secondary_root_dir,
secondary_minion_config_file,
master_return_port,
secondary_minion_engine_port,
secondary_minion_config_overrides,
secondary_minion_id,
running_username,
salt_log_port,
secondary_minion_log_prefix,
secondary_minion_tcp_pub_port,
secondary_minion_tcp_pull_port)
@pytest.fixture(scope='session')
def session_secondary_minion_config(session_secondary_root_dir,
session_secondary_minion_config_file,
session_master_return_port,
session_secondary_minion_engine_port,
session_secondary_minion_config_overrides,
session_secondary_minion_id,
running_username,
salt_log_port,
session_secondary_minion_log_prefix,
session_secondary_minion_tcp_pub_port,
session_secondary_minion_tcp_pull_port):
'''
This fixture will return the session salt minion configuration options after being
overrided with any options passed from ``session_secondary_minion_config_overrides``
'''
return apply_minion_config(session_secondary_root_dir,
session_secondary_minion_config_file,
session_master_return_port,
session_secondary_minion_engine_port,
session_secondary_minion_config_overrides,
session_secondary_minion_id,
running_username,
salt_log_port,
session_secondary_minion_log_prefix,
session_secondary_minion_tcp_pub_port,
session_secondary_minion_tcp_pull_port)
def apply_syndic_config(master_config,
minion_config,
syndic_conf_dir,
engine_port,
master_config_overrides,
minion_config_overrides,
running_username,
salt_log_port,
syndic_log_prefix,
syndic_id):
'''
This fixture will return the salt syndic configuration options after being
overridden with any options passed from ``config_overrides``
'''
import salt.config
import salt.utils
import salt.utils.dictupdate as dictupdate
import salt.utils.verify as salt_verify
import salt.serializers.yaml as yamlserialize
syndic_master_config_file = syndic_conf_dir.join('master').realpath().strpath
syndic_minion_config_file = syndic_conf_dir.join('minion').realpath().strpath
default_master_options = copy.deepcopy(master_config)
default_minion_options = copy.deepcopy(minion_config)
master_overrides = {
'syndic_master': 'localhost',
'syndic_master_port': master_config['ret_port'],
'syndic_pidfile': 'run/salt-syndic.pid',
'syndic_user': running_username,
'syndic_log_file': 'logs/syndic.log',
'pytest_port': engine_port,
'pytest_log_prefix': '[{0}] '.format(syndic_log_prefix)
}
master_config = copy.deepcopy(default_master_options)
master_config.update(master_overrides)
if master_config_overrides:
# Merge in the default options with the minion_config_overrides
dictupdate.update(master_config, master_config_overrides, merge_lists=True)
# Write down the master computed configuration into the config file
with salt.utils.fopen(syndic_master_config_file, 'w') as wfh:
wfh.write(yamlserialize.serialize(master_config))
default_minion_options = copy.deepcopy(minion_config)
minion_overrides = {
'id': syndic_id,
}
minion_config = copy.deepcopy(default_minion_options)
minion_config.update(minion_overrides)
if minion_config_overrides:
# Merge in the default options with the minion_config_overrides
dictupdate.update(minion_config, minion_config_overrides, merge_lists=True)
# Write down the minion computed configuration into the config file
with salt.utils.fopen(syndic_minion_config_file, 'w') as wfh:
wfh.write(yamlserialize.serialize(minion_config))
options = salt.config.syndic_config(syndic_master_config_file, syndic_minion_config_file)
return options
@pytest.fixture
def syndic_config(master_config,
minion_config,
syndic_conf_dir,
syndic_engine_port,
syndic_master_config_overrides,
syndic_minion_config_overrides,
running_username,
salt_log_port,
syndic_log_prefix,
syndic_id):
'''
This fixture will return the salt syndic configuration options after being
overridden with any options passed from ``syndic_master_config_overrides``
and ``syndic_minion_config_overrides``
'''
return apply_syndic_config(master_config,
minion_config,
syndic_conf_dir,
syndic_engine_port,
syndic_master_config_overrides,
syndic_minion_config_overrides,
running_username,
salt_log_port,
syndic_log_prefix,
syndic_id)
@pytest.fixture(scope='session')
def session_syndic_config(session_master_config,
session_minion_config,
session_syndic_conf_dir,
session_syndic_engine_port,
session_syndic_master_config_overrides,
session_syndic_minion_config_overrides,
running_username,
salt_log_port,
session_syndic_log_prefix,
session_syndic_id):
'''
This fixture will return the salt syndic configuration options after being
overridden with any options passed from ``syndic_master_config_overrides``
and ``syndic_minion_config_overrides``
'''
return apply_syndic_config(session_master_config,
session_minion_config,
session_syndic_conf_dir,
session_syndic_engine_port,
session_syndic_master_config_overrides,
session_syndic_minion_config_overrides,
running_username,
salt_log_port,
session_syndic_log_prefix,
session_syndic_id)
@pytest.fixture
def salt_ssh_log_prefix(sshd_port):
return 'salt-ssh/{0}'.format(sshd_port)
@pytest.fixture(scope='session')
def session_salt_ssh_log_prefix(session_sshd_port):
return 'salt-ssh/{0}'.format(session_sshd_port)
@pytest.fixture
def ssh_client_key(ssh_config_dir):
'''
The ssh client key
'''
return _generate_ssh_key(ssh_config_dir.join('test_key').realpath().strpath)
@pytest.fixture(scope='session')
def session_ssh_client_key(session_ssh_config_dir):
'''
The ssh client key
'''
return _generate_ssh_key(session_ssh_config_dir.join('test_key').realpath().strpath)
def _sshd_config_lines(sshd_port):
'''
Return a list of lines which will make the sshd_config file
'''
return [
'Port {0}'.format(sshd_port),
'ListenAddress 127.0.0.1',
'Protocol 2',
'UsePrivilegeSeparation yes',
'# Turn strict modes off so that we can operate in /tmp',
'StrictModes no',
'# Lifetime and size of ephemeral version 1 server key',
'KeyRegenerationInterval 3600',
'ServerKeyBits 1024',
'# Logging',
'SyslogFacility AUTH',
'LogLevel INFO',
'# Authentication:',
'LoginGraceTime 120',
'PermitRootLogin without-password',
'StrictModes yes',
'RSAAuthentication yes',
'PubkeyAuthentication yes',
'#AuthorizedKeysFile %h/.ssh/authorized_keys',
'#AuthorizedKeysFile key_test.pub',
'# Don\'t read the user\'s ~/.rhosts and ~/.shosts files',
'IgnoreRhosts yes',
'# For this to work you will also need host keys in /etc/ssh_known_hosts',
'RhostsRSAAuthentication no',
'# similar for protocol version 2',
'HostbasedAuthentication no',
'#IgnoreUserKnownHosts yes',
'# To enable empty passwords, change to yes (NOT RECOMMENDED)',
'PermitEmptyPasswords no',
'# Change to yes to enable challenge-response passwords (beware issues with',
'# some PAM modules and threads)',
'ChallengeResponseAuthentication no',
'# Change to no to disable tunnelled clear text passwords',
'PasswordAuthentication no',
'X11Forwarding no',
'X11DisplayOffset 10',
'PrintMotd no',
'PrintLastLog yes',
'TCPKeepAlive yes',
'#UseLogin no',
'AcceptEnv LANG LC_*',
'Subsystem sftp /usr/lib/openssh/sftp-server',
'#UsePAM yes',
]
@pytest.fixture
def sshd_config_lines(sshd_port):
'''
Return a list of lines which will make the sshd_config file
'''
return _sshd_config_lines(sshd_port)
@pytest.fixture(scope='session')
def session_sshd_config_lines(session_sshd_port):
'''
Return a list of lines which will make the sshd_config file
'''
return _sshd_config_lines(session_sshd_port)
@pytest.fixture
def write_sshd_config(sshd_config_dir, sshd_config_lines, ssh_client_key):
'''
This fixture will write the necessary configuration to run an SSHD server to be used in tests
'''
return _write_sshd_config(sshd_config_dir, sshd_config_lines, ssh_client_key)
@pytest.fixture(scope='session')
def session_write_sshd_config(session_sshd_config_dir, session_sshd_config_lines, session_ssh_client_key):
'''
This fixture will write the necessary configuration to run an SSHD server to be used in tests
'''
return _write_sshd_config(session_sshd_config_dir, session_sshd_config_lines, session_ssh_client_key)
@pytest.fixture
def _write_sshd_config(sshd_config_dir, sshd_config_lines, ssh_client_key):
'''
This fixture will write the necessary configuration to run an SSHD server to be used in tests
'''
import salt.utils
sshd = salt.utils.which('sshd')
if not sshd:
pytest.skip('"sshd" not found.')
# Generate server key
server_key_dir = sshd_config_dir.realpath().strpath
server_dsa_key_file = os.path.join(server_key_dir, 'ssh_host_dsa_key')
server_ecdsa_key_file = os.path.join(server_key_dir, 'ssh_host_ecdsa_key')
server_ed25519_key_file = os.path.join(server_key_dir, 'ssh_host_ed25519_key')
_generate_ssh_key(server_dsa_key_file, 'dsa', 1024)
_generate_ssh_key(server_ecdsa_key_file, 'ecdsa', 521)
_generate_ssh_key(server_ed25519_key_file, 'ed25519', 521)
sshd_config = sshd_config_lines[:]
sshd_config.append('AuthorizedKeysFile {0}.pub'.format(ssh_client_key))
sshd_config.append('HostKey {0}'.format(server_dsa_key_file))
sshd_config.append('HostKey {0}'.format(server_ecdsa_key_file))
sshd_config.append('HostKey {0}'.format(server_ed25519_key_file))
with salt.utils.fopen(sshd_config_dir.join('sshd_config').realpath().strpath, 'w') as wfh:
wfh.write('\n'.join(sshd_config))
@pytest.fixture
def sshd_server_log_prefix(sshd_port):
'''
The log prefix to use for the sshd server fixture
'''
return 'sshd-server/{0}'.format(sshd_port)
@pytest.fixture(scope='session')
def session_sshd_server_log_prefix(session_sshd_port):
'''
The log prefix to use for the sshd server fixture
'''
return 'session-sshd-server/{0}'.format(session_sshd_port)
def _generate_ssh_key(key_path, key_type='ecdsa', key_size=521):
'''
Generate an SSH key
'''
import salt.utils
log.debug('Generating ssh key(type: %s; size: %d; path: %s;)', key_type, key_size, key_path)
keygen = salt.utils.which('ssh-keygen')
if not keygen:
pytest.skip('"ssh-keygen" not found')
keygen_process = subprocess.Popen(
[
keygen,
'-t', key_type,
'-b', str(key_size),
'-C', '"$(whoami)@$(hostname)-$(date -I)"',
'-f', os.path.basename(key_path),
'-P', ''
],
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
close_fds=True,
cwd=os.path.dirname(key_path)
)
_, keygen_err = keygen_process.communicate()
if keygen_err:
pytest.skip(
'ssh-keygen had errors generating {0}({1}:{2}): {3}'.format(
os.path.basename(key_path),
key_type,
key_size,
keygen_err
)
)
return key_path
@pytest.fixture
def roster_config_file(conf_dir):
'''
Returns the path to the salt-ssh roster configuration file
'''
return conf_dir.join('roster').realpath().strpath
@pytest.fixture(scope='session')
def session_roster_config_file(session_conf_dir):
'''
Returns the path to the salt-ssh roster configuration file
'''
return session_conf_dir.join('roster').realpath().strpath
@pytest.fixture
def roster_config_overrides():
'''
This fixture should be implemented to overwrite default salt-ssh roster
configuration options.
It will be applied over the loaded default options
'''
@pytest.fixture(scope='session')
def session_roster_config_overrides():
'''
This fixture should be implemented to overwrite default salt-ssh roster
configuration options.
It will be applied over the loaded default options
'''
def _roster_config(config_file, config, config_overrides):
import salt.utils
import salt.serializers.yaml as yamlserialize
if config_overrides:
config.update(config_overrides)
with salt.utils.fopen(config_file, 'w') as wfh:
wfh.write(yamlserialize.serialize(config))
return config
@pytest.fixture
def roster_config(roster_config_file,
roster_config_overrides,
running_username,
ssh_client_key,
master_config,
sshd_port):
config = {
'localhost': {
'host': '127.0.0.1',
'port': sshd_port,
'user': running_username,
'priv': ssh_client_key
}
}
return _roster_config(roster_config_file, config, roster_config_overrides)
@pytest.fixture(scope='session')
def session_roster_config(session_roster_config_file,
session_roster_config_overrides,
running_username,
session_ssh_client_key,
session_sshd_port,
session_master_config):
config = {
'localhost': {
'host': '127.0.0.1',
'port': session_sshd_port,
'user': running_username,
'priv': session_ssh_client_key
}
}
return _roster_config(session_roster_config_file, config, session_roster_config_overrides)
@pytest.mark.trylast
def pytest_configure(config):
pytest.helpers.utils.register(apply_master_config)
pytest.helpers.utils.register(apply_minion_config)
pytest.helpers.utils.register(apply_syndic_config)
|