Add method to ScmManager to get an ScmRepository from an existing

directory

It tries to find a suitable provider by using
ScmProvider.makeProviderScmRepository(directory) on all providers

Extend checkout Tck to make sure that the working directory is
recognized
afterwards by the provider.

Author: kwin

maven-scm-api/src/main/java/org/apache/maven/scm/manager/AbstractScmManager.java

@@ -23,6 +23,7 @@
 import java.util.Date;
 import java.util.List;
 import java.util.Map;
+import java.util.Optional;
 import java.util.concurrent.ConcurrentHashMap;
 
 import org.apache.maven.scm.CommandParameters;
@@ -245,6 +246,28 @@ public ScmRepository makeProviderScmRepository(String providerType, File path)
         return new ScmRepository(providerType, providerRepository);
     }
 
+    @Override
+    public Optional<ScmRepository> makeProviderScmRepository(File workingDirectory) {
+        //
+        for (ScmProvider provider : scmProviders.values()) {
+            logger.debug(
+                    "Checking if SCM provider {} is suitable for processing: {}",
+                    provider.getScmType(),
+                    workingDirectory);
+            try {
+                ScmProviderRepository providerRepository = provider.makeProviderScmRepository(workingDirectory);
+                return Optional.of(new ScmRepository(provider.getScmType(), providerRepository));
+            } catch (ScmRepositoryException | UnknownRepositoryStructure e) {
+                logger.debug(
+                        "SCM provider {} is not suitable for processing: {}",
+                        provider.getScmType(),
+                        workingDirectory,
+                        e);
+            }
+        }
+        return Optional.empty();
+    }
+
     /**
      * {@inheritDoc}
      */

maven-scm-api/src/main/java/org/apache/maven/scm/manager/ScmManager.java

@@ -21,6 +21,7 @@
 import java.io.File;
 import java.util.Date;
 import java.util.List;
+import java.util.Optional;
 
 import org.apache.maven.scm.CommandParameters;
 import org.apache.maven.scm.ScmBranch;
