Added type check for snapshot and screenshot (#249)

Author: chinmay-browserstack

src/main/java/io/percy/selenium/Percy.java

@@ -46,6 +46,9 @@ public class Percy {
     // for logging
     private static String LABEL = "[\u001b[35m" + (PERCY_DEBUG ? "percy:java" : "percy") + "\u001b[39m]";
 
+    // Type of session automate/web
+    protected String sessionType = null;
+
     // Is the Percy server running or not
     private boolean isPercyEnabled = healthcheck();
 
@@ -154,6 +157,7 @@ public void snapshot(String name, @Nullable List<Integer> widths, Integer minHei
 
     public void snapshot(String name, Map<String, Object> options) {
         if (!isPercyEnabled) { return; }
+        if ("automate".equals(sessionType)) { throw new RuntimeException("Invalid function call - snapshot(). Please use screenshot() function while using Percy with Automate. For more information on usage of PercyScreenshot, refer https://docs.percy.io/docs/integrate-functional-testing-with-visual-testing"); }
 
         Map<String, Object> domSnapshot = null;
 
@@ -187,6 +191,8 @@ public void screenshot(String name) throws UnsupportedOperationException {
      */
     public void screenshot(String name, Map<String, Object> options) throws UnsupportedOperationException {
         if (!isPercyEnabled) { return; }
+        if ("web".equals(sessionType)) { throw new RuntimeException("Invalid function call - screenshot(). Please use snapshot() function for taking screenshot. screenshot() should be used only while using Percy with Automate. For more information on usage of snapshot(), refer doc for your language https://docs.percy.io/docs/end-to-end-testing"); }
+
         List<String> driverArray = Arrays.asList(driver.getClass().toString().split("\\$")); // Added to handle testcase (mocked driver)
         Iterator<String> driverIterator = driverArray.iterator();
         String driverClass = driverIterator.next();
@@ -264,6 +270,10 @@ private boolean healthcheck() {
 
                 return false;
             }
+            HttpEntity entity = response.getEntity();
+            String responseString = EntityUtils.toString(entity, "UTF-8");
+            JSONObject responseObject = new JSONObject(responseString);
+            sessionType = (String) responseObject.optString("type", null);
 
             return true;
         } catch (Exception ex) {

src/test/java/io/percy/selenium/SdkTest.java

@@ -7,6 +7,7 @@
 
 import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
 import static org.junit.jupiter.api.Assertions.*;
@@ -48,6 +49,11 @@ public static void testTeardown() {
     TestServer.shutdown();
   }
 
+  @BeforeEach
+  public void setSessionType() {
+    percy.sessionType = "web";
+  }
+
   @Test
   public void takesLocalAppSnapshotWithProvidedName() {
     driver.get(TEST_URL);
@@ -123,6 +129,7 @@ public void takeScreenshot() {
     } catch (Exception e) {
     }
     percy = spy(new Percy(mockedDriver));
+    percy.sessionType = "automate";
     when(mockedDriver.getSessionId()).thenReturn(new SessionId("123"));
     when(mockedDriver.getCommandExecutor()).thenReturn(commandExecutor);
     DesiredCapabilities capabilities = new DesiredCapabilities();
@@ -141,6 +148,7 @@ public void takeScreenshotWithOptions() {
       } catch (Exception e) {
       }
       percy = spy(new Percy(mockedDriver));
+      percy.sessionType = "automate";
       when(mockedDriver.getSessionId()).thenReturn(new SessionId("123"));
       when(mockedDriver.getCommandExecutor()).thenReturn(commandExecutor);
       DesiredCapabilities capabilities = new DesiredCapabilities();
@@ -155,4 +163,19 @@ public void takeScreenshotWithOptions() {
       percy.screenshot("Test", options);
       verify(percy).request(eq("/percy/automateScreenshot"), any() , eq("Test"));
     }
+
+    @Test
+    public void takeSnapshotThrowErrorForPOA() {
+      percy.sessionType = "automate";
+      Throwable exception = assertThrows(RuntimeException.class, () -> percy.snapshot("Test"));
+      assertEquals("Invalid function call - snapshot(). Please use screenshot() function while using Percy with Automate. For more information on usage of PercyScreenshot, refer https://docs.percy.io/docs/integrate-functional-testing-with-visual-testing", exception.getMessage());
+    }
+
+    @Test
+    public void takeScreenshotThrowErrorForWeb() {
+      RemoteWebDriver mockedDriver = mock(RemoteWebDriver.class);
+      percy = spy(new Percy(mockedDriver));
+      Throwable exception = assertThrows(RuntimeException.class, () -> percy.screenshot("Test"));
+      assertEquals("Invalid function call - screenshot(). Please use snapshot() function for taking screenshot. screenshot() should be used only while using Percy with Automate. For more information on usage of snapshot(), refer doc for your language https://docs.percy.io/docs/end-to-end-testing", exception.getMessage());
+    }
 }