Checkstyle: preparation for switching to odlparent

There has been a lot of work on the ODL-wide checkstyle rules in
odlparent, and we should eventually be compliant. To be able to make
progress on individial bundles, this commit moves our custom checkstyle
enabler from mappingservice/pom.xml to the individual child poms. As an
example, mappingservice/shell is updated to comply with ODL checkstyle
rules and turns on enforcement. Additionally, it contains a violation
that is inevitable, and code to suppress than one particular violation.
That can be used as an example in other places where there is good
reason not to follow ODL style.

Change-Id: I3455f4084fa1302f8a970b2dfba0b9293767aecf
Signed-off-by: Lorand Jakab <lojakab@cisco.com>

diff --git a/mappingservice/api/pom.xml b/mappingservice/api/pom.xml
index 45e49931bcb7cfc04b967cffaa5baedbf62f15c1..496fd1154225c700d111e8bdb54cb4d09df76cb4 100644 (file)
--- a/mappingservice/api/pom.xml
+++ b/mappingservice/api/pom.xml
@@ -27,6 +27,40 @@
     </dependency>
   </dependencies>
 
+  <build>
+    <pluginManagement>
+      <plugins>
+        <plugin>
+          <!-- Temporarily override the odlparent checkstyle configuration.
+               We want to enforce some simple rules and add more as we clean up code -->
+          <artifactId>maven-checkstyle-plugin</artifactId>
+          <configuration>
+            <configLocation>checkstyle/java_rules.xml</configLocation>
+            <includeTestSourceDirectory>true</includeTestSourceDirectory>
+            <excludes>org/opendaylight/yang/gen/**,**/config/yang/**</excludes>
+            <failsOnError>true</failsOnError>
+            <consoleOutput>true</consoleOutput>
+          </configuration>
+          <dependencies>
+            <dependency>
+              <groupId>org.opendaylight.lispflowmapping</groupId>
+              <artifactId>common.build.tools</artifactId>
+              <version>${project.version}</version>
+            </dependency>
+          </dependencies>
+          <executions>
+            <execution>
+              <goals>
+                <goal>check</goal>
+              </goals>
+              <phase>process-sources</phase>
+            </execution>
+          </executions>
+        </plugin>
+      </plugins>
+    </pluginManagement>
+  </build>
+
   <!--
       Maven Site Configuration
 

diff --git a/mappingservice/dsbackend/pom.xml b/mappingservice/dsbackend/pom.xml
index 14e75da8d9988135da4597d80b249e7daa9ee0c4..34789a5aa9e4fdb8845dbeb8b044cc0a69082617 100644 (file)
--- a/mappingservice/dsbackend/pom.xml
+++ b/mappingservice/dsbackend/pom.xml
@@ -46,6 +46,40 @@
 
   </dependencies>
 
+  <build>
+    <pluginManagement>
+      <plugins>
+        <plugin>
+          <!-- Temporarily override the odlparent checkstyle configuration.
+               We want to enforce some simple rules and add more as we clean up code -->
+          <artifactId>maven-checkstyle-plugin</artifactId>
+          <configuration>
+            <configLocation>checkstyle/java_rules.xml</configLocation>
+            <includeTestSourceDirectory>true</includeTestSourceDirectory>
+            <excludes>org/opendaylight/yang/gen/**,**/config/yang/**</excludes>
+            <failsOnError>true</failsOnError>
+            <consoleOutput>true</consoleOutput>
+          </configuration>
+          <dependencies>
+            <dependency>
+              <groupId>org.opendaylight.lispflowmapping</groupId>
+              <artifactId>common.build.tools</artifactId>
+              <version>${project.version}</version>
+            </dependency>
+          </dependencies>
+          <executions>
+            <execution>
+              <goals>
+                <goal>check</goal>
+              </goals>
+              <phase>process-sources</phase>
+            </execution>
+          </executions>
+        </plugin>
+      </plugins>
+    </pluginManagement>
+  </build>
+
   <!--
       Maven Site Configuration
 

diff --git a/mappingservice/implementation/pom.xml b/mappingservice/implementation/pom.xml
index 70233c1c40b0a06cd3efb6a849c72dbe2056bc48..51895d004c66dbb2bcfdef6393ee74d5bbbf73df 100644 (file)
--- a/mappingservice/implementation/pom.xml
+++ b/mappingservice/implementation/pom.xml
@@ -59,6 +59,40 @@
     </dependency>
   </dependencies>
 
+  <build>
+    <pluginManagement>
+      <plugins>
+        <plugin>
+          <!-- Temporarily override the odlparent checkstyle configuration.
+               We want to enforce some simple rules and add more as we clean up code -->
+          <artifactId>maven-checkstyle-plugin</artifactId>
+          <configuration>
+            <configLocation>checkstyle/java_rules.xml</configLocation>
+            <includeTestSourceDirectory>true</includeTestSourceDirectory>
+            <excludes>org/opendaylight/yang/gen/**,**/config/yang/**</excludes>
+            <failsOnError>true</failsOnError>
+            <consoleOutput>true</consoleOutput>
+          </configuration>
+          <dependencies>
+            <dependency>
+              <groupId>org.opendaylight.lispflowmapping</groupId>
+              <artifactId>common.build.tools</artifactId>
+              <version>${project.version}</version>
+            </dependency>
+          </dependencies>
+          <executions>
+            <execution>
+              <goals>
+                <goal>check</goal>
+              </goals>
+              <phase>process-sources</phase>
+            </execution>
+          </executions>
+        </plugin>
+      </plugins>
+    </pluginManagement>
+  </build>
+
   <!--
       Maven Site Configuration
 

diff --git a/mappingservice/inmemorydb/pom.xml b/mappingservice/inmemorydb/pom.xml
index 47a8934ed3beb5681ee622b057868316ac2d93fc..d7bd393e17c72a431d6038d56f653351ed9b12cc 100644 (file)
--- a/mappingservice/inmemorydb/pom.xml
+++ b/mappingservice/inmemorydb/pom.xml
@@ -19,6 +19,40 @@
     </dependency>
   </dependencies>
 
+  <build>
+    <pluginManagement>
+      <plugins>
+        <plugin>
+          <!-- Temporarily override the odlparent checkstyle configuration.
+               We want to enforce some simple rules and add more as we clean up code -->
+          <artifactId>maven-checkstyle-plugin</artifactId>
+          <configuration>
+            <configLocation>checkstyle/java_rules.xml</configLocation>
+            <includeTestSourceDirectory>true</includeTestSourceDirectory>
+            <excludes>org/opendaylight/yang/gen/**,**/config/yang/**</excludes>
+            <failsOnError>true</failsOnError>
+            <consoleOutput>true</consoleOutput>
+          </configuration>
+          <dependencies>
+            <dependency>
+              <groupId>org.opendaylight.lispflowmapping</groupId>
+              <artifactId>common.build.tools</artifactId>
+              <version>${project.version}</version>
+            </dependency>
+          </dependencies>
+          <executions>
+            <execution>
+              <goals>
+                <goal>check</goal>
+              </goals>
+              <phase>process-sources</phase>
+            </execution>
+          </executions>
+        </plugin>
+      </plugins>
+    </pluginManagement>
+  </build>
+
   <!--
       Maven Site Configuration
 

diff --git a/mappingservice/mapcache/pom.xml b/mappingservice/mapcache/pom.xml
index 7c3e04a587e3e48831f5baa414b85a81ce9f9458..6e51050c5ec6cc6dea51b448b81f63b3fd3009cd 100644 (file)
--- a/mappingservice/mapcache/pom.xml
+++ b/mappingservice/mapcache/pom.xml
@@ -33,6 +33,40 @@
     </dependency>
   </dependencies>
 
+  <build>
+    <pluginManagement>
+      <plugins>
+        <plugin>
+          <!-- Temporarily override the odlparent checkstyle configuration.
+               We want to enforce some simple rules and add more as we clean up code -->
+          <artifactId>maven-checkstyle-plugin</artifactId>
+          <configuration>
+            <configLocation>checkstyle/java_rules.xml</configLocation>
+            <includeTestSourceDirectory>true</includeTestSourceDirectory>
+            <excludes>org/opendaylight/yang/gen/**,**/config/yang/**</excludes>
+            <failsOnError>true</failsOnError>
+            <consoleOutput>true</consoleOutput>
+          </configuration>
+          <dependencies>
+            <dependency>
+              <groupId>org.opendaylight.lispflowmapping</groupId>
+              <artifactId>common.build.tools</artifactId>
+              <version>${project.version}</version>
+            </dependency>
+          </dependencies>
+          <executions>
+            <execution>
+              <goals>
+                <goal>check</goal>
+              </goals>
+              <phase>process-sources</phase>
+            </execution>
+          </executions>
+        </plugin>
+      </plugins>
+    </pluginManagement>
+  </build>
+
   <!--
       Maven Site Configuration
 

diff --git a/mappingservice/pom.xml b/mappingservice/pom.xml
index 8e9c67d896295094238d5a9aacac5c96b0d22a66..0f481a6d2bc2ec309eed5639b210333550dfbfcb 100644 (file)
--- a/mappingservice/pom.xml
+++ b/mappingservice/pom.xml
@@ -89,40 +89,6 @@
     </dependency>
   </dependencies>
 
-  <build>
-    <pluginManagement>
-      <plugins>
-        <plugin>
-          <!-- Temporarily override the odlparent checkstyle configuration.
-               We want to enforce some simple rules and add more as we clean up code -->
-          <artifactId>maven-checkstyle-plugin</artifactId>
-          <configuration>
-            <configLocation>checkstyle/java_rules.xml</configLocation>
-            <includeTestSourceDirectory>true</includeTestSourceDirectory>
-            <excludes>org/opendaylight/yang/gen/**,**/config/yang/**</excludes>
-            <failsOnError>true</failsOnError>
-            <consoleOutput>true</consoleOutput>
-          </configuration>
-          <dependencies>
-            <dependency>
-              <groupId>org.opendaylight.lispflowmapping</groupId>
-              <artifactId>common.build.tools</artifactId>
-              <version>${project.version}</version>
-            </dependency>
-          </dependencies>
-          <executions>
-            <execution>
-              <goals>
-                <goal>check</goal>
-              </goals>
-              <phase>process-sources</phase>
-            </execution>
-          </executions>
-        </plugin>
-      </plugins>
-    </pluginManagement>
-  </build>
-
   <!--
       Maven Site Configuration
 

diff --git a/mappingservice/shell/pom.xml b/mappingservice/shell/pom.xml
index b3004575b6ca0a7149e512ffd3731abe1d243c4a..23d96b8701be0d45a61f0d24783202f0ddaf5d07 100644 (file)
--- a/mappingservice/shell/pom.xml
+++ b/mappingservice/shell/pom.xml
@@ -25,6 +25,19 @@
   </dependencies>
 
   <build>
+    <pluginManagement>
+      <plugins>
+        <plugin>
+          <!-- Enforce odlparent checkstyle -->
+          <groupId>org.apache.maven.plugins</groupId>
+          <artifactId>maven-checkstyle-plugin</artifactId>
+          <configuration>
+            <includeTestSourceDirectory>true</includeTestSourceDirectory>
+            <propertyExpansion>checkstyle.violationSeverity=error</propertyExpansion>
+          </configuration>
+        </plugin>
+      </plugins>
+    </pluginManagement>
     <plugins>
       <plugin>
         <groupId>org.apache.felix</groupId>

diff --git a/mappingservice/shell/src/main/java/org/opendaylight/lispflowmapping/shell/LispAddKey.java b/mappingservice/shell/src/main/java/org/opendaylight/lispflowmapping/shell/LispAddKey.java
index a37464042600e1943c483757ae0f808df09e543d..77167967ba665d6aa100bd064cb9bfba5e1b1593 100644 (file)
--- a/mappingservice/shell/src/main/java/org/opendaylight/lispflowmapping/shell/LispAddKey.java
+++ b/mappingservice/shell/src/main/java/org/opendaylight/lispflowmapping/shell/LispAddKey.java
@@ -13,12 +13,12 @@ import org.apache.karaf.shell.console.OsgiCommandSupport;
 import org.opendaylight.lispflowmapping.interfaces.mappingservice.IMappingServiceShell;
 
 /**
- * This class implements the "lisp:addkey" Karaf shell command
+ * This class implements the "lisp:addkey" Karaf shell command.
  *
  * @author Lorand Jakab
  *
  */
