Add Python debugging sample

Author: joe4dev

lambda-debugging-sam-python/.gitignore

@@ -0,0 +1,187 @@
+# Lambda function response
+response.json
+
+# Created by https://www.toptal.com/developers/gitignore/api/python,sam
+# Edit at https://www.toptal.com/developers/gitignore?templates=python,sam
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+### SAM ###
+# Ignore build directories for the AWS Serverless Application Model (SAM)
+# Info: https://aws.amazon.com/serverless/sam/
+# Docs: https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-reference.html
+
+**/.aws-sam
+
+# End of https://www.toptal.com/developers/gitignore/api/python,sam
+

lambda-debugging-sam-python/.vscode/launch.json

@@ -0,0 +1,20 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Python: Remote Attach",
+            "type": "debugpy",
+            "request": "attach",
+            "connect": {
+                "host": "localhost",
+                "port": 8050
+            },
+            "pathMappings": [
+                {
+                    "localRoot": "${workspaceFolder}/hello_world",
+                    "remoteRoot": "."
+                }
+            ]
+        }
+    ]
+}

lambda-debugging-sam-python/Makefile

@@ -0,0 +1,90 @@
+.PHONY: usage install build build-docker build-local build-sam wait deploy deploy-aws deploy-sam invoke clean start stop ready test-ci
+
+AWS_ENDPOINT_URL ?= http://localhost.localstack.cloud:4566
+AWS ?= AWS_ENDPOINT_URL=$(AWS_ENDPOINT_URL) \
+	AWS_ACCESS_KEY_ID=test \
+	AWS_SECRET_ACCESS_KEY=test \
+	AWS_DEFAULT_REGION=us-east-1 \
+	aws
+SAM ?= AWS_ENDPOINT_URL=$(AWS_ENDPOINT_URL) \
+	AWS_ACCESS_KEY_ID=test \
+	AWS_SECRET_ACCESS_KEY=test \
+	AWS_DEFAULT_REGION=us-east-1 \
+	sam
+FUNCTION_NAME ?= HelloWorldFunctionPython
+
+# Changing architecture (arm64 or x86_64) requires rebuilding the Java package in Docker
+ARCH ?= x86_64
+DOCKER_PLATFORM ?= linux/$(ARCH)
+IMAGE ?= public.ecr.aws/sam/build-python3.13:latest-$(ARCH)
+
+all: usage
+
+usage:                ## Show this help
+	@fgrep -h "##" $(MAKEFILE_LIST) | fgrep -v fgrep | sed -e 's/\\$$//' | sed -e 's/##//'
+
+# TODO: figure out how to install the AWS CLI v2 in CI
+install:              ## Install CLI dependencies
+	@which aws || pip install awscli
+
+build: build-local   ## Build the Lambda function (default local)
+
+# TODO: package dependencies in requirements.txt
+# TODO: run tests before build
+build-docker:         ## Build the Lambda function zip in Docker
+	docker run --platform $(DOCKER_PLATFORM) --rm -v "$$(pwd)/hello_world:/app" $(IMAGE) bash -c "cd /app && zip -r hello_world_python.zip ."
+
+# TODO: package dependencies in requirements.txt
+# TODO: run tests before build
+build-local:          ## Build the Lambda function zip locally (JDK required)
+	cd hello_world && zip -r hello_world_python.zip .
+
+build-sam:            ## Build the Lambda function via AWS SAM
+	$(SAM) build --use-container
+
+wait:                 ## Wait until the Lambda function becomes ready to invoke
+	$(AWS) lambda wait function-active-v2 --function-name $(FUNCTION_NAME)
+
+deploy: deploy-aws    ## Deploy the Lambda function (default AWS CLI)
+
+deploy-aws:           ## Deploy the Lambda function via AWS CLI
+	$(AWS) lambda create-function \
+	--function-name $(FUNCTION_NAME) \
+	--runtime python3.13 \
+	--role arn:aws:iam::000000000000:role/lambda-role \
+	--handler app.lambda_handler \
+	--zip-file fileb://hello_world/hello_world_python.zip \
+	--timeout 2
+
+deploy-sam:           ## Deploy the Lambda function via AWS SAM CLI
+	$(SAM) deploy
+
+invoke:               ## Invoke the Lambda function and show logs
+	AWS_MAX_ATTEMPTS=1 $(AWS) lambda invoke --function-name $(FUNCTION_NAME) \
+	--payload file://events/event.json \
+	--cli-connect-timeout 3600 \
+	--cli-read-timeout 3600 \
+	--log-type Tail \
+	response.json | jq .LogResult -r | base64 -d && cat response.json | jq -r .result
+
+# TODO: avoid having the built zip file in the source directory
+clean:                ## Clean the build directory
+	rm -rf hello_world/hello_world_python.zip
+
+start:                ## Start LocalStack
+	IMAGE_NAME=localstack/localstack-pro \
+	LOCALSTACK_AUTH_TOKEN=${LOCALSTACK_AUTH_TOKEN} \
+	LOCALSTACK_LAMBDA_DEBUG_MODE=1 \
+	LOCALSTACK_LAMBDA_DEBUG_MODE_CONFIG_PATH=/tmp/lambda_debug_mode_config.yaml \
+	localstack start --detached --volume ${PWD}/lambda_debug_mode_config.yaml:/tmp/lambda_debug_mode_config.yaml
+
+stop:                 ## Stop LocalStack
+	localstack stop
+
+ready:                ## Wait until LocalStack is running
+	@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)
+
+test-ci:
+	make start install ready deploy wait invoke; return_code=`echo $$?`;\
+	echo "Interactive debugging not tested in CI"; exit $$return_code;

