treat IOException thrown during index check as success

Author: vladak

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

@@ -137,8 +137,8 @@ private IndexCheck() {
      *                     on whether projects are enabled in the configuration.
      * @return true on success, false on failure
      */
-    public static boolean check(@NotNull Configuration configuration, IndexCheckMode mode,
-                                Collection<String> projectNames) {
+    public static boolean isOkay(@NotNull Configuration configuration, IndexCheckMode mode,
+                                 Collection<String> projectNames) {
 
         if (mode.equals(IndexCheckMode.NO_CHECK)) {
             LOGGER.log(Level.WARNING, "no index check mode selected");
@@ -151,15 +151,15 @@ public static boolean check(@NotNull Configuration configuration, IndexCheckMode
         if (!projectNames.isEmpty()) {
             // Assumes projects are enabled.
             for (String projectName : projectNames) {
-                ret |= checkDirNoExceptions(Path.of(indexRoot.toString(), projectName), mode, projectName);
+                ret |= checkDirNoExceptions(Path.of(indexRoot.toString(), projectName), mode);
             }
         } else {
             if (configuration.isProjectsEnabled()) {
                 for (String projectName : configuration.getProjects().keySet()) {
-                    ret |= checkDirNoExceptions(Path.of(indexRoot.toString(), projectName), mode, projectName);
+                    ret |= checkDirNoExceptions(Path.of(indexRoot.toString(), projectName), mode);
                 }
             } else {
-                ret |= checkDirNoExceptions(indexRoot, mode, "");
+                ret |= checkDirNoExceptions(indexRoot, mode);
             }
         }
 
@@ -170,10 +170,13 @@ public static boolean check(@NotNull Configuration configuration, IndexCheckMode
      * @param indexPath directory with index
      * @return 0 on success, 1 on failure
      */
-    private static int checkDirNoExceptions(Path indexPath, IndexCheckMode mode, String projectName) {
+    private static int checkDirNoExceptions(Path indexPath, IndexCheckMode mode) {
         try {
             LOGGER.log(Level.INFO, "Checking index in ''{0}''", indexPath);
             checkDir(indexPath, mode);
+        } catch (IOException e) {
+            LOGGER.log(Level.WARNING, String.format("Could not perform index check for directory '%s'", indexPath), e);
+            return 0;
         } catch (Exception e) {
             LOGGER.log(Level.WARNING, String.format("Index check for directory '%s' failed", indexPath), e);
             return 1;
@@ -191,6 +194,7 @@ private static int checkDirNoExceptions(Path indexPath, IndexCheckMode mode, Str
      * @param mode      index check mode
      * @throws IOException           if the directory cannot be opened
      * @throws IndexVersionException if the version of the index does not match Lucene index version
+     * @throws IndexDocumentException if there are duplicate documents in the index
      */
     public static void checkDir(Path indexPath, IndexCheckMode mode)
             throws IndexVersionException, IndexDocumentException, IOException {

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

@@ -268,7 +268,7 @@ public static void main(String[] argv) {
                     System.exit(1);
                 }
 
-                if (!IndexCheck.check(cfg, indexCheckMode, subFileArgs)) {
+                if (!IndexCheck.isOkay(cfg, indexCheckMode, subFileArgs)) {
                     System.err.printf("Index check failed%n");
                     System.err.print("You might want to remove " +
                             (!subFilePaths.isEmpty() ? "data for projects " + String.join(",", subFilePaths) :

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

@@ -99,12 +99,12 @@ private void testIndexVersion(boolean projectsEnabled, List<String> subFiles) th
                 null, null);
         Indexer.getInstance().doIndexerExecution(null, null);
 
-        IndexCheck.check(configuration, IndexCheck.IndexCheckMode.VERSION, subFiles);
+        IndexCheck.isOkay(configuration, IndexCheck.IndexCheckMode.VERSION, subFiles);
     }
 
     @Test
     void testIndexVersionNoIndex() {
-        IndexCheck.check(configuration, IndexCheck.IndexCheckMode.VERSION, new ArrayList<>());
+        IndexCheck.isOkay(configuration, IndexCheck.IndexCheckMode.VERSION, new ArrayList<>());
     }
 
     @Test
@@ -138,7 +138,7 @@ void testIndexVersionOldIndex() throws Exception {
         configuration.setDataRoot(oldIndexDataDir.toString());
         env.setProjectsEnabled(false);
         configuration.setProjectsEnabled(false);
-        assertFalse(IndexCheck.check(configuration, IndexCheck.IndexCheckMode.VERSION, new ArrayList<>()));
+        assertFalse(IndexCheck.isOkay(configuration, IndexCheck.IndexCheckMode.VERSION, new ArrayList<>()));
 
         assertThrows(IndexCheck.IndexVersionException.class, () ->
                 IndexCheck.checkDir(indexPath, IndexCheck.IndexCheckMode.VERSION));
@@ -149,4 +149,19 @@ void testEmptyDir(@TempDir Path tempDir) throws Exception {
         assertEquals(0, tempDir.toFile().list().length);
         IndexCheck.checkDir(tempDir, IndexCheck.IndexCheckMode.VERSION);
     }
+
+    /**
+     * Check that {@link IOException} thrown during index check is treated as success.
+     */
+    @Test
+    void testIndexCheckIOException() {
+        configuration.setDataRoot("/nonexistent");
+        configuration.setProjectsEnabled(false);
+
+        IndexCheck.IndexCheckMode mode = IndexCheck.IndexCheckMode.VERSION;
+        assertThrows(IOException.class, () -> IndexCheck.checkDir(Path.of(configuration.getDataRoot()), mode));
+        // Assumes that IndexCheck.checkDir() is called via IndexCheck.isOkay() and the latter method
+        // infers the result from the call.
+        assertTrue(IndexCheck.isOkay(configuration, mode, new ArrayList<>()));
+    }
 }