Skip to content

Commit 4f81ad5

Browse files
committed
[GR-60229] Use gradle wrapper to build org.graalvm.python.gradle.plugin.
PullRequest: graalpython/3599
2 parents 2ec2361 + f5ef79e commit 4f81ad5

File tree

11 files changed

+433
-74
lines changed

11 files changed

+433
-74
lines changed

graalpython/com.oracle.graal.python.test/src/tests/standalone/test_gradle_plugin.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,8 +98,7 @@ def generate_app(self, target_dir):
9898
if file.endswith(".j"):
9999
shutil.move(os.path.join(root, file), os.path.join(root, file[0:len(file)- 1] + "java"))
100100

101-
util.patch_properties_file(os.path.join(target_dir, "gradle", "wrapper", "gradle-wrapper.properties"), self.env.get("GRADLE_DISTRIBUTION_URL_OVERRIDE"))
102-
101+
util.override_gradle_properties_file(target_dir)
103102
self.copy_build_files(target_dir)
104103

105104
def check_filelist(self, target_dir, log, check_lib=True):

graalpython/com.oracle.graal.python.test/src/tests/standalone/test_maven_plugin.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -72,11 +72,11 @@ def generate_app(self, tmpdir, target_dir, target_name, pom_template=None):
7272
shutil.copy(os.path.join(mvnw_dir, "mvnw"), os.path.join(target_dir, "mvnw"))
7373
shutil.copy(os.path.join(mvnw_dir, "mvnw.cmd"), os.path.join(target_dir, "mvnw.cmd"))
7474
shutil.copytree(os.path.join(mvnw_dir, ".mvn"), os.path.join(target_dir, ".mvn"))
75-
util.patch_properties_file(os.path.join(target_dir, ".mvn", "wrapper", "maven-wrapper.properties"), self.env.get("MAVEN_DISTRIBUTION_URL_OVERRIDE"))
75+
util.override_maven_properties_file(target_dir)
7676

7777
@unittest.skipUnless(util.is_maven_plugin_test_enabled, "ENABLE_MAVEN_PLUGIN_UNITTESTS is not true")
7878
def test_generated_app(self):
79-
with tempfile.TemporaryDirectory() as tmpdir:
79+
with util.TemporaryTestDirectory() as tmpdir:
8080
target_name = "generated_app_test"
8181
target_dir = os.path.join(str(tmpdir), target_name)
8282
self.generate_app(tmpdir, target_dir, target_name)
@@ -140,7 +140,7 @@ def test_generated_app(self):
140140

141141
@unittest.skipUnless(util.is_maven_plugin_test_enabled, "ENABLE_MAVEN_PLUGIN_UNITTESTS is not true")
142142
def test_generated_app_external_resources(self):
143-
with tempfile.TemporaryDirectory() as tmpdir:
143+
with util.TemporaryTestDirectory() as tmpdir:
144144
target_name = "generated_app_ext_resources_test"
145145
target_dir = os.path.join(str(tmpdir), target_name)
146146
self.generate_app(tmpdir, target_dir, target_name)
@@ -193,7 +193,7 @@ def test_generated_app_external_resources(self):
193193

194194
@unittest.skipUnless(util.is_maven_plugin_test_enabled, "ENABLE_MAVEN_PLUGIN_UNITTESTS is not true")
195195
def test_fail_without_graalpy_dep(self):
196-
with tempfile.TemporaryDirectory() as tmpdir:
196+
with util.TemporaryTestDirectory() as tmpdir:
197197
target_name = "fail_without_graalpy_dep_test"
198198
target_dir = os.path.join(str(tmpdir), target_name)
199199
pom_template = os.path.join(os.path.dirname(__file__), "fail_without_graalpy_dep_pom.xml")
@@ -207,7 +207,7 @@ def test_fail_without_graalpy_dep(self):
207207

