Adding/Replacing Plugins to format/validate code

Replacing Groovy script with directory-maven-plugin to identify baseDirPath

Add license-maven-plugin plugin to Generate / Validate Copyright header

Adding tidy-maven-plugin to format / validate POM.xml

Updating Java Code Formatter Sytle XML to Version 13

Issue-ID: LOG-1129
Signed-off-by: Singal, Kapil (ks220y) <ks220y@att.com>
Change-Id: Ifa333053bb1dff70f28b14ea9460073043e9c847

5 files changed, 267 insertions, 245 deletions

diff --git a/reference/logging-filter/logging-filter-base/pom.xml b/reference/logging-filter/logging-filter-base/pom.xml
index 297d54d..d275833 100644
--- a/reference/logging-filter/logging-filter-base/pom.xml
+++ b/reference/logging-filter/logging-filter-base/pom.xml
@@ -54,9 +54,9 @@
 			<scope>test</scope>
 		</dependency>
 		<dependency>
-      		<groupId>org.mockito</groupId>
-      		<artifactId>mockito-core</artifactId>
-      		<scope>test</scope>
+			<groupId>org.mockito</groupId>
+			<artifactId>mockito-core</artifactId>
+			<scope>test</scope>
     	</dependency>
 	</dependencies>
 </project>
diff --git a/reference/logging-filter/logging-filter-base/src/main/java/org/onap/logging/filter/base/ONAPComponents.java b/reference/logging-filter/logging-filter-base/src/main/java/org/onap/logging/filter/base/ONAPComponents.java
index 1b9c1cd..06fbba9 100644
--- a/reference/logging-filter/logging-filter-base/src/main/java/org/onap/logging/filter/base/ONAPComponents.java
+++ b/reference/logging-filter/logging-filter-base/src/main/java/org/onap/logging/filter/base/ONAPComponents.java
@@ -7,9 +7,9 @@
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
- *
+ * 
  *      http://www.apache.org/licenses/LICENSE-2.0
- *
+ * 
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
diff --git a/reference/logging-filter/logging-filter-base/src/main/java/org/onap/logging/filter/base/ONAPComponentsList.java b/reference/logging-filter/logging-filter-base/src/main/java/org/onap/logging/filter/base/ONAPComponentsList.java
index f117ab7..7ffc251 100644
--- a/reference/logging-filter/logging-filter-base/src/main/java/org/onap/logging/filter/base/ONAPComponentsList.java
+++ b/reference/logging-filter/logging-filter-base/src/main/java/org/onap/logging/filter/base/ONAPComponentsList.java
@@ -7,9 +7,9 @@
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
- *
+ * 
  *      http://www.apache.org/licenses/LICENSE-2.0
- *
+ * 
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
diff --git a/reference/logging-filter/logging-filter-spring/pom.xml b/reference/logging-filter/logging-filter-spring/pom.xml
index 42f5fe8..e7ae8f8 100644
--- a/reference/logging-filter/logging-filter-spring/pom.xml
+++ b/reference/logging-filter/logging-filter-spring/pom.xml
@@ -63,9 +63,9 @@
 			<scope>test</scope>
 		</dependency>
 		<dependency>
-      		<groupId>org.mockito</groupId>
-      		<artifactId>mockito-core</artifactId>
-      		<scope>test</scope>
+			<groupId>org.mockito</groupId>
+			<artifactId>mockito-core</artifactId>
+			<scope>test</scope>
     	</dependency>
 	</dependencies>
 </project>
diff --git a/reference/logging-filter/pom.xml b/reference/logging-filter/pom.xml
index 6038024..aef5327 100644
--- a/reference/logging-filter/pom.xml
+++ b/reference/logging-filter/pom.xml
@@ -1,241 +1,263 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
-	<modelVersion>4.0.0</modelVersion>
-	
-	<parent>
-      <groupId>org.onap.logging-analytics</groupId>
-      <artifactId>logging-reference</artifactId>
-      <version>1.5.0-SNAPSHOT</version>
-	</parent>
-	<artifactId>logging-filter-parent</artifactId>
-	<packaging>pom</packaging>
+    <modelVersion>4.0.0</modelVersion>
 
