[GSoC-2020] Git Repository Size Estimation

README.adoc

@@ -171,6 +171,13 @@ Hide credential identifier in job output::
 
   If checked, the console log will not show the credential identifier used to clone a repository.
 
+[[disable-performance-enhancements]]
+Disable GitToolChooser which tries to suggest an optimal git implementation::
+
+  If checked, the plugin will disable a feature which recommends a git implementation on the basis of the size of a repository.
+  This switch may be used in case of a bug in the performance improvement feature.
+  If you enable this setting, please report a git plugin issue that describes why you needed to enable it.
+
 [[preserve-second-fetch-during-checkout]]
 Preserve second fetch during initial checkout::
 

pom.xml

@@ -101,6 +101,7 @@
     <dependency>
       <groupId>org.jenkins-ci.plugins</groupId>
       <artifactId>git-client</artifactId>
+      <version>3.4.2</version>
     </dependency>
     <dependency>
       <groupId>org.jenkins-ci.plugins</groupId>

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

@@ -4,6 +4,7 @@
 import com.cloudbees.plugins.credentials.CredentialsMatchers;
 import com.cloudbees.plugins.credentials.CredentialsProvider;
 import com.cloudbees.plugins.credentials.common.StandardUsernameCredentials;
+import com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials;
 import com.cloudbees.plugins.credentials.domains.URIRequirementBuilder;
 import com.google.common.collect.Iterables;
 
@@ -17,16 +18,8 @@
 import hudson.FilePath;
 import hudson.Launcher;
 import hudson.init.Initializer;
-import hudson.model.AbstractBuild;
-import hudson.model.AbstractProject;
+import hudson.model.*;
 import hudson.model.Descriptor.FormException;
-import hudson.model.Items;
-import hudson.model.Job;
-import hudson.model.Node;
-import hudson.model.Queue;
-import hudson.model.Run;
-import hudson.model.Saveable;
-import hudson.model.TaskListener;
 import hudson.plugins.git.browser.GitRepositoryBrowser;
 import hudson.plugins.git.extensions.GitSCMExtension;
 import hudson.plugins.git.extensions.GitSCMExtensionDescriptor;
@@ -59,6 +52,7 @@
 import hudson.util.ListBoxModel;
 import jenkins.model.Jenkins;
 import jenkins.plugins.git.GitSCMMatrixUtil;
+import jenkins.plugins.git.GitToolChooser;
 import net.sf.json.JSONObject;
 
 import org.eclipse.jgit.errors.MissingObjectException;
@@ -68,13 +62,7 @@
 import org.eclipse.jgit.transport.RefSpec;
 import org.eclipse.jgit.transport.RemoteConfig;
 import org.eclipse.jgit.transport.URIish;
-import org.jenkinsci.plugins.gitclient.ChangelogCommand;
-import org.jenkinsci.plugins.gitclient.CheckoutCommand;
-import org.jenkinsci.plugins.gitclient.CliGitAPIImpl;
-import org.jenkinsci.plugins.gitclient.CloneCommand;
-import org.jenkinsci.plugins.gitclient.FetchCommand;
-import org.jenkinsci.plugins.gitclient.Git;
-import org.jenkinsci.plugins.gitclient.GitClient;
+import org.jenkinsci.plugins.gitclient.*;
 import org.jenkinsci.plugins.scriptsecurity.sandbox.whitelists.Whitelisted;
 import org.kohsuke.stapler.DataBoundConstructor;
 import org.kohsuke.stapler.StaplerRequest;
@@ -448,6 +436,11 @@ public boolean isAllowSecondFetch() {
         return (gitDescriptor != null && gitDescriptor.isAllowSecondFetch());
     }
 
