Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

8340785: Update description of PassFailJFrame and samples #21162

Closed
wants to merge 2 commits into from

Conversation

aivanov-jdk
Copy link
Member

@aivanov-jdk aivanov-jdk commented Sep 24, 2024

I re-worked the entire description of PassFailJFrame:

Add description of what UI elements it provides and how to interact with them.
Add anchors for linking to the sections.

Use {@snippet} instead of <pre>{@code}</pre> for sample code.
Use method references instead of lambdas in samples.
Document required jtreg tags to use PassFailJFrame.
Rename SampleOldManualTest to ObsoleteManualTest.

Provide an overview of Builder methods to configure PassFailJFrame.

As in #21145, the generated javadoc PassFailJFrame.html could be easier to read and review.

The current version of the generated docs contains changes from #21145 and this PR. The PRs can be integrated independently.


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-8340785: Update description of PassFailJFrame and samples (Sub-task - P4)

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 21162

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

Using diff file

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

Webrev

Link to Webrev Comment

Re-work the entire description of PassFailJFrame:
Add description of what UI elements it provides and
how to interact with them.
Add anchors for linking to the sections.

Use {@snippet} instead of <pre>{@code}</pre> for sample code.
Use method references instead of lambdas in samples.
Document required jtreg tags to use PassFailJFrame.
Rename SampleOldManualTest to ObsoleteManualTest.

Provide an overview of Builder methods to configure PassFailJFrame.
@bridgekeeper
Copy link

bridgekeeper bot commented Sep 24, 2024

👋 Welcome back aivanov! 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
Copy link

openjdk bot commented Sep 24, 2024

@aivanov-jdk 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:

8340785: Update description of PassFailJFrame and samples

Reviewed-by: prr

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

  • 8f75619: 8340864: Remove unused lines related to vmClasses
  • 84751cb: 8340831: Simplify simple validation for class definition in MethodHandles.Lookup
  • df1959f: 8340838: Clean up MutableCallSite to use explicit release fence instead of AtomicInteger
  • 1b2d40a: 8340956: ProblemList 4 java/nio/channels/DatagramChannel tests on macosx-all
  • f7bc9ba: 8340228: Open source couple more miscellaneous AWT tests
  • 0e0b0b0: 8340684: Reading from an input stream backed by a closed ZipFile has no test coverage
  • 81b5f09: 8340946: Add vmTestbase/gc/memory/Nio/Nio.java and java/nio/Buffer/LimitDirectMemory.java to problem list
  • 0474f02: 8340815: Add SECURITY.md file
  • fb70325: 8338583: NMT: Malloc overhead is calculated incorrectly
  • 083b980: 8340568: Incorrect escaping of single quotes when pretty-printing character literals
  • ... and 38 more: https://git.openjdk.org/jdk/compare/e97f0fe1b4046bfcc40e85ba1bee4f4c40053300...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 openjdk bot added the rfr Pull request is ready for review label Sep 24, 2024
@openjdk
Copy link

openjdk bot commented Sep 24, 2024

@aivanov-jdk 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.

@openjdk openjdk bot added the client client-libs-dev@openjdk.org label Sep 24, 2024
@mlbridge
Copy link

mlbridge bot commented Sep 24, 2024

Webrevs

@aivanov-jdk
Copy link
Member Author

There are still some missing parts, like more details on different kinds of testUI overloads and support for multiple windows.

At the same time, the description is close to comprehensive, the javadoc comment for the PassFailJFrame takes more than 200 lines.

* A framework for manual tests to display test instructions and
* <i>Pass</i> / <i>Fail</i> buttons. The framework automatically
* creates a frame to display the instructions, provides buttons
* to select the test result, handles test timeout.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"and handles"

@openjdk openjdk bot added the ready Pull request is ready to be integrated label Sep 24, 2024
@openjdk openjdk bot removed the ready Pull request is ready to be integrated label Sep 25, 2024
@openjdk openjdk bot added the ready Pull request is ready to be integrated label Sep 25, 2024
@aivanov-jdk
Copy link
Member Author

/integrate

@openjdk
Copy link

openjdk bot commented Oct 2, 2024

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

  • 85f0442: 8317116: Provide layouts for multiple test UI in PassFailJFrame
  • 49501fe: 8341412: Various test failures after JDK-8334305
  • 8838048: 8324259: Classes used by CDS at runtime should be archived
  • 5e98007: 8307532: Implement LM_LIGHTWEIGHT for Zero
  • 855c8a7: 8334305: Remove all code for nsk.share.Log verbose mode
  • d6820d1: 8336274: MutableBigInteger.leftShift(int) optimization
  • a4ca626: 8341146: RISC-V: Unnecessary fences used for load-acquire in template interpreter
  • c8c4ff2: 8341135: Incorrect format string after JDK-8339475
  • efe3573: 8340109: Ubsan: ciEnv.cpp:1660:65: runtime error: member call on null pointer of type 'struct CompileTask'
  • 52c2ea6: 8340732: RISC-V: Refactor crc32 scalar version
  • ... and 126 more: https://git.openjdk.org/jdk/compare/e97f0fe1b4046bfcc40e85ba1bee4f4c40053300...master

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot added the integrated Pull request has been integrated label Oct 2, 2024
@openjdk openjdk bot closed this Oct 2, 2024
@openjdk openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Oct 2, 2024
@openjdk
Copy link

openjdk bot commented Oct 2, 2024

@aivanov-jdk Pushed as commit 5063494.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
client client-libs-dev@openjdk.org integrated Pull request has been integrated
Development

Successfully merging this pull request may close these issues.

2 participants