Gentoo Archives: gentoo-dev

From: Anna <cyber+gentoo@×××××.in>
To: gentoo-dev@l.g.o
Subject: Re: [gentoo-dev] [PATCH] gradle.eclass: add new eclass
Date: Sat, 07 Jan 2023 06:07:10
Message-Id: Y7kMBj617iBiAMLV@sysrq.in
In Reply to: [gentoo-dev] [PATCH] gradle.eclass: add new eclass by Florian Schmaus
1 On 2023-01-06 18:20, Florian Schmaus wrote:
2 > Signed-off-by: Florian Schmaus <flow@g.o>
3 > ---
4 > eclass/gradle.eclass | 149 +++++++++++++++++++++++++++++++++++++++++
5 > eclass/tests/gradle.sh | 62 +++++++++++++++++
6 > 2 files changed, 211 insertions(+)
7 > create mode 100644 eclass/gradle.eclass
8 > create mode 100755 eclass/tests/gradle.sh
9 >
10 > diff --git a/eclass/gradle.eclass b/eclass/gradle.eclass
11 > new file mode 100644
12 > index 000000000000..a321262612d0
13 > --- /dev/null
14 > +++ b/eclass/gradle.eclass
15 > @@ -0,0 +1,149 @@
16 > +# Copyright 2021-2023 Gentoo Authors
17 > +# Distributed under the terms of the GNU General Public License v2
18 > +
19 > +# @ECLASS: gradle.eclass
20
21 I think "gradle-utils" is a better name since the eclass does not export
22 any phase functions or set metadata variables (this should be noted in
23 the description btw).
24
25 > +# @MAINTAINER:
26 > +# Gentoo Java Project <java@g.o>
27 > +# @AUTHOR:
28 > +# Florian Schmaus <flow@g.o>
29 > +# @BLURB: Utility functions for the gradle build system.
30
31 First letter should not be capitalized (for manpage reasons).
32
33 > +# @DESCRIPTION:
34 > +# Utility functions for the gradle build system.
35
36 Either drop description or don't repeat blurb here.
37
38 > +
39 > +case ${EAPI} in
40 > + 7|8) ;;
41 > + *) die "${ECLASS}: EAPI ${EAPI:-0} not supported" ;;
42 > +esac
43 > +
44 > +if [[ -z ${_GRADLE_ECLASS} ]] ; then
45 > +_GRADLE_ECLASS=1
46 > +
47 > +inherit edo
48 > +
49 > +# @ECLASS_VARIABLE: EGRADLE_MIN
50 > +# @DEFAULT_UNSET
51 > +# @DESCRIPTION:
52 > +# Minimum required gradle version.
53 > +
54 > +# @ECLASS_VARIABLE: EGRADLE_MAX_EXCLUSIVE
55 > +# @DEFAULT_UNSET
56 > +# @DESCRIPTION:
57 > +# First gradle version that is not supported.
58 > +
59 > +# @ECLASS_VARIABLE: EGRADLE_EXACT_VER
60 > +# @DEFAULT_UNSET
61 > +# @DESCRIPTION:
62 > +# The exact required gradle version.
63 > +
64 > +# @ECLASS_VARIABLE: EGRADLE_PARALLEL
65 > +# @DESCRIPTION:
66 > +# Set to the 'true', the default, to invoke gradle with --parallel. Set
67 > +# to 'false' to disable parallel gradle builds.
68 > +: "${EGRADLE_PARALLEL=true}"
69
70 Can be deduced indeirectly (when "makeopts_jobs" equals to 1).
71
72 > +
73 > +# @ECLASS_VARIABLE: EGRADLE_USER_HOME
74 > +# @DESCRIPTION:
75 > +# Directroy used as the user's home directory by gradle. Defaults to
76 > +# ${T}/gradle_user_home
77 > +: "${EGRADLE_USER_HOME="${T}/gradle_user_home"}"
78
79 Can it be just ${HOME}?
80
81 > +
82 > +# @ECLASS_VARIABLE: EGRADLE_OVERWRITE
83 > +# @USER_VARIABLE
84 > +# @DEFAULT_UNSET
85 > +# @DESCRIPTION:
86 > +# User-specified overwrite of the used gradle binary.
87 > +
88 > +# @FUNCTION: gradle-set_EGRADLE
89 > +# @DESCRIPTION:
90 > +# Set the EGRADLE environment variable.
91 > +gradle-set_EGRADLE() {
92 > + [[ -n ${EGRADLE} ]] && return
93 > +
94 > + if [[ -n ${EGRADLE_OVERWRITE} ]]; then
95 > + export EGRADLE="${EGRADLE_OVERWRITE}"
96
97 Any reason to export?
98
99 > + return
100 > + fi
101 > +
102 > + local candidates candidate selected selected_ver
103 > +
104 > + candidates=$(compgen -c gradle-)
105 > + for candidate in ${candidates}; do
106 > + if [[ ! ${candidate} =~ gradle(-bin)?-([.0-9]+) ]]; then
107 > + continue
108 > + fi
109 > +
110 > + local ver
111 > + if (( ${#BASH_REMATCH[@]} == 3 )); then
112 > + ver="${BASH_REMATCH[2]}"
113 > + else
114 > + ver="${BASH_REMATCH[1]}"
115 > + fi
116 > +
117 > + if [[ -n ${EGRADLE_EXACT_VER} ]]; then
118 > + ver_test "${ver}" -ne "${EGRADLE_EXACT_VER}" && continue
119 > +
120 > + selected="${candidate}"
121 > + selected_ver="${ver}"
122 > + break
123 > + fi
124 > +
125 > + if [[ -n ${EGRADLE_MIN} ]] \
126 > + && ver_test "${ver}" -lt "${EGRADLE_MIN}"; then
127 > + # Candidate does not satisfy EGRADLE_MIN condition.
128 > + continue
129 > + fi
130 > +
131 > + if [[ -n ${EGRADLE_MAX_EXCLUSIVE} ]] \
132 > + && ver_test "${ver}" -ge "${EGRADLE_MAX_EXCLUSIVE}"; then
133 > + # Candidate does not satisfy EGRADLE_MAX_EXCLUSIVE condition.
134 > + continue
135 > + fi
136 > +
137 > + if [[ -n ${selected_ver} ]] \
138 > + && ver_test "${selected_ver}" -gt "${ver}"; then
139 > + # Candidate is older than the currently selected candidate.
140 > + continue
141 > + fi
142 > +
143 > + selected="${candidate}"
144 > + selected_ver="${ver}"
145 > + done
146 > +
147 > + if [[ -z ${selected} ]]; then
148 > + die "Could not find (suitable) gradle installation in PATH"
149 > + fi
150 > +
151 > + export EGRADLE="${selected}"
152 > + export EGRADLE_VER="${ver}"
153 > +}
154 > +
155 > +# @FUNCTION: egradle
156 > +# @USAGE: [gradle-args]
157 > +# @DESCRIPTION:
158 > +# Invoke gradle with the optionally provided arguments.
159 > +egradle() {
160 > + gradle-set_EGRADLE
161 > +
162 > + local gradle_args=(
163 > + --console=plain
164 > + --info
165 > + --stacktrace
166 > + --no-daemon
167 > + --offline
168 > + --no-build-cache
169 > + --gradle-user-home "${EGRADLE_USER_HOME}"
170 > + --project-cache-dir "${T}/gradle_project_cache"
171 > + )
172 > +
173 > + if $EGRADLE_PARALLEL; then
174
175 ${Braces}
176
177 > + gradle_args+=( --parallel )
178 > + fi
179 > +
180 > + local -x JAVA_TOOL_OPTIONS="-Duser.home=\"$T\""
181
182 ${Braces}
183
184 > + # TERM needed, otherwise gradle may fail on terms it does not know about
185 > + TERM=xterm \
186 > + edo \
187 > + "${EGRADLE}" "${gradle_args[@]}" "${@}"
188 > +}
189 > +
190 > +fi
191 > diff --git a/eclass/tests/gradle.sh b/eclass/tests/gradle.sh
192 > new file mode 100755
193 > index 000000000000..61666c1bc60e
194 > --- /dev/null
195 > +++ b/eclass/tests/gradle.sh
196 > @@ -0,0 +1,62 @@
197 > +#!/usr/bin/env bash
198 > +# Copyright 2022-2023 Gentoo Authors
199 > +# Distributed under the terms of the GNU General Public License v2
200 > +
201 > +EAPI=8
202 > +
203 > +SCRIPT_DIR=$(cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd)
204 > +cd "${SCRIPT_DIR}"
205 > +
206 > +source tests-common.sh || exit
207 > +
208 > +inherit gradle
209 > +
210 > +# TODO: hack because tests-common don't implement ver_cut
211 > +EAPI=6 inherit eapi7-ver
212 > +
213 > +test_set_EGRADLE() {
214 > + local expected_EGRADLE="${1}"
215 > +
216 > + shift
217 > +
218 > + local tmpdir
219 > + tmpdir=$(mktemp -d || die)
220 > + for pseudo_gradle in "${@}"; do
221 > + local pseudo_gradle_path="${tmpdir}/${pseudo_gradle}"
222 > + touch "${pseudo_gradle_path}"
223 > + chmod 755 "${pseudo_gradle_path}"
224 > + done
225 > +
226 > + local saved_PATH="${PATH}"
227 > + PATH="${tmpdir}"
228 > +
229 > + local test_desc=(
230 > + test_set_EGRADLE
231 > + )
232 > + [[ -v EGRADLE_MIN ]] && test_desc+=( "EGRADLE_MIN=${EGRADLE_MIN}" )
233 > + [[ -v EGRADLE_MAX_EXCLUSIVE ]] && test_desc+=( "EGRADLE_MAX_EXCLUSIVE=${EGRADLE_MAX_EXCLUSIVE}" )
234 > + test_desc+=( $@ )
235 > +
236 > + tbegin "${test_desc[@]}"
237 > + gradle-set_EGRADLE
238 > +
239 > + local saved_EGRADLE="${EGRADLE}"
240 > + unset EGRADLE
241 > +
242 > + PATH="${saved_PATH}"
243 > + rm -rf "${tmpdir}"
244 > +
245 > + [[ "${saved_EGRADLE}" == "${expected_EGRADLE}" ]]
246 > + tend $?
247 > +
248 > + if (( $? > 0 )); then
249 > + >&2 echo -e "\t expected=${expected_EGRADLE} actual=${saved_EGRADLE}"
250 > + fi
251 > +}
252 > +
253 > +test_set_EGRADLE gradle-2.0 gradle-1.0 gradle-2.0
254 > +EGRADLE_MIN=2.0 test_set_EGRADLE gradle-2.2.3 gradle-1.0 gradle-2.0 gradle-2.2.3
255 > +EGRADLE_MAX_EXCLUSIVE=2.2 test_set_EGRADLE gradle-2.0 gradle-1.0 gradle-2.0 gradle-2.2.3
256 > +
257 > +
258 > +texit
259 > --
260 > 2.38.2
261 >
262 >