使用模擬服務整合在 Step Functions Local 中進行測試

建立名為 的檔案MockConfigFile.json，以設定具有模擬服務整合的測試。

下列範例顯示參考狀態機器的模擬組態檔案，其中有兩個已定義狀態名為 LambdaState和 SQSState。

您可以使用下列其中一個測試案例，執行模擬組態檔案中參考LambdaSQSIntegration的狀態機器定義：

如需如何使用模擬服務整合開始測試執行的詳細資訊，請參閱步驟 3：執行模擬服務整合測試。

確定模擬回應的結構符合您在進行整合服務呼叫時收到的實際服務回應結構。如需模擬回應的結構需求資訊，請參閱 設定模擬服務整合。

在先前的範例模擬組態檔案中，在 中定義的模擬回應MockedLambdaRetry，MockedLambdaSuccess符合從呼叫 傳回的實際回應結構HelloFromLambda。

根據模擬組態檔案中先前提及的定義建立狀態機器。

aws stepfunctions create-state-machine \
    --endpoint http://localhost:8083 \
    --definition "{\"Comment\":\"Thisstatemachineiscalled:LambdaSQSIntegration\",\"StartAt\":\"LambdaState\",\"States\":{\"LambdaState\":{\"Type\":\"Task\",\"Resource\":\"arn:aws:states:::lambda:invoke\",\"Parameters\":{\"Payload.$\":\"$\",\"FunctionName\":\"arn:aws:lambda:us-east-1:123456789012:function:HelloWorldFunction\"},\"Retry\":[{\"ErrorEquals\":[\"States.ALL\"],\"IntervalSeconds\":2,\"MaxAttempts\":3,\"BackoffRate\":2}],\"Next\":\"SQSState\"},\"SQSState\":{\"Type\":\"Task\",\"Resource\":\"arn:aws:states:::sqs:sendMessage\",\"Parameters\":{\"QueueUrl\":\"https://sqs.us-east-1.amazonaws.com/123456789012/myQueue\",\"MessageBody.$\":\"$\"},\"End\":true}}}" \
    --name "LambdaSQSIntegration" --role-arn "arn:aws:iam::123456789012:role/service-role/LambdaSQSIntegration"

使用模擬服務整合執行狀態機器。

若要使用模擬組態檔案，請在模擬組態檔案中設定的狀態機器上StartExecutionAPI撥打電話。若要這樣做，請將尾碼 附加#test_name至 ARN所使用的狀態機器StartExecution。 test_name 是測試案例，會針對相同模擬組態檔案中的狀態機器進行設定。

下列命令是使用 LambdaSQSIntegration 狀態機器和模擬組態的範例。在此範例中，LambdaSQSIntegration狀態機器會使用 中定義的HappyPath測試來執行步驟 1：在模擬組態檔案中指定模擬服務整合。HappyPath 測試包含執行的組態，以處理使用 LambdaState和模擬服務回應所SQSState發出的MockedLambdaSuccessMockedSQSSuccess模擬服務整合呼叫。

aws stepfunctions start-execution \
    --endpoint http://localhost:8083 \
    --name executionWithHappyPathMockedServices \
    --state-machine arn:aws:states:us-east-1:123456789012:stateMachine:LambdaSQSIntegration#HappyPath

檢視狀態機器執行回應。

StartExecution 使用模擬服務整合測試呼叫的回應與StartExecution正常呼叫的回應相同，這會傳回執行ARN和開始日期。

以下是StartExecution使用模擬服務整合測試呼叫 的範例回應：

{
   "startDate":"2022-01-28T15:03:16.981000-05:00",
   "executionArn":"arn:aws:states:us-east-1:123456789012:execution:LambdaSQSIntegration:executionWithHappyPathMockedServices"
}

透過發出 ListExecutions、 DescribeExecution或 GetExecutionHistoryAPI呼叫來檢查執行的結果。

aws stepfunctions get-execution-history \
    --endpoint http://localhost:8083 \
    --execution-arn arn:aws:states:us-east-1:123456789012:execution:LambdaSQSIntegration:executionWithHappyPathMockedServices

下列範例示範GetExecutionHistory使用步驟 2 中所示ARN範例回應中的執行呼叫 的回應部分。在此範例中， LambdaState和 的輸出SQSState是模擬組態檔案中定義的MockedLambdaSuccessMockedSQSSuccess模擬資料。 步驟 1：在模擬組態檔案中指定模擬服務整合此外，模擬資料的使用方式與執行實際服務整合呼叫時傳回的資料使用方式相同。此外，在此範例中，來自 的輸出LambdaState會SQSState做為輸入傳遞至 。

{
    "events": [
        ...
        {
            "timestamp": "2021-12-02T19:39:48.988000+00:00",
            "type": "TaskStateEntered",
            "id": 2,
            "previousEventId": 0,
            "stateEnteredEventDetails": {
                "name": "LambdaState",
                "input": "{}",
                "inputDetails": {
                    "truncated": false
                }
            }
        },
        ...
        {
            "timestamp": "2021-11-25T23:39:10.587000+00:00",
            "type": "LambdaFunctionSucceeded",
            "id": 5,
            "previousEventId": 4,
            "lambdaFunctionSucceededEventDetails": {
                "output": "{\"statusCode\":200,\"body\":\"\\\"Hello from Lambda!\\\"\"}",
                "outputDetails": {
                    "truncated": false
                }
            }
        },
        ...
            "timestamp": "2021-12-02T19:39:49.464000+00:00",
            "type": "TaskStateEntered",
            "id": 7,
            "previousEventId": 6,
            "stateEnteredEventDetails": {
                "name": "SQSState",
                "input": "{\"statusCode\":200,\"body\":\"\\\"Hello from Lambda!\\\"\"}",
                "inputDetails": {
                    "truncated": false
                }
            }
        },
        ...
        {
            "timestamp": "2021-11-25T23:39:10.652000+00:00",
            "type": "TaskSucceeded",
            "id": 10,
            "previousEventId": 9,
            "taskSucceededEventDetails": {
                "resourceType": "sqs",
                "resource": "sendMessage",
                "output": "{\"MD5OfMessageBody\":\"3bcb6e8e-7h85-4375-b0bc-1a59812c6e51\",\"MessageId\":\"3bcb6e8e-8b51-4375-b0bc-1a59812c6e51\"}",
                "outputDetails": {
                    "truncated": false
                }
            }
        },
        ...
    ]
}