Add skip reason for skipped tasks in build results table (#356)

mw-kapilg · web-flow · commit 8afb9e21f2a6 · 2024-09-05T09:40:26.000+05:30
* Add skipReason in build results table

* add skip reason texts

* add test and bump Maven task

* remove .idea from gitignore in this branch

* update as per review comments

* update as per review

* update function name

* update build results table

* update test

* update skip link

* update status to succeeded

* update data constructor
diff --git a/azure-pipelines.yml b/azure-pipelines.yml
@@ -19,7 +19,7 @@ trigger:
   - master
 
 steps:
-  - task: Maven@3
+  - task: Maven@4
     inputs:
       mavenPomFile: 'pom.xml'
       mavenOptions: '-Xmx3072m -Dmaven.javadoc.skip=true'
diff --git a/src/main/java/com/mathworks/ci/BuildArtifactAction.java b/src/main/java/com/mathworks/ci/BuildArtifactAction.java
@@ -206,7 +206,7 @@ private void setCounts() throws InterruptedException, ParseException {
     private void iterateAllTaskAttributes(Entry pair, BuildArtifactData data) {
         // Iterates across all task attributes and updates
         String key = pair.getKey().toString();
-        switch(key.toLowerCase()){
+        switch(key){
             case "duration":
                 data.setTaskDuration(pair.getValue().toString());
                 break;
@@ -222,6 +222,26 @@ private void iterateAllTaskAttributes(Entry pair, BuildArtifactData data) {
             case "skipped":
                 data.setTaskSkipped((Boolean) pair.getValue());
                 break;
+            case "skipReason":
+                String skipReasonKey = pair.getValue().toString();
+                String skipReason;
+                switch(skipReasonKey){
+                    case "UpToDate":
+                        skipReason = "up-to-date";
+                        break;
+                    case "UserSpecified":
+                    case "UserRequested":
+                        skipReason = "user requested";
+                        break;
+                    case "DependencyFailed":
+                        skipReason = "dependency failed";
+                        break;
+                    default:
+                        skipReason = skipReasonKey;
+                        break;
+                }
+                data.setSkipReason(skipReason);
+                break;
             default :
                 break;
         }
diff --git a/src/main/java/com/mathworks/ci/BuildArtifactData.java b/src/main/java/com/mathworks/ci/BuildArtifactData.java
@@ -13,6 +13,7 @@ public class BuildArtifactData {
 
     private String taskDescription;
     private boolean taskSkipped;
+    private String skipReason;
 
     public BuildArtifactData() {
     }
@@ -41,6 +42,14 @@ public void setTaskSkipped(boolean taskSkipped) {
         this.taskSkipped = taskSkipped;
     }
 
+    public String getSkipReason() {
+        return (this.skipReason == null) ? "" : this.skipReason;
+    }
+
+    public void setSkipReason(String skipReason) {
+        this.skipReason = skipReason;
+    }
+
     public boolean getTaskFailed() {
         return this.taskFailed;
     }
diff --git a/src/main/resources/+ciplugins/+jenkins/BuildReportPlugin.m b/src/main/resources/+ciplugins/+jenkins/BuildReportPlugin.m
@@ -2,27 +2,48 @@
 
 %   Copyright 2024 The MathWorks, Inc.
 
-    methods (Access=protected)
+    properties
+        TaskDetails = {};
+    end
 
+    methods (Access=protected)
         function runTaskGraph(plugin, pluginData)
             runTaskGraph@matlab.buildtool.plugins.BuildRunnerPlugin(plugin, pluginData);
+
             [fID, msg] = fopen(fullfile(getenv("MW_MATLAB_TEMP_FOLDER"),"buildArtifact.json"), "w");
             if fID == -1
                 warning("ciplugins:jenkins:BuildReportPlugin:UnableToOpenFile","Could not open a file for Jenkins build result table due to: %s", msg);
             else
                 closeFile = onCleanup(@()fclose(fID));
-                taskDetails = struct();
-                for idx = 1:numel(pluginData.TaskResults)
-                    taskDetails(idx).name = pluginData.TaskResults(idx).Name;
-                    taskDetails(idx).description = pluginData.TaskGraph.Tasks(idx).Description;
-                    taskDetails(idx).failed = pluginData.TaskResults(idx).Failed;
-                    taskDetails(idx).skipped = pluginData.TaskResults(idx).Skipped;
-                    taskDetails(idx).duration = string(pluginData.TaskResults(idx).Duration);
-                end
-                a = struct("taskDetails",taskDetails);
-                s = jsonencode(a,PrettyPrint=true);
-                fprintf(fID, "%s",s);
+                a = struct();
+                a.taskDetails = plugin.TaskDetails;
+                s = jsonencode(a, PrettyPrint=true);
+                fprintf(fID, "%s", s);
             end
         end
+
+        function runTask(plugin, pluginData)
+            runTask@matlab.buildtool.plugins.BuildRunnerPlugin(plugin, pluginData);
+
+            taskDetail = getCommonTaskDetail(pluginData);
+            plugin.TaskDetails = [plugin.TaskDetails, taskDetail];
+        end
+
+        function skipTask(plugin, pluginData)
+            skipTask@matlab.buildtool.plugins.BuildRunnerPlugin(plugin, pluginData);
+
+            taskDetail = getCommonTaskDetail(pluginData);
+            taskDetail.skipReason = pluginData.SkipReason;
+            plugin.TaskDetails = [plugin.TaskDetails, taskDetail];
+        end
     end
 end
+
+function taskDetail = getCommonTaskDetail(pluginData)
+    taskDetail = struct();
+    taskDetail.name = pluginData.TaskResults.Name;
+    taskDetail.description = pluginData.TaskGraph.Tasks.Description;
+    taskDetail.failed = pluginData.TaskResults.Failed;
+    taskDetail.skipped = pluginData.TaskResults.Skipped;
+    taskDetail.duration = string(pluginData.TaskResults.Duration);
+end
diff --git a/src/main/resources/com/mathworks/ci/BuildArtifactAction/index.jelly b/src/main/resources/com/mathworks/ci/BuildArtifactAction/index.jelly
@@ -1,4 +1,3 @@
-
 <?jelly escape-by-default='true'?>
 <j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:d="jelly:define"
   xmlns:l="/lib/layout" xmlns:t="/lib/hudson" xmlns:f="/lib/form" xmlns:r="/lib/hudson/test" xmlns:p="/lib/test">
@@ -23,20 +22,20 @@
                             (${h.getDiffString(it.failCount-prev.failCount)})
                         </j:if>
                         <j:if test="${it.skipCount > 0}">
-                            , Skipped ${(it.skipCount)}
+                            , ${(it.skipCount)} Skipped
                             <j:if test="${prev!=null}">
                                 (${h.getDiffString(it.skipCount-prev.skipCount)})
                             </j:if>
                         </j:if>
                     </div>
-                    <div style="width:100%; height:1em; background-color: #729FCF; border-radius: 6px; overflow: hidden;">
+                    <div style="width:100%; height:1em; background-color: mediumseagreen; border-radius: 6px; overflow: hidden;">
                         <!-- Failed task part of the bar. -->
-                        <div style="width:${it.failCount*100/it.totalCount}%; height: 1em; background-color: #EF2929; float: right;"></div>
+                        <div style="width:${it.failCount*100/it.totalCount}%; height: 1em; background-color: crimson; float: right;"></div>
                         <!-- Skipped task part of the bar. -->
-                        <div style="width:${it.skipCount*100/it.totalCount}%; height: 1em; background-color: #FCE94F; float: right;"></div>
+                        <div style="width:${it.skipCount*100/it.totalCount}%; height: 1em; background-color: steelblue; float: right;"></div>
                     </div>
                     <div align="right">
-                        ${(it.failCount)} Failures
+                        ${(it.failCount)} Failed
                         <j:if test="${prev!=null}">
                             (${h.getDiffString(it.totalCount-prev.totalCount)})
                         </j:if>
@@ -48,10 +47,10 @@
         <table class="jenkins-table sortable" id="buildresults">
             <thead>
                 <tr>
-                    <th class="pane-header" style="width:6em">Task Name</th>
+                    <th class="pane-header" style="width:6em" tooltip="Task name">Task</th>
                     <th class="pane-header" style="width:6em">Status </th>
                     <th class="pane-header">Description</th>
-                    <th class="pane-header" style="width:6em">Duration (HH:MM:SS)</th>
+                    <th class="pane-header" style="width:6em">Duration (HH:mm:ss)</th>
                 </tr>
             </thead>
 
@@ -66,28 +65,25 @@
                                 <a href="../console#matlab-${p.taskName}">${p.taskName}</a>
                             </j:if>
                         </td>
-                        <td class="pane" style="width:9em">
+                        <td class="pane no-wrap" style="width:auto">
                             <span class="${pst.cssClass}">
                                 <j:if test="${p.taskFailed != false}">
-                                   <j:if test="${it.actionID != ''}">
-                                       <a href="../console#matlab-${p.taskName}-${it.actionID}"><font color="#EF2929"> FAILED </font> </a>
-                                   </j:if>
-                                   <j:if test="${it.actionID == ''}">
-                                       <a href="../console#matlab-${p.taskName}"><font color="#EF2929"> FAILED </font> </a>
-                                   </j:if>
+                                        <a href="../console#matlab-${p.taskName}${it.actionID != '' ? '-' + it.actionID : ''}" style="color: crimson;">
+                                            Failed 
+                                        </a>
                                 </j:if>
                                 <j:if test="${p.taskFailed == false}">
                                     <j:if test="${p.taskSkipped == false}">
-                                        <font color="#729FCF"> PASSED </font>
+                                        <font color="mediumseagreen"> Succeeded </font>
                                     </j:if>
                                 </j:if>
                                 <j:if test="${p.taskSkipped == true}">
-                                    <j:if test="${it.actionID != ''}">
-                                       <a href="../console#matlab-${p.taskName}-${it.actionID}"><font color="#FCE94F"> SKIPPED </font> </a>
-                                   </j:if>
-                                   <j:if test="${it.actionID == ''}">
-                                       <a href="../console#matlab-${p.taskName}"><font color="#FCE94F"> SKIPPED </font> </a>
-                                   </j:if>
+                                        <a href="../console#matlab-${p.taskName}${it.actionID != '' ? '-' + it.actionID : ''}" style="color: steelblue;">
+                                             Skipped 
+                                            <j:if test="${p.skipReason != ''}">
+                                                (${p.skipReason})
+                                            </j:if>
+                                        </a>
                                 </j:if>
                             </span>
                         </td>
diff --git a/src/main/resources/com/mathworks/ci/BuildArtifactAction/summary.jelly b/src/main/resources/com/mathworks/ci/BuildArtifactAction/summary.jelly
@@ -9,18 +9,15 @@
     <p><a href="${it.urlName}">MATLAB Build Results</a></p>
     <span class="${pst.cssClass}">
       <j:if test="${it.totalCount == 0}">
-        <font color="#EF2929"><h5>Unable to generate a build artifact. </h5></font>
+        <font color="crimson"><h5>Unable to generate a build artifact. </h5></font>
       </j:if>
     </span>
-    <p>
-      <b>Tasks run: <font color="Blue">${it.totalCount}</font></b>
-      <br></br>
-      <br>
-      <b>Failed: <font color="red">${it.failCount}</font></b>
-      </br>
-      <br>
-      <b>Skipped: <font color="orange">${it.skipCount}</font></b>
-      </br>
-    </p>
+    <p><b>Tasks run: <font color="mediumseagreen">${it.totalCount}</font></b></p>
+    <br>
+    <b>Failed: <font color="crimson">${it.failCount}</font></b>
+    </br>
+    <br>
+    <b>Skipped: <font color="steelblue">${it.skipCount}</font></b>
+    </br>
   </t:summary>
 </j:jelly>
diff --git a/src/main/resources/com/mathworks/ci/MatlabBuilder/config.jelly b/src/main/resources/com/mathworks/ci/MatlabBuilder/config.jelly
@@ -1,7 +1,7 @@
 <?jelly escape-by-default='true'?>
 <j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:d="jelly:define" xmlns:l="/lib/layout" xmlns:t="/lib/hudson" xmlns:f="/lib/form">
 
- <font color="red">Using this build step is not recommended and will be removed in a feature release. Use “Run MATLAB Tests” or “Run MATLAB Command” instead.</font>   
+ <font color="crimson">Using this build step is not recommended and will be removed in a feature release. Use “Run MATLAB Tests” or “Run MATLAB Command” instead.</font>   
  <f:section>
 	  <f:entry title="MATLAB root " field="matlabRoot">
 	        <f:textbox disabled="disabled" checkMethod="post" />
diff --git a/src/test/java/integ/com/mathworks/ci/BuildArtifactActionTest.java b/src/test/java/integ/com/mathworks/ci/BuildArtifactActionTest.java
@@ -100,7 +100,7 @@ public void verifyFailedCount() throws ExecutionException, InterruptedException,
         copyFileInWorkspace("buildArtifacts/t1/buildArtifact.json",targetFile,artifactRoot);
         List<BuildArtifactData> ba = ac.getBuildArtifact();
         boolean expectedStatus = ba.get(0).getTaskFailed();
-        Assert.assertEquals("The task is passed",false,expectedStatus);
+        Assert.assertEquals("The task succeeded",false,expectedStatus);
     }
 
     /**
@@ -120,6 +120,24 @@ public void verifySkipCount() throws ExecutionException, InterruptedException, U
         Assert.assertEquals("The task is not skipped",true,ba.get(0).getTaskSkipped());
     }
 
+    /**
+     *  Verify if skip reason is returned from artifact file.
+     *
+     */
+
+    @Test
+    public void verifySkipReasonIsAccurate() throws ExecutionException, InterruptedException, URISyntaxException, IOException, ParseException {
+        FreeStyleBuild build = getFreestyleBuild();
+        final String actionID = "abc123";
+        final String targetFile = "buildArtifact"+ actionID + ".json";
+        BuildArtifactAction ac = new BuildArtifactAction(build, actionID);
+        FilePath artifactRoot = new FilePath(build.getRootDir());
+        copyFileInWorkspace("buildArtifacts/t2/buildArtifact.json",targetFile,artifactRoot);
+        List<BuildArtifactData> ba = ac.getBuildArtifact();
+        Assert.assertEquals("The task is not skipped",true,ba.get(0).getTaskSkipped());
+        Assert.assertEquals("The skip reason for skipped task is inaccurate","user requested",ba.get(0).getSkipReason());
+    }
+
     /**
      *  Verify if duration returned from artifact file.
      *
@@ -219,6 +237,7 @@ public void verifyTotalFailedTaskCountIsAccurate() throws ExecutionException, In
         Assert.assertEquals("Total task count is not correct",3,ac.getTotalCount());
         Assert.assertEquals("Total task failed count is not correct",1,ac.getFailCount());
     }
+    
     /**
      *  Verify if total skipped count returned from artifact file.
      *
diff --git a/src/test/resources/buildArtifacts/t1/buildArtifact.json b/src/test/resources/buildArtifacts/t1/buildArtifact.json
@@ -19,6 +19,7 @@
       "description": "tests Dscription",
       "failed": false,
       "skipped": true,
+      "skipReason": "UserSpecified",
       "duration": "00:00:00"
     }
   ]
diff --git a/src/test/resources/buildArtifacts/t2/buildArtifact.json b/src/test/resources/buildArtifacts/t2/buildArtifact.json
@@ -4,6 +4,7 @@
     "description": "Test show",
     "failed": false,
     "skipped": true,
+    "skipReason": "UserSpecified",
     "duration": "00:02:53"
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@ public class BuildArtifactData {`
`13`	`13`
`14`	`14`	`private String taskDescription;`
`15`	`15`	`private boolean taskSkipped;`
	`16`	`+ private String skipReason;`
`16`	`17`
`17`	`18`	`public BuildArtifactData() {`
`18`	`19`	`}`
`@@ -41,6 +42,14 @@ public void setTaskSkipped(boolean taskSkipped) {`
`41`	`42`	`this.taskSkipped = taskSkipped;`
`42`	`43`	`}`
`43`	`44`
	`45`	`+ public String getSkipReason() {`
	`46`	`+ return (this.skipReason == null) ? "" : this.skipReason;`
	`47`	`+ }`
	`48`	`+`
	`49`	`+ public void setSkipReason(String skipReason) {`
	`50`	`+ this.skipReason = skipReason;`
	`51`	`+ }`
	`52`	`+`
`44`	`53`	`public boolean getTaskFailed() {`
`45`	`54`	`return this.taskFailed;`
`46`	`55`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,7 @@`
`19`	`19`	`"description": "tests Dscription",`
`20`	`20`	`"failed": false,`
`21`	`21`	`"skipped": true,`
	`22`	`+ "skipReason": "UserSpecified",`
`22`	`23`	`"duration": "00:00:00"`
`23`	`24`	`}`
`24`	`25`	`]`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`	`"description": "Test show",`
`5`	`5`	`"failed": false,`
`6`	`6`	`"skipped": true,`
	`7`	`+ "skipReason": "UserSpecified",`
`7`	`8`	`"duration": "00:02:53"`
`8`	`9`	`}`
`9`	`10`	`}`