Avoid repository invalidation with --checkIndex

fixes #3645

Author: ahornace

opengrok-indexer/src/main/java/org/opengrok/indexer/index/IndexCheck.java

@@ -34,7 +34,8 @@
 import org.apache.lucene.store.LockFactory;
 import org.apache.lucene.store.NativeFSLockFactory;
 import org.apache.lucene.util.Version;
-import org.opengrok.indexer.configuration.RuntimeEnvironment;
+import org.jetbrains.annotations.NotNull;
+import org.opengrok.indexer.configuration.Configuration;
 import org.opengrok.indexer.logger.LoggerFactory;
 
 /**
@@ -52,8 +53,8 @@ public static class IndexVersionException extends Exception {
 
         private static final long serialVersionUID = 5693446916108385595L;
 
-        private int luceneIndexVersion = -1;
-        private int indexVersion = -1;
+        private final int luceneIndexVersion;
+        private final int indexVersion;
 
         public IndexVersionException(String s, int luceneIndexVersion, int indexVersion) {
             super(s);
@@ -75,12 +76,12 @@ private IndexCheck() {
 
     /**
      * Check if version of index(es) matches major Lucene version.
+     * @param configuration configuration based on which to perform the check
      * @param subFilesList list of paths. If non-empty, only projects matching these paths will be checked.
      * @return true on success, false on failure
      */