+    public boolean isDisableGitToolChooser() {
+        DescriptorImpl gitDescriptor = getDescriptor();
+        return (gitDescriptor != null && gitDescriptor.isDisableGitToolChooser());
+    }
+
     @Whitelisted
     public BuildChooser getBuildChooser() {
         BuildChooser bc;
@@ -844,6 +837,25 @@ public GitClient createClient(TaskListener listener, EnvVars environment, Run<?,
     /*package*/ GitClient createClient(TaskListener listener, EnvVars environment, Job project, Node n, FilePath ws) throws IOException, InterruptedException {
 
         String gitExe = getGitExe(n, listener);
+
+        if (!isDisableGitToolChooser()) {
+            UnsupportedCommand unsupportedCommand = new UnsupportedCommand();
+            for (GitSCMExtension ext : extensions) {
+                ext.determineSupportForJGit(this, unsupportedCommand);
+            }
+            GitToolChooser chooser = null;
+            for (UserRemoteConfig uc : getUserRemoteConfigs()) {
+                String ucCredentialsId = uc.getCredentialsId();
+                String url = getParameterString(uc.getUrl(), environment);
+                chooser = new GitToolChooser(url, project, ucCredentialsId, gitExe, unsupportedCommand.determineSupportForJGit());
+            }
+            listener.getLogger().println("The recommended git tool is: " + chooser.getGitTool());
+            String updatedGitExe = chooser.getGitTool();
+
+            if (!updatedGitExe.equals("NONE")) {
+                gitExe = updatedGitExe;
+            }
+        }
         Git git = Git.with(listener, environment).in(ws).using(gitExe);
 
         GitClient c = git.getClient();
@@ -857,17 +869,7 @@ public GitClient createClient(TaskListener listener, EnvVars environment, Run<?,
                 listener.getLogger().println("No credentials specified");
             } else {
                 String url = getParameterString(uc.getUrl(), environment);
-                List<StandardUsernameCredentials> urlCredentials = CredentialsProvider.lookupCredentials(
-                        StandardUsernameCredentials.class,
-                        project,
-                        project instanceof Queue.Task
-                                ? ((Queue.Task) project).getDefaultAuthentication()
-                                : ACL.SYSTEM,
-                        URIRequirementBuilder.fromUri(url).build()
-                );
-                CredentialsMatcher ucMatcher = CredentialsMatchers.withId(ucCredentialsId);
-                CredentialsMatcher idMatcher = CredentialsMatchers.allOf(ucMatcher, GitClient.CREDENTIALS_MATCHER);
-                StandardUsernameCredentials credentials = CredentialsMatchers.firstOrNull(urlCredentials, idMatcher);
+                StandardUsernameCredentials credentials = lookupScanCredentials(project, url, ucCredentialsId);
                 if (credentials != null) {
                     c.addCredentials(url, credentials);
                     if(!isHideCredentials()) {
@@ -888,6 +890,30 @@ public GitClient createClient(TaskListener listener, EnvVars environment, Run<?,
         return c;
     }
 
+    private static StandardUsernameCredentials lookupScanCredentials(@CheckForNull Item project,
+                                                              @CheckForNull String url,
+                                                              @CheckForNull String ucCredentialsId) {
+        if (Util.fixEmpty(ucCredentialsId) == null) {
+            return null;
+        } else {
+            return CredentialsMatchers.firstOrNull(
+                    CredentialsProvider.lookupCredentials(
+                            StandardUsernameCredentials.class,
+                            project,
+                            project instanceof Queue.Task
+                                    ? ((Queue.Task) project).getDefaultAuthentication()
+                                    : ACL.SYSTEM,
+                            URIRequirementBuilder.fromUri(url).build()
+                    ),
+                    CredentialsMatchers.allOf(CredentialsMatchers.withId(ucCredentialsId), GitClient.CREDENTIALS_MATCHER)
+            );
+        }
+    }
+
+    private static CredentialsMatcher gitScanCredentialsMatcher() {
+        return CredentialsMatchers.anyOf(CredentialsMatchers.instanceOf(StandardUsernamePasswordCredentials.class));
+    }
+
     @NonNull
     private BuildData fixNull(BuildData bd) {
         ScmName sn = getExtensions().get(ScmName.class);
@@ -1537,6 +1563,7 @@ public static final class DescriptorImpl extends SCMDescriptor<GitSCM> {
         private boolean showEntireCommitSummaryInChanges;
         private boolean hideCredentials;
         private boolean allowSecondFetch;
+        private boolean disableGitToolChooser;
 
         public DescriptorImpl() {
             super(GitSCM.class, GitRepositoryBrowser.class);
@@ -1672,6 +1699,10 @@ public void setAllowSecondFetch(boolean allowSecondFetch) {
             this.allowSecondFetch = allowSecondFetch;
         }
 
+        public boolean isDisableGitToolChooser() { return disableGitToolChooser; }
+
+        public void setDisableGitToolChooser(boolean disableGitToolChooser) { this.disableGitToolChooser = disableGitToolChooser; }
+
         /**
          * Old configuration of git executable - exposed so that we can
          * migrate this setting to GitTool without deprecation warnings.

src/main/java/hudson/plugins/git/extensions/GitSCMExtension.java

@@ -24,11 +24,8 @@
 import java.io.File;
 import java.io.IOException;
 import java.util.Map;
-import org.jenkinsci.plugins.gitclient.CheckoutCommand;
-import org.jenkinsci.plugins.gitclient.CloneCommand;
-import org.jenkinsci.plugins.gitclient.FetchCommand;
-import org.jenkinsci.plugins.gitclient.GitClient;
-import org.jenkinsci.plugins.gitclient.MergeCommand;
+
+import org.jenkinsci.plugins.gitclient.*;
 
 /**
  * Extension point to tweak the behaviour of {@link GitSCM}.
@@ -233,6 +230,15 @@ public GitClient decorate(GitSCM scm, GitClient git) throws IOException, Interru
         return git;
     }
 
+    /**
+     * Called when support of JGit for a particular or multiple extensions is to be determined
+     * @param scm GitSCM object
+     * @param unsupportedCommand UnsupportedCommand object
+     */
+    public void determineSupportForJGit(GitSCM scm, UnsupportedCommand unsupportedCommand) {
+
+    }
+
     /**
      * Called before a {@link CloneCommand} is executed to allow extensions to alter its behaviour.
      * @param scm GitSCM object

src/main/java/hudson/plugins/git/extensions/impl/CheckoutOption.java

@@ -14,6 +14,7 @@
 import java.util.Objects;
 import org.jenkinsci.plugins.gitclient.CheckoutCommand;
 import org.jenkinsci.plugins.gitclient.GitClient;
+import org.jenkinsci.plugins.gitclient.UnsupportedCommand;
 import org.kohsuke.stapler.DataBoundConstructor;
 
 /**
@@ -50,6 +51,11 @@ public void decorateCheckoutCommand(GitSCM scm, Run<?, ?> build, GitClient git,
         cmd.timeout(timeout);
     }
 
+    @Override
+    public void determineSupportForJGit(GitSCM scm, UnsupportedCommand cmd) {
+        cmd.timeout(timeout);
+    }
+
     /**
      * {@inheritDoc}
      */

src/main/java/hudson/plugins/git/extensions/impl/CloneOption.java

@@ -21,6 +21,7 @@
 import org.jenkinsci.plugins.gitclient.CloneCommand;
 import org.jenkinsci.plugins.gitclient.FetchCommand;
 import org.jenkinsci.plugins.gitclient.GitClient;
+import org.jenkinsci.plugins.gitclient.UnsupportedCommand;
 import org.jenkinsci.plugins.scriptsecurity.sandbox.whitelists.Whitelisted;
 import org.kohsuke.stapler.DataBoundConstructor;
 import org.kohsuke.stapler.DataBoundSetter;
@@ -185,6 +186,13 @@ public void decorateFetchCommand(GitSCM scm, GitClient git, TaskListener listene
         cmd.timeout(timeout);
     }
 
+    @Override
+    public void determineSupportForJGit(GitSCM scm, UnsupportedCommand cmd) {
+        cmd.timeout(timeout);
+        cmd.shallow(shallow);
+        cmd.depth(depth);
+    }
+
     /**
      * {@inheritDoc}
      */

src/main/java/hudson/plugins/git/extensions/impl/GitLFSPull.java

@@ -12,6 +12,7 @@
 import org.eclipse.jgit.transport.RemoteConfig;
 import org.jenkinsci.plugins.gitclient.CheckoutCommand;
 import org.jenkinsci.plugins.gitclient.GitClient;
+import org.jenkinsci.plugins.gitclient.UnsupportedCommand;
 import org.kohsuke.stapler.DataBoundConstructor;
 
 /**
@@ -44,6 +45,12 @@ public void decorateCheckoutCommand(GitSCM scm, Run<?, ?> build, GitClient git,
         }
     }
 
+    @Override
+    public void determineSupportForJGit(GitSCM scm, UnsupportedCommand cmd) {
+        List<RemoteConfig> repos = scm.getRepositories();
+        cmd.lfsRemote(repos.get(0).getName());
+    }
+
     /**
      * {@inheritDoc}
      */

src/main/java/hudson/plugins/git/extensions/impl/SparseCheckoutPaths.java

@@ -11,6 +11,7 @@
 import org.jenkinsci.plugins.gitclient.CheckoutCommand;
 import org.jenkinsci.plugins.gitclient.CloneCommand;
 import org.jenkinsci.plugins.gitclient.GitClient;
+import org.jenkinsci.plugins.gitclient.UnsupportedCommand;
 import org.jenkinsci.plugins.scriptsecurity.sandbox.whitelists.Whitelisted;
 import org.kohsuke.stapler.DataBoundConstructor;
 
@@ -44,6 +45,11 @@ public void decorateCheckoutCommand(GitSCM scm, Run<?, ?> build, GitClient git,
         cmd.sparseCheckoutPaths(Lists.transform(sparseCheckoutPaths, SparseCheckoutPath.SPARSE_CHECKOUT_PATH_TO_PATH));
     }
 
+    @Override
+    public void determineSupportForJGit(GitSCM scm, UnsupportedCommand cmd) {
+        cmd.sparseCheckoutPaths(Lists.transform(sparseCheckoutPaths, SparseCheckoutPath.SPARSE_CHECKOUT_PATH_TO_PATH));
+    }
+
     @Extension
     public static class DescriptorImpl extends GitSCMExtensionDescriptor {
         @Override

src/main/java/hudson/plugins/git/extensions/impl/SubmoduleOption.java

@@ -14,6 +14,7 @@
 import java.util.Objects;
 import org.jenkinsci.plugins.gitclient.GitClient;
 import org.jenkinsci.plugins.gitclient.SubmoduleUpdateCommand;
+import org.jenkinsci.plugins.gitclient.UnsupportedCommand;
 import org.jenkinsci.plugins.scriptsecurity.sandbox.whitelists.Whitelisted;
 import org.kohsuke.stapler.DataBoundConstructor;
 import org.kohsuke.stapler.DataBoundSetter;
@@ -181,6 +182,16 @@ public void onCheckoutCompleted(GitSCM scm, Run<?, ?> build, GitClient git, Task
         }
     }
 
+    @Override
+    public void determineSupportForJGit(GitSCM scm, UnsupportedCommand cmd) {
+        cmd.threads(threads);
+        cmd.depth(depth);
+        cmd.shallow(shallow);
+        cmd.timeout(timeout);
+        cmd.ref(reference);
+        cmd.parentCredentials(parentCredentials);
+    }
+
     /**
      * {@inheritDoc}
      */