Merge lp:~trond-norbye/gearman-java/checkstyle_support into lp:gearman-java

[Trond Norbye]

[Trond Norbye (trond-norbye)]

Added support for running checkstyle on the code ;)

=== modified file 'build.xml'
--- build.xml	2009-07-16 23:40:07 +0000
+++ build.xml	2009-08-05 19:26:15 +0000
@@ -11,6 +11,10 @@
     <property name="dist.docs.dir" location="${dist.dir}/docs" />
     <property name="dist.jar" location="${dist.lib.dir}/${ant.project.name}-${project.version}.jar"/>
     <property name="api.pkg" value="org.gearman"/>
+    <property name="pmd.home" value="${user.home}/.ant/lib/pmd"/>
+    <property name="findbugs.home" value="${user.home}/.ant/lib/findbugs"/>
+    <property name="checkstyle.home" value="${user.home}/.ant/lib/checkstyle"/>
+
     <path id="build.classpath">
         <pathelement location="${build.classes.dir}" />
     </path>
@@ -20,6 +24,87 @@
         <pathelement location="${junit.jar}" />
     </path>
 
+    <path id="pmd.lib.search.path">
+        <pathelement path="${pmd.home}/lib/"/>
+        <pathelement path="${java.class.path}"/>
+        <pathelement path="lib/pmd/lib/"/>
+    </path>
+
+    <path id="findbugs.lib.search.path">
+        <pathelement path="${findbugs.home}/lib/"/>
+        <pathelement path="${java.class.path}"/>
+        <pathelement path="lib/findbugs/lib/"/>
+    </path>
+
+    <path id="checkstyle.lib.search.path">
+        <pathelement path="${checkstyle.home}/"/>
+        <pathelement path="${java.class.path}"/>
+        <pathelement path="lib/checkstyle/lib/"/>
+    </path>
+
+    <target name="-check_pmd" description="Check that pmd jar files are present">
+        <available file="pmd.jar" type="file" property="pmd.jar.present">
+            <filepath refid="pmd.lib.search.path"/>
+        </available>
+        <fail unless="pmd.jar.present" message="Please install pmd.jar in lib-directory  (or in ant classpath) to run PMD."/>
+    </target>
+
+    <target name="pmd" depends="compile, -check_pmd" description="Check the code with PMD">
+        <path id="pmd.lib" >
+            <pathelement location="${pmd.home}/lib/pmd.jar"/>
+            <pathelement location="${pmd.home}/lib/jaxen.jar"/>
+        </path>
+        <taskdef name="pmd" classname="net.sourceforge.pmd.ant.PMDTask" classpathref="pmd.lib"/>
+        <mkdir dir="build/pmd"/>
+        <pmd targetjdk="1.6" failuresPropertyName="pmd.num.warnings" rulesetfiles="tools/pmd/ruleset.xml">
+            <formatter type="html" toFile="build/pmd/report.html"/>
+            <formatter type="xml" toFile="build/pmd/report.xml"/>
+            <fileset dir="src" includes="**/*.java"/>
+        </pmd>
+        <echo message="PMD finished, found ${pmd.num.warnings} warnings, see pmd/pmd_report.html"/>
+    </target>
+
+    <target name="-check_findbugs" description="Check that findbugs jar files are present">
+        <available file="findbugs.jar" type="file" property="findbugs.jar.present">
+            <filepath refid="findbugs.lib.search.path"/>
+        </available>
+        <fail unless="findbugs.jar.present" message="Could not find findbugs.jar"/>
+
+        <available file="findbugs-ant.jar" type="file" property="findbugs-ant.jar.present">
+            <filepath refid="findbugs.lib.search.path"/>
+        </available>
+        <fail unless="findbugs-ant.jar.present" message="Could not find findbugs-ant.jar"/>
+    </target>
+
+    <target name="findbugs" depends="dist, -check_findbugs" description="Check the code with Findbugs">
+        <path id="findbugs.lib" >
+            <pathelement location="${findbugs.home}/lib/findbugs.jar"/>
+            <pathelement location="${findbugs.home}/lib/findbugs-ant.jar"/>
+        </path>
+        <taskdef name="findbugs" classname="edu.umd.cs.findbugs.anttask.FindBugsTask" classpathref="findbugs.lib"/>
+        <mkdir dir="build/findbugs"/>
+        <findbugs projectname="Gearman-Java" home="${findbugs.home}" output="xml" outputFile="build/findbugs/findbugs.xml">
+            <sourcePath path="src" />
+            <class location="${dist.jar}" />
+        </findbugs>
+    </target>
+
+    <target name="-check_checkstyle" description="Check that checkstyle jar files are present">
+        <available file="checkstyle-all.jar" type="file" property="checkstyle.jar.present">
+            <filepath refid="checkstyle.lib.search.path"/>
+        </available>
+        <fail unless="checkstyle.jar.present" message="Please install checkstyle-all.jar in lib-directory  (or in ant classpath) to run Checkstyle, see README."/>
+    </target>
+
+    <target name="checkstyle" depends="compile, -check_checkstyle" description="Check the style with Checkstyle">
+        <taskdef resource="checkstyletask.properties" classpath="${checkstyle.home}/checkstyle-all.jar"/>
+        <mkdir dir="build/checkstyle"/>
+        <checkstyle config="tools/checkstyle/ruleset.xml" failOnViolation="false">
+            <fileset dir="src" includes="**/*.java"/>
+            <formatter type="xml" toFile="build/checkstyle/errors.xml"/>
+        </checkstyle>
+    </target>
+
     <target name="usage">
         <echo message="Build the ${ant.project.name} project."/>
         <echo message=""/>

