From 671f926883758a5a2e24bbc1191645bbfd95e909 Mon Sep 17 00:00:00 2001
From: Wouter Born <github@maindrain.net>
Date: Thu, 14 Mar 2019 20:20:40 +0100
Subject: [PATCH] Resolve SAT errors (#36)

Signed-off-by: Wouter Born <github@maindrain.net>
---
 org.openhab.ui.dashboard/pom.xml              |  4 +--
 org.openhab.ui.habot/build.properties         | 15 ----------
 org.openhab.ui.paper/build.properties         | 20 -------------
 tools/checkstyle_suppressions.xml             | 29 -------------------
 .../checkstyle/ruleset.properties}            |  6 ++--
 .../checkstyle/suppressions.xml               | 16 ++++++++++
 .../pmd/suppressions.properties               |  0
 .../spotbugs/suppressions.xml                 | 29 +++++++++++++++++++
 8 files changed, 50 insertions(+), 69 deletions(-)
 delete mode 100644 org.openhab.ui.habot/build.properties
 delete mode 100644 org.openhab.ui.paper/build.properties
 delete mode 100644 tools/checkstyle_suppressions.xml
 rename tools/{checkstyle.properties => static-code-analysis/checkstyle/ruleset.properties} (89%)
 create mode 100644 tools/static-code-analysis/checkstyle/suppressions.xml
 create mode 100644 tools/static-code-analysis/pmd/suppressions.properties
 create mode 100644 tools/static-code-analysis/spotbugs/suppressions.xml

diff --git a/org.openhab.ui.dashboard/pom.xml b/org.openhab.ui.dashboard/pom.xml
index ea3ffc6d4..27aea76ef 100644
--- a/org.openhab.ui.dashboard/pom.xml
+++ b/org.openhab.ui.dashboard/pom.xml
@@ -3,8 +3,8 @@
   <modelVersion>4.0.0</modelVersion>
 
   <parent>
-    <groupId>org.openhab.core.bundles</groupId>
-    <artifactId>org.openhab.core.reactor.bundles</artifactId>
+    <groupId>org.openhab.ui</groupId>
+    <artifactId>pom</artifactId>
     <version>2.5.0-SNAPSHOT</version>
   </parent>
 
