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
|
import errno
import os
import re
import signal
import stat
import subprocess
from configparser import RawConfigParser
from datetime import datetime
from urllib.parse import urlsplit
from dateutil.relativedelta import relativedelta
from dateutil.tz import tzlocal, tzutc
from awscli.compat import urlparse
from awscli.customizations.codeartifact.login import (
BaseLogin,
CommandFailedError,
DotNetLogin,
NpmLogin,
NuGetLogin,
PipLogin,
SwiftLogin,
TwineLogin,
get_relative_expiration_time,
)
from awscli.testutils import FileCreator, mock, skip_if_windows, unittest
class TestBaseLogin(unittest.TestCase):
def setUp(self):
self.domain = 'domain'
self.domain_owner = 'domain-owner'
self.package_format = 'npm'
self.repository = 'repository'
self.auth_token = 'auth-token'
self.expiration = (
datetime.now(tzlocal())
+ relativedelta(hours=10)
+ relativedelta(minutes=9)
).replace(microsecond=0)
self.endpoint = (
f'https://{self.domain}-{self.domain_owner}.codeartifact.aws.'
f'a2z.com/{self.package_format}/{self.repository}/'
)
self.subprocess_utils = mock.Mock()
self.test_subject = BaseLogin(
self.auth_token,
self.expiration,
self.endpoint,
self.domain,
self.repository,
self.subprocess_utils,
)
def test_login(self):
with self.assertRaises(NotImplementedError):
self.test_subject.login()
def test_get_commands(self):
with self.assertRaises(NotImplementedError):
self.test_subject.get_commands(self.endpoint, self.auth_token)
def test_run_commands_command_failed(self):
error_to_be_caught = subprocess.CalledProcessError(
returncode=1,
cmd=['cmd'],
output=None,
stderr=b'Command error message.',
)
self.subprocess_utils.run.side_effect = error_to_be_caught
with self.assertRaisesRegex(
CommandFailedError,
rf"{re.escape(str(error_to_be_caught))}"
rf" Stderr from command:\nCommand error message.",
):
self.test_subject._run_commands('tool', ['cmd'])
def test_run_commands_command_failed_redact_auth_token(self):
error_to_be_caught = subprocess.CalledProcessError(
returncode=1,
cmd=['cmd', 'with', 'auth-token', 'present'],
output=None,
stderr=b'Command error message.',
)
self.subprocess_utils.run.side_effect = error_to_be_caught
with self.assertRaisesRegex(
CommandFailedError,
(
r"(?=.*cmd)(?=.*with)(?!.*auth-token)(?=.*present)"
r"(?=.*Stderr from command:\nCommand error message.)"
),
):
self.test_subject._run_commands('tool', ['cmd'])
def test_run_commands_nonexistent_command(self):
self.subprocess_utils.run.side_effect = OSError(
errno.ENOENT, 'not found error'
)
tool = 'NotSupported'
with self.assertRaisesRegex(ValueError, f'{tool} was not found.'):
self.test_subject._run_commands(tool, ['echo', tool])
def test_run_commands_unhandled_error(self):
self.subprocess_utils.run.side_effect = OSError(
errno.ENOSYS, 'unhandled error'
)
tool = 'NotSupported'
with self.assertRaisesRegex(OSError, 'unhandled error'):
self.test_subject._run_commands(tool, ['echo', tool])
def handle_timeout(signum, frame, test_name):
raise TimeoutError(f"{test_name} timed out!!")
class TestSwiftLogin(unittest.TestCase):
def setUp(self):
self.domain = 'domain'
self.domain_owner = 'domain-owner'
self.package_format = 'swift'
self.repository = 'repository'
self.auth_token = 'auth-token'
self.namespace = 'namespace'
self.expiration = (
datetime.now(tzlocal())
+ relativedelta(hours=10)
+ relativedelta(minutes=9)
).replace(microsecond=0)
self.endpoint = (
f'https://{self.domain}-{self.domain_owner}.codeartifact'
f'.aws.a2z.com/{self.package_format}/{self.repository}/'
)
self.hostname = urlparse.urlparse(self.endpoint).hostname
self.new_entry = SwiftLogin.DEFAULT_NETRC_FMT.format(
hostname=self.hostname, auth_token=self.auth_token
)
self.file_creator = FileCreator()
self.test_netrc_path = self.file_creator.full_path('netrc')
self.get_netrc_path_patch = mock.patch(
'awscli.customizations.codeartifact.login.SwiftLogin'
'.get_netrc_path'
)
self.get_netrc_path_mock = self.get_netrc_path_patch.start()
self.get_netrc_path_mock.return_value = self.test_netrc_path
self.base_command = ['swift', 'package-registry', 'set', self.endpoint]
self.macos_commands = [
self.base_command[:],
[
'swift',
'package-registry',
'login',
self.endpoint + 'login',
'--token',
self.auth_token,
],
]
self.non_macos_commands = [
self.base_command[:],
['swift', 'package-registry', 'login', self.endpoint + 'login'],
]
self.subprocess_utils = mock.Mock()
self.test_subject = SwiftLogin(
self.auth_token,
self.expiration,
self.endpoint,
self.domain,
self.repository,
self.subprocess_utils,
)
def tearDown(self):
self.get_netrc_path_patch.stop()
self.file_creator.remove_all()
def _assert_netrc_has_expected_content(self, expected_contents):
with open(self.test_netrc_path) as file:
actual_contents = file.read()
self.assertEqual(expected_contents, actual_contents)
def _assert_netrc_has_expected_permissions(self):
file_stat = os.stat(self.test_netrc_path)
file_mode = file_stat.st_mode
self.assertTrue(stat.S_IRUSR & file_mode)
self.assertTrue(stat.S_IWUSR & file_mode)
def test_get_netrc_path(self):
self.assertEqual(SwiftLogin.get_netrc_path(), self.test_netrc_path)
def test_regex_only_match_escaped_hostname(self):
pattern = re.compile(
SwiftLogin.NETRC_REGEX_FMT.format(
escaped_hostname=re.escape(self.hostname)
),
re.M,
)
bad_endpoint = (
f'https://{self.domain}-{self.domain_owner}-codeartifact'
f'-aws-a2z-com/{self.package_format}/{self.repository}/'
)
bad_hostname = urlparse.urlparse(bad_endpoint).hostname
bad_entry = SwiftLogin.DEFAULT_NETRC_FMT.format(
hostname=bad_hostname, auth_token=self.auth_token
)
self.assertTrue(pattern.match(self.new_entry))
self.assertFalse(pattern.match(bad_entry))
def test_create_netrc_if_not_exist(self):
self.assertFalse(os.path.exists(self.test_netrc_path))
self.test_subject._update_netrc_entry(
self.hostname, 'a new entry', self.test_netrc_path
)
self.assertTrue(os.path.exists(self.test_netrc_path))
self._assert_netrc_has_expected_permissions()
self._assert_netrc_has_expected_content('a new entry\n')
def test_replacement_token_has_backslash(self):
existing_content = f'machine {self.hostname} login token password expired-auth-token\n'
with open(self.test_netrc_path, 'w+') as f:
f.write(existing_content)
self.test_subject.auth_token = r'new-token_.\1\g<entry_start>\n\w'
# make sure it uses re.sub() to replace the token
self.test_subject._update_netrc_entry(
self.hostname, '', self.test_netrc_path
)
self.assertTrue(os.path.exists(self.test_netrc_path))
self._assert_netrc_has_expected_content(
f'machine {self.hostname} login token password {self.test_subject.auth_token}\n'
)
def test_update_netrc_with_existing_entry(self):
existing_content = f'machine {self.hostname} login token password expired-auth-token\n'
expected_content = f'{self.new_entry}\n'
with open(self.test_netrc_path, 'w+') as f:
f.write(existing_content)
self.test_subject._update_netrc_entry(
self.hostname, self.new_entry, self.test_netrc_path
)
self._assert_netrc_has_expected_content(expected_content)
def test_update_netrc_with_existing_entry_in_between(self):
existing_content = (
f'some random line above\n'
f'machine {self.hostname} login token password expired-auth-token\n'
f'some random line below\n'
)
expected_content = (
f'some random line above\n'
f'{self.new_entry}\n'
f'some random line below\n'
)
with open(self.test_netrc_path, 'w+') as f:
f.write(existing_content)
self.test_subject._update_netrc_entry(
self.hostname, self.new_entry, self.test_netrc_path
)
self._assert_netrc_has_expected_content(expected_content)
def test_append_netrc_without_ending_newline(self):
existing_content = 'machine host login user password 1234'
expected_content = (
f'machine host login user password 1234\n' f'{self.new_entry}\n'
)
with open(self.test_netrc_path, 'w+') as f:
f.write(existing_content)
self.test_subject._update_netrc_entry(
self.hostname, self.new_entry, self.test_netrc_path
)
self._assert_netrc_has_expected_content(expected_content)
def test_append_netrc_with_ending_newline(self):
existing_content = 'machine host login user password 1234\n'
expected_content = (
f'machine host login user password 1234\n' f'{self.new_entry}\n'
)
with open(self.test_netrc_path, 'w+') as f:
f.write(existing_content)
self.test_subject._update_netrc_entry(
self.hostname, self.new_entry, self.test_netrc_path
)
self._assert_netrc_has_expected_content(expected_content)
def test_update_netrc_with_multiple_spaces_and_newlines(self):
existing_content = (
f' machine {self.hostname}\n'
f' login token \n'
f'password expired-auth-token \n'
f'\n'
f'machine example1.com\n'
f' login user1 \n'
f'password 1234\n'
)
expected_content = (
f' machine {self.hostname}\n'
f' login token \n'
f'password auth-token \n'
f'\n'
f'machine example1.com\n'
f' login user1 \n'
f'password 1234\n'
)
with open(self.test_netrc_path, 'w+') as f:
f.write(existing_content)
self.test_subject._update_netrc_entry(
self.hostname, self.new_entry, self.test_netrc_path
)
self._assert_netrc_has_expected_content(expected_content)
def test_update_netrc_with_multiple_existing_entries(self):
existing_content = (
f'machine {self.hostname} login token password expired-auth-token-1\n'
f'machine {self.hostname} login token password expired-auth-token-2\n'
)
expected_content = f'{self.new_entry}\n' f'{self.new_entry}\n'
with open(self.test_netrc_path, 'w+') as f:
f.write(existing_content)
self.test_subject._update_netrc_entry(
self.hostname, self.new_entry, self.test_netrc_path
)
self._assert_netrc_has_expected_content(expected_content)
@mock.patch('awscli.customizations.codeartifact.login.is_macos', True)
def test_login_macos(self):
self.test_subject.login()
expected_calls = [
mock.call(command, capture_output=True, check=True)
for command in self.macos_commands
]
self.subprocess_utils.run.assert_has_calls(
expected_calls, any_order=True
)
@mock.patch('awscli.customizations.codeartifact.login.is_macos', False)
def test_login_non_macos(self):
self.test_subject.login()
expected_calls = [
mock.call(command, capture_output=True, check=True)
for command in self.non_macos_commands
]
self.subprocess_utils.run.assert_has_calls(
expected_calls, any_order=True
)
def test_login_swift_tooling_error(self):
self.subprocess_utils.run.side_effect = subprocess.CalledProcessError(
returncode=1, cmd='swift command', stderr=b''
)
with self.assertRaises(CommandFailedError):
self.test_subject.login()
def test_login_swift_not_installed(self):
self.subprocess_utils.run.side_effect = OSError(
errno.ENOENT, 'not found error'
)
with self.assertRaisesRegex(
ValueError, 'swift was not found. Please verify installation.'
):
self.test_subject.login()
def test_get_scope(self):
expected_value = 'namespace'
scope = self.test_subject.get_scope(self.namespace)
self.assertEqual(scope, expected_value)
def test_get_scope_none_namespace(self):
expected_value = None
scope = self.test_subject.get_scope(None)
self.assertEqual(scope, expected_value)
def test_get_scope_invalid_leading_character(self):
with self.assertRaises(ValueError):
self.test_subject.get_scope(f'.{self.namespace}')
def test_get_scope_invalid_length(self):
with self.assertRaises(ValueError):
self.test_subject.get_scope("a" * 40)
@mock.patch('awscli.customizations.codeartifact.login.is_macos', True)
def test_get_commands_macos(self):
commands = self.test_subject.get_commands(
self.endpoint, self.auth_token
)
self.assertCountEqual(commands, self.macos_commands)
@mock.patch('awscli.customizations.codeartifact.login.is_macos', False)
def test_get_commands_non_macos(self):
commands = self.test_subject.get_commands(
self.endpoint, self.auth_token
)
self.assertCountEqual(commands, self.non_macos_commands)
@mock.patch('awscli.customizations.codeartifact.login.is_macos', True)
def test_get_commands_with_scope_macos(self):
commands = self.test_subject.get_commands(
self.endpoint, self.auth_token, scope=self.namespace
)
self.macos_commands[0] += ['--scope', self.namespace]
self.assertCountEqual(commands, self.macos_commands)
@mock.patch('awscli.customizations.codeartifact.login.is_macos', False)
def test_get_commands_with_scope_non_macos(self):
commands = self.test_subject.get_commands(
self.endpoint, self.auth_token, scope=self.namespace
)
self.non_macos_commands[0] += ['--scope', self.namespace]
self.assertCountEqual(commands, self.non_macos_commands)
def test_login_dry_run(self):
self.test_subject.login(dry_run=True)
self.subprocess_utils.check_output.assert_not_called()
self.assertFalse(os.path.exists(self.test_netrc_path))
class TestNuGetLogin(unittest.TestCase):
_NUGET_INDEX_URL_FMT = NuGetLogin._NUGET_INDEX_URL_FMT
_NUGET_SOURCES_LIST_RESPONSE = b"""\
Registered Sources:
1. Source Name 1 [Enabled]
https://source1.com/index.json
2. Ab[.d7 $#!], [Disabled]
https://source2.com/index.json"""
_NUGET_SOURCES_LIST_RESPONSE_BACKTRACKING = b'1.' + b' ' * 10000 + b'a'
_NUGET_SOURCES_LIST_RESPONSE_WITH_SPACE = b"""\
Registered Sources:
1. Source Name 1 [Enabled]
https://source1.com/index.json
2. Ab[.d7 $#!], [Disabled]
https://source2.com/index.json"""
def setUp(self):
self.domain = 'domain'
self.domain_owner = 'domain-owner'
self.package_format = 'nuget'
self.repository = 'repository'
self.auth_token = 'auth-token'
self.expiration = (
datetime.now(tzlocal())
+ relativedelta(hours=10)
+ relativedelta(minutes=9)
).replace(microsecond=0)
self.endpoint = (
f'https://{self.domain}-{self.domain_owner}.codeartifact.aws.'
f'a2z.com/{self.package_format}/{self.repository}/'
)
self.nuget_index_url = self._NUGET_INDEX_URL_FMT.format(
endpoint=self.endpoint,
)
self.source_name = self.domain + '/' + self.repository
self.list_operation_command = [
'nuget',
'sources',
'list',
'-format',
'detailed',
]
self.add_operation_command = [
'nuget',
'sources',
'add',
'-name',
self.source_name,
'-source',
self.nuget_index_url,
'-username',
'aws',
'-password',
self.auth_token,
]
self.update_operation_command = [
'nuget',
'sources',
'update',
'-name',
self.source_name,
'-source',
self.nuget_index_url,
'-username',
'aws',
'-password',
self.auth_token,
]
self.subprocess_utils = mock.Mock()
self.test_subject = NuGetLogin(
self.auth_token,
self.expiration,
self.endpoint,
self.domain,
self.repository,
self.subprocess_utils,
)
def test_login(self):
self.subprocess_utils.check_output.return_value = (
self._NUGET_SOURCES_LIST_RESPONSE
)
self.test_subject.login()
self.subprocess_utils.check_output.assert_any_call(
self.list_operation_command, stderr=self.subprocess_utils.PIPE
)
self.subprocess_utils.run.assert_called_with(
self.add_operation_command, capture_output=True, check=True
)
def test_login_dry_run(self):
self.subprocess_utils.check_output.return_value = (
self._NUGET_SOURCES_LIST_RESPONSE
)
self.test_subject.login(dry_run=True)
self.subprocess_utils.check_output.assert_called_once_with(
['nuget', 'sources', 'list', '-format', 'detailed'],
stderr=self.subprocess_utils.PIPE,
)
def test_login_old_nuget(self):
self.subprocess_utils.check_output.return_value = (
self._NUGET_SOURCES_LIST_RESPONSE_WITH_SPACE
)
self.test_subject.login()
self.subprocess_utils.check_output.assert_any_call(
self.list_operation_command, stderr=self.subprocess_utils.PIPE
)
self.subprocess_utils.run.assert_called_with(
self.add_operation_command, capture_output=True, check=True
)
def test_login_dry_run_old_nuget(self):
self.subprocess_utils.check_output.return_value = (
self._NUGET_SOURCES_LIST_RESPONSE_WITH_SPACE
)
self.test_subject.login(dry_run=True)
self.subprocess_utils.check_output.assert_called_once_with(
['nuget', 'sources', 'list', '-format', 'detailed'],
stderr=self.subprocess_utils.PIPE,
)
def test_login_source_name_already_exists(self):
list_response = (
'Registered Sources:\n'
' 1. ' + self.source_name + ' [ENABLED]\n'
' https://source.com/index.json'
)
self.subprocess_utils.check_output.return_value = list_response.encode(
'utf-8'
)
self.test_subject.login()
self.subprocess_utils.run.assert_called_with(
self.update_operation_command, capture_output=True, check=True
)
def test_login_source_url_already_exists_old_nuget(self):
non_default_source_name = 'Source Name'
list_response = (
'Registered Sources:\n'
'\n'
' 1. ' + non_default_source_name + ' [ENABLED]\n'
' ' + self.nuget_index_url
)
self.subprocess_utils.check_output.return_value = list_response.encode(
'utf-8'
)
self.test_subject.login()
self.subprocess_utils.run.assert_called_with(
[
'nuget',
'sources',
'update',
'-name',
non_default_source_name,
'-source',
self.nuget_index_url,
'-username',
'aws',
'-password',
self.auth_token,
],
capture_output=True,
check=True,
)
def test_login_source_url_already_exists(self):
non_default_source_name = 'Source Name'
list_response = (
'Registered Sources:\n'
' 1. ' + non_default_source_name + ' [ENABLED]\n'
' ' + self.nuget_index_url
)
self.subprocess_utils.check_output.return_value = list_response.encode(
'utf-8'
)
self.test_subject.login()
self.subprocess_utils.run.assert_called_with(
[
'nuget',
'sources',
'update',
'-name',
non_default_source_name,
'-source',
self.nuget_index_url,
'-username',
'aws',
'-password',
self.auth_token,
],
capture_output=True,
check=True,
)
def test_login_nuget_not_installed(self):
self.subprocess_utils.check_output.side_effect = OSError(
errno.ENOENT, 'not found error'
)
with self.assertRaisesRegex(
ValueError, 'nuget was not found. Please verify installation.'
):
self.test_subject.login()
@skip_if_windows("Windows does not support signal.SIGALRM.")
def test_login_nuget_sources_listed_with_backtracking(self):
self.subprocess_utils.check_output.return_value = (
self._NUGET_SOURCES_LIST_RESPONSE_BACKTRACKING
)
signal.signal(
signal.SIGALRM,
lambda signum, frame: handle_timeout(signum, frame, self.id()),
)
signal.alarm(10)
self.test_subject.login()
signal.alarm(0)
self.subprocess_utils.check_output.assert_any_call(
self.list_operation_command, stderr=self.subprocess_utils.PIPE
)
class TestDotNetLogin(unittest.TestCase):
_NUGET_INDEX_URL_FMT = NuGetLogin._NUGET_INDEX_URL_FMT
_NUGET_SOURCES_LIST_RESPONSE = b"""\
Registered Sources:
1. Source Name 1 [Enabled]
https://source1.com/index.json
2. Ab[.d7 $#!], [Disabled]
https://source2.com/index.json"""
_NUGET_SOURCES_LIST_RESPONSE_BACKTRACKING = b'1.' + b' ' * 10000 + b'a'
_NUGET_SOURCES_LIST_RESPONSE_WITH_EXTRA_NON_LIST_TEXT = b"""\
Welcome to dotnet 2.0!
Registered Sources:
1. Source Name 1 [Enabled]
https://source1.com/index.json
2. ati-nugetserver [Disabled]
http://atinugetserver-env.elasticbeanstalk.com/nuget
warn : You are running the 'list source' operation with an 'HTTP' source,
'ati-nugetserver' [http://atinugetserver-env..elasticbeanstalk.com/nuget]'.
Non-HTTPS access will be removed in a future version. Consider migrating
to an 'HTTPS' source."""
def setUp(self):
self.domain = 'domain'
self.domain_owner = 'domain-owner'
self.package_format = 'nuget'
self.repository = 'repository'
self.auth_token = 'auth-token'
self.expiration = (
datetime.now(tzlocal())
+ relativedelta(hours=10)
+ relativedelta(minutes=9)
).replace(microsecond=0)
self.endpoint = (
f'https://{self.domain}-{self.domain_owner}.codeartifact.aws.'
f'a2z.com/{self.package_format}/{self.repository}/'
)
self.nuget_index_url = self._NUGET_INDEX_URL_FMT.format(
endpoint=self.endpoint,
)
self.source_name = self.domain + '/' + self.repository
self.list_operation_command = [
'dotnet',
'nuget',
'list',
'source',
'--format',
'detailed',
]
self.add_operation_command_windows = [
'dotnet',
'nuget',
'add',
'source',
self.nuget_index_url,
'--name',
self.source_name,
'--username',
'aws',
'--password',
self.auth_token,
]
self.add_operation_command_non_windows = [
'dotnet',
'nuget',
'add',
'source',
self.nuget_index_url,
'--name',
self.source_name,
'--username',
'aws',
'--password',
self.auth_token,
'--store-password-in-clear-text',
]
self.update_operation_command_windows = [
'dotnet',
'nuget',
'update',
'source',
self.source_name,
'--source',
self.nuget_index_url,
'--username',
'aws',
'--password',
self.auth_token,
]
self.update_operation_command_non_windows = [
'dotnet',
'nuget',
'update',
'source',
self.source_name,
'--source',
self.nuget_index_url,
'--username',
'aws',
'--password',
self.auth_token,
'--store-password-in-clear-text',
]
self.subprocess_utils = mock.Mock()
self.test_subject = DotNetLogin(
self.auth_token,
self.expiration,
self.endpoint,
self.domain,
self.repository,
self.subprocess_utils,
)
@mock.patch('awscli.customizations.codeartifact.login.is_windows', False)
def test_login(self):
self.subprocess_utils.check_output.return_value = (
self._NUGET_SOURCES_LIST_RESPONSE
)
self.test_subject.login()
self.subprocess_utils.check_output.assert_any_call(
self.list_operation_command, stderr=self.subprocess_utils.PIPE
)
self.subprocess_utils.run.assert_called_with(
self.add_operation_command_non_windows,
capture_output=True,
check=True,
)
@mock.patch('awscli.customizations.codeartifact.login.is_windows', True)
def test_login_on_windows(self):
self.subprocess_utils.check_output.return_value = (
self._NUGET_SOURCES_LIST_RESPONSE
)
self.test_subject.login()
self.subprocess_utils.check_output.assert_any_call(
self.list_operation_command, stderr=self.subprocess_utils.PIPE
)
self.subprocess_utils.run.assert_called_with(
self.add_operation_command_windows, capture_output=True, check=True
)
def test_login_dry_run(self):
self.subprocess_utils.check_output.return_value = (
self._NUGET_SOURCES_LIST_RESPONSE
)
self.test_subject.login(dry_run=True)
self.subprocess_utils.check_output.assert_called_once_with(
self.list_operation_command, stderr=self.subprocess_utils.PIPE
)
@mock.patch('awscli.customizations.codeartifact.login.is_windows', False)
def test_login_sources_listed_with_extra_non_list_text(self):
self.subprocess_utils.check_output.return_value = (
self._NUGET_SOURCES_LIST_RESPONSE_WITH_EXTRA_NON_LIST_TEXT
)
self.test_subject.login()
self.subprocess_utils.check_output.assert_any_call(
self.list_operation_command, stderr=self.subprocess_utils.PIPE
)
self.subprocess_utils.run.assert_called_with(
self.add_operation_command_non_windows,
capture_output=True,
check=True,
)
@mock.patch('awscli.customizations.codeartifact.login.is_windows', True)
def test_login_sources_listed_with_extra_non_list_text_on_windows(self):
self.subprocess_utils.check_output.return_value = (
self._NUGET_SOURCES_LIST_RESPONSE_WITH_EXTRA_NON_LIST_TEXT
)
self.test_subject.login()
self.subprocess_utils.check_output.assert_any_call(
self.list_operation_command, stderr=self.subprocess_utils.PIPE
)
self.subprocess_utils.run.assert_called_with(
self.add_operation_command_windows, capture_output=True, check=True
)
def test_login_sources_listed_with_extra_non_list_text_dry_run(self):
self.subprocess_utils.check_output.return_value = (
self._NUGET_SOURCES_LIST_RESPONSE_WITH_EXTRA_NON_LIST_TEXT
)
self.test_subject.login(dry_run=True)
self.subprocess_utils.check_output.assert_called_once_with(
self.list_operation_command, stderr=self.subprocess_utils.PIPE
)
@skip_if_windows("Windows does not support signal.SIGALRM.")
@mock.patch('awscli.customizations.codeartifact.login.is_windows', False)
def test_login_dotnet_sources_listed_with_backtracking(self):
self.subprocess_utils.check_output.return_value = (
self._NUGET_SOURCES_LIST_RESPONSE_BACKTRACKING
)
signal.signal(
signal.SIGALRM,
lambda signum, frame: handle_timeout(signum, frame, self.id()),
)
signal.alarm(10)
self.test_subject.login()
signal.alarm(0)
@skip_if_windows("Windows does not support signal.SIGALRM.")
@mock.patch('awscli.customizations.codeartifact.login.is_windows', True)
def test_login_dotnet_sources_listed_with_backtracking_windows(self):
self.subprocess_utils.check_output.return_value = (
self._NUGET_SOURCES_LIST_RESPONSE_BACKTRACKING
)
signal.signal(
signal.SIGALRM,
lambda signum, frame: handle_timeout(signum, frame, self.id()),
)
signal.alarm(10)
self.test_subject.login()
signal.alarm(0)
@mock.patch('awscli.customizations.codeartifact.login.is_windows', False)
def test_login_source_name_already_exists(self):
list_response = (
'Registered Sources:\n'
' 1. ' + self.source_name + ' [ENABLED]\n'
' https://source.com/index.json'
)
self.subprocess_utils.check_output.return_value = list_response.encode(
'utf-8'
)
self.test_subject.login()
self.subprocess_utils.run.assert_called_with(
self.update_operation_command_non_windows,
capture_output=True,
check=True,
)
@mock.patch('awscli.customizations.codeartifact.login.is_windows', True)
def test_login_source_name_already_exists_on_windows(self):
list_response = (
'Registered Sources:\n'
' 1. ' + self.source_name + ' [ENABLED]\n'
' https://source.com/index.json'
)
self.subprocess_utils.check_output.return_value = list_response.encode(
'utf-8'
)
self.test_subject.login()
self.subprocess_utils.run.assert_called_with(
self.update_operation_command_windows,
capture_output=True,
check=True,
)
@mock.patch('awscli.customizations.codeartifact.login.is_windows', True)
def test_login_source_url_already_exists(self):
non_default_source_name = 'Source Name'
list_response = (
'Registered Sources:\n'
' 1. ' + non_default_source_name + ' [ENABLED]\n'
' ' + self.nuget_index_url
)
self.subprocess_utils.check_output.return_value = list_response.encode(
'utf-8'
)
self.test_subject.login()
self.subprocess_utils.run.assert_called_with(
[
'dotnet',
'nuget',
'update',
'source',
non_default_source_name,
'--source',
self.nuget_index_url,
'--username',
'aws',
'--password',
self.auth_token,
],
capture_output=True,
check=True,
)
def test_login_dotnet_not_installed(self):
self.subprocess_utils.check_output.side_effect = OSError(
errno.ENOENT, 'not found error'
)
with self.assertRaisesRegex(
ValueError, 'dotnet was not found. Please verify installation.'
):
self.test_subject.login()
class TestNpmLogin(unittest.TestCase):
NPM_CMD = NpmLogin.NPM_CMD
def setUp(self):
self.domain = 'domain'
self.domain_owner = 'domain-owner'
self.package_format = 'npm'
self.repository = 'repository'
self.auth_token = 'auth-token'
self.namespace = 'namespace'
self.expiration = (
datetime.now(tzlocal())
+ relativedelta(hours=10)
+ relativedelta(minutes=9)
).replace(microsecond=0)
self.endpoint = (
f'https://{self.domain}-{self.domain_owner}.codeartifact.aws.'
f'a2z.com/{self.package_format}/{self.repository}/'
)
repo_uri = urlsplit(self.endpoint)
always_auth_config = f'//{repo_uri.netloc}{repo_uri.path}:always-auth'
auth_token_config = f'//{repo_uri.netloc}{repo_uri.path}:_authToken'
self.commands = []
self.commands.append(
[self.NPM_CMD, 'config', 'set', 'registry', self.endpoint]
)
self.commands.append(
[self.NPM_CMD, 'config', 'set', always_auth_config, 'true']
)
self.commands.append(
[self.NPM_CMD, 'config', 'set', auth_token_config, self.auth_token]
)
self.subprocess_utils = mock.Mock()
self.test_subject = NpmLogin(
self.auth_token,
self.expiration,
self.endpoint,
self.domain,
self.repository,
self.subprocess_utils,
)
def test_login(self):
self.test_subject.login()
expected_calls = [
mock.call(command, capture_output=True, check=True)
for command in self.commands
]
self.subprocess_utils.run.assert_has_calls(
expected_calls, any_order=True
)
def test_login_always_auth_error_ignored(self):
"""Test login ignores error for always-auth.
This test is for NPM version >= 9 where the support of 'always-auth'
has been dropped. Running the command to set config gives a non-zero
exit code. This is to make sure that login ignores that error and all
other commands executes successfully.
"""
def side_effect(command, capture_output, check):
"""Set side_effect for always-auth config setting command"""
if any('always-auth' in arg for arg in command):
raise subprocess.CalledProcessError(returncode=1, cmd=command)
return mock.DEFAULT
self.subprocess_utils.run.side_effect = side_effect
expected_calls = []
for command in self.commands:
expected_calls.append(
mock.call(command, capture_output=True, check=True)
)
self.test_subject.login()
self.subprocess_utils.run.assert_has_calls(
expected_calls, any_order=True
)
def test_get_scope(self):
expected_value = f'@{self.namespace}'
scope = self.test_subject.get_scope(self.namespace)
self.assertEqual(scope, expected_value)
def test_get_scope_none_namespace(self):
expected_value = None
scope = self.test_subject.get_scope(None)
self.assertEqual(scope, expected_value)
def test_get_scope_invalid_name(self):
with self.assertRaises(ValueError):
self.test_subject.get_scope(f'.{self.namespace}')
def test_get_scope_without_prefix(self):
expected_value = f'@{self.namespace}'
scope = self.test_subject.get_scope(f'@{self.namespace}')
self.assertEqual(scope, expected_value)
def test_get_commands(self):
commands = self.test_subject.get_commands(
self.endpoint, self.auth_token
)
self.assertCountEqual(commands, self.commands)
def test_get_commands_with_scope(self):
commands = self.test_subject.get_commands(
self.endpoint, self.auth_token, scope=self.namespace
)
self.commands[0][3] = f'{self.namespace}:registry'
self.assertCountEqual(commands, self.commands)
def test_login_dry_run(self):
self.test_subject.login(dry_run=True)
self.subprocess_utils.assert_not_called()
class TestPipLogin(unittest.TestCase):
PIP_INDEX_URL_FMT = PipLogin.PIP_INDEX_URL_FMT
def setUp(self):
self.domain = 'domain'
self.domain_owner = 'domain-owner'
self.package_format = 'pip'
self.repository = 'repository'
self.auth_token = 'auth-token'
self.expiration = (
datetime.now(tzlocal())
+ relativedelta(years=1)
+ relativedelta(months=9)
).replace(microsecond=0)
self.endpoint = (
f'https://{self.domain}-{self.domain_owner}.codeartifact.aws.'
f'a2z.com/{self.package_format}/{self.repository}/'
)
repo_uri = urlsplit(self.endpoint)
self.pip_index_url = self.PIP_INDEX_URL_FMT.format(
scheme=repo_uri.scheme,
auth_token=self.auth_token,
netloc=repo_uri.netloc,
path=repo_uri.path,
)
self.subprocess_utils = mock.Mock()
self.test_subject = PipLogin(
self.auth_token,
self.expiration,
self.endpoint,
self.domain,
self.repository,
self.subprocess_utils,
)
def test_get_commands(self):
expected_commands = [
['pip', 'config', 'set', 'global.index-url', self.pip_index_url]
]
commands = self.test_subject.get_commands(
self.endpoint, self.auth_token
)
self.assertCountEqual(commands, expected_commands)
def test_login(self):
self.test_subject.login()
self.subprocess_utils.run.assert_called_once_with(
['pip', 'config', 'set', 'global.index-url', self.pip_index_url],
capture_output=True,
check=True,
)
def test_login_dry_run(self):
self.test_subject.login(dry_run=True)
self.subprocess_utils.run.assert_not_called()
class TestTwineLogin(unittest.TestCase):
DEFAULT_PYPI_RC_FMT = TwineLogin.DEFAULT_PYPI_RC_FMT
def setUp(self):
self.file_creator = FileCreator()
self.domain = 'domain'
self.domain_owner = 'domain-owner'
self.package_format = 'pip'
self.repository = 'repository'
self.auth_token = 'auth-token'
self.expiration = (
datetime.now(tzlocal())
+ relativedelta(years=1)
+ relativedelta(months=9)
).replace(microsecond=0)
self.endpoint = (
f'https://{self.domain}-{self.domain_owner}.codeartifact.aws.'
f'a2z.com/{self.package_format}/{self.repository}/'
)
self.default_pypi_rc = self.DEFAULT_PYPI_RC_FMT.format(
repository_endpoint=self.endpoint, auth_token=self.auth_token
)
self.subprocess_utils = mock.Mock()
self.test_pypi_rc_path = self.file_creator.full_path('pypirc')
if not os.path.isdir(os.path.dirname(self.test_pypi_rc_path)):
os.makedirs(os.path.dirname(self.test_pypi_rc_path))
self.test_subject = TwineLogin(
self.auth_token,
self.expiration,
self.endpoint,
self.domain,
self.repository,
self.subprocess_utils,
self.test_pypi_rc_path,
)
def tearDown(self):
self.file_creator.remove_all()
def _assert_pypi_rc_has_expected_content(
self, pypi_rc_str, server, repo_url=None, username=None, password=None
):
pypi_rc = RawConfigParser()
pypi_rc.read_string(pypi_rc_str)
self.assertIn('distutils', pypi_rc.sections())
self.assertIn('index-servers', pypi_rc.options('distutils'))
index_servers = pypi_rc.get('distutils', 'index-servers')
index_servers = [
index_server.strip()
for index_server in index_servers.split('\n')
if index_server.strip() != ''
]
self.assertIn(server, index_servers)
if repo_url or username or password:
self.assertIn(server, pypi_rc.sections())
if repo_url:
self.assertIn('repository', pypi_rc.options(server))
self.assertEqual(pypi_rc.get(server, 'repository'), repo_url)
if username:
self.assertIn('username', pypi_rc.options(server))
self.assertEqual(pypi_rc.get(server, 'username'), username)
if password:
self.assertIn('password', pypi_rc.options(server))
self.assertEqual(pypi_rc.get(server, 'password'), password)
def test_get_pypi_rc_path(self):
self.assertEqual(
TwineLogin.get_pypi_rc_path(),
os.path.join(os.path.expanduser("~"), ".pypirc"),
)
def test_login_pypi_rc_not_found_defaults_set(self):
self.test_subject.login()
with open(self.test_pypi_rc_path) as f:
test_pypi_rc_str = f.read()
self._assert_pypi_rc_has_expected_content(
pypi_rc_str=test_pypi_rc_str,
server='codeartifact',
repo_url=self.endpoint,
username='aws',
password=self.auth_token,
)
def test_login_dry_run(self):
self.test_subject.login(dry_run=True)
self.subprocess_utils.run.assert_not_called()
self.assertFalse(os.path.exists(self.test_pypi_rc_path))
def test_login_existing_pypi_rc_not_clobbered(self):
existing_pypi_rc = '''\
[distutils]
index-servers=
pypi
test
[pypi]
repository: http://www.python.org/pypi/
username: monty
password: JgCXIr5xGG
[test]
repository: http://example.com/test/
username: testusername
password: testpassword
'''
with open(self.test_pypi_rc_path, 'w+') as f:
f.write(existing_pypi_rc)
self.test_subject.login()
with open(self.test_pypi_rc_path) as f:
test_pypi_rc_str = f.read()
self._assert_pypi_rc_has_expected_content(
pypi_rc_str=test_pypi_rc_str,
server='codeartifact',
repo_url=self.endpoint,
username='aws',
password=self.auth_token,
)
self._assert_pypi_rc_has_expected_content(
pypi_rc_str=test_pypi_rc_str,
server='pypi',
repo_url='http://www.python.org/pypi/',
username='monty',
password='JgCXIr5xGG',
)
self._assert_pypi_rc_has_expected_content(
pypi_rc_str=test_pypi_rc_str,
server='test',
repo_url='http://example.com/test/',
username='testusername',
password='testpassword',
)
def test_login_existing_pypi_rc_with_codeartifact_not_clobbered(self):
existing_pypi_rc = '''\
[distutils]
index-servers=
pypi
codeartifact
[pypi]
repository: http://www.python.org/pypi/
username: monty
password: JgCXIr5xGG
[codeartifact]
repository: https://test-testOwner.codeartifact.aws.a2z.com/pypi/testRepo/
username: aws
password: expired_token
'''
with open(self.test_pypi_rc_path, 'w+') as f:
f.write(existing_pypi_rc)
self.test_subject.login()
with open(self.test_pypi_rc_path) as f:
test_pypi_rc_str = f.read()
self._assert_pypi_rc_has_expected_content(
pypi_rc_str=test_pypi_rc_str,
server='codeartifact',
repo_url=self.endpoint,
username='aws',
password=self.auth_token,
)
self._assert_pypi_rc_has_expected_content(
pypi_rc_str=test_pypi_rc_str,
server='pypi',
repo_url='http://www.python.org/pypi/',
username='monty',
password='JgCXIr5xGG',
)
def test_login_existing_invalid_pypi_rc_error(self):
# This is an invalid pypirc as the list of servers are expected under
# an 'index-servers' option instead of 'servers'.
existing_pypi_rc = '''\
[distutils]
servers=
pypi
[pypi]
repository: http://www.python.org/pypi/
username: monty
password: JgCXIr5xGG
'''
with open(self.test_pypi_rc_path, 'w+') as f:
f.write(existing_pypi_rc)
with open(self.test_pypi_rc_path) as f:
original_content = f.read()
with self.assertRaises(Exception):
self.test_subject.login()
# We should just leave the pypirc untouched when it's invalid.
with open(self.test_pypi_rc_path) as f:
self.assertEqual(f.read(), original_content)
class TestRelativeExpirationTime(unittest.TestCase):
def test_with_years_months_days(self):
remaining = relativedelta(years=1, months=9)
message = get_relative_expiration_time(remaining)
self.assertEqual(message, '1 year and 9 months')
def test_with_years_months(self):
remaining = relativedelta(
years=1, months=8, days=30, hours=23, minutes=59, seconds=30
)
message = get_relative_expiration_time(remaining)
self.assertEqual(message, '1 year and 8 months')
def test_with_years_month(self):
remaining = relativedelta(
years=3, days=30, hours=23, minutes=59, seconds=30
)
message = get_relative_expiration_time(remaining)
self.assertEqual(message, '3 years')
def test_with_years_days(self):
remaining = relativedelta(years=1, days=9)
message = get_relative_expiration_time(remaining)
self.assertEqual(message, '1 year')
def test_with_year(self):
remaining = relativedelta(months=11, days=30)
message = get_relative_expiration_time(remaining)
self.assertEqual(message, '11 months and 30 days')
def test_with_years(self):
remaining = relativedelta(years=1, months=11)
message = get_relative_expiration_time(remaining)
self.assertEqual(message, '1 year and 11 months')
def test_with_years_days_hours_minutes(self):
remaining = relativedelta(years=2, days=7, hours=11, minutes=44)
message = get_relative_expiration_time(remaining)
self.assertEqual(message, '2 years')
def test_with_days_minutes(self):
remaining = relativedelta(days=1, minutes=44)
message = get_relative_expiration_time(remaining)
self.assertEqual(message, '1 day')
def test_with_day(self):
remaining = relativedelta(days=1)
message = get_relative_expiration_time(remaining)
self.assertEqual(message, '1 day')
def test_with_hour(self):
self.expiration = (
datetime.now(tzlocal()) + relativedelta(hours=1)
).replace(microsecond=0)
remaining = relativedelta(
self.expiration, datetime.now(tzutc())
) + relativedelta(seconds=30)
message = get_relative_expiration_time(remaining)
self.assertEqual(message, '1 hour')
def test_with_minutes_seconds(self):
remaining = relativedelta(hours=1)
message = get_relative_expiration_time(remaining)
self.assertEqual(message, '1 hour')
def test_with_full_time(self):
remaining = relativedelta(
years=2, months=3, days=7, hours=11, minutes=44
)
message = get_relative_expiration_time(remaining)
self.assertEqual(message, '2 years and 3 months')
|