@@ -62,18 +63,36 @@ public interface ScmManager {
     // ----------------------------------------------------------------------
 
     /**
-     * Generate a SCMRepository  from an SCM URL.
+     * Generate a {@link ScmRepository} from an SCM URL.
      *
      * @param scmUrl the scm url
-     * @return the scm repository
+     * @return the scm repository (never {@code null})
      * @throws NoSuchScmProviderException if the provider doesn't exist
      * @throws ScmRepositoryException     if an error occurs in the scm repository construction
      */
     ScmRepository makeScmRepository(String scmUrl) throws ScmRepositoryException, NoSuchScmProviderException;
 
+    /**
+     * Generate a {@link ScmRepository} for a specific provider and a given checkout (working) directory
+     * @param providerType
+     * @param path the checkout (working) directory
+     * @return the SCM repository (never {@code null})
+     * @throws ScmRepositoryException if the provider does not recognize the directory
+     * @throws UnknownRepositoryStructure if the provider does not support this way of generating a {@link ScmRepository}
+     * @throws NoSuchScmProviderException if the given provider type does not have a provider implementation bound
+     */
     ScmRepository makeProviderScmRepository(String providerType, File path)
             throws ScmRepositoryException, UnknownRepositoryStructure, NoSuchScmProviderException;
 
+    /**
+     * Generate a {@link ScmRepository} for a given checkout (working) directory.
+     * Determines a suitable SCM provider for the directory by looking for SCM specific metadata files.
+     * @param path the checkout (working) directory
+     * @return the {@link ScmRepository} or empty if no suitable provider found
+     * @since 2.2.1
+     */
+    Optional<ScmRepository> makeProviderScmRepository(File path);
+
     /**
      * Validate a SCM URL.
      *

maven-scm-api/src/main/java/org/apache/maven/scm/provider/ScmProvider.java

@@ -65,6 +65,14 @@ public interface ScmProvider {
     ScmProviderRepository makeProviderScmRepository(String scmSpecificUrl, char delimiter)
             throws ScmRepositoryException;
 
+    /**
+     * Try to create a {@link ScmProviderRepository} for this provider from the given working directory (created through a previous checkout).
+     * This is only successful if the working directory is recognized by this SCM provider.
+     * @param path the checkout(working) directory
+     * @return the repository bound to this provider
+     * @throws ScmRepositoryException in case the given directory does not contain a valid working directory recognized by this provider
+     * @throws UnknownRepositoryStructure in case the provider does not support this way of initializing an ScmProviderRepository
+     */
     ScmProviderRepository makeProviderScmRepository(File path)
             throws ScmRepositoryException, UnknownRepositoryStructure;
 

maven-scm-providers/maven-scm-providers-git/maven-scm-provider-jgit/src/main/java/org/apache/maven/scm/provider/git/jgit/JGitScmProvider.java

@@ -44,6 +44,7 @@
 import org.apache.maven.scm.provider.git.jgit.command.status.JGitStatusCommand;
 import org.apache.maven.scm.provider.git.jgit.command.tag.JGitTagCommand;
 import org.apache.maven.scm.provider.git.jgit.command.untag.JGitUntagCommand;
+import org.apache.maven.scm.provider.git.repository.GitScmProviderRepository;
 import org.apache.maven.scm.repository.ScmRepositoryException;
 import org.codehaus.plexus.components.interactivity.Prompter;
 import org.eclipse.jgit.transport.CredentialsProvider;
@@ -188,7 +189,8 @@ protected String getRepositoryURL(File path) throws ScmException {
         // Note: I need to supply just 1 absolute path, but ScmFileSet won't let
         // me without
         // a basedir (which isn't used here anyway), so use a dummy file.
-        InfoScmResult result = info(null, new ScmFileSet(new File(""), path), null);
+        InfoScmResult result =
+                info(new GitScmProviderRepository(path.toPath().toUri().toASCIIString()), new ScmFileSet(path), null);
 
         if (result.getInfoItems().size() != 1) {
             throw new ScmRepositoryException("Cannot find URL: "

maven-scm-test/src/main/java/org/apache/maven/scm/manager/ScmManagerStub.java

@@ -22,6 +22,7 @@
 import java.util.ArrayList;
 import java.util.Date;
 import java.util.List;
+import java.util.Optional;
 
 import org.apache.maven.scm.CommandParameters;
 import org.apache.maven.scm.ScmBranch;
@@ -141,6 +142,11 @@ public ScmRepository makeProviderScmRepository(String providerType, File path)
         return getScmRepository();
     }
 
+    @Override
+    public Optional<ScmRepository> makeProviderScmRepository(File path) {
+        return Optional.ofNullable(getScmRepository());
+    }
+
     /**
      * Returns the same list as getMessages()
      *

maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/checkout/CheckOutCommandTckTest.java

@@ -20,15 +20,21 @@
 
 import java.util.Iterator;
 import java.util.List;
+import java.util.Optional;
 import java.util.SortedSet;
 import java.util.TreeSet;
 
 import org.apache.maven.scm.ScmFile;
 import org.apache.maven.scm.ScmTckTestCase;
 import org.apache.maven.scm.command.checkout.CheckOutScmResult;
+import org.apache.maven.scm.provider.ScmProvider;
+import org.apache.maven.scm.repository.ScmRepository;
+import org.apache.maven.scm.repository.UnknownRepositoryStructure;
 import org.junit.Test;
 
+import static org.junit.Assert.assertTrue;
 import static org.junit.Assert.fail;
+import static org.junit.Assume.assumeTrue;
 
 /**
  * This test tests the check out command.
@@ -60,4 +66,24 @@ public void testCheckOutCommandTest() throws Exception {
             fail("Expected 4 files in the updated files list, was " + checkedOutFiles.size());
         }
     }
+
+    @Test
+    public void testMakeProviderScmRepositoryFromCheckoutDirectory() throws Exception {
+        assumeTrue(isMakeProviderScmRepositoryFromDirectorySupportedByProvider());
+        CheckOutScmResult result = checkOut(getWorkingCopy(), getScmRepository());
+        assertResultIsSuccess(result);
+        Optional<ScmRepository> repository = getScmManager().makeProviderScmRepository(getWorkingCopy());
+        assertTrue("Could not detect SCM repository for working copy at " + getWorkingCopy(), repository.isPresent());
+    }
+
+    private boolean isMakeProviderScmRepositoryFromDirectorySupportedByProvider() throws Exception {
+        ScmProvider provider = getScmManager().getProviderByUrl(getScmUrl());
+        try {
+            provider.makeProviderScmRepository(getWorkingCopy());
+        } catch (UnknownRepositoryStructure e) {
+            // in this case the provider does not support this operation
+            return false;
+        }
+        return true;
+    }
 }