Fix JENKINS-42699

- Add data parameter which can accept BUILD_URL, PROJECT_NAME, or BUILD_NUMBER
jenkinsci · Oct 22, 2017 · 4d24aa5 · 4d24aa5
1 parent 66ede22
commit 4d24aa5
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 3 deletions.
diff --git a/src/main/java/org/jenkinsci/plugins/tokenmacro/impl/BuildCauseMacro.java b/src/main/java/org/jenkinsci/plugins/tokenmacro/impl/BuildCauseMacro.java
@@ -20,6 +20,9 @@ public class BuildCauseMacro extends DataBoundTokenMacro {
     public static final String MACRO_NAME = "BUILD_CAUSE";
     public static final String ALTERNATE_MACRO_NAME = "CAUSE";
 
+    @Parameter
+    public String data = null;
+
     @Override
     public boolean acceptsMacroName(String macroName) {
         return macroName.equals(MACRO_NAME) || macroName.equals(ALTERNATE_MACRO_NAME);
@@ -55,12 +58,25 @@ private String formatCauses(List<Cause> causes) {
             return "N/A";
         }
 
-        List<String> causeNames = new LinkedList<String>();
+        List<String> causeData = new LinkedList<String>();
         for (Cause cause : causes) {
-            causeNames.add(cause.getShortDescription());
+            if(data != null) {
+                if(cause instanceof Cause.UpstreamCause) {
+                    Cause.UpstreamCause upstreamCause = (Cause.UpstreamCause) cause;
+                    if (data.equals("BUILD_URL")) {
+                        causeData.add(upstreamCause.getUpstreamUrl());
+                    } else if (data.equals("PROJECT_NAME")) {
+                        causeData.add(upstreamCause.getUpstreamProject());
+                    } else if (data.equals("BUILD_NUMBER")) {
+                        causeData.add("" + upstreamCause.getUpstreamBuild());
+                    }
+                }
+            } else {
+                causeData.add(cause.getShortDescription());
+            }
         }
 
-        return StringUtils.join(causeNames, ", ");
+        return StringUtils.join(causeData, ", ");
     }
 }
 
diff --git a/src/test/java/org/jenkinsci/plugins/tokenmacro/impl/BuildCauseMacroTest.java b/src/test/java/org/jenkinsci/plugins/tokenmacro/impl/BuildCauseMacroTest.java
@@ -69,6 +69,29 @@ public void shouldReturnMultipleCausesSeperatedByCommas()
         assertEquals("Cause1, Cause2, Cause3", buildCauseMacro.evaluate(build, listener, BuildCauseMacro.MACRO_NAME));
     }
 
+    @Test
+    public void testCauseData()
+            throws Exception {
+        CauseAction causeAction = mock(CauseAction.class);
+        final Cause.UpstreamCause upstreamCause = mock(Cause.UpstreamCause.class);
+
+        when(upstreamCause.getUpstreamBuild()).thenReturn(3);
+        when(upstreamCause.getUpstreamProject()).thenReturn("Upstream");
+        when(upstreamCause.getUpstreamUrl()).thenReturn("http://localhost/jenkins/jobs/Upstream/3");
+
+        when(causeAction.getCauses()).thenReturn(new LinkedList<Cause>() {{
+            add(upstreamCause);
+        }});
+
+        when(build.getAction(CauseAction.class)).thenReturn(causeAction);
+        buildCauseMacro.data = "BUILD_NUMBER";
+        assertEquals("3", buildCauseMacro.evaluate(build,listener,BuildCauseMacro.MACRO_NAME));
+        buildCauseMacro.data = "PROJECT_NAME";
+        assertEquals("Upstream", buildCauseMacro.evaluate(build,listener,BuildCauseMacro.MACRO_NAME));
+        buildCauseMacro.data = "BUILD_URL";
+        assertEquals("http://localhost/jenkins/jobs/Upstream/3",buildCauseMacro.evaluate(build,listener,BuildCauseMacro.MACRO_NAME));
+    }
+
     private class CauseStub extends Cause {
         private String name;