208208
@unittest.skipUnless(util.is_maven_plugin_test_enabled, "ENABLE_MAVEN_PLUGIN_UNITTESTS is not true")
209209
def test_gen_launcher_and_venv(self):
210-
with tempfile.TemporaryDirectory() as tmpdir:
210+
with util.TemporaryTestDirectory() as tmpdir:
211211
target_name = "gen_launcher_and_venv_test"
212212
target_dir = os.path.join(str(tmpdir), target_name)
213213
pom_template = os.path.join(os.path.dirname(__file__), "prepare_venv_pom.xml")
@@ -247,7 +247,7 @@ def check_tagfile(self, target_dir, expected):
247247

248248
@unittest.skipUnless(util.is_maven_plugin_test_enabled, "ENABLE_MAVEN_PLUGIN_UNITTESTS is not true")
249249
def test_check_home(self):
250-
with tempfile.TemporaryDirectory() as tmpdir:
250+
with util.TemporaryTestDirectory() as tmpdir:
251251
target_name = "check_home_test"
252252
target_dir = os.path.join(str(tmpdir), target_name)
253253
pom_template = os.path.join(os.path.dirname(__file__), "check_home_pom.xml")
@@ -340,7 +340,7 @@ def test_check_home(self):
340340

341341
@unittest.skipUnless(util.is_maven_plugin_test_enabled, "ENABLE_MAVEN_PLUGIN_UNITTESTS is not true")
342342
def test_empty_packages(self):
343-
with tempfile.TemporaryDirectory() as tmpdir:
343+
with util.TemporaryTestDirectory() as tmpdir:
344344
target_name = "empty_packages_test"
345345
target_dir = os.path.join(str(tmpdir), target_name)
346346
pom_template = os.path.join(os.path.dirname(__file__), "check_packages_pom.xml")

graalpython/com.oracle.graal.python.test/src/tests/standalone/util.py

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -333,15 +333,12 @@ def replace_in_file(file, str, replace_str):
333333
with open(file, "w") as f:
334334
f.write(contents.replace(str, replace_str))
335335

