Skip to content

Commit 637948a

Browse files
olegzolegz
committed
GH-1208 Update documentation and plugins for aws sample
Resolves #1208
1 parent 90caa2e commit 637948a

File tree

10 files changed

+72
-27
lines changed

10 files changed

+72
-27
lines changed

‎spring-cloud-function-adapters/spring-cloud-function-aws-gradle-parent/org.springframework.cloud.function.aws-lambda.packaging.gradle.plugin/pom.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
<parent>
1111
<groupId>org.springframework.cloud.function.aws-lambda.packaging</groupId>
1212
<artifactId>spring-cloud-function-aws-gradle-parent</artifactId>
13-
<version>4.2.1-SNAPSHOT</version>
13+
<version>1.0.0</version>
1414
</parent>
1515
<properties>
1616
<main.basedir>${basedir}/../..</main.basedir>

‎spring-cloud-function-adapters/spring-cloud-function-aws-gradle-parent/spring-cloud-function-aws-packaging-gradle-plugin/pom.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
<parent>
1414
<groupId>org.springframework.cloud.function.aws-lambda.packaging</groupId>
1515
<artifactId>spring-cloud-function-aws-gradle-parent</artifactId>
16-
<version>4.2.1-SNAPSHOT</version>
16+
<version>1.0.0</version>
1717
</parent>
1818

1919
<properties>

‎spring-cloud-function-samples/function-sample-aws/README.adoc

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
This is a basic sample of executing function on AWS.
2+
3+
You can execute it locally or deploy it to the cloud - https://aws.amazon.com/pm/lambda/[AWS Lambda]
4+
5+
6+
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
7+
8+
----
9+
> sam build
10+
----
11+
12+
and then
13+
14+
----
15+
sam local invoke UppercaseFunction --event input.json
16+
----
17+
18+
The `input.json` file contains a simple quoted string `"hello"` which will be uppercased and you should see the following in the output
19+
20+
----
21+
...
22+
END RequestId: cd119d99-1325-4453-8456-97248dd12cc7
23+
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
24+
"HELLO"
25+
...
26+
----
27+
28+
29+
To run this app in the cloud, make sure you have AWS Account
30+
31+
-----
32+
33+
> mvn clean install
34+
-----
35+
36+
This will generate the `function-sample-aws-0.0.1-SNAPSHOT-aws.jar` in the `target` directory.
37+
38+
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]

‎spring-cloud-function-samples/function-sample-aws/build.gradle

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
plugins {
22
id 'org.springframework.cloud.function.aws-lambda.packaging' version '1.0.0'
33
//id 'java'
4-
id 'org.springframework.boot' version '3.2.0-M2'
4+
id 'org.springframework.boot' version '3.4.0'
55
//id 'io.spring.dependency-management' version '1.1.3'
66
//id 'com.github.johnrengelman.shadow' version '8.1.1'
77
//id 'maven-publish'
@@ -22,7 +22,7 @@ repositories {
2222
}
2323

2424
ext {
25-
set('springCloudVersion', "2023.0.0-M1")
25+
set('springCloudVersion', "2024.0.1-SNAPSHOT")
2626
}
2727

2828
//assemble.dependsOn = [thinJar, shadowJar]
@@ -68,7 +68,7 @@ ext {
6868

6969
dependencies {
7070
implementation 'org.springframework.boot:spring-boot-starter'
71-
implementation 'org.springframework.cloud:spring-cloud-function-adapter-aws:4.1.0-SNAPSHOT'
71+
implementation 'org.springframework.cloud:spring-cloud-function-adapter-aws'
7272
testImplementation 'org.springframework.boot:spring-boot-starter-test'
7373
}
7474

‎spring-cloud-function-samples/function-sample-aws/gradle/wrapper/gradle-wrapper.jar

-19.3 KB
Binary file not shown.

‎spring-cloud-function-samples/function-sample-aws/gradle/wrapper/gradle-wrapper.properties

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
distributionBase=GRADLE_USER_HOME
22
distributionPath=wrapper/dists
3-
distributionUrl=https\://services.gradle.org/distributions/gradle-8.2.1-bin.zip
3+
distributionUrl=https\://services.gradle.org/distributions/gradle-8.10-bin.zip
44
networkTimeout=10000
55
validateDistributionUrl=true
66
zipStoreBase=GRADLE_USER_HOME

‎spring-cloud-function-samples/function-sample-aws/gradlew

+13-9
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@
1515
# See the License for the specific language governing permissions and
1616
# limitations under the License.
1717
#
18+
# SPDX-License-Identifier: Apache-2.0
19+
#
1820

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

8892
# Use the maximum available, or set MAX_FD != -1 to use that value.
8993
MAX_FD=maximum
@@ -144,15 +148,15 @@ if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
144148
case $MAX_FD in #(
145149
max*)
146150
# In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
147-
# shellcheck disable=SC3045
151+
# shellcheck disable=SC2039,SC3045
148152
MAX_FD=$( ulimit -H -n ) ||
149153
warn "Could not query maximum file descriptor limit"
150154
esac
151155
case $MAX_FD in #(
152156
'' | soft) :;; #(
153157
*)
154158
# In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
155-
# shellcheck disable=SC3045
159+
# shellcheck disable=SC2039,SC3045
156160
ulimit -n "$MAX_FD" ||
157161
warn "Could not set maximum file descriptor limit to $MAX_FD"
158162
esac
@@ -201,11 +205,11 @@ fi
201205
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
202206
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
203207

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

210214
set -- \
211215
"-Dorg.gradle.appname=$APP_BASE_NAME" \

‎spring-cloud-function-samples/function-sample-aws/gradlew.bat

+12-10
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@
1313
@rem See the License for the specific language governing permissions and
1414
@rem limitations under the License.
1515
@rem
16+
@rem SPDX-License-Identifier: Apache-2.0
17+
@rem
1618

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

46-
echo.
47-
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
48-
echo.
49-
echo Please set the JAVA_HOME variable in your environment to match the
50-
echo location of your Java installation.
48+
echo. 1>&2
49+
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2
50+
echo. 1>&2
51+
echo Please set the JAVA_HOME variable in your environment to match the 1>&2
52+
echo location of your Java installation. 1>&2
5153

5254
goto fail
5355

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

5860
if exist "%JAVA_EXE%" goto execute
5961

60-
echo.
61-
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
62-
echo.
63-
echo Please set the JAVA_HOME variable in your environment to match the
64-
echo location of your Java installation.
62+
echo. 1>&2
63+
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2
64+
echo. 1>&2
65+
echo Please set the JAVA_HOME variable in your environment to match the 1>&2
66+
echo location of your Java installation. 1>&2
6567

6668
goto fail
6769

‎spring-cloud-function-samples/function-sample-aws/input.json

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
"hello"

‎spring-cloud-function-samples/function-sample-aws/template.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Globals:
88
EndpointConfiguration: REGIONAL
99

1010
Resources:
11-
PetStoreMVC:
11+
UppercaseFunction:
1212
Type: AWS::Serverless::Function
1313
Properties:
1414
# AutoPublishAlias: bcn
@@ -32,7 +32,7 @@ Resources:
3232
PayloadFormatVersion: '1.0'
3333

3434
Outputs:
35-
PetStoreMVCApi:
35+
UppercaseFunctionApi:
3636
Description: URL for application
3737
Value: !Sub 'https://${ServerlessHttpApi}.execute-api.${AWS::Region}.amazonaws.com/uppercase'
3838
Export:

0 commit comments

Comments
 (0)