Fixes #2900 : Add Repository isNestable() property

- Set new property to true for Git and Mercurial.
- Do not limit nested repos only to same type as
  parent.

Author: idodeclare

opengrok-indexer/src/main/java/org/opengrok/indexer/history/GitRepository.java

@@ -536,6 +536,15 @@ boolean supportsSubRepositories() {
         return true;
     }
 
+    /**
+     * Gets a value indicating the instance is nestable.
+     * @return {@code true}
+     */
+    @Override
+    boolean isNestable() {
+        return true;
+    }
+
     @Override
     public boolean isWorking() {
         if (working == null) {

opengrok-indexer/src/main/java/org/opengrok/indexer/history/HistoryGuru.java

@@ -19,7 +19,7 @@
 
 /*
  * Copyright (c) 2005, 2019, Oracle and/or its affiliates. All rights reserved.
- * Portions Copyright (c) 2017-2018, Chris Fraire <[email protected]>.
+ * Portions Copyright (c) 2017-2019, Chris Fraire <[email protected]>.
  */
 package org.opengrok.indexer.history;
 
@@ -387,13 +387,15 @@ public Map<String, Date> getLastModifiedTimes(File directory)
      * @param files list of files to check if they contain a repository
      * @param ignoredNames what files to ignore
      * @param recursiveSearch whether to use recursive search
-     * @param type type of the repository to search for or {@code null}
      * @param depth current depth - using global scanningDepth - one can limit
      * this to improve scanning performance
+     * @param isNested a value indicating if a parent {@link Repository} was
+     * already found above the {@code files}
      * @return collection of added repositories
      */
     private Collection<RepositoryInfo> addRepositories(File[] files,
-            IgnoredNames ignoredNames, boolean recursiveSearch, String type, int depth) {
+            IgnoredNames ignoredNames, boolean recursiveSearch, int depth,
+            boolean isNested) {
 
         List<RepositoryInfo> repoList = new ArrayList<>();
 
@@ -408,7 +410,7 @@ private Collection<RepositoryInfo> addRepositories(File[] files,
 
                 Repository repository = null;
                 try {
-                    repository = RepositoryFactory.getRepository(file, type);
+                    repository = RepositoryFactory.getRepository(file, false, isNested);
                 } catch (InstantiationException | NoSuchMethodException | InvocationTargetException e) {
                     LOGGER.log(Level.WARNING, "Could not create repository for '"
                             + file + "', could not instantiate the repository.", e);
@@ -429,8 +431,8 @@ private Collection<RepositoryInfo> addRepositories(File[] files,
                                     "check access permissions.",
                                     file.getAbsolutePath());
                         } else if (depth <= scanningDepth) {
-                            repoList.addAll(HistoryGuru.this.addRepositories(subFiles, ignoredNames,
-                                    recursiveSearch, type, depth + 1));
+                            repoList.addAll(addRepositories(subFiles, ignoredNames,
+                                    recursiveSearch, depth + 1, isNested));
                         }
                     }
                 } else {
@@ -447,9 +449,10 @@ private Collection<RepositoryInfo> addRepositories(File[] files,
                                     "Failed to get sub directories for ''{0}'', check access permissions.",
                                     file.getAbsolutePath());
                         } else if (depth <= scanningDepth) {
-                            // Search only for one type of repository - the one found here.
-                            repoList.addAll(HistoryGuru.this.addRepositories(subFiles, ignoredNames,
-                                    false, repository.getType(), depth + 1));
+                            // Search only one level down - if not: too much
+                            // stat'ing for huge Mercurial repositories
+                            repoList.addAll(addRepositories(subFiles, ignoredNames,
+                                    false, depth + 1, true));
                         }
                     }
                 }
@@ -464,13 +467,6 @@ private Collection<RepositoryInfo> addRepositories(File[] files,
         return repoList;
     }
 
