[gentoo-dev] [PATCH 0/2] eclass/java-{utils-2,pkg-simple}.eclass: features and enhancements

[gentoo-dev] [PATCH 0/2] eclass/java-{utils-2,pkg-simple}.eclass: features and enhancements

[zongyu]

Dear all,

     I am one of the students who attend Gentoo's Google Summer of Code
     program [1] this year. And this email is attempting to trigger a
     review for a patch for eclass/java-{utils-2,pkg-simple}.eclass.

     Java-pkg-simple.eclass is widely used by java packages that do not
     provide a build.xml for building with java-ant-2.eclass. Although
     java-pkg-simple.eclass works well right now, it still lacks some
     features [2], such as installing java resources and providing
     src_test() function.

     The patch below is trying to enable some missing features of
     java-pkg-simple.eclass, including:
     1. Since some java packages (e.g. dev-java/commons-io) has java
        resources bundled in jar files, java-pkg-simple.eclass now has a
        function java-pkg-simple_prepend_resources() to recognize and
        install those java resource files;
     2. Some java packages have a "main class" so that we can execute
        the jar file from command line. With "JAVA_MAIN_CLASS" and
        "JAVA_LAUNCHER_FILENAME", the eclass can deal with the situation
        properly;
     3. Enabling src_test() function with multiple testing frameworks
        like junit, testng, pkgdiff and so on;
     4. Pkgdiff test will compare natively compiled jar file and upstream
        provided binary jar file, to support the feature the eclass will
        fetch pre-compiled java jars and accept "JAVA_BINJAR_FILENAME" to
        identify it.
        Besides, installing binjar will help resolve circular
        dependencies, so the eclass also accepts USE="binary" and
        installs the binary jars now.

     And for java-utils-2.eclass:
     1. To support java-pkg-simple_src_test(), there is a new function
        etestng() to launch java tests with dev-java/testng.

     Finally, there is a breaking change to java-pkg-simple. Instead of
     treating "JAVA_SRC_DIR" as a string of directories separated by
     spaces, currently the eclass will treat it as an array. A few
     packages will be affected and fail to build, and the second patch
     will solve the problem.

     P.S. 
     This is the first time for me to write a patch for such a huge
     project and send such an email. I hope this email will meet your
     requirements, and I would appreciate your every response.

     Regards,
     Zhang Zongyu

     [1] the GSoC program
     https://summerofcode.withgoogle.com/projects/#4994566568017920
     [2] a related bug
     https://bugs.gentoo.org/564158

zongyu (2):
  java-pkg-simple.eclass and java-utils-2.eclass: features and
    enhancements
  patching ebuild files to support new java-pkg-simple

 dev-java/juel/juel-2.1.0-r2.ebuild            |   2 +-
 dev-java/piccolo2d/piccolo2d-3.0-r1.ebuild    |   2 +-
 .../swingx-ws-1.0_p20110515-r1.ebuild         |   4 +-
 .../xml-commons/xml-commons-1.4.01.ebuild     |   2 +-
 dev-java/xsdlib/xsdlib-20090415.ebuild        |   4 +-
 eclass/java-pkg-simple.eclass                 | 379 ++++++++++++++++--
 eclass/java-utils-2.eclass                    |  38 ++
 7 files changed, 395 insertions(+), 36 deletions(-)

-- 
2.26.2

[gentoo-dev] [PATCH 1/2] java-pkg-simple.eclass and java-utils-2.eclass: features and enhancements

[zongyu]

1) support java resources
2) support java main class and launcher
3) enable java-pkg-simple_src_test()
4) support binary jars (both for resolve circular deps and for pkgdiff test)

Signed-off-by: zongyu <zzy2529420793@gmail.com>
---
 eclass/java-pkg-simple.eclass | 379 +++++++++++++++++++++++++++++++---
 eclass/java-utils-2.eclass    |  38 ++++
 2 files changed, 388 insertions(+), 29 deletions(-)

diff --git a/eclass/java-pkg-simple.eclass b/eclass/java-pkg-simple.eclass
index 0b16cd5d40f..bfec305123f 100644
--- a/eclass/java-pkg-simple.eclass
+++ b/eclass/java-pkg-simple.eclass
@@ -22,11 +22,30 @@ if ! has java-pkg-2 ${INHERITED}; then
 	eerror "java-pkg-simple eclass can only be inherited AFTER java-pkg-2"
 fi
 
-EXPORT_FUNCTIONS src_compile src_install
+EXPORT_FUNCTIONS src_compile src_install src_test
 
 # We are only interested in finding all java source files, wherever they may be.
 S="${WORKDIR}"
 
+# handle dependencies for testing frameworks
+if has test ${JAVA_PKG_IUSE}; then
+	local test_deps
+	for framework in ${JAVA_TESTING_FRAMEWORKS}; do
+		case ${framework} in
+			junit)
+				test_deps+=" dev-java/junit:0";;
+			junit-4)
+				test_deps+=" dev-java/junit:4";;
+			pkgdiff)
+				test_deps+=" amd64? ( dev-util/pkgdiff
+					dev-util/japi-compliance-checker )";;
+			testng)
+				test_deps+=" dev-java/testng:0";;
+		esac
+	done
+	[[ ${test_deps} ]] && DEPEND="test? ( ${test_deps} )"
+fi
+
 # @ECLASS-VARIABLE: JAVA_GENTOO_CLASSPATH
 # @DEFAULT_UNSET
 # @DESCRIPTION:
@@ -45,17 +64,46 @@ S="${WORKDIR}"
 # Extra list of colon separated path elements to be put on the
 # classpath when compiling sources.
 
+# @ECLASS-VARIABLE: JAVA_CLASSPATH_EXTRA
+# @DEFAULT_UNSET
+# @DESCRIPTION:
+# An extra comma or space separated list of java packages
+# that are needed only during compiling sources.
+
+# @ECLASS-VARIABLE: JAVA_NEEDS_TOOLS
+# @DEFAULT_UNSET
+# @DESCRIPTION:
+# add tools.jar to the gentoo.classpath. Should only be used
+# for build-time purposes, the dependency is not recorded to
+# package.env.
+
 # @ECLASS-VARIABLE: JAVA_SRC_DIR
 # @DEFAULT_UNSET
 # @DESCRIPTION:
-# Directories relative to ${S} which contain the sources of the
-# application. The default of "" will be treated mostly as ${S}
-# itself. For the generated source package (if source is listed in
+# An array of directories relative to ${S} which contain the sources
+# of the application. If you set ${JAVA_SRC_DIR} to a string it works
+# as well. The default value "" means it will get all source files
+# inside ${S}.
+# For the generated source package (if source is listed in
 # ${JAVA_PKG_IUSE}), it is important that these directories are
 # actually the roots of the corresponding source trees.
 #
 # @CODE
-#	JAVA_SRC_DIR="src/java/org/gentoo"
+#	JAVA_SRC_DIR=( "impl/src/main/java/"
+#		"arquillian/weld-ee-container/src/main/java/"
+#	)
+# @CODE
+
+# @DESCRIPTION:
+# @ECLASS-VARIABLE: JAVA_RESOURCE_DIRS
+# @DEFAULT_UNSET
+# @DESCRIPTION:
+# An array of directories relative to ${S} which contain the
+# resources of the application. If you do not set the variable,
+# there will be no resources added to the compiled jar file.
+#
+# @CODE
+#	JAVA_RESOURCE_DIRS=("src/java/resources/")
 # @CODE
 
 # @ECLASS-VARIABLE: JAVA_ENCODING
@@ -68,6 +116,17 @@ S="${WORKDIR}"
 # @DESCRIPTION:
 # Additional arguments to be passed to javac.
 
+# @ECLASS-VARIABLE: JAVA_MAIN_CLASS
+# @DEFAULT_UNSET
+# @DESCRIPTION:
+# If the java has a main class, you are going to set the
+# variable so that we can generate a proper MANIFEST.MF
+# and create a launcher.
+#
+# @CODE
+#	JAVA_MAIN_CLASS="org.gentoo.java.ebuilder.Main"
+# @CODE
+
 # @ECLASS-VARIABLE: JAVADOC_ARGS
 # @DEFAULT_UNSET
 # @DESCRIPTION:
@@ -78,34 +137,217 @@ S="${WORKDIR}"
 # The name of the jar file to create and install.
 : ${JAVA_JAR_FILENAME:=${PN}.jar}
 
