Add volume mounts and improve sample scripts

Author: joe4dev

lambda-debug-mode/python/base-concurrent-lambda-debug-mode/Makefile

@@ -16,5 +16,24 @@ run:         ## Deploy and invoke the Lambda container locally
 	./run.sh; \
 	echo "Done - test successfully finished."
 
-.PHONY: usage install run
+start:
+	LOCALSTACK_LAMBDA_DEBUG_MODE=1 \
+	LOCALSTACK_LAMBDA_DEBUG_MODE_CONFIG_PATH=/tmp/lambda_debug_mode_config.yaml \
+	localstack start --volume ${PWD}/lambda_debug_mode_config.yaml:/tmp/lambda_debug_mode_config.yaml -d
 
+stop:
+	@echo
+	localstack stop
+
+ready:
+	@echo Waiting on the LocalStack container...
+	@localstack wait -t 30 && echo Localstack is ready to use! || (echo Gave up waiting on LocalStack, exiting. && exit 1)
+
+logs:
+	@localstack logs > logs.txt
+
+test-ci:
+	make install; return_code=`echo $$?`;\
+	echo "Interactive debugging not tested in CI"; exit $$return_code;
+
+.PHONY: usage install run start stop ready logs test-ci

lambda-debug-mode/python/base-concurrent-lambda-debug-mode/README.md

@@ -1,6 +1,6 @@
 # LocalStack Demo: Lambda Debug Mode Automatically Handle Concurrent Function Invocations
 
-A simple demo application showcasing how to Lambda Debug Mode automatically controls concurrent lambda call invocations.
+A simple demo application showcasing how Lambda Debug Mode automatically controls concurrent lambda call invocations.
 The demo deploys a Lambda function with a one-second timeout, and continues to invoke this function
 three times. Upon connecting the remote debugger, the user should see how only the first call is received and can be
 debugged, with concurrency error messages being logged about the following two invocations.
@@ -15,43 +15,40 @@ debugged, with concurrency error messages being logged about the following two i
 ## Installing
 
 To install the dependencies:
-```
+
+```sh
 make install
 ```
 
 ## Starting Up
 
-Make sure that LocalStack is started with the following configuration:
+```sh
+LOCALSTACK_LAMBDA_DEBUG_MODE=1 \
+LOCALSTACK_LAMBDA_DEBUG_MODE_CONFIG_PATH=/tmp/lambda_debug_mode_config.yaml \
+localstack start --volume $PWD/lambda_debug_mode_config.yaml:/tmp/lambda_debug_mode_config.yaml
 ```
-LAMBDA_DEBUG_MODE=1 \
-LAMBDA_DEBUG_MODE_CONFIG_PATH=path/to/lambda_debug_mode_config.yaml \
-localstack start
-```
-
-Lambda Debug Mode is enabled through the config option `LAMBDA_DEBUG_MODE=1`.
-
-The config option `LAMBDA_DEBUG_MODE_CONFIG_PATH` should point to the provided `yaml` config file for Lambda Debug Mode `lambda_debug_mode_config.yaml`.
-The config file contains instructions for Lambda Debug Mode to debug the Lambda function `arn:aws:lambda:us-east-1:000000000000:function:function-one` on port `19891`.
 
+* `LOCALSTACK_LAMBDA_DEBUG_MODE=1` enables the Lambda debug mode
+* `LOCALSTACK_LAMBDA_DEBUG_MODE_CONFIG_PATH=/tmp/lambda_debug_mode_config.yaml` points to the config file for Lambda debug mode allowing for advanced configuration. It maps the Lambda function `arn:aws:lambda:us-east-1:000000000000:function:function-one` to port `19891`.
+* `--volume $PWD/lambda_debug_mode_config.yaml:/tmp/lambda_debug_mode_config.yaml` maps the Lambda debug configuration from the host into the LocalStack Docker container for hot-reloading.
 
 ## Running the Sample
 
 The project ships with a Visual Studio Code debug launch config (see `.vscode/launch.json`). This configuration can be used to attach to the code in the Lambda function while it is executing.
 
 The following command used to deploy and invoke the Lambda locally:
 
