replacing old automate report with new Cad reports

shandli123 · shandli123 · commit 76981eb46be8 · 2025-06-24T19:05:16.000+05:30
diff --git a/src/main/java/com/browserstack/automate/ci/common/constants/Constants.java b/src/main/java/com/browserstack/automate/ci/common/constants/Constants.java
@@ -19,10 +19,13 @@ public class Constants {
     public static  final String BROWSERSTACK_CONFIG_DETAILS_ENDPOINT = "/v1/builds/buildReport";
 
     public static final String INTEGRATIONS_TOOL_KEY = "jenkins";
-    public static  final String REPORT_FORMAT = "richHtml";
 
     public static final String BROWSERSTACK_TEST_REPORT_URL = "testReportBrowserStack";
-    public static final String BROWSERSTACK_CAD_REPORT_DISPLAY_NAME = "BrowserStack Build Test Reports";
+    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";
diff --git a/src/main/java/com/browserstack/automate/ci/jenkins/integrationService/BrowserStackTestReportAction.java b/src/main/java/com/browserstack/automate/ci/jenkins/integrationService/BrowserStackTestReportAction.java
@@ -3,11 +3,16 @@
 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;
@@ -93,7 +98,7 @@ private Map<String, Object> createReportParams() {
     params.put("buildStartedAt", buildCreatedAt);
     params.put("originalBuildName", buildName);
     params.put("requestingCi", Constants.INTEGRATIONS_TOOL_KEY);
-    params.put("reportFormat", Arrays.asList(Constants.REPORT_FORMAT));
+    params.put("reportFormat", Arrays.asList("richHtml", "basicHtml"));
     params.put("requestType", RquestTypeForJenkins);
     params.put("userTimeout", DEFAULT_REPORT_TIMEOUT);
     return params;
@@ -148,6 +153,33 @@ private void setReportSuccess(JSONObject report) {
     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) {
@@ -202,7 +234,7 @@ public String getIconFileName() {
 
   @Override
   public String getDisplayName() {
-    return Constants.BROWSERSTACK_CAD_REPORT_DISPLAY_NAME;
+    return Constants.BROWSERSTACK_REPORT_DISPLAY_NAME;
   }
 
   @Override
diff --git a/src/main/java/com/browserstack/automate/ci/jenkins/integrationService/BrowserStackTestReportPublisher.java b/src/main/java/com/browserstack/automate/ci/jenkins/integrationService/BrowserStackTestReportPublisher.java
@@ -20,10 +20,9 @@
 import org.jenkinsci.Symbol;
 import org.kohsuke.stapler.DataBoundConstructor;
 
+import javax.annotation.CheckForNull;
 import java.io.IOException;
 import java.io.PrintStream;
-import java.net.URLEncoder;
-import java.text.SimpleDateFormat;
 import java.util.*;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.logging.Logger;
@@ -33,11 +32,11 @@
 
 public class BrowserStackTestReportPublisher extends Recorder implements SimpleBuildStep {
   private static final Logger LOGGER = Logger.getLogger(BrowserStackTestReportPublisher.class.getName());
-  private final Map<String, String> customEnvVars;
+  private Map<String, String> customEnvVars;
 
   @DataBoundConstructor
-  public BrowserStackTestReportPublisher(Map<String, String> customEnvVars) {
-    this.customEnvVars = customEnvVars != null && !customEnvVars.isEmpty() ? new ConcurrentHashMap<>(customEnvVars) : new ConcurrentHashMap<>();
+  public BrowserStackTestReportPublisher(@CheckForNull String product) {
+    this.customEnvVars =  new ConcurrentHashMap<>();
   }
 
   @Override
@@ -83,7 +82,7 @@ public BuildStepMonitor getRequiredMonitorService() {
     return BuildStepMonitor.NONE;
   }
 
-  @Symbol("browserStackBuildTestReports")
+  @Symbol(Constants.BROWSERSTACK_REPORT_PIPELINE_FUNCTION)
   @Extension
   public static final class DescriptorImpl extends BuildStepDescriptor<Publisher> {
 
@@ -93,7 +92,6 @@ 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;
diff --git a/src/main/java/com/browserstack/automate/ci/jenkins/pipeline/BrowserStackReportStep.java b/src/main/java/com/browserstack/automate/ci/jenkins/pipeline/BrowserStackReportStep.java
@@ -47,7 +47,7 @@ public Set<? extends Class<?>> getRequiredContext() {
 
         @Override
         public String getFunctionName() {
-            return Constants.BROWSERSTACK_REPORT_PIPELINE_FUNCTION;
+            return Constants.BROWSERSTACK_REPORT_AUT_PIPELINE_FUNCTION ; // deprecated Constants.BROWSERSTACK_REPORT_PIPELINE_FUNCTION;
         }
 
         @Override
diff --git a/src/main/resources/com/browserstack/automate/ci/jenkins/BrowserStackCypressReportPublisher/config.jelly b/src/main/resources/com/browserstack/automate/ci/jenkins/BrowserStackCypressReportPublisher/config.jelly
@@ -1,4 +1,6 @@
 <?jelly escape-by-default='true'?>
 <j:jelly xmlns:j="jelly:core" xmlns:f="/lib/form" xmlns:l="/lib/layout">
-    This step will generate BrowserStack Cypress Test Report by utilising the build name from the environment variable BROWSERSTACK_BUILD_NAME set by the BrowserStack plugin
+    This step will generate BrowserStack Cypress Test Report by utilising the build name from the environment variable BROWSERSTACK_BUILD_NAME set by the BrowserStack plugin.
+    <br/>
+    ⚠️ Note: This post-build action is deprecated and will no longer be supported in future releases. To continue generating test reports, please use the new BrowserStack Test Report and Insights post-build action.
 </j:jelly>
diff --git a/src/main/resources/com/browserstack/automate/ci/jenkins/BrowserStackReportPublisher/config.jelly b/src/main/resources/com/browserstack/automate/ci/jenkins/BrowserStackReportPublisher/config.jelly
@@ -1,4 +1,6 @@
 <?jelly escape-by-default='true'?>
 <j:jelly xmlns:j="jelly:core" xmlns:f="/lib/form" xmlns:l="/lib/layout">
-    This step will generate BrowserStack Test Report by utilising the build name from the environment variable BROWSERSTACK_BUILD_NAME set by the BrowserStack plugin
+    This step will generate BrowserStack Test Report by utilising the build name from the environment variable BROWSERSTACK_BUILD_NAME set by the BrowserStack plugin.
+    <br/>
+    ⚠️ Note: This post-build action is deprecated and will no longer be supported in future releases. To continue generating test reports, please use the new BrowserStack Test Report and Insights post-build action.
 </j:jelly>
diff --git a/src/main/resources/com/browserstack/automate/ci/jenkins/integrationService/BrowserStackTestReportPublisher/config.jelly b/src/main/resources/com/browserstack/automate/ci/jenkins/integrationService/BrowserStackTestReportPublisher/config.jelly
@@ -1,4 +1,4 @@
 <?jelly escape-by-default='true'?>
 <j:jelly xmlns:j="jelly:core" xmlns:f="/lib/form" xmlns:l="/lib/layout">
-    This step will generate BrowserStack Test Report by utilising the build name from the environment variable BROWSERSTACK_BUILD_NAME set by the BrowserStack plugin
+    This step will generate BrowserStack Test Report and Insights by using the build name from the environment variable BROWSERSTACK_BUILD_NAME set by the BrowserStack plugin
 </j:jelly>

Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ public Set<? extends Class<?>> getRequiredContext() {`
`47`	`47`
`48`	`48`	`@Override`
`49`	`49`	`public String getFunctionName() {`
`50`		`- return Constants.BROWSERSTACK_REPORT_PIPELINE_FUNCTION;`
	`50`	`+ return Constants.BROWSERSTACK_REPORT_AUT_PIPELINE_FUNCTION ; // deprecated Constants.BROWSERSTACK_REPORT_PIPELINE_FUNCTION;`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`@Override`