Skip to content

Commit 36919fd

Browse files
psxjoypsxjoy
authored
chore: update Maven wrapper script for improved readability and functionality (#320)
1 parent 52eb9b8 commit 36919fd

File tree

2 files changed

+114
-105
lines changed

2 files changed

+114
-105
lines changed

Diff for: ‎.github/workflows/release.yml

+1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ name: Publish package to the Maven Central Repository
55
on:
66
release:
77
types: [created]
8+
workflow_dispatch:
89

910
jobs:
1011
publish:

Diff for: ‎mvnw

+113-105
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,15 @@
1919
# ----------------------------------------------------------------------------
2020

2121
# ----------------------------------------------------------------------------
22-
# Apache Maven Wrapper startup batch script, version 3.2.0
22+
# Maven Start Up Batch script
2323
#
2424
# Required ENV vars:
2525
# ------------------
2626
# JAVA_HOME - location of a JDK home dir
2727
#
2828
# Optional ENV vars
2929
# -----------------
30+
# M2_HOME - location of maven2's installed home dir
3031
# MAVEN_OPTS - parameters passed to the Java VM when running Maven
3132
# e.g. to debug Maven itself, use
3233
# set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000
@@ -53,56 +54,86 @@ fi
5354
cygwin=false;
5455
darwin=false;
5556
mingw=false
56-
case "$(uname)" in
57+
case "`uname`" in
5758
CYGWIN*) cygwin=true ;;
5859
MINGW*) mingw=true;;
5960
Darwin*) darwin=true
6061
# Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home
6162
# See https://developer.apple.com/library/mac/qa/qa1170/_index.html
6263
if [ -z "$JAVA_HOME" ]; then
6364
if [ -x "/usr/libexec/java_home" ]; then
64-
JAVA_HOME="$(/usr/libexec/java_home)"; export JAVA_HOME
65+
export JAVA_HOME="`/usr/libexec/java_home`"
6566
else
66-
JAVA_HOME="/Library/Java/Home"; export JAVA_HOME
67+
export JAVA_HOME="/Library/Java/Home"
6768
fi
6869
fi
6970
;;
7071
esac
7172

7273
if [ -z "$JAVA_HOME" ] ; then
7374
if [ -r /etc/gentoo-release ] ; then
74-
JAVA_HOME=$(java-config --jre-home)
75+
JAVA_HOME=`java-config --jre-home`
7576
fi
7677
fi
7778

79+
if [ -z "$M2_HOME" ] ; then
80+
## resolve links - $0 may be a link to maven's home
81+
PRG="$0"
82+
83+
# need this for relative symlinks
84+
while [ -h "$PRG" ] ; do
85+
ls=`ls -ld "$PRG"`
86+
link=`expr "$ls" : '.*-> \(.*\)$'`
87+
if expr "$link" : '/.*' > /dev/null; then
88+
PRG="$link"
89+
else
90+
PRG="`dirname "$PRG"`/$link"
91+
fi
92+
done
93+
94+
saveddir=`pwd`
95+
96+
M2_HOME=`dirname "$PRG"`/..
97+
98+
# make it fully qualified
99+
M2_HOME=`cd "$M2_HOME" && pwd`
100+
101+
cd "$saveddir"
102+
# echo Using m2 at $M2_HOME
103+
fi
104+
78105
# For Cygwin, ensure paths are in UNIX format before anything is touched
79106
if $cygwin ; then
107+
[ -n "$M2_HOME" ] &&
108+
M2_HOME=`cygpath --unix "$M2_HOME"`
80109
[ -n "$JAVA_HOME" ] &&
81-
JAVA_HOME=$(cygpath --unix "$JAVA_HOME")
110+
JAVA_HOME=`cygpath --unix "$JAVA_HOME"`
82111
[ -n "$CLASSPATH" ] &&
83-
CLASSPATH=$(cygpath --path --unix "$CLASSPATH")
112+
CLASSPATH=`cygpath --path --unix "$CLASSPATH"`
84113
fi
85114

