aboutsummaryrefslogtreecommitdiff
blob: 070a3e126862830a0297f1c9918a2f8b18e40533 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
# Copyright 2021-2023 Gentoo Authors
# Distributed under the terms of the GNU General Public License v2

# @ECLASS: gradle.eclass
# @MAINTAINER:
# Gentoo Java Project <java@gentoo.org>
# @AUTHOR:
# Florian Schmaus <flow@gentoo.org>
# @BLURB: common ebuild functions for gradle-based packages.
# @DESCRIPTION:
# This eclass provides support for the gradle build system.  There
# are currently two approaches to using gradle in ebuilds.  You can either
# depend on a gradle system-wide installation from a gradle ebuild, typically
# dev-java/gradle-bin, or, bundle gradle with the ebuild.
#
# To use a system-wide gradle installation, set EGRADLE_MIN and
# EGRADLE_MAX_EXCLUSIVE and declare a BDEPEND on the gradle package.
# @CODE
# inherit gradle
# EGRADLE_MIN=7.3
# EGRADLE_MAX_EXCLUSIVE=8
#
# BDEPEND="|| (dev-java/gradle-bin:7.3 dev-java/gradle-bin:7.4)
# @CODE
#
# To use a bundled gradle version, set EGRADLE_BUNDLED_VER and add
# $(gradle_src_uri) to SRC_URI.
# @CODE
# inherit gradle
# EGRADLE_BUNDLED_VER=7.6
# SRC_URI="
#     ...
#     $(gradle_src_uri)
# "
# @CODE
#
# Afterwards, use egradle to invoke gradle.
# @CODE
# src_compile() {
#     egradle build
# }
# @CODE

case ${EAPI} in
	7|8) ;;
	*) die "${ECLASS}: EAPI ${EAPI:-0} not supported" ;;
esac

if [[ -z ${_GRADLE_ECLASS} ]] ; then
_GRADLE_ECLASS=1

inherit edo

# @ECLASS_VARIABLE: EGRADLE_MIN
# @DEFAULT_UNSET
# @DESCRIPTION:
# Minimum required gradle version.

# @ECLASS_VARIABLE: EGRADLE_MAX_EXCLUSIVE
# @DEFAULT_UNSET
# @DESCRIPTION:
# First gradle version that is not supported.

# @ECLASS_VARIABLE: EGRADLE_EXACT_VER
# @DEFAULT_UNSET
# @DESCRIPTION:
# The exact required gradle version.

# @ECLASS_VARIABLE: EGRADLE_BUNDLED_VER
# @DEFAULT_UNSET
# @DESCRIPTION:
# The gradle version that will be bundled with this package.

# @ECLASS_VARIABLE: EGRADLE_PARALLEL
# @DESCRIPTION:
# Set to the 'true', the default, to invoke gradle with --parallel. Set
# to 'false' to disable parallel gradle builds.
: "${EGRADLE_PARALLEL=true}"

# @ECLASS_VARIABLE: EGRADLE_USER_HOME
# @DESCRIPTION:
# Directroy used as the user's home directory by gradle. Defaults to
# ${T}/gradle_user_home
: "${EGRADLE_USER_HOME="${T}/gradle_user_home"}"

# @ECLASS_VARIABLE: EGRADLE_OVERWRITE
# @USER_VARIABLE
# @DEFAULT_UNSET
# @DESCRIPTION:
# User-specified overwrite of the used gradle binary.

# @FUNCTION: gradle-set_EGRADLE
# @DESCRIPTION:
# Set the EGRADLE environment variable.
gradle-set_EGRADLE() {
	[[ -n ${EGRADLE} ]] && return

	if [[ -n ${EGRADLE_OVERWRITE} ]]; then
		EGRADLE="${EGRADLE_OVERWRITE}"
		return
	fi

	if [[ -n ${EGRADLE_BUNDLED_VER} ]]; then
		EGRADLE="${WORKDIR}/gradle-${EGRADLE_BUNDLED_VER}/bin/gradle"
		return
	fi

	local candidates candidate selected selected_ver

	candidates=$(compgen -c gradle-)
	for candidate in ${candidates}; do
		if [[ ! ${candidate} =~ gradle(-bin)?-([.0-9]+) ]]; then
			continue
		fi

		local ver
		if (( ${#BASH_REMATCH[@]} == 3 )); then
			ver="${BASH_REMATCH[2]}"
		else
			ver="${BASH_REMATCH[1]}"
		fi

		if [[ -n ${EGRADLE_EXACT_VER} ]]; then
			ver_test "${ver}" -ne "${EGRADLE_EXACT_VER}" && continue

			selected="${candidate}"
			break
		fi

		if [[ -n ${EGRADLE_MIN} ]] \
			   && ver_test "${ver}" -lt "${EGRADLE_MIN}"; then
			# Candidate does not satisfy EGRADLE_MIN condition.
			continue
		fi

		if [[ -n ${EGRADLE_MAX_EXCLUSIVE} ]] \
			   && ver_test "${ver}" -ge "${EGRADLE_MAX_EXCLUSIVE}"; then
			# Candidate does not satisfy EGRADLE_MAX_EXCLUSIVE condition.
			continue
		fi

		if [[ -n ${selected_ver} ]] \
			   && ver_test "${selected_ver}" -gt "${ver}"; then
			# Candidate is older than the currently selected candidate.
			continue
		fi

		selected="${candidate}"
		selected_ver="${ver}"
	done

	if [[ -z ${selected} ]]; then
		die "Could not find (suitable) gradle installation in PATH"
	fi

	EGRADLE="${selected}"
}

# @FUNCTION: gradle-src_uri
# @DESCRIPTION:
# Generate SRC_URI data from EGRADLE_BUNDLED_VER.
gradle-src_uri() {
	if [[ -z ${EGRADLE_BUNDLED_VER} ]]; then
		die "Must set EGRADLE_BUNDLED_VER when calling gradle-src_uri"
	fi
	echo "https://services.gradle.org/distributions/gradle-${EGRADLE_BUNDLED_VER}-bin.zip"
}

# @FUNCTION: egradle
# @USAGE: [gradle-args]
# @DESCRIPTION:
# Invoke gradle with the optionally provided arguments.
egradle() {
	gradle-set_EGRADLE

	local gradle_args=(
		--console=plain
		--info
		--stacktrace
		--no-daemon
		--offline
		--no-build-cache
		--gradle-user-home "${EGRADLE_USER_HOME}"
		--project-cache-dir "${T}/gradle_project_cache"
	)

	if ${EGRADLE_PARALLEL}; then
		gradle_args+=( --parallel )
	fi

	local -x JAVA_TOOL_OPTIONS="${JAVA_TOOL_OPTIONS} -Duser.home=\"${T}\""
	# TERM needed, otherwise gradle may fail on terms it does not know about
	TERM=xterm \
		edo \
		"${EGRADLE}" "${gradle_args[@]}" "${@}"
}

fi