JDK-8319139: Improve diagnosability of JavadocTester output

[jonathan-gibbons]

Please review a small update to the output generated by JavadocTester when a test fails.

Although JavadocTester does report a stack trace, it appears after all the content of the failure message, which may be some distance away if the message is long.

The String message parameter for passed and failed is split in two: String message, String... details with the intent that the message should be a short one-line message, and any long additional info put in the effectively optional details.

The stack trace is now generated immediately after the initial FAILED: message line and before the details.
Using a varargs details means that we do not have to concatenate strings with \n.

There are some other minor tweaks to the output to make it slightly less cryptic.

JavadocTester does have some specific tests of its own, and these are updated as appropriate.

---

Progress

• Change must be properly reviewed (1 review required, with at least 1 Reviewer)
• Change must not contain extraneous whitespace
• Commit message must refer to an issue

Issue

• JDK-8319139: Improve diagnosability of JavadocTester output (Enhancement - P4)

Reviewers

• Hannes Wallnöfer (@hns - Reviewer)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/16436/head:pull/16436
$ git checkout pull/16436

Update a local copy of the PR:
$ git checkout pull/16436
$ git pull https://git.openjdk.org/jdk.git pull/16436/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 16436

View PR using the GUI difftool:
$ git pr show -t 16436

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/16436.diff

Webrev

Link to Webrev Comment

[bridgekeeper]

👋 Welcome back jjg! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

[openjdk]

@jonathan-gibbons The following label will be automatically applied to this pull request:

• javadoc

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command.

[mlbridge]

Webrevs

• 00: Full (69d71221)

[hns]

Looks good to me. Looking forward for seeing the new message format "in the wild".

[openjdk]

@jonathan-gibbons This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8319139: Improve diagnosability of `JavadocTester` output

Reviewed-by: hannesw

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 24 new commits pushed to the master branch:

• 0461d9a: 8318016: Per-compilation memory ceiling
• 2a76ad9: 8318683: compiler/c2/irTests/TestPhiDuplicatedConversion.java "Failed IR Rules (2) of Methods (2)"
• b3fec6b: 8306980: Generated docs should contain correct Legal Documents
• 1139482: 8316132: CDSProtectionDomain::get_shared_protection_domain should check for exception
• 2182c93: 8313643: Update HarfBuzz to 8.2.2
• 613a3cc: 8301846: Invalid TargetDataLine after screen lock when using JFileChooser or COM library
• 613d32c: 8169475: WheelModifier.java fails by timeout
• f1e8787: 8317609: Classfile API fails to verify /jdk.jcmd/sun/tools/jstat/Alignment.class
• 47624f6: 8299058: AssertionError in sun.net.httpserver.ServerImpl when connection is idle
• 2d5829a: 8239508: JFR: @RemoveFields
• ... and 14 more: https://git.openjdk.org/jdk/compare/d3534b08b5691c362db987f207da7cdd9c3b4b5a...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

[jonathan-gibbons]

/integrate

[openjdk]

Going to push as commit 3660a90.
Since your change was applied there have been 28 commits pushed to the master branch:

• 7f47c51: 8316025: Use testUI() method of PassFailJFrame.Builder in FileChooserSymLinkTest.java
• 36de19d: 8317048: VerifyError with unnamed pattern variable and more than one components
• ab19348: 8318647: Serial: Refactor BlockOffsetTable
• b4f5379: 8304939: os::win32::exit_process_or_thread should be marked noreturn
• 0461d9a: 8318016: Per-compilation memory ceiling
• 2a76ad9: 8318683: compiler/c2/irTests/TestPhiDuplicatedConversion.java "Failed IR Rules (2) of Methods (2)"
• b3fec6b: 8306980: Generated docs should contain correct Legal Documents
• 1139482: 8316132: CDSProtectionDomain::get_shared_protection_domain should check for exception
• 2182c93: 8313643: Update HarfBuzz to 8.2.2
• 613a3cc: 8301846: Invalid TargetDataLine after screen lock when using JFileChooser or COM library
• ... and 18 more: https://git.openjdk.org/jdk/compare/d3534b08b5691c362db987f207da7cdd9c3b4b5a...master

Your commit was automatically rebased without conflicts.

[openjdk]

@jonathan-gibbons Pushed as commit 3660a90.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.