=== added directory 'tools'
=== added directory 'tools/checkstyle'
=== added file 'tools/checkstyle/ruleset.xml'
--- tools/checkstyle/ruleset.xml	1970-01-01 00:00:00 +0000
+++ tools/checkstyle/ruleset.xml	2009-08-05 19:26:15 +0000
@@ -0,0 +1,27 @@
+<?xml version="1.0"?>
+<!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="NewlineAtEndOfFile"/>
+    <module name="TreeWalker">
+        <module name="AvoidStarImport"/>
+        <module name="RedundantImport"/>
+        <module name="UnusedImports"/>
+        <module name="ImportOrder"/>
+        <module name="FileLength"/>
+        <module name="MethodLength">
+            <property name="max" value="200"/>
+        </module>
+        <module name="AnonInnerLength">
+            <property name="max" value="60"/>
+        </module>
+        <module name="ParameterNumber"/>
+        <module name="NeedBraces"/>
+        <module name="GenericWhitespace"/>
+        <module name="MethodParamPad"/>
+        <module name="NoWhitespaceAfter"/>
+        <module name="FileContentsHolder"/>
+    </module>
+</module>
+

=== added directory 'tools/pmd'
=== added file 'tools/pmd/ruleset.xml'
--- tools/pmd/ruleset.xml	1970-01-01 00:00:00 +0000
+++ tools/pmd/ruleset.xml	2009-08-05 18:34:44 +0000
@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ruleset name="Custom ruleset for Gearman Java driver"
+    xmlns="http://pmd.sf.net/ruleset/1.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0 http://pmd.sf.net/ruleset_xml_schema.xsd"
+    xsi:noNamespaceSchemaLocation="http://pmd.sf.net/ruleset_xml_schema.xsd">
+
+  <description>PMD settings for lp:gearman-java</description>
+  
+  <rule ref="rulesets/strings.xml"/>
+  <rule ref="rulesets/basic.xml"/>
+  <rule ref="rulesets/braces.xml"/>
+  <rule ref="rulesets/clone.xml"/>
+  <rule ref="rulesets/design.xml"/>
+  <rule ref="rulesets/finalizers.xml"/>
+  <rule ref="rulesets/imports.xml"/>
+  <rule ref="rulesets/junit.xml"/>
+  <rule ref="rulesets/logging-java.xml"/>
+  <rule ref="rulesets/migrating.xml"/>
+  <rule ref="rulesets/optimizations.xml">
+      <!-- The following rules generate a lot of warnings... -->
+      <exclude name="LocalVariableCouldBeFinal"/> 
+      <exclude name="MethodArgumentCouldBeFinal"/>
+  </rule>
+  <rule ref="rulesets/strictexception.xml"/>
+  <rule ref="rulesets/strings.xml"/>
+  <rule ref="rulesets/sunsecure.xml"/>
+  <rule ref="rulesets/typeresolution.xml"/>
+  <rule ref="rulesets/unusedcode.xml"/>
+  
+</ruleset>