diff --git a/README.adoc b/README.adoc index 139cdf601..468b7c954 100644 --- a/README.adoc +++ b/README.adoc @@ -9,185 +9,31 @@ Edit the files in the src/main/asciidoc/ directory instead. image::https://travis-ci.org/spring-cloud/spring-cloud-function.svg?branch={branch}[Build Status, link=https://travis-ci.org/spring-cloud/spring-cloud-function] -== Introduction - -Spring Cloud Function is a project with the following high-level goals: - -* Promote the implementation of business logic via functions. -* Decouple the development lifecycle of business logic from any specific runtime target so that the same code can run as a web endpoint, a stream processor, or a task. -* Support a uniform programming model across serverless providers, as well as the ability to run standalone (locally or in a PaaS). -* Enable Spring Boot features (auto-configuration, dependency injection, metrics) on serverless providers. - -It abstracts away all of the transport details and -infrastructure, allowing the developer to keep all the familiar tools -and processes, and focus firmly on business logic. - -Here's a complete, executable, testable Spring Boot application -(implementing a simple string manipulation): - -[source,java] ----- -@SpringBootApplication -public class Application { - - @Bean - public Function uppercase() { - return value -> value.toUpperCase(); - } - - public static void main(String[] args) { - SpringApplication.run(Application.class, args); - } -} ----- - -It's just a Spring Boot application, so it can be built, run and -tested, locally and in a CI build, the same way as any other Spring -Boot application. The `Function` is from `java.util` and `Flux` is a -https://www.reactive-streams.org/[Reactive Streams] `Publisher` from -https://projectreactor.io/[Project Reactor]. The function can be -accessed over HTTP or messaging. - -Spring Cloud Function has the following features: - -* _Choice of programming styles - reactive, imperative or hybrid._ -* _Function composition and adaptation (e.g., composing imperative functions with reactive)._ -* _Support for reactive function with multiple inputs and outputs allowing merging, joining and other complex streaming operation to be handled by functions._ -* _Transparent type conversion of inputs and outputs._ -* _Packaging functions for deployments, specific to the target platform (e.g., Project Riff, AWS Lambda and more)_ -* _Adapters to expose function to the outside world as HTTP endpoints etc._ -* _Deploying a JAR file containing such an application context with an isolated classloader, so that you can pack them together in a single JVM._ -* _Adapters for https://github.com/spring-cloud/spring-cloud-function/tree/master/spring-cloud-function-adapters/spring-cloud-function-adapter-aws[AWS Lambda], https://github.com/spring-cloud/spring-cloud-function/tree/master/spring-cloud-function-adapters/spring-cloud-function-adapter-azure[Azure], https://github.com/spring-cloud/spring-cloud-function/tree/master/spring-cloud-function-adapters/spring-cloud-function-adapter-gcp[Google Cloud Functions], and possibly other "serverless" service providers._ - -== Getting Started - -Build from the command line (and "install" the samples): - ----- -$ ./mvnw clean install ----- - -(If you like to YOLO add `-DskipTests`.) - -Run one of the samples, e.g. - ----- -$ java -jar spring-cloud-function-samples/function-sample/target/*.jar ----- - -This runs the app and exposes its functions over HTTP, so you can -convert a string to uppercase, like this: - ----- -$ curl -H "Content-Type: text/plain" localhost:8080/uppercase -d Hello -HELLO ----- - -You can convert multiple strings (a `Flux`) by separating them -with new lines - ----- -$ curl -H "Content-Type: text/plain" localhost:8080/uppercase -d 'Hello -> World' -HELLOWORLD ----- - -(You can use `^Q^J` in a terminal to insert a new line in a literal -string like that.) - -== Building - -:jdkversion: 17 - -=== Basic Compile and Test - -To build the source you will need to install JDK {jdkversion}. - -Spring Cloud uses Maven for most build-related activities, and you -should be able to get off the ground quite quickly by cloning the -project you are interested in and typing - ----- -$ ./mvnw install ----- - -NOTE: You can also install Maven (>=3.3.3) yourself and run the `mvn` command -in place of `./mvnw` in the examples below. If you do that you also -might need to add `-P spring` if your local Maven settings do not -contain repository declarations for spring pre-release artifacts. - -NOTE: Be aware that you might need to increase the amount of memory -available to Maven by setting a `MAVEN_OPTS` environment variable with -a value like `-Xmx512m -XX:MaxPermSize=128m`. We try to cover this in -the `.mvn` configuration, so if you find you have to do it to make a -build succeed, please raise a ticket to get the settings added to -source control. - -The projects that require middleware (i.e. Redis) for testing generally -require that a local instance of [Docker](https://www.docker.com/get-started) is installed and running. +[[introduction]] += Introduction +:page-section-summary-toc: 1 -=== Documentation - -The spring-cloud-build module has a "docs" profile, and if you switch -that on it will try to build asciidoc sources from -`src/main/asciidoc`. As part of that process it will look for a -`README.adoc` and process it by loading all the includes, but not -parsing or rendering it, just copying it to `${main.basedir}` -(defaults to `${basedir}`, i.e. the root of the project). If there are -any changes in the README it will then show up after a Maven build as -a modified file in the correct place. Just commit it and push the change. - -=== Working with the code -If you don't have an IDE preference we would recommend that you use -https://www.springsource.com/developer/sts[Spring Tools Suite] or -https://eclipse.org[Eclipse] when working with the code. We use the -https://eclipse.org/m2e/[m2eclipse] eclipse plugin for maven support. Other IDEs and tools -should also work without issue as long as they use Maven 3.3.3 or better. - -==== Activate the Spring Maven profile -Spring Cloud projects require the 'spring' Maven profile to be activated to resolve -the spring milestone and snapshot repositories. Use your preferred IDE to set this -profile to be active, or you may experience build errors. - -==== Importing into eclipse with m2eclipse -We recommend the https://eclipse.org/m2e/[m2eclipse] eclipse plugin when working with -eclipse. If you don't already have m2eclipse installed it is available from the "eclipse -marketplace". - -NOTE: Older versions of m2e do not support Maven 3.3, so once the -projects are imported into Eclipse you will also need to tell -m2eclipse to use the right profile for the projects. If you -see many different errors related to the POMs in the projects, check -that you have an up to date installation. If you can't upgrade m2e, -add the "spring" profile to your `settings.xml`. Alternatively you can -copy the repository settings from the "spring" profile of the parent -pom into your `settings.xml`. - -==== Importing into eclipse without m2eclipse -If you prefer not to use m2eclipse you can generate eclipse project metadata using the -following command: - -[indent=0] ----- - $ ./mvnw eclipse:eclipse ----- - -The generated eclipse projects can be imported by selecting `import existing projects` -from the `file` menu. +[[getting-started]] += Getting Started +:page-section-summary-toc: 1 -== Contributing +[[building]] += Building +:page-section-summary-toc: 1 -:spring-cloud-build-branch: master +:spring-cloud-build-branch: main Spring Cloud is released under the non-restrictive Apache 2.0 license, and follows a very standard Github development process, using Github -tracker for issues and merging pull requests into master. If you want +tracker for issues and merging pull requests into main. If you want to contribute even something trivial please do not hesitate, but follow the guidelines below. -=== Sign the Contributor License Agreement +[[sign-the-contributor-license-agreement]] +== Sign the Contributor License Agreement + Before we accept a non-trivial patch or pull request we will need you to sign the https://cla.pivotal.io/sign/spring[Contributor License Agreement]. Signing the contributor's agreement does not grant anyone commit rights to the main @@ -195,19 +41,21 @@ repository, but it does mean that we can accept your contributions, and you will author credit if we do. Active contributors might be asked to join the core team, and given the ability to merge pull requests. -=== Code of Conduct -This project adheres to the Contributor Covenant https://github.com/spring-cloud/spring-cloud-build/blob/master/docs/src/main/asciidoc/code-of-conduct.adoc[code of +[[code-of-conduct]] +== Code of Conduct +This project adheres to the Contributor Covenant https://github.com/spring-cloud/spring-cloud-build/blob/main/docs/src/main/asciidoc/code-of-conduct.adoc[code of conduct]. By participating, you are expected to uphold this code. Please report unacceptable behavior to spring-code-of-conduct@pivotal.io. -=== Code Conventions and Housekeeping +[[code-conventions-and-housekeeping]] +== Code Conventions and Housekeeping None of these is essential for a pull request, but they will all help. They can also be added after the original pull request but before a merge. * Use the Spring Framework code format conventions. If you use Eclipse you can import formatter settings using the `eclipse-code-formatter.xml` file from the - https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-dependencies-parent/eclipse-code-formatter.xml[Spring + https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/spring-cloud-dependencies-parent/eclipse-code-formatter.xml[Spring Cloud Build] project. If using IntelliJ, you can use the https://plugins.jetbrains.com/plugin/6546[Eclipse Code Formatter Plugin] to import the same file. @@ -220,13 +68,14 @@ added after the original pull request but before a merge. than cosmetic changes). * Add some Javadocs and, if you change the namespace, some XSD doc elements. * A few unit tests would help a lot as well -- someone has to do it. -* If no-one else is using your branch, please rebase it against the current master (or +* If no-one else is using your branch, please rebase it against the current main (or other target branch in the main project). * When writing a commit message please follow https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html[these conventions], if you are fixing an existing issue please add `Fixes gh-XXXX` at the end of the commit message (where XXXX is the issue number). -=== Checkstyle +[[checkstyle]] +== Checkstyle Spring Cloud Build comes with a set of checkstyle rules. You can find them in the `spring-cloud-build-tools` module. The most notable files under the module are: @@ -244,7 +93,8 @@ Spring Cloud Build comes with a set of checkstyle rules. You can find them in th <2> File header setup <3> Default suppression rules -==== Checkstyle configuration +[[checkstyle-configuration]] +=== Checkstyle configuration Checkstyle rules are *disabled by default*. To add checkstyle to your project just define the following properties and plugins. @@ -303,16 +153,18 @@ If you need to suppress some rules (e.g. line length needs to be longer), then i It's advisable to copy the `${spring-cloud-build.rootFolder}/.editorconfig` and `${spring-cloud-build.rootFolder}/.springformat` to your project. That way, some default formatting rules will be applied. You can do so by running this script: ```bash -$ curl https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/.editorconfig -o .editorconfig +$ curl https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/.editorconfig -o .editorconfig $ touch .springformat ``` -=== IDE setup +[[ide-setup]] +== IDE setup -==== Intellij IDEA +[[intellij-idea]] +=== Intellij IDEA In order to setup Intellij you should import our coding conventions, inspection profiles and set up the checkstyle plugin. -The following files can be found in the https://github.com/spring-cloud/spring-cloud-build/tree/master/spring-cloud-build-tools[Spring Cloud Build] project. +The following files can be found in the https://github.com/spring-cloud/spring-cloud-build/tree/main/spring-cloud-build-tools[Spring Cloud Build] project. .spring-cloud-build-tools/ ---- @@ -335,13 +187,13 @@ The following files can be found in the https://github.com/spring-cloud/spring-c .Code style -image::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/{spring-cloud-build-branch}/docs/src/main/asciidoc/images/intellij-code-style.png[Code style] +image::intellij-code-style.png[Code style] Go to `File` -> `Settings` -> `Editor` -> `Code style`. There click on the icon next to the `Scheme` section. There, click on the `Import Scheme` value and pick the `Intellij IDEA code style XML` option. Import the `spring-cloud-build-tools/src/main/resources/intellij/Intellij_Spring_Boot_Java_Conventions.xml` file. .Inspection profiles -image::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/{spring-cloud-build-branch}/docs/src/main/asciidoc/images/intellij-inspections.png[Code style] +image::intellij-inspections.png[Code style] Go to `File` -> `Settings` -> `Editor` -> `Inspections`. There click on the icon next to the `Profile` section. There, click on the `Import Profile` and import the `spring-cloud-build-tools/src/main/resources/intellij/Intellij_Project_Defaults.xml` file. @@ -349,21 +201,268 @@ Go to `File` -> `Settings` -> `Editor` -> `Inspections`. There click on the icon To have Intellij work with Checkstyle, you have to install the `Checkstyle` plugin. It's advisable to also install the `Assertions2Assertj` to automatically convert the JUnit assertions -image::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/{spring-cloud-build-branch}/docs/src/main/asciidoc/images/intellij-checkstyle.png[Checkstyle] +image::intellij-checkstyle.png[Checkstyle] -Go to `File` -> `Settings` -> `Other settings` -> `Checkstyle`. There click on the `+` icon in the `Configuration file` section. There, you'll have to define where the checkstyle rules should be picked from. In the image above, we've picked the rules from the cloned Spring Cloud Build repository. However, you can point to the Spring Cloud Build's GitHub repository (e.g. for the `checkstyle.xml` : `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/main/resources/checkstyle.xml`). We need to provide the following variables: +Go to `File` -> `Settings` -> `Other settings` -> `Checkstyle`. There click on the `+` icon in the `Configuration file` section. There, you'll have to define where the checkstyle rules should be picked from. In the image above, we've picked the rules from the cloned Spring Cloud Build repository. However, you can point to the Spring Cloud Build's GitHub repository (e.g. for the `checkstyle.xml` : `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/spring-cloud-build-tools/src/main/resources/checkstyle.xml`). We need to provide the following variables: -- `checkstyle.header.file` - please point it to the Spring Cloud Build's, `spring-cloud-build-tools/src/main/resources/checkstyle-header.txt` file either in your cloned repo or via the `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/main/resources/checkstyle-header.txt` URL. -- `checkstyle.suppressions.file` - default suppressions. Please point it to the Spring Cloud Build's, `spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml` file either in your cloned repo or via the `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml` URL. +- `checkstyle.header.file` - please point it to the Spring Cloud Build's, `spring-cloud-build-tools/src/main/resources/checkstyle-header.txt` file either in your cloned repo or via the `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/spring-cloud-build-tools/src/main/resources/checkstyle-header.txt` URL. +- `checkstyle.suppressions.file` - default suppressions. Please point it to the Spring Cloud Build's, `spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml` file either in your cloned repo or via the `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml` URL. - `checkstyle.additional.suppressions.file` - this variable corresponds to suppressions in your local project. E.g. you're working on `spring-cloud-contract`. Then point to the `project-root/src/checkstyle/checkstyle-suppressions.xml` folder. Example for `spring-cloud-contract` would be: `/home/username/spring-cloud-contract/src/checkstyle/checkstyle-suppressions.xml`. IMPORTANT: Remember to set the `Scan Scope` to `All sources` since we apply checkstyle rules for production and test sources. -=== Duplicate Finder +[[duplicate-finder]] +== Duplicate Finder Spring Cloud Build brings along the `basepom:duplicate-finder-maven-plugin`, that enables flagging duplicate and conflicting classes and resources on the java classpath. -==== Duplicate Finder configuration +[[duplicate-finder-configuration]] +=== Duplicate Finder configuration + +Duplicate finder is *enabled by default* and will run in the `verify` phase of your Maven build, but it will only take effect in your project if you add the `duplicate-finder-maven-plugin` to the `build` section of the projecst's `pom.xml`. + +.pom.xml +[source,xml] +---- + + + + org.basepom.maven + duplicate-finder-maven-plugin + + + +---- + +For other properties, we have set defaults as listed in the https://github.com/basepom/duplicate-finder-maven-plugin/wiki[plugin documentation]. + +You can easily override them but setting the value of the selected property prefixed with `duplicate-finder-maven-plugin`. For example, set `duplicate-finder-maven-plugin.skip` to `true` in order to skip duplicates check in your build. + +If you need to add `ignoredClassPatterns` or `ignoredResourcePatterns` to your setup, make sure to add them in the plugin configuration section of your project: + +[source,xml] +---- + + + + org.basepom.maven + duplicate-finder-maven-plugin + + + org.joda.time.base.BaseDateTime + .*module-info + + + changelog.txt + + + + + + + +---- + + +[[contributing]] += Contributing +:page-section-summary-toc: 1 + +:spring-cloud-build-branch: main + +Spring Cloud is released under the non-restrictive Apache 2.0 license, +and follows a very standard Github development process, using Github +tracker for issues and merging pull requests into main. If you want +to contribute even something trivial please do not hesitate, but +follow the guidelines below. + +[[sign-the-contributor-license-agreement]] +== Sign the Contributor License Agreement + +Before we accept a non-trivial patch or pull request we will need you to sign the +https://cla.pivotal.io/sign/spring[Contributor License Agreement]. +Signing the contributor's agreement does not grant anyone commit rights to the main +repository, but it does mean that we can accept your contributions, and you will get an +author credit if we do. Active contributors might be asked to join the core team, and +given the ability to merge pull requests. + +[[code-of-conduct]] +== Code of Conduct +This project adheres to the Contributor Covenant https://github.com/spring-cloud/spring-cloud-build/blob/main/docs/src/main/asciidoc/code-of-conduct.adoc[code of +conduct]. By participating, you are expected to uphold this code. Please report +unacceptable behavior to spring-code-of-conduct@pivotal.io. + +[[code-conventions-and-housekeeping]] +== Code Conventions and Housekeeping +None of these is essential for a pull request, but they will all help. They can also be +added after the original pull request but before a merge. + +* Use the Spring Framework code format conventions. If you use Eclipse + you can import formatter settings using the + `eclipse-code-formatter.xml` file from the + https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/spring-cloud-dependencies-parent/eclipse-code-formatter.xml[Spring + Cloud Build] project. If using IntelliJ, you can use the + https://plugins.jetbrains.com/plugin/6546[Eclipse Code Formatter + Plugin] to import the same file. +* Make sure all new `.java` files to have a simple Javadoc class comment with at least an + `@author` tag identifying you, and preferably at least a paragraph on what the class is + for. +* Add the ASF license header comment to all new `.java` files (copy from existing files + in the project) +* Add yourself as an `@author` to the .java files that you modify substantially (more + than cosmetic changes). +* Add some Javadocs and, if you change the namespace, some XSD doc elements. +* A few unit tests would help a lot as well -- someone has to do it. +* If no-one else is using your branch, please rebase it against the current main (or + other target branch in the main project). +* When writing a commit message please follow https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html[these conventions], + if you are fixing an existing issue please add `Fixes gh-XXXX` at the end of the commit + message (where XXXX is the issue number). + +[[checkstyle]] +== Checkstyle + +Spring Cloud Build comes with a set of checkstyle rules. You can find them in the `spring-cloud-build-tools` module. The most notable files under the module are: + +.spring-cloud-build-tools/ +---- +└── src +    ├── checkstyle +    │   └── checkstyle-suppressions.xml <3> +    └── main +    └── resources +    ├── checkstyle-header.txt <2> +    └── checkstyle.xml <1> +---- +<1> Default Checkstyle rules +<2> File header setup +<3> Default suppression rules + +[[checkstyle-configuration]] +=== Checkstyle configuration + +Checkstyle rules are *disabled by default*. To add checkstyle to your project just define the following properties and plugins. + +.pom.xml +---- + +true <1> + true + <2> + true + <3> + + + + + <4> + io.spring.javaformat + spring-javaformat-maven-plugin + + <5> + org.apache.maven.plugins + maven-checkstyle-plugin + + + + + + <5> + org.apache.maven.plugins + maven-checkstyle-plugin + + + + +---- +<1> Fails the build upon Checkstyle errors +<2> Fails the build upon Checkstyle violations +<3> Checkstyle analyzes also the test sources +<4> Add the Spring Java Format plugin that will reformat your code to pass most of the Checkstyle formatting rules +<5> Add checkstyle plugin to your build and reporting phases + +If you need to suppress some rules (e.g. line length needs to be longer), then it's enough for you to define a file under `${project.root}/src/checkstyle/checkstyle-suppressions.xml` with your suppressions. Example: + +.projectRoot/src/checkstyle/checkstyle-suppresions.xml +---- + + + + + + +---- + +It's advisable to copy the `${spring-cloud-build.rootFolder}/.editorconfig` and `${spring-cloud-build.rootFolder}/.springformat` to your project. That way, some default formatting rules will be applied. You can do so by running this script: + +```bash +$ curl https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/.editorconfig -o .editorconfig +$ touch .springformat +``` + +[[ide-setup]] +== IDE setup + +[[intellij-idea]] +=== Intellij IDEA + +In order to setup Intellij you should import our coding conventions, inspection profiles and set up the checkstyle plugin. +The following files can be found in the https://github.com/spring-cloud/spring-cloud-build/tree/main/spring-cloud-build-tools[Spring Cloud Build] project. + +.spring-cloud-build-tools/ +---- +└── src +    ├── checkstyle +    │   └── checkstyle-suppressions.xml <3> +    └── main +    └── resources +    ├── checkstyle-header.txt <2> +    ├── checkstyle.xml <1> +    └── intellij +       ├── Intellij_Project_Defaults.xml <4> +       └── Intellij_Spring_Boot_Java_Conventions.xml <5> +---- +<1> Default Checkstyle rules +<2> File header setup +<3> Default suppression rules +<4> Project defaults for Intellij that apply most of Checkstyle rules +<5> Project style conventions for Intellij that apply most of Checkstyle rules + +.Code style + +image::intellij-code-style.png[Code style] + +Go to `File` -> `Settings` -> `Editor` -> `Code style`. There click on the icon next to the `Scheme` section. There, click on the `Import Scheme` value and pick the `Intellij IDEA code style XML` option. Import the `spring-cloud-build-tools/src/main/resources/intellij/Intellij_Spring_Boot_Java_Conventions.xml` file. + +.Inspection profiles + +image::intellij-inspections.png[Code style] + +Go to `File` -> `Settings` -> `Editor` -> `Inspections`. There click on the icon next to the `Profile` section. There, click on the `Import Profile` and import the `spring-cloud-build-tools/src/main/resources/intellij/Intellij_Project_Defaults.xml` file. + +.Checkstyle + +To have Intellij work with Checkstyle, you have to install the `Checkstyle` plugin. It's advisable to also install the `Assertions2Assertj` to automatically convert the JUnit assertions + +image::intellij-checkstyle.png[Checkstyle] + +Go to `File` -> `Settings` -> `Other settings` -> `Checkstyle`. There click on the `+` icon in the `Configuration file` section. There, you'll have to define where the checkstyle rules should be picked from. In the image above, we've picked the rules from the cloned Spring Cloud Build repository. However, you can point to the Spring Cloud Build's GitHub repository (e.g. for the `checkstyle.xml` : `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/spring-cloud-build-tools/src/main/resources/checkstyle.xml`). We need to provide the following variables: + +- `checkstyle.header.file` - please point it to the Spring Cloud Build's, `spring-cloud-build-tools/src/main/resources/checkstyle-header.txt` file either in your cloned repo or via the `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/spring-cloud-build-tools/src/main/resources/checkstyle-header.txt` URL. +- `checkstyle.suppressions.file` - default suppressions. Please point it to the Spring Cloud Build's, `spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml` file either in your cloned repo or via the `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml` URL. +- `checkstyle.additional.suppressions.file` - this variable corresponds to suppressions in your local project. E.g. you're working on `spring-cloud-contract`. Then point to the `project-root/src/checkstyle/checkstyle-suppressions.xml` folder. Example for `spring-cloud-contract` would be: `/home/username/spring-cloud-contract/src/checkstyle/checkstyle-suppressions.xml`. + +IMPORTANT: Remember to set the `Scan Scope` to `All sources` since we apply checkstyle rules for production and test sources. + +[[duplicate-finder]] +== Duplicate Finder + +Spring Cloud Build brings along the `basepom:duplicate-finder-maven-plugin`, that enables flagging duplicate and conflicting classes and resources on the java classpath. + +[[duplicate-finder-configuration]] +=== Duplicate Finder configuration Duplicate finder is *enabled by default* and will run in the `verify` phase of your Maven build, but it will only take effect in your project if you add the `duplicate-finder-maven-plugin` to the `build` section of the projecst's `pom.xml`. diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc index 7c8cc81e8..66c23274e 100644 --- a/docs/modules/ROOT/nav.adoc +++ b/docs/modules/ROOT/nav.adoc @@ -9,7 +9,7 @@ *** xref:adapters/aws-intro.adoc[] *** xref:adapters/azure-intro.adoc[] *** xref:adapters/gcp-intro.adoc[] -** xref:spring-cloud-function/apendix.adoc[] +** xref:spring-cloud-function/appendix.adoc[] *** https://github.com/spring-cloud/spring-cloud-function/tree/main/spring-cloud-function-samples/function-sample-cloudevent[Cloud Events support] *** https://github.com/spring-cloud/spring-cloud-function/tree/main/spring-cloud-function-rsocket[RSocket support] *** xref:spring-integration.adoc[Spring Integration] \ No newline at end of file diff --git a/docs/modules/ROOT/pages/adapters/aws-intro.adoc b/docs/modules/ROOT/pages/adapters/aws-intro.adoc index d7ac472b0..68f8e4ff6 100644 --- a/docs/modules/ROOT/pages/adapters/aws-intro.adoc +++ b/docs/modules/ROOT/pages/adapters/aws-intro.adoc @@ -259,7 +259,7 @@ You can use the Spring Boot Maven Plugin to generate the <>. ---- You can find the entire sample `pom.xml` file for deploying Spring Cloud Function -applications to AWS Lambda with Maven https://github.com/spring-cloud/spring-cloud-function/blob/{branch}/spring-cloud-function-samples/function-sample-aws/pom.xml[here]. +applications to AWS Lambda with Maven https://github.com/spring-cloud/spring-cloud-function/tree/main/spring-cloud-function-samples/function-sample-aws/pom.xml[here]. [[gradle]] === Gradle @@ -328,4 +328,4 @@ assemble.dependsOn = [thinJar] ---- You can find the entire sample `build.gradle` file for deploying Spring Cloud Function -applications to AWS Lambda with Gradle https://github.com/spring-cloud/spring-cloud-function/blob/{branch}/spring-cloud-function-samples/function-sample-aws/build.gradle[here]. +applications to AWS Lambda with Gradle https://github.com/spring-cloud/spring-cloud-function/tree/main/spring-cloud-function-samples/function-sample-aws/build.gradle[here]. diff --git a/docs/modules/ROOT/pages/adapters/azure-intro.adoc b/docs/modules/ROOT/pages/adapters/azure-intro.adoc index 6621c44ac..b44e77336 100644 --- a/docs/modules/ROOT/pages/adapters/azure-intro.adoc +++ b/docs/modules/ROOT/pages/adapters/azure-intro.adoc @@ -202,6 +202,7 @@ Plugins are used to set the platform, runtime and app-settings properties like t ====== Maven:: + + [source,xml,indent=0,subs="verbatim,attributes",role="primary"] ---- @@ -243,6 +244,7 @@ Maven:: Gradle:: + + [source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] ---- plugins { @@ -312,6 +314,7 @@ You can use the Maven `start-class` property or set the `Main-Class` attribute o ====== Maven:: + + [source,xml,indent=0,subs="verbatim,attributes",role="primary"] ---- @@ -322,6 +325,7 @@ Maven:: Gradle:: + + [source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] ---- jar { @@ -372,7 +376,7 @@ Here is a list of various Spring Cloud Function Azure Adapter samples you can ex - https://github.com/spring-cloud/spring-cloud-function/tree/main/spring-cloud-function-samples/function-sample-azure-kafka-trigger[ Kafka Trigger & Output Binding (Maven)]. [[azure.web.adapter]] -= Azure Web Adapter +== Azure Web Adapter For, pure, Web-based function applications, you can replace the generic `adapter-azure` with the specialized https://github.com/spring-cloud/spring-cloud-function/tree/main/spring-cloud-function-adapters/spring-cloud-function-adapter-azure-web[spring-cloud-function-adapter-azure-web]. The Azure Web Adapter can deploy any Spring Web application as a native Azure function, using the HttpTrigger internally. @@ -414,7 +418,7 @@ For further information, explore the following, Azure Web Adapter, sample: - https://github.com/spring-cloud/spring-cloud-function/tree/main/spring-cloud-function-samples/function-sample-azure-web[ Azure Web Adapter (Maven)]. [[azure.usage]] -= Usage +== Usage Common instructions for building and deploying both, `Azure Adapter` and `Azure Web Adapter` type of applications. @@ -485,6 +489,7 @@ Maven:: Gradle:: + + [source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] ---- ./gradlew azureFunctionsDeploy @@ -500,6 +505,7 @@ Run the function in debug mode. ====== Maven:: + + [source,xml,indent=0,subs="verbatim,attributes",role="primary"] ---- ./mvnw azure-functions:run -DenableDebug @@ -507,6 +513,7 @@ Maven:: Gradle:: + + [source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] ---- // If you want to debug your functions, please add the following line @@ -551,14 +558,14 @@ Here is snippet for a `VSCode` remote debugging configuration: ---- [[functioninvoker-deprecated]] -= FunctionInvoker (deprecated) +== FunctionInvoker (deprecated) WARNING: The legacy `FunctionInvoker` programming model is deprecated and will not be supported going forward. For additional documentation and samples about the Function Integration approach follow the https://github.com/spring-cloud/spring-cloud-function/tree/main/spring-cloud-function-samples/function-sample-azure/[azure-sample] README and code. [[relevant-links]] -= Relevant Links +== Relevant Links - https://learn.microsoft.com/en-us/azure/developer/java/spring-framework/getting-started-with-spring-cloud-function-in-azure[Spring Cloud Function in Azure] - https://spring.io/blog/2023/02/24/spring-cloud-function-for-azure-function[Spring Cloud Function for Azure Function (blog)] diff --git a/docs/modules/ROOT/pages/adapters/gcp-intro.adoc b/docs/modules/ROOT/pages/adapters/gcp-intro.adoc index 747d26490..04480c856 100644 --- a/docs/modules/ROOT/pages/adapters/gcp-intro.adoc +++ b/docs/modules/ROOT/pages/adapters/gcp-intro.adoc @@ -5,7 +5,7 @@ The Google Cloud Functions adapter enables Spring Cloud Function apps to run on You can either run the function locally using the open source https://github.com/GoogleCloudPlatform/functions-framework-java[Google Functions Framework for Java] or on GCP. [[project-dependencies]] -=== Project Dependencies +== Project Dependencies Start by adding the `spring-cloud-function-adapter-gcp` dependency to your project. @@ -63,12 +63,12 @@ NOTE: The function target should always be set to `org.springframework.cloud.fun A full example of a working `pom.xml` can be found in the https://github.com/spring-cloud/spring-cloud-function/blob/master/spring-cloud-function-samples/function-sample-gcp-http/pom.xml[Spring Cloud Functions GCP sample]. [[http-functions]] -=== HTTP Functions +== HTTP Functions Google Cloud Functions supports deploying https://cloud.google.com/functions/docs/writing/http[HTTP Functions], which are functions that are invoked by HTTP request. The sections below describe instructions for deploying a Spring Cloud Function as an HTTP Function. [[getting-started]] -=== Getting Started +== Getting Started Let’s start with a simple Spring Cloud Function example: @@ -108,8 +108,8 @@ Invoke the HTTP function: curl http://localhost:8080/ -d "hello" ---- -[[deploy-to-gcp]] -=== Deploy to GCP + +== Buikd & Deploy to GCP Start by packaging your application. @@ -171,8 +171,8 @@ The `spring-cloud-function-adapter-gcp` allows for functions to be deployed as b The sections below describe the process for writing a Cloud Pub/Sub topic background function. However, there are a number of different event types that can trigger a background function to execute which are not discussed here; these are described in the https://cloud.google.com/functions/docs/calling[Background Function triggers documentation]. -[[getting-started]] -=== Getting Started + +== GCP Getting Started Let’s start with a simple Spring Cloud Function which will run as a GCF background function: @@ -265,7 +265,7 @@ curl localhost:8080 -H "Content-Type: application/json" -d '{"data":"hello"}' Verify that the function was invoked by viewing the logs. [[deploy-to-gcp]] -=== Deploy to GCP +== Deploy to GCP In order to deploy your background function to GCP, first package your application. diff --git a/docs/modules/ROOT/pages/functional.adoc b/docs/modules/ROOT/pages/functional.adoc index 385ff5b97..65d3a85be 100644 --- a/docs/modules/ROOT/pages/functional.adoc +++ b/docs/modules/ROOT/pages/functional.adoc @@ -7,7 +7,9 @@ Spring Cloud Function supports a "functional" style of bean declarations for sma Here's a vanilla Spring Cloud Function application from with the familiar `@Configuration` and `@Bean` declaration style: -```java +[source,json] +---- + @SpringBootApplication public class DemoApplication { @@ -21,12 +23,13 @@ public class DemoApplication { } } -``` +---- Now for the functional beans: the user application code can be recast into "functional" form, like this: -```java +[source,json] +---- @SpringBootConfiguration public class DemoApplication implements ApplicationContextInitializer { @@ -46,7 +49,7 @@ public class DemoApplication implements ApplicationContextInitializer { @@ -85,7 +89,7 @@ public class DemoApplication implements Function { } } -``` +---- It would also work if you add a separate, standalone class of type `Function` and register it with the `SpringApplication` using an alternative form of the `run()` method. The main thing is that the generic @@ -276,7 +280,6 @@ And to help with correct dependencies here is the excerpt from POM org.springframework.boot spring-boot-starter-parent - {spring-boot-version} . . . . diff --git a/docs/modules/ROOT/pages/spring-cloud-function/apendix.adoc b/docs/modules/ROOT/pages/spring-cloud-function/appendix.adoc similarity index 82% rename from docs/modules/ROOT/pages/spring-cloud-function/apendix.adoc rename to docs/modules/ROOT/pages/spring-cloud-function/appendix.adoc index 45efa8bb0..889d776f5 100644 --- a/docs/modules/ROOT/pages/spring-cloud-function/apendix.adoc +++ b/docs/modules/ROOT/pages/spring-cloud-function/appendix.adoc @@ -1,5 +1,5 @@ -[[apendix]] -= Apendix +[[appendix]] += Appendix :page-section-summary-toc: 1 Relevant Links: diff --git a/docs/modules/ROOT/pages/spring-cloud-function/serverless-platform-adapters.adoc b/docs/modules/ROOT/pages/spring-cloud-function/serverless-platform-adapters.adoc index 840626796..39a2fb10b 100644 --- a/docs/modules/ROOT/pages/spring-cloud-function/serverless-platform-adapters.adoc +++ b/docs/modules/ROOT/pages/spring-cloud-function/serverless-platform-adapters.adoc @@ -5,5 +5,5 @@ As well as being able to run as standalone process, Spring Cloud Function application can be adapted to run one of the existing serverless platforms. In the project there are adapters for -https://github.com/spring-cloud/spring-cloud-function/tree/{branch}/spring-cloud-function-adapters/spring-cloud-function-adapter-aws[AWS -Lambda], and https://github.com/spring-cloud/spring-cloud-function/tree/{branch}/spring-cloud-function-adapters/spring-cloud-function-adapter-azure[Azure]. +https://github.com/spring-cloud/spring-cloud-function/tree/main/spring-cloud-function-adapters/spring-cloud-function-adapter-aws[AWS +Lambda], and https://github.com/spring-cloud/spring-cloud-function/tree/main/spring-cloud-function-adapters/spring-cloud-function-adapter-azure[Azure]. diff --git a/docs/modules/ROOT/pages/spring-cloud-function/standalone-web-applications.adoc b/docs/modules/ROOT/pages/spring-cloud-function/standalone-web-applications.adoc index 442989230..583877d19 100644 --- a/docs/modules/ROOT/pages/spring-cloud-function/standalone-web-applications.adoc +++ b/docs/modules/ROOT/pages/spring-cloud-function/standalone-web-applications.adoc @@ -21,13 +21,13 @@ It is primarily to accommodate _stateless serverless patterns_ where you simply |=== | Method | Path | Request | Response | Status -| GET | /{supplier} | - | Items from the named supplier | 200 OK -| POST | /{consumer} | JSON object or text | Mirrors input and pushes request body into consumer | 202 Accepted -| PUT | /{consumer} | JSON object or text | Mirrors input and pushes request body into consumer | 202 Accepted -| DELETE | /{consumer} | JSON object or text | - | 204 NO CONTENT -| POST | /{function} | JSON object or text | The result of applying the named function | 200 OK -| PUT | /{function} | JSON object or text | The result of applying the named function | 200 OK -| GET | /{function}/{item} | - | Convert the item into an object and return the result of applying the function | 200 OK +| GET | /\{supplier} | - | Items from the named supplier | 200 OK +| POST | /\{consumer} | JSON object or text | Mirrors input and pushes request body into consumer | 202 Accepted +| PUT | /\{consumer} | JSON object or text | Mirrors input and pushes request body into consumer | 202 Accepted +| DELETE | /\{consumer} | JSON object or text | - | 204 NO CONTENT +| POST | /\{function} | JSON object or text | The result of applying the named function | 200 OK +| PUT | /\{function} | JSON object or text | The result of applying the named function | 200 OK +| GET | /\{function}/\{item} | - | Convert the item into an object and return the result of applying the function | 200 OK |=== @@ -42,8 +42,8 @@ When POSTing text the response format might be different with Spring Boot 2.0 an See <> to see the details and example on how to test such application. [[http-request-parameters]] -=== HTTP Request Parameters -As you have noticed from the previous table, you can pass an argument to a function as path variable (i.e., `/{function}/{item}`). +== HTTP Request Parameters +As you have noticed from the previous table, you can pass an argument to a function as path variable (i.e., `/\{function}/\{item}`). For example, `http://localhost:8080/uppercase/foo` will result in calling `uppercase` function with its input parameter being `foo`. While this is the recommended approach and the one that fits most use cases cases, there are times when you have to deal with HTTP request parameters (e.g., `http://localhost:8080/uppercase/foo?name=Bill`)