Resolve #2638 : Add -h,--help repos

Author: idodeclare

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

@@ -0,0 +1,71 @@
+/*
+ * CDDL HEADER START
+ *
+ * The contents of this file are subject to the terms of the
+ * Common Development and Distribution License (the "License").
+ * You may not use this file except in compliance with the License.
+ *
+ * See LICENSE.txt included in this distribution for the specific
+ * language governing permissions and limitations under the License.
+ *
+ * When distributing Covered Code, include this CDDL HEADER in each
+ * file and include the License file at LICENSE.txt.
+ * If applicable, add the following below this CDDL HEADER, with the
+ * fields enclosed by brackets "[]" replaced with your own identifying
+ * information: Portions Copyright [yyyy] [name of copyright owner]
+ *
+ * CDDL HEADER END
+ */
+
+/*
+ * Copyright (c) 2020, Chris Fraire <[email protected]>.
+ */
+
+package org.opengrok.indexer.history;
+
+import java.util.List;
+import java.util.Locale;
+
+/**
+ * Represents a utility to show the user details of supported {@link Repository}
+ * types for -h,--help.
+ */
+public class RepositoriesHelp {
+
+    public static String getText() {
+        StringBuilder builder = new StringBuilder();
+        builder.append("Enabled repositories:");
+        builder.append(System.lineSeparator());
+        builder.append(System.lineSeparator());
+
+        List<Class<? extends Repository>> clazzes = RepositoryFactory.getRepositoryClasses();
+        clazzes.sort((o1, o2) -> o1.getSimpleName().compareToIgnoreCase(o2.getSimpleName()));
+        for (Class<?> clazz : clazzes) {
+            String simpleName = clazz.getSimpleName();
+            if (toAka(builder, simpleName)) {
+                builder.append(" (");
+                builder.append(simpleName);
+                builder.append(")");
+            }
+            builder.append(System.lineSeparator());
+        }
+        return builder.toString();
+    }
+
+    private static boolean toAka(StringBuilder builder, String repoSimpleName) {
+        final String REPOSITORY = "Repository";
+        if (!repoSimpleName.endsWith(REPOSITORY)) {
+            builder.append(repoSimpleName);
+            return false;
+        } else {
+            String aka = repoSimpleName.substring(0,
+                    repoSimpleName.length() - REPOSITORY.length());
+            builder.append(aka.toLowerCase(Locale.ROOT));
+            return true;
+        }
+    }
+
+    /* private to enforce static */
+    private RepositoriesHelp() {
+    }
+}

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

@@ -61,6 +61,7 @@
 import org.opengrok.indexer.configuration.Project;
 import org.opengrok.indexer.configuration.RuntimeEnvironment;
 import org.opengrok.indexer.history.HistoryGuru;
+import org.opengrok.indexer.history.RepositoriesHelp;
 import org.opengrok.indexer.history.Repository;
 import org.opengrok.indexer.history.RepositoryFactory;
 import org.opengrok.indexer.history.RepositoryInfo;
@@ -168,6 +169,9 @@ public static void main(String[] argv) {
                     case GURU:
                         helpStream.println(AnalyzerGuruHelp.getUsage());
                         break;
+                    case REPOS:
+                        helpStream.println(RepositoriesHelp.getText());
+                        break;
                     default:
                         helpStream.println(helpUsage);
                         break;
@@ -448,7 +452,8 @@ public static String[] parseOptions(String[] argv) throws ParseException {
                     "With no mode specified, display this usage summary. Or specify a mode:",
                     "  config - display configuration.xml examples.",
                     "   ctags - display ctags command-line.",
-                    "    guru - display AnalyzerGuru details.").Do(v -> {
+                    "    guru - display AnalyzerGuru details.",
+                    "   repos - display enabled repositories.").Do(v -> {
                         help = true;
                         helpUsage = parser.getUsage();
                         String mode = (String) v;
@@ -1148,7 +1153,7 @@ private static String getCtagsCommand() {
     }
 
     private enum HelpMode {
-        CONFIG, CTAGS, DEFAULT, GURU
+        CONFIG, CTAGS, DEFAULT, GURU, REPOS
     }
 
     private Indexer() {

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

@@ -0,0 +1,42 @@
+/*
+ * CDDL HEADER START
+ *
+ * The contents of this file are subject to the terms of the
+ * Common Development and Distribution License (the "License").
+ * You may not use this file except in compliance with the License.
+ *
+ * See LICENSE.txt included in this distribution for the specific
+ * language governing permissions and limitations under the License.
+ *
+ * When distributing Covered Code, include this CDDL HEADER in each
+ * file and include the License file at LICENSE.txt.
+ * If applicable, add the following below this CDDL HEADER, with the
+ * fields enclosed by brackets "[]" replaced with your own identifying
+ * information: Portions Copyright [yyyy] [name of copyright owner]
+ *
+ * CDDL HEADER END
+ */
+
+/*
+ * Copyright (c) 2020, Chris Fraire <[email protected]>.
+ */
+
+package org.opengrok.indexer.history;
+
+import org.junit.Test;
+
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+
+/**
+ * Represents a container for tests of {@link RepositoriesHelp}.
+ */
+public class RepositoriesHelpTest {
+    @Test
+    public void shouldCreateReadableUsage() {
+        String helpText = RepositoriesHelp.getText();
+        assertFalse("help text should not be empty", helpText.isEmpty());
+        assertTrue("help text should contain 'git (GitRepository)'",
+                helpText.contains("git (GitRepository)"));
+    }
+}