0.6.0 changes from development (#50)

* Experimental java agent support

JavaFXLibrary can now be attached to process as java agent.

* Fix docker-compose up

Building the docker demo failed because of missing package versions for
the newer Ubuntu image. Base image of the demo is now fixed to bionic
tag since Ubuntu updates have broken the build earlier as well.
Related Launchpad ticket:
https://bugs.launchpad.net/ubuntu/+source/openjfx/+bug/1799946

* Updated documentation (java agent)

* Add possibility to configure different directory for log.html in Set Screenshotdir, fixes #17

* java agent documentation fix

* Set Classpath failure as warnings and add failIfNotFound argument

* Use asyncFx for helperfunctions methods, remove waitForFxEvents usage, failure printout improvements

* remove deprecated keywords and methods (enhancement #11)

Co-authored-by: Turo Soisenniemi <[email protected]>
Co-authored-by: Pasi Saikkonen <[email protected]>

Author: 3 people

AUTHORS.txt

@@ -8,4 +8,4 @@ Tatu Lahtela             Find All With Pseudo Class and Find Class keywords
 Sakari Hoisko            Dockerized linux env with X
 Juho Lehtonen            Optimized docker environment.
 Juho Saarinen            Package improvements, initial monocle support, screenshot bug fix
-
+Turo Soisenniemi         Initial java agent support

Dockerfile_build

@@ -14,8 +14,8 @@ RUN mvn package
 # ENTRYPOINT java -jar /code/target/javafxlibrary-*-SNAPSHOT-jar-with-dependencies.jar
 
 FROM ubuntu:16.04
-COPY --from=builder /code/target/javafxlibrary-*-jar-with-dependencies.jar /.
-COPY --from=builder /code/target/javafxlibrary-*-tests.jar /.
+COPY --from=builder /code/target/javafxlibrary-*-jar-with-dependencies.jar /
+COPY --from=builder /code/target/javafxlibrary-*-tests.jar /
 RUN echo "Built following jar files" && ls -latr /*.jar
 COPY entrypoint_build.sh /.
 RUN apt-get -qq update && apt-get dist-upgrade -y  && apt-get install -qq --no-install-recommends --allow-unauthenticated -y \

README.md

@@ -75,7 +75,7 @@ Executing _test.sh_ runs the acceptance suite twice: first using JavaFXLibrary a
 If you want the suite to run only once, you can define which type of library to use by including **local** or **remote** as an argument. For example command `test.sh remote` will execute the suite only in remote mode.
 
 ## Experimental: Headless support
-Library supports headless operation utilizing [Monocle](https://wiki.openjdk.java.net/display/OpenJFX/Monocle). The support for this is still at experimental level. 
+Library supports headless operation utilizing [Monocle](https://wiki.openjdk.java.net/display/OpenJFX/Monocle). The support for this is still at experimental level.
 
 ### Main issues with headless function
 * Scrolling doesn't work same way as with screen
@@ -97,4 +97,7 @@ Remote:
 ```
 *** Settings ***
 Library    Remote    http://127.0.0.1:8270    ${True}    WITH NAME    JavaFXLibrary
-```
+```
+
+## Experimental: Java agent support
+Library can be used as java agent. Launch application with `-javaagent:/path/to/javafxlibrary-<version>.jar`. Default port is 8270 and can be changed with adding `=<port>` to java agent command. Only remote library is supported. Using launch keyword is still required but instead of starting new application keyword initializes Stage for library.

docker/robot-javafx-demo/Dockerfile

@@ -1,4 +1,4 @@
-FROM dorowu/ubuntu-desktop-lxde-vnc
+FROM dorowu/ubuntu-desktop-lxde-vnc:bionic
 
 ENV DEBIAN_FRONTEND noninteractive
 

pom.xml

@@ -221,6 +221,9 @@
 							<addClasspath>true</addClasspath>
 							<mainClass>JavaFXLibrary</mainClass>
 						</manifest>
+						<manifestEntries>
+							<Premain-Class>JavaFXLibrary</Premain-Class>
+						</manifestEntries>
 					</archive>
 				</configuration>
 				<executions>

src/main/java/JavaFXLibrary.java

@@ -56,12 +56,12 @@ public class JavaFXLibrary extends AnnotationLibrary {
         add("javafxlibrary/keywords/Keywords/*.class");
         add("javafxlibrary/keywords/*.class");
         add("javafxlibrary/tests/*.class");
-	}};
+    }};
 
     public JavaFXLibrary() {
-    	this(false);
+        this(false);
     }
-    
+
     public JavaFXLibrary(boolean headless) {
         super(includePatterns);
         if (headless) {
@@ -71,9 +71,9 @@ public JavaFXLibrary(boolean headless) {
             System.setProperty("prism.text", "t2k");
             TestFxAdapter.isHeadless = true;
         } else {
-	        //v4.0.15-alpha sets default robot as glass, which breaks rolling
-	        //Forcing usage of awt robot as previous versions
-	        System.setProperty("testfx.robot", "awt");
+            // v4.0.15-alpha sets default robot as glass, which breaks rolling
+            // Forcing usage of awt robot as previous versions
+            System.setProperty("testfx.robot", "awt");
         }
     }
 
@@ -108,7 +108,6 @@ public Object runKeyword(String keywordName, List args, Map kwargs) {
             finalKwargs = kwargs;
         }
 
-
         AtomicReference<Object> retval = new AtomicReference<>();
         AtomicReference<RuntimeException> retExcep = new AtomicReference<>();
 
@@ -121,12 +120,12 @@ public Object runKeyword(String keywordName, List args, Map kwargs) {
                     retval.set(super.runKeyword(keywordName, finalArgs, finalKwargs));
                     return true;
 
-                } catch (JavaFXLibraryTimeoutException jfxte){
+                } catch (JavaFXLibraryTimeoutException jfxte) {
                     // timeout already expired, catch exception and jump out
                     retExcep.set(jfxte);
                     throw jfxte;
 
-                } catch (RuntimeException e){
+                } catch (RuntimeException e) {
                     // catch exception and continue trying
                     retExcep.set(e);
                     return false;
@@ -165,10 +164,11 @@ public Object runKeyword(String keywordName, List args) {
 
         List finalArgs;
         // JavalibCore changes arguments of Call Method keywords to Strings after this check, so they need to handle their own objectMapping
-        if (!(keywordName.equals("callObjectMethod") || keywordName.equals("callObjectMethodInFxApplicationThread")))
+        if (!(keywordName.equals("callObjectMethod") || keywordName.equals("callObjectMethodInFxApplicationThread"))) {
             finalArgs = HelperFunctions.useMappedObjects(args);
-        else
+        } else {
             finalArgs = args;
+        }
 
         AtomicReference<Object> retval = new AtomicReference<>();
         AtomicReference<RuntimeException> retExcep = new AtomicReference<>();
@@ -182,12 +182,12 @@ public Object runKeyword(String keywordName, List args) {
                     retval.set(super.runKeyword(keywordName, finalArgs));
                     return true;
 
-                } catch (JavaFXLibraryTimeoutException jfxte){
+                } catch (JavaFXLibraryTimeoutException jfxte) {
                     // timeout already expired, catch exception and jump out
                     retExcep.set(jfxte);
                     throw jfxte;
 
-                } catch (RuntimeException e){
+                } catch (RuntimeException e) {
                     // catch exception and continue trying
                     retExcep.set(e);
                     return false;
@@ -227,17 +227,16 @@ public String getKeywordDocumentation(String keywordName) {
                 return "IOException occurred while reading the documentation file!";
             }
         } else if (keywordName.equals("__init__")) {
-        	try {
+            try {
                 return FileUtils.readFileToString(new File("./src/main/java/libdoc-init-documentation.txt"), "utf-8");
             } catch (IOException e) {
                 e.printStackTrace();
                 return "IOException occurred while reading the init documentation file!";
             }
         } else {
-        	try {
+            try {
                 return super.getKeywordDocumentation(keywordName);
-            }
-            catch (Exception e) {
+            } catch (Exception e) {
                 return keywordName;
             }
         }
@@ -258,6 +257,27 @@ public static JavaFXLibrary getLibraryInstance() throws ScriptException {
     }
 
     public static void main(String[] args) throws Exception {
+        startServer(args);
+    }
+
+    public static void premain(String args) {
+        TestFxAdapter.isAgent = true;
+        Thread agentThread = new Thread(() -> {
+            try {
+                if (args == null) {
+                    startServer();
+                } else {
+                    startServer(args);
+                }
+            } catch (Exception e) {
+                e.printStackTrace();
+            }
+        });
+        agentThread.setDaemon(true);
+        agentThread.start();
+    }
+
+    public static void startServer(String... args) throws Exception {
         int port = 8270;
         InetAddress ipAddr = InetAddress.getLocalHost();
 
@@ -266,8 +286,7 @@ public static void main(String[] args) throws Exception {
             System.out.println("----------------------------= JavaFXLibrary =-----------------------------");
             if (args.length > 0) {
                 port = Integer.parseInt(args[0]);
-            }
-            else {
+            } else {
                 System.out.println("RemoteServer for JavaFXLibrary will be started at default port of: " + port + ".\n" +
                         "If you wish to use another port, restart the library and give port number\n" +
                         "as an argument.");
@@ -294,4 +313,3 @@ public static void main(String[] args) throws Exception {
         }
     }
 }
-

src/main/java/javafxlibrary/keywords/AdditionalKeywords/ApplicationLauncher.java

@@ -45,8 +45,8 @@ public class ApplicationLauncher extends TestFxAdapter {
             + "Example:\n"
             + "| Launch JavaFX Application | _javafxlibrary.testapps.MenuApp_ |\n"
             + "| Launch JavaFX Application | _TestApplication.jar_ |\n")
-    @ArgumentNames({"appName", "*args"})
-    public void launchJavafxApplication(String appName, String... appArgs)  {
+    @ArgumentNames({ "appName", "*args" })
+    public void launchJavafxApplication(String appName, String... appArgs) {
         try {
             RobotLog.info("Starting application:" + appName);
             createNewSession(appName, appArgs);
@@ -65,7 +65,7 @@ public void launchJavafxApplication(String appName, String... appArgs)  {
             + "Example:\n"
             + "| Launch Swing Application | _javafxlibrary.testapps.SwingApplication |\n"
             + "| Launch Swing Application | _TestApplication.jar_ |\n")
-    @ArgumentNames({"appName", "*args"})
+    @ArgumentNames({ "appName", "*args" })
     public void launchSwingApplication(String appName, String... appArgs) {
         RobotLog.info("Starting application:" + appName);
         Class c = getMainClass(appName);
@@ -84,7 +84,7 @@ public void launchSwingApplication(String appName, String... appArgs) {
             + "Example:\n"
             + "| Launch Swing Application In Separate Thread | _javafxlibrary.testapps.SwingApplication |\n"
             + "| Launch Swing Application In Separate Thread | _TestApplication.jar_ |\n")
-    @ArgumentNames({"appName", "*args"})
+    @ArgumentNames({ "appName", "*args" })
     public void launchSwingApplicationInSeparateThread(String appName, String... appArgs) {
         RobotLog.info("Starting application:" + appName);
         Class c = getMainClass(appName);
@@ -95,10 +95,11 @@ public void launchSwingApplicationInSeparateThread(String appName, String... app
 
     private Class getMainClass(String appName) {
         try {
-            if (appName.endsWith(".jar"))
+            if (appName.endsWith(".jar")) {
                 return getMainClassFromJarFile(appName);
-            else
+            } else {
                 return Class.forName(appName);
+            }
         } catch (ClassNotFoundException e) {
             throw new JavaFXLibraryNonFatalException("Unable to launch application: " + appName, e);
         }
@@ -112,41 +113,56 @@ private void _addPathToClassPath(String path) {
         try {
             Method method = URLClassLoader.class.getDeclaredMethod("addURL", URL.class);
             method.setAccessible(true);
-            method.invoke(classLoader, (new File(path)).toURI().toURL() );
+            method.invoke(classLoader, (new File(path)).toURI().toURL());
 
         } catch (Exception e) {
-            throw new JavaFXLibraryFatalException("Problem setting the classpath: " + path , e);
+            throw new JavaFXLibraryFatalException("Problem setting the classpath: " + path, e);
         }
     }
 
     @RobotKeyword("Loads given path to classpath.\n\n"
-        + "``path`` is the path to add.\n\n"
-        + "If directory path has asterisk(*) after directory separator all jar files are added from directory.\n"
-        + "\nExample:\n"
-        + "| Set To Classpath | C:${/}users${/}my${/}test${/}folder | \n"
-        + "| Set To Classpath | C:${/}users${/}my${/}test${/}folder${/}* | \n")
-    @ArgumentNames({"path"})
-    public void setToClasspath(String path)  {
+            + "``path`` is the path to add.\n\n"
+            + "``failIfNotFound`` is either True or False, default False. In case of False error is written as warning.\n\n"
+            + "If directory path has asterisk(*) after directory separator all jar files are added from directory.\n"
+            + "\nExample:\n"
+            + "| Set To Classpath | C:${/}users${/}my${/}test${/}folder | \n"
+            + "| Set To Classpath | C:${/}users${/}my${/}test${/}folder${/}* | \n"
+            + "| Set To Classpath | C:${/}users${/}my${/}test${/}folder2${/}* | failIfNotFound=${True} | \n")
+    @ArgumentNames({ "path", "failIfNotFound=False" })
+    public void setToClasspath(String path, boolean failIfNotFound) {
+        RobotLog.info("Setting \"" + path + "\" to classpath, failIfNotFound=\"" + failIfNotFound + "\"");
         if (path.endsWith("*")) {
-          path = path.substring(0, path.length() - 1);
-          RobotLog.info("Adding all jars from directory: " + path);
+            path = path.substring(0, path.length() - 1);
+            RobotLog.info("Adding all jars from directory.");
+            String fullPath = FileSystems.getDefault().getPath(path).normalize().toAbsolutePath().toString();
 
-          try {
-              File directory = new File(path);
-              File[] fileList = directory.listFiles();
-              boolean jarsFound = false;
-              for (File file : Objects.requireNonNull(fileList)) {
-                  if (file.getName().endsWith(".jar")) {
-                      jarsFound = true;
-                      _addPathToClassPath(file.getAbsolutePath());
-                  }
-              }
-              if(!jarsFound) throw new JavaFXLibraryNonFatalException("No jar files found from classpath: " + FileSystems.getDefault().getPath(path).normalize().toAbsolutePath().toString());
-          } catch (NullPointerException e) {
-              throw new JavaFXLibraryFatalException("Directory not found: " + path + "\n" + e.getMessage(), e);
-          }
-        }
-        else {
+            try {
+                File directory = new File(path);
+                File[] fileList = directory.listFiles();
+                boolean jarsFound = false;
+                for (File file : Objects.requireNonNull(fileList)) {
+                    if (file.getName().endsWith(".jar")) {
+                        jarsFound = true;
+                        _addPathToClassPath(file.getAbsolutePath());
+                    }
+                }
+                if (!jarsFound) {
+                    String jarsNotFoundError = "No jar files found from classpath: " + fullPath;
+                    if (failIfNotFound) {
+                        throw new JavaFXLibraryNonFatalException(jarsNotFoundError);
+                    } else {
+                        RobotLog.warn(jarsNotFoundError);
+                    }
+                }
+            } catch (NullPointerException e) {
+                String directoryNotFoundError = "Directory not found: " + fullPath;
+                if (failIfNotFound) {
+                    throw new JavaFXLibraryFatalException(directoryNotFoundError);
+                } else {
+                    RobotLog.warn(directoryNotFoundError);
+                }
+            }
+        } else {
             _addPathToClassPath(path);
         }
     }
@@ -157,8 +173,9 @@ public void logApplicationClasspath() {
             ClassLoader cl = ClassLoader.getSystemClassLoader();
             URL[] urls = ((URLClassLoader) cl).getURLs();
             RobotLog.info("Printing out classpaths: \n");
-            for (URL url : urls)
+            for (URL url : urls) {
                 RobotLog.info(url.getFile());
+            }
         } catch (Exception e) {
             throw new JavaFXLibraryNonFatalException("Unable to log application classpaths", e);
         }
@@ -237,7 +254,6 @@ public void clearObjectMap() {
         objectMap.clear();
     }
 
-
     @RobotKeyword("Returns the class name of currently active JavaFX Application")
     public String getCurrentApplication() {
         try {
@@ -247,15 +263,9 @@ public String getCurrentApplication() {
         }
     }
 
-    @Deprecated
-    @RobotKeyword("*DEPRECATED in version 0.6.0!* Use `Get Current Application` keyword instead.\n\n"
-            + "Returns the class name of currently active JavaFX Application\n")
-    public String currentApplication() {
-        try {
-            return getCurrentSessionApplicationName();
-        } catch (Exception e) {
-            throw new JavaFXLibraryNonFatalException("Problem getting current application name.", e);
-        }
+    @RobotKeyword("Returns if JavaFXLibrary is started as java agent.")
+    public boolean isJavaAgent() {
+        return TestFxAdapter.isAgent;
     }
 
 }