Skip to content

Commit

Permalink
require -P lint (#131)
Browse files Browse the repository at this point in the history 
* require -P lint

Lets not burden customers with our development rules.
* Move Checkstyle, ErrorProne, PMD, and SpotBugs to only run w/ -P lint
* Update the Readme

* Fix comments
  • Loading branch information
@lesv
lesv committed Apr 16, 2020
1 parent 58bb9f7 commit b402174
Show file tree
Hide file tree
Showing 2 changed files with 179 additions and 154 deletions.
20 changes: 17 additions & 3 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,17 @@ organization.

## Using this repository

This package is meant to be used as a parent pom, so that [CheckStyle](https://github.com/checkstyle/checkstyle), [ErrorProne](http://errorprone.info/) and other plugins run against sample code. Please ensure that samples function without this parent definition. The parent should be used only to enforce style and other checks.
This package should be used as a parent `pom.xml`. It adds:
* [CheckStyle](https://github.com/checkstyle/checkstyle) Enforces the
[Google Java Style guide](https://google.github.io/styleguide/javaguide.html)
* [ErrorProne](http://errorprone.info/) Google written code analyzer
* [PMD](https://pmd.github.io/) A cross-language static code analyzer
* [SpotBugs](https://spotbugs.readthedocs.io/en/stable/) Find well know bug patterns with these
extensions:
* [Find Security Bugs](http://find-sec-bugs.github.io/) Security audits of Java Web Applications.
* [fb-contrib](http://fb-contrib.sourceforge.net/) Static code analysis on Java byte code.

Please ensure that samples function without this parent definition.

```xml
<!--
Expand All @@ -22,11 +32,15 @@ This package is meant to be used as a parent pom, so that [CheckStyle](https://g
<parent>
<groupId>com.google.cloud.samples</groupId>
<artifactId>shared-configuration</artifactId>
<version>1.0.12</version>
<version>1.0.17</version>
</parent>
```

You must also copy the files `google-checks.xml` and `suppressions.xml` to the same directory for the parent to work. We are working on [removing this requirement](https://github.com/GoogleCloudPlatform/java-repo-tools/issues/41).
## USAGE

```bash
mvn -P lint clean package verify
```

## Where is this used?

Expand Down
313 changes: 162 additions & 151 deletions pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ limitations under the License.
<javac.version>9+181-r4173-1</javac.version>

<maven-release-plugin>2.5.3</maven-release-plugin><!-- could be 3.0.0-M1 -->
<maven-compiler-plugin>3.8.1</maven-compiler-plugin>
<nexus-staging-maven-plugin>1.6.8</nexus-staging-maven-plugin>
<versions-maven-plugin>2.7</versions-maven-plugin>
<maven-gpg-plugin>1.6</maven-gpg-plugin>
Expand Down Expand Up @@ -151,6 +152,7 @@ limitations under the License.
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>${maven-compiler-plugin}</version>
<configuration>
<fork>true</fork>
<compilerArgs combine.children="append">
Expand All @@ -163,6 +165,166 @@ limitations under the License.
</plugins>
</build>
</profile>

<!-- only lint when we ask -->
<profile>
<id>lint</id>
<build>
<plugins>

<!-- Compile w/ ErrorProne (see https://errorprone.info) -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>${maven-compiler-plugin}</version>
<configuration>
<compilerArgs>
<arg>-XDcompilePolicy=simple</arg>
<arg>-Xplugin:ErrorProne</arg>
</compilerArgs>
<annotationProcessorPaths>
<path>
<groupId>com.google.errorprone</groupId>
<artifactId>error_prone_core</artifactId>
<version>2.3.4</version>
</path>
</annotationProcessorPaths>
</configuration>
</plugin>

<plugin><!-- SPOTBUGS -->
<groupId>com.github.spotbugs</groupId>
<artifactId>spotbugs-maven-plugin</artifactId>
<version>4.0.0</version>
<executions>
<execution>
<id>analyze-compile</id>
<phase>compile</phase>
<goals>
<goal>check</goal>
</goals>
</execution>
</executions>
<dependencies>
<dependency>
<groupId>com.github.spotbugs</groupId>
<artifactId>spotbugs</artifactId>
<version>4.0.1</version>
</dependency>
<dependency>
<groupId>com.google.cloud.samples</groupId>
<artifactId>checkstyle-configuration</artifactId>
<version>1.0.17-SNAPSHOT</version>
</dependency>
</dependencies>
<configuration>
<failOnError>false</failOnError><!-- Let's not fail for now -->
<effort>Max</effort>
<threshold>Low</threshold>
<includeTests>true</includeTests>
<fork>false</fork>
<excludeFilterFile>c.g.c.s/spotBugsExcludeFilter.xml</excludeFilterFile>
<plugins>
<plugin>
<groupId>com.h3xstream.findsecbugs</groupId>
<artifactId>findsecbugs-plugin</artifactId>
<version>1.10.1</version>
</plugin>
<plugin>
<groupId>com.mebigfatguy.sb-contrib</groupId>
<artifactId>sb-contrib</artifactId>
<version>7.4.7</version>
</plugin>
<!-- Great idea, but we need to have a single logging story before we do this -->
<!-- <plugin> https://github.com/KengoTODA/findbugs-slf4j -->
<!-- <groupId>jp.skypencil.findbugs.slf4j</groupId>-->
<!-- <artifactId>findbugs-slf4j</artifactId>-->
<!-- <version>1.5.0</version>-->
<!-- </plugin>-->
</plugins>
</configuration>
</plugin>

<plugin><!-- PMD -->
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-pmd-plugin</artifactId>
<version>3.13.0</version>
<dependencies>
<dependency>
<groupId>net.sourceforge.pmd</groupId>
<artifactId>pmd-core</artifactId>
<version>${pmdVersion}</version>
</dependency>
<dependency>
<groupId>net.sourceforge.pmd</groupId>
<artifactId>pmd-java</artifactId>
<version>${pmdVersion}</version>
</dependency>
<dependency>
<groupId>net.sourceforge.pmd</groupId>
<artifactId>pmd-java8</artifactId>
<version>${pmdVersion}</version>
</dependency>
</dependencies>
<configuration>
<failOnViolation>false</failOnViolation>
<printFailingErrors>true</printFailingErrors>
<skipEmptyReport>false</skipEmptyReport>
<linkXRef>false</linkXRef>
<targetJdk>${maven.compiler.source}</targetJdk>
</configuration>
<executions>
<execution>
<phase>compile</phase>
<goals>
<goal>check</goal>
<goal>cpd-check</goal>
</goals>
</execution>
</executions>
</plugin>

<plugin> <!-- Checkstyle -->
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
<version>3.1.1</version>
<configuration>
<configLocation>google-checks.xml</configLocation>
<suppressionsLocation>suppressions.xml</suppressionsLocation>
<headerLocation>LICENSE.txt</headerLocation>

<includeTestSourceDirectory>true</includeTestSourceDirectory>
<consoleOutput>true</consoleOutput>
<logViolationsToConsole>true</logViolationsToConsole>
<failOnViolation>true</failOnViolation>
</configuration>
<dependencies>
<!-- Add a dependency to use bundled resources.
See: http://stackoverflow.com/a/19690484/101923 -->
<dependency>
<groupId>com.google.cloud.samples</groupId>
<artifactId>checkstyle-configuration</artifactId>
<version>1.0.17-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>com.puppycrawl.tools</groupId>
<artifactId>checkstyle</artifactId>
<version>8.31</version>
</dependency>
</dependencies>
<executions>
<execution>
<phase>verify</phase>
<goals>
<goal>check</goal>
</goals>
</execution>
</executions>
</plugin>

</plugins>
</build>
</profile>
</profiles>

<dependencies>
Expand All @@ -176,26 +338,6 @@ limitations under the License.

<build>
<plugins>
<!-- Compile w/ ErrorProne (see https://errorprone.info) -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.8.1</version>
<configuration>
<compilerArgs>
<arg>-XDcompilePolicy=simple</arg>
<arg>-Xplugin:ErrorProne</arg>
</compilerArgs>
<annotationProcessorPaths>
<path>
<groupId>com.google.errorprone</groupId>
<artifactId>error_prone_core</artifactId>
<version>2.3.4</version>
</path>
</annotationProcessorPaths>
</configuration>
</plugin>

<plugin> <!-- Unit Tests -->
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
Expand Down Expand Up @@ -223,137 +365,6 @@ limitations under the License.
</configuration>
</plugin>

<plugin><!-- SPOTBUGS -->
<groupId>com.github.spotbugs</groupId>
<artifactId>spotbugs-maven-plugin</artifactId>
<version>4.0.0</version>
<executions>
<execution>
<id>analyze-compile</id>
<phase>compile</phase>
<goals>
<goal>check</goal>
</goals>
</execution>
</executions>
<dependencies>
<!-- overwrite dependency on spotbugs if you want to specify the version of spotbugs -->
<dependency>
<groupId>com.github.spotbugs</groupId>
<artifactId>spotbugs</artifactId>
<version>4.0.1</version>
</dependency>
<dependency>
<groupId>com.google.cloud.samples</groupId>
<artifactId>checkstyle-configuration</artifactId>
<version>1.0.17-SNAPSHOT</version>
</dependency>
</dependencies>
<configuration>
<failOnError>false</failOnError><!-- Let's not fail for now -->
<effort>Max</effort>
<threshold>Low</threshold>
<includeTests>true</includeTests>
<fork>false</fork>
<!-- Can't currently find this for some reason, so commenting out -->
<excludeFilterFile>c.g.c.s/spotBugsExcludeFilter.xml</excludeFilterFile>
<plugins>
<plugin>
<groupId>com.h3xstream.findsecbugs</groupId>
<artifactId>findsecbugs-plugin</artifactId>
<version>1.10.1</version>
</plugin>
<plugin>
<groupId>com.mebigfatguy.sb-contrib</groupId>
<artifactId>sb-contrib</artifactId>
<version>7.4.7</version>
</plugin>
<!-- <plugin> https://github.com/KengoTODA/findbugs-slf4j -->
<!-- <groupId>jp.skypencil.findbugs.slf4j</groupId>-->
<!-- <artifactId>findbugs-slf4j</artifactId>-->
<!-- <version>1.5.0</version>-->
<!-- </plugin>-->
</plugins>
</configuration>
</plugin>

<plugin><!-- PMD -->
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-pmd-plugin</artifactId>
<version>3.13.0</version>
<dependencies>
<dependency>
<groupId>net.sourceforge.pmd</groupId>
<artifactId>pmd-core</artifactId>
<version>${pmdVersion}</version>
</dependency>
<dependency>
<groupId>net.sourceforge.pmd</groupId>
<artifactId>pmd-java</artifactId>
<version>${pmdVersion}</version>
</dependency>
<dependency>
<groupId>net.sourceforge.pmd</groupId>
<artifactId>pmd-java8</artifactId>
<version>${pmdVersion}</version>
</dependency>
</dependencies>
<configuration>
<failOnViolation>false</failOnViolation>
<printFailingErrors>true</printFailingErrors>
<skipEmptyReport>false</skipEmptyReport>
<linkXRef>false</linkXRef>
<targetJdk>${maven.compiler.source}</targetJdk>
</configuration>
<executions>
<execution>
<phase>verify</phase>
<goals>
<goal>check</goal>
<goal>cpd-check</goal>
</goals>
</execution>
</executions>
</plugin>

<plugin> <!-- Checkstyle -->
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
<version>3.1.1</version>
<configuration>
<configLocation>google-checks.xml</configLocation>
<suppressionsLocation>suppressions.xml</suppressionsLocation>
<headerLocation>LICENSE.txt</headerLocation>

<includeTestSourceDirectory>true</includeTestSourceDirectory>
<consoleOutput>true</consoleOutput>
<logViolationsToConsole>true</logViolationsToConsole>
<failOnViolation>true</failOnViolation>
</configuration>
<dependencies>
<!-- Add a dependency to use bundled resources.
See: http://stackoverflow.com/a/19690484/101923 -->
<dependency>
<groupId>com.google.cloud.samples</groupId>
<artifactId>checkstyle-configuration</artifactId>
<version>1.0.17-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>com.puppycrawl.tools</groupId>
<artifactId>checkstyle</artifactId>
<version>8.31</version>
</dependency>
</dependencies>
<executions>
<execution>
<phase>verify</phase>
<goals>
<goal>check</goal>
</goals>
</execution>
</executions>
</plugin>

<plugin> <!-- Versions -->
<groupId>org.codehaus.mojo</groupId>
<artifactId>versions-maven-plugin</artifactId>
Expand Down

0 comments on commit b402174

Please sign in to comment.