-	<modules>
-		<module>logging-filter-base</module>
-		<module>logging-filter-spring</module>
-	</modules>
-	
-	<properties>
-		<format.skipValidate>false</format.skipValidate>
-    	<format.skipExecute>true</format.skipExecute>
-    	<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-	</properties>
+    <parent>
+        <groupId>org.onap.logging-analytics</groupId>
+        <artifactId>logging-reference</artifactId>
+        <version>1.5.0-SNAPSHOT</version>
+    </parent>
 
-	<dependencyManagement>
-		<dependencies>
-			<dependency>
-				<groupId>javax.annotation</groupId>
-				<artifactId> javax.annotation-api</artifactId>
-				<version>1.2</version>
-				<scope>provided</scope>
-			</dependency>
-			<dependency>
-				<groupId>org.onap.logging-analytics</groupId>
-				<artifactId>logging-slf4j</artifactId>
-				<version>1.5.0-SNAPSHOT</version>
-			</dependency>
-			<dependency>
-				<groupId>javax.servlet</groupId>
-				<artifactId>javax.servlet-api</artifactId>
-				<version>3.1.0</version>
-				<scope>provided</scope>
-			</dependency>
-			<dependency>
-				<groupId>javax.ws.rs</groupId>
-				<artifactId>javax.ws.rs-api</artifactId>
-				<version>2.0.1</version>
-				<scope>provided</scope>
-			</dependency>
-			<dependency>
-				<groupId>org.slf4j</groupId>
-				<artifactId>slf4j-api</artifactId>
-				<version>1.7.25</version>
-				<scope>provided</scope>
-			</dependency>
-			<dependency>
-				<groupId>org.apache.logging.log4j</groupId>
-				<artifactId>log4j-slf4j-impl</artifactId>
-				<version>2.11.2</version>
-				<scope>test</scope>
-			</dependency>
-			<dependency>
-				<groupId>junit</groupId>
-				<artifactId>junit</artifactId>
-				<version>4.11</version>
-				<scope>test</scope>
-			</dependency>
-			<dependency>
-        		<groupId>org.mockito</groupId>
-        		<artifactId>mockito-core</artifactId>
-        		<version>2.15.0</version>
-        		<scope>test</scope>
-      		</dependency>
-		</dependencies>
-	</dependencyManagement>
+    <artifactId>logging-filter-parent</artifactId>
+    <packaging>pom</packaging>
 
