From 89ce85dfc88b21cdb7a8bc95d89b24259b987d19 Mon Sep 17 00:00:00 2001
From: Christopher Simons <christopher.simons@viaoncology.com>
Date: Wed, 7 Oct 2015 08:55:17 -0400
Subject: [PATCH] [FIXED JENKINS-30502] trim job name upon rename

If a job is renamed to a string with trailing whitespace, exceptions are
thrown as the application attempts to rename the job directory in the
file system, and the job can be neither deleted nor renamed again
through the UI. This problem occurs only when renaming a job, and not
when initially creating a job, because job names are trimmed when first
created.  This change trims the job name for rename operations as well,
so that the name-setting behavior is consistent across create/update
operations and inadvertent leading/trailing whitespace is removed before
it can cause problems.
---
 core/src/main/java/hudson/model/Job.java     | 12 ++-
 test/src/test/java/hudson/model/JobTest.java | 89 +++++++++++++++++++-
 2 files changed, 99 insertions(+), 2 deletions(-)

diff --git a/core/src/main/java/hudson/model/Job.java b/core/src/main/java/hudson/model/Job.java
index 85d440f25a..5e7d56183a 100644
--- a/core/src/main/java/hudson/model/Job.java
+++ b/core/src/main/java/hudson/model/Job.java
@@ -1210,7 +1210,8 @@ public abstract class Job<JobT extends Job<JobT, RunT>, RunT extends Run<JobT, R
 
             String newName = req.getParameter("name");
             final ProjectNamingStrategy namingStrategy = Jenkins.getInstance().getProjectNamingStrategy();
-            if (newName != null && !newName.equals(name)) {
+            if (validRename(name, newName)) {
+                newName = newName.trim();
                 // check this error early to avoid HTTP response splitting.
                 Jenkins.checkGoodName(newName);
                 namingStrategy.checkName(newName);
@@ -1231,6 +1232,15 @@ public abstract class Job<JobT extends Job<JobT, RunT>, RunT extends Run<JobT, R
         }
     }
 
+    private boolean validRename(String oldName, String newName) {
+        if (newName == null) {
+            return false;
+        }
+        boolean noChange = oldName.equals(newName);
+        boolean spaceAdded = oldName.equals(newName.trim());
+        return !noChange && !spaceAdded;
+    }
+
     /**
      * Derived class can override this to perform additional config submission
      * work.
diff --git a/test/src/test/java/hudson/model/JobTest.java b/test/src/test/java/hudson/model/JobTest.java
index b49b13e45d..3e0e26d3b8 100644
--- a/test/src/test/java/hudson/model/JobTest.java
+++ b/test/src/test/java/hudson/model/JobTest.java
@@ -2,6 +2,7 @@
  * The MIT License
  * 
  * Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi
+ * Copyright (c) 2015 Christopher Simons
  * 
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -25,27 +26,34 @@ package hudson.model;
 
 import com.gargoylesoftware.htmlunit.FailingHttpStatusCodeException;
 import com.gargoylesoftware.htmlunit.WebAssert;
+import com.gargoylesoftware.htmlunit.html.HtmlForm;
 import com.gargoylesoftware.htmlunit.html.HtmlFormUtil;
 import com.gargoylesoftware.htmlunit.html.HtmlPage;
 import com.gargoylesoftware.htmlunit.TextPage;
 
+import hudson.Functions;
 import hudson.util.TextFile;
 import java.io.IOException;
 import java.net.HttpURLConnection;
+import java.text.MessageFormat;
 import java.util.concurrent.Callable;
 import java.util.concurrent.CountDownLatch;
 
 import jenkins.model.ProjectNamingStrategy;
 
-import static org.junit.Assert.*;
 import org.junit.Rule;
 import org.junit.Test;
 import org.jvnet.hudson.test.Issue;
 import org.jvnet.hudson.test.FailureBuilder;
 import org.jvnet.hudson.test.JenkinsRule;
+import org.jvnet.hudson.test.JenkinsRule.WebClient;
 import org.jvnet.hudson.test.RunLoadCounter;
 import org.jvnet.hudson.test.recipes.LocalData;
 
+import static org.hamcrest.Matchers.endsWith;
+import static org.junit.Assert.*;
+import static org.junit.Assume.assumeFalse;
+
 /**
  * @author Kohsuke Kawaguchi
  */
@@ -286,4 +294,83 @@ public class JobTest {
         p.renameTo("different-name");
     }
 
+    @Issue("JENKINS-30502")
+    @Test
+    public void testRenameTrimsLeadingSpace() throws Exception {
+        tryRename("myJob1", " foo", "foo", false);
+    }
+
+    @Issue("JENKINS-30502")
+    @Test
+    public void testRenameTrimsTrailingSpace() throws Exception {
+        tryRename("myJob2", "foo ", "foo", false);
+    }
+
+    @Issue("JENKINS-30502")
+    @Test
+    public void testAllowTrimmingByUser() throws Exception {
+        assumeFalse("Unix-only test.", Functions.isWindows());
+        tryRename("myJob3 ", "myJob3", "myJob3", false);
+    }
+
+    @Issue("JENKINS-30502")
+    @Test
+    public void testRenameWithLeadingSpaceTrimsLeadingSpace() throws Exception {
+        assumeFalse("Unix-only test.", Functions.isWindows());
+        tryRename(" myJob4", " foo", "foo", false);
+    }
+
+    @Issue("JENKINS-30502")
+    @Test
+    public void testRenameWithLeadingSpaceTrimsTrailingSpace()
+            throws Exception {
+        assumeFalse("Unix-only test.", Functions.isWindows());
+        tryRename(" myJob5", "foo ", "foo", false);
+    }
+
+    @Issue("JENKINS-30502")
+    @Test
+    public void testRenameWithTrailingSpaceTrimsTrailingSpace()
+            throws Exception {
+        assumeFalse("Unix-only test.", Functions.isWindows());
+        tryRename("myJob6 ", "foo ", "foo", false);
+    }
+
+    @Issue("JENKINS-30502")
+    @Test
+    public void testRenameWithTrailingSpaceTrimsLeadingSpace()
+            throws Exception {
+        assumeFalse("Unix-only test.", Functions.isWindows());
+        tryRename("myJob7 ", " foo", "foo", false);
+    }
+
+    @Issue("JENKINS-30502")
+    @Test
+    public void testDoNotAutoTrimExistingUntrimmedNames() throws Exception {
+        assumeFalse("Unix-only test.", Functions.isWindows());
+        tryRename("myJob8 ", "myJob8 ", null, true);
+    }
+
+    private void tryRename(String initialName, String submittedName,
+            String correctResult, boolean shouldSkipConfirm) throws Exception {
+        j.jenkins.setCrumbIssuer(null);
+
+        FreeStyleProject job = j.createFreeStyleProject(initialName);
+        WebClient wc = j.createWebClient();
+        HtmlForm form = wc.getPage(job, "configure").getFormByName("config");
+        form.getInputByName("name").setValueAttribute(submittedName);
+        HtmlPage resultPage = j.submit(form);
+
+        String urlTemplate;
+        if (shouldSkipConfirm) {
+            urlTemplate = "/job/{0}/";
+        } else {
+            urlTemplate = "/job/{0}/rename?newName={1}";
+        }
+
+        String urlString = MessageFormat.format(
+                urlTemplate, initialName, correctResult).replace(" ", "%20");
+
+        assertThat(resultPage.getUrl().toString(), endsWith(urlString));
+    }
 }
-- 
GitLab