diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..8d95e09 --- /dev/null +++ b/.gitignore @@ -0,0 +1,111 @@ +# Misc +target/ +build/ +.idea +.gradle +example/target + +# General +*.log +*.keystore +.history/ +*.tgz + +# git-secret rules +.secrets/*.* +!.secrets/*.secret +!.secrets/public-keys/ +.gitsecret/keys/random_seed +.gitsecret/keys/pubring.kbx~ + + +.ci/gradle* + +# You can put a script which call `yarn prettier-eslint --write` that prettify the file in-place. +# Keep in mind the hook files are executed by alphabet sequence: so `in_place_prettier_eslint` will be executed before `prettier_eslint` +buildtools/hooks/pre-commit.d/in_place_prettier_eslint + +# Archives / Binaries +*.jar +*.zip +*.tar.gz +*.so +*.xcarchive + +# MacOS +.DS_Store + +# Build Output +build/ +out/ +bin/ +codemr/ + +# JetBrains +.idea/ +*.iml +*.ipr +*.iws +.mvn/ +.project + +# VSCode +.vscode/ +*.code-workspace + +# Eclipse +.settings/ +.classpath + +# Java +*.hprof +.gradle/ +!gradle-wrapper.jar +!gradle-wrapper.properties + + +# Node or NPM or Yarn +npm-debug.log* +yarn-debug.log* +yarn-error.log* +node_modules/ +.eslintcache + +# Jest/Bamboo test results output +jest.json +coverage/ + +# Vagrant +.vagrant/ + +# Xcode +# +*.pbxuser +!default.pbxuser +*.mode1v3 +!default.mode1v3 +*.mode2v3 +!default.mode2v3 +*.perspectivev3 +!default.perspectivev3 +xcuserdata +*.xccheckout +*.moved-aside +DerivedData +*.hmap +*.ipa +*.xcuserstate +project.xcworkspace +**/*.framework/ + + +# VIM +[._]*.s[a-v][a-z] +[._]*.sw[a-p] +[._]s[a-v][a-z] +[._]sw[a-p] +version.yml + +#Andorid +local.properties +>>>>>>> main diff --git a/README.md b/README.md index 993305e..b21b6e5 100644 --- a/README.md +++ b/README.md @@ -1 +1,12 @@ # firetail-java-lib + +## To build the library +Run: + +1. `mvn install` + +## To run the example application with the library +Run: + +1. Go to `example/` folder +2. Type `mvnw spring-boot:run` diff --git a/example/.gitignore b/example/.gitignore new file mode 100644 index 0000000..549e00a --- /dev/null +++ b/example/.gitignore @@ -0,0 +1,33 @@ +HELP.md +target/ +!.mvn/wrapper/maven-wrapper.jar +!**/src/main/**/target/ +!**/src/test/**/target/ + +### STS ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache + +### IntelliJ IDEA ### +.idea +*.iws +*.iml +*.ipr + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ +build/ +!**/src/main/**/build/ +!**/src/test/**/build/ + +### VS Code ### +.vscode/ diff --git a/example/mvnw b/example/mvnw new file mode 100755 index 0000000..66df285 --- /dev/null +++ b/example/mvnw @@ -0,0 +1,308 @@ +#!/bin/sh +# ---------------------------------------------------------------------------- +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# ---------------------------------------------------------------------------- + +# ---------------------------------------------------------------------------- +# Apache Maven Wrapper startup batch script, version 3.2.0 +# +# Required ENV vars: +# ------------------ +# JAVA_HOME - location of a JDK home dir +# +# Optional ENV vars +# ----------------- +# MAVEN_OPTS - parameters passed to the Java VM when running Maven +# e.g. to debug Maven itself, use +# set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 +# MAVEN_SKIP_RC - flag to disable loading of mavenrc files +# ---------------------------------------------------------------------------- + +if [ -z "$MAVEN_SKIP_RC" ] ; then + + if [ -f /usr/local/etc/mavenrc ] ; then + . /usr/local/etc/mavenrc + fi + + if [ -f /etc/mavenrc ] ; then + . /etc/mavenrc + fi + + if [ -f "$HOME/.mavenrc" ] ; then + . "$HOME/.mavenrc" + fi + +fi + +# OS specific support. $var _must_ be set to either true or false. +cygwin=false; +darwin=false; +mingw=false +case "$(uname)" in + CYGWIN*) cygwin=true ;; + MINGW*) mingw=true;; + Darwin*) darwin=true + # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home + # See https://developer.apple.com/library/mac/qa/qa1170/_index.html + if [ -z "$JAVA_HOME" ]; then + if [ -x "/usr/libexec/java_home" ]; then + JAVA_HOME="$(/usr/libexec/java_home)"; export JAVA_HOME + else + JAVA_HOME="/Library/Java/Home"; export JAVA_HOME + fi + fi + ;; +esac + +if [ -z "$JAVA_HOME" ] ; then + if [ -r /etc/gentoo-release ] ; then + JAVA_HOME=$(java-config --jre-home) + fi +fi + +# For Cygwin, ensure paths are in UNIX format before anything is touched +if $cygwin ; then + [ -n "$JAVA_HOME" ] && + JAVA_HOME=$(cygpath --unix "$JAVA_HOME") + [ -n "$CLASSPATH" ] && + CLASSPATH=$(cygpath --path --unix "$CLASSPATH") +fi + +# For Mingw, ensure paths are in UNIX format before anything is touched +if $mingw ; then + [ -n "$JAVA_HOME" ] && [ -d "$JAVA_HOME" ] && + JAVA_HOME="$(cd "$JAVA_HOME" || (echo "cannot cd into $JAVA_HOME."; exit 1); pwd)" +fi + +if [ -z "$JAVA_HOME" ]; then + javaExecutable="$(which javac)" + if [ -n "$javaExecutable" ] && ! [ "$(expr "\"$javaExecutable\"" : '\([^ ]*\)')" = "no" ]; then + # readlink(1) is not available as standard on Solaris 10. + readLink=$(which readlink) + if [ ! "$(expr "$readLink" : '\([^ ]*\)')" = "no" ]; then + if $darwin ; then + javaHome="$(dirname "\"$javaExecutable\"")" + javaExecutable="$(cd "\"$javaHome\"" && pwd -P)/javac" + else + javaExecutable="$(readlink -f "\"$javaExecutable\"")" + fi + javaHome="$(dirname "\"$javaExecutable\"")" + javaHome=$(expr "$javaHome" : '\(.*\)/bin') + JAVA_HOME="$javaHome" + export JAVA_HOME + fi + fi +fi + +if [ -z "$JAVACMD" ] ; then + if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + else + JAVACMD="$(\unset -f command 2>/dev/null; \command -v java)" + fi +fi + +if [ ! -x "$JAVACMD" ] ; then + echo "Error: JAVA_HOME is not defined correctly." >&2 + echo " We cannot execute $JAVACMD" >&2 + exit 1 +fi + +if [ -z "$JAVA_HOME" ] ; then + echo "Warning: JAVA_HOME environment variable is not set." +fi + +# traverses directory structure from process work directory to filesystem root +# first directory with .mvn subdirectory is considered project base directory +find_maven_basedir() { + if [ -z "$1" ] + then + echo "Path not specified to find_maven_basedir" + return 1 + fi + + basedir="$1" + wdir="$1" + while [ "$wdir" != '/' ] ; do + if [ -d "$wdir"/.mvn ] ; then + basedir=$wdir + break + fi + # workaround for JBEAP-8937 (on Solaris 10/Sparc) + if [ -d "${wdir}" ]; then + wdir=$(cd "$wdir/.." || exit 1; pwd) + fi + # end of workaround + done + printf '%s' "$(cd "$basedir" || exit 1; pwd)" +} + +# concatenates all lines of a file +concat_lines() { + if [ -f "$1" ]; then + # Remove \r in case we run on Windows within Git Bash + # and check out the repository with auto CRLF management + # enabled. Otherwise, we may read lines that are delimited with + # \r\n and produce $'-Xarg\r' rather than -Xarg due to word + # splitting rules. + tr -s '\r\n' ' ' < "$1" + fi +} + +log() { + if [ "$MVNW_VERBOSE" = true ]; then + printf '%s\n' "$1" + fi +} + +BASE_DIR=$(find_maven_basedir "$(dirname "$0")") +if [ -z "$BASE_DIR" ]; then + exit 1; +fi + +MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"}; export MAVEN_PROJECTBASEDIR +log "$MAVEN_PROJECTBASEDIR" + +########################################################################################## +# Extension to allow automatically downloading the maven-wrapper.jar from Maven-central +# This allows using the maven wrapper in projects that prohibit checking in binary data. +########################################################################################## +wrapperJarPath="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" +if [ -r "$wrapperJarPath" ]; then + log "Found $wrapperJarPath" +else + log "Couldn't find $wrapperJarPath, downloading it ..." + + if [ -n "$MVNW_REPOURL" ]; then + wrapperUrl="$MVNW_REPOURL/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + else + wrapperUrl="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + fi + while IFS="=" read -r key value; do + # Remove '\r' from value to allow usage on windows as IFS does not consider '\r' as a separator ( considers space, tab, new line ('\n'), and custom '=' ) + safeValue=$(echo "$value" | tr -d '\r') + case "$key" in (wrapperUrl) wrapperUrl="$safeValue"; break ;; + esac + done < "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties" + log "Downloading from: $wrapperUrl" + + if $cygwin; then + wrapperJarPath=$(cygpath --path --windows "$wrapperJarPath") + fi + + if command -v wget > /dev/null; then + log "Found wget ... using wget" + [ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--quiet" + if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then + wget $QUIET "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" + else + wget $QUIET --http-user="$MVNW_USERNAME" --http-password="$MVNW_PASSWORD" "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" + fi + elif command -v curl > /dev/null; then + log "Found curl ... using curl" + [ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--silent" + if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then + curl $QUIET -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath" + else + curl $QUIET --user "$MVNW_USERNAME:$MVNW_PASSWORD" -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath" + fi + else + log "Falling back to using Java to download" + javaSource="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.java" + javaClass="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.class" + # For Cygwin, switch paths to Windows format before running javac + if $cygwin; then + javaSource=$(cygpath --path --windows "$javaSource") + javaClass=$(cygpath --path --windows "$javaClass") + fi + if [ -e "$javaSource" ]; then + if [ ! -e "$javaClass" ]; then + log " - Compiling MavenWrapperDownloader.java ..." + ("$JAVA_HOME/bin/javac" "$javaSource") + fi + if [ -e "$javaClass" ]; then + log " - Running MavenWrapperDownloader.java ..." + ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$wrapperUrl" "$wrapperJarPath") || rm -f "$wrapperJarPath" + fi + fi + fi +fi +########################################################################################## +# End of extension +########################################################################################## + +# If specified, validate the SHA-256 sum of the Maven wrapper jar file +wrapperSha256Sum="" +while IFS="=" read -r key value; do + case "$key" in (wrapperSha256Sum) wrapperSha256Sum=$value; break ;; + esac +done < "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties" +if [ -n "$wrapperSha256Sum" ]; then + wrapperSha256Result=false + if command -v sha256sum > /dev/null; then + if echo "$wrapperSha256Sum $wrapperJarPath" | sha256sum -c > /dev/null 2>&1; then + wrapperSha256Result=true + fi + elif command -v shasum > /dev/null; then + if echo "$wrapperSha256Sum $wrapperJarPath" | shasum -a 256 -c > /dev/null 2>&1; then + wrapperSha256Result=true + fi + else + echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available." + echo "Please install either command, or disable validation by removing 'wrapperSha256Sum' from your maven-wrapper.properties." + exit 1 + fi + if [ $wrapperSha256Result = false ]; then + echo "Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised." >&2 + echo "Investigate or delete $wrapperJarPath to attempt a clean download." >&2 + echo "If you updated your Maven version, you need to update the specified wrapperSha256Sum property." >&2 + exit 1 + fi +fi + +MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" + +# For Cygwin, switch paths to Windows format before running java +if $cygwin; then + [ -n "$JAVA_HOME" ] && + JAVA_HOME=$(cygpath --path --windows "$JAVA_HOME") + [ -n "$CLASSPATH" ] && + CLASSPATH=$(cygpath --path --windows "$CLASSPATH") + [ -n "$MAVEN_PROJECTBASEDIR" ] && + MAVEN_PROJECTBASEDIR=$(cygpath --path --windows "$MAVEN_PROJECTBASEDIR") +fi + +# Provide a "standardized" way to retrieve the CLI args that will +# work with both Windows and non-Windows executions. +MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $*" +export MAVEN_CMD_LINE_ARGS + +WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +# shellcheck disable=SC2086 # safe args +exec "$JAVACMD" \ + $MAVEN_OPTS \ + $MAVEN_DEBUG_OPTS \ + -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ + "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ + ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" diff --git a/example/mvnw.cmd b/example/mvnw.cmd new file mode 100644 index 0000000..95ba6f5 --- /dev/null +++ b/example/mvnw.cmd @@ -0,0 +1,205 @@ +@REM ---------------------------------------------------------------------------- +@REM Licensed to the Apache Software Foundation (ASF) under one +@REM or more contributor license agreements. See the NOTICE file +@REM distributed with this work for additional information +@REM regarding copyright ownership. The ASF licenses this file +@REM to you under the Apache License, Version 2.0 (the +@REM "License"); you may not use this file except in compliance +@REM with the License. You may obtain a copy of the License at +@REM +@REM https://www.apache.org/licenses/LICENSE-2.0 +@REM +@REM Unless required by applicable law or agreed to in writing, +@REM software distributed under the License is distributed on an +@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +@REM KIND, either express or implied. See the License for the +@REM specific language governing permissions and limitations +@REM under the License. +@REM ---------------------------------------------------------------------------- + +@REM ---------------------------------------------------------------------------- +@REM Apache Maven Wrapper startup batch script, version 3.2.0 +@REM +@REM Required ENV vars: +@REM JAVA_HOME - location of a JDK home dir +@REM +@REM Optional ENV vars +@REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands +@REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending +@REM MAVEN_OPTS - parameters passed to the Java VM when running Maven +@REM e.g. to debug Maven itself, use +@REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 +@REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files +@REM ---------------------------------------------------------------------------- + +@REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' +@echo off +@REM set title of command window +title %0 +@REM enable echoing by setting MAVEN_BATCH_ECHO to 'on' +@if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% + +@REM set %HOME% to equivalent of $HOME +if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") + +@REM Execute a user defined script before this one +if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre +@REM check for pre script, once with legacy .bat ending and once with .cmd ending +if exist "%USERPROFILE%\mavenrc_pre.bat" call "%USERPROFILE%\mavenrc_pre.bat" %* +if exist "%USERPROFILE%\mavenrc_pre.cmd" call "%USERPROFILE%\mavenrc_pre.cmd" %* +:skipRcPre + +@setlocal + +set ERROR_CODE=0 + +@REM To isolate internal variables from possible post scripts, we use another setlocal +@setlocal + +@REM ==== START VALIDATION ==== +if not "%JAVA_HOME%" == "" goto OkJHome + +echo. +echo Error: JAVA_HOME not found in your environment. >&2 +echo Please set the JAVA_HOME variable in your environment to match the >&2 +echo location of your Java installation. >&2 +echo. +goto error + +:OkJHome +if exist "%JAVA_HOME%\bin\java.exe" goto init + +echo. +echo Error: JAVA_HOME is set to an invalid directory. >&2 +echo JAVA_HOME = "%JAVA_HOME%" >&2 +echo Please set the JAVA_HOME variable in your environment to match the >&2 +echo location of your Java installation. >&2 +echo. +goto error + +@REM ==== END VALIDATION ==== + +:init + +@REM Find the project base dir, i.e. the directory that contains the folder ".mvn". +@REM Fallback to current working directory if not found. + +set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% +IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir + +set EXEC_DIR=%CD% +set WDIR=%EXEC_DIR% +:findBaseDir +IF EXIST "%WDIR%"\.mvn goto baseDirFound +cd .. +IF "%WDIR%"=="%CD%" goto baseDirNotFound +set WDIR=%CD% +goto findBaseDir + +:baseDirFound +set MAVEN_PROJECTBASEDIR=%WDIR% +cd "%EXEC_DIR%" +goto endDetectBaseDir + +:baseDirNotFound +set MAVEN_PROJECTBASEDIR=%EXEC_DIR% +cd "%EXEC_DIR%" + +:endDetectBaseDir + +IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig + +@setlocal EnableExtensions EnableDelayedExpansion +for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a +@endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% + +:endReadAdditionalConfig + +SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" +set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" +set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +set WRAPPER_URL="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + +FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( + IF "%%A"=="wrapperUrl" SET WRAPPER_URL=%%B +) + +@REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central +@REM This allows using the maven wrapper in projects that prohibit checking in binary data. +if exist %WRAPPER_JAR% ( + if "%MVNW_VERBOSE%" == "true" ( + echo Found %WRAPPER_JAR% + ) +) else ( + if not "%MVNW_REPOURL%" == "" ( + SET WRAPPER_URL="%MVNW_REPOURL%/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + ) + if "%MVNW_VERBOSE%" == "true" ( + echo Couldn't find %WRAPPER_JAR%, downloading it ... + echo Downloading from: %WRAPPER_URL% + ) + + powershell -Command "&{"^ + "$webclient = new-object System.Net.WebClient;"^ + "if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^ + "$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^ + "}"^ + "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%WRAPPER_URL%', '%WRAPPER_JAR%')"^ + "}" + if "%MVNW_VERBOSE%" == "true" ( + echo Finished downloading %WRAPPER_JAR% + ) +) +@REM End of extension + +@REM If specified, validate the SHA-256 sum of the Maven wrapper jar file +SET WRAPPER_SHA_256_SUM="" +FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( + IF "%%A"=="wrapperSha256Sum" SET WRAPPER_SHA_256_SUM=%%B +) +IF NOT %WRAPPER_SHA_256_SUM%=="" ( + powershell -Command "&{"^ + "$hash = (Get-FileHash \"%WRAPPER_JAR%\" -Algorithm SHA256).Hash.ToLower();"^ + "If('%WRAPPER_SHA_256_SUM%' -ne $hash){"^ + " Write-Output 'Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised.';"^ + " Write-Output 'Investigate or delete %WRAPPER_JAR% to attempt a clean download.';"^ + " Write-Output 'If you updated your Maven version, you need to update the specified wrapperSha256Sum property.';"^ + " exit 1;"^ + "}"^ + "}" + if ERRORLEVEL 1 goto error +) + +@REM Provide a "standardized" way to retrieve the CLI args that will +@REM work with both Windows and non-Windows executions. +set MAVEN_CMD_LINE_ARGS=%* + +%MAVEN_JAVA_EXE% ^ + %JVM_CONFIG_MAVEN_PROPS% ^ + %MAVEN_OPTS% ^ + %MAVEN_DEBUG_OPTS% ^ + -classpath %WRAPPER_JAR% ^ + "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" ^ + %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* +if ERRORLEVEL 1 goto error +goto end + +:error +set ERROR_CODE=1 + +:end +@endlocal & set ERROR_CODE=%ERROR_CODE% + +if not "%MAVEN_SKIP_RC%"=="" goto skipRcPost +@REM check for post script, once with legacy .bat ending and once with .cmd ending +if exist "%USERPROFILE%\mavenrc_post.bat" call "%USERPROFILE%\mavenrc_post.bat" +if exist "%USERPROFILE%\mavenrc_post.cmd" call "%USERPROFILE%\mavenrc_post.cmd" +:skipRcPost + +@REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' +if "%MAVEN_BATCH_PAUSE%"=="on" pause + +if "%MAVEN_TERMINATE_CMD%"=="on" exit %ERROR_CODE% + +cmd /C exit /B %ERROR_CODE% diff --git a/example/pom.xml b/example/pom.xml new file mode 100644 index 0000000..0d5c836 --- /dev/null +++ b/example/pom.xml @@ -0,0 +1,47 @@ + + + 4.0.0 + + org.springframework.boot + spring-boot-starter-parent + 3.1.3 + + + com.example + demo + 0.0.1-SNAPSHOT + demo + Demo project for Spring Boot + + 17 + + + + org.springframework.boot + spring-boot-starter-web + + + + org.springframework.boot + spring-boot-starter-test + test + + + + com.github.firetail-io + firetail-java-lib + 0.0.1-SNAPSHOT + + + + + + + org.springframework.boot + spring-boot-maven-plugin + + + + + diff --git a/example/src/main/java/com/example/demo/DemoApplication.java b/example/src/main/java/com/example/demo/DemoApplication.java new file mode 100644 index 0000000..2e3ef5e --- /dev/null +++ b/example/src/main/java/com/example/demo/DemoApplication.java @@ -0,0 +1,21 @@ +package com.example.demo; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.RequestParam; +import org.springframework.web.bind.annotation.RestController; + +@SpringBootApplication +@RestController +public class DemoApplication { + + public static void main(String[] args) { + SpringApplication.run(DemoApplication.class, args); + } + + @GetMapping("/hello") + public String hello(@RequestParam(value = "name", defaultValue = "World") String name) { + return String.format("Hello %s!", name); + } +} diff --git a/example/src/main/resources/application.properties b/example/src/main/resources/application.properties new file mode 100644 index 0000000..2199969 --- /dev/null +++ b/example/src/main/resources/application.properties @@ -0,0 +1 @@ +logging.firetail.enabled=true diff --git a/example/src/test/java/com/example/demo/DemoApplicationTests.java b/example/src/test/java/com/example/demo/DemoApplicationTests.java new file mode 100644 index 0000000..2778a6a --- /dev/null +++ b/example/src/test/java/com/example/demo/DemoApplicationTests.java @@ -0,0 +1,13 @@ +package com.example.demo; + +import org.junit.jupiter.api.Test; +import org.springframework.boot.test.context.SpringBootTest; + +@SpringBootTest +class DemoApplicationTests { + + @Test + void contextLoads() { + } + +} diff --git a/pom.xml b/pom.xml index 2ac8a70..b7e046b 100644 --- a/pom.xml +++ b/pom.xml @@ -1,178 +1,178 @@ - - 4.0.0 + + 4.0.0 - com.github.firetail-io - firetail-java-lib - 0.0.1.SNAPSPOT - firetail-java-lib - Java Library for Firetail - https://github.com/muhammadn/firetail-java-lib + com.github.firetail-io + firetail-java-lib + 0.0.1-SNAPSHOT + firetail-java-lib + Java Library for Firetail + https://github.com/muhammadn/firetail-java-lib + + + Muhammad Nuzaihan + zaihan@unrealasia.net + https://github.com/muhammadn + + - - - Muhammad Nuzaihan - zaihan@unrealasia.net - https://github.com/muhammadn - - + + + LGPL License + https://opensource.org/license/lgpl-3-0/ + repo + + - - - LGPL License - https://opensource.org/license/lgpl-3-0/ - repo - - + + 17 + 2.13.0 + 6.0.0 + 1.4.1 + 6.0.11 + 3.1.3 + 2.0.9 + ${project.artifactId} + - - 1.8 - 2.6 - 4.0.1 - 5.3 - 5.2.3.RELEASE - 2.1.4.RELEASE - 1.7.26 - - - - scm:git:git://github.com/muhammadn/firetail-java-lib.git - scm:git:git@github.com:muhammadn/firetail-java-lib.git - https://github.com/muhammadn/firetail-java-lib - - - - - ossrh - https://oss.sonatype.org/content/repositories/snapshots - - - ossrh - https://oss.sonatype.org/service/local/staging/deploy/maven2/ - - - - - - org.springframework - spring-context - ${spring.version} - provided - - - org.springframework - spring-web - ${spring.version} - provided - - - org.springframework - spring-webmvc - ${spring.version} - provided - - - org.springframework.boot - spring-boot-autoconfigure + + + ossrh + https://oss.sonatype.org/content/repositories/snapshots + + + ossrh + https://oss.sonatype.org/service/local/staging/deploy/maven2/ + + + + + org.springframework + spring-context + ${spring.version} + provided + + + org.springframework + spring-web + ${spring.version} + provided + + + org.springframework + spring-webmvc + ${spring.version} + provided + + + org.springframework.boot + spring-boot-autoconfigure ${spring.boot.version} - provided - - - net.logstash.logback - logstash-logback-encoder - ${logstash-logback.version} - - - javax.servlet - javax.servlet-api - ${javax-servlet.version} - provided - - - commons-io - commons-io - ${commons-io.version} - - - org.slf4j - slf4j-api - ${slf4j.version} - - - ch.qos.logback - logback-classic - 1.2.3 - - - javax.annotation - javax.annotation-api - 1.3.2 - - - - - - - org.apache.maven.plugins - maven-compiler-plugin - 3.8.0 - - ${java.version} - ${java.version} - UTF-8 - - - - + provided + + + jakarta.servlet + jakarta.servlet-api + ${javax-servlet.version} + provided + + + commons-io + commons-io + ${commons-io.version} + + + org.slf4j + slf4j-api + ${slf4j.version} + + + org.springframework.boot + spring-boot-starter-test + ${spring.boot.version} + test + + + ch.qos.logback + logback-classic + 1.4.11 + + + com.google.code.gson + gson + 2.10.1 + + + de.idealo.whitelabels + logstash-logback-http + 1.1.1 + + + + + + org.apache.maven.plugins + maven-compiler-plugin + 3.11.0 + + ${java.version} + ${java.version} + UTF-8 + + + + - - - release - - - - org.apache.maven.plugins - maven-gpg-plugin - 1.5 - - - sign-artifacts - verify - - sign - - - - - - org.apache.maven.plugins - maven-source-plugin - 3.0.1 - - - attach-sources - - jar-no-fork - - - - - - org.apache.maven.plugins - maven-javadoc-plugin - 3.0.0 - - - attach-javadocs - - jar - - - - - - - - + + + release + + + + org.apache.maven.plugins + maven-gpg-plugin + 3.1.0 + + + sign-artifacts + verify + + sign + + + + + + org.apache.maven.plugins + maven-source-plugin + 3.3.0 + + + attach-sources + + jar-no-fork + + + + + + org.apache.maven.plugins + maven-javadoc-plugin + 3.5.0 + + + attach-javadocs + + jar + + + + + + + + diff --git a/src/main/META-INF/spring.factories b/src/main/META-INF/spring.factories deleted file mode 100644 index 2b1c98c..0000000 --- a/src/main/META-INF/spring.factories +++ /dev/null @@ -1,2 +0,0 @@ -org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ -pl.piomin.logging.config.SpringLoggingAutoConfiguration diff --git a/src/main/java/io/firetail/logging/config/FiretailLoggingAutoConfiguration.java b/src/main/java/io/firetail/logging/config/FiretailLoggingAutoConfiguration.java new file mode 100644 index 0000000..60ab5f5 --- /dev/null +++ b/src/main/java/io/firetail/logging/config/FiretailLoggingAutoConfiguration.java @@ -0,0 +1,152 @@ +package io.firetail.logging.config; + +import net.logstash.logback.encoder.LogstashEncoder; +import ch.qos.logback.classic.Logger; +import ch.qos.logback.classic.LoggerContext; +import de.idealo.whitelabels.logback.*; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.boot.autoconfigure.condition.ConditionalOnBean; +import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; +import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; +import org.springframework.boot.context.properties.ConfigurationProperties; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.http.client.ClientHttpRequestInterceptor; +import org.springframework.web.client.RestTemplate; +import io.firetail.logging.client.RestTemplateSetHeaderInterceptor; +import io.firetail.logging.filter.SpringLoggingFilter; +import io.firetail.logging.util.UniqueIDGenerator; + +import java.util.HashMap; +import java.util.ArrayList; +import java.util.List; + +@Configuration +@ConfigurationProperties(prefix = "logging.firetail") +public class FiretailLoggingAutoConfiguration { + + private static final String FIRETAIL_APPENDER_NAME = "FIRETAIL"; + private static final org.slf4j.Logger LOGGER = LoggerFactory.getLogger(FiretailLoggingAutoConfiguration.class); + + private String url = "http://localhost:3100"; + private String ignorePatterns; + private boolean logHeaders; + private String trustStoreLocation; + private String trustStorePassword; + private String requestIdHeaderName = "X-Request-ID"; + private String correlationIdHeaderName = "X-Correlation-ID"; + + + @Value("${spring.application.name:-}") + String name; + + @Bean + public UniqueIDGenerator generator() { + return new UniqueIDGenerator(requestIdHeaderName, correlationIdHeaderName); + } + + @Bean + public SpringLoggingFilter loggingFilter() { + return new SpringLoggingFilter(generator(), ignorePatterns, logHeaders); + } + + @Bean + @ConditionalOnMissingBean + public RestTemplate restTemplate() { + return new RestTemplate(); + } + + @Bean + @ConditionalOnBean + public RestTemplate existingRestTemplate(final RestTemplate restTemplate) { + List interceptorList = new ArrayList(); + interceptorList.add(new RestTemplateSetHeaderInterceptor()); + restTemplate.setInterceptors(interceptorList); + return restTemplate; + } + + @Bean + @ConditionalOnProperty(value = "logging.firetail.enabled", matchIfMissing = true, havingValue = "true") + public HttpAppender firetailAppender() { + LoggerContext loggerContext = (LoggerContext) LoggerFactory.getILoggerFactory(); + + HttpAppender httpAppender = new HttpAppender(); + httpAppender.setContext(loggerContext); + httpAppender.setName(FIRETAIL_APPENDER_NAME); + + HttpClient httpClient = new HttpClient(); + httpClient.setDestination(url); + httpAppender.setHttpClient(httpClient); + + LogstashEncoder encoder = new LogstashEncoder(); + encoder.setContext(loggerContext); + encoder.setIncludeContext(true); + encoder.setCustomFields("{\"appname\":\"" + name + "\"}"); + encoder.start(); + + httpAppender.setEncoder(encoder); + httpAppender.start(); + + LOGGER.info("Firetail Appender running..."); + + loggerContext.getLogger(Logger.ROOT_LOGGER_NAME).addAppender(httpAppender); + return httpAppender; + } + + public String getUrl() { + return url; + } + + public void setUrl(String url) { + this.url = url; + } + + public String getTrustStoreLocation() { + return trustStoreLocation; + } + + public void setTrustStoreLocation(String trustStoreLocation) { + this.trustStoreLocation = trustStoreLocation; + } + + public String getTrustStorePassword() { + return trustStorePassword; + } + + public void setTrustStorePassword(String trustStorePassword) { + this.trustStorePassword = trustStorePassword; + } + + public String getIgnorePatterns() { + return ignorePatterns; + } + + public void setIgnorePatterns(String ignorePatterns) { + this.ignorePatterns = ignorePatterns; + } + + public boolean isLogHeaders() { + return logHeaders; + } + + public void setLogHeaders(boolean logHeaders) { + this.logHeaders = logHeaders; + } + + public String getRequestIdHeaderName() { + return requestIdHeaderName; + } + + public void setRequestIdHeaderName(String requestIdHeaderName) { + this.requestIdHeaderName = requestIdHeaderName; + } + + public String getCorrelationIdHeaderName() { + return correlationIdHeaderName; + } + + public void setCorrelationIdHeaderName(String correlationIdHeaderName) { + this.correlationIdHeaderName = correlationIdHeaderName; + } +} diff --git a/src/main/java/io/firetail/logging/config/SpringLoggerAutoConfiguration.java b/src/main/java/io/firetail/logging/config/SpringLoggerAutoConfiguration.java deleted file mode 100644 index 09d50d8..0000000 --- a/src/main/java/io/firetail/logging/config/SpringLoggerAutoConfiguration.java +++ /dev/null @@ -1,142 +0,0 @@ -package io.firetail.logging.config; - -import ch.qos.logback.classic.Logger; -import ch.qos.logback.classic.LoggerContext; -import ch.qos.logback.core.net.ssl.KeyStoreFactoryBean; -import ch.qos.logback.core.net.ssl.SSLConfiguration; -//import net.logstash.logback.appender.LogstashTcpSocketAppender; -//import net.logstash.logback.encoder.LogstashEncoder; -import org.slf4j.LoggerFactory; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.beans.factory.annotation.Value; -import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; -import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; -import org.springframework.boot.context.properties.ConfigurationProperties; -import org.springframework.context.annotation.Bean; -import org.springframework.context.annotation.Configuration; -import org.springframework.http.client.ClientHttpRequestInterceptor; -import org.springframework.web.client.RestTemplate; - -import io.firetail.logging.client.RestTemplateSetHeaderInterceptor; -import io.firetail.logging.filter.SpringLoggingFilter; -import io.firetail.logging.util.UniqueIDGenerator; - -import javax.annotation.PostConstruct; -import java.util.ArrayList; -import java.util.List; -import java.util.Optional; - -@Configuration -@ConfigurationProperties(prefix = "logging.logstash") -public class SpringLoggingAutoConfiguration { - - private static final String FIRETAIL_APPENDER_NAME = "FIRETAIL"; - - private String url = "localhost:8500"; - private String ignorePatterns; - private boolean logHeaders; - private String trustStoreLocation; - private String trustStorePassword; - @Value("${spring.application.name:-}") - String name; - @Autowired(required = false) - Optional template; - - @Bean - public UniqueIDGenerator generator() { - return new UniqueIDGenerator(); - } - - @Bean - public SpringLoggingFilter loggingFilter() { - return new SpringLoggingFilter(generator(), ignorePatterns, logHeaders); - } - - @Bean - @ConditionalOnMissingBean(RestTemplate.class) - public RestTemplate restTemplate() { - RestTemplate restTemplate = new RestTemplate(); - List interceptorList = new ArrayList(); - interceptorList.add(new RestTemplateSetHeaderInterceptor()); - restTemplate.setInterceptors(interceptorList); - return restTemplate; - } - - /* rewrite this method to send data to firetail backend - @Bean - @ConditionalOnProperty("logging.firetail.enabled") - public FiretailTcpSocketAppender firetailAppender() { - LoggerContext loggerContext = (LoggerContext) LoggerFactory.getILoggerFactory(); - LogstashTcpSocketAppender logstashTcpSocketAppender = new LogstashTcpSocketAppender(); - logstashTcpSocketAppender.setName(FIRETAIL_APPENDER_NAME); - logstashTcpSocketAppender.setContext(loggerContext); - logstashTcpSocketAppender.addDestination(url); - if (trustStoreLocation != null) { - SSLConfiguration sslConfiguration = new SSLConfiguration(); - KeyStoreFactoryBean factory = new KeyStoreFactoryBean(); - factory.setLocation(trustStoreLocation); - if (trustStorePassword != null) - factory.setPassword(trustStorePassword); - sslConfiguration.setTrustStore(factory); - logstashTcpSocketAppender.setSsl(sslConfiguration); - } - LogstashEncoder encoder = new LogstashEncoder(); - encoder.setContext(loggerContext); - encoder.setIncludeContext(true); - encoder.setCustomFields("{\"appname\":\"" + name + "\"}"); - encoder.start(); - logstashTcpSocketAppender.setEncoder(encoder); - logstashTcpSocketAppender.start(); - loggerContext.getLogger(Logger.ROOT_LOGGER_NAME).addAppender(logstashTcpSocketAppender); - return logstashTcpSocketAppender; - } */ - - @PostConstruct - public void init() { - template.ifPresent(restTemplate -> { - List interceptorList = new ArrayList(); - interceptorList.add(new RestTemplateSetHeaderInterceptor()); - restTemplate.setInterceptors(interceptorList); - }); - } - - public String getUrl() { - return url; - } - - public void setUrl(String url) { - this.url = url; - } - - public String getTrustStoreLocation() { - return trustStoreLocation; - } - - public void setTrustStoreLocation(String trustStoreLocation) { - this.trustStoreLocation = trustStoreLocation; - } - - public String getTrustStorePassword() { - return trustStorePassword; - } - - public void setTrustStorePassword(String trustStorePassword) { - this.trustStorePassword = trustStorePassword; - } - - public String getIgnorePatterns() { - return ignorePatterns; - } - - public void setIgnorePatterns(String ignorePatterns) { - this.ignorePatterns = ignorePatterns; - } - - public boolean isLogHeaders() { - return logHeaders; - } - - public void setLogHeaders(boolean logHeaders) { - this.logHeaders = logHeaders; - } -} diff --git a/src/main/java/io/firetail/logging/filter/SpringLoggerFilter.java b/src/main/java/io/firetail/logging/filter/SpringLoggingFilter.java similarity index 86% rename from src/main/java/io/firetail/logging/filter/SpringLoggerFilter.java rename to src/main/java/io/firetail/logging/filter/SpringLoggingFilter.java index ce11374..97de4c8 100644 --- a/src/main/java/io/firetail/logging/filter/SpringLoggerFilter.java +++ b/src/main/java/io/firetail/logging/filter/SpringLoggingFilter.java @@ -1,5 +1,9 @@ package io.firetail.logging.filter; +import jakarta.servlet.FilterChain; +import jakarta.servlet.ServletException; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; import org.apache.commons.io.IOUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -15,10 +19,6 @@ import io.firetail.logging.wrapper.SpringRequestWrapper; import io.firetail.logging.wrapper.SpringResponseWrapper; -import javax.servlet.FilterChain; -import javax.servlet.ServletException; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; import java.io.IOException; import java.util.Map; import java.util.Objects; @@ -54,11 +54,11 @@ protected void doFilterInternal(HttpServletRequest request, HttpServletResponse if (logHeaders) LOGGER.info("Request: method={}, uri={}, payload={}, headers={}, audit={}", wrappedRequest.getMethod(), wrappedRequest.getRequestURI(), IOUtils.toString(wrappedRequest.getInputStream(), - wrappedRequest.getCharacterEncoding()), wrappedRequest.getAllHeaders(), value("audit", true)); + wrappedRequest.getCharacterEncoding()), wrappedRequest.getAllHeaders(), true); else LOGGER.info("Request: method={}, uri={}, payload={}, audit={}", wrappedRequest.getMethod(), wrappedRequest.getRequestURI(), IOUtils.toString(wrappedRequest.getInputStream(), - wrappedRequest.getCharacterEncoding()), value("audit", true)); + wrappedRequest.getCharacterEncoding()), true); final SpringResponseWrapper wrappedResponse = new SpringResponseWrapper(response); wrappedResponse.setHeader("X-Request-ID", MDC.get("X-Request-ID")); wrappedResponse.setHeader("X-Correlation-ID", MDC.get("X-Correlation-ID")); @@ -77,13 +77,13 @@ private void logResponse(long startTime, SpringResponseWrapper wrappedResponse, final long duration = System.currentTimeMillis() - startTime; wrappedResponse.setCharacterEncoding("UTF-8"); if (logHeaders) - LOGGER.info("Response({} ms): status={}, payload={}, headers={}, audit={}", value("X-Response-Time", duration), - value("X-Response-Status", overriddenStatus), IOUtils.toString(wrappedResponse.getContentAsByteArray(), - wrappedResponse.getCharacterEncoding()), wrappedResponse.getAllHeaders(), value("audit", true)); + LOGGER.info("Response({} ms): status={}, payload={}, headers={}, audit={}", duration, + overriddenStatus, IOUtils.toString(wrappedResponse.getContentAsByteArray(), + wrappedResponse.getCharacterEncoding()), wrappedResponse.getAllHeaders(), true); else - LOGGER.info("Response({} ms): status={}, payload={}, audit={}", value("X-Response-Time", duration), - value("X-Response-Status", overriddenStatus), - IOUtils.toString(wrappedResponse.getContentAsByteArray(), wrappedResponse.getCharacterEncoding()), value("audit", true)); + LOGGER.info("Response({} ms): status={}, payload={}, audit={}", duration, + overriddenStatus, + IOUtils.toString(wrappedResponse.getContentAsByteArray(), wrappedResponse.getCharacterEncoding()), true); } private void getHandlerMethod(HttpServletRequest request) throws Exception { diff --git a/src/main/java/io/firetail/logging/util/UniqueIDGenerator.java b/src/main/java/io/firetail/logging/util/UniqueIDGenerator.java index 7d95a69..0eb38c8 100644 --- a/src/main/java/io/firetail/logging/util/UniqueIDGenerator.java +++ b/src/main/java/io/firetail/logging/util/UniqueIDGenerator.java @@ -1,26 +1,30 @@ package io.firetail.logging.util; +import jakarta.servlet.http.HttpServletRequest; import org.slf4j.MDC; -import javax.servlet.http.HttpServletRequest; import java.util.UUID; public class UniqueIDGenerator { - private static final String REQUEST_ID_HEADER_NAME = "X-Request-ID"; - private static final String CORRELATION_ID_HEADER_NAME = "X-Correlation-ID"; + private final String requestIdHeaderName; + private final String correlationIdHeaderName; + + public UniqueIDGenerator(String requestIdHeaderName, String correlationIdHeaderName) { + this.requestIdHeaderName = requestIdHeaderName; + this.correlationIdHeaderName = correlationIdHeaderName; + } public void generateAndSetMDC(HttpServletRequest request) { - MDC.clear(); - String requestId = request.getHeader(REQUEST_ID_HEADER_NAME); + String requestId = request.getHeader(requestIdHeaderName); if (requestId == null) requestId = UUID.randomUUID().toString(); - MDC.put(REQUEST_ID_HEADER_NAME, requestId); + MDC.put(requestIdHeaderName, requestId); - String correlationId = request.getHeader(CORRELATION_ID_HEADER_NAME); + String correlationId = request.getHeader(correlationIdHeaderName); if (correlationId == null) correlationId = UUID.randomUUID().toString(); - MDC.put(CORRELATION_ID_HEADER_NAME, correlationId); + MDC.put(correlationIdHeaderName, correlationId); } } diff --git a/src/main/java/io/firetail/logging/wrapper/ServletOutputStreamWrapper.java b/src/main/java/io/firetail/logging/wrapper/ServletOutputStreamWrapper.java index c9964dd..a6db2f7 100644 --- a/src/main/java/io/firetail/logging/wrapper/ServletOutputStreamWrapper.java +++ b/src/main/java/io/firetail/logging/wrapper/ServletOutputStreamWrapper.java @@ -1,39 +1,39 @@ package io.firetail.logging.wrapper; +import jakarta.servlet.ServletOutputStream; +import jakarta.servlet.WriteListener; + import java.io.ByteArrayOutputStream; import java.io.IOException; import java.io.OutputStream; -import javax.servlet.ServletOutputStream; -import javax.servlet.WriteListener; - public class ServletOutputStreamWrapper extends ServletOutputStream { - private OutputStream outputStream; - private ByteArrayOutputStream copy; + private OutputStream outputStream; + private ByteArrayOutputStream copy; - public ServletOutputStreamWrapper(OutputStream outputStream) { - this.outputStream = outputStream; - this.copy = new ByteArrayOutputStream(); - } + public ServletOutputStreamWrapper(OutputStream outputStream) { + this.outputStream = outputStream; + this.copy = new ByteArrayOutputStream(); + } - @Override - public void write(int b) throws IOException { - outputStream.write(b); - copy.write(b); - } + @Override + public void write(int b) throws IOException { + outputStream.write(b); + copy.write(b); + } - public byte[] getCopy() { - return copy.toByteArray(); - } + public byte[] getCopy() { + return copy.toByteArray(); + } - @Override - public boolean isReady() { - return true; - } + @Override + public boolean isReady() { + return true; + } - @Override - public void setWriteListener(WriteListener writeListener) { + @Override + public void setWriteListener(WriteListener writeListener) { - } + } } diff --git a/src/main/java/io/firetail/logging/wrapper/SpringRequestWrapper.java b/src/main/java/io/firetail/logging/wrapper/SpringRequestWrapper.java index 79be944..3cd1d2b 100644 --- a/src/main/java/io/firetail/logging/wrapper/SpringRequestWrapper.java +++ b/src/main/java/io/firetail/logging/wrapper/SpringRequestWrapper.java @@ -1,11 +1,11 @@ package io.firetail.logging.wrapper; +import jakarta.servlet.ReadListener; +import jakarta.servlet.ServletInputStream; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletRequestWrapper; import org.apache.commons.io.IOUtils; -import javax.servlet.ReadListener; -import javax.servlet.ServletInputStream; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletRequestWrapper; import java.io.ByteArrayInputStream; import java.io.IOException; import java.util.Collections; @@ -15,9 +15,12 @@ public class SpringRequestWrapper extends HttpServletRequestWrapper { private byte[] body; + private Map parameterMap; public SpringRequestWrapper(HttpServletRequest request) { super(request); + parameterMap = request.getParameterMap(); + try { body = IOUtils.toByteArray(request.getInputStream()); } catch (IOException ex) { @@ -25,6 +28,11 @@ public SpringRequestWrapper(HttpServletRequest request) { } } + @Override + public Map getParameterMap() { + return parameterMap; + } + @Override public ServletInputStream getInputStream() throws IOException { return new ServletInputStream() { diff --git a/src/main/java/io/firetail/logging/wrapper/SpringResponseWrapper.java b/src/main/java/io/firetail/logging/wrapper/SpringResponseWrapper.java index b8c191c..45961d2 100644 --- a/src/main/java/io/firetail/logging/wrapper/SpringResponseWrapper.java +++ b/src/main/java/io/firetail/logging/wrapper/SpringResponseWrapper.java @@ -1,77 +1,74 @@ package io.firetail.logging.wrapper; +import jakarta.servlet.ServletOutputStream; +import jakarta.servlet.http.HttpServletResponse; +import jakarta.servlet.http.HttpServletResponseWrapper; + import java.io.IOException; import java.io.OutputStreamWriter; import java.io.PrintWriter; import java.util.HashMap; import java.util.Map; -import javax.servlet.ServletOutputStream; -import javax.servlet.http.HttpServletResponse; -import javax.servlet.http.HttpServletResponseWrapper; - public class SpringResponseWrapper extends HttpServletResponseWrapper { - private ServletOutputStream outputStream; - private PrintWriter writer; - private ServletOutputStreamWrapper copier; - - public SpringResponseWrapper(HttpServletResponse response) throws IOException { - super(response); - } - - @Override - public ServletOutputStream getOutputStream() throws IOException { - if (writer != null) { - throw new IllegalStateException("getWriter() has already been called on this response."); - } - - if (outputStream == null) { - outputStream = getResponse().getOutputStream(); - copier = new ServletOutputStreamWrapper(outputStream); - } - - return copier; - } - - @Override - public PrintWriter getWriter() throws IOException { - if (outputStream != null) { - throw new IllegalStateException("getOutputStream() has already been called on this response."); - } - - if (writer == null) { - copier = new ServletOutputStreamWrapper(getResponse().getOutputStream()); - writer = new PrintWriter(new OutputStreamWriter(copier, getResponse().getCharacterEncoding()), true); - } - - return writer; - } - - @Override - public void flushBuffer() throws IOException { - if (writer != null) { - writer.flush(); - } - else if (outputStream != null) { - copier.flush(); - } - } - - public byte[] getContentAsByteArray() { - if (copier != null) { - return copier.getCopy(); - } - else { - return new byte[0]; - } - } - - public Map getAllHeaders() { - final Map headers = new HashMap<>(); - getHeaderNames().forEach(it -> headers.put(it, getHeader(it))); - return headers; - } + private ServletOutputStream outputStream; + private PrintWriter writer; + private ServletOutputStreamWrapper copier; + + public SpringResponseWrapper(HttpServletResponse response) throws IOException { + super(response); + } + + @Override + public ServletOutputStream getOutputStream() throws IOException { + if (writer != null) { + throw new IllegalStateException("getWriter() has already been called on this response."); + } + + if (outputStream == null) { + outputStream = getResponse().getOutputStream(); + copier = new ServletOutputStreamWrapper(outputStream); + } + + return copier; + } + + @Override + public PrintWriter getWriter() throws IOException { + if (outputStream != null) { + throw new IllegalStateException("getOutputStream() has already been called on this response."); + } + + if (writer == null) { + copier = new ServletOutputStreamWrapper(getResponse().getOutputStream()); + writer = new PrintWriter(new OutputStreamWriter(copier, getResponse().getCharacterEncoding()), true); + } + + return writer; + } + + @Override + public void flushBuffer() throws IOException { + if (writer != null) { + writer.flush(); + } else if (outputStream != null) { + copier.flush(); + } + } + + public byte[] getContentAsByteArray() { + if (copier != null) { + return copier.getCopy(); + } else { + return new byte[0]; + } + } + + public Map getAllHeaders() { + final Map headers = new HashMap<>(); + getHeaderNames().forEach(it -> headers.put(it, getHeader(it))); + return headers; + } } - diff --git a/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports b/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports new file mode 100644 index 0000000..810def2 --- /dev/null +++ b/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports @@ -0,0 +1 @@ +io.firetail.logging.config.FiretailLoggingAutoConfiguration diff --git a/src/test/kotlin/io/firetail/logging/IdGeneratorTests.kt b/src/test/kotlin/io/firetail/logging/IdGeneratorTests.kt new file mode 100644 index 0000000..1aac882 --- /dev/null +++ b/src/test/kotlin/io/firetail/logging/IdGeneratorTests.kt @@ -0,0 +1,45 @@ +package io.firetail.logging + +import io.firetail.logging.Constants.Companion.CORRELATION_ID +import io.firetail.logging.Constants.Companion.REQUEST_ID +import io.firetail.logging.util.Generator +import io.firetail.logging.util.UniqueIDGenerator +import org.assertj.core.api.Assertions.assertThat +import org.junit.jupiter.api.Test +import org.mockito.Mockito +import org.slf4j.MDC +import org.springframework.mock.web.MockHttpServletRequest + +class IdGeneratorTests { + @Test + fun mdcIsSetFromHeaderValues() { + val idGenerator = UniqueIDGenerator() // test with default generator + val httpRequest = MockHttpServletRequest() + val requestId = "requestId" + val correlationId = "correlationId" + httpRequest.addHeader(REQUEST_ID, requestId) + httpRequest.addHeader(CORRELATION_ID, correlationId) + idGenerator.generateAndSetMDC(httpRequest) + + assertThat(MDC.get(REQUEST_ID)).isEqualTo(requestId) + assertThat(MDC.get(CORRELATION_ID)).isEqualTo(correlationId) + assertThat(httpRequest.getHeader(REQUEST_ID)).isEqualTo(requestId) + assertThat(httpRequest.getHeader(CORRELATION_ID)).isEqualTo(correlationId) + } + + @Test + fun mdcIsSetWhenNoHeaderValues() { + val generator = Mockito.mock(Generator::class.java) + MDC.clear() + assertThat(MDC.get(CORRELATION_ID)).isNull() + assertThat(MDC.get(REQUEST_ID)).isNull() + val httpRequest = MockHttpServletRequest() + val id = "someValue" + Mockito.`when`(generator.generate()).thenReturn(id) + val idGenerator = UniqueIDGenerator(generator) + idGenerator.generateAndSetMDC(httpRequest) + assertThat(httpRequest.headerNames.toList()).isEmpty() + assertThat(MDC.get(REQUEST_ID)).isEqualTo(id) + assertThat(MDC.get(CORRELATION_ID)).isEqualTo(id) + } +}