Merge pull request #541 from jglick/wicked_deep_cause_14814

[JENKINS-14814] "Ping-pong" builds store excessively large CauseAction
jenkinsci · Aug 15, 2012 · a56f000 · a56f000
2 parents aaecf79 + bfa6481
commit a56f000
Show file tree

Hide file tree

Showing 2 changed files with 105 additions and 2 deletions.
diff --git a/core/src/main/java/hudson/model/Cause.java b/core/src/main/java/hudson/model/Cause.java
@@ -34,6 +34,7 @@
 import org.kohsuke.stapler.export.Exported;
 import org.kohsuke.stapler.export.ExportedBean;
 import com.thoughtworks.xstream.converters.UnmarshallingContext;
+import javax.annotation.Nonnull;
 
 /**
  * Cause object base class.  This class hierarchy is used to keep track of why
@@ -100,14 +101,19 @@ public String getShortDescription() {
      * A build is triggered by the completion of another build (AKA upstream build.)
      */
     public static class UpstreamCause extends Cause {
+
+        /**
+         * Maximum depth of transitive upstream causes we want to record.
+         */
+        private static final int MAX_DEPTH = 10;
         private String upstreamProject, upstreamUrl;
         private int upstreamBuild;
         /**
          * @deprecated since 2009-02-28
          */
         @Deprecated
         private transient Cause upstreamCause;
-        private List<Cause> upstreamCauses;
+        private @Nonnull List<Cause> upstreamCauses;
 
         /**
          * @deprecated since 2009-02-28
@@ -121,7 +127,33 @@ public UpstreamCause(Run<?, ?> up) {
             upstreamBuild = up.getNumber();
             upstreamProject = up.getParent().getFullName();
             upstreamUrl = up.getParent().getUrl();
-            upstreamCauses = new ArrayList<Cause>(up.getCauses());
+            upstreamCauses = new ArrayList<Cause>();
+            for (Cause c : up.getCauses()) {
+                upstreamCauses.add(trim(c, MAX_DEPTH));
+            }
+        }
+
+        private UpstreamCause(String upstreamProject, int upstreamBuild, String upstreamUrl, @Nonnull List<Cause> upstreamCauses) {
+            this.upstreamProject = upstreamProject;
+            this.upstreamBuild = upstreamBuild;
+            this.upstreamUrl = upstreamUrl;
+            this.upstreamCauses = upstreamCauses;
+        }
+
+        private @Nonnull Cause trim(@Nonnull Cause c, int depth) {
+            if (!(c instanceof UpstreamCause)) {
+                return c;
+            }
+            UpstreamCause uc = (UpstreamCause) c;
+            List<Cause> cs = new ArrayList<Cause>();
+            if (depth > 0) {
+                for (Cause c2 : uc.upstreamCauses) {
+                    cs.add(trim(c2, depth - 1));
+                }
+            } else {
+                cs.add(new DeeplyNestedUpstreamCause());
+            }
+            return new UpstreamCause(uc.upstreamProject, uc.upstreamBuild, uc.upstreamUrl, cs);
         }
 
         /**
@@ -167,6 +199,10 @@ public void print(TaskListener listener) {
             );
         }
 
+        @Override public String toString() {
+            return upstreamUrl + upstreamBuild + upstreamCauses;
+        }
+
         public static class ConverterImpl extends XStream2.PassthruConverter<UpstreamCause> {
             public ConverterImpl(XStream2 xstream) { super(xstream); }
             @Override protected void callback(UpstreamCause uc, UnmarshallingContext context) {
@@ -178,6 +214,16 @@ public static class ConverterImpl extends XStream2.PassthruConverter<UpstreamCau
                 }
             }
         }
+
+        public static class DeeplyNestedUpstreamCause extends Cause {
+            @Override public String getShortDescription() {
+                return "(deeply nested causes)";
+            }
+            @Override public String toString() {
+                return "JENKINS-14814";
+            }
+        }
+
     }
 
     /**

diff --git a/test/src/test/java/hudson/model/CauseTest.java b/test/src/test/java/hudson/model/CauseTest.java
@@ -0,0 +1,57 @@
+/*
+ * The MIT License
+ *
+ * Copyright 2012 Jesse Glick.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+package hudson.model;
+
+import hudson.XmlFile;
+import java.io.File;
+import static org.junit.Assert.*;
+import org.junit.Rule;
+import org.junit.Test;
+import org.jvnet.hudson.test.Bug;
+import org.jvnet.hudson.test.JenkinsRule;
+
+public class CauseTest {
+
+    @Rule public JenkinsRule j = new JenkinsRule();
+
+    @Bug(14814)
+    @Test public void deeplyNestedCauses() throws Exception {
+        FreeStyleProject a = j.createFreeStyleProject("a");
+        FreeStyleProject b = j.createFreeStyleProject("b");
+        Run<?,?> early = null;
+        Run<?,?> last = null;
+        for (int i = 1; i <= 15; i++) {
+            last = b.scheduleBuild2(0, new Cause.UpstreamCause((Run<?,?>) a.scheduleBuild2(0, last == null ? null : new Cause.UpstreamCause(last)).get())).get();
+            if (i == 5) {
+                early = last;
+            }
+        }
+        String buildXml = new XmlFile(Run.XSTREAM, new File(early.getRootDir(), "build.xml")).asString();
+        assertTrue("keeps full history:\n" + buildXml, buildXml.contains("<upstreamBuild>1</upstreamBuild>"));
+        buildXml = new XmlFile(Run.XSTREAM, new File(last.getRootDir(), "build.xml")).asString();
+        assertFalse("too big:\n" + buildXml, buildXml.contains("<upstreamBuild>1</upstreamBuild>"));
+    }
+
+}