diff --git a/org.openhab.ui.habot/build.properties b/org.openhab.ui.habot/build.properties
deleted file mode 100644
index c71384b8b..000000000
--- a/org.openhab.ui.habot/build.properties
+++ /dev/null
@@ -1,15 +0,0 @@
-bin.includes = META-INF/,\
-               .,\
-               NOTICE,\
-               ESH-INF/,\
-               OSGI-INF/,\
-               lib/,\
-               lib/opennlp-tools-1.8.3.jar,\
-               lib/bcprov-jdk15on-154.jar,\
-               lib/jose4j-0.6.3.jar,\
-               web/dist/pwa-mat/
-output = target/classes/
-source.. = src/main/java/,\
-           src/main/resources/
-src.excludes = src/test/java/\
-           src/test/resources/
diff --git a/org.openhab.ui.paper/build.properties b/org.openhab.ui.paper/build.properties
deleted file mode 100644
index bea70070e..000000000
--- a/org.openhab.ui.paper/build.properties
+++ /dev/null
@@ -1,20 +0,0 @@
-output.. = target/classes/
-bin.includes = META-INF/,\
-               .,\
-               OSGI-INF/,\
-               NOTICE,\
-               web/css/,\
-               web/fonts/,\
-               web/img/,\
-               web/index.html,\
-               web/js/,\
-               web/partials/
-source.. = src/main/java/
-bin.excludes = web/fonts/Roboto-Thin.woff,\
-               web/fonts/Roboto-ThinItalic.woff,\
-               web/fonts/Roboto-RegularItalic.woff,\
-               web/fonts/Roboto-MediumItalic.woff,\
-               web/fonts/Roboto-LightItalic.woff,\
-               web/fonts/Roboto-BoldItalic.woff,\
-               web/fonts/Roboto-BlackItalic.woff,\
-               web/fonts/Roboto-Black.woff
diff --git a/tools/checkstyle_suppressions.xml b/tools/checkstyle_suppressions.xml
deleted file mode 100644
index 2ffb023b8..000000000
--- a/tools/checkstyle_suppressions.xml
+++ /dev/null
@@ -1,29 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE suppressions PUBLIC "-//Puppy Crawl//DTD Suppressions 1.1//EN" "http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
-<suppressions>
-    <suppress files="build.properties" checks="AboutHtmlCheck" />
-    <!-- These suppressions define which files to be suppressed for which checks. -->
-    <suppress files=".+[\\/]internal[\\/].+\.java" checks="JavadocType|JavadocVariable|JavadocMethod|JavadocFilterCheck"/>
-    <suppress files=".+DTO\.java" checks="JavadocType|JavadocVariable|JavadocMethod|JavadocFilterCheck" />
-    <suppress files=".+Impl\.java" checks="JavadocType|JavadocVariable|JavadocMethod|JavadocFilterCheck"/>
-
-    <!-- The WiFi led binding contains test packages that shouldn't be included in the binary build -->
-    <!-- The CometVisu UI contains files in the resources folder that are used only during the build -->
-    <suppress files=".+org.openhab.binding.wifiled.+|.+org.openhab.ui.cometvisu.+" checks="BuildPropertiesCheck"/>
-    <!-- Homematic and Tellstick bindings are creating and configuring things dynamically, they will log false positives for unused configuration -->
-    <!-- IO and Voice bundles have specific use cases - they use only the config .xml files and will log false positives as well -->
-    <suppress files=".+org.openhab.binding.homematic.+|.+org.openhab.binding.tellstick.+|.+org.openhab.io.+|.+org.openhab.voice.+" checks="EshInfXmlCheck"/>
-    <!-- All generated files will skip the author tag check -->
-    <suppress files=".+[\\/]gen[\\/].+\.java" checks="AuthorTagCheck"/>
-    <!-- Some checks will be supressed for test bundles -->
-    <suppress files=".+.test[\\/].+" checks="RequireBundleCheck"/>
-    <!--  There is a single class inside org.openhab.voice.voicerss.tool, which is meant to be called from the command line.
-    Moving it to "internal" is also not ideal as it is a documented tool. -->
-    <suppress files=".+org.openhab.voice.voicerss.+" checks="PackageExportsNameCheck"/>
-    <!--  Allow the usage of scheduleAtFixedRate in FadingWiFiLEDDriver class  -->
-    <suppress files=".+org.openhab.binding.wifiled.handler.FadingWiFiLEDDriver.java" checks="AvoidScheduleAtFixedRateCheck"/>
-    <suppress files=".+[\\/]pom\.xml" checks="OnlyTabIndentationInXmlFilesCheck"/>
-    <suppress files=".+[\\/]OSGI-INF[\\/]org.openhab.+\.xml" checks="OnlyTabIndentationInXmlFilesCheck|NewlineAtEndOfFileCheck"/>
-    <suppress files=".+org.openhab.binding.yeelight.+" checks="OutsideOfLibExternalLibrariesCheck" />
-    <suppress files=".+org.openhab.ui.paper.+" checks="OutsideOfLibExternalLibrariesCheck|ManifestExternalLibrariesCheck|BuildPropertiesExternalLibrariesCheck" />
-</suppressions>
diff --git a/tools/checkstyle.properties b/tools/static-code-analysis/checkstyle/ruleset.properties
similarity index 89%
rename from tools/checkstyle.properties
rename to tools/static-code-analysis/checkstyle/ruleset.properties
index 8aab41c93..41e0dc233 100644
--- a/tools/checkstyle.properties
+++ b/tools/static-code-analysis/checkstyle/ruleset.properties
@@ -1,6 +1,6 @@
+checkstyle.forbiddenPackageUsageCheck.exceptions=
+checkstyle.forbiddenPackageUsageCheck.forbiddenPackages=com.google.common
 checkstyle.headerCheck.content=^/\\*\\*$\\n^ \\* Copyright \\(c\\) {0}-{1} Contributors to the openHAB project$\\n^ \\*$\\n^ \\* See the NOTICE file\\(s\\) distributed with this work for additional$\\n^ \\* information.$\\n^ \\*$\\n^ \\* This program and the accompanying materials are made available under the$\\n^ \\* terms of the Eclipse Public License 2\\.0 which is available at$\\n^ \\* http://www.eclipse.org/legal/epl\\-2\\.0$\\n^ \\*$\\n^ \\* SPDX-License-Identifier: EPL-2.0$
 checkstyle.headerCheck.values=2010,2019
 checkstyle.pomXmlCheck.currentVersionRegex=^2\.5\.0
