From a0e0c7840f72392152a970d88a5a66d394c4a793 Mon Sep 17 00:00:00 2001
From: Pamela Dragosh <pdragosh@research.att.com>
Date: Fri, 28 Sep 2018 04:58:26 -0400
Subject: Set drools-pdp checkstyle config

Fixed last remaining checkstyle issues along with
setting the pom.xml to the correct path setting.

Fixed forbidden summary fragments, not allowed
to prepend summary with "This method returns"

Issue-ID: POLICY-1153
Change-Id: I267842080494132a7b5507731e14f027a3f6fe44
Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
---
 feature-healthcheck/checkstyle-suppressions.xml    | 30 ++++++++++++++++++
 feature-healthcheck/pom.xml                        | 36 ++++++++++++++++++++++
 .../drools/healthcheck/AafHealthCheckFilter.java   |  2 +-
 .../policy/drools/healthcheck/HealthCheck.java     | 10 +++---
 .../policy/drools/healthcheck/RestHealthCheck.java |  2 +-
 .../healthcheck/TestAafHealthCheckFilter.java      |  2 +-
 6 files changed, 74 insertions(+), 8 deletions(-)
 create mode 100644 feature-healthcheck/checkstyle-suppressions.xml

(limited to 'feature-healthcheck')

diff --git a/feature-healthcheck/checkstyle-suppressions.xml b/feature-healthcheck/checkstyle-suppressions.xml
new file mode 100644
index 00000000..ed04d894
--- /dev/null
+++ b/feature-healthcheck/checkstyle-suppressions.xml
@@ -0,0 +1,30 @@
+<?xml version="1.0"?>
+<!--
+  ============LICENSE_START=======================================================
+   Copyright (C) 2018 AT&T Technologies. All rights reserved.
+  ================================================================================
+  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.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+  
+  SPDX-License-Identifier: Apache-2.0
+  ============LICENSE_END=========================================================
+-->
+
+<!DOCTYPE suppressions PUBLIC
+     "-//Puppy Crawl//DTD Suppressions 1.0//EN"
+     "http://www.puppycrawl.com/dtds/suppressions_1_0.dtd">
+ 
+<suppressions>
+  <suppress checks="OneTopLevelClass"
+    files="HealthCheck.java"
+    lines="1-9999"/>
+</suppressions>
diff --git a/feature-healthcheck/pom.xml b/feature-healthcheck/pom.xml
index 1acfb2d1..3ed46abc 100644
--- a/feature-healthcheck/pom.xml
+++ b/feature-healthcheck/pom.xml
@@ -86,6 +86,42 @@
           </execution>
         </executions>
       </plugin>
+          <plugin>
+              <artifactId>maven-checkstyle-plugin</artifactId>
+              <executions>
+                  <execution>
+                      <id>onap-java-style</id>
+                      <goals>
+                          <goal>check</goal>
+                      </goals>
+                      <phase>process-sources</phase>
+                      <configuration>
+                          <!-- Use Google Java Style Guide: https://github.com/checkstyle/checkstyle/blob/master/src/main/resources/google_checks.xml 
+                              with minor changes -->
+                          <configLocation>onap-checkstyle/onap-java-style.xml</configLocation>
+                          <!-- <sourceDirectory> is needed so that checkstyle ignores the generated sources directory -->
+                          <sourceDirectory>${project.build.sourceDirectory}</sourceDirectory>
+                          <includeResources>true</includeResources>
+                          <includeTestSourceDirectory>true</includeTestSourceDirectory>
+                          <includeTestResources>true</includeTestResources>
+                          <excludes>
+                          </excludes>
+                          <suppressionsLocation>${project.baseUri}checkstyle-suppressions.xml</suppressionsLocation>
+                          <consoleOutput>true</consoleOutput>
+                          <failsOnViolation>true</failsOnViolation>
+                          <violationSeverity>warning</violationSeverity>
+                      </configuration>
+                  </execution>
+              </executions>
+              <dependencies>
+                  <dependency>
+                      <groupId>org.onap.oparent</groupId>
+                      <artifactId>checkstyle</artifactId>
+                      <version>${oparent.version}</version>
+                      <scope>compile</scope>
+                  </dependency>
+              </dependencies>
+          </plugin>
     </plugins>
   </build>
 
