Fix Configuration javadoc. Rem superfluous ctags overrides.

idodeclare · idodeclare · commit 032910f54dad · 2018-01-26T09:59:36.000-06:00
diff --git a/src/org/opensolaris/opengrok/configuration/Configuration.java b/src/org/opensolaris/opengrok/configuration/Configuration.java
@@ -513,9 +513,7 @@ public void setCmds(Map<String, String> cmds) {
     }
 
     /**
-     * Gets the configuration's ctags command. Default is the system property
-     * for {@code "org.opensolaris.opengrok.analysis.Ctags"} or else the value
-     * {@code "ctags"}.
+     * Gets the configuration's ctags command. Default is null.
      * @return the configured value
      */
     public String getCtags() {
@@ -524,16 +522,14 @@ public String getCtags() {
 
     /**
      * Sets the configuration's ctags command.
-     * @param ctags A program name (full-path if necessary)
+     * @param ctags A program name (full-path if necessary) or {@code null}
      */
     public void setCtags(String ctags) {
         this.ctags = ctags;
     }
 
     /**
-     * Gets the configuration's mandoc command. Default is the system property
-     * for {@code "org.opensolaris.opengrok.analysis.Mandoc"} or else
-     * {@code null}.
+     * Gets the configuration's mandoc command. Default is {@code null}.
      * @return the configured value
      */
     public String getMandoc() {
@@ -542,8 +538,7 @@ public String getMandoc() {
 
     /**
      * Sets the configuration's mandoc command.
-     * @param value A program name (full-path if necessary) or {@code null} to
-     * disable mandoc rendering.
+     * @param value A program name (full-path if necessary) or {@code null}
      */
     public void setMandoc(String value) {
         this.mandoc = value;
diff --git a/test/org/opensolaris/opengrok/analysis/c/CAnalyzerFactoryTest.java b/test/org/opensolaris/opengrok/analysis/c/CAnalyzerFactoryTest.java
@@ -19,7 +19,7 @@
 
 /*
  * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
- * Portions Copyright (c) 2017, Chris Fraire <cfraire@me.com>.
+ * Portions Copyright (c) 2017-2018, Chris Fraire <cfraire@me.com>.
  */
 package org.opensolaris.opengrok.analysis.c;
 
@@ -56,8 +56,6 @@
  */
 public class CAnalyzerFactoryTest {
 
-    private static final String CTAGS_PROP =
-        "org.opensolaris.opengrok.analysis.Ctags";
     private static Ctags ctags;
     private static TestRepository repository;
     private static FileAnalyzer analyzer;
@@ -83,7 +81,6 @@ public static void setUpClass() throws Exception {
         CAnalyzerFactory analFact = new CAnalyzerFactory();
         analyzer = analFact.getAnalyzer();
         RuntimeEnvironment env = RuntimeEnvironment.getInstance();
-        env.setCtags(System.getProperty(CTAGS_PROP, "ctags"));
         if (env.validateExuberantCtags()) {
             analyzer.setCtags(new Ctags());
         }
diff --git a/test/org/opensolaris/opengrok/analysis/c/CxxAnalyzerFactoryTest.java b/test/org/opensolaris/opengrok/analysis/c/CxxAnalyzerFactoryTest.java
@@ -19,7 +19,7 @@
 
 /*
  * Copyright (c) 2015, 2016 Oracle and/or its affiliates. All rights reserved.
- * Portions Copyright (c) 2017, Chris Fraire <cfraire@me.com>.
+ * Portions Copyright (c) 2017-2018, Chris Fraire <cfraire@me.com>.
  */
 package org.opensolaris.opengrok.analysis.c;
 
@@ -56,8 +56,6 @@
  */
 public class CxxAnalyzerFactoryTest {
 
-    private static final String CTAGS_PROP =
-        "org.opensolaris.opengrok.analysis.Ctags";
     private static Ctags ctags;
     private static TestRepository repository;
     private static FileAnalyzer analyzer;
@@ -83,7 +81,6 @@ public static void setUpClass() throws Exception {
         CxxAnalyzerFactory analFact = new CxxAnalyzerFactory();
         analyzer = analFact.getAnalyzer();
         RuntimeEnvironment env = RuntimeEnvironment.getInstance();
-        env.setCtags(System.getProperty(CTAGS_PROP, "ctags"));
         if (env.validateExuberantCtags()) {
             analyzer.setCtags(new Ctags());
         }
diff --git a/test/org/opensolaris/opengrok/analysis/clojure/ClojureAnalyzerFactoryTest.java b/test/org/opensolaris/opengrok/analysis/clojure/ClojureAnalyzerFactoryTest.java
@@ -19,7 +19,7 @@
 
 /*
  * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
- * Portions Copyright (c) 2017, Chris Fraire <cfraire@me.com>.
+ * Portions Copyright (c) 2017-2018, Chris Fraire <cfraire@me.com>.
  */
 package org.opensolaris.opengrok.analysis.clojure;
 
@@ -54,8 +54,6 @@
  */
 public class ClojureAnalyzerFactoryTest {
 
-    private static final String CTAGS_PROP =
-        "org.opensolaris.opengrok.analysis.Ctags";
     private static Ctags ctags;
     private static TestRepository repository;
     private static FileAnalyzer analyzer;
@@ -81,7 +79,6 @@ public static void setUpClass() throws Exception {
         ClojureAnalyzerFactory analFact = new ClojureAnalyzerFactory();
         analyzer = analFact.getAnalyzer();
         RuntimeEnvironment env = RuntimeEnvironment.getInstance();
-        env.setCtags(System.getProperty(CTAGS_PROP, "ctags"));
         if (env.validateExuberantCtags()) {
             analyzer.setCtags(new Ctags());
         }
diff --git a/test/org/opensolaris/opengrok/analysis/csharp/CSharpAnalyzerFactoryTest.java b/test/org/opensolaris/opengrok/analysis/csharp/CSharpAnalyzerFactoryTest.java
@@ -19,7 +19,7 @@
 
 /*
  * Copyright (c) 2015, 2016 Oracle and/or its affiliates. All rights reserved.
- * Portions Copyright (c) 2017, Chris Fraire <cfraire@me.com>.
+ * Portions Copyright (c) 2017-2018, Chris Fraire <cfraire@me.com>.
  */
 package org.opensolaris.opengrok.analysis.csharp;
 
@@ -51,8 +51,6 @@
  */
 public class CSharpAnalyzerFactoryTest {
 
-    private static final String CTAGS_PROP =
-        "org.opensolaris.opengrok.analysis.Ctags";
     private static Ctags ctags;
     private static TestRepository repository;
     private static FileAnalyzer analyzer;
@@ -78,7 +76,6 @@ public static void setUpClass() throws Exception {
         CSharpAnalyzerFactory analFact = new CSharpAnalyzerFactory();
         analyzer = analFact.getAnalyzer();
         RuntimeEnvironment env = RuntimeEnvironment.getInstance();
-        env.setCtags(System.getProperty(CTAGS_PROP, "ctags"));
         if (env.validateExuberantCtags()) {
             analyzer.setCtags(new Ctags());
         }
diff --git a/test/org/opensolaris/opengrok/analysis/java/JavaAnalyzerFactoryTest.java b/test/org/opensolaris/opengrok/analysis/java/JavaAnalyzerFactoryTest.java
@@ -19,7 +19,7 @@
 
 /*
  * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
- * Portions Copyright (c) 2017, Chris Fraire <cfraire@me.com>.
+ * Portions Copyright (c) 2017-2018, Chris Fraire <cfraire@me.com>.
  */
 package org.opensolaris.opengrok.analysis.java;
 
@@ -56,8 +56,6 @@
  */
 public class JavaAnalyzerFactoryTest {
 
-    private static final String CTAGS_PROP =
-        "org.opensolaris.opengrok.analysis.Ctags";
     private static Ctags ctags;
     private static TestRepository repository;
     private static FileAnalyzer analyzer;
@@ -83,7 +81,6 @@ public static void setUpClass() throws Exception {
         JavaAnalyzerFactory analFact = new JavaAnalyzerFactory();
         analyzer = analFact.getAnalyzer();
         RuntimeEnvironment env = RuntimeEnvironment.getInstance();
-        env.setCtags(System.getProperty(CTAGS_PROP, "ctags"));
         if (env.validateExuberantCtags()) {
             analyzer.setCtags(new Ctags());
         }
diff --git a/test/org/opensolaris/opengrok/analysis/pascal/PascalAnalyzerFactoryTest.java b/test/org/opensolaris/opengrok/analysis/pascal/PascalAnalyzerFactoryTest.java
@@ -19,7 +19,7 @@
 
 /*
  * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
- * Portions Copyright (c) 2017, Chris Fraire <cfraire@me.com>.
+ * Portions Copyright (c) 2017-2018, Chris Fraire <cfraire@me.com>.
  */
 package org.opensolaris.opengrok.analysis.pascal;
 
@@ -53,8 +53,6 @@
  */
 public class PascalAnalyzerFactoryTest {
     
-    private static final String CTAGS_PROP =
-        "org.opensolaris.opengrok.analysis.Ctags";
     private static Ctags ctags;
     private static TestRepository repository;
     private static FileAnalyzer analyzer;
@@ -80,7 +78,6 @@ public static void setUpClass() throws Exception {
         PascalAnalyzerFactory analyzerFactory = new PascalAnalyzerFactory();
         analyzer = analyzerFactory.getAnalyzer();
         RuntimeEnvironment env = RuntimeEnvironment.getInstance();
-        env.setCtags(System.getProperty(CTAGS_PROP, "ctags"));
         if (env.validateExuberantCtags()) {
             analyzer.setCtags(new Ctags());
         }
diff --git a/test/org/opensolaris/opengrok/configuration/RuntimeEnvironmentTest.java b/test/org/opensolaris/opengrok/configuration/RuntimeEnvironmentTest.java
@@ -209,6 +209,12 @@ public void testCtags() {
         String path = "/usr/bin/ctags";
         instance.setCtags(path);
         assertEquals(path, instance.getCtags());
+
+        instance.setCtags(null);
+        instanceCtags = instance.getCtags();
+        assertTrue("instance ctags should equals 'ctags' or the sys property",
+            instanceCtags.equals("ctags") || instanceCtags.equals(
+            System.getProperty("org.opensolaris.opengrok.analysis.Ctags")));
     }
 
     @Test
diff --git a/test/org/opensolaris/opengrok/configuration/messages/ProjectMessageTest.java b/test/org/opensolaris/opengrok/configuration/messages/ProjectMessageTest.java
@@ -19,7 +19,7 @@
 
 /*
  * Copyright (c) 2017, 2018, Oracle and/or its affiliates. All rights reserved.
- * Portions Copyright (c) 2017, Chris Fraire <cfraire@me.com>.
+ * Portions Copyright (c) 2017-2018, Chris Fraire <cfraire@me.com>.
  */
 package org.opensolaris.opengrok.configuration.messages;
 
@@ -65,7 +65,6 @@ public class ProjectMessageTest {
     RuntimeEnvironment env;
 
     private static TestRepository repository = new TestRepository();
-    private final String ctagsProperty = "org.opensolaris.opengrok.analysis.Ctags";
 
     @Before
     public void setUp() throws IOException {
@@ -253,8 +252,6 @@ public void testRepositoryRefresh() throws Exception {
     public void testDelete() throws Exception {
         String projectsToDelete[] = { "git", "svn" };
 
-        env.setCtags(System.getProperty(ctagsProperty, "ctags"));
-
         assertTrue("No point in running indexer tests without valid ctags",
                 RuntimeEnvironment.getInstance().validateExuberantCtags());
 
diff --git a/test/org/opensolaris/opengrok/index/IndexDatabaseTest.java b/test/org/opensolaris/opengrok/index/IndexDatabaseTest.java
@@ -19,6 +19,7 @@
 
 /*
  * Copyright (c) 2010, 2017, Oracle and/or its affiliates. All rights reserved.
+ * Portions Copyright (c) 2018, Chris Fraire <cfraire@me.com>.
  */
 package org.opensolaris.opengrok.index;
 
@@ -48,15 +49,13 @@ public class IndexDatabaseTest {
 
     private static TestRepository repository;
     private static IndexerParallelizer parallelizer;
-    private final static String ctagsProperty = "org.opensolaris.opengrok.analysis.Ctags";
 
     public IndexDatabaseTest() {
     }
 
     @BeforeClass
     public static void setUpClass() throws Exception {
         RuntimeEnvironment env = RuntimeEnvironment.getInstance();
-        env.setCtags(System.getProperty(ctagsProperty, "ctags"));
         assertTrue("No ctags available", env.validateExuberantCtags());
 
         repository = new TestRepository();
diff --git a/test/org/opensolaris/opengrok/index/IndexerRepoTest.java b/test/org/opensolaris/opengrok/index/IndexerRepoTest.java
@@ -19,6 +19,7 @@
 
 /*
  * Copyright (c) 2014, 2017, Oracle and/or its affiliates. All rights reserved.
+ * Portions Copyright (c) 2018, Chris Fraire <cfraire@me.com>.
  */
 package org.opensolaris.opengrok.index;
 
@@ -41,7 +42,6 @@
 public class IndexerRepoTest {
 
     TestRepository repository;
-    private final String ctagsProperty = "org.opensolaris.opengrok.analysis.Ctags";
 
     @Before
     public void setUp() throws IOException {
@@ -77,7 +77,6 @@ private void checkNumberOfThreads() {
     public void testMainWithH() throws IOException {
         System.out.println("Generate index by using command line options with -H");
         RuntimeEnvironment env = RuntimeEnvironment.getInstance();
-        env.setCtags(System.getProperty(ctagsProperty, "ctags"));
         if (env.validateExuberantCtags()) {
             String[] argv = {"-S", "-H", "-s", repository.getSourceRoot(),
                 "-d", repository.getDataRoot(), "-v", "-c", env.getCtags()};
@@ -92,7 +91,6 @@ public void testMainWithH() throws IOException {
     public void testMainWithoutH() throws IOException {
         System.out.println("Generate index by using command line options without -H");
         RuntimeEnvironment env = RuntimeEnvironment.getInstance();
-        env.setCtags(System.getProperty(ctagsProperty, "ctags"));
         if (env.validateExuberantCtags()) {
             String[] argv = {"-S", "-P", "-s", repository.getSourceRoot(),
                 "-d", repository.getDataRoot(), "-v", "-c", env.getCtags()};
diff --git a/test/org/opensolaris/opengrok/index/IndexerTest.java b/test/org/opensolaris/opengrok/index/IndexerTest.java
@@ -19,7 +19,7 @@
 
 /*
  * Copyright (c) 2008, 2017, Oracle and/or its affiliates. All rights reserved.
- * Portions Copyright (c) 2017, Chris Fraire <cfraire@me.com>.
+ * Portions Copyright (c) 2017-2018, Chris Fraire <cfraire@me.com>.
  */
 package org.opensolaris.opengrok.index;
 
@@ -73,7 +73,6 @@
 public class IndexerTest {
 
     TestRepository repository;
-    private final String ctagsProperty = "org.opensolaris.opengrok.analysis.Ctags";
     private static IndexerParallelizer parallelizer;
 
     @Rule
@@ -116,7 +115,6 @@ public void tearDown() {
     public void testIndexGeneration() throws Exception {
         System.out.println("Generating index by using the class methods");
         RuntimeEnvironment env = RuntimeEnvironment.getInstance();
-        env.setCtags(System.getProperty(ctagsProperty, "ctags"));
         if (env.validateExuberantCtags()) {
             env.setSourceRoot(repository.getSourceRoot());
             env.setDataRoot(repository.getDataRoot());
@@ -199,7 +197,6 @@ public void testRescanProjects() throws Exception {
     public void testMain() throws IOException {
         System.out.println("Generate index by using command line options");
         RuntimeEnvironment env = RuntimeEnvironment.getInstance();
-        env.setCtags(System.getProperty(ctagsProperty, "ctags"));
         if (env.validateExuberantCtags()) {
             String[] argv = {"-S", "-P", "-H", "-Q", "off", "-s",
                 repository.getSourceRoot(), "-d", repository.getDataRoot(),
@@ -251,7 +248,6 @@ public void reset() {
     @Test
     public void testIndexWithSetIndexVersionedFilesOnly() throws Exception {
         RuntimeEnvironment env = RuntimeEnvironment.getInstance();
-        env.setCtags(System.getProperty(ctagsProperty, "ctags"));
         env.setSourceRoot(repository.getSourceRoot());
         env.setDataRoot(repository.getDataRoot());
         env.setRepositories(repository.getSourceRoot());
@@ -342,7 +338,6 @@ public void reset() {
     public void testRemoveFileOnFileChange() throws Exception {
         RuntimeEnvironment env = RuntimeEnvironment.getInstance();
 
-        env.setCtags(System.getProperty(ctagsProperty, "ctags"));
         if (!env.validateExuberantCtags()) {
             System.out.println("Skipping test due to no ctags");
         }
@@ -407,7 +402,6 @@ public void testXref() throws IOException {
     @Test
     public void testBug3430() throws Exception {
         RuntimeEnvironment env = RuntimeEnvironment.getInstance();
-        env.setCtags(System.getProperty(ctagsProperty, "ctags"));
         env.setSourceRoot(repository.getSourceRoot());
         env.setDataRoot(repository.getDataRoot());
 
@@ -432,7 +426,6 @@ public void testBug3430() throws Exception {
     @Test
     public void testIncrementalIndexAddRemoveFile() throws Exception {
         RuntimeEnvironment env = RuntimeEnvironment.getInstance();
-        env.setCtags(System.getProperty(ctagsProperty, "ctags"));
         env.setSourceRoot(repository.getSourceRoot());
         env.setDataRoot(repository.getDataRoot());
 
diff --git a/test/org/opensolaris/opengrok/search/SearchEngineTest.java b/test/org/opensolaris/opengrok/search/SearchEngineTest.java
@@ -19,6 +19,7 @@
 
 /*
  * Copyright (c) 2008, 2017, Oracle and/or its affiliates. All rights reserved.
+ * Portions Copyright (c) 2018, Chris Fraire <cfraire@me.com>.
  */
 
 package org.opensolaris.opengrok.search;
@@ -58,7 +59,6 @@ public static void setUpClass() throws Exception {
         repository.create(HistoryGuru.class.getResourceAsStream("repositories.zip"));
 
         RuntimeEnvironment env = RuntimeEnvironment.getInstance();
-        env.setCtags(System.getProperty("org.opensolaris.opengrok.analysis.Ctags", "ctags"));
         env.setSourceRoot(repository.getSourceRoot());
         env.setDataRoot(repository.getDataRoot());
         RepositoryFactory.initializeIgnoredNames(env);
diff --git a/test/org/opensolaris/opengrok/search/SearchTest.java b/test/org/opensolaris/opengrok/search/SearchTest.java
@@ -19,6 +19,7 @@
 
 /*
  * Copyright (c) 2008, 2017, Oracle and/or its affiliates. All rights reserved.
+ * Portions Copyright (c) 2018, Chris Fraire <cfraire@me.com>.
  */
 package org.opensolaris.opengrok.search;
 
@@ -60,7 +61,6 @@ public static void setUpClass() throws Exception {
         repository.create(IndexerTest.class.getResourceAsStream("source.zip"));
 
         RuntimeEnvironment env = RuntimeEnvironment.getInstance();
-        env.setCtags(System.getProperty("org.opensolaris.opengrok.analysis.Ctags", "ctags"));
         env.setSourceRoot(repository.getSourceRoot());
         env.setDataRoot(repository.getDataRoot());
 
diff --git a/test/org/opensolaris/opengrok/web/SearchHelperTest.java b/test/org/opensolaris/opengrok/web/SearchHelperTest.java
