Skip to content

Commit

Permalink
MCHECKSTYLE-366 Upgrade checkstyle to a more recent version
Browse files Browse the repository at this point in the history
and require Java 8 as Checkstyle 7+ requires Java 8
  • Loading branch information
eolivelli committed Apr 22, 2019
1 parent eee0ba1 commit 5b91456
Show file tree
Hide file tree
Showing 13 changed files with 245 additions and 44 deletions.
2 changes: 1 addition & 1 deletion Jenkinsfile
Expand Up @@ -17,4 +17,4 @@
* under the License.
*/

asfMavenTlpPlgnBuild()
asfMavenTlpPlgnBuild(jdk:['8','9','10','11','12'])
6 changes: 3 additions & 3 deletions pom.xml
Expand Up @@ -63,12 +63,12 @@ under the License.
</distributionManagement>

<properties>
<!-- Because Checkstyle 6.2+ requires Java 7 -->
<javaVersion>7</javaVersion>
<!-- Because Checkstyle 7+ requires Java 8 -->
<javaVersion>8</javaVersion>
<maven.compiler.source>1.${javaVersion}</maven.compiler.source>
<maven.compiler.target>1.${javaVersion}</maven.compiler.target>
<mavenVersion>3.0</mavenVersion>
<checkstyleVersion>6.18</checkstyleVersion>
<checkstyleVersion>8.19</checkstyleVersion>
<doxiaVersion>1.4</doxiaVersion>
<sitePluginVersion>3.7.1</sitePluginVersion>
</properties>
Expand Down
2 changes: 1 addition & 1 deletion src/it/MCHECKSTYLE-129/pom.xml
Expand Up @@ -57,7 +57,7 @@ under the License.
<artifactId>maven-checkstyle-plugin</artifactId>
<version>${checkstyleVersion}</version>
<configuration>
<configLocation>http://svn.apache.org/repos/asf/maven/plugins/tags/maven-checkstyle-plugin-2.15/src/main/resources/config/sun_checks.xml</configLocation>
<configLocation>https://raw.githubusercontent.com/checkstyle/checkstyle/checkstyle-8.19/src/main/resources/sun_checks.xml</configLocation>
</configuration>
</plugin>
</plugins>
Expand Down
9 changes: 2 additions & 7 deletions src/it/MCHECKSTYLE-137/checkstyle.xml
Expand Up @@ -20,8 +20,6 @@ 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="TreeWalker">
<!-- Enable FileContentsHolder to allow us to in turn turn on suppression comments -->
<module name="FileContentsHolder"/>
<!-- Checks for Naming Conventions. -->
<!-- See http://checkstyle.sf.net/config_naming.html -->
<module name="ConstantName"/>
Expand Down Expand Up @@ -89,7 +87,7 @@ under the License.
<!-- blows up with eclipse-cs 5.6.0
<module name="DoubleCheckedLocking"/>
-->
<module name="EmptyStatement"/>
<module name="EmptyStatement"/>
<module name="EqualsHashCode"/>
<module name="HiddenField">
<property name="tokens" value="VARIABLE_DEF"/>
Expand All @@ -98,7 +96,6 @@ under the License.
<module name="InnerAssignment"/>
<module name="MissingSwitchDefault"/>
<module name="SimplifyBooleanExpression"/>
<module name="SimplifyBooleanReturn"/>
<module name="StringLiteralEquality"/>
<module name="NestedIfDepth">
<property name="max" value="3"/>
Expand All @@ -117,15 +114,14 @@ under the License.
<module name="MultipleVariableDeclarations"/>
<module name="UnnecessaryParentheses"/>
<module name="FinalClass"/>
<module name="HideUtilityClassConstructor"/>
<module name="InterfaceIsType"/>
<module name="ThrowsCount">
<property name="max" value="5"/>
</module>
<module name="VisibilityModifier">
<property name="protectedAllowed" value="true"/>
<property name="packageAllowed" value="true"/>
<!-- Allow public members with 'Rule' on the end of their names to allow for
<!-- Allow public members with 'Rule' on the end of their names to allow for
JUnit rules. Too bad we can't make this see the @nnotations.
-->
<property name="publicMemberPattern" value="^.*Rule$"/>
Expand All @@ -152,7 +148,6 @@ under the License.
<property name="caseIndent" value="0"/>
</module>
</module>
<module name="SuppressionCommentFilter"/>
<module name="FileTabCharacter">
<property name="eachLine" value="true"/>
</module>
Expand Down
17 changes: 7 additions & 10 deletions src/it/MCHECKSTYLE-137/src/main/java/org/MyClass.java
Expand Up @@ -18,16 +18,13 @@
* specific language governing permissions and limitations
* under the License.
*/
public class MyClass {

public class MyClass
{
public static boolean singleCharHiragana(int v1, char v2) {
if (v1 != 12 || c == 'の')
{
return true;
}
else
{
return false;
}
if (v1 != 12 || c == 'の') {
return true;
} else {
return false;
}
}
}
Expand Up @@ -27,7 +27,6 @@ under the License.
<property name="file" value="${checkstyle.suppressions.file}"/>
</module>
<module name="TreeWalker">
<property name="cacheFile" value="${checkstyle.cache.file}"/>
<module name="LeftCurly">
<property name="option" value="nl"/>
</module>
Expand Down
3 changes: 0 additions & 3 deletions src/it/MCHECKSTYLE-193/checkstyle.xml
Expand Up @@ -23,8 +23,6 @@ Checkstyle rules for Basis Technology.
-->
<module name="Checker">
<module name="TreeWalker">
<!-- Enable FileContentsHolder to allow us to in turn turn on suppression comments -->
<module name="FileContentsHolder"/>
<!-- Checks for Naming Conventions. -->
<!-- See http://checkstyle.sf.net/config_naming.html -->
<module name="ConstantName"/>
Expand Down Expand Up @@ -159,7 +157,6 @@ Checkstyle rules for Basis Technology.
<module name="RegexpHeader">
<property name="header" value="/* A Required Header */"/>
</module>
<module name="SuppressionCommentFilter"/>
<module name="FileTabCharacter">
<property name="eachLine" value="true"/>
</module>
Expand Down
Expand Up @@ -20,10 +20,13 @@
*/

import java.io.File;
import java.util.Collections;
import java.util.List;
import java.util.TreeSet;

import com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck;
import com.puppycrawl.tools.checkstyle.api.CheckstyleException;
import com.puppycrawl.tools.checkstyle.api.FileText;
import com.puppycrawl.tools.checkstyle.api.LocalizedMessage;
import com.puppycrawl.tools.checkstyle.api.SeverityLevel;

Expand All @@ -32,12 +35,12 @@ public class EmptyLoggingCheck
{

@Override
protected void processFiltered( File file, List<String> lines )
protected void processFiltered( File file, FileText lines )
throws CheckstyleException
{
getMessageCollector().add( new LocalizedMessage( 0, 0, getMessageBundle(),
addMessages( new TreeSet<LocalizedMessage>( Collections.singleton( new LocalizedMessage( 0, 0, getMessageBundle(),
"EmptyLoggingCheck on file " + file.getName(), new Object[0],
SeverityLevel.ERROR, getId(), getClass(), null ) );
SeverityLevel.ERROR, getId(), getClass(), null ) ) ) );
}

}
Expand Up @@ -20,9 +20,7 @@ public AppTest( String testName )
super( testName );
}