-@Command(scope = "mappingservice", name = "addkey", description="Add an authentication key")
+@Command(scope = "mappingservice", name = "addkey", description = "Add an authentication key")
 public class LispAddKey  extends OsgiCommandSupport {
     private IMappingServiceShell mappingServiceShell;
 

diff --git a/mappingservice/shell/src/main/java/org/opendaylight/lispflowmapping/shell/LispMappings.java b/mappingservice/shell/src/main/java/org/opendaylight/lispflowmapping/shell/LispMappings.java
index e84bbd350f7b01de0d6ddbe48f6cb78906023532..4e44795cdbbfc1a03e15e8f3fec4210f3ab47015 100644 (file)
--- a/mappingservice/shell/src/main/java/org/opendaylight/lispflowmapping/shell/LispMappings.java
+++ b/mappingservice/shell/src/main/java/org/opendaylight/lispflowmapping/shell/LispMappings.java
@@ -13,16 +13,17 @@ import org.apache.karaf.shell.console.OsgiCommandSupport;
 import org.opendaylight.lispflowmapping.interfaces.mappingservice.IMappingServiceShell;
 
 /**
- * This class implements the "lisp:mappings" Karaf shell command
+ * This class implements the "lisp:mappings" Karaf shell command.
  *
  * @author Lorand Jakab
  *
  */
-@Command(scope = "mappingservice", name = "mappings", description="Print LISP mapping database")
+@Command(scope = "mappingservice", name = "mappings", description = "Print LISP mapping database")
 public class LispMappings  extends OsgiCommandSupport {
     private IMappingServiceShell mappingServiceShell;
 
     @Override
+    @SuppressWarnings("checkstyle:RegexpMultiline")
     protected Object doExecute() throws Exception {
         System.out.print(mappingServiceShell.printMappings());
         return null;

diff --git a/mappingservice/southbound/pom.xml b/mappingservice/southbound/pom.xml
index 048b91c10e32897c75cfacedec28d740cf190ddc..575e4f34e96a7e785447502543d76c3fdbe1b5e5 100644 (file)
--- a/mappingservice/southbound/pom.xml
+++ b/mappingservice/southbound/pom.xml
@@ -53,6 +53,40 @@
     </dependency>
   </dependencies>
 
+  <build>
+    <pluginManagement>
+      <plugins>
+        <plugin>
+          <!-- Temporarily override the odlparent checkstyle configuration.
+               We want to enforce some simple rules and add more as we clean up code -->
+          <artifactId>maven-checkstyle-plugin</artifactId>
+          <configuration>
+            <configLocation>checkstyle/java_rules.xml</configLocation>
+            <includeTestSourceDirectory>true</includeTestSourceDirectory>
+            <excludes>org/opendaylight/yang/gen/**,**/config/yang/**</excludes>
+            <failsOnError>true</failsOnError>
+            <consoleOutput>true</consoleOutput>
+          </configuration>
+          <dependencies>
+            <dependency>
+              <groupId>org.opendaylight.lispflowmapping</groupId>
+              <artifactId>common.build.tools</artifactId>
+              <version>${project.version}</version>
+            </dependency>
+          </dependencies>
+          <executions>
+            <execution>
+              <goals>
+                <goal>check</goal>
+              </goals>
+              <phase>process-sources</phase>
+            </execution>
+          </executions>
+        </plugin>
+      </plugins>
+    </pluginManagement>
+  </build>
+
   <!--
       Maven Site Configuration