Feature/mentioned in commit or upstream commits strategy

DSL.md

@@ -16,6 +16,8 @@ job {
             firstWordOfUpstreamCommit()
             // - or -
             mentionedInCommit()
+            // - or -
+            mentionedInCommitOrUpstreamCommits()            
         }
         jiraOperations {
             transition('Deploy to Test');

README.md

@@ -12,6 +12,7 @@ Out of the box, you may discover issues by:
 * The issue key as the first word of the upstream commit message
 * Manually specifying an issue
 * Looking for it being mentioned somewhere in the commit message
+* Looking for it being mentioned somewhere in the commit message or any upstream build commit messages
 
 To all of these JIRA issues, you may:
 

pom.xml

@@ -132,8 +132,8 @@
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-compiler-plugin</artifactId>
         <configuration>
-          <source>1.7</source>
-          <target>1.7</target>
+          <source>1.8</source>
+          <target>1.8</target>
         </configuration>
       </plugin>
       <plugin>

src/main/java/org/jenkinsci/plugins/jiraext/UpstreamBuildUtil.java

@@ -24,6 +24,9 @@
 import hudson.model.Run;
 import jenkins.model.Jenkins;
 
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.LinkedList;
 import java.util.List;
 import java.util.logging.Level;
 import java.util.logging.Logger;
@@ -73,6 +76,43 @@ public static AbstractBuild getUpstreamBuild(AbstractBuild<?, ?> build)
         return getUpstreamBuild(upstreamBuild);
     }
 
