Merge pull request #44 from BorderTech/overrides

Property overrides

Author: jonathanaustin

.travis.yml

@@ -1,11 +1,23 @@
+dist: trusty
+
+cache:
+  directories:
+  - $HOME/.m2
+
+addons:
+  sonarcloud:
+    organization: "bordertech-github"
+    token:
+        secure: $SONAR_TOKEN
+
 before_install:
 - echo "MAVEN_OPTS='-Xmx512m -XX:MaxPermSize=128m'" > ~/.mavenrc
 - mvn clean
 
 language: Java
 jdk:
-  - oraclejdk8
+ - oraclejdk8
 
 ## Travis installs the project with the following maven command:- "mvn install -DskipTests=true -Dmaven.javadoc.skip=true -B -V"
 script:
- - mvn test
+ - mvn package sonar:sonar -Dsonar.projectKey="bordertech-java-common"

README.md

@@ -3,8 +3,9 @@
 Reusable build configuration for for BorderTech open source projects.
 
 ## Status
-
 [![Build Status](https://travis-ci.com/BorderTech/java-common.svg?branch=master)](https://travis-ci.com/BorderTech/java-common)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=bordertech-java-common&metric=alert_status)](https://sonarcloud.io/dashboard?id=bordertech-java-common)
+[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=bordertech-java-common&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=bordertech-java-common)
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/c7a2226acd574943af9ae966c54b05e6)](https://app.codacy.com/app/BorderTech/java-common?utm_source=github.com&utm_medium=referral&utm_content=BorderTech/java-common&utm_campaign=Badge_Grade_Dashboard)
 [![Maven Central](https://img.shields.io/maven-central/v/com.github.bordertech.common/bordertech-parent.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22com.github.bordertech.common%22%20AND%20a:%22bordertech-parent%22)
 
@@ -54,3 +55,194 @@ Full documentation is available in the wiki under [Releasing](https://github.com
 ## build-tools
 
 This is primarily a shared resources module used by qa-parent and potentially other BorderTech maven modules.
+
+## qa-parent overrides
+
+### Enable Static Analysis
+
+By default qa checks do not run, you must enable them on a per-module basis.
+
+``` xml
+<property>
+	<bt.qa.skip>false</bt.qa.skip>
+</property>
+```
+
+### Checkstyle
+
+Refer to [Checkstyle plugin](https://maven.apache.org/plugins/maven-checkstyle-plugin/checkstyle-mojo.html) for all override details.
+
+#### Skip Checkstyle
+
+``` xml
+<property>
+	<checkstyle.skip>true</checkstyle.skip>
+</property>
+```
+
+#### Change or Add Checkstyle Rules
+
+The checkstyle config defaults to `bordertech/bt-checkstyle.xml`. This config is based on `sun-checks.xml` provided by checkstyle.
+
+To add or change a checkstyle rule you are required to create your own [config.xml](http://checkstyle.sourceforge.net/config.html) file and set the `checkstyle.config.location` property.
+
+``` xml
+<property>
+	<checkstyle.config.location>${basedir}/my-checkstyle-config.xml</checkstyle.config.location>
+</property>
+```
+
+#### Ignore Checkstyle Rule
+
+Create a [suppression](http://checkstyle.sourceforge.net/config_filters.html) file add set the `checkstyle.suppressions.location` property.
+
+``` xml
+<property>
+	<checkstyle.suppressions.location>${basedir}/my-suppression.xml</checkstyle.suppressions.location>
+</property>
+```
+
+Example suppression file:-
+``` xml
+<?xml version="1.0"?>
+<!DOCTYPE suppressions PUBLIC "-//Puppy Crawl//DTD Suppressions 1.0//EN" "http://www.puppycrawl.com/dtds/suppressions_1_0.dtd">
+<suppressions>
+	<!-- Ignores for all files -->
+	<suppress checks="NPathComplexity" files="."/>
+</suppressions>
+```
+
+### PMD and CPD
+
+Refer to [PMD plugin](https://maven.apache.org/plugins/maven-pmd-plugin/) for all override details.
+
+#### Skip PMD and CPD
+
+``` xml
+<property>
+	<pmd.skip>true</pmd.skip>
+	<cpd.skip>true</cpd.skip>
+</property>
+```
+
+#### Change PMD Rule Set
+
+The default rule set is `bordertech/bt-pmd-rules.xml`.
+
+You can override the default by creating your own custom [rule set](https://pmd.github.io/latest/pmd_userdocs_making_rulesets.html) and set the `bt.pmd.rules.file` property.
+
+``` xml
+<property>
+	<bt.pmd.rules.file>${basedir}/my-rules.xml</bt.pmd.rules.file>
+</property>
+```
+
+#### Add extra PMD Rule set
+
+An extra [rule set](https://pmd.github.io/latest/pmd_userdocs_making_rulesets.html) can be added via the plugin `rulesets` configuration.
+
+``` xml
+<plugin>
+	...
+	<configuration>
+		<rulesets>
+			<ruleset>${bt.pmd.rules.file}</ruleset>
+			<ruleset>${basedir}/my-rules.xml</ruleset>
+		</rulesets>
+	</configuration>
+	...
+</plugin>
+```
+
+#### Ignore PMD Rule
+
+Create an [excludes](https://pmd.github.io/latest/pmd_userdocs_suppressing_warnings.html#xpath-and-regex-message-suppression) file that lists classes and rules to be excluded from failures and set the `pmd.excludeFromFailureFile` property.
+
+``` xml
+<property>
+	<pmd.excludeFromFailureFile>${basedir}/my-pmd-excludes.properties</pmd.excludeFromFailureFile>
+</property>
+```
+
+Example properties file:
+
+``` java
+com.my.example.MyClass=LoggerIsNotStaticFinal
+```
+
+### Spotbugs
+
+Refer to [spotbugs plugin](https://spotbugs.github.io/spotbugs-maven-plugin/spotbugs-mojo.html) or [doco](https://spotbugs.readthedocs.io/en/latest/index.html) for all override details.
+
+#### Skip spotbugs
+
+``` xml
+<property>
+	<spotbugs.skip>true</spotbugs.skip>
+</property>
+```
+
+#### Ignore Spotbugs Rule
+
+Create a [filter](https://spotbugs.readthedocs.io/en/latest/filter.html) file and set `spotbugs.excludeFilterFile` property.
+
+``` xml
+<property>
+	<!-- List of exclude filter files -->
+	<spotbugs.excludeFilterFile>${basedir}/my-spotbugs-exclude-file.xml</spotbugs.excludeFilterFile>
+</property>
+```
+
+Example filter file:-
+
+``` xml
+<?xml version="1.0" encoding="UTF-8"?>
+<FindBugsFilter>
+	<!-- False Positive on Loading Property Filenames -->
+	<Match>
+		<Bug pattern="PATH_TRAVERSAL_IN" />
+	</Match>
+</FindBugsFilter>
+```
+
+### OWASP
+
+Refer to [OWASP plugin](https://jeremylong.github.io/DependencyCheck/dependency-check-maven/index.html) for all override details.
+
+#### Skip OWASP
+
+``` xml
+<property>
+	<dependency-check.skip>true</dependency-check.skip>
+</property>
+```
+
+#### Ignore OWASP Rule
+
+Create a [suppression](https://jeremylong.github.io/DependencyCheck/general/suppression.html) file add set the `suppression.file` property.
+
+``` xml
+<property>
+	<suppression.file>${basedir}/my-owasp-suppressions.xml</suppression.file>
+</property>
+```
+
+### Enforcer Plugin
+
+Refer to [enforcer plugin](https://maven.apache.org/enforcer/maven-enforcer-plugin/enforce-mojo.html) for all override details.
+
+#### Skip enforcer
+
+``` xml
+<property>
+	<enforcer.skip>true</enforcer.skip>
+</property>
+```
+
+#### Report issues but dont fail
+
+``` xml
+<property>
+	<enforcer.fail>false</enforcer.fail>
+</property>
+```