8332901: Select{Current,New}ItemTest.java for Choice don't open popup on macOS #20601

aivanov-jdk · 2024-08-15T18:02:33Z

I looked at java/awt/Choice/SelectCurrentItemTest/SelectCurrentItemTest.java, ran it and noticed that the test does not open the popup of the Choice component on macOS 14.x.

If the popup does not open, the test does not verify anything — it always passes.

I refactored the test and added a mouse listener to the Choice component. If mouse click isn't registered, the test fails.

Later, I found a similar test: test/jdk/java/awt/Choice/SelectNewItemTest/SelectNewItemTest.java. It clicks on another item in the Choice popup and expects to receive ItemEvent.

I refactored both tests and moved them into Choice/SelectItem folder.

SelectCurrentItemTest encapsulates the common test logic and provides overridable methods to customise conditions for SelectNewItemTest.

Now, SelectNewItemTest extends SelectCurrentItemTest and overrides the conditions as well as the coordinates for clicking the popup of the Choice component.

~~The updated test fails for me locally on macOS Sonoma 14.5. This is likely the result of JDK-8322653: [macos14] : Mouse clicks are not received within 3 pixels of the window boundary.~~

To work around JDK-8322653, both tests use non-resizable frame. Both updated tests pass on CI and locally on macOS 14.5. This is why I removed SelectNewItemTest from problem-list.

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-8332901: Select{Current,New}ItemTest.java for Choice don't open popup on macOS (Bug - P4)

Reviewers

