Fix https://issues.apache.org/bugzilla/show_bug.cgi?id=49268

Add necessary plumbing to enable Checkstyle
The config file is deliberately empty. The check will be uncommented once the source code has been fixed (~200 files contain tabs).

git-svn-id: https://svn.apache.org/repos/asf/tomcat/trunk@966882 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/build.properties.default b/build.properties.default
index a6bab56..cbfc32d 100644 (file)
--- a/build.properties.default
+++ b/build.properties.default
@@ -120,6 +120,12 @@ junit.lib=${junit.home}
 junit.jar=${junit.lib}/junit.jar
 junit.loc=${base-sf.loc}/junit/junit3.8.2.zip
 
+# ----- Checkstyle, version 5.1 or later -----
+checkstyle.version=5.1
+checkstyle.home=${base.path}/checkstyle-${checkstyle.version}
+checkstyle.loc=${base-sf.loc}/checkstyle/checkstyle-${checkstyle.version}.zip
+checkstyle.jar=${checkstyle.home}/checkstyle-all-${checkstyle.version}.jar
+
 # ----- JSON Libraries (for bayeux module) -----
 json-lib.home=${base.path}/json-20080701
 json-lib.lib=http://repo1.maven.org/maven2/org/json/json/20080701/json-20080701.jar

diff --git a/build.xml b/build.xml
index f5d794b..a237b17 100644 (file)
--- a/build.xml
+++ b/build.xml
@@ -410,7 +410,18 @@
        
   </target>
 
-  <target name="compile" depends="build-prepare,download-compile">
+  <target name="validate" depends="download-validate">
+    <taskdef resource="checkstyletask.properties"
+                classpath="${checkstyle.jar}" />
+       <checkstyle config="checkstyle.xml">
+      <fileset dir="java">
+       <include name="**/*.java" />
+        <exclude name="org/apache/tomcat/util/bcel/**" />
+         </fileset>
+       </checkstyle>
+  </target>
+
+  <target name="compile" depends="build-prepare,download-compile,validate">
 
     <!-- Compile internal server components -->
     <javac srcdir="java" destdir="${tomcat.classes}"
@@ -1888,6 +1899,17 @@ Apache Tomcat ${version} native binaries for Win64 AMD64/EMT64 platform.
        
   <!-- ================ Download and dependency building =================== -->
 
+  <target name="download-validate"
+          description="Download components necessary to validate source" >
+
+    <antcall target="downloadzip">
+      <param name="sourcefile" value="${checkstyle.loc}"/>
+      <param name="destfile" value="${checkstyle.jar}"/>
+      <param name="destdir" value="${base.path}"/>
+    </antcall>
+
+  </target>
+
   <target name="download-compile"
              description="Download (and build) components necessary to compile" >
 

diff --git a/checkstyle.xml b/checkstyle.xml
new file mode 100644 (file)
index 0000000..784b70a
--- /dev/null
+++ b/checkstyle.xml
@@ -0,0 +1,25 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You 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.
+-->
+<!DOCTYPE module PUBLIC
+    "-//Puppy Crawl//DTD Check Configuration 1.2//EN"
+    "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
+<module name="Checker">
+<!--
+  <module name="FileTabCharacter"/>
+-->
+</module>
\ No newline at end of file

diff --git a/webapps/docs/changelog.xml b/webapps/docs/changelog.xml
index 67e671b..13f58c0 100644 (file)
--- a/webapps/docs/changelog.xml
+++ b/webapps/docs/changelog.xml
@@ -294,6 +294,11 @@
         Re-factor unit tests to enable them to be run once with each of the HTTP
         connector implementations (BIO, NIO and APR/native). (markt)
       </add>
+      <add>
+        <bug>49268</bug>: Add the necessary plumbing to include CheckStyle in
+        the build process. Start with no checks. Additional checks will be
+        added as they are agreed. (markt)
+      </add>
     </changelog>
   </subsection>
 </section>