USE 86 - AWS SAM for local testing #326
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Why these changes are being introduced: Previously, local testing was performed by building a Docker container and issuing HTTP requests against the container that simulated an invocation (to be specific, this was not a true HTTP invocation of the lambda but instead a convenience wrapper in the Docker image to field "regular" invocations via HTTP requests). While functional, it does not provide a lot of the affordances and conveniences of AWS SAM, including: - explicit HTTP versus regular/direction invocation - handling of AWS credentials for the running container - simulation of resources Related, while the repository is named "timdex-pipeline-lambdas" plural, it effectively continues to be a single lambda. It is proposed that we consider keeping it as a single lambda, but explore introducing more structured business logic branching in the lambda entrypoint. It is anticipated that the pipeline lambda could be helpful for things beyond just CLI command formatting, at which time attention to entrypoint handling and how we test will get more important. How this addresses that need: Adds AWS SAM scaffolding to the repository, while also updating the README to guide users towards using this approach. The `ping.py` module was also removed, which was a placeholder for another distinct lambda definition. Side effects of this change: * Local testing is performed via AWS SAM, which is present in other more recent AWS Lambda repositories we manage. Relevant ticket(s): * https://mitlibraries.atlassian.net/browse/USE-86
ghukill
force-pushed
the
USE-86-sam-for-local-testing
branch
from
8af6346 to
923e6c8
Compare
Pull Request Test Coverage Report for Build 18508251000Details
💛 - Coveralls |
ehanson8
approved these changes
Oct 14, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose and background context
This PR updates the pipeline lambdas repository to use AWS SAM for local testing. As noted in the git commit, SAM provides some affordances that the AWS Lambda Docker image does not:
This change is inline with some other more recent lambda repositories like the APT tool and s3-bagit-validator.
Additionally, this PR tries to bring the documentation + code more inline with the current state of the pipeline lambda(s), where effectively we've always had one lambda and will likely continue that way for the foreseeable future. As such, some old code like
ping.pywas removed which was stubbing a distinct lambda handler.This work is setup for the "actual" work in USE-86.
How can a reviewer manually see the effects of these changes?
Follow the directions in the new README section, "Running Locally with AWS SAM".
The example command in the
Makefilesugggests how we could create example JSON input payloads for other functionality we want to test, either as a persisting fixture, or just ad-hoc during development.Includes new or updated dependencies?
YES: includes the current
pip-auditworkaroundChanges expectations for external applications?
NO
What are the relevant tickets?