TEZ-4387: use new doclet API in Java 9+ by LA-Toth · Pull Request #187 · apache/tez

LA-Toth · 2022-02-11T09:42:37Z

No description provided.

abstractdog · 2022-02-18T09:19:26Z

+ <id>jdk9plus</id>
+ <activation>
+ <!-- JDK9 starts strong encapsulation of Java internals, JDK17 removes/hides those -->
+ <jdk>[9,9999)</jdk>


which version does this expression target?
if every version starting with "9", then a simply "9" should work
https://maven.apache.org/guides/introduction/introduction-to-profiles.html
The following configuration will trigger the profile when the JDK's version starts with "1.4" (eg. "1.4.0_08", "1.4.2_07", "1.4"): <profiles> <profile> <activation> <jdk>1.4</jdk> </activation> ... </profile> </profiles>

This is a range of versions, based on https://maven.apache.org/enforcer/enforcer-rules/versionRanges.html I wanted to write for JDK version 9 and up:
<jdk>[9,)</jdk>
It also could be 17 and up as only 17 enforces the new API.

abstractdog · 2022-02-18T09:24:30Z

left some comments
also, could you please make a simple validity check with javadocs on JDK17?

mvn javadoc:javadoc
#take a look at for example tez-api/target/site/apidocs/index.html

abstractdog · 2022-02-18T09:42:48Z

+
+ @Override
+ public String getName() {
+ return "Example";


where is this name used? is there a chance for a better name?
in case of no idea, I guess "Tez" would make do :)

It's from the JDK sample code. I had to implement the method. Good catch, I totally forgot to update it for the current project.

LA-Toth · 2022-02-22T07:46:44Z

It seems that in JDK 11 the documentation generation is quite buggy, which is a known issue and fixed in JDK 13.
SO link: https://stackoverflow.com/questions/62531431/exit-code-1-javadoc-error-the-code-being-documented-uses-modules-but
possible OpenJDK tickets: https://bugs.openjdk.java.net/browse/JDK-8212233
and https://bugs.openjdk.java.net/browse/JDK-8217177

With Java 17 the documentation was generated successfully and believable, so I go further with the JDK17-only version.

abstractdog · 2022-11-17T10:27:35Z

@LA-Toth: is there any pending work on this PR I can help with?

LA-Toth · 2022-11-22T09:28:22Z

I had only one problem, the tests are too strict and cannot handle properly my solution. So I always get -1 for something. I don't think it's an error in my PR, I can't do anything.

abstractdog · 2022-11-26T10:46:34Z

okay thanks, let me take a look next week

abstractdog · 2023-06-23T12:46:26Z

@LA-Toth: is there a chance you can check the patch with JDK11? I tried your commits at #296 and I found that the new github action step fails for building it on JDK11
the goal here is to remain compatible with JDK8 + JDK11, I'm hoping it's possible with easy changes

LA-Toth · 2023-06-23T13:06:52Z

@LA-Toth: is there a chance you can check the patch with JDK11? I tried your commits at #296 and I found that the new github action step fails for building it on JDK11 the goal here is to remain compatible with JDK8 + JDK11, I'm hoping it's possible with easy changes

It works with JDK 11, as I see, at least locally. I just missed the version bump in pom.xml files.

tez-yetus · 2023-06-23T14:02:57Z

💔 -1 overall

Vote	Subsystem	Runtime	Comment
+0 🆗	reexec	27m 6s	Docker mode activated.
		_ Prechecks _
+1 💚	dupname	0m 0s	No case conflicting files found.
+1 💚	@author	0m 0s	The patch does not contain any @author tags.
-1 ❌	test4tests	0m 0s	The patch doesn't appear to include any new or modified tests. Please justify why no new tests are needed for this patch. Also please list what manual steps were performed to verify this patch.
		_ master Compile Tests _
