Create custom checkstyle rules for NN 61/23861/2
authorRyan Moats <rmoats@us.ibm.com>
Wed, 8 Jul 2015 00:25:43 +0000 (19:25 -0500)
committerRyan Moats <rmoats@us.ibm.com>
Wed, 8 Jul 2015 17:52:02 +0000 (12:52 -0500)
There are some rules in ODL parent checkstyle that
are annoying - this patch allows us to set our own
for some of them

Change-Id: I4045988200508c4976290a526e7d2ee504c58e25
Signed-off-by: Ryan Moats <rmoats@us.ibm.com>
dummyprovider/pom.xml
integration/test/pom.xml
karaf/pom.xml
neutron-spi/pom.xml
northbound-api/pom.xml
parent/pom.xml
parent/src/main/resources/java_rules.xml [new file with mode: 0644]
pom.xml
transcriber/pom.xml

index c99ef647913b867c8fbd91b8479f41c4210bcece..012671cd5360a746831152dc789034a5cf6d1c8b 100644 (file)
@@ -12,6 +12,9 @@
   <artifactId>dummyprovider</artifactId>
   <version>0.6.0-SNAPSHOT</version>
   <packaging>bundle</packaging>
+  <properties>
+    <checkstyle.location>${project.parent.basedir}/src/main/resources</checkstyle.location>
+  </properties>
   <dependencies>
     <dependency>
       <groupId>org.opendaylight.neutron</groupId>
index 54337fa39158c1a1b6abcdf2a5332266f4f54651..2b4d1ed9658ce748b227f8c0d3a94d139ececa43 100644 (file)
@@ -14,6 +14,7 @@
   <packaging>jar</packaging>
 
   <properties>
+    <checkstyle.location>${project.parent.basedir}/src/main/resources</checkstyle.location>
     <sonar.jacoco.itReportPath>target/jacoco-it.exec</sonar.jacoco.itReportPath>
     <sonar.java.coveragePlugin>jacoco</sonar.java.coveragePlugin>
     <sonar.sources>pom.xml,target/generated-sources/dependency</sonar.sources>
index 9083cc11ada685f6a48697322153ea372406600a..057198dbe4de355f44f635a1812b4bc85fe51804 100644 (file)
@@ -22,6 +22,7 @@ and is available at http://www.eclipse.org/legal/epl-v10.html INTERNAL
   </prerequisites>
   <properties>
     <karaf.localFeature>odl-neutron-dummyprovider-test</karaf.localFeature>
+    <checkstyle.location>${project.parent.basedir}/src/main/resources</checkstyle.location>
   </properties>
   <dependencies>
     <dependency>
index 9fbe817185527abb4c11a73a14ed7cb65b4141db..287fc83a45b763c081f29aafc61ac5800e67abc8 100644 (file)
@@ -12,6 +12,9 @@
   <artifactId>neutron-spi</artifactId>
   <version>0.6.0-SNAPSHOT</version>
   <packaging>bundle</packaging>
+  <properties>
+    <checkstyle.location>${project.parent.basedir}/src/main/resources</checkstyle.location>
+  </properties>
   <dependencies>
     <dependency>
       <groupId>commons-net</groupId>
index a5bc839177980ff643b05fac860b26ade2a5d6a7..7555e2a275ef3d6874cefb21744f3786763215f0 100644 (file)
@@ -12,6 +12,9 @@
   <artifactId>northbound-api</artifactId>
   <version>0.6.0-SNAPSHOT</version>
   <packaging>bundle</packaging>
+  <properties>
+    <checkstyle.location>${project.parent.basedir}/src/main/resources</checkstyle.location>
+  </properties>
   <dependencies>
     <dependency>
       <groupId>com.sun.jersey</groupId>
index d1916d5bda3c82e550e47e10eec13779008da202..77db01ea32e35b0847667e1df3e2e364bdb32224 100644 (file)
@@ -27,6 +27,7 @@
     <yang-ext.version>2013.09.07.7-SNAPSHOT</yang-ext.version>
     <sonar.jacoco.reportPath>target/jacoco.exec</sonar.jacoco.reportPath>
     <sonar.jacoco.itReportPath>../target/jacoco-it.exec</sonar.jacoco.itReportPath>
