Provides code defining a number of lambdas to be launched by AWS supporting a number of processes within the Digital Prison Reporting platform.
This project uses gradle which is bundled with the repository and also makes use of
- jacoco - for test coverage reports
This project makes use of the shadow jar plugin which takes care of creating a jar containing all dependencies.
The plugin adds the suffix -all
to the jar file name e.g.
digital-prison-reporting-lambdas-1.0-SNAPSHOT-all.jar
First, build the jar locally
./gradlew clean shadowJar
and then execute your lambda by specifying the fully qualified classname e.g.
java -cp ./build/libs/digital-prison-reporting-lambdas-1.0-SNAPSHOT-all.jar uk.gov.justice.digital.Placeholder
ensuring that your lambda class has a handleRequest method that can be executed.
Note - test coverage reports are enabled by default and after running the tests the report will be written to build/reports/jacoco/test/html
The unit tests use JUnit5 and Mockito where appropriate. Use the following to run the tests.
./gradlew clean test
./gradlew clean check
./gradlew clean integrationTest
./gradlew clean check
TBD
Please adhere to the following guidelines when making contributions to the project.
- Keep all code commentary and documentation up to date
- Use a JIRA ticket number where available
- Otherwise a short descriptive name is acceptable
- Prefix any commit messages with the JIRA ticket number where available
- Otherwise use the prefix
NOJIRA
- Reference or link any relevant JIRA tickets in the pull request notes
- At least one approval is required before a PR can be merged
- v1.0.0
- Modify the Dependabot file to suit the dependency manager you plan to use and for automated pull requests for package updates. Dependabot is enabled in the settings by default.
- Ensure as many of the GitHub Standards rules are maintained as possibly can.