在使用aws sam本地调用docker容器时，pytest测试框架可能出现重复执行的情况。这通常是由于dockerfile中对entrypoint指令的误用造成的。aws lambda基础镜像已预设其运行时入口点，自定义entrypoint会与基础镜像冲突。通过移除dockerfile中自定义的entrypoint，并确保cmd正确指向lambda函数处理器，可以有效解决此问题，确保pytest只执行一次。
问题现象：Pytest在Docker容器中重复运行
当开发者在AWS SAM（Serverless Application Model）项目中使用Docker容器运行Lambda函数的Pytest测试时，可能会观察到测试套件被完整执行两次。例如，在使用sam build -t template_pytest.yaml && sam local invoke -e test_lambda.py命令进行本地调用时，控制台输出会显示两次完整的Pytest会话，每次都报告相同的测试结果，如下所示：
Invoking Container created from dockerpytestinteraction:latest Building image................. Using local image: dockerpytestinteraction:rapid-x86_64. START RequestId: b265e3b7-73c9-410d-a66c-c7e609fda97d Version: $LATEST ============================= test session starts ============================== platform linux -- Python 3.11.6, pytest-7.4.4, pluggy-1.3.0 rootdir: /var/task collected 1 item test_lambda.py . [100%] ============================== 1 passed in 0.03s =============================== 02 Jan 2024 22:08:48,347 [ERROR] (rapid) Init failed error=Runtime exited without providing a reason InvokeID= ============================= test session starts ============================== platform linux -- Python 3.11.6, pytest-7.4.4, pluggy-1.3.0 rootdir: /var/task collected 1 item test_lambda.py . [100%] ============================== 1 passed in 0.02s =============================== END RequestId: 22600007-3ac4-4b48-80a4-fe11d1592f4b REPORT RequestId: 22600007-3ac4-4b48-80a4-fe11d1592f4b Init Duration: 1.11 ms Duration: 1946.25 ms Billed Duration: 1947 ms Memory Size: 10240 MB Max Memory Used: 10240 MB
这种重复执行不仅浪费资源和时间，还可能导致测试报告混乱，影响开发效率。
理解Docker的ENTRYPOINT与CMD指令
要解决Pytest重复执行的问题，首先需要深入理解Docker的ENTRYPOINT和CMD指令在构建镜像时的作用，以及它们在AWS Lambda基础镜像中的特殊行为。
- ENTRYPOINT: 定义了容器启动时执行的命令或脚本。一旦设置，它将作为容器的主进程，并且通常不被覆盖。CMD指令中的内容会作为ENTRYPOINT的参数。
- CMD: 提供ENTRYPOINT的默认参数，或者在没有ENTRYPOINT时，作为容器启动时执行的默认命令。CMD可以被docker run命令后的参数轻易覆盖。
AWS Lambda的基础镜像（例如public.ecr.aws/lambda/python:3.11）已经预设了一个ENTRYPOINT，它负责启动Lambda运行时环境并监听调用事件。这个预设的ENTRYPOINT期望CMD指令提供Lambda函数的处理器路径（例如your_module.your_handler）。
Pytest重复执行的根本原因
Pytest在AWS Lambda Docker容器中重复执行的根本原因在于自定义Dockerfile中错误地设置了ENTRYPOINT指令。当你的Dockerfile包含类似ENTRYPOINT [ "python3.11", "-m", "pytest" ]这样的行时，会发生以下情况：
- 第一次执行: Docker容器启动时，它会首先执行你自定义的ENTRYPOINT，即python3.11 -m pytest。sam local invoke命令中的-e test_lambda.py参数会被传递给这个ENTRYPOINT，导致Pytest立即运行一次所有的测试。
- 第二次执行: 由于你的自定义ENTRYPOINT执行的是Pytest，而不是Lambda处理器，AWS Lambda运行时会报告初始化失败（如示例输出中的Init failed error=Runtime exited without providing a reason）。在某些情况下，Lambda运行时可能会尝试重新初始化或以其他方式触发容器的默认行为，这可能导致基础镜像的ENTRYPOINT结合一个不正确的CMD（如果CMD仍然指向pytest或被误解）再次执行Pytest。
简而言之，你自定义的ENTRYPOINT与AWS Lambda基础镜像的预期行为产生了冲突，导致了不必要的测试执行。
解决方案：优化Dockerfile配置
解决Pytest重复执行问题的关键在于移除自定义的ENTRYPOINT，并确保CMD指令正确指向Lambda函数的处理器。
以下是优化的Dockerfile配置步骤：
- 移除自定义ENTRYPOINT: 删除Dockerfile中所有设置ENTRYPOINT为pytest或任何测试运行器的行。AWS Lambda基础镜像已提供其自身的运行时ENTRYPOINT。
- 正确设置CMD: CMD指令应明确指定Lambda函数的处理器。例如，如果你的Lambda函数处理器在test_lambda.py文件中，名为handler，那么CMD应设置为[ "test_lambda.handler" ]。
- 将Pytest作为依赖安装: Pytest应该作为Python项目的开发依赖通过pip install安装，而不是作为容器的ENTRYPOINT。
示例：修正后的Dockerfile
以下是一个修正后的Dockerfile示例，它将确保Pytest只在容器构建和测试阶段（如果手动触发）运行，而不是在Lambda函数调用时重复运行：
FROM public.ecr.aws/lambda/python:3.11 # 复制 requirements.txt 文件 COPY requirements.txt ./ # 安装指定的Python包，包括pytest（如果包含在requirements.txt中） RUN python3.11 -m pip install -r requirements.txt # 如果pytest不在requirements.txt中，可以单独安装 # RUN python3.11 -m pip install pytest # 复制 Lambda 函数代码 COPY test_lambda.py ./ # 设置 CMD 为 Lambda 函数处理器 # 这是AWS Lambda运行时期望的入口点 CMD [ "test_lambda.handler" ]
Dockerfile解释：
- FROM public.ecr.aws/lambda/python:3.11: 使用AWS官方提供的Python 3.11 Lambda基础镜像。这个镜像已经包含了运行Lambda函数所需的ENTRYPOINT。
- COPY requirements.txt ./ 和 RUN python3.11 -m pip install -r requirements.txt: 将requirements.txt复制到容器中并安装所有依赖。如果pytest是你的测试依赖，它应该包含在这个文件中。
- COPY test_lambda.py ./: 复制你的Lambda函数代码到容器的工作目录。
- CMD [ "test_lambda.handler" ]: 这是最关键的更改。它将容器的默认命令设置为test_lambda.handler，即Lambda函数的处理器。当sam local invoke命令调用容器时，基础镜像的ENTRYPOINT会结合这个CMD来执行你的Lambda函数。
注意事项与最佳实践
- 分离职责: Dockerfile应专注于构建一个能够运行Lambda函数的生产环境镜像。测试运行器（如Pytest）应作为开发或CI/CD流程的一部分来执行，而不是作为容器的ENTRYPOINT。
- 理解基础镜像: 在使用任何基础镜像时，务必查阅其官方文档，了解其预设的ENTRYPOINT和CMD行为。AWS Lambda容器镜像的文档是一个很好的起点，例如 AWS Lambda Python Image Instructions。
-
本地测试与CI/CD: 在本地开发时，可以通过单独的命令（例如docker exec
python3.11 -m pytest或在CI/CD管道中）来运行测试，而不是依赖sam local invoke来隐式触发。sam local invoke的目的是测试Lambda函数的实际调用行为。
总结
Pytest在AWS Lambda Docker容器中重复执行的问题，本质上是由于Dockerfile中ENTRYPOINT指令与AWS Lambda基础镜像的运行时机制冲突所致。通过移除自定义的ENTRYPOINT，并确保CMD正确指向Lambda函数处理器，可以有效解决此问题。这种方法不仅保证了测试的正确执行，也符合Docker和AWS Lambda的最佳实践，即容器应专注于其主要职责——运行Lambda函数，而测试则应作为独立的步骤进行管理。
