Step Functions Local でのテストにモックサービス統合を使用する

モックサービス統合を含むテストを設定するための MockConfigFile.json という名前のファイルを作成します。

次の例は、LambdaState と SQSState という名前の 2 つのステートが定義されているステートマシンを参照するモック設定ファイルを示しています。

以下のテストケースのいずれかを使用して、モック設定ファイルで参照されている LambdaSQSIntegration ステートマシン定義を実行できます。

モックサービス統合を使用してテスト実行を開始する方法については、「ステップ 3: モックサービス統合テストを実行する」を参照してください。

モックレスポンスの構造が、統合サービス呼び出しを行うときに受け取る実際のサービスレスポンスの構造と一致していることを確認してください。モックレスポンスの構造要件については、「モックサービス統合の設定」を参照してください。

前述のモック設定ファイルの例では、MockedLambdaSuccess および MockedLambdaRetry で定義されたモック応答は、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呼び出します。これを行うには、 ARNで使用されるステートマシン#test_nameにサフィックス を追加しますStartExecution。 test_nameはテストケースで、同じモック設定ファイル内のステートマシン用に設定されます。

以下のコマンドは、LambdaSQSIntegration ステートマシンとモックコンフィグレーションを使用する例です。この例では、ステップ 1: モック設定ファイルでモックサービス統合を指定する で定義された HappyPath テストを使用して LambdaSQSIntegration ステートマシンが実行されます。HappyPath テストには、LambdaState ステートおよび SQSState ステートが MockedLambdaSuccess および MockedSQSSuccess のモックサービスのレスポンスを使用して行うモックサービス統合呼び出しを処理するための実行設定が含まれています。

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

ステートマシンの実行レスポンスを表示します。

モックサービス統合テストStartExecutionを使用して を呼び出すレスポンスは、実行日ARNと開始日を返すStartExecution通常の を呼び出すレスポンスと同じです。

以下は、モックサービス統合テストを使用した StartExecution の呼び出しに対するレスポンスの例です。

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

、ListExecutions、または GetExecutionHistoryAPI呼び出しを実行してDescribeExecution、実行の結果を確認します。

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

次の例は、ステップ 2 で示したレスポンス例ARNの実行GetExecutionHistoryを使用して を呼び出すレスポンスの一部を示しています。この例では、LambdaState と SQSState の出力は、モック設定ファイルの MockedLambdaSuccess と MockedSQSSuccess で定義されているモックデータです。また、モックデータは、実際のサービス統合呼び出しを実行して返されるデータと同じ方法で使用されます。また、この例では、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
                }
            }
        },
        ...
    ]
}