revamp based on new architecture

Author: shandli123

src/main/java/com/browserstack/automate/ci/common/constants/Constants.java

@@ -15,12 +15,12 @@ public class Constants {
     public static final String BROWSERSTACK_REPORT_PATH_PATTERN = "**/browserstack-artifacts/*";
     public static final String JENKINS_CI_PLUGIN = "JenkinsCiPlugin";
 
-    public static final String INTEGRATE_BASE_URL = "https://integrate.browserstack.com/api";
-    public static  final String BROWSERSTACK_CONFIG_DETAILS_ENDPOINT = "/ci-tools/v1/events/report-config";
+    public static final String CAD_BASE_URL = "https://api-observability.browserstack.com//api";
+    public static  final String BROWSERSTACK_CONFIG_DETAILS_ENDPOINT = "/v1/builds/buildReport";
 
     public static final String BROWSERSTACK_TEST_REPORT_DISPLAY_NAME = "BrowserStack Build Test Reports";
     public static final String INTEGRATIONS_TOOL_KEY = "jenkins";
-    public static  final String REPORT_CONFIG_OPERATION_NAME = "report-config-details";
+    public static  final String REPORT_FORMAT = "richHtml";
 
     // Product
     public static final String AUTOMATE = "automate";

src/main/java/com/browserstack/automate/ci/jenkins/integrationService/BrowserStackReportStatus.java

@@ -3,5 +3,8 @@
 public enum BrowserStackReportStatus {
   IN_PROGRESS,
   COMPLETED,
-  FAILED
+  TEST_AVAILABLE,
+  NOT_AVAILABLE,
+  BUILD_NOT_FOUND,
+  MULTIPLE_BUILD_FOUND
 }

src/main/java/com/browserstack/automate/ci/jenkins/integrationService/BrowserStackTestReportAction.java

@@ -7,6 +7,7 @@
 import org.json.JSONObject;
 import okhttp3.*;
 
+import javax.xml.bind.annotation.XmlType;
 import java.io.PrintStream;
 import java.util.Arrays;
 import java.util.HashMap;
@@ -19,15 +20,18 @@ public class BrowserStackTestReportAction implements Action {
 
   private Run<?, ?> run;
   private BrowserStackCredentials credentials;
-  private String reportUrl;
-  private final String UUID;
   private String reportHtml;
+
+  private String buildName;
+  private String buildCreatedAt;
   private final transient PrintStream logger;
   private String reportStyle;
   public String reportName;
   public String urlName;
 
   private int maxRetryReportAttempt;
+
+  private static final String DEFAULT_REPORT_TIMEOUT = "120";
   private static final String REPORT_IN_PROGRESS = "REPORT_IN_PROGRESS";
   private static final String REPORT_FAILED = "REPORT_FAILED";
 
@@ -36,18 +40,16 @@ public class BrowserStackTestReportAction implements Action {
   private static final int MAX_ATTEMPTS = 3;
   private RequestsUtil requestsUtil;
 
-  public BrowserStackTestReportAction(Run<?, ?> run, BrowserStackCredentials credentials, String reportUrl, String UUID, String reportName, String tabUrl, final PrintStream logger) {
+  public BrowserStackTestReportAction(Run<?, ?> run, BrowserStackCredentials credentials, String buildName, String builldCreatedAt, final PrintStream logger) {
     super();
     setBuild(run);
     this.credentials = credentials;
-    this.reportUrl = reportUrl;
-    this.UUID = UUID;
+    this.buildName = buildName;
+    this.buildCreatedAt = builldCreatedAt;
     this.reportHtml = null;
     this.reportStyle = "";
+    maxRetryReportAttempt = MAX_ATTEMPTS;
     this.logger = logger;
-    this.reportName = reportName;
-    this.urlName = tabUrl;
-    this.maxRetryReportAttempt = MAX_ATTEMPTS;
 
     this.requestsUtil = new RequestsUtil();
   }
@@ -70,28 +72,37 @@ private void fetchReportConditions() {
   }
 
   private void fetchReport() {
-    if (UUID == null) {
-      reportHtml = REPORT_FAILED;
-      return;
-    }
     Map<String, String> params = new HashMap<>();
-    params.put("UUID", UUID);
-    params.put("report_name", reportName);
-    params.put("tool", Constants.INTEGRATIONS_TOOL_KEY);
+    String pollValue = "FIRST";
+    params.put("buildCreatedAt", buildCreatedAt);
+    params.put("buildName", buildName);
+    params.put("requestingCi", Constants.INTEGRATIONS_TOOL_KEY);
+    params.put("reportFormat", Arrays.asList(Constants.REPORT_FORMAT).toString());
+    params.put("requestType", pollValue);
+    params.put("userTimeout", DEFAULT_REPORT_TIMEOUT);
 
     try {
+      String reportUrl = Constants.CAD_BASE_URL + Constants.BROWSERSTACK_CONFIG_DETAILS_ENDPOINT;
       String ciReportUrlWithParams = requestsUtil.buildQueryParams(reportUrl, params);
       log(logger, "Fetching browserstack report " + reportName);
       Response response = requestsUtil.makeRequest(ciReportUrlWithParams, credentials);
       if (response.isSuccessful()) {
+        assert response.body() != null;
         JSONObject reportResponse = new JSONObject(response.body().string());
-        String reportStatus = reportResponse.optString("report_status");
-        if (reportStatus.equalsIgnoreCase(String.valueOf(BrowserStackReportStatus.COMPLETED))) {
+        String reportStatus = reportResponse.optString("reportStatus");
+        if (reportStatus.equalsIgnoreCase(String.valueOf(BrowserStackReportStatus.COMPLETED)) ||
+                reportStatus.equalsIgnoreCase(String.valueOf(BrowserStackReportStatus.TEST_AVAILABLE)) ||
+                reportStatus.equalsIgnoreCase(String.valueOf(BrowserStackReportStatus.NOT_AVAILABLE))) {
+
           String defaultHTML = "<h1>No Report Found</h1>";
-          reportHtml = reportResponse.optString("report_html", defaultHTML);
-          reportStyle = reportResponse.optString("report_style", "");
+          JSONObject report = reportResponse.optJSONObject("report");
+          reportHtml = report != null ? report.optString("report_html", defaultHTML) : defaultHTML;
+          reportStyle = report != null ? report.optString("report_style", "") : "";
+
         } else if (reportStatus.equalsIgnoreCase(String.valueOf(BrowserStackReportStatus.IN_PROGRESS))) {
+
           reportHtml = REPORT_IN_PROGRESS;
+
         } else {
           reportHtml = REPORT_FAILED;
         }

src/main/java/com/browserstack/automate/ci/jenkins/integrationService/BrowserStackTestReportPublisher.java

@@ -18,36 +18,26 @@
 import hudson.Launcher;
 import jenkins.tasks.SimpleBuildStep;
 import org.jenkinsci.Symbol;
-import org.json.JSONArray;
-import org.json.JSONObject;
-import okhttp3.*;
 import org.kohsuke.stapler.DataBoundConstructor;
 
 import java.io.IOException;
 import java.io.PrintStream;
-import java.net.URISyntaxException;
 import java.net.URLEncoder;
 import java.text.SimpleDateFormat;
 import java.util.*;
 import java.util.concurrent.ConcurrentHashMap;
-import java.util.concurrent.TimeUnit;
 import java.util.logging.Logger;
 
 import static com.browserstack.automate.ci.common.logger.PluginLogger.log;
 import static com.browserstack.automate.ci.common.logger.PluginLogger.logError;
 
 public class BrowserStackTestReportPublisher extends Recorder implements SimpleBuildStep {
   private static final Logger LOGGER = Logger.getLogger(BrowserStackTestReportPublisher.class.getName());
-  private static final int MAX_ATTEMPTS = 3;
-  private static final int RETRY_DELAY_SECONDS = 5;
   private final Map<String, String> customEnvVars;
 
-  private RequestsUtil requestsUtil;
-
   @DataBoundConstructor
   public BrowserStackTestReportPublisher(Map<String, String> customEnvVars) {
     this.customEnvVars = customEnvVars != null && !customEnvVars.isEmpty() ? new ConcurrentHashMap<>(customEnvVars) : new ConcurrentHashMap<>();
-    this.requestsUtil = new RequestsUtil();
   }
 
   @Override
@@ -60,7 +50,6 @@ public void perform(Run<?, ?> build, @NonNull FilePath workspace, @NonNull Launc
 
     String browserStackBuildName = Optional.ofNullable(parentEnvs.get(BrowserStackEnvVars.BROWSERSTACK_BUILD_NAME))
             .orElse(parentEnvs.get(Constants.JENKINS_BUILD_TAG));
-    String projectName = parentEnvs.get(BrowserStackEnvVars.BROWSERSTACK_PROJECT_NAME);
 
     BrowserStackBuildAction buildAction = build.getAction(BrowserStackBuildAction.class);
     if (buildAction == null || buildAction.getBrowserStackCredentials() == null) {
@@ -72,105 +61,20 @@ public void perform(Run<?, ?> build, @NonNull FilePath workspace, @NonNull Launc
 
     LOGGER.info("Adding BrowserStack Report Action");
 
-    String configDetailsEndpoint = Constants.INTEGRATE_BASE_URL + Constants.BROWSERSTACK_CONFIG_DETAILS_ENDPOINT;
-    JSONObject reportConfigDetailsResponse = fetchConfigDetails(logger, configDetailsEndpoint, credentials);
-    if (reportConfigDetailsResponse == null) {
-      logError(logger, "Could not fetch the report config details");
-      return;
-    }
 
-    JSONArray configDetails = reportConfigDetailsResponse.getJSONArray("config_details");
-    String lookUpURL = reportConfigDetailsResponse.getString("lookup_endpoint");
     Date buildTimestamp = new Date(build.getStartTimeInMillis());
 
     // Format the timestamp (e.g., YYYY-MM-DD HH:MM:SS)
     SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd_HH:mm:ss");
     String formattedTime = sdf.format(buildTimestamp);
 
     // Encode the timestamp to make it URL-safe
-    String encodedTimestamp = URLEncoder.encode(formattedTime, "UTF-8");
-
-    String UUID = fetchBuildUUID(logger, lookUpURL, credentials, browserStackBuildName, projectName, encodedTimestamp);
-    if (UUID == null) {
-      logError(logger, "Cannot find a build with name " + browserStackBuildName);
-    }
+    String buildCreatedAt = URLEncoder.encode(formattedTime, "UTF-8");
 
-    for (int i = 0; i < configDetails.length(); i++) {
-      JSONObject config = configDetails.getJSONObject(i);
-
-      String reportUrl = config.getString("report_fetch_url");
-      String reportName = config.getString("report_name");
-      String reportTabUrl = config.getString("report_tab_url");
-      build.addAction(new BrowserStackTestReportAction(build, credentials, reportUrl, UUID, reportName, reportTabUrl, logger));
-    }
+    build.addAction(new BrowserStackTestReportAction(build, credentials, browserStackBuildName,buildCreatedAt, logger));
 
   }
 
-  private String fetchBuildUUID(PrintStream logger, String lookUpURL, BrowserStackCredentials credentials, String buildName, String projectName, String encodedTimestamp) throws InterruptedException {
-
-    Map<String, String> params = new HashMap<>();
-    params.put("build_name", buildName);
-    params.put("pipeline_timestamp", encodedTimestamp);
-    params.put("tool", Constants.INTEGRATIONS_TOOL_KEY);
-    if (projectName != null) {
-      params.put("project_name", projectName);
-    }
-
-    log(logger, "Fetching build....");
-    String lookUpURLWithParams;
-
-    //constructing build params
-    try {
-      lookUpURLWithParams = requestsUtil.buildQueryParams(lookUpURL, params);
-    } catch (URISyntaxException uriSyntaxException) {
-      logError(logger, "Could not build look up url with params" + Arrays.toString(uriSyntaxException.getStackTrace()));
-      return null;
-    }
-
-    //making attempts
-    for (int attempts = 0; attempts < MAX_ATTEMPTS; attempts++) {
-      try {
-        Response response = requestsUtil.makeRequest(lookUpURLWithParams, credentials);
-        if (response.isSuccessful()) {
-          assert response.body() != null;
-          JSONObject lookUpResponse = new JSONObject(response.body().string());
-          String UUID = lookUpResponse.optString("UUID", null);
-
-          if (UUID != null) {
-            log(logger, "build found with " + buildName + " and project name " + projectName);
-            return UUID;
-          }
-
-          LOGGER.info("build not found will retry in sometime.." + lookUpResponse.getString("message"));
-        }
-      } catch (Exception e) {
-        logError(logger, "Attempt " + (attempts + 1) + " failed: " + Arrays.toString(e.getStackTrace()));
-      }
-      TimeUnit.SECONDS.sleep(RETRY_DELAY_SECONDS);
-    }
-
-    LOGGER.info("build not found even after " + MAX_ATTEMPTS + "attempts");
-    return null;
-  }
-
-  private JSONObject fetchConfigDetails(PrintStream logger, String configDetailsURL, BrowserStackCredentials credentials) {
-    log(logger, "Fetching config details for reports");
-    Map<String, String> params = new HashMap<>();
-    params.put("tool", Constants.INTEGRATIONS_TOOL_KEY);
-    params.put("operation", Constants.REPORT_CONFIG_OPERATION_NAME);
-    try {
-      String configDetailsURLWithParams = requestsUtil.buildQueryParams(configDetailsURL, params);
-      Response response = requestsUtil.makeRequest(configDetailsURLWithParams, credentials);
-      if (response.isSuccessful()) {
-        assert response.body() != null;
-        return new JSONObject(response.body().string());
-      }
-      logError(logger, "Failed to fetch config details: " + response.code());
-    } catch (Exception e) {
-      logError(logger, "Exception occurred while fetching config details: " + Arrays.toString(e.getStackTrace()));
-    }
-    return null;
-  }
 
   public Map<String, String> getCustomEnvVars() {
     return customEnvVars;

src/main/resources/com/browserstack/automate/ci/jenkins/integrationService/BrowserStackTestReportAction/index.jelly

@@ -75,7 +75,7 @@
                     <div class="new-container">
                         <div class="report-row">
                             <j:if test="${(it.isReportInProgress())}">
-                                <p class="no-report-para"><strong class="strong-font-custom">BrowserStack ${it.reportName} Report In Progress</strong></p>
+                                <p class="no-report-para"><strong class="strong-font-custom">BrowserStack ${it.reportName} Report In Progress, please refresh after sometime</strong></p>
                             </j:if>
                             <j:if test="${(it.isReportFailed())}">
                                 <p class="no-report-para"><strong class="strong-font-custom">No BrowserStack ${it.reportName} Report Available</strong></p>
@@ -85,8 +85,6 @@
                                 <ul class="bullet-points">
                                     <li class="bullet-item">You have set valid BrowserStack credentials via BrowserStack Plugin.</li>
                                     <li class="bullet-item">You have used BROWSERSTACK_BUILD_NAME as your build name</li>
-                                    <li class="bullet-item">try passing BROWSERSTACK_PROJECT_NAME environment variable</li>
-
                                 </ul>
                             </j:if>
                             <j:if test="${it.reportRetryRequired()}">