Merge pull request #679 from Dohbedoh/feature/JENKINS-56189

[JENKINS-56189] Add Sparse Checkout SCM trait

Author: MarkEWaite

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

@@ -16,6 +16,7 @@
 import java.io.IOException;
 import java.util.Collections;
 import java.util.List;
+import java.util.Objects;
 
 public class SparseCheckoutPaths extends GitSCMExtension {
     private List<SparseCheckoutPath> sparseCheckoutPaths = Collections.emptyList();
@@ -49,4 +50,39 @@ public String getDisplayName() {
             return "Sparse Checkout paths";
         }
     }
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) {
+            return true;
+        }
+        
+        if (o == null || getClass() != o.getClass()) {
+            return false;
+        }
+        
+        SparseCheckoutPaths that = (SparseCheckoutPaths) o;
+        return Objects.equals(getSparseCheckoutPaths(), that.getSparseCheckoutPaths());
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public int hashCode() {
+        return Objects.hash(getSparseCheckoutPaths());
+    }
+    
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public String toString() {
+        return "SparseCheckoutPaths{" +
+                "sparseCheckoutPaths=" + sparseCheckoutPaths +
+                '}';
+    }
 }

src/main/java/jenkins/plugins/git/traits/SparseCheckoutPathsTrait.java

@@ -0,0 +1,37 @@
+package jenkins.plugins.git.traits;
+
+import hudson.Extension;
+import hudson.plugins.git.extensions.impl.SparseCheckoutPaths;
+import jenkins.scm.api.trait.SCMSourceTrait;
+import org.kohsuke.stapler.DataBoundConstructor;
+
+/**
+ * Exposes {@link SparseCheckoutPaths} as a {@link SCMSourceTrait}.
+ *
+ * @since 4.0.1
+ */
+public class SparseCheckoutPathsTrait extends GitSCMExtensionTrait<SparseCheckoutPaths> {
+    /**
+     * Stapler constructor.
+     *
+     * @param extension the {@link SparseCheckoutPaths}
+     */
+    @DataBoundConstructor
+    public SparseCheckoutPathsTrait(SparseCheckoutPaths extension) {
+        super(extension);
+    }
+
+    /**
+     * Our {@link hudson.model.Descriptor}
+     */
+    @Extension
+    public static class DescriptorImpl extends GitSCMExtensionTraitDescriptor {
+        /**
+         * {@inheritDoc}
+         */
+        @Override
+        public String getDisplayName() {
+            return "Sparse Checkout paths";
+        }
+    }
+}

src/test/java/jenkins/plugins/git/GitSCMSourceTraitsTest.java

@@ -10,11 +10,14 @@
 import hudson.plugins.git.extensions.impl.GitLFSPull;
 import hudson.plugins.git.extensions.impl.LocalBranch;
 import hudson.plugins.git.extensions.impl.PruneStaleBranch;
+import hudson.plugins.git.extensions.impl.SparseCheckoutPaths;
 import hudson.plugins.git.extensions.impl.SubmoduleOption;
 import hudson.plugins.git.extensions.impl.UserIdentity;
 import hudson.plugins.git.extensions.impl.WipeWorkspace;
+
 import java.util.Collections;
 import jenkins.model.Jenkins;
+
 import jenkins.plugins.git.traits.AuthorInChangelogTrait;
 import jenkins.plugins.git.traits.BranchDiscoveryTrait;
 import jenkins.plugins.git.traits.CheckoutOptionTrait;
@@ -28,6 +31,7 @@
 import jenkins.plugins.git.traits.PruneStaleBranchTrait;
 import jenkins.plugins.git.traits.RefSpecsSCMSourceTrait;
 import jenkins.plugins.git.traits.RemoteNameSCMSourceTrait;
+import jenkins.plugins.git.traits.SparseCheckoutPathsTrait;
 import jenkins.plugins.git.traits.SubmoduleOptionTrait;
 import jenkins.plugins.git.traits.UserIdentityTrait;
 import jenkins.plugins.git.traits.WipeWorkspaceTrait;
@@ -45,6 +49,7 @@
 import static org.hamcrest.Matchers.containsInAnyOrder;
 import static org.hamcrest.Matchers.empty;
 import static org.hamcrest.Matchers.hasProperty;
+import static org.hamcrest.Matchers.hasSize;
 import static org.hamcrest.Matchers.instanceOf;
 import static org.hamcrest.Matchers.is;
 import static org.hamcrest.Matchers.nullValue;
@@ -156,6 +161,14 @@ public void pimpped_out() throws Exception {
                                                 hasProperty("repoUrl", is("foo"))
                                         )
                                 )
+                        ),
+                        Matchers.<SCMSourceTrait>allOf(
+                                instanceOf(SparseCheckoutPathsTrait.class),
+                                hasProperty("extension",
+                                        allOf(
+                                                hasProperty("sparseCheckoutPaths", hasSize(2))
+                                        )
+                                )
                         )
                 )
         );
@@ -201,7 +214,11 @@ public void pimpped_out() throws Exception {
                         Matchers.<GitSCMExtension>instanceOf(GitLFSPull.class),
                         Matchers.<GitSCMExtension>instanceOf(PruneStaleBranch.class),
                         Matchers.<GitSCMExtension>instanceOf(AuthorInChangelog.class),
-                        Matchers.<GitSCMExtension>instanceOf(WipeWorkspace.class)
+                        Matchers.<GitSCMExtension>instanceOf(WipeWorkspace.class),
+                        Matchers.<GitSCMExtension>allOf(
+                                instanceOf(SparseCheckoutPaths.class),
+                                hasProperty("sparseCheckoutPaths", hasSize(2))
+                        )
                 )
         );
         assertThat(instance.getBrowser(), allOf(