/**
* @return the suite of tests being tested
*/
/* missing javadoc */
public static Test suite()
{
return new TestSuite( AppTest.class );
Expand Down
205 changes: 205 additions & 0 deletions src/it/multi-modules-aggregate/maven_checks.xml
@@ -0,0 +1,205 @@
<?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 that checks the Maven coding conventions from:
-->

<module name="Checker">

<!-- Checks that each Java package has a Javadoc file used for commenting. -->
<!-- See http://checkstyle.sf.net/config_javadoc.html#JavadocPackage -->
<!--module name="JavadocPackage">
<property name="allowLegacy" value="true"/>
</module-->

<!-- Checks whether files end with a new line. -->
<!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile -->
<!-- module name="NewlineAtEndOfFile"/ -->

<module name="FileLength"/>

<!-- Checks for Headers -->
<!-- See http://checkstyle.sf.net/config_header.html -->
<!-- <module name="RegexpHeader">
<property name="fileExtensions" value="java"/>
<property name="headerFile" value="${checkstyle.header.file}"/>
</module>
-->
<module name="FileTabCharacter">
<property name="eachLine" value="true"/>
</module>

<!-- Line with trailing spaces (disabled as it's too noisy) -->
<!--<module name="RegexpSingleline">
<property name="format" value="\s+$"/>
<property name="message" value="Line has trailing spaces."/>
</module>-->

<module name="TreeWalker">

<property name="tabWidth" value="4"/>

<!-- required for SuppressWarningsFilter (and other Suppress* rules not used here) -->
<!-- see http://checkstyle.sourceforge.net/config_annotation.html#SuppressWarningsHolder -->
<module name="SuppressWarningsHolder"/>

<module name="LeftCurly">
<property name="option" value="nl"/>
</module>

<module name="RightCurly">
<property name="option" value="alone"/>
</module>

<module name="LineLength">
<property name="max" value="120" />
<property name="ignorePattern" value="@version|@see|@todo|TODO"/>
</module>

<module name="MemberName" />

<!-- Checks for Javadoc comments. -->
<!-- See http://checkstyle.sf.net/config_javadoc.html -->
<module name="JavadocMethod">
<property name="severity" value="warning"/>
<property name="scope" value="protected"/>
</module>
<module name="JavadocType">
<property name="scope" value="protected"/>
<property name="allowUnknownTags" value="true" />
</module>
<module name="JavadocVariable">
<property name="severity" value="info"/>
<property name="scope" value="protected"/>
</module>


<!-- Checks for Naming Conventions. -->
<!-- See http://checkstyle.sf.net/config_naming.html -->
<module name="ConstantName"/>
<module name="LocalFinalVariableName"/>
<module name="LocalVariableName"/>
<module name="MethodName"/>
<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="AvoidStarImport"/>
<module name="IllegalImport"/>
<module name="UnusedImports"/>


<!-- Checks for Size Violations. -->
<!-- See http://checkstyle.sf.net/config_sizes.html -->
<module name="MethodLength"/>
<module name="ParameterNumber"/>


<!-- Checks for whitespace -->
<!-- See http://checkstyle.sf.net/config_whitespace.html -->
<module name="EmptyForIteratorPad">
<property name="option" value="space"/>
</module>
<!-- module name="NoWhitespaceAfter"/ -->
<!-- module name="NoWhitespaceBefore"/ -->
<module name="OperatorWrap"/>
<module name="ParenPad">
<property name="option" value="space" />
</module>
<module name="WhitespaceAfter"/>
<module name="WhitespaceAround"/>
<!-- module name="MethodParamPad"/ -->
<module name="GenericWhitespace"/>


<!-- 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">
<property name="option" value="text"/>
</module>
<module name="NeedBraces"/>


<!-- Checks for common coding problems -->
<!-- See http://checkstyle.sf.net/config_coding.html -->
<!-- module name="AvoidInlineConditionals"/ -->
<module name="EmptyStatement"/>
<module name="EqualsHashCode"/>
<module name="HiddenField">
<property name="severity" value="warning"/>
<property name="ignoreSetter" value="true"/>
<property name="ignoreConstructorParameter" value="true"/>
</module>
<module name="IllegalInstantiation"/>
<module name="InnerAssignment"/>
<module name="MagicNumber">
<!-- some numbers are really not that magic -->
<property name="ignoreNumbers" value="-4, -3, -2, -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 31, 32, 37, 64, 100, 128, 256, 512, 1000, 1024"/>
</module>
<module name="MissingSwitchDefault"/>
<module name="SimplifyBooleanExpression"/>
<module name="SimplifyBooleanReturn"/>

<!-- Checks for class design -->
<!-- See http://checkstyle.sf.net/config_design.html -->
<!-- module name="DesignForExtension"/ -->
<!-- module name="FinalClass"/ -->
<!-- module name="HideUtilityClassConstructor"/ -->
<module name="InterfaceIsType"/>
<module name="VisibilityModifier">
<property name="protectedAllowed" value="true"/>
<property name="packageAllowed" value="true"/>
</module>

<!-- Miscellaneous other checks. -->
<!-- See http://checkstyle.sf.net/config_misc.html -->
<!-- module name="ArrayTypeStyle"/ -->
<!-- module name="FinalParameters"/ -->
<!-- Let todo plugin handle this.
<module name="TodoComment"/>
-->
<module name="UpperEll"/>

</module>

<!-- Support @SuppressWarnings (added in Checkstyle 5.7) -->
<!-- see http://checkstyle.sourceforge.net/config.html#SuppressWarningsFilter -->
<module name="SuppressWarningsFilter"/>

<!-- Checks properties file for a duplicated properties. -->
<!-- See http://checkstyle.sourceforge.net/config_misc.html#UniqueProperties -->
<module name="UniqueProperties"/>

</module>

0 comments on commit 5b91456

Please sign in to comment.