-    public static boolean check(List<String> subFilesList) {
-        RuntimeEnvironment env = RuntimeEnvironment.getInstance();
-        File indexRoot = new File(env.getDataRootPath(), IndexDatabase.INDEX_DIR);
+    public static boolean check(@NotNull Configuration configuration, List<String> subFilesList) {
+        File indexRoot = new File(configuration.getDataRoot(), IndexDatabase.INDEX_DIR);
         LOGGER.log(Level.FINE, "Checking for Lucene index version mismatch in {0}",
                 indexRoot);
         int ret = 0;
@@ -94,8 +95,8 @@ public static boolean check(List<String> subFilesList) {
                 ret |= checkDirNoExceptions(new File(indexRoot, projectName));
             }
         } else {
-            if (env.isProjectsEnabled()) {
-                for (String projectName : env.getProjects().keySet()) {
+            if (configuration.isProjectsEnabled()) {
+                for (String projectName : configuration.getProjects().keySet()) {
                     LOGGER.log(Level.FINER,
                             "Checking Lucene index version in project {0}",
                             projectName);
@@ -115,7 +116,7 @@ private static int checkDirNoExceptions(File dir) {
         try {
             checkDir(dir);
         } catch (Exception e) {
-            LOGGER.log(Level.WARNING, "Index check for directory " + dir.toString() + " failed", e);
+            LOGGER.log(Level.WARNING, "Index check for directory " + dir + " failed", e);
             return 1;
         }
 
@@ -141,7 +142,7 @@ public static void checkDir(File dir) throws IndexVersionException, IOException
 
         if (segVersion != Version.LATEST.major) {
             throw new IndexVersionException(
-                String.format("Directory %s has index version discrepancy", dir.toString()),
+                String.format("Directory %s has index version discrepancy", dir),
                     Version.LATEST.major, segVersion);
         }
     }

opengrok-indexer/src/main/java/org/opengrok/indexer/index/Indexer.java

@@ -257,9 +257,6 @@ public static void main(String[] argv) {
                 }
             }
 
-            // Set updated configuration in RuntimeEnvironment.
-            env.setConfiguration(cfg, subFilesList, CommandTimeoutType.INDEXER);
-
             // Check version of index(es) versus current Lucene version and exit
             // with return code upon failure.
             if (checkIndex) {
@@ -268,7 +265,7 @@ public static void main(String[] argv) {
                     System.exit(1);
                 }
 
-                if (!IndexCheck.check(subFilesList)) {
+                if (!IndexCheck.check(cfg, subFilesList)) {
                     System.err.printf("Index check failed%n");
                     System.err.print("You might want to remove " +
                             (subFilesList.size() > 0 ?
@@ -280,6 +277,9 @@ public static void main(String[] argv) {
                 System.exit(0);
             }
 
+            // Set updated configuration in RuntimeEnvironment.
+            env.setConfiguration(cfg, subFilesList, CommandTimeoutType.INDEXER);
+
             // Let repository types to add items to ignoredNames.
             // This changes env so is called after the setConfiguration()
             // call above.

opengrok-indexer/src/test/java/org/opengrok/indexer/index/IndexCheckTest.java

@@ -41,6 +41,7 @@
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
+import org.opengrok.indexer.configuration.Configuration;
 import org.opengrok.indexer.configuration.RuntimeEnvironment;
 import org.opengrok.indexer.history.RepositoryFactory;
 import org.opengrok.indexer.util.FileUtilities;
@@ -51,11 +52,12 @@
  * Verify index check.
  * @author Vladimír Kotal
  */
-public class IndexCheckTest {
+class IndexCheckTest {
 
     private TestRepository repository;
     private final RuntimeEnvironment env = RuntimeEnvironment.getInstance();
     private Path oldIndexDataDir;
+    private Configuration configuration;
 
     @BeforeAll
     public static void setUpClass() {
@@ -68,6 +70,9 @@ public void setUp() throws IOException {
         repository = new TestRepository();
         repository.create(IndexerTest.class.getResourceAsStream("/org/opengrok/indexer/history/repositories.zip"));
         oldIndexDataDir = null;
+        configuration = new Configuration();
+        configuration.setDataRoot(env.getDataRootPath());
+        configuration.setSourceRoot(env.getSourceRootPath());
     }
 
     @AfterEach
@@ -84,36 +89,38 @@ public void tearDown() throws IOException {
      */
     private void testIndexVersion(boolean projectsEnabled, List<String> subFiles) throws Exception {
         env.setHistoryEnabled(false);
+        configuration.setHistoryEnabled(false);
         env.setProjectsEnabled(projectsEnabled);
+        configuration.setProjectsEnabled(projectsEnabled);
         Indexer.getInstance().prepareIndexer(env, true, true,
                 false, null, null);
         Indexer.getInstance().doIndexerExecution(true, null, null);
 
-        IndexCheck.check(subFiles);
+        IndexCheck.check(configuration, subFiles);
     }
 
     @Test
-    public void testIndexVersionNoIndex() throws Exception {
-        IndexCheck.check(new ArrayList<>());
+    void testIndexVersionNoIndex() {
+        IndexCheck.check(configuration, new ArrayList<>());
     }
 
     @Test
-    public void testIndexVersionProjects() throws Exception {
+    void testIndexVersionProjects() throws Exception {
         testIndexVersion(true, new ArrayList<>());
     }
 
     @Test
-    public void testIndexVersionSelectedProjects() throws Exception {
+    void testIndexVersionSelectedProjects() throws Exception {
         testIndexVersion(true, Arrays.asList("mercurial", "git"));
     }
 
     @Test
-    public void testIndexVersionNoProjects() throws Exception {
+    void testIndexVersionNoProjects() throws Exception {
         testIndexVersion(false, new ArrayList<>());
     }
 
     @Test
-    public void testIndexVersionOldIndex() throws Exception {
+    void testIndexVersionOldIndex() throws Exception {
         oldIndexDataDir = Files.createTempDirectory("data");
         Path indexPath = oldIndexDataDir.resolve("index");
         Files.createDirectory(indexPath);
@@ -125,8 +132,10 @@ public void testIndexVersionOldIndex() throws Exception {
         assertTrue(archive.isFile(), "archive exists");
         FileUtilities.extractArchive(archive, indexDir);
         env.setDataRoot(oldIndexDataDir.toString());
+        configuration.setDataRoot(oldIndexDataDir.toString());
         env.setProjectsEnabled(false);
-        assertFalse(IndexCheck.check(new ArrayList<>()));
+        configuration.setProjectsEnabled(false);
+        assertFalse(IndexCheck.check(configuration, new ArrayList<>()));
 
         assertThrows(IndexCheck.IndexVersionException.class, () -> IndexCheck.checkDir(indexDir));
     }