From 3322a0f7105a6e37c5d92fe2cd147381b2855b52 Mon Sep 17 00:00:00 2001
From: Lorand Jakab <lojakab@cisco.com>
Date: Wed, 22 Oct 2014 12:07:11 +0300
Subject: [PATCH] Add coding style checks

Run the maven-checkstyle-plugin during the build, using rules from the
controller project, which include:

  - No TAB characters
  - No trailing spaces
  - No redundant, unused or star imports
  - Long constants defined with upper ell: 'L'
  - No empty statements (standalone ';' semicolon)
  - If a class overrides equals() it must override hashCode()

These rules are applied to .java, .xml, and .yang files.  Rule
violations are reported on the console, but they don't cause the build
to fail.  This behavior should be changed in the future, when the
existing code base is cleaned up, so that no new violations are
introduced after that.

Change-Id: I552eb72e1ac4b96a4cf80a216a1638bb36d77821
Signed-off-by: Lorand Jakab <lojakab@cisco.com>
---
 commons/parent/pom.xml | 33 +++++++++++++++++++++++++++++++++
 pom.xml                | 20 ++++++++++++--------
 2 files changed, 45 insertions(+), 8 deletions(-)

diff --git a/commons/parent/pom.xml b/commons/parent/pom.xml
index e8ff45050..eeab58c88 100644
--- a/commons/parent/pom.xml
+++ b/commons/parent/pom.xml
@@ -33,6 +33,7 @@
 		<build.suffix>1.0.0</build.suffix>
 		<clustering.services.version>0.6.0-SNAPSHOT</clustering.services.version>
 		<config.version>0.3.0-SNAPSHOT</config.version>
+		<controller.checkstyle.version>0.1.0-SNAPSHOT</controller.checkstyle.version>
 		<enforcer.version>1.3.1</enforcer.version>
 		<enunciate.version>1.26.2</enunciate.version>
 		<feature.test.version>0.7.0-SNAPSHOT</feature.test.version>
@@ -712,6 +713,38 @@
 						</execution>
 					</executions>
 				</plugin>
+      <plugin>
+        <!-- Define the configuration for the checkstyle plugin.  Import the rules from the controller project, which
+             is defined as a dependency.  Print rule violations to the console, but don't fail the build if violations
+             are found. -->
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-checkstyle-plugin</artifactId>
+        <version>${checkstyle.version}</version>
+        <configuration>
+          <failOnViolation>false</failOnViolation>
+          <configLocation>controller/checkstyle.xml</configLocation>
+          <consoleOutput>true</consoleOutput>
+          <includeTestSourceDirectory>true</includeTestSourceDirectory>
+          <sourceDirectory>${project.basedir}</sourceDirectory>
+          <includes>**\/*.java,**\/*.xml,**\/*.yang</includes>
+          <excludes>**\/target\/,**\/target-ide\/,**\/${jmxGeneratorPath}\/,**\/${salGeneratorPath}\/</excludes>
+        </configuration>
+        <dependencies>
+          <dependency>
+            <groupId>org.opendaylight.controller</groupId>
+            <artifactId>checkstyle</artifactId>
+            <version>${controller.checkstyle.version}</version>
+          </dependency>
+        </dependencies>
+        <executions>
+          <execution>
+            <goals>
+              <goal>check</goal>
+            </goals>
+            <phase>process-sources</phase>
+          </execution>
+        </executions>
+      </plugin>
 			</plugins>
 		</pluginManagement>
 		<plugins>
diff --git a/pom.xml b/pom.xml
index f3d09991e..b5e484d5e 100644
--- a/pom.xml
+++ b/pom.xml
@@ -26,8 +26,7 @@
     <pluginManagement>
       <plugins>
         <plugin>
-          <!-- we are overriding the default version of this plugin here... not
-						sure why. -->
+          <!-- we are overriding the default version of this plugin here... not sure why. -->
           <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-dependency-plugin</artifactId>
           <version>2.8</version>
@@ -37,20 +36,25 @@
     <plugins>
       <plugin>
         <!-- In this project we want to automatically sort all poms, thus we
-					add the invocation of this plugin to the root parent. Configuration is in
-					the ODL parent. -->
+             add the invocation of this plugin to the root parent. Configuration is in
+             the ODL parent. -->
         <groupId>com.google.code.sortpom</groupId>
         <artifactId>maven-sortpom-plugin</artifactId>
       </plugin>
+      <plugin>
+        <!-- Check for coding style violations.  Configuration in the parent pom. -->
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-checkstyle-plugin</artifactId>
+      </plugin>
     </plugins>
   </build>
 
   <repositories>
     <!-- NOTE: The repositories and plugin repositories sections need fully
-			qualified URLs to the nexus because it has to download the parent. There
-			seems to be a bug where you need to parent before any properties can be substituted
-			in. You can override this URL by using the "mirror" section of your settings.xml
-			configuration file. See http://maven.apache.org/guides/mini/guide-mirror-settings.html -->
+         qualified URLs to the nexus because it has to download the parent. There
+         seems to be a bug where you need to parent before any properties can be substituted
+         in. You can override this URL by using the "mirror" section of your settings.xml
+         configuration file. See http://maven.apache.org/guides/mini/guide-mirror-settings.html -->
     <!-- OpenDayLight Repo Mirror -->
     <repository>
       <releases>
-- 
2.36.6