Maven Checkstyle Plugin
  1. Maven Checkstyle Plugin
  2. MCHECKSTYLE-172

Checkstyle Plugin 2.8+ generates an additional aggregate report

    Details

    • Type: Bug Bug
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 2.8, 2.9
    • Fix Version/s: 2.10
    • Component/s: None
    • Labels:
      None
    • Environment:

      Description

      Using a very simple single module project, the aggregated report is created by default.

      Both the checkstyle and checkstyle-aggregate report are generated.

        Issue Links

          Activity

          sebbasf created issue -
          Sebb made changes -
          Field Original Value New Value
          Link This issue duplicates MCHECKSTYLE-167 [ MCHECKSTYLE-167 ]
          Dennis Lundberg made changes -
          Assignee Olivier Lamy [ olamy ]
          Fix Version/s 2.9 [ 18049 ]
          Dennis Lundberg made changes -
          Summary Checkstyle runs aggregate report on projects without modules Checkstyle Plugin 2.8+ generates an additional aggregate report
          Description Using a very simple single module project, the aggregated report is created by default and reports an incorrect number of violations, it just doubles the numbers. I checked out http://svn.apache.org/repos/asf/maven/plugins/tags/maven-checkstyle-plugin-2.8 and modified the integration test project {{checkstyle-report}} a little bit:
          * I deleted the {{reportSets}} configuration from the {{pom.xml}}.
          * I modified {{src/main/java/org/MyClass.java}} to actually have errors.

          The build log looks like this:
          {code}
          [mirko@borg checkstyle-report]$ mvn clean site
          [INFO] Scanning for projects...
          [INFO]
          [INFO] ------------------------------------------------------------------------
          [INFO] Building check-pass 1.0-SNAPSHOT
          [INFO] ------------------------------------------------------------------------
          [INFO]
          [INFO] --- maven-clean-plugin:2.4.1:clean (default-clean) @ check-pass ---
          [INFO] Deleting /Users/mirko/Documents/workspace/maven-checkstyle-plugin/target/it/checkstyle-report/target
          [INFO]
          [INFO] --- maven-site-plugin:3.0:site (default-site) @ check-pass ---
          [INFO] configuring report plugin org.apache.maven.plugins:maven-checkstyle-plugin:2.8
          [INFO] Relativizing decoration links with respect to project URL: http://maven.apache.org/
          [INFO] Rendering site with org.apache.maven.skins:maven-default-skin:jar:1.0 skin.
          [INFO] Generating "Checkstyle" report --- maven-checkstyle-plugin:2.8
          [INFO]
          [INFO] There are 2 checkstyle errors.
          [WARNING] Unable to locate Source XRef to link to - DISABLED
          [INFO] Generating "Checkstyle" report --- maven-checkstyle-plugin:2.8
          [INFO]
          [INFO] There are 4 checkstyle errors.
          [WARNING] Unable to locate Source XRef to link to - DISABLED
          [INFO] ------------------------------------------------------------------------
          [INFO] BUILD SUCCESS
          [INFO] ------------------------------------------------------------------------
          [INFO] Total time: 4.847s
          [INFO] Finished at: Tue Nov 29 21:13:40 CET 2011
          [INFO] Final Memory: 12M/81M
          [INFO] ------------------------------------------------------------------------
          {code}

          {{target/checkstyle-result.xml}} looks like this and reports the same errors twice:
          {code}
          <?xml version="1.0" encoding="UTF-8"?>
          <checkstyle version="5.4">
          <file name="/Users/mirko/Documents/workspace/maven-checkstyle-plugin/target/it/checkstyle-report/src/main/java/org/MyClass.java">
          <error line="7" column="5" severity="error" message="Missing a Javadoc comment." source="com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck"/>
          <error line="7" column="22" severity="error" message="Parameter args should be final." source="com.puppycrawl.tools.checkstyle.checks.FinalParametersCheck"/>
          </file>
          <file name="/Users/mirko/Documents/workspace/maven-checkstyle-plugin/target/it/checkstyle-report/src/main/java/org/MyClass.java">
          <error line="7" column="5" severity="error" message="Missing a Javadoc comment." source="com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck"/>
          <error line="7" column="22" severity="error" message="Parameter args should be final." source="com.puppycrawl.tools.checkstyle.checks.FinalParametersCheck"/>
          </file>
          </checkstyle>
          {code}

          Both the {{checkstyle}} and {{checkstyle-aggregate}} report are generated and {{checkstyle-aggregate}} reports the same errors twice. I attach the patched project which includes a check in {{verify.groovy}} to assert that only one {{file}} entry is present in the created {{target/checkstyle-result.xml}}.
          Using a very simple single module project, the aggregated report is created by default.

          Both the {{checkstyle}} and {{checkstyle-aggregate}} report are generated.
          Affects Version/s 2.9 [ 18049 ]
          Dennis Lundberg made changes -
          Testcase included yes [ 10040 ]
          Dennis Lundberg made changes -
          Link This issue relates to MCHECKSTYLE-62 [ MCHECKSTYLE-62 ]
          Dennis Lundberg made changes -
          Link This issue duplicates MCHECKSTYLE-167 [ MCHECKSTYLE-167 ]
          Dennis Lundberg made changes -
          Environment {{{
          mvn --version
          Apache Maven 3.0.4 (r1206075; 2011-11-25 09:20:29+0100)
          Maven home: /usr/local/Cellar/maven/current/libexec
          Java version: 1.6.0_29, vendor: Apple Inc.
          Java home: /Library/Java/JavaVirtualMachines/1.6.0_29-b11-402.jdk/Contents/Home
          Default locale: de_DE, platform encoding: MacRoman
          OS name: "mac os x", version: "10.7.2", arch: "x86_64", family: "mac"
          }}}
          mvn --version
          Apache Maven 3.0.4 (r1206075; 2011-11-25 09:20:29+0100)
          Maven home: /usr/local/Cellar/maven/current/libexec
          Java version: 1.6.0_29, vendor: Apple Inc.
          Java home: /Library/Java/JavaVirtualMachines/1.6.0_29-b11-402.jdk/Contents/Home
          Default locale: de_DE, platform encoding: MacRoman
          OS name: "mac os x", version: "10.7.2", arch: "x86_64", family: "mac"
          Fix Version/s 2.10 [ 18318 ]
          Assignee Dennis Lundberg [ dennislundberg ]
          Dennis Lundberg made changes -
          Resolution Fixed [ 1 ]
          Status Open [ 1 ] Closed [ 6 ]
          Mark Thomas made changes -
          Project Import Sun Apr 05 09:17:21 UTC 2015 [ 1428225441187 ]
          Mark Thomas made changes -
          Workflow jira [ 12718347 ] Default workflow, editable Closed status [ 12749805 ]
          Mark Thomas made changes -
          Project Import Sun Apr 05 22:43:44 UTC 2015 [ 1428273824526 ]
          Mark Thomas made changes -
          Workflow jira [ 12955746 ] Default workflow, editable Closed status [ 12992757 ]
          Mark Thomas made changes -
          Reporter SebbASF [ sebbasf ] Sebb [ sebb@apache.org ]
          Mark Thomas made changes -
          Assignee dennislundberg [ dennislundberg ] Dennis Lundberg [ dennisl@apache.org ]

            People

            • Assignee:
              Dennis Lundberg
              Reporter:
              Sebb
            • Votes:
              4 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development