diff --git a/.gitignore b/.gitignore index 0755a9b56..20f4c17fa 100644 --- a/.gitignore +++ b/.gitignore @@ -5,6 +5,7 @@ # Package Files # *.jar +!example/HelloWorldFunction/gradle/wrapper/gradle-wrapper.jar *.war *.ear @@ -99,3 +100,7 @@ docs/public /example/.aws-sam/ /example/HelloWorldFunction/.aws-sam/ samconfig.toml +example/HelloWorldFunction/.gradle +example/HelloWorldFunction/build +/example/.gradle/ +/example/.java-version diff --git a/README.md b/README.md index 5ad18b96b..50ec77be2 100644 --- a/README.md +++ b/README.md @@ -78,7 +78,7 @@ And configure the aspectj-maven-plugin to compile-time weave (CTW) the aws-lambd ## Example -See **[example](./example/README.md)** of all features, and a SAM template with all Powertools env vars. +See **[example](./example/README.md)** for maven or gradle configurations including all features, and a SAM template with all Powertools env vars. ## Credits diff --git a/docs/content/index.mdx b/docs/content/index.mdx index dd7006151..b9095b85b 100644 --- a/docs/content/index.mdx +++ b/docs/content/index.mdx @@ -75,6 +75,28 @@ And configure the aspectj-maven-plugin to compile-time weave (CTW) the aws-lambd ``` **Note:** If you are working with lambda function on runtime post java8, please refer [issue](https://github.com/awslabs/aws-lambda-powertools-java/issues/50) for workaround +* [gradle](https://gradle.org): +```groovy +plugins{ + id 'java' + id 'aspectj.AspectjGradlePlugin' version '0.0.3' +} +repositories { + jcenter() +} +dependencies { + implementation 'software.amazon.lambda:powertools-tracing:0.5.0-beta' + aspectpath 'software.amazon.lambda:powertools-tracing:0.5.0-beta' + implementation 'software.amazon.lambda:powertools-logging:0.5.0-beta' + aspectpath 'software.amazon.lambda:powertools-logging:0.5.0-beta' + implementation 'software.amazon.lambda:powertools-metrics:0.5.0-beta' + aspectpath 'software.amazon.lambda:powertools-metrics:0.5.0-beta' +} +``` + +**Note:** Please add `aspectjVersion = '1.9.6'` to the `gradle.properties` file. The aspectj plugin works at the moment with gradle 5.x only. +Please refer to [open issue](https://github.com/awslabs/aws-lambda-powertools-java/issues/146) for more details. + ## Environment variables **Environment variables** used across suite of utilities. diff --git a/example/HelloWorldFunction/build.gradle b/example/HelloWorldFunction/build.gradle new file mode 100644 index 000000000..2cdc39e27 --- /dev/null +++ b/example/HelloWorldFunction/build.gradle @@ -0,0 +1,33 @@ +plugins{ + id 'java' + id 'aspectj.AspectjGradlePlugin' version '0.0.3' +} + +repositories { + jcenter() +} + +dependencies { + implementation 'software.amazon.lambda:powertools-tracing:0.5.0-beta' + aspectpath 'software.amazon.lambda:powertools-tracing:0.5.0-beta' + + implementation 'software.amazon.lambda:powertools-logging:0.5.0-beta' + aspectpath 'software.amazon.lambda:powertools-logging:0.5.0-beta' + + implementation 'software.amazon.lambda:powertools-metrics:0.5.0-beta' + aspectpath 'software.amazon.lambda:powertools-metrics:0.5.0-beta' + + implementation 'software.amazon.lambda:powertools-sqs:0.5.0-beta' + aspectpath 'software.amazon.lambda:powertools-sqs:0.5.0-beta' + + implementation 'software.amazon.lambda:powertools-parameters:0.5.0-beta' + aspectpath 'software.amazon.lambda:powertools-parameters:0.5.0-beta' + + implementation 'com.amazonaws:aws-lambda-java-core:1.2.0' + implementation 'com.amazonaws:aws-lambda-java-events:3.1.0' + + implementation 'org.apache.logging.log4j:log4j-api:2.13.3' + implementation 'org.apache.logging.log4j:log4j-core:2.13.3' + + testImplementation 'junit:junit:4.12' +} \ No newline at end of file diff --git a/example/HelloWorldFunction/gradle.properties b/example/HelloWorldFunction/gradle.properties new file mode 100644 index 000000000..c84ec451a --- /dev/null +++ b/example/HelloWorldFunction/gradle.properties @@ -0,0 +1 @@ +aspectjVersion=1.9.6 \ No newline at end of file diff --git a/example/HelloWorldFunction/gradle/wrapper/gradle-wrapper.jar b/example/HelloWorldFunction/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 000000000..62d4c0535 Binary files /dev/null and b/example/HelloWorldFunction/gradle/wrapper/gradle-wrapper.jar differ diff --git a/example/HelloWorldFunction/gradle/wrapper/gradle-wrapper.properties b/example/HelloWorldFunction/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 000000000..5028f28f8 --- /dev/null +++ b/example/HelloWorldFunction/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-5.6.4-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/example/HelloWorldFunction/gradlew b/example/HelloWorldFunction/gradlew new file mode 100644 index 000000000..3a163de71 --- /dev/null +++ b/example/HelloWorldFunction/gradlew @@ -0,0 +1,185 @@ +#!/usr/bin/env sh + +# +# Copyright 2015 the original author or authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >/dev/null +APP_HOME="`pwd -P`" +cd "$SAVED" >/dev/null + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn () { + echo "$*" +} + +die () { + echo + echo "$*" + echo + exit 1 +} + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "`uname`" in + CYGWIN* ) + cygwin=true + ;; + Darwin* ) + darwin=true + ;; + MINGW* ) + msys=true + ;; + NONSTOP* ) + nonstop=true + ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD="java" + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin or MSYS, switch paths to Windows format before running java +if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + + JAVACMD=`cygpath --unix "$JAVACMD"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=`expr $i + 1` + done + case $i in + 0) set -- ;; + 1) set -- "$args0" ;; + 2) set -- "$args0" "$args1" ;; + 3) set -- "$args0" "$args1" "$args2" ;; + 4) set -- "$args0" "$args1" "$args2" "$args3" ;; + 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Escape application args +save () { + for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done + echo " " +} +APP_ARGS=`save "$@"` + +# Collect all arguments for the java command, following the shell quoting and substitution rules +eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" + +exec "$JAVACMD" "$@" \ No newline at end of file diff --git a/example/HelloWorldFunction/gradlew.bat b/example/HelloWorldFunction/gradlew.bat new file mode 100644 index 000000000..9b30e1557 --- /dev/null +++ b/example/HelloWorldFunction/gradlew.bat @@ -0,0 +1,104 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto init + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto init + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:init +@rem Get command-line arguments, handling Windows variants + +if not "%OS%" == "Windows_NT" goto win9xME_args + +:win9xME_args +@rem Slurp the command line arguments. +set CMD_LINE_ARGS= +set _SKIP=2 + +:win9xME_args_slurp +if "x%~1" == "x" goto execute + +set CMD_LINE_ARGS=%* + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega \ No newline at end of file diff --git a/example/HelloWorldFunction/settings.gradle b/example/HelloWorldFunction/settings.gradle new file mode 100644 index 000000000..94df0a3e5 --- /dev/null +++ b/example/HelloWorldFunction/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'HelloWorldFunction' diff --git a/example/README.md b/example/README.md index e5300c6e7..b52eda8d4 100644 --- a/example/README.md +++ b/example/README.md @@ -1,4 +1,4 @@ -# sam-app +# example This project contains source code and supporting files for a serverless application that you can deploy with the SAM CLI. It includes the following files and folders. @@ -25,7 +25,8 @@ To use the SAM CLI, you need the following tools. * SAM CLI - [Install the SAM CLI](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html) * Java8 - [Install the Java SE Development Kit 8](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) -* Maven - [Install Maven](https://maven.apache.org/install.html) +* Maven - [Install Maven](https://maven.apache.org/install.html) or +* Gradle - [Install Maven](https://maven.apache.org/install.html) * Docker - [Install Docker community edition](https://hub.docker.com/search/?type=edition&offering=community) To build and deploy your application for the first time, run the following in your shell: @@ -50,24 +51,24 @@ You can find your API Gateway Endpoint URL in the output values displayed after Build your application with the `sam build` command. ```bash -sam-app$ sam build +example$ sam build ``` -The SAM CLI installs dependencies defined in `HelloWorldFunction/pom.xml`, creates a deployment package, and saves it in the `.aws-sam/build` folder. +The SAM CLI installs dependencies defined in `HelloWorldFunction/build.gradle`, creates a deployment package, and saves it in the `.aws-sam/build` folder. Test a single function by invoking it directly with a test event. An event is a JSON document that represents the input that the function receives from the event source. Test events are included in the `events` folder in this project. Run functions locally and invoke them with the `sam local invoke` command. ```bash -sam-app$ sam local invoke HelloWorldFunction --event events/event.json +example$ sam local invoke HelloWorldFunction --event events/event.json ``` The SAM CLI can also emulate your application's API. Use the `sam local start-api` to run the API locally on port 3000. ```bash -sam-app$ sam local start-api -sam-app$ curl http://localhost:3000/ +example$ sam local start-api +example$ curl http://localhost:3000/ ``` The SAM CLI reads the application template to determine the API's routes and the functions that they invoke. The `Events` property on each function's definition includes the route and method for each path. @@ -91,7 +92,7 @@ To simplify troubleshooting, SAM CLI has a command called `sam logs`. `sam logs` `NOTE`: This command works for all AWS Lambda functions; not just the ones you deploy using SAM. ```bash -sam-app$ sam logs -n HelloWorldFunction --stack-name sam-app --tail +example$ sam logs -n HelloWorldFunction --stack-name sam-app --tail ``` You can find more information and examples about filtering Lambda function logs in the [SAM CLI Documentation](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-logging.html). @@ -101,8 +102,8 @@ You can find more information and examples about filtering Lambda function logs Tests are defined in the `HelloWorldFunction/src/test` folder in this project. ```bash -sam-app$ cd HelloWorldFunction -HelloWorldFunction$ mvn test +example$ cd HelloWorldFunction +HelloWorldFunction$ gradle test ``` ## Cleanup @@ -110,7 +111,7 @@ HelloWorldFunction$ mvn test To delete the sample application that you created, use the AWS CLI. Assuming you used your project name for the stack name, you can run the following: ```bash -aws cloudformation delete-stack --stack-name sam-app +aws cloudformation delete-stack --stack-name example ``` ## Resources