Merge pull request #273 from bmleite/patch-1

Protect against ArrayIndexOutOfBoundsException (related to JENKINS-34309)
jenkinsci · Sep 30, 2017 · 85e6a0d · 85e6a0d
2 parents 51ec170 + 4016ead
commit 85e6a0d
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 6 deletions.
diff --git a/src/main/java/org/jenkinsci/plugins/gitclient/CliGitAPIImpl.java b/src/main/java/org/jenkinsci/plugins/gitclient/CliGitAPIImpl.java
@@ -2029,7 +2029,12 @@ public void execute() throws GitException, InterruptedException {
      * @param fos output of "git branch -v --no-abbrev"
      * @return a {@link java.util.Set} object.
      */
-    private Set<Branch> parseBranches(String fos) {
+    /*package*/ Set<Branch> parseBranches(String fos) {
+        // JENKINS-34309 if the commit message contains line breaks,
+        // "git branch -v --no-abbrev" output will include CR (Carriage Return) characters.
+        // Replace all CR characters to avoid interpreting them as line endings
+        fos = fos.replaceAll("\\r", "");
+
         Set<Branch> branches = new HashSet<>();
         BufferedReader rdr = new BufferedReader(new StringReader(fos));
         String line;
@@ -2039,17 +2044,14 @@ private Set<Branch> parseBranches(String fos) {
                     // Line must contain 2 leading characters, branch
                     // name (at least 1 character), a space, and 40
                     // character SHA1.
-                    // JENKINS-34309 found cases where a Ctrl-M was
-                    // inserted into the output of
-                    // "git branch -v --no-abbrev"
                     continue;
                 }
                 // Ignore leading 2 characters (marker for current branch)
                 // Ignore line if second field is not SHA1 length (40 characters)
                 // Split fields into branch name, SHA1, and rest of line
                 // Fields are separated by one or more spaces
                 String[] branchVerboseOutput = line.substring(2).split(" +", 3);
-                if (branchVerboseOutput[1].length() == 40) {
+                if (branchVerboseOutput.length > 1 && branchVerboseOutput[1].length() == 40) {
                     branches.add(new Branch(branchVerboseOutput[0], ObjectId.fromString(branchVerboseOutput[1])));
                 }
             }

diff --git a/src/test/java/org/jenkinsci/plugins/gitclient/CliGitAPIImplTest.java b/src/test/java/org/jenkinsci/plugins/gitclient/CliGitAPIImplTest.java
@@ -1,9 +1,12 @@
 package org.jenkinsci.plugins.gitclient;
 
+import hudson.plugins.git.Branch;
+import org.apache.commons.lang.SystemUtils;
+
 import java.io.File;
 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
-import org.apache.commons.lang.SystemUtils;
+import java.util.Set;
 
 /**
  * @author <a href="mailto:nicolas.deloof@gmail.com">Nicolas De Loof</a>
@@ -284,6 +287,18 @@ public void test_git_ssh_executable_found_on_windows() throws Exception {
         assertTrue("ssh.exe not found", w.cgit().getSSHExecutable().exists());
     }
 
+    public void test_git_branch_with_line_breaks_and_long_strings() throws Exception {
+        String gitBranchOutput =
+                "* (HEAD detached at b297853)  b297853e667d5989801937beea30fcec7d1d2595 Commit message with line breaks\r very-long-string-with-more-than-44-characters\n" +
+                "  remotes/origin/master       e0d3f46c4fdb8acd068b6b127356931411d16e23 Commit message with line breaks\r very-long-string-with-more-than-44-characters and some more text\n" +
+                "  remotes/origin/develop      fc8996efc1066d9dae529e5187800f84995ca56f Single-line commit message\n";
+
+        setTimeoutVisibleInCurrentTest(false);
+        CliGitAPIImpl git = new CliGitAPIImpl("git", new File("."), listener, env);
+        Set<Branch> branches = git.parseBranches(gitBranchOutput);
+        assertTrue("\"git branch -a -v --no-abbrev\" output correctly parsed", branches.size() == 2);
+    }
+
     @Override
     protected String getRemoteBranchPrefix() {
         return "remotes/";