Harshitha Onkar (@honkar-jdk - Reviewer)
Damon Nguyen (@DamonGuy - Committer) Review applies to c288ab68
Phil Race (@prrace - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 20601

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

Using diff file

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

Webrev

Link to Webrev Comment

bridgekeeper · 2024-08-15T18:03:10Z

👋 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 · 2024-08-15T18:04:21Z

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

8332901: Select{Current,New}ItemTest.java for Choice don't open popup on macOS

Move SelectCurrentItemTest.java to java/awt/Choice/SelectItem/.
Move SelectNewItemTest.java to java/awt/Choice/SelectItem/.
Use latches to control test flow instead of delays.
Encapsulate the common logic in SelectCurrentItemTest.
Provide overridable checkXXX() methods to modify conditions.
Provide an overridable method which defines where to click
in the choice popup to select an item.

Reviewed-by: honkar, prr, dnguyen

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

2fb8305: 8339319: ProblemList runtime/exceptionMsgs/NoClassDefFoundError/NoClassDefFoundErrorTest.java
3a352b8: 8339191: JFR: Bulk read support for ChunkInputStream
92c4704: 8339166: java/lang/String/concat/HiddenClassUnloading.java fails on AIX and Linux ppc64le after JDK-8336856
2abe2ff: 8339235: Fix indentation in build system
bb28b0d: 8338404: Cross-compilation to different endianness fails after JDK-8318913
b872718: 8338301: Error recovery and reporting should be improved for erroneous implicitly declared classes
b9e65f9: 8337662: Improve os::print_hex_dump for printing Instructions sections
f927c12: 8339154: Cleanups and JUnit conversion of test/jdk/java/util/zip/Available.java
4675913: 8339237: RISC-V: Builds fail after JDK-8339120
b711c41: 8339196: Optimize BufWriterImpl#writeU1/U2/Int/Long
... and 137 more: https://git.openjdk.org/jdk/compare/f308b2d59672b39ddca502baff50ab20ab781047...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 · 2024-08-15T18:04:52Z

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

mlbridge · 2024-08-15T18:08:26Z

Webrevs

honkar-jdk

@aivanov-jdk As you mentioned earlier this test fails on macOS 14.5 due to JDK-8322653, since it passes on CI (14.3 and 14.4) do we skip problemlisting the test for now ?

honkar-jdk · 2024-08-16T00:51:27Z

test/jdk/java/awt/Choice/SelectCurrentItemTest/SelectCurrentItemTest.java

        frame.addWindowListener(this);

-        frame.setLocation(1,20);
-        robot.mouseMove(10, 30);
+        frame.setLocationRelativeTo(null);
        frame.pack();


When frame.setSize() is used, the mouse pointer on the choice drop-down button is no longer a resize indicator and the click event is received. But I guess you are planning to leave this as-is for now to test when the external fix is available for JDK-8322653

When frame.setSize() is used, the mouse pointer on the choice drop-down button is no longer a resize indicator and the click event is received.

I don't understand how using frame.setSize resolve the problem? Both pack and setSize call reshape to apply the new location and size.

Did you mean frame.setResizable(false)?

But I guess you are planning to leave this as-is for now to test when the external fix is available for JDK-8322653

We can modify this test to avoid JDK-8322653.

I added a panel to the frame to move the mouse cursor away from the edge of the frame while I verified the test would pass.

I don't understand how using frame.setSize resolve the problem? Both pack and setSize call reshape to apply the new location and size.

When the frame width and height is increased then the mouse is no longer a resize indicator which makes the 1st click (on the choice dropdown button) work but the 2nd click on the choice item needs to be adjusted accordingly.

I believe frame.setResizable(false) or adding a panel as you suggested is a better and easier option.

We can modify this test to avoid JDK-8322653

Since there are already few tests problemlisted to track the external issue JDK-8322653, I think any of the above workarounds that you suggested can be added to avoid JDK-8322653. What do you think?

aivanov-jdk · 2024-08-16T14:14:04Z

since it passes on CI (14.3 and 14.4) do we skip problemlisting the test for now ?

I'm unsure whether the test has ever run on 14.x in CI.

The test has never failed for me when I submitted test jobs. As such, I have no reasons to problem-list it.

honkar-jdk

LGTM

DamonGuy

LGTM as well

Use latches to control test flow instead of delays and volatile variables.

Encapsulate the common logic in SelectCurrentItemTest. Provide overridable checkXXX() methods to modify conditions. Provide an overridable method which defines where to click in the choice popup to select an item.

aivanov-jdk · 2024-08-20T14:53:10Z

While I worked on another backport, I found SelectNewItemTest.java. This test is basically the same: the only difference is that it selects a new item in the choice popup and expects ItemEvent.

I updated the other test too and refactored both of them to re-use common functionality.

I moved both tests — test/jdk/java/awt/Choice/SelectCurrentItemTest/SelectCurrentItemTest.java and test/jdk/java/awt/Choice/SelectNewItemTest/SelectNewItemTest.java — to test/jdk/java/awt/Choice/SelectItem/ folder. The SelectCurrentItemTest is the main one as the oldest; and SelectNewItemTest now extends SelectCurrentItemTest.

Both updated tests pass in CI and locally on macOS 14.x. Non-resizable frame is used to work around JDK-8322653.

I will update JBS issue and the description of the PR accordingly.

aivanov-jdk · 2024-08-20T15:20:35Z

Unfortunately, Git does not recognise the files are moved with so many additional changes.

As a workaround, I can submit a new issue and integrate it where the files are moved only. This way we could preserve the history of the changes to the tests.

Do you have any opinions?

honkar-jdk · 2024-08-20T16:45:36Z

Unfortunately, Git does not recognise the files are moved with so many additional changes.

As a workaround, I can submit a new issue and integrate it where the files are moved only. This way we could preserve the history of the changes to the tests.

Do you have any opinions?

@aivanov-jdk Does it work if you move the test files using git mv, commit it and in the next commit modify the files
I mean 2 separate commits - one for move and another one that modifies the files.

aivanov-jdk · 2024-08-20T17:01:03Z

@aivanov-jdk Does it work if you move the test files using git mv, commit it and in the next commit modify the files
I mean 2 separate commits - one for move and another one that modifies the files.

That's exactly what I did if you look at the history of the commits.

It doesn't work in the code review. It won't work after integration either.

After integration, individual commits are lost, everything is squashed into one changeset.

The only reliable way to preserve the history across renames (and modification) is to integrate a separate changeset where the files are only renamed without any modifications.

honkar-jdk

LGTM

Ideally these two tests can be combined since they are very similar and it also means one test less to run on CI.
But since you are reusing the SelectCurrentItemTest test code and overriding the methods, this approach is cleaner and doesn't make the test complicated.

aivanov-jdk · 2024-08-20T20:03:48Z

Ideally these two tests can be combined since they are very similar and it also means one test less to run on CI.

I believe the difference is close to negligible. Creating UI and waiting for it to be displayed likely takes more than compiling the test source code and starting a new JVM process.

But since you are reusing the SelectCurrentItemTest test code and overriding the methods, this approach is cleaner and doesn't make the test complicated.

Yes, I think it's cleaner this way. Each test does one thing and tests its own scenario.

The old SelectNewItemTest also verified the case where the same item was selected from the popup again. Thus, it repeated what SelectCurrentItemTest did for a long time. So I removed it.

I found another test which tests the same scenario as SelectNewItemTest, it's test/jdk/java/awt/event/ComponentEvent/ComponentItemEventTest.java. It was added in #11786. I'm going to submit a bug to remove this scenario from the ComponentItemEventTest test.

aivanov-jdk · 2024-08-30T15:09:28Z

/summary
Move SelectCurrentItemTest.java to java/awt/Choice/SelectItem/.
Move SelectNewItemTest.java to java/awt/Choice/SelectItem/.
Use latches to control test flow instead of delays.
Encapsulate the common logic in SelectCurrentItemTest.
Provide overridable checkXXX() methods to modify conditions.
Provide an overridable method which defines where to click
in the choice popup to select an item.

openjdk · 2024-08-30T15:10:51Z

@aivanov-jdk Setting summary to:

Move SelectCurrentItemTest.java to java/awt/Choice/SelectItem/.
Move SelectNewItemTest.java to java/awt/Choice/SelectItem/.
Use latches to control test flow instead of delays.
Encapsulate the common logic in SelectCurrentItemTest.
Provide overridable checkXXX() methods to modify conditions.
Provide an overridable method which defines where to click
in the choice popup to select an item.

honkar-jdk

Updated changes and summary looks good.

aivanov-jdk · 2024-09-04T16:35:21Z

I found another test which tests the same scenario as SelectNewItemTest, it's test/jdk/java/awt/event/ComponentEvent/ComponentItemEventTest.java. It was added in #11786. I'm going to submit a bug to remove this scenario from the ComponentItemEventTest test.

I submitted JDK-8339338 to remove Choice from ComponentItemEventTest.

aivanov-jdk · 2024-09-04T16:35:33Z

/integrate

openjdk · 2024-09-04T16:37:17Z

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

12d060a: 8339148: Make os::Linux::active_processor_count() public
0cfd08f: 8339112: Move JVM Klass flags out of AccessFlags
6f8714e: 8336860: x86: Change integer src operand for CMoveL of 0 and 1 to long
c7d15f1: 8325679: Optimize ArrayList subList sort
bd8569b: 8339131: Remove rarely-used accessor methods from Opcode
e25a9e7: 8339486: JFR: Modernize
4e2dde2: 8339371: jlink.log warning when building after JDK-8338404
7ad6160: 8339163: ZGC: Race in clearing of remembered sets
a618605: 8339399: ZGC: Remove unnecessary page reset when splitting pages
f2c992c: 8339300: CollectorPolicy.young_scaled_initial_ergo_vm gtest fails on ppc64 based platforms
... and 184 more: https://git.openjdk.org/jdk/compare/f308b2d59672b39ddca502baff50ab20ab781047...master

Your commit was automatically rebased without conflicts.

openjdk · 2024-09-04T16:37:23Z

@aivanov-jdk Pushed as commit ef96a7b.

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

8332901:

2da478d

openjdk bot added the rfr Pull request is ready for review label Aug 15, 2024

openjdk bot added the client client-libs-dev@openjdk.org label Aug 15, 2024

honkar-jdk reviewed Aug 16, 2024

View reviewed changes

Make frame non-resizable to workaround JDK-8322653

c288ab6

honkar-jdk approved these changes Aug 19, 2024

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Aug 19, 2024

DamonGuy approved these changes Aug 19, 2024

View reviewed changes

aivanov-jdk added 4 commits August 20, 2024 14:36

Refactor SelectNewItemTest similar to SelectCurrentItemTest

b9fab1f

Use latches to control test flow instead of delays and volatile variables.

Move *CurrentItem*.java and *NewItem*.java to Choice/SelectItem/

ee6e088

Refactor Select{New,Current}ItemTest

1d6956c

Encapsulate the common logic in SelectCurrentItemTest. Provide overridable checkXXX() methods to modify conditions. Provide an overridable method which defines where to click in the choice popup to select an item.

Remove SelectNewItemTest from ProblemList.txt

e6d0481

openjdk bot removed the ready Pull request is ready to be integrated label Aug 20, 2024

Amend the copyright year in SelectCurrentItemTest

28ea7d2

aivanov-jdk requested review from honkar-jdk and DamonGuy August 20, 2024 14:43

aivanov-jdk changed the title ~~8332901: Choice/SelectCurrentItemTest/SelectCurrentItemTest.java doesn't open popup on macOS~~ Select{Current,New}ItemTest.java for Choice don't open popup on macOS Aug 20, 2024

openjdk bot removed the rfr Pull request is ready for review label Aug 20, 2024

aivanov-jdk changed the title ~~Select{Current,New}ItemTest.java for Choice don't open popup on macOS~~ 8332901: Select{Current,New}ItemTest.java for Choice don't open popup on macOS Aug 20, 2024

openjdk bot added the rfr Pull request is ready for review label Aug 20, 2024

honkar-jdk approved these changes Aug 20, 2024

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Aug 20, 2024

prrace approved these changes Aug 23, 2024

View reviewed changes

honkar-jdk approved these changes Aug 30, 2024

View reviewed changes

openjdk bot added the integrated Pull request has been integrated label Sep 4, 2024

openjdk bot closed this Sep 4, 2024

openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Sep 4, 2024

aivanov-jdk deleted the 8332901-SelectCurrentItemTest-popup branch October 8, 2024 15:51

8332901: Select{Current,New}ItemTest.java for Choice don't open popup on macOS #20601

8332901: Select{Current,New}ItemTest.java for Choice don't open popup on macOS #20601

Uh oh!

Conversation

aivanov-jdk commented Aug 15, 2024 • edited by openjdk bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Progress

Issue

Reviewers

Reviewing

Webrev

Uh oh!

bridgekeeper bot commented Aug 15, 2024

Uh oh!

openjdk bot commented Aug 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openjdk bot commented Aug 15, 2024

Uh oh!

mlbridge bot commented Aug 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Webrevs

Uh oh!

honkar-jdk left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

honkar-jdk Aug 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aivanov-jdk Aug 16, 2024

Choose a reason for hiding this comment

Uh oh!

honkar-jdk Aug 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aivanov-jdk commented Aug 16, 2024

Uh oh!

honkar-jdk left a comment

Choose a reason for hiding this comment

Uh oh!

DamonGuy left a comment

Choose a reason for hiding this comment

Uh oh!

aivanov-jdk commented Aug 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aivanov-jdk commented Aug 20, 2024

Uh oh!

honkar-jdk commented Aug 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aivanov-jdk commented Aug 20, 2024

Uh oh!

honkar-jdk left a comment

Choose a reason for hiding this comment

Uh oh!

aivanov-jdk commented Aug 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aivanov-jdk commented Aug 30, 2024

Uh oh!

openjdk bot commented Aug 30, 2024

Uh oh!

honkar-jdk left a comment

Choose a reason for hiding this comment

Uh oh!

aivanov-jdk commented Sep 4, 2024

Uh oh!

aivanov-jdk commented Sep 4, 2024

Uh oh!

openjdk bot commented Sep 4, 2024

Uh oh!

openjdk bot commented Sep 4, 2024

Uh oh!

Uh oh!

aivanov-jdk commented Aug 15, 2024 •

edited by openjdk bot

Loading

openjdk bot commented Aug 15, 2024 •

edited

Loading

mlbridge bot commented Aug 15, 2024 •

edited

Loading

honkar-jdk left a comment •

edited

Loading

honkar-jdk Aug 16, 2024 •

edited

Loading

honkar-jdk Aug 16, 2024 •

edited

Loading

aivanov-jdk commented Aug 20, 2024 •

edited

Loading

honkar-jdk commented Aug 20, 2024 •

edited

Loading

aivanov-jdk commented Aug 20, 2024 •

edited

Loading