+0 🆗	mvndep	5m 24s	Maven dependency ordering for branch
+1 💚	mvninstall	7m 23s	master passed
+1 💚	compile	0m 58s	master passed with JDK Ubuntu-11.0.19+7-post-Ubuntu-0ubuntu122.04.1
+1 💚	compile	0m 55s	master passed with JDK Private Build-1.8.0_362-8u372-ga~~us1-0ubuntu1~~22.04-b09
+1 💚	checkstyle	0m 43s	master passed
+1 💚	javadoc	0m 43s	master passed with JDK Ubuntu-11.0.19+7-post-Ubuntu-0ubuntu122.04.1
+1 💚	javadoc	0m 41s	master passed with JDK Private Build-1.8.0_362-8u372-ga~~us1-0ubuntu1~~22.04-b09
+0 🆗	spotbugs	0m 33s	Used deprecated FindBugs config; considering switching to SpotBugs.
+1 💚	findbugs	1m 26s	master passed
		_ Patch Compile Tests _
+0 🆗	mvndep	0m 10s	Maven dependency ordering for patch
-1 ❌	mvninstall	0m 20s	tez-tools in the patch failed.
-1 ❌	mvninstall	0m 11s	tez-javadoc-tools in the patch failed.
-1 ❌	mvninstall	0m 11s	tez-javadoc-tools-base in the patch failed.
-1 ❌	compile	0m 24s	tez-tools in the patch failed with JDK Ubuntu-11.0.19+7-post-Ubuntu-0ubuntu122.04.1.
-1 ❌	compile	0m 12s	tez-javadoc-tools in the patch failed with JDK Ubuntu-11.0.19+7-post-Ubuntu-0ubuntu122.04.1.
-1 ❌	javac	0m 24s	tez-tools in the patch failed with JDK Ubuntu-11.0.19+7-post-Ubuntu-0ubuntu122.04.1.
-1 ❌	javac	0m 12s	tez-javadoc-tools in the patch failed with JDK Ubuntu-11.0.19+7-post-Ubuntu-0ubuntu122.04.1.
-1 ❌	compile	0m 20s	tez-tools in the patch failed with JDK Private Build-1.8.0_362-8u372-ga~~us1-0ubuntu1~~22.04-b09.
-1 ❌	compile	0m 12s	tez-javadoc-tools in the patch failed with JDK Private Build-1.8.0_362-8u372-ga~~us1-0ubuntu1~~22.04-b09.
-1 ❌	compile	0m 10s	tez-javadoc-tools-base in the patch failed with JDK Private Build-1.8.0_362-8u372-ga~~us1-0ubuntu1~~22.04-b09.
-1 ❌	javac	0m 20s	tez-tools in the patch failed with JDK Private Build-1.8.0_362-8u372-ga~~us1-0ubuntu1~~22.04-b09.
-1 ❌	javac	0m 12s	tez-javadoc-tools in the patch failed with JDK Private Build-1.8.0_362-8u372-ga~~us1-0ubuntu1~~22.04-b09.
-1 ❌	javac	0m 10s	tez-javadoc-tools-base in the patch failed with JDK Private Build-1.8.0_362-8u372-ga~~us1-0ubuntu1~~22.04-b09.
-0 ⚠️	checkstyle	0m 9s	The patch fails to run checkstyle in tez-tools
-0 ⚠️	checkstyle	0m 7s	The patch fails to run checkstyle in tez-javadoc-tools
-0 ⚠️	checkstyle	0m 8s	tez-tools/tez-javadoc-tools-base: The patch generated 47 new + 0 unchanged - 0 fixed = 47 total (was 0)
-0 ⚠️	checkstyle	0m 11s	tez-tools/tez-javadoc-tools-base-jdk8: The patch generated 190 new + 0 unchanged - 0 fixed = 190 total (was 0)
+1 💚	whitespace	0m 0s	The patch has no whitespace issues.
+1 💚	xml	0m 7s	The patch has no ill-formed XML file.
+1 💚	javadoc	0m 34s	the patch passed with JDK Ubuntu-11.0.19+7-post-Ubuntu-0ubuntu122.04.1
+1 💚	javadoc	0m 34s	the patch passed with JDK Private Build-1.8.0_362-8u372-ga~~us1-0ubuntu1~~22.04-b09
-1 ❌	findbugs	0m 31s	tez-tools in the patch failed.
-1 ❌	findbugs	0m 12s	tez-javadoc-tools in the patch failed.
-1 ❌	findbugs	0m 10s	tez-javadoc-tools-base in the patch failed.
		_ Other Tests _
