Build visulization support for pipeline (#278)

nbhoski · web-flow · commit 6265ee071c9e · 2024-01-18T14:04:10.000+05:30
diff --git a/src/main/java/com/mathworks/ci/MatlabBuildStepExecution.java b/src/main/java/com/mathworks/ci/MatlabBuildStepExecution.java
@@ -5,6 +5,10 @@
  *  
  */
 
+import hudson.model.Run;
+import hudson.util.ArgumentListBuilder;
+import java.io.ByteArrayOutputStream;
+import java.io.File;
 import java.io.IOException;
 import org.jenkinsci.plugins.workflow.steps.StepContext;
 import org.jenkinsci.plugins.workflow.steps.SynchronousNonBlockingStepExecution;
@@ -21,6 +25,9 @@ public class MatlabBuildStepExecution extends SynchronousNonBlockingStepExecutio
     
     private String tasks;
     private String startupOptions;
+    private static String DEFAULT_PLUGIN = "+ciplugins/+jenkins/getDefaultPlugins.m";
+    private static String BUILD_REPORT_PLUGIN = "+ciplugins/+jenkins/BuildReportPlugin.m";
+    private static String TASK_RUN_PROGRESS_PLUGIN = "+ciplugins/+jenkins/TaskRunProgressPlugin.m";
 
     public MatlabBuildStepExecution(StepContext context, String tasks, String startupOptions) {
         super(context);
@@ -38,12 +45,21 @@ public Void run() throws Exception {
         final FilePath workspace = getContext().get(FilePath.class);
         final TaskListener listener = getContext().get(TaskListener.class);
         final EnvVars env = getContext().get(EnvVars.class);
+        final Run<?,?> build =  getContext().get(Run.class);
         
         //Make sure the Workspace exists before run
         
         workspace.mkdirs();
+        System.out.println("THE ROOT DIR IS"+ build.getRootDir().toString());
         
-        int exitCode = execMatlabCommand(workspace, launcher, listener, env);
+        int exitCode = execMatlabCommand(workspace, launcher, listener, env, build);
+        //Add build result action
+        FilePath jsonFile = new FilePath(workspace, ".matlab/buildArtifact.json");
+        if(jsonFile.exists()){
+            jsonFile.copyTo(new FilePath(new File(build.getRootDir().getAbsolutePath()+"/buildArtifact.json")));
+            jsonFile.delete();
+        }
+        build.addAction(new BuildArtifactAction(build, workspace));
 
         if(exitCode != 0){
             // throw an exception if return code is non-zero
@@ -60,20 +76,26 @@ public void stop(Throwable cause) throws Exception {
     }
     
     private int execMatlabCommand(FilePath workspace, Launcher launcher,
-            TaskListener listener, EnvVars envVars) throws IOException, InterruptedException {
+            TaskListener listener, EnvVars envVars, Run<?,?> build) throws IOException, InterruptedException {
         final String uniqueTmpFldrName = getUniqueNameForRunnerFile();  
         final String uniqueBuildFile =
                 "build_" + getUniqueNameForRunnerFile().replaceAll("-", "_");
         final FilePath uniqueTmpFolderPath =
                 getFilePathForUniqueFolder(launcher, uniqueTmpFldrName, workspace);
 
         // Create MATLAB script
-        createMatlabScriptByName(uniqueTmpFolderPath, uniqueBuildFile, listener);
+        createMatlabScriptByName(uniqueTmpFolderPath, uniqueBuildFile, listener, envVars);
+
+        // Copy JenkinsLogging plugin in temp folder
+        copyFileInWorkspace(DEFAULT_PLUGIN,DEFAULT_PLUGIN,uniqueTmpFolderPath);
+        copyFileInWorkspace(BUILD_REPORT_PLUGIN,BUILD_REPORT_PLUGIN,uniqueTmpFolderPath);
+        copyFileInWorkspace(TASK_RUN_PROGRESS_PLUGIN,TASK_RUN_PROGRESS_PLUGIN,uniqueTmpFolderPath);
+
         ProcStarter matlabLauncher;
 
-        try {
-            matlabLauncher = getProcessToRunMatlabCommand(workspace, launcher, listener, envVars,
-                    "setenv('MW_ORIG_WORKING_FOLDER', cd('"+ uniqueTmpFolderPath.getRemote().replaceAll("'", "''") +"')); "+ uniqueBuildFile, startupOptions, uniqueTmpFldrName);
+        try (BuildConsoleAnnotator bca = new BuildConsoleAnnotator(listener.getLogger(), build.getCharset())) {
+            matlabLauncher = getProcessToRunMatlabCommand(workspace, launcher, bca, envVars,
+                    "setenv('MW_ORIG_WORKING_FOLDER', cd('"+ uniqueTmpFolderPath.getRemote().replaceAll("'", "''") +"'));"+ uniqueBuildFile, startupOptions, uniqueTmpFldrName);
             listener.getLogger()
                     .println("#################### Starting command output ####################");
             return matlabLauncher.pwd(workspace).join();
@@ -86,24 +108,80 @@ private int execMatlabCommand(FilePath workspace, Launcher launcher,
         }
     }
     
-    private void createMatlabScriptByName(FilePath uniqueTmpFolderPath, String uniqueScriptName, TaskListener listener) throws IOException, InterruptedException {
+    private void createMatlabScriptByName(FilePath uniqueTmpFolderPath, String uniqueScriptName, TaskListener listener, EnvVars envVars) throws IOException, InterruptedException {
 
         // Create a new command runner script in the temp folder.
         final FilePath matlabBuildFile =
                 new FilePath(uniqueTmpFolderPath, uniqueScriptName + ".m");
         final String tasks = getContext().get(EnvVars.class).expand(getTasks());
+
+        // Set ENV variable to override the default plugin list
+        envVars.put("MW_MATLAB_BUILDTOOL_DEFAULT_PLUGINS_FCN_OVERRIDE", "ciplugins.jenkins.getDefaultPlugins");
         String cmd = "buildtool";
 
         if (!tasks.trim().isEmpty()) {
             cmd += " " + tasks;
         }
         final String matlabBuildFileContent =
-                "cd(getenv('MW_ORIG_WORKING_FOLDER'));\n" + cmd;
+                "addpath(pwd);cd(getenv('MW_ORIG_WORKING_FOLDER'));\n" + cmd;
 
         // Display the commands on console output for users reference
         listener.getLogger()
                 .println("Generating MATLAB script with content:\n" + cmd + "\n");
 
         matlabBuildFile.write(matlabBuildFileContent, "UTF-8");
     }
+
+    public ProcStarter getProcessToRunMatlabCommand(FilePath workspace,
+                                                    Launcher launcher, BuildConsoleAnnotator bca, EnvVars envVars, String matlabCommand, String startupOpts, String uniqueName)
+            throws IOException, InterruptedException {
+        // Get node specific temp .matlab directory to copy matlab runner script
+        FilePath targetWorkspace;
+        ProcStarter matlabLauncher;
+        ArgumentListBuilder args = new ArgumentListBuilder();
+        if (launcher.isUnix()) {
+            targetWorkspace = new FilePath(launcher.getChannel(),
+                    workspace.getRemote() + "/" + MatlabBuilderConstants.TEMP_MATLAB_FOLDER_NAME);
+
+            // Determine whether we're on Mac on Linux
+            ByteArrayOutputStream kernelStream = new ByteArrayOutputStream();
+            launcher.launch()
+                    .cmds("uname")
+                    .masks(true)
+                    .stdout(kernelStream)
+                    .join();
+
+            String binaryName;
+            String runnerName = uniqueName + "/run-matlab-command";
+            if (kernelStream.toString("UTF-8").contains("Linux")) {
+                binaryName = "glnxa64/run-matlab-command";
+            } else {
+                binaryName = "maci64/run-matlab-command";
+            }
+
+            args.add(MatlabBuilderConstants.TEMP_MATLAB_FOLDER_NAME + "/" + runnerName);
+            args.add(matlabCommand);
+            args.add(startupOpts.split(" "));
+
+            matlabLauncher = launcher.launch().envs(envVars).cmds(args).stdout(bca);
+
+            // Copy runner for linux platform in workspace.
+            copyFileInWorkspace(binaryName, runnerName, targetWorkspace);
+        } else {
+            targetWorkspace = new FilePath(launcher.getChannel(),
+                    workspace.getRemote() + "\\" + MatlabBuilderConstants.TEMP_MATLAB_FOLDER_NAME);
+
+            final String runnerName = uniqueName + "\\run-matlab-command.exe";
+
+            args.add(targetWorkspace.toString() + "\\" + runnerName, "\"" + matlabCommand + "\"");
+            args.add(startupOpts.split(" "));
+
+            matlabLauncher = launcher.launch().envs(envVars).cmds(args).stdout(bca);
+
+            // Copy runner for Windows platform in workspace.
+            copyFileInWorkspace("win64/run-matlab-command.exe", runnerName,
+                    targetWorkspace);
+        }
+        return matlabLauncher;
+    }
 }
diff --git a/src/main/java/com/mathworks/ci/RunMatlabBuildBuilder.java b/src/main/java/com/mathworks/ci/RunMatlabBuildBuilder.java
@@ -139,7 +139,7 @@ private int execMatlabCommand(FilePath workspace, Launcher launcher,
         BuildConsoleAnnotator bca = new BuildConsoleAnnotator(listener.getLogger(), build.getCharset());
         String options = getStartupOptions() == null ? "" : getStartupOptions().getOptions();
         try {
-            matlabLauncher = getProcessToRunMatlabCommand(workspace, launcher, listener, envVars,
+            matlabLauncher = getProcessToRunMatlabCommand(workspace, launcher, bca, envVars,
                     "setenv('MW_ORIG_WORKING_FOLDER', cd('"+ uniqueTmpFolderPath.getRemote().replaceAll("'", "''") +"'));"+ uniqueBuildFile, options, uniqueTmpFldrName);
 
             
@@ -152,7 +152,6 @@ private int execMatlabCommand(FilePath workspace, Launcher launcher,
             return 1;
         } finally {
             bca.forceEol();
-            bca.close();
             // Cleanup the tmp directory
             if (uniqueTmpFolderPath.exists()) {
                 uniqueTmpFolderPath.deleteRecursive();
@@ -186,7 +185,8 @@ private void createMatlabScriptByName(FilePath uniqueTmpFolderPath, String uniqu
         matlabCommandFile.write(matlabCommandFileContent, "UTF-8");
     }
 
-    public ProcStarter getProcessToRunMatlabCommand(FilePath workspace,
+
+    private ProcStarter getProcessToRunMatlabCommand(FilePath workspace,
                                                     Launcher launcher, BuildConsoleAnnotator bca, EnvVars envVars, String matlabCommand, String startupOpts, String uniqueName)
             throws IOException, InterruptedException {
         // Get node specific temp .matlab directory to copy matlab runner script
diff --git a/src/main/resources/com/mathworks/ci/BuildArtifactAction/index.jelly b/src/main/resources/com/mathworks/ci/BuildArtifactAction/index.jelly
@@ -59,14 +59,14 @@
                 <j:forEach var="p" items="${it.buildArtifact}" varStatus="status">
                     <tr>
                         <td class="pane" align="left">
-                            <a href="../console#matlab-${p.taskName}">${p.taskName}</a>
+                            <a href="../console#matlab-${p.taskName}]">${p.taskName}</a>
                         </td>
                         <td class="pane" style="width:9em">
                             <span class="${pst.cssClass}">
-                                <j:if test="${p.taskStatus != false}">
-                                    <a href="../console#matlab-${p.taskName}"><font color="#EF2929"> FAILED </font> </a>
+                                <j:if test="${p.taskFailed != false}">
+                                    <a href="../console#matlab-${p.taskName}]"><font color="#EF2929"> FAILED </font> </a>
                                 </j:if>
-                                <j:if test="${p.taskStatus == false}">
+                                <j:if test="${p.taskFailed == false}">
                                     <j:if test="${p.taskSkipped == false}">
                                         <font color="#729FCF"> PASSED </font>
                                     </j:if>
@@ -78,7 +78,7 @@
                         </td>
                         <td class="pane" style="width:10em">
                             <span class="${pst.cssClass}">
-                                ${p.description}
+                                ${p.taskDescription}
                             </span>
                         </td>
                         <td class="pane no-wrap" style="width:6em" data="${p.duration}"> ${p.taskDuration}</td>
