#405 Fix "File name too long" error with deep paths in JUnit reports #426

ascheman · 2025-10-13T21:16:25Z

Summary

Fixes #405 - Resolves "File name too long" error when generating JUnit XML reports for HTML files in deeply nested directory structures.

The solution introduces a configurable output style for JUnit XML reports:

FLAT (default): Maintains backward compatibility with existing behavior - all files in one directory with encoded paths
HIERARCHICAL: New mode that mirrors source file directory structure, solving filename length issues

Changes

Core Implementation

Added JunitOutputStyle enum as nested class in Configuration (FLAT, HIERARCHICAL)
Refactored JUnitXmlReporter to support both output modes with strategy pattern
Implemented getHierarchicalOutputFile() with path normalization and security checks
Updated AllChecksRunner to pass configuration to JUnitXmlReporter

Security & Quality Improvements (from GitHub Copilot review)

Enhanced path traversal security: Replaced string-based path validation with NIO Path API for robust protection against sophisticated attacks
Improved error diagnostics: Added detailed context to directory creation failures including existence status and parent permissions
Comprehensive security testing: Added tests for path traversal attacks and error message validation

Plugin/CLI Updates

Gradle plugin: Added junitOutputStyle input property
Maven plugin: Added junitOutputStyle parameter
CLI: Added --junitOutputStyle / -o command-line option

Testing

Added 7 comprehensive tests for HIERARCHICAL mode including edge cases
Added 2 tests for FLAT mode and exception handling
Added 5 tests for security (path traversal) and enhanced error messages
Improved overall test coverage for JUnitXmlReporter
All 384+ tests pass successfully

Documentation

Created comprehensive AsciiDoc documentation in src/docs/development/_includes/issue-405.adoc
Includes problem description, solution details, configuration examples, and implementation notes

Testing with JitPack

You can test this fix before it's released by using JitPack to build from this branch:

Gradle

```groovy
repositories {
maven { url 'https://jitpack.io' }
}

dependencies {
// For the Gradle plugin
classpath 'com.github.aim42.htmlSanityCheck:htmlSanityCheck-gradle-plugin:bugfix~405-enable-junit-results-per-dir-SNAPSHOT'
}

htmlSanityCheck {
junitOutputStyle = org.aim42.htmlsanitycheck.Configuration.JunitOutputStyle.HIERARCHICAL
}
```

Maven