-1 ❌	unit	2m 44s	tez-tools in the patch failed.
-1 ❌	unit	0m 11s	tez-javadoc-tools in the patch failed.
-1 ❌	unit	0m 11s	tez-javadoc-tools-base in the patch failed.
+1 💚	unit	0m 12s	tez-javadoc-tools-base-jdk8 in the patch passed.
+1 💚	asflicense	0m 30s	The patch does not generate ASF License warnings.
		56m 46s

Subsystem	Report/Notes
Docker	ClientAPI=1.43 ServerAPI=1.43 base: https://ci-hadoop.apache.org/job/tez-multibranch/job/PR-187/4/artifact/out/Dockerfile
GITHUB PR	#187
JIRA Issue	TEZ-4387
Optional Tests	dupname asflicense javac javadoc unit xml compile spotbugs findbugs checkstyle
uname	Linux 5149fe41507f 4.15.0-212-generic #223-Ubuntu SMP Tue May 23 13:09:22 UTC 2023 x86_64 x86_64 x86_64 GNU/Linux
Build tool	maven
Personality	personality/tez.sh
git revision	master / `154fd34`
Default Java	Private Build-1.8.0_362-8u372-ga~~us1-0ubuntu1~~22.04-b09
Multi-JDK versions	/usr/lib/jvm/java-11-openjdk-amd64:Ubuntu-11.0.19+7-post-Ubuntu-0ubuntu122.04.1 /usr/lib/jvm/java-8-openjdk-amd64:Private Build-1.8.0_362-8u372-ga~~us1-0ubuntu1~~22.04-b09
mvninstall	https://ci-hadoop.apache.org/job/tez-multibranch/job/PR-187/4/artifact/out/patch-mvninstall-tez-tools.txt
mvninstall	https://ci-hadoop.apache.org/job/tez-multibranch/job/PR-187/4/artifact/out/patch-mvninstall-tez-tools_tez-javadoc-tools.txt
mvninstall	https://ci-hadoop.apache.org/job/tez-multibranch/job/PR-187/4/artifact/out/patch-mvninstall-tez-tools_tez-javadoc-tools-base.txt
compile	https://ci-hadoop.apache.org/job/tez-multibranch/job/PR-187/4/artifact/out/patch-compile-tez-tools-jdkUbuntu-11.0.19+7-post-Ubuntu-0ubuntu122.04.1.txt
compile	https://ci-hadoop.apache.org/job/tez-multibranch/job/PR-187/4/artifact/out/patch-compile-tez-tools_tez-javadoc-tools-jdkUbuntu-11.0.19+7-post-Ubuntu-0ubuntu122.04.1.txt
javac	https://ci-hadoop.apache.org/job/tez-multibranch/job/PR-187/4/artifact/out/patch-compile-tez-tools-jdkUbuntu-11.0.19+7-post-Ubuntu-0ubuntu122.04.1.txt
javac	https://ci-hadoop.apache.org/job/tez-multibranch/job/PR-187/4/artifact/out/patch-compile-tez-tools_tez-javadoc-tools-jdkUbuntu-11.0.19+7-post-Ubuntu-0ubuntu122.04.1.txt
compile	https://ci-hadoop.apache.org/job/tez-multibranch/job/PR-187/4/artifact/out/patch-compile-tez-tools-jdkPrivateBuild-1.8.0_362-8u372-ga~us1-0ubuntu1~22.04-b09.txt
compile	https://ci-hadoop.apache.org/job/tez-multibranch/job/PR-187/4/artifact/out/patch-compile-tez-tools_tez-javadoc-tools-jdkPrivateBuild-1.8.0_362-8u372-ga~us1-0ubuntu1~22.04-b09.txt
compile	https://ci-hadoop.apache.org/job/tez-multibranch/job/PR-187/4/artifact/out/patch-compile-tez-tools_tez-javadoc-tools-base-jdkPrivateBuild-1.8.0_362-8u372-ga~us1-0ubuntu1~22.04-b09.txt
javac	https://ci-hadoop.apache.org/job/tez-multibranch/job/PR-187/4/artifact/out/patch-compile-tez-tools-jdkPrivateBuild-1.8.0_362-8u372-ga~us1-0ubuntu1~22.04-b09.txt
javac	https://ci-hadoop.apache.org/job/tez-multibranch/job/PR-187/4/artifact/out/patch-compile-tez-tools_tez-javadoc-tools-jdkPrivateBuild-1.8.0_362-8u372-ga~us1-0ubuntu1~22.04-b09.txt
javac	https://ci-hadoop.apache.org/job/tez-multibranch/job/PR-187/4/artifact/out/patch-compile-tez-tools_tez-javadoc-tools-base-jdkPrivateBuild-1.8.0_362-8u372-ga~us1-0ubuntu1~22.04-b09.txt
checkstyle	https://ci-hadoop.apache.org/job/tez-multibranch/job/PR-187/4/artifact/out/buildtool-patch-checkstyle-tez-tools.txt
checkstyle	https://ci-hadoop.apache.org/job/tez-multibranch/job/PR-187/4/artifact/out/buildtool-patch-checkstyle-tez-tools_tez-javadoc-tools.txt
checkstyle	https://ci-hadoop.apache.org/job/tez-multibranch/job/PR-187/4/artifact/out/diff-checkstyle-tez-tools_tez-javadoc-tools-base.txt
checkstyle	https://ci-hadoop.apache.org/job/tez-multibranch/job/PR-187/4/artifact/out/diff-checkstyle-tez-tools_tez-javadoc-tools-base-jdk8.txt
findbugs	https://ci-hadoop.apache.org/job/tez-multibranch/job/PR-187/4/artifact/out/patch-findbugs-tez-tools.txt
findbugs	https://ci-hadoop.apache.org/job/tez-multibranch/job/PR-187/4/artifact/out/patch-findbugs-tez-tools_tez-javadoc-tools.txt
findbugs	https://ci-hadoop.apache.org/job/tez-multibranch/job/PR-187/4/artifact/out/patch-findbugs-tez-tools_tez-javadoc-tools-base.txt
unit	https://ci-hadoop.apache.org/job/tez-multibranch/job/PR-187/4/artifact/out/patch-unit-tez-tools.txt
unit	https://ci-hadoop.apache.org/job/tez-multibranch/job/PR-187/4/artifact/out/patch-unit-tez-tools_tez-javadoc-tools.txt
unit	https://ci-hadoop.apache.org/job/tez-multibranch/job/PR-187/4/artifact/out/patch-unit-tez-tools_tez-javadoc-tools-base.txt
Test Results	https://ci-hadoop.apache.org/job/tez-multibranch/job/PR-187/4/testReport/
Max. process+thread count	807 (vs. ulimit of 5500)
modules	C: tez-tools tez-tools/tez-javadoc-tools tez-tools/tez-javadoc-tools-base tez-tools/tez-javadoc-tools-base-jdk8 U: tez-tools
Console output	https://ci-hadoop.apache.org/job/tez-multibranch/job/PR-187/4/console
versions	git=2.34.1 maven=3.6.3 findbugs=3.0.1
Powered by	Apache Yetus 0.12.0 https://yetus.apache.org