336-
def patch_properties_file(properties_file, distribution_url_override):
337-
if distribution_url_override:
338-
new_lines = []
339-
with(open(properties_file)) as f:
340-
while line := f.readline():
341-
line.strip()
342-
if not line.startswith("#") and "distributionUrl" in line:
343-
new_lines.append(f"distributionUrl={distribution_url_override}\n")
344-
else:
345-
new_lines.append(line)
346-
with(open(properties_file, "w")) as f:
347-
f.writelines(new_lines)
336+
337+
def override_gradle_properties_file(gradle_project_root):
338+
if override_file:=os.environ.get('GRADLE_PROPERTIES_OVERRIDE'):
339+
shutil.copy(override_file, os.path.join(gradle_project_root, "gradle", "wrapper", "gradle-wrapper.properties"))
340+
341+
342+
def override_maven_properties_file(maven_project_root):
343+
if override_file:=os.environ.get('MAVEN_PROPERTIES_OVERRIDE'):
344+
shutil.copy(override_file, os.path.join(maven_project_root, ".mvn", "wrapper", "maven-wrapper.properties"))
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
The Gradle wrapper related files are stored in graalpython/org.graalvm.python.gradle.plugin/wrapper
2+
3+
Those files are verbatim copied over to the Gradle project generated by mx project `GradlePluginProject`.
4+
If the Gradle wrapper files ever need to be updated, they should be updated manually in the generated
5+
Gradle project in mxbuild and then copied over the "blueprint" files in
6+
graalpython/org.graalvm.python.gradle.plugin/wrapper
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
distributionBase=GRADLE_USER_HOME
2+
distributionPath=wrapper/dists
3+
distributionUrl=https\://services.gradle.org/distributions/gradle-8.10.2-bin.zip
4+
networkTimeout=10000
5+
validateDistributionUrl=true
6+
zipStoreBase=GRADLE_USER_HOME
7+
zipStorePath=wrapper/dists
Lines changed: 252 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,252 @@
1+
#!/bin/sh
2+
3+
#
4+
# Copyright © 2015-2021 the original authors.
5+
#
6+
# Licensed under the Apache License, Version 2.0 (the "License");
7+
# you may not use this file except in compliance with the License.
8+
# You may obtain a copy of the License at
9+
#
10+
# https://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# Unless required by applicable law or agreed to in writing, software
13+
# distributed under the License is distributed on an "AS IS" BASIS,
14+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
# See the License for the specific language governing permissions and
16+
# limitations under the License.
17+
#
18+
# SPDX-License-Identifier: Apache-2.0
19+
#
20+
21+
##############################################################################
22+
#
23+
# Gradle start up script for POSIX generated by Gradle.
24+
#
25+
# Important for running:
26+
#
27+
# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
28+
# noncompliant, but you have some other compliant shell such as ksh or
29+
# bash, then to run this script, type that shell name before the whole
30+
# command line, like:
31+
#
32+
# ksh Gradle
33+
#
34+
# Busybox and similar reduced shells will NOT work, because this script
35+
# requires all of these POSIX shell features:
36+
# * functions;
37+
# * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
38+
# «${var#prefix}», «${var%suffix}», and «$( cmd )»;
39+
# * compound commands having a testable exit status, especially «case»;
40+
# * various built-in commands including «command», «set», and «ulimit».
41+
#
42+
# Important for patching:
43+
#
44+
# (2) This script targets any POSIX shell, so it avoids extensions provided
45+
# by Bash, Ksh, etc; in particular arrays are avoided.
46+
#
47+
# The "traditional" practice of packing multiple parameters into a
48+
# space-separated string is a well documented source of bugs and security
49+
# problems, so this is (mostly) avoided, by progressively accumulating
50+
# options in "$@", and eventually passing that to Java.
51+
#
52+
# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
53+
# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
54+
# see the in-line comments for details.
55+
#
56+
# There are tweaks for specific operating systems such as AIX, CygWin,
57+
# Darwin, MinGW, and NonStop.
58+
#
59+
# (3) This script is generated from the Groovy template
60+
# https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
61+
# within the Gradle project.
62+
#
63+
# You can find Gradle at https://github.com/gradle/gradle/.
64+
#
65+
##############################################################################
66+
67+
# Attempt to set APP_HOME
68+
69+
# Resolve links: $0 may be a link
70+
app_path=$0
71+
72+
# Need this for daisy-chained symlinks.
73+
while
74+
APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
75+
[ -h "$app_path" ]
76+
do
77+
ls=$( ls -ld "$app_path" )
78+
link=${ls#*' -> '}
79+
case $link in #(
80+
/*) app_path=$link ;; #(
81+
*) app_path=$APP_HOME$link ;;
82+
esac
83+
done
84+
85+
# This is normally unused
86+
# shellcheck disable=SC2034
87+
APP_BASE_NAME=${0##*/}
88+
# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
89+
APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s
90+
' "$PWD" ) || exit
91+
92+
# Use the maximum available, or set MAX_FD != -1 to use that value.
93+
MAX_FD=maximum
94+
95+
warn () {
96+
echo "$*"
97+
} >&2
98+
99+
die () {
100+
echo
101+
echo "$*"
102+
echo
103+
exit 1
104+
} >&2
105+
106+
# OS specific support (must be 'true' or 'false').
107+
cygwin=false
108+
msys=false
109+
darwin=false
110+
nonstop=false
111+
case "$( uname )" in #(
112+
CYGWIN* ) cygwin=true ;; #(
113+
Darwin* ) darwin=true ;; #(
114+
MSYS* | MINGW* ) msys=true ;; #(
115+
NONSTOP* ) nonstop=true ;;
116+
esac
117+
118+
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
119+
120+
121+
# Determine the Java command to use to start the JVM.
122+
if [ -n "$JAVA_HOME" ] ; then
123+
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
124+
# IBM's JDK on AIX uses strange locations for the executables
125+
JAVACMD=$JAVA_HOME/jre/sh/java
126+
else
127+
JAVACMD=$JAVA_HOME/bin/java
128+
fi
129+
if [ ! -x "$JAVACMD" ] ; then
130+
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
131+
132+
Please set the JAVA_HOME variable in your environment to match the
133+
location of your Java installation."
134+
fi
135+
else
136+
JAVACMD=java
137+
if ! command -v java >/dev/null 2>&1
138+
then
139+
die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
140+
141+
Please set the JAVA_HOME variable in your environment to match the
142+
location of your Java installation."
143+
fi
144+
fi
145+
146+
# Increase the maximum file descriptors if we can.
147+
if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
148+
case $MAX_FD in #(
149+
max*)
150+
# In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
151+
# shellcheck disable=SC2039,SC3045
152+
MAX_FD=$( ulimit -H -n ) ||
153+
warn "Could not query maximum file descriptor limit"
154+
esac
155+
case $MAX_FD in #(
156+
'' | soft) :;; #(
157+
*)
158+
# In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
159+
# shellcheck disable=SC2039,SC3045
160+
ulimit -n "$MAX_FD" ||
161+
warn "Could not set maximum file descriptor limit to $MAX_FD"
162+
esac
163+
fi
164+
165+
# Collect all arguments for the java command, stacking in reverse order:
166+
# * args from the command line
167+
# * the main class name
168+
# * -classpath
169+
# * -D...appname settings
170+
# * --module-path (only if needed)
171+
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
172+
173+
# For Cygwin or MSYS, switch paths to Windows format before running java
174+
if "$cygwin" || "$msys" ; then
175+
APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
176+
CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
177+
178+
JAVACMD=$( cygpath --unix "$JAVACMD" )
179+
180+
# Now convert the arguments - kludge to limit ourselves to /bin/sh
181+
for arg do
182+
if
183+
case $arg in #(
184+
-*) false ;; # don't mess with options #(
185+
/?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
186+
[ -e "$t" ] ;; #(
187+
*) false ;;
188+
esac
189+
then
190+
arg=$( cygpath --path --ignore --mixed "$arg" )
191+
fi
192+
# Roll the args list around exactly as many times as the number of
193+
# args, so each arg winds up back in the position where it started, but
194+
# possibly modified.
195+
#
196+
# NB: a `for` loop captures its iteration list before it begins, so
197+
# changing the positional parameters here affects neither the number of
198+
# iterations, nor the values presented in `arg`.
199+
shift # remove old arg
200+
set -- "$@" "$arg" # push replacement arg
201+
done
202+
fi
203+
204+
205+
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
206+
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
207+
208+
# Collect all arguments for the java command:
209+
# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
210+
# and any embedded shellness will be escaped.
211+
# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
212+
# treated as '${Hostname}' itself on the command line.
213+
214+
set -- \
215+
"-Dorg.gradle.appname=$APP_BASE_NAME" \
216+
-classpath "$CLASSPATH" \
217+
org.gradle.wrapper.GradleWrapperMain \
218+
"$@"
219+
220+
# Stop when "xargs" is not available.
221+
if ! command -v xargs >/dev/null 2>&1
222+
then
223+
die "xargs is not available"
224+
fi
225+
226+
# Use "xargs" to parse quoted args.
227+
#
228+
# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
229+
#
230+
# In Bash we could simply go:
231+
#
232+
# readarray ARGS < <( xargs -n1 <<<"$var" ) &&
233+
# set -- "${ARGS[@]}" "$@"
234+
#
235+
# but POSIX shell has neither arrays nor command substitution, so instead we
236+
# post-process each arg (as a line of input to sed) to backslash-escape any
237+
# character that might be a shell metacharacter, then use eval to reverse
238+
# that process (while maintaining the separation between arguments), and wrap
239+
# the whole thing up as a single "set" statement.
240+
#
241+
# This will of course break if any of these variables contains a newline or
242+
# an unmatched quote.
243+
#
244+
245+
eval "set -- $(
246+
printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
247+
xargs -n1 |
248+
sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
249+
tr '\n' ' '
250+
)" '"$@"'
251+
252+
exec "$JAVACMD" "$@"

0 commit comments

Comments
 (0)