Skip to content

Commit

Permalink
GH-1208 Update documentation and plugins for aws sample
Browse files Browse the repository at this point in the history
Resolves #1208
  • Loading branch information
olegz committed Dec 17, 2024
1 parent 90caa2e commit 637948a
Show file tree
Hide file tree
Showing 10 changed files with 72 additions and 27 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<parent>
<groupId>org.springframework.cloud.function.aws-lambda.packaging</groupId>
<artifactId>spring-cloud-function-aws-gradle-parent</artifactId>
<version>4.2.1-SNAPSHOT</version>
<version>1.0.0</version>
</parent>
<properties>
<main.basedir>${basedir}/../..</main.basedir>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<parent>
<groupId>org.springframework.cloud.function.aws-lambda.packaging</groupId>
<artifactId>spring-cloud-function-aws-gradle-parent</artifactId>
<version>4.2.1-SNAPSHOT</version>
<version>1.0.0</version>
</parent>

<properties>
Expand Down
38 changes: 38 additions & 0 deletions spring-cloud-function-samples/function-sample-aws/README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
This is a basic sample of executing function on AWS.

You can execute it locally or deploy it to the cloud - https://aws.amazon.com/pm/lambda/[AWS Lambda]


To run this app locally please ensure that you have https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/install-sam-cli.html[SAM] (Serverless Application Model) installed on your machine

----
> sam build
----

and then

----
sam local invoke UppercaseFunction --event input.json
----

The `input.json` file contains a simple quoted string `"hello"` which will be uppercased and you should see the following in the output

----
...
END RequestId: cd119d99-1325-4453-8456-97248dd12cc7
REPORT RequestId: cd119d99-1325-4453-8456-97248dd12cc7 Init Duration: 1.03 ms Duration: 17740.33 ms Billed Duration: 17741 ms Memory Size: 1024 MB Max Memory Used: 1024 MB
"HELLO"
...
----


To run this app in the cloud, make sure you have AWS Account

-----
> mvn clean install
-----

This will generate the `function-sample-aws-0.0.1-SNAPSHOT-aws.jar` in the `target` directory.

This is the file you will use to deploy following procedure described https://docs.spring.io/spring-cloud-function/reference/adapters/aws-intro.html[here]
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
plugins {
id 'org.springframework.cloud.function.aws-lambda.packaging' version '1.0.0'
//id 'java'
id 'org.springframework.boot' version '3.2.0-M2'
id 'org.springframework.boot' version '3.4.0'
//id 'io.spring.dependency-management' version '1.1.3'
//id 'com.github.johnrengelman.shadow' version '8.1.1'
//id 'maven-publish'
Expand All @@ -22,7 +22,7 @@ repositories {
}

ext {
set('springCloudVersion', "2023.0.0-M1")
set('springCloudVersion', "2024.0.1-SNAPSHOT")
}

//assemble.dependsOn = [thinJar, shadowJar]
Expand Down Expand Up @@ -68,7 +68,7 @@ ext {

dependencies {
implementation 'org.springframework.boot:spring-boot-starter'
implementation 'org.springframework.cloud:spring-cloud-function-adapter-aws:4.1.0-SNAPSHOT'
implementation 'org.springframework.cloud:spring-cloud-function-adapter-aws'
testImplementation 'org.springframework.boot:spring-boot-starter-test'
}

Expand Down
Binary file not shown.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-8.2.1-bin.zip
distributionUrl=https\://services.gradle.org/distributions/gradle-8.10-bin.zip
networkTimeout=10000
validateDistributionUrl=true
zipStoreBase=GRADLE_USER_HOME
Expand Down
22 changes: 13 additions & 9 deletions spring-cloud-function-samples/function-sample-aws/gradlew
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0
#

##############################################################################
#
Expand Down Expand Up @@ -55,7 +57,7 @@
# Darwin, MinGW, and NonStop.
#
# (3) This script is generated from the Groovy template
# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
# https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
# within the Gradle project.
#
# You can find Gradle at https://github.com/gradle/gradle/.
Expand Down Expand Up @@ -83,7 +85,9 @@ done
# This is normally unused
# shellcheck disable=SC2034
APP_BASE_NAME=${0##*/}
APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s
' "$PWD" ) || exit

# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD=maximum
Expand Down Expand Up @@ -144,15 +148,15 @@ if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
case $MAX_FD in #(
max*)
# In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
# shellcheck disable=SC3045
# shellcheck disable=SC2039,SC3045
MAX_FD=$( ulimit -H -n ) ||
warn "Could not query maximum file descriptor limit"
esac
case $MAX_FD in #(
'' | soft) :;; #(
*)
# In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
# shellcheck disable=SC3045
# shellcheck disable=SC2039,SC3045
ulimit -n "$MAX_FD" ||
warn "Could not set maximum file descriptor limit to $MAX_FD"
esac
Expand Down Expand Up @@ -201,11 +205,11 @@ fi
# 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"'

# Collect all arguments for the java command;
# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
# shell script including quotes and variable substitutions, so put them in
# double quotes to make sure that they get re-expanded; and
# * put everything else in single quotes, so that it's not re-expanded.
# Collect all arguments for the java command:
# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
# and any embedded shellness will be escaped.
# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
# treated as '${Hostname}' itself on the command line.

set -- \
"-Dorg.gradle.appname=$APP_BASE_NAME" \
Expand Down
22 changes: 12 additions & 10 deletions spring-cloud-function-samples/function-sample-aws/gradlew.bat
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
@rem See the License for the specific language governing permissions and
@rem limitations under the License.
@rem
@rem SPDX-License-Identifier: Apache-2.0
@rem

@if "%DEBUG%"=="" @echo off
@rem ##########################################################################
Expand Down Expand Up @@ -43,11 +45,11 @@ set JAVA_EXE=java.exe
%JAVA_EXE% -version >NUL 2>&1
if %ERRORLEVEL% equ 0 goto execute

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.
echo. 1>&2
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2
echo. 1>&2
echo Please set the JAVA_HOME variable in your environment to match the 1>&2
echo location of your Java installation. 1>&2

goto fail

Expand All @@ -57,11 +59,11 @@ set JAVA_EXE=%JAVA_HOME%/bin/java.exe

if exist "%JAVA_EXE%" goto execute

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.
echo. 1>&2
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2
echo. 1>&2
echo Please set the JAVA_HOME variable in your environment to match the 1>&2
echo location of your Java installation. 1>&2

goto fail

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
"hello"
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Globals:
EndpointConfiguration: REGIONAL

Resources:
PetStoreMVC:
UppercaseFunction:
Type: AWS::Serverless::Function
Properties:
# AutoPublishAlias: bcn
Expand All @@ -32,7 +32,7 @@ Resources:
PayloadFormatVersion: '1.0'

Outputs:
PetStoreMVCApi:
UppercaseFunctionApi:
Description: URL for application
Value: !Sub 'https://${ServerlessHttpApi}.execute-api.${AWS::Region}.amazonaws.com/uppercase'
Export:
Expand Down

0 comments on commit 637948a

Please sign in to comment.