-	<build>
-		<plugins>
-			<plugin>
-				<artifactId>maven-compiler-plugin</artifactId>
-				<version>2.5.1</version>
-				<executions>
-					<execution>
-						<id>default-compile</id>
-						<phase>compile</phase>
-						<goals>
-							<goal>compile</goal>
-						</goals>
-						<configuration>
-							<source>1.8</source>
-							<target>1.8</target>
-							<showWarnings>true</showWarnings>
-							<compilerArgs>
-								<arg>-parameters</arg>
-								<arg>-Xlint:deprecation</arg>
-							</compilerArgs>
-						</configuration>
-					</execution>
-					<execution>
-						<id>default-testCompile</id>
-						<phase>test-compile</phase>
-						<goals>
-							<goal>testCompile</goal>
-						</goals>
-						<configuration>
-							<source>1.8</source>
-							<target>1.8</target>
-							<showWarnings>true</showWarnings>
-							<compilerArgs>
-								<arg>-parameters</arg>
-								<arg>-Xlint:deprecation</arg>
-							</compilerArgs>
-						</configuration>
-					</execution>
-				</executions>
-				<configuration>
-					<source>1.8</source>
-					<target>1.8</target>
-					<showWarnings>true</showWarnings>
-					<compilerArgs>
-						<arg>-parameters</arg>
-						<arg>-Xlint:deprecation</arg>
-					</compilerArgs>
-				</configuration>
-			</plugin>
-			<plugin>
-		        <groupId>org.codehaus.gmaven</groupId>
-		        <artifactId>groovy-maven-plugin</artifactId>
-		        <version>2.0</version>
-		        <executions>
-		          <!-- set absolute base path from super pom -->
-		          <execution>
-		            <id>find-basepath</id>
-		            <phase>validate</phase>
-		            <goals>
-		              <goal>execute</goal>
-		            </goals>
-		            <configuration>
-		              <source>
-		                <![CDATA[
-		                    import java.io.File;
-		                    log.info('## define projects super pom absolute path through basepath_marker')
-		                    String p = "basepath_marker";
-		                    File f = null;
-		                    if( p != null ) {
-		                        def _max_child_poms = 0
-		                        while( _max_child_poms++ < 5 ) {
-		                            f = new File( p );
-		                            if( f.exists() ) {
-		                                break;
-		                            }   
-		                            p = "../" + p;
-		                        }
-		                    }
-		                    if( f != null ) {
-		                        String basePath = f.getCanonicalPath();
-		                        basePath = basePath.substring( 0, basePath.lastIndexOf( File.separator ) ); 
-		                        project.properties['base-path'] = basePath.replace( '\\' , '/');
-		                        log.info(' - used base path = ' + project.properties['base-path'] );
-		                    } else {
-		                        log.error( 'Could not find basepath_marker marker file!' );
-		                        System.stop( 0 );
-		                    }
-		                ]]>
-		              </source>
-		            </configuration>
-		          </execution>
-		        </executions>
-		      </plugin>
-		      <plugin>
-		        <groupId>net.revelc.code.formatter</groupId>
-		        <artifactId>formatter-maven-plugin</artifactId>
-		        <version>2.9.0</version>
-		        <executions>
-		          <execution>
-		            <id>format-java</id>
-		            <goals>
-		              <goal>format</goal>
-		            </goals>
-		            <configuration>
-		              <skip>${format.skipExecute}</skip>
-		              <configFile>${base-path}/project-configs/code-tools/onap-eclipse-format.xml</configFile>
-		            </configuration>
-		          </execution>
-		          <execution>
-		            <id>format-xml</id>
-		            <goals>
-		              <goal>format</goal>
-		            </goals>
-		            <configuration>
-		              <skip>${format.skipExecute}</skip>
-		              <sourceDirectory>${project.basedir}</sourceDirectory>
-		              <configXmlFile>${base-path}/project-configs/code-tools/pom-format.properties</configXmlFile>
-		              <includes>
-		                <include>${project.basedir}/pom.xml</include>
-		              </includes>
-		            </configuration>
-		          </execution>
-		          <execution>
-		            <id>validate-java</id>
-		            <goals>
-		              <goal>validate</goal>
-		            </goals>
-		            <configuration>
-		              <skip>${format.skipValidate}</skip>
-		              <configFile>${base-path}/project-configs/code-tools/onap-eclipse-format.xml</configFile>
-		            </configuration>
-		          </execution>
-		          <execution>
-		            <id>validate-poms</id>
-		            <goals>
-		              <goal>validate</goal>
-		            </goals>
-		            <configuration>
-		              <skip>${format.skipValidate}</skip>
-		              <configFile>${base-path}/project-configs/code-tools/pom-format.properties</configFile>
-		               <includes>
-		                <include>${project.basedir}/pom.xml</include>
-		              </includes>
-		            </configuration>
-		          </execution>
-		        </executions>
-		        <dependencies>
-		          <dependency>
-		            <groupId>com.fasterxml.jackson.core</groupId>
-		            <artifactId>jackson-annotations</artifactId>
-		            <version>2.9.8</version>
-		          </dependency>
-		        </dependencies>
-      		</plugin>
-		</plugins>
-	</build>
-	<profiles>
-		<profile>
-	      <id>format</id>
-	      <properties>
-	        <format.skipValidate>true</format.skipValidate>
-	        <format.skipExecute>false</format.skipExecute>
-	      </properties>
-	    </profile>
-	</profiles>
+    <modules>
+        <module>logging-filter-base</module>
+        <module>logging-filter-spring</module>
+    </modules>
+
+    <properties>
+        <format.skipValidate>false</format.skipValidate>
+        <format.skipExecute>true</format.skipExecute>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    </properties>
+
+    <dependencyManagement>
+        <dependencies>
+            <dependency>
+                <groupId>javax.annotation</groupId>
+                <artifactId>javax.annotation-api</artifactId>
+                <version>1.2</version>
+                <scope>provided</scope>
+            </dependency>
+            <dependency>
+                <groupId>org.onap.logging-analytics</groupId>
+                <artifactId>logging-slf4j</artifactId>
+                <version>1.5.0-SNAPSHOT</version>
+            </dependency>
+            <dependency>
+                <groupId>javax.servlet</groupId>
+                <artifactId>javax.servlet-api</artifactId>
+                <version>3.1.0</version>
+                <scope>provided</scope>
+            </dependency>
+            <dependency>
+                <groupId>javax.ws.rs</groupId>
+                <artifactId>javax.ws.rs-api</artifactId>
+                <version>2.0.1</version>
+                <scope>provided</scope>
+            </dependency>
+            <dependency>
+                <groupId>org.slf4j</groupId>
+                <artifactId>slf4j-api</artifactId>
+                <version>1.7.25</version>
+                <scope>provided</scope>
+            </dependency>
+            <dependency>
+                <groupId>org.apache.logging.log4j</groupId>
+                <artifactId>log4j-slf4j-impl</artifactId>
+                <version>2.11.2</version>
+                <scope>test</scope>
+            </dependency>
+            <dependency>
+                <groupId>junit</groupId>
+                <artifactId>junit</artifactId>
+                <version>4.11</version>
+                <scope>test</scope>
+            </dependency>
+            <dependency>
+                <groupId>org.mockito</groupId>
+                <artifactId>mockito-core</artifactId>
+                <version>2.15.0</version>
+                <scope>test</scope>
+            </dependency>
+        </dependencies>
+    </dependencyManagement>
+
+    <build>
+        <plugins>
+            <plugin>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <version>2.5.1</version>
+                <executions>
+                    <execution>
+                        <id>default-compile</id>
+                        <phase>compile</phase>
+                        <goals>
+                            <goal>compile</goal>
+                        </goals>
+                    </execution>
+                    <execution>
+                        <id>default-testCompile</id>
+                        <phase>test-compile</phase>
+                        <goals>
+                            <goal>testCompile</goal>
+                        </goals>
+                    </execution>
+                </executions>
+                <configuration>
+                    <source>1.8</source>
+                    <target>1.8</target>
+                    <showWarnings>true</showWarnings>
+                    <compilerArgument>-parameters</compilerArgument>
+                    <compilerArgument>-Xlint:deprecation</compilerArgument>
+                </configuration>
+            </plugin>
+
+            <!-- Plugin to identify root path of the project -->
+            <plugin>
+                <groupId>org.commonjava.maven.plugins</groupId>
+                <artifactId>directory-maven-plugin</artifactId>
+                <version>0.2</version>
+                <executions>
+                    <execution>
+                        <phase>validate</phase>
+                        <id>directories</id>
+                        <goals>
+                            <goal>execution-root</goal>
+                        </goals>
+                        <configuration>
+                            <property>baseDirPath</property>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+
+            <!-- Plugin to Generate/Validate Copyright License header -->
+            <!--
+            <plugin>
+                <groupId>org.codehaus.mojo</groupId>
+                <artifactId>license-maven-plugin</artifactId>
+                <version>1.20</version>
+                <configuration>
+                    <processStartTag>============LICENSE_START=======================================================</processStartTag>
+                    <sectionDelimiter>================================================================================</sectionDelimiter>
+                    <processEndTag>============LICENSE_END=========================================================</processEndTag>
+
+                    <licenseName>apache_v2</licenseName>
+                    <inceptionYear>2019</inceptionYear>
+                    <organizationName>AT&amp;T Intellectual Property. All rights reserved.</organizationName>
+                    <projectName>ONAP - Logging</projectName>
+
+                    <addJavaLicenseAfterPackage>false</addJavaLicenseAfterPackage>
+                    <skipUpdateLicense>${format.skipExecute}</skipUpdateLicense>
+                    <skipCheckLicense>${format.skipValidate}</skipCheckLicense>
+                </configuration>
+                <executions>
+                    <execution>
+                        <id>update-headers</id>
+                        <goals>
+                            <goal>update-file-header</goal>
+                        </goals>
+                        <phase>process-sources</phase>
+                        <configuration>
+                            <canUpdateCopyright>true</canUpdateCopyright>
+                            <canUpdateDescription>true</canUpdateDescription>
+                            <canUpdateLicense>true</canUpdateLicense>
+                            <emptyLineAfterHeader>true</emptyLineAfterHeader>
+                        </configuration>
+                    </execution>
+                    <execution>
+                        <id>check-headers</id>
+                        <goals>
+                            <goal>check-file-header</goal>
+                        </goals>
+                        <phase>validate</phase>
+                        <configuration>
+                            <failOnNotUptodateHeader>true</failOnNotUptodateHeader>
+                            <failOnMissingHeader>true</failOnMissingHeader>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+            -->
+
+            <!-- Plugin to Format/Validate Java Classes -->
+            <plugin>
+                <groupId>net.revelc.code.formatter</groupId>
+                <artifactId>formatter-maven-plugin</artifactId>
+                <version>2.10.0</version>
+                <executions>
+                    <execution>
+                        <id>format-java</id>
+                        <goals>
+                            <goal>format</goal>
+                        </goals>
+                        <phase>process-sources</phase>
+                        <configuration>
+                            <lineEnding>LF</lineEnding>
+                            <skip>${format.skipExecute}</skip>
+                            <sourceDirectory>${project.basedir}</sourceDirectory>
+                            <configFile>${baseDirPath}/project-configs/code-tools/onap-java-format.xml</configFile>
+                            <includes>
+                                <include>src/**/*.java</include>
+                            </includes>
+                        </configuration>
+                    </execution>
+                    <execution>
+                        <id>validate-java</id>
+                        <goals>
+                            <goal>validate</goal>
+                        </goals>
+                        <phase>validate</phase>
+                        <configuration>
+                            <lineEnding>LF</lineEnding>
+                            <skip>${format.skipValidate}</skip>
+                            <sourceDirectory>${project.basedir}</sourceDirectory>
+                            <configFile>${baseDirPath}/project-configs/code-tools/onap-java-format.xml</configFile>
+                            <includes>
+                                <include>src/**/*.java</include>
+                            </includes>
+                        </configuration>
+                    </execution>
+                </executions>
+                <dependencies>
+                    <dependency>
+                        <groupId>com.fasterxml.jackson.core</groupId>
+                        <artifactId>jackson-annotations</artifactId>
+                        <version>2.9.8</version>
+                    </dependency>
+                </dependencies>
+            </plugin>
+
+            <!-- Plugin to Format/Validate POM Files -->
+            <plugin>
+                <groupId>org.codehaus.mojo</groupId>
+                <artifactId>tidy-maven-plugin</artifactId>
+                <version>1.1.0</version>
+                <executions>
+                    <execution>
+                        <id>format-pom</id>
+                        <phase>process-sources</phase>
+                        <goals>
+                            <goal>pom</goal>
+                        </goals>
+                        <configuration>
+                            <skip>${format.skipExecute}</skip>
+                        </configuration>
+                    </execution>
+                    <execution>
+                        <id>validate-pom</id>
+                        <phase>validate</phase>
+                        <goals>
+                            <goal>check</goal>
+                        </goals>
+                        <configuration>
+                            <skip>${format.skipValidate}</skip>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+
+    <profiles>
+        <profile>
+            <id>format</id>
+            <properties>
+                <format.skipValidate>true</format.skipValidate>
+                <format.skipExecute>false</format.skipExecute>
+            </properties>
+        </profile>
+    </profiles>
 </project>