-```
+```sh
 make run
 ```
 
 ### Attaching the VSCode Debugger
 
-After the Lambda function is invoked you can switch to Visual Studio Code, set a breakpoint in the Lambda handler, and run the preconfigured remote debugger.
+After the Lambda function is invoked you can switch to Visual Studio Code, set a breakpoint in the Lambda handler, and run the pre-configured remote debugger.
 LocalStack will automatically waive the set one second timeout for the Lambda function, giving you ample time to connect the debugger and debug the logic in the function.
 You should also notice how the debugger connects to the first invocation (the message object would end with `Attempt 1`), whilst the following invocations
 are refused automatically by Lambda Debug Mode as explained in the corresponding log messages.
 
 ## License
 
 The code in this sample is available under the Apache 2.0 license.
-

lambda-debug-mode/python/base-concurrent-lambda-debug-mode/run.sh

@@ -11,29 +11,9 @@ awslocal lambda create-function \
     --code "S3Bucket=hot-reload,S3Key=$(pwd)/" \
     --handler handler.handler \
     --role arn:aws:iam::000000000000:role/test-role \
-    --runtime python3.9
+    --runtime python3.12
 
-# Function to check the status of the Lambda function.
-check_lambda_status() {
-    status=$(awslocal lambda get-function --function-name "$FUNCTION_NAME" 2>&1)
-    # Check if "Active" is in the response
-    if echo "$status" | grep -q "Active"; then
-        return 0
-    fi
-    return 1
-}
-
-# Wait until the Lambda function is active
-echo "Waiting for Lambda function to become active..."
-while true; do
-    if check_lambda_status; then
-        echo "Lambda function is active."
-        break
-    else
-        echo "Lambda function is still pending. Waiting..."
-        sleep 1
-    fi
-done
+awslocal lambda wait function-active-v2 --function-name "$FUNCTION_NAME"
 
 # Invoke the Lambda function 3 times every 5 seconds.
 for i in {1..3}; do
@@ -42,9 +22,10 @@ for i in {1..3}; do
     awslocal lambda invoke \
         --cli-connect-timeout 3600 \
         --cli-read-timeout 3600 \
-        --function-name "function_one" \
+        --function-name "$FUNCTION_NAME" \
         --payload "{\"message\": \"Testing Lambda Debug Mode lifting the 1-second timeout for function-one. Attempt $i.\"}" \
         /dev/stdout 2>/dev/stderr &
     sleep 5
 done
 
+echo "Set a breakpoint and attach the Python remote debugger from your IDE"

lambda-debug-mode/python/base-enable-lambda-debug-mode/Makefile

@@ -16,5 +16,24 @@ run:         ## Deploy and invoke the Lambda container locally
 	./run.sh; \
 	echo "Done - test successfully finished."
 
-.PHONY: usage install run
+start:
+	LOCALSTACK_LAMBDA_DEBUG_MODE=1 \
+	LOCALSTACK_LAMBDA_DEBUG_MODE_CONFIG_PATH=/tmp/lambda_debug_mode_config.yaml \
+	localstack start --volume ${PWD}/lambda_debug_mode_config.yaml:/tmp/lambda_debug_mode_config.yaml -d
 
+stop:
+	@echo
+	localstack stop
+
+ready:
+	@echo Waiting on the LocalStack container...
+	@localstack wait -t 30 && echo Localstack is ready to use! || (echo Gave up waiting on LocalStack, exiting. && exit 1)
+
+logs:
+	@localstack logs > logs.txt
+
+test-ci:
+	make install; return_code=`echo $$?`;\
+	echo "Interactive debugging not tested in CI"; exit $$return_code;
+
+.PHONY: usage install run start stop ready logs test-ci

lambda-debug-mode/python/base-enable-lambda-debug-mode/README.md

@@ -13,45 +13,46 @@ The demo deploys a Lambda function with a one-second timeout, which is automatic
 ## Installing
 
 To install the dependencies:
-```
+
+```sh
 make install
 ```
 
 ## Starting Up
 
 Make sure that LocalStack is started with the following configuration:
-```
-LAMBDA_DEBUG_MODE=1 \
-LAMBDA_DEBUG_MODE_CONFIG_PATH=path/to/lambda_debug_mode_config.yaml \
-localstack start
-```
-
-Lambda Debug Mode is enabled through the config option `LAMBDA_DEBUG_MODE=1`.
 
-The config option `LAMBDA_DEBUG_MODE_CONFIG_PATH` should point to the provided `yaml` config file for Lambda Debug Mode `lambda_debug_mode_config.yaml`.
-The config file contains instructions for Lambda Debug Mode to debug the Lambda function `arn:aws:lambda:us-east-1:000000000000:function:function-one` on port `19891`.
+```sh
+LOCALSTACK_LAMBDA_DEBUG_MODE=1 \
+LOCALSTACK_LAMBDA_DEBUG_MODE_CONFIG_PATH=/tmp/lambda_debug_mode_config.yaml \
+localstack start --volume $PWD/lambda_debug_mode_config.yaml:/tmp/lambda_debug_mode_config.yaml
+```
 
