8348299: Update List/ItemEventTest/ItemEventTest.java

Use thread-safe StringBuffer to track selecting/deselecting items.
Use auto waitForIdle for all events.
Log handleEvent and ItemListener.
Take screenshot of the list on failure;
Optionally take screenshot after each mouse press+release.

Reviewed-by: azvegint, prr, kizune

Author: aivanov-jdk

test/jdk/java/awt/List/ItemEventTest/ItemEventTest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016, 2016, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2016, 2025, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -27,8 +27,13 @@
  * @bug 8033936 8172510
  * @summary Verify that correct ItemEvent is received while selection &
  *          deselection of multi select List items.
+ * @library /test/lib
+ * @build jdk.test.lib.Platform
+ * @run main ItemEventTest
  */
 
+// Pass -save to the test to enable screenshots at each select/deselect
+
 import java.awt.AWTException;
 import java.awt.Event;
 import java.awt.FlowLayout;
@@ -37,26 +42,30 @@
 import java.awt.Point;
 import java.awt.Rectangle;
 import java.awt.Robot;
-import java.awt.event.KeyEvent;
 import java.awt.event.InputEvent;
-import java.awt.event.ItemEvent;
-import java.awt.event.ItemListener;
-
-public class ItemEventTest extends Frame
-{
-    List list;
-    final String expectedSelectionOrder;
-    StringBuilder actualSelectionOrder;
-    Robot robot;
-
-    public ItemEventTest()
-    {
-        try {
-            robot = new Robot();
-        } catch(AWTException e) {
-            throw new RuntimeException(e.getMessage());
-        }
-        expectedSelectionOrder = "01230123";
+import java.awt.event.KeyEvent;
+import java.awt.image.RenderedImage;
+import java.io.File;
+import java.io.IOException;
+
+import javax.imageio.ImageIO;
+
+import jdk.test.lib.Platform;
+
+public final class ItemEventTest extends Frame {
+    private static final String expectedSelectionOrder = "01230123";
+
+    private static boolean saveScreenshots;
+
+    private final StringBuffer actualSelectionOrder
+            = new StringBuffer(expectedSelectionOrder.length());
+
+    private final List list;
+    private final Robot robot;
+
+    private ItemEventTest() throws AWTException {
+        robot = new Robot();
+        robot.setAutoWaitForIdle(true);
 
         list = new List(4, true);
         list.add("0");
@@ -65,82 +74,109 @@ public ItemEventTest()
         list.add("3");
 
         add(list);
+
         setSize(400,400);
         setLayout(new FlowLayout());
         pack();
+        setLocationRelativeTo(null);
         setVisible(true);
         robot.waitForIdle();
     }
 
     @Override
+    @SuppressWarnings("deprecation")
     public boolean handleEvent(Event e) {
-        if (e.target instanceof List) {
-            if (e.id == Event.LIST_DESELECT || e.id == Event.LIST_SELECT) {
-                actualSelectionOrder.append(e.arg);
-            }
+        if ((e.target instanceof List)
+            && (e.id == Event.LIST_DESELECT
+                || e.id == Event.LIST_SELECT)) {
+            logEvent("handleEvent: ", e.arg);
         }
         return true;
     }
 
-    void testHandleEvent() {
+    private void logEvent(String method, Object listItem) {
+        actualSelectionOrder.append(listItem);
+        System.out.println(method + listItem);
+    }
+
+    private void testHandleEvent() {
         // When no ItemListener is added to List, parent's handleEvent is
         // called with ItemEvent.
         performTest();
     }
 
-    void testItemListener() {
-        list.addItemListener(new ItemListener() {
-            @Override
-            public void itemStateChanged(ItemEvent ie) {
-                actualSelectionOrder.append(ie.getItem());
-            }
-        });
+    private void testItemListener() {
+        list.addItemListener(ie
+                -> logEvent("testItemListener: ", ie.getItem()));
         performTest();
     }
 
-    void performTest() {
-        actualSelectionOrder = new StringBuilder();
-        Point loc = list.getLocationOnScreen();
-        Rectangle rect = list.getBounds();
-        int dY = rect.height / list.getItemCount();
-        loc = new Point(loc.x + 10, loc.y + 5);
+    private void performTest() {
+        actualSelectionOrder.setLength(0);
+
+        final Rectangle rect = getListBoundsOnScreen();
+        final int dY = rect.height / list.getItemCount();
+        final Point loc = new Point(rect.x + rect.width / 2,
+                                    rect.y + dY / 2);
 
-        String osName = System.getProperty("os.name");
-        boolean isMac = osName.contains("Mac") || osName.contains("mac");
-        if(isMac) {
+        if (Platform.isOSX()) {
             robot.keyPress(KeyEvent.VK_META);
-            robot.waitForIdle();
         }
 
         // First loop to select & Second loop to deselect the list items.
         for (int j = 0; j < 2; ++j) {
             for (int i = 0; i < list.getItemCount(); ++i) {
                 robot.mouseMove(loc.x, loc.y + i * dY);
+                robot.mousePress(InputEvent.BUTTON1_DOWN_MASK);
+                robot.mouseRelease(InputEvent.BUTTON1_DOWN_MASK);
                 robot.waitForIdle();
-                robot.mousePress(InputEvent.BUTTON1_MASK);
-                robot.waitForIdle();
-                robot.mouseRelease(InputEvent.BUTTON1_MASK);
-                robot.waitForIdle();
+
+                if (saveScreenshots) {
+                    saveImage(robot.createScreenCapture(rect));
+                }
             }
         }
 
-        if(isMac) {
+        if (Platform.isOSX()) {
             robot.keyRelease(KeyEvent.VK_META);
         }
 
-        if (!expectedSelectionOrder.equals(actualSelectionOrder.toString())) {
-            dispose();
+        if (!expectedSelectionOrder.contentEquals(actualSelectionOrder)) {
+            saveImage(robot.createScreenCapture(rect));
+
             throw new RuntimeException("ItemEvent for selection & deselection"
                 + " of multi select List's item is not correct"
                 + " Expected : " + expectedSelectionOrder
                 + " Actual : " + actualSelectionOrder);
         }
     }
 
-    public static void main(String args[]) {
-       ItemEventTest test = new ItemEventTest();
-       test.testHandleEvent();
-       test.testItemListener();
-       test.dispose();
+    private Rectangle getListBoundsOnScreen() {
+        return new Rectangle(list.getLocationOnScreen(),
+                             list.getSize());
+    }
+
+    private static int imageNo = 0;
+
+    private static void saveImage(RenderedImage image) {
+        try {
+            ImageIO.write(image,
+                          "png",
+                          new File(String.format("image-%02d.png",
+                                                 ++imageNo)));
+        } catch (IOException ignored) {
+        }
+    }
+
+    public static void main(String[] args) throws AWTException {
+        saveScreenshots = args.length > 0 && "-save".equals(args[0]);
+
+        ItemEventTest test = new ItemEventTest();
+        try {
+            test.testHandleEvent();
+            test.testItemListener();
+        } finally {
+            test.dispose();
+        }
     }
 }