Merge pull request #64 from LambdaTest/stage

Release 1.0.24-beta.1

Author: parthlambdatest

build.gradle

@@ -6,7 +6,7 @@ plugins {
 }
 
 group = 'io.github.lambdatest'
-version = '1.0.23'
+version = '1.0.24-beta.1'
 description = 'lambdatest-java-sdk'
 
 repositories {
@@ -82,7 +82,7 @@ afterEvaluate {
             mavenJava(MavenPublication) {
                 groupId = 'io.github.lambdatest'
                 artifactId = 'lambdatest-java-sdk'
-                version = '1.0.23'
+                version = '1.0.24-beta.1'
 
                 pom {
                     name.set('LambdaTest Java SDK')

pom.xml

@@ -6,7 +6,7 @@
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>io.github.lambdatest</groupId>
 	<artifactId>lambdatest-java-sdk</artifactId>
-	<version>1.0.23</version>
+	<version>1.0.24-beta.1</version>
 	<name>lambdatest-java-sdk</name>
 	<description>LambdaTest SDK in Java</description>
 	<url>https://www.lambdatest.com</url>

src/main/java/io/github/lambdatest/SmartUIResults.java

@@ -0,0 +1,96 @@
+package io.github.lambdatest;
+
+import org.openqa.selenium.WebDriver;
+import io.github.lambdatest.utils.LoggerUtil;
+import io.github.lambdatest.utils.SmartUIUtil;
+import io.github.lambdatest.constants.Constants;
+import org.json.JSONObject;
+
+import java.util.logging.Logger;
+
+/**
+ * Provides methods to fetch aggregate visual comparison results from SmartUI.
+ *
+ * <p>Two overloaded methods are available:
+ * <ul>
+ *   <li>{@link #smartuiResults(WebDriver)} - fetches results for a specific session (driver's sessionId)</li>
+ *   <li>{@link #smartuiResults()} - fetches results for the entire active build</li>
+ * </ul>
+ */
+public class SmartUIResults {
+
+    private static final Logger log = LoggerUtil.createLogger("lambdatest-java-sdk");
+    private static final SmartUIUtil smartUIUtils = new SmartUIUtil();
+
+    /**
+     * Fetches SmartUI visual comparison results for the session associated with the given WebDriver.
+     *
+     * <p>This method extracts the sessionId from the RemoteWebDriver and queries the SmartUI server
+     * for screenshot data filtered by that session. The response contains screenshots grouped by name
+     * with a summary indicating variant and screenshot counts.
+     *
+     * @param driver A Selenium WebDriver instance (must be a RemoteWebDriver)
+     * @return JSONObject containing screenshots grouped by name and a summary with type "session"
+     * @throws Exception if the driver is null, not a RemoteWebDriver, or the request fails
+     */
+    public static JSONObject smartuiResults(WebDriver driver) throws Exception {
+        if (driver == null) {
+            throw new IllegalArgumentException(Constants.Errors.SELENIUM_DRIVER_NULL);
+        }
+
+        if (!smartUIUtils.isSmartUIRunning()) {
+            throw new IllegalStateException(Constants.Errors.SMARTUI_NOT_RUNNING);
+        }
+
+        try {
+            // Extract sessionId from the driver (null-safe)
+            org.openqa.selenium.remote.SessionId sid = ((org.openqa.selenium.remote.RemoteWebDriver) driver).getSessionId();
+            if (sid == null) {
+                throw new IllegalStateException("Unable to get sessionId from the driver");
+            }
+            String sessionId = sid.toString();
+
+            log.info("Fetching SmartUI results for sessionId: " + sessionId);
+
+            // CLI server resolves buildId and projectToken from its context
+            String resultsResponse = smartUIUtils.getSmartUIResults(sessionId);
+            log.info("SmartUI results fetched successfully for sessionId: " + sessionId);
+
+            return new JSONObject(resultsResponse);
+
+        } catch (ClassCastException e) {
+            throw new IllegalArgumentException("Driver must be an instance of RemoteWebDriver to extract sessionId", e);
+        } catch (Exception e) {
+            throw e;
+        }
+    }
+
+    /**
+     * Fetches SmartUI visual comparison results for the entire active build.
+     *
+     * <p>This method queries the SmartUI server for all screenshot data in the current build
+     * without filtering by session. The response contains screenshots grouped by name
+     * with a summary indicating variant and screenshot counts.
+     *
+     * @return JSONObject containing screenshots grouped by name and a summary with type "build"
+     * @throws Exception if the SmartUI server is not running or the request fails
+     */
+    public static JSONObject smartuiResults() throws Exception {
+        if (!smartUIUtils.isSmartUIRunning()) {
+            throw new IllegalStateException(Constants.Errors.SMARTUI_NOT_RUNNING);
+        }
+
+        try {
+            log.info("Fetching SmartUI results for entire build");
+
+            // CLI server resolves buildId from its active build context
+            String resultsResponse = smartUIUtils.getSmartUIResults(null);
+            log.info("SmartUI results fetched successfully for build");
+
+            return new JSONObject(resultsResponse);
+
+        } catch (Exception e) {
+            throw e;
+        }
+    }
+}

src/main/java/io/github/lambdatest/SmartUISnapshot.java

@@ -3,6 +3,7 @@
 import org.openqa.selenium.WebDriver;
 import io.github.lambdatest.utils.LoggerUtil;
 import io.github.lambdatest.utils.SmartUIUtil;
+import io.github.lambdatest.utils.WebElementResolver;
 import io.github.lambdatest.constants.Constants;
 import io.github.lambdatest.models.ResponseData;
 import io.github.lambdatest.models.SnapshotResponse;
@@ -65,6 +66,13 @@ public static JSONObject smartuiSnapshot(WebDriver driver, String snapshotName,
                     options.put("sessionId", sessionId);
                 }
 
+                // Resolve any WebElement objects in element/ignoreDOM/selectDOM to CSS selectors
+                try {
+                    WebElementResolver.resolveWebElements(jsExecutor, options);
+                } catch (Exception e) {
+                    log.warning("Failed to resolve WebElement options: " + e.getMessage());
+                }
+
                 // Convert the options map to JSON string
                 String jsonOptions = gson.toJson(options);
 

src/main/java/io/github/lambdatest/constants/Constants.java

@@ -34,6 +34,7 @@ interface SmartUIRoutes {
     public static final String SMARTUI_UPLOAD_PDF_ROUTE = "/pdf/upload";
     public static final String SMARTUI_BUILD_SCREENSHOTS_ROUTE = "/smartui/2.0/build/screenshots";
     public static final String SMARTUI_SNAPSHOT_STATUS_ROUTE = "/snapshot/status";
+    public static final String SMARTUI_RESULTS_ROUTE = "/smartui/results";
   }
 
   //Request methods
@@ -82,5 +83,6 @@ interface Errors {
     public static final String NULL_OPTIONS_OBJECT = "Options object is null or missing in request.";
     public static final String DEVICE_NAME_NULL = "Device name is a mandatory parameter.";
     public static final String SNAPSHOT_STATUS_FAILED = "Get snapshot status failed";
+    public static final String SMARTUI_RESULTS_FAILED = "Failed to fetch SmartUI results";
   }
-}
+}

src/main/java/io/github/lambdatest/utils/HttpClientUtil.java

@@ -575,6 +575,34 @@ public String getBuildScreenshotsWithPolling(String url, Map<String, String> hea
         }
     }
 
+    public String getSmartUIResults(String sessionId) throws IOException {
+        try {
+            String url = SmartUIUtil.getSmartUIServerAddress() +
+                    Constants.SmartUIRoutes.SMARTUI_RESULTS_ROUTE;
+            if (sessionId != null && !sessionId.isEmpty()) {
+                url += "?sessionId=" + URLEncoder.encode(sessionId, StandardCharsets.UTF_8);
+            }
+
+            HttpGet request = new HttpGet(url);
+            request.setHeader("Content-Type", "application/json");
+
+            log.info("Fetching SmartUI results from: " + url);
+
+            try (CloseableHttpResponse response = httpClient.execute(request)) {
+                int statusCode = response.getStatusLine().getStatusCode();
+                HttpEntity entity = response.getEntity();
+                String responseString = entity != null ? EntityUtils.toString(entity) : null;
+                if (statusCode == HttpStatus.SC_OK) {
+                    return responseString;
+                } else {
+                    throw new IOException("SmartUI results request failed with status code: " + statusCode + ". Response: " + responseString);
+                }
+            }
+        } catch (Exception e) {
+            throw new IOException(Constants.Errors.SMARTUI_RESULTS_FAILED + ": " + e.getMessage(), e);
+        }
+    }
+
     public String getSnapshotStatus(String contextId, String snapshotName, int timeout) throws IOException {
         try {
             String trimmedSnapshotName = snapshotName.trim();

src/main/java/io/github/lambdatest/utils/SmartUIUtil.java

@@ -256,6 +256,23 @@ public BuildScreenshotsResponse getBuildScreenshots(String projectId, String bui
         }
     }
 
+    /**
+     * Fetches SmartUI results for a specific session.
+     * The CLI server resolves buildId and projectToken from its context.
+     * @param sessionId The session ID to fetch results for (null for build-level results)
+     * @return JSON string of SmartUI results with screenshots grouped by name and summary
+     */
+    public String getSmartUIResults(String sessionId) throws Exception {
+        try {
+            String results = httpClient.getSmartUIResults(sessionId);
+            log.info("Fetched SmartUI results for sessionId: " + sessionId);
+            return results;
+        } catch (Exception e) {
+            log.severe("Failed to fetch SmartUI results: " + e.getMessage());
+            throw e;
+        }
+    }
+
     public String getSnapshotStatus(String contextId, String snapshotName, int timeout) throws Exception {
         try {
             String snapshotStatus = httpClient.getSnapshotStatus(contextId, snapshotName, timeout);