diff --git a/feature-healthcheck/src/main/java/org/onap/policy/drools/healthcheck/AafHealthCheckFilter.java b/feature-healthcheck/src/main/java/org/onap/policy/drools/healthcheck/AafHealthCheckFilter.java
index 3cb9def6..47a617b3 100644
--- a/feature-healthcheck/src/main/java/org/onap/policy/drools/healthcheck/AafHealthCheckFilter.java
+++ b/feature-healthcheck/src/main/java/org/onap/policy/drools/healthcheck/AafHealthCheckFilter.java
@@ -24,7 +24,7 @@ import org.onap.policy.common.endpoints.http.server.aaf.AafGranularAuthFilter;
 import org.onap.policy.drools.server.restful.aaf.AafBase;
 
 /**
- * Healthcheck AAF Authorization Filter
+ * Healthcheck AAF Authorization Filter.
  */
 public class AafHealthCheckFilter extends AafGranularAuthFilter {
 
diff --git a/feature-healthcheck/src/main/java/org/onap/policy/drools/healthcheck/HealthCheck.java b/feature-healthcheck/src/main/java/org/onap/policy/drools/healthcheck/HealthCheck.java
index d35b7371..40e4f354 100644
--- a/feature-healthcheck/src/main/java/org/onap/policy/drools/healthcheck/HealthCheck.java
+++ b/feature-healthcheck/src/main/java/org/onap/policy/drools/healthcheck/HealthCheck.java
@@ -201,7 +201,7 @@ class HealthCheckMonitor implements HealthCheck {
     protected volatile Properties healthCheckProperties = null;
 
     /**
-     * {@inheritDoc}
+     * {@inheritDoc}.
      */
     @Override
     public Reports healthCheck() {
@@ -242,7 +242,7 @@ class HealthCheckMonitor implements HealthCheck {
     }
 
     /**
-     * {@inheritDoc}
+     * {@inheritDoc}.
      */
     @Override
     public boolean start() {
@@ -265,7 +265,7 @@ class HealthCheckMonitor implements HealthCheck {
     }
 
     /**
-     * {@inheritDoc}
+     * {@inheritDoc}.
      */
     @Override
     public boolean stop() {
@@ -290,7 +290,7 @@ class HealthCheckMonitor implements HealthCheck {
     }
 
     /**
-     * {@inheritDoc}
+     * {@inheritDoc}.
      */
     @Override
     public void shutdown() {
@@ -298,7 +298,7 @@ class HealthCheckMonitor implements HealthCheck {
     }
 
     /**
-     * {@inheritDoc}
+     * {@inheritDoc}.
      */
     @Override
     public synchronized boolean isAlive() {
diff --git a/feature-healthcheck/src/main/java/org/onap/policy/drools/healthcheck/RestHealthCheck.java b/feature-healthcheck/src/main/java/org/onap/policy/drools/healthcheck/RestHealthCheck.java
index 734a75e0..5047cb26 100644
--- a/feature-healthcheck/src/main/java/org/onap/policy/drools/healthcheck/RestHealthCheck.java
+++ b/feature-healthcheck/src/main/java/org/onap/policy/drools/healthcheck/RestHealthCheck.java
@@ -49,7 +49,7 @@ import org.onap.policy.drools.healthcheck.HealthCheck.Reports;
     tags = {
         @Tag(name = "pdp-d-healthcheck", description = "Drools PDP Healthcheck Operations")
     }
-)
+    )
 public class RestHealthCheck {
 
     @GET
diff --git a/feature-healthcheck/src/test/java/org/onap/policy/drools/healthcheck/TestAafHealthCheckFilter.java b/feature-healthcheck/src/test/java/org/onap/policy/drools/healthcheck/TestAafHealthCheckFilter.java
index 03ca6897..9c34670c 100644
--- a/feature-healthcheck/src/test/java/org/onap/policy/drools/healthcheck/TestAafHealthCheckFilter.java
+++ b/feature-healthcheck/src/test/java/org/onap/policy/drools/healthcheck/TestAafHealthCheckFilter.java
@@ -24,7 +24,7 @@ import javax.servlet.http.HttpServletRequest;
 import org.onap.policy.common.utils.network.NetworkUtil;
 
 /**
- * Healthcheck AAF Authorization Filter
+ * Healthcheck AAF Authorization Filter.
  */
 public class TestAafHealthCheckFilter extends AafHealthCheckFilter {
 
-- 
cgit 1.2.3-korg