lambda-debugging-sam-python/README.md

@@ -0,0 +1,79 @@
+# Debug your Python Lambda Function
+
+This Hello World Lambda function written in Python demonstrates how to use interactive breakpoint-debugging using LocalStack [Lambda Remote Debugging](https://docs.localstack.cloud/aws/tooling/lambda-tools/remote-debugging/).
+LocalStack automatically configures debugging and adjusts relevant timeouts.
+
+We recommend the one-click setup using the AWS Toolkit for VS Code unless your advanced scenario requires Lambda Debug Mode (Preview).
+
+> [!NOTE]
+> Check out our blog post [Developing with LocalStack using the AWS Toolkit for VS Code](#TODO-update-link)
+
+## Prerequisites
+
+* [Docker](https://www.docker.com/)
+* [VS Code](https://code.visualstudio.com/)
+* [LocalStack Toolkit for VS Code](https://marketplace.visualstudio.com/items?itemName=localstack.localstack) ≥ 1.2 installs [LocalStack](https://docs.localstack.cloud/aws/getting-started/installation/) ≥ 4.8
+* [AWS Toolkit for VS Code](https://marketplace.visualstudio.com/items?itemName=AmazonWebServices.aws-toolkit-vscode) ≥ 3.74
+* `make`
+* [AWS CLI v2](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) or [AWS SAM CLI](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/install-sam-cli.html)
+
+## Starting Up
+
+1. Execute the VS Code command "LocalStack: Run Setup Wizard" using the LocalStack Toolkit
+2. Start LocalStack by clicking on the LocalStack Toolkit status bar
+
+## Deploying
+
+1. Run `make build`
+2. Run `make deploy`
+
+## Debugging
+
+1. Open the **Remote invoke configuration** in the AWS Toolkit
+    1. Open the AWS Toolkit extension
+    2. Expand the AWS Explorer and Lambda node
+    3. Navigate to the function you want to debug, then choose the Invoke remotely icon ▶️ from the context menu
+2. Select the **Remote debugging** check box to display the remote debugging properties
+3. Specify the Local Root Path to your local handler file.
+4. Set a breakpoint in your handler file by clicking in the gutter-margin
+5. Click the **Remote invoke** button to invoke the Lambda function
+
+## Lambda Debug Mode (Preview, Pro)
+
+### Starting Up
+
+1. Start LocalStack with the following configuration:
+
+    ```sh
+    LOCALSTACK_IMAGE_NAME=localstack/localstack-pro \
+    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
+    ```
+
+    * `IMAGE_NAME=localstack/localstack-pro` ensures the Pro image is started
+    * `LOCALSTACK_LAMBDA_DEBUG_MODE=1` adjusts timeouts
+    * `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 `8050`.
+    * `--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 configuration updates.
+
+### Deploying
+
+1. Run `make build` to build the Lambda ZIP package
+2. Run `make deploy` to deploy the Lambda function
+
+### Debugging
+
+1. Open the sample folder in VS Code to auto-detect `.vscode/launch.json`
+2. Set a breakpoint in the handler file `HelloWorldFunction/app.py` by clicking in the gutter-margin
+3. Open the **Run and Debug** view in VS Code
+4. Run the **Python: Remote Attach** task
+5. Run `make invoke` to invoke the Lambda function
+
+## Troubleshooting
+
+* Concurrent invokes are currently rejected with a `ResourceConflictException`.
+Upvote [this GitHub issue](https://github.com/localstack/localstack/issues/8522) if this affects you.
+
+## License
+
+The code in this sample is available under the Apache 2.0 license.