Intg 1575 Adding support to view bstack reports in jenkins CI

pom.xml

@@ -10,7 +10,7 @@
   </parent>
 
   <artifactId>browserstack-integration</artifactId>
-  <version>1.2.17-SNAPSHOT</version>
+  <version>1.2.18-SNAPSHOT</version>
   <packaging>hpi</packaging>
 
   <name>BrowserStack</name>

src/main/java/com/browserstack/automate/ci/common/BrowserStackEnvVars.java

@@ -9,6 +9,8 @@ public interface BrowserStackEnvVars {
     String BROWSERSTACK_LOCAL_IDENTIFIER = "BROWSERSTACK_LOCAL_IDENTIFIER";
     String BROWSERSTACK_BUILD = "BROWSERSTACK_BUILD";
     String BROWSERSTACK_BUILD_NAME = "BROWSERSTACK_BUILD_NAME";
+
+    String BROWSERSTACK_PROJECT_NAME = "BROWSERSTACK_PROJECT_NAME";
     String BROWSERSTACK_APP_ID = "BROWSERSTACK_APP_ID";
     String BROWSERSTACK_RERUN = "BROWSERSTACK_RERUN";
     String BROWSERSTACK_RERUN_TESTS = "BROWSERSTACK_RERUN_TESTS";

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

@@ -15,6 +15,18 @@ 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 CAD_BASE_URL = "https://api-observability.browserstack.com/ext";
+    public static  final String BROWSERSTACK_CONFIG_DETAILS_ENDPOINT = "/v1/builds/buildReport";
+
+    public static final String INTEGRATIONS_TOOL_KEY = "jenkins";
+
+    public static final String BROWSERSTACK_TEST_REPORT_URL = "testReportBrowserStack";
+    public static final String BROWSERSTACK_CAD_REPORT_DISPLAY_NAME = "BrowserStack Test Report and Insights";
+    public static final String BROWSERSTACK_REPORT_FILENAME = "browserstack-report";
+    public static final String BROWSERSTACK_REPORT_FOLDER = "browserstack-artifacts";
+
+    public static final String BROWSERSTACK_REPORT_AUT_PIPELINE_FUNCTION = "browserStackReportAut";
+
     // Product
     public static final String AUTOMATE = "automate";
     public static final String APP_AUTOMATE = "app-automate";

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

@@ -0,0 +1,8 @@
+package com.browserstack.automate.ci.jenkins.integrationService;
+
+public enum BrowserStackReportStatus {
+  IN_PROGRESS,
+  COMPLETED,
+  TEST_AVAILABLE,
+  NOT_AVAILABLE
+}

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

@@ -0,0 +1,244 @@
+package com.browserstack.automate.ci.jenkins.integrationService;
+
+import com.browserstack.automate.ci.common.constants.Constants;
+import com.browserstack.automate.ci.jenkins.BrowserStackCredentials;
+import com.google.gson.Gson;
+import hudson.EnvVars;
+import hudson.FilePath;
+import hudson.model.Action;
+import hudson.model.Run;
+import hudson.model.TaskListener;
+import hudson.tasks.ArtifactArchiver;
+import org.json.JSONObject;
+import okhttp3.*;
+
+import java.io.IOException;
+import java.io.PrintStream;
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.Map;
+
+import static com.browserstack.automate.ci.common.logger.PluginLogger.log;
+import static com.browserstack.automate.ci.common.logger.PluginLogger.logError;
+
+public class BrowserStackTestReportAction implements Action {
+
+  private static final String DEFAULT_REPORT_TIMEOUT = "120";
+  private static final String SUCCESS_REPORT = "SUCCESS_REPORT";
+  private static final String REPORT_IN_PROGRESS = "REPORT_IN_PROGRESS";
+  private static final String REPORT_FAILED = "REPORT_FAILED";
+  private static final String RETRY_REPORT = "RETRY_REPORT";
+  private static final String RATE_LIMIT = "RATE_LIMIT";
+  private static final String TEST_AVAILABLE = "TEST_AVAILABLE";
+  private static final int MAX_ATTEMPTS = 3;
+
+  private final transient PrintStream logger;
+  private final RequestsUtil requestsUtil;
+  private final BrowserStackCredentials credentials;
+  private final String buildName;
+  private final String buildCreatedAt;
+
+  private Run<?, ?> run;
+  private String reportHtml;
+  private String reportStyle;
+  private String reportStatus;
+  private int maxRetryReportAttempt;
+
+  public BrowserStackTestReportAction(Run<?, ?> run, BrowserStackCredentials credentials, String buildName, String buildCreatedAt, final PrintStream logger) {
+    this.run = run;
+    this.credentials = credentials;
+    this.buildName = buildName;
+    this.buildCreatedAt = buildCreatedAt;
+    this.logger = logger;
+    this.requestsUtil = new RequestsUtil();
+    this.reportHtml = null;
+    this.reportStyle = "";
+    this.reportStatus = "";
+    this.maxRetryReportAttempt = MAX_ATTEMPTS;
+  }
+
+  public String getReportHtml() {
+    ensureReportFetched();
+    return reportHtml;
+  }
+
+  public String getReportStyle() {
+    ensureReportFetched();
+    return reportStyle;
+  }
+
+  private void ensureReportFetched() {
+    if (!isReportCompletedOrFailed()) {
+      fetchReport();
+    }
+  }
+
+  private boolean isReportCompletedOrFailed() {
+    return reportStatus.equals(SUCCESS_REPORT) || reportStatus.equals(REPORT_FAILED);
+  }
+
+  private void fetchReport() {
+    Map<String, Object> params = createReportParams();
+    String reportUrl = Constants.CAD_BASE_URL + Constants.BROWSERSTACK_CONFIG_DETAILS_ENDPOINT;
+
+    try {
+      log(logger, "Fetching BrowserStack report...");
+      Response response = requestsUtil.makeRequest(reportUrl, credentials, createRequestBody(params));
+      handleResponse(response);
+    } catch (Exception e) {
+      if(!isReportTestAvailable()) {
+        handleFetchException(e);
+      }
+    }
+  }
+
+  private Map<String, Object> createReportParams() {
+    String RquestTypeForJenkins = "POLL";
+    Map<String, Object> params = new HashMap<>();
+    params.put("buildStartedAt", buildCreatedAt);
+    params.put("originalBuildName", buildName);
+    params.put("requestingCi", Constants.INTEGRATIONS_TOOL_KEY);
+    params.put("reportFormat", Arrays.asList("richHtml", "basicHtml"));
+    params.put("requestType", RquestTypeForJenkins);
+    params.put("userTimeout", DEFAULT_REPORT_TIMEOUT);
+    return params;
+  }
+
+  private RequestBody createRequestBody(Map<String, Object> params) {
+    Gson gson = new Gson();
+    String json = gson.toJson(params);
+    return RequestBody.create(MediaType.parse("application/json"), json);
+  }
+
+  private void handleResponse(Response response) throws Exception {
+    if (response.isSuccessful()) {
+      processSuccessfulResponse(response);
+    } else {
+      if(!isReportTestAvailable()) {
+        if (response.code() == 429) {
+          reportStatus = RATE_LIMIT;
+        } else {
+          reportStatus = REPORT_FAILED;
+          logError(logger, "Non-success response while fetching report: " + response.code());
+        }
+      }
+    }
+  }
+
+  private void processSuccessfulResponse(Response response) throws Exception {
+    assert response.body() != null;
+    JSONObject reportResponse = new JSONObject(response.body().string());
+    String responseReportStatus = reportResponse.optString("reportStatus");
+    JSONObject report = reportResponse.optJSONObject("report");
+
+    switch (responseReportStatus.toUpperCase()) {
+      case "COMPLETED":
+      case "NOT_AVAILABLE":
+        setReportSuccess(report);
+        break;
+      case "IN_PROGRESS":
+        reportStatus = REPORT_IN_PROGRESS;
+        break;
+      case "TEST_AVAILABLE":
+        setReportSuccess(report);
+        reportStatus = TEST_AVAILABLE;
+        break;
+      default:
+        reportStatus = REPORT_FAILED;
+    }
+  }
+
+  private void setReportSuccess(JSONObject report) {
+    String defaultHTML = "<h1>No Report Found</h1>";
+    reportStatus = SUCCESS_REPORT;
+    reportHtml = report != null ? report.optString("richHtml", defaultHTML) : defaultHTML;
+    reportStyle = report != null ? report.optString("richCss", "") : "";
+
+    try {
+      String basicHtml = report != null ? report.optString("basicHtml", defaultHTML) : defaultHTML;
+      String fullHtml = "<!DOCTYPE html> <html><head> <head>" + basicHtml + "</html>";
+
+      // Save the HTML content to a file in the workspace
+      FilePath workspace = new FilePath(run.getRootDir()).getParent();
+      ArtifactArchiver artifactArchiver = getArtifactArchiver(workspace, fullHtml);
+      artifactArchiver.perform(run, workspace, new EnvVars(), null, TaskListener.NULL);
+    } catch (Exception e) {
+      logError(logger, "Failed to save or archive report artifact: " + e.getMessage());
+    }
+  }
+
+  private static ArtifactArchiver getArtifactArchiver(FilePath workspace, String fullHtml) throws IOException, InterruptedException {
+    FilePath artifactsDir = new FilePath(workspace, Constants.BROWSERSTACK_REPORT_FOLDER);
+    artifactsDir.mkdirs();
+    String htmlFileName = Constants.BROWSERSTACK_REPORT_FILENAME + ".html";
+
+    FilePath htmlFile = new FilePath(artifactsDir, htmlFileName);
+
+    htmlFile.write(fullHtml, "UTF-8");
+    String artifactFilePath = Constants.BROWSERSTACK_REPORT_FOLDER + "/" + htmlFileName;
+    // Archive the file as an artifact
+    ArtifactArchiver artifactArchiver = new ArtifactArchiver(artifactFilePath);
+    artifactArchiver.setAllowEmptyArchive(false);
+    return artifactArchiver;
+  }
+
+  private void handleFetchException(Exception e) {
+    reportStatus = RETRY_REPORT;
+    maxRetryReportAttempt--;
+    if (maxRetryReportAttempt < 0) {
+      reportStatus = REPORT_FAILED;
+    }
+    logError(logger, "Exception while fetching the report: " + Arrays.toString(e.getStackTrace()));
+  }
+
+  public boolean isReportInProgress() {
+    return reportStatus.equals(REPORT_IN_PROGRESS);
+  }
+
+  public boolean isReportFailed() {
+    return reportStatus.equals(REPORT_FAILED);
+  }
+
+  public boolean reportRetryRequired() {
+    return reportStatus.equals(RETRY_REPORT);
+  }
+
+  public boolean isUserRateLimited() {
+    return reportStatus.equals(RATE_LIMIT);
+  }
+
+  public boolean isReportAvailable() {
+    return reportStatus.equals(SUCCESS_REPORT) || reportStatus.equals(TEST_AVAILABLE);
+  }
+
+  public boolean isReportTestAvailable() {
+    return reportStatus.equals(TEST_AVAILABLE);
+  }
+
+  public boolean reportHasStatus() {
+    return !reportStatus.isEmpty() && (reportStatus.equals(REPORT_IN_PROGRESS) || reportStatus.equals(REPORT_FAILED));
+  }
+
+  public Run<?, ?> getBuild() {
+    return run;
+  }
+
+  public void setBuild(Run<?, ?> build) {
+    this.run = build;
+  }
+
+  @Override
+  public String getIconFileName() {
+    return Constants.BROWSERSTACK_LOGO;
+  }
+
+  @Override
+  public String getDisplayName() {
+    return Constants.BROWSERSTACK_REPORT_DISPLAY_NAME;
+  }
+
+  @Override
+  public String getUrlName() {
+    return Constants.BROWSERSTACK_TEST_REPORT_URL;
+  }
+}

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

@@ -0,0 +1,101 @@
+package com.browserstack.automate.ci.jenkins.integrationService;
+
+import com.browserstack.automate.ci.common.BrowserStackEnvVars;
+import com.browserstack.automate.ci.common.constants.Constants;
+import com.browserstack.automate.ci.jenkins.BrowserStackBuildAction;
+import com.browserstack.automate.ci.jenkins.BrowserStackCredentials;
+import edu.umd.cs.findbugs.annotations.NonNull;
+import hudson.EnvVars;
+import hudson.Extension;
+import hudson.model.AbstractProject;
+import hudson.model.Run;
+import hudson.model.TaskListener;
+import hudson.tasks.BuildStepDescriptor;
+import hudson.tasks.BuildStepMonitor;
+import hudson.tasks.Publisher;
+import hudson.tasks.Recorder;
+import hudson.FilePath;
+import hudson.Launcher;
+import jenkins.tasks.SimpleBuildStep;
+import org.jenkinsci.Symbol;
+import org.kohsuke.stapler.DataBoundConstructor;
+
+import javax.annotation.CheckForNull;
+import java.io.IOException;
+import java.io.PrintStream;
+import java.util.*;
+import java.util.concurrent.ConcurrentHashMap;
+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 Map<String, String> customEnvVars;
+
+  @DataBoundConstructor
+  public BrowserStackTestReportPublisher(@CheckForNull String product) {
+    this.customEnvVars =  new ConcurrentHashMap<>();
+  }
+
+  @Override
+  public void perform(Run<?, ?> build, @NonNull FilePath workspace, @NonNull Launcher launcher, TaskListener listener) throws IOException, InterruptedException {
+    final PrintStream logger = listener.getLogger();
+    log(logger, "Adding BrowserStack Report");
+
+    EnvVars parentEnvs = build.getEnvironment(listener);
+    parentEnvs.putAll(getCustomEnvVars());
+
+    String browserStackBuildName = Optional.ofNullable(parentEnvs.get(BrowserStackEnvVars.BROWSERSTACK_BUILD_NAME))
+            .orElse(parentEnvs.get(Constants.JENKINS_BUILD_TAG));
+
+    BrowserStackBuildAction buildAction = build.getAction(BrowserStackBuildAction.class);
+    if (buildAction == null || buildAction.getBrowserStackCredentials() == null) {
+      logError(logger, "No BrowserStackBuildAction or credentials found");
+      return;
+    }
+
+    BrowserStackCredentials credentials = buildAction.getBrowserStackCredentials();
+
+    LOGGER.info("Adding BrowserStack Report Action");
+
+
+    Date buildTimestamp = new Date(build.getStartTimeInMillis());
+
+    // Format the timestamp (e.g., YYYY-MM-DD HH:MM:SS)
+    long unixTimestamp = buildTimestamp.getTime() / 1000;
+
+    String buildCreatedAt = String.valueOf(unixTimestamp);
+
+    build.addAction(new BrowserStackTestReportAction(build, credentials, browserStackBuildName,buildCreatedAt, logger));
+
+  }
+
+
+  public Map<String, String> getCustomEnvVars() {
+    return customEnvVars;
+  }
+
+  @Override
+  public BuildStepMonitor getRequiredMonitorService() {
+    return BuildStepMonitor.NONE;
+  }
+
+  @Symbol(Constants.BROWSERSTACK_REPORT_PIPELINE_FUNCTION)
+  @Extension
+  public static final class DescriptorImpl extends BuildStepDescriptor<Publisher> {
+
+    @Override
+    @SuppressWarnings("rawtypes")
+    public boolean isApplicable(Class<? extends AbstractProject> aClass) {
+      // indicates that this builder can be used with all kinds of project types
+      return true;
+    }
+    @Override
+    public String getDisplayName() {
+      return Constants.BROWSERSTACK_CAD_REPORT_DISPLAY_NAME;
+    }
+
+  }
+}