-checkstyle.forbiddenPackageUsageCheck.forbiddenPackages=com.google.common
-checkstyle.forbiddenPackageUsageCheck.exceptions=
-checkstyle.requiredFilesCheck.files=build.properties,pom.xml,META-INF/MANIFEST.MF
+checkstyle.requiredFilesCheck.files=pom.xml
diff --git a/tools/static-code-analysis/checkstyle/suppressions.xml b/tools/static-code-analysis/checkstyle/suppressions.xml
new file mode 100644
index 000000000..3d99ecd0a
--- /dev/null
+++ b/tools/static-code-analysis/checkstyle/suppressions.xml
@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE suppressions PUBLIC "-//Puppy Crawl//DTD Suppressions 1.1//EN" "http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
+<suppressions>
+    <suppress files="build.properties" checks="AboutHtmlCheck" />
+    <!-- These suppressions define which files to be suppressed for which checks. -->
+    <suppress files=".+[\\/]pom\.xml" checks="OnlyTabIndentationCheck"/>
+    <suppress files=".+[\\/]gen[\\/].+\.java" checks="AuthorTagCheck"/>
+    <suppress files=".+[\\/]internal[\\/].+\.java" checks="JavadocType|JavadocVariable|JavadocMethod|JavadocFilterCheck"/>
+    <suppress files=".+Impl\.java" checks="JavadocType|JavadocVariable|JavadocMethod|JavadocFilterCheck"/>
+    <suppress files=".+.test[\\/].+" checks="RequireBundleCheck"/>
+
+    <!-- The CometVisu UI contains files in the resources folder that are used only during the build -->
+    <suppress files=".+org.openhab.ui.cometvisu.+" checks="BuildPropertiesCheck"/>
+
+    <suppress files=".+org.openhab.ui.paper.+" checks="OutsideOfLibExternalLibrariesCheck|ManifestExternalLibrariesCheck|BuildPropertiesExternalLibrariesCheck" />
+</suppressions>
diff --git a/tools/static-code-analysis/pmd/suppressions.properties b/tools/static-code-analysis/pmd/suppressions.properties
new file mode 100644
index 000000000..e69de29bb
diff --git a/tools/static-code-analysis/spotbugs/suppressions.xml b/tools/static-code-analysis/spotbugs/suppressions.xml
new file mode 100644
index 000000000..bb11da72a
--- /dev/null
+++ b/tools/static-code-analysis/spotbugs/suppressions.xml
@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<FindBugsFilter>
+  <!-- Excludes all bugs with priority higher than 4 -->
+  <Match>
+    <Rank value="4"/>
+    <Not>
+      <Bug pattern="SLF4J_LOGGER_SHOULD_BE_NON_STATIC"/>
+    </Not>
+  </Match>
+  <!-- This pattern is not wanted as it reports usage of Throwable.getMessage() as argument to SLF4G logger -->
+  <Match>
+    <Bug pattern="SLF4J_MANUALLY_PROVIDED_MESSAGE"/>
+  </Match>
+  <!-- Allow util classes to have static loggers -->
+  <Match>
+    <Class name="~.*Utils"/>
+    <Bug pattern="SLF4J_LOGGER_SHOULD_BE_NON_STATIC"/>
+  </Match>
+  <Match>
+    <Class name="~.*Util"/>
+    <Bug pattern="SLF4J_LOGGER_SHOULD_BE_NON_STATIC"/>
+  </Match>
+  <Match>
+    <Bug pattern="SLF4J_UNKNOWN_ARRAY"/>
+  </Match>
+  <Match>
+    <Bug pattern="SLF4J_SIGN_ONLY_FORMAT"/>
+  </Match>
+</FindBugsFilter>