From 941f22ebb0cb8f2f51190c2c1a85ca63387fc713 Mon Sep 17 00:00:00 2001 From: azerr Date: Wed, 30 Aug 2023 13:39:01 +0200 Subject: [PATCH] feat: Support Reactive Routes Fixes #1114 Signed-off-by: azerr --- .../maven/quarkus-route/.dockerignore | 5 + .../projects/maven/quarkus-route/.gitignore | 43 +++ .../quarkus-route/.mvn/wrapper/.gitignore | 1 + .../.mvn/wrapper/MavenWrapperDownloader.java | 98 ++++++ .../.mvn/wrapper/maven-wrapper.properties | 18 + .../projects/maven/quarkus-route/README.md | 52 +++ .../quarkus/projects/maven/quarkus-route/mvnw | 308 ++++++++++++++++++ .../projects/maven/quarkus-route/mvnw.cmd | 205 ++++++++++++ .../projects/maven/quarkus-route/pom.xml | 116 +++++++ .../src/main/docker/Dockerfile.jvm | 97 ++++++ .../src/main/docker/Dockerfile.legacy-jar | 93 ++++++ .../src/main/docker/Dockerfile.native | 27 ++ .../src/main/docker/Dockerfile.native-micro | 30 ++ .../acme/reactive/routes/MultipleRoutes.java | 14 + .../reactive/routes/MyDeclarativeRoutes.java | 34 ++ .../acme/reactive/routes/SimpleRoutes.java | 14 + .../src/main/resources/application.properties | 0 .../psi/core/utils/AnnotationUtils.java | 24 ++ .../jaxrs/java/DefaultJaxRsInfoProvider.java | 4 +- .../route/java/ReactiveRouteConstants.java | 30 ++ .../ReactiveRouteImplicitUsageProvider.java | 57 ++++ .../java/ReactiveRouteJaxRsInfoProvider.java | 159 +++++++++ .../route/java/ReactiveRouteUtils.java | 86 +++++ .../resources/META-INF/lsp4ij-quarkus.xml | 2 + src/main/resources/META-INF/plugin.xml | 2 + 25 files changed, 1517 insertions(+), 2 deletions(-) create mode 100644 projects/quarkus/projects/maven/quarkus-route/.dockerignore create mode 100644 projects/quarkus/projects/maven/quarkus-route/.gitignore create mode 100644 projects/quarkus/projects/maven/quarkus-route/.mvn/wrapper/.gitignore create mode 100644 projects/quarkus/projects/maven/quarkus-route/.mvn/wrapper/MavenWrapperDownloader.java create mode 100644 projects/quarkus/projects/maven/quarkus-route/.mvn/wrapper/maven-wrapper.properties create mode 100644 projects/quarkus/projects/maven/quarkus-route/README.md create mode 100644 projects/quarkus/projects/maven/quarkus-route/mvnw create mode 100644 projects/quarkus/projects/maven/quarkus-route/mvnw.cmd create mode 100644 projects/quarkus/projects/maven/quarkus-route/pom.xml create mode 100644 projects/quarkus/projects/maven/quarkus-route/src/main/docker/Dockerfile.jvm create mode 100644 projects/quarkus/projects/maven/quarkus-route/src/main/docker/Dockerfile.legacy-jar create mode 100644 projects/quarkus/projects/maven/quarkus-route/src/main/docker/Dockerfile.native create mode 100644 projects/quarkus/projects/maven/quarkus-route/src/main/docker/Dockerfile.native-micro create mode 100644 projects/quarkus/projects/maven/quarkus-route/src/main/java/org/acme/reactive/routes/MultipleRoutes.java create mode 100644 projects/quarkus/projects/maven/quarkus-route/src/main/java/org/acme/reactive/routes/MyDeclarativeRoutes.java create mode 100644 projects/quarkus/projects/maven/quarkus-route/src/main/java/org/acme/reactive/routes/SimpleRoutes.java create mode 100644 projects/quarkus/projects/maven/quarkus-route/src/main/resources/application.properties create mode 100644 src/main/java/com/redhat/microprofile/psi/internal/quarkus/route/java/ReactiveRouteConstants.java create mode 100644 src/main/java/com/redhat/microprofile/psi/internal/quarkus/route/java/ReactiveRouteImplicitUsageProvider.java create mode 100644 src/main/java/com/redhat/microprofile/psi/internal/quarkus/route/java/ReactiveRouteJaxRsInfoProvider.java create mode 100644 src/main/java/com/redhat/microprofile/psi/internal/quarkus/route/java/ReactiveRouteUtils.java diff --git a/projects/quarkus/projects/maven/quarkus-route/.dockerignore b/projects/quarkus/projects/maven/quarkus-route/.dockerignore new file mode 100644 index 000000000..94810d006 --- /dev/null +++ b/projects/quarkus/projects/maven/quarkus-route/.dockerignore @@ -0,0 +1,5 @@ +* +!target/*-runner +!target/*-runner.jar +!target/lib/* +!target/quarkus-app/* \ No newline at end of file diff --git a/projects/quarkus/projects/maven/quarkus-route/.gitignore b/projects/quarkus/projects/maven/quarkus-route/.gitignore new file mode 100644 index 000000000..8c7863e7b --- /dev/null +++ b/projects/quarkus/projects/maven/quarkus-route/.gitignore @@ -0,0 +1,43 @@ +#Maven +target/ +pom.xml.tag +pom.xml.releaseBackup +pom.xml.versionsBackup +release.properties +.flattened-pom.xml + +# Eclipse +.project +.classpath +.settings/ +bin/ + +# IntelliJ +.idea +*.ipr +*.iml +*.iws + +# NetBeans +nb-configuration.xml + +# Visual Studio Code +.vscode +.factorypath + +# OSX +.DS_Store + +# Vim +*.swp +*.swo + +# patch +*.orig +*.rej + +# Local environment +.env + +# Plugin directory +/.quarkus/cli/plugins/ diff --git a/projects/quarkus/projects/maven/quarkus-route/.mvn/wrapper/.gitignore b/projects/quarkus/projects/maven/quarkus-route/.mvn/wrapper/.gitignore new file mode 100644 index 000000000..e72f5e8b7 --- /dev/null +++ b/projects/quarkus/projects/maven/quarkus-route/.mvn/wrapper/.gitignore @@ -0,0 +1 @@ +maven-wrapper.jar diff --git a/projects/quarkus/projects/maven/quarkus-route/.mvn/wrapper/MavenWrapperDownloader.java b/projects/quarkus/projects/maven/quarkus-route/.mvn/wrapper/MavenWrapperDownloader.java new file mode 100644 index 000000000..84d1e60d8 --- /dev/null +++ b/projects/quarkus/projects/maven/quarkus-route/.mvn/wrapper/MavenWrapperDownloader.java @@ -0,0 +1,98 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 + * + * http://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. + */ + +import java.io.IOException; +import java.io.InputStream; +import java.net.Authenticator; +import java.net.PasswordAuthentication; +import java.net.URL; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.nio.file.StandardCopyOption; + +public final class MavenWrapperDownloader +{ + private static final String WRAPPER_VERSION = "3.2.0"; + + private static final boolean VERBOSE = Boolean.parseBoolean( System.getenv( "MVNW_VERBOSE" ) ); + + public static void main( String[] args ) + { + log( "Apache Maven Wrapper Downloader " + WRAPPER_VERSION ); + + if ( args.length != 2 ) + { + System.err.println( " - ERROR wrapperUrl or wrapperJarPath parameter missing" ); + System.exit( 1 ); + } + + try + { + log( " - Downloader started" ); + final URL wrapperUrl = new URL( args[0] ); + final String jarPath = args[1].replace( "..", "" ); // Sanitize path + final Path wrapperJarPath = Paths.get( jarPath ).toAbsolutePath().normalize(); + downloadFileFromURL( wrapperUrl, wrapperJarPath ); + log( "Done" ); + } + catch ( IOException e ) + { + System.err.println( "- Error downloading: " + e.getMessage() ); + if ( VERBOSE ) + { + e.printStackTrace(); + } + System.exit( 1 ); + } + } + + private static void downloadFileFromURL( URL wrapperUrl, Path wrapperJarPath ) + throws IOException + { + log( " - Downloading to: " + wrapperJarPath ); + if ( System.getenv( "MVNW_USERNAME" ) != null && System.getenv( "MVNW_PASSWORD" ) != null ) + { + final String username = System.getenv( "MVNW_USERNAME" ); + final char[] password = System.getenv( "MVNW_PASSWORD" ).toCharArray(); + Authenticator.setDefault( new Authenticator() + { + @Override + protected PasswordAuthentication getPasswordAuthentication() + { + return new PasswordAuthentication( username, password ); + } + } ); + } + try ( InputStream inStream = wrapperUrl.openStream() ) + { + Files.copy( inStream, wrapperJarPath, StandardCopyOption.REPLACE_EXISTING ); + } + log( " - Downloader complete" ); + } + + private static void log( String msg ) + { + if ( VERBOSE ) + { + System.out.println( msg ); + } + } + +} diff --git a/projects/quarkus/projects/maven/quarkus-route/.mvn/wrapper/maven-wrapper.properties b/projects/quarkus/projects/maven/quarkus-route/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 000000000..6d3a56651 --- /dev/null +++ b/projects/quarkus/projects/maven/quarkus-route/.mvn/wrapper/maven-wrapper.properties @@ -0,0 +1,18 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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 +# +# http://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. +distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.3/apache-maven-3.9.3-bin.zip +wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar diff --git a/projects/quarkus/projects/maven/quarkus-route/README.md b/projects/quarkus/projects/maven/quarkus-route/README.md new file mode 100644 index 000000000..c4c87707b --- /dev/null +++ b/projects/quarkus/projects/maven/quarkus-route/README.md @@ -0,0 +1,52 @@ +# quarkus-route + +This project uses Quarkus, the Supersonic Subatomic Java Framework. + +If you want to learn more about Quarkus, please visit its website: https://quarkus.io/ . + +## Running the application in dev mode + +You can run your application in dev mode that enables live coding using: +```shell script +./mvnw compile quarkus:dev +``` + +> **_NOTE:_** Quarkus now ships with a Dev UI, which is available in dev mode only at http://localhost:8080/q/dev/. + +## Packaging and running the application + +The application can be packaged using: +```shell script +./mvnw package +``` +It produces the `quarkus-run.jar` file in the `target/quarkus-app/` directory. +Be aware that it’s not an _über-jar_ as the dependencies are copied into the `target/quarkus-app/lib/` directory. + +The application is now runnable using `java -jar target/quarkus-app/quarkus-run.jar`. + +If you want to build an _über-jar_, execute the following command: +```shell script +./mvnw package -Dquarkus.package.type=uber-jar +``` + +The application, packaged as an _über-jar_, is now runnable using `java -jar target/*-runner.jar`. + +## Creating a native executable + +You can create a native executable using: +```shell script +./mvnw package -Dnative +``` + +Or, if you don't have GraalVM installed, you can run the native executable build in a container using: +```shell script +./mvnw package -Dnative -Dquarkus.native.container-build=true +``` + +You can then execute your native executable with: `./target/quarkus-route-1.0.0-SNAPSHOT-runner` + +If you want to learn more about building native executables, please consult https://quarkus.io/guides/maven-tooling. + +## Related Guides + +- Reactive Routes ([guide](https://quarkus.io/guides/reactive-routes)): REST framework offering the route model to define non blocking endpoints diff --git a/projects/quarkus/projects/maven/quarkus-route/mvnw b/projects/quarkus/projects/maven/quarkus-route/mvnw new file mode 100644 index 000000000..8d937f4c1 --- /dev/null +++ b/projects/quarkus/projects/maven/quarkus-route/mvnw @@ -0,0 +1,308 @@ +#!/bin/sh +# ---------------------------------------------------------------------------- +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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 +# +# http://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. +# ---------------------------------------------------------------------------- + +# ---------------------------------------------------------------------------- +# Apache Maven Wrapper startup batch script, version 3.2.0 +# +# Required ENV vars: +# ------------------ +# JAVA_HOME - location of a JDK home dir +# +# Optional ENV vars +# ----------------- +# MAVEN_OPTS - parameters passed to the Java VM when running Maven +# e.g. to debug Maven itself, use +# set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 +# MAVEN_SKIP_RC - flag to disable loading of mavenrc files +# ---------------------------------------------------------------------------- + +if [ -z "$MAVEN_SKIP_RC" ] ; then + + if [ -f /usr/local/etc/mavenrc ] ; then + . /usr/local/etc/mavenrc + fi + + if [ -f /etc/mavenrc ] ; then + . /etc/mavenrc + fi + + if [ -f "$HOME/.mavenrc" ] ; then + . "$HOME/.mavenrc" + fi + +fi + +# OS specific support. $var _must_ be set to either true or false. +cygwin=false; +darwin=false; +mingw=false +case "$(uname)" in + CYGWIN*) cygwin=true ;; + MINGW*) mingw=true;; + Darwin*) darwin=true + # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home + # See https://developer.apple.com/library/mac/qa/qa1170/_index.html + if [ -z "$JAVA_HOME" ]; then + if [ -x "/usr/libexec/java_home" ]; then + JAVA_HOME="$(/usr/libexec/java_home)"; export JAVA_HOME + else + JAVA_HOME="/Library/Java/Home"; export JAVA_HOME + fi + fi + ;; +esac + +if [ -z "$JAVA_HOME" ] ; then + if [ -r /etc/gentoo-release ] ; then + JAVA_HOME=$(java-config --jre-home) + fi +fi + +# For Cygwin, ensure paths are in UNIX format before anything is touched +if $cygwin ; then + [ -n "$JAVA_HOME" ] && + JAVA_HOME=$(cygpath --unix "$JAVA_HOME") + [ -n "$CLASSPATH" ] && + CLASSPATH=$(cygpath --path --unix "$CLASSPATH") +fi + +# For Mingw, ensure paths are in UNIX format before anything is touched +if $mingw ; then + [ -n "$JAVA_HOME" ] && [ -d "$JAVA_HOME" ] && + JAVA_HOME="$(cd "$JAVA_HOME" || (echo "cannot cd into $JAVA_HOME."; exit 1); pwd)" +fi + +if [ -z "$JAVA_HOME" ]; then + javaExecutable="$(which javac)" + if [ -n "$javaExecutable" ] && ! [ "$(expr "\"$javaExecutable\"" : '\([^ ]*\)')" = "no" ]; then + # readlink(1) is not available as standard on Solaris 10. + readLink=$(which readlink) + if [ ! "$(expr "$readLink" : '\([^ ]*\)')" = "no" ]; then + if $darwin ; then + javaHome="$(dirname "\"$javaExecutable\"")" + javaExecutable="$(cd "\"$javaHome\"" && pwd -P)/javac" + else + javaExecutable="$(readlink -f "\"$javaExecutable\"")" + fi + javaHome="$(dirname "\"$javaExecutable\"")" + javaHome=$(expr "$javaHome" : '\(.*\)/bin') + JAVA_HOME="$javaHome" + export JAVA_HOME + fi + fi +fi + +if [ -z "$JAVACMD" ] ; then + 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 + else + JAVACMD="$(\unset -f command 2>/dev/null; \command -v java)" + fi +fi + +if [ ! -x "$JAVACMD" ] ; then + echo "Error: JAVA_HOME is not defined correctly." >&2 + echo " We cannot execute $JAVACMD" >&2 + exit 1 +fi + +if [ -z "$JAVA_HOME" ] ; then + echo "Warning: JAVA_HOME environment variable is not set." +fi + +# traverses directory structure from process work directory to filesystem root +# first directory with .mvn subdirectory is considered project base directory +find_maven_basedir() { + if [ -z "$1" ] + then + echo "Path not specified to find_maven_basedir" + return 1 + fi + + basedir="$1" + wdir="$1" + while [ "$wdir" != '/' ] ; do + if [ -d "$wdir"/.mvn ] ; then + basedir=$wdir + break + fi + # workaround for JBEAP-8937 (on Solaris 10/Sparc) + if [ -d "${wdir}" ]; then + wdir=$(cd "$wdir/.." || exit 1; pwd) + fi + # end of workaround + done + printf '%s' "$(cd "$basedir" || exit 1; pwd)" +} + +# concatenates all lines of a file +concat_lines() { + if [ -f "$1" ]; then + # Remove \r in case we run on Windows within Git Bash + # and check out the repository with auto CRLF management + # enabled. Otherwise, we may read lines that are delimited with + # \r\n and produce $'-Xarg\r' rather than -Xarg due to word + # splitting rules. + tr -s '\r\n' ' ' < "$1" + fi +} + +log() { + if [ "$MVNW_VERBOSE" = true ]; then + printf '%s\n' "$1" + fi +} + +BASE_DIR=$(find_maven_basedir "$(dirname "$0")") +if [ -z "$BASE_DIR" ]; then + exit 1; +fi + +MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"}; export MAVEN_PROJECTBASEDIR +log "$MAVEN_PROJECTBASEDIR" + +########################################################################################## +# Extension to allow automatically downloading the maven-wrapper.jar from Maven-central +# This allows using the maven wrapper in projects that prohibit checking in binary data. +########################################################################################## +wrapperJarPath="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" +if [ -r "$wrapperJarPath" ]; then + log "Found $wrapperJarPath" +else + log "Couldn't find $wrapperJarPath, downloading it ..." + + if [ -n "$MVNW_REPOURL" ]; then + wrapperUrl="$MVNW_REPOURL/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + else + wrapperUrl="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + fi + while IFS="=" read -r key value; do + # Remove '\r' from value to allow usage on windows as IFS does not consider '\r' as a separator ( considers space, tab, new line ('\n'), and custom '=' ) + safeValue=$(echo "$value" | tr -d '\r') + case "$key" in (wrapperUrl) wrapperUrl="$safeValue"; break ;; + esac + done < "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties" + log "Downloading from: $wrapperUrl" + + if $cygwin; then + wrapperJarPath=$(cygpath --path --windows "$wrapperJarPath") + fi + + if command -v wget > /dev/null; then + log "Found wget ... using wget" + [ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--quiet" + if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then + wget $QUIET "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" + else + wget $QUIET --http-user="$MVNW_USERNAME" --http-password="$MVNW_PASSWORD" "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" + fi + elif command -v curl > /dev/null; then + log "Found curl ... using curl" + [ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--silent" + if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then + curl $QUIET -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath" + else + curl $QUIET --user "$MVNW_USERNAME:$MVNW_PASSWORD" -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath" + fi + else + log "Falling back to using Java to download" + javaSource="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.java" + javaClass="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.class" + # For Cygwin, switch paths to Windows format before running javac + if $cygwin; then + javaSource=$(cygpath --path --windows "$javaSource") + javaClass=$(cygpath --path --windows "$javaClass") + fi + if [ -e "$javaSource" ]; then + if [ ! -e "$javaClass" ]; then + log " - Compiling MavenWrapperDownloader.java ..." + ("$JAVA_HOME/bin/javac" "$javaSource") + fi + if [ -e "$javaClass" ]; then + log " - Running MavenWrapperDownloader.java ..." + ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$wrapperUrl" "$wrapperJarPath") || rm -f "$wrapperJarPath" + fi + fi + fi +fi +########################################################################################## +# End of extension +########################################################################################## + +# If specified, validate the SHA-256 sum of the Maven wrapper jar file +wrapperSha256Sum="" +while IFS="=" read -r key value; do + case "$key" in (wrapperSha256Sum) wrapperSha256Sum=$value; break ;; + esac +done < "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties" +if [ -n "$wrapperSha256Sum" ]; then + wrapperSha256Result=false + if command -v sha256sum > /dev/null; then + if echo "$wrapperSha256Sum $wrapperJarPath" | sha256sum -c > /dev/null 2>&1; then + wrapperSha256Result=true + fi + elif command -v shasum > /dev/null; then + if echo "$wrapperSha256Sum $wrapperJarPath" | shasum -a 256 -c > /dev/null 2>&1; then + wrapperSha256Result=true + fi + else + echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available." + echo "Please install either command, or disable validation by removing 'wrapperSha256Sum' from your maven-wrapper.properties." + exit 1 + fi + if [ $wrapperSha256Result = false ]; then + echo "Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised." >&2 + echo "Investigate or delete $wrapperJarPath to attempt a clean download." >&2 + echo "If you updated your Maven version, you need to update the specified wrapperSha256Sum property." >&2 + exit 1 + fi +fi + +MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" + +# For Cygwin, switch paths to Windows format before running java +if $cygwin; then + [ -n "$JAVA_HOME" ] && + JAVA_HOME=$(cygpath --path --windows "$JAVA_HOME") + [ -n "$CLASSPATH" ] && + CLASSPATH=$(cygpath --path --windows "$CLASSPATH") + [ -n "$MAVEN_PROJECTBASEDIR" ] && + MAVEN_PROJECTBASEDIR=$(cygpath --path --windows "$MAVEN_PROJECTBASEDIR") +fi + +# Provide a "standardized" way to retrieve the CLI args that will +# work with both Windows and non-Windows executions. +MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $*" +export MAVEN_CMD_LINE_ARGS + +WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +# shellcheck disable=SC2086 # safe args +exec "$JAVACMD" \ + $MAVEN_OPTS \ + $MAVEN_DEBUG_OPTS \ + -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ + "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ + ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" diff --git a/projects/quarkus/projects/maven/quarkus-route/mvnw.cmd b/projects/quarkus/projects/maven/quarkus-route/mvnw.cmd new file mode 100644 index 000000000..c4586b564 --- /dev/null +++ b/projects/quarkus/projects/maven/quarkus-route/mvnw.cmd @@ -0,0 +1,205 @@ +@REM ---------------------------------------------------------------------------- +@REM Licensed to the Apache Software Foundation (ASF) under one +@REM or more contributor license agreements. See the NOTICE file +@REM distributed with this work for additional information +@REM regarding copyright ownership. The ASF licenses this file +@REM to you under the Apache License, Version 2.0 (the +@REM "License"); you may not use this file except in compliance +@REM with the License. You may obtain a copy of the License at +@REM +@REM http://www.apache.org/licenses/LICENSE-2.0 +@REM +@REM Unless required by applicable law or agreed to in writing, +@REM software distributed under the License is distributed on an +@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +@REM KIND, either express or implied. See the License for the +@REM specific language governing permissions and limitations +@REM under the License. +@REM ---------------------------------------------------------------------------- + +@REM ---------------------------------------------------------------------------- +@REM Apache Maven Wrapper startup batch script, version 3.2.0 +@REM +@REM Required ENV vars: +@REM JAVA_HOME - location of a JDK home dir +@REM +@REM Optional ENV vars +@REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands +@REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending +@REM MAVEN_OPTS - parameters passed to the Java VM when running Maven +@REM e.g. to debug Maven itself, use +@REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 +@REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files +@REM ---------------------------------------------------------------------------- + +@REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' +@echo off +@REM set title of command window +title %0 +@REM enable echoing by setting MAVEN_BATCH_ECHO to 'on' +@if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% + +@REM set %HOME% to equivalent of $HOME +if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") + +@REM Execute a user defined script before this one +if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre +@REM check for pre script, once with legacy .bat ending and once with .cmd ending +if exist "%USERPROFILE%\mavenrc_pre.bat" call "%USERPROFILE%\mavenrc_pre.bat" %* +if exist "%USERPROFILE%\mavenrc_pre.cmd" call "%USERPROFILE%\mavenrc_pre.cmd" %* +:skipRcPre + +@setlocal + +set ERROR_CODE=0 + +@REM To isolate internal variables from possible post scripts, we use another setlocal +@setlocal + +@REM ==== START VALIDATION ==== +if not "%JAVA_HOME%" == "" goto OkJHome + +echo. +echo Error: JAVA_HOME not found in your environment. >&2 +echo Please set the JAVA_HOME variable in your environment to match the >&2 +echo location of your Java installation. >&2 +echo. +goto error + +:OkJHome +if exist "%JAVA_HOME%\bin\java.exe" goto init + +echo. +echo Error: JAVA_HOME is set to an invalid directory. >&2 +echo JAVA_HOME = "%JAVA_HOME%" >&2 +echo Please set the JAVA_HOME variable in your environment to match the >&2 +echo location of your Java installation. >&2 +echo. +goto error + +@REM ==== END VALIDATION ==== + +:init + +@REM Find the project base dir, i.e. the directory that contains the folder ".mvn". +@REM Fallback to current working directory if not found. + +set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% +IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir + +set EXEC_DIR=%CD% +set WDIR=%EXEC_DIR% +:findBaseDir +IF EXIST "%WDIR%"\.mvn goto baseDirFound +cd .. +IF "%WDIR%"=="%CD%" goto baseDirNotFound +set WDIR=%CD% +goto findBaseDir + +:baseDirFound +set MAVEN_PROJECTBASEDIR=%WDIR% +cd "%EXEC_DIR%" +goto endDetectBaseDir + +:baseDirNotFound +set MAVEN_PROJECTBASEDIR=%EXEC_DIR% +cd "%EXEC_DIR%" + +:endDetectBaseDir + +IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig + +@setlocal EnableExtensions EnableDelayedExpansion +for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a +@endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% + +:endReadAdditionalConfig + +SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" +set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" +set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +set WRAPPER_URL="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + +FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( + IF "%%A"=="wrapperUrl" SET WRAPPER_URL=%%B +) + +@REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central +@REM This allows using the maven wrapper in projects that prohibit checking in binary data. +if exist %WRAPPER_JAR% ( + if "%MVNW_VERBOSE%" == "true" ( + echo Found %WRAPPER_JAR% + ) +) else ( + if not "%MVNW_REPOURL%" == "" ( + SET WRAPPER_URL="%MVNW_REPOURL%/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + ) + if "%MVNW_VERBOSE%" == "true" ( + echo Couldn't find %WRAPPER_JAR%, downloading it ... + echo Downloading from: %WRAPPER_URL% + ) + + powershell -Command "&{"^ + "$webclient = new-object System.Net.WebClient;"^ + "if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^ + "$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^ + "}"^ + "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%WRAPPER_URL%', '%WRAPPER_JAR%')"^ + "}" + if "%MVNW_VERBOSE%" == "true" ( + echo Finished downloading %WRAPPER_JAR% + ) +) +@REM End of extension + +@REM If specified, validate the SHA-256 sum of the Maven wrapper jar file +SET WRAPPER_SHA_256_SUM="" +FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( + IF "%%A"=="wrapperSha256Sum" SET WRAPPER_SHA_256_SUM=%%B +) +IF NOT %WRAPPER_SHA_256_SUM%=="" ( + powershell -Command "&{"^ + "$hash = (Get-FileHash \"%WRAPPER_JAR%\" -Algorithm SHA256).Hash.ToLower();"^ + "If('%WRAPPER_SHA_256_SUM%' -ne $hash){"^ + " Write-Output 'Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised.';"^ + " Write-Output 'Investigate or delete %WRAPPER_JAR% to attempt a clean download.';"^ + " Write-Output 'If you updated your Maven version, you need to update the specified wrapperSha256Sum property.';"^ + " exit 1;"^ + "}"^ + "}" + if ERRORLEVEL 1 goto error +) + +@REM Provide a "standardized" way to retrieve the CLI args that will +@REM work with both Windows and non-Windows executions. +set MAVEN_CMD_LINE_ARGS=%* + +%MAVEN_JAVA_EXE% ^ + %JVM_CONFIG_MAVEN_PROPS% ^ + %MAVEN_OPTS% ^ + %MAVEN_DEBUG_OPTS% ^ + -classpath %WRAPPER_JAR% ^ + "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" ^ + %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* +if ERRORLEVEL 1 goto error +goto end + +:error +set ERROR_CODE=1 + +:end +@endlocal & set ERROR_CODE=%ERROR_CODE% + +if not "%MAVEN_SKIP_RC%"=="" goto skipRcPost +@REM check for post script, once with legacy .bat ending and once with .cmd ending +if exist "%USERPROFILE%\mavenrc_post.bat" call "%USERPROFILE%\mavenrc_post.bat" +if exist "%USERPROFILE%\mavenrc_post.cmd" call "%USERPROFILE%\mavenrc_post.cmd" +:skipRcPost + +@REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' +if "%MAVEN_BATCH_PAUSE%"=="on" pause + +if "%MAVEN_TERMINATE_CMD%"=="on" exit %ERROR_CODE% + +cmd /C exit /B %ERROR_CODE% diff --git a/projects/quarkus/projects/maven/quarkus-route/pom.xml b/projects/quarkus/projects/maven/quarkus-route/pom.xml new file mode 100644 index 000000000..889263ffa --- /dev/null +++ b/projects/quarkus/projects/maven/quarkus-route/pom.xml @@ -0,0 +1,116 @@ + + + 4.0.0 + org.acme + quarkus-route + 1.0.0-SNAPSHOT + + 3.11.0 + 17 + UTF-8 + UTF-8 + quarkus-bom + io.quarkus.platform + 3.3.1 + true + 3.1.2 + + + + + ${quarkus.platform.group-id} + ${quarkus.platform.artifact-id} + ${quarkus.platform.version} + pom + import + + + + + + io.quarkus + quarkus-reactive-routes + + + io.quarkus + quarkus-arc + + + io.quarkus + quarkus-junit5 + test + + + + + + ${quarkus.platform.group-id} + quarkus-maven-plugin + ${quarkus.platform.version} + true + + + + build + generate-code + generate-code-tests + + + + + + maven-compiler-plugin + ${compiler-plugin.version} + + + -parameters + + + + + maven-surefire-plugin + ${surefire-plugin.version} + + + org.jboss.logmanager.LogManager + ${maven.home} + + + + + maven-failsafe-plugin + ${surefire-plugin.version} + + + + integration-test + verify + + + + ${project.build.directory}/${project.build.finalName}-runner + org.jboss.logmanager.LogManager + ${maven.home} + + + + + + + + + + native + + + native + + + + false + native + + + + diff --git a/projects/quarkus/projects/maven/quarkus-route/src/main/docker/Dockerfile.jvm b/projects/quarkus/projects/maven/quarkus-route/src/main/docker/Dockerfile.jvm new file mode 100644 index 000000000..e1019a906 --- /dev/null +++ b/projects/quarkus/projects/maven/quarkus-route/src/main/docker/Dockerfile.jvm @@ -0,0 +1,97 @@ +#### +# This Dockerfile is used in order to build a container that runs the Quarkus application in JVM mode +# +# Before building the container image run: +# +# ./mvnw package +# +# Then, build the image with: +# +# docker build -f src/main/docker/Dockerfile.jvm -t quarkus/quarkus-route-jvm . +# +# Then run the container using: +# +# docker run -i --rm -p 8080:8080 quarkus/quarkus-route-jvm +# +# If you want to include the debug port into your docker image +# you will have to expose the debug port (default 5005 being the default) like this : EXPOSE 8080 5005. +# Additionally you will have to set -e JAVA_DEBUG=true and -e JAVA_DEBUG_PORT=*:5005 +# when running the container +# +# Then run the container using : +# +# docker run -i --rm -p 8080:8080 quarkus/quarkus-route-jvm +# +# This image uses the `run-java.sh` script to run the application. +# This scripts computes the command line to execute your Java application, and +# includes memory/GC tuning. +# You can configure the behavior using the following environment properties: +# - JAVA_OPTS: JVM options passed to the `java` command (example: "-verbose:class") +# - JAVA_OPTS_APPEND: User specified Java options to be appended to generated options +# in JAVA_OPTS (example: "-Dsome.property=foo") +# - JAVA_MAX_MEM_RATIO: Is used when no `-Xmx` option is given in JAVA_OPTS. This is +# used to calculate a default maximal heap memory based on a containers restriction. +# If used in a container without any memory constraints for the container then this +# option has no effect. If there is a memory constraint then `-Xmx` is set to a ratio +# of the container available memory as set here. The default is `50` which means 50% +# of the available memory is used as an upper boundary. You can skip this mechanism by +# setting this value to `0` in which case no `-Xmx` option is added. +# - JAVA_INITIAL_MEM_RATIO: Is used when no `-Xms` option is given in JAVA_OPTS. This +# is used to calculate a default initial heap memory based on the maximum heap memory. +# If used in a container without any memory constraints for the container then this +# option has no effect. If there is a memory constraint then `-Xms` is set to a ratio +# of the `-Xmx` memory as set here. The default is `25` which means 25% of the `-Xmx` +# is used as the initial heap size. You can skip this mechanism by setting this value +# to `0` in which case no `-Xms` option is added (example: "25") +# - JAVA_MAX_INITIAL_MEM: Is used when no `-Xms` option is given in JAVA_OPTS. +# This is used to calculate the maximum value of the initial heap memory. If used in +# a container without any memory constraints for the container then this option has +# no effect. If there is a memory constraint then `-Xms` is limited to the value set +# here. The default is 4096MB which means the calculated value of `-Xms` never will +# be greater than 4096MB. The value of this variable is expressed in MB (example: "4096") +# - JAVA_DIAGNOSTICS: Set this to get some diagnostics information to standard output +# when things are happening. This option, if set to true, will set +# `-XX:+UnlockDiagnosticVMOptions`. Disabled by default (example: "true"). +# - JAVA_DEBUG: If set remote debugging will be switched on. Disabled by default (example: +# true"). +# - JAVA_DEBUG_PORT: Port used for remote debugging. Defaults to 5005 (example: "8787"). +# - CONTAINER_CORE_LIMIT: A calculated core limit as described in +# https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt. (example: "2") +# - CONTAINER_MAX_MEMORY: Memory limit given to the container (example: "1024"). +# - GC_MIN_HEAP_FREE_RATIO: Minimum percentage of heap free after GC to avoid expansion. +# (example: "20") +# - GC_MAX_HEAP_FREE_RATIO: Maximum percentage of heap free after GC to avoid shrinking. +# (example: "40") +# - GC_TIME_RATIO: Specifies the ratio of the time spent outside the garbage collection. +# (example: "4") +# - GC_ADAPTIVE_SIZE_POLICY_WEIGHT: The weighting given to the current GC time versus +# previous GC times. (example: "90") +# - GC_METASPACE_SIZE: The initial metaspace size. (example: "20") +# - GC_MAX_METASPACE_SIZE: The maximum metaspace size. (example: "100") +# - GC_CONTAINER_OPTIONS: Specify Java GC to use. The value of this variable should +# contain the necessary JRE command-line options to specify the required GC, which +# will override the default of `-XX:+UseParallelGC` (example: -XX:+UseG1GC). +# - HTTPS_PROXY: The location of the https proxy. (example: "myuser@127.0.0.1:8080") +# - HTTP_PROXY: The location of the http proxy. (example: "myuser@127.0.0.1:8080") +# - NO_PROXY: A comma separated lists of hosts, IP addresses or domains that can be +# accessed directly. (example: "foo.example.com,bar.example.com") +# +### +FROM registry.access.redhat.com/ubi8/openjdk-17:1.16 + +ENV LANGUAGE='en_US:en' + + +# We make four distinct layers so if there are application changes the library layers can be re-used +COPY --chown=185 target/quarkus-app/lib/ /deployments/lib/ +COPY --chown=185 target/quarkus-app/*.jar /deployments/ +COPY --chown=185 target/quarkus-app/app/ /deployments/app/ +COPY --chown=185 target/quarkus-app/quarkus/ /deployments/quarkus/ + +EXPOSE 8080 +USER 185 +ENV JAVA_OPTS="-Dquarkus.http.host=0.0.0.0 -Djava.util.logging.manager=org.jboss.logmanager.LogManager" +ENV JAVA_APP_JAR="/deployments/quarkus-run.jar" + +ENTRYPOINT [ "/opt/jboss/container/java/run/run-java.sh" ] + diff --git a/projects/quarkus/projects/maven/quarkus-route/src/main/docker/Dockerfile.legacy-jar b/projects/quarkus/projects/maven/quarkus-route/src/main/docker/Dockerfile.legacy-jar new file mode 100644 index 000000000..b1fa64adb --- /dev/null +++ b/projects/quarkus/projects/maven/quarkus-route/src/main/docker/Dockerfile.legacy-jar @@ -0,0 +1,93 @@ +#### +# This Dockerfile is used in order to build a container that runs the Quarkus application in JVM mode +# +# Before building the container image run: +# +# ./mvnw package -Dquarkus.package.type=legacy-jar +# +# Then, build the image with: +# +# docker build -f src/main/docker/Dockerfile.legacy-jar -t quarkus/quarkus-route-legacy-jar . +# +# Then run the container using: +# +# docker run -i --rm -p 8080:8080 quarkus/quarkus-route-legacy-jar +# +# If you want to include the debug port into your docker image +# you will have to expose the debug port (default 5005 being the default) like this : EXPOSE 8080 5005. +# Additionally you will have to set -e JAVA_DEBUG=true and -e JAVA_DEBUG_PORT=*:5005 +# when running the container +# +# Then run the container using : +# +# docker run -i --rm -p 8080:8080 quarkus/quarkus-route-legacy-jar +# +# This image uses the `run-java.sh` script to run the application. +# This scripts computes the command line to execute your Java application, and +# includes memory/GC tuning. +# You can configure the behavior using the following environment properties: +# - JAVA_OPTS: JVM options passed to the `java` command (example: "-verbose:class") +# - JAVA_OPTS_APPEND: User specified Java options to be appended to generated options +# in JAVA_OPTS (example: "-Dsome.property=foo") +# - JAVA_MAX_MEM_RATIO: Is used when no `-Xmx` option is given in JAVA_OPTS. This is +# used to calculate a default maximal heap memory based on a containers restriction. +# If used in a container without any memory constraints for the container then this +# option has no effect. If there is a memory constraint then `-Xmx` is set to a ratio +# of the container available memory as set here. The default is `50` which means 50% +# of the available memory is used as an upper boundary. You can skip this mechanism by +# setting this value to `0` in which case no `-Xmx` option is added. +# - JAVA_INITIAL_MEM_RATIO: Is used when no `-Xms` option is given in JAVA_OPTS. This +# is used to calculate a default initial heap memory based on the maximum heap memory. +# If used in a container without any memory constraints for the container then this +# option has no effect. If there is a memory constraint then `-Xms` is set to a ratio +# of the `-Xmx` memory as set here. The default is `25` which means 25% of the `-Xmx` +# is used as the initial heap size. You can skip this mechanism by setting this value +# to `0` in which case no `-Xms` option is added (example: "25") +# - JAVA_MAX_INITIAL_MEM: Is used when no `-Xms` option is given in JAVA_OPTS. +# This is used to calculate the maximum value of the initial heap memory. If used in +# a container without any memory constraints for the container then this option has +# no effect. If there is a memory constraint then `-Xms` is limited to the value set +# here. The default is 4096MB which means the calculated value of `-Xms` never will +# be greater than 4096MB. The value of this variable is expressed in MB (example: "4096") +# - JAVA_DIAGNOSTICS: Set this to get some diagnostics information to standard output +# when things are happening. This option, if set to true, will set +# `-XX:+UnlockDiagnosticVMOptions`. Disabled by default (example: "true"). +# - JAVA_DEBUG: If set remote debugging will be switched on. Disabled by default (example: +# true"). +# - JAVA_DEBUG_PORT: Port used for remote debugging. Defaults to 5005 (example: "8787"). +# - CONTAINER_CORE_LIMIT: A calculated core limit as described in +# https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt. (example: "2") +# - CONTAINER_MAX_MEMORY: Memory limit given to the container (example: "1024"). +# - GC_MIN_HEAP_FREE_RATIO: Minimum percentage of heap free after GC to avoid expansion. +# (example: "20") +# - GC_MAX_HEAP_FREE_RATIO: Maximum percentage of heap free after GC to avoid shrinking. +# (example: "40") +# - GC_TIME_RATIO: Specifies the ratio of the time spent outside the garbage collection. +# (example: "4") +# - GC_ADAPTIVE_SIZE_POLICY_WEIGHT: The weighting given to the current GC time versus +# previous GC times. (example: "90") +# - GC_METASPACE_SIZE: The initial metaspace size. (example: "20") +# - GC_MAX_METASPACE_SIZE: The maximum metaspace size. (example: "100") +# - GC_CONTAINER_OPTIONS: Specify Java GC to use. The value of this variable should +# contain the necessary JRE command-line options to specify the required GC, which +# will override the default of `-XX:+UseParallelGC` (example: -XX:+UseG1GC). +# - HTTPS_PROXY: The location of the https proxy. (example: "myuser@127.0.0.1:8080") +# - HTTP_PROXY: The location of the http proxy. (example: "myuser@127.0.0.1:8080") +# - NO_PROXY: A comma separated lists of hosts, IP addresses or domains that can be +# accessed directly. (example: "foo.example.com,bar.example.com") +# +### +FROM registry.access.redhat.com/ubi8/openjdk-17:1.16 + +ENV LANGUAGE='en_US:en' + + +COPY target/lib/* /deployments/lib/ +COPY target/*-runner.jar /deployments/quarkus-run.jar + +EXPOSE 8080 +USER 185 +ENV JAVA_OPTS="-Dquarkus.http.host=0.0.0.0 -Djava.util.logging.manager=org.jboss.logmanager.LogManager" +ENV JAVA_APP_JAR="/deployments/quarkus-run.jar" + +ENTRYPOINT [ "/opt/jboss/container/java/run/run-java.sh" ] diff --git a/projects/quarkus/projects/maven/quarkus-route/src/main/docker/Dockerfile.native b/projects/quarkus/projects/maven/quarkus-route/src/main/docker/Dockerfile.native new file mode 100644 index 000000000..07031811c --- /dev/null +++ b/projects/quarkus/projects/maven/quarkus-route/src/main/docker/Dockerfile.native @@ -0,0 +1,27 @@ +#### +# This Dockerfile is used in order to build a container that runs the Quarkus application in native (no JVM) mode. +# +# Before building the container image run: +# +# ./mvnw package -Dnative +# +# Then, build the image with: +# +# docker build -f src/main/docker/Dockerfile.native -t quarkus/quarkus-route . +# +# Then run the container using: +# +# docker run -i --rm -p 8080:8080 quarkus/quarkus-route +# +### +FROM registry.access.redhat.com/ubi8/ubi-minimal:8.8 +WORKDIR /work/ +RUN chown 1001 /work \ + && chmod "g+rwX" /work \ + && chown 1001:root /work +COPY --chown=1001:root target/*-runner /work/application + +EXPOSE 8080 +USER 1001 + +ENTRYPOINT ["./application", "-Dquarkus.http.host=0.0.0.0"] diff --git a/projects/quarkus/projects/maven/quarkus-route/src/main/docker/Dockerfile.native-micro b/projects/quarkus/projects/maven/quarkus-route/src/main/docker/Dockerfile.native-micro new file mode 100644 index 000000000..369f5f668 --- /dev/null +++ b/projects/quarkus/projects/maven/quarkus-route/src/main/docker/Dockerfile.native-micro @@ -0,0 +1,30 @@ +#### +# This Dockerfile is used in order to build a container that runs the Quarkus application in native (no JVM) mode. +# It uses a micro base image, tuned for Quarkus native executables. +# It reduces the size of the resulting container image. +# Check https://quarkus.io/guides/quarkus-runtime-base-image for further information about this image. +# +# Before building the container image run: +# +# ./mvnw package -Dnative +# +# Then, build the image with: +# +# docker build -f src/main/docker/Dockerfile.native-micro -t quarkus/quarkus-route . +# +# Then run the container using: +# +# docker run -i --rm -p 8080:8080 quarkus/quarkus-route +# +### +FROM quay.io/quarkus/quarkus-micro-image:2.0 +WORKDIR /work/ +RUN chown 1001 /work \ + && chmod "g+rwX" /work \ + && chown 1001:root /work +COPY --chown=1001:root target/*-runner /work/application + +EXPOSE 8080 +USER 1001 + +ENTRYPOINT ["./application", "-Dquarkus.http.host=0.0.0.0"] diff --git a/projects/quarkus/projects/maven/quarkus-route/src/main/java/org/acme/reactive/routes/MultipleRoutes.java b/projects/quarkus/projects/maven/quarkus-route/src/main/java/org/acme/reactive/routes/MultipleRoutes.java new file mode 100644 index 000000000..7a81ccef2 --- /dev/null +++ b/projects/quarkus/projects/maven/quarkus-route/src/main/java/org/acme/reactive/routes/MultipleRoutes.java @@ -0,0 +1,14 @@ +package org.acme.reactive.routes; + +import io.quarkus.vertx.web.Route; +import io.vertx.ext.web.RoutingContext; + +public class MultipleRoutes { + + @Route(path = "/first") + @Route(path = "/second") + public void route(RoutingContext rc) { + // ... + } + +} diff --git a/projects/quarkus/projects/maven/quarkus-route/src/main/java/org/acme/reactive/routes/MyDeclarativeRoutes.java b/projects/quarkus/projects/maven/quarkus-route/src/main/java/org/acme/reactive/routes/MyDeclarativeRoutes.java new file mode 100644 index 000000000..629785bd6 --- /dev/null +++ b/projects/quarkus/projects/maven/quarkus-route/src/main/java/org/acme/reactive/routes/MyDeclarativeRoutes.java @@ -0,0 +1,34 @@ +package org.acme.reactive.routes; + +import io.quarkus.vertx.web.Param; +import io.quarkus.vertx.web.Route; +import io.quarkus.vertx.web.Route.HttpMethod; +import io.quarkus.vertx.web.RoutingExchange; +import io.vertx.ext.web.RoutingContext; + +import jakarta.enterprise.context.ApplicationScoped; + +@ApplicationScoped +public class MyDeclarativeRoutes { + + // neither path nor regex is set - match a path derived from the method name + @Route(methods = Route.HttpMethod.GET) + void hello(RoutingContext rc) { + rc.response().end("hello"); + } + + @Route(path = "/world") + String helloWorld() { + return "Hello world!"; + } + + @Route(path = "/greetings", methods = Route.HttpMethod.GET) + void greetingsQueryParam(RoutingExchange ex) { + ex.ok("hello " + ex.getParam("name").orElse("world")); + } + + @Route(path = "/greetings/:name", methods = Route.HttpMethod.GET) + void greetingsPathParam(@Param String name, RoutingExchange ex) { + ex.ok("hello " + name); + } +} diff --git a/projects/quarkus/projects/maven/quarkus-route/src/main/java/org/acme/reactive/routes/SimpleRoutes.java b/projects/quarkus/projects/maven/quarkus-route/src/main/java/org/acme/reactive/routes/SimpleRoutes.java new file mode 100644 index 000000000..658c0197d --- /dev/null +++ b/projects/quarkus/projects/maven/quarkus-route/src/main/java/org/acme/reactive/routes/SimpleRoutes.java @@ -0,0 +1,14 @@ +package org.acme.reactive.routes; + +import io.quarkus.vertx.web.Route; +import io.quarkus.vertx.web.RouteBase; +import io.vertx.ext.web.RoutingContext; + +@RouteBase(path = "simple", produces = "text/plain") +public class SimpleRoutes { + + @Route(path = "ping") // the final path is /simple/ping + void ping(RoutingContext rc) { + rc.response().end("pong"); + } +} \ No newline at end of file diff --git a/projects/quarkus/projects/maven/quarkus-route/src/main/resources/application.properties b/projects/quarkus/projects/maven/quarkus-route/src/main/resources/application.properties new file mode 100644 index 000000000..e69de29bb diff --git a/src/main/java/com/redhat/devtools/intellij/lsp4mp4ij/psi/core/utils/AnnotationUtils.java b/src/main/java/com/redhat/devtools/intellij/lsp4mp4ij/psi/core/utils/AnnotationUtils.java index d670a2ca7..e0bf3f0af 100644 --- a/src/main/java/com/redhat/devtools/intellij/lsp4mp4ij/psi/core/utils/AnnotationUtils.java +++ b/src/main/java/com/redhat/devtools/intellij/lsp4mp4ij/psi/core/utils/AnnotationUtils.java @@ -21,6 +21,8 @@ import org.eclipse.lsp4j.util.Ranges; import org.jetbrains.annotations.Nullable; +import java.util.ArrayList; +import java.util.List; import java.util.regex.Matcher; import java.util.regex.Pattern; @@ -97,6 +99,28 @@ private static PsiAnnotation getFirstAnnotation(PsiAnnotation[] annotations, Str return null; } + public static List getAllAnnotations(PsiElement annotatable, String... annotationNames) { + List all = new ArrayList<>(); + if (annotatable instanceof PsiAnnotationOwner) { + collectAnnotations(((PsiAnnotationOwner) annotatable).getAnnotations(), all, annotationNames); + } else if (annotatable instanceof PsiModifierListOwner) { + collectAnnotations(((PsiModifierListOwner) annotatable).getAnnotations(), all, annotationNames); + } + return all; + } + + private static void collectAnnotations(PsiAnnotation[] annotations, List all, String...annotationNames) { + if (annotations == null || annotations.length == 0 || annotationNames == null || annotationNames.length == 0) { + return; + } + for (PsiAnnotation annotation : annotations) { + for (String annotationName: annotationNames) { + if (isMatchAnnotation(annotation, annotationName)) { + all.add(annotation); + } + } + } + } /** * Returns the annotation from the given annotatable element with * the given name annotationName and null otherwise. diff --git a/src/main/java/com/redhat/devtools/intellij/lsp4mp4ij/psi/internal/jaxrs/java/DefaultJaxRsInfoProvider.java b/src/main/java/com/redhat/devtools/intellij/lsp4mp4ij/psi/internal/jaxrs/java/DefaultJaxRsInfoProvider.java index 3eabafcda..d7b1e4679 100644 --- a/src/main/java/com/redhat/devtools/intellij/lsp4mp4ij/psi/internal/jaxrs/java/DefaultJaxRsInfoProvider.java +++ b/src/main/java/com/redhat/devtools/intellij/lsp4mp4ij/psi/internal/jaxrs/java/DefaultJaxRsInfoProvider.java @@ -51,8 +51,8 @@ public class DefaultJaxRsInfoProvider implements IJaxRsInfoProvider { @Override public boolean canProvideJaxRsMethodInfoForClass(PsiFile typeRoot, Module javaProject, ProgressIndicator monitor) { - return PsiTypeUtils.findType(javaProject, JAVAX_WS_RS_PATH_ANNOTATION) == null - || PsiTypeUtils.findType(javaProject, JAKARTA_WS_RS_PATH_ANNOTATION) == null; + return PsiTypeUtils.findType(javaProject, JAVAX_WS_RS_PATH_ANNOTATION) != null + || PsiTypeUtils.findType(javaProject, JAKARTA_WS_RS_PATH_ANNOTATION) != null; } @Override diff --git a/src/main/java/com/redhat/microprofile/psi/internal/quarkus/route/java/ReactiveRouteConstants.java b/src/main/java/com/redhat/microprofile/psi/internal/quarkus/route/java/ReactiveRouteConstants.java new file mode 100644 index 000000000..07cabc808 --- /dev/null +++ b/src/main/java/com/redhat/microprofile/psi/internal/quarkus/route/java/ReactiveRouteConstants.java @@ -0,0 +1,30 @@ +/******************************************************************************* + * Copyright (c) 2023 Red Hat Inc. and others. + * All rights reserved. This program and the accompanying materials + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v20.html + * + * SPDX-License-Identifier: EPL-2.0 + * + * Contributors: + * Red Hat Inc. - initial API and implementation + *******************************************************************************/ +package com.redhat.microprofile.psi.internal.quarkus.route.java; + +/** + * Reactive route constants. + * + * @see https://quarkus.io/guides/reactive-routes#declaring-reactive-routes + */ +public class ReactiveRouteConstants { + + public static final String ROUTE_BASE_FQN = "io.quarkus.vertx.web.RouteBase"; + + public static final String ROUTE_BASE_PATH = "path"; + + public static final String ROUTE_FQN = "io.quarkus.vertx.web.Route"; + + public static final String ROUTE_PATH = "path"; + + public static final String REACTIVE_ROUTE_GET_ANNOTATION = "io.quarkus.vertx.web.Route.HttpMethod.GET"; +} \ No newline at end of file diff --git a/src/main/java/com/redhat/microprofile/psi/internal/quarkus/route/java/ReactiveRouteImplicitUsageProvider.java b/src/main/java/com/redhat/microprofile/psi/internal/quarkus/route/java/ReactiveRouteImplicitUsageProvider.java new file mode 100644 index 000000000..c6c4d5473 --- /dev/null +++ b/src/main/java/com/redhat/microprofile/psi/internal/quarkus/route/java/ReactiveRouteImplicitUsageProvider.java @@ -0,0 +1,57 @@ +/******************************************************************************* + * Copyright (c) 2023 Red Hat Inc. and others. + * + * This program and the accompanying materials are made available under the + * terms of the Eclipse Public License v. 2.0 which is available at + * http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0 + * which is available at https://www.apache.org/licenses/LICENSE-2.0. + * + * SPDX-License-Identifier: EPL-2.0 OR Apache-2.0 + * + * Contributors: + * Red Hat Inc. - initial API and implementation + *******************************************************************************/ +package com.redhat.microprofile.psi.internal.quarkus.route.java; + +import com.intellij.codeInsight.daemon.ImplicitUsageProvider; +import com.intellij.psi.PsiClass; +import com.intellij.psi.PsiElement; +import com.intellij.psi.PsiMethod; +import com.intellij.psi.PsiModifier; +import com.redhat.devtools.intellij.lsp4mp4ij.psi.core.jaxrs.JaxRsConstants; +import com.redhat.devtools.intellij.lsp4mp4ij.psi.core.utils.AnnotationUtils; +import com.redhat.devtools.intellij.lsp4mp4ij.psi.internal.restclient.MicroProfileRestClientConstants; +import com.redhat.devtools.intellij.qute.psi.internal.QuteJavaConstants; +import com.redhat.microprofile.psi.internal.quarkus.renarde.java.RenardeUtils; +import org.jetbrains.annotations.NotNull; + +import java.util.Arrays; + +/** + * Automatically declares as used, public methods annotated with @io.quarkus.vertx.web.Route + */ +public class ReactiveRouteImplicitUsageProvider implements ImplicitUsageProvider { + @Override + public boolean isImplicitUsage(@NotNull PsiElement element) { + return isImplicitRead(element) || isImplicitWrite(element); + } + + @Override + public boolean isImplicitRead(@NotNull PsiElement element) { + if (element instanceof PsiMethod) { + PsiMethod method = (PsiMethod)element; + if (isReactiveRoute(method)) { + return true; + } + } + return false; + } + private boolean isReactiveRoute(@NotNull PsiElement element) { + return AnnotationUtils.hasAnyAnnotation(element, ReactiveRouteConstants.ROUTE_FQN); + } + + @Override + public boolean isImplicitWrite(@NotNull PsiElement element) { + return false; + } +} diff --git a/src/main/java/com/redhat/microprofile/psi/internal/quarkus/route/java/ReactiveRouteJaxRsInfoProvider.java b/src/main/java/com/redhat/microprofile/psi/internal/quarkus/route/java/ReactiveRouteJaxRsInfoProvider.java new file mode 100644 index 000000000..c50a62cd9 --- /dev/null +++ b/src/main/java/com/redhat/microprofile/psi/internal/quarkus/route/java/ReactiveRouteJaxRsInfoProvider.java @@ -0,0 +1,159 @@ +/******************************************************************************* + * Copyright (c) 2023 Red Hat Inc. and others. + * All rights reserved. This program and the accompanying materials + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v20.html + * + * SPDX-License-Identifier: EPL-2.0 + * + * Contributors: + * Red Hat Inc. - initial API and implementation + *******************************************************************************/ +package com.redhat.microprofile.psi.internal.quarkus.route.java; + + +import com.intellij.openapi.module.Module; +import com.intellij.openapi.progress.ProcessCanceledException; +import com.intellij.openapi.progress.ProgressIndicator; +import com.intellij.psi.*; +import com.intellij.util.KeyedLazyInstanceEP; +import com.redhat.devtools.intellij.lsp4ij.LSPIJUtils; +import com.redhat.devtools.intellij.lsp4mp4ij.psi.core.jaxrs.*; +import com.redhat.devtools.intellij.lsp4mp4ij.psi.core.utils.IPsiUtils; +import com.redhat.devtools.intellij.lsp4mp4ij.psi.core.utils.PsiTypeUtils; + +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; +import java.util.Set; +import java.util.logging.Level; +import java.util.logging.Logger; + +import static com.redhat.devtools.intellij.lsp4mp4ij.psi.core.utils.PsiTypeUtils.overlaps; +import static com.redhat.microprofile.psi.internal.quarkus.route.java.ReactiveRouteConstants.ROUTE_FQN; + +/** + * Use custom logic for all JAX-RS features for Reactive @Route. + * + * @see https://quarkus.io/guides/reactive-routes#declaring-reactive-routes + */ +public class ReactiveRouteJaxRsInfoProvider extends KeyedLazyInstanceEP implements IJaxRsInfoProvider { + + private static final Logger LOGGER = Logger.getLogger(ReactiveRouteJaxRsInfoProvider.class.getName()); + + @Override + public boolean canProvideJaxRsMethodInfoForClass(PsiFile typeRoot, Module javaProject, ProgressIndicator monitor) { + return PsiTypeUtils.findType(javaProject, ROUTE_FQN) != null; + } + + @Override + public Set getAllJaxRsClasses(Module javaProject, ProgressIndicator monitor) { + // TODO: implement when LSP4IJ will support workspace symbols + return Collections.emptySet(); + } + + @Override + public List getJaxRsMethodInfo(PsiFile typeRoot, JaxRsContext jaxrsContext, IPsiUtils utils, + ProgressIndicator monitor) { + try { + PsiClass type = findFirstClass(typeRoot); + if (type == null) { + return Collections.emptyList(); + } + // See https://quarkus.io/guides/reactive-routes#routebase + // Try to get the @RouteBase declared in the Java type + + PsiAnnotation routeBaseAnnotation = ReactiveRouteUtils.getRouteBaseAnnotation(type); + String pathSegment = routeBaseAnnotation != null ? ReactiveRouteUtils.getRouteBasePath(routeBaseAnnotation) : null; + + List methodInfos = new ArrayList<>(); + for (PsiMethod method : type.getMethods()) { + + if (method.isConstructor() || utils.isHiddenGeneratedElement(method)) { + continue; + } + // ignore element if method range overlaps the type range, + // happens for generated + // bytecode, i.e. with lombok + if (overlaps(type.getNameIdentifier().getTextRange(), method.getNameIdentifier().getTextRange())) { + continue; + } + + // A route method must be a non-private non-static method of a CDI bean. + // See https://quarkus.io/guides/reactive-routes#reactive-route-methods + if (!method.getModifierList().hasExplicitModifier(PsiModifier.PRIVATE) && !method.getModifierList().hasExplicitModifier(PsiModifier.STATIC)) { + + // Method can have several @Route + // @Route(path = "/first") + // @Route(path = "/second") + // public void route(RoutingContext rc) { + // // ... + List routeAnnotations = ReactiveRouteUtils.getRouteAnnotations(method); + if (routeAnnotations.isEmpty()) { + continue; + } + + // Loop for @Route annotation + for (PsiAnnotation routeAnnotation : routeAnnotations) { + // @Route(path = "/first") + String methodSegment = ReactiveRouteUtils.getRoutePath(routeAnnotation); + if (methodSegment == null) { + // @Route(methods = Route.HttpMethod.GET) + // void hello(RoutingContext rc) + // Here the segment is the method name + methodSegment = method.getName(); + } + String path; + if (pathSegment == null) { + path = methodSegment; + } else { + path = JaxRsUtils.buildURL(pathSegment, methodSegment); + } + String url = JaxRsUtils.buildURL(jaxrsContext.getLocalBaseURL(), path); + + JaxRsMethodInfo methodInfo = createMethodInfo(method, routeAnnotation, url); + if (methodInfo != null) { + methodInfos.add(methodInfo); + } + } + } + } + return methodInfos; + } catch (ProcessCanceledException e) { + throw e; + } catch (Exception e) { + LOGGER.log(Level.SEVERE, "Error while collecting JAX-RS methods for Reactive @Route", e); + return Collections.emptyList(); + } + } + + private PsiClass findFirstClass(PsiFile typeRoot) { + for (PsiElement element : typeRoot.getChildren()) { + if (element instanceof PsiClass) { + return (PsiClass) element; + } + } + return null; + } + + private static JaxRsMethodInfo createMethodInfo(PsiMethod method, PsiAnnotation routeAnnotation, String url) { + + PsiFile resource = method.getContainingFile(); + if (resource == null) { + return null; + } + String documentUri = LSPIJUtils.toUriAsString(resource); + + HttpMethod httpMethod = HttpMethod.GET; + // TODO: collect the proper http method from @Route(methods=) + /*for (String methodAnnotationFQN : JaxRsConstants.HTTP_METHOD_ANNOTATIONS) { + if (hasAnnotation(method, methodAnnotationFQN)) { + httpMethod = ReactiveRouteUtils.getHttpMethodForAnnotation(methodAnnotationFQN); + break; + } + }*/ + + return new JaxRsMethodInfo(url, httpMethod, method, documentUri); + } + +} \ No newline at end of file diff --git a/src/main/java/com/redhat/microprofile/psi/internal/quarkus/route/java/ReactiveRouteUtils.java b/src/main/java/com/redhat/microprofile/psi/internal/quarkus/route/java/ReactiveRouteUtils.java new file mode 100644 index 000000000..e74aaf284 --- /dev/null +++ b/src/main/java/com/redhat/microprofile/psi/internal/quarkus/route/java/ReactiveRouteUtils.java @@ -0,0 +1,86 @@ +/******************************************************************************* +* Copyright (c) 2023 Red Hat Inc. and others. +* +* This program and the accompanying materials are made available under the +* terms of the Eclipse Public License v. 2.0 which is available at +* http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0 +* which is available at https://www.apache.org/licenses/LICENSE-2.0. +* +* SPDX-License-Identifier: EPL-2.0 OR Apache-2.0 +* +* Contributors: +* Red Hat Inc. - initial API and implementation +*******************************************************************************/ +package com.redhat.microprofile.psi.internal.quarkus.route.java; + +import com.intellij.psi.PsiAnnotation; +import com.intellij.psi.PsiElement; +import com.redhat.devtools.intellij.lsp4mp4ij.psi.core.jaxrs.HttpMethod; +import com.redhat.devtools.intellij.lsp4mp4ij.psi.core.jaxrs.JaxRsConstants; + +import java.util.List; + +import static com.redhat.devtools.intellij.lsp4mp4ij.psi.core.utils.AnnotationUtils.*; +import static com.redhat.microprofile.psi.internal.quarkus.route.java.ReactiveRouteConstants.*; + + +/** + * Reactive @Route utilities. + * + * @see https://quarkus.io/guides/reactive-routes#declaring-reactive-routes + */ +public class ReactiveRouteUtils { + + private ReactiveRouteUtils() { + + } + + public static PsiAnnotation getRouteBaseAnnotation(PsiElement annotatable) { + return getFirstAnnotation(annotatable, ROUTE_BASE_FQN); + } + + public static String getRouteBasePath(PsiAnnotation routeBaseAnnotation) { + return getAnnotationMemberValue(routeBaseAnnotation, ROUTE_BASE_PATH); + } + + public static List getRouteAnnotations(PsiElement annotatable) { + return getAllAnnotations(annotatable, ROUTE_FQN); + } + + public static String getRoutePath(PsiAnnotation routeAnnotation) { + return getAnnotationMemberValue(routeAnnotation, ROUTE_PATH); + } + + /** + * Returns an HttpMethod given the FQN of a JAX-RS or Jakarta RESTful + * annotation, nor null if the FQN doesn't match any HttpMethod. + * + * @param annotationFQN the FQN of the annotation to convert into a HttpMethod + * @return an HttpMethod given the FQN of a JAX-RS or Jakarta RESTful + * annotation, nor null if the FQN doesn't match any HttpMethod + */ + public static HttpMethod getHttpMethodForAnnotation(String annotationFQN) { + switch (annotationFQN) { + case ReactiveRouteConstants.REACTIVE_ROUTE_GET_ANNOTATION: + case JaxRsConstants.JAVAX_WS_RS_GET_ANNOTATION: + return HttpMethod.GET; + case JaxRsConstants.JAKARTA_WS_RS_HEAD_ANNOTATION: + case JaxRsConstants.JAVAX_WS_RS_HEAD_ANNOTATION: + return HttpMethod.HEAD; + case JaxRsConstants.JAKARTA_WS_RS_POST_ANNOTATION: + case JaxRsConstants.JAVAX_WS_RS_POST_ANNOTATION: + return HttpMethod.POST; + case JaxRsConstants.JAKARTA_WS_RS_PUT_ANNOTATION: + case JaxRsConstants.JAVAX_WS_RS_PUT_ANNOTATION: + return HttpMethod.PUT; + case JaxRsConstants.JAKARTA_WS_RS_DELETE_ANNOTATION: + case JaxRsConstants.JAVAX_WS_RS_DELETE_ANNOTATION: + return HttpMethod.DELETE; + case JaxRsConstants.JAKARTA_WS_RS_PATCH_ANNOTATION: + case JaxRsConstants.JAVAX_WS_RS_PATCH_ANNOTATION: + return HttpMethod.PATCH; + default: + return null; + } + } +} diff --git a/src/main/resources/META-INF/lsp4ij-quarkus.xml b/src/main/resources/META-INF/lsp4ij-quarkus.xml index 30b6a7ee5..20de85dbf 100644 --- a/src/main/resources/META-INF/lsp4ij-quarkus.xml +++ b/src/main/resources/META-INF/lsp4ij-quarkus.xml @@ -46,6 +46,8 @@ + + +