Add test for Serverlesspresso AWS sample application #24

lizard-boy · 2024-09-20T12:35:45Z

Motivation

As part of our scenario testing exploration, we also wanted to look into migrating bigger samples to our CDK-based setup and add multiple test scenarios on that infrastructure.

Changes

Adds a scenario test using a slightly modified version of Serverlesspresso, a pretty sophisticated event-based sample application from AWS.
Implements UPDATE support for stacks in infra provisioner for faster iteration cycles while writing the test scenarios

Testing

Note that the test currently only works against AWS.

TODO

What's left to do:

extract re-usable utils
only update stack when running on AWS
add a simple test that at least validates successful deployment on LS
add timeout tests
add full e2e test with cognito/apigw

greptile-apps

PR Summary

This pull request adds a comprehensive scenario test for the Serverlesspresso AWS sample application, implementing a complex serverless coffee ordering system using various AWS services.

Introduced ServerlesspressoCoreStack in serverlesspresso_core_stack.py, setting up core AWS services like DynamoDB, EventBridge, IoT Core, and Lambda functions
Added multiple service constructs (e.g., AuthService, ConfigService, OrderManagerService) in separate files under constructs/ to modularize the application architecture
Implemented test_serverlesspresso.py with extensive test cases covering data population, store operations, user registration, order workflows, and WebSocket communication
Created ServerlesspressoStack.json CloudFormation template defining the complete infrastructure for the application
Added Lambda function implementations in artifacts/functions/ for various application functionalities like order processing, QR code verification, and IoT publishing

_{29 file(s) reviewed, 50 comment(s)}
_{Edit PR Review Bot Settings}

greptile-apps · 2024-09-20T12:37:01Z

tests/aws/cdk_templates/serverlesspresso/ServerlesspressoStack.json

