Repository: falcon Updated Branches: refs/heads/master e85287fb8 -> b5c0b6139
FALCON-1721 Move checkstyle under parent pom Author: sandeep <[email protected]> Reviewers: praveen <[email protected]>, Pallavi Rao <[email protected] Closes #19 from sandeepSamudrala/master Project: http://git-wip-us.apache.org/repos/asf/falcon/repo Commit: http://git-wip-us.apache.org/repos/asf/falcon/commit/b5c0b613 Tree: http://git-wip-us.apache.org/repos/asf/falcon/tree/b5c0b613 Diff: http://git-wip-us.apache.org/repos/asf/falcon/diff/b5c0b613 Branch: refs/heads/master Commit: b5c0b6139af40da69667c36ad0c06a36b87f5d8c Parents: e85287f Author: sandeep <[email protected]> Authored: Tue Feb 2 10:11:56 2016 +0530 Committer: Pallavi Rao <[email protected]> Committed: Tue Feb 2 10:11:56 2016 +0530 ---------------------------------------------------------------------- .gitignore | 2 +- checkstyle/pom.xml | 34 --- .../resources/falcon/checkstyle-java-header.txt | 17 -- .../resources/falcon/checkstyle-noframes.xsl | 218 ----------------- .../falcon/checkstyle-suppressions.xml | 26 -- .../src/main/resources/falcon/checkstyle.xml | 238 ------------------- .../main/resources/falcon/findbugs-exclude.xml | 53 ----- pom.xml | 16 +- src/build/checkstyle-java-header.txt | 17 ++ src/build/checkstyle-noframes.xsl | 218 +++++++++++++++++ src/build/checkstyle-suppressions.xml | 26 ++ src/build/checkstyle.xml | 238 +++++++++++++++++++ src/build/findbugs-exclude.xml | 53 +++++ 13 files changed, 557 insertions(+), 599 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/falcon/blob/b5c0b613/.gitignore ---------------------------------------------------------------------- diff --git a/.gitignore b/.gitignore index 35b8256..f23a34d 100644 --- a/.gitignore +++ b/.gitignore @@ -32,7 +32,7 @@ maven-eclipse.xml #ActiveMQ activemq-data -build +#build #log files logs http://git-wip-us.apache.org/repos/asf/falcon/blob/b5c0b613/checkstyle/pom.xml ---------------------------------------------------------------------- diff --git a/checkstyle/pom.xml b/checkstyle/pom.xml deleted file mode 100644 index 8ea7fa1..0000000 --- a/checkstyle/pom.xml +++ /dev/null @@ -1,34 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- - 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. - --> - -<project xmlns="http://maven.apache.org/POM/4.0.0"; - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; - xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd";> - <modelVersion>4.0.0</modelVersion> - <parent> - <groupId>org.apache.falcon</groupId> - <artifactId>falcon-main</artifactId> - <version>0.10-SNAPSHOT</version> - </parent> - <artifactId>checkstyle</artifactId> - <name>Checkstyle</name> - <properties> - <skipTests>true</skipTests> - </properties> -</project> http://git-wip-us.apache.org/repos/asf/falcon/blob/b5c0b613/checkstyle/src/main/resources/falcon/checkstyle-java-header.txt ---------------------------------------------------------------------- diff --git a/checkstyle/src/main/resources/falcon/checkstyle-java-header.txt b/checkstyle/src/main/resources/falcon/checkstyle-java-header.txt deleted file mode 100644 index 5d5f1e3..0000000 --- a/checkstyle/src/main/resources/falcon/checkstyle-java-header.txt +++ /dev/null @@ -1,17 +0,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. - */ http://git-wip-us.apache.org/repos/asf/falcon/blob/b5c0b613/checkstyle/src/main/resources/falcon/checkstyle-noframes.xsl ---------------------------------------------------------------------- diff --git a/checkstyle/src/main/resources/falcon/checkstyle-noframes.xsl b/checkstyle/src/main/resources/falcon/checkstyle-noframes.xsl deleted file mode 100644 index 6308ef8..0000000 --- a/checkstyle/src/main/resources/falcon/checkstyle-noframes.xsl +++ /dev/null @@ -1,218 +0,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. - --> - -<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"; version="1.0"> - - <xsl:output method="html" indent="yes"/> - <xsl:decimal-format decimal-separator="." grouping-separator=","/> - - <xsl:key name="files" match="file" use="@name"/> - - <!-- Checkstyle XML Style Sheet by Stephane Bailliez <[email protected]> --> - <!-- Part of the Checkstyle distribution found at http://checkstyle.sourceforge.net --> - <!-- Usage (generates checkstyle_report.html): --> - <!-- <checkstyle failonviolation="false" config="${check.config}"> --> - <!-- <fileset dir="${src.dir}" includes="**/*.java"/> --> - <!-- <formatter type="xml" toFile="${doc.dir}/checkstyle_report.xml"/> --> - <!-- </checkstyle> --> - <!-- <style basedir="${doc.dir}" destdir="${doc.dir}" --> - <!-- includes="checkstyle_report.xml" --> - <!-- style="${doc.dir}/checkstyle-noframes-sorted.xsl"/> --> - - <xsl:template match="checkstyle"> - <html> - <head> - <style type="text/css"> - .bannercell { - border: 0px; - padding: 0px; - } - body { - margin-left: 10; - margin-right: 10; - font:normal 80% arial,helvetica,sanserif; - background-color:#FFFFFF; - color:#000000; - } - .a td { - background: #efefef; - } - .b td { - background: #fff; - } - th, td { - text-align: left; - vertical-align: top; - } - th { - font-weight:bold; - background: #ccc; - color: black; - } - table, th, td { - font-size:100%; - border: none - } - table.log tr td, tr th { - - } - h2 { - font-weight:bold; - font-size:140%; - margin-bottom: 5; - } - h3 { - font-size:100%; - font-weight:bold; - background: #525D76; - color: white; - text-decoration: none; - padding: 5px; - margin-right: 2px; - margin-left: 2px; - margin-bottom: 0; - } - </style> - </head> - <body> - <a name="top"></a> - <!-- jakarta logo --> - <table border="0" cellpadding="0" cellspacing="0" width="100%"> - <tr> - <td class="bannercell" rowspan="2"> - <!--a href="http://jakarta.apache.org/";> - <img src="http://jakarta.apache.org/images/jakarta-logo.gif"; alt="http://jakarta.apache.org"; align="left" border="0"/> - </a--> - </td> - <td class="text-align:right"> - <h2>CheckStyle Audit</h2> - </td> - </tr> - <tr> - <td class="text-align:right">Designed for use with - <a href='http://checkstyle.sourceforge.net/'>CheckStyle</a> - and<a href='http://jakarta.apache.org'>Ant</a>. - </td> - </tr> - </table> - <hr size="1"/> - - <!-- Summary part --> - <xsl:apply-templates select="." mode="summary"/> - <hr size="1" width="100%" align="left"/> - - <!-- Package List part --> - <xsl:apply-templates select="." mode="filelist"/> - <hr size="1" width="100%" align="left"/> - - <!-- For each package create its part --> - <xsl:apply-templates select="file[@name and generate-id(.) = generate-id(key('files', @name))]"/> - - <hr size="1" width="100%" align="left"/> - - - </body> - </html> - </xsl:template> - - - <xsl:template match="checkstyle" mode="filelist"> - <h3>Files</h3> - <table class="log" border="0" cellpadding="5" cellspacing="2" width="100%"> - <tr> - <th>Name</th> - <th>Errors</th> - </tr> - <xsl:for-each select="file[@name and generate-id(.) = generate-id(key('files', @name))]"> - <xsl:sort data-type="number" order="descending" select="count(key('files', @name)/error)"/> - <xsl:variable name="errorCount" select="count(error)"/> - <tr> - <xsl:call-template name="alternated-row"/> - <td> - <a href="#f-{@name}"> - <xsl:value-of select="@name"/> - </a> - </td> - <td> - <xsl:value-of select="$errorCount"/> - </td> - </tr> - </xsl:for-each> - </table> - </xsl:template> - - - <xsl:template match="file"> - <a name="f-{@name}"></a> - <h3>File - <xsl:value-of select="@name"/> - </h3> - - <table class="log" border="0" cellpadding="5" cellspacing="2" width="100%"> - <tr> - <th>Error Description</th> - <th>Line</th> - </tr> - <xsl:for-each select="key('files', @name)/error"> - <xsl:sort data-type="number" order="ascending" select="@line"/> - <tr> - <xsl:call-template name="alternated-row"/> - <td> - <xsl:value-of select="@message"/> - </td> - <td> - <xsl:value-of select="@line"/> - </td> - </tr> - </xsl:for-each> - </table> - <a href="#top">Back to top</a> - </xsl:template> - - - <xsl:template match="checkstyle" mode="summary"> - <h3>Summary</h3> - <xsl:variable name="fileCount" - select="count(file[@name and generate-id(.) = generate-id(key('files', @name))])"/> - <xsl:variable name="errorCount" select="count(file/error)"/> - <table class="log" border="0" cellpadding="5" cellspacing="2" width="100%"> - <tr> - <th>Files</th> - <th>Errors</th> - </tr> - <tr> - <xsl:call-template name="alternated-row"/> - <td> - <xsl:value-of select="$fileCount"/> - </td> - <td> - <xsl:value-of select="$errorCount"/> - </td> - </tr> - </table> - </xsl:template> - - <xsl:template name="alternated-row"> - <xsl:attribute name="class"> - <xsl:if test="position() mod 2 = 1">a</xsl:if> - <xsl:if test="position() mod 2 = 0">b</xsl:if> - </xsl:attribute> - </xsl:template> -</xsl:stylesheet> - - http://git-wip-us.apache.org/repos/asf/falcon/blob/b5c0b613/checkstyle/src/main/resources/falcon/checkstyle-suppressions.xml ---------------------------------------------------------------------- diff --git a/checkstyle/src/main/resources/falcon/checkstyle-suppressions.xml b/checkstyle/src/main/resources/falcon/checkstyle-suppressions.xml deleted file mode 100644 index 3b75811..0000000 --- a/checkstyle/src/main/resources/falcon/checkstyle-suppressions.xml +++ /dev/null @@ -1,26 +0,0 @@ -<?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 suppressions PUBLIC -"-//Puppy Crawl//DTD Suppressions 1.1//EN" -"http://www.puppycrawl.com/dtds/suppressions_1_1.dtd";> - -<suppressions> - <suppress files="[\\/]generated-sources[\\/]" checks="[a-zA-Z0-9]*"/> - <suppress files="[\\/]surefire-reports[\\/]" checks="[a-zA-Z0-9]*"/> -</suppressions> http://git-wip-us.apache.org/repos/asf/falcon/blob/b5c0b613/checkstyle/src/main/resources/falcon/checkstyle.xml ---------------------------------------------------------------------- diff --git a/checkstyle/src/main/resources/falcon/checkstyle.xml b/checkstyle/src/main/resources/falcon/checkstyle.xml deleted file mode 100644 index 292a0a3..0000000 --- a/checkstyle/src/main/resources/falcon/checkstyle.xml +++ /dev/null @@ -1,238 +0,0 @@ -<?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";> - -<!-- - - Checkstyle configuration for Falcon that is based on the sun_checks.xml file - that is bundled with Checkstyle and includes checks for: - - - the Java Language Specification at - http://java.sun.com/docs/books/jls/second_edition/html/index.html - - - the Sun Code Conventions at http://java.sun.com/docs/codeconv/ - - - the Javadoc guidelines at - http://java.sun.com/j2se/javadoc/writingdoccomments/index.html - - - the JDK Api documentation http://java.sun.com/j2se/docs/api/index.html - - - some best practices - - Checkstyle is very configurable. Be sure to read the documentation at - http://checkstyle.sf.net (or in your downloaded distribution). - - Most Checks are configurable, be sure to consult the documentation. - - To completely disable a check, just comment it out or delete it from the file. - - Finally, it is worth reading the documentation. - ---> - -<module name="Checker"> - - <!-- Checks that a package.html file exists for each package. --> - <!-- See http://checkstyle.sf.net/config_javadoc.html#PackageHtml --> - <!-- module name="PackageHtml"/ --> - - <!-- Checks whether files end with a new line. --> - <!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile --> - <module name="NewlineAtEndOfFile"/> - - <!-- Checks for Headers --> - <!-- See http://checkstyle.sf.net/config_header.html --> - <module name="Header"> - <property name="headerFile" value="${checkstyle.header.file}"/> - <property name="fileExtensions" value="java"/> - </module> - - <module name="FileLength"/> - <module name="FileTabCharacter"/> - - <module name="TreeWalker"> - <!-- Checks for Javadoc comments. --> - <!-- See http://checkstyle.sf.net/config_javadoc.html --> - <module name="JavadocType"> - <property name="scope" value="public"/> - <property name="allowMissingParamTags" value="true"/> - </module> - <module name="JavadocStyle"/> - - <module name="SuperClone"/> - <module name="SuperFinalize"/> - - <!-- Checks for Naming Conventions. --> - <!-- See http://checkstyle.sf.net/config_naming.html --> - <module name="ConstantName"/> - <module name="ClassTypeParameterName"> - <property name="format" value="^[A-Z]+$"/> - </module> - <module name="LocalFinalVariableName"> - <!--<property name="format" value="^[A-Z][_A-Z0-9]*$"/>--> - </module> - <module name="LocalVariableName"/> - <module name="MemberName"/> - <module name="MethodName"/> - <module name="MethodTypeParameterName"> - <property name="format" value="^[A-Z]+$"/> - </module> - <module name="PackageName"/> - <module name="ParameterName"/> - <module name="StaticVariableName"/> - <module name="TypeName"/> - - <!-- Checks for imports --> - <!-- See http://checkstyle.sf.net/config_import.html --> - <module name="IllegalImport"/> - <!-- defaults to sun.* packages --> - <module name="RedundantImport"/> - <module name="UnusedImports"/> - <module name="AvoidStarImport"> - <property name="allowClassImports" value="false"/> - </module> - - - <!-- Checks for Size Violations. --> - <!-- See http://checkstyle.sf.net/config_sizes.html --> - <module name="LineLength"> - <property name="max" value="120"/> - </module> - <module name="MethodLength"/> - <module name="ParameterNumber"/> - <module name="OuterTypeNumber"/> - - <!-- Checks for whitespace --> - <!-- See http://checkstyle.sf.net/config_whitespace.html --> - <module name="GenericWhitespace"/> - <module name="EmptyForIteratorPad"/> - <module name="MethodParamPad"/> - <module name="WhitespaceAround"> - <property name="tokens" value="LITERAL_IF"/> - </module> - <module name="NoWhitespaceAfter"> - <property name="tokens" - value="BNOT, DEC, DOT, INC, LNOT, UNARY_MINUS, UNARY_PLUS"/> - </module> - <module name="NoWhitespaceBefore"/> - <module name="OperatorWrap"/> - <module name="ParenPad"/> - <module name="TypecastParenPad"/> - <module name="WhitespaceAfter"> - <property name="tokens" value="COMMA, SEMI"/> - </module> - - <module name="Regexp"> - <property name="format" value="[ \t]+$"/> - <property name="illegalPattern" value="true"/> - <property name="message" value="Trailing whitespace"/> - </module> - - <!-- Modifier Checks --> - <!-- See http://checkstyle.sf.net/config_modifiers.html --> - <module name="ModifierOrder"/> - <module name="RedundantModifier"/> - - - <!-- Checks for blocks. You know, those {}'s --> - <!-- See http://checkstyle.sf.net/config_blocks.html --> - <module name="AvoidNestedBlocks"/> - <module name="EmptyBlock"> - <!-- catch blocks need a statement or a comment. --> - <property name="option" value="text"/> - <property name="tokens" value="LITERAL_CATCH"/> - </module> - <module name="EmptyBlock"> - <!-- all other blocks need a real statement. --> - <property name="option" value="stmt"/> - <property name="tokens" value="LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, - LITERAL_IF, LITERAL_FOR, LITERAL_TRY, LITERAL_WHILE, INSTANCE_INIT, - STATIC_INIT"/> - </module> - <module name="LeftCurly"/> - <module name="NeedBraces"/> - <module name="RightCurly"/> - - - <!-- Checks for common coding problems --> - <!-- See http://checkstyle.sf.net/config_coding.html --> - <!-- module name="AvoidInlineConditionals"/--> - <!-- DoubleCheckedLocking check is no longer required. See http://checkstyle.sourceforge.net/releasenotes.html --> - <!-- module name="DoubleCheckedLocking"/--> - <module name="EmptyStatement"/> - <module name="EqualsHashCode"/> - <module name="StringLiteralEquality"/> - <module name="HiddenField"> - <property name="ignoreConstructorParameter" value="true"/> - <property name="ignoreAbstractMethods" value="true"/> - <property name="ignoreSetter" value="true"/> - </module> - <module name="IllegalInstantiation"/> - <module name="InnerAssignment"/> - <module name="MissingSwitchDefault"/> - <module name="RedundantThrows"/> - <module name="SimplifyBooleanExpression"/> - <module name="SimplifyBooleanReturn"/> - <module name="DefaultComesLast"/> - - <!-- Checks for class design --> - <!-- See http://checkstyle.sf.net/config_design.html --> - <module name="FinalClass"/> - <module name="HideUtilityClassConstructor"/> - <module name="InterfaceIsType"/> - <module name="VisibilityModifier"> - <property name="protectedAllowed" value="true"/> - </module> - <module name="MissingOverride"/> - - - <!-- Miscellaneous other checks. --> - <!-- See http://checkstyle.sf.net/config_misc.html --> - <module name="ArrayTypeStyle"/> - <module name="ArrayTrailingComma"/> - <!-- - This generates too many false-positives on wrapped 'throws' clauses - to be really useful. Disabled for now. - - Falcon style is: - * Spaces, not tabs. - * Indent by four spaces. - * Indent by four spaces when wrapping a line. - --> - <module name="Indentation"> - <property name="basicOffset" value="4"/> - <property name="caseIndent" value="0"/> - </module> - <module name="TodoComment"/> - <module name="UpperEll"/> - - <module name="FileContentsHolder"/> - </module> - - <!-- allow warnings to be suppressed --> - <module name="SuppressionCommentFilter"> - <property name="offCommentFormat" value="SUSPEND CHECKSTYLE CHECK ParameterNumberCheck|VisibilityModifierCheck|HiddenFieldCheck|MethodName|LineLengthCheck"/> - <property name="onCommentFormat" value="RESUME CHECKSTYLE CHECK ParameterNumberCheck|VisibilityModifierCheck|HiddenFieldCheck|MethodName|LineLengthCheck"/> - <property name="checkFormat" value="ParameterNumberCheck|VisibilityModifierCheck|HiddenFieldCheck|MethodName|LineLengthCheck"/> - </module> - -</module> http://git-wip-us.apache.org/repos/asf/falcon/blob/b5c0b613/checkstyle/src/main/resources/falcon/findbugs-exclude.xml ---------------------------------------------------------------------- diff --git a/checkstyle/src/main/resources/falcon/findbugs-exclude.xml b/checkstyle/src/main/resources/falcon/findbugs-exclude.xml deleted file mode 100644 index 78f2fd0..0000000 --- a/checkstyle/src/main/resources/falcon/findbugs-exclude.xml +++ /dev/null @@ -1,53 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- - 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. - --> -<FindBugsFilter> - <!-- These are generated by xjc compiler and hence excluded. --> - <Match> - <Or> - <Class name="~org.apache.falcon.entity.v0.feed.Validity" /> - <Class name="~org.apache.falcon.entity.v0.process.Validity" /> - </Or> - </Match> - - <!-- - Disable encoding as this might give an impression that Falcon code base is - "Internationalization" ready, but we haven't done anything consciously to guarantee that. - --> - <Match> - <Bug pattern="DM_DEFAULT_ENCODING" /> - </Match> - - <Match> - <Class name="org.apache.falcon.tools.FalconStateStoreDBCLI" /> - <Bug pattern="SQL_NONCONSTANT_STRING_PASSED_TO_EXECUTE" /> - </Match> - - <Match> - <Class name="org.apache.falcon.state.store.jdbc.EntityBean" /> - <Bug pattern="NP_BOOLEAN_RETURN_NULL" /> - </Match> - - <Match> - <Class name="org.apache.falcon.state.store.jdbc.InstanceBean" /> - <Bug pattern="NP_BOOLEAN_RETURN_NULL" /> - </Match> - - <Match> - <Bug pattern="RV_RETURN_VALUE_IGNORED_NO_SIDE_EFFECT" /> - </Match> -</FindBugsFilter> http://git-wip-us.apache.org/repos/asf/falcon/blob/b5c0b613/pom.xml ---------------------------------------------------------------------- diff --git a/pom.xml b/pom.xml index 4a6bd35..3d82c13 100644 --- a/pom.xml +++ b/pom.xml @@ -309,13 +309,6 @@ <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-checkstyle-plugin</artifactId> - <dependencies> - <dependency> - <groupId>org.apache.falcon</groupId> - <artifactId>checkstyle</artifactId> - <version>${project.version}</version> - </dependency> - </dependencies> <executions> <execution> <id>checkstyle-check</id> @@ -326,9 +319,9 @@ <configuration> <consoleOutput>true</consoleOutput> <includeTestSourceDirectory>true</includeTestSourceDirectory> - <configLocation>checkstyle/src/main/resources/falcon/checkstyle.xml</configLocation> - <headerLocation>checkstyle/src/main/resources/falcon/checkstyle-java-header.txt</headerLocation> - <suppressionsLocation>checkstyle/src/main/resources/falcon/checkstyle-suppressions.xml</suppressionsLocation> + <configLocation>src/build/checkstyle.xml</configLocation> + <headerLocation>src/build/checkstyle-java-header.txt</headerLocation> + <suppressionsLocation>src/build/checkstyle-suppressions.xml</suppressionsLocation> <failOnViolation>true</failOnViolation> </configuration> </execution> @@ -341,7 +334,7 @@ <configuration> <!--debug>true</debug --> <xmlOutput>true</xmlOutput> - <excludeFilterFile>checkstyle/src/main/resources/falcon/findbugs-exclude.xml</excludeFilterFile> + <excludeFilterFile>src/build/findbugs-exclude.xml</excludeFilterFile> <failOnError>true</failOnError> </configuration> <executions> @@ -405,7 +398,6 @@ <modules> <module>falcon-ui</module> - <module>checkstyle</module> <module>build-tools</module> <module>client</module> <module>cli</module> http://git-wip-us.apache.org/repos/asf/falcon/blob/b5c0b613/src/build/checkstyle-java-header.txt ---------------------------------------------------------------------- diff --git a/src/build/checkstyle-java-header.txt b/src/build/checkstyle-java-header.txt new file mode 100644 index 0000000..5d5f1e3 --- /dev/null +++ b/src/build/checkstyle-java-header.txt @@ -0,0 +1,17 @@ +/** + * 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. + */ http://git-wip-us.apache.org/repos/asf/falcon/blob/b5c0b613/src/build/checkstyle-noframes.xsl ---------------------------------------------------------------------- diff --git a/src/build/checkstyle-noframes.xsl b/src/build/checkstyle-noframes.xsl new file mode 100644 index 0000000..6308ef8 --- /dev/null +++ b/src/build/checkstyle-noframes.xsl @@ -0,0 +1,218 @@ +<!-- + 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. + --> + +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"; version="1.0"> + + <xsl:output method="html" indent="yes"/> + <xsl:decimal-format decimal-separator="." grouping-separator=","/> + + <xsl:key name="files" match="file" use="@name"/> + + <!-- Checkstyle XML Style Sheet by Stephane Bailliez <[email protected]> --> + <!-- Part of the Checkstyle distribution found at http://checkstyle.sourceforge.net --> + <!-- Usage (generates checkstyle_report.html): --> + <!-- <checkstyle failonviolation="false" config="${check.config}"> --> + <!-- <fileset dir="${src.dir}" includes="**/*.java"/> --> + <!-- <formatter type="xml" toFile="${doc.dir}/checkstyle_report.xml"/> --> + <!-- </checkstyle> --> + <!-- <style basedir="${doc.dir}" destdir="${doc.dir}" --> + <!-- includes="checkstyle_report.xml" --> + <!-- style="${doc.dir}/checkstyle-noframes-sorted.xsl"/> --> + + <xsl:template match="checkstyle"> + <html> + <head> + <style type="text/css"> + .bannercell { + border: 0px; + padding: 0px; + } + body { + margin-left: 10; + margin-right: 10; + font:normal 80% arial,helvetica,sanserif; + background-color:#FFFFFF; + color:#000000; + } + .a td { + background: #efefef; + } + .b td { + background: #fff; + } + th, td { + text-align: left; + vertical-align: top; + } + th { + font-weight:bold; + background: #ccc; + color: black; + } + table, th, td { + font-size:100%; + border: none + } + table.log tr td, tr th { + + } + h2 { + font-weight:bold; + font-size:140%; + margin-bottom: 5; + } + h3 { + font-size:100%; + font-weight:bold; + background: #525D76; + color: white; + text-decoration: none; + padding: 5px; + margin-right: 2px; + margin-left: 2px; + margin-bottom: 0; + } + </style> + </head> + <body> + <a name="top"></a> + <!-- jakarta logo --> + <table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td class="bannercell" rowspan="2"> + <!--a href="http://jakarta.apache.org/";> + <img src="http://jakarta.apache.org/images/jakarta-logo.gif"; alt="http://jakarta.apache.org"; align="left" border="0"/> + </a--> + </td> + <td class="text-align:right"> + <h2>CheckStyle Audit</h2> + </td> + </tr> + <tr> + <td class="text-align:right">Designed for use with + <a href='http://checkstyle.sourceforge.net/'>CheckStyle</a> + and<a href='http://jakarta.apache.org'>Ant</a>. + </td> + </tr> + </table> + <hr size="1"/> + + <!-- Summary part --> + <xsl:apply-templates select="." mode="summary"/> + <hr size="1" width="100%" align="left"/> + + <!-- Package List part --> + <xsl:apply-templates select="." mode="filelist"/> + <hr size="1" width="100%" align="left"/> + + <!-- For each package create its part --> + <xsl:apply-templates select="file[@name and generate-id(.) = generate-id(key('files', @name))]"/> + + <hr size="1" width="100%" align="left"/> + + + </body> + </html> + </xsl:template> + + + <xsl:template match="checkstyle" mode="filelist"> + <h3>Files</h3> + <table class="log" border="0" cellpadding="5" cellspacing="2" width="100%"> + <tr> + <th>Name</th> + <th>Errors</th> + </tr> + <xsl:for-each select="file[@name and generate-id(.) = generate-id(key('files', @name))]"> + <xsl:sort data-type="number" order="descending" select="count(key('files', @name)/error)"/> + <xsl:variable name="errorCount" select="count(error)"/> + <tr> + <xsl:call-template name="alternated-row"/> + <td> + <a href="#f-{@name}"> + <xsl:value-of select="@name"/> + </a> + </td> + <td> + <xsl:value-of select="$errorCount"/> + </td> + </tr> + </xsl:for-each> + </table> + </xsl:template> + + + <xsl:template match="file"> + <a name="f-{@name}"></a> + <h3>File + <xsl:value-of select="@name"/> + </h3> + + <table class="log" border="0" cellpadding="5" cellspacing="2" width="100%"> + <tr> + <th>Error Description</th> + <th>Line</th> + </tr> + <xsl:for-each select="key('files', @name)/error"> + <xsl:sort data-type="number" order="ascending" select="@line"/> + <tr> + <xsl:call-template name="alternated-row"/> + <td> + <xsl:value-of select="@message"/> + </td> + <td> + <xsl:value-of select="@line"/> + </td> + </tr> + </xsl:for-each> + </table> + <a href="#top">Back to top</a> + </xsl:template> + + + <xsl:template match="checkstyle" mode="summary"> + <h3>Summary</h3> + <xsl:variable name="fileCount" + select="count(file[@name and generate-id(.) = generate-id(key('files', @name))])"/> + <xsl:variable name="errorCount" select="count(file/error)"/> + <table class="log" border="0" cellpadding="5" cellspacing="2" width="100%"> + <tr> + <th>Files</th> + <th>Errors</th> + </tr> + <tr> + <xsl:call-template name="alternated-row"/> + <td> + <xsl:value-of select="$fileCount"/> + </td> + <td> + <xsl:value-of select="$errorCount"/> + </td> + </tr> + </table> + </xsl:template> + + <xsl:template name="alternated-row"> + <xsl:attribute name="class"> + <xsl:if test="position() mod 2 = 1">a</xsl:if> + <xsl:if test="position() mod 2 = 0">b</xsl:if> + </xsl:attribute> + </xsl:template> +</xsl:stylesheet> + + http://git-wip-us.apache.org/repos/asf/falcon/blob/b5c0b613/src/build/checkstyle-suppressions.xml ---------------------------------------------------------------------- diff --git a/src/build/checkstyle-suppressions.xml b/src/build/checkstyle-suppressions.xml new file mode 100644 index 0000000..3b75811 --- /dev/null +++ b/src/build/checkstyle-suppressions.xml @@ -0,0 +1,26 @@ +<?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 suppressions PUBLIC +"-//Puppy Crawl//DTD Suppressions 1.1//EN" +"http://www.puppycrawl.com/dtds/suppressions_1_1.dtd";> + +<suppressions> + <suppress files="[\\/]generated-sources[\\/]" checks="[a-zA-Z0-9]*"/> + <suppress files="[\\/]surefire-reports[\\/]" checks="[a-zA-Z0-9]*"/> +</suppressions> http://git-wip-us.apache.org/repos/asf/falcon/blob/b5c0b613/src/build/checkstyle.xml ---------------------------------------------------------------------- diff --git a/src/build/checkstyle.xml b/src/build/checkstyle.xml new file mode 100644 index 0000000..292a0a3 --- /dev/null +++ b/src/build/checkstyle.xml @@ -0,0 +1,238 @@ +<?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";> + +<!-- + + Checkstyle configuration for Falcon that is based on the sun_checks.xml file + that is bundled with Checkstyle and includes checks for: + + - the Java Language Specification at + http://java.sun.com/docs/books/jls/second_edition/html/index.html + + - the Sun Code Conventions at http://java.sun.com/docs/codeconv/ + + - the Javadoc guidelines at + http://java.sun.com/j2se/javadoc/writingdoccomments/index.html + + - the JDK Api documentation http://java.sun.com/j2se/docs/api/index.html + + - some best practices + + Checkstyle is very configurable. Be sure to read the documentation at + http://checkstyle.sf.net (or in your downloaded distribution). + + Most Checks are configurable, be sure to consult the documentation. + + To completely disable a check, just comment it out or delete it from the file. + + Finally, it is worth reading the documentation. + +--> + +<module name="Checker"> + + <!-- Checks that a package.html file exists for each package. --> + <!-- See http://checkstyle.sf.net/config_javadoc.html#PackageHtml --> + <!-- module name="PackageHtml"/ --> + + <!-- Checks whether files end with a new line. --> + <!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile --> + <module name="NewlineAtEndOfFile"/> + + <!-- Checks for Headers --> + <!-- See http://checkstyle.sf.net/config_header.html --> + <module name="Header"> + <property name="headerFile" value="${checkstyle.header.file}"/> + <property name="fileExtensions" value="java"/> + </module> + + <module name="FileLength"/> + <module name="FileTabCharacter"/> + + <module name="TreeWalker"> + <!-- Checks for Javadoc comments. --> + <!-- See http://checkstyle.sf.net/config_javadoc.html --> + <module name="JavadocType"> + <property name="scope" value="public"/> + <property name="allowMissingParamTags" value="true"/> + </module> + <module name="JavadocStyle"/> + + <module name="SuperClone"/> + <module name="SuperFinalize"/> + + <!-- Checks for Naming Conventions. --> + <!-- See http://checkstyle.sf.net/config_naming.html --> + <module name="ConstantName"/> + <module name="ClassTypeParameterName"> + <property name="format" value="^[A-Z]+$"/> + </module> + <module name="LocalFinalVariableName"> + <!--<property name="format" value="^[A-Z][_A-Z0-9]*$"/>--> + </module> + <module name="LocalVariableName"/> + <module name="MemberName"/> + <module name="MethodName"/> + <module name="MethodTypeParameterName"> + <property name="format" value="^[A-Z]+$"/> + </module> + <module name="PackageName"/> + <module name="ParameterName"/> + <module name="StaticVariableName"/> + <module name="TypeName"/> + + <!-- Checks for imports --> + <!-- See http://checkstyle.sf.net/config_import.html --> + <module name="IllegalImport"/> + <!-- defaults to sun.* packages --> + <module name="RedundantImport"/> + <module name="UnusedImports"/> + <module name="AvoidStarImport"> + <property name="allowClassImports" value="false"/> + </module> + + + <!-- Checks for Size Violations. --> + <!-- See http://checkstyle.sf.net/config_sizes.html --> + <module name="LineLength"> + <property name="max" value="120"/> + </module> + <module name="MethodLength"/> + <module name="ParameterNumber"/> + <module name="OuterTypeNumber"/> + + <!-- Checks for whitespace --> + <!-- See http://checkstyle.sf.net/config_whitespace.html --> + <module name="GenericWhitespace"/> + <module name="EmptyForIteratorPad"/> + <module name="MethodParamPad"/> + <module name="WhitespaceAround"> + <property name="tokens" value="LITERAL_IF"/> + </module> + <module name="NoWhitespaceAfter"> + <property name="tokens" + value="BNOT, DEC, DOT, INC, LNOT, UNARY_MINUS, UNARY_PLUS"/> + </module> + <module name="NoWhitespaceBefore"/> + <module name="OperatorWrap"/> + <module name="ParenPad"/> + <module name="TypecastParenPad"/> + <module name="WhitespaceAfter"> + <property name="tokens" value="COMMA, SEMI"/> + </module> + + <module name="Regexp"> + <property name="format" value="[ \t]+$"/> + <property name="illegalPattern" value="true"/> + <property name="message" value="Trailing whitespace"/> + </module> + + <!-- Modifier Checks --> + <!-- See http://checkstyle.sf.net/config_modifiers.html --> + <module name="ModifierOrder"/> + <module name="RedundantModifier"/> + + + <!-- Checks for blocks. You know, those {}'s --> + <!-- See http://checkstyle.sf.net/config_blocks.html --> + <module name="AvoidNestedBlocks"/> + <module name="EmptyBlock"> + <!-- catch blocks need a statement or a comment. --> + <property name="option" value="text"/> + <property name="tokens" value="LITERAL_CATCH"/> + </module> + <module name="EmptyBlock"> + <!-- all other blocks need a real statement. --> + <property name="option" value="stmt"/> + <property name="tokens" value="LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, + LITERAL_IF, LITERAL_FOR, LITERAL_TRY, LITERAL_WHILE, INSTANCE_INIT, + STATIC_INIT"/> + </module> + <module name="LeftCurly"/> + <module name="NeedBraces"/> + <module name="RightCurly"/> + + + <!-- Checks for common coding problems --> + <!-- See http://checkstyle.sf.net/config_coding.html --> + <!-- module name="AvoidInlineConditionals"/--> + <!-- DoubleCheckedLocking check is no longer required. See http://checkstyle.sourceforge.net/releasenotes.html --> + <!-- module name="DoubleCheckedLocking"/--> + <module name="EmptyStatement"/> + <module name="EqualsHashCode"/> + <module name="StringLiteralEquality"/> + <module name="HiddenField"> + <property name="ignoreConstructorParameter" value="true"/> + <property name="ignoreAbstractMethods" value="true"/> + <property name="ignoreSetter" value="true"/> + </module> + <module name="IllegalInstantiation"/> + <module name="InnerAssignment"/> + <module name="MissingSwitchDefault"/> + <module name="RedundantThrows"/> + <module name="SimplifyBooleanExpression"/> + <module name="SimplifyBooleanReturn"/> + <module name="DefaultComesLast"/> + + <!-- Checks for class design --> + <!-- See http://checkstyle.sf.net/config_design.html --> + <module name="FinalClass"/> + <module name="HideUtilityClassConstructor"/> + <module name="InterfaceIsType"/> + <module name="VisibilityModifier"> + <property name="protectedAllowed" value="true"/> + </module> + <module name="MissingOverride"/> + + + <!-- Miscellaneous other checks. --> + <!-- See http://checkstyle.sf.net/config_misc.html --> + <module name="ArrayTypeStyle"/> + <module name="ArrayTrailingComma"/> + <!-- + This generates too many false-positives on wrapped 'throws' clauses + to be really useful. Disabled for now. + + Falcon style is: + * Spaces, not tabs. + * Indent by four spaces. + * Indent by four spaces when wrapping a line. + --> + <module name="Indentation"> + <property name="basicOffset" value="4"/> + <property name="caseIndent" value="0"/> + </module> + <module name="TodoComment"/> + <module name="UpperEll"/> + + <module name="FileContentsHolder"/> + </module> + + <!-- allow warnings to be suppressed --> + <module name="SuppressionCommentFilter"> + <property name="offCommentFormat" value="SUSPEND CHECKSTYLE CHECK ParameterNumberCheck|VisibilityModifierCheck|HiddenFieldCheck|MethodName|LineLengthCheck"/> + <property name="onCommentFormat" value="RESUME CHECKSTYLE CHECK ParameterNumberCheck|VisibilityModifierCheck|HiddenFieldCheck|MethodName|LineLengthCheck"/> + <property name="checkFormat" value="ParameterNumberCheck|VisibilityModifierCheck|HiddenFieldCheck|MethodName|LineLengthCheck"/> + </module> + +</module> http://git-wip-us.apache.org/repos/asf/falcon/blob/b5c0b613/src/build/findbugs-exclude.xml ---------------------------------------------------------------------- diff --git a/src/build/findbugs-exclude.xml b/src/build/findbugs-exclude.xml new file mode 100644 index 0000000..78f2fd0 --- /dev/null +++ b/src/build/findbugs-exclude.xml @@ -0,0 +1,53 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + 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. + --> +<FindBugsFilter> + <!-- These are generated by xjc compiler and hence excluded. --> + <Match> + <Or> + <Class name="~org.apache.falcon.entity.v0.feed.Validity" /> + <Class name="~org.apache.falcon.entity.v0.process.Validity" /> + </Or> + </Match> + + <!-- + Disable encoding as this might give an impression that Falcon code base is + "Internationalization" ready, but we haven't done anything consciously to guarantee that. + --> + <Match> + <Bug pattern="DM_DEFAULT_ENCODING" /> + </Match> + + <Match> + <Class name="org.apache.falcon.tools.FalconStateStoreDBCLI" /> + <Bug pattern="SQL_NONCONSTANT_STRING_PASSED_TO_EXECUTE" /> + </Match> + + <Match> + <Class name="org.apache.falcon.state.store.jdbc.EntityBean" /> + <Bug pattern="NP_BOOLEAN_RETURN_NULL" /> + </Match> + + <Match> + <Class name="org.apache.falcon.state.store.jdbc.InstanceBean" /> + <Bug pattern="NP_BOOLEAN_RETURN_NULL" /> + </Match> + + <Match> + <Bug pattern="RV_RETURN_VALUE_IGNORED_NO_SIDE_EFFECT" /> + </Match> +</FindBugsFilter>
![http://jakarta.apache.org/images/jakarta-logo.gif"](http://jakarta.apache.org/images/jakarta-logo.gif"){kind=link}