-    private Collection<RepositoryInfo>
-        addRepositories(File[] files, Collection<RepositoryInfo> repos,
-                IgnoredNames ignoredNames, int depth) {
-
-        return HistoryGuru.this.addRepositories(files, ignoredNames, true, null, depth);
-    }
-
     /**
      * Recursively search for repositories in given directories, add those found
      * to the internally used repository map.
@@ -482,7 +478,7 @@ private Collection<RepositoryInfo> addRepositories(File[] files,
     public Collection<RepositoryInfo> addRepositories(File[] files,
             IgnoredNames ignoredNames) {
 
-        return HistoryGuru.this.addRepositories(files, ignoredNames, true, null, 0);
+        return addRepositories(files, ignoredNames, true, 0, false);
     }
 
     /**
@@ -496,7 +492,7 @@ public Collection<RepositoryInfo> addRepositories(File[] files,
     public Collection<RepositoryInfo> addRepositories(Collection<String> repos,
             IgnoredNames ignoredNames) {
 
-        return HistoryGuru.this.addRepositories(repos.stream().
+        return addRepositories(repos.stream().
                 map(r -> new File(r)).
                 collect(Collectors.toList()).toArray(new File[0]), ignoredNames);
     }

opengrok-indexer/src/main/java/org/opengrok/indexer/history/MercurialRepository.java

@@ -19,7 +19,7 @@
 
 /*
  * Copyright (c) 2006, 2019, Oracle and/or its affiliates. All rights reserved.
- * Portions Copyright (c) 2017-2018, Chris Fraire <[email protected]>.
+ * Portions Copyright (c) 2017-2019, Chris Fraire <[email protected]>.
  */
 package org.opengrok.indexer.history;
 
@@ -493,6 +493,15 @@ boolean supportsSubRepositories() {
                 : Boolean.parseBoolean(val));
     }
 
+    /**
+     * Gets a value indicating the instance is nestable.
+     * @return {@code true}
+     */
+    @Override
+    boolean isNestable() {
+        return true;
+    }
+
     @Override
     public boolean isWorking() {
         if (working == null) {

opengrok-indexer/src/main/java/org/opengrok/indexer/history/Repository.java

@@ -19,7 +19,7 @@
 
 /*
  * Copyright (c) 2008, 2018, Oracle and/or its affiliates. All rights reserved.
- * Portions Copyright (c) 2017-2018, Chris Fraire <[email protected]>.
+ * Portions Copyright (c) 2017-2019, Chris Fraire <[email protected]>.
  */
 package org.opengrok.indexer.history;
 
@@ -506,6 +506,14 @@ boolean supportsSubRepositories() {
         return false;
     }
 
+    /**
+     * Subclasses can override to get a value indicating that a repository implementation is nestable.
+     * @return {@code false}
+     */
+    boolean isNestable() {
+        return false;
+    }
+
     private DateFormat getDateFormat() {
         return new RepositoryDateFormat();
     }

opengrok-indexer/src/main/java/org/opengrok/indexer/history/RepositoryFactory.java

@@ -19,7 +19,7 @@
 
 /*
  * Copyright (c) 2008, 2019, Oracle and/or its affiliates. All rights reserved.
- * Portions Copyright (c) 2017, Chris Fraire <[email protected]>.
+ * Portions Copyright (c) 2017, 2019, Chris Fraire <[email protected]>.
  */
 package org.opengrok.indexer.history;
 
@@ -81,18 +81,24 @@ public static List<Class<? extends Repository>> getRepositoryClasses() {
         return list;
     }
 
-    public static Repository getRepository(File file, String type)
+    /**
+     * Calls {@link #getRepository(File, boolean)} with {@code file} and {@code false}.
+     */
+    public static Repository getRepository(File file)
             throws InstantiationException, IllegalAccessException, NoSuchMethodException, InvocationTargetException,
             IOException, ForbiddenSymlinkException {
-        return getRepository(file, false, type);
+        return getRepository(file, false);
     }
 
-    public static Repository getRepository(File file)
-            throws InstantiationException, IllegalAccessException, NoSuchMethodException, InvocationTargetException,
-            IOException, ForbiddenSymlinkException {
-        return getRepository(file, false, null);
+    /**
+     * Calls {@link #getRepository(File, boolean, boolean)} with {@code file}, {@code interactive}, and {@code false}.
+     */
+    public static Repository getRepository(File file, boolean interactive)
+            throws IllegalAccessException, InvocationTargetException, ForbiddenSymlinkException, InstantiationException,
+            NoSuchMethodException, IOException {
+        return getRepository(file, interactive, false);
     }
-    
+
     /**
      * Returns a repository for the given file, or null if no repository was
      * found.
@@ -104,8 +110,8 @@ public static Repository getRepository(File file)
      * use interactive command timeout (as specified in {@code Configuration}).
      *
      * @param file File that might contain a repository
-     * @param interactive true if running in interactive mode
-     * @param type type of the repository to search for or {@code null}
+     * @param interactive a value indicating if running in interactive mode
+     * @param isNested a value indicating if a nestable {@link Repository} is required
      * @return Correct repository for the given file
      * @throws InstantiationException in case we cannot create the repository object
      * @throws IllegalAccessException in case no permissions to repository file
@@ -114,18 +120,14 @@ public static Repository getRepository(File file)
      * @throws IOException when resolving repository path
      * @throws ForbiddenSymlinkException when resolving repository path
      */
-    public static Repository getRepository(File file, boolean interactive, String type)
+    public static Repository getRepository(File file, boolean interactive, boolean isNested)
             throws InstantiationException, IllegalAccessException, NoSuchMethodException, InvocationTargetException,
             IOException, ForbiddenSymlinkException {
         RuntimeEnvironment env = RuntimeEnvironment.getInstance();
         Repository repo = null;
 
         for (Repository rep : repositories) {
-            if (type != null && !type.equals(rep.getType())) {
-                continue;
-            }
-
-            if (rep.isRepositoryFor(file, interactive)) {
+            if ((!isNested || rep.isNestable()) && rep.isRepositoryFor(file, interactive)) {
                 repo = rep.getClass().getDeclaredConstructor().newInstance();
 
                 if (env.isProjectsEnabled() && env.getPathRelativeToSourceRoot(file).equals(File.separator)) {
@@ -212,7 +214,7 @@ public static Repository getRepository(File file, boolean interactive, String ty
     public static Repository getRepository(RepositoryInfo info, boolean interactive)
             throws InstantiationException, IllegalAccessException, NoSuchMethodException, InvocationTargetException,
             IOException, ForbiddenSymlinkException {
-        return getRepository(new File(info.getDirectoryName()), interactive, null);
+        return getRepository(new File(info.getDirectoryName()), interactive);
     }
 
     /**

opengrok-indexer/src/test/java/org/opengrok/indexer/history/CVSRepositoryTest.java

@@ -19,7 +19,7 @@
 
 /*
  * Copyright (c) 2008, 2018, Oracle and/or its affiliates. All rights reserved.
- * Portions Copyright (c) 2018, Chris Fraire <[email protected]>.
+ * Portions Copyright (c) 2018-2019, Chris Fraire <[email protected]>.
  */
 package org.opengrok.indexer.history;
 
@@ -102,7 +102,7 @@ public void setUp() {
      * @param reposRoot directory of the repository root
      * @param args arguments to use for the command
      */
-    private static void runCvsCommand(File reposRoot, String ... args) {
+    public static void runCvsCommand(File reposRoot, String ... args) {
         List<String> cmdargs = new ArrayList<>();
         CVSRepository repo = new CVSRepository();
         cmdargs.add(repo.getRepoCommand());

opengrok-indexer/src/test/java/org/opengrok/indexer/history/HistoryGuruTest.java

@@ -19,9 +19,14 @@
 
 /*
  * Copyright (c) 2008, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Portions Copyright (c) 2019, Chris Fraire <[email protected]>.
  */
 package org.opengrok.indexer.history;
 
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertTrue;
+
 import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
@@ -43,8 +48,6 @@
 import org.opengrok.indexer.util.FileUtilities;
 import org.opengrok.indexer.util.TestRepository;
 
-import static org.junit.Assert.*;
-
 /**
  * Test the functionality provided by the HistoryGuru (with friends)
  *
@@ -174,21 +177,21 @@ public void testAddRemoveRepositories() {
     }
 
     @Test
-    @ConditionalRun(RepositoryInstalled.GitInstalled.class)
+    @ConditionalRun(RepositoryInstalled.CvsInstalled.class)
     @ConditionalRun(RepositoryInstalled.MercurialInstalled.class)
-    public void testAddSubRepositoryNoTypeMatch() {
+    public void testAddSubRepositoryNotNestable() {
         HistoryGuru instance = HistoryGuru.getInstance();
         RuntimeEnvironment env = RuntimeEnvironment.getInstance();
 
-        // Clone a Mercurial repository underneath a Git repository.
-        File hgRoot = new File(repository.getSourceRoot(), "mercurial");
-        assertTrue(hgRoot.exists());
-        assertTrue(hgRoot.isDirectory());
+        // Check out CVS underneath a Git repository.
+        File cvsRoot = new File(repository.getSourceRoot(), "cvs_test");
+        assertTrue(cvsRoot.exists());
+        assertTrue(cvsRoot.isDirectory());
         File gitRoot = new File(repository.getSourceRoot(), "git");
         assertTrue(gitRoot.exists());
         assertTrue(gitRoot.isDirectory());
-        MercurialRepositoryTest.runHgCommand(gitRoot,
-                "clone", hgRoot.getAbsolutePath(), "subrepo");
+        CVSRepositoryTest.runCvsCommand(gitRoot, "-d",
+                cvsRoot.toPath().resolve("cvsroot").toFile().getAbsolutePath(), "checkout", "cvsrepo");
 
         Collection<RepositoryInfo> addedRepos = instance.
                 addRepositories(Collections.singleton(Paths.get(repository.getSourceRoot(), "git").toString()),