+        ]
+      }
+    },
+    "ValidatorServiceGetQRcodeFunctionB2637D0B": {


style: Lambda function code is embedded directly in the template. Consider using a separate file for better maintainability

greptile-apps · 2024-09-20T12:37:02Z

tests/aws/cdk_templates/serverlesspresso/ServerlesspressoStack.json

+    "OrderManagerStateMachine": {
+      "Type": "AWS::StepFunctions::StateMachine",
+      "Properties": {
+        "DefinitionString": "{\n  \"Comment\": \"A description of my state machine\",\n  \"StartAt\": \"Decide Action\",\n  \"States\": {\n    \"Decide Action\": {\n      \"Type\": \"Choice\",\n      \"Choices\": [\n        {\n          \"Variable\": \"$.action\",\n          \"StringEquals\": \"complete\",\n          \"Next\": \"Complete Order\"\n        },\n        {\n          \"Variable\": \"$.action\",\n          \"StringEquals\": \"cancel\",\n          \"Next\": \"Cancel Order\"\n        },\n        {\n          \"Variable\": \"$.action\",\n          \"StringEquals\": \"make\",\n          \"Next\": \"Claim Order\"\n        },\n        {\n          \"Variable\": \"$.action\",\n          \"StringEquals\": \"unmake\",\n          \"Next\": \"Claim Order\"\n        }\n      ],\n      \"Default\": \"Customer Put Order\"\n    },\n    \"Cancel Order\": {\n      \"Type\": \"Pass\",\n      \"Next\": \"DynamoDB Update Order Record\",\n      \"Result\": {\n        \"name\": \"Cancelled\",\n        \"state\": \"CANCELLED\"\n      },\n      \"ResultPath\": \"$.event\"\n    },\n    \"DynamoDB Update Order Record\": {\n      \"Type\": \"Task\",\n      \"Resource\": \"arn:aws:states:::dynamodb:updateItem\",\n      \"Parameters\": {\n        \"TableName\": \"${OMTable}\",\n        \"Key\": {\n          \"PK\": {\n            \"S\": \"orders\"\n          },\n          \"SK\": {\n            \"S.$\": \"$.orderId\"\n          }\n        },\n        \"UpdateExpression\": \"set #OS = :OS\",\n        \"ExpressionAttributeNames\": {\n          \"#OS\": \"ORDERSTATE\"\n        },\n        \"ExpressionAttributeValues\": {\n          \":OS\": {\n            \"S.$\": \"$.event.state\"\n          }\n        },\n        \"ReturnValues\": \"ALL_NEW\"\n      },\n      \"ResultPath\": \"$.result\",\n      \"Next\": \"Construct record (1)\",\n      \"ResultSelector\": {\n        \"Attributes.$\": \"$.Attributes\"\n      }\n    },\n    \"Construct record (1)\": {\n      \"Type\": \"Pass\",\n      \"Next\": \"Emit Completed || Cancelled\",\n      \"ResultPath\": \"$.detail\",\n      \"Parameters\": {\n        \"orderId.$\": \"$.orderId\",\n        \"userId.$\": \"$.result.Attributes.USERID.S\",\n        \"ORDERSTATE.$\": \"$.result.Attributes.ORDERSTATE.S\",\n        \"Message\": \"Barrista has cancelled or completed the order\"\n      }\n    },\n    \"Emit Completed || Cancelled\": {\n      \"Type\": \"Task\",\n      \"Resource\": \"arn:aws:states:::events:putEvents\",\n      \"Parameters\": {\n        \"Entries\": [\n          {\n            \"Detail.$\": \"States.JsonToString($.detail)\",\n            \"DetailType.$\": \"States.Format('OrderManager.Order{}', $.event.name)\",\n            \"EventBusName\": \"Serverlesspresso\",\n            \"Source\": \"lstesting.serverlesspresso\",\n            \"Time.$\": \"$$.State.EnteredTime\"\n          }\n        ]\n      },\n      \"Next\": \"Resume Order Processor 1\",\n      \"ResultPath\": \"$.eventEmit\"\n    },\n    \"Complete Order\": {\n      \"Type\": \"Pass\",\n      \"Next\": \"DynamoDB Update Order Record\",\n      \"Result\": {\n        \"name\": \"Completed\",\n        \"state\": \"COMPLETED\"\n      },\n      \"ResultPath\": \"$.event\"\n    },\n    \"Customer Put Order\": {\n      \"Type\": \"Pass\",\n      \"Next\": \"get menu\"\n    },\n    \"get menu\": {\n      \"Type\": \"Task\",\n      \"Resource\": \"arn:aws:states:::dynamodb:getItem\",\n      \"Parameters\": {\n        \"TableName\": \"${ConfigTable}\",\n        \"Key\": {\n          \"PK\": {\n            \"S\": \"menu\"\n          }\n        }\n      },\n      \"Next\": \"Sanitize order\",\n      \"ResultPath\": \"$.menu\"\n    },\n    \"Sanitize order\": {\n      \"Type\": \"Task\",\n      \"Resource\": \"arn:aws:states:::lambda:invoke\",\n      \"Parameters\": {\n        \"Payload.$\": \"$\",\n        \"FunctionName\": \"${SanitizeOrderLambda}\"\n      },\n      \"Retry\": [\n        {\n          \"ErrorEquals\": [\n            \"Lambda.ServiceException\",\n            \"Lambda.AWSLambdaException\",\n            \"Lambda.SdkClientException\"\n          ],\n          \"IntervalSeconds\": 2,\n          \"MaxAttempts\": 6,\n          \"BackoffRate\": 2\n        }\n      ],\n      \"Next\": \"Is Order Valid?\",\n      \"ResultPath\": \"$.sanitise\"\n    },\n    \"Is Order Valid?\": {\n      \"Type\": \"Choice\",\n      \"Choices\": [\n        {\n          \"Variable\": \"$.sanitise.Payload\",\n          \"BooleanEquals\": false,\n          \"Next\": \"not a valid order\"\n        }\n      ],\n      \"Default\": \"Update order\"\n    },\n    \"not a valid order\": {\n      \"Type\": \"Succeed\"\n    },\n    \"Update order\": {\n      \"Type\": \"Task\",\n      \"Resource\": \"arn:aws:states:::dynamodb:updateItem\",\n      \"Parameters\": {\n        \"TableName\": \"serverlesspresso-order-table\",\n        \"Key\": {\n          \"PK\": {\n            \"S\": \"orders\"\n          },\n          \"SK\": {\n            \"S.$\": \"$.orderId\"\n          }\n        },\n        \"UpdateExpression\": \"set #drinkOrder = :drinkOrder\",\n        \"ConditionExpression\": \"#userId = :userId AND attribute_exists(TaskToken)\",\n        \"ExpressionAttributeNames\": {\n          \"#drinkOrder\": \"drinkOrder\",\n          \"#userId\": \"USERID\"\n        },\n        \"ExpressionAttributeValues\": {\n          \":drinkOrder\": {\n            \"S.$\": \"States.JsonToString($.body)\"\n          },\n          \":userId\": {\n            \"S.$\": \"$.body.userId\"\n          }\n        },\n        \"ReturnValues\": \"ALL_NEW\"\n      },\n      \"Next\": \"Resume Order Processor 2\",\n      \"ResultSelector\": {\n        \"TaskToken.$\": \"$.Attributes.TaskToken.S\"\n      },\n      \"OutputPath\": \"$.record\",\n      \"ResultPath\": \"$.record\"\n    },\n    \"Resume Order Processor 1\": {\n      \"Type\": \"Task\",\n      \"Parameters\": {\n        \"Output\": \"{}\",\n        \"TaskToken.$\": \"$.result.Attributes.TaskToken.S\"\n      },\n      \"Resource\": \"arn:aws:states:::aws-sdk:sfn:sendTaskSuccess\",\n      \"End\": true\n    },\n    \"Resume Order Processor 2\": {\n      \"Type\": \"Task\",\n      \"Parameters\": {\n        \"Output\": \"{}\",\n        \"TaskToken.$\": \"$.TaskToken\"\n      },\n      \"Resource\": \"arn:aws:states:::aws-sdk:sfn:sendTaskSuccess\",\n      \"End\": true\n    },\n    \"Claim Order\": {\n      \"Type\": \"Pass\",\n      \"Next\": \"Make OR Unmake?\"\n    },\n    \"Make OR Unmake?\": {\n      \"Type\": \"Choice\",\n      \"Choices\": [\n        {\n          \"Variable\": \"$.action\",\n          \"StringEquals\": \"unmake\",\n          \"Next\": \"Unmake Order\"\n        },\n        {\n          \"Variable\": \"$.action\",\n          \"StringEquals\": \"make\",\n          \"Next\": \"DynamoDB Update Order\"\n        }\n      ],\n      \"Default\": \"DynamoDB Update Order\"\n    },\n    \"Unmake Order\": {\n      \"Type\": \"Pass\",\n      \"Parameters\": {\n        \"baristaUserId\": \"\",\n        \"orderId.$\": \"$.orderId\",\n        \"Message\": \"The barista has pressed the 'UnMake order' button, this Invokes a Lambda function via API Gateway, which updates the order in DynamoDB and emits a new 'make order' Event.\"\n      },\n      \"Next\": \"DynamoDB Update Order\"\n    },\n    \"DynamoDB Update Order\": {\n      \"Type\": \"Task\",\n      \"Resource\": \"arn:aws:states:::dynamodb:updateItem\",\n      \"Parameters\": {\n        \"TableName\": \"serverlesspresso-order-table\",\n        \"Key\": {\n          \"PK\": {\n            \"S\": \"orders\"\n          },\n          \"SK\": {\n            \"S.$\": \"$.orderId\"\n          }\n        },\n        \"UpdateExpression\": \"set #baristaUserId = :baristaUserId\",\n        \"ExpressionAttributeNames\": {\n          \"#baristaUserId\": \"baristaUserId\"\n        },\n        \"ExpressionAttributeValues\": {\n          \":baristaUserId\": {\n            \"S.$\": \"$.baristaUserId\"\n          }\n        },\n        \"ReturnValues\": \"ALL_NEW\"\n      },\n      \"ResultSelector\": {\n        \"Attributes.$\": \"$.Attributes\"\n      },\n      \"ResultPath\": \"$.result\",\n      \"Next\": \"Construct record\"\n    },\n    \"Construct record\": {\n      \"Type\": \"Pass\",\n      \"Next\": \"EventBridge Emit Making Order\",\n      \"ResultPath\": \"$.detail\",\n      \"Parameters\": {\n        \"baristaUserId.$\": \"$.result.Attributes.baristaUserId.S\",\n        \"orderId.$\": \"$.orderId\",\n        \"userId.$\": \"$.result.Attributes.USERID.S\",\n        \"Message\": \"The barista has pressed the 'Make order' button, this Invokes a Lambda function via API Gateway, which updates the order in DynamoDB and emits a new 'make order' Event.\"\n      }\n    },\n    \"EventBridge Emit Making Order\": {\n      \"Type\": \"Task\",\n      \"Resource\": \"arn:aws:states:::events:putEvents\",\n      \"Parameters\": {\n        \"Entries\": [\n          {\n            \"Detail.$\": \"States.JsonToString($.detail)\",\n            \"DetailType\": \"OrderManager.MakeOrder\",\n            \"EventBusName\": \"Serverlesspresso\",\n            \"Source\": \"lstesting.serverlesspresso\",\n            \"Time.$\": \"$$.State.EnteredTime\"\n          }\n        ]\n      },\n      \"End\": true\n    }\n  }\n}\n",


style: State machine definition is embedded as a string. Consider using a separate JSON file for improved readability and maintenance

greptile-apps · 2024-09-20T12:38:42Z

tests/aws/scenario/serverlesspresso/artifacts/api/config_service_api.yaml

+          default:
+            statusCode: "200"
+            responseParameters:
+              method.response.header.Access-Control-Allow-Methods: "'GET,OPTIONS'"


logic: Access-Control-Allow-Methods should include 'PUT' instead of 'GET' for the store endpoint

greptile-apps · 2024-09-20T12:39:39Z

tests/aws/scenario/serverlesspresso/artifacts/api/order_manager_api.yaml

+          application/json: "\n#set($state = $input.params('state'))\n#if( $input.params('maxItems').toString()\
+            \ != \"\" )\n  #set($maxItems = $input.params('maxItems'))\n#else\n  #set($maxItems\
+            \ = 100)\n#end\n\n\n{\n    \"TableName\": \"serverlesspresso-order-table\"\
+            ,\n    \"IndexName\": \"GSI-status\",\n    \"KeyConditionExpression\"\
+            : \"#ORDERSTATE = :ORDERSTATE\",\n    \"ExpressionAttributeNames\": {\n\
+            \    \"#ORDERSTATE\": \"ORDERSTATE\"\n    },\n    \"ExpressionAttributeValues\"\
+            : {\n    \":ORDERSTATE\": {\n      \"S\": \"$state\"\n    }\n    },\n\
+            \    \"ScanIndexForward\": true,\n    \"Limit\": $maxItems,\n    \"ProjectionExpression\"\
+            : \"PK, SK, orderNumber, robot, drinkOrder, ORDERSTATE, TS, userId, baristaUserId\"\
+            \n}"


style: Consider using a more descriptive name for the DynamoDB table, such as 'serverlesspresso-orders' instead of 'serverlesspresso-order-table'

greptile-apps · 2024-09-20T12:39:40Z

tests/aws/scenario/serverlesspresso/artifacts/api/order_manager_api.yaml

+          application/json: "#set($sub = $input.params('sub'))\n#set($subFromJWT =\
+            \ $context.authorizer.claims.sub)\n\n{\n    \"TableName\": \"serverlesspresso-order-table\"\
+            ,\n    \"IndexName\": \"GSI-userId\",\n    \"KeyConditionExpression\"\
+            : \"#USERID = :USERID\",\n    \"ExpressionAttributeNames\": {\n    \"\
+            #USERID\": \"USERID\"\n    },\n    \"ExpressionAttributeValues\": {\n\
+            \    \":USERID\": {\n      \"S\": \"$subFromJWT\"\n    }\n    },\n   \
+            \ \"ScanIndexForward\": true,\n    \"ProjectionExpression\": \"PK, SK,\
+            \ orderNumber, robot, drinkOrder, ORDERSTATE, TS\"\n}"


style: The 'sub' parameter is set but not used. Consider removing it if it's unnecessary

greptile-apps · 2024-09-20T12:56:49Z

tests/aws/scenario/serverlesspresso/constructs/serverlesspresso_core_stack.py

+        source = SERVERLESSPRESSO_SOURCE  # Event bus source by application
+        max_concurrent_capacity = "5"


style: Consider using an integer instead of a string for max_concurrent_capacity

greptile-apps · 2024-09-20T12:56:50Z

tests/aws/scenario/serverlesspresso/constructs/serverlesspresso_core_stack.py

+            cdk.aws_iam.PolicyStatement(
+                actions=["iot:DescribeEndpoint"], resources=["*"], effect=cdk.aws_iam.Effect.ALLOW


style: Broad IAM permission. Consider restricting to specific resources if possible

greptile-apps · 2024-09-20T12:57:46Z

tests/aws/scenario/serverlesspresso/constructs/validator_service.py

+            },
+            timeout=cdk.Duration.seconds(15),
+        )
+        validator_table.grant_full_access(get_qr_code_fn)


style: Granting full access to the Lambda function may be overly permissive. Consider using least privilege principle

greptile-apps · 2024-09-20T12:57:47Z

tests/aws/scenario/serverlesspresso/constructs/validator_service.py

+            default_cors_preflight_options=cdk.aws_apigateway.CorsOptions(
+                allow_origins=["*"], allow_headers=["*"], allow_methods=["GET", "POST", "OPTIONS"]
+            ),


style: CORS is set to allow all origins (*). This may pose security risks in production

greptile-apps · 2024-09-20T12:58:35Z

tests/aws/scenario/serverlesspresso/test_serverlesspresso.py

+        ]
+        aws_client.events.put_events(Entries=initial_events)
+        # all 5 should be in "Emit - Workflow Started TT" state waiting for the callback with a token
+        time.sleep(2)  # TODO: instead just check if all 5 are in a waiting state


style: Replace sleep with a more robust check for waiting state

dominikschubert and others added 24 commits August 2, 2024 10:42

initial wip

28c528c

cleanup

285c603

update code and make stack deployable

dedda48

greenify test open store

9544228

order completion workflow test is complete

ca3f4f1

extra configs

d1509ac

config service and order service fixes

38e2328

rest api services deployments

4a06adc

fix validator service deployments

d78b88d

register user test

d45a959

fix verify code

fdec759

waiting on deployment event trigger

c6c1aab

fix waiting fn

c241d2b

fix final state value

fdf9960

fix test state assertion

4e4be46

publisher functions renamed

8ee5981

trigger publisher functions

8ea005b

resolve role attachments for cognito users

dc04d88

fix state issue with casing and event name

4fcc8f5

wip: e2e test

65cddf9

e2e

bf11467

format and lint

370042e

wip: iot test

b8cd1f3

iot test complete

0dbbd43

greptile-apps bot reviewed Sep 20, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add test for Serverlesspresso AWS sample application #24

Add test for Serverlesspresso AWS sample application #24

lizard-boy commented Sep 20, 2024

greptile-apps bot left a comment

greptile-apps bot Sep 20, 2024

greptile-apps bot Sep 20, 2024

greptile-apps bot Sep 20, 2024

greptile-apps bot Sep 20, 2024

greptile-apps bot Sep 20, 2024

greptile-apps bot Sep 20, 2024

greptile-apps bot Sep 20, 2024

greptile-apps bot Sep 20, 2024

greptile-apps bot Sep 20, 2024

greptile-apps bot Sep 20, 2024

		source = SERVERLESSPRESSO_SOURCE # Event bus source by application
		max_concurrent_capacity = "5"

		cdk.aws_iam.PolicyStatement(
		actions=["iot:DescribeEndpoint"], resources=["*"], effect=cdk.aws_iam.Effect.ALLOW

Add test for Serverlesspresso AWS sample application #24

Are you sure you want to change the base?

Add test for Serverlesspresso AWS sample application #24

Conversation

lizard-boy commented Sep 20, 2024

Motivation

Changes

Testing

TODO

greptile-apps bot left a comment

Choose a reason for hiding this comment

PR Summary

greptile-apps bot Sep 20, 2024

Choose a reason for hiding this comment

greptile-apps bot Sep 20, 2024

Choose a reason for hiding this comment

greptile-apps bot Sep 20, 2024

Choose a reason for hiding this comment

greptile-apps bot Sep 20, 2024

Choose a reason for hiding this comment

greptile-apps bot Sep 20, 2024

Choose a reason for hiding this comment

greptile-apps bot Sep 20, 2024

Choose a reason for hiding this comment

greptile-apps bot Sep 20, 2024

Choose a reason for hiding this comment

greptile-apps bot Sep 20, 2024

Choose a reason for hiding this comment

greptile-apps bot Sep 20, 2024

Choose a reason for hiding this comment

greptile-apps bot Sep 20, 2024

Choose a reason for hiding this comment