86115
# For Mingw, ensure paths are in UNIX format before anything is touched
87116
if $mingw ; then
88-
[ -n "$JAVA_HOME" ] && [ -d "$JAVA_HOME" ] &&
89-
JAVA_HOME="$(cd "$JAVA_HOME" || (echo "cannot cd into $JAVA_HOME."; exit 1); pwd)"
117+
[ -n "$M2_HOME" ] &&
118+
M2_HOME="`(cd "$M2_HOME"; pwd)`"
119+
[ -n "$JAVA_HOME" ] &&
120+
JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`"
90121
fi
91122

92123
if [ -z "$JAVA_HOME" ]; then
93-
javaExecutable="$(which javac)"
94-
if [ -n "$javaExecutable" ] && ! [ "$(expr "\"$javaExecutable\"" : '\([^ ]*\)')" = "no" ]; then
124+
javaExecutable="`which javac`"
125+
if [ -n "$javaExecutable" ] && ! [ "`expr \"$javaExecutable\" : '\([^ ]*\)'`" = "no" ]; then
95126
# readlink(1) is not available as standard on Solaris 10.
96-
readLink=$(which readlink)
97-
if [ ! "$(expr "$readLink" : '\([^ ]*\)')" = "no" ]; then
127+
readLink=`which readlink`
128+
if [ ! `expr "$readLink" : '\([^ ]*\)'` = "no" ]; then
98129
if $darwin ; then
99-
javaHome="$(dirname "\"$javaExecutable\"")"
100-
javaExecutable="$(cd "\"$javaHome\"" && pwd -P)/javac"
130+
javaHome="`dirname \"$javaExecutable\"`"
131+
javaExecutable="`cd \"$javaHome\" && pwd -P`/javac"
101132
else
102-
javaExecutable="$(readlink -f "\"$javaExecutable\"")"
133+
javaExecutable="`readlink -f \"$javaExecutable\"`"
103134
fi
104-
javaHome="$(dirname "\"$javaExecutable\"")"
105-
javaHome=$(expr "$javaHome" : '\(.*\)/bin')
135+
javaHome="`dirname \"$javaExecutable\"`"
136+
javaHome=`expr "$javaHome" : '\(.*\)/bin'`
106137
JAVA_HOME="$javaHome"
107138
export JAVA_HOME
108139
fi
@@ -118,7 +149,7 @@ if [ -z "$JAVACMD" ] ; then
118149
JAVACMD="$JAVA_HOME/bin/java"
119150
fi
120151
else
121-
JAVACMD="$(\unset -f command 2>/dev/null; \command -v java)"
152+
JAVACMD="`\\unset -f command; \\command -v java`"
122153
fi
123154
fi
124155

@@ -132,9 +163,12 @@ if [ -z "$JAVA_HOME" ] ; then
132163
echo "Warning: JAVA_HOME environment variable is not set."
133164
fi
134165

