Use kotlinx-coroutines for UI launcher

gradle.properties

@@ -113,6 +113,7 @@ jsoup.version=1.14.3
 jtidy.version=r938
 junit4.version=4.13.2
 junit5.version=5.8.2
+kotlinx-coroutines.version=1.6.1
 lets-plot-batik.version=2.2.1
 lets-plot-kotlin-jvm.version=3.1.1
 log4j.version=2.17.2

src/bom/build.gradle.kts

@@ -45,6 +45,7 @@ javaPlatform {
 
 dependencies {
     api(platform("org.codehaus.groovy:groovy-bom:${"groovy".v}"))
+    api(platform("org.jetbrains.kotlinx:kotlinx-coroutines-bom:${"kotlinx-coroutines".v}"))
 
     // Parenthesis are needed here: https://github.com/gradle/gradle/issues/9248
     (constraints) {

src/core/build.gradle.kts

@@ -68,6 +68,8 @@ dependencies {
         }
     }
 
+    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core")
+    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-swing")
     implementation("com.fasterxml.jackson.core:jackson-annotations")
     implementation("com.fasterxml.jackson.core:jackson-core")
     implementation("com.fasterxml.jackson.core:jackson-databind")

src/core/src/main/java/org/apache/jmeter/JMeter.java

@@ -17,14 +17,12 @@
 
 package org.apache.jmeter;
 
-import java.awt.event.ActionEvent;
 import java.io.File;
 import java.io.FileInputStream;
 import java.io.FileNotFoundException;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.Reader;
-import java.lang.reflect.InvocationTargetException;
 import java.net.Authenticator;
 import java.net.DatagramPacket;
 import java.net.DatagramSocket;
@@ -56,9 +54,6 @@
 import javax.script.ScriptEngineFactory;
 import javax.script.ScriptEngineManager;
 import javax.script.ScriptException;
-import javax.swing.JTree;
-import javax.swing.SwingUtilities;
-import javax.swing.tree.TreePath;
 
 import org.apache.commons.cli.avalon.CLArgsParser;
 import org.apache.commons.cli.avalon.CLOption;
@@ -75,17 +70,9 @@
 import org.apache.jmeter.engine.StandardJMeterEngine;
 import org.apache.jmeter.engine.TreeCloner;
 import org.apache.jmeter.exceptions.IllegalUserActionException;
-import org.apache.jmeter.gui.GuiPackage;
-import org.apache.jmeter.gui.MainFrame;
-import org.apache.jmeter.gui.action.ActionNames;
-import org.apache.jmeter.gui.action.ActionRouter;
-import org.apache.jmeter.gui.action.Load;
 import org.apache.jmeter.gui.action.LoadRecentProject;
-import org.apache.jmeter.gui.action.LookAndFeelCommand;
-import org.apache.jmeter.gui.tree.JMeterTreeListener;
 import org.apache.jmeter.gui.tree.JMeterTreeModel;
 import org.apache.jmeter.gui.tree.JMeterTreeNode;
-import org.apache.jmeter.gui.util.FocusRequester;
 import org.apache.jmeter.plugin.JMeterPlugin;
 import org.apache.jmeter.plugin.PluginManager;
 import org.apache.jmeter.report.config.ConfigurationException;
@@ -107,9 +94,6 @@
 import org.apache.jmeter.util.ShutdownClient;
 import org.apache.jorphan.collections.HashTree;
 import org.apache.jorphan.collections.SearchByClass;
-import org.apache.jorphan.gui.ComponentUtil;
-import org.apache.jorphan.gui.JMeterUIDefaults;
-import org.apache.jorphan.gui.ui.KerningOptimizer;
 import org.apache.jorphan.reflect.ClassTools;
 import org.apache.jorphan.util.HeapDumper;
 import org.apache.jorphan.util.JMeterException;
@@ -120,8 +104,6 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import com.thoughtworks.xstream.converters.ConversionException;
-
 /**
  * Main JMeter class; processes options and starts the GUI, non-GUI or server as appropriate.
  */
@@ -366,111 +348,6 @@ public JMeter() {
     }
 
 
-    /**
-     * Starts up JMeter in GUI mode
-     */
-    private void startGui(String testFile) {
-        System.out.println("================================================================================");//NOSONAR
-        System.out.println("Don't use GUI mode for load testing !, only for Test creation and Test debugging.");//NOSONAR
-        System.out.println("For load testing, use CLI Mode (was NON GUI):");//NOSONAR
-        System.out.println("   jmeter -n -t [jmx file] -l [results file] -e -o [Path to web report folder]");//NOSONAR
-        System.out.println("& increase Java Heap to meet your test requirements:");//NOSONAR
-        System.out.println("   Modify current env variable HEAP=\"-Xms1g -Xmx1g -XX:MaxMetaspaceSize=256m\" in the jmeter batch file");//NOSONAR
-        System.out.println("Check : https://jmeter.apache.org/usermanual/best-practices.html");//NOSONAR
-        System.out.println("================================================================================");//NOSONAR
-        invokeAndWait("LaF", JMeter::setupLaF);
-
-        // SplashScreen is created after LaF activation, otherwise it would cause splash flicker.
-        // bug 66044 split showing splash screen from the other parts to have content in the window
-        SplashScreen splash = new SplashScreen();
-        splash.showScreen();
-        splash.setProgress(10);
-        invokeAndWait("HiDPI settings", JMeterUtils::applyHiDPIOnFonts);
-        splash.setProgress(20);
-        invokeAndWait("main part", () -> startGuiPartTwo(testFile, splash));
-    }
-
-    private static void invokeAndWait(String part, Runnable doRun) {
-        try {
-            log.debug("Setting up {}", part);
-            SwingUtilities.invokeAndWait(doRun);
-        } catch (InterruptedException e) {
-            log.warn("Interrupted while setting up {}", part, e);
-        } catch (InvocationTargetException e) {
-            log.warn("Problem while setting up {}", part, e);
-        }
-    }
-
-    private static void setupLaF() {
-        KerningOptimizer.INSTANCE.setMaxTextLengthWithKerning(
-                JMeterUtils.getPropDefault("text.kerning.max_document_size", 10000)
-        );
-        JMeterUIDefaults.INSTANCE.install();
-
-        String jMeterLaf = LookAndFeelCommand.getPreferredLafCommand();
-        try {
-            log.info("Setting LAF to: {}", jMeterLaf);
-            LookAndFeelCommand.activateLookAndFeel(jMeterLaf);
-        } catch (IllegalArgumentException ex) {
-            log.warn("Could not set LAF to: {}", jMeterLaf, ex);
-        }
-    }
-
-    private void startGuiPartTwo(String testFile, SplashScreen splash) {
-        log.debug("Configure PluginManager");
-        PluginManager.install(this, true);
-        splash.setProgress(30);
-        log.debug("Setup tree");
-        JMeterTreeModel treeModel = new JMeterTreeModel();
-        JMeterTreeListener treeLis = new JMeterTreeListener(treeModel);
-        final ActionRouter instance = ActionRouter.getInstance();
-        splash.setProgress(40);
-        log.debug("populate command map");
-        instance.populateCommandMap();
-        splash.setProgress(60);
-        treeLis.setActionHandler(instance);
-        log.debug("init instance");
-        splash.setProgress(70);
-        GuiPackage.initInstance(treeLis, treeModel);
-        splash.setProgress(80);
-        log.debug("constructing main frame");
-        MainFrame main = new MainFrame(treeModel, treeLis);
-        splash.setProgress(100);
-        ComponentUtil.centerComponentInWindow(main, 80);
-        main.setLocationRelativeTo(splash);
-        main.setVisible(true);
-        main.toFront();
-        instance.actionPerformed(new ActionEvent(main, 1, ActionNames.ADD_ALL));
-        if (testFile != null) {
-            try {
-                File f = new File(testFile);
-                log.info("Loading file: {}", f);
-                FileServer.getFileServer().setBaseForScript(f);
-
-                HashTree tree = SaveService.loadTree(f);
-
-                GuiPackage.getInstance().setTestPlanFile(f.getAbsolutePath());
-
-                Load.insertLoadedTree(1, tree);
-            } catch (ConversionException e) {
-                log.error("Failure loading test file", e);
-                splash.close();
-                JMeterUtils.reportErrorToUser(SaveService.CEtoString(e));
-            } catch (Exception e) {
-                log.error("Failure loading test file", e);
-                splash.close();
-                JMeterUtils.reportErrorToUser(e.toString());
-            }
-        } else {
-            JTree jTree = GuiPackage.getInstance().getMainFrame().getTree();
-            TreePath path = jTree.getPathForRow(0);
-            jTree.setSelectionPath(path);
-            FocusRequester.requestFocus(jTree);
-        }
-        splash.setProgress(100);
-        splash.close();
-    }
-
     /**
      * Takes the command line arguments and uses them to determine how to
      * startup JMeter.
@@ -584,8 +461,9 @@ public void start(String[] args) {
                     ReportGenerator generator = new ReportGenerator(reportFile, null);
                     generator.generate();
                 } else if (parser.getArgumentById(NONGUI_OPT) == null) { // not non-GUI => GUI
+                    PluginManager.install(this, true);
                     String initialTestFile = testFile;
-                    startGui(initialTestFile);
+                    JMeterGuiLauncher.startGui(initialTestFile);
                     startOptionalServers();
                 } else { // NON-GUI must be true
                     extractAndSetReportOutputFolder(parser, deleteResultFile);

src/core/src/main/java/org/apache/jmeter/JMeterGuiLauncher.kt

@@ -0,0 +1,154 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to you under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.jmeter
+
+import com.thoughtworks.xstream.converters.ConversionException
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.launch
+import kotlinx.coroutines.runBlocking
+import kotlinx.coroutines.swing.Swing
+import kotlinx.coroutines.withContext
+import kotlinx.coroutines.yield
+import org.apache.jmeter.gui.GuiPackage
+import org.apache.jmeter.gui.MainFrame
+import org.apache.jmeter.gui.action.ActionNames
+import org.apache.jmeter.gui.action.ActionRouter
+import org.apache.jmeter.gui.action.Load
+import org.apache.jmeter.gui.action.LookAndFeelCommand
+import org.apache.jmeter.gui.tree.JMeterTreeListener
+import org.apache.jmeter.gui.tree.JMeterTreeModel
+import org.apache.jmeter.gui.util.FocusRequester
+import org.apache.jmeter.save.SaveService
+import org.apache.jmeter.services.FileServer
+import org.apache.jmeter.util.JMeterUtils
+import org.apache.jorphan.collections.HashTree
+import org.apache.jorphan.gui.ComponentUtil
+import org.apache.jorphan.gui.JMeterUIDefaults
+import org.apache.jorphan.gui.ui.KerningOptimizer
+import org.slf4j.LoggerFactory
+import java.awt.event.ActionEvent
+import java.io.File
+
+public object JMeterGuiLauncher {
+    private val log = LoggerFactory.getLogger(JMeterGuiLauncher::class.java)
+
+    /**
+     * Starts up JMeter in GUI mode
+     */
+    @JvmStatic
+    public fun startGui(testFile: String?) {
+        println("================================================================================") // NOSONAR
+        println("Don't use GUI mode for load testing !, only for Test creation and Test debugging.") // NOSONAR
+        println("For load testing, use CLI Mode (was NON GUI):") // NOSONAR
+        println("   jmeter -n -t [jmx file] -l [results file] -e -o [Path to web report folder]") // NOSONAR
+        println("& increase Java Heap to meet your test requirements:") // NOSONAR
+        println("   Modify current env variable HEAP=\"-Xms1g -Xmx1g -XX:MaxMetaspaceSize=256m\" in the jmeter batch file") // NOSONAR
+        println("Check : https://jmeter.apache.org/usermanual/best-practices.html") // NOSONAR
+        println("================================================================================") // NOSONAR
+
+        runBlocking {
+            // See https://github.com/Kotlin/kotlinx.coroutines/blob/master/ui/coroutines-guide-ui.md
+            launch(Dispatchers.Swing) {
+                startGuiInternal(testFile)
+            }
+        }
+    }
+
+    private fun setupLaF() {
+        KerningOptimizer.INSTANCE.maxTextLengthWithKerning =
+            JMeterUtils.getPropDefault("text.kerning.max_document_size", 10000)
+        JMeterUIDefaults.INSTANCE.install()
+        val jMeterLaf = LookAndFeelCommand.getPreferredLafCommand()
+        try {
+            log.info("Setting LAF to: {}", jMeterLaf)
+            LookAndFeelCommand.activateLookAndFeel(jMeterLaf)
+        } catch (ex: IllegalArgumentException) {
+            log.warn("Could not set LAF to: {}", jMeterLaf, ex)
+        }
+    }
+
+    private suspend fun startGuiInternal(testFile: String?) {
+        setupLaF()
+        val splash = SplashScreen()
+        suspend fun setProgress(progress: Int) {
+            splash.setProgress(progress)
+            // Allow UI updates
+            yield()
+        }
+        splash.showScreen()
+        setProgress(10)
+        JMeterUtils.applyHiDPIOnFonts()
+        setProgress(20)
+        log.debug("Configure PluginManager")
+        setProgress(30)
+        log.debug("Setup tree")
+        val treeModel = JMeterTreeModel()
+        val treeLis = JMeterTreeListener(treeModel)
+        val instance = ActionRouter.getInstance()
+        setProgress(40)
+        withContext(Dispatchers.Default) {
+            log.debug("populate command map")
+            instance.populateCommandMap()
+        }
+        setProgress(60)
+        treeLis.setActionHandler(instance)
+        log.debug("init instance")
+        setProgress(70)
+        GuiPackage.initInstance(treeLis, treeModel)
+        setProgress(80)
+        log.debug("constructing main frame")
+        val main = MainFrame(treeModel, treeLis)
+        setProgress(90)
+        ComponentUtil.centerComponentInWindow(main, 80)
+        main.setLocationRelativeTo(splash)
+        main.isVisible = true
+        main.toFront()
+        instance.actionPerformed(ActionEvent(main, 1, ActionNames.ADD_ALL))
+        if (testFile != null) {
+            loadFile(testFile)
+        } else {
+            val jTree = GuiPackage.getInstance().mainFrame.tree
+            val path = jTree.getPathForRow(0)
+            jTree.selectionPath = path
+            FocusRequester.requestFocus(jTree)
+        }
+        setProgress(100)
+        splash.close()
+    }
+
+    private suspend fun loadFile(testFile: String) {
+        try {
+            val f: File
+            val tree: HashTree?
+            withContext(Dispatchers.Default) {
+                f = File(testFile)
+                log.info("Loading file: {}", f)
+                FileServer.getFileServer().setBaseForScript(f)
+                tree = SaveService.loadTree(f)
+            }
+            GuiPackage.getInstance().testPlanFile = f.absolutePath
+            Load.insertLoadedTree(1, tree)
+        } catch (e: ConversionException) {
+            log.error("Failure loading test file", e)
+            JMeterUtils.reportErrorToUser(SaveService.CEtoString(e))
+        } catch (e: Exception) {
+            log.error("Failure loading test file", e)
+            JMeterUtils.reportErrorToUser(e.toString())
+        }
+    }
+}

src/dist/src/dist/expected_release_jars.csv

@@ -91,6 +91,8 @@
 200631,kotlin-stdlib-common-1.6.21.jar
 23898,kotlin-stdlib-jdk7-1.6.21.jar
 17772,kotlin-stdlib-jdk8-1.6.21.jar
+1492143,kotlinx-coroutines-core-jvm-1.6.1.jar
+10026,kotlinx-coroutines-swing-1.6.1.jar
 792176,kotlinx-html-jvm-0.7.3.jar
 181223,lets-plot-batik-2.2.1.jar
 4025480,lets-plot-common-2.2.1.jar