8319555: [TestBug] Utility for creating instruction window for manual tests

tests/manual/text/.classpath

@@ -10,11 +10,17 @@
 			<attribute name="module" value="true"/>
 		</attributes>
 	</classpathentry>
+	<classpathentry combineaccessrules="false" kind="src" path="/controls">
+		<attributes>
+			<attribute name="module" value="true"/>
+		</attributes>
+	</classpathentry>
 	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER">
 		<attributes>
 			<attribute name="module" value="true"/>
 		</attributes>
 	</classpathentry>
+	<classpathentry kind="src" path="/manualTests-util"/>
 	<classpathentry excluding=".classpath|.project|.settings" kind="src" output="bin" path=""/>
 	<classpathentry kind="output" path="bin"/>
 </classpath>

tests/manual/text/EmojiTest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2023, 2024, 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
@@ -23,64 +23,44 @@
  * questions.
  */
 
-import javafx.application.Application;
-import javafx.application.Platform;
-import javafx.scene.layout.HBox;
-import javafx.scene.layout.VBox;
-import javafx.scene.Group;
-import javafx.scene.Scene;
-import javafx.scene.control.Button;
+import javafx.scene.Node;
 import javafx.scene.control.Label;
 import javafx.scene.control.TextField;
-import javafx.stage.Stage;
+import javafx.scene.layout.VBox;
 import javafx.scene.text.Font;
 import javafx.scene.text.Text;
+import com.oracle.util.testing.ManualTestWindow;
 
