Fix Sonar codesmell issues (#4460)

Signed-off-by: Gino Augustine <[email protected]>

Author: ginoaugustine

opengrok-indexer/src/main/java/org/opengrok/indexer/analysis/AnalyzerGuru.java

@@ -703,6 +703,7 @@ public static void writeXref(AnalyzerFactory factory, Reader in,
      * @param file file object, used for logging only
      * @throws java.io.IOException if an error occurs while creating the output
      */
+    @SuppressWarnings("java:S5443")
     public static void writeDumpedXref(String contextPath,
             AnalyzerFactory factory, Reader in, Writer out,
             @Nullable Definitions defs, Annotation annotation, Project project, File file) throws IOException {

opengrok-indexer/src/main/java/org/opengrok/indexer/analysis/Ctags.java

@@ -591,7 +591,6 @@ private void readTags(CtagsReader reader) throws InterruptedException {
                     throw new InterruptedException("readLine()");
                 }
 
-                //log.fine("Tagline:-->" + tagLine+"<----ONELINE");
                 if (tagLine == null) {
                     if (!junitTesting) {
                         LOGGER.warning("ctags: Unexpected end of file!");

opengrok-indexer/src/main/java/org/opengrok/indexer/analysis/CtagsReader.java

@@ -102,9 +102,6 @@ public enum tagFields {
         //        NAMESPACE("namespace"), //this is not defined in above format docs, but both universal and exuberant ctags use it
         //        PROGRAM("program"), //this is not defined in above format docs, but both universal and exuberant ctags use it
         SIGNATURE("signature");
-//        STRUCT("struct"),
-//        TYPEREF("typeref"),
-//        UNION("union");
 
         //NOTE: if you edit above, always consult below charCmpEndOffset
         private final String name;
@@ -381,7 +378,8 @@ private CpatIndex bestIndexOfTag(int lineno, String whole, String str) {
         String origWhole = whole;
 
         int t = tabSize;
-        int s, e;
+        int s;
+        int e;
 
         int woff = strictIndexOf(whole, str);
         if (woff < 0) {
@@ -440,7 +438,8 @@ private CpatIndex bestIndexOfArg(int lineno, String whole, String arg) {
         }
 
         int t = tabSize;
-        int s, e;
+        int s;
+        int e;
 
         // First search arg as-is in the current `whole' -- strict then lax.
         int woff = strictIndexOf(whole, arg);

opengrok-indexer/src/main/java/org/opengrok/indexer/analysis/archive/GZIPAnalyzer.java

@@ -93,7 +93,6 @@ public void analyze(Document doc, StreamSource src, Writer xrefOut)
         String path = doc.get(QueryBuilder.PATH);
         if (path != null && path.toLowerCase(Locale.ROOT).endsWith(".gz")) {
             String newname = path.substring(0, path.length() - 3);
-            //System.err.println("GZIPPED OF = " + newname);
             try (InputStream gzis = gzSrc.getStream()) {
                 fa = AnalyzerGuru.getAnalyzer(gzis, newname);
             }

opengrok-indexer/src/main/java/org/opengrok/indexer/analysis/document/DocumentMatcher.java

@@ -124,11 +124,9 @@ public AnalyzerFactory isMagic(byte[] contents, InputStream in)
         if (!foundLF) {
             return null;
         }
-        if (bomLength > 0) {
-            if (in.skip(bomLength) != bomLength) {
-                in.reset();
-                return null;
-            }
+        if (bomLength > 0 && in.skip(bomLength) != bomLength) {
+            in.reset();
+            return null;
         }
 
         // read line-by-line for a first few lines

opengrok-indexer/src/main/java/org/opengrok/indexer/authorization/AuthorizationStack.java

@@ -260,7 +260,7 @@ protected boolean processStack(Nameable entity,
                 }
             } catch (AuthorizationException ex) {
                 // Propagate up so that proper HTTP error can be given.
-                LOGGER.log(Level.FINEST, "got authorization exception: " + ex.getMessage());
+                LOGGER.log(Level.FINEST, () -> "got authorization exception: " + ex.getMessage());
                 throw ex;
             } catch (Throwable ex) {
                 LOGGER.log(Level.WARNING,

opengrok-indexer/src/main/java/org/opengrok/indexer/configuration/Configuration.java

@@ -187,7 +187,7 @@ public final class Configuration {
     private short contextLimit; // initialized non-zero in ctor
     private short contextSurround;
     private boolean lastEditedDisplayMode;
-    private String CTagsExtraOptionsFile;
+    private String cTagsExtraOptionsFile;
     private int scanningDepth;
     private int nestingMaximum;
     private Set<String> allowedSymlinks;
@@ -220,7 +220,7 @@ public final class Configuration {
 
     private boolean mergeCommitsEnabled;
 
-    public static final double defaultRamBufferSize = 16;
+    public static final double DEFAULT_RAM_BUFFER_SIZE = 16;
 
     /**
      * The directory hierarchy depth to limit the scanning for repositories.
@@ -261,19 +261,19 @@ public final class Configuration {
      * Upper bound for number of threads used for performing multi-project
      * searches. This is total for the whole webapp.
      */
-    private int MaxSearchThreadCount;
+    private int maxSearchThreadCount;
 
     /**
      * Upper bound for number of threads used for getting revision contents.
      * This is total for the whole webapp.
      */
-    private int MaxRevisionThreadCount;
+    private int maxRevisionThreadCount;
 
     /**
      * Upper bound for number of threads used for getting directory entries.
      * This is total for the whole webapp.
      */
-    private int MaxDirectoryListingThreadCount;
+    private int maxDirectoryListingThreadCount;
 
     /**
      * If false, do not display listing or projects/repositories on the index page.
@@ -556,7 +556,6 @@ public Configuration() {
         setApiTimeout(300); // 5 minutes
         setAuthenticationTokens(new HashSet<>());
         setAuthorizationWatchdogEnabled(false);
-        //setBugPage("http://bugs.myserver.org/bugdatabase/view_bug.do?bug_id=");
         setBugPattern("\\b([12456789][0-9]{6})\\b");
         setCachePages(5);
         setCanonicalRoots(new HashSet<>());
@@ -604,19 +603,16 @@ public Configuration() {
         setProjects(new ConcurrentHashMap<>());
         setQuickContextScan(true);
         //below can cause an outofmemory error, since it is defaulting to NO LIMIT
-        setRamBufferSize(defaultRamBufferSize); //MB
+        setRamBufferSize(DEFAULT_RAM_BUFFER_SIZE); //MB
         setRemoteScmSupported(RemoteSCM.OFF);
         setRepositories(new ArrayList<>());
-        //setReviewPage("http://arc.myserver.org/caselog/PSARC/");
         setReviewPattern("\\b(\\d{4}/\\d{3})\\b"); // in form e.g. PSARC 2008/305
         setRevisionMessageCollapseThreshold(200);
         setScanningDepth(DEFAULT_SCANNING_DEPTH); // default depth of scanning for repositories
         setScopesEnabled(true);
         setSourceRoot(null);
-        //setTabSize(4);
         setTagsEnabled(false);
         setUseHistoryCacheForDirectoryListing(true);
-        //setUserPage("http://www.myserver.org/viewProfile.jspa?username=");
         // Set to empty string, so we can append it to the URL unconditionally later.
         setUserPageSuffix("");
         setWebappLAF("default");
@@ -1289,11 +1285,11 @@ public Path getDtagsEftarPath() {
     }
 
     public String getCTagsExtraOptionsFile() {
-        return CTagsExtraOptionsFile;
+        return cTagsExtraOptionsFile;
     }
 
     public void setCTagsExtraOptionsFile(String filename) {
-        this.CTagsExtraOptionsFile = filename;
+        this.cTagsExtraOptionsFile = filename;
     }
 
     public Set<String> getAllowedSymlinks() {
@@ -1345,27 +1341,27 @@ public void setFoldingEnabled(boolean foldingEnabled) {
     }
 
     public int getMaxSearchThreadCount() {
-        return MaxSearchThreadCount;
+        return maxSearchThreadCount;
     }
 
     public void setMaxSearchThreadCount(int count) {
-        this.MaxSearchThreadCount = count;
+        this.maxSearchThreadCount = count;
     }
 
     public int getMaxRevisionThreadCount() {
-        return MaxRevisionThreadCount;
+        return maxRevisionThreadCount;
     }
 
     public void setMaxRevisionThreadCount(int count) {
-        this.MaxRevisionThreadCount = count;
+        this.maxRevisionThreadCount = count;
     }
 
     public int getMaxDirectoryListingThreadCount() {
-        return MaxDirectoryListingThreadCount;
+        return maxDirectoryListingThreadCount;
     }
 
     public void setMaxDirectoryListingThreadCount(int count) {
-        this.MaxDirectoryListingThreadCount = count;
+        this.maxDirectoryListingThreadCount = count;
     }
 
     public boolean isProjectsEnabled() {

opengrok-indexer/src/main/java/org/opengrok/indexer/configuration/ConfigurationHelp.java

@@ -47,6 +47,10 @@
 public class ConfigurationHelp {
 
     private static final String XML_COMMENT_START = "  <!-- ";
+    private static final String USER_DEFINED_KEY = "user-defined-key";
+    private static final String USER_DEFINED_VALUE = "user-specified-value";
+    private static final String NOT_SUPPORTED_MSG = "Not supported yet for ";
+
 
     private ConfigurationHelp() {
     }
@@ -136,7 +140,7 @@ private static Object getSampleValue(Method setter, Object defaultValue) {
         } else if (setter.getName().equals("setReviewPattern")) {
             return "Sample Issue \\#(\\d+)";
         } else if (paramType == String.class) {
-            return "user-specified-value";
+            return USER_DEFINED_VALUE;
         } else if (paramType == int.class) {
             return 1 + (int) defaultValue;
         } else if (paramType == long.class) {
@@ -158,9 +162,9 @@ private static Object getSampleValue(Method setter, Object defaultValue) {
             return getSampleSetValue(genType);
         } else if (paramType == AuthorizationStack.class) {
             AuthorizationStack astck = new AuthorizationStack(
-                AuthControlFlag.REQUIRED, "user-specified-value");
+                AuthControlFlag.REQUIRED, USER_DEFINED_VALUE);
             astck.add(new AuthorizationPlugin(AuthControlFlag.REQUISITE,
-                "user-specified-value"));
+                USER_DEFINED_VALUE));
             return astck;
         } else if (paramType == Filter.class) {
             Filter flt = new Filter();
@@ -198,7 +202,7 @@ private static Object getSampleListValue(Type genType) {
         Type actType = genParamType.getActualTypeArguments()[0];
 
         if (actType != RepositoryInfo.class) {
-            throw new UnsupportedOperationException("Not supported yet for " + actType);
+            throw new UnsupportedOperationException(NOT_SUPPORTED_MSG + actType);
         }
         return null;
     }
@@ -216,24 +220,24 @@ private static Object getSampleMapValue(Type genType) {
         if (actType0 == String.class) {
             if (actType1 == String.class) {
                 Map<String, String> strmap = new TreeMap<>();
-                strmap.put("user-defined-key", "user-defined-value");
+                strmap.put(USER_DEFINED_KEY, "user-defined-value");
                 res = strmap;
             } else if (actType1 == Project.class) {
                 Map<String, Project> strmap = new TreeMap<>();
-                String nm = "user-defined-key";
+                String nm = USER_DEFINED_KEY;
                 strmap.put(nm, getSampleProject(nm));
                 res = strmap;
             } else if (actType1 == Group.class) {
                 Map<String, Group> strmap = new TreeMap<>();
-                String nm = "user-defined-key";
+                String nm = USER_DEFINED_KEY;
                 strmap.put(nm, getSampleGroup(nm));
                 res = strmap;
             } else {
                 throw new UnsupportedOperationException(
-                    "Not supported yet for " + actType0 + " " + actType1);
+                    NOT_SUPPORTED_MSG + actType0 + " " + actType1);
             }
         } else {
-            throw new UnsupportedOperationException("Not supported yet for " +
+            throw new UnsupportedOperationException(NOT_SUPPORTED_MSG +
                 actType0 + " " + actType1);
         }
         return res;
@@ -262,7 +266,7 @@ private static Object getSampleSetValue(Type genType) {
             prjset.add(p);
             res = prjset;
         } else {
-            throw new UnsupportedOperationException("Not supported yet for " +
+            throw new UnsupportedOperationException(NOT_SUPPORTED_MSG +
                 actType);
         }
         return res;

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

@@ -228,6 +228,30 @@ String determineCurrentVersion(CommandTimeoutType cmdType) throws IOException {
 
     private static class VobsHolder {
         static String[] vobs = runLsvob();
+        private static String[] runLsvob() {
+            if (testRepo.isWorking()) {
+                Executor exec = new Executor(
+                        new String[]{testRepo.RepoCommand, "lsvob", "-s"});
+                int rc;
+                if ((rc = exec.exec(true)) == 0) {
+                    String output = exec.getOutputString();
+
+                    if (output == null) {
+                        LOGGER.log(Level.SEVERE,
+                                "\"cleartool lsvob -s\" output was null");
+                        return new String[0];
+                    }
+                    String sep = System.getProperty("line.separator");
+                    String[] vobs = output.split(Pattern.quote(sep));
+                    LOGGER.log(Level.CONFIG, "Found VOBs: {0}",
+                            Arrays.asList(vobs));
+                    return vobs;
+                }
+                LOGGER.log(Level.SEVERE,
+                        "\"cleartool lsvob -s\" returned non-zero status: {0}", rc);
+            }
+            return new String[0];
+        }
     }
 
     private static String[] getAllVobs() {
@@ -237,31 +261,6 @@ private static String[] getAllVobs() {
     private static final ClearCaseRepository testRepo
             = new ClearCaseRepository();
 
-    private static String[] runLsvob() {
-        if (testRepo.isWorking()) {
-            Executor exec = new Executor(
-                    new String[]{testRepo.RepoCommand, "lsvob", "-s"});
-            int rc;
-            if ((rc = exec.exec(true)) == 0) {
-                String output = exec.getOutputString();
-
-                if (output == null) {
-                    LOGGER.log(Level.SEVERE,
-                            "\"cleartool lsvob -s\" output was null");
-                    return new String[0];
-                }
-                String sep = System.getProperty("line.separator");
-                String[] vobs = output.split(Pattern.quote(sep));
-                LOGGER.log(Level.CONFIG, "Found VOBs: {0}",
-                        Arrays.asList(vobs));
-                return vobs;
-            }
-            LOGGER.log(Level.SEVERE,
-                    "\"cleartool lsvob -s\" returned non-zero status: {0}", rc);
-        }
-        return new String[0];
-    }
-
     @Override
     boolean hasHistoryForDirectories() {
         return true;

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

@@ -333,7 +333,7 @@ private File pathTranslation(File file, String intermediateElements,
 
     @Override
     boolean isRepositoryFor(File file, CommandTimeoutType cmdType) {
-        File f = new File(file, ".razor");
+        File f = new File(file, RAZOR_DIR);
         return f.exists() && f.isDirectory();
     }