Skip to content

Conversation

@chihyu0917
Copy link

Motivation

MarkdownParserTest#testHtmlContent was brittle around HTML tables.
Inside <table><tbody>…</tbody></table>, the event stream intermittently included extra "text" whitespace nodes and "unknown" nodes (tbody boundary markers), which caused order-sensitive assertions to fail (e.g., expecting text but seeing tableRow / tableHeaderCell_). This is environmental/renderer dependent and shows up under different JDKs/runners and with NonDex.

Design / Implementation

  • Replace the large positional assertSinkEquals(...) block for this test with a compact normalization loop:
    • Iterate the emitted events.
    • Track when we are inside tableRowstableRows_.
    • While inside that region, skip intermittent "text" and "unknown" events.
    • Compare the remaining sequence with a concise exp list.
      Scope is only htmlContent; no production code touched, no new imports or dependencies.

Reproduce the error

  • Error message: org.apache.maven.doxia.module.markdown.MarkdownParserTest.htmlContent -- Time elapsed: 0.869 s <<< FAILURE! org.opentest4j.AssertionFailedError
  • Reproduce: mvn -pl doxia-modules/doxia-module-markdown edu.illinois:nondex-maven-plugin:2.1.7:nondex -Dtest=org.apache.maven.doxia.module.markdown.MarkdownParserTest#htmlContent

Following this checklist to help us incorporate your
contribution quickly and easily:

  • Your pull request should address just one issue, without pulling in other changes.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Each commit in the pull request should have a meaningful subject line and body.
    Note that commits might be squashed by a maintainer on merge.
  • Write unit tests that match behavioral changes, where the tests fail if the changes to the runtime are not applied.
    This may not always be possible but is a best-practice.
  • Run mvn verify to make sure basic checks pass.
    A more thorough check will be performed on your pull request automatically.
  • You have run the integration tests successfully (mvn -Prun-its verify).

If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.

To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.

@chihyu0917 chihyu0917 changed the title test(markdown): stabilize htmlContent by normalizing tableRows whitespace/boundary events fix bugs: stabilize htmlContent by normalizing tableRows whitespace/boundary events Nov 8, 2025
@chihyu0917
Copy link
Author

I rerun mvn spotless:apply to ensure not failing in CI

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant