8328242: Add a log area to the PassFailJFrame

[azvegint]

Often manual tests have a text area in the instruction window to print feedback from the test to be evaluated by a tester.
I stumbled across another test that needed this, so I decided to make these changes a standard feature.

List of changes:

• The log text area can be added below the Pass and Fail buttons panel.
  To do this, use the builder methods logArea(), logArea(int rows).
• PassFailJFrame.log(message), PassFailJFrame.logClear() and PassFailJFrame.logSet() are added to control this text area. (maybe I missed something?)
• added invokeOnEDTUncheckedException for easier use of logging methods

So typical usage would be like:

        PassFailJFrame
                .builder()
                .title("GetBoundsResizeTest Instructions")
                .instructions(INSTRUCTIONS)
                .rows(20)
                .columns(70)
                .logArea()
                .build()
                .awaitAndCheck();

---

//somewhere in event handlers:
PassFailJFrame.log("Very important message");

---

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-8328242: Add a log area to the PassFailJFrame (Enhancement - P4)

Reviewers

• Phil Race (@prrace - Reviewer) ⚠️ Review applies to a0fc617c
• Alexey Ivanov (@aivanov-jdk - Reviewer)
• Harshitha Onkar (@honkar-jdk - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 18319

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

Using diff file

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

Webrev

Link to Webrev Comment

[bridgekeeper]

👋 Welcome back azvegint! 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]

@azvegint 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:

8328242: Add a log area to the PassFailJFrame

Reviewed-by: prr, aivanov, honkar

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 18 new commits pushed to the master branch:

• 65a84c2: 8328006: refactor large anonymous inner class in HtmlDocletWriter
• 044f4ed: 8326979: (jdeps) improve the error message for FindException caused by InvalidModuleDescriptorException
• 71f9c4e: 8320534: fatal error for the NMTBenchmark test run for the mainline build
• bfba489: 8328157: Move C[XX]FLAGS_JDK[LIB/EXE] to JdkNativeCompilation.gmk
• 42aec8c: 8328146: Set LIBCXX automatically
• 90ab52e: 8328166: Epsilon: 'EpsilonHeap::allocate_work' misuses the parameter 'size' as size in bytes
• bf990c8: 8328269: NonFocusablePopupMenuTest.java should be marked as headful
• 80b98c8: 8320503: Print warning if VM reaches MallocLimit during error reporting
• dde519d: 8328066: WhiteBoxResizeTest failure on linux-x86: Could not reserve enough space for 2097152KB object heap
• 80ccc98: 8328075: Shenandoah: Avoid forwarding when objects don't move in full-GC
• ... and 8 more: https://git.openjdk.org/jdk/compare/f6390e5f801a3e25bda591e30e49db86519bf028...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.

[openjdk]

@azvegint The following label will be automatically applied to this pull request:

• client

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

• 01: Full - Incremental (77e5e4a5)
• 00: Full (a0fc617c)

[prrace]

The way you did it is as I imagined. As a result of the extra builder call,
there is an implicit log target created with a known way to use with which you can write to when you want.
And the size is the same width as the instructions with and you just specify
as many lines (rows) to be visible that makes sense, so long as it is scrollable.

[aivanov-jdk]

Perhaps, we should change the approach a bit… and create re-usable components or something similar. For example, the logging area could be placed in a test UI window while the same logging methods would be used to add log messages. Such a component could also display or hide Clear Log button.

It's more like a design idea to simplify adding new functionality and making it more isolated from the rest of the framework and thus re-usable.

[honkar-jdk]

@azvegint logArea() can be listed here as additional feature.

jdk/test/jdk/java/awt/regtesthelpers/PassFailJFrame.java

Line 154 in 07cb0b8

* Use methods of the {@code Builder} class or constructors of the

[azvegint]

@azvegint logArea() can be listed here as additional feature.

jdk/test/jdk/java/awt/regtesthelpers/PassFailJFrame.java

Line 154 in 07cb0b8

* Use methods of the {@code Builder} class or constructors of the

Thanks, added.

[azvegint]

Perhaps, we should change the approach a bit… and create re-usable components or something similar. For example, the logging area could be placed in a test UI window while the same logging methods would be used to add log messages. Such a component could also display or hide Clear Log button.

It's more like a design idea to simplify adding new functionality and making it more isolated from the rest of the framework and thus re-usable.

We can revisit this later if we actually need to add buttons or other controls, for now the JTextArea seems sufficient.

[azvegint]

/integrate

[openjdk]

Going to push as commit 9bc1b06.
Since your change was applied there have been 18 commits pushed to the master branch:

• 65a84c2: 8328006: refactor large anonymous inner class in HtmlDocletWriter
• 044f4ed: 8326979: (jdeps) improve the error message for FindException caused by InvalidModuleDescriptorException
• 71f9c4e: 8320534: fatal error for the NMTBenchmark test run for the mainline build
• bfba489: 8328157: Move C[XX]FLAGS_JDK[LIB/EXE] to JdkNativeCompilation.gmk
• 42aec8c: 8328146: Set LIBCXX automatically
• 90ab52e: 8328166: Epsilon: 'EpsilonHeap::allocate_work' misuses the parameter 'size' as size in bytes
• bf990c8: 8328269: NonFocusablePopupMenuTest.java should be marked as headful
• 80b98c8: 8320503: Print warning if VM reaches MallocLimit during error reporting
• dde519d: 8328066: WhiteBoxResizeTest failure on linux-x86: Could not reserve enough space for 2097152KB object heap
• 80ccc98: 8328075: Shenandoah: Avoid forwarding when objects don't move in full-GC
• ... and 8 more: https://git.openjdk.org/jdk/compare/f6390e5f801a3e25bda591e30e49db86519bf028...master

Your commit was automatically rebased without conflicts.

[openjdk]

@azvegint Pushed as commit 9bc1b06.

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