Jinwoo Hwang created GEODE-10476:
------------------------------------
Summary: Update assembly content validation to support Java 17
javadoc format changes
Key: GEODE-10476
URL: https://issues.apache.org/jira/browse/GEODE-10476
Project: Geode
Issue Type: Sub-task
Reporter: Jinwoo Hwang
After upgrading from Java 8 to Java 17, the {{AssemblyContentsIntegrationTest}}
is failing because the javadoc generation process has changed significantly
between these Java versions. The test validates that the actual assembly
contents match the expected contents defined in assembly_content.txt, but the
expected file still reflects the old Java 8 javadoc structure.
h3. Root Cause
Java 9+ introduced major changes to javadoc generation:
* *Removed frame-based navigation* due to accessibility concerns and modern
web standards
* *Introduced search functionality* with enhanced JavaScript support
* *Changed file structure* from frame-based to modern HTML5 format
* *Updated package metadata* from {{package-list}} to {{element-list}}
h3. Specific Changes Required
The following javadoc files have changed between Java 8 and Java 17:
*Removed files (Java 8 format):*
* {{javadoc/allclasses-frame.html}}
* {{javadoc/allclasses-noframe.html}}
* {{javadoc/package-frame.html}} (multiple instances for each package)
* {{javadoc/overview-frame.html}}
* {{javadoc/package-list}}
*Added files (Java 17 format):*
* {{javadoc/allclasses-index.html}}
* {{javadoc/allpackages-index.html}}
* {{javadoc/element-list}}
* {{javadoc/search.js}}
* {{javadoc/*-search-index.js}} (multiple search index files)
* {{javadoc/script-dir/jquery-*.js}} (jQuery integration)
* {{javadoc/jquery-ui.overrides.css}}
* {{javadoc/legal/jquery.md}} and {{javadoc/legal/jqueryUI.md}} (legal notices)
* Various resource files ({{{}javadoc/resources/*.png{}}})
h3. Solution
Update the assembly_content.txt file to reflect the new Java 17 javadoc
structure by copying the current generated content from the build output.
h3. Test Failure Details
AssemblyContentsIntegrationTest > verifyAssemblyContents FAILED
java.lang.AssertionError: [The assembly contents have changed. Verify
dependencies and copy geode-assembly/build/integrationTest/assembly_content.txt
to geode-assembly/src/integrationTest/resources/assembly_content.txt]
h3. Impact
* *Low Risk:* This is purely a test validation update to match the new javadoc
format
* *No Functional Impact:* The actual javadoc functionality is improved (better
accessibility, search capability)
* *Build Impact:* Unblocks integration tests after Java 17 upgrade
h3. Acceptance Criteria
* {{AssemblyContentsIntegrationTest}} passes with Java 17
* Assembly content validation reflects modern javadoc structure
* No regression in javadoc generation or content quality
* Generated javadoc maintains all expected documentation
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