+* `LOCALSTACK_LAMBDA_DEBUG_MODE=1` enables the Lambda debug mode
+* `LOCALSTACK_LAMBDA_DEBUG_MODE_CONFIG_PATH=/tmp/lambda_debug_mode_config.yaml` points to the config file for Lambda debug mode allowing for advanced configuration. It maps the Lambda function `arn:aws:lambda:us-east-1:000000000000:function:function-one` to port `19891`.
+* `--volume $PWD/lambda_debug_mode_config.yaml:/tmp/lambda_debug_mode_config.yaml` maps the Lambda debug configuration from the host into the LocalStack Docker container for hot-reloading.
 
 ## Running the Sample
 
 The project ships with a Visual Studio Code debug launch config (see `.vscode/launch.json`). This configuration can be used to attach to the code in the Lambda function while it is executing.
 
 The following command used to deploy and invoke the Lambda locally:
 
-```
+```sh
 make run
 ```
 
 ### Attaching the VSCode Debugger
 
-After the Lambda function is invoked you can switch to Visual Studio Code, set a breakpoint in the Lambda handler, and run the preconfigured remote debugger.
+After the Lambda function is invoked you can switch to Visual Studio Code, set a breakpoint in the Lambda handler, and run the pre-configured remote debugger.
 LocalStack will automatically waive the set one second timeout for the Lambda function, giving you ample time to connect the debugger and debug the logic in the function.
 
 ### Quick Dev Loop with Lambda Code Mounting
 
 Note that, since the Lambda code is mounted from your local filesystem into the Lambda container (by means of `hot-reload` as special bucket name in `run.sh`),
 all changes are immediately reflected. For example, you could change the implementation of the handler as follows:
-```
+
+```python
 def handler(event, context):
     """Lambda handler that will get invoked by the LocalStack runtime"""
 
@@ -64,13 +65,13 @@ def handler(event, context):
     # Additional line added below:
     print("!! Additional log output !!")
 
-    # Return the incomeing invocation evant.
+    # Return the incoming invocation event.
     return event
 ```
+
 and then upon next invocation of the Lambda, the additional print output will immediately appear in the Lambda logs.
 This allows for a quick dev/debug loop, without the need to redeploy the Lambda after the handler is changed!
 
 ## License
 
 The code in this sample is available under the Apache 2.0 license.
-

lambda-debug-mode/python/base-enable-lambda-debug-mode/run.sh

@@ -11,37 +11,18 @@ awslocal lambda create-function \
     --code "S3Bucket=hot-reload,S3Key=$(pwd)/" \
     --handler handler.handler \
     --role arn:aws:iam::000000000000:role/test-role \
-    --runtime python3.9
+    --runtime python3.12
 
-# Function to check the status of the Lambda function.
-check_lambda_status() {
-    status=$(awslocal lambda get-function --function-name "$FUNCTION_NAME" 2>&1)
-    # Check if "Active" is in the response
-    if echo "$status" | grep -q "Active"; then
-        return 0
-    fi
-    return 1
-}
-
-# Wait until the Lambda function is active
-echo "Waiting for Lambda function to become active..."
-while true; do
-    if check_lambda_status; then
-        echo "Lambda function is active."
-        break
-    else
-        echo "Lambda function is still pending. Waiting..."
-        sleep 1
-    fi
-done
+awslocal lambda wait function-active-v2 --function-name "$FUNCTION_NAME"
 
 # Invoke the Lambda function.
 echo "Invoking the Lambda function."
 AWS_MAX_ATTEMPTS=1 \
 awslocal lambda invoke \
     --cli-connect-timeout 3600 \
     --cli-read-timeout 3600 \
-    --function-name "function_one" \
+    --function-name "$FUNCTION_NAME" \
     --payload '{"message": "Testing Lambda Debug Mode lifting the 1-second timeout for function-one."}' \
     /dev/stdout 2>/dev/stderr
 
+echo "Set a breakpoint and attach the Python remote debugger from your IDE"

lambda-debug-mode/python/base-multiple-lambda-debug-mode/Makefile

@@ -16,5 +16,24 @@ run:         ## Deploy and invoke the Lambda container locally
 	./run.sh; \
 	echo "Done - test successfully finished."
 
-.PHONY: usage install run
+start:
+	LOCALSTACK_LAMBDA_DEBUG_MODE=1 \
+	LOCALSTACK_LAMBDA_DEBUG_MODE_CONFIG_PATH=/tmp/lambda_debug_mode_config.yaml \
+	localstack start --volume ${PWD}/lambda_debug_mode_config.yaml:/tmp/lambda_debug_mode_config.yaml -d
 
