diff --git a/pom.xml b/pom.xml index 3ac6bb0a3..0f4444a7b 100644 --- a/pom.xml +++ b/pom.xml @@ -330,6 +330,20 @@ lombok-maven-plugin ${lombok-maven-plugin.version} + + io.spring.javaformat + spring-javaformat-maven-plugin + ${spring-javaformat-maven-plugin.version} + + + validate + true + + validate + + + + @@ -337,16 +351,6 @@ io.spring.javaformat spring-javaformat-maven-plugin - ${spring-javaformat-maven-plugin.version} - - - validate - true - - validate - - - org.apache.maven.plugins diff --git a/spring-rewrite-commons-examples/boot-3-upgrade-iterative/.gitignore b/spring-rewrite-commons-examples/boot-3-upgrade-iterative/.gitignore new file mode 100644 index 000000000..549e00a2a --- /dev/null +++ b/spring-rewrite-commons-examples/boot-3-upgrade-iterative/.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/spring-rewrite-commons-examples/boot-3-upgrade-iterative/.mvn/wrapper/maven-wrapper.jar b/spring-rewrite-commons-examples/boot-3-upgrade-iterative/.mvn/wrapper/maven-wrapper.jar new file mode 100644 index 000000000..cb28b0e37 Binary files /dev/null and b/spring-rewrite-commons-examples/boot-3-upgrade-iterative/.mvn/wrapper/maven-wrapper.jar differ diff --git a/spring-rewrite-commons-examples/boot-3-upgrade-iterative/.mvn/wrapper/maven-wrapper.properties b/spring-rewrite-commons-examples/boot-3-upgrade-iterative/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 000000000..5f0536eb7 --- /dev/null +++ b/spring-rewrite-commons-examples/boot-3-upgrade-iterative/.mvn/wrapper/maven-wrapper.properties @@ -0,0 +1,2 @@ +distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.5/apache-maven-3.9.5-bin.zip +wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar diff --git a/spring-rewrite-commons-examples/boot-3-upgrade-iterative/mvnw b/spring-rewrite-commons-examples/boot-3-upgrade-iterative/mvnw new file mode 100755 index 000000000..66df28542 --- /dev/null +++ b/spring-rewrite-commons-examples/boot-3-upgrade-iterative/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/spring-rewrite-commons-examples/boot-3-upgrade-iterative/mvnw.cmd b/spring-rewrite-commons-examples/boot-3-upgrade-iterative/mvnw.cmd new file mode 100644 index 000000000..95ba6f54a --- /dev/null +++ b/spring-rewrite-commons-examples/boot-3-upgrade-iterative/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/spring-rewrite-commons-examples/boot-3-upgrade-iterative/pom.xml b/spring-rewrite-commons-examples/boot-3-upgrade-iterative/pom.xml new file mode 100644 index 000000000..9226ec783 --- /dev/null +++ b/spring-rewrite-commons-examples/boot-3-upgrade-iterative/pom.xml @@ -0,0 +1,83 @@ + + + 4.0.0 + + org.springframework.rewrite + spring-rewrite-commons + 0.1.0-SNAPSHOT + ../pom.xml + + com.example + boot-3-upgrade-iterative + 0.0.1-SNAPSHOT + boot-upgrade-iterative + boot-upgrade-iterative + + 17 + + + + org.springframework.boot + spring-boot-starter + + + + org.springframework.experimental + sbm-support-rewrite + 0.1.0-SNAPSHOT + + + org.openrewrite.recipe + rewrite-spring + 5.1.2 + + + org.openrewrite.recipe + rewrite-migrate-java + 2.3.0 + + + + org.kohsuke + github-api + 1.317 + + + com.fasterxml.jackson.dataformat + jackson-dataformat-xml + + + org.projectlombok + lombok + true + + + org.springframework.boot + spring-boot-starter-test + test + + + + + + + org.springframework.boot + spring-boot-maven-plugin + + com.example.bootupgrade.IterativeBoot3UpgradeExample + + paketobuildpacks/builder-jammy-base:latest + + + + org.projectlombok + lombok + + + + + + + + diff --git a/spring-rewrite-commons-examples/boot-3-upgrade-iterative/src/main/java/com/example/bootupgrade/BootUpgradeIterativeApplication.java b/spring-rewrite-commons-examples/boot-3-upgrade-iterative/src/main/java/com/example/bootupgrade/BootUpgradeIterativeApplication.java new file mode 100644 index 000000000..991e3f40c --- /dev/null +++ b/spring-rewrite-commons-examples/boot-3-upgrade-iterative/src/main/java/com/example/bootupgrade/BootUpgradeIterativeApplication.java @@ -0,0 +1,29 @@ +/* + * Copyright 2021 - 2023 the original author or authors. + * + * Licensed 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. + */ +package com.example.bootupgrade; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class BootUpgradeIterativeApplication { + + public static void main(String[] args) { + + SpringApplication.run(BootUpgradeIterativeApplication.class, args); + } + +} diff --git a/spring-rewrite-commons-examples/boot-3-upgrade-iterative/src/main/java/com/example/bootupgrade/IterativeBoot3UpgradeExample.java b/spring-rewrite-commons-examples/boot-3-upgrade-iterative/src/main/java/com/example/bootupgrade/IterativeBoot3UpgradeExample.java new file mode 100644 index 000000000..5ef73dd84 --- /dev/null +++ b/spring-rewrite-commons-examples/boot-3-upgrade-iterative/src/main/java/com/example/bootupgrade/IterativeBoot3UpgradeExample.java @@ -0,0 +1,342 @@ +/* + * Copyright 2021 - 2023 the original author or authors. + * + * Licensed 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. + */ +package com.example.bootupgrade; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.dataformat.xml.XmlMapper; +import lombok.extern.slf4j.Slf4j; +import org.jetbrains.annotations.NotNull; +import org.kohsuke.github.GHPullRequest; +import org.kohsuke.github.GHRepository; +import org.kohsuke.github.GitHub; +import org.kohsuke.github.GitHubBuilder; +import org.openrewrite.Recipe; +import org.openrewrite.SourceFile; +import org.openrewrite.shaded.jgit.api.CreateBranchCommand; +import org.openrewrite.shaded.jgit.api.Git; +import org.openrewrite.shaded.jgit.api.ListBranchCommand; +import org.openrewrite.shaded.jgit.api.ResetCommand; +import org.openrewrite.shaded.jgit.api.errors.GitAPIException; +import org.openrewrite.shaded.jgit.lib.Ref; +import org.openrewrite.shaded.jgit.revwalk.RevCommit; +import org.openrewrite.shaded.jgit.transport.*; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.ApplicationArguments; +import org.springframework.boot.ApplicationRunner; +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; +import org.springframework.context.event.EventListener; +import org.springframework.core.io.Resource; +import org.springframework.sbm.parsers.ProjectScanner; +import org.springframework.sbm.parsers.RewriteProjectParser; +import org.springframework.sbm.parsers.RewriteProjectParsingResult; +import org.springframework.sbm.parsers.events.StartedParsingResourceEvent; +import org.springframework.sbm.project.resource.ProjectResourceSet; +import org.springframework.sbm.project.resource.ProjectResourceSetFactory; +import org.springframework.sbm.project.resource.ProjectResourceSetSerializer; +import org.springframework.sbm.recipes.RewriteRecipeDiscovery; +import org.springframework.scheduling.annotation.EnableScheduling; +import org.springframework.scheduling.annotation.Scheduled; +import org.springframework.util.FileSystemUtils; + +import java.io.File; +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.*; + +/** + * @author Fabian Krüger + */ +@SpringBootApplication +@EnableScheduling +@Slf4j +public class IterativeBoot3UpgradeExample implements ApplicationRunner { + + private static final String MAIN_BRANCH = "main"; + + public static final String GH_ORG_NAME = "fabapp2"; + + public static final String GH_REPO_NAME = "spring-petclinic-detached"; + + public static final String GIT_COMMIT_HASH = "baafc5a80c988cffa0c11e88859143308e850f08"; + + private String repoUrl; + + private String ghToken; + + public static void main(String[] args) { + SpringApplication.run(IterativeBoot3UpgradeExample.class, args); + } + + private static Map> versionToRecipeMap = new HashMap<>(); + + static { + versionToRecipeMap = Map.of("2.3.5.RELEASE", List.of("org.openrewrite.java.spring.boot2.UpgradeSpringBoot_2_4"), + + "2.4.13", List.of("org.openrewrite.java.spring.boot2.UpgradeSpringBoot_2_5"), + + "2.5.15", List.of("org.openrewrite.java.spring.boot2.UpgradeSpringBoot_2_6"), + + "2.6.15", List.of("org.openrewrite.java.spring.boot2.UpgradeSpringBoot_2_7"), + + "2.7.17", List.of("org.openrewrite.java.spring.boot3.UpgradeSpringBoot_3_0"), + + "3.0.12", List.of("org.openrewrite.java.spring.boot3.UpgradeSpringBoot_3_1"), + + "3.1.5", List.of("org.openrewrite.java.spring.boot3.UpgradeSpringBoot_3_2")); + // map.keySet() + // .stream() + // .forEach(keys -> { + // keys.stream() + // .forEach(k -> { + // versionToRecipeMap.put(k, map.get(keys)); + // }); + // }); + + } + + @Autowired + private RewriteProjectParser parser; + + @Autowired + private ProjectScanner scanner; + + @Autowired + private RewriteRecipeDiscovery discovery; + + @Autowired + private ProjectResourceSetSerializer serializer; + + @Autowired + private ProjectResourceSetFactory projectResourceSetFactory; + + @EventListener(StartedParsingResourceEvent.class) + public void onStartedParsingResourceEvent(StartedParsingResourceEvent event) { + } + + @Override + public void run(ApplicationArguments args) throws Exception { + repoUrl = getRepoUrl(args); + ghToken = getGitHubToken(args); + } + + @Scheduled(fixedDelay = 10_000) + void loop() throws IOException, GitAPIException { + log.info("Scheduling..."); + if (repoUrl == null || ghToken == null) { + return; + } + // clone + Path baseDir = cloneFreshRepo(repoUrl); + + String pomXml = Files.readString(baseDir.resolve("pom.xml")); + String currentBootVersion = extractSpringBootVersion(pomXml); + + if (versionToRecipeMap.containsKey(currentBootVersion)) { + Optional newBootVersionOpt = calculateNextBootVersion(currentBootVersion); + if (newBootVersionOpt.isPresent()) { + String newBootVersion = newBootVersionOpt.get(); + log.info("Found migration path to Spring Boot %s".formatted(newBootVersion)); + String branchName = calculateBranchName(newBootVersion); + Git git = Git.open(baseDir.resolve(".git").toFile()); + if (branchExists(git, branchName)) { + log.info("There might be an open PR? Otherwise please delete this remote branch: " + branchName); + return; + } + // find recipe name + List recipeNames = versionToRecipeMap.get(currentBootVersion); + // parse + ProjectResourceSet projectResourceSet = parseProject(baseDir); + // discover + List recipes = discoverRecipes(recipeNames); + // apply + applyRecipe(projectResourceSet, recipes); + // create branch + Ref branchRef = createBranch(git, branchName); + checkout(git, branchName); + // commit + String message = "Upgrade Spring Boot from %s to %s".formatted(currentBootVersion, newBootVersion); + RevCommit commit = commit(git, message); + log.info("commit: " + commit); + push(git, branchRef, ghToken); + + // Create PR + String mainBranch = "main"; + GHPullRequest pr = createPullRequest(ghToken, message, branchName, mainBranch, message); + } + else { + log.info("No migration path found."); + } + } + else { + log.info("No migration found for Spring Boot version: %s".formatted(currentBootVersion)); + } + } + + private boolean branchExists(Git git, String branchName) { + try { + git.fetch().call(); + // FIXME: This works only in this example. origin could be different + return git.branchList() + .setListMode(ListBranchCommand.ListMode.REMOTE) + .call() + .stream() + .anyMatch(b -> "refs/remotes/origin/%s".formatted(branchName).equals(b.getName())); + } + catch (GitAPIException e) { + throw new RuntimeException(e); + } + } + + private String calculateBranchName(String newBootVersion) { + return "app-analyzer/boot-upgrade-%s".formatted(newBootVersion.replace(".", "")); + } + + private Optional calculateNextBootVersion(String currentBootVersion) { + List sortedVersions = versionToRecipeMap.keySet().stream().sorted(String::compareTo).toList(); + int i = sortedVersions.indexOf(currentBootVersion); + if (i < sortedVersions.size() - 1) { + return Optional.of(sortedVersions.get(i + 1)); + } + return Optional.empty(); + } + + private String extractSpringBootVersion(String pomXml) { + try { + ObjectMapper mm = new XmlMapper(); + String version = mm.readTree(pomXml).get("parent").get("version").textValue(); + return version; + } + catch (JsonProcessingException e) { + throw new RuntimeException(e); + } + } + + private static void checkout(Git git, String branchName) throws GitAPIException { + git.checkout().setName(branchName).call(); + } + + private String getGitHubToken(ApplicationArguments args) { + if (args.getNonOptionArgs().size() < 2) { + throw new IllegalArgumentException("The GitHub token must be provided as second parameter."); + } + return args.getNonOptionArgs().get(1); + } + + private void push(Git git, Ref branch, String ghToken) throws GitAPIException { + git.push().add(branch).setCredentialsProvider(new UsernamePasswordCredentialsProvider(ghToken, "")).call(); + } + + private static RevCommit commit(Git git, String message) throws GitAPIException { + git.add().addFilepattern(".").call(); + return git.commit().setMessage(message).call(); + } + + private static Ref createBranch(Git git, String branchName) throws GitAPIException { + Ref branchRef = git.branchCreate() + .setName(branchName) + .setUpstreamMode(CreateBranchCommand.SetupUpstreamMode.SET_UPSTREAM) + .setForce(true) + .call(); + return branchRef; + } + + private ProjectResourceSet parseProject(Path baseDir) { + // scan + List resources = scanner.scan(baseDir); + // parse + RewriteProjectParsingResult parsingResult = parser.parse(baseDir, resources); + List sourceFiles = parsingResult.sourceFiles(); + ProjectResourceSet projectResourceSet = projectResourceSetFactory.create(baseDir, sourceFiles); + return projectResourceSet; + } + + @NotNull + private Path cloneFreshRepo(String repoUrl) throws IOException { + Path targetDir = Path.of(System.getProperty("java.io.tmpdir")).resolve(GH_REPO_NAME); // Files.createTempDirectory(GH_REPO_NAME).toAbsolutePath(); + if (targetDir.toFile().exists()) { + FileSystemUtils.deleteRecursively(targetDir); + } + String commitHash = null;// GIT_COMMIT_HASH; // + // https://github.com/spring-projects/spring-petclinic/commit/a3294f2 + cloneFreshRepo(repoUrl, targetDir, commitHash); + System.out.println("Cloned to %s".formatted(targetDir)); + return targetDir; + } + + private static String getRepoUrl(ApplicationArguments args) { + if (args.getNonOptionArgs().isEmpty()) { + throw new IllegalArgumentException("A repository URL must be provided."); + } + String repoUrl = args.getNonOptionArgs().get(0); + return repoUrl; + } + + private void cloneFreshRepo(String repoUrl, Path targetDir, String gitHash) { + try { + File directory = targetDir.toFile(); + Git git = Git.cloneRepository().setDirectory(directory).setURI(repoUrl).call(); + + if (gitHash != null) { + git.reset().setMode(ResetCommand.ResetType.HARD).setRef(GIT_COMMIT_HASH); + } + } + catch (GitAPIException e) { + throw new RuntimeException(e); + } + } + + private GHPullRequest createPullRequest(String ghToken, String name, String head, String base, String body) { + try { + GitHub gitHub = new GitHubBuilder().withOAuthToken(ghToken).build(); + + GHRepository repo = gitHub + /* .getOrganization(GH_ORG_NAME) */ + .getRepository(GH_ORG_NAME + "/" + GH_REPO_NAME); + + GHPullRequest pr = repo.createPullRequest(name, head, base, body); + log.info("Created PR '%s'".formatted(name)); + return pr; + } + catch (IOException e) { + throw new RuntimeException(e); + } + } + + private void applyRecipe(ProjectResourceSet projectResourceSet, List recipes) { + // FIXME: If recipes is a list they need to be provided through + // Recipe.getRecipeList() to not require a new parse + log.info("Applying recipes %s".formatted(recipes.stream().map(Recipe::getDisplayName).toList())); + if (recipes.size() > 1) + throw new UnsupportedOperationException("Can only handle single recipes."); + recipes.forEach(r -> this.applyRecipe(projectResourceSet, r)); + } + + private void applyRecipe(ProjectResourceSet projectResourceSet, Recipe recipe) { + projectResourceSet.apply(recipe); + serializer.writeChanges(projectResourceSet); + System.out.println("Applied recipe " + recipe.getDisplayName()); + } + + private List discoverRecipes(List recipeNames) { + List recipes = discovery.discoverRecipes(); + List matchingRecipes = recipes.stream().filter(r -> recipeNames.contains(r.getName())).toList(); + return matchingRecipes; + } + +} diff --git a/spring-rewrite-commons-examples/boot-3-upgrade-iterative/src/main/resources/application.properties b/spring-rewrite-commons-examples/boot-3-upgrade-iterative/src/main/resources/application.properties new file mode 100644 index 000000000..8b1378917 --- /dev/null +++ b/spring-rewrite-commons-examples/boot-3-upgrade-iterative/src/main/resources/application.properties @@ -0,0 +1 @@ + diff --git a/spring-rewrite-commons-examples/pom.xml b/spring-rewrite-commons-examples/pom.xml index c3ea0772a..63ea9fd1e 100644 --- a/spring-rewrite-commons-examples/pom.xml +++ b/spring-rewrite-commons-examples/pom.xml @@ -16,6 +16,7 @@ boot-3-upgrade-atomic + boot-3-upgrade-iterative list-applicable-recipes-example