refactored image logging

haavistoj · haavistoj · commit dc9ca79180b1 · 2018-10-12T08:41:19.000+03:00
diff --git a/src/main/java/javafxlibrary/keywords/AdditionalKeywords/RunOnFailure.java b/src/main/java/javafxlibrary/keywords/AdditionalKeywords/RunOnFailure.java
@@ -55,18 +55,15 @@ public void runOnFailure() {
 
         runningOnFailureRoutine = true;
 
+        RobotLog.info("JavaFXLibrary keyword has failed!");
         if (robot == null) {
             RobotLog.error("FxRobot not initialized, launch test application with the library");
-        } else if (TestFxAdapter.logImages) {
-            RobotLog.info("JavaFxLibrary keyword has failed! Below a screenshot from erroneous situation:");
-            if (robot.targetWindow() != null) {
-                new ScreenCapturing().captureImage(robot.targetWindow());
-            } else
-                new ScreenCapturing().captureImage(Screen.getPrimary().getBounds());
+        }
+
+        if (robot.targetWindow() != null) {
+            new ScreenCapturing().captureImage(robot.targetWindow());
         } else {
-            RobotLog.info("JavaFXLibrary keyword has failed!");
-            RobotLog.info("Not taking a screenshot since Set Image Logging is set to off. To enable screenshots " +
-                    "on failed keywords, use keyword 'Set Image Logging    ON'");
+            new ScreenCapturing().captureImage(Screen.getPrimary().getBounds());
         }
 
         runningOnFailureRoutine = false;
diff --git a/src/main/java/javafxlibrary/keywords/Keywords/ScreenCapturing.java b/src/main/java/javafxlibrary/keywords/Keywords/ScreenCapturing.java
@@ -44,24 +44,24 @@
 @RobotKeywords
 public class ScreenCapturing extends TestFxAdapter {
 
-    @RobotKeyword("Sets whether to log images into the log.html file or not.\n\n"
-            + "Argument ``value`` is a string. Accepted values are \"on\" and \"off\". They can be given in uppercase as well. \n\n"
+    @RobotKeyword("Sets whether to embed log images directly into the log.html file or as a link to a file on local disk.\n\n"
+            + "Argument ``value`` is a string. Accepted values are ``embedded`` (initial value) and ``diskonly``. They can be given in uppercase as well. \n\n"
             + "\nExample:\n"
-            + "| Set Image Logging | OFF |\n")
+            + "| Set Image Logging | DISKONLY |\n")
     @ArgumentNames({ "value" })
     public void setImageLogging(String value) {
-        if (value.toLowerCase().equals("on"))
-            TestFxAdapter.logImages = true;
-        else if (value.toLowerCase().equals("off"))
-            TestFxAdapter.logImages = false;
+        if (value.toLowerCase().equals("embedded"))
+            TestFxAdapter.logImages = "embedded";
+        else if (value.toLowerCase().equals("diskonly"))
+            TestFxAdapter.logImages = "diskonly";
         else
             throw new JavaFXLibraryNonFatalException("Value \"" + value + "\" is not supported! Value must be either " +
-                    "\"ON\" or \"OFF\"");
+                    "\"EMBEDDED\" or \"DISKONLY\"");
     }
 
     @RobotKeywordOverload
     public Object captureImage(Object locator){
-        return captureImage(locator, TestFxAdapter.logImages);
+            return captureImage(locator, true);
     }
 
     @RobotKeyword("Returns a screenshot of the given locator.\n\n"
@@ -89,17 +89,24 @@ public Object captureImage(Object locator, boolean logImage){
             robotContext.getCaptureSupport().saveImage(image, path);
 
             if (logImage) {
-                Image resizedImage = resizeImage(image, path);
-                Path tempPath = Paths.get(getCurrentSessionScreenshotDirectory(), "temp.png");
-                robotContext.getCaptureSupport().saveImage(resizedImage, tempPath);
+                Double printSize = targetBounds.getWidth() > 800 ? 800 : targetBounds.getWidth();
 
-                File imageFile = convertToJpeg(tempPath);
-                byte[] imageBytes = IOUtils.toByteArray(new FileInputStream(imageFile));
-                String encodedImage = Base64.getEncoder().encodeToString(imageBytes);
-                imageFile.delete();
+                if(TestFxAdapter.logImages.toLowerCase().equals("embedded")) {
+                    Image resizedImage = resizeImage(image, path);
+                    Path tempPath = Paths.get(getCurrentSessionScreenshotDirectory(), "temp.png");
+                    robotContext.getCaptureSupport().saveImage(resizedImage, tempPath);
 
-                Double printSize = targetBounds.getWidth() > 800 ? 800 : targetBounds.getWidth();
-                System.out.println("*HTML* <img src=\"data:image/png;base64," + encodedImage + "\" width=\"" + printSize + "px\">");
+                    File imageFile = convertToJpeg(tempPath);
+                    byte[] imageBytes = IOUtils.toByteArray(new FileInputStream(imageFile));
+                    String encodedImage = Base64.getEncoder().encodeToString(imageBytes);
+                    imageFile.delete();
+
+                    RobotLog.html("<img src=\"data:image/png;base64," + encodedImage + "\" width=\"" + printSize + "px\">");
+
+                } else {
+                    // diskonly option
+                    RobotLog.html("<img src=\"" + path + "\" width=\"" + printSize + "px\">");
+                }
             }
             return mapObject(image);
 
@@ -181,7 +188,7 @@ private static Image resizeImage(Image image, Path path) {
         if (width < 800)
             return image;
 
-        RobotLog.info("Full resolution image can be found at " + path);
+        RobotLog.html("Full resolution image can be found from <a href=" + path + " >" + path + "</a>.");
         double multiplier = width / 800;
         try {
             String url = path.toUri().toURL().toString();
diff --git a/src/main/java/javafxlibrary/utils/RobotLog.java b/src/main/java/javafxlibrary/utils/RobotLog.java
@@ -22,6 +22,11 @@ public static void info(String message) {
             System.out.println("*INFO* " + message);
     }
 
+    public static void html(String message) {
+        if (shouldLogMessage(message))
+            System.out.println("*HTML* " + message);
+    }
+
     public static void debug(String message) {
         if (shouldLogMessage(message))
             System.out.println("*DEBUG* " + message);
diff --git a/src/main/java/javafxlibrary/utils/TestFxAdapter.java b/src/main/java/javafxlibrary/utils/TestFxAdapter.java
@@ -44,7 +44,7 @@ public static void setRobotContext(FxRobotContext context) {
     // TODO: consider adding support for multiple sessions
     private static Session activeSession = null;
 
-    protected static boolean logImages = true;
+    protected static String logImages = "embedded";
 
     // internal book keeping for objects
     public static HashMap objectMap = new HashMap();
diff --git a/src/test/robotframework/acceptance/0_ClickRobotTest.robot b/src/test/robotframework/acceptance/0_ClickRobotTest.robot
@@ -266,7 +266,7 @@ Setup all tests
 
 Setup test case
     Reset Counters
-    Disable Image Logging For Negative Tests
+    Disable Embedded Image Logging For Negative Tests
 
 Teardown all tests
     Close Javafx Application
diff --git a/src/test/robotframework/acceptance/BoundsLocationTest.robot b/src/test/robotframework/acceptance/BoundsLocationTest.robot
@@ -3,7 +3,7 @@ Documentation       Tests to test javafxlibrary.keywords.BoundsLocation related
 Resource            ../resource.robot
 Suite Setup         Setup all tests
 Suite Teardown      Teardown all tests
-Test Setup          Disable Image Logging For Negative Tests
+Test Setup          Disable Embedded Image Logging For Negative Tests
 Test Teardown       Enable Image Logging
 Force Tags          set-boundslocation
 
diff --git a/src/test/robotframework/acceptance/DatePickerTest.robot b/src/test/robotframework/acceptance/DatePickerTest.robot
@@ -3,7 +3,7 @@ Documentation       Tests to test DatePicker related keywords
 Resource            ../resource.robot
 Suite Setup         Setup all tests
 Suite Teardown      Teardown all tests
-Test Setup          Disable Image Logging For Negative Tests
+Test Setup          Disable Embedded Image Logging For Negative Tests
 Test Teardown       Teardown test case
 Force Tags          set-datepicker
 
diff --git a/src/test/robotframework/acceptance/DragRobotTest.robot b/src/test/robotframework/acceptance/DragRobotTest.robot
@@ -3,7 +3,7 @@ Documentation       Tests to test javafxlibrary.keywords.DragRobot related keywo
 Resource            ../resource.robot
 Suite Setup         Setup all tests
 Suite Teardown      Teardown all tests
-Test Setup          Disable Image Logging For Negative Tests
+Test Setup          Disable Embedded Image Logging For Negative Tests
 Test Teardown       Enable Image Logging
 Force tags          set-dragrobot
 
diff --git a/src/test/robotframework/acceptance/FindTest.robot b/src/test/robotframework/acceptance/FindTest.robot
@@ -3,7 +3,7 @@ Documentation       Tests to test javafxlibrary.keywords.AdditionalKeywords.Find
 Resource            ../resource.robot
 Suite Setup         Setup All Tests
 Suite Teardown      Teardown all tests
-Test Setup          Disable Image Logging For Negative Tests
+Test Setup          Disable Embedded Image Logging For Negative Tests
 Test Teardown       Enable Image Logging
 Force Tags          set-find
 
diff --git a/src/test/robotframework/acceptance/KeyboardRobotTest.robot b/src/test/robotframework/acceptance/KeyboardRobotTest.robot
@@ -3,7 +3,7 @@ Documentation       Tests to test javafxlibrary.keywords.KeyboardRobot related k
 Resource            ../resource.robot
 Suite Setup         Setup all tests
 Suite Teardown      Teardown all tests
-Test Setup          Disable Image Logging For Negative Tests
+Test Setup          Disable Embedded Image Logging For Negative Tests
 Test Teardown       Enable Image Logging
 Force Tags          set-keyboardrobot
 
diff --git a/src/test/robotframework/acceptance/MenuAppTest.robot b/src/test/robotframework/acceptance/MenuAppTest.robot
@@ -3,7 +3,7 @@ Documentation       Tests to test javafxlibrary keywords
 Resource            ../resource.robot
 Suite Setup         Setup all tests
 Suite Teardown      Teardown all tests
-Test Setup          Disable Image Logging For Negative Tests
+Test Setup          Disable Embedded Image Logging For Negative Tests
 Test Teardown       Enable Image Logging
 Force Tags          set-menuapp
 
diff --git a/src/test/robotframework/acceptance/MiscTests.robot b/src/test/robotframework/acceptance/MiscTests.robot
@@ -5,7 +5,7 @@ Library             Collections
 Library             String
 Suite Setup         Setup All Tests
 Suite Teardown      Close Javafx Application
-Test Setup          Disable Image Logging For Negative Tests
+Test Setup          Disable Embedded Image Logging For Negative Tests
 Test Teardown       Enable Image Logging
 
 *** Variables ***
diff --git a/src/test/robotframework/acceptance/MoveRobotTest.robot b/src/test/robotframework/acceptance/MoveRobotTest.robot
@@ -96,7 +96,7 @@ Setup all tests
 
 Setup test case
     Move To Top Left Corner
-    Disable Image Logging For Negative Tests
+    Disable Embedded Image Logging For Negative Tests
 
 Teardown all tests
     Close Javafx Application
diff --git a/src/test/robotframework/acceptance/NodeLookupTest.robot b/src/test/robotframework/acceptance/NodeLookupTest.robot
@@ -3,7 +3,7 @@ Documentation       Tests to test javafxlibrary.keywords.NodeLookup related keyw
 Resource            ../resource.robot
 Suite Setup         Setup all tests
 Suite Teardown      Teardown all tests
-Test Setup          Disable Image Logging For Negative Tests
+Test Setup          Disable Embedded Image Logging For Negative Tests
 Test Teardown       Enable Image Logging
 Force Tags          set-nodelookup
 
diff --git a/src/test/robotframework/acceptance/PointLocationTest.robot b/src/test/robotframework/acceptance/PointLocationTest.robot
@@ -3,7 +3,7 @@ Documentation       Tests to test javafxlibrary.keywords.PointLocation and Point
 Resource            ../resource.robot
 Suite Setup         Setup all tests
 Suite Teardown      Teardown all tests
-Test Setup          Disable Image Logging For Negative Tests
+Test Setup          Disable Embedded Image Logging For Negative Tests
 Test Teardown       Enable Image Logging
 Force Tags          set-pointlocation    set-pointoffset
 
diff --git a/src/test/robotframework/acceptance/ScreenCapturingTest.robot b/src/test/robotframework/acceptance/ScreenCapturingTest.robot
@@ -4,7 +4,7 @@ Library             String
 Resource            ../resource.robot
 Suite Setup         Setup all tests
 Suite Teardown      Teardown all tests
-Test Setup          Disable Image Logging For Negative Tests
+Test Setup          Disable Embedded Image Logging For Negative Tests
 Test Teardown       Enable Image Logging
 Force Tags          set-screencapturing
 
diff --git a/src/test/robotframework/acceptance/ScrollRobotTest.robot b/src/test/robotframework/acceptance/ScrollRobotTest.robot
@@ -3,7 +3,7 @@ Documentation       Tests to test javafxlibrary.keywords.ScrollRobot related key
 Resource            ../resource.robot
 Suite Setup         Setup all tests
 Suite Teardown      Teardown all tests
-Test Setup          Disable Image Logging For Negative Tests
+Test Setup          Disable Embedded Image Logging For Negative Tests
 Test Teardown       Enable Image Logging
 Force Tags          set-scrollrobot
 
diff --git a/src/test/robotframework/acceptance/ScrollRobotTest2.robot b/src/test/robotframework/acceptance/ScrollRobotTest2.robot
@@ -3,7 +3,7 @@ Documentation       Tests to test javafxlibrary.keywords.ScrollRobot related key
 Resource            ../resource.robot
 Suite Setup         Setup all tests
 Suite Teardown      Teardown all tests
-Test Setup          Disable Image Logging For Negative Tests
+Test Setup          Disable Embedded Image Logging For Negative Tests
 Test Teardown       Enable Image Logging
 Force Tags          set-scrollrobot
 
diff --git a/src/test/robotframework/acceptance/SwingApplicationWrapperTest.robot b/src/test/robotframework/acceptance/SwingApplicationWrapperTest.robot
@@ -3,7 +3,7 @@ Documentation       Tests for handling Swing embedded JavaFX nodes
 Resource            ../resource.robot
 Force Tags          set-embedded
 Suite Setup         Import JavaFXLibrary
-Test Setup          Disable Image Logging For Negative Tests
+Test Setup          Disable Embedded Image Logging For Negative Tests
 Test Teardown       Teardown Test Case
 
 *** Testcases ***
diff --git a/src/test/robotframework/acceptance/WindowLookupTest.robot b/src/test/robotframework/acceptance/WindowLookupTest.robot
@@ -3,7 +3,7 @@ Documentation       Tests to test javafxlibrary.keywords.WindowLookup related ke
 Resource            ../resource.robot
 Suite Setup         Setup all tests
 Suite Teardown      Teardown all tests
-Test Setup          Disable Image Logging For Negative Tests
+Test Setup          Disable Embedded Image Logging For Negative Tests
 Test Teardown       Enable Image Logging
 Force Tags          set-windowlookup
 
diff --git a/src/test/robotframework/acceptance/WindowManagementTest.robot b/src/test/robotframework/acceptance/WindowManagementTest.robot
@@ -3,7 +3,7 @@ Documentation       Tests for Window Management
 Resource            ../resource.robot
 Suite Setup         Setup all tests
 Suite Teardown      Teardown all tests
-Test Setup          Disable Image Logging For Negative Tests
+Test Setup          Disable Embedded Image Logging For Negative Tests
 Test Teardown       Enable Image Logging
 Force Tags          set-windowmanagement
 
diff --git a/src/test/robotframework/acceptance/WindowTargetingTest.robot b/src/test/robotframework/acceptance/WindowTargetingTest.robot
@@ -3,7 +3,7 @@ Documentation       Tests to test javafxlibrary.keywords.WindowTargeting related
 Resource            ../resource.robot
 Suite Setup         Setup all tests
 Suite Teardown      Teardown all tests
-Test Setup          Disable Image Logging For Negative Tests
+Test Setup          Disable Embedded Image Logging For Negative Tests
 Test Teardown       Enable Image Logging
 Force Tags          set-windowtargeting
 
diff --git a/src/test/robotframework/resource.robot b/src/test/robotframework/resource.robot
@@ -3,9 +3,9 @@ Import JavaFXLibrary
     Run Keyword If    sys.platform.startswith('java')    Import Library    JavaFXLibrary
     ...    ELSE    Import Library    Remote    http://javafxcompile:8270    WITH NAME    RemoteJavaFXLibrary
 
-Disable Image Logging For Negative Tests
+Disable Embedded Image Logging For Negative Tests
     :FOR    ${tag}    IN    @{TEST TAGS}
-    \       Run Keyword If    '${tag}' == 'negative'    Set Image Logging    OFF
+    \       Run Keyword If    '${tag}' == 'negative'    Set Image Logging    DISKONLY
 
 Enable Image Logging
-    Set Image Logging    ON
+    Set Image Logging    EMBEDDED
