1 /*
   2  * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  */
  23 
  24 /*
  25   @test
  26   @bug 8007220 8039081
  27   @summary Reference to the popup should not leak after the TrayIcon is 
  28            removed from system tray.
  29   @run main/othervm -Xmx50m PopupMenuLeakTest
  30  */
  31 
  32 import java.awt.Color;
  33 import java.awt.Frame;
  34 import java.awt.Graphics2D;
  35 import java.awt.Image;
  36 import java.awt.MenuItem;
  37 import java.awt.PopupMenu;
  38 import java.awt.RenderingHints;
  39 import java.awt.SystemTray;
  40 import java.awt.TrayIcon;
  41 import java.awt.image.BufferedImage;
  42 import javax.swing.SwingUtilities;
  43 import java.lang.ref.WeakReference;
  44 import java.util.ArrayList;
  45 import java.util.concurrent.atomic.AtomicReference;
  46 
  47 public class PopupMenuLeakTest {
  48 
  49     static final AtomicReference<WeakReference<TrayIcon>> iconWeakReference
  50             = new AtomicReference<>();
  51     static final AtomicReference<WeakReference<PopupMenu>> popupWeakReference
  52             = new AtomicReference<>();
  53     static Frame popupMenuParentFrame;
  54 
  55     public static void main(String[] args) throws Exception {
  56         SwingUtilities.invokeAndWait(PopupMenuLeakTest::createSystemTrayIcon);
  57         // To automate the test, explicitly call addNotify on a popup
  58         // to create the peer.
  59         SwingUtilities.invokeAndWait(PopupMenuLeakTest::addNotifyPopup);
  60         SwingUtilities.invokeAndWait(PopupMenuLeakTest::removeIcon);
  61         assertCollected(popupWeakReference.get(),
  62                 "Failed, reference to popup not collected");
  63         assertCollected(iconWeakReference.get(),
  64                 "Failed, reference to tray icon not collected");
  65     }
  66 
  67     private static void addNotifyPopup() {
  68         PopupMenu menu = popupWeakReference.get().get();
  69         if (menu == null) {
  70             throw new RuntimeException("Failed: popup collected too early");
  71         }
  72         menu.addNotify();
  73     }
  74 
  75     private static void removeIcon() {
  76         TrayIcon icon = iconWeakReference.get().get();
  77         if (icon == null) {
  78             throw new RuntimeException("Failed: TrayIcon collected too early");
  79         }
  80         SystemTray.getSystemTray().remove(icon);
  81 
  82         PopupMenu menu = popupWeakReference.get().get();
  83         popupMenuParentFrame.remove(menu);
  84         popupMenuParentFrame.dispose();
  85     }
  86 
  87     private static void assertCollected(WeakReference<?> reference,
  88             String message) {
  89         java.util.List<byte[]> bytes = new ArrayList<>();
  90         try {
  91             while (true) {
  92                 bytes.add(new byte[4096]);
  93             }
  94         } catch (OutOfMemoryError err) {
  95         }
  96         if (reference.get() != null) {
  97             throw new RuntimeException(message);
  98         }
  99     }
 100 
 101     private static void createSystemTrayIcon() {
 102         final TrayIcon trayIcon = new TrayIcon(createTrayIconImage());
 103         trayIcon.setImageAutoSize(true);
 104 
 105         try {
 106             // Add tray icon to system tray *before* adding popup menu.
 107             trayIcon.setPopupMenu(createTrayIconPopupMenu());
 108             SystemTray.getSystemTray().add(trayIcon);
 109             iconWeakReference.set(new WeakReference<>(trayIcon));
 110             popupWeakReference.set(new WeakReference<>(
 111                     trayIcon.getPopupMenu()));
 112         } catch (final Exception ex) {
 113             ex.printStackTrace();
 114         }
 115     }
 116 
 117     private static Image createTrayIconImage() {
 118         // Create a small red circle image to use as the icon for tray icon.
 119         int trayIconImageSize = 32;
 120         final BufferedImage trayImage = new BufferedImage(trayIconImageSize,
 121                 trayIconImageSize, BufferedImage.TYPE_INT_ARGB);
 122         final Graphics2D trayImageGraphics
 123                 = (Graphics2D) trayImage.getGraphics();
 124 
 125         trayImageGraphics.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
 126                 RenderingHints.VALUE_ANTIALIAS_ON);
 127 
 128         trayImageGraphics.setColor(new Color(255, 255, 255, 0));
 129         trayImageGraphics.fillRect(0, 0, trayImage.getWidth(),
 130                 trayImage.getHeight());
 131 
 132         trayImageGraphics.setColor(Color.red);
 133 
 134         int trayIconImageInset = 4;
 135         trayImageGraphics.fillOval(trayIconImageInset,
 136                 trayIconImageInset,
 137                 trayImage.getWidth() - 2 * trayIconImageInset,
 138                 trayImage.getHeight() - 2 * trayIconImageInset);
 139 
 140         trayImageGraphics.setColor(Color.darkGray);
 141 
 142         trayImageGraphics.drawOval(trayIconImageInset,
 143                 trayIconImageInset,
 144                 trayImage.getWidth() - 2 * trayIconImageInset,
 145                 trayImage.getHeight() - 2 * trayIconImageInset);
 146 
 147         return trayImage;
 148     }
 149 
 150     private static PopupMenu createTrayIconPopupMenu() {
 151         popupMenuParentFrame = new Frame();
 152         popupMenuParentFrame.setVisible(true);
 153 
 154         final PopupMenu trayIconPopupMenu = new PopupMenu();
 155         final MenuItem popupMenuItem = new MenuItem("TEST!");
 156         trayIconPopupMenu.add(popupMenuItem);
 157 
 158         popupMenuParentFrame.add(trayIconPopupMenu);
 159         return trayIconPopupMenu;
 160     }
 161 }