Bxc 3811 adjust codeclimate thresholds 2 (#1520)

* add default codeclimate checks

* modify checkstyle config, move LineLength module, add/remove properties

* new maven-checkstyle-plugin version

* enable checkstyle plugin

* add checkstyle config file

* disable checkstyle plugin

* adjust thresholds

* fix spelling

* method-lines threshold to 150

* disabled similar-code and identical-code checks, add duplication plugin

* increase java mass threshold in duplication plugin

* enable similar-code and identical-code, java mass threshold to 45 in duplication plugin

* enable duplication plugin

* change duplication count_threshold to 4

* change duplication count_threshold to 5

* change comments, add default java mass_threshold to duplication

Author: krwong

.codeclimate.yml

@@ -1,15 +1,66 @@
 version: "2"
+
+checks:
+  argument-count:
+    enabled: true
+    config:
+      threshold: 7
+  complex-logic:
+    enabled: true
+    config:
+      threshold: 4
+  file-lines:
+    enabled: true
+    config:
+      threshold: 500
+  method-complexity:
+    enabled: true
+    config:
+      threshold: 25
+  method-count:
+    enabled: true
+    config:
+      threshold: 50
+  method-lines:
+    enabled: true
+    config:
+      threshold: 150
+  nested-control-flow:
+    enabled: true
+    config:
+      threshold: 4
+  return-statements:
+    enabled: true
+    config:
+      threshold: 4
+  similar-code:
+    enabled: true
+    config:
+      threshold: # language-specific defaults. an override will affect all languages.
+  identical-code:
+    enabled: true
+    config:
+      threshold: # language-specific defaults. an override will affect all languages.
+
 plugins:
-  # checkstyle is disabled until we figure out
-  # how to incorporate our file suppressions config.
+  # there are 16,000+ errors/warnings when checkstyle is enabled
   checkstyle:
     enabled: false
-    # config:
-    #   file: "common-utils/src/main/resources/checkstyle/checkstyle.xml"
+    config:
+      file: "common-utils/src/main/resources/checkstyle/checkstyle.xml"
   sonar-java:
     enabled: true
   pmd:
     enabled: true
+  # duplication plugin affects similar-code and identical-code
+  duplication:
+    enabled: true
+    config:
+      count_threshold: 5
+      languages:
+        java:
+          mass_threshold: 40 # default threshold
+
 exclude_patterns:
   - "static/js/lib/"
   - "static/js/admin/performance_visualizations/assets/"

common-utils/src/main/resources/checkstyle/checkstyle-suppressions.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE suppressions PUBLIC
-     "-//Puppy Crawl//DTD Suppressions 1.1//EN"
-     "http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
+     "-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN"
+     "https://checkstyle.orgm/dtds/suppressions_1_2.dtd">
 <suppressions>
     <suppress checks=".*" files="/fcrepo/" />
     <suppress checks=".*" files="/fcrepo-cdr-fesl/" />

common-utils/src/main/resources/checkstyle/checkstyle.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE module PUBLIC
-    "-//Puppy Crawl//DTD Check Configuration 1.2//EN"
-    "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
+    "-//Checkstyle//DTD Checkstyle Configuration 1.2//EN"
+    "https://checkstyle.or/dtds/configuration_1_2.dtd">
 <!-- Checkstyle configuration that checks the Fedora coding conventions from: 
     - the Fedora FcRepo4 Code Style Guide https://wiki.duraspace.org/display/FF/Code+Style+Guide 
     - some best practices Checkstyle is very configurable. Be sure to read the 
@@ -18,20 +18,27 @@
         http://checkstyle.sourceforge.net/property_types.html
     -->
 <module name="Checker">
+    <property name="severity" value="warning"/>
 
     <!-- Suppress 
         The fcrepo based suppression file disables JavaDoc checks in unit test and IT test files.
         It also disables indentation checking, e.g. 4 spaces for all java files
     -->
     <module name="SuppressionFilter">
-        <property name="file" value="${checkstyle.suppressions.file}"/>
+        <property name="file" value="common-utils/src/main/resources/checkstyle/checkstyle-suppressions.xml"/>
     </module>
 
     <!-- Checks that there are no tab characters ('\t') in the source code. -->
     <module name="FileTabCharacter">
         <property name="eachLine" value="true" />
         <property name="fileExtensions" value="css,java,js,jsp,xml,xsl" />
     </module>
+
+    <!-- Checks for long lines. -->
+    <module name="LineLength">
+        <property name="fileExtensions" value="java"/>
+        <property name="max" value="120"/>
+    </module>
 
     <!-- License Header module disabled in favor of license-maven-plugin -->
     <module name="TreeWalker">
@@ -45,11 +52,6 @@
         <!-- Check that finds import statements that use the * notation. -->
         <module name="AvoidStarImport" />
 
-        <!-- Checks for long lines. -->
-        <module name="LineLength">
-            <property name="max" value="120"/>
-        </module>
-        
         <!-- Write Javadocs for public methods and classes. Keep it short and to 
             the point /** * @author Joe Developer * @date MMM DD, YYYY */ public class 
             MyClass -->
@@ -70,11 +72,7 @@
 
         <!-- Relaxes syntax options for JavaDoc comments -->
         <module name="JavadocMethod">
-            <property name="scope" value="public" />
-            <!-- whether to allow documented exceptions that are not declared if they are a subclass of java.lang.RuntimeException -->
-            <property name="allowUndeclaredRTE" value="true" /> 
             <property name="allowMissingParamTags" value="true" />
-            <property name="allowMissingThrowsTags" value="true" />
             <property name="allowMissingReturnTag" value="true" />
         </module>
 

pom.xml

@@ -138,7 +138,7 @@
         <maven.surefire.version>2.22.1</maven.surefire.version>
         <compiler.plugin.version>3.8.0</compiler.plugin.version>
         <maven-eclipse-plugin.version>2.10</maven-eclipse-plugin.version>
-        <maven-checkstyle-plugin.version>3.0.0</maven-checkstyle-plugin.version>
+        <maven-checkstyle-plugin.version>3.2.1</maven-checkstyle-plugin.version>
         <maven-release-plugin.version>2.5.3</maven-release-plugin.version>
         <exec-maven-plugin.version>3.1.0</exec-maven-plugin.version>
         <maven-scm-provider-svnjava.version>2.1.2</maven-scm-provider-svnjava.version>