+stop:
+	@echo
+	localstack stop
+
+ready:
+	@echo Waiting on the LocalStack container...
+	@localstack wait -t 30 && echo Localstack is ready to use! || (echo Gave up waiting on LocalStack, exiting. && exit 1)
+
+logs:
+	@localstack logs > logs.txt
+
+test-ci:
+	make install; return_code=`echo $$?`;\
+	echo "Interactive debugging not tested in CI"; exit $$return_code;
+
+.PHONY: usage install run start stop ready logs test-ci

lambda-debug-mode/python/base-multiple-lambda-debug-mode/README.md

@@ -14,49 +14,48 @@ and configure the Docker container to open specific debug ports for the two lamb
 ## Installing
 
 To install the dependencies:
-```
+
+```sh
 make install
 ```
 
 ## Starting Up
 
 Make sure that LocalStack is started with the following configuration:
-```
-LAMBDA_DEBUG_MODE=1 \
-LAMBDA_DEBUG_MODE_CONFIG_PATH=path/to/lambda_debug_mode_config.yaml \
-localstack start
-```
-
-Lambda Debug Mode is enabled through the config option `LAMBDA_DEBUG_MODE=1`.
 
-The config option `LAMBDA_DEBUG_MODE_CONFIG_PATH` should point to the provided `yaml` config file for Lambda Debug Mode `lambda_debug_mode_config.yaml`.
-The config file contains instructions for Lambda Debug Mode to debug
-Lambda function `arn:aws:lambda:us-east-1:000000000000:function:function-one` on port `19891` and
-Lambda function `arn:aws:lambda:us-east-1:000000000000:function:function-two` on port `19892`.
-The two lambda functions configure `debugpy` to listen for debug connections on the corresponding ports.
+```sh
+LOCALSTACK_LAMBDA_DEBUG_MODE=1 \
+LOCALSTACK_LAMBDA_DEBUG_MODE_CONFIG_PATH=/tmp/lambda_debug_mode_config.yaml \
+localstack start --volume $PWD/lambda_debug_mode_config.yaml:/tmp/lambda_debug_mode_config.yaml
+```
 
+* `LOCALSTACK_LAMBDA_DEBUG_MODE=1` enables the Lambda debug mode
+* `LOCALSTACK_LAMBDA_DEBUG_MODE_CONFIG_PATH` points to the config file for Lambda debug mode allowing for advanced configuration. It maps the Lambda function `arn:aws:lambda:us-east-1:000000000000:function:function-one` to port `19891` and
+Lambda function `arn:aws:lambda:us-east-1:000000000000:function:function-two` on port `19892`. The two lambda functions configure `debugpy` to listen for debug connections on the corresponding ports.
+* `--volume $PWD/lambda_debug_mode_config.yaml:/tmp/lambda_debug_mode_config.yaml` maps the Lambda debug configuration from the host into the LocalStack Docker container for hot-reloading.
 
 ## Running the Sample
 
 The project ships with a Visual Studio Code debug launch config (see `.vscode/launch.json`). This configuration can be used to attach to the code in the Lambda function while it is executing.
 
 The following command used to deploy and invoke the Lambda locally:
 
-```
+```sh
 make run
 ```
 
 ### Attaching the VSCode Debugger
 
-After the Lambda function is invoked you can switch to Visual Studio Code, set a breakpoint in the Lambda handler, and run the preconfigured remote debuggers.
-You will find that you can run the two preconfigured remote debuggers at the same time and simultaneously debug both Lambda functions.
+After the Lambda function is invoked you can switch to Visual Studio Code, set a breakpoint in the Lambda handler, and run the pre-configured remote debuggers.
+You will find that you can run the two pre-configured remote debuggers at the same time and simultaneously debug both Lambda functions.
 LocalStack will automatically waive the set one second timeout for the Lambda function, giving you ample time to connect the debugger and debug the logic in the function.
 
 ### Quick Dev Loop with Lambda Code Mounting
 
 Note that, since the Lambda code is mounted from your local filesystem into the Lambda container (by means of `hot-reload` as special bucket name in `run.sh`),
 all changes are immediately reflected. For example, you could change the implementation of the handler for `function_one` as follows:
-```
+
+```python
 def handler(event, context):
     """Lambda handler that will get invoked by the LocalStack runtime"""
 
@@ -72,7 +71,7 @@ def handler(event, context):
     # Additional line added below:
     print("!! Additional log output !!")
 
-    # Return the incomeing invocation evant.
+    # Return the incoming invocation event.
     return event
 ```
 
@@ -82,4 +81,3 @@ This allows for a quick dev/debug loop, without the need to redeploy the Lambda
 ## License
 
 The code in this sample is available under the Apache 2.0 license.
-

lambda-debug-mode/python/base-multiple-lambda-debug-mode/handler_function_two.py

@@ -35,4 +35,3 @@ def run(self):
 
 if __name__ == "__main__":
     handler({}, {})
-