Add RobotLog class for logging messages to Robot Framework log files

New RobotLog class replaces the HelperFunctions.robotLog method.

Author: psaikkonen

src/main/java/JavaFXLibrary.java

@@ -25,6 +25,7 @@
 import javafxlibrary.exceptions.JavaFXLibraryNonFatalException;
 import javafxlibrary.keywords.AdditionalKeywords.RunOnFailure;
 import javafxlibrary.utils.HelperFunctions;
+import javafxlibrary.utils.RobotLog;
 import javafxlibrary.utils.TestListener;
 import org.apache.commons.io.FileUtils;
 import org.robotframework.javalib.annotation.Autowired;
@@ -73,13 +74,13 @@ public Object runKeyword(String keywordName, Object[] args) {
         } catch (RuntimeException e) {
             runOnFailure.runOnFailure();
             if (e.getCause() instanceof JavaFXLibraryFatalException) {
-                robotLog("DEBUG", "JavaFXLibrary: Caught JavaFXLibrary FATAL exception");
+                RobotLog.debug("JavaFXLibrary: Caught JavaFXLibrary FATAL exception");
                 throw e;
             } else if (e.getCause() instanceof JavaFXLibraryNonFatalException) {
-                robotLog("DEBUG", "JavaFXLibrary: Caught JavaFXLibrary NON-FATAL exception");
+                RobotLog.debug("JavaFXLibrary: Caught JavaFXLibrary NON-FATAL exception");
                 throw e;
             } else {
-                robotLog("DEBUG", "JavaFXLibrary: Caught JavaFXLibrary RUNTIME exception");
+                RobotLog.debug("JavaFXLibrary: Caught JavaFXLibrary RUNTIME exception");
                 throw e;
             }
         }

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

@@ -20,7 +20,7 @@
 import javafx.application.Application;
 import javafxlibrary.exceptions.JavaFXLibraryFatalException;
 import javafxlibrary.exceptions.JavaFXLibraryNonFatalException;
-import javafxlibrary.utils.HelperFunctions;
+import javafxlibrary.utils.RobotLog;
 import javafxlibrary.utils.TestFxAdapter;
 import org.robotframework.javalib.annotation.ArgumentNames;
 import org.robotframework.javalib.annotation.RobotKeyword;
@@ -33,7 +33,6 @@
 
 import static javafxlibrary.utils.HelperFunctions.createWrapperApplication;
 import static javafxlibrary.utils.HelperFunctions.getMainClassFromJarFile;
-import static javafxlibrary.utils.HelperFunctions.robotLog;
 
 @RobotKeywords
 public class ApplicationLauncher extends TestFxAdapter {
@@ -47,10 +46,9 @@ public class ApplicationLauncher extends TestFxAdapter {
     @ArgumentNames({"appName", "*args"})
     public void launchJavafxApplication(String appName, String... appArgs)  {
         try {
-            HelperFunctions.robotLog("INFO", "Starting application:" + appName);
+            RobotLog.info("Starting application:" + appName);
             createNewSession(appName, appArgs);
-            HelperFunctions.robotLog("INFO", "Application: " + appName + " started.");
-
+            RobotLog.info("Application: " + appName + " started.");
         } catch (Exception e) {
             throw new JavaFXLibraryNonFatalException("Unable to launch application: " + appName, e);
         }
@@ -67,7 +65,7 @@ public void launchJavafxApplication(String appName, String... appArgs)  {
             + "| Launch Swing Application | _TestApplication.jar_ |\n")
     @ArgumentNames({"appName", "*args"})
     public void launchSwingApplication(String appName, String... appArgs) {
-        HelperFunctions.robotLog("INFO", "Starting application:" + appName);
+        RobotLog.info("Starting application:" + appName);
         Class c;
 
         try {
@@ -82,15 +80,15 @@ public void launchSwingApplication(String appName, String... appArgs) {
 
         Application app = createWrapperApplication(c, appArgs);
         createNewSession(app);
-        HelperFunctions.robotLog("INFO", "Application: " + appName + " started.");
+        RobotLog.info("Application: " + appName + " started.");
     }
 
     private void _addPathToClassPath(String path) {
         URLClassLoader classLoader = (URLClassLoader) ClassLoader.getSystemClassLoader();
 
-        HelperFunctions.robotLog("INFO", "Setting following path to Classpath: " + path );
+        RobotLog.info("Setting following path to Classpath: " + path);
 
-        try{
+        try {
             Method method = URLClassLoader.class.getDeclaredMethod("addURL", URL.class);
             method.setAccessible(true);
             method.invoke(classLoader, (new File(path)).toURI().toURL() );
@@ -110,10 +108,12 @@ private void _addPathToClassPath(String path) {
     public void setToClasspath(String path)  {
         if (path.endsWith("*")) {
           path = path.substring(0, path.length() - 1);
-          HelperFunctions.robotLog("INFO", "Adding all jars from directory: " + path );
+          RobotLog.info("Adding all jars from directory: " + path);
+
           try {
               File directory = new File(path);
               File[] fileList = directory.listFiles();
+
               for (File file : fileList) {
                   if (file.getName().endsWith(".jar"))
                       _addPathToClassPath(file.getAbsolutePath());
@@ -132,10 +132,9 @@ public void logApplicationClasspath() {
         try {
             ClassLoader cl = ClassLoader.getSystemClassLoader();
             URL[] urls = ((URLClassLoader) cl).getURLs();
-            HelperFunctions.robotLog("INFO", "Printing out classpaths: \n");
-            for (URL url : urls) {
-                HelperFunctions.robotLog("INFO", url.getFile());
-            }
+            RobotLog.info("Printing out classpaths: \n");
+            for (URL url : urls)
+                RobotLog.info(url.getFile());
         } catch (Exception e) {
             throw new JavaFXLibraryNonFatalException("Unable to log application classpaths", e);
         }
@@ -174,7 +173,7 @@ public void logSystemProperties() {
             while (keys.hasMoreElements()) {
                 String key = (String) keys.nextElement();
                 String value = (String) p.get(key);
-                HelperFunctions.robotLog("INFO", key + "=" + value);
+                RobotLog.info(key + "=" + value);
             }
         } catch (Exception e) {
             throw new JavaFXLibraryNonFatalException("Unable to log system properties", e);
@@ -187,9 +186,9 @@ public void logSystemProperties() {
     public void closeJavafxApplication() {
 
         try {
-            HelperFunctions.robotLog("INFO", "Closing application...");
+            RobotLog.info("Closing application...");
             deleteSession();
-            HelperFunctions.robotLog("INFO", "Application closed.");
+            RobotLog.info("Application closed.");
         } catch (Exception e) {
             throw new JavaFXLibraryNonFatalException("Unable to close Java FX application.", e);
         }
@@ -200,17 +199,17 @@ public void closeJavafxApplication() {
             + "| Close Swing Application | \n")
     public void closeSwingApplication() {
         try {
-            HelperFunctions.robotLog("INFO", "Closing application...");
+            RobotLog.info("Closing application...");
             deleteSwingSession();
-            HelperFunctions.robotLog("INFO", "Application closed.");
+            RobotLog.info("Application closed.");
         } catch (Exception e) {
             throw new JavaFXLibraryNonFatalException("Unable to close JavaFXLibrary Swing Wrapper application.", e);
         }
     }
 
     @RobotKeyword("Clears internal book keeping of all java objects.")
     public void clearObjectMap() {
-        robotLog("INFO", "Clearing " + objectMap.size() + " objects from objectMap.");
+        RobotLog.info("Clearing " + objectMap.size() + " objects from objectMap.");
         objectMap.clear();
     }