Merge pull request #4 from synopsys-arc-oss/JENKINS_22974_NPE_in_make…

…UserVars [FIXED JENKINS-22974] - NPE in makeUserVars if an upstream build is missing
jenkinsci · May 19, 2014 · 5db4ca0 · 5db4ca0
2 parents da34a52 + 223500f
commit 5db4ca0
Show file tree

Hide file tree

Showing 2 changed files with 101 additions and 2 deletions.
diff --git a/src/main/java/org/jenkinsci/plugins/builduser/BuildUser.java b/src/main/java/org/jenkinsci/plugins/builduser/BuildUser.java
@@ -15,6 +15,7 @@
 
 import java.io.IOException;
 import java.util.Map;
+import javax.annotation.Nonnull;
 
 import jenkins.model.Jenkins;
 
@@ -67,14 +68,16 @@ public void makeBuildVariables(AbstractBuild build,
     /**
      * Retrieve user cause that triggered this build and populate variables accordingly
      */
-    private void makeUserBuildVariables(Run build, Map<String, String> variables) {
+    private void makeUserBuildVariables(@Nonnull Run build, @Nonnull Map<String, String> variables) {
 
         // If build has been triggered form an upstream build, get UserCause from there to set user build variables
         Cause.UpstreamCause upstreamCause = (Cause.UpstreamCause) build.getCause(Cause.UpstreamCause.class);
         if (upstreamCause != null) {
             Job job = Jenkins.getInstance().getItemByFullName(upstreamCause.getUpstreamProject(), Job.class);
             Run upstream = job.getBuildByNumber(upstreamCause.getUpstreamBuild());
-            makeUserBuildVariables(upstream, variables);
+            if (upstream != null) {
+                makeUserBuildVariables(upstream, variables);
+            }
         }
 
         // set BUILD_USER_NAME to fixed value if the build was triggered by a change in the scm

diff --git a/src/test/java/org/jenkinsci/plugins/builduser/BuildUserTest.java b/src/test/java/org/jenkinsci/plugins/builduser/BuildUserTest.java
@@ -0,0 +1,96 @@
+/*
+ * The MIT License
+ * 
+ * Copyright (c) 2013 Oleg Nenashev
+ * 
+ * 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 org.jenkinsci.plugins.builduser;
+
+import hudson.model.AbstractProject;
+import hudson.model.Build;
+import hudson.model.Cause;
+import hudson.model.CauseAction;
+import hudson.model.FreeStyleBuild;
+import hudson.model.FreeStyleProject;
+import hudson.model.Result;
+import hudson.tasks.BuildTrigger;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import junit.framework.Assert;
+import org.jvnet.hudson.test.Bug;
+import org.jvnet.hudson.test.HudsonTestCase;
+import org.jvnet.hudson.test.MockBuilder;
+
+/**
+ * Contains tests of {@link BuildUser}.
+ * @author Oleg Nenashev <o.v.nenashev@gmail.com>
+ */
+public class BuildUserTest extends HudsonTestCase {
+
+
+    @Bug(22974)
+    public void testMakeUserBuildVariablesWithoutUpstream() throws Exception {      
+        // Initialize
+        FreeStyleProject childProject = createFreeStyleProject();
+        List<AbstractProject> childProjects = new ArrayList<AbstractProject>(1);
+        childProjects.add(childProject);
+        Map<String, String> outputVars = new HashMap<String, String>();
+        BuildUser buildUser = new BuildUser();
+
+        // Create the parent job
+        FreeStyleProject parentProject = createFreeStyleProject();
+        parentProject.getBuildersList().add(new MockBuilder(Result.SUCCESS));
+        parentProject.getPublishersList().add(new BuildTrigger(childProjects, Result.SUCCESS));
+        parentProject.save();
+        jenkins.rebuildDependencyGraph();
+
+        // Trigger the first job. It should not trigger anything
+        FreeStyleBuild upstreamBuild = this.buildAndAssertSuccess(parentProject);
+        Thread.sleep(20000);
+        Assert.assertEquals(1, childProject.getBuilds().size());
+
+        // Register non-existent build as an execution cause
+        Build downstreamBuild = childProject.getLastBuild();
+        List<CauseAction> actions = downstreamBuild.getActions(CauseAction.class);
+        Assert.assertTrue("CauseAction has not been created properly",
+                actions != null && actions.size() == 1);
+        Cause.UpstreamCause upstreamCause = null;
+        List<Cause> causes = actions.get(0).getCauses();
+        for (Cause cause : causes) {
+            if (cause instanceof Cause.UpstreamCause) {
+                upstreamCause = (Cause.UpstreamCause) cause;
+            }
+        }
+        Assert.assertNotNull("Cannot extract the UpstreamCause", upstreamCause);
+        buildUser.makeBuildVariables(downstreamBuild, outputVars); // Just a smoke check
+
+        // Delete master build and check the correctness
+        upstreamBuild.delete();
+        try {
+            buildUser.makeBuildVariables(downstreamBuild, outputVars);
+        } catch (NullPointerException npe) {
+            npe.printStackTrace();
+            fail("MakeBuildVariables() has failed with NPE on non-existent upstream cause");            
+        }
+    }
+
+}