Consistent treatment of GitException (#1166)

src/main/java/hudson/plugins/git/IGitAPI.java

@@ -138,7 +138,7 @@ public interface IGitAPI extends GitClient {
      * @param remoteRepository remote configuration from which refs will be retrieved
      * @throws java.lang.InterruptedException if interrupted.
      */
-    void fetch(RemoteConfig remoteRepository) throws InterruptedException;
+    void fetch(RemoteConfig remoteRepository) throws GitException, InterruptedException;
 
     /**
      * Retrieve commits from default remote.
@@ -281,7 +281,7 @@ public interface IGitAPI extends GitClient {
      * @return a {@link org.eclipse.jgit.lib.ObjectId} object.
      * @throws java.lang.InterruptedException if interrupted.
      */
-    ObjectId mergeBase(ObjectId sha1, ObjectId sha2) throws InterruptedException;
+    ObjectId mergeBase(ObjectId sha1, ObjectId sha2) throws GitException, InterruptedException;
 
     /**
      * showRevision.
@@ -304,5 +304,5 @@ public interface IGitAPI extends GitClient {
      */
     @Restricted(NoExternalUse.class)
     @Deprecated
-    String getAllLogEntries(String branch) throws InterruptedException;
+    String getAllLogEntries(String branch) throws GitException, InterruptedException;
 }

src/main/java/org/jenkinsci/plugins/gitclient/AbstractGitAPIImpl.java

@@ -23,7 +23,7 @@
 abstract class AbstractGitAPIImpl implements GitClient, Serializable {
     /** {@inheritDoc} */
     @Override
-    public <T> T withRepository(RepositoryCallback<T> callable) throws IOException, InterruptedException {
+    public <T> T withRepository(RepositoryCallback<T> callable) throws GitException, IOException, InterruptedException {
         try (Repository repo = getRepository()) {
             return callable.invoke(repo, FilePath.localChannel);
         }
@@ -40,15 +40,15 @@ public void commit(String message, PersonIdent author, PersonIdent committer)
 
     /** {@inheritDoc} */
     @Override
-    public void setAuthor(PersonIdent p) {
+    public void setAuthor(PersonIdent p) throws GitException {
         if (p != null) {
             setAuthor(p.getName(), p.getEmailAddress());
         }
     }
 
     /** {@inheritDoc} */
     @Override
-    public void setCommitter(PersonIdent p) {
+    public void setCommitter(PersonIdent p) throws GitException {
         if (p != null) {
             setCommitter(p.getName(), p.getEmailAddress());
         }

src/main/java/org/jenkinsci/plugins/gitclient/ChangelogCommand.java

@@ -1,5 +1,6 @@
 package org.jenkinsci.plugins.gitclient;
 
+import hudson.plugins.git.GitException;
 import java.io.Writer;
 import org.eclipse.jgit.lib.ObjectId;
 
@@ -55,15 +56,15 @@ public interface ChangelogCommand extends GitCommand {
      * @param rev a {@link java.lang.String} object.
      * @return a {@link org.jenkinsci.plugins.gitclient.ChangelogCommand} object.
      */
-    ChangelogCommand excludes(String rev);
+    ChangelogCommand excludes(String rev) throws GitException;
 
     /**
      * excludes.
      *
      * @param rev a {@link org.eclipse.jgit.lib.ObjectId} object.
      * @return a {@link org.jenkinsci.plugins.gitclient.ChangelogCommand} object.
      */
-    ChangelogCommand excludes(ObjectId rev);
+    ChangelogCommand excludes(ObjectId rev) throws GitException;
 
     /**
      * Adds the revision to include in the log.
@@ -73,15 +74,15 @@ public interface ChangelogCommand extends GitCommand {
      * @param rev a {@link java.lang.String} object.
      * @return a {@link org.jenkinsci.plugins.gitclient.ChangelogCommand} object.
      */
-    ChangelogCommand includes(String rev);
+    ChangelogCommand includes(String rev) throws GitException;
 
     /**
      * includes.
      *
      * @param rev a {@link org.eclipse.jgit.lib.ObjectId} object.
      * @return a {@link org.jenkinsci.plugins.gitclient.ChangelogCommand} object.
      */
-    ChangelogCommand includes(ObjectId rev);
+    ChangelogCommand includes(ObjectId rev) throws GitException;
 
     /**
      * Sets the {@link java.io.OutputStream} that receives the changelog.

src/main/java/org/jenkinsci/plugins/gitclient/CliGitAPIImpl.java

@@ -465,7 +465,7 @@ public List<IndexEntry> getSubmodules(String treeIsh) throws GitException, Inter
      * custom pack programs. Reject a URL if it includes invalid
      * content.
      */
-    private void addCheckedRemoteUrl(@NonNull ArgumentListBuilder args, @NonNull String url) {
+    private void addCheckedRemoteUrl(@NonNull ArgumentListBuilder args, @NonNull String url) throws GitException {
         String trimmedUrl = url.trim();
         /* Don't check for invalid args if URL starts with known good cases.
          * Known good cases include:
@@ -1211,7 +1211,7 @@ public void prune(RemoteConfig repository) throws GitException, InterruptedExcep
     @SuppressFBWarnings(
             value = "RV_DONT_JUST_NULL_CHECK_READLINE",
             justification = "Only needs first line, exception if multiple detected")
-    private @CheckForNull String firstLine(String result) {
+    private @CheckForNull String firstLine(String result) throws GitException {
         BufferedReader reader = new BufferedReader(new StringReader(result));
         String line;
         try {
@@ -2355,7 +2355,7 @@ private void reportFailureClues() {
         }
     }
 
-    private Path createSshKeyFile(SSHUserPrivateKey sshUser) throws IOException {
+    private Path createSshKeyFile(SSHUserPrivateKey sshUser) throws GitException, IOException {
         Path key = createTempFile("ssh", ".key");
         try (BufferedWriter w = Files.newBufferedWriter(key, Charset.forName(encoding))) {
             List<String> privateKeys = sshUser.getPrivateKeys();
@@ -2951,7 +2951,7 @@ public void execute() throws GitException, InterruptedException {
      * @param fos output of "git branch -v --no-abbrev"
      * @return a {@link java.util.Set} object.
      */
-    /*package*/ Set<Branch> parseBranches(String fos) {
+    /*package*/ Set<Branch> parseBranches(String fos) throws GitException {
         // 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
@@ -3473,7 +3473,7 @@ public List<ObjectId> revList(String ref) throws GitException, InterruptedExcept
 
     /** {@inheritDoc} */
     @Override
-    public boolean isCommitInRepo(ObjectId commit) throws InterruptedException {
+    public boolean isCommitInRepo(ObjectId commit) throws GitException, InterruptedException {
         if (commit == null) {
             return false;
         }
@@ -3910,7 +3910,7 @@ public List<Branch> getBranchesContaining(String revspec, boolean allBranches)
     /** {@inheritDoc} */
     @Deprecated
     @Override
-    public ObjectId mergeBase(ObjectId id1, ObjectId id2) throws InterruptedException {
+    public ObjectId mergeBase(ObjectId id1, ObjectId id2) throws GitException, InterruptedException {
         try {
             String result;
             try {
@@ -3926,7 +3926,7 @@ public ObjectId mergeBase(ObjectId id1, ObjectId id2) throws InterruptedExceptio
                 // Add the SHA1
                 return ObjectId.fromString(line);
             }
-        } catch (IOException | GitException e) {
+        } catch (IOException e) {
             throw new GitException("Error parsing merge base", e);
         }
 
@@ -3936,7 +3936,7 @@ public ObjectId mergeBase(ObjectId id1, ObjectId id2) throws InterruptedExceptio
     /** {@inheritDoc} */
     @Deprecated
     @Override
-    public String getAllLogEntries(String branch) throws InterruptedException {
+    public String getAllLogEntries(String branch) throws GitException, InterruptedException {
         // BROKEN: --all and branch are conflicting.
         return launchCommand("log", "--all", "--pretty=format:'%H#%ct'", branch);
     }

src/main/java/org/jenkinsci/plugins/gitclient/GitClient.java

@@ -130,7 +130,7 @@ public interface GitClient {
      * @throws java.io.IOException in case of IO error
      * @throws java.lang.InterruptedException if interrupted
      */
-    <T> T withRepository(RepositoryCallback<T> callable) throws IOException, InterruptedException;
+    <T> T withRepository(RepositoryCallback<T> callable) throws GitException, IOException, InterruptedException;
 
     /**
      * The working tree of this repository.
@@ -857,7 +857,7 @@ void submoduleUpdate(boolean recursive, boolean remoteTracking, String reference
      *
      * @return a {@link org.jenkinsci.plugins.gitclient.ChangelogCommand} object.
      */
-    ChangelogCommand changelog();
+    ChangelogCommand changelog() throws GitException;
 
     /**
      * Appends to an existing git-note on the current HEAD commit.

src/main/java/org/jenkinsci/plugins/gitclient/JGitAPIImpl.java

@@ -1250,7 +1250,7 @@ public void appendNote(String note, String namespace) throws GitException {
      * @return a {@link org.jenkinsci.plugins.gitclient.ChangelogCommand} object.
      */
     @Override
-    public ChangelogCommand changelog() {
+    public ChangelogCommand changelog() throws GitException {
         return new ChangelogCommand() {
             private Repository repo = getRepository();
             private ObjectReader or = repo.newObjectReader();
@@ -1259,7 +1259,7 @@ public ChangelogCommand changelog() {
             private boolean hasIncludedRev = false;
 
             @Override
-            public ChangelogCommand excludes(String rev) {
+            public ChangelogCommand excludes(String rev) throws GitException {
                 try {
                     return excludes(repo.resolve(rev));
                 } catch (IOException e) {
@@ -1268,7 +1268,7 @@ public ChangelogCommand excludes(String rev) {
             }
 
             @Override
-            public ChangelogCommand excludes(ObjectId rev) {
+            public ChangelogCommand excludes(ObjectId rev) throws GitException {
                 try {
                     walk.markUninteresting(walk.lookupCommit(rev));
                     return this;
@@ -1278,7 +1278,7 @@ public ChangelogCommand excludes(ObjectId rev) {
             }
 
             @Override
-            public ChangelogCommand includes(String rev) {
+            public ChangelogCommand includes(String rev) throws GitException {
                 try {
                     includes(repo.resolve(rev));
                     hasIncludedRev = true;
@@ -1289,7 +1289,7 @@ public ChangelogCommand includes(String rev) {
             }
 
             @Override
-            public ChangelogCommand includes(ObjectId rev) {
+            public ChangelogCommand includes(ObjectId rev) throws GitException {
                 try {
                     walk.markStart(walk.lookupCommit(rev));
                     hasIncludedRev = true;
@@ -1396,7 +1396,8 @@ private String statusOf(DiffEntry d) {
         @SuppressFBWarnings(
                 value = "VA_FORMAT_STRING_USES_NEWLINE",
                 justification = "Windows git implementation requires specific line termination")
-        void format(RevCommit commit, RevCommit parent, PrintWriter pw, Boolean useRawOutput) throws IOException {
+        void format(RevCommit commit, RevCommit parent, PrintWriter pw, Boolean useRawOutput)
+                throws GitException, IOException {
             if (parent != null) {
                 pw.printf("commit %s (from %s)\n", commit.name(), parent.name());
             } else {
@@ -2091,7 +2092,7 @@ public void prune(RemoteConfig repository) throws GitException {
     }
 
     private Set<String> listRemoteBranches(String remote)
-            throws NotSupportedException, TransportException, URISyntaxException {
+            throws GitException, NotSupportedException, TransportException, URISyntaxException {
         Set<String> branches = new HashSet<>();
         try (final Repository repo = getRepository()) {
             StoredConfig config = repo.getConfig();
@@ -2453,7 +2454,7 @@ public List<String> showRevision(ObjectId from, ObjectId to, Boolean useRawOutpu
         }
     }
 
-    private Iterable<JGitAPIImpl> submodules() throws IOException {
+    private Iterable<JGitAPIImpl> submodules() throws GitException, IOException {
         List<JGitAPIImpl> submodules = new ArrayList<>();
         try (Repository repo = getRepository()) {
             SubmoduleWalk generator = SubmoduleWalk.forIndex(repo);
@@ -2709,7 +2710,7 @@ public List<Branch> getBranchesContaining(String revspec, boolean allBranches)
         }
     }
 
-    private List<Ref> getAllBranchRefs(boolean originBranches) {
+    private List<Ref> getAllBranchRefs(boolean originBranches) throws GitException {
         List<Ref> branches = new ArrayList<>();
         try (Repository repo = getRepository()) {
             for (Ref r : repo.getAllRefs().values()) {
@@ -2725,7 +2726,7 @@ private List<Ref> getAllBranchRefs(boolean originBranches) {
     /** {@inheritDoc} */
     @Deprecated
     @Override
-    public ObjectId mergeBase(ObjectId id1, ObjectId id2) {
+    public ObjectId mergeBase(ObjectId id1, ObjectId id2) throws GitException {
         try (Repository repo = getRepository();
                 ObjectReader or = repo.newObjectReader();
                 RevWalk walk = new RevWalk(or)) {
@@ -2748,7 +2749,7 @@ public ObjectId mergeBase(ObjectId id1, ObjectId id2) {
     /** {@inheritDoc} */
     @Deprecated
     @Override
-    public String getAllLogEntries(String branch) {
+    public String getAllLogEntries(String branch) throws GitException {
         try (Repository repo = getRepository();
                 ObjectReader or = repo.newObjectReader();
                 RevWalk walk = new RevWalk(or)) {
@@ -2772,14 +2773,14 @@ public String getAllLogEntries(String branch) {
     /**
      * Adds all the refs as start commits.
      */
-    private void markAllRefs(RevWalk walk) throws IOException {
+    private void markAllRefs(RevWalk walk) throws GitException, IOException {
         markRefs(walk, unused -> true);
     }
 
     /**
      * Adds all matching refs as start commits.
      */
-    private void markRefs(RevWalk walk, Predicate<Ref> filter) throws IOException {
+    private void markRefs(RevWalk walk, Predicate<Ref> filter) throws GitException, IOException {
         try (Repository repo = getRepository()) {
             for (Ref r : repo.getAllRefs().values()) {
                 if (filter.test(r)) {

src/main/java/org/jenkinsci/plugins/gitclient/LegacyCompatibleGitAPIImpl.java

@@ -113,7 +113,7 @@ public void fetch(String repository, String refspec) throws GitException, Interr
     /** {@inheritDoc} */
     @Override
     @Deprecated
-    public void fetch(RemoteConfig remoteRepository) throws InterruptedException {
+    public void fetch(RemoteConfig remoteRepository) throws GitException, InterruptedException {
         // Assume there is only 1 URL for simplicity
         fetch(remoteRepository.getURIs().get(0), remoteRepository.getFetchRefSpecs());
     }

src/main/java/org/jenkinsci/plugins/gitclient/Netrc.java

@@ -38,7 +38,7 @@ private enum ParseState {
      *
      * @return a {@link org.jenkinsci.plugins.gitclient.Netrc} object.
      */
-    public static Netrc getInstance() {
+    public static Netrc getInstance() throws GitException {
         File netrc = getDefaultFile();
         return getInstance(netrc);
     }
@@ -49,7 +49,7 @@ public static Netrc getInstance() {
      * @param netrcPath a {@link java.lang.String} object.
      * @return a {@link org.jenkinsci.plugins.gitclient.Netrc} object.
      */
-    public static Netrc getInstance(@NonNull String netrcPath) {
+    public static Netrc getInstance(@NonNull String netrcPath) throws GitException {
         File netrc = new File(netrcPath);
         return netrc.exists() ? getInstance(new File(netrcPath)) : null;
     }
@@ -60,7 +60,7 @@ public static Netrc getInstance(@NonNull String netrcPath) {
      * @param netrc a {@link java.io.File} object.
      * @return a {@link org.jenkinsci.plugins.gitclient.Netrc} object.
      */
-    public static Netrc getInstance(File netrc) {
+    public static Netrc getInstance(File netrc) throws GitException {
         return new Netrc(netrc).parse();
     }
 
@@ -79,7 +79,7 @@ private static File getDefaultFile() {
      * @param host a {@link java.lang.String} object.
      * @return a {@link org.apache.http.auth.Credentials} object.
      */
-    public synchronized Credentials getCredentials(String host) {
+    public synchronized Credentials getCredentials(String host) throws GitException {
         if (!this.netrc.exists()) {
             return null;
         }
@@ -93,7 +93,7 @@ private Netrc(File netrc) {
         this.netrc = netrc;
     }
 
-    private synchronized Netrc parse() {
+    private synchronized Netrc parse() throws GitException {
         if (!netrc.exists()) {
             return this;
         }

src/main/java/org/jenkinsci/plugins/gitclient/RemoteGitImpl.java

@@ -257,7 +257,7 @@ public void setCommitter(PersonIdent p) throws GitException {
 
     /** {@inheritDoc} */
     @Override
-    public <T> T withRepository(RepositoryCallback<T> callable) throws IOException, InterruptedException {
+    public <T> T withRepository(RepositoryCallback<T> callable) throws GitException, IOException, InterruptedException {
         return proxy.withRepository(callable);
     }
 
@@ -386,13 +386,13 @@ public void checkoutBranch(String branch, String ref) throws GitException, Inter
 
     /** {@inheritDoc} */
     @Override
-    public ObjectId mergeBase(ObjectId sha1, ObjectId sha12) throws InterruptedException {
+    public ObjectId mergeBase(ObjectId sha1, ObjectId sha12) throws GitException, InterruptedException {
         return getGitAPI().mergeBase(sha1, sha12);
     }
 
     /** {@inheritDoc} */
     @Override
-    public String getAllLogEntries(String branch) throws InterruptedException {
+    public String getAllLogEntries(String branch) throws GitException, InterruptedException {
         return getGitAPI().getAllLogEntries(branch);
     }
 
@@ -945,7 +945,7 @@ public void fetch(String repository, String refspec) throws GitException, Interr
 
     /** {@inheritDoc} */
     @Override
-    public void fetch(RemoteConfig remoteRepository) throws InterruptedException {
+    public void fetch(RemoteConfig remoteRepository) throws GitException, InterruptedException {
         getGitAPI().fetch(remoteRepository);
     }