-public class EmojiTest extends Application {
-
-   static String instructions =
-      """
-        This tests rendering of Emoji glyphs which is only supported on macOS.
-        On macOS you should see a yellow-coloured smiling face image,
-        embedded between 'ab' and 'cd'.
-        On other platforms it may be a missing glyph, or an empty space, or
-        a similar rendering as a greyscale/B&W glyph.
-        Principally, you are checking that the emoji is rendered on macOS in
-        each of the controls and nodes displayed in the test, and that the
-        editable text field handles selection of the emoji glyph with the
-        same background as other glyphs - this presumes the emoji image has
-        transparent background pixels.
-        There are 3 different ways it is displayed to verify
-        1) Text node. 2) Label control, 3) TextField Control
-        Press the Pass or Fail button as appropriate and the test will exit.
-        If what you see is not explained here, ask before filing a bug.
-
-
-        """;
-
+public class EmojiTest extends ManualTestWindow {
     public static void main(String[] args) {
         launch(args);
     }
 
-    private void quit() {
-        Platform.exit();
+    public EmojiTest() {
+        super(
+            "Emoji Rendering Test (macOS)",
+            """
+            This tests rendering of Emoji glyphs which is only supported on macOS.
+            On macOS you should see a yellow-coloured smiling face image,
+            embedded between 'ab' and 'cd'.
+            On other platforms it may be a missing glyph, or an empty space, or
+            a similar rendering as a greyscale/B&W glyph.
+            Principally, you are checking that the emoji is rendered on macOS in
+            each of the controls and nodes displayed in the test, and that the
+            editable text field handles selection of the emoji glyph with the
+            same background as other glyphs - this presumes the emoji image has
+            transparent background pixels.
+            There are 3 different ways it is displayed to verify
+            1) Text node. 2) Label control, 3) TextField Control
+            Press the Pass or Fail button as appropriate and the test will exit.
+            If what you see is not explained here, ask before filing a bug.
+            """,
+            1200, 800
+        );
     }
 
     @Override
-    public void start(Stage stage) {
-        Button passButton = new Button("Pass");
-        Button failButton = new Button("Fail");
-        passButton.setOnAction(e -> this.quit());
-        failButton.setOnAction(e -> {
-            this.quit();
-            throw new AssertionError("The Emoji was not rendered on macOS");
-        });
-
-        HBox hbox = new HBox(10, passButton, failButton);
-
-        Text instTA = new Text(instructions);
-        instTA.setWrappingWidth(500);
-
+    protected Node createContent() {
         Font font = new Font(32);
         String emojiString = "ab\ud83d\ude00cd";
         Text text = new Text(emojiString);
@@ -90,18 +70,11 @@ public void start(Stage stage) {
         TextField textField = new TextField(emojiString);
         textField.setFont(font);
 
-        VBox vbox = new VBox();
-        Scene scene = new Scene(vbox);
-        vbox.getChildren().add(instTA);
-        vbox.getChildren().add(hbox);
-        vbox.getChildren().add(text);
-        vbox.getChildren().add(label);
-        vbox.getChildren().add(textField);
-        stage.setWidth(600);
-        stage.setHeight(600);
-        stage.setScene(scene);
-
-        stage.show();
+        return new VBox(
+            2,
+            text,
+            label,
+            textField
+        );
     }
-
 }

tests/manual/util/.classpath

@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<classpath>
+	<classpathentry combineaccessrules="false" kind="src" path="/base">
+		<attributes>
+			<attribute name="module" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry combineaccessrules="false" kind="src" path="/controls">
+		<attributes>
+			<attribute name="module" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry combineaccessrules="false" kind="src" path="/graphics">
+		<attributes>
+			<attribute name="module" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry kind="con" path="org.eclipse.jdt.junit.JUNIT_CONTAINER/5">
+		<attributes>
+			<attribute name="test" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER">
+		<attributes>
+			<attribute name="module" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry kind="src" path="src"/>
+	<classpathentry kind="output" path="bin"/>
+</classpath>

tests/manual/util/.project

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+    <name>manualTests-util</name>
+    <comment></comment>
+    <projects>
+    </projects>
+    <buildSpec>
+        <buildCommand>
+            <name>org.eclipse.jdt.core.javabuilder</name>
+            <arguments>
+            </arguments>
+        </buildCommand>
+    </buildSpec>
+    <natures>
+        <nature>org.eclipse.jdt.core.javanature</nature>
+    </natures>
+</projectDescription>

tests/manual/util/.settings/org.eclipse.core.resources.prefs

@@ -0,0 +1,2 @@
+eclipse.preferences.version=1
+encoding/<project>=UTF-8

tests/manual/util/.settings/org.eclipse.jdt.core.prefs

@@ -0,0 +1,14 @@
+eclipse.preferences.version=1
+org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled
+org.eclipse.jdt.core.compiler.codegen.targetPlatform=17
+org.eclipse.jdt.core.compiler.codegen.unusedLocal=preserve
+org.eclipse.jdt.core.compiler.compliance=17
+org.eclipse.jdt.core.compiler.debug.lineNumber=generate
+org.eclipse.jdt.core.compiler.debug.localVariable=generate
+org.eclipse.jdt.core.compiler.debug.sourceFile=generate
+org.eclipse.jdt.core.compiler.problem.assertIdentifier=error
+org.eclipse.jdt.core.compiler.problem.enablePreviewFeatures=disabled
+org.eclipse.jdt.core.compiler.problem.enumIdentifier=error
+org.eclipse.jdt.core.compiler.problem.reportPreviewFeatures=warning
+org.eclipse.jdt.core.compiler.release=enabled
+org.eclipse.jdt.core.compiler.source=17

tests/manual/util/README.md

@@ -0,0 +1,38 @@
+# Test Utilities
+
+## ManualTestWindow
+
+This facility provides the base class for manual tests which displays the test instructions,
+the UI under test, and the Pass/Fail buttons.
+
+Example:
+
+```java
+public class ManualTestExample extends ManualTestWindow {
+    public ManualTestExample() {
+        super(
+            "Manual Test Example",
+            """
+            Instructions:
+            1. you will see a button named "Test"
+            2. press the button
+            3. verify that the button can be pressed""",
+            400, 250
+        );
+    }
+
+    public static void main(String[] args) throws Exception {
+        launch(args);
+    }
+
+    @Override
+    protected Node createContent() {
+        return new Button("Test");
+    }
+}
+```
+
+Resulting application window:
+
+![screenshot](doc/ManualTestWindow.png)
+