Checkstyle Update (#87)

* Updated .gitignore for intellij

* Removed properties from pom.xml.

* Cleaned up pom and added comments.

* Cleaned up original checkstyle config.

* Added in Header check.

* Added header checks.

* Enabled checksytle toggle via comment.

* Fixed license header in sample apps.

Author: kurtisvg

.gitignore

@@ -3,6 +3,10 @@ service-account.json
 ### Java ###
 *.class
 
+# intellij
+.idea/
+*.iml
+
 # Mobile Tools for Java (J2ME)
 .mtj.tmp/
 

checkstyle-config/src/main/resources/LICENSE.txt

@@ -0,0 +1,17 @@
+^/\*$
+^<!--$
+^\W+\*?\W*Copyright 20\d\d Google Inc.$
+^\W+\*?\W*$
+^\W+\*?\W*Licensed under the Apache License, Version 2.0 \(the "License"\);$
+^\W+\*?\W*you may not use this file except in compliance with the License.$
+^\W+\*?\W*You may obtain a copy of the License at$
+^\W+\*?\W*$
+^\W+\*?\W*http://www.apache.org/licenses/LICENSE-2.0$
+^\W+\*?\W*$
+^\W+\*?\W*Unless required by applicable law or agreed to in writing, software$
+^\W+\*?\W*distributed under the License is distributed on an "AS IS" BASIS,$
+^\W+\*?\W*WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.$
+^\W+\*?\W*See the License for the specific language governing permissions and$
+^\W+\*?\W*limitations under the License.$
+^\W\*/$
+^-->$

pom.xml

@@ -22,9 +22,11 @@ limitations under the License.
   <packaging>pom</packaging>
 
   <name>${project.groupId}:${project.artifactId}</name>
-  <description>A shared configuration for Google Cloud samples. This defines
+  <description>
+    A shared configuration for Google Cloud samples. This defines
     common plugins and their configurations for testing, maintenance, and style
-    checks.</description>
+    checks.
+  </description>
   <url>https://github.com/GoogleCloudPlatform/java-repo-tools</url>
 
   <licenses>
@@ -76,42 +78,18 @@ limitations under the License.
   <properties>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
-
-    <jacoco-maven-plugin>0.7.9</jacoco-maven-plugin>
-    <plexus-compiler-javac-errorprone>2.8.2</plexus-compiler-javac-errorprone>
-    <error_prone_core>2.0.21</error_prone_core>
-
-    <maven-failsafe-plugin>2.20</maven-failsafe-plugin>
-    <maven-surefire-plugin>2.20</maven-surefire-plugin>
-    <maven-checkstyle-plugin>2.17</maven-checkstyle-plugin>
-    <maven-clean-plugin>3.0.0</maven-clean-plugin>
-    <maven-deploy-plugin>2.8.2</maven-deploy-plugin>
-    <maven-install-plugin>2.5.2</maven-install-plugin>
-    <maven-site-plugin>3.6</maven-site-plugin>
-    <maven-compiler-plugin>3.6.2</maven-compiler-plugin>
-    <maven-resources-plugin>3.0.2</maven-resources-plugin>
-    <maven-war-plugin>3.0.0</maven-war-plugin>
-    <maven-assembly-plugin>3.0.0</maven-assembly-plugin>
-    <maven-jar-plugin>3.0.2</maven-jar-plugin>
-    <maven-source-plugin>3.0.1</maven-source-plugin>
-    <maven-archetype-plugin>3.0.1</maven-archetype-plugin>
-
-    <maven-release-plugin>2.5.3</maven-release-plugin>
-    <nexus-staging-maven-plugin>1.6.8</nexus-staging-maven-plugin>
-    <versions-maven-plugin>2.4</versions-maven-plugin>
-    <maven-gpg-plugin>1.6</maven-gpg-plugin>
   </properties>
 
   <profiles>
-    <!-- Code signing for release: http://stackoverflow.com/a/14869692/101923 -->
-    <profile>
+    <profile> <!-- Code signing for release: http://stackoverflow.com/a/14869692/101923 -->
       <id>release</id>
       <build>
         <plugins>
+
           <plugin>
             <groupId>org.apache.maven.plugins</groupId>
             <artifactId>maven-source-plugin</artifactId>
-            <version>${maven-source-plugin}</version>
+            <version>3.0.1</version>
             <executions>
               <execution>
                 <id>attach-sources</id>
@@ -124,13 +102,13 @@ limitations under the License.
 
           <plugin>
             <artifactId>maven-archetype-plugin</artifactId>
-            <version>${maven-archetype-plugin}</version>
+            <version>3.0.1</version>
           </plugin>
 
           <plugin>
             <groupId>org.apache.maven.plugins</groupId>
             <artifactId>maven-gpg-plugin</artifactId>
-            <version>${maven-gpg-plugin}</version>
+            <version>1.6</version>
             <executions>
               <execution>
                 <id>sign-artifacts</id>
@@ -145,18 +123,19 @@ limitations under the License.
               </execution>
             </executions>
           </plugin>
+
         </plugins>
       </build>
     </profile>
   </profiles>
 
   <build>
     <plugins>
-      <!-- Compiler -->
-      <plugin>
+
+      <plugin> <!-- Compile w/ Errorprone -->
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-compiler-plugin</artifactId>
-        <version>${maven-compiler-plugin}</version>
+        <version>3.6.2</version>
         <configuration>
           <compilerId>javac-with-errorprone</compilerId>
           <forceJavacCompilerUse>true</forceJavacCompilerUse>
@@ -165,32 +144,31 @@ limitations under the License.
           <dependency>
             <groupId>org.codehaus.plexus</groupId>
             <artifactId>plexus-compiler-javac-errorprone</artifactId>
-            <version>${plexus-compiler-javac-errorprone}</version>
+            <version>2.8.2</version>
           </dependency>
           <!-- override plexus-compiler-javac-errorprone's dependency on
                Error Prone with the latest version -->
           <dependency>
             <groupId>com.google.errorprone</groupId>
             <artifactId>error_prone_core</artifactId>
-            <version>${error_prone_core}</version>
+            <version>2.0.21</version>
           </dependency>
         </dependencies>
       </plugin>
 
-     <!-- Unit tests -->
-      <plugin>
+      <plugin> <!-- Unit Tests -->
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-surefire-plugin</artifactId>
-        <version>${maven-surefire-plugin}</version>
+        <version>2.20</version>
         <configuration>
           <trimStackTrace>false</trimStackTrace>
         </configuration>
       </plugin>
-      <plugin>
-        <!-- Integration / system tests -->
+
+      <plugin> <!-- Integration / System Tests -->
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-failsafe-plugin</artifactId>
-        <version>${maven-failsafe-plugin}</version>
+        <version>2.20</version>
         <executions>
           <execution>
             <goals>
@@ -200,47 +178,54 @@ limitations under the License.
           </execution>
         </executions>
       </plugin>
-      <plugin>
+
+      <plugin> <!-- Style Check -->
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-checkstyle-plugin</artifactId>
-        <version>${maven-checkstyle-plugin}</version>
+        <version>2.17</version>
         <configuration>
           <configLocation>google-checks.xml</configLocation>
+          <headerLocation>LICENSE.txt</headerLocation>
+          <suppressionsLocation>suppressions.xml</suppressionsLocation>
+          <includeTestSourceDirectory>true</includeTestSourceDirectory>
           <consoleOutput>true</consoleOutput>
+          <logViolationsToConsole>true</logViolationsToConsole>
           <failOnViolation>true</failOnViolation>
-          <includeTestSourceDirectory>true</includeTestSourceDirectory>
-          <suppressionsLocation>suppressions.xml</suppressionsLocation>
         </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.3-SNAPSHOT</version>
           </dependency>
-
           <dependency>
             <groupId>com.puppycrawl.tools</groupId>
             <artifactId>checkstyle</artifactId>
             <version>8.1</version>
           </dependency>
-
         </dependencies>
         <executions>
-          <execution><goals><goal>check</goal></goals></execution>
+          <execution>
+            <phase>verify</phase>
+            <goals>
+              <goal>check</goal>
+            </goals>
+          </execution>
         </executions>
       </plugin>
-      <plugin>
+
+      <plugin> <!-- Used for managing and upgrading dependencies -->
         <groupId>org.codehaus.mojo</groupId>
         <artifactId>versions-maven-plugin</artifactId>
-        <version>${versions-maven-plugin}</version>
+        <version>2.4</version>
       </plugin>
-      <plugin>
+
+      <plugin> <!-- Used for creating basic report creation -->
         <groupId>org.jacoco</groupId>
         <artifactId>jacoco-maven-plugin</artifactId>
-        <version>${jacoco-maven-plugin}</version>
+        <version>0.7.9</version>
         <executions>
           <execution>
             <goals>
@@ -256,6 +241,8 @@ limitations under the License.
           </execution>
         </executions>
       </plugin>
+
     </plugins>
   </build>
+
 </project>

test/src/main/java/com/google/cloud/samples/test/App.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016 Google Inc. All Rights Reserved.
+ * Copyright 2016 Google Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

test/src/test/java/com/google/cloud/samples/test/AppTest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016 Google Inc. All Rights Reserved.
+ * Copyright 2016 Google Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.