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 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784
|
import copy
import datetime
import json
import logging
import re
import time
from typing import Final, Optional
from localstack.aws.api import CommonServiceException, RequestContext
from localstack.services.plugins import ServiceLifecycleHook
from localstack.state import StateVisitor
from localstack.utils.collections import PaginatedList
from moto.stepfunctions.parser.api import (
ActivityDoesNotExist,
AliasDescription,
Arn,
CharacterRestrictedName,
ConflictException,
CreateActivityOutput,
CreateStateMachineAliasOutput,
CreateStateMachineInput,
CreateStateMachineOutput,
Definition,
DeleteActivityOutput,
DeleteStateMachineAliasOutput,
DeleteStateMachineOutput,
DeleteStateMachineVersionOutput,
DescribeActivityOutput,
DescribeExecutionOutput,
DescribeMapRunOutput,
DescribeStateMachineAliasOutput,
DescribeStateMachineForExecutionOutput,
DescribeStateMachineOutput,
EncryptionConfiguration,
ExecutionDoesNotExist,
ExecutionList,
ExecutionRedriveFilter,
ExecutionStatus,
GetActivityTaskOutput,
GetExecutionHistoryOutput,
IncludedData,
IncludeExecutionDataGetExecutionHistory,
InspectionLevel,
InvalidArn,
InvalidDefinition,
InvalidExecutionInput,
InvalidLoggingConfiguration,
InvalidName,
InvalidToken,
ListActivitiesOutput,
ListExecutionsOutput,
ListExecutionsPageToken,
ListMapRunsOutput,
ListStateMachineAliasesOutput,
ListStateMachinesOutput,
ListStateMachineVersionsOutput,
ListTagsForResourceOutput,
LoggingConfiguration,
LogLevel,
LongArn,
MaxConcurrency,
MissingRequiredParameter,
Name,
PageSize,
PageToken,
Publish,
PublishStateMachineVersionOutput,
ResourceNotFound,
RevealSecrets,
ReverseOrder,
RevisionId,
RoutingConfigurationList,
SendTaskFailureOutput,
SendTaskHeartbeatOutput,
SendTaskSuccessOutput,
SensitiveCause,
SensitiveData,
SensitiveError,
StartExecutionOutput,
StartSyncExecutionOutput,
StateMachineAliasList,
StateMachineAlreadyExists,
StateMachineDoesNotExist,
StateMachineList,
StateMachineType,
StateMachineTypeNotSupported,
StepfunctionsApi,
StopExecutionOutput,
TagKeyList,
TagList,
TagResourceOutput,
TaskDoesNotExist,
TaskTimedOut,
TaskToken,
TestStateOutput,
ToleratedFailureCount,
ToleratedFailurePercentage,
TraceHeader,
TracingConfiguration,
UntagResourceOutput,
UpdateMapRunOutput,
UpdateStateMachineAliasOutput,
UpdateStateMachineOutput,
ValidateStateMachineDefinitionDiagnostic,
ValidateStateMachineDefinitionDiagnosticList,
ValidateStateMachineDefinitionInput,
ValidateStateMachineDefinitionOutput,
ValidateStateMachineDefinitionResultCode,
ValidateStateMachineDefinitionSeverity,
ValidationException,
VersionDescription,
)
from moto.stepfunctions.parser.asl.component.state.state_execution.state_map.iteration.itemprocessor.map_run_record import (
MapRunRecord,
)
from moto.stepfunctions.parser.asl.eval.callback.callback import (
ActivityCallbackEndpoint,
CallbackConsumerTimeout,
CallbackNotifyConsumerError,
CallbackOutcomeFailure,
CallbackOutcomeSuccess,
)
from moto.stepfunctions.parser.asl.eval.event.logging import (
CloudWatchLoggingConfiguration,
CloudWatchLoggingSession,
)
from moto.stepfunctions.parser.asl.parse.asl_parser import (
ASLParserException,
)
from moto.stepfunctions.parser.asl.static_analyser.express_static_analyser import (
ExpressStaticAnalyser,
)
from moto.stepfunctions.parser.asl.static_analyser.static_analyser import (
StaticAnalyser,
)
from moto.stepfunctions.parser.asl.static_analyser.test_state.test_state_analyser import (
TestStateStaticAnalyser,
)
from moto.stepfunctions.parser.asl.static_analyser.usage_metrics_static_analyser import (
UsageMetricsStaticAnalyser,
)
from moto.stepfunctions.parser.backend.activity import Activity, ActivityTask
from moto.stepfunctions.parser.backend.alias import Alias
from moto.stepfunctions.parser.backend.execution import Execution, SyncExecution
from moto.stepfunctions.parser.backend.state_machine import (
StateMachineInstance,
StateMachineRevision,
StateMachineVersion,
TestStateMachine,
)
from moto.stepfunctions.parser.backend.store import SFNStore, sfn_stores
from moto.stepfunctions.parser.backend.test_state.execution import (
TestStateExecution,
)
from moto.stepfunctions.parser.mocking.mock_config import (
MockTestCase,
load_mock_test_case_for,
)
from moto.stepfunctions.parser.stepfunctions_utils import (
assert_pagination_parameters_valid,
get_next_page_token_from_arn,
normalise_max_results,
)
from moto.stepfunctions.parser.utils import long_uid, short_uid
from moto.utilities.arns import (
ARN_PARTITION_REGEX,
stepfunctions_activity_arn,
stepfunctions_express_execution_arn,
stepfunctions_standard_execution_arn,
stepfunctions_state_machine_arn,
)
LOG = logging.getLogger(__name__)
class StepFunctionsProvider(StepfunctionsApi, ServiceLifecycleHook):
_TEST_STATE_MAX_TIMEOUT_SECONDS: Final[int] = 300 # 5 minutes.
@staticmethod
def get_store(context: RequestContext) -> SFNStore:
return sfn_stores[context.account_id][context.region]
def accept_state_visitor(self, visitor: StateVisitor):
visitor.visit(sfn_stores)
_STATE_MACHINE_ARN_REGEX: Final[re.Pattern] = re.compile(
rf"{ARN_PARTITION_REGEX}:states:[a-z0-9-]+:[0-9]{{12}}:stateMachine:[a-zA-Z0-9-_.]+(:\d+)?(:[a-zA-Z0-9-_.]+)*(?:#[a-zA-Z0-9-_]+)?$"
)
_STATE_MACHINE_EXECUTION_ARN_REGEX: Final[re.Pattern] = re.compile(
rf"{ARN_PARTITION_REGEX}:states:[a-z0-9-]+:[0-9]{{12}}:(stateMachine|execution|express):[a-zA-Z0-9-_.]+(:\d+)?(:[a-zA-Z0-9-_.]+)*$"
)
_ACTIVITY_ARN_REGEX: Final[re.Pattern] = re.compile(
rf"{ARN_PARTITION_REGEX}:states:[a-z0-9-]+:[0-9]{{12}}:activity:[a-zA-Z0-9-_\.]{{1,80}}$"
)
_ALIAS_ARN_REGEX: Final[re.Pattern] = re.compile(
rf"{ARN_PARTITION_REGEX}:states:[a-z0-9-]+:[0-9]{{12}}:stateMachine:[A-Za-z0-9_.-]+:[A-Za-z_.-]+[A-Za-z0-9_.-]{{0,80}}$"
)
_ALIAS_NAME_REGEX: Final[re.Pattern] = re.compile(
r"^(?=.*[a-zA-Z_\-\.])[a-zA-Z0-9_\-\.]+$"
)
@staticmethod
def _validate_state_machine_arn(state_machine_arn: str) -> None:
# TODO: InvalidArn exception message do not communicate which part of the ARN is incorrect.
if not StepFunctionsProvider._STATE_MACHINE_ARN_REGEX.match(state_machine_arn):
raise InvalidArn(f"Invalid arn: '{state_machine_arn}'")
@staticmethod
def _raise_state_machine_does_not_exist(state_machine_arn: str) -> None:
raise StateMachineDoesNotExist(
f"State Machine Does Not Exist: '{state_machine_arn}'"
)
@staticmethod
def _validate_state_machine_execution_arn(execution_arn: str) -> None:
# TODO: InvalidArn exception message do not communicate which part of the ARN is incorrect.
if not StepFunctionsProvider._STATE_MACHINE_EXECUTION_ARN_REGEX.match(
execution_arn
):
raise InvalidArn(f"Invalid arn: '{execution_arn}'")
@staticmethod
def _validate_activity_arn(activity_arn: str) -> None:
# TODO: InvalidArn exception message do not communicate which part of the ARN is incorrect.
if not StepFunctionsProvider._ACTIVITY_ARN_REGEX.match(activity_arn):
raise InvalidArn(f"Invalid arn: '{activity_arn}'")
@staticmethod
def _validate_state_machine_alias_arn(state_machine_alias_arn: Arn) -> None:
if not StepFunctionsProvider._ALIAS_ARN_REGEX.match(state_machine_alias_arn):
raise InvalidArn(f"Invalid arn: '{state_machine_alias_arn}'")
def _raise_state_machine_type_not_supported(self):
raise StateMachineTypeNotSupported(
"This operation is not supported by this type of state machine"
)
@staticmethod
def _raise_resource_type_not_in_context(resource_type: str) -> None:
lower_resource_type = resource_type.lower()
raise InvalidArn(
f"Invalid Arn: 'Resource type not valid in this context: {lower_resource_type}'"
)
@staticmethod
def _validate_activity_name(name: str) -> None:
# The activity name is validated according to the AWS StepFunctions documentation, the name should not contain:
# - white space
# - brackets < > { } [ ]
# - wildcard characters ? *
# - special characters " # % \ ^ | ~ ` $ & , ; : /
# - control characters (U+0000-001F, U+007F-009F)
# https://docs.aws.amazon.com/step-functions/latest/apireference/API_CreateActivity.html#API_CreateActivity_RequestSyntax
if not (1 <= len(name) <= 80):
raise InvalidName(f"Invalid Name: '{name}'")
invalid_chars = set(' <>{}[]?*"#%\\^|~`$&,;:/')
control_chars = {chr(i) for i in range(32)} | {chr(i) for i in range(127, 160)}
invalid_chars |= control_chars
for char in name:
if char in invalid_chars:
raise InvalidName(f"Invalid Name: '{name}'")
@staticmethod
def _validate_state_machine_alias_name(name: CharacterRestrictedName) -> None:
len_name = len(name)
if len_name > 80:
raise ValidationException(
f"1 validation error detected: Value '{name}' at 'name' failed to satisfy constraint: "
f"Member must have length less than or equal to 80"
)
if not StepFunctionsProvider._ALIAS_NAME_REGEX.match(name):
raise ValidationException(
# TODO: explore more error cases in which more than one validation error may occur which results
# in the counter below being greater than 1.
f"1 validation error detected: Value '{name}' at 'name' failed to satisfy constraint: "
f"Member must satisfy regular expression pattern: ^(?=.*[a-zA-Z_\\-\\.])[a-zA-Z0-9_\\-\\.]+$"
)
def _get_execution(self, context: RequestContext, execution_arn: Arn) -> Execution:
execution: Optional[Execution] = self.get_store(context).executions.get(
execution_arn
)
if not execution:
raise ExecutionDoesNotExist(f"Execution Does Not Exist: '{execution_arn}'")
return execution
def _get_executions(
self,
context: RequestContext,
execution_status: Optional[ExecutionStatus] = None,
):
store = self.get_store(context)
execution: list[Execution] = list(store.executions.values())
if execution_status:
execution = list(
filter(
lambda e: e.exec_status == execution_status,
store.executions.values(),
)
)
return execution
def _get_activity(self, context: RequestContext, activity_arn: Arn) -> Activity:
maybe_activity: Optional[Activity] = self.get_store(context).activities.get(
activity_arn, None
)
if maybe_activity is None:
raise ActivityDoesNotExist(f"Activity Does Not Exist: '{activity_arn}'")
return maybe_activity
def _idempotent_revision(
self,
context: RequestContext,
name: str,
definition: Definition,
state_machine_type: StateMachineType,
logging_configuration: LoggingConfiguration,
tracing_configuration: TracingConfiguration,
) -> Optional[StateMachineRevision]:
# CreateStateMachine's idempotency check is based on the state machine name, definition, type,
# LoggingConfiguration and TracingConfiguration.
# If a following request has a different roleArn or tags, Step Functions will ignore these differences and
# treat it as an idempotent request of the previous. In this case, roleArn and tags will not be updated, even
# if they are different.
state_machines: list[StateMachineInstance] = list(
self.get_store(context).state_machines.values()
)
revisions = filter(
lambda sm: isinstance(sm, StateMachineRevision), state_machines
)
for state_machine in revisions:
check = all(
[
state_machine.name == name,
state_machine.definition == definition,
state_machine.sm_type == state_machine_type,
state_machine.logging_config == logging_configuration,
state_machine.tracing_config == tracing_configuration,
]
)
if check:
return state_machine
return None
def _idempotent_start_execution(
self,
execution: Optional[Execution],
state_machine: StateMachineInstance,
name: Name,
input_data: SensitiveData,
) -> Optional[Execution]:
# StartExecution is idempotent for STANDARD workflows. For a STANDARD workflow,
# if you call StartExecution with the same name and input as a running execution,
# the call succeeds and return the same response as the original request.
# If the execution is closed or if the input is different,
# it returns a 400 ExecutionAlreadyExists error. You can reuse names after 90 days.
if not execution:
return None
if (name, input_data, execution.exec_status, state_machine.sm_type) == (
execution.name,
execution.input_data,
ExecutionStatus.RUNNING,
StateMachineType.STANDARD,
):
return execution
raise CommonServiceException(
code="ExecutionAlreadyExists",
message=f"Execution Already Exists: '{execution.exec_arn}'",
)
def _revision_by_name(
self, context: RequestContext, name: str
) -> Optional[StateMachineInstance]:
state_machines: list[StateMachineInstance] = list(
self.get_store(context).state_machines.values()
)
for state_machine in state_machines:
if (
isinstance(state_machine, StateMachineRevision)
and state_machine.name == name
):
return state_machine
return None
@staticmethod
def _validate_definition(
definition: str, static_analysers: list[StaticAnalyser]
) -> None:
try:
for static_analyser in static_analysers:
static_analyser.analyse(definition)
except ASLParserException as asl_parser_exception:
invalid_definition = InvalidDefinition()
invalid_definition.message = repr(asl_parser_exception)
raise invalid_definition
except Exception as exception:
exception_name = exception.__class__.__name__
exception_args = list(exception.args)
invalid_definition = InvalidDefinition()
invalid_definition.message = f"Error={exception_name} Args={exception_args} in definition '{definition}'."
raise invalid_definition
@staticmethod
def _sanitise_logging_configuration(
logging_configuration: LoggingConfiguration,
) -> None:
level = logging_configuration.get("level")
destinations = logging_configuration.get("destinations")
if destinations is not None and len(destinations) > 1:
raise InvalidLoggingConfiguration(
"Invalid Logging Configuration: Must specify exactly one Log Destination."
)
# A LogLevel that is not OFF, should have a destination.
if level is not None and level != LogLevel.OFF and not destinations:
raise InvalidLoggingConfiguration(
"Invalid Logging Configuration: Must specify exactly one Log Destination."
)
# Default for level is OFF.
level = level or LogLevel.OFF
# Default for includeExecutionData is False.
include_flag = logging_configuration.get("includeExecutionData", False)
# Update configuration object.
logging_configuration["level"] = level
logging_configuration["includeExecutionData"] = include_flag
def create_state_machine(
self, context: RequestContext, request: CreateStateMachineInput, **kwargs
) -> CreateStateMachineOutput:
if not request.get("publish", False) and request.get("versionDescription"):
raise ValidationException(
"Version description can only be set when publish is true"
)
# Extract parameters and set defaults.
state_machine_name = request["name"]
state_machine_role_arn = request["roleArn"]
state_machine_definition = request["definition"]
state_machine_type = request.get("type") or StateMachineType.STANDARD
state_machine_tracing_configuration = request.get("tracingConfiguration")
state_machine_tags = request.get("tags")
state_machine_logging_configuration = request.get(
"loggingConfiguration", LoggingConfiguration()
)
self._sanitise_logging_configuration(
logging_configuration=state_machine_logging_configuration
)
# CreateStateMachine is an idempotent API. Subsequent requests won't create a duplicate resource if it was
# already created.
idem_state_machine: Optional[StateMachineRevision] = self._idempotent_revision(
context=context,
name=state_machine_name,
definition=state_machine_definition,
state_machine_type=state_machine_type,
logging_configuration=state_machine_logging_configuration,
tracing_configuration=state_machine_tracing_configuration,
)
if idem_state_machine is not None:
return CreateStateMachineOutput(
stateMachineArn=idem_state_machine.arn,
creationDate=idem_state_machine.create_date,
)
# Assert this state machine name is unique.
state_machine_with_name: Optional[StateMachineRevision] = (
self._revision_by_name(context=context, name=state_machine_name)
)
if state_machine_with_name is not None:
raise StateMachineAlreadyExists(
f"State Machine Already Exists: '{state_machine_with_name.arn}'"
)
# Compute the state machine's Arn.
state_machine_arn = stepfunctions_state_machine_arn(
name=state_machine_name,
account_id=context.account_id,
region_name=context.region,
)
state_machines = self.get_store(context).state_machines
# Reduce the logging configuration to a usable cloud watch representation, and validate the destinations
# if any were given.
cloud_watch_logging_configuration = (
CloudWatchLoggingConfiguration.from_logging_configuration(
state_machine_arn=state_machine_arn,
logging_configuration=state_machine_logging_configuration,
)
)
if cloud_watch_logging_configuration is not None:
cloud_watch_logging_configuration.validate()
# Run static analysers on the definition given.
if state_machine_type == StateMachineType.EXPRESS:
StepFunctionsProvider._validate_definition(
definition=state_machine_definition,
static_analysers=[ExpressStaticAnalyser()],
)
else:
StepFunctionsProvider._validate_definition(
definition=state_machine_definition, static_analysers=[StaticAnalyser()]
)
# Create the state machine and add it to the store.
state_machine = StateMachineRevision(
name=state_machine_name,
arn=state_machine_arn,
role_arn=state_machine_role_arn,
definition=state_machine_definition,
sm_type=state_machine_type,
logging_config=state_machine_logging_configuration,
cloud_watch_logging_configuration=cloud_watch_logging_configuration,
tracing_config=state_machine_tracing_configuration,
tags=state_machine_tags,
)
state_machines[state_machine_arn] = state_machine
create_output = CreateStateMachineOutput(
stateMachineArn=state_machine.arn, creationDate=state_machine.create_date
)
# Create the first version if the 'publish' flag is used.
if request.get("publish", False):
version_description = request.get("versionDescription")
state_machine_version = state_machine.create_version(
description=version_description
)
if state_machine_version is not None:
state_machine_version_arn = state_machine_version.arn
state_machines[state_machine_version_arn] = state_machine_version
create_output["stateMachineVersionArn"] = state_machine_version_arn
# Run static analyser on definition and collect usage metrics
UsageMetricsStaticAnalyser.process(state_machine_definition)
return create_output
def _validate_state_machine_alias_routing_configuration(
self,
context: RequestContext,
routing_configuration_list: RoutingConfigurationList,
) -> None:
# TODO: to match AWS's approach best validation exceptions could be
# built in a process decoupled from the provider.
routing_configuration_list_len = len(routing_configuration_list)
if not (1 <= routing_configuration_list_len <= 2):
# Replicate the object string dump format:
# [RoutingConfigurationListItem(stateMachineVersionArn=arn_no_quotes, weight=int), ...]
routing_configuration_serialization_parts = []
for routing_configuration in routing_configuration_list:
routing_configuration_serialization_parts.append(
"".join(
[
"RoutingConfigurationListItem(stateMachineVersionArn=",
routing_configuration["stateMachineVersionArn"],
", weight=",
str(routing_configuration["weight"]),
")",
]
)
)
routing_configuration_serialization_list = (
f"[{', '.join(routing_configuration_serialization_parts)}]"
)
raise ValidationException(
f"1 validation error detected: Value '{routing_configuration_serialization_list}' "
"at 'routingConfiguration' failed to "
"satisfy constraint: Member must have length less than or equal to 2"
)
routing_configuration_arn_list = [
routing_configuration["stateMachineVersionArn"]
for routing_configuration in routing_configuration_list
]
if len(set(routing_configuration_arn_list)) < routing_configuration_list_len:
arn_list_string = f"[{', '.join(routing_configuration_arn_list)}]"
raise ValidationException(
"Routing configuration must contain distinct state machine version ARNs. "
f"Received: {arn_list_string}"
)
routing_weights = [
routing_configuration["weight"]
for routing_configuration in routing_configuration_list
]
for i, weight in enumerate(routing_weights):
# TODO: check for weight type.
if weight < 0:
raise ValidationException(
f"Invalid value for parameter routingConfiguration[{i + 1}].weight, value: {weight}, valid min value: 0"
)
if weight > 100:
raise ValidationException(
f"1 validation error detected: Value '{weight}' at 'routingConfiguration.{i + 1}.member.weight' "
"failed to satisfy constraint: Member must have value less than or equal to 100"
)
routing_weights_sum = sum(routing_weights)
if not routing_weights_sum == 100:
raise ValidationException(
f"Sum of routing configuration weights must equal 100. Received: {json.dumps(routing_weights)}"
)
store = self.get_store(context=context)
state_machines = store.state_machines
first_routing_qualified_arn = routing_configuration_arn_list[0]
shared_state_machine_revision_arn = (
self._get_state_machine_arn_from_qualified_arn(
qualified_arn=first_routing_qualified_arn
)
)
for routing_configuration_arn in routing_configuration_arn_list:
maybe_state_machine_version = state_machines.get(routing_configuration_arn)
if not isinstance(maybe_state_machine_version, StateMachineVersion):
arn_list_string = f"[{', '.join(routing_configuration_arn_list)}]"
raise ValidationException(
f"Routing configuration must contain state machine version ARNs. Received: {arn_list_string}"
)
state_machine_revision_arn = self._get_state_machine_arn_from_qualified_arn(
qualified_arn=routing_configuration_arn
)
if state_machine_revision_arn != shared_state_machine_revision_arn:
raise ValidationException("TODO")
@staticmethod
def _get_state_machine_arn_from_qualified_arn(qualified_arn: Arn) -> Arn:
last_colon_index = qualified_arn.rfind(":")
base_arn = qualified_arn[:last_colon_index]
return base_arn
def create_state_machine_alias(
self,
context: RequestContext,
name: CharacterRestrictedName,
routing_configuration: RoutingConfigurationList,
description: AliasDescription = None,
**kwargs,
) -> CreateStateMachineAliasOutput:
# Validate the inputs.
self._validate_state_machine_alias_name(name=name)
self._validate_state_machine_alias_routing_configuration(
context=context, routing_configuration_list=routing_configuration
)
# Determine the state machine arn this alias maps to,
# do so unsafely as validation already took place before initialisation.
first_routing_qualified_arn = routing_configuration[0]["stateMachineVersionArn"]
state_machine_revision_arn = self._get_state_machine_arn_from_qualified_arn(
qualified_arn=first_routing_qualified_arn
)
alias = Alias(
state_machine_arn=state_machine_revision_arn,
name=name,
description=description,
routing_configuration_list=routing_configuration,
)
state_machine_alias_arn = alias.state_machine_alias_arn
store = self.get_store(context=context)
aliases = store.aliases
if maybe_idempotent_alias := aliases.get(state_machine_alias_arn):
if alias.is_idempotent(maybe_idempotent_alias):
return CreateStateMachineAliasOutput(
stateMachineAliasArn=state_machine_alias_arn,
creationDate=alias.create_date,
)
else:
# CreateStateMachineAlias is an idempotent API. Idempotent requests won't create duplicate resources.
raise ConflictException(
"Failed to create alias because an alias with the same name and a "
"different routing configuration already exists."
)
aliases[state_machine_alias_arn] = alias
state_machine_revision = store.state_machines.get(state_machine_revision_arn)
if not isinstance(state_machine_revision, StateMachineRevision):
# The state machine was deleted but not the version referenced in this context.
raise RuntimeError(
f"No state machine revision for arn '{state_machine_revision_arn}'"
)
state_machine_revision.aliases.add(alias)
return CreateStateMachineAliasOutput(
stateMachineAliasArn=state_machine_alias_arn, creationDate=alias.create_date
)
def describe_state_machine(
self,
context: RequestContext,
state_machine_arn: Arn,
included_data: IncludedData = None,
**kwargs,
) -> DescribeStateMachineOutput:
self._validate_state_machine_arn(state_machine_arn)
state_machine = self.get_store(context).state_machines.get(state_machine_arn)
if state_machine is None:
self._raise_state_machine_does_not_exist(state_machine_arn)
return state_machine.describe()
def describe_state_machine_alias(
self, context: RequestContext, state_machine_alias_arn: Arn, **kwargs
) -> DescribeStateMachineAliasOutput:
self._validate_state_machine_alias_arn(
state_machine_alias_arn=state_machine_alias_arn
)
alias: Optional[Alias] = self.get_store(context=context).aliases.get(
state_machine_alias_arn
)
if alias is None:
# TODO: assemble the correct exception
raise ValidationException()
description = alias.to_description()
return description
def describe_state_machine_for_execution(
self,
context: RequestContext,
execution_arn: Arn,
included_data: IncludedData = None,
**kwargs,
) -> DescribeStateMachineForExecutionOutput:
self._validate_state_machine_execution_arn(execution_arn)
execution: Execution = self._get_execution(
context=context, execution_arn=execution_arn
)
return execution.to_describe_state_machine_for_execution_output()
def send_task_heartbeat(
self, context: RequestContext, task_token: TaskToken, **kwargs
) -> SendTaskHeartbeatOutput:
running_executions: list[Execution] = self._get_executions(
context, ExecutionStatus.RUNNING
)
for execution in running_executions:
try:
if execution.exec_worker.env.callback_pool_manager.heartbeat(
callback_id=task_token
):
return SendTaskHeartbeatOutput()
except CallbackNotifyConsumerError as consumer_error:
if isinstance(consumer_error, CallbackConsumerTimeout):
raise TaskTimedOut()
else:
raise TaskDoesNotExist()
raise InvalidToken()
def send_task_success(
self,
context: RequestContext,
task_token: TaskToken,
output: SensitiveData,
**kwargs,
) -> SendTaskSuccessOutput:
outcome = CallbackOutcomeSuccess(callback_id=task_token, output=output)
running_executions: list[Execution] = self._get_executions(
context, ExecutionStatus.RUNNING
)
for execution in running_executions:
try:
if execution.exec_worker.env.callback_pool_manager.notify(
callback_id=task_token, outcome=outcome
):
return SendTaskSuccessOutput()
except CallbackNotifyConsumerError as consumer_error:
if isinstance(consumer_error, CallbackConsumerTimeout):
raise TaskTimedOut()
else:
raise TaskDoesNotExist()
raise InvalidToken("Invalid token")
def send_task_failure(
self,
context: RequestContext,
task_token: TaskToken,
error: SensitiveError = None,
cause: SensitiveCause = None,
**kwargs,
) -> SendTaskFailureOutput:
outcome = CallbackOutcomeFailure(
callback_id=task_token, error=error, cause=cause
)
store = self.get_store(context)
for execution in store.executions.values():
try:
if execution.exec_worker.env.callback_pool_manager.notify(
callback_id=task_token, outcome=outcome
):
return SendTaskFailureOutput()
except CallbackNotifyConsumerError as consumer_error:
if isinstance(consumer_error, CallbackConsumerTimeout):
raise TaskTimedOut()
else:
raise TaskDoesNotExist()
raise InvalidToken("Invalid token")
@staticmethod
def _get_state_machine_arn(state_machine_arn: str) -> str:
"""Extract the state machine ARN by removing the test case suffix."""
return state_machine_arn.split("#")[0]
@staticmethod
def _get_mock_test_case(
state_machine_arn: str, state_machine_name: str
) -> Optional[MockTestCase]:
"""Extract and load a mock test case from a state machine ARN if present."""
parts = state_machine_arn.split("#")
if len(parts) != 2:
return None
mock_test_case_name = parts[1]
mock_test_case = load_mock_test_case_for(
state_machine_name=state_machine_name, test_case_name=mock_test_case_name
)
if mock_test_case is None:
raise InvalidName(
f"Invalid mock test case name '{mock_test_case_name}' "
f"for state machine '{state_machine_name}'."
"Either the test case is not defined or the mock configuration file "
"could not be loaded. See logs for details."
)
return mock_test_case
def start_execution(
self,
context: RequestContext,
state_machine_arn: Arn,
name: Name = None,
input: SensitiveData = None,
trace_header: TraceHeader = None,
**kwargs,
) -> StartExecutionOutput:
self._validate_state_machine_arn(state_machine_arn)
base_arn = self._get_state_machine_arn(state_machine_arn)
store = self.get_store(context=context)
alias: Optional[Alias] = store.aliases.get(base_arn)
alias_sample_state_machine_version_arn = (
alias.sample() if alias is not None else None
)
unsafe_state_machine: Optional[StateMachineInstance] = store.state_machines.get(
alias_sample_state_machine_version_arn or base_arn
)
if not unsafe_state_machine:
self._raise_state_machine_does_not_exist(base_arn)
# Update event change parameters about the state machine and should not affect those about this execution.
state_machine_clone = copy.deepcopy(unsafe_state_machine)
if input is None:
input_data = {}
else:
try:
input_data = json.loads(input)
except Exception as ex:
raise InvalidExecutionInput(
str(ex)
) # TODO: report parsing error like AWS.
normalised_state_machine_arn = (
state_machine_clone.source_arn
if isinstance(state_machine_clone, StateMachineVersion)
else state_machine_clone.arn
)
exec_name = name or long_uid() # TODO: validate name format
if state_machine_clone.sm_type == StateMachineType.STANDARD:
exec_arn = stepfunctions_standard_execution_arn(
normalised_state_machine_arn, exec_name
)
else:
# Exhaustive check on STANDARD and EXPRESS type, validated on creation.
exec_arn = stepfunctions_express_execution_arn(
normalised_state_machine_arn, exec_name
)
if execution := store.executions.get(exec_arn):
# Return already running execution if name and input match
existing_execution = self._idempotent_start_execution(
execution=execution,
state_machine=state_machine_clone,
name=name,
input_data=input_data,
)
if existing_execution:
return existing_execution.to_start_output()
# Create the execution logging session, if logging is configured.
cloud_watch_logging_session = None
if state_machine_clone.cloud_watch_logging_configuration is not None:
cloud_watch_logging_session = CloudWatchLoggingSession(
execution_arn=exec_arn,
configuration=state_machine_clone.cloud_watch_logging_configuration,
)
mock_test_case = self._get_mock_test_case(
state_machine_arn, state_machine_clone.name
)
execution = Execution(
name=exec_name,
sm_type=state_machine_clone.sm_type,
role_arn=state_machine_clone.role_arn,
exec_arn=exec_arn,
account_id=context.account_id,
region_name=context.region,
state_machine=state_machine_clone,
state_machine_alias_arn=alias.state_machine_alias_arn
if alias is not None
else None,
start_date=datetime.datetime.now(tz=datetime.timezone.utc),
cloud_watch_logging_session=cloud_watch_logging_session,
input_data=input_data,
trace_header=trace_header,
activity_store=self.get_store(context).activities,
mock_test_case=mock_test_case,
)
store.executions[exec_arn] = execution
execution.start()
return execution.to_start_output()
def start_sync_execution(
self,
context: RequestContext,
state_machine_arn: Arn,
name: Name = None,
input: SensitiveData = None,
trace_header: TraceHeader = None,
included_data: IncludedData = None,
**kwargs,
) -> StartSyncExecutionOutput:
self._validate_state_machine_arn(state_machine_arn)
base_arn = self._get_state_machine_arn(state_machine_arn)
unsafe_state_machine: Optional[StateMachineInstance] = self.get_store(
context
).state_machines.get(base_arn)
if not unsafe_state_machine:
self._raise_state_machine_does_not_exist(base_arn)
if unsafe_state_machine.sm_type == StateMachineType.STANDARD:
self._raise_state_machine_type_not_supported()
# Update event change parameters about the state machine and should not affect those about this execution.
state_machine_clone = copy.deepcopy(unsafe_state_machine)
if input is None:
input_data = {}
else:
try:
input_data = json.loads(input)
except Exception as ex:
raise InvalidExecutionInput(
str(ex)
) # TODO: report parsing error like AWS.
normalised_state_machine_arn = (
state_machine_clone.source_arn
if isinstance(state_machine_clone, StateMachineVersion)
else state_machine_clone.arn
)
exec_name = name or long_uid() # TODO: validate name format
exec_arn = stepfunctions_express_execution_arn(
normalised_state_machine_arn, exec_name
)
if exec_arn in self.get_store(context).executions:
raise InvalidName() # TODO
# Create the execution logging session, if logging is configured.
cloud_watch_logging_session = None
if state_machine_clone.cloud_watch_logging_configuration is not None:
cloud_watch_logging_session = CloudWatchLoggingSession(
execution_arn=exec_arn,
configuration=state_machine_clone.cloud_watch_logging_configuration,
)
mock_test_case = self._get_mock_test_case(
state_machine_arn, state_machine_clone.name
)
execution = SyncExecution(
name=exec_name,
sm_type=state_machine_clone.sm_type,
role_arn=state_machine_clone.role_arn,
exec_arn=exec_arn,
account_id=context.account_id,
region_name=context.region,
state_machine=state_machine_clone,
start_date=datetime.datetime.now(tz=datetime.timezone.utc),
cloud_watch_logging_session=cloud_watch_logging_session,
input_data=input_data,
trace_header=trace_header,
activity_store=self.get_store(context).activities,
mock_test_case=mock_test_case,
)
self.get_store(context).executions[exec_arn] = execution
execution.start()
return execution.to_start_sync_execution_output()
def describe_execution(
self,
context: RequestContext,
execution_arn: Arn,
included_data: IncludedData = None,
**kwargs,
) -> DescribeExecutionOutput:
self._validate_state_machine_execution_arn(execution_arn)
execution: Execution = self._get_execution(
context=context, execution_arn=execution_arn
)
# Action only compatible with STANDARD workflows.
if execution.sm_type != StateMachineType.STANDARD:
self._raise_resource_type_not_in_context(resource_type=execution.sm_type)
return execution.to_describe_output()
@staticmethod
def _list_execution_filter(
ex: Execution, state_machine_arn: str, status_filter: Optional[str]
) -> bool:
state_machine_reference_arn_set = {
ex.state_machine_arn,
ex.state_machine_version_arn,
}
if state_machine_arn not in state_machine_reference_arn_set:
return False
if not status_filter:
return True
return ex.exec_status == status_filter
def list_executions(
self,
context: RequestContext,
state_machine_arn: Arn = None,
status_filter: ExecutionStatus = None,
max_results: PageSize = None,
next_token: ListExecutionsPageToken = None,
map_run_arn: LongArn = None,
redrive_filter: ExecutionRedriveFilter = None,
**kwargs,
) -> ListExecutionsOutput:
self._validate_state_machine_arn(state_machine_arn)
assert_pagination_parameters_valid(
max_results=max_results,
next_token=next_token,
next_token_length_limit=3096,
)
max_results = normalise_max_results(max_results)
state_machine = self.get_store(context).state_machines.get(state_machine_arn)
if state_machine is None:
self._raise_state_machine_does_not_exist(state_machine_arn)
if state_machine.sm_type != StateMachineType.STANDARD:
self._raise_state_machine_type_not_supported()
# TODO: add support for paging
allowed_execution_status = [
ExecutionStatus.SUCCEEDED,
ExecutionStatus.TIMED_OUT,
ExecutionStatus.PENDING_REDRIVE,
ExecutionStatus.ABORTED,
ExecutionStatus.FAILED,
ExecutionStatus.RUNNING,
]
validation_errors = []
if status_filter and status_filter not in allowed_execution_status:
validation_errors.append(
f"Value '{status_filter}' at 'statusFilter' failed to satisfy constraint: Member must satisfy enum value set: [{', '.join(allowed_execution_status)}]"
)
if not state_machine_arn and not map_run_arn:
validation_errors.append("Must provide a StateMachine ARN or MapRun ARN")
if validation_errors:
errors_message = "; ".join(validation_errors)
message = f"{len(validation_errors)} validation {'errors' if len(validation_errors) > 1 else 'error'} detected: {errors_message}"
raise CommonServiceException(message=message, code="ValidationException")
executions: ExecutionList = [
execution.to_execution_list_item()
for execution in self.get_store(context).executions.values()
if self._list_execution_filter(
execution,
state_machine_arn=state_machine_arn,
status_filter=status_filter,
)
]
executions.sort(key=lambda item: item["startDate"], reverse=True)
paginated_executions = PaginatedList(executions)
page, token_for_next_page = paginated_executions.get_page(
token_generator=lambda item: get_next_page_token_from_arn(
item.get("executionArn")
),
page_size=max_results,
next_token=next_token,
)
return ListExecutionsOutput(executions=page, nextToken=token_for_next_page)
def list_state_machines(
self,
context: RequestContext,
max_results: PageSize = None,
next_token: PageToken = None,
**kwargs,
) -> ListStateMachinesOutput:
assert_pagination_parameters_valid(max_results, next_token)
max_results = normalise_max_results(max_results)
state_machines: StateMachineList = [
sm.itemise()
for sm in self.get_store(context).state_machines.values()
if isinstance(sm, StateMachineRevision)
]
state_machines.sort(key=lambda item: item["name"])
paginated_state_machines = PaginatedList(state_machines)
page, token_for_next_page = paginated_state_machines.get_page(
token_generator=lambda item: get_next_page_token_from_arn(
item.get("stateMachineArn")
),
page_size=max_results,
next_token=next_token,
)
return ListStateMachinesOutput(
stateMachines=page, nextToken=token_for_next_page
)
def list_state_machine_aliases(
self,
context: RequestContext,
state_machine_arn: Arn,
next_token: PageToken = None,
max_results: PageSize = None,
**kwargs,
) -> ListStateMachineAliasesOutput:
assert_pagination_parameters_valid(max_results, next_token)
self._validate_state_machine_arn(state_machine_arn)
state_machines = self.get_store(context).state_machines
state_machine_revision = state_machines.get(state_machine_arn)
if not isinstance(state_machine_revision, StateMachineRevision):
raise InvalidArn(f"Invalid arn: {state_machine_arn}")
state_machine_aliases: StateMachineAliasList = []
valid_token_found = next_token is None
for alias in state_machine_revision.aliases:
state_machine_aliases.append(alias.to_item())
if alias.tokenized_state_machine_alias_arn == next_token:
valid_token_found = True
if not valid_token_found:
raise InvalidToken("Invalid Token: 'Invalid token'")
state_machine_aliases.sort(key=lambda item: item["creationDate"])
paginated_list = PaginatedList(state_machine_aliases)
paginated_aliases, next_token = paginated_list.get_page(
token_generator=lambda item: get_next_page_token_from_arn(
item.get("stateMachineAliasArn")
),
next_token=next_token,
page_size=100 if max_results == 0 or max_results is None else max_results,
)
return ListStateMachineAliasesOutput(
stateMachineAliases=paginated_aliases, nextToken=next_token
)
def list_state_machine_versions(
self,
context: RequestContext,
state_machine_arn: Arn,
next_token: PageToken = None,
max_results: PageSize = None,
**kwargs,
) -> ListStateMachineVersionsOutput:
self._validate_state_machine_arn(state_machine_arn)
assert_pagination_parameters_valid(max_results, next_token)
max_results = normalise_max_results(max_results)
state_machines = self.get_store(context).state_machines
state_machine_revision = state_machines.get(state_machine_arn)
if not isinstance(state_machine_revision, StateMachineRevision):
raise InvalidArn(f"Invalid arn: {state_machine_arn}")
state_machine_version_items = []
for version_arn in state_machine_revision.versions.values():
state_machine_version = state_machines[version_arn]
if isinstance(state_machine_version, StateMachineVersion):
state_machine_version_items.append(state_machine_version.itemise())
else:
raise RuntimeError(
f"Expected {version_arn} to be a StateMachine Version, but got '{type(state_machine_version)}'."
)
state_machine_version_items.sort(
key=lambda item: item["creationDate"], reverse=True
)
paginated_state_machine_versions = PaginatedList(state_machine_version_items)
page, token_for_next_page = paginated_state_machine_versions.get_page(
token_generator=lambda item: get_next_page_token_from_arn(
item.get("stateMachineVersionArn")
),
page_size=max_results,
next_token=next_token,
)
return ListStateMachineVersionsOutput(
stateMachineVersions=page, nextToken=token_for_next_page
)
def get_execution_history(
self,
context: RequestContext,
execution_arn: Arn,
max_results: PageSize = None,
reverse_order: ReverseOrder = None,
next_token: PageToken = None,
include_execution_data: IncludeExecutionDataGetExecutionHistory = None,
**kwargs,
) -> GetExecutionHistoryOutput:
# TODO: add support for paging, ordering, and other manipulations.
self._validate_state_machine_execution_arn(execution_arn)
execution: Execution = self._get_execution(
context=context, execution_arn=execution_arn
)
# Action only compatible with STANDARD workflows.
if execution.sm_type != StateMachineType.STANDARD:
self._raise_resource_type_not_in_context(resource_type=execution.sm_type)
history: GetExecutionHistoryOutput = execution.to_history_output()
if reverse_order:
history["events"].reverse()
return history
def delete_state_machine(
self, context: RequestContext, state_machine_arn: Arn, **kwargs
) -> DeleteStateMachineOutput:
# TODO: halt executions?
self._validate_state_machine_arn(state_machine_arn)
state_machines = self.get_store(context).state_machines
state_machine = state_machines.get(state_machine_arn)
if isinstance(state_machine, StateMachineRevision):
state_machines.pop(state_machine_arn)
for version_arn in state_machine.versions.values():
state_machines.pop(version_arn, None)
return DeleteStateMachineOutput()
def delete_state_machine_alias(
self, context: RequestContext, state_machine_alias_arn: Arn, **kwargs
) -> DeleteStateMachineAliasOutput:
self._validate_state_machine_alias_arn(
state_machine_alias_arn=state_machine_alias_arn
)
store = self.get_store(context=context)
aliases = store.aliases
if (alias := aliases.pop(state_machine_alias_arn, None)) is not None:
state_machines = store.state_machines
for routing_configuration in alias.get_routing_configuration_list():
state_machine_version_arn = routing_configuration[
"stateMachineVersionArn"
]
if (
state_machine_version := state_machines.get(
state_machine_version_arn
)
) is None or not isinstance(state_machine_version, StateMachineVersion):
continue
if (
state_machine_revision := state_machines.get(
state_machine_version.source_arn
)
) is None or not isinstance(
state_machine_revision, StateMachineRevision
):
continue
state_machine_revision.aliases.discard(alias)
return DeleteStateMachineOutput()
def delete_state_machine_version(
self, context: RequestContext, state_machine_version_arn: LongArn, **kwargs
) -> DeleteStateMachineVersionOutput:
self._validate_state_machine_arn(state_machine_version_arn)
state_machines = self.get_store(context).state_machines
if not (
state_machine_version := state_machines.get(state_machine_version_arn)
) or not isinstance(state_machine_version, StateMachineVersion):
return DeleteStateMachineVersionOutput()
if (
state_machine_revision := state_machines.get(
state_machine_version.source_arn
)
) and isinstance(state_machine_revision, StateMachineRevision):
referencing_alias_names: list[str] = []
for alias in state_machine_revision.aliases:
if alias.is_router_for(
state_machine_version_arn=state_machine_version_arn
):
referencing_alias_names.append(alias.name)
if referencing_alias_names:
referencing_alias_names_list_body = ", ".join(referencing_alias_names)
raise ConflictException(
"Version to be deleted must not be referenced by an alias. "
f"Current list of aliases referencing this version: [{referencing_alias_names_list_body}]"
)
state_machine_revision.delete_version(state_machine_version_arn)
state_machines.pop(state_machine_version.arn, None)
return DeleteStateMachineVersionOutput()
def stop_execution(
self,
context: RequestContext,
execution_arn: Arn,
error: SensitiveError = None,
cause: SensitiveCause = None,
**kwargs,
) -> StopExecutionOutput:
self._validate_state_machine_execution_arn(execution_arn)
execution: Execution = self._get_execution(
context=context, execution_arn=execution_arn
)
# Action only compatible with STANDARD workflows.
if execution.sm_type != StateMachineType.STANDARD:
self._raise_resource_type_not_in_context(resource_type=execution.sm_type)
stop_date = datetime.datetime.now(tz=datetime.timezone.utc)
execution.stop(stop_date=stop_date, cause=cause, error=error)
return StopExecutionOutput(stopDate=stop_date)
def update_state_machine(
self,
context: RequestContext,
state_machine_arn: Arn,
definition: Definition = None,
role_arn: Arn = None,
logging_configuration: LoggingConfiguration = None,
tracing_configuration: TracingConfiguration = None,
publish: Publish = None,
version_description: VersionDescription = None,
encryption_configuration: EncryptionConfiguration = None,
**kwargs,
) -> UpdateStateMachineOutput:
self._validate_state_machine_arn(state_machine_arn)
state_machines = self.get_store(context).state_machines
state_machine = state_machines.get(state_machine_arn)
if not isinstance(state_machine, StateMachineRevision):
self._raise_state_machine_does_not_exist(state_machine_arn)
# TODO: Add logic to handle metrics for when SFN definitions update
if not any([definition, role_arn, logging_configuration]):
raise MissingRequiredParameter(
"Either the definition, the role ARN, the LoggingConfiguration, "
"or the TracingConfiguration must be specified"
)
if definition is not None:
self._validate_definition(
definition=definition, static_analysers=[StaticAnalyser()]
)
if logging_configuration is not None:
self._sanitise_logging_configuration(
logging_configuration=logging_configuration
)
revision_id = state_machine.create_revision(
definition=definition,
role_arn=role_arn,
logging_configuration=logging_configuration,
)
version_arn = None
if publish:
version = state_machine.create_version(description=version_description)
if version is not None:
version_arn = version.arn
state_machines[version_arn] = version
else:
target_revision_id = revision_id or state_machine.revision_id
version_arn = state_machine.versions[target_revision_id]
update_output = UpdateStateMachineOutput(
updateDate=datetime.datetime.now(tz=datetime.timezone.utc)
)
if revision_id is not None:
update_output["revisionId"] = revision_id
if version_arn is not None:
update_output["stateMachineVersionArn"] = version_arn
return update_output
def update_state_machine_alias(
self,
context: RequestContext,
state_machine_alias_arn: Arn,
description: AliasDescription = None,
routing_configuration: RoutingConfigurationList = None,
**kwargs,
) -> UpdateStateMachineAliasOutput:
self._validate_state_machine_alias_arn(
state_machine_alias_arn=state_machine_alias_arn
)
if not any([description, routing_configuration]):
raise MissingRequiredParameter(
"Either the description or the RoutingConfiguration must be specified"
)
if routing_configuration is not None:
self._validate_state_machine_alias_routing_configuration(
context=context, routing_configuration_list=routing_configuration
)
store = self.get_store(context=context)
alias = store.aliases.get(state_machine_alias_arn)
if alias is None:
raise ResourceNotFound("Request references a resource that does not exist.")
alias.update(
description=description, routing_configuration_list=routing_configuration
)
return UpdateStateMachineAliasOutput(updateDate=alias.update_date)
def publish_state_machine_version(
self,
context: RequestContext,
state_machine_arn: Arn,
revision_id: RevisionId = None,
description: VersionDescription = None,
**kwargs,
) -> PublishStateMachineVersionOutput:
self._validate_state_machine_arn(state_machine_arn)
state_machines = self.get_store(context).state_machines
state_machine_revision = state_machines.get(state_machine_arn)
if not isinstance(state_machine_revision, StateMachineRevision):
self._raise_state_machine_does_not_exist(state_machine_arn)
if (
revision_id is not None
and state_machine_revision.revision_id != revision_id
):
raise ConflictException(
f"Failed to publish the State Machine version for revision {revision_id}. "
f"The current State Machine revision is {state_machine_revision.revision_id}."
)
state_machine_version = state_machine_revision.create_version(
description=description
)
if state_machine_version is not None:
state_machines[state_machine_version.arn] = state_machine_version
else:
target_revision_id = revision_id or state_machine_revision.revision_id
state_machine_version_arn = state_machine_revision.versions.get(
target_revision_id
)
state_machine_version = state_machines[state_machine_version_arn]
return PublishStateMachineVersionOutput(
creationDate=state_machine_version.create_date,
stateMachineVersionArn=state_machine_version.arn,
)
def tag_resource(
self, context: RequestContext, resource_arn: Arn, tags: TagList, **kwargs
) -> TagResourceOutput:
# TODO: add tagging for activities.
state_machines = self.get_store(context).state_machines
state_machine = state_machines.get(resource_arn)
if not isinstance(state_machine, StateMachineRevision):
raise ResourceNotFound(f"Resource not found: '{resource_arn}'")
state_machine.tag_manager.add_all(tags)
return TagResourceOutput()
def untag_resource(
self, context: RequestContext, resource_arn: Arn, tag_keys: TagKeyList, **kwargs
) -> UntagResourceOutput:
# TODO: add untagging for activities.
state_machines = self.get_store(context).state_machines
state_machine = state_machines.get(resource_arn)
if not isinstance(state_machine, StateMachineRevision):
raise ResourceNotFound(f"Resource not found: '{resource_arn}'")
state_machine.tag_manager.remove_all(tag_keys)
return UntagResourceOutput()
def list_tags_for_resource(
self, context: RequestContext, resource_arn: Arn, **kwargs
) -> ListTagsForResourceOutput:
# TODO: add untagging for activities.
state_machines = self.get_store(context).state_machines
state_machine = state_machines.get(resource_arn)
if not isinstance(state_machine, StateMachineRevision):
raise ResourceNotFound(f"Resource not found: '{resource_arn}'")
tags: TagList = state_machine.tag_manager.to_tag_list()
return ListTagsForResourceOutput(tags=tags)
def describe_map_run(
self, context: RequestContext, map_run_arn: LongArn, **kwargs
) -> DescribeMapRunOutput:
store = self.get_store(context)
for execution in store.executions.values():
map_run_record: Optional[MapRunRecord] = (
execution.exec_worker.env.map_run_record_pool_manager.get(map_run_arn)
)
if map_run_record is not None:
return map_run_record.describe()
raise ResourceNotFound()
def list_map_runs(
self,
context: RequestContext,
execution_arn: Arn,
max_results: PageSize = None,
next_token: PageToken = None,
**kwargs,
) -> ListMapRunsOutput:
# TODO: add support for paging.
execution = self._get_execution(context=context, execution_arn=execution_arn)
map_run_records: list[MapRunRecord] = (
execution.exec_worker.env.map_run_record_pool_manager.get_all()
)
return ListMapRunsOutput(
mapRuns=[map_run_record.list_item() for map_run_record in map_run_records]
)
def update_map_run(
self,
context: RequestContext,
map_run_arn: LongArn,
max_concurrency: MaxConcurrency = None,
tolerated_failure_percentage: ToleratedFailurePercentage = None,
tolerated_failure_count: ToleratedFailureCount = None,
**kwargs,
) -> UpdateMapRunOutput:
if (
tolerated_failure_percentage is not None
or tolerated_failure_count is not None
):
raise NotImplementedError(
"Updating of ToleratedFailureCount and ToleratedFailurePercentage is currently unsupported."
)
# TODO: investigate behaviour of empty requests.
store = self.get_store(context)
for execution in store.executions.values():
map_run_record: Optional[MapRunRecord] = (
execution.exec_worker.env.map_run_record_pool_manager.get(map_run_arn)
)
if map_run_record is not None:
map_run_record.update(
max_concurrency=max_concurrency,
tolerated_failure_count=tolerated_failure_count,
tolerated_failure_percentage=tolerated_failure_percentage,
)
LOG.warning(
"StepFunctions UpdateMapRun changes are currently not being reflected in the MapRun instances."
)
return UpdateMapRunOutput()
raise ResourceNotFound()
def test_state(
self,
context: RequestContext,
definition: Definition,
role_arn: Arn = None,
input: SensitiveData = None,
inspection_level: InspectionLevel = None,
reveal_secrets: RevealSecrets = None,
variables: SensitiveData = None,
**kwargs,
) -> TestStateOutput:
StepFunctionsProvider._validate_definition(
definition=definition, static_analysers=[TestStateStaticAnalyser()]
)
name: Optional[Name] = f"TestState-{short_uid()}"
arn = stepfunctions_state_machine_arn(
name=name, account_id=context.account_id, region_name=context.region
)
state_machine = TestStateMachine(
name=name,
arn=arn,
role_arn=role_arn,
definition=definition,
)
exec_arn = stepfunctions_standard_execution_arn(state_machine.arn, name)
input_json = json.loads(input)
execution = TestStateExecution(
name=name,
role_arn=role_arn,
exec_arn=exec_arn,
account_id=context.account_id,
region_name=context.region,
state_machine=state_machine,
start_date=datetime.datetime.now(tz=datetime.timezone.utc),
input_data=input_json,
activity_store=self.get_store(context).activities,
)
execution.start()
test_state_output = execution.to_test_state_output(
inspection_level=inspection_level or InspectionLevel.INFO
)
return test_state_output
def create_activity(
self,
context: RequestContext,
name: Name,
tags: TagList = None,
encryption_configuration: EncryptionConfiguration = None,
**kwargs,
) -> CreateActivityOutput:
self._validate_activity_name(name=name)
activity_arn = stepfunctions_activity_arn(
name=name, account_id=context.account_id, region_name=context.region
)
activities = self.get_store(context).activities
if activity_arn not in activities:
activity = Activity(arn=activity_arn, name=name)
activities[activity_arn] = activity
else:
activity = activities[activity_arn]
return CreateActivityOutput(
activityArn=activity.arn, creationDate=activity.creation_date
)
def delete_activity(
self, context: RequestContext, activity_arn: Arn, **kwargs
) -> DeleteActivityOutput:
self._validate_activity_arn(activity_arn)
self.get_store(context).activities.pop(activity_arn, None)
return DeleteActivityOutput()
def describe_activity(
self, context: RequestContext, activity_arn: Arn, **kwargs
) -> DescribeActivityOutput:
self._validate_activity_arn(activity_arn)
activity = self._get_activity(context=context, activity_arn=activity_arn)
return activity.to_describe_activity_output()
def list_activities(
self,
context: RequestContext,
max_results: PageSize = None,
next_token: PageToken = None,
**kwargs,
) -> ListActivitiesOutput:
activities: list[Activity] = list(self.get_store(context).activities.values())
return ListActivitiesOutput(
activities=[activity.to_activity_list_item() for activity in activities]
)
def _send_activity_task_started(
self,
context: RequestContext,
task_token: TaskToken,
worker_name: Optional[Name],
) -> None:
executions: list[Execution] = self._get_executions(context)
for execution in executions:
callback_endpoint = execution.exec_worker.env.callback_pool_manager.get(
callback_id=task_token
)
if isinstance(callback_endpoint, ActivityCallbackEndpoint):
callback_endpoint.notify_activity_task_start(worker_name=worker_name)
return
raise InvalidToken()
@staticmethod
def _pull_activity_task(activity: Activity) -> Optional[ActivityTask]:
seconds_left = 60
while seconds_left > 0:
try:
return activity.get_task()
except IndexError:
time.sleep(1)
seconds_left -= 1
return None
def get_activity_task(
self,
context: RequestContext,
activity_arn: Arn,
worker_name: Name = None,
**kwargs,
) -> GetActivityTaskOutput:
self._validate_activity_arn(activity_arn)
activity = self._get_activity(context=context, activity_arn=activity_arn)
maybe_task: Optional[ActivityTask] = self._pull_activity_task(activity=activity)
if maybe_task is not None:
self._send_activity_task_started(
context, maybe_task.task_token, worker_name=worker_name
)
return GetActivityTaskOutput(
taskToken=maybe_task.task_token, input=maybe_task.task_input
)
return GetActivityTaskOutput(taskToken=None, input=None)
def validate_state_machine_definition(
self,
context: RequestContext,
request: ValidateStateMachineDefinitionInput,
**kwargs,
) -> ValidateStateMachineDefinitionOutput:
# TODO: increase parity of static analysers, current implementation is an unblocker for this API action.
# TODO: add support for ValidateStateMachineDefinitionSeverity
# TODO: add support for ValidateStateMachineDefinitionMaxResult
state_machine_type: StateMachineType = request.get(
"type", StateMachineType.STANDARD
)
definition: str = request["definition"]
static_analysers = []
if state_machine_type == StateMachineType.STANDARD:
static_analysers.append(StaticAnalyser())
else:
static_analysers.append(ExpressStaticAnalyser())
diagnostics: ValidateStateMachineDefinitionDiagnosticList = []
try:
StepFunctionsProvider._validate_definition(
definition=definition, static_analysers=static_analysers
)
validation_result = ValidateStateMachineDefinitionResultCode.OK
except InvalidDefinition as invalid_definition:
validation_result = ValidateStateMachineDefinitionResultCode.FAIL
diagnostics.append(
ValidateStateMachineDefinitionDiagnostic(
severity=ValidateStateMachineDefinitionSeverity.ERROR,
code="SCHEMA_VALIDATION_FAILED",
message=invalid_definition.message,
)
)
except Exception as ex:
validation_result = ValidateStateMachineDefinitionResultCode.FAIL
LOG.error("Unknown error during validation %s", ex)
return ValidateStateMachineDefinitionOutput(
result=validation_result, diagnostics=diagnostics, truncated=False
)
|