```xml

jitpack.io
https://jitpack.io

com.github.aim42.htmlSanityCheck htmlSanityCheck-maven-plugin bugfix~405-enable-junit-results-per-dir-SNAPSHOT HIERARCHICAL \`\`\`

Note: JitPack replaces / with ~ in branch names, so bugfix/405-enable-junit-results-per-dir becomes bugfix~405-enable-junit-results-per-dir-SNAPSHOT

Backward Compatibility

✅ Fully backward compatible - The default value is FLAT, maintaining existing behavior unless explicitly configured to use HIERARCHICAL mode.

CI Status

All workflows passing:

✅ Build and Test
✅ HTML Sanity Check Matrix Test (Java 8, 11, 17, 21 on Ubuntu, macOS, Windows)
✅ GitHub Pages
✅ SonarCloud Quality Gate

Related Commits

7116615 - Initial fix with hierarchical structure
d076086 - Made feature configurable for backward compatibility
3fad99e - Improved test coverage for SonarCloud
bf8ce30 - Enhanced path security and error handling (Copilot review)

Implement hierarchical directory structure for JUnit XML reports to solve filename length issues when checking HTML files in deeply nested directories. Changes: - Modify JUnitXmlReporter to create directory hierarchies mirroring source file structure instead of encoding paths into flat filenames - Add path normalization and security checks to prevent directory traversal - Update JUnitXmlReporterTest with 7 comprehensive tests for hierarchical structure, including edge cases for long paths and relative references - Add helper method findFirstXmlFile() for recursive XML file discovery - Fix tearDown() to handle directories when traversing file tree - Add AsciiDoc documentation in issue-405.adoc with code includes via tags - Update CLAUDE.md with AsciiDoc and commit message conventions - Add source code tags to JUnitXmlReporter.java for documentation includes The solution keeps individual filenames under OS limits while preserving full path information through directory structure. All 379 existing tests continue to pass. Resolves #405 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>

Add configuration option to choose between flat and hierarchical JUnit XML output structures for backwards compatibility. - Move JunitOutputStyle enum as nested class in Configuration - Add junitOutputStyle field to Configuration (default: FLAT) - Refactor JUnitXmlReporter with getFlatOutputFile() and getHierarchicalOutputFile() methods - Update Gradle plugin to expose junitOutputStyle property - Update Maven plugin to expose junitOutputStyle parameter - Update CLI to add --junitOutputStyle/-o option - Add 7 comprehensive tests for HIERARCHICAL mode - Update documentation with configuration examples FLAT mode (default) maintains backwards compatibility with existing behavior. HIERARCHICAL mode solves filename length issues for deeply nested directory structures. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>

Add tests to improve code coverage for exception handling and both FLAT and HIERARCHICAL output modes. - testFlatModeCreatesEncodedFilename: Tests explicit FLAT mode - testFlatModeIsDefaultWhenNotSpecified: Tests default behavior - testHierarchicalModeFailsWhenCannotCreateDirectory: Tests exception when directory creation fails in HIERARCHICAL mode - Fix testInitReportWithNonWritableDirectory to properly test exception when output path cannot be created These tests address Sonar coverage gaps in: - Line 64: initReport() exception handling - Line 165: getHierarchicalOutputFile() directory creation error - getFlatOutputFile() method coverage Coverage improvements ensure both output modes and exception paths are properly tested. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>

Copilot

Pull Request Overview

This PR fixes issue #405 by resolving "File name too long" errors when generating JUnit XML reports for HTML files in deeply nested directory structures. The solution introduces a configurable output style system that maintains backward compatibility while providing a new hierarchical mode to solve filename length issues.

Adds JunitOutputStyle enum with FLAT (default) and HIERARCHICAL modes
Refactors JUnitXmlReporter to support both output strategies
Updates all three interfaces (Gradle plugin, Maven plugin, CLI) to expose the new configuration option

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
src/docs/development/design-discussions.adoc	Adds reference to new documentation for issue #405
src/docs/development/_includes/issue-405.adoc	Comprehensive documentation explaining the problem, solution, and implementation
htmlSanityCheck-maven-plugin/src/main/java/org/aim42/htmlsanitycheck/maven/HtmlSanityCheckMojo.java	Adds `junitOutputStyle` parameter to Maven plugin
htmlSanityCheck-gradle-plugin/src/main/groovy/org/aim42/htmlsanitycheck/gradle/HtmlSanityCheckTask.groovy	Adds `junitOutputStyle` input property to Gradle plugin
htmlSanityCheck-core/src/test/groovy/org/aim42/htmlsanitycheck/report/JUnitXmlReporterTest.groovy	Adds comprehensive test coverage for both FLAT and HIERARCHICAL modes
htmlSanityCheck-core/src/main/java/org/aim42/htmlsanitycheck/report/JUnitXmlReporter.java	Core implementation supporting both output styles with strategy pattern
htmlSanityCheck-core/src/main/java/org/aim42/htmlsanitycheck/Configuration.java	Defines `JunitOutputStyle` enum and adds configuration field
htmlSanityCheck-core/src/main/java/org/aim42/htmlsanitycheck/AllChecksRunner.java	Updates to pass configuration to JUnitXmlReporter
htmlSanityCheck-cli/src/main/groovy/org/aim42/htmlsanitycheck/cli/HscCommand.groovy	Adds CLI option for junitOutputStyle

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

htmlSanityCheck-core/src/main/java/org/aim42/htmlsanitycheck/report/JUnitXmlReporter.java

Copilot · 2025-10-13T21:17:13Z

htmlSanityCheck-core/src/main/java/org/aim42/htmlsanitycheck/report/JUnitXmlReporter.java

+
+        // Ensure the directory exists
+        if (!testOutputDir.exists() && !testOutputDir.mkdirs()) {
+            throw new RuntimeException("Cannot create directory " + testOutputDir); //NOSONAR(S112)


The error message should include more context about why directory creation failed. Consider including the original IOException details or system-specific error information to help with debugging.

Suggested change

throw new RuntimeException("Cannot create directory " + testOutputDir); //NOSONAR(S112)

StringBuilder errorMsg = new StringBuilder("Cannot create directory: ")

.append(testOutputDir.getAbsolutePath());

errorMsg.append(" (exists: ").append(testOutputDir.exists())

.append(", canWrite: ").append(testOutputDir.getParentFile() != null ? testOutputDir.getParentFile().canWrite() : "unknown")

.append(")");

throw new RuntimeException(errorMsg.toString()); //NOSONAR(S112)

ascheman · 2025-10-13T21:17:57Z

@strido This PR addresses your issue #405. Could you please test the solution using JitPack (instructions in the PR description) to verify it resolves your "File name too long" error? Your feedback would be greatly appreciated!

github-actions · 2025-10-13T21:26:29Z

Test Results

123 files ± 0 123 suites ±0 9m 2s ⏱️ - 3m 34s
501 tests +14 499 ✅ +14 0 💤 ±0 2 ❌ ±0
641 runs +14 576 ✅ +14 0 💤 ±0 65 ❌ ±0

For more details on these failures, see this check.

Results for commit bf8ce30. ± Comparison against base commit 9efca5e.

This pull request removes 60 and adds 37 tests. Note that renamed tests count towards both.

                                <a href="http://aim.org">improve</a>' 
                                <a href="http://arc42.de">arc42.de</a> and some more text
                                <a href="https://arc42.org">arc42 over https</a> even more
                                <a href="local-file.jpg">local file</a> again, text
                                <img src="" alt="2">
                                <img src="t.doc" alt="r"> '
    <area shape="circle" coords="0,1,1" href="#test2">
    <area shape="rect" coords="0,0,1,1" href="#id1" >
    <area shape="rect" coords="0,0,1,1" href="#test1" >
    <area shape="rect" coords="0,0,1,1" href="#test1">
…

org.aim42.htmlsanitycheck.check.ImageMapsCheckerSpec ‑ find image map issues [nrOfFindings: 1, imageMapStr: <img src="image1.jpg" usemap="#map1"><map name="map1">
    <area shape="rect" coords="0,0,1,1" href="#id1" >
</map>
<h2 id="foo" >bad header</h2>, msg: ImageMap "map1" refers to missing link "id1"., #4]
org.aim42.htmlsanitycheck.check.ImageMapsCheckerSpec ‑ find image map issues [nrOfFindings: 1, imageMapStr: <img src="image1.jpg" usemap="#map1"><map name="map1">
    <area shape="rect" coords="0,0,1,1" href="#id1" >
</map>
<map name="map1">
    <area shape="rect" coords="0,0,1,1" href="#id1" >
</map>
<h2 id="id1">aim42 header</h2>, msg: 2 imagemaps with identical name "map1" exist., #1]
org.aim42.htmlsanitycheck.check.ImageMapsCheckerSpec ‑ find image map issues [nrOfFindings: 1, imageMapStr: <img src="image1.jpg" usemap="#map1"><map name="map1">
</map>
, msg: ImageMap "map1" has no area tags., #3]
org.aim42.htmlsanitycheck.check.ImageMapsCheckerSpec ‑ find image map issues [nrOfFindings: 1, imageMapStr: <map name="map1">
    <area shape="rect" coords="0,0,1,1" href="#id1" >
</map>
<h2 id="id1">aim42 header</h2>, msg: ImageMap "map1" not referenced by any image., #2]
org.aim42.htmlsanitycheck.html.HtmlPageSpec ‑ can extract alt attributes from imageTag ' <img alt="1" >
                                <img src="" alt="2">
                                <img src="t.doc" alt="r"> '
org.aim42.htmlsanitycheck.html.HtmlPageSpec ‑ detect correct number of external http links in anchors '<a href="http://arc42.org">arc42</a> and some text
                                <a href="http://arc42.de">arc42.de</a> and some more text
                                <a href="https://arc42.org">arc42 over https</a> even more
                                <a href="local-file.jpg">local file</a> again, text
                                <a href="http://aim.org">improve</a>' 
org.aim42.htmlsanitycheck.html.HtmlPageSpec ‑ detect missing alt attributes in imageTag ' <img alt="1" >
                                <img src="" alt="2">
                                <img src="t.doc" alt="r"> '
org.aim42.htmlsanitycheck.html.ImageMapParserSpec ‑ find all areas within map [nrOfAreas: 1, mapName: mymap, htmlBody: <img src="image.gif" usemap="#mymap">
<map name="mymap">
    <area shape="rect" coords="0,0,1,1" href="#test1" >
</map> , #1]
org.aim42.htmlsanitycheck.html.ImageMapParserSpec ‑ find all areas within map [nrOfAreas: 2, mapName: mymap, htmlBody: <img src="image.gif" usemap="#mymap">
<map name="mymap">
    <area shape="rect" coords="0,0,1,1" href="#test1" >
    <area shape="circle" coords="0,1,1" href="#test2">
</map> , #0]
org.aim42.htmlsanitycheck.html.ImageMapParserSpec ‑ find all hrefs within map [nrOfHrefs: 1, mapName: mymap, htmlBody: <img src="image.gif" usemap="#mymap">
<map name="mymap">
    <area shape="rect" coords="0,0,1,1" href="#test1" >
</map> , hrefs: [#test1], #1]
…

♻️ This comment has been updated with latest results.

Address GitHub Copilot code review suggestions: 1. Enhanced path traversal security - Replace string-based startsWith() check with NIO Path API - Use Path.normalize() for more robust path validation - Prevent sophisticated path traversal attacks 2. Improved error diagnostics - Add detailed context to directory creation failures - Include directory existence status and parent permissions - Make debugging filesystem issues easier 3. Comprehensive test coverage - Add testPathTraversalAttackIsBlocked - Add testPathTraversalWithSymlinkStyleAttackIsBlocked - Add testEnhancedErrorMessageWhenDirectoryCreationFails - Add testEnhancedErrorMessageFormatIsCorrect - All 24 tests pass successfully 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>

ascheman · 2025-10-13T21:38:40Z

@copilot Please review the latest changes addressing your previous security and error handling suggestions.

Copilot

Pull Request Overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

htmlSanityCheck-core/src/main/java/org/aim42/htmlsanitycheck/report/JUnitXmlReporter.java

sonarqubecloud · 2025-10-13T21:42:33Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
89.3% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

strido · 2025-10-30T12:18:37Z

@ascheman I have tried the fix and its working with the new HIERARCHICAL junit output style on our project!

I tried the instructions in the description but haven't been able to get it to work (it seems like the build on jitpack fails?).
So I have built the branch and tested this locally, I guess that doesn't matter.

Thank you for your work!

ascheman · 2025-10-31T09:39:52Z

@ascheman I have tried the fix and its working with the new HIERARCHICAL junit output style on our project!

I tried the instructions in the description but haven't been able to get it to work (it seems like the build on jitpack fails?). So I have built the branch and tested this locally, I guess that doesn't matter.

Thank you for your work!

Thanks for trying this, @strido. I experienced similar problems on another branch/PR (cf. #429 / #431) with Jitpack meanwhile.
Sometimes, Jitpack can be a nightmare. So I raised a new issue to make the package (branches) available on GitHub packages. I hope to have a first publication available in the next days, stay tuned.

Sorry for the inconvenience.

ascheman and others added 3 commits October 13, 2025 22:00

Copilot AI review requested due to automatic review settings October 13, 2025 21:16

Copilot AI reviewed Oct 13, 2025

View reviewed changes

ascheman requested a review from Copilot October 13, 2025 21:41

Copilot AI reviewed Oct 13, 2025

View reviewed changes

htmlSanityCheck-core/src/main/java/org/aim42/htmlsanitycheck/report/JUnitXmlReporter.java Show resolved Hide resolved

ascheman added the hacktoberfest-accepted label Oct 29, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

#405 Fix "File name too long" error with deep paths in JUnit reports #426

#405 Fix "File name too long" error with deep paths in JUnit reports #426

Uh oh!

ascheman commented Oct 13, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Copilot AI Oct 13, 2025

Uh oh!

ascheman commented Oct 13, 2025

Uh oh!

github-actions bot commented Oct 13, 2025 •

edited

Loading

Uh oh!

ascheman commented Oct 13, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

sonarqubecloud bot commented Oct 13, 2025

Uh oh!

strido commented Oct 30, 2025

Uh oh!

ascheman commented Oct 31, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

-            throw new RuntimeException("Cannot create directory " + testOutputDir); //NOSONAR(S112)
+            StringBuilder errorMsg = new StringBuilder("Cannot create directory: ")
+                .append(testOutputDir.getAbsolutePath());
+            errorMsg.append(" (exists: ").append(testOutputDir.exists())
+                    .append(", canWrite: ").append(testOutputDir.getParentFile() != null ? testOutputDir.getParentFile().canWrite() : "unknown")
+                    .append(")");
+            throw new RuntimeException(errorMsg.toString()); //NOSONAR(S112)

#405 Fix "File name too long" error with deep paths in JUnit reports #426

Are you sure you want to change the base?

#405 Fix "File name too long" error with deep paths in JUnit reports #426

Uh oh!

Conversation

ascheman commented Oct 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

Core Implementation

Security & Quality Improvements (from GitHub Copilot review)

Plugin/CLI Updates

Testing

Documentation

Testing with JitPack

Gradle

Maven

Backward Compatibility

CI Status

Related Commits

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Copilot AI Oct 13, 2025

Choose a reason for hiding this comment

Uh oh!

ascheman commented Oct 13, 2025

Uh oh!

github-actions bot commented Oct 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test Results

Uh oh!

ascheman commented Oct 13, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

sonarqubecloud bot commented Oct 13, 2025

Quality Gate passed

Uh oh!

strido commented Oct 30, 2025

Uh oh!

ascheman commented Oct 31, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ascheman commented Oct 13, 2025 •

edited

Loading

github-actions bot commented Oct 13, 2025 •

edited

Loading