From 5881dd06130b7846430067030e9944013f92073b Mon Sep 17 00:00:00 2001 From: Lobo Date: Sun, 19 Apr 2026 10:44:29 +0200 Subject: [PATCH] Initial project setup: CI, Docker & configs Add project bootstrap for build, CI/CD, and local development. Introduces Maven Wrapper (mvnw, mvnw.cmd, .mvn/wrapper), multi-stage Dockerfile, docker-compose files (compose.yaml, docker-compose.dev.yml), .env, banner and README. Adds Gitea Actions workflow to build, test and push container images. Update application.yml (port -> 8090, virtual threads, API versioning, management/actuator/prometheus settings, Steam API config) and add application-dev.yml for local overrides. Extend pom.xml with caching, observability (actuator, micrometer/prometheus), testing/dev dependencies (testcontainers, devtools, additional spring test modules) to support CI and local testing. --- .gitea/workflows/publish-core.yml | 75 +++++++ .mvn/wrapper/maven-wrapper.properties | 3 + Dockerfile | 35 +++ compose.yaml | 10 + docker-compose.dev.yml | 22 ++ mvnw | 295 ++++++++++++++++++++++++++ mvnw.cmd | 189 +++++++++++++++++ pom.xml | 49 +++++ readme.md | 82 +++++++ src/main/resources/application.yml | 34 +-- src/main/resources/banner.txt | 18 ++ 11 files changed, 800 insertions(+), 12 deletions(-) create mode 100644 .gitea/workflows/publish-core.yml create mode 100644 .mvn/wrapper/maven-wrapper.properties create mode 100644 Dockerfile create mode 100644 compose.yaml create mode 100644 docker-compose.dev.yml create mode 100644 mvnw create mode 100644 mvnw.cmd create mode 100644 readme.md create mode 100644 src/main/resources/banner.txt diff --git a/.gitea/workflows/publish-core.yml b/.gitea/workflows/publish-core.yml new file mode 100644 index 0000000..765a8ce --- /dev/null +++ b/.gitea/workflows/publish-core.yml @@ -0,0 +1,75 @@ +name: Build, Test & Push Core Service + +# Trigger the workflow +on: + push: + branches: + - main + +jobs: + # ------------------------------------------------------------------ + # JOB 1: Code integrity and quality gates (CI) + # ------------------------------------------------------------------ + quality-check: + runs-on: ubuntu-latest + steps: + - name: Checkout Code + uses: actions/checkout@v4 + + - name: Setup Java 25 + uses: actions/setup-java@v4 + with: + java-version: '25' + distribution: 'temurin' + # Automatically cache Maven dependencies to speed up builds + cache: 'maven' + + - name: Make Maven Wrapper executable + # This fixes the "Permission denied" error on Linux runners + run: chmod +x mvnw + + - name: Build and Test with Maven Wrapper + # Uses the wrapper to guarantee the correct Maven version + run: ./mvnw clean verify + + # ------------------------------------------------------------------ + # JOB 2: Docker Build & Push (CD) + # Runs only if 'quality-check' is successful and we are on branch main + # ------------------------------------------------------------------ + docker: + needs: quality-check + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - name: Prepare tag + id: prep + shell: bash + run: | + # Sanitize branch name for valid Docker tags + BRANCH="${GITHUB_REF_NAME}" + BRANCH="${BRANCH//\//-}" + BRANCH="$(echo "$BRANCH" | tr '[:upper:]' '[:lower:]')" + echo "branch=$BRANCH" >> "$GITHUB_OUTPUT" + echo "sha=${GITHUB_SHA::12}" >> "$GITHUB_OUTPUT" + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v3 + + - name: Login to Gitea Container Registry + uses: docker/login-action@v3 + with: + registry: git.andreas-dahm.eu + # Use your Gitea Secrets here + username: ${{ github.repository_owner }} + password: ${{ secrets.TOKEN_GITEA }} + + - name: Build & Push + uses: docker/build-push-action@v6 + with: + context: . + push: true + tags: | + git.andreas-dahm.eu/lobo_corp/tbp-core-service:${{ steps.prep.outputs.branch }} + git.andreas-dahm.eu/lobo_corp/tbp-core-service:${{ steps.prep.outputs.branch }}-${{ steps.prep.outputs.sha }} + git.andreas-dahm.eu/lobo_corp/tbp-core-service:latest \ No newline at end of file diff --git a/.mvn/wrapper/maven-wrapper.properties b/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 0000000..c595b00 --- /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.14/apache-maven-3.9.14-bin.zip diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..5b79e05 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,35 @@ +# ------------------------------------------------------------------ +# STAGE 1: Build the application using Maven Wrapper +# ------------------------------------------------------------------ +FROM eclipse-temurin:25-jdk-alpine AS builder + +WORKDIR /app + +# Copy the Maven wrapper and pom.xml first to cache dependencies +COPY .mvn/ .mvn +COPY mvnw pom.xml ./ + +# Make the wrapper executable (just in case) and download dependencies +RUN chmod +x mvnw +RUN ./mvnw dependency:go-offline + +# Copy the actual source code and build the application (skip tests in Docker, +# as they will be run by the Gitea Action before the build) +COPY src ./src +RUN ./mvnw clean package -DskipTests + +# ------------------------------------------------------------------ +# STAGE 2: Create the minimal runtime image +# ------------------------------------------------------------------ +FROM eclipse-temurin:25-jre-alpine + +WORKDIR /app + +# Expose the port your Spring Boot app runs on +EXPOSE 8090 + +# Copy the compiled jar file from the builder stage +COPY --from=builder /app/target/*.jar app.jar + +# Run the application +ENTRYPOINT ["java", "-jar", "app.jar"] \ No newline at end of file diff --git a/compose.yaml b/compose.yaml new file mode 100644 index 0000000..678feae --- /dev/null +++ b/compose.yaml @@ -0,0 +1,10 @@ +services: + postgres: + image: postgres:17-alpine + container_name: tbp_core_db_local + ports: + - "5433:5432" + environment: + - POSTGRES_DB=tbp_core + - POSTGRES_USER=tbp_user + - POSTGRES_PASSWORD=local_secret_password \ No newline at end of file diff --git a/docker-compose.dev.yml b/docker-compose.dev.yml new file mode 100644 index 0000000..e19c70d --- /dev/null +++ b/docker-compose.dev.yml @@ -0,0 +1,22 @@ +# docker-compose.dev.yml +services: + # ───────────────────────────────────────────── + # LOCAL DATABASE FOR DEVELOPMENT + # ───────────────────────────────────────────── + tbp-db-local: + image: postgres:17-alpine + container_name: tbp_db_local + restart: unless-stopped + ports: + # Map the container port 5432 to your local machine port 5432 + - "5432:5432" + environment: + - POSTGRES_DB=tbp_core + - POSTGRES_USER=tbp_user + - POSTGRES_PASSWORD=${DB_PASSWORD} + volumes: + # Use a local volume to persist data across container restarts + - tbp_local_db_data:/var/lib/postgresql/data + +volumes: + tbp_local_db_data: \ No newline at end of file diff --git a/mvnw b/mvnw new file mode 100644 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 100644 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 index 61314d0..ead3ec1 100644 --- a/pom.xml +++ b/pom.xml @@ -40,6 +40,7 @@ org.springframework.boot spring-boot-starter-cache + com.github.ben-manes.caffeine caffeine @@ -75,6 +76,8 @@ org.springframework.boot spring-boot-starter-flyway + + org.springframework.boot spring-boot-starter-actuator @@ -84,6 +87,14 @@ micrometer-registry-prometheus runtime + + + + org.springframework.boot + spring-boot-docker-compose + runtime + true + org.postgresql postgresql @@ -99,11 +110,48 @@ spring-boot-starter-test test + + org.springframework.boot + spring-boot-starter-data-jpa-test + test + org.springframework.boot spring-boot-starter-security-test test + + org.springframework.boot + spring-boot-starter-validation-test + test + + + org.springframework.boot + spring-boot-starter-webmvc-test + test + + + org.springframework.boot + spring-boot-devtools + runtime + + + org.springframework.boot + spring-boot-testcontainers + test + + + org.testcontainers + postgresql + test + ${testcontainers.version} + + + org.testcontainers + junit-jupiter + ${testcontainers.version} + test + com.tngtech.archunit archunit-junit5 @@ -111,6 +159,7 @@ test + diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..7e3e71b --- /dev/null +++ b/readme.md @@ -0,0 +1,82 @@ +# To Be Played (TBP) - Core Service + +This is the Core Service for the "To Be Played" project. It acts as the central modulith, handling all business logic in vertical micro-service ready slices. + +## 🚀 Tech Stack + +* **Language:** Java 25 +* **Framework:** Spring Boot 4.1.x +* **Security:** Spring Security & JSON Web Tokens (JWT) +* **Database:** PostgreSQL 17 +* **Migrations:** Flyway +* **Observability:** Spring Boot Actuator & Micrometer (Prometheus) +* **Build Tool:** Maven Wrapper (`mvnw`) +* **CI/CD:** Gitea Actions (Forgejo) + +## 🏗️ Architecture (Clean Architecture) + +The project strictly follows a Domain-Driven / Clean Architecture (Ports & Adapters) approach to ensure high maintainability and testability. The codebase is divided into three main layers to prevent framework lock-in and keep business logic isolated. + +### Layer Breakdown + +1. **Controller / Web Layer (`controller`)** + * Contains REST endpoints, DTOs (`Request`/`Response` records), and Global Exception Handlers. + * Uses `ApiMapper` to map between DTOs and Domain Models. + * **Rule:** This layer delegates to the Service layer and never accesses persistence directly. + +2. **Domain / Core Layer (`model`, `service`, `exception`)** + * The heart of the application. Contains pure Java classes (Models) and Business Logic (Services). + * Throws specific business exceptions (e.g., `InvalidCredentialsException`). + * **Rule:** This layer has **no dependencies** on the Controller or Persistence layer. It defines interfaces that the persistence layer must implement. + +3. **Persistence Layer (`persistence`)** + * Handles database operations. Contains JPA Entities (`UserEntity`), Spring Data Repositories, and the `EntityMapper`. + * Implements the interfaces defined in the Domain layer. + * **Rule:** Entities never leak into the Controller layer. + +*Note: Future implementations will include ArchUnit tests to automatically enforce these architectural boundaries during the CI pipeline.* + +## ⚙️ Local Development + +Running the application locally is fully automated via Spring Boot's Docker Compose Support. + +### Prerequisites + +* Java 25 installed +* Docker & Docker Compose running + +### How to start + +1. Simply run the application from your IDE (e.g., IntelliJ) via the `CoreServiceApplication.java` main class. +2. Spring Boot will automatically detect the `compose.yaml` and spin up a local PostgreSQL container (`tbp_db_local`) on port `5432`. +3. **Flyway** will automatically apply all database migrations located in `src/main/resources/db/migration`. +4. The application will be available at `http://localhost:8090`. + +To stop the environment and clean the database volume (if needed): + +```bash +docker compose down -v +``` + +## 🔐 API Versioning + +All API endpoints utilize Query Parameter Versioning to keep URLs clean and manageable. +Example: GET /api/users/me?v=1 + +## 🐳 CI/CD Pipeline + +The project uses Gitea Actions for Continuous Integration and Deployment. + +Quality Gate: Runs ./mvnw clean verify to ensure tests and builds pass. + +Docker Build: Packages the application using a multi-stage Dockerfile. + +Registry: Pushes the lightweight Alpine-based image to the private Gitea container registry (git.andreas-dahm.eu/lobo_corp/tbp-core-service:latest). + +## 📈 Observability + +Metrics and health checks are exposed out-of-the-box via Spring Boot Actuator: + +Health: http://localhost:8090/actuator/health + +Prometheus Metrics: http://localhost:8090/actuator/prometheus \ No newline at end of file diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml index deb882c..1726e72 100644 --- a/src/main/resources/application.yml +++ b/src/main/resources/application.yml @@ -3,35 +3,45 @@ spring: name: tbp-core-service profiles: active: prod - datasource: - url: jdbc:postgresql://${DB_HOST}:5432/tbp_core - username: ${DB_USER} - password: ${DB_PASS} jpa: open-in-view: true - hibernate: - ddl-auto: validate flyway: enabled: true baseline-on-migrate: true locations: classpath:db/migration + threads: + virtual: + enabled: true + mvc: + apiversion: + use: + query-parameter: version + default: "1.0" + supported: 1.0, 2,0 server: - port: 8081 + port: 8090 management: endpoints: web: exposure: include: health, prometheus, metrics - + endpoint: + health: + show-details: always + prometheus: + metrics: + export: + enabled: true security: jwt: secret: ${JWT_SECRET} - app: cors: allowed-origins: "https://tbp.andreas-dahm.eu" - -internal: - api-key: ${INTERNAL_API_KEY} + steam: + api-key: ${STEAM_API_KEY} + playerService-url: https://api.steampowered.com/IPlayerService/GetOwnedGames/v1/ + storeService-url: https://api.steampowered.com/IStoreService/GetAppList/v1/ + imageService-url: https://cdn.cloudflare.steamstatic.com/steam/apps/ \ No newline at end of file diff --git a/src/main/resources/banner.txt b/src/main/resources/banner.txt new file mode 100644 index 0000000..47fda19 --- /dev/null +++ b/src/main/resources/banner.txt @@ -0,0 +1,18 @@ + ,----, + ,/ .`| ,-.----. + ,` .' : ,---,. \ / \ ,--, ,----.. + ; ; / ,' .' \ | : \ ,--.'| ,---, / / \ +.'___,/ ,' ,---. ,---.' .' | | | .\ :| | : ,---.'| ,---,.| : : ,---. __ ,-. +| : | ' ,'\ | | |: | . : |: |: : ' | | : ,' .' |. | ;. / ' ,'\ ,' ,'/ /| +; |.'; ; / / |: : : / ,---. | | \ :| ' | ,--.--. .--, ,---. | | |,---.' ,. ; /--` / / |' | |' | ,---. +`----' | |. ; ,. :: | ; / \ | : . /' | | / \ /_ ./| / \ ,--.__| || | |; | ; . ; ,. :| | ,'/ \ + ' : ;' | |: :| : \ / / |; | |`-' | | : .--. .-. | , ' , ' : / / | / ,' |: : .' | : | ' | |: :' : / / / | + | | '' | .; :| | . |. ' / || | ; ' : |__ \__\/: . ./___/ \: |. ' / |. ' / |: |.' . | '___' | .; :| | ' . ' / | + ' : || : |' : '; |' ; /|: ' | | | '.'| ," .--.; | . \ ' |' ; /|' ; |: |`---' ' ; : .'| : |; : | ' ; /| + ; |.' \ \ / | | | ; ' | / |: : : ; : ;/ / ,. | \ ; :' | / || | '/ ' ' | '/ :\ \ / | , ; ' | / | + '---' `----' | : / | : || | : | , /; : .' \ \ \ ;| : || : :| | : / `----' ---' | : | + | | ,' \ \ / `---'.| ---`-' | , .-./ : \ \\ \ / \ \ / \ \ .' \ \ / + `----' `----' `---` `--`---' \ ' ; `----' `----' `---` `----' + `--` +${application.title} ${application.version} +Powered by Spring Boot ${spring-boot.version} \ No newline at end of file