Skip to content

Commit 557361a

Browse files
kameshsampathlance
kameshsampath
and
lance
authored
feat: add spring cloud function runtime and templates (#231)
* feat: add spring cloud function runtime and templates * docs: review updates * squash: apply suggestions from code review Co-authored-by: Lance Ball <lball@redhat.com>
1 parent e8b622e commit 557361a

32 files changed

+2093
-2
lines changed

‎buildpacks/builder.go

+6
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,24 @@ import (
1414
"github.com/boson-project/faas"
1515
)
1616

17+
//Builder holds the configuration that will be passed to
18+
//Buildpack builder
1719
type Builder struct {
1820
Verbose bool
1921
}
2022

23+
//NewBuilder builds the new Builder configuration
2124
func NewBuilder() *Builder {
2225
return &Builder{}
2326
}
2427

28+
//RuntimeToBuildpack holds the mapping between the Runtime and its corresponding
29+
//Buildpack builder to use
2530
var RuntimeToBuildpack = map[string]string{
2631
"quarkus": "quay.io/boson/faas-quarkus-builder",
2732
"node": "quay.io/boson/faas-nodejs-builder",
2833
"go": "quay.io/boson/faas-go-builder",
34+
"springboot": "quay.io/boson/faas-springboot-builder",
2935
}
3036

3137
// Build the Function at path.

‎cmd/create.go

+2-1
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,13 @@ import (
99

1010
"github.com/boson-project/faas"
1111
"github.com/boson-project/faas/prompt"
12+
"github.com/boson-project/faas/utils"
1213
)
1314

1415
func init() {
1516
root.AddCommand(createCmd)
1617
createCmd.Flags().BoolP("confirm", "c", false, "Prompt to confirm all configuration options (Env: $FUNC_CONFIRM)")
17-
createCmd.Flags().StringP("runtime", "l", faas.DefaultRuntime, "Function runtime language/framework. Available runtimes: 'node', 'quarkus' and 'go' (Env: $FUNC_RUNTIME)")
18+
createCmd.Flags().StringP("runtime", "l", faas.DefaultRuntime, "Function runtime language/framework. Available runtimes: " + utils.RuntimeList() + " (Env: $FUNC_RUNTIME)")
1819
createCmd.Flags().StringP("templates", "", filepath.Join(configPath(), "templates"), "Path to additional templates (Env: $FUNC_TEMPLATES)")
1920
createCmd.Flags().StringP("trigger", "t", faas.DefaultTrigger, "Function trigger. Available triggers: 'http' and 'events' (Env: $FUNC_TRIGGER)")
2021

‎pkged.go

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎templates/springboot/events/.builders.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
default: quay.io/boson/faas-springboot-builder

‎templates/springboot/events/.editorconfig

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
root = true
2+
3+
[*]
4+
indent_style = space
5+
indent_size = 2
6+
charset = utf-8
7+
trim_trailing_whitespace = false
8+
insert_final_newline = false

‎templates/springboot/events/.gitignore

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
HELP.md
2+
target/
3+
!.mvn/wrapper/maven-wrapper.jar
4+
!**/src/main/**/target/
5+
!**/src/test/**/target/
6+
7+
### STS ###
8+
.apt_generated
9+
.classpath
10+
.factorypath
11+
.project
12+
.settings
13+
.springBeans
14+
.sts4-cache
15+
16+
### IntelliJ IDEA ###
17+
.idea
18+
*.iws
19+
*.iml
20+
*.ipr
21+
22+
### NetBeans ###
23+
/nbproject/private/
24+
/nbbuild/
25+
/dist/
26+
/nbdist/
27+
/.nb-gradle/
28+
build/
29+
!**/src/main/**/build/
30+
!**/src/test/**/build/
31+
32+
### VS Code ###
33+
.vscode/

‎templates/springboot/events/.mvn/wrapper/MavenWrapperDownloader.java

+117
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
/*
2+
* Copyright 2007-present the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
import java.net.*;
17+
import java.io.*;
18+
import java.nio.channels.*;
19+
import java.util.Properties;
20+
21+
public class MavenWrapperDownloader {
22+
23+
private static final String WRAPPER_VERSION = "0.5.6";
24+
/**
25+
* Default URL to download the maven-wrapper.jar from, if no 'downloadUrl' is provided.
26+
*/
27+
private static final String DEFAULT_DOWNLOAD_URL = "https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/"
28+
+ WRAPPER_VERSION + "/maven-wrapper-" + WRAPPER_VERSION + ".jar";
29+
30+
/**
31+
* Path to the maven-wrapper.properties file, which might contain a downloadUrl property to
32+
* use instead of the default one.
33+
*/
34+
private static final String MAVEN_WRAPPER_PROPERTIES_PATH =
35+
".mvn/wrapper/maven-wrapper.properties";
36+
37+
/**
38+
* Path where the maven-wrapper.jar will be saved to.
39+
*/
40+
private static final String MAVEN_WRAPPER_JAR_PATH =
41+
".mvn/wrapper/maven-wrapper.jar";
42+
43+
/**
44+
* Name of the property which should be used to override the default download url for the wrapper.
45+
*/
46+
private static final String PROPERTY_NAME_WRAPPER_URL = "wrapperUrl";
47+
48+
public static void main(String args[]) {
49+
System.out.println("- Downloader started");
50+
File baseDirectory = new File(args[0]);
51+
System.out.println("- Using base directory: " + baseDirectory.getAbsolutePath());
52+
53+
// If the maven-wrapper.properties exists, read it and check if it contains a custom
54+
// wrapperUrl parameter.
55+
File mavenWrapperPropertyFile = new File(baseDirectory, MAVEN_WRAPPER_PROPERTIES_PATH);
56+
String url = DEFAULT_DOWNLOAD_URL;
57+
if(mavenWrapperPropertyFile.exists()) {
58+
FileInputStream mavenWrapperPropertyFileInputStream = null;
59+
try {
60+
mavenWrapperPropertyFileInputStream = new FileInputStream(mavenWrapperPropertyFile);
61+
Properties mavenWrapperProperties = new Properties();
62+
mavenWrapperProperties.load(mavenWrapperPropertyFileInputStream);
63+
url = mavenWrapperProperties.getProperty(PROPERTY_NAME_WRAPPER_URL, url);
64+
} catch (IOException e) {
65+
System.out.println("- ERROR loading '" + MAVEN_WRAPPER_PROPERTIES_PATH + "'");
66+
} finally {
67+
try {
68+
if(mavenWrapperPropertyFileInputStream != null) {
69+
mavenWrapperPropertyFileInputStream.close();
70+
}
71+
} catch (IOException e) {
72+
// Ignore ...
73+
}
74+
}
75+
}
76+
System.out.println("- Downloading from: " + url);
77+
78+
File outputFile = new File(baseDirectory.getAbsolutePath(), MAVEN_WRAPPER_JAR_PATH);
79+
if(!outputFile.getParentFile().exists()) {
80+
if(!outputFile.getParentFile().mkdirs()) {
81+
System.out.println(
82+
"- ERROR creating output directory '" + outputFile.getParentFile().getAbsolutePath() + "'");
83+
}
84+
}
85+
System.out.println("- Downloading to: " + outputFile.getAbsolutePath());
86+
try {
87+
downloadFileFromURL(url, outputFile);
88+
System.out.println("Done");
89+
System.exit(0);
90+
} catch (Throwable e) {
91+
System.out.println("- Error downloading");
92+
e.printStackTrace();
93+
System.exit(1);
94+
}
95+
}
96+
97+
private static void downloadFileFromURL(String urlString, File destination) throws Exception {
98+
if (System.getenv("MVNW_USERNAME") != null && System.getenv("MVNW_PASSWORD") != null) {
99+
String username = System.getenv("MVNW_USERNAME");
100+
char[] password = System.getenv("MVNW_PASSWORD").toCharArray();
101+
Authenticator.setDefault(new Authenticator() {
102+
@Override
103+
protected PasswordAuthentication getPasswordAuthentication() {
104+
return new PasswordAuthentication(username, password);
105+
}
106+
});
107+
}
108+
URL website = new URL(urlString);
109+
ReadableByteChannel rbc;
110+
rbc = Channels.newChannel(website.openStream());
111+
FileOutputStream fos = new FileOutputStream(destination);
112+
fos.getChannel().transferFrom(rbc, 0, Long.MAX_VALUE);
113+
fos.close();
114+
rbc.close();
115+
}
116+
117+
}

‎templates/springboot/events/.mvn/wrapper/maven-wrapper.jar

49.5 KB
Binary file not shown.

‎templates/springboot/events/.mvn/wrapper/maven-wrapper.properties

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.6.3/apache-maven-3.6.3-bin.zip
2+
wrapperUrl=https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar

‎templates/springboot/events/README.md

+107
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
# Function project
2+
3+
Welcome to your new Function project!
4+
5+
This sample project contains a single function based on Spring Cloud Function: `functions.CloudFunctionApplication.uppercase()`, which returns the uppercase of the data passed via CloudEvents.
6+
7+
## Local execution
8+
9+
Make sure that `Java 11 SDK` is installed.
10+
11+
To start server locally run `./mvnw spring-boot:run`.
12+
The command starts http server and automatically watches for changes of source code.
13+
If source code changes the change will be propagated to running server. It also opens debugging port `5005`
14+
so a debugger can be attached if needed.
15+
16+
To run tests locally run `./mvnw test`.
17+
18+
## The `func` CLI
19+
20+
It's recommended to set `FUNC_REGISTRY` environment variable.
21+
22+
```shell script
23+
# replace ~/.bashrc by your shell rc file
24+
# replace docker.io/johndoe with your registry
25+
export FUNC_REGISTRY=docker.io/johndoe
26+
echo "export FUNC_REGISTRY=docker.io/johndoe" >> ~/.bashrc
27+
```
28+
29+
### Building
30+
31+
This command builds an OCI image for the function.
32+
33+
```shell script
34+
func build -v # build jar
35+
```
36+
37+
### Running
38+
39+
This command runs the func locally in a container
40+
using the image created above.
41+
42+
```shell script
43+
func run
44+
```
45+
46+
### Deploying
47+
48+
This command will build and deploy the function into cluster.
49+
50+
```shell script
51+
func deploy -v # also triggers build
52+
```
53+
54+
## Function invocation
55+
56+
For the examples below, please be sure to set the `URL` variable to the route of your function.
57+
58+
You get the route by following command.
59+
60+
```shell script
61+
func describe
62+
```
63+
64+
Note the value of **Routes:** from the output, set `$URL` to its value.
65+
66+
__TIP__:
67+
68+
If you use `kn` then you can set the url by:
69+
70+
```shell script
71+
# kn service describe <function name> and show route url
72+
export URL=$(kn service describe $(basename $PWD) -ourl)
73+
```
74+
75+
### cURL
76+
77+
```shell script
78+
curl -v "$URL/uppercase" \
79+
-H "Content-Type:application/json" \
80+
-H "Ce-Id:1" \
81+
-H "Ce-Subject:Uppercase" \
82+
-H "Ce-Source:cloud-event-example" \
83+
-H "Ce-Type:dev.knative.example" \
84+
-H "Ce-Specversion:1.0" \
85+
-d "{\"input\": \"$(whoami)\"}\""
86+
```
87+
88+
### HTTPie
89+
90+
```shell script
91+
http -v "$URL/uppercase" \
92+
Content-Type:application/json \
93+
Ce-Id:1 \
94+
Ce-Subject:Uppercase \
95+
Ce-Source:cloud-event-example \
96+
Ce-Type:dev.knative.example \
97+
Ce-Specversion:1.0 \
98+
input=$(whoami)
99+
```
100+
101+
## Cleanup
102+
103+
To remove the deployed function from your cluster, run:
104+
105+
```shell
106+
func delete
107+
```

0 commit comments

Comments
 (0)