166+
CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher
167+
135168
# traverses directory structure from process work directory to filesystem root
136169
# first directory with .mvn subdirectory is considered project base directory
137170
find_maven_basedir() {
171+
138172
if [ -z "$1" ]
139173
then
140174
echo "Path not specified to find_maven_basedir"
@@ -150,99 +184,96 @@ find_maven_basedir() {
150184
fi
151185
# workaround for JBEAP-8937 (on Solaris 10/Sparc)
152186
if [ -d "${wdir}" ]; then
153-
wdir=$(cd "$wdir/.." || exit 1; pwd)
187+
wdir=`cd "$wdir/.."; pwd`
154188
fi
155189
# end of workaround
156190
done
157-
printf '%s' "$(cd "$basedir" || exit 1; pwd)"
191+
echo "${basedir}"
158192
}
159193

160194
# concatenates all lines of a file
161195
concat_lines() {
162196
if [ -f "$1" ]; then
163-
# Remove \r in case we run on Windows within Git Bash
164-
# and check out the repository with auto CRLF management
165-
# enabled. Otherwise, we may read lines that are delimited with
166-
# \r\n and produce $'-Xarg\r' rather than -Xarg due to word
167-
# splitting rules.
168-
tr -s '\r\n' ' ' < "$1"
169-
fi
170-
}
171-
172-
log() {
173-
if [ "$MVNW_VERBOSE" = true ]; then
174-
printf '%s\n' "$1"
197+
echo "$(tr -s '\n' ' ' < "$1")"
175198
fi
176199
}
177200

178-
BASE_DIR=$(find_maven_basedir "$(dirname "$0")")
201+
BASE_DIR=`find_maven_basedir "$(pwd)"`
179202
if [ -z "$BASE_DIR" ]; then
180203
exit 1;
181204
fi
182205

183-
MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"}; export MAVEN_PROJECTBASEDIR
184-
log "$MAVEN_PROJECTBASEDIR"
185-
186206
##########################################################################################
187207
# Extension to allow automatically downloading the maven-wrapper.jar from Maven-central
188208
# This allows using the maven wrapper in projects that prohibit checking in binary data.
189209
##########################################################################################
190-
wrapperJarPath="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar"
191-
if [ -r "$wrapperJarPath" ]; then
192-
log "Found $wrapperJarPath"
210+
if [ -r "$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" ]; then
211+
if [ "$MVNW_VERBOSE" = true ]; then
212+
echo "Found .mvn/wrapper/maven-wrapper.jar"
213+
fi
193214
else
194-
log "Couldn't find $wrapperJarPath, downloading it ..."
195-
215+
if [ "$MVNW_VERBOSE" = true ]; then
216+
echo "Couldn't find .mvn/wrapper/maven-wrapper.jar, downloading it ..."
217+
fi
196218
if [ -n "$MVNW_REPOURL" ]; then
197-
wrapperUrl="$MVNW_REPOURL/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar"
219+
jarUrl="$MVNW_REPOURL/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar"
198220
else
199-
wrapperUrl="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar"
221+
jarUrl="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar"
200222
fi
201-
while IFS="=" read -r key value; do
202-
# 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 '=' )
203-
safeValue=$(echo "$value" | tr -d '\r')
204-
case "$key" in (wrapperUrl) wrapperUrl="$safeValue"; break ;;
223+
while IFS="=" read key value; do
224+
case "$key" in (wrapperUrl) jarUrl="$value"; break ;;
205225
esac
206-
done < "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties"
207-
log "Downloading from: $wrapperUrl"
208-
226+
done < "$BASE_DIR/.mvn/wrapper/maven-wrapper.properties"
227+
if [ "$MVNW_VERBOSE" = true ]; then
228+
echo "Downloading from: $jarUrl"
229+
fi
230+
wrapperJarPath="$BASE_DIR/.mvn/wrapper/maven-wrapper.jar"
209231
if $cygwin; then
210-
wrapperJarPath=$(cygpath --path --windows "$wrapperJarPath")
232+
wrapperJarPath=`cygpath --path --windows "$wrapperJarPath"`
211233
fi
212234

213235
if command -v wget > /dev/null; then
214-
log "Found wget ... using wget"
215-
[ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--quiet"
236+
if [ "$MVNW_VERBOSE" = true ]; then
237+
echo "Found wget ... using wget"
238+
fi
216239
if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then
217-
wget $QUIET "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath"
240+
wget "$jarUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath"
218241
else
219-
wget $QUIET --http-user="$MVNW_USERNAME" --http-password="$MVNW_PASSWORD" "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath"
242+
wget --http-user=$MVNW_USERNAME --http-password=$MVNW_PASSWORD "$jarUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath"
220243
fi
221244
elif command -v curl > /dev/null; then
222-
log "Found curl ... using curl"
223-
[ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--silent"
245+
if [ "$MVNW_VERBOSE" = true ]; then
246+
echo "Found curl ... using curl"
247+
fi
224248
if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then
225-
curl $QUIET -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath"
249+
curl -o "$wrapperJarPath" "$jarUrl" -f
226250
else
227-
curl $QUIET --user "$MVNW_USERNAME:$MVNW_PASSWORD" -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath"
251+
curl --user $MVNW_USERNAME:$MVNW_PASSWORD -o "$wrapperJarPath" "$jarUrl" -f
228252
fi
253+
229254
else
230-
log "Falling back to using Java to download"
231-
javaSource="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.java"
232-
javaClass="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.class"
255+
if [ "$MVNW_VERBOSE" = true ]; then
256+
echo "Falling back to using Java to download"
257+
fi
258+
javaClass="$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.java"
233259
# For Cygwin, switch paths to Windows format before running javac
234260
if $cygwin; then
235-
javaSource=$(cygpath --path --windows "$javaSource")
236-
javaClass=$(cygpath --path --windows "$javaClass")
261+
javaClass=`cygpath --path --windows "$javaClass"`
237262
fi
238-
if [ -e "$javaSource" ]; then
239-
if [ ! -e "$javaClass" ]; then
240-
log " - Compiling MavenWrapperDownloader.java ..."
241-
("$JAVA_HOME/bin/javac" "$javaSource")
263+
if [ -e "$javaClass" ]; then
264+
if [ ! -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then
265+
if [ "$MVNW_VERBOSE" = true ]; then
266+
echo " - Compiling MavenWrapperDownloader.java ..."
267+
fi
268+
# Compiling the Java class
269+
("$JAVA_HOME/bin/javac" "$javaClass")
242270
fi
243-
if [ -e "$javaClass" ]; then
244-
log " - Running MavenWrapperDownloader.java ..."
245-
("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$wrapperUrl" "$wrapperJarPath") || rm -f "$wrapperJarPath"
271+
if [ -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then
272+
# Running the downloader
273+
if [ "$MVNW_VERBOSE" = true ]; then
274+
echo " - Running MavenWrapperDownloader.java ..."
275+
fi
276+
("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$MAVEN_PROJECTBASEDIR")
246277
fi
247278
fi
248279
fi
@@ -251,58 +282,35 @@ fi
251282
# End of extension
252283
##########################################################################################
253284

254-
# If specified, validate the SHA-256 sum of the Maven wrapper jar file
255-
wrapperSha256Sum=""
256-
while IFS="=" read -r key value; do
257-
case "$key" in (wrapperSha256Sum) wrapperSha256Sum=$value; break ;;
258-
esac
259-
done < "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties"
260-
if [ -n "$wrapperSha256Sum" ]; then
261-
wrapperSha256Result=false
262-
if command -v sha256sum > /dev/null; then
263-
if echo "$wrapperSha256Sum $wrapperJarPath" | sha256sum -c > /dev/null 2>&1; then
264-
wrapperSha256Result=true
265-
fi
266-
elif command -v shasum > /dev/null; then
267-
if echo "$wrapperSha256Sum $wrapperJarPath" | shasum -a 256 -c > /dev/null 2>&1; then
268-
wrapperSha256Result=true
269-
fi
270-
else
271-
echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available."
272-
echo "Please install either command, or disable validation by removing 'wrapperSha256Sum' from your maven-wrapper.properties."
273-
exit 1
274-
fi
275-
if [ $wrapperSha256Result = false ]; then
276-
echo "Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised." >&2
277-
echo "Investigate or delete $wrapperJarPath to attempt a clean download." >&2
278-
echo "If you updated your Maven version, you need to update the specified wrapperSha256Sum property." >&2
279-
exit 1
280-
fi
285+
export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"}
286+
if [ "$MVNW_VERBOSE" = true ]; then
287+
echo $MAVEN_PROJECTBASEDIR
281288
fi
282-
283289
MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS"
284290

285291
# For Cygwin, switch paths to Windows format before running java
286292
if $cygwin; then
293+
[ -n "$M2_HOME" ] &&
294+
M2_HOME=`cygpath --path --windows "$M2_HOME"`
287295
[ -n "$JAVA_HOME" ] &&
288-
JAVA_HOME=$(cygpath --path --windows "$JAVA_HOME")
296+
JAVA_HOME=`cygpath --path --windows "$JAVA_HOME"`
289297
[ -n "$CLASSPATH" ] &&
290-
CLASSPATH=$(cygpath --path --windows "$CLASSPATH")
298+
CLASSPATH=`cygpath --path --windows "$CLASSPATH"`
291299
[ -n "$MAVEN_PROJECTBASEDIR" ] &&
292-
MAVEN_PROJECTBASEDIR=$(cygpath --path --windows "$MAVEN_PROJECTBASEDIR")
300+
MAVEN_PROJECTBASEDIR=`cygpath --path --windows "$MAVEN_PROJECTBASEDIR"`
293301
fi
294302

295303
# Provide a "standardized" way to retrieve the CLI args that will
296304
# work with both Windows and non-Windows executions.
297-
MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $*"
305+
MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $@"
298306
export MAVEN_CMD_LINE_ARGS
299307

300308
WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain
301309

302-
# shellcheck disable=SC2086 # safe args
303310
exec "$JAVACMD" \
304311
$MAVEN_OPTS \
305312
$MAVEN_DEBUG_OPTS \
306313
-classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \
314+
"-Dmaven.home=${M2_HOME}" \
307315
"-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \
308316
${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@"

0 commit comments

Comments
 (0)