+    /**
+     * Gets all upstream builds which caused this build.
+     *
+     * @return
+     */
+    public static List<AbstractBuild<?, ?>> getUpstreamBuilds(AbstractBuild<?, ?> build)
+    {
+        logger.log(Level.FINE, "Find build upstream of " + build.getId());
+
+        Cause.UpstreamCause cause = getUpstreamCause(build);
+        if (cause == null)
+        {
+            logger.log(Level.FINE, "No upstream cause, so must be root upstream build: " + build.getId());
+            return Collections.<AbstractBuild<?, ?>>emptyList();
+        }
+        logger.log(Level.FINE, "Found upstream cause: " + cause.toString() + "(" + cause.getShortDescription() + ")");
+        AbstractProject project = (AbstractProject) Jenkins.getInstance().getItem(cause.getUpstreamProject(), build.getProject());
+        if (project == null)
+        {
+            logger.log(Level.WARNING, "Found an UpstreamCause (" + cause.toString()
+                    + "), but the upstream project (" + cause.getUpstreamProject() + ") does not appear to be valid!");
+            return Collections.<AbstractBuild<?, ?>>emptyList();
+        }
+        AbstractBuild upstreamBuild = project.getBuildByNumber(cause.getUpstreamBuild());
+        if (upstreamBuild == null)
+        {
+            logger.log(Level.WARNING, "Found an UpstreamCause (" + cause.toString()
+                    + "), and an upstream project (" + project.getName() + "), but the build is invalid!" + cause.getUpstreamBuild());
+            return Collections.<AbstractBuild<?, ?>>emptyList();
+        }
+        List<AbstractBuild<?, ?>> upstreamBuilds = new LinkedList<>();
+        upstreamBuilds.add(upstreamBuild);
+        upstreamBuilds.addAll(getUpstreamBuilds(upstreamBuild));
+
+        return upstreamBuilds;
+    }
+
     private static Cause.UpstreamCause getUpstreamCause(Run run)
     {
         if (run == null)

src/main/java/org/jenkinsci/plugins/jiraext/dsl/IssueStrategyContext.java

@@ -22,11 +22,7 @@
 import hudson.Extension;
 import javaposse.jobdsl.dsl.Context;
 import javaposse.jobdsl.plugin.ContextExtensionPoint;
-import org.jenkinsci.plugins.jiraext.view.FirstWordOfCommitStrategy;
-import org.jenkinsci.plugins.jiraext.view.FirstWordOfUpstreamCommitStrategy;
-import org.jenkinsci.plugins.jiraext.view.IssueStrategyExtension;
-import org.jenkinsci.plugins.jiraext.view.MentionedInCommitStrategy;
-import org.jenkinsci.plugins.jiraext.view.SingleTicketStrategy;
+import org.jenkinsci.plugins.jiraext.view.*;
 
 /**
  * @author dalvizu
@@ -60,6 +56,11 @@ public void mentionedInCommit()
         issueStrategy = new MentionedInCommitStrategy();
     }
 
+    public void mentionedInCommitOrUpstreamCommits()
+    {
+        issueStrategy = new MentionedInCommitOrUpstreamCommitsStrategy();
+    }
+
     /**
      * Allows direct manipulation of the generated XML. The {@code issueStrategy} node is passed into the configure block.
      *

src/main/java/org/jenkinsci/plugins/jiraext/view/AbstractParsingIssueStrategy.java

@@ -18,19 +18,24 @@
  **************************************************************************/
 package org.jenkinsci.plugins.jiraext.view;
 
+import com.google.common.collect.Iterators;
+import com.google.common.collect.Lists;
 import hudson.model.AbstractBuild;
+import hudson.model.AbstractProject;
 import hudson.model.BuildListener;
 import hudson.scm.ChangeLogSet;
 import org.jenkinsci.plugins.jiraext.domain.JiraCommit;
 
 import java.util.ArrayList;
+import java.util.LinkedList;
 import java.util.List;
+import java.util.Map;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
 /**
  * An IssueStrategyExtension which assumes you want to return a list of jira commits by
- * deriving them from the provided build's {@link ChangeLogSet}
+ * deriving them from the provided build's {@link ChangeLogSet}. Also includes upstream build ChangeLogSets
  *
  * @author dalvizu
  */
@@ -40,18 +45,19 @@ public abstract class AbstractParsingIssueStrategy
     private static final Logger _logger = Logger.getLogger(FirstWordOfCommitStrategy.class.getName());
 
     @Override
-    public final List<JiraCommit> getJiraCommits(AbstractBuild build,
+    public List<JiraCommit> getJiraCommits(AbstractBuild build,
                                            BuildListener listener)
     {
         List<JiraCommit> result = new ArrayList<>();
 
         try
         {
             _logger.log(Level.FINE, "iterateTicketsAndApply");
-            ChangeLogSet changeSets = build.getChangeSet();
-            listener.getLogger().println("ChangeLogSet class: " + changeSets.getClass());
+            List<Object> changeSetEntries = new LinkedList<>();
 
-            for (Object entry : changeSets)
+            getBuildChangeSetEntries(listener, build, changeSetEntries);
+
+            for (Object entry : changeSetEntries)
             {
                 try
                 {
@@ -81,6 +87,14 @@ public final List<JiraCommit> getJiraCommits(AbstractBuild build,
         return result;
     }
 
+    private void getBuildChangeSetEntries(BuildListener listener, AbstractBuild build, List<Object> changeSetEntries) {
+        ChangeLogSet changeSets = build.getChangeSet();
+        String projectName = build.getProject() == null ? "" : build.getProject().getName();
+        Integer buildNumber = build.getNumber();
+        listener.getLogger().println(String.format("ChangeLogSet from %s build %d, class: %s", projectName, buildNumber, changeSets.getClass()));
+        changeSetEntries.addAll(Lists.newArrayList(changeSets.iterator()));
+    }
+
     /**
      * Parse a JIRA issue key, ie SSD-101, out of the given ChangeLogSet.Entry.
      *

src/main/java/org/jenkinsci/plugins/jiraext/view/MentionedInCommitOrUpstreamCommitsStrategy.java

@@ -0,0 +1,78 @@
+/***************************************************************************
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ **************************************************************************/
+package org.jenkinsci.plugins.jiraext.view;
+
+import hudson.Extension;
+import hudson.model.AbstractBuild;
+import hudson.model.BuildListener;
+import org.jenkinsci.plugins.jiraext.UpstreamBuildUtil;
+import org.jenkinsci.plugins.jiraext.domain.JiraCommit;
+import org.kohsuke.stapler.DataBoundConstructor;
+
+import java.util.List;
+import java.util.stream.Collectors;
+
+
+/**
+ * Find JiraCommits by looking for word in the build's changelog. Issues must match in the pattern defined in
+ * global config. Also looks in Jira comments for all upstream commits
+ *
+ * @author milowg
+ */
+public class MentionedInCommitOrUpstreamCommitsStrategy
+        extends MentionedInCommitStrategy {
+
+    @DataBoundConstructor
+    public MentionedInCommitOrUpstreamCommitsStrategy()
+    {
+        super();
+    }
+
+    @Override
+    public boolean equals(Object obj)
+    {
+        return (obj != null) && (obj instanceof MentionedInCommitOrUpstreamCommitsStrategy);
+    }
+
+    @Override
+    public List<JiraCommit> getJiraCommits(AbstractBuild build, BuildListener buildListener) {
+        List<JiraCommit> jiraCommits = super.getJiraCommits(build, buildListener);
+
+        for (AbstractBuild upstreamBuild : UpstreamBuildUtil.getUpstreamBuilds(build)) {
+            if (jiraCommits.addAll(
+                    super.getJiraCommits(upstreamBuild, buildListener)
+                            .stream()
+                            .filter(jc -> !jiraCommits.contains(jc))
+                            .collect(Collectors.toSet()))) ;
+        }
+        return jiraCommits;
+    }
+
+    @Extension
+    public static class DescriptorImpl
+            extends IssueStrategyExtensionDescriptor
+    {
+
+        @Override
+        public String getDisplayName()
+        {
+            return "Mentioned somewhere in commit or upstream build commit message";
+        }
+    }
+}

src/test/java/org/jenkinsci/plugins/jiraext/view/MentionedInCommitOrUpstreamCommitStrategyTest.java

@@ -0,0 +1,59 @@
+/***************************************************************************
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ **************************************************************************/
+package org.jenkinsci.plugins.jiraext.view;
+
+import hudson.model.FreeStyleProject;
+import org.jenkinsci.plugins.jiraext.Config;
+import org.junit.Before;
+import org.junit.Rule;
+import org.junit.Test;
+import org.jvnet.hudson.test.JenkinsRule;
+
+import java.util.Arrays;
+
+/**
+ * @author dalvizu
+ */
+public class MentionedInCommitOrUpstreamCommitStrategyTest
+{
+    @Rule
+    public JenkinsRule jenkinsRule = new JenkinsRule();
+
+    @Before
+    public void setUp()
+    {
+        Config.getGlobalConfig().setPattern("FOO-,BAR-");
+    }
+
+    @Test
+    public void testSaveConfig()
+            throws Exception
+    {
+        FreeStyleProject project = jenkinsRule.createFreeStyleProject();
+        JiraExtBuildStep builder = new JiraExtBuildStep(new MentionedInCommitOrUpstreamCommitsStrategy(),
+                Arrays.asList((JiraOperationExtension) new AddComment(true, "Hello World")));
+        project.getBuildersList().add(builder);
+
+        jenkinsRule.submit(jenkinsRule.createWebClient().getPage(project, "configure").getFormByName("config"));
+
+        JiraExtBuildStep after = project.getBuildersList().get(JiraExtBuildStep.class);
+        jenkinsRule.assertEqualBeans(builder, after, "issueStrategy");
+    }
+
+}