feat: Allow taking of screenshots of Page Objects or elements (#236)

Author: jimevanssfdc

pom.xml

@@ -12,7 +12,7 @@
     <groupId>com.salesforce.utam</groupId>
     <artifactId>utam-java</artifactId>
     <packaging>pom</packaging>
-    <version>4.0.2-SNAPSHOT</version>
+    <version>4.0.3-SNAPSHOT</version>
     <name>${project.groupId}:${project.artifactId}</name>
     <description>Java project for generating and using UTAM Page Objects</description>
     <url>http://github.com/salesforce/utam-java</url>

utam-compiler/pom.xml

@@ -10,7 +10,7 @@
     <parent>
         <artifactId>utam-java</artifactId>
         <groupId>com.salesforce.utam</groupId>
-        <version>4.0.2-SNAPSHOT</version>
+        <version>4.0.3-SNAPSHOT</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

utam-core/pom.xml

@@ -10,7 +10,7 @@
     <parent>
         <artifactId>utam-java</artifactId>
         <groupId>com.salesforce.utam</groupId>
-        <version>4.0.2-SNAPSHOT</version>
+        <version>4.0.3-SNAPSHOT</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 
@@ -27,6 +27,20 @@
         <dependency>
             <groupId>io.appium</groupId>
             <artifactId>java-client</artifactId>
+            <exclusions>
+                <exclusion>
+                    <groupId>org.seleniumhq.selenium</groupId>
+                    <artifactId>selenium-api</artifactId>
+               </exclusion>
+               <exclusion>
+                    <groupId>org.seleniumhq.selenium</groupId>
+                    <artifactId>selenium-remote-driver</artifactId>
+                </exclusion>
+                <exclusion>
+                    <groupId>org.seleniumhq.selenium</groupId>
+                    <artifactId>selenium-support</artifactId>
+                </exclusion>
+        </exclusions>
         </dependency>
         <dependency>
             <groupId>org.slf4j</groupId>

utam-core/src/main/java/utam/core/element/Element.java

@@ -160,6 +160,13 @@ public interface Element {
    */
   void dragAndDrop(DragAndDropOptions options);
 
+  /**
+   * Gets a screenshot of the element represented by this object.
+   *
+   * @return a byte array containing a PNG image of the element
+   */
+  byte[] getScreenshot();
+
   /**
    * Get element coordinates and size. Can be used to calculate drop location inside a frame.
    *

utam-core/src/main/java/utam/core/framework/base/ContainerElementPageObject.java

@@ -63,6 +63,11 @@ public boolean isPresent() {
     return false;
   }
 
+  @Override
+  public byte[] getScreenshot() {
+    throw new UtamCoreError(ERR_UNSUPPORTED_METHOD);
+  }
+
   @Override
   public void waitForAbsence() {
     throw new UtamCoreError(ERR_UNSUPPORTED_METHOD);

utam-core/src/main/java/utam/core/framework/base/UtamBase.java

@@ -56,6 +56,13 @@ public interface UtamBase {
    */
   boolean isVisible();
 
+  /**
+   * Gets a screenshot of the element represented by this object.
+   *
+   * @return the screenshot in PNG format as a byte array
+   */
+  byte[] getScreenshot();
+
   /**
    * check if current element contains another element with the given selector
    *

utam-core/src/main/java/utam/core/framework/base/UtamBaseImpl.java

@@ -121,6 +121,11 @@ public final boolean containsElement(Locator locator, boolean isExpandShadow) {
     return transformed.containsElements(locator) > 0;
   }
 
+  @Override
+  public byte[] getScreenshot() {
+    return getElement().getScreenshot();
+  }
+
   @Override
   public final boolean containsElement(Locator locator) {
     return containsElement(locator, false);

utam-core/src/main/java/utam/core/selenium/element/ElementAdapter.java

@@ -16,6 +16,7 @@
 import java.util.stream.Collectors;
 import org.openqa.selenium.By;
 import org.openqa.selenium.NoSuchElementException;
+import org.openqa.selenium.OutputType;
 import org.openqa.selenium.Rectangle;
 import org.openqa.selenium.StaleElementReferenceException;
 import org.openqa.selenium.WebDriver;
@@ -183,6 +184,11 @@ public void deprecatedClick() {
     driverAdapter.executeScript(CLICK_VIA_JAVASCRIPT, getWebElement());
   }
 
+  @Override
+  public byte[] getScreenshot() {
+    return getWebElement().getScreenshotAs(OutputType.BYTES);
+  }
+
   @Override
   public void scrollIntoView(ScrollOptions options) {
     if (options == ScrollOptions.TOP) {

utam-core/src/test/java/utam/core/framework/element/BasePageElementTests.java

@@ -10,6 +10,7 @@
 import static org.hamcrest.CoreMatchers.equalTo;
 import static org.hamcrest.CoreMatchers.is;
 import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.notNullValue;
 import static org.mockito.ArgumentMatchers.contains;
 import static org.mockito.ArgumentMatchers.refEq;
 import static org.mockito.Mockito.doThrow;
@@ -24,6 +25,7 @@
 import org.openqa.selenium.JavascriptException;
 import org.openqa.selenium.JavascriptExecutor;
 import org.openqa.selenium.Keys;
+import org.openqa.selenium.OutputType;
 import org.openqa.selenium.Rectangle;
 import org.openqa.selenium.StaleElementReferenceException;
 import org.openqa.selenium.TimeoutException;
@@ -312,4 +314,11 @@ public void testGetRectangle() {
     assertThat(test.getWidth(), equalTo(4));
     assertThat(test.getHeight(), equalTo(3));
   }
+
+  @Test
+  public void testGetScreenshot() {
+    MockUtilities mock = new MockUtilities();
+    when(mock.getWebElementMock().getScreenshotAs(OutputType.BYTES)).thenReturn(new byte[0]);
+    assertThat(mock.getUtamElement().getScreenshot(), is(notNullValue()));
+  }
 }