This message was automatically generated.

abstractdog · 2023-06-23T15:29:25Z

this is strange, I wanted to test by building locally, but I can see that in jdk8 the problematic module is not included at all:

cd tez-tools
mvn --batch-mode clean test-compile -DskipTests=true
...
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Summary for tez-tools 0.10.3-SNAPSHOT:
[INFO]
[INFO] tez-tools .......................................... SUCCESS [ 1.414 s]
[INFO] tez-perf-analyzer .................................. SUCCESS [ 0.126 s]
[INFO] tez-job-analyzer ................................... SUCCESS [ 8.361 s]
[INFO] tez-javadoc-tools .................................. SUCCESS [ 1.323 s]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------

I expected tez-javadoc-tools-base-jdk8 to be included

mvn -version
Apache Maven 3.8.6 (84538c9988a25aec085021c365c560670ad80f63)
Maven home: /Users/laszlobodor/Applications/maven
Java version: 1.8.0_292, vendor: AdoptOpenJDK, runtime: /Library/Java/JavaVirtualMachines/adoptopenjdk-8.jdk/Contents/Home/jre
Default locale: en_HU, platform encoding: UTF-8
OS name: "mac os x", version: "10.16", arch: "x86_64", family: "mac"

abstractdog · 2024-12-23T10:20:52Z

currently working on this in the scope of #296

abstractdog · 2024-12-30T16:48:46Z

merged as #296