+    <checkstyle.location>${project.build.resources[0].directory}</checkstyle.location>
   </properties>
   <scm>
     <connection>scm:git:ssh://git.opendaylight.org:29418/neutron.git</connection>
   <build>
     <pluginManagement>
       <plugins>
+        <plugin>
+          <artifactId>maven-checkstyle-plugin</artifactId>
+          <configuration>
+            <configLocation>${checkstyle.location}/java_rules.xml</configLocation>
+            <excludes>org/opendaylight/yang/gen/**,**/yang/**</excludes>
+            <consoleOutput>true</consoleOutput>
+          </configuration>
+          <executions>
+            <execution>
+              <goals>
+                <goal>check</goal>
+              </goals>
+              <phase>process-sources</phase>
+            </execution>
+          </executions>
+        </plugin>
         <plugin>
           <groupId>org.jacoco</groupId>
           <artifactId>jacoco-maven-plugin</artifactId>
diff --git a/parent/src/main/resources/java_rules.xml b/parent/src/main/resources/java_rules.xml
new file mode 100644 (file)
index 0000000..ebfa780
--- /dev/null
@@ -0,0 +1,226 @@
+<?xml version="1.0"?>
+<!DOCTYPE module PUBLIC
+          "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
+          "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
+
+<!--
+
+    Checkstyle configuration that checks the Google coding conventions from:
+
+    -  Google Java Style
+       https://google-styleguide.googlecode.com/svn-history/r130/trunk/javaguide.html
+
+    Checkstyle is very configurable. Be sure to read the documentation at
+    http://checkstyle.sf.net (or in your downloaded distribution).
+
+    Most Checks are configurable, be sure to consult the documentation.
+
+    To completely disable a check, just comment it out or delete it from the file.
+
+    Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov.
+
+ -->
+
+<module name = "Checker">
+    <property name="charset" value="UTF-8"/>
+
+    <property name="severity" value="warning"/>
+
+    <!-- Checks for whitespace                               -->
+    <!-- See http://checkstyle.sf.net/config_whitespace.html -->
+        <module name="FileTabCharacter">
+            <property name="eachLine" value="true"/>
+        </module>
+
+    <module name="TreeWalker">
+        <module name="OuterTypeFilename"/>
+        <module name="IllegalTokenText">
+            <property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
+            <property name="format" value="\\u00(08|09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)"/>
+            <property name="message" value="Avoid using corresponding octal or Unicode escape."/>
+        </module>
+    <!-- Not yet supported https://jira.codehaus.org/browse/MCHECKSTYLE-261
+        <module name="AvoidEscapedUnicodeCharacters">
+            <property name="allowEscapesForControlCharacters" value="true"/>
+            <property name="allowByTailComment" value="true"/>
+            <property name="allowNonPrintableEscapes" value="true"/>
+        </module>
+    -->
+        <module name="LineLength">
+            <property name="max" value="120"/><!-- ODL projects use 120 max line length -->
+            <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
+        </module>
+        <module name="AvoidStarImport"/>
+    <!-- Not yet supported https://jira.codehaus.org/browse/MCHECKSTYLE-261
+        <module name="OneTopLevelClass"/>
+        <module name="NoLineWrap"/>
+    -->
+        <module name="EmptyBlock">
+            <property name="option" value="TEXT"/>
+            <property name="tokens" value="LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
+        </module>
+        <module name="NeedBraces"/>
+        <module name="LeftCurly">
+            <property name="maxLineLength" value="100"/>
+        </module>
+        <module name="RightCurly"/>
+        <module name="RightCurly">
+            <property name="option" value="alone"/>
+            <property name="tokens" value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, LITERAL_DO, STATIC_INIT, INSTANCE_INIT"/>
+        </module>
+        <module name="WhitespaceAround">
+            <property name="allowEmptyConstructors" value="true"/>
+            <property name="allowEmptyMethods" value="true"/>
+        <!-- Not yet supported https://jira.codehaus.org/browse/MCHECKSTYLE-261
+            <property name="allowEmptyTypes" value="true"/>
+            <property name="allowEmptyLoops" value="true"/>
+        -->
+            <message key="ws.notFollowed"
+             value="WhitespaceAround: ''{0}'' is not followed by whitespace."/>
+             <message key="ws.notPreceded"
+             value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
+        </module>
+        <module name="OneStatementPerLine"/>
+        <module name="MultipleVariableDeclarations"/>
+        <module name="ArrayTypeStyle"/>
+        <module name="MissingSwitchDefault"/>
+        <module name="FallThrough"/>
+        <module name="UpperEll"/>
+        <module name="ModifierOrder"/>
+    <!-- Not yet supported https://jira.codehaus.org/browse/MCHECKSTYLE-261
+        <module name="EmptyLineSeparator">
+            <property name="allowNoEmptyLineBetweenFields" value="true"/>
+        </module>
+        <module name="SeparatorWrap">
+            <property name="tokens" value="DOT"/>
+            <property name="option" value="nl"/>
+        </module>
+        <module name="SeparatorWrap">
+            <property name="tokens" value="COMMA"/>
+            <property name="option" value="EOL"/>
+        </module>
+    -->
+        <module name="PackageName">
+            <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
+            <message key="name.invalidPattern"
+             value="Package name ''{0}'' must match pattern ''{1}''."/>
+        </module>
+        <module name="TypeName">
+            <message key="name.invalidPattern"
+             value="Type name ''{0}'' must match pattern ''{1}''."/>
+        </module>
+        <module name="MemberName">
+            <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
+            <message key="name.invalidPattern"
+             value="Member name ''{0}'' must match pattern ''{1}''."/>
+        </module>
+        <module name="ParameterName">
+            <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
+            <message key="name.invalidPattern"
+             value="Parameter name ''{0}'' must match pattern ''{1}''."/>
+        </module>
+        <module name="LocalVariableName">
+            <property name="tokens" value="VARIABLE_DEF"/>
+            <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
+        <!-- Not yet supported https://jira.codehaus.org/browse/MCHECKSTYLE-261
+            <property name="allowOneCharVarInForLoop" value="true"/>
+        -->
+            <message key="name.invalidPattern"
+             value="Local variable name ''{0}'' must match pattern ''{1}''."/>
+        </module>
+        <module name="ClassTypeParameterName">
+            <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
+            <message key="name.invalidPattern"
+             value="Class type name ''{0}'' must match pattern ''{1}''."/>
+        </module>
+        <module name="MethodTypeParameterName">
+            <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
+            <message key="name.invalidPattern"
+             value="Method type name ''{0}'' must match pattern ''{1}''."/>
+        </module>
+        <module name="NoFinalizer"/>
+        <module name="GenericWhitespace">
+            <message key="ws.followed"
+             value="GenericWhitespace ''{0}'' is followed by whitespace."/>
+             <message key="ws.preceded"
+             value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
+             <message key="ws.illegalFollow"
+             value="GenericWhitespace ''{0}'' should followed by whitespace."/>
+             <message key="ws.notPreceded"
+             value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
+        </module>
+        <module name="Indentation">
+            <property name="basicOffset" value="4"/>
+            <property name="braceAdjustment" value="0"/>
+            <property name="caseIndent" value="4"/>
+            <property name="throwsIndent" value="4"/>
+        <!-- Not yet supported https://jira.codehaus.org/browse/MCHECKSTYLE-261
+            <property name="lineWrappingIndentation" value="4"/>
+            <property name="arrayInitIndent" value="4"/>
+        -->
+        </module>
+    <!-- Not yet supported https://jira.codehaus.org/browse/MCHECKSTYLE-261
+        <module name="AbbreviationAsWordInName">
+            <property name="ignoreFinal" value="false"/>
+            <property name="allowedAbbreviationLength" value="1"/>
+        </module>
+        <module name="OverloadMethodsDeclarationOrder"/>
+        <module name="VariableDeclarationUsageDistance"/>
+        <module name="CustomImportOrder">
+            <property name="thirdPartyPackageRegExp" value=".*"/>
+            <property name="specialImportsRegExp" value="com.google"/>
+            <property name="sortImportsInGroupAlphabetically" value="true"/>
+            <property name="customImportOrderRules" value="STATIC###SPECIAL_IMPORTS###THIRD_PARTY_PACKAGE###STANDARD_JAVA_PACKAGE"/>
+        </module>
+    -->
+        <module name="MethodParamPad"/>
+        <module name="OperatorWrap">
+            <property name="option" value="NL"/>
+            <property name="tokens" value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR, LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR "/>
+        </module>
+    <!-- Not yet supported https://jira.codehaus.org/browse/MCHECKSTYLE-261
+        <module name="AnnotationLocation">
+            <property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/>
+        </module>
+        <module name="AnnotationLocation">
+            <property name="tokens" value="VARIABLE_DEF"/>
+            <property name="allowSamelineMultipleAnnotations" value="true"/>
+        </module>
+        <module name="NonEmptyAtclauseDescription"/>
+        <module name="JavadocTagContinuationIndentation"/>
+        <module name="SummaryJavadocCheck">
+            <property name="forbiddenSummaryFragments" value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
+        </module>
+        <module name="JavadocParagraph"/>
+        <module name="AtclauseOrder">
+            <property name="tagOrder" value="@param, @return, @throws, @deprecated"/>
+            <property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
+        </module>
+    -->
+        <module name="JavadocMethod">
+            <property name="scope" value="public"/>
+            <property name="allowMissingParamTags" value="true"/>
+            <property name="allowMissingThrowsTags" value="true"/>
+            <property name="allowMissingReturnTag" value="true"/>
+            <property name="minLineCount" value="4"/>
+        <!-- Not yet supported https://jira.codehaus.org/browse/MCHECKSTYLE-261
+            <property name="allowedAnnotations" value="Override, Test"/>
+        -->
+            <property name="allowThrowsTagsForSubclasses" value="true"/>
+        </module>
+        <module name="MethodName">
+            <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
+            <message key="name.invalidPattern"
+             value="Method name ''{0}'' must match pattern ''{1}''."/>
+        </module>
+    <!-- Not yet supported https://jira.codehaus.org/browse/MCHECKSTYLE-261
+        <module name="SingleLineJavadoc"/>
+    -->
+
+    </module>
+
+    <module name="RegexpHeader">
+        <property name="headerFile" value="${checkstyle.header.file}"/>
+        <property name="multiLines" value="2"/>
+    </module>
+</module>
diff --git a/pom.xml b/pom.xml
index b9ae51a43a5fcee8f1848adaf4a6d564d4620461..bce204ef5cb0f978098eb010a78490e0040ab8ec 100644 (file)
--- a/pom.xml
+++ b/pom.xml
@@ -85,6 +85,9 @@
       <timezone>Asia/Kolkata</timezone>
     </developer>
   </developers>
+  <properties>
+    <checkstyle.location>${project.parent.basedir}/src/main/resources</checkstyle.location>
+  </properties>
   <modules>
     <module>parent</module>
     <module>neutron-spi</module>
index d1df36214bd4ccc398bcd4df2f0f9df386341cfa..c4216b52187bf43d20728b5ecb94a6ce6181f795 100644 (file)
@@ -11,6 +11,9 @@
   <artifactId>transcriber</artifactId>
   <version>0.6.0-SNAPSHOT</version>
   <packaging>bundle</packaging>
+  <properties>
+    <checkstyle.location>${project.parent.basedir}/src/main/resources</checkstyle.location>
+  </properties>
   <dependencies>
     <dependency>
       <groupId>org.opendaylight.neutron</groupId>