New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
MCHECKSTYLE-366 Upgrade checkstyle to a more recent version #13
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,4 +17,4 @@ | |
| * under the License. | ||
| */ | ||
|
|
||
| asfMavenTlpPlgnBuild() | ||
| asfMavenTlpPlgnBuild(jdk:['8','9','10','11','12']) | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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> |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it would be good if you can update all xmls to have new DOCTYPE that reference to secure website.
Example: https://github.com/checkstyle/checkstyle/blob/master/config/checkstyle_checks.xml#L2
There should be no
Puppy Crawl, nohttp://.it is part of security issue - checkstyle/checkstyle#6478 and checkstyle/checkstyle#6474
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a test resource
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@eolivelli , please address my comment, to avoid security issues in plugin.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@romani this file is a test resource, it is an integration test.
It would be better to create a specific JIRA and track the work to do.
I will be very happy to fix the problem you are reporting or to help your provide a patch.
This PR has already been merged, we should start a new one
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@eolivelli The security issue is in the parser that is used to parse this file. It leaves any code that parses this file vulnerable to XXE via a MITM.
It doesn't matter that it's a "test resource", it still leaves the build vulnerable to this attack vector.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I will create the ticket.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here is the new ticket to provide any patches for: https://issues.apache.org/jira/browse/MCHECKSTYLE-375
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great. If anyone wants to pick it up....I can wait for it before cutting the 3.1.0 release.
I am currently waiting for another patch se the is no hurry.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@eolivelli , please share link to patch that you are waiting
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@romani this one #5