This is an automated email from the ASF dual-hosted git repository. eolivelli pushed a commit to branch MCHECKSTYLE-357 in repository https://gitbox.apache.org/repos/asf/maven-checkstyle-plugin.git
commit ae240d1357f68a4bc0983d1981760dade674b43f Author: Peter Lamby <peterla...@web.de> AuthorDate: Thu Dec 6 14:20:49 2018 +0100 [MCHECKSTYLE-357] - Allow inline configuration for reporting --- src/it/MCHECKSTYLE-357/LICENSE.txt | 202 +++++++++++++++++++++ src/it/MCHECKSTYLE-357/invoker.properties | 20 ++ src/it/MCHECKSTYLE-357/pom.xml | 187 +++++++++++++++++++ src/it/MCHECKSTYLE-357/src/main/java/cat/App.java | 37 ++++ src/it/MCHECKSTYLE-357/verify.groovy | 31 ++++ .../checkstyle/AbstractCheckstyleReport.java | 62 +++++++ 6 files changed, 539 insertions(+) diff --git a/src/it/MCHECKSTYLE-357/LICENSE.txt b/src/it/MCHECKSTYLE-357/LICENSE.txt new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/src/it/MCHECKSTYLE-357/LICENSE.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed 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. diff --git a/src/it/MCHECKSTYLE-357/invoker.properties b/src/it/MCHECKSTYLE-357/invoker.properties new file mode 100644 index 0000000..0ed555b --- /dev/null +++ b/src/it/MCHECKSTYLE-357/invoker.properties @@ -0,0 +1,20 @@ +# 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. + +invoker.goals=clean site +# checkstyleRules requires Maven 3+ +invoker.maven.version = 3.0+ diff --git a/src/it/MCHECKSTYLE-357/pom.xml b/src/it/MCHECKSTYLE-357/pom.xml new file mode 100644 index 0000000..5c7d616 --- /dev/null +++ b/src/it/MCHECKSTYLE-357/pom.xml @@ -0,0 +1,187 @@ +<?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 + ~ + --> +<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> + <groupId>com.basistech</groupId> + <artifactId>MCHECKSTYLE-357</artifactId> + <description>Tests that the report uses the inline configuration.</description> + <version>1.0-SNAPSHOT</version> + <properties> + <maven.compiler.source>1.8</maven.compiler.source> + <maven.compiler.target>1.8</maven.compiler.target> + <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> + </properties> + <build> + <pluginManagement> + <plugins> + <plugin> + <artifactId>maven-site-plugin</artifactId> + <version>3.7.1</version> + </plugin> + <plugin> + <artifactId>maven-checkstyle-plugin</artifactId> + <version>3.0.1-SNAPSHOT</version> + <configuration> + <checkstyleRules> + <module name="Checker"> + <property name="charset" value="UTF-8" /> + <property name="severity" value="error" /> + + <module name="TreeWalker"> + <property name="tabWidth" value="3" /> + + <module name="RegexpSinglelineJava"> + <property name="format" value="^\t*(?! \*) " /> + <property name="message" + value="Indent must use tab characters" /> + </module> + + <!-- Annotations --> + <module name="AnnotationUseStyle" /> + <module name="MissingDeprecated"> + <property name="skipNoJavadoc" value="true" /> + </module> + <module name="MissingOverride" /> + <module name="PackageAnnotation" /> + + <!-- Blocks --> + <module name="EmptyCatchBlock"> + <property name="exceptionVariableName" + value="expected|ignore" /> + </module> + <module name="LeftCurly"> + <property name="option" value="nlow" /> + <property name="ignoreEnums" value="false" /> + </module> + <module name="NeedBraces"> + <property name="allowSingleLineStatement" + value="true" /> + </module> + <module name="RightCurly" /> + + <!-- Class design --> + <module name="HideUtilityClassConstructor" /> + <module name="InnerTypeLast" /> + <module name="InterfaceIsType" /> + <module name="OneTopLevelClass" /> + + <!-- Coding --> + <module name="CovariantEquals" /> + <module name="DeclarationOrder" /> + <module name="DefaultComesLast" /> + <module name="EmptyStatement" /> + <module name="EqualsHashCode" /> + <module name="ExplicitInitialization" /> + <module name="MissingSwitchDefault" /> + <module name="MultipleStringLiterals"> + <property name="allowedDuplicates" value="4" /> + </module> + <module name="OneStatementPerLine" /> + <module name="OverloadMethodsDeclarationOrder" /> + <module name="PackageDeclaration" /> + <module name="StringLiteralEquality" /> + <module name="UnnecessaryParentheses" /> + + <!-- Imports --> + <module name="AvoidStarImport" /> + <module name="CustomImportOrder"> + <property name="customImportOrderRules" + value="THIRD_PARTY_PACKAGE###STANDARD_JAVA_PACKAGE###STATIC" /> + </module> + <module name="RedundantImport" /> + <module name="UnusedImports"> + <property name="processJavadoc" value="false" /> + </module> + + <!-- Javadoc --> + <module name="AtclauseOrder" /> + + <!-- Misc --> + <module name="ArrayTypeStyle" /> + <module name="OuterTypeFilename" /> + <module name="CommentsIndentation" /> + <module name="Indentation"> + <property name="basicOffset" value="3" /> + <property name="caseIndent" value="0" /> + <property name="lineWrappingIndentation" value="6" /> + </module> + <module name="TodoComment"> + <property name="format" value="(TODO)|(FIXME)" /> + </module> + <module name="UpperEll" /> + + <!-- Modifiers --> + <module name="ModifierOrder" /> + <module name="RedundantModifier" /> + + <!-- Naming --> + <module name="ConstantName" /> + + <!-- Sizes --> + <module name="LineLength"> + <property name="max" value="120" /> + </module> + </module> + + <module name="RegexpSingleline"> + <!-- Check trailing whitespace --> + <property name="format" value="\s+$" /> + </module> + + <module name="NewlineAtEndOfFile"> + <property name="lineSeparator" value="lf" /> + </module> + <module name="UniqueProperties" /> + </module> + </checkstyleRules> + </configuration> + <executions> + <execution> + <goals> + <goal>check</goal> + </goals> + </execution> + </executions> + </plugin> + </plugins> + </pluginManagement> + <plugins> + <plugin> + <artifactId>maven-checkstyle-plugin</artifactId> + </plugin> + </plugins> + </build> + + <reporting> + <plugins> + <plugin> + <artifactId>maven-checkstyle-plugin</artifactId> + <reportSets> + <reportSet> + <reports> + <report>checkstyle</report> + </reports> + </reportSet> + </reportSets> + </plugin> + </plugins> + </reporting> +</project> + diff --git a/src/it/MCHECKSTYLE-357/src/main/java/cat/App.java b/src/it/MCHECKSTYLE-357/src/main/java/cat/App.java new file mode 100644 index 0000000..d6716a6 --- /dev/null +++ b/src/it/MCHECKSTYLE-357/src/main/java/cat/App.java @@ -0,0 +1,37 @@ +package cat; + +/* + * 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. + */ + +/** + * Hello world! + * + */ +public class App +{ + public static void main( String[] args ) + { + Object[] bucket = new Object[12345]; + String y = args[0]; + Object x = bucket[ Math.abs(y.hashCode()) % bucket.length]; + System.out.println( "Hello World!" + x); + x = bucket[ y.hashCode() % bucket.length]; + System.out.println( "Hello World!" + x); + } +} diff --git a/src/it/MCHECKSTYLE-357/verify.groovy b/src/it/MCHECKSTYLE-357/verify.groovy new file mode 100644 index 0000000..9609b0b --- /dev/null +++ b/src/it/MCHECKSTYLE-357/verify.groovy @@ -0,0 +1,31 @@ + +/* + * 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. + */ +assert new File(basedir, 'target/site/checkstyle.html').exists(); + +assert new File(basedir, 'target/checkstyle-cachefile').exists(); +assert new File(basedir, 'target/checkstyle-checker.xml').exists(); +assert new File(basedir, 'target/checkstyle-header.txt').exists(); +assert new File(basedir, 'target/checkstyle-result.xml').exists(); +assert new File(basedir, 'target/checkstyle-rules.xml').exists(); + +File rssFile = new File( basedir, 'target/site/checkstyle.rss' ); +assert rssFile.exists(); + +return true; diff --git a/src/main/java/org/apache/maven/plugins/checkstyle/AbstractCheckstyleReport.java b/src/main/java/org/apache/maven/plugins/checkstyle/AbstractCheckstyleReport.java index 950f116..6c5130b 100644 --- a/src/main/java/org/apache/maven/plugins/checkstyle/AbstractCheckstyleReport.java +++ b/src/main/java/org/apache/maven/plugins/checkstyle/AbstractCheckstyleReport.java @@ -50,6 +50,7 @@ import org.apache.maven.plugins.checkstyle.rss.CheckstyleRssGenerator; import org.apache.maven.plugins.checkstyle.rss.CheckstyleRssGeneratorRequest; import org.apache.maven.reporting.AbstractMavenReport; import org.apache.maven.reporting.MavenReportException; +import org.codehaus.plexus.configuration.PlexusConfiguration; import org.codehaus.plexus.resource.ResourceManager; import org.codehaus.plexus.resource.loader.FileResourceLoader; import org.codehaus.plexus.util.FileUtils; @@ -73,6 +74,10 @@ public abstract class AbstractCheckstyleReport protected static final String JAVA_FILES = "**\\/*.java"; + private static final String CHECKSTYLE_FILE_HEADER = "<?xml version=\"1.0\"?>\n" + + "<!DOCTYPE module PUBLIC \"-//Puppy Crawl//DTD Check Configuration 1.3//EN\"\n" + + " \"http://www.puppycrawl.com/dtds/configuration_1_3.dtd\">\n"; + /** * Specifies the cache file used to speed up Checkstyle on successive runs. */ @@ -403,6 +408,40 @@ public abstract class AbstractCheckstyleReport private boolean omitIgnoredModules; /** + * By using this property, you can specify the whole Checkstyle rules + * inline directly inside this pom. + * + * <pre> + * <plugin> + * ... + * <configuration> + * <checkstyleRules> + * <module name="Checker"> + * <module name="FileTabCharacter"> + * <property name="eachLine" value="true" /> + * </module> + * <module name="TreeWalker"> + * <module name="EmptyBlock"/> + * </module> + * </module> + * </checkstyleRules> + * </configuration> + * ... + * </pre> + * + * @since 2.12 + */ + @Parameter + private PlexusConfiguration checkstyleRules; + + /** + * Dump file for inlined Checkstyle rules. + */ + @Parameter( property = "checkstyle.output.rules.file", + defaultValue = "${project.build.directory}/checkstyle-rules.xml" ) + private File rulesFiles; + + /** */ @Component protected ResourceManager locator; @@ -451,7 +490,30 @@ public abstract class AbstractCheckstyleReport // locator = new Locator( new MojoLogMonitorAdaptor( getLog() ) ); // locator = new Locator( getLog(), new File( project.getBuild().getDirectory() ) ); + if ( checkstyleRules != null ) + { + if ( !"sun_checks.xml".equals( configLocation ) ) + { + throw new MavenReportException( "If you use inline configuration for rules, don't specify " + + "a configLocation" ); + } + if ( checkstyleRules.getChildCount() > 1 ) + { + throw new MavenReportException( "Currently only one root module is supported" ); + } + PlexusConfiguration checkerModule = checkstyleRules.getChild( 0 ); + try + { + FileUtils.forceMkdir( rulesFiles.getParentFile() ); + FileUtils.fileWrite( rulesFiles, CHECKSTYLE_FILE_HEADER + checkerModule.toString() ); + } + catch ( final IOException e ) + { + throw new MavenReportException( e.getMessage(), e ); + } + configLocation = rulesFiles.getAbsolutePath(); + } ClassLoader currentClassLoader = Thread.currentThread().getContextClassLoader(); try