From a3db67696ce6af846856099d033ff48404191086 Mon Sep 17 00:00:00 2001 From: Andreas Dinauer Date: Sat, 14 Feb 2026 20:14:23 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=8E=89=20Init?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .dockerignore | 5 + .gitignore | 45 +++ .mvn/wrapper/maven-wrapper.properties | 3 + Jenkinsfile | 45 +++ README.md | 77 +++++ mappings/healthcheck.json | 13 + mvnw | 295 ++++++++++++++++++ mvnw.cmd | 189 +++++++++++ pom.xml | 144 +++++++++ postgres.yaml | 20 ++ src/main/docker/Dockerfile.jvm | 100 ++++++ src/main/docker/Dockerfile.legacy-jar | 96 ++++++ src/main/docker/Dockerfile.native | 29 ++ src/main/docker/Dockerfile.native-micro | 32 ++ src/main/java/dev/dinauer/pingo/Core.java | 120 +++++++ .../java/dev/dinauer/pingo/PingService.java | 50 +++ .../java/dev/dinauer/pingo/config/Config.java | 7 + .../java/dev/dinauer/pingo/config/Group.java | 7 + .../dev/dinauer/pingo/config/Healthcheck.java | 5 + .../dev/dinauer/pingo/config/Request.java | 5 + .../java/dev/dinauer/pingo/config/Target.java | 45 +++ .../java/dev/dinauer/pingo/group/Group.java | 9 + .../dev/dinauer/pingo/group/GroupEntity.java | 54 ++++ .../dev/dinauer/pingo/group/GroupRepo.java | 9 + .../dinauer/pingo/group/GroupResource.java | 20 ++ .../dev/dinauer/pingo/group/GroupService.java | 39 +++ .../dev/dinauer/pingo/ping/PingEntity.java | 97 ++++++ .../java/dev/dinauer/pingo/ping/PingRepo.java | 31 ++ .../dev/dinauer/pingo/ping/PingResult.java | 6 + src/main/resources/application.properties | 10 + src/main/resources/config.yml | 42 +++ src/main/resources/import.sql | 6 + 32 files changed, 1655 insertions(+) create mode 100644 .dockerignore create mode 100644 .gitignore create mode 100644 .mvn/wrapper/maven-wrapper.properties create mode 100644 Jenkinsfile create mode 100644 README.md create mode 100644 mappings/healthcheck.json create mode 100755 mvnw create mode 100755 mvnw.cmd create mode 100644 pom.xml create mode 100644 postgres.yaml create mode 100644 src/main/docker/Dockerfile.jvm create mode 100644 src/main/docker/Dockerfile.legacy-jar create mode 100644 src/main/docker/Dockerfile.native create mode 100644 src/main/docker/Dockerfile.native-micro create mode 100644 src/main/java/dev/dinauer/pingo/Core.java create mode 100644 src/main/java/dev/dinauer/pingo/PingService.java create mode 100644 src/main/java/dev/dinauer/pingo/config/Config.java create mode 100644 src/main/java/dev/dinauer/pingo/config/Group.java create mode 100644 src/main/java/dev/dinauer/pingo/config/Healthcheck.java create mode 100644 src/main/java/dev/dinauer/pingo/config/Request.java create mode 100644 src/main/java/dev/dinauer/pingo/config/Target.java create mode 100644 src/main/java/dev/dinauer/pingo/group/Group.java create mode 100644 src/main/java/dev/dinauer/pingo/group/GroupEntity.java create mode 100644 src/main/java/dev/dinauer/pingo/group/GroupRepo.java create mode 100644 src/main/java/dev/dinauer/pingo/group/GroupResource.java create mode 100644 src/main/java/dev/dinauer/pingo/group/GroupService.java create mode 100644 src/main/java/dev/dinauer/pingo/ping/PingEntity.java create mode 100644 src/main/java/dev/dinauer/pingo/ping/PingRepo.java create mode 100644 src/main/java/dev/dinauer/pingo/ping/PingResult.java create mode 100644 src/main/resources/application.properties create mode 100644 src/main/resources/config.yml create mode 100644 src/main/resources/import.sql diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..94810d0 --- /dev/null +++ b/.dockerignore @@ -0,0 +1,5 @@ +* +!target/*-runner +!target/*-runner.jar +!target/lib/* +!target/quarkus-app/* \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..91a800a --- /dev/null +++ b/.gitignore @@ -0,0 +1,45 @@ +#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/ +# TLS Certificates +.certs/ diff --git a/.mvn/wrapper/maven-wrapper.properties b/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 0000000..8dea6c2 --- /dev/null +++ b/.mvn/wrapper/maven-wrapper.properties @@ -0,0 +1,3 @@ +wrapperVersion=3.3.4 +distributionType=only-script +distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.12/apache-maven-3.9.12-bin.zip diff --git a/Jenkinsfile b/Jenkinsfile new file mode 100644 index 0000000..9010ec3 --- /dev/null +++ b/Jenkinsfile @@ -0,0 +1,45 @@ +pipeline { + agent any + + stages { + stage('Set Image Name') { + steps { + script { + env.IMAGE = "harbor.dinauer.dev/pingo/backend:${env.BUILD_NUMBER}"; + } + } + } + stage('Build Quarkus application') { + steps { + script { + sh 'mvn clean install' + } + } + } + stage('Build Docker Image') { + steps { + script { + sh "docker build --no-cache -t ${env.IMAGE} ." + } + } + } + stage('Push Image to Docker Hub') { + steps { + script { + withCredentials([usernamePassword(credentialsId: 'harbor', usernameVariable: 'USERNAME', passwordVariable: 'PASSWORD')]) { + sh 'echo ${PASSWORD} | docker login harbor.dinauer.dev -u ${USERNAME} --password-stdin' + sh "docker push ${env.IMAGE}" + sh "docker logout" + } + } + } + } + stage('Remove image from host') { + steps { + script { + sh "docker image rm --force ${env.IMAGE}" + } + } + } + } +} \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..b851752 --- /dev/null +++ b/README.md @@ -0,0 +1,77 @@ +# backend + +This project uses Quarkus, the Supersonic Subatomic Java Framework. + +If you want to learn more about Quarkus, please visit its website: . + +## Running the application in dev mode + +You can run your application in dev mode that enables live coding using: + +```shell script +./mvnw quarkus:dev +``` + +> **_NOTE:_** Quarkus now ships with a Dev UI, which is available in dev mode only at . + +## 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.jar.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/backend-1.0.0-SNAPSHOT-runner` + +If you want to learn more about building native executables, please consult . + +## Related Guides + +- REST ([guide](https://quarkus.io/guides/rest)): A Jakarta REST implementation utilizing build time processing and Vert.x. This extension is not compatible with the quarkus-resteasy extension, or any of the extensions that depend on it. +- Hibernate ORM with Panache ([guide](https://quarkus.io/guides/hibernate-orm-panache)): Simplify your persistence code for Hibernate ORM via the active record or the repository pattern +- JDBC Driver - PostgreSQL ([guide](https://quarkus.io/guides/datasource)): Connect to the PostgreSQL database via JDBC + +## Provided Code + +### Hibernate ORM + +Create your first JPA entity + +[Related guide section...](https://quarkus.io/guides/hibernate-orm) + +[Related Hibernate with Panache section...](https://quarkus.io/guides/hibernate-orm-panache) + + +### REST + +Easily start your REST Web Services + +[Related guide section...](https://quarkus.io/guides/getting-started-reactive#reactive-jax-rs-resources) diff --git a/mappings/healthcheck.json b/mappings/healthcheck.json new file mode 100644 index 0000000..8dffe8e --- /dev/null +++ b/mappings/healthcheck.json @@ -0,0 +1,13 @@ +{ + "request": { + "method": "GET", + "url": "/health" + }, + "response": { + "status": 400, + "body": "{\"status\": \"DOWN\"}", + "headers": { + "Content-Type": "application/json" + } + } +} diff --git a/mvnw b/mvnw new file mode 100755 index 0000000..bd8896b --- /dev/null +++ b/mvnw @@ -0,0 +1,295 @@ +#!/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.3.4 +# +# Optional ENV vars +# ----------------- +# JAVA_HOME - location of a JDK home dir, required when download maven via java source +# MVNW_REPOURL - repo url base for downloading maven distribution +# MVNW_USERNAME/MVNW_PASSWORD - user and password for downloading maven +# MVNW_VERBOSE - true: enable verbose log; debug: trace the mvnw script; others: silence the output +# ---------------------------------------------------------------------------- + +set -euf +[ "${MVNW_VERBOSE-}" != debug ] || set -x + +# OS specific support. +native_path() { printf %s\\n "$1"; } +case "$(uname)" in +CYGWIN* | MINGW*) + [ -z "${JAVA_HOME-}" ] || JAVA_HOME="$(cygpath --unix "$JAVA_HOME")" + native_path() { cygpath --path --windows "$1"; } + ;; +esac + +# set JAVACMD and JAVACCMD +set_java_home() { + # For Cygwin and MinGW, ensure paths are in Unix format before anything is touched + 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" + JAVACCMD="$JAVA_HOME/jre/sh/javac" + else + JAVACMD="$JAVA_HOME/bin/java" + JAVACCMD="$JAVA_HOME/bin/javac" + + if [ ! -x "$JAVACMD" ] || [ ! -x "$JAVACCMD" ]; then + echo "The JAVA_HOME environment variable is not defined correctly, so mvnw cannot run." >&2 + echo "JAVA_HOME is set to \"$JAVA_HOME\", but \"\$JAVA_HOME/bin/java\" or \"\$JAVA_HOME/bin/javac\" does not exist." >&2 + return 1 + fi + fi + else + JAVACMD="$( + 'set' +e + 'unset' -f command 2>/dev/null + 'command' -v java + )" || : + JAVACCMD="$( + 'set' +e + 'unset' -f command 2>/dev/null + 'command' -v javac + )" || : + + if [ ! -x "${JAVACMD-}" ] || [ ! -x "${JAVACCMD-}" ]; then + echo "The java/javac command does not exist in PATH nor is JAVA_HOME set, so mvnw cannot run." >&2 + return 1 + fi + fi +} + +# hash string like Java String::hashCode +hash_string() { + str="${1:-}" h=0 + while [ -n "$str" ]; do + char="${str%"${str#?}"}" + h=$(((h * 31 + $(LC_CTYPE=C printf %d "'$char")) % 4294967296)) + str="${str#?}" + done + printf %x\\n $h +} + +verbose() { :; } +[ "${MVNW_VERBOSE-}" != true ] || verbose() { printf %s\\n "${1-}"; } + +die() { + printf %s\\n "$1" >&2 + exit 1 +} + +trim() { + # MWRAPPER-139: + # Trims trailing and leading whitespace, carriage returns, tabs, and linefeeds. + # Needed for removing poorly interpreted newline sequences when running in more + # exotic environments such as mingw bash on Windows. + printf "%s" "${1}" | tr -d '[:space:]' +} + +scriptDir="$(dirname "$0")" +scriptName="$(basename "$0")" + +# parse distributionUrl and optional distributionSha256Sum, requires .mvn/wrapper/maven-wrapper.properties +while IFS="=" read -r key value; do + case "${key-}" in + distributionUrl) distributionUrl=$(trim "${value-}") ;; + distributionSha256Sum) distributionSha256Sum=$(trim "${value-}") ;; + esac +done <"$scriptDir/.mvn/wrapper/maven-wrapper.properties" +[ -n "${distributionUrl-}" ] || die "cannot read distributionUrl property in $scriptDir/.mvn/wrapper/maven-wrapper.properties" + +case "${distributionUrl##*/}" in +maven-mvnd-*bin.*) + MVN_CMD=mvnd.sh _MVNW_REPO_PATTERN=/maven/mvnd/ + case "${PROCESSOR_ARCHITECTURE-}${PROCESSOR_ARCHITEW6432-}:$(uname -a)" in + *AMD64:CYGWIN* | *AMD64:MINGW*) distributionPlatform=windows-amd64 ;; + :Darwin*x86_64) distributionPlatform=darwin-amd64 ;; + :Darwin*arm64) distributionPlatform=darwin-aarch64 ;; + :Linux*x86_64*) distributionPlatform=linux-amd64 ;; + *) + echo "Cannot detect native platform for mvnd on $(uname)-$(uname -m), use pure java version" >&2 + distributionPlatform=linux-amd64 + ;; + esac + distributionUrl="${distributionUrl%-bin.*}-$distributionPlatform.zip" + ;; +maven-mvnd-*) MVN_CMD=mvnd.sh _MVNW_REPO_PATTERN=/maven/mvnd/ ;; +*) MVN_CMD="mvn${scriptName#mvnw}" _MVNW_REPO_PATTERN=/org/apache/maven/ ;; +esac + +# apply MVNW_REPOURL and calculate MAVEN_HOME +# maven home pattern: ~/.m2/wrapper/dists/{apache-maven-,maven-mvnd--}/ +[ -z "${MVNW_REPOURL-}" ] || distributionUrl="$MVNW_REPOURL$_MVNW_REPO_PATTERN${distributionUrl#*"$_MVNW_REPO_PATTERN"}" +distributionUrlName="${distributionUrl##*/}" +distributionUrlNameMain="${distributionUrlName%.*}" +distributionUrlNameMain="${distributionUrlNameMain%-bin}" +MAVEN_USER_HOME="${MAVEN_USER_HOME:-${HOME}/.m2}" +MAVEN_HOME="${MAVEN_USER_HOME}/wrapper/dists/${distributionUrlNameMain-}/$(hash_string "$distributionUrl")" + +exec_maven() { + unset MVNW_VERBOSE MVNW_USERNAME MVNW_PASSWORD MVNW_REPOURL || : + exec "$MAVEN_HOME/bin/$MVN_CMD" "$@" || die "cannot exec $MAVEN_HOME/bin/$MVN_CMD" +} + +if [ -d "$MAVEN_HOME" ]; then + verbose "found existing MAVEN_HOME at $MAVEN_HOME" + exec_maven "$@" +fi + +case "${distributionUrl-}" in +*?-bin.zip | *?maven-mvnd-?*-?*.zip) ;; +*) die "distributionUrl is not valid, must match *-bin.zip or maven-mvnd-*.zip, but found '${distributionUrl-}'" ;; +esac + +# prepare tmp dir +if TMP_DOWNLOAD_DIR="$(mktemp -d)" && [ -d "$TMP_DOWNLOAD_DIR" ]; then + clean() { rm -rf -- "$TMP_DOWNLOAD_DIR"; } + trap clean HUP INT TERM EXIT +else + die "cannot create temp dir" +fi + +mkdir -p -- "${MAVEN_HOME%/*}" + +# Download and Install Apache Maven +verbose "Couldn't find MAVEN_HOME, downloading and installing it ..." +verbose "Downloading from: $distributionUrl" +verbose "Downloading to: $TMP_DOWNLOAD_DIR/$distributionUrlName" + +# select .zip or .tar.gz +if ! command -v unzip >/dev/null; then + distributionUrl="${distributionUrl%.zip}.tar.gz" + distributionUrlName="${distributionUrl##*/}" +fi + +# verbose opt +__MVNW_QUIET_WGET=--quiet __MVNW_QUIET_CURL=--silent __MVNW_QUIET_UNZIP=-q __MVNW_QUIET_TAR='' +[ "${MVNW_VERBOSE-}" != true ] || __MVNW_QUIET_WGET='' __MVNW_QUIET_CURL='' __MVNW_QUIET_UNZIP='' __MVNW_QUIET_TAR=v + +# normalize http auth +case "${MVNW_PASSWORD:+has-password}" in +'') MVNW_USERNAME='' MVNW_PASSWORD='' ;; +has-password) [ -n "${MVNW_USERNAME-}" ] || MVNW_USERNAME='' MVNW_PASSWORD='' ;; +esac + +if [ -z "${MVNW_USERNAME-}" ] && command -v wget >/dev/null; then + verbose "Found wget ... using wget" + wget ${__MVNW_QUIET_WGET:+"$__MVNW_QUIET_WGET"} "$distributionUrl" -O "$TMP_DOWNLOAD_DIR/$distributionUrlName" || die "wget: Failed to fetch $distributionUrl" +elif [ -z "${MVNW_USERNAME-}" ] && command -v curl >/dev/null; then + verbose "Found curl ... using curl" + curl ${__MVNW_QUIET_CURL:+"$__MVNW_QUIET_CURL"} -f -L -o "$TMP_DOWNLOAD_DIR/$distributionUrlName" "$distributionUrl" || die "curl: Failed to fetch $distributionUrl" +elif set_java_home; then + verbose "Falling back to use Java to download" + javaSource="$TMP_DOWNLOAD_DIR/Downloader.java" + targetZip="$TMP_DOWNLOAD_DIR/$distributionUrlName" + cat >"$javaSource" <<-END + public class Downloader extends java.net.Authenticator + { + protected java.net.PasswordAuthentication getPasswordAuthentication() + { + return new java.net.PasswordAuthentication( System.getenv( "MVNW_USERNAME" ), System.getenv( "MVNW_PASSWORD" ).toCharArray() ); + } + public static void main( String[] args ) throws Exception + { + setDefault( new Downloader() ); + java.nio.file.Files.copy( java.net.URI.create( args[0] ).toURL().openStream(), java.nio.file.Paths.get( args[1] ).toAbsolutePath().normalize() ); + } + } + END + # For Cygwin/MinGW, switch paths to Windows format before running javac and java + verbose " - Compiling Downloader.java ..." + "$(native_path "$JAVACCMD")" "$(native_path "$javaSource")" || die "Failed to compile Downloader.java" + verbose " - Running Downloader.java ..." + "$(native_path "$JAVACMD")" -cp "$(native_path "$TMP_DOWNLOAD_DIR")" Downloader "$distributionUrl" "$(native_path "$targetZip")" +fi + +# If specified, validate the SHA-256 sum of the Maven distribution zip file +if [ -n "${distributionSha256Sum-}" ]; then + distributionSha256Result=false + if [ "$MVN_CMD" = mvnd.sh ]; then + echo "Checksum validation is not supported for maven-mvnd." >&2 + echo "Please disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." >&2 + exit 1 + elif command -v sha256sum >/dev/null; then + if echo "$distributionSha256Sum $TMP_DOWNLOAD_DIR/$distributionUrlName" | sha256sum -c - >/dev/null 2>&1; then + distributionSha256Result=true + fi + elif command -v shasum >/dev/null; then + if echo "$distributionSha256Sum $TMP_DOWNLOAD_DIR/$distributionUrlName" | shasum -a 256 -c >/dev/null 2>&1; then + distributionSha256Result=true + fi + else + echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available." >&2 + echo "Please install either command, or disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." >&2 + exit 1 + fi + if [ $distributionSha256Result = false ]; then + echo "Error: Failed to validate Maven distribution SHA-256, your Maven distribution might be compromised." >&2 + echo "If you updated your Maven version, you need to update the specified distributionSha256Sum property." >&2 + exit 1 + fi +fi + +# unzip and move +if command -v unzip >/dev/null; then + unzip ${__MVNW_QUIET_UNZIP:+"$__MVNW_QUIET_UNZIP"} "$TMP_DOWNLOAD_DIR/$distributionUrlName" -d "$TMP_DOWNLOAD_DIR" || die "failed to unzip" +else + tar xzf${__MVNW_QUIET_TAR:+"$__MVNW_QUIET_TAR"} "$TMP_DOWNLOAD_DIR/$distributionUrlName" -C "$TMP_DOWNLOAD_DIR" || die "failed to untar" +fi + +# Find the actual extracted directory name (handles snapshots where filename != directory name) +actualDistributionDir="" + +# First try the expected directory name (for regular distributions) +if [ -d "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain" ]; then + if [ -f "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain/bin/$MVN_CMD" ]; then + actualDistributionDir="$distributionUrlNameMain" + fi +fi + +# If not found, search for any directory with the Maven executable (for snapshots) +if [ -z "$actualDistributionDir" ]; then + # enable globbing to iterate over items + set +f + for dir in "$TMP_DOWNLOAD_DIR"/*; do + if [ -d "$dir" ]; then + if [ -f "$dir/bin/$MVN_CMD" ]; then + actualDistributionDir="$(basename "$dir")" + break + fi + fi + done + set -f +fi + +if [ -z "$actualDistributionDir" ]; then + verbose "Contents of $TMP_DOWNLOAD_DIR:" + verbose "$(ls -la "$TMP_DOWNLOAD_DIR")" + die "Could not find Maven distribution directory in extracted archive" +fi + +verbose "Found extracted Maven distribution directory: $actualDistributionDir" +printf %s\\n "$distributionUrl" >"$TMP_DOWNLOAD_DIR/$actualDistributionDir/mvnw.url" +mv -- "$TMP_DOWNLOAD_DIR/$actualDistributionDir" "$MAVEN_HOME" || [ -d "$MAVEN_HOME" ] || die "fail to move MAVEN_HOME" + +clean || : +exec_maven "$@" diff --git a/mvnw.cmd b/mvnw.cmd new file mode 100755 index 0000000..92450f9 --- /dev/null +++ b/mvnw.cmd @@ -0,0 +1,189 @@ +<# : batch portion +@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.3.4 +@REM +@REM Optional ENV vars +@REM MVNW_REPOURL - repo url base for downloading maven distribution +@REM MVNW_USERNAME/MVNW_PASSWORD - user and password for downloading maven +@REM MVNW_VERBOSE - true: enable verbose log; others: silence the output +@REM ---------------------------------------------------------------------------- + +@IF "%__MVNW_ARG0_NAME__%"=="" (SET __MVNW_ARG0_NAME__=%~nx0) +@SET __MVNW_CMD__= +@SET __MVNW_ERROR__= +@SET __MVNW_PSMODULEP_SAVE=%PSModulePath% +@SET PSModulePath= +@FOR /F "usebackq tokens=1* delims==" %%A IN (`powershell -noprofile "& {$scriptDir='%~dp0'; $script='%__MVNW_ARG0_NAME__%'; icm -ScriptBlock ([Scriptblock]::Create((Get-Content -Raw '%~f0'))) -NoNewScope}"`) DO @( + IF "%%A"=="MVN_CMD" (set __MVNW_CMD__=%%B) ELSE IF "%%B"=="" (echo %%A) ELSE (echo %%A=%%B) +) +@SET PSModulePath=%__MVNW_PSMODULEP_SAVE% +@SET __MVNW_PSMODULEP_SAVE= +@SET __MVNW_ARG0_NAME__= +@SET MVNW_USERNAME= +@SET MVNW_PASSWORD= +@IF NOT "%__MVNW_CMD__%"=="" ("%__MVNW_CMD__%" %*) +@echo Cannot start maven from wrapper >&2 && exit /b 1 +@GOTO :EOF +: end batch / begin powershell #> + +$ErrorActionPreference = "Stop" +if ($env:MVNW_VERBOSE -eq "true") { + $VerbosePreference = "Continue" +} + +# calculate distributionUrl, requires .mvn/wrapper/maven-wrapper.properties +$distributionUrl = (Get-Content -Raw "$scriptDir/.mvn/wrapper/maven-wrapper.properties" | ConvertFrom-StringData).distributionUrl +if (!$distributionUrl) { + Write-Error "cannot read distributionUrl property in $scriptDir/.mvn/wrapper/maven-wrapper.properties" +} + +switch -wildcard -casesensitive ( $($distributionUrl -replace '^.*/','') ) { + "maven-mvnd-*" { + $USE_MVND = $true + $distributionUrl = $distributionUrl -replace '-bin\.[^.]*$',"-windows-amd64.zip" + $MVN_CMD = "mvnd.cmd" + break + } + default { + $USE_MVND = $false + $MVN_CMD = $script -replace '^mvnw','mvn' + break + } +} + +# apply MVNW_REPOURL and calculate MAVEN_HOME +# maven home pattern: ~/.m2/wrapper/dists/{apache-maven-,maven-mvnd--}/ +if ($env:MVNW_REPOURL) { + $MVNW_REPO_PATTERN = if ($USE_MVND -eq $False) { "/org/apache/maven/" } else { "/maven/mvnd/" } + $distributionUrl = "$env:MVNW_REPOURL$MVNW_REPO_PATTERN$($distributionUrl -replace "^.*$MVNW_REPO_PATTERN",'')" +} +$distributionUrlName = $distributionUrl -replace '^.*/','' +$distributionUrlNameMain = $distributionUrlName -replace '\.[^.]*$','' -replace '-bin$','' + +$MAVEN_M2_PATH = "$HOME/.m2" +if ($env:MAVEN_USER_HOME) { + $MAVEN_M2_PATH = "$env:MAVEN_USER_HOME" +} + +if (-not (Test-Path -Path $MAVEN_M2_PATH)) { + New-Item -Path $MAVEN_M2_PATH -ItemType Directory | Out-Null +} + +$MAVEN_WRAPPER_DISTS = $null +if ((Get-Item $MAVEN_M2_PATH).Target[0] -eq $null) { + $MAVEN_WRAPPER_DISTS = "$MAVEN_M2_PATH/wrapper/dists" +} else { + $MAVEN_WRAPPER_DISTS = (Get-Item $MAVEN_M2_PATH).Target[0] + "/wrapper/dists" +} + +$MAVEN_HOME_PARENT = "$MAVEN_WRAPPER_DISTS/$distributionUrlNameMain" +$MAVEN_HOME_NAME = ([System.Security.Cryptography.SHA256]::Create().ComputeHash([byte[]][char[]]$distributionUrl) | ForEach-Object {$_.ToString("x2")}) -join '' +$MAVEN_HOME = "$MAVEN_HOME_PARENT/$MAVEN_HOME_NAME" + +if (Test-Path -Path "$MAVEN_HOME" -PathType Container) { + Write-Verbose "found existing MAVEN_HOME at $MAVEN_HOME" + Write-Output "MVN_CMD=$MAVEN_HOME/bin/$MVN_CMD" + exit $? +} + +if (! $distributionUrlNameMain -or ($distributionUrlName -eq $distributionUrlNameMain)) { + Write-Error "distributionUrl is not valid, must end with *-bin.zip, but found $distributionUrl" +} + +# prepare tmp dir +$TMP_DOWNLOAD_DIR_HOLDER = New-TemporaryFile +$TMP_DOWNLOAD_DIR = New-Item -Itemtype Directory -Path "$TMP_DOWNLOAD_DIR_HOLDER.dir" +$TMP_DOWNLOAD_DIR_HOLDER.Delete() | Out-Null +trap { + if ($TMP_DOWNLOAD_DIR.Exists) { + try { Remove-Item $TMP_DOWNLOAD_DIR -Recurse -Force | Out-Null } + catch { Write-Warning "Cannot remove $TMP_DOWNLOAD_DIR" } + } +} + +New-Item -Itemtype Directory -Path "$MAVEN_HOME_PARENT" -Force | Out-Null + +# Download and Install Apache Maven +Write-Verbose "Couldn't find MAVEN_HOME, downloading and installing it ..." +Write-Verbose "Downloading from: $distributionUrl" +Write-Verbose "Downloading to: $TMP_DOWNLOAD_DIR/$distributionUrlName" + +$webclient = New-Object System.Net.WebClient +if ($env:MVNW_USERNAME -and $env:MVNW_PASSWORD) { + $webclient.Credentials = New-Object System.Net.NetworkCredential($env:MVNW_USERNAME, $env:MVNW_PASSWORD) +} +[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 +$webclient.DownloadFile($distributionUrl, "$TMP_DOWNLOAD_DIR/$distributionUrlName") | Out-Null + +# If specified, validate the SHA-256 sum of the Maven distribution zip file +$distributionSha256Sum = (Get-Content -Raw "$scriptDir/.mvn/wrapper/maven-wrapper.properties" | ConvertFrom-StringData).distributionSha256Sum +if ($distributionSha256Sum) { + if ($USE_MVND) { + Write-Error "Checksum validation is not supported for maven-mvnd. `nPlease disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." + } + Import-Module $PSHOME\Modules\Microsoft.PowerShell.Utility -Function Get-FileHash + if ((Get-FileHash "$TMP_DOWNLOAD_DIR/$distributionUrlName" -Algorithm SHA256).Hash.ToLower() -ne $distributionSha256Sum) { + Write-Error "Error: Failed to validate Maven distribution SHA-256, your Maven distribution might be compromised. If you updated your Maven version, you need to update the specified distributionSha256Sum property." + } +} + +# unzip and move +Expand-Archive "$TMP_DOWNLOAD_DIR/$distributionUrlName" -DestinationPath "$TMP_DOWNLOAD_DIR" | Out-Null + +# Find the actual extracted directory name (handles snapshots where filename != directory name) +$actualDistributionDir = "" + +# First try the expected directory name (for regular distributions) +$expectedPath = Join-Path "$TMP_DOWNLOAD_DIR" "$distributionUrlNameMain" +$expectedMvnPath = Join-Path "$expectedPath" "bin/$MVN_CMD" +if ((Test-Path -Path $expectedPath -PathType Container) -and (Test-Path -Path $expectedMvnPath -PathType Leaf)) { + $actualDistributionDir = $distributionUrlNameMain +} + +# If not found, search for any directory with the Maven executable (for snapshots) +if (!$actualDistributionDir) { + Get-ChildItem -Path "$TMP_DOWNLOAD_DIR" -Directory | ForEach-Object { + $testPath = Join-Path $_.FullName "bin/$MVN_CMD" + if (Test-Path -Path $testPath -PathType Leaf) { + $actualDistributionDir = $_.Name + } + } +} + +if (!$actualDistributionDir) { + Write-Error "Could not find Maven distribution directory in extracted archive" +} + +Write-Verbose "Found extracted Maven distribution directory: $actualDistributionDir" +Rename-Item -Path "$TMP_DOWNLOAD_DIR/$actualDistributionDir" -NewName $MAVEN_HOME_NAME | Out-Null +try { + Move-Item -Path "$TMP_DOWNLOAD_DIR/$MAVEN_HOME_NAME" -Destination $MAVEN_HOME_PARENT | Out-Null +} catch { + if (! (Test-Path -Path "$MAVEN_HOME" -PathType Container)) { + Write-Error "fail to move MAVEN_HOME" + } +} finally { + try { Remove-Item $TMP_DOWNLOAD_DIR -Recurse -Force | Out-Null } + catch { Write-Warning "Cannot remove $TMP_DOWNLOAD_DIR" } +} + +Write-Output "MVN_CMD=$MAVEN_HOME/bin/$MVN_CMD" diff --git a/pom.xml b/pom.xml new file mode 100644 index 0000000..482a1fc --- /dev/null +++ b/pom.xml @@ -0,0 +1,144 @@ + + + 4.0.0 + dev.dinauer.pingo + backend + 1.0.0-SNAPSHOT + quarkus + + + 3.14.1 + 25 + UTF-8 + UTF-8 + quarkus-bom + io.quarkus.platform + 3.31.2 + true + 3.5.4 + + + + + + ${quarkus.platform.group-id} + ${quarkus.platform.artifact-id} + ${quarkus.platform.version} + pom + import + + + + + + + io.quarkus + quarkus-rest + + + io.quarkus + quarkus-rest-jackson + + + io.quarkus + quarkus-hibernate-orm-panache + + + io.quarkus + quarkus-jdbc-postgresql + + + io.quarkus + quarkus-arc + + + io.quarkus + quarkus-hibernate-orm + + + org.apache.commons + commons-lang3 + 3.20.0 + + + com.fasterxml.jackson.dataformat + jackson-dataformat-yaml + 2.21.0 + + + io.quarkus + quarkus-junit + test + + + io.rest-assured + rest-assured + test + + + + + + + ${quarkus.platform.group-id} + quarkus-maven-plugin + ${quarkus.platform.version} + true + + + maven-compiler-plugin + ${compiler-plugin.version} + + true + + + + maven-surefire-plugin + ${surefire-plugin.version} + + @{argLine} + + org.jboss.logmanager.LogManager + ${maven.home} + + + + + maven-failsafe-plugin + ${surefire-plugin.version} + + + + integration-test + verify + + + + + @{argLine} + + ${project.build.directory}/${project.build.finalName}-runner + org.jboss.logmanager.LogManager + ${maven.home} + + + + + + + + + native + + + native + + + + false + false + true + + + + diff --git a/postgres.yaml b/postgres.yaml new file mode 100644 index 0000000..be6738c --- /dev/null +++ b/postgres.yaml @@ -0,0 +1,20 @@ +version: "3.9" +services: + postgres: + image: postgres:16 + container_name: dev-postgres + environment: + POSTGRES_DB: postgres + POSTGRES_USER: postgres + POSTGRES_PASSWORD: postgres + ports: + - "5432:5432" + wiremock: + image: wiremock/wiremock:latest + container_name: wiremock + ports: + - "2000:8080" + volumes: + - ./mappings:/home/wiremock/mappings + environment: + - JAVA_OPTS=-Dcom.github.tomakehurst.wiremock.global-response-templating=true \ No newline at end of file diff --git a/src/main/docker/Dockerfile.jvm b/src/main/docker/Dockerfile.jvm new file mode 100644 index 0000000..c26c2de --- /dev/null +++ b/src/main/docker/Dockerfile.jvm @@ -0,0 +1,100 @@ +#### +# 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/backend-jvm . +# +# Then run the container using: +# +# docker run -i --rm -p 8080:8080 quarkus/backend-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/backend-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") - Be aware that this will override +# the default JVM options, use `JAVA_OPTS_APPEND` to append options +# - 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") +# +# You can find more information about the UBI base runtime images and their configuration here: +# https://rh-openjdk.github.io/redhat-openjdk-containers/ +### +FROM registry.access.redhat.com/ubi9/openjdk-25:1.23 + +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_APPEND="-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/src/main/docker/Dockerfile.legacy-jar b/src/main/docker/Dockerfile.legacy-jar new file mode 100644 index 0000000..b70c5f4 --- /dev/null +++ b/src/main/docker/Dockerfile.legacy-jar @@ -0,0 +1,96 @@ +#### +# 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.jar.type=legacy-jar +# +# Then, build the image with: +# +# docker build -f src/main/docker/Dockerfile.legacy-jar -t quarkus/backend-legacy-jar . +# +# Then run the container using: +# +# docker run -i --rm -p 8080:8080 quarkus/backend-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/backend-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") - Be aware that this will override +# the default JVM options, use `JAVA_OPTS_APPEND` to append options +# - 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") +# +# You can find more information about the UBI base runtime images and their configuration here: +# https://rh-openjdk.github.io/redhat-openjdk-containers/ +### +FROM registry.access.redhat.com/ubi9/openjdk-25:1.23 + +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_APPEND="-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/src/main/docker/Dockerfile.native b/src/main/docker/Dockerfile.native new file mode 100644 index 0000000..c6f6324 --- /dev/null +++ b/src/main/docker/Dockerfile.native @@ -0,0 +1,29 @@ +#### +# 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/backend . +# +# Then run the container using: +# +# docker run -i --rm -p 8080:8080 quarkus/backend +# +# The ` registry.access.redhat.com/ubi9/ubi-minimal:9.7` base image is based on UBI 9. +# To use UBI 8, switch to `quay.io/ubi8/ubi-minimal:8.10`. +### +FROM registry.access.redhat.com/ubi9/ubi-minimal:9.7 +WORKDIR /work/ +RUN chown 1001 /work \ + && chmod "g+rwX" /work \ + && chown 1001:root /work +COPY --chown=1001:root --chmod=0755 target/*-runner /work/application + +EXPOSE 8080 +USER 1001 + +ENTRYPOINT ["./application", "-Dquarkus.http.host=0.0.0.0"] diff --git a/src/main/docker/Dockerfile.native-micro b/src/main/docker/Dockerfile.native-micro new file mode 100644 index 0000000..0df45fe --- /dev/null +++ b/src/main/docker/Dockerfile.native-micro @@ -0,0 +1,32 @@ +#### +# 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/backend . +# +# Then run the container using: +# +# docker run -i --rm -p 8080:8080 quarkus/backend +# +# The `quay.io/quarkus/ubi9-quarkus-micro-image:2.0` base image is based on UBI 9. +# To use UBI 8, switch to `quay.io/quarkus/quarkus-micro-image:2.0`. +### +FROM quay.io/quarkus/ubi9-quarkus-micro-image:2.0 +WORKDIR /work/ +RUN chown 1001 /work \ + && chmod "g+rwX" /work \ + && chown 1001:root /work +COPY --chown=1001:root --chmod=0755 target/*-runner /work/application + +EXPOSE 8080 +USER 1001 + +ENTRYPOINT ["./application", "-Dquarkus.http.host=0.0.0.0"] diff --git a/src/main/java/dev/dinauer/pingo/Core.java b/src/main/java/dev/dinauer/pingo/Core.java new file mode 100644 index 0000000..a80eab0 --- /dev/null +++ b/src/main/java/dev/dinauer/pingo/Core.java @@ -0,0 +1,120 @@ +package dev.dinauer.pingo; + +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.dataformat.yaml.YAMLFactory; +import dev.dinauer.pingo.config.Group; +import dev.dinauer.pingo.group.GroupEntity; +import dev.dinauer.pingo.group.GroupService; +import dev.dinauer.pingo.ping.PingResult; +import dev.dinauer.pingo.config.Config; +import dev.dinauer.pingo.config.Healthcheck; +import dev.dinauer.pingo.target.HealthcheckEntity; +import dev.dinauer.pingo.target.HealthcheckService; +import io.quarkus.runtime.Startup; +import io.smallrye.mutiny.Multi; +import io.smallrye.mutiny.infrastructure.Infrastructure; +import jakarta.enterprise.context.ApplicationScoped; +import jakarta.inject.Inject; +import org.apache.commons.lang3.Strings; +import org.jboss.logging.Logger; + +import java.io.File; +import java.io.IOException; +import java.net.URI; +import java.net.http.HttpClient; +import java.net.http.HttpRequest; +import java.net.http.HttpResponse; +import java.time.Duration; +import java.util.Map; + +@ApplicationScoped +public class Core +{ + private static final String CONFIG_PATH = "/home/andreas/Documents/dev/pingo/backend/src/main/resources/config.yml"; + + @Inject + Logger LOG; + + @Inject + PingService pingService; + + @Inject + GroupService groupService; + + @Inject + HealthcheckService healthcheckService; + + @Startup + void init() throws IOException + { + Config checks = new ObjectMapper(new YAMLFactory()).readValue(new File(CONFIG_PATH), Config.class); + for (Map.Entry groupEntry : checks.groups().entrySet()) + { + GroupEntity group = groupService.create(groupEntry); + for (Map.Entry healthcheck : groupEntry.getValue().checks().entrySet()) + { + HealthcheckEntity target = healthcheckService.create(group, healthcheck); + run(target, healthcheck.getValue()); + } + } + } + + public void run(HealthcheckEntity target, Healthcheck healthcheck) + { + Multi.createFrom() + .ticks() + .every(Duration.ofSeconds(healthcheck.interval())) + .onItem() + .invoke(() -> performHealthcheck(target, healthcheck)) + .runSubscriptionOn(Infrastructure.getDefaultWorkerPool()) + .subscribe() + .with(tick -> {}, Throwable::printStackTrace); + } + + private void performHealthcheck(HealthcheckEntity target, Healthcheck healthcheck) + { + URI uri = healthcheck.target().toURI(); + LOG.infof("Executing healthcheck to URI %s", uri); + HttpRequest request = HttpRequest.newBuilder() + .method(HttpMethod.valueOf(healthcheck.request().method()).toString(), HttpRequest.BodyPublishers.noBody()) + .uri(uri) + .build(); + try (HttpClient client = HttpClient.newHttpClient()) + { + HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString()); + PingResult result = isSuccessful(response.statusCode()); + pingService.persist(target, result, response.statusCode(), response.body()); + if (PingResult.UP.equals(result)) + { + LOG.infof("Healthcheck for URI %s was successful: %s", uri, response.statusCode()); + } + else + { + LOG.infof("Healthcheck for URI %s was unsuccessful: %s", uri, response.statusCode()); + } + } + catch (IOException e) + { + pingService.persist(target, PingResult.DOWN, null, null); + LOG.infof("Healthcheck for URI %s was unsuccessful: due to an I/O exception", uri); + } + catch (InterruptedException e) + { + throw new RuntimeException(e); + } + } + + private PingResult isSuccessful(int statusCode) + { + if (Strings.CI.startsWith(String.valueOf(statusCode), "2")) + { + return PingResult.UP; + } + return PingResult.DOWN; + } + + private enum HttpMethod + { + GET, POST + } +} diff --git a/src/main/java/dev/dinauer/pingo/PingService.java b/src/main/java/dev/dinauer/pingo/PingService.java new file mode 100644 index 0000000..d9b6a7e --- /dev/null +++ b/src/main/java/dev/dinauer/pingo/PingService.java @@ -0,0 +1,50 @@ +package dev.dinauer.pingo; + +import dev.dinauer.pingo.group.GroupRepo; +import dev.dinauer.pingo.target.*; +import dev.dinauer.pingo.ping.PingEntity; +import dev.dinauer.pingo.ping.PingRepo; +import dev.dinauer.pingo.ping.PingResult; +import jakarta.enterprise.context.ApplicationScoped; +import jakarta.inject.Inject; +import jakarta.transaction.Transactional; + +import java.time.ZonedDateTime; +import java.time.temporal.ChronoUnit; +import java.util.List; + +@ApplicationScoped +public class PingService +{ + @Inject + GroupRepo groupRepo; + + @Inject + HealthcheckRepo healthcheckRepo; + + @Inject + PingRepo pingRepo; + + @Transactional + public void persist(HealthcheckEntity target, PingResult result, Integer code, String body) + { + PingEntity ping = new PingEntity().setTimestamp(ZonedDateTime.now().truncatedTo(ChronoUnit.SECONDS)).setResult(result).setCode(String.valueOf(code)).setBody(body).setTarget(target); + pingRepo.persist(ping); + } + + public Double findUptimeRatio(HealthcheckEntity target, ZonedDateTime from) + { + List pings = pingRepo.findByTargetAndCreatedAfter(target, from); + if (!pings.isEmpty()) + { + long up = pings.stream().filter(ping -> PingResult.UP.equals(ping.getResult())).count(); + return (1.0 * up) / pings.size(); + } + return null; + } + + public PingResult findResult(HealthcheckEntity target) + { + return pingRepo.findLatestByTarget(target).map(PingEntity::getResult).orElse(null); + } +} diff --git a/src/main/java/dev/dinauer/pingo/config/Config.java b/src/main/java/dev/dinauer/pingo/config/Config.java new file mode 100644 index 0000000..747aada --- /dev/null +++ b/src/main/java/dev/dinauer/pingo/config/Config.java @@ -0,0 +1,7 @@ +package dev.dinauer.pingo.config; + +import java.util.Map; + +public record Config(Map groups) +{ +} \ No newline at end of file diff --git a/src/main/java/dev/dinauer/pingo/config/Group.java b/src/main/java/dev/dinauer/pingo/config/Group.java new file mode 100644 index 0000000..667fdb6 --- /dev/null +++ b/src/main/java/dev/dinauer/pingo/config/Group.java @@ -0,0 +1,7 @@ +package dev.dinauer.pingo.config; + +import java.util.Map; + +public record Group(String displayName, Map checks) +{ +} diff --git a/src/main/java/dev/dinauer/pingo/config/Healthcheck.java b/src/main/java/dev/dinauer/pingo/config/Healthcheck.java new file mode 100644 index 0000000..75ca4e9 --- /dev/null +++ b/src/main/java/dev/dinauer/pingo/config/Healthcheck.java @@ -0,0 +1,5 @@ +package dev.dinauer.pingo.config; + +public record Healthcheck(String displayName, Integer interval, Request request, Target target) +{ +} diff --git a/src/main/java/dev/dinauer/pingo/config/Request.java b/src/main/java/dev/dinauer/pingo/config/Request.java new file mode 100644 index 0000000..cf69fc7 --- /dev/null +++ b/src/main/java/dev/dinauer/pingo/config/Request.java @@ -0,0 +1,5 @@ +package dev.dinauer.pingo.config; + +public record Request(String method) +{ +} diff --git a/src/main/java/dev/dinauer/pingo/config/Target.java b/src/main/java/dev/dinauer/pingo/config/Target.java new file mode 100644 index 0000000..434deb2 --- /dev/null +++ b/src/main/java/dev/dinauer/pingo/config/Target.java @@ -0,0 +1,45 @@ +package dev.dinauer.pingo.config; + +import org.apache.commons.lang3.Strings; + +import java.net.URI; +import java.util.Objects; + +public record Target(String schema, String host, String path) +{ + public URI toURI() + { + StringBuilder raw = new StringBuilder(); + if (Objects.nonNull(schema)) + { + raw.append(schema); + if (Objects.nonNull(host)) + { + raw.append("://").append(host); + if (Objects.nonNull(path)) + { + if (Strings.CI.startsWith("/", path)) + { + return URI.create(raw.append(path).toString()); + } + return URI.create(raw.append("/").append(path).toString()); + } + return URI.create(raw.toString()); + } + } + throw new RuntimeException(); + } + + public String path() + { + if (Objects.isNull(path)) + { + return null; + } + if (Strings.CI.startsWith(path, "/")) + { + return path; + } + return String.format("/%s", path); + } +} diff --git a/src/main/java/dev/dinauer/pingo/group/Group.java b/src/main/java/dev/dinauer/pingo/group/Group.java new file mode 100644 index 0000000..dbe145e --- /dev/null +++ b/src/main/java/dev/dinauer/pingo/group/Group.java @@ -0,0 +1,9 @@ +package dev.dinauer.pingo.group; + +import dev.dinauer.pingo.target.Healthcheck; + +import java.util.List; + +public record Group(String key, String displayName, List targets) +{ +} diff --git a/src/main/java/dev/dinauer/pingo/group/GroupEntity.java b/src/main/java/dev/dinauer/pingo/group/GroupEntity.java new file mode 100644 index 0000000..f91ec58 --- /dev/null +++ b/src/main/java/dev/dinauer/pingo/group/GroupEntity.java @@ -0,0 +1,54 @@ +package dev.dinauer.pingo.group; + +import dev.dinauer.pingo.target.HealthcheckEntity; +import jakarta.persistence.*; + +import java.util.ArrayList; +import java.util.List; + +@Entity +@Table(name = "target_group") +public class GroupEntity +{ + @Id + private String key; + + @Column(name = "display_name") + private String displayName; + + @OneToMany(mappedBy = "group") + private List targets = new ArrayList<>(); + + public String getKey() + { + return key; + } + + public GroupEntity setKey(String key) + { + this.key = key; + return this; + } + + public String getDisplayName() + { + return displayName; + } + + public GroupEntity setDisplayName(String displayName) + { + this.displayName = displayName; + return this; + } + + public List getTargets() + { + return targets; + } + + public GroupEntity setTargets(List targets) + { + this.targets = targets; + return this; + } +} diff --git a/src/main/java/dev/dinauer/pingo/group/GroupRepo.java b/src/main/java/dev/dinauer/pingo/group/GroupRepo.java new file mode 100644 index 0000000..8e4e69c --- /dev/null +++ b/src/main/java/dev/dinauer/pingo/group/GroupRepo.java @@ -0,0 +1,9 @@ +package dev.dinauer.pingo.group; + +import io.quarkus.hibernate.orm.panache.PanacheRepositoryBase; +import jakarta.enterprise.context.ApplicationScoped; + +@ApplicationScoped +public class GroupRepo implements PanacheRepositoryBase +{ +} diff --git a/src/main/java/dev/dinauer/pingo/group/GroupResource.java b/src/main/java/dev/dinauer/pingo/group/GroupResource.java new file mode 100644 index 0000000..40db859 --- /dev/null +++ b/src/main/java/dev/dinauer/pingo/group/GroupResource.java @@ -0,0 +1,20 @@ +package dev.dinauer.pingo.group; + +import jakarta.inject.Inject; +import jakarta.ws.rs.GET; +import jakarta.ws.rs.Path; + +import java.util.List; + +@Path("/groups") +public class GroupResource +{ + @Inject + GroupService groupService; + + @GET + public List get() + { + return groupService.find(); + } +} diff --git a/src/main/java/dev/dinauer/pingo/group/GroupService.java b/src/main/java/dev/dinauer/pingo/group/GroupService.java new file mode 100644 index 0000000..e7db37c --- /dev/null +++ b/src/main/java/dev/dinauer/pingo/group/GroupService.java @@ -0,0 +1,39 @@ +package dev.dinauer.pingo.group; + +import dev.dinauer.pingo.target.HealthcheckService; +import jakarta.enterprise.context.ApplicationScoped; +import jakarta.inject.Inject; +import jakarta.transaction.Transactional; + +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +@ApplicationScoped +public class GroupService +{ + @Inject + GroupRepo groupRepo; + + @Inject + HealthcheckService healthcheckService; + + public List find() + { + List result = new ArrayList<>(); + for (GroupEntity group : groupRepo.listAll()) + { + result.add(new Group(group.getKey(), group.getDisplayName(), healthcheckService.findByGroup(group))); + } + return result; + } + + @Transactional + public GroupEntity create(Map.Entry groupEntry) + { + GroupEntity group = groupRepo.findByIdOptional(groupEntry.getKey()).orElse( + new GroupEntity().setKey(groupEntry.getKey()).setDisplayName(groupEntry.getValue().displayName())); + groupRepo.persist(group); + return group; + } +} diff --git a/src/main/java/dev/dinauer/pingo/ping/PingEntity.java b/src/main/java/dev/dinauer/pingo/ping/PingEntity.java new file mode 100644 index 0000000..ed04bbd --- /dev/null +++ b/src/main/java/dev/dinauer/pingo/ping/PingEntity.java @@ -0,0 +1,97 @@ +package dev.dinauer.pingo.ping; + +import com.fasterxml.jackson.annotation.JsonIgnore; +import dev.dinauer.pingo.target.HealthcheckEntity; +import jakarta.persistence.*; + +import java.time.ZonedDateTime; + +@Entity +@Table(name = "ping") +public class PingEntity +{ + @Id + @GeneratedValue(strategy = GenerationType.UUID) + private String id; + + @Enumerated(EnumType.STRING) + private PingResult result; + + private String code; + + @Column(columnDefinition = "TEXT") + private String body; + + private ZonedDateTime timestamp; + + @ManyToOne + @JoinColumn(name = "target_id") + @JsonIgnore + private HealthcheckEntity target; + + public String getId() + { + return id; + } + + public PingEntity setId(String id) + { + this.id = id; + return this; + } + + public PingResult getResult() + { + return result; + } + + public PingEntity setResult(PingResult result) + { + this.result = result; + return this; + } + + public String getCode() + { + return code; + } + + public PingEntity setCode(String code) + { + this.code = code; + return this; + } + + public String getBody() + { + return body; + } + + public PingEntity setBody(String body) + { + this.body = body; + return this; + } + + public ZonedDateTime getTimestamp() + { + return timestamp; + } + + public PingEntity setTimestamp(ZonedDateTime timestamp) + { + this.timestamp = timestamp; + return this; + } + + public HealthcheckEntity getTarget() + { + return target; + } + + public PingEntity setTarget(HealthcheckEntity target) + { + this.target = target; + return this; + } +} diff --git a/src/main/java/dev/dinauer/pingo/ping/PingRepo.java b/src/main/java/dev/dinauer/pingo/ping/PingRepo.java new file mode 100644 index 0000000..9f45f9e --- /dev/null +++ b/src/main/java/dev/dinauer/pingo/ping/PingRepo.java @@ -0,0 +1,31 @@ +package dev.dinauer.pingo.ping; + +import dev.dinauer.pingo.target.HealthcheckEntity; +import io.quarkus.hibernate.orm.panache.PanacheRepositoryBase; +import io.quarkus.panache.common.Page; +import io.quarkus.panache.common.Parameters; +import io.quarkus.panache.common.Sort; +import jakarta.enterprise.context.ApplicationScoped; + +import java.time.ZonedDateTime; +import java.util.List; +import java.util.Optional; + +@ApplicationScoped +public class PingRepo implements PanacheRepositoryBase +{ + public List findPageByTarget(HealthcheckEntity target, Integer pageIndex, Integer pageSize) + { + return find("target = :target", Sort.descending("timestamp"), Parameters.with("target", target)).page(Page.of(pageIndex, pageSize)).list(); + } + + public Optional findLatestByTarget(HealthcheckEntity target) + { + return find("target = :target", Sort.descending("timestamp"), Parameters.with("target", target)).firstResultOptional(); + } + + public List findByTargetAndCreatedAfter(HealthcheckEntity target, ZonedDateTime from) + { + return list("target = :target AND timestamp >= :from", Sort.descending("timestamp"), Parameters.with("target", target).and("from", from)); + } +} diff --git a/src/main/java/dev/dinauer/pingo/ping/PingResult.java b/src/main/java/dev/dinauer/pingo/ping/PingResult.java new file mode 100644 index 0000000..66a8c72 --- /dev/null +++ b/src/main/java/dev/dinauer/pingo/ping/PingResult.java @@ -0,0 +1,6 @@ +package dev.dinauer.pingo.ping; + +public enum PingResult +{ + UP, DOWN +} diff --git a/src/main/resources/application.properties b/src/main/resources/application.properties new file mode 100644 index 0000000..fcac1ae --- /dev/null +++ b/src/main/resources/application.properties @@ -0,0 +1,10 @@ +# HTTP +quarkus.http.cors.enabled=true +%dev.quarkus.http.cors.origins=/.*/ + +# Postgres +quarkus.datasource.db-kind=postgresql +%dev,test.quarkus.hibernate-orm.schema-management.strategy=drop-and-create +%dev,test.quarkus.datasource.username=postgres +%dev,test.quarkus.datasource.password=postgres +%dev,test.quarkus.datasource.jdbc.url=jdbc:postgresql://localhost:5432/postgres \ No newline at end of file diff --git a/src/main/resources/config.yml b/src/main/resources/config.yml new file mode 100644 index 0000000..1f83920 --- /dev/null +++ b/src/main/resources/config.yml @@ -0,0 +1,42 @@ +groups: + backends: + displayName: Backends + checks: + backend: + displayName: Backend + request: + method: GET + target: + schema: https + host: tavolio.de + path: api/q/health + interval: 60 + assortment-backend: + displayName: Assortment Backend + request: + method: GET + target: + schema: https + host: tavolio.de + path: api/assortment-backend/q/health + interval: 60 + frontends: + displayName: Frontends + checks: + public: + displayName: Public + request: + method: GET + target: + schema: https + host: tavolio.de + interval: 60 + account: + displayName: Account + request: + method: GET + target: + schema: https + host: tavolio.de + path: account + interval: 60 \ No newline at end of file diff --git a/src/main/resources/import.sql b/src/main/resources/import.sql new file mode 100644 index 0000000..16aa523 --- /dev/null +++ b/src/main/resources/import.sql @@ -0,0 +1,6 @@ +-- This file allow to write SQL commands that will be emitted in test and dev. +-- The commands are commented as their support depends of the database +-- insert into myentity (id, field) values(1, 'field-1'); +-- insert into myentity (id, field) values(2, 'field-2'); +-- insert into myentity (id, field) values(3, 'field-3'); +-- alter sequence myentity_seq restart with 4; \ No newline at end of file