+# @ECLASS-VARIABLE: JAVA_BINJAR_FILENAME
+# @DEFAULT_UNSET
+# @DESCRIPTION:
+# The name of the binary jar file to be installed if
+# USE FLAG 'binary' is set.
+
+# @ECLASS-VARIABLE: JAVA_LAUNCHER_FILENAME
+# @DESCRIPTION:
+# If ${JAVA_MAIN_CLASS} is set, we will create a launcher to
+# execute the jar, and ${JAVA_LAUNCHER_FILENAME} will be the
+# name of the script.
+: ${JAVA_LAUNCHER_FILENAME:=${PN}-${SLOT}}
+
+# @ECLASS-VARIABLE: JAVA_TESTING_FRAMEWORKS
+# @DEFAULT_UNSET
+# @DESCRIPTION:
+# A space separated list that defines which tests it should launch
+# during src_test.
+#
+# @CODE
+# JAVA_TESTING_FRAMEWORKS="junit pkgdiff"
+# @CODE
+
+# @ECLASS-VARIABLE: JAVA_TEST_EXCLUDES
+# @DEFAULT_UNSET
+# @DESCRIPTION:
+# A array of classes that should not be executed during src_test().
+#
+# @CODE
+# JAVA_TEST_EXCLUDES=( "net.sf.cglib.CodeGenTestCase" "net.sf.cglib.TestAll" )
+# @CODE
+
+# @ECLASS-VARIABLE: JAVA_TEST_GENTOO_CLASSPATH
+# @DEFAULT_UNSET
+# @DESCRIPTION:
+# The extra classpath we need while compiling and running the
+# source code for testing.
+
+# @ECLASS-VARIABLE: JAVA_TEST_SRC_DIR
+# @DEFAULT_UNSET
+# @DESCRIPTION:
+# An array of directories relative to ${S} which contain the
+# sources for testing. It is almost equivalent to
+# ${JAVA_SRC_DIR} in src_test.
+
+# @ECLASS-VARIABLE: JAVA_TEST_RESOURCE_DIRS
+# @DEFAULT_UNSET
+# @DESCRIPTION:
+# It is almost equivalent to ${JAVA_RESOURCE_DIRS} in src_test.
+
+# @FUNCTION: java-pkg-simple_getclasspath
+# @USAGE: java-pkg-simple_getclasspath [--runtime-only]
+# @INTERNAL
+# @DESCRIPTION:
+# Get proper ${classpath} from ${JAVA_GENTOO_CLASSPATH_EXTRA},
+# ${JAVA_NEEDS_TOOLS}, ${JAVA_CLASSPATH_EXTRA} and
+# ${JAVA_GENTOO_CLASSPATH}. We use it inside
+# java-pkg-simple_src_compile and java-pkg-simple_src_test.
+#
+# Note that if you need to define a "classpath" variable before
+# calling this function.
+java-pkg-simple_getclasspath() {
+	debug-print-function ${FUNCNAME} $*
+
+	local denpendency
+	local deep_jars="--with-dependencies"
+	local buildonly_jars="--build-only"
+
+	# the extra classes that are not installed by portage
+	classpath+=":${JAVA_GENTOO_CLASSPATH_EXTRA}"
+
+	# whether we need tools.jar
+	[[ ${JAVA_NEEDS_TOOLS} ]] && classpath+=":$(java-config --tools)"
+
+	# the extra classes that are installed by portage
+	for dependency in ${JAVA_CLASSPATH_EXTRA}; do
+		classpath="${classpath}:$(java-pkg_getjars ${buildonly_jars}\
+			${deep_jars} ${dependency})"
+	done
+
+	# add test dependencies if USE FLAG 'test' is set
+	if has test ${JAVA_PKG_IUSE} && use test; then
+		for dependency in ${JAVA_TEST_GENTOO_CLASSPATH}; do
+			classpath="${classpath}:$(java-pkg_getjars ${buildonly_jars}\
+				${deep_jars} ${dependency})"
+		done
+	fi
+
+	# add the RUNTIME dependencies
+	for dependency in ${JAVA_GENTOO_CLASSPATH}; do
+		classpath="${classpath}:$(java-pkg_getjars ${deep_jars} ${dependency})"
+	done
+
+	# purify classpath
+	while [[ $classpath = *::* ]]; do classpath="${classpath//::/:}"; done
+	classpath=${classpath%:}
+	classpath=${classpath#:}
+
+	debug-print "CLASSPATH=${classpath}"
+}
+
+# @FUNCTION: java-pkg-simple_test_with_pkgdiff_
+# @INTERNAL
+# @DESCRIPTION:
+# use japi-compliance-checker the ensure the compabitily of \*.class files,
+# Besides, use pkgdiff to ensure the compabilty of resources.
+java-pkg-simple_test_with_pkgdiff_() {
+	debug-print-function ${FUNCNAME} $*
+
+	if [[ ! ${ARCH} == "amd64" ]]; then
+		elog "For architectures other than amd64, "\
+			"the pkgdiff test is currently unavailable "\
+			"because 'dev-util/japi-compliance-checker "\
+			"and 'dev-util/pkgdiff' do not support those architectures."
+		return
+	fi
+
+	local report1=${PN}-japi-compliance-checker.html
+	local report2=${PN}-pkgdiff.html
+
+	# pkgdiff test
+	if [[ -f "${DISTDIR}/${JAVA_BINJAR_FILENAME}" ]]; then
+		# pkgdiff cannot deal with symlinks, so this is a workaround
+		cp "${DISTDIR}/${JAVA_BINJAR_FILENAME}" ./ \
+			|| die "Cannot copy binjar file to ${S}."
+
+		# japi-compliance-checker
+		japi-compliance-checker ${JAVA_BINJAR_FILENAME} ${JAVA_JAR_FILENAME}\
+			--lib=${PN} -v1 ${PV}-bin -v2 ${PV} -report-path ${report1}\
+			--binary\
+			|| die "japi-compliance-checker returns $?,"\
+				"check the report in ${S}/${report1}"
+
+		# ignore META-INF since it does not matter
+		# ignore classes because japi-compilance checker will take care of it
+		pkgdiff ${JAVA_BINJAR_FILENAME} ${JAVA_JAR_FILENAME}\
+			-vnum1 ${PV}-bin -vnum2 ${PV}\
+			-skip-pattern "META-INF|.class$"\
+			-name ${PN} -report-path ${report2}\
+			|| die "pkgdiff returns $?, check the report in ${S}/${report2}"
+	fi
+}
+
+# @FUNCTION: java-pkg-simple_prepend_resources
+# @USAGE: java-pkg-simple_prepend-resources <${classes}> <"${RESOURCE_DIRS[@]}">
+# @INTERNAL
+# @DESCRIPTION:
+# Copy things under "${JAVA_RESOURCE_DIRS[@]}" or "${JAVA_TEST_RESOURCE_DIRS[@]}"
+# to ${classes}, so that `jar` will package resources together with classes.
+#
+# Note that you need to define a "classes" variable before calling
+# this function.
+java-pkg-simple_prepend_resources() {
+	debug-print-function ${FUNCNAME} $*
+
+	local destination="${1}"
+	shift 1
+
+	# return if there is no resource dirs defined
+	[[ "$@" ]] || return
+	local resources=("${@}")
+
+	# add resources directory to classpath
+	for resource in "${resources[@]}"; do
+		cp -rT "${resource:-.}" "${destination}"\
+			|| die "Could copy resources to ${destination}"
+	done
+}
+
 # @FUNCTION: java-pkg-simple_src_compile
 # @DESCRIPTION:
 # src_compile for simple bare source java packages. Finds all *.java
 # sources in ${JAVA_SRC_DIR}, compiles them with the classpath
 # calculated from ${JAVA_GENTOO_CLASSPATH}, and packages the resulting
-# classes to ${JAVA_JAR_FILENAME}.
+# classes to a single ${JAVA_JAR_FILENAME}. If the file
+# target/META-INF/MANIFEST.MF exists, it is used as the manifest of the
+# created jar.
+#
+# If USE FLAG 'binary' exists and is set, it will just copy
+# ${JAVA_BINJAR_FILENAME} to ${S} and skip the rest of src_compile.
 java-pkg-simple_src_compile() {
 	local sources=sources.lst classes=target/classes apidoc=target/api
 
 	# auto generate classpath
 	java-pkg_gen-cp JAVA_GENTOO_CLASSPATH
 
+	# do not compile if we decide to install binary jar
+	if has binary ${JAVA_PKG_IUSE} && use binary; then
+		# register the runtime dependencies
+		for dependency in ${JAVA_GENTOO_CLASSPATH//,/ }; do
+			java-pkg_record-jar_ ${dependency}
+		done
+
+		cp "${DISTDIR}"/${JAVA_BINJAR_FILENAME} ${JAVA_JAR_FILENAME}\
+			|| die "Could not copy the binary jar file to ${S}"
+		return 0
+	fi
+
 	# gather sources
-	find ${JAVA_SRC_DIR:-*} -name \*.java > ${sources}
+	find "${JAVA_SRC_DIR[@]}" -name \*.java > ${sources}
+
+	# create the target directory
 	mkdir -p ${classes} || die "Could not create target directory"
 
 	# compile
-	local classpath="${JAVA_GENTOO_CLASSPATH_EXTRA}" dependency
-	for dependency in ${JAVA_GENTOO_CLASSPATH}; do
-		classpath="${classpath}:$(java-pkg_getjars ${dependency})" \
-			|| die "getjars failed for ${dependency}"
-	done
-	while [[ $classpath = *::* ]]; do classpath="${classpath//::/:}"; done
-	classpath=${classpath%:}
-	classpath=${classpath#:}
-	debug-print "CLASSPATH=${classpath}"
-	ejavac -d ${classes} -encoding ${JAVA_ENCODING} \
-		${classpath:+-classpath ${classpath}} ${JAVAC_ARGS} \
+	local classpath=""
+	java-pkg-simple_getclasspath
+	java-pkg-simple_prepend_resources ${classes} "${JAVA_RESOURCE_DIRS[@]}"
+
+	ejavac -d ${classes} -encoding ${JAVA_ENCODING}\
+		${classpath:+-classpath ${classpath}} ${JAVAC_ARGS}\
 		@${sources}
 
 	# javadoc
@@ -118,25 +360,33 @@ java-pkg-simple_src_compile() {
 	fi
 
 	# package
-	local jar_args="cf ${JAVA_JAR_FILENAME}"
+	local jar_args
 	if [[ -e ${classes}/META-INF/MANIFEST.MF ]]; then
 		jar_args="cfm ${JAVA_JAR_FILENAME} ${classes}/META-INF/MANIFEST.MF"
+	elif [[ ${JAVA_MAIN_CLASS} ]]; then
+		jar_args="cfe ${JAVA_JAR_FILENAME} ${JAVA_MAIN_CLASS}"
+	else
+		jar_args="cf ${JAVA_JAR_FILENAME}"
 	fi
 	jar ${jar_args} -C ${classes} . || die "jar failed"
 }
 
 # @FUNCTION: java-pkg-simple_src_install
 # @DESCRIPTION:
-# src_install for simple single jar java packages. Simply packages the
-# contents from the target directory and installs it as
-# ${JAVA_JAR_FILENAME}. If the file target/META-INF/MANIFEST.MF exists,
-# it is used as the manifest of the created jar.
+# src_install for simple single jar java packages. Simply installs
+# ${JAVA_JAR_FILENAME}. It will also install a launcher if
+# ${JAVA_MAIN_CLASS} is set.
 java-pkg-simple_src_install() {
 	local sources=sources.lst classes=target/classes apidoc=target/api
 
-	# main jar
+	# install the jar file that we need
 	java-pkg_dojar ${JAVA_JAR_FILENAME}
 
+	# install a wrapper if ${JAVA_MAIN_CLASS} is defined
+	if [[ ${JAVA_MAIN_CLASS} ]]; then
+		java-pkg_dolauncher "${JAVA_LAUNCHER_FILENAME}" --main ${JAVA_MAIN_CLASS}
+	fi
+
 	# javadoc
 	if has doc ${JAVA_PKG_IUSE} && use doc; then
 		java-pkg_dojavadoc ${apidoc}
@@ -145,12 +395,10 @@ java-pkg-simple_src_install() {
 	# dosrc
 	if has source ${JAVA_PKG_IUSE} && use source; then
 		local srcdirs=""
-		if [[ ${JAVA_SRC_DIR} ]]; then
+		if [[ "${JAVA_SRC_DIR[@]}" ]]; then
 			local parent child
-			for parent in ${JAVA_SRC_DIR}; do
-				for child in ${parent}/*; do
-					srcdirs="${srcdirs} ${child}"
-				done
+			for parent in "${JAVA_SRC_DIR[@]}"; do
+				srcdirs="${srcdirs} ${parent}"
 			done
 		else
 			# take all directories actually containing any sources
@@ -159,3 +407,76 @@ java-pkg-simple_src_install() {
 		java-pkg_dosrc ${srcdirs}
 	fi
 }
+
+# @FUNCTION: java-pkg-simple_src_test
+# @DESCRIPTION:
+# src_test for simple single java jar file.
+# It will perform test with frameworks that are defined in
+# ${JAVA_TESTING_FRAMEWORKS}.
+java-pkg-simple_src_test() {
+	local test_sources=test_sources.lst classes=target/test-classes
+	local tests_to_run classpath
+
+	# do not continue if the USE FLAG 'test' is explicitly unset
+	# or no ${JAVA_TESTING_FRSerializingCAMEWORKS} specified
+	if ! has test ${JAVA_PKG_IUSE}; then
+		return
+	elif ! use test; then
+		return
+	elif [[ ! "${JAVA_TESTING_FRAMEWORKS}" ]]; then
+		return
+	fi
+
+	# create the target directory
+	mkdir -p ${classes} || die "Could not create target directory for testing"
+
+	# get classpath
+	classpath="${classes}:${JAVA_JAR_FILENAME}"
+	java-pkg-simple_getclasspath
+	java-pkg-simple_prepend_resources ${classes} "${JAVA_TEST_RESOURCE_DIRS[@]}"
+
+	# gathering sources for testing
+	find "${JAVA_TEST_SRC_DIR[@]}" -name \*.java > ${test_sources}
+
+	# compile
+	[[ -s ${test_sources} ]] && ejavac -d ${classes} ${JAVAC_ARGS} \
+		-encoding ${JAVA_ENCODING} ${classpath:+-classpath ${classpath}} \
+		@${test_sources}
+
+	# grab a set of tests that testing framework will run
+	tests_to_run=$(find "${classes}" -type f\
+		\( -name "*Test.class"\
+		-o -name "Test*.class"\
+		-o -name "*Tests.class"\
+		-o -name "*TestCase.class" \)\
+		! -name "*Abstract*"\
+		! -name "*BaseTest*"\
+		! -name "*TestTypes*"\
+		! -name "*TestUtils*"\
+		! -name "*\$*")
+	tests_to_run=${tests_to_run//"${classes}"\/}
+	tests_to_run=${tests_to_run//.class}
+	tests_to_run=${tests_to_run//\//.}
+
+	# exclude extra test classes, usually corner cases
+	#   that the code above cannot handle
+	for class in "${JAVA_TEST_EXCLUDES[@]}"; do
+		tests_to_run=${tests_to_run//${class}}
+	done
+
+	# launch test
+	for framework in ${JAVA_TESTING_FRAMEWORKS}; do
+		case ${framework} in
+			junit)
+				ejunit -classpath "${classpath}" ${tests_to_run};;
+			junit-4)
+				ejunit4 -classpath "${classpath}" ${tests_to_run};;
+			pkgdiff)
+				java-pkg-simple_test_with_pkgdiff_;;
+			testng)
+				etestng -classpath "${classpath}" ${tests_to_run};;
+			*)
+				elog "No suitable function found for framework ${framework}"
+		esac
+	done
+}
diff --git a/eclass/java-utils-2.eclass b/eclass/java-utils-2.eclass
index 29f13e031f4..a33962f114d 100644
--- a/eclass/java-utils-2.eclass
+++ b/eclass/java-utils-2.eclass
@@ -1861,6 +1861,44 @@ ejunit4() {
 	ejunit_ "junit-4" "${@}"
 }
 
+# @FUNCTION: etestng
+# @USAGE: etestng_ [-cp $classpath] <test classes>
+# @INTERNAL
+# @DESCRIPTION:
+# Testng wrapper function. Makes it easier to run the tests.
+# Launches the tests using org.testng.TestNG.
+#
+# @CODE
+# $1 - -cp or -classpath
+# $2 - the classpath passed to it
+# $@ - test classes for testng to run.
+# @CODE
+etestng() {
+	debug-print-function ${FUNCNAME} $*
+
+	local runner=org.testng.TestNG
+	local cp=$(java-pkg_getjars --with-dependencies testng)
+	local tests
+
+	if [[ ${1} = -cp || ${1} = -classpath ]]; then
+		cp="${cp}:${2}"
+		shift 2
+	else
+		cp="${cp}:."
+	fi
+
+	for test in ${@}; do
+		tests+="${test},"
+	done
+
+	debug-print "java -cp \"${cp}\" -Djava.io.tmpdir=\"${T}\""\
+		"-Djava.awt.headless=true ${runner}"\
+		"-usedefaultlisteners false -testclass ${tests}"
+	java -cp "${cp}" -Djava.io.tmpdir=\"${T}\" -Djava.awt.headless=true\
+		${runner} -usedefaultlisteners false -testclass ${tests}\
+		|| die "Running TestNG failed."
+}
+
 # @FUNCTION: java-utils-2_src_prepare
 # @DESCRIPTION:
 # src_prepare Searches for bundled jars
-- 
2.26.2

[gentoo-dev] [PATCH 2/2] patching ebuild files to support new java-pkg-simple

[zongyu]

Signed-off-by: zongyu <zzy2529420793@gmail.com>
---
 dev-java/juel/juel-2.1.0-r2.ebuild                   | 2 +-
 dev-java/piccolo2d/piccolo2d-3.0-r1.ebuild           | 2 +-
 dev-java/swingx-ws/swingx-ws-1.0_p20110515-r1.ebuild | 4 ++--
 dev-java/xml-commons/xml-commons-1.4.01.ebuild       | 2 +-
 dev-java/xsdlib/xsdlib-20090415.ebuild               | 4 ++--
 5 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/dev-java/juel/juel-2.1.0-r2.ebuild b/dev-java/juel/juel-2.1.0-r2.ebuild
index 052a8b4e96e..6b7b4c894a2 100644
--- a/dev-java/juel/juel-2.1.0-r2.ebuild
+++ b/dev-java/juel/juel-2.1.0-r2.ebuild
@@ -26,7 +26,7 @@ DEPEND="
 
 S="${WORKDIR}/${P}"
 
-JAVA_SRC_DIR="src/api src/impl"
+JAVA_SRC_DIR=( "src/api" "src/impl" )
 
 java_prepare() {
 	java-pkg_clean
diff --git a/dev-java/piccolo2d/piccolo2d-3.0-r1.ebuild b/dev-java/piccolo2d/piccolo2d-3.0-r1.ebuild
index 6193eb4112a..bd8cd931c7e 100644
--- a/dev-java/piccolo2d/piccolo2d-3.0-r1.ebuild
+++ b/dev-java/piccolo2d/piccolo2d-3.0-r1.ebuild
@@ -29,7 +29,7 @@ DEPEND="
 
 S="${WORKDIR}/${PN}.java-${PN}-complete-${PV}"
 JAVA_GENTOO_CLASSPATH="swt-3.8"
-JAVA_SRC_DIR="core extras swt"
+JAVA_SRC_DIR=( "core" "extras" "swt" )
 
 java_prepare() {
 	rm -rf core/src/test extras/src/test swt/src/test || die
diff --git a/dev-java/swingx-ws/swingx-ws-1.0_p20110515-r1.ebuild b/dev-java/swingx-ws/swingx-ws-1.0_p20110515-r1.ebuild
index d417f67fd56..a9667ffec75 100644
--- a/dev-java/swingx-ws/swingx-ws-1.0_p20110515-r1.ebuild
+++ b/dev-java/swingx-ws/swingx-ws-1.0_p20110515-r1.ebuild
@@ -37,7 +37,7 @@ DEPEND="
 	app-arch/unzip"
 
 S="${WORKDIR}/${MY_P}/src"
-JAVA_SRC_DIR="beaninfo java"
+JAVA_SRC_DIR=( "beaninfo" "java" )
 
 src_prepare() {
 	default
@@ -61,7 +61,7 @@ src_compile() {
 	java-pkg-simple_src_compile
 
 	local DIR
-	for DIR in ${JAVA_SRC_DIR}; do
+	for DIR in "${JAVA_SRC_DIR[@]}"; do
 		java-pkg_addres ${PN}.jar ${DIR}
 	done
 }
diff --git a/dev-java/xml-commons/xml-commons-1.4.01.ebuild b/dev-java/xml-commons/xml-commons-1.4.01.ebuild
index 25d9caa3b6a..028c71cf67d 100644
--- a/dev-java/xml-commons/xml-commons-1.4.01.ebuild
+++ b/dev-java/xml-commons/xml-commons-1.4.01.ebuild
@@ -26,4 +26,4 @@ DEPEND="
 	>=virtual/jdk-1.6
 	source? ( app-arch/zip )"
 
-JAVA_SRC_DIR="org javax"
+JAVA_SRC_DIR=( "org" "javax" )
diff --git a/dev-java/xsdlib/xsdlib-20090415.ebuild b/dev-java/xsdlib/xsdlib-20090415.ebuild
index c317785fc9f..0cb2aba0120 100644
--- a/dev-java/xsdlib/xsdlib-20090415.ebuild
+++ b/dev-java/xsdlib/xsdlib-20090415.ebuild
@@ -31,13 +31,13 @@ java_prepare() {
 	find -name '*.jar' -exec rm -v {} + || die
 }
 
-JAVA_SRC_DIR="src src-apache"
+JAVA_SRC_DIR=( "src" "src-apache" )
 JAVA_GENTOO_CLASSPATH="relaxng-datatype,xerces-2"
 
 src_compile() {
 	java-pkg-simple_src_compile
 
-	local dir; for dir in ${JAVA_SRC_DIR}; do
+	local dir; for dir in "${JAVA_SRC_DIR[@]}"; do
 		pushd ${dir} > /dev/null || die
 			jar -uf "${S}"/${PN}.jar $(find -name '*.properties') || die
 		popd > /dev/null
-- 
2.26.2

Re: [gentoo-dev] [PATCH 1/2] java-pkg-simple.eclass and java-utils-2.eclass: features and enhancements

[Joonas Niilola]

[-- Attachment #1.1: Type: text/plain, Size: 296 bytes --]


On 8/25/20 6:46 PM, zongyu wrote:
> Signed-off-by: zongyu <zzy2529420793@gmail.com>

Hey, these patches can't be applied as-is due to this sign-off. Please
see https://www.gentoo.org/glep/glep-0076.html#certificate-of-origin

This is probably just your "mis"configured git settings.



[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 642 bytes --]

[gentoo-dev] [PATCHv2 0/2] java-pkg-simple.eclass and java-utils-2.eclass: features and enhancements

[Zhang Zongyu]

Hello,
        I am sorry for the misconfiguration, and here is the new patch
        that is signed off with my full name.

        Regards,
        Zhang Zongyu

        P.S. If you are interested in the new features of the eclass,
        here is an overlay for testing new features of the patched
        java-pkg-simple.eclass:
        https://github.com/6-6-6/test-java-pkg-simple

Zhang Zongyu (2):
  java-pkg-simple.eclass and java-utils-2.eclass: features and
    enhancements
  patching ebuild files to support new java-pkg-simple

 dev-java/juel/juel-2.1.0-r2.ebuild            |   2 +-
 dev-java/piccolo2d/piccolo2d-3.0-r1.ebuild    |   2 +-
 .../swingx-ws-1.0_p20110515-r1.ebuild         |   4 +-
 .../xml-commons/xml-commons-1.4.01.ebuild     |   2 +-
 dev-java/xsdlib/xsdlib-20090415.ebuild        |   4 +-
 eclass/java-pkg-simple.eclass                 | 379 ++++++++++++++++--
 eclass/java-utils-2.eclass                    |  38 ++
 7 files changed, 395 insertions(+), 36 deletions(-)

-- 
2.26.2

[gentoo-dev] [PATCHv2 1/2] java-pkg-simple.eclass and java-utils-2.eclass: features and enhancements

[Zhang Zongyu]

1) support java resources
2) support java main class and launcher
3) enable java-pkg-simple_src_test()
4) support binary jars (both for resolve circular deps and for pkgdiff test)

Signed-off-by: Zhang Zongyu <zzy2529420793@gmail.com>
---
 eclass/java-pkg-simple.eclass | 379 +++++++++++++++++++++++++++++++---
 eclass/java-utils-2.eclass    |  38 ++++
 2 files changed, 388 insertions(+), 29 deletions(-)

diff --git a/eclass/java-pkg-simple.eclass b/eclass/java-pkg-simple.eclass
index 0b16cd5d40f..bfec305123f 100644
--- a/eclass/java-pkg-simple.eclass
+++ b/eclass/java-pkg-simple.eclass
@@ -22,11 +22,30 @@ if ! has java-pkg-2 ${INHERITED}; then
 	eerror "java-pkg-simple eclass can only be inherited AFTER java-pkg-2"
 fi
 
-EXPORT_FUNCTIONS src_compile src_install
+EXPORT_FUNCTIONS src_compile src_install src_test
 
 # We are only interested in finding all java source files, wherever they may be.
 S="${WORKDIR}"
 
+# handle dependencies for testing frameworks
+if has test ${JAVA_PKG_IUSE}; then
+	local test_deps
+	for framework in ${JAVA_TESTING_FRAMEWORKS}; do
+		case ${framework} in
+			junit)
+				test_deps+=" dev-java/junit:0";;
+			junit-4)
+				test_deps+=" dev-java/junit:4";;
+			pkgdiff)
+				test_deps+=" amd64? ( dev-util/pkgdiff
+					dev-util/japi-compliance-checker )";;
+			testng)
+				test_deps+=" dev-java/testng:0";;
+		esac
+	done
+	[[ ${test_deps} ]] && DEPEND="test? ( ${test_deps} )"
+fi
+
 # @ECLASS-VARIABLE: JAVA_GENTOO_CLASSPATH
 # @DEFAULT_UNSET
 # @DESCRIPTION:
@@ -45,17 +64,46 @@ S="${WORKDIR}"
 # Extra list of colon separated path elements to be put on the
 # classpath when compiling sources.
 
+# @ECLASS-VARIABLE: JAVA_CLASSPATH_EXTRA
+# @DEFAULT_UNSET
+# @DESCRIPTION:
+# An extra comma or space separated list of java packages
+# that are needed only during compiling sources.
+
+# @ECLASS-VARIABLE: JAVA_NEEDS_TOOLS
+# @DEFAULT_UNSET
+# @DESCRIPTION:
+# add tools.jar to the gentoo.classpath. Should only be used
+# for build-time purposes, the dependency is not recorded to
+# package.env.
+
 # @ECLASS-VARIABLE: JAVA_SRC_DIR
 # @DEFAULT_UNSET
 # @DESCRIPTION:
-# Directories relative to ${S} which contain the sources of the
-# application. The default of "" will be treated mostly as ${S}
-# itself. For the generated source package (if source is listed in
+# An array of directories relative to ${S} which contain the sources
+# of the application. If you set ${JAVA_SRC_DIR} to a string it works
+# as well. The default value "" means it will get all source files
+# inside ${S}.
+# For the generated source package (if source is listed in
 # ${JAVA_PKG_IUSE}), it is important that these directories are
 # actually the roots of the corresponding source trees.
 #
 # @CODE
-#	JAVA_SRC_DIR="src/java/org/gentoo"
+#	JAVA_SRC_DIR=( "impl/src/main/java/"
+#		"arquillian/weld-ee-container/src/main/java/"
+#	)
+# @CODE
+
+# @DESCRIPTION:
+# @ECLASS-VARIABLE: JAVA_RESOURCE_DIRS
+# @DEFAULT_UNSET
+# @DESCRIPTION:
+# An array of directories relative to ${S} which contain the
+# resources of the application. If you do not set the variable,
+# there will be no resources added to the compiled jar file.
+#
+# @CODE
+#	JAVA_RESOURCE_DIRS=("src/java/resources/")
 # @CODE
 
 # @ECLASS-VARIABLE: JAVA_ENCODING
@@ -68,6 +116,17 @@ S="${WORKDIR}"
 # @DESCRIPTION:
 # Additional arguments to be passed to javac.
 
+# @ECLASS-VARIABLE: JAVA_MAIN_CLASS
+# @DEFAULT_UNSET
+# @DESCRIPTION:
+# If the java has a main class, you are going to set the
+# variable so that we can generate a proper MANIFEST.MF
+# and create a launcher.
+#
+# @CODE
+#	JAVA_MAIN_CLASS="org.gentoo.java.ebuilder.Main"
+# @CODE
+
 # @ECLASS-VARIABLE: JAVADOC_ARGS
 # @DEFAULT_UNSET
 # @DESCRIPTION:
@@ -78,34 +137,217 @@ S="${WORKDIR}"
 # The name of the jar file to create and install.
 : ${JAVA_JAR_FILENAME:=${PN}.jar}
 
+# @ECLASS-VARIABLE: JAVA_BINJAR_FILENAME
+# @DEFAULT_UNSET
+# @DESCRIPTION:
+# The name of the binary jar file to be installed if
+# USE FLAG 'binary' is set.
+
+# @ECLASS-VARIABLE: JAVA_LAUNCHER_FILENAME
+# @DESCRIPTION:
+# If ${JAVA_MAIN_CLASS} is set, we will create a launcher to
+# execute the jar, and ${JAVA_LAUNCHER_FILENAME} will be the
+# name of the script.
+: ${JAVA_LAUNCHER_FILENAME:=${PN}-${SLOT}}
+
+# @ECLASS-VARIABLE: JAVA_TESTING_FRAMEWORKS
+# @DEFAULT_UNSET
+# @DESCRIPTION:
+# A space separated list that defines which tests it should launch
+# during src_test.
+#
+# @CODE
+# JAVA_TESTING_FRAMEWORKS="junit pkgdiff"
+# @CODE
+
+# @ECLASS-VARIABLE: JAVA_TEST_EXCLUDES
+# @DEFAULT_UNSET
+# @DESCRIPTION:
+# A array of classes that should not be executed during src_test().
+#
+# @CODE
+# JAVA_TEST_EXCLUDES=( "net.sf.cglib.CodeGenTestCase" "net.sf.cglib.TestAll" )
+# @CODE
+
+# @ECLASS-VARIABLE: JAVA_TEST_GENTOO_CLASSPATH
+# @DEFAULT_UNSET
+# @DESCRIPTION:
+# The extra classpath we need while compiling and running the
+# source code for testing.
+
+# @ECLASS-VARIABLE: JAVA_TEST_SRC_DIR
+# @DEFAULT_UNSET
+# @DESCRIPTION:
+# An array of directories relative to ${S} which contain the
+# sources for testing. It is almost equivalent to
+# ${JAVA_SRC_DIR} in src_test.
+
+# @ECLASS-VARIABLE: JAVA_TEST_RESOURCE_DIRS
+# @DEFAULT_UNSET
+# @DESCRIPTION:
+# It is almost equivalent to ${JAVA_RESOURCE_DIRS} in src_test.
+
+# @FUNCTION: java-pkg-simple_getclasspath
+# @USAGE: java-pkg-simple_getclasspath [--runtime-only]
+# @INTERNAL
+# @DESCRIPTION:
+# Get proper ${classpath} from ${JAVA_GENTOO_CLASSPATH_EXTRA},
+# ${JAVA_NEEDS_TOOLS}, ${JAVA_CLASSPATH_EXTRA} and
+# ${JAVA_GENTOO_CLASSPATH}. We use it inside
+# java-pkg-simple_src_compile and java-pkg-simple_src_test.
+#
+# Note that if you need to define a "classpath" variable before
+# calling this function.
+java-pkg-simple_getclasspath() {
+	debug-print-function ${FUNCNAME} $*
+
+	local denpendency
+	local deep_jars="--with-dependencies"
+	local buildonly_jars="--build-only"
+
+	# the extra classes that are not installed by portage
+	classpath+=":${JAVA_GENTOO_CLASSPATH_EXTRA}"
+
+	# whether we need tools.jar
+	[[ ${JAVA_NEEDS_TOOLS} ]] && classpath+=":$(java-config --tools)"
+
+	# the extra classes that are installed by portage
+	for dependency in ${JAVA_CLASSPATH_EXTRA}; do
+		classpath="${classpath}:$(java-pkg_getjars ${buildonly_jars}\
+			${deep_jars} ${dependency})"
+	done
+
+	# add test dependencies if USE FLAG 'test' is set
+	if has test ${JAVA_PKG_IUSE} && use test; then
+		for dependency in ${JAVA_TEST_GENTOO_CLASSPATH}; do
+			classpath="${classpath}:$(java-pkg_getjars ${buildonly_jars}\
+				${deep_jars} ${dependency})"
+		done
+	fi
+
+	# add the RUNTIME dependencies
+	for dependency in ${JAVA_GENTOO_CLASSPATH}; do
+		classpath="${classpath}:$(java-pkg_getjars ${deep_jars} ${dependency})"
+	done
+
+	# purify classpath
+	while [[ $classpath = *::* ]]; do classpath="${classpath//::/:}"; done
+	classpath=${classpath%:}
+	classpath=${classpath#:}
+
+	debug-print "CLASSPATH=${classpath}"
+}
+
+# @FUNCTION: java-pkg-simple_test_with_pkgdiff_
+# @INTERNAL
+# @DESCRIPTION:
+# use japi-compliance-checker the ensure the compabitily of \*.class files,
+# Besides, use pkgdiff to ensure the compabilty of resources.
+java-pkg-simple_test_with_pkgdiff_() {
+	debug-print-function ${FUNCNAME} $*
+
+	if [[ ! ${ARCH} == "amd64" ]]; then
+		elog "For architectures other than amd64, "\
+			"the pkgdiff test is currently unavailable "\
+			"because 'dev-util/japi-compliance-checker "\
+			"and 'dev-util/pkgdiff' do not support those architectures."
+		return
+	fi
+
+	local report1=${PN}-japi-compliance-checker.html
+	local report2=${PN}-pkgdiff.html
+
+	# pkgdiff test
+	if [[ -f "${DISTDIR}/${JAVA_BINJAR_FILENAME}" ]]; then
+		# pkgdiff cannot deal with symlinks, so this is a workaround
+		cp "${DISTDIR}/${JAVA_BINJAR_FILENAME}" ./ \
+			|| die "Cannot copy binjar file to ${S}."
+
+		# japi-compliance-checker
+		japi-compliance-checker ${JAVA_BINJAR_FILENAME} ${JAVA_JAR_FILENAME}\
+			--lib=${PN} -v1 ${PV}-bin -v2 ${PV} -report-path ${report1}\
+			--binary\
+			|| die "japi-compliance-checker returns $?,"\
+				"check the report in ${S}/${report1}"
+
+		# ignore META-INF since it does not matter
+		# ignore classes because japi-compilance checker will take care of it
+		pkgdiff ${JAVA_BINJAR_FILENAME} ${JAVA_JAR_FILENAME}\
+			-vnum1 ${PV}-bin -vnum2 ${PV}\
+			-skip-pattern "META-INF|.class$"\
+			-name ${PN} -report-path ${report2}\
+			|| die "pkgdiff returns $?, check the report in ${S}/${report2}"
+	fi
+}
+
+# @FUNCTION: java-pkg-simple_prepend_resources
+# @USAGE: java-pkg-simple_prepend-resources <${classes}> <"${RESOURCE_DIRS[@]}">
+# @INTERNAL
+# @DESCRIPTION:
+# Copy things under "${JAVA_RESOURCE_DIRS[@]}" or "${JAVA_TEST_RESOURCE_DIRS[@]}"
+# to ${classes}, so that `jar` will package resources together with classes.
+#
+# Note that you need to define a "classes" variable before calling
+# this function.
+java-pkg-simple_prepend_resources() {
+	debug-print-function ${FUNCNAME} $*
+
+	local destination="${1}"
+	shift 1
+
+	# return if there is no resource dirs defined
+	[[ "$@" ]] || return
+	local resources=("${@}")
+
+	# add resources directory to classpath
+	for resource in "${resources[@]}"; do
+		cp -rT "${resource:-.}" "${destination}"\
+			|| die "Could copy resources to ${destination}"
+	done
+}
+
 # @FUNCTION: java-pkg-simple_src_compile
 # @DESCRIPTION:
 # src_compile for simple bare source java packages. Finds all *.java
 # sources in ${JAVA_SRC_DIR}, compiles them with the classpath
 # calculated from ${JAVA_GENTOO_CLASSPATH}, and packages the resulting
-# classes to ${JAVA_JAR_FILENAME}.
+# classes to a single ${JAVA_JAR_FILENAME}. If the file
+# target/META-INF/MANIFEST.MF exists, it is used as the manifest of the
+# created jar.
+#
+# If USE FLAG 'binary' exists and is set, it will just copy
+# ${JAVA_BINJAR_FILENAME} to ${S} and skip the rest of src_compile.
 java-pkg-simple_src_compile() {
 	local sources=sources.lst classes=target/classes apidoc=target/api
 
 	# auto generate classpath
 	java-pkg_gen-cp JAVA_GENTOO_CLASSPATH
 
+	# do not compile if we decide to install binary jar
+	if has binary ${JAVA_PKG_IUSE} && use binary; then
+		# register the runtime dependencies
+		for dependency in ${JAVA_GENTOO_CLASSPATH//,/ }; do
+			java-pkg_record-jar_ ${dependency}
+		done
+
+		cp "${DISTDIR}"/${JAVA_BINJAR_FILENAME} ${JAVA_JAR_FILENAME}\
+			|| die "Could not copy the binary jar file to ${S}"
+		return 0
+	fi
+
 	# gather sources
-	find ${JAVA_SRC_DIR:-*} -name \*.java > ${sources}
+	find "${JAVA_SRC_DIR[@]}" -name \*.java > ${sources}
+
+	# create the target directory
 	mkdir -p ${classes} || die "Could not create target directory"
 
 	# compile
-	local classpath="${JAVA_GENTOO_CLASSPATH_EXTRA}" dependency
-	for dependency in ${JAVA_GENTOO_CLASSPATH}; do
-		classpath="${classpath}:$(java-pkg_getjars ${dependency})" \
-			|| die "getjars failed for ${dependency}"
-	done
-	while [[ $classpath = *::* ]]; do classpath="${classpath//::/:}"; done
-	classpath=${classpath%:}
-	classpath=${classpath#:}
-	debug-print "CLASSPATH=${classpath}"
-	ejavac -d ${classes} -encoding ${JAVA_ENCODING} \
-		${classpath:+-classpath ${classpath}} ${JAVAC_ARGS} \
+	local classpath=""
+	java-pkg-simple_getclasspath
+	java-pkg-simple_prepend_resources ${classes} "${JAVA_RESOURCE_DIRS[@]}"
+
+	ejavac -d ${classes} -encoding ${JAVA_ENCODING}\
+		${classpath:+-classpath ${classpath}} ${JAVAC_ARGS}\
 		@${sources}
 
 	# javadoc
@@ -118,25 +360,33 @@ java-pkg-simple_src_compile() {
 	fi
 
 	# package
-	local jar_args="cf ${JAVA_JAR_FILENAME}"
+	local jar_args
 	if [[ -e ${classes}/META-INF/MANIFEST.MF ]]; then
 		jar_args="cfm ${JAVA_JAR_FILENAME} ${classes}/META-INF/MANIFEST.MF"
+	elif [[ ${JAVA_MAIN_CLASS} ]]; then
+		jar_args="cfe ${JAVA_JAR_FILENAME} ${JAVA_MAIN_CLASS}"
+	else
+		jar_args="cf ${JAVA_JAR_FILENAME}"
 	fi
 	jar ${jar_args} -C ${classes} . || die "jar failed"
 }
 
 # @FUNCTION: java-pkg-simple_src_install
 # @DESCRIPTION:
-# src_install for simple single jar java packages. Simply packages the
-# contents from the target directory and installs it as
-# ${JAVA_JAR_FILENAME}. If the file target/META-INF/MANIFEST.MF exists,
-# it is used as the manifest of the created jar.
+# src_install for simple single jar java packages. Simply installs
+# ${JAVA_JAR_FILENAME}. It will also install a launcher if
+# ${JAVA_MAIN_CLASS} is set.
 java-pkg-simple_src_install() {
 	local sources=sources.lst classes=target/classes apidoc=target/api
 
-	# main jar
+	# install the jar file that we need
 	java-pkg_dojar ${JAVA_JAR_FILENAME}
 
+	# install a wrapper if ${JAVA_MAIN_CLASS} is defined
+	if [[ ${JAVA_MAIN_CLASS} ]]; then
+		java-pkg_dolauncher "${JAVA_LAUNCHER_FILENAME}" --main ${JAVA_MAIN_CLASS}
+	fi
+
 	# javadoc
 	if has doc ${JAVA_PKG_IUSE} && use doc; then
 		java-pkg_dojavadoc ${apidoc}
@@ -145,12 +395,10 @@ java-pkg-simple_src_install() {
 	# dosrc
 	if has source ${JAVA_PKG_IUSE} && use source; then
 		local srcdirs=""
-		if [[ ${JAVA_SRC_DIR} ]]; then
+		if [[ "${JAVA_SRC_DIR[@]}" ]]; then
 			local parent child
-			for parent in ${JAVA_SRC_DIR}; do
-				for child in ${parent}/*; do
-					srcdirs="${srcdirs} ${child}"
-				done
+			for parent in "${JAVA_SRC_DIR[@]}"; do
+				srcdirs="${srcdirs} ${parent}"
 			done
 		else
 			# take all directories actually containing any sources
@@ -159,3 +407,76 @@ java-pkg-simple_src_install() {
 		java-pkg_dosrc ${srcdirs}
 	fi
 }
+
+# @FUNCTION: java-pkg-simple_src_test
+# @DESCRIPTION:
+# src_test for simple single java jar file.
+# It will perform test with frameworks that are defined in
+# ${JAVA_TESTING_FRAMEWORKS}.
+java-pkg-simple_src_test() {
+	local test_sources=test_sources.lst classes=target/test-classes
+	local tests_to_run classpath
+
+	# do not continue if the USE FLAG 'test' is explicitly unset
+	# or no ${JAVA_TESTING_FRSerializingCAMEWORKS} specified
+	if ! has test ${JAVA_PKG_IUSE}; then
+		return
+	elif ! use test; then
+		return
+	elif [[ ! "${JAVA_TESTING_FRAMEWORKS}" ]]; then
+		return
+	fi
+
+	# create the target directory
+	mkdir -p ${classes} || die "Could not create target directory for testing"
+
+	# get classpath
+	classpath="${classes}:${JAVA_JAR_FILENAME}"
+	java-pkg-simple_getclasspath
+	java-pkg-simple_prepend_resources ${classes} "${JAVA_TEST_RESOURCE_DIRS[@]}"
+
+	# gathering sources for testing
+	find "${JAVA_TEST_SRC_DIR[@]}" -name \*.java > ${test_sources}
+
+	# compile
+	[[ -s ${test_sources} ]] && ejavac -d ${classes} ${JAVAC_ARGS} \
+		-encoding ${JAVA_ENCODING} ${classpath:+-classpath ${classpath}} \
+		@${test_sources}
+
+	# grab a set of tests that testing framework will run
+	tests_to_run=$(find "${classes}" -type f\
+		\( -name "*Test.class"\
+		-o -name "Test*.class"\
+		-o -name "*Tests.class"\
+		-o -name "*TestCase.class" \)\
+		! -name "*Abstract*"\
+		! -name "*BaseTest*"\
+		! -name "*TestTypes*"\
+		! -name "*TestUtils*"\
+		! -name "*\$*")
+	tests_to_run=${tests_to_run//"${classes}"\/}
+	tests_to_run=${tests_to_run//.class}
+	tests_to_run=${tests_to_run//\//.}
+
+	# exclude extra test classes, usually corner cases
+	#   that the code above cannot handle
+	for class in "${JAVA_TEST_EXCLUDES[@]}"; do
+		tests_to_run=${tests_to_run//${class}}
+	done
+
+	# launch test
+	for framework in ${JAVA_TESTING_FRAMEWORKS}; do
+		case ${framework} in
+			junit)
+				ejunit -classpath "${classpath}" ${tests_to_run};;
+			junit-4)
+				ejunit4 -classpath "${classpath}" ${tests_to_run};;
+			pkgdiff)
+				java-pkg-simple_test_with_pkgdiff_;;
+			testng)
+				etestng -classpath "${classpath}" ${tests_to_run};;
+			*)
+				elog "No suitable function found for framework ${framework}"
+		esac
+	done
+}
diff --git a/eclass/java-utils-2.eclass b/eclass/java-utils-2.eclass
index 29f13e031f4..a33962f114d 100644
--- a/eclass/java-utils-2.eclass
+++ b/eclass/java-utils-2.eclass
@@ -1861,6 +1861,44 @@ ejunit4() {
 	ejunit_ "junit-4" "${@}"
 }
 
+# @FUNCTION: etestng
+# @USAGE: etestng_ [-cp $classpath] <test classes>
+# @INTERNAL
+# @DESCRIPTION:
+# Testng wrapper function. Makes it easier to run the tests.
+# Launches the tests using org.testng.TestNG.
+#
+# @CODE
+# $1 - -cp or -classpath
+# $2 - the classpath passed to it
+# $@ - test classes for testng to run.
+# @CODE
+etestng() {
+	debug-print-function ${FUNCNAME} $*
+
+	local runner=org.testng.TestNG
+	local cp=$(java-pkg_getjars --with-dependencies testng)
+	local tests
+
+	if [[ ${1} = -cp || ${1} = -classpath ]]; then
+		cp="${cp}:${2}"
+		shift 2
+	else
+		cp="${cp}:."
+	fi
+
+	for test in ${@}; do
+		tests+="${test},"
+	done
+
+	debug-print "java -cp \"${cp}\" -Djava.io.tmpdir=\"${T}\""\
+		"-Djava.awt.headless=true ${runner}"\
+		"-usedefaultlisteners false -testclass ${tests}"
+	java -cp "${cp}" -Djava.io.tmpdir=\"${T}\" -Djava.awt.headless=true\
+		${runner} -usedefaultlisteners false -testclass ${tests}\
+		|| die "Running TestNG failed."
+}
+
 # @FUNCTION: java-utils-2_src_prepare
 # @DESCRIPTION:
 # src_prepare Searches for bundled jars
-- 
2.26.2

[gentoo-dev] [PATCHv2 2/2] patching ebuild files to support new java-pkg-simple

[Zhang Zongyu]

Signed-off-by: Zhang Zongyu <zzy2529420793@gmail.com>
---
 dev-java/juel/juel-2.1.0-r2.ebuild                   | 2 +-
 dev-java/piccolo2d/piccolo2d-3.0-r1.ebuild           | 2 +-
 dev-java/swingx-ws/swingx-ws-1.0_p20110515-r1.ebuild | 4 ++--
 dev-java/xml-commons/xml-commons-1.4.01.ebuild       | 2 +-
 dev-java/xsdlib/xsdlib-20090415.ebuild               | 4 ++--
 5 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/dev-java/juel/juel-2.1.0-r2.ebuild b/dev-java/juel/juel-2.1.0-r2.ebuild
index 052a8b4e96e..6b7b4c894a2 100644
--- a/dev-java/juel/juel-2.1.0-r2.ebuild
+++ b/dev-java/juel/juel-2.1.0-r2.ebuild
@@ -26,7 +26,7 @@ DEPEND="
 
 S="${WORKDIR}/${P}"
 
-JAVA_SRC_DIR="src/api src/impl"
+JAVA_SRC_DIR=( "src/api" "src/impl" )
 
 java_prepare() {
 	java-pkg_clean
diff --git a/dev-java/piccolo2d/piccolo2d-3.0-r1.ebuild b/dev-java/piccolo2d/piccolo2d-3.0-r1.ebuild
index 6193eb4112a..bd8cd931c7e 100644
--- a/dev-java/piccolo2d/piccolo2d-3.0-r1.ebuild
+++ b/dev-java/piccolo2d/piccolo2d-3.0-r1.ebuild
@@ -29,7 +29,7 @@ DEPEND="
 
 S="${WORKDIR}/${PN}.java-${PN}-complete-${PV}"
 JAVA_GENTOO_CLASSPATH="swt-3.8"
-JAVA_SRC_DIR="core extras swt"
+JAVA_SRC_DIR=( "core" "extras" "swt" )
 
 java_prepare() {
 	rm -rf core/src/test extras/src/test swt/src/test || die
diff --git a/dev-java/swingx-ws/swingx-ws-1.0_p20110515-r1.ebuild b/dev-java/swingx-ws/swingx-ws-1.0_p20110515-r1.ebuild
index d417f67fd56..a9667ffec75 100644
--- a/dev-java/swingx-ws/swingx-ws-1.0_p20110515-r1.ebuild
+++ b/dev-java/swingx-ws/swingx-ws-1.0_p20110515-r1.ebuild
@@ -37,7 +37,7 @@ DEPEND="
 	app-arch/unzip"
 
 S="${WORKDIR}/${MY_P}/src"
-JAVA_SRC_DIR="beaninfo java"
+JAVA_SRC_DIR=( "beaninfo" "java" )
 
 src_prepare() {
 	default
@@ -61,7 +61,7 @@ src_compile() {
 	java-pkg-simple_src_compile
 
 	local DIR
-	for DIR in ${JAVA_SRC_DIR}; do
+	for DIR in "${JAVA_SRC_DIR[@]}"; do
 		java-pkg_addres ${PN}.jar ${DIR}
 	done
 }
diff --git a/dev-java/xml-commons/xml-commons-1.4.01.ebuild b/dev-java/xml-commons/xml-commons-1.4.01.ebuild
index 25d9caa3b6a..028c71cf67d 100644
--- a/dev-java/xml-commons/xml-commons-1.4.01.ebuild
+++ b/dev-java/xml-commons/xml-commons-1.4.01.ebuild
@@ -26,4 +26,4 @@ DEPEND="
 	>=virtual/jdk-1.6
 	source? ( app-arch/zip )"
 
-JAVA_SRC_DIR="org javax"
+JAVA_SRC_DIR=( "org" "javax" )
diff --git a/dev-java/xsdlib/xsdlib-20090415.ebuild b/dev-java/xsdlib/xsdlib-20090415.ebuild
index c317785fc9f..0cb2aba0120 100644
--- a/dev-java/xsdlib/xsdlib-20090415.ebuild
+++ b/dev-java/xsdlib/xsdlib-20090415.ebuild
@@ -31,13 +31,13 @@ java_prepare() {
 	find -name '*.jar' -exec rm -v {} + || die
 }
 
-JAVA_SRC_DIR="src src-apache"
+JAVA_SRC_DIR=( "src" "src-apache" )
 JAVA_GENTOO_CLASSPATH="relaxng-datatype,xerces-2"
 
 src_compile() {
 	java-pkg-simple_src_compile
 
-	local dir; for dir in ${JAVA_SRC_DIR}; do
+	local dir; for dir in "${JAVA_SRC_DIR[@]}"; do
 		pushd ${dir} > /dev/null || die
 			jar -uf "${S}"/${PN}.jar $(find -name '*.properties') || die
 		popd > /dev/null
-- 
2.26.2

Re: [gentoo-dev] [PATCH 0/2] eclass/java-{utils-2,pkg-simple}.eclass: features and enhancements

[Miroslav Šulc]

hi all,

jfyi, i'm going to commit these changes to the main tree at the end of 
the weekend if there are no objections. (i've been mentoring this 
project.) we have some other work that depends on these patches so i'd 
like to see it in the main tree as soon as possible.

regards.

fordfrog


Dne 25. 08. 20 v 17:46 zongyu napsal(a):
> Dear all,
>
>       I am one of the students who attend Gentoo's Google Summer of Code
>       program [1] this year. And this email is attempting to trigger a
>       review for a patch for eclass/java-{utils-2,pkg-simple}.eclass.
>
>       Java-pkg-simple.eclass is widely used by java packages that do not
>       provide a build.xml for building with java-ant-2.eclass. Although
>       java-pkg-simple.eclass works well right now, it still lacks some
>       features [2], such as installing java resources and providing
>       src_test() function.
>
>       The patch below is trying to enable some missing features of
>       java-pkg-simple.eclass, including:
>       1. Since some java packages (e.g. dev-java/commons-io) has java
>          resources bundled in jar files, java-pkg-simple.eclass now has a
>          function java-pkg-simple_prepend_resources() to recognize and
>          install those java resource files;
>       2. Some java packages have a "main class" so that we can execute
>          the jar file from command line. With "JAVA_MAIN_CLASS" and
>          "JAVA_LAUNCHER_FILENAME", the eclass can deal with the situation
>          properly;
>       3. Enabling src_test() function with multiple testing frameworks
>          like junit, testng, pkgdiff and so on;
>       4. Pkgdiff test will compare natively compiled jar file and upstream
>          provided binary jar file, to support the feature the eclass will
>          fetch pre-compiled java jars and accept "JAVA_BINJAR_FILENAME" to
>          identify it.
>          Besides, installing binjar will help resolve circular
>          dependencies, so the eclass also accepts USE="binary" and
>          installs the binary jars now.
>
>       And for java-utils-2.eclass:
>       1. To support java-pkg-simple_src_test(), there is a new function
>          etestng() to launch java tests with dev-java/testng.
>
>       Finally, there is a breaking change to java-pkg-simple. Instead of
>       treating "JAVA_SRC_DIR" as a string of directories separated by
>       spaces, currently the eclass will treat it as an array. A few
>       packages will be affected and fail to build, and the second patch
>       will solve the problem.
>
>       P.S.
>       This is the first time for me to write a patch for such a huge
>       project and send such an email. I hope this email will meet your
>       requirements, and I would appreciate your every response.
>
>       Regards,
>       Zhang Zongyu
>
>       [1] the GSoC program
>       https://summerofcode.withgoogle.com/projects/#4994566568017920
>       [2] a related bug
>       https://bugs.gentoo.org/564158
>
> zongyu (2):
>    java-pkg-simple.eclass and java-utils-2.eclass: features and
>      enhancements
>    patching ebuild files to support new java-pkg-simple
>
>   dev-java/juel/juel-2.1.0-r2.ebuild            |   2 +-
>   dev-java/piccolo2d/piccolo2d-3.0-r1.ebuild    |   2 +-
>   .../swingx-ws-1.0_p20110515-r1.ebuild         |   4 +-
>   .../xml-commons/xml-commons-1.4.01.ebuild     |   2 +-
>   dev-java/xsdlib/xsdlib-20090415.ebuild        |   4 +-
>   eclass/java-pkg-simple.eclass                 | 379 ++++++++++++++++--
>   eclass/java-utils-2.eclass                    |  38 ++
>   7 files changed, 395 insertions(+), 36 deletions(-)
>

Re: [gentoo-dev] [PATCH 0/2] eclass/java-{utils-2,pkg-simple}.eclass: features and enhancements

[Miroslav Šulc]

hi all,

it's committed now:

commit a4d773b4c2f433438b00010bbf0981c81e123d1b (HEAD -> master, 
origin/master, origin/HEAD)
Author: Zhang Zongyu <zzy2529420793@gmail.com>
Date:   Wed Aug 26 00:30:10 2020 +0800

     patching ebuild files to support new java-pkg-simple

     Signed-off-by: Zhang Zongyu <zzy2529420793@gmail.com>
     Signed-off-by: Miroslav Šulc <fordfrog@gentoo.org>

commit faa407032918b43fafe7d4e1de85dde4d30ba4f2
Author: Zhang Zongyu <zzy2529420793@gmail.com>
Date:   Wed Aug 26 00:30:09 2020 +0800

     java-pkg-simple.eclass and java-utils-2.eclass: features and 
enhancements

     1) support java resources
     2) support java main class and launcher
     3) enable java-pkg-simple_src_test()
     4) support binary jars (both for resolve circular deps and for 
pkgdiff test)

     Signed-off-by: Zhang Zongyu <zzy2529420793@gmail.com>
     Signed-off-by: Miroslav Šulc <fordfrog@gentoo.org>

regards.

fordfrog


Dne 28. 08. 20 v 19:25 Miroslav Šulc napsal(a):
> hi all,
>
> jfyi, i'm going to commit these changes to the main tree at the end of 
> the weekend if there are no objections. (i've been mentoring this 
> project.) we have some other work that depends on these patches so i'd 
> like to see it in the main tree as soon as possible.
>
> regards.
>
> fordfrog
>
>
> Dne 25. 08. 20 v 17:46 zongyu napsal(a):
>> Dear all,
>>
>>       I am one of the students who attend Gentoo's Google Summer of Code
>>       program [1] this year. And this email is attempting to trigger a
>>       review for a patch for eclass/java-{utils-2,pkg-simple}.eclass.
>>
>>       Java-pkg-simple.eclass is widely used by java packages that do not
>>       provide a build.xml for building with java-ant-2.eclass. Although
>>       java-pkg-simple.eclass works well right now, it still lacks some
>>       features [2], such as installing java resources and providing
>>       src_test() function.
>>
>>       The patch below is trying to enable some missing features of
>>       java-pkg-simple.eclass, including:
>>       1. Since some java packages (e.g. dev-java/commons-io) has java
>>          resources bundled in jar files, java-pkg-simple.eclass now 
>> has a
>>          function java-pkg-simple_prepend_resources() to recognize and
>>          install those java resource files;
>>       2. Some java packages have a "main class" so that we can execute
>>          the jar file from command line. With "JAVA_MAIN_CLASS" and
>>          "JAVA_LAUNCHER_FILENAME", the eclass can deal with the 
>> situation
>>          properly;
>>       3. Enabling src_test() function with multiple testing frameworks
>>          like junit, testng, pkgdiff and so on;
>>       4. Pkgdiff test will compare natively compiled jar file and 
>> upstream
>>          provided binary jar file, to support the feature the eclass 
>> will
>>          fetch pre-compiled java jars and accept 
>> "JAVA_BINJAR_FILENAME" to
>>          identify it.
>>          Besides, installing binjar will help resolve circular
>>          dependencies, so the eclass also accepts USE="binary" and
>>          installs the binary jars now.
>>
>>       And for java-utils-2.eclass:
>>       1. To support java-pkg-simple_src_test(), there is a new function
>>          etestng() to launch java tests with dev-java/testng.
>>
>>       Finally, there is a breaking change to java-pkg-simple. Instead of
>>       treating "JAVA_SRC_DIR" as a string of directories separated by
>>       spaces, currently the eclass will treat it as an array. A few
>>       packages will be affected and fail to build, and the second patch
>>       will solve the problem.
>>
>>       P.S.
>>       This is the first time for me to write a patch for such a huge
>>       project and send such an email. I hope this email will meet your
>>       requirements, and I would appreciate your every response.
>>
>>       Regards,
>>       Zhang Zongyu
>>
>>       [1] the GSoC program
>> https://summerofcode.withgoogle.com/projects/#4994566568017920
>>       [2] a related bug
>>       https://bugs.gentoo.org/564158
>>
>> zongyu (2):
>>    java-pkg-simple.eclass and java-utils-2.eclass: features and
>>      enhancements
>>    patching ebuild files to support new java-pkg-simple
>>
>>   dev-java/juel/juel-2.1.0-r2.ebuild            |   2 +-
>>   dev-java/piccolo2d/piccolo2d-3.0-r1.ebuild    |   2 +-
>>   .../swingx-ws-1.0_p20110515-r1.ebuild         |   4 +-
>>   .../xml-commons/xml-commons-1.4.01.ebuild     |   2 +-
>>   dev-java/xsdlib/xsdlib-20090415.ebuild        |   4 +-
>>   eclass/java-pkg-simple.eclass                 | 379 ++++++++++++++++--
>>   eclass/java-utils-2.eclass                    |  38 ++
>>   7 files changed, 395 insertions(+), 36 deletions(-)
>>
>