8244531: Tests: add support to identify recurring issues with control…

…s et al

Reviewed-by: aghaisas

modules/javafx.controls/src/shims/java/javafx/scene/control/skin/ControlSkinShim.java

@@ -0,0 +1,55 @@
+/*
+ * Copyright (c) 2020, 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
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package javafx.scene.control.skin;
+
+import java.lang.reflect.Field;
+
+import com.sun.javafx.scene.control.behavior.BehaviorBase;
+
+import javafx.scene.control.Skin;
+
+public class ControlSkinShim {
+
+    /**
+     * Reflectively accesses and returns the value of the skin's behavior field.
+     *
+     * @param skin the skin to get the behavior from
+     * @return the value of the skin's behavior field
+     * @throws RuntimeException wrapped around the exception thrown by the reflective access
+     */
+    public static BehaviorBase<?> getBehavior(Skin<?> skin) {
+        try {
+            Field field = skin.getClass().getDeclaredField("behavior");
+            field.setAccessible(true);
+            return (BehaviorBase<?>) field.get(skin);
+        } catch (NoSuchFieldException | SecurityException | IllegalArgumentException | IllegalAccessException e) {
+            throw new RuntimeException("failed access to behavior in " + skin.getClass(), e);
+        }
+    }
+
+
+    private ControlSkinShim() {}
+}

modules/javafx.controls/src/test/java/test/com/sun/javafx/scene/control/behavior/BehaviorMemoryLeakTest.java

@@ -0,0 +1,157 @@
+/*
+ * Copyright (c) 2020, 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
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package test.com.sun.javafx.scene.control.behavior;
+
+import java.lang.ref.WeakReference;
+import java.util.Collection;
+import java.util.List;
+import java.util.stream.Collectors;
+
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.junit.runners.Parameterized;
+
+import com.sun.javafx.scene.control.behavior.BehaviorBase;
+
+import static org.junit.Assert.*;
+import static test.com.sun.javafx.scene.control.infrastructure.ControlSkinFactory.*;
+
+import javafx.scene.control.Button;
+import javafx.scene.control.CheckBox;
+import javafx.scene.control.ColorPicker;
+import javafx.scene.control.ComboBox;
+import javafx.scene.control.Control;
+import javafx.scene.control.DatePicker;
+import javafx.scene.control.Hyperlink;
+import javafx.scene.control.ListView;
+import javafx.scene.control.MenuButton;
+import javafx.scene.control.PasswordField;
+import javafx.scene.control.RadioButton;
+import javafx.scene.control.SplitMenuButton;
+import javafx.scene.control.TableView;
+import javafx.scene.control.TextArea;
+import javafx.scene.control.TextField;
+import javafx.scene.control.ToggleButton;
+import javafx.scene.control.TreeTableView;
+import javafx.scene.control.TreeView;
+import test.com.sun.javafx.scene.control.infrastructure.ControlSkinFactory;
+
+/**
+ * Test for memory leaks in Behavior implementations.
+ * <p>
+ * This test is parameterized on control type.
+ */
+@RunWith(Parameterized.class)
+public class BehaviorMemoryLeakTest {
+
+    private Control control;
+
+    /**
+     * Create behavior -> dispose behavior -> gc
+     */
+    @Test
+    public void testMemoryLeakDisposeBehavior() {
+        WeakReference<BehaviorBase<?>> weakRef = new WeakReference<>(createBehavior(control));
+        assertNotNull(weakRef.get());
+        weakRef.get().dispose();
+        attemptGC(weakRef);
+        assertNull("behavior must be gc'ed", weakRef.get());
+    }
+
+    //---------------- parameterized
+
+    // Note: name property not supported before junit 4.11
+    @Parameterized.Parameters //(name = "{index}: {0} ")
+    public static Collection<Object[]> data() {
+        List<Class<Control>> controlClasses = getControlClassesWithBehavior();
+        // FIXME as part of JDK-8241364
+        // The behaviors of these controls are leaking
+        // step 1: file issues (where not yet done), add informal ignore to entry
+        // step 2: fix and remove from list
+        List<Class<? extends Control>> leakingClasses = List.of(
+                // @Ignore("8245282")
+                Button.class,
+                // @Ignore("8245282")
+                CheckBox.class,
+                // @Ignore("8245282")
+                ColorPicker.class,
+                // @Ignore("8245282")
+                ComboBox.class,
+                // @Ignore("8245282")
+                DatePicker.class,
+                // @Ignore("8245282")
+                Hyperlink.class,
+                ListView.class,
+                // @Ignore("8245282")
+                MenuButton.class,
+                PasswordField.class,
+                // @Ignore("8245282")
+                RadioButton.class,
+                // @Ignore("8245282")
+                SplitMenuButton.class,
+                TableView.class,
+                TextArea.class,
+                TextField.class,
+                // @Ignore("8245282")
+                ToggleButton.class,
+                TreeTableView.class,
+                TreeView.class
+         );
+        // remove the known issues to make the test pass
+        controlClasses.removeAll(leakingClasses);
+        // instantiate controls
+        List<Control> controls = controlClasses.stream()
+                .map(ControlSkinFactory::createControl)
+                .collect(Collectors.toList());
+        return asArrays(controls);
+    }
+
+    public BehaviorMemoryLeakTest(Control control) {
+        this.control = control;
+    }
+
+//------------------- setup
+
+    @After
+    public void cleanup() {
+        Thread.currentThread().setUncaughtExceptionHandler(null);
+    }
+
+    @Before
+    public void setup() {
+        Thread.currentThread().setUncaughtExceptionHandler((thread, throwable) -> {
+            if (throwable instanceof RuntimeException) {
+                throw (RuntimeException)throwable;
+            } else {
+                Thread.currentThread().getThreadGroup().uncaughtException(thread, throwable);
+            }
+        });
+        assertNotNull(control);
+    }
+
+}