add sub-repositories of the same type as parent (#2817)

fixes #1461

Author: Vladimir Kotal

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

@@ -387,12 +387,13 @@ 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
      * @return collection of added repositories
      */
     private Collection<RepositoryInfo> addRepositories(File[] files,
-            IgnoredNames ignoredNames, boolean recursiveSearch, int depth) {
+            IgnoredNames ignoredNames, boolean recursiveSearch, String type, int depth) {
 
         List<RepositoryInfo> repoList = new ArrayList<>();
 
@@ -407,7 +408,7 @@ private Collection<RepositoryInfo> addRepositories(File[] files,
 
                 Repository repository = null;
                 try {
-                    repository = RepositoryFactory.getRepository(file);
+                    repository = RepositoryFactory.getRepository(file, type);
                 } catch (InstantiationException | NoSuchMethodException | InvocationTargetException e) {
                     LOGGER.log(Level.WARNING, "Could not create repository for '"
                             + file + "', could not instantiate the repository.", e);
@@ -429,7 +430,7 @@ private Collection<RepositoryInfo> addRepositories(File[] files,
                                     file.getAbsolutePath());
                         } else if (depth <= scanningDepth) {
                             repoList.addAll(HistoryGuru.this.addRepositories(subFiles, ignoredNames,
-                                    recursiveSearch, depth + 1));
+                                    recursiveSearch, null,depth + 1));
                         }
                     }
                 } else {
@@ -439,18 +440,16 @@ private Collection<RepositoryInfo> addRepositories(File[] files,
                     repoList.add(new RepositoryInfo(repository));
                     putRepository(repository);
 
-                    // @TODO: Search only for one type of repository - the one found here
                     if (recursiveSearch && repository.supportsSubRepositories()) {
                         File[] subFiles = file.listFiles();
                         if (subFiles == null) {
                             LOGGER.log(Level.WARNING,
                                     "Failed to get sub directories for ''{0}'', check access permissions.",
                                     file.getAbsolutePath());
                         } else if (depth <= scanningDepth) {
-                            // Search only one level down - if not: too much
-                            // stat'ing for huge Mercurial repositories
+                            // Search only for one type of repository - the one found here.
                             repoList.addAll(HistoryGuru.this.addRepositories(subFiles, ignoredNames,
-                                    false, depth + 1));
+                                    false, repository.getType(), depth + 1));
                         }
                     }
                 }
@@ -469,7 +468,7 @@ private Collection<RepositoryInfo> addRepositories(File[] files,
         addRepositories(File[] files, Collection<RepositoryInfo> repos,
                 IgnoredNames ignoredNames, int depth) {
 
-        return HistoryGuru.this.addRepositories(files, ignoredNames, true, depth);
+        return HistoryGuru.this.addRepositories(files, ignoredNames, true, null, depth);
     }
 
     /**
@@ -483,7 +482,7 @@ private Collection<RepositoryInfo> addRepositories(File[] files,
     public Collection<RepositoryInfo> addRepositories(File[] files,
             IgnoredNames ignoredNames) {
 
-        return HistoryGuru.this.addRepositories(files, ignoredNames, true, 0);
+        return HistoryGuru.this.addRepositories(files, ignoredNames, true, null,0);
     }
 
     /**

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

@@ -80,9 +80,14 @@ public static List<Class<? extends Repository>> getRepositoryClasses() {
         return list;
     }
 
+    public static Repository getRepository(File file, String type)
+            throws InstantiationException, IllegalAccessException, NoSuchMethodException, InvocationTargetException, IOException, ForbiddenSymlinkException {
+        return getRepository(file, false, type);
+    }
+
     public static Repository getRepository(File file)
             throws InstantiationException, IllegalAccessException, NoSuchMethodException, InvocationTargetException, IOException, ForbiddenSymlinkException {
-        return getRepository(file, false);
+        return getRepository(file, false, null);
     }
 
     /**
@@ -97,6 +102,7 @@ public static Repository getRepository(File file)
      *
      * @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}
      * @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
@@ -105,12 +111,16 @@ 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)
+    public static Repository getRepository(File file, boolean interactive, String type)
             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)) {
                 repo = rep.getClass().getDeclaredConstructor().newInstance();
 
@@ -197,7 +207,7 @@ public static Repository getRepository(File file, boolean interactive)
      */
     public static Repository getRepository(RepositoryInfo info, boolean interactive)
             throws InstantiationException, IllegalAccessException, NoSuchMethodException, InvocationTargetException, IOException, ForbiddenSymlinkException {
-        return getRepository(new File(info.getDirectoryName()), interactive);
+        return getRepository(new File(info.getDirectoryName()), interactive, null);
     }
 
     /**

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

@@ -60,7 +60,7 @@ public class RepositoryInfo implements Serializable {
 
     private String directoryNameRelative;
     protected Boolean working;
-    protected String type;
+    protected String type;  // type of the repository, should be unique
     protected boolean remote;
     protected String[] datePatterns = new String[0];
     protected String parent;

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

@@ -18,18 +18,17 @@
  */
 
 /*
- * Copyright (c) 2008, 2018, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2008, 2019, Oracle and/or its affiliates. All rights reserved.
  */
 package org.opengrok.indexer.history;
 
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertNotNull;
-
 import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
+import java.nio.file.Paths;
 import java.util.ArrayList;
 import java.util.Collection;
+import java.util.Collections;
 import java.util.List;
 
 import org.junit.AfterClass;
@@ -44,6 +43,8 @@
 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)
  *
@@ -171,4 +172,46 @@ public void testAddRemoveRepositories() {
         Assert.assertEquals(1, added.size());
         Assert.assertEquals(numReposOrig, instance.getRepositories().size());
     }
+
+    @Test
+    @ConditionalRun(RepositoryInstalled.GitInstalled.class)
+    @ConditionalRun(RepositoryInstalled.MercurialInstalled.class)
+    public void testAddSubRepositoryNoTypeMatch() {
+        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());
+        File gitRoot = new File(repository.getSourceRoot(), "git");
+        assertTrue(gitRoot.exists());
+        assertTrue(gitRoot.isDirectory());
+        MercurialRepositoryTest.runHgCommand(gitRoot,
+                "clone", hgRoot.getAbsolutePath(), "subrepo");
+
+        Collection<RepositoryInfo> addedRepos = instance.
+                addRepositories(Collections.singleton(Paths.get(repository.getSourceRoot(), "git").toString()),
+                        env.getIgnoredNames());
+        assertEquals(1, addedRepos.size());
+    }
+
+    @Test
+    @ConditionalRun(RepositoryInstalled.MercurialInstalled.class)
+    public void testAddSubRepository() {
+        HistoryGuru instance = HistoryGuru.getInstance();
+        RuntimeEnvironment env = RuntimeEnvironment.getInstance();
+
+        // Clone a Mercurial repository underneath a Mercurial repository.
+        File hgRoot = new File(repository.getSourceRoot(), "mercurial");
+        assertTrue(hgRoot.exists());
+        assertTrue(hgRoot.isDirectory());
+        MercurialRepositoryTest.runHgCommand(hgRoot,
+                "clone", hgRoot.getAbsolutePath(), "subrepo");
+
+        Collection<RepositoryInfo> addedRepos = instance.
+                addRepositories(Collections.singleton(Paths.get(repository.getSourceRoot(), "mercurial").toString()),
+                        env.getIgnoredNames());
